TreeSVG.h

/*
 
MIT License
 
Copyright (c) 2023 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)
*/
/*
 * TreeSVG.h
 *
 *  Created on: Jun 24, 2012
 *      Author: mpeura
 */
 
#ifndef DRAIN_TREE_SVG
#define DRAIN_TREE_SVG
 
#include "drain/util/EnumFlags.h"
#include "drain/util/FileInfo.h"
#include "drain/util/Frame.h"
#include "drain/util/SelectorXML.h"
#include "drain/util/TreeXML.h"
#include "AlignSVG.h"
 
namespace drain {
 
namespace image {
 
class NodeSVG;
 
typedef drain::UnorderedMultiTree<NodeSVG,false, NodeXML<>::path_t> TreeSVG;
 
struct svg {
 
    typedef float coord_t;
 
    enum tag_t {
        UNDEFINED=XML::UNDEFINED,
        COMMENT=XML::COMMENT,
        CTEXT=XML::CTEXT,
        SCRIPT=XML::SCRIPT,
        STYLE=XML::STYLE,
        STYLE_SELECT=XML::STYLE_SELECT,
        SVG=10,
        CIRCLE, DESC, GROUP, LINE, IMAGE, METADATA, POLYGON, RECT, TEXT, TITLE, TSPAN };
    // check CTEXT, maybe implement in XML
 
};
 
} // image::
 
 
const drain::EnumDict<image::svg::tag_t>::dict_t & getDict();
 
 
template <>
const EnumDict<image::svg::tag_t>::dict_t EnumDict<image::svg::tag_t>::dict;
 
DRAIN_ENUM_OSTREAM(image::svg::tag_t)
 
 
 
namespace image {
 
class BBoxSVG : public drain::Box<svg::coord_t> {
 
public:
 
    inline
    BBoxSVG(svg::coord_t x=0, svg::coord_t y=0, svg::coord_t width=0, svg::coord_t height=0) : drain::Box<svg::coord_t>(x, y, width, height)  {
    }
 
    inline
    BBoxSVG(const BBoxSVG & bbox) : drain::Box<svg::coord_t>(bbox)  {
    }
 
    // Future option - also other units!
    /*
    bool x_PERCENTAGE = false;
    bool y_PERCENTAGE = false;
    bool width_PERCENTAGE = false;
    bool height_PERCENTAGE = false;
    */
};
 
 
template <size_t N>
class Transform : public UniTuple<double,N> {
 
public:
 
    bool empty() const {
        return (*this == 0.0);
    }
 
    virtual inline
    void toStream(std::ostream & ostr) const override {
        ostr << '(';
        TupleBase<double,N>::toStreamFormatted(ostr, ' ');
        ostr << ')';
    }
 
};
 
 
template <size_t N>
std::ostream & operator<<(std::ostream & ostr, Transform<N> & tr){
    tr.toStream(ostr);
    return ostr;
}
 
 
// Future option
class TransformSVG {
 
public:
 
    TransformSVG();
 
    inline
    bool empty() const {
        return (rotate.empty() && scale.empty() && translate.empty() && matrix.empty()) ;
    }
 
    inline
    void setTranslate(const svg::coord_t & x, const svg::coord_t & y){
        // translate.ensureSize(2);
        translate.set(x,y);
    }
 
    inline
    void setTranslateX(const svg::coord_t & x){
        // translate.ensureSize(1);
        // translate.set(x);
        translate[0] = x;
    }
 
    inline
    void setTranslateY(const svg::coord_t & y){
        // translate.ensureSize(2);
        // svg::coord_t x = translate.get<svg::coord_t>(1);
        translate[1] = y;
        // translate.set(x, y);
    }
 
 
    Transform<3> rotate;
    Transform<2> scale;
    Transform<2> translate;
    Transform<6> matrix;
 
    /*
    Variable rotate;
    Variable scale;
    Variable translate;
    Variable matrix;
    */
 
    // drain::Variable matrix;
    // drain::Variable skewX;
    // drain::Variable skewY;
    void toStream(std::ostream & ostr) const;
 
};
 
//typedef drain::StyleSelectorXML<NodeSVG> SelectSVG;
typedef drain::SelectorXML SelectSVG;
 
 
// class NodeSVG: public svg, public NodeXML<svg::tag_t>, public AlignAdapterSVG {
class NodeSVG: public NodeXML<svg::tag_t>, public AlignAdapterSVG {
public:
 
    static
    std::string xlink;
 
    static
    std::string svg;
 
    static
    const drain::FileInfo fileInfo;
 
 
    NodeSVG(svg::tag_t t = svg::UNDEFINED);
 
    NodeSVG(const NodeSVG & node);
 
    inline virtual
    ~NodeSVG(){};
 
    inline
    bool isAbstract(){
        return typeIs(
                svg::tag_t::STYLE,
                svg::tag_t::DESC,
                svg::tag_t::METADATA,
                svg::tag_t::SCRIPT,
                svg::tag_t::TITLE,
                svg::tag_t::TSPAN
        );
    }
 
    virtual inline
    bool isSingular() const override final {
        return false;
    }
 
 
    inline
    NodeSVG & operator=(const NodeSVG & node){
        if (!typeIsSet()){
            setType(node.getType());
            handleType();
            //handleType(node.getNativeType());
        }
        XML::xmlAssignNode(*this, node);
        return *this;
    }
 
    inline
    NodeSVG & operator=(const std::initializer_list<Variable::init_pair_t > &l){
        set(l);
        return *this;
    }
 
    template <class T>
    inline
    NodeSVG & operator=(const T & arg){
        set(arg);
        //assign(arg);
        return *this;
    }
 
 
 
    virtual
    void setAttribute(const std::string & key, const std::string &value) override;
 
    virtual
    void setAttribute(const std::string & key, const char *value) override;
 
 
 
    inline
    const BBoxSVG & getBoundingBox() const {
        return box;
    }
    // Consider also with conversion:  getBoundingBox(Box<T> &b)
 
    inline
    BBoxSVG & getBoundingBox(){
        return box;
    }
 
    template <typename T>
    inline
    void setBoundingBox(const drain::Box<T> & b){
        setLocation(b);
        setFrame(b);
        // setAttribute("data:bbox", StringBuilder<' '>(b.x, b.y, b.getWidth(), b.getHeight()));
    }
 
    template <typename T>
    inline
    void setLocation(const drain::Point2D<T> & point){
        box.x = point.x;
        box.y = point.y;
    }
 
    template <typename T>
    inline
    void setLocation(const T & x, const T & y){
        box.setLocation(x, y);
    }
 
    template <typename T>
    inline
    void setFrame(const drain::Frame2D<T> & frame){
        box.width  = frame.width;
        box.height = frame.height;
    }
 
    template <typename T>
    inline
    void setFrame(const T & w, const T & h){
        box.setArea(w, h);
    }
 
 
    template <typename T>
    inline
    void setWidth(T w){
        box.width  = w;
    }
 
    inline
    svg::coord_t getWidth(){
        return box.width;
    }
 
 
    template <typename T>
    inline
    void setMargin(T w){
        link("data-margin", box.width);
        box.width = w;
    }
 
 
    inline
    svg::coord_t getMargin(){
        return box.width;
    }
 
 
    template <typename T>
    inline
    void setHeight(T h){
        if (typeIs(svg::TEXT)){
            link("data-height", box.height);
        }
        box.height = h;
    }
 
    inline
    svg::coord_t getHeight(){
        return box.height;
    }
 
    void setFontSize(svg::coord_t size, svg::coord_t elemHeight = 0.0);
 
    TransformSVG transform;
 
 
    virtual
    void specificAttributesToStream(std::ostream & ostr) const override;
 
 
protected:
 
    virtual
    void handleType() override final;
 
 
    virtual
    void updateAlign() override;
 
    //drain::Box<coord_t> box;
    BBoxSVG box;
    // consider:
    // bool x_PERCENTAGE = false;
    // bool y_PERCENTAGE = false;
    // svg:
 
    // int radius = 0;
 
};
 
 
/*
template <typename P, typename A,typename V>
void NodeSVG::setAlign(const P & pos, const A & axis,  const V &value){
    alignments[p][a] = v;
}
*/
 
 
}  // image::
 
inline
std::ostream & operator<<(std::ostream &ostr, const image::NodeSVG & node){
    return node.nodeToStream(ostr);
}
 
/*
template <>
template <>
class NodeXML<image::svg::tag_t>::Elem<image::svg::tag_t::RECT>{
public:
 
    inline
    Elem(image::NodeSVG & node) : x(node.box.x), y(node.box.y), width(node.box.width), height(node.box.height){
    };
 
    float & x;
    float & y;
    double & width;
    double & height;
};
*/
 
template <>
template <>
class NodeXML<image::svg::tag_t>::Elem<image::svg::tag_t::RECT>{
public:
 
    inline
    Elem(image::NodeSVG & node) : x(node["x"]), y(node["y"]), width(node["width"]), height(node["height"]){
        node.setType(image::svg::tag_t::RECT);
    };
 
    FlexibleVariable & x;
    FlexibleVariable & y;
    FlexibleVariable & width;
    FlexibleVariable & height;
};
 
 
 
template <>
template <>
class NodeXML<image::svg::tag_t>::Elem<image::svg::tag_t::CIRCLE>{
public:
 
    inline
    Elem(image::NodeSVG & node) : x(node["x"]), y(node["y"]), radius(node["radius"]){
        node.setType(image::svg::tag_t::CIRCLE);
    };
 
    FlexibleVariable & x;
    FlexibleVariable & y;
    FlexibleVariable & radius;
 
    /*
    inline
    Elem(image::NodeSVG & node) : x(node.box.x), y(node.box.y), radius(node.radius){
    };
 
    float & x;
    float & y;
    int & radius;
    // double radius; // FAILS! Upon exiting scope, link becomes invalidated
    */
};
 
}  // drain::
 
 
inline
std::ostream & operator<<(std::ostream &ostr, const drain::image::TreeSVG & tree){
    //return drain::NodeXML<const drain::image::NodeSVG>::docToStream(ostr, tree);
    return drain::image::NodeSVG::docToStream(ostr, tree);
    //return drain::image::TreeSVG::node_data_t::docToStream(ostr, tree);
}
 
 
 
namespace drain {
 
DRAIN_TYPENAME(image::NodeSVG);
DRAIN_TYPENAME(image::svg::tag_t);
 
 
template <>
const NodeXML<image::svg::tag_t>::xml_default_elem_map_t NodeXML<image::svg::tag_t>::xml_default_elems;
 
/*
template <>
template <typename K, typename V>
image::TreeSVG & image::TreeSVG::operator=(std::initializer_list<std::pair<K,V> > args){
    drain::Logger mout(__FILE__, __FUNCTION__);
    mout.attention("initlist pair<K,V>: ", args);
    data.set(args); // what about TreeSVG & arg
    return *this;
}
*/
 
 
template <> // referring to Tree<NodeSVG>
template <> // referring to tparam T
inline
image::TreeSVG & image::TreeSVG::operator=(const std::string & arg){
    XML::xmlAssignString(*this, arg);
    return *this;
}
 
 
template <> // referring to Tree<NodeSVG>
inline
image::TreeSVG & image::TreeSVG::operator=(std::initializer_list<std::pair<const char *,const Variable> > l){
//image::TreeSVG & image::TreeSVG::operator=(std::initializer_list<std::pair<const char *,const char *> > l){
    return XML::xmlAssign(*this, l);
}
 
 
template <>
template <class T>
image::TreeSVG & image::TreeSVG::operator=(const T & arg){
    return XML::xmlAssign(*this, arg);
    /*
    data.set(arg); // what about TreeSVG & arg
    return *this;
    */
}
 
 
template <> // for T - Tree class
template <> // for K - operator() argument
// inline
image::TreeSVG & image::TreeSVG::operator()(const image::svg::tag_t & type);
/*
{
        return XML::xmlSetType(*this, type);
}
*/
 
 
template <> // for T (Tree class)
template <> // for K (path elem arg)
image::TreeSVG & image::TreeSVG::operator[](const image::svg::tag_t & type);
 
template <> // for T (Tree class)
template <> // for K (path elem arg)
const image::TreeSVG & image::TreeSVG::operator[](const image::svg::tag_t & type) const ;
 
 
template <>
inline
image::TreeSVG & image::TreeSVG::addChild(const image::TreeSVG::key_t & key){
    return XML::xmlAddChild(*this, key);
}
 
 
template <> // for T (Tree class)
template <> // for K (path elem arg)
bool image::TreeSVG::hasChild(const image::svg::tag_t & type) const;
 
 
/*
template <>
template <class K>
const image::TreeSVG::key_t & image::TreeSVG::getKey(const K & key){
    return EnumDict<K>::dict.getKey(key, false);
}
*/
 
/*  tested 2025/01/20 but caused problems with Hi5Tree("dataset2") etc.
template <>
template <typename K> // for K (path elem arg)
const image::TreeSVG::key_t & image::TreeSVG::getKey(const K & key){
    return EnumDict<K>::dict.getKey(key, false);
}
 
template <>
template <> // for K (path elem arg)
inline
const image::TreeSVG::key_t & image::TreeSVG::getKey(const drain::StyleSelectorXML<image::NodeSVG> & selector){
    return selector;
}
 
*/
 
} // drain::
 
#endif // DRAIN_TREE_SVG