VariableMap.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_VARIABLEMAP_H
#define DRAIN_VARIABLEMAP_H
 
//#include <string.h>
#include <string>
//#include <vector>
#include <map>
 
//#include "Castable.h"
//#include "CastableIterator.h"
//#include "StringTools.h"
 
/*
#include "Variable.h" // <- FlexVariable
#include "FlexibleVariable.h"
*/
 
#include <drain/Variable.h> // <- FlexVariable
#include <drain/FlexibleVariable.h>
 
#include "SmartMap.h"
 
#ifndef DRAIN_SMAP_NAME
#define DRAIN_SMAP_NAME VariableMap
#endif
 
namespace drain {
 
class VariableMap : public SmartMap<Variable> {
 
public:
 
    inline
    VariableMap(char separator = ',') : SmartMap<Variable>(separator){
    };
 
 
    inline
    VariableMap(const VariableMap & v) : SmartMap<Variable>(v.separator){
        importMap(v);
    };
 
 
    inline
    VariableMap(std::initializer_list<Variable::init_pair_t > inits) : SmartMap<Variable>(','){
        //importMap(v);
        for (const auto & entry: inits){
            (*this)[entry.first] = entry.second;
        }
    };
 
 
    inline
    VariableMap(Variable::init_pair_t & entry) : SmartMap<Variable>(','){
        (*this)[entry.first] = entry.second;
    };
 
    // TODO: CHECK: -Wdeprecated-copy fires because the copy constructor above is user-declared
    // but operator=(const VariableMap&) is not (it was tried and disabled below); the implicit
    // copy-assignment operator does a plain memberwise/base copy (via std::map's operator=,
    // copying items), whereas SmartMap's own copy constructor deliberately "does not copy items"
    // (see SmartMap.h) and this class's copy constructor instead calls importMap(v) explicitly.
    // Confirm whether copy-assignment should match the copy constructor's behavior.
    /*
    inline
    VariableMap & operator=(const VariableMap & v){
        importMap(v);
        return *this;
    }
    */
 
    template <class T>
    inline
    VariableMap & operator=(const std::map<std::string,T> & m){
        if (&m != this->getMap()){
            importMap(m); // CastableMap?
        }
        return *this;
    }
 
 
};
 
 
template <>
inline
std::ostream & Sprinter::toStream(std::ostream & ostr, const VariableMap & vmap, const SprinterLayout & layout){
 
    if (&layout == &UNSET_LAYOUT){
        return Sprinter::sequenceToStream(ostr, vmap, Sprinter::jsonLayout.mapChars, jsonLayout);
    }
    else {
        return Sprinter::sequenceToStream(ostr, vmap.getMap(), layout.mapChars, layout);
    }
 
    // return Sprinter::sequenceToStream(ostr, vmap.getMap(), layout.mapChars, layout);
    // return Sprinter::mapToStream(ostr, vmap.getMap(), layout, vmap.getKeys());
}
 
 
class FlexVariableMap : public SmartMap<FlexibleVariable> {
 
public:
 
    inline
    FlexVariableMap(char separator = '\0') : SmartMap<FlexibleVariable>(separator){
    };
 
    //Does not try to create references (links), ie does not copy pointers even if input has referencing entries.
    inline
    FlexVariableMap(const FlexVariableMap & m) : SmartMap<FlexibleVariable>(m.separator){ // vField.ordered,
        importMap(m);
    };
 
 
    inline
    FlexVariableMap(std::initializer_list<Variable::init_pair_t > inits) : SmartMap<FlexibleVariable>(','){
        for (const auto & entry: inits){
            (*this)[entry.first] = entry.second;
        }
    };
 
 
    inline
    FlexVariableMap & operator=(const FlexVariableMap & v){
        importMap(v);
        return *this;
    }
 
 
    template <class T>
    inline
    FlexVariableMap & link(const std::string &key, T & target){
        (*this)[key].link(target);
        return *this;
    }
 
    inline
    void clearVariables(){
        iterator it = this->begin();
        while (true){
            if (!it->second.isLinking()){
                iterator dit = it;
                ++it;
                this->erase(dit);
            }
            else {
                ++it;
            }
 
            if (it == this->end()){
                break;
            }
 
        };
    }
 
};
 
 
template <>
inline
std::ostream & Sprinter::toStream(std::ostream & ostr, const FlexVariableMap & vmap, const SprinterLayout & layout){
 
    if (&layout == &UNSET_LAYOUT){
        ostr << "UNSET_LAYOUT:";
        return Sprinter::sequenceToStream(ostr, vmap, Sprinter::jsonLayout.mapChars, Sprinter::jsonLayout);
    }
    else {
        return Sprinter::sequenceToStream(ostr, vmap.getMap(), layout.mapChars, layout);
    }
 
    // return Sprinter::sequenceToStream(ostr, vmap.getMap(), layout.mapChars, layout);
    // return Sprinter::mapToStream(ostr, vmap.getMap(), layout, vmap.getKeys());
}
 
 
// std::ostream &operator<<(std::ostream &ostr, const VariableMap &m);
inline
std::ostream & operator<<(std::ostream &ostr, const FlexVariableMap & vmap){
    return Sprinter::sequenceToStream(ostr, vmap.getMap(), Sprinter::jsonLayout.mapChars, Sprinter::jsonLayout);
}
 
} // drain
 
#endif /* VARIABLE_H_ */