xparser.h

/*
 *     ____             _________                __                _
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
 *                                                       /____/
 *
 *                 SharkSSL Embedded SSL/TLS Stack
 ****************************************************************************
 *   PROGRAM MODULE
 *
 *   $Id: xparser.h 5076 2022-02-10 16:59:48Z wini $
 *
 *   COPYRIGHT:  Real Time Logic LLC, 2010
 *
 *   This software is copyrighted by and is the sole property of Real
 *   Time Logic LLC.  All rights, title, ownership, or other interests in
 *   the software remain the property of Real Time Logic LLC.  This
 *   software may only be used in accordance with the terms and
 *   conditions stipulated in the corresponding license agreement under
 *   which the software has been supplied.  Any unauthorized use,
 *   duplication, transmission, distribution, or disclosure of this
 *   software is expressly forbidden.
 *
 *   This Copyright notice may not be removed or modified without prior
 *   written consent of Real Time Logic LLC.
 *
 *   Real Time Logic LLC. reserves the right to modify this software
 *   without notice.
 *
 *               http://www.realtimelogic.com
 *               http://www.sharkssl.com
 ****************************************************************************
 * xparser.h : streaming xml parser
 */
 
#ifndef __xparser_h
#define __xparser_h
#ifndef XPARSER_ALLOC
#define XPARSER_ALLOC 2
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
   struct xparser_context;
   typedef struct xparser_context xparser;
 
   enum xparser_event {
      xparserNOEVENT = 0,
      /*
        these event flags are for pseudo-events, which have no
        data attached to them.
      */
      xparserINIT,            
      xparserRESET,           
      xparserTERM,            
      xparserSTART,           
      /*
        the following are all called from first xparser_parse()
        name, attrs,data indicate which parameters will be returned.
      */
      xparserXML,             
      xparserSTART_ELEMENT,   
      xparserEND_ELEMENT,     
      xparserEMPTY_ELEMENT,   
      xparserPI,              
      xparserCOMMENT,         
      xparserCDATA,           
      xparserTEXT,            
      xparserLAST             
   };
   typedef enum xparser_event xparser_event;
 
   extern const char* const xparser_eventname[xparserLAST];
 
 
   typedef int (*xparser_callback)(
      xparser* parser,
      void* userdata,
      xparser_event event,
      const char* name, /* start element/end element/empty element/PI : tag name. */
      const char** attr, /* xml/start element/empty element : name,value pairs, as zero-terminated list. */
      const char* data); /* comment/pi/text/cdata : content*/
 
   typedef xparser_callback xparser_handlers[xparserLAST];
 
 
   enum xparser_textmode {xparserPRESERVE=0,xparserSKIPBLANK=1,xparserTRIM=2};
 
   xparser* xparser_create(void);
 
 
   int xparser_init(xparser* parser, xparser_handlers* handlers, void* userdata,unsigned int options);
 
 
 
   int xparser_term(xparser* parser);
 
 
   void xparser_destroy(xparser* parser);
 
 
   int xparser_reset(xparser* parser, int full);
 
 
   int xparser_parse(xparser* parser,const char* pData, size_t datalen);
 
/*
  information functions
*/
   const char* xparser_errormsg(xparser* parser);  
   unsigned int xparser_line(xparser* parser);     
   unsigned int xparser_col(xparser* parser);      
   size_t xparser_count(xparser* parser);          
   unsigned int xparser_depth(xparser* parser);    
   unsigned int xparser_flags(xparser* parser);    
   int xparser_has_doc(xparser* parser);           
   void* xparser_userdata(xparser* parser);        
#ifdef __DOXYGEN__
#else
 
/* #define XPARSER_ALLOC 2 */ /* no allocation functions in library */
 
#endif  /* doxygen */
 
#if XPARSER_ALLOC
   typedef void * (*xparser_alloc) (
      void *ud, /*< user token, supplied with allocator */
      void *ptr, /*< pointer to realloc/free. NULL for alloc */
      size_t osize, /*< current size : 0 to allocate */
      size_t nsize); /*< new size. 0 to de-allocate */
 
   void xparser_setalloc(xparser_alloc pa,void* ud);
 
#endif
 
#ifdef __cplusplus
}
#endif
 
 
#endif