ApplicationOptions Class Reference

Handles command line and config file program options. More...

Public Member Functions
	ApplicationOptions (int argc=0, char **argv=0)
bool	disableHighDPISupport ()
bool	find (std::string name) const
	Returns true if option with given name has been set. More...
bpo::options_description &	getOptions ()
	Returns reference to the options description. More...
bpo::variables_map &	getVariables ()
	Returns reference to the variables container. More...
bool	isConsistent () const
	Returns true if options are consistent (no conflicts, no –help request) 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...
void	parseCommandLine (int argc, char **argv)
	Parses command line arguments. More...
void	printHelpMessage () const
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

Detailed Description

Handles command line and config file program options.

Definition at line 32 of file appoptions.h.

Constructor & Destructor Documentation

ApplicationOptions()

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

Definition at line 49 of file appoptions.cpp.

                                                            : m_options_is_consistent(false)
{
    m_options.add_options()("help,h", "print help message");
    m_options.add_options()("with-debug", "run application with debug printout");
    m_options.add_options()("no-splash", "do not show splash screen");
    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

(

)

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 70 of file appoptions.cpp.

{
    return (m_variables_map.count(name.c_str()));
}

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

Referenced by disableHighDPISupport(), and main().

Here is the call graph for this function:

getOptions()

boost::program_options::options_description & ApplicationOptions::getOptions

(

)

Returns reference to the options description.

Definition at line 113 of file appoptions.cpp.

{
    return m_options;
}

References m_options.

getVariables()

boost::program_options::variables_map & ApplicationOptions::getVariables

(

)

Returns reference to the variables container.

Definition at line 108 of file appoptions.cpp.

{
    return m_variables_map;
}

References m_variables_map.

isConsistent()

bool ApplicationOptions::isConsistent

(

)

const

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

Definition at line 75 of file appoptions.cpp.

{
    return m_options_is_consistent;
}

References m_options_is_consistent.

Referenced by main().

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 65 of file appoptions.cpp.

{
    return m_variables_map[s.c_str()];
}

References m_variables_map.

parseCommandLine()

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

Parses command line arguments.

parse command line arguments

Definition at line 82 of file appoptions.cpp.

{
    m_options_is_consistent = false;
    // 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);
 
        m_options_is_consistent = true;
    } catch (std::exception& e) {
        // we get here if there is unrecognized options
        std::cout << "main() ->  " << e.what() << std::endl;
        std::cout << m_options << std::endl;
    }
}

References m_options, m_options_is_consistent, m_positional_options, and m_variables_map.

Referenced by ApplicationOptions().

printHelpMessage()

void ApplicationOptions::printHelpMessage

(

)

const

Definition at line 139 of file appoptions.cpp.

{
    std::cout << "BornAgain Graphical User Interface" << std::endl;
    std::cout << m_options << std::endl;
}

References m_options.

Referenced by processOptions().

processOptions()

void ApplicationOptions::processOptions

(

)

Definition at line 118 of file appoptions.cpp.

{
    if (m_variables_map.count("help")) {
        printHelpMessage();
        m_options_is_consistent = false;
    }
 
    else if (m_variables_map.count("version")) {
        std::cout << "BornAgain-" << GUIHelpers::getBornAgainVersionString().toStdString()
                  << std::endl;
        m_options_is_consistent = false;
    }
 
    else if (m_variables_map.count(geometry)) {
        if (!isValid(mainWindowSize())) {
            std::cout << "Wrong window size, try --geometry=1600x900\n";
            m_options_is_consistent = false;
        }
    }
}

References GUIHelpers::getBornAgainVersionString(), m_options_is_consistent, m_variables_map, mainWindowSize(), and printHelpMessage().

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 66 of file appoptions.h.

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

m_options_is_consistent

bool ApplicationOptions::m_options_is_consistent

private

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

Definition at line 64 of file appoptions.h.

Referenced by isConsistent(), parseCommandLine(), and processOptions().

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 68 of file appoptions.h.

Referenced by parseCommandLine().

m_variables_map

bpo::variables_map ApplicationOptions::m_variables_map

private

Definition at line 69 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/www/ba/GUI/main/appoptions.h
• /home/www/ba/GUI/main/appoptions.cpp