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/forward.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 Inkscape {
  45     struct Application;
  46     class Selection;
  47     class UndoStackObserver;
  48     class EventLog;
  49     class ProfileManager;
  50     namespace XML {
  51         class Document;
  52         class Node;
  53     }
  54 }
  55
  56 class SP3DBox;
  57 class Persp3D;
  58
  59 namespace Proj {
  60     class TransfMat3x4;
  61 }
  62
  63 class SPDocumentPrivate;
  64
  65 /// Typed SVG document implementation.
  66 struct SPDocument : public Inkscape::GC::Managed<>,
  67                     public Inkscape::GC::Finalized,
  68                     public Inkscape::GC::Anchored
  69 {
  70     typedef sigc::signal<void, SPObject *> IDChangedSignal;
  71     typedef sigc::signal<void> ResourcesChangedSignal;
  72     typedef sigc::signal<void, guint> ModifiedSignal;
  73     typedef sigc::signal<void, gchar const *> URISetSignal;
  74     typedef sigc::signal<void, double, double> ResizedSignal;
  75     typedef sigc::signal<void> ReconstructionStart;
  76     typedef sigc::signal<void> ReconstructionFinish;
  77     typedef sigc::signal<void> CommitSignal;
  78
  79     SPDocument();
  80     virtual ~SPDocument();
  81
  82     unsigned int keepalive : 1;
  83     unsigned int virgin    : 1; ///< Has the document never been touched?
  84     unsigned int modified_since_save : 1;
  85
  86     Inkscape::XML::Document *rdoc; ///< Our Inkscape::XML::Document
  87     Inkscape::XML::Node *rroot; ///< Root element of Inkscape::XML::Document
  88     SPObject *root;             ///< Our SPRoot
  89     CRCascade *style_cascade;
  90
  91     gchar *uri;   ///< A filename (not a URI yet), or NULL
  92     gchar *base;  ///< To be used for resolving relative hrefs.
  93     gchar *name;  ///< basename(uri) or other human-readable label for the document.
  94
  95     SPDocumentPrivate *priv;
  96
  97     /// Last action key
  98     const gchar *actionkey;
  99     /// Handler ID
 100     guint modified_id;
 101
 102     Inkscape::ProfileManager* profileManager;
 103
 104     // Instance of the connector router
 105     Avoid::Router *router;
 106
 107     GSList *perspectives;
 108
 109     Persp3D *current_persp3d; // "currently active" perspective (e.g., newly created boxes are attached to this one)
 110
 111     GSList *_collection_queue;
 112
 113     bool oldSignalsConnected;
 114
 115     void add_persp3d(Persp3D * const persp);
 116     void remove_persp3d(Persp3D * const persp);
 117     void initialize_current_persp3d();
 118
 119     sigc::connection connectModified(ModifiedSignal::slot_type slot);
 120     sigc::connection connectURISet(URISetSignal::slot_type slot);
 121     sigc::connection connectResized(ResizedSignal::slot_type slot);
 122 sigc::connection connectCommit(CommitSignal::slot_type slot);
 123
 124     void bindObjectToId(gchar const *id, SPObject *object);
 125     SPObject *getObjectById(gchar const *id);
 126     sigc::connection connectIdChanged(const gchar *id, IDChangedSignal::slot_type slot);
 127
 128     void bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object);
 129     SPObject *getObjectByRepr(Inkscape::XML::Node *repr);
 130
 131     Glib::ustring getLanguage();
 132
 133     void queueForOrphanCollection(SPObject *object);
 134     void collectOrphans();
 135
 136     void _emitModified();
 137
 138     void addUndoObserver(Inkscape::UndoStackObserver& observer);
 139     void removeUndoObserver(Inkscape::UndoStackObserver& observer);
 140
 141     bool _updateDocument();
 142
 143     /// Are we currently in a transition between two "known good" states of the document?
 144     bool isSeeking() const;
 145
 146     bool isModifiedSinceSave() const { return modified_since_save; }
 147     void setModifiedSinceSave(bool modified = true) {
 148         modified_since_save = modified;
 149     }
 150
 151 private:
 152     SPDocument(SPDocument const &); // no copy
 153     void operator=(SPDocument const &); // no assign
 154
 155 public:
 156     sigc::connection connectReconstructionStart(ReconstructionStart::slot_type slot);
 157     sigc::connection connectReconstructionFinish(ReconstructionFinish::slot_type slot);
 158     void emitReconstructionStart(void);
 159     void emitReconstructionFinish(void);
 160
 161     unsigned long serial() const;
 162     void reset_key(void *dummy);
 163     sigc::connection _selection_changed_connection;
 164     sigc::connection _desktop_activated_connection;
 165
 166     void fitToRect(Geom::Rect const &rect);
 167 };
 168
 169 SPDocument *sp_document_new(const gchar *uri, unsigned int keepalive, bool make_new = false);
 170 SPDocument *sp_document_new_from_mem(const gchar *buffer, gint length, unsigned int keepalive);
 171
 172 SPDocument *sp_document_ref(SPDocument *doc);
 173 SPDocument *sp_document_unref(SPDocument *doc);
 174
 175
 176 SPDocument *sp_document_create(Inkscape::XML::Document *rdoc, gchar const *uri, gchar const *base, gchar const *name, unsigned int keepalive);
 177
 178 /*
 179  * Access methods
 180  */
 181
 182 #define sp_document_repr_doc(d) (d->rdoc)
 183 #define sp_document_repr_root(d) (d->rroot)
 184 #define sp_document_root(d) (d->root)
 185 #define SP_DOCUMENT_ROOT(d) (d->root)
 186
 187 gdouble sp_document_width(SPDocument *document);
 188 gdouble sp_document_height(SPDocument *document);
 189 Geom::Point sp_document_dimensions(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, gchar const *uri);
 269 void sp_document_change_uri_and_hrefs(SPDocument *document, gchar const *uri);
 270
 271 void sp_document_resized_signal_emit(SPDocument *doc, gdouble width, gdouble height);
 272
 273 unsigned int vacuum_document(SPDocument *document);
 274
 275
 276 #endif
 277
 278 /*
 279   Local Variables:
 280   mode:c++
 281   c-file-style:"stroustrup"
 282   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 283   indent-tabs-mode:nil
 284   fill-column:99
 285   End:
 286 */
 287 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :