sp-filter.cpp revision 7c4b60329b0211e45e6bb3dc2a10dcec11fc18ff
#define __SP_FILTER_CPP__
/** \file
* SVG <filter> implementation.
*/
/*
* Authors:
* Hugo Rodrigues <haa.rodrigues@gmail.com>
* Niko Kiirala <niko@kiirala.com>
*
* Copyright (C) 2006,2007 Authors
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <map>
#include <string.h>
using std::map;
using std::pair;
#include <gtkmm.h>
#include "attributes.h"
#include "document.h"
#include "sp-filter.h"
#include "sp-filter-reference.h"
#include "uri.h"
#include "xml/repr.h"
#include <cstring>
#include <string>
#define SP_MACROS_SILENT
#include "macros.h"
#include "display/nr-filter.h"
/* Filter base class */
static void sp_filter_class_init(SPFilterClass *klass);
static void sp_filter_init(SPFilter *filter);
static void sp_filter_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
static void sp_filter_release(SPObject *object);
static void sp_filter_set(SPObject *object, unsigned int key, gchar const *value);
static void sp_filter_update(SPObject *object, SPCtx *ctx, guint flags);
static void sp_filter_child_added(SPObject *object,
Inkscape::XML::Node *child,
Inkscape::XML::Node *ref);
static void sp_filter_remove_child(SPObject *object, Inkscape::XML::Node *child);
static Inkscape::XML::Node *sp_filter_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
static void filter_ref_changed(SPObject *old_ref, SPObject *ref, SPFilter *filter);
static void filter_ref_modified(SPObject *href, guint flags, SPFilter *filter);
static SPObjectClass *filter_parent_class;
GType
sp_filter_get_type()
{
static GType filter_type = 0;
if (!filter_type) {
GTypeInfo filter_info = {
sizeof(SPFilterClass),
NULL, NULL,
(GClassInitFunc) sp_filter_class_init,
NULL, NULL,
sizeof(SPFilter),
16,
(GInstanceInitFunc) sp_filter_init,
NULL, /* value_table */
};
filter_type = g_type_register_static(SP_TYPE_OBJECT, "SPFilter", &filter_info, (GTypeFlags)0);
}
return filter_type;
}
static void
sp_filter_class_init(SPFilterClass *klass)
{
SPObjectClass *sp_object_class = (SPObjectClass *)klass;
filter_parent_class = (SPObjectClass*)g_type_class_peek_parent(klass);
sp_object_class->build = sp_filter_build;
sp_object_class->release = sp_filter_release;
sp_object_class->write = sp_filter_write;
sp_object_class->set = sp_filter_set;
sp_object_class->update = sp_filter_update;
sp_object_class->child_added = sp_filter_child_added;
sp_object_class->remove_child = sp_filter_remove_child;
}
static void
sp_filter_init(SPFilter *filter)
{
filter->href = new SPFilterReference(SP_OBJECT(filter));
filter->href->changedSignal().connect(sigc::bind(sigc::ptr_fun(filter_ref_changed), filter));
filter->x = 0;
filter->y = 0;
filter->width = 0;
filter->height = 0;
filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
filter->filterUnits_set = FALSE;
filter->primitiveUnits_set = FALSE;
filter->_renderer = NULL;
filter->_image_name = new std::map<gchar *, int, ltstr>;
filter->_image_name->clear();
filter->_image_number_next = 0;
filter->filterRes = NumberOptNumber();
new (&filter->modified_connection) sigc::connection();
}
/**
* Reads the Inkscape::XML::Node, and initializes SPFilter variables. For this to get called,
* our name must be associated with a repr via "sp_object_type_register". Best done through
* sp-object-repr.cpp's repr_name_entries array.
*/
static void
sp_filter_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
{
if (((SPObjectClass *) filter_parent_class)->build) {
((SPObjectClass *) filter_parent_class)->build(object, document, repr);
}
//Read values of key attributes from XML nodes into object.
sp_object_read_attr(object, "filterUnits");
sp_object_read_attr(object, "primitiveUnits");
sp_object_read_attr(object, "x");
sp_object_read_attr(object, "y");
sp_object_read_attr(object, "width");
sp_object_read_attr(object, "height");
sp_object_read_attr(object, "filterRes");
sp_object_read_attr(object, "xlink:href");
//is this necessary?
sp_document_add_resource(document, "filter", object);
}
/**
* Drops any allocated memory.
*/
static void
sp_filter_release(SPObject *object)
{
SPFilter *filter = SP_FILTER(object);
if (SP_OBJECT_DOCUMENT(object)) {
/* Unregister ourselves */
sp_document_remove_resource(SP_OBJECT_DOCUMENT(object), "filter", SP_OBJECT(object));
}
//TODO: release resources here
//release href
if (filter->href) {
filter->modified_connection.disconnect();
filter->href->detach();
delete filter->href;
filter->href = NULL;
}
filter->modified_connection.~connection();
delete filter->_image_name;
if (((SPObjectClass *) filter_parent_class)->release)
((SPObjectClass *) filter_parent_class)->release(object);
}
/**
* Sets a specific value in the SPFilter.
*/
static void
sp_filter_set(SPObject *object, unsigned int key, gchar const *value)
{
SPFilter *filter = SP_FILTER(object);
switch (key) {
case SP_ATTR_FILTERUNITS:
if (value) {
if (!strcmp(value, "userSpaceOnUse")) {
filter->filterUnits = SP_FILTER_UNITS_USERSPACEONUSE;
} else {
filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
}
filter->filterUnits_set = TRUE;
} else {
filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
filter->filterUnits_set = FALSE;
}
object->requestModified(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_PRIMITIVEUNITS:
if (value) {
if (!strcmp(value, "userSpaceOnUse")) {
filter->primitiveUnits = SP_FILTER_UNITS_USERSPACEONUSE;
} else {
filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
}
filter->primitiveUnits_set = TRUE;
} else {
filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
filter->primitiveUnits_set = FALSE;
}
object->requestModified(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_X:
filter->x.readOrUnset(value);
object->requestModified(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_Y:
filter->y.readOrUnset(value);
object->requestModified(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_WIDTH:
filter->width.readOrUnset(value);
object->requestModified(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_HEIGHT:
filter->height.readOrUnset(value);
object->requestModified(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_FILTERRES:
filter->filterRes.set(value);
object->requestModified(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_XLINK_HREF:
if (value) {
try {
filter->href->attach(Inkscape::URI(value));
} catch (Inkscape::BadURIException &e) {
g_warning("%s", e.what());
filter->href->detach();
}
} else {
filter->href->detach();
}
break;
default:
// See if any parents need this value.
if (((SPObjectClass *) filter_parent_class)->set) {
((SPObjectClass *) filter_parent_class)->set(object, key, value);
}
break;
}
}
/**
* Receives update notifications.
*/
static void
sp_filter_update(SPObject *object, SPCtx *ctx, guint flags)
{
//SPFilter *filter = SP_FILTER(object);
if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
/* do something to trigger redisplay, updates? */
}
if (((SPObjectClass *) filter_parent_class)->update) {
((SPObjectClass *) filter_parent_class)->update(object, ctx, flags);
}
}
/**
* Writes its settings to an incoming repr object, if any.
*/
static Inkscape::XML::Node *
sp_filter_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags)
{
SPFilter *filter = SP_FILTER(object);
if (!repr) {
repr = SP_OBJECT_REPR(object)->duplicate(doc);
}
if ((flags & SP_OBJECT_WRITE_ALL) || filter->filterUnits_set) {
switch (filter->filterUnits) {
case SP_FILTER_UNITS_USERSPACEONUSE:
repr->setAttribute("filterUnits", "userSpaceOnUse");
break;
default:
repr->setAttribute("filterUnits", "objectBoundingBox");
break;
}
}
if ((flags & SP_OBJECT_WRITE_ALL) || filter->primitiveUnits_set) {
switch (filter->primitiveUnits) {
case SP_FILTER_UNITS_USERSPACEONUSE:
repr->setAttribute("primitiveUnits", "userSpaceOnUse");
break;
default:
repr->setAttribute("primitiveUnits", "objectBoundingBox");
break;
}
}
if (filter->x._set) {
sp_repr_set_svg_double(repr, "x", filter->x.computed);
} else {
repr->setAttribute("x", NULL);
}
if (filter->y._set) {
sp_repr_set_svg_double(repr, "y", filter->y.computed);
} else {
repr->setAttribute("y", NULL);
}
if (filter->width._set) {
sp_repr_set_svg_double(repr, "width", filter->width.computed);
} else {
repr->setAttribute("width", NULL);
}
if (filter->height._set) {
sp_repr_set_svg_double(repr, "height", filter->height.computed);
} else {
repr->setAttribute("height", NULL);
}
if (filter->filterRes.getNumber()>=0) {
gchar *tmp = filter->filterRes.getValueString();
repr->setAttribute("filterRes", tmp);
g_free(tmp);
} else {
repr->setAttribute("filterRes", NULL);
}
if (filter->href->getURI()) {
gchar *uri_string = filter->href->getURI()->toString();
repr->setAttribute("xlink:href", uri_string);
g_free(uri_string);
}
// TODO: This is evil, correctly implement support for color-interpolation-filters!!!
// The color-interpolation-filters attribute is initially set to linearRGB according to the SVG standard.
// However, Inkscape completely ignores it and implicitly assumes that it is sRGB (like color-interpolation-filters).
// This results in a discrepancy between Inkscape and other renderers in how they render filters.
// To mitigate this problem I've (Jasper van de Gronde,th.v.d.gronde@hccnet.nl) added this to ensure that at least
// any filters written by Inkscape will henceforth be rendered the same in other renderers.
// In the future Inkscape should have proper support for the color-interpolation properties and this should be changed.
repr->setAttribute("color-interpolation-filters", "sRGB");
if (((SPObjectClass *) filter_parent_class)->write) {
((SPObjectClass *) filter_parent_class)->write(object, doc, repr, flags);
}
return repr;
}
/**
* Gets called when the filter is (re)attached to another filter.
*/
static void
filter_ref_changed(SPObject *old_ref, SPObject *ref, SPFilter *filter)
{
if (old_ref) {
filter->modified_connection.disconnect();
}
if ( SP_IS_FILTER(ref)
&& ref != filter )
{
filter->modified_connection =
ref->connectModified(sigc::bind(sigc::ptr_fun(&filter_ref_modified), filter));
}
filter_ref_modified(ref, 0, filter);
}
static void
filter_ref_modified(SPObject */*href*/, guint /*flags*/, SPFilter *filter)
{
SP_OBJECT(filter)->requestModified(SP_OBJECT_MODIFIED_FLAG);
}
/**
* Callback for child_added event.
*/
static void
sp_filter_child_added(SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref)
{
//SPFilter *f = SP_FILTER(object);
if (((SPObjectClass *) filter_parent_class)->child_added)
(* ((SPObjectClass *) filter_parent_class)->child_added)(object, child, ref);
object->requestModified(SP_OBJECT_MODIFIED_FLAG);
}
/**
* Callback for remove_child event.
*/
static void
sp_filter_remove_child(SPObject *object, Inkscape::XML::Node *child)
{
// SPFilter *f = SP_FILTER(object);
if (((SPObjectClass *) filter_parent_class)->remove_child)
(* ((SPObjectClass *) filter_parent_class)->remove_child)(object, child);
object->requestModified(SP_OBJECT_MODIFIED_FLAG);
}
void sp_filter_build_renderer(SPFilter *sp_filter, Inkscape::Filters::Filter *nr_filter)
{
g_assert(sp_filter != NULL);
g_assert(nr_filter != NULL);
sp_filter->_renderer = nr_filter;
nr_filter->set_x(sp_filter->x);
nr_filter->set_y(sp_filter->y);
nr_filter->set_width(sp_filter->width);
nr_filter->set_height(sp_filter->height);
if (sp_filter->filterRes.getNumber() >= 0) {
if (sp_filter->filterRes.getOptNumber() >= 0) {
nr_filter->set_resolution(sp_filter->filterRes.getNumber(),
sp_filter->filterRes.getOptNumber());
} else {
nr_filter->set_resolution(sp_filter->filterRes.getNumber());
}
}
nr_filter->clear_primitives();
SPObject *primitive_obj = sp_filter->children;
while (primitive_obj) {
if (SP_IS_FILTER_PRIMITIVE(primitive_obj)) {
SPFilterPrimitive *primitive = SP_FILTER_PRIMITIVE(primitive_obj);
g_assert(primitive != NULL);
if (((SPFilterPrimitiveClass*) G_OBJECT_GET_CLASS(primitive))->build_renderer) {
((SPFilterPrimitiveClass *) G_OBJECT_GET_CLASS(primitive))->build_renderer(primitive, nr_filter);
} else {
g_warning("Cannot build filter renderer: missing builder");
}
}
primitive_obj = primitive_obj->next;
}
}
int sp_filter_primitive_count(SPFilter *filter) {
g_assert(filter != NULL);
int count = 0;
SPObject *primitive_obj = filter->children;
while (primitive_obj) {
if (SP_IS_FILTER_PRIMITIVE(primitive_obj)) count++;
primitive_obj = primitive_obj->next;
}
return count;
}
int sp_filter_get_image_name(SPFilter *filter, gchar const *name) {
gchar *name_copy = strdup(name);
map<gchar *, int, ltstr>::iterator result = filter->_image_name->find(name_copy);
free(name_copy);
if (result == filter->_image_name->end()) return -1;
else return (*result).second;
}
int sp_filter_set_image_name(SPFilter *filter, gchar const *name) {
int value = filter->_image_number_next;
filter->_image_number_next++;
gchar *name_copy = strdup(name);
pair<gchar*,int> new_pair(name_copy, value);
pair<map<gchar*,int,ltstr>::iterator,bool> ret = filter->_image_name->insert(new_pair);
if (ret.second == false) {
return (*ret.first).second;
}
return value;
}
Glib::ustring sp_filter_get_new_result_name(SPFilter *filter) {
g_assert(filter != NULL);
int largest = 0;
SPObject *primitive_obj = filter->children;
while (primitive_obj) {
if (SP_IS_FILTER_PRIMITIVE(primitive_obj)) {
Inkscape::XML::Node *repr = SP_OBJECT_REPR(primitive_obj);
char const *result = repr->attribute("result");
int index;
if (result && sscanf(result, "result%d", &index) == 1) {
if (index > largest) {
largest = index;
}
}
}
primitive_obj = primitive_obj->next;
}
return "result" + Glib::Ascii::dtostr(largest + 1);
}
bool ltstr::operator()(const char* s1, const char* s2) const
{
return strcmp(s1, s2) < 0;
}
/*
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:encoding=utf-8:textwidth=99 :