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