Usermode/Libraries/libspiderscript.so_src/ast.h

   1 /*
   2  */
   3 #ifndef _AST_H_
   4 #define _AST_H_
   5
   6 #include <spiderscript.h>
   7 #include "tokens.h"
   8
   9 typedef enum eAST_NodeTypes     tAST_NodeType;
  10 typedef struct sAST_Script      tAST_Script;
  11 typedef struct sAST_Function    tAST_Function;
  12 typedef struct sAST_Node        tAST_Node;
  13 typedef struct sAST_BlockState  tAST_BlockState;
  14 typedef struct sAST_Variable    tAST_Variable;
  15
  16 /**
  17  * \brief Node Types
  18  */
  19 enum eAST_NodeTypes
  20 {
  21         NODETYPE_NOP,
  22
  23         NODETYPE_BLOCK, //!< Node Block
  24
  25         NODETYPE_VARIABLE,      //!< Variable
  26         NODETYPE_CONSTANT,      //!< Runtime Constant
  27         NODETYPE_STRING,        //!< String Constant
  28         NODETYPE_INTEGER,       //!< Integer Constant
  29         NODETYPE_REAL,  //!< Real Constant
  30
  31         NODETYPE_DEFVAR,        //!< Define a variable (Variable)
  32         NODETYPE_SCOPE, //!< Dereference a Namespace/Class static
  33         NODETYPE_ELEMENT,       //!< Reference a class attribute
  34         NODETYPE_CAST,  //!< Cast a value to another (Uniop)
  35
  36         NODETYPE_RETURN,        //!< Return from a function (reserved word)
  37         NODETYPE_BREAK,         //!< Break out of a loop
  38         NODETYPE_CONTINUE,      //!< Next loop iteration
  39         NODETYPE_ASSIGN,        //!< Variable assignment operator
  40         NODETYPE_POSTINC,       //!< Post-increment (i++) - Uniop
  41         NODETYPE_POSTDEC,       //!< Post-decrement (i--) - Uniop
  42         NODETYPE_FUNCTIONCALL,  //!< Call a function
  43         NODETYPE_METHODCALL,    //!< Call a class method
  44         NODETYPE_CREATEOBJECT,  //!< Create an object
  45
  46         NODETYPE_IF,    //!< Conditional
  47         NODETYPE_LOOP,  //!< Looping Construct
  48
  49         NODETYPE_INDEX, //!< Index into an array
  50
  51         NODETYPE_LOGICALNOT,    //!< Logical NOT operator
  52         NODETYPE_LOGICALAND,    //!< Logical AND operator
  53         NODETYPE_LOGICALOR,     //!< Logical OR operator
  54         NODETYPE_LOGICALXOR,    //!< Logical XOR operator
  55
  56         NODETYPE_EQUALS,        //!< Comparison Equals
  57         NODETYPE_LESSTHAN,      //!< Comparison Less Than
  58         NODETYPE_LESSTHANEQUAL, //!< Comparison Less Than or Equal
  59         NODETYPE_GREATERTHAN,   //!< Comparison Greater Than
  60         NODETYPE_GREATERTHANEQUAL,      //!< Comparison Greater Than or Equal
  61
  62         NODETYPE_BWNOT, //!< Bitwise NOT
  63         NODETYPE_BWAND, //!< Bitwise AND
  64         NODETYPE_BWOR,  //!< Bitwise OR
  65         NODETYPE_BWXOR, //!< Bitwise XOR
  66
  67         NODETYPE_BITSHIFTLEFT,  //!< Bitwise Shift Left (Grow)
  68         NODETYPE_BITSHIFTRIGHT, //!< Bitwise Shift Right (Shrink)
  69         NODETYPE_BITROTATELEFT, //!< Bitwise Rotate Left (Grow)
  70
  71         NODETYPE_NEGATE,        //!< Negagte
  72         NODETYPE_ADD,   //!< Add
  73         NODETYPE_SUBTRACT,      //!< Subtract
  74         NODETYPE_MULTIPLY,      //!< Multiply
  75         NODETYPE_DIVIDE,        //!< Divide
  76         NODETYPE_MODULO,        //!< Modulus
  77 };
  78
  79 struct sAST_Node
  80 {
  81         tAST_Node       *NextSibling;
  82         tAST_NodeType   Type;
  83
  84         const char      *File;
  85          int    Line;
  86
  87         void    *BlockState;    //!< BlockState pointer (for cache integrity)
  88          int    BlockIdent;     //!< Ident (same as above)
  89         void    *ValueCache;    //!< Cached value / pointer
  90
  91         union
  92         {
  93                 struct {
  94                         tAST_Node       *FirstChild;
  95                         tAST_Node       *LastChild;
  96                 }       Block;
  97
  98                 struct {
  99                          int    Operation;
 100                         tAST_Node       *Dest;
 101                         tAST_Node       *Value;
 102                 }       Assign;
 103
 104                 struct {
 105                         tAST_Node       *Value;
 106                 }       UniOp;
 107
 108                 struct {
 109                         tAST_Node       *Left;
 110                         tAST_Node       *Right;
 111                 }       BinOp;
 112
 113                 struct {
 114                         tAST_Node       *Object;
 115                         tAST_Node       *FirstArg;
 116                         tAST_Node       *LastArg;
 117                          int    NumArgs;
 118                         char    Name[];
 119                 }       FunctionCall;
 120
 121                 struct {
 122                         tAST_Node       *Condition;
 123                         tAST_Node       *True;
 124                         tAST_Node       *False;
 125                 }       If;
 126
 127                 struct {
 128                         tAST_Node       *Init;
 129                          int    bCheckAfter;
 130                         tAST_Node       *Condition;
 131                         tAST_Node       *Increment;
 132                         tAST_Node       *Code;
 133                         char    Tag[];
 134                 }       For;
 135
 136                 /**
 137                  * \note Used for \a NODETYPE_VARIABLE and \a NODETYPE_CONSTANT
 138                  */
 139                 struct {
 140                         char    _unused;        // Shut GCC up
 141                         char    Name[];
 142                 }       Variable;
 143
 144                 struct {
 145                         tAST_Node       *Element;
 146                         char    Name[];
 147                 }       Scope;  // Used by NODETYPE_SCOPE and NODETYPE_ELEMENT
 148
 149                 struct {
 150                          int    DataType;
 151                         tAST_Node       *LevelSizes;
 152                         tAST_Node       *LevelSizes_Last;
 153                         tAST_Node       *InitialValue;
 154                         char    Name[];
 155                 }       DefVar;
 156
 157                 struct {
 158                          int    DataType;
 159                          tAST_Node      *Value;
 160                 }       Cast;
 161
 162                 // Used for NODETYPE_REAL, NODETYPE_INTEGER and NODETYPE_STRING
 163                 tSpiderValue    Constant;
 164         };
 165 };
 166
 167 /**
 168  * \brief Code Block state (stores local variables)
 169  */
 170 struct sAST_BlockState
 171 {
 172         tAST_BlockState *Parent;
 173         tSpiderScript   *Script;        //!< Script
 174         tAST_Variable   *FirstVar;      //!< First variable in the list
 175         tSpiderValue    *RetVal;
 176         tSpiderNamespace        *BaseNamespace; //!< Base namespace (for entire block)
 177         tSpiderNamespace        *CurNamespace;  //!< Currently selected namespace
 178          int    Ident;  //!< ID number used for variable lookup caching
 179         const char      *BreakTarget;
 180          int    BreakType;
 181 };
 182
 183 struct sAST_Variable
 184 {
 185         tAST_Variable   *Next;
 186          int    Type;   // Only used for static typing
 187         tSpiderValue    *Object;
 188         char    Name[];
 189 };
 190
 191 // === FUNCTIONS ===
 192 extern tAST_Script      *AST_NewScript(void);
 193 extern size_t   AST_WriteScript(void *Buffer, tSpiderScript *Script);
 194 extern size_t   AST_WriteNode(void *Buffer, size_t Offset, tAST_Node *Node);
 195
 196 extern int      AST_AppendFunction(tSpiderScript *Script, const char *Name, int ReturnType, tAST_Node *FirstArg, tAST_Node *Code);
 197
 198 extern tAST_Node        *AST_NewNop(tParser *Parser);
 199
 200 extern tAST_Node        *AST_NewString(tParser *Parser, const char *String, int Length);
 201 extern tAST_Node        *AST_NewInteger(tParser *Parser, int64_t Value);
 202 extern tAST_Node        *AST_NewReal(tParser *Parser, double Value);
 203 extern tAST_Node        *AST_NewVariable(tParser *Parser, const char *Name);
 204 extern tAST_Node        *AST_NewDefineVar(tParser *Parser, int Type, const char *Name);
 205 extern tAST_Node        *AST_NewConstant(tParser *Parser, const char *Name);
 206 extern tAST_Node        *AST_NewClassElement(tParser *Parser, tAST_Node *Object, const char *Name);
 207
 208 extern tAST_Node        *AST_NewFunctionCall(tParser *Parser, const char *Name);
 209 extern tAST_Node        *AST_NewCreateObject(tParser *Parser, const char *Name);
 210 extern tAST_Node        *AST_NewMethodCall(tParser *Parser, tAST_Node *Object, const char *Name);
 211 extern void     AST_AppendFunctionCallArg(tAST_Node *Node, tAST_Node *Arg);
 212
 213 extern tAST_Node        *AST_NewCodeBlock(tParser *Parser);
 214 extern void     AST_AppendNode(tAST_Node *Parent, tAST_Node *Child);
 215
 216 extern tAST_Node        *AST_NewIf(tParser *Parser, tAST_Node *Condition, tAST_Node *True, tAST_Node *False);
 217 extern tAST_Node        *AST_NewLoop(tParser *Parser, const char *Tag, tAST_Node *Init, int bPostCheck, tAST_Node *Condition, tAST_Node *Increment, tAST_Node *Code);
 218
 219 extern tAST_Node        *AST_NewAssign(tParser *Parser, int Operation, tAST_Node *Dest, tAST_Node *Value);
 220 extern tAST_Node        *AST_NewCast(tParser *Parser, int Target, tAST_Node *Value);
 221 extern tAST_Node        *AST_NewBinOp(tParser *Parser, int Operation, tAST_Node *Left, tAST_Node *Right);
 222 extern tAST_Node        *AST_NewUniOp(tParser *Parser, int Operation, tAST_Node *Value);
 223 extern tAST_Node        *AST_NewBreakout(tParser *Parser, int Type, const char *DestTag);
 224 extern tAST_Node        *AST_NewScopeDereference(tParser *Parser, const char *Name, tAST_Node *Child);
 225
 226 extern void     AST_FreeNode(tAST_Node *Node);
 227
 228 // exec_ast.h
 229 extern void     Object_Dereference(tSpiderValue *Object);
 230 extern void     Object_Reference(tSpiderValue *Object);
 231 extern tSpiderValue     *AST_ExecuteNode(tAST_BlockState *Block, tAST_Node *Node);
 232 extern tSpiderValue     *AST_ExecuteNode_BinOp(tSpiderScript *Script, tAST_Node *Node, int Operation, tSpiderValue *Left, tSpiderValue *Right);
 233 extern tSpiderValue     *AST_ExecuteNode_UniOp(tSpiderScript *Script, tAST_Node *Node, int Operation, tSpiderValue *Value);
 234
 235 #endif