Code

struct SPCurve => class SPCurve
[inkscape.git] / src / document.cpp
index b53a7b7fad6f9fb1d54354ba028e77e9f0fc77f7..92aad942d7687e7f8d24cad35a25712962774d8b 100644 (file)
@@ -18,7 +18,7 @@
 /** \class SPDocument
  * SPDocument serves as the container of both model trees (agnostic XML
  * and typed object tree), and implements all of the document-level
- * functionality used by the program. Many document level operations, like 
+ * functionality used by the program. Many document level operations, like
  * load, save, print, export and so on, use SPDocument as their basic datatype.
  *
  * SPDocument implements undo and redo stacks and an id-based object
@@ -38,6 +38,8 @@
 # include "config.h"
 #endif
 #include <gtk/gtkmain.h>
+#include <string>
+#include <cstring>
 #include "application/application.h"
 #include "application/editor.h"
 #include "libnr/nr-matrix-fns.h"
 #include "unit-constants.h"
 #include "prefs-utils.h"
 #include "libavoid/router.h"
+#include "libnr/nr-rect.h"
+#include "sp-item-group.h"
+#include "profile-manager.h"
+#include "persp3d.h"
 
 #include "display/nr-arena-item.h"
 
 #include "dialogs/rdf.h"
 
-#define A4_WIDTH_STR "210mm"
-#define A4_HEIGHT_STR "297mm"
+#include "transf_mat_3x4.h"
 
 #define SP_DOCUMENT_UPDATE_PRIORITY (G_PRIORITY_HIGH_IDLE - 1)
 
@@ -68,6 +73,8 @@ gboolean sp_document_resource_list_free(gpointer key, gpointer value, gpointer d
 
 static gint doc_count = 0;
 
+static unsigned long next_serial = 0;
+
 SPDocument::SPDocument() {
     SPDocumentPrivate *p;
 
@@ -89,9 +96,15 @@ SPDocument::SPDocument() {
 
     // Initialise instance of connector router.
     router = new Avoid::Router();
+    // Don't use the Consolidate moves optimisation.
+    router->ConsolidateMoves = false;
+
+    perspectives = NULL;
 
     p = new SPDocumentPrivate();
 
+    p->serial = next_serial++;
+
     p->iddef = g_hash_table_new(g_direct_hash, g_direct_equal);
     p->reprdef = g_hash_table_new(g_direct_hash, g_direct_equal);
 
@@ -102,16 +115,27 @@ SPDocument::SPDocument() {
     p->history_size = 0;
     p->undo = NULL;
     p->redo = NULL;
+    p->seeking = false;
 
     priv = p;
+
+    // Once things are set, hook in the manager
+    profileManager = new Inkscape::ProfileManager(this);
+
+    // XXX only for testing!
+    priv->undoStackObservers.add(p->console_output_undo_observer);
 }
 
 SPDocument::~SPDocument() {
     collectOrphans();
 
-    if (priv) {
-        inkscape_remove_document(this);
+    // kill/unhook this first
+    if ( profileManager ) {
+        delete profileManager;
+        profileManager = 0;
+    }
 
+    if (priv) {
         if (priv->partial) {
             sp_repr_free_log(priv->partial);
             priv->partial = NULL;
@@ -121,8 +145,8 @@ SPDocument::~SPDocument() {
         sp_document_clear_undo(this);
 
         if (root) {
-            sp_object_invoke_release(root);
-            g_object_unref(G_OBJECT(root));
+            root->releaseReferences();
+            sp_object_unref(root);
             root = NULL;
         }
 
@@ -174,6 +198,31 @@ SPDocument::~SPDocument() {
     }
 
     //delete this->_whiteboard_session_manager;
+
+}
+
+void SPDocument::add_persp3d (Persp3D * const /*persp*/)
+{
+    SPDefs *defs = SP_ROOT(this->root)->defs;
+    for (SPObject *i = sp_object_first_child(SP_OBJECT(defs)); i != NULL; i = SP_OBJECT_NEXT(i) ) {
+        if (SP_IS_PERSP3D(i)) {
+            g_print ("Encountered a Persp3D in defs\n");
+        }
+    }
+
+    g_print ("Adding Persp3D to defs\n");
+    persp3d_create_xml_element (this);
+}
+
+void SPDocument::remove_persp3d (Persp3D * const /*persp*/)
+{
+    // TODO: Delete the repr, maybe perform a check if any boxes are still linked to the perspective.
+    //       Anything else?
+    g_print ("Please implement deletion of perspectives here.\n");
+}
+
+unsigned long SPDocument::serial() const {
+    return priv->serial;
 }
 
 void SPDocument::queueForOrphanCollection(SPObject *object) {
@@ -197,12 +246,12 @@ void SPDocument::collectOrphans() {
     }
 }
 
-void SPDocument::reset_key (void *dummy)
+void SPDocument::reset_key (void */*dummy*/)
 {
     actionkey = NULL;
 }
-    
-static SPDocument *
+
+SPDocument *
 sp_document_create(Inkscape::XML::Document *rdoc,
                    gchar const *uri,
                    gchar const *base,
@@ -213,7 +262,7 @@ sp_document_create(Inkscape::XML::Document *rdoc,
     Inkscape::XML::Node *rroot;
     Inkscape::Version sodipodi_version;
 
-    rroot = sp_repr_document_root(rdoc);
+    rroot = rdoc->root();
 
     document = new SPDocument();
 
@@ -248,16 +297,13 @@ sp_document_create(Inkscape::XML::Document *rdoc,
     /* fixme: Again, I moved these here to allow version determining in ::build (Lauris) */
 
     /* Quick hack 2 - get default image size into document */
-    if (!rroot->attribute("width")) rroot->setAttribute("width", A4_WIDTH_STR);
-    if (!rroot->attribute("height")) rroot->setAttribute("height", A4_HEIGHT_STR);
+    if (!rroot->attribute("width")) rroot->setAttribute("width", "100%");
+    if (!rroot->attribute("height")) rroot->setAttribute("height", "100%");
     /* End of quick hack 2 */
 
     /* Quick hack 3 - Set uri attributes */
     if (uri) {
-        /* fixme: Think, what this means for images (Lauris) */
         rroot->setAttribute("sodipodi:docname", uri);
-        if (document->base)
-            rroot->setAttribute("sodipodi:docbase", document->base);
     }
     /* End of quick hack 3 */
 
@@ -270,11 +316,11 @@ sp_document_create(Inkscape::XML::Document *rdoc,
         // see if there's a template with id="base" in the preferences
         if (!r) {
             // if there's none, create an empty element
-            rnew = sp_repr_new("sodipodi:namedview");
+            rnew = rdoc->createElement("sodipodi:namedview");
             rnew->setAttribute("id", "base");
         } else {
             // otherwise, take from preferences
-            rnew = r->duplicate();
+            rnew = r->duplicate(rroot->document());
         }
         // insert into the document
         rroot->addChild(rnew, NULL);
@@ -285,7 +331,7 @@ sp_document_create(Inkscape::XML::Document *rdoc,
     /* Defs */
     if (!SP_ROOT(document->root)->defs) {
         Inkscape::XML::Node *r;
-        r = sp_repr_new("svg:defs");
+        r = rdoc->createElement("svg:defs");
         rroot->addChild(r, NULL);
         Inkscape::GC::release(r);
         g_assert(SP_ROOT(document->root)->defs);
@@ -298,7 +344,16 @@ sp_document_create(Inkscape::XML::Document *rdoc,
         inkscape_ref();
     }
 
-    sp_document_set_undo_sensitive(document, TRUE);
+    // Remark: Here, we used to create a "currentpersp3d" element in the document defs.
+    // But this is probably a bad idea since we need to adapt it for every change of selection, which will
+    // completely clutter the undo history. Maybe rather save it to prefs on exit and re-read it on startup?
+
+    document->current_persp3d = persp3d_document_first_persp(document);
+    if (!document->current_persp3d) {
+        document->current_persp3d = persp3d_create_xml_element (document);
+    }
+
+    sp_document_set_undo_sensitive(document, true);
 
     // reset undo key when selection changes, so that same-key actions on different objects are not coalesced
     if (!Inkscape::NSApplication::Application::getNewGui()) {
@@ -310,13 +365,12 @@ sp_document_create(Inkscape::XML::Document *rdoc,
         document->_selection_changed_connection = Inkscape::NSApplication::Editor::connectSelectionChanged (sigc::mem_fun (*document, &SPDocument::reset_key));
         document->_desktop_activated_connection = Inkscape::NSApplication::Editor::connectDesktopActivated (sigc::mem_fun (*document, &SPDocument::reset_key));
     }
-    inkscape_add_document(document);
 
     return document;
 }
 
 /**
- * Fetches document from URI, or creates new, if NULL; public document 
+ * Fetches document from URI, or creates new, if NULL; public document
  * appears in document list.
  */
 SPDocument *
@@ -334,7 +388,7 @@ sp_document_new(gchar const *uri, unsigned int keepalive, bool make_new)
         rdoc = sp_repr_read_file(uri, SP_SVG_NS_URI);
         /* If file cannot be loaded, return NULL without warning */
         if (rdoc == NULL) return NULL;
-        rroot = sp_repr_document_root(rdoc);
+        rroot = rdoc->root();
         /* If xml file is not svg, return NULL without warning */
         /* fixme: destroy document */
         if (strcmp(rroot->name(), "svg:svg") != 0) return NULL;
@@ -383,7 +437,7 @@ sp_document_new_from_mem(gchar const *buffer, gint length, unsigned int keepaliv
     /* If it cannot be loaded, return NULL without warning */
     if (rdoc == NULL) return NULL;
 
-    rroot = sp_repr_document_root(rdoc);
+    rroot = rdoc->root();
     /* If xml file is not svg, return NULL without warning */
     /* fixme: destroy document */
     if (strcmp(rroot->name(), "svg:svg") != 0) return NULL;
@@ -395,12 +449,6 @@ sp_document_new_from_mem(gchar const *buffer, gint length, unsigned int keepaliv
     return doc;
 }
 
-SPDocument *sp_document_new_dummy() {
-    SPDocument *document = new SPDocument();
-    inkscape_add_document(document);
-    return document;
-}
-
 SPDocument *
 sp_document_ref(SPDocument *doc)
 {
@@ -480,6 +528,29 @@ gdouble sp_document_height(SPDocument *document)
     return SP_ROOT(document->root)->height.computed;
 }
 
+/**
+ * Given an NR::Rect that may, for example, correspond to the bbox of an object,
+ * this function fits the canvas to that rect by resizing the canvas
+ * and translating the document root into position.
+ */
+void SPDocument::fitToRect(NR::Rect const &rect)
+{
+    g_return_if_fail(!rect.isEmpty());
+
+    using NR::X; using NR::Y;
+    double const w = rect.extent(X);
+    double const h = rect.extent(Y);
+
+    double const old_height = sp_document_height(this);
+    SPUnit const &px(sp_unit_get_by_id(SP_UNIT_PX));
+    sp_document_set_width(this, w, &px);
+    sp_document_set_height(this, h, &px);
+
+    NR::translate const tr(NR::Point(0, (old_height - h))
+                           - rect.min());
+    SP_GROUP(root)->translateChildItems(tr);
+}
+
 void sp_document_set_uri(SPDocument *document, gchar const *uri)
 {
     g_return_if_fail(document != NULL);
@@ -519,10 +590,8 @@ void sp_document_set_uri(SPDocument *document, gchar const *uri)
     // Update saveable repr attributes.
     Inkscape::XML::Node *repr = sp_document_repr_root(document);
     // changing uri in the document repr must not be not undoable
-    gboolean saved = sp_document_get_undo_sensitive(document);
-    sp_document_set_undo_sensitive(document, FALSE);
-    if (document->base)
-        repr->setAttribute("sodipodi:docbase", document->base);
+    bool saved = sp_document_get_undo_sensitive(document);
+    sp_document_set_undo_sensitive(document, false);
 
     repr->setAttribute("sodipodi:docname", document->name);
     sp_document_set_undo_sensitive(document, saved);
@@ -581,6 +650,12 @@ SPDocument::emitReconstructionFinish(void)
     return;
 }
 
+sigc::connection SPDocument::connectCommit(SPDocument::CommitSignal::slot_type slot)
+{
+    return priv->commit_signal.connect(slot);
+}
+
+
 
 void SPDocument::_emitModified() {
     static guint const flags = SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG | SP_OBJECT_PARENT_MODIFIED_FLAG;
@@ -614,13 +689,13 @@ void SPDocument::bindObjectToId(gchar const *id, SPObject *object) {
 void
 SPDocument::addUndoObserver(Inkscape::UndoStackObserver& observer)
 {
-       this->priv->undoStackObservers.add(observer);
+    this->priv->undoStackObservers.add(observer);
 }
 
 void
 SPDocument::removeUndoObserver(Inkscape::UndoStackObserver& observer)
 {
-       this->priv->undoStackObservers.remove(observer);
+    this->priv->undoStackObservers.remove(observer);
 }
 
 SPObject *SPDocument::getObjectById(gchar const *id) {
@@ -651,6 +726,35 @@ SPObject *SPDocument::getObjectByRepr(Inkscape::XML::Node *repr) {
     return (SPObject*)g_hash_table_lookup(priv->reprdef, repr);
 }
 
+Glib::ustring SPDocument::getLanguage() {
+    gchar const *document_language = rdf_get_work_entity(this, rdf_find_entity("language"));
+    if (document_language) {
+        while (isspace(*document_language))
+            document_language++;
+    }
+    if ( !document_language || 0 == *document_language) {
+        // retrieve system language
+        document_language = getenv("LC_ALL");
+        if ( NULL == document_language || *document_language == 0 ) {
+            document_language = getenv ("LC_MESSAGES");
+        }
+        if ( NULL == document_language || *document_language == 0 ) {
+            document_language = getenv ("LANG");
+        }
+
+        if ( NULL != document_language ) {
+            gchar *pos = strchr(document_language, '_');
+            if ( NULL != pos ) {
+                return Glib::ustring(document_language, pos - document_language);
+            }
+        }
+    }
+
+    if ( NULL == document_language )
+        return Glib::ustring();
+    return document_language;
+}
+
 /* Object modification root handler */
 
 void
@@ -681,69 +785,75 @@ sp_document_setup_viewport (SPDocument *doc, SPItemCtx *ctx)
     ctx->i2vp = NR::identity();
 }
 
+/**
+ * Tries to update the document state based on the modified and
+ * "update required" flags, and return true if the document has
+ * been brought fully up to date.
+ */
+bool
+SPDocument::_updateDocument()
+{
+    /* Process updates */
+    if (this->root->uflags || this->root->mflags) {
+        if (this->root->uflags) {
+            SPItemCtx ctx;
+            sp_document_setup_viewport (this, &ctx);
+
+            bool saved = sp_document_get_undo_sensitive(this);
+            sp_document_set_undo_sensitive(this, false);
+
+            this->root->updateDisplay((SPCtx *)&ctx, 0);
+
+            sp_document_set_undo_sensitive(this, saved);
+        }
+        this->_emitModified();
+    }
+
+    return !(this->root->uflags || this->root->mflags);
+}
+
+
+/**
+ * Repeatedly works on getting the document updated, since sometimes
+ * it takes more than one pass to get the document updated.  But it
+ * usually should not take more than a few loops, and certainly never
+ * more than 32 iterations.  So we bail out if we hit 32 iterations,
+ * since this typically indicates we're stuck in an update loop.
+ */
 gint
 sp_document_ensure_up_to_date(SPDocument *doc)
 {
-    int lc;
-    lc = 32;
-    while (doc->root->uflags || doc->root->mflags) {
-        lc -= 1;
-        if (lc < 0) {
-            g_warning("More than 32 iterations while updating document '%s'", doc->uri);
-            if (doc->modified_id) {
-                /* Remove handler */
-                gtk_idle_remove(doc->modified_id);
-                doc->modified_id = 0;
-            }
-            return FALSE;
-        }
-        /* Process updates */
-        if (doc->root->uflags) {
-            SPItemCtx ctx;
-            sp_document_setup_viewport (doc, &ctx);
-            doc->root->updateDisplay((SPCtx *)&ctx, 0);
+    int counter = 32;
+    while (!doc->_updateDocument()) {
+        if (counter == 0) {
+            g_warning("More than 32 iteration while updating document '%s'", doc->uri);
+            break;
         }
-        doc->_emitModified();
+        counter--;
     }
+
     if (doc->modified_id) {
         /* Remove handler */
         gtk_idle_remove(doc->modified_id);
         doc->modified_id = 0;
     }
-    return TRUE;
+    return counter>0;
 }
 
+/**
+ * An idle handler to update the document.  Returns true if
+ * the document needs further updates.
+ */
 static gint
 sp_document_idle_handler(gpointer data)
 {
-    SPDocument *doc;
-    int repeat;
-
-    doc = static_cast<SPDocument *>(data);
-
-#ifdef SP_DOCUMENT_DEBUG_IDLE
-    g_print("->\n");
-#endif
-
-    /* Process updates */
-    if (doc->root->uflags) {
-        SPItemCtx ctx;
-        sp_document_setup_viewport (doc, &ctx);
-
-        gboolean saved = sp_document_get_undo_sensitive(doc);
-        sp_document_set_undo_sensitive(doc, FALSE);
-
-        doc->root->updateDisplay((SPCtx *)&ctx, 0);
-
-        sp_document_set_undo_sensitive(doc, saved);
-        /* if (doc->root->uflags & SP_OBJECT_MODIFIED_FLAG) return TRUE; */
+    SPDocument *doc = static_cast<SPDocument *>(data);
+    if (doc->_updateDocument()) {
+        doc->modified_id = 0;
+        return false;
+    } else {
+        return true;
     }
-
-    doc->_emitModified();
-
-    repeat = (doc->root->uflags || doc->root->mflags);
-    if (!repeat) doc->modified_id = 0;
-    return repeat;
 }
 
 static bool is_within(NR::Rect const &area, NR::Rect const &box)
@@ -769,8 +879,8 @@ static GSList *find_items_in_area(GSList *s, SPGroup *group, unsigned int dkey,
             s = find_items_in_area(s, SP_GROUP(o), dkey, area, test);
         } else {
             SPItem *child = SP_ITEM(o);
-            NR::Rect box = sp_item_bbox_desktop(child);
-            if (test(area, box) && (take_insensitive || child->isVisibleAndUnlocked(dkey))) {
+            NR::Maybe<NR::Rect> box = sp_item_bbox_desktop(child);
+            if ( box && test(area, *box) && (take_insensitive || child->isVisibleAndUnlocked(dkey))) {
                 s = g_slist_append(s, child);
             }
         }
@@ -849,7 +959,7 @@ find_item_at_point(unsigned int dkey, SPGroup *group, NR::Point const p, gboolea
         if (upto && SP_ITEM(o) == upto)
             break;
 
-        if (SP_IS_GROUP(o) && (SP_GROUP(o)->effectiveLayerMode(dkey) == SPGroup::LAYER || into_groups))        {
+        if (SP_IS_GROUP(o) && (SP_GROUP(o)->effectiveLayerMode(dkey) == SPGroup::LAYER || into_groups)) {
             // if nothing found yet, recurse into the group
             newseen = find_item_at_point(dkey, SP_GROUP(o), p, into_groups, take_insensitive, upto);
             if (newseen) {
@@ -936,6 +1046,30 @@ GSList *sp_document_partial_items_in_box(SPDocument *document, unsigned int dkey
     return find_items_in_area(NULL, SP_GROUP(document->root), dkey, box, overlaps);
 }
 
+GSList *
+sp_document_items_at_points(SPDocument *document, unsigned const key, std::vector<NR::Point> points)
+{
+    GSList *items = NULL;
+
+    // When picking along the path, we don't want small objects close together
+    // (such as hatching strokes) to obscure each other by their deltas,
+    // so we temporarily set delta to a small value
+    gdouble saved_delta = prefs_get_double_attribute ("options.cursortolerance", "value", 1.0);
+    prefs_set_double_attribute ("options.cursortolerance", "value", 0.25);
+
+    for(unsigned int i = 0; i < points.size(); i++) {
+        SPItem *item = sp_document_item_at_point(document, key, points[i],
+                                         false, NULL);
+        if (item && !g_slist_find(items, item))
+            items = g_slist_prepend (items, item);
+    }
+
+    // and now we restore it back
+    prefs_set_double_attribute ("options.cursortolerance", "value", saved_delta);
+
+    return items;
+}
+
 SPItem *
 sp_document_item_at_point(SPDocument *document, unsigned const key, NR::Point const p,
                           gboolean const into_groups, SPItem *upto)
@@ -1030,7 +1164,7 @@ sigc::connection sp_document_resources_changed_connect(SPDocument *document,
 /* Helpers */
 
 gboolean
-sp_document_resource_list_free(gpointer key, gpointer value, gpointer data)
+sp_document_resource_list_free(gpointer /*key*/, gpointer value, gpointer /*data*/)
 {
     g_slist_free((GSList *) value);
     return TRUE;
@@ -1092,6 +1226,10 @@ vacuum_document(SPDocument *document)
     return start - newend;
 }
 
+bool SPDocument::isSeeking() const {
+    return priv->seeking;
+}
+
 
 /*
   Local Variables: