Adopt #pragma once in JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / parser / SourceCodeKey.h
1 /*
2  * Copyright (C) 2012 Apple Inc. All Rights Reserved.
3  * Copyright (C) 2015 Yusuke Suzuki <utatane.tea@gmail.com>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "ParserModes.h"
30 #include "SourceCode.h"
31 #include <wtf/HashTraits.h>
32
33 namespace JSC {
34
35 enum class SourceCodeType { EvalType, ProgramType, FunctionType, ModuleType };
36
37 class SourceCodeFlags {
38 public:
39     SourceCodeFlags() = default;
40
41     SourceCodeFlags(SourceCodeType codeType, JSParserBuiltinMode builtinMode, JSParserStrictMode strictMode, JSParserScriptMode scriptMode, DerivedContextType derivedContextType, EvalContextType evalContextType, bool isArrowFunctionContext)
42         : m_flags(
43             (static_cast<unsigned>(scriptMode) << 8) |
44             (static_cast<unsigned>(isArrowFunctionContext) << 7) |
45             (static_cast<unsigned>(evalContextType) << 6) |
46             (static_cast<unsigned>(derivedContextType) << 4) |
47             (static_cast<unsigned>(codeType) << 2) |
48             (static_cast<unsigned>(builtinMode) << 1) |
49             (static_cast<unsigned>(strictMode))
50         )
51     {
52     }
53
54     inline bool operator==(const SourceCodeFlags& rhs) const
55     {
56         return m_flags == rhs.m_flags;
57     }
58
59 private:
60     unsigned m_flags { 0 };
61 };
62
63 class SourceCodeKey {
64 public:
65     SourceCodeKey()
66     {
67     }
68
69     SourceCodeKey(const SourceCode& sourceCode, const String& name, SourceCodeType codeType, JSParserBuiltinMode builtinMode, JSParserStrictMode strictMode, JSParserScriptMode scriptMode, DerivedContextType derivedContextType, EvalContextType evalContextType, bool isArrowFunctionContext)
70         : m_sourceCode(sourceCode)
71         , m_name(name)
72         , m_flags(codeType, builtinMode, strictMode, scriptMode, derivedContextType, evalContextType, isArrowFunctionContext)
73         , m_hash(sourceCode.hash())
74     {
75     }
76
77     SourceCodeKey(WTF::HashTableDeletedValueType)
78         : m_sourceCode(WTF::HashTableDeletedValue)
79     {
80     }
81
82     bool isHashTableDeletedValue() const { return m_sourceCode.isHashTableDeletedValue(); }
83
84     unsigned hash() const { return m_hash; }
85
86     size_t length() const { return m_sourceCode.length(); }
87
88     bool isNull() const { return m_sourceCode.isNull(); }
89
90     // To save memory, we compute our string on demand. It's expected that source
91     // providers cache their strings to make this efficient.
92     StringView string() const { return m_sourceCode.view(); }
93
94     bool operator==(const SourceCodeKey& other) const
95     {
96         return m_hash == other.m_hash
97             && length() == other.length()
98             && m_flags == other.m_flags
99             && m_name == other.m_name
100             && string() == other.string();
101     }
102
103     struct Hash {
104         static unsigned hash(const SourceCodeKey& key) { return key.hash(); }
105         static bool equal(const SourceCodeKey& a, const SourceCodeKey& b) { return a == b; }
106         static const bool safeToCompareToEmptyOrDeleted = false;
107     };
108
109     struct HashTraits : SimpleClassHashTraits<SourceCodeKey> {
110         static const bool hasIsEmptyValueFunction = true;
111         static bool isEmptyValue(const SourceCodeKey& key) { return key.isNull(); }
112     };
113
114 private:
115     SourceCode m_sourceCode;
116     String m_name;
117     SourceCodeFlags m_flags;
118     unsigned m_hash;
119 };
120
121 } // namespace JSC