Support list of tracks in caption media controls
[WebKit-https.git] / Source / WebCore / platform / Language.cpp
1 /*
2  * Copyright (C) 2010 Apple 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''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "Language.h"
28
29 #include <wtf/HashMap.h>
30 #include <wtf/RetainPtr.h>
31 #include <wtf/text/WTFString.h>
32
33 #if PLATFORM(MAC)
34 #include <CoreFoundation/CoreFoundation.h>
35 #endif
36
37 namespace WebCore {
38
39 typedef HashMap<void*, LanguageChangeObserverFunction> ObserverMap;
40 static ObserverMap& observerMap()
41 {
42     DEFINE_STATIC_LOCAL(ObserverMap, map, ());
43     return map;
44 }
45
46 void addLanguageChangeObserver(void* context, LanguageChangeObserverFunction customObserver)
47 {
48     observerMap().set(context, customObserver);
49 }
50
51 void removeLanguageChangeObserver(void* context)
52 {
53     ASSERT(observerMap().contains(context));
54     observerMap().remove(context);
55 }
56
57 void languageDidChange()
58 {
59     ObserverMap::iterator end = observerMap().end();
60     for (ObserverMap::iterator iter = observerMap().begin(); iter != end; ++iter)
61         iter->value(iter->key);
62 }
63
64 String defaultLanguage()
65 {
66     Vector<String> languages = userPreferredLanguages();
67     if (languages.size())
68         return languages[0];
69
70     return emptyString();
71 }
72
73 static Vector<String>& preferredLanguagesOverride()
74 {
75     DEFINE_STATIC_LOCAL(Vector<String>, override, ());
76     return override;
77 }
78
79 void overrideUserPreferredLanguages(const Vector<String>& override)
80 {
81     preferredLanguagesOverride() = override;
82 }
83     
84 Vector<String> userPreferredLanguages()
85 {
86     Vector<String>& override = preferredLanguagesOverride();
87     if (!override.isEmpty())
88         return override;
89     
90     return platformUserPreferredLanguages();
91 }
92
93 static String canonicalLanguageIdentifier(const String& languageCode)
94 {
95     String lowercaseLanguageCode = languageCode.lower();
96     
97     if (lowercaseLanguageCode.length() >= 3 && lowercaseLanguageCode[2] == '_')
98         lowercaseLanguageCode.replace(2, 1, "-");
99
100     return lowercaseLanguageCode;
101 }
102
103 static String bestMatchingLanguage(const String& language, const Vector<String>& languageList)
104 {
105     bool canMatchLanguageOnly = (language.length() == 2 || (language.length() >= 3 && language[2] == '-'));
106     String languageWithoutLocaleMatch;
107     String languageMatchButNotLocale;
108
109     for (size_t i = 0; i < languageList.size(); ++i) {
110         String canonicalizedLanguageFromList = canonicalLanguageIdentifier(languageList[i]);
111
112         if (language == canonicalizedLanguageFromList)
113             return languageList[i];
114
115         if (canMatchLanguageOnly && canonicalizedLanguageFromList.length() >= 2) {
116             if (language[0] == canonicalizedLanguageFromList[0] && language[1] == canonicalizedLanguageFromList[1]) {
117                 if (!languageWithoutLocaleMatch.length() && canonicalizedLanguageFromList.length() == 2)
118                     languageWithoutLocaleMatch = languageList[i];
119                 if (!languageMatchButNotLocale.length() && canonicalizedLanguageFromList.length() >= 3)
120                     languageMatchButNotLocale = languageList[i];
121             }
122         }
123     }
124
125     // If we have both a language-only match and a languge-but-not-locale match, return the 
126     // languge-only match as is considered a "better" match. For example, if the list
127     // provided has both "en-GB" and "en" and the user prefers "en-US" we will return "en".
128     if (languageWithoutLocaleMatch.length())
129         return languageWithoutLocaleMatch;
130
131     if (languageMatchButNotLocale.length())
132         return languageMatchButNotLocale;
133     
134     return emptyString();
135 }
136
137 String preferredLanguageFromList(const Vector<String>& languageList)
138 {
139     Vector<String> preferredLanguages = userPreferredLanguages();
140
141     for (size_t i = 0; i < preferredLanguages.size(); ++i) {
142         String bestMatch = bestMatchingLanguage(canonicalLanguageIdentifier(preferredLanguages[i]), languageList);
143
144         if (bestMatch.length())
145             return bestMatch;
146     }
147
148     return emptyString();
149 }
150
151 String displayNameForLanguageLocale(const String& localeName)
152 {
153 #if PLATFORM(MAC)
154     if (!localeName.isNull() && !localeName.isEmpty())
155         return CFLocaleCopyDisplayNameForPropertyValue(CFLocaleCopyCurrent(), kCFLocaleIdentifier, localeName.createCFString().get());
156 #endif
157     return localeName;
158 }
159
160 }