office-gobmx/include/i18nlangtag/languagetag.hxx
Eike Rathke cf417c2cd4 use bcp47 unresolved system for operator<()
We have several tags mapping to one LangID, so using LangID isn't a good
idea.

Change-Id: I561745b032af7eb0c54cf55dbcd26872103e2e07
2013-09-21 15:24:43 +02:00

546 lines
21 KiB
C++

/* -*- 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 <boost/shared_ptr.hpp>
#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"
class LanguageTagImpl;
/** 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
{
friend class LanguageTagImpl;
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 );
/** Default ctor, init LanguageTag with LanguageType LANGUAGE_DONTKNOW.
To be able to use LanguageTag in maps etc., avoid otherwise.
*/
explicit LanguageTag();
/** 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. */
LanguageTag & reset( const OUString & rBcp47LanguageTag, bool bCanonicalize = false );
/** Reset with Locale. */
LanguageTag & reset( const com::sun::star::lang::Locale & rLocale );
/** Reset with LanguageType MS-LangID. */
LanguageTag & reset( LanguageType nLanguage );
/** Reset with rtl_Locale. */
LanguageTag & 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;
/** Test this LanguageTag less than that LanguageTag.
For sorted containers. Does NOT resolve system.
*/
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 );
/** If nLang is a generated on-the-fly LangID */
static bool isOnTheFlyID( LanguageType nLang );
typedef ::boost::shared_ptr< LanguageTagImpl > ImplPtr;
private:
mutable com::sun::star::lang::Locale maLocale;
mutable OUString maBcp47;
mutable LanguageType mnLangID;
mutable ImplPtr mpImpl;
bool mbSystemLocale : 1;
mutable bool mbInitializedBcp47 : 1;
mutable bool mbInitializedLocale : 1;
mutable bool mbInitializedLangID : 1;
bool mbIsFallback : 1;
ImplPtr getImpl() const;
ImplPtr registerImpl() const;
void syncFromImpl();
void syncVarsFromRawImpl() const;
void syncVarsFromImpl() const;
void convertLocaleToBcp47();
void convertLocaleToLang();
void convertBcp47ToLocale();
void convertBcp47ToLang();
void convertLangToLocale();
void convertLangToBcp47();
void convertFromRtlLocale();
/** Canonicalize if not yet done and synchronize initialized conversions.
@return whether BCP 47 language tag string was changed.
*/
bool synCanonicalize();
void resetVars();
static bool isIsoLanguage( const OUString& rLanguage );
static bool isIsoScript( const OUString& rScript );
static bool isIsoCountry( const OUString& rRegion );
};
#endif // INCLUDED_I18NLANGTAG_LANGUAGETAG_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */