bbe93f5bfca34979cd56b7d29548ded76cb6759c
[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 "ExecutableAllocator.h"
26 #include "MatchResult.h"
27 #include "RegExpKey.h"
28 #include "Structure.h"
29 #include "yarr/Yarr.h"
30 #include <wtf/Forward.h>
31 #include <wtf/text/WTFString.h>
32
33 #if ENABLE(YARR_JIT)
34 #include "yarr/YarrJIT.h"
35 #endif
36
37 namespace JSC {
38
39 struct RegExpRepresentation;
40 class VM;
41
42 JS_EXPORT_PRIVATE RegExpFlags regExpFlags(const String&);
43
44 class RegExp final : public JSCell {
45 public:
46     typedef JSCell Base;
47     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
48
49     JS_EXPORT_PRIVATE static RegExp* create(VM&, const String& pattern, RegExpFlags);
50     static const bool needsDestruction = true;
51     static void destroy(JSCell*);
52     static size_t estimatedSize(JSCell*);
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
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 hasCode()
83     {
84         return m_state != NotCompiled;
85     }
86
87     bool hasCodeFor(Yarr::YarrCharSize);
88     bool hasMatchOnlyCodeFor(Yarr::YarrCharSize);
89
90     void deleteCode();
91
92 #if ENABLE(REGEXP_TRACING)
93     void printTraceData();
94 #endif
95
96     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
97     {
98         return Structure::create(vm, globalObject, prototype, TypeInfo(CellType, StructureFlags), info());
99     }
100
101     DECLARE_INFO;
102
103     RegExpKey key() { return RegExpKey(m_flags, m_patternString); }
104
105 protected:
106     void finishCreation(VM&);
107
108 private:
109     friend class RegExpCache;
110     RegExp(VM&, const String&, RegExpFlags);
111
112     static RegExp* createWithoutCaching(VM&, const String&, RegExpFlags);
113
114     enum RegExpState {
115         ParseError,
116         JITCode,
117         ByteCode,
118         NotCompiled
119     };
120
121     RegExpState m_state;
122
123     void compile(VM*, Yarr::YarrCharSize);
124     void compileIfNecessary(VM&, Yarr::YarrCharSize);
125
126     void compileMatchOnly(VM*, Yarr::YarrCharSize);
127     void compileIfNecessaryMatchOnly(VM&, Yarr::YarrCharSize);
128
129 #if ENABLE(YARR_JIT_DEBUG)
130     void matchCompareWithInterpreter(const String&, int startOffset, int* offsetVector, int jitResult);
131 #endif
132
133     String m_patternString;
134     RegExpFlags m_flags;
135     const char* m_constructionError;
136     unsigned m_numSubpatterns;
137 #if ENABLE(REGEXP_TRACING)
138     double m_rtMatchOnlyTotalSubjectStringLen;
139     double m_rtMatchTotalSubjectStringLen;
140     unsigned m_rtMatchOnlyCallCount;
141     unsigned m_rtMatchOnlyFoundCount;
142     unsigned m_rtMatchCallCount;
143     unsigned m_rtMatchFoundCount;
144 #endif
145     ConcurrentJSLock m_lock;
146
147 #if ENABLE(YARR_JIT)
148     Yarr::YarrCodeBlock m_regExpJITCode;
149 #endif
150     std::unique_ptr<Yarr::BytecodePattern> m_regExpBytecode;
151 };
152
153 } // namespace JSC