OptionsIO Class Reference

#include <OptionsIO.h>

---

Detailed Description

Helping methods for parsing of command line arguments and reading a configuration file. Any errors are reported by throwing a ProcessError exception which contains a description about the failure.

Definition at line 52 of file OptionsIO.h.

Static Public Member Functions
static void	getOptions (bool loadConfig, int argv, char **argc) throw (ProcessError)
	Parses the command line arguments and loads the configuration optionally.
static void	loadConfiguration () throw (ProcessError)
	Loads and parses the configuration.

---

Member Function Documentation

void OptionsIO::getOptions	(	bool	loadConfig,
		int	argv,
		char **	argc
	)			throw (ProcessError) [static]

Parses the command line arguments and loads the configuration optionally.

Command line arguments are parsed, first, throwing a ProcessError if something fails. If loadConfig is false, the method returns after this. Otherwise, options are reset to being writeable and the configuration is loaded using "loadConfiguration". After this, the options are reset again and the command line arguments are reparsed.

This workflow allows to read the name of a configuration file from command line arguments, first, then to load values from this configuration file and reset them by other values from the command line.

Parameters:

[in]	loadConfig	Whether the configuration shall be loaded
[in]	argv	number of arguments given at the command line
[in]	argc	arguments given at the command line

Definition at line 56 of file OptionsIO.cpp.

References OptionsCont::getOptions(), OptionsParser::parse(), and OptionsCont::resetWritable().

Referenced by GUILoadThread::initOptions(), and main().

                                                                                {
    // preparse the options
    //  (maybe another configuration file was chosen)
    if (!OptionsParser::parse(argc, argv)) {
        throw ProcessError("Could not parse commandline options.");
    }
    // check whether to use the command line parameters only
    if (!loadConfig) {
        return;
    }
    // read the configuration when everything's ok
    OptionsCont::getOptions().resetWritable();
    loadConfiguration();
    // reparse the options
    //  (overwrite the settings from the configuration file)
    OptionsCont::getOptions().resetWritable();
    OptionsParser::parse(argc, argv);
}

void OptionsIO::loadConfiguration

(

)

throw (ProcessError) [static]

Loads and parses the configuration.

The name of the configuration file is extracted from the global OptionsCont ("configuration-file" is used as the name of the option to get the name of the configuration).

Definition at line 77 of file OptionsIO.cpp.

References MsgHandler::beginProcessMsg(), MsgHandler::endProcessMsg(), OptionsLoader::errorOccured(), FileHelpers::exists(), OptionsCont::exists(), MsgHandler::getMessageInstance(), OptionsCont::getOptions(), OptionsCont::getString(), OptionsCont::isSet(), and OptionsCont::relocateFiles().

                                                 {
    OptionsCont &oc = OptionsCont::getOptions();
    if (!oc.exists("configuration-file") || !oc.isSet("configuration-file")) {
        return;
    }
    std::string path = oc.getString("configuration-file");
    if (!FileHelpers::exists(path)) {
        throw ProcessError("Could not find configuration '" + oc.getString("configuration-file") + "'.");
    }
    MsgHandler::getMessageInstance()->beginProcessMsg("Loading configuration...");
    // build parser
    SAXParser parser;
    parser.setValidationScheme(SAXParser::Val_Auto);
    parser.setDoNamespaces(false);
    parser.setDoSchema(false);
    // start the parsing
    OptionsLoader handler;
    try {
        parser.setDocumentHandler(&handler);
        parser.setErrorHandler(&handler);
        parser.parse(path.c_str());
        if (handler.errorOccured()) {
            throw ProcessError("Could not load configuration '" + path + "'.");
        }
    } catch (const XMLException &e) {
        throw ProcessError("Could not load configuration '" + path + "':\n " + TplConvert<XMLCh>::_2str(e.getMessage()));
    }
    oc.relocateFiles(path);
    MsgHandler::getMessageInstance()->endProcessMsg("done.");
}

---

The documentation for this class was generated from the following files:

• OptionsIO.h
• OptionsIO.cpp