git.sur5r.net Git - cc65/blob - src/common/cmdline.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 cmdline.h                                 */
   4 /*                                                                           */
   5 /*                 Helper functions for command line parsing                 */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-2009, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 52                                           */
  11 /*                D-70794 Filderstadt                                        */
  12 /* EMail:         uz@cc65.org                                                */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef CMDLINE_H
  37 #define CMDLINE_H
  38
  39
  40
  41 #include "attrib.h"
  42
  43
  44
  45 /*****************************************************************************/
  46 /*                                   Data                                    */
  47 /*****************************************************************************/
  48
  49
  50
  51 /* Program name - is set after call to InitCmdLine */
  52 extern const char* ProgName;
  53
  54 /* The program argument vector */
  55 extern char** ArgVec;
  56 extern unsigned ArgCount;
  57
  58 /* Structure defining a long option */
  59 typedef struct LongOpt  LongOpt;
  60 struct LongOpt {
  61     const char* Option;
  62     unsigned    ArgCount;
  63     void        (*Func) (const char* Opt, const char* Arg);
  64 };
  65
  66
  67
  68 /*****************************************************************************/
  69 /*                                   Code                                    */
  70 /*****************************************************************************/
  71
  72
  73
  74 void InitCmdLine (int* aArgCount, char** aArgVec[], const char* aProgName);
  75 /* Initialize command line parsing. aArgVec is the argument array terminated by
  76  * a NULL pointer (as usual), ArgCount is the number of valid arguments in the
  77  * array. Both arguments are remembered in static storage.
  78  */
  79
  80 void UnknownOption (const char* Opt) attribute ((noreturn));
  81 /* Print an error about an unknown option and die. */
  82
  83 void NeedArg (const char* Opt) attribute ((noreturn));
  84 /* Print an error about a missing option argument and exit. */
  85
  86 void InvArg (const char* Opt, const char* Arg) attribute ((noreturn));
  87 /* Print an error about an invalid option argument and exit. */
  88
  89 void InvDef (const char* Def) attribute ((noreturn));
  90 /* Print an error about an invalid definition and die */
  91
  92 const char* GetArg (unsigned* ArgNum, unsigned Len);
  93 /* Get an argument for a short option. The argument may be appended to the
  94  * option itself or may be separate. Len is the length of the option string.
  95  */
  96
  97 void LongOption (unsigned* ArgNum, const LongOpt* OptTab, unsigned OptCount);
  98 /* Handle a long command line option */
  99
 100
 101
 102 /* End of cmdline.h */
 103
 104 #endif
 105
 106
 107