/*
- * Project: libFIRM
- * File name: ir/ir/irdump.h
- * Purpose: Write vcg representation of firm to file.
- * Author: Martin Trapp, Christian Schaefer
- * Modified by: Goetz Lindenmaier, Hubert Schmidt
- * Created:
- * CVS-ID: $Id$
- * Copyright: (c) 1998-2003 Universität Karlsruhe
- * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2007 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.
*/
-
/**
- * @file irdump.h
- *
- * Dump routines for the ir graph and all type information.
+ * @file
+ * @brief Write vcg representation of firm to file.
+ * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
+ * @version $Id$
+ * @summary
+ * Dump routines for the ir graph and all type information.
*
- * @author Martin Trapp, Christian Schaefer
+ * The dump format of most functions is vcg. This is a text based graph
+ * 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.
*
- * The dump format of most functions is vcg. This is a text based graph
- * 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.
+ * We have developed an own advanced viewer called ycomp:
+ * http://www.info.uni-karlsruhe.de/software.php/id=6&lang=en
*
- * Most routines use the name of the passed entity as the name of the
- * file dumped to.
+ * Most routines use the name of the passed entity as the name of the
+ * file dumped to.
*/
+#ifndef FIRM_IR_IRDUMP_H
+#define FIRM_IR_IRDUMP_H
-
-# ifndef _IRDUMP_H_
-# define _IRDUMP_H_
-
-# include "irnode.h"
-# include "irgraph.h"
-# include "irloop.h"
+#include "irnode.h"
+#include "irgraph.h"
+#include "irloop.h"
/**
* Names of the 32 supported colors
*/
DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void);
+/**
+ * Set the hook to be called to dump additional edges to a block.
+ * @param func The hook to be called.
+ */
+void set_dump_block_edge_hook(DUMP_NODE_EDGE_FUNC func);
+
+/**
+ * Get the additional block edge dump hook.
+ * @return The current additional block edge dump hook.
+ */
+DUMP_NODE_EDGE_FUNC get_dump_block_edge_hook(void);
+
/** Dump a firm graph.
*
* @param irg The firm graph to be dumped.
* is dumped along with the entities.
* Dumps to a file class_hierarchy.vcg
*/
-void dump_class_hierarchy (bool entities, const char *suffix);
+void dump_class_hierarchy (int entities, const char *suffix);
/* **************************************************************************** */
/* LOOPTREE DUMPERS */
/** Verbosity for text dumpers */
typedef enum {
dump_verbosity_onlynames = 0x00000001, /**< only dump names. turns off all other
- flags up to 0x00010000. */
+ flags up to 0x00010000. */
dump_verbosity_fields = 0x00000002, /**< dump types and fields (like a type declaration) */
dump_verbosity_methods = 0x00000004, /**< dump types and methods (like a type declaration) */
dump_verbosity_nostatic = 0x00000040, /**< dump types and dynamic allocated fields (like a
- type declaration). This excludes methods and
- static, polymorphic fields. */
+ type declaration). This excludes methods and
+ static, polymorphic fields. */
dump_verbosity_typeattrs = 0x00000008, /**< dump all type attributes */
dump_verbosity_entattrs = 0x00000010, /**< dump all entity attributes */
dump_verbosity_entconsts = 0x00000020, /**< dump entity constants */
dump_verbosity_onlyEnumerationTypes=0x0007F000, /**< dump only enumeration types */
dump_verbosity_max = 0x4FF00FBE /**< turn on all verbosity.
- Do not turn on negative flags!
- @@@ Because of a bug in gcc 3.2 we can not set the
- first two bits. */
+ Do not turn on negative flags!
+ @@@ Because of a bug in gcc 3.2 we can not set the
+ first two bits. */
} dump_verbosity;
/** Write the entity and all its attributes to the passed file.
* */
-void dump_entity_to_file (FILE *F, entity *ent, unsigned verbosity);
+void dump_entity_to_file (FILE *F, ir_entity *ent, unsigned verbosity);
/** Write the entity and all its attributes to the stdout.
*
* Calls dump_entity_to_file(). */
-void dump_entity (entity *ent);
+void dump_entity (ir_entity *ent);
/** Write the type and all its attributes to the file passed.
* */
-void dump_type_to_file (FILE *f, type *tp, dump_verbosity verbosity);
+void dump_type_to_file (FILE *f, ir_type *tp, dump_verbosity verbosity);
/** Write the type and all its attributes to stdout.
* */
-void dump_type (type *tp);
+void dump_type (ir_type *tp);
/** Dump type information as text.
/* FLAGS */
/* **************************************************************************** */
-/** Output a selected graph.
+/** Set a prefix filter for output functions.
*
* All graph dumpers check this name. If the name is != "" and
* not a prefix of the graph to be dumped, the dumper does not
*/
void only_dump_method_with_name(ident *name);
-/** Returns the name set with only_dump_method_with_name(). */
+/** Returns the prefix filter set with only_dump_method_with_name(). */
ident *get_dump_file_filter_ident(void);
/** Returns true if dump file filter is not set, or if it is a
void turn_off_edge_labels(void);
/**
- * If set to true constants will be replicated for every use. In non
+ * If set to non-zero constants will be replicated for every use. In non
* blocked view edges from constant to block are skipped. 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.
*/
-void dump_consts_local(bool b);
+void dump_consts_local(int flag);
/**
- * Returns false if dump_out_edge_flag or dump_loop_information_flag
+ * Returns 0 if dump_out_edge_flag or dump_loop_information_flag
* are set, else returns dump_const_local_flag.
*/
-bool get_opt_dump_const_local(void);
+int get_opt_dump_const_local(void);
/** Turns off dumping the values of constant entities. Makes type graphs
* better readable.
*/
-void dump_constant_entity_values(bool b);
+void dump_constant_entity_values(int flag);
/** Turns on dumping the edges from the End node to nodes to be kept
* alive.
*/
-void dump_keepalive_edges(bool b);
-bool get_opt_dump_keepalive_edges(void);
+void dump_keepalive_edges(int flag);
+int get_opt_dump_keepalive_edges(void);
/** Turns on dumping the out edges starting from the Start block in
* dump_ir_graph.
*
* To test the consistency of the out data structure.
*/
-void dump_out_edges(bool b);
+void dump_out_edges(int flag);
/** If this flag is set the dumper dumps edges to immediate dominator in cfg.
*/
-void dump_dominator_information(bool b);
+void dump_dominator_information(int flag);
/** If this flag is set the dumper dumps loop nodes and edges from
* these nodes to the contained ir nodes.
*
* If the loops are interprocedural nodes can be missing.
*/
-void dump_loop_information(bool b);
+void dump_loop_information(int flag);
/** If set and backedge info is computed, backedges are dumped dashed
* and as vcg 'backedge' construct.
*
* Default: set.
*/
-void dump_backedge_information(bool b);
+void dump_backedge_information(int flag);
/** Dump the information of type field specified in ana/irtypeinfo.h.
*
* If the flag is set, the type name is output in [] in the node label,
* else it is output as info.
*/
-void set_opt_dump_analysed_type_info(bool b);
+void set_opt_dump_analysed_type_info(int flag);
/** Write the address of a node into the vcg info.
*
* This is off per default for automatic comparisons of
* vcg graphs -- these will differ in the pointer values!
*/
-void dump_pointer_values_to_info(bool b);
+void dump_pointer_values_to_info(int flag);
/** Dumps ld_names of entities instead of there names.
*
* This option is on per default.
*/
-void dump_ld_names(bool b);
+void dump_ld_names(int flag);
+
+/** Dumps all graph anchor nodes, even if they
+ * are dead.
+ *
+ * This option is off per default.
+ */
+void dump_all_anchors(int flag);
+
+/** A node info dumper callback. */
+typedef void (dump_node_info_cb_t)(void *data, FILE *f, const ir_node *n);
+
+/**
+ * Adds a new node info dumper callback. It is possible to add an unlimited
+ * number of callbacks. The callbacks are called at the end of the default
+ * info dumper.
+ *
+ * @param cb the callback function to be called
+ * @param data a context parameter
+ *
+ * @return A callback handle.
+ *
+ * @note This functionality is only available, if Firm hooks are enabled (default).
+ */
+void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);
+
+/**
+ * Remove a previously added info dumper callback.
+ *
+ * @param handle the callback handle returned from dump_add_node_info_callback()
+ */
+void dump_remv_node_info_callback(void *handle);
-# endif /* _IRDUMP_H_ */
+#endif
projects / libfirm / blobdiff