(Commit created by redmine exporter script from page "Wiki" version 87)

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

diff --git a/NewQC.textile b/NewQC.textile
index b20ee5431ef55edae6f85250780393715f6dcc67..0e6baef103b8815e0bccb89d9dc4a87358e9bced 100644 (file)
--- a/NewQC.textile
+++ b/NewQC.textile
@@ -2,35 +2,24 @@ h1. New QC Syntax
 
 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, *SUGGESTIONS ARE WELCOME*, my(blub's) current suggestion is:
+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>|           member: method/function pointer|
-|<code>..float foo(void)</code>| member: method/function pointer returning .float|
-|<code>..*float .foo(void)</code>| Member function returning pointer to float field
-|<code>.*float foo*(void)</code>|  function pointer returning .float|
-|<code>.*float</code>|             fieldpointer|
-|<code>.*float foo(void)</code>|   fieldpointer: method/function pointer|
-|<code>.*.float foo(void)</code>|  fieldpointer: method/function pointer returning .float|
-
-Additionally, at places where the definition of members or global functions is not allowed, they will be treated like fieldpointers.
-So inside parameterlists or a functionbody the list is as follows:
-
-|_.definition|_.meaning|
-|<code>float foo(void)</code>|     *function pointer*|
-|<code>float foo*(void)</code>|    function pointer|
-|<code>.float foo(void)</code>|           *fieldpointer: method/function pointer*|
-|<code>..float foo(void)</code>|/2. *fieldpointer: method/function pointer returning .float*|
-|<code>..*float foo(void)</code>|
-|<code>.*float foo*(void)</code>|  function pointer returning .float|
-|<code>.*float</code>|             fieldpointer|
-|<code>.*float foo(void)</code>|   fieldpointer: method/function pointer|
-|<code>.*.float foo(void)</code>|  fieldpointer: method/function pointer returning .float|
+|<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:
 
@@ -47,3 +36,48 @@ From now on, the code
 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>