X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firgmod.h;h=cf5cac6351653a8fe16cfb1dee1d3add2e9a8e0e;hb=cf3056ad5ceb8c9018c01e634fc5e85bb4bfd6fb;hp=7ec6d8211c9048f3723b449c932df2c9d50aee4d;hpb=83afa91b731e958deffb1a65ce26c792779b88f3;p=libfirm

diff --git a/ir/ir/irgmod.h b/ir/ir/irgmod.h
index 7ec6d8211..cf5cac635 100644
--- a/ir/ir/irgmod.h
+++ b/ir/ir/irgmod.h
@@ -1,26 +1,76 @@
-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Martin Trapp, Christian Schaefer
-**
-** irgmod.h: ir graph modification
-*/
+/*
+ * 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.
+ */
 
-# ifndef _IRGMOD_H_
-# define _IRGMOD_H_
+/**
+ * @file
+ * @brief    Support for ir graph modification.
+ * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier
+ * @version  $Id$
+ */
+#ifndef FIRM_IR_IRGMOD_H
+#define FIRM_IR_IRGMOD_H
 
-# include "irnode.h"
+#include "firm_types.h"
 
+/** Exchanges two nodes by conserving edges leaving old (i.e.,
+   pointers pointing to old).  Turns the old node into an Id. */
+void exchange(ir_node *old, ir_node *nw);
 
-/* Turns a node into a "useless" Tuple.  The Tuple just forms a tuple
-   from several inputs.  The tuples predecessors have to be
-   set by hand.
-   This is useful if a node returning a tuple is removed, but the Projs
-   extracting values from the tuple are not available. */
-void turn_into_tuple (ir_node *node, int arity);
+/** Turns a node into a "useless" Tuple.
+ *
+ *  Turns a node into a "useless" Tuple.  The Tuple node just forms a tuple
+ *  from several inputs.  The predecessors of the tuple have to be
+ *  set by hand.  The block predecessor automatically remains the same.
+ *  This is useful if a node returning a tuple is removed, but the Projs
+ *  extracting values from the tuple are not available.
+ *
+ *  @param node The node to be turned into a tuple.
+ *  @param arity The number of values formed into a Tuple.
+ */
+void turn_into_tuple(ir_node *node, int arity);
 
-/* Exchanges two nodes by conserving edges leaving old (i.e., pointers)
-   pointing to old. */
-inline void exchange (ir_node *old, ir_node *new);
+/** Walks over the passed ir graph and collects all Phi nodes as a
+  * list built with the link field in their corresponding block.
+  * Further it collects all Proj nodes in a list of the node producing
+  * the tuple. In case of nested tuples the Projs are collected in the
+  * node producing the outermost Tuple.
+  * All other link fields are cleared afterwards.
+  */
+void collect_phiprojs(ir_graph *irg);
 
-#endif /* ifndef _IRGMOD_H_ */
+/** Parts a block into two.  This is useful to insert other blocks within a
+ *  given block.
+ *
+ * Adds a new block (new_block) in the control flow before the block
+ * (old_block) of node.  Moves node and its predecessors from old_block to
+ * new_block.  Moves all Projs that depend on moved nodes and are in old_block
+ * to new_block. Moves all Phi nodes from old_block to new_block.  To achieve
+ * this the routine assumes that all Phi nodes are in a list (using the link
+ * field) in the link field of old_block.  Further it assumes that all Proj nodes
+ * are accessible by the link field of the nodes producing the Tuple. This
+ * can be established by collect_phiprojs().  part_block conserves this property.
+ * Adds a Jmp node to new_block that jumps to old_block.
+ * Assumes that node is contained in current_ir_graph.  Sets current_block in
+ * this ir_graph to new_block.
+ *
+ * @param node   The node were to break the block
+ */
+void part_block(ir_node *node);
+
+#endif /* FIRM_IR_IRGMOD_H */