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; ///< URI string or NULL
  92     gchar *base;
  93     gchar *name;
  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     void add_persp3d (Persp3D * const persp);
 114     void remove_persp3d (Persp3D * const persp);
 115
 116     sigc::connection connectModified(ModifiedSignal::slot_type slot);
 117     sigc::connection connectURISet(URISetSignal::slot_type slot);
 118     sigc::connection connectResized(ResizedSignal::slot_type slot);
 119 sigc::connection connectCommit(CommitSignal::slot_type slot);
 120
 121     void bindObjectToId(gchar const *id, SPObject *object);
 122     SPObject *getObjectById(gchar const *id);
 123     sigc::connection connectIdChanged(const gchar *id, IDChangedSignal::slot_type slot);
 124
 125     void bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object);
 126     SPObject *getObjectByRepr(Inkscape::XML::Node *repr);
 127
 128     Glib::ustring getLanguage();
 129
 130     void queueForOrphanCollection(SPObject *object);
 131     void collectOrphans();
 132
 133     void _emitModified();
 134
 135     void addUndoObserver(Inkscape::UndoStackObserver& observer);
 136     void removeUndoObserver(Inkscape::UndoStackObserver& observer);
 137
 138     bool _updateDocument();
 139
 140     /// Are we currently in a transition between two "known good" states of the document?
 141     bool isSeeking() const;
 142
 143     bool isModifiedSinceSave() const { return modified_since_save; }
 144     void setModifiedSinceSave(bool modified = true) {
 145         modified_since_save = modified;
 146     }
 147
 148 private:
 149     SPDocument(SPDocument const &); // no copy
 150     void operator=(SPDocument const &); // no assign
 151
 152 public:
 153     sigc::connection connectReconstructionStart(ReconstructionStart::slot_type slot);
 154     sigc::connection connectReconstructionFinish (ReconstructionFinish::slot_type  slot);
 155     void emitReconstructionStart (void);
 156     void emitReconstructionFinish  (void);
 157
 158     unsigned long serial() const;
 159     void reset_key (void *dummy);
 160     sigc::connection _selection_changed_connection;
 161     sigc::connection _desktop_activated_connection;
 162
 163     void fitToRect(Geom::Rect const &rect);
 164 };
 165
 166 SPDocument *sp_document_new (const gchar *uri, unsigned int keepalive, bool make_new = false);
 167 SPDocument *sp_document_new_from_mem (const gchar *buffer, gint length, unsigned int keepalive);
 168
 169 SPDocument *sp_document_ref (SPDocument *doc);
 170 SPDocument *sp_document_unref (SPDocument *doc);
 171
 172
 173 SPDocument *sp_document_create(Inkscape::XML::Document *rdoc, gchar const *uri, gchar const *base, gchar const *name, unsigned int keepalive);
 174
 175 /*
 176  * Access methods
 177  */
 178
 179 #define sp_document_repr_doc(d) (d->rdoc)
 180 #define sp_document_repr_root(d) (d->rroot)
 181 #define sp_document_root(d) (d->root)
 182 #define SP_DOCUMENT_ROOT(d)  (d->root)
 183
 184 gdouble sp_document_width (SPDocument * document);
 185 gdouble sp_document_height (SPDocument * document);
 186 Geom::Point sp_document_dimensions (SPDocument * document);
 187
 188 struct SPUnit;
 189
 190 void sp_document_set_width (SPDocument * document, gdouble width, const SPUnit *unit);
 191 void sp_document_set_height (SPDocument * document, gdouble height, const SPUnit *unit);
 192
 193 #define SP_DOCUMENT_URI(d) (d->uri)
 194 #define SP_DOCUMENT_NAME(d) (d->name)
 195 #define SP_DOCUMENT_BASE(d) (d->base)
 196
 197 /*
 198  * Dictionary
 199  */
 200
 201 /*
 202  * Undo & redo
 203  */
 204
 205 void sp_document_set_undo_sensitive (SPDocument * document, bool sensitive);
 206 bool sp_document_get_undo_sensitive (SPDocument const * document);
 207
 208 void sp_document_clear_undo (SPDocument * document);
 209 void sp_document_clear_redo (SPDocument * document);
 210
 211 void sp_document_child_added (SPDocument *doc, SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref);
 212 void sp_document_child_removed (SPDocument *doc, SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref);
 213 void sp_document_attr_changed (SPDocument *doc, SPObject *object, const gchar *key, const gchar *oldval, const gchar *newval);
 214 void sp_document_content_changed (SPDocument *doc, SPObject *object, const gchar *oldcontent, const gchar *newcontent);
 215 void sp_document_order_changed (SPDocument *doc, SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *oldref, Inkscape::XML::Node *newref);
 216
 217 /* Object modification root handler */
 218 void sp_document_request_modified (SPDocument *doc);
 219 gint sp_document_ensure_up_to_date (SPDocument *doc);
 220
 221 /* Save all previous actions to stack, as one undo step */
 222 void sp_document_done (SPDocument *document, unsigned int event_type, Glib::ustring event_description);
 223 void sp_document_maybe_done (SPDocument *document, const gchar *keyconst, unsigned int event_type, Glib::ustring event_description);
 224 void sp_document_reset_key (Inkscape::Application *inkscape, SPDesktop *desktop, GtkObject *base);
 225
 226 /* Cancel (and revert) current unsaved actions */
 227 void sp_document_cancel (SPDocument *document);
 228
 229 /* Undo and redo */
 230 gboolean sp_document_undo (SPDocument * document);
 231 gboolean sp_document_redo (SPDocument * document);
 232
 233 /* Resource management */
 234 gboolean sp_document_add_resource (SPDocument *document, const gchar *key, SPObject *object);
 235 gboolean sp_document_remove_resource (SPDocument *document, const gchar *key, SPObject *object);
 236 const GSList *sp_document_get_resource_list (SPDocument *document, const gchar *key);
 237 sigc::connection sp_document_resources_changed_connect(SPDocument *document, const gchar *key, SPDocument::ResourcesChangedSignal::slot_type slot);
 238
 239
 240 /*
 241  * Ideas: How to overcome style invalidation nightmare
 242  *
 243  * 1. There is reference request dictionary, that contains
 244  * objects (styles) needing certain id. Object::build checks
 245  * final id against it, and invokes necesary methods
 246  *
 247  * 2. Removing referenced object is simply prohibited -
 248  * needs analyse, how we can deal with situations, where
 249  * we simply want to ungroup etc. - probably we need
 250  * Repr::reparent method :( [Or was it ;)]
 251  *
 252  */
 253
 254 /*
 255  * Misc
 256  */
 257
 258 GSList * sp_document_items_in_box(SPDocument *document, unsigned int dkey, Geom::Rect const &box);
 259 GSList * sp_document_partial_items_in_box(SPDocument *document, unsigned int dkey, Geom::Rect const &box);
 260 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);
 261 SPItem * sp_document_item_at_point (SPDocument *document, unsigned int key, Geom::Point const p, gboolean into_groups, SPItem *upto = NULL);
 262 GSList *sp_document_items_at_points(SPDocument *document, unsigned const key, std::vector<Geom::Point> points);
 263 SPItem *sp_document_group_at_point (SPDocument *document, unsigned int key,  Geom::Point const p);
 264
 265 void sp_document_set_uri (SPDocument *document, const gchar *uri);
 266 void sp_document_resized_signal_emit (SPDocument *doc, gdouble width, gdouble height);
 267
 268 unsigned int vacuum_document (SPDocument *document);
 269
 270 #endif
 271
 272 /*
 273   Local Variables:
 274   mode:c++
 275   c-file-style:"stroustrup"
 276   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 277   indent-tabs-mode:nil
 278   fill-column:99
 279   End:
 280 */
 281 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :