1 /*****************************************************************************/
5 /* Type string handling for the cc65 C compiler */
9 /* (C) 1998-2002 Ullrich von Bassewitz */
11 /* D-70597 Stuttgart */
12 /* EMail: uz@musoftware.de */
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 /*****************************************************************************/
52 /*****************************************************************************/
54 /*****************************************************************************/
59 /* Basic data types */
66 T_TYPE_SHORT = 0x0002,
69 T_TYPE_LONGLONG = 0x0005,
71 T_TYPE_FLOAT = 0x0007,
72 T_TYPE_DOUBLE = 0x0008,
74 T_TYPE_STRUCT = 0x000A,
75 T_TYPE_UNION = 0x000B,
76 T_TYPE_ARRAY = 0x000C,
82 T_CLASS_NONE = 0x0000,
84 T_CLASS_FLOAT = 0x0040,
86 T_CLASS_STRUCT = 0x0080,
87 T_CLASS_FUNC = 0x00A0,
88 T_MASK_CLASS = 0x00E0,
92 T_SIGN_UNSIGNED = 0x0100,
93 T_SIGN_SIGNED = 0x0200,
96 /* Type size modifiers */
98 T_SIZE_SHORT = 0x0400,
100 T_SIZE_LONGLONG = 0x0C00,
101 T_MASK_SIZE = 0x0C00,
103 /* Type qualifiers */
104 T_QUAL_NONE = 0x0000,
105 T_QUAL_CONST = 0x1000,
106 T_QUAL_VOLATILE = 0x2000,
107 T_MASK_QUAL = 0x3000,
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,
135 /* Forward for a symbol entry */
139 typedef unsigned short type;
141 /* Maximum length of a type string */
142 #define MAXTYPELEN 30
144 /* Type elements needed for Encode/Decode */
145 #define DECODE_SIZE 5
147 /* Unspecified size for the element count of an array */
148 #define UNSPECIFIED -1L
151 #define SIZEOF_CHAR 1
152 #define SIZEOF_SHORT 2
154 #define SIZEOF_LONG 4
155 #define SIZEOF_LONGLONG 8
156 #define SIZEOF_FLOAT 4
157 #define SIZEOF_DOUBLE 4
160 /* Predefined type strings */
161 extern type type_uchar [];
162 extern type type_int [];
163 extern type type_uint [];
164 extern type type_long [];
165 extern type type_ulong [];
166 extern type type_void [];
167 extern type type_size_t [];
171 /*****************************************************************************/
173 /*****************************************************************************/
177 unsigned TypeLen (const type* Type);
178 /* Return the length of the type string */
180 type* TypeCpy (type* Dest, const type* Src);
181 /* Copy a type string */
183 type* TypeCat (type* Dest, const type* Src);
186 type* TypeDup (const type* Type);
187 /* Create a copy of the given type on the heap */
189 type* TypeAlloc (unsigned Len);
190 /* Allocate memory for a type string of length Len. Len *must* include the
194 void TypeFree (type* Type);
195 /* Free a type string */
197 int SignExtendChar (int C);
198 /* Do correct sign extension of a character */
200 type GetDefaultChar (void);
201 /* Return the default char type (signed/unsigned) depending on the settings */
203 type* GetCharArrayType (unsigned Len);
204 /* Return the type for a char array of the given length */
206 type* GetImplicitFuncType (void);
207 /* Return a type string for an inplicitly declared function */
209 type* PointerTo (const type* T);
210 /* Return a type string that is "pointer to T". The type string is allocated
211 * on the heap and may be freed after use.
214 void PrintType (FILE* F, const type* Type);
215 /* Output translation of type array. */
217 void PrintRawType (FILE* F, const type* Type);
218 /* Print a type string in raw format (for debugging) */
220 void PrintFuncSig (FILE* F, const char* Name, type* Type);
221 /* Print a function signature. */
223 void Encode (type* Type, unsigned long Val);
224 /* Encode Val into the given type string */
226 void EncodePtr (type* Type, void* P);
227 /* Encode a pointer into a type array */
229 unsigned long Decode (const type* Type);
230 /* Decode an unsigned long from a type array */
232 void* DecodePtr (const type* Type);
233 /* Decode a pointer from a type array */
235 int HasEncode (const type* Type);
236 /* Return true if the given type has encoded data */
238 void CopyEncode (const type* Source, type* Target);
239 /* Copy encoded data from Source to Target */
241 #if defined(HAVE_INLINE)
242 INLINE type UnqualifiedType (type T)
243 /* Return the unqalified type */
245 return (T & ~T_MASK_QUAL);
248 # define UnqualifiedType(T) ((T) & ~T_MASK_QUAL)
251 unsigned SizeOf (const type* Type);
252 /* Compute size of object represented by type array. */
254 unsigned PSizeOf (const type* Type);
255 /* Compute size of pointer object. */
257 unsigned CheckedSizeOf (const type* T);
258 /* Return the size of a data type. If the size is zero, emit an error and
259 * return some valid size instead (so the rest of the compiler doesn't have
260 * to work with invalid sizes).
262 unsigned CheckedPSizeOf (const type* T);
263 /* Return the size of a data type that is pointed to by a pointer. If the
264 * size is zero, emit an error and return some valid size instead (so the
265 * rest of the compiler doesn't have to work with invalid sizes).
268 unsigned TypeOf (const type* Type);
269 /* Get the code generator base type of the object */
271 type* Indirect (type* Type);
272 /* Do one indirection for the given type, that is, return the type where the
273 * given type points to.
276 type* ArrayToPtr (const type* Type);
277 /* Convert an array to a pointer to it's first element */
279 #if defined(HAVE_INLINE)
280 INLINE int IsTypeChar (const type* T)
281 /* Return true if this is a character type */
283 return (T[0] & T_MASK_TYPE) == T_TYPE_CHAR;
286 # define IsTypeChar(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_CHAR)
289 #if defined(HAVE_INLINE)
290 INLINE int IsTypeInt (const type* T)
291 /* Return true if this is an int type (signed or unsigned) */
293 return (T[0] & T_MASK_TYPE) == T_TYPE_INT;
296 # define IsTypeInt(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_INT)
299 #if defined(HAVE_INLINE)
300 INLINE int IsTypeLong (const type* T)
301 /* Return true if this is a long type (signed or unsigned) */
303 return (T[0] & T_MASK_TYPE) == T_TYPE_LONG;
306 # define IsTypeLong(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_LONG)
309 #if defined(HAVE_INLINE)
310 INLINE int IsTypeFloat (const type* T)
311 /* Return true if this is a float type */
313 return (T[0] & T_MASK_TYPE) == T_TYPE_FLOAT;
316 # define IsTypeFloat(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_FLOAT)
319 #if defined(HAVE_INLINE)
320 INLINE int IsTypeDouble (const type* T)
321 /* Return true if this is a double type */
323 return (T[0] & T_MASK_TYPE) == T_TYPE_DOUBLE;
326 # define IsTypeDouble(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_DOUBLE)
329 #if defined(HAVE_INLINE)
330 INLINE int IsTypePtr (const type* T)
331 /* Return true if this is a pointer type */
333 return ((T[0] & T_MASK_TYPE) == T_TYPE_PTR);
336 # define IsTypePtr(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_PTR)
339 #if defined(HAVE_INLINE)
340 INLINE int IsTypeStruct (const type* T)
341 /* Return true if this is a struct type */
343 return ((T[0] & T_MASK_TYPE) == T_TYPE_STRUCT);
346 # define IsTypeStruct(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_STRUCT)
349 #if defined(HAVE_INLINE)
350 INLINE int IsTypeUnion (const type* T)
351 /* Return true if this is a union type */
353 return ((T[0] & T_MASK_TYPE) == T_TYPE_UNION);
356 # define IsTypeUnion(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_UNION)
359 #if defined(HAVE_INLINE)
360 INLINE int IsTypeArray (const type* T)
361 /* Return true if this is an array type */
363 return ((T[0] & T_MASK_TYPE) == T_TYPE_ARRAY);
366 # define IsTypeArray(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_ARRAY)
369 #if defined(HAVE_INLINE)
370 INLINE int IsTypeVoid (const type* T)
371 /* Return true if this is a void type */
373 return (T[0] & T_MASK_TYPE) == T_TYPE_VOID;
376 # define IsTypeVoid(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_VOID)
379 #if defined(HAVE_INLINE)
380 INLINE int IsTypeFunc (const type* T)
381 /* Return true if this is a function class */
383 return ((T[0] & T_MASK_TYPE) == T_TYPE_FUNC);
386 # define IsTypeFunc(T) (((T)[0] & T_MASK_TYPE) == T_TYPE_FUNC)
389 #if defined(HAVE_INLINE)
390 INLINE int IsTypeFuncPtr (const type* T)
391 /* Return true if this is a function pointer */
393 return ((T[0] & T_MASK_TYPE) == T_TYPE_PTR && (T[1] & T_MASK_TYPE) == T_TYPE_FUNC);
396 # define IsTypeFuncPtr(T) \
397 ((((T)[0] & T_MASK_TYPE) == T_TYPE_PTR) && (((T)[1] & T_MASK_TYPE) == T_TYPE_FUNC))
400 int IsClassInt (const type* Type) attribute ((const));
401 /* Return true if this is an integer type */
403 int IsClassFloat (const type* Type) attribute ((const));
404 /* Return true if this is a float type */
406 int IsClassPtr (const type* Type) attribute ((const));
407 /* Return true if this is a pointer type */
409 int IsClassStruct (const type* Type) attribute ((const));
410 /* Return true if this is a struct type */
412 int IsSignUnsigned (const type* Type) attribute ((const));
413 /* Return true if this is an unsigned type */
415 int IsQualConst (const type* T) attribute ((const));
416 /* Return true if the given type has a const memory image */
418 int IsQualVolatile (const type* T) attribute ((const));
419 /* Return true if the given type has a volatile type qualifier */
421 int IsFastCallFunc (const type* T) attribute ((const));
422 /* Return true if this is a function type or pointer to function with
423 * __fastcall__ calling conventions
426 int IsVariadicFunc (const type* T) attribute ((const));
427 /* Return true if this is a function type or pointer to function type with
428 * variable parameter list
431 #if defined(HAVE_INLINE)
432 INLINE type GetType (const type* T)
433 /* Get the raw type */
435 return (T[0] & T_MASK_TYPE);
438 # define GetType(T) ((T)[0] & T_MASK_TYPE)
441 #if defined(HAVE_INLINE)
442 INLINE type GetClass (const type* T)
443 /* Get the class of a type string */
445 return (T[0] & T_MASK_CLASS);
448 # define GetClass(T) ((T)[0] & T_MASK_CLASS)
451 #if defined(HAVE_INLINE)
452 INLINE type GetSignedness (const type* T)
453 /* Get the sign of a type */
455 return (T[0] & T_MASK_SIGN);
458 # define GetSignedness(T) ((T)[0] & T_MASK_SIGN)
461 #if defined(HAVE_INLINE)
462 INLINE type GetSizeModifier (const type* T)
463 /* Get the size modifier of a type */
465 return (T[0] & T_MASK_SIZE);
468 # define GetSizeModifier(T) ((T)[0] & T_MASK_SIZE)
471 type GetQualifier (const type* T) attribute ((const));
472 /* Get the qualifier from the given type string */
474 FuncDesc* GetFuncDesc (const type* T) attribute ((const));
475 /* Get the FuncDesc pointer from a function or pointer-to-function type */
477 type* GetFuncReturn (type* T) attribute ((const));
478 /* Return a pointer to the return type of a function or pointer-to-function type */
480 long GetElementCount (const type* T);
481 /* Get the element count of the array specified in T (which must be of
487 /* End of datatype.h */