We should support CreateThis in the FTL
[WebKit-https.git] / Source / JavaScriptCore / runtime / PropertyDescriptor.h
1 /*
2  * Copyright (C) 2009 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "DefinePropertyAttributes.h"
29 #include "JSCJSValue.h"
30
31 namespace JSC {
32
33 class GetterSetter;
34
35 class PropertyDescriptor {
36 public:
37     PropertyDescriptor()
38         : m_attributes(defaultAttributes)
39         , m_seenAttributes(0)
40     {
41     }
42     PropertyDescriptor(JSValue value, unsigned attributes)
43         : m_value(value)
44         , m_attributes(attributes)
45         , m_seenAttributes(EnumerablePresent | ConfigurablePresent | WritablePresent)
46     {
47         ASSERT(m_value);
48         ASSERT(!m_value.isGetterSetter());
49         ASSERT(!m_value.isCustomGetterSetter());
50     }
51     JS_EXPORT_PRIVATE bool writable() const;
52     JS_EXPORT_PRIVATE bool enumerable() const;
53     JS_EXPORT_PRIVATE bool configurable() const;
54     JS_EXPORT_PRIVATE bool isDataDescriptor() const;
55     bool isGenericDescriptor() const;
56     JS_EXPORT_PRIVATE bool isAccessorDescriptor() const;
57     unsigned attributes() const { return m_attributes; }
58     JSValue value() const { return m_value; }
59     GetterSetter* slowGetterSetter(ExecState*); // Be aware that this will lazily allocate a GetterSetter object. It's much better to use getter() and setter() individually if possible.
60     JS_EXPORT_PRIVATE JSValue getter() const;
61     JS_EXPORT_PRIVATE JSValue setter() const;
62     JSObject* getterObject() const;
63     JSObject* setterObject() const;
64     JS_EXPORT_PRIVATE void setUndefined();
65     JS_EXPORT_PRIVATE void setDescriptor(JSValue, unsigned attributes);
66     JS_EXPORT_PRIVATE void setCustomDescriptor(unsigned attributes);
67     JS_EXPORT_PRIVATE void setAccessorDescriptor(GetterSetter* accessor, unsigned attributes);
68     JS_EXPORT_PRIVATE void setWritable(bool);
69     JS_EXPORT_PRIVATE void setEnumerable(bool);
70     JS_EXPORT_PRIVATE void setConfigurable(bool);
71     void setValue(JSValue value) { m_value = value; }
72     JS_EXPORT_PRIVATE void setSetter(JSValue);
73     JS_EXPORT_PRIVATE void setGetter(JSValue);
74     bool isEmpty() const { return !(m_value || m_getter || m_setter || m_seenAttributes); }
75     bool writablePresent() const { return m_seenAttributes & WritablePresent; }
76     bool enumerablePresent() const { return m_seenAttributes & EnumerablePresent; }
77     bool configurablePresent() const { return m_seenAttributes & ConfigurablePresent; }
78     bool setterPresent() const { return !!m_setter; }
79     bool getterPresent() const { return !!m_getter; }
80     bool equalTo(ExecState*, const PropertyDescriptor& other) const;
81     bool attributesEqual(const PropertyDescriptor& other) const;
82     unsigned attributesOverridingCurrent(const PropertyDescriptor& current) const;
83
84 private:
85     JS_EXPORT_PRIVATE static unsigned defaultAttributes;
86     bool operator==(const PropertyDescriptor&) { return false; }
87     enum { WritablePresent = 1, EnumerablePresent = 2, ConfigurablePresent = 4};
88     // May be a getter/setter
89     JSValue m_value;
90     JSValue m_getter;
91     JSValue m_setter;
92     unsigned m_attributes;
93     unsigned m_seenAttributes;
94 };
95
96 inline PropertyDescriptor toPropertyDescriptor(JSValue value, JSValue getter, JSValue setter, DefinePropertyAttributes attributes)
97 {
98     // We assume that validation is already done.
99     PropertyDescriptor desc;
100
101     if (std::optional<bool> enumerable = attributes.enumerable())
102         desc.setEnumerable(enumerable.value());
103
104     if (std::optional<bool> configurable = attributes.configurable())
105         desc.setConfigurable(configurable.value());
106
107     if (attributes.hasValue())
108         desc.setValue(value);
109
110     if (std::optional<bool> writable = attributes.writable())
111         desc.setWritable(writable.value());
112
113     if (attributes.hasGet())
114         desc.setGetter(getter);
115
116     if (attributes.hasSet())
117         desc.setSetter(setter);
118
119     return desc;
120 }
121
122 }