Web Inspector: Array/Collection Sizes should be visible and distinct
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Models / ObjectPreview.js
1 /*
2  * Copyright (C) 2015 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 WebInspector.ObjectPreview = function(type, subtype, description, lossless, overflow, properties, entries, size)
27 {
28     WebInspector.Object.call(this);
29
30     console.assert(type);
31     console.assert(typeof lossless === "boolean");
32     console.assert(!properties || !properties.length || properties[0] instanceof WebInspector.PropertyPreview);
33     console.assert(!entries || !entries.length || entries[0] instanceof WebInspector.CollectionEntryPreview);
34
35     this._type = type;
36     this._subtype = subtype;
37     this._description = description || "";
38     this._lossless = lossless;
39     this._overflow = overflow || false;
40     this._size = size;
41
42     this._properties = properties || null;
43     this._entries = entries || null;
44 };
45
46 // Runtime.ObjectPreview.
47 WebInspector.ObjectPreview.fromPayload = function(payload)
48 {
49     if (payload.properties)
50         payload.properties = payload.properties.map(function(property) { return WebInspector.PropertyPreview.fromPayload(property); });
51     if (payload.entries)
52         payload.entries = payload.entries.map(function(entry) { return WebInspector.CollectionEntryPreview.fromPayload(entry); });
53
54     if (payload.subtype === "array") {
55         // COMPATIBILITY (iOS 8): Runtime.ObjectPreview did not have size property,
56         // instead it was tacked onto the end of the description, like "Array[#]".
57         var match = payload.description.match(/\[(\d+)\]$/);
58         if (match) {
59             payload.size = parseInt(match[1]);
60             payload.description = payload.description.replace(/\[\d+\]$/, "");
61         }
62     }
63
64     return new WebInspector.ObjectPreview(payload.type, payload.subtype, payload.description, payload.lossless, payload.overflow, payload.properties, payload.entries, payload.size);
65 };
66
67 WebInspector.ObjectPreview.prototype = {
68     constructor: WebInspector.ObjectPreview,
69     __proto__: WebInspector.Object.prototype,
70
71     // Public
72
73     get type()
74     {
75         return this._type;
76     },
77
78     get subtype()
79     {
80         return this._subtype;
81     },
82
83     get description()
84     {
85         return this._description;
86     },
87
88     get lossless()
89     {
90         return this._lossless;
91     },
92
93     get overflow()
94     {
95         return this._overflow;
96     },
97
98     get propertyPreviews()
99     {
100         return this._properties;
101     },
102
103     get collectionEntryPreviews()
104     {
105         return this._entries;
106     },
107
108     get size()
109     {
110         return this._size;
111     },
112
113     hasSize: function()
114     {
115         return this._size !== undefined && (this._subtype === "array" || this._subtype === "set" || this._subtype === "map" || this._subtype === "weakmap");
116     }
117 };