src/filters/image.cpp

   1 /** \file
   2  * SVG <feImage> implementation.
   3  *
   4  */
   5 /*
   6  * Authors:
   7  *   Felipe Corrêa da Silva Sanches <juca@members.fsf.org>
   8  *   hugo Rodrigues <haa.rodrigues@gmail.com>
   9  *   Abhishek Sharma
  10  *
  11  * Copyright (C) 2007 Felipe Sanches
  12  * Copyright (C) 2006 Hugo Rodrigues
  13  *
  14  * Released under GNU GPL, read the file 'COPYING' for more information
  15  */
  16
  17 #ifdef HAVE_CONFIG_H
  18 # include "config.h"
  19 #endif
  20 #include "uri.h"
  21 #include "uri-references.h"
  22 #include "attributes.h"
  23 #include "svg/svg.h"
  24 #include "image.h"
  25 #include "xml/repr.h"
  26 #include <string.h>
  27
  28 #include "display/nr-filter.h"
  29 #include "display/nr-filter-image.h"
  30
  31 /* FeImage base class */
  32
  33 static void sp_feImage_class_init(SPFeImageClass *klass);
  34 static void sp_feImage_init(SPFeImage *feImage);
  35
  36 static void sp_feImage_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
  37 static void sp_feImage_release(SPObject *object);
  38 static void sp_feImage_set(SPObject *object, unsigned int key, gchar const *value);
  39 static void sp_feImage_update(SPObject *object, SPCtx *ctx, guint flags);
  40 static Inkscape::XML::Node *sp_feImage_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
  41 static void sp_feImage_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter);
  42
  43 static SPFilterPrimitiveClass *feImage_parent_class;
  44
  45 GType sp_feImage_get_type()
  46 {
  47     static GType feImage_type = 0;
  48
  49     if (!feImage_type) {
  50         GTypeInfo feImage_info = {
  51             sizeof(SPFeImageClass),
  52             NULL, NULL,
  53             (GClassInitFunc) sp_feImage_class_init,
  54             NULL, NULL,
  55             sizeof(SPFeImage),
  56             16,
  57             (GInstanceInitFunc) sp_feImage_init,
  58             NULL,    /* value_table */
  59         };
  60         feImage_type = g_type_register_static(SP_TYPE_FILTER_PRIMITIVE, "SPFeImage", &feImage_info, (GTypeFlags)0);
  61     }
  62     return feImage_type;
  63 }
  64
  65 static void sp_feImage_class_init(SPFeImageClass *klass)
  66 {
  67     SPObjectClass *sp_object_class = (SPObjectClass *)klass;
  68     SPFilterPrimitiveClass * sp_primitive_class = (SPFilterPrimitiveClass *)klass;
  69
  70     feImage_parent_class = (SPFilterPrimitiveClass*)g_type_class_peek_parent(klass);
  71
  72     sp_object_class->build = sp_feImage_build;
  73     sp_object_class->release = sp_feImage_release;
  74     sp_object_class->write = sp_feImage_write;
  75     sp_object_class->set = sp_feImage_set;
  76     sp_object_class->update = sp_feImage_update;
  77
  78     sp_primitive_class->build_renderer = sp_feImage_build_renderer;
  79 }
  80
  81 static void sp_feImage_init(SPFeImage */*feImage*/)
  82 {
  83 }
  84
  85 /**
  86  * Reads the Inkscape::XML::Node, and initializes SPFeImage variables.  For this to get called,
  87  * our name must be associated with a repr via "sp_object_type_register".  Best done through
  88  * sp-object-repr.cpp's repr_name_entries array.
  89  */
  90 static void sp_feImage_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
  91 {
  92     // Save document reference so we can load images with relative paths.
  93     SPFeImage *feImage = SP_FEIMAGE(object);
  94     feImage->document = document;
  95
  96     if (((SPObjectClass *) feImage_parent_class)->build) {
  97         ((SPObjectClass *) feImage_parent_class)->build(object, document, repr);
  98     }
  99
 100     /*LOAD ATTRIBUTES FROM REPR HERE*/
 101
 102     object->readAttr( "x" );
 103     object->readAttr( "y" );
 104     object->readAttr( "width" );
 105     object->readAttr( "height" );
 106     object->readAttr( "xlink:href" );
 107
 108 }
 109
 110 /**
 111  * Drops any allocated memory.
 112  */
 113 static void sp_feImage_release(SPObject *object)
 114 {
 115     SPFeImage *feImage = SP_FEIMAGE(object);
 116     feImage->_image_modified_connection.disconnect();
 117     feImage->_href_modified_connection.disconnect();
 118     if (feImage->SVGElemRef) delete feImage->SVGElemRef;
 119
 120     if (((SPObjectClass *) feImage_parent_class)->release)
 121         ((SPObjectClass *) feImage_parent_class)->release(object);
 122 }
 123
 124 static void sp_feImage_elem_modified(SPObject* /*href*/, guint /*flags*/, SPObject* obj)
 125 {
 126     obj->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 127 }
 128
 129 static void sp_feImage_href_modified(SPObject* /*old_elem*/, SPObject* new_elem, SPObject* obj)
 130 {
 131     SPFeImage *feImage = SP_FEIMAGE(obj);
 132     feImage->_image_modified_connection.disconnect();
 133     if (new_elem) {
 134         feImage->SVGElem = SP_ITEM(new_elem);
 135         feImage->_image_modified_connection = ((SPObject*) feImage->SVGElem)->connectModified(sigc::bind(sigc::ptr_fun(&sp_feImage_elem_modified), obj));
 136     } else {
 137         feImage->SVGElem = 0;
 138     }
 139
 140     obj->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 141 }
 142
 143 /**
 144  * Sets a specific value in the SPFeImage.
 145  */
 146 static void sp_feImage_set(SPObject *object, unsigned int key, gchar const *value)
 147 {
 148     SPFeImage *feImage = SP_FEIMAGE(object);
 149     (void)feImage;
 150     switch(key) {
 151     /*DEAL WITH SETTING ATTRIBUTES HERE*/
 152         case SP_ATTR_XLINK_HREF:
 153             if (feImage->href) {
 154                 g_free(feImage->href);
 155             }
 156             feImage->href = (value) ? g_strdup (value) : NULL;
 157             if (!feImage->href) return;
 158             delete feImage->SVGElemRef;
 159             feImage->SVGElemRef = 0;
 160             feImage->SVGElem = 0;
 161             feImage->_image_modified_connection.disconnect();
 162             feImage->_href_modified_connection.disconnect();
 163             try{
 164                 Inkscape::URI SVGElem_uri(feImage->href);
 165                 feImage->SVGElemRef = new Inkscape::URIReference(feImage->document);
 166                 feImage->SVGElemRef->attach(SVGElem_uri);
 167                 feImage->from_element = true;
 168                 feImage->_href_modified_connection = feImage->SVGElemRef->changedSignal().connect(sigc::bind(sigc::ptr_fun(&sp_feImage_href_modified), object));
 169                 if (SPObject *elemref = feImage->SVGElemRef->getObject()) {
 170                     feImage->SVGElem = SP_ITEM(elemref);
 171                     feImage->_image_modified_connection = ((SPObject*) feImage->SVGElem)->connectModified(sigc::bind(sigc::ptr_fun(&sp_feImage_elem_modified), object));
 172                     object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 173                     break;
 174                 } else {
 175                     g_warning("SVG element URI was not found in the document while loading feImage");
 176                 }
 177             }
 178             // catches either MalformedURIException or UnsupportedURIException
 179             catch(const Inkscape::BadURIException & e)
 180             {
 181                 feImage->from_element = false;
 182                 /* This occurs when using external image as the source */
 183                 //g_warning("caught Inkscape::BadURIException in sp_feImage_set");
 184                 break;
 185             }
 186             break;
 187
 188         case SP_ATTR_X:
 189             feImage->x.readOrUnset(value);
 190             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 191             break;
 192         case SP_ATTR_Y:
 193             feImage->y.readOrUnset(value);
 194             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 195             break;
 196         case SP_ATTR_WIDTH:
 197             feImage->width.readOrUnset(value);
 198             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 199             break;
 200         case SP_ATTR_HEIGHT:
 201             feImage->height.readOrUnset(value);
 202             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 203             break;
 204         default:
 205             if (((SPObjectClass *) feImage_parent_class)->set)
 206                 ((SPObjectClass *) feImage_parent_class)->set(object, key, value);
 207             break;
 208     }
 209
 210 }
 211
 212 /**
 213  * Receives update notifications.
 214  */
 215 static void sp_feImage_update(SPObject *object, SPCtx *ctx, guint flags)
 216 {
 217
 218     if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
 219                  SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 220
 221         /* do something to trigger redisplay, updates? */
 222     }
 223
 224     if (((SPObjectClass *) feImage_parent_class)->update) {
 225         ((SPObjectClass *) feImage_parent_class)->update(object, ctx, flags);
 226     }
 227 }
 228
 229 /**
 230  * Writes its settings to an incoming repr object, if any.
 231  */
 232 static Inkscape::XML::Node * sp_feImage_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags)
 233 {
 234     /* TODO: Don't just clone, but create a new repr node and write all
 235      * relevant values into it */
 236     if (!repr) {
 237         repr = SP_OBJECT_REPR(object)->duplicate(doc);
 238     }
 239
 240     if (((SPObjectClass *) feImage_parent_class)->write) {
 241         ((SPObjectClass *) feImage_parent_class)->write(object, doc, repr, flags);
 242     }
 243
 244     return repr;
 245 }
 246
 247 static void sp_feImage_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter) {
 248     g_assert(primitive != NULL);
 249     g_assert(filter != NULL);
 250
 251     SPFeImage *sp_image = SP_FEIMAGE(primitive);
 252
 253     int primitive_n = filter->add_primitive(Inkscape::Filters::NR_FILTER_IMAGE);
 254     Inkscape::Filters::FilterPrimitive *nr_primitive = filter->get_primitive(primitive_n);
 255     Inkscape::Filters::FilterImage *nr_image = dynamic_cast<Inkscape::Filters::FilterImage*>(nr_primitive);
 256     g_assert(nr_image != NULL);
 257
 258     sp_filter_primitive_renderer_common(primitive, nr_primitive);
 259
 260     nr_image->from_element = sp_image->from_element;
 261     nr_image->SVGElem = sp_image->SVGElem;
 262     nr_image->set_region(sp_image->x, sp_image->y, sp_image->width, sp_image->height);
 263     nr_image->set_href(sp_image->href);
 264     nr_image->set_document(sp_image->document);
 265 }
 266
 267 /*
 268   Local Variables:
 269   mode:c++
 270   c-file-style:"stroustrup"
 271   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 272   indent-tabs-mode:nil
 273   fill-column:99
 274   End:
 275 */
 276 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :