languagetag.hxx

Go to the documentation of this file.

/* -*- 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/locale.h>
#include <rtl/ustring.hxx>
#include <com/sun/star/lang/Locale.hpp>
#include <i18nlangtag/i18nlangtagdllapi.h>
#include <i18nlangtag/lang.h>
 
#include <memory>
#include <string_view>
#include <vector>
 
#define I18NLANGTAG_QLT_ASCII "qlt"
inline constexpr OUStringLiteral I18NLANGTAG_QLT = u"qlt";
 
 
class LanguageTagImpl;
 
 
class SAL_WARN_UNUSED I18NLANGTAG_DLLPUBLIC LanguageTag
{
    friend class LanguageTagImpl;
 
public:
 
    enum class ScriptType
    {
        UNKNOWN = 0,
        WESTERN = 1,      // Copies css::i18n::ScriptType for strong types
        CJK = 2,
        CTL = 3,
        RTL = 4       // implies CTL
    };
 
    explicit LanguageTag( const OUString & rBcp47LanguageTag, bool bCanonicalize = false );
 
    explicit LanguageTag( const css::lang::Locale & rLocale );
 
    explicit LanguageTag( LanguageType nLanguage );
 
    explicit LanguageTag( const OUString& rBcp47, const OUString& rLanguage,
                          std::u16string_view rScript, const OUString& rCountry );
 
    explicit LanguageTag( const rtl_Locale & rLocale );
 
    ~LanguageTag();
 
    LanguageTag(LanguageTag const &) = default;
    LanguageTag(LanguageTag &&) = default;
    LanguageTag & operator =(LanguageTag const &) = default;
    LanguageTag & operator =(LanguageTag &&) = default;
 
    const OUString &                getBcp47( bool bResolveSystem = true ) const;
 
    OUString                        getBcp47MS() const;
 
    const css::lang::Locale &    getLocale( bool bResolveSystem = true ) const;
 
    LanguageType                    getLanguageType( bool bResolveSystem = true ) const;
 
    void                            getIsoLanguageScriptCountry( OUString& rLanguage,
                                                                 OUString& rScript, OUString& rCountry ) const;
 
    OUString                        getLanguage() const;
 
    OUString                        getScript() const;
 
    OUString                        getLanguageAndScript() const;
 
    OUString                        getCountry() const;
 
    OUString                        getVariants() const;
 
    OUString                        getGlibcLocaleString( std::u16string_view rEncoding ) const;
 
    bool                            hasScript() const;
 
    bool                            isIsoLocale() const;
 
    bool                            isIsoODF() const;
 
    bool                            isValidBcp47() const;
 
    bool                            isSystemLocale() const { return mbSystemLocale;}
 
    ScriptType                      getScriptType() const;
 
    void                            setScriptType(ScriptType st);
 
    LanguageTag &                   reset( const OUString & rBcp47LanguageTag );
 
    LanguageTag &                   reset( const css::lang::Locale & rLocale );
 
    LanguageTag &                   reset( LanguageType nLanguage );
 
 
    LanguageTag &                   makeFallback();
 
    ::std::vector< OUString >       getFallbackStrings( bool bIncludeFullBcp47 ) const;
 
 
    static ::std::vector< OUString >::const_iterator getFallback( const ::std::vector< OUString > & rList,
                                                                  const OUString & rReference );
 
 
    static ::std::vector< css::lang::Locale >::const_iterator getMatchingFallback(
            const ::std::vector< css::lang::Locale > & rList,
            const css::lang::Locale & rReference );
 
 
    bool    equals( const LanguageTag & rLanguageTag ) const;
 
    bool    operator==( const LanguageTag & rLanguageTag ) const;
 
    bool    operator!=( const LanguageTag & rLanguageTag ) const;
 
    bool    operator<( const LanguageTag & rLanguageTag ) const;
 
    static css::lang::Locale convertToLocale( LanguageType nLangID, bool bResolveSystem = true );
 
    static LanguageType convertToLanguageType( const css::lang::Locale& rLocale, bool bResolveSystem = true );
 
    static OUString convertToBcp47( LanguageType nLangID );
 
    static OUString convertToBcp47( const css::lang::Locale& rLocale, bool bResolveSystem = true );
 
    static css::lang::Locale convertToLocale( const OUString& rBcp47, bool bResolveSystem = true );
 
    static LanguageType convertToLanguageType( const OUString& rBcp47 );
 
    static LanguageType convertToLanguageTypeWithFallback( const OUString& rBcp47 );
 
    static css::lang::Locale convertToLocaleWithFallback( const OUString& rBcp47 );
 
    static LanguageType convertToLanguageTypeWithFallback( const css::lang::Locale& rLocale );
 
    enum PrivateUse
    {
        ALLOW = 0,      
        DISALLOW,       
        ALLOW_ART_X     
    };
 
    static bool         isValidBcp47( const OUString& rString, OUString* o_pCanonicalized,
                                      PrivateUse ePrivateUse = PrivateUse::ALLOW );
 
    static bool         isOnTheFlyID( LanguageType nLang );
    static ScriptType   getOnTheFlyScriptType( LanguageType nLang );
 
    static void setConfiguredSystemLanguage( LanguageType nLang );
 
    static void disable_lt_tag_parse();
 
    typedef std::shared_ptr< LanguageTagImpl > ImplPtr;
 
private:
 
    mutable css::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;
 
    LanguageTagImpl*    getImpl();
    LanguageTagImpl const* getImpl() const;
    ImplPtr             registerImpl() const;
    void                syncFromImpl();
    void                syncVarsFromRawImpl() const;
    void                syncVarsFromImpl() const;
 
    void                convertLocaleToLang();
    void                convertBcp47ToLocale();
    void                convertBcp47ToLang();
    void                convertLangToLocale();
 
    void                convertFromRtlLocale();
 
    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: */