eee25651b6db00411cfe62dfb22800f65076e1af
[WebKit-https.git] / Source / JavaScriptCore / parser / SyntaxChecker.h
1 /*
2  * Copyright (C) 2010, 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef SyntaxChecker_h
27 #define SyntaxChecker_h
28
29 #include "Lexer.h"
30 #include "ParserFunctionInfo.h"
31 #include "YarrSyntaxChecker.h"
32
33 namespace JSC {
34     
35 class SyntaxChecker {
36 public:
37     struct BinaryExprContext {
38         BinaryExprContext(SyntaxChecker& context)
39             : m_context(&context)
40         {
41             m_context->m_topBinaryExprs.append(m_context->m_topBinaryExpr);
42             m_context->m_topBinaryExpr = 0;
43         }
44         ~BinaryExprContext()
45         {
46             m_context->m_topBinaryExpr = m_context->m_topBinaryExprs.last();
47             m_context->m_topBinaryExprs.removeLast();
48         }
49     private:
50         SyntaxChecker* m_context;
51     };
52     struct UnaryExprContext {
53         UnaryExprContext(SyntaxChecker& context)
54             : m_context(&context)
55         {
56             m_context->m_topUnaryTokens.append(m_context->m_topUnaryToken);
57             m_context->m_topUnaryToken = 0;
58         }
59         ~UnaryExprContext()
60         {
61             m_context->m_topUnaryToken = m_context->m_topUnaryTokens.last();
62             m_context->m_topUnaryTokens.removeLast();
63         }
64     private:
65         SyntaxChecker* m_context;
66     };
67     
68     SyntaxChecker(VM* , void*)
69     {
70     }
71
72     typedef SyntaxChecker FunctionBodyBuilder;
73     enum { NoneExpr = 0,
74         ResolveEvalExpr, ResolveExpr, NumberExpr, StringExpr,
75         ThisExpr, NullExpr, BoolExpr, RegExpExpr, ObjectLiteralExpr,
76         FunctionExpr, BracketExpr, DotExpr, CallExpr,
77         NewExpr, PreExpr, PostExpr, UnaryExpr, BinaryExpr,
78         ConditionalExpr, AssignmentExpr, TypeofExpr,
79         DeleteExpr, ArrayLiteralExpr, BindingDeconstruction,
80         ArrayDeconstruction, ObjectDeconstruction, SourceElementsResult,
81         FunctionBodyResult, SpreadExpr, ArgumentsResult,
82         PropertyListResult, ArgumentsListResult, ElementsListResult,
83         StatementResult, FormalParameterListResult, ClauseResult,
84         ClauseListResult, CommaExpr, DeconstructingAssignment
85     };
86     typedef int ExpressionType;
87
88     typedef ExpressionType Expression;
89     typedef int SourceElements;
90     typedef int Arguments;
91     typedef ExpressionType Comma;
92     struct Property {
93         ALWAYS_INLINE Property(void* = 0)
94             : type((PropertyNode::Type)0)
95         {
96         }
97         ALWAYS_INLINE Property(const Identifier* ident, PropertyNode::Type ty)
98             : name(ident)
99             , type(ty)
100         {
101         }
102         ALWAYS_INLINE Property(PropertyNode::Type ty)
103             : name(0)
104             , type(ty)
105         {
106         }
107         ALWAYS_INLINE bool operator!() { return !type; }
108         const Identifier* name;
109         PropertyNode::Type type;
110     };
111     typedef int PropertyList;
112     typedef int ElementList;
113     typedef int ArgumentsList;
114     typedef int FormalParameterList;
115     typedef int FunctionBody;
116     typedef int Statement;
117     typedef int ClauseList;
118     typedef int Clause;
119     typedef int ConstDeclList;
120     typedef int BinaryOperand;
121     typedef int DeconstructionPattern;
122     typedef DeconstructionPattern ArrayPattern;
123     typedef DeconstructionPattern ObjectPattern;
124
125     static const bool CreatesAST = false;
126     static const bool NeedsFreeVariableInfo = false;
127     static const bool CanUseFunctionCache = true;
128     static const unsigned DontBuildKeywords = LexexFlagsDontBuildKeywords;
129     static const unsigned DontBuildStrings = LexerFlagsDontBuildStrings;
130
131     int createSourceElements() { return SourceElementsResult; }
132     ExpressionType makeFunctionCallNode(const JSTokenLocation&, int, int, int, int, int) { return CallExpr; }
133     ExpressionType createCommaExpr(const JSTokenLocation&, ExpressionType expr) { return expr; }
134     ExpressionType appendToCommaExpr(const JSTokenLocation&, ExpressionType& head, ExpressionType, ExpressionType next) { head = next; return next; }
135     ExpressionType makeAssignNode(const JSTokenLocation&, ExpressionType, Operator, ExpressionType, bool, bool, int, int, int) { return AssignmentExpr; }
136     ExpressionType makePrefixNode(const JSTokenLocation&, ExpressionType, Operator, int, int, int) { return PreExpr; }
137     ExpressionType makePostfixNode(const JSTokenLocation&, ExpressionType, Operator, int, int, int) { return PostExpr; }
138     ExpressionType makeTypeOfNode(const JSTokenLocation&, ExpressionType) { return TypeofExpr; }
139     ExpressionType makeDeleteNode(const JSTokenLocation&, ExpressionType, int, int, int) { return DeleteExpr; }
140     ExpressionType makeNegateNode(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
141     ExpressionType makeBitwiseNotNode(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
142     ExpressionType createLogicalNot(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
143     ExpressionType createUnaryPlus(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
144     ExpressionType createVoid(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
145     ExpressionType thisExpr(const JSTokenLocation&) { return ThisExpr; }
146     ExpressionType createResolve(const JSTokenLocation&, const Identifier*, int) { return ResolveExpr; }
147     ExpressionType createObjectLiteral(const JSTokenLocation&) { return ObjectLiteralExpr; }
148     ExpressionType createObjectLiteral(const JSTokenLocation&, int) { return ObjectLiteralExpr; }
149     ExpressionType createArray(const JSTokenLocation&, int) { return ArrayLiteralExpr; }
150     ExpressionType createArray(const JSTokenLocation&, int, int) { return ArrayLiteralExpr; }
151     ExpressionType createNumberExpr(const JSTokenLocation&, double) { return NumberExpr; }
152     ExpressionType createString(const JSTokenLocation&, const Identifier*) { return StringExpr; }
153     ExpressionType createBoolean(const JSTokenLocation&, bool) { return BoolExpr; }
154     ExpressionType createNull(const JSTokenLocation&) { return NullExpr; }
155     ExpressionType createBracketAccess(const JSTokenLocation&, ExpressionType, ExpressionType, bool, int, int, int) { return BracketExpr; }
156     ExpressionType createDotAccess(const JSTokenLocation&, ExpressionType, const Identifier*, int, int, int) { return DotExpr; }
157     ExpressionType createRegExp(const JSTokenLocation&, const Identifier& pattern, const Identifier&, int) { return Yarr::checkSyntax(pattern.string()) ? 0 : RegExpExpr; }
158     ExpressionType createNewExpr(const JSTokenLocation&, ExpressionType, int, int, int, int) { return NewExpr; }
159     ExpressionType createNewExpr(const JSTokenLocation&, ExpressionType, int, int) { return NewExpr; }
160     ExpressionType createConditionalExpr(const JSTokenLocation&, ExpressionType, ExpressionType, ExpressionType) { return ConditionalExpr; }
161     ExpressionType createAssignResolve(const JSTokenLocation&, const Identifier&, ExpressionType, int, int, int) { return AssignmentExpr; }
162     ExpressionType createEmptyVarExpression(const JSTokenLocation&, const Identifier&) { return AssignmentExpr; }
163     ExpressionType createFunctionExpr(const JSTokenLocation&, const ParserFunctionInfo<SyntaxChecker>&, int) { return FunctionExpr; }
164     int createFunctionBody(const JSTokenLocation&, const JSTokenLocation&, int, int, bool) { return FunctionBodyResult; }
165     void setFunctionNameStart(int, int) { }
166     int createArguments() { return ArgumentsResult; }
167     int createArguments(int) { return ArgumentsResult; }
168     ExpressionType createSpreadExpression(const JSTokenLocation&, ExpressionType, int, int, int) { return SpreadExpr; }
169     int createArgumentsList(const JSTokenLocation&, int) { return ArgumentsListResult; }
170     int createArgumentsList(const JSTokenLocation&, int, int) { return ArgumentsListResult; }
171     Property createProperty(const Identifier* name, int, PropertyNode::Type type, bool complete)
172     {
173         if (!complete)
174             return Property(type);
175         ASSERT(name);
176         return Property(name, type);
177     }
178     Property createProperty(VM* vm, ParserArena& parserArena, double name, int, PropertyNode::Type type, bool complete)
179     {
180         if (!complete)
181             return Property(type);
182         return Property(&parserArena.identifierArena().makeNumericIdentifier(vm, name), type);
183     }
184     Property createProperty(int, int, PropertyNode::Type type, bool)
185     {
186         return Property(type);
187     }
188     int createPropertyList(const JSTokenLocation&, Property) { return PropertyListResult; }
189     int createPropertyList(const JSTokenLocation&, Property, int) { return PropertyListResult; }
190     int createElementList(int, int) { return ElementsListResult; }
191     int createElementList(int, int, int) { return ElementsListResult; }
192     int createFormalParameterList(DeconstructionPattern) { return FormalParameterListResult; }
193     int createFormalParameterList(int, DeconstructionPattern) { return FormalParameterListResult; }
194     int createClause(int, int) { return ClauseResult; }
195     int createClauseList(int) { return ClauseListResult; }
196     int createClauseList(int, int) { return ClauseListResult; }
197     int createFuncDeclStatement(const JSTokenLocation&, const ParserFunctionInfo<SyntaxChecker>&, int) { return StatementResult; }
198     int createClassDeclStatement(const JSTokenLocation&, const Identifier&, ExpressionType, ExpressionType, PropertyList, PropertyList, int, int) { return StatementResult; }
199     int createBlockStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
200     int createExprStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
201     int createIfStatement(const JSTokenLocation&, int, int, int, int) { return StatementResult; }
202     int createIfStatement(const JSTokenLocation&, int, int, int, int, int) { return StatementResult; }
203     int createForLoop(const JSTokenLocation&, int, int, int, int, int, int) { return StatementResult; }
204     int createForInLoop(const JSTokenLocation&, int, int, int, int, int, int, int, int) { return StatementResult; }
205     int createForOfLoop(const JSTokenLocation&, int, int, int, int, int, int, int, int) { return StatementResult; }
206     int createEmptyStatement(const JSTokenLocation&) { return StatementResult; }
207     int createVarStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
208     int createReturnStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
209     int createBreakStatement(const JSTokenLocation&, int, int) { return StatementResult; }
210     int createBreakStatement(const JSTokenLocation&, const Identifier*, int, int) { return StatementResult; }
211     int createContinueStatement(const JSTokenLocation&, int, int) { return StatementResult; }
212     int createContinueStatement(const JSTokenLocation&, const Identifier*, int, int) { return StatementResult; }
213     int createTryStatement(const JSTokenLocation&, int, const Identifier*, int, int, int, int) { return StatementResult; }
214     int createSwitchStatement(const JSTokenLocation&, int, int, int, int, int, int) { return StatementResult; }
215     int createWhileStatement(const JSTokenLocation&, int, int, int, int) { return StatementResult; }
216     int createWithStatement(const JSTokenLocation&, int, int, int, int, int, int) { return StatementResult; }
217     int createDoWhileStatement(const JSTokenLocation&, int, int, int, int) { return StatementResult; }
218     int createLabelStatement(const JSTokenLocation&, const Identifier*, int, int, int) { return StatementResult; }
219     int createThrowStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
220     int createDebugger(const JSTokenLocation&, int, int) { return StatementResult; }
221     int createConstStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
222     int appendConstDecl(const JSTokenLocation&, int, const Identifier*, int) { return StatementResult; }
223     Property createGetterOrSetterProperty(const JSTokenLocation&, PropertyNode::Type type, bool strict, const Identifier* name, const ParserFunctionInfo<SyntaxChecker>&, unsigned)
224     {
225         ASSERT(name);
226         if (!strict)
227             return Property(type);
228         return Property(name, type);
229     }
230     Property createGetterOrSetterProperty(VM* vm, ParserArena& parserArena, const JSTokenLocation&, PropertyNode::Type type, bool strict, double name, const ParserFunctionInfo<SyntaxChecker>&, unsigned)
231     {
232         if (!strict)
233             return Property(type);
234         return Property(&parserArena.identifierArena().makeNumericIdentifier(vm, name), type);
235     }
236
237     void appendStatement(int, int) { }
238     void addVar(const Identifier*, bool) { }
239     int combineCommaNodes(const JSTokenLocation&, int, int) { return CommaExpr; }
240     int evalCount() const { return 0; }
241     void appendBinaryExpressionInfo(int& operandStackDepth, int expr, int, int, int, bool)
242     {
243         if (!m_topBinaryExpr)
244             m_topBinaryExpr = expr;
245         else
246             m_topBinaryExpr = BinaryExpr;
247         operandStackDepth++;
248     }
249     
250     // Logic to handle datastructures used during parsing of binary expressions
251     void operatorStackPop(int& operatorStackDepth) { operatorStackDepth--; }
252     bool operatorStackHasHigherPrecedence(int&, int) { return true; }
253     BinaryOperand getFromOperandStack(int) { return m_topBinaryExpr; }
254     void shrinkOperandStackBy(int& operandStackDepth, int amount) { operandStackDepth -= amount; }
255     void appendBinaryOperation(const JSTokenLocation&, int& operandStackDepth, int&, BinaryOperand, BinaryOperand) { operandStackDepth++; }
256     void operatorStackAppend(int& operatorStackDepth, int, int) { operatorStackDepth++; }
257     int popOperandStack(int&) { int res = m_topBinaryExpr; m_topBinaryExpr = 0; return res; }
258     
259     void appendUnaryToken(int& stackDepth, int tok, int) { stackDepth = 1; m_topUnaryToken = tok; }
260     int unaryTokenStackLastType(int&) { return m_topUnaryToken; }
261     JSTextPosition unaryTokenStackLastStart(int&) { return JSTextPosition(0, 0, 0); }
262     void unaryTokenStackRemoveLast(int& stackDepth) { stackDepth = 0; }
263     
264     void assignmentStackAppend(int, int, int, int, int, Operator) { }
265     int createAssignment(const JSTokenLocation&, int, int, int, int, int) { RELEASE_ASSERT_NOT_REACHED(); return AssignmentExpr; }
266     const Identifier* getName(const Property& property) const { ASSERT(property.name); return property.name; }
267     PropertyNode::Type getType(const Property& property) const { return property.type; }
268     bool isResolve(ExpressionType expr) const { return expr == ResolveExpr || expr == ResolveEvalExpr; }
269     ExpressionType createDeconstructingAssignment(const JSTokenLocation&, int, ExpressionType)
270     {
271         return DeconstructingAssignment;
272     }
273     
274     ArrayPattern createArrayPattern(const JSTokenLocation&)
275     {
276         return ArrayDeconstruction;
277     }
278     void appendArrayPatternSkipEntry(ArrayPattern, const JSTokenLocation&)
279     {
280     }
281     void appendArrayPatternEntry(ArrayPattern, const JSTokenLocation&, DeconstructionPattern)
282     {
283     }
284     ObjectPattern createObjectPattern(const JSTokenLocation&)
285     {
286         return ObjectDeconstruction;
287     }
288     void appendObjectPatternEntry(ArrayPattern, const JSTokenLocation&, bool, const Identifier&, DeconstructionPattern)
289     {
290     }
291     DeconstructionPattern createBindingLocation(const JSTokenLocation&, const Identifier&, const JSTextPosition&, const JSTextPosition&)
292     {
293         return BindingDeconstruction;
294     }
295
296     bool isBindingNode(DeconstructionPattern pattern)
297     {
298         return pattern == BindingDeconstruction;
299     }
300
301     void setEndOffset(int, int) { }
302     int endOffset(int) { return 0; }
303     void setStartOffset(int, int) { }
304
305 private:
306     int m_topBinaryExpr;
307     int m_topUnaryToken;
308     Vector<int, 8> m_topBinaryExprs;
309     Vector<int, 8> m_topUnaryTokens;
310 };
311
312 }
313
314 #endif