git.sur5r.net Git - cc65/blob - src/cc65/codeseg.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 codeseg.h                                 */
   4 /*                                                                           */
   5 /*                          Code segment structure                           */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2001      Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  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 CODESEG_H
  37 #define CODESEG_H
  38
  39
  40
  41 #include <stdarg.h>
  42 #include <stdio.h>
  43
  44 /* common */
  45 #include "attrib.h"
  46 #include "coll.h"
  47 #include "inline.h"
  48
  49 /* cc65 */
  50 #include "codelab.h"
  51 #include "symentry.h"
  52
  53
  54
  55 /*****************************************************************************/
  56 /*                                 Forwards                                  */
  57 /*****************************************************************************/
  58
  59
  60
  61 struct CodeEntry;
  62
  63
  64
  65 /*****************************************************************************/
  66 /*                                   Data                                    */
  67 /*****************************************************************************/
  68
  69
  70
  71 /* Size of the label hash table */
  72 #define CS_LABEL_HASH_SIZE      29
  73
  74 /* Code segment structure */
  75 typedef struct CodeSeg CodeSeg;
  76 struct CodeSeg {
  77     char*           SegName;                    /* Segment name */
  78     SymEntry*       Func;                       /* Owner function */
  79     Collection      Entries;                    /* List of code entries */
  80     Collection      Labels;                     /* Labels for next insn */
  81     CodeLabel*      LabelHash [CS_LABEL_HASH_SIZE]; /* Label hash table */
  82     unsigned char   ExitRegs;                   /* Register use on exit */
  83 };
  84
  85
  86
  87 /*****************************************************************************/
  88 /*                                   Code                                    */
  89 /*****************************************************************************/
  90
  91
  92
  93 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func);
  94 /* Create a new code segment, initialize and return it */
  95
  96 void AddCodeEntry (CodeSeg* S, const char* Format, va_list ap) attribute ((format(printf,2,0)));
  97 /* Add a line to the given code segment */
  98
  99 void InsertCodeEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index);
 100 /* Insert the code entry at the index given. Following code entries will be
 101  * moved to slots with higher indices.
 102  */
 103
 104 void DelCodeEntry (CodeSeg* S, unsigned Index);
 105 /* Delete an entry from the code segment. This includes moving any associated
 106  * labels, removing references to labels and even removing the referenced labels
 107  * if the reference count drops to zero.
 108  */
 109
 110 #if defined(HAVE_INLINE)
 111 INLINE struct CodeEntry* GetCodeEntry (CodeSeg* S, unsigned Index)
 112 /* Get an entry from the given code segment */
 113 {
 114     return CollAt (&S->Entries, Index);
 115 }
 116 #else
 117 #  define GetCodeEntry(S, Index)        CollAt(&(S)->Entries, (Index))
 118 #endif
 119
 120 struct CodeEntry* GetNextCodeEntry (CodeSeg* S, unsigned Index);
 121 /* Get the code entry following the one with the index Index. If there is no
 122  * following code entry, return NULL.
 123  */
 124
 125 int GetCodeEntries (CodeSeg* S, struct CodeEntry** List,
 126                     unsigned Start, unsigned Count);
 127 /* Get Count code entries into List starting at index start. Return true if
 128  * we got the lines, return false if not enough lines were available.
 129  */
 130
 131 unsigned GetCodeEntryIndex (CodeSeg* S, struct CodeEntry* E);
 132 /* Return the index of a code entry */
 133
 134 void AddCodeLabel (CodeSeg* S, const char* Name);
 135 /* Add a code label for the next instruction to follow */
 136
 137 CodeLabel* GenCodeLabel (CodeSeg* S, struct CodeEntry* E);
 138 /* If the code entry E does already have a label, return it. Otherwise
 139  * create a new label, attach it to E and return it.
 140  */
 141
 142 void DelCodeLabel (CodeSeg* S, CodeLabel* L);
 143 /* Remove references from this label and delete it. */
 144
 145 void MergeCodeLabels (CodeSeg* S);
 146 /* Merge code labels. That means: For each instruction, remove all labels but
 147  * one and adjust references accordingly.
 148  */
 149
 150 void MoveCodeLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New);
 151 /* Move all labels from Old to New. The routine will move the labels itself
 152  * if New does not have any labels, and move references if there is at least
 153  * a label for new. If references are moved, the old label is deleted
 154  * afterwards.
 155  */
 156
 157 void RemoveCodeLabelRef (CodeSeg* S, struct CodeEntry* E);
 158 /* Remove the reference between E and the label it jumps to. The reference
 159  * will be removed on both sides and E->JumpTo will be 0 after that. If
 160  * the reference was the only one for the label, the label will get
 161  * deleted.
 162  */
 163
 164 void MoveCodeLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L);
 165 /* Change the reference of E to L instead of the current one. If this
 166  * was the only reference to the old label, the old label will get
 167  * deleted.
 168  */
 169
 170 void AddCodeSegHint (CodeSeg* S, unsigned Hint);
 171 /* Add a hint for the preceeding instruction */
 172
 173 void DelCodeSegAfter (CodeSeg* S, unsigned Last);
 174 /* Delete all entries including the given one */
 175
 176 void OutputCodeSeg (const CodeSeg* S, FILE* F);
 177 /* Output the code segment data to a file */
 178
 179 #if defined(HAVE_INLINE)
 180 INLINE unsigned GetCodeEntryCount (const CodeSeg* S)
 181 /* Return the number of entries for the given code segment */
 182 {
 183     return CollCount (&S->Entries);
 184 }
 185 #else
 186 #  define GetCodeEntryCount(S)  CollCount (&(S)->Entries)
 187 #endif
 188
 189
 190
 191 /* End of codeseg.h */
 192 #endif
 193
 194
 195