Some access routines for visited flags in entity.h, irnode.h,
[libfirm] / ir / tr / type_t.h
1
2 /* $Id$ */
3
4 # ifndef _TYPE_T_H_
5 # define _TYPE_T_H_
6
7 # include "type.h"
8
9 /****h* libfirm/type_t.h
10  *
11  * NAME
12  *   file type_t.h
13  * COPYRIGHT
14  *   (C) 2001 by Universitaet Karlsruhe
15  * AUTHORS
16  *   Goetz Lindenmaier
17  * NOTES
18  *   This file contains the datatypes hidden in type.h.
19  * SEE ALSO
20  *   type.h tpop_t.h tpop.h
21  *****
22  */
23
24 typedef struct {
25   entity **members;    /* fields and methods of this class */
26   type   **subtypes;   /* direct subtypes */
27   type   **supertypes; /* direct supertypes */
28 } cls_attr;
29
30 typedef struct {
31   entity **members;    /* fields of this struct. No method entities
32                           allowed. */
33 } stc_attr;
34
35 typedef struct {
36   int n_params;        /* number of parameters */
37   type **param_type;   /* code generation needs this information.
38                           @@@ Should it be generated by the frontend,
39                           or does this impose unnecessary work for
40                           optimizations that change the parameters of
41                           methods? */
42   int n_res;           /* number of results */
43   type **res_type;     /* array with result types */
44 } mtd_attr;
45
46 typedef struct {
47   int     n_types;
48   /* type  **unioned_type; * a list of unioned types. */
49   /* ident **delim_names;  * names of the union delimiters. */
50   entity **members;    /* fields of this union. No method entities
51                           allowed.  */
52
53 } uni_attr;
54
55 typedef struct {
56   int   n_dimensions;  /* Number of array dimensions.  */
57   ir_node **lower_bound;   /* Lower bounds of dimensions.  Usually all 0. */
58   ir_node **upper_bound;   /* Upper bounds or dimensions. */
59   type *element_type;  /* The type of the array elements. */
60   entity *element_ent; /* Entity for the array elements, to be used for
61                           element selection with Sel. */
62 } arr_attr;
63
64 typedef struct {
65   int      n_enums;    /* Number of enumerators. */
66   tarval **enumer;     /* Contains all constants that represent a member
67                           of the enum -- enumerators. */
68   ident  **enum_nameid;/* Contains the names of the enum fields as specified by
69                           the source program */
70 } enm_attr;
71
72 typedef struct {
73   type *points_to;     /* The type of the enitity the pointer points to. */
74 } ptr_attr;
75
76 /*
77 typedef struct {        * No private attr yet. *
78 } pri_attr;
79 */
80
81 /*
82 typedef struct {        * No private attr, must be smaller than others! *
83 } id_attr;
84 */
85
86
87 typedef union {
88   cls_attr ca;
89   stc_attr sa;
90   mtd_attr ma;
91   uni_attr ua;
92   arr_attr aa;
93   enm_attr ea;
94   ptr_attr pa;
95 } tp_attr;
96
97 struct type {
98   firm_kind kind;
99   tp_op *type_op;
100   ir_mode *mode;
101   ident *name;
102   type_state state;        /* Represents the types state: layout undefined or
103                               fixed. */
104   int size;                /* Size of an entity of this type.  This is determined
105                               when fixing the layout of this class.  Size must be
106                               given in bytes. */
107   unsigned long visit;     /* visited counter for walks of the type information */
108   void *link;              /* holds temporary data - like in irnode_t.h */
109   tp_attr attr;            /* type kind specific fields. This must be the last
110                               entry in this struct!  Varying size! */
111 };
112
113 /****f* type_t.h/new_type
114  *
115  * NAME
116  *   new_type - creates a new type representation
117  * SYNOPSIS
118  *  type *new_type(tp_op *type_op, ir_mode *mode, ident* name);
119  * INPUTS
120  *   type_op - the kind of this type.  May not be type_id.
121  *   mode    - the mode to be used for this type, may be NULL
122  *   name    - an ident for the name of this type.
123  * RESULT
124  *   a new type of the given type.  The remaining private attributes are not
125  *   initalized.  The type is in state layout_undefined.
126  ***
127  */
128 inline type *
129 new_type(tp_op *type_op,
130          ir_mode *mode,
131          ident* name);
132 void free_type_attrs       (type *tp);
133
134 inline void free_class_attrs      (type *clss);
135 inline void free_struct_attrs     (type *strct);
136 inline void free_method_attrs     (type *method);
137 inline void free_union_attrs      (type *uni);
138 inline void free_array_attrs      (type *array);
139 inline void free_enumeration_attrs(type *enumeration);
140 inline void free_pointer_attrs    (type *pointer);
141 inline void free_primitive_attrs  (type *primitive);
142
143
144 # endif /* _TYPE_T_H_ */