webkitgtk-2.16.5HEADwebkitgtk-2.16.5master

1 files changed, 383 insertions, 0 deletions

diff --git a/Source/WebInspectorUI/UserInterface/Views/ObjectTreeView.js b/Source/WebInspectorUI/UserInterface/Views/ObjectTreeView.js
new file mode 100644
index 000000000..1c1311eb6
--- /dev/null
+++ b/Source/WebInspectorUI/UserInterface/Views/ObjectTreeView.js
@@ -0,0 +1,383 @@
+/*
+ * Copyright (C) 2015 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+WebInspector.ObjectTreeView = class ObjectTreeView extends WebInspector.Object
+{
+    constructor(object, mode, propertyPath, forceExpanding)
+    {
+        super();
+
+        console.assert(object instanceof WebInspector.RemoteObject);
+        console.assert(!propertyPath || propertyPath instanceof WebInspector.PropertyPath);
+
+        var providedPropertyPath = propertyPath instanceof WebInspector.PropertyPath;
+
+        this._object = object;
+        this._mode = mode || WebInspector.ObjectTreeView.defaultModeForObject(object);
+        this._propertyPath = propertyPath || new WebInspector.PropertyPath(this._object, "this");
+        this._expanded = false;
+        this._hasLosslessPreview = false;
+
+        // If ObjectTree is used outside of the console, we do not know when to release
+        // WeakMap entries. Currently collapse would work. For the console, we can just
+        // listen for console clear events. Currently all ObjectTrees are in the console.
+        this._inConsole = true;
+
+        // Always force expanding for classes.
+        if (this._object.isClass())
+            forceExpanding = true;
+
+        this._element = document.createElement("div");
+        this._element.className = "object-tree";
+
+        if (this._object.preview) {
+            this._previewView = new WebInspector.ObjectPreviewView(this._object.preview);
+            this._previewView.setOriginatingObjectInfo(this._object, providedPropertyPath ? propertyPath : null);
+            this._previewView.element.addEventListener("click", this._handlePreviewOrTitleElementClick.bind(this));
+            this._element.appendChild(this._previewView.element);
+
+            if (this._previewView.lossless && !this._propertyPath.parent && !forceExpanding) {
+                this._hasLosslessPreview = true;
+                this.element.classList.add("lossless-preview");
+            }
+        } else {
+            this._titleElement = document.createElement("span");
+            this._titleElement.className = "title";
+            this._titleElement.appendChild(WebInspector.FormattedValue.createElementForRemoteObject(this._object));
+            this._titleElement.addEventListener("click", this._handlePreviewOrTitleElementClick.bind(this));
+            this._element.appendChild(this._titleElement);
+        }
+
+        this._outline = new WebInspector.TreeOutline;
+        this._outline.compact = true;
+        this._outline.customIndent = true;
+        this._outline.element.classList.add("object");
+        this._element.appendChild(this._outline.element);
+
+        // FIXME: Support editable ObjectTrees.
+    }
+
+    // Static
+
+    static defaultModeForObject(object)
+    {
+        if (object.subtype === "class")
+            return WebInspector.ObjectTreeView.Mode.ClassAPI;
+
+        return WebInspector.ObjectTreeView.Mode.Properties;
+    }
+
+    static createEmptyMessageElement(message)
+    {
+        var emptyMessageElement = document.createElement("div");
+        emptyMessageElement.className = "empty-message";
+        emptyMessageElement.textContent = message;
+        return emptyMessageElement;
+    }
+
+    static comparePropertyDescriptors(propertyA, propertyB)
+    {
+        var a = propertyA.name;
+        var b = propertyB.name;
+
+        // Put __proto__ at the bottom.
+        if (a === "__proto__")
+            return 1;
+        if (b === "__proto__")
+            return -1;
+
+        // Put Internal properties at the top.
+        if (propertyA.isInternalProperty && !propertyB.isInternalProperty)
+            return -1;
+        if (propertyB.isInternalProperty && !propertyA.isInternalProperty)
+            return 1;
+
+        // Put Symbol properties at the bottom.
+        if (propertyA.symbol && !propertyB.symbol)
+            return 1;
+        if (propertyB.symbol && !propertyA.symbol)
+            return -1;
+
+        // Symbol properties may have the same description string but be different objects.
+        if (a === b)
+            return 0;
+
+        var diff = 0;
+        var chunk = /^\d+|^\D+/;
+        var chunka, chunkb, anum, bnum;
+        while (diff === 0) {
+            if (!a && b)
+                return -1;
+            if (!b && a)
+                return 1;
+            chunka = a.match(chunk)[0];
+            chunkb = b.match(chunk)[0];
+            anum = !isNaN(chunka);
+            bnum = !isNaN(chunkb);
+            if (anum && !bnum)
+                return -1;
+            if (bnum && !anum)
+                return 1;
+            if (anum && bnum) {
+                diff = chunka - chunkb;
+                if (diff === 0 && chunka.length !== chunkb.length) {
+                    if (!+chunka && !+chunkb) // chunks are strings of all 0s (special case)
+                        return chunka.length - chunkb.length;
+                    else
+                        return chunkb.length - chunka.length;
+                }
+            } else if (chunka !== chunkb)
+                return (chunka < chunkb) ? -1 : 1;
+            a = a.substring(chunka.length);
+            b = b.substring(chunkb.length);
+        }
+        return diff;
+    }
+
+    // Public
+
+    get object()
+    {
+        return this._object;
+    }
+
+    get element()
+    {
+        return this._element;
+    }
+
+    get treeOutline()
+    {
+        return this._outline;
+    }
+
+    get expanded()
+    {
+        return this._expanded;
+    }
+
+    expand()
+    {
+        if (this._expanded)
+            return;
+
+        if (this._hasLosslessPreview)
+            return;
+
+        this._expanded = true;
+        this._element.classList.add("expanded");
+
+        if (this._previewView)
+            this._previewView.showTitle();
+
+        this._trackWeakEntries();
+
+        this.update();
+    }
+
+    collapse()
+    {
+        if (!this._expanded)
+            return;
+
+        this._expanded = false;
+        this._element.classList.remove("expanded");
+
+        if (this._previewView)
+            this._previewView.showPreview();
+
+        this._untrackWeakEntries();
+    }
+
+    showOnlyProperties()
+    {
+        this._inConsole = false;
+
+        this._element.classList.add("properties-only");
+    }
+
+    appendTitleSuffix(suffixElement)
+    {
+        if (this._previewView)
+            this._previewView.element.appendChild(suffixElement);
+        else
+            this._titleElement.appendChild(suffixElement);
+    }
+
+    appendExtraPropertyDescriptor(propertyDescriptor)
+    {
+        if (!this._extraProperties)
+            this._extraProperties = [];
+
+        this._extraProperties.push(propertyDescriptor);
+    }
+
+    // Protected
+
+    update()
+    {
+        if (this._object.isCollectionType() && this._mode === WebInspector.ObjectTreeView.Mode.Properties)
+            this._object.getCollectionEntries(0, 100, this._updateChildren.bind(this, this._updateEntries));
+        else if (this._object.isClass())
+            this._object.classPrototype.getDisplayablePropertyDescriptors(this._updateChildren.bind(this, this._updateProperties));
+        else
+            this._object.getDisplayablePropertyDescriptors(this._updateChildren.bind(this, this._updateProperties));
+    }
+
+    // Private
+
+    _updateChildren(handler, list)
+    {
+        this._outline.removeChildren();
+
+        if (!list) {
+            var errorMessageElement = WebInspector.ObjectTreeView.createEmptyMessageElement(WebInspector.UIString("Could not fetch properties. Object may no longer exist."));
+            this._outline.appendChild(new WebInspector.TreeElement(errorMessageElement, null, false));
+            return;
+        }
+
+        handler.call(this, list, this._propertyPath);
+
+        this.dispatchEventToListeners(WebInspector.ObjectTreeView.Event.Updated);
+    }
+
+    _updateEntries(entries, propertyPath)
+    {
+        for (var entry of entries) {
+            if (entry.key) {
+                this._outline.appendChild(new WebInspector.ObjectTreeMapKeyTreeElement(entry.key, propertyPath));
+                this._outline.appendChild(new WebInspector.ObjectTreeMapValueTreeElement(entry.value, propertyPath, entry.key));
+            } else
+                this._outline.appendChild(new WebInspector.ObjectTreeSetIndexTreeElement(entry.value, propertyPath));
+        }
+
+        if (!this._outline.children.length) {
+            var emptyMessageElement = WebInspector.ObjectTreeView.createEmptyMessageElement(WebInspector.UIString("No Entries"));
+            this._outline.appendChild(new WebInspector.TreeElement(emptyMessageElement, null, false));
+        }
+
+        // Show the prototype so users can see the API.
+        this._object.getOwnPropertyDescriptor("__proto__", (propertyDescriptor) => {
+            if (propertyDescriptor)
+                this._outline.appendChild(new WebInspector.ObjectTreePropertyTreeElement(propertyDescriptor, propertyPath, this._mode));
+        });
+    }
+
+    _updateProperties(properties, propertyPath)
+    {
+        if (this._extraProperties)
+            properties = properties.concat(this._extraProperties);
+
+        properties.sort(WebInspector.ObjectTreeView.comparePropertyDescriptors);
+
+        var isArray = this._object.isArray();
+        var isPropertyMode = this._mode === WebInspector.ObjectTreeView.Mode.Properties;
+
+        var hadProto = false;
+        for (var propertyDescriptor of properties) {
+            // COMPATIBILITY (iOS 8): Sometimes __proto__ is not a value, but a get/set property.
+            // In those cases it is actually not useful to show.
+            if (propertyDescriptor.name === "__proto__" && !propertyDescriptor.hasValue())
+                continue;
+
+            if (isArray && isPropertyMode) {
+                if (propertyDescriptor.isIndexProperty())
+                    this._outline.appendChild(new WebInspector.ObjectTreeArrayIndexTreeElement(propertyDescriptor, propertyPath));
+                else if (propertyDescriptor.name === "__proto__")
+                    this._outline.appendChild(new WebInspector.ObjectTreePropertyTreeElement(propertyDescriptor, propertyPath, this._mode));
+            } else
+                this._outline.appendChild(new WebInspector.ObjectTreePropertyTreeElement(propertyDescriptor, propertyPath, this._mode));
+
+            if (propertyDescriptor.name === "__proto__")
+                hadProto = true;
+        }
+
+        if (!this._outline.children.length || (hadProto && this._outline.children.length === 1)) {
+            var emptyMessageElement = WebInspector.ObjectTreeView.createEmptyMessageElement(WebInspector.UIString("No Properties"));
+            this._outline.insertChild(new WebInspector.TreeElement(emptyMessageElement, null, false), 0);
+        }
+    }
+
+    _handlePreviewOrTitleElementClick(event)
+    {
+        if (this._hasLosslessPreview)
+            return;
+
+        if (!this._expanded)
+            this.expand();
+        else
+            this.collapse();
+
+        event.stopPropagation();
+    }
+
+    _trackWeakEntries()
+    {
+        if (this._trackingEntries)
+            return;
+
+        if (!this._object.isWeakCollection())
+            return;
+
+        this._trackingEntries = true;
+
+        if (this._inConsole) {
+            WebInspector.logManager.addEventListener(WebInspector.LogManager.Event.Cleared, this._untrackWeakEntries, this);
+            WebInspector.logManager.addEventListener(WebInspector.LogManager.Event.SessionStarted, this._untrackWeakEntries, this);
+        }
+    }
+
+    _untrackWeakEntries()
+    {
+        if (!this._trackingEntries)
+            return;
+
+        if (!this._object.isWeakCollection())
+            return;
+
+        this._trackingEntries = false;
+
+        this._object.releaseWeakCollectionEntries();
+
+        if (this._inConsole) {
+            WebInspector.logManager.removeEventListener(WebInspector.LogManager.Event.Cleared, this._untrackWeakEntries, this);
+            WebInspector.logManager.removeEventListener(WebInspector.LogManager.Event.SessionStarted, this._untrackWeakEntries, this);
+        }
+
+        // FIXME: This only tries to release weak entries if this object was a WeakMap.
+        // If there was a WeakMap expanded in a sub-object, we will never release those values.
+        // Should we attempt walking the entire tree and release weak collections?
+    }
+};
+
+WebInspector.ObjectTreeView.Mode = {
+    Properties: Symbol("object-tree-properties"),      // Properties
+    PrototypeAPI: Symbol("object-tree-prototype-api"), // API view on a live object instance, so getters can be invoked.
+    ClassAPI: Symbol("object-tree-class-api"),         // API view without an object instance, can not invoke getters.
+};
+
+WebInspector.ObjectTreeView.Event = {
+    Updated: "object-tree-updated",
+};