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.
130 * Removes the type from the type list. Does not free the entities
131 * belonging to the type, except for the array element entity. Does
132 * not free if tp is "none" or "unknown". Frees entities in value
133 * param subtypes of method types!!! Make sure these are not
134 * referenced any more. Further make sure there is no pointer type
135 * that refers to this type. */
136 void free_type(type *tp);
138 tp_op* get_type_tpop(type *tp);
139 ident* get_type_tpop_nameid(type *tp);
140 const char* get_type_tpop_name(type *tp);
141 tp_opcode get_type_tpop_code(type *tp);
143 ident* get_type_ident(type *tp);
144 void set_type_ident(type *tp, ident* id);
145 const char* get_type_name(type *tp);
147 /** The state of the type layout. */
149 layout_undefined, /**< The layout of this type is not defined.
150 Address computation to access fields is not
151 possible, fields must be accessed by Sel
152 nodes. This is the default value except for
153 pointer, primitive and method types. */
154 layout_fixed /**< The layout is fixed, all component/member entities
155 have an offset assigned. Size of the type is known.
156 Arrays can be accessed by explicit address
157 computation. Default for pointer, primitive and method
161 /** Returns the type layout state of a type. */
162 type_state get_type_state(type *tp);
164 /** Sets the type layout state of a type.
166 * For primitives, pointer and method types the layout is always fixed.
167 * This call is legal but has no effect.
169 void set_type_state(type *tp, type_state state);
171 /** Returns the mode of a type.
173 * Returns NULL for all non atomic types.
175 ir_mode* get_type_mode(type *tp);
177 /** Sets the mode of a type.
179 * Only has an effect on primitive, enumeration and pointer types.
181 void set_type_mode(type *tp, ir_mode* m);
183 /** Returns the size of a type in bytes, retuns -1 if the size is NOT
184 * a byte size, ie not dividable by 8. */
185 int get_type_size_bytes(type *tp);
187 /** Returns the size of a type in bits. */
188 int get_type_size_bits(type *tp);
190 /** Sets the size of a type in bytes.
192 * For primitive, enumeration, pointer and method types the size
193 * is always fixed. This call is legal but has no effect.
195 void set_type_size_bytes(type *tp, int size);
197 /** Sets the size of a type in bits.
199 * For primitive, enumeration, pointer and method types the size
200 * is always fixed. This call is legal but has no effect.
202 void set_type_size_bits(type *tp, int size);
205 unsigned long get_type_visited(type *tp);
206 void set_type_visited(type *tp, unsigned long num);
207 /* Sets visited field in type to type_visited. */
208 void mark_type_visited(type *tp);
209 /* @@@ name clash!! int type_visited(type *tp); */
210 int type_not_visited(type *tp);
212 void* get_type_link(type *tp);
213 void set_type_link(type *tp, void *l);
216 * Visited flag to traverse the type information.
218 * Increase this flag by one before traversing the type information.
219 * Mark type nodes as visited by set_type_visited(type, type_visited).
220 * Check whether node was already visited by comparing get_type_visited(type)
222 * Or use the function to walk all types.
226 extern unsigned long type_visited;
227 void set_master_type_visited(unsigned long val);
228 unsigned long get_master_type_visited(void);
229 void inc_master_type_visited(void);
232 * Checks whether a pointer points to a type.
234 * @param thing an arbitrary pointer
237 * true if the thing is a type, else false
239 int is_type (void *thing);
242 * Checks whether two types are structural equal.
244 * @param st pointer type
245 * @param lt pointer type
248 * true if the types are equal, else false.
249 * Types are equal if :
250 * - they are the same type kind
251 * - they have the same name
252 * - they have the same mode (if applicable)
253 * - they have the same type_state and, ev., the same size
254 * - they are class types and have
255 * - the same members (see same_entity in entity.h)
256 * - the same supertypes -- the C-pointers are compared --> no recursive call.
257 * - the same number of subtypes. Subtypes are not compared,
258 * as this could cause a cyclic test.
259 * - the same peculiarity
260 * - they are structure types and have the same members
261 * - they are method types and have
262 * - the same parameter types
263 * - the same result types
264 * - they are union types and have the same members
265 * - they are array types and have
266 * - the same number of dimensions
267 * - the same dimension bounds
268 * - the same dimension order
269 * - the same element type
270 * - they are enumeration types and have the same enumerator names
271 * - they are pointer types and have the identical points_to type
272 * (i.e., the same C-struct to represent the type, type_id is skipped.
273 * This is to avoid endless recursions; with pointer types circlic
274 * type graphs are possible.)
276 bool equal_type(type *tpy1, type *typ2);
279 * Checks whether two types are structural comparable.
281 * @param st pointer type
282 * @param lt pointer type
285 * true if type st is smaller than type lt, i.e. whenever
286 * lt is expected a st can be used.
288 * - they are the same type kind
289 * - mode(st) < mode (lt) (if applicable)
290 * - they are class types and st is (transitive) subtype of lt,
291 * - they are structure types and
292 * - the members of st have exactly one counterpart in lt with the same name,
293 * - the counterpart has a bigger type.
294 * - they are method types and have
295 * - the same number of parameter and result types,
296 * - the parameter types of st are smaller than those of lt,
297 * - the result types of st are smaller than those of lt
298 * - they are union types and have the members of st have exactly one
299 * @return counterpart in lt and the type is smaller
300 * - they are array types and have
301 * - the same number of dimensions
302 * - all bounds of lt are bound of st
303 * - the same dimension order
304 * - the same element type
306 * - the element type of st is smaller than that of lt
307 * - the element types have the same size and fixed layout.
308 * - they are enumeration types and have the same enumerator names
309 * - they are pointer types and have the points_to type of st is
310 * @return smaller than the points_to type of lt.
313 bool smaller_type (type *st, type *lt);
316 * @page class_type Representation of a class type
318 * If the type opcode is set to type_class the type represents class
319 * types. A list of fields and methods is associated with a class.
320 * Further a class can inherit from and bequest to other classes.
322 * The following attributes are private to this type kind:
323 * - member: All entities belonging to this class. This are methode entities
324 * which have type_method or fields that can have any of the
325 * following type kinds: type_class, type_struct, type_union,
326 * type_array, type_enumeration, type_pointer, type_primitive.
328 * The following two are dynamic lists that can be grown with an "add_" function,
331 * - subtypes: A list of direct subclasses.
333 * - supertypes: A list of direct superclasses.
335 * - peculiarity: The peculiarity of this class. If the class is of peculiarity
336 * "description" it only is a description of requirememts to a class,
337 * as, e.g., a Java interface. The class will never be allocated.
338 * Peculiatity inherited is only possible for entities. An entity
339 * is of peculiarity inherited if the compiler generated the entity
340 * to explicitly resolve inheritance. An inherited method entity has
342 * Values: description, existent, inherited. Default: existent.
346 /** Creates a new class type. */
347 type *new_type_class (ident *name);
349 /** Creates a new class type with debug information. */
350 type *new_d_type_class (ident *name, dbg_info *db);
352 /* --- manipulate private fields of class type --- */
354 /** Adds the entity as member of the class. */
355 void add_class_member (type *clss, entity *member);
357 /** Returns the number of members of this class. */
358 int get_class_n_members (type *clss);
360 /** Returns the member at position pos, 0 <= pos < n_member */
361 entity *get_class_member (type *clss, int pos);
363 /** Returns index of mem in clss, -1 if not contained. */
364 int get_class_member_index(type *clss, entity *mem);
366 /** Finds the member with name 'name'. If several members with the same
367 name returns one of them. Returns NULL if no member found. */
368 entity *get_class_member_by_name(type *clss, ident *name);
370 /** Overwrites the member at position pos, 0 <= pos < n_member with
371 the passed entity. */
372 void set_class_member (type *clss, entity *member, int pos);
374 /** Replaces complete member list in class type by the list passed.
375 Copies the list passed. This function is necessary to reduce the number of members.
376 members is an array of entities, num the size of this array. Sets all
377 owners of the members passed to clss. */
378 void set_class_members (type *clss, entity *members[], int arity);
380 /** Finds member in the list of members and removes it.
381 Shrinks the member list, so iterate from the end!!!
382 Does not deallocate the entity. */
383 void remove_class_member(type *clss, entity *member);
386 /** Adds subtype as subtype to clss.
387 Checks whether clss is a supertype of subtype. If not
388 adds also clss as supertype to subtype. */
389 void add_class_subtype (type *clss, type *subtype);
391 /** Returns the number of subtypes */
392 int get_class_n_subtypes (type *clss);
394 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
395 type *get_class_subtype (type *clss, int pos);
397 /** Sets the subtype at positioin pos, 0 <= pos < n_subtype.
398 Does not set the corresponding supertype relation for subtype: this might
399 be a different position! */
400 void set_class_subtype (type *clss, type *subtype, int pos);
402 /** Finds subtype in the list of subtypes and removes it */
403 void remove_class_subtype(type *clss, type *subtype);
406 /** Adds supertype as supertype to class.
407 Checks whether clss is a subtype of supertype. If not
408 adds also clss as subtype to supertype. */
409 void add_class_supertype (type *clss, type *supertype);
411 /** Returns the number of supertypes */
412 int get_class_n_supertypes (type *clss);
414 /** Returns the index of an supertype in a type. */
415 int get_class_supertype_index(type *clss, type *super_clss);
417 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
418 type *get_class_supertype (type *clss, int pos);
420 /** Sets the supertype at postition pos, 0 <= pos < n_subtype.
421 Does not set the corresponding subtype relation for supertype: this might
422 be a different position! */
423 void set_class_supertype (type *clss, type *supertype, int pos);
425 /** Finds supertype in the list of supertypes and removes it */
426 void remove_class_supertype(type *clss, type *supertype);
428 /** This enumeration flags the peculiarity of entities and types. */
429 typedef enum peculiarity {
430 peculiarity_description, /**< Represents only a description. The entity/type is never
431 allocated, no code/data exists for this entity/type.
432 @@@ eventually rename to descriptive (adjectiv as the others!)*/
433 peculiarity_inherited, /**< Describes explicitly that other entities are
434 inherited to the owner of this entity.
435 Overwrites must refer to at least one other
436 entity. If this is a method entity there exists
437 no irg for this entity, only for one of the
440 peculiarity_existent /**< The entity/type (can) exist.
441 @@@ eventually rename to 'real' i.e., 'echt'
442 This serves better as opposition to description _and_ inherited.*/
444 char *get_peculiarity_string(peculiarity p);
446 /* The peculiarity of the class. The enumeration peculiarity is defined
448 peculiarity get_class_peculiarity (type *clss);
449 void set_class_peculiarity (type *clss, peculiarity pec);
451 /* Set and get a class' dfn --
452 @todo This is an undocumented field, subject to change! */
453 void set_class_dfn (type *clss, int dfn);
454 int get_class_dfn (type *clss);
456 /** Returns true if a type is a class type. */
457 int is_class_type(type *clss);
459 /** Returns true if low is subclass of high. */
460 bool is_subclass_of(type *low, type *high);
463 * @page struct_type Representation of a struct type
465 * Type_strct represents aggregate types that consist of a list
467 * The following attributes are private to this type kind:
468 * - member: All entities belonging to this class. This are the fields
469 * that can have any of the following types: type_class,
470 * type_struct, type_union, type_array, type_enumeration,
471 * type_pointer, type_primitive.
472 * This is a dynamic list that can be grown with an "add_" function,
474 * This is a dynamic list that can be grown with an "add_" function,
477 /** Creates a new type struct */
478 type *new_type_struct (ident *name);
479 /** Creates a new type struct with debug information. */
480 type *new_d_type_struct (ident *name, dbg_info* db);
482 /* --- manipulate private fields of struct --- */
484 /** Adds the entity as member of the struct. */
485 void add_struct_member (type *strct, entity *member);
487 /** Returns the number of members of this struct. */
488 int get_struct_n_members (type *strct);
490 /** Returns the member at position pos, 0 <= pos < n_member */
491 entity *get_struct_member (type *strct, int pos);
493 /** Returns index of member in strct, -1 if not contained. */
494 int get_struct_member_index(type *strct, entity *member);
496 /** Overwrites the member at position pos, 0 <= pos < n_member with
497 the passed entity. */
498 void set_struct_member (type *strct, int pos, entity *member);
500 /** Finds member in the list of members and removes it. */
501 void remove_struct_member (type *strct, entity *member);
503 /** Returns true if a type is a struct type. */
504 int is_struct_type(type *strct);
507 * @page method_type Representation of a method type
509 * A method type represents a method, function or procedure type.
510 * It contains a list of the parameter and result types, as these
511 * are part of the type description. These lists should not
512 * be changed by a optimization, as a change creates a new method
513 * type. Therefore optimizations should allocated new method types.
514 * The set_ routines are only for construction by a frontend.
516 * - n_params: Number of parameters to the procedure.
517 * A procedure in FIRM has only call by value parameters.
519 * - param_type: A list with the types of parameters. This list is ordered.
520 * The nth type in this list corresponds to the nth element
521 * in the parameter tuple that is a result of the start node.
522 * (See ircons.h for more information.)
525 * A list of entities (whose owner is a struct private to the
526 * method type) that represent parameters passed by value.
528 * - n_res: The number of results of the method. In general, procedures
529 * have zero results, functions one.
531 * - res_type: A list with the types of parameters. This list is ordered.
532 * The nth type in this list corresponds to the nth input to
533 * Return nodes. (See ircons.h for more information.)
536 * A list of entities (whose owner is a struct private to the
537 * method type) that represent results passed by value.
540 /* These makros define the suffixes for the types and entities used
541 to represent value parameters / results. */
542 #define VALUE_PARAMS_SUFFIX "val_param"
543 #define VALUE_RESS_SUFFIX "val_res"
545 /** Create a new method type.
547 * @param name the name (ident) of this type
548 * @param n_param the number of parameters
549 * @param n_res the number of results
551 * The arrays for the parameter and result types are not initialized by
554 type *new_type_method (ident *name, int n_param, int n_res);
556 /** Create a new method type with debug information.
558 * @param name the name (ident) of this type
559 * @param n_param the number of parameters
560 * @param n_res the number of results
561 * @param db user defined debug information
563 * The arrays for the parameter and result types are not initialized by
566 type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
568 /* -- manipulate private fields of method. -- */
570 /** Returns the number of parameters of this method. */
571 int get_method_n_params (type *method);
573 /** Returns the type of the parameter at position pos of a method. */
574 type *get_method_param_type(type *method, int pos);
575 /** Sets the type of the parameter at position pos of a method.
576 Also changes the type in the pass-by-value representation by just
577 changing the type of the corresponding entity if the representation is constructed. */
578 void set_method_param_type(type *method, int pos, type* tp);
579 /** Returns an entity that represents the copied value argument. Only necessary
580 for compounds passed by value. This information is constrnewucted only on demand. */
581 entity *get_method_value_param_ent(type *method, int pos);
583 * Returns a type that represents the copied value arguments.
585 type *get_method_value_param_type(type *method);
587 int get_method_n_ress (type *method);
588 type *get_method_res_type(type *method, int pos);
589 /** Sets the type of the result at position pos of a method.
590 Also changes the type in the pass-by-value representation by just
591 changing the type of the corresponding entity if the representation is constructed. */
592 void set_method_res_type(type *method, int pos, type* tp);
593 /** Returns an entity that represents the copied value result. Only necessary
594 for compounds passed by value. This information is constructed only on demand. */
595 entity *get_method_value_res_ent(type *method, int pos);
597 * Returns a type that represents the copied value results.
599 type *get_method_value_res_type(type *method);
602 * this enum flags the variadicity of methods (methods with a
603 * variable amount of arguments (e.g. C's printf). Default is
606 typedef enum variadicity {
607 variadicity_non_variadic, /**< non variadic */
608 variadicity_variadic /**< variadic */
611 /** Returns the null-terminated name of this variadicity. */
612 const char *get_variadicity_name(variadicity vari);
614 /** Returns the variadicity of a method. */
615 variadicity get_method_variadicity(type *method);
617 /** Sets the variadicity of a method. */
618 void set_method_variadicity(type *method, variadicity vari);
621 * Returns the first variadic parameter index of a type.
622 * If this index was NOT set, the index of the last parameter
623 * of the method type plus one is returned for variadic functions.
624 * Non-variadic function types always return -1 here.
626 int get_method_first_variadic_param_index(type *method);
629 * Sets the first variadic parameter index. This allows to specify
630 * a complete call type (containing the type of all parameters)
631 * but still have the knowledge, which parameter must be passed as
634 void set_method_first_variadic_param_index(type *method, int index);
636 /** Returns true if a type is a method type. */
637 int is_method_type (type *method);
640 * @page union_type Representation of a union type.
642 * The union type represents union types.
643 * - n_types: Number of unioned types.
644 * - members: Entities for unioned types. Fixed length array.
645 * This is a dynamic list that can be grown with an "add_" function,
648 /** Creates a new type union. */
649 type *new_type_union (ident *name);
651 /** Creates a new type union with debug information. */
652 type *new_d_type_union (ident *name, dbg_info* db);
654 /* --- manipulate private fields of struct --- */
656 /** Returns the number of unioned types of this union */
657 int get_union_n_members (type *uni);
659 /** Adds a new entity to a union type */
660 void add_union_member (type *uni, entity *member);
662 /** Returns the entity at position pos of a union */
663 entity *get_union_member (type *uni, int pos);
665 /** Overwrites a entity at position pos in a union type. */
666 void set_union_member (type *uni, int pos, entity *member);
668 /** Finds member in the list of members and removes it. */
669 void remove_union_member (type *uni, entity *member);
671 /** Returns true if a type is a union type. */
672 int is_union_type (type *uni);
675 * @page array_type Representation of an array type
677 * The array type represents rectangular multi dimensional arrays.
678 * The constants representing the bounds must be allocated to
679 * get_const_code_irg() by setting current_ir_graph accordingly.
681 * - n_dimensions: Number of array dimensions.
682 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
683 * - *upper_bound: Upper bounds or dimensions.
684 * - *element_type: The type of the array elements.
685 * - *element_ent: An entity for the array elements to be used for
686 * element selection with Sel.
688 * Do we need several entities? One might want
689 * to select a dimension and not a single element in case of multidim arrays.
692 /** Create a new type array.
694 * Sets n_dimension to dimension and all dimension entries to NULL.
695 * Initializes order to the order of the dimensions.
696 * The entity for array elements is built automatically.
697 * Set dimension sizes after call to constructor with set_* routines.
699 type *new_type_array (ident *name, int n_dimensions,
702 /** Create a new type array with debug information.
704 * Sets n_dimension to dimension and all dimension entries to NULL.
705 * Initializes order to the order of the dimensions.
706 * The entity for array elements is built automatically.
707 * Set dimension sizes after call to constructor with set_* routines.
708 * A legal array type must have at least one dimension set.
710 type *new_d_type_array (ident *name, int n_dimensions,
711 type *element_type, dbg_info* db);
713 /* --- manipulate private fields of array type --- */
715 /** Returns the number of array dimensions of this type. */
716 int get_array_n_dimensions (type *array);
718 /** Allocates Const nodes of mode_I for the array dimensions */
719 void set_array_bounds_int (type *array, int dimension, int lower_bound,
721 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
722 ir_node *upper_bound);
723 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
724 void set_array_lower_bound_int (type *array, int dimension, int lower_bound);
725 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
726 void set_array_upper_bound_int (type *array, int dimension, int lower_bound);
727 /** returns true if lower bound != Unknown */
728 int has_array_lower_bound (type *array, int dimension);
729 ir_node * get_array_lower_bound (type *array, int dimension);
730 /** Works only if bound is Const node with tarval that can be converted to long. */
731 long get_array_lower_bound_int (type *array, int dimension);
732 /** returns true if lower bound != Unknown */
733 int has_array_upper_bound (type *array, int dimension);
734 ir_node * get_array_upper_bound (type *array, int dimension);
735 /** Works only if bound is Const node with tarval that can be converted to long. */
736 long get_array_upper_bound_int (type *array, int dimension);
738 void set_array_order (type *array, int dimension, int order);
739 int get_array_order (type *array, int dimension);
741 void set_array_element_type (type *array, type *tp);
742 type *get_array_element_type (type *array);
744 void set_array_element_entity (type *array, entity *ent);
745 entity *get_array_element_entity (type *array);
747 /** Returns true if a type is an array type. */
748 int is_array_type(type *array);
751 * @page enumeration_type Representation of an enumeration type
753 * Enumeration types need not necessarily be represented explicitly
754 * by Firm types, as the frontend can lower them to integer constants as
755 * well. For debugging purposes or similar tasks this information is useful.
757 * - *enum: The target values representing the constants used to
758 * represent individual enumerations.
759 * - *enum_nameid: Idents containing the source program name of the enumeration
762 /** Create a new type enumeration -- set the enumerators independently. */
763 type *new_type_enumeration (ident *name, int n_enums);
765 /** Create a new type enumeration with debug information -- set the enumerators independently. */
766 type *new_d_type_enumeration (ident *name, int n_enums, dbg_info* db);
768 /* --- manipulate fields of enumeration type. --- */
770 /** Returns the number of enumeration values of this enumeration */
771 int get_enumeration_n_enums (type *enumeration);
773 /** Sets the enumeration value at a given position. */
774 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
776 /** Returns the enumeration value at a given position. */
777 tarval *get_enumeration_enum (type *enumeration, int pos);
779 /** Assign an ident to an enumeration value at a given position. */
780 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
782 /** Returns the assigned ident of an enumeration value at a given position. */
783 ident *get_enumeration_nameid (type *enumeration, int pos);
785 /** Returns the assigned name of an enumeration value at a given position. */
786 const char *get_enumeration_name(type *enumeration, int pos);
788 /** Returns true if a type is a enumeration type. */
789 int is_enumeration_type (type *enumeration);
792 * @page pointer_type Representation of a pointer type
794 * The mode of the pointer type must be a mode_reference.
797 * - points_to: The type of the entity this pointer points to.
800 /** Creates a new type pointer with mode mode_p. */
801 #define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
803 /** Creates a new type pointer with given pointer mode. */
804 type *new_type_pointer_mode (ident *name, type *points_to, ir_mode *ptr_mode);
806 /** Creates a new type pointer given pointer mode and with debug information. */
807 type *new_d_type_pointer (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
809 /* --- manipulate fields of type_pointer --- */
811 /** Sets the type to which a pointer points to. */
812 void set_pointer_points_to_type (type *pointer, type *tp);
814 /** Returns the type to which a pointer points to. */
815 type *get_pointer_points_to_type (type *pointer);
817 /** Returns true if a type is a pointer type. */
818 int is_pointer_type (type *pointer);
820 /** Returns the first pointer type that has as points_to tp.
821 * Not efficient: O(#types).
822 * If not found returns unknown_type. */
823 type *find_pointer_type_to_type (type *tp);
826 * @page primitive_type Representation of a primitive type
828 * Primitive types are types that represent indivisible data values that
829 * map directly to modes. They don't have a private attribute. The
830 * important information they carry is held in the common mode field.
832 /** Creates a new primitive type. */
833 type *new_type_primitive (ident *name, ir_mode *mode);
835 /** Creates a new primitive type with debug information. */
836 type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
838 /** Returns true if a type is a primitive type. */
839 int is_primitive_type (type *primitive);
845 * This type is an auxiliary type dedicated to support type analyses.
847 * The none type represents that there is no type. The type can be used to
848 * initialize fields of type* that actually can not contain a type or that
849 * are initialized for an analysis. There exists exactly one type none.
850 * This type is not on the type list in ir_prog. It is
851 * allocated when initializing the type module.
853 * The following values are set:
856 * state: layout_fixed
859 /* A variable that contains the only none type. */
860 extern type *none_type;
861 /* Returns the none type */
862 type *get_none_type(void);
867 * This type is an auxiliary type dedicated to support type analyses.
869 * The unknown type represents that there could be a type, but it is not
870 * known. This type can be used to initialize fields before an analysis (not known
871 * yet) or to represent the top of a lattice (could not be determined). There exists
872 * exactly one type unknown. This type is not on the type list in ir_prog. It is
873 * allocated when initializing the type module.
875 * The following values are set:
877 * name: "type_unknown"
878 * state: layout_fixed
881 /* A variable that contains the only unknown type. */
882 extern type *unknown_type;
883 /* Returns the none type */
884 type *get_unknown_type(void);
888 * Checks whether a type is atomic.
889 * @param tp - any type
890 * @return true if type is primitive, pointer or enumeration
892 int is_atomic_type(type *tp);
894 /* --- Support for compound types --- */
897 * Gets the number of elements in a firm compound type.
899 * This is just a comforability function, because structs and
900 * classes can often be treated be the same code, but they have
901 * different access functions to their members.
903 * @param tp The type (must be struct, union or class).
905 * @return Number of members in the compound type.
907 int get_compound_n_members(type *tp);
910 * Gets the member of a firm compound type at position pos.
912 * @param tp The type (must be struct, union or class).
913 * @param pos The number of the member.
915 * @return The member entity at position pos.
917 * @see get_compound_n_members() for justifaction of existence.
919 entity *get_compound_member(type *tp, int pos);
922 * Checks whether a type is compound.
924 * @param tp - any type
926 * @return true if the type is class, structure, union or array type.
928 int is_compound_type(type *tp);
932 * Outputs a unique number for this type if libfirm is compiled for
933 * debugging, (configure with --enable-debug) else returns the address
934 * of the type cast to long.
936 long get_type_nr(type *tp);
938 /*******************************************************************/
940 /*******************************************************************/
945 # endif /* _TYPE_H_ */