Remove excessive headers from 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 #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
60     const String& pattern() const { return m_patternString; }
61
62     bool isValid() const { return !m_constructionError && m_flags != InvalidFlags; }
63     const char* errorMessage() const { return m_constructionError; }
64
65     JS_EXPORT_PRIVATE int match(VM&, const String&, unsigned startOffset, Vector<int>& ovector);
66
67     // Returns false if we couldn't run the regular expression for any reason.
68     bool matchConcurrently(VM&, const String&, unsigned startOffset, int& position, Vector<int>& ovector);
69     
70     JS_EXPORT_PRIVATE MatchResult match(VM&, const String&, unsigned startOffset);
71
72     bool matchConcurrently(VM&, const String&, unsigned startOffset, MatchResult&);
73
74     // Call these versions of the match functions if you're desperate for performance.
75     template<typename VectorType>
76     int matchInline(VM&, const String&, unsigned startOffset, VectorType& ovector);
77     MatchResult matchInline(VM&, const String&, unsigned startOffset);
78     
79     unsigned numSubpatterns() const { return m_numSubpatterns; }
80
81     bool hasCode()
82     {
83         return m_state != NotCompiled;
84     }
85
86     bool hasCodeFor(Yarr::YarrCharSize);
87     bool hasMatchOnlyCodeFor(Yarr::YarrCharSize);
88
89     void deleteCode();
90
91 #if ENABLE(REGEXP_TRACING)
92     void printTraceData();
93 #endif
94
95     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
96     {
97         return Structure::create(vm, globalObject, prototype, TypeInfo(CellType, StructureFlags), info());
98     }
99
100     DECLARE_INFO;
101
102     RegExpKey key() { return RegExpKey(m_flags, m_patternString); }
103
104 protected:
105     void finishCreation(VM&);
106
107 private:
108     friend class RegExpCache;
109     RegExp(VM&, const String&, RegExpFlags);
110
111     static RegExp* createWithoutCaching(VM&, const String&, RegExpFlags);
112
113     enum RegExpState {
114         ParseError,
115         JITCode,
116         ByteCode,
117         NotCompiled
118     };
119
120     RegExpState m_state;
121
122     void compile(VM*, Yarr::YarrCharSize);
123     void compileIfNecessary(VM&, Yarr::YarrCharSize);
124
125     void compileMatchOnly(VM*, Yarr::YarrCharSize);
126     void compileIfNecessaryMatchOnly(VM&, Yarr::YarrCharSize);
127
128 #if ENABLE(YARR_JIT_DEBUG)
129     void matchCompareWithInterpreter(const String&, int startOffset, int* offsetVector, int jitResult);
130 #endif
131
132     String m_patternString;
133     RegExpFlags m_flags;
134     const char* m_constructionError;
135     unsigned m_numSubpatterns;
136 #if ENABLE(REGEXP_TRACING)
137     double m_rtMatchOnlyTotalSubjectStringLen;
138     double m_rtMatchTotalSubjectStringLen;
139     unsigned m_rtMatchOnlyCallCount;
140     unsigned m_rtMatchOnlyFoundCount;
141     unsigned m_rtMatchCallCount;
142     unsigned m_rtMatchFoundCount;
143 #endif
144     ConcurrentJSLock m_lock;
145
146 #if ENABLE(YARR_JIT)
147     Yarr::YarrCodeBlock m_regExpJITCode;
148 #endif
149     std::unique_ptr<Yarr::BytecodePattern> m_regExpBytecode;
150 };
151
152 } // namespace JSC