rename files before conversion

[xonotic/xonotic.wiki.git] / NewQC.md

diff --git a/NewQC.md b/NewQC.md
new file mode 100644 (file)
index 0000000..915a275
--- /dev/null
+++ b/NewQC.md
@@ -0,0 +1,85 @@
+h1. New QC Syntax
+
+{{>toc}}
+
+It is possible that at some point we decide to switch QC-compiler which requires some changes to the code.
+
+*For more information see* http://dev.xonotic.org/projects/bocc
+
+h2. Clean syntax:
+
+In fteqcc there are some ambiguities regarding fieldpointers, function pointers, and field-return-types etc.
+A clean syntax is needed, the current implementation uses the following:
+
+|_.definition|_.meaning|
+|<code>float foo</code>|           global variable|
+|<code>float .foo</code>|          entity field|
+|<code>.float foo</code>|          fieldpointer|
+|<code>.float .foo</code>|         entity field of type fieldpointer|
+|<code>float foo(void)</code>|     function|
+|<code>float foo*(void)</code>|    function pointer|
+|<code>.float foo(void)</code>|    function returning a fieldpointer .float|
+|<code>.float foo*(void)</code>|   function pointer, returning a fieldpointer .float|
+|<code>float .foo(void)</code>|    entity field of type function returning float|
+|<code>.float .foo(void)</code>|   entity field of type function returning fieldpointer|
+
+h2. Function definitions:
+
+The old-style QC way of defining functions will not be supported, so
+<pre>void(float x) something = { ... }</pre>
+becomes
+<pre>void something(float x) { ... }</pre>
+which is the most common way to define functions in the xonotic code already anyway.
+
+h2. Constants:
+
+From now on, the code
+<pre>float x = 3</pre>
+does what the first instinct tells you: it creates a global with the initial value 3. Contrary to old QC, where it created a constant.
+To create a constant use:
+<pre>const float x = 3</pre>
+
+h2. Extendable functions:
+
+Since menuQC has some funny macro: ACCUMULATE_FUNCTIONS, it seemed like a nice syntactical sugar to allow the following:
+
+<pre>float myfunc() extendable
+{
+    float mylocal = 3;
+}
+
+/* other code */
+
+float myfunc()
+{
+    mylocal += 5;
+    if (mylocal > 20)
+        return mylocal;
+}
+
+/* optionally: */
+float myfunc() final
+{
+    return 3;
+}
+</pre>
+
+h2. Variadic parameters (do not use yet)
+
+(This might get changed to be more flexible so do not rely on this syntax...)
+
+Another "enhancement" is the possibility to have functions with variadic parameter lists. However, the only way to sanely access them (until pointers are allowed) is via a recursive way.
+Here's an example that assumes float parameters and prints them one after the other:
+<pre>void printfloats(float count, float first, ...)
+{
+    if (count <= 0) // if there are no parameters, return
+        return;
+    if (count == 1) { // If there's one parameter, print it, plus a new-line
+        print(strcat(ftos(first), "\n"));
+        return;
+    }
+    // Otherwise we have multiple parameters left, so print the float, and add a comma
+    print(strcat(ftos(first), ", "));
+    myprint(count-1, ...);
+}</pre>
+So <code>myprint(4, 1, 2, 3, 4)</code> would print <code>"1, 2, 3, 4\n"</code>