-/**
+/*
+ * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
*
- * @file irtypeinfo.h
+ * This file is part of libFirm.
*
- * Project: libFIRM
- * File name: ir/ana/irtypeinfo.h
- * Purpose: Data structure to hold type information for nodes.
- * Author: Goetz Lindenmaier
- * Modified by:
- * Created: 28.8.2003
- * CVS-ID: $Id$
- * Copyright: (c) 2003 Universität Karlsruhe
- * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ * 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.
*
- * Data structure to hold type information for nodes.
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
*
- * This module defines a field "type" of type "type *" for each ir node.
- * It defines a flag for irgraphs to mark whether the type info of the
- * graph is valid. Further it defines an auxiliary type "init_type".
+ * 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 Data structure to hold type information for nodes.
+ * @author Goetz Lindenmaier
+ * @date 28.8.2003
+ * @version $Id$
+ * @summary
+ * Data structure to hold type information for nodes.
*
+ * This module defines a field "type" of type "type *" for each ir node.
+ * It defines a flag for irgraphs to mark whether the type info of the
+ * graph is valid. Further it defines an auxiliary type "init_type".
*/
-#ifndef _IRTYPEINFO_H_
-#define _IRTYPEINFO_H_
+#ifndef FIRM_ANA_IRTYPEINFO_H
+#define FIRM_ANA_IRTYPEINFO_H
#include "firm_types.h"
/** An auxiliary type used to express that a field is uninitialized.
*
* This auxiliary type expresses that a field is uninitialized. The
- * variable is set by init_irtypeinfo. The type is freed by
- * free_irtypeinfo.
+ * variable is initialized by init_irtypeinfo(). The type is freed by
+ * free_irtypeinfo().
*/
extern ir_type *initial_type;
/** Initializes the type information module.
*
* Initializes the type information module.
- * Generates a type "init_type" and sets the type of all nodes to this type.
- * Calling set/get_irn_type is invalid before calling init. Requires memory
- * in the order of MIN(<calls to set_irn_type>, #irnodes).
+ * Generates a type inititial_type and sets the type of all nodes to this type.
+ * Calling set/get_irn_typeinfo_type() is invalid before calling init. Requires memory
+ * in the order of MIN(<calls to set_irn_typeinfo_type>, #irnodes).
*/
void init_irtypeinfo(void);
void free_irtypeinfo(void);
*/
typedef enum {
- ir_typeinfo_none, /**< No typeinfo computed, calls to set/get_irn_type
+ ir_typeinfo_none, /**< No typeinfo computed, calls to set/get_irn_typeinfo_type()
are invalid. */
- ir_typeinfo_consistent, /**< Type info valid, calls to set/get_irn_type return
+ ir_typeinfo_consistent, /**< Type info valid, calls to set/get_irn_typeinfo_type() return
the proper type. */
ir_typeinfo_inconsistent /**< Type info can be accessed, but it can be invalid
because of other transformations. */
ir_type *get_irn_typeinfo_type(ir_node *n);
void set_irn_typeinfo_type(ir_node *n, ir_type *tp);
-#endif /* _IRTYPEINFO_H_ */
+#endif