epoc32/include/stdapis/libxml2/libxml2_uri.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2  * Summary: library of generic URI related routines
     3  * Description: library of generic URI related routines
     4  *              Implements RFC 2396
     5  *
     6  * Copy: See Copyright for the status of this software.
     7  *
     8  * Author: Daniel Veillard
     9  * Portion Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. 
    10  */
    11 
    12 /** @file
    13 @publishedAll
    14 @released
    15 */
    16 
    17 #ifndef XML_URI_H
    18 #define XML_URI_H
    19 
    20 #include <stdapis/libxml2/libxml2_xmlstring.h>
    21 
    22 #ifdef __cplusplus
    23 extern "C" {
    24 #endif
    25 
    26 /**
    27  * xmlURI:
    28  *
    29  * A parsed URI reference. This is a struct containing the various fields
    30  * as described in RFC 2396 but separated for further processing.
    31  */
    32 typedef struct _xmlURI xmlURI;
    33 typedef xmlURI *xmlURIPtr;
    34 struct _xmlURI {
    35     char *scheme;       /* the URI scheme */
    36     char *opaque;       /* opaque part */
    37     char *authority;    /* the authority part */
    38     char *server;       /* the server part */
    39     char *user;         /* the user part */
    40     int port;           /* the port number */
    41     char *path;         /* the path string */
    42     char *query;        /* the query string */
    43     char *fragment;     /* the fragment identifier */
    44     int  cleanup;       /* parsing potentially unclean URI */
    45 };
    46 
    47 /*
    48  * This function is in tree.h:
    49  * xmlChar *    xmlNodeGetBase  (xmlDocPtr doc,
    50  *                               xmlNodePtr cur);
    51  */
    52 XMLPUBFUN xmlURIPtr XMLCALL
    53                 xmlCreateURI            (void);
    54 XMLPUBFUN xmlChar * XMLCALL
    55                 xmlBuildURI             (const xmlChar *URI,
    56                                          const xmlChar *base);
    57 XMLPUBFUN xmlURIPtr XMLCALL
    58                 xmlParseURI             (const char *str);
    59 XMLPUBFUN int XMLCALL
    60                 xmlParseURIReference    (xmlURIPtr uri,
    61                                          const char *str);
    62 XMLPUBFUN xmlChar * XMLCALL
    63                 xmlSaveUri              (xmlURIPtr uri);
    64 
    65 #ifndef XMLENGINE_EXCLUDE_FILE_FUNC
    66 XMLPUBFUN void XMLCALL
    67                 xmlPrintURI             (FILE *stream,
    68                                          xmlURIPtr uri);
    69 #endif
    70 
    71 XMLPUBFUN xmlChar * XMLCALL
    72                 xmlURIEscapeStr         (const xmlChar *str,
    73                                          const xmlChar *list);
    74 XMLPUBFUN char * XMLCALL
    75                 xmlURIUnescapeString    (const char *str,
    76                                          int len,
    77                                          char *target);
    78 XMLPUBFUN int XMLCALL
    79                 xmlNormalizeURIPath     (char *path);
    80 XMLPUBFUN xmlChar * XMLCALL
    81                 xmlURIEscape            (const xmlChar *str);
    82 XMLPUBFUN void XMLCALL
    83                 xmlFreeURI              (xmlURIPtr uri);
    84 XMLPUBFUN xmlChar* XMLCALL
    85                 xmlCanonicPath          (const xmlChar *path);
    86 
    87 #ifdef __cplusplus
    88 }
    89 #endif
    90 #endif /* XML_URI_H */
    91