1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
/*
* BRLTTY - A background process providing access to the console screen (when in
* text mode) for a blind person using a refreshable braille display.
*
* Copyright (C) 1995-2014 by The BRLTTY Developers.
*
* BRLTTY comes with ABSOLUTELY NO WARRANTY.
*
* This is free software, placed 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. Please see the file LICENSE-GPL for details.
*
* Web Page: http://mielke.cc/brltty/
*
* This software is maintained by Dave Mielke <dave@mielke.cc>.
*/
#ifndef BRLTTY_INCLUDED_OPTIONS
#define BRLTTY_INCLUDED_OPTIONS
#include "program.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
typedef enum {
OPT_Hidden = 0X01,
OPT_Extend = 0X02,
OPT_Config = 0X04,
OPT_Environ = 0X08,
OPT_Format = 0X10
} OptionFlag;
#define FLAG_TRUE_WORD "on"
#define FLAG_FALSE_WORD "off"
typedef struct {
const char *word;
const char *argument;
unsigned char letter;
unsigned char bootParameter;
unsigned char flags;
const char *defaultSetting;
const char *description;
union {
int *flag;
char **string;
} setting;
union {
const char *const *array;
size_t (*format) (unsigned int index, char *buffer, size_t size);
} strings;
} OptionEntry;
#define BEGIN_OPTION_TABLE(name) static const OptionEntry name[] = {
#define END_OPTION_TABLE \
{ .letter = 'h', \
.word = "help", \
.description = strtext("Print a usage summary (commonly used options only), and then exit.") \
} \
, \
{ .letter = 'H', \
.word = "full-help", \
.description = strtext("Print a usage summary (all options), and then exit.") \
} \
};
typedef struct {
const OptionEntry *optionTable;
unsigned int optionCount;
int *doBootParameters;
int *doEnvironmentVariables;
char **configurationFile;
const char *applicationName;
const char *argumentsSummary;
} OptionsDescriptor;
#define OPTION_TABLE(name) .optionTable = name, .optionCount = ARRAY_COUNT(name)
extern ProgramExitStatus processOptions (
const OptionsDescriptor *descriptor,
int *argumentCount, char ***argumentVector
);
#define PROCESS_OPTIONS(descriptorVariable, argcVariable, argvVariable) { \
ProgramExitStatus exitStatus = processOptions(&descriptorVariable, &argcVariable, &argvVariable); \
if (exitStatus == PROG_EXIT_FORCE) return PROG_EXIT_SUCCESS; \
if (exitStatus != PROG_EXIT_SUCCESS) return exitStatus; \
}
extern void resetOptions (const OptionsDescriptor *descriptor);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* BRLTTY_INCLUDED_OPTIONS */
|
