ApplicationOptions Class Reference

Description

Handles command line and config file program options.

Definition at line 31 of file AppOptions.h.

Public Member Functions
	ApplicationOptions (int argc=0, char **argv=0)
bool	disableHighDPISupport () const
bool	find (std::string name) const
	Returns true if option with given name has been set. More...
QSize	mainWindowSize () const
const bpo::variable_value &	operator[] (const std::string &s) const
	access to variable with given name defined in variables container More...

Private Member Functions
bpo::options_description &	getOptions ()
	Returns reference to the options description. More...
bpo::variables_map &	getVariables ()
	Returns reference to the variables container. More...
void	parseCommandLine (int argc, char **argv)
	Parses command line arguments. More...
void	processOptions ()

Private Attributes
bpo::options_description	m_options
	options description, to be filled with add() from different program modules More...
bool	m_options_is_consistent
	true if options are consistent (no conflicts, no –help request) More...
bpo::positional_options_description	m_positional_options
	positional options description, to be filled with addPositional() from main module More...
bpo::variables_map	m_variables_map

Constructor & Destructor Documentation

ApplicationOptions()

ApplicationOptions::ApplicationOptions	(	int	argc = 0,
		char **	argv = 0
	)

Definition at line 60 of file AppOptions.cpp.

{
    m_options.add_options()("help,h", "print help message and exit");
    m_options.add_options()("version,v", "print version and exit");
    m_options.add_options()("with-debug", "run application with debug printout");
    m_options.add_options()(geometry, bpo::value<std::string>(),
                            "Main window geometry, e.g. 1600x1000");
    m_options.add_options()(nohighdpi, "Run without high-dpi support");
 
    parseCommandLine(argc, argv);
 
    processOptions();
}

References m_options, parseCommandLine(), and processOptions().

Here is the call graph for this function:

Member Function Documentation

disableHighDPISupport()

bool ApplicationOptions::disableHighDPISupport

(

)

const

Definition at line 151 of file AppOptions.cpp.

{
    return find(nohighdpi);
}

References find().

Referenced by main().

Here is the call graph for this function:

find()

bool ApplicationOptions::find

(

std::string

name

)

const

Returns true if option with given name has been set.

Definition at line 81 of file AppOptions.cpp.

{
    return m_variables_map.count(name);
}

References m_variables_map, and GUI::RealSpace::Particles::name().

Referenced by disableHighDPISupport(), and main().

Here is the call graph for this function:

getOptions()

boost::program_options::options_description & ApplicationOptions::getOptions ( )

private

Returns reference to the options description.

Definition at line 120 of file AppOptions.cpp.

{
    return m_options;
}

References m_options.

getVariables()

boost::program_options::variables_map & ApplicationOptions::getVariables ( )

private

Returns reference to the variables container.

Definition at line 115 of file AppOptions.cpp.

{
    return m_variables_map;
}

References m_variables_map.

mainWindowSize()

QSize ApplicationOptions::mainWindowSize

(

)

const

Definition at line 145 of file AppOptions.cpp.

{
    QString size_str = QString::fromStdString(m_variables_map[geometry].as<std::string>());
    return windowSize(size_str);
}

References m_variables_map.

Referenced by main(), and processOptions().

operator[]()

const bpo::variable_value & ApplicationOptions::operator[]

(

const std::string &

s

)

const

access to variable with given name defined in variables container

access variables

Definition at line 76 of file AppOptions.cpp.

{
    return m_variables_map[s];
}

References m_variables_map.

parseCommandLine()

void ApplicationOptions::parseCommandLine ( int  argc, char **  argv  )

private

Parses command line arguments.

parse command line arguments

Definition at line 88 of file AppOptions.cpp.

{
    // parsing command line arguments
    try {
        // if positional option description is empty, no command line arguments
        // without '--' or '-' will be accepted
        // 'store' populates the variable map
        bpo::store(bpo::command_line_parser(argc, argv)
                       .options(m_options)
                       .positional(m_positional_options)
                       .run(),
                   m_variables_map);
        // bpo::store(bpo::parse_command_line(argc, argv, m_options), m_variables_map);
 
        // 'notify' raises any errors encountered
        bpo::notify(m_variables_map);
 
    } catch (std::exception& e) {
        std::stringstream s;
        s << "BornAgain was launched with invalid command line option.\n"
          << "Parser error message: " << e.what() << ".\n"
          << "Available options:\n"
          << m_options << "\n";
        exitWithGuiMessage(QString::fromStdString(s.str()));
    }
}

References m_options, m_positional_options, and m_variables_map.

Referenced by ApplicationOptions().

processOptions()

void ApplicationOptions::processOptions ( )

private

Definition at line 125 of file AppOptions.cpp.

{
    if (m_variables_map.count("help")) {
        std::cout << "BornAgain Graphical User Interface" << std::endl;
        std::cout << m_options << std::endl;
        exit(0);
    }
 
    else if (m_variables_map.count("version")) {
        std::cout << "BornAgain-" << GUI::Util::Path::getBornAgainVersionString().toStdString()
                  << std::endl;
        exit(0);
    }
 
    else if (m_variables_map.count(geometry)) {
        if (!isValid(mainWindowSize()))
            exitWithGuiMessage("Wrong window size, try --geometry=1600x900\n");
    }
}

References GUI::Util::Path::getBornAgainVersionString(), m_options, m_variables_map, and mainWindowSize().

Referenced by ApplicationOptions().

Here is the call graph for this function:

Member Data Documentation

m_options

bpo::options_description ApplicationOptions::m_options

private

options description, to be filled with add() from different program modules

Definition at line 60 of file AppOptions.h.

Referenced by ApplicationOptions(), getOptions(), parseCommandLine(), and processOptions().

m_options_is_consistent

bool ApplicationOptions::m_options_is_consistent

private

true if options are consistent (no conflicts, no –help request)

Definition at line 58 of file AppOptions.h.

m_positional_options

bpo::positional_options_description ApplicationOptions::m_positional_options

private

positional options description, to be filled with addPositional() from main module

Definition at line 62 of file AppOptions.h.

Referenced by parseCommandLine().

m_variables_map

bpo::variables_map ApplicationOptions::m_variables_map

private

Definition at line 63 of file AppOptions.h.

Referenced by find(), getVariables(), mainWindowSize(), operator[](), parseCommandLine(), and processOptions().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/App/AppOptions.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/App/AppOptions.cpp