5 * Project: libFIRM <br>
6 * File name: ir/tr/type.h <br>
7 * Purpose: Representation of types. <br>
8 * Author: Goetz Lindenmaier <br>
11 * Copyright: (c) 2001-2003 Universität Karlsruhe <br>
12 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. <br>
16 * Datastructure to hold type information.
18 * This module supplies a datastructure to represent all types
19 * known in the compiled program. This includes types specified
20 * in the program as well as types defined by the language. In the
21 * view of the intermediate representation there is no difference
22 * between these types. Finally it specifies some auxiliary types.
24 * There exist several kinds of types, arranged by the structure of
25 * the type. A type is described by a set of attributes. Some of
26 * these attributes are common to all types, others depend on the
29 * Types are different from the modes defined in irmode: Types are
30 * on the level of the programming language, modes at the level of
31 * the target processor.
42 # include "firm_common.h"
48 /* to resolve recursion between entity.h and type.h */
49 #ifndef _ENTITY_TYPEDEF_
50 #define _ENTITY_TYPEDEF_
51 typedef struct entity entity;
54 #ifndef _IR_NODE_TYPEDEF_
55 #define _IR_NODE_TYPEDEF_
56 typedef struct ir_node ir_node;
60 * An abstract data type to represent types.
62 * This is the abstract data type with which any type known in the
63 * compiled program can be represented. This includes types specified
64 * in the program as well as types defined by the language. In the
65 * view of the intermediate representation there is no difference
66 * between these types.
68 * There exist several kinds of types, arranged by the structure of
69 * the type. These are distinguished by a type opcode.
70 * A type is described by a set of attributes. Some of these attributes
71 * are common to all types, others depend on the kind of the type.
73 * The following describes the common attributes. They can only be
74 * accessed by the functions given below.
76 * The common fields are:
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 * - type_op: A tp_op specifying the kind of the type.
81 * - mode: The mode to be used to represent the type on a machine.
82 * - 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 * occupy size bytes in memory. In several cases this is
86 * determined when fixing the layout of this type (class,
87 * struct, union, array, enumeration).
88 * - state: The state of the type. The state represents whether the
89 * layout of the type is undefined or fixed (values: layout_undefined
90 * or layout_fixed). Compound types can have an undefined
91 * layout. The layout of the basic types primitive and pointer
92 * is always layout_fixed. If the layout of
93 * compound types is fixed all entities must have an offset
94 * and the size of the type must be set.
95 * A fixed layout for enumeration types means that each enumeration
96 * is associated with an implementation value.
97 * - visit: A counter for walks of the type information.
98 * - link: A void* to associate some additional information with the type.
100 * These fields can only be accessed via access functions.
102 * Depending on the value of @c type_op, i.e., depending on the kind of the
103 * type the adt contains further attributes. These are documented below.
107 * @link class_type class @endlink, @link struct_type struct @endlink,
108 * @link method_type method @endlink, @link union_type union @endlink,
109 * @link array_type array @endlink, @link enumeration_type enumeration @endlink,
110 * @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
113 * mode maybe not global field??
115 #ifndef _TYPE_TYPEDEF_
116 #define _TYPE_TYPEDEF_
117 typedef struct type type;
120 # include "type_or_entity.h"
122 /** frees all entities associated with a type.
123 Does not free array entity.
124 Warning: make sure these entities are not referenced anywhere else.
126 void free_type_entities(type *tp);
128 /** Frees the memory used by the type. Does not free the entities
129 belonging to the type, except for the array element entity.
130 Does not free if tp is "none" or "unknown".
131 Frees entities in value param subtypes of method types!!! Make sure these
132 are not referenced any more. */
133 void free_type(type *tp);
135 tp_op* get_type_tpop(type *tp);
136 ident* get_type_tpop_nameid(type *tp);
137 const char* get_type_tpop_name(type *tp);
138 tp_opcode get_type_tpop_code(type *tp);
140 ident* get_type_ident(type *tp);
141 void set_type_ident(type *tp, ident* id);
142 const char* get_type_name(type *tp);
144 /** The state of the type layout. */
146 layout_undefined, /**< The layout of this type is not defined.
147 Address computation to access fields is not
148 possible, fields must be accessed by Sel
149 nodes. This is the default value except for
150 pointer, primitive and method types. */
151 layout_fixed /**< The layout is fixed, all component/member entities
152 have an offset assigned. Size of the type is known.
153 Arrays can be accessed by explicit address
154 computation. Default for pointer, primitive and method
158 /** Returns the type layout state of a type. */
159 type_state get_type_state(type *tp);
161 /** Sets the type layout state of a type.
163 * For primitives, pointer and method types the layout is always fixed.
164 * This call is legal but has no effect.
166 void set_type_state(type *tp, type_state state);
168 /** Returns the mode of a type.
170 * Returns NULL for all non atomic types.
172 ir_mode* get_type_mode(type *tp);
174 /** Sets the mode of a type.
176 * Only has an effect on primitive, enumeration and pointer types.
178 void set_type_mode(type *tp, ir_mode* m);
180 /** Returns the size of a type in bytes, retuns -1 if the size is NOT
181 * a byte size, ie not dividable by 8. */
182 int get_type_size_bytes(type *tp);
184 /** Returns the size of a type in bits. */
185 int get_type_size_bits(type *tp);
187 /** Sets the size of a type in bytes.
189 * For primitive, enumeration, pointer and method types the size
190 * is always fixed. This call is legal but has no effect.
192 void set_type_size_bytes(type *tp, int size);
194 /** Sets the size of a type in bits.
196 * For primitive, enumeration, pointer and method types the size
197 * is always fixed. This call is legal but has no effect.
199 void set_type_size_bits(type *tp, int size);
202 unsigned long get_type_visited(type *tp);
203 void set_type_visited(type *tp, unsigned long num);
204 /* Sets visited field in type to type_visited. */
205 void mark_type_visited(type *tp);
206 /* @@@ name clash!! int type_visited(type *tp); */
207 int type_not_visited(type *tp);
209 void* get_type_link(type *tp);
210 void set_type_link(type *tp, void *l);
213 * Visited flag to traverse the type information.
215 * Increase this flag by one before traversing the type information.
216 * Mark type nodes as visited by set_type_visited(type, type_visited).
217 * Check whether node was already visited by comparing get_type_visited(type)
219 * Or use the function to walk all types.
223 extern unsigned long type_visited;
224 void set_master_type_visited(unsigned long val);
225 unsigned long get_master_type_visited(void);
226 void inc_master_type_visited(void);
229 * Checks whether a pointer points to a type.
231 * @param thing an arbitrary pointer
234 * true if the thing is a type, else false
236 int is_type (void *thing);
239 * Checks whether two types are structural equal.
241 * @param st pointer type
242 * @param lt pointer type
245 * true if the types are equal, else false.
246 * Types are equal if :
247 * - they are the same type kind
248 * - they have the same name
249 * - they have the same mode (if applicable)
250 * - they have the same type_state and, ev., the same size
251 * - they are class types and have
252 * - the same members (see same_entity in entity.h)
253 * - the same supertypes -- the C-pointers are compared --> no recursive call.
254 * - the same number of subtypes. Subtypes are not compared,
255 * as this could cause a cyclic test.
256 * - the same peculiarity
257 * - they are structure types and have the same members
258 * - they are method types and have
259 * - the same parameter types
260 * - the same result types
261 * - they are union types and have the same members
262 * - they are array types and have
263 * - the same number of dimensions
264 * - the same dimension bounds
265 * - the same dimension order
266 * - the same element type
267 * - they are enumeration types and have the same enumerator names
268 * - they are pointer types and have the identical points_to type
269 * (i.e., the same C-struct to represent the type, type_id is skipped.
270 * This is to avoid endless recursions; with pointer types circlic
271 * type graphs are possible.)
273 bool equal_type(type *tpy1, type *typ2);
276 * Checks whether two types are structural comparable.
278 * @param st pointer type
279 * @param lt pointer type
282 * true if type st is smaller than type lt, i.e. whenever
283 * lt is expected a st can be used.
285 * - they are the same type kind
286 * - mode(st) < mode (lt) (if applicable)
287 * - they are class types and st is (transitive) subtype of lt,
288 * - they are structure types and
289 * - the members of st have exactly one counterpart in lt with the same name,
290 * - the counterpart has a bigger type.
291 * - they are method types and have
292 * - the same number of parameter and result types,
293 * - the parameter types of st are smaller than those of lt,
294 * - the result types of st are smaller than those of lt
295 * - they are union types and have the members of st have exactly one
296 * @return counterpart in lt and the type is smaller
297 * - they are array types and have
298 * - the same number of dimensions
299 * - all bounds of lt are bound of st
300 * - the same dimension order
301 * - the same element type
303 * - the element type of st is smaller than that of lt
304 * - the element types have the same size and fixed layout.
305 * - they are enumeration types and have the same enumerator names
306 * - they are pointer types and have the points_to type of st is
307 * @return smaller than the points_to type of lt.
310 bool smaller_type (type *st, type *lt);
313 * @page class_type Representation of a class type
315 * If the type opcode is set to type_class the type represents class
316 * types. A list of fields and methods is associated with a class.
317 * Further a class can inherit from and bequest to other classes.
319 * The following attributes are private to this type kind:
320 * - member: All entities belonging to this class. This are methode entities
321 * which have type_method or fields that can have any of the
322 * following type kinds: type_class, type_struct, type_union,
323 * type_array, type_enumeration, type_pointer, type_primitive.
325 * The following two are dynamic lists that can be grown with an "add_" function,
328 * - subtypes: A list of direct subclasses.
330 * - supertypes: A list of direct superclasses.
332 * - peculiarity: The peculiarity of this class. If the class is of peculiarity
333 * "description" it only is a description of requirememts to a class,
334 * as, e.g., a Java interface. The class will never be allocated.
335 * Peculiatity inherited is only possible for entities. An entity
336 * is of peculiarity inherited if the compiler generated the entity
337 * to explicitly resolve inheritance. An inherited method entity has
339 * Values: description, existent, inherited. Default: existent.
343 /** Creates a new class type. */
344 type *new_type_class (ident *name);
346 /** Creates a new class type with debug information. */
347 type *new_d_type_class (ident *name, dbg_info *db);
349 /* --- manipulate private fields of class type --- */
351 /** Adds the entity as member of the class. */
352 void add_class_member (type *clss, entity *member);
354 /** Returns the number of members of this class. */
355 int get_class_n_members (type *clss);
357 /** Returns the member at position pos, 0 <= pos < n_member */
358 entity *get_class_member (type *clss, int pos);
360 /** Returns index of mem in clss, -1 if not contained. */
361 int get_class_member_index(type *clss, entity *mem);
363 /** Finds the member with name 'name'. If several members with the same
364 name returns one of them. Returns NULL if no member found. */
365 entity *get_class_member_by_name(type *clss, ident *name);
367 /** Overwrites the member at position pos, 0 <= pos < n_member with
368 the passed entity. */
369 void set_class_member (type *clss, entity *member, int pos);
371 /** Replaces complete member list in class type by the list passed.
372 Copies the list passed. This function is necessary to reduce the number of members.
373 members is an array of entities, num the size of this array. Sets all
374 owners of the members passed to clss. */
375 void set_class_members (type *clss, entity *members[], int arity);
377 /** Finds member in the list of members and removes it.
378 Shrinks the member list, so iterate from the end!!!
379 Does not deallocate the entity. */
380 void remove_class_member(type *clss, entity *member);
383 /** Adds subtype as subtype to clss.
384 Checks whether clss is a supertype of subtype. If not
385 adds also clss as supertype to subtype. */
386 void add_class_subtype (type *clss, type *subtype);
388 /** Returns the number of subtypes */
389 int get_class_n_subtypes (type *clss);
391 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
392 type *get_class_subtype (type *clss, int pos);
394 /** Sets the subtype at positioin pos, 0 <= pos < n_subtype.
395 Does not set the corresponding supertype relation for subtype: this might
396 be a different position! */
397 void set_class_subtype (type *clss, type *subtype, int pos);
399 /** Finds subtype in the list of subtypes and removes it */
400 void remove_class_subtype(type *clss, type *subtype);
403 /** Adds supertype as supertype to class.
404 Checks whether clss is a subtype of supertype. If not
405 adds also clss as subtype to supertype. */
406 void add_class_supertype (type *clss, type *supertype);
408 /** Returns the number of supertypes */
409 int get_class_n_supertypes (type *clss);
411 /** Returns the index of an supertype in a type. */
412 int get_class_supertype_index(type *clss, type *super_clss);
414 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
415 type *get_class_supertype (type *clss, int pos);
417 /** Sets the supertype at postition pos, 0 <= pos < n_subtype.
418 Does not set the corresponding subtype relation for supertype: this might
419 be a different position! */
420 void set_class_supertype (type *clss, type *supertype, int pos);
422 /** Finds supertype in the list of supertypes and removes it */
423 void remove_class_supertype(type *clss, type *supertype);
425 /** This enumeration flags the peculiarity of entities and types. */
426 typedef enum peculiarity {
427 peculiarity_description, /**< Represents only a description. The entity/type is never
428 allocated, no code/data exists for this entity/type.
429 @@@ eventually rename to descriptive (adjectiv as the others!)*/
430 peculiarity_inherited, /**< Describes explicitly that other entities are
431 inherited to the owner of this entity.
432 Overwrites must refer to at least one other
433 entity. If this is a method entity there exists
434 no irg for this entity, only for one of the
437 peculiarity_existent /**< The entity/type (can) exist.
438 @@@ eventually rename to 'real' i.e., 'echt'
439 This serves better as opposition to description _and_ inherited.*/
441 char *get_peculiarity_string(peculiarity p);
443 /* The peculiarity of the class. The enumeration peculiarity is defined
445 peculiarity get_class_peculiarity (type *clss);
446 void set_class_peculiarity (type *clss, peculiarity pec);
448 /* Set and get a class' dfn --
449 @todo This is an undocumented field, subject to change! */
450 void set_class_dfn (type *clss, int dfn);
451 int get_class_dfn (type *clss);
453 /** Returns true if a type is a class type. */
454 int is_class_type(type *clss);
456 /** Returns true if low is subclass of high. */
457 bool is_subclass_of(type *low, type *high);
460 * @page struct_type Representation of a struct type
462 * Type_strct represents aggregate types that consist of a list
464 * The following attributes are private to this type kind:
465 * - member: All entities belonging to this class. This are the fields
466 * that can have any of the following types: type_class,
467 * type_struct, type_union, type_array, type_enumeration,
468 * type_pointer, type_primitive.
469 * This is a dynamic list that can be grown with an "add_" function,
471 * This is a dynamic list that can be grown with an "add_" function,
474 /** Creates a new type struct */
475 type *new_type_struct (ident *name);
476 /** Creates a new type struct with debug information. */
477 type *new_d_type_struct (ident *name, dbg_info* db);
479 /* --- manipulate private fields of struct --- */
481 /** Adds the entity as member of the struct. */
482 void add_struct_member (type *strct, entity *member);
484 /** Returns the number of members of this struct. */
485 int get_struct_n_members (type *strct);
487 /** Returns the member at position pos, 0 <= pos < n_member */
488 entity *get_struct_member (type *strct, int pos);
490 /** Returns index of member in strct, -1 if not contained. */
491 int get_struct_member_index(type *strct, entity *member);
493 /** Overwrites the member at position pos, 0 <= pos < n_member with
494 the passed entity. */
495 void set_struct_member (type *strct, int pos, entity *member);
497 /** Finds member in the list of members and removes it. */
498 void remove_struct_member (type *strct, entity *member);
500 /** Returns true if a type is a struct type. */
501 int is_struct_type(type *strct);
504 * @page method_type Representation of a method type
506 * A method type represents a method, function or procedure type.
507 * It contains a list of the parameter and result types, as these
508 * are part of the type description. These lists should not
509 * be changed by a optimization, as a change creates a new method
510 * type. Therefore optimizations should allocated new method types.
511 * The set_ routines are only for construction by a frontend.
513 * - n_params: Number of parameters to the procedure.
514 * A procedure in FIRM has only call by value parameters.
516 * - param_type: A list with the types of parameters. This list is ordered.
517 * The nth type in this list corresponds to the nth element
518 * in the parameter tuple that is a result of the start node.
519 * (See ircons.h for more information.)
522 * A list of entities (whose owner is a struct private to the
523 * method type) that represent parameters passed by value.
525 * - n_res: The number of results of the method. In general, procedures
526 * have zero results, functions one.
528 * - res_type: A list with the types of parameters. This list is ordered.
529 * The nth type in this list corresponds to the nth input to
530 * Return nodes. (See ircons.h for more information.)
533 * A list of entities (whose owner is a struct private to the
534 * method type) that represent results passed by value.
537 /* These makros define the suffixes for the types and entities used
538 to represent value parameters / results. */
539 #define VALUE_PARAMS_SUFFIX "val_param"
540 #define VALUE_RESS_SUFFIX "val_res"
542 /** Create a new method type.
544 * @param name the name (ident) of this type
545 * @param n_param the number of parameters
546 * @param n_res the number of results
548 * The arrays for the parameter and result types are not initialized by
551 type *new_type_method (ident *name, int n_param, int n_res);
553 /** Create a new method type with debug information.
555 * @param name the name (ident) of this type
556 * @param n_param the number of parameters
557 * @param n_res the number of results
558 * @param db user defined debug information
560 * The arrays for the parameter and result types are not initialized by
563 type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
565 /* -- manipulate private fields of method. -- */
567 /** Returns the number of parameters of this method. */
568 int get_method_n_params (type *method);
570 /** Returns the type of the parameter at position pos of a method. */
571 type *get_method_param_type(type *method, int pos);
572 /** Sets the type of the parameter at position pos of a method.
573 Also changes the type in the pass-by-value representation by just
574 changing the type of the corresponding entity if the representation is constructed. */
575 void set_method_param_type(type *method, int pos, type* tp);
576 /** Returns an entity that represents the copied value argument. Only necessary
577 for compounds passed by value. This information is constructed only on demand. */
578 entity *get_method_value_param_ent(type *method, int pos);
580 * Returns a type that represents the copied value arguments.
582 type *get_method_value_param_type(type *method);
584 int get_method_n_ress (type *method);
585 type *get_method_res_type(type *method, int pos);
586 /** Sets the type of the result at position pos of a method.
587 Also changes the type in the pass-by-value representation by just
588 changing the type of the corresponding entity if the representation is constructed. */
589 void set_method_res_type(type *method, int pos, type* tp);
590 /** Returns an entity that represents the copied value result. Only necessary
591 for compounds passed by value. This information is constructed only on demand. */
592 entity *get_method_value_res_ent(type *method, int pos);
594 * Returns a type that represents the copied value results.
596 type *get_method_value_res_type(type *method);
599 * this enum flags the variadicity of methods (methods with a
600 * variable amount of arguments (e.g. C's printf). Default is
603 typedef enum variadicity {
604 variadicity_non_variadic, /**< non variadic */
605 variadicity_variadic /**< variadic */
608 /** Returns the null-terminated name of this variadicity. */
609 const char *get_variadicity_name(variadicity vari);
611 /** Returns the variadicity of a method. */
612 variadicity get_method_variadicity(type *method);
614 /** Sets the variadicity of a method. */
615 void set_method_variadicity(type *method, variadicity vari);
618 * Returns the first variadic parameter index of a type.
619 * If this index was NOT set, the index of the last parameter
620 * of the method type plus one is returned for variadic functions.
621 * Non-variadic function types always return -1 here.
623 int get_method_first_variadic_param_index(type *method);
626 * Sets the first variadic parameter index. This allows to specify
627 * a complete call type (containing the type of all parameters)
628 * but still have the knowledge, which parameter must be passed as
631 void set_method_first_variadic_param_index(type *method, int index);
633 /** Returns true if a type is a method type. */
634 int is_method_type (type *method);
637 * @page union_type Representation of a union type.
639 * The union type represents union types.
640 * - n_types: Number of unioned types.
641 * - members: Entities for unioned types. Fixed length array.
642 * This is a dynamic list that can be grown with an "add_" function,
645 /** Creates a new type union. */
646 type *new_type_union (ident *name);
648 /** Creates a new type union with debug information. */
649 type *new_d_type_union (ident *name, dbg_info* db);
651 /* --- manipulate private fields of struct --- */
653 /** Returns the number of unioned types of this union */
654 int get_union_n_members (type *uni);
656 /** Adds a new entity to a union type */
657 void add_union_member (type *uni, entity *member);
659 /** Returns the entity at position pos of a union */
660 entity *get_union_member (type *uni, int pos);
662 /** Overwrites a entity at position pos in a union type. */
663 void set_union_member (type *uni, int pos, entity *member);
665 /** Finds member in the list of members and removes it. */
666 void remove_union_member (type *uni, entity *member);
668 /** Returns true if a type is a union type. */
669 int is_union_type (type *uni);
672 * @page array_type Representation of an array type
674 * The array type represents rectangular multi dimensional arrays.
675 * The constants representing the bounds must be allocated to
676 * get_const_code_irg() by setting current_ir_graph accordingly.
678 * - n_dimensions: Number of array dimensions.
679 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
680 * - *upper_bound: Upper bounds or dimensions.
681 * - *element_type: The type of the array elements.
682 * - *element_ent: An entity for the array elements to be used for
683 * element selection with Sel.
685 * Do we need several entities? One might want
686 * to select a dimension and not a single element in case of multidim arrays.
689 /** Create a new type array.
691 * Sets n_dimension to dimension and all dimension entries to NULL.
692 * Initializes order to the order of the dimensions.
693 * The entity for array elements is built automatically.
694 * Set dimension sizes after call to constructor with set_* routines.
696 type *new_type_array (ident *name, int n_dimensions,
699 /** Create a new type array with debug information.
701 * Sets n_dimension to dimension and all dimension entries to NULL.
702 * Initializes order to the order of the dimensions.
703 * The entity for array elements is built automatically.
704 * Set dimension sizes after call to constructor with set_* routines.
706 type *new_d_type_array (ident *name, int n_dimensions,
707 type *element_type, dbg_info* db);
709 /* --- manipulate private fields of array type --- */
711 /** Returns the number of array dimensions of this type. */
712 int get_array_n_dimensions (type *array);
714 /** Allocates Const nodes of mode_I for the array dimensions */
715 void set_array_bounds_int (type *array, int dimension, int lower_bound,
717 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
718 ir_node *upper_bound);
719 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
720 void set_array_lower_bound_int (type *array, int dimension, int lower_bound);
721 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
722 void set_array_upper_bound_int (type *array, int dimension, int lower_bound);
723 /* returns true if lower bound != Unknown */
724 int has_array_lower_bound (type *array, int dimension);
725 ir_node * get_array_lower_bound (type *array, int dimension);
726 int has_array_upper_bound (type *array, int dimension);
727 ir_node * get_array_upper_bound (type *array, int dimension);
729 void set_array_order (type *array, int dimension, int order);
730 int get_array_order (type *array, int dimension);
732 void set_array_element_type (type *array, type *tp);
733 type *get_array_element_type (type *array);
735 void set_array_element_entity (type *array, entity *ent);
736 entity *get_array_element_entity (type *array);
738 /** Returns true if a type is an array type. */
739 int is_array_type(type *array);
742 * @page enumeration_type Representation of an enumeration type
744 * Enumeration types need not necessarily be represented explicitly
745 * by Firm types, as the frontend can lower them to integer constants as
746 * well. For debugging purposes or similar tasks this information is useful.
748 * - *enum: The target values representing the constants used to
749 * represent individual enumerations.
750 * - *enum_nameid: Idents containing the source program name of the enumeration
753 /** Create a new type enumeration -- set the enumerators independently. */
754 type *new_type_enumeration (ident *name, int n_enums);
756 /** Create a new type enumeration with debug information -- set the enumerators independently. */
757 type *new_d_type_enumeration (ident *name, int n_enums, dbg_info* db);
759 /* --- manipulate fields of enumeration type. --- */
761 /** Returns the number of enumeration values of this enumeration */
762 int get_enumeration_n_enums (type *enumeration);
764 /** Sets the enumeration value at a given position. */
765 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
767 /** Returns the enumeration value at a given position. */
768 tarval *get_enumeration_enum (type *enumeration, int pos);
770 /** Assign an ident to an enumeration value at a given position. */
771 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
773 /** Returns the assigned ident of an enumeration value at a given position. */
774 ident *get_enumeration_nameid (type *enumeration, int pos);
776 /** Returns the assigned name of an enumeration value at a given position. */
777 const char *get_enumeration_name(type *enumeration, int pos);
779 /** Returns true if a type is a enumeration type. */
780 int is_enumeration_type (type *enumeration);
783 * @page pointer_type Representation of a pointer type
785 * The mode of the pointer type must be a mode_reference.
788 * - points_to: The type of the entity this pointer points to.
791 /** Creates a new type pointer with mode mode_p. */
792 #define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
794 /** Creates a new type pointer with given pointer mode. */
795 type *new_type_pointer_mode (ident *name, type *points_to, ir_mode *ptr_mode);
797 /** Creates a new type pointer given pointer mode and with debug information. */
798 type *new_d_type_pointer (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
800 /* --- manipulate fields of type_pointer --- */
802 /** Sets the type to which a pointer points to. */
803 void set_pointer_points_to_type (type *pointer, type *tp);
805 /** Returns the type to which a pointer points to. */
806 type *get_pointer_points_to_type (type *pointer);
808 /** Returns true if a type is a pointer type. */
809 int is_pointer_type (type *pointer);
811 /** Returns the first pointer type that has as points_to tp.
812 * Not efficient: O(#types).
813 * If not found returns unknown_type. */
814 type *find_pointer_type_to_type (type *tp);
817 * @page primitive_type Representation of a primitive type
819 * Primitive types are types that represent indivisible data values that
820 * map directly to modes. They don't have a private attribute. The
821 * important information they carry is held in the common mode field.
823 /** Creates a new primitive type. */
824 type *new_type_primitive (ident *name, ir_mode *mode);
826 /** Creates a new primitive type with debug information. */
827 type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
829 /** Returns true if a type is a primitive type. */
830 int is_primitive_type (type *primitive);
836 * This type is an auxiliary type dedicated to support type analyses.
838 * The none type represents that there is no type. The type can be used to
839 * initialize fields of type* that actually can not contain a type or that
840 * are initialized for an analysis. There exists exactly one type none.
841 * This type is not on the type list in ir_prog. It is
842 * allocated when initializing the type module.
844 * The following values are set:
847 * state: layout_fixed
850 /* A variable that contains the only none type. */
851 extern type *none_type;
852 /* Returns the none type */
853 type *get_none_type(void);
858 * This type is an auxiliary type dedicated to support type analyses.
860 * The unknown type represents that there could be a type, but it is not
861 * known. This type can be used to initialize fields before an analysis (not known
862 * yet) or to represent the top of a lattice (could not be determined). There exists
863 * exactly one type unknown. This type is not on the type list in ir_prog. It is
864 * allocated when initializing the type module.
866 * The following values are set:
868 * name: "type_unknown"
869 * state: layout_fixed
872 /* A variable that contains the only unknown type. */
873 extern type *unknown_type;
874 /* Returns the none type */
875 type *get_unknown_type(void);
879 * Checks whether a type is atomic.
880 * @param tp - any type
881 * @return true if type is primitive, pointer or enumeration
883 int is_atomic_type(type *tp);
885 /* --- Support for compound types --- */
888 * Gets the number of elements in a firm compound type.
890 * This is just a comforability function, because structs and
891 * classes can often be treated be the same code, but they have
892 * different access functions to their members.
894 * @param tp The type (must be struct, union or class).
896 * @return Number of members in the compound type.
898 int get_compound_n_members(type *tp);
901 * Gets the member of a firm compound type at position pos.
903 * @param tp The type (must be struct, union or class).
904 * @param pos The number of the member.
906 * @return The member entity at position pos.
908 * @see get_compound_n_members() for justifaction of existence.
910 entity *get_compound_member(type *tp, int pos);
913 * Checks whether a type is compound.
915 * @param tp - any type
917 * @return true if the type is class, structure, union or array type.
919 int is_compound_type(type *tp);
923 * Outputs a unique number for this type if libfirm is compiled for
924 * debugging, (configure with --enable-debug) else returns the address
925 * of the type cast to long.
927 long get_type_nr(type *tp);
929 /*******************************************************************/
931 /*******************************************************************/
934 /** Write the type and all its attributes to stdout.
936 * Writes the type and all its attributes to stdout if DEBUG_libfirm
937 * is set. Else does nothing. */
938 void dump_type (type *tp);
941 # endif /* _TYPE_H_ */