1 /*****************************************************************************/
5 /* Exports handing for the ld65 linker */
9 /* (C) 1998-2003 Ullrich von Bassewitz */
10 /* Römerstrasse 52 */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
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. */
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: */
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 */
32 /*****************************************************************************/
54 /*****************************************************************************/
56 /*****************************************************************************/
60 /* Import symbol structure */
61 typedef struct Import 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 Type; /* Type of import */
74 /* Export symbol structure */
75 typedef struct Export 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 ConDes[CD_TYPE_COUNT]; /* Constructor/destructor decls */
91 /* Prototype of a function that is called if an undefined symbol is found. It
92 * may check if the symbol is an external symbol (for binary formats that
93 * support externals) and will return zero if the symbol could not be
94 * resolved, or a value != zero if the symbol could be resolved. The
95 * CheckExports routine will print out the missing symbol in the first case.
97 typedef int (*ExpCheckFunc) (unsigned Name, void* Data);
101 /*****************************************************************************/
103 /*****************************************************************************/
107 void FreeImport (Import* I);
108 /* Free an import. NOTE: This won't remove the import from the exports table,
109 * so it may only be called for unused imports (imports from modules that
110 * aren't referenced).
113 Import* ReadImport (FILE* F, ObjData* Obj);
114 /* Read an import from a file and insert it into the table */
116 void InsertImport (Import* I);
117 /* Insert an import into the table */
119 void FreeExport (Export* E);
120 /* Free an export. NOTE: This won't remove the export from the exports table,
121 * so it may only be called for unused exports (exports from modules that
122 * aren't referenced).
125 Export* ReadExport (FILE* F, ObjData* Obj);
126 /* Read an export from a file */
128 void InsertExport (Export* E);
129 /* Insert an exported identifier and check if it's already in the list */
131 Export* CreateConstExport (unsigned Name, long Value);
132 /* Create an export for a literal date */
134 Export* CreateMemoryExport (unsigned Name, Memory* Mem, unsigned long Offs);
135 /* Create an relative export for a memory area offset */
137 Export* CreateSegmentExport (unsigned Name, Segment* Seg, unsigned long Offs);
138 /* Create a relative export to a segment */
140 Export* CreateSectionExport (unsigned Name, Section* S, unsigned long Offs);
141 /* Create a relative export to a section */
143 Export* FindExport (unsigned Name);
144 /* Check for an identifier in the list. Return 0 if not found, otherwise
145 * return a pointer to the export.
148 int IsUnresolved (unsigned Name);
149 /* Check if this symbol is an unresolved export */
151 int IsUnresolvedExport (const Export* E);
152 /* Return true if the given export is unresolved */
154 int IsConstExport (const Export* E);
155 /* Return true if the expression associated with this export is const */
157 long GetExportVal (const Export* E);
158 /* Get the value of this export */
160 void CheckExports (ExpCheckFunc F, void* Data);
161 /* Check if there are any unresolved symbols. On unresolved symbols, F is
162 * called (see the comments on ExpCheckFunc in the data section).
165 void PrintExportMap (FILE* F);
166 /* Print an export map to the given file */
168 void PrintImportMap (FILE* F);
169 /* Print an import map to the given file */
171 void PrintExportLabels (FILE* F);
172 /* Print the exports in a VICE label file */
174 void MarkExport (Export* E);
175 /* Mark the export */
177 void UnmarkExport (Export* E);
178 /* Remove the mark from the export */
180 int ExportHasMark (Export* E);
181 /* Return true if the export has a mark */
183 void CircularRefError (const Export* E);
184 /* Print an error about a circular reference using to define the given export */
188 /* End of exports.h */