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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 library.h                                 */
   4 /*                                                                           */
   5 /*          Library data structures and helpers for the ld65 linker          */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2011, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 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 LIBRARY_H
  37 #define LIBRARY_H
  38
  39
  40
  41 /*****************************************************************************/
  42 /*                                   Data                                    */
  43 /*****************************************************************************/
  44
  45
  46
  47 /* Opaque structure */
  48 struct Library;
  49
  50
  51
  52 /*****************************************************************************/
  53 /*                                   Code                                    */
  54 /*****************************************************************************/
  55
  56
  57
  58 void LibAdd (FILE* F, const char* Name);
  59 /* Add files from the library to the list if there are references that could
  60  * be satisfied.
  61  */
  62
  63 void LibStartGroup (void);
  64 /* Start a library group. Objects within a library group may reference each
  65  * other, and libraries are searched repeatedly until all references are
  66  * satisfied.
  67  */
  68
  69 void LibEndGroup (void);
  70 /* End a library group and resolve all open references. Objects within a
  71  * library group may reference each other, and libraries are searched
  72  * repeatedly until all references are satisfied.
  73  */
  74
  75 void LibCheckGroup (void);
  76 /* Check if there are open library groups */
  77
  78 const char* GetLibFileName (const struct Library* L);
  79 /* Get the name of a library */
  80
  81 unsigned GetLibId (const struct Library* L);
  82 /* Get the id of a library file. */
  83
  84 unsigned LibraryCount (void);
  85 /* Return the total number of libraries */
  86
  87 void PrintDbgLibraries (FILE* F);
  88 /* Output the libraries to a debug info file */
  89
  90
  91
  92 /* End of library.h */
  93
  94 #endif
  95
  96
  97