diff options
Diffstat (limited to 'src/document.h')
| -rw-r--r-- | src/document.h | 461 |
1 files changed, 461 insertions, 0 deletions
diff --git a/src/document.h b/src/document.h new file mode 100644 index 0000000..96bedef --- /dev/null +++ b/src/document.h @@ -0,0 +1,461 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +#ifndef SEEN_SP_DOCUMENT_H +#define SEEN_SP_DOCUMENT_H + +/** \file + * SPDocument: Typed SVG document implementation + */ +/* Authors: + * Lauris Kaplinski <lauris@kaplinski.com> + * MenTaLguY <mental@rydia.net> + * Jon A. Cruz <jon@joncruz.org> + * Abhishek Sharma + * + * Copyright (C) 2004-2005 MenTaLguY + * Copyright (C) 1999-2002 Lauris Kaplinski + * Copyright (C) 2000-2001 Ximian, Inc. + * + * Released under GNU GPL v2+, read the file 'COPYING' for more information. + */ + + +#include <cstddef> +#include <deque> +#include <map> +#include <vector> + +#include <boost/ptr_container/ptr_list.hpp> + +#include <glibmm/ustring.h> +#include <sigc++/sigc++.h> + +#include <2geom/affine.h> +#include <2geom/forward.h> + +#include "3rdparty/libcroco/cr-cascade.h" + +#include "document-undo.h" +#include "event.h" +#include "gc-anchored.h" +#include "gc-finalized.h" + +#include "inkgc/gc-managed.h" + +#include "composite-undo-stack-observer.h" +// XXX only for testing! +#include "console-output-undo-observer.h" + +// This variable is introduced with 0.92.1 +// with the introduction of automatic fix +// for files detected to have been created +// with previous versions to have a similar +// look in 0.92+. +extern bool sp_no_convert_text_baseline_spacing; + + + +// This variable is introduced with 0.92.1 +// with the introduction of automatic fix +// for files detected to have been created +// with previous versions to have a similar +// look in 0.92+. +extern bool sp_do_not_fix_pre_92; + + + +namespace Avoid { +class Router; +} + +class SPItem; +class SPObject; +class SPGroup; +class SPRoot; + +namespace Inkscape { + class Selection; + class UndoStackObserver; + class EventLog; + class ProfileManager; + namespace XML { + struct Document; + class Node; + } + namespace Util { + class Unit; + class Quantity; + } +} + +class SPDefs; +class SP3DBox; +class Persp3D; +class Persp3DImpl; +class SPItemCtx; + +namespace Proj { + class TransfMat3x4; +} + +/// Typed SVG document implementation. +class SPDocument : public Inkscape::GC::Managed<>, + public Inkscape::GC::Finalized, + public Inkscape::GC::Anchored +{ + +public: + + /************ Functions *****************/ + + // Fundamental ------------------------ + SPDocument(); + ~SPDocument() override; + SPDocument(SPDocument const &) = delete; // no copy + void operator=(SPDocument const &) = delete; // no assign + + + // Document creation ------------------ + static SPDocument *createDoc(Inkscape::XML::Document *rdoc, char const *uri, + char const *base, char const *name, bool keepalive, + SPDocument *parent); + static SPDocument *createNewDoc(char const*uri, bool keepalive, + bool make_new = false, SPDocument *parent=nullptr ); + static SPDocument *createNewDocFromMem(char const*buffer, int length, bool keepalive); + SPDocument *createChildDoc(std::string const &uri); + + + // Document status -------------------- + void setVirgin(bool Virgin) { virgin = Virgin; } + bool getVirgin() { return virgin; } + + SPDocument *doRef(); + SPDocument *doUnref(); + + bool isModifiedSinceSave() const { return modified_since_save; } + bool isModifiedSinceAutoSave() const { return modified_since_autosave; } + void setModifiedSinceSave(bool const modified = true); + void setModifiedSinceAutoSaveFalse() { modified_since_autosave = false; }; + + bool idle_handler(); + bool rerouting_handler(); + + void requestModified(); + bool _updateDocument(); // Used by stand-alone sp_document_idle_handler + int ensureUpToDate(); + + bool addResource(char const *key, SPObject *object); + bool removeResource(char const *key, SPObject *object); + std::vector<SPObject *> const getResourceList(char const *key); + + void do_change_uri(char const *const filename, bool const rebase); + void changeUriAndHrefs(char const *uri); + void setXMLDialogSelectedObject(SPObject *activexmltree) { _activexmltree = activexmltree; } + SPObject *getXMLDialogSelectedObject() { return _activexmltree; } + + private: + void _importDefsNode(SPDocument *source, Inkscape::XML::Node *defs, Inkscape::XML::Node *target_defs); + SPObject *_activexmltree; + + public: + void importDefs(SPDocument *source); + + unsigned int vacuumDocument(); + + /******** Getters and Setters **********/ + + // Document structure ----------------- + Inkscape::ProfileManager* getProfileManager() const { return profileManager; } + Avoid::Router* getRouter() const { return router; } + + + /** Returns our SPRoot */ + SPRoot *getRoot() { return root; } + SPRoot const *getRoot() const { return root; } + + /** Return the main defs object for the document. */ + SPDefs *getDefs(); + + Inkscape::XML::Node *getReprRoot() { return rroot; } + Inkscape::XML::Node *getReprNamedView(); + + /** Our Inkscape::XML::Document. */ + Inkscape::XML::Document *getReprDoc() { return rdoc; } + Inkscape::XML::Document const *getReprDoc() const { return rdoc; } + + + std::vector<Glib::ustring> getLanguages() const; + + // Styling + CRCascade *getStyleCascade() { return style_cascade; } + CRStyleSheet *getStyleSheet() { return style_sheet; } + void const setStyleSheet(CRStyleSheet* sheet) { style_sheet = sheet; } + + // File information -------------------- + + /** A filename (not a URI yet), or NULL */ + void setDocumentUri(char const *document_uri); + char const *getDocumentURI() const { return document_uri; } + + /** To be used for resolving relative hrefs. */ + void setDocumentBase( char const* document_base ); + char const *getDocumentBase() const { return document_base; }; + + /** basename(uri) or other human-readable label for the document. */ + char const* getDocumentName() const { return document_name; } + + + // Document geometry ------------------------ + Inkscape::Util::Unit const* getDisplayUnit() const; + + void setDocumentScale( const double scaleX, const double scaleY ); + void setDocumentScale( const double scale ); + Geom::Scale getDocumentScale() const; + + void setWidthAndHeight(const Inkscape::Util::Quantity &width, const Inkscape::Util::Quantity &height, bool changeSize=true); + Geom::Point getDimensions() const; + + void setWidth(const Inkscape::Util::Quantity &width, bool changeSize=true); + void setHeight(const Inkscape::Util::Quantity &height, bool changeSize=true); + Inkscape::Util::Quantity getWidth() const; + Inkscape::Util::Quantity getHeight() const; + + void setViewBox(); + void setViewBox(const Geom::Rect &viewBox); + Geom::Rect getViewBox() const; + + Geom::OptRect preferredBounds() const; + void fitToRect(Geom::Rect const &rect, bool with_margins = false); + void setupViewport(SPItemCtx *ctx); + + + // Find items ----------------------------- + void bindObjectToId(char const *id, SPObject *object); + SPObject *getObjectById(Glib::ustring const &id) const; + SPObject *getObjectById(char const *id) const; + + void bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object); + SPObject *getObjectByRepr(Inkscape::XML::Node *repr) const; + + std::vector<SPObject *> getObjectsByClass(Glib::ustring const &klass) const; + std::vector<SPObject *> getObjectsByElement(Glib::ustring const &element) const; + std::vector<SPObject *> getObjectsBySelector(Glib::ustring const &selector) const; + + + // Find items by geometry -------------------- + void build_flat_item_list(unsigned int dkey, SPGroup *group, gboolean into_groups) const; + + std::vector<SPItem*> getItemsInBox (unsigned int dkey, Geom::Rect const &box, bool take_hidden = false, bool take_insensitive = false, bool take_groups = true, bool enter_groups = false) const; + std::vector<SPItem*> getItemsPartiallyInBox(unsigned int dkey, Geom::Rect const &box, bool take_hidden = false, bool take_insensitive = false, bool take_groups = true, bool enter_groups = false) const; + SPItem *getItemAtPoint(unsigned int key, Geom::Point const &p, bool into_groups, SPItem *upto = nullptr) const; + std::vector<SPItem*> getItemsAtPoints(unsigned const key, std::vector<Geom::Point> points, bool all_layers = true, size_t limit = 0) const ; + SPItem *getGroupAtPoint(unsigned int key, Geom::Point const &p) const; + + /** + * Returns the bottommost item from the list which is at the point, or NULL if none. + */ + static SPItem *getItemFromListAtPointBottom(unsigned int dkey, SPGroup *group, const std::vector<SPItem*> &list, Geom::Point const &p, bool take_insensitive = false); + + + // Box tool ------------------------------- + void setCurrentPersp3D(Persp3D * const persp); + /* + * getCurrentPersp3D returns current_persp3d (if non-NULL) or the first + * perspective in the defs. If no perspective exists, returns NULL. + */ + Persp3D * getCurrentPersp3D(); + + void setCurrentPersp3DImpl(Persp3DImpl * const persp_impl) { current_persp3d_impl = persp_impl; } + Persp3DImpl * getCurrentPersp3DImpl() { return current_persp3d_impl; } + + void getPerspectivesInDefs(std::vector<Persp3D*> &list) const; + unsigned int numPerspectivesInDefs() const { + std::vector<Persp3D*> list; + getPerspectivesInDefs(list); + return list.size(); + } + + + // Document undo/redo ---------------------- + unsigned long serial() const { return _serial; } // Returns document's unique number. + bool isSeeking() const {return seeking;} // In a transition between two "good" states of document? + void reset_key(void *dummy) { actionkey.clear(); } + bool isSensitive() const { return sensitive; } + + + // Garbage collecting ---------------------- + void queueForOrphanCollection(SPObject *object); + void collectOrphans(); + + + /************* Data ***************/ +private: + + // Document ------------------------------ + Inkscape::ProfileManager* profileManager; // Color profile. + Avoid::Router *router; // Instance of the connector router + + // Document status ----------------------- + int ref_count; // Temp to check refcounting + + bool keepalive; ///< false if temporary document (e.g. to generate a PNG for display in a dialog). + bool virgin ; ///< Has the document never been touched? + bool modified_since_save = false; + bool modified_since_autosave = false; + sigc::connection modified_connection; + sigc::connection rerouting_connection; + + // Document structure -------------------- + Inkscape::XML::Document *rdoc; ///< Our Inkscape::XML::Document + Inkscape::XML::Node *rroot; ///< Root element of Inkscape::XML::Document + + SPRoot *root; ///< Our SPRoot + + // A list of svg documents being used or shown within this document + boost::ptr_list<SPDocument> _child_documents; + // Conversely this is a parent document because this is a child. + SPDocument *_parent_document; + + // Styling + CRCascade *style_cascade; + CRStyleSheet *style_sheet; + + // File information ---------------------- + char *document_uri; ///< A filename (not a URI yet), or NULL + char *document_base; ///< To be used for resolving relative hrefs. + char *document_name; ///< basename(uri) or other human-readable label for the document. + + // Find items ---------------------------- + std::map<std::string, SPObject *> iddef; + std::map<Inkscape::XML::Node *, SPObject *> reprdef; + + // Find items by geometry -------------------- + mutable std::deque<SPItem*> _node_cache; // Used to speed up search. + mutable bool _node_cache_valid; + + // Box tool ---------------------------- + Persp3D *current_persp3d; /**< Currently 'active' perspective (to which, e.g., newly created boxes are attached) */ + Persp3DImpl *current_persp3d_impl; + + // Document undo/redo ---------------------- + friend Inkscape::DocumentUndo; + + /* Undo/Redo state */ + bool sensitive; /* If we save actions to undo stack */ + Inkscape::XML::Event * partial; /* partial undo log when interrupted */ + int history_size; + std::vector<Inkscape::Event *> undo; /* Undo stack of reprs */ + std::vector<Inkscape::Event *> redo; /* Redo stack of reprs */ + + /* Undo listener */ + Inkscape::CompositeUndoStackObserver undoStackObservers; + + // XXX only for testing! + Inkscape::ConsoleOutputUndoObserver console_output_undo_observer; + + bool seeking; // Related to undo/redo/unique id + unsigned long _serial; // Unique document number (used by undo/redo). + Glib::ustring actionkey; // Last action key, used to combine actions in undo. + + // Garbage collecting ---------------------- + + std::vector<SPObject *> _collection_queue; ///< Orphans + + + /*********** Signals **************/ + + typedef sigc::signal<void, SPObject *> IDChangedSignal; + typedef sigc::signal<void> ResourcesChangedSignal; + typedef sigc::signal<void, unsigned> ModifiedSignal; + typedef sigc::signal<void, char const *> URISetSignal; + typedef sigc::signal<void, double, double> ResizedSignal; + typedef sigc::signal<void> ReconstructionStart; + typedef sigc::signal<void> ReconstructionFinish; + typedef sigc::signal<void> CommitSignal; + + typedef std::map<GQuark, SPDocument::IDChangedSignal> IDChangedSignalMap; + typedef std::map<GQuark, SPDocument::ResourcesChangedSignal> ResourcesChangedSignalMap; + + /** Dictionary of signals for id changes */ + IDChangedSignalMap id_changed_signals; + + SPDocument::ModifiedSignal modified_signal; + SPDocument::URISetSignal uri_set_signal; + SPDocument::ResizedSignal resized_signal; + SPDocument::ReconstructionStart _reconstruction_start_signal; + SPDocument::ReconstructionFinish _reconstruction_finish_signal; + SPDocument::CommitSignal commit_signal; // Used by friend Inkscape::DocumentUndo + + bool oldSignalsConnected; + + sigc::connection _selection_changed_connection; + sigc::connection _desktop_activated_connection; + sigc::connection selChangeConnection; + sigc::connection desktopActivatedConnection; + + sigc::signal<void> destroySignal; + + mutable Geom::Affine _doc2dt; + +public: + /// Document to desktop coordinate transformation. + const Geom::Affine &doc2dt() const; + /// Desktop to document coordinate transformation. + const Geom::Affine &dt2doc() const + { + // Note: doc2dt().inverse() happens to be identical to doc2dt() + return doc2dt(); + } + /// True if the desktop Y-axis points down, false if it points up. + bool is_yaxisdown() const { return yaxisdir() > 0; } + /// "1" if the desktop Y-axis points down, "-1" if it points up. + double yaxisdir() const { return _doc2dt[3]; } + + void addUndoObserver(Inkscape::UndoStackObserver& observer); + void removeUndoObserver(Inkscape::UndoStackObserver& observer); + + sigc::connection connectDestroy(sigc::signal<void>::slot_type slot); + sigc::connection connectModified(ModifiedSignal::slot_type slot); + sigc::connection connectURISet(URISetSignal::slot_type slot); + sigc::connection connectResized(ResizedSignal::slot_type slot); + sigc::connection connectCommit(CommitSignal::slot_type slot); + sigc::connection connectIdChanged(const char *id, IDChangedSignal::slot_type slot); + sigc::connection connectResourcesChanged(char const *key, SPDocument::ResourcesChangedSignal::slot_type slot); + sigc::connection connectReconstructionStart(ReconstructionStart::slot_type slot); + sigc::connection connectReconstructionFinish(ReconstructionFinish::slot_type slot); + + /* Resources */ + std::map<std::string, std::vector<SPObject *> > resources; + ResourcesChangedSignalMap resources_changed_signals; // Used by Extension::Internal::Filter + + void _emitModified(); // Used by SPItem + void emitReconstructionStart(); + void emitReconstructionFinish(); + void emitResizedSignal(double width, double height); +}; + +/* + * Ideas: How to overcome style invalidation nightmare + * + * 1. There is reference request dictionary, that contains + * objects (styles) needing certain id. Object::build checks + * final id against it, and invokes necessary methods + * + * 2. Removing referenced object is simply prohibited - + * needs analyse, how we can deal with situations, where + * we simply want to ungroup etc. - probably we need + * Repr::reparent method :( [Or was it ;)] + * + */ + +#endif // SEEN_SP_DOCUMENT_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:fileencoding=utf-8:textwidth=99 : |