[iOS] Upstream PLATFORM(IOS) changes to Source/WebKit/
[WebKit-https.git] / Source / WebKit / mac / Misc / WebLocalizableStrings.mm
1 /*
2  * Copyright (C) 2005 Apple Computer, 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 #import <WebKit/WebLocalizableStrings.h>
30
31 #import <wtf/Assertions.h>
32 #import <wtf/MainThread.h>
33
34 #if PLATFORM(IOS)
35 #import "WebLocalizableStringsInternal.h"
36 #import <dispatch/dispatch.h>
37 #endif
38
39 WebLocalizableStringsBundle WebKitLocalizableStringsBundle = { "com.apple.WebKit", 0 };
40
41 NSString *WebLocalizedString(WebLocalizableStringsBundle *stringsBundle, const char *key)
42 {
43     // This function is not thread-safe due at least to its unguarded use of the mainBundle static variable
44     // and its use of [NSBundle localizedStringForKey:::], which is not guaranteed to be thread-safe. If
45     // we decide we need to use this on background threads, we'll need to add locking here and make sure
46     // it doesn't affect performance.
47 #if !PLATFORM(IOS)
48     ASSERT(isMainThread());
49 #endif
50
51     NSBundle *bundle;
52     if (stringsBundle == NULL) {
53         static NSBundle *mainBundle;
54         if (mainBundle == nil) {
55             mainBundle = [NSBundle mainBundle];
56             ASSERT(mainBundle);
57             CFRetain(mainBundle);
58         }
59         bundle = mainBundle;
60     } else {
61         bundle = stringsBundle->bundle;
62         if (bundle == nil) {
63             bundle = [NSBundle bundleWithIdentifier:[NSString stringWithUTF8String:stringsBundle->identifier]];
64             ASSERT(bundle);
65             stringsBundle->bundle = bundle;
66         }
67     }
68     NSString *notFound = @"localized string not found";
69     CFStringRef keyString = CFStringCreateWithCStringNoCopy(NULL, key, kCFStringEncodingUTF8, kCFAllocatorNull);
70     NSString *result = [bundle localizedStringForKey:(NSString *)keyString value:notFound table:nil];
71     CFRelease(keyString);
72     ASSERT_WITH_MESSAGE(result != notFound, "could not find localizable string %s in bundle", key);
73     return result;
74 }
75
76 #if PLATFORM(IOS)
77 // See <rdar://problem/7902473> Optimize WebLocalizedString for why we do this on a background thread on a timer callback
78 static void LoadWebLocalizedStringsTimerCallback(CFRunLoopTimerRef timer, void *info)
79 {
80     dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_LOW, 0), ^{ 
81         UI_STRING_KEY_INTERNAL("Typing", "Typing (Undo action name)", "We don't care if we find this string, but searching for it will load the plist and save the results.");
82     });
83 }
84
85 void LoadWebLocalizedStrings(void)
86 {
87     CFRunLoopTimerRef timer = CFRunLoopTimerCreate(kCFAllocatorDefault, CFAbsoluteTimeGetCurrent(), 0, 0, 0, &LoadWebLocalizedStringsTimerCallback, NULL);
88     CFRunLoopAddTimer(CFRunLoopGetCurrent(), timer, kCFRunLoopCommonModes);
89     CFRelease(timer);
90 }
91 #endif