removed unused header

[libfirm] / ir / debug / seqnumbers.h

diff --git a/ir/debug/seqnumbers.h b/ir/debug/seqnumbers.h
index fa9a2c6..bc48057 100644 (file)
--- a/ir/debug/seqnumbers.h
+++ b/ir/debug/seqnumbers.h
@@ -1,29 +1,45 @@
 /*
- * Project:     libFIRM
- * File name:   ir/debug/seqnumbers.h
- * Purpose:     Implements simple sequence numbers for Firm debug info.
- * Author:      Michael Beck
- * Modified by:
- * Created:     2005
- * CVS-ID:      $Id$
- * Copyright:   (c) 2001-2005 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 seqnumbers.h
+ * @file
+ * @brief    Implements simple sequence numbers for Firm debug info.
+ * @author   Michael Beck
+ * @date     2005
+ * @version  $Id$
+ * @summary
+ *  Sequence numbers for Firm.
  *
- * Sequence numbers for Firm.
- *
- * A sequence number is an unique number representing a filename
- * and a line number. The number 0 represents empty information.
- * This module is an optional "snap-in" for the Firm debug info.
+ *  A sequence number is an unique number representing a filename
+ *  and a line number. The number 0 represents empty information.
+ *  This module is an optional "snap-in" for the Firm debug info.
+ *  In simple cases it should be possible to use sequence numbers
+ *  as dbg_info.
  */
-#ifndef _SEQNUMBERS_H_
-#define _SEQNUMBERS_H_
+#ifndef FIRM_DEBUG_SEQNUMBERS_H
+#define FIRM_DEBUG_SEQNUMBERS_H
 
 #include "ident.h"
 
+/**
+ * An opaque type for a sequence number.
+ */
 #ifndef _SEQNO_T_TYPEDEF_
 #define _SEQNO_T_TYPEDEF_
 typedef struct sn_entry *seqno_t;
@@ -39,6 +55,16 @@ typedef struct sn_entry *seqno_t;
  */
 seqno_t firm_seqno_enter(const char *filename, unsigned lineno);
 
+/**
+ * Create a new sequence number from a filename ident and a line number.
+ *
+ * @param filename  an ident
+ * @param lineno    a line number
+ *
+ * @return  a sequence number for this position.
+ */
+seqno_t firm_seqno_enter_id(ident *filename, unsigned lineno);
+
 /**
  * Retrieve filename and line number from a sequence number.
  *
@@ -50,7 +76,7 @@ seqno_t firm_seqno_enter(const char *filename, unsigned lineno);
 const char *firm_seqno_retrieve(seqno_t seqno, unsigned *lineno);
 
 /**
- * Creates the seqno pool.
+ * Creates the sequence number pool.
  * Is not called by init_firm(), because the sequence number
  * support is optional. Call firm_seqno_init() after init_firm()
  * if sequence numbers should be used.
@@ -58,11 +84,11 @@ const char *firm_seqno_retrieve(seqno_t seqno, unsigned *lineno);
 void firm_seqno_init(void);
 
 /**
- * Terminates the seqno pool.
+ * Terminates the sequence number pool.
  * Sequence numbers cannot be resolved anymore.
- * Call this fucntion to terminate the sequence
+ * Call this function to terminate the sequence
  * pool.
  */
 void firm_seqno_term(void);
 
-#endif /* _SEQNUMBERS_H_ */
+#endif