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