XML.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)
 */
/*
 * TreeXML.h
 *
 *  Created on: Jun 24, 2012
 *      Author: mpeura
 */
 
 
 
#ifndef DRAIN_XML
#define DRAIN_XML
 
#include <ostream>
 
#include <drain/Sprinter.h>
#include <drain/FlexibleVariable.h>
 
#include "ClassXML.h"
// #include "UtilsXML.h"
// #include "Flags.h"
#include "ReferenceMap.h"
#include "StyleXML.h"
 
namespace drain {
 
 
 
 
class XML :  protected ReferenceMap2<FlexibleVariable> {
public:
 
    typedef int intval_t;
 
    // TODO:
    // static const intval_t flag_OPEN = 128;
    // static const intval_t flag_TEXT = 256;
    static const intval_t UNDEFINED = 0;
    static const intval_t COMMENT   = 1; // || flag_TEXT
    static const intval_t CTEXT     = 2; // || flag_TEXT
    static const intval_t SCRIPT    = 3; // || flag_EXPLICIT || flag_TEXT
    static const intval_t STYLE     = 4; // || flag_EXPLICIT
    static const intval_t STYLE_SELECT = 5;
 
    enum entity_t {
        AMPERSAND = '&',
        LESS_THAN = '<',
        EQUAL_TO  = '=',
        GREATER_THAN = '>',
        NONBREAKABLE_SPACE = ' ',
        QUOTE = '"',
        CURLY_LEFT  = '{',
        CURLY_RIGHT = '}',
        // ---
        TAB = '\t',
        NEWLINE = '\n',
        // ---
        DEGREE = 176,
    };
 
    /* Variants of entity map */
 
    static
    const std::map<char,std::string> & getKeyConversionMap();
 
    static
    const std::map<char,std::string> & getAttributeConversionMap();
 
    static
    const std::map<char,std::string> & getCTextConversionMap();
 
 
    // OLD static   const std::map<char,std::string> encodingMap;
 
    typedef ReferenceMap2<FlexibleVariable> map_t;
 
 
 
public:
 
    inline
    XML(){};
 
    inline
    XML(const XML &){
 
    };
 
    template <class T> // "final"
    void setType(const T &t){ // DANGER, without cast?
        const intval_t t2 = static_cast<intval_t>(t);
        if (type != t2){
            reset();
            type = t2; // also UNDEFINED ok here
            handleType(); // NOTE: problems, if copy constructor etc. calls setType on a base class – trying to link future members
        }
        // handleType(static_cast<T>(t)); REMOVED 2025/09
        // in derived classes, eg. drain::image::BaseGDAL
        // warning: case value ‘...’ not in enumerated type
    }
 
    // Consider this later, for user-defined (not enumerated) tag types.
    // virtual
    // void setType(const std::string & type);
 
 
    inline
    const intval_t & getType() const {
        return type;
    };
 
    inline
    bool typeIsSet() const {
        return type != UNDEFINED;
    };
 
 
    template <class T2, class ...T3>
    inline
    bool typeIs(const T2 & arg, const T3... args) const {
        if (type == static_cast<intval_t>(arg)){
            return true;
        }
        else {
            return typeIs(args...);
        }
    };
 
 
    std::string ctext;
 
    // Could be templated, behind Static?
    static int nextID;
 
    inline
    static int getCount(){
        return nextID;
    }
 
 
    inline
    bool isUndefined() const {
        return type == UNDEFINED;
    }
 
    inline
    bool isComment() const {
        return type == COMMENT;
    }
 
    inline
    bool isCText() const {
        return type == CTEXT;
    }
 
    inline
    bool isStyle() const {
        return type == STYLE;
    }
 
    inline
    bool isScript() const {
        return type == SCRIPT;
    }
 
    virtual
    bool isSingular() const;
 
    virtual
    bool isExplicit() const;
 
 
    void reset();
 
    inline
    void setId(){
        link("id", id);
    }
 
    inline
    void setId(const std::string & s){
        link("id", id = s);
    }
 
    template <char C='\0', typename ...TT>
    inline
    void setId(const TT & ...args) {
        link("id", id = drain::StringBuilder<C>(args...));
    }
 
    inline
    const std::string & getId() const {
        return id;
    }
 
 
 
    template <class ...T>
    inline
    void setComment(const T & ...args) {
        this->clear(); // what if also uncommenting needed?
        // this->clearClasses();
        type = COMMENT;
        setText(args...);
    }
 
 
    virtual // redef shows variadic args, below?
    void setText(const std::string & s);
 
    template <class ...T>
    void setText(const T & ...args) {
        setText(StringBuilder<>(args...).str()); // str() to avoid infinite loop
    }
 
    template <class ...T>
    void setTextSafe(const T & ...args) {
        std::string dst;
        StringTools::replace(StringBuilder<>(args...).str(), getCTextConversionMap(), dst); // str() to avoid infinite loop
        setText(dst);
        //setText(StringTools::replace(m, StringBuilder<>(args...).str(), ctext)); // str() to avoid infinite loop
    }
 
    virtual inline
    const std::string & getText() const {
        return ctext;
    }
 
    inline
    const std::string & getUrl(){
        return url;
    }
 
    inline
    void setUrl(const std::string & s){
        url = s;
        // ctext = s;
    }
 
    template <class ...T>
    inline
    void setName(const T & ...args){
        setAttribute("data-name", drain::StringBuilder<>(args...).str());
    }
 
    inline
    const FlexibleVariable & getName() const {
        return (*this)["data-name"];
    }
 
 
    // ---------------- Attributes ---------------
 
    virtual inline // shadows - consider virtual
    bool empty() const {
        return map_t::empty();
    }
 
    inline
    const map_t & getAttributes() const {
        return *this;
    };
 
    // Maybe controversial. Helps importing sets of variables.
    inline
    map_t & getAttributes(){
        return *this;
    };
 
    // Rename getAttribute?
    inline
    const drain::FlexibleVariable & get(const std::string & key) const {
        return (*this)[key];
    }
 
    // Rename getAttribute?
    inline
    drain::FlexibleVariable & get(const std::string & key){
        return (*this)[key];
    }
 
 
    // Rename getAttribute?
    template <class V>
    inline
    V get(const std::string & key, const V & defaultValue) const {
        return map_t::get(key, defaultValue);
    }
 
    inline
    std::string get(const std::string & key, const char * defaultValue) const {
        return map_t::get(key, defaultValue);
    }
 
    //   But otherways confusing?
    virtual inline
    void setAttribute(const std::string & key, const std::string &value){
        (*this)[key] = value;
    }
 
    //   But otherways confusing?
    virtual inline
    void setAttribute(const std::string & key, const char *value){
        (*this)[key] = value; // -> handleString()
    }
 
    template <class V>
    inline
    void setAttribute(const std::string & key, const V & value){
        (*this)[key] = value; // -> handleString()
    }
 
 
    inline
    void removeAttribute(const std::string & s){
        iterator it = this->find(s);
        if (it != this->end()){
            this->erase(it);
        }
    }
 
 
 
protected:
 
    inline
    bool typeIs() const {
        return false;
    };
 
    intval_t type = XML::UNDEFINED;
 
    // String, still easily allowing numbers through set("id", ...)
    std::string id;
    // Consider either/or
    std::string url;
 
    virtual inline
    void handleType(){}; // = 0;
 
 
public:
 
    // ------------------ Style ---------------
 
protected:
 
    StyleXML style;
 
public:
 
    inline
    const StyleXML & getStyle() const {
        return style;
    }
 
    inline
    void setStyle(const StyleXML & s){
        style.clear();
        MapTools::setValues(style, s);
    }
 
    void setStyle(const std::string & value){
        drain::Logger mout(__FILE__, __FUNCTION__);
        if (type == UNDEFINED){
            mout.reject<LOG_WARNING>("setting style for UNDEFINED elem: ", value);
            mout.unimplemented<LOG_WARNING>("future option: set type to STYLE_SELECT");
        }
        else if (type == STYLE){
            mout.reject<LOG_WARNING>("not setting style for STYLE elem: ", value); // , *this);
        }
        else {
            MapTools::setValues(style, value, ';', ':', "; \t\n"); // sep, equal, trim (also ';' ?)
        }
    }
 
    inline
    void setStyle(const char *value){
        setStyle(std::string(value));
    }
 
    inline
    void setStyle(const std::string & key, const std::string & value){
        drain::Logger mout(__FILE__, __FUNCTION__);
        if (type == UNDEFINED){
            mout.reject<LOG_WARNING>("setting style for UNDEFINED elem: ", key, '=', value);
            mout.unimplemented<LOG_WARNING>("future option: set type to STYLE_SELECT");
        }
        else if (type == STYLE){
            mout.reject<LOG_WARNING>("not setting style for STYLE elem: ", value); // , *this);
        }
        else {
            this->style[key] = value;
        }
    }
 
 
 
    template <class V>
    inline
    void setStyle(const std::string & key, const std::initializer_list<V> &l){
        // const std::initializer_list<Variable::init_pair_t > &l
        if (type == STYLE){  // typeIs(STYLE) fails
            drain::Logger mout(__FILE__, __FUNCTION__);
            mout.warn("Setting style of STYLE?  initializer_list<", drain::TypeName<V>::str(), "> = ", sprinter(l)); // , StyleXML::styleLineLayout ?
        }
        this->style[key] = l;
    }
 
 
 
    template <class V>
    inline
    void setStyle(const std::string & key, const V & value){
 
        if (type == STYLE){
            drain::Logger(__FILE__, __FUNCTION__).reject<LOG_WARNING>("Setting style of STYLE: ", key, "=", value);
        }
        else {
            this->style[key] = value;
        }
    }
 
    inline
    void setStyle(const std::initializer_list<std::pair<const char *,const drain::Variable> > &args){
        drain::SmartMapTools::setValues(style, args);
    }
 
 
 
protected:
 
    // ------------------ Style Class ---------------
 
    ClassListXML classList;
 
public:
 
    const ClassListXML & getClasses() const {
        return classList;
    }
 
    template <typename ... TT>
    inline
    void addClass(const TT &... args) {
        classList.add(args...);
    }
 
    template <class V>
    inline
    bool hasClass(const V & cls) const {
        return classList.has(cls);
    }
 
    inline
    void removeClass(const std::string & s) {
        classList.remove(s);
    }
 
    inline
    void clearClasses(){
        classList.clear();
    }
 
 
    virtual
    void specificAttributesToStream(std::ostream & ostr) const;
 
 
    enum tag_display_mode {
        FLEXIBLE_TAG = 0,  // <TAG>...</TAG> or <TAG/>
        OPENING_TAG= 1,   // <TAG>
        CLOSING_TAG = 2,   // </TAG>
        EMPTY_TAG = OPENING_TAG | CLOSING_TAG,  // element has no descendants:  <hr/>
        NON_EMPTY_TAG, // opening and closing tags must appear, even when empty: <script></script>
    };
 
 
    virtual
    std::ostream & nodeToStream(std::ostream & ostr, tag_display_mode mode=EMPTY_TAG) const = 0;
 
 
 
    template <class TR>
    static
    std::ostream & toStream(std::ostream & ostr, const TR & tree, const std::string & defaultTag="ELEM", int indent=0);
 
 
    static
    const std::map<char,std::string> & getEntityMap();
 
 
    // core utility (not to be external)
    template <class V>
    static inline
    void xmlAttribToStream(std::ostream &ostr, const std::string & key, const V &value){
        //StringTools::replace(XML::encodingMap, data.ctext, ostr);
        //ostr << ' ' << key << '=' << '"' << value << '"'; // << ' ';
 
        static const std::map<char,char> keyMap = {
                {' ','_'},
                {'"','_'},
                {'=','_'},
        };
        ostr << ' ';
        StringTools::replace(key, keyMap, ostr); // XML::encodingMap
        //StringTools::replace(getEntityMap(), key, ostr); // XML::encodingMap
 
        static const std::map<char,std::string> valueMap = {
                {entity_t::QUOTE, "'"},
                {entity_t::LESS_THAN,"(("},
                {entity_t::GREATER_THAN,"))"},
        };
        ostr << '=' << '"';
        StringTools::replace(value, valueMap, ostr); // XML::encodingMap
        //StringTools::replace(getEntityMap(), value, ostr); // XML::encodingMap
        ostr << '"';
        //<< key << '=' << '"' << value << '"'; // << ' ';
    }
 
 
 
    template <typename N>
    static inline
    N & xmlAssignNode(N & dst, const N & src){
 
        if (&src != &dst){
            //dst.clear(); // clear attributes,
            //if (!dst.typeIs(src.getNativeType())){
            if (dst.getType() != src.getType()){
                dst.reset(); // clear attributes, style, cstring and type.
                // Warning: does not create links.
                dst.setType(src.getType());
            }
            dst.getAttributes().importMap(src.getAttributes());
            dst.setStyle(src.getStyle());
            // dst.setText(src.ctext); // wrong! set type to CTEXT
            dst.ctext = src.ctext;
        }
 
        return dst;
    }
 
 
 
    /*
    UNUSED!
    template <typename T>
    static
    T & xmlGuessType(const typename T::node_data_t & parentNode, T & child){
        typedef typename T::node_data_t::xml_default_elem_map_t map_t;
        const typename map_t::const_iterator it = T::node_data_t::xml_default_elems.find(parentNode.getNativeType());
        if (it != T::node_data_t::xml_default_elems.end()){
            child->setType(it->second);
            drain::Logger(__FILE__, __FUNCTION__).experimental<LOG_WARNING>("Default type set: ", child->getTag());
        }
        return child;
    }
    */
 
 
 
};
 
 
template <>
const drain::EnumDict<XML::entity_t>::dict_t drain::EnumDict<XML::entity_t>::dict;
 
DRAIN_ENUM_OSTREAM(XML::entity_t);
 
template <class TR>
std::ostream & XML::toStream(std::ostream & ostr, const TR & tree, const std::string & defaultTag, int indent){
 
    drain::Logger mout(__FILE__,__FUNCTION__);
 
    const typename TR::container_t & children = tree.getChildren();
 
    // const XML & data = tree.data; // template type forcing, keep here for programming aid.
    const typename TR::node_data_t & data = tree.data; // template used
 
    tag_display_mode mode = EMPTY_TAG;
 
    if (data.isCText()){ // this can be true only at root, and rarely so...? (because recursive call not reached, if ctext)
        data.nodeToStream(ostr, mode);
        // ostr << "<!--TX-->";
        return ostr;
    }
 
    if (!data.ctext.empty()){
        // mout.warn("Non-CTEXT-elem with ctext: <", data.getTag(), " id='", data.getId(), "' ...>, text='", data.ctext, "'");
        if (data.isSingular()){
            // mout.warn("Skipping CTEXT of a singular element <", tree->getTag(), " id='", data.getId(), "' ...> , CTEXT: '", data.ctext, "'");
            mode = EMPTY_TAG;
        }
        else {
            mode = OPENING_TAG;
        }
    }
 
    if (!children.empty()){
        mode = OPENING_TAG;
        if (data.isSingular()){
            mout.warn("Singular (hence normally empty) element <", tree->getTag(), " id='", data.getId(), "' ...> has ", children.size(), " children?");
        }
    }
 
    // mout.attention("Hey! ", TypeName<TR>::str(), " with ", TypeName<typename TR::node_data_t>::str(), "Explicit ", data.isExplicit(), " or implicit ", data.isSingular());
    if (data.isExplicit()){ // explicit
        mode = OPENING_TAG;
    }
    else if (data.isSingular()){ // <br/> <hr/>
        mode = EMPTY_TAG;
    }
    // Hence, is flexible, "bimodal", supports empty and open-close mode.
 
    // Indent
    // std::fill_n(std::ostream_iterator<char>(ostr), 2*indent, ' ');
    std::string fill(2*indent, ' ');
    ostr << fill;
    data.nodeToStream(ostr, mode);
 
    if (mode == EMPTY_TAG){
        //ostr << "<!--ET-->";
        ostr << '\n';
        return ostr;
    }
    else if (data.isStyle()){
        // https://www.w3.org/TR/xml/#sec-cdata-sect
        // ostr << "<![CDATA[ \n";
        // ostr << "<!-- STYLE -->"; WRONG!
 
        if (!data.ctext.empty()){
            // TODO: indent
            ostr << fill << data.ctext;
            StyleXML::commentToStream(ostr, " TEXT ");
            ostr << '\n';
        }
 
        if (!data.getAttributes().empty()){
            mout.warn("STYLE elem ", data.getId()," contains attributes, probably meant as style: ", sprinter(data.getAttributes()));
            ostr << "\n\t /" << "* <!-- DISCARDED attribs ";
            Sprinter::toStream(ostr, data.getAttributes()); //, StyleXML::styleRecordLayout
            ostr << " /--> *" << "/" << '\n';
        }
 
        if (!data.style.empty()){
            ostr << fill;
            StyleXML::commentToStream(ostr, "STYLE OBJ");
            ostr << '\n';
            for (const auto & attr: data.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;
        StyleXML::commentToStream(ostr, "style ELEMS");
        ostr << '\n';
 
        for (const auto & entry: tree.getChildren()){
 
            if (entry.second->isComment()){
                // StringTools::replace();
                ostr << fill << "/* "<< entry.second->ctext << " */" << '\n';
                // XML::toStream(ostr, entry.second, defaultTag, indent); // indent not used?
                continue;
            }
 
            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 << "  " << entry.first << " {\n";
                for (const auto & attr: entry.second->getAttributes()){
                    ostr << fill  << "    ";
                    if (attr.first == "id"){
                        StyleXML::commentToStream(ostr, "id=", attr.second);
                        // mout.suspicious("Style elem has id (", attr.second, ")");
                    }
                    else {
                        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 {
 
        // Elements "own" CTEXT will be always output first -> check for problems, if other elements added first.
        // ostr << data.ctext;
 
        if (data.isScript()){
            ostr << data.ctext; // let < and > pass through
        }
        else {
            ostr << data.ctext; // let < and > pass through
            // StringTools::replace(XML::encodingMap, data.ctext, ostr); // sometimes an issue? // any time issue?
        }
 
        // 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 = true; // (!data.ctext.empty()) || !children.empty();
 
        for (const auto & entry: children){
            if (!entry.second->isCText()){
                ALL_CTEXT = false;
                break;
            }
        }
 
        // ALL_CTEXT = false;
 
        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();
                //StringTools::replace(XML::encodingMap, entry.second->getText(), ostr); // any time issue?
                StringTools::replace(entry.second->getText(), getEntityMap(), ostr); // any time issue?
                // 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
        }
 
    }
 
    // ostr << "<!-- END "<< data.getId() << ' ' << data.getTag() << '(' << data.getType() << ')' << "-->";
 
    data.nodeToStream(ostr, CLOSING_TAG);
    ostr << '\n';  // Always after closing tag!
 
    return ostr;
}
 
 
 
}  // drain::
 
#endif /* DRAIN_XML */