src/xml/repr.h

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