Jpp 19.3.0-rc.3
the software that should make you happy
Loading...
Searching...
No Matches
JPARSER::JParser< JKey_t > Class Template Reference

Utility class to parse command line options. More...

#include <JParser.hh>

Inheritance diagram for JPARSER::JParser< JKey_t >:
std::map< char, JParserElement > JEEP::JMessage< T >

Public Types

typedef JLANG::JParserException JParserException
 
typedef JKey_t key_type
 
typedef std::map< key_type, JParserElementmap_type
 
typedef map_type::iterator iterator
 
typedef map_type::const_iterator const_iterator
 

Public Member Functions

 JParser (const int debug=0)
 Default constructor.
 
 JParser (const std::string &message, const int debug=0)
 Constructor.
 
JParserjoin (const JParser &parser)
 Join parser.
 
void print (std::ostream &out) const
 Print the possible command line options.
 
virtual void terminate (const int status)
 Terminate.
 
JArgs operator() (const int argc, const char *const argv[])
 Parse the program's command line options.
 
JArgs operator() (const JArgs &args)
 Parse the program's command line options.
 
int read (const int argc, const char *const argv[])
 Parse the program's command line options.
 
int read (const JArgs &args)
 Parse the program's command line options.
 
std::ostream & write (std::ostream &out) const
 Print the current parameter values.
 

Static Public Attributes

static int debug = 0
 debug level (default is off).
 

Protected Member Functions

void check_status () const
 Check if all required options have been set.
 

Protected Attributes

std::string help
 help message
 
std::string pid
 process name
 

Friends

std::ostream & operator<< (std::ostream &out, const JParser< key_type > &parser)
 Stream output.
 

Detailed Description

template<class JKey_t = char>
class JPARSER::JParser< JKey_t >

Utility class to parse command line options.

The mapping between a parameter (of any type) and a unique option has to be defined in the user's application, e.g.

#include "Jeep/JParser.hh"
int main(int argc, char**argv)
{
int aap;
bool noot;
bool mies;
try {
JParser<> zap;
zap['i'] = make_field(aap) = 123; // set default value
zap['b'] = make_field(noot); // default is false
zap['B'] = make_field(mies);
zap(argc, argv);
}
catch(const std::exception& error) {
cerr << error.what() << endl;
return 1;
}
}
Utility class to parse command line options.
#define make_field(A,...)
macro to convert parameter to JParserTemplateElement object
Definition JParser.hh:2142
int main(int argc, char *argv[])
Definition Main.cc:15
Utility class to parse command line options.
Definition JParser.hh:1698

The behaviour of the parser is different for parameters of type bool. By default, its value is set to false; it is set to true when the corresponding option is parsed. This implies that no data are read and that several options can be parsed in sequence without repeating the '-' symbol.

The syntax for the command line is:

program [-<option> <value> [-<option> <value>]]
program -h 

will print the usage specification including all existing options.

program --!

will terminate the parsing of options and print the actual setting of all options.

After the command line has been parsed, it is checked whether each parameter has been assigned a value by default or at run time. If not, an exception is thrown.

For a comparison between the parsing of command line options with JParser and boost, see internal note which is accessible for anyone with a KM3NeT account.

Definition at line 1695 of file JParser.hh.

Member Typedef Documentation

◆ JParserException

template<class JKey_t = char>
JLANG::JParserException JPARSER::JParser< JKey_t >::JParserException

Definition at line 1701 of file JParser.hh.

◆ key_type

template<class JKey_t = char>
JKey_t JPARSER::JParser< JKey_t >::key_type

Definition at line 1702 of file JParser.hh.

◆ map_type

template<class JKey_t = char>
std::map<key_type, JParserElement> JPARSER::JParser< JKey_t >::map_type

Definition at line 1703 of file JParser.hh.

◆ iterator

template<class JKey_t = char>
map_type::iterator JPARSER::JParser< JKey_t >::iterator

Definition at line 1705 of file JParser.hh.

◆ const_iterator

template<class JKey_t = char>
map_type::const_iterator JPARSER::JParser< JKey_t >::const_iterator

Definition at line 1706 of file JParser.hh.

Constructor & Destructor Documentation

◆ JParser() [1/2]

template<class JKey_t = char>
JPARSER::JParser< JKey_t >::JParser ( const int debug = 0)
inline

Default constructor.

Parameters
debugdebug level

Definition at line 1716 of file JParser.hh.

1716 :
1717 help ()
1718 {
1719 this->debug = debug;
1720 }
std::string help
help message
Definition JParser.hh:2063
static int debug
debug level (default is off).
Definition JMessage.hh:45

◆ JParser() [2/2]

template<class JKey_t = char>
JPARSER::JParser< JKey_t >::JParser ( const std::string & message,
const int debug = 0 )
inline

Constructor.

Parameters
messagemessage printed with option -h
debugdebug level

Definition at line 1729 of file JParser.hh.

1730 :
1731 help (message)
1732 {
1733 this->debug = debug;
1734 }

Member Function Documentation

◆ join()

template<class JKey_t = char>
JParser & JPARSER::JParser< JKey_t >::join ( const JParser< JKey_t > & parser)
inline

Join parser.

Parameters
parserparser
Returns
this parser

Definition at line 1743 of file JParser.hh.

1744 {
1745 this->insert(parser.begin(), parser.end());
1746
1747 return *this;
1748 }

◆ print()

template<class JKey_t = char>
void JPARSER::JParser< JKey_t >::print ( std::ostream & out) const
inline

Print the possible command line options.

Parameters
outoutput stream

Definition at line 1756 of file JParser.hh.

1757 {
1758 using namespace std;
1759 using namespace JPP;
1760
1761 if (help != "") {
1762 out << help << endl;
1763 }
1764
1765 out << "usage: " << getFilename(pid) << endl;
1766
1767 out << ' ' << START_OF_OPTION << HELP_OPTION << ' ' << " \"help\"" << endl;
1768 out << ' ' << START_OF_OPTION << HELP_OPTION << PRINT_OPTION << " \"help with print of default and possible values\"" << endl;
1769 out << ' ' << START_OF_OPTION << REVISION_OPTION << ' ' << " \"print revision\"" << endl;
1770 out << ' ' << START_OF_OPTION << END_OF_OPTIONS << ' ' << " \"end of options; remainder will be discarded\"" << endl;
1771 out << ' ' << START_OF_OPTION << END_OF_OPTIONS << PRINT_OPTION << " \"end of options with print of actual values\"" << endl;
1772
1773 for (const_iterator i = this->begin(); i != this->end(); ++i) {
1774
1775 out << ' ' << START_OF_OPTION << i->first << " ";
1776
1777 i->second.print(out);
1778
1779 out << endl;
1780 }
1781
1782 if (getURL() != "") {
1783 out << endl << "See also: " << getURL() << '#' << getFilename(pid) << endl;
1784 }
1785 }
std::string pid
process name
Definition JParser.hh:2064
map_type::const_iterator const_iterator
Definition JParser.hh:1706
std::string getURL()
Get URL of document pages.
static char END_OF_OPTIONS
end of all options
Definition JParser.hh:81
static char REVISION_OPTION
revision option
Definition JParser.hh:83
static char START_OF_OPTION
Parser options.
Definition JParser.hh:80
static char HELP_OPTION
help option
Definition JParser.hh:82
static char PRINT_OPTION
print option
Definition JParser.hh:84
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).

◆ terminate()

template<class JKey_t = char>
virtual void JPARSER::JParser< JKey_t >::terminate ( const int status)
inlinevirtual

Terminate.

Parameters
statusexit status

Definition at line 1793 of file JParser.hh.

1794 {
1795 exit(status);
1796 }

◆ operator()() [1/2]

template<class JKey_t = char>
JArgs JPARSER::JParser< JKey_t >::operator() ( const int argc,
const char *const argv[] )
inline

Parse the program's command line options.

Parameters
argcnumber of arguments
argvargument list
Returns
argument list

Definition at line 1806 of file JParser.hh.

1807 {
1808 return (*this)(JArgs(argc, argv));
1809 }
Data structure to store command line arguments.
Definition JArgs.hh:26

◆ operator()() [2/2]

template<class JKey_t = char>
JArgs JPARSER::JParser< JKey_t >::operator() ( const JArgs & args)
inline

Parse the program's command line options.

Parameters
argsargument list
Returns
argument list

Definition at line 1818 of file JParser.hh.

1819 {
1820 using namespace std;
1821 using namespace JLANG;
1822 using namespace JEEP;
1823
1824 pid = args.PID;
1825
1826 istringstream is;
1827
1828 // argument passing
1829
1830 for (JArgs::const_iterator i = args.begin(); i != args.end(); ++i) {
1831
1832 DEBUG("Processing option <" << *i << ">" << endl);
1833
1834 is.clear();
1835 is.str(*i);
1836
1837 for (int c; (c = is.get()) != EOF; ) {
1838
1839 if (c == START_OF_OPTION) {
1840
1841 if (is.peek() == EOF) { // end-of-file
1842
1843 THROW(JParserException, "stray " << START_OF_OPTION << " in <" << is.str() << "> at " << JArgs("", i, args.end()));
1844
1845 } else if (isspace(is.peek())) { // white space
1846
1847 THROW(JParserException, "stray " << START_OF_OPTION << " in <" << is.str() << "> at " << JArgs("", i, args.end()));;
1848 }
1849
1850 while (is.peek() != EOF) { // read option(s)
1851
1852 if (is.peek() == HELP_OPTION) { // help
1853
1854 is.get();
1855
1856 setPrintOption(cout, SHORT_PRINT);
1857
1858 if (is.peek() != EOF) {
1859
1860 if (is.get() == PRINT_OPTION) {
1861
1862 setPrintOption(cout, LONG_PRINT);
1863
1864 } else {
1865
1866 THROW(JParserException, "invalid option at <" << is.str() << ">");
1867 }
1868 }
1869
1870 print(cout);
1871
1873
1874 return JArgs();
1875
1876 } else if (is.peek() == REVISION_OPTION) { // revision
1877
1878 cout << "source: " << getSource() << endl;
1879 cout << "version: " << getGITVersion() << endl;
1880 cout << "commit: " << getGITCommit() << endl;
1881 cout << "date: " << getGITDate() << endl;
1882 cout << "namespace: " << getNamespace() << endl;
1883
1885
1886 return JArgs();
1887
1888 } else if (is.peek() == END_OF_OPTIONS) { // end of options
1889
1890 is.get();
1891
1892 if (is.peek() != EOF) {
1893
1894 c = is.get();
1895
1896 if (c == PRINT_OPTION) {
1897
1898 setPrintOption(cout, MEDIUM_PRINT);
1899
1900 print(cout);
1901
1902 } else if (c == PID_OPTION) {
1903
1904 if (is.peek() == EOF && i + 1 != args.end()) {
1905 is.clear();
1906 is.str(*++i);
1907 }
1908
1909 string file_name;
1910
1911 getline(is, file_name);
1912
1913 ofstream out(file_name.c_str());
1914
1915 out << getpid() << endl;
1916
1917 if (!out) {
1918 THROW(JParserException, "invalid option at <" << is.str() << ">");
1919 }
1920
1921 out.close();
1922
1923 } else {
1924
1925 THROW(JParserException, "invalid option at <" << is.str() << ">");
1926 }
1927 }
1928
1929 check_status();
1930
1931 return JArgs(pid, ++i, args.end());
1932
1933 } else {
1934
1935 key_type option;
1936
1937 is >> option;
1938
1939 iterator p = this->find(option);
1940
1941 DEBUG("Processing option <" << option << "> " << (p != this->end()) << endl);
1942
1943 if (p != this->end()) {
1944
1945 if (p->second->gcount()) {
1946
1947 if (is.peek() == EOF && i + 1 != args.end()) {
1948 is.clear();
1949 is.str(*++i);
1950 }
1951 }
1952
1953 try {
1954 is >> p->second;
1955 }
1956 catch(const exception& error) {
1957 THROW(JParserException, "read error " << error.what() << " at <" << is.str() << ">");
1958 }
1959
1960 if (fail(is)) {
1961 THROW(JParserException, "read error at <" << is.str() << ">");
1962 }
1963
1964 } else {
1965
1966 THROW(JParserException, "unknown option <" << is.str() << "> at " << JArgs("", i, args.end()));
1967 }
1968 }
1969 }
1970
1971 } else {
1972
1973 THROW(JParserException, "illegal character <" << (char) c << "> at " << JArgs("", i, args.end()));
1974 }
1975 }
1976 }
1977
1978 check_status();
1979
1980 return JArgs();
1981 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
void setPrintOption(std::ostream &out, const int option)
Set print option.
Definition JManip.hh:63
#define DEBUG(A)
Message macros.
Definition JMessage.hh:62
Exception when parsing a value.
virtual void terminate(const int status)
Terminate.
Definition JParser.hh:1793
void print(std::ostream &out) const
Print the possible command line options.
Definition JParser.hh:1756
void check_status() const
Check if all required options have been set.
Definition JParser.hh:2049
General puprpose classes and methods.
std::string getGITVersion(const std::string &tag)
Get GIT version for given GIT tag.
Auxiliary classes and methods for language specific functionality.
std::istream & getline(std::istream &in, JString &object)
Read string from input stream until end of line.
Definition JString.hh:478
const char * getGITDate()
Get GIT date.
Definition Jpp.cc:39
const char * getSource()
Get source.
Definition Jpp.hh:89
const char * getGITCommit()
Get GIT commit.
Definition Jpp.cc:24
bool fail(std::istream &in)
Check for stream state.
Definition JParser.hh:98
static int NORMAL_EXIT_CODE
exit code of normal end
Definition JParser.hh:86
static char PID_OPTION
print PID to file
Definition JParser.hh:85

◆ read() [1/2]

template<class JKey_t = char>
int JPARSER::JParser< JKey_t >::read ( const int argc,
const char *const argv[] )
inline

Parse the program's command line options.


This method is maintained for backward compatibility and will be deprecated.

Parameters
argcnumber of arguments
argvargument list
Returns
0

Definition at line 1992 of file JParser.hh.

1993 {
1994 (*this)(argc, argv);
1995
1996 return 0;
1997 }

◆ read() [2/2]

template<class JKey_t = char>
int JPARSER::JParser< JKey_t >::read ( const JArgs & args)
inline

Parse the program's command line options.


This method is maintained for backward compatibility and will be deprecated.

Parameters
argsargument list
Returns
0

Definition at line 2007 of file JParser.hh.

2008 {
2009 (*this)(args);
2010
2011 return 0;
2012 }

◆ write()

template<class JKey_t = char>
std::ostream & JPARSER::JParser< JKey_t >::write ( std::ostream & out) const
inline

Print the current parameter values.

Parameters
outoutput stream
Returns
output stream

Definition at line 2021 of file JParser.hh.

2022 {
2023 for (const_iterator i = this->begin(); i != this->end(); ++i) {
2024 out << i->second->getName() << '=' << i->second << std::endl;
2025 }
2026
2027 return out;
2028 }

◆ check_status()

template<class JKey_t = char>
void JPARSER::JParser< JKey_t >::check_status ( ) const
inlineprotected

Check if all required options have been set.


This method throws an exception in case of a non-compliance.

Definition at line 2049 of file JParser.hh.

2050 {
2051 for (const_iterator p = this->begin(); p != this->end(); ++p) {
2052
2053 if (!p->second->getInitialisationStatus()) {
2054 THROW(JParserException, pid << " option: " << START_OF_OPTION << p->first << " <" << p->second->getName() << ">" << " has no value");
2055 }
2056
2057 if (!p->second->getStatus()) {
2058 THROW(JParserException, pid << " option: " << START_OF_OPTION << p->first << " <" << p->second->getName() << ">" << " has illegal value");
2059 }
2060 }
2061 }
JLANG::JParserException JParserException
Definition JParser.hh:1701

Friends And Related Symbol Documentation

◆ operator<<

template<class JKey_t = char>
std::ostream & operator<< ( std::ostream & out,
const JParser< key_type > & parser )
friend

Stream output.

Parameters
outoutput stream
parserparser
Returns
output stream

Definition at line 2038 of file JParser.hh.

2039 {
2040 return parser.write(out);
2041 }
std::ostream & write(std::ostream &out) const
Print the current parameter values.
Definition JParser.hh:2021

Member Data Documentation

◆ help

template<class JKey_t = char>
std::string JPARSER::JParser< JKey_t >::help
protected

help message

Definition at line 2063 of file JParser.hh.

◆ pid

template<class JKey_t = char>
std::string JPARSER::JParser< JKey_t >::pid
protected

process name

Definition at line 2064 of file JParser.hh.

◆ debug

template<class T >
int JEEP::JMessage< T >::debug = 0
staticinherited

debug level (default is off).

Definition at line 45 of file JMessage.hh.


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