X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firgwalk.h;h=a40dcd8aa192a242a5b43d4feb95e7b039343873;hb=c3c48d7bd83f042cc2951754377de928d66fe51e;hp=bd55265bd33de45edcde80b14662c2e07f314072;hpb=b4f94bb0711b6706af39c38f0b18847323b31e83;p=libfirm

diff --git a/ir/ir/irgwalk.h b/ir/ir/irgwalk.h
index bd55265bd..a40dcd8aa 100644
--- 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_
@@ -28,7 +36,7 @@
 #ifndef _IRG_WALK_FUNC_TYPEDEF_
 #define _IRG_WALK_FUNC_TYPEDEF_
 /**
- * The type of a walk function.
+ * The type of a walk function.  Does not use the link field.
  *
  * @param node - the node that is just visited
  * @param env  - an environment pointer passed by the walk functions
@@ -45,18 +53,20 @@ 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.
+ * pre and post functions.  Does not use the link field.
+ *
+ * @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 +80,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.
+ * 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);
 
@@ -84,7 +95,7 @@ void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void
  * This function executes irg_walk(end, pre, post, env) for all irgraphs in irprog.
  * Sets current_ir_graph properly for each walk.  Conserves current
  * current_ir_graph.  In interprocedural view nodes can be visited several
- * times.
+ * times.  Does not use the link field.
  */
 void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -96,7 +107,7 @@ void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
  * @param env  - environment, passend to pre and post
  *
  * This function walks all irgs in interprocedural view.
- * Visits each node only once.Sets current_ir_graph properly.
+ * Visits each node only once.  Sets current_ir_graph properly. Does not use the link field.
  */
 void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -111,7 +122,7 @@ void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
  * This function Walks only over Block nodes in the graph. Has it's own visited
  * flag, so that it can be interleaved with the other walker.
  * If a none block is passed, starts at the block this node belongs to.
- * If end is passed also visites kept alive blocks.
+ * If end is passed also visites kept alive blocks. Does not use the link field.
  */
 void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -124,7 +135,7 @@ void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void
  * @param env  - environment, passend to pre and post
  *
  * Like irg_block_walk(), but walks over all reachable blocks in the
- * ir graph, starting at the end block.
+ * ir graph, starting at the end block. Does not use the link field.
  */
 void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env);
 
@@ -136,7 +147,7 @@ void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post
  * @param env  - environment, passend to pre and post
  *
  * This function walks over all code in const_code_irg.
- * Uses visited flag in const_code_irg.
+ * Uses visited flag in const_code_irg.  Does not use the link field.
  */
 void walk_const_code(irg_walk_func *pre, irg_walk_func *post, void *env);