AlterOffice
AlterOffice 3.4 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
uri.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 
3 
4 #ifndef INCLUDED_RTL_URI_H
5 #define INCLUDED_RTL_URI_H
6 
7 #include "sal/config.h"
8 
9 #include "rtl/textenc.h"
10 #include "rtl/ustring.h"
11 #include "sal/saldllapi.h"
12 #include "sal/types.h"
13 
14 #if defined __cplusplus
15 extern "C" {
16 #endif /* __cplusplus */
17 
29 typedef enum
30 {
36 
47 
58 
68 
78 
88 
98 
106 
108 }
110 
114 typedef enum
115 {
124 
135 
146 
153 
160 
162 }
164 
168 typedef enum
169 {
173 
182 
189 
196 
198 }
200 
212 SAL_DLLPUBLIC sal_Bool const * SAL_CALL rtl_getUriCharClass(rtl_UriCharClass eCharClass)
214 
249 SAL_DLLPUBLIC void SAL_CALL rtl_uriEncode(
250  rtl_uString * pText,
251  sal_Bool const * pCharClass,
252  rtl_UriEncodeMechanism eMechanism,
253  rtl_TextEncoding eCharset,
254  rtl_uString ** pResult)
256 
287 SAL_DLLPUBLIC void SAL_CALL rtl_uriDecode(
288  rtl_uString * pText,
289  rtl_UriDecodeMechanism eMechanism,
290  rtl_TextEncoding eCharset,
291  rtl_uString ** pResult)
293 
325  rtl_uString * pBaseUriRef,
326  rtl_uString * pRelUriRef,
327  rtl_uString ** pResult,
328  rtl_uString ** pException)
330 
331 #if defined __cplusplus
332 }
333 #endif /* __cplusplus */
334 
335 #endif // INCLUDED_RTL_URI_H
336 
337 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
The text is returned completely unmodified.
Definition: uri.h:172
SAL_DLLPUBLIC void rtl_uriDecode(rtl_uString *pText, rtl_UriDecodeMechanism eMechanism, rtl_TextEncoding eCharset, rtl_uString **pResult) SAL_THROW_EXTERN_C()
Decode (a part of) a URI.
SAL_DLLPUBLIC sal_Bool const * rtl_getUriCharClass(rtl_UriCharClass eCharClass) SAL_THROW_EXTERN_C()
Map a predefined rtl_UriCharClass to a form usable by rtl_uriEncode().
unsigned char sal_Bool
Definition: types.h:18
The RFC 2396 <userinfo> char class.
Definition: uri.h:87
The char class for the values of uno URL parameters.
Definition: uri.h:105
rtl_UriDecodeMechanism
The mechanism describing how rtl_uriDecode() translates (part of) a URI into a Unicode string...
Definition: uri.h:168
sal_uInt16 rtl_TextEncoding
The various supported text encodings.
Definition: textenc.h:17
All escape sequences ('' followed by two hex digits) are resolved in a first step; only those that re...
Definition: uri.h:145
The RFC 2732 <uric> char class.
Definition: uri.h:46
The text is decoded.
Definition: uri.h:188
The special meaning of '' is ignored (i.e., there are by definition no escape sequences in the input)...
Definition: uri.h:123
The RFC 2396 <rel_segment> char class.
Definition: uri.h:67
The RFC 2396 <uric_no_slash> char class.
Definition: uri.h:57
The text is returned in the form of an IURI (cf.
Definition: uri.h:181
All escape sequences ('' followed by two hex digits) are kept intact, even if they represent characte...
Definition: uri.h:134
CPPU_DLLPUBLIC void SAL_THROW_EXTERN_C()
This method is called to wait for a reply of a previously sent request.
Like rtl_UriDecodeWithCharset, but indicating failure when converting unmappable characters.
Definition: uri.h:195
Like rtl_UriEncodeKeepEscapes, but indicating failure when converting unmappable characters.
Definition: uri.h:159
SAL_DLLPUBLIC sal_Bool rtl_uriConvertRelToAbs(rtl_uString *pBaseUriRef, rtl_uString *pRelUriRef, rtl_uString **pResult, rtl_uString **pException) SAL_THROW_EXTERN_C()
Convert a relative URI reference into an absolute URI.
rtl_UriCharClass
Various predefined URI 'char classes.
Definition: uri.h:29
Definition: uri.h:161
rtl_UriEncodeMechanism
The mechanism describing how escape sequences in the input of rtl_uriEncode() are handled...
Definition: uri.h:114
Like rtl_UriEncodeIgnoreEscapes, but indicating failure when converting unmappable characters...
Definition: uri.h:152
#define SAL_MAX_ENUM
Definition: types.h:185
The RFC 2396 <pchar> char class.
Definition: uri.h:97
The RFC 2396 <reg_name> char class.
Definition: uri.h:77
SAL_DLLPUBLIC void rtl_uriEncode(rtl_uString *pText, sal_Bool const *pCharClass, rtl_UriEncodeMechanism eMechanism, rtl_TextEncoding eCharset, rtl_uString **pResult) SAL_THROW_EXTERN_C()
Encode a text as (part of) a URI.
Definition: uri.h:197
The empty char class.
Definition: uri.h:35
#define SAL_DLLPUBLIC
Definition: saldllapi.h:14