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     Ullrich von Bassewitz                                        */
  10 /*              Wacholderweg 14                                              */
  11 /*              D-70597 Stuttgart                                            */
  12 /* EMail:       uz@musoftware.de                                             */
  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 /* Structure defining a long option */
  55 typedef struct LongOpt  LongOpt;
  56 struct LongOpt {
  57     const char* Option;
  58     unsigned    ArgCount;
  59     void        (*Func) (const char* Opt, const char* Arg);
  60 };
  61
  62
  63
  64 /*****************************************************************************/
  65 /*                                   Code                                    */
  66 /*****************************************************************************/
  67
  68
  69
  70 void InitCmdLine (unsigned aArgCount, char* aArgVec[], const char* aProgName);
  71 /* Initialize command line parsing. aArgVec is the argument array terminated by
  72  * a NULL pointer (as usual), ArgCount is the number of valid arguments in the
  73  * array. Both arguments are remembered in static storage.
  74  */
  75
  76 void UnknownOption (const char* Opt) attribute ((noreturn));
  77 /* Print an error about an unknown option and die. */
  78
  79 void NeedArg (const char* Opt) attribute ((noreturn));
  80 /* Print an error about a missing option argument and exit. */
  81
  82 void InvDef (const char* Def) attribute ((noreturn));
  83 /* Print an error about an invalid definition and die */
  84
  85 const char* GetArg (int* ArgNum, unsigned Len);
  86 /* Get an argument for a short option. The argument may be appended to the
  87  * option itself or may be separate. Len is the length of the option string.
  88  */
  89
  90 void LongOption (int* ArgNum, const LongOpt* OptTab, unsigned OptCount);
  91 /* Handle a long command line option */
  92
  93
  94
  95 /* End of cmdline.h */
  96
  97 #endif
  98
  99
 100