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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                datatype.h                                 */
   4 /*                                                                           */
   5 /*               Type string handling for the cc65 C compiler                */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2004 Ullrich von Bassewitz                                       */
  10 /*               Römerstrasse 52                                             */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  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 DATATYPE_H
  37 #define DATATYPE_H
  38
  39
  40
  41 #include <stdio.h>
  42
  43 /* common */
  44 #include "attrib.h"
  45 #include "inline.h"
  46
  47 /* cc65 */
  48 #include "funcdesc.h"
  49
  50
  51
  52 /*****************************************************************************/
  53 /*                                   Data                                    */
  54 /*****************************************************************************/
  55
  56
  57
  58
  59 /* Basic data types */
  60 enum {
  61     T_END           = 0x0000,
  62
  63     /* Basic types */
  64     T_TYPE_NONE     = 0x0000,
  65     T_TYPE_CHAR     = 0x0001,
  66     T_TYPE_SHORT    = 0x0002,
  67     T_TYPE_INT      = 0x0003,
  68     T_TYPE_LONG     = 0x0004,
  69     T_TYPE_LONGLONG = 0x0005,
  70     T_TYPE_ENUM     = 0x0006,
  71     T_TYPE_FLOAT    = 0x0007,
  72     T_TYPE_DOUBLE   = 0x0008,
  73     T_TYPE_VOID     = 0x0009,
  74     T_TYPE_STRUCT   = 0x000A,
  75     T_TYPE_UNION    = 0x000B,
  76     T_TYPE_ARRAY    = 0x000C,
  77     T_TYPE_PTR      = 0x000D,
  78     T_TYPE_FUNC     = 0x000E,
  79     T_MASK_TYPE     = 0x001F,
  80
  81     /* Type classes */
  82     T_CLASS_NONE    = 0x0000,
  83     T_CLASS_INT     = 0x0020,
  84     T_CLASS_FLOAT   = 0x0040,
  85     T_CLASS_PTR     = 0x0060,
  86     T_CLASS_STRUCT  = 0x0080,
  87     T_CLASS_FUNC    = 0x00A0,
  88     T_MASK_CLASS    = 0x00E0,
  89
  90     /* Type signedness */
  91     T_SIGN_NONE     = 0x0000,
  92     T_SIGN_UNSIGNED = 0x0100,
  93     T_SIGN_SIGNED   = 0x0200,
  94     T_MASK_SIGN     = 0x0300,
  95
  96     /* Type size modifiers */
  97     T_SIZE_NONE     = 0x0000,
  98     T_SIZE_SHORT    = 0x0400,
  99     T_SIZE_LONG     = 0x0800,
 100     T_SIZE_LONGLONG = 0x0C00,
 101     T_MASK_SIZE     = 0x0C00,
 102
 103     /* Type qualifiers */
 104     T_QUAL_NONE     = 0x0000,
 105     T_QUAL_CONST    = 0x1000,
 106     T_QUAL_VOLATILE = 0x2000,
 107     T_MASK_QUAL     = 0x3000,
 108
 109     /* Types */
 110     T_CHAR      = T_TYPE_CHAR     | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_NONE,
 111     T_SCHAR     = T_TYPE_CHAR     | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_NONE,
 112     T_UCHAR     = T_TYPE_CHAR     | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_NONE,
 113     T_SHORT     = T_TYPE_SHORT    | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_SHORT,
 114     T_USHORT    = T_TYPE_SHORT    | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_SHORT,
 115     T_INT       = T_TYPE_INT      | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_NONE,
 116     T_UINT      = T_TYPE_INT      | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_NONE,
 117     T_LONG      = T_TYPE_LONG     | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_LONG,
 118     T_ULONG     = T_TYPE_LONG     | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_LONG,
 119     T_LONGLONG  = T_TYPE_LONGLONG | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_LONGLONG,
 120     T_ULONGLONG = T_TYPE_LONGLONG | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_LONGLONG,
 121     T_ENUM      = T_TYPE_ENUM     | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_NONE,
 122     T_FLOAT     = T_TYPE_FLOAT    | T_CLASS_FLOAT  | T_SIGN_NONE     | T_SIZE_NONE,
 123     T_DOUBLE    = T_TYPE_DOUBLE   | T_CLASS_FLOAT  | T_SIGN_NONE     | T_SIZE_NONE,
 124     T_VOID      = T_TYPE_VOID     | T_CLASS_NONE   | T_SIGN_NONE     | T_SIZE_NONE,
 125     T_STRUCT    = T_TYPE_STRUCT   | T_CLASS_STRUCT | T_SIGN_NONE     | T_SIZE_NONE,
 126     T_UNION     = T_TYPE_UNION    | T_CLASS_STRUCT | T_SIGN_NONE     | T_SIZE_NONE,
 127     T_ARRAY     = T_TYPE_ARRAY    | T_CLASS_PTR    | T_SIGN_NONE     | T_SIZE_NONE,
 128     T_PTR       = T_TYPE_PTR      | T_CLASS_PTR    | T_SIGN_NONE     | T_SIZE_NONE,
 129     T_FUNC      = T_TYPE_FUNC     | T_CLASS_FUNC   | T_SIGN_NONE     | T_SIZE_NONE,
 130
 131     /* Aliases */
 132     T_SIZE_T    = T_UINT,
 133 };
 134
 135
 136
 137 /* Forward for a symbol entry */
 138 struct SymEntry;
 139
 140 /* Type entry */
 141 typedef unsigned short type;
 142
 143 /* Maximum length of a type string */
 144 #define MAXTYPELEN      30
 145
 146 /* Type elements needed for Encode/Decode */
 147 #define DECODE_SIZE     5
 148
 149 /* Special encodings for element counts of an array */
 150 #define UNSPECIFIED     -1L     /* Element count was not specified */
 151 #define FLEXIBLE        0L      /* Flexible array struct member */
 152
 153 /* Sizes */
 154 #define SIZEOF_CHAR     1
 155 #define SIZEOF_SHORT    2
 156 #define SIZEOF_INT      2
 157 #define SIZEOF_LONG     4
 158 #define SIZEOF_LONGLONG 8
 159 #define SIZEOF_FLOAT    4
 160 #define SIZEOF_DOUBLE   4
 161 #define SIZEOF_PTR      2
 162
 163 /* Predefined type strings */
 164 extern type type_uchar [];
 165 extern type type_int [];
 166 extern type type_uint [];
 167 extern type type_long [];
 168 extern type type_ulong [];
 169 extern type type_void [];
 170 extern type type_size_t [];
 171
 172
 173
 174 /*****************************************************************************/
 175 /*                                   Code                                    */
 176 /*****************************************************************************/
 177
 178
 179
 180 unsigned TypeLen (const type* Type);
 181 /* Return the length of the type string */
 182
 183 type* TypeCpy (type* Dest, const type* Src);
 184 /* Copy a type string */
 185
 186 type* TypeCat (type* Dest, const type* Src);
 187 /* Append Src */
 188
 189 type* TypeDup (const type* Type);
 190 /* Create a copy of the given type on the heap */
 191
 192 type* TypeAlloc (unsigned Len);
 193 /* Allocate memory for a type string of length Len. Len *must* include the
 194  * trailing T_END.
 195  */
 196
 197 void TypeFree (type* Type);
 198 /* Free a type string */
 199
 200 int SignExtendChar (int C);
 201 /* Do correct sign extension of a character */
 202
 203 type GetDefaultChar (void);
 204 /* Return the default char type (signed/unsigned) depending on the settings */
 205
 206 type* GetCharArrayType (unsigned Len);
 207 /* Return the type for a char array of the given length */
 208
 209 type* GetImplicitFuncType (void);
 210 /* Return a type string for an inplicitly declared function */
 211
 212 type* PointerTo (const type* T);
 213 /* Return a type string that is "pointer to T". The type string is allocated
 214  * on the heap and may be freed after use.
 215  */
 216
 217 void PrintType (FILE* F, const type* Type);
 218 /* Output translation of type array. */
 219
 220 void PrintRawType (FILE* F, const type* Type);
 221 /* Print a type string in raw format (for debugging) */
 222
 223 void PrintFuncSig (FILE* F, const char* Name, type* Type);
 224 /* Print a function signature. */
 225
 226 void Encode (type* Type, unsigned long Val);
 227 /* Encode Val into the given type string */
 228
 229 void EncodePtr (type* Type, void* P);
 230 /* Encode a pointer into a type array */
 231
 232 unsigned long Decode (const type* Type);
 233 /* Decode an unsigned long from a type array */
 234
 235 void* DecodePtr (const type* Type);
 236 /* Decode a pointer from a type array */
 237
 238 int HasEncode (const type* Type);
 239 /* Return true if the given type has encoded data */
 240
 241 void CopyEncode (const type* Source, type* Target);
 242 /* Copy encoded data from Source to Target */
 243
 244 #if defined(HAVE_INLINE)
 245 INLINE type UnqualifiedType (type T)
 246 /* Return the unqalified type */
 247 {
 248     return (T & ~T_MASK_QUAL);
 249 }
 250 #else
 251 #  define UnqualifiedType(T)    ((T) & ~T_MASK_QUAL)
 252 #endif
 253
 254 unsigned SizeOf (const type* Type);
 255 /* Compute size of object represented by type array. */
 256
 257 unsigned PSizeOf (const type* Type);
 258 /* Compute size of pointer object. */
 259
 260 unsigned CheckedSizeOf (const type* T);
 261 /* Return the size of a data type. If the size is zero, emit an error and
 262  * return some valid size instead (so the rest of the compiler doesn't have
 263  * to work with invalid sizes).
 264  */
 265 unsigned CheckedPSizeOf (const type* T);
 266 /* Return the size of a data type that is pointed to by a pointer. If the
 267  * size is zero, emit an error and return some valid size instead (so the
 268  * rest of the compiler doesn't have to work with invalid sizes).
 269  */
 270
 271 unsigned TypeOf (const type* Type);
 272 /* Get the code generator base type of the object */
 273
 274 type* Indirect (type* Type);
 275 /* Do one indirection for the given type, that is, return the type where the
 276  * given type points to.
 277  */
 278
 279 type* ArrayToPtr (const type* Type);
 280 /* Convert an array to a pointer to it's first element */
 281
 282 #if defined(HAVE_INLINE)
 283 INLINE int IsTypeChar (const type* T)
 284 /* Return true if this is a character type */
 285 {
 286     return (T[0] & T_MASK_TYPE) == T_TYPE_CHAR;
 287 }
 288 #else
 289 #  define IsTypeChar(T)         (((T)[0] & T_MASK_TYPE) == T_TYPE_CHAR)
 290 #endif
 291
 292 #if defined(HAVE_INLINE)
 293 INLINE int IsTypeInt (const type* T)
 294 /* Return true if this is an int type (signed or unsigned) */
 295 {
 296     return (T[0] & T_MASK_TYPE) == T_TYPE_INT;
 297 }
 298 #else
 299 #  define IsTypeInt(T)          (((T)[0] & T_MASK_TYPE) == T_TYPE_INT)
 300 #endif
 301
 302 #if defined(HAVE_INLINE)
 303 INLINE int IsTypeLong (const type* T)
 304 /* Return true if this is a long type (signed or unsigned) */
 305 {
 306     return (T[0] & T_MASK_TYPE) == T_TYPE_LONG;
 307 }
 308 #else
 309 #  define IsTypeLong(T)         (((T)[0] & T_MASK_TYPE) == T_TYPE_LONG)
 310 #endif
 311
 312 #if defined(HAVE_INLINE)
 313 INLINE int IsTypeFloat (const type* T)
 314 /* Return true if this is a float type */
 315 {
 316     return (T[0] & T_MASK_TYPE) == T_TYPE_FLOAT;
 317 }
 318 #else
 319 #  define IsTypeFloat(T)        (((T)[0] & T_MASK_TYPE) == T_TYPE_FLOAT)
 320 #endif
 321
 322 #if defined(HAVE_INLINE)
 323 INLINE int IsTypeDouble (const type* T)
 324 /* Return true if this is a double type */
 325 {
 326     return (T[0] & T_MASK_TYPE) == T_TYPE_DOUBLE;
 327 }
 328 #else
 329 #  define IsTypeDouble(T)       (((T)[0] & T_MASK_TYPE) == T_TYPE_DOUBLE)
 330 #endif
 331
 332 #if defined(HAVE_INLINE)
 333 INLINE int IsTypePtr (const type* T)
 334 /* Return true if this is a pointer type */
 335 {
 336     return ((T[0] & T_MASK_TYPE) == T_TYPE_PTR);
 337 }
 338 #else
 339 #  define IsTypePtr(T)          (((T)[0] & T_MASK_TYPE) == T_TYPE_PTR)
 340 #endif
 341
 342 #if defined(HAVE_INLINE)
 343 INLINE int IsTypeStruct (const type* T)
 344 /* Return true if this is a struct type */
 345 {
 346     return ((T[0] & T_MASK_TYPE) == T_TYPE_STRUCT);
 347 }
 348 #else
 349 #  define IsTypeStruct(T)       (((T)[0] & T_MASK_TYPE) == T_TYPE_STRUCT)
 350 #endif
 351
 352 #if defined(HAVE_INLINE)
 353 INLINE int IsTypeUnion (const type* T)
 354 /* Return true if this is a union type */
 355 {
 356     return ((T[0] & T_MASK_TYPE) == T_TYPE_UNION);
 357 }
 358 #else
 359 #  define IsTypeUnion(T)       (((T)[0] & T_MASK_TYPE) == T_TYPE_UNION)
 360 #endif
 361
 362 #if defined(HAVE_INLINE)
 363 INLINE int IsTypeArray (const type* T)
 364 /* Return true if this is an array type */
 365 {
 366     return ((T[0] & T_MASK_TYPE) == T_TYPE_ARRAY);
 367 }
 368 #else
 369 #  define IsTypeArray(T)        (((T)[0] & T_MASK_TYPE) == T_TYPE_ARRAY)
 370 #endif
 371
 372 #if defined(HAVE_INLINE)
 373 INLINE int IsTypeVoid (const type* T)
 374 /* Return true if this is a void type */
 375 {
 376     return (T[0] & T_MASK_TYPE) == T_TYPE_VOID;
 377 }
 378 #else
 379 #  define IsTypeVoid(T)         (((T)[0] & T_MASK_TYPE) == T_TYPE_VOID)
 380 #endif
 381
 382 #if defined(HAVE_INLINE)
 383 INLINE int IsTypeFunc (const type* T)
 384 /* Return true if this is a function class */
 385 {
 386     return ((T[0] & T_MASK_TYPE) == T_TYPE_FUNC);
 387 }
 388 #else
 389 #  define IsTypeFunc(T)         (((T)[0] & T_MASK_TYPE) == T_TYPE_FUNC)
 390 #endif
 391
 392 #if defined(HAVE_INLINE)
 393 INLINE int IsTypeFuncPtr (const type* T)
 394 /* Return true if this is a function pointer */
 395 {
 396     return ((T[0] & T_MASK_TYPE) == T_TYPE_PTR && (T[1] & T_MASK_TYPE) == T_TYPE_FUNC);
 397 }
 398 #else
 399 #  define IsTypeFuncPtr(T)      \
 400         ((((T)[0] & T_MASK_TYPE) == T_TYPE_PTR) && (((T)[1] & T_MASK_TYPE) == T_TYPE_FUNC))
 401 #endif
 402
 403 int IsClassInt (const type* Type) attribute ((const));
 404 /* Return true if this is an integer type */
 405
 406 int IsClassFloat (const type* Type) attribute ((const));
 407 /* Return true if this is a float type */
 408
 409 int IsClassPtr (const type* Type) attribute ((const));
 410 /* Return true if this is a pointer type */
 411
 412 int IsClassStruct (const type* Type) attribute ((const));
 413 /* Return true if this is a struct type */
 414
 415 int IsSignUnsigned (const type* Type) attribute ((const));
 416 /* Return true if this is an unsigned type */
 417
 418 int IsQualConst (const type* T) attribute ((const));
 419 /* Return true if the given type has a const memory image */
 420
 421 int IsQualVolatile (const type* T) attribute ((const));
 422 /* Return true if the given type has a volatile type qualifier */
 423
 424 int IsFastCallFunc (const type* T) attribute ((const));
 425 /* Return true if this is a function type or pointer to function with
 426  * __fastcall__ calling conventions
 427  */
 428
 429 int IsVariadicFunc (const type* T) attribute ((const));
 430 /* Return true if this is a function type or pointer to function type with
 431  * variable parameter list
 432  */
 433
 434 #if defined(HAVE_INLINE)
 435 INLINE type GetType (const type* T)
 436 /* Get the raw type */
 437 {
 438     return (T[0] & T_MASK_TYPE);
 439 }
 440 #else
 441 #  define GetType(T)    ((T)[0] & T_MASK_TYPE)
 442 #endif
 443
 444 #if defined(HAVE_INLINE)
 445 INLINE type GetClass (const type* T)
 446 /* Get the class of a type string */
 447 {
 448     return (T[0] & T_MASK_CLASS);
 449 }
 450 #else
 451 #  define GetClass(T)    ((T)[0] & T_MASK_CLASS)
 452 #endif
 453
 454 #if defined(HAVE_INLINE)
 455 INLINE type GetSignedness (const type* T)
 456 /* Get the sign of a type */
 457 {
 458     return (T[0] & T_MASK_SIGN);
 459 }
 460 #else
 461 #  define GetSignedness(T)      ((T)[0] & T_MASK_SIGN)
 462 #endif
 463
 464 #if defined(HAVE_INLINE)
 465 INLINE type GetSizeModifier (const type* T)
 466 /* Get the size modifier of a type */
 467 {
 468     return (T[0] & T_MASK_SIZE);
 469 }
 470 #else
 471 #  define GetSizeModifier(T)      ((T)[0] & T_MASK_SIZE)
 472 #endif
 473
 474 type GetQualifier (const type* T) attribute ((const));
 475 /* Get the qualifier from the given type string */
 476
 477 FuncDesc* GetFuncDesc (const type* T) attribute ((const));
 478 /* Get the FuncDesc pointer from a function or pointer-to-function type */
 479
 480 type* GetFuncReturn (type* T) attribute ((const));
 481 /* Return a pointer to the return type of a function or pointer-to-function type */
 482
 483 long GetElementCount (const type* T);
 484 /* Get the element count of the array specified in T (which must be of
 485  * array type).
 486  */
 487
 488 type* GetElementType (type* T);
 489 /* Return the element type of the given array type. */
 490
 491
 492
 493 /* End of datatype.h */
 494
 495 #endif
 496
 497
 498