/*****************************************************************************/
/*                                                                           */
/*                                 exports.h                                 */
/*                                                                           */
/*                    Exports handing for the ld65 linker                    */
/*                                                                           */
/*                                                                           */
/*                                                                           */
/* (C) 1998-2011, Ullrich von Bassewitz                                      */
/*                Roemerstrasse 52                                           */
/*                D-70794 Filderstadt                                        */
/* EMail:         uz@cc65.org                                                */
/*                                                                           */
/*                                                                           */
/* This software is provided 'as-is', without any expressed or implied       */
/* warranty.  In no event will the authors be held liable for any damages    */
/* arising from the use of this software.                                    */
/*                                                                           */
/* Permission is granted to anyone to use this software for any purpose,     */
/* including commercial applications, and to alter it and redistribute it    */
/* freely, subject to the following restrictions:                            */
/*                                                                           */
/* 1. The origin of this software must not be misrepresented; you must not   */
/*    claim that you wrote the original software. If you use this software   */
/*    in a product, an acknowledgment in the product documentation would be  */
/*    appreciated but is not required.                                       */
/* 2. Altered source versions must be plainly marked as such, and must not   */
/*    be misrepresented as being the original software.                      */
/* 3. This notice may not be removed or altered from any source              */
/*    distribution.                                                          */
/*                                                                           */
/*****************************************************************************/



#ifndef EXPORTS_H
#define EXPORTS_H



#include <stdio.h>

/* common */
#include "cddefs.h"
#include "coll.h"
#include "exprdefs.h"

/* ld65 */
#include "config.h"
#include "lineinfo.h"
#include "memarea.h"
#include "objdata.h"



/*****************************************************************************/
/*                                   Data                                    */
/*****************************************************************************/



/* Import symbol structure */
typedef struct Import Import;
struct Import {
    Import*             Next;           /* Single linked list */
    ObjData*            Obj;            /* Object file that imports the name */
    Collection          DefLines;       /* Line infos of definition */
    Collection          RefLines;       /* Line infos of reference */
    struct Export*      Exp;            /* Matching export for this import */
    unsigned            Name;           /* Name if not in table */
    unsigned short      Flags;          /* Generic flags */
    unsigned short      AddrSize;       /* Address size of import */
};



/* Export symbol structure */
typedef struct Export Export;
struct Export {
    unsigned            Name;           /* Name */
    Export*             Next;           /* Hash table link */
    unsigned            Flags;          /* Generic flags */
    ObjData*            Obj;            /* Object file that exports the name */
    unsigned            ImpCount;       /* How many imports for this symbol? */
    Import*             ImpList;        /* List of imports for this symbol */
    ExprNode*           Expr;           /* Expression (0 if not def'd) */
    unsigned            Size;           /* Size of the symbol if any */
    Collection          DefLines;       /* Line infos of definition */
    Collection          RefLines;       /* Line infos of reference */
    unsigned            DbgSymId;       /* Id of debug symbol for this export */
    unsigned short      Type;           /* Type of export */
    unsigned short      AddrSize;       /* Address size of export */
    unsigned char       ConDes[CD_TYPE_COUNT];  /* Constructor/destructor decls */
};



/* Prototype of a function that is called if an undefined symbol is found. It
 * may check if the symbol is an external symbol (for binary formats that
 * support externals) and will return zero if the symbol could not be
 * resolved, or a value != zero if the symbol could be resolved. The
 * CheckExports routine will print out the missing symbol in the first case.
 */
typedef int (*ExpCheckFunc) (unsigned Name, void* Data);



/*****************************************************************************/
/*                                   Code                                    */
/*****************************************************************************/



void FreeImport (Import* I);
/* Free an import. NOTE: This won't remove the import from the exports table,
 * so it may only be called for unused imports (imports from modules that
 * aren't referenced).
 */

Import* ReadImport (FILE* F, ObjData* Obj);
/* Read an import from a file and insert it into the table */

Import* GenImport (unsigned Name, unsigned char AddrSize);
/* Generate a new import with the given name and address size and return it */

Import* InsertImport (Import* I);
/* Insert an import into the table, return I */

const LineInfo* GetImportPos (const Import* I);
/* Return the basic line info of an import */

void FreeExport (Export* E);
/* Free an export. NOTE: This won't remove the export from the exports table,
 * so it may only be called for unused exports (exports from modules that
 * aren't referenced).
 */

Export* ReadExport (FILE* F, ObjData* Obj);
/* Read an export from a file */

void InsertExport (Export* E);
/* Insert an exported identifier and check if it's already in the list */

const LineInfo* GetExportPos (const Export* E);
/* Return the basic line info of an export */

Export* CreateConstExport (unsigned Name, long Value);
/* Create an export for a literal date */

Export* CreateExprExport (unsigned Name, ExprNode* Expr, unsigned char AddrSize);
/* Create an export for an expression */

Export* CreateMemoryExport (unsigned Name, MemoryArea* Mem, unsigned long Offs);
/* Create an relative export for a memory area offset */

Export* CreateSegmentExport (unsigned Name, Segment* Seg, unsigned long Offs);
/* Create a relative export to a segment */

Export* CreateSectionExport (unsigned Name, Section* S, unsigned long Offs);
/* Create a relative export to a section */

Export* FindExport (unsigned Name);
/* Check for an identifier in the list. Return 0 if not found, otherwise
 * return a pointer to the export.
 */

int IsUnresolved (unsigned Name);
/* Check if this symbol is an unresolved export */

int IsUnresolvedExport (const Export* E);
/* Return true if the given export is unresolved */

int IsConstExport (const Export* E);
/* Return true if the expression associated with this export is const */

long GetExportVal (const Export* E);
/* Get the value of this export */

void CheckExports (void);
/* Setup the list of all exports and check for export/import symbol type
 * mismatches.
 */

void CheckUnresolvedImports (ExpCheckFunc F, void* Data);
/* Check if there are any unresolved imports. On unresolved imports, F is
 * called (see the comments on ExpCheckFunc in the data section).
 */

void PrintExportMap (FILE* F);
/* Print an export map to the given file */

void PrintImportMap (FILE* F);
/* Print an import map to the given file */

void PrintExportLabels (FILE* F);
/* Print the exports in a VICE label file */

void MarkExport (Export* E);
/* Mark the export */

void UnmarkExport (Export* E);
/* Remove the mark from the export */

int ExportHasMark (Export* E);
/* Return true if the export has a mark */

void CircularRefError (const Export* E);
/* Print an error about a circular reference using to define the given export */



/* End of exports.h */

#endif




