Detailed Description

Class for management of command line arguments.

This class allows to manage the command line arguments as commands, options and extra arguments.

The example below is for a command line program with two commands ('run' and 'search') and associated options

#include <openfluid/utils/CommandLineParser.hpp>
 
int main(int argc, char** argv)
{
  // ------- Definition of the parser for "myprogram"
 
  openfluid::utils::CommandLineParser Parser("myprogram","this is my program"); 
 
  // add of the "run" command with associated options
  openfluid::utils::CommandLineCommand RunCmd("run","run the process");
  RunCmd.addOption(openfluid::utils::CommandLineOption("input-path","i","input path",true));
  RunCmd.addOption(openfluid::utils::CommandLineOption("output-path","o","output path",true));
  RunCmd.addOption(openfluid::utils::CommandLineOption("verbose","","verbose mode"));
  Parser.addCommand(RunCmd);
 
  // add of the "search" command with associated options
  openfluid::utils::CommandLineCommand SearchCmd("search","search for data");
  SearchCmd.addOption(openfluid::utils::CommandLineOption("path","p","path to search",true));
  SearchCmd.addOption(openfluid::utils::CommandLineOption("extended","e","enable extended search"));
  Parser.addCommand(SearchCmd);
 
 
  // ------- Parsing of the given arguments
 
  Parser.parse(argc,argv);
  
 
  // ------- Processing of commands and options
 
  std::string ActiveCommand = Parser.getActiveCommand();
  
  if (ActiveCommand.empty())
  {
    // .. code here when no command
  }
  else if (ActiveCommand == "run")
  {
    // .. code here for "run" command
 
    if (Parser.command(ActiveCommand).isOptionActive("input-path"))
    {
      // .. code here for "input-path" option
    }
    if (Parser.command(ActiveCommand).isOptionActive("output-path"))
    {
      // .. code here for "output-path" option
    }
    
    // ...
  }
  else if (ActiveCommand == "search")
  {
    // .. code here for "search" command
  }
}

#include <utils/CommandLineParser.hpp>

Public Member Functions
	CommandLineParser ()

	CommandLineParser (const std::string &ProgramName, const std::string &HelpText, bool UseCustomOrder=false)

const std::vector< std::string > &	extraArgs () const

const std::vector< std::string > &	thirdPartyArgs () const

std::string	getHelpText () const

std::string	getProgramName () const

std::string	getParsingMessage () const

std::string	getActiveCommand () const

const CommandLineCommand &	command (const std::string &Name) const

void	addCommand (const CommandLineCommand &Command)

void	addOption (const CommandLineOption &Option)

bool	parse (std::list< std::string > ArgValues)

bool	parse (int ArgC, char **ArgV)

void	reset ()

bool	isHelpAsked ()

void	printHelp (std::ostream &OutStm)

void	printState (std::ostream &OutStm)

Protected Member Functions
int	getLargestCommandLength ()

int	getLargestOptionLength ()

std::string	getCustomIndent (int CommandLength, int LargestCommandLength, std::string minimalSpace=" ")

CommandLineOption	getHelpOption ()

void	displayFormattedData (std::ostream &OutStm, std::string Title, std::string HelpText, int LargestTextLength)

void	displayOptions (std::ostream &OutStm, CommandLineOption HelpOption, int LargestTextLength)

std::string	getArgsDisplay ()

void	displayUsageMessage (std::ostream &OutStm)

Protected Attributes
std::string	m_ProgramName

std::string	m_HelpText

std::map< std::string, CommandLineCommand >	m_Commands

std::vector< CommandLineCommand >	m_CommandsOrdered

std::string	m_ActiveCommand

const std::string	m_AvailableCommandsText

Inheritance diagram for openfluid::utils::CommandLineParser:

[legend]

Constructor & Destructor Documentation

◆ CommandLineParser() [1/2]

openfluid::utils::CommandLineParser::CommandLineParser ( )

inline

◆ CommandLineParser() [2/2]

openfluid::utils::CommandLineParser::CommandLineParser	(	const std::string &	ProgramName,
		const std::string &	HelpText,
		bool	UseCustomOrder = `false`
	)

inline

Instanciates a command line parser with the given parameters

Parameters

[in]	ProgramName	The name of the programn
[in]	HelpText	The help text associated to the option
[in]	UseCustomOrder	Enables custom order in the display

Member Function Documentation

◆ addCommand()

void openfluid::utils::CommandLineParser::addCommand ( const CommandLineCommand & Command )

inline

Adds a command to the parser

Parameters

[in] Command The command to add

◆ addOption()

void openfluid::utils::CommandLineParser::addOption ( const CommandLineOption & Option )

inline

Adds a global option to the parser

Parameters

[in] Option The option to add

◆ command()

const CommandLineCommand& openfluid::utils::CommandLineParser::command ( const std::string & Name ) const

inline

Returns the command corresponding to the given name

Parameters

[in] Name the name of the command

Returns: The command object

◆ displayFormattedData()

void openfluid::utils::CommandLineParser::displayFormattedData	(	std::ostream &	OutStm,
		std::string	Title,
		std::string	HelpText,
		int	LargestTextLength
	)

inlineprotected

◆ displayOptions()

void openfluid::utils::CommandLineParser::displayOptions	(	std::ostream &	OutStm,
		CommandLineOption	HelpOption,
		int	LargestTextLength
	)

inlineprotected

◆ displayUsageMessage()

void openfluid::utils::CommandLineParser::displayUsageMessage ( std::ostream & OutStm )

inlineprotected

◆ extraArgs()

const std::vector<std::string>& openfluid::utils::CommandLineParser::extraArgs ( ) const

inline

Returns the extra arguments given to the command

Returns: a vector of arguments

◆ getActiveCommand()

std::string openfluid::utils::CommandLineParser::getActiveCommand ( ) const

inline

Returns the active command name

Returns: The active command name

◆ getArgsDisplay()

std::string openfluid::utils::CommandLineParser::getArgsDisplay ( )

inlineprotected

◆ getCustomIndent()

std::string openfluid::utils::CommandLineParser::getCustomIndent	(	int	CommandLength,
		int	LargestCommandLength,
		std::string	minimalSpace = `" "`
	)

inlineprotected

◆ getHelpOption()

CommandLineOption openfluid::utils::CommandLineParser::getHelpOption ( )

inlineprotected

◆ getHelpText()

std::string openfluid::utils::CommandLineParser::getHelpText ( ) const

inline

Returns the help text of the parser

Returns: The help text

◆ getLargestCommandLength()

int openfluid::utils::CommandLineParser::getLargestCommandLength ( )

inlineprotected

◆ getLargestOptionLength()

int openfluid::utils::CommandLineParser::getLargestOptionLength ( )

inlineprotected

◆ getParsingMessage()

std::string openfluid::utils::CommandLineParser::getParsingMessage ( ) const

inline

Returns the message given by the parsing process in case of error(s)

Returns: The message

◆ getProgramName()

std::string openfluid::utils::CommandLineParser::getProgramName ( ) const

inline

Returns the program name

Returns: The program name

◆ isHelpAsked()

bool openfluid::utils::CommandLineParser::isHelpAsked ( )

inline

Tests if the help is asked

Returns: true if the help is asked

◆ parse() [1/2]

bool openfluid::utils::CommandLineParser::parse	(	int	ArgC,
		char **	ArgV
	)

inline

Parses arguments from the standard parameters (int argc,char** argv) given through the main function

Parameters

[in]	ArgC	The number of arguments
[in]	ArgV	The array of arguments

Returns: true if the parsing is succesful, false otherwise

◆ parse() [2/2]

bool openfluid::utils::CommandLineParser::parse ( std::list< std::string > ArgValues )

inline

Parses a list of string arguments

Parameters

[in] ArgValues The lists of arguments to parse

Returns: true if the parsing is succesful, false otherwise

◆ printHelp()

void openfluid::utils::CommandLineParser::printHelp ( std::ostream & OutStm )

inline

Prints the help text

Parameters

[in] OutStm The stream where the help text is printed (e.g. std::cout)

◆ printState()

void openfluid::utils::CommandLineParser::printState ( std::ostream & OutStm )

inline

Prints the state of the parser

Parameters

[in] OutStm The stream where the help text is printed (e.g. std::cout)

◆ reset()

void openfluid::utils::CommandLineParser::reset ( )

inline

Resets the parser to default (no active command, no extra arguments, no option activated)

◆ thirdPartyArgs()

const std::vector<std::string>& openfluid::utils::CommandLineParser::thirdPartyArgs ( ) const

inline

Returns the third party arguments given to the command, mainly used to pass arguments to a third party program

Returns: a vector of arguments

Member Data Documentation

◆ m_ActiveCommand

std::string openfluid::utils::CommandLineParser::m_ActiveCommand

protected

◆ m_AvailableCommandsText

const std::string openfluid::utils::CommandLineParser::m_AvailableCommandsText

protected

◆ m_Commands

std::map<std::string,CommandLineCommand> openfluid::utils::CommandLineParser::m_Commands

protected

◆ m_CommandsOrdered

std::vector<CommandLineCommand> openfluid::utils::CommandLineParser::m_CommandsOrdered

protected

◆ m_HelpText

std::string openfluid::utils::CommandLineParser::m_HelpText

protected

◆ m_ProgramName

std::string openfluid::utils::CommandLineParser::m_ProgramName

protected

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

utils/CommandLineParser.hpp

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ CommandLineParser() [1/2]

◆ CommandLineParser() [2/2]

Member Function Documentation

◆ addCommand()

◆ addOption()

◆ command()

◆ displayFormattedData()

◆ displayOptions()

◆ displayUsageMessage()

◆ extraArgs()

◆ getActiveCommand()

◆ getArgsDisplay()

◆ getCustomIndent()

◆ getHelpOption()

◆ getHelpText()

◆ getLargestCommandLength()

◆ getLargestOptionLength()

◆ getParsingMessage()

◆ getProgramName()

◆ isHelpAsked()

◆ parse() [1/2]

◆ parse() [2/2]

◆ printHelp()

◆ printState()

◆ reset()

◆ thirdPartyArgs()

Member Data Documentation

◆ m_ActiveCommand

◆ m_AvailableCommandsText

◆ m_Commands

◆ m_CommandsOrdered

◆ m_HelpText

◆ m_ProgramName