UtilsXML.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)
 */
/*
 * UtilsXML.h
 *
 *      Author: mpeura
 */
 
#ifndef DRAIN_UTILS_XML
#define DRAIN_UTILS_XML
 
// #include "XML.h"
#include "SelectorXML.h" // Only for StyleUtils :-/
#include "TreeXML.h"
 
 
namespace drain {
 
 
class UtilsXML {
 
public:
 
 
    template <typename TX>
    static inline
    TX & setType(TX & tree, const typename TX::node_data_t::xml_tag_t & type){
        tree->setType(type);
        return tree;
    }
 
    template <typename TX, typename ...TT>
    static TX& setTypeAndID(TX &tree, const typename TX::node_data_t::xml_tag_t &type, const TT & ...args);
 
 
 
    template <typename N>
    static
    typename N::xml_tag_t retrieveDefaultType(const N & parentNode){
        typedef typename N::xml_default_elem_map_t map_t;
        const typename map_t::const_iterator it = N::xml_default_elems.find(parentNode.getNativeType());
        if (it != N::xml_default_elems.end()){
            return (it->second);
        }
        else {
            return static_cast<typename N::xml_tag_t>(0);
        }
    }
 
    template <typename T>
    static
    bool initChildWithDefaultType(const T & tree, T & child){
        typename T::node_data_t::xml_tag_t type = retrieveDefaultType(tree.data);
        if (static_cast<int>(type) != 0){
            child->setType(type);
            return true;
        }
        else {
            return false;
        }
    }
 
 
    template <typename T>
    static inline
    T & assign(T & dst, const T & src){
 
        if (&src != &dst){
            dst.clear(); // clears children...
            // ... but not copying src? (TreeUtils?)
            // also dst->clear();
            assignNode(dst.data, src); // removed - so is this polymorphic method ever used.
        }
 
        return dst;
    }
 
 
    template <typename TX>
    static inline
    TX & assign(TX & dst, const typename TX::xml_node_t & src){
        assignNode(dst.data, src);
        return dst;
    }
 
 
 
    template <typename T, typename V>
    static inline
    T & assign(T & tree, const V & arg){
        tree->set(arg);
        return tree;
    }
 
 
    template <typename T>
    static
    //T & assign(T & tree, std::initializer_list<std::pair<const char *,const char *> > l){
    T & assign(T & tree, std::initializer_list<std::pair<const char *,const Variable> > l){
 
        //switch (static_cast<intval_t>(tree->getType())){
        switch (tree->getType()){
        case XML::STYLE:
            for (const auto & entry: l){
                T & elem = tree[entry.first];
                elem->setType(XML::STYLE_SELECT);
                drain::MapTools::setValues(elem->getAttributes(), entry.second, ';', ':', std::string(" \t\n"));
            }
            break;
        case XML::UNDEFINED:
            tree->setType(XML::STYLE_SELECT);
            // no break  TODO: CHECK
        case XML::STYLE_SELECT:
            // no break  TODO: CHECK
        default:
            tree->set(l);
            break;
        }
 
        return tree;
    }
 
    // UNDER CONSTRUCTION!
 
    template <typename TX>
    static inline  // NOT YET as template specification of assign(...)
    TX & assignString(TX & tree, const std::string & s){
        if (tree->isUndefined()){
            tree->setType(XML::CTEXT);
        }
        tree->ctext = s;
        return tree;
    }
 
    template <typename TX>
    static inline  // NOT YET as template specification of assign(...)
    TX & appendString(TX & tree, const std::string & s){
        if (tree->isCText()){
            tree->ctext += s;
            return tree;
        }
        else if (tree->isUndefined()){
            tree->setType(XML::CTEXT);
            // tree->setText(s);
            tree->ctext += s;
            return tree;
        }
        else {
            // drain::Logger(__FILE__, __FUNCTION__).error("Assign string...");
            TX & child = tree.addChild();
            child->setType(XML::CTEXT);
            child->setText(s);
            return child;
        }
    }
 
 
    template <typename N>
    static
    DRAIN_XML_TREE(N) & getHeaderObject(DRAIN_XML_TREE(N) & root, typename N::xml_tag_t tag,
            const typename DRAIN_XML_TREE(N)::path_elem_t & key = typename DRAIN_XML_TREE(N)::path_elem_t()){
 
        const typename DRAIN_XML_TREE(N)::path_elem_t & finalKey = !key.empty() ? key : Enum<typename N::xml_tag_t>::getKey(tag);
 
        if (!root.hasChild(finalKey)){
            DRAIN_XML_TREE(N) & child = root.prependChild(finalKey); // consider path type! getDefaultObject
            child->setType(tag);
            return child;
        }
        else {
            return root[finalKey];
        }
    }
 
    template <typename N>
    static
    DRAIN_XML_TREE(N) & appendHeaderObject(DRAIN_XML_TREE(N) & root, typename N::xml_tag_t tag,
            const typename DRAIN_XML_TREE(N)::path_elem_t & key = typename DRAIN_XML_TREE(N)::path_elem_t()){
 
        const typename DRAIN_XML_TREE(N)::path_elem_t & finalKey = !key.empty() ? key : Enum<typename N::xml_tag_t>::getKey(tag);
 
        if (!root.hasChild(finalKey)){
            DRAIN_XML_TREE(N) & child = root.add(finalKey); // consider path type! getDefaultObject
            child->setType(tag);
            return child;
        }
        else {
            return root[finalKey];
        }
    }
 
    /*
    template <typename T>
    static
    T & getHeaderObject(T & root, typename T::node_data_t::xml_tag_t tag, const typename T::path_elem_t & key = typename T::path_elem_t()){
 
        const typename T::path_elem_t & finalKey = !key.empty() ? key : Enum<typename T::node_data_t::xml_tag_t>::getKey(tag);
 
        if (!root.hasChild(finalKey)){
            T & child = root.prependChild(finalKey); // consider path type! getDefaultObject
            child->setType(tag);
            return child;
        }
        else {
            return root[finalKey];
        }
    };
 
    template <typename T>
    static
    T & appendHeaderObject(T & root, typename T::node_data_t::xml_tag_t tag, const typename T::path_elem_t & key = typename T::path_elem_t()){
 
        const typename T::path_elem_t & finalKey = !key.empty() ? key : Enum<typename T::node_data_t::xml_tag_t>::getKey(tag);
 
        if (!root.hasChild(finalKey)){
            T & child = root.add(finalKey); // consider path type! getDefaultObject
            child->setType(tag);
            return child;
        }
        else {
            return root[finalKey];
        }
    };
    */
 
 
    template <typename T>
    static inline
    T & ensureStyleElem(T & elem){
        if (elem->typeIs(T::node_data_t::xml_tag_t::STYLE)){
            return elem;
        }
        else {
            return getHeaderObject(elem, T::node_data_t::xml_tag_t::STYLE);
        }
    }
 
    // Needed?
    /*s
    template <typename T>
    static
    T & ensureStyle(T & elem, const std::string & cls, const std::initializer_list<std::pair<const char *,const Variable> > & styleDef){
 
        //T & style = getHeaderObject(elem, T::node_data_t::xml_tag_t::STYLE);
        T & style = ensureStyleElem(elem);
 
        T & styleEntry = style[cls];
        if (styleEntry.empty()){
            styleEntry = styleDef;
            // styleEntry->setStyle(styleDef); WRONG (did not work)
        }
        return styleEntry;
    }
    */
 
    template <typename T, typename S>
    static
    T & ensureStyle(T & elem, const S & selector, const std::initializer_list<std::pair<const char *,const Variable> > & styleDef){
    //T & ensureStyle(T & elem, const typename T::path_elem_t & selector, const std::initializer_list<std::pair<const char *,const Variable> > & styleDef){
        //T & style = getHeaderObject(elem, T::node_data_t::xml_tag_t::STYLE);
        T & style = ensureStyleElem(elem);
 
        T & styleEntry = style[SelectXML<typename T::node_data_t::xml_tag_t>(selector)];
        if (styleEntry.empty()){
            styleEntry = styleDef;
            // styleEntry->setStyle(styleDef); WRONG (did not work)
        }
        return styleEntry;
    }
 
    // See StringTools::getSafeKey void getSafeVariableName();
 
 
 
};
 
template<typename TX, typename ...TT>
inline
TX& UtilsXML::setTypeAndID(TX &tree, const typename TX::node_data_t::xml_tag_t &type, const TT & ...args) {
    tree->setType(type);
    tree->setId(type, drain::StringBuilder<'_'>(TX::node_data_t::getCount(), args...));
    return tree;
}
 
 
#define DRAIN_XML_DEFAULT_INIT(xml_tree) template <> inline void xml_tree::initChild(xml_tree & child) const { UtilsXML::initChildWithDefaultType(*this, child); }
 
 
#define DRAIN_XML_EASY_TYPE(xml_tree) template <> template <> inline xml_tree & xml_tree::operator()(const xml_tree::node_data_t::tag_t & type){ return UtilsXML::setType(*this, type); }
 
 
}  // drain::
 
#endif /* DRAIN_XML */