type.h 29.6 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
 *
74
 *  - firm_kind: A firm_kind tag containing k_type.  This is useful
75
 *               for dynamically checking whether a node is a type node.
76
77
78
 *  - type_op:   A tp_op specifying the kind of the type.
 *  - mode:      The mode to be used to represent the type on a machine.
 *  - name:      An identifier specifying the name of the type.  To be
79
 *               set by the frontend.
80
 *  - size:      The size of the type, i.e. an entity of this type will
81
82
83
 *               occupy size bytes in memory.  In several cases this is
 *               determined when fixing the layout of this type (class,
 *               struct, union, array, enumeration).
84
 *  - state:     The state of the type.  The state represents whether the
Götz Lindenmaier's avatar
Götz Lindenmaier committed
85
86
87
88
89
90
91
92
 *               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.
93
94
 *  - visit:     A counter for walks of the type information.
 *  - link:      A void* to associate some additional information with the type.
95
 *
Michael Beck's avatar
Michael Beck committed
96
 *  These fields can only be accessed via access functions.
97
 *
98
 *  Depending on the value of @c type_op, i.e., depending on the kind of the
Michael Beck's avatar
Michael Beck committed
99
 *  type the adt contains further attributes.  These are documented below.
100
101
102
103
104
105
106
107
108
109
 *
 *  @see
 *
 *  @link class_type class @endlink, @link struct_type struct @endlink,
 *  @link method_type method @endlink, @link union_type union @endlink,
 *  @link array_type array @endlink, @link enumeration_type enumeration @endlink,
 *  @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
 *
 *  @todo
 *  	mode maybe not global field??
110
 */
111
112
#ifndef _TYPE_TYPEDEF_
#define _TYPE_TYPEDEF_
113
typedef struct type type;
114
#endif
115

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
116
117
# include "type_or_entity.h"

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

122
123
124
125
126
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);

127
128
ident*      get_type_ident(type *tp);
void        set_type_ident(type *tp, ident* id);
129
130
const char* get_type_name(type *tp);

131
/** The state of a type layout. */
132
typedef enum {
Michael Beck's avatar
Michael Beck committed
133
  layout_undefined,    /**< The layout of this type is not defined.
134
			  Address computation to access fields is not
135
136
137
			  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
138
  layout_fixed         /**< The layout is fixed, all component/member entities
139
140
			  have an offset assigned.  Size of the type is known.
			  Arrays can be accessed by explicit address
141
142
			  computation. Default for pointer, primitive ane method
			  types.  */
143
} type_state;
144
145

/** Returns the type layout state of a type. */
146
type_state  get_type_state(type *tp);
147
148
149
150
151
152

/** Sets the type layout state of a type.
 *
 * For primitives, pointer and method types the layout is always fixed.
 * This call is legal but has no effect.
 */
153
154
void        set_type_state(type *tp, type_state state);

155
156
157
158
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
159
ir_mode*    get_type_mode(type *tp);
160
161
162
163
164

/** Sets the mode of a type.
 *
 * Only has an effect on primitive and enumeration types.
 */
165
166
void        set_type_mode(type *tp, ir_mode* m);

167
/** Returns the size of a type. */
168
int         get_type_size(type *tp);
169
170
171
172
173
174

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


178
unsigned long get_type_visited(type *tp);
179
void          set_type_visited(type *tp, unsigned long num);
180
/* Sets visited field in type to type_visited. */
181
void          mark_type_visited(type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
182
183
/* @@@ name clash!! bool          type_visited(type *tp); */
bool          type_not_visited(type *tp);
184

185
186
void*         get_type_link(type *tp);
void          set_type_link(type *tp, void *l);
187

Sebastian Felis's avatar
Sebastian Felis committed
188
/**
189
190
191
192
193
194
195
 * Visited flag to traverse the type information.
 *
 * 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.
196
 *
Sebastian Felis's avatar
Sebastian Felis committed
197
 * @see  typewalk
198
 */
Christian Schäfer's avatar
Christian Schäfer committed
199
extern unsigned long type_visited;
200
void          set_master_type_visited(unsigned long val);
201
202
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
203
204

/**
205
 * Checks whether a pointer points to a type.
Sebastian Felis's avatar
Sebastian Felis committed
206
 *
207
 * @param thing     an arbitrary pointer
Sebastian Felis's avatar
Sebastian Felis committed
208
 *
209
210
 * @return
 *     true if the thing is a type, else false
211
212
 */
int is_type            (void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
213

Sebastian Felis's avatar
Sebastian Felis committed
214
215
/**
 *   Checks whether two types are structural equal.
Michael Beck's avatar
Michael Beck committed
216
217
218
219
220
221
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if the types are equal, else false.
222
 *    Types are equal if :
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 *    - 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
251
252
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
253
254
255
256
257
258
259
260
 *
 *   @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
261
262
263
264
265
266
267
268
269
270
271
 *    - 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
272
 *      @return counterpart in lt and the type is smaller
273
274
275
276
277
 *    - 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
278
 *      @return or
279
280
281
282
 *      - 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
283
284
 *      @return smaller than the points_to type of lt.
 *
285
286
287
 */
bool smaller_type (type *st, type *lt);

Sebastian Felis's avatar
Sebastian Felis committed
288
/**
289
290
 *  @page class_type	Representation of a class type
 *
291
292
293
294
 *  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???
295
296
297
298
299
 *  The following attributes are private to this type kind:
 *  - member:     All entities belonging to this class.  This are methode entities
 *                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.
300
 *
301
302
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
303
 *
304
 *  - subtypes:   A list of direct subclasses.
305
 *
306
 *  - supertypes: A list of direct superclasses.
307
 *
308
309
310
311
312
313
314
315
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
 *                 "description" it only is a description of requirememts to a class,
 *                 as, e.g., a Java interface.  The class will never be allocated.
 *                 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.
316
 *
317
 */
318
319

/** Creates a new class type. */
320
type   *new_type_class (ident *name);
321
322

/** Creates a new class type with debug information. */
323
type   *new_d_type_class (ident *name, dbg_info *db);
324

325
326
327
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
328
void    add_class_member   (type *clss, entity *member);
329
330

/** Returns the number of members of this class. */
331
int     get_class_n_members (type *clss);
332
333

/** Returns the member at position pos, 0 <= pos < n_member */
334
entity *get_class_member   (type *clss, int pos);
335

Götz Lindenmaier's avatar
Götz Lindenmaier committed
336
337
/** Returns index of mem in clss, -1 if not contained. */
int     get_class_member_index(type *clss, entity *mem);
338
339

/** Overwrites the member at position pos, 0 <= pos < n_member with
340
   the passed entity. */
341
void    set_class_member   (type *clss, entity *member, int pos);
342
343
344

/** 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.
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
345
346
   members is an array of entities, num the size of this array.  Sets all
   owners of the members passed to clss. */
347
void    set_class_members  (type *clss, entity *members[], int arity);
348
349

/** Finds member in the list of members and removes it.
350
351
   Shrinks the member list, so iterate from the end!!!
   Does not deallocate the entity.  */
352
void    remove_class_member(type *clss, entity *member);
353

354

355
/** Adds subtype as subtype to clss.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
356
357
   Checks whether clss is a supertype of subtype.  If not
   adds also clss as supertype to subtype.  */
358
void    add_class_subtype   (type *clss, type *subtype);
359
360

/** Returns the number of subtypes */
361
int     get_class_n_subtypes (type *clss);
362
363

/** Gets the subtype at position pos, 0 <= pos < n_subtype. */
364
type   *get_class_subtype   (type *clss, int pos);
365
366
367

/** Sets the subtype at positioin pos, 0 <= pos < n_subtype.
   Does not set the corresponding supertype relation for subtype: this might
368
   be a different position! */
369
void    set_class_subtype   (type *clss, type *subtype, int pos);
370
371

/** Finds subtype in the list of subtypes and removes it  */
372
373
void    remove_class_subtype(type *clss, type *subtype);

374

375
/** Adds supertype as supertype to class.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
376
377
   Checks whether clss is a subtype of supertype.  If not
   adds also clss as subtype to supertype.  */
378
void    add_class_supertype   (type *clss, type *supertype);
379
380

/** Returns the number of supertypes */
381
int     get_class_n_supertypes (type *clss);
382
383

/** Returns the index of an supertype in a type. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
384
int     get_class_supertype_index(type *clss, type *super_clss);
385
386

/** Gets the supertype at position pos,  0 <= pos < n_supertype. */
387
type   *get_class_supertype   (type *clss, int pos);
388
389
390

/** Sets the supertype at postition pos, 0 <= pos < n_subtype.
   Does not set the corresponding subtype relation for supertype: this might
391
   be a different position! */
392
void    set_class_supertype   (type *clss, type *supertype, int pos);
393
394

/** Finds supertype in the list of supertypes and removes it */
395
void    remove_class_supertype(type *clss, type *supertype);
396

Michael Beck's avatar
Michael Beck committed
397
/** This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
398
typedef enum peculiarity {
Michael Beck's avatar
Michael Beck committed
399
  description,     /**< Represents only a description.  The entity/type is never
400
	  	      allocated, no code/data exists for this entity/type. */
Michael Beck's avatar
Michael Beck committed
401
  inherited,       /**< Describes explicitly that other entities are
402
403
404
405
406
 		      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
407
  existent         /**< The entity/type (can) exist. */
408
409
410
411
} peculiarity;

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

415
/* Set and get a class' dfn --
Michael Beck's avatar
Michael Beck committed
416
   @todo This is an undocumented field, subject to change! */
417
418
void set_class_dfn (type *clss, int dfn);
int  get_class_dfn (type *clss);
419

420
/** Returns true if a type is a class type. */
421
bool is_class_type(type *clss);
422
423

/** Returns true if low is subclass of high. */
424
bool is_subclass_of(type *low, type *high);
425

Sebastian Felis's avatar
Sebastian Felis committed
426
/**
427
428
 *  @page struct_type	Representation of a struct type
 *
429
430
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
431
432
433
434
435
436
437
438
439
 *  The following attributes are private to this type kind:
 *  - member:  All entities belonging to this class.  This are the fields
 *             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.
 *             This is a dynamic list that can be grown with an "add_" function,
 *             but not shrinked.
440
 */
441
/** Creates a new type struct */
442
type   *new_type_struct (ident *name);
443
/** Creates a new type struct with debug information. */
444
type   *new_d_type_struct (ident *name, dbg_info* db);
445
446
447

/* manipulate private fields of struct */
void    add_struct_member   (type *strct, entity *member);
448
int     get_struct_n_members (type *strct);
449
450
entity *get_struct_member   (type *strct, int pos);
void    set_struct_member   (type *strct, int pos, entity *member);
451
452

/** Finds member in the list of members and removes it. */
453
void    remove_struct_member (type *strct, entity *member);
454

455
/** Returns true if a type is a struct type. */
456
457
bool    is_struct_type(type *strct);

Sebastian Felis's avatar
Sebastian Felis committed
458
/**
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 * @page method_type	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.
 *
 * - n_params:   Number of parameters to the procedure.
 *               A procedure in FIRM has only call by value parameters.
 *
 * - param_type: A list with the types of parameters.  This list is ordered.
 *               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.)
 *
476
477
478
479
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
480
481
482
483
484
485
 * - n_res:      The number of results of the method.  In general, procedures
 *               have zero results, functions one.
 *
 * - res_type:   A list with the types of parameters.  This list is ordered.
 *               The nth type in this list corresponds to the nth input to
 *               Return nodes.  (See ircons.h for more information.)
486
487
488
489
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
490
491
 */

492
493
494
495
496
/* These makros define the suffixes for the types and entities used
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
497
498
/** Create a new method type.
 *
499
500
501
502
503
504
505
 * @param name      the name (ident) of this type
 * @param n_param   the number of parameters
 * @param n_res     the number of results
 *
 * The arrays for the parameter and result types are not initialized by
 * the constructor.
 */
506
type *new_type_method (ident *name, int n_param, int n_res);
507
508
509
510
511
512
513
514
515
516
517

/** Create a new method type with debug information.
 *
 * @param name      the name (ident) of this type
 * @param n_param   the number of parameters
 * @param n_res     the number of results
 * @param db        user defined debug information
 *
 * The arrays for the parameter and result types are not initialized by
 * the constructor.
 */
518
type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
519

520
521
522
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
523
int   get_method_n_params  (type *method);
524
525

/** Returns the type of the parameter at position pos of a method. */
526
type *get_method_param_type(type *method, int pos);
527
528
529
/** Sets the type of the parameter at position pos of a method.
    Also changes the type in the pass-by-value representation by just
    changing the type of the corresponding entity if the representation is constructed. */
530
void  set_method_param_type(type *method, int pos, type* tp);
531
532
533
/* Returns an entity that represents the copied value argument.  Only necessary
   for compounds passed by value. This information is constructed only on demand. */
entity *get_method_value_param_ent(type *method, int pos);
534

535
int   get_method_n_ress   (type *method);
536
type *get_method_res_type(type *method, int pos);
537
538
539
/** Sets the type of the result at position pos of a method.
    Also changes the type in the pass-by-value representation by just
    changing the type of the corresponding entity if the representation is constructed. */
540
void  set_method_res_type(type *method, int pos, type* tp);
541
542
543
/* Returns an entity that represents the copied value result.  Only necessary
   for compounds passed by value. This information is constructed only on demand. */
entity *get_method_value_res_ent(type *method, int pos);
544

Michael Beck's avatar
Michael Beck committed
545
/**
546
547
548
549
550
 * 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 {
551
552
  non_variadic,		/**< non variadic */
  variadic		/**< variadic */
553
554
} variadicity;

555
/** Returns the variadicity of a method. */
556
variadicity get_method_variadicity(type *method);
557
558

/** Sets the variadicity of a method. */
559
560
void set_method_variadicity(type *method, variadicity vari);

561
/** Returns true if a type is a method type. */
562
563
bool  is_method_type     (type *method);

Sebastian Felis's avatar
Sebastian Felis committed
564
/**
565
566
 *   @page union_type	Representation of a union type.
 *
567
 *   The union type represents union types.
568
569
 *   - n_types:     Number of unioned types.
 *   - members:     Entities for unioned types.  Fixed length array.
570
571
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
572
 */
573
/** Creates a new type union. */
574
type   *new_type_union (ident *name);
575
576

/** Creates a new type union with debug information. */
577
type   *new_d_type_union (ident *name, dbg_info* db);
578

579
580
581
/* --- manipulate private fields of struct --- */

/** Returns the number of unioned types of this union */
582
int     get_union_n_members      (type *uni);
583
584

/** Adds a new entity to a union type */
585
void    add_union_member (type *uni, entity *member);
586
587

/** Returns the entity at position pos of a union */
588
entity *get_union_member (type *uni, int pos);
589
590

/** Overwrites a entity at position pos in a union type. */
591
void    set_union_member (type *uni, int pos, entity *member);
592
593

/** Finds member in the list of members and removes it. */
594
void    remove_union_member (type *uni, entity *member);
595

596
/** Returns true if a type is a union type. */
597
598
bool    is_union_type          (type *uni);

Sebastian Felis's avatar
Sebastian Felis committed
599
/**
600
601
602
603
604
605
606
607
608
609
610
611
612
 * @page array_type	Representation of an array type
 *
 * The array type represents rectangular multi dimensional arrays.
 * The constants representing the bounds must be allocated to
 * get_const_code_irg() by setting current_ir_graph accordingly.
 *
 * - n_dimensions:    Number of array dimensions.
 * - *lower_bound:    Lower bounds of dimensions.  Usually all 0.
 * - *upper_bound:    Upper bounds or dimensions.
 * - *element_type:   The type of the array elements.
 * - *element_ent:    An entity for the array elements to be used for
 *                      element selection with Sel.
 * @todo
Michael Beck's avatar
Michael Beck committed
613
614
 *   Do we need several entities?  One might want
 *   to select a dimension and not a single element in case of multidim arrays.
615
 */
616
617
618
619
620
621
622
623

/** Create a new type array.
 *
 * Sets n_dimension to dimension and all dimension entries to NULL.
 * Initializes order to the order of the dimensions.
 * The entity for array elements is built automatically.
 * Set dimension sizes after call to constructor with set_* routines.
 */
624
type *new_type_array         (ident *name, int n_dimensions,
625
			      type *element_type);
626
627
628
629
630
631
632
633

/** Create a new type array with debug information.
 *
 * Sets n_dimension to dimension and all dimension entries to NULL.
 * Initializes order to the order of the dimensions.
 * The entity for array elements is built automatically.
 * Set dimension sizes after call to constructor with set_* routines.
 */
634
635
type *new_d_type_array         (ident *name, int n_dimensions,
			      type *element_type, dbg_info* db);
636

637
638
639
/* --- manipulate private fields of array type --- */

/** Returns the number of array dimensions of this type. */
640
int   get_array_n_dimensions (type *array);
641
642

/** Allocates Const nodes of mode_I for the array dimensions */
643
644
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
645
646
647
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);
648
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
649
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
650
void  set_array_upper_bound_int (type *array, int dimension, int lower_bound);
651
652
ir_node * get_array_lower_bound  (type *array, int dimension);
ir_node * get_array_upper_bound  (type *array, int dimension);
653

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
654
655
656
void set_array_order (type *array, int dimension, int order);
int  get_array_order (type *array, int dimension);

657
void  set_array_element_type (type *array, type *tp);
658
659
type *get_array_element_type (type *array);

660
661
662
void  set_array_element_entity (type *array, entity *ent);
entity *get_array_element_entity (type *array);

663
/** Returns true if a type is an array type. */
664
665
bool   is_array_type         (type *array);

Sebastian Felis's avatar
Sebastian Felis committed
666
/**
667
 * @page enumeration_type	Representation of an enumeration type
668
 *
669
670
671
672
673
674
675
676
677
678
 * 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.
 *
 * - *enum:         The target values representing the constants used to
 *                  represent individual enumerations.
 * - *enum_nameid:  Idents containing the source program name of the enumeration
 *  	     constants
 */
/** Create a new type enumeration -- set the enumerators independently. */
679
type   *new_type_enumeration    (ident *name, int n_enums);
680
681

/** Create a new type enumeration with debug information -- set the enumerators independently. */
682
type   *new_d_type_enumeration    (ident *name, int n_enums, dbg_info* db);
683

684
685
686
/* --- manipulate fields of enumeration type. --- */

/** Returns the number of enumeration values of this enumeration */
687
688
int     get_enumeration_n_enums (type *enumeration);

689
/** Sets the enumeration value at a given position. */
690
void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
691
692

/** Returns the enumeration value at a given position. */
693
694
tarval *get_enumeration_enum    (type *enumeration, int pos);

695
/** Assign an ident to an enumeration value at a given position. */
696
void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
697
698

/** Returns the assigned ident of an enumeration value at a given position. */
699
ident  *get_enumeration_nameid  (type *enumeration, int pos);
700
701

/** Returns the assigned name of an enumeration value at a given position. */
702
703
const char *get_enumeration_name(type *enumeration, int pos);

704
/** Returns true if a type is a enumeration type. */
705
706
bool    is_enumeration_type     (type *enumeration);

Sebastian Felis's avatar
Sebastian Felis committed
707
/**
708
709
710
711
 * @page pointer_type	Representation of a pointer type
 *
 * Pointer types:
 * - points_to:      The type of the entity this pointer points to.
712
 */
713
/** Creates a new type pointer. */
714
type *new_type_pointer           (ident *name, type *points_to);
Christian Schäfer's avatar
Christian Schäfer committed
715

716
717
718
719
720
721
/** Creates a new type pointer with debug information. */
type *new_d_type_pointer         (ident *name, type *points_to, dbg_info* db);

/* --- manipulate fields of type_pointer --- */

/** Sets the type to which a pointer points to. */
722
void  set_pointer_points_to_type (type *pointer, type *tp);
723
724

/** Returns the type to which a pointer points to. */
725
726
type *get_pointer_points_to_type (type *pointer);

727
/** Returns true if a type is a pointer type. */
728
729
bool  is_pointer_type            (type *pointer);

Sebastian Felis's avatar
Sebastian Felis committed
730
/**
731
732
733
734
735
 * @page primitive_type 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
736
*/
737
/** Creates a new primitive type. */
738
type *new_type_primitive (ident *name, ir_mode *mode);
739
740

/** Creates a new primitive type with debug information. */
741
type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
Christian Schäfer's avatar
Christian Schäfer committed
742

743
/** Returns true if a type is a primitive type. */
744
bool  is_primitive_type  (type *primitive);
Christian Schäfer's avatar
Christian Schäfer committed
745

746

Sebastian Felis's avatar
Sebastian Felis committed
747
/**
748
749
750
 *  Checks whether a type is atomic.
 *  @param tp - any type
 *  @return true if type is primitive, pointer or enumeration
751
752
753
 */
int is_atomic_type(type *tp);

754
755
/* --- Support for compound types --- */

Sebastian Felis's avatar
Sebastian Felis committed
756
/**
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 * Gets the number of elements in a firm compound type.
 *
 * This is just a comforability function, because structs and
 * classes can often be treated be the same code, but they have
 * different access functions to their members.
 *
 * @param tp  The type (must be struct, union or class).
 *
 * @return Number of members in the compound type.
 */
int get_compound_n_members(type *tp);

/**
 * Gets the member of a firm compound type at position pos.
 *
 * @param tp  The type (must be struct, union or class).
 * @param pos The number of the member.
 *
 * @return The member entity at position pos.
 *
 * @see get_compound_n_members() for justifaction of existence.
 */
entity *get_compound_member(type *tp, int pos);

/**
 *  Checks whether a type is compound.
 *
 *  @param tp - any type
 *
 *  @return true if the type is class, structure, union or array type.
787
788
789
 */
int is_compound_type(type *tp);

790

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

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