1 #define __SP_FILTER_PRIMITIVE_CPP__
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 */
17 #ifdef HAVE_CONFIG_H
18 # include "config.h"
19 #endif
21 #include <string.h>
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"
30 /* FilterPrimitive base class */
32 static void sp_filter_primitive_class_init(SPFilterPrimitiveClass *klass);
33 static void sp_filter_primitive_init(SPFilterPrimitive *filter_primitive);
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);
41 static SPObjectClass *filter_primitive_parent_class;
43 GType
44 sp_filter_primitive_get_type()
45 {
46 static GType filter_primitive_type = 0;
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 }
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;
70 filter_primitive_parent_class = (SPObjectClass*)g_type_class_peek_parent(klass);
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;
78 /* This should never be called on this base class, but only on derived
79 * classes. */
80 klass->build_renderer = NULL;
81 }
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 }
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 }
102 sp_object_read_attr(object, "in");
103 sp_object_read_attr(object, "result");
104 }
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 }
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;
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 }
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 }
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);
166 if (flags & SP_OBJECT_MODIFIED_FLAG) {
167 sp_object_read_attr(object, "in");
168 sp_object_read_attr(object, "result");
169 }
171 if (((SPObjectClass *) filter_primitive_parent_class)->update) {
172 ((SPObjectClass *) filter_primitive_parent_class)->update(object, ctx, flags);
173 }
174 }
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 *filterPrimitive = SP_FILTER_PRIMITIVE(object);
184 // Inkscape-only object, not copied during an "plain SVG" dump:
185 if (flags & SP_OBJECT_WRITE_EXT) {
186 if (repr) {
187 // is this sane?
188 //repr->mergeFrom(SP_OBJECT_REPR(object), "id");
189 } else {
190 repr = SP_OBJECT_REPR(object)->duplicate(doc);
191 }
192 }
194 if (((SPObjectClass *) filter_primitive_parent_class)->write) {
195 ((SPObjectClass *) filter_primitive_parent_class)->write(object, doc, repr, flags);
196 }
198 return repr;
199 }
201 int sp_filter_primitive_read_in(SPFilterPrimitive *prim, gchar const *name)
202 {
203 if (!name) return Inkscape::Filters::NR_FILTER_SLOT_NOT_SET;
204 // TODO: are these case sensitive or not? (assumed yes)
205 switch (name[0]) {
206 case 'S':
207 if (strcmp(name, "SourceGraphic") == 0)
208 return Inkscape::Filters::NR_FILTER_SOURCEGRAPHIC;
209 if (strcmp(name, "SourceAlpha") == 0)
210 return Inkscape::Filters::NR_FILTER_SOURCEALPHA;
211 if (strcmp(name, "StrokePaint") == 0)
212 return Inkscape::Filters::NR_FILTER_STROKEPAINT;
213 break;
214 case 'B':
215 if (strcmp(name, "BackgroundImage") == 0)
216 return Inkscape::Filters::NR_FILTER_BACKGROUNDIMAGE;
217 if (strcmp(name, "BackgroundAlpha") == 0)
218 return Inkscape::Filters::NR_FILTER_BACKGROUNDALPHA;
219 break;
220 case 'F':
221 if (strcmp(name, "FillPaint") == 0)
222 return Inkscape::Filters::NR_FILTER_FILLPAINT;
223 break;
224 }
226 SPFilter *parent = SP_FILTER(prim->parent);
227 int ret = sp_filter_get_image_name(parent, name);
228 if (ret >= 0) return ret;
230 return Inkscape::Filters::NR_FILTER_SLOT_NOT_SET;
231 }
233 int sp_filter_primitive_read_result(SPFilterPrimitive *prim, gchar const *name)
234 {
235 SPFilter *parent = SP_FILTER(prim->parent);
236 int ret = sp_filter_get_image_name(parent, name);
237 if (ret >= 0) return ret;
239 ret = sp_filter_set_image_name(parent, name);
240 if (ret >= 0) return ret;
242 return Inkscape::Filters::NR_FILTER_SLOT_NOT_SET;
243 }
245 /* Common initialization for filter primitives */
246 void sp_filter_primitive_renderer_common(SPFilterPrimitive *sp_prim, Inkscape::Filters::FilterPrimitive *nr_prim)
247 {
248 g_assert(sp_prim != NULL);
249 g_assert(nr_prim != NULL);
252 nr_prim->set_input(sp_prim->image_in);
253 nr_prim->set_output(sp_prim->image_out);
255 /* TODO: place here code to handle input images, filter area etc. */
256 }
260 /*
261 Local Variables:
262 mode:c++
263 c-file-style:"stroustrup"
264 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
265 indent-tabs-mode:nil
266 fill-column:99
267 End:
268 */
269 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :