Much better implementation for A8 strings - introduced a new token called STRINGA8...
[rmac] / rmac.h
1 //
2 // RMAC - Reboot's Macro Assembler for the Atari Jaguar Console System
3 // RMAC.H - Main Application Code
4 // Copyright (C) 199x Landon Dyer, 2017 Reboot & 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 __RMAC_H__
10 #define __RMAC_H__
11
12 #include <stdio.h>
13 #include <stdlib.h>
14 #include <string.h>
15 #include <ctype.h>
16 #include <sys/types.h>
17 #include <sys/stat.h>
18
19 //
20 // TARGET SPECIFIC BUILD SETTINGS
21 //
22 #if defined(WIN32) || defined (WIN64)
23         #include <io.h>
24         #include <fcntl.h>
25         // Release platform - windows
26         #define PLATFORM        "Win32"
27         #define _OPEN_FLAGS     _O_TRUNC|_O_CREAT|_O_BINARY|_O_RDWR
28         #define _OPEN_INC       _O_RDONLY|_O_BINARY
29         #define _PERM_MODE      _S_IREAD|_S_IWRITE
30         #ifdef _MSC_VER
31                 #if _MSC_VER > 1000
32                         #pragma warning(disable:4996)
33                 #endif
34
35         // Makes warnings double clickable on visual studio (ggn)
36         #define STRINGIZE_HELPER(x) #x
37         #define STRINGIZE(x) STRINGIZE_HELPER(x)
38         #define WARNING(desc) __pragma(message(__FILE__ "(" STRINGIZE(__LINE__) ") : Warning: " #desc))
39         #define inline __inline
40
41         // usage:
42         // WARNING(FIXME: Code removed because...)
43
44         #else
45         // If we're not compiling for Visual Studio let's assume that we're using
46         // some flavour of gcc instead. So let's use the gcc compliant macro
47         // instead. If some weirdo uses something else (I dunno, Intel compiler or
48         // something?) this is probably going to explode spectacularly. Let's wait
49         // for the fireworks!
50         #define DO_PRAGMA(x) _Pragma (#x)
51         #define WARNING(desc) DO_PRAGMA(message (#desc))
52
53         #endif
54
55 #else
56
57         #ifdef __GCCUNIX__
58
59         #include <sys/fcntl.h>
60         #include <unistd.h>
61         // Release platform - mac OS-X or Linux
62         #define PLATFORM        "OSX/Linux"
63         #define _OPEN_FLAGS     O_TRUNC|O_CREAT|O_RDWR
64         #define _OPEN_INC       O_RDONLY
65         #define _PERM_MODE      S_IRUSR|S_IWUSR
66
67         #ifdef __MINGW32__
68         #define off64_t long
69         #define off_t long
70         #undef _OPEN_FLAGS
71         #undef _OPEN_INC
72         #define _OPEN_FLAGS     _O_TRUNC|_O_CREAT|_O_BINARY|_O_RDWR
73         #define _OPEN_INC       O_RDONLY|_O_BINARY
74         #endif
75
76         // WARNING WARNING WARNING
77         #define DO_PRAGMA(x) _Pragma (#x)
78         #define WARNING(desc) DO_PRAGMA(message (#desc))
79 #else
80         // Release platform - not specified
81         #include <sys/fcntl.h>
82         #define PLATFORM        "Unknown"
83         #define _OPEN_FLAGS     O_TRUNC|O_CREAT|O_RDWR
84         #define _OPEN_INC       O_RDONLY
85         #define _PERM_MODE      S_IREAD|S_IWRITE
86         // Defined here, even though the platform may not support it...
87         #define DO_PRAGMA(x) _Pragma (#x)
88         #define WARNING(desc) DO_PRAGMA(message (#desc))
89         #endif
90 #endif
91
92 //
93 // Endian related, for safe handling of endian-sensitive data
94 // USAGE: GETBExx() is *always* an rvalue, a = pointer to a uint8_t,
95 //        r = offset from 0. SETBExx(), v = value to write into 'a'
96 //
97 #define GETBE16(a, r) \
98         (((uint16_t)(a)[(r + 0)] << 8) | ((uint16_t)(a)[(r + 1)]))
99
100 #define GETBE32(a, r) \
101         (((uint32_t)(a)[(r + 0)] << 24) | ((uint32_t)(a)[(r + 1)] << 16) \
102         | ((uint32_t)(a)[(r + 2)] << 8) | ((uint32_t)(a)[(r + 3)]))
103
104 #define GETBE64(a, r) \
105         (((uint64_t)(a)[(r + 0)] << 56) | ((uint64_t)(a)[(r + 1)] << 48) \
106         | ((uint64_t)(a)[(r + 2)] << 40) | ((uint64_t)(a)[(r + 3)] << 32) \
107         | ((uint64_t)(a)[(r + 4)] << 24) | ((uint64_t)(a)[(r + 5)] << 16) \
108         | ((uint64_t)(a)[(r + 6)] << 8) | ((uint64_t)(a)[(r + 7)]))
109
110 #define SETBE16(a, r, v) \
111         { (a)[(r + 0)] = (uint8_t)((v) >> 8); \
112         (a)[(r + 1)] = (uint8_t)((v) & 0xFF); }
113
114 #define SETBE32(a, r, v) \
115         { (a)[(r + 0)] = (uint8_t)((v) >> 24); \
116         (a)[(r + 1)] = (uint8_t)(((v) >> 16) & 0xFF); \
117         (a)[(r + 2)] = (uint8_t)(((v) >> 8) & 0xFF); \
118         (a)[(r + 3)] = (uint8_t)((v) & 0xFF); }
119
120 #define SETBE64(a, r, v) \
121         { (a)[(r + 0)] = (uint8_t)((v) >> 56); \
122         (a)[(r + 1)] = (uint8_t)(((v) >> 48) & 0xFF); \
123         (a)[(r + 2)] = (uint8_t)(((v) >> 40) & 0xFF); \
124         (a)[(r + 3)] = (uint8_t)(((v) >> 32) & 0xFF); \
125         (a)[(r + 4)] = (uint8_t)(((v) >> 24) & 0xFF); \
126         (a)[(r + 5)] = (uint8_t)(((v) >> 16) & 0xFF); \
127         (a)[(r + 6)] = (uint8_t)(((v) >> 8) & 0xFF); \
128         (a)[(r + 7)] = (uint8_t)((v) & 0xFF); }
129
130 // In 6502 mode, turns out we need this:
131 #define SETLE16(a, r, v) \
132         { (a)[(r + 0)] = (uint8_t)((v) & 0xFF); \
133         (a)[(r + 1)] = (uint8_t)((v) >> 8); }
134
135 // Byteswap crap
136 #define BYTESWAP16(x) ((((x) & 0x00FF) << 8) | (((x) & 0xFF00) >> 8))
137 #define BYTESWAP32(x) ((((x) & 0x000000FF) << 24) | (((x) & 0x0000FF00) << 8) | (((x) & 0x00FF0000) >> 8) | (((x) & 0xFF000000) >> 24))
138 #define WORDSWAP32(x) ((((x) & 0x0000FFFF) << 16) | (((x) & 0xFFFF0000) >> 16))
139
140 //
141 // Non-target specific stuff
142 //
143 #include <inttypes.h>
144 #include "symbol.h"
145
146 #define BYTE         uint8_t
147 #define WORD         uint16_t
148 #define LONG         uint32_t
149 #define VOID         void
150
151 #define ERROR        (-1)                       // Generic error return
152 #define EOS          '\0'                       // End of string
153 #define SPACE        ' '                        // ASCII space
154 #define SLASHCHAR    '/'
155 #define SLASHSTRING  "/"
156 #define VALUE        LONG                       // Assembler value
157 #define TOKEN        LONG                       // Assembler token
158 #define FNSIZ        128                        // Maximum size of a filename
159 #define OK           0                          // OK return
160 #define DEBUG        if (debug)         // Debug conditional
161 #define MAXARGV      100                        // Maximum number of commandline args
162 #define STDOUT       1                          // Standard output
163 #define ERROUT       2                          // Error output
164 #define CREATMASK    0
165
166 // (Normally) non-printable tokens
167 #define COLON        ':'                        // : (grumble: GNUmacs hates ':')
168 #define CONST        'a'                        // CONST <value>
169 #define ACONST       'A'                        // ACONST <value> <attrib>
170 #define STRING       'b'                        // STRING <address>
171 #define STRINGA8     'S'            // Atari 800 internal STRING <address>
172 #define SYMBOL       'c'                        // SYMBOL <address>
173 #define EOL          'e'                        // End of line
174 #define TKEOF        'f'                        // End of file (or macro)
175 #define DEQUALS      'g'                        // ==
176 #define SET          149                        // set
177 #define REG          'R'                        // reg
178 #define EQUREG       148                        // equreg
179 #define CCDEF        183                        // ccdef
180 #define DCOLON       'h'                        // ::
181 #define GE           'i'                        // >=
182 #define LE           'j'                        // <=
183 #define NE           'k'                        // <> or !=
184 #define SHR          'l'                        // >>
185 #define SHL          'm'                        // <<
186 #define UNMINUS      'n'                        // Unary '-'
187 #define DOTB         'B'                        // .b or .B or .s or .S
188 #define DOTW         'W'                        // .w or .W
189 #define DOTL         'L'                        // .l or .L
190 #define DOTI         'I'                        // .i or .I
191 #define ENDEXPR      'E'                        // End of expression
192
193 // Object code formats
194 #define ALCYON       0                          // Alcyon/DRI C object format
195 #define MWC          1                          // Mark Williams object format
196 #define BSD          2                          // BSD object format
197 #define ELF          3                          // ELF object format
198 #define XEX          4                          // COM/EXE/XEX/whatever a8 object format
199
200 // Pointer type that can point to (almost) anything
201 #define PTR union _ptr
202 PTR
203 {
204    uint8_t * cp;                                        // Char
205    uint16_t * wp;                                       // WORD
206    uint32_t * lp;                                       // LONG
207    uint32_t lw;                                         // LONG
208    SYM ** sy;                                           // SYM
209    TOKEN * tk;                                          // TOKEN
210 };
211
212 // Symbol spaces
213 #define LABEL        0                          // User-defined symbol
214 #define MACRO        1                          // Macro definition
215 #define MACARG       2                          // Macro argument
216 #define SY_UNDEF     -1                         // Undefined (lookup never matches it)
217
218 // Symbol and expression attributes
219 #define DEFINED      0x8000                     // Symbol has been defined
220 #define GLOBAL       0x4000                     // Symbol has been .GLOBL'd
221 #define COMMON       0x2000                     // Symbol has been .COMM'd
222 #define REFERENCED   0x1000                     // Symbol has been referenced
223 #define EQUATED      0x0800                     // Symbol was equated
224 #define SDECLLIST    0x0400                     // Symbol is on 'sdecl'-order list
225
226 // Expression spaces, ORed with symbol and expression attributes above
227 #define ABS          0x0000                     // In absolute space
228 #define TEXT         0x0001                     // Relative to text
229 #define DATA         0x0002                     // Relative to data
230 #define BSS          0x0004                     // Relative to BSS
231 #define M6502        0x0008                     // 6502/microprocessor (absolute)
232 #define TDB          (TEXT|DATA|BSS)    // Mask for text+data+bss
233
234 // Sizes
235 #define SIZB         0x0001                     // .b
236 #define SIZW         0x0002                     // .w
237 #define SIZL         0x0004                     // .l
238 #define SIZN         0x0008                     // no .(size) specifier
239
240 // RISC register bank definitions (used in extended symbol attributes also)
241 #define BANK_N       0x0000                     // No register bank specified
242 #define BANK_0       0x0001                     // Register bank zero specified
243 #define BANK_1       0x0002                     // Register bank one specified
244 #define EQUATEDREG   0x0008                     // Equated register symbol
245 #define UNDEF_EQUR   0x0010
246 #define EQUATEDCC    0x0020
247 #define UNDEF_CC     0x0040
248
249 // Optimisation defines
250 enum
251 {
252         OPT_ABS_SHORT     = 0,
253         OPT_MOVEL_MOVEQ   = 1,
254         OPT_BSR_BCC_S     = 2,
255         OPT_INDIRECT_DISP = 3,
256         OPT_COUNT   // Dummy, used to count number of optimisation switches
257 };
258
259 // Exported variables
260 extern int verb_flag;
261 extern int debug;
262 extern int rgpu, rdsp;
263 extern int err_flag;
264 extern int err_fd;
265 extern int regbank;
266 extern char * firstfname;
267 extern int list_fd;
268 extern int as68_flag;
269 extern int m6502;
270 extern int list_flag;
271 extern int glob_flag;
272 extern int lsym_flag;
273 extern int sbra_flag;
274 extern int obj_format;
275 extern int legacy_flag;
276 extern int prg_flag;    // 1 = write ".PRG" relocatable executable
277 extern LONG PRGFLAGS;
278 extern int optim_flags[OPT_COUNT];
279
280 // Exported functions
281 char * fext(char *, char *, int);
282 int nthpath(char *, int, char *);
283 int ParseOptimization(char * optstring);
284
285 #endif // __RMAC_H__
286