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
 *
 *  Created on: Jun 24, 2012
 *      Author: mpeura
 */
 
 
 
#ifndef DRAIN_UTILS_XML
#define DRAIN_UTILS_XML
 
#include <ostream>
 
#include <drain/Sprinter.h>
// #include <drain/FlexibleVariable.h>
 
// #include "ClassXML.h"
 
namespace drain {
 
 
class UtilsXML {
 
public:
 
    typedef drain::Path<std::string,'/'> path_t; // consider xml_path_t
    typedef path_t::elem_t path_elem_t;
 
    typedef std::list<path_t> path_list_t;
 
 
    //   This could also be in TreeXMLutilities
    template <class V>
    static
    bool findById(const V & tree, const std::string & tag, typename V::path_t & result, const typename V::path_t & path = path_t());
 
 
    //   This could also be in TreeXMLutilities
    template <class T>
    static
    bool findById(const T & tree, const std::string & tag, path_list_t & result, const path_t & path = path_t());
 
    template <class T, class E>
    static
    bool findByTag(const T & tree, const E & tag, path_list_t & result, const path_t & path = path_t());
 
    //   This could also be in TreeXMLutilities
    template <class T, class E>
    static
    bool findByTags(const T & tree, const std::set<E> & tags, path_list_t & result, const path_t & path = path_t());
 
 
    template <class T, class C>
    static
    bool findByClass(const T & t, const C & cls, std::list<typename T::path_elem_t> & result);
 
 
    //template <class V, class E>
    template <class T, class C>
    static inline
    bool findByClass(const T & t, const C & cls, path_list_t & result, const path_t & path = path_t());
 
 
    /*
    template <class TR>
    static
    std::ostream & toStream(std::ostream & ostr, const TR & tree, const std::string & defaultTag="unnamed", int indent=0);
    */
 
};
 
 
template <class T>
bool UtilsXML::findById(const T & t, const std::string & id, typename T::path_t & result, const typename T::path_t & path){
 
    if (t->id == id){
        result = path;
        return true;
    }
 
    // Recursion
    for (const auto & entry: t){
        if (findById(entry.second, id, result, path_t(path, entry.first))){
            return true;
        }
    }
 
    return false;
    //return !result.empty();
}
 
 
 
template <class T>
bool UtilsXML::findById(const T & t, const std::string & id, UtilsXML::path_list_t & result, const path_t & path){
 
    if (t->id == id){
        result.push_back(path);
    }
 
    for (const auto & entry: t){
        findById(entry.second, id, result, path_t(path, entry.first));
    }
 
    return !result.empty();
}
 
//template <class N>
template <class T, class N>
bool UtilsXML::findByTag(const T & t, const N & tag, UtilsXML::path_list_t & result, const path_t & path){
 
    // const T & t = tree(path);
 
    if (t->typeIs(tag)){
        result.push_back(path);
    }
 
    for (const auto & entry: t){
        findByTag(entry.second, tag, result, path_t(path, entry.first));
    }
 
    return !result.empty();
 
}
 
template <class T,class N>
bool UtilsXML::findByTags(const T & t, const std::set<N> & tags, UtilsXML::path_list_t & result, const UtilsXML::path_t & path){
 
    // const T & t = tree(path);
 
    //if (t->typeIs(tag)){
    if (tags.count(t->getType()) > 0){
        result.push_back(path);
    }
 
    for (const auto & entry: t){
        findByTags(entry.second, tags, result, path_t(path, entry.first));
    }
 
    //return result;
    return !result.empty();
}
 
 
 
template <class T, class C>
bool UtilsXML::findByClass(const T & t, const C & cls, UtilsXML::path_list_t & result, const UtilsXML::path_t & path){
 
    // drain::Logger mout(__FILE__,__FUNCTION__);
 
    if (t->classList.has(cls)){
        result.push_back(path);
    }
 
    for (const auto & entry: t){
        // mout.warn(t->get("name", "<name>"), "... continuing to: ", path_t(path, entry.first));
        findByClass(entry.second, cls, result, path_t(path, entry.first));
    }
 
    return !result.empty();
}
 
template <class T, class C>
bool UtilsXML::findByClass(const T & t, const C & cls, std::list<typename T::path_elem_t> & result){
 
    for (const auto & entry: t){
        if (entry.second->hasClass(cls)){
            result.push_back(entry.first);
        }
    }
 
    return !result.empty();
}
 
/*
template <class TR>
std::ostream & UtilsXML::toStream(std::ostream & ostr, const TR & tree, const std::string & defaultTag, int indent){
 
    // TODO: delegate to XML node start/end function, maybe xmlNodeToStream ?
 
    const typename TR::container_t & children = tree.getChildren();
 
    // const XML & data = tree.data; // template type forcing
    const typename TR::node_data_t & data = tree.data;
 
    tag_display_mode mode = EMPTY_TAG;
 
    if (data.isCText()){ // this can be true only at root, and rarely so...?
        data.nodeToStream(ostr, mode);
        ostr << "<!--TX-->";
        return ostr;
    }
 
    if (!tree->ctext.empty()){
        drain::Logger mout(__FILE__, __FUNCTION__);
        mout.warn("Non-CTEXT-elem with ctext: <", tree->getTag(), " id='", tree->getId(), "' ...>, text='", tree->ctext, "'");
    }
 
    if (!children.empty()){
        mode = OPENING_TAG;
    }
 
    if (tree->isExplicit()){ // explicit
        mode = OPENING_TAG;
    }
 
    if (tree->isSingular()){ // <br/> <hr/>
        mode = EMPTY_TAG;
    }
 
 
    // Indent
    //std::fill_n(std::ostream_iterator<char>(ostr), 2*indent, ' ');
    std::string fill(2*indent, ' ');
    ostr << fill;
    tree->nodeToStream(ostr, mode);
 
    if (mode == EMPTY_TAG){
        ostr << "<!--ET-->";
        ostr << '\n';
        return ostr;
    }
    else if (tree->isStyle()){
        // https://www.w3.org/TR/xml/#sec-cdata-sect
        // ostr << "<![CDATA[ \n";
 
        if (!tree->ctext.empty()){
            // TODO: indent
            ostr << fill << tree->ctext << " /" << "* CTEXT? *" << "/" << '\n';
        }
 
        if (!tree->getAttributes().empty()){
            drain::Logger mout(__FILE__,__FUNCTION__);
            mout.warn("STYLE elem ", tree->getId()," contains attributes, probably meant as style: ", sprinter(tree->getAttributes()));
            ostr << "\n\t /" << "* <!-- DISCARDED attribs ";
            Sprinter::toStream(ostr, tree->getAttributes()); //, StyleXML::styleRecordLayout
            ostr << " /--> *" << "/" << '\n';
        }
 
        if (!tree->style.empty()){
            ostr << fill << "/ ** style obj ** /" << '\n';
            for (const auto & attr: tree->style){
                ostr << fill << "  ";
                Sprinter::pairToStream(ostr, attr, StyleXML::styleRecordLayout); // {" :;"}
                //attr.first << ':' attr.first << ':';
                ostr << '\n';
            }
            // ostr << fill << "}\n";
            // Sprinter::sequenceToStream(ostr, entry.second->getAttributes(), StyleXML::styleRecordLayoutActual);
            // ostr << '\n';
        }
 
        ostr << '\n';
        // ostr << fill << "<!-- elems /-->" << '\n';
        ostr << fill << "/ * elems * /" << '\n';
        for (const auto & entry: tree.getChildren()){
            if (!entry.second->ctext.empty()){
                //ostr << fill << "<!-- elem("<< entry.first << ") ctext /-->" << '\n';
                ostr << fill << "  " << entry.first << " {" << entry.second->ctext << "} / * CTEXT  * / \n";
            }
            if (!entry.second->getAttributes().empty()){
                //ostr << fill << "<!-- elem("<< entry.first << ") attribs /-->" << '\n';
                ostr << fill << "  " << entry.first << " {\n";
                for (const auto & attr: entry.second->getAttributes()){
                    ostr << fill  << "    ";
                    ostr << attr.first << ':' << attr.second << ';';
                    ostr << '\n';
                }
                ostr << fill << "  }\n";
                ostr << '\n';
            }
        }
        ostr << "\n"; // end CTEXT
        // ostr << " ]]>\n"; // end CTEXT
        // end STYLE defs
        ostr << fill;
 
    }
    else {
 
        // Detect if all the children are of type CTEXT, to be rendered in a single line.
        // Note: potential re-parsing will probably detect them as a single CTEXT element.
        bool ALL_CTEXT = !children.empty();
 
        for (const auto & entry: children){
            if (!entry.second->isCText()){
                ALL_CTEXT = false;
                break;
            }
        }
 
        if (ALL_CTEXT){
            ostr << "<!--ALL_CTEXT-->";
            char sep=0;
            for (const auto & entry: children){
                if (sep){
                    ostr << sep;
                }
                else {
                    sep = ' '; // consider global setting?
                }
                ostr << entry.second->getText();
            }
        }
        else {
            // ostr << "<!-- RECURSION -->";
            ostr << '\n';
            for (const auto & entry: children){
                toStream(ostr, entry.second, entry.first, indent+1); // Notice, no ++indent
                // "implicit" newline
            }
            ostr << fill; //  for CLOSING tag
        }
 
    }
 
 
    tree->nodeToStream(ostr, CLOSING_TAG);
    //ostr << fill;
    ostr << '\n';  // Always after closing tag!
 
    //if (tree.data.id >= 0)
    //  ostr << "<!-- " << tree.data.id << " /-->\n";
 
    return ostr;
}
*/
 
 
}  // drain::
 
#endif /* DRAIN_UTILS_XML */