Code

Connector tool: make connectors avoid the convex hull of shapes.
[inkscape.git] / src / document.cpp
index 4f54870324b9232fc972ff3897f0ac0b50124826..a3ad6f7beb1486a4bc236e6d0ff44213b2d89ef5 100644 (file)
 #include <gtk/gtkmain.h>
 #include <string>
 #include <cstring>
+
 #include "application/application.h"
 #include "application/editor.h"
-#include "xml/repr.h"
+#include "desktop.h"
+#include "dir-util.h"
+#include "display/nr-arena-item.h"
+#include "document-private.h"
 #include "helper/units.h"
 #include "inkscape-private.h"
 #include "inkscape-version.h"
-#include "sp-object-repr.h"
-#include "sp-namedview.h"
-#include "desktop.h"
-#include "document-private.h"
-#include "dir-util.h"
-#include "unit-constants.h"
-#include "preferences.h"
 #include "libavoid/router.h"
-#include "sp-item-group.h"
-#include "profile-manager.h"
 #include "persp3d.h"
-
-#include "display/nr-arena-item.h"
-
-#include "dialogs/rdf.h"
-
+#include "preferences.h"
+#include "profile-manager.h"
+#include "rdf.h"
+#include "sp-item-group.h"
+#include "sp-namedview.h"
+#include "sp-object-repr.h"
 #include "transf_mat_3x4.h"
+#include "unit-constants.h"
+#include "xml/repr.h"
+#include "xml/rebase-hrefs.h"
 
-#define SP_DOCUMENT_UPDATE_PRIORITY (G_PRIORITY_HIGH_IDLE - 1)
+// Higher number means lower priority.
+#define SP_DOCUMENT_UPDATE_PRIORITY (G_PRIORITY_HIGH_IDLE - 2)
+
+// Should have a lower priority than SP_DOCUMENT_UPDATE_PRIORITY,
+// since we want it to happen when there are no more updates.
+#define SP_DOCUMENT_REROUTING_PRIORITY (G_PRIORITY_HIGH_IDLE - 1)
 
 
 static gint sp_document_idle_handler(gpointer data);
+static gint sp_document_rerouting_handler(gpointer data);
 
 gboolean sp_document_resource_list_free(gpointer key, gpointer value, gpointer data);
 
@@ -89,15 +94,17 @@ SPDocument::SPDocument() :
     priv(0), // reset in ctor
     actionkey(0),
     modified_id(0),
+    rerouting_handler_id(0),
     profileManager(0), // deferred until after other initialization
-    router(new Avoid::Router()),
+    router(new Avoid::Router(Avoid::PolyLineRouting|Avoid::OrthogonalRouting)),
     perspectives(0),
     current_persp3d(0),
     _collection_queue(0),
     oldSignalsConnected(false)
 {
-    // Don't use the Consolidate moves optimisation.
-    router->ConsolidateMoves = false;
+    // Penalise libavoid for choosing paths with needless extra segments.
+    // This results in much better looking orthogonal connector paths.
+    router->setRoutingPenalty(Avoid::segmentPenalty);
 
     SPDocumentPrivate *p = new SPDocumentPrivate();
 
@@ -133,6 +140,11 @@ SPDocument::~SPDocument() {
         profileManager = 0;
     }
 
+    if (router) {
+        delete router;
+        router = NULL;
+    }
+
     if (priv) {
         if (priv->partial) {
             sp_repr_free_log(priv->partial);
@@ -178,10 +190,15 @@ SPDocument::~SPDocument() {
     }
 
     if (modified_id) {
-        gtk_idle_remove(modified_id);
+        g_source_remove(modified_id);
         modified_id = 0;
     }
 
+    if (rerouting_handler_id) {
+        g_source_remove(rerouting_handler_id);
+        rerouting_handler_id = 0;
+    }
+
     if (oldSignalsConnected) {
         g_signal_handlers_disconnect_by_func(G_OBJECT(INKSCAPE),
                                              reinterpret_cast<gpointer>(sp_document_reset_key),
@@ -196,13 +213,7 @@ SPDocument::~SPDocument() {
         keepalive = FALSE;
     }
 
-    if (router) {
-        delete router;
-        router = NULL;
-    }
-
     //delete this->_whiteboard_session_manager;
-
 }
 
 void SPDocument::add_persp3d (Persp3D * const /*persp*/)
@@ -225,6 +236,14 @@ void SPDocument::remove_persp3d (Persp3D * const /*persp*/)
     g_print ("Please implement deletion of perspectives here.\n");
 }
 
+void SPDocument::initialize_current_persp3d()
+{
+    this->current_persp3d = persp3d_document_first_persp(this);
+    if (!this->current_persp3d) {
+        this->current_persp3d = persp3d_create_xml_element(this);
+    }
+}
+
 unsigned long SPDocument::serial() const {
     return priv->serial;
 }
@@ -264,7 +283,6 @@ sp_document_create(Inkscape::XML::Document *rdoc,
 {
     SPDocument *document;
     Inkscape::XML::Node *rroot;
-    Inkscape::Version sodipodi_version;
     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 
     rroot = rdoc->root();
@@ -277,7 +295,7 @@ sp_document_create(Inkscape::XML::Document *rdoc,
     document->rroot = rroot;
 
 #ifndef WIN32
-    prepend_current_dir_if_relative(&(document->uri), uri);
+    document->uri = prepend_current_dir_if_relative(uri);
 #else
     // FIXME: it may be that prepend_current_dir_if_relative works OK on windows too, test!
     document->uri = uri? g_strdup(uri) : NULL;
@@ -294,10 +312,7 @@ sp_document_create(Inkscape::XML::Document *rdoc,
 
     document->root = sp_object_repr_build_tree(document, rroot);
 
-    sodipodi_version = SP_ROOT(document->root)->version.sodipodi;
-
     /* fixme: Not sure about this, but lets assume ::build updates */
-    rroot->setAttribute("sodipodi:version", SODIPODI_VERSION);
     rroot->setAttribute("inkscape:version", Inkscape::version_string);
     /* fixme: Again, I moved these here to allow version determining in ::build (Lauris) */
 
@@ -314,7 +329,7 @@ sp_document_create(Inkscape::XML::Document *rdoc,
 
     /* Eliminate obsolete sodipodi:docbase, for privacy reasons */
     rroot->setAttribute("sodipodi:docbase", NULL);
-    
+
     /* Eliminate any claim to adhere to a profile, as we don't try to */
     rroot->setAttribute("baseProfile", NULL);
 
@@ -322,7 +337,7 @@ sp_document_create(Inkscape::XML::Document *rdoc,
     if (!sp_item_group_get_child_by_name((SPGroup *) document->root, NULL, "sodipodi:namedview")) {
         // if there's none in the document already,
         Inkscape::XML::Node *rnew = NULL;
-        
+
         rnew = rdoc->createElement("sodipodi:namedview");
         //rnew->setAttribute("id", "base");
 
@@ -352,7 +367,7 @@ sp_document_create(Inkscape::XML::Document *rdoc,
             prefs->getInt("/template/base/inkscape:window-width", 640));
         sp_repr_set_int(rnew, "inkscape:window-height",
             prefs->getInt("/template/base/inkscape:window-height", 480));
-        
+
         // insert into the document
         rroot->addChild(rnew, NULL);
         // clean up
@@ -378,11 +393,7 @@ sp_document_create(Inkscape::XML::Document *rdoc,
     // 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);
-    }
+    document->initialize_current_persp3d();
 
     sp_document_set_undo_sensitive(document, true);
 
@@ -610,54 +621,83 @@ void SPDocument::fitToRect(Geom::Rect const &rect)
     }
 }
 
-void sp_document_set_uri(SPDocument *document, gchar const *uri)
+static void
+do_change_uri(SPDocument *const document, gchar const *const filename, bool const rebase)
 {
     g_return_if_fail(document != NULL);
 
-    if (document->name) {
-        g_free(document->name);
-        document->name = NULL;
-    }
-    if (document->base) {
-        g_free(document->base);
-        document->base = NULL;
-    }
-    if (document->uri) {
-        g_free(document->uri);
-        document->uri = NULL;
-    }
-
-    if (uri) {
+    gchar *new_base;
+    gchar *new_name;
+    gchar *new_uri;
+    if (filename) {
 
 #ifndef WIN32
-        prepend_current_dir_if_relative(&(document->uri), uri);
+        new_uri = prepend_current_dir_if_relative(filename);
 #else
         // FIXME: it may be that prepend_current_dir_if_relative works OK on windows too, test!
-        document->uri = g_strdup(uri);
+        new_uri = g_strdup(filename);
 #endif
 
-        /* fixme: Think, what this means for images (Lauris) */
-        document->base = g_path_get_dirname(document->uri);
-        document->name = g_path_get_basename(document->uri);
-
+        new_base = g_path_get_dirname(new_uri);
+        new_name = g_path_get_basename(new_uri);
     } else {
-        document->uri = g_strdup_printf(_("Unnamed document %d"), ++doc_count);
-        document->base = NULL;
-        document->name = g_strdup(document->uri);
+        new_uri = g_strdup_printf(_("Unnamed document %d"), ++doc_count);
+        new_base = NULL;
+        new_name = g_strdup(document->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
-    bool saved = sp_document_get_undo_sensitive(document);
+
+    // Changing uri in the document repr must not be not undoable.
+    bool const saved = sp_document_get_undo_sensitive(document);
     sp_document_set_undo_sensitive(document, false);
 
+    if (rebase) {
+        Inkscape::XML::rebase_hrefs(document, new_base, true);
+    }
+
     repr->setAttribute("sodipodi:docname", document->name);
     sp_document_set_undo_sensitive(document, saved);
 
+
+    g_free(document->name);
+    g_free(document->base);
+    g_free(document->uri);
+    document->name = new_name;
+    document->base = new_base;
+    document->uri = new_uri;
+
     document->priv->uri_set_signal.emit(document->uri);
 }
 
+/**
+ * Sets base, name and uri members of \a document.  Doesn't update
+ * any relative hrefs in the document: thus, this is primarily for
+ * newly-created documents.
+ *
+ * \see sp_document_change_uri_and_hrefs
+ */
+void sp_document_set_uri(SPDocument *document, gchar const *filename)
+{
+    g_return_if_fail(document != NULL);
+
+    do_change_uri(document, filename, false);
+}
+
+/**
+ * Changes the base, name and uri members of \a document, and updates any
+ * relative hrefs in the document to be relative to the new base.
+ *
+ * \see sp_document_set_uri
+ */
+void sp_document_change_uri_and_hrefs(SPDocument *document, gchar const *filename)
+{
+    g_return_if_fail(document != NULL);
+
+    do_change_uri(document, filename, true);
+}
+
 void
 sp_document_resized_signal_emit(SPDocument *doc, gdouble width, gdouble height)
 {
@@ -706,6 +746,10 @@ SPDocument::emitReconstructionFinish(void)
 {
     // printf("Finishing Reconstruction\n");
     priv->_reconstruction_finish_signal.emit();
+    
+    // Reference to the old persp3d object is invalid after reconstruction.
+    initialize_current_persp3d();
+    
     return;
 }
 
@@ -802,7 +846,7 @@ Glib::ustring SPDocument::getLanguage() {
         }
 
         if ( NULL != document_language ) {
-            gchar *pos = strchr(document_language, '_');
+            const char *pos = strchr(document_language, '_');
             if ( NULL != pos ) {
                 return Glib::ustring(document_language, pos - document_language);
             }
@@ -820,7 +864,12 @@ void
 sp_document_request_modified(SPDocument *doc)
 {
     if (!doc->modified_id) {
-        doc->modified_id = gtk_idle_add_priority(SP_DOCUMENT_UPDATE_PRIORITY, sp_document_idle_handler, doc);
+        doc->modified_id = g_idle_add_full(SP_DOCUMENT_UPDATE_PRIORITY, 
+                sp_document_idle_handler, doc, NULL);
+    }
+    if (!doc->rerouting_handler_id) {
+        doc->rerouting_handler_id = g_idle_add_full(SP_DOCUMENT_REROUTING_PRIORITY, 
+                sp_document_rerouting_handler, doc, NULL);
     }
 }
 
@@ -882,20 +931,43 @@ SPDocument::_updateDocument()
 gint
 sp_document_ensure_up_to_date(SPDocument *doc)
 {
+    // Bring the document up-to-date, specifically via the following:
+    //   1a) Process all document updates.
+    //   1b) When completed, process connector routing changes.
+    //   2a) Process any updates resulting from connector reroutings.
     int counter = 32;
-    while (!doc->_updateDocument()) {
-        if (counter == 0) {
-            g_warning("More than 32 iteration while updating document '%s'", doc->uri);
+    for (unsigned int pass = 1; pass <= 2; ++pass) {
+        // Process document updates.
+        while (!doc->_updateDocument()) {
+            if (counter == 0) {
+                g_warning("More than 32 iteration while updating document '%s'", doc->uri);
+                break;
+            }
+            counter--;
+        }
+        if (counter == 0)
+        {
             break;
         }
-        counter--;
-    }
 
+        // After updates on the first pass we get libavoid to process all the 
+        // changed objects and provide new routings.  This may cause some objects
+            // to be modified, hence the second update pass.
+        if (pass == 1) {
+            doc->router->processTransaction();
+        }
+    }
+    
     if (doc->modified_id) {
         /* Remove handler */
-        gtk_idle_remove(doc->modified_id);
+        g_source_remove(doc->modified_id);
         doc->modified_id = 0;
     }
+    if (doc->rerouting_handler_id) {
+        /* Remove handler */
+        g_source_remove(doc->rerouting_handler_id);
+        doc->rerouting_handler_id = 0;
+    }
     return counter>0;
 }
 
@@ -915,6 +987,24 @@ sp_document_idle_handler(gpointer data)
     }
 }
 
+/**
+ * An idle handler to reroute connectors in the document.  
+ */
+static gint
+sp_document_rerouting_handler(gpointer data)
+{
+    // Process any queued movement actions and determine new routings for 
+    // object-avoiding connectors.  Callbacks will be used to update and 
+    // redraw affected connectors.
+    SPDocument *doc = static_cast<SPDocument *>(data);
+    doc->router->processTransaction();
+    
+    // We don't need to handle rerouting again until there are further 
+    // diagram updates.
+    doc->rerouting_handler_id = 0;
+    return false;
+}
+
 static bool is_within(Geom::Rect const &area, Geom::Rect const &box)
 {
     return area.contains(box);