tools/sfdc/sfdc.readme

   1 Short:    Compile SFD files into someting useful (v1.3)
   2 Author:   Martin Blom <martin@blom.org>
   3 Type:     dev/gcc
   4 Requires: perl
   5
   6 sfdc is an open source replacement for Amiga, Inc.'s sfd tool,
   7 distributed with NDK 3.9. It is also an replacement for fd2inline.
   8
   9 The basis for all work performed by sfdc is the SFD file, which contains
  10 all required information about the module and the functions provided.
  11 From this information, sfdc can:
  12
  13 *   Generate an old-style FD file for futher processing with other
  14     tools.
  15
  16 *   Generate a C prototype file, such as those normally found in the
  17     Include/clib/ directory.
  18
  19 *   Generate gcc inlines (actually preprocessor macros) or pragmas for
  20     direct library function calls (without going via library stubs).
  21
  22 *   Generate the Include/proto/ file, which includes the
  23     Include/clib/ file and either the inlines or pragmas.
  24
  25 *   Generate an assembler LVO file, which contains the library offset of
  26     all functions in the library.
  27
  28 *   Generate C stubs, which can be compiled and archived into a stub
  29     library.
  30
  31 *   Generate library gateway stubs, which can be used as part of your
  32     module as glue between the module function table and your C
  33     functions.
  34
  35 Additionally, sfdc does all this for several Amiga-like operating
  36 systems: traditional AmigaOS, AmigaOS 4, native Amithlon, AROS and
  37 MorphOS.