implementation.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
/*
    Author:  Ted Gould <ted@gould.cx>
    Copyright (c) 2003-2005,2007
 
    Released under GNU GPL v2+, read the file 'COPYING' for more information.
 
    This file is the backend to the extensions system.  These are
    the parts of the system that most users will never see, but are
    important for implementing the extensions themselves.  This file
    contains the base class for all of that.
*/
#ifndef SEEN_INKSCAPE_EXTENSION_IMPLEMENTATION_H
#define SEEN_INKSCAPE_EXTENSION_IMPLEMENTATION_H
 
#include <vector>
#include <memory>
#include <sigc++/signal.h>
#include <glibmm/value.h>
#include <2geom/forward.h>
 
namespace Gtk {
    class Widget;
}
 
class SPDesktop;
class SPDocument;
class SPPage;
class SPStyle;
class SPItem;
 
namespace Inkscape {
 
namespace XML {
    class Node;
}
 
namespace Extension {
 
class Effect;
class Extension;
class Template;
class TemplatePreset;
class Input;
class Output;
class Print;
class ExecutionEnv;
 
typedef std::vector<std::shared_ptr<TemplatePreset>> TemplatePresets;
 
namespace Implementation {
 
class ImplementationDocumentCache {
 
    SPDesktop * _desktop;
public:
    explicit ImplementationDocumentCache (SPDesktop * desktop) { _desktop = desktop;};
 
    virtual ~ImplementationDocumentCache ( ) { return; };
    SPDesktop const * desktop() { return _desktop; }
};
 
class Implementation {
public:
    // ----- Constructor / destructor -----
    Implementation() = default;
 
    virtual ~Implementation() = default;
 
    // ----- Basic functions for all Extension -----
    virtual bool load(Inkscape::Extension::Extension * /*module*/) { return true; }
 
    virtual void unload(Inkscape::Extension::Extension * /*module*/) {}
 
    virtual ImplementationDocumentCache * newDocCache (Inkscape::Extension::Extension * /*ext*/, SPDesktop * /*desktop*/) { return nullptr; }
 
    virtual bool check(Inkscape::Extension::Extension * /*module*/) { return true; }
 
    virtual bool cancelProcessing () { return true; }
    virtual void commitDocument () {}
 
    // ---- Template and Page functions -----
    virtual std::unique_ptr<SPDocument> new_from_template(Inkscape::Extension::Template *);
    virtual void get_template_presets(const Template *tmod, TemplatePresets &presets) const {};
    virtual void resize_to_template(Inkscape::Extension::Template *tmod, SPDocument *doc, SPPage *page){};
    virtual bool match_template_size(Inkscape::Extension::Template *tmod, double width, double height){ return false; }
 
    // ----- Input functions -----
    virtual std::unique_ptr<SPDocument> open(Inkscape::Extension::Input *module, char const *filename, bool is_importing);
 
    // ----- Output functions -----
    virtual void save(Inkscape::Extension::Output * /*module*/, SPDocument * /*doc*/, gchar const * /*filename*/) {}
    virtual void export_raster(
            Inkscape::Extension::Output * module,
            const SPDocument * doc,
            std::string const &png_file,
            gchar const * filename) {}
 
    // ----- Effect functions -----
    virtual Gtk::Widget * prefs_effect(Inkscape::Extension::Effect *module,
                                       SPDesktop *desktop,
                                       sigc::signal<void ()> *changeSignal,
                                       ImplementationDocumentCache *docCache);
    virtual void effect(Inkscape::Extension::Effect * /*module*/, ExecutionEnv * /*executionEnv*/,
                        SPDesktop * /*desktop*/, ImplementationDocumentCache * /*docCache*/);
    virtual void effect(Inkscape::Extension::Effect * /*module*/, ExecutionEnv * /*executionEnv*/, SPDocument *document)
    {}
 
    virtual bool apply_filter(Inkscape::Extension::Effect* module, SPItem* item) { return false; }
 
    // ----- Print functions -----
    virtual unsigned setup(Inkscape::Extension::Print * /*module*/) { return 0; }
    virtual unsigned set_preview(Inkscape::Extension::Print * /*module*/) { return 0; }
 
    virtual unsigned begin(Inkscape::Extension::Print * /*module*/,
                           SPDocument * /*doc*/) { return 0; }
    virtual unsigned finish(Inkscape::Extension::Print * /*module*/) { return 0; }
 
    virtual bool     textToPath(Inkscape::Extension::Print * /*ext*/) { return false; }
 
    virtual bool     fontEmbedded(Inkscape::Extension::Print * /*ext*/) { return false; }
 
    // ----- Rendering methods -----
    virtual unsigned bind(Inkscape::Extension::Print * /*module*/,
                          Geom::Affine const & /*transform*/,
                          float /*opacity*/) { return 0; }
    virtual unsigned release(Inkscape::Extension::Print * /*module*/) { return 0; }
    virtual unsigned fill(Inkscape::Extension::Print * /*module*/,
                          Geom::PathVector const & /*pathv*/,
                          Geom::Affine const & /*ctm*/,
                          SPStyle const * /*style*/,
                          Geom::OptRect const & /*pbox*/,
                          Geom::OptRect const & /*dbox*/,
                          Geom::OptRect const & /*bbox*/) { return 0; }
    virtual unsigned stroke(Inkscape::Extension::Print * /*module*/,
                            Geom::PathVector const & /*pathv*/,
                            Geom::Affine const & /*transform*/,
                            SPStyle const * /*style*/,
                            Geom::OptRect const & /*pbox*/,
                            Geom::OptRect const & /*dbox*/,
                            Geom::OptRect const & /*bbox*/) { return 0; }
    virtual unsigned image(Inkscape::Extension::Print * /*module*/,
                           unsigned char * /*px*/,
                           unsigned int /*w*/,
                           unsigned int /*h*/,
                           unsigned int /*rs*/,
                           Geom::Affine const & /*transform*/,
                           SPStyle const * /*style*/) { return 0; }
    virtual unsigned text(Inkscape::Extension::Print * /*module*/,
                          char const * /*text*/,
                          Geom::Point const & /*p*/,
                          SPStyle const * /*style*/) { return 0; }
    virtual void     processPath(Inkscape::XML::Node * /*node*/) {}
 
    virtual void setDetachBase(bool detach) {}
};
 
 
}  // namespace Implementation
}  // namespace Extension
}  // namespace Inkscape
 
#endif // SEEN_INKSCAPE_EXTENSION_IMPLEMENTATION_H
 
/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :