cc65/src/common/cmdline.h

105 lines
4.5 KiB
C

/*****************************************************************************/
/* */
/* cmdline.h */
/* */
/* Helper functions for command line parsing */
/* */
/* */
/* */
/* (C) 2000-2009, Ullrich von Bassewitz */
/* Roemerstrasse 52 */
/* D-70794 Filderstadt */
/* EMail: uz@cc65.org */
/* */
/* */
/* This software is provided 'as-is', without any expressed or implied */
/* warranty. In no event will the authors be held liable for any damages */
/* arising from the use of this software. */
/* */
/* Permission is granted to anyone to use this software for any purpose, */
/* including commercial applications, and to alter it and redistribute it */
/* freely, subject to the following restrictions: */
/* */
/* 1. The origin of this software must not be misrepresented; you must not */
/* claim that you wrote the original software. If you use this software */
/* in a product, an acknowledgment in the product documentation would be */
/* appreciated but is not required. */
/* 2. Altered source versions must be plainly marked as such, and must not */
/* be misrepresented as being the original software. */
/* 3. This notice may not be removed or altered from any source */
/* distribution. */
/* */
/*****************************************************************************/
#ifndef CMDLINE_H
#define CMDLINE_H
#include "attrib.h"
/*****************************************************************************/
/* Data */
/*****************************************************************************/
/* Program name - is set after call to InitCmdLine */
extern const char* ProgName;
/* The program argument vector */
extern char** ArgVec;
extern unsigned ArgCount;
/* Structure defining a long option */
typedef struct LongOpt LongOpt;
struct LongOpt {
const char* Option;
unsigned ArgCount;
void (*Func) (const char* Opt, const char* Arg);
};
/*****************************************************************************/
/* Code */
/*****************************************************************************/
void InitCmdLine (int* aArgCount, char*** aArgVec, const char* aProgName);
/* Initialize command line parsing. aArgVec is the argument array terminated by
** a NULL pointer (as usual), ArgCount is the number of valid arguments in the
** array. Both arguments are remembered in static storage.
*/
void UnknownOption (const char* Opt) attribute ((noreturn));
/* Print an error about an unknown option and die. */
void NeedArg (const char* Opt) attribute ((noreturn));
/* Print an error about a missing option argument and exit. */
void InvArg (const char* Opt, const char* Arg) attribute ((noreturn));
/* Print an error about an invalid option argument and exit. */
void InvDef (const char* Def) attribute ((noreturn));
/* Print an error about an invalid definition and die */
const char* GetArg (unsigned* ArgNum, unsigned Len);
/* Get an argument for a short option. The argument may be appended to the
** option itself or may be separate. Len is the length of the option string.
*/
void LongOption (unsigned* ArgNum, const LongOpt* OptTab, unsigned OptCount);
/* Handle a long command line option */
/* End of cmdline.h */
#endif