graphics.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)
*/
 
// Vector graphics (mainly SVG) – EXPERIMENTAL
 
#ifndef RACK_GRAPHICS
#define RACK_GRAPHICS
 
// #include <drain/prog/CommandInstaller.h>
 
#include "resources-image.h"
#include "resources.h"
 
// Notice: role of graphics.cpp and fileio-svg.cpp is currently equivalent
 
namespace rack {
 
 
 
class RackSVG { // : public drain::BasicCommand {
 
 
public:
 
    //typedef drain::StyleSelectorXML<NodeSVG> Select;
 
    // Identifier for the anchor background
    static const std::string BACKGROUND_RECT; //  = "mainRect";
 
    // static const std::string TECH_PANEL;
    /*
    enum ElemClass {
        NONE = 0,
        MAIN_TITLE = 1,  // Main title in SVG image
        GROUP_TITLE = 2,
        IMAGE_TITLE = 4,  // Small title in a corner of radar image (time, location)
        TIME = 8,       // Date and time attributes
        LOCATION = 16,   // Place (coordinates, municipality)
        GENERAL = 32,    // Default type
        ALL = (63),
        MAIN,
        IMAGE_PANEL,
        IMAGE_BORDER, // RECT surrounding the image
        SHARED_METADATA, // Something that should not be repeated in panels.
        // --- unused ? ---
        TITLE,      // Default title
      };
    */
 
    // Selected CSS classes corresponding to above element classes
    /*
    static const drain::ClassSelectorXML clsTITLE;// ('.', RackSVG::TITLE);
    static const drain::ClassSelectorXML clsIMAGE_TITLE;// ('.', RackSVG::IMAGE_TITLE);
    static const drain::ClassSelectorXML clsGROUP_TITLE;// ('.', RackSVG::GROUP_TITLE);
    static const drain::ClassSelectorXML clsMAIN_TITLE;// ('.', RackSVG::MAIN_TITLE);
    static const drain::ClassSelectorXML clsTIME;// ('.', RackSVG::TIME);
    static const drain::ClassSelectorXML clsLOCATION;// ('.', RackSVG::LOCATION);
    static const drain::ClassSelectorXML clsIMAGE_BORDER;// ('.', RackSVG::IMAGE_BORDER);
    */
 
    // typedef drain::EnumFlagger<drain::MultiFlagger<ElemClass> > TitleFlagger;
    //TitleFlagger svgTitles = ElemClass::NONE;
 
 
    static
    drain::image::TreeSVG & getStyle(RackContext & ctx);
 
    static
    const std::string & guessFormat(const std::string & key);
 
 
    static
    drain::image::TreeSVG & getMainGroup(RackContext & ctx);
 
    //drain::image::TreeSVG & getCurrentAlignedGroup();
 
    // virtual
    // std::string getFormattedStatus(RackContext & ctx, const std::string & format) const = 0;
 
    static
    drain::image::TreeSVG & getCurrentAlignedGroup(RackContext & ctx);
 
    static
    drain::image::TreeSVG & getImagePanelGroup(RackContext & ctx, const drain::FilePath & filepath);
 
 
    static
    void applyAlignment(RackContext & ctx, drain::image::TreeSVG & group);
 
    static
    bool applyInclusion(RackContext & cxt, const drain::FilePath & filepath); // , SvgInclude fileFormat);
 
    static
    // drain::image::TreeSVG &
    void addImage(RackContext & ctx, const drain::image::Image & src, const drain::FilePath & filepath);
 
    static
    // drain::image::TreeSVG &
    void addImage(RackContext & ctx, const drain::image::TreeSVG & svg, const drain::FilePath & filepath);
 
 
    static
    // drain::image::TreeSVG &
    void addImage(RackContext & ctx, const drain::Frame2D<drain::image::svg::coord_t> & frame, const drain::FilePath & filepath, const std::string & styleClass = "");
 
 
    static
    void addTitleBox(const PanelConfSVG & conf, drain::image::TreeSVG & object, PanelConfSVG::ElemClass elemClass);
 
    static
    void addTitles(const PanelConfSVG & conf, drain::image::TreeSVG & object, const std::string & anchor, PanelConfSVG::ElemClass elemClass);
 
    static
    drain::image::TreeSVG & addRectangleGroup(RackContext & ctx, const drain::Frame2D<double> & frame = {200,200});
 
 
 
    static
    drain::image::TreeSVG & addImageBorder(drain::image::TreeSVG & imagePanel); // , const drain::Frame2D<double> & frame = {200,200});
 
 
    //  static
    //  void generateTitles(RackContext & ctx);
 
    // Re-align elements etc
    static
    void completeSVG(RackContext & ctx); // , const drain::FilePath & filepath);
 
    // static
    // const std::string  & getTextClass(const std::string & key, const std::string & defaultClass = "");
 
protected:
 
    // Under construction...
    // static
    // void createTitleBox(TreeSVG & tree);
 
};
 
//DRAIN_ENUM_OSTREAM(RackSVG::ElemClass);
 
}
 
namespace drain {
 
//
/*
template <> // for T (Tree class)
template <> // for K (path elem arg)
image::TreeSVG & image::TreeSVG::operator[](const rack::GraphicsContext::ElemClass &x);
*/
 
 
//template <>
//const drain::EnumDict<RackSVG::TitleClass>::dict_t  drain::EnumDict<RackSVG::TitleClass>::dict;
 
/*
template <>
const std::string std::static_cast<std::string>(const RackSVG::ElemClass & e){
    return drain::EnumDict<RackSVG::ElemClass>::dict.getKey(e);
}
*/
 
}
 
 
namespace rack {
 
 
class MetaDataCollectorSVG : public drain::TreeVisitor<TreeSVG> {
 
public:
 
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path)  override;
 
    int visitPostfix(TreeSVG & tree, const TreeSVG::path_t & path)  override;
 
protected:
 
    typedef std::map<std::string, unsigned short> variableStat_t;
 
};
 
class MetaDataPrunerSVG : public drain::TreeVisitor<TreeSVG> {
 
public:
 
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path) override;
 
    int visitPostfix(TreeSVG & tree, const TreeSVG::path_t & path) override;
 
    // Also
    //GraphicsContext::TitleFlagger titles;
 
protected:
 
    typedef std::map<std::string, unsigned short> variableStat_t;
 
};
 
 
 
class TitleCreatorSVG : public drain::TreeVisitor<TreeSVG> {
 
public:
 
 
    inline
    TitleCreatorSVG(const PanelConfSVG & svgConf) : svgConf(svgConf) {
        //titles.set(0xff);
        /*
        if (!svgConf.mainTitle.empty()){
            titles.set(PanelConfSVG::ElemClass::MAIN_TITLE);
        }
 
        if (!svgConf.groupTitleSyntax.empty()){
            titles.set(PanelConfSVG::ElemClass::GROUP_TITLE);
        }
 
        titles.set(PanelConfSVG::ElemClass::IMAGE_TITLE);
        */
        /*
        if (!svgConf.groupNameSyntax.empty()){
            titles.set(RackSVG::ElemClass::GROUP_TITLE);
        }
        */
 
    };
 
    int visitPostfix(TreeSVG & tree, const TreeSVG::path_t & odimPath) override;
 
 
    static
    void writeTitles(TreeSVG & group, const NodeSVG::map_t & attributes);
 
    const PanelConfSVG & svgConf;
 
    // Conf
    // int mainHeaderHeight;
 
protected:
    // RackSVG::TitleFlagger::ivalue_t titles;
 
    // Conf
    // RackSVG::TitleFlagger titles;
 
 
};
 
 
} // rack::
 
 
#endif