type.h 30.9 KB
Newer Older
Sebastian Felis's avatar
Sebastian Felis committed
1
/**
2
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
3
 * @file type.h
Michael Beck's avatar
Michael Beck committed
4
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
5
6
7
8
9
10
11
12
13
 * Project:     libFIRM                                                   <br>
 * File name:   ir/tr/type.h                                              <br>
 * Purpose:     Representation of types.                                  <br>
 * Author:      Goetz Lindenmaier                                         <br>
 * Modified by:                                                           <br>
 * Created:                                                               <br>
 * Copyright:   (c) 2001-2003 Universität Karlsruhe                       <br>
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE. <br>
 * CVS-ID:      $Id$
Michael Beck's avatar
Michael Beck committed
14
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
15
16
 *
 *  Datastructure to hold type information.
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 *
 *  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.
 *
33
 *  @see  tpop.h
34
 */
Boris Boesler's avatar
Boris Boesler committed
35

Christian Schäfer's avatar
Christian Schäfer committed
36
37
38
# ifndef _TYPE_H_
# define _TYPE_H_

Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
39
40
# include <stdbool.h>

41
# include "tpop.h"
42
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
43
44
# include "ident.h"
# include "irmode.h"
45
# include "dbginfo.h"
Christian Schäfer's avatar
Christian Schäfer committed
46

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

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

54
55
56
57
58
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif

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

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
120
121
# include "type_or_entity.h"

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

126
127
128
129
130
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);

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

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

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

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

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

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

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

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


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

189
190
void*         get_type_link(type *tp);
void          set_type_link(type *tp, void *l);
191

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

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

Sebastian Felis's avatar
Sebastian Felis committed
218
219
/**
 *   Checks whether two types are structural equal.
Michael Beck's avatar
Michael Beck committed
220
221
222
223
224
225
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if the types are equal, else false.
226
 *    Types are equal if :
227
228
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
 *    - 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
255
256
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
257
258
259
260
261
262
263
264
 *
 *   @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
265
266
267
268
269
270
271
272
273
274
275
 *    - 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
276
 *      @return counterpart in lt and the type is smaller
277
278
279
280
281
 *    - 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
282
 *      @return or
283
284
285
286
 *      - 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
287
288
 *      @return smaller than the points_to type of lt.
 *
289
290
291
 */
bool smaller_type (type *st, type *lt);

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

/** Creates a new class type. */
324
type   *new_type_class (ident *name);
325
326

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

329
330
331
/* --- manipulate private fields of class type  --- */

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

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

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

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

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

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

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

358

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

/** Returns the number of subtypes */
365
int     get_class_n_subtypes (type *clss);
366
367

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

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

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

378

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

/** Returns the number of supertypes */
385
int     get_class_n_supertypes (type *clss);
386
387

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

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

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

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

Michael Beck's avatar
Michael Beck committed
401
/** This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
402
typedef enum peculiarity {
403
404
405
406
407
408
409
410
411
  peculiarity_description,     /**< Represents only a description.  The entity/type is never
	  	                    allocated, no code/data exists for this entity/type. */
  peculiarity_inherited,       /**< Describes explicitly that other entities are
 		                    inherited to the owner of this entity.
 		                    Overwrites must refer to at least one other
 		                    entity.  If this is a method entity there exists
 		                    no irg for this entity, only for one of the
 		                    overwritten ones. */
  peculiarity_existent         /**< The entity/type (can) exist. */
412
413
414
415
} peculiarity;

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

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

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

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

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

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

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

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

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

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

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

524
525
526
/* -- manipulate private fields of method. -- */

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

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

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

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

Michael Beck's avatar
Michael Beck committed
559
560
561
/** Returns the null-terminated name of this variadicity. */
const char *get_variadicity_name(variadicity vari);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

726
727
728
729
730
731
732
733
734
/** 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);
735
736
737
738

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

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

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

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

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

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

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

763

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

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

Sebastian Felis's avatar
Sebastian Felis committed
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
803
 * 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.
804
805
806
 */
int is_compound_type(type *tp);

807

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

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