src/xml/node.h

   1 /*
   2  * Node - interface for XML nodes
   3  *
   4  * Copyright 2005 MenTaLguY <mental@rydia.net>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * See the file COPYING for details.
  12  *
  13  */
  14
  15 #ifndef SEEN_INKSCAPE_XML_NODE_H
  16 #define SEEN_INKSCAPE_XML_NODE_H
  17
  18 #include <glib/gtypes.h>
  19 #include "gc-anchored.h"
  20 #include "util/list.h"
  21
  22 namespace Inkscape {
  23 namespace XML {
  24
  25 class AttributeRecord;
  26 class Document;
  27 class NodeEventVector;
  28 class NodeObserver;
  29
  30 enum NodeType {
  31     DOCUMENT_NODE,
  32     ELEMENT_NODE,
  33     TEXT_NODE,
  34     COMMENT_NODE
  35 };
  36
  37 // careful; GC::Anchored should only appear once in the inheritance
  38 // hierarcy; else there will be leaks
  39 class Node : public Inkscape::GC::Anchored {
  40 public:
  41     Node() {}
  42
  43     virtual ~Node() {}
  44
  45     virtual NodeType type() const=0;
  46
  47     virtual gchar const *name() const=0;
  48     virtual int code() const=0;
  49     virtual void setCodeUnsafe(int code)=0;
  50
  51     virtual Document *document()=0;
  52     virtual Document const *document() const=0;
  53
  54     virtual Node *duplicate(Document *doc) const=0;
  55
  56     virtual Node *root()=0;
  57     virtual Node const *root() const=0;
  58
  59     virtual Node *parent()=0;
  60     virtual Node const *parent() const=0;
  61
  62     virtual Node *next()=0;
  63     virtual Node const *next() const=0;
  64
  65     virtual Node *firstChild()=0;
  66     virtual Node const *firstChild() const=0;
  67     virtual Node *lastChild()=0;
  68     virtual Node const *lastChild() const=0;
  69
  70     virtual unsigned childCount() const=0;
  71     virtual Node *nthChild(unsigned index)=0;
  72     virtual Node const *nthChild(unsigned index) const=0;
  73
  74     virtual void addChild(Node *child, Node *ref)=0;
  75     virtual void appendChild(Node *child)=0;
  76     virtual void removeChild(Node *child)=0;
  77     virtual void changeOrder(Node *child, Node *ref)=0;
  78
  79     virtual unsigned position() const=0;
  80     virtual void setPosition(int pos)=0;
  81
  82     virtual gchar const *attribute(gchar const *key) const=0;
  83     virtual void setAttribute(gchar const *key, gchar const *value, bool is_interactive=false)=0;
  84     virtual bool matchAttributeName(gchar const *partial_name) const=0;
  85
  86     virtual gchar const *content() const=0;
  87     virtual void setContent(gchar const *value)=0;
  88
  89     virtual void mergeFrom(Node const *src, gchar const *key)=0;
  90
  91     virtual Inkscape::Util::List<AttributeRecord const> attributeList() const=0;
  92
  93     virtual void synthesizeEvents(NodeEventVector const *vector, void *data)=0;
  94     virtual void synthesizeEvents(NodeObserver &observer)=0;
  95     virtual void addObserver(NodeObserver &observer)=0;
  96     virtual void addListener(NodeEventVector const *vector, void *data)=0;
  97     virtual void removeObserver(NodeObserver &observer)=0;
  98     virtual void removeListenerByData(void *data)=0;
  99
 100 protected:
 101     Node(Node const &) : Anchored() {}
 102
 103 public: // ideally these should be protected too somehow...
 104     virtual void _setParent(Node *parent)=0;
 105     virtual void _setNext(Node *next)=0;
 106     virtual void _bindDocument(Document &document)=0;
 107
 108     virtual unsigned _childPosition(Node const &child) const=0;
 109     virtual unsigned _cachedPosition() const=0;
 110     virtual void _setCachedPosition(unsigned position) const=0;
 111 };
 112
 113 }
 114 }
 115
 116 #endif
 117 /*
 118   Local Variables:
 119   mode:c++
 120   c-file-style:"stroustrup"
 121   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 122   indent-tabs-mode:nil
 123   fill-column:99
 124   End:
 125 */
 126 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :