/* -*- 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_UNOTOOLS_LOCALEDATAWRAPPER_HXX #define INCLUDED_UNOTOOLS_LOCALEDATAWRAPPER_HXX #include #include #include #include #include #include #include #include #include namespace com { namespace sun { namespace star { namespace uno { class XComponentContext; } }}} class Date; class Time; class CalendarWrapper; enum DateFormat { MDY, DMY, YMD }; enum MeasurementSystem { MEASURE_METRIC, MEASURE_US }; class UNOTOOLS_DLLPUBLIC LocaleDataWrapper : private boost::noncopyable { static sal_uInt8 nLocaleDataChecking; // 0:=dontknow, 1:=yes, 2:=no ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > m_xContext; ::com::sun::star::uno::Reference< ::com::sun::star::i18n::XLocaleData4 > xLD; LanguageTag maLanguageTag; ::boost::shared_ptr< ::com::sun::star::i18n::Calendar2 > xDefaultCalendar; ::com::sun::star::i18n::LocaleDataItem aLocaleDataItem; ::com::sun::star::uno::Sequence< OUString > aReservedWordSeq; ::com::sun::star::uno::Sequence< OUString > aDateAcceptancePatterns; ::com::sun::star::uno::Sequence< sal_Int32 > aGrouping; // cached items OUString aLocaleItem[::com::sun::star::i18n::LocaleItem::COUNT]; OUString aReservedWord[::com::sun::star::i18n::reservedWords::COUNT]; OUString aCurrSymbol; OUString aCurrBankSymbol; int nDateFormat; int nLongDateFormat; sal_uInt16 nCurrPositiveFormat; sal_uInt16 nCurrNegativeFormat; sal_uInt16 nCurrDigits; bool bLocaleDataItemValid; bool bReservedWordValid; mutable ::utl::ReadWriteMutex aMutex; // dummies, to be implemented or provided by XML locale data sal_Unicode cCurrZeroChar; // whenever Locale changes void invalidateData(); void getOneLocaleItemImpl( sal_Int16 nItem ); const OUString& getOneLocaleItem( sal_Int16 nItem ) const; void getOneReservedWordImpl( sal_Int16 nWord ); const OUString& getOneReservedWord( sal_Int16 nWord ) const; void getCurrSymbolsImpl(); void getCurrFormatsImpl(); void scanCurrFormatImpl( const OUString& rCode, sal_Int32 nStart, sal_Int32& nSign, sal_Int32& nPar, sal_Int32& nNum, sal_Int32& nBlank, sal_Int32& nSym ); void getDateFormatsImpl(); DateFormat scanDateFormatImpl( const OUString& rCode ); void getDefaultCalendarImpl(); sal_Unicode* ImplAddFormatNum( sal_Unicode* pBuf, sal_Int64 nNumber, sal_uInt16 nDecimals, bool bUseThousandSep, bool bTrailingZeros ) const; void getDigitGroupingImpl(); public: LocaleDataWrapper( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > & rxContext, const LanguageTag& rLanguageTag ); LocaleDataWrapper( const LanguageTag& rLanguageTag ); ~LocaleDataWrapper(); /** Get the service factory, meant to be able to create a CalendarWrapper from a LocaleDataWrapper. Note that the service factory may be non-existent if this LocaleDataWrapper was created without one and lives "on the grassland". The CalendarWrapper ctor can handle that though. */ const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > & getComponentContext() const { return m_xContext; } /// set a new Locale to request void setLanguageTag( const LanguageTag& rLanguageTag ); /// get current requested Locale const LanguageTag& getLanguageTag() const; /// get current loaded Locale, which might differ from the requested Locale LanguageTag getLoadedLanguageTag() const; // Wrapper implementations of service LocaleData ::com::sun::star::i18n::LanguageCountryInfo getLanguageCountryInfo() const; ::com::sun::star::i18n::LocaleDataItem getLocaleItem() const; /// NOTE: this wraps XLocaleData3::getAllCalendars2() in fact. ::com::sun::star::uno::Sequence< ::com::sun::star::i18n::Calendar2 > getAllCalendars() const; /// NOTE: this wraps XLocaleData2::getAllCurrencies2() in fact. ::com::sun::star::uno::Sequence< ::com::sun::star::i18n::Currency2 > getAllCurrencies() const; ::com::sun::star::uno::Sequence< ::com::sun::star::i18n::FormatElement > getAllFormats() const; ::com::sun::star::i18n::ForbiddenCharacters getForbiddenCharacters() const; ::com::sun::star::uno::Sequence< OUString > getReservedWord() const; ::com::sun::star::uno::Sequence< ::com::sun::star::lang::Locale > getAllInstalledLocaleNames() const; ::com::sun::star::uno::Sequence< OUString > getDateAcceptancePatterns() const; /** Override locale's date acceptance patterns. An empty sequence resets the patterns to the locale's pattern sequence. */ void setDateAcceptancePatterns( const ::com::sun::star::uno::Sequence< OUString > & rPatterns ); /// same as the wrapper implementation but static static ::com::sun::star::uno::Sequence< ::com::sun::star::lang::Locale > getInstalledLocaleNames(); /** Get LanguageTypes for all installed locales which are unambiguous convertible back and forth between locale ISO strings and MS-LCID LanguageType. Upon the first time the function is called when locale data checking is enabled, messages are shown for locales not matching, excluding already known problems. (e.g. used in number formatter dialog init) */ static ::com::sun::star::uno::Sequence< sal_uInt16 > getInstalledLanguageTypes(); /// maps the LocaleData string to the International enum MeasurementSystem mapMeasurementStringToEnum( const OUString& rMS ) const; /// Convenience method to obtain the default calendar. const ::boost::shared_ptr< ::com::sun::star::i18n::Calendar2 > getDefaultCalendar() const; /// Convenience method to obtain the day names of the default calendar. const ::com::sun::star::uno::Sequence< ::com::sun::star::i18n::CalendarItem2 > getDefaultCalendarDays() const; /// Convenience method to obtain the month names of the default calendar. const ::com::sun::star::uno::Sequence< ::com::sun::star::i18n::CalendarItem2 > getDefaultCalendarMonths() const; /** Obtain digit grouping. The usually known grouping by thousands (#,###) is actually only one of possible groupings. Another one, for example, used in India is group by 3 and then by 2 indefinitely (#,##,###). The integer sequence returned here specifies grouping from right to left (!), with a 0 entry designating the end of rules and the previous value to be repeated indefinitely. Hence the sequence {3,0} specifies the usual grouping by thousands, whereas the sequence {3,2,0} specifies Indian grouping. The sal_Int32* getConstArray() can be passed directly to the ::rtl::math::doubleToString() methods as argument for the pGroups parameter. */ const ::com::sun::star::uno::Sequence< sal_Int32 > getDigitGrouping() const; // Functionality of class International methods, LocaleItem const OUString& getDateSep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::DATE_SEPARATOR ); } const OUString& getNumThousandSep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::THOUSAND_SEPARATOR ); } const OUString& getNumDecimalSep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::DECIMAL_SEPARATOR ); } const OUString& getTimeSep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::TIME_SEPARATOR ); } const OUString& getTime100SecSep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::TIME_100SEC_SEPARATOR ); } const OUString& getListSep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::LIST_SEPARATOR ); } const OUString& getQuotationMarkStart() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::SINGLE_QUOTATION_START ); } const OUString& getQuotationMarkEnd() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::SINGLE_QUOTATION_END ); } const OUString& getDoubleQuotationMarkStart() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::DOUBLE_QUOTATION_START ); } const OUString& getDoubleQuotationMarkEnd() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::DOUBLE_QUOTATION_END ); } const OUString& getMeasurementSystem() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::MEASUREMENT_SYSTEM ); } MeasurementSystem getMeasurementSystemEnum() const { return mapMeasurementStringToEnum( getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::MEASUREMENT_SYSTEM ) ); } const OUString& getTimeAM() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::TIME_AM ); } const OUString& getTimePM() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::TIME_PM ); } const OUString& getLongDateDayOfWeekSep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::LONG_DATE_DAY_OF_WEEK_SEPARATOR ); } const OUString& getLongDateDaySep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::LONG_DATE_DAY_SEPARATOR ); } const OUString& getLongDateMonthSep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::LONG_DATE_MONTH_SEPARATOR ); } const OUString& getLongDateYearSep() const { return getOneLocaleItem( ::com::sun::star::i18n::LocaleItem::LONG_DATE_YEAR_SEPARATOR ); } // currency const OUString& getCurrSymbol() const; const OUString& getCurrBankSymbol() const; sal_uInt16 getCurrPositiveFormat() const; sal_uInt16 getCurrNegativeFormat() const; sal_uInt16 getCurrDigits() const; // simple date and time formatting DateFormat getDateFormat() const; DateFormat getLongDateFormat() const; /// only numerical values of Gregorian calendar OUString getDate( const Date& rDate ) const; OUString getTime( const Time& rTime, bool bSec = true, bool b100Sec = false ) const; OUString getDuration( const Time& rTime, bool bSec = true, bool b100Sec = false ) const; /** The CalendarWrapper already MUST have loaded a calendar. @param nDisplayDayOfWeek 0 := abbreviated name 1 := full name @param bDayOfMonthWithLeadingZero := without leading zero := with leading zero if <10 @param nDisplayMonth 0 := abbreviated name 1 := full name @param bTwoDigitYear := full year := year % 100 */ OUString getLongDate( const Date& rDate, CalendarWrapper& rCal, sal_Int16 nDisplayDayOfWeek = 1, bool bDayOfMonthWithLeadingZero = false, sal_Int16 nDisplayMonth = 1, bool bTwoDigitYear = false ) const; /** Simple number formatting @param nNumber value * 10**nDecimals @param bTrailingZeros := always display trailing zeros in decimal places, even if integer value. := trailing zeros are only displayed if the value is not an integer value. */ OUString getNum( sal_Int64 nNumber, sal_uInt16 nDecimals, bool bUseThousandSep = true, bool bTrailingZeros = true ) const; /// "Secure" currency formatted string. OUString getCurr( sal_Int64 nNumber, sal_uInt16 nDecimals, const OUString& rCurrencySymbol, bool bUseThousandSep = true ) const; /** Default currency formatted string, use with care as default currency may change in any locale, for example, DEM -> EUR */ OUString getCurr( sal_Int64 nNumber, sal_uInt16 nDecimals, bool bUseThousandSep = true ) const { return getCurr( nNumber, nDecimals, getCurrSymbol(), bUseThousandSep ); } // dummy returns, to be implemented inline sal_Unicode getCurrZeroChar() const { return cCurrZeroChar; } inline bool isNumLeadingZero() const { return true; } /// standard decimal places inline sal_uInt16 getNumDigits() const { return 2; } inline bool isNumTrailingZeros() const { return true; } // reserved words const OUString& getTrueWord() const { return getOneReservedWord( ::com::sun::star::i18n::reservedWords::TRUE_WORD ); } const OUString& getFalseWord() const { return getOneReservedWord( ::com::sun::star::i18n::reservedWords::FALSE_WORD ); } /// return a quarter string matching nQuarter (0..3) => "1st quarter" .. "4th quarter" const OUString& getQuarterWord( sal_Int16 nQuarter ) const { return getOneReservedWord( ::com::sun::star::i18n::reservedWords::QUARTER1_WORD + nQuarter ); } const OUString& getAboveWord() const { return getOneReservedWord( ::com::sun::star::i18n::reservedWords::ABOVE_WORD ); } const OUString& getBelowWord() const { return getOneReservedWord( ::com::sun::star::i18n::reservedWords::BELOW_WORD ); } /// return a quarter abbreviation string matching nQuarter (0..3) => "Q1" .. "Q2" const OUString& getQuarterAbbreviation( sal_Int16 nQuarter ) const { return getOneReservedWord( ::com::sun::star::i18n::reservedWords::QUARTER1_ABBREVIATION + nQuarter ); } /** Return whether locale data checks are enabled. Checks are enabled if the environment variable OOO_ENABLE_LOCALE_DATA_CHECKS is set to 'Y' or 'Yes' (or any other string starting with 'Y') or '1'. Also used in conjunction with the number formatter. */ static inline bool areChecksEnabled() { if (nLocaleDataChecking == 0) evaluateLocaleDataChecking(); return nLocaleDataChecking == 1; } /** Append locale info to string, used with locale data checking. A string similar to "de_DE requested\n en_US loaded" is appended. */ OUString appendLocaleInfo(const OUString& rDebugMsg) const; /** Ouput a message during locale data checking. The (UTF-8) string is written to stderr and in a non-product build or if DBG_UTIL is enabled also raised as an assertion message box. */ static void outputCheckMessage( const OUString& rMsg ); static void outputCheckMessage( const char* pStr); private: const ::com::sun::star::lang::Locale & getMyLocale() const; static void evaluateLocaleDataChecking(); }; #endif // INCLUDED_UNOTOOLS_LOCALEDATAWRAPPER_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */