<!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>[192272] trunk/Source/WebInspectorUI</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/192272">192272</a></dd>
<dt>Author</dt> <dd>mattbaker@apple.com</dd>
<dt>Date</dt> <dd>2015-11-10 14:31:21 -0800 (Tue, 10 Nov 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>Web Inspector: Batch all scheduled layouts and update the view tree in a single animation frame
https://bugs.webkit.org/show_bug.cgi?id=150993
Reviewed by Brian Burg.
Shifts responsibility for scheduling asynchronous layouts from view objects to a controller
layer, implemented as private static methods and properties in the View class. A single animation
frame callback performs a breadth-first traversal of the view tree starting at the root view,
updating views marked as needing a layout.
* UserInterface/Base/Main.js:
(WebInspector.contentLoaded):
Setup root view.
* UserInterface/Views/View.js:
Added private class properties for root view reference and rAF identifier.
(WebInspector.View):
(WebInspector.View.prototype.get layoutPending):
(WebInspector.View.prototype.get parentView):
(WebInspector.View.prototype.makeRootView):
Set current view to be the root of the view hierarchy.
Can only be called once.
(WebInspector.View.prototype.insertSubviewBefore):
No longer appends subview element to parent element, if subview already in the DOM.
Checks that view being inserted isn't the root view.
(WebInspector.View.prototype.removeSubview):
(WebInspector.View.prototype.updateLayout):
Cancels any scheduled layouts for the view, then does a synchronous layout.
(WebInspector.View.prototype.updateLayoutIfNeeded):
(WebInspector.View.prototype.needsLayout):
Schedules view for the next asynchronous layout, if not already scheduled.
(WebInspector.View.prototype.didAttach):
(WebInspector.View.prototype.didDetach):
Inform view of changing parent view.
(WebInspector.View.prototype._layoutSubtree):
(WebInspector.View._scheduleLayoutForView):
Increments dirty counts on ancestor views, schedules a layout if needed.
(WebInspector.View._cancelScheduledLayoutForView):
Decrements dirty counts on ancestor views, cancels a pending layout if needed.
(WebInspector.View._visitViewTreeForLayout):
Animation frame callback. Does a breadth-first traversal of the view tree,
and updates the layout of views marked as dirty.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebInspectorUIChangeLog">trunk/Source/WebInspectorUI/ChangeLog</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceBaseMainjs">trunk/Source/WebInspectorUI/UserInterface/Base/Main.js</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceViewsViewjs">trunk/Source/WebInspectorUI/UserInterface/Views/View.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebInspectorUIChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/ChangeLog (192271 => 192272)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/ChangeLog        2015-11-10 22:22:12 UTC (rev 192271)
+++ trunk/Source/WebInspectorUI/ChangeLog        2015-11-10 22:31:21 UTC (rev 192272)
</span><span class="lines">@@ -1,3 +1,48 @@
</span><ins>+2015-11-10 Matt Baker <mattbaker@apple.com>
+
+ Web Inspector: Batch all scheduled layouts and update the view tree in a single animation frame
+ https://bugs.webkit.org/show_bug.cgi?id=150993
+
+ Reviewed by Brian Burg.
+
+ Shifts responsibility for scheduling asynchronous layouts from view objects to a controller
+ layer, implemented as private static methods and properties in the View class. A single animation
+ frame callback performs a breadth-first traversal of the view tree starting at the root view,
+ updating views marked as needing a layout.
+
+ * UserInterface/Base/Main.js:
+ (WebInspector.contentLoaded):
+ Setup root view.
+
+ * UserInterface/Views/View.js:
+ Added private class properties for root view reference and rAF identifier.
+ (WebInspector.View):
+ (WebInspector.View.prototype.get layoutPending):
+ (WebInspector.View.prototype.get parentView):
+ (WebInspector.View.prototype.makeRootView):
+ Set current view to be the root of the view hierarchy.
+ Can only be called once.
+ (WebInspector.View.prototype.insertSubviewBefore):
+ No longer appends subview element to parent element, if subview already in the DOM.
+ Checks that view being inserted isn't the root view.
+ (WebInspector.View.prototype.removeSubview):
+ (WebInspector.View.prototype.updateLayout):
+ Cancels any scheduled layouts for the view, then does a synchronous layout.
+ (WebInspector.View.prototype.updateLayoutIfNeeded):
+ (WebInspector.View.prototype.needsLayout):
+ Schedules view for the next asynchronous layout, if not already scheduled.
+ (WebInspector.View.prototype.didAttach):
+ (WebInspector.View.prototype.didDetach):
+ Inform view of changing parent view.
+ (WebInspector.View.prototype._layoutSubtree):
+ (WebInspector.View._scheduleLayoutForView):
+ Increments dirty counts on ancestor views, schedules a layout if needed.
+ (WebInspector.View._cancelScheduledLayoutForView):
+ Decrements dirty counts on ancestor views, cancels a pending layout if needed.
+ (WebInspector.View._visitViewTreeForLayout):
+ Animation frame callback. Does a breadth-first traversal of the view tree,
+ and updates the layout of views marked as dirty.
+
</ins><span class="cx"> 2015-11-10 Nikita Vasilyev <nvasilyev@apple.com>
</span><span class="cx">
</span><span class="cx"> Web Inspector: Code coverage profiler: incorrect "in-viewport" detection algorithm
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceBaseMainjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Base/Main.js (192271 => 192272)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Base/Main.js        2015-11-10 22:22:12 UTC (rev 192271)
+++ trunk/Source/WebInspectorUI/UserInterface/Base/Main.js        2015-11-10 22:31:21 UTC (rev 192272)
</span><span class="lines">@@ -355,6 +355,7 @@
</span><span class="cx">
</span><span class="cx"> this._updateDockNavigationItems();
</span><span class="cx"> this._updateToolbarHeight();
</span><ins>+ this._setupViewHierarchy();
</ins><span class="cx">
</span><span class="cx"> this._pendingOpenTabs = [];
</span><span class="cx">
</span><span class="lines">@@ -1373,6 +1374,20 @@
</span><span class="cx"> InspectorFrontendHost.setToolbarHeight(this.toolbar.element.offsetHeight);
</span><span class="cx"> };
</span><span class="cx">
</span><ins>+WebInspector._setupViewHierarchy = function()
+{
+ let rootView = new WebInspector.View(document.body);
+ rootView.addSubview(this.toolbar);
+ rootView.addSubview(this.tabBar);
+ rootView.addSubview(this.tabBrowser);
+ rootView.addSubview(this.splitContentBrowser);
+ rootView.addSubview(this.quickConsole);
+
+ // FIXME: add navigation and details sidebars to the tree once <https://webkit.org/b/151057> is fixed.
+
+ rootView.makeRootView();
+};
+
</ins><span class="cx"> WebInspector._tabBrowserSelectedTabContentViewDidChange = function(event)
</span><span class="cx"> {
</span><span class="cx"> if (this.tabBar.selectedTabBarItem)
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceViewsViewjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Views/View.js (192271 => 192272)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Views/View.js        2015-11-10 22:22:12 UTC (rev 192271)
+++ trunk/Source/WebInspectorUI/UserInterface/Views/View.js        2015-11-10 22:31:21 UTC (rev 192272)
</span><span class="lines">@@ -31,7 +31,10 @@
</span><span class="cx">
</span><span class="cx"> this._element = element || document.createElement("div");
</span><span class="cx"> this._element.__view = this;
</span><ins>+ this._parentView = null;
</ins><span class="cx"> this._subviews = [];
</span><ins>+ this._dirty = false;
+ this._dirtyDescendantsCount = 0;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Public
</span><span class="lines">@@ -43,14 +46,29 @@
</span><span class="cx">
</span><span class="cx"> get layoutPending()
</span><span class="cx"> {
</span><del>- return !!this._scheduledLayoutUpdateIdentifier;
</del><ins>+ return this._dirty;
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+ get parentView()
+ {
+ return this._parentView;
+ }
+
</ins><span class="cx"> get subviews()
</span><span class="cx"> {
</span><span class="cx"> return this._subviews;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ makeRootView()
+ {
+ console.assert(!WebInspector.View._rootView, "Root view already exists.");
+ console.assert(!this._parentView, "Root view cannot be a subview.")
+ if (WebInspector.View._rootView)
+ return;
+
+ WebInspector.View._rootView = this;
+ }
+
</ins><span class="cx"> addSubview(view)
</span><span class="cx"> {
</span><span class="cx"> this.insertSubviewBefore(view, null);
</span><span class="lines">@@ -60,6 +78,7 @@
</span><span class="cx"> {
</span><span class="cx"> console.assert(view instanceof WebInspector.View);
</span><span class="cx"> console.assert(!referenceView || referenceView instanceof WebInspector.View);
</span><ins>+ console.assert(view !== WebInspector.View._rootView, "Root view cannot be a subview.");
</ins><span class="cx">
</span><span class="cx"> if (this._subviews.includes(view)) {
</span><span class="cx"> console.assert(false, "Cannot add view that is already a subview.", view);
</span><span class="lines">@@ -73,7 +92,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> this._subviews.insertAtIndex(view, beforeIndex);
</span><del>- this._element.insertBefore(view.element, referenceView ? referenceView.element : null);
</del><ins>+
+ if (!view.element.parentNode)
+ this._element.insertBefore(view.element, referenceView ? referenceView.element : null);
+
+ view.didAttach(this);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> removeSubview(view)
</span><span class="lines">@@ -88,6 +111,7 @@
</span><span class="cx">
</span><span class="cx"> this._subviews.remove(view, true);
</span><span class="cx"> this._element.removeChild(view.element);
</span><ins>+ view.didDetach();
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> replaceSubview(oldView, newView)
</span><span class="lines">@@ -100,12 +124,13 @@
</span><span class="cx">
</span><span class="cx"> updateLayout()
</span><span class="cx"> {
</span><ins>+ WebInspector.View._cancelScheduledLayoutForView(this);
</ins><span class="cx"> this._layoutSubtree();
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> updateLayoutIfNeeded()
</span><span class="cx"> {
</span><del>- if (!this._scheduledLayoutUpdateIdentifier)
</del><ins>+ if (!this._dirty)
</ins><span class="cx"> return;
</span><span class="cx">
</span><span class="cx"> this.updateLayout();
</span><span class="lines">@@ -113,17 +138,26 @@
</span><span class="cx">
</span><span class="cx"> needsLayout()
</span><span class="cx"> {
</span><del>- if (this._scheduledLayoutUpdateIdentifier)
</del><ins>+ if (this._dirty)
</ins><span class="cx"> return;
</span><span class="cx">
</span><del>- this._scheduledLayoutUpdateIdentifier = requestAnimationFrame(() => {
- this._scheduledLayoutUpdateIdentifier = undefined;
- this._layoutSubtree();
- });
</del><ins>+ WebInspector.View._scheduleLayoutForView(this);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Protected
</span><span class="cx">
</span><ins>+ didAttach(parentView)
+ {
+ console.assert(!this._parentView, "Attached view already has a parent.", this._parentView);
+ this._parentView = parentView;
+ }
+
+ didDetach()
+ {
+ console.assert(this._parentView, "Detached view has no parent.")
+ this._parentView = null;
+ }
+
</ins><span class="cx"> layout()
</span><span class="cx"> {
</span><span class="cx"> // Overridden by subclasses.
</span><span class="lines">@@ -135,14 +169,82 @@
</span><span class="cx">
</span><span class="cx"> _layoutSubtree()
</span><span class="cx"> {
</span><del>- if (this._scheduledLayoutUpdateIdentifier) {
- cancelAnimationFrame(this._scheduledLayoutUpdateIdentifier);
- this._scheduledLayoutUpdateIdentifier = undefined;
- }
</del><ins>+ this._dirty = false;
+ this._dirtyDescendantsCount = 0;
</ins><span class="cx">
</span><span class="cx"> this.layout();
</span><span class="cx">
</span><span class="cx"> for (let view of this._subviews)
</span><span class="cx"> view._layoutSubtree();
</span><span class="cx"> }
</span><ins>+
+ // Private layout controller logic
+
+ static _scheduleLayoutForView(view)
+ {
+ // Asynchronous layouts aren't scheduled until the root view has been set.
+ // If the root view hasn't been set, switch to a synchronous layout.
+ if (!WebInspector.View._rootView) {
+ view._layoutSubtree();
+ return;
+ }
+
+ view._dirty = true;
+
+ let parentView = view.parentView;
+ while (parentView) {
+ parentView._dirtyDescendantsCount++;
+ parentView = parentView.parentView;
+ }
+
+ if (WebInspector.View._scheduledLayoutUpdateIdentifier)
+ return;
+
+ WebInspector.View._scheduledLayoutUpdateIdentifier = requestAnimationFrame(WebInspector.View._visitViewTreeForLayout);
+ }
+
+ static _cancelScheduledLayoutForView(view)
+ {
+ // Asynchronous layouts aren't scheduled until the root view has been set.
+ if (!WebInspector.View._rootView)
+ return;
+
+ let cancelledLayouts = view._dirtyDescendantsCount;
+ if (this._dirty)
+ cancelledLayouts++;
+
+ let parentView = view.parentView;
+ while (parentView) {
+ parentView._dirtyDescendantsCount = Math.max(0, parentView._dirtyDescendantsCount - cancelledLayouts);
+ parentView = parentView.parentView;
+ }
+
+ if (WebInspector.View._rootView._dirtyDescendantsCount || !WebInspector.View._scheduledLayoutUpdateIdentifier)
+ return;
+
+ // No views need layout, so cancel the pending requestAnimationFrame.
+ cancelAnimationFrame(WebInspector.View._scheduledLayoutUpdateIdentifier);
+ WebInspector.View._scheduledLayoutUpdateIdentifier = undefined;
+ }
+
+ static _visitViewTreeForLayout()
+ {
+ console.assert(WebInspector.View._rootView, "Cannot layout view tree without a root.");
+
+ WebInspector.View._scheduledLayoutUpdateIdentifier = undefined;
+
+ let views = [WebInspector.View._rootView];
+ while (views.length) {
+ let view = views.shift();
+ if (view.layoutPending)
+ view._layoutSubtree();
+ else if (view._dirtyDescendantsCount) {
+ views = views.concat(view.subviews);
+ view._dirtyDescendantsCount = 0;
+ }
+ }
+ }
</ins><span class="cx"> };
</span><ins>+
+WebInspector.View._rootView = null;
+WebInspector.View._scheduledLayoutUpdateIdentifier = undefined;
</ins></span></pre>
</div>
</div>
</body>
</html>