/usr/include/glibmm-2.4/glibmm/optioncontext.h is in libglibmm-2.4-dev 2.42.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GLIBMM_OPTIONCONTEXT_H
#define _GLIBMM_OPTIONCONTEXT_H
/* Copyright (C) 2004 The glibmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/optionentry.h>
#include <glibmm/optiongroup.h>
#include <glibmm/error.h>
#include <sigc++/signal.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C" { typedef struct _GOptionContext GOptionContext; }
#endif
namespace Glib
{
/** Exception class for options.
*/
class OptionError : public Glib::Error
{
public:
enum Code
{
UNKNOWN_OPTION,
BAD_VALUE,
FAILED
};
OptionError(Code error_code, const Glib::ustring& error_message);
explicit OptionError(GError* gobject);
Code code() const;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
static void throw_func(GError* gobject);
friend void wrap_init(); // uses throw_func()
#endif //DOXYGEN_SHOULD_SKIP_THIS
};
/** An OptionContext defines and parses commandline options, using OptionGroup%s and \link OptionEntry option entries \endlink.
*
* It supports short and long commandline options, as shown in the following example:
*
* <tt>testtreemodel -r 1 --max-size 20 --rand --display=:1.0 -vb -- file1 file2</tt>
*
* The example demonstrates a number of features of the GOption
* commandline parser
* - Options can be single letters, prefixed by a single dash.
Multiple short options can be grouped behind a single dash.
* - Long options are prefixed by two consecutive dashes.
* - Options can have an extra argument, which can be a number, a string or
* a filename. For long options, the extra argument can be appended with
* an equals sign after the option name, which is useful if the extra
* argument starts with a dash, which would otherwise cause it to be
* interpreted as another option.
* - Non-option arguments are returned to the application as rest arguments.
* - An argument consisting solely of two dashes turns off further parsing,
* any remaining arguments (even those starting with a dash) are returned
* to the application as rest arguments.
*
* The OptionContext groups options in OptionGroups, which makes it easy to
* incorporate options from multiple sources. The intended use for this is
* to let applications collect option groups from the libraries it uses,
* add them to their OptionContext, and parse all options by a single call
* to parse(). See Gtk::Main::add_gtk_option_group(), for an example.
*
* Add options by creating OptionEntry instances and appropriately-typed variables,
* and adding them to an OptionGroup with OptionGroup::add_entry() or
* OptionGroup::add_entry_filename(). The option group should then be added to
* the OptionContext with set_main_group() or add_group().
*
* You might find it convenient to derive your own class from OptionGroup to
* contain these OptionEntry instances and member variables.
*
* If an option is of type string (see OptionGroup::add_entry()) or filename
* (see OptionGroup::add_entry_filename()), OptionContext takes
* care of converting it to the right encoding. strings are returned in
* UTF-8 encoding and filenames are returned in the GLib filename encoding.
* Note that this only works if setlocale() has been called before
* OptionContext::parse().
*
* OptionContext can automatically generate nicely formatted help output. Unless it is
* explicitly turned off with set_help_enabled(), this will recognize
* the --help, -?, --help-all and --help-groupname options
* (where groupname is the name of an OptionGroup) and write suitable text to
* stdout.
*
*
*/
class OptionContext
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef OptionContext CppObjectType;
typedef GOptionContext BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
private:
public:
/** Creates a new option context.
* @param parameter_string A string which is displayed in the first line of --help output, after programname [OPTION...]
*/
explicit OptionContext(const Glib::ustring& parameter_string = Glib::ustring());
//Note that, unlike Glib::Wrap(), this would create a second C++ instance for the same C instance,u
//so it should be used carefully. For instance you could not access data in a derived class via this second instance.
explicit OptionContext(GOptionContext* castitem, bool take_ownership = false);
virtual ~OptionContext();
/** Enables or disables automatic generation of `--help` output.
* By default, g_option_context_parse() recognizes `--help`, `-h`,
* `-?`, `--help-all` and `--help-groupname` and creates suitable
* output to stdout.
*
* @newin{2,6}
*
* @param help_enabled <tt>true</tt> to enable `--help`, <tt>false</tt> to disable it.
*/
void set_help_enabled(bool help_enabled = true);
/** Returns whether automatic `--help` generation
* is turned on for @a context. See g_option_context_set_help_enabled().
*
* @newin{2,6}
*
* @return <tt>true</tt> if automatic help generation is turned on.
*/
bool get_help_enabled() const;
/** Sets whether to ignore unknown options or not. If an argument is
* ignored, it is left in the @a argv array after parsing. By default,
* g_option_context_parse() treats unknown options as error.
*
* This setting does not affect non-option arguments (i.e. arguments
* which don't start with a dash). But note that GOption cannot reliably
* determine whether a non-option belongs to a preceding unknown option.
*
* @newin{2,6}
*
* @param ignore_unknown <tt>true</tt> to ignore unknown options, <tt>false</tt> to produce
* an error when unknown options are met.
*/
void set_ignore_unknown_options(bool ignore_unknown = true);
/** Returns whether unknown options are ignored or not. See
* g_option_context_set_ignore_unknown_options().
*
* @newin{2,6}
*
* @return <tt>true</tt> if unknown options are ignored.
*/
bool get_ignore_unknown_options() const;
/** Parses the command line arguments, recognizing options
* which have been added to @a context. A side-effect of
* calling this function is that g_set_prgname() will be
* called.
*
* If the parsing is successful, any parsed arguments are
* removed from the array and @a argc and @a argv are updated
* accordingly. A '--' option is stripped from @a argv
* unless there are unparsed options before and after it,
* or some of the options after it start with '-'. In case
* of an error, @a argc and @a argv are left unmodified.
*
* If automatic `--help` support is enabled
* (see g_option_context_set_help_enabled()), and the
* @a argv array contains one of the recognized help options,
* this function will produce help output to stdout and
* call `exit (0)`.
*
* Note that function depends on the [current locale][setlocale] for
* automatic character set conversion of string and filename
* arguments.
*
* @newin{2,6}
*
* @param argc A pointer to the number of command line arguments.
* @param argv A pointer to the array of command line arguments.
* @return <tt>true</tt> if the parsing was successful,
* <tt>false</tt> if an error occurred.
*/
bool parse(int& argc, char**& argv);
//TODO: Document this as useful (only?) with the result from g_win32_get_command_line?
//goption.c has example code that suggests always using this, and ifdefing for G_OS_WIN32, with a g_strdupv for the non-win32 case.
//Presumably we cannot hide that ifdeffing from application code because the argument-removal would be invisible to the caller.
//So can we hide it for people who don't care about arguments being removed from argv?
//TODO? _WRAP_METHOD(bool parse(char**& argv), g_option_context_parse_strv, errthrow)
//g_option_context_add_main_entries(), just creates a group internally, adds them to it, and does a set_main_group()
//- a group without callbacks seems to do some simple default parsing.
/** Adds an OptionGroup to the context, so that parsing with context will recognize the options in the group.
* Note that the group will not be copied, so it should exist for as long as the context exists.
*
* @param group The group to add.
*/
void add_group(OptionGroup& group);
/** Sets an OptionGroup as the main group of the context. This has the same effect as calling add_group(), the only
* difference is that the options in the main group are treated differently when generating --help output.
* Note that the group will not be copied, so it should exist for as long as the context exists.
*
* @param group The group to add.
*/
void set_main_group(OptionGroup& group);
//We don't need this (hopefully), and the memory management would be really awkward.
//OptionGroup& get_main_group();
//const OptionGroup& get_main_group() const;
/** Returns a formatted, translated help text for the given context.
* To obtain the text produced by `--help`, call
* `g_option_context_get_help (context, <tt>true</tt>, <tt>0</tt>)`.
* To obtain the text produced by `--help-all`, call
* `g_option_context_get_help (context, <tt>false</tt>, <tt>0</tt>)`.
* To obtain the help text for an option group, call
* `g_option_context_get_help (context, <tt>false</tt>, group)`.
*
* @newin{2,14}
*
* @param main_help If <tt>true</tt>, only include the main group.
* @param group The OptionGroup to create help for, or <tt>0</tt>.
* @return A newly allocated string containing the help text.
*/
Glib::ustring get_help(bool main_help, const OptionGroup& group) const;
/** Returns a formatted, translated help text for the given context.
* To obtain the text produced by --help, call get_help (true).
* To obtain the text produced by --help-all, call get_help(false).
* To obtain the help text for an option group, call get_help(false, group).
*
* @param main_help If true, only include the main group.
* @result string containing the help text.
*/
Glib::ustring get_help(bool main_help = true) const;
GOptionContext* gobj() { return gobject_; }
const GOptionContext* gobj() const { return gobject_; }
/** Adds a string to be displayed in `--help` output before the list
* of options. This is typically a summary of the program functionality.
*
* Note that the summary is translated (see
* g_option_context_set_translate_func() and
* g_option_context_set_translation_domain()).
*
* @newin{2,12}
*
* @param summary A string to be shown in --help output before the list of
* options.
*/
void set_summary(const Glib::ustring& summary);
/** Returns the summary. See g_option_context_set_summary().
*
* @newin{2,12}
*
* @return The summary.
*/
Glib::ustring get_summary() const;
/** Adds a string to be displayed in `--help` output after the list
* of options. This text often includes a bug reporting address.
*
* Note that the summary is translated (see
* g_option_context_set_translate_func()).
*
* @newin{2,12}
*
* @param description A string to be shown in --help output
* after the list of options.
*/
void set_description(const Glib::ustring& description);
/** Returns the description. See g_option_context_set_description().
*
* @newin{2,12}
*
* @return The description.
*/
Glib::ustring get_description() const;
/** A convenience function to use gettext() for translating
* user-visible strings.
*
* @newin{2,12}
*
* @param domain The domain to use.
*/
void set_translation_domain(const Glib::ustring& domain);
/**
* This function is used to translate user-visible strings, for --help output.
* The function takes an untranslated string and returns a translated string
*/
typedef sigc::slot<Glib::ustring, const Glib::ustring&> SlotTranslate;
/**
* Sets the function which is used to translate user-visible
* strings, for --help output. Different groups can use different functions.
*
* If you are using gettext(), you only need to set the translation domain,
* see set_translation_domain().
*
* @newin{2,14}
*/
void set_translate_func (const SlotTranslate& slot);
protected:
GOptionContext* gobject_;
bool has_ownership_;
};
} // namespace Glib
#endif /* _GLIBMM_OPTIONCONTEXT_H */
|