ad451f9d9e85bdbf21b75b18c7743747db0e3d0d
[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 #ifndef RegExp_h
23 #define RegExp_h
24
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/RefCounted.h>
32 #include <wtf/text/WTFString.h>
33
34 #if ENABLE(YARR_JIT)
35 #include "yarr/YarrJIT.h"
36 #endif
37
38 namespace JSC {
39
40 struct RegExpRepresentation;
41 class VM;
42
43 JS_EXPORT_PRIVATE RegExpFlags regExpFlags(const String&);
44
45 class RegExp final : public JSCell {
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*);
54
55     bool global() const { return m_flags & FlagGlobal; }
56     bool ignoreCase() const { return m_flags & FlagIgnoreCase; }
57     bool multiline() const { return m_flags & FlagMultiline; }
58     bool sticky() const { return m_flags & FlagSticky; }
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, 32>& ovector);
67     JS_EXPORT_PRIVATE MatchResult match(VM&, const String&, unsigned startOffset);
68
69     // Call these versions of the match functions if you're desperate for performance.
70     int matchInline(VM&, const String&, unsigned startOffset, Vector<int, 32>& ovector);
71     MatchResult matchInline(VM&, const String&, unsigned startOffset);
72     
73     unsigned numSubpatterns() const { return m_numSubpatterns; }
74
75     bool hasCode()
76     {
77         return m_state != NotCompiled;
78     }
79
80     void deleteCode();
81
82 #if ENABLE(REGEXP_TRACING)
83     void printTraceData();
84 #endif
85
86     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
87     {
88         return Structure::create(vm, globalObject, prototype, TypeInfo(CellType, StructureFlags), info());
89     }
90
91     DECLARE_INFO;
92
93     RegExpKey key() { return RegExpKey(m_flags, m_patternString); }
94
95 protected:
96     void finishCreation(VM&);
97
98 private:
99     friend class RegExpCache;
100     RegExp(VM&, const String&, RegExpFlags);
101
102     static RegExp* createWithoutCaching(VM&, const String&, RegExpFlags);
103
104     enum RegExpState {
105         ParseError,
106         JITCode,
107         ByteCode,
108         NotCompiled
109     };
110
111     RegExpState m_state;
112
113     void compile(VM*, Yarr::YarrCharSize);
114     void compileIfNecessary(VM&, Yarr::YarrCharSize);
115
116     void compileMatchOnly(VM*, Yarr::YarrCharSize);
117     void compileIfNecessaryMatchOnly(VM&, Yarr::YarrCharSize);
118
119 #if ENABLE(YARR_JIT_DEBUG)
120     void matchCompareWithInterpreter(const String&, int startOffset, int* offsetVector, int jitResult);
121 #endif
122
123     String m_patternString;
124     RegExpFlags m_flags;
125     const char* m_constructionError;
126     unsigned m_numSubpatterns;
127 #if ENABLE(REGEXP_TRACING)
128     double m_rtMatchOnlyTotalSubjectStringLen;
129     double m_rtMatchTotalSubjectStringLen;
130     unsigned m_rtMatchOnlyCallCount;
131     unsigned m_rtMatchOnlyFoundCount;
132     unsigned m_rtMatchCallCount;
133     unsigned m_rtMatchFoundCount;
134 #endif
135
136 #if ENABLE(YARR_JIT)
137     Yarr::YarrCodeBlock m_regExpJITCode;
138 #endif
139     std::unique_ptr<Yarr::BytecodePattern> m_regExpBytecode;
140 };
141
142 } // namespace JSC
143
144 #endif // RegExp_h