3 * - Script AST Manipulator
12 extern void SyntaxError(tParser *Parser, int bFatal, const char *Message, ...);
16 * \brief Append a function to a script
18 int AST_AppendFunction(tSpiderScript *Script, const char *Name, int ReturnType, tAST_Node *Args, tAST_Node *Code)
20 tScript_Function *fcn;
21 int arg_count = 0, arg_bytes = 0;
24 // Count and size arguments
25 for(arg = Args; arg; arg = arg->NextSibling)
28 arg_bytes += sizeof(fcn->Arguments[0]) + strlen(Args->DefVar.Name) + 1;
31 // Allocate information
32 fcn = malloc( sizeof(tScript_Function) + arg_bytes + strlen(Name) + 1 );
35 fcn->Name = (char*)&fcn->Arguments[arg_count];
36 strcpy(fcn->Name, Name);
37 fcn->ReturnType = ReturnType;
38 fcn->ArgumentCount = arg_count;
43 arg_bytes = strlen(Name) + 1; // Used as an offset into fcn->Name
45 for(arg = Args; arg; arg = arg->NextSibling)
47 fcn->Arguments[arg_count].Name = fcn->Name + arg_bytes;
48 strcpy(fcn->Arguments[arg_count].Name, arg->DefVar.Name);
49 fcn->Arguments[arg_count].Type = arg->DefVar.DataType;
50 arg_bytes += strlen(arg->DefVar.Name) + 1;
54 if(Script->LastFunction == NULL) {
55 Script->Functions = Script->LastFunction = fcn;
58 Script->LastFunction->Next = fcn;
59 Script->LastFunction = fcn;
66 * \name Node Manipulation
69 #define WRITE_N(_buffer, _offset, _len, _dataptr) do { \
70 if(_buffer) memcpy((char*)_buffer + _offset, _dataptr, _len);\
74 #define WRITE_8(_buffer, _offset, _val) do {\
76 WRITE_N(_buffer, _offset, 1, &v);\
78 #define WRITE_16(_buffer, _offset, _val) do {\
80 WRITE_N(_buffer, _offset, 2, &v);\
82 #define WRITE_32(_buffer, _offset, _val) do {\
84 WRITE_N(_buffer, _offset, 4, &v);\
86 #define WRITE_64(_buffer, _offset, _val) do {\
88 WRITE_N(_buffer, _offset, 8, &v);\
90 #define WRITE_REAL(_buffer, _offset, _val) do {\
92 WRITE_N(_buffer, _offset, sizeof(double), &v);\
95 #define WRITE_STR(_buffer, _offset, _string) do {\
96 int len = strlen(_string);\
97 WRITE_16(_buffer, _offset, len);\
98 WRITE_N(_buffer, _offset, len, _string);\
99 if((_offset & 1) == 1)WRITE_8(_buffer, _offset, 0); \
100 if((_offset & 3) == 2)WRITE_16(_buffer, _offset, 0); \
102 #define WRITE_NODELIST(_buffer, _offset, _listHead) do {\
105 for(node=(_listHead); node; node = node->NextSibling) {\
107 _offset += AST_WriteNode(_buffer, _offset, node); \
108 WRITE_32(_buffer, ptr, ptr); \
110 if(ptr != -1){ptr -= 4; WRITE_32(_buffer, ptr, 0);} \
114 * \brief Writes a script dump to a buffer
115 * \return Size of encoded data
116 * \note If \a Buffer is NULL, no write is done, but the size is still returned
118 size_t AST_WriteScript(void *Buffer, tSpiderScript *Script)
120 tScript_Function *fcn;
121 size_t ret = 0, ptr = 0;
124 for( fcn = Script->Functions; fcn; fcn = fcn->Next )
126 // printf("fcn = %p, fcn->Name = %p\n", fcn, fcn->Name);
128 WRITE_32(Buffer, ret, 0); // Next
129 WRITE_STR(Buffer, ret, fcn->Name);
130 WRITE_32(Buffer, ret, fcn->ArgumentCount);
131 for( i = 0; i < fcn->ArgumentCount; i ++ )
133 WRITE_16(Buffer, ret, fcn->Arguments[i].Type);
134 WRITE_STR(Buffer, ret, fcn->Arguments[i].Name);
136 ret += AST_WriteNode(Buffer, ret, fcn->ASTFcn);
137 WRITE_32(Buffer, ptr, ret); // Actually set `Next`
142 WRITE_32(Buffer, ptr, 0); // Clear next for final
149 * \brief Write a node to a file
151 size_t AST_WriteNode(void *Buffer, size_t Offset, tAST_Node *Node)
153 size_t baseOfs = Offset;
156 //fprintf(stderr, "Possible Bug - NULL passed to AST_WriteNode\n");
157 WRITE_32(Buffer, Offset, 0);
158 WRITE_16(Buffer, Offset, NODETYPE_NOP);
159 WRITE_16(Buffer, Offset, 0); // Line (0)
163 WRITE_32(Buffer, Offset, 0); // Next
164 WRITE_16(Buffer, Offset, Node->Type);
165 // TODO: Scan the buffer for the location of the filename (with NULL byte)
166 // else, write the string at the end of the node
167 WRITE_16(Buffer, Offset, Node->Line); // Line
168 //WRITE_32(Buffer, Offset, 0); // File
174 WRITE_NODELIST(Buffer, Offset, Node->Block.FirstChild);
178 case NODETYPE_METHODCALL:
179 Offset += AST_WriteNode(Buffer, Offset, Node->FunctionCall.Object);
180 case NODETYPE_FUNCTIONCALL:
181 case NODETYPE_CREATEOBJECT:
182 // TODO: Search for the same function name and add a pointer
183 WRITE_STR(Buffer, Offset, Node->FunctionCall.Name);
184 WRITE_NODELIST(Buffer, Offset, Node->FunctionCall.FirstArg);
189 Offset += AST_WriteNode(Buffer, Offset, Node->If.Condition);
190 Offset += AST_WriteNode(Buffer, Offset, Node->If.True);
191 Offset += AST_WriteNode(Buffer, Offset, Node->If.False);
194 // Looping Construct (For loop node)
196 WRITE_8(Buffer, Offset, Node->For.bCheckAfter);
197 WRITE_STR(Buffer, Offset, Node->For.Tag);
198 Offset += AST_WriteNode(Buffer, Offset, Node->For.Init);
199 Offset += AST_WriteNode(Buffer, Offset, Node->For.Condition);
200 Offset += AST_WriteNode(Buffer, Offset, Node->For.Increment);
201 Offset += AST_WriteNode(Buffer, Offset, Node->For.Code);
205 case NODETYPE_ASSIGN:
206 WRITE_8(Buffer, Offset, Node->Assign.Operation);
207 Offset += AST_WriteNode(Buffer, Offset, Node->Assign.Dest);
208 Offset += AST_WriteNode(Buffer, Offset, Node->Assign.Value);
213 WRITE_8(Buffer, Offset, Node->Cast.DataType);
214 Offset += AST_WriteNode(Buffer, Offset, Node->Cast.Value);
218 case NODETYPE_DEFVAR:
219 WRITE_32(Buffer, Offset, Node->DefVar.DataType);
220 // TODO: Duplicate compress the strings
221 WRITE_STR(Buffer, Offset, Node->DefVar.Name);
222 Offset += AST_WriteNode(Buffer, Offset, Node->DefVar.InitialValue);
227 case NODETYPE_ELEMENT:
228 WRITE_STR(Buffer, Offset, Node->Scope.Name);
229 Offset += AST_WriteNode(Buffer, Offset, Node->UniOp.Value);
233 case NODETYPE_RETURN:
235 case NODETYPE_LOGICALNOT:
236 case NODETYPE_NEGATE:
237 case NODETYPE_POSTINC:
238 case NODETYPE_POSTDEC:
239 Offset += AST_WriteNode(Buffer, Offset, Node->UniOp.Value);
245 case NODETYPE_SUBTRACT:
246 case NODETYPE_MULTIPLY:
247 case NODETYPE_DIVIDE:
248 case NODETYPE_MODULO:
249 case NODETYPE_BITSHIFTLEFT:
250 case NODETYPE_BITSHIFTRIGHT:
251 case NODETYPE_BITROTATELEFT:
252 case NODETYPE_BWAND: case NODETYPE_LOGICALAND:
253 case NODETYPE_BWOR: case NODETYPE_LOGICALOR:
254 case NODETYPE_BWXOR: case NODETYPE_LOGICALXOR:
255 case NODETYPE_EQUALS: case NODETYPE_NOTEQUALS:
256 case NODETYPE_LESSTHAN: case NODETYPE_LESSTHANEQUAL:
257 case NODETYPE_GREATERTHAN: case NODETYPE_GREATERTHANEQUAL:
258 Offset += AST_WriteNode(Buffer, Offset, Node->BinOp.Left);
259 Offset += AST_WriteNode(Buffer, Offset, Node->BinOp.Right);
262 // Node types with no children
265 case NODETYPE_VARIABLE:
266 case NODETYPE_CONSTANT:
268 case NODETYPE_CONTINUE:
269 // TODO: De-Duplicate the strings
270 WRITE_STR(Buffer, Offset, Node->Variable.Name);
272 case NODETYPE_STRING:
273 WRITE_32(Buffer, Offset, Node->Constant.String.Length);
274 WRITE_N(Buffer, Offset, Node->Constant.String.Length, Node->Constant.String.Data);
276 case NODETYPE_INTEGER:
277 WRITE_64(Buffer, Offset, Node->Constant.Integer);
280 WRITE_REAL(Buffer, Offset, Node->Constant.Real);
286 // fprintf(stderr, "AST_WriteNode: Unknown node type %i\n", Node->Type);
290 return Offset - baseOfs;
294 * \brief Free a node and all subnodes
296 void AST_FreeNode(tAST_Node *Node)
302 // Referenced counted file name
303 (*(int*)(Node->File - sizeof(int))) -= 1;
304 if( *(int*)(Node->File - sizeof(int)) == 0 )
305 free( (void*)(Node->File - sizeof(int)) );
311 for( node = Node->Block.FirstChild; node; )
313 tAST_Node *savedNext = node->NextSibling;
320 case NODETYPE_METHODCALL:
321 AST_FreeNode(Node->FunctionCall.Object);
322 case NODETYPE_FUNCTIONCALL:
323 case NODETYPE_CREATEOBJECT:
324 for( node = Node->FunctionCall.FirstArg; node; )
326 tAST_Node *savedNext = node->NextSibling;
334 AST_FreeNode(Node->If.Condition);
335 AST_FreeNode(Node->If.True);
336 AST_FreeNode(Node->If.False);
339 // Looping Construct (For loop node)
341 AST_FreeNode(Node->For.Init);
342 AST_FreeNode(Node->For.Condition);
343 AST_FreeNode(Node->For.Increment);
344 AST_FreeNode(Node->For.Code);
348 case NODETYPE_ASSIGN:
349 AST_FreeNode(Node->Assign.Dest);
350 AST_FreeNode(Node->Assign.Value);
355 AST_FreeNode(Node->Cast.Value);
359 case NODETYPE_ELEMENT:
360 AST_FreeNode(Node->Scope.Element);
364 case NODETYPE_DEFVAR:
365 AST_FreeNode(Node->DefVar.InitialValue);
369 case NODETYPE_RETURN:
371 case NODETYPE_LOGICALNOT:
372 case NODETYPE_NEGATE:
373 case NODETYPE_POSTINC:
374 case NODETYPE_POSTDEC:
375 AST_FreeNode(Node->UniOp.Value);
381 case NODETYPE_SUBTRACT:
382 case NODETYPE_MULTIPLY:
383 case NODETYPE_DIVIDE:
384 case NODETYPE_MODULO:
385 case NODETYPE_BITSHIFTLEFT:
386 case NODETYPE_BITSHIFTRIGHT:
387 case NODETYPE_BITROTATELEFT:
388 case NODETYPE_BWAND: case NODETYPE_LOGICALAND:
389 case NODETYPE_BWOR: case NODETYPE_LOGICALOR:
390 case NODETYPE_BWXOR: case NODETYPE_LOGICALXOR:
391 case NODETYPE_EQUALS: case NODETYPE_NOTEQUALS:
392 case NODETYPE_LESSTHAN: case NODETYPE_LESSTHANEQUAL:
393 case NODETYPE_GREATERTHAN: case NODETYPE_GREATERTHANEQUAL:
394 AST_FreeNode( Node->BinOp.Left );
395 AST_FreeNode( Node->BinOp.Right );
398 // Node types with no children
399 case NODETYPE_NOP: break;
400 case NODETYPE_NULL: break;
401 case NODETYPE_VARIABLE: break;
402 case NODETYPE_CONSTANT: break;
404 case NODETYPE_CONTINUE: break;
406 case NODETYPE_STRING:
407 case NODETYPE_INTEGER:
409 if( Node->ValueCache )
410 SpiderScript_DereferenceValue(Node->ValueCache);
411 Node->ValueCache = NULL;
417 tAST_Node *AST_int_AllocateNode(tParser *Parser, int Type, int ExtraSize)
419 tAST_Node *ret = malloc( sizeof(tAST_Node) + ExtraSize );
420 ret->NextSibling = NULL;
421 ret->File = Parser->Filename; *(int*)(Parser->Filename - sizeof(int)) += 1;
422 ret->Line = Parser->CurLine;
426 ret->BlockState = NULL;
428 ret->ValueCache = NULL;
433 tAST_Node *AST_NewCodeBlock(tParser *Parser)
435 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_BLOCK, 0 );
437 ret->Block.FirstChild = NULL;
438 ret->Block.LastChild = NULL;
443 void AST_AppendNode(tAST_Node *Parent, tAST_Node *Child)
445 // Ignore NULL children
446 if( !Child ) return ;
448 Child->NextSibling = NULL;
449 switch( Parent->Type )
452 if(Parent->Block.FirstChild == NULL) {
453 Parent->Block.FirstChild = Parent->Block.LastChild = Child;
456 Parent->Block.LastChild->NextSibling = Child;
457 Parent->Block.LastChild = Child;
461 fprintf(stderr, "BUG REPORT: AST_AppendNode on an invalid node type (%i)\n", Parent->Type);
466 tAST_Node *AST_NewIf(tParser *Parser, tAST_Node *Condition, tAST_Node *True, tAST_Node *False)
468 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_IF, 0);
469 ret->If.Condition = Condition;
471 ret->If.False = False;
475 tAST_Node *AST_NewLoop(tParser *Parser, const char *Tag, tAST_Node *Init, int bPostCheck, tAST_Node *Condition, tAST_Node *Increment, tAST_Node *Code)
479 // NOTE: The +3) & ~3 is to align the size to 4 bytes, and shut valgrind up
480 // - GCC sometimes inlines strlen as a loop of dword reads, triggering valgrind
481 ret = AST_int_AllocateNode(Parser, NODETYPE_LOOP, (strlen(Tag) + 1 + 3) & ~3);
482 ret->For.Init = Init;
483 ret->For.bCheckAfter = !!bPostCheck;
484 ret->For.Condition = Condition;
485 ret->For.Increment = Increment;
486 ret->For.Code = Code;
487 strcpy(ret->For.Tag, Tag);
491 tAST_Node *AST_NewAssign(tParser *Parser, int Operation, tAST_Node *Dest, tAST_Node *Value)
493 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_ASSIGN, 0);
495 if( Dest->Type != NODETYPE_VARIABLE && Dest->Type != NODETYPE_ELEMENT && Dest->Type != NODETYPE_INDEX )
498 SyntaxError(Parser, 1, "Assign target is not a variable or attribute (instead %i)",
505 ret->Assign.Operation = Operation;
506 ret->Assign.Dest = Dest;
507 ret->Assign.Value = Value;
512 tAST_Node *AST_NewCast(tParser *Parser, int Target, tAST_Node *Value)
514 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_CAST, 0);
516 ret->Cast.DataType = Target;
517 ret->Cast.Value = Value;
522 tAST_Node *AST_NewBinOp(tParser *Parser, int Operation, tAST_Node *Left, tAST_Node *Right)
524 tAST_Node *ret = AST_int_AllocateNode(Parser, Operation, 0);
526 ret->BinOp.Left = Left;
527 ret->BinOp.Right = Right;
534 tAST_Node *AST_NewUniOp(tParser *Parser, int Operation, tAST_Node *Value)
536 tAST_Node *ret = AST_int_AllocateNode(Parser, Operation, 0);
538 ret->UniOp.Value = Value;
543 tAST_Node *AST_NewBreakout(tParser *Parser, int Type, const char *DestTag)
545 int len = (DestTag ? strlen(DestTag) : 0);
546 tAST_Node *ret = AST_int_AllocateNode(Parser, Type, len + 1);
549 strcpy(ret->Variable.Name, DestTag);
551 ret->Variable.Name[0] = '\0';
556 tAST_Node *AST_NewNop(tParser *Parser)
558 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_NOP, 0);
564 * \brief Create a new string node
566 tAST_Node *AST_NewString(tParser *Parser, const char *String, int Length)
568 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_STRING, Length + 1);
570 ret->Constant.Type = SS_DATATYPE_STRING;
571 ret->Constant.ReferenceCount = 1;
572 ret->Constant.String.Length = Length;
573 memcpy(ret->Constant.String.Data, String, Length);
574 ret->Constant.String.Data[Length] = '\0';
580 * \brief Create a new integer node
582 tAST_Node *AST_NewInteger(tParser *Parser, int64_t Value)
584 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_INTEGER, 0);
585 ret->Constant.Type = SS_DATATYPE_INTEGER;
586 ret->Constant.ReferenceCount = 1;
587 ret->Constant.Integer = Value;
592 * \brief Create a new real number node
594 tAST_Node *AST_NewReal(tParser *Parser, double Value)
596 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_REAL, 0);
597 ret->Constant.Type = SS_DATATYPE_REAL;
598 ret->Constant.ReferenceCount = 1;
599 ret->Constant.Real = Value;
604 * \brief Return a null value
606 tAST_Node *AST_NewNull(tParser *Parser)
608 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_NULL, 0);
614 * \brief Create a new variable reference node
616 tAST_Node *AST_NewVariable(tParser *Parser, const char *Name)
618 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_VARIABLE, strlen(Name) + 1 );
619 strcpy(ret->Variable.Name, Name);
624 * \brief Create a new variable definition node
626 tAST_Node *AST_NewDefineVar(tParser *Parser, int Type, const char *Name)
628 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_DEFVAR, strlen(Name) + 1 );
630 ret->DefVar.DataType = Type;
631 ret->DefVar.InitialValue = NULL;
632 strcpy(ret->DefVar.Name, Name);
638 * \brief Create a new runtime constant reference node
640 tAST_Node *AST_NewConstant(tParser *Parser, const char *Name)
642 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_CONSTANT, strlen(Name) + 1 );
644 strcpy(ret->Variable.Name, Name);
650 * \brief Create a function call node
651 * \note Argument list is manipulated using AST_AppendFunctionCallArg
653 tAST_Node *AST_NewFunctionCall(tParser *Parser, const char *Name)
655 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_FUNCTIONCALL, strlen(Name) + 1 );
657 ret->FunctionCall.Object = NULL;
658 ret->FunctionCall.FirstArg = NULL;
659 ret->FunctionCall.LastArg = NULL;
660 ret->FunctionCall.NumArgs = 0;
661 strcpy(ret->FunctionCall.Name, Name);
665 tAST_Node *AST_NewMethodCall(tParser *Parser, tAST_Node *Object, const char *Name)
667 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_METHODCALL, strlen(Name) + 1 );
669 ret->FunctionCall.Object = Object;
670 ret->FunctionCall.FirstArg = NULL;
671 ret->FunctionCall.LastArg = NULL;
672 ret->FunctionCall.NumArgs = 0;
673 strcpy(ret->FunctionCall.Name, Name);
678 tAST_Node *AST_NewCreateObject(tParser *Parser, const char *Name)
680 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_CREATEOBJECT, strlen(Name) + 1 );
682 ret->FunctionCall.Object = NULL;
683 ret->FunctionCall.FirstArg = NULL;
684 ret->FunctionCall.LastArg = NULL;
685 ret->FunctionCall.NumArgs = 0;
686 strcpy(ret->FunctionCall.Name, Name);
692 * \brief Append an argument to a function call
694 void AST_AppendFunctionCallArg(tAST_Node *Node, tAST_Node *Arg)
696 if( Node->Type != NODETYPE_FUNCTIONCALL
697 && Node->Type != NODETYPE_CREATEOBJECT
698 && Node->Type != NODETYPE_METHODCALL)
700 fprintf(stderr, "BUG REPORT: AST_AppendFunctionCallArg on an invalid node type (%i)\n", Node->Type);
704 if(Node->FunctionCall.LastArg) {
705 Node->FunctionCall.LastArg->NextSibling = Arg;
706 Node->FunctionCall.LastArg = Arg;
709 Node->FunctionCall.FirstArg = Arg;
710 Node->FunctionCall.LastArg = Arg;
712 Node->FunctionCall.NumArgs ++;
716 * \brief Add a scope node
718 tAST_Node *AST_NewScopeDereference(tParser *Parser, const char *Name, tAST_Node *Child)
720 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_SCOPE, strlen(Name) + 1 );
721 ret->Scope.Element = Child;
722 strcpy(ret->Scope.Name, Name);
727 * \brief Add a scope node
729 tAST_Node *AST_NewClassElement(tParser *Parser, tAST_Node *Object, const char *Name)
731 tAST_Node *ret = AST_int_AllocateNode(Parser, NODETYPE_ELEMENT, strlen(Name) + 1 );
732 ret->Scope.Element = Object;
733 strcpy(ret->Scope.Name, Name);