<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[198793] trunk/Source/WebKit2</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/198793">198793</a></dd>
<dt>Author</dt> <dd>bburg@apple.com</dd>
<dt>Date</dt> <dd>2016-03-29 13:19:51 -0700 (Tue, 29 Mar 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Web Automation: Add SPI to tell whether an NSEvent was synthesized for automation
https://bugs.webkit.org/show_bug.cgi?id=155963
<rdar://problem/25405747>
Reviewed by Timothy Hatcher.
Tag all NSEvents that were synthesized with an associated object before sending.
Do all associated object work below the API layer so we don't get into trouble
using things that may be guarded by WK_API_ENABLED.
* UIProcess/API/Cocoa/_WKAutomationSession.h:
* UIProcess/API/Cocoa/_WKAutomationSession.mm:
(-[_WKAutomationSession wasEventSynthesizedForAutomation:]):
Forward to the wrapped session object.
* UIProcess/Automation/WebAutomationSession.h:
* UIProcess/Cocoa/WebAutomationSessionCocoa.mm:
(WebKit::WebAutomationSession::sendSynthesizedEventsToPage):
Tag outgoing NSEvents with the session identifier as an associated object.
(WebKit::WebAutomationSession::wasEventSynthesizedForAutomation):
Check an incoming NSEvent to see if its associated object is the session identifier.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoa_WKAutomationSessionh">trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKAutomationSession.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoa_WKAutomationSessionmm">trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKAutomationSession.mm</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAutomationWebAutomationSessionh">trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessCocoaWebAutomationSessionCocoamm">trunk/Source/WebKit2/UIProcess/Cocoa/WebAutomationSessionCocoa.mm</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (198792 => 198793)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog 2016-03-29 20:19:45 UTC (rev 198792)
+++ trunk/Source/WebKit2/ChangeLog 2016-03-29 20:19:51 UTC (rev 198793)
</span><span class="lines">@@ -1,3 +1,28 @@
</span><ins>+2016-03-29 Brian Burg <bburg@apple.com>
+
+ Web Automation: Add SPI to tell whether an NSEvent was synthesized for automation
+ https://bugs.webkit.org/show_bug.cgi?id=155963
+ <rdar://problem/25405747>
+
+ Reviewed by Timothy Hatcher.
+
+ Tag all NSEvents that were synthesized with an associated object before sending.
+ Do all associated object work below the API layer so we don't get into trouble
+ using things that may be guarded by WK_API_ENABLED.
+
+ * UIProcess/API/Cocoa/_WKAutomationSession.h:
+ * UIProcess/API/Cocoa/_WKAutomationSession.mm:
+ (-[_WKAutomationSession wasEventSynthesizedForAutomation:]):
+ Forward to the wrapped session object.
+
+ * UIProcess/Automation/WebAutomationSession.h:
+ * UIProcess/Cocoa/WebAutomationSessionCocoa.mm:
+ (WebKit::WebAutomationSession::sendSynthesizedEventsToPage):
+ Tag outgoing NSEvents with the session identifier as an associated object.
+
+ (WebKit::WebAutomationSession::wasEventSynthesizedForAutomation):
+ Check an incoming NSEvent to see if its associated object is the session identifier.
+
</ins><span class="cx"> 2016-03-28 Brian Burg <bburg@apple.com>
</span><span class="cx">
</span><span class="cx"> Web Automation: implement Automation.performMouseInteraction
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoa_WKAutomationSessionh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKAutomationSession.h (198792 => 198793)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKAutomationSession.h 2016-03-29 20:19:45 UTC (rev 198792)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKAutomationSession.h 2016-03-29 20:19:51 UTC (rev 198793)
</span><span class="lines">@@ -40,6 +40,8 @@
</span><span class="cx"> @property (nonatomic, weak) id <_WKAutomationSessionDelegate> delegate;
</span><span class="cx"> @property (nonatomic, readonly, getter=isPaired) BOOL paired;
</span><span class="cx">
</span><ins>+- (BOOL)wasEventSynthesizedForAutomation:(NSEvent *)event;
+
</ins><span class="cx"> @end
</span><span class="cx">
</span><span class="cx"> NS_ASSUME_NONNULL_END
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoa_WKAutomationSessionmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKAutomationSession.mm (198792 => 198793)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKAutomationSession.mm 2016-03-29 20:19:45 UTC (rev 198792)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKAutomationSession.mm 2016-03-29 20:19:51 UTC (rev 198793)
</span><span class="lines">@@ -83,6 +83,11 @@
</span><span class="cx"> return _session->isPaired();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+- (BOOL)wasEventSynthesizedForAutomation:(NSEvent *)event
+{
+ return _session->wasEventSynthesizedForAutomation(event);
+}
+
</ins><span class="cx"> #pragma mark WKObject protocol implementation
</span><span class="cx">
</span><span class="cx"> - (API::Object&)_apiObject
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAutomationWebAutomationSessionh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h (198792 => 198793)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h 2016-03-29 20:19:45 UTC (rev 198792)
+++ trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h 2016-03-29 20:19:51 UTC (rev 198793)
</span><span class="lines">@@ -54,6 +54,7 @@
</span><span class="cx">
</span><span class="cx"> #if USE(APPKIT)
</span><span class="cx"> OBJC_CLASS NSArray;
</span><ins>+OBJC_CLASS NSEvent;
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> namespace WebKit {
</span><span class="lines">@@ -112,6 +113,10 @@
</span><span class="cx"> void messageOfCurrentJavaScriptDialog(Inspector::ErrorString&, const String& browsingContextHandle, String* text) override;
</span><span class="cx"> void setUserInputForCurrentJavaScriptPrompt(Inspector::ErrorString&, const String& browsingContextHandle, const String& text) override;
</span><span class="cx">
</span><ins>+#if USE(APPKIT)
+ bool wasEventSynthesizedForAutomation(NSEvent *);
+#endif
+
</ins><span class="cx"> private:
</span><span class="cx"> WebPageProxy* webPageProxyForHandle(const String&);
</span><span class="cx"> String handleForWebPageProxy(const WebPageProxy&);
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessCocoaWebAutomationSessionCocoamm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/Cocoa/WebAutomationSessionCocoa.mm (198792 => 198793)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/Cocoa/WebAutomationSessionCocoa.mm 2016-03-29 20:19:45 UTC (rev 198792)
+++ trunk/Source/WebKit2/UIProcess/Cocoa/WebAutomationSessionCocoa.mm 2016-03-29 20:19:51 UTC (rev 198793)
</span><span class="lines">@@ -39,17 +39,24 @@
</span><span class="cx">
</span><span class="cx"> #if USE(APPKIT)
</span><span class="cx">
</span><ins>+static const void *synthesizedAutomationEventAssociatedObjectKey = &synthesizedAutomationEventAssociatedObjectKey;
+
</ins><span class="cx"> void WebAutomationSession::sendSynthesizedEventsToPage(WebPageProxy& page, NSArray *eventsToSend)
</span><span class="cx"> {
</span><span class="cx"> NSWindow *window = page.platformWindow();
</span><span class="cx">
</span><span class="cx"> for (NSEvent *event in eventsToSend) {
</span><del>- // FIXME: <https://www.webkit.org/b/155963> Set an associated object with a per-session identifier.
- // This will allow a WebKit2 client to tell apart events synthesized on behalf of an automation command.
</del><ins>+ objc_setAssociatedObject(event, &synthesizedAutomationEventAssociatedObjectKey, m_sessionIdentifier, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
</ins><span class="cx"> [window sendEvent:event];
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+bool WebAutomationSession::wasEventSynthesizedForAutomation(NSEvent *event)
+{
+ NSString *senderSessionIdentifier = objc_getAssociatedObject(event, &synthesizedAutomationEventAssociatedObjectKey);
+ return [senderSessionIdentifier isEqualToString:m_sessionIdentifier];
+}
+
</ins><span class="cx"> void WebAutomationSession::platformSimulateMouseInteraction(WebPageProxy& page, const WebCore::IntPoint& viewPosition, Inspector::Protocol::Automation::MouseInteraction interaction, Inspector::Protocol::Automation::MouseButton button, WebEvent::Modifiers keyModifiers)
</span><span class="cx"> {
</span><span class="cx"> IntRect windowRect;
</span></span></pre>
</div>
</div>
</body>
</html>