/scr/tee1/isis/lib/Core/CoreUtils/progparameter.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2010  reimer@cbs.mpg.de

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef PROGPARAMETER_HPP
#define PROGPARAMETER_HPP

#include "property.hpp"
#include <string>
#include <map>

namespace isis
{
namespace util
{
class ProgParameter: public PropertyValue
{
    std::string m_description;
    bool m_hidden, m_set;
public:
    ProgParameter();
    template<typename T> ProgParameter( const T &ref, bool is_needed = true ): PropertyValue( ref, is_needed ), m_hidden( false ), m_set( false ) {}
    bool parse( const isis::util::Value< std::string >& props );
    bool parse_list( const isis::util::Value< util::slist >& props_list );
    const std::string &description()const;
    /* set the description string
    *  \param desc description to be set */
    void setDescription( const std::string &desc );
    template<typename T> operator const T()const {
        LOG_IF( isEmpty(), isis::CoreDebug, isis::error ) << "Program parameters must not be empty. Please set it to any value.";
        return get()->castTo<T>();
    }


    operator boost::scoped_ptr<ValueBase>::unspecified_bool_type()const;// implicit conversion to "bool" stolen from boost

    bool isSet()const;

    bool isHidden()const;

    bool &hidden();
};

class ParameterMap: public std::map<std::string, ProgParameter>
{
    struct neededP {
        bool operator()( const_reference ref )const {return ref.second.isNeeded();}
    };
    struct notneededP {
        bool operator()( const_reference ref )const {return !ref.second.isNeeded();}
    };
    struct hiddenP {
        bool operator()( const_reference ref )const {return ref.second.isHidden();}
    };
    template<class T> void printWithout() {
        std::map<key_type, mapped_type, key_compare> result( *this );

        for (
            iterator found = std::find_if( result.begin(), result.end(), T() );
            found != result.end();
            found = std::find_if( found, result.end(), hiddenP() )
        )
            result.erase( found++ );

        std::cout << result << std::endl;
    }
    bool parsed;
public:
    const ProgParameter operator[]( const std::string key )const;
    ProgParameter &operator[]( const std::string key );
    /*
     * Default constructor to create an empty parameter map
     */
    ParameterMap();
    bool parse( int argc, char **argv );

    bool isComplete()const;
};

}
}

namespace std
{
template<typename charT, typename traits> basic_ostream<charT, traits>&
operator<<( basic_ostream<charT, traits> &out, const isis::util::ProgParameter &s )
{
    const std::string &desc = s.description();

    if ( ! desc.empty() ) {
        out << desc << ", ";
    }

    LOG_IF( s.isEmpty(), isis::CoreDebug, isis::error ) << "Program parameters must not be empty. Please set it to any value.";
    assert( !s.isEmpty() );
    out << "default=\"" << s.toString( false ) << "\", type=" << s.getTypeName();

    if ( s.isNeeded() )out << " (needed)";

    return out;
}
}
#endif // PROGPARAMETER_HPP