From 8f90dd43ecb62676323fb507ba7d014faa6d22f7 Mon Sep 17 00:00:00 2001
From: Thomas <tluppi@thomas-GE60.(none)>
Date: Tue, 29 Apr 2014 12:52:08 -0400
Subject: [PATCH] Changed things to use typedef ScriptARgs/ScriptReturn, which
 makes finding out what those weird strings meant much much easier

---
 components/compiler/extensions.cpp | 10 ++++----
 components/compiler/extensions.hpp | 38 +++++++++++++++++++++++-------
 2 files changed, 35 insertions(+), 13 deletions(-)

diff --git a/components/compiler/extensions.cpp b/components/compiler/extensions.cpp
index c09abcbaf..c2b11c615 100644
--- a/components/compiler/extensions.cpp
+++ b/components/compiler/extensions.cpp
@@ -21,7 +21,7 @@ namespace Compiler
         return iter->second;
     }
 
-    bool Extensions::isFunction (int keyword, char& returnType, std::string& argumentType,
+    bool Extensions::isFunction (int keyword, ScriptReturn& returnType, ScriptArgs& argumentType,
         bool& explicitReference) const
     {
         std::map<int, Function>::const_iterator iter = mFunctions.find (keyword);
@@ -37,7 +37,7 @@ namespace Compiler
         return true;
     }
 
-    bool Extensions::isInstruction (int keyword, std::string& argumentType,
+    bool Extensions::isInstruction (int keyword, ScriptArgs& argumentType,
         bool& explicitReference) const
     {
         std::map<int, Instruction>::const_iterator iter = mInstructions.find (keyword);
@@ -52,8 +52,8 @@ namespace Compiler
         return true;
     }
 
-    void Extensions::registerFunction (const std::string& keyword, char returnType,
-        const std::string& argumentType, int code, int codeExplicit)
+    void Extensions::registerFunction (const std::string& keyword, ScriptReturn returnType,
+        const ScriptArgs& argumentType, int code, int codeExplicit)
     {
         Function function;
 
@@ -83,7 +83,7 @@ namespace Compiler
     }
 
     void Extensions::registerInstruction (const std::string& keyword,
-        const std::string& argumentType, int code, int codeExplicit)
+        const ScriptArgs& argumentType, int code, int codeExplicit)
     {
         Instruction instruction;
 
diff --git a/components/compiler/extensions.hpp b/components/compiler/extensions.hpp
index 18bb24ed0..5be81ac08 100644
--- a/components/compiler/extensions.hpp
+++ b/components/compiler/extensions.hpp
@@ -11,14 +11,36 @@ namespace Compiler
 {
     class Literals;
 
-    /// \brief Collection of compiler extensions
+    /// Typedef for script arguments string
+    /** Every character reperesents an argument to the command. All arguments are required until a /, after which
+        every argument is optional. <BR>
+        Eg: fff/f represents 3 required floats followed by one optional float <BR>
+        f - Float <BR>
+        c - String <BR>
+        l - Integer <BR>
+        s - Short <BR>
+        S - Also string (Seemed to be mostly used for Cell Names) <BR>
+        x - none?
 
+    **/
+    typedef std::string ScriptArgs;
+
+    /// Typedef for script return char
+    /** The character represents the type of data being returned. <BR>
+        f - float <BR>
+        S - String (Cell names) <BR>
+        l - Integer
+    **/
+    typedef char ScriptReturn;
+
+    /// \brief Collection of compiler extensions
     class Extensions
     {
+
             struct Function
             {
                 char mReturn;
-                std::string mArguments;
+                ScriptArgs mArguments;
                 int mCode;
                 int mCodeExplicit;
                 int mSegment;
@@ -26,7 +48,7 @@ namespace Compiler
 
             struct Instruction
             {
-                std::string mArguments;
+                ScriptArgs mArguments;
                 int mCode;
                 int mCodeExplicit;
                 int mSegment;
@@ -46,21 +68,21 @@ namespace Compiler
             /// - if no match is found 0 is returned.
             /// - keyword must be all lower case.
 
-            bool isFunction (int keyword, char& returnType, std::string& argumentType,
+            bool isFunction (int keyword, ScriptReturn& returnType, ScriptArgs& argumentType,
                 bool& explicitReference) const;
             ///< Is this keyword registered with a function? If yes, return return and argument
             /// types.
             /// \param explicitReference In: has explicit reference; Out: set to false, if
             /// explicit reference is not available for this instruction.
 
-            bool isInstruction (int keyword, std::string& argumentType,
+            bool isInstruction (int keyword, ScriptArgs& argumentType,
                 bool& explicitReference) const;
             ///< Is this keyword registered with a function? If yes, return argument types.
             /// \param explicitReference In: has explicit reference; Out: set to false, if
             /// explicit reference is not available for this instruction.
 
-            void registerFunction (const std::string& keyword, char returnType,
-                const std::string& argumentType, int code, int codeExplicit = -1);
+            void registerFunction (const std::string& keyword, ScriptReturn returnType,
+                const ScriptArgs& argumentType, int code, int codeExplicit = -1);
             ///< Register a custom function
             /// - keyword must be all lower case.
             /// - keyword must be unique
@@ -68,7 +90,7 @@ namespace Compiler
             /// \note Currently only segment 3 and segment 5 opcodes are supported.
 
             void registerInstruction (const std::string& keyword,
-                const std::string& argumentType, int code, int codeExplicit = -1);
+                const ScriptArgs& argumentType, int code, int codeExplicit = -1);
             ///< Register a custom instruction
             /// - keyword must be all lower case.
             /// - keyword must be unique