LibreOffice: rtl/uri.h Source File

LibreOffice LibreOffice 6.3 SDK C/C++ API Reference

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 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef INCLUDED_RTL_URI_H
21 #define INCLUDED_RTL_URI_H
22
23 #include "sal/config.h"
24
25 #include "rtl/textenc.h"
26 #include "rtl/ustring.h"
27 #include "sal/saldllapi.h"
28 #include "sal/types.h"
29
30 #if defined __cplusplus
31 extern "C" {
32 #endif /* __cplusplus */
33
45 typedef enum
46 {
51 rtl_UriCharClassNone,
52
60 rtl_UriCharClassUric,
61
68 rtl_UriCharClassUricNoSlash,
69
76 rtl_UriCharClassRelSegment,
77
84 rtl_UriCharClassRegName,
85
92 rtl_UriCharClassUserinfo,
93
100 rtl_UriCharClassPchar,
101
108 rtl_UriCharClassUnoParamValue,
109
110 rtl_UriCharClass_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
111 }
112 rtl_UriCharClass;
113
117 typedef enum
118 {
126 rtl_UriEncodeIgnoreEscapes,
127
137 rtl_UriEncodeKeepEscapes,
138
148 rtl_UriEncodeCheckEscapes,
149
155 rtl_UriEncodeStrict,
156
162 rtl_UriEncodeStrictKeepEscapes,
163
164 rtl_UriEncode_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
165 }
166 rtl_UriEncodeMechanism;
167
171 typedef enum
172 {
175 rtl_UriDecodeNone,
176
184 rtl_UriDecodeToIuri,
185
191 rtl_UriDecodeWithCharset,
192
198 rtl_UriDecodeStrict,
199
200 rtl_UriDecode_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
201 }
202 rtl_UriDecodeMechanism;
203
215 SAL_DLLPUBLIC sal_Bool const * SAL_CALL rtl_getUriCharClass(rtl_UriCharClass eCharClass)
216 SAL_THROW_EXTERN_C();
217
252 SAL_DLLPUBLIC void SAL_CALL rtl_uriEncode(
253 rtl_uString * pText,
254 sal_Bool const * pCharClass,
255 rtl_UriEncodeMechanism eMechanism,
256 rtl_TextEncoding eCharset,
257 rtl_uString ** pResult)
258 SAL_THROW_EXTERN_C();
259
290 SAL_DLLPUBLIC void SAL_CALL rtl_uriDecode(
291 rtl_uString * pText,
292 rtl_UriDecodeMechanism eMechanism,
293 rtl_TextEncoding eCharset,
294 rtl_uString ** pResult)
295 SAL_THROW_EXTERN_C();
296
327 SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_uriConvertRelToAbs(
328 rtl_uString * pBaseUriRef,
329 rtl_uString * pRelUriRef,
330 rtl_uString ** pResult,
331 rtl_uString ** pException)
332 SAL_THROW_EXTERN_C();
333
334 #if defined __cplusplus
335 }
336 #endif /* __cplusplus */
337
338 #endif // INCLUDED_RTL_URI_H
339
340 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
rtl_UriCharClassNone
@ rtl_UriCharClassNone
The empty char class.
Definition: uri.h:51
ustring.h
rtl_UriDecodeStrict
@ rtl_UriDecodeStrict
Like rtl_UriDecodeWithCharset, but indicating failure when converting unmappable characters.
Definition: uri.h:198
rtl_uriDecode
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.
rtl_UriEncodeKeepEscapes
@ rtl_UriEncodeKeepEscapes
All escape sequences ('' followed by two hex digits) are kept intact, even if they represent characte...
Definition: uri.h:137
rtl_UriDecodeToIuri
@ rtl_UriDecodeToIuri
The text is returned in the form of an IURI (cf.
Definition: uri.h:184
rtl_UriCharClassRegName
@ rtl_UriCharClassRegName
The RFC 2396 <reg_name> char class.
Definition: uri.h:84
rtl_TextEncoding
sal_uInt16 rtl_TextEncoding
The various supported text encodings.
Definition: textenc.h:33
saldllapi.h
rtl_UriDecodeNone
@ rtl_UriDecodeNone
The text is returned completely unmodified.
Definition: uri.h:175
rtl_UriEncodeCheckEscapes
@ rtl_UriEncodeCheckEscapes
All escape sequences ('' followed by two hex digits) are resolved in a first step; only those that re...
Definition: uri.h:148
rtl_UriDecode_FORCE_EQUAL_SIZE
@ rtl_UriDecode_FORCE_EQUAL_SIZE
Definition: uri.h:200
rtl_UriCharClassUricNoSlash
@ rtl_UriCharClassUricNoSlash
The RFC 2396 <uric_no_slash> char class.
Definition: uri.h:68
sal_Bool
unsigned char sal_Bool
Definition: types.h:38
config.h
rtl_UriEncode_FORCE_EQUAL_SIZE
@ rtl_UriEncode_FORCE_EQUAL_SIZE
Definition: uri.h:164
rtl_UriEncodeMechanism
rtl_UriEncodeMechanism
The mechanism describing how escape sequences in the input of rtl_uriEncode() are handled.
Definition: uri.h:118
rtl_UriCharClassUnoParamValue
@ rtl_UriCharClassUnoParamValue
The char class for the values of uno URL parameters.
Definition: uri.h:108
rtl_UriCharClassUserinfo
@ rtl_UriCharClassUserinfo
The RFC 2396 <userinfo> char class.
Definition: uri.h:92
rtl_UriDecodeWithCharset
@ rtl_UriDecodeWithCharset
The text is decoded.
Definition: uri.h:191
rtl_UriCharClass_FORCE_EQUAL_SIZE
@ rtl_UriCharClass_FORCE_EQUAL_SIZE
Definition: uri.h:110
types.h
rtl_uriConvertRelToAbs
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.
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
rtl_UriEncodeStrictKeepEscapes
@ rtl_UriEncodeStrictKeepEscapes
Like rtl_UriEncodeKeepEscapes, but indicating failure when converting unmappable characters.
Definition: uri.h:162
rtl_UriDecodeMechanism
rtl_UriDecodeMechanism
The mechanism describing how rtl_uriDecode() translates (part of) a URI into a Unicode string.
Definition: uri.h:172
textenc.h
rtl_getUriCharClass
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().
rtl_UriCharClassRelSegment
@ rtl_UriCharClassRelSegment
The RFC 2396 <rel_segment> char class.
Definition: uri.h:76
rtl_UriCharClass
rtl_UriCharClass
Various predefined URI 'char classes.
Definition: uri.h:46
SAL_MAX_ENUM
#define SAL_MAX_ENUM
Definition: types.h:223
rtl_UriCharClassPchar
@ rtl_UriCharClassPchar
The RFC 2396 <pchar> char class.
Definition: uri.h:100
rtl_UriEncodeStrict
@ rtl_UriEncodeStrict
Like rtl_UriEncodeIgnoreEscapes, but indicating failure when converting unmappable characters.
Definition: uri.h:155
rtl_UriCharClassUric
@ rtl_UriCharClassUric
The RFC 2732 <uric> char class.
Definition: uri.h:60
rtl_UriEncodeIgnoreEscapes
@ rtl_UriEncodeIgnoreEscapes
The special meaning of '' is ignored (i.e., there are by definition no escape sequences in the input)...
Definition: uri.h:126
rtl_uriEncode
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.
SAL_THROW_EXTERN_C
#define SAL_THROW_EXTERN_C()
Nothrow specification for C functions.
Definition: types.h:346