Changeset 218316 in webkit

Timestamp:

Jun 14, 2017 10:57:27 PM (7 years ago)

Author:

mitz@apple.com

Message:

[Cocoa] Objective-C class whose name begins with an underscore can’t be exported to JavaScript
​https://bugs.webkit.org/show_bug.cgi?id=168578

Reviewed by Geoff Garen.

• API/JSWrapperMap.mm:

(allocateConstructorForCustomClass): Updated for change to forEachProtocolImplementingProtocol.
(-[JSObjCClassInfo allocateConstructorAndPrototype]): Ditto.
(-[JSWrapperMap classInfoForClass:]): If the class name begins with an underscore, check if

it defines conformance to a JSExport-derived protocol and if so, avoid using the
superclass as a substitute as we’d normally do.

• API/ObjcRuntimeExtras.h:

(forEachProtocolImplementingProtocol): Added a "stop" argument to the block to let callers

bail out.

• API/tests/JSExportTests.mm:

(+[JSExportTests classNamePrefixedWithUnderscoreTest]): New test for this.
(runJSExportTests): Run new test.

Location:

trunk/Source/JavaScriptCore

Files:

• API/JSWrapperMap.mm (modified) (4 diffs)
• API/ObjcRuntimeExtras.h (modified) (4 diffs)
• API/tests/JSExportTests.mm (modified) (4 diffs)
• ChangeLog (modified) (1 diff)

trunk/Source/JavaScriptCore/API/JSWrapperMap.mm

@@ -1 +1 @@
 /*
- * Copyright (C) 2013-2015 Apple Inc. All rights reserved.
+ * Copyright (C) 2013-2015, 2017 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -413 +413 @@
     Protocol *exportProtocol = getJSExportProtocol();
     for (Class currentClass = cls; currentClass; currentClass = class_getSuperclass(currentClass)) {
-        forEachProtocolImplementingProtocol(currentClass, exportProtocol, ^(Protocol *protocol) {
+        forEachProtocolImplementingProtocol(currentClass, exportProtocol, ^(Protocol *protocol, bool&) {
             forEachMethodInProtocol(protocol, YES, YES, ^(SEL selector, const char*) {
                 const char* name = sel_getName(selector);
@@ -491 +491 @@
 
         Protocol *exportProtocol = getJSExportProtocol();
-        forEachProtocolImplementingProtocol(m_class, exportProtocol, ^(Protocol *protocol){
+        forEachProtocolImplementingProtocol(m_class, exportProtocol, ^(Protocol *protocol, bool&){
             copyPrototypeProperties(context, m_class, protocol, prototype);
             copyMethodsToObject(context, m_class, protocol, NO, constructor);
@@ -588 +588 @@
 
     // Skip internal classes beginning with '_' - just copy link to the parent class's info.
-    if ('_' == *class_getName(cls))
-        return m_classMap[cls] = [self classInfoForClass:class_getSuperclass(cls)];
+    if ('_' == *class_getName(cls)) {
+        bool conformsToExportProtocol = false;
+        forEachProtocolImplementingProtocol(cls, getJSExportProtocol(), [&conformsToExportProtocol](Protocol *, bool& stop) {
+            conformsToExportProtocol = true;
+            stop = true;
+        });
+
+        if (!conformsToExportProtocol)
+            return m_classMap[cls] = [self classInfoForClass:class_getSuperclass(cls)];
+    }
 
     return m_classMap[cls] = [[[JSObjCClassInfo alloc] initForClass:cls] autorelease];

trunk/Source/JavaScriptCore/API/ObjcRuntimeExtras.h

@@ -1 +1 @@
 /*
- * Copyright (C) 2013 Apple Inc. All rights reserved.
+ * Copyright (C) 2013, 2017 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -43 +43 @@
 }
 
-inline void forEachProtocolImplementingProtocol(Class cls, Protocol *target, void (^callback)(Protocol *))
+inline void forEachProtocolImplementingProtocol(Class cls, Protocol *target, void (^callback)(Protocol *, bool& stop))
 {
     ASSERT(cls);
@@ -57 +57 @@
     free(protocols);
 
+    bool stop = false;
     while (!worklist.isEmpty()) {
         Protocol *protocol = worklist.last();
@@ -66 +67 @@
 
         // If it implements the protocol, make the callback.
-        if (protocolImplementsProtocol(protocol, target))
-            callback(protocol);
+        if (protocolImplementsProtocol(protocol, target)) {
+            callback(protocol, stop);
+            if (stop)
+                break;
+        }
 
         // Add incorporated protocols to the worklist.

trunk/Source/JavaScriptCore/API/tests/JSExportTests.mm

@@ -1 +1 @@
 /*
- * Copyright (C) 2014 Apple Inc. All rights reserved.
+ * Copyright (C) 2014, 2017 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -81 +81 @@
 @end
 
+@interface NoUnderscorePrefix : NSObject
+@end
+
+@implementation NoUnderscorePrefix
+@end
+
+@interface _UnderscorePrefixNoExport : NoUnderscorePrefix
+@end
+
+@implementation _UnderscorePrefixNoExport
+@end
+
+@protocol Initializing <JSExport>
+- (instancetype)init;
+@end
+
+@interface _UnderscorePrefixWithExport : NoUnderscorePrefix <Initializing>
+@end
+
+@implementation _UnderscorePrefixWithExport
+@end
+
 @implementation JSExportTests
 + (void) exportInstanceMethodWithIdProtocolTest
@@ -124 +146 @@
     checkResult(@"Dynamically generated JSExport-ed protocols are ignored", [value isUndefined] && !!context.exception);
 }
+
++ (void)classNamePrefixedWithUnderscoreTest
+{
+    JSContext *context = [[JSContext alloc] init];
+
+    context[@"_UnderscorePrefixNoExport"] = [_UnderscorePrefixNoExport class];
+    context[@"_UnderscorePrefixWithExport"] = [_UnderscorePrefixWithExport class];
+
+    checkResult(@"Non-underscore-prefixed ancestor class used when there are no exports", [context[@"_UnderscorePrefixNoExport"] toObject] == [NoUnderscorePrefix class]);
+    checkResult(@"Underscore-prefixed class used when there are exports", [context[@"_UnderscorePrefixWithExport"] toObject] == [_UnderscorePrefixWithExport class]);
+
+    JSValue *withExportInstance = [context evaluateScript:@"new _UnderscorePrefixWithExport()"];
+    checkResult(@"Exports present on underscore-prefixed class", !context.exception && !withExportInstance.isUndefined);
+}
+
 @end
 
@@ -172 +209 @@
         [JSExportTests exportInstanceMethodWithClassProtocolTest];
         [JSExportTests exportDynamicallyGeneratedProtocolTest];
+        [JSExportTests classNamePrefixedWithUnderscoreTest];
     }
     wrapperLifetimeIsTiedToGlobalObject();

trunk/Source/JavaScriptCore/ChangeLog

@@ +1 @@
+2017-06-14  Dan Bernstein  <mitz@apple.com>
+
+        [Cocoa] Objective-C class whose name begins with an underscore can’t be exported to JavaScript
+        https://bugs.webkit.org/show_bug.cgi?id=168578
+
+        Reviewed by Geoff Garen.
+
+        * API/JSWrapperMap.mm:
+        (allocateConstructorForCustomClass): Updated for change to forEachProtocolImplementingProtocol.
+        (-[JSObjCClassInfo allocateConstructorAndPrototype]): Ditto.
+        (-[JSWrapperMap classInfoForClass:]): If the class name begins with an underscore, check if
+          it defines conformance to a JSExport-derived protocol and if so, avoid using the
+          superclass as a substitute as we’d normally do.
+
+        * API/ObjcRuntimeExtras.h:
+        (forEachProtocolImplementingProtocol): Added a "stop" argument to the block to let callers
+          bail out.
+
+        * API/tests/JSExportTests.mm:
+        (+[JSExportTests classNamePrefixedWithUnderscoreTest]): New test for this.
+        (runJSExportTests): Run new test.
+
 2017-06-14  Yusuke Suzuki  <utatane.tea@gmail.com>