EnumUtils.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
 
#ifndef DRAIN_ENUM_UTILS
#define DRAIN_ENUM_UTILS
 
#include "Dictionary.h"
#include "Flags.h"
 
namespace drain {
 
 
 
 
template <class E, class OWNER=E>
struct EnumDict {
 
    //typedef FlagResolver::dict_t dict_t;
    typedef drain::Dictionary<std::string,E> dict_t;
 
    static
    const dict_t dict;
 
    static
    const dict_t & getDict(){
        return dict;
    }
 
 
 
    static inline
    const std::string & str(const E & value){
        return dict.getKey(value);
    }
 
 
 
    static
    bool setValue(const std::string & key, E & value){  // NOTE:  could be more general, without explicit template
        if (drain::EnumDict<E>::dict.hasKey(key)){
            value = drain::EnumDict<E>::dict.getValue(key);
            return true; // assigned
        }
        else {
            return false; // not found
        }
    }
 
 
 
    static inline
    E getValue(const E & value, bool lenient=true){
        return value;
    }
 
 
    static inline
    E getValue(const std::string &key, bool lenient=true){
        return dict.getValue(key, lenient);
    }
 
 
    static inline
    E getValue(const char *key, bool lenient=true){
        return dict.getValue(key, lenient);
    }
 
    /*
    static inline
    E getValue(char * const key, bool lenient=true){
        return dict.getValue(key, lenient);
    }
    */
 
 
 
    static inline // TODO: remove/handle misleading lenient here
    const std::string & getKey(const std::string & s, bool lenient=true){
        return s;
    }
 
    static inline // TODO: remove/handle misleading lenient here
    const char * getKey(const char * s, bool lenient=true){
        return s;
    }
 
    static inline // TODO: remove/handle misleading lenient here
    const std::string & getKey(const E & value, bool lenient=true){
        return dict.getKey(value, lenient);
    }
 
    /*
    static inline
    const std::string & getKey(const char *value, bool lenient=true){
        //return dict.getKey(std::string(value), lenient);
        return dict.getKey(std::string(value), lenient);
    }
    */
 
 
};
 
template <typename E, bool STRICT=true>
class EnumWrapper : public std::string { // StringWrapper<E> {
 
public:
 
    inline
    EnumWrapper(const std::string & s=""){ //  : std::string(s){
        set(s);
    };
 
    inline
    EnumWrapper(const E & x){
        set(x);
    };
 
    template <typename T>
    void set(const T & value){
        // handle empty with default enum value?
        assign(drain::EnumDict<E>::dict.getKey(value, !STRICT));
    }
 
    /*
    virtual inline
    void setSpecial(const E & x) override {
        assign(drain::EnumDict<E>::dict.getKey(x, !STRICT));
    };
    */
 
};
 
class MultiEnumWrapper : public std::string { // StringWrapper<E> {
 
public:
 
    inline
    MultiEnumWrapper(const std::string & s="") : std::string(s){
    };
 
    inline
    MultiEnumWrapper(const char *s) : std::string(s){
    };
 
    // inline
    // MultiEnumWrapper(const MultiEnumWrapper & wrapper) : std::string(wrapper){
    // };
 
    template <typename T>
    inline
    MultiEnumWrapper(const T & arg){
        set(arg);
    };
 
 
    void set(const std::string &arg){
        assign(arg);
    }
 
    void set(const char * arg){
        assign(arg);
    }
 
    void set(const MultiEnumWrapper &arg){
        assign(arg);
    }
 
    template <typename T>
    void set(const T & value){
        assign(drain::EnumDict<T>::dict.getKey(value, false));
    }
 
};
 
 
 
/* Perhaps useful!
template <class E>
class EnumKey {
 
public:
 
    inline
    EnumKey(const E & value) : key(EnumDict<E>::dict.getKey(value)){
    };
 
    inline
    operator const std::string & () const {
        return key;
    }
 
protected:
 
    const std::string & key;
};
*/
 
 
 
template <class F>  // F =SingleFlagger<E>
class EnumFlagger : public F {
 
public:
 
    typedef F fbase_t;
    typedef typename F::value_t value_t;
    typedef typename F::storage_t storage_t;
    typedef typename F::dict_t  dict_t;
    typedef FlagResolver::ivalue_t ivalue_t;
 
    inline
    EnumFlagger(): fbase_t(EnumDict<value_t>::dict){
    }
 
    inline
    EnumFlagger(const storage_t & v): fbase_t(EnumDict<value_t>::dict) {
        this->value = v;
    }
 
    /*
    inline
    EnumFlagger(value_t v): fbase_t(v) {
    }
    */
 
    template <typename ... T>
    inline
    EnumFlagger(const T & ... arg): fbase_t(EnumDict<value_t>::dict, arg...) { // designed for MultiFlagger
    }
 
    /*  // keep
    virtual void reset() override {
        this->value = EnumDict<value_t>::defaultValue; // ALERT! enums need neutral value.
    };
    */
 
 
 
    static
    ivalue_t getValueNEW(const std::string & key){
        return (ivalue_t)EnumDict<value_t>::dict.getValue(key);
    };
 
    // Raise?
    /*
    static inline
    std::string getKeysNEW2(const storage_t & value, char separator = ','){
        // currentStr = FlagResolver::getKeys(dict, this->value, this->separator);
        return FlagResolver::getKeys(EnumDict<value_t>::dict, value, separator);
    }
    */
 
    inline
    EnumFlagger<F> & operator=(const EnumFlagger<F> & flagger){
        this->set(flagger.value);
        return *this;
    }
 
    template <class T>
    inline
    EnumFlagger<F> & operator=(const T & v){
        this->set(v);
        return *this;
    }
 
};
 
 
} // drain::
 
#define DRAIN_ENUM_DICT(enumtype)        template <> const drain::EnumDict<enumtype>::dict_t drain::EnumDict<enumtype>::dict
#define DRAIN_ENUM_DICT2(enumtype,owner) template <> const drain::EnumDict<enumtype,owner>::dict_t drain::EnumDict<enumtype,owner>::dict
 
#define DRAIN_ENUM_ENTRY(nspace, key) {#key, nspace::key}
 
#define DRAIN_ENUM_OSTREAM(enumtype) inline std::ostream & operator<<(std::ostream &ostr, const enumtype & e){return ostr << drain::EnumDict<enumtype>::dict.getKey(e);}
 
 
#endif