1 /*
2 * Copyright (C) 2008 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 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14 * its contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #include "config.h"
30 #include "wtf/unicode/Collator.h"
31
32 #include "wtf/Assertions.h"
33 #include "wtf/StringExtras.h"
34 #include "wtf/Threading.h"
35 #include "wtf/ThreadingPrimitives.h"
36 #include <stdlib.h>
37 #include <string.h>
38 #include <unicode/ucol.h>
39
40 #if OS(MACOSX)
41 #include "wtf/RetainPtr.h"
42 #include <CoreFoundation/CoreFoundation.h>
43 #endif
44
45 namespace WTF {
46
47 static UCollator* cachedCollator;
cachedCollatorMutex()48 static Mutex& cachedCollatorMutex()
49 {
50 AtomicallyInitializedStatic(Mutex&, mutex = *new Mutex);
51 return mutex;
52 }
53
Collator(const char * locale)54 Collator::Collator(const char* locale)
55 : m_collator(0)
56 , m_locale(locale ? strdup(locale) : 0)
57 , m_lowerFirst(false)
58 {
59 }
60
userDefault()61 PassOwnPtr<Collator> Collator::userDefault()
62 {
63 #if OS(MACOSX) && USE(CF)
64 // Mac OS X doesn't set UNIX locale to match user-selected one, so ICU default doesn't work.
65 RetainPtr<CFLocaleRef> currentLocale(AdoptCF, CFLocaleCopyCurrent());
66 CFStringRef collationOrder = (CFStringRef)CFLocaleGetValue(currentLocale.get(), kCFLocaleCollatorIdentifier);
67 char buf[256];
68 if (!collationOrder)
69 return adoptPtr(new Collator(""));
70 CFStringGetCString(collationOrder, buf, sizeof(buf), kCFStringEncodingASCII);
71 return adoptPtr(new Collator(buf));
72 #else
73 return adoptPtr(new Collator(0));
74 #endif
75 }
76
~Collator()77 Collator::~Collator()
78 {
79 releaseCollator();
80 free(m_locale);
81 }
82
setOrderLowerFirst(bool lowerFirst)83 void Collator::setOrderLowerFirst(bool lowerFirst)
84 {
85 m_lowerFirst = lowerFirst;
86 }
87
collate(const UChar * lhs,size_t lhsLength,const UChar * rhs,size_t rhsLength) const88 Collator::Result Collator::collate(const UChar* lhs, size_t lhsLength, const UChar* rhs, size_t rhsLength) const
89 {
90 if (!m_collator)
91 createCollator();
92
93 return static_cast<Result>(ucol_strcoll(m_collator, lhs, lhsLength, rhs, rhsLength));
94 }
95
createCollator() const96 void Collator::createCollator() const
97 {
98 ASSERT(!m_collator);
99 UErrorCode status = U_ZERO_ERROR;
100
101 {
102 Locker<Mutex> lock(cachedCollatorMutex());
103 if (cachedCollator) {
104 const char* cachedCollatorLocale = ucol_getLocaleByType(cachedCollator, ULOC_REQUESTED_LOCALE, &status);
105 ASSERT(U_SUCCESS(status));
106 ASSERT(cachedCollatorLocale);
107
108 UColAttributeValue cachedCollatorLowerFirst = ucol_getAttribute(cachedCollator, UCOL_CASE_FIRST, &status);
109 ASSERT(U_SUCCESS(status));
110
111 // FIXME: default locale is never matched, because ucol_getLocaleByType returns the actual one used, not 0.
112 if (m_locale && 0 == strcmp(cachedCollatorLocale, m_locale)
113 && ((UCOL_LOWER_FIRST == cachedCollatorLowerFirst && m_lowerFirst) || (UCOL_UPPER_FIRST == cachedCollatorLowerFirst && !m_lowerFirst))) {
114 m_collator = cachedCollator;
115 cachedCollator = 0;
116 return;
117 }
118 }
119 }
120
121 m_collator = ucol_open(m_locale, &status);
122 if (U_FAILURE(status)) {
123 status = U_ZERO_ERROR;
124 m_collator = ucol_open("", &status); // Fallback to Unicode Collation Algorithm.
125 }
126 ASSERT(U_SUCCESS(status));
127
128 ucol_setAttribute(m_collator, UCOL_CASE_FIRST, m_lowerFirst ? UCOL_LOWER_FIRST : UCOL_UPPER_FIRST, &status);
129 ASSERT(U_SUCCESS(status));
130
131 ucol_setAttribute(m_collator, UCOL_NORMALIZATION_MODE, UCOL_ON, &status);
132 ASSERT(U_SUCCESS(status));
133 }
134
releaseCollator()135 void Collator::releaseCollator()
136 {
137 {
138 Locker<Mutex> lock(cachedCollatorMutex());
139 if (cachedCollator)
140 ucol_close(cachedCollator);
141 cachedCollator = m_collator;
142 m_collator = 0;
143 }
144 }
145
146 } // namespace WTF
147