normalized various syntactic constructs for firm jni.

[libfirm] / ir / ir / irdump.h

diff --git a/ir/ir/irdump.h b/ir/ir/irdump.h
index 54a2d19..8a3a5ff 100644 (file)
--- a/ir/ir/irdump.h
+++ b/ir/ir/irdump.h
@@ -23,7 +23,8 @@
  *   representation. Some use the original format,
  *   but most generate an extended format that is only read by some special
  *   versions of xvcg or by the comercialized version now calles aiSee.
- *   A test version of aiSee is available at http://www.absint.de/aisee/download/index.htm.
+ *   A test version of aiSee is available at
+ *   http://www.absint.de/aisee/download/index.htm.
  *
  *   Most routines use the name of the passed entity as the name of the
  *   file dumped to.
@@ -31,16 +32,8 @@
  ******
  */
 
-#if 0
-/* The following routines use a global variable that is not external.
-   Therefore removed from interface. */
-/* dump a simple node */
-void dump_ir_node (ir_node *node);
-/* dump the edge to the block this node belongs to */
-void dump_ir_block_edge(ir_node *n);
-/* dump edges to our inputs */
-void dump_ir_data_edges(ir_node *n);
-#endif
+/* @@@ GL: A hack */
+extern char *dump_file_suffix;
 
 /****m* irdump/dump_ir_graph
  *
@@ -193,6 +186,45 @@ void dump_ir_graph_w_types (ir_graph *irg);
  */
 void dump_ir_block_graph_w_types (ir_graph *irg);
 
+
+
+/****m* irdump/dump_cg_graph
+ *
+ * NAME
+ *   dump_cg_graph
+ * SYNOPSIS
+ *   void dump_cg_graph (ir_graph *irg);
+ * FUNCTION
+ *  Dumps a interprocedural firm graph as dump_ir_graph.
+ * INPUTS
+ *   irg: The firm graph to be dumped.
+ * RESULT
+ *   A file containing the firm graph in vcg format.
+ * SEE ALSO
+ ***
+ */
+void dump_cg_graph(ir_graph * irg);
+
+/****m* irdump/dump_cg_block_graph
+ *
+ * NAME
+ *   dump_cg_block_graph
+ * SYNOPSIS
+ *   void dump_cg_block_graph (ir_graph *irg);
+ * FUNCTION
+ *  Dumps a interprocedural firm graph as dump_ir_block_graph.
+ * INPUTS
+ *   irg: The firm graph to be dumped.
+ * RESULT
+ *   A file containing the firm graph in vcg format.
+ * SEE ALSO
+ ***
+ */
+void dump_cg_block_graph(ir_graph * irg);
+
+
+void dump_all_cg_block_graph();
+
 /****m* irdump/dump_all_ir_graphs
  *
  * NAME
@@ -215,7 +247,8 @@ void dump_ir_block_graph_w_types (ir_graph *irg);
  *  turn_of_edge_labels
  ***
  */
-void dump_all_ir_graphs (void dump_graph(ir_graph*));
+typedef void (dump_graph_func)(ir_graph *);
+void dump_all_ir_graphs (dump_graph_func *dump_graph);
 
 /****m* irdump/turn_off_edge_labels
  *
@@ -237,6 +270,27 @@ void dump_all_ir_graphs (void dump_graph(ir_graph*));
  */
 void turn_off_edge_labels();
 
+/****m* irdump/dump_consts_local
+ *
+ * NAME
+ *   dump_consts_local
+ * SYNOPSIS
+ *   void dump_consts_local(bool b);
+ * FUNCTION
+ *   If set to true constants will be replicated for every use. In non blocked
+ *   view edges from constant to block are scipped.  Vcg
+ *   then layouts the graphs more compact, this makes them better readable.
+ *   The flag is automatically and temporarily set to false if other
+ *   edges are dumped, as outs, loop, ...
+ *   Default setting: false.
+ * INPUTS
+ * RESULT
+ * SEE ALSO
+ *
+ ***
+ */
+void dump_consts_local(bool b);
+
 
 /****m* irdump/turn_off_constant_entity_values
  *
@@ -276,7 +330,7 @@ void turn_off_constant_entity_values();
 void dump_keepalive_edges();
 
 
-/****m* irdump/dump_constant_entity_values
+/****m* irdump/dump_out_edges
  *
  * NAME
  *   dump_out_edges
@@ -293,4 +347,45 @@ void dump_keepalive_edges();
  ***
  */
 void dump_out_edges();
+
+
+/****m* irdump/dump_dominator_information
+ *
+ * NAME
+ *   dump_dominator_information
+ * SYNOPSIS
+ *   void dump_dominator_information()
+ * FUNCTION
+ *   If this flag is set the dumper dumps edges to immediate dominator in cfg.
+ * INPUTS
+ *   No inputs
+ * RESULT
+ * SEE ALSO
+ *
+ ***
+ */
+void dump_dominator_information();
+
+
+/****m* irdump/dump_loop_information
+ *
+ * NAME
+ *   dump_loop_information
+ * SYNOPSIS
+ *   void dump_loop_information()
+ * FUNCTION
+ *   If this flag is set the dumper dumps loop nodes and edges from
+ *   these nodes to the contained ir nodes.
+ *   Can be turned off with dont_dump_loop_information().
+ *   If the loops are interprocedural nodes can be missing.
+ * INPUTS
+ *   No inputs
+ * RESULT
+ * SEE ALSO
+ *
+ ***
+ */
+void dump_loop_information();
+void dont_dump_loop_information();
+
 # endif /* _IRDUMP_H_ */