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 "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"
28 /* FilterPrimitive base class */
30 static void sp_filter_primitive_class_init(SPFilterPrimitiveClass *klass);
31 static void sp_filter_primitive_init(SPFilterPrimitive *filter_primitive);
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);
39 static SPObjectClass *filter_primitive_parent_class;
41 GType
42 sp_filter_primitive_get_type()
43 {
44 static GType filter_primitive_type = 0;
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 }
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;
68 filter_primitive_parent_class = (SPObjectClass*)g_type_class_peek_parent(klass);
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;
76 /* This should never be called on this base class, but only on derived
77 * classes. */
78 klass->build_renderer = NULL;
79 }
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 }
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 }
100 sp_object_read_attr(object, "in");
101 sp_object_read_attr(object, "result");
102 }
104 /**
105 * Drops any allocated memory.
106 */
107 static void
108 sp_filter_primitive_release(SPObject *object)
109 {
110 /* deal with our children and our selves here */
111 if (((SPObjectClass *) filter_primitive_parent_class)->release)
112 ((SPObjectClass *) filter_primitive_parent_class)->release(object);
113 }
115 /**
116 * Sets a specific value in the SPFilterPrimitive.
117 */
118 static void
119 sp_filter_primitive_set(SPObject *object, unsigned int key, gchar const *value)
120 {
121 SPFilterPrimitive *filter_primitive = SP_FILTER_PRIMITIVE(object);
122 (void)filter_primitive;
124 int image_nr;
125 switch (key) {
126 case SP_ATTR_IN:
127 if (value) {
128 image_nr = sp_filter_primitive_read_in(filter_primitive, value);
129 } else {
130 image_nr = NR::NR_FILTER_SLOT_NOT_SET;
131 }
132 if (image_nr != filter_primitive->image_in) {
133 filter_primitive->image_in = image_nr;
134 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
135 }
136 break;
137 case SP_ATTR_RESULT:
138 if (value) {
139 image_nr = sp_filter_primitive_read_result(filter_primitive, value);
140 } else {
141 image_nr = NR::NR_FILTER_SLOT_NOT_SET;
142 }
143 if (image_nr != filter_primitive->image_out) {
144 filter_primitive->image_out = image_nr;
145 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
146 }
147 break;
148 }
150 /* See if any parents need this value. */
151 if (((SPObjectClass *) filter_primitive_parent_class)->set) {
152 ((SPObjectClass *) filter_primitive_parent_class)->set(object, key, value);
153 }
154 }
156 /**
157 * Receives update notifications.
158 */
159 static void
160 sp_filter_primitive_update(SPObject *object, SPCtx *ctx, guint flags)
161 {
162 //SPFilterPrimitive *filter_primitive = SP_FILTER_PRIMITIVE(object);
164 if (flags & SP_OBJECT_MODIFIED_FLAG) {
165 sp_object_read_attr(object, "in");
166 sp_object_read_attr(object, "result");
167 }
169 if (((SPObjectClass *) filter_primitive_parent_class)->update) {
170 ((SPObjectClass *) filter_primitive_parent_class)->update(object, ctx, flags);
171 }
172 }
174 /**
175 * Writes its settings to an incoming repr object, if any.
176 */
177 static Inkscape::XML::Node *
178 sp_filter_primitive_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
179 {
180 //SPFilterPrimitive *filterPrimitive = SP_FILTER_PRIMITIVE(object);
182 // Inkscape-only object, not copied during an "plain SVG" dump:
183 if (flags & SP_OBJECT_WRITE_EXT) {
184 if (repr) {
185 // is this sane?
186 //repr->mergeFrom(SP_OBJECT_REPR(object), "id");
187 } else {
188 /// \todo FIXME: Plumb an appropriate XML::Document into this
189 repr = SP_OBJECT_REPR(object)->duplicate(NULL);
190 }
191 }
193 if (((SPObjectClass *) filter_primitive_parent_class)->write) {
194 ((SPObjectClass *) filter_primitive_parent_class)->write(object, repr, flags);
195 }
197 return repr;
198 }
200 int sp_filter_primitive_read_in(SPFilterPrimitive *prim, gchar const *name)
201 {
202 if (!name) return NR::NR_FILTER_SLOT_NOT_SET;
203 // TODO: are these case sensitive or not? (assumed yes)
204 switch (name[0]) {
205 case 'S':
206 if (strcmp(name, "SourceGraphic") == 0)
207 return NR::NR_FILTER_SOURCEGRAPHIC;
208 if (strcmp(name, "SourceAlpha") == 0)
209 return NR::NR_FILTER_SOURCEALPHA;
210 if (strcmp(name, "StrokePaint") == 0)
211 return NR::NR_FILTER_STROKEPAINT;
212 break;
213 case 'B':
214 if (strcmp(name, "BackgroundImage") == 0)
215 return NR::NR_FILTER_BACKGROUNDIMAGE;
216 if (strcmp(name, "BackgroundAlpha") == 0)
217 return NR::NR_FILTER_BACKGROUNDALPHA;
218 break;
219 case 'F':
220 if (strcmp(name, "FillPaint") == 0)
221 return NR::NR_FILTER_FILLPAINT;
222 break;
223 }
225 SPFilter *parent = SP_FILTER(prim->parent);
226 int ret = sp_filter_get_image_name(parent, name);
227 if (ret >= 0) return ret;
229 return NR::NR_FILTER_SLOT_NOT_SET;
230 }
232 int sp_filter_primitive_read_result(SPFilterPrimitive *prim, gchar const *name)
233 {
234 SPFilter *parent = SP_FILTER(prim->parent);
235 int ret = sp_filter_get_image_name(parent, name);
236 if (ret >= 0) return ret;
238 ret = sp_filter_set_image_name(parent, name);
239 if (ret >= 0) return ret;
241 return NR::NR_FILTER_SLOT_NOT_SET;
242 }
244 /* Common initialization for filter primitives */
245 void sp_filter_primitive_renderer_common(SPFilterPrimitive *sp_prim, NR::FilterPrimitive *nr_prim)
246 {
247 g_assert(sp_prim != NULL);
248 g_assert(nr_prim != NULL);
251 nr_prim->set_input(sp_prim->image_in);
252 nr_prim->set_output(sp_prim->image_out);
254 /* TODO: place here code to handle input images, filter area etc. */
255 }
259 /*
260 Local Variables:
261 mode:c++
262 c-file-style:"stroustrup"
263 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
264 indent-tabs-mode:nil
265 fill-column:99
266 End:
267 */
268 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :