removed INLIEN before global functions

[libfirm] / ir / ir / irdump.h

diff --git a/ir/ir/irdump.h b/ir/ir/irdump.h
index 2532f56..a1981bb 100644 (file)
--- a/ir/ir/irdump.h
+++ b/ir/ir/irdump.h
@@ -42,6 +42,16 @@
 /*                                 GRAPH DUMPERS                                */
 /* **************************************************************************** */
 
+/**
+ * This hook is called to dump the vcg attributes of a node to a file.
+ * If this function returns zero, the default attributes are added, else
+ * removed.
+ */
+typedef int (*DUMP_NODE_VCGATTR_FUNC)(FILE *F, ir_node *node, ir_node *local);
+
+/** Set the node_vcgattr hook. */
+void set_dump_node_vcgattr_hook(DUMP_NODE_VCGATTR_FUNC hook);
+
 /** Dump a firm graph.
  *
  *  @param irg  The firm graph to be dumped.
@@ -157,6 +167,21 @@ void dump_all_ir_graphs (dump_graph_func *dump_graph, const char *suffix);
  */
 void dump_cfg (ir_graph *irg, const char *suffix);
 
+/**  Dump a node and its predecessors forming a subgraph to a vcg file.
+ *
+ *   @param root   The node serving as root for the subgraph.
+ *   @param depth  Dump nodes on paths starting at root with length depth.
+ *   @param suffix A suffix for the file name.
+ *
+ *   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
+ *   for each graph dumped. Eventually overwrites existing files.
+ *
+ *   @return
+ *      A file containing the subgraph in vcg format.
+ */
+void dump_subgraph (ir_node *root, int depth, const char *suffix);
 
 /* **************************************************************************** */
 /*                              CALLGRAPH DUMPERS                               */
@@ -261,6 +286,38 @@ void dump_callgraph_loop_tree(const char *suffix);
 /*                                TEXT DUMPERS                                  */
 /* **************************************************************************** */
 
+
+/** Write the irnode and all its attributes to the file passed.
+ * */
+int dump_irnode_to_file (FILE *f, ir_node *n);
+
+/** Write the irnode and all its attributes to stdout.
+ *  */
+void dump_irnode (ir_node *n);
+
+/** Write the graph and all its attributes to the file passed.
+ *  Does not write the nodes.
+ * */
+void dump_graph_to_file(FILE *F, ir_graph *irg);
+
+/** Write the graph and all its attributes to stdout.
+ *  Does not write the nodes.
+ *  */
+void dump_graph(ir_graph *g);
+
+
+/** Dump graph information as text.
+ *
+ *  Often graphs are unhandy in their vcg representation.  The text
+ *  dumper represents the information for the firm nodes more compact,
+ *  but the relations between the nodes only implicitly.
+ *
+ *  The file name is the graph name (get_entity_name()), appended by
+ *  <suffix>.txt.
+ */
+void dump_graph_as_text(ir_graph *irg, const char *suffix);
+
+
 /** Verbosity for text dumpers */
 typedef enum {
   dump_verbosity_onlynames         = 0x00000001,   /**< only dump names. turns off all other
@@ -272,6 +329,7 @@ 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 */
@@ -291,7 +349,8 @@ typedef enum {
   dump_verbosity_onlyPrimitiveTypes = 0x000BF000,  /**< dump only primitive types */
   dump_verbosity_onlyEnumerationTypes=0x0007F000,  /**< dump only enumeration types */
 
-  dump_verbosity_max                = 0x48888887   /**< turn on all verbosity. */
+  dump_verbosity_max                = 0x4FF00FFE   /**< turn on all verbosity.
+                                                       @@@ Because of a bug in gcc 3.2 we can not set the first two bits. */
 } dump_verbosity;
 
 
@@ -306,7 +365,7 @@ void    dump_entity (entity *ent);
 
 /** Write the type and all its attributes to the file passed.
  * */
-void    dump_type_to_file (FILE *f, type *tp, unsigned verbosity);
+void    dump_type_to_file (FILE *f, type *tp, dump_verbosity verbosity);
 
 /** Write the type and all its attributes to stdout.
  *  */
@@ -322,7 +381,8 @@ void    dump_type (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);
 
@@ -344,7 +404,7 @@ void only_dump_method_with_name(ident *name);
 /**  Sets the vcg flag "display_edge_labels" to no.
  *
  *   This is necessary as xvcg and aisee both fail to display graphs
- *   with self-edges if these edges have labes.
+ *   with self-edges if these edges have lables.
  */
 void turn_off_edge_labels(void);
 
@@ -367,7 +427,7 @@ bool get_opt_dump_const_local(void);
 /**  Turns off dumping the values of constant entities. Makes type graphs
  *   better readable.
  */
-void turn_off_constant_entity_values(void);
+void dump_constant_entity_values(bool b);
 
 /**  Turns on dumping the edges from the End node to nodes to be kept
  *   alive.
@@ -380,24 +440,18 @@ bool get_opt_dump_keepalive_edges(void);
  *
  *  To test the consistency of the out datastructure.
  */
-void dump_out_edges(void);
+void dump_out_edges(bool b);
 
 /** If this flag is set the dumper dumps edges to immediate dominator in cfg.
  */
-void dump_dominator_information(void);
+void dump_dominator_information(bool b);
 
 /** 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.
  */
-void dump_loop_information(void);
-
-/**
- * @see dump_loop_information()
- */
-void dont_dump_loop_information(void);
+void dump_loop_information(bool b);
 
 /** If set and backedge info is computed, backedges are dumped dashed
  *  and as vcg 'backedge' construct.