usage: Print metavariables in SHOUTY letters.

[sw-tools] / src / sw.h

/* -*-c-*-
 *
 * $Id: sw.h,v 1.3 2004/04/08 01:52:19 mdw Exp $
 *
 * Interface to main options parser
 *
 * (c) 1999 EBI
 */

/*----- Licensing notice --------------------------------------------------* 
 *
 * This file is part of sw-tools.
 *
 * sw-tools is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * sw-tools is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with sw-tools; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef SW_H
#define SW_H

#ifdef __cplusplus
  extern "C" {
#endif

/*----- Data structures ---------------------------------------------------*/

/* --- About the commands list --- *
 *
 * Declare commands in the header file, like this:
 *@
 *   #ifdef CMD_LINK
 *      static cmd cmd_foo = { CMD_LINK, sw_foo, "foo\t\tDoes something." };
 *   #  undef CMD_LINK
 *   #  define CMD_LINK &cmd_foo
 *   #endif
 *@
 * This causes all the commands to be linked together at compile time, and is
 * therefore a cool thing to do.
 */

typedef struct cmd {
  struct cmd *next;
  const char *name;
  int (*cmd)(int /*argc*/, char */*argv*/[]);
  const char *help;
} cmd;

/*----- Global variables --------------------------------------------------*/

extern const char *opt_arch;		/* Value of `--arch' option */
extern const char *opt_output;		/* Value of `--output' option */
extern unsigned int opt_flags;		/* Various bitflag options */

enum {
  optFlag_install = 1,
  optFlag_force = 2,
  optFlag_beep = 4,
  optFlag_percent = 8
};

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif