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 :: Framework                              *
*                                                                             *
* Authors: M. Adam, J. Allard, B. Andre, P-J. Bensoussan, S. Cotin, C. Duriez,*
* H. Delingette, F. Falipou, F. Faure, S. Fonteneau, L. Heigeas, C. Mendoza,  *
* M. Nesme, P. Neumann, J-P. de la Plata Alcade, F. Poyer and F. Roy          *
*                                                                             *
* Contact information: contact@sofa-framework.org                             *
******************************************************************************/
//========================================================
// Yet another command line parser. 
// Francois Faure, iMAGIS-GRAVIR, May 2001
//========================================================

#ifndef SOFA_HELPER_ARGUMENTPARSER_H
#define SOFA_HELPER_ARGUMENTPARSER_H

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

namespace sofa
{

namespace helper
{

typedef std::istringstream istrstream; 

class ArgumentBase
{
public:
    typedef std::string string;
    
    ArgumentBase(char s, string l, string h, bool m);
    
    virtual ~ArgumentBase();

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

    char shortName; 
    string longName;  
    string help;      

    bool mandatory;

    bool isSet;
    
};


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

template < class T = void* >
class Argument : public ArgumentBase {
public:
    
    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<class TE> inline 
bool Argument< std::vector<TE> >::read( std::list<std::string>& str)
{
    if (str.empty()) return false;
    std::string s = str.front();
    str.pop_front();
    TE val;
    istrstream istr( s.c_str() );
    if( ! (istr >> val) ) return false;
    else {
        isSet = true;
        *ptr.push_back(vak);
        return true;
    }
}
*/

template<> inline 
bool Argument< std::vector< std::string > >::read( std::list<std::string>& str)
{
    if (str.empty()) return false;
    std::string s = str.front();
    str.pop_front();
    isSet = true;
    ptr->push_back(s);
    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 << " ";
}

template<> inline
void Argument<std::vector<std::string > >::printValue() const {
    for (unsigned int i=0;i<ptr->size();i++)
        std::cout << (*ptr)[i] << " ";
}


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

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;
    
    std::vector<std::string>* files;
    
    // help stuff
    string globalHelp;    
    char helpShortName;   
    string helpLongName;  

public:

    ArgumentParser( const string& helpstr="", char hlpShrt='h', const string& hlpLng="help" );

    ArgumentParser( std::vector<std::string>* files, const string& helpstr="", char hlpShrt='h', const string& hlpLng="help" );

    ~ArgumentParser();
    
    template<class T> inline 
    ArgumentParser& option( T* ptr, char sho, const char* lon, const 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, const char* lon, const 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);
    }

    void operator () ( int argc, char** argv );

    void operator () ( std::list<std::string> str );

};

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

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

} // namespace helper

} // namespace sofa

#endif