git.sur5r.net Git - cc65/blob - src/ld65/exports.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 exports.h                                 */
   4 /*                                                                           */
   5 /*                    Exports handing for the ld65 linker                    */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2003 Ullrich von Bassewitz                                       */
  10 /*               Römerstraße 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 EXPORTS_H
  37 #define EXPORTS_H
  38
  39
  40
  41 #include <stdio.h>
  42
  43 /* common */
  44 #include "cddefs.h"
  45 #include "exprdefs.h"
  46 #include "filepos.h"
  47
  48 /* ld65 */
  49 #include "objdata.h"
  50 #include "config.h"
  51
  52
  53
  54 /*****************************************************************************/
  55 /*                                   Data                                    */
  56 /*****************************************************************************/
  57
  58
  59
  60 /* Import symbol structure */
  61 typedef struct Import Import;
  62 struct Import {
  63     Import*             Next;           /* Single linked list */
  64     ObjData*            Obj;            /* Object file that imports the name */
  65     FilePos             Pos;            /* File position of reference */
  66     struct Export*      Exp;            /* Matching export for this import */
  67     unsigned            Name;           /* Name if not in table */
  68     unsigned char       Flags;          /* Generic flags */
  69     unsigned char       AddrSize;       /* Address size of import */
  70 };
  71
  72
  73
  74 /* Export symbol structure */
  75 typedef struct Export Export;
  76 struct Export {
  77     unsigned            Name;           /* Name */
  78     Export*             Next;           /* Hash table link */
  79     unsigned            Flags;          /* Generic flags */
  80     ObjData*            Obj;            /* Object file that exports the name */
  81     unsigned            ImpCount;       /* How many imports for this symbol? */
  82     Import*             ImpList;        /* List of imports for this symbol */
  83     FilePos             Pos;            /* File position of definition */
  84     ExprNode*           Expr;           /* Expression (0 if not def'd) */
  85     unsigned char       Type;           /* Type of export */
  86     unsigned char       AddrSize;       /* Address size of export */
  87     unsigned char       ConDes[CD_TYPE_COUNT];  /* Constructor/destructor decls */
  88 };
  89
  90
  91
  92 /* Prototype of a function that is called if an undefined symbol is found. It
  93  * may check if the symbol is an external symbol (for binary formats that
  94  * support externals) and will return zero if the symbol could not be
  95  * resolved, or a value != zero if the symbol could be resolved. The
  96  * CheckExports routine will print out the missing symbol in the first case.
  97  */
  98 typedef int (*ExpCheckFunc) (unsigned Name, void* Data);
  99
 100
 101
 102 /*****************************************************************************/
 103 /*                                   Code                                    */
 104 /*****************************************************************************/
 105
 106
 107
 108 void FreeImport (Import* I);
 109 /* Free an import. NOTE: This won't remove the import from the exports table,
 110  * so it may only be called for unused imports (imports from modules that
 111  * aren't referenced).
 112  */
 113
 114 Import* ReadImport (FILE* F, ObjData* Obj);
 115 /* Read an import from a file and insert it into the table */
 116
 117 void InsertImport (Import* I);
 118 /* Insert an import into the table */
 119
 120 void FreeExport (Export* E);
 121 /* Free an export. NOTE: This won't remove the export from the exports table,
 122  * so it may only be called for unused exports (exports from modules that
 123  * aren't referenced).
 124  */
 125
 126 Export* ReadExport (FILE* F, ObjData* Obj);
 127 /* Read an export from a file */
 128
 129 void InsertExport (Export* E);
 130 /* Insert an exported identifier and check if it's already in the list */
 131
 132 Export* CreateConstExport (unsigned Name, long Value);
 133 /* Create an export for a literal date */
 134
 135 Export* CreateMemoryExport (unsigned Name, Memory* Mem, unsigned long Offs);
 136 /* Create an relative export for a memory area offset */
 137
 138 Export* CreateSegmentExport (unsigned Name, Segment* Seg, unsigned long Offs);
 139 /* Create a relative export to a segment */
 140
 141 Export* CreateSectionExport (unsigned Name, Section* S, unsigned long Offs);
 142 /* Create a relative export to a section */
 143
 144 Export* FindExport (unsigned Name);
 145 /* Check for an identifier in the list. Return 0 if not found, otherwise
 146  * return a pointer to the export.
 147  */
 148
 149 int IsUnresolved (unsigned Name);
 150 /* Check if this symbol is an unresolved export */
 151
 152 int IsUnresolvedExport (const Export* E);
 153 /* Return true if the given export is unresolved */
 154
 155 int IsConstExport (const Export* E);
 156 /* Return true if the expression associated with this export is const */
 157
 158 long GetExportVal (const Export* E);
 159 /* Get the value of this export */
 160
 161 void CheckExports (ExpCheckFunc F, void* Data);
 162 /* Check if there are any unresolved symbols. On unresolved symbols, F is
 163  * called (see the comments on ExpCheckFunc in the data section).
 164  */
 165
 166 void PrintExportMap (FILE* F);
 167 /* Print an export map to the given file */
 168
 169 void PrintImportMap (FILE* F);
 170 /* Print an import map to the given file */
 171
 172 void PrintExportLabels (FILE* F);
 173 /* Print the exports in a VICE label file */
 174
 175 void MarkExport (Export* E);
 176 /* Mark the export */
 177
 178 void UnmarkExport (Export* E);
 179 /* Remove the mark from the export */
 180
 181 int ExportHasMark (Export* E);
 182 /* Return true if the export has a mark */
 183
 184 void CircularRefError (const Export* E);
 185 /* Print an error about a circular reference using to define the given export */
 186
 187
 188
 189 /* End of exports.h */
 190
 191 #endif
 192
 193
 194
 195