xmlns.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_xmlns
#define _H_xmlns
/*  FILE: xmlns.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/

/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************

date             init     comment
----------------------------------------------------------------------
30-apr-05    abb      Begun.
*/

#include <xmlstring.h>

#ifndef _H_dlq
#include "dlq.h"
#endif

#ifndef _H_status
#include "status.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/

#define XMLNS_NULL_NS_ID          0

#define XMLNS                     ((const xmlChar *)"xmlns")
#define XMLNS_LEN                 5

#define XMLNS_SEPCH               ':'

/* only compare if both elements have namespaces specified
 * If either one is 'no namespace', then it is considered a match
 */
#define XMLNS_EQ(NS1,NS2)     (((NS1) && (NS2)) && ((NS1)==(NS2)))

/********************************************************************
*                                                                   *
*                             T Y P E S                             *
*                                                                   *
*********************************************************************/


typedef uint16 xmlns_id_t;


typedef struct xmlns_qname_t_ {
    xmlns_id_t       nsid;  
    const xmlChar   *name;  
} xmlns_qname_t;

typedef struct xmlns_t_ {
    xmlns_id_t   ns_id;

    xmlChar     *ns_pfix;

    xmlChar     *ns_name;

    xmlChar     *ns_module;

    struct ncx_module_t_ *ns_mod;

    boolean      ns_temporary;

    boolean      ns_deleted;
} xmlns_t;


typedef struct xmlns_pmap_t_ {
    dlq_hdr_t      qhdr;

    xmlns_id_t     nm_id;

    xmlChar       *nm_pfix;

    boolean        nm_topattr;
} xmlns_pmap_t;


/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/


extern void
    xmlns_init (void);


extern void
    xmlns_cleanup (void);


extern status_t
    xmlns_register_ns (const xmlChar *ns,
               const xmlChar *pfix,
               const xmlChar *modname,
               void *modptr,
               xmlns_id_t *ns_id);


extern void
    xmlns_unregister_ns (xmlns_id_t ns_id);


extern status_t
    xmlns_register_temp_ns (const xmlChar *ns,
                            const xmlChar *pfix,
                            xmlns_id_t *ns_id);


extern status_t
    xmlns_convert_temp_ns (xmlns_id_t nsid,
                           const xmlChar *pfix,
                           const xmlChar *modname,
                           void *modptr);


extern const xmlChar *
    xmlns_get_ns_prefix (xmlns_id_t ns_id);


extern const xmlChar *
    xmlns_get_ns_name (xmlns_id_t ns_id);


extern xmlns_id_t
    xmlns_find_ns_by_module (const xmlChar *modname);


extern xmlns_id_t
    xmlns_find_ns_by_prefix (const xmlChar *pfix);


extern xmlns_id_t
    xmlns_find_ns_by_name (const xmlChar *name);


extern xmlns_id_t
    xmlns_find_ns_by_name_str (const xmlChar *name,
                   uint32 namelen);


extern xmlns_id_t
    xmlns_nc_id (void);


extern xmlns_id_t
    xmlns_ncx_id (void);


extern xmlns_id_t
    xmlns_ns_id (void);


extern xmlns_id_t
    xmlns_inv_id (void);


extern xmlns_id_t
    xmlns_xs_id (void);


extern xmlns_id_t
    xmlns_xsi_id (void);


extern xmlns_id_t
    xmlns_xml_id (void);


extern xmlns_id_t
    xmlns_ncn_id (void);


extern xmlns_id_t
    xmlns_yang_id (void);


extern xmlns_id_t
    xmlns_yin_id (void);


extern xmlns_id_t
    xmlns_wildcard_id (void);


extern xmlns_id_t
    xmlns_wda_id (void);


extern xmlns_id_t
    xmlns_ywattrs_id (void);


extern xmlns_id_t
    xmlns_origin_id (void);


extern const xmlChar *
    xmlns_get_module (xmlns_id_t  nsid);


extern void *
    xmlns_get_modptr (xmlns_id_t nsid);


extern void
    xmlns_set_modptrs (const xmlChar *modname,
               void *modptr);


extern void
    xmlns_clear_modptrs (void *modptr);


extern xmlns_pmap_t *
    xmlns_new_pmap (uint32 buffsize);


extern void
    xmlns_free_pmap (xmlns_pmap_t *pmap);


extern xmlns_qname_t *
    xmlns_new_qname (void);


extern void
    xmlns_free_qname (xmlns_qname_t *qname);


extern boolean
    xmlns_ids_equal (xmlns_id_t ns1,
             xmlns_id_t ns2);

extern void
    xmlns_check_deleted_ns (void);


extern uint16
    xmlns_get_mod_count (void);


#ifdef __cplusplus
}  /* end extern 'C' */
#endif

#endif            /* _H_xmlns */