src/sp-filter.cpp

   1 #define __SP_FILTER_CPP__
   2
   3 /** \file
   4  * SVG <filter> implementation.
   5  */
   6 /*
   7  * Authors:
   8  *   Hugo Rodrigues <haa.rodrigues@gmail.com>
   9  *   Niko Kiirala <niko@kiirala.com>
  10  *
  11  * Copyright (C) 2006,2007 Authors
  12  *
  13  * Released under GNU GPL, read the file 'COPYING' for more information
  14  */
  15
  16 #ifdef HAVE_CONFIG_H
  17 # include "config.h"
  18 #endif
  19
  20 #include <map>
  21 #include <string.h>
  22 using std::map;
  23 using std::pair;
  24
  25 #include "attributes.h"
  26 #include "document.h"
  27 #include "sp-filter.h"
  28 #include "sp-filter-reference.h"
  29 #include "uri.h"
  30 #include "xml/repr.h"
  31
  32 #define SP_MACROS_SILENT
  33 #include "macros.h"
  34
  35 #include "display/nr-filter.cpp"
  36
  37 /* Filter base class */
  38
  39 static void sp_filter_class_init(SPFilterClass *klass);
  40 static void sp_filter_init(SPFilter *filter);
  41
  42 static void sp_filter_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
  43 static void sp_filter_release(SPObject *object);
  44 static void sp_filter_set(SPObject *object, unsigned int key, gchar const *value);
  45 static void sp_filter_update(SPObject *object, SPCtx *ctx, guint flags);
  46 static void sp_filter_child_added(SPObject *object,
  47                                     Inkscape::XML::Node *child,
  48                                     Inkscape::XML::Node *ref);
  49 static void sp_filter_remove_child(SPObject *object, Inkscape::XML::Node *child);
  50 static Inkscape::XML::Node *sp_filter_write(SPObject *object, Inkscape::XML::Node *repr, guint flags);
  51
  52 static void filter_ref_changed(SPObject *old_ref, SPObject *ref, SPFilter *filter);
  53 static void filter_ref_modified(SPObject *href, guint flags, SPFilter *filter);
  54
  55 static SPObjectClass *filter_parent_class;
  56
  57 GType
  58 sp_filter_get_type()
  59 {
  60     static GType filter_type = 0;
  61
  62     if (!filter_type) {
  63         GTypeInfo filter_info = {
  64             sizeof(SPFilterClass),
  65             NULL, NULL,
  66             (GClassInitFunc) sp_filter_class_init,
  67             NULL, NULL,
  68             sizeof(SPFilter),
  69             16,
  70             (GInstanceInitFunc) sp_filter_init,
  71             NULL,    /* value_table */
  72         };
  73         filter_type = g_type_register_static(SP_TYPE_OBJECT, "SPFilter", &filter_info, (GTypeFlags)0);
  74     }
  75     return filter_type;
  76 }
  77
  78 static void
  79 sp_filter_class_init(SPFilterClass *klass)
  80 {
  81
  82     SPObjectClass *sp_object_class = (SPObjectClass *)klass;
  83
  84     filter_parent_class = (SPObjectClass*)g_type_class_peek_parent(klass);
  85
  86     sp_object_class->build = sp_filter_build;
  87     sp_object_class->release = sp_filter_release;
  88     sp_object_class->write = sp_filter_write;
  89     sp_object_class->set = sp_filter_set;
  90     sp_object_class->update = sp_filter_update;
  91     sp_object_class->child_added = sp_filter_child_added;
  92     sp_object_class->remove_child = sp_filter_remove_child;
  93 }
  94
  95 static void
  96 sp_filter_init(SPFilter *filter)
  97 {
  98     filter->href = new SPFilterReference(SP_OBJECT(filter));
  99     filter->href->changedSignal().connect(sigc::bind(sigc::ptr_fun(filter_ref_changed), filter));
 100
 101     filter->x = 0;
 102     filter->y = 0;
 103     filter->width = 0;
 104     filter->height = 0;
 105
 106     filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 107     filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 108     filter->filterUnits_set = FALSE;
 109     filter->primitiveUnits_set = FALSE;
 110
 111     filter->_renderer = NULL;
 112
 113     filter->_image_name = map<gchar *, int, ltstr>();
 114
 115     new (&filter->modified_connection) sigc::connection();
 116 }
 117
 118 /**
 119  * Reads the Inkscape::XML::Node, and initializes SPFilter variables.  For this to get called,
 120  * our name must be associated with a repr via "sp_object_type_register".  Best done through
 121  * sp-object-repr.cpp's repr_name_entries array.
 122  */
 123 static void
 124 sp_filter_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
 125 {
 126     if (((SPObjectClass *) filter_parent_class)->build) {
 127         ((SPObjectClass *) filter_parent_class)->build(object, document, repr);
 128     }
 129
 130     //Read values of key attributes from XML nodes into object.
 131     sp_object_read_attr(object, "filterUnits");
 132     sp_object_read_attr(object, "primitiveUnits");
 133     sp_object_read_attr(object, "x");
 134     sp_object_read_attr(object, "y");
 135     sp_object_read_attr(object, "width");
 136     sp_object_read_attr(object, "height");
 137     sp_object_read_attr(object, "filterRes");
 138     sp_object_read_attr(object, "xlink:href");
 139
 140 //is this necessary?
 141     sp_document_add_resource(document, "filter", object);
 142 }
 143
 144 /**
 145  * Drops any allocated memory.
 146  */
 147 static void
 148 sp_filter_release(SPObject *object)
 149 {
 150     SPFilter *filter = SP_FILTER(object);
 151
 152     if (SP_OBJECT_DOCUMENT(object)) {
 153         /* Unregister ourselves */
 154         sp_document_remove_resource(SP_OBJECT_DOCUMENT(object), "filter", SP_OBJECT(object));
 155     }
 156
 157 //TODO: release resources here
 158
 159     //release href
 160     if (filter->href) {
 161         filter->modified_connection.disconnect();
 162         filter->href->detach();
 163         delete filter->href;
 164         filter->href = NULL;
 165     }
 166
 167     filter->modified_connection.~connection();
 168
 169     if (((SPObjectClass *) filter_parent_class)->release)
 170         ((SPObjectClass *) filter_parent_class)->release(object);
 171 }
 172
 173 /**
 174  * Sets a specific value in the SPFilter.
 175  */
 176 static void
 177 sp_filter_set(SPObject *object, unsigned int key, gchar const *value)
 178 {
 179     SPFilter *filter = SP_FILTER(object);
 180
 181     switch (key) {
 182         case SP_ATTR_FILTERUNITS:
 183             if (value) {
 184                 if (!strcmp(value, "userSpaceOnUse")) {
 185                     filter->filterUnits = SP_FILTER_UNITS_USERSPACEONUSE;
 186                 } else {
 187                     filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 188                 }
 189                 filter->filterUnits_set = TRUE;
 190             } else {
 191                 filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 192                 filter->filterUnits_set = FALSE;
 193             }
 194             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 195             break;
 196         case SP_ATTR_PRIMITIVEUNITS:
 197             if (value) {
 198                 if (!strcmp(value, "userSpaceOnUse")) {
 199                     filter->primitiveUnits = SP_FILTER_UNITS_USERSPACEONUSE;
 200                 } else {
 201                     filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 202                 }
 203                 filter->primitiveUnits_set = TRUE;
 204             } else {
 205                 filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 206                 filter->primitiveUnits_set = FALSE;
 207             }
 208             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 209             break;
 210     case SP_ATTR_X:
 211             filter->x.readOrUnset(value);
 212         object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 213             break;
 214     case SP_ATTR_Y:
 215         filter->y.readOrUnset(value);
 216         object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 217             break;
 218     case SP_ATTR_WIDTH:
 219         filter->width.readOrUnset(value);
 220         object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 221             break;
 222     case SP_ATTR_HEIGHT:
 223         filter->height.readOrUnset(value);
 224         object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 225             break;
 226     case SP_ATTR_FILTERRES:
 227         filter->filterRes.set(value);
 228             break;
 229         case SP_ATTR_XLINK_HREF:
 230             if (value) {
 231                 try {
 232                     filter->href->attach(Inkscape::URI(value));
 233                 } catch (Inkscape::BadURIException &e) {
 234                     g_warning("%s", e.what());
 235                     filter->href->detach();
 236                 }
 237             } else {
 238                 filter->href->detach();
 239             }
 240             break;
 241         default:
 242             // See if any parents need this value.
 243             if (((SPObjectClass *) filter_parent_class)->set) {
 244                 ((SPObjectClass *) filter_parent_class)->set(object, key, value);
 245             }
 246             break;
 247     }
 248 }
 249
 250 /**
 251  * Receives update notifications.
 252  */
 253 static void
 254 sp_filter_update(SPObject *object, SPCtx *ctx, guint flags)
 255 {
 256     //SPFilter *filter = SP_FILTER(object);
 257
 258     if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
 259                  SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 260
 261         /* do something to trigger redisplay, updates? */
 262
 263     }
 264
 265     if (((SPObjectClass *) filter_parent_class)->update) {
 266         ((SPObjectClass *) filter_parent_class)->update(object, ctx, flags);
 267     }
 268 }
 269
 270 /**
 271  * Writes its settings to an incoming repr object, if any.
 272  */
 273 static Inkscape::XML::Node *
 274 sp_filter_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
 275 {
 276     SPFilter *filter = SP_FILTER(object);
 277
 278     if (!repr) {
 279         repr = SP_OBJECT_REPR(object)->duplicate(NULL); // FIXME
 280     }
 281
 282     if ((flags & SP_OBJECT_WRITE_ALL) || filter->filterUnits_set) {
 283         switch (filter->filterUnits) {
 284             case SP_FILTER_UNITS_USERSPACEONUSE:
 285                 repr->setAttribute("filterUnits", "userSpaceOnUse");
 286                 break;
 287             default:
 288                 repr->setAttribute("filterUnits", "objectBoundingBox");
 289                 break;
 290         }
 291     }
 292
 293     if ((flags & SP_OBJECT_WRITE_ALL) || filter->primitiveUnits_set) {
 294         switch (filter->primitiveUnits) {
 295             case SP_FILTER_UNITS_USERSPACEONUSE:
 296                 repr->setAttribute("primitiveUnits", "userSpaceOnUse");
 297                 break;
 298             default:
 299                 repr->setAttribute("primitiveUnits", "objectBoundingBox");
 300                 break;
 301         }
 302     }
 303
 304     if (filter->x._set) {
 305         sp_repr_set_svg_double(repr, "x", filter->x.computed);
 306     } else {
 307         repr->setAttribute("x", NULL);
 308     }
 309
 310     if (filter->y._set) {
 311         sp_repr_set_svg_double(repr, "y", filter->y.computed);
 312     } else {
 313         repr->setAttribute("y", NULL);
 314     }
 315
 316     if (filter->width._set) {
 317         sp_repr_set_svg_double(repr, "width", filter->width.computed);
 318     } else {
 319         repr->setAttribute("width", NULL);
 320     }
 321
 322     if (filter->height._set) {
 323         sp_repr_set_svg_double(repr, "height", filter->height.computed);
 324     } else {
 325         repr->setAttribute("height", NULL);
 326     }
 327
 328     if (filter->filterRes.getNumber()>=0) {
 329         gchar *tmp = filter->filterRes.getValueString();
 330         repr->setAttribute("filterRes", tmp);
 331         g_free(tmp);
 332     } else {
 333         repr->setAttribute("filterRes", NULL);
 334     }
 335
 336     if (filter->href->getURI()) {
 337         gchar *uri_string = filter->href->getURI()->toString();
 338         repr->setAttribute("xlink:href", uri_string);
 339         g_free(uri_string);
 340     }
 341
 342     if (((SPObjectClass *) filter_parent_class)->write) {
 343         ((SPObjectClass *) filter_parent_class)->write(object, repr, flags);
 344     }
 345
 346     return repr;
 347 }
 348
 349
 350 /**
 351  * Gets called when the filter is (re)attached to another filter.
 352  */
 353 static void
 354 filter_ref_changed(SPObject *old_ref, SPObject *ref, SPFilter *filter)
 355 {
 356     if (old_ref) {
 357         filter->modified_connection.disconnect();
 358     }
 359     if ( SP_IS_FILTER(ref)
 360          && ref != filter )
 361     {
 362         filter->modified_connection =
 363             ref->connectModified(sigc::bind(sigc::ptr_fun(&filter_ref_modified), filter));
 364     }
 365
 366     filter_ref_modified(ref, 0, filter);
 367 }
 368
 369 static void
 370 filter_ref_modified(SPObject *href, guint flags, SPFilter *filter)
 371 {
 372     SP_OBJECT(filter)->requestModified(SP_OBJECT_MODIFIED_FLAG);
 373 }
 374
 375 /**
 376  * Callback for child_added event.
 377  */
 378 static void
 379 sp_filter_child_added(SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref)
 380 {
 381     //SPFilter *f = SP_FILTER(object);
 382
 383     if (((SPObjectClass *) filter_parent_class)->child_added)
 384         (* ((SPObjectClass *) filter_parent_class)->child_added)(object, child, ref);
 385
 386     object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 387 }
 388
 389 /**
 390  * Callback for remove_child event.
 391  */
 392 static void
 393 sp_filter_remove_child(SPObject *object, Inkscape::XML::Node *child)
 394 {
 395 //    SPFilter *f = SP_FILTER(object);
 396
 397     if (((SPObjectClass *) filter_parent_class)->remove_child)
 398         (* ((SPObjectClass *) filter_parent_class)->remove_child)(object, child);
 399
 400     object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 401 }
 402
 403 void sp_filter_build_renderer(SPFilter *sp_filter, NR::Filter *nr_filter)
 404 {
 405     g_assert(sp_filter != NULL);
 406     g_assert(nr_filter != NULL);
 407
 408     sp_filter->_renderer = nr_filter;
 409
 410     nr_filter->set_x(sp_filter->x);
 411     nr_filter->set_y(sp_filter->y);
 412     nr_filter->set_width(sp_filter->width);
 413     nr_filter->set_height(sp_filter->height);
 414
 415     nr_filter->clear_primitives();
 416     SPObject *primitive_obj = sp_filter->children;
 417     while (primitive_obj) {
 418         if (SP_IS_FILTER_PRIMITIVE(primitive_obj)) {
 419             SPFilterPrimitive *primitive = SP_FILTER_PRIMITIVE(primitive_obj);
 420             g_assert(primitive != NULL);
 421             if (((SPFilterPrimitiveClass*) G_OBJECT_GET_CLASS(primitive))->build_renderer) {
 422                 ((SPFilterPrimitiveClass *) G_OBJECT_GET_CLASS(primitive))->build_renderer(primitive, nr_filter);
 423             } else {
 424                 g_warning("Cannot build filter renderer: missing builder");
 425             }
 426         }
 427         primitive_obj = primitive_obj->next;
 428     }
 429 }
 430
 431 int sp_filter_primitive_count(SPFilter *filter) {
 432     g_assert(filter != NULL);
 433     int count = 0;
 434
 435     SPObject *primitive_obj = filter->children;
 436     while (primitive_obj) {
 437         if (SP_IS_FILTER_PRIMITIVE(primitive_obj)) count++;
 438         primitive_obj = primitive_obj->next;
 439     }
 440     return count;
 441 }
 442
 443 int sp_filter_get_image_name(SPFilter *filter, gchar const *name) {
 444     gchar *name_copy = strdup(name);
 445     map<gchar *, int, ltstr>::iterator result = filter->_image_name.find(name_copy);
 446     free(name_copy);
 447     if (result == filter->_image_name.end()) return -1;
 448     else return (*result).second;
 449 }
 450
 451 int sp_filter_set_image_name(SPFilter *filter, gchar const *name) {
 452     int value = filter->_image_number_next;
 453     filter->_image_number_next++;
 454     gchar *name_copy = strdup(name);
 455     pair<map<gchar*,int,ltstr>::iterator,bool> ret = filter->_image_name.insert(pair<gchar*,int>(name_copy, value));
 456     if (ret.second == false) {
 457         return (*ret.first).second;
 458     }
 459     return value;
 460 }
 461
 462 bool ltstr::operator()(const char* s1, const char* s2) const
 463 {
 464     return strcmp(s1, s2) < 0;
 465 }
 466
 467
 468 /*
 469   Local Variables:
 470   mode:c++
 471   c-file-style:"stroustrup"
 472   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 473   indent-tabs-mode:nil
 474   fill-column:99
 475   End:
 476 */
 477 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :