diff --git a/src/document.cpp b/src/document.cpp
index 4289205c121b45d9223c75a4d728983a6e975165..a3ad6f7beb1486a4bc236e6d0ff44213b2d89ef5 100644 (file)
--- a/src/document.cpp
+++ b/src/document.cpp
-#define __DOCUMENT_C__
+#define __SP_DOCUMENT_C__
/** \file
- * Document manipulation
+ * SPDocument manipulation
*
* Authors:
* Lauris Kaplinski <lauris@kaplinski.com>
* Released under GNU GPL, read the file 'COPYING' for more information
*/
-/** \class Document
- * Document serves as the container of both model trees (agnostic XML
+/** \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
- * load, save, print, export and so on, use Document as their basic datatype.
+ * load, save, print, export and so on, use SPDocument as their basic datatype.
*
- * Document implements undo and redo stacks and an id-based object
+ * SPDocument implements undo and redo stacks and an id-based object
* dictionary. Thanks to unique id attributes, the latter can be used to
* map from the XML tree back to the object tree.
*
- * Document performs the basic operations needed for asynchronous
+ * SPDocument performs the basic operations needed for asynchronous
* update notification (SPObject ::modified virtual method), and implements
* the 'modified' signal, as well.
*/
#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);
static unsigned long next_serial = 0;
-Document::Document() :
+SPDocument::SPDocument() :
keepalive(FALSE),
virgin(TRUE),
modified_since_save(FALSE),
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);
- DocumentPrivate *p = new DocumentPrivate();
+ SPDocumentPrivate *p = new SPDocumentPrivate();
p->serial = next_serial++;
priv->undoStackObservers.add(p->console_output_undo_observer);
}
-Document::~Document() {
+SPDocument::~SPDocument() {
collectOrphans();
// kill/unhook this first
profileManager = 0;
}
+ if (router) {
+ delete router;
+ router = NULL;
+ }
+
if (priv) {
if (priv->partial) {
sp_repr_free_log(priv->partial);
}
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),
keepalive = FALSE;
}
- if (router) {
- delete router;
- router = NULL;
- }
-
//delete this->_whiteboard_session_manager;
-
}
-void Document::add_persp3d (Persp3D * const /*persp*/)
+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) ) {
persp3d_create_xml_element (this);
}
-void Document::remove_persp3d (Persp3D * const /*persp*/)
+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 Document::serial() const {
+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;
}
-void Document::queueForOrphanCollection(SPObject *object) {
+void SPDocument::queueForOrphanCollection(SPObject *object) {
g_return_if_fail(object != NULL);
g_return_if_fail(SP_OBJECT_DOCUMENT(object) == this);
_collection_queue = g_slist_prepend(_collection_queue, object);
}
-void Document::collectOrphans() {
+void SPDocument::collectOrphans() {
while (_collection_queue) {
GSList *objects=_collection_queue;
_collection_queue = NULL;
}
}
-void Document::reset_key (void */*dummy*/)
+void SPDocument::reset_key (void */*dummy*/)
{
actionkey = NULL;
}
-Document *
+SPDocument *
sp_document_create(Inkscape::XML::Document *rdoc,
gchar const *uri,
gchar const *base,
gchar const *name,
unsigned int keepalive)
{
- Document *document;
+ SPDocument *document;
Inkscape::XML::Node *rroot;
Inkscape::Preferences *prefs = Inkscape::Preferences::get();
rroot = rdoc->root();
- document = new Document();
+ document = new SPDocument();
document->keepalive = keepalive;
// 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);
G_CALLBACK(sp_document_reset_key), document);
document->oldSignalsConnected = true;
} else {
- document->_selection_changed_connection = Inkscape::NSApplication::Editor::connectSelectionChanged (sigc::mem_fun (*document, &Document::reset_key));
- document->_desktop_activated_connection = Inkscape::NSApplication::Editor::connectDesktopActivated (sigc::mem_fun (*document, &Document::reset_key));
+ 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));
document->oldSignalsConnected = false;
}
* Fetches document from URI, or creates new, if NULL; public document
* appears in document list.
*/
-Document *
+SPDocument *
sp_document_new(gchar const *uri, unsigned int keepalive, bool make_new)
{
- Document *doc;
+ SPDocument *doc;
Inkscape::XML::Document *rdoc;
gchar *base = NULL;
gchar *name = NULL;
return doc;
}
-Document *
+SPDocument *
sp_document_new_from_mem(gchar const *buffer, gint length, unsigned int keepalive)
{
- Document *doc;
+ SPDocument *doc;
Inkscape::XML::Document *rdoc;
Inkscape::XML::Node *rroot;
gchar *name;
@@ -477,23 +493,23 @@ sp_document_new_from_mem(gchar const *buffer, gint length, unsigned int keepaliv
return doc;
}
-Document *
-sp_document_ref(Document *doc)
+SPDocument *
+sp_document_ref(SPDocument *doc)
{
g_return_val_if_fail(doc != NULL, NULL);
Inkscape::GC::anchor(doc);
return doc;
}
-Document *
-sp_document_unref(Document *doc)
+SPDocument *
+sp_document_unref(SPDocument *doc)
{
g_return_val_if_fail(doc != NULL, NULL);
Inkscape::GC::release(doc);
return NULL;
}
-gdouble sp_document_width(Document *document)
+gdouble sp_document_width(SPDocument *document)
{
g_return_val_if_fail(document != NULL, 0.0);
g_return_val_if_fail(document->priv != NULL, 0.0);
}
void
-sp_document_set_width (Document *document, gdouble width, const SPUnit *unit)
+sp_document_set_width (SPDocument *document, gdouble width, const SPUnit *unit)
{
SPRoot *root = SP_ROOT(document->root);
SP_OBJECT (root)->updateRepr();
}
-void sp_document_set_height (Document * document, gdouble height, const SPUnit *unit)
+void sp_document_set_height (SPDocument * document, gdouble height, const SPUnit *unit)
{
SPRoot *root = SP_ROOT(document->root);
@@ -559,7 +575,7 @@ void sp_document_set_height (Document * document, gdouble height, const SPUnit *
SP_OBJECT (root)->updateRepr();
}
-gdouble sp_document_height(Document *document)
+gdouble sp_document_height(SPDocument *document)
{
g_return_val_if_fail(document != NULL, 0.0);
g_return_val_if_fail(document->priv != NULL, 0.0);
return root->height.computed;
}
-Geom::Point sp_document_dimensions(Document *doc)
+Geom::Point sp_document_dimensions(SPDocument *doc)
{
return Geom::Point(sp_document_width(doc), sp_document_height(doc));
}
* this function fits the canvas to that rect by resizing the canvas
* and translating the document root into position.
*/
-void Document::fitToRect(Geom::Rect const &rect)
+void SPDocument::fitToRect(Geom::Rect const &rect)
{
double const w = rect.width();
double const h = rect.height();
}
static void
-do_change_uri(Document *const document, gchar const *const filename, bool const rebase)
+do_change_uri(SPDocument *const document, gchar const *const filename, bool const rebase)
{
g_return_if_fail(document != NULL);
sp_document_set_undo_sensitive(document, false);
if (rebase) {
- Inkscape::XML::rebase_hrefs((Inkscape::XML::Document *)document, new_base, true);
+ Inkscape::XML::rebase_hrefs(document, new_base, true);
}
repr->setAttribute("sodipodi:docname", document->name);
*
* \see sp_document_change_uri_and_hrefs
*/
-void sp_document_set_uri(Document *document, gchar const *filename)
+void sp_document_set_uri(SPDocument *document, gchar const *filename)
{
g_return_if_fail(document != NULL);
*
* \see sp_document_set_uri
*/
-void sp_document_change_uri_and_hrefs(Document *document, gchar const *filename)
+void sp_document_change_uri_and_hrefs(SPDocument *document, gchar const *filename)
{
g_return_if_fail(document != NULL);
@@ -683,36 +699,36 @@ void sp_document_change_uri_and_hrefs(Document *document, gchar const *filename)
}
void
-sp_document_resized_signal_emit(Document *doc, gdouble width, gdouble height)
+sp_document_resized_signal_emit(SPDocument *doc, gdouble width, gdouble height)
{
g_return_if_fail(doc != NULL);
doc->priv->resized_signal.emit(width, height);
}
-sigc::connection Document::connectModified(Document::ModifiedSignal::slot_type slot)
+sigc::connection SPDocument::connectModified(SPDocument::ModifiedSignal::slot_type slot)
{
return priv->modified_signal.connect(slot);
}
-sigc::connection Document::connectURISet(Document::URISetSignal::slot_type slot)
+sigc::connection SPDocument::connectURISet(SPDocument::URISetSignal::slot_type slot)
{
return priv->uri_set_signal.connect(slot);
}
-sigc::connection Document::connectResized(Document::ResizedSignal::slot_type slot)
+sigc::connection SPDocument::connectResized(SPDocument::ResizedSignal::slot_type slot)
{
return priv->resized_signal.connect(slot);
}
sigc::connection
-Document::connectReconstructionStart(Document::ReconstructionStart::slot_type slot)
+SPDocument::connectReconstructionStart(SPDocument::ReconstructionStart::slot_type slot)
{
return priv->_reconstruction_start_signal.connect(slot);
}
void
-Document::emitReconstructionStart(void)
+SPDocument::emitReconstructionStart(void)
{
// printf("Starting Reconstruction\n");
priv->_reconstruction_start_signal.emit();
}
sigc::connection
-Document::connectReconstructionFinish(Document::ReconstructionFinish::slot_type slot)
+SPDocument::connectReconstructionFinish(SPDocument::ReconstructionFinish::slot_type slot)
{
return priv->_reconstruction_finish_signal.connect(slot);
}
void
-Document::emitReconstructionFinish(void)
+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;
}
-sigc::connection Document::connectCommit(Document::CommitSignal::slot_type slot)
+sigc::connection SPDocument::connectCommit(SPDocument::CommitSignal::slot_type slot)
{
return priv->commit_signal.connect(slot);
}
-void Document::_emitModified() {
+void SPDocument::_emitModified() {
static guint const flags = SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG | SP_OBJECT_PARENT_MODIFIED_FLAG;
root->emitModified(0);
priv->modified_signal.emit(flags);
}
-void Document::bindObjectToId(gchar const *id, SPObject *object) {
+void SPDocument::bindObjectToId(gchar const *id, SPObject *object) {
GQuark idq = g_quark_from_string(id);
if (object) {
g_hash_table_remove(priv->iddef, GINT_TO_POINTER(idq));
}
- DocumentPrivate::IDChangedSignalMap::iterator pos;
+ SPDocumentPrivate::IDChangedSignalMap::iterator pos;
pos = priv->id_changed_signals.find(idq);
if ( pos != priv->id_changed_signals.end() ) {
}
void
-Document::addUndoObserver(Inkscape::UndoStackObserver& observer)
+SPDocument::addUndoObserver(Inkscape::UndoStackObserver& observer)
{
this->priv->undoStackObservers.add(observer);
}
void
-Document::removeUndoObserver(Inkscape::UndoStackObserver& observer)
+SPDocument::removeUndoObserver(Inkscape::UndoStackObserver& observer)
{
this->priv->undoStackObservers.remove(observer);
}
-SPObject *Document::getObjectById(gchar const *id) {
+SPObject *SPDocument::getObjectById(gchar const *id) {
g_return_val_if_fail(id != NULL, NULL);
GQuark idq = g_quark_from_string(id);
return (SPObject*)g_hash_table_lookup(priv->iddef, GINT_TO_POINTER(idq));
}
-sigc::connection Document::connectIdChanged(gchar const *id,
- Document::IDChangedSignal::slot_type slot)
+sigc::connection SPDocument::connectIdChanged(gchar const *id,
+ SPDocument::IDChangedSignal::slot_type slot)
{
return priv->id_changed_signals[g_quark_from_string(id)].connect(slot);
}
-void Document::bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object) {
+void SPDocument::bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object) {
if (object) {
g_assert(g_hash_table_lookup(priv->reprdef, repr) == NULL);
g_hash_table_insert(priv->reprdef, repr, object);
@@ -804,12 +824,12 @@ void Document::bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object) {
}
}
-SPObject *Document::getObjectByRepr(Inkscape::XML::Node *repr) {
+SPObject *SPDocument::getObjectByRepr(Inkscape::XML::Node *repr) {
g_return_val_if_fail(repr != NULL, NULL);
return (SPObject*)g_hash_table_lookup(priv->reprdef, repr);
}
-Glib::ustring Document::getLanguage() {
+Glib::ustring SPDocument::getLanguage() {
gchar const *document_language = rdf_get_work_entity(this, rdf_find_entity("language"));
if (document_language) {
while (isspace(*document_language))
/* Object modification root handler */
void
-sp_document_request_modified(Document *doc)
+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);
}
}
void
-sp_document_setup_viewport (Document *doc, SPItemCtx *ctx)
+sp_document_setup_viewport (SPDocument *doc, SPItemCtx *ctx)
{
ctx->ctx.flags = 0;
ctx->i2doc = Geom::identity();
* been brought fully up to date.
*/
bool
-Document::_updateDocument()
+SPDocument::_updateDocument()
{
/* Process updates */
if (this->root->uflags || this->root->mflags) {
* since this typically indicates we're stuck in an update loop.
*/
gint
-sp_document_ensure_up_to_date(Document *doc)
+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;
}
static gint
sp_document_idle_handler(gpointer data)
{
- Document *doc = static_cast<Document *>(data);
+ SPDocument *doc = static_cast<SPDocument *>(data);
if (doc->_updateDocument()) {
doc->modified_id = 0;
return false;
}
}
+/**
+ * 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);
*
*/
-GSList *sp_document_items_in_box(Document *document, unsigned int dkey, Geom::Rect const &box)
+GSList *sp_document_items_in_box(SPDocument *document, unsigned int dkey, Geom::Rect const &box)
{
g_return_val_if_fail(document != NULL, NULL);
g_return_val_if_fail(document->priv != NULL, NULL);
@@ -1121,7 +1187,7 @@ GSList *sp_document_items_in_box(Document *document, unsigned int dkey, Geom::Re
*
*/
-GSList *sp_document_partial_items_in_box(Document *document, unsigned int dkey, Geom::Rect const &box)
+GSList *sp_document_partial_items_in_box(SPDocument *document, unsigned int dkey, Geom::Rect const &box)
{
g_return_val_if_fail(document != NULL, NULL);
g_return_val_if_fail(document->priv != NULL, NULL);
@@ -1130,7 +1196,7 @@ GSList *sp_document_partial_items_in_box(Document *document, unsigned int dkey,
}
GSList *
-sp_document_items_at_points(Document *document, unsigned const key, std::vector<Geom::Point> points)
+sp_document_items_at_points(SPDocument *document, unsigned const key, std::vector<Geom::Point> points)
{
GSList *items = NULL;
Inkscape::Preferences *prefs = Inkscape::Preferences::get();
@@ -1155,7 +1221,7 @@ sp_document_items_at_points(Document *document, unsigned const key, std::vector<
}
SPItem *
-sp_document_item_at_point(Document *document, unsigned const key, Geom::Point const p,
+sp_document_item_at_point(SPDocument *document, unsigned const key, Geom::Point const p,
gboolean const into_groups, SPItem *upto)
{
g_return_val_if_fail(document != NULL, NULL);
@@ -1165,7 +1231,7 @@ sp_document_item_at_point(Document *document, unsigned const key, Geom::Point co
}
SPItem*
-sp_document_group_at_point(Document *document, unsigned int key, Geom::Point const p)
+sp_document_group_at_point(SPDocument *document, unsigned int key, Geom::Point const p)
{
g_return_val_if_fail(document != NULL, NULL);
g_return_val_if_fail(document->priv != NULL, NULL);
@@ -1177,7 +1243,7 @@ sp_document_group_at_point(Document *document, unsigned int key, Geom::Point con
/* Resource management */
gboolean
-sp_document_add_resource(Document *document, gchar const *key, SPObject *object)
+sp_document_add_resource(SPDocument *document, gchar const *key, SPObject *object)
{
GSList *rlist;
GQuark q = g_quark_from_string(key);
@@ -1202,7 +1268,7 @@ sp_document_add_resource(Document *document, gchar const *key, SPObject *object)
}
gboolean
-sp_document_remove_resource(Document *document, gchar const *key, SPObject *object)
+sp_document_remove_resource(SPDocument *document, gchar const *key, SPObject *object)
{
GSList *rlist;
GQuark q = g_quark_from_string(key);
@@ -1228,7 +1294,7 @@ sp_document_remove_resource(Document *document, gchar const *key, SPObject *obje
}
GSList const *
-sp_document_get_resource_list(Document *document, gchar const *key)
+sp_document_get_resource_list(SPDocument *document, gchar const *key)
{
g_return_val_if_fail(document != NULL, NULL);
g_return_val_if_fail(key != NULL, NULL);
return (GSList*)g_hash_table_lookup(document->priv->resources, key);
}
-sigc::connection sp_document_resources_changed_connect(Document *document,
+sigc::connection sp_document_resources_changed_connect(SPDocument *document,
gchar const *key,
- Document::ResourcesChangedSignal::slot_type slot)
+ SPDocument::ResourcesChangedSignal::slot_type slot)
{
GQuark q = g_quark_from_string(key);
return document->priv->resources_changed_signals[q].connect(slot);
}
unsigned int
-objects_in_document(Document *document)
+objects_in_document(SPDocument *document)
{
return count_objects_recursive(SP_DOCUMENT_ROOT(document), 0);
}
}
unsigned int
-vacuum_document(Document *document)
+vacuum_document(SPDocument *document)
{
unsigned int start = objects_in_document(document);
unsigned int end;
return start - newend;
}
-bool Document::isSeeking() const {
+bool SPDocument::isSeeking() const {
return priv->seeking;
}