Author: jmb Date: Wed Sep 19 23:06:26 2007 New Revision: 3551 URL: http://source.netsurf-browser.org?rev=3551&view=rev Log: Begin implementation of DocumentType class Remove dom_document_set_doctype() -- dom_node_insert_before() (and thus _append_child()) can be used to achieve the same effect. DocumentType node is now a child of the Document node (as it should have been) rather than a hidden field. Make dom_node_destroy() aware of DocumentType nodes potentially having no owner. Make dom_node_finalise() aware of it, too. Make dom_node_get_owner_document() return NULL for Document nodes, as per the spec. Fix bug in dom_node_insert_before() -- previously it failed to catch attempts to insert a second root element. Make dom_node_insert_before() handle DocumentType nodes appropriately. Implement XML binding's dom_implementation_create_document_type() function. Fix XML binding's dom_implementation_create_document() implementation to cope with changed API relating to doctype insertion. Fix up XML parser wrapper to cater for new doctype insertion mechanism. Also sprinkle some NULL about for paranoia purposes. Added: trunk/dom/src/core/document_type.h Modified: trunk/dom/bindings/xml/xmlbinding.c trunk/dom/bindings/xml/xmlparser.c trunk/dom/include/dom/bootstrap/implpriv.h trunk/dom/src/core/document.c trunk/dom/src/core/document_type.c trunk/dom/src/core/node.c Modified: trunk/dom/bindings/xml/xmlbinding.c URL: http://source.netsurf-browser.org/trunk/dom/bindings/xml/xmlbinding.c?rev... ============================================================================== --- trunk/dom/bindings/xml/xmlbinding.c (original) +++ trunk/dom/bindings/xml/xmlbinding.c Wed Sep 19 23:06:26 2007 @@ -193,11 +193,7 @@ * \param pw Pointer to client-specific private data * \return DOM_NO_ERR on success, * DOM_INVALID_CHARACTER_ERR if ::qname is invalid, - * DOM_NAMESPACE_ERR if ::qname is malformed, - * DOM_NOT_SUPPORTED_ERR if ::impl does not support the - * feature "XML" and the language - * exposed through Document does - * not support XML namespaces. + * DOM_NAMESPACE_ERR if ::qname is malformed. * * Any memory allocated by this call should be allocated using * the provided memory (de)allocation function. @@ -214,15 +210,23 @@ struct dom_document_type **doctype, dom_alloc alloc, void *pw) { + struct dom_document_type *d; + dom_exception err; + + /* We have no use for the impl -- we only have one */ UNUSED(impl); - UNUSED(qname); - UNUSED(public_id); - UNUSED(system_id); - UNUSED(doctype); - UNUSED(alloc); - UNUSED(pw); - - return DOM_NOT_SUPPORTED_ERR; + + /** \todo validate qname */ + + /* Create the doctype */ + err = dom_document_type_create(qname, public_id, system_id, + alloc, pw, &d); + if (err != DOM_NO_ERR) + return err; + + *doctype = d; + + return DOM_NO_ERR; } /** @@ -281,11 +285,18 @@ /* Set its doctype, if necessary */ if (doctype != NULL) { - err = dom_document_set_doctype(d, doctype); + struct dom_node *ins_doctype = NULL; + + err = dom_node_append_child((struct dom_node *) d, + (struct dom_node *) doctype, &ins_doctype); if (err != DOM_NO_ERR) { dom_node_unref((struct dom_node *) d); return err; } + + /* Not interested in inserted doctype */ + if (ins_doctype != NULL) + dom_node_unref(ins_doctype); } /* Create root element and attach it to document */ Modified: trunk/dom/bindings/xml/xmlparser.c URL: http://source.netsurf-browser.org/trunk/dom/bindings/xml/xmlparser.c?rev=... ============================================================================== --- trunk/dom/bindings/xml/xmlparser.c (original) +++ trunk/dom/bindings/xml/xmlparser.c Wed Sep 19 23:06:26 2007 @@ -637,7 +637,7 @@ void xml_parser_add_element_node(xml_parser *parser, struct dom_node *parent, xmlNodePtr child) { - struct dom_element *el, *ins_el; + struct dom_element *el, *ins_el = NULL; xmlAttrPtr a; dom_exception err; @@ -896,7 +896,7 @@ void xml_parser_add_text_node(xml_parser *parser, struct dom_node *parent, xmlNodePtr child) { - struct dom_text *text, *ins_text; + struct dom_text *text, *ins_text = NULL; struct dom_string *data; dom_exception err; @@ -957,7 +957,7 @@ void xml_parser_add_cdata_section(xml_parser *parser, struct dom_node *parent, xmlNodePtr child) { - struct dom_cdata_section *cdata, *ins_cdata; + struct dom_cdata_section *cdata, *ins_cdata = NULL; struct dom_string *data; dom_exception err; @@ -1018,7 +1018,7 @@ void xml_parser_add_entity_reference(xml_parser *parser, struct dom_node *parent, xmlNodePtr child) { - struct dom_entity_reference *entity, *ins_entity; + struct dom_entity_reference *entity, *ins_entity = NULL; struct dom_string *name; xmlNodePtr c; dom_exception err; @@ -1086,7 +1086,7 @@ void xml_parser_add_comment(xml_parser *parser, struct dom_node *parent, xmlNodePtr child) { - struct dom_comment *comment, *ins_comment; + struct dom_comment *comment, *ins_comment = NULL; struct dom_string *data; dom_exception err; @@ -1148,7 +1148,7 @@ struct dom_node *parent, xmlNodePtr child) { xmlDtdPtr dtd = (xmlDtdPtr) child; - struct dom_document_type *doctype; + struct dom_document_type *doctype, *ins_doctype = NULL; struct dom_string *qname, *public_id, *system_id; dom_exception err; @@ -1207,14 +1207,18 @@ dom_string_unref(qname); /* Add doctype to document */ - err = dom_document_set_doctype((struct dom_document *) parent, - doctype); + err = dom_node_append_child(parent, (struct dom_node *) doctype, + (struct dom_node **) &ins_doctype); if (err != DOM_NO_ERR) { dom_node_unref((struct dom_node *) doctype); parser->msg(XML_MSG_CRITICAL, parser->mctx, "Failed attaching doctype"); return; } + + /* Not interested in inserted node */ + if (ins_doctype != NULL) + dom_node_unref((struct dom_node *) ins_doctype); /* Link nodes together */ err = xml_parser_link_nodes(parser, (struct dom_node *) doctype, Modified: trunk/dom/include/dom/bootstrap/implpriv.h URL: http://source.netsurf-browser.org/trunk/dom/include/dom/bootstrap/implpri... ============================================================================== --- trunk/dom/include/dom/bootstrap/implpriv.h (original) +++ trunk/dom/include/dom/bootstrap/implpriv.h Wed Sep 19 23:06:26 2007 @@ -14,6 +14,9 @@ * * The Document implementation includes this as it needs the declaration of * dom_document_create and dom_document_set_doctype. + * + * The DocumentType implementation includes this as it needs the declaration + * of dom_document_type_create. * * No other client should be including this. */ @@ -248,8 +251,11 @@ dom_exception dom_document_create(struct dom_implementation *impl, dom_alloc alloc, void *pw, struct dom_document **doc); -/* Set a Document's DocumentType */ -dom_exception dom_document_set_doctype(struct dom_document *doc, - struct dom_document_type *doctype); +/* Create a DOM document type */ +dom_exception dom_document_type_create(struct dom_string *qname, + struct dom_string *public_id, + struct dom_string *system_id, + dom_alloc alloc, void *pw, + struct dom_document_type **doctype); #endif Modified: trunk/dom/src/core/document.c URL: http://source.netsurf-browser.org/trunk/dom/src/core/document.c?rev=3551&... ============================================================================== --- trunk/dom/src/core/document.c (original) +++ trunk/dom/src/core/document.c Wed Sep 19 23:06:26 2007 @@ -54,8 +54,6 @@ */ struct dom_document { struct dom_node base; /**< Base node */ - - struct dom_document_type *type; /**< Associated doctype */ struct dom_implementation *impl; /**< Owning implementation */ @@ -157,8 +155,6 @@ } /* Initialise remaining type-specific data */ - d->type = NULL; - if (impl != NULL) dom_implementation_ref(impl); d->impl = impl; @@ -210,15 +206,6 @@ /* Ok, the document tree is empty, as is the list of nodes pending * deletion. Therefore, it is safe to destroy the document. */ - - /* Destroy the doctype (if there is one) */ - if (doc->type != NULL) { - ((struct dom_node *) doc->type)->parent = NULL; - - dom_node_destroy((struct dom_node *) doc->type); - } - - doc->type = NULL; if (doc->impl != NULL) dom_implementation_unref(doc->impl); @@ -258,10 +245,17 @@ dom_exception dom_document_get_doctype(struct dom_document *doc, struct dom_document_type **result) { - if (doc->type != NULL) - dom_node_ref((struct dom_node *) doc->type); - - *result = doc->type; + struct dom_node *c; + + for (c = doc->base.first_child; c != NULL; c = c->next) { + if (c->type == DOM_DOCUMENT_TYPE_NODE) + break; + } + + if (c != NULL) + dom_node_ref(c); + + *result = (struct dom_document_type *) c; return DOM_NO_ERR; } @@ -941,31 +935,6 @@ /* */ /** - * Set a Document's Document Type - * - * \param doc Document to set type of - * \param doctype The doctype to apply - * \return DOM_NO_ERR on success, - * DOM_INVALID_MODIFICATION_ERR if ::doc already has a doctype. - * - * The doctype will have its reference count increased. It is the - * responsibility of the caller to unref the doctype once it has finished - * with it. - */ -dom_exception dom_document_set_doctype(struct dom_document *doc, - struct dom_document_type *doctype) -{ - UNUSED(doc); - UNUSED(doctype); - - return DOM_NOT_SUPPORTED_ERR; -} - -/* */ -/* ----------------------------------------------------------------------- */ -/* */ - -/** * Acquire a pointer to the base of the document buffer * * \param doc Document to retrieve pointer from Modified: trunk/dom/src/core/document_type.c URL: http://source.netsurf-browser.org/trunk/dom/src/core/document_type.c?rev=... ============================================================================== --- trunk/dom/src/core/document_type.c (original) +++ trunk/dom/src/core/document_type.c Wed Sep 19 23:06:26 2007 @@ -7,7 +7,10 @@ */ #include <dom/core/document_type.h> - +#include <dom/core/string.h> +#include <dom/bootstrap/implpriv.h> + +#include "core/document_type.h" #include "core/node.h" #include "utils/utils.h" @@ -18,7 +21,83 @@ struct dom_node base; /**< Base node */ /** \todo other members */ + struct dom_string *public_id; /**< Doctype public ID */ + struct dom_string *system_id; /**< Doctype system ID */ + + dom_alloc alloc; /**< Memory (de)allocation function */ + void *pw; /**< Pointer to private data */ }; + +/** + * Create a document type node + * + * \param qname The qualified name of the document type + * \param public_id The external subset public identifier + * \param system_id The external subset system identifier + * \param alloc Memory (de)allocation function + * \param pw Pointer to client-specific private data + * \param doctype Pointer to location to receive result + * \return DOM_NO_ERR on success, DOM_NO_MEM_ERR on memory exhaustion. + * + * The doctype will be referenced, so the client need not do so + * explicitly. The client must unref the doctype once it has + * finished with it. + */ +dom_exception dom_document_type_create(struct dom_string *qname, + struct dom_string *public_id, struct dom_string *system_id, + dom_alloc alloc, void *pw, struct dom_document_type **doctype) +{ + struct dom_document_type *result; + dom_exception err; + + /* Create node */ + result = alloc(NULL, sizeof(struct dom_document_type), pw); + if (result == NULL) + return DOM_NO_MEM_ERR; + + /* Initialise base node */ + err = dom_node_initialise(&result->base, NULL, DOM_DOCUMENT_TYPE_NODE, + qname, NULL); + if (err != DOM_NO_ERR) { + alloc(result, 0, pw); + return err; + } + + /* Get public and system IDs */ + dom_string_ref(public_id); + result->public_id = public_id; + + dom_string_ref(system_id); + result->system_id = system_id; + + /* Fill in allocation information */ + result->alloc = alloc; + result->pw = pw; + + *doctype = result; + + return DOM_NO_ERR; +} + +/** + * Destroy a DocumentType node + * + * \param doctype The DocumentType node to destroy + * + * The contents of ::doctype will be destroyed and ::doctype will be freed. + */ +void dom_document_type_destroy(struct dom_document_type *doctype) +{ + /* Finish with public and system IDs */ + dom_string_unref(doctype->system_id); + dom_string_unref(doctype->public_id); + + /* Finalise base class */ + dom_node_finalise(doctype->base.owner, &doctype->base); + + /* Free doctype */ + doctype->alloc(doctype, 0, doctype->pw); +} /** * Retrieve a document type's name Added: trunk/dom/src/core/document_type.h URL: http://source.netsurf-browser.org/trunk/dom/src/core/document_type.h?rev=... ============================================================================== --- trunk/dom/src/core/document_type.h (added) +++ trunk/dom/src/core/document_type.h Wed Sep 19 23:06:26 2007 @@ -1,0 +1,17 @@ +/* + * This file is part of libdom. + * Licensed under the MIT License, + * http://www.opensource.org/licenses/mit-license.php + * Copyright 2007 John-Mark Bell <jmb(a)netsurf-browser.org&gt; + */ + +#ifndef dom_internal_core_document_type_h_ +#define dom_internal_core_document_type_h_ + +struct dom_document_type; + +/* Destroy a document type */ +void dom_document_type_destroy(struct dom_document_type *doctype); + +#endif + Modified: trunk/dom/src/core/node.c URL: http://source.netsurf-browser.org/trunk/dom/src/core/node.c?rev=3551&... ============================================================================== --- trunk/dom/src/core/node.c (original) +++ trunk/dom/src/core/node.c Wed Sep 19 23:06:26 2007 @@ -14,6 +14,7 @@ #include "core/cdatasection.h" #include "core/comment.h" #include "core/document.h" +#include "core/document_type.h" #include "core/doc_fragment.h" #include "core/element.h" #include "core/entity_ref.h" @@ -39,14 +40,15 @@ void dom_node_destroy(struct dom_node *node) { struct dom_document *owner = node->owner; - bool document_node = (node->type == DOM_DOCUMENT_NODE); + bool null_owner_permitted = (node->type == DOM_DOCUMENT_NODE || + node->type == DOM_DOCUMENT_TYPE_NODE); /* This function simply acts as a central despatcher * for type-specific destructors. */ - assert(owner != NULL); - - if (!document_node) { + assert(null_owner_permitted || owner != NULL); + + if (!null_owner_permitted) { /* Claim a reference upon the owning document during * destruction to ensure that the document doesn't get * destroyed before its contents. */ @@ -85,7 +87,7 @@ dom_document_destroy((struct dom_document *) node); break; case DOM_DOCUMENT_TYPE_NODE: - /** \todo document type node */ + dom_document_type_destroy((struct dom_document_type *) node); break; case DOM_DOCUMENT_FRAGMENT_NODE: dom_document_fragment_destroy(owner, @@ -96,7 +98,7 @@ break; } - if (!document_node) { + if (!null_owner_permitted) { /* Release the reference we claimed on the document. If this * is the last reference held on the document and the list * of nodes pending deletion is empty, then the document will @@ -173,7 +175,7 @@ /** * Finalise a DOM node * - * \param doc The owning document + * \param doc The owning document (or NULL if it's a standalone DocumentType) * \param node The node to finalise * * The contents of ::node will be cleaned up. ::node will not be freed. @@ -182,6 +184,10 @@ void dom_node_finalise(struct dom_document *doc, struct dom_node *node) { struct dom_user_data *u, *v; + + /* Standalone DocumentType nodes may not have user data attached */ + assert(node->type != DOM_DOCUMENT_TYPE_NODE || + node->user_data == NULL); /* Destroy user data */ for (u = node->user_data; u != NULL; u = v) { @@ -493,6 +499,15 @@ dom_exception dom_node_get_owner_document(struct dom_node *node, struct dom_document **result) { + /* Document nodes have no owner, as far as clients are concerned + * In reality, they own themselves as this simplifies code elsewhere + */ + if (node->type == DOM_DOCUMENT_NODE) { + *result = NULL; + + return DOM_NO_ERR; + } + /* If there is an owner, increase its reference count */ if (node->owner != NULL) dom_node_ref((struct dom_node *) node->owner); @@ -522,14 +537,12 @@ * DOM_NO_MODIFICATION_ALLOWED_ERR if ::node is readonly, or * ::new_child's parent is readonly, * DOM_NOT_FOUND_ERR if ::ref_child is not a child of - * ::node, - * DOM_NOT_SUPPORTED_ERR if ::node is of type Document and - * ::new_child is of type DocumentType. + * ::node. * * If ::new_child is a DocumentFragment, all of its children are inserted. * If ::new_child is already in the tree, it is first removed. * - * Attempting to insert a node before itself is a NOP + * Attempting to insert a node before itself is a NOP. * * ::new_child's reference count will be increased. The caller should unref * it (as they should already have held a reference on the node) @@ -539,7 +552,11 @@ struct dom_node **result) { /* Ensure that new_child and node are owned by the same document */ - if (new_child->owner != node->owner) + if ((new_child->type == DOM_DOCUMENT_TYPE_NODE && + new_child->owner != NULL && + new_child->owner != node->owner) || + (new_child->type != DOM_DOCUMENT_TYPE_NODE && + new_child->owner != node->owner)) return DOM_WRONG_DOCUMENT_ERR; /** \todo ensure ::node may be written to */ @@ -547,12 +564,6 @@ /* Ensure that ref_child (if any) is a child of node */ if (ref_child != NULL && ref_child->parent != node) return DOM_NOT_FOUND_ERR; - - /* We don't support addition of DocumentType nodes using this API */ - /** \todo if we did, then we could purge dom_document_set_doctype() */ - if (node->type == DOM_DOCUMENT_NODE && - new_child->type == DOM_DOCUMENT_TYPE_NODE) - return DOM_NOT_SUPPORTED_ERR; /* Ensure that new_child is not an ancestor of node, nor node itself */ for (struct dom_node *n = node; n != NULL; n = n->parent) { @@ -561,7 +572,8 @@ } /* Ensure that the document doesn't already have a root element */ - if (node->type == DOM_DOCUMENT_NODE && node->type == DOM_ELEMENT_NODE) { + if (node->type == DOM_DOCUMENT_NODE && + new_child->type == DOM_ELEMENT_NODE) { for (struct dom_node *n = node->first_child; n != NULL; n = n->next) { if (n->type == DOM_ELEMENT_NODE) @@ -569,7 +581,27 @@ } } + /* Ensure that the document doesn't already have a document type */ + if (node->type == DOM_DOCUMENT_NODE && + new_child->type == DOM_DOCUMENT_TYPE_NODE) { + for (struct dom_node *n = node->first_child; + n != NULL; n = n->next) { + if (n->type == DOM_DOCUMENT_TYPE_NODE) + return DOM_HIERARCHY_REQUEST_ERR; + } + } + /** \todo ensure ::new_child is permitted as a child of ::node */ + + /* DocumentType nodes are created outside the Document so, + * if we're trying to attach a DocumentType node, then we + * also need to set its owner. */ + if (node->type == DOM_DOCUMENT_NODE && + new_child->type == DOM_DOCUMENT_TYPE_NODE) { + /* See long comment in dom_node_initialise as to why + * we don't ref the document here */ + new_child->owner = (struct dom_document *) node; + } /* Attempting to insert a node before itself is a NOP */ if (new_child == ref_child) { @@ -761,10 +793,7 @@ * DOM_WRONG_DOCUMENT_ERR if ::new_child was created from a * different document than ::node, * DOM_NO_MODIFICATION_ALLOWED_ERR if ::node is readonly, or - * ::new_child's parent is readonly, - * DOM_NOT_SUPPORTED_ERR if ::node is of type Document and - * ::new_child is of type - * DocumentType or Element. + * ::new_child's parent is readonly. * * If ::new_child is a DocumentFragment, all of its children are inserted. * If ::new_child is already in the tree, it is first removed.