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 Session;
  26 class TransactionLogger;
  27 class AttributeRecord;
  28 class Document;
  29 class NodeEventVector;
  30 class NodeObserver;
  31
  32 enum NodeType {
  33     DOCUMENT_NODE,
  34     ELEMENT_NODE,
  35     TEXT_NODE,
  36     COMMENT_NODE
  37 };
  38
  39 // careful; GC::Anchored should only appear once in the inheritance
  40 // hierarcy; else there will be leaks
  41 class Node : public Inkscape::GC::Anchored {
  42 public:
  43     Node() {}
  44
  45     virtual ~Node() {}
  46
  47     virtual NodeType type() const=0;
  48
  49     virtual Session *session()=0;
  50
  51     virtual gchar const *name() const=0;
  52     virtual int code() const=0;
  53     virtual void setCodeUnsafe(int code)=0;
  54
  55     virtual Document *document()=0;
  56     virtual Document const *document() const=0;
  57
  58     virtual Node *duplicate() const=0;
  59
  60     virtual Node *root()=0;
  61     virtual Node const *root() const=0;
  62
  63     virtual Node *parent()=0;
  64     virtual Node const *parent() const=0;
  65
  66     virtual Node *next()=0;
  67     virtual Node const *next() const=0;
  68
  69     virtual Node *firstChild()=0;
  70     virtual Node const *firstChild() const=0;
  71     virtual Node *lastChild()=0;
  72     virtual Node const *lastChild() const=0;
  73
  74     virtual unsigned childCount() const=0;
  75     virtual Node *nthChild(unsigned index)=0;
  76     virtual Node const *nthChild(unsigned index) const=0;
  77
  78     virtual void addChild(Node *child, Node *ref)=0;
  79     virtual void appendChild(Node *child)=0;
  80     virtual void removeChild(Node *child)=0;
  81     virtual void changeOrder(Node *child, Node *ref)=0;
  82
  83     virtual unsigned position() const=0;
  84     virtual void setPosition(int pos)=0;
  85
  86     virtual gchar const *attribute(gchar const *key) const=0;
  87     virtual void setAttribute(gchar const *key, gchar const *value, bool is_interactive=false)=0;
  88     virtual bool matchAttributeName(gchar const *partial_name) const=0;
  89
  90     virtual gchar const *content() const=0;
  91     virtual void setContent(gchar const *value)=0;
  92
  93     virtual void mergeFrom(Node const *src, gchar const *key)=0;
  94
  95     virtual Inkscape::Util::List<AttributeRecord const> attributeList() const=0;
  96
  97     virtual void synthesizeEvents(NodeEventVector const *vector, void *data)=0;
  98     virtual void synthesizeEvents(NodeObserver &observer)=0;
  99     virtual void addObserver(NodeObserver &observer)=0;
 100     virtual void addListener(NodeEventVector const *vector, void *data)=0;
 101     virtual void removeObserver(NodeObserver &observer)=0;
 102     virtual void removeListenerByData(void *data)=0;
 103
 104 protected:
 105     Node(Node const &) : Anchored() {}
 106
 107 public: // ideally these should be protected too somehow...
 108     virtual void _setParent(Node *parent)=0;
 109     virtual void _setNext(Node *next)=0;
 110     virtual void _bindDocument(Document &document)=0;
 111     virtual void _bindLogger(TransactionLogger &logger)=0;
 112
 113     virtual unsigned _childPosition(Node const &child) const=0;
 114     virtual unsigned _cachedPosition() const=0;
 115     virtual void _setCachedPosition(unsigned position) const=0;
 116 };
 117
 118 }
 119 }
 120
 121 #endif
 122 /*
 123   Local Variables:
 124   mode:c++
 125   c-file-style:"stroustrup"
 126   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 127   indent-tabs-mode:nil
 128   fill-column:99
 129   End:
 130 */
 131 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :