1 /*****************************************************************************/
5 /* 6502 code generator */
9 /* (C) 1998-2001 llrich von Bassewitz */
11 /* D-70597 Stuttgart */
12 /* EMail: uz@cc65.org */
15 /* This software is provided 'as-is', without any expressed or implied */
16 /* warranty. In no event will the authors be held liable for any damages */
17 /* arising from the use of this software. */
19 /* Permission is granted to anyone to use this software for any purpose, */
20 /* including commercial applications, and to alter it and redistribute it */
21 /* freely, subject to the following restrictions: */
23 /* 1. The origin of this software must not be misrepresented; you must not */
24 /* claim that you wrote the original software. If you use this software */
25 /* in a product, an acknowledgment in the product documentation would be */
26 /* appreciated but is not required. */
27 /* 2. Altered source versions must be plainly marked as such, and must not */
28 /* be misrepresented as being the original software. */
29 /* 3. This notice may not be removed or altered from any source */
32 /*****************************************************************************/
46 /*****************************************************************************/
48 /*****************************************************************************/
52 /* Code generator flags.
53 * Note: The type flags are designed so that a smaller type may override a
54 * larger one by or'ing it into the existing one.
56 #define CF_NONE 0x0000 /* No special flags */
58 #define CF_TYPE 0x0007 /* Mask for operand type */
59 #define CF_CHAR 0x0003 /* Operation on characters */
60 #define CF_INT 0x0001 /* Operation on ints */
61 #define CF_PTR CF_INT /* Alias for readability */
62 #define CF_LONG 0x0000 /* Operation on longs */
64 #define CF_NOKEEP 0x0008 /* Value may get destroyed when storing */
66 #define CF_UNSIGNED 0x0010 /* Value is unsigned */
67 #define CF_CONST 0x0020 /* Constant value available */
68 #define CF_CONSTADDR 0x0040 /* Constant address value available */
69 #define CF_TEST 0x0080 /* Test value */
70 #define CF_FIXARGC 0x0100 /* Function has fixed arg count */
71 #define CF_FORCECHAR 0x0200 /* Handle chars as chars, not ints */
72 #define CF_REG 0x0800 /* Value is in primary register */
74 /* Type of static address */
75 #define CF_ADDRMASK 0xF000 /* Type of address */
76 #define CF_STATIC 0x0000 /* Static local */
77 #define CF_EXTERNAL 0x1000 /* Static external */
78 #define CF_ABSOLUTE 0x2000 /* Numeric absolute address */
79 #define CF_LOCAL 0x4000 /* Auto variable */
80 #define CF_REGVAR 0x8000 /* Register variable */
84 /* Compiler relative stackpointer */
89 /*****************************************************************************/
90 /* Pre- and postamble */
91 /*****************************************************************************/
95 void g_preamble (void);
96 /* Generate the assembler code preamble */
100 /*****************************************************************************/
101 /* Segment support */
102 /*****************************************************************************/
106 void g_userodata (void);
107 /* Switch to the read only data segment */
109 void g_usedata (void);
110 /* Switch to the data segment */
112 void g_usebss (void);
113 /* Switch to the bss segment */
117 /*****************************************************************************/
118 /* Functions handling local labels */
119 /*****************************************************************************/
123 void g_defcodelabel (unsigned label);
124 /* Define a local code label */
126 void g_defdatalabel (unsigned label);
127 /* Define a local data label */
131 /*****************************************************************************/
132 /* Functions handling global labels */
133 /*****************************************************************************/
137 void g_defgloblabel (const char* Name);
138 /* Define a global label with the given name */
140 void g_defexport (const char* Name, int ZP);
141 /* Export the given label */
143 void g_defimport (const char* Name, int ZP);
144 /* Import the given label */
148 /*****************************************************************************/
150 /*****************************************************************************/
154 int pop (unsigned flags);
155 /* Pop an argument of the given size */
157 int push (unsigned flags);
158 /* Push an argument of the given size */
160 unsigned sizeofarg (unsigned flags);
161 /* Return the size of a function argument type that is encoded in flags */
165 /*****************************************************************************/
166 /* type conversion and similiar stuff */
167 /*****************************************************************************/
171 void g_toslong (unsigned flags);
172 /* Make sure, the value on TOS is a long. Convert if necessary */
174 void g_tosint (unsigned flags);
175 /* Make sure, the value on TOS is an int. Convert if necessary */
177 void g_reglong (unsigned flags);
178 /* Make sure, the value in the primary register a long. Convert if necessary */
180 unsigned g_typeadjust (unsigned lhs, unsigned rhs);
181 /* Adjust the integer operands before doing a binary operation. lhs is a flags
182 * value, that corresponds to the value on TOS, rhs corresponds to the value
183 * in (e)ax. The return value is the the flags value for the resulting type.
186 unsigned g_typecast (unsigned lhs, unsigned rhs);
187 /* Cast the value in the primary register to the operand size that is flagged
188 * by the lhs value. Return the result value.
191 void g_scale (unsigned flags, long val);
192 /* Scale the value in the primary register by the given value. If val is positive,
193 * scale up, is val is negative, scale down. This function is used to scale
194 * the operands or results of pointer arithmetic by the size of the type, the
200 /*****************************************************************************/
201 /* Function entry and exit */
202 /*****************************************************************************/
206 void g_enter (unsigned flags, unsigned argsize);
207 /* Function prologue */
209 void g_leave (int flags, int val);
210 /* Function epilogue */
214 /*****************************************************************************/
215 /* Register variables */
216 /*****************************************************************************/
220 void g_save_regvars (int RegOffs, unsigned Bytes);
221 /* Save register variables */
223 void g_restore_regvars (int StackOffs, int RegOffs, unsigned Bytes);
224 /* Restore register variables */
228 /*****************************************************************************/
229 /* Fetching memory cells */
230 /*****************************************************************************/
234 void g_getimmed (unsigned Flags, unsigned long Val, unsigned Offs);
235 /* Load a constant into the primary register */
237 void g_getstatic (unsigned Flags, unsigned long Label, unsigned Offs);
238 /* Fetch an static memory cell into the primary register */
240 void g_getlocal (unsigned Flags, int Offs);
241 /* Fetch specified local object (local var). */
243 void g_getind (unsigned Flags, unsigned Offs);
244 /* Fetch the specified object type indirect through the primary register
245 * into the primary register
248 void g_leasp (int Offs);
249 /* Fetch the address of the specified symbol into the primary register */
251 void g_leavariadic (int Offs);
252 /* Fetch the address of a parameter in a variadic function into the primary
258 /*****************************************************************************/
259 /* Store into memory */
260 /*****************************************************************************/
264 void g_putstatic (unsigned flags, unsigned long label, unsigned offs);
265 /* Store the primary register into the specified static memory cell */
267 void g_putlocal (unsigned Flags, int Offs, long Val);
268 /* Put data into local object. */
270 void g_putind (unsigned flags, unsigned offs);
271 /* Store the specified object type in the primary register at the address
272 * on the top of the stack
277 /*****************************************************************************/
278 /* Adds and subs of variables fix a fixed address */
279 /*****************************************************************************/
283 void g_addlocal (unsigned flags, int offs);
284 /* Add a local variable to ax */
286 void g_addstatic (unsigned flags, unsigned long label, unsigned offs);
287 /* Add a static variable to ax */
291 /*****************************************************************************/
292 /* Compares of ax with a variable with fixed address */
293 /*****************************************************************************/
297 void g_cmplocal (unsigned flags, int offs);
298 /* Compare a local variable to ax */
300 void g_cmpstatic (unsigned flags, unsigned label, unsigned offs);
301 /* Compare a static variable to ax */
305 /*****************************************************************************/
306 /* Special op= functions */
307 /*****************************************************************************/
311 void g_addeqstatic (unsigned flags, unsigned long label, unsigned offs,
313 /* Emit += for a static variable */
315 void g_addeqlocal (unsigned flags, int offs, unsigned long val);
316 /* Emit += for a local variable */
318 void g_addeqind (unsigned flags, unsigned offs, unsigned long val);
319 /* Emit += for the location with address in ax */
321 void g_subeqstatic (unsigned flags, unsigned long label, unsigned offs,
323 /* Emit -= for a static variable */
325 void g_subeqlocal (unsigned flags, int offs, unsigned long val);
326 /* Emit -= for a local variable */
328 void g_subeqind (unsigned flags, unsigned offs, unsigned long val);
329 /* Emit -= for the location with address in ax */
333 /*****************************************************************************/
334 /* Add a variable address to the value in ax */
335 /*****************************************************************************/
339 void g_addaddr_local (unsigned flags, int offs);
340 /* Add the address of a local variable to ax */
342 void g_addaddr_static (unsigned flags, unsigned long label, unsigned offs);
343 /* Add the address of a static variable to ax */
347 /*****************************************************************************/
349 /*****************************************************************************/
353 void g_save (unsigned flags);
354 /* Copy primary register to hold register. */
356 void g_restore (unsigned flags);
357 /* Copy hold register to primary. */
359 void g_cmp (unsigned flags, unsigned long val);
360 /* Immidiate compare. The primary register will not be changed, Z flag
364 void g_test (unsigned flags);
365 /* Test the value in the primary and set the condition codes */
367 void g_push (unsigned flags, unsigned long val);
368 /* Push the primary register or a constant value onto the stack */
370 void g_swap (unsigned flags);
371 /* Swap the primary register and the top of the stack. flags give the type
372 * of *both* values (must have same size).
375 void g_call (unsigned Flags, const char* Label, unsigned ArgSize);
376 /* Call the specified subroutine name */
378 void g_callind (unsigned Flags, unsigned ArgSize);
379 /* Call subroutine with address in AX */
381 void g_jump (unsigned Label);
382 /* Jump to specified internal label number */
384 void g_switch (unsigned Flags);
385 /* Output switch statement preamble */
387 void g_case (unsigned flags, unsigned label, unsigned long val);
388 /* Create table code for one case selector */
390 void g_truejump (unsigned flags, unsigned label);
391 /* Jump to label if zero flag clear */
393 void g_falsejump (unsigned flags, unsigned label);
394 /* Jump to label if zero flag set */
396 void g_space (int space);
397 /* Create or drop space on the stack */
399 void g_cstackcheck (void);
400 /* Check for a C stack overflow */
402 void g_stackcheck (void);
403 /* Check for a stack overflow */
405 void g_add (unsigned flags, unsigned long val);
406 void g_sub (unsigned flags, unsigned long val);
407 void g_rsub (unsigned flags, unsigned long val);
408 void g_mul (unsigned flags, unsigned long val);
409 void g_div (unsigned flags, unsigned long val);
410 void g_mod (unsigned flags, unsigned long val);
411 void g_or (unsigned flags, unsigned long val);
412 void g_xor (unsigned flags, unsigned long val);
413 void g_and (unsigned flags, unsigned long val);
414 void g_asr (unsigned flags, unsigned long val);
415 void g_asl (unsigned flags, unsigned long val);
416 void g_neg (unsigned flags);
417 void g_bneg (unsigned flags);
418 void g_com (unsigned flags);
419 void g_inc (unsigned flags, unsigned long n);
420 void g_dec (unsigned flags, unsigned long n);
421 void g_eq (unsigned flags, unsigned long val);
422 void g_ne (unsigned flags, unsigned long val);
423 void g_lt (unsigned flags, unsigned long val);
424 void g_le (unsigned flags, unsigned long val);
425 void g_gt (unsigned flags, unsigned long val);
426 void g_ge (unsigned flags, unsigned long val);
428 void g_res (unsigned n);
429 /* Reserve static storage, n bytes */
431 void g_defdata (unsigned flags, unsigned long val, unsigned offs);
432 /* Define data with the size given in flags */
434 void g_defbytes (const void* bytes, unsigned count);
435 /* Output a row of bytes as a constant */
437 void g_zerobytes (unsigned n);
438 /* Output n bytes of data initialized with zero */
442 /*****************************************************************************/
443 /* User supplied assembler code */
444 /*****************************************************************************/
448 void g_asmcode (const char* Line, int Len);
449 /* Output one line of assembler code. If Len is greater than zero, it is used
450 * as the maximum number of characters to use from Line.
455 /*****************************************************************************/
456 /* Inlined known functions */
457 /*****************************************************************************/
461 void g_strlen (unsigned flags, unsigned long val, unsigned offs);
462 /* Inline the strlen() function */
466 /* End of codegen.h */