added new licence header

[libfirm] / ir / ir / irdump.h

diff --git a/ir/ir/irdump.h b/ir/ir/irdump.h
index 96a9b6c..58c352e 100644 (file)
--- a/ir/ir/irdump.h
+++ b/ir/ir/irdump.h
@@ -1,3 +1,22 @@
+/*
+ * 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.
+ */
+
 /*
  * Project:     libFIRM
  * File name:   ir/ir/irdump.h
@@ -7,10 +26,8 @@
  * Created:
  * CVS-ID:      $Id$
  * Copyright:   (c) 1998-2003 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
 
-
 /**
  * @file irdump.h
  *
@@ -28,14 +45,12 @@
  * 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
@@ -151,6 +166,18 @@ void set_dump_node_edge_hook(DUMP_NODE_EDGE_FUNC func);
  */
 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.
@@ -501,12 +528,12 @@ typedef enum {
 
 /** 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.
  * */
@@ -547,7 +574,7 @@ void dump_globals_as_text(unsigned verbosity, const char *suffix);
 /*                                    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
@@ -558,7 +585,7 @@ void dump_globals_as_text(unsigned verbosity, const char *suffix);
  */
 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
@@ -644,4 +671,35 @@ void dump_pointer_values_to_info(int flag);
  */
 void dump_ld_names(int flag);
 
-# endif /* _IRDUMP_H_ */
+/** 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 /* _FIRM_IR_IRDUMP_H_ */