1/*
2 * Copyright (C) 2012 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1.  Redistributions of source code must retain the above copyright
8 *     notice, this list of conditions and the following disclaimer.
9 * 2.  Redistributions in binary form must reproduce the above copyright
10 *     notice, this list of conditions and the following disclaimer in the
11 *     documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
20 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
23 * DAMAGE.
24 */
25
26#ifndef PlatformLocale_h
27#define PlatformLocale_h
28
29#include "platform/DateComponents.h"
30#include "platform/Language.h"
31#include "public/platform/WebLocalizedString.h"
32#include "wtf/PassOwnPtr.h"
33#include "wtf/text/WTFString.h"
34
35namespace blink {
36
37class PLATFORM_EXPORT Locale {
38    WTF_MAKE_NONCOPYABLE(Locale);
39public:
40    static PassOwnPtr<Locale> create(const String& localeIdentifier);
41    static Locale& defaultLocale();
42
43    String queryString(blink::WebLocalizedString::Name);
44    String queryString(blink::WebLocalizedString::Name, const String& parameter);
45    String queryString(blink::WebLocalizedString::Name, const String& parameter1, const String& parameter2);
46    String validationMessageTooLongText(unsigned valueLength, int maxLength);
47
48    // Converts the specified number string to another number string localized
49    // for this Locale locale. The input string must conform to HTML
50    // floating-point numbers, and is not empty.
51    String convertToLocalizedNumber(const String&);
52
53    // Converts the specified localized number string to a number string in the
54    // HTML floating-point number format. The input string is provided by a end
55    // user, and might not be a number string. It's ok that the function returns
56    // a string which is not conforms to the HTML floating-point number format,
57    // callers of this function are responsible to check the format of the
58    // resultant string.
59    String convertFromLocalizedNumber(const String&);
60
61#if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
62    // Returns localized decimal separator, e.g. "." for English, "," for French.
63    String localizedDecimalSeparator();
64#endif
65
66    // Returns date format in Unicode TR35 LDML[1] containing day of month,
67    // month, and year, e.g. "dd/mm/yyyy"
68    // [1] LDML http://unicode.org/reports/tr35/#Date_Format_Patterns
69    virtual String dateFormat() = 0;
70
71    // Returns a year-month format in Unicode TR35 LDML.
72    virtual String monthFormat() = 0;
73
74    // Returns a year-month format using short month lanel in Unicode TR35 LDML.
75    virtual String shortMonthFormat() = 0;
76
77    // Returns time format in Unicode TR35 LDML[1] containing hour, minute, and
78    // second with optional period(AM/PM), e.g. "h:mm:ss a"
79    // [1] LDML http://unicode.org/reports/tr35/#Date_Format_Patterns
80    virtual String timeFormat() = 0;
81
82    // Returns time format in Unicode TR35 LDML containing hour, and minute
83    // with optional period(AM/PM), e.g. "h:mm a"
84    // Note: Some platforms return same value as timeFormat().
85    virtual String shortTimeFormat() = 0;
86
87    // Returns a date-time format in Unicode TR35 LDML. It should have a seconds
88    // field.
89    virtual String dateTimeFormatWithSeconds() = 0;
90
91    // Returns a date-time format in Unicode TR35 LDML. It should have no seconds
92    // field.
93    virtual String dateTimeFormatWithoutSeconds() = 0;
94
95    // weekFormatInLDML() returns week and year format in LDML, Unicode
96    // technical standard 35, Locale Data Markup Language, e.g. "'Week' ww, yyyy"
97    String weekFormatInLDML();
98
99    // Returns a vector of string of which size is 12. The first item is a
100    // localized string of Jan and the last item is a localized string of
101    // Dec. These strings should be short.
102    virtual const Vector<String>& shortMonthLabels() = 0;
103
104    // Returns a vector of string of which size is 12. The first item is a
105    // stand-alone localized string of January and the last item is a
106    // stand-alone localized string of December. These strings should not be
107    // abbreviations.
108    virtual const Vector<String>& standAloneMonthLabels() = 0;
109
110    // Stand-alone month version of shortMonthLabels.
111    virtual const Vector<String>& shortStandAloneMonthLabels() = 0;
112
113    // Returns localized period field(AM/PM) strings.
114    virtual const Vector<String>& timeAMPMLabels() = 0;
115
116    // Returns a vector of string of which size is 12. The first item is a
117    // localized string of January, and the last item is a localized string of
118    // December. These strings should not be abbreviations.
119    virtual const Vector<String>& monthLabels() = 0;
120
121    // Returns a vector of string of which size is 7. The first item is a
122    // localized short string of Monday, and the last item is a localized
123    // short string of Saturday. These strings should be short.
124    virtual const Vector<String>& weekDayShortLabels() = 0;
125
126    // The first day of a week. 0 is Sunday, and 6 is Saturday.
127    virtual unsigned firstDayOfWeek() = 0;
128
129    // Returns true if people use right-to-left writing in the locale for this
130    // object.
131    virtual bool isRTL() = 0;
132
133    enum FormatType { FormatTypeUnspecified, FormatTypeShort, FormatTypeMedium };
134
135    // Serializes the specified date into a formatted date string to
136    // display to the user. If an implementation doesn't support
137    // localized dates the function should return an empty string.
138    // FormatType can be used to specify if you want the short format.
139    String formatDateTime(const DateComponents&, FormatType = FormatTypeUnspecified);
140
141    virtual ~Locale();
142
143protected:
144    enum {
145        // 0-9 for digits.
146        DecimalSeparatorIndex = 10,
147        GroupSeparatorIndex = 11,
148        DecimalSymbolsSize
149    };
150
151    Locale() : m_hasLocaleData(false) { }
152    virtual void initializeLocaleData() = 0;
153    void setLocaleData(const Vector<String, DecimalSymbolsSize>&, const String& positivePrefix, const String& positiveSuffix, const String& negativePrefix, const String& negativeSuffix);
154
155private:
156    bool detectSignAndGetDigitRange(const String& input, bool& isNegative, unsigned& startIndex, unsigned& endIndex);
157    unsigned matchedDecimalSymbolIndex(const String& input, unsigned& position);
158
159    String m_decimalSymbols[DecimalSymbolsSize];
160    String m_positivePrefix;
161    String m_positiveSuffix;
162    String m_negativePrefix;
163    String m_negativeSuffix;
164    bool m_hasLocaleData;
165};
166
167}
168#endif
169