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
 116 /**
 117  * Reads the Inkscape::XML::Node, and initializes SPFilter variables.  For this to get called,
 118  * our name must be associated with a repr via "sp_object_type_register".  Best done through
 119  * sp-object-repr.cpp's repr_name_entries array.
 120  */
 121 static void
 122 sp_filter_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
 123 {
 124     if (((SPObjectClass *) filter_parent_class)->build) {
 125         ((SPObjectClass *) filter_parent_class)->build(object, document, repr);
 126     }
 127
 128     //Read values of key attributes from XML nodes into object.
 129     sp_object_read_attr(object, "filterUnits");
 130     sp_object_read_attr(object, "primitiveUnits");
 131     sp_object_read_attr(object, "x");
 132     sp_object_read_attr(object, "y");
 133     sp_object_read_attr(object, "width");
 134     sp_object_read_attr(object, "height");
 135     sp_object_read_attr(object, "filterRes");
 136     sp_object_read_attr(object, "xlink:href");
 137
 138 //is this necessary?
 139     sp_document_add_resource(document, "filter", object);
 140 }
 141
 142 /**
 143  * Drops any allocated memory.
 144  */
 145 static void
 146 sp_filter_release(SPObject *object)
 147 {
 148     SPFilter *filter = SP_FILTER(object);
 149
 150     if (SP_OBJECT_DOCUMENT(object)) {
 151         /* Unregister ourselves */
 152         sp_document_remove_resource(SP_OBJECT_DOCUMENT(object), "filter", SP_OBJECT(object));
 153     }
 154
 155 //TODO: release resources here
 156
 157     //release href
 158     if (filter->href) {
 159         if (filter->href->getObject()) {
 160             sp_signal_disconnect_by_data(filter->href->getObject(), filter);
 161         }
 162         filter->href->detach();
 163         delete filter->href;
 164         filter->href = NULL;
 165     }
 166
 167     if (((SPObjectClass *) filter_parent_class)->release)
 168         ((SPObjectClass *) filter_parent_class)->release(object);
 169 }
 170
 171 /**
 172  * Sets a specific value in the SPFilter.
 173  */
 174 static void
 175 sp_filter_set(SPObject *object, unsigned int key, gchar const *value)
 176 {
 177     SPFilter *filter = SP_FILTER(object);
 178
 179     switch (key) {
 180         case SP_ATTR_FILTERUNITS:
 181             if (value) {
 182                 if (!strcmp(value, "userSpaceOnUse")) {
 183                     filter->filterUnits = SP_FILTER_UNITS_USERSPACEONUSE;
 184                 } else {
 185                     filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 186                 }
 187                 filter->filterUnits_set = TRUE;
 188             } else {
 189                 filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 190                 filter->filterUnits_set = FALSE;
 191             }
 192             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 193             break;
 194         case SP_ATTR_PRIMITIVEUNITS:
 195             if (value) {
 196                 if (!strcmp(value, "userSpaceOnUse")) {
 197                     filter->primitiveUnits = SP_FILTER_UNITS_USERSPACEONUSE;
 198                 } else {
 199                     filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 200                 }
 201                 filter->primitiveUnits_set = TRUE;
 202             } else {
 203                 filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 204                 filter->primitiveUnits_set = FALSE;
 205             }
 206             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 207             break;
 208     case SP_ATTR_X:
 209             filter->x.readOrUnset(value);
 210         object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 211             break;
 212     case SP_ATTR_Y:
 213         filter->y.readOrUnset(value);
 214         object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 215             break;
 216     case SP_ATTR_WIDTH:
 217         filter->width.readOrUnset(value);
 218         object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 219             break;
 220     case SP_ATTR_HEIGHT:
 221         filter->height.readOrUnset(value);
 222         object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 223             break;
 224     case SP_ATTR_FILTERRES:
 225         filter->filterRes.set(value);
 226             break;
 227         case SP_ATTR_XLINK_HREF:
 228             if (value) {
 229                 try {
 230                     filter->href->attach(Inkscape::URI(value));
 231                 } catch (Inkscape::BadURIException &e) {
 232                     g_warning("%s", e.what());
 233                     filter->href->detach();
 234                 }
 235             } else {
 236                 filter->href->detach();
 237             }
 238             break;
 239         default:
 240             // See if any parents need this value.
 241             if (((SPObjectClass *) filter_parent_class)->set) {
 242                 ((SPObjectClass *) filter_parent_class)->set(object, key, value);
 243             }
 244             break;
 245     }
 246 }
 247
 248 /**
 249  * Receives update notifications.
 250  */
 251 static void
 252 sp_filter_update(SPObject *object, SPCtx *ctx, guint flags)
 253 {
 254     //SPFilter *filter = SP_FILTER(object);
 255
 256     if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
 257                  SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 258
 259         /* do something to trigger redisplay, updates? */
 260
 261     }
 262
 263     if (((SPObjectClass *) filter_parent_class)->update) {
 264         ((SPObjectClass *) filter_parent_class)->update(object, ctx, flags);
 265     }
 266 }
 267
 268 /**
 269  * Writes its settings to an incoming repr object, if any.
 270  */
 271 static Inkscape::XML::Node *
 272 sp_filter_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
 273 {
 274     SPFilter *filter = SP_FILTER(object);
 275
 276     if (!repr) {
 277         repr = SP_OBJECT_REPR(object)->duplicate(NULL); // FIXME
 278     }
 279
 280     if ((flags & SP_OBJECT_WRITE_ALL) || filter->filterUnits_set) {
 281         switch (filter->filterUnits) {
 282             case SP_FILTER_UNITS_USERSPACEONUSE:
 283                 repr->setAttribute("filterUnits", "userSpaceOnUse");
 284                 break;
 285             default:
 286                 repr->setAttribute("filterUnits", "objectBoundingBox");
 287                 break;
 288         }
 289     }
 290
 291     if ((flags & SP_OBJECT_WRITE_ALL) || filter->primitiveUnits_set) {
 292         switch (filter->primitiveUnits) {
 293             case SP_FILTER_UNITS_USERSPACEONUSE:
 294                 repr->setAttribute("primitiveUnits", "userSpaceOnUse");
 295                 break;
 296             default:
 297                 repr->setAttribute("primitiveUnits", "objectBoundingBox");
 298                 break;
 299         }
 300     }
 301
 302     if (filter->x._set) {
 303         sp_repr_set_svg_double(repr, "x", filter->x.computed);
 304     } else {
 305         repr->setAttribute("x", NULL);
 306     }
 307
 308     if (filter->y._set) {
 309         sp_repr_set_svg_double(repr, "y", filter->y.computed);
 310     } else {
 311         repr->setAttribute("y", NULL);
 312     }
 313
 314     if (filter->width._set) {
 315         sp_repr_set_svg_double(repr, "width", filter->width.computed);
 316     } else {
 317         repr->setAttribute("width", NULL);
 318     }
 319
 320     if (filter->height._set) {
 321         sp_repr_set_svg_double(repr, "height", filter->height.computed);
 322     } else {
 323         repr->setAttribute("height", NULL);
 324     }
 325
 326     if (filter->filterRes.getNumber()>=0) {
 327         gchar *tmp = filter->filterRes.getValueString();
 328         repr->setAttribute("filterRes", tmp);
 329         g_free(tmp);
 330     } else {
 331         repr->setAttribute("filterRes", NULL);
 332     }
 333
 334     if (filter->href->getURI()) {
 335         gchar *uri_string = filter->href->getURI()->toString();
 336         repr->setAttribute("xlink:href", uri_string);
 337         g_free(uri_string);
 338     }
 339
 340     if (((SPObjectClass *) filter_parent_class)->write) {
 341         ((SPObjectClass *) filter_parent_class)->write(object, repr, flags);
 342     }
 343
 344     return repr;
 345 }
 346
 347
 348 /**
 349  * Gets called when the filter is (re)attached to another filter.
 350  */
 351 static void
 352 filter_ref_changed(SPObject *old_ref, SPObject *ref, SPFilter *filter)
 353 {
 354     if (old_ref) {
 355         sp_signal_disconnect_by_data(old_ref, filter);
 356     }
 357     if ( SP_IS_FILTER(ref)
 358          && ref != filter )
 359     {
 360         ref->connectModified(sigc::bind(sigc::ptr_fun(&filter_ref_modified), filter));
 361         //g_signal_connect(G_OBJECT(ref), "modified", G_CALLBACK(filter_ref_modified), filter);
 362     }
 363
 364     filter_ref_modified(ref, 0, filter);
 365 }
 366
 367 static void
 368 filter_ref_modified(SPObject *href, guint flags, SPFilter *filter)
 369 {
 370     SP_OBJECT(filter)->requestModified(SP_OBJECT_MODIFIED_FLAG);
 371 }
 372
 373 /**
 374  * Callback for child_added event.
 375  */
 376 static void
 377 sp_filter_child_added(SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref)
 378 {
 379     //SPFilter *f = SP_FILTER(object);
 380
 381     if (((SPObjectClass *) filter_parent_class)->child_added)
 382         (* ((SPObjectClass *) filter_parent_class)->child_added)(object, child, ref);
 383
 384     object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 385 }
 386
 387 /**
 388  * Callback for remove_child event.
 389  */
 390 static void
 391 sp_filter_remove_child(SPObject *object, Inkscape::XML::Node *child)
 392 {
 393 //    SPFilter *f = SP_FILTER(object);
 394
 395     if (((SPObjectClass *) filter_parent_class)->remove_child)
 396         (* ((SPObjectClass *) filter_parent_class)->remove_child)(object, child);
 397
 398     object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 399 }
 400
 401 void sp_filter_build_renderer(SPFilter *sp_filter, NR::Filter *nr_filter)
 402 {
 403     g_assert(sp_filter != NULL);
 404     g_assert(nr_filter != NULL);
 405
 406     sp_filter->_renderer = nr_filter;
 407
 408     nr_filter->set_x(sp_filter->x);
 409     nr_filter->set_y(sp_filter->y);
 410     nr_filter->set_width(sp_filter->width);
 411     nr_filter->set_height(sp_filter->height);
 412
 413     nr_filter->clear_primitives();
 414     SPObject *primitive_obj = sp_filter->children;
 415     while (primitive_obj) {
 416         if (SP_IS_FILTER_PRIMITIVE(primitive_obj)) {
 417             SPFilterPrimitive *primitive = SP_FILTER_PRIMITIVE(primitive_obj);
 418             g_assert(primitive != NULL);
 419             if (((SPFilterPrimitiveClass*) G_OBJECT_GET_CLASS(primitive))->build_renderer) {
 420                 ((SPFilterPrimitiveClass *) G_OBJECT_GET_CLASS(primitive))->build_renderer(primitive, nr_filter);
 421             } else {
 422                 g_warning("Cannot build filter renderer: missing builder");
 423             }
 424         }
 425         primitive_obj = primitive_obj->next;
 426     }
 427 }
 428
 429 int sp_filter_primitive_count(SPFilter *filter) {
 430     g_assert(filter != NULL);
 431     int count = 0;
 432
 433     SPObject *primitive_obj = filter->children;
 434     while (primitive_obj) {
 435         if (SP_IS_FILTER_PRIMITIVE(primitive_obj)) count++;
 436         primitive_obj = primitive_obj->next;
 437     }
 438     return count;
 439 }
 440
 441 int sp_filter_get_image_name(SPFilter *filter, gchar const *name) {
 442     gchar *name_copy = strdup(name);
 443     map<gchar *, int, ltstr>::iterator result = filter->_image_name.find(name_copy);
 444     free(name_copy);
 445     if (result == filter->_image_name.end()) return -1;
 446     else return (*result).second;
 447 }
 448
 449 int sp_filter_set_image_name(SPFilter *filter, gchar const *name) {
 450     int value = filter->_image_number_next;
 451     filter->_image_number_next++;
 452     gchar *name_copy = strdup(name);
 453     pair<map<gchar*,int,ltstr>::iterator,bool> ret = filter->_image_name.insert(pair<gchar*,int>(name_copy, value));
 454     if (ret.second == false) {
 455         return (*ret.first).second;
 456     }
 457     return value;
 458 }
 459
 460 bool ltstr::operator()(const char* s1, const char* s2) const
 461 {
 462     return strcmp(s1, s2) < 0;
 463 }
 464
 465
 466 /*
 467   Local Variables:
 468   mode:c++
 469   c-file-style:"stroustrup"
 470   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 471   indent-tabs-mode:nil
 472   fill-column:99
 473   End:
 474 */
 475 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :