Web Inspector: ES6: Show Symbol properties on Objects
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Models / PropertyDescriptor.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.PropertyDescriptor = class PropertyDescriptor extends WebInspector.Object
27 {
28     constructor(descriptor, symbol, isOwnProperty, wasThrown, nativeGetter, isInternalProperty)
29     {
30         super();
31
32         console.assert(descriptor);
33         console.assert(descriptor.name);
34         console.assert(!descriptor.value || descriptor.value instanceof WebInspector.RemoteObject);
35         console.assert(!descriptor.get || descriptor.get instanceof WebInspector.RemoteObject);
36         console.assert(!descriptor.set || descriptor.set instanceof WebInspector.RemoteObject);
37         console.assert(!symbol || symbol instanceof WebInspector.RemoteObject);
38
39         this._name = descriptor.name;
40         this._value = descriptor.value;
41         this._hasValue = "value" in descriptor;
42         this._get = descriptor.get;
43         this._set = descriptor.set;
44         this._symbol = symbol;
45
46         this._writable = descriptor.writable || false;
47         this._configurable = descriptor.configurable || false;
48         this._enumerable = descriptor.enumerable || false;
49
50         this._own = isOwnProperty || false;
51         this._wasThrown = wasThrown || false;
52         this._nativeGetterValue = nativeGetter || false;
53         this._internal = isInternalProperty || false;
54     }
55
56     // Static
57
58     // Runtime.PropertyDescriptor or Runtime.InternalPropertyDescriptor (second argument).
59     static fromPayload(payload, internal)
60     {
61         if (payload.value)
62             payload.value = WebInspector.RemoteObject.fromPayload(payload.value);
63         if (payload.get)
64             payload.get = WebInspector.RemoteObject.fromPayload(payload.get);
65         if (payload.set)
66             payload.set = WebInspector.RemoteObject.fromPayload(payload.set);
67
68         if (payload.symbol)
69             payload.symbol = WebInspector.RemoteObject.fromPayload(payload.symbol);
70
71         if (internal) {
72             console.assert(payload.value);
73             payload.writable = payload.configurable = payload.enumerable = false;
74             payload.isOwn = true;
75         }
76
77         return new WebInspector.PropertyDescriptor(payload, payload.symbol, payload.isOwn, payload.wasThrown, payload.nativeGetter, internal);
78     }
79
80     // Public
81
82     get name()
83     {
84         return this._name;
85     }
86
87     get value()
88     {
89         return this._value;
90     }
91
92     get get()
93     {
94         return this._get;
95     }
96
97     get set()
98     {
99         return this._set;
100     }
101
102     get writable()
103     {
104         return this._writable;
105     }
106
107     get configurable()
108     {
109         return this._configurable;
110     }
111
112     get enumerable()
113     {
114         return this._enumerable;
115     }
116
117     get symbol()
118     {
119         return this._symbol;
120     }
121
122     get isOwnProperty()
123     {
124         return this._own;
125     }
126
127     get wasThrown()
128     {
129         return this._wasThrown;
130     }
131
132     get nativeGetter()
133     {
134         return this._nativeGetterValue;
135     }
136
137     get isInternalProperty()
138     {
139         return this._internal;
140     }
141
142     hasValue()
143     {
144         return this._hasValue;
145     }
146
147     hasGetter()
148     {
149         return this._get && this._get.type === "function";
150     }
151
152     hasSetter()
153     {
154         return this._set && this._set.type === "function";
155     }
156
157     isIndexProperty()
158     {
159         return !isNaN(Number(this._name));
160     }
161
162     isSymbolProperty()
163     {
164         return !!this._symbol;
165     }
166 };