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