/*
- * Copyright (C) 1995-2008 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.
+ * Copyright (C) 2012 University of Karlsruhe.
*/
/**
* @file
* @brief Traverse an ir graph
* @author Boris Boesler, Goetz Lindenmaier
- * @version $Id$
- * @brief
- * Traverse an ir graph:
- * - execute the pre function before recursion
- * - execute the post function after recursion
- *
- * Uses current_ir_graph (from irgraph.h)!!! Set it to the proper
- * graph before starting the walker.
*/
#ifndef FIRM_IR_IRGWALK_H
#define FIRM_IR_IRGWALK_H
#include "firm_types.h"
#include "begin.h"
+/**
+ * @ingroup ir_graph
+ * @defgroup irgwalk Traversing
+ *
+ * Traverse graphs:
+ * - execute the pre function before recursion
+ * - execute the post function after recursion
+ * @{
+ */
+
/**
* Walks over the ir graph.
*
*
* 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. If interprocedural_view
- * is set, visits all reachable irgs.
+ * is set to irg. Does not use the link field.
*/
FIRM_API void irg_walk_graph(ir_graph *irg, irg_walk_func *pre,
irg_walk_func *post, void *env);
* graph, starting at the end operation. During the walk current_ir_graph
* is set to irg. Does not use the link field.
* This walker also follows additional dependency egdes.
- * interprocedural_view is not yet supported.
*/
FIRM_API void irg_walk_in_or_dep_graph(ir_graph *irg, irg_walk_func *pre,
irg_walk_func *post, void *env);
*
* 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. Does not use the link field.
+ * current_ir_graph. Does not use the link field.
*/
FIRM_API void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
-#ifdef INTERPROCEDURAL_VIEW
-/**
- * Walks all irgs 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, passed to pre and post
- *
- * This function walks all irgs in interprocedural view.
- * Visits each node only once. Sets current_ir_graph properly. Does not use the link field.
- */
-FIRM_API void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env);
-#endif
-
/** Walks only over Block nodes in the graph.
*
* @param node the start node
* @param post walker function, executed after the predecessor of a node are visited
* @param env environment, passed to pre and post
*
- * This function Walks only over Block nodes in the graph. Has it's own visited
+ * This function Walks only over Block nodes in the graph. Has its 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 a non-block is passed, starts at the block this node belongs to.
* If end is passed also visits kept alive blocks. Does not use the link field.
*/
FIRM_API void irg_block_walk(ir_node *node, irg_walk_func *pre,
* flag. 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.
- * Walks only intraprocedural, even in interprocedural view.
*
* @param irg the irg graph
* @param pre walker function, executed before the predecessor of a node are visited
* flag. 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.
- * Walks only intraprocedural, even in interprocedural view.
* This walker also follows dependency edges.
*
* @param irg the irg graph
* flag. 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.
- * Walks only intraprocedural, even in interprocedural view.
*
* @param irg the irg graph
* @param pre walker function, executed before the predecessor of a node are visited
* Walker function which does not increase the visited flag before walking.
* Do not use this unless you know what you are doing.
*/
-unsigned irg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post,
- void *env);
+FIRM_API void irg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post,
+ void *env);
+
+/** @} */
#include "end.h"
projects / libfirm / blobdiff