Cache bytecode to disk
[WebKit-https.git] / Source / JavaScriptCore / runtime / RegExp.h
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2007, 2008, 2009, 2016 Apple Inc. All rights reserved.
4  *  Copyright (C) 2009 Torch Mobile, Inc.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Lesser General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Lesser General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Lesser General Public
17  *  License along with this library; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 #pragma once
23
24 #include "ConcurrentJSLock.h"
25 #include "MatchResult.h"
26 #include "RegExpKey.h"
27 #include "Structure.h"
28 #include "Yarr.h"
29 #include <wtf/Forward.h>
30 #include <wtf/text/WTFString.h>
31
32 #if ENABLE(YARR_JIT)
33 #include "YarrJIT.h"
34 #endif
35
36 namespace JSC {
37
38 struct RegExpRepresentation;
39 class VM;
40
41 JS_EXPORT_PRIVATE RegExpFlags regExpFlags(const String&);
42
43 class RegExp final : public JSCell {
44     friend class CachedRegExp;
45
46 public:
47     typedef JSCell Base;
48     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
49
50     JS_EXPORT_PRIVATE static RegExp* create(VM&, const String& pattern, RegExpFlags);
51     static const bool needsDestruction = true;
52     static void destroy(JSCell*);
53     static size_t estimatedSize(JSCell*, VM&);
54     JS_EXPORT_PRIVATE static void dumpToStream(const JSCell*, PrintStream&);
55
56     bool global() const { return m_flags & FlagGlobal; }
57     bool ignoreCase() const { return m_flags & FlagIgnoreCase; }
58     bool multiline() const { return m_flags & FlagMultiline; }
59     bool sticky() const { return m_flags & FlagSticky; }
60     bool globalOrSticky() const { return global() || sticky(); }
61     bool unicode() const { return m_flags & FlagUnicode; }
62     bool dotAll() const { return m_flags & FlagDotAll; }
63
64     const String& pattern() const { return m_patternString; }
65
66     bool isValid() const { return !Yarr::hasError(m_constructionErrorCode) && m_flags != InvalidFlags; }
67     const char* errorMessage() const { return Yarr::errorMessage(m_constructionErrorCode); }
68     JSObject* errorToThrow(ExecState* exec) { return Yarr::errorToThrow(exec, m_constructionErrorCode); }
69     void reset()
70     {
71         m_state = NotCompiled;
72         m_constructionErrorCode = Yarr::ErrorCode::NoError;
73     }
74
75     JS_EXPORT_PRIVATE int match(VM&, const String&, unsigned startOffset, Vector<int>& ovector);
76
77     // Returns false if we couldn't run the regular expression for any reason.
78     bool matchConcurrently(VM&, const String&, unsigned startOffset, int& position, Vector<int>& ovector);
79     
80     JS_EXPORT_PRIVATE MatchResult match(VM&, const String&, unsigned startOffset);
81
82     bool matchConcurrently(VM&, const String&, unsigned startOffset, MatchResult&);
83
84     // Call these versions of the match functions if you're desperate for performance.
85     template<typename VectorType>
86     int matchInline(VM&, const String&, unsigned startOffset, VectorType& ovector);
87     MatchResult matchInline(VM&, const String&, unsigned startOffset);
88     
89     unsigned numSubpatterns() const { return m_numSubpatterns; }
90
91     bool hasNamedCaptures()
92     {
93         return !m_captureGroupNames.isEmpty();
94     }
95
96     String getCaptureGroupName(unsigned i)
97     {
98         if (!i || m_captureGroupNames.size() <= i)
99             return String();
100         return m_captureGroupNames[i];
101     }
102
103     unsigned subpatternForName(String groupName)
104     {
105         auto it = m_namedGroupToParenIndex.find(groupName);
106         if (it == m_namedGroupToParenIndex.end())
107             return 0;
108         return it->value;
109     }
110
111     bool hasCode()
112     {
113         return m_state != NotCompiled;
114     }
115
116     bool hasCodeFor(Yarr::YarrCharSize);
117     bool hasMatchOnlyCodeFor(Yarr::YarrCharSize);
118
119     void deleteCode();
120
121 #if ENABLE(REGEXP_TRACING)
122     void printTraceData();
123 #endif
124
125     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
126     {
127         return Structure::create(vm, globalObject, prototype, TypeInfo(CellType, StructureFlags), info());
128     }
129
130     DECLARE_INFO;
131
132     RegExpKey key() { return RegExpKey(m_flags, m_patternString); }
133
134 protected:
135     void finishCreation(VM&);
136
137 private:
138     friend class RegExpCache;
139     RegExp(VM&, const String&, RegExpFlags);
140
141     static RegExp* createWithoutCaching(VM&, const String&, RegExpFlags);
142
143     enum RegExpState : uint8_t {
144         ParseError,
145         JITCode,
146         ByteCode,
147         NotCompiled
148     };
149
150     void byteCodeCompileIfNecessary(VM*);
151
152     void compile(VM*, Yarr::YarrCharSize);
153     void compileIfNecessary(VM&, Yarr::YarrCharSize);
154
155     void compileMatchOnly(VM*, Yarr::YarrCharSize);
156     void compileIfNecessaryMatchOnly(VM&, Yarr::YarrCharSize);
157
158 #if ENABLE(YARR_JIT_DEBUG)
159     void matchCompareWithInterpreter(const String&, int startOffset, int* offsetVector, int jitResult);
160 #endif
161
162     String m_patternString;
163     RegExpState m_state { NotCompiled };
164     RegExpFlags m_flags;
165     ConcurrentJSLock m_lock;
166     Yarr::ErrorCode m_constructionErrorCode { Yarr::ErrorCode::NoError };
167     unsigned m_numSubpatterns { 0 };
168     Vector<String> m_captureGroupNames;
169     HashMap<String, unsigned> m_namedGroupToParenIndex;
170     std::unique_ptr<Yarr::BytecodePattern> m_regExpBytecode;
171 #if ENABLE(REGEXP_TRACING)
172     double m_rtMatchOnlyTotalSubjectStringLen { 0.0 };
173     double m_rtMatchTotalSubjectStringLen { 0.0 };
174     unsigned m_rtMatchOnlyCallCount { 0 };
175     unsigned m_rtMatchOnlyFoundCount { 0 };
176     unsigned m_rtMatchCallCount { 0 };
177     unsigned m_rtMatchFoundCount { 0 };
178 #endif
179
180 #if ENABLE(YARR_JIT)
181     Yarr::YarrCodeBlock m_regExpJITCode;
182 #endif
183 };
184
185 } // namespace JSC