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
  48 /* cc65 */
  49 #include "codelab.h"
  50 #include "symentry.h"
  51
  52
  53
  54 /*****************************************************************************/
  55 /*                                   Data                                    */
  56 /*****************************************************************************/
  57
  58
  59
  60 /* Size of the label hash table */
  61 #define CS_LABEL_HASH_SIZE      29
  62
  63 /* Code segment structure */
  64 typedef struct CodeSeg CodeSeg;
  65 struct CodeSeg {
  66     char*       SegName;                        /* Segment name */
  67     SymEntry*   Func;                           /* Owner function */
  68     Collection  Entries;                        /* List of code entries */
  69     Collection  Labels;                         /* Labels for next insn */
  70     CodeLabel*  LabelHash [CS_LABEL_HASH_SIZE]; /* Label hash table */
  71 };
  72
  73
  74
  75 /*****************************************************************************/
  76 /*                                   Code                                    */
  77 /*****************************************************************************/
  78
  79
  80
  81 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func);
  82 /* Create a new code segment, initialize and return it */
  83
  84 void AddCodeEntry (CodeSeg* S, const char* Format, va_list ap) attribute ((format(printf,2,0)));
  85 /* Add a line to the given code segment */
  86
  87 void DelCodeEntry (CodeSeg* S, unsigned Index);
  88 /* Delete an entry from the code segment. This includes deleting any associated
  89  * labels, removing references to labels and even removing the referenced labels
  90  * if the reference count drops to zero.
  91  */
  92
  93 void AddCodeLabel (CodeSeg* S, const char* Name);
  94 /* Add a code label for the next instruction to follow */
  95
  96 void DelCodeLabel (CodeSeg* S, CodeLabel* L);
  97 /* Remove references from this label and delete it. */
  98
  99 void AddCodeSegHint (CodeSeg* S, unsigned Hint);
 100 /* Add a hint for the preceeding instruction */
 101
 102 void DelCodeSegAfter (CodeSeg* S, unsigned Last);
 103 /* Delete all entries including the given one */
 104
 105 void OutputCodeSeg (const CodeSeg* S, FILE* F);
 106 /* Output the code segment data to a file */
 107
 108 CodeLabel* FindCodeLabel (CodeSeg* S, const char* Name, unsigned Hash);
 109 /* Find the label with the given name. Return the label or NULL if not found */
 110
 111 void MergeCodeLabels (CodeSeg* S);
 112 /* Merge code labels. That means: For each instruction, remove all labels but
 113  * one and adjust the code entries accordingly.
 114  */
 115
 116 unsigned GetCodeSegEntries (const CodeSeg* S);
 117 /* Return the number of entries for the given code segment */
 118
 119
 120
 121 /* End of codeseg.h */
 122 #endif
 123
 124
 125