git.sur5r.net Git - cc65/blob - src/ca65/lineinfo.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                lineinfo.h                                 */
   4 /*                                                                           */
   5 /*                     Source file line info management                      */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2001-2011, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 52                                           */
  11 /*                70794 Filderstadt                                          */
  12 /* EMail:         uz@cc65.org                                                */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef LINEINFO_H
  37 #define LINEINFO_H
  38
  39
  40
  41 /* common */
  42 #include "coll.h"
  43 #include "filepos.h"
  44 #include "lidefs.h"
  45
  46
  47
  48 /*****************************************************************************/
  49 /*                                   Data                                    */
  50 /*****************************************************************************/
  51
  52
  53
  54 /* Predefined line info slots. These are allocated when initializing the
  55  * module. Beware: Some code relies on the fact that slot zero is the basic
  56  * standard line info. It is assumed to be always there.
  57  */
  58 enum {
  59     LI_SLOT_INV         = -1,           /* Use to mark invalid slots */
  60     LI_SLOT_ASM         = 0,            /* Normal assembler source */
  61     LI_SLOT_EXT         = 1,            /* Externally supplied line info */
  62 };
  63
  64 /* The LineInfo structure is shared between several fragments, so we need a
  65  * reference counter.
  66  */
  67 typedef struct LineInfo LineInfo;
  68 struct LineInfo {
  69     unsigned    Usage;                  /* Usage counter */
  70     unsigned    Type;                   /* Type of line info */
  71     unsigned    Index;                  /* Index */
  72     FilePos     Pos;                    /* File position */
  73 };
  74
  75
  76
  77 /*****************************************************************************/
  78 /*                                   Code                                    */
  79 /*****************************************************************************/
  80
  81
  82
  83 void InitLineInfo (void);
  84 /* Initialize the line infos */
  85
  86 int AllocLineInfoSlot (unsigned Type, unsigned Count);
  87 /* Allocate a line info slot of the given type and return the slot index */
  88
  89 void FreeLineInfoSlot (int Slot);
  90 /* Free the line info in the given slot. Note: Alloc/Free must be used in
  91  * FIFO order.
  92  */
  93
  94 void GenLineInfo (int Slot, const FilePos* Pos);
  95 /* Generate a new line info in the given slot */
  96
  97 void ClearLineInfo (int Slot);
  98 /* Clear the line info in the given slot */
  99
 100 void GetFullLineInfo (Collection* LineInfos, unsigned IncUsage);
 101 /* Return full line infos, that is line infos for all slots in LineInfos. The
 102  * function will clear LineInfos before usage and will increment the usage
 103  * counter by IncUsage for all line infos returned.
 104  */
 105
 106 LineInfo* ReleaseLineInfo (LineInfo* LI);
 107 /* Decrease the reference count of the given line info and return it. The
 108  * function will gracefully accept NULL pointers and do nothing in this case.
 109  */
 110
 111 #if defined(HAVE_INLINE)
 112 INLINE const FilePos* GetSourcePos (const LineInfo* LI)
 113 /* Return the source file position from the given line info */
 114 {
 115     return &LI->Pos;
 116 }
 117 #else
 118 #  define GetSourcePos(LI)      (&(LI)->Pos)
 119 #endif
 120
 121 #if defined(HAVE_INLINE)
 122 INLINE unsigned GetLineInfoType (const LineInfo* LI)
 123 /* Return the type of a line info */
 124 {
 125     return LI_GET_TYPE (LI->Type);
 126 }
 127 #else
 128 #  define GetLineInfoType(LI)     LI_GET_TYPE ((LI)->Type)
 129 #endif
 130
 131 void WriteLineInfo (const Collection* LineInfos);
 132 /* Write a list of line infos to the object file. MakeLineInfoIndex has to
 133  * be called before!
 134  */
 135
 136 void MakeLineInfoIndex (void);
 137 /* Index the line infos */
 138
 139 void WriteLineInfos (void);
 140 /* Write a list of all line infos to the object file. */
 141
 142
 143
 144 /* End of lineinfo.h */
 145 #endif
 146
 147
 148
 149