mslangid.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/.
 *
 * 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 INCLUDED_I18NLANGTAG_MSLANGID_HXX
#define INCLUDED_I18NLANGTAG_MSLANGID_HXX
 
#include <sal/config.h>
 
#include <i18nlangtag/i18nlangtagdllapi.h>
#include <i18nlangtag/lang.h>
#include <com/sun/star/lang/Locale.hpp>
 
#include <string_view>
#include <utility>
#include <vector>
 
struct IsoLanguageCountryEntry;
struct IsoLanguageScriptCountryEntry;
struct Bcp47CountryEntry;
 
class SAL_WARN_UNUSED I18NLANGTAG_DLLPUBLIC MsLangId
{
public:
 
    static LanguageType makeLangID( LanguageType nSubLangId, LanguageType nPriLangId)
    {
        return LanguageType((sal_uInt16(nSubLangId) << 10) | sal_uInt16(nPriLangId));
    }
 
    static LanguageType getPrimaryLanguage( LanguageType nLangID)
    {
        return LanguageType(sal_uInt16(nLangID) & LANGUAGE_MASK_PRIMARY);
    }
 
    static LanguageType getSubLanguage( LanguageType nLangID)
    {
        return LanguageType((sal_uInt16(nLangID) & ~LANGUAGE_MASK_PRIMARY) >> 10);
    }
 
    static LanguageType getConfiguredSystemLanguage();
 
    static LanguageType getConfiguredSystemUILanguage();
 
 
    static LanguageType getSystemLanguage();
 
    static LanguageType getSystemUILanguage();
 
 
    static LanguageType getRealLanguage( LanguageType nLang );
 
 
    // TODO: refactor to LanguageTag? Used only in
    // i18npool/source/localedata/localedata.cxx
 
    static css::lang::Locale getFallbackLocale( const css::lang::Locale & rLocale );
 
 
    // TODO: refactor to LanguageTag, used only in
    // i18npool/source/isolang/inunx.cxx to convert Unix locale string
 
    static LanguageType convertUnxByteStringToLanguage( std::string_view rString );
 
 
    static LanguageType resolveSystemLanguageByScriptType( LanguageType nLang, sal_Int16 nType );
 
 
    static bool usesHyphenation( LanguageType nLang );
 
    static bool isRightToLeft( LanguageType nLang );
 
    static bool isRightToLeftMath( LanguageType nLang );
 
    static bool isCJK( LanguageType nLang );
 
    static bool isChinese( LanguageType nLang );
 
    static bool isSimplifiedChinese( LanguageType nLang );
 
    static bool isTraditionalChinese( LanguageType nLang );
 
    static bool isKorean( LanguageType nLang );
 
    static bool isSimplifiedChinese( const css::lang::Locale & rLocale );
 
    static bool isTraditionalChinese( const css::lang::Locale & rLocale );
 
    static bool isFamilyNameFirst( LanguageType nLang );
 
    static bool hasForbiddenCharacters( LanguageType nLang );
 
 
    static bool needsSequenceChecking( LanguageType nLang );
 
 
    static sal_Int16 getScriptType( LanguageType nLang );
 
    static bool isNonLatinWestern( LanguageType nLang );
 
 
    static LanguageType getReplacementForObsoleteLanguage( LanguageType nLang );
 
    static bool isLegacy( LanguageType nLang );
 
 
    static void setConfiguredSystemUILanguage( LanguageType nLang );
    static void setConfiguredWesternFallback( LanguageType nLang );
    static void setConfiguredComplexFallback( LanguageType nLang );
    static void setConfiguredAsianFallback( LanguageType nLang );
 
 
    class LanguageTagAccess
    {
    private:
 
        friend class LanguageTag;
 
        I18NLANGTAG_DLLPRIVATE static void setConfiguredSystemLanguage( LanguageType nLang );
    };
 
 
    struct LanguagetagMapping
    {
        OUString        maBcp47;
        LanguageType    mnLang;
 
        LanguagetagMapping( OUString aBcp47, LanguageType nLang ) : maBcp47(std::move(aBcp47)), mnLang(nLang) {}
    };
 
    static ::std::vector< LanguagetagMapping > getDefinedLanguagetags();
 
 
    class Conversion
    {
    private:
 
        friend class LanguageTag;
        friend class LanguageTagImpl;
 
        friend css::lang::Locale MsLangId::getFallbackLocale(
                const css::lang::Locale & rLocale );
 
        friend LanguageType MsLangId::convertUnxByteStringToLanguage(
                std::string_view rString );
 
 
        I18NLANGTAG_DLLPRIVATE static LanguageType convertLocaleToLanguage(
                const css::lang::Locale & rLocale );
 
        I18NLANGTAG_DLLPRIVATE static LanguageType convertLocaleToLanguageImpl(
                const css::lang::Locale & rLocale );
 
        I18NLANGTAG_DLLPRIVATE static LanguageType convertPrivateUseToLanguage(
                std::u16string_view rPriv );
 
        I18NLANGTAG_DLLPRIVATE static css::lang::Locale getOverride(
                const css::lang::Locale & rLocale );
 
        I18NLANGTAG_DLLPRIVATE static LanguageType convertIsoNamesToLanguage(
                const OUString& rLang, const OUString& rCountry, bool bSkipIsoTable );
 
 
        I18NLANGTAG_DLLPRIVATE static LanguageType convertIsoNamesToLanguage(
                std::string_view rLang, std::string_view rCountry );
 
 
        I18NLANGTAG_DLLPRIVATE static css::lang::Locale getLocale(
                const IsoLanguageCountryEntry * pEntry );
 
        I18NLANGTAG_DLLPRIVATE static css::lang::Locale getLocale(
                const IsoLanguageScriptCountryEntry * pEntry );
 
        I18NLANGTAG_DLLPRIVATE static css::lang::Locale getLocale(
                const Bcp47CountryEntry * pEntry );
 
 
        I18NLANGTAG_DLLPRIVATE static css::lang::Locale convertLanguageToLocale(
                LanguageType nLang, bool bIgnoreOverride );
 
        I18NLANGTAG_DLLPRIVATE static void convertLanguageToLocaleImpl(
                LanguageType nLang, css::lang::Locale & rLocale, bool bIgnoreOverride );
 
 
        I18NLANGTAG_DLLPRIVATE static css::lang::Locale lookupFallbackLocale(
                const css::lang::Locale & rLocale );
    };
 
private:
 
    static LanguageType         nConfiguredSystemLanguage;
    static LanguageType         nConfiguredSystemUILanguage;
 
    static LanguageType         nConfiguredWesternFallback;
    static LanguageType         nConfiguredAsianFallback;
    static LanguageType         nConfiguredComplexFallback;
 
    static LanguageType getPlatformSystemLanguage();
    static LanguageType getPlatformSystemUILanguage();
 
    // Substitute LANGUAGE_SYSTEM for LANGUAGE_SYSTEM_DEFAULT and
    // LANGUAGE_PROCESS_OR_USER_DEFAULT, other values aren't touched.
    I18NLANGTAG_DLLPRIVATE static inline LanguageType simplifySystemLanguages( LanguageType nLang );
};
 
#endif // INCLUDED_I18NLANGTAG_MSLANGID_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */