xml_def.h 25.1 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*******************************************************************************
 * Filename:
 * ---------
 * xml_def.h
 *
 * Project:
 * --------
 *   MAUI
 *
 * Description:
 * ------------
 *   This file is intends for ¡K.
 *
 * Author:
 * -------
 * -------
 *
 *==============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!! 
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 *******************************************************************************/

#ifndef __XML_DEF_H__
#define __XML_DEF_H__

#include "kal_general_types.h"
#include "fs_type.h"

/********************************************************************/
/* declaration */
/********************************************************************/

/* DOM-NOT_FOR_SDK-BEGIN */
#define XML_TAG_PROLOG_START        "<?xml"
#define XML_TAG_PROLOG_END          "?>"
#define XML_TAG_DOCTYPE_START       "<!DOCTYPE"
#define XML_TAG_ELEMENTTYPE_START   "<!ELEMENT"
#define XML_TAG_ATTLISTTYPE_START   "<!ATTLIST"
#define XML_TAG_ENTITYTYPE_START    "<!ENTITY"
#define XML_TAG_NOTATIONTYPE_START  "<!NOTATION"
#define XML_TAG_COMMENT_START       "<!--"
#define XML_TAG_COMMENT_END         "-->"
#define XML_TAG_CDATA_START         "<![CDATA["
#define XML_TAG_CDATA_END           "]]>"
#define XML_TAG_PI_START            "<?"
#define XML_TAG_ENCODING            "encoding"
#define XML_TAG_ENCODING_UTF8       "utf-8"
#define XML_TAG_ENCODING_UTF16      "utf-16"
#define XML_TAG_ENCODING_UCS2       "iso-10646-ucs-2"
#define XML_TAG_ENCODING_UCS4       "iso-10646-ucs-4"
#define XML_TAG_ENCODING_ASCII      "iso-8859-1"

#define XML_TAG_ELEMENT_START       "<"
#define XML_TAG_ELEMENT_END         "</"
#define XML_TAG_SINGLE_END          "/>"
#define XML_TAG_GENERAL_END         ">"
#define XML_SPACE                   " "
#define XML_QUOTE                   "'"
#define XML_DOUBLE_QUOTE            "\""
#define XML_SQUARE_LEFT_BRAKET      "["
#define XML_SQUARE_RIGHT_BRAKET     "]"


/* Leo add for DLT */
/*****************************************
Note: DLT needs more buffer length.
If anyone needs to use these two macro,
   please include "MMI_features.h" before
   xml_def.h.
*****************************************/
#if defined (__MMI_DOWNLOADABLE_THEMES_SUPPORT__) || defined (SVG_SUPPORT)
#define XML_BUFFER_LENGTH        (512)
#define XML_MAX_ATTR_COUNT       (100)
#elif defined (__MMI_BT_MAP_CLIENT__)
#define XML_BUFFER_LENGTH        (128)
#define XML_MAX_ATTR_COUNT       (40)
#else /* defined (__MMI_DOWNLOADABLE_THEMES_SUPPORT__) || defined (__SVG_SUPPORT__) */ 
#define XML_BUFFER_LENGTH        (128)
#define XML_MAX_ATTR_COUNT       (30)
#endif /* defined (__MMI_DOWNLOADABLE_THEMES_SUPPORT__) || defined (__SVG_SUPPORT__) */ 

#define MAX_CTRL_BUFFER_SIZE    (2048)
#define XML_MAX_ENTITY_COUNT    (10)
#define XML_MAX_ELEM_DEPTH      (20)
#define XML_CHAR_ENTITY_LENGTH  (15)

#define MAX_FILEBUF_NUM     (2)
#define FILEBUF_SIZE        (5*1024)
#define FILEBUF_BACKSIZE    (2*1024)
#define XML_VIRFILE_MIN     (4*1024)
/* DOM-NOT_FOR_SDK-END */

/*****************************************************************************
 * <GROUP  CallbackFunctions>
 *
 * FUNCTION
 *  XML_start_elem_hdlr
 * DESCRIPTION
 *  this function is element start handler.
 * PARAMETERS
 *  data:        [IN]        reserved
 *  el:          [IN]        Element name
 *  attr:        [IN]        Attribution list
 *  error:       [IN]        error code
 * RETURNS
 *  void
 *****************************************************************************/
typedef void (*XML_start_elem_hdlr) (
                void *data,
                const kal_char *el,
                const kal_char **attr,
                kal_int32 error);


/*****************************************************************************
 * <GROUP  CallbackFunctions>
 *
 * FUNCTION
 *  XML_end_elem_hdlr
 * DESCRIPTION
 *  this function is element end handler.
 * PARAMETERS
 *  data:        [IN]        reserved
 *  el:          [IN]        Element name
 *  error:       [IN]        error code
 * RETURNS
 *  void
 *****************************************************************************/
typedef void (*XML_end_elem_hdlr) (void *data, const kal_char *el, kal_int32 error);


/*****************************************************************************
 * <GROUP  CallbackFunctions>
 *
 * FUNCTION
 *  XML_start_doctype_hdlr
 * DESCRIPTION
 *  this function is document type start handler.
 * PARAMETERS
 *  data:            [IN]        reserved
 *  doctypeName:     [IN]        document type name
 *  sysid:           [IN]        system id
 *  pubid:           [IN]        public id
 *  internal_subset: [IN]        internal subset
 *  error:           [IN]        error code
 * RETURNS
 *  void
 *****************************************************************************/
typedef void (*XML_start_doctype_hdlr) (
                void *data,
                const kal_char *doctypeName,
                const kal_char **sysid, 
                const kal_char **pubid,
                kal_int32 internal_subset,
                kal_int32 error);


/*****************************************************************************
 * <GROUP  CallbackFunctions>
 *
 * FUNCTION
 *  XML_end_doctype_hdlr
 * DESCRIPTION
 *  this function is used to handle document type.
 * PARAMETERS
 *  data:            [IN]        reserved
 *  error:           [IN]        error code
 * RETURNS
 *  void
 *****************************************************************************/
typedef void (*XML_end_doctype_hdlr) (void *data, kal_int32 error);


/*****************************************************************************
 * <GROUP  CallbackFunctions>
 *
 * FUNCTION
 *  XML_data_hdlr
 * DESCRIPTION
 *  this function is used to handle data.
 * PARAMETERS
 *  resv:            [IN]        reserved
 *  el:              [IN]        element name
 *  data:            [IN]        data
 *  len:             [IN]        length
 *  error:           [IN]        error code
 * RETURNS
 *  void
 *****************************************************************************/
typedef void (*XML_data_hdlr) (
                void *resv,
                const kal_char *el,
                const kal_char *data,
                kal_int32 len,
                kal_int32 error);


/*****************************************************************************
 * <GROUP  CallbackFunctions>
 *
 * FUNCTION
 *  XML_malloc_buffer_ptr
 * DESCRIPTION
 *  this function is used to malloc buffer.
 * PARAMETERS
 *  len:           [IN]        length
 * RETURNS
 *  void
 *****************************************************************************/
typedef void *(*XML_malloc_buffer_ptr) (kal_int32 len);


/*****************************************************************************
 * <GROUP  CallbackFunctions>
 *
 * FUNCTION
 *  XML_free_buffer_ptr
 * DESCRIPTION
 *  this function is used to free buffer.
 * PARAMETERS
 *  ptr:           [IN]        buffer pointer
 * RETURNS
 *  void
 *****************************************************************************/
typedef void (*XML_free_buffer_ptr) (void *ptr);


/* define the error code */
typedef enum
{
    XML_RESULT_IS_STOPPED = -5, /* the parser is stopped. */
    XML_RESULT_FILE_NOT_FOUND = -4, /* the file isn't found */
    XML_RESULT_OUT_OF_MEMORY = -3,  /* the memory isn't enough*/
    XML_RESULT_ENCODING_ERROR = -2, /* the char encoding error */
    XML_RESULT_FAIL = -1,           /* fail to parse xml */
    XML_RESULT_OK = 0               /* parsing xml succed */
} XML_RESULT_ENUM;

/* define the error code */
typedef enum
{
    XML_NO_ERROR,                               /* no error */
    XML_ERROR_MISMATCH_TAG,                     /* error string: end tag name */
    XML_ERROR_MISMATCH_DOCTYPENAME_ROOTNAME,    /* error string : root element name */
    XML_ERROR_INVALID_ATTRIBUTE,                /* error string : attribute name */
    XML_ERROR_DUPLICATE_ATTRIBUTE,              /* error string : attribute name */
    XML_ERROR_ENTITY_DEFINITION,                /* error string: entity name */
    XML_ERROR_UNDEFINED_ENTITY                  /* error string : entity name */
}xml_error_enum;

/* define the pending type */
typedef enum
{
    XML_PENDING_NONE,           /* no pending content */
    XML_PENDING_PROLOG,         /* the prolog is pending */
    XML_PENDING_DOCTYPE,        /* the document type decare is pending */
    XML_PENDING_DOCTYPE_MARKUP, /* the doctype markup is pending */
    XML_PENDING_COMMENT,        /* the comment is pending */
    XML_PENDING_PI,             /* the pi is pending */
    XML_PENDING_CDATA,          /* the cdata is pending */
    XML_PENDING_START_ELEMENT,  /* the start element is pending */
    XML_PENDING_END_ELEMENT     /* the end element is pending */
} XML_PENDING_ENTITY_TYPE_ENUM;

/* define the charset encoding */
typedef enum
{
    XML_ENCODING_UTF8,      /* the char encoding is utf8 */
    XML_ENCODING_UTF16,     /* the char encoding is utf16 */
    XML_ENCODING_UCS2,      /* the char encoding is ucs2 */
    XML_ENCODING_UCS4,      /* the char encoding is ucs4 */
    XML_ENCODING_UNKNOWN    /* the char encoding is unknown */
} XML_ENCODING_TYPE_ENUM;

/* this struct is used to parse char entity */
typedef struct
{
    const kal_char *named_string;   /* replace text of char entity */
    const kal_char named_ch;        /* Predefined char entity */
} named_char_entry_struct;

/* this struct is used when using file buffer */
typedef struct 
{
    kal_char  *bufptr;              /* point to the buffer provided by app */
    kal_int32 virfilelen;           /* the length of data in buffer */
    kal_int32 virfileseek;          /* the position of file buffer */
    kal_int32 bufsize;              /* the size of file buffer */
    FS_HANDLE fp;                   /* file handle */
    kal_int32 realfilebeginpos;     /* file begin position from where we read data */
    kal_int32 realfileseekpos;      /* seek pointer of real file */
    kal_char  valid;                /* whether the file buffer is valid */
    kal_char  isfull;               /* whether the buffer is full */
} virtual_file_buf_struct;

/* this struct is used to parse xml */
typedef struct
{
    XML_malloc_buffer_ptr get_buffer_ptr;       /* function pointer provided by app */
    XML_free_buffer_ptr free_buffer_ptr;        /* function pointer provided by app */
    XML_start_doctype_hdlr start_doctype_hdlr;  /* function pointer provided by app */
    XML_end_doctype_hdlr end_doctype_hdlr;      /* function pointer provided by app */
    XML_start_elem_hdlr start_elem_hdlr;        /* function pointer provided by app */
    XML_end_elem_hdlr end_elem_hdlr;            /* function pointer provided by app */
    XML_data_hdlr data_hdlr;                    /* function pointer provided by app */
    FS_HANDLE source;                           /* file handle */
    virtual_file_buf_struct virfileptr;         /* information of file buffer  */
    const kal_char *xml_text;                   /* point to buffer provided by app */
    kal_char *elem[XML_MAX_ELEM_DEPTH];         /* stack for managing element nesting */
    kal_char *ge_data[XML_MAX_ENTITY_COUNT << 1]; /* manage general entity data */
    kal_char *pe_data[XML_MAX_ENTITY_COUNT << 1]; /* manage parameter entity data */
    kal_char *doct_name;        /* this name is saved to match with root element name */
    kal_char *token_ptr;        /* token pointer */
    kal_char *ap_temp;          /* temp buffer to parse xml */
    kal_char *err_str;          /* save the error string */
    void *root;                 /* indicate the root element */
    kal_int32 xml_len;          /* the length of xml_text */
    kal_int32 curr_depth;       /* stack pointer */
    kal_int32 error;            /* error code */
    kal_int32 prolog_depth;     /* the depth of prolog */
    kal_int32 encoding;         /* character encoding */
    kal_int32 prolog_done;      /* whether the prolog has been parsed */
    kal_int32 pos;              /* file position that indicates the length of parsed content */
    kal_int32 pending_start_pos; /* indicate the file position of the pending data */
    kal_int32 cdata_start_pos;  /* indicate the file position of the cdata */
    kal_int32 cdata_len;        /* the length of cdata */
    kal_int32 data_start_pos;   /* indicate the file position of the data */
    kal_int32 need_end_tag;     /* whether need the end tag */
    kal_int32 pending_type;     /* please refer to XML_PENDING_ENTITY_TYPE_ENUM */
    kal_int32 stop;             /* whether stop the xml parser */
    kal_int32 pause;            /* whether pause the xml parser */
    kal_uint8 pe_count;         /* the count of parameter entity */
    kal_uint8 ge_count;         /* the count of general entity */
    kal_int32 offset;
    kal_uint8 isext;                            /* whether use file buffer */
} XML_PARSER_STRUCT;

/* DOM-NOT_FOR_SDK-BEGIN */
/* this function is used as default element start handler */
extern void xml_elem_start_hdlr(
                void *data,
                const kal_char *el,
                const kal_char **attr,
                kal_int32 error);

/* this function is used as default element end handler */
extern void xml_elem_end_hdlr(void *data, const kal_char *el, kal_int32 error);

/* this function is used as default doctype start handler */
extern void xml_doctype_start_hdlr(
                void *data,
                const kal_char *doctypeName,
                const kal_char **sysid,
                const kal_char **pubid,
                kal_int32 internal_subset,
                kal_int32 error);

/* this function is used as default doctype end handler */
extern void xml_doctype_end_hdlr(void *data, kal_int32 error);

/* this function is used as default general data handler */
extern void xml_general_data_hdlr(
                void *resv,
                const kal_char *el,
                const kal_char *data,
                kal_int32 len,
                kal_int32 error);
/* DOM-NOT_FOR_SDK-END */

/*****************************************************************************
 * FUNCTION
 *  xml_new_parser
 * DESCRIPTION
 *  this function is used to new parser
 * PARAMETERS
 *  parser:      [IN]        Global parser struct
 * RETURNS
 *  result of parser
 *****************************************************************************/
extern kal_int32 xml_new_parser(XML_PARSER_STRUCT *parser);


/*****************************************************************************
 * FUNCTION
 *  xml_close_parser
 * DESCRIPTION
 *  this function is used to close parser
 * PARAMETERS
 *  parser:      [IN]        Global parser struct
 * RETURNS
 *  void
 *****************************************************************************/
extern void xml_close_parser(XML_PARSER_STRUCT *parser);


/*****************************************************************************
 * FUNCTION
 *  xml_close_parser_offset
 * DESCRIPTION
 *  this function is used to close offset-parser
 * PARAMETERS
 *  parser:      [IN]        Global parser struct
 * RETURNS
 *  void
 *****************************************************************************/
extern void xml_close_parser_offset(XML_PARSER_STRUCT *parser);


/*****************************************************************************
 * FUNCTION
 *  xml_parse_file_from_offset
 * DESCRIPTION
 *  this function is called to parse from offset
 * PARAMETERS
 *  parser:          [IN/OUT]        Global parser struct
 *  file_handle:     [IN]            FS_HANDLE of xml file
 * RETURNS
 *  void
 *****************************************************************************/
extern kal_int32 xml_parse_file_from_offset(XML_PARSER_STRUCT *parser, kal_int32 file_handle);


/*****************************************************************************
 * FUNCTION
 *  xml_register_doctype_handler
 * DESCRIPTION
 *  this functin is used to register document handler
 * PARAMETERS
 *  parser:          [OUT]       Global parser struct
 *  start_hdlr:      [IN]        Function handler to handle start doc data
 *  end_hdlr:        [IN]        Function handler to handle end doc data
 * RETURNS
 *  void
 *****************************************************************************/
extern void xml_register_doctype_handler(
                XML_PARSER_STRUCT *parser,
                XML_start_doctype_hdlr start_hdlr,
                XML_end_doctype_hdlr end_hdlr);


/*****************************************************************************
 * FUNCTION
 *  xml_register_element_handler
 * DESCRIPTION
 *  this function is used to register element handler
 * PARAMETERS
 *  parser:          [OUT]       Global parser struct
 *  start_hdlr:      [IN]        Function handler to handle start element data
 *  end_hdlr:        [IN]        Function handler to handle end element data
 * RETURNS
 *  void
 *****************************************************************************/
extern void xml_register_element_handler(
                XML_PARSER_STRUCT *parser,
                XML_start_elem_hdlr start_hdlr,
                XML_end_elem_hdlr end_hdlr);


/*****************************************************************************
 * FUNCTION
 *  xml_register_data_handler
 * DESCRIPTION
 *  this function is used to register data handler
 * PARAMETERS
 *  parser:          [OUT]       Global parser struct
 *  data_hdlr:       [IN]        Function handler to handle data
 * RETURNS
 *  void
 *****************************************************************************/
extern void xml_register_data_handler(XML_PARSER_STRUCT *parser, XML_data_hdlr data_hdlr);


/*****************************************************************************
 * FUNCTION
 *  xml_parse
 * DESCRIPTION
 *  this function is called by application to start parsing if application pass
 *  xml text with file
 * PARAMETERS
 *  parser:          [IN/OUT]        Global parser struct
 *  file_name:       [IN]            Xml file name
 * RETURNS
 *  void
 *****************************************************************************/
extern kal_int32 xml_parse(XML_PARSER_STRUCT *parser, kal_wchar *file_name);


/*****************************************************************************
 * FUNCTION
 *  xml_parse_buffer
 * DESCRIPTION
 *  this function is called by application to start parsing if application 
 *  pass xml text with buffer
 * PARAMETERS
 *  parser:          [IN/OUT]        Global parser struct
 *  xmltext:         [IN]            Xml text buffer
 *  length:          [IN]            the length of buffer
 * RETURNS
 *  return XML_RESULT_OK if successful
 *****************************************************************************/
extern kal_int32 xml_parse_buffer(
                    XML_PARSER_STRUCT *parser,
                    const kal_char *xmltext,
                    kal_int32 length);


/*****************************************************************************
 * FUNCTION
 *  xml_resume_parse
 * DESCRIPTION
 *  this function is called to resume parsing
 * PARAMETERS
 *  parser:      [IN/OUT]        Global parser struct
 * RETURNS
 *  void
 *****************************************************************************/
extern kal_int32 xml_resume_parse(XML_PARSER_STRUCT *parser);


/*****************************************************************************
 * FUNCTION
 *  xml_pause_parse
 * DESCRIPTION
 *  this function is called to pause parsing
 * PARAMETERS
 *  parser:      [IN/OUT]        Global parser struct
 * RETURNS
 *  void
 *****************************************************************************/
extern void xml_pause_parse(XML_PARSER_STRUCT *parser);


/*****************************************************************************
 * FUNCTION
 *  xml_stop_parse
 * DESCRIPTION
 *  this function is called to stop parsing
 * PARAMETERS
 *  parser:      [IN/OUT]        Global parser struct
 * RETURNS
 *  void
 *****************************************************************************/
extern void xml_stop_parse(XML_PARSER_STRUCT *parser);


/*****************************************************************************
 * FUNCTION
 *  xml_free_parse
 * DESCRIPTION
 *  this function is called to free parser
 * PARAMETERS
 *  parser:      [IN/OUT]        Global parser struct
 * RETURNS
 *  void
 *****************************************************************************/
extern void xml_free_parse(XML_PARSER_STRUCT *parser);


/*****************************************************************************
 * FUNCTION
 *  xml_get_err_string
 * DESCRIPTION
 *  This function is used to return error string to application
 * PARAMETERS
 *  parser:      [IN]        Global parser struct
 * RETURNS
 *  return error string to application
 *****************************************************************************/
extern kal_char *xml_get_err_string(XML_PARSER_STRUCT *parser);


/*****************************************************************************
 * FUNCTION
 *  xml_configure_memory
 * DESCRIPTION
 *  this function is used to configure memory
 * PARAMETERS
 *  parser:          [IN]        Global parser struct
 *  get_ptr:         [IN]        The pointer to malloc function
 *  free_ptr:        [IN]        
 * RETURNS
 *  void
 *****************************************************************************/
extern void xml_configure_memory(
                XML_PARSER_STRUCT *parser,
                XML_malloc_buffer_ptr get_ptr,
                XML_free_buffer_ptr free_ptr);


/*****************************************************************************
 * FUNCTION
 *  xml_new_parser_ext
 * DESCRIPTION
 *  this function is used to new parser
 * PARAMETERS
 *  parser:      [IN]        Global parser struct
 *  buffer:      [IN}        buffer provided by app
 *  size:        [IN]        The size of buffer 
 * RETURNS
 *  result of parser
 *****************************************************************************/
extern kal_int32 xml_new_parser_ext(
                    XML_PARSER_STRUCT *parser,
                    kal_char* buffer,
                    kal_int32 size);

#endif /* __XML_DEF_H__ */