type.h 23.9 KB
Newer Older
Sebastian Felis's avatar
Sebastian Felis committed
1
/**
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 *   file type.h - datastructure to hold type information.
 *  (C) 2001 by Universitaet Karlsruhe
 *  Goetz Lindenmaier
 *
 *  This module supplies a datastructure to represent all types
 *  known in the compiled program.  This includes types specified
 *  in the program as well as types defined by the language.  In the
 *  view of the intermediate representation there is no difference
 *  between these types.
 *
 *  There exist several kinds of types, arranged by the structure of
 *  the type.  A type is described by a set of attributes.  Some of
 *  these attributes are common to all types, others depend on the
 *  kind of the type.
 *
 *  Types are different from the modes defined in irmode:  Types are
 *  on the level of the programming language, modes at the level of
 *  the target processor.
 *
Sebastian Felis's avatar
Sebastian Felis committed
22
 * @see  tpop.h
23
 */
Boris Boesler's avatar
Boris Boesler committed
24
25
26

/* $Id$ */

Christian Schäfer's avatar
Christian Schäfer committed
27
28
29
# ifndef _TYPE_H_
# define _TYPE_H_

30
# include "tpop.h"
31
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
32
33
# include "ident.h"
# include "irmode.h"
34
# include <stdbool.h>
35
# include "dbginfo.h"
Christian Schäfer's avatar
Christian Schäfer committed
36

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
37

38
/* to resolve recursion between entity.h and type.h */
Christian Schäfer's avatar
Christian Schäfer committed
39
40
41
42
#ifndef _ENTITY_TYPEDEF_
#define _ENTITY_TYPEDEF_
typedef struct entity entity;
#endif
Christian Schäfer's avatar
Christian Schäfer committed
43

44
45
46
47
48
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif

Sebastian Felis's avatar
Sebastian Felis committed
49
/**
50
 *
Sebastian Felis's avatar
Sebastian Felis committed
51
 *   An abstract data type to represent types.
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 *  This is the abstract data type with which any type known in the
 *  compiled program can be represented.  This includes types specified
 *  in the program as well as types defined by the language.  In the
 *  view of the intermediate representation there is no difference
 *  between these types.
 *
 *  There exist several kinds of types, arranged by the structure of
 *  the type.  These are distinguished by a type opcode.
 *  A type is described by a set of attributes.  Some of these attributes
 *  are common to all types, others depend on the kind of the type.
 *
 *  The following describes the common attributes.  They can only be
 *  accessed by the functions given below.
 *
Sebastian Felis's avatar
Sebastian Felis committed
66
 *  @param The common fields are:
67
 *
Sebastian Felis's avatar
Sebastian Felis committed
68
 *  @param firm_kind    A firm_kind tag containing k_type.  This is useful
69
 *               for dynamically checking whether a node is a type node.
Sebastian Felis's avatar
Sebastian Felis committed
70
71
 *  @param type_op      A tp_op specifying the kind of the type.
 *  @param mode         The mode to be used to represent the type on a machine.
72
 *               @@@ maybe not global field??
Sebastian Felis's avatar
Sebastian Felis committed
73
 *  @param name         An identifier specifying the name of the type.  To be
74
 *               set by the frontend.
Sebastian Felis's avatar
Sebastian Felis committed
75
 *  @param size         The size of the type, i.e. an entity of this type will
76
77
78
 *               occupy size bytes in memory.  In several cases this is
 *               determined when fixing the layout of this type (class,
 *               struct, union, array, enumeration).
Sebastian Felis's avatar
Sebastian Felis committed
79
 *  @param state        The state of the type.  The state represents whether the
Götz Lindenmaier's avatar
Götz Lindenmaier committed
80
81
82
83
84
85
86
87
 *               layout of the type is undefined or fixed (values: layout_undefined
 *               or layout_fixed).  Compound types can have an undefined
 *               layout.  The layout of the basic types primitive and pointer
 *               is always layout_fixed.  If the layout of
 *               compound types is fixed all entities must have an offset
 *               and the size of the type must be set.
 *               A fixed layout for enumeration types means that each enumeration
 *               is associated with an implementation value.
Sebastian Felis's avatar
Sebastian Felis committed
88
89
 *  @param visit        A counter for walks of the type information.
 *  @param link         A void* to associate some additional information with the type.
90
 *
Sebastian Felis's avatar
Sebastian Felis committed
91
 *  @param These fields can only be accessed via access functions.
92
 *
Sebastian Felis's avatar
Sebastian Felis committed
93
94
95
 *  @param Depending on the value of type_op, i.e., depending on the kind of the
 *  @param type the adt contains further attributes.  These are documented below.
 * @see  class, struct, method, union, array, enumeration, pointer, primitive
96
 */
97
98
#ifndef _TYPE_TYPEDEF_
#define _TYPE_TYPEDEF_
99
typedef struct type type;
100
#endif
101

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
102
103
# include "type_or_entity.h"

104
105
106
107
/* Frees the memory used by the type.   Does not free the entities
   belonging to the type, except for the array element entity.  */
void        free_type(type *tp);

108
109
110
111
112
tp_op*      get_type_tpop(type *tp);
ident*      get_type_tpop_nameid(type *tp);
const char* get_type_tpop_name(type *tp);
tp_opcode   get_type_tpop_code(type *tp);

113
114
ident*      get_type_ident(type *tp);
void        set_type_ident(type *tp, ident* id);
115
116
const char* get_type_name(type *tp);

117
118
119
typedef enum {
  layout_undefined,    /* The layout of this type is not defined.
			  Address computation to access fields is not
120
121
122
			  possible, fields must be accessed by Sel
			  nodes.  This is the default value except for
			  pointer, primitive and method types. */
123
124
125
  layout_fixed         /* The layout is fixed, all component/member entities
			  have an offset assigned.  Size of the type is known.
			  Arrays can be accessed by explicit address
126
127
			  computation. Default for pointer, primitive ane method
			  types.  */
128
129
} type_state;
type_state  get_type_state(type *tp);
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
130
/* For primitives, pointer and method types the layout is always fixed.
131
132
133
   This call is legal but has no effect. */
void        set_type_state(type *tp, type_state state);

134
135
136
137
138
139
140
141
142
143
144
/* Returns NULL for all non atomic types. */
ir_mode*    get_type_mode(type *tp);
/* Only has an effect on primitive and enumeration types */
void        set_type_mode(type *tp, ir_mode* m);

int         get_type_size(type *tp);
/* For primitive, enumeration, pointer and method types the size
   is always fixed. This call is legal but has no effect. */
void        set_type_size(type *tp, int size);


145
unsigned long get_type_visited(type *tp);
146
void          set_type_visited(type *tp, unsigned long num);
147
/* Sets visited field in type to type_visited. */
148
void          mark_type_visited(type *tp);
149

150
151
void*         get_type_link(type *tp);
void          set_type_link(type *tp, void *l);
152

Sebastian Felis's avatar
Sebastian Felis committed
153
/**
154
 *
Sebastian Felis's avatar
Sebastian Felis committed
155
 *   visited flag to traverse the type information
156
157
158
159
160
 *   Increase this flag by one before traversing the type information.
 *   Mark type nodes as visited by set_type_visited(type, type_visited).
 *   Check whether node was already visited by comparing get_type_visited(type)
 *   and type_visited.
 *   Or use the function to walk all types.
Sebastian Felis's avatar
Sebastian Felis committed
161
 * @see  typewalk
162
 */
Christian Schäfer's avatar
Christian Schäfer committed
163
extern unsigned long type_visited;
164
void          set_master_type_visited(unsigned long val);
165
unsigned long get_master_type_visited();
166
void          inc_master_type_visited();
Sebastian Felis's avatar
Sebastian Felis committed
167
168
169
170
171
172
173

/**
 *
 *   Checks whether a pointer points to a type.
 *   @param thing - a pointer
 *   @return true if the thing is a type, else false
 *
174
175
 */
int is_type            (void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
176

Sebastian Felis's avatar
Sebastian Felis committed
177
178
179
180
181
182
/**
 *
 *   Checks whether two types are structural equal.
 *   @param two pointer types
 *   @return true if the types are equal, else false.
 *   @return Types are equal if
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 *    - they are the same type kind
 *    - they have the same name
 *    - they have the same mode (if applicable)
 *    - they have the same type_state and, ev., the same size
 *    - they are class types and have
 *      - the same members (see same_entity in entity.h)
 *      - the same supertypes -- the C-pointers are compared --> no recursive call.
 *      - the same number of subtypes.  Subtypes are not compared,
 *        as this could cause a cyclic test.
 *      - the same peculiarity
 *    - they are structure types and have the same members
 *    - they are method types and have
 *      - the same parameter types
 *      - the same result types
 *    - they are union types and have the same members
 *    - they are array types and have
 *      - the same number of dimensions
 *      - the same dimension bounds
 *      - the same dimension order
 *      - the same element type
 *    - they are enumeration types and have the same enumerator names
 *    - they are pointer types and have the identical points_to type
 *      (i.e., the same C-struct to represent the type, type_id is skipped.
 *       This is to avoid endless recursions; with pointer types circlic
 *       type graphs are possible.)
 *
Sebastian Felis's avatar
Sebastian Felis committed
209
 *
210
211
212
 */
bool equal_type(type *tpy1, type *typ2);

Sebastian Felis's avatar
Sebastian Felis committed
213
214
215
216
217
218
219
/**
 *
 *   Checks whether two types are structural comparable.
 *   @param two pointer type
 *   @return true if type st is smaller than type lt, i.e. whenever
 *   @return lt is expected a st can be used.
 *   @return This is true if
220
221
222
223
224
225
226
227
228
229
230
 *    - they are the same type kind
 *    - mode(st) < mode (lt)  (if applicable)
 *    - they are class types and st is (transitive) subtype of lt,
 *    - they are structure types and
 *       - the members of st have exactly one counterpart in lt with the same name,
 *       - the counterpart has a bigger type.
 *    - they are method types and have
 *      - the same number of parameter and result types,
 *      - the parameter types of st are smaller than those of lt,
 *      - the result types of st are smaller than those of lt
 *    - they are union types and have the members of st have exactly one
Sebastian Felis's avatar
Sebastian Felis committed
231
 *      @return counterpart in lt and the type is smaller
232
233
234
235
236
 *    - they are array types and have
 *      - the same number of dimensions
 *      - all bounds of lt are bound of st
 *      - the same dimension order
 *      - the same element type
Sebastian Felis's avatar
Sebastian Felis committed
237
 *      @return or
238
239
240
241
 *      - the element type of st is smaller than that of lt
 *      - the element types have the same size and fixed layout.
 *    - they are enumeration types and have the same enumerator names
 *    - they are pointer types and have the points_to type of st is
Sebastian Felis's avatar
Sebastian Felis committed
242
243
 *      @return smaller than the points_to type of lt.
 *
244
245
246
 */
bool smaller_type (type *st, type *lt);

Sebastian Felis's avatar
Sebastian Felis committed
247
/**
248
249
250
251
252
 *  Representation of a class type.
 *  If the type opcode is set to type_class the type represents class
 *  types.  A list of fields and methods is associated with a class.
 *  Further a class can inherit from and bequest to other classes.
 *  @@@ value class???
Sebastian Felis's avatar
Sebastian Felis committed
253
254
 *  @param The following attributes are private to this type kind.
 *  @param member     All entities belonging to this class.  This are methode entities
255
256
257
258
 *             which have type_method or fields that can have any of the
 *             following type kinds: type_class, type_struct, type_union,
 *             type_array, type_enumeration, type_pointer, type_primitive.
 *
Sebastian Felis's avatar
Sebastian Felis committed
259
 *  @param subtypes   A list of direct subclasses.
260
 *
Sebastian Felis's avatar
Sebastian Felis committed
261
 *  @param supertypes A list of direct superclasses.
262
 *
Sebastian Felis's avatar
Sebastian Felis committed
263
264
 *  @param These are dynamic lists that can be grown with an "add_" function,
 *  @param but not shrinked.
265
 *
Sebastian Felis's avatar
Sebastian Felis committed
266
 *  @param peculiarity The peculiarity of this class.  If the class is of peculiarity
267
268
 *             "description" it only is a description of requirememts to a class,
 *             as, e.g., a Java interface.  The class will never be allocated.
269
270
271
272
273
 *             Peculiatity inherited is only possible for entities.  An entity
 *             is of peculiarity inherited if the compiler generated the entity
 *             to explicitly resolve inheritance.  An inherited method entity has
 *             no value for irg.
 *             Values: description, existent, inherited.  Default: existent.
274
 *
275
276
277
 */
/* create a new class type */
type   *new_type_class (ident *name);
278
type   *new_d_type_class (ident *name, dbg_info *db);
279

280
281
/** manipulate private fields of class type  **/
/* Adds the entity as member of the class.  */
282
void    add_class_member   (type *clss, entity *member);
283
/* Returns the number of members of this class. */
284
int     get_class_n_members (type *clss);
285
/* Returns the member at position pos, 0 <= pos < n_member */
286
entity *get_class_member   (type *clss, int pos);
287
288
/* Overwrites the member at position pos, 0 <= pos < n_member with
   the passed entity. */
289
void    set_class_member   (type *clss, entity *member, int pos);
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
290
291
292
293
/* Replaces complete member list in class type by the list passed.  Copies the
   list passed. This function is necessary to reduce the number of members.
   members is an array of entities, num the size of this array.  Sets all
   owners of the members passed to clss. */
294
void    set_class_members  (type *clss, entity *members[], int arity);
295
296
297
/* Finds member in the list of members and removes it.
   Shrinks the member list, so iterate from the end!!!
   Does not deallocate the entity.  */
298
void    remove_class_member(type *clss, entity *member);
299

300

Götz Lindenmaier's avatar
Götz Lindenmaier committed
301
302
303
/* Adds subtype as subtype to clss.
   Checks whether clss is a supertype of subtype.  If not
   adds also clss as supertype to subtype.  */
304
void    add_class_subtype   (type *clss, type *subtype);
305
/* Returns the number of subtypes */
306
int     get_class_n_subtypes (type *clss);
307
/* Gets the subtype at position pos, 0 <= pos < n_subtype. */
308
type   *get_class_subtype   (type *clss, int pos);
309
310
311
/* Sets the subtype at positioin pos, 0 <= pos < n_subtype.  Does not
   set the corresponding supertype relation for subtype: this might
   be a different position! */
312
void    set_class_subtype   (type *clss, type *subtype, int pos);
313
/* Finds subtype in the list of subtypes and removes it  */
314
315
void    remove_class_subtype(type *clss, type *subtype);

316

Götz Lindenmaier's avatar
Götz Lindenmaier committed
317
318
319
/* Adds supertype as supertype to class.
   Checks whether clss is a subtype of supertype.  If not
   adds also clss as subtype to supertype.  */
320
void    add_class_supertype   (type *clss, type *supertype);
321
/* Returns the number of supertypes */
322
int     get_class_n_supertypes (type *clss);
323
/* Gets the supertype at position pos,  0 <= pos < n_supertype. */
324
type   *get_class_supertype   (type *clss, int pos);
325
326
327
/* Sets the supertype at postition pos, 0 <= pos < n_subtype.  Does not
   set the corresponding subtype relation for supertype: this might
   be a different position! */
328
void    set_class_supertype   (type *clss, type *supertype, int pos);
329
/* Finds supertype in the list of supertypes and removes it */
330
void    remove_class_supertype(type *clss, type *supertype);
331

332
/* This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
333
typedef enum peculiarity {
334
335
  description,     /* Represents only a description.  The entity/type is never
	  	      allocated, no code/data exists for this entity/type. */
336
337
338
339
340
341
  inherited,       /* Describes explicitly that other entities are
 		      inherited to the owner of this entity.
 		      Overwrites must refer to at least one other
 		      entity.  If this is a method entity there exists
 		      no irg for this entity, only for one of the
 		      overwritten ones. */
342
343
344
345
346
  existent         /* The entity/type (can) exist. */
} peculiarity;

/* The peculiarity of the class.  The enumeration peculiarity is defined
   in entity.h */
347
348
INLINE peculiarity get_class_peculiarity (type *clss);
INLINE void        set_class_peculiarity (type *clss, peculiarity pec);
349

350
351
/* Set and get a class' dfn --
   @@@ This is an undocumented field, subject to change! */
352
353
void set_class_dfn (type *clss, int dfn);
int  get_class_dfn (type *clss);
354

355
/* typecheck */
356
357
358
bool is_class_type(type *clss);
/* Returns true if low is subclass of high. */
bool is_subclass_of(type *low, type *high);
359

Sebastian Felis's avatar
Sebastian Felis committed
360
/**
361
362
363
 *  Representation of a struct type.
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
Sebastian Felis's avatar
Sebastian Felis committed
364
 *  @param member   All entities belonging to this class.  This are the fields
365
366
367
368
369
 *           that can have any of the following types:  type_class,
 *           type_struct, type_union, type_array, type_enumeration,
 *  	     type_pointer, type_primitive.
 *           This is a dynamic list that can be grown with an "add_" function,
 *           but not shrinked.
370
371
 *           This is a dynamic list that can be grown with an "add_" function,
 *           but not shrinked.
372
373
374
 */
/* create a new type struct */
type   *new_type_struct (ident *name);
375
type   *new_d_type_struct (ident *name, dbg_info* db);
376
377
378

/* manipulate private fields of struct */
void    add_struct_member   (type *strct, entity *member);
379
int     get_struct_n_members (type *strct);
380
381
entity *get_struct_member   (type *strct, int pos);
void    set_struct_member   (type *strct, int pos, entity *member);
382
/* Finds member in the list of memberss and removees it */
383
void    remove_struct_member (type *strct, entity *member);
384
385
386
387

/* typecheck */
bool    is_struct_type(type *strct);

Sebastian Felis's avatar
Sebastian Felis committed
388
/**
389
390
391
392
393
394
395
 *  Representation of a method type.
 *  A method type represents a method, function or procedure type.
 *  It contains a list of the parameter and result types, as these
 *  are part of the type description.  These lists should not
 *  be changed by a optimization, as a change creates a new method
 *  type.  Therefore optimizations should allocated new method types.
 *  The set_ routines are only for construction by a frontend.
Sebastian Felis's avatar
Sebastian Felis committed
396
 *  @param n_params    Number of parameters to the procedure.
397
398
 *              A procedure in FIRM has only call by value parameters.
 *
Sebastian Felis's avatar
Sebastian Felis committed
399
 *  @param param_type  A list with the types of parameters.  This list is ordered.
400
401
402
403
 *              The nth type in this list corresponds to the nth element
 *              in the parameter tuple that is a result of the start node.
 *  	        (See ircons.h for more information.)
 *
Sebastian Felis's avatar
Sebastian Felis committed
404
 *  @param n_res       The number of results of the method.  In general, procedures
405
406
 *              have zero results, functions one.
 *
Sebastian Felis's avatar
Sebastian Felis committed
407
 *  @param res_type    A list with the types of parameters.  This list is ordered.
408
409
410
411
412
413
414
415
416
 *              The nth type in this list corresponds to the nth input to
 *  	        Return nodes.  (See ircons.h for more information.)
 */

/* Create a new method type.
   N_param is the number of parameters, n_res the number of results.
   The arrays for the parameter and result types are not initialized by
   the constructor. */
type *new_type_method (ident *name, int n_param, int n_res);
417
type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
418
419
420
421

/* manipulate private fields of method. */
int   get_method_n_params  (type *method);
type *get_method_param_type(type *method, int pos);
422
void  set_method_param_type(type *method, int pos, type* tp);
423

424
int   get_method_n_ress   (type *method);
425
type *get_method_res_type(type *method, int pos);
426
void  set_method_res_type(type *method, int pos, type* tp);
427

428
429
430
431
432
433
434
435
436
437
438
439
440
/*
 * this enum flags the variadicity of methods (methods with a
 * variable amount of arguments (e.g. C's printf). Default is
 * non_variadic.
 */
typedef enum variadicity {
  non_variadic,
  variadic
} variadicity;

variadicity get_method_variadicity(type *method);
void set_method_variadicity(type *method, variadicity vari);

441
442
443
/* typecheck */
bool  is_method_type     (type *method);

Sebastian Felis's avatar
Sebastian Felis committed
444
/**
445
446
 *   Representation of a union type.
 *   The union type represents union types.
Sebastian Felis's avatar
Sebastian Felis committed
447
448
 *   @param n_types        Number of unioned types.
 *   @param members        Entities for unioned types.  Fixed length array.
449
450
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
451
 */
452
/* create a new type union  */
453
type   *new_type_union (ident *name);
454
type   *new_d_type_union (ident *name, dbg_info* db);
455
456

/* manipulate private fields of struct */
457
458
459
460
int     get_union_n_members      (type *uni);
void    add_union_member (type *uni, entity *member);
entity *get_union_member (type *uni, int pos);
void    set_union_member (type *uni, int pos, entity *member);
461
/* Finds member in the list of members and removes it. */
462
void    remove_union_member (type *uni, entity *member);
463

464
465
466
/* typecheck */
bool    is_union_type          (type *uni);

Sebastian Felis's avatar
Sebastian Felis committed
467
/**
468
469
 *   Representation of an array type.
 *   The array type represents rectangular multi dimensional arrays.
470
471
 *   The constants representing the bounds must be allocated to
 *   get_const_code_irg() by setting current_ir_graph accordingly.
Sebastian Felis's avatar
Sebastian Felis committed
472
473
474
475
476
 *   @param n_dimensions     Number of array dimensions.
 *   @param *lower_bound     Lower bounds of dimensions.  Usually all 0.
 *   @param *upper_bound     Upper bounds or dimensions.
 *   @param *element_type    The type of the array elements.
 *   @param *element_ent     An entity for the array elements to be used for
477
 *                    element selection with Sel.
478
479
480
 *                    @@@ Do we need several entities?  One might want
 *                    to select a dimension and not a single element in
 *                    case of multidim arrays.
481
 */
482
/* create a new type array --
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
483
484
   Sets n_dimension to dimension and all dimension entries to NULL.
   Initializes order to the order of the dimensions.
485
   The entity for array elements is built automatically.
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
486
   Set dimension sizes after call to constructor with set_* routines. */
487
type *new_type_array         (ident *name, int n_dimensions,
488
			      type *element_type);
489
490
type *new_d_type_array         (ident *name, int n_dimensions,
			      type *element_type, dbg_info* db);
491
492
493

/* manipulate private fields of array type */
int   get_array_n_dimensions (type *array);
494
495
496
/* Allocates Const nodes of mode_I for the array dimensions */
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
497
498
499
void  set_array_bounds       (type *array, int dimension, ir_node *lower_bound,
                                                          ir_node *upper_bound);
void  set_array_lower_bound  (type *array, int dimension, ir_node *lower_bound);
500
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
501
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
502
void  set_array_upper_bound_int (type *array, int dimension, int lower_bound);
503
504
ir_node * get_array_lower_bound  (type *array, int dimension);
ir_node * get_array_upper_bound  (type *array, int dimension);
505

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
506
507
508
void set_array_order (type *array, int dimension, int order);
int  get_array_order (type *array, int dimension);

509
void  set_array_element_type (type *array, type *tp);
510
511
type *get_array_element_type (type *array);

512
513
514
void  set_array_element_entity (type *array, entity *ent);
entity *get_array_element_entity (type *array);

515
516
517
/* typecheck */
bool   is_array_type         (type *array);

Sebastian Felis's avatar
Sebastian Felis committed
518
/**
519
520
521
522
 *  Representation of an enumeration type.
 *  Enumeration types need not necessarily be represented explicitly
 *  by Firm types, as the frontend can lower them to integer constants as
 *  well.  For debugging purposes or similar tasks this information is useful.
Sebastian Felis's avatar
Sebastian Felis committed
523
 *   @param *enum           The target values representing the constants used to
524
 *                   represent individual enumerations.
Sebastian Felis's avatar
Sebastian Felis committed
525
 *   @param *enum_nameid    Idents containing the source program name of the enumeration
526
527
 *  		     constants
 *
Christian Schäfer's avatar
Christian Schäfer committed
528
529
*/
/* create a new type enumeration -- set the enumerators independently */
530
type   *new_type_enumeration    (ident *name, int n_enums);
531
type   *new_d_type_enumeration    (ident *name, int n_enums, dbg_info* db);
532
533
534
535
536
537
538
539
540
541
542
543
544
545

/* manipulate fields of enumeration type. */
int     get_enumeration_n_enums (type *enumeration);

void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
tarval *get_enumeration_enum    (type *enumeration, int pos);

void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
ident  *get_enumeration_nameid  (type *enumeration, int pos);
const char *get_enumeration_name(type *enumeration, int pos);

/* typecheck */
bool    is_enumeration_type     (type *enumeration);

Sebastian Felis's avatar
Sebastian Felis committed
546
/**
547
548
 *   Representation of a pointer type.
 *   Pointer types.
Sebastian Felis's avatar
Sebastian Felis committed
549
 *   @param points_to       The type of the entity this pointer points to.
550
551
552
 */
/* Create a new type pointer */
type *new_type_pointer           (ident *name, type *points_to);
553
type *new_d_type_pointer           (ident *name, type *points_to, dbg_info* db);
Christian Schäfer's avatar
Christian Schäfer committed
554
555

/* manipulate fields of type_pointer */
556
void  set_pointer_points_to_type (type *pointer, type *tp);
557
558
559
560
561
type *get_pointer_points_to_type (type *pointer);

/* typecheck */
bool  is_pointer_type            (type *pointer);

Sebastian Felis's avatar
Sebastian Felis committed
562
/**
563
564
565
566
 *   Representation of a primitive type.
 *   Primitive types are types that represent indivisible data values that
 *   map directly to modes.  They don't have a private attribute.  The
 *   important information they carry is held in the common mode field.
Christian Schäfer's avatar
Christian Schäfer committed
567
568
*/
/* create a new type primitive */
569
type *new_type_primitive (ident *name, ir_mode *mode);
570
type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
Christian Schäfer's avatar
Christian Schäfer committed
571

572
573
/* typecheck */
bool  is_primitive_type  (type *primitive);
Christian Schäfer's avatar
Christian Schäfer committed
574

575
576


Sebastian Felis's avatar
Sebastian Felis committed
577
578
579
580
581
/**
 *
 *   Checks whether a type is atomic.
 *   @param tp - any type
 *   @return true if type is primitive, pointer or enumeration
582
583
584
585
 *
 */
int is_atomic_type(type *tp);

Sebastian Felis's avatar
Sebastian Felis committed
586
587
588
589
590
591
/**
 *
 *   Checks whether a type is compound.
 *   @param tp - any type
 *   @return true if the type is class, structure, union or array type.
 *
592
593
594
 */
int is_compound_type(type *tp);

Christian Schäfer's avatar
Christian Schäfer committed
595
# endif /* _TYPE_H_ */