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
|
/*
* Copyright (C) 2010 Apple Inc. All rights reserved.
* Copyright (C) 2015 Igalia S.L.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "Hyphenation.h"
#if USE(LIBHYPHEN)
#include "FileSystem.h"
#include <hyphen.h>
#include <limits>
#include <stdlib.h>
#include <wtf/HashMap.h>
#include <wtf/NeverDestroyed.h>
#include <wtf/TinyLRUCache.h>
#include <wtf/text/AtomicStringHash.h>
#include <wtf/text/CString.h>
#include <wtf/text/StringView.h>
#if PLATFORM(GTK)
#include "GtkUtilities.h"
#include <wtf/glib/GUniquePtr.h>
#endif
#if !defined(PATH_MAX)
#define PATH_MAX 4096
#endif
namespace WebCore {
static const char* const gDictionaryDirectories[] = {
"/usr/share/hyphen",
"/usr/local/share/hyphen",
};
static String extractLocaleFromDictionaryFilePath(const String& filePath)
{
// Dictionary files always have the form "hyph_<locale name>.dic"
// so we strip everything except the locale.
String fileName = pathGetFileName(filePath);
static const int prefixLength = 5;
static const int suffixLength = 4;
return fileName.substring(prefixLength, fileName.length() - prefixLength - suffixLength);
}
static void scanDirectoryForDicionaries(const char* directoryPath, HashMap<AtomicString, Vector<String>>& availableLocales)
{
for (auto& filePath : listDirectory(directoryPath, "hyph_*.dic")) {
String locale = extractLocaleFromDictionaryFilePath(filePath).convertToASCIILowercase();
char normalizedPath[PATH_MAX];
if (!realpath(fileSystemRepresentation(filePath).data(), normalizedPath))
continue;
filePath = stringFromFileSystemRepresentation(normalizedPath);
availableLocales.add(locale, Vector<String>()).iterator->value.append(filePath);
String localeReplacingUnderscores = String(locale);
localeReplacingUnderscores.replace('_', '-');
if (locale != localeReplacingUnderscores)
availableLocales.add(localeReplacingUnderscores, Vector<String>()).iterator->value.append(filePath);
size_t dividerPosition = localeReplacingUnderscores.find('-');
if (dividerPosition != notFound) {
localeReplacingUnderscores.truncate(dividerPosition);
availableLocales.add(localeReplacingUnderscores, Vector<String>()).iterator->value.append(filePath);
}
}
}
#if ENABLE(DEVELOPER_MODE)
static void scanTestDictionariesDirectoryIfNecessary(HashMap<AtomicString, Vector<String>>& availableLocales)
{
// It's unfortunate that we need to look for the dictionaries this way, but
// libhyphen doesn't have the concept of installed dictionaries. Instead,
// we have this special case for WebKit tests.
#if PLATFORM(GTK)
CString buildDirectory = webkitBuildDirectory();
GUniquePtr<char> dictionariesPath(g_build_filename(buildDirectory.data(), "DependenciesGTK", "Root", "webkitgtk-test-dicts", nullptr));
if (g_file_test(dictionariesPath.get(), static_cast<GFileTest>(G_FILE_TEST_IS_DIR))) {
scanDirectoryForDicionaries(dictionariesPath.get(), availableLocales);
return;
}
// Try alternative dictionaries path for people not using JHBuild.
dictionariesPath.reset(g_build_filename(buildDirectory.data(), "webkitgtk-test-dicts", nullptr));
scanDirectoryForDicionaries(dictionariesPath.get(), availableLocales);
#elif defined(TEST_HYPHENATAION_PATH)
scanDirectoryForDicionaries(TEST_HYPHENATAION_PATH, availableLocales);
#else
UNUSED_PARAM(availableLocales);
#endif
}
#endif
static HashMap<AtomicString, Vector<String>>& availableLocales()
{
static bool scannedLocales = false;
static HashMap<AtomicString, Vector<String>> availableLocales;
if (!scannedLocales) {
for (size_t i = 0; i < WTF_ARRAY_LENGTH(gDictionaryDirectories); i++)
scanDirectoryForDicionaries(gDictionaryDirectories[i], availableLocales);
#if ENABLE(DEVELOPER_MODE)
scanTestDictionariesDirectoryIfNecessary(availableLocales);
#endif
scannedLocales = true;
}
return availableLocales;
}
bool canHyphenate(const AtomicString& localeIdentifier)
{
if (localeIdentifier.isNull())
return false;
if (availableLocales().contains(localeIdentifier))
return true;
return availableLocales().contains(AtomicString(localeIdentifier.string().convertToASCIILowercase()));
}
class HyphenationDictionary : public RefCounted<HyphenationDictionary> {
WTF_MAKE_NONCOPYABLE(HyphenationDictionary);
WTF_MAKE_FAST_ALLOCATED;
public:
typedef std::unique_ptr<HyphenDict, void(*)(HyphenDict*)> HyphenDictUniquePtr;
virtual ~HyphenationDictionary() { }
static RefPtr<HyphenationDictionary> createNull()
{
return adoptRef(new HyphenationDictionary());
}
static RefPtr<HyphenationDictionary> create(const CString& dictPath)
{
return adoptRef(new HyphenationDictionary(dictPath));
}
HyphenDict* libhyphenDictionary() const
{
return m_libhyphenDictionary.get();
}
private:
HyphenationDictionary(const CString& dictPath)
: m_libhyphenDictionary(HyphenDictUniquePtr(hnj_hyphen_load(dictPath.data()), hnj_hyphen_free))
{
}
HyphenationDictionary()
: m_libhyphenDictionary(HyphenDictUniquePtr(nullptr, hnj_hyphen_free))
{
}
HyphenDictUniquePtr m_libhyphenDictionary;
};
} // namespace WebCore
namespace WTF {
template<>
class TinyLRUCachePolicy<AtomicString, RefPtr<WebCore::HyphenationDictionary>>
{
public:
static TinyLRUCache<AtomicString, RefPtr<WebCore::HyphenationDictionary>, 32>& cache()
{
static NeverDestroyed<TinyLRUCache<AtomicString, RefPtr<WebCore::HyphenationDictionary>, 32>> cache;
return cache;
}
static bool isKeyNull(const AtomicString& localeIdentifier)
{
return localeIdentifier.isNull();
}
static RefPtr<WebCore::HyphenationDictionary> createValueForNullKey()
{
return WebCore::HyphenationDictionary::createNull();
}
static RefPtr<WebCore::HyphenationDictionary> createValueForKey(const AtomicString& dictionaryPath)
{
return WebCore::HyphenationDictionary::create(WebCore::fileSystemRepresentation(dictionaryPath.string()));
}
};
} // namespace WTF
namespace WebCore {
static void countLeadingSpaces(const CString& utf8String, int32_t& pointerOffset, int32_t& characterOffset)
{
pointerOffset = 0;
characterOffset = 0;
const char* stringData = utf8String.data();
UChar32 character = 0;
while (static_cast<unsigned>(pointerOffset) < utf8String.length()) {
int32_t nextPointerOffset = pointerOffset;
U8_NEXT(stringData, nextPointerOffset, static_cast<int32_t>(utf8String.length()), character);
if (character < 0 || !u_isUWhiteSpace(character))
return;
pointerOffset = nextPointerOffset;
characterOffset++;
}
}
size_t lastHyphenLocation(StringView string, size_t beforeIndex, const AtomicString& localeIdentifier)
{
// libhyphen accepts strings in UTF-8 format, but WebCore can only provide StringView
// which stores either UTF-16 or Latin1 data. This is unfortunate for performance
// reasons and we should consider switching to a more flexible hyphenation library
// if it is available.
CString utf8StringCopy = string.toStringWithoutCopying().utf8();
// WebCore often passes strings like " wordtohyphenate" to the platform layer. Since
// libhyphen isn't advanced enough to deal with leading spaces (presumably CoreFoundation
// can), we should find the appropriate indexes into the string to skip them.
int32_t leadingSpaceBytes;
int32_t leadingSpaceCharacters;
countLeadingSpaces(utf8StringCopy, leadingSpaceBytes, leadingSpaceCharacters);
// The libhyphen documentation specifies that this array should be 5 bytes longer than
// the byte length of the input string.
Vector<char> hyphenArray(utf8StringCopy.length() - leadingSpaceBytes + 5);
char* hyphenArrayData = hyphenArray.data();
String lowercaseLocaleIdentifier = AtomicString(localeIdentifier.string().convertToASCIILowercase());
// Web content may specify strings for locales which do not exist or that we do not have.
if (!availableLocales().contains(lowercaseLocaleIdentifier))
return 0;
for (const auto& dictionaryPath : availableLocales().get(lowercaseLocaleIdentifier)) {
RefPtr<HyphenationDictionary> dictionary = WTF::TinyLRUCachePolicy<AtomicString, RefPtr<HyphenationDictionary>>::cache().get(AtomicString(dictionaryPath));
char** replacements = nullptr;
int* positions = nullptr;
int* removedCharacterCounts = nullptr;
hnj_hyphen_hyphenate2(dictionary->libhyphenDictionary(),
utf8StringCopy.data() + leadingSpaceBytes,
utf8StringCopy.length() - leadingSpaceBytes,
hyphenArrayData,
nullptr, /* output parameter for hyphenated word */
&replacements,
&positions,
&removedCharacterCounts);
if (replacements) {
for (unsigned i = 0; i < utf8StringCopy.length() - leadingSpaceBytes - 1; i++)
free(replacements[i]);
free(replacements);
}
free(positions);
free(removedCharacterCounts);
for (int i = beforeIndex - leadingSpaceCharacters - 2; i >= 0; i--) {
// libhyphen will put an odd number in hyphenArrayData at all
// hyphenation points. A number & 1 will be true for odd numbers.
if (hyphenArrayData[i] & 1)
return i + 1 + leadingSpaceCharacters;
}
}
return 0;
}
} // namespace WebCore
#endif // USE(LIBHYPHEN)
|