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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                segments.h                                 */
   4 /*                                                                           */
   5 /*                            Segment management                             */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-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 SEGMENTS_H
  37 #define SEGMENTS_H
  38
  39
  40
  41 #include <stdio.h>
  42
  43 /* common */
  44 #include "attrib.h"
  45
  46
  47
  48 /*****************************************************************************/
  49 /*                                 Forwards                                  */
  50 /*****************************************************************************/
  51
  52
  53
  54 struct CodeEntry;
  55 struct CodeSeg;
  56 struct DataSeg;
  57 struct TextSeg;
  58 struct SymEntry;
  59
  60
  61
  62 /*****************************************************************************/
  63 /*                                   Data                                    */
  64 /*****************************************************************************/
  65
  66
  67
  68 /* Segment types */
  69 typedef enum segment_t {
  70     SEG_CODE,
  71     SEG_RODATA,
  72     SEG_DATA,
  73     SEG_BSS,
  74     SEG_COUNT
  75 } segment_t;
  76
  77 /* A list of all segments used when generating code */
  78 typedef struct Segments Segments;
  79 struct Segments {
  80     struct TextSeg*     Text;           /* Text segment */
  81     struct CodeSeg*     Code;           /* Code segment */
  82     struct DataSeg*     Data;           /* Data segment */
  83     struct DataSeg*     ROData;         /* Readonly data segment */
  84     struct DataSeg*     BSS;            /* Segment for uninitialized data */
  85     segment_t           CurDSeg;        /* Current data segment */
  86 };
  87
  88 /* Pointer to the current segment list. Output goes here. */
  89 extern Segments* CS;
  90
  91
  92
  93 /*****************************************************************************/
  94 /*                                   Code                                    */
  95 /*****************************************************************************/
  96
  97
  98
  99 void InitSegNames (void);
 100 /* Initialize the segment names */
 101
 102 void NewSegName (segment_t Seg, const char* Name);
 103 /* Set a new name for a segment */
 104
 105 int ValidSegName (const char* Name);
 106 /* Return true if the given segment name is valid, return false otherwise */
 107
 108 Segments* PushSegments (struct SymEntry* Func);
 109 /* Make the new segment list current but remember the old one */
 110
 111 void PopSegments (void);
 112 /* Pop the old segment list (make it current) */
 113
 114 void UseDataSeg (segment_t DSeg);
 115 /* For the current segment list, use the data segment DSeg */
 116
 117 struct DataSeg* GetDataSeg (void);
 118 /* Return the current data segment */
 119
 120 void AddTextLine (const char* Format, ...) attribute ((format (printf, 1, 2)));
 121 /* Add a line of code to the current text segment */
 122
 123 void AddCodeLine (const char* Format, ...) attribute ((format (printf, 1, 2)));
 124 /* Add a line of code to the current code segment */
 125
 126 void AddCode (struct CodeEntry* E);
 127 /* Add a code entry to the current code segment */
 128
 129 void AddDataLine (const char* Format, ...) attribute ((format (printf, 1, 2)));
 130 /* Add a line of data to the current data segment */
 131
 132 void OutputSegments (const Segments* S, FILE* F);
 133 /* Output the given segments to the file */
 134
 135
 136
 137 /* End of segments.h */
 138 #endif
 139
 140
 141