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     Ullrich 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 DATATYPE_H
  37 #define DATATYPE_H
  38
  39
  40
  41 #include <stdio.h>
  42
  43
  44
  45 /*****************************************************************************/
  46 /*                                   Data                                    */
  47 /*****************************************************************************/
  48
  49
  50
  51
  52 // Basic data types
  53 enum {
  54     T_END           = 0x0000,
  55
  56     // Basic types
  57     T_TYPE_NONE     = 0x0000,
  58     T_TYPE_CHAR     = 0x0001,
  59     T_TYPE_SHORT    = 0x0002,
  60     T_TYPE_INT      = 0x0003,
  61     T_TYPE_LONG     = 0x0004,
  62     T_TYPE_LONGLONG = 0x0005,
  63     T_TYPE_ENUM     = 0x0006,
  64     T_TYPE_FLOAT    = 0x0007,
  65     T_TYPE_DOUBLE   = 0x0008,
  66     T_TYPE_VOID     = 0x0009,
  67     T_TYPE_STRUCT   = 0x000A,
  68     T_TYPE_UNION    = 0x000B,
  69     T_TYPE_ARRAY    = 0x000C,
  70     T_TYPE_PTR      = 0x000D,
  71     T_TYPE_FUNC     = 0x000E,
  72     T_MASK_TYPE     = 0x001F,
  73
  74     // Type classes
  75     T_CLASS_NONE    = 0x0000,
  76     T_CLASS_INT     = 0x0020,
  77     T_CLASS_FLOAT   = 0x0040,
  78     T_CLASS_PTR     = 0x0060,
  79     T_CLASS_STRUCT  = 0x0080,
  80     T_CLASS_FUNC    = 0x00A0,
  81     T_MASK_CLASS    = 0x00E0,
  82
  83     // Type signedness
  84     T_SIGN_NONE     = 0x0000,
  85     T_SIGN_UNSIGNED = 0x0100,
  86     T_SIGN_SIGNED   = 0x0200,
  87     T_MASK_SIGN     = 0x0300,
  88
  89     // Type size modifiers
  90     T_SIZE_NONE     = 0x0000,
  91     T_SIZE_SHORT    = 0x0400,
  92     T_SIZE_LONG     = 0x0800,
  93     T_SIZE_LONGLONG = 0x0C00,
  94     T_MASK_SIZE     = 0x0C00,
  95
  96     // Type qualifiers
  97     T_QUAL_NONE     = 0x0000,
  98     T_QUAL_CONST    = 0x1000,
  99     T_QUAL_VOLATILE = 0x2000,
 100     T_MASK_QUAL     = 0x3000,
 101
 102     // Types
 103     T_CHAR      = T_TYPE_CHAR     | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_NONE,
 104     T_SCHAR     = T_TYPE_CHAR     | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_NONE,
 105     T_UCHAR     = T_TYPE_CHAR     | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_NONE,
 106     T_SHORT     = T_TYPE_SHORT    | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_SHORT,
 107     T_USHORT    = T_TYPE_SHORT    | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_SHORT,
 108     T_INT       = T_TYPE_INT      | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_NONE,
 109     T_UINT      = T_TYPE_INT      | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_NONE,
 110     T_LONG      = T_TYPE_LONG     | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_LONG,
 111     T_ULONG     = T_TYPE_LONG     | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_LONG,
 112     T_LONGLONG  = T_TYPE_LONGLONG | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_LONGLONG,
 113     T_ULONGLONG = T_TYPE_LONGLONG | T_CLASS_INT    | T_SIGN_UNSIGNED | T_SIZE_LONGLONG,
 114     T_ENUM      = T_TYPE_ENUM     | T_CLASS_INT    | T_SIGN_SIGNED   | T_SIZE_NONE,
 115     T_FLOAT     = T_TYPE_FLOAT    | T_CLASS_FLOAT  | T_SIGN_NONE     | T_SIZE_NONE,
 116     T_DOUBLE    = T_TYPE_DOUBLE   | T_CLASS_FLOAT  | T_SIGN_NONE     | T_SIZE_NONE,
 117     T_VOID      = T_TYPE_VOID     | T_CLASS_NONE   | T_SIGN_NONE     | T_SIZE_NONE,
 118     T_STRUCT    = T_TYPE_STRUCT   | T_CLASS_STRUCT | T_SIGN_NONE     | T_SIZE_NONE,
 119     T_UNION     = T_TYPE_UNION    | T_CLASS_STRUCT | T_SIGN_NONE     | T_SIZE_NONE,
 120     T_ARRAY     = T_TYPE_ARRAY    | T_CLASS_PTR    | T_SIGN_NONE     | T_SIZE_NONE,
 121     T_PTR       = T_TYPE_PTR      | T_CLASS_PTR    | T_SIGN_NONE     | T_SIZE_NONE,
 122     T_FUNC      = T_TYPE_FUNC     | T_CLASS_FUNC   | T_SIGN_NONE     | T_SIZE_NONE,
 123
 124 };
 125
 126
 127
 128 /* Forward for a symbol entry */
 129 struct SymEntry;
 130
 131 /* Type entry */
 132 typedef unsigned short type;
 133
 134 /* Maximum length of a type string */
 135 #define MAXTYPELEN      30
 136
 137 /* type elements needed for Encode/Decode */
 138 #define DECODE_SIZE     5
 139
 140 /* Predefined type strings */
 141 extern type type_int [];
 142 extern type type_uint [];
 143 extern type type_long [];
 144 extern type type_ulong [];
 145 extern type type_void [];
 146 extern type type_pschar [];
 147 extern type type_puchar [];
 148
 149
 150
 151 /*****************************************************************************/
 152 /*                                   Code                                    */
 153 /*****************************************************************************/
 154
 155
 156
 157 unsigned TypeLen (const type* Type);
 158 /* Return the length of the type string */
 159
 160 int TypeCmp (const type* T1, const type* T2);
 161 /* Compare two type strings */
 162
 163 type* TypeCpy (type* Dest, const type* Src);
 164 /* Copy a type string */
 165
 166 type* TypeCat (type* Dest, const type* Src);
 167 /* Append Src */
 168
 169 type* TypeDup (const type* Type);
 170 /* Create a copy of the given type on the heap */
 171
 172 type* TypeAlloc (unsigned Len);
 173 /* Allocate memory for a type string of length Len. Len *must* include the
 174  * trailing T_END.
 175  */
 176
 177 void TypeFree (type* Type);
 178 /* Free a type string */
 179
 180 type GetDefaultChar (void);
 181 /* Return the default char type (signed/unsigned) depending on the settings */
 182
 183 type* GetCharArrayType (unsigned Len);
 184 /* Return the type for a char array of the given length */
 185
 186 type* GetImplicitFuncType (void);
 187 /* Return a type string for an inplicitly declared function */
 188
 189 void PrintType (FILE* F, const type* Type);
 190 /* Output translation of type array. */
 191
 192 void PrintRawType (FILE* F, const type* Type);
 193 /* Print a type string in raw format (for debugging) */
 194
 195 void Encode (type* Type, unsigned long Val);
 196 /* Encode an unsigned long into a type array */
 197
 198 void EncodePtr (type* Type, void* P);
 199 /* Encode a pointer into a type array */
 200
 201 unsigned long Decode (const type* Type);
 202 /* Decode an unsigned long from a type array */
 203
 204 void* DecodePtr (const type* Type);
 205 /* Decode a pointer from a type array */
 206
 207 int HasEncode (const type* Type);
 208 /* Return true if the given type has encoded data */
 209
 210 void CopyEncode (const type* Source, type* Target);
 211 /* Copy encoded data from Source to Target */
 212
 213 type UnqualifiedType (type T);
 214 /* Return the unqalified type */
 215
 216 unsigned SizeOf (const type* Type);
 217 /* Compute size of object represented by type array. */
 218
 219 unsigned PSizeOf (const type* Type);
 220 /* Compute size of pointer object. */
 221
 222 unsigned TypeOf (const type* Type);
 223 /* Get the code generator base type of the object */
 224
 225 type* Indirect (type* Type);
 226 /* Do one indirection for the given type, that is, return the type where the
 227  * given type points to.
 228  */
 229
 230 int IsConst (const type* T);
 231 /* Return true if the given type has a const memory image */
 232
 233 int IsTypeVoid (const type* Type);
 234 /* Return true if this is a void type */
 235
 236 int IsClassPtr (const type* Type);
 237 /* Return true if this is a pointer type */
 238
 239 int IsTypeChar (const type* Type);
 240 /* Return true if this is a character type */
 241
 242 int IsClassInt (const type* Type);
 243 /* Return true if this is an integer type */
 244
 245 int IsTypeLong (const type* Type);
 246 /* Return true if this is a long type (signed or unsigned) */
 247
 248 int IsUnsigned (const type* Type);
 249 /* Return true if this is an unsigned type */
 250
 251 int IsClassStruct (const type* Type);
 252 /* Return true if this is a struct type */
 253
 254 int IsTypeFunc (const type* Type);
 255 /* Return true if this is a function class */
 256
 257 int IsFastCallFunc (const type* Type);
 258 /* Return true if this is a function type with __fastcall__ calling conventions */
 259
 260 int IsTypeFuncPtr (const type* Type);
 261 /* Return true if this is a function pointer */
 262
 263 int IsTypeArray (const type* Type);
 264 /* Return true if this is an array type */
 265
 266 struct FuncDesc* GetFuncDesc (const type* Type);
 267 /* Get the FuncDesc pointer from a function or pointer-to-function type */
 268
 269
 270
 271 /* End of datatype.h */
 272
 273 #endif
 274
 275
 276