Reverted r27368, needed for propagation of changed nodes ...
[libfirm] / include / libfirm / irdump.h
index 87f3871..ba17cda 100644 (file)
@@ -191,11 +191,17 @@ void dump_ir_graph_file(ir_graph *irg, FILE *out);
  * @see turn_off_edge_labels()
  */
 void dump_ir_block_graph(ir_graph *irg, const char *suffix);
+
+/**
+ * Does the same as dump_ir_block_graph but dumps to a stream
+ * @see dump_ir_block_graph()
+ */
 void dump_ir_block_graph_file(ir_graph *irg, FILE *out);
 
 /** Dump a firm graph without explicit block nodes but grouped in extended blocks.
  *
- *  @param irg   The firm graph to be dumped.
+ *  @param irg     The firm graph to be dumped.
+ *  @param suffix  suffix to append after the irgname (but before the .vcg)
  *
  *  @return
  *     A file containing the firm graph in vcg format.
@@ -210,9 +216,14 @@ void dump_ir_block_graph_file(ir_graph *irg, FILE *out);
  * @see turn_off_edge_labels()
  */
 void dump_ir_extblock_graph(ir_graph *irg, const char *suffix);
+
+/**
+ * Does the same as dump_ir_extrblock_graph but dumps to a stream
+ * @see dump_ir_extblock_graph()
+ */
 void dump_ir_extblock_graph_file(ir_graph *irg, FILE *out);
 
-/** Dumps all graphs in interprocedural view to a file named All_graphs<suffix>.vcg.
+/** Dumps all graphs in interprocedural view to a file named All_graphs\<suffix\>.vcg.
  *
  * @param suffix  A suffix for the file name.
  */
@@ -234,6 +245,11 @@ void dump_all_cg_block_graph(const char *suffix);
  * @see turn_off_edge_labels()
  */
 void dump_ir_graph_w_types(ir_graph *irg, const char *suffix);
+
+/**
+ * Does the same as dump_ir_graph_w_types but dumps to a stream
+ * @see dump_ir_graph_w_types()
+ */
 void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out);
 
 /** Dumps a firm graph and  all the type information needed for Calls,
@@ -254,6 +270,13 @@ void dump_ir_graph_w_types_file(ir_graph *irg, FILE *out);
  */
 void dump_ir_block_graph_w_types(ir_graph *irg, const char *suffix);
 
+/**
+ * same as @see dump_ir_block_graph_w_types() but dumps to a stream
+ * @param irg  the graph to dump
+ * @param out  stream to dump to
+ */
+void dump_ir_block_graph_w_types_file(ir_graph *irg, FILE *out);
+
 /** The type of a dump function that is called for each graph.
  *
  *  @param irg     current visited graph
@@ -321,7 +344,7 @@ void dump_cfg(ir_graph *irg, const char *suffix);
  *
  * Dumps the graph to a file.  The file name is constructed from the
  * name of the entity describing the procedure the passed node is
- * in, suffix and the ending -subg_<nr>.vcg.  nr is a unique number
+ * in, suffix and the ending -subg_\<nr\>.vcg.  nr is a unique number
  * for each graph dumped. Eventually overwrites existing files.
  *
  * @return
@@ -336,7 +359,7 @@ void dump_subgraph(ir_node *root, int depth, const char *suffix);
 
 /** Dump the call graph.
  *
- * Dumps the callgraph to a file "Callgraph"<suffix>".vcg".
+ * Dumps the callgraph to a file "Callgraph"\<suffix\>".vcg".
  *
  * @param suffix A suffix for the file name.
  *
@@ -409,7 +432,7 @@ void dump_class_hierarchy(int entities, const char *suffix);
 /**
  * Dump a standalone loop tree, which contains the loop nodes and the firm nodes
  * belonging to one loop packed together in one subgraph.  Dumps to file
- * <name of irg><suffix>-looptree.vcg
+ * \<name of irg\>\<suffix\>-looptree.vcg
  * Turns on edge labels by default.
  *
  * Implementing this dumper was stimulated by Florian Liekwegs similar dumper.
@@ -422,7 +445,7 @@ void dump_loop_tree(ir_graph *irg, const char *suffix);
 /** Dumps the firm nodes in the sub-loop-tree of loop to a graph.
  *
  * Dumps the loop nodes if dump_loop_information() is set.
- * The name of the file is loop_<loop_nr><suffix>.vcg.
+ * The name of the file is loop_<loop_nr>\<suffix\>.vcg.
  *
  * @param l       Dump the loop tree for this loop.
  * @param suffix  A suffix for the file name.
@@ -432,7 +455,7 @@ void dump_loop(ir_loop *l, const char *suffix);
 /** Dumps the loop tree over the call graph.
  *
  * See for yourself what you can use this for.
- * The filename is "Callgraph_looptree<suffix>.vcg".
+ * The filename is "Callgraph_looptree\<suffix\>.vcg".
  *
  * @param suffix  A suffix for the file name.
  */
@@ -470,7 +493,7 @@ void dump_graph(ir_graph *g);
  *  but the relations between the nodes only implicitly.
  *
  *  The file name is the graph name (get_entity_name()), appended by
- *  <suffix>.txt.
+ *  \<suffix\>.txt.
  */
 void dump_graph_as_text(ir_graph *irg, const char *suffix);
 
@@ -489,7 +512,6 @@ typedef enum {
        dump_verbosity_entconsts         = 0x00000020,   /**< Dump entity constants. */
 
        dump_verbosity_accessStats       = 0x00000100,   /**< Dump entity access statistics. */
-       dump_verbosity_csv               = 0x00000200,   /**< Dump access statistics as comma separated list. */
 
        dump_verbosity_noClassTypes      = 0x00001000,   /**< Dump no class       types. */
        dump_verbosity_noStructTypes     = 0x00002000,   /**< Dump no struct      types. */
@@ -543,19 +565,20 @@ void    dump_type(ir_type *tp);
  *  the global type nor frame types or the like.
  *
  *  The file name is the program name (get_irp_name()), or 'TextTypes'
- *  if the program name is not set, appended by <suffix>-types.txt.
+ *  if the program name is not set, appended by \<suffix\>-types.txt.
  *  For verbosity see the documentation of the verbosity flags above.
  */
 void dump_types_as_text(unsigned verbosity, const char *suffix);
 
 /** Dumps all global variables as text.
  *
- * @param suffix  A suffix for the file name.
+ * @param verbosity   verbosity flag
+ * @param suffix      A suffix for the file name.
  *
  * Dumps a text representation of the entities in the global type.
  *
  * The file name is the program name (get_irp_name()), or 'TextTypes'
- * if the program name is not set, appended by <suffix>-globals.txt.
+ * if the program name is not set, appended by \<suffix\>-globals.txt.
  * For verbosity see the documentation of the verbosity flags above.
  */
 void dump_globals_as_text(unsigned verbosity, const char *suffix);
@@ -647,6 +670,11 @@ void dump_backedge_information(int flag);
  */
 void set_opt_dump_analysed_type_info(int flag);
 
+/**
+ * dump iredges (new style out edges)
+ */
+void dump_new_edges(int flag);
+
 /** Write the address of a node into the vcg info.
  *
  *  This is off per default for automatic comparisons of