condeval.h added
[libfirm] / ir / common / firmwalk.h
index 91b80ad..6fce4eb 100644 (file)
 #ifndef _FIRM_WALK_H_
 #define _FIRM_WALK_H_
 
-#include "type.h"
-#include "irgraph.h"
-#include "typewalk.h"
+#include "firm_types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 
 /** Returns the link of a firm node.
  *  Possible firm structures are: entity, type, ir_graph, ir_node and
@@ -45,7 +48,7 @@
  *  by this firm walker to collect walking data.
  *
  *  @param thing Pointer to a firm structure
- *  @retrun Link pointer
+ *  @return Link pointer
  *
  *  @note After calling firm_walk_finalize() the stored link
  *        information may be invalid. */
@@ -59,7 +62,7 @@ void *get_firm_walk_link(void *thing);
  *  to a firm structure. The real link field of firm structure is used
  *  by this firm walker to collect walking data.
  *
- *  @param thing firm structur
+ *  @param thing firm structure
  *  @param link Pointer to link field
  *
  *  @note After calling firm_walk_finalize() the stored link
@@ -74,17 +77,17 @@ typedef void firm_walk_finalize_func(void *env);
 /** Mode callback function definition */
 typedef void firm_walk_mode_func(ir_mode *mode, void *env);
 /** Type callback function definition */
-typedef void firm_walk_type_func(type *tp, void *env);
+typedef void firm_walk_type_func(ir_type *tp, void *env);
 /** Entity callback function definition */
 typedef void firm_walk_entity_func(entity *ent, void *env);
 /** Graph callback function definition */
 typedef void firm_walk_graph_func(ir_graph *irg, void *env);
-//@{
+/* @{ */
 /** Block callback function definition */
 typedef void firm_walk_block_init_func(ir_graph *irg, void *env);
 typedef void firm_walk_block_func(ir_node *block, void *env);
 typedef void firm_walk_block_finalize_func(ir_graph *irg, void *env);
-//@}
+/* @} */
 /** Node callback function definition */
 typedef void firm_walk_node_func (ir_node *irn, void *env);
 
@@ -112,37 +115,38 @@ typedef enum
 /** Interface of the firm walker */
 typedef struct
 {
-  //@{
+  /* @{ */
   /** Interface function to dump all used and internal modes.
       Internal modes are: BB, X, M and T */
   firm_walk_init_func *do_mode_init;
   firm_walk_mode_func *do_mode;
   firm_walk_finalize_func *do_mode_finalize;
-  //@}
+  /* @} */
 
-  //@{
+  /* @{ */
   /** Interface to dump all collected types.
    *
-   *  @node To dump all (not only used types by default) a special walk
+   *  @note To dump all (not only used types by default) a special walk
    *        flag must be set for the walker initializer */
   firm_walk_init_func *do_type_init;
   firm_walk_type_func *do_type;
   firm_walk_finalize_func *do_type_finalize;
-  //@}
+  /* @} */
 
-  //@{
+  /* @{ */
   /** Dumping interface for entities */
   firm_walk_init_func *do_entity_init;
   firm_walk_entity_func *do_entity;
   firm_walk_finalize_func *do_entity_finalize;
-  //@}
+  /* @} */
 
   /** Dumps all graphs and subnodes.
    *
    *  The firm walker dump a graph with its blocks and nodes nested.
    *  Fist do_graph_init will be called (if defined). For each graph
-   *  do_graph will be call in a loop. After dumped all graphs,
-   *  do_graph_finalize will be called.
+   *  do_graph will be call in a loop.
+   *  After all blocks in a graph are dumped, do_graph_post() is called.
+   *  After dumped all graphs, do_graph_finalize will be called.
    *
    *  Within do_graph each block will be dumped. First do_block_init,
    *  for each block do_block and after all dumped blocks
@@ -154,16 +158,18 @@ typedef struct
    *  walking flag, a prefix order is also possible. */
   firm_walk_init_func *do_graph_init;
   firm_walk_graph_func *do_graph;
+  firm_walk_graph_func *do_graph_post;
   firm_walk_finalize_func *do_graph_finalize;
 
-  //@{
+  /* @{ */
   /** Dumping interface for blocks. If blocks should be handled like
    *  like a normal ir node, a special walker flag could be set.
    *  @see do_graph */
   firm_walk_block_init_func *do_block_init;
   firm_walk_block_func *do_block;
+  firm_walk_block_func *do_block_post;
   firm_walk_block_finalize_func *do_block_finalize;
-  //@}
+  /* @} */
 
   /** Dumping interface for ir nodes
    *  @see do_graph */
@@ -205,4 +211,9 @@ void firm_walk(firm_walk_interface *wif);
 /** Finalize the walker and frees all stored data for dumping */
 void firm_walk_finalize(void);
 
+#ifdef __cplusplus
+}
+#endif
+
+
 #endif /* _FIRM_WALK_H_ */