sdcc/src/SDCCargs.h

   1 /*-------------------------------------------------------------------------
   2   SDCCargs.c - command line arguments handling
   3
   4              Written By -  Sandeep Dutta . sandeep.dutta@usa.net (1999)
   5
   6    This program is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by the
   8    Free Software Foundation; either version 2, or (at your option) any
   9    later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20    In other words, you are welcome to use, share and improve this program.
  21    You are forbidden to forbid anyone else to use, share and improve
  22    what you give them.   Help stamp out software-hoarding!
  23 -------------------------------------------------------------------------*/
  24
  25 /** Definition of the structures used by the options parser.  The port
  26     may implement one of these for any options it wants parsed
  27     automatically.
  28 */
  29 #ifndef SDCCARGS_H
  30 #define SDCCARGS_H
  31
  32 /** Specifies option argument types.  */
  33 enum cl_opt_arg_type {
  34   CLAT_BOOLEAN = 0, /* has to be zero! */
  35   CLAT_INTEGER,
  36   CLAT_STRING,
  37   CLAT_SET,
  38   CLAT_ADD_SET
  39 };
  40
  41 /** Table of all options supported by all ports.
  42     This table provides:
  43       * A reference for all options.
  44       * An easy way to maintain help for the options.
  45       * Automatic support for setting flags on simple options.
  46 */
  47 typedef struct
  48   {
  49     /** The short option character e.g. 'h' for -h.  0 for none. */
  50     char shortOpt;
  51     /** Long option e.g. "--help".  Includes the -- prefix.  NULL for
  52         none. */
  53     const char *longOpt;
  54     /** Pointer to an int that will be incremented every time the
  55         option is encountered.  May be NULL.
  56     */
  57     void *pparameter;
  58     /** Help text to go with this option.  May be NULL. */
  59     const char *help;
  60     /** Option argument type */
  61     enum cl_opt_arg_type arg_type;
  62   } OPTION;
  63
  64 char *getStringArgEx(const char *szStart, size_t skipChars, char **argv, int *pi, int argc);
  65 char *getStringArg(const char *szStart, char **argv, int *pi, int argc);
  66 long getIntArgEx(const char *szStart, size_t skipChars, char **argv, int *pi, int argc);
  67 long getIntArg(const char *szStart, char **argv, int *pi, int argc);
  68
  69 #endif