LibreOffice
LibreOffice 7.4 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 /*
21  * This file is part of LibreOffice published API.
22  */
23 
24 #ifndef INCLUDED_RTL_URI_H
25 #define INCLUDED_RTL_URI_H
26 
27 #include "sal/config.h"
28 
29 #include "rtl/textenc.h"
30 #include "rtl/ustring.h"
31 #include "sal/saldllapi.h"
32 #include "sal/types.h"
33 
34 #if defined __cplusplus
35 extern "C" {
36 #endif /* __cplusplus */
37 
49 typedef enum
50 {
56 
67 
78 
88 
98 
108 
118 
126 
128 }
130 
134 typedef enum
135 {
144 
155 
166 
173 
180 
182 }
184 
188 typedef enum
189 {
193 
202 
209 
216 
218 }
220 
234 
270  rtl_uString * pText,
271  sal_Bool const * pCharClass,
272  rtl_UriEncodeMechanism eMechanism,
273  rtl_TextEncoding eCharset,
274  rtl_uString ** pResult)
276 
308  rtl_uString * pText,
309  rtl_UriDecodeMechanism eMechanism,
310  rtl_TextEncoding eCharset,
311  rtl_uString ** pResult)
313 
345  rtl_uString * pBaseUriRef,
346  rtl_uString * pRelUriRef,
347  rtl_uString ** pResult,
348  rtl_uString ** pException)
350 
351 #if defined __cplusplus
352 }
353 #endif /* __cplusplus */
354 
355 #endif // INCLUDED_RTL_URI_H
356 
357 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_DLLPUBLIC
Definition: saldllapi.h:34
#define SAL_MAX_ENUM
Definition: types.h:205
unsigned char sal_Bool
Definition: types.h:38
#define SAL_THROW_EXTERN_C()
Nothrow specification for C functions.
Definition: types.h:334
sal_uInt16 rtl_TextEncoding
The various supported text encodings.
Definition: textenc.h:37
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_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_UriDecodeMechanism
The mechanism describing how rtl_uriDecode() translates (part of) a URI into a Unicode string.
Definition: uri.h:189
@ rtl_UriDecodeWithCharset
The text is decoded.
Definition: uri.h:208
@ rtl_UriDecodeToIuri
The text is returned in the form of an IURI (cf.
Definition: uri.h:201
@ rtl_UriDecode_FORCE_EQUAL_SIZE
Definition: uri.h:217
@ rtl_UriDecodeNone
The text is returned completely unmodified.
Definition: uri.h:192
@ rtl_UriDecodeStrict
Like rtl_UriDecodeWithCharset, but indicating failure when converting unmappable characters.
Definition: uri.h:215
rtl_UriEncodeMechanism
The mechanism describing how escape sequences in the input of rtl_uriEncode() are handled.
Definition: uri.h:135
@ rtl_UriEncodeStrict
Like rtl_UriEncodeIgnoreEscapes, but indicating failure when converting unmappable characters.
Definition: uri.h:172
@ rtl_UriEncodeIgnoreEscapes
The special meaning of '' is ignored (i.e., there are by definition no escape sequences in the input)...
Definition: uri.h:143
@ rtl_UriEncode_FORCE_EQUAL_SIZE
Definition: uri.h:181
@ rtl_UriEncodeStrictKeepEscapes
Like rtl_UriEncodeKeepEscapes, but indicating failure when converting unmappable characters.
Definition: uri.h:179
@ rtl_UriEncodeKeepEscapes
All escape sequences ('' followed by two hex digits) are kept intact, even if they represent characte...
Definition: uri.h:154
@ rtl_UriEncodeCheckEscapes
All escape sequences ('' followed by two hex digits) are resolved in a first step; only those that re...
Definition: uri.h:165
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().
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:50
@ rtl_UriCharClassRelSegment
The RFC 2396 <rel_segment> char class.
Definition: uri.h:87
@ rtl_UriCharClassPchar
The RFC 2396 <pchar> char class.
Definition: uri.h:117
@ rtl_UriCharClassUserinfo
The RFC 2396 <userinfo> char class.
Definition: uri.h:107
@ rtl_UriCharClassUnoParamValue
The char class for the values of uno URL parameters.
Definition: uri.h:125
@ rtl_UriCharClassNone
The empty char class.
Definition: uri.h:55
@ rtl_UriCharClass_FORCE_EQUAL_SIZE
Definition: uri.h:127
@ rtl_UriCharClassUricNoSlash
The RFC 2396 <uric_no_slash> char class.
Definition: uri.h:77
@ rtl_UriCharClassRegName
The RFC 2396 <reg_name> char class.
Definition: uri.h:97
@ rtl_UriCharClassUric
The RFC 2732 <uric> char class.
Definition: uri.h:66