![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 840c7e4)
raw | patch | inline | side by side (parent: 840c7e4)
| author | ishmal <ishmal@users.sourceforge.net> | |
| Wed, 23 Apr 2008 15:52:00 +0000 (15:52 +0000) | ||
| committer | ishmal <ishmal@users.sourceforge.net> | |
| Wed, 23 Apr 2008 15:52:00 +0000 (15:52 +0000) |
| src/dom/dom.h | patch | blob | history | |
| src/dom/domconfig.h | [deleted file] | patch | blob | history |
diff --git a/src/dom/dom.h b/src/dom/dom.h
index f57a19cd32a0faa8f64f2421d77243c30e56a36d..4e55d610fb5c26ac5e13931a4cc1920bf8843c4b 100644 (file)
--- a/src/dom/dom.h
+++ b/src/dom/dom.h
* which are provided for reference. Most important is this one:
*
* http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html
+ *
+ * More thorough explanations of the various classes and their algorithms
+ * can be found there.
+ *
*
* Authors:
* Bob Jamison
*
- * Copyright (C) 2006 Bob Jamison
+ * Copyright (C) 2006-2008 Bob Jamison
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
#include <vector>
-//# include this before the #ifdefs below
-#include "domconfig.h"
+/**
+ * What type of string do we want? Pick one of the following
+ * Then below, select one of the corresponding typedefs?
+ */
-#ifdef DOM_STRING_OWN
-#include "domstring.h"
-#else
-#ifdef DOM_STRING_GLIBMM
#include <glibmm.h>
-#else
-#include <string>
-#endif
-#endif
+//#include <string>
//# Unfortunate hack for a name collision
#ifdef SEVERITY_ERROR
{
-
-#ifdef DOM_STRING_OWN
-#else
-#ifdef DOM_STRING_GLIBMM
+/**
+ * This is the org::w3c::dom::DOMString definition.
+ * Which type do we want?
+ */
typedef Glib::ustring DOMString;
typedef gunichar XMLCh;
-#else
-typedef std::string DOMString;
-typedef unsigned short XMLCh;
-#endif
-#endif
+
+//typedef std::string DOMString;
+//typedef unsigned short XMLCh;
/**
- *
+ * At least 64 bit time stamp value.
*/
typedef unsigned long long DOMTimeStamp;
/**
- *
+ * This is used for storing refs to user-supplied data.
*/
typedef void DOMUserData;
+
/*#########################################################################
## NodePtr
#########################################################################*/
/**
* A simple Smart Pointer class that handles Nodes and all of its
- * descendants
+ * descendants. This is very similar to shared_ptr, but it is customized
+ * to handle our needs.
*/
template<class T> class Ptr
{
/**
- *
+ * This is used for opaque references to arbitrary objects from
+ * the DOM tree.
*/
typedef void DOMObject;
+/**
+ * Forward references. These are needed because of extensive
+ * inter-referencing within the DOM tree.
+ */
class NodeList;
class NamedNodeMap;
class DOMException;
class DOMLocator;
class DOMConfiguration;
+/**
+ * Smart pointer definitions. Most methods that return references to
+ * Nodes of various types, will return one of these smart pointers instead,
+ * to allow refcounting and GC.
+ */
class Node;
typedef Ptr<Node> NodePtr;
class CharacterData;
/*#########################################################################
## DOMException
#########################################################################*/
+
/**
- * This is the only non-interface class
+ * An Exception class. Not an interface, since this is something that
+ * all implementations must support.
*/
class DOMException
{
{}
/**
- *
+ * What type of exception? One of the ExceptionCodes above.
*/
unsigned short code;
/**
- *
+ * Some text describing the context that generated this exception.
*/
DOMString msg;
## DOMStringList
#########################################################################*/
+/**
+ * This holds a list of DOMStrings. This is likely the response to a query,
+ * or the value of an attribute.
+ */
class DOMStringList
{
public:
/**
- *
+ * Get the nth string of the list
*/
virtual DOMString item(unsigned long index)
{
}
/**
- *
+ * How many strings in this list?
*/
virtual unsigned long getLength()
{
}
/**
- *
+ * Is the argument string present in this list? Lexically, not identically.
*/
virtual bool contains(const DOMString &str)
{
/*#########################################################################
## NameList
#########################################################################*/
-class NamePair
-{
-public:
- NamePair(const DOMString &theNamespaceURI, const DOMString &theName)
- {
- namespaceURI = theNamespaceURI;
- name = theName;
- }
- NamePair(const NamePair &other)
- {
- namespaceURI = other.namespaceURI;
- name = other.name;
- }
- NamePair &operator=(const NamePair &other)
- {
- namespaceURI = other.namespaceURI;
- name = other.name;
- return *this;
- }
- virtual ~NamePair() {}
-
- DOMString namespaceURI;
- DOMString name;
-};
-
+/**
+ * Constains a list of namespaced names.
+ */
class NameList
{
+private:
+
+ class NamePair
+ {
+ public:
+ NamePair(const DOMString &theNamespaceURI, const DOMString &theName)
+ {
+ namespaceURI = theNamespaceURI;
+ name = theName;
+ }
+ NamePair(const NamePair &other)
+ {
+ namespaceURI = other.namespaceURI;
+ name = other.name;
+ }
+ NamePair &operator=(const NamePair &other)
+ {
+ namespaceURI = other.namespaceURI;
+ name = other.name;
+ return *this;
+ }
+ virtual ~NamePair() {}
+
+ DOMString namespaceURI;
+ DOMString name;
+ };
+
public:
/**
- *
+ * Returns a name at the given index. If out of range, return -1.
*/
virtual DOMString getName(unsigned long index)
{
}
/**
- *
+ * Returns a namespace at the given index. If out of range, return -1.
*/
virtual DOMString getNamespaceURI(unsigned long index)
{
}
/**
- *
+ * Return the number of entries in this list.
*/
virtual unsigned long getLength()
{
}
/**
- *
+ * Return whether the name argument is present in the list.
+ * This is done lexically, not identically.
*/
virtual bool contains(const DOMString &name)
{
}
/**
- *
+ * Return whether the namespaced name argument is present in the list.
+ * This is done lexically, not identically.
*/
virtual bool containsNS(const DOMString namespaceURI,const DOMString &name)
{
*
*/
virtual ~NameList() {}
+
+
protected:
std::vector<NamePair> namePairs;
## DOMImplementationList
#########################################################################*/
+/**
+ * Contains a list of DOMImplementations, with accessors.
+ */
class DOMImplementationList
{
public:
/**
- *
+ * Return a DOMImplementation at the given index. If
+ * out of range, return NULL.
*/
virtual DOMImplementation *item(unsigned long index)
{
}
/**
- *
+ * Return the number of DOMImplementations in this list.
*/
virtual unsigned long getLength()
{
}
-
-
//##################
//# Non-API methods
//##################
## DOMImplementationSource
#########################################################################*/
+/**
+ * This is usually the first item to be called when creating a Document.
+ * You will either find one DOMImplementation with a given set of features,
+ * or return a list that match. Using "" will get any implementation
+ * available.
+ */
class DOMImplementationSource
{
public:
/**
- *
+ * Return the first DOMImplementation with the given set of features.
+ * Use "" to fetch any implementation.
*/
virtual DOMImplementation *getDOMImplementation(const DOMString &features) = 0;
/**
- *
+ * Return a list of DOMImplementations with the given set of features.
+ * Use "" to fetch any implementation.
*/
virtual DOMImplementationList getDOMImplementationList(const DOMString &features) = 0;
/*#########################################################################
## DOMImplementation
#########################################################################*/
+
/**
- *
+ * This is the class that actually creates a Document.
*/
class DOMImplementation
{
public:
+
/**
- *
+ * Determine if this implementation has the given feature and version.
*/
virtual bool hasFeature(const DOMString& feature, const DOMString& version) = 0;
/**
- *
+ * Create a document type to be used in creating documents.
*/
virtual DocumentTypePtr createDocumentType(
const DOMString& qualifiedName,
throw(DOMException) = 0;
/**
- *
+ * Create a DOM document.
*/
virtual DocumentPtr createDocument(const DOMString& namespaceURI,
const DOMString& qualifiedName,
DocumentTypePtr doctype)
throw(DOMException) = 0;
/**
- *
+ * Return the thing which is the feature of this implementation. Since
+ * this is a "one size fits all" call, you will need to typecast the
+ * result to the expected type.
*/
virtual DOMObject *getFeature(const DOMString& feature,
const DOMString& version) = 0;
{
public:
+ /**
+ * Which of the DOM Core node types is this node?
+ */
typedef enum
{
ELEMENT_NODE = 1,
} NodeType;
/**
- *
+ * Return the name of this node.
*/
virtual DOMString getNodeName() = 0;
/**
- *
+ * Return the value of this node. The interpretation of the
+ * value is type-specific.
*/
virtual DOMString getNodeValue() throw (DOMException) = 0;
/**
- *
+ * Set the value of this node. The interpretation of the
+ * value is type-specific.
*/
virtual void setNodeValue(const DOMString& val) throw (DOMException) = 0;
/**
- *
+ * Return the type of this Node. One of the NodeType values above.
*/
virtual unsigned short getNodeType() = 0;
/**
- *
+ * Return the parent which references this node as a child in the DOM
+ * tree. Return NULL if there is none.
*/
virtual NodePtr getParentNode() = 0;
/**
- *
+ * Return a list of the children of this Node.
+ * NOTE: the spec expects this to be a "live" list that always
+ * reflects an accurate list of what the Node current possesses, not
+ * a snapshot. How do we do this?
*/
virtual NodeList getChildNodes() = 0;
#########################################################################*/
/**
- *
+ * Contains a list of Nodes. This is the standard API container for Nodes,
+ * and is used in lieu of other lists, arrays, etc, in order to provide
+ * a consistent API and algorithm.
*/
class NodeList
{
public:
+
/**
- *
+ * Retrieve the Node at the given index. Return NULL
+ * if out of range.
*/
virtual NodePtr item(unsigned long index)
{
diff --git a/src/dom/domconfig.h b/src/dom/domconfig.h
--- a/src/dom/domconfig.h
+++ /dev/null
@@ -1,50 +0,0 @@
-#ifndef __DOMCONFIG_H__
-#define __DOMCONFIG_H__
-/**
- * Phoebe DOM Implementation.
- *
- * This is a C++ approximation of the W3C DOM model, which follows
- * fairly closely the specifications in the various .idl files, copies of
- * which are provided for reference. Most important is this one:
- *
- * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html
- *
- * Authors:
- * Bob Jamison
- *
- * Copyright (C) 2006 Bob Jamison
- *
- * rwjj@earthlink.net
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
- */
-
-/**
- * What kind of implementation of DOMString and XMLCh do we want?
- * Define one of the two below for either our own implementation,
- * or GlibMM's Glib::ustring. If neither one is defined, then DOMString
- * is defined as stdc++'s std::string.
- */
-#define DOM_STRING_GLIBMM
-//#define DOM_STRING_OWN
-
-
-
-#endif /* __DOMCONFIG_H__ */
-/*#########################################################################
-## E N D O F F I L E
-#########################################################################*/
-
-