type.h 30.4 KB
Newer Older
Michael Beck's avatar
Michael Beck committed
1
/*
2
3
4
5
6
7
8
9
10
 * Project:     libFIRM
 * File name:   ir/tr/type.h
 * Purpose:     Representation of types.
 * Author:      Goetz Lindenmaier
 * Modified by:
 * Created:
 * CVS-ID:      $Id$
 * Copyright:   (c) 2001-2003 Universität Karlsruhe
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
Michael Beck's avatar
Michael Beck committed
11
12
 */

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

Christian Schäfer's avatar
Christian Schäfer committed
39
40
41
# ifndef _TYPE_H_
# define _TYPE_H_

42
# include "tpop.h"
43
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
44
45
# include "ident.h"
# include "irmode.h"
46
# include <stdbool.h>
47
# include "dbginfo.h"
Christian Schäfer's avatar
Christian Schäfer committed
48

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

50
/* to resolve recursion between entity.h and type.h */
Christian Schäfer's avatar
Christian Schäfer committed
51
52
53
54
#ifndef _ENTITY_TYPEDEF_
#define _ENTITY_TYPEDEF_
typedef struct entity entity;
#endif
Christian Schäfer's avatar
Christian Schäfer committed
55

56
57
58
59
60
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif

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

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
122
123
# include "type_or_entity.h"

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

128
129
130
131
132
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);

133
134
ident*      get_type_ident(type *tp);
void        set_type_ident(type *tp, ident* id);
135
136
const char* get_type_name(type *tp);

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

/** Returns the type layout state of a type. */
152
type_state  get_type_state(type *tp);
153
154
155
156
157
158

/** 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.
 */
159
160
void        set_type_state(type *tp, type_state state);

161
162
163
164
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
165
ir_mode*    get_type_mode(type *tp);
166
167
168
169
170

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

173
/** Returns the size of a type. */
174
int         get_type_size(type *tp);
175
176
177
178
179
180

/** 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.
 */
181
182
183
void        set_type_size(type *tp, int size);


184
unsigned long get_type_visited(type *tp);
185
void          set_type_visited(type *tp, unsigned long num);
186
/* Sets visited field in type to type_visited. */
187
void          mark_type_visited(type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
188
189
/* @@@ name clash!! bool          type_visited(type *tp); */
bool          type_not_visited(type *tp);
190

191
192
void*         get_type_link(type *tp);
void          set_type_link(type *tp, void *l);
193

Sebastian Felis's avatar
Sebastian Felis committed
194
/**
195
196
197
198
199
200
201
 * 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.
202
 *
Sebastian Felis's avatar
Sebastian Felis committed
203
 * @see  typewalk
204
 */
Christian Schäfer's avatar
Christian Schäfer committed
205
extern unsigned long type_visited;
206
void          set_master_type_visited(unsigned long val);
207
208
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
209
210

/**
211
 * Checks whether a pointer points to a type.
Sebastian Felis's avatar
Sebastian Felis committed
212
 *
213
 * @param thing     an arbitrary pointer
Sebastian Felis's avatar
Sebastian Felis committed
214
 *
215
216
 * @return
 *     true if the thing is a type, else false
217
218
 */
int is_type            (void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
219

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

Sebastian Felis's avatar
Sebastian Felis committed
294
/**
295
296
 *  @page class_type	Representation of a class type
 *
297
298
299
300
 *  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???
301
302
303
304
305
 *  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.
306
 *
307
308
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
309
 *
310
 *  - subtypes:   A list of direct subclasses.
311
 *
312
 *  - supertypes: A list of direct superclasses.
313
 *
314
315
316
317
318
319
320
321
 *  - 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.
322
 *
323
 */
324
325

/** Creates a new class type. */
326
type   *new_type_class (ident *name);
327
328

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

331
332
333
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
334
void    add_class_member   (type *clss, entity *member);
335
336

/** Returns the number of members of this class. */
337
int     get_class_n_members (type *clss);
338
339

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
342
343
/** Returns index of mem in clss, -1 if not contained. */
int     get_class_member_index(type *clss, entity *mem);
344
345

/** Overwrites the member at position pos, 0 <= pos < n_member with
346
   the passed entity. */
347
void    set_class_member   (type *clss, entity *member, int pos);
348
349
350

/** 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
351
352
   members is an array of entities, num the size of this array.  Sets all
   owners of the members passed to clss. */
353
void    set_class_members  (type *clss, entity *members[], int arity);
354
355

/** Finds member in the list of members and removes it.
356
357
   Shrinks the member list, so iterate from the end!!!
   Does not deallocate the entity.  */
358
void    remove_class_member(type *clss, entity *member);
359

360

361
/** Adds subtype as subtype to clss.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
362
363
   Checks whether clss is a supertype of subtype.  If not
   adds also clss as supertype to subtype.  */
364
void    add_class_subtype   (type *clss, type *subtype);
365
366

/** Returns the number of subtypes */
367
int     get_class_n_subtypes (type *clss);
368
369

/** Gets the subtype at position pos, 0 <= pos < n_subtype. */
370
type   *get_class_subtype   (type *clss, int pos);
371
372
373

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

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

380

381
/** Adds supertype as supertype to class.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
382
383
   Checks whether clss is a subtype of supertype.  If not
   adds also clss as subtype to supertype.  */
384
void    add_class_supertype   (type *clss, type *supertype);
385
386

/** Returns the number of supertypes */
387
int     get_class_n_supertypes (type *clss);
388
389

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

/** Gets the supertype at position pos,  0 <= pos < n_supertype. */
393
type   *get_class_supertype   (type *clss, int pos);
394
395
396

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

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

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

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

421
/* Set and get a class' dfn --
Michael Beck's avatar
Michael Beck committed
422
   @todo This is an undocumented field, subject to change! */
423
424
void set_class_dfn (type *clss, int dfn);
int  get_class_dfn (type *clss);
425

426
/** Returns true if a type is a class type. */
427
bool is_class_type(type *clss);
428
429

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

Sebastian Felis's avatar
Sebastian Felis committed
432
/**
433
434
 *  @page struct_type	Representation of a struct type
 *
435
436
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
437
438
439
440
441
442
443
444
445
 *  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.
446
 */
447
/** Creates a new type struct */
448
type   *new_type_struct (ident *name);
449
/** Creates a new type struct with debug information. */
450
type   *new_d_type_struct (ident *name, dbg_info* db);
451
452
453

/* manipulate private fields of struct */
void    add_struct_member   (type *strct, entity *member);
454
int     get_struct_n_members (type *strct);
455
456
entity *get_struct_member   (type *strct, int pos);
void    set_struct_member   (type *strct, int pos, entity *member);
457
458

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

461
/** Returns true if a type is a struct type. */
462
463
bool    is_struct_type(type *strct);

Sebastian Felis's avatar
Sebastian Felis committed
464
/**
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 * @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.)
 *
482
483
484
485
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
486
487
488
489
490
491
 * - 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.)
492
493
494
495
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
496
497
 */

498
499
500
501
502
/* 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
503
504
/** Create a new method type.
 *
505
506
507
508
509
510
511
 * @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.
 */
512
type *new_type_method (ident *name, int n_param, int n_res);
513
514
515
516
517
518
519
520
521
522
523

/** 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.
 */
524
type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
525

526
527
528
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
529
int   get_method_n_params  (type *method);
530
531

/** Returns the type of the parameter at position pos of a method. */
532
type *get_method_param_type(type *method, int pos);
533
534
535
/** 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. */
536
void  set_method_param_type(type *method, int pos, type* tp);
537
538
539
/* 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);
540

541
int   get_method_n_ress   (type *method);
542
type *get_method_res_type(type *method, int pos);
543
544
545
/** 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. */
546
void  set_method_res_type(type *method, int pos, type* tp);
547
548
549
/* 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);
550

Michael Beck's avatar
Michael Beck committed
551
/**
552
553
554
555
556
 * 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 {
557
558
  non_variadic,		/**< non variadic */
  variadic		/**< variadic */
559
560
} variadicity;

561
/** Returns the variadicity of a method. */
562
variadicity get_method_variadicity(type *method);
563
564

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

567
/** Returns true if a type is a method type. */
568
569
bool  is_method_type     (type *method);

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

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

585
586
587
/* --- manipulate private fields of struct --- */

/** Returns the number of unioned types of this union */
588
int     get_union_n_members      (type *uni);
589
590

/** Adds a new entity to a union type */
591
void    add_union_member (type *uni, entity *member);
592
593

/** Returns the entity at position pos of a union */
594
entity *get_union_member (type *uni, int pos);
595
596

/** Overwrites a entity at position pos in a union type. */
597
void    set_union_member (type *uni, int pos, entity *member);
598
599

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

602
/** Returns true if a type is a union type. */
603
604
bool    is_union_type          (type *uni);

Sebastian Felis's avatar
Sebastian Felis committed
605
/**
606
607
608
609
610
611
612
613
614
615
616
617
618
 * @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
619
620
 *   Do we need several entities?  One might want
 *   to select a dimension and not a single element in case of multidim arrays.
621
 */
622
623
624
625
626
627
628
629

/** 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.
 */
630
type *new_type_array         (ident *name, int n_dimensions,
631
			      type *element_type);
632
633
634
635
636
637
638
639

/** 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.
 */
640
641
type *new_d_type_array         (ident *name, int n_dimensions,
			      type *element_type, dbg_info* db);
642

643
644
645
/* --- manipulate private fields of array type --- */

/** Returns the number of array dimensions of this type. */
646
int   get_array_n_dimensions (type *array);
647
648

/** Allocates Const nodes of mode_I for the array dimensions */
649
650
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
651
652
653
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);
654
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
655
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
656
void  set_array_upper_bound_int (type *array, int dimension, int lower_bound);
657
/* returns true if lower bound != Unknown */
658
int       has_array_lower_bound  (type *array, int dimension);
659
ir_node * get_array_lower_bound  (type *array, int dimension);
660
int       has_array_upper_bound  (type *array, int dimension);
661
ir_node * get_array_upper_bound  (type *array, int dimension);
662

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
663
664
665
void set_array_order (type *array, int dimension, int order);
int  get_array_order (type *array, int dimension);

666
void  set_array_element_type (type *array, type *tp);
667
668
type *get_array_element_type (type *array);

669
670
671
void  set_array_element_entity (type *array, entity *ent);
entity *get_array_element_entity (type *array);

672
/** Returns true if a type is an array type. */
673
674
bool   is_array_type         (type *array);

Sebastian Felis's avatar
Sebastian Felis committed
675
/**
676
 * @page enumeration_type	Representation of an enumeration type
677
 *
678
679
680
681
682
683
684
685
686
687
 * 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. */
688
type   *new_type_enumeration    (ident *name, int n_enums);
689
690

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

693
694
695
/* --- manipulate fields of enumeration type. --- */

/** Returns the number of enumeration values of this enumeration */
696
697
int     get_enumeration_n_enums (type *enumeration);

698
/** Sets the enumeration value at a given position. */
699
void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
700
701

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

704
/** Assign an ident to an enumeration value at a given position. */
705
void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
706
707

/** Returns the assigned ident of an enumeration value at a given position. */
708
ident  *get_enumeration_nameid  (type *enumeration, int pos);
709
710

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

713
/** Returns true if a type is a enumeration type. */
714
715
bool    is_enumeration_type     (type *enumeration);

Sebastian Felis's avatar
Sebastian Felis committed
716
/**
717
718
 * @page pointer_type	Representation of a pointer type
 *
719
720
 * The mode of the pointer type must be a mode_reference.
 *
721
722
 * Pointer types:
 * - points_to:      The type of the entity this pointer points to.
723
 */
Christian Schäfer's avatar
Christian Schäfer committed
724

725
726
727
728
729
730
731
732
733
/** Creates a new type pointer with mode mode_p. */
#define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P)
//type *new_type_pointer           (ident *name, type *points_to);

/** Creates a new type pointer with given pointer mode. */
type *new_type_pointer_mode      (ident *name, type *points_to, ir_mode *ptr_mode);

/** Creates a new type pointer given pointer mode and with debug information. */
type *new_d_type_pointer         (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
734
735
736
737

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

/** Sets the type to which a pointer points to. */
738
void  set_pointer_points_to_type (type *pointer, type *tp);
739
740

/** Returns the type to which a pointer points to. */
741
742
type *get_pointer_points_to_type (type *pointer);

743
/** Returns true if a type is a pointer type. */
744
745
bool  is_pointer_type            (type *pointer);

Sebastian Felis's avatar
Sebastian Felis committed
746
/**
747
748
749
750
751
 * @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
752
*/
753
/** Creates a new primitive type. */
754
type *new_type_primitive (ident *name, ir_mode *mode);
755
756

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

759
/** Returns true if a type is a primitive type. */
760
bool  is_primitive_type  (type *primitive);
Christian Schäfer's avatar
Christian Schäfer committed
761

762

Sebastian Felis's avatar
Sebastian Felis committed
763
/**
764
765
766
 *  Checks whether a type is atomic.
 *  @param tp - any type
 *  @return true if type is primitive, pointer or enumeration
767
768
769
 */
int is_atomic_type(type *tp);

770
771
/* --- Support for compound types --- */

Sebastian Felis's avatar
Sebastian Felis committed
772
/**
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 * 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.
803
804
805
 */
int is_compound_type(type *tp);

806

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

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