Source/JavaScriptCore:
[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 "ConcurrentJITLock.h"
26 #include "ExecutableAllocator.h"
27 #include "MatchResult.h"
28 #include "RegExpKey.h"
29 #include "Structure.h"
30 #include "yarr/Yarr.h"
31 #include <wtf/Forward.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/text/WTFString.h>
34
35 #if ENABLE(YARR_JIT)
36 #include "yarr/YarrJIT.h"
37 #endif
38
39 namespace JSC {
40
41 struct RegExpRepresentation;
42 class VM;
43
44 JS_EXPORT_PRIVATE RegExpFlags regExpFlags(const String&);
45
46 class RegExp final : public JSCell {
47 public:
48     typedef JSCell Base;
49     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
50
51     JS_EXPORT_PRIVATE static RegExp* create(VM&, const String& pattern, RegExpFlags);
52     static const bool needsDestruction = true;
53     static void destroy(JSCell*);
54     static size_t estimatedSize(JSCell*);
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
63     const String& pattern() const { return m_patternString; }
64
65     bool isValid() const { return !m_constructionError && m_flags != InvalidFlags; }
66     const char* errorMessage() const { return m_constructionError; }
67
68     JS_EXPORT_PRIVATE int match(VM&, const String&, unsigned startOffset, Vector<int, 32>& ovector);
69
70     // Returns false if we couldn't run the regular expression for any reason.
71     bool matchConcurrently(VM&, const String&, unsigned startOffset, int& position, Vector<int, 32>& ovector);
72     
73     JS_EXPORT_PRIVATE MatchResult match(VM&, const String&, unsigned startOffset);
74
75     bool matchConcurrently(VM&, const String&, unsigned startOffset, MatchResult&);
76
77     // Call these versions of the match functions if you're desperate for performance.
78     int matchInline(VM&, const String&, unsigned startOffset, Vector<int, 32>& ovector);
79     MatchResult matchInline(VM&, const String&, unsigned startOffset);
80     
81     unsigned numSubpatterns() const { return m_numSubpatterns; }
82
83     bool hasCode()
84     {
85         return m_state != NotCompiled;
86     }
87
88     bool hasCodeFor(Yarr::YarrCharSize);
89     bool hasMatchOnlyCodeFor(Yarr::YarrCharSize);
90
91     void deleteCode();
92
93 #if ENABLE(REGEXP_TRACING)
94     void printTraceData();
95 #endif
96
97     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
98     {
99         return Structure::create(vm, globalObject, prototype, TypeInfo(CellType, StructureFlags), info());
100     }
101
102     DECLARE_INFO;
103
104     RegExpKey key() { return RegExpKey(m_flags, m_patternString); }
105
106 protected:
107     void finishCreation(VM&);
108
109 private:
110     friend class RegExpCache;
111     RegExp(VM&, const String&, RegExpFlags);
112
113     static RegExp* createWithoutCaching(VM&, const String&, RegExpFlags);
114
115     enum RegExpState {
116         ParseError,
117         JITCode,
118         ByteCode,
119         NotCompiled
120     };
121
122     RegExpState m_state;
123
124     void compile(VM*, Yarr::YarrCharSize);
125     void compileIfNecessary(VM&, Yarr::YarrCharSize);
126
127     void compileMatchOnly(VM*, Yarr::YarrCharSize);
128     void compileIfNecessaryMatchOnly(VM&, Yarr::YarrCharSize);
129
130 #if ENABLE(YARR_JIT_DEBUG)
131     void matchCompareWithInterpreter(const String&, int startOffset, int* offsetVector, int jitResult);
132 #endif
133
134     String m_patternString;
135     RegExpFlags m_flags;
136     const char* m_constructionError;
137     unsigned m_numSubpatterns;
138 #if ENABLE(REGEXP_TRACING)
139     double m_rtMatchOnlyTotalSubjectStringLen;
140     double m_rtMatchTotalSubjectStringLen;
141     unsigned m_rtMatchOnlyCallCount;
142     unsigned m_rtMatchOnlyFoundCount;
143     unsigned m_rtMatchCallCount;
144     unsigned m_rtMatchFoundCount;
145 #endif
146     ConcurrentJITLock m_lock;
147
148 #if ENABLE(YARR_JIT)
149     Yarr::YarrCodeBlock m_regExpJITCode;
150 #endif
151     std::unique_ptr<Yarr::BytecodePattern> m_regExpBytecode;
152 };
153
154 } // namespace JSC
155
156 #endif // RegExp_h