becopyilp: Inline struct size_red_t into struct ilp_env_t.

[libfirm] / ir / debug / dbginfo_t.h

diff --git a/ir/debug/dbginfo_t.h b/ir/debug/dbginfo_t.h
index f84a4ba..92010fd 100644 (file)
--- a/ir/debug/dbginfo_t.h
+++ b/ir/debug/dbginfo_t.h
@@ -1,28 +1,59 @@
 /*
-*  Copyright (C) 2001 by Universitaet Karlsruhe
-*  All rights reserved.
-*
-*  Authors: Goetz Lindenmaier
-*
-*  dbginfo: This is a empty implementation of the Firm interface to
-*  debugging support.  It only guarantees that the Firm library compiles
-*  and runs without any real debugging support.
-*  The functions herein are declared weak so that they can be overriden
-*  by a real implementation.
-*/
-
-/* $Id$ */
-
-#ifndef __DBGINFO_T_H__
-#define __DBGINFO_T_H__
+ * This file is part of libFirm.
+ * Copyright (C) 2012 University of Karlsruhe.
+ */
 
+/**
+ * @file
+ * @brief      Implements the Firm interface to debug information -- private header.
+ * @author     Goetz Lindenmaier
+ * @date       2001
+ * @brief
+ *  dbginfo: This is a empty implementation of the Firm interface to
+ *  debugging support.  It only guarantees that the Firm library compiles
+ *  and runs without any real debugging support.
+ */
+#ifndef FIRM_DEBUG_DBGINFO_T_H
+#define FIRM_DEBUG_DBGINFO_T_H
+
+#include <stdlib.h>
 #include "dbginfo.h"
 
-extern void (*__dbg_info_merge_pair)(ir_node *nw, ir_node *old,
-                                    dbg_action info);
+/**
+ * The default merge_pair_func implementation, simply copies the debug info
+ * from the old Firm node to the new one if the new one does not have debug info yet.
+ *
+ * @param nw    The new Firm node.
+ * @param old   The old Firm node.
+ * @param info  The action that cause old node to be replaced by new one.
+ */
+void default_dbg_info_merge_pair(ir_node *nw, ir_node *old, dbg_action info);
+
+/**
+ * The default merge_sets_func implementation.  If n_old_nodes is equal 1,
+ * copies the debug info from the old node to all new ones (if they do not have
+ * one), else does nothing.
+ *
+ * @param new_nodes     An array of new Firm nodes.
+ * @param n_new_nodes   The length of the new_nodes array.
+ * @param old_nodes     An array of old (replaced) Firm nodes.
+ * @param n_old_nodes   The length of the old_nodes array.
+ * @param info          The action that cause old node to be replaced by new one.
+ */
+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);
+
+/**
+ * The current merge_pair_func(), access only from inside firm.
+ */
+extern merge_pair_func *__dbg_info_merge_pair;
+
+/**
+ * The current merge_sets_func(), access only from inside firm.
+ */
+extern merge_sets_func *__dbg_info_merge_sets;
 
-extern void (*__dbg_info_merge_sets)(ir_node **new_nodes, int n_new_nodes,
-                                    ir_node **old_nodes, int n_old_nodes,
-                                    dbg_action info);
+void ir_dbg_info_snprint(char *buf, size_t buf_size, const dbg_info *dbg);
 
-#endif /* __DBGINFO_T_H__ */
+#endif