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