src/document.cpp

   1 #define __SP_DOCUMENT_C__
   2
   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  */
  17
  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  */
  32
  33
  34 #define noSP_DOCUMENT_DEBUG_IDLE
  35 #define noSP_DOCUMENT_DEBUG_UNDO
  36
  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"
  56
  57 #include "display/nr-arena-item.h"
  58
  59 #include "dialogs/rdf.h"
  60
  61 #define A4_WIDTH_STR "210mm"
  62 #define A4_HEIGHT_STR "297mm"
  63
  64 #define SP_DOCUMENT_UPDATE_PRIORITY (G_PRIORITY_HIGH_IDLE - 1)
  65
  66
  67 static gint sp_document_idle_handler(gpointer data);
  68
  69 gboolean sp_document_resource_list_free(gpointer key, gpointer value, gpointer data);
  70
  71 static gint doc_count = 0;
  72
  73 SPDocument::SPDocument() {
  74     SPDocumentPrivate *p;
  75
  76     keepalive = FALSE;
  77     virgin    = TRUE;
  78
  79     modified_id = 0;
  80
  81     rdoc = NULL;
  82     rroot = NULL;
  83     root = NULL;
  84     style_cascade = cr_cascade_new(NULL, NULL, NULL);
  85
  86     uri = NULL;
  87     base = NULL;
  88     name = NULL;
  89
  90     _collection_queue = NULL;
  91
  92     // Initialise instance of connector router.
  93     router = new Avoid::Router();
  94     // Don't use the Consolidate moves optimisation.
  95     router->ConsolidateMoves = false;
  96
  97     p = new SPDocumentPrivate();
  98
  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);
 101
 102     p->resources = g_hash_table_new(g_str_hash, g_str_equal);
 103
 104     p->sensitive = FALSE;
 105     p->partial = NULL;
 106     p->history_size = 0;
 107     p->undo = NULL;
 108     p->redo = NULL;
 109
 110     priv = p;
 111
 112     // XXX only for testing!
 113     priv->undoStackObservers.add(p->console_output_undo_observer);
 114 }
 115
 116 SPDocument::~SPDocument() {
 117     collectOrphans();
 118
 119     if (priv) {
 120         inkscape_remove_document(this);
 121
 122         if (priv->partial) {
 123             sp_repr_free_log(priv->partial);
 124             priv->partial = NULL;
 125         }
 126
 127         sp_document_clear_redo(this);
 128         sp_document_clear_undo(this);
 129
 130         if (root) {
 131             root->releaseReferences();
 132             sp_object_unref(root);
 133             root = NULL;
 134         }
 135
 136         if (priv->iddef) g_hash_table_destroy(priv->iddef);
 137         if (priv->reprdef) g_hash_table_destroy(priv->reprdef);
 138
 139         if (rdoc) Inkscape::GC::release(rdoc);
 140
 141         /* Free resources */
 142         g_hash_table_foreach_remove(priv->resources, sp_document_resource_list_free, this);
 143         g_hash_table_destroy(priv->resources);
 144
 145         delete priv;
 146         priv = NULL;
 147     }
 148
 149     cr_cascade_unref(style_cascade);
 150     style_cascade = NULL;
 151
 152     if (name) {
 153         g_free(name);
 154         name = NULL;
 155     }
 156     if (base) {
 157         g_free(base);
 158         base = NULL;
 159     }
 160     if (uri) {
 161         g_free(uri);
 162         uri = NULL;
 163     }
 164
 165     if (modified_id) {
 166         gtk_idle_remove(modified_id);
 167         modified_id = 0;
 168     }
 169
 170     _selection_changed_connection.disconnect();
 171     _desktop_activated_connection.disconnect();
 172
 173     if (keepalive) {
 174         inkscape_unref();
 175         keepalive = FALSE;
 176     }
 177
 178     if (router) {
 179         delete router;
 180         router = NULL;
 181     }
 182
 183     //delete this->_whiteboard_session_manager;
 184 }
 185
 186 void SPDocument::queueForOrphanCollection(SPObject *object) {
 187     g_return_if_fail(object != NULL);
 188     g_return_if_fail(SP_OBJECT_DOCUMENT(object) == this);
 189
 190     sp_object_ref(object, NULL);
 191     _collection_queue = g_slist_prepend(_collection_queue, object);
 192 }
 193
 194 void SPDocument::collectOrphans() {
 195     while (_collection_queue) {
 196         GSList *objects=_collection_queue;
 197         _collection_queue = NULL;
 198         for ( GSList *iter=objects ; iter ; iter = iter->next ) {
 199             SPObject *object=reinterpret_cast<SPObject *>(iter->data);
 200             object->collectOrphan();
 201             sp_object_unref(object, NULL);
 202         }
 203         g_slist_free(objects);
 204     }
 205 }
 206
 207 void SPDocument::reset_key (void *dummy)
 208 {
 209     actionkey = NULL;
 210 }
 211
 212 SPDocument *
 213 sp_document_create(Inkscape::XML::Document *rdoc,
 214                    gchar const *uri,
 215                    gchar const *base,
 216                    gchar const *name,
 217                    unsigned int keepalive)
 218 {
 219     SPDocument *document;
 220     Inkscape::XML::Node *rroot;
 221     Inkscape::Version sodipodi_version;
 222
 223     rroot = sp_repr_document_root(rdoc);
 224
 225     document = new SPDocument();
 226
 227     document->keepalive = keepalive;
 228
 229     document->rdoc = rdoc;
 230     document->rroot = rroot;
 231
 232 #ifndef WIN32
 233     prepend_current_dir_if_relative(&(document->uri), uri);
 234 #else
 235     // FIXME: it may be that prepend_current_dir_if_relative works OK on windows too, test!
 236     document->uri = uri? g_strdup(uri) : NULL;
 237 #endif
 238
 239     // base is simply the part of the path before filename; e.g. when running "inkscape ../file.svg" the base is "../"
 240     // which is why we use g_get_current_dir() in calculating the abs path above
 241     //This is NULL for a new document
 242     if (base)
 243         document->base = g_strdup(base);
 244     else
 245         document->base = NULL;
 246     document->name = g_strdup(name);
 247
 248     document->root = sp_object_repr_build_tree(document, rroot);
 249
 250     sodipodi_version = SP_ROOT(document->root)->version.sodipodi;
 251
 252     /* fixme: Not sure about this, but lets assume ::build updates */
 253     rroot->setAttribute("sodipodi:version", SODIPODI_VERSION);
 254     rroot->setAttribute("inkscape:version", INKSCAPE_VERSION);
 255     /* fixme: Again, I moved these here to allow version determining in ::build (Lauris) */
 256
 257     /* Quick hack 2 - get default image size into document */
 258     if (!rroot->attribute("width")) rroot->setAttribute("width", A4_WIDTH_STR);
 259     if (!rroot->attribute("height")) rroot->setAttribute("height", A4_HEIGHT_STR);
 260     /* End of quick hack 2 */
 261
 262     /* Quick hack 3 - Set uri attributes */
 263     if (uri) {
 264         /* fixme: Think, what this means for images (Lauris) */
 265         rroot->setAttribute("sodipodi:docname", uri);
 266         if (document->base)
 267             rroot->setAttribute("sodipodi:docbase", document->base);
 268     }
 269     /* End of quick hack 3 */
 270
 271     // creating namedview
 272     if (!sp_item_group_get_child_by_name((SPGroup *) document->root, NULL, "sodipodi:namedview")) {
 273         // if there's none in the document already,
 274         Inkscape::XML::Node *r = NULL;
 275         Inkscape::XML::Node *rnew = NULL;
 276         r = inkscape_get_repr(INKSCAPE, "template.base");
 277         // see if there's a template with id="base" in the preferences
 278         if (!r) {
 279             // if there's none, create an empty element
 280             rnew = sp_repr_new("sodipodi:namedview");
 281             rnew->setAttribute("id", "base");
 282         } else {
 283             // otherwise, take from preferences
 284             rnew = r->duplicate();
 285         }
 286         // insert into the document
 287         rroot->addChild(rnew, NULL);
 288         // clean up
 289         Inkscape::GC::release(rnew);
 290     }
 291
 292     /* Defs */
 293     if (!SP_ROOT(document->root)->defs) {
 294         Inkscape::XML::Node *r;
 295         r = sp_repr_new("svg:defs");
 296         rroot->addChild(r, NULL);
 297         Inkscape::GC::release(r);
 298         g_assert(SP_ROOT(document->root)->defs);
 299     }
 300
 301     /* Default RDF */
 302     rdf_set_defaults( document );
 303
 304     if (keepalive) {
 305         inkscape_ref();
 306     }
 307
 308     sp_document_set_undo_sensitive(document, true);
 309
 310     // reset undo key when selection changes, so that same-key actions on different objects are not coalesced
 311     if (!Inkscape::NSApplication::Application::getNewGui()) {
 312         g_signal_connect(G_OBJECT(INKSCAPE), "change_selection",
 313                          G_CALLBACK(sp_document_reset_key), document);
 314         g_signal_connect(G_OBJECT(INKSCAPE), "activate_desktop",
 315                          G_CALLBACK(sp_document_reset_key), document);
 316     } else {
 317         document->_selection_changed_connection = Inkscape::NSApplication::Editor::connectSelectionChanged (sigc::mem_fun (*document, &SPDocument::reset_key));
 318         document->_desktop_activated_connection = Inkscape::NSApplication::Editor::connectDesktopActivated (sigc::mem_fun (*document, &SPDocument::reset_key));
 319     }
 320     inkscape_add_document(document);
 321
 322     return document;
 323 }
 324
 325 /**
 326  * Fetches document from URI, or creates new, if NULL; public document
 327  * appears in document list.
 328  */
 329 SPDocument *
 330 sp_document_new(gchar const *uri, unsigned int keepalive, bool make_new)
 331 {
 332     SPDocument *doc;
 333     Inkscape::XML::Document *rdoc;
 334     gchar *base = NULL;
 335     gchar *name = NULL;
 336
 337     if (uri) {
 338         Inkscape::XML::Node *rroot;
 339         gchar *s, *p;
 340         /* Try to fetch repr from file */
 341         rdoc = sp_repr_read_file(uri, SP_SVG_NS_URI);
 342         /* If file cannot be loaded, return NULL without warning */
 343         if (rdoc == NULL) return NULL;
 344         rroot = sp_repr_document_root(rdoc);
 345         /* If xml file is not svg, return NULL without warning */
 346         /* fixme: destroy document */
 347         if (strcmp(rroot->name(), "svg:svg") != 0) return NULL;
 348         s = g_strdup(uri);
 349         p = strrchr(s, '/');
 350         if (p) {
 351             name = g_strdup(p + 1);
 352             p[1] = '\0';
 353             base = g_strdup(s);
 354         } else {
 355             base = NULL;
 356             name = g_strdup(uri);
 357         }
 358         g_free(s);
 359     } else {
 360         rdoc = sp_repr_document_new("svg:svg");
 361     }
 362
 363     if (make_new) {
 364         base = NULL;
 365         uri = NULL;
 366         name = g_strdup_printf(_("New document %d"), ++doc_count);
 367     }
 368
 369     //# These should be set by now
 370     g_assert(name);
 371
 372     doc = sp_document_create(rdoc, uri, base, name, keepalive);
 373
 374     g_free(base);
 375     g_free(name);
 376
 377     return doc;
 378 }
 379
 380 SPDocument *
 381 sp_document_new_from_mem(gchar const *buffer, gint length, unsigned int keepalive)
 382 {
 383     SPDocument *doc;
 384     Inkscape::XML::Document *rdoc;
 385     Inkscape::XML::Node *rroot;
 386     gchar *name;
 387
 388     rdoc = sp_repr_read_mem(buffer, length, SP_SVG_NS_URI);
 389
 390     /* If it cannot be loaded, return NULL without warning */
 391     if (rdoc == NULL) return NULL;
 392
 393     rroot = sp_repr_document_root(rdoc);
 394     /* If xml file is not svg, return NULL without warning */
 395     /* fixme: destroy document */
 396     if (strcmp(rroot->name(), "svg:svg") != 0) return NULL;
 397
 398     name = g_strdup_printf(_("Memory document %d"), ++doc_count);
 399
 400     doc = sp_document_create(rdoc, NULL, NULL, name, keepalive);
 401
 402     return doc;
 403 }
 404
 405 SPDocument *sp_document_new_dummy() {
 406     SPDocument *document = new SPDocument();
 407     inkscape_add_document(document);
 408     return document;
 409 }
 410
 411 SPDocument *
 412 sp_document_ref(SPDocument *doc)
 413 {
 414     g_return_val_if_fail(doc != NULL, NULL);
 415     Inkscape::GC::anchor(doc);
 416     return doc;
 417 }
 418
 419 SPDocument *
 420 sp_document_unref(SPDocument *doc)
 421 {
 422     g_return_val_if_fail(doc != NULL, NULL);
 423     Inkscape::GC::release(doc);
 424     return NULL;
 425 }
 426
 427 gdouble sp_document_width(SPDocument *document)
 428 {
 429     g_return_val_if_fail(document != NULL, 0.0);
 430     g_return_val_if_fail(document->priv != NULL, 0.0);
 431     g_return_val_if_fail(document->root != NULL, 0.0);
 432
 433     return SP_ROOT(document->root)->width.computed;
 434 }
 435
 436 void
 437 sp_document_set_width (SPDocument *document, gdouble width, const SPUnit *unit)
 438 {
 439     SPRoot *root = SP_ROOT(document->root);
 440
 441     if (root->width.unit == SVGLength::PERCENT && root->viewBox_set) { // set to viewBox=
 442         root->viewBox.x1 = root->viewBox.x0 + sp_units_get_pixels (width, *unit);
 443     } else { // set to width=
 444         root->width.computed = sp_units_get_pixels (width, *unit);
 445         /* SVG does not support meters as a unit, so we must translate meters to
 446          * cm when writing */
 447         if (!strcmp(unit->abbr, "m")) {
 448             root->width.value = 100*width;
 449             root->width.unit = SVGLength::CM;
 450         } else {
 451             root->width.value = width;
 452             root->width.unit = (SVGLength::Unit) sp_unit_get_svg_unit(unit);
 453         }
 454     }
 455
 456     SP_OBJECT (root)->updateRepr();
 457 }
 458
 459 void sp_document_set_height (SPDocument * document, gdouble height, const SPUnit *unit)
 460 {
 461     SPRoot *root = SP_ROOT(document->root);
 462
 463     if (root->height.unit == SVGLength::PERCENT && root->viewBox_set) { // set to viewBox=
 464         root->viewBox.y1 = root->viewBox.y0 + sp_units_get_pixels (height, *unit);
 465     } else { // set to height=
 466         root->height.computed = sp_units_get_pixels (height, *unit);
 467         /* SVG does not support meters as a unit, so we must translate meters to
 468          * cm when writing */
 469         if (!strcmp(unit->abbr, "m")) {
 470             root->height.value = 100*height;
 471             root->height.unit = SVGLength::CM;
 472         } else {
 473             root->height.value = height;
 474             root->height.unit = (SVGLength::Unit) sp_unit_get_svg_unit(unit);
 475         }
 476     }
 477
 478     SP_OBJECT (root)->updateRepr();
 479 }
 480
 481 gdouble sp_document_height(SPDocument *document)
 482 {
 483     g_return_val_if_fail(document != NULL, 0.0);
 484     g_return_val_if_fail(document->priv != NULL, 0.0);
 485     g_return_val_if_fail(document->root != NULL, 0.0);
 486
 487     return SP_ROOT(document->root)->height.computed;
 488 }
 489
 490 /**
 491  * Given an NRRect that may, for example, correspond to the bbox of an object
 492  * this function fits the canvas to that rect by resizing the canvas
 493  * and translating the document root into position.
 494  */
 495 void SPDocument::fitToRect(NRRect const & rect)
 496 {
 497     g_return_if_fail(!empty(rect));
 498
 499     gdouble w = rect.x1 - rect.x0;
 500     gdouble h = rect.y1 - rect.y0;
 501     gdouble old_height = sp_document_height(this);
 502     SPUnit unit = sp_unit_get_by_id(SP_UNIT_PX);
 503     sp_document_set_width(this, w, &unit);
 504     sp_document_set_height(this, h, &unit);
 505
 506     NR::translate tr = NR::translate::translate(-rect.x0,-(rect.y0 + (h - old_height)));
 507     static_cast<SPGroup *>(root)->translateChildItems(tr);
 508 }
 509
 510 void sp_document_set_uri(SPDocument *document, gchar const *uri)
 511 {
 512     g_return_if_fail(document != NULL);
 513
 514     if (document->name) {
 515         g_free(document->name);
 516         document->name = NULL;
 517     }
 518     if (document->base) {
 519         g_free(document->base);
 520         document->base = NULL;
 521     }
 522     if (document->uri) {
 523         g_free(document->uri);
 524         document->uri = NULL;
 525     }
 526
 527     if (uri) {
 528
 529 #ifndef WIN32
 530         prepend_current_dir_if_relative(&(document->uri), uri);
 531 #else
 532         // FIXME: it may be that prepend_current_dir_if_relative works OK on windows too, test!
 533         document->uri = g_strdup(uri);
 534 #endif
 535
 536         /* fixme: Think, what this means for images (Lauris) */
 537         document->base = g_path_get_dirname(document->uri);
 538         document->name = g_path_get_basename(document->uri);
 539
 540     } else {
 541         document->uri = g_strdup_printf(_("Unnamed document %d"), ++doc_count);
 542         document->base = NULL;
 543         document->name = g_strdup(document->uri);
 544     }
 545
 546     // Update saveable repr attributes.
 547     Inkscape::XML::Node *repr = sp_document_repr_root(document);
 548     // changing uri in the document repr must not be not undoable
 549     bool saved = sp_document_get_undo_sensitive(document);
 550     sp_document_set_undo_sensitive(document, false);
 551     if (document->base)
 552         repr->setAttribute("sodipodi:docbase", document->base);
 553
 554     repr->setAttribute("sodipodi:docname", document->name);
 555     sp_document_set_undo_sensitive(document, saved);
 556
 557     document->priv->uri_set_signal.emit(document->uri);
 558 }
 559
 560 void
 561 sp_document_resized_signal_emit(SPDocument *doc, gdouble width, gdouble height)
 562 {
 563     g_return_if_fail(doc != NULL);
 564
 565     doc->priv->resized_signal.emit(width, height);
 566 }
 567
 568 sigc::connection SPDocument::connectModified(SPDocument::ModifiedSignal::slot_type slot)
 569 {
 570     return priv->modified_signal.connect(slot);
 571 }
 572
 573 sigc::connection SPDocument::connectURISet(SPDocument::URISetSignal::slot_type slot)
 574 {
 575     return priv->uri_set_signal.connect(slot);
 576 }
 577
 578 sigc::connection SPDocument::connectResized(SPDocument::ResizedSignal::slot_type slot)
 579 {
 580     return priv->resized_signal.connect(slot);
 581 }
 582
 583 sigc::connection
 584 SPDocument::connectReconstructionStart(SPDocument::ReconstructionStart::slot_type slot)
 585 {
 586     return priv->_reconstruction_start_signal.connect(slot);
 587 }
 588
 589 void
 590 SPDocument::emitReconstructionStart(void)
 591 {
 592     // printf("Starting Reconstruction\n");
 593     priv->_reconstruction_start_signal.emit();
 594     return;
 595 }
 596
 597 sigc::connection
 598 SPDocument::connectReconstructionFinish(SPDocument::ReconstructionFinish::slot_type  slot)
 599 {
 600     return priv->_reconstruction_finish_signal.connect(slot);
 601 }
 602
 603 void
 604 SPDocument::emitReconstructionFinish(void)
 605 {
 606     // printf("Finishing Reconstruction\n");
 607     priv->_reconstruction_finish_signal.emit();
 608     return;
 609 }
 610
 611 sigc::connection SPDocument::connectCommit(SPDocument::CommitSignal::slot_type slot)
 612 {
 613     return priv->commit_signal.connect(slot);
 614 }
 615
 616
 617
 618 void SPDocument::_emitModified() {
 619     static guint const flags = SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG | SP_OBJECT_PARENT_MODIFIED_FLAG;
 620     root->emitModified(0);
 621     priv->modified_signal.emit(flags);
 622 }
 623
 624 void SPDocument::bindObjectToId(gchar const *id, SPObject *object) {
 625     GQuark idq = g_quark_from_string(id);
 626
 627     if (object) {
 628         g_assert(g_hash_table_lookup(priv->iddef, GINT_TO_POINTER(idq)) == NULL);
 629         g_hash_table_insert(priv->iddef, GINT_TO_POINTER(idq), object);
 630     } else {
 631         g_assert(g_hash_table_lookup(priv->iddef, GINT_TO_POINTER(idq)) != NULL);
 632         g_hash_table_remove(priv->iddef, GINT_TO_POINTER(idq));
 633     }
 634
 635     SPDocumentPrivate::IDChangedSignalMap::iterator pos;
 636
 637     pos = priv->id_changed_signals.find(idq);
 638     if ( pos != priv->id_changed_signals.end() ) {
 639         if (!(*pos).second.empty()) {
 640             (*pos).second.emit(object);
 641         } else { // discard unused signal
 642             priv->id_changed_signals.erase(pos);
 643         }
 644     }
 645 }
 646
 647 void
 648 SPDocument::addUndoObserver(Inkscape::UndoStackObserver& observer)
 649 {
 650         this->priv->undoStackObservers.add(observer);
 651 }
 652
 653 void
 654 SPDocument::removeUndoObserver(Inkscape::UndoStackObserver& observer)
 655 {
 656         this->priv->undoStackObservers.remove(observer);
 657 }
 658
 659 SPObject *SPDocument::getObjectById(gchar const *id) {
 660     g_return_val_if_fail(id != NULL, NULL);
 661
 662     GQuark idq = g_quark_from_string(id);
 663     return (SPObject*)g_hash_table_lookup(priv->iddef, GINT_TO_POINTER(idq));
 664 }
 665
 666 sigc::connection SPDocument::connectIdChanged(gchar const *id,
 667                                               SPDocument::IDChangedSignal::slot_type slot)
 668 {
 669     return priv->id_changed_signals[g_quark_from_string(id)].connect(slot);
 670 }
 671
 672 void SPDocument::bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object) {
 673     if (object) {
 674         g_assert(g_hash_table_lookup(priv->reprdef, repr) == NULL);
 675         g_hash_table_insert(priv->reprdef, repr, object);
 676     } else {
 677         g_assert(g_hash_table_lookup(priv->reprdef, repr) != NULL);
 678         g_hash_table_remove(priv->reprdef, repr);
 679     }
 680 }
 681
 682 SPObject *SPDocument::getObjectByRepr(Inkscape::XML::Node *repr) {
 683     g_return_val_if_fail(repr != NULL, NULL);
 684     return (SPObject*)g_hash_table_lookup(priv->reprdef, repr);
 685 }
 686
 687 Glib::ustring SPDocument::getLanguage() {
 688     gchar const *document_language = rdf_get_work_entity(this, rdf_find_entity("language"));
 689     if (document_language) {
 690         while (isspace(*document_language))
 691             document_language++;
 692     }
 693     if ( !document_language || 0 == *document_language) {
 694         // retrieve system language
 695         document_language = getenv("LC_ALL");
 696         if ( NULL == document_language || *document_language == 0 ) {
 697             document_language = getenv ("LC_MESSAGES");
 698         }
 699         if ( NULL == document_language || *document_language == 0 ) {
 700             document_language = getenv ("LANG");
 701         }
 702
 703         if ( NULL != document_language ) {
 704             gchar *pos = strchr(document_language, '_');
 705             if ( NULL != pos ) {
 706                 return Glib::ustring(document_language, pos - document_language);
 707             }
 708         }
 709     }
 710
 711     if ( NULL == document_language )
 712         return Glib::ustring();
 713     return document_language;
 714 }
 715
 716 /* Object modification root handler */
 717
 718 void
 719 sp_document_request_modified(SPDocument *doc)
 720 {
 721     if (!doc->modified_id) {
 722         doc->modified_id = gtk_idle_add_priority(SP_DOCUMENT_UPDATE_PRIORITY, sp_document_idle_handler, doc);
 723     }
 724 }
 725
 726 void
 727 sp_document_setup_viewport (SPDocument *doc, SPItemCtx *ctx)
 728 {
 729     ctx->ctx.flags = 0;
 730     ctx->i2doc = NR::identity();
 731     /* Set up viewport in case svg has it defined as percentages */
 732     if (SP_ROOT(doc->root)->viewBox_set) { // if set, take from viewBox
 733         ctx->vp.x0 = SP_ROOT(doc->root)->viewBox.x0;
 734         ctx->vp.y0 = SP_ROOT(doc->root)->viewBox.y0;
 735         ctx->vp.x1 = SP_ROOT(doc->root)->viewBox.x1;
 736         ctx->vp.y1 = SP_ROOT(doc->root)->viewBox.y1;
 737     } else { // as a last resort, set size to A4
 738         ctx->vp.x0 = 0.0;
 739         ctx->vp.y0 = 0.0;
 740         ctx->vp.x1 = 210 * PX_PER_MM;
 741         ctx->vp.y1 = 297 * PX_PER_MM;
 742     }
 743     ctx->i2vp = NR::identity();
 744 }
 745
 746 /**
 747  * Tries to update the document state based on the modified and
 748  * "update required" flags, and return true if the document has
 749  * been brought fully up to date.
 750  */
 751 bool
 752 SPDocument::_updateDocument()
 753 {
 754     /* Process updates */
 755     if (this->root->uflags || this->root->mflags) {
 756         if (this->root->uflags) {
 757             SPItemCtx ctx;
 758             sp_document_setup_viewport (this, &ctx);
 759
 760             bool saved = sp_document_get_undo_sensitive(this);
 761             sp_document_set_undo_sensitive(this, false);
 762
 763             this->root->updateDisplay((SPCtx *)&ctx, 0);
 764
 765             sp_document_set_undo_sensitive(this, saved);
 766         }
 767         this->_emitModified();
 768     }
 769
 770     return !(this->root->uflags || this->root->mflags);
 771 }
 772
 773
 774 /**
 775  * Repeatedly works on getting the document updated, since sometimes
 776  * it takes more than one pass to get the document updated.  But it
 777  * usually should not take more than a few loops, and certainly never
 778  * more than 32 iterations.  So we bail out if we hit 32 iterations,
 779  * since this typically indicates we're stuck in an update loop.
 780  */
 781 gint
 782 sp_document_ensure_up_to_date(SPDocument *doc)
 783 {
 784     int counter = 32;
 785     while (!doc->_updateDocument()) {
 786         if (counter == 0) {
 787             g_warning("More than 32 iteration while updating document '%s'", doc->uri);
 788             break;
 789         }
 790         counter--;
 791     }
 792
 793     if (doc->modified_id) {
 794         /* Remove handler */
 795         gtk_idle_remove(doc->modified_id);
 796         doc->modified_id = 0;
 797     }
 798     return counter>0;
 799 }
 800
 801 /**
 802  * An idle handler to update the document.  Returns true if
 803  * the document needs further updates.
 804  */
 805 static gint
 806 sp_document_idle_handler(gpointer data)
 807 {
 808     SPDocument *doc = static_cast<SPDocument *>(data);
 809     if (doc->_updateDocument()) {
 810         doc->modified_id = 0;
 811         return false;
 812     } else {
 813         return true;
 814     }
 815 }
 816
 817 static bool is_within(NR::Rect const &area, NR::Rect const &box)
 818 {
 819     return area.contains(box);
 820 }
 821
 822 static bool overlaps(NR::Rect const &area, NR::Rect const &box)
 823 {
 824     return area.intersects(box);
 825 }
 826
 827 static GSList *find_items_in_area(GSList *s, SPGroup *group, unsigned int dkey, NR::Rect const &area,
 828                                   bool (*test)(NR::Rect const &, NR::Rect const &), bool take_insensitive = false)
 829 {
 830     g_return_val_if_fail(SP_IS_GROUP(group), s);
 831
 832     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
 833         if (!SP_IS_ITEM(o)) {
 834             continue;
 835         }
 836         if (SP_IS_GROUP(o) && SP_GROUP(o)->effectiveLayerMode(dkey) == SPGroup::LAYER ) {
 837             s = find_items_in_area(s, SP_GROUP(o), dkey, area, test);
 838         } else {
 839             SPItem *child = SP_ITEM(o);
 840             NR::Rect box = sp_item_bbox_desktop(child);
 841             if (test(area, box) && (take_insensitive || child->isVisibleAndUnlocked(dkey))) {
 842                 s = g_slist_append(s, child);
 843             }
 844         }
 845     }
 846
 847     return s;
 848 }
 849
 850 /**
 851 Returns true if an item is among the descendants of group (recursively).
 852  */
 853 bool item_is_in_group(SPItem *item, SPGroup *group)
 854 {
 855     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
 856         if (!SP_IS_ITEM(o)) continue;
 857         if (SP_ITEM(o) == item)
 858             return true;
 859         if (SP_IS_GROUP(o))
 860             if (item_is_in_group(item, SP_GROUP(o)))
 861                 return true;
 862     }
 863     return false;
 864 }
 865
 866 /**
 867 Returns the bottommost item from the list which is at the point, or NULL if none.
 868 */
 869 SPItem*
 870 sp_document_item_from_list_at_point_bottom(unsigned int dkey, SPGroup *group, GSList const *list,
 871                                            NR::Point const p, bool take_insensitive)
 872 {
 873     g_return_val_if_fail(group, NULL);
 874
 875     gdouble delta = prefs_get_double_attribute ("options.cursortolerance", "value", 1.0);
 876
 877     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
 878
 879         if (!SP_IS_ITEM(o)) continue;
 880
 881         SPItem *item = SP_ITEM(o);
 882         NRArenaItem *arenaitem = sp_item_get_arenaitem(item, dkey);
 883         if (arenaitem && nr_arena_item_invoke_pick(arenaitem, p, delta, 1) != NULL
 884             && (take_insensitive || item->isVisibleAndUnlocked(dkey))) {
 885             if (g_slist_find((GSList *) list, item) != NULL)
 886                 return item;
 887         }
 888
 889         if (SP_IS_GROUP(o)) {
 890             SPItem *found = sp_document_item_from_list_at_point_bottom(dkey, SP_GROUP(o), list, p, take_insensitive);
 891             if (found)
 892                 return found;
 893         }
 894
 895     }
 896     return NULL;
 897 }
 898
 899 /**
 900 Returns the topmost (in z-order) item from the descendants of group (recursively) which
 901 is at the point p, or NULL if none. Honors into_groups on whether to recurse into
 902 non-layer groups or not. Honors take_insensitive on whether to return insensitive
 903 items. If upto != NULL, then if item upto is encountered (at any level), stops searching
 904 upwards in z-order and returns what it has found so far (i.e. the found item is
 905 guaranteed to be lower than upto).
 906  */
 907 SPItem*
 908 find_item_at_point(unsigned int dkey, SPGroup *group, NR::Point const p, gboolean into_groups, bool take_insensitive = false, SPItem *upto = NULL)
 909 {
 910     SPItem *seen = NULL, *newseen = NULL;
 911
 912     gdouble delta = prefs_get_double_attribute ("options.cursortolerance", "value", 1.0);
 913
 914     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
 915         if (!SP_IS_ITEM(o)) continue;
 916
 917         if (upto && SP_ITEM(o) == upto)
 918             break;
 919
 920         if (SP_IS_GROUP(o) && (SP_GROUP(o)->effectiveLayerMode(dkey) == SPGroup::LAYER || into_groups)) {
 921             // if nothing found yet, recurse into the group
 922             newseen = find_item_at_point(dkey, SP_GROUP(o), p, into_groups, take_insensitive, upto);
 923             if (newseen) {
 924                 seen = newseen;
 925                 newseen = NULL;
 926             }
 927
 928             if (item_is_in_group(upto, SP_GROUP(o)))
 929                 break;
 930
 931         } else {
 932             SPItem *child = SP_ITEM(o);
 933             NRArenaItem *arenaitem = sp_item_get_arenaitem(child, dkey);
 934
 935             // seen remembers the last (topmost) of items pickable at this point
 936             if (arenaitem && nr_arena_item_invoke_pick(arenaitem, p, delta, 1) != NULL
 937                 && (take_insensitive || child->isVisibleAndUnlocked(dkey))) {
 938                 seen = child;
 939             }
 940         }
 941     }
 942     return seen;
 943 }
 944
 945 /**
 946 Returns the topmost non-layer group from the descendants of group which is at point
 947 p, or NULL if none. Recurses into layers but not into groups.
 948  */
 949 SPItem*
 950 find_group_at_point(unsigned int dkey, SPGroup *group, NR::Point const p)
 951 {
 952     SPItem *seen = NULL;
 953
 954     gdouble delta = prefs_get_double_attribute ("options.cursortolerance", "value", 1.0);
 955
 956     for (SPObject *o = sp_object_first_child(SP_OBJECT(group)) ; o != NULL ; o = SP_OBJECT_NEXT(o) ) {
 957         if (!SP_IS_ITEM(o)) continue;
 958         if (SP_IS_GROUP(o) && SP_GROUP(o)->effectiveLayerMode(dkey) == SPGroup::LAYER) {
 959             SPItem *newseen = find_group_at_point(dkey, SP_GROUP(o), p);
 960             if (newseen) {
 961                 seen = newseen;
 962             }
 963         }
 964         if (SP_IS_GROUP(o) && SP_GROUP(o)->effectiveLayerMode(dkey) != SPGroup::LAYER ) {
 965             SPItem *child = SP_ITEM(o);
 966             NRArenaItem *arenaitem = sp_item_get_arenaitem(child, dkey);
 967
 968             // seen remembers the last (topmost) of groups pickable at this point
 969             if (arenaitem && nr_arena_item_invoke_pick(arenaitem, p, delta, 1) != NULL) {
 970                 seen = child;
 971             }
 972         }
 973     }
 974     return seen;
 975 }
 976
 977 /*
 978  * Return list of items, contained in box
 979  *
 980  * Assumes box is normalized (and g_asserts it!)
 981  *
 982  */
 983
 984 GSList *sp_document_items_in_box(SPDocument *document, unsigned int dkey, NR::Rect const &box)
 985 {
 986     g_return_val_if_fail(document != NULL, NULL);
 987     g_return_val_if_fail(document->priv != NULL, NULL);
 988
 989     return find_items_in_area(NULL, SP_GROUP(document->root), dkey, box, is_within);
 990 }
 991
 992 /*
 993  * Return list of items, that the parts of the item contained in box
 994  *
 995  * Assumes box is normalized (and g_asserts it!)
 996  *
 997  */
 998
 999 GSList *sp_document_partial_items_in_box(SPDocument *document, unsigned int dkey, NR::Rect const &box)
1000 {
1001     g_return_val_if_fail(document != NULL, NULL);
1002     g_return_val_if_fail(document->priv != NULL, NULL);
1003
1004     return find_items_in_area(NULL, SP_GROUP(document->root), dkey, box, overlaps);
1005 }
1006
1007 SPItem *
1008 sp_document_item_at_point(SPDocument *document, unsigned const key, NR::Point const p,
1009                           gboolean const into_groups, SPItem *upto)
1010 {
1011     g_return_val_if_fail(document != NULL, NULL);
1012     g_return_val_if_fail(document->priv != NULL, NULL);
1013
1014     return find_item_at_point(key, SP_GROUP(document->root), p, into_groups, false, upto);
1015 }
1016
1017 SPItem*
1018 sp_document_group_at_point(SPDocument *document, unsigned int key, NR::Point const p)
1019 {
1020     g_return_val_if_fail(document != NULL, NULL);
1021     g_return_val_if_fail(document->priv != NULL, NULL);
1022
1023     return find_group_at_point(key, SP_GROUP(document->root), p);
1024 }
1025
1026
1027 /* Resource management */
1028
1029 gboolean
1030 sp_document_add_resource(SPDocument *document, gchar const *key, SPObject *object)
1031 {
1032     GSList *rlist;
1033     GQuark q = g_quark_from_string(key);
1034
1035     g_return_val_if_fail(document != NULL, FALSE);
1036     g_return_val_if_fail(key != NULL, FALSE);
1037     g_return_val_if_fail(*key != '\0', FALSE);
1038     g_return_val_if_fail(object != NULL, FALSE);
1039     g_return_val_if_fail(SP_IS_OBJECT(object), FALSE);
1040
1041     if (SP_OBJECT_IS_CLONED(object))
1042         return FALSE;
1043
1044     rlist = (GSList*)g_hash_table_lookup(document->priv->resources, key);
1045     g_return_val_if_fail(!g_slist_find(rlist, object), FALSE);
1046     rlist = g_slist_prepend(rlist, object);
1047     g_hash_table_insert(document->priv->resources, (gpointer) key, rlist);
1048
1049     document->priv->resources_changed_signals[q].emit();
1050
1051     return TRUE;
1052 }
1053
1054 gboolean
1055 sp_document_remove_resource(SPDocument *document, gchar const *key, SPObject *object)
1056 {
1057     GSList *rlist;
1058     GQuark q = g_quark_from_string(key);
1059
1060     g_return_val_if_fail(document != NULL, FALSE);
1061     g_return_val_if_fail(key != NULL, FALSE);
1062     g_return_val_if_fail(*key != '\0', FALSE);
1063     g_return_val_if_fail(object != NULL, FALSE);
1064     g_return_val_if_fail(SP_IS_OBJECT(object), FALSE);
1065
1066     if (SP_OBJECT_IS_CLONED(object))
1067         return FALSE;
1068
1069     rlist = (GSList*)g_hash_table_lookup(document->priv->resources, key);
1070     g_return_val_if_fail(rlist != NULL, FALSE);
1071     g_return_val_if_fail(g_slist_find(rlist, object), FALSE);
1072     rlist = g_slist_remove(rlist, object);
1073     g_hash_table_insert(document->priv->resources, (gpointer) key, rlist);
1074
1075     document->priv->resources_changed_signals[q].emit();
1076
1077     return TRUE;
1078 }
1079
1080 GSList const *
1081 sp_document_get_resource_list(SPDocument *document, gchar const *key)
1082 {
1083     g_return_val_if_fail(document != NULL, NULL);
1084     g_return_val_if_fail(key != NULL, NULL);
1085     g_return_val_if_fail(*key != '\0', NULL);
1086
1087     return (GSList*)g_hash_table_lookup(document->priv->resources, key);
1088 }
1089
1090 sigc::connection sp_document_resources_changed_connect(SPDocument *document,
1091                                                        gchar const *key,
1092                                                        SPDocument::ResourcesChangedSignal::slot_type slot)
1093 {
1094     GQuark q = g_quark_from_string(key);
1095     return document->priv->resources_changed_signals[q].connect(slot);
1096 }
1097
1098 /* Helpers */
1099
1100 gboolean
1101 sp_document_resource_list_free(gpointer key, gpointer value, gpointer data)
1102 {
1103     g_slist_free((GSList *) value);
1104     return TRUE;
1105 }
1106
1107 unsigned int
1108 count_objects_recursive(SPObject *obj, unsigned int count)
1109 {
1110     count++; // obj itself
1111
1112     for (SPObject *i = sp_object_first_child(obj); i != NULL; i = SP_OBJECT_NEXT(i)) {
1113         count = count_objects_recursive(i, count);
1114     }
1115
1116     return count;
1117 }
1118
1119 unsigned int
1120 objects_in_document(SPDocument *document)
1121 {
1122     return count_objects_recursive(SP_DOCUMENT_ROOT(document), 0);
1123 }
1124
1125 void
1126 vacuum_document_recursive(SPObject *obj)
1127 {
1128     if (SP_IS_DEFS(obj)) {
1129         for (SPObject *def = obj->firstChild(); def; def = SP_OBJECT_NEXT(def)) {
1130             /* fixme: some inkscape-internal nodes in the future might not be collectable */
1131             def->requestOrphanCollection();
1132         }
1133     } else {
1134         for (SPObject *i = sp_object_first_child(obj); i != NULL; i = SP_OBJECT_NEXT(i)) {
1135             vacuum_document_recursive(i);
1136         }
1137     }
1138 }
1139
1140 unsigned int
1141 vacuum_document(SPDocument *document)
1142 {
1143     unsigned int start = objects_in_document(document);
1144     unsigned int end;
1145     unsigned int newend = start;
1146
1147     unsigned int iterations = 0;
1148
1149     do {
1150         end = newend;
1151
1152         vacuum_document_recursive(SP_DOCUMENT_ROOT(document));
1153         document->collectOrphans();
1154         iterations++;
1155
1156         newend = objects_in_document(document);
1157
1158     } while (iterations < 100 && newend < end);
1159
1160     return start - newend;
1161 }
1162
1163
1164 /*
1165   Local Variables:
1166   mode:c++
1167   c-file-style:"stroustrup"
1168   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1169   indent-tabs-mode:nil
1170   fill-column:99
1171   End:
1172 */
1173 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :