topical media & game development
lib-of-vs-libs-Poco-include-Poco-Util-OptionProcessor.h / h
//
// OptionProcessor.h
//
//
//
// Library: Util
// Package: Options
// Module: OptionProcessor
//
// Definition of the OptionProcessor class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
ifndef Util_OptionProcessor_INCLUDED
define Util_OptionProcessor_INCLUDED
include "Poco/Util/Util.h"
include <set>
namespace Poco {
namespace Util {
class OptionSet;
class Util_API OptionProcessor
An OptionProcessor is used to process the command line
arguments of an application.
The process() method takes an argument from the command line.
If that argument starts with an option prefix, the argument
is further processed. Otherwise, the argument is ignored and
false is ignored. The argument must match one of the options
given in the OptionSet that is passed to the OptionProcessor
with the constructor. If an option is part of a group, at most
one option of the group can be passed to the OptionProcessor.
Otherwise an IncompatibleOptionsException is thrown.
If the same option is given multiple times, but the option
is not repeatable, a DuplicateOptionException is thrown.
If the option is not recognized, a UnexpectedArgumentException
is thrown.
If the option requires an argument, but none is given, an
MissingArgumentException is thrown.
If no argument is expected, but one is present, a
UnexpectedArgumentException is thrown.
If a partial option name is ambiguous, an AmbiguousOptionException
is thrown.
The OptionProcessor supports two modes: Unix mode and default mode.
In Unix mode, the option prefix is a dash '-'. A dash must be followed
by a short option name, or another dash, followed by a (partial)
long option name.
In default mode, the option prefix is a slash '/', followed by
a (partial) long option name.
If the special option '--' is encountered in Unix mode, all following
options are ignored.
{
public:
OptionProcessor(const OptionSet& options);
Creates the OptionProcessor, using the given OptionSet.
~OptionProcessor();
Destroys the OptionProcessor.
void setUnixStyle(bool flag);
Enables (flag == true) or disables (flag == false) Unix-style
option processing.
If Unix-style processing is enabled, options are expected to
begin with a single or a double dash ('-' or '--', respectively).
A single dash must be followed by a short option name. A double
dash must be followed by a (partial) full option name.
If Unix-style processing is disabled, options are expected to
begin with a slash ('/'), followed by a (partial) full option name.
bool isUnixStyle() const;
Returns true iff Unix-style option processing is enabled.
bool process(const std::string& argument, std::string& optionName, std::string& optionArg);
Examines and processes the given command line argument.
If the argument begins with an option prefix, the option is processed
and true is returned. The full option name is stored in optionName and the
option argument, if present, is stored in optionArg.
If the option does not begin with an option prefix, false is returned.
void checkRequired() const;
Checks if all required options have been processed.
Does nothing if all required options have been processed.
Throws a MissingOptionException otherwise.
private:
bool processUnix(const std::string& argument, std::string& optionName, std::string& optionArg);
bool processDefault(const std::string& argument, std::string& optionName, std::string& optionArg);
bool processCommon(const std::string& option, bool isShort, std::string& optionName, std::string& optionArg);
const OptionSet& _options;
bool _unixStyle;
bool _ignore;
std::set<std::string> _groups;
std::set<std::string> _specifiedOptions;
};
//
// inlines
//
inline bool OptionProcessor::isUnixStyle() const
{
return _unixStyle;
}
} } // namespace Poco::Util
endif // Util_OptionProcessor_INCLUDED
(C) Æliens
04/09/2009
You may not copy or print any of this material without explicit permission of the author or the publisher.
In case of other copyright issues, contact the author.
