1 #ifndef __SP_REPR_H__
2 #define __SP_REPR_H__
4 /** \file
5 * C facade to Inkscape::XML::Node.
6 *
7 * Authors:
8 * Lauris Kaplinski <lauris@kaplinski.com>
9 *
10 * Copyright (C) 1999-2002 authors
11 * Copyright (C) 2000-2002 Ximian, Inc.
12 *
13 * Released under GNU GPL, read the file 'COPYING' for more information
14 */
16 #include <stdio.h>
17 #include <glib/gtypes.h>
18 #include "gc-anchored.h"
20 #include "xml/node.h"
21 #include "xml/document.h"
22 #include "xml/sp-css-attr.h"
24 #define SP_SODIPODI_NS_URI "http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
25 #define SP_BROKEN_SODIPODI_NS_URI "http://inkscape.sourceforge.net/DTD/sodipodi-0.dtd"
26 #define SP_INKSCAPE_NS_URI "http://www.inkscape.org/namespaces/inkscape"
27 #define SP_XLINK_NS_URI "http://www.w3.org/1999/xlink"
28 #define SP_SVG_NS_URI "http://www.w3.org/2000/svg"
29 #define SP_RDF_NS_URI "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
30 #define SP_CC_NS_URI "http://web.resource.org/cc/"
31 #define SP_DC_NS_URI "http://purl.org/dc/elements/1.1/"
33 /**
34 * \note NB! Unless explicitly stated all methods are noref/nostrcpy
35 */
37 /** \todo
38 * Though Inkscape::XML::Node provides "signals" for notification when
39 * individual nodes change, there is no mechanism to receive notification
40 * for overall document changes.
41 * However, with the addition of the transactions code, it would not be
42 * very hard to implement if you wanted it.
43 *
44 * \class Inkscape::XML::Node
45 * \note
46 * Inkscape::XML::Node itself doesn't use GObject signals at present --
47 * Inkscape::XML::Nodes maintain lists of Inkscape::XML::NodeEventVectors
48 * (added via sp_repr_add_listener), which are used to specify callbacks
49 * when something changes.
50 *
51 * Here are the current callbacks in an event vector (they may be NULL):
52 *
53 * void (* child_added)(Inkscape::XML::Node *repr, Inkscape::XML::Node *child,
54 * Inkscape::XML::Node *ref, void *data); Called once a child has been added.
55 *
56 * void (* child_removed)(Inkscape::XML::Node *repr,
57 * Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void *data);
58 * Called after a child is removed; ref is the child that used to precede
59 * the removed child.
60 *
61 * void (* attr_changed)(Inkscape::XML::Node *repr, gchar const *key,
62 * gchar const *oldval, gchar const *newval, void *data);
63 * Called after an attribute has been changed.
64 *
65 * void (* content_changed)(Inkscape::XML::Node *repr, gchar const *oldcontent,
66 * gchar const *newcontent, void *data);
67 * Called after an element's content has been changed.
68 *
69 * void (* order_changed)(Inkscape::XML::Node *repr, Inkscape::XML::Node *child,
70 * Inkscape::XML::Node *oldref, Inkscape::XML::Node *newref, void *data);
71 * Called once the child has been moved to its new position in the child order.
72 *
73 * <b> Inkscape::XML::Node mini-FAQ </b>
74 *
75 * Since I'm not very familiar with this section of code but I need to use
76 * it heavily for the RDF work, I'm going to answer various questions I run
77 * into with my best-guess answers so others can follow along too.
78 *
79 * \arg
80 * Q: How do I find the root Inkscape::XML::Node? <br>
81 * A: If you have an SPDocument, use doc->rroot. For example:
82 *
83 * \code SP_ACTIVE_DOCUMENT->rroot \endcode <br>
84 *
85 * (but it's better to arrange for your caller to pass in the relevent
86 * document rather than assuming it's necessarily the active one and
87 * using SP_ACTIVE_DOCUMENT)
88 *
89 * \arg
90 * Q: How do I find an Inkscape::XML::Node by unique key/value? <br>
91 * A: Use sp_repr_lookup_child
92 *
93 * \arg
94 * Q: How do I find an Inkscape::XML::Node by unique namespace name? <br>
95 * A: Use sp_repr_lookup_name
96 *
97 * \arg
98 * Q: How do I make an Inkscape::XML::Node namespace prefix constant in
99 * the application? <br>
100 * A: Add the XML namespace URL as a #define to repr.h at the top with the
101 * other SP_<NAMESPACE>_NS_URI #define's, and then in repr-util.cpp,
102 * in sp_xml_ns_register_defaults, bump "defaults" up in size one, and
103 * add another section. Don't forget to increment the array offset and
104 * keep ".next" pointed to the next (if any) array entry.
105 *
106 * \arg
107 * Q: How do I create a new Inkscape::XML::Node? <br>
108 * A: Use the appropriate create* method on Inkscape::XML::Document,
109 * parent->appendChild(child), and then use Inkscape::GC::release(child) to
110 * let go of it (the parent will hold it in memory).
111 *
112 * \arg
113 * Q: How do I destroy an Inkscape::XML::Node?
114 * A: Just call "sp_repr_unparent" on it and release any references
115 * you may be retaining to it. Any attached SPObjects will
116 * clean themselves up automatically, as will any children.
117 *
118 * \arg
119 * Q: What about listeners? <br>
120 * A: I have no idea yet...
121 *
122 * \arg
123 * Q: How do I add a namespace to a newly created document? <br>
124 * A: The current hack is in document.cpp:sp_document_create
125 *
126 * Kees Cook 2004-07-01, updated MenTaLguY 2005-01-25
127 */
129 /* SPXMLNs */
130 char const *sp_xml_ns_uri_prefix(gchar const *uri, gchar const *suggested);
131 char const *sp_xml_ns_prefix_uri(gchar const *prefix);
133 Inkscape::XML::Document *sp_repr_document_new(gchar const *rootname);
135 /* Contents */
136 /// Sets the node's \a key attribute to \a value.
137 inline unsigned sp_repr_set_attr(Inkscape::XML::Node *repr, gchar const *key, gchar const *value,
138 bool is_interactive = false) {
139 repr->setAttribute(key, value, is_interactive);
140 return true;
141 }
143 /* Tree */
144 /// Returns the node's parent.
145 inline Inkscape::XML::Node *sp_repr_parent(Inkscape::XML::Node const *repr) {
146 return const_cast<Inkscape::XML::Node *>(repr->parent());
147 }
149 /// Returns first child of node, resets iterator.
150 inline Inkscape::XML::Node *sp_repr_children(Inkscape::XML::Node *repr) {
151 return ( repr ? repr->firstChild() : NULL );
152 }
154 /// Returns next child of node or NULL.
155 inline Inkscape::XML::Node *sp_repr_next(Inkscape::XML::Node *repr) {
156 return ( repr ? repr->next() : NULL );
157 }
159 /* IO */
161 Inkscape::XML::Document *sp_repr_read_file(gchar const *filename, gchar const *default_ns);
162 Inkscape::XML::Document *sp_repr_read_mem(gchar const *buffer, int length, gchar const *default_ns);
163 void sp_repr_save_stream(Inkscape::XML::Document *doc, FILE *to_file, gchar const *default_ns=NULL, bool compress = false);
164 bool sp_repr_save_file(Inkscape::XML::Document *doc, gchar const *filename, gchar const *default_ns=NULL);
166 void sp_repr_print(Inkscape::XML::Node *repr);
168 /* CSS stuff */
170 SPCSSAttr *sp_repr_css_attr_new(void);
171 void sp_repr_css_attr_unref(SPCSSAttr *css);
172 SPCSSAttr *sp_repr_css_attr(Inkscape::XML::Node *repr, gchar const *attr);
173 SPCSSAttr *sp_repr_css_attr_inherited(Inkscape::XML::Node *repr, gchar const *attr);
175 gchar const *sp_repr_css_property(SPCSSAttr *css, gchar const *name, gchar const *defval);
176 void sp_repr_css_set_property(SPCSSAttr *css, gchar const *name, gchar const *value);
177 void sp_repr_css_unset_property(SPCSSAttr *css, gchar const *name);
178 bool sp_repr_css_property_is_unset(SPCSSAttr *css, gchar const *name);
179 double sp_repr_css_double_property(SPCSSAttr *css, gchar const *name, double defval);
181 gchar *sp_repr_css_write_string(SPCSSAttr *css);
182 void sp_repr_css_set(Inkscape::XML::Node *repr, SPCSSAttr *css, gchar const *key);
183 void sp_repr_css_merge(SPCSSAttr *dst, SPCSSAttr *src);
184 void sp_repr_css_attr_add_from_string(SPCSSAttr *css, const gchar *data);
185 void sp_repr_css_change(Inkscape::XML::Node *repr, SPCSSAttr *css, gchar const *key);
186 void sp_repr_css_change_recursive(Inkscape::XML::Node *repr, SPCSSAttr *css, gchar const *key);
188 void sp_repr_css_print(SPCSSAttr *css);
190 /* Utility finctions */
191 /// Remove \a repr from children of its parent node.
192 inline void sp_repr_unparent(Inkscape::XML::Node *repr) {
193 Inkscape::XML::Node *parent=repr->parent();
194 if (parent) {
195 parent->removeChild(repr);
196 }
197 }
199 /* Convenience */
200 unsigned sp_repr_get_boolean(Inkscape::XML::Node *repr, gchar const *key, unsigned *val);
201 unsigned sp_repr_get_int(Inkscape::XML::Node *repr, gchar const *key, int *val);
202 unsigned sp_repr_get_double(Inkscape::XML::Node *repr, gchar const *key, double *val);
203 unsigned sp_repr_set_boolean(Inkscape::XML::Node *repr, gchar const *key, unsigned val);
204 unsigned sp_repr_set_int(Inkscape::XML::Node *repr, gchar const *key, int val);
205 unsigned sp_repr_set_css_double(Inkscape::XML::Node *repr, gchar const *key, double val);
206 unsigned sp_repr_set_svg_double(Inkscape::XML::Node *repr, gchar const *key, double val);
208 /// \deprecated !
209 double sp_repr_get_double_attribute(Inkscape::XML::Node *repr, gchar const *key, double def);
210 /// \deprecated !
211 long long int sp_repr_get_int_attribute(Inkscape::XML::Node *repr, gchar const *key, long long int def);
212 /* End Deprecated? */
214 int sp_repr_compare_position(Inkscape::XML::Node *first, Inkscape::XML::Node *second);
216 /* Searching */
217 Inkscape::XML::Node *sp_repr_lookup_name(Inkscape::XML::Node *repr,
218 gchar const *name,
219 gint maxdepth = -1);
220 Inkscape::XML::Node *sp_repr_lookup_child(Inkscape::XML::Node *repr,
221 gchar const *key,
222 gchar const *value);
225 inline Inkscape::XML::Node *sp_repr_document_first_child(Inkscape::XML::Document const *doc) {
226 return const_cast<Inkscape::XML::Node *>(doc->firstChild());
227 }
229 #endif
232 /*
233 Local Variables:
234 mode:c++
235 c-file-style:"stroustrup"
236 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
237 indent-tabs-mode:nil
238 fill-column:99
239 End:
240 */
241 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :