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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 segment.h                                 */
   4 /*                                                                           */
   5 /*                   Segments for the ca65 macroassembler                    */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2007 Ullrich von Bassewitz                                       */
  10 /*               Roemerstrasse 52                                            */
  11 /*               D-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 SEGMENT_H
  37 #define SEGMENT_H
  38
  39
  40
  41 /* common */
  42 #include "fragdefs.h"
  43 #include "inline.h"
  44 #include "segdefs.h"
  45
  46 /* ca65 */
  47 #include "fragment.h"
  48
  49
  50
  51 /*****************************************************************************/
  52 /*                                   Data                                    */
  53 /*****************************************************************************/
  54
  55
  56
  57 /* Segment definition */
  58 typedef struct Segment Segment;
  59 struct Segment {
  60     Segment*        List;               /* List of all segments */
  61     Fragment*       Root;               /* Root of fragment list */
  62     Fragment*       Last;               /* Pointer to last fragment */
  63     unsigned long   FragCount;          /* Number of fragments */
  64     unsigned        Num;                /* Segment number */
  65     unsigned        Align;              /* Segment alignment */
  66     int             RelocMode;          /* Relocatable mode if OrgPerSeg */
  67     unsigned long   PC;                 /* PC if in relocatable mode */
  68     unsigned long   AbsPC;              /* PC if in local absolute mode */
  69                                         /* (OrgPerSeg is true) */
  70     SegDef*         Def;                /* Segment definition (name and type) */
  71 };
  72
  73 /* Definitions for predefined segments */
  74 extern SegDef NullSegDef;
  75 extern SegDef ZeropageSegDef;
  76 extern SegDef DataSegDef;
  77 extern SegDef BssSegDef;
  78 extern SegDef RODataSegDef;
  79 extern SegDef CodeSegDef;
  80
  81 /* List of all segments */
  82 extern Segment* SegmentList;
  83
  84 /* Currently active segment */
  85 extern Segment* ActiveSeg;
  86
  87
  88
  89 /*****************************************************************************/
  90 /*                                   Code                                    */
  91 /*****************************************************************************/
  92
  93
  94
  95 Fragment* GenFragment (unsigned char Type, unsigned short Len);
  96 /* Generate a new fragment, add it to the current segment and return it. */
  97
  98 void UseSeg (const SegDef* D);
  99 /* Use the given segment */
 100
 101 #if defined(HAVE_INLINE)
 102 INLINE const SegDef* GetCurrentSegDef (void)
 103 /* Get a pointer to the segment defininition of the current segment */
 104 {
 105     return ActiveSeg->Def;
 106 }
 107 #else
 108 #  define GetCurrentSegDef()    (ActiveSeg->Def)
 109 #endif
 110
 111 #if defined(HAVE_INLINE)
 112 INLINE unsigned GetCurrentSegNum (void)
 113 /* Get the number of the current segment */
 114 {
 115     return ActiveSeg->Num;
 116 }
 117 #else
 118 #  define GetCurrentSegNum()    (ActiveSeg->Num)
 119 #endif
 120
 121 #if defined(HAVE_INLINE)
 122 INLINE unsigned char GetCurrentSegAddrSize (void)
 123 /* Get the address size of the current segment */
 124 {
 125     return ActiveSeg->Def->AddrSize;
 126 }
 127 #else
 128 #  define GetCurrentSegAddrSize()    (ActiveSeg->Def->AddrSize)
 129 #endif
 130
 131 void SegAlign (unsigned Power, int Val);
 132 /* Align the PC segment to 2^Power. If Val is -1, emit fill fragments (the
 133  * actual fill value will be determined by the linker), otherwise use the
 134  * given value.
 135  */
 136
 137 unsigned char GetSegAddrSize (unsigned SegNum);
 138 /* Return the address size of the segment with the given number */
 139
 140 unsigned long GetPC (void);
 141 /* Get the program counter of the current segment */
 142
 143 int GetRelocMode (void);
 144 /* Return true if we're currently in relocatable mode */
 145
 146 void EnterAbsoluteMode (unsigned long AbsPC);
 147 /* Enter absolute (non relocatable mode). Depending on the OrgPerSeg flag,
 148  * this will either switch the mode globally or for the current segment.
 149  */
 150
 151 void EnterRelocMode (void);
 152 /* Enter relocatable mode. Depending on the OrgPerSeg flag, this will either
 153  * switch the mode globally or for the current segment.
 154  */
 155
 156 void SegCheck (void);
 157 /* Check the segments for range and other errors */
 158
 159 void SegDump (void);
 160 /* Dump the contents of all segments */
 161
 162 void InitSegments (void);
 163 /* Initialize segments */
 164
 165 void WriteSegments (void);
 166 /* Write the segment data to the object file */
 167
 168
 169
 170 /* End of segment.h */
 171
 172 #endif
 173
 174
 175