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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
|
/* -*- 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/.
*/
#ifndef INCLUDED_I18NLANGTAG_LANGUAGETAG_HXX
#define INCLUDED_I18NLANGTAG_LANGUAGETAG_HXX
#include <sal/config.h>
#include <rtl/ustring.hxx>
#include <com/sun/star/lang/Locale.hpp>
#include <i18nlangtag/i18nlangtagdllapi.h>
#include <i18nlangtag/lang.h>
#include <vector>
typedef struct _rtl_Locale rtl_Locale; // as in rtl/locale.h
/** The ISO 639-2 code reserved for local use used to indicate that a
com::sun::star::Locale contains a BCP 47 string in its Variant field. The
Locale's Language field then will contain this language code.
@see LanguageTag::getLocale()
Avoid use, only needed internally or if conversion from Locale to
LanguageTag is not wanted, i.e. during ODF import. To check whether a
LanguageTag contains a plain language/country combination or a more
detailed BCP 47 language tag use LanguageTag::isIsoLocale() instead.
*/
#define I18NLANGTAG_QLT "qlt"
/** Wrapper for liblangtag BCP 47 language tags, MS-LangIDs, locales and
conversions in between.
Note that member variables are mutable and may change their values even in
const methods. Getter methods return either the original value or matching
converted values.
For standalone conversions if no LanguageTag instance is at hand, static
convertTo...() methods exist.
*/
class I18NLANGTAG_DLLPUBLIC LanguageTag
{
public:
/** Init LanguageTag with existing BCP 47 language tag string.
@param bCanonicalize
If TRUE, canonicalize tag and reparse, the resulting tag string may
be different.
IF FALSE, the tag is simply stored and can be retrieved with
getBcp47().
Note that conversions to ISO codes, locales or LanguageType or
obtaining language or script will canonicalize the tag string anyway,
so specifying bCanonicalize=false is not a guarantee that the tag will
stay identical to what was passed.
*/
explicit LanguageTag( const OUString & rBcp47LanguageTag, bool bCanonicalize = false );
/** Init LanguageTag with Locale. */
explicit LanguageTag( const com::sun::star::lang::Locale & rLocale );
/** Init LanguageTag with LanguageType MS-LangID. */
explicit LanguageTag( LanguageType nLanguage );
/** Init LanguageTag with either BCP 47 language tag (precedence if not
empty), or a combination of language, script and country.
This is a convenience ctor to be used in ODF import where these are
distinct attributes.
*/
explicit LanguageTag( const OUString& rBcp47, const OUString& rLanguage,
const OUString& rScript, const OUString& rCountry );
/** Init LanguageTag with rtl_Locale.
This is a convenience ctor.
*/
explicit LanguageTag( const rtl_Locale & rLocale );
LanguageTag( const LanguageTag & rLanguageTag );
~LanguageTag();
LanguageTag& operator=( const LanguageTag & rLanguageTag );
/** Obtain BCP 47 language tag.
@param bResolveSystem
If TRUE, resolve an empty language tag denoting the system
locale to the real locale used.
If FALSE, return an empty OUString for such a tag.
*/
const OUString & getBcp47( bool bResolveSystem = true ) const;
/** Obtain language tag as Locale.
As a convention, language tags that can not be expressed as "pure"
com::sun::star::lang::Locale content using Language and Country fields
store "qlt" (ISO 639 reserved for local use) in the Language field and
the entire BCP 47 language tag in the Variant field. The Country field
contains the corresponding ISO 3166 country code _if_ there is one, or
otherwise is empty.
@param bResolveSystem
If TRUE, resolve an empty language tag denoting the system
locale to the real locale used.
If FALSE, return an empty Locale for such a tag.
*/
const com::sun::star::lang::Locale & getLocale( bool bResolveSystem = true ) const;
/** Obtain mapping to MS-LangID.
@param bResolveSystem
If TRUE, resolve an empty language tag denoting the system
locale to the real locale used.
If FALSE, return LANGUAGE_SYSTEM for such a tag.
*/
LanguageType getLanguageType( bool bResolveSystem = true ) const;
/** Obtain ISO strings for language, script and country.
This is a convenience method for ODF export places only. Avoid use in
other code.
ATTENTION! May return empty strings if the language tag is not
expressable in valid ISO codes!
@see isIsoODF()
Always resolves an empty tag to the system locale.
*/
void getIsoLanguageScriptCountry( OUString& rLanguage,
OUString& rScript, OUString& rCountry ) const;
/** Get ISO 639 language code, or BCP 47 language.
Always resolves an empty tag to the system locale.
*/
OUString getLanguage() const;
/** Get ISO 15924 script code, if not the default script according to
BCP 47. For default script an empty string is returned.
@see hasScript()
Always resolves an empty tag to the system locale.
*/
OUString getScript() const;
/** Get combined language and script code, separated by '-' if
non-default script, if default script only language.
@see hasScript()
Always resolves an empty tag to the system locale.
*/
OUString getLanguageAndScript() const;
/** Get ISO 3166 country alpha code. Empty if the BCP 47 tags denote a
region not expressable as 2 character country code.
Always resolves an empty tag to the system locale.
*/
OUString getCountry() const;
/** Get BCP 47 region tag, which may be an ISO 3166 country alpha code or
any other BCP 47 region tag.
Always resolves an empty tag to the system locale.
*/
OUString getRegion() const;
/** Get BCP 47 variant subtags, of the IANA Language Subtag Registry.
If there are multiple variant subtags they are separated by '-'.
This is NOT related to Locale.Variant!
Always resolves an empty tag to the system locale.
*/
OUString getVariants() const;
/** Get a GLIBC locale string.
Always resolves an empty tag to the system locale.
@param rEncoding
An encoding to be appended to language_country, for example
".UTF-8" including the dot.
@return The resulting GLIBC locale string if it could be constructed,
if not an empty string is returned.
*/
OUString getGlibcLocaleString( const OUString & rEncoding ) const;
/** If language tag has a non-default script specified.
*/
bool hasScript() const;
/** If language tag is a locale that can be expressed using only ISO 639
language codes and ISO 3166 country codes, thus is convertible to a
conforming Locale struct without using extension mechanisms.
Note that an empty language tag or empty Locale::Language field or
LanguageType LANGUAGE_SYSTEM could be treated as a valid ISO locale in
some context, but here is not. If you want that ask for
aTag.isSystemLocale() || aTag.isIsoLocale()
Always resolves an empty tag to the system locale.
*/
bool isIsoLocale() const;
/** If language tag is a locale that can be expressed using only ISO 639
language codes and ISO 15924 script codes and ISO 3166 country codes,
thus can be stored in an ODF document using only fo:language, fo:script
and fo:country attributes. If this is FALSE, the locale must be stored
as a <*:rfc-language-tag> element.
Always resolves an empty tag to the system locale.
*/
bool isIsoODF() const;
/** If this is a valid BCP 47 language tag.
Always resolves an empty tag to the system locale.
*/
bool isValidBcp47() const;
/** If this tag was contructed as an empty tag denoting the system locale.
*/
bool isSystemLocale() const;
/** Reset with existing BCP 47 language tag string. See ctor. */
void reset( const OUString & rBcp47LanguageTag, bool bCanonicalize = false );
/** Reset with Locale. */
void reset( const com::sun::star::lang::Locale & rLocale );
/** Reset with LanguageType MS-LangID. */
void reset( LanguageType nLanguage );
/** Reset with rtl_Locale. */
void reset( const rtl_Locale & rLocale );
/** Fall back to a known locale.
If the current tag does not represent a known (by us) locale, fall back
to the most likely locale possible known.
If the current tag is known, no change occurs.
*/
LanguageTag & makeFallback();
/** Return a vector of fall-back strings.
In order:
full BCP 47 tag, same as getBcp47()
lll-Ssss-CC
lll-Ssss
lll-CC
lll
If the tag includes variants the order is:
full BCP 47 tag, same as getBcp47()
lll-Ssss-CC-vvvvvvvv
lll-Ssss-vvvvvvvv
lll-Ssss-CC
lll-Ssss
lll-CC-vvvvvvvv
lll-vvvvvvvv
lll-CC
lll
Only strings that differ from a higher order are included, for example
if there is no script the elements will be bcp47, lll-CC, lll; if the
bcp47 string is identical to lll-CC then only lll-CC, lll.
Note that lll is only ISO 639-1/2 alpha code and CC is only ISO 3166
alpha code. If the region can not be expressed as ISO 3166 then no -CC
tags are included.
@param bIncludeFullBcp47
If TRUE, the full BCP 47 tag is included as first element.
If FALSE, the full tag is not included; used if the caller
obtains the fallbacks only if the full tag did not lead to a
match, so subsequent tries need not to include it again.
*/
::std::vector< OUString > getFallbackStrings( bool bIncludeFullBcp47 ) const;
/** @short Search for an equal or at least for a similar locale in a list
of possible ones.
@descr First search for a locale that is equal to the reference
locale. (means: same BCP47 string)
If the reference locale could not be located, check for
"similar" locales, in the same order as obtained by
getFallbackStrings().
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-no-translate" explicitly. Sometimes
variables don't use real localization. For example, in case the
localized value is a fix product name.
If no locale matched until then, we use any other locale that
exists inside the set of given ones, namely the first
encountered!
@param rList
the vector of possible locales as BCP47 strings.
@param rReference
the reference locale, BCP47 string.
@return An iterator that points to the found element inside the given
locale list. If no matching locale could be found it points to
the beginning of the list.
*/
static ::std::vector< OUString >::const_iterator getFallback( const ::std::vector< OUString > & rList,
const OUString & rReference );
/** @short Search for an equal or for a similar locale in a list
of possible ones where at least the language matches.
@descr First search for a locale that is equal to the reference
locale.
If the reference locale could not be located, check for
"similar" locales, in the same order as obtained by
getFallbackStrings().
If no locale matches, rList.end() is returned.
@param rList
the vector of possible locales.
@param rReference
the reference locale.
@return An iterator that 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.
*/
static ::std::vector< com::sun::star::lang::Locale >::const_iterator getMatchingFallback(
const ::std::vector< com::sun::star::lang::Locale > & rList,
const com::sun::star::lang::Locale & rReference );
/** Test equality of two LanguageTag, possibly resolving system locale.
@param bResolveSystem
If TRUE, resolve empty language tags denoting the system
locale to the real locale used before comparing.
If FALSE, the behavior is identical to operator==(), system
locales are not resolved first.
*/
bool equals( const LanguageTag & rLanguageTag, bool bResolveSystem = false ) const;
/** Test equality of two LanguageTag.
Does NOT resolve system, i.e. if the system locale is en-US
LanguageTag("")==LanguageTag("en-US") returns false! Use
equals(...,true) instead if system locales shall be resolved.
*/
bool operator==( const LanguageTag & rLanguageTag ) const;
/** Test inequality of two LanguageTag.
Does NOT resolve system, i.e. if the system locale is en-US
LanguageTag("")!=LanguageTag("en-US") returns true! Use
!equals(,...true) instead if system locales shall be resolved.
*/
bool operator!=( const LanguageTag & rLanguageTag ) const;
/** Convert MS-LangID to Locale.
@param bResolveSystem
If TRUE, resolve an empty language tag denoting the system
locale to the real locale used.
If FALSE, return an empty Locale for such a tag.
*/
static com::sun::star::lang::Locale convertToLocale( LanguageType nLangID, bool bResolveSystem = true );
/** Convert Locale to MS-LangID.
@param bResolveSystem
If TRUE, resolve an empty language tag denoting the system
locale to the real locale used.
If FALSE, return LANGUAGE_SYSTEM for such a tag.
*/
static LanguageType convertToLanguageType( const com::sun::star::lang::Locale& rLocale, bool bResolveSystem = true );
/** Convert MS-LangID to BCP 47 string.
@param bResolveSystem
If TRUE, resolve an empty language tag denoting the system
locale to the real locale used.
If FALSE, return an empty OUString for such a tag.
*/
static OUString convertToBcp47( LanguageType nLangID, bool bResolveSystem = true );
/** Convert Locale to BCP 47 string.
@param bResolveSystem
If TRUE, resolve an empty language tag denoting the system
locale to the real locale used.
If FALSE, return an empty OUString for such a tag.
*/
static OUString convertToBcp47( const com::sun::star::lang::Locale& rLocale, bool bResolveSystem = true );
/** Convert BCP 47 string to Locale, convenience method.
NOTE: exists only for consistency with the other convertTo...()
methods, internally uses a temporary LanguageTag instance for
conversion so does not save anything compared to
LanguageTag(rBcp47).getLocale(bResolveSystem).
@param bResolveSystem
If TRUE, resolve an empty language tag denoting the system
locale to the real locale used.
If FALSE, return an empty Locale for such a tag.
*/
static com::sun::star::lang::Locale convertToLocale( const OUString& rBcp47, bool bResolveSystem = true );
/** Convert BCP 47 string to MS-LangID, convenience method.
NOTE: exists only for consistency with the other convertTo...()
methods, internally uses a temporary LanguageTag instance for
conversion so does not save anything compared to
LanguageTag(rBcp47).getLanguageType(bResolveSystem).
@param bResolveSystem
If TRUE, resolve an empty language tag denoting the system
locale to the real locale used.
If FALSE, return LANGUAGE_SYSTEM for such a tag.
*/
static LanguageType convertToLanguageType( const OUString& rBcp47, bool bResolveSystem = true );
/** Convert BCP 47 string to MS-LangID with fallback, convenience method.
NOTE: exists only for consistency with the other convertTo...()
methods, internally uses a temporary LanguageTag instance for
conversion so does not save anything compared to
LanguageTag(rBcp47).makeFallback().getLanguageType(bResolveSystem).
@see makeFallback()
Always resolves an empty tag to the system locale.
*/
static LanguageType convertToLanguageTypeWithFallback( const OUString& rBcp47 );
/** Convert BCP 47 string to Locale with fallback, convenience method.
NOTE: exists only for consistency with the other convertTo...()
methods, internally uses a temporary LanguageTag instance for
conversion so does not save anything compared to
LanguageTag(rBcp47).makeFallback().getLocale(bResolveSystem).
@see makeFallback()
Always resolves an empty tag to the system locale.
*/
static com::sun::star::lang::Locale convertToLocaleWithFallback( const OUString& rBcp47 );
private:
enum Decision
{
DECISION_DONTKNOW,
DECISION_NO,
DECISION_YES
};
mutable com::sun::star::lang::Locale maLocale;
mutable OUString maBcp47;
mutable OUString maCachedLanguage; ///< cache getLanguage()
mutable OUString maCachedScript; ///< cache getScript()
mutable OUString maCachedCountry; ///< cache getCountry()
mutable OUString maCachedVariants; ///< cache getVariants()
mutable void* mpImplLangtag; ///< actually lt_tag_t pointer, encapsulated
mutable LanguageType mnLangID;
mutable Decision meIsValid;
mutable Decision meIsIsoLocale;
mutable Decision meIsIsoODF;
mutable Decision meIsLiblangtagNeeded; ///< whether processing with liblangtag needed
bool mbSystemLocale : 1;
mutable bool mbInitializedBcp47 : 1;
mutable bool mbInitializedLocale : 1;
mutable bool mbInitializedLangID : 1;
mutable bool mbCachedLanguage : 1;
mutable bool mbCachedScript : 1;
mutable bool mbCachedCountry : 1;
mutable bool mbCachedVariants : 1;
bool mbIsFallback : 1;
void convertLocaleToBcp47();
void convertLocaleToLang();
void convertBcp47ToLocale();
void convertBcp47ToLang();
void convertLangToLocale();
void convertLangToBcp47();
void convertFromRtlLocale();
/** @return whether BCP 47 language tag string was changed. */
bool canonicalize();
/** Canonicalize if not yet done and synchronize initialized conversions.
@return whether BCP 47 language tag string was changed.
*/
bool synCanonicalize();
OUString getLanguageFromLangtag();
OUString getScriptFromLangtag();
OUString getRegionFromLangtag();
OUString getVariantsFromLangtag();
void resetVars();
/** Obtain Language, Script, Country and Variants via simpleExtract() and
assign them to the cached variables if successful.
@return return of simpleExtract()
*/
bool cacheSimpleLSCV();
static bool isIsoLanguage( const OUString& rLanguage );
static bool isIsoScript( const OUString& rScript );
static bool isIsoCountry( const OUString& rRegion );
enum Extraction
{
EXTRACTED_NONE,
EXTRACTED_LSC,
EXTRACTED_LV,
EXTRACTED_X,
EXTRACTED_X_JOKER
};
/** Of a language tag of the form lll[-Ssss][-CC][-vvvvvvvv] extract the
portions.
Does not check case or content!
@return EXTRACTED_LSC if simple tag was detected (i.e. one that
would fulfill the isIsoODF() condition),
EXTRACTED_LV if a tag with variant was detected,
EXTRACTED_X if x-... privateuse tag was detected,
EXTRACTED_X_JOKER if "*" joker was detected,
EXTRACTED_NONE else.
*/
static Extraction simpleExtract( const OUString& rBcp47,
OUString& rLanguage,
OUString& rScript,
OUString& rCountry,
OUString& rVariants );
};
#endif // INCLUDED_I18NLANGTAG_LANGUAGETAG_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|