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 static unsigned long next_serial = 0;
  74
  75 SPDocument::SPDocument() {
  76     SPDocumentPrivate *p;
  77
  78     keepalive = FALSE;
  79     virgin    = TRUE;
  80
  81     modified_id = 0;
  82
  83     rdoc = NULL;
  84     rroot = NULL;
  85     root = NULL;
  86     style_cascade = cr_cascade_new(NULL, NULL, NULL);
  87
  88     uri = NULL;
  89     base = NULL;
  90     name = NULL;
  91
  92     _collection_queue = NULL;
  93
  94     // Initialise instance of connector router.
  95     router = new Avoid::Router();
  96     // Don't use the Consolidate moves optimisation.
  97     router->ConsolidateMoves = false;
  98
  99     p = new SPDocumentPrivate();
 100
 101     p->serial = next_serial++;
 102
 103     p->iddef = g_hash_table_new(g_direct_hash, g_direct_equal);
 104     p->reprdef = g_hash_table_new(g_direct_hash, g_direct_equal);
 105
 106     p->resources = g_hash_table_new(g_str_hash, g_str_equal);
 107
 108     p->sensitive = FALSE;
 109     p->partial = NULL;
 110     p->history_size = 0;
 111     p->undo = NULL;
 112     p->redo = NULL;
 113     p->seeking = false;
 114
 115     priv = p;
 116
 117     // XXX only for testing!
 118     priv->undoStackObservers.add(p->console_output_undo_observer);
 119 }
 120
 121 SPDocument::~SPDocument() {
 122     collectOrphans();
 123
 124     if (priv) {
 125         if (priv->partial) {
 126             sp_repr_free_log(priv->partial);
 127             priv->partial = NULL;
 128         }
 129
 130         sp_document_clear_redo(this);
 131         sp_document_clear_undo(this);
 132
 133         if (root) {
 134             root->releaseReferences();
 135             sp_object_unref(root);
 136             root = NULL;
 137         }
 138
 139         if (priv->iddef) g_hash_table_destroy(priv->iddef);
 140         if (priv->reprdef) g_hash_table_destroy(priv->reprdef);
 141
 142         if (rdoc) Inkscape::GC::release(rdoc);
 143
 144         /* Free resources */
 145         g_hash_table_foreach_remove(priv->resources, sp_document_resource_list_free, this);
 146         g_hash_table_destroy(priv->resources);
 147
 148         delete priv;
 149         priv = NULL;
 150     }
 151
 152     cr_cascade_unref(style_cascade);
 153     style_cascade = NULL;
 154
 155     if (name) {
 156         g_free(name);
 157         name = NULL;
 158     }
 159     if (base) {
 160         g_free(base);
 161         base = NULL;
 162     }
 163     if (uri) {
 164         g_free(uri);
 165         uri = NULL;
 166     }
 167
 168     if (modified_id) {
 169         gtk_idle_remove(modified_id);
 170         modified_id = 0;
 171     }
 172
 173     _selection_changed_connection.disconnect();
 174     _desktop_activated_connection.disconnect();
 175
 176     if (keepalive) {
 177         inkscape_unref();
 178         keepalive = FALSE;
 179     }
 180
 181     if (router) {
 182         delete router;
 183         router = NULL;
 184     }
 185
 186     //delete this->_whiteboard_session_manager;
 187 }
 188
 189 unsigned long SPDocument::serial() const {
 190     return priv->serial;
 191 }
 192
 193 void SPDocument::queueForOrphanCollection(SPObject *object) {
 194     g_return_if_fail(object != NULL);
 195     g_return_if_fail(SP_OBJECT_DOCUMENT(object) == this);
 196
 197     sp_object_ref(object, NULL);
 198     _collection_queue = g_slist_prepend(_collection_queue, object);
 199 }
 200
 201 void SPDocument::collectOrphans() {
 202     while (_collection_queue) {
 203         GSList *objects=_collection_queue;
 204         _collection_queue = NULL;
 205         for ( GSList *iter=objects ; iter ; iter = iter->next ) {
 206             SPObject *object=reinterpret_cast<SPObject *>(iter->data);
 207             object->collectOrphan();
 208             sp_object_unref(object, NULL);
 209         }
 210         g_slist_free(objects);
 211     }
 212 }
 213
 214 void SPDocument::reset_key (void *dummy)
 215 {
 216     actionkey = NULL;
 217 }
 218
 219 SPDocument *
 220 sp_document_create(Inkscape::XML::Document *rdoc,
 221                    gchar const *uri,
 222                    gchar const *base,
 223                    gchar const *name,
 224                    unsigned int keepalive)
 225 {
 226     SPDocument *document;
 227     Inkscape::XML::Node *rroot;
 228     Inkscape::Version sodipodi_version;
 229
 230     rroot = rdoc->root();
 231
 232     document = new SPDocument();
 233
 234     document->keepalive = keepalive;
 235
 236     document->rdoc = rdoc;
 237     document->rroot = rroot;
 238
 239 #ifndef WIN32
 240     prepend_current_dir_if_relative(&(document->uri), uri);
 241 #else
 242     // FIXME: it may be that prepend_current_dir_if_relative works OK on windows too, test!
 243     document->uri = uri? g_strdup(uri) : NULL;
 244 #endif
 245
 246     // base is simply the part of the path before filename; e.g. when running "inkscape ../file.svg" the base is "../"
 247     // which is why we use g_get_current_dir() in calculating the abs path above
 248     //This is NULL for a new document
 249     if (base)
 250         document->base = g_strdup(base);
 251     else
 252         document->base = NULL;
 253     document->name = g_strdup(name);
 254
 255     document->root = sp_object_repr_build_tree(document, rroot);
 256
 257     sodipodi_version = SP_ROOT(document->root)->version.sodipodi;
 258
 259     /* fixme: Not sure about this, but lets assume ::build updates */
 260     rroot->setAttribute("sodipodi:version", SODIPODI_VERSION);
 261     rroot->setAttribute("inkscape:version", INKSCAPE_VERSION);
 262     /* fixme: Again, I moved these here to allow version determining in ::build (Lauris) */
 263
 264     /* Quick hack 2 - get default image size into document */
 265     if (!rroot->attribute("width")) rroot->setAttribute("width", A4_WIDTH_STR);
 266     if (!rroot->attribute("height")) rroot->setAttribute("height", A4_HEIGHT_STR);
 267     /* End of quick hack 2 */
 268
 269     /* Quick hack 3 - Set uri attributes */
 270     if (uri) {
 271         rroot->setAttribute("sodipodi:docname", uri);
 272     }
 273     /* End of quick hack 3 */
 274
 275     // creating namedview
 276     if (!sp_item_group_get_child_by_name((SPGroup *) document->root, NULL, "sodipodi:namedview")) {
 277         // if there's none in the document already,
 278         Inkscape::XML::Node *r = NULL;
 279         Inkscape::XML::Node *rnew = NULL;
 280         r = inkscape_get_repr(INKSCAPE, "template.base");
 281         // see if there's a template with id="base" in the preferences
 282         if (!r) {
 283             // if there's none, create an empty element
 284             rnew = rdoc->createElement("sodipodi:namedview");
 285             rnew->setAttribute("id", "base");
 286         } else {
 287             // otherwise, take from preferences
 288             rnew = r->duplicate(rroot->document());
 289         }
 290         // insert into the document
 291         rroot->addChild(rnew, NULL);
 292         // clean up
 293         Inkscape::GC::release(rnew);
 294     }
 295
 296     /* Defs */
 297     if (!SP_ROOT(document->root)->defs) {
 298         Inkscape::XML::Node *r;
 299         r = rdoc->createElement("svg:defs");
 300         rroot->addChild(r, NULL);
 301         Inkscape::GC::release(r);
 302         g_assert(SP_ROOT(document->root)->defs);
 303     }
 304
 305     /* Default RDF */
 306     rdf_set_defaults( document );
 307
 308     if (keepalive) {
 309         inkscape_ref();
 310     }
 311
 312     sp_document_set_undo_sensitive(document, true);
 313
 314     // reset undo key when selection changes, so that same-key actions on different objects are not coalesced
 315     if (!Inkscape::NSApplication::Application::getNewGui()) {
 316         g_signal_connect(G_OBJECT(INKSCAPE), "change_selection",
 317                          G_CALLBACK(sp_document_reset_key), document);
 318         g_signal_connect(G_OBJECT(INKSCAPE), "activate_desktop",
 319                          G_CALLBACK(sp_document_reset_key), document);
 320     } else {
 321         document->_selection_changed_connection = Inkscape::NSApplication::Editor::connectSelectionChanged (sigc::mem_fun (*document, &SPDocument::reset_key));
 322         document->_desktop_activated_connection = Inkscape::NSApplication::Editor::connectDesktopActivated (sigc::mem_fun (*document, &SPDocument::reset_key));
 323     }
 324
 325     return document;
 326 }
 327
 328 /**
 329  * Fetches document from URI, or creates new, if NULL; public document
 330  * appears in document list.
 331  */
 332 SPDocument *
 333 sp_document_new(gchar const *uri, unsigned int keepalive, bool make_new)
 334 {
 335     SPDocument *doc;
 336     Inkscape::XML::Document *rdoc;
 337     gchar *base = NULL;
 338     gchar *name = NULL;
 339
 340     if (uri) {
 341         Inkscape::XML::Node *rroot;
 342         gchar *s, *p;
 343         /* Try to fetch repr from file */
 344         rdoc = sp_repr_read_file(uri, SP_SVG_NS_URI);
 345         /* If file cannot be loaded, return NULL without warning */
 346         if (rdoc == NULL) return NULL;
 347         rroot = rdoc->root();
 348         /* If xml file is not svg, return NULL without warning */
 349         /* fixme: destroy document */
 350         if (strcmp(rroot->name(), "svg:svg") != 0) return NULL;
 351         s = g_strdup(uri);
 352         p = strrchr(s, '/');
 353         if (p) {
 354             name = g_strdup(p + 1);
 355             p[1] = '\0';
 356             base = g_strdup(s);
 357         } else {
 358             base = NULL;
 359             name = g_strdup(uri);
 360         }
 361         g_free(s);
 362     } else {
 363         rdoc = sp_repr_document_new("svg:svg");
 364     }
 365
 366     if (make_new) {
 367         base = NULL;
 368         uri = NULL;
 369         name = g_strdup_printf(_("New document %d"), ++doc_count);
 370     }
 371
 372     //# These should be set by now
 373     g_assert(name);
 374
 375     doc = sp_document_create(rdoc, uri, base, name, keepalive);
 376
 377     g_free(base);
 378     g_free(name);
 379
 380     return doc;
 381 }
 382
 383 SPDocument *
 384 sp_document_new_from_mem(gchar const *buffer, gint length, unsigned int keepalive)
 385 {
 386     SPDocument *doc;
 387     Inkscape::XML::Document *rdoc;
 388     Inkscape::XML::Node *rroot;
 389     gchar *name;
 390
 391     rdoc = sp_repr_read_mem(buffer, length, SP_SVG_NS_URI);
 392
 393     /* If it cannot be loaded, return NULL without warning */
 394     if (rdoc == NULL) return NULL;
 395
 396     rroot = rdoc->root();
 397     /* If xml file is not svg, return NULL without warning */
 398     /* fixme: destroy document */
 399     if (strcmp(rroot->name(), "svg:svg") != 0) return NULL;
 400
 401     name = g_strdup_printf(_("Memory document %d"), ++doc_count);
 402
 403     doc = sp_document_create(rdoc, NULL, NULL, name, keepalive);
 404
 405     return doc;
 406 }
 407
 408 SPDocument *sp_document_new_dummy() {
 409     SPDocument *document = new SPDocument();
 410     return document;
 411 }
 412
 413 SPDocument *
 414 sp_document_ref(SPDocument *doc)
 415 {
 416     g_return_val_if_fail(doc != NULL, NULL);
 417     Inkscape::GC::anchor(doc);
 418     return doc;
 419 }
 420
 421 SPDocument *
 422 sp_document_unref(SPDocument *doc)
 423 {
 424     g_return_val_if_fail(doc != NULL, NULL);
 425     Inkscape::GC::release(doc);
 426     return NULL;
 427 }
 428
 429 gdouble sp_document_width(SPDocument *document)
 430 {
 431     g_return_val_if_fail(document != NULL, 0.0);
 432     g_return_val_if_fail(document->priv != NULL, 0.0);
 433     g_return_val_if_fail(document->root != NULL, 0.0);
 434
 435     return SP_ROOT(document->root)->width.computed;
 436 }
 437
 438 void
 439 sp_document_set_width (SPDocument *document, gdouble width, const SPUnit *unit)
 440 {
 441     SPRoot *root = SP_ROOT(document->root);
 442
 443     if (root->width.unit == SVGLength::PERCENT && root->viewBox_set) { // set to viewBox=
 444         root->viewBox.x1 = root->viewBox.x0 + sp_units_get_pixels (width, *unit);
 445     } else { // set to width=
 446         root->width.computed = sp_units_get_pixels (width, *unit);
 447         /* SVG does not support meters as a unit, so we must translate meters to
 448          * cm when writing */
 449         if (!strcmp(unit->abbr, "m")) {
 450             root->width.value = 100*width;
 451             root->width.unit = SVGLength::CM;
 452         } else {
 453             root->width.value = width;
 454             root->width.unit = (SVGLength::Unit) sp_unit_get_svg_unit(unit);
 455         }
 456     }
 457
 458     SP_OBJECT (root)->updateRepr();
 459 }
 460
 461 void sp_document_set_height (SPDocument * document, gdouble height, const SPUnit *unit)
 462 {
 463     SPRoot *root = SP_ROOT(document->root);
 464
 465     if (root->height.unit == SVGLength::PERCENT && root->viewBox_set) { // set to viewBox=
 466         root->viewBox.y1 = root->viewBox.y0 + sp_units_get_pixels (height, *unit);
 467     } else { // set to height=
 468         root->height.computed = sp_units_get_pixels (height, *unit);
 469         /* SVG does not support meters as a unit, so we must translate meters to
 470          * cm when writing */
 471         if (!strcmp(unit->abbr, "m")) {
 472             root->height.value = 100*height;
 473             root->height.unit = SVGLength::CM;
 474         } else {
 475             root->height.value = height;
 476             root->height.unit = (SVGLength::Unit) sp_unit_get_svg_unit(unit);
 477         }
 478     }
 479
 480     SP_OBJECT (root)->updateRepr();
 481 }
 482
 483 gdouble sp_document_height(SPDocument *document)
 484 {
 485     g_return_val_if_fail(document != NULL, 0.0);
 486     g_return_val_if_fail(document->priv != NULL, 0.0);
 487     g_return_val_if_fail(document->root != NULL, 0.0);
 488
 489     return SP_ROOT(document->root)->height.computed;
 490 }
 491
 492 /**
 493  * Given an NRRect that may, for example, correspond to the bbox of an object
 494  * this function fits the canvas to that rect by resizing the canvas
 495  * and translating the document root into position.
 496  */
 497 void SPDocument::fitToRect(NRRect const & rect)
 498 {
 499     g_return_if_fail(!nr_rect_d_test_empty(&rect));
 500
 501     gdouble w = rect.x1 - rect.x0;
 502     gdouble h = rect.y1 - rect.y0;
 503     gdouble old_height = sp_document_height(this);
 504     SPUnit unit = sp_unit_get_by_id(SP_UNIT_PX);
 505     sp_document_set_width(this, w, &unit);
 506     sp_document_set_height(this, h, &unit);
 507
 508     NR::translate tr = NR::translate::translate(-rect.x0,-(rect.y0 + (h - old_height)));
 509     static_cast<SPGroup *>(root)->translateChildItems(tr);
 510 }
 511
 512 void sp_document_set_uri(SPDocument *document, gchar const *uri)
 513 {
 514     g_return_if_fail(document != NULL);
 515
 516     if (document->name) {
 517         g_free(document->name);
 518         document->name = NULL;
 519     }
 520     if (document->base) {
 521         g_free(document->base);
 522         document->base = NULL;
 523     }
 524     if (document->uri) {
 525         g_free(document->uri);
 526         document->uri = NULL;
 527     }
 528
 529     if (uri) {
 530
 531 #ifndef WIN32
 532         prepend_current_dir_if_relative(&(document->uri), uri);
 533 #else
 534         // FIXME: it may be that prepend_current_dir_if_relative works OK on windows too, test!
 535         document->uri = g_strdup(uri);
 536 #endif
 537
 538         /* fixme: Think, what this means for images (Lauris) */
 539         document->base = g_path_get_dirname(document->uri);
 540         document->name = g_path_get_basename(document->uri);
 541
 542     } else {
 543         document->uri = g_strdup_printf(_("Unnamed document %d"), ++doc_count);
 544         document->base = NULL;
 545         document->name = g_strdup(document->uri);
 546     }
 547
 548     // Update saveable repr attributes.
 549     Inkscape::XML::Node *repr = sp_document_repr_root(document);
 550     // changing uri in the document repr must not be not undoable
 551     bool saved = sp_document_get_undo_sensitive(document);
 552     sp_document_set_undo_sensitive(document, false);
 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::Maybe<NR::Rect> box = sp_item_bbox_desktop(child);
 841             if ( box && 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 GSList *
1008 sp_document_items_at_points(SPDocument *document, unsigned const key, std::vector<NR::Point> points)
1009 {
1010     GSList *items = NULL;
1011
1012     // When picking along the path, we don't want small objects close together
1013     // (such as hatching strokes) to obscure each other by their deltas,
1014     // so we temporarily set delta to a small value
1015     gdouble saved_delta = prefs_get_double_attribute ("options.cursortolerance", "value", 1.0);
1016     prefs_set_double_attribute ("options.cursortolerance", "value", 0.25);
1017
1018     for(unsigned int i = 0; i < points.size(); i++) {
1019         SPItem *item = sp_document_item_at_point(document, key, points[i],
1020                                          false, NULL);
1021         if (item && !g_slist_find(items, item))
1022             items = g_slist_prepend (items, item);
1023     }
1024
1025     // and now we restore it back
1026     prefs_set_double_attribute ("options.cursortolerance", "value", saved_delta);
1027
1028     return items;
1029 }
1030
1031 SPItem *
1032 sp_document_item_at_point(SPDocument *document, unsigned const key, NR::Point const p,
1033                           gboolean const into_groups, SPItem *upto)
1034 {
1035     g_return_val_if_fail(document != NULL, NULL);
1036     g_return_val_if_fail(document->priv != NULL, NULL);
1037
1038     return find_item_at_point(key, SP_GROUP(document->root), p, into_groups, false, upto);
1039 }
1040
1041 SPItem*
1042 sp_document_group_at_point(SPDocument *document, unsigned int key, NR::Point const p)
1043 {
1044     g_return_val_if_fail(document != NULL, NULL);
1045     g_return_val_if_fail(document->priv != NULL, NULL);
1046
1047     return find_group_at_point(key, SP_GROUP(document->root), p);
1048 }
1049
1050
1051 /* Resource management */
1052
1053 gboolean
1054 sp_document_add_resource(SPDocument *document, gchar const *key, SPObject *object)
1055 {
1056     GSList *rlist;
1057     GQuark q = g_quark_from_string(key);
1058
1059     g_return_val_if_fail(document != NULL, FALSE);
1060     g_return_val_if_fail(key != NULL, FALSE);
1061     g_return_val_if_fail(*key != '\0', FALSE);
1062     g_return_val_if_fail(object != NULL, FALSE);
1063     g_return_val_if_fail(SP_IS_OBJECT(object), FALSE);
1064
1065     if (SP_OBJECT_IS_CLONED(object))
1066         return FALSE;
1067
1068     rlist = (GSList*)g_hash_table_lookup(document->priv->resources, key);
1069     g_return_val_if_fail(!g_slist_find(rlist, object), FALSE);
1070     rlist = g_slist_prepend(rlist, object);
1071     g_hash_table_insert(document->priv->resources, (gpointer) key, rlist);
1072
1073     document->priv->resources_changed_signals[q].emit();
1074
1075     return TRUE;
1076 }
1077
1078 gboolean
1079 sp_document_remove_resource(SPDocument *document, gchar const *key, SPObject *object)
1080 {
1081     GSList *rlist;
1082     GQuark q = g_quark_from_string(key);
1083
1084     g_return_val_if_fail(document != NULL, FALSE);
1085     g_return_val_if_fail(key != NULL, FALSE);
1086     g_return_val_if_fail(*key != '\0', FALSE);
1087     g_return_val_if_fail(object != NULL, FALSE);
1088     g_return_val_if_fail(SP_IS_OBJECT(object), FALSE);
1089
1090     if (SP_OBJECT_IS_CLONED(object))
1091         return FALSE;
1092
1093     rlist = (GSList*)g_hash_table_lookup(document->priv->resources, key);
1094     g_return_val_if_fail(rlist != NULL, FALSE);
1095     g_return_val_if_fail(g_slist_find(rlist, object), FALSE);
1096     rlist = g_slist_remove(rlist, object);
1097     g_hash_table_insert(document->priv->resources, (gpointer) key, rlist);
1098
1099     document->priv->resources_changed_signals[q].emit();
1100
1101     return TRUE;
1102 }
1103
1104 GSList const *
1105 sp_document_get_resource_list(SPDocument *document, gchar const *key)
1106 {
1107     g_return_val_if_fail(document != NULL, NULL);
1108     g_return_val_if_fail(key != NULL, NULL);
1109     g_return_val_if_fail(*key != '\0', NULL);
1110
1111     return (GSList*)g_hash_table_lookup(document->priv->resources, key);
1112 }
1113
1114 sigc::connection sp_document_resources_changed_connect(SPDocument *document,
1115                                                        gchar const *key,
1116                                                        SPDocument::ResourcesChangedSignal::slot_type slot)
1117 {
1118     GQuark q = g_quark_from_string(key);
1119     return document->priv->resources_changed_signals[q].connect(slot);
1120 }
1121
1122 /* Helpers */
1123
1124 gboolean
1125 sp_document_resource_list_free(gpointer key, gpointer value, gpointer data)
1126 {
1127     g_slist_free((GSList *) value);
1128     return TRUE;
1129 }
1130
1131 unsigned int
1132 count_objects_recursive(SPObject *obj, unsigned int count)
1133 {
1134     count++; // obj itself
1135
1136     for (SPObject *i = sp_object_first_child(obj); i != NULL; i = SP_OBJECT_NEXT(i)) {
1137         count = count_objects_recursive(i, count);
1138     }
1139
1140     return count;
1141 }
1142
1143 unsigned int
1144 objects_in_document(SPDocument *document)
1145 {
1146     return count_objects_recursive(SP_DOCUMENT_ROOT(document), 0);
1147 }
1148
1149 void
1150 vacuum_document_recursive(SPObject *obj)
1151 {
1152     if (SP_IS_DEFS(obj)) {
1153         for (SPObject *def = obj->firstChild(); def; def = SP_OBJECT_NEXT(def)) {
1154             /* fixme: some inkscape-internal nodes in the future might not be collectable */
1155             def->requestOrphanCollection();
1156         }
1157     } else {
1158         for (SPObject *i = sp_object_first_child(obj); i != NULL; i = SP_OBJECT_NEXT(i)) {
1159             vacuum_document_recursive(i);
1160         }
1161     }
1162 }
1163
1164 unsigned int
1165 vacuum_document(SPDocument *document)
1166 {
1167     unsigned int start = objects_in_document(document);
1168     unsigned int end;
1169     unsigned int newend = start;
1170
1171     unsigned int iterations = 0;
1172
1173     do {
1174         end = newend;
1175
1176         vacuum_document_recursive(SP_DOCUMENT_ROOT(document));
1177         document->collectOrphans();
1178         iterations++;
1179
1180         newend = objects_in_document(document);
1181
1182     } while (iterations < 100 && newend < end);
1183
1184     return start - newend;
1185 }
1186
1187 bool SPDocument::isSeeking() const {
1188     return priv->seeking;
1189 }
1190
1191
1192 /*
1193   Local Variables:
1194   mode:c++
1195   c-file-style:"stroustrup"
1196   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1197   indent-tabs-mode:nil
1198   fill-column:99
1199   End:
1200 */
1201 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :