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