Unreviewed, rolling out r237445.
[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 "UnlinkedSourceCode.h"
31 #include <wtf/HashTraits.h>
32
33 namespace JSC {
34
35 enum class SourceCodeType { EvalType, ProgramType, FunctionType, ModuleType };
36 enum class TypeProfilerEnabled { No, Yes };
37 enum class ControlFlowProfilerEnabled { No, Yes };
38
39 class SourceCodeFlags {
40 public:
41     SourceCodeFlags() = default;
42
43     SourceCodeFlags(
44         SourceCodeType codeType, JSParserStrictMode strictMode, JSParserScriptMode scriptMode, 
45         DerivedContextType derivedContextType, EvalContextType evalContextType, bool isArrowFunctionContext,
46         DebuggerMode debuggerMode, TypeProfilerEnabled typeProfilerEnabled, ControlFlowProfilerEnabled controlFlowProfilerEnabled)
47         : m_flags(
48             (static_cast<unsigned>(debuggerMode) << 8) |
49             (static_cast<unsigned>(typeProfilerEnabled) << 7) |
50             (static_cast<unsigned>(controlFlowProfilerEnabled) << 6) |
51             (static_cast<unsigned>(scriptMode) << 5) |
52             (static_cast<unsigned>(isArrowFunctionContext) << 4) |
53             (static_cast<unsigned>(evalContextType) << 3) |
54             (static_cast<unsigned>(derivedContextType) << 2) |
55             (static_cast<unsigned>(codeType) << 1) |
56             (static_cast<unsigned>(strictMode))
57         )
58     {
59     }
60
61     inline bool operator==(const SourceCodeFlags& rhs) const
62     {
63         return m_flags == rhs.m_flags;
64     }
65
66     unsigned bits() { return m_flags; }
67
68 private:
69     unsigned m_flags { 0 };
70 };
71
72 class SourceCodeKey {
73 public:
74     SourceCodeKey()
75     {
76     }
77
78     SourceCodeKey(
79         const UnlinkedSourceCode& sourceCode, const String& name, SourceCodeType codeType, JSParserStrictMode strictMode, 
80         JSParserScriptMode scriptMode, DerivedContextType derivedContextType, EvalContextType evalContextType, bool isArrowFunctionContext,
81         DebuggerMode debuggerMode, TypeProfilerEnabled typeProfilerEnabled, ControlFlowProfilerEnabled controlFlowProfilerEnabled)
82             : m_sourceCode(sourceCode)
83             , m_name(name)
84             , m_flags(codeType, strictMode, scriptMode, derivedContextType, evalContextType, isArrowFunctionContext, debuggerMode, typeProfilerEnabled, controlFlowProfilerEnabled)
85             , m_hash(sourceCode.hash() ^ m_flags.bits())
86     {
87     }
88
89     SourceCodeKey(WTF::HashTableDeletedValueType)
90         : m_sourceCode(WTF::HashTableDeletedValue)
91     {
92     }
93
94     bool isHashTableDeletedValue() const { return m_sourceCode.isHashTableDeletedValue(); }
95
96     unsigned hash() const { return m_hash; }
97
98     size_t length() const { return m_sourceCode.length(); }
99
100     bool isNull() const { return m_sourceCode.isNull(); }
101
102     // To save memory, we compute our string on demand. It's expected that source
103     // providers cache their strings to make this efficient.
104     StringView string() const { return m_sourceCode.view(); }
105
106     bool operator==(const SourceCodeKey& other) const
107     {
108         return m_hash == other.m_hash
109             && length() == other.length()
110             && m_flags == other.m_flags
111             && m_name == other.m_name
112             && string() == other.string();
113     }
114
115     struct Hash {
116         static unsigned hash(const SourceCodeKey& key) { return key.hash(); }
117         static bool equal(const SourceCodeKey& a, const SourceCodeKey& b) { return a == b; }
118         static const bool safeToCompareToEmptyOrDeleted = false;
119     };
120
121     struct HashTraits : SimpleClassHashTraits<SourceCodeKey> {
122         static const bool hasIsEmptyValueFunction = true;
123         static bool isEmptyValue(const SourceCodeKey& key) { return key.isNull(); }
124     };
125
126 private:
127     UnlinkedSourceCode m_sourceCode;
128     String m_name;
129     SourceCodeFlags m_flags;
130     unsigned m_hash;
131 };
132
133 } // namespace JSC