sp-use.cpp revision 1853b6fb3034af6c1d69d83b96c377a50a17e38a
/*
* SVG <use> implementation
*
* Authors:
* Lauris Kaplinski <lauris@kaplinski.com>
* bulia byak <buliabyak@users.sf.net>
* Jon A. Cruz <jon@joncruz.org>
* Abhishek Sharma
*
* Copyright (C) 1999-2005 authors
* Copyright (C) 2000-2001 Ximian, Inc.
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <cstring>
#include <string>
#include <2geom/transforms.h>
#include <glibmm/i18n.h>
#include "display/drawing-group.h"
#include "attributes.h"
#include "document.h"
#include "sp-object-repr.h"
#include "sp-flowregion.h"
#include "uri.h"
#include "print.h"
#include "xml/repr.h"
#include "svg/svg.h"
#include "preferences.h"
#include "style.h"
#include "sp-symbol.h"
#include "sp-use.h"
#include "sp-use-reference.h"
/* fixme: */
static void sp_use_finalize(GObject *obj);
static void sp_use_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
static void sp_use_release(SPObject *object);
static void sp_use_set(SPObject *object, unsigned key, gchar const *value);
static Inkscape::XML::Node *sp_use_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
static void sp_use_update(SPObject *object, SPCtx *ctx, guint flags);
static void sp_use_modified(SPObject *object, guint flags);
static Geom::OptRect sp_use_bbox(SPItem const *item, Geom::Affine const &transform, SPItem::BBoxType type);
static void sp_use_snappoints(SPItem const *item, std::vector<Inkscape::SnapCandidatePoint> &p, Inkscape::SnapPreferences const *snapprefs);
static void sp_use_print(SPItem *item, SPPrintContext *ctx);
static gchar *sp_use_description(SPItem *item);
static Inkscape::DrawingItem *sp_use_show(SPItem *item, Inkscape::Drawing &drawing, unsigned key, unsigned flags);
static void sp_use_hide(SPItem *item, unsigned key);
static void sp_use_href_changed(SPObject *old_ref, SPObject *ref, SPUse *use);
static void sp_use_delete_self(SPObject *deleted, SPUse *self);
//void m_print(gchar *say, Geom::Affine m)
//{ g_print("%s %g %g %g %g %g %g\n", say, m[0], m[1], m[2], m[3], m[4], m[5]); }
G_DEFINE_TYPE(SPUse, sp_use, SP_TYPE_ITEM);
static void
sp_use_class_init(SPUseClass *classname)
{
GObjectClass *gobject_class = (GObjectClass *) classname;
SPObjectClass *sp_object_class = (SPObjectClass *) classname;
SPItemClass *item_class = (SPItemClass *) classname;
gobject_class->finalize = sp_use_finalize;
sp_object_class->build = sp_use_build;
sp_object_class->release = sp_use_release;
sp_object_class->set = sp_use_set;
sp_object_class->write = sp_use_write;
sp_object_class->update = sp_use_update;
sp_object_class->modified = sp_use_modified;
item_class->bbox = sp_use_bbox;
item_class->description = sp_use_description;
item_class->print = sp_use_print;
item_class->show = sp_use_show;
item_class->hide = sp_use_hide;
item_class->snappoints = sp_use_snappoints;
}
static void
sp_use_init(SPUse *use)
{
use->x.unset();
use->y.unset();
use->width.unset(SVGLength::PERCENT, 1.0, 1.0);
use->height.unset(SVGLength::PERCENT, 1.0, 1.0);
use->href = NULL;
new (&use->_delete_connection) sigc::connection();
new (&use->_changed_connection) sigc::connection();
new (&use->_transformed_connection) sigc::connection();
use->ref = new SPUseReference(use);
use->_changed_connection = use->ref->changedSignal().connect(sigc::bind(sigc::ptr_fun(sp_use_href_changed), use));
}
static void
sp_use_finalize(GObject *obj)
{
SPUse *use = reinterpret_cast<SPUse *>(obj);
if (use->child) {
use->detach(use->child);
use->child = NULL;
}
use->ref->detach();
delete use->ref;
use->ref = 0;
use->_delete_connection.~connection();
use->_changed_connection.~connection();
use->_transformed_connection.~connection();
}
static void
sp_use_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
{
if (((SPObjectClass *) sp_use_parent_class)->build) {
(* ((SPObjectClass *) sp_use_parent_class)->build)(object, document, repr);
}
object->readAttr( "x" );
object->readAttr( "y" );
object->readAttr( "width" );
object->readAttr( "height" );
object->readAttr( "xlink:href" );
// We don't need to create child here:
// reading xlink:href will attach ref, and that will cause the changed signal to be emitted,
// which will call sp_use_href_changed, and that will take care of the child
}
static void
sp_use_release(SPObject *object)
{
SPUse *use = SP_USE(object);
if (use->child) {
object->detach(use->child);
use->child = NULL;
}
use->_delete_connection.disconnect();
use->_changed_connection.disconnect();
use->_transformed_connection.disconnect();
g_free(use->href);
use->href = NULL;
use->ref->detach();
if (((SPObjectClass *) sp_use_parent_class)->release) {
((SPObjectClass *) sp_use_parent_class)->release(object);
}
}
static void
sp_use_set(SPObject *object, unsigned key, gchar const *value)
{
SPUse *use = SP_USE(object);
switch (key) {
case SP_ATTR_X:
use->x.readOrUnset(value);
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_Y:
use->y.readOrUnset(value);
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_WIDTH:
use->width.readOrUnset(value, SVGLength::PERCENT, 1.0, 1.0);
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_HEIGHT:
use->height.readOrUnset(value, SVGLength::PERCENT, 1.0, 1.0);
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_XLINK_HREF: {
if ( value && use->href && ( strcmp(value, use->href) == 0 ) ) {
/* No change, do nothing. */
} else {
g_free(use->href);
use->href = NULL;
if (value) {
// First, set the href field, because sp_use_href_changed will need it.
use->href = g_strdup(value);
// Now do the attaching, which emits the changed signal.
try {
use->ref->attach(Inkscape::URI(value));
} catch (Inkscape::BadURIException &e) {
g_warning("%s", e.what());
use->ref->detach();
}
} else {
use->ref->detach();
}
}
break;
}
default:
if (((SPObjectClass *) sp_use_parent_class)->set) {
((SPObjectClass *) sp_use_parent_class)->set(object, key, value);
}
break;
}
}
static Inkscape::XML::Node *
sp_use_write(SPObject *object, Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
{
SPUse *use = SP_USE(object);
if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
repr = xml_doc->createElement("svg:use");
}
if (((SPObjectClass *) (sp_use_parent_class))->write) {
((SPObjectClass *) (sp_use_parent_class))->write(object, xml_doc, repr, flags);
}
sp_repr_set_svg_double(repr, "x", use->x.computed);
sp_repr_set_svg_double(repr, "y", use->y.computed);
repr->setAttribute("width", sp_svg_length_write_with_units(use->width).c_str());
repr->setAttribute("height", sp_svg_length_write_with_units(use->height).c_str());
if (use->ref->getURI()) {
gchar *uri_string = use->ref->getURI()->toString();
repr->setAttribute("xlink:href", uri_string);
g_free(uri_string);
}
return repr;
}
static Geom::OptRect sp_use_bbox(SPItem const *item, Geom::Affine const &transform, SPItem::BBoxType type)
{
SPUse const *use = SP_USE(item);
Geom::OptRect bbox;
if (use->child && SP_IS_ITEM(use->child)) {
SPItem *child = SP_ITEM(use->child);
Geom::Affine const ct( child->transform
* Geom::Translate(use->x.computed,
use->y.computed)
* transform );
bbox = child->bounds(type, ct);
}
return bbox;
}
static void sp_use_print(SPItem *item, SPPrintContext *ctx)
{
bool translated = false;
SPUse *use = SP_USE(item);
if ((use->x._set && use->x.computed != 0) || (use->y._set && use->y.computed != 0)) {
Geom::Affine tp(Geom::Translate(use->x.computed, use->y.computed));
sp_print_bind(ctx, tp, 1.0);
translated = true;
}
if (use->child && SP_IS_ITEM(use->child)) {
SP_ITEM(use->child)->invoke_print(ctx);
}
if (translated) {
sp_print_release(ctx);
}
}
static gchar *sp_use_description(SPItem *item)
{
SPUse *use = SP_USE(item);
if (use->child) {
if( SP_IS_SYMBOL( use->child ) ) {
char *symbol_desc = SP_ITEM(use->child)->title();
return g_strdup_printf(_("<b>'%s' Symbol</b>"), symbol_desc );
g_free(symbol_desc);
}
static unsigned recursion_depth = 0;
if (recursion_depth >= 4) {
/* TRANSLATORS: Used for statusbar description for long <use> chains:
* "Clone of: Clone of: ... in Layer 1". */
return g_strdup(_("..."));
/* We could do better, e.g. chasing the href chain until we reach something other than
* a <use>, and giving its description. */
}
++recursion_depth;
char *child_desc = SP_ITEM(use->child)->description();
--recursion_depth;
char *ret = g_strdup_printf(_("<b>Clone</b> of: %s"), child_desc);
g_free(child_desc);
return ret;
} else {
return g_strdup(_("<b>Orphaned clone</b>"));
}
}
static Inkscape::DrawingItem *
sp_use_show(SPItem *item, Inkscape::Drawing &drawing, unsigned key, unsigned flags)
{
SPUse *use = SP_USE(item);
Inkscape::DrawingGroup *ai = new Inkscape::DrawingGroup(drawing);
ai->setPickChildren(false);
ai->setStyle(item->style);
if (use->child) {
Inkscape::DrawingItem *ac = SP_ITEM(use->child)->invoke_show(drawing, key, flags);
if (ac) {
ai->prependChild(ac);
}
Geom::Translate t(use->x.computed,
use->y.computed);
ai->setChildTransform(t);
}
return ai;
}
static void
sp_use_hide(SPItem *item, unsigned key)
{
SPUse *use = SP_USE(item);
if (use->child) {
SP_ITEM(use->child)->invoke_hide(key);
}
if (((SPItemClass *) sp_use_parent_class)->hide) {
((SPItemClass *) sp_use_parent_class)->hide(item, key);
}
}
/**
* Returns the ultimate original of a SPUse (i.e. the first object in the chain of its originals
* which is not an SPUse). If no original is found, NULL is returned (it is the responsibility
* of the caller to make sure that this is handled correctly).
*
* Note that the returned is the clone object, i.e. the child of an SPUse (of the argument one for
* the trivial case) and not the "true original".
*/
SPItem *
sp_use_root(SPUse *use)
{
SPObject *orig = use->child;
while (orig && SP_IS_USE(orig)) {
orig = SP_USE(orig)->child;
}
if (!orig || !SP_IS_ITEM(orig))
return NULL;
return SP_ITEM(orig);
}
/**
* Returns the effective transform that goes from the ultimate original to given SPUse, both ends
* included.
*/
Geom::Affine
sp_use_get_root_transform(SPUse *use)
{
//track the ultimate source of a chain of uses
SPObject *orig = use->child;
GSList *chain = NULL;
chain = g_slist_prepend(chain, use);
while (SP_IS_USE(orig)) {
chain = g_slist_prepend(chain, orig);
orig = SP_USE(orig)->child;
}
chain = g_slist_prepend(chain, orig);
//calculate the accummulated transform, starting from the original
Geom::Affine t(Geom::identity());
for (GSList *i = chain; i != NULL; i = i->next) {
SPItem *i_tem = SP_ITEM(i->data);
// "An additional transformation translate(x,y) is appended to the end (i.e.,
// right-side) of the transform attribute on the generated 'g', where x and y
// represent the values of the x and y attributes on the 'use' element." - http://www.w3.org/TR/SVG11/struct.html#UseElement
if (SP_IS_USE(i_tem)) {
SPUse *i_use = SP_USE(i_tem);
if ((i_use->x._set && i_use->x.computed != 0) || (i_use->y._set && i_use->y.computed != 0)) {
t = t * Geom::Translate(i_use->x._set ? i_use->x.computed : 0, i_use->y._set ? i_use->y.computed : 0);
}
}
t *= i_tem->transform;
}
g_slist_free(chain);
return t;
}
/**
* Returns the transform that leads to the use from its immediate original.
* Does not inlcude the original's transform if any.
*/
Geom::Affine
sp_use_get_parent_transform(SPUse *use)
{
Geom::Affine t(Geom::identity());
if ((use->x._set && use->x.computed != 0) || (use->y._set && use->y.computed != 0)) {
t *= Geom::Translate(use->x._set ? use->x.computed : 0,
use->y._set ? use->y.computed : 0);
}
t *= SP_ITEM(use)->transform;
return t;
}
/**
* Sensing a movement of the original, this function attempts to compensate for it in such a way
* that the clone stays unmoved or moves in parallel (depending on user setting) regardless of the
* clone's transform.
*/
static void
sp_use_move_compensate(Geom::Affine const *mp, SPItem */*original*/, SPUse *self)
{
// the clone is orphaned; or this is not a real use, but a clone of another use;
// we skip it, otherwise duplicate compensation will occur
if (self->cloned) {
return;
}
// never compensate uses which are used in flowtext
if (self->parent && SP_IS_FLOWREGION(self->parent)) {
return;
}
Inkscape::Preferences *prefs = Inkscape::Preferences::get();
guint mode = prefs->getInt("/options/clonecompensation/value", SP_CLONE_COMPENSATION_PARALLEL);
// user wants no compensation
if (mode == SP_CLONE_COMPENSATION_NONE)
return;
Geom::Affine m(*mp);
// this is not a simple move, do not try to compensate
if (!(m.isTranslation()))
return;
// restore item->transform field from the repr, in case it was changed by seltrans
self->readAttr ("transform");
Geom::Affine t = sp_use_get_parent_transform(self);
Geom::Affine clone_move = t.inverse() * m * t;
// calculate the compensation matrix and the advertized movement matrix
Geom::Affine advertized_move;
if (mode == SP_CLONE_COMPENSATION_PARALLEL) {
clone_move = clone_move.inverse() * m;
advertized_move = m;
} else if (mode == SP_CLONE_COMPENSATION_UNMOVED) {
clone_move = clone_move.inverse();
advertized_move.setIdentity();
} else {
g_assert_not_reached();
}
// commit the compensation
self->transform *= clone_move;
self->doWriteTransform(self->getRepr(), self->transform, &advertized_move);
self->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
}
static void
sp_use_href_changed(SPObject */*old_ref*/, SPObject */*ref*/, SPUse *use)
{
SPItem *item = SP_ITEM(use);
use->_delete_connection.disconnect();
use->_transformed_connection.disconnect();
if (use->child) {
use->detach(use->child);
use->child = NULL;
}
if (use->href) {
SPItem *refobj = use->ref->getObject();
if (refobj) {
Inkscape::XML::Node *childrepr = refobj->getRepr();
GType type = sp_repr_type_lookup(childrepr);
g_return_if_fail(type > G_TYPE_NONE);
if (g_type_is_a(type, SP_TYPE_ITEM)) {
use->child = (SPObject*) g_object_new(type, 0);
use->attach(use->child, use->lastChild());
sp_object_unref(use->child, use);
(use->child)->invoke_build(use->document, childrepr, TRUE);
for (SPItemView *v = item->display; v != NULL; v = v->next) {
Inkscape::DrawingItem *ai;
ai = SP_ITEM(use->child)->invoke_show(v->arenaitem->drawing(), v->key, v->flags);
if (ai) {
v->arenaitem->prependChild(ai);
}
}
}
use->_delete_connection = refobj->connectDelete(sigc::bind(sigc::ptr_fun(&sp_use_delete_self), use));
use->_transformed_connection = SP_ITEM(refobj)->connectTransformed(sigc::bind(sigc::ptr_fun(&sp_use_move_compensate), use));
}
}
}
static void
sp_use_delete_self(SPObject */*deleted*/, SPUse *self)
{
// always delete uses which are used in flowtext
if (self->parent && SP_IS_FLOWREGION(self->parent)) {
self->deleteObject();
return;
}
Inkscape::Preferences *prefs = Inkscape::Preferences::get();
guint const mode = prefs->getInt("/options/cloneorphans/value",
SP_CLONE_ORPHANS_UNLINK);
if (mode == SP_CLONE_ORPHANS_UNLINK) {
sp_use_unlink(self);
} else if (mode == SP_CLONE_ORPHANS_DELETE) {
self->deleteObject();
}
}
static void
sp_use_update(SPObject *object, SPCtx *ctx, unsigned flags)
{
SPItem *item = SP_ITEM(object);
SPUse *use = SP_USE(object);
SPItemCtx *ictx = (SPItemCtx *) ctx;
SPItemCtx cctx = *ictx;
if (((SPObjectClass *) (sp_use_parent_class))->update)
((SPObjectClass *) (sp_use_parent_class))->update(object, ctx, flags);
if (flags & SP_OBJECT_MODIFIED_FLAG) {
flags |= SP_OBJECT_PARENT_MODIFIED_FLAG;
}
flags &= SP_OBJECT_MODIFIED_CASCADE;
if (flags & SP_OBJECT_STYLE_MODIFIED_FLAG) {
for (SPItemView *v = SP_ITEM(object)->display; v != NULL; v = v->next) {
Inkscape::DrawingGroup *g = dynamic_cast<Inkscape::DrawingGroup *>(v->arenaitem);
g->setStyle(object->style);
}
}
/* Set up child viewport */
if (use->x.unit == SVGLength::PERCENT) {
use->x.computed = use->x.value * ictx->viewport.width();
}
if (use->y.unit == SVGLength::PERCENT) {
use->y.computed = use->y.value * ictx->viewport.height();
}
if (use->width.unit == SVGLength::PERCENT) {
use->width.computed = use->width.value * ictx->viewport.width();
}
if (use->height.unit == SVGLength::PERCENT) {
use->height.computed = use->height.value * ictx->viewport.height();
}
cctx.viewport = Geom::Rect::from_xywh(0, 0, use->width.computed, use->height.computed);
cctx.i2vp = Geom::identity();
flags&=~SP_OBJECT_USER_MODIFIED_FLAG_B;
if (use->child) {
g_object_ref(G_OBJECT(use->child));
if (flags || (use->child->uflags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG))) {
if (SP_IS_ITEM(use->child)) {
SPItem const &chi = *SP_ITEM(use->child);
cctx.i2doc = chi.transform * ictx->i2doc;
cctx.i2vp = chi.transform * ictx->i2vp;
use->child->updateDisplay((SPCtx *)&cctx, flags);
} else {
use->child->updateDisplay(ctx, flags);
}
}
g_object_unref(G_OBJECT(use->child));
}
/* As last step set additional transform of arena group */
for (SPItemView *v = item->display; v != NULL; v = v->next) {
Inkscape::DrawingGroup *g = dynamic_cast<Inkscape::DrawingGroup *>(v->arenaitem);
Geom::Affine t(Geom::Translate(use->x.computed, use->y.computed));
g->setChildTransform(t);
}
}
static void
sp_use_modified(SPObject *object, guint flags)
{
SPUse *use_obj = SP_USE(object);
if (flags & SP_OBJECT_MODIFIED_FLAG) {
flags |= SP_OBJECT_PARENT_MODIFIED_FLAG;
}
flags &= SP_OBJECT_MODIFIED_CASCADE;
if (flags & SP_OBJECT_STYLE_MODIFIED_FLAG) {
for (SPItemView *v = SP_ITEM(object)->display; v != NULL; v = v->next) {
Inkscape::DrawingGroup *g = dynamic_cast<Inkscape::DrawingGroup *>(v->arenaitem);
g->setStyle(object->style);
}
}
SPObject *child = use_obj->child;
if (child) {
g_object_ref(G_OBJECT(child));
if (flags || (child->mflags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG))) {
child->emitModified(flags);
}
g_object_unref(G_OBJECT(child));
}
}
SPItem *sp_use_unlink(SPUse *use)
{
if (!use) {
return NULL;
}
Inkscape::XML::Node *repr = use->getRepr();
if (!repr) {
return NULL;
}
Inkscape::XML::Node *parent = repr->parent();
SPDocument *document = use->document;
Inkscape::XML::Document *xml_doc = document->getReprDoc();
// Track the ultimate source of a chain of uses.
SPItem *orig = sp_use_root(use);
if (!orig) {
return NULL;
}
// Calculate the accumulated transform, starting from the original.
Geom::Affine t = sp_use_get_root_transform(use);
Inkscape::XML::Node *copy = NULL;
if (SP_IS_SYMBOL(orig)) { // make a group, copy children
copy = xml_doc->createElement("svg:g");
for (Inkscape::XML::Node *child = orig->getRepr()->firstChild() ; child != NULL; child = child->next()) {
Inkscape::XML::Node *newchild = child->duplicate(xml_doc);
copy->appendChild(newchild);
}
} else { // just copy
copy = orig->getRepr()->duplicate(xml_doc);
}
// Add the duplicate repr just after the existing one.
parent->addChild(copy, repr);
// Retrieve the SPItem of the resulting repr.
SPObject *unlinked = document->getObjectByRepr(copy);
// Merge style from the use.
SPStyle *unli_sty = unlinked->style;
SPStyle const *use_sty = use->style;
sp_style_merge_from_dying_parent(unli_sty, use_sty);
sp_style_merge_from_parent(unli_sty, unlinked->parent->style);
unlinked->updateRepr();
// Hold onto our SPObject and repr for now.
sp_object_ref(use, NULL);
Inkscape::GC::anchor(repr);
// Remove ourselves, not propagating delete events to avoid a
// chain-reaction with other elements that might reference us.
use->deleteObject(false);
// Give the copy our old id and let go of our old repr.
copy->setAttribute("id", repr->attribute("id"));
Inkscape::GC::release(repr);
// Remove tiled clone attrs.
copy->setAttribute("inkscape:tiled-clone-of", NULL);
copy->setAttribute("inkscape:tile-w", NULL);
copy->setAttribute("inkscape:tile-h", NULL);
copy->setAttribute("inkscape:tile-cx", NULL);
copy->setAttribute("inkscape:tile-cy", NULL);
// Establish the succession and let go of our object.
use->setSuccessor(unlinked);
sp_object_unref(use, NULL);
SPItem *item = SP_ITEM(unlinked);
// Set the accummulated transform.
{
Geom::Affine nomove(Geom::identity());
// Advertise ourselves as not moving.
item->doWriteTransform(item->getRepr(), t, &nomove);
}
return item;
}
SPItem *sp_use_get_original(SPUse *use)
{
SPItem *ref = NULL;
if (use){
if (use->ref){
ref = use->ref->getObject();
}
}
return ref;
}
static void
sp_use_snappoints(SPItem const *item, std::vector<Inkscape::SnapCandidatePoint> &p, Inkscape::SnapPreferences const *snapprefs)
{
g_assert (item != NULL);
g_assert (SP_IS_ITEM(item));
g_assert (SP_IS_USE(item));
SPUse *use = SP_USE(item);
SPItem *root = sp_use_root(use);
if (!root)
return;
SPItemClass const &item_class = *(SPItemClass const *) G_OBJECT_GET_CLASS(root);
if (item_class.snappoints) {
item_class.snappoints(root, p, snapprefs);
}
}
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
indent-tabs-mode:nil
fill-column:99
End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :