third_party/WebKit/Source/platform/text/PlatformLocale.h

   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
  35 namespace blink {
  36
  37 class PLATFORM_EXPORT Locale {
  38     WTF_MAKE_NONCOPYABLE(Locale);
  39 public:
  40     static PassOwnPtr<Locale> create(const String& localeIdentifier);
  41     static Locale& defaultLocale();
  42
  43     String queryString(WebLocalizedString::Name);
  44     String queryString(WebLocalizedString::Name, const String& parameter);
  45     String queryString(WebLocalizedString::Name, const String& parameter1, const String& parameter2);
  46     String validationMessageTooLongText(unsigned valueLength, int maxLength);
  47     String validationMessageTooShortText(unsigned valueLength, int minLength);
  48
  49     // Converts the specified number string to another number string localized
  50     // for this Locale locale. The input string must conform to HTML
  51     // floating-point numbers, and is not empty.
  52     String convertToLocalizedNumber(const String&);
  53
  54     // Converts the specified localized number string to a number string in the
  55     // HTML floating-point number format. The input string is provided by a end
  56     // user, and might not be a number string. It's ok that the function returns
  57     // a string which is not conforms to the HTML floating-point number format,
  58     // callers of this function are responsible to check the format of the
  59     // resultant string.
  60     String convertFromLocalizedNumber(const String&);
  61
  62     // Remove characters from |input| if a character is not included in
  63     // locale-specific number characters and |standardChars|.
  64     String stripInvalidNumberCharacters(const String& input, const String& standardChars) const;
  65
  66 #if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
  67     // Returns localized decimal separator, e.g. "." for English, "," for French.
  68     String localizedDecimalSeparator();
  69 #endif
  70
  71     // Returns date format in Unicode TR35 LDML[1] containing day of month,
  72     // month, and year, e.g. "dd/mm/yyyy"
  73     // [1] LDML http://unicode.org/reports/tr35/#Date_Format_Patterns
  74     virtual String dateFormat() = 0;
  75
  76     // Returns a year-month format in Unicode TR35 LDML.
  77     virtual String monthFormat() = 0;
  78
  79     // Returns a year-month format using short month lanel in Unicode TR35 LDML.
  80     virtual String shortMonthFormat() = 0;
  81
  82     // Returns time format in Unicode TR35 LDML[1] containing hour, minute, and
  83     // second with optional period(AM/PM), e.g. "h:mm:ss a"
  84     // [1] LDML http://unicode.org/reports/tr35/#Date_Format_Patterns
  85     virtual String timeFormat() = 0;
  86
  87     // Returns time format in Unicode TR35 LDML containing hour, and minute
  88     // with optional period(AM/PM), e.g. "h:mm a"
  89     // Note: Some platforms return same value as timeFormat().
  90     virtual String shortTimeFormat() = 0;
  91
  92     // Returns a date-time format in Unicode TR35 LDML. It should have a seconds
  93     // field.
  94     virtual String dateTimeFormatWithSeconds() = 0;
  95
  96     // Returns a date-time format in Unicode TR35 LDML. It should have no seconds
  97     // field.
  98     virtual String dateTimeFormatWithoutSeconds() = 0;
  99
 100     // weekFormatInLDML() returns week and year format in LDML, Unicode
 101     // technical standard 35, Locale Data Markup Language, e.g. "'Week' ww, yyyy"
 102     String weekFormatInLDML();
 103
 104     // Returns a vector of string of which size is 12. The first item is a
 105     // localized string of Jan and the last item is a localized string of
 106     // Dec. These strings should be short.
 107     virtual const Vector<String>& shortMonthLabels() = 0;
 108
 109     // Returns a vector of string of which size is 12. The first item is a
 110     // stand-alone localized string of January and the last item is a
 111     // stand-alone localized string of December. These strings should not be
 112     // abbreviations.
 113     virtual const Vector<String>& standAloneMonthLabels() = 0;
 114
 115     // Stand-alone month version of shortMonthLabels.
 116     virtual const Vector<String>& shortStandAloneMonthLabels() = 0;
 117
 118     // Returns localized period field(AM/PM) strings.
 119     virtual const Vector<String>& timeAMPMLabels() = 0;
 120
 121     // Returns a vector of string of which size is 12. The first item is a
 122     // localized string of January, and the last item is a localized string of
 123     // December. These strings should not be abbreviations.
 124     virtual const Vector<String>& monthLabels() = 0;
 125
 126     // Returns a vector of string of which size is 7. The first item is a
 127     // localized short string of Monday, and the last item is a localized
 128     // short string of Saturday. These strings should be short.
 129     virtual const Vector<String>& weekDayShortLabels() = 0;
 130
 131     // The first day of a week. 0 is Sunday, and 6 is Saturday.
 132     virtual unsigned firstDayOfWeek() = 0;
 133
 134     // Returns true if people use right-to-left writing in the locale for this
 135     // object.
 136     virtual bool isRTL() = 0;
 137
 138     enum FormatType { FormatTypeUnspecified, FormatTypeShort, FormatTypeMedium };
 139
 140     // Serializes the specified date into a formatted date string to
 141     // display to the user. If an implementation doesn't support
 142     // localized dates the function should return an empty string.
 143     // FormatType can be used to specify if you want the short format.
 144     String formatDateTime(const DateComponents&, FormatType = FormatTypeUnspecified);
 145
 146     virtual ~Locale();
 147
 148 protected:
 149     enum {
 150         // 0-9 for digits.
 151         DecimalSeparatorIndex = 10,
 152         GroupSeparatorIndex = 11,
 153         DecimalSymbolsSize
 154     };
 155
 156     Locale() : m_hasLocaleData(false) { }
 157     virtual void initializeLocaleData() = 0;
 158     void setLocaleData(const Vector<String, DecimalSymbolsSize>&, const String& positivePrefix, const String& positiveSuffix, const String& negativePrefix, const String& negativeSuffix);
 159
 160 private:
 161     bool detectSignAndGetDigitRange(const String& input, bool& isNegative, unsigned& startIndex, unsigned& endIndex);
 162     unsigned matchedDecimalSymbolIndex(const String& input, unsigned& position);
 163
 164     String m_decimalSymbols[DecimalSymbolsSize];
 165     String m_positivePrefix;
 166     String m_positiveSuffix;
 167     String m_negativePrefix;
 168     String m_negativeSuffix;
 169     String m_acceptableNumberCharacters;
 170     bool m_hasLocaleData;
 171 };
 172
 173 } // namespace blink
 174 #endif