fix cmp_ASM_attr
[libfirm] / ir / debug / debugger.h
index 37d790a..b1310a1 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
  * PURPOSE.
  */
 
-/*
- * Project:     libFIRM
- * File name:   ir/debug/debugger.h
- * Purpose:     Helper function for integerated debug support
- * Author:      Michael Beck
- * Modified by:
- * Created:     2005
- * CVS-ID:      $Id$
- * Copyright:   (c) 2001-2005 Universität Karlsruhe
- */
-#ifndef __DEBUGGER_H__
-#define __DEBUGGER_H__
+/**
+ * @file
+ * @brief     Helper function for integrated debug support
+ * @author    Michael Beck
+ * @date      2005
+ * @version   $Id$
+ */
+#ifndef FIRM_DEBUG_DEBUGGER_H
+#define FIRM_DEBUG_DEBUGGER_H
+
+#include "firm_types.h"
 
 /** Break into the debugger. */
 void firm_debug_break(void);
@@ -45,4 +44,43 @@ void firm_break(const char *cmd);
 /** Creates the debugger tables. */
 void firm_init_debugger(void);
 
-#endif /* __DEBUGGER_H__ */
+/**
+ * @defgroup external_debug    helper functions for debuggers
+ *
+ * @{
+ */
+
+/**
+ * Returns non-zero, if the debug extension is active
+ */
+int firm_debug_active(void);
+
+/**
+ * Return the content of the debug text buffer.
+ *
+ * To be called from the debugger.
+ */
+const char *firm_debug_text(void);
+
+/**
+ * A gdb helper function to print tarvals.
+ */
+const char *gdb_tarval_helper(void *tv_object);
+
+/**
+ * A gdb helper to print all (new-style-) out edges of a node
+ */
+const char *gdb_out_edge_helper(const ir_node *node);
+
+/**
+ * High level function to use from debugger interface
+ *
+ * See show_commands() for supported commands.
+ */
+void firm_debug(const char *cmd);
+
+/**
+ * @}
+ */
+
+#endif