param_map.h

Go to the documentation of this file.

// -*-c++-*-
 
/*
 *Copyright:
 
 Copyright (C) Hidehisa AKIYAMA
 
 This code 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 3 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 *EndCopyright:
 */
 
 
#ifndef RCSC_PARAM_PARAM_MAP_H
#define RCSC_PARAM_PARAM_MAP_H
 
#include <boost/lexical_cast.hpp>
 
#include <memory>
#include <vector>
#include <map>
#include <string>
#include <iostream>
#include <cassert>
 
namespace rcsc {
 
struct NegateBool {
    bool * ptr_; 
 
    explicit
    NegateBool( bool * ptr )
        : ptr_( ptr )
      {
          assert( ptr );
      }
 
private:
    // not used
    NegateBool() = delete;
};
 
struct BoolSwitch {
    bool * ptr_; 
 
    explicit
    BoolSwitch( bool * ptr )
        : ptr_( ptr )
      {
          assert( ptr );
      }
 
private:
    // not used
    BoolSwitch() = delete;
};
 
 
struct NegateSwitch {
    bool * ptr_; 
 
    explicit
    NegateSwitch( bool * ptr )
        : ptr_( ptr )
      {
          assert( ptr );
      }
 
    explicit
    NegateSwitch( const BoolSwitch & value )
        : ptr_( value.ptr_ )
      {
          assert( ptr_ );
      }
 
private:
    // not used
    NegateSwitch() = delete;
};
 
/*-------------------------------------------------------------------*/
class ParamEntity {
public:
 
    typedef std::shared_ptr< ParamEntity > Ptr;
 
private:
    std::string M_long_name;
    std::string M_short_name;
    std::string M_description;
 
    ParamEntity() = delete;
 
protected:
 
    ParamEntity( const std::string & long_name,
                const std::string & short_name,
                const char * description = "" )
        : M_long_name( long_name ),
          M_short_name( short_name ),
          M_description( description )
      { }
 
public:
 
    virtual
    ~ParamEntity()
      { }
 
    const std::string & longName() const
      {
          return M_long_name;
      }
 
    const std::string & shortName() const
      {
          return M_short_name;
      }
    const std::string & description() const
      {
          return M_description;
      }
 
    std::string helpName() const;
 
    virtual
    bool isSwitch() const
      {
          return false;
      }
 
    virtual
    bool analyze( const std::string & value_str ) = 0;
 
    virtual
    std::ostream & printFormat( std::ostream & os ) const;
 
    virtual
    std::ostream & printValue( std::ostream & os ) const = 0;
 
};
 
/*-------------------------------------------------------------------*/
template < typename ValueType >
class ParamGeneric
    : public ParamEntity {
public:
    typedef ValueType Type; 
 
private:
    Type * M_value_ptr;
 
public:
 
    ParamGeneric( const std::string & long_name,
                  const std::string & short_name,
                  Type * value_ptr,
                  const char * description = "" )
        : ParamEntity( long_name, short_name, description ),
          M_value_ptr( value_ptr )
      {
          assert( value_ptr );
      }
 
    bool analyze( const std::string & value_str )
      {
          try
          {
              *M_value_ptr = boost::lexical_cast< Type >( value_str );
              return true;
          }
          catch ( boost::bad_lexical_cast & e )
          {
              std::cerr << e.what() << "  [" << value_str << "]"
                        << std::endl;
              return false;
          }
      }
 
private:
 
    template < typename T >
    std::ostream & printValueImpl( std::ostream & os,
                                   const T & value ) const
      {
          os << value;
          return os;
      }
 
    std::ostream & printValueImpl( std::ostream & os,
                                   const std::string & value ) const
      {
          os << '"' << value << '"';
          return os;
      }
 
public:
    std::ostream & printValue( std::ostream & os ) const
      {
          return printValueImpl( os, *M_value_ptr );
      }
 
};
 
/*-------------------------------------------------------------------*/
template <>
class ParamGeneric< bool >
    : public ParamEntity {
private:
    const bool M_negate;
 
    bool * M_value_ptr;
 
public:
 
    ParamGeneric( const std::string & long_name,
                  const std::string & short_name,
                  bool * value_ptr,
                  const char * description = "" )
        : ParamEntity( long_name, short_name, description ),
          M_negate( false ),
          M_value_ptr( value_ptr )
      {
          assert( value_ptr );
      }
 
    ParamGeneric( const std::string & long_name,
                  const std::string & short_name,
                  const NegateBool & value,
                  const char * description = "" )
        : ParamEntity( long_name, short_name, description ),
          M_negate( true ),
          M_value_ptr( value.ptr_ )
      {
          assert( M_value_ptr );
      }
 
    bool analyze( const std::string & value_str );
 
    std::ostream & printValue( std::ostream & os ) const;
 
};
 
/*-------------------------------------------------------------------*/
class ParamSwitch
    : public ParamEntity {
private:
    const bool M_negate;
 
    bool * M_value_ptr;
 
public:
 
    ParamSwitch( const std::string & long_name,
                 const std::string & short_name,
                 bool * value_ptr,
                 const char * description = "" )
        : ParamEntity( long_name, short_name, description ),
          M_negate( false ),
          M_value_ptr( value_ptr )
      {
          assert( value_ptr );
      }
 
 
    ParamSwitch( const std::string & long_name,
                 const std::string & short_name,
                 const NegateSwitch & value,
                 const char * description = "" )
        : ParamEntity( long_name, short_name, description ),
          M_negate( true ),
          M_value_ptr( value.ptr_ )
      {
          assert( M_value_ptr );
      }
 
    virtual
    bool isSwitch() const
      {
          return true;
      }
 
    bool analyze( const std::string & value_str );
 
    std::ostream & printFormat( std::ostream & os ) const;
 
    std::ostream & printValue( std::ostream & os ) const;
 
};
 
 
/*-------------------------------------------------------------------*/
class ParamMap {
private:
 
    class Registrar {
    private:
        ParamMap & M_param_map;
        Registrar() = delete;
    public:
        explicit
        Registrar( ParamMap & pmap )
            : M_param_map( pmap )
          { }
 
        template < typename ValueType >
        Registrar & operator()( const std::string & long_name,
                                const std::string & short_name,
                                ValueType * value_ptr,
                                const char * description = "" )
          {
              if ( ! checkName( long_name, short_name ) )
              {
                  M_param_map.M_valid = false;
                  return *this;
              }
 
              if ( ! value_ptr )
              {
                  std::cerr << "***ERROR*** detected null pointer for the option "
                            << long_name << std::endl;
                  M_param_map.M_valid = false;
                  return *this;
              }
 
              ParamEntity::Ptr ptr( new ParamGeneric< ValueType >( long_name,
                                                                   short_name,
                                                                   value_ptr,
                                                                   description ) );
              M_param_map.add( ptr );
              return *this;
          }
 
        Registrar & operator()( const std::string & long_name,
                                const std::string & short_name,
                                const NegateBool & value,
                                const char * description = "" );
 
        Registrar & operator()( const std::string & long_name,
                                const std::string & short_name,
                                const BoolSwitch & value,
                                const char * description = "" );
 
        Registrar & operator()( const std::string & long_name,
                                const std::string & short_name,
                                const NegateSwitch & value,
                                const char * description = "" );
 
    private:
 
        bool checkName( const std::string & long_nam,
                        const std::string & short_name ) const;
    };
 
    bool M_valid;
 
    Registrar M_registrar;
 
    std::string M_group_name;
 
    std::vector< ParamEntity::Ptr > M_parameters;
 
    std::map< std::string, ParamEntity::Ptr > M_long_name_map;
 
    std::map< std::string, ParamEntity::Ptr > M_short_name_map;
 
 
    // no copyable
    ParamMap( const ParamMap & );
    ParamMap & operator=( const ParamMap & );
 
public:
 
    ParamMap()
        : M_valid( true ),
          M_registrar( *this )
      { }
 
    explicit
    ParamMap( const std::string & group_name )
        : M_valid( true ),
          M_registrar( *this ),
          M_group_name( group_name )
      { }
 
    ~ParamMap()
      { }
 
    bool isValid() const
      {
          return M_valid;
      }
 
    const std::string & groupName() const
      {
          return M_group_name;
      }
 
    const std::vector< ParamEntity::Ptr > & parameters() const
      {
          return M_parameters;
      }
 
    const std::map< std::string, ParamEntity::Ptr > & longNameMap() const
      {
          return M_long_name_map;
      }
 
    const std::map< std::string, ParamEntity::Ptr > & shortNameMap() const
      {
          return M_short_name_map;
      }
 
    Registrar & add()
      {
          return M_registrar;
      }
 
    Registrar & add( ParamEntity::Ptr param );
 
    void remove( const std::string & long_name );
 
    ParamEntity::Ptr findLongName( const std::string & long_name );
 
    ParamEntity::Ptr findShortName( const std::string & short_name );
 
    std::ostream & printHelp( std::ostream & os,
                              const bool with_default = true ) const;
 
    std::ostream & printValues( std::ostream & os ) const;
};
 
}
 
#endif