chiark - git - mdw - sw-tools/blob - src/sw.h

   1 /* -*-c-*-
   2  *
   3  * $Id: sw.h,v 1.2 1999/09/10 15:27:33 mdw Exp $
   4  *
   5  * Interface to main options parser
   6  *
   7  * (c) 1999 EBI
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of sw-tools.
  13  *
  14  * sw-tools is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * sw-tools is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with sw-tools; if not, write to the Free Software Foundation,
  26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 /*----- Revision history --------------------------------------------------*
  30  *
  31  * $Log: sw.h,v $
  32  * Revision 1.2  1999/09/10 15:27:33  mdw
  33  * Include `%'-escape substitution.
  34  *
  35  * Revision 1.1.1.1  1999/06/02 16:53:35  mdw
  36  * Initial import.
  37  *
  38  */
  39
  40 #ifndef SW_H
  41 #define SW_H
  42
  43 #ifdef __cplusplus
  44   extern "C" {
  45 #endif
  46
  47 /*----- Data structures ---------------------------------------------------*/
  48
  49 /* --- About the commands list --- *
  50  *
  51  * Declare commands in the header file, like this:
  52  *@
  53  *   #ifdef CMD_LINK
  54  *      static cmd cmd_foo = { CMD_LINK, sw_foo, "foo\t\tDoes something." };
  55  *   #  undef CMD_LINK
  56  *   #  define CMD_LINK &cmd_foo
  57  *   #endif
  58  *@
  59  * This causes all the commands to be linked together at compile time, and is
  60  * therefore a cool thing to do.
  61  */
  62
  63 typedef struct cmd {
  64   struct cmd *next;
  65   const char *name;
  66   int (*cmd)(int /*argc*/, char */*argv*/[]);
  67   const char *help;
  68 } cmd;
  69
  70 /*----- Global variables --------------------------------------------------*/
  71
  72 extern const char *opt_arch;            /* Value of `--arch' option */
  73 extern const char *opt_output;          /* Value of `--output' option */
  74 extern unsigned int opt_flags;          /* Various bitflag options */
  75
  76 enum {
  77   optFlag_install = 1,
  78   optFlag_force = 2,
  79   optFlag_beep = 4,
  80   optFlag_percent = 8
  81 };
  82
  83 /*----- That's all, folks -------------------------------------------------*/
  84
  85 #ifdef __cplusplus
  86   }
  87 #endif
  88
  89 #endif