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
|
/* -*- 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 _UNOTOOLS_LOCALEDATAWRAPPER_HXX
#define _UNOTOOLS_LOCALEDATAWRAPPER_HXX
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
#include <com/sun/star/i18n/XLocaleData4.hpp>
#include <com/sun/star/i18n/LocaleItem.hpp>
#include <com/sun/star/i18n/reservedWords.hpp>
#include <rtl/ustring.hxx>
#include <i18nlangtag/languagetag.hxx>
#include <unotools/readwritemutexguard.hxx>
#include "unotools/unotoolsdllapi.h"
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;
sal_Bool bLocaleDataItemValid;
sal_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,
sal_Bool bUseThousandSep, sal_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, sal_Bool bSec = sal_True,
sal_Bool b100Sec = sal_False ) const;
OUString getDuration( const Time& rTime,
sal_Bool bSec = sal_True, sal_Bool b100Sec = sal_False ) const;
/** The CalendarWrapper already <b>MUST</b>
have loaded a calendar.
@param nDisplayDayOfWeek
0 := abbreviated name
1 := full name
@param bDayOfMonthWithLeadingZero
<FALSE/> := without leading zero
<TRUE/> := with leading zero if <10
@param nDisplayMonth
0 := abbreviated name
1 := full name
@param bTwoDigitYear
<FALSE/> := full year
<TRUE/> := year % 100
*/
OUString getLongDate( const Date& rDate,
CalendarWrapper& rCal,
sal_Int16 nDisplayDayOfWeek = 1,
sal_Bool bDayOfMonthWithLeadingZero = sal_False,
sal_Int16 nDisplayMonth = 1,
sal_Bool bTwoDigitYear = sal_False
) const;
/** Simple number formatting
@param nNumber
value * 10**nDecimals
@param bTrailingZeros
</sal_True> := always display trailing zeros in
decimal places, even if integer value.
</sal_False> := trailing zeros are only displayed
if the value is not an integer value.
*/
OUString getNum( sal_Int64 nNumber, sal_uInt16 nDecimals,
sal_Bool bUseThousandSep = sal_True,
sal_Bool bTrailingZeros = sal_True ) const;
/// "Secure" currency formatted string.
OUString getCurr( sal_Int64 nNumber, sal_uInt16 nDecimals,
const OUString& rCurrencySymbol,
sal_Bool bUseThousandSep = sal_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,
sal_Bool bUseThousandSep = sal_True ) const
{ return getCurr( nNumber, nDecimals,
getCurrSymbol(), bUseThousandSep ); }
// dummy returns, to be implemented
inline sal_Unicode getCurrZeroChar() const
{ return cCurrZeroChar; }
inline sal_Bool isNumLeadingZero() const
{ return sal_True; }
/// standard decimal places
inline sal_uInt16 getNumDigits() const
{ return 2; }
inline sal_Bool isNumTrailingZeros() const
{ return sal_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 // _UNOTOOLS_LOCALEDATAWRAPPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
