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.
40 # include "firm_common.h"
46 /* to resolve recursion between entity.h and type.h */
47 #ifndef _ENTITY_TYPEDEF_
48 #define _ENTITY_TYPEDEF_
49 typedef struct entity entity;
52 #ifndef _IR_NODE_TYPEDEF_
53 #define _IR_NODE_TYPEDEF_
54 typedef struct ir_node ir_node;
58 * An abstract data type to represent types.
60 * This is the abstract data type with which any type known in the
61 * compiled program can be represented. This includes types specified
62 * in the program as well as types defined by the language. In the
63 * view of the intermediate representation there is no difference
64 * between these types.
66 * There exist several kinds of types, arranged by the structure of
67 * the type. These are distinguished by a type opcode.
68 * A type is described by a set of attributes. Some of these attributes
69 * are common to all types, others depend on the kind of the type.
71 * The following describes the common attributes. They can only be
72 * accessed by the functions given below.
74 * The common fields are:
76 * - firm_kind: A firm_kind tag containing k_type. This is useful
77 * for dynamically checking whether a node is a type node.
78 * - type_op: A tp_op specifying the kind of the type.
79 * - mode: The mode to be used to represent the type on a machine.
80 * - name: An identifier specifying the name of the type. To be
81 * set by the frontend.
82 * - size: The size of the type, i.e. an entity of this type will
83 * occupy size bits in memory. In several cases this is
84 * determined when fixing the layout of this type (class,
85 * struct, union, array, enumeration).
86 * - alignment The alignment of the type, i.e. an entity of this type will
87 * be allocated an an address in memory with this alignment.
88 * In several cases this is determined when fixing the layout
89 * of this type (class, struct, union, array)
90 * - state: The state of the type. The state represents whether the
91 * layout of the type is undefined or fixed (values: layout_undefined
92 * or layout_fixed). Compound types can have an undefined
93 * layout. The layout of the basic types primitive and pointer
94 * is always layout_fixed. If the layout of
95 * compound types is fixed all entities must have an offset
96 * and the size of the type must be set.
97 * A fixed layout for enumeration types means that each enumeration
98 * is associated with an implementation value.
99 * - visit: A counter for walks of the type information.
100 * - link: A void* to associate some additional information with the type.
102 * These fields can only be accessed via access functions.
104 * Depending on the value of @c type_op, i.e., depending on the kind of the
105 * type the adt contains further attributes. These are documented below.
109 * @link class_type class @endlink, @link struct_type struct @endlink,
110 * @link method_type method @endlink, @link union_type union @endlink,
111 * @link array_type array @endlink, @link enumeration_type enumeration @endlink,
112 * @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
115 * mode maybe not global field??
117 #ifndef _TYPE_TYPEDEF_
118 #define _TYPE_TYPEDEF_
119 typedef struct type type;
122 # include "type_or_entity.h"
124 /** frees all entities associated with a type.
125 Does not free array entity.
126 Warning: make sure these entities are not referenced anywhere else.
128 void free_type_entities(type *tp);
130 /** Frees the memory used by the type.
132 * Removes the type from the type list. Does not free the entities
133 * belonging to the type, except for the array element entity. Does
134 * not free if tp is "none" or "unknown". Frees entities in value
135 * param subtypes of method types!!! Make sure these are not
136 * referenced any more. Further make sure there is no pointer type
137 * that refers to this type. */
138 void free_type(type *tp);
140 const tp_op*get_type_tpop(const type *tp);
141 ident* get_type_tpop_nameid(const type *tp);
142 const char* get_type_tpop_name(const type *tp);
143 tp_opcode get_type_tpop_code(const type *tp);
145 ident* get_type_ident(const type *tp);
146 void set_type_ident(type *tp, ident* id);
147 const char* get_type_name(const type *tp);
149 /** The state of the type layout. */
151 layout_undefined, /**< The layout of this type is not defined.
152 Address computation to access fields is not
153 possible, fields must be accessed by Sel
154 nodes. This is the default value except for
155 pointer, primitive and method types. */
156 layout_fixed /**< The layout is fixed, all component/member entities
157 have an offset assigned. Size of the type is known.
158 Arrays can be accessed by explicit address
159 computation. Default for pointer, primitive and method
163 /** Returns the type layout state of a type. */
164 type_state get_type_state(const type *tp);
166 /** Sets the type layout state of a type.
168 * For primitives, pointer and method types the layout is always fixed.
169 * This call is legal but has no effect.
171 void set_type_state(type *tp, type_state state);
173 /** Returns the mode of a type.
175 * Returns NULL for all non atomic types.
177 ir_mode* get_type_mode(const type *tp);
179 /** Sets the mode of a type.
181 * Only has an effect on primitive, enumeration and pointer types.
183 void set_type_mode(type *tp, ir_mode* m);
185 /** Returns the size of a type in bytes, returns -1 if the size is NOT
186 * a byte size, ie not dividable by 8. */
187 int get_type_size_bytes(const type *tp);
189 /** Returns the size of a type in bits. */
190 int get_type_size_bits(const type *tp);
192 /** Sets the size of a type in bytes.
194 * For primitive, enumeration, pointer and method types the size
195 * is always fixed. This call is legal but has no effect.
197 void set_type_size_bytes(type *tp, int size);
199 /** Sets the size of a type in bits.
201 * For primitive, enumeration, pointer and method types the size
202 * is always fixed. This call is legal but has no effect.
204 void set_type_size_bits(type *tp, int size);
206 /** Returns the alignment of a type in bytes, returns -1 if the alignment is NOT
207 * a byte size, ie not dividable by 8. Calls get_type_alignment_bits(). */
208 int get_type_alignment_bytes(type *tp);
210 /** Returns the alignment of a type in bits. If the alignment of a type is
211 * not set, it is calculated here according to the following rules:
212 * 1.) if a type has a mode, the alignment is the mode size.
213 * 2.) compound types have the alignment of it's biggest member.
214 * 3.) array types have the alignment of its element type.
215 * 4.) method types return 0 here.
216 * 5.) all other types return 8 here (i.e. aligned at byte).
218 int get_type_alignment_bits(type *tp);
220 /** Sets the alignment of a type in bytes. */
221 void set_type_alignment_bytes(type *tp, int size);
223 /** Sets the alignment of a type in bits.
225 * For method types the alignment is always fixed.
226 * This call is legal but has no effect.
228 void set_type_alignment_bits(type *tp, int size);
230 unsigned long get_type_visited(const type *tp);
231 void set_type_visited(type *tp, unsigned long num);
232 /* Sets visited field in type to type_visited. */
233 void mark_type_visited(type *tp);
234 /* @@@ name clash!! int type_visited(const type *tp); */
235 int type_not_visited(const type *tp);
237 void* get_type_link(const type *tp);
238 void set_type_link(type *tp, void *l);
241 * Visited flag to traverse the type information.
243 * Increase this flag by one before traversing the type information.
244 * Mark type nodes as visited by set_type_visited(type, type_visited).
245 * Check whether node was already visited by comparing get_type_visited(type)
247 * Or use the function to walk all types.
251 extern unsigned long type_visited;
252 void set_master_type_visited(unsigned long val);
253 unsigned long get_master_type_visited(void);
254 void inc_master_type_visited(void);
257 * Checks whether a pointer points to a type.
259 * @param thing an arbitrary pointer
262 * true if the thing is a type, else false
264 int is_type (const void *thing);
267 * Checks whether two types are structural equal.
269 * @param st pointer type
270 * @param lt pointer type
273 * true if the types are equal, else false.
274 * Types are equal if :
275 * - they are the same type kind
276 * - they have the same name
277 * - they have the same mode (if applicable)
278 * - they have the same type_state and, ev., the same size
279 * - they are class types and have
280 * - the same members (see same_entity in entity.h)
281 * - the same supertypes -- the C-pointers are compared --> no recursive call.
282 * - the same number of subtypes. Subtypes are not compared,
283 * as this could cause a cyclic test.
284 * - the same peculiarity
285 * - they are structure types and have the same members
286 * - they are method types and have
287 * - the same parameter types
288 * - the same result types
289 * - they are union types and have the same members
290 * - they are array types and have
291 * - the same number of dimensions
292 * - the same dimension bounds
293 * - the same dimension order
294 * - the same element type
295 * - they are enumeration types and have the same enumerator names
296 * - they are pointer types and have the identical points_to type
297 * (i.e., the same C-struct to represent the type, type_id is skipped.
298 * This is to avoid endless recursions; with pointer types circlic
299 * type graphs are possible.)
301 int equal_type(type *tpy1, type *typ2);
304 * Checks whether two types are structural comparable.
306 * @param st pointer type
307 * @param lt pointer type
310 * true if type st is smaller than type lt, i.e. whenever
311 * lt is expected a st can be used.
313 * - they are the same type kind
314 * - mode(st) < mode (lt) (if applicable)
315 * - they are class types and st is (transitive) subtype of lt,
316 * - they are structure types and
317 * - the members of st have exactly one counterpart in lt with the same name,
318 * - the counterpart has a bigger type.
319 * - they are method types and have
320 * - the same number of parameter and result types,
321 * - the parameter types of st are smaller than those of lt,
322 * - the result types of st are smaller than those of lt
323 * - they are union types and have the members of st have exactly one
324 * @return counterpart in lt and the type is smaller
325 * - they are array types and have
326 * - the same number of dimensions
327 * - all bounds of lt are bound of st
328 * - the same dimension order
329 * - the same element type
331 * - the element type of st is smaller than that of lt
332 * - the element types have the same size and fixed layout.
333 * - they are enumeration types and have the same enumerator names
334 * - they are pointer types and have the points_to type of st is
335 * @return smaller than the points_to type of lt.
338 int smaller_type (type *st, type *lt);
341 * @page class_type Representation of a class type
343 * If the type opcode is set to type_class the type represents class
344 * types. A list of fields and methods is associated with a class.
345 * Further a class can inherit from and bequest to other classes.
347 * The following attributes are private to this type kind:
348 * - member: All entities belonging to this class. This are methode entities
349 * which have type_method or fields that can have any of the
350 * following type kinds: type_class, type_struct, type_union,
351 * type_array, type_enumeration, type_pointer, type_primitive.
353 * The following two are dynamic lists that can be grown with an "add_" function,
356 * - subtypes: A list of direct subclasses.
358 * - supertypes: A list of direct superclasses.
360 * - peculiarity: The peculiarity of this class. If the class is of peculiarity
361 * "description" it only is a description of requirements to a class,
362 * as, e.g., a Java interface. The class will never be allocated.
363 * Peculiarity inherited is only possible for entities. An entity
364 * is of peculiarity inherited if the compiler generated the entity
365 * to explicitly resolve inheritance. An inherited method entity has
367 * Values: description, existent, inherited. Default: existent.
371 /** Creates a new class type. */
372 type *new_type_class (ident *name);
374 /** Creates a new class type with debug information. */
375 type *new_d_type_class (ident *name, dbg_info *db);
377 /* --- manipulate private fields of class type --- */
379 /** Adds the entity as member of the class. */
380 void add_class_member (type *clss, entity *member);
382 /** Returns the number of members of this class. */
383 int get_class_n_members (const type *clss);
385 /** Returns the member at position pos, 0 <= pos < n_member */
386 entity *get_class_member (const type *clss, int pos);
388 /** Returns index of mem in clss, -1 if not contained. */
389 int get_class_member_index(type *clss, entity *mem);
391 /** Finds the member with name 'name'. If several members with the same
392 name returns one of them. Returns NULL if no member found. */
393 entity *get_class_member_by_name(type *clss, ident *name);
395 /** Overwrites the member at position pos, 0 <= pos < n_member with
396 the passed entity. */
397 void set_class_member (type *clss, entity *member, int pos);
399 /** Replaces complete member list in class type by the list passed.
400 Copies the list passed. This function is necessary to reduce the number of members.
401 members is an array of entities, num the size of this array. Sets all
402 owners of the members passed to clss. */
403 void set_class_members (type *clss, entity *members[], int arity);
405 /** Finds member in the list of members and removes it.
406 Shrinks the member list, so iterate from the end!!!
407 Does not deallocate the entity. */
408 void remove_class_member(type *clss, entity *member);
411 /** Adds subtype as subtype to clss.
412 Checks whether clss is a supertype of subtype. If not
413 adds also clss as supertype to subtype. */
414 void add_class_subtype (type *clss, type *subtype);
416 /** Returns the number of subtypes */
417 int get_class_n_subtypes (const type *clss);
419 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
420 type *get_class_subtype (type *clss, int pos);
422 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
423 Does not set the corresponding supertype relation for subtype: this might
424 be a different position! */
425 void set_class_subtype (type *clss, type *subtype, int pos);
427 /** Finds subtype in the list of subtypes and removes it */
428 void remove_class_subtype(type *clss, type *subtype);
431 /** Adds supertype as supertype to class.
432 Checks whether clss is a subtype of supertype. If not
433 adds also clss as subtype to supertype. */
434 void add_class_supertype (type *clss, type *supertype);
436 /** Returns the number of supertypes */
437 int get_class_n_supertypes (const type *clss);
439 /** Returns the index of an supertype in a type. */
440 int get_class_supertype_index(type *clss, type *super_clss);
442 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
443 type *get_class_supertype (type *clss, int pos);
445 /** Sets the supertype at position pos, 0 <= pos < n_subtype.
446 Does not set the corresponding subtype relation for supertype: this might
447 be a different position! */
448 void set_class_supertype (type *clss, type *supertype, int pos);
450 /** Finds supertype in the list of supertypes and removes it */
451 void remove_class_supertype(type *clss, type *supertype);
453 /** This enumeration flags the peculiarity of entities and types. */
454 typedef enum peculiarity {
455 peculiarity_description, /**< Represents only a description. The entity/type is never
456 allocated, no code/data exists for this entity/type.
457 @@@ eventually rename to descriptive (adjective as the others!)*/
458 peculiarity_inherited, /**< Describes explicitly that other entities are
459 inherited to the owner of this entity.
460 Overwrites must refer to at least one other
461 entity. If this is a method entity there exists
462 no irg for this entity, only for one of the
465 peculiarity_existent /**< The entity/type (can) exist.
466 @@@ eventually rename to 'real' i.e., 'echt'
467 This serves better as opposition to description _and_ inherited.*/
469 const char *get_peculiarity_string(peculiarity p);
471 /* The peculiarity of the class. The enumeration peculiarity is defined
473 peculiarity get_class_peculiarity (const type *clss);
474 void set_class_peculiarity (type *clss, peculiarity pec);
476 /* Set and get a class' dfn --
477 @todo This is an undocumented field, subject to change! */
478 void set_class_dfn (type *clss, int dfn);
479 int get_class_dfn (const type *clss);
481 /** Returns true if a type is a class type. */
482 int is_class_type(const type *clss);
484 /** Returns true if low is subclass of high. */
485 int is_subclass_of(type *low, type *high);
488 * @page struct_type Representation of a struct type
490 * Type_strct represents aggregate types that consist of a list
492 * The following attributes are private to this type kind:
493 * - member: All entities belonging to this class. This are the fields
494 * that can have any of the following types: type_class,
495 * type_struct, type_union, type_array, type_enumeration,
496 * type_pointer, type_primitive.
497 * This is a dynamic list that can be grown with an "add_" function,
499 * This is a dynamic list that can be grown with an "add_" function,
502 /** Creates a new type struct */
503 type *new_type_struct (ident *name);
504 /** Creates a new type struct with debug information. */
505 type *new_d_type_struct (ident *name, dbg_info* db);
507 /* --- manipulate private fields of struct --- */
509 /** Adds the entity as member of the struct. */
510 void add_struct_member (type *strct, entity *member);
512 /** Returns the number of members of this struct. */
513 int get_struct_n_members (const type *strct);
515 /** Returns the member at position pos, 0 <= pos < n_member */
516 entity *get_struct_member (const type *strct, int pos);
518 /** Returns index of member in strct, -1 if not contained. */
519 int get_struct_member_index(type *strct, entity *member);
521 /** Overwrites the member at position pos, 0 <= pos < n_member with
522 the passed entity. */
523 void set_struct_member (type *strct, int pos, entity *member);
525 /** Finds member in the list of members and removes it. */
526 void remove_struct_member (type *strct, entity *member);
528 /** Returns true if a type is a struct type. */
529 int is_struct_type(const type *strct);
532 * @page method_type Representation of a method type
534 * A method type represents a method, function or procedure type.
535 * It contains a list of the parameter and result types, as these
536 * are part of the type description. These lists should not
537 * be changed by a optimization, as a change creates a new method
538 * type. Therefore optimizations should allocated new method types.
539 * The set_ routines are only for construction by a frontend.
541 * - n_params: Number of parameters to the procedure.
542 * A procedure in FIRM has only call by value parameters.
544 * - param_type: A list with the types of parameters. This list is ordered.
545 * The nth type in this list corresponds to the nth element
546 * in the parameter tuple that is a result of the start node.
547 * (See ircons.h for more information.)
550 * A list of entities (whose owner is a struct private to the
551 * method type) that represent parameters passed by value.
553 * - n_res: The number of results of the method. In general, procedures
554 * have zero results, functions one.
556 * - res_type: A list with the types of parameters. This list is ordered.
557 * The nth type in this list corresponds to the nth input to
558 * Return nodes. (See ircons.h for more information.)
561 * A list of entities (whose owner is a struct private to the
562 * method type) that represent results passed by value.
565 /* These macros define the suffixes for the types and entities used
566 to represent value parameters / results. */
567 #define VALUE_PARAMS_SUFFIX "val_param"
568 #define VALUE_RESS_SUFFIX "val_res"
570 /** Create a new method type.
572 * @param name the name (ident) of this type
573 * @param n_param the number of parameters
574 * @param n_res the number of results
576 * The arrays for the parameter and result types are not initialized by
579 type *new_type_method (ident *name, int n_param, int n_res);
581 /** Create a new method type with debug information.
583 * @param name the name (ident) of this type
584 * @param n_param the number of parameters
585 * @param n_res the number of results
586 * @param db user defined debug information
588 * The arrays for the parameter and result types are not initialized by
591 type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
593 /* -- manipulate private fields of method. -- */
595 /** Returns the number of parameters of this method. */
596 int get_method_n_params (const type *method);
598 /** Returns the type of the parameter at position pos of a method. */
599 type *get_method_param_type(type *method, int pos);
600 /** Sets the type of the parameter at position pos of a method.
601 Also changes the type in the pass-by-value representation by just
602 changing the type of the corresponding entity if the representation is constructed. */
603 void set_method_param_type(type *method, int pos, type* tp);
604 /** Returns an entity that represents the copied value argument. Only necessary
605 for compounds passed by value. This information is constructed only on demand. */
606 entity *get_method_value_param_ent(type *method, int pos);
608 * Returns a type that represents the copied value arguments.
610 type *get_method_value_param_type(const type *method);
612 int get_method_n_ress (const type *method);
613 type *get_method_res_type(type *method, int pos);
614 /** Sets the type of the result at position pos of a method.
615 Also changes the type in the pass-by-value representation by just
616 changing the type of the corresponding entity if the representation is constructed. */
617 void set_method_res_type(type *method, int pos, type* tp);
618 /** Returns an entity that represents the copied value result. Only necessary
619 for compounds passed by value. This information is constructed only on demand. */
620 entity *get_method_value_res_ent(type *method, int pos);
623 * Returns a type that represents the copied value results.
625 type *get_method_value_res_type(const type *method);
628 * this enum flags the variadicity of methods (methods with a
629 * variable amount of arguments (e.g. C's printf). Default is
632 typedef enum variadicity {
633 variadicity_non_variadic, /**< non variadic */
634 variadicity_variadic /**< variadic */
637 /** Returns the null-terminated name of this variadicity. */
638 const char *get_variadicity_name(variadicity vari);
640 /** Returns the variadicity of a method. */
641 variadicity get_method_variadicity(const type *method);
643 /** Sets the variadicity of a method. */
644 void set_method_variadicity(type *method, variadicity vari);
647 * Returns the first variadic parameter index of a type.
648 * If this index was NOT set, the index of the last parameter
649 * of the method type plus one is returned for variadic functions.
650 * Non-variadic function types always return -1 here.
652 int get_method_first_variadic_param_index(const type *method);
655 * Sets the first variadic parameter index. This allows to specify
656 * a complete call type (containing the type of all parameters)
657 * but still have the knowledge, which parameter must be passed as
660 void set_method_first_variadic_param_index(type *method, int index);
662 /** Returns true if a type is a method type. */
663 int is_method_type (const type *method);
666 * @page union_type Representation of a union type.
668 * The union type represents union types.
669 * - n_types: Number of unioned types.
670 * - members: Entities for unioned types. Fixed length array.
671 * This is a dynamic list that can be grown with an "add_" function,
674 /** Creates a new type union. */
675 type *new_type_union (ident *name);
677 /** Creates a new type union with debug information. */
678 type *new_d_type_union (ident *name, dbg_info* db);
680 /* --- manipulate private fields of struct --- */
682 /** Returns the number of unioned types of this union */
683 int get_union_n_members (const type *uni);
685 /** Adds a new entity to a union type */
686 void add_union_member (type *uni, entity *member);
688 /** Returns the entity at position pos of a union */
689 entity *get_union_member (const type *uni, int pos);
691 /** Overwrites a entity at position pos in a union type. */
692 void set_union_member (type *uni, int pos, entity *member);
694 /** Finds member in the list of members and removes it. */
695 void remove_union_member (type *uni, entity *member);
697 /** Returns true if a type is a union type. */
698 int is_union_type (const type *uni);
701 * @page array_type Representation of an array type
703 * The array type represents rectangular multi dimensional arrays.
704 * The constants representing the bounds must be allocated to
705 * get_const_code_irg() by setting current_ir_graph accordingly.
707 * - n_dimensions: Number of array dimensions.
708 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
709 * - *upper_bound: Upper bounds or dimensions.
710 * - *element_type: The type of the array elements.
711 * - *element_ent: An entity for the array elements to be used for
712 * element selection with Sel.
714 * Do we need several entities? One might want
715 * to select a dimension and not a single element in case of multi
716 * dimensional arrays.
719 /** Create a new type array.
721 * Sets n_dimension to dimension and all dimension entries to NULL.
722 * Initializes order to the order of the dimensions.
723 * The entity for array elements is built automatically.
724 * Set dimension sizes after call to constructor with set_* routines.
726 type *new_type_array (ident *name, int n_dimensions,
729 /** Create a new type array with debug information.
731 * Sets n_dimension to dimension and all dimension entries to NULL.
732 * Initializes order to the order of the dimensions.
733 * The entity for array elements is built automatically.
734 * Set dimension sizes after call to constructor with set_* routines.
735 * A legal array type must have at least one dimension set.
737 type *new_d_type_array (ident *name, int n_dimensions,
738 type *element_type, dbg_info* db);
740 /* --- manipulate private fields of array type --- */
742 /** Returns the number of array dimensions of this type. */
743 int get_array_n_dimensions (const type *array);
745 /** Allocates Const nodes of mode_I for the array dimensions */
746 void set_array_bounds_int (type *array, int dimension, int lower_bound,
748 void set_array_bounds (type *array, int dimension, ir_node *lower_bound,
749 ir_node *upper_bound);
750 void set_array_lower_bound (type *array, int dimension, ir_node *lower_bound);
751 void set_array_lower_bound_int (type *array, int dimension, int lower_bound);
752 void set_array_upper_bound (type *array, int dimension, ir_node *upper_bound);
753 void set_array_upper_bound_int (type *array, int dimension, int lower_bound);
754 /** returns true if lower bound != Unknown */
755 int has_array_lower_bound (const type *array, int dimension);
756 ir_node * get_array_lower_bound (const type *array, int dimension);
757 /** Works only if bound is Const node with tarval that can be converted to long. */
758 long get_array_lower_bound_int (const type *array, int dimension);
759 /** returns true if lower bound != Unknown */
760 int has_array_upper_bound (const type *array, int dimension);
761 ir_node * get_array_upper_bound (const type *array, int dimension);
762 /** Works only if bound is Const node with tarval that can be converted to long. */
763 long get_array_upper_bound_int (const type *array, int dimension);
765 void set_array_order (type *array, int dimension, int order);
766 int get_array_order (const type *array, int dimension);
768 void set_array_element_type (type *array, type *tp);
769 type *get_array_element_type (type *array);
771 void set_array_element_entity (type *array, entity *ent);
772 entity *get_array_element_entity (const type *array);
774 /** Returns true if a type is an array type. */
775 int is_array_type(const type *array);
778 * @page enumeration_type Representation of an enumeration type
780 * Enumeration types need not necessarily be represented explicitly
781 * by Firm types, as the frontend can lower them to integer constants as
782 * well. For debugging purposes or similar tasks this information is useful.
784 * - *enum: The target values representing the constants used to
785 * represent individual enumerations.
786 * - *enum_nameid: Idents containing the source program name of the enumeration
789 /** Create a new type enumeration -- set the enumerators independently. */
790 type *new_type_enumeration (ident *name, int n_enums);
792 /** Create a new type enumeration with debug information -- set the enumerators independently. */
793 type *new_d_type_enumeration (ident *name, int n_enums, dbg_info* db);
795 /* --- manipulate fields of enumeration type. --- */
797 /** Returns the number of enumeration values of this enumeration */
798 int get_enumeration_n_enums (const type *enumeration);
800 /** Sets the enumeration value at a given position. */
801 void set_enumeration_enum (type *enumeration, int pos, tarval *con);
803 /** Returns the enumeration value at a given position. */
804 tarval *get_enumeration_enum (const type *enumeration, int pos);
806 /** Assign an ident to an enumeration value at a given position. */
807 void set_enumeration_nameid (type *enumeration, int pos, ident *id);
809 /** Returns the assigned ident of an enumeration value at a given position. */
810 ident *get_enumeration_nameid (const type *enumeration, int pos);
812 /** Returns the assigned name of an enumeration value at a given position. */
813 const char *get_enumeration_name(const type *enumeration, int pos);
815 /** Returns true if a type is a enumeration type. */
816 int is_enumeration_type (const type *enumeration);
819 * @page pointer_type Representation of a pointer type
821 * The mode of the pointer type must be a mode_reference.
824 * - points_to: The type of the entity this pointer points to.
827 /** Creates a new type pointer with mode mode_p. */
828 #define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
830 /** Creates a new type pointer with given pointer mode. */
831 type *new_type_pointer_mode (ident *name, type *points_to, ir_mode *ptr_mode);
833 /** Creates a new type pointer given pointer mode and with debug information. */
834 type *new_d_type_pointer (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
836 /* --- manipulate fields of type_pointer --- */
838 /** Sets the type to which a pointer points to. */
839 void set_pointer_points_to_type (type *pointer, type *tp);
841 /** Returns the type to which a pointer points to. */
842 type *get_pointer_points_to_type (type *pointer);
844 /** Returns true if a type is a pointer type. */
845 int is_pointer_type (const type *pointer);
847 /** Returns the first pointer type that has as points_to tp.
848 * Not efficient: O(#types).
849 * If not found returns unknown_type. */
850 type *find_pointer_type_to_type (type *tp);
853 * @page primitive_type Representation of a primitive type
855 * Primitive types are types that represent indivisible data values that
856 * map directly to modes. They don't have a private attribute. The
857 * important information they carry is held in the common mode field.
859 /** Creates a new primitive type. */
860 type *new_type_primitive (ident *name, ir_mode *mode);
862 /** Creates a new primitive type with debug information. */
863 type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
865 /** Returns true if a type is a primitive type. */
866 int is_primitive_type (const type *primitive);
872 * This type is an auxiliary type dedicated to support type analyses.
874 * The none type represents that there is no type. The type can be used to
875 * initialize fields of type* that actually can not contain a type or that
876 * are initialized for an analysis. There exists exactly one type none.
877 * This type is not on the type list in ir_prog. It is
878 * allocated when initializing the type module.
880 * The following values are set:
883 * state: layout_fixed
886 /* A variable that contains the only none type. */
887 extern type *none_type;
888 /* Returns the none type */
889 type *get_none_type(void);
894 * This type is an auxiliary type dedicated to support type analyses.
896 * The unknown type represents that there could be a type, but it is not
897 * known. This type can be used to initialize fields before an analysis (not known
898 * yet) or to represent the top of a lattice (could not be determined). There exists
899 * exactly one type unknown. This type is not on the type list in ir_prog. It is
900 * allocated when initializing the type module.
902 * The following values are set:
904 * name: "type_unknown"
905 * state: layout_fixed
908 /* A variable that contains the only unknown type. */
909 extern type *unknown_type;
910 /* Returns the unknown type */
911 type *get_unknown_type(void);
915 * Checks whether a type is atomic.
916 * @param tp - any type
917 * @return true if type is primitive, pointer or enumeration
919 int is_atomic_type(const type *tp);
921 /* --- Support for compound types --- */
924 * Gets the number of elements in a firm compound type.
926 * This is just a comforability function, because structs and
927 * classes can often be treated be the same code, but they have
928 * different access functions to their members.
930 * @param tp The type (must be struct, union or class).
932 * @return Number of members in the compound type.
934 int get_compound_n_members(const type *tp);
937 * Gets the member of a firm compound type at position pos.
939 * @param tp The type (must be struct, union or class).
940 * @param pos The number of the member.
942 * @return The member entity at position pos.
944 * @see get_compound_n_members() for justifaction of existence.
946 entity *get_compound_member(const type *tp, int pos);
949 * Checks whether a type is compound.
951 * @param tp - any type
953 * @return true if the type is class, structure, union or array type.
955 int is_compound_type(const type *tp);
959 * Outputs a unique number for this type if libfirm is compiled for
960 * debugging, (configure with --enable-debug) else returns the address
961 * of the type cast to long.
963 long get_type_nr(const type *tp);
965 /*******************************************************************/
967 /*******************************************************************/
972 # endif /* _TYPE_H_ */