libdom
Loading...
Searching...
No Matches
Macros | Functions
document_type.h File Reference
#include <dom/core/document_type.h>

Go to the source code of this file.

Macros

#define DOM_DOCUMENT_TYPE_VTABLE
 
#define DOM_NODE_VTABLE_DOCUMENT_TYPE
 
#define DOM_DT_PROTECT_VTABLE
 

Functions

dom_exception _dom_document_type_create (dom_string *qname, dom_string *public_id, dom_string *system_id, dom_document_type **doctype)
 
void _dom_document_type_destroy (dom_node_internal *doctypenode)
 
dom_exception _dom_document_type_initialise (dom_document_type *doctype, dom_string *qname, dom_string *public_id, dom_string *system_id)
 
void _dom_document_type_finalise (dom_document_type *doctype)
 
dom_exception _dom_document_type_get_name (dom_document_type *doc_type, dom_string **result)
 
dom_exception _dom_document_type_get_entities (dom_document_type *doc_type, struct dom_namednodemap **result)
 
dom_exception _dom_document_type_get_notations (dom_document_type *doc_type, struct dom_namednodemap **result)
 
dom_exception _dom_document_type_get_public_id (dom_document_type *doc_type, dom_string **result)
 
dom_exception _dom_document_type_get_system_id (dom_document_type *doc_type, dom_string **result)
 
dom_exception _dom_document_type_get_internal_subset (dom_document_type *doc_type, dom_string **result)
 
dom_exception _dom_document_type_get_text_content (dom_node_internal *node, dom_string **result)
 
dom_exception _dom_document_type_set_text_content (dom_node_internal *node, dom_string *content)
 
void _dom_dt_destroy (dom_node_internal *node)
 
dom_exception _dom_dt_copy (dom_node_internal *old, dom_node_internal **copy)
 

Macro Definition Documentation

◆ DOM_DOCUMENT_TYPE_VTABLE

#define DOM_DOCUMENT_TYPE_VTABLE
Value:
dom_exception _dom_document_type_get_system_id(dom_document_type *doc_type, dom_string **result)
Definition document_type.c:270
dom_exception _dom_document_type_get_entities(dom_document_type *doc_type, struct dom_namednodemap **result)
Definition document_type.c:202
dom_exception _dom_document_type_get_public_id(dom_document_type *doc_type, dom_string **result)
Definition document_type.c:247
dom_exception _dom_document_type_get_name(dom_document_type *doc_type, dom_string **result)
Definition document_type.c:182
dom_exception _dom_document_type_get_notations(dom_document_type *doc_type, struct dom_namednodemap **result)
Definition document_type.c:226
dom_exception _dom_document_type_get_internal_subset(dom_document_type *doc_type, dom_string **result)
Definition document_type.c:296

◆ DOM_DT_PROTECT_VTABLE

#define DOM_DT_PROTECT_VTABLE
Value:
void _dom_dt_destroy(dom_node_internal *node)
Definition document_type.c:330
dom_exception _dom_dt_copy(dom_node_internal *old, dom_node_internal **copy)
Definition document_type.c:336

◆ DOM_NODE_VTABLE_DOCUMENT_TYPE

#define DOM_NODE_VTABLE_DOCUMENT_TYPE

Function Documentation

◆ _dom_document_type_create()

dom_exception _dom_document_type_create ( dom_string * qname,
dom_string * public_id,
dom_string * system_id,
dom_document_type ** doctype )

Create a document type node

Parameters
qnameThe qualified name of the document type
public_idThe external subset public identifier
system_idThe external subset system identifier
allocMemory (de)allocation function
pwPointer to client-specific private data
doctypePointer to location to receive result
Returns
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_document_type_destroy()

void _dom_document_type_destroy ( dom_node_internal * doctypenode)

Destroy a DocumentType node

Parameters
doctypeThe DocumentType node to destroy

The contents of ::doctype will be destroyed and ::doctype will be freed.

◆ _dom_document_type_finalise()

void _dom_document_type_finalise ( dom_document_type * doctype)

◆ _dom_document_type_get_entities()

dom_exception _dom_document_type_get_entities ( dom_document_type * doc_type,
dom_namednodemap ** result )

Retrieve a document type's entities

Parameters
doc_typeDocument type to retrieve entities from
resultPointer to location to receive result
Returns
DOM_NO_ERR.

The returned map will have its reference count increased. It is the responsibility of the caller to unref the map once it has finished with it.

We don't support this API now, so this function call should always return DOM_NOT_SUPPORTED_ERR.

◆ _dom_document_type_get_internal_subset()

dom_exception _dom_document_type_get_internal_subset ( dom_document_type * doc_type,
dom_string ** result )

Retrieve a document type's internal subset

Parameters
doc_typeDocument type to retrieve internal subset from
resultPointer to location to receive result
Returns
DOM_NO_ERR.

The returned string will have its reference count increased. It is the responsibility of the caller to unref the string once it has finished with it.

We don't support this API now, so this function call should always return DOM_NOT_SUPPORTED_ERR.

◆ _dom_document_type_get_name()

dom_exception _dom_document_type_get_name ( dom_document_type * doc_type,
dom_string ** result )

Retrieve a document type's name

Parameters
doc_typeDocument type to retrieve name from
resultPointer to location to receive result
Returns
DOM_NO_ERR.

The returned string will have its reference count increased. It is the responsibility of the caller to unref the string once it has finished with it.

We don't support this API now, so this function call should always return DOM_NOT_SUPPORTED_ERR.

◆ _dom_document_type_get_notations()

dom_exception _dom_document_type_get_notations ( dom_document_type * doc_type,
dom_namednodemap ** result )

Retrieve a document type's notations

Parameters
doc_typeDocument type to retrieve notations from
resultPointer to location to receive result
Returns
DOM_NO_ERR.

The returned map will have its reference count increased. It is the responsibility of the caller to unref the map once it has finished with it.

We don't support this API now, so this function call should always return DOM_NOT_SUPPORTED_ERR.

◆ _dom_document_type_get_public_id()

dom_exception _dom_document_type_get_public_id ( dom_document_type * doc_type,
dom_string ** result )

Retrieve a document type's public id

Parameters
doc_typeDocument type to retrieve public id from
resultPointer to location to receive result
Returns
DOM_NO_ERR.

The returned string will have its reference count increased. It is the responsibility of the caller to unref the string once it has finished with it.

◆ _dom_document_type_get_system_id()

dom_exception _dom_document_type_get_system_id ( dom_document_type * doc_type,
dom_string ** result )

Retrieve a document type's system id

Parameters
doc_typeDocument type to retrieve system id from
resultPointer to location to receive result
Returns
DOM_NO_ERR.

The returned string will have its reference count increased. It is the responsibility of the caller to unref the string once it has finished with it.

◆ _dom_document_type_get_text_content()

dom_exception _dom_document_type_get_text_content ( dom_node_internal * node,
dom_string ** result )

◆ _dom_document_type_initialise()

dom_exception _dom_document_type_initialise ( dom_document_type * doctype,
dom_string * qname,
dom_string * public_id,
dom_string * system_id )

◆ _dom_document_type_set_text_content()

dom_exception _dom_document_type_set_text_content ( dom_node_internal * node,
dom_string * content )

◆ _dom_dt_copy()

dom_exception _dom_dt_copy ( dom_node_internal * old,
dom_node_internal ** copy )

◆ _dom_dt_destroy()

void _dom_dt_destroy ( dom_node_internal * node)