xml_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_xml_util
#define _H_xml_util
/*  FILE: xml_util.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
14-oct-05    abb      begun
2-jan-06     abb      rewrite xml_consume_* API to use simpler
                      xml_node_t
*/
 
 
/* From /usr/include/libxml2/libxml/ */
#include <xmlreader.h>
#include <xmlstring.h>
 
#ifndef _H_ncxconst
#include "ncxconst.h"
#endif
 
#ifndef _H_xmlns
#include "xmlns.h"
#endif
 
#ifndef _H_log
#include "log.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                       C O N S T A N T S                           *
*                                                                   *
*********************************************************************/
 
#define MAX_CHAR_ENT 8
 
#define XML_START_MSG ((const xmlChar *)\
                       "<?xml version=\"1.0\" encoding=\"UTF-8\"?>")
 
#define XML_START_MSG_SIZE   38
 
 
/* XML_PARSE_NOCDATA option merge CDATA as text nodes, used to
 * parse Confd get-schema reply properly
 */
#define XML_READER_OPTIONS  \
    (XML_PARSE_RECOVER+XML_PARSE_NOERROR+                         \
     XML_PARSE_NOWARNING+XML_PARSE_NOBLANKS+XML_PARSE_NONET+      \
     XML_PARSE_XINCLUDE+XML_PARSE_NOCDATA)
 
#define XML_SES_URL "netconf://pdu"
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
typedef dlq_hdr_t  xml_attrs_t;
 
 
typedef struct xml_attr_t_ {
    dlq_hdr_t      attr_qhdr;
 
    xmlns_id_t     attr_ns;
 
    xmlns_id_t     attr_xmlns_ns;
 
    const xmlChar *attr_qname;
 
    const xmlChar *attr_name;
 
    xmlChar       *attr_dname;
 
    xmlChar       *attr_val;
 
    struct xpath_pcb_t_ *attr_xpcb;
} xml_attr_t;
 
 
typedef enum xml_nodetyp_t_ {
    XML_NT_NONE,   
    XML_NT_EMPTY,             
    XML_NT_START,             
    XML_NT_END,               
    XML_NT_STRING             
} xml_nodetyp_t;
 
 
typedef struct xml_node_t_ {
    xml_nodetyp_t  nodetyp;
 
    xmlns_id_t     nsid;
 
    xmlns_id_t     contentnsid;
 
    const xmlChar *module;
 
    const xmlChar *badns;
 
    xmlChar       *qname;
 
    const xmlChar *elname;
 
    const xmlChar *simval;
 
    uint32         simlen;
 
    xmlChar       *simfree;
 
    int            depth;
 
    xml_attrs_t    attrs;
} xml_node_t;
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern xml_node_t *
    xml_new_node (void);
 
 
extern void
    xml_init_node (xml_node_t *node);
 
 
extern void
    xml_free_node (xml_node_t *node);
 
 
extern void
    xml_clean_node (xml_node_t *node);
 
 
extern status_t
    xml_get_reader_from_buff (const xmlChar *buff,
                              xmlTextReaderPtr *reader);
 
 
extern status_t
    xml_get_reader_from_filespec (const char *filespec,
                                  xmlTextReaderPtr  *reader);
 
 
extern status_t
    xml_get_reader_for_session (xmlInputReadCallback readfn,
                                xmlInputCloseCallback closefn,
                                void *context,
                                xmlTextReaderPtr  *reader);
 
 
extern status_t
    xml_reset_reader_for_session (xmlInputReadCallback readfn,
                                  xmlInputCloseCallback closefn,
                                  void *context,
                                  xmlTextReaderPtr  reader);
 
 
extern void
    xml_free_reader (xmlTextReaderPtr reader);
 
 
extern const char *
    xml_get_node_name (int nodeval);
 
 
extern boolean
    xml_advance_reader (xmlTextReaderPtr reader);
 
 
extern status_t
    xml_node_match (const xml_node_t *node,
                    xmlns_id_t nsid,
                    const xmlChar *elname,
                    xml_nodetyp_t  nodetyp);
 
 
extern status_t
    xml_endnode_match (const xml_node_t *startnode,
                       const xml_node_t *endnode);
 
 
extern boolean
    xml_docdone (xmlTextReaderPtr reader);
 
 
extern void
    xml_dump_node (const xml_node_t *node,
                   log_debug_t lvl);
 
 
extern void
    xml_init_attrs (xml_attrs_t *attrs);
 
 
extern xml_attr_t *
    xml_new_attr (void);
 
 
extern void
    xml_free_attr (xml_attr_t *attr);
 
 
extern status_t
    xml_add_attr (xml_attrs_t *attrs,
                  xmlns_id_t  ns_id,
                  const xmlChar *attr_name,
                  const xmlChar *attr_val);
 
 
extern xml_attr_t *
    xml_add_qattr (xml_attrs_t *attrs,
                   xmlns_id_t  ns_id,
                   const xmlChar *attr_qname,
                   uint32  plen,
                   const xmlChar *attr_val,
                   status_t *res);
 
 
extern status_t
    xml_add_xmlns_attr (xml_attrs_t *attrs,
                        xmlns_id_t  ns_id,
                        const xmlChar *pfix);
 
 
extern status_t
    xml_add_xmlns_attr_string (xml_attrs_t *attrs,
                               const xmlChar *ns,
                               const xmlChar *pfix);
 
 
extern status_t
    xml_add_inv_xmlns_attr (xml_attrs_t *attrs,
                            xmlns_id_t  ns_id,
                            const xmlChar *pfix,
                            const xmlChar *nsval);
 
 
extern xml_attr_t *
    xml_first_attr (xml_attrs_t  *attrs);
 
 
extern xml_attr_t *
    xml_get_first_attr (const xml_node_t  *node);
 
 
extern xml_attr_t *
    xml_next_attr (xml_attr_t  *attr);
 
 
extern void
    xml_clean_attrs (xml_attrs_t  *attrs);
 
 
extern void
    xml_move_attrs (xml_attrs_t *src_attrs,
                    xml_attrs_t *dest_attrs);
 
 
 
extern xml_attr_t *
    xml_find_attr (xml_node_t   *node,
                   xmlns_id_t    nsid,
                   const xmlChar *attrname);
 
 
extern xml_attr_t *
    xml_find_attr_q (xml_attrs_t *attrs,
                     xmlns_id_t        nsid,
                     const xmlChar    *attrname);
 
 
extern const xml_attr_t *
    xml_find_ro_attr (const xml_node_t *node,
                      xmlns_id_t        nsid,
                      const xmlChar    *attrname);
 
 
extern uint32
    xml_strlen (const xmlChar *str);
 
 
extern uint32
    xml_strlen_sp (const xmlChar *str,
                   boolean *sp);
 
 
extern uint32
    xml_strcpy (xmlChar *copyTo,
                const xmlChar *copyFrom);
 
 
extern uint32
    xml_strncpy (xmlChar *copyTo,
                 const xmlChar *copyFrom,
                 uint32  maxlen);
 
 
extern xmlChar *
    xml_strdup (const xmlChar *copyFrom);
 
 
extern xmlChar *
    xml_strcat (xmlChar *appendTo,
                const xmlChar *appendFrom);
 
 
extern xmlChar *
    xml_strncat (xmlChar *appendTo,
                 const xmlChar *appendFrom,
                 uint32 maxlen);
 
 
extern xmlChar *
    xml_strndup (const xmlChar *copyFrom,
                 uint32 maxlen);
 
 
extern char *
    xml_ch_strndup (const char *copyFrom,
                    uint32 maxlen);
 
 
extern int
    xml_strcmp (const xmlChar *s1,
                const xmlChar *s2);
 
 
extern int
    xml_stricmp (const xmlChar *s1,
                 const xmlChar *s2);
 
 
extern int
    xml_strncmp (const xmlChar *s1,
                 const xmlChar *s2,
                 uint32 maxlen);
 
 
extern int
    xml_strnicmp (const xmlChar *s1,
                  const xmlChar *s2,
                  uint32 maxlen);
 
 
extern boolean
    xml_isspace (uint32 ch);
 
 
extern boolean
    xml_isspace_str (const xmlChar *str);
 
 
extern int
    xml_strcmp_nosp (const xmlChar *s1,
                     const xmlChar *s2);
 
 
int
    xml_strcmp_nosp2 (const xmlChar *s1,
                      const xmlChar *s2);
 
 
extern xmlChar *
    xml_copy_clean_string (const xmlChar *str);
 
 
extern xmlChar
    xml_convert_char_entity (const xmlChar *str,
                             uint32 *used);
 
 
extern status_t
    xml_check_ns (xmlTextReaderPtr reader,
                  const xmlChar   *elname,
                  xmlns_id_t       *id,
                  uint32           *pfix_len,
                  const xmlChar   **badns);
 
 
extern void
    xml_check_qname_content (xmlTextReaderPtr reader,
                             xml_node_t      *node);
 
 
extern status_t
    xml_get_namespace_id (xmlTextReaderPtr reader,
                          const xmlChar *prefix,
                          uint32 prefixlen,
                          boolean register_missing,
                          xmlns_id_t  *retnsid);
 
 
extern status_t
    xml_consume_node (xmlTextReaderPtr reader,
                      xml_node_t  *xmlnode,
                      boolean nserr,
                      boolean adv);
 
 
extern xmlChar * xml_trim_string (xmlChar *str);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_xml_util */