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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*
* Copyright 2019-2022 the Pacemaker project contributors
*
* The version control history for this file may have further details.
*
* This source code is licensed under the GNU Lesser General Public License
* version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
*/
#ifndef PCMK__CMDLINE_INTERNAL__H
#define PCMK__CMDLINE_INTERNAL__H
#ifdef __cplusplus
extern "C" {
#endif
#include <glib.h>
typedef struct {
char *summary;
char *output_as_descr;
gboolean version;
gboolean quiet;
unsigned int verbosity;
char *output_ty;
char *output_dest;
} pcmk__common_args_t;
/*!
* \internal
* \brief Allocate a new common args object
*
* \param[in] summary Summary description of tool for man page
*
* \return Newly allocated common args object
* \note This function will immediately exit the program if memory allocation
* fails, since the intent is to call it at the very beginning of a
* program, before logging has been set up.
*/
pcmk__common_args_t *
pcmk__new_common_args(const char *summary);
/*!
* \internal
* \brief Create and return a GOptionContext containing the command line options
* supported by all tools.
*
* \note Formatted output options will be added unless fmts is NULL. This allows
* for using this function in tools that have not yet been converted to
* formatted output. It should not be NULL in any tool that calls
* pcmk__register_formats() as that function adds its own command line
* options.
*
* \param[in,out] common_args A ::pcmk__common_args_t structure where the
* results of handling command options will be written.
* \param[in] fmts The help string for which formats are supported.
* \param[in,out] output_group A ::GOptionGroup that formatted output related
* command line arguments should be added to.
* \param[in] param_string A string describing any remaining command line
* arguments.
*/
GOptionContext *
pcmk__build_arg_context(pcmk__common_args_t *common_args, const char *fmts,
GOptionGroup **output_group, const char *param_string);
/*!
* \internal
* \brief Clean up after pcmk__build_arg_context(). This should be called
* instead of ::g_option_context_free at program termination.
*
* \param[in,out] context Argument context to free
*/
void
pcmk__free_arg_context(GOptionContext *context);
/*!
* \internal
* \brief Add options to the main application options
*
* \param[in,out] context Argument context to add options to
* \param[in] entries Option entries to add
*
* \note This is simply a convenience wrapper to reduce duplication
*/
void pcmk__add_main_args(GOptionContext *context, const GOptionEntry entries[]);
/*!
* \internal
* \brief Add an option group to an argument context
*
* \param[in,out] context Argument context to add group to
* \param[in] name Option group name (to be used in --help-NAME)
* \param[in] header Header for --help-NAME output
* \param[in] desc Short description for --help-NAME option
* \param[in] entries Array of options in group
*
* \note This is simply a convenience wrapper to reduce duplication
*/
void pcmk__add_arg_group(GOptionContext *context, const char *name,
const char *header, const char *desc,
const GOptionEntry entries[]);
/*!
* \internal
* \brief Prepare the command line for being added to a pcmk__output_t as the
* request
*
* This performs various transformations on the command line arguments, such
* as surrounding arguments containing spaces with quotes and escaping any
* single quotes in the string.
*
* \param[in,out] argv Command line (typically from pcmk__cmdline_preproc())
*/
gchar *pcmk__quote_cmdline(gchar **argv);
/*!
* \internal
* \brief Pre-process command line arguments to preserve compatibility with
* getopt behavior.
*
* getopt and glib have slightly different behavior when it comes to processing
* single command line arguments. getopt allows this: -x<val>, while glib will
* try to handle <val> like it is additional single letter arguments. glib
* prefers -x <val> instead.
*
* This function scans argv, looking for any single letter command line options
* (indicated by the 'special' parameter). When one is found, everything after
* that argument to the next whitespace is converted into its own value. Single
* letter command line options can come in a group after a single dash, but
* this function will expand each group into many arguments.
*
* Long options and anything after "--" is preserved. The result of this function
* can then be passed to ::g_option_context_parse_strv for actual processing.
*
* In pseudocode, this:
*
* pcmk__cmdline_preproc(4, ["-XbA", "--blah=foo", "-aF", "-Fval", "--", "--extra", "-args"], "aF")
*
* Would be turned into this:
*
* ["-X", "-b", "-A", "--blah=foo", "-a", "F", "-F", "val", "--", "--extra", "-args"]
*
* This function does not modify argv, and the return value is built of copies
* of all the command line arguments. It is up to the caller to free this memory
* after use.
*
* \note This function calls g_set_prgname assuming it wasn't previously set and
* assuming argv is not NULL. It is not safe to call g_set_prgname more
* than once so clients should not do so after calling this function.
*
* \param[in] argv The command line arguments.
* \param[in] special Single-letter command line arguments that take a value.
* These letters will all have pre-processing applied.
*/
gchar **
pcmk__cmdline_preproc(char *const *argv, const char *special);
/*!
* \internal
* \brief Process extra arguments as if they were provided by the user on the
* command line.
*
* \param[in,out] context The command line option processing context.
* \param[out] error A place for errors to be collected.
* \param[in] format The command line to be processed, potentially with
* format specifiers.
* \param[in] ... Arguments to be formatted.
*
* \note The first item in the list of arguments must be the name of the
* program, exactly as if the format string were coming from the
* command line. Otherwise, the first argument will be ignored.
*
* \return TRUE if processing succeeded, or FALSE otherwise. If FALSE, error
* should be checked and displayed to the user.
*/
G_GNUC_PRINTF(3, 4)
gboolean
pcmk__force_args(GOptionContext *context, GError **error, const char *format, ...);
#ifdef __cplusplus
}
#endif
#endif
|
