1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
/*
* This file is part of LibreOffice published API.
*/
#ifndef INCLUDED_CPPUHELPER_UNOURL_HXX
#define INCLUDED_CPPUHELPER_UNOURL_HXX
#include "sal/config.h"
#include "cppuhelper/cppuhelperdllapi.h"
namespace rtl
{
class OUString;
}
namespace cppu
{
/** A descriptor as part of a UNO URL (connection descriptor or protocol
descriptor).
Such a descriptor can also be useful outside the context of a full UNO URL.
For example, some functions take a string representing a connection or
protocol descriptor as input, and can use this class to parse the string.
*/
class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC UnoUrlDescriptor
{
public:
class Impl;
/** Construct a descriptor from a string representation.
@param rDescriptor
The string representation of a descriptor.
@exception rtl::MalformedUriException
Thrown when the given string representation is invalid.
*/
explicit UnoUrlDescriptor(rtl::OUString const& rDescriptor);
UnoUrlDescriptor(UnoUrlDescriptor const& rOther);
~UnoUrlDescriptor();
UnoUrlDescriptor& operator=(UnoUrlDescriptor const& rOther);
/** Return the string representation of the descriptor.
@return
A reference to the string representation used to construct this
descriptor, without any modifications. The reference is valid for the
lifetime of this URL object.
*/
rtl::OUString const& getDescriptor() const;
/** Return the name component of the descriptor.
@return
A reference to the (case insensitive) name, in lower case form. The
reference is valid for the lifetime of this URL object.
*/
rtl::OUString const& getName() const;
/** Test whether the parameters contain a key.
@param
rKey A (case insensitive) key.
@return
True if the parameters contain a matching key/value pair.
*/
bool hasParameter(rtl::OUString const& rKey) const;
/** Return the parameter value for a key.
@param
rKey A (case insensitive) key.
@return
The (case sensitive) value associated with the given key, or an empty
string if there is no matching key/value pair.
*/
rtl::OUString getParameter(rtl::OUString const& rKey) const;
private:
Impl* m_pImpl;
};
/** Parse UNO URLs into their components.
The ABNF for UNO URLs is as follows (see RFCs 2234, 2396, also see
<http://udk.openoffice.org/common/man/spec/uno-url.html>):
uno-url = "UNO:" connection ";" protocol ";" object-name
connection = descriptor
protocol = descriptor
descriptor = name *("," parameter)
name = 1*alphanum
parameter = key "=" value
key = 1*alphanum
value = *vchar
valchar = unreserved / escaped / "$" / "&" / "+" / "/" / ":" / "?" / "@"
object-name = 1*ochar
ochar = unreserved / "$" / "&" / "+" / "," / "/" / ":" / "=" / "?" / "@"
Within a descriptor, the name and the keys are case insensitive, and within
the parameter list all keys must be distinct.
Parameter values are encoded using UTF-8. Note that parsing of parameter
values as done by UnoUrl and UnoUrlDescriptor is not strict: Invalid UTF-16
entities in the input, as well as broken escape sequences ("%" not followed
by two hex digits) are copied verbatim to the output, invalid bytes in the
converted UTF-8 data are considered individual Unicode characters, and
invalid UTF-16 entities in the resulting output (e.g., a high surrogate not
followed by a low surrogate) are not detected.
*/
class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC UnoUrl
{
public:
/** Construct a UNO URL from a string representation.
@param rUrl
The string representation of a UNO URL.
@exception rtl::MalformedUriException
Thrown when the given string representation is invalid.
*/
explicit UnoUrl(rtl::OUString const& rUrl);
UnoUrl(UnoUrl const& rOther);
~UnoUrl();
UnoUrl& operator=(UnoUrl const& rOther);
/** Return the connection descriptor component of the URL.
@return
A reference to the connection descriptor. The reference is valid for
the lifetime of this URL object.
*/
UnoUrlDescriptor const& getConnection() const;
/** Return the protocol descriptor component of the URL.
@return
A reference to the protocol descriptor. The reference is valid for the
lifetime of this URL object.
*/
UnoUrlDescriptor const& getProtocol() const;
/** Return the object-name component of the URL.
@return
A reference to the (case sensitive) object-name. The reference is valid
for the lifetime of this URL object.
*/
rtl::OUString const& getObjectName() const;
private:
class Impl;
Impl* m_pImpl;
};
}
#endif // INCLUDED_RTL_UNOURL_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
