+/*
+ * Copyright (C) 1995-2007 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.
+ */
-/* $Id$ */
-
-# ifndef _TYPEGMOD_H_
-# define _TYPEGMOD_H_
+/**
+ * @file typegmod.h
+ * @brief Functionality to modify the type graph.
+ * @author Goetz Lindenmaier, Michael Beck
+ * @version $Id$
+ */
+#ifndef FIRM_TR_TYPEGMOD_H
+#define FIRM_TR_TYPEGMOD_H
-# include "type.h"
+#include "firm_types.h"
-/****h* libfirm/typegmod
- *
- * NAME
- * file typegmod.h
- * COPYRIGHT
- * (C) 2001 by Universitaet Karlsruhe
- * AUTHORS
- * Goetz Lindenmaier
- * NOTES
+/**
+ *
+ * @file typegmod.h
* This module supplies routines that support changing the type graph.
- *****
*/
-/****f* tpop/exchange_types
- *
- * NAME
- * exchange_types -- replaces one type by the other.
- * SYNOPSIS
- * void exchange_types(type *old_type, type *new_type);
- * INPUTS
- * The old type that shall be replaced by the new type.
- * SIDE EFFECTS
- * Old type is replaced by new_type. All references to old_type
- * now point to new_type. The memory for the old type is destroyed,
- * but still used. Therefore it is not freed.
- * All referenced to this memory will be lost after a certain while.
- * An exception is the list of types in irp (irprog.h).
- * In the future there might be a routine to recover the memory, but
- * this will be at considerable runtime cost.
- ***
+/** Replaces one type by the other.
+ *
+ * Old type is replaced by new_type. All references to old_type
+ * now point to new_type. The memory for the old type is destroyed,
+ * but still used. Therefore it is not freed.
+ * All referenced to this memory will be lost after a certain while.
+ * An exception is the list of types in irp (irprog.h).
+ * In the future there might be a routine to recover the memory, but
+ * this will be at considerable runtime cost.
+ *
+ * @param old_type - The old type that shall be replaced by the new type.
+ * @param new_type - The new type that will replace old_type.
+ *
*/
-INLINE void exchange_types(type *old_type, type *new_type);
+void exchange_types(ir_type *old_type, ir_type *new_type);
-/****f* tpop/skip_tid
- *
- * NAME
- * skip_tid -- skip id types until a useful type is reached.
- * SYNOPSIS
- * type *skip_tid(type *tp)
- * INPUTS
- * A type of arbitrary kind.
- * RETURNS
- * tp if it is not an id type.
- * If tp is an id type retruns the real type it stands for.
- ***
+/** Skip id types until a useful type is reached.
+ *
+ * @param tp - A type of arbitrary kind.
+ *
+ * @return
+ * tp if it is not an id type.
+ * If tp is an id type returns the real type it stands for.
*/
-INLINE type *skip_tid(type *tp);
+ir_type *skip_tid(ir_type *tp);
-# endif /*_TYPEGMOD_H_ */
+#endif /*FIRM_TR_TYPEGMOD_H */
projects / libfirm / blobdiff