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 CodeSeg;
  55 struct DataSeg;
  56 struct SymEntry;
  57
  58
  59
  60 /*****************************************************************************/
  61 /*                                   Data                                    */
  62 /*****************************************************************************/
  63
  64
  65
  66 /* Segment types */
  67 typedef enum segment_t {
  68     SEG_CODE,
  69     SEG_RODATA,
  70     SEG_DATA,
  71     SEG_BSS,
  72     SEG_COUNT
  73 } segment_t;
  74
  75 /* A list of all segments used when generating code */
  76 typedef struct Segments Segments;
  77 struct Segments {
  78     struct CodeSeg*     Code;           /* Code segment */
  79     struct DataSeg*     Data;           /* Data segment */
  80     struct DataSeg*     ROData;         /* Readonly data segment */
  81     struct DataSeg*     BSS;            /* Segment for uninitialized data */
  82     segment_t           CurDSeg;        /* Current data segment */
  83 };
  84
  85 /* Pointer to the current segment list. Output goes here. */
  86 extern Segments* CS;
  87
  88
  89
  90 /*****************************************************************************/
  91 /*                                   Code                                    */
  92 /*****************************************************************************/
  93
  94
  95
  96 void InitSegNames (void);
  97 /* Initialize the segment names */
  98
  99 void NewSegName (segment_t Seg, const char* Name);
 100 /* Set a new name for a segment */
 101
 102 int ValidSegName (const char* Name);
 103 /* Return true if the given segment name is valid, return false otherwise */
 104
 105 Segments* PushSegments (struct SymEntry* Func);
 106 /* Make the new segment list current but remember the old one */
 107
 108 void PopSegments (void);
 109 /* Pop the old segment list (make it current) */
 110
 111 void UseDataSeg (segment_t DSeg);
 112 /* For the current segment list, use the data segment DSeg */
 113
 114 struct DataSeg* GetDataSeg (void);
 115 /* Return the current data segment */
 116
 117 void AddCodeLine (const char* Format, ...) attribute ((format (printf, 1, 2)));
 118 /* Add a line of code to the current code segment */
 119
 120 void AddDataLine (const char* Format, ...) attribute ((format (printf, 1, 2)));
 121 /* Add a line of data to the current data segment */
 122
 123 void OutputSegments (const Segments* S, FILE* F);
 124 /* Output the given segments to the file */
 125
 126
 127
 128 /* End of segments.h */
 129 #endif
 130
 131
 132