MapTools.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_MAP_TOOLS_H
#define DRAIN_MAP_TOOLS_H
 
#include <iostream>
#include <string>
#include <set>
#include <list>
#include <vector>
#include <map>
// #include <stdlib.h>
// #include <sys/syslog.h>
// #include <syslog.h>
 
#include "Log.h"
#include "Sprinter.h"
#include "StringTools.h"
 
 
namespace drain {
 
class MapTools {
 
public:
 
    template <class K,class V>
    static inline
    typename std::map<K,V>::const_iterator findEntryByKey(const std::map<K,V> & m, const K & key){
        return m.find(key);
    }
 
    template <class K,class V>
    static inline
    typename std::list<K,V>::const_iterator findEntryByKey(const std::list<K,V> & l, const K & key){
        for (typename std::list<K,V>::const_iterator it=l.begin(); it!=l.end(); ++it){
            if (it->first == key){
                return it;
            }
        }
        return l.end();
    }
 
    template <class M>
    static
    bool hasKey(const M & m, const typename M::key_type & key){
        typename M::const_iterator it = findEntryByKey(m, key);
        return it != m.end();
    }
 
 
 
    template <class M>
    static
    const typename M::mapped_type & get(const M & m, const typename M::key_type & key){
        typename M::const_iterator it = m.find(key);
        if (it != m.end()){
            return it->second;
        }
        else {
            static const typename M::mapped_type empty;
            return empty;
        }
    }
 
    // NEW
    template <class M>
    static
    typename M::mapped_type & get(M & m, const typename M::key_type & key){
        return m[key];
    }
 
    /*
    template <class M, class T>
    static
    const T & get(const M & m, const typename M::key_type & key, const T & defaultValue){ // todo: const char *
        typename M::const_iterator it = m.find(key);
        if (it != m.end()){
            return static_cast<T>(it->second);
        }
        else {
            return defaultValue;
            //static const typename M::mapped_type empty;
            //return empty;
        }
    }
    */
 
    // Universal (map and list compatible)
    template <class M>
    static
    const typename M::value_type::second_type & get(const M & m, const typename M::value_type::first_type & key, const typename M::value_type::second_type & defaultValue){ // todo: const char *
        typename M::const_iterator it = findEntryByKey(m, key);
        if (it != m.end()){
            return it->second;
        }
        else {
            return defaultValue;
        }
    }
 
    template <class M>
    static
    std::string get(const M & m, const typename M::key_type & key, const char * defaultValue){ // todo: const char *
        typename M::const_iterator it = m.find(key);
        if (it != m.end()){
            //return static_cast<std::string>(it->second);
            return it->second;
        }
        else {
            return defaultValue;
            //static const typename M::mapped_type empty;
            //return empty;
        }
    }
 
 
 
    typedef std::list<std::string> keylist_t;
 
 
 
 
    template <class M,class V,bool STRICT=true>
    static
    void setValue(M & dst, const std::string & key, const V & value) {
        if (STRICT){
            dst[key] = value;  // throws exception in derived classes!
        }
        else {
            //typename std::map<std::string,T>::iterator it = dst.find(key);
            typename M::iterator it = dst.find(key);
            if (it != dst.end()){
                it->second = value;
            }
            else {
                //std::cerr << __FILE__ << ':' << __FUNCTION__ << ": key '" << key << "' not found\n";
            }
        }
    }
 
    template <class M,class V>
    static inline
    void setValue(M & dst, const std::string & key, const V & value, bool STRICT) {
        if (STRICT)
            setValue<M,V,true>(dst, key, value);
        else
            setValue<M,V,false>(dst, key, value);
    }
 
 
 
    template <class M,class V>
    static inline
    void updateValue(M & dst, const std::string & key, const V & value) {
        setValue<M,V,false>(dst, key, value);
    }
 
 
    template <class M,class S,bool STRICT=true>
    static
    void setValues(M & dst, const std::map<std::string,S> & srcMap) {
        // std::cerr << __FUNCTION__ << ':' << typeid(M).name() << " <= map<str," << typeid(S).name() << ">\n";
        for (const typename std::map<std::string,S>::value_type & entry: srcMap){
            setValue<M,S,STRICT>(dst, entry.first, entry.second);
        }
    }
 
 
 
 
    template <class M,class S>
    static inline
    void updateValues(M & dst, const std::map<std::string,S> & src) {
         setValues<M,S,false>(dst, src);
    }
 
 
 
    template <class M, bool STRICT=true>
    static
    void setValues(M & dst, const std::list<std::string> & values, char equalSign='=', const std::string & trimChars = "") {
 
        const bool TRIM = !trimChars.empty();
 
        for (const std::string & entry: values){
 
            if (entry.empty()){
 
                Logger mout(__FILE__, __FUNCTION__);
                if (values.size()==1){
                    //std::cerr << __FILE__ << ':' << __
                    mout.experimental("clearing a map of ",  dst.size(), " elements");
                    dst.clear();
                    return;
                }
                else {
                    mout.debug("parameter list contained an empty value (ok)");
                    continue;
                }
 
            }
 
            const size_t i = entry.find(equalSign);
            if (i != std::string::npos){
                if (i == (entry.length()-1)){
                    if (TRIM){
                        setValue<M,std::string,STRICT>(dst, StringTools::trim(entry, trimChars), ""); // todo: touch
                    }
                    else {
                        setValue<M,std::string,STRICT>(dst, entry, ""); // todo: touch
                    }
                }
                else {
                    if (TRIM){
                        setValue<M,std::string,STRICT>(dst, StringTools::trim(entry.substr(0, i)), StringTools::trim(entry.substr(i+1)));
                    }
                    else {
                        setValue<M,std::string,STRICT>(dst, entry.substr(0, i), entry.substr(i+1));
                    }
                }
            }
            else {
                for (const std::string & e: values){
                    std::cerr << '"' << e << '"' << std::endl;
                }
                // TODO: warn dump
                throw std::runtime_error(entry + ": positional args without keys");
            }
        }
    }
 
 
 
 
    template <class M>
    static inline
    void updateValues(M & dst, const std::list<std::string> & values, char equals='=') {
        setValues<M,false>(dst, values, equals);
    }
 
 
    // Potential for allowed-keys-only policy (hidden/read-only entries)
    template <class M, bool STRICT=true>
    static
    void setValues(M & dst, const std::list<std::string> & keys, const std::list<std::string> & entries, char assignmentChar='=') {
 
        Logger mout(__FILE__, __FUNCTION__);
 
 
        // 2026: use char in split2
        //const std::string assignmentSymbols(1, assignmentSymbol);
 
        std::list<std::string>::const_iterator kit = keys.begin();
 
        bool acceptOrderedParams = true;
 
        // mout.warn(" assignmentSymbol: " ,  assignmentSymbol );
        // mout.warn(" size: " ,  this->size() );
        for (const std::string & entry: entries){
 
            //for (std::list<std::string>::const_iterator pit = p.begin(); pit != p.end(); ++pit){
            //mout.warn(" entry: " , *pit );
 
            // Check specific assignment, ie. check if the key=value is given explicitly.
            if (assignmentChar){ // typically '='
 
                std::string key, value;
 
                //if (StringTools::split2(entry, key, value, assignmentSymbols)){
                if (StringTools::split2(entry, key, value, assignmentChar)){
 
                    // mout.warn(" specified " ,  key , "=\t" , value );
 
                    if (dst.size()==1){
                        /*
                         * This special handling is for single-element maps
                         * "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs"
                         */
                        typename M::iterator it = dst.begin();
                        if (key == it->first)
                            it->second = value;
                        else {
                            it->second = entry;
                            // mout.warn("is this in use?" , it->first , " <= '" , entry , "'" );
                        }
                        return;
                    }
 
                    setValue<M,std::string,STRICT>(dst, key, value); //, criticality);
                    acceptOrderedParams = false;
                    continue;
                }
                else {
                    // mout.warn(" could not split: " , *pit );
                }
            }
 
            // Key and assignment symbol not given.
 
            if (kit != keys.end()){
                // Assignment-by-order
                if (!acceptOrderedParams){
                    mout.warn("positional arg '" , entry , "' for [", *kit , "] given after explicit args" );
                }
                //mout.warn(" ordered  " ,   );
                dst[*kit] = entry;  // does not need to call import() because *kit exists.
                ++kit; // NUEVO
            }
            else {
                //mout.log(criticality)
                // << "too many (over "<< this->size() << ") params, run out of keys with entry=" << *pit << mout.endl;
                if (STRICT){
                    mout.warn(DRAIN_LOG(sprinter(entries)));
                    mout.warn(DRAIN_LOG(sprinter(keys)));
                    mout.warn(DRAIN_LOG(sprinter(dst)));
                    mout.error("too many (over ", dst.size() , ") params, run out of keys with entry=" , entry );
                }
 
            }
 
 
        }
 
 
    }
 
    template <class M>
    static inline
    void updateValues(M & dst, const std::list<std::string> & keys, const std::list<std::string> & entries, char equals='=') {
        setValues<false>(dst, keys, entries, equals);
    }
 
 
 
    template <class M, bool STRICT=true>
    static
    void setValues(M & dst, const std::string & values, char split=',', char equals='=', const std::string & trimChars = "") {
        std::list<std::string> l;
        drain::StringTools::split(values, l, split);
        setValues<M,STRICT>(dst, l, equals, trimChars);
    }
 
    template <class M>
    static inline
    void updateValues(M & dst, const std::string & values, char split=',', char equals='=') {
        setValues<false>(dst, values, split, equals);
    }
 
 
    template <class M, bool STRICT=true>
    static
    void setValues(M & dst, const std::list<std::string> & keys, const std::string & values, char split=',', char equals='=') {
        std::list<std::string> l;
        drain::StringTools::split(values, l, split);
        setValues(dst, keys, l, equals);
    }
 
 
    template <class M>
    static inline
    void updateValues(M & dst, const std::list<std::string> & keys, const std::string & values, char split=',', char equals='=') {
        setValues<false>(dst, keys, values, split, equals);
    }
 
 
    template <class M, class V, bool STRICT=true>
    static
    void setValues(M & dst, const std::list<std::string> & keys, std::initializer_list<V> values) {
 
        std::list<std::string>::const_iterator kit = keys.begin();
 
        for (const V & value: values){
            if (kit == keys.end()){
                throw std::runtime_error(std::string(__FILE__) + " run out of keys");
            }
            setValue(dst, *kit, value);
            ++kit;
        }
    }
 
    template <class M, class V>
    static
    void setValues(M & dst, std::initializer_list<V> values) {
 
        //typename std::map<std::string,T>::const_iterator it = dst.begin();
        typename M::const_iterator it = dst.begin();
 
        for (const V & value: values){
            if (it == dst.end()){
                throw std::runtime_error(std::string(__FILE__) + " run out of keys");
            }
            setValue(dst, it->first, value);
            ++it;
        }
    }
 
    // Designed for: const std::initializer_list<std::pair<const char *,const char *> >
    template <class M, typename K, typename V>
    static
    void setValues(M & dst, std::initializer_list<std::pair<K,V> > values) {
        for (const auto & entry: values){
            setValue(dst, entry.first, entry.second);
        }
    }
 
 
    /*
    template <class T, class T2>
    static inline
    void updateValues(std::map<std::string,T> & dst, const std::list<std::string> & keys, std::initializer_list<T2> values) {
        setValues<false>(dst, keys, values);
    }
    */
 
 
};
 
 
 
 
} // drain
 
 
#endif // Drain