/*

* Copyright (c) 2000 - 2001 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

/** ----------------------------------------------------------------------- **

    @package:     NW_TinyDom

    @synopsis:    default

    @description: default

 ** ----------------------------------------------------------------------- **/

#ifndef NW_TINY_DOM_H

#define NW_TINY_DOM_H

#include <xml/cxml/cxml_proj.h>

#include <xml/cxml/nw_tinytree.h>

#include <xml/cxml/nw_wbxml_document.h>

#include <xml/cxml/nw_wbxml_parse.h>

#include <xml/cxml/nw_wbxml_opaque.h>

#include <xml/cxml/nw_encoder_wbxmlwriter.h>

#ifdef __cplusplus

extern "C" {

#endif /* __cplusplus */

enum NW_TinyDom_ExtensionType_e {

  NW_TINYDOM_EXTENSION_TYPE_NORMAL,

  NW_TINYDOM_EXTENSION_TYPE_EXT_T_INTEGER

};

/** ----------------------------------------------------------------------- **

    @struct:      NW_TinyDom_Extension

    @synopsis:    Extension structure.

    @scope:       public

    @variables:

       NW_Uint32 token

                  Token.

       NW_String_t string

                  Extension string.

    @description: Extension structure.

 ** ----------------------------------------------------------------------- **/

typedef struct NW_TinyDom_Extension_s{

  /* type is either NW_TINYDOM_EXTENSION_TYPE_NORMAL or

     NW_TINYDOM_EXTENSION_TYPE_EXT_T_INTEGER */

  NW_Uint8 type;

  NW_Uint32 token;

  union {

    NW_String_t string;

    NW_Uint32 x;

  } value;

} NW_TinyDom_Extension_t;

/** ----------------------------------------------------------------------- **

    @union:      NW_TinyDom_AttrValComponent

    @synopsis:    Attribute value component union.

    @scope:       public

    @variables:

       NW_Uint32 value_token

                  token

       NW_String_t string

                  string

       NW_TinyDom_Extension_t ext

                  extension

       NW_Uint32 entity

                  entity.

       NW_WBXML_Opaque_t opaque

                  opaque

    @description: Union of all possible attribute value types.

 ** ----------------------------------------------------------------------- **/

typedef union NW_TinyDom_AttrValComponent_u{

  NW_Uint32 value_token;

  NW_String_t string;

  NW_TinyDom_Extension_t ext;

  NW_Uint32 entity;

  NW_WBXML_Opaque_t opaque;

}NW_TinyDom_AttrValComponent_t;

/** ----------------------------------------------------------------------- **

    @struct:       NW_TinyDom_AttrVal

    @synopsis:    Attribute value.

    @scope:       public

    @variables:

       NW_Uint32 type

                  type

       NW_TinyDom_AttrValComponent_t component

                  attribute value union of all possible types.

    @description: An attribute value has a type info field and a union of

                  all the possible types. The type info values are defined

                  in NW_WBXML_Attribute.h. This type is designed to be

                  passed as an in/out param to the attribute value iterator.

 ** ----------------------------------------------------------------------- **/

typedef struct NW_TinyDom_AttrVal_s {

  NW_Uint32 type;

  NW_TinyDom_AttrValComponent_t component;

} NW_TinyDom_AttrVal_t;

/* Node type bits */

#define T_DOM_NODE_DOC          (NW_Uint16)00

#define T_DOM_NODE_TAG          (NW_Uint16)01

#define T_DOM_NODE_ATTR         (NW_Uint16)02

#define T_DOM_NODE_TEXT         (NW_Uint16)03

#define T_DOM_NODE_PI           (NW_Uint16)04

#define T_DOM_NODE_COMMENT      (NW_Uint16)05

#define T_DOM_NODE_CDATASECTION (NW_Uint16)06

#define T_DOM_NODE_XML          (NW_Uint16)80

/** ----------------------------------------------------------------------- **

    @struct:      NW_TinyDom_Tree

    @synopsis:    Wrapper for tree components.

    @scope:       public

    @variables:

       NW_WBXML_Document_t* doc

                  The document.

       NW_TinyTree_t tree

                  The tree.

       NW_WBXML_Parser_t* parser

                  Parser associated with this tree.

       NW_WBXML_Writer_t* writer

                  Writer for this tree.

       NW_TinyTree_Node_t* root_node

                  Root node of tree.

    @description:  Wrapper for tree components.

 ** ----------------------------------------------------------------------- **/

typedef struct NW_TinyDom_Tree_s{

  NW_WBXML_Document_t* doc;

  NW_TinyTree_t tree;

  NW_WBXML_Parser_t* parser;

  NW_WBXML_Writer_t* writer;

  NW_TinyTree_Node_t* root_node;

}NW_TinyDom_Tree_t;

/** ----------------------------------------------------------------------- **

    @struct:      NW_TinyDom_Parser

    @synopsis:    Parser structure.

    @scope:       public

    @variables:

       NW_Uint32 state

                  State.

       NW_TinyTree_Offset_t node_count

                  default

       NW_TinyTree_Offset_t cp_count

                  Current offset.

       NW_TinyDom_Tree_t* dom_tree

                  The tree.

       NW_TinyTree_Node_t* current_node

                  Present position in tree.

       NW_TinyTree_Offset_t content_offset

                  Present offset into buffer.

    @description: Parser structure.

 ** ----------------------------------------------------------------------- **/

typedef struct NW_TinyDom_Parser_s{

  NW_Uint32 state;

  NW_TinyTree_Offset_t node_count;

  NW_TinyTree_Offset_t cp_count;

  NW_TinyDom_Tree_t* dom_tree;

  NW_TinyTree_Node_t* current_node;

  /* Offset where current content begins */

  NW_TinyTree_Offset_t content_offset;

}NW_TinyDom_Parser_t;

/** ----------------------------------------------------------------------- **

    @function:    NW_TinyDom_Tree_construct

    @synopsis:    Constructor.

    @scope:       public

    @parameters:

       [in-out] NW_TinyDom_Tree_t* domTree

                  The tree.

       [in] NW_WBXML_Parser_t* wbxmlParser

                  The parser

       [in] NW_WBXML_Document_t* doc

                  The document.

       [in] NW_WBXML_Writer_t* writer

                  The writer.

    @description: Constructor.

 ** ----------------------------------------------------------------------- **/

void

NW_TinyDom_Tree_construct(NW_TinyDom_Tree_t* domTree,

                          NW_WBXML_Parser_t* wbxmlParser,

                          NW_WBXML_Document_t* doc,

                          NW_WBXML_Writer_t* writer);

/** ----------------------------------------------------------------------- **

    @function:    NW_TinyDom_Tree_destruct

    @synopsis:    Destructor.

    @scope:       public

    @parameters:

       [in-out] NW_TinyDom_Tree_t* domTree

                  The DOM tree.

    @description: Destructor.

 ** ----------------------------------------------------------------------- **/

void

NW_TinyDom_Tree_destruct(NW_TinyDom_Tree_t* domTree);

/** ----------------------------------------------------------------------- **

    @function:    NW_TinyDom_Parser_construct

    @synopsis:    Constructor.

    @scope:       public

    @parameters:

       [in] NW_TinyDom_Parser_t* domParser

                  The DOM parser.

       [in] NW_TinyDom_Tree_t* domTree

                  The DOM tree.

    @description: Constructor.

 ** ----------------------------------------------------------------------- **/

IMPORT_C void

NW_TinyDom_Parser_construct(NW_TinyDom_Parser_t* domParser,

                            NW_TinyDom_Tree_t* domTree);

/** ----------------------------------------------------------------------- **

    @function:    NW_TinyDom_Parser_destruct

    @synopsis:    Desctructor.

    @scope:       public

    @parameters:

       [in-out] NW_TinyDom_Parser_t* domParser

                  The DOM parser.

    @description: Destructor.

 ** ----------------------------------------------------------------------- **/

void

NW_TinyDom_Parser_destruct(NW_TinyDom_Parser_t* domParser);

/** ----------------------------------------------------------------------- **

    @function:    NW_TinyDom_Parser_buildTree

    @synopsis:    Build tiny DOM tree.

    @scope:       public

    @parameters:

       [in] NW_TinyDom_Parser_t* domParser

                  The DOM parser.

       [in] char* buffer

                  The buffer containing the document data.

       [in] NW_Uint32 buffsize

                  The size of the document buffer.

       [in] NW_Bool freeBuff

                  Flag

    @description: Builds a DOM tree. The DOM parser must previously have

                  been initialized to use a parser (WBXML or XML) that

                  knows how to parse the contents of the buffer.Build tiny

                  DOM tree. Run Pass1 and Pass 2.

    @returns:     NW_Status_t

                  default

       [NW_STAT_SUCCESS]

                  Tree built.

       [NW_STAT_WBXML_ERROR_BYTECODE]

                  General error.

       [NW_STAT_OUT_OF_MEMORY]

                  Out of memory.

 ** ----------------------------------------------------------------------- **/

NW_Status_t

NW_TinyDom_Parser_buildTree(NW_TinyDom_Parser_t* domParser,

                            char* buffer,

                            NW_Uint32 buffsize,

                            NW_Bool freeBuff);

/** ----------------------------------------------------------------------- **

    @function:    NW_TinyDom_Parser_incrementalBuildTree

    @synopsis:    build/append tiny DOM tree.

    @scope:       public

    @parameters:

       [in] NW_TinyDom_Parser_t* domParser

                  The DOM parser.

       [in] char* buffer

                  The buffer containing the document data.

       [in] NW_Uint32 buffsize

                  The size of the document buffer.

       [in] NW_Bool freeBuff

                  Flag

    @description: Builds a DOM tree. The DOM parser must previously have

                  been initialized to use a parser (WBXML or XML) that

                  knows how to parse the contents of the buffer.Build tiny

                  DOM tree. Run Pass1 and Pass 2.

    @returns:     NW_Status_t

                  default

       [NW_STAT_SUCCESS]

                  Tree built.

       [NW_STAT_WBXML_ERROR_BYTECODE]

                  General error.

       [NW_STAT_OUT_OF_MEMORY]

                  Out of memory.

 ** ----------------------------------------------------------------------- **/

NW_Status_t

NW_TinyDom_Parser_incrementalBuildTree(NW_TinyDom_Parser_t* domParser,

                            char* buffer,

                            NW_Uint32 buffsize,

                            NW_Bool freeBuff,

                            NW_Int32 lastValid);

/** ----------------------------------------------------------------------- **

    @function:    NW_TinyDom_Node_getType

    @synopsis:    Get node type.

    @scope:       public

    @parameters:

       [in] NW_TinyTree_Node_t* node

                  The DOM parser.

    @description: Get node type.

    @returns:     NW_Uint16

                  Node flag.

 ** ----------------------------------------------------------------------- **/

NW_Uint16

NW_TinyDom_Node_getType(NW_TinyTree_Node_t* node);

/** ----------------------------------------------------------------------- **

    @struct:      NW_TinyDom_ListIterator

    @synopsis:    ListIterator structure.

    @scope:       public

    @variables:

       NW_Uint32 state

                  Iterator state.

       void* segment

                  Segment

       NW_TinyTree_Offset_t segSize

                  Segment size

       NW_TinyTree_Offset_t offset

                  Offset into document.

       NW_TinyDom_Parser_t* tiny_parser

                  Parser used for iteration.

       void* context

                  Context.

    @description: ListIterator structure.

 ** ----------------------------------------------------------------------- **/

typedef struct NW_TinyDom_ListIterator_s {

  NW_Uint32 state;

  void* segment;

  NW_TinyTree_Offset_t segSize;

  NW_TinyTree_Offset_t offset;

  NW_TinyDom_Parser_t* tiny_parser;

  void* context;

}NW_TinyDom_ListIterator_t;

/* Tiny dom routines to support tags */

/** ----------------------------------------------------------------------- **

    @struct:      NW_TinyDom_Tag

    @synopsis:    Tag structure.

    @scope:       public

    @variables:

       NW_TinyDom_Parser_t* tiny_parser

                  This parser.

       NW_Uint32 fq_token

                  Token with codepage and attribute/element tag.

       NW_Uint32 name_index

                  Index of first character of name into string table.

    @description: Tag structure.

 ** ----------------------------------------------------------------------- **/

typedef struct NW_TinyDom_Tag_s {

  NW_TinyDom_Parser_t* tiny_parser;

  NW_Uint32 fq_token;

  NW_Uint32 name_index;

}NW_TinyDom_Tag_t;

/** ----------------------------------------------------------------------- **

    @function:    NW_TinyDom_getTagToken

    @synopsis:    Get tag token.

    @scope:       public

    @parameters:

       [in] NW_TinyDom_Parser_t* parser

                  The parser.

       [in] NW_TinyTree_Node_t* node

                  Node to use.

    @description: Get tag token.

    @returns:     NW_Uint32

                  Tag token.

 ** ----------------------------------------------------------------------- **/

IMPORT_C NW_Uint32

NW_TinyDom_getTagToken(NW_TinyDom_Parser_t* parser,

                       NW_TinyTree_Node_t* node);

/** ----------------------------------------------------------------------- **

    @function:    NW_TinyDom_getTagName

    @synopsis:    Get tag name.

    @scope:       public

    @parameters:

       [in] NW_TinyDom_Parser_t* parser

                  This parser.

       [in] NW_TinyTree_Node_t* node

                  This node.

       [out] NW_String_t* name

                  Name of tag.

    @description: Get tag name.

    @returns:     NW_Status_t

                  Status of operation.

       [NW_STAT_SUCCESS]

                  Name found.