X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Ftr%2Ftpop_t.h;h=d4b922cbe058a922c8b25bdc92ae4689939dc029;hb=b4559ec03fdb815542c75600384afb295600baa9;hp=be3cc7a38d6b00d51464034aee5cddffe41f8879;hpb=87f73fef92b9a1904f4dc989e758b5ce3bbc02f7;p=libfirm diff --git a/ir/tr/tpop_t.h b/ir/tr/tpop_t.h index be3cc7a38..d4b922cbe 100644 --- a/ir/tr/tpop_t.h +++ b/ir/tr/tpop_t.h @@ -1,88 +1,164 @@ +/* + * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved. + * + * This file is part of libFirm. + * + * 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. + * + * Licensees holding valid libFirm Professional Edition licenses may use + * this file in accordance with the libFirm Commercial License. + * Agreement provided with the Software. + * + * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE + * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE. + */ + +/** + * @file + * @brief Opcode of types -- private header. + * @author Goetz Lindenmaier, Michael Beck + * @version $Id$ + */ +#ifndef FIRM_TR_TPOP_T_H +#define FIRM_TR_TPOP_T_H -/* $Id$ */ +#include -# ifndef _TPOP_T_H_ -# define _TPOP_T_H_ +#include "firm_types.h" +#include "typerep.h" +#include "irmode.h" -# include -# include "tpop.h" -/****h* libfirm/tpop_t.h - * - * NAME - * file tpop_t.h - * COPYRIGHT - * (C) 2001 by Universitaet Karlsruhe - * AUTHORS - * Goetz Lindenmaier - * NOTES - * This file contains the datatypes hidden in tpop.h. - * SEE ALSO - * tpop.h - ***** +/** A function called to free attributes of a type. */ +typedef void (*free_attrs_func)(ir_type *tp); + +/** A function called to free owned entities of a type. */ +typedef void (*free_entities_func)(ir_type *tp); + +/** A function called to free all automatic allocated entities of a type. */ +typedef void (*free_auto_entities_func)(ir_type *tp); + +/** A function called to set the mode of a type. */ +typedef void (*set_type_mode_func)(ir_type *tp, ir_mode *m); + +/** A function called to set the size of a type in bytes. */ +typedef void (*set_type_size_func)(ir_type *tp, unsigned size); + +/** A function called to get the number of compound members */ +typedef size_t (*get_n_members_func)(const ir_type *tp); + +/** A function called to get the pos'th compound member */ +typedef ir_entity *(*get_member_func)(const ir_type *tp, size_t pos); + +typedef size_t (*get_member_index_func)(const ir_type *tp, ir_entity *member); + +/** A function called to insert an entity into the type */ +typedef void (*insert_entity_func)(ir_type *tp, ir_entity *member); + +/** + * tp_op operations. */ +typedef struct tp_op_ops { + free_attrs_func free_attrs; /**< Called to free the attributes of a type. */ + free_entities_func free_entities; /**< Called to free the owned entities of a type. */ + free_auto_entities_func free_auto_entities; /**< Called to free the automatic allocated entities of a type. */ + set_type_mode_func set_type_mode; /**< Called to set a ir_mode of a type. */ + set_type_size_func set_type_size; /**< Called to set the byte size of a type. */ + get_n_members_func get_n_members; /**< Called to return the number of compound members. */ + get_member_func get_member; /**< Called to get the pos'th compound member. */ + get_member_index_func get_member_index; /**< Called to get the index of a compound member. */ +} tp_op_ops; + +/** possible flags for a type opcode */ +enum tp_op_flags_t { + TP_OP_FLAG_COMPOUND = 1 /**< is a compound type */ +}; +/** The type opcode. */ struct tp_op { - tp_opcode code; - ident *name; - size_t attr_size; + tp_opcode code; /**< The tpop code. */ + ident *name; /**< The name of the type opcode. */ + size_t attr_size; /**< The attribute size for a type of this opcode. */ + unsigned flags; /**< Flags for this opcode. */ + tp_op_ops ops; /**< tp_op operations. */ }; -/****f* tpop/new_tpop +/** + * Returns a new type opcode. + * + * Allocates a new tp_op struct and initializes its fields with + * the passed values. This function is only to be used during + * initialization of the library. + * + * @param code the enum for this type opcode. + * @param name an ident for the name of the type opcode. + * @param flags additional flags + * @param attr_size the size of the attributes necessary for a type with + * this opcode + * @param ops the tp_op operations for this type + * @return A new type opcode. + */ +const tp_op *new_tpop (tp_opcode code, ident *name, unsigned flags, size_t attr_size, const tp_op_ops *ops); + +/** + * Free a tpop data structure. + */ +void free_tpop(const tp_op *tpop); + +/** + * Initialize the tpop module. * - * NAME - * new_tpop - Returns a new type opcode. - * NOTE - * Allocates a new tp_op struct and initializes it's fields with - * the passed values. This function is only to be used during - * initialization of the library. - * SYNOPSIS - * tp_op * new_tpop (tp_opcode code, ident *name, size_t attr_size); - * INPUTS - * code - the enum for this type opcode. - * name - an ident for the name of the type opcode. - * attr_size - the size of the attributes necessary for a type with - * this opcode - * RESULT - * A new type opcode. - *** + * Must be called during the initialization of the library. Allocates + * opcodes and sets the globals that are external visible as specified + * in tpop.h. + * Allocates opcodes for classes, struct, method, union, array, + * enumeration, pointer and primitive and sets the according values. */ -tp_op * new_tpop (tp_opcode code, ident *name, size_t attr_size); +void init_tpop(void); -/****f* tpop/new_tpop +/** + * Finalize the tpop module. * - * NAME - * init_tpop - Initialize the tpop module. - * NOTE - * Must be called during the initizlization of the library. Allocates - * opcodes and sets the globals that are external visible as specified - * in tpop.h. - * SYNOPSIS - * void init_tpop (void); - * INPUTS - * RESULT - * SIDE EFFECTS - * Allocates opcodes for classes, struct, method, union, array, - * enumeration, pointer and primitive and sets the according values. - *** + * Frees all type opcodes. */ -void init_tpop (void); +void finish_tpop(void); -/****f* tpop/get_tpop_attr_size +/** + * Returns the size of the attribute to this kind + * of type. + * + * Internal feature. * - * NAME - * get_tpop_attr_size - Returns the size of the attribute to this kind - * of type. - * NOTE - * Internal feature. - * SYNOPSIS - * int get_tpop_attr_size (tp_op *op) - * INPUTS - * op - The type opcode to get the size for. - * RESULT - * The size of the attribute of types with this opcode. - * SIDE EFFECTS - *** + * @param op The type opcode to get the size for. + * @return The size of the attribute of types with this opcode. */ -int get_tpop_attr_size (tp_op *op); +size_t get_tpop_attr_size(const tp_op *op); + + +/* ---------------- * + * inline functions * + * -----------------*/ + +static inline tp_opcode _get_tpop_code(const tp_op *op) +{ + return op->code; +} + +static inline ident *_get_tpop_ident(const tp_op *op) +{ + return op->name; +} + +static inline size_t _get_tpop_attr_size(const tp_op *op) +{ + return op->attr_size; +} + +#define get_tpop_code(op) _get_tpop_code(op) +#define get_tpop_ident(op) _get_tpop_ident(op) +#define get_tpop_attr_size(op) _get_tpop_attr_size(op) -#endif /* _TPOP_T_H_ */ +#endif /* FIRM_TR_TPOP_T_H */