Every node has now a pinned attribute that is inherited from the op.

[libfirm] / ir / debug / dbginfo.h

diff --git a/ir/debug/dbginfo.h b/ir/debug/dbginfo.h
index e9ad670..1042a48 100644 (file)
--- a/ir/debug/dbginfo.h
+++ b/ir/debug/dbginfo.h
@@ -3,7 +3,7 @@
  * File name:   ir/debug/dbginfo.h
  * Purpose:     Implements the Firm interface to debug information.
  * Author:      Goetz Lindenmaier
- * Modified by:
+ * Modified by: Michael Beck
  * Created:     2001
  * CVS-ID:      $Id$
  * Copyright:   (c) 2001-2003 Universität Karlsruhe
@@ -11,41 +11,30 @@
  */
 
 /**
-* @file  dbginfo.h
-*
-*  This is the Firm interface to debugging support.
-*
-*  @author Goetz Lindenmaier
-*
-*  Firm requires a debugging module fulfilling this interface, else no
-*  debugging information is passed to the backend.
-*  The interface requires a datatype representing the debugging
-*  information.  Firm supports administrating a reference to the debug
-*  information in every firm node.  Further Firm optimizations call
-*  routines to propagate debug information from old nodes to new nodes
-*  if the optimization replaces the old ones by the new ones.
-*
-*/
+ * @file  dbginfo.h
+ *
+ *  This is the Firm interface to debugging support.
+ *
+ *  @author Goetz Lindenmaier
+ *
+ *  Firm requires a debugging module fulfilling this interface, else no
+ *  debugging information is passed to the backend.
+ *  The interface requires a datatype representing the debugging
+ *  information.  Firm supports administrating a reference to the debug
+ *  information in every firm node.  Further Firm optimizations call
+ *  routines to propagate debug information from old nodes to new nodes
+ *  if the optimization replaces the old ones by the new ones.
+ *
+ */
 
-# ifndef _DBGINFO_H_
-# define _DBGINFO_H_
+#ifndef _DBGINFO_H_
+#define _DBGINFO_H_
 
+#include "firm_types.h"
 #include "ident.h"
 
-#ifndef _IR_NODE_TYPEDEF_
-#define _IR_NODE_TYPEDEF_
-typedef struct ir_node ir_node;
-#endif
-
-/* to resolve recursion between entity.h and type.h */
-#ifndef _ENTITY_TYPEDEF_
-#define _ENTITY_TYPEDEF_
-typedef struct entity entity;
-#endif
-
-#ifndef _TYPE_TYPEDEF_
-#define _TYPE_TYPEDEF_
-typedef struct type type;
+#ifdef __cplusplus
+extern "C" {
 #endif
 
 /**
@@ -86,12 +75,12 @@ dbg_info *get_entity_dbg_info(entity *ent);
 /**
  * Sets the debug information of a type.
  */
-void set_type_dbg_info(type *tp, dbg_info *db);
+void set_type_dbg_info(ir_type *tp, dbg_info *db);
 
 /**
  * Returns the debug information of a type.
  */
-dbg_info *get_type_dbg_info(type *tp);
+dbg_info *get_type_dbg_info(ir_type *tp);
 
 /**
  * An enumeration indicating the action performed by a transformation.
@@ -120,44 +109,16 @@ typedef enum {
   dbg_rem_poly_call,            /**< Remove polymorphic call. */
   dbg_dead_code,                /**< Removing unreachable code, I.e. blocks that are never executed. */
   dbg_opt_confirm,              /**< A Firm subgraph was replace because of a Confirmation */
+  dbg_backend,                  /**< Backend transformation */
   dbg_max                       /**< Maximum value. */
-
 } dbg_action;
 
-
 /**
- * Converts enum values to strings.
+ * Converts a debug_action into a string.
+ *
+ * @param a  the debug action
  */
-#ifdef __GNUC__
-static const char* dbg_action_2_str(dbg_action) __attribute__ ((unused));
-#endif
-
-static const char* dbg_action_2_str(dbg_action a) {
-  switch(a) {
-  case dbg_error: return "dbg_error"; break;
-  case dbg_opt_ssa: return "dbg_opt_ssa"; break;
-  case dbg_opt_auxnode: return "dbg_opt_auxnode"; break;
-  case dbg_const_eval: return "dbg_const_eval"; break;
-  case dbg_opt_cse: return "dbg_opt_cse"; break;
-  case dbg_straightening: return "dbg_straightening"; break;
-  case dbg_if_simplification: return "dbg_if_simplification"; break;
-  case dbg_algebraic_simplification:
-    return "dbg_algebraic_simplification"; break;
-  case dbg_write_after_write: return "dbg_write_after_write"; break;
-  case dbg_write_after_read: return "dbg_write_after_read"; break;
-  case dbg_read_after_write: return "dbg_read_after_write"; break;
-  case dbg_read_after_read: return "dbg_read_after_read"; break;
-  case dbg_read_a_const: return "dbg_read_a_const"; break;
-  case dbg_rem_poly_call: return "dbg_rem_poly_call"; break;
-  case dbg_opt_confirm: return "dbg_opt_confirm"; break;
-  default:
-    if (a <= dbg_max)
-      return "string conversion not implemented";
-    else
-      assert(0);
-    return NULL;
-  }
-}
+const char *dbg_action_2_str(dbg_action a);
 
 /**
  * The type of the debug info merge function.
@@ -223,11 +184,12 @@ typedef unsigned snprint_dbg_func(char *buf, unsigned len, const dbg_info *dbg);
  *   Further both functions pass an enumeration indicating the action
  *   performed by the transformation, e.g. the kind of optimization performed.
  *
- * print_dbg is called to convert a debug info into a human readable string.
- * This string is the dumped in the duper functions.
+ * The third argument snprint_dbg is called to convert a debug info into a human readable string.
+ * This string is the dumped in the dumper functions.
  *
  * Note that if NULL is passed for dbg_info_merge_pair or dbg_info_merge_sets, the default
  * implementations default_dbg_info_merge_pair() and default_dbg_info_merge_sets() are used.
+ * NULL passed for snprint_dbg means no output.
  */
 void dbg_init(merge_pair_func *dbg_info_merge_pair, merge_sets_func *dbg_info_merge_sets, snprint_dbg_func *snprint_dbg);
 
@@ -246,4 +208,8 @@ void default_dbg_info_merge_sets(ir_node **new_nodes, int n_new_nodes,
                             ir_node **old_nodes, int n_old_nodes,
                             dbg_action info);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* _DBGINFO_H_ */