argumentParser.h

Go to the documentation of this file.

/******************************************************************************
*       SOFA, Simulation Open-Framework Architecture, version 1.0 beta 3      *
*                (c) 2006-2008 MGH, INRIA, USTL, UJF, CNRS                    *
*                                                                             *
* This library is free software; you can redistribute it and/or modify it     *
* under the terms of the GNU Lesser General Public License as published by    *
* the Free Software Foundation; either version 2.1 of the License, or (at     *
* your option) any later version.                                             *
*                                                                             *
* This library is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License *
* for more details.                                                           *
*                                                                             *
* You should have received a copy of the GNU Lesser General Public License    *
* along with this library; if not, write to the Free Software Foundation,     *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.          *
*******************************************************************************
*                               SOFA :: Modules                               *
*                                                                             *
* Authors: The SOFA Team and external contributors (see Authors.txt)          *
*                                                                             *
* Contact information: contact@sofa-framework.org                             *
******************************************************************************/
//========================================================
// Yet another command line parser. 
// Fran�is Faure, iMAGIS-GRAVIR, May 2001
//========================================================

#ifndef ANIMAL_command_line_parser________
#define ANIMAL_command_line_parser________

#include <iostream>
#include <stdlib.h>
//#include <strstream>
#include <sstream>
#include <fstream>
#include <string>
#include <vector>
#include <algorithm>
#include <map>
#include <list>

typedef std::istringstream istrstream; 

struct ArgumentBase
{
    typedef std::string string;
    
    ArgumentBase(char s, string l, string h, bool m)
        : shortName(s)
        , longName(l)
        , help(h)
        , mandatory(m)
        , isSet(false)
    {}
    
    virtual ~ArgumentBase(){}

    virtual bool read( std::list<std::string>& str ) = 0;
    
    virtual void printValue() const =0;

    char shortName; 
    string longName;  
    string help;      
    
    inline void print () const
    {
        std::cout << "-" << shortName <<",\t--"<< longName <<":\t" << help;
        if( mandatory ) std::cout<< " (required) ";
        std::cout << "  (default: "; printValue();
        std::cout << ")" << std::endl;
    }

    bool mandatory;

    bool isSet;
    

};


//=========================================================================

template < class T = void* >
struct Argument : public ArgumentBase {

    
    Argument( T* t, char sn, string ln, string h, bool m )
        : ArgumentBase(sn,ln,h,m)
        , ptr(t)
    {}
    
    inline void printValue() const ;
    
private:
    T* ptr;
    
    
    inline bool read( std::list<std::string>& str ) {
        if (str.empty()) return false;
        std::string s = str.front();
        str.pop_front();
        istrstream istr( s.c_str() );
        if( ! (istr >> *ptr) ) return false;
        else {
            isSet = true;
            return true;
        }
    }
    
};

template<> inline 
bool Argument<bool>::read( std::list<std::string>& )
{
    *ptr = true;
    isSet = true;
    return true;
}

template<> inline 
        bool Argument<std::string>::read( std::list<std::string>& str )
{
    if (str.empty()) return false;
    std::string s = str.front();
    str.pop_front();
    *ptr = s;
    isSet = true;
    return true;
}

template<class T> inline
void Argument<T>::printValue() const {
    std::cout << *ptr << " ";
}


//========================================================================

class ArgumentParser {
    typedef std::string string;
    typedef std::map< string, ArgumentBase* > Map;
    std::map< char, ArgumentBase* > shortName;
    Map longName;
    
    typedef std::map<ArgumentBase*,bool> SetMap;
    
    SetMap parameter_set;
    
    typedef std::vector<ArgumentBase*> ArgVec;
    ArgVec commands;
    
    // help stuff
    string globalHelp;    
    char helpShortName;   
    string helpLongName;  

public:

    ArgumentParser( const string& helpstr="", char hlpShrt='h', const string& hlpLng="help" )
        : globalHelp( helpstr )
        , helpShortName(hlpShrt)
        , helpLongName(hlpLng)
    {}
    
    template<class T> inline 
    ArgumentParser& option( T* ptr, char sho, char* lon, char* help )
    {
        string sn, ln(lon), h(help); sn += sho;
        
        if( sho!=0 && shortName.find(sho) != shortName.end() ){
            std::cerr << "name " << sn << " already used !" << std::endl;
            exit( 1 );
        }
        
        if( ln.size()>0 && longName.find(ln) != longName.end() ){
            std::cerr << "name " << ln << " already used !" << std::endl;
            exit( 1 );
        }
        
        if( sho!=0 && sho == helpShortName ){
            std::cerr << "name " << sho << " reserved for help !" << std::endl;
            exit( 1 );
        }
        if( ln.size()>0 && lon == helpLongName ){
            std::cerr << "name " << lon << " reserved for help !" << std::endl;
            exit( 1 );
        }
        
        ArgumentBase* c = new Argument<T>(ptr,sho,ln,h,false);
        shortName[sho] = c; 
        longName[lon] = c; 
        commands.push_back(c);
        return (*this);
    }
    
    template<class T> inline 
    ArgumentParser& parameter( T* ptr, char sho, char* lon, char* help )
    {
        string sn, ln(lon), h(help); sn += sho;
        
        if( sho!=0 && shortName.find(sho) != shortName.end() ){
            std::cerr << "name " << sn << " already used !" << std::endl;
            exit( 1 );
        }
        
        if( ln.size()>0 && longName.find(ln) != longName.end() ){
            std::cerr << "name " << ln << " already used !" << std::endl;
            exit( 1 );
        }
        
        if( sho!=0 && sho == helpShortName ){
            std::cerr << "name " << sho << " reserved for help !" << std::endl;
            exit( 1 );
        }
        if( ln.size()>0 && lon == helpLongName ){
            std::cerr << "name " << lon << " reserved for help !" << std::endl;
            exit( 1 );
        }
        
        ArgumentBase* c = new Argument<T>(ptr,sho,ln,h,true);
        shortName[sho] = c; 
        longName[lon] = c; 
        commands.push_back(c);
        return (*this);
    }


    inline void operator () ( int argc, char** argv )
    {
        std::list<std::string> str;
        for (int i=1;i<argc;++i)
            str.push_back(std::string(argv[i]));
        (*this)(str);
    }

    inline void operator () ( std::list<std::string> str )
    {
        string shHelp("-");  shHelp.push_back( helpShortName ); 
        string lgHelp("--"); lgHelp.append( helpLongName ); 
        string name;
        while( !str.empty() ){
            name = str.front();
            str.pop_front();
//          std::cout << "name = " << name << std::endl;
//          std::cout << "lgHelp = " << lgHelp << std::endl;
//          std::cout << "shHelp = " << shHelp << std::endl;
            
            // display help
            if( name == shHelp || name == lgHelp )
            {
                if( globalHelp.size()>0 ) std::cout<< globalHelp <<std::endl;
                std::cout << "(short name, long name, description, default value)\n-h,\t--help: this help" << std::endl;
                for( ArgVec::const_iterator a=commands.begin(), aend=commands.end(); a!=aend; ++a )
                    (*a)->print();
                exit(1);
            }
            
            // long name
            else if( name.length() > 1 && name[0]=='-' && name[1]=='-' ){
                string a;
                for( unsigned int i=2; i<name.length(); ++i ){
                    a += name[i];
                }
                if( longName.find(a) != longName.end() ){
                    if( !(longName[ a ]->read( str ))) 
                        std::cerr<< "\ncould not read value for option " << name << std::endl << std::endl;
                    else parameter_set[longName[ a ]] = true;
                }
                else std::cerr << "\nUnknown option " << name << std::endl << std::endl;
            }
            
            // short names (possibly concatenated)
            else if( name.length() > 1 && name[0]=='-' && name[1]!='-' ){
                for( unsigned int i=1; i<name.length(); ++i ){
                    char a = name[i];
                    if( shortName.find(a) != shortName.end() ){
                        if( !(shortName[ a ]->read( str ))) 
                            std::cerr<< "\ncould not read value for option " << name << std::endl << std::endl;
                        else parameter_set[shortName[ a ]] = true;
                    }
                    else std::cerr << "\nUnknown option " << name[i] << std::endl << std::endl;
                }
            }
            
            //
            else std::cerr << "Unknown option " << name << std::endl;
        }

        // Unset mandatory arguments ?
        bool unset = false;
        for( ArgVec::const_iterator cm = commands.begin(), cmend=commands.end(); cm != cmend; ++cm )
        {
            if( (*cm)->mandatory && !(*cm)->isSet ){
                if( !unset )
                {
                    std::cout << "Please set the following parameters: (short name, long name, description)" << std::endl;
                    unset = true;
                }
                (*cm)->print();                 
            }
        }   
        if( unset ) exit(1);
    }

};

inline ArgumentParser parse( const std::string& helpstr="", char hs='h', const std::string& hl="help" ){ 
    return ArgumentParser(helpstr,hs,hl); 
}




#endif