Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSMap.h
1 /*
2  * Copyright (C) 2013, 2016 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 "HashMapImpl.h"
29 #include "JSObject.h"
30
31 namespace JSC {
32
33 class JSMapIterator;
34
35 class JSMap final : public HashMapImpl<HashMapBucket<HashMapBucketDataKeyValue>> {
36     using Base = HashMapImpl<HashMapBucket<HashMapBucketDataKeyValue>>;
37 public:
38     friend class JSMapIterator;
39
40     DECLARE_EXPORT_INFO;
41
42     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
43     {
44         return Structure::create(vm, globalObject, prototype, TypeInfo(JSMapType, StructureFlags), info());
45     }
46
47     static JSMap* create(ExecState* exec, VM& vm, Structure* structure)
48     {
49         JSMap* instance = new (NotNull, allocateCell<JSMap>(vm.heap)) JSMap(vm, structure);
50         instance->finishCreation(exec, vm);
51         return instance;
52     }
53
54     ALWAYS_INLINE void set(ExecState* exec, JSValue key, JSValue value)
55     {
56         add(exec, key, value);
57     }
58
59     bool canCloneFastAndNonObservable(Structure*);
60     JSMap* clone(ExecState*, VM&, Structure*);
61
62 private:
63     JSMap(VM& vm, Structure* structure)
64         : Base(vm, structure)
65     {
66     }
67
68     static String toStringName(const JSObject*, ExecState*);
69 };
70
71 inline bool isJSMap(JSCell* from)
72 {
73     static_assert(std::is_final<JSMap>::value, "");
74     return from->type() == JSMapType;
75 }
76
77 inline bool isJSMap(JSValue from)
78 {
79     static_assert(std::is_final<JSMap>::value, "");
80     return from.isCell() && from.asCell()->type() == JSMapType;
81 }
82
83 } // namespace JSC