domcif.h

upnpsdk-1.0.4.tar.gz Intel UPnP SDK Source

///////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000 Intel Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither name of Intel Corporation nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
///////////////////////////////////////////////////////////////////////////

//	$Revision: 1.1.1.5 $
//	$Date: 2001/06/15 00:22:14 $

/**@name Document Object Level 1 APIs
 * The UPnP SDK for Linux implements part of the Document Object Model
 * Level 1 interface as needed for working with the XML documents required
 * by UPnP.  For those interfaces that are documented in the DOM Level
 * 1 specification, the reader is referred to that document rather than
 * recreating the documentation here.
 *
 * The DOM Level 1 Specification is available from the W3C web site at
 * http://www.w3c.org/TR/1998/REC-DOM-Level-1.
 *
 * Of the interfaces defined in DOM Level 1, the UPnP SDK only implements
 * these interfaces:
 *
 * \begin{itemize}
 *   \item Document: DOM Level 1 specification section 1.2 page 22
 *   \item Element: DOM Level 1 specification section 1.2 page 38
 *   \item NamedNodeMap: DOM Level 1 specification section 1.2 page 32
 *   \item Node: DOM Level 1 specification section 1.2 page 25
 *   \item NodeList: DOM Level 1 specification section 1.2 page 32
 * \end{itemize}
 *
 * {\it Note that all page numbers listed for the DOM Level 1 Specification
 * are relative to the PDF format version dated 1 October 1998.}
 *
 * The prototypes for the methods listed here differ slighly from those
 * in the DOM specification.  The UPnP SDK implements a C-style interface
 * for those methods, requiring the DOM object to be passed as the first
 * parameter.  C++ and other object oriented languages (as the
 * Interface Description Language the interfaces are described in the DOM
 * specification) do not require this.
 */

//@{

#ifndef _domCif_h_
#define _domCif_h_

#ifdef __cplusplus
extern "C"{
#endif

#include "all.h"

#define Upnp_DOMString   char *

#define Upnp_Bool int

#define Upnp_Void   void

#define Upnp_UShort unsigned short

#define Upnp_ULong unsigned long

#define Upnp_DocumentFragment void *

#define Upnp_Node void *

#define Upnp_Document void *

#define Upnp_NodeList void *

#define Upnp_CharacterData void *

#define Upnp_Attr void *

#define Upnp_Element void *

#define Upnp_Text void *

#define Upnp_Comment void *

#define Upnp_CDATASection void *

#define Upnp_ProcessingInstruction void *

#define Upnp_EntityReference void *

#define Upnp_DocumentType void *

#define Upnp_NamedNodeMap void *

#define Upnp_DOMImplementation void *

#define Upnp_Notation void *

#define Upnp_Entity void *

#define Upnp_NodeType NODE_TYPE



typedef enum Upnp_DOMException{ 
	NO_ERR=0, 
	INDEX_SIZE_ERR=1, 
	STRING_SIZE_ERR=2, 
	HIERARCHY_REQUEST_ERR=3, 
	WRONG_DOCUMENT_ERR=4, 
	INVALID_CHARACTER_ERR=5, 
	NO_DATA_ALLOWED_ERR=6, 
	NO_MODIFICATION_ALLOWED_ERR=7, 
	NOT_FOUND_ERR=8, 
	NOT_SUPPORTED_ERR=9, 
	INUSE_ATTRIBUTE_ERR=10
} Upnp_DOMException;

/****************************************************************************/
//Interface Node Implementation
/****************************************************************************/

/** @name Interface Node
 * Refer to the DOM Level 1 specification page 25.
 */

//@{

/** Refer to the DOM Level 1 specification page 29. */
Upnp_Node UpnpNode_insertBefore(
	Upnp_Node OperationNode, 
	Upnp_Node newChild,      
	Upnp_Node refChild,      
	Upnp_DOMException *err  
        );

/** Refer to the DOM Level 1 specification page 30. */
Upnp_Node UpnpNode_replaceChild(
	Upnp_Node OperationNode, 
	Upnp_Node newChild, 
	Upnp_Node oldChild, 
	Upnp_DOMException *err
	);

/** Refer to the DOM Level 1 specification page 30. */
Upnp_Node UpnpNode_removeChild(
	Upnp_Node OperationNode, 
	Upnp_Node oldChild, 
	Upnp_DOMException *err
	);

/** Refer to the DOM Level 1 specification page 30. */
Upnp_Node UpnpNode_appendChild(
	Upnp_Node OperationNode, 
	Upnp_Node newChild, 
	Upnp_DOMException *err
	);

/** Refer to the DOM Level 1 specification page 31. */
Upnp_Bool UpnpNode_hasChildNodes(
	Upnp_Node OperationNode
	);

/** Refer to the DOM Level 1 specification page 31. */
Upnp_Node UpnpNode_cloneNode(
	Upnp_Node OperationNode, 
	Upnp_Bool deep
	);

/** Refer to the {\tt nodeName} attribute in the DOM Level 1 specification 
 * page 28. 
 */
Upnp_DOMString UpnpNode_getNodeName(
	Upnp_Node OperationNode
	);

/** Refer to the {\tt nodeValue} attribute in the DOM Level 1 specification 
 * page 28. 
 */
Upnp_DOMString UpnpNode_getNodeValue(
	Upnp_Node OperationNode, 
	Upnp_DOMException *err
	);

/** Refer to the {\tt nodeValue} attribute in the DOM Level 1 specification 
 * page 28. 
 */
Upnp_Void UpnpNode_setNodeValue(
	Upnp_Node OperationNode, 
	Upnp_DOMString nodeValue, 
	Upnp_DOMException *err
	);

/** Refer to the {\tt nodeType} attribute in the DOM Level 1 specification 
 * page 28. 
 */
Upnp_UShort UpnpNode_getNodeType(
	Upnp_Node OperationNode
	);

/** Refer to the {\tt parentNode} attribute in the DOM Level 1 specification 
 * page 28. 
 */
Upnp_Node UpnpNode_getParentNode(
	Upnp_Node OperationNode
	);

/** Refer to the {\tt childNodes} attribute in the DOM Level 1 specification 
 * page 29. 
 */
Upnp_NodeList UpnpNode_getChildNodes(
	Upnp_Node OperationNode
	);

/** Refer to the {\tt firstChild} attribute in the DOM Level 1 specification 
 * page 29. 
 */
Upnp_Node UpnpNode_getFirstChild(
	Upnp_Node OperationNode
	);

/** Refer to the {\tt lastChild} attribute in the DOM Level 1 specification 
 * page 29. 
 */
Upnp_Node UpnpNode_getLastChild(
	Upnp_Node OperationNode
	);

/** Refer to the {\tt previousSibling} attribute in the DOM Level 1 
 * specification page 29. 
 */
Upnp_Node UpnpNode_getPreviousSibling(
	Upnp_Node OperationNode
	);

/** Refer to the {\tt nextSibling} attribute in the DOM Level 1 
 * specification page 29. 
 */
Upnp_Node UpnpNode_getNextSibling(
	Upnp_Node OperationNode
	);

/** Refer to the {\tt attributes} attribute in the DOM Level 1 
 * specification page 29. 
 */
Upnp_NamedNodeMap UpnpNode_getAttributes(
	Upnp_Node OperationNode
	);

/** Refer to the {\tt ownerDocument} attribute in the DOM Level 1 
 * specification page 29. 
 */
Upnp_Document   UpnpNode_getOwnerDocument(Upnp_Node OperationNode);

/** Frees the given node object. 
 *
 * @return This method does not return a value. 
 */
Upnp_Void UpnpNode_free(
	Upnp_Node OperationNode /** The node object to free. */
	);

//@} // Interface Node

/***************************************************************************/
//Interface Document Implementation
/***************************************************************************/

/** @name Interface Document
 * Refer to the DOM Level 1 specification page 22.
 */

//@{

/** Refer to the DOM Level 1 specification page 23. */
Upnp_Document UpnpDocument_createDocument(
	Upnp_Document OperationDocument
	);

/** Refer to the DOM Level 1 specification page 23. */
Upnp_Element UpnpDocument_createElement(
	Upnp_Document OperationDocument, 
	Upnp_DOMString tagName, 
	Upnp_DOMException *err
	);

/** Refer to the DOM Level 1 specification page 23. */
Upnp_Text UpnpDocument_createTextNode(
	Upnp_Document OperationDocument, 
	Upnp_DOMString data
	);

/** Refer to the DOM Level 1 specification page 24. */
Upnp_Attr UpnpDocument_createAttribute(
	Upnp_Document OperationDocument, 
	Upnp_DOMString name, 
	Upnp_DOMException *err
	);

/** Refer to the DOM Level 1 specification page 24. */
Upnp_NodeList UpnpDocument_getElementsByTagName(
	Upnp_Document OperationDocument, 
	Upnp_DOMString tagname
	);

/** Refer to the {\tt doctype} attribute in the DOM Level 1 
 * specification page 22. 
 */
Upnp_DocumentType UpnpDocument_getDoctype(
	Upnp_Document OperationDocument
	);


/** Refer to the {\tt documentElement} attribute in the DOM Level 1 
 * specification page 22. 
 */
Upnp_Element UpnpDocument_getDocumentElement(
	Upnp_Document OperationDocument
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 29. 
 */
Upnp_Node UpnpDocument_insertBefore(
	Upnp_Document OperationDocument, 
	Upnp_Node newChild, 
	Upnp_Node refChild, 
	Upnp_DOMException *err
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 30. 
 */
Upnp_Node UpnpDocument_replaceChild(
	Upnp_Document OperationDocument, 
	Upnp_Node newChild, 
	Upnp_Node oldChild, 
	Upnp_DOMException *err
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 30. 
 */
Upnp_Node UpnpDocument_removeChild(
	Upnp_Document OperationDocument, 
	Upnp_Node oldChild, 
	Upnp_DOMException *err
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 30. 
 */
Upnp_Node UpnpDocument_appendChild(
	Upnp_Document OperationDocument, 
	Upnp_Node newChild, 
	Upnp_DOMException *err
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 31. 
 */
Upnp_Bool UpnpDocument_hasChildNodes(
	Upnp_Document OperationDocument
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 31. 
 */
Upnp_Node UpnpDocument_cloneNode(
	Upnp_Document OperationDocument, 
	Upnp_Bool deep
	);

/** Inherited from Interface Node.  Refer to the {\tt nodeName} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_DOMString UpnpDocument_getNodeName(
	Upnp_Document OperationDocument
	);

/** Inherited from Interface Node.  Refer to the {\tt nodeName} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_DOMString UpnpDocument_getNodeValue(
	Upnp_Document OperationDocument, 
	Upnp_DOMException *err
	);

/** Inherited from Interface Node.  Refer to the {\tt nodeName} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_Void UpnpDocument_setNodeValue(
	Upnp_Document OperationDocument, 
	Upnp_DOMString nodeValue, 
	Upnp_DOMException *err
	);

/** Inherited from Interface Node.  Refer to the {\tt nodeType} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_UShort UpnpDocument_getNodeType(
	Upnp_Document OperationDocument
	);