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://web.resource.org/cc/"
  31 #define SP_DC_NS_URI "http://purl.org/dc/elements/1.1/"
  32
  33 /**
  34  * \note NB! Unless explicitly stated all methods are noref/nostrcpy
  35  */
  36
  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 "sp_repr_new*".  Then attach it to a parent somewhere with
 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  */
 128
 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);
 132
 133
 134 Inkscape::XML::Node *sp_repr_new(gchar const *name);
 135 Inkscape::XML::Node *sp_repr_new_text(gchar const *content);
 136 Inkscape::XML::Node *sp_repr_new_comment(gchar const *comment);
 137
 138 /*inline Inkscape::XML::Node *sp_repr_duplicate(Inkscape::XML::Node const *repr) {
 139     return repr->duplicate();
 140 }*/
 141
 142 Inkscape::XML::Document *sp_repr_document_new(gchar const *rootname);
 143
 144 /// Returns root node of document.
 145 inline Inkscape::XML::Node *sp_repr_document_root(Inkscape::XML::Document const *doc) {
 146     return const_cast<Inkscape::XML::Node *>(doc->root());
 147 }
 148
 149 /// Returns the node's document.
 150 inline Inkscape::XML::Document *sp_repr_document(Inkscape::XML::Node const *repr) {
 151     return const_cast<Inkscape::XML::Document *>(repr->document());
 152 }
 153
 154 /* Contents */
 155 /// Sets the node's \a key attribute to \a value.
 156 inline unsigned sp_repr_set_attr(Inkscape::XML::Node *repr, gchar const *key, gchar const *value,
 157                                  bool is_interactive = false) {
 158     repr->setAttribute(key, value, is_interactive);
 159     return true;
 160 }
 161
 162 /* Tree */
 163 /// Returns the node's parent.
 164 inline Inkscape::XML::Node *sp_repr_parent(Inkscape::XML::Node const *repr) {
 165     return const_cast<Inkscape::XML::Node *>(repr->parent());
 166 }
 167
 168 /// Returns first child of node, resets iterator.
 169 inline Inkscape::XML::Node *sp_repr_children(Inkscape::XML::Node *repr) {
 170     return ( repr ? repr->firstChild() : NULL );
 171 }
 172
 173 /// Returns next child of node or NULL.
 174 inline Inkscape::XML::Node *sp_repr_next(Inkscape::XML::Node *repr) {
 175     return ( repr ? repr->next() : NULL );
 176 }
 177
 178 /* IO */
 179
 180 Inkscape::XML::Document *sp_repr_read_file(gchar const *filename, gchar const *default_ns);
 181 Inkscape::XML::Document *sp_repr_read_mem(gchar const *buffer, int length, gchar const *default_ns);
 182 void sp_repr_save_stream(Inkscape::XML::Document *doc, FILE *to_file, gchar const *default_ns=NULL, bool compress = false);
 183 gboolean sp_repr_save_file(Inkscape::XML::Document *doc, gchar const *filename, gchar const *default_ns=NULL);
 184
 185 void sp_repr_print(Inkscape::XML::Node *repr);
 186
 187 /* CSS stuff */
 188
 189 SPCSSAttr *sp_repr_css_attr_new(void);
 190 void sp_repr_css_attr_unref(SPCSSAttr *css);
 191 SPCSSAttr *sp_repr_css_attr(Inkscape::XML::Node *repr, gchar const *attr);
 192 SPCSSAttr *sp_repr_css_attr_inherited(Inkscape::XML::Node *repr, gchar const *attr);
 193
 194 gchar const *sp_repr_css_property(SPCSSAttr *css, gchar const *name, gchar const *defval);
 195 void sp_repr_css_set_property(SPCSSAttr *css, gchar const *name, gchar const *value);
 196 void sp_repr_css_unset_property(SPCSSAttr *css, gchar const *name);
 197 bool sp_repr_css_property_is_unset(SPCSSAttr *css, gchar const *name);
 198 double sp_repr_css_double_property(SPCSSAttr *css, gchar const *name, double defval);
 199
 200 gchar *sp_repr_css_write_string(SPCSSAttr *css);
 201 void sp_repr_css_set(Inkscape::XML::Node *repr, SPCSSAttr *css, gchar const *key);
 202 void sp_repr_css_merge(SPCSSAttr *dst, SPCSSAttr *src);
 203 void sp_repr_css_attr_add_from_string(SPCSSAttr *css, const gchar *data);
 204 void sp_repr_css_change(Inkscape::XML::Node *repr, SPCSSAttr *css, gchar const *key);
 205 void sp_repr_css_change_recursive(Inkscape::XML::Node *repr, SPCSSAttr *css, gchar const *key);
 206
 207 void sp_repr_css_print(SPCSSAttr *css);
 208
 209 /* Utility finctions */
 210 /// Remove \a repr from children of its parent node.
 211 inline void sp_repr_unparent(Inkscape::XML::Node *repr) {
 212     Inkscape::XML::Node *parent=repr->parent();
 213     if (parent) {
 214         parent->removeChild(repr);
 215     }
 216 }
 217
 218 /* Convenience */
 219 unsigned sp_repr_get_boolean(Inkscape::XML::Node *repr, gchar const *key, unsigned *val);
 220 unsigned sp_repr_get_int(Inkscape::XML::Node *repr, gchar const *key, int *val);
 221 unsigned sp_repr_get_double(Inkscape::XML::Node *repr, gchar const *key, double *val);
 222 unsigned sp_repr_set_boolean(Inkscape::XML::Node *repr, gchar const *key, unsigned val);
 223 unsigned sp_repr_set_int(Inkscape::XML::Node *repr, gchar const *key, int val);
 224 unsigned sp_repr_set_css_double(Inkscape::XML::Node *repr, gchar const *key, double val);
 225 unsigned sp_repr_set_svg_double(Inkscape::XML::Node *repr, gchar const *key, double val);
 226
 227 /// \deprecated !
 228 double sp_repr_get_double_attribute(Inkscape::XML::Node *repr, gchar const *key, double def);
 229 /// \deprecated !
 230 int sp_repr_get_int_attribute(Inkscape::XML::Node *repr, gchar const *key, int def);
 231 /* End Deprecated? */
 232
 233 int sp_repr_compare_position(Inkscape::XML::Node *first, Inkscape::XML::Node *second);
 234
 235 /* Searching */
 236 Inkscape::XML::Node *sp_repr_lookup_name(Inkscape::XML::Node *repr,
 237                                          gchar const *name,
 238                                          gint maxdepth = -1);
 239 Inkscape::XML::Node *sp_repr_lookup_child(Inkscape::XML::Node *repr,
 240                                           gchar const *key,
 241                                           gchar const *value);
 242
 243
 244 Inkscape::XML::Document *sp_repr_document_new_list(GSList *reprs);
 245
 246 inline Inkscape::XML::Node *sp_repr_document_first_child(Inkscape::XML::Document const *doc) {
 247     return const_cast<Inkscape::XML::Node *>(doc->firstChild());
 248 }
 249
 250 #endif
 251
 252
 253 /*
 254   Local Variables:
 255   mode:c++
 256   c-file-style:"stroustrup"
 257   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 258   indent-tabs-mode:nil
 259   fill-column:99
 260   End:
 261 */
 262 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :