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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
/* -*- 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 .
*/
#ifndef _COMPHELPER_LOCALE_HXX_
#define _COMPHELPER_LOCALE_HXX_
//_______________________________________________
// includes
#include <vector>
#include <rtl/ustring.hxx>
#include "comphelper/comphelperdllapi.h"
//_______________________________________________
// namespace
namespace comphelper{
//_______________________________________________
// definitions
/** @short A Locale object represents a specific geographical, political, or cultural region.
@descr This Locale class can be used to:
- provide the different parts of a Locale (Language, Country, Variant)
- converting it from/to ISO formated string values (like e.g. "en-US")
- provide some predefined (static) Locale objects
*/
class COMPHELPER_DLLPUBLIC Locale
{
//-------------------------------------------
// const
public:
/** @short seperates LANGUAGE and COUNTRY part of an ISO formated Locale. */
static const sal_Unicode SEPERATOR_LC;
/** @short seperates COUNTRY and VARIANT part of an ISO formated Locale. */
static const sal_Unicode SEPERATOR_CV;
/** @short seperates COUNTRY and VARIANT part of an ISO formated Locale.
@descr Its true for some linux derivates only :-( */
static const sal_Unicode SEPERATOR_CV_LINUX;
/** @short some predefined Locale objects. */
static const Locale EN_US();
static const Locale X_DEFAULT();
static const Locale X_NOTRANSLATE();
//-------------------------------------------
// types
public:
/** @short will be throw during convertion, if a Locale cant be interpreted. */
struct MalFormedLocaleException
{
public:
::rtl::OUString Message;
MalFormedLocaleException()
{}
MalFormedLocaleException(const ::rtl::OUString& sMessage)
: Message(sMessage)
{}
};
//-------------------------------------------
// member
private :
//---------------------------------------
/** @short must be a valid ISO Language Code.
@descr These codes are the lower-case two-letter codes as defined by ISO-639.
You can find a full list of these codes at a number of sites, such as:
<BR><a href ="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</a>
*/
::rtl::OUString m_sLanguage;
//---------------------------------------
/** @short must be a valid ISO Country Code.
@descr These codes are the upper-case two-letter codes as defined by ISO-3166.
You can find a full list of these codes at a number of sites, such as:
<BR><a href="http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html">
http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html</a>
*/
::rtl::OUString m_sCountry;
//---------------------------------------
/** @short Variant codes are vendor and browser-specific.
@descr For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX.
Where there are two variants, separate them with an underscore, and
put the most important one first. For example, a Traditional Spanish collation
might be referenced, with "ES", "ES", "Traditional_WIN".
*/
::rtl::OUString m_sVariant;
//-------------------------------------------
// interface
public :
//---------------------------------------
/** @short needed by outside users!
@descr Otherwise it wouldnt be possible to use
any instance of such Locale static ...
*/
Locale();
//---------------------------------------
/** @short construct a Locale from an ISO formated string value.
@seealso fromISO()
@param sISO
an ISO formated string value, which can be parsed and
tokenized into a Lamnguage, Country and Variant part.
@throw MalFormedLocaleException
if conversion failed.
*/
Locale(const ::rtl::OUString& sISO)
throw(MalFormedLocaleException);
//---------------------------------------
/** @short construct a Locale from language, country and variant.
@seealso setLanguage()
@seealso setCountry()
@seealso setVariant()
@param sLanguage
lowercase two-letter ISO-639 code.
@param sCountry
uppercase two-letter ISO-3166 code.
@param sVariant
vendor and browser specific code.
*/
Locale(const ::rtl::OUString& sLanguage ,
const ::rtl::OUString& sCountry ,
const ::rtl::OUString& sVariant = ::rtl::OUString());
//---------------------------------------
/** @short copy constructor.
@param aCopy
the copy object.
*/
Locale(const Locale& aCopy);
//---------------------------------------
/** @short returns the language code for this locale.
@descr That will either be the empty string or
a lowercase ISO 639 code.
@return [string]
the language code.
*/
::rtl::OUString getLanguage() const;
//---------------------------------------
/** @short returns the country/region code for this locale.
@descr That will either be the empty string or an
upercase ISO 3166 2-letter code.
@return [string]
the country code.
*/
::rtl::OUString getCountry() const;
//---------------------------------------
/** @short returns the variant code for this locale.
@return [string]
the variant code.
*/
::rtl::OUString getVariant() const;
//---------------------------------------
/** @short set the new language code for this locale.
@descr That will either be the empty string or
a lowercase ISO 639 code.
@param sLanguage
the language code.
*/
void setLanguage(const ::rtl::OUString& sLanguage);
//---------------------------------------
/** @short set the new country/region code for this locale.
@descr That will either be the empty string or an
upercase ISO 3166 2-letter code.
@param sCountry
the country code.
*/
void setCountry(const ::rtl::OUString& sCountry);
//---------------------------------------
/** @short set the new variant code for this locale.
@param sVariant
the variant code.
*/
void setVariant(const ::rtl::OUString& sVariant);
//---------------------------------------
/** @short take over new Locale informations.
@seealso Locale(const ::rtl::OUString& sISO)
@param sISO
an ISO formated string value, which can be parsed and
tokenized into a Lamnguage, Country and Variant part.
e.g. "en-US" or "en-US_WIN"
@throw MalFormedLocaleException
if conversion failed.
*/
void fromISO(const ::rtl::OUString& sISO)
throw(MalFormedLocaleException);
//---------------------------------------
/** @short converts this Locale to an ISO formated string value.
@descr The different parts of this Locale will be assempled
e.g. to "en-US" or "en-US_WIN"
@return [string]
the ISO formated string.
*/
::rtl::OUString toISO() const;
//---------------------------------------
/** @short check, if two Locale objects are equals.
@descr All parts of a Locale (means Language, Country and Variant)
will be checked.
@param aComparable
the Locale object for compare.
@return [boolean]
TRUE if both objects uses the same values for
Language, Country and Variant.
*/
sal_Bool equals(const Locale& aComparable) const;
//---------------------------------------
/** @short check, if two Locale objects
uses the same language.
@descr The Country and Variant parts of a Locale
wont be checked here.
@return [boolean]
TRUE if both objects uses the same
Language value.
*/
sal_Bool similar(const Locale& aComparable) const;
//---------------------------------------
/** @short search for an equal or at least for a similar
Locale in a list of possible ones.
@descr First it searches for a Locale, which is equals
to the reference Locale.
(means: same Language, Country, Variant)
If the reference Locale couldnt be located, it will
tried again - but we are checking for "similar" Locales then.
(means: same Language)
If no similar Locale could be located, we search
for a Locale "en-US" inside the given Locale list.
If "en-US" could not be located, we search for
a Locale "en" inside the given list.
If no "same" nor any "similar" locale could be found,
we try "x-default" and "x-notranslate" explicitly.
Sometimes localized variables are optimized and doesnt use
localzation realy. E.g. in case the localized value is a fix
product name.
If no locale match till now, we use any other existing
locale, which exists inside the set of given ones!
@seealso equals()
@seealso similar()
@param lISOList
the list of possible Locales
(as formated ISO strings).
@param sReferenceISO
the reference Locale, which should be searched
if its equals or similar to any Locale inside
the provided Locale list.
@return An iterator, which points to the found element
inside the given Locale list.
If no matching Locale could be found, it points
to the end of the list.
@throw [MalFormedLocaleException]
if at least one ISO formated string couldnt
be converted to a valid Locale Object.
*/
static ::std::vector< ::rtl::OUString >::const_iterator getFallback(const ::std::vector< ::rtl::OUString >& lISOList ,
const ::rtl::OUString& sReferenceISO)
throw(MalFormedLocaleException);
//---------------------------------------
/** @short assign elements of another locale
to this instance.
@param rCopy
another locale object.
*/
void operator=(const Locale& rCopy);
//---------------------------------------
/** @short check if two Locale objects are equals.
@seealso equals()
@param aComparable
the Locale object for compare.
@return [boolean]
TRUE if both objects uses the same values for
Language, Country and Variant.
*/
sal_Bool operator==(const Locale& aComparable) const;
//---------------------------------------
/** @short check if two Locale objects are different.
@param aComparable
the Locale object for compare.
@return [boolean]
TRUE if at least one part of such Locale
isnt the same.
*/
sal_Bool operator!=(const Locale& aComparable) const;
};
} // namespace salhelper
#endif // _COMPHELPER_LOCALE_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|