ParamReader¶

constructor¶

ParamReader();

The constructor.

destructor¶

~ParamReader();

The destructor.

setOptions¶

setOptions(int iNumOptions, ...);

Assign variables to flags.

iNumOptions

Number of options.

...

The vararg argument must consist of iNumOptions pairs of option-definition string and void*. See Example below.

The option-definition has two possible formats:

simple-opt   ::= "-"  <option-char> ":" <option-type> ["!"]
long-opt     ::= "--" <option-name> ":" <option-type>
option-type  ::= 'c'| 'h' | 'i' | 'l'  | 'f' | 'd' | 'b'  | 's' | 'S' | '0'

The the meaning of the option types is found in this table.

Returns true on success.

getParams¶

int  getParams(int iArgC, char *apArgV[], bool bOverwrite=false);

Read the command line parameters and set variables.

iArgC

Number of command line arguments.

apArgV

Array of arguments.

bOverwrite

If true, the variable for a repeated flag will be overwritten.

Returns 0 on success, or an error code.

getParams¶

int  getParams(const std::string sConfigFile, bool bOverwrite=false);

Read a config file and set variables.

sConfigFile

Configuration file.

bOverwrite

If true, the variable for a repeated flag will be overwrittem

Returns 0 on success, or an error code.

getMandatoryParams¶

uint getMandatoryParams(stringvec &vMand);

Gets the names of the mandatory options and puts them into vMand.

vMand

A string vector to be filled with the names of the mandatory options.

Returns the number of mandatory options.

getUnknownParams¶

uint getUnknownParams(stringvec &vUnknown);

Gets the names of the unknown options and puts them into vUnknown.

vUnknown

A string vector to be filled with the names of the unknown options.

Returns the number of unknown options.

getFreeParams¶

uint getFreeParams(stringvec &vFree);

Gets the names of the free parameters and puts them into vFree.

vFree

A string vector to be filled with the names of the free parameters.

Returns the number of free parameters.

writeConfigFile¶

bool writeConfigFile(const std::string sConfigFile, const std::string sOmit);

Writes a config file containing the values passed to getParams() which can be used as input to getParams() at a later time.

sConfigFile

Name of file to write to.

sOmit

Comma-separated list of options to omit.

Returns true on success.

collectOptions¶

void collectOptions(stringvec &vsOptions);

Fills a vsOptions with options and values.

vsOptions

A string vector to be filled with the options.

getErrorMessage¶

std::string getErrorMessage(int iResult);

Returns the error message corresponding to the error code iResult.

getBadArg¶

std::string getBadArg();

Returns the option that caused an error.

getBadVal¶

std::string getBadVal();

Returns the value of the option that caused an error.

display¶

void display();

Display the options and their values to stdout, one option per line.

display¶

void display(FILE *fOut, bool bLines);

Writes the options and their values to fOut.

fOut

FIle to write to.

bLines

If true one option per line is written, otherwise a line consisting of space separated options and values is written.

g++ pr_example.cpp ParamReader.cpp xha_strutils.cpp xha_strutilsT.h --std=c++20 -o pr_example

#include <cstdio>
#include <string>
#include <vector>

#include "ParamReader.h"

typedef unsigned int             uint;
typedef std::vector<std::string> stringvec;

int main (int iArgC, char *apArgV[]) {
     int iResult = -1;

     bool   bHelp       = false;
     double dValue      =  -1;
     int    iSel        =  0;
     char   c1          = '\0';
     std::string sName  = "default_name";
     char  *psOpt       = NULL;

     ParamReader *pPR = new ParamReader();
     bool bOK = pPR->setOptions(6,
                                "-h:0",          &bHelp,
                                "-v:d!",         &dValue,
                                "--selector:i!", &iSel,
                                "-n:s",          &sName,
                                "--optional:S",  &psOpt,
                                "-t:c",          &c1);

     if (bOK) {
         iResult = pPR->getParams(iArgC, apArgV);
         if (iResult >= 0) {
             printf("Successs!\n");
             printf("  bHelp:     %s\n", bHelp?"true":"false");
             printf("  dValue:    %f\n", dValue);
             printf("  iSel:      %i\n", iSel);
             printf("  sName:     %s\n", sName.c_str());
             printf("  psOpt:     %s\n", psOpt);
             if (iResult == 2) {
                 stringvec vFree;
                 uint iNum = pPR->getFreeParams(vFree);
                     printf("Found %d free param%s\n", iNum, (iNum==1)?"":"s");
                 for (uint i = 0; i < iNum; i++) {
                     printf("  %s\n", vFree[i].c_str());
                 }
                 iResult = 0;
             }
         } else {
             printf("Have Error\n");
             printf("code    : %d\n", iResult);
             printf("message : %s\n", pPR->getErrorMessage(iResult).c_str());
        }
        delete pPR;
    } else {
        printf("Error in setOptions\n");
    }
    return iResult;
}