uriparser
0.8.1
|
Data Structures | |
struct | UriTextRangeStructA |
struct | UriPathSegmentStructA |
struct | UriHostDataStructA |
struct | UriUriStructA |
struct | UriParserStateStructA |
struct | UriQueryListStructA |
Typedefs | |
typedef struct UriTextRangeStructA | UriTextRangeA |
typedef struct UriPathSegmentStructA | UriPathSegmentA |
typedef struct UriHostDataStructA | UriHostDataA |
typedef struct UriUriStructA | UriUriA |
typedef struct UriParserStateStructA | UriParserStateA |
typedef struct UriQueryListStructA | UriQueryListA |
Functions | |
int | uriParseUriExA (UriParserStateA *state, const char *first, const char *afterLast) |
int | uriParseUriA (UriParserStateA *state, const char *text) |
void | uriFreeUriMembersA (UriUriA *uri) |
char * | uriEscapeExA (const char *inFirst, const char *inAfterLast, char *out, UriBool spaceToPlus, UriBool normalizeBreaks) |
char * | uriEscapeA (const char *in, char *out, UriBool spaceToPlus, UriBool normalizeBreaks) |
const char * | uriUnescapeInPlaceExA (char *inout, UriBool plusToSpace, UriBreakConversion breakConversion) |
const char * | uriUnescapeInPlaceA (char *inout) |
int | uriAddBaseUriA (UriUriA *absoluteDest, const UriUriA *relativeSource, const UriUriA *absoluteBase) |
int | uriAddBaseUriExA (UriUriA *absoluteDest, const UriUriA *relativeSource, const UriUriA *absoluteBase, UriResolutionOptions options) |
int | uriRemoveBaseUriA (UriUriA *dest, const UriUriA *absoluteSource, const UriUriA *absoluteBase, UriBool domainRootMode) |
UriBool | uriEqualsUriA (const UriUriA *a, const UriUriA *b) |
int | uriToStringCharsRequiredA (const UriUriA *uri, int *charsRequired) |
int | uriToStringA (char *dest, const UriUriA *uri, int maxChars, int *charsWritten) |
unsigned int | uriNormalizeSyntaxMaskRequiredA (const UriUriA *uri) |
int | uriNormalizeSyntaxExA (UriUriA *uri, unsigned int mask) |
int | uriNormalizeSyntaxA (UriUriA *uri) |
int | uriUnixFilenameToUriStringA (const char *filename, char *uriString) |
int | uriWindowsFilenameToUriStringA (const char *filename, char *uriString) |
int | uriUriStringToUnixFilenameA (const char *uriString, char *filename) |
int | uriUriStringToWindowsFilenameA (const char *uriString, char *filename) |
int | uriComposeQueryCharsRequiredA (const UriQueryListA *queryList, int *charsRequired) |
int | uriComposeQueryCharsRequiredExA (const UriQueryListA *queryList, int *charsRequired, UriBool spaceToPlus, UriBool normalizeBreaks) |
int | uriComposeQueryA (char *dest, const UriQueryListA *queryList, int maxChars, int *charsWritten) |
int | uriComposeQueryExA (char *dest, const UriQueryListA *queryList, int maxChars, int *charsWritten, UriBool spaceToPlus, UriBool normalizeBreaks) |
int | uriComposeQueryMallocA (char **dest, const UriQueryListA *queryList) |
int | uriComposeQueryMallocExA (char **dest, const UriQueryListA *queryList, UriBool spaceToPlus, UriBool normalizeBreaks) |
int | uriDissectQueryMallocA (UriQueryListA **dest, int *itemCount, const char *first, const char *afterLast) |
int | uriDissectQueryMallocExA (UriQueryListA **dest, int *itemCount, const char *first, const char *afterLast, UriBool plusToSpace, UriBreakConversion breakConversion) |
void | uriFreeQueryListA (UriQueryListA *queryList) |
Holds the RFC 3986 URI parser interface. NOTE: This header includes itself twice.
typedef struct UriHostDataStructA UriHostDataA |
Holds structured host information. This is either a IPv4, IPv6, plain text for IPvFuture or all zero for a registered name.
typedef struct UriParserStateStructA UriParserStateA |
Represents a state of the URI parser. Missing components can be NULL to reflect a components absence.
typedef struct UriPathSegmentStructA UriPathSegmentA |
typedef struct UriQueryListStructA UriQueryListA |
Represents a query element. More precisely it is a node in a linked list of query elements.
typedef struct UriTextRangeStructA UriTextRangeA |
Specifies a range of characters within a string. The range includes all characters from first
to one before afterLast
. So if both are non-NULL the difference is the length of the text range.
first
to one before afterLast
. So if both are non-NULL the difference is the length of the text range.typedef struct UriUriStructA UriUriA |
Represents an RFC 3986 URI. Missing components can be {NULL, NULL} ranges.
int uriAddBaseUriA | ( | UriUriA * | absoluteDest, |
const UriUriA * | relativeSource, | ||
const UriUriA * | absoluteBase | ||
) |
Performs reference resolution as described in section 5.2.2 of RFC 3986. NOTE: On success you have to call uriFreeUriMembersA on absoluteDest
manually later.
absoluteDest | OUT: Result URI |
relativeSource | IN: Reference to resolve |
absoluteBase | IN: Base URI to apply |
int uriAddBaseUriExA | ( | UriUriA * | absoluteDest, |
const UriUriA * | relativeSource, | ||
const UriUriA * | absoluteBase, | ||
UriResolutionOptions | options | ||
) |
Performs reference resolution as described in section 5.2.2 of RFC 3986. NOTE: On success you have to call uriFreeUriMembersA on absoluteDest
manually later.
absoluteDest | OUT: Result URI |
relativeSource | IN: Reference to resolve |
absoluteBase | IN: Base URI to apply |
options | IN: Configuration to apply |
int uriComposeQueryA | ( | char * | dest, |
const UriQueryListA * | queryList, | ||
int | maxChars, | ||
int * | charsWritten | ||
) |
Converts a query list structure back to a query string. The composed string does not start with '?', on the way ' ' is converted to '+' and line breaks are normalized to "%0D%0A".
dest | OUT: Output destination |
queryList | IN: Query list to convert |
maxChars | IN: Maximum number of characters to copy including terminator |
charsWritten | OUT: Number of characters written, can be lower than maxChars even if the query list is too long! |
int uriComposeQueryCharsRequiredA | ( | const UriQueryListA * | queryList, |
int * | charsRequired | ||
) |
Calculates the number of characters needed to store the string representation of the given query list excluding the terminator. It is assumed that line breaks are will be normalized to "%0D%0A".
queryList | IN: Query list to measure |
charsRequired | OUT: Length of the string representation in characters excluding terminator |
int uriComposeQueryCharsRequiredExA | ( | const UriQueryListA * | queryList, |
int * | charsRequired, | ||
UriBool | spaceToPlus, | ||
UriBool | normalizeBreaks | ||
) |
Calculates the number of characters needed to store the string representation of the given query list excluding the terminator.
queryList | IN: Query list to measure |
charsRequired | OUT: Length of the string representation in characters excluding terminator |
spaceToPlus | IN: Wether to convert ' ' to '+' or not |
normalizeBreaks | IN: Wether to convert CR and LF to CR-LF or not. |
int uriComposeQueryExA | ( | char * | dest, |
const UriQueryListA * | queryList, | ||
int | maxChars, | ||
int * | charsWritten, | ||
UriBool | spaceToPlus, | ||
UriBool | normalizeBreaks | ||
) |
Converts a query list structure back to a query string. The composed string does not start with '?'.
dest | OUT: Output destination |
queryList | IN: Query list to convert |
maxChars | IN: Maximum number of characters to copy including terminator |
charsWritten | OUT: Number of characters written, can be lower than maxChars even if the query list is too long! |
spaceToPlus | IN: Wether to convert ' ' to '+' or not |
normalizeBreaks | IN: Wether to convert CR and LF to CR-LF or not. |
int uriComposeQueryMallocA | ( | char ** | dest, |
const UriQueryListA * | queryList | ||
) |
Converts a query list structure back to a query string. Memory for this string is allocated internally. The composed string does not start with '?', on the way ' ' is converted to '+' and line breaks are normalized to "%0D%0A".
dest | OUT: Output destination |
queryList | IN: Query list to convert |
int uriComposeQueryMallocExA | ( | char ** | dest, |
const UriQueryListA * | queryList, | ||
UriBool | spaceToPlus, | ||
UriBool | normalizeBreaks | ||
) |
Converts a query list structure back to a query string. Memory for this string is allocated internally. The composed string does not start with '?'.
dest | OUT: Output destination |
queryList | IN: Query list to convert |
spaceToPlus | IN: Wether to convert ' ' to '+' or not |
normalizeBreaks | IN: Wether to convert CR and LF to CR-LF or not. |
int uriDissectQueryMallocA | ( | UriQueryListA ** | dest, |
int * | itemCount, | ||
const char * | first, | ||
const char * | afterLast | ||
) |
Constructs a query list from the raw query string of a given URI. On the way '+' is converted back to ' ', line breaks are not modified.
dest | OUT: Output destination |
itemCount | OUT: Number of items found, can be NULL |
first | IN: Pointer to first character after '?' |
afterLast | IN: Pointer to character after the last one still in |
int uriDissectQueryMallocExA | ( | UriQueryListA ** | dest, |
int * | itemCount, | ||
const char * | first, | ||
const char * | afterLast, | ||
UriBool | plusToSpace, | ||
UriBreakConversion | breakConversion | ||
) |
Constructs a query list from the raw query string of a given URI.
dest | OUT: Output destination |
itemCount | OUT: Number of items found, can be NULL |
first | IN: Pointer to first character after '?' |
afterLast | IN: Pointer to character after the last one still in |
plusToSpace | IN: Whether to convert '+' to ' ' or not |
breakConversion | IN: Line break conversion mode |
Checks two URIs for equivalence. Comparison is done the naive way, without prior normalization. NOTE: Two NULL
URIs are equal as well.
a | IN: First URI |
b | IN: Second URI |
URI_TRUE
when equal, URI_FAlSE
elsePercent-encodes all unreserved characters from the input string and writes the encoded version to the output string. Be sure to allocate 3 times the space of the input buffer for the output buffer for normalizeBreaks == URI_FALSE
and 6 times the space for normalizeBreaks == URI_TRUE
(since e.g. "\x0d" becomes "%0D%0A" in that case)
in | IN: Text source |
out | OUT: Encoded text destination |
spaceToPlus | IN: Wether to convert ' ' to '+' or not |
normalizeBreaks | IN: Wether to convert CR and LF to CR-LF or not. |
char* uriEscapeExA | ( | const char * | inFirst, |
const char * | inAfterLast, | ||
char * | out, | ||
UriBool | spaceToPlus, | ||
UriBool | normalizeBreaks | ||
) |
Percent-encodes all unreserved characters from the input string and writes the encoded version to the output string. Be sure to allocate 3 times the space of the input buffer for the output buffer for normalizeBreaks == URI_FALSE
and 6 times the space for normalizeBreaks == URI_TRUE
(since e.g. "\x0d" becomes "%0D%0A" in that case)
inFirst | IN: Pointer to first character of the input text |
inAfterLast | IN: Pointer after the last character of the input text |
out | OUT: Encoded text destination |
spaceToPlus | IN: Wether to convert ' ' to '+' or not |
normalizeBreaks | IN: Wether to convert CR and LF to CR-LF or not. |
void uriFreeQueryListA | ( | UriQueryListA * | queryList | ) |
Frees all memory associated with the given query list. The structure itself is freed as well.
queryList | INOUT: Query list to free |
void uriFreeUriMembersA | ( | UriUriA * | uri | ) |
Frees all memory associated with the members of the URI structure. Note that the structure itself is not freed, only its members.
uri | INOUT: URI structure whose members should be freed |
int uriNormalizeSyntaxA | ( | UriUriA * | uri | ) |
Normalizes all components of a URI.
NOTE: If necessary the URI becomes owner of all memory behind the text pointed to. Text is duplicated in that case.
uri | INOUT: URI to normalize |
int uriNormalizeSyntaxExA | ( | UriUriA * | uri, |
unsigned int | mask | ||
) |
Normalizes a URI using a normalization mask. The normalization mask decides what components are normalized.
NOTE: If necessary the URI becomes owner of all memory behind the text pointed to. Text is duplicated in that case.
uri | INOUT: URI to normalize |
mask | IN: Normalization mask |
unsigned int uriNormalizeSyntaxMaskRequiredA | ( | const UriUriA * | uri | ) |
Determines the components of a URI that are not normalized.
uri | IN: URI to check |
int uriParseUriA | ( | UriParserStateA * | state, |
const char * | text | ||
) |
Parses a RFC 3986 URI.
state | INOUT: Parser state with set output URI, must not be NULL |
text | IN: Text to parse, must not be NULL |
int uriParseUriExA | ( | UriParserStateA * | state, |
const char * | first, | ||
const char * | afterLast | ||
) |
Parses a RFC 3986 URI.
state | INOUT: Parser state with set output URI, must not be NULL |
first | IN: Pointer to the first character to parse, must not be NULL |
afterLast | IN: Pointer to the character after the last to parse, must not be NULL |
int uriRemoveBaseUriA | ( | UriUriA * | dest, |
const UriUriA * | absoluteSource, | ||
const UriUriA * | absoluteBase, | ||
UriBool | domainRootMode | ||
) |
Tries to make a relative URI (a reference) from an absolute URI and a given base URI. This can only work if the absolute URI shares scheme and authority with the base URI. If it does not the result will still be an absolute URI (with scheme part if necessary). NOTE: On success you have to call uriFreeUriMembersA on dest
manually later.
dest | OUT: Result URI |
absoluteSource | IN: Absolute URI to make relative |
absoluteBase | IN: Base URI |
domainRootMode | IN: Create URI with path relative to domain root |
int uriToStringA | ( | char * | dest, |
const UriUriA * | uri, | ||
int | maxChars, | ||
int * | charsWritten | ||
) |
Converts a URI structure back to text as described in section 5.3 of RFC 3986.
dest | OUT: Output destination |
uri | IN: URI to convert |
maxChars | IN: Maximum number of characters to copy including terminator |
charsWritten | OUT: Number of characters written, can be lower than maxChars even if the URI is too long! |
int uriToStringCharsRequiredA | ( | const UriUriA * | uri, |
int * | charsRequired | ||
) |
Calculates the number of characters needed to store the string representation of the given URI excluding the terminator.
uri | IN: URI to measure |
charsRequired | OUT: Length of the string representation in characters excluding terminator |
const char* uriUnescapeInPlaceA | ( | char * | inout | ) |
Unescapes percent-encoded groups in a given string. E.g. "%20" will become " ". Unescaping is done in place. The return value will be point to the new position of the terminating zero. Use this value to get the new length of the string. NULL is only returned if inout
is NULL.
NOTE: '+' is not decoded to ' ' and line breaks are not converted. Use the more advanced UnescapeInPlaceEx for that features instead.
inout | INOUT: Text to unescape/decode |
const char* uriUnescapeInPlaceExA | ( | char * | inout, |
UriBool | plusToSpace, | ||
UriBreakConversion | breakConversion | ||
) |
Unescapes percent-encoded groups in a given string. E.g. "%20" will become " ". Unescaping is done in place. The return value will be point to the new position of the terminating zero. Use this value to get the new length of the string. NULL is only returned if inout
is NULL.
inout | INOUT: Text to unescape/decode |
plusToSpace | IN: Whether to convert '+' to ' ' or not |
breakConversion | IN: Line break conversion mode |
int uriUnixFilenameToUriStringA | ( | const char * | filename, |
char * | uriString | ||
) |
Converts a Unix filename to a URI string. The destination buffer must be large enough to hold 7 + 3 * len(filename) + 1 characters in case of an absolute filename or 3 * len(filename) + 1 in case of a relative filename.
EXAMPLE Input: "/bin/bash" Output: "file:///bin/bash"
filename | IN: Unix filename to convert |
uriString | OUT: Destination to write URI string to |
int uriUriStringToUnixFilenameA | ( | const char * | uriString, |
char * | filename | ||
) |
Extracts a Unix filename from a URI string. The destination buffer must be large enough to hold len(uriString) + 1 - 7 characters in case of an absolute URI or len(uriString) + 1 in case of a relative URI.
uriString | IN: URI string to convert |
filename | OUT: Destination to write filename to |
int uriUriStringToWindowsFilenameA | ( | const char * | uriString, |
char * | filename | ||
) |
Extracts a Windows filename from a URI string. The destination buffer must be large enough to hold len(uriString) + 1 - 8 characters in case of an absolute URI or len(uriString) + 1 in case of a relative URI.
uriString | IN: URI string to convert |
filename | OUT: Destination to write filename to |
int uriWindowsFilenameToUriStringA | ( | const char * | filename, |
char * | uriString | ||
) |
Converts a Windows filename to a URI string. The destination buffer must be large enough to hold 8 + 3 * len(filename) + 1 characters in case of an absolute filename or 3 * len(filename) + 1 in case of a relative filename.
EXAMPLE Input: "E:\\Documents and Settings" Output: "file:///E:/Documents%20and%20Settings"
filename | IN: Windows filename to convert |
uriString | OUT: Destination to write URI string to |