Version bump for last commit; now at v2.0.23.
[rmac] / token.h
1 //
2 // RMAC - Reboot's Macro Assembler for all Atari computers
3 // TOKEN.H - Token Handling
4 // Copyright (C) 199x Landon Dyer, 2011-2020 Reboot and Friends
5 // RMAC derived from MADMAC v1.07 Written by Landon Dyer, 1986
6 // Source utilised with the kind permission of Landon Dyer
7 //
8
9 #ifndef __TOKEN_H__
10 #define __TOKEN_H__
11
12 #include "rmac.h"
13
14 // Include Files and Macros
15 #define SRC_IFILE       0                       // Input source is IFILE
16 #define SRC_IMACRO      1                       // Input source is IMACRO
17 #define SRC_IREPT       2                       // Input source is IREPT
18
19 // Macros
20 #define INOBJ           struct _inobj
21 #define IUNION          union _iunion
22 #define IFILE           struct _incldfile
23 #define IMACRO          struct _imacro
24 #define IREPT           struct _irept
25 #define IFENT           struct _ifent
26
27 // Tunable definitions
28 #define LNSIZ           1024            // Maximum size of a line of text
29 #define TOKBUFSIZE      400                     // Size of token-line buffer
30 #define QUANTUM         4096L           // # bytes to eat at a time from a file
31 #define LNBUFSIZ        (QUANTUM*2)     // Size of file's buffer
32 #define KWSIZE          7                       // Maximum size of keyword in kwtab.h
33
34 // (Normally) non-printable tokens
35 #define COLON           ':'                     // : (grumble: GNUmacs hates ':')
36 #define CONST           'a'                     // CONST <value>
37 #define FCONST          'r'                     // Floating CONST <value>
38 #define ACONST          'A'                     // ACONST <value> <attrib>
39 #define STRING          'b'                     // STRING <address>
40 #define STRINGA8        'S'                     // Atari 800 internal STRING <address>
41 #define SYMBOL          'c'                     // SYMBOL <address>
42 #define EOL             'e'                     // End of line
43 #define TKEOF           'f'                     // End of file (or macro)
44 #define DEQUALS         'g'                     // ==
45 #define SET             0x95            // Set
46 #define REG             'R'                     // Reg
47 #define EQUREG          0x94            // equreg
48 #define CCDEF           0xB7            // ccdef
49 #define DCOLON          'h'                     // ::
50 #define GE              'i'                     // >=
51 #define LE              'j'                     // <=
52 #define NE              'k'                     // <> or !=
53 #define SHR             'l'                     // >>
54 #define SHL             'm'                     // <<
55 #define UNMINUS         'n'                     // Unary '-'
56 #define DOTB            'B'                     // .b or .B or .s or .S
57 #define DOTW            'W'                     // .w or .W
58 #define DOTL            'L'                     // .l or .L
59 #define DOTI            'I'                     // .l or .L
60 #define DOTX            'X'                     // .x or .X
61 #define DOTD            'D'                     // .d or .D
62 #define DOTP            'P'                     // .p or .P
63 #define DOTQ            'Q'                     // .q or .Q (essentially an alias for P)
64 #define DOTS            'S'                     // .s or .S (FPU Single)
65 #define ENDEXPR         'E'                     // End of expression
66 #define UNLT            0x81            // Unary '<' (low byte)
67 #define UNGT            0x82            // Unary '>' (high byte)
68
69 // ^^ operators
70 #define CR_DEFINED      'p'                     // ^^defined - is symbol defined?
71 #define CR_REFERENCED   'q'                     // ^^referenced - was symbol referenced?
72 #define CR_STREQ        'v'                     // ^^streq - compare two strings
73 #define CR_MACDEF       'w'                     // ^^macdef - is macro defined?
74 #define CR_TIME         'x'                     // ^^time - DOS format time
75 #define CR_DATE         'y'                     // ^^date - DOS format date
76 #define CR_ABSCOUNT     'z'                     // ^^abscount - count the number of bytes
77                                                                         // defined in current .abs section
78 #define CR_FILESIZE     'F'                     // ^^filesize - return the size in bytes of a file
79
80 // Character Attributes
81 #define ILLEG           0                       // Illegal character (unused)
82 #define DIGIT           1                       // 0-9
83 #define HDIGIT          2                       // A-F, a-f
84 #define STSYM           4                       // A-Z, a-z, _~.
85 #define CTSYM           8                       // A-Z, a-z, 0-9, _~$?
86 #define SELF            16                      // Single-character tokens: ( ) [ ] etc
87 #define WHITE           32                      // Whitespace (space, tab, etc.)
88 #define MULTX           64                      // Multiple-character tokens
89 #define DOT             128                     // [bwlsBWSL] for what follows a '.'
90
91 // Macro to check for specific optimizations or override
92 #define CHECK_OPTS(x)   (optim_flags[x] && !optimizeOff)
93
94 // Conditional assembly structures
95 IFENT {
96         IFENT * if_prev;                // Ptr prev .if state block (or NULL)
97         WORD if_state;                  // 0:enabled, 1:disabled
98 };
99
100 // Pointer to IFILE or IMACRO or IREPT
101 IUNION {
102         IFILE * ifile;
103         IMACRO * imacro;
104         IREPT * irept;
105 };
106
107 // Ptr to IFILEs, IMACROs, and so on; back-ptr to previous input objects
108 INOBJ {
109         WORD in_type;                   // 0=IFILE, 1=IMACRO, 2=IREPT
110         IFENT * in_ifent;               // Pointer to .if context on entry
111         INOBJ * in_link;                // Pointer to previous INOBJ
112         TOKEN * in_otok;                // Old `tok' value
113         TOKEN * in_etok;                // Old `etok' value
114         IUNION inobj;                   // IFILE or IMACRO or IREPT
115 };
116
117 // Information about a file
118 IFILE {
119         IFILE * if_link;                // Pointer to ancient IFILEs
120         char * ifoldfname;              // Old file's name
121         int ifoldlineno;                // Old line number
122         int ifind;                              // Position in file buffer
123         int ifcnt;                              // #chars left in file buffer
124         int ifhandle;                   // File's descriptor
125         WORD ifno;                              // File number
126         char ifbuf[LNBUFSIZ];   // Line buffer
127 };
128
129 #define TOKENSTREAM struct _tokenstream
130 TOKENSTREAM {
131         TOKEN token[32];                // 32 ought to be enough for anybody (including XiA!)
132         char * string[32];              // same for attached strings
133 };
134
135 // Information about a macro invocation
136 IMACRO {
137         IMACRO * im_link;               // Pointer to ancient IMACROs
138         LLIST * im_nextln;              // Next line to include
139         WORD im_nargs;                  // # of arguments supplied on invocation
140         WORD im_siz;                    // Size suffix supplied on invocation
141         LONG im_olduniq;                // Old value of 'macuniq'
142         SYM * im_macro;                 // Pointer to macro we're in
143         char im_lnbuf[LNSIZ];   // Line buffer
144         TOKENSTREAM argument[20];       // Assume no more than 20 arguments in an invocation
145 };
146
147 // Information about a .rept invocation
148 IREPT {
149         LLIST * ir_firstln;             // Pointer to first line
150         LLIST * ir_nextln;              // Pointer to next line
151         uint32_t ir_count;              // Repeat count (decrements)
152         uint32_t lineno;                // Repeat line number (Convert this to global instead of putting it here?)
153 };
154
155 // Exported variables
156 extern int lnsave;
157 extern uint16_t curlineno;
158 extern char * curfname;
159 extern WORD cfileno;
160 extern TOKEN * tok;
161 extern char lnbuf[];
162 extern char lntag;
163 extern char tolowertab[];
164 extern INOBJ * cur_inobj;
165 extern int mjump_align;
166 extern char * string[];
167 extern int optimizeOff;
168
169 // Exported functions
170 int include(int, char *);
171 void InitTokenizer(void);
172 void SetFilenameForErrorReporting(void);
173 int TokenizeLine(void);
174 int fpop(void);
175 int d_goto(WORD);
176 INOBJ * a_inobj(int);
177 void DumpToken(TOKEN);
178 void DumpTokenBuffer(void);
179
180 #endif // __TOKEN_H__
181