src/sp-filter-primitive.cpp

   1 #define __SP_FILTER_PRIMITIVE_CPP__
   2
   3 /** \file
   4  * Superclass for all the filter primitives
   5  *
   6  */
   7 /*
   8  * Authors:
   9  *   Kees Cook <kees@outflux.net>
  10  *   Niko Kiirala <niko@kiirala.com>
  11  *
  12  * Copyright (C) 2004-2007 Authors
  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
  21 #include "attributes.h"
  22 #include "sp-filter-primitive.h"
  23 #include "xml/repr.h"
  24 #include "sp-filter.h"
  25 #include "display/nr-filter-primitive.h"
  26 #include "display/nr-filter-types.h"
  27
  28 /* FilterPrimitive base class */
  29
  30 static void sp_filter_primitive_class_init(SPFilterPrimitiveClass *klass);
  31 static void sp_filter_primitive_init(SPFilterPrimitive *filter_primitive);
  32
  33 static void sp_filter_primitive_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
  34 static void sp_filter_primitive_release(SPObject *object);
  35 static void sp_filter_primitive_set(SPObject *object, unsigned int key, gchar const *value);
  36 static void sp_filter_primitive_update(SPObject *object, SPCtx *ctx, guint flags);
  37 static Inkscape::XML::Node *sp_filter_primitive_write(SPObject *object, Inkscape::XML::Node *repr, guint flags);
  38
  39 static SPObjectClass *filter_primitive_parent_class;
  40
  41 GType
  42 sp_filter_primitive_get_type()
  43 {
  44     static GType filter_primitive_type = 0;
  45
  46     if (!filter_primitive_type) {
  47         GTypeInfo filter_primitive_info = {
  48             sizeof(SPFilterPrimitiveClass),
  49             NULL, NULL,
  50             (GClassInitFunc) sp_filter_primitive_class_init,
  51             NULL, NULL,
  52             sizeof(SPFilterPrimitive),
  53             16,
  54             (GInstanceInitFunc) sp_filter_primitive_init,
  55             NULL,    /* value_table */
  56         };
  57         filter_primitive_type = g_type_register_static(SP_TYPE_OBJECT, "SPFilterPrimitive", &filter_primitive_info, (GTypeFlags)0);
  58     }
  59     return filter_primitive_type;
  60 }
  61
  62 static void
  63 sp_filter_primitive_class_init(SPFilterPrimitiveClass *klass)
  64 {
  65     //GObjectClass *gobject_class = (GObjectClass *)klass;
  66     SPObjectClass *sp_object_class = (SPObjectClass *)klass;
  67
  68     filter_primitive_parent_class = (SPObjectClass*)g_type_class_peek_parent(klass);
  69
  70     sp_object_class->build = sp_filter_primitive_build;
  71     sp_object_class->release = sp_filter_primitive_release;
  72     sp_object_class->write = sp_filter_primitive_write;
  73     sp_object_class->set = sp_filter_primitive_set;
  74     sp_object_class->update = sp_filter_primitive_update;
  75
  76     /* This should never be called on this base class, but only on derived
  77      * classes. */
  78     klass->build_renderer = NULL;
  79 }
  80
  81 static void
  82 sp_filter_primitive_init(SPFilterPrimitive *filter_primitive)
  83 {
  84     filter_primitive->image_in = NR::NR_FILTER_SLOT_NOT_SET;
  85     filter_primitive->image_out = NR::NR_FILTER_SLOT_NOT_SET;
  86 }
  87
  88 /**
  89  * Reads the Inkscape::XML::Node, and initializes SPFilterPrimitive variables.  For this to get called,
  90  * our name must be associated with a repr via "sp_object_type_register".  Best done through
  91  * sp-object-repr.cpp's repr_name_entries array.
  92  */
  93 static void
  94 sp_filter_primitive_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
  95 {
  96     if (((SPObjectClass *) filter_primitive_parent_class)->build) {
  97         ((SPObjectClass *) filter_primitive_parent_class)->build(object, document, repr);
  98     }
  99
 100     sp_object_read_attr(object, "in");
 101     sp_object_read_attr(object, "result");
 102
 103     if (object->parent)
 104         add_primitive((SPFilter*)object->parent, (SPFilterPrimitive*)object);
 105 }
 106
 107 /**
 108  * Drops any allocated memory.
 109  */
 110 static void
 111 sp_filter_primitive_release(SPObject *object)
 112 {
 113     /* deal with our children and our selves here */
 114     if (((SPObjectClass *) filter_primitive_parent_class)->release)
 115         ((SPObjectClass *) filter_primitive_parent_class)->release(object);
 116 }
 117
 118 /**
 119  * Sets a specific value in the SPFilterPrimitive.
 120  */
 121 static void
 122 sp_filter_primitive_set(SPObject *object, unsigned int key, gchar const *value)
 123 {
 124     SPFilterPrimitive *filter_primitive = SP_FILTER_PRIMITIVE(object);
 125     (void)filter_primitive;
 126
 127     int image_nr;
 128     switch (key) {
 129         case SP_ATTR_IN:
 130             if (value) {
 131                 image_nr = sp_filter_primitive_read_in(filter_primitive, value);
 132             } else {
 133                 image_nr = NR::NR_FILTER_SLOT_NOT_SET;
 134             }
 135             if (image_nr != filter_primitive->image_in) {
 136                 filter_primitive->image_in = image_nr;
 137                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 138             }
 139             break;
 140         case SP_ATTR_RESULT:
 141             if (value) {
 142                 image_nr = sp_filter_primitive_read_result(filter_primitive, value);
 143             } else {
 144                 image_nr = NR::NR_FILTER_SLOT_NOT_SET;
 145             }
 146             if (image_nr != filter_primitive->image_out) {
 147                 filter_primitive->image_out = image_nr;
 148                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 149             }
 150             break;
 151     }
 152
 153     /* See if any parents need this value. */
 154     if (((SPObjectClass *) filter_primitive_parent_class)->set) {
 155         ((SPObjectClass *) filter_primitive_parent_class)->set(object, key, value);
 156     }
 157 }
 158
 159 /**
 160  * Receives update notifications.
 161  */
 162 static void
 163 sp_filter_primitive_update(SPObject *object, SPCtx *ctx, guint flags)
 164 {
 165     //SPFilterPrimitive *filter_primitive = SP_FILTER_PRIMITIVE(object);
 166
 167     if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
 168                  SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 169
 170         /* do something to trigger redisplay, updates? */
 171     }
 172
 173     if (((SPObjectClass *) filter_primitive_parent_class)->update) {
 174         ((SPObjectClass *) filter_primitive_parent_class)->update(object, ctx, flags);
 175     }
 176 }
 177
 178 /**
 179  * Writes its settings to an incoming repr object, if any.
 180  */
 181 static Inkscape::XML::Node *
 182 sp_filter_primitive_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
 183 {
 184     //SPFilterPrimitive *filterPrimitive = SP_FILTER_PRIMITIVE(object);
 185
 186     // Inkscape-only object, not copied during an "plain SVG" dump:
 187     if (flags & SP_OBJECT_WRITE_EXT) {
 188         if (repr) {
 189             // is this sane?
 190             //repr->mergeFrom(SP_OBJECT_REPR(object), "id");
 191         } else {
 192              /// \todo FIXME:  Plumb an appropriate XML::Document into this
 193              repr = SP_OBJECT_REPR(object)->duplicate(NULL);
 194         }
 195     }
 196
 197     if (((SPObjectClass *) filter_primitive_parent_class)->write) {
 198         ((SPObjectClass *) filter_primitive_parent_class)->write(object, repr, flags);
 199     }
 200
 201     return repr;
 202 }
 203
 204 int sp_filter_primitive_read_in(SPFilterPrimitive *prim, gchar const *name)
 205 {
 206     if (!name) return NR::NR_FILTER_SLOT_NOT_SET;
 207     // TODO: are these case sensitive or not? (assumed yes)
 208     switch (name[0]) {
 209         case 'S':
 210             if (strcmp(name, "SourceGraphic") == 0)
 211                 return NR::NR_FILTER_SOURCEGRAPHIC;
 212             if (strcmp(name, "SourceAlpha") == 0)
 213                 return NR::NR_FILTER_SOURCEALPHA;
 214             if (strcmp(name, "StrokePaint") == 0)
 215                 return NR::NR_FILTER_STROKEPAINT;
 216             break;
 217         case 'B':
 218             if (strcmp(name, "BackgroundImage") == 0)
 219                 return NR::NR_FILTER_BACKGROUNDIMAGE;
 220             if (strcmp(name, "BackgroundAlpha") == 0)
 221                 return NR::NR_FILTER_BACKGROUNDALPHA;
 222             break;
 223         case 'F':
 224             if (strcmp(name, "FillPaint") == 0)
 225                 return NR::NR_FILTER_FILLPAINT;
 226             break;
 227     }
 228
 229     SPFilter *parent = SP_FILTER(prim->parent);
 230     int ret = sp_filter_get_image_name(parent, name);
 231     if (ret >= 0) return ret;
 232
 233     return NR::NR_FILTER_SLOT_NOT_SET;
 234 }
 235
 236 int sp_filter_primitive_read_result(SPFilterPrimitive *prim, gchar const *name)
 237 {
 238     SPFilter *parent = SP_FILTER(prim->parent);
 239     int ret = sp_filter_get_image_name(parent, name);
 240     if (ret >= 0) return ret;
 241
 242     ret = sp_filter_set_image_name(parent, name);
 243     if (ret >= 0) return ret;
 244
 245     return NR::NR_FILTER_SLOT_NOT_SET;
 246 }
 247
 248 /* Common initialization for filter primitives */
 249 void sp_filter_primitive_renderer_common(SPFilterPrimitive *sp_prim, NR::FilterPrimitive *nr_prim)
 250 {
 251     g_assert(sp_prim != NULL);
 252     g_assert(nr_prim != NULL);
 253
 254
 255     nr_prim->set_input(sp_prim->image_in);
 256     nr_prim->set_output(sp_prim->image_out);
 257
 258     /* TODO: place here code to handle input images, filter area etc. */
 259 }
 260
 261
 262
 263 /*
 264   Local Variables:
 265   mode:c++
 266   c-file-style:"stroustrup"
 267   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 268   indent-tabs-mode:nil
 269   fill-column:99
 270   End:
 271 */
 272 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :