include/libxml/uri.h - master - niceSOFT/libxml2

include/libxml/uri.h
105 строк3 KB
Nick Wellnhofer
doc: Document struct typedefs
04 июл 2025, 17:47
04 июл 2025, 17:47c7a9ef1
/**
 * @file
 *
 * @brief library of generic URI related routines
 * 
 * library of generic URI related routines
 *              Implements RFC 2396
 *
 * @copyright See Copyright for the status of this software.
 *
 * @author Daniel Veillard
 */

#ifndef __XML_URI_H__
#define __XML_URI_H__

#include <stdio.h>
#include <libxml/xmlversion.h>
#include <libxml/xmlstring.h>

#ifdef __cplusplus
extern "C" {
#endif

/** Parsed URI */
typedef struct _xmlURI xmlURI;
typedef xmlURI *xmlURIPtr;
/**
 * A parsed URI reference.
 *
 * This is a struct containing the various fields
 * as described in RFC 2396 but separated for further processing.
 *
 * Note: query is a deprecated field which is incorrectly unescaped.
 * query_raw takes precedence over query if the former is set.
 * See: http://mail.gnome.org/archives/xml/2007-April/thread.html\#00127
 */
struct _xmlURI {
    char *scheme;	/* the URI scheme */
    char *opaque;	/* opaque part */
    char *authority;	/* the authority part */
    char *server;	/* the server part */
    char *user;		/* the user part */
    int port;		/* the port number */
    char *path;		/* the path string */
    char *query;	/* the query string (deprecated - use with caution) */
    char *fragment;	/* the fragment identifier */
    int  cleanup;	/* parsing potentially unclean URI */
    char *query_raw;	/* the query string (as it appears in the URI) */
};

XMLPUBFUN xmlURI *
		xmlCreateURI		(void);
XMLPUBFUN int
		xmlBuildURISafe		(const xmlChar *URI,
					 const xmlChar *base,
					 xmlChar **out);
XMLPUBFUN xmlChar *
		xmlBuildURI		(const xmlChar *URI,
					 const xmlChar *base);
XMLPUBFUN int
		xmlBuildRelativeURISafe	(const xmlChar *URI,
					 const xmlChar *base,
					 xmlChar **out);
XMLPUBFUN xmlChar *
		xmlBuildRelativeURI	(const xmlChar *URI,
					 const xmlChar *base);
XMLPUBFUN xmlURI *
		xmlParseURI		(const char *str);
XMLPUBFUN int
		xmlParseURISafe		(const char *str,
					 xmlURI **uri);
XMLPUBFUN xmlURI *
		xmlParseURIRaw		(const char *str,
					 int raw);
XMLPUBFUN int
		xmlParseURIReference	(xmlURI *uri,
					 const char *str);
XMLPUBFUN xmlChar *
		xmlSaveUri		(xmlURI *uri);
XMLPUBFUN void
		xmlPrintURI		(FILE *stream,
					 xmlURI *uri);
XMLPUBFUN xmlChar *
		xmlURIEscapeStr         (const xmlChar *str,
					 const xmlChar *list);
XMLPUBFUN char *
		xmlURIUnescapeString	(const char *str,
					 int len,
					 char *target);
XMLPUBFUN int
		xmlNormalizeURIPath	(char *path);
XMLPUBFUN xmlChar *
		xmlURIEscape		(const xmlChar *str);
XMLPUBFUN void
		xmlFreeURI		(xmlURI *uri);
XMLPUBFUN xmlChar*
		xmlCanonicPath		(const xmlChar *path);
XMLPUBFUN xmlChar*
		xmlPathToURI		(const xmlChar *path);

#ifdef __cplusplus
}
#endif
#endif /* __XML_URI_H__ */