/*
- * Project: libFIRM
- * File name: ir/tr/entity_t.h
- * Purpose: Representation of all program known entities -- private header.
- * Author: Martin Trapp, Christian Schaefer
- * Modified by: Goetz Lindenmaier, Michael Beck
- * Created:
- * CVS-ID: $Id$
- * Copyright: (c) 1998-2006 Universität Karlsruhe
- * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
- */
-
-/**
- * @file entity_t.h
+ * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
*
- * entity.h: entities represent all program known objects.
+ * This file is part of libFirm.
*
- * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
*
- * An entity is the representation of program known objects in Firm.
- * The primary concept of entities is to represent members of complex
- * types, i.e., fields and methods of classes. As not all programming
- * language model all variables and methods as members of some class,
- * the concept of entities is extended to cover also local and global
- * variables, and arbitrary procedures.
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
*
- * An entity always specifies the type of the object it represents and
- * the type of the object it is a part of, the owner of the entity.
- * Originally this is the type of the class of which the entity is a
- * member.
- * The owner of local variables is the procedure they are defined in.
- * The owner of global variables and procedures visible in the whole
- * program is a universally defined class type "GlobalType". The owner
- * of procedures defined in the scope of an other procedure is the
- * enclosing procedure.
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
*/
-#ifndef _FIRM_TR_ENTITY_T_H_
-#define _FIRM_TR_ENTITY_T_H_
+/*
+ * @file entity_t.h
+ * @brief Representation of all program known entities -- private header.
+ * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
+ * @version $Id$
+ */
+#ifndef FIRM_TR_ENTITY_T_H
+#define FIRM_TR_ENTITY_T_H
#include "firm_common_t.h"
#include "firm_config.h"
int index; /**< Array index. To compute position of array elements */
ir_entity *node; /**< The accessed entity. */
} list[1]; /**< List of entity/index tuple of length len to express the
- access path. */
+ access path. */
};
/** The attributes for atomic entities. */
typedef struct atomic_ent_attr {
- ir_node *value; /**< value if entity is not of variability uninitialized.
- Only for atomic entities. */
+ ir_node *value; /**< value if entity is not of variability uninitialized.
+ Only for atomic entities. */
} atomic_ent_attr;
/** The attributes for compound entities. */
} method_ent_attr;
-/** The type of an entity. */
+/**
+ * An abstract data type to represent program entities.
+ *
+ * @see ir_type
+ */
struct ir_entity {
firm_kind kind; /**< The dynamic type tag for entity. */
ident *name; /**< The name of this entity. */
ir_type *type; /**< The type of this entity, e.g., a method type, a
basic type of the language or a class itself. */
ir_type *owner; /**< The compound type (e.g. class type) this entity belongs to. */
- ir_allocation allocation:3; /**< Distinguishes static and dynamically allocated
- entities and some further cases. */
- ir_visibility visibility:3; /**< Specifies visibility to external program
- fragments. */
- ir_variability variability:3; /**< Specifies variability of entities content. */
- ir_volatility volatility:2; /**< Specifies volatility of entities content. */
- ir_stickyness stickyness:2; /**< Specifies whether this entity is sticky. */
- ir_peculiarity peculiarity:3; /**< The peculiarity of this entity. */
+ ir_allocation allocation:3; /**< Distinguishes static and dynamically allocated
+ entities and some further cases. */
+ ir_visibility visibility:3; /**< Specifies visibility to external program fragments. */
+ ir_variability variability:3; /**< Specifies variability of entities content. */
+ ir_volatility volatility:2; /**< Specifies volatility of entities content. */
+ ir_stickyness stickyness:2; /**< Specifies whether this entity is sticky. */
+ ir_peculiarity peculiarity:3; /**< The peculiarity of this entity. */
+ ir_address_taken_state address_taken:3; /**< A flag that can be set to mark address taken entities. */
unsigned final:1; /**< If set, this entity cannot be overridden. */
unsigned compiler_gen:1; /**< If set, this entity was compiler generated. */
int offset; /**< Offset in bytes for this entity. Fixed when layout
}
static INLINE int
-_get_entity_final(const ir_entity *ent) {
+_is_entity_final(const ir_entity *ent) {
assert(ent && ent->kind == k_entity);
return (int)ent->final;
}
ent->final = final ? 1 : 0;
}
+static INLINE int
+_is_entity_compiler_generated(const ir_entity *ent) {
+ assert(ent && ent->kind == k_entity);
+ return ent->compiler_gen;
+}
+
+static INLINE void
+_set_entity_compiler_generated(ir_entity *ent, int flag) {
+ assert(ent && ent->kind == k_entity);
+ ent->compiler_gen = flag ? 1 : 0;
+}
+
+static INLINE ir_address_taken_state
+_get_entity_address_taken(const ir_entity *ent) {
+ assert(ent && ent->kind == k_entity);
+ return ent->address_taken;
+}
+
+static INLINE void
+_set_entity_address_taken(ir_entity *ent, ir_address_taken_state state) {
+ assert(ent && ent->kind == k_entity);
+ assert(ir_address_not_taken <= state && state <= ir_address_taken);
+ ent->address_taken = state;
+}
+
static INLINE int
_get_entity_offset(const ir_entity *ent) {
assert(ent && ent->kind == k_entity);
#define set_entity_peculiarity(ent, pec) _set_entity_peculiarity(ent, pec)
#define get_entity_stickyness(ent) _get_entity_stickyness(ent)
#define set_entity_stickyness(ent, stickyness) _set_entity_stickyness(ent, stickyness)
-#define get_entity_final(ent) _get_entity_final(ent)
+#define is_entity_final(ent) _is_entity_final(ent)
#define set_entity_final(ent, final) _set_entity_final(ent, final)
+#define is_entity_compiler_generated(ent) _is_entity_compiler_generated(ent)
+#define set_entity_compiler_generated(ent, flag) _set_entity_compiler_generated(ent, flag)
+#define get_entity_address_taken(ent) _get_entity_address_taken(ent)
+#define set_entity_address_taken(ent, flag) _set_entity_address_taken(ent, flag)
#define get_entity_offset(ent) _get_entity_offset(ent)
#define set_entity_offset(ent, offset) _set_entity_offset(ent, offset)
#define get_entity_offset_bits_remainder(ent) _get_entity_offset_bits_remainder(ent)
#define get_entity_repr_class(ent) _get_entity_repr_class(ent)
-#endif /* _FIRM_TR_ENTITY_T_H_ */
+#endif /* FIRM_TR_ENTITY_T_H */