commandlineparser.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        K. Tingdahl
 Date:          March 2013
 RCS:           $Id$
________________________________________________________________________
 
 
 
-*/
 
#include "convert.h"
#include "dbkey.h"
#include "genc.h"
#include "bufstringset.h"
#include "typeset.h"
#include "debug.h" // easier for test programs, declares od_init_test_program
 
mExpClass(Basic) CommandLineParser
{
public:
                                CommandLineParser(const char*);
                                CommandLineParser(int argc,char** argv);
                                CommandLineParser();
    void                        setKeyHasValue(const char* key,int nrvals=1);
    void                        getNormalArguments(BufferStringSet&) const;
    bool                        hasKey(const char*) const;
    bool                        getVal(const char* key,BufferString&,
                                       bool acceptnone=false,int valnr=1) const;
    bool                        getVal(const char* key,DBKey&,
                                       bool acceptnone=false,int valnr=1) const;
    template <class T> bool     getVal(const char* key,T&,
                                       bool acceptnone=false,int valnr=1) const;
                                // following return empty string, invalid DBKey
                                // or Udf if the key is not present or
                                // carries no value
    BufferString                keyedString(const char* ky,int argnr=0) const;
    template <class T>
    T                           keyedValue(const char* ky,int argnr=0) const;
 
    bool                        isPresent(const char*) const;
 
    int                         nrArgs() const          { return argv_.size(); }
    bool                        isKey(int) const;
    bool                        isKeyValue(int idx) const;
    const OD::String&           getArg(int idx) const   { return *argv_[idx]; }
    const OD::String&           lastArg() const;
 
    const OD::String&           getExecutable() const;
    const OD::String&           getExecutableName() const;
 
    mDeprecated                 ("Use BufferString createKey(const char*)")
    static void                 createKey(const char* key,BufferString& res)
                                { res = "--"; res += key; }
    static BufferString         createKey( const char* key )
                                { return BufferString("--",key); }
 
    static void                 addKey(const char* key,BufferString& cmd,
                                       const char* valstr=0);
    static void                 addFilePath(const char*,BufferString& cmd);
    static const char*          sDataRootArg()          { return "dataroot"; }
    static const char*          sSurveyArg()            { return "survey"; }
    BufferString                envVarBase() const;
    BufferString                getFullSurveyPath(bool* iscursurv=0) const;
 
private:
 
    int                         indexOf(const char*) const;
    void                        init(int,char**);
    void                        init(const char*);
 
    BufferString                progname_;
    BufferString                executable_;
    BufferStringSet             argv_;
 
    BufferStringSet             keyswithvalue_;
    TypeSet<int>                nrvalues_;
};
 
//Implementation
 
template <class T> inline
bool CommandLineParser::getVal( const char* key, T& val,
                                bool acceptnone, int valnr ) const
{
    const int keyidx = indexOf( key );
    if ( keyidx<0 )
        return acceptnone;
 
    const int validx = keyidx + mMAX(valnr,1);
    if ( !argv_.validIdx( validx ) || isKey(validx) )
        return false;
 
    val = Conv::to<T>( argv_[validx]->buf() );
 
    return !mIsUdf(val);
}
 
 
inline BufferString CommandLineParser::keyedString( const char* ky,
                                                    int argnr ) const
{
    BufferString ret;
    getVal( ky, ret, false, argnr );
    return ret;
}
 
 
template <class T> inline
T CommandLineParser::keyedValue( const char* ky, int argnr ) const
{
    T ret = mUdf(T);
    getVal( ky, ret, false, argnr );
    return ret;
}