AlignSVG.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: Nov, 2024
 *      Author: mpeura
 */
 
#ifndef DRAIN_ALIGN_SVG
#define DRAIN_ALIGN_SVG
 
#include <drain/Enum.h>
#include <string>
 
namespace drain {
 
namespace image {
 
 
struct AlignBase {
 
public:
 
    enum Pos {
        UNDEFINED_POS = 0,
        MIN = 1, // LEFT  (if HORZ) or TOP    (when VERT) 0b01010101,
        MAX = 2, // RIGHT (if HORZ) or BOTTOM (when VERT) 0b10101010,
        MID = 3, // 0b11111111,
        FILL = 4, 
        // ABSOLUTE?
    };
 
    enum Axis {
        // Index, must contain 0 and 1 for HORZ and VERT
        HORZ      = 0, // 0b00110011,
        VERT      = 1, // b11001100,
        UNDEFINED_AXIS = 2,
    };
 
 
    /*
    enum Axis {
        // Index, must contain 0 and 1 for HORZ and VERT
        UNDEFINED_AXIS = 0,
        HORZ      = 1, // 0b00110011,
        VERT      = 2, // b11001100,
    };
    */
 
    static inline
    Axis flip(Axis axis){
        switch (axis){
        case HORZ:
            return VERT;
        case VERT:
            return HORZ;
        default:
            return UNDEFINED_AXIS;
        }
    };
 
    //typedef drain::Enum<Coord>::dict_t pos_dict_t;
 
    static inline
    AlignBase::Pos flip(AlignBase::Pos pos){
        switch (pos){
        case MAX:
            return MIN;
        case MIN:
            return MAX;
        case MID:
        case FILL:
        case UNDEFINED_POS:
        default:
            return pos;
        }
    };
 
};
 
 
// template <> const drain::Enum<AlignBase::Axis>::dict_t drain::Enum<AlignBase::Axis>::dict;
DRAIN_ENUM_DICT(AlignBase::Axis);
DRAIN_ENUM_OSTREAM(AlignBase::Axis);
 
// template <>const drain::Enum<AlignBase::Pos>::dict_t drain::Enum<AlignBase::Pos>::dict;
DRAIN_ENUM_DICT(AlignBase::Pos);
DRAIN_ENUM_OSTREAM(AlignBase::Pos);
 
 
 
template <typename AX = AlignBase::Axis, AlignBase::Axis A = AlignBase::Axis::UNDEFINED_AXIS> //, typename POS = AlignBase::Pos> // , Align::Coord POS = Align::Coord::UNDEFINED_POS>
struct Alignment {
 
    // Align::Axis
    AX axis; // = V; // compiler error if different type?
 
    //AlignBase::Pos pos
    AlignBase::Pos pos = AlignBase::Pos::UNDEFINED_POS; // or middle?
    //POS pos = AlignBase::Pos::UNDEFINED_POS; // or middle?
 
    inline
    Alignment(AlignBase::Pos pos = AlignBase::Pos::UNDEFINED_POS) : axis(A), pos(pos){
    }
 
    inline
    Alignment(const Alignment & ac) : axis(ac.axis), pos(ac.pos){
    }
 
 
    inline
    Alignment(AlignBase::Axis axis, AlignBase::Pos pos = AlignBase::Pos::UNDEFINED_POS): axis(axis), pos(pos){
    }
 
    template <typename AX2, AlignBase::Axis A2>
    inline
    Alignment(const Alignment<AX2,A2> & align) : pos(align.pos){ // axis(ac.axis),
        axis = align.axis; // error if const
    }
 
    inline virtual
    ~Alignment(){};
 
 
    inline
    const AlignBase::Axis & get(const AlignBase::Axis & defaultValue) const {
        if (axis != AlignBase::Axis::UNDEFINED_AXIS){
            return axis;
        }
        else {
            return defaultValue;
        }
    }
 
    inline
    const AlignBase::Pos & get(const AlignBase::Pos & defaultValue) const {
        if (pos != AlignBase::Pos::UNDEFINED_POS){
            return pos;
        }
        else {
            return defaultValue;
        }
    }
 
 
    virtual inline
    void reset(){
        axis = AlignBase::Axis::UNDEFINED_AXIS;
        pos  = AlignBase::Pos::UNDEFINED_POS;
    }
 
 
    template <typename AX2, AlignBase::Axis A2>
    inline
    bool operator==(const Alignment<AX2,A2> & align) const {
        return (align.axis == axis) && (align.pos == pos);
        // return compare(ad) == 0;
    }
 
    /*
    inline
    Alignment<AX,A> & operator=(Alignment<AX,A> & align){
        // axis = align.axis;
        pos  = align.pos;
        return *this;
    }
    */
 
 
 
 
};
 
 
 
template <typename AX, AlignBase::Axis V>
inline
std::ostream & operator<<(std::ostream &ostr, const Alignment<AX,V> & align){
    //return ostr << align.axis << '_' << align.pos; // enums resolved above
    return ostr << align.axis << '_' << align.pos;
}
 
struct MutualAlign {
 
    enum Topol {
        INSIDE = 0,
        OUTSIDE = 1,
        UNDEFINED_TOPOL = 2,
    };
 
 
};
 
 
 
template <typename AX = AlignBase::Axis, AlignBase::Axis A = AlignBase::Axis::UNDEFINED_AXIS> // , Align::Coord POS = Align::Coord::UNDEFINED_POS>
struct CompleteAlignment : public Alignment<AX,A> {
 
    MutualAlign::Topol topol = MutualAlign::Topol::INSIDE; // or undef?
 
    template <class ...TT>
    CompleteAlignment(const TT... args) : Alignment<AX,A>() {
        set(args...);
    }
 
    inline
    ~CompleteAlignment(){};
 
    virtual inline
    bool isSet() const {
        return (this->axis != AlignBase::Axis::UNDEFINED_AXIS) &&
                (this->pos != AlignBase::Pos::UNDEFINED_POS) &&
                (topol != MutualAlign::Topol::UNDEFINED_TOPOL);
        // return Alignment<AX,A>::isSet() && (topol != MutualAlign::Topol::UNDEFINED_TOPOL);
    }
 
    inline
    const MutualAlign::Topol & getOrDefault(const MutualAlign::Topol & defaultValue) const {
        if (topol != MutualAlign::Topol::UNDEFINED_TOPOL){
            return topol;
        }
        else {
            return defaultValue;
        }
    }
 
 
    // Sets all members to UNDEFINED state.
    virtual inline
    void reset(){
        Alignment<AX,A>::reset();
        topol = MutualAlign::Topol::UNDEFINED_TOPOL;
        // this->updateAlign();
    }
 
 
    template <typename AX2, AlignBase::Axis A2, class ...TT>
    void set(const Alignment<AX2,A2> & align, const TT... args){
        this->axis = align.axis;
        this->pos  = align.pos;
        set(args...);
    }
 
    template <class ...TT>
    void set(MutualAlign::Topol topol, const TT... args){
        this->topol = topol;
        set(args...);
    }
 
    template <class ...TT>
    void set(AlignBase::Axis axis, const TT... args){
        this->axis = axis;
        set(args...);
    }
 
    template <class ...TT>
    void set(AlignBase::Pos coord, const TT... args){
        this->pos = coord;
        set(args...);
    }
 
    template <class ...TT>
    void set(const std::string & key, const TT... args){
        if (Enum<MutualAlign::Topol>::setValue(key, topol)){
            // ok
        }
        else if (Enum<Alignment<> >::setValue(key, *this)){ // RIGHT or?
            // ok
        }
        else if (Enum<AlignBase::Axis>::setValue(key, this->axis)){
            // ok
        }
        else if (Enum<AlignBase::Pos>::setValue(key, this->pos)){
            // ok
        }
        else {
            // Advice: keys
            throw std::runtime_error(drain::StringBuilder<>("key '", key, "' not found. Appeared in: ", args...));
        }
 
        set(args...);
    }
 
    template <class ...TT>
    void set(const char *key, const TT... args){
        set(std::string(key), args...);
    }
 
 
protected:
 
    inline
    void set(){
        // this->updateAlign(); // ok?
    }
 
};
 
 
//struct Alignment2;
 
 
struct AlignSVG { // : protected Align {
 
 
    virtual
    ~AlignSVG(){};
 
    typedef Alignment<const AlignBase::Axis, AlignBase::Axis::HORZ> HorzAlign;
 
    static
    const HorzAlign LEFT;
 
    static
    const HorzAlign CENTER;
 
    static
    const HorzAlign RIGHT;
 
    static
    const HorzAlign HORZ_FILL;
 
    static
    const HorzAlign UNDEFINED_HORZ;
 
    // ----------------------
 
    typedef Alignment<const AlignBase::Axis, AlignBase::Axis::VERT> VertAlign;
 
    static
    const VertAlign TOP;
 
    static
    const VertAlign MIDDLE;
 
    static
    const VertAlign BOTTOM;
 
    static
    const VertAlign VERT_FILL;
 
    static
    const VertAlign UNDEFINED_VERT;
 
 
    enum Owner {
        OBJECT = 0, // 0b00001111,
        ANCHOR = 1, // 0b11110000,
    };
 
 
 
 
    /*
     *  Notice that for an alignment to be complete, this function should be called twice:
     *  setting partial alignment for both owner=OBJECT and owner=ANCHOR .
     *
     *  \tparam OBJ  - enum type \c Owner  or string
     *  \tparam A    - enum type \c Axis or string
     *  \tparam V    - enum type \c Alignment or string
     *  \param pos   - enum value \c OBJ or \c REF
     *  \param axis  - enum value \c HORZ or \c VERT
     *  \param value - enum value \c MAX , \c MID , or \c MIN (or string)
     */
    template <typename OBJ, typename A, typename V>
    inline // in problems, rename this function, ie. remove polymorphism
    void setAlign(const OBJ & owner, const A & axis,  const V &value){
        modifyAlign(owner, axis, value);
        updateAlign();
    }
 
 
    inline
    void setAlign(const AlignBase::Axis & axis, const AlignBase::Pos & pos, MutualAlign::Topol topol=MutualAlign::Topol::INSIDE){
        if (pos != AlignBase::FILL){
            modifyAlign(ANCHOR, axis, pos);
        }
        modifyAlign(OBJECT, axis, (topol==MutualAlign::INSIDE) ? pos : AlignBase::flip(pos));
        updateAlign();
    }
 
    /*
     *  Template supports empty arg list.
     *
     *  \tparam T  - enum type \c Topol or string
     *  \tparam AX - axis enum type: Axis or const Axis
     *  \tparam A  - axis enum value: HORZ, VERT or UNDEFINED_AXIS
     *  \param align  - \c HorzAlign or \c VertAlign
     */
    template <typename ...T, typename AX, AlignBase::Axis A>
    void setAlign(const Alignment<AX,A> & align, const T...  args){
        if (align.pos == AlignBase::FILL){
            // Makes sense only for OBJECT, as it will be changed (and ANCHOR is never unchanged).
            setAlign(AlignSVG::OBJECT, align.axis, align.pos);
        }
        else {
            setAlign(align.axis, align.pos, args...);
        }
    }
 
    // Convenience: set both horz and vert alignments (INSIDE)
    /*
     */
    template <typename AX1, AlignBase::Axis A1, typename AX2, AlignBase::Axis A2>
    void setAlign(const Alignment<AX1,A1> & align1, const Alignment<AX2,A2> & align2){
        setAlign(align1.axis, align1.pos, MutualAlign::Topol::INSIDE);
        setAlign(align2.axis, align2.pos, MutualAlign::Topol::INSIDE);
    }
 
    // Convenience: set both horz and vert alignments (INSIDE)
    /*
     */
    template <typename AX1, AlignBase::Axis A1> // , typename AX2, AlignBase::Axis A2>
    void setAlign(const CompleteAlignment<AX1,A1> & align1){
        setAlign(align1.axis, align1.pos, align1.topol);
        //setAlign(align2.axis, align2.pos, MutualAlign::Topol::INSIDE);
    }
 
 
    template <typename AX, AlignBase::Axis A>
    void setAlign(const Alignment<AX,A> & align1, const Alignment<AX,A> & align2);
 
 
    /*
     *  \tparam T - enum type \c Topol or string: \c INSIDE or \c OUTSIDE .
     *  \param align  - Horizontal or vertical Alignment: \c LEFT|CENTER|RIGHT or \c TOP|MIDDLE|BOTTOM
     *  \param topol  - \c INSIDE or \c OUTSIDE
     */
    template <typename T>
    void setAlign(const std::string & align, const T & topol){
        const Alignment<> & a = Enum<Alignment<> >::getValue(align, false);
        const MutualAlign::Topol & t = Enum<MutualAlign::Topol>::getValue(topol, false);
        //const Alignment<> & a = Enum<Alignment<> >::getValue(align, false);
        setAlign(a.axis, a.pos, t);
    }
 
    /* "TODO"
    void setAlign(const CompleteAlignment<> & align){
    }
    */
 
 
    void setAlign(const std::string & align);
    // Note: no mixed type, ANCHOR:LEFT
 
    bool isAligned() const;
 
    void resetAlign();
 
    void swapAlign(AlignSVG & align);
 
    /*
     *  \tparam P - enum type Owner \c REF or \c OBJ , or respective string.
     *  \tparam A - enum type axis_t \c HORZ or \c VERT , or respective string.
     *  \param pos - target object \c OBJ or referred anchor object \c REF
     *  \param axis - horizontal \c HORZ or vertical \c AXIS .
     */
    template <typename P, typename A>
    AlignBase::Pos & getAlignPos(const P & pos, const A & axis);
 
 
    /*
     *  \tparam P - enum type Owner \c REF or \c OBJ , or respective string.
     *  \tparam A - enum type axis_t \c HORZ or \c VERT , or respective string.
     *  \param pos - target object \c OBJ or referred anchor object \c REF
     *  \param axis - horizontal \c HORZ or vertical \c AXIS .
     *
     */
    template <typename P, typename A>
    const AlignBase::Pos & getAlignPos(const P & pos, const A & axis) const;
 
    void confToStream(std::ostream & ostr) const;
 
    inline
    const std::string & getAlignStr() const {
        return alignStr;
    }
 
    void swapAlign();
    /*
    template <typename ...TT>
    bool isAlignSet(const TT... args) const {
        bitvect_t v = combineAlign(args...);
        return (alignment & v) == v;
    }
 
    */
 
protected:
 
    // Future extension
    typedef int bitvect_t;  // or int_t ?
 
    // Future extension
    mutable
    bitvect_t alignment = 0;
 
    std::string alignStr;
 
    template <typename P, typename A, typename V>
    void modifyAlign(const P & owner, const A & axis,  const V &value){
        getAlignPos(owner, axis) = Enum<AlignBase::Pos>::getValue(value, false);
    }
 
 
    void updateAlignStr();
 
    virtual inline
    void updateAlign(){
        updateAlignStr();
    };
 
 
    typedef std::vector<AlignBase::Pos> align_vect_t;
    typedef std::vector<align_vect_t > align_conf_t;
 
    align_conf_t alignments = align_conf_t(2, align_vect_t(2, AlignBase::Pos::UNDEFINED_POS));
 
 
 
};
 
 
inline
std::ostream & operator<<(std::ostream &ostr, const AlignSVG & align){
    //return ostr << align.axis << '_' << align.pos; // enums resolved above
    align.confToStream(ostr);
    return ostr; //  << "UNDER CONSTR...";  // RESOLVE!
}
 
 
// template <>
// const drain::Enum<AlignSVG::Owner>::dict_t drain::Enum<AlignSVG::Owner>::dict;
DRAIN_ENUM_DICT(AlignSVG::Owner);
DRAIN_ENUM_OSTREAM(AlignSVG::Owner);
 
//template <>
//const drain::Enum<MutualAlign::Topol>::dict_t drain::Enum<MutualAlign::Topol>::dict;
DRAIN_ENUM_DICT(MutualAlign::Topol);
DRAIN_ENUM_OSTREAM(MutualAlign::Topol);
 
template <>
inline
void AlignSVG::HorzAlign::reset(){
    // axis = AlignBase::Axis::UNDEFINED_AXIS;
    pos  = AlignBase::Pos::UNDEFINED_POS;
}
 
template <>
inline
void AlignSVG::VertAlign::reset(){
    // axis = AlignBase::Axis::UNDEFINED_AXIS;
    pos  = AlignBase::Pos::UNDEFINED_POS;
}
 
 
/*
template <>
const drain::Enum<AlignSVG::HorzAlign>::dict_t  drain::Enum<AlignSVG::HorzAlign>::dict;
 
template <>
const drain::Enum<AlignSVG::VertAlign>::dict_t  drain::Enum<AlignSVG::VertAlign>::dict;
 
 
template <>
const drain::Enum<Alignment<> >::dict_t  drain::Enum<Alignment<> >::dict;
*/
 
DRAIN_ENUM_DICT(AlignSVG::HorzAlign);
DRAIN_ENUM_DICT(AlignSVG::VertAlign);
DRAIN_ENUM_DICT(Alignment<>);
 
 
 
template <typename OBJ, typename A>
AlignBase::Pos & AlignSVG::getAlignPos(const OBJ & owner, const A & axis){
    const AlignSVG::Owner p = Enum<AlignSVG::Owner>::getValue(owner, false); // raise error
    const AlignBase::Axis a = Enum<AlignBase::Axis>::getValue(axis, false); // raise error
    return alignments[p][a];
}
 
template <typename OBJ, typename A>
const AlignBase::Pos & AlignSVG::getAlignPos(const OBJ & owner, const A & axis) const {
    const AlignSVG::Owner p  = Enum<AlignSVG::Owner>::getValue(owner, false); // raise error
    const AlignBase::Axis a  = Enum<AlignBase::Axis>::getValue(axis, false); // raise error
    return alignments[p][a];
}
 
 
 
 
 
template <typename AX, AlignBase::Axis A>
std::ostream & operator<<(std::ostream &ostr, const CompleteAlignment<AX,A> & ad){
    return ostr << ad.topol << '_' << ad.axis << ':' << ad.pos;
}
 
 
 
 
 
 
 
}  // image::
 
DRAIN_TYPENAME(image::AlignSVG::HorzAlign);
DRAIN_TYPENAME(image::AlignSVG::VertAlign);
 
}  // drain::
 
 
DRAIN_ENUM_OSTREAM(drain::image::AlignBase::Axis);
DRAIN_ENUM_OSTREAM(drain::image::AlignBase::Pos);
DRAIN_ENUM_OSTREAM(drain::image::AlignSVG::Owner);
 
 
#endif // DRAIN_ALIGN_SVG_H_