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
  45
  46
  47 /*****************************************************************************/
  48 /*                                   Data                                    */
  49 /*****************************************************************************/
  50
  51
  52
  53 /* Predefined line info slots. These are allocated when initializing the
  54  * module. Beware: Some code relies on the fact that slot zero is the basic
  55  * standard line info. It is assumed to be always there.
  56  */
  57 enum {
  58     LI_SLOT_ASM         = 0,            /* Normal assembler source */
  59     LI_SLOT_EXT         = 1,            /* Externally supplied line info */
  60 };
  61
  62 /* Types of line infos. The low byte may be used for some sort of depth
  63  * counter.
  64  */
  65 enum {
  66     LI_MASK_COUNT       = 0x00FF,       /* Mask to extract the count */
  67
  68     LI_TYPE_EXT         = 0x0100,       /* Externally supplied line info */
  69     LI_TYPE_ASM         = 0x0200,       /* Normal assembler source */
  70     LI_TYPE_MACRO       = 0x0300,       /* Macro expansion */
  71     LI_MASK_TYPE        = 0x7F00,       /* Mask to extract the type */
  72 };
  73
  74 /* The LineInfo structure is shared between several fragments, so we need a
  75  * reference counter.
  76  */
  77 typedef struct LineInfo LineInfo;
  78 struct LineInfo {
  79     unsigned    Usage;                  /* Usage counter */
  80     unsigned    Type;                   /* Type of line info */
  81     unsigned    Index;                  /* Index */
  82     FilePos     Pos;                    /* File position */
  83 };
  84
  85
  86
  87 /*****************************************************************************/
  88 /*                                   Code                                    */
  89 /*****************************************************************************/
  90
  91
  92
  93 void InitLineInfo (void);
  94 /* Initialize the line infos */
  95
  96 unsigned AllocLineInfoSlot (unsigned Type);
  97 /* Allocate a line info slot of the given type and return the slot index */
  98
  99 void FreeLineInfoSlot (unsigned Slot);
 100 /* Free the line info in the given slot. Note: Alloc/Free must be used in
 101  * FIFO order.
 102  */
 103
 104 void GenLineInfo (unsigned Slot, const FilePos* Pos);
 105 /* Generate a new line info in the given slot */
 106
 107 void ClearLineInfo (unsigned Slot);
 108 /* Clear the line info in the given slot */
 109
 110 LineInfo* GetLineInfo (unsigned Slot);
 111 /* Get the line info from the given slot */
 112
 113 void GetFullLineInfo (Collection* LineInfos);
 114 /* Return full line infos, that is line infos for all slots in LineInfos. The
 115  * function does also increase the usage counter for all line infos returned.
 116  */
 117
 118 LineInfo* UseLineInfo (LineInfo* LI);
 119 /* Increase the reference count of the given line info and return it. The
 120  * function will gracefully accept NULL pointers and do nothing in this case.
 121  */
 122
 123 LineInfo* ReleaseLineInfo (LineInfo* LI);
 124 /* Decrease the reference count of the given line info and return it. The
 125  * function will gracefully accept NULL pointers and do nothing in this case.
 126  */
 127
 128 void WriteLineInfo (const Collection* LineInfos);
 129 /* Write a list of line infos to the object file. MakeLineInfoIndex has to
 130  * be called before!
 131  */
 132
 133 void MakeLineInfoIndex (void);
 134 /* Index the line infos */
 135
 136 void WriteLineInfos (void);
 137 /* Write a list of all line infos to the object file. */
 138
 139
 140
 141 /* End of lineinfo.h */
 142 #endif
 143
 144
 145