83aad356038eb2ec76e6b8bd37c7476cec91352e
[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 public:
45     typedef JSCell Base;
46     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
47
48     JS_EXPORT_PRIVATE static RegExp* create(VM&, const String& pattern, RegExpFlags);
49     static const bool needsDestruction = true;
50     static void destroy(JSCell*);
51     static size_t estimatedSize(JSCell*, VM&);
52     JS_EXPORT_PRIVATE static void dumpToStream(const JSCell*, PrintStream&);
53
54     bool global() const { return m_flags & FlagGlobal; }
55     bool ignoreCase() const { return m_flags & FlagIgnoreCase; }
56     bool multiline() const { return m_flags & FlagMultiline; }
57     bool sticky() const { return m_flags & FlagSticky; }
58     bool globalOrSticky() const { return global() || sticky(); }
59     bool unicode() const { return m_flags & FlagUnicode; }
60     bool dotAll() const { return m_flags & FlagDotAll; }
61
62     const String& pattern() const { return m_patternString; }
63
64     bool isValid() const { return !Yarr::hasError(m_constructionErrorCode) && m_flags != InvalidFlags; }
65     const char* errorMessage() const { return Yarr::errorMessage(m_constructionErrorCode); }
66     JSObject* errorToThrow(ExecState* exec) { return Yarr::errorToThrow(exec, m_constructionErrorCode); }
67     void reset()
68     {
69         m_state = NotCompiled;
70         m_constructionErrorCode = Yarr::ErrorCode::NoError;
71     }
72
73     JS_EXPORT_PRIVATE int match(VM&, const String&, unsigned startOffset, Vector<int>& ovector);
74
75     // Returns false if we couldn't run the regular expression for any reason.
76     bool matchConcurrently(VM&, const String&, unsigned startOffset, int& position, Vector<int>& ovector);
77     
78     JS_EXPORT_PRIVATE MatchResult match(VM&, const String&, unsigned startOffset);
79
80     bool matchConcurrently(VM&, const String&, unsigned startOffset, MatchResult&);
81
82     // Call these versions of the match functions if you're desperate for performance.
83     template<typename VectorType>
84     int matchInline(VM&, const String&, unsigned startOffset, VectorType& ovector);
85     MatchResult matchInline(VM&, const String&, unsigned startOffset);
86     
87     unsigned numSubpatterns() const { return m_numSubpatterns; }
88
89     bool hasNamedCaptures()
90     {
91         return !m_captureGroupNames.isEmpty();
92     }
93
94     String getCaptureGroupName(unsigned i)
95     {
96         if (!i || m_captureGroupNames.size() <= i)
97             return String();
98         return m_captureGroupNames[i];
99     }
100
101     unsigned subpatternForName(String groupName)
102     {
103         auto it = m_namedGroupToParenIndex.find(groupName);
104         if (it == m_namedGroupToParenIndex.end())
105             return 0;
106         return it->value;
107     }
108
109     bool hasCode()
110     {
111         return m_state != NotCompiled;
112     }
113
114     bool hasCodeFor(Yarr::YarrCharSize);
115     bool hasMatchOnlyCodeFor(Yarr::YarrCharSize);
116
117     void deleteCode();
118
119 #if ENABLE(REGEXP_TRACING)
120     void printTraceData();
121 #endif
122
123     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
124     {
125         return Structure::create(vm, globalObject, prototype, TypeInfo(CellType, StructureFlags), info());
126     }
127
128     DECLARE_INFO;
129
130     RegExpKey key() { return RegExpKey(m_flags, m_patternString); }
131
132 protected:
133     void finishCreation(VM&);
134
135 private:
136     friend class RegExpCache;
137     RegExp(VM&, const String&, RegExpFlags);
138
139     static RegExp* createWithoutCaching(VM&, const String&, RegExpFlags);
140
141     enum RegExpState : uint8_t {
142         ParseError,
143         JITCode,
144         ByteCode,
145         NotCompiled
146     };
147
148     void byteCodeCompileIfNecessary(VM*);
149
150     void compile(VM*, Yarr::YarrCharSize);
151     void compileIfNecessary(VM&, Yarr::YarrCharSize);
152
153     void compileMatchOnly(VM*, Yarr::YarrCharSize);
154     void compileIfNecessaryMatchOnly(VM&, Yarr::YarrCharSize);
155
156 #if ENABLE(YARR_JIT_DEBUG)
157     void matchCompareWithInterpreter(const String&, int startOffset, int* offsetVector, int jitResult);
158 #endif
159
160     String m_patternString;
161     RegExpState m_state { NotCompiled };
162     RegExpFlags m_flags;
163     ConcurrentJSLock m_lock;
164     Yarr::ErrorCode m_constructionErrorCode { Yarr::ErrorCode::NoError };
165     unsigned m_numSubpatterns { 0 };
166     Vector<String> m_captureGroupNames;
167     HashMap<String, unsigned> m_namedGroupToParenIndex;
168     std::unique_ptr<Yarr::BytecodePattern> m_regExpBytecode;
169 #if ENABLE(REGEXP_TRACING)
170     double m_rtMatchOnlyTotalSubjectStringLen { 0.0 };
171     double m_rtMatchTotalSubjectStringLen { 0.0 };
172     unsigned m_rtMatchOnlyCallCount { 0 };
173     unsigned m_rtMatchOnlyFoundCount { 0 };
174     unsigned m_rtMatchCallCount { 0 };
175     unsigned m_rtMatchFoundCount { 0 };
176 #endif
177
178 #if ENABLE(YARR_JIT)
179     Yarr::YarrCodeBlock m_regExpJITCode;
180 #endif
181 };
182
183 } // namespace JSC