src/document.h

   1 #ifndef __SP_DOCUMENT_H__
   2 #define __SP_DOCUMENT_H__
   3
   4 /** \file
   5  * SPDocument: Typed SVG document implementation
   6  *
   7  * Authors:
   8  *   Lauris Kaplinski <lauris@kaplinski.com>
   9  *   MenTaLguY <mental@rydia.net>
  10  *
  11  * Copyright (C) 2004-2005 MenTaLguY
  12  * Copyright (C) 1999-2002 Lauris Kaplinski
  13  * Copyright (C) 2000-2001 Ximian, Inc.
  14  *
  15  * Released under GNU GPL, read the file 'COPYING' for more information
  16  */
  17
  18 #include <glib-object.h>
  19 #include <gtk/gtksignal.h>
  20 #include <sigc++/sigc++.h>
  21 #include <sigc++/class_slot.h>
  22
  23 #include "libcroco/cr-cascade.h"
  24 #include <2geom/rect.h>
  25
  26 #include "gc-managed.h"
  27 #include "gc-finalized.h"
  28 #include "gc-anchored.h"
  29 #include <glibmm/ustring.h>
  30 #include "verbs.h"
  31 #include <vector>
  32 #include <set>
  33
  34 namespace Avoid {
  35 class Router;
  36 }
  37
  38 struct NRRect;
  39 struct SPDesktop;
  40 struct SPItem;
  41 struct SPObject;
  42 struct SPGroup;
  43
  44 namespace Geom {
  45     class Point;
  46 }
  47
  48 namespace Inkscape {
  49     struct Application;
  50     class Selection;
  51     class UndoStackObserver;
  52     class EventLog;
  53     class ProfileManager;
  54     namespace XML {
  55         class Document;
  56         class Node;
  57     }
  58 }
  59
  60 class SP3DBox;
  61 class Persp3D;
  62
  63 namespace Proj {
  64   class TransfMat3x4;
  65 }
  66
  67 class SPDocumentPrivate;
  68
  69 /// Typed SVG document implementation.
  70 struct SPDocument : public Inkscape::GC::Managed<>,
  71                     public Inkscape::GC::Finalized,
  72                     public Inkscape::GC::Anchored
  73 {
  74     typedef sigc::signal<void, SPObject *> IDChangedSignal;
  75     typedef sigc::signal<void> ResourcesChangedSignal;
  76     typedef sigc::signal<void, guint> ModifiedSignal;
  77     typedef sigc::signal<void, gchar const *> URISetSignal;
  78     typedef sigc::signal<void, double, double> ResizedSignal;
  79     typedef sigc::signal<void> ReconstructionStart;
  80     typedef sigc::signal<void> ReconstructionFinish;
  81     typedef sigc::signal<void> CommitSignal;
  82
  83     SPDocument();
  84     virtual ~SPDocument();
  85
  86     unsigned int keepalive : 1;
  87     unsigned int virgin    : 1; ///< Has the document never been touched?
  88     unsigned int modified_since_save : 1;
  89
  90     Inkscape::XML::Document *rdoc; ///< Our Inkscape::XML::Document
  91     Inkscape::XML::Node *rroot; ///< Root element of Inkscape::XML::Document
  92     SPObject *root;             ///< Our SPRoot
  93     CRCascade *style_cascade;
  94
  95     gchar *uri; ///< URI string or NULL
  96     gchar *base;
  97     gchar *name;
  98
  99     SPDocumentPrivate *priv;
 100
 101     /// Last action key
 102     const gchar *actionkey;
 103     /// Handler ID
 104     guint modified_id;
 105
 106     Inkscape::ProfileManager* profileManager;
 107
 108     // Instance of the connector router
 109     Avoid::Router *router;
 110
 111     GSList *perspectives;
 112
 113     Persp3D *current_persp3d; // "currently active" perspective (e.g., newly created boxes are attached to this one)
 114
 115     GSList *_collection_queue;
 116
 117     void add_persp3d (Persp3D * const persp);
 118     void remove_persp3d (Persp3D * const persp);
 119
 120     sigc::connection connectModified(ModifiedSignal::slot_type slot);
 121     sigc::connection connectURISet(URISetSignal::slot_type slot);
 122     sigc::connection connectResized(ResizedSignal::slot_type slot);
 123 sigc::connection connectCommit(CommitSignal::slot_type slot);
 124
 125     void bindObjectToId(gchar const *id, SPObject *object);
 126     SPObject *getObjectById(gchar const *id);
 127     sigc::connection connectIdChanged(const gchar *id, IDChangedSignal::slot_type slot);
 128
 129     void bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object);
 130     SPObject *getObjectByRepr(Inkscape::XML::Node *repr);
 131
 132     Glib::ustring getLanguage();
 133
 134     void queueForOrphanCollection(SPObject *object);
 135     void collectOrphans();
 136
 137     void _emitModified();
 138
 139     void addUndoObserver(Inkscape::UndoStackObserver& observer);
 140     void removeUndoObserver(Inkscape::UndoStackObserver& observer);
 141
 142     bool _updateDocument();
 143
 144     /// Are we currently in a transition between two "known good" states of the document?
 145     bool isSeeking() const;
 146
 147     bool isModifiedSinceSave() const { return modified_since_save; }
 148     void setModifiedSinceSave(bool modified = true) {
 149         modified_since_save = modified;
 150     }
 151
 152 private:
 153     SPDocument(SPDocument const &); // no copy
 154     void operator=(SPDocument const &); // no assign
 155
 156 public:
 157     sigc::connection connectReconstructionStart(ReconstructionStart::slot_type slot);
 158     sigc::connection connectReconstructionFinish (ReconstructionFinish::slot_type  slot);
 159     void emitReconstructionStart (void);
 160     void emitReconstructionFinish  (void);
 161
 162     unsigned long serial() const;
 163     void reset_key (void *dummy);
 164     sigc::connection _selection_changed_connection;
 165     sigc::connection _desktop_activated_connection;
 166
 167     void fitToRect(Geom::Rect const &rect);
 168 };
 169
 170 SPDocument *sp_document_new (const gchar *uri, unsigned int keepalive, bool make_new = false);
 171 SPDocument *sp_document_new_from_mem (const gchar *buffer, gint length, unsigned int keepalive);
 172
 173 SPDocument *sp_document_ref (SPDocument *doc);
 174 SPDocument *sp_document_unref (SPDocument *doc);
 175
 176
 177 SPDocument *sp_document_create(Inkscape::XML::Document *rdoc, gchar const *uri, gchar const *base, gchar const *name, unsigned int keepalive);
 178
 179 /*
 180  * Access methods
 181  */
 182
 183 #define sp_document_repr_doc(d) (d->rdoc)
 184 #define sp_document_repr_root(d) (d->rroot)
 185 #define sp_document_root(d) (d->root)
 186 #define SP_DOCUMENT_ROOT(d)  (d->root)
 187
 188 gdouble sp_document_width (SPDocument * document);
 189 gdouble sp_document_height (SPDocument * document);
 190
 191 struct SPUnit;
 192
 193 void sp_document_set_width (SPDocument * document, gdouble width, const SPUnit *unit);
 194 void sp_document_set_height (SPDocument * document, gdouble height, const SPUnit *unit);
 195
 196 #define SP_DOCUMENT_URI(d) (d->uri)
 197 #define SP_DOCUMENT_NAME(d) (d->name)
 198 #define SP_DOCUMENT_BASE(d) (d->base)
 199
 200 /*
 201  * Dictionary
 202  */
 203
 204 /*
 205  * Undo & redo
 206  */
 207
 208 void sp_document_set_undo_sensitive (SPDocument * document, bool sensitive);
 209 bool sp_document_get_undo_sensitive (SPDocument const * document);
 210
 211 void sp_document_clear_undo (SPDocument * document);
 212 void sp_document_clear_redo (SPDocument * document);
 213
 214 void sp_document_child_added (SPDocument *doc, SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref);
 215 void sp_document_child_removed (SPDocument *doc, SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref);
 216 void sp_document_attr_changed (SPDocument *doc, SPObject *object, const gchar *key, const gchar *oldval, const gchar *newval);
 217 void sp_document_content_changed (SPDocument *doc, SPObject *object, const gchar *oldcontent, const gchar *newcontent);
 218 void sp_document_order_changed (SPDocument *doc, SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *oldref, Inkscape::XML::Node *newref);
 219
 220 /* Object modification root handler */
 221 void sp_document_request_modified (SPDocument *doc);
 222 gint sp_document_ensure_up_to_date (SPDocument *doc);
 223
 224 /* Save all previous actions to stack, as one undo step */
 225 void sp_document_done (SPDocument *document, unsigned int event_type, Glib::ustring event_description);
 226 void sp_document_maybe_done (SPDocument *document, const gchar *keyconst, unsigned int event_type, Glib::ustring event_description);
 227 void sp_document_reset_key (Inkscape::Application *inkscape, SPDesktop *desktop, GtkObject *base);
 228
 229 /* Cancel (and revert) current unsaved actions */
 230 void sp_document_cancel (SPDocument *document);
 231
 232 /* Undo and redo */
 233 gboolean sp_document_undo (SPDocument * document);
 234 gboolean sp_document_redo (SPDocument * document);
 235
 236 /* Resource management */
 237 gboolean sp_document_add_resource (SPDocument *document, const gchar *key, SPObject *object);
 238 gboolean sp_document_remove_resource (SPDocument *document, const gchar *key, SPObject *object);
 239 const GSList *sp_document_get_resource_list (SPDocument *document, const gchar *key);
 240 sigc::connection sp_document_resources_changed_connect(SPDocument *document, const gchar *key, SPDocument::ResourcesChangedSignal::slot_type slot);
 241
 242
 243 /*
 244  * Ideas: How to overcome style invalidation nightmare
 245  *
 246  * 1. There is reference request dictionary, that contains
 247  * objects (styles) needing certain id. Object::build checks
 248  * final id against it, and invokes necesary methods
 249  *
 250  * 2. Removing referenced object is simply prohibited -
 251  * needs analyse, how we can deal with situations, where
 252  * we simply want to ungroup etc. - probably we need
 253  * Repr::reparent method :( [Or was it ;)]
 254  *
 255  */
 256
 257 /*
 258  * Misc
 259  */
 260
 261 GSList * sp_document_items_in_box(SPDocument *document, unsigned int dkey, Geom::Rect const &box);
 262 GSList * sp_document_partial_items_in_box(SPDocument *document, unsigned int dkey, Geom::Rect const &box);
 263 SPItem* sp_document_item_from_list_at_point_bottom (unsigned int dkey, SPGroup *group, const GSList *list, Geom::Point const p, bool take_insensitive = false);
 264 SPItem * sp_document_item_at_point (SPDocument *document, unsigned int key, Geom::Point const p, gboolean into_groups, SPItem *upto = NULL);
 265 GSList *sp_document_items_at_points(SPDocument *document, unsigned const key, std::vector<Geom::Point> points);
 266 SPItem *sp_document_group_at_point (SPDocument *document, unsigned int key,  Geom::Point const p);
 267
 268 void sp_document_set_uri (SPDocument *document, const gchar *uri);
 269 void sp_document_resized_signal_emit (SPDocument *doc, gdouble width, gdouble height);
 270
 271 unsigned int vacuum_document (SPDocument *document);
 272
 273 #endif
 274
 275 /*
 276   Local Variables:
 277   mode:c++
 278   c-file-style:"stroustrup"
 279   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 280   indent-tabs-mode:nil
 281   fill-column:99
 282   End:
 283 */
 284 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :