removed INLIEN before global functions

[libfirm] / ir / ir / irgwalk.h

diff --git a/ir/ir/irgwalk.h b/ir/ir/irgwalk.h
index 9b2c03a..1983be4 100644 (file)
--- a/ir/ir/irgwalk.h
+++ b/ir/ir/irgwalk.h
@@ -1,6 +1,15 @@
-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-* All rights reserved.
-*/
+/*
+ * Project:     libFIRM
+ * File name:   ir/ir/irgwalk.h
+ * Purpose:
+ * Author:      Boris Boesler
+ * Modified by: Goetz Lindenmaier
+ * Created:
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 1999-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
+
 
 /**
  * @file irgwalk.h
@@ -17,7 +26,6 @@
  * graph before starting the walker.
  */
 
-/* $Id$ */
 
 # ifndef _IRGWALK_H_
 # define _IRGWALK_H_
@@ -36,27 +44,23 @@
 typedef void irg_walk_func(ir_node *node, void *env);
 #endif
 
-/** Allocates some necessary datastructures. */
-void init_ip_walk(void);
-
-/** Frees some necessary datastructures. */
-void finish_ip_walk(void);
-
 /**
  * Walks over the ir graph.
  *
- * @param node - the start node
- * @param pre  - walker function, executed before the predecessor of a node are visited
- * @param post - walker function, executed after the predecessor of a node are visited
- * @param env  - environment, passend to pre and post
- *
  * Walks over the ir graph, starting at the node given as first argument.
  * Executes pre before visiting the predecessor of a node, post after.
  * irg_walk uses the visited flag in irg and the nodes to determine visited
  * nodes.  It executes inc_irg_visited(current_ir_graph) to generate a new
- * flag.  It marks the node as visited before executing pre.
+ * flag.  Therefore current_ir_graph must be set before calling the walker.
+ * It marks the node as visited before executing pre.
  * The void* env can be used to pass status information between the
- * pre and post functions.  Does not use the link field.
+ * pre and post functions.  Does not use the link fields.
+ *
+ * @param node - the start node
+ * @param pre  - walker function, executed before the predecessor of a node are visited
+ * @param post - walker function, executed after the predecessor of a node are visited
+ * @param env  - environment, passend to pre and post
+ *
  */
 void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -70,7 +74,8 @@ void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
  *
  * Like irg_walk(), but walks over all reachable nodes in the ir
  * graph, starting at the end operation. During the walk current_ir_graph
- * is set to irg.  Does not use the link field.
+ * is set to irg.  Does not use the link field.  If interprocedural_view
+ * is set, visits all reachable irgs.
  */
 void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -100,8 +105,7 @@ void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
  */
 void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
 
-/**
- * Walks only over Block nodes in the graph.
+/** Walks only over Block nodes in the graph.
  *
  * @param node - the start node
  * @param pre  - walker function, executed before the predecessor of a node are visited
@@ -140,4 +144,40 @@ void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post
  */
 void walk_const_code(irg_walk_func *pre, irg_walk_func *post, void *env);
 
+/**
+ * Walks over reachable nodes in block-wise order, i.e. visit all nodes in a block
+ * before going to another block, starting at the node given as first argument.
+ * Executes pre before visiting the predecessor of a node, post after.
+ * irg_walk_blkwise() uses the visited flag in irg and the nodes to determine visited
+ * nodes.  It executes inc_irg_visited(current_ir_graph) to generate a new
+ * flag.  Therefore current_ir_graph must be set before calling the walker.
+ * It marks the node as visited before executing pre.
+ * The void *env can be used to pass status information between the
+ * pre and post functions.  Does not use the link fields.
+ * Do NOT leave the graph in interprocedural view.
+ *
+ * @param pre  - walker function, executed before the predecessor of a node are visited
+ * @param post - walker function, executed after the predecessor of a node are visited
+ * @param env  - environment, passend to pre and post
+ *
+ * This function works like irg_walk, except that it enters and leaves blocks only once.
+ * So, the post walker see a 'valid schedule' of the code, the pre-walker a 'reversed schedule'
+ */
+void irg_walk_blkwise(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);
+
+/**
+ * Walks over all reachable nodes in the ir graph in block-wise order.
+ *
+ * @param irg  - the irg graph
+ * @param pre  - walker function, executed before the predecessor of a node are visited
+ * @param post - walker function, executed after the predecessor of a node are visited
+ * @param env  - environment, passend to pre and post
+ *
+ * Like irg_walk_blkwise(), but walks over all reachable nodes in the ir
+ * graph, starting at the end operation. During the walk current_ir_graph
+ * is set to irg.  Does not use the link fields.
+ * Do NOT leave the graph in interprocedural view.
+ */
+void irg_walk_blkwise_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env);
+
 # endif /* _IRGWALK_H_ */