type.h 24.4 KB
Newer Older
Michael Beck's avatar
Michael Beck committed
1
2
3
4
/*
 * (C) 2001 by Universitaet Karlsruhe
 */

Sebastian Felis's avatar
Sebastian Felis committed
5
/**
6
 *
Michael Beck's avatar
Michael Beck committed
7
8
9
10
11
 *  @file type.h
 *
 *  Datastructure to hold type information.
 *
 *  @author Goetz Lindenmaier
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 *
 *  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
28
 * @see  tpop.h
29
 */
Boris Boesler's avatar
Boris Boesler committed
30
31
32

/* $Id$ */

Christian Schäfer's avatar
Christian Schäfer committed
33
34
35
# ifndef _TYPE_H_
# define _TYPE_H_

36
# include "tpop.h"
37
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
38
39
# include "ident.h"
# include "irmode.h"
40
# include <stdbool.h>
41
# include "dbginfo.h"
Christian Schäfer's avatar
Christian Schäfer committed
42

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

44
/* to resolve recursion between entity.h and type.h */
Christian Schäfer's avatar
Christian Schäfer committed
45
46
47
48
#ifndef _ENTITY_TYPEDEF_
#define _ENTITY_TYPEDEF_
typedef struct entity entity;
#endif
Christian Schäfer's avatar
Christian Schäfer committed
49

50
51
52
53
54
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif

Sebastian Felis's avatar
Sebastian Felis committed
55
/**
Michael Beck's avatar
Michael Beck committed
56
 *  An abstract data type to represent types.
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 *
 *  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.
 *
Michael Beck's avatar
Michael Beck committed
72
 *  The common fields are:
73
 *
Michael Beck's avatar
Michael Beck committed
74
 *  - firm_kind    A firm_kind tag containing k_type.  This is useful
75
 *               for dynamically checking whether a node is a type node.
Michael Beck's avatar
Michael Beck committed
76
77
 *  - type_op      A tp_op specifying the kind of the type.
 *  - mode         The mode to be used to represent the type on a machine.
78
 *               @@@ maybe not global field??
Michael Beck's avatar
Michael Beck committed
79
 *  - name         An identifier specifying the name of the type.  To be
80
 *               set by the frontend.
Michael Beck's avatar
Michael Beck committed
81
 *  - size         The size of the type, i.e. an entity of this type will
82
83
84
 *               occupy size bytes in memory.  In several cases this is
 *               determined when fixing the layout of this type (class,
 *               struct, union, array, enumeration).
Michael Beck's avatar
Michael Beck committed
85
 *  - state        The state of the type.  The state represents whether the
Götz Lindenmaier's avatar
Götz Lindenmaier committed
86
87
88
89
90
91
92
93
 *               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.
Michael Beck's avatar
Michael Beck committed
94
95
 *  - visit        A counter for walks of the type information.
 *  - link         A void* to associate some additional information with the type.
96
 *
Michael Beck's avatar
Michael Beck committed
97
 *  These fields can only be accessed via access functions.
98
 *
Michael Beck's avatar
Michael Beck committed
99
100
 *  Depending on the value of type_op, i.e., depending on the kind of the
 *  type the adt contains further attributes.  These are documented below.
Sebastian Felis's avatar
Sebastian Felis committed
101
 * @see  class, struct, method, union, array, enumeration, pointer, primitive
102
 */
103
104
#ifndef _TYPE_TYPEDEF_
#define _TYPE_TYPEDEF_
105
typedef struct type type;
106
#endif
107

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
108
109
# include "type_or_entity.h"

Michael Beck's avatar
Michael Beck committed
110
/** Frees the memory used by the type.   Does not free the entities
111
112
113
   belonging to the type, except for the array element entity.  */
void        free_type(type *tp);

114
115
116
117
118
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);

119
120
ident*      get_type_ident(type *tp);
void        set_type_ident(type *tp, ident* id);
121
122
const char* get_type_name(type *tp);

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

140
141
142
143
144
145
146
147
148
149
150
/* 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);


151
unsigned long get_type_visited(type *tp);
152
void          set_type_visited(type *tp, unsigned long num);
153
/* Sets visited field in type to type_visited. */
154
void          mark_type_visited(type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
155
156
/* @@@ name clash!! bool          type_visited(type *tp); */
bool          type_not_visited(type *tp);
157

158
159
void*         get_type_link(type *tp);
void          set_type_link(type *tp, void *l);
160

Sebastian Felis's avatar
Sebastian Felis committed
161
/**
162
 *
Sebastian Felis's avatar
Sebastian Felis committed
163
 *   visited flag to traverse the type information
164
165
166
167
168
 *   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
169
 * @see  typewalk
170
 */
Christian Schäfer's avatar
Christian Schäfer committed
171
extern unsigned long type_visited;
172
void          set_master_type_visited(unsigned long val);
173
174
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
175
176
177
178

/**
 *
 *   Checks whether a pointer points to a type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
179
180
181
182
183
 *
 *   @param thing     an arbitrary pointer
 *
 *   @return
 *       true if the thing is a type, else false
Sebastian Felis's avatar
Sebastian Felis committed
184
 *
185
186
 */
int is_type            (void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
187

Sebastian Felis's avatar
Sebastian Felis committed
188
189
/**
 *   Checks whether two types are structural equal.
Michael Beck's avatar
Michael Beck committed
190
191
192
193
194
195
196
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if the types are equal, else false.
 *    Types are equal if
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 *    - 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.)
 */
bool equal_type(type *tpy1, type *typ2);

Sebastian Felis's avatar
Sebastian Felis committed
225
226
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
227
228
229
230
231
232
233
234
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if type st is smaller than type lt, i.e. whenever
 *    lt is expected a st can be used.
 *    This is true if
235
236
237
238
239
240
241
242
243
244
245
 *    - 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
246
 *      @return counterpart in lt and the type is smaller
247
248
249
250
251
 *    - 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
252
 *      @return or
253
254
255
256
 *      - 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
257
258
 *      @return smaller than the points_to type of lt.
 *
259
260
261
 */
bool smaller_type (type *st, type *lt);

Sebastian Felis's avatar
Sebastian Felis committed
262
/**
263
264
265
266
267
 *  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
268
269
 *  @param The following attributes are private to this type kind.
 *  @param member     All entities belonging to this class.  This are methode entities
270
271
272
273
 *             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
274
 *  @param subtypes   A list of direct subclasses.
275
 *
Sebastian Felis's avatar
Sebastian Felis committed
276
 *  @param supertypes A list of direct superclasses.
277
 *
Sebastian Felis's avatar
Sebastian Felis committed
278
279
 *  @param These are dynamic lists that can be grown with an "add_" function,
 *  @param but not shrinked.
280
 *
Sebastian Felis's avatar
Sebastian Felis committed
281
 *  @param peculiarity The peculiarity of this class.  If the class is of peculiarity
282
283
 *             "description" it only is a description of requirememts to a class,
 *             as, e.g., a Java interface.  The class will never be allocated.
284
285
286
287
288
 *             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.
289
 *
290
291
292
 */
/* create a new class type */
type   *new_type_class (ident *name);
293
type   *new_d_type_class (ident *name, dbg_info *db);
294

295
296
/** manipulate private fields of class type  **/
/* Adds the entity as member of the class.  */
297
void    add_class_member   (type *clss, entity *member);
298
/* Returns the number of members of this class. */
299
int     get_class_n_members (type *clss);
300
/* Returns the member at position pos, 0 <= pos < n_member */
301
entity *get_class_member   (type *clss, int pos);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
302
303
/** Returns index of mem in clss, -1 if not contained. */
int     get_class_member_index(type *clss, entity *mem);
304
305
/* Overwrites the member at position pos, 0 <= pos < n_member with
   the passed entity. */
306
void    set_class_member   (type *clss, entity *member, int pos);
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
307
308
309
310
/* 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. */
311
void    set_class_members  (type *clss, entity *members[], int arity);
312
313
314
/* Finds member in the list of members and removes it.
   Shrinks the member list, so iterate from the end!!!
   Does not deallocate the entity.  */
315
void    remove_class_member(type *clss, entity *member);
316

317

Götz Lindenmaier's avatar
Götz Lindenmaier committed
318
319
320
/* Adds subtype as subtype to clss.
   Checks whether clss is a supertype of subtype.  If not
   adds also clss as supertype to subtype.  */
321
void    add_class_subtype   (type *clss, type *subtype);
322
/* Returns the number of subtypes */
323
int     get_class_n_subtypes (type *clss);
324
/* Gets the subtype at position pos, 0 <= pos < n_subtype. */
325
type   *get_class_subtype   (type *clss, int pos);
326
327
328
/* 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! */
329
void    set_class_subtype   (type *clss, type *subtype, int pos);
330
/* Finds subtype in the list of subtypes and removes it  */
331
332
void    remove_class_subtype(type *clss, type *subtype);

333

Götz Lindenmaier's avatar
Götz Lindenmaier committed
334
335
336
/* Adds supertype as supertype to class.
   Checks whether clss is a subtype of supertype.  If not
   adds also clss as subtype to supertype.  */
337
void    add_class_supertype   (type *clss, type *supertype);
338
/* Returns the number of supertypes */
339
int     get_class_n_supertypes (type *clss);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
340
int     get_class_supertype_index(type *clss, type *super_clss);
341
/* Gets the supertype at position pos,  0 <= pos < n_supertype. */
342
type   *get_class_supertype   (type *clss, int pos);
343
344
345
/* 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! */
346
void    set_class_supertype   (type *clss, type *supertype, int pos);
347
/* Finds supertype in the list of supertypes and removes it */
348
void    remove_class_supertype(type *clss, type *supertype);
349

Michael Beck's avatar
Michael Beck committed
350
/** This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
351
typedef enum peculiarity {
Michael Beck's avatar
Michael Beck committed
352
  description,     /**< Represents only a description.  The entity/type is never
353
	  	      allocated, no code/data exists for this entity/type. */
Michael Beck's avatar
Michael Beck committed
354
  inherited,       /**< Describes explicitly that other entities are
355
356
357
358
359
 		      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. */
Michael Beck's avatar
Michael Beck committed
360
  existent         /**< The entity/type (can) exist. */
361
362
363
364
} peculiarity;

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

368
/* Set and get a class' dfn --
Michael Beck's avatar
Michael Beck committed
369
   @todo This is an undocumented field, subject to change! */
370
371
void set_class_dfn (type *clss, int dfn);
int  get_class_dfn (type *clss);
372

373
/* typecheck */
374
375
376
bool is_class_type(type *clss);
/* Returns true if low is subclass of high. */
bool is_subclass_of(type *low, type *high);
377

Sebastian Felis's avatar
Sebastian Felis committed
378
/**
379
380
381
 *  Representation of a struct type.
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
Sebastian Felis's avatar
Sebastian Felis committed
382
 *  @param member   All entities belonging to this class.  This are the fields
383
384
385
386
387
 *           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.
388
389
 *           This is a dynamic list that can be grown with an "add_" function,
 *           but not shrinked.
390
391
392
 */
/* create a new type struct */
type   *new_type_struct (ident *name);
393
type   *new_d_type_struct (ident *name, dbg_info* db);
394
395
396

/* manipulate private fields of struct */
void    add_struct_member   (type *strct, entity *member);
397
int     get_struct_n_members (type *strct);
398
399
entity *get_struct_member   (type *strct, int pos);
void    set_struct_member   (type *strct, int pos, entity *member);
400
/* Finds member in the list of memberss and removees it */
401
void    remove_struct_member (type *strct, entity *member);
402
403
404
405

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

Sebastian Felis's avatar
Sebastian Felis committed
406
/**
407
408
409
410
411
412
413
 *  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
414
 *  @param n_params    Number of parameters to the procedure.
415
416
 *              A procedure in FIRM has only call by value parameters.
 *
Sebastian Felis's avatar
Sebastian Felis committed
417
 *  @param param_type  A list with the types of parameters.  This list is ordered.
418
419
420
421
 *              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
422
 *  @param n_res       The number of results of the method.  In general, procedures
423
424
 *              have zero results, functions one.
 *
Sebastian Felis's avatar
Sebastian Felis committed
425
 *  @param res_type    A list with the types of parameters.  This list is ordered.
426
427
428
429
 *              The nth type in this list corresponds to the nth input to
 *  	        Return nodes.  (See ircons.h for more information.)
 */

Michael Beck's avatar
Michael Beck committed
430
431
432
433
434
/** Create a new method type.
 *
   @param n_param   the number of parameters
   @param n_res     the number of results

435
436
437
   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);
438
type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
439

Michael Beck's avatar
Michael Beck committed
440
/** manipulate private fields of method. */
441
442
int   get_method_n_params  (type *method);
type *get_method_param_type(type *method, int pos);
443
void  set_method_param_type(type *method, int pos, type* tp);
444

445
int   get_method_n_ress   (type *method);
446
type *get_method_res_type(type *method, int pos);
447
void  set_method_res_type(type *method, int pos, type* tp);
448

Michael Beck's avatar
Michael Beck committed
449
/**
450
451
452
453
454
455
456
457
458
459
460
461
 * 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);

462
463
464
/* typecheck */
bool  is_method_type     (type *method);

Sebastian Felis's avatar
Sebastian Felis committed
465
/**
466
467
 *   Representation of a union type.
 *   The union type represents union types.
Sebastian Felis's avatar
Sebastian Felis committed
468
469
 *   @param n_types        Number of unioned types.
 *   @param members        Entities for unioned types.  Fixed length array.
470
471
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
472
 */
473
/* create a new type union  */
474
type   *new_type_union (ident *name);
475
type   *new_d_type_union (ident *name, dbg_info* db);
476
477

/* manipulate private fields of struct */
478
479
480
481
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);
482
/* Finds member in the list of members and removes it. */
483
void    remove_union_member (type *uni, entity *member);
484

485
486
487
/* typecheck */
bool    is_union_type          (type *uni);

Sebastian Felis's avatar
Sebastian Felis committed
488
/**
489
490
 *   Representation of an array type.
 *   The array type represents rectangular multi dimensional arrays.
491
492
 *   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
493
494
495
496
497
 *   @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
498
 *                    element selection with Sel.
Michael Beck's avatar
Michael Beck committed
499
500
501
 *   @todo
 *   Do we need several entities?  One might want
 *   to select a dimension and not a single element in case of multidim arrays.
502
 */
503
/* create a new type array --
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
504
505
   Sets n_dimension to dimension and all dimension entries to NULL.
   Initializes order to the order of the dimensions.
506
   The entity for array elements is built automatically.
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
507
   Set dimension sizes after call to constructor with set_* routines. */
508
type *new_type_array         (ident *name, int n_dimensions,
509
			      type *element_type);
510
511
type *new_d_type_array         (ident *name, int n_dimensions,
			      type *element_type, dbg_info* db);
512
513
514

/* manipulate private fields of array type */
int   get_array_n_dimensions (type *array);
515
516
517
/* 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);
518
519
520
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);
521
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
522
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
523
void  set_array_upper_bound_int (type *array, int dimension, int lower_bound);
524
525
ir_node * get_array_lower_bound  (type *array, int dimension);
ir_node * get_array_upper_bound  (type *array, int dimension);
526

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
527
528
529
void set_array_order (type *array, int dimension, int order);
int  get_array_order (type *array, int dimension);

530
void  set_array_element_type (type *array, type *tp);
531
532
type *get_array_element_type (type *array);

533
534
535
void  set_array_element_entity (type *array, entity *ent);
entity *get_array_element_entity (type *array);

536
537
538
/* typecheck */
bool   is_array_type         (type *array);

Sebastian Felis's avatar
Sebastian Felis committed
539
/**
540
541
542
543
 *  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
544
 *   @param *enum           The target values representing the constants used to
545
 *                   represent individual enumerations.
Sebastian Felis's avatar
Sebastian Felis committed
546
 *   @param *enum_nameid    Idents containing the source program name of the enumeration
547
548
 *  		     constants
 *
Christian Schäfer's avatar
Christian Schäfer committed
549
550
*/
/* create a new type enumeration -- set the enumerators independently */
551
type   *new_type_enumeration    (ident *name, int n_enums);
552
type   *new_d_type_enumeration    (ident *name, int n_enums, dbg_info* db);
553
554
555
556
557
558
559
560
561
562
563
564
565
566

/* 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
567
/**
568
569
 *   Representation of a pointer type.
 *   Pointer types.
Sebastian Felis's avatar
Sebastian Felis committed
570
 *   @param points_to       The type of the entity this pointer points to.
571
572
573
 */
/* Create a new type pointer */
type *new_type_pointer           (ident *name, type *points_to);
574
type *new_d_type_pointer           (ident *name, type *points_to, dbg_info* db);
Christian Schäfer's avatar
Christian Schäfer committed
575
576

/* manipulate fields of type_pointer */
577
void  set_pointer_points_to_type (type *pointer, type *tp);
578
579
580
581
582
type *get_pointer_points_to_type (type *pointer);

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

Sebastian Felis's avatar
Sebastian Felis committed
583
/**
584
585
586
587
 *   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
588
589
*/
/* create a new type primitive */
590
type *new_type_primitive (ident *name, ir_mode *mode);
591
type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
Christian Schäfer's avatar
Christian Schäfer committed
592

593
594
/* typecheck */
bool  is_primitive_type  (type *primitive);
Christian Schäfer's avatar
Christian Schäfer committed
595

596
597


Sebastian Felis's avatar
Sebastian Felis committed
598
599
600
601
/**
 *   Checks whether a type is atomic.
 *   @param tp - any type
 *   @return true if type is primitive, pointer or enumeration
602
603
604
 */
int is_atomic_type(type *tp);

Sebastian Felis's avatar
Sebastian Felis committed
605
606
607
608
/**
 *   Checks whether a type is compound.
 *   @param tp - any type
 *   @return true if the type is class, structure, union or array type.
609
610
611
 */
int is_compound_type(type *tp);

612
613
614
615
616

/** Outputs a unique number for this node if libfirm is compiled for
   debugging, (configure with --enable-debug) else returns 0. */
INLINE long get_type_nr(type *tp);

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