chiark - git - mdw - ssr/blob - StraySrc/Libraries/Sapphire/csapph/h/libOpts

   1 /*
   2  * libOpts.h
   3  *
   4  * [Generated from libOpts, 25 September 1996]
   5  */
   6
   7 #if !defined(__CC_NORCROFT) || !defined(__arm)
   8   #error You must use the Norcroft ARM Compiler for Sapphire programs
   9 #endif
  10
  11 #pragma include_only_once
  12 #pragma force_top_level
  13
  14 #ifndef __libOpts_h
  15 #define __libOpts_h
  16
  17 #ifndef __sapphire_h
  18   #include "sapphire.h"
  19 #endif
  20
  21 /*----- Overview ----------------------------------------------------------*
  22  *
  23  * Functions provided:
  24  *
  25  *  libOpts_register
  26  *  libOpts_find
  27  *
  28  * Macros provided:
  29  *
  30  *  LIBOPT
  31  *  LOEND
  32  */
  33
  34 /* --- libOpts_register --- *
  35  *
  36  * On entry:    R0 == address of an options block
  37  *
  38  * On exit:     --
  39  *
  40  * Use:         Adds the block given to the library options.
  41  */
  42
  43 extern routine libOpts_register;
  44
  45 /* --- libOpts_find --- *
  46  *
  47  * On entry:    R0 == magic marker word
  48  *
  49  * On exit:     CS if found, and
  50  *                R0 == address of options block
  51  *              else CC, and
  52  *                R0 corrupted
  53  *
  54  * Use:         Tries to find an option with the given marker, which will
  55  *              normally be a four-character text string.  The first match
  56  *              found will be returned.  The options blocks are searched in
  57  *              reverse order of registration (i.e. blocks registered later
  58  *              will override blocks registered reviously).
  59  */
  60
  61 extern routine libOpts_find;
  62
  63 /*----- Macros ------------------------------------------------------------*/
  64
  65 /* --- Macro: LIBOPT --- *
  66  *
  67  * Arguments:   name == name of this options subblock (4 characters)
  68  *
  69  * Use:         Sets up an options subblock with the given name.
  70  */
  71
  72 /* --- Macro: LOEND --- *
  73  *
  74  * Arguments:   --
  75  *
  76  * Use:         Terminates a library options block.
  77  */
  78
  79 /*----- That's all, folks -------------------------------------------------*/
  80
  81 #endif