Add support for private names
[WebKit-https.git] / Source / WebCore / bridge / objc / objc_class.mm
1 /*
2  * Copyright (C) 2004, 2012 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 COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "objc_class.h"
28
29 #include "objc_instance.h"
30 #include "WebScriptObject.h"
31
32 namespace JSC {
33 namespace Bindings {
34
35 ObjcClass::ObjcClass(ClassStructPtr aClass)
36     : _isa(aClass)
37 {
38 }
39
40 static CFMutableDictionaryRef classesByIsA = 0;
41
42 static void _createClassesByIsAIfNecessary()
43 {
44     if (!classesByIsA)
45         classesByIsA = CFDictionaryCreateMutable(NULL, 0, NULL, NULL);
46 }
47
48 ObjcClass* ObjcClass::classForIsA(ClassStructPtr isa)
49 {
50     _createClassesByIsAIfNecessary();
51
52     ObjcClass* aClass = (ObjcClass*)CFDictionaryGetValue(classesByIsA, isa);
53     if (!aClass) {
54         aClass = new ObjcClass(isa);
55         CFDictionaryAddValue(classesByIsA, isa, aClass);
56     }
57
58     return aClass;
59 }
60
61 /*
62     By default, a JavaScript method name is produced by concatenating the
63     components of an ObjectiveC method name, replacing ':' with '_', and
64     escaping '_' and '$' with a leading '$', such that '_' becomes "$_" and
65     '$' becomes "$$". For example:
66
67     ObjectiveC name         Default JavaScript name
68         moveTo::                moveTo__
69         moveTo_                 moveTo$_
70         moveTo$_                moveTo$$$_
71
72     This function performs the inverse of that operation.
73
74     @result Fills 'buffer' with the ObjectiveC method name that corresponds to 'JSName'.
75 */
76 typedef Vector<char, 256> JSNameConversionBuffer;
77 static inline void convertJSMethodNameToObjc(const CString& jsName, JSNameConversionBuffer& buffer)
78 {
79     buffer.reserveInitialCapacity(jsName.length() + 1);
80
81     const char* source = jsName.data();
82     while (true) {
83         if (*source == '$') {
84             ++source;
85             buffer.uncheckedAppend(*source);
86         } else if (*source == '_')
87             buffer.uncheckedAppend(':');
88         else
89             buffer.uncheckedAppend(*source);
90
91         if (!*source)
92             return;
93
94         ++source;
95     }
96 }
97
98 MethodList ObjcClass::methodsNamed(PropertyName propertyName, Instance*) const
99 {
100     UString name(propertyName.publicName());
101     if (name.isNull())
102         return MethodList();
103
104     MethodList methodList;
105     if (Method* method = m_methodCache.get(name.impl())) {
106         methodList.append(method);
107         return methodList;
108     }
109
110     CString jsName = name.ascii();
111     JSNameConversionBuffer buffer;
112     convertJSMethodNameToObjc(jsName, buffer);
113     RetainPtr<CFStringRef> methodName(AdoptCF, CFStringCreateWithCString(NULL, buffer.data(), kCFStringEncodingASCII));
114
115     ClassStructPtr thisClass = _isa;
116     while (thisClass && methodList.isEmpty()) {
117         unsigned numMethodsInClass = 0;
118         MethodStructPtr* objcMethodList = class_copyMethodList(thisClass, &numMethodsInClass);
119         for (unsigned i = 0; i < numMethodsInClass; i++) {
120             MethodStructPtr objcMethod = objcMethodList[i];
121             SEL objcMethodSelector = method_getName(objcMethod);
122             const char* objcMethodSelectorName = sel_getName(objcMethodSelector);
123             NSString* mappedName = nil;
124
125             // See if the class wants to exclude the selector from visibility in JavaScript.
126             if ([thisClass respondsToSelector:@selector(isSelectorExcludedFromWebScript:)])
127                 if ([thisClass isSelectorExcludedFromWebScript:objcMethodSelector])
128                     continue;
129
130             // See if the class want to provide a different name for the selector in JavaScript.
131             // Note that we do not do any checks to guarantee uniqueness. That's the responsiblity
132             // of the class.
133             if ([thisClass respondsToSelector:@selector(webScriptNameForSelector:)])
134                 mappedName = [thisClass webScriptNameForSelector:objcMethodSelector];
135
136             if ((mappedName && [mappedName isEqual:(NSString*)methodName.get()]) || strcmp(objcMethodSelectorName, buffer.data()) == 0) {
137                 OwnPtr<Method> method = adoptPtr(new ObjcMethod(thisClass, objcMethodSelector));
138                 methodList.append(method.get());
139                 m_methodCache.add(name.impl(), method.release());
140                 break;
141             }
142         }
143         thisClass = class_getSuperclass(thisClass);
144         free(objcMethodList);
145     }
146
147     return methodList;
148 }
149
150 Field* ObjcClass::fieldNamed(PropertyName propertyName, Instance* instance) const
151 {
152     UString name(propertyName.publicName());
153     if (name.isNull())
154         return 0;
155
156     Field* field = m_fieldCache.get(name.impl());
157     if (field)
158         return field;
159
160     ClassStructPtr thisClass = _isa;
161
162     CString jsName = name.ascii();
163     RetainPtr<CFStringRef> fieldName(AdoptCF, CFStringCreateWithCString(NULL, jsName.data(), kCFStringEncodingASCII));
164     id targetObject = (static_cast<ObjcInstance*>(instance))->getObject();
165     id attributes = [targetObject attributeKeys];
166     if (attributes) {
167         // Class overrides attributeKeys, use that array of key names.
168         unsigned count = [attributes count];
169         for (unsigned i = 0; i < count; i++) {
170             NSString* keyName = [attributes objectAtIndex:i];
171             const char* UTF8KeyName = [keyName UTF8String]; // ObjC actually only supports ASCII names.
172
173             // See if the class wants to exclude the selector from visibility in JavaScript.
174             if ([thisClass respondsToSelector:@selector(isKeyExcludedFromWebScript:)])
175                 if ([thisClass isKeyExcludedFromWebScript:UTF8KeyName])
176                     continue;
177
178             // See if the class want to provide a different name for the selector in JavaScript.
179             // Note that we do not do any checks to guarantee uniqueness. That's the responsiblity
180             // of the class.
181             NSString* mappedName = nil;
182             if ([thisClass respondsToSelector:@selector(webScriptNameForKey:)])
183                 mappedName = [thisClass webScriptNameForKey:UTF8KeyName];
184
185             if ((mappedName && [mappedName isEqual:(NSString*)fieldName.get()]) || [keyName isEqual:(NSString*)fieldName.get()]) {
186                 OwnPtr<Field> newField = adoptPtr(new ObjcField((CFStringRef)keyName));
187                 field = newField.get();
188                 m_fieldCache.add(name.impl(), newField.release());
189                 break;
190             }
191         }
192     } else {
193         // Class doesn't override attributeKeys, so fall back on class runtime
194         // introspection.
195
196         while (thisClass) {
197             unsigned numFieldsInClass = 0;
198             IvarStructPtr* ivarsInClass = class_copyIvarList(thisClass, &numFieldsInClass);
199
200             for (unsigned i = 0; i < numFieldsInClass; i++) {
201                 IvarStructPtr objcIVar = ivarsInClass[i];
202                 const char* objcIvarName = ivar_getName(objcIVar);
203                 NSString* mappedName = 0;
204
205                 // See if the class wants to exclude the selector from visibility in JavaScript.
206                 if ([thisClass respondsToSelector:@selector(isKeyExcludedFromWebScript:)])
207                     if ([thisClass isKeyExcludedFromWebScript:objcIvarName])
208                         continue;
209
210                 // See if the class want to provide a different name for the selector in JavaScript.
211                 // Note that we do not do any checks to guarantee uniqueness. That's the responsiblity
212                 // of the class.
213                 if ([thisClass respondsToSelector:@selector(webScriptNameForKey:)])
214                     mappedName = [thisClass webScriptNameForKey:objcIvarName];
215
216                 if ((mappedName && [mappedName isEqual:(NSString*)fieldName.get()]) || strcmp(objcIvarName, jsName.data()) == 0) {
217                     OwnPtr<Field> newField = adoptPtr(new ObjcField(objcIVar));
218                     field = newField.get();
219                     m_fieldCache.add(name.impl(), newField.release());
220                     break;
221                 }
222             }
223
224             thisClass = class_getSuperclass(thisClass);
225             free(ivarsInClass);
226         }
227     }
228
229     return field;
230 }
231
232 JSValue ObjcClass::fallbackObject(ExecState* exec, Instance* instance, PropertyName propertyName)
233 {
234     ObjcInstance* objcInstance = static_cast<ObjcInstance*>(instance);
235     id targetObject = objcInstance->getObject();
236     
237     if (![targetObject respondsToSelector:@selector(invokeUndefinedMethodFromWebScript:withArguments:)])
238         return jsUndefined();
239     return ObjcFallbackObjectImp::create(exec, exec->lexicalGlobalObject(), objcInstance, propertyName.publicName());
240 }
241
242 }
243 }