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 "lineinfo.h"
  52 #include "symentry.h"
  53
  54
  55
  56 /*****************************************************************************/
  57 /*                                 Forwards                                  */
  58 /*****************************************************************************/
  59
  60
  61
  62 struct CodeEntry;
  63
  64
  65
  66 /*****************************************************************************/
  67 /*                                   Data                                    */
  68 /*****************************************************************************/
  69
  70
  71
  72 /* Size of the label hash table */
  73 #define CS_LABEL_HASH_SIZE      29
  74
  75 /* Code segment structure */
  76 typedef struct CodeSeg CodeSeg;
  77 struct CodeSeg {
  78     char*           SegName;                    /* Segment name */
  79     SymEntry*       Func;                       /* Owner function */
  80     Collection      Entries;                    /* List of code entries */
  81     Collection      Labels;                     /* Labels for next insn */
  82     CodeLabel*      LabelHash [CS_LABEL_HASH_SIZE]; /* Label hash table */
  83     unsigned char   ExitRegs;                   /* Register use on exit */
  84 };
  85
  86
  87
  88 /*****************************************************************************/
  89 /*                                   Code                                    */
  90 /*****************************************************************************/
  91
  92
  93
  94 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func);
  95 /* Create a new code segment, initialize and return it */
  96
  97 void CS_AddEntry (CodeSeg* S, struct CodeEntry* E);
  98 /* Add an entry to the given code segment */
  99
 100 void CS_AddLine (CodeSeg* S, LineInfo* LI, const char* Format, va_list ap) attribute ((format(printf,3,0)));
 101 /* Add a line to the given code segment */
 102
 103 void CS_InsertEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index);
 104 /* Insert the code entry at the index given. Following code entries will be
 105  * moved to slots with higher indices.
 106  */
 107
 108 void CS_DelEntry (CodeSeg* S, unsigned Index);
 109 /* Delete an entry from the code segment. This includes moving any associated
 110  * labels, removing references to labels and even removing the referenced labels
 111  * if the reference count drops to zero.
 112  */
 113
 114 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count);
 115 /* Delete a range of code entries. This includes removing references to labels,
 116  * labels attached to the entries and so on.
 117  */
 118
 119 void CS_MoveEntries (CodeSeg* S, unsigned Start, unsigned Count, unsigned NewPos);
 120 /* Move a range of entries from one position to another. Start is the index
 121  * of the first entry to move, Count is the number of entries and NewPos is
 122  * the index of the target entry. The entry with the index Start will later
 123  * have the index NewPos. All entries with indices NewPos and above are
 124  * moved to higher indices. If the code block is moved to the end of the
 125  * current code, and if pending labels exist, these labels will get attached
 126  * to the first instruction of the moved block (the first one after the
 127  * current code end)
 128  */
 129
 130 #if defined(HAVE_INLINE)
 131 INLINE void CS_MoveEntry (CodeSeg* S, unsigned OldPos, unsigned NewPos)
 132 /* Move an entry from one position to another. OldPos is the current position
 133  * of the entry, NewPos is the new position of the entry.
 134  */
 135 {
 136     CollMove (&S->Entries, OldPos, NewPos);
 137 }
 138 #else
 139 #  define CS_MoveEntry(S, OldPos, NewPos)       CollMove (&(S)->Entries, OldPos, NewPos)
 140 #endif
 141
 142 #if defined(HAVE_INLINE)
 143 INLINE struct CodeEntry* CS_GetEntry (CodeSeg* S, unsigned Index)
 144 /* Get an entry from the given code segment */
 145 {
 146     return CollAt (&S->Entries, Index);
 147 }
 148 #else
 149 #  define CS_GetEntry(S, Index) CollAt(&(S)->Entries, (Index))
 150 #endif
 151
 152 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index);
 153 /* Get the code entry following the one with the index Index. If there is no
 154  * following code entry, return NULL.
 155  */
 156
 157 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
 158                    unsigned Start, unsigned Count);
 159 /* Get Count code entries into List starting at index start. Return true if
 160  * we got the lines, return false if not enough lines were available.
 161  */
 162
 163 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E);
 164 /* Return the index of a code entry */
 165
 166 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name);
 167 /* Add a code label for the next instruction to follow */
 168
 169 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E);
 170 /* If the code entry E does already have a label, return it. Otherwise
 171  * create a new label, attach it to E and return it.
 172  */
 173
 174 void CS_DelLabel (CodeSeg* S, CodeLabel* L);
 175 /* Remove references from this label and delete it. */
 176
 177 void CS_MergeLabels (CodeSeg* S);
 178 /* Merge code labels. That means: For each instruction, remove all labels but
 179  * one and adjust references accordingly.
 180  */
 181
 182 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New);
 183 /* Move all labels from Old to New. The routine will move the labels itself
 184  * if New does not have any labels, and move references if there is at least
 185  * a label for new. If references are moved, the old label is deleted
 186  * afterwards.
 187  */
 188
 189 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E);
 190 /* Remove the reference between E and the label it jumps to. The reference
 191  * will be removed on both sides and E->JumpTo will be 0 after that. If
 192  * the reference was the only one for the label, the label will get
 193  * deleted.
 194  */
 195
 196 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L);
 197 /* Change the reference of E to L instead of the current one. If this
 198  * was the only reference to the old label, the old label will get
 199  * deleted.
 200  */
 201
 202 void CS_DelCodeAfter (CodeSeg* S, unsigned Last);
 203 /* Delete all entries including the given one */
 204
 205 void CS_Output (const CodeSeg* S, FILE* F);
 206 /* Output the code segment data to a file */
 207
 208 #if defined(HAVE_INLINE)
 209 INLINE unsigned CS_GetEntryCount (const CodeSeg* S)
 210 /* Return the number of entries for the given code segment */
 211 {
 212     return CollCount (&S->Entries);
 213 }
 214 #else
 215 #  define CS_GetEntryCount(S)   CollCount (&(S)->Entries)
 216 #endif
 217
 218
 219
 220 /* End of codeseg.h */
 221 #endif
 222
 223
 224