3 * Drafted after the Small-C compiler Version 2.01, originally created
4 * by Ron Cain, july 1980, and enhanced by James E. Hendrix.
6 * This version comes close to a complete rewrite.
8 * Copyright R. Cain, 1980
9 * Copyright J.E. Hendrix, 1982, 1983
10 * Copyright ITB CompuPhase, 1997-2006
12 * This software is provided "as-is", without any express or implied warranty.
13 * In no event will the authors be held liable for any damages arising from
14 * the use of this software.
16 * Permission is granted to anyone to use this software for any purpose,
17 * including commercial applications, and to alter it and redistribute it
18 * freely, subject to the following restrictions:
20 * 1. The origin of this software must not be misrepresented; you must not
21 * claim that you wrote the original software. If you use this software in
22 * a product, an acknowledgment in the product documentation would be
23 * appreciated but is not required.
24 * 2. Altered source versions must be plainly marked as such, and must not be
25 * misrepresented as being the original software.
26 * 3. This notice may not be removed or altered from any source distribution.
35 #if defined __BORLANDC__ && defined _Windows && !(defined __32BIT__ || defined __WIN32__)
36 /* setjmp() and longjmp() not well supported in 16-bit windows */
38 typedef int jmp_buf[9];
39 #define setjmp(b) Catch(b)
40 #define longjmp(b,e) Throw(b,e)
47 /* Note: the "cell" and "ucell" types are defined in AMX.H */
49 #define PUBLIC_CHAR '@' /* character that defines a function "public" */
50 #define CTRL_CHAR '\\' /* default control character */
51 #define sCHARBITS 8 /* size of a packed character */
53 #define sDIMEN_MAX 4 /* maximum number of array dimensions */
54 #define sLINEMAX 1023 /* input line length (in characters) */
55 #define sCOMP_STACK 32 /* maximum nesting of #if .. #endif sections */
56 #define sDEF_LITMAX 500 /* initial size of the literal pool, in "cells" */
57 #define sDEF_AMXSTACK 4096 /* default stack size for AMX files */
58 #define PREPROC_TERM '\x7f'/* termination character for preprocessor expressions (the "DEL" code) */
59 #define sDEF_PREFIX "sourcemod.inc" /* default prefix filename */
60 #define sARGS_MAX 32 /* number of arguments a function can have, max */
61 #define sTAGS_MAX 16 /* maximum number of tags on an argument */
64 void *pv; /* e.g. a name */
66 } stkitem; /* type of items stored on the compiler stack */
68 typedef struct s_arginfo { /* function argument info */
69 char name[sNAMEMAX+1];
70 char ident; /* iVARIABLE, iREFERENCE, iREFARRAY or iVARARGS */
71 char usage; /* uCONST */
72 int *tags; /* argument tag id. list */
73 int numtags; /* number of tags in the tag list */
75 int idxtag[sDIMEN_MAX];
76 int numdim; /* number of dimensions */
77 unsigned char hasdefault; /* bit0: is there a default value? bit6: "tagof"; bit7: "sizeof" */
79 cell val; /* default value */
81 char *symname; /* name of another symbol */
82 short level; /* indirection level for that symbol */
83 } size; /* used for "sizeof" default value */
85 cell *data; /* values of default array */
86 int size; /* complete length of default array */
87 int arraysize; /* size to reserve on the heap */
88 cell addr; /* address of the default array in the data segment */
90 } defvalue; /* default value, or pointer to default array */
91 int defvalue_tag; /* tag of the default value */
94 /* Equate table, tagname table, library table */
95 typedef struct s_constvalue {
96 struct s_constvalue *next;
97 char name[sNAMEMAX+1];
99 int index; /* index level, for constants referring to array sizes/tags
100 * automaton id. for states and automatons
101 * tag for enumeration lists */
104 /* Symbol table format
106 * The symbol name read from the input file is stored in "name", the
107 * value of "addr" is written to the output file. The address in "addr"
108 * depends on the class of the symbol:
109 * global offset into the data segment
110 * local offset relative to the stack frame
111 * label generated hexadecimal number
112 * function offset into code segment
114 typedef struct s_symbol {
115 struct s_symbol *next;
116 struct s_symbol *parent; /* hierarchical types (multi-dimensional arrays) */
117 char name[sNAMEMAX+1];
118 uint32_t hash; /* value derived from name, for quicker searching */
119 cell addr; /* address or offset (or value for constant, index for native function) */
120 cell codeaddr; /* address (in the code segment) where the symbol declaration starts */
121 char vclass; /* sLOCAL if "addr" refers to a local symbol */
122 char ident; /* see below for possible values */
123 short usage; /* see below for possible values */
124 char flags; /* see below for possible values */
125 int compound; /* compound level (braces nesting level) */
126 int tag; /* tagname id */
128 int declared; /* label: how many local variables are declared */
130 int index; /* array & enum: tag of array indices or the enum item */
131 int field; /* enumeration fields, where a size is attached to the field */
132 } tags; /* extra tags */
133 constvalue *lib; /* native function: library it is part of */
134 long stacksize; /* normal/public function: stack requirements */
135 } x; /* 'x' for 'extra' */
137 arginfo *arglist; /* types of all parameters for functions */
138 constvalue *enumlist;/* list of names for the "root" of an enumeration */
140 cell length; /* arrays: length (size) */
141 cell slength; /* if a string index, this will be set to the original size */
142 short level; /* number of dimensions below this level */
144 } dim; /* for 'dimension', both functions and arrays */
145 constvalue *states; /* list of state function/state variable ids + addresses */
146 int fnumber; /* static global variables: file number in which the declaration is visible */
147 int lnumber; /* line number (in the current source file) for the declaration */
148 struct s_symbol **refer; /* referrer list, functions that "use" this symbol */
149 int numrefers; /* number of entries in the referrer list */
150 char *documentation; /* optional documentation string */
154 /* Possible entries for "ident". These are used in the "symbol", "value"
155 * and arginfo structures. Not every constant is valid for every use.
156 * In an argument list, the list is terminated with a "zero" ident; labels
157 * cannot be passed as function arguments, so the value 0 is overloaded.
160 #define iVARIABLE 1 /* cell that has an address and that can be fetched directly (lvalue) */
161 #define iREFERENCE 2 /* iVARIABLE, but must be dereferenced */
163 #define iREFARRAY 4 /* an array passed by reference (i.e. a pointer) */
164 #define iARRAYCELL 5 /* array element, cell that must be fetched indirectly */
165 #define iARRAYCHAR 6 /* array element, character from cell from array */
166 #define iEXPRESSION 7 /* expression result, has no address (rvalue) */
167 #define iCONSTEXPR 8 /* constant expression (or constant symbol) */
170 #define iVARARGS 11 /* function specified ... as argument(s) */
172 /* Possible entries for "usage"
174 * This byte is used as a serie of bits, the syntax is different for
175 * functions and other symbols:
178 * bits: 0 (uDEFINE) the variable is defined in the source file
179 * 1 (uREAD) the variable is "read" (accessed) in the source file
180 * 2 (uWRITTEN) the variable is altered (assigned a value)
181 * 3 (uCONST) the variable is constant (may not be assigned to)
182 * 4 (uPUBLIC) the variable is public
183 * 6 (uSTOCK) the variable is discardable (without warning)
186 * bits: 0 (uDEFINE) the function is defined ("implemented") in the source file
187 * 1 (uREAD) the function is invoked in the source file
188 * 2 (uRETVALUE) the function returns a value (or should return a value)
189 * 3 (uPROTOTYPED) the function was prototyped (implicitly via a definition or explicitly)
190 * 4 (uPUBLIC) the function is public
191 * 5 (uNATIVE) the function is native
192 * 6 (uSTOCK) the function is discardable (without warning)
193 * 7 (uMISSING) the function is not implemented in this source file
194 * 8 (uFORWARD) the function is explicitly forwardly declared
197 * bits: 0 (uDEFINE) the symbol is defined in the source file
198 * 1 (uREAD) the constant is "read" (accessed) in the source file
199 * 2 (uWRITTEN) redundant, but may be set for constants passed by reference
200 * 3 (uPREDEF) the constant is pre-defined and should be kept between passes
201 * 5 (uENUMROOT) the constant is the "root" of an enumeration
202 * 6 (uENUMFIELD) the constant is a field in a named enumeration
204 #define uDEFINE 0x001
206 #define uWRITTEN 0x004
207 #define uRETVALUE 0x004 /* function returns (or should return) a value */
209 #define uPROTOTYPED 0x008
210 #define uPREDEF 0x008 /* constant is pre-defined */
211 #define uPUBLIC 0x010
212 #define uNATIVE 0x020
213 #define uENUMROOT 0x020
215 #define uENUMFIELD 0x040
216 #define uMISSING 0x080
217 #define uFORWARD 0x100
218 #define uSTRUCT 0x200 /* :TODO: make this an ident */
219 /* uRETNONE is not stored in the "usage" field of a symbol. It is
220 * used during parsing a function, to detect a mix of "return;" and
221 * "return value;" in a few special cases.
223 #define uRETNONE 0x10
225 #define flgDEPRECATED 0x01 /* symbol is deprecated (avoid use) */
227 #define uCOUNTOF 0x20 /* set in the "hasdefault" field of the arginfo struct */
228 #define uTAGOF 0x40 /* set in the "hasdefault" field of the arginfo struct */
229 #define uSIZEOF 0x80 /* set in the "hasdefault" field of the arginfo struct */
231 #define uMAINFUNC "main"
232 #define uENTRYFUNC "entry"
234 #define sGLOBAL 0 /* global variable/constant class (no states) */
235 #define sLOCAL 1 /* local variable/constant */
236 #define sSTATIC 2 /* global life, local scope */
238 #define sSTATEVAR 3 /* criterion to find variables (sSTATEVAR implies a global variable) */
240 typedef struct s_value {
241 symbol *sym; /* symbol in symbol table, NULL for (constant) expression */
242 cell constval; /* value of the constant expression (if ident==iCONSTEXPR)
243 * also used for the size of a literal array */
244 int tag; /* tag (of the expression) */
245 int cmptag; /* for searching symbols: choose the one with the matching tag */
246 char ident; /* iCONSTEXPR, iVARIABLE, iARRAY, iARRAYCELL,
247 * iEXPRESSION or iREFERENCE */
248 char boolresult; /* boolean result for relational operators */
249 cell *arrayidx; /* last used array indices, for checking self assignment */
252 /* "while" statement queue (also used for "for" and "do - while" loops) */
254 wqBRK, /* used to restore stack for "break" */
255 wqCONT, /* used to restore stack for "continue" */
256 wqLOOP, /* loop start label number */
257 wqEXIT, /* loop exit label number (jump if false) */
259 wqSIZE /* "while queue" size */
261 #define wqTABSZ (24*wqSIZE) /* 24 nested loop statements */
264 statIDLE, /* not compiling yet */
265 statFIRST, /* first pass */
266 statWRITE, /* writing output */
267 statSKIP, /* skipping output */
270 typedef struct s_stringlist {
271 struct s_stringlist *next;
275 typedef struct s_stringpair {
276 struct s_stringpair *next;
284 /* macros for code generation */
285 #define opcodes(n) ((n)*sizeof(cell)) /* opcode size */
286 #define opargs(n) ((n)*sizeof(cell)) /* size of typical argument */
288 /* Tokens recognized by lex()
289 * Some of these constants are assigned as well to the variable "lastst" (see SC1.C)
291 #define tFIRST 256 /* value of first multi-character operator */
292 #define tMIDDLE 280 /* value of last multi-character operator */
293 #define tLAST 333 /* value of last multi-character match-able token */
294 /* multi-character operators */
295 #define taMULT 256 /* *= */
296 #define taDIV 257 /* /= */
297 #define taMOD 258 /* %= */
298 #define taADD 259 /* += */
299 #define taSUB 260 /* -= */
300 #define taSHL 261 /* <<= */
301 #define taSHRU 262 /* >>>= */
302 #define taSHR 263 /* >>= */
303 #define taAND 264 /* &= */
304 #define taXOR 265 /* ^= */
305 #define taOR 266 /* |= */
306 #define tlOR 267 /* || */
307 #define tlAND 268 /* && */
308 #define tlEQ 269 /* == */
309 #define tlNE 270 /* != */
310 #define tlLE 271 /* <= */
311 #define tlGE 272 /* >= */
312 #define tSHL 273 /* << */
313 #define tSHRU 274 /* >>> */
314 #define tSHR 275 /* >> */
315 #define tINC 276 /* ++ */
316 #define tDEC 277 /* -- */
317 #define tELLIPS 278 /* ... */
318 #define tDBLDOT 279 /* .. */
319 #define tDBLCOLON 280 /* :: */
320 /* reserved words (statements) */
328 #define tCONTINUE 288
338 #define tFUNCENUM 298
345 #define tOPERATOR 305
358 /* compiler directives */
359 #define tpASSERT 318 /* #assert */
361 #define tpELSE 320 /* #else */
362 #define tpELSEIF 321 /* #elseif */
365 #define tpENDINPUT 324
366 #define tpENDSCRPT 325
369 #define tpIF 328 /* #if */
373 #define tpTRYINCLUDE 332
375 /* semicolon is a special case, because it can be optional */
376 #define tTERM 334 /* semicolon or newline */
377 #define tENDEXPR 335 /* forced end of expression */
378 /* other recognized tokens */
379 #define tNUMBER 336 /* integer number */
380 #define tRATIONAL 337 /* rational number */
384 #define tEXPR 341 /* for assigment to "lastst" only (see SC1.C) */
385 #define tENDLESS 342 /* endless loop, for assigment to "lastst" only */
387 /* (reversed) evaluation of staging buffer */
388 #define sSTARTREORDER 0x01
389 #define sENDREORDER 0x02
390 #define sEXPRSTART 0x80 /* top bit set, rest is free */
391 #define sMAXARGS 127 /* relates to the bit pattern of sEXPRSTART */
393 #define sDOCSEP 0x01 /* to separate documentation comments between functions */
395 /* codes for ffabort() */
396 #define xEXIT 1 /* exit code in PRI */
397 #define xASSERTION 2 /* abort caused by failing assertion */
398 #define xSTACKERROR 3 /* stack/heap overflow */
399 #define xBOUNDSERROR 4 /* array index out of bounds */
400 #define xMEMACCESS 5 /* data access error */
401 #define xINVINSTR 6 /* invalid instruction */
402 #define xSTACKUNDERFLOW 7 /* stack underflow */
403 #define xHEAPUNDERFLOW 8 /* heap underflow */
404 #define xCALLBACKERR 9 /* no, or invalid, callback */
405 #define xSLEEP 12 /* sleep, exit code in PRI, tag in ALT */
412 #define sIN_CSEG 1 /* if parsing CODE */
413 #define sIN_DSEG 2 /* if parsing DATA */
414 #define sCHKBOUNDS 1 /* bit position in "debug" variable: check bounds */
415 #define sSYMBOLIC 2 /* bit position in "debug" variable: symbolic info */
416 #define sRESET 0 /* reset error flag */
417 #define sFORCESET 1 /* force error flag on */
418 #define sEXPRMARK 2 /* mark start of expression */
419 #define sEXPRRELEASE 3 /* mark end of expression */
420 #define sSETPOS 4 /* set line number for the error */
423 sOPTIMIZE_NONE, /* no optimization */
424 sOPTIMIZE_NOMACRO, /* no macro instructions */
425 sOPTIMIZE_DEFAULT, /* full optimization */
430 typedef enum s_regid {
431 sPRI, /* indicates the primary register */
432 sALT, /* indicates the secundary register */
435 typedef enum s_optmark {
436 sEXPR, /* end of expression (for expressions that form a statement) */
437 sPARM, /* end of parameter (in a function parameter list) */
438 sLDECL, /* start of local declaration (variable) */
441 #define suSLEEP_INSTR 0x01 /* the "sleep" instruction was used */
444 #define PUBLICTAG 0x8000u
445 #define FIXEDTAG 0x4000u
446 #define FUNCTAG 0x2000u
448 #define PUBLICTAG 0x80000000Lu
449 #define FIXEDTAG 0x40000000Lu
450 #define FUNCTAG 0x20000000Lu
452 #define TAGMASK (~PUBLICTAG)
453 #define CELL_MAX (((ucell)1 << (sizeof(cell)*8-1)) - 1)
456 /* interface functions */
457 #if defined __cplusplus
462 * Functions you call from the "driver" program
464 int pc_compile(int argc, char **argv);
465 int pc_addconstant(char *name,cell value,int tag);
466 int pc_addtag(char *name);
467 int pc_addfunctag(char *name);
468 int pc_enablewarning(int number,int enable);
471 * Functions called from the compiler (to be implemented by you)
474 /* general console output */
475 int pc_printf(const char *message,...);
477 /* error report function */
478 int pc_error(int number,char *message,char *filename,int firstline,int lastline,va_list argptr);
480 /* input from source file */
481 void *pc_opensrc(char *filename); /* reading only */
482 void *pc_createsrc(char *filename);
483 void pc_closesrc(void *handle); /* never delete */
484 void pc_resetsrc(void *handle,void *position); /* reset to a position marked earlier */
485 char *pc_readsrc(void *handle,unsigned char *target,int maxchars);
486 int pc_writesrc(void *handle,unsigned char *source);
487 void *pc_getpossrc(void *handle); /* mark the current position */
488 int pc_eofsrc(void *handle);
490 /* output to intermediate (.ASM) file */
491 void *pc_openasm(char *filename); /* read/write */
492 void pc_closeasm(void *handle,int deletefile);
493 void pc_resetasm(void *handle);
494 int pc_writeasm(void *handle,char *str);
495 char *pc_readasm(void *handle,char *target,int maxchars);
497 /* output to binary (.AMX) file */
498 void *pc_openbin(char *filename);
499 void pc_closebin(void *handle,int deletefile);
500 void pc_resetbin(void *handle,long offset);
501 int pc_writebin(void *handle,void *buffer,int size);
502 long pc_lengthbin(void *handle); /* return the length of the file */
504 #if defined __cplusplus
509 /* by default, functions and variables used in throughout the compiler
510 * files are "external"
515 #if !defined SC_VDECL
516 #define SC_VDECL extern
518 #if !defined SC_VDEFINE
522 void sp_fdbg_ntv_start(int num_natives);
523 void sp_fdbg_ntv_hook(int index, symbol *sym);
525 /* function prototypes in SC1.C */
526 SC_FUNC void set_extension(char *filename,char *extension,int force);
527 SC_FUNC symbol *fetchfunc(char *name,int tag);
528 SC_FUNC char *operator_symname(char *symname,char *opername,int tag1,int tag2,int numtags,int resulttag);
529 SC_FUNC char *funcdisplayname(char *dest,char *funcname);
530 SC_FUNC int constexpr(cell *val,int *tag,symbol **symptr);
531 SC_FUNC constvalue *append_constval(constvalue *table,const char *name,cell val,int index);
532 SC_FUNC constvalue *find_constval(constvalue *table,char *name,int index);
533 SC_FUNC void delete_consttable(constvalue *table);
534 SC_FUNC symbol *add_constant(char *name,cell val,int vclass,int tag);
535 SC_FUNC void exporttag(int tag);
536 SC_FUNC void sc_attachdocumentation(symbol *sym);
537 SC_FUNC constvalue *find_tag_byval(int tag);
539 /* function prototypes in SC2.C */
540 #define PUSHSTK_P(v) { stkitem s_; s_.pv=(v); pushstk(s_); }
541 #define PUSHSTK_I(v) { stkitem s_; s_.i=(v); pushstk(s_); }
542 #define POPSTK_P() (popstk().pv)
543 #define POPSTK_I() (popstk().i)
544 SC_FUNC void pushstk(stkitem val);
545 SC_FUNC stkitem popstk(void);
546 SC_FUNC void clearstk(void);
547 SC_FUNC int plungequalifiedfile(char *name); /* explicit path included */
548 SC_FUNC int plungefile(char *name,int try_currentpath,int try_includepaths); /* search through "include" paths */
549 SC_FUNC void preprocess(void);
550 SC_FUNC void lexinit(void);
551 SC_FUNC int lex(cell *lexvalue,char **lexsym);
552 SC_FUNC void lexpush(void);
553 SC_FUNC void lexclr(int clreol);
554 SC_FUNC int matchtoken(int token);
555 SC_FUNC int tokeninfo(cell *val,char **str);
556 SC_FUNC int needtoken(int token);
557 SC_FUNC void litadd(cell value);
558 SC_FUNC void litinsert(cell value,int pos);
559 SC_FUNC int alphanum(char c);
560 SC_FUNC int ishex(char c);
561 SC_FUNC void delete_symbol(symbol *root,symbol *sym);
562 SC_FUNC void delete_symbols(symbol *root,int level,int del_labels,int delete_functions);
563 SC_FUNC int refer_symbol(symbol *entry,symbol *bywhom);
564 SC_FUNC void markusage(symbol *sym,int usage);
565 SC_FUNC uint32_t namehash(const char *name);
566 SC_FUNC symbol *findglb(const char *name,int filter);
567 SC_FUNC symbol *findloc(const char *name);
568 SC_FUNC symbol *findconst(const char *name,int *matchtag);
569 SC_FUNC symbol *finddepend(const symbol *parent);
570 SC_FUNC symbol *addsym(const char *name,cell addr,int ident,int vclass,int tag,
572 SC_FUNC symbol *addvariable(const char *name,cell addr,int ident,int vclass,int tag,
573 int dim[],int numdim,int idxtag[]);
574 SC_FUNC symbol *addvariable2(const char *name,cell addr,int ident,int vclass,int tag,
575 int dim[],int numdim,int idxtag[],int slength);
576 SC_FUNC int getlabel(void);
577 SC_FUNC char *itoh(ucell val);
579 /* function prototypes in SC3.C */
580 SC_FUNC int check_userop(void (*oper)(void),int tag1,int tag2,int numparam,
581 value *lval,int *resulttag);
582 SC_FUNC int matchtag(int formaltag,int actualtag,int allowcoerce);
583 SC_FUNC int checktag(int tags[],int numtags,int exprtag);
584 SC_FUNC int expression(cell *val,int *tag,symbol **symptr,int chkfuncresult,value *_lval);
585 SC_FUNC int sc_getstateid(constvalue **automaton,constvalue **state);
586 SC_FUNC cell array_totalsize(symbol *sym);
587 SC_FUNC int matchtag_string(int ident, int tag);
588 SC_FUNC int checktag_string(value *sym1, value *sym2);
589 SC_FUNC int checktags_string(int tags[], int numtags, value *sym1);
591 /* function prototypes in SC4.C */
592 SC_FUNC void writeleader(symbol *root);
593 SC_FUNC void writetrailer(void);
594 SC_FUNC void begcseg(void);
595 SC_FUNC void begdseg(void);
596 SC_FUNC void setline(int chkbounds);
597 SC_FUNC void setfiledirect(char *name);
598 SC_FUNC void setlinedirect(int line);
599 SC_FUNC void setlabel(int index);
600 SC_FUNC void markexpr(optmark type,const char *name,cell offset);
601 SC_FUNC void startfunc(char *fname);
602 SC_FUNC void endfunc(void);
603 SC_FUNC void alignframe(int numbytes);
604 SC_FUNC void rvalue(value *lval);
605 SC_FUNC void address(symbol *ptr,regid reg);
606 SC_FUNC void store(value *lval);
607 SC_FUNC void loadreg(cell address,regid reg);
608 SC_FUNC void storereg(cell address,regid reg);
609 SC_FUNC void memcopy(cell size);
610 SC_FUNC void copyarray(symbol *sym,cell size);
611 SC_FUNC void fillarray(symbol *sym,cell size,cell value);
612 SC_FUNC void ldconst(cell val,regid reg);
613 SC_FUNC void moveto1(void);
614 SC_FUNC void pushreg(regid reg);
615 SC_FUNC void pushval(cell val);
616 SC_FUNC void popreg(regid reg);
617 SC_FUNC void genarray(int dims, int _autozero);
618 SC_FUNC void swap1(void);
619 SC_FUNC void ffswitch(int label);
620 SC_FUNC void ffcase(cell value,char *labelname,int newtable);
621 SC_FUNC void ffcall(symbol *sym,const char *label,int numargs);
622 SC_FUNC void ffret(int remparams);
623 SC_FUNC void ffabort(int reason);
624 SC_FUNC void ffbounds(cell size);
625 SC_FUNC void jumplabel(int number);
626 SC_FUNC void defstorage(void);
627 SC_FUNC void modstk(int delta);
628 SC_FUNC void setstk(cell value);
629 SC_FUNC void modheap(int delta);
630 SC_FUNC void modheap_i();
631 SC_FUNC void setheap_pri(void);
632 SC_FUNC void setheap(cell value);
633 SC_FUNC void cell2addr(void);
634 SC_FUNC void cell2addr_alt(void);
635 SC_FUNC void addr2cell(void);
636 SC_FUNC void char2addr(void);
637 SC_FUNC void charalign(void);
638 SC_FUNC void addconst(cell value);
639 SC_FUNC void setheap_save(cell value);
640 SC_FUNC void stradjust(regid reg);
642 /* Code generation functions for arithmetic operators.
644 * Syntax: o[u|s|b]_name
645 * | | | +--- name of operator
646 * | | +----- underscore
647 * | +--------- "u"nsigned operator, "s"igned operator or "b"oth
648 * +------------- "o"perator
650 SC_FUNC void os_mult(void); /* multiplication (signed) */
651 SC_FUNC void os_div(void); /* division (signed) */
652 SC_FUNC void os_mod(void); /* modulus (signed) */
653 SC_FUNC void ob_add(void); /* addition */
654 SC_FUNC void ob_sub(void); /* subtraction */
655 SC_FUNC void ob_sal(void); /* shift left (arithmetic) */
656 SC_FUNC void os_sar(void); /* shift right (arithmetic, signed) */
657 SC_FUNC void ou_sar(void); /* shift right (logical, unsigned) */
658 SC_FUNC void ob_or(void); /* bitwise or */
659 SC_FUNC void ob_xor(void); /* bitwise xor */
660 SC_FUNC void ob_and(void); /* bitwise and */
661 SC_FUNC void ob_eq(void); /* equality */
662 SC_FUNC void ob_ne(void); /* inequality */
663 SC_FUNC void relop_prefix(void);
664 SC_FUNC void relop_suffix(void);
665 SC_FUNC void os_le(void); /* less or equal (signed) */
666 SC_FUNC void os_ge(void); /* greater or equal (signed) */
667 SC_FUNC void os_lt(void); /* less (signed) */
668 SC_FUNC void os_gt(void); /* greater (signed) */
670 SC_FUNC void lneg(void);
671 SC_FUNC void neg(void);
672 SC_FUNC void invert(void);
673 SC_FUNC void nooperation(void);
674 SC_FUNC void inc(value *lval);
675 SC_FUNC void dec(value *lval);
676 SC_FUNC void jmp_ne0(int number);
677 SC_FUNC void jmp_eq0(int number);
678 SC_FUNC void outval(cell val,int newline);
680 /* function prototypes in SC5.C */
681 SC_FUNC int error(int number,...);
682 SC_FUNC void errorset(int code,int line);
684 /* function prototypes in SC6.C */
685 SC_FUNC int assemble(FILE *fout,FILE *fin);
687 /* function prototypes in SC7.C */
688 SC_FUNC void stgbuffer_cleanup(void);
689 SC_FUNC void stgmark(char mark);
690 SC_FUNC void stgwrite(const char *st);
691 SC_FUNC void stgout(int index);
692 SC_FUNC void stgdel(int index,cell code_index);
693 SC_FUNC int stgget(int *index,cell *code_index);
694 SC_FUNC void stgset(int onoff);
695 SC_FUNC int phopt_init(void);
696 SC_FUNC int phopt_cleanup(void);
698 /* function prototypes in SCLIST.C */
699 SC_FUNC char* duplicatestring(const char* sourcestring);
700 SC_FUNC stringpair *insert_alias(char *name,char *alias);
701 SC_FUNC stringpair *find_alias(char *name);
702 SC_FUNC int lookup_alias(char *target,char *name);
703 SC_FUNC void delete_aliastable(void);
704 SC_FUNC stringlist *insert_path(char *path);
705 SC_FUNC char *get_path(int index);
706 SC_FUNC void delete_pathtable(void);
707 SC_FUNC stringpair *insert_subst(char *pattern,char *substitution,int prefixlen);
708 SC_FUNC int get_subst(int index,char **pattern,char **substitution);
709 SC_FUNC stringpair *find_subst(char *name,int length);
710 SC_FUNC int delete_subst(char *name,int length);
711 SC_FUNC void delete_substtable(void);
712 SC_FUNC stringlist *insert_sourcefile(char *string);
713 SC_FUNC char *get_sourcefile(int index);
714 SC_FUNC void delete_sourcefiletable(void);
715 SC_FUNC stringlist *insert_docstring(char *string);
716 SC_FUNC char *get_docstring(int index);
717 SC_FUNC void delete_docstring(int index);
718 SC_FUNC void delete_docstringtable(void);
719 SC_FUNC stringlist *insert_autolist(char *string);
720 SC_FUNC char *get_autolist(int index);
721 SC_FUNC void delete_autolisttable(void);
722 SC_FUNC stringlist *insert_dbgfile(const char *filename);
723 SC_FUNC stringlist *insert_dbgline(int linenr);
724 SC_FUNC stringlist *insert_dbgsymbol(symbol *sym);
725 SC_FUNC char *get_dbgstring(int index);
726 SC_FUNC void delete_dbgstringtable(void);
728 /* function prototypes in SCMEMFILE.C */
729 #if !defined tMEMFILE
730 typedef unsigned char MEMFILE;
733 MEMFILE *mfcreate(const char *filename);
734 void mfclose(MEMFILE *mf);
735 int mfdump(MEMFILE *mf);
736 long mflength(const MEMFILE *mf);
737 long mfseek(MEMFILE *mf,long offset,int whence);
738 unsigned int mfwrite(MEMFILE *mf,const unsigned char *buffer,unsigned int size);
739 unsigned int mfread(MEMFILE *mf,unsigned char *buffer,unsigned int size);
740 char *mfgets(MEMFILE *mf,char *string,unsigned int size);
741 int mfputs(MEMFILE *mf,const char *string);
743 /* function prototypes in SCI18N.C */
744 #define MAXCODEPAGE 12
745 SC_FUNC int cp_path(const char *root,const char *directory);
746 SC_FUNC int cp_set(const char *name);
747 SC_FUNC cell cp_translate(const unsigned char *string,const unsigned char **endptr);
748 SC_FUNC cell get_utf8_char(const unsigned char *string,const unsigned char **endptr);
749 SC_FUNC int scan_utf8(FILE *fp,const char *filename);
751 /* function prototypes in SCSTATE.C */
752 SC_FUNC constvalue *automaton_add(const char *name);
753 SC_FUNC constvalue *automaton_find(const char *name);
754 SC_FUNC constvalue *automaton_findid(int id);
755 SC_FUNC constvalue *state_add(const char *name,int fsa_id);
756 SC_FUNC constvalue *state_find(const char *name,int fsa_id);
757 SC_FUNC constvalue *state_findid(int id);
758 SC_FUNC void state_buildlist(int **list,int *listsize,int *count,int stateid);
759 SC_FUNC int state_addlist(int *list,int count,int fsa_id);
760 SC_FUNC void state_deletetable(void);
761 SC_FUNC int state_getfsa(int listid);
762 SC_FUNC int state_count(int listid);
763 SC_FUNC int state_inlist(int listid,int state);
764 SC_FUNC int state_listitem(int listid,int index);
765 SC_FUNC void state_conflict(symbol *root);
766 SC_FUNC int state_conflict_id(int listid1,int listid2);
768 /* external variables (defined in scvars.c) */
769 #if !defined SC_SKIP_VDECL
770 SC_VDECL symbol loctab; /* local symbol table */
771 SC_VDECL symbol glbtab; /* global symbol table */
772 SC_VDECL cell *litq; /* the literal queue */
773 SC_VDECL unsigned char pline[]; /* the line read from the input file */
774 SC_VDECL const unsigned char *lptr;/* points to the current position in "pline" */
775 SC_VDECL constvalue tagname_tab;/* tagname table */
776 SC_VDECL constvalue libname_tab;/* library table (#pragma library "..." syntax) */
777 SC_VDECL constvalue *curlibrary;/* current library */
778 SC_VDECL int pc_addlibtable; /* is the library table added to the AMX file? */
779 SC_VDECL symbol *curfunc; /* pointer to current function */
780 SC_VDECL char *inpfname; /* name of the file currently read from */
781 SC_VDECL char outfname[]; /* intermediate (assembler) file name */
782 SC_VDECL char binfname[]; /* binary file name */
783 SC_VDECL char errfname[]; /* error file name */
784 SC_VDECL char sc_ctrlchar; /* the control character (or escape character) */
785 SC_VDECL char sc_ctrlchar_org;/* the default control character */
786 SC_VDECL int litidx; /* index to literal table */
787 SC_VDECL int litmax; /* current size of the literal table */
788 SC_VDECL int stgidx; /* index to the staging buffer */
789 SC_VDECL int sc_labnum; /* number of (internal) labels */
790 SC_VDECL int staging; /* true if staging output */
791 SC_VDECL cell declared; /* number of local cells declared */
792 SC_VDECL cell glb_declared; /* number of global cells declared */
793 SC_VDECL cell code_idx; /* number of bytes with generated code */
794 SC_VDECL int ntv_funcid; /* incremental number of native function */
795 SC_VDECL int errnum; /* number of errors */
796 SC_VDECL int warnnum; /* number of warnings */
797 SC_VDECL int sc_debug; /* debug/optimization options (bit field) */
798 SC_VDECL int sc_packstr; /* strings are packed by default? */
799 SC_VDECL int sc_asmfile; /* create .ASM file? */
800 SC_VDECL int sc_listing; /* create .LST file? */
801 SC_VDECL int sc_compress; /* compress bytecode? */
802 SC_VDECL int sc_needsemicolon;/* semicolon required to terminate expressions? */
803 SC_VDECL int sc_dataalign; /* data alignment value */
804 SC_VDECL int sc_alignnext; /* must frame of the next function be aligned? */
805 SC_VDECL int pc_docexpr; /* must expression be attached to documentation comment? */
806 SC_VDECL int curseg; /* 1 if currently parsing CODE, 2 if parsing DATA */
807 SC_VDECL cell pc_stksize; /* stack size */
808 SC_VDECL cell pc_amxlimit; /* abstract machine size limit (code + data, or only code) */
809 SC_VDECL cell pc_amxram; /* abstract machine data size limit */
810 SC_VDECL int freading; /* is there an input file ready for reading? */
811 SC_VDECL int fline; /* the line number in the current file */
812 SC_VDECL short fnumber; /* number of files in the file table (debugging) */
813 SC_VDECL short fcurrent; /* current file being processed (debugging) */
814 SC_VDECL short sc_intest; /* true if inside a test */
815 SC_VDECL int sideeffect; /* true if an expression causes a side-effect */
816 SC_VDECL int stmtindent; /* current indent of the statement */
817 SC_VDECL int indent_nowarn; /* skip warning "217 loose indentation" */
818 SC_VDECL int sc_tabsize; /* number of spaces that a TAB represents */
819 SC_VDECL short sc_allowtags; /* allow/detect tagnames in lex() */
820 SC_VDECL int sc_status; /* read/write status */
821 SC_VDECL int sc_rationaltag; /* tag for rational numbers */
822 SC_VDECL int rational_digits; /* number of fractional digits */
823 SC_VDECL int sc_allowproccall;/* allow/detect tagnames in lex() */
824 SC_VDECL short sc_is_utf8; /* is this source file in UTF-8 encoding */
825 SC_VDECL char *pc_deprecate; /* if non-NULL, mark next declaration as deprecated */
826 SC_VDECL int sc_curstates; /* ID of the current state list */
827 SC_VDECL int pc_optimize; /* (peephole) optimization level */
828 SC_VDECL int pc_memflags; /* special flags for the stack/heap usage */
829 SC_VDECL int pc_functag; /* global function tag */
830 SC_VDECL int pc_tag_string; /* global string tag */
831 SC_VDECL int pc_anytag; /* global any tag */
832 SC_VDECL int glbstringread; /* last global string read */
834 SC_VDECL constvalue sc_automaton_tab; /* automaton table */
835 SC_VDECL constvalue sc_state_tab; /* state table */
837 SC_VDECL FILE *inpf; /* file read from (source or include) */
838 SC_VDECL FILE *inpf_org; /* main source file */
839 SC_VDECL FILE *outf; /* file written to */
841 SC_VDECL jmp_buf errbuf; /* target of longjmp() on a fatal error */
843 #if !defined SC_LIGHT
844 SC_VDECL int sc_makereport; /* generate a cross-reference report */
848 #if !defined snprintf
849 #define snprintf _snprintf
853 #endif /* SC_SKIP_VDECL */
855 typedef struct array_info_s
857 const int *dim_list; /* Dimension sizes */
858 int dim_count; /* Number of dimensions */
859 const int *lastdim_list; /* Sizes of last dimensions, if variable */
860 const cell *dim_offs_precalc; /* Cached calculations into the lastdim_list array */
861 cell *data_offs; /* Current offset AFTER the indirection vectors (data) */
862 int *cur_dims; /* Current dimensions the recursion is at */
863 cell *base; /* &litq[startlit] */
866 #endif /* SC_H_INCLUDED */
