git.sur5r.net Git - cc65/blob - src/cc65/codegen.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 codegen.h                                 */
   4 /*                                                                           */
   5 /*                            6502 code generator                            */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2001 llrich von Bassewitz                                        */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@musoftware.de                                            */
  13 /*                                                                           */
  14 /*                                                                           */
  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.                                    */
  18 /*                                                                           */
  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:                            */
  22 /*                                                                           */
  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              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef CODEGEN_H
  37 #define CODEGEN_H
  38
  39
  40
  41 /* ##### */
  42 #include "dataseg.h"
  43 #include "codeseg.h"
  44
  45
  46
  47 /*****************************************************************************/
  48 /*                                   data                                    */
  49 /*****************************************************************************/
  50
  51
  52
  53 /* Code generator flags.
  54  * Note: The type flags are designed so that a smaller type may override a
  55  * larger one by or'ing it into the existing one.
  56  */
  57 #define CF_NONE         0x0000  /* No special flags */
  58
  59 #define CF_TYPE         0x0007  /* Mask for operand type */
  60 #define CF_CHAR         0x0003  /* Operation on characters */
  61 #define CF_INT          0x0001  /* Operation on ints */
  62 #define CF_PTR          CF_INT  /* Alias for readability */
  63 #define CF_LONG         0x0000  /* Operation on longs */
  64
  65 #define CF_NOKEEP       0x0008  /* Value may get destroyed when storing */
  66
  67 #define CF_UNSIGNED     0x0010  /* Value is unsigned */
  68 #define CF_CONST        0x0020  /* Constant value available */
  69 #define CF_CONSTADDR    0x0040  /* Constant address value available */
  70 #define CF_TEST         0x0080  /* Test value */
  71 #define CF_FIXARGC      0x0100  /* Function has fixed arg count */
  72 #define CF_FORCECHAR    0x0200  /* Handle chars as chars, not ints */
  73 #define CF_SHORT        0x0400  /* Use short addressing */
  74 #define CF_REG          0x0800  /* Value is in primary register */
  75
  76 /* Type of static address */
  77 #define CF_ADDRMASK     0xF000  /* Type of address */
  78 #define CF_STATIC       0x0000  /* Static local */
  79 #define CF_EXTERNAL     0x1000  /* Static external */
  80 #define CF_ABSOLUTE     0x2000  /* Numeric absolute address */
  81 #define CF_LOCAL        0x4000  /* Auto variable */
  82 #define CF_REGVAR       0x8000  /* Register variable */
  83
  84
  85
  86 /* Compiler relative stackpointer */
  87 extern int oursp;
  88
  89 /* Segments */
  90 extern DataSeg* DS;
  91 extern CodeSeg* CS;
  92
  93
  94
  95 /*****************************************************************************/
  96 /*                            Pre- and postamble                             */
  97 /*****************************************************************************/
  98
  99
 100
 101 void g_preamble (void);
 102 /* Generate the assembler code preamble */
 103
 104
 105
 106 /*****************************************************************************/
 107 /*                              Segment support                              */
 108 /*****************************************************************************/
 109
 110
 111
 112 void g_usecode (void);
 113 /* Switch to the code segment */
 114
 115 void g_userodata (void);
 116 /* Switch to the read only data segment */
 117
 118 void g_usedata (void);
 119 /* Switch to the data segment */
 120
 121 void g_usebss (void);
 122 /* Switch to the bss segment */
 123
 124 void g_codename (const char* Name);
 125 /* Set the name of the CODE segment */
 126
 127 void g_rodataname (const char* Name);
 128 /* Set the name of the RODATA segment */
 129
 130 void g_dataname (const char* Name);
 131 /* Set the name of the DATA segment */
 132
 133 void g_bssname (const char* Name);
 134 /* Set the name of the BSS segment */
 135
 136
 137
 138 /*****************************************************************************/
 139 /*                      Functions handling local labels                      */
 140 /*****************************************************************************/
 141
 142
 143
 144 void g_defloclabel (unsigned label);
 145 /* Define a local label */
 146
 147
 148
 149 /*****************************************************************************/
 150 /*                     Functions handling global labels                      */
 151 /*****************************************************************************/
 152
 153
 154
 155 void g_defgloblabel (const char* Name);
 156 /* Define a global label with the given name */
 157
 158 void g_defexport (const char* Name, int ZP);
 159 /* Export the given label */
 160
 161 void g_defimport (const char* Name, int ZP);
 162 /* Import the given label */
 163
 164
 165
 166 /*****************************************************************************/
 167 /*                                   stack                                   */
 168 /*****************************************************************************/
 169
 170
 171
 172 int pop (unsigned flags);
 173 /* Pop an argument of the given size */
 174
 175 int push (unsigned flags);
 176 /* Push an argument of the given size */
 177
 178 unsigned sizeofarg (unsigned flags);
 179 /* Return the size of a function argument type that is encoded in flags */
 180
 181
 182
 183 /*****************************************************************************/
 184 /*                    type conversion and similiar stuff                     */
 185 /*****************************************************************************/
 186
 187
 188
 189 void g_toslong (unsigned flags);
 190 /* Make sure, the value on TOS is a long. Convert if necessary */
 191
 192 void g_tosint (unsigned flags);
 193 /* Make sure, the value on TOS is an int. Convert if necessary */
 194
 195 void g_reglong (unsigned flags);
 196 /* Make sure, the value in the primary register a long. Convert if necessary */
 197
 198 unsigned g_typeadjust (unsigned lhs, unsigned rhs);
 199 /* Adjust the integer operands before doing a binary operation. lhs is a flags
 200  * value, that corresponds to the value on TOS, rhs corresponds to the value
 201  *  in (e)ax. The return value is the the flags value for the resulting type.
 202  */
 203
 204 unsigned g_typecast (unsigned lhs, unsigned rhs);
 205 /* Cast the value in the primary register to the operand size that is flagged
 206  * by the lhs value. Return the result value.
 207  */
 208
 209 void g_scale (unsigned flags, long val);
 210 /* Scale the value in the primary register by the given value. If val is positive,
 211  * scale up, is val is negative, scale down. This function is used to scale
 212  * the operands or results of pointer arithmetic by the size of the type, the
 213  * pointer points to.
 214  */
 215
 216
 217
 218 /*****************************************************************************/
 219 /*                          Function entry and exit                          */
 220 /*****************************************************************************/
 221
 222
 223
 224 void g_enter (unsigned flags, unsigned argsize);
 225 /* Function prologue */
 226
 227 void g_leave (int flags, int val);
 228 /* Function epilogue */
 229
 230
 231
 232 /*****************************************************************************/
 233 /*                            Register variables                             */
 234 /*****************************************************************************/
 235
 236
 237
 238 void g_save_regvars (int RegOffs, unsigned Bytes);
 239 /* Save register variables */
 240
 241 void g_restore_regvars (int StackOffs, int RegOffs, unsigned Bytes);
 242 /* Restore register variables */
 243
 244
 245
 246 /*****************************************************************************/
 247 /*                           Fetching memory cells                           */
 248 /*****************************************************************************/
 249
 250
 251
 252 void g_getimmed (unsigned Flags, unsigned long Val, unsigned Offs);
 253 /* Load a constant into the primary register */
 254
 255 void g_getstatic (unsigned Flags, unsigned long Label, unsigned Offs);
 256 /* Fetch an static memory cell into the primary register */
 257
 258 void g_getlocal (unsigned Flags, int Offs);
 259 /* Fetch specified local object (local var). */
 260
 261 void g_getind (unsigned Flags, unsigned Offs);
 262 /* Fetch the specified object type indirect through the primary register
 263  * into the primary register
 264  */
 265
 266 void g_leasp (int Offs);
 267 /* Fetch the address of the specified symbol into the primary register */
 268
 269 void g_leavariadic (int Offs);
 270 /* Fetch the address of a parameter in a variadic function into the primary
 271  * register
 272  */
 273
 274
 275
 276 /*****************************************************************************/
 277 /*                             Store into memory                             */
 278 /*****************************************************************************/
 279
 280
 281
 282 void g_putstatic (unsigned flags, unsigned long label, unsigned offs);
 283 /* Store the primary register into the specified static memory cell */
 284
 285 void g_putlocal (unsigned Flags, int Offs, long Val);
 286 /* Put data into local object. */
 287
 288 void g_putind (unsigned flags, unsigned offs);
 289 /* Store the specified object type in the primary register at the address
 290  * on the top of the stack
 291  */
 292
 293
 294
 295 /*****************************************************************************/
 296 /*              Adds and subs of variables fix a fixed address               */
 297 /*****************************************************************************/
 298
 299
 300
 301 void g_addlocal (unsigned flags, int offs);
 302 /* Add a local variable to ax */
 303
 304 void g_addstatic (unsigned flags, unsigned long label, unsigned offs);
 305 /* Add a static variable to ax */
 306
 307
 308
 309 /*****************************************************************************/
 310 /*             Compares of ax with a variable with fixed address             */
 311 /*****************************************************************************/
 312
 313
 314
 315 void g_cmplocal (unsigned flags, int offs);
 316 /* Compare a local variable to ax */
 317
 318 void g_cmpstatic (unsigned flags, unsigned label, unsigned offs);
 319 /* Compare a static variable to ax */
 320
 321
 322
 323 /*****************************************************************************/
 324 /*                           Special op= functions                           */
 325 /*****************************************************************************/
 326
 327
 328
 329 void g_addeqstatic (unsigned flags, unsigned long label, unsigned offs,
 330                     unsigned long val);
 331 /* Emit += for a static variable */
 332
 333 void g_addeqlocal (unsigned flags, int offs, unsigned long val);
 334 /* Emit += for a local variable */
 335
 336 void g_addeqind (unsigned flags, unsigned offs, unsigned long val);
 337 /* Emit += for the location with address in ax */
 338
 339 void g_subeqstatic (unsigned flags, unsigned long label, unsigned offs,
 340                     unsigned long val);
 341 /* Emit -= for a static variable */
 342
 343 void g_subeqlocal (unsigned flags, int offs, unsigned long val);
 344 /* Emit -= for a local variable */
 345
 346 void g_subeqind (unsigned flags, unsigned offs, unsigned long val);
 347 /* Emit -= for the location with address in ax */
 348
 349
 350
 351 /*****************************************************************************/
 352 /*                 Add a variable address to the value in ax                 */
 353 /*****************************************************************************/
 354
 355
 356
 357 void g_addaddr_local (unsigned flags, int offs);
 358 /* Add the address of a local variable to ax */
 359
 360 void g_addaddr_static (unsigned flags, unsigned long label, unsigned offs);
 361 /* Add the address of a static variable to ax */
 362
 363
 364
 365 /*****************************************************************************/
 366 /*                                                                           */
 367 /*****************************************************************************/
 368
 369
 370
 371 void g_save (unsigned flags);
 372 void g_restore (unsigned flags);
 373
 374 void g_cmp (unsigned flags, unsigned long val);
 375 /* Immidiate compare. The primary register will not be changed, Z flag
 376  * will be set.
 377  */
 378
 379 void g_test (unsigned flags);
 380 void g_push (unsigned flags, unsigned long val);
 381 void g_swap (unsigned flags);
 382
 383 void g_call (unsigned Flags, const char* Label, unsigned ArgSize);
 384 /* Call the specified subroutine name */
 385
 386 void g_callind (unsigned Flags, unsigned ArgSize);
 387 /* Call subroutine with address in AX */
 388
 389 void g_jump (unsigned Label);
 390 /* Jump to specified internal label number */
 391
 392 void g_switch (unsigned Flags);
 393 /* Output switch statement preamble */
 394
 395 void g_case (unsigned flags, unsigned label, unsigned long val);
 396 /* Create table code for one case selector */
 397
 398 void g_truejump (unsigned flags, unsigned label);
 399 /* Jump to label if zero flag clear */
 400
 401 void g_falsejump (unsigned flags, unsigned label);
 402 /* Jump to label if zero flag set */
 403
 404 void g_space (int space);
 405 /* Create or drop space on the stack */
 406
 407 void g_cstackcheck (void);
 408 /* Check for a C stack overflow */
 409
 410 void g_stackcheck (void);
 411 /* Check for a stack overflow */
 412
 413 void g_add (unsigned flags, unsigned long val);
 414 void g_sub (unsigned flags, unsigned long val);
 415 void g_rsub (unsigned flags, unsigned long val);
 416 void g_mul (unsigned flags, unsigned long val);
 417 void g_div (unsigned flags, unsigned long val);
 418 void g_mod (unsigned flags, unsigned long val);
 419 void g_or (unsigned flags, unsigned long val);
 420 void g_xor (unsigned flags, unsigned long val);
 421 void g_and (unsigned flags, unsigned long val);
 422 void g_asr (unsigned flags, unsigned long val);
 423 void g_asl (unsigned flags, unsigned long val);
 424 void g_neg (unsigned flags);
 425 void g_bneg (unsigned flags);
 426 void g_com (unsigned flags);
 427 void g_inc (unsigned flags, unsigned long n);
 428 void g_dec (unsigned flags, unsigned long n);
 429 void g_eq (unsigned flags, unsigned long val);
 430 void g_ne (unsigned flags, unsigned long val);
 431 void g_lt (unsigned flags, unsigned long val);
 432 void g_le (unsigned flags, unsigned long val);
 433 void g_gt (unsigned flags, unsigned long val);
 434 void g_ge (unsigned flags, unsigned long val);
 435
 436 void g_res (unsigned n);
 437 /* Reserve static storage, n bytes */
 438
 439 void g_defdata (unsigned flags, unsigned long val, unsigned offs);
 440 /* Define data with the size given in flags */
 441
 442 void g_defbytes (const void* bytes, unsigned count);
 443 /* Output a row of bytes as a constant */
 444
 445 void g_zerobytes (unsigned n);
 446 /* Output n bytes of data initialized with zero */
 447
 448
 449
 450 /*****************************************************************************/
 451 /*                       User supplied assembler code                        */
 452 /*****************************************************************************/
 453
 454
 455
 456 void g_asmcode (const char* Line, int Len);
 457 /* Output one line of assembler code. If Len is greater than zero, it is used
 458  * as the maximum number of characters to use from Line.
 459  */
 460
 461
 462
 463 /*****************************************************************************/
 464 /*                          Inlined known functions                          */
 465 /*****************************************************************************/
 466
 467
 468
 469 void g_strlen (unsigned flags, unsigned long val, unsigned offs);
 470 /* Inline the strlen() function */
 471
 472
 473
 474 /* End of codegen.h */
 475 #endif
 476
 477