Code

switch to sigc++ signal for "release"
[inkscape.git] / src / document.cpp
1 #define __SP_DOCUMENT_C__
3 /** \file
4  * SPDocument manipulation
5  *
6  * Authors:
7  *   Lauris Kaplinski <lauris@kaplinski.com>
8  *   MenTaLguY <mental@rydia.net>
9  *   bulia byak <buliabyak@users.sf.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  */
18 /** \class SPDocument
19  * SPDocument serves as the container of both model trees (agnostic XML
20  * and typed object tree), and implements all of the document-level
21  * functionality used by the program. Many document level operations, like
22  * load, save, print, export and so on, use SPDocument as their basic datatype.
23  *
24  * SPDocument implements undo and redo stacks and an id-based object
25  * dictionary.  Thanks to unique id attributes, the latter can be used to
26  * map from the XML tree back to the object tree.
27  *
28  * SPDocument performs the basic operations needed for asynchronous
29  * update notification (SPObject ::modified virtual method), and implements
30  * the 'modified' signal, as well.
31  */
34 #define noSP_DOCUMENT_DEBUG_IDLE
35 #define noSP_DOCUMENT_DEBUG_UNDO
37 #ifdef HAVE_CONFIG_H
38 # include "config.h"
39 #endif
40 #include <gtk/gtkmain.h>
41 #include "application/application.h"
42 #include "application/editor.h"
43 #include "libnr/nr-matrix-fns.h"
44 #include "xml/repr.h"
45 #include "helper/units.h"
46 #include "inkscape-private.h"
47 #include "inkscape_version.h"
48 #include "sp-object-repr.h"
49 #include "document-private.h"
50 #include "dir-util.h"
51 #include "unit-constants.h"
52 #include "prefs-utils.h"
53 #include "libavoid/router.h"
54 #include "libnr/nr-rect.h"
55 #include "sp-item-group.h"
57 #include "display/nr-arena-item.h"
59 #include "dialogs/rdf.h"
61 #define A4_WIDTH_STR "210mm"
62 #define A4_HEIGHT_STR "297mm"
64 #define SP_DOCUMENT_UPDATE_PRIORITY (G_PRIORITY_HIGH_IDLE - 1)
67 static gint sp_document_idle_handler(gpointer data);
69 gboolean sp_document_resource_list_free(gpointer key, gpointer value, gpointer data);
71 static gint doc_count = 0;
73 SPDocument::SPDocument() {
74     SPDocumentPrivate *p;
76     keepalive = FALSE;
77     virgin    = TRUE;
79     modified_id = 0;
81     rdoc = NULL;
82     rroot = NULL;
83     root = NULL;
84     style_cascade = cr_cascade_new(NULL, NULL, NULL);
86     uri = NULL;
87     base = NULL;
88     name = NULL;
90     _collection_queue = NULL;
92     // Initialise instance of connector router.
93     router = new Avoid::Router();
94     // Don't use the Consolidate moves optimisation.
95     router->ConsolidateMoves = false;
97     p = new SPDocumentPrivate();
99     p->iddef = g_hash_table_new(g_direct_hash, g_direct_equal);
100     p->reprdef = g_hash_table_new(g_direct_hash, g_direct_equal);
102     p->resources = g_hash_table_new(g_str_hash, g_str_equal);
104     p->sensitive = FALSE;
105     p->partial = NULL;
106     p->history_size = 0;
107     p->undo = NULL;
108     p->redo = NULL;
110     p->undoStackObservers.add(p->event_log);
111     p->event_log.setDocument(this);
113     priv = p;
115     // XXX only for testing!
116     priv->undoStackObservers.add(p->console_output_undo_observer);
119 SPDocument::~SPDocument() {
120     collectOrphans();
122     if (priv) {
123         inkscape_remove_document(this);
125         if (priv->partial) {
126             sp_repr_free_log(priv->partial);
127             priv->partial = NULL;
128         }
130         sp_document_clear_redo(this);
131         sp_document_clear_undo(this);
133         if (root) {
134             root->releaseReferences();
135             sp_object_unref(root);
136             root = NULL;
137         }
139         if (priv->iddef) g_hash_table_destroy(priv->iddef);
140         if (priv->reprdef) g_hash_table_destroy(priv->reprdef);
142         if (rdoc) Inkscape::GC::release(rdoc);
144         /* Free resources */
145         g_hash_table_foreach_remove(priv->resources, sp_document_resource_list_free, this);
146         g_hash_table_destroy(priv->resources);
148         delete priv;
149         priv = NULL;
150     }
152     cr_cascade_unref(style_cascade);
153     style_cascade = NULL;
155     if (name) {
156         g_free(name);
157         name = NULL;
158     }
159     if (base) {
160         g_free(base);
161         base = NULL;
162     }
163     if (uri) {
164         g_free(uri);
165         uri = NULL;
166     }
168     if (modified_id) {
169         gtk_idle_remove(modified_id);
170         modified_id = 0;
171     }
173     _selection_changed_connection.disconnect();
174     _desktop_activated_connection.disconnect();
176     if (keepalive) {
177         inkscape_unref();
178         keepalive = FALSE;
179     }
181     if (router) {
182         delete router;
183         router = NULL;
184     }
186     //delete this->_whiteboard_session_manager;
189 void SPDocument::queueForOrphanCollection(SPObject *object) {
190     g_return_if_fail(object != NULL);
191     g_return_if_fail(SP_OBJECT_DOCUMENT(object) == this);
193     sp_object_ref(object, NULL);
194     _collection_queue = g_slist_prepend(_collection_queue, object);
197 void SPDocument::collectOrphans() {
198     while (_collection_queue) {
199         GSList *objects=_collection_queue;
200         _collection_queue = NULL;
201         for ( GSList *iter=objects ; iter ; iter = iter->next ) {
202             SPObject *object=reinterpret_cast<SPObject *>(iter->data);
203             object->collectOrphan();
204             sp_object_unref(object, NULL);
205         }
206         g_slist_free(objects);
207     }
210 void SPDocument::reset_key (void *dummy)
212     actionkey = NULL;
215 SPDocument *
216 sp_document_create(Inkscape::XML::Document *rdoc,
217                    gchar const *uri,
218                    gchar const *base,
219                    gchar const *name,
220                    unsigned int keepalive)
222     SPDocument *document;
223     Inkscape::XML::Node *rroot;
224     Inkscape::Version sodipodi_version;
226     rroot = sp_repr_document_root(rdoc);
228     document = new SPDocument();
230     document->keepalive = keepalive;
232     document->rdoc = rdoc;
233     document->rroot = rroot;
235 #ifndef WIN32
236     prepend_current_dir_if_relative(&(document->uri), uri);
237 #else
238     // FIXME: it may be that prepend_current_dir_if_relative works OK on windows too, test!
239     document->uri = uri? g_strdup(uri) : NULL;
240 #endif
242     // base is simply the part of the path before filename; e.g. when running "inkscape ../file.svg" the base is "../"
243     // which is why we use g_get_current_dir() in calculating the abs path above
244     //This is NULL for a new document
245     if (base)
246         document->base = g_strdup(base);
247     else
248         document->base = NULL;
249     document->name = g_strdup(name);
251     document->root = sp_object_repr_build_tree(document, rroot);
253     sodipodi_version = SP_ROOT(document->root)->version.sodipodi;
255     /* fixme: Not sure about this, but lets assume ::build updates */
256     rroot->setAttribute("sodipodi:version", SODIPODI_VERSION);
257     rroot->setAttribute("inkscape:version", INKSCAPE_VERSION);
258     /* fixme: Again, I moved these here to allow version determining in ::build (Lauris) */
260     /* Quick hack 2 - get default image size into document */
261     if (!rroot->attribute("width")) rroot->setAttribute("width", A4_WIDTH_STR);
262     if (!rroot->attribute("height")) rroot->setAttribute("height", A4_HEIGHT_STR);
263     /* End of quick hack 2 */
265     /* Quick hack 3 - Set uri attributes */
266     if (uri) {
267         /* fixme: Think, what this means for images (Lauris) */
268         rroot->setAttribute("sodipodi:docname", uri);
269         if (document->base)
270             rroot->setAttribute("sodipodi:docbase", document->base);
271     }
272     /* End of quick hack 3 */
274     // creating namedview
275     if (!sp_item_group_get_child_by_name((SPGroup *) document->root, NULL, "sodipodi:namedview")) {
276         // if there's none in the document already,
277         Inkscape::XML::Node *r = NULL;
278         Inkscape::XML::Node *rnew = NULL;
279         r = inkscape_get_repr(INKSCAPE, "template.base");
280         // see if there's a template with id="base" in the preferences
281         if (!r) {
282             // if there's none, create an empty element
283             rnew = sp_repr_new("sodipodi:namedview");
284             rnew->setAttribute("id", "base");
285         } else {
286             // otherwise, take from preferences
287             rnew = r->duplicate();
288         }
289         // insert into the document
290         rroot->addChild(rnew, NULL);
291         // clean up
292         Inkscape::GC::release(rnew);
293     }
295     /* Defs */
296     if (!SP_ROOT(document->root)->defs) {
297         Inkscape::XML::Node *r;
298         r = sp_repr_new("svg:defs");
299         rroot->addChild(r, NULL);
300         Inkscape::GC::release(r);
301         g_assert(SP_ROOT(document->root)->defs);
302     }
304     /* Default RDF */
305     rdf_set_defaults( document );
307     if (keepalive) {
308         inkscape_ref();
309     }
311     sp_document_set_undo_sensitive(document, TRUE);
313     // reset undo key when selection changes, so that same-key actions on different objects are not coalesced
314     if (!Inkscape::NSApplication::Application::getNewGui()) {
315         g_signal_connect(G_OBJECT(INKSCAPE), "change_selection",
316                          G_CALLBACK(sp_document_reset_key), document);
317         g_signal_connect(G_OBJECT(INKSCAPE), "activate_desktop",
318                          G_CALLBACK(sp_document_reset_key), document);
319     } else {
320         document->_selection_changed_connection = Inkscape::NSApplication::Editor::connectSelectionChanged (sigc::mem_fun (*document, &SPDocument::reset_key));
321         document->_desktop_activated_connection = Inkscape::NSApplication::Editor::connectDesktopActivated (sigc::mem_fun (*document, &SPDocument::reset_key));
322     }
323     inkscape_add_document(document);
325     return document;
328 /**
329  * Fetches document from URI, or creates new, if NULL; public document
330  * appears in document list.
331  */
332 SPDocument *
333 sp_document_new(gchar const *uri, unsigned int keepalive, bool make_new)
335     SPDocument *doc;
336     Inkscape::XML::Document *rdoc;
337     gchar *base = NULL;
338     gchar *name = NULL;
340     if (uri) {
341         Inkscape::XML::Node *rroot;
342         gchar *s, *p;
343         /* Try to fetch repr from file */
344         rdoc = sp_repr_read_file(uri, SP_SVG_NS_URI);
345         /* If file cannot be loaded, return NULL without warning */
346         if (rdoc == NULL) return NULL;
347         rroot = sp_repr_document_root(rdoc);
348         /* If xml file is not svg, return NULL without warning */
349         /* fixme: destroy document */
350         if (strcmp(rroot->name(), "svg:svg") != 0) return NULL;
351         s = g_strdup(uri);
352         p = strrchr(s, '/');
353         if (p) {
354             name = g_strdup(p + 1);
355             p[1] = '\0';
356             base = g_strdup(s);
357         } else {
358             base = NULL;
359             name = g_strdup(uri);
360         }
361         g_free(s);
362     } else {
363         rdoc = sp_repr_document_new("svg:svg");
364     }
366     if (make_new) {
367         base = NULL;
368         uri = NULL;
369         name = g_strdup_printf(_("New document %d"), ++doc_count);
370     }
372     //# These should be set by now
373     g_assert(name);
375     doc = sp_document_create(rdoc, uri, base, name, keepalive);
377     g_free(base);
378     g_free(name);
380     return doc;
383 SPDocument *
384 sp_document_new_from_mem(gchar const *buffer, gint length, unsigned int keepalive)
386     SPDocument *doc;
387     Inkscape::XML::Document *rdoc;
388     Inkscape::XML::Node *rroot;
389     gchar *name;
391     rdoc = sp_repr_read_mem(buffer, length, SP_SVG_NS_URI);
393     /* If it cannot be loaded, return NULL without warning */
394     if (rdoc == NULL) return NULL;
396     rroot = sp_repr_document_root(rdoc);
397     /* If xml file is not svg, return NULL without warning */
398     /* fixme: destroy document */
399     if (strcmp(rroot->name(), "svg:svg") != 0) return NULL;
401     name = g_strdup_printf(_("Memory document %d"), ++doc_count);
403     doc = sp_document_create(rdoc, NULL, NULL, name, keepalive);
405     return doc;
408 SPDocument *sp_document_new_dummy() {
409     SPDocument *document = new SPDocument();
410     inkscape_add_document(document);
411     return document;
414 SPDocument *
415 sp_document_ref(SPDocument *doc)
417     g_return_val_if_fail(doc != NULL, NULL);
418     Inkscape::GC::anchor(doc);
419     return doc;
422 SPDocument *
423 sp_document_unref(SPDocument *doc)
425     g_return_val_if_fail(doc != NULL, NULL);
426     Inkscape::GC::release(doc);
427     return NULL;
430 gdouble sp_document_width(SPDocument *document)
432     g_return_val_if_fail(document != NULL, 0.0);
433     g_return_val_if_fail(document->priv != NULL, 0.0);
434     g_return_val_if_fail(document->root != NULL, 0.0);
436     return SP_ROOT(document->root)->width.computed;
439 void
440 sp_document_set_width (SPDocument *document, gdouble width, const SPUnit *unit)
442     SPRoot *root = SP_ROOT(document->root);
444     if (root->width.unit == SVGLength::PERCENT && root->viewBox_set) { // set to viewBox=
445         root->viewBox.x1 = root->viewBox.x0 + sp_units_get_pixels (width, *unit);
446     } else { // set to width=
447         root->width.computed = sp_units_get_pixels (width, *unit);
448         /* SVG does not support meters as a unit, so we must translate meters to
449          * cm when writing */
450         if (!strcmp(unit->abbr, "m")) {
451             root->width.value = 100*width;
452             root->width.unit = SVGLength::CM;
453         } else {
454             root->width.value = width;
455             root->width.unit = (SVGLength::Unit) sp_unit_get_svg_unit(unit);
456         }
457     }
459     SP_OBJECT (root)->updateRepr();
462 void sp_document_set_height (SPDocument * document, gdouble height, const SPUnit *unit)
464     SPRoot *root = SP_ROOT(document->root);
466     if (root->height.unit == SVGLength::PERCENT && root->viewBox_set) { // set to viewBox=
467         root->viewBox.y1 = root->viewBox.y0 + sp_units_get_pixels (height, *unit);
468     } else { // set to height=
469         root->height.computed = sp_units_get_pixels (height, *unit);
470         /* SVG does not support meters as a unit, so we must translate meters to
471          * cm when writing */
472         if (!strcmp(unit->abbr, "m")) {
473             root->height.value = 100*height;
474             root->height.unit = SVGLength::CM;
475         } else {
476             root->height.value = height;
477             root->height.unit = (SVGLength::Unit) sp_unit_get_svg_unit(unit);
478         }
479     }
481     SP_OBJECT (root)->updateRepr();
484 gdouble sp_document_height(SPDocument *document)
486     g_return_val_if_fail(document != NULL, 0.0);
487     g_return_val_if_fail(document->priv != NULL, 0.0);
488     g_return_val_if_fail(document->root != NULL, 0.0);
490     return SP_ROOT(document->root)->height.computed;
493 /**
494  * Given an NRRect that may, for example, correspond to the bbox of an object
495  * this function fits the canvas to that rect by resizing the canvas
496  * and translating the document root into position.
497  */
498 void SPDocument::fitToRect(NRRect const & rect)
500     g_return_if_fail(!empty(rect));
501     
502     gdouble w = rect.x1 - rect.x0;
503     gdouble h = rect.y1 - rect.y0;
504     gdouble old_height = sp_document_height(this);
505     SPUnit unit = sp_unit_get_by_id(SP_UNIT_PX);
506     sp_document_set_width(this, w, &unit);
507     sp_document_set_height(this, h, &unit);
509     NR::translate tr = NR::translate::translate(-rect.x0,-(rect.y0 + (h - old_height)));
510     static_cast<SPGroup *>(root)->translateChildItems(tr);
513 void sp_document_set_uri(SPDocument *document, gchar const *uri)
515     g_return_if_fail(document != NULL);
517     if (document->name) {
518         g_free(document->name);
519         document->name = NULL;
520     }
521     if (document->base) {
522         g_free(document->base);
523         document->base = NULL;
524     }
525     if (document->uri) {
526         g_free(document->uri);
527         document->uri = NULL;
528     }
530     if (uri) {
532 #ifndef WIN32
533         prepend_current_dir_if_relative(&(document->uri), uri);
534 #else
535         // FIXME: it may be that prepend_current_dir_if_relative works OK on windows too, test!
536         document->uri = g_strdup(uri);
537 #endif
539         /* fixme: Think, what this means for images (Lauris) */
540         document->base = g_path_get_dirname(document->uri);
541         document->name = g_path_get_basename(document->uri);
543     } else {
544         document->uri = g_strdup_printf(_("Unnamed document %d"), ++doc_count);
545         document->base = NULL;
546         document->name = g_strdup(document->uri);
547     }
549     // Update saveable repr attributes.
550     Inkscape::XML::Node *repr = sp_document_repr_root(document);
551     // changing uri in the document repr must not be not undoable
552     gboolean saved = sp_document_get_undo_sensitive(document);
553     sp_document_set_undo_sensitive(document, FALSE);
554     if (document->base)
555         repr->setAttribute("sodipodi:docbase", document->base);
557     repr->setAttribute("sodipodi:docname", document->name);
558     sp_document_set_undo_sensitive(document, saved);
560     document->priv->uri_set_signal.emit(document->uri);
563 void
564 sp_document_resized_signal_emit(SPDocument *doc, gdouble width, gdouble height)
566     g_return_if_fail(doc != NULL);
568     doc->priv->resized_signal.emit(width, height);
571 sigc::connection SPDocument::connectModified(SPDocument::ModifiedSignal::slot_type slot)
573     return priv->modified_signal.connect(slot);
576 sigc::connection SPDocument::connectURISet(SPDocument::URISetSignal::slot_type slot)
578     return priv->uri_set_signal.connect(slot);
581 sigc::connection SPDocument::connectResized(SPDocument::ResizedSignal::slot_type slot)
583     return priv->resized_signal.connect(slot);
586 sigc::connection
587 SPDocument::connectReconstructionStart(SPDocument::ReconstructionStart::slot_type slot)
589     return priv->_reconstruction_start_signal.connect(slot);
592 void
593 SPDocument::emitReconstructionStart(void)
595     // printf("Starting Reconstruction\n");
596     priv->_reconstruction_start_signal.emit();
597     return;
600 sigc::connection
601 SPDocument::connectReconstructionFinish(SPDocument::ReconstructionFinish::slot_type  slot)
603     return priv->_reconstruction_finish_signal.connect(slot);
606 void
607 SPDocument::emitReconstructionFinish(void)
609     // printf("Finishing Reconstruction\n");
610     priv->_reconstruction_finish_signal.emit();
611     return;
615 void SPDocument::_emitModified() {
616     static guint const flags = SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG | SP_OBJECT_PARENT_MODIFIED_FLAG;
617     root->emitModified(0);
618     priv->modified_signal.emit(flags);
621 void SPDocument::bindObjectToId(gchar const *id, SPObject *object) {
622     GQuark idq = g_quark_from_string(id);
624     if (object) {
625         g_assert(g_hash_table_lookup(priv->iddef, GINT_TO_POINTER(idq)) == NULL);
626         g_hash_table_insert(priv->iddef, GINT_TO_POINTER(idq), object);
627     } else {
628         g_assert(g_hash_table_lookup(priv->iddef, GINT_TO_POINTER(idq)) != NULL);
629         g_hash_table_remove(priv->iddef, GINT_TO_POINTER(idq));
630     }
632     SPDocumentPrivate::IDChangedSignalMap::iterator pos;
634     pos = priv->id_changed_signals.find(idq);
635     if ( pos != priv->id_changed_signals.end() ) {
636         if (!(*pos).second.empty()) {
637             (*pos).second.emit(object);
638         } else { // discard unused signal
639             priv->id_changed_signals.erase(pos);
640         }
641     }
644 void
645 SPDocument::addUndoObserver(Inkscape::UndoStackObserver& observer)
647         this->priv->undoStackObservers.add(observer);
650 void
651 SPDocument::removeUndoObserver(Inkscape::UndoStackObserver& observer)
653         this->priv->undoStackObservers.remove(observer);
656 Inkscape::EventLog&
657 SPDocument::getEventLog() const
659   return priv->event_log;
662 SPObject *SPDocument::getObjectById(gchar const *id) {
663     g_return_val_if_fail(id != NULL, NULL);
665     GQuark idq = g_quark_from_string(id);
666     return (SPObject*)g_hash_table_lookup(priv->iddef, GINT_TO_POINTER(idq));
669 sigc::connection SPDocument::connectIdChanged(gchar const *id,
670                                               SPDocument::IDChangedSignal::slot_type slot)
672     return priv->id_changed_signals[g_quark_from_string(id)].connect(slot);
675 void SPDocument::bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object) {
676     if (object) {
677         g_assert(g_hash_table_lookup(priv->reprdef, repr) == NULL);
678         g_hash_table_insert(priv->reprdef, repr, object);
679     } else {
680         g_assert(g_hash_table_lookup(priv->reprdef, repr) != NULL);
681         g_hash_table_remove(priv->reprdef, repr);
682     }
685 SPObject *SPDocument::getObjectByRepr(Inkscape::XML::Node *repr) {
686     g_return_val_if_fail(repr != NULL, NULL);
687     return (SPObject*)g_hash_table_lookup(priv->reprdef, repr);
690 Glib::ustring SPDocument::getLanguage() {
691     gchar const *document_language = rdf_get_work_entity(this, rdf_find_entity("language"));
692     if (document_language) {
693         while (isspace(*document_language))
694             document_language++;
695     }
696     if ( !document_language || 0 == *document_language) {
697         // retrieve system language
698         document_language = getenv("LC_ALL");
699         if ( NULL == document_language || *document_language == 0 ) {
700             document_language = getenv ("LC_MESSAGES");
701         }
702         if ( NULL == document_language || *document_language == 0 ) {
703             document_language = getenv ("LANG");
704         }
705         
706         if ( NULL != document_language ) {
707             gchar *pos = strchr(document_language, '_');
708             if ( NULL != pos ) {
709                 return Glib::ustring(document_language, pos - document_language);
710             }
711         }
712     }
714     if ( NULL == document_language )
715         return Glib::ustring();
716     return document_language;
719 /* Object modification root handler */
721 void
722 sp_document_request_modified(SPDocument *doc)
724     if (!doc->modified_id) {
725         doc->modified_id = gtk_idle_add_priority(SP_DOCUMENT_UPDATE_PRIORITY, sp_document_idle_handler, doc);
726     }
729 void
730 sp_document_setup_viewport (SPDocument *doc, SPItemCtx *ctx)
732     ctx->ctx.flags = 0;
733     ctx->i2doc = NR::identity();
734     /* Set up viewport in case svg has it defined as percentages */
735     if (SP_ROOT(doc->root)->viewBox_set) { // if set, take from viewBox
736         ctx->vp.x0 = SP_ROOT(doc->root)->viewBox.x0;
737         ctx->vp.y0 = SP_ROOT(doc->root)->viewBox.y0;
738         ctx->vp.x1 = SP_ROOT(doc->root)->viewBox.x1;
739         ctx->vp.y1 = SP_ROOT(doc->root)->viewBox.y1;
740     } else { // as a last resort, set size to A4
741         ctx->vp.x0 = 0.0;
742         ctx->vp.y0 = 0.0;
743         ctx->vp.x1 = 210 * PX_PER_MM;
744         ctx->vp.y1 = 297 * PX_PER_MM;
745     }
746     ctx->i2vp = NR::identity();
749 /**
750  * Tries to update the document state based on the modified and 
751  * "update required" flags, and return true if the document has
752  * been brought fully up to date.
753  */
754 bool
755 SPDocument::_updateDocument()
757     /* Process updates */
758     if (this->root->uflags || this->root->mflags) {
759         if (this->root->uflags) {
760             SPItemCtx ctx;
761             sp_document_setup_viewport (this, &ctx);
763             bool saved = sp_document_get_undo_sensitive(this);
764             sp_document_set_undo_sensitive(this, FALSE);
766             this->root->updateDisplay((SPCtx *)&ctx, 0);
768             sp_document_set_undo_sensitive(this, saved);
769         }
770         this->_emitModified();
771     }
773     return !(this->root->uflags || this->root->mflags);
777 /**
778  * Repeatedly works on getting the document updated, since sometimes
779  * it takes more than one pass to get the document updated.  But it
780  * usually should not take more than a few loops, and certainly never
781  * more than 32 iterations.  So we bail out if we hit 32 iterations,
782  * since this typically indicates we're stuck in an update loop.
783  */
784 gint
785 sp_document_ensure_up_to_date(SPDocument *doc)
787     int counter = 32;
788     while (!doc->_updateDocument()) {
789         if (counter == 0) {
790             g_warning("More than 32 iteration while updating document '%s'", doc->uri);
791             break;
792         }
793         counter--;
794     }
796     if (doc->modified_id) {
797         /* Remove handler */
798         gtk_idle_remove(doc->modified_id);
799         doc->modified_id = 0;
800     }
801     return counter>0;
804 /**
805  * An idle handler to update the document.  Returns true if
806  * the document needs further updates.
807  */
808 static gint
809 sp_document_idle_handler(gpointer data)
811     SPDocument *doc = static_cast<SPDocument *>(data);
812     if (doc->_updateDocument()) {
813         doc->modified_id = 0;
814         return false;
815     } else {
816         return true;
817     }
820 static bool is_within(NR::Rect const &area, NR::Rect const &box)
822     return area.contains(box);
825 static bool overlaps(NR::Rect const &area, NR::Rect const &box)
827     return area.intersects(box);
830 static GSList *find_items_in_area(GSList *s, SPGroup *group, unsigned int dkey, NR::Rect const &area,
831                                   bool (*test)(NR::Rect const &, NR::Rect const &), bool take_insensitive = false)
833     g_return_val_if_fail(SP_IS_GROUP(group), s);
835     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
836         if (!SP_IS_ITEM(o)) {
837             continue;
838         }
839         if (SP_IS_GROUP(o) && SP_GROUP(o)->effectiveLayerMode(dkey) == SPGroup::LAYER ) {
840             s = find_items_in_area(s, SP_GROUP(o), dkey, area, test);
841         } else {
842             SPItem *child = SP_ITEM(o);
843             NR::Rect box = sp_item_bbox_desktop(child);
844             if (test(area, box) && (take_insensitive || child->isVisibleAndUnlocked(dkey))) {
845                 s = g_slist_append(s, child);
846             }
847         }
848     }
850     return s;
853 /**
854 Returns true if an item is among the descendants of group (recursively).
855  */
856 bool item_is_in_group(SPItem *item, SPGroup *group)
858     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
859         if (!SP_IS_ITEM(o)) continue;
860         if (SP_ITEM(o) == item)
861             return true;
862         if (SP_IS_GROUP(o))
863             if (item_is_in_group(item, SP_GROUP(o)))
864                 return true;
865     }
866     return false;
869 /**
870 Returns the bottommost item from the list which is at the point, or NULL if none.
871 */
872 SPItem*
873 sp_document_item_from_list_at_point_bottom(unsigned int dkey, SPGroup *group, GSList const *list,
874                                            NR::Point const p, bool take_insensitive)
876     g_return_val_if_fail(group, NULL);
878     gdouble delta = prefs_get_double_attribute ("options.cursortolerance", "value", 1.0);
880     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
882         if (!SP_IS_ITEM(o)) continue;
884         SPItem *item = SP_ITEM(o);
885         NRArenaItem *arenaitem = sp_item_get_arenaitem(item, dkey);
886         if (arenaitem && nr_arena_item_invoke_pick(arenaitem, p, delta, 1) != NULL
887             && (take_insensitive || item->isVisibleAndUnlocked(dkey))) {
888             if (g_slist_find((GSList *) list, item) != NULL)
889                 return item;
890         }
892         if (SP_IS_GROUP(o)) {
893             SPItem *found = sp_document_item_from_list_at_point_bottom(dkey, SP_GROUP(o), list, p, take_insensitive);
894             if (found)
895                 return found;
896         }
898     }
899     return NULL;
902 /**
903 Returns the topmost (in z-order) item from the descendants of group (recursively) which
904 is at the point p, or NULL if none. Honors into_groups on whether to recurse into
905 non-layer groups or not. Honors take_insensitive on whether to return insensitive
906 items. If upto != NULL, then if item upto is encountered (at any level), stops searching
907 upwards in z-order and returns what it has found so far (i.e. the found item is
908 guaranteed to be lower than upto).
909  */
910 SPItem*
911 find_item_at_point(unsigned int dkey, SPGroup *group, NR::Point const p, gboolean into_groups, bool take_insensitive = false, SPItem *upto = NULL)
913     SPItem *seen = NULL, *newseen = NULL;
915     gdouble delta = prefs_get_double_attribute ("options.cursortolerance", "value", 1.0);
917     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
918         if (!SP_IS_ITEM(o)) continue;
920         if (upto && SP_ITEM(o) == upto)
921             break;
923         if (SP_IS_GROUP(o) && (SP_GROUP(o)->effectiveLayerMode(dkey) == SPGroup::LAYER || into_groups)) {
924             // if nothing found yet, recurse into the group
925             newseen = find_item_at_point(dkey, SP_GROUP(o), p, into_groups, take_insensitive, upto);
926             if (newseen) {
927                 seen = newseen;
928                 newseen = NULL;
929             }
931             if (item_is_in_group(upto, SP_GROUP(o)))
932                 break;
934         } else {
935             SPItem *child = SP_ITEM(o);
936             NRArenaItem *arenaitem = sp_item_get_arenaitem(child, dkey);
938             // seen remembers the last (topmost) of items pickable at this point
939             if (arenaitem && nr_arena_item_invoke_pick(arenaitem, p, delta, 1) != NULL
940                 && (take_insensitive || child->isVisibleAndUnlocked(dkey))) {
941                 seen = child;
942             }
943         }
944     }
945     return seen;
948 /**
949 Returns the topmost non-layer group from the descendants of group which is at point
950 p, or NULL if none. Recurses into layers but not into groups.
951  */
952 SPItem*
953 find_group_at_point(unsigned int dkey, SPGroup *group, NR::Point const p)
955     SPItem *seen = NULL;
957     gdouble delta = prefs_get_double_attribute ("options.cursortolerance", "value", 1.0);
959     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
960         if (!SP_IS_ITEM(o)) continue;
961         if (SP_IS_GROUP(o) && SP_GROUP(o)->effectiveLayerMode(dkey) == SPGroup::LAYER) {
962             SPItem *newseen = find_group_at_point(dkey, SP_GROUP(o), p);
963             if (newseen) {
964                 seen = newseen;
965             }
966         }
967         if (SP_IS_GROUP(o) && SP_GROUP(o)->effectiveLayerMode(dkey) != SPGroup::LAYER ) {
968             SPItem *child = SP_ITEM(o);
969             NRArenaItem *arenaitem = sp_item_get_arenaitem(child, dkey);
971             // seen remembers the last (topmost) of groups pickable at this point
972             if (arenaitem && nr_arena_item_invoke_pick(arenaitem, p, delta, 1) != NULL) {
973                 seen = child;
974             }
975         }
976     }
977     return seen;
980 /*
981  * Return list of items, contained in box
982  *
983  * Assumes box is normalized (and g_asserts it!)
984  *
985  */
987 GSList *sp_document_items_in_box(SPDocument *document, unsigned int dkey, NR::Rect const &box)
989     g_return_val_if_fail(document != NULL, NULL);
990     g_return_val_if_fail(document->priv != NULL, NULL);
992     return find_items_in_area(NULL, SP_GROUP(document->root), dkey, box, is_within);
995 /*
996  * Return list of items, that the parts of the item contained in box
997  *
998  * Assumes box is normalized (and g_asserts it!)
999  *
1000  */
1002 GSList *sp_document_partial_items_in_box(SPDocument *document, unsigned int dkey, NR::Rect const &box)
1004     g_return_val_if_fail(document != NULL, NULL);
1005     g_return_val_if_fail(document->priv != NULL, NULL);
1007     return find_items_in_area(NULL, SP_GROUP(document->root), dkey, box, overlaps);
1010 SPItem *
1011 sp_document_item_at_point(SPDocument *document, unsigned const key, NR::Point const p,
1012                           gboolean const into_groups, SPItem *upto)
1014     g_return_val_if_fail(document != NULL, NULL);
1015     g_return_val_if_fail(document->priv != NULL, NULL);
1017     return find_item_at_point(key, SP_GROUP(document->root), p, into_groups, false, upto);
1020 SPItem*
1021 sp_document_group_at_point(SPDocument *document, unsigned int key, NR::Point const p)
1023     g_return_val_if_fail(document != NULL, NULL);
1024     g_return_val_if_fail(document->priv != NULL, NULL);
1026     return find_group_at_point(key, SP_GROUP(document->root), p);
1030 /* Resource management */
1032 gboolean
1033 sp_document_add_resource(SPDocument *document, gchar const *key, SPObject *object)
1035     GSList *rlist;
1036     GQuark q = g_quark_from_string(key);
1038     g_return_val_if_fail(document != NULL, FALSE);
1039     g_return_val_if_fail(key != NULL, FALSE);
1040     g_return_val_if_fail(*key != '\0', FALSE);
1041     g_return_val_if_fail(object != NULL, FALSE);
1042     g_return_val_if_fail(SP_IS_OBJECT(object), FALSE);
1044     if (SP_OBJECT_IS_CLONED(object))
1045         return FALSE;
1047     rlist = (GSList*)g_hash_table_lookup(document->priv->resources, key);
1048     g_return_val_if_fail(!g_slist_find(rlist, object), FALSE);
1049     rlist = g_slist_prepend(rlist, object);
1050     g_hash_table_insert(document->priv->resources, (gpointer) key, rlist);
1052     document->priv->resources_changed_signals[q].emit();
1054     return TRUE;
1057 gboolean
1058 sp_document_remove_resource(SPDocument *document, gchar const *key, SPObject *object)
1060     GSList *rlist;
1061     GQuark q = g_quark_from_string(key);
1063     g_return_val_if_fail(document != NULL, FALSE);
1064     g_return_val_if_fail(key != NULL, FALSE);
1065     g_return_val_if_fail(*key != '\0', FALSE);
1066     g_return_val_if_fail(object != NULL, FALSE);
1067     g_return_val_if_fail(SP_IS_OBJECT(object), FALSE);
1069     if (SP_OBJECT_IS_CLONED(object))
1070         return FALSE;
1072     rlist = (GSList*)g_hash_table_lookup(document->priv->resources, key);
1073     g_return_val_if_fail(rlist != NULL, FALSE);
1074     g_return_val_if_fail(g_slist_find(rlist, object), FALSE);
1075     rlist = g_slist_remove(rlist, object);
1076     g_hash_table_insert(document->priv->resources, (gpointer) key, rlist);
1078     document->priv->resources_changed_signals[q].emit();
1080     return TRUE;
1083 GSList const *
1084 sp_document_get_resource_list(SPDocument *document, gchar const *key)
1086     g_return_val_if_fail(document != NULL, NULL);
1087     g_return_val_if_fail(key != NULL, NULL);
1088     g_return_val_if_fail(*key != '\0', NULL);
1090     return (GSList*)g_hash_table_lookup(document->priv->resources, key);
1093 sigc::connection sp_document_resources_changed_connect(SPDocument *document,
1094                                                        gchar const *key,
1095                                                        SPDocument::ResourcesChangedSignal::slot_type slot)
1097     GQuark q = g_quark_from_string(key);
1098     return document->priv->resources_changed_signals[q].connect(slot);
1101 /* Helpers */
1103 gboolean
1104 sp_document_resource_list_free(gpointer key, gpointer value, gpointer data)
1106     g_slist_free((GSList *) value);
1107     return TRUE;
1110 unsigned int
1111 count_objects_recursive(SPObject *obj, unsigned int count)
1113     count++; // obj itself
1115     for (SPObject *i = sp_object_first_child(obj); i != NULL; i = SP_OBJECT_NEXT(i)) {
1116         count = count_objects_recursive(i, count);
1117     }
1119     return count;
1122 unsigned int
1123 objects_in_document(SPDocument *document)
1125     return count_objects_recursive(SP_DOCUMENT_ROOT(document), 0);
1128 void
1129 vacuum_document_recursive(SPObject *obj)
1131     if (SP_IS_DEFS(obj)) {
1132         for (SPObject *def = obj->firstChild(); def; def = SP_OBJECT_NEXT(def)) {
1133             /* fixme: some inkscape-internal nodes in the future might not be collectable */
1134             def->requestOrphanCollection();
1135         }
1136     } else {
1137         for (SPObject *i = sp_object_first_child(obj); i != NULL; i = SP_OBJECT_NEXT(i)) {
1138             vacuum_document_recursive(i);
1139         }
1140     }
1143 unsigned int
1144 vacuum_document(SPDocument *document)
1146     unsigned int start = objects_in_document(document);
1147     unsigned int end;
1148     unsigned int newend = start;
1150     unsigned int iterations = 0;
1152     do {
1153         end = newend;
1155         vacuum_document_recursive(SP_DOCUMENT_ROOT(document));
1156         document->collectOrphans();
1157         iterations++;
1159         newend = objects_in_document(document);
1161     } while (iterations < 100 && newend < end);
1163     return start - newend;
1167 /*
1168   Local Variables:
1169   mode:c++
1170   c-file-style:"stroustrup"
1171   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1172   indent-tabs-mode:nil
1173   fill-column:99
1174   End:
1175 */
1176 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :