Rename Mutex to DeprecatedMutex
[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     enum { NoneExpr = 0,
73         ResolveEvalExpr, ResolveExpr, IntegerExpr, DoubleExpr, StringExpr,
74         ThisExpr, NullExpr, BoolExpr, RegExpExpr, ObjectLiteralExpr,
75         FunctionExpr, ClassExpr, SuperExpr, BracketExpr, DotExpr, CallExpr,
76         NewExpr, PreExpr, PostExpr, UnaryExpr, BinaryExpr,
77         ConditionalExpr, AssignmentExpr, TypeofExpr, NewTargetExpr,
78         DeleteExpr, ArrayLiteralExpr, BindingDestructuring,
79         ArrayDestructuring, ObjectDestructuring, SourceElementsResult,
80         FunctionBodyResult, SpreadExpr, ArgumentsResult,
81         PropertyListResult, ArgumentsListResult, ElementsListResult,
82         StatementResult, FormalParameterListResult, ClauseResult,
83         ClauseListResult, CommaExpr, DestructuringAssignment,
84         TemplateStringResult, TemplateStringListResult,
85         TemplateExpressionListResult, TemplateExpr,
86         TaggedTemplateExpr,
87         ModuleSpecifierResult,
88         ImportSpecifierResult, ImportSpecifierListResult,
89         ExportSpecifierResult, ExportSpecifierListResult
90     };
91     typedef int ExpressionType;
92
93     typedef ExpressionType Expression;
94     typedef int SourceElements;
95     typedef int Arguments;
96     typedef ExpressionType Comma;
97     struct Property {
98         ALWAYS_INLINE Property(void* = 0)
99             : type((PropertyNode::Type)0)
100         {
101         }
102         ALWAYS_INLINE Property(const Identifier* ident, PropertyNode::Type ty)
103             : name(ident)
104             , type(ty)
105         {
106         }
107         ALWAYS_INLINE Property(PropertyNode::Type ty)
108             : name(0)
109             , type(ty)
110         {
111         }
112         ALWAYS_INLINE bool operator!() { return !type; }
113         const Identifier* name;
114         PropertyNode::Type type;
115     };
116     typedef int PropertyList;
117     typedef int ElementList;
118     typedef int ArgumentsList;
119 #if ENABLE(ES6_TEMPLATE_LITERAL_SYNTAX)
120     typedef int TemplateExpressionList;
121     typedef int TemplateString;
122     typedef int TemplateStringList;
123     typedef int TemplateLiteral;
124 #endif
125     typedef int FormalParameterList;
126     typedef int FunctionBody;
127 #if ENABLE(ES6_CLASS_SYNTAX)
128     typedef int ClassExpression;
129 #endif
130     typedef int ModuleSpecifier;
131     typedef int ImportSpecifier;
132     typedef int ImportSpecifierList;
133     typedef int ExportSpecifier;
134     typedef int ExportSpecifierList;
135     typedef int Statement;
136     typedef int ClauseList;
137     typedef int Clause;
138     typedef int BinaryOperand;
139     typedef int DestructuringPattern;
140     typedef DestructuringPattern ArrayPattern;
141     typedef DestructuringPattern ObjectPattern;
142
143     static const bool CreatesAST = false;
144     static const bool NeedsFreeVariableInfo = false;
145     static const bool CanUseFunctionCache = true;
146     static const unsigned DontBuildKeywords = LexexFlagsDontBuildKeywords;
147     static const unsigned DontBuildStrings = LexerFlagsDontBuildStrings;
148
149     int createSourceElements() { return SourceElementsResult; }
150     ExpressionType makeFunctionCallNode(const JSTokenLocation&, int, int, int, int, int) { return CallExpr; }
151     ExpressionType createCommaExpr(const JSTokenLocation&, ExpressionType expr) { return expr; }
152     ExpressionType appendToCommaExpr(const JSTokenLocation&, ExpressionType& head, ExpressionType, ExpressionType next) { head = next; return next; }
153     ExpressionType makeAssignNode(const JSTokenLocation&, ExpressionType, Operator, ExpressionType, bool, bool, int, int, int) { return AssignmentExpr; }
154     ExpressionType makePrefixNode(const JSTokenLocation&, ExpressionType, Operator, int, int, int) { return PreExpr; }
155     ExpressionType makePostfixNode(const JSTokenLocation&, ExpressionType, Operator, int, int, int) { return PostExpr; }
156     ExpressionType makeTypeOfNode(const JSTokenLocation&, ExpressionType) { return TypeofExpr; }
157     ExpressionType makeDeleteNode(const JSTokenLocation&, ExpressionType, int, int, int) { return DeleteExpr; }
158     ExpressionType makeNegateNode(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
159     ExpressionType makeBitwiseNotNode(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
160     ExpressionType createLogicalNot(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
161     ExpressionType createUnaryPlus(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
162     ExpressionType createVoid(const JSTokenLocation&, ExpressionType) { return UnaryExpr; }
163     ExpressionType createThisExpr(const JSTokenLocation&, ThisTDZMode) { return ThisExpr; }
164     ExpressionType createSuperExpr(const JSTokenLocation&) { return SuperExpr; }
165     ExpressionType createNewTargetExpr(const JSTokenLocation&) { return NewTargetExpr; }
166     ExpressionType createResolve(const JSTokenLocation&, const Identifier*, int) { return ResolveExpr; }
167     ExpressionType createObjectLiteral(const JSTokenLocation&) { return ObjectLiteralExpr; }
168     ExpressionType createObjectLiteral(const JSTokenLocation&, int) { return ObjectLiteralExpr; }
169     ExpressionType createArray(const JSTokenLocation&, int) { return ArrayLiteralExpr; }
170     ExpressionType createArray(const JSTokenLocation&, int, int) { return ArrayLiteralExpr; }
171     ExpressionType createDoubleExpr(const JSTokenLocation&, double) { return DoubleExpr; }
172     ExpressionType createIntegerExpr(const JSTokenLocation&, double) { return IntegerExpr; }
173     ExpressionType createString(const JSTokenLocation&, const Identifier*) { return StringExpr; }
174     ExpressionType createBoolean(const JSTokenLocation&, bool) { return BoolExpr; }
175     ExpressionType createNull(const JSTokenLocation&) { return NullExpr; }
176     ExpressionType createBracketAccess(const JSTokenLocation&, ExpressionType, ExpressionType, bool, int, int, int) { return BracketExpr; }
177     ExpressionType createDotAccess(const JSTokenLocation&, ExpressionType, const Identifier*, int, int, int) { return DotExpr; }
178     ExpressionType createRegExp(const JSTokenLocation&, const Identifier& pattern, const Identifier&, int) { return Yarr::checkSyntax(pattern.string()) ? 0 : RegExpExpr; }
179     ExpressionType createNewExpr(const JSTokenLocation&, ExpressionType, int, int, int, int) { return NewExpr; }
180     ExpressionType createNewExpr(const JSTokenLocation&, ExpressionType, int, int) { return NewExpr; }
181     ExpressionType createConditionalExpr(const JSTokenLocation&, ExpressionType, ExpressionType, ExpressionType) { return ConditionalExpr; }
182     ExpressionType createAssignResolve(const JSTokenLocation&, const Identifier&, ExpressionType, int, int, int, AssignmentContext) { return AssignmentExpr; }
183     ExpressionType createEmptyVarExpression(const JSTokenLocation&, const Identifier&) { return AssignmentExpr; }
184     ExpressionType createEmptyLetExpression(const JSTokenLocation&, const Identifier&) { return AssignmentExpr; }
185 #if ENABLE(ES6_CLASS_SYNTAX)
186     ClassExpression createClassExpr(const JSTokenLocation&, const Identifier&, ExpressionType, ExpressionType, PropertyList, PropertyList) { return ClassExpr; }
187 #endif
188     ExpressionType createFunctionExpr(const JSTokenLocation&, const ParserFunctionInfo<SyntaxChecker>&) { return FunctionExpr; }
189     int createFunctionBody(const JSTokenLocation&, const JSTokenLocation&, int, int, bool, int, int, int, ConstructorKind, unsigned, int) { return FunctionBodyResult; }
190     ExpressionType createArrowFunctionExpr(const JSTokenLocation&, const ParserFunctionInfo<SyntaxChecker>&) { return FunctionExpr; }
191     void setFunctionNameStart(int, int) { }
192     int createArguments() { return ArgumentsResult; }
193     int createArguments(int) { return ArgumentsResult; }
194     ExpressionType createSpreadExpression(const JSTokenLocation&, ExpressionType, int, int, int) { return SpreadExpr; }
195 #if ENABLE(ES6_TEMPLATE_LITERAL_SYNTAX)
196     TemplateString createTemplateString(const JSTokenLocation&, const Identifier&, const Identifier&) { return TemplateStringResult; }
197     TemplateStringList createTemplateStringList(TemplateString) { return TemplateStringListResult; }
198     TemplateStringList createTemplateStringList(TemplateStringList, TemplateString) { return TemplateStringListResult; }
199     TemplateExpressionList createTemplateExpressionList(Expression) { return TemplateExpressionListResult; }
200     TemplateExpressionList createTemplateExpressionList(TemplateExpressionList, Expression) { return TemplateExpressionListResult; }
201     TemplateLiteral createTemplateLiteral(const JSTokenLocation&, TemplateStringList) { return TemplateExpr; }
202     TemplateLiteral createTemplateLiteral(const JSTokenLocation&, TemplateStringList, TemplateExpressionList) { return TemplateExpr; }
203     ExpressionType createTaggedTemplate(const JSTokenLocation&, ExpressionType, TemplateLiteral, int, int, int) { return TaggedTemplateExpr; }
204 #endif
205
206     int createArgumentsList(const JSTokenLocation&, int) { return ArgumentsListResult; }
207     int createArgumentsList(const JSTokenLocation&, int, int) { return ArgumentsListResult; }
208     Property createProperty(const Identifier* name, int, PropertyNode::Type type, PropertyNode::PutType, bool complete, SuperBinding = SuperBinding::NotNeeded)
209     {
210         if (!complete)
211             return Property(type);
212         ASSERT(name);
213         return Property(name, type);
214     }
215     Property createProperty(VM* vm, ParserArena& parserArena, double name, int, PropertyNode::Type type, PropertyNode::PutType, bool complete)
216     {
217         if (!complete)
218             return Property(type);
219         return Property(&parserArena.identifierArena().makeNumericIdentifier(vm, name), type);
220     }
221     Property createProperty(int, int, PropertyNode::Type type, PropertyNode::PutType, bool)
222     {
223         return Property(type);
224     }
225     int createPropertyList(const JSTokenLocation&, Property) { return PropertyListResult; }
226     int createPropertyList(const JSTokenLocation&, Property, int) { return PropertyListResult; }
227     int createElementList(int, int) { return ElementsListResult; }
228     int createElementList(int, int, int) { return ElementsListResult; }
229     int createFormalParameterList() { return FormalParameterListResult; }
230     void appendParameter(int, DestructuringPattern, int) { }
231     int createClause(int, int) { return ClauseResult; }
232     int createClauseList(int) { return ClauseListResult; }
233     int createClauseList(int, int) { return ClauseListResult; }
234     int createFuncDeclStatement(const JSTokenLocation&, const ParserFunctionInfo<SyntaxChecker>&) { return StatementResult; }
235 #if ENABLE(ES6_CLASS_SYNTAX)
236     int createClassDeclStatement(const JSTokenLocation&, ClassExpression,
237         const JSTextPosition&, const JSTextPosition&, int, int) { return StatementResult; }
238 #endif
239     int createBlockStatement(const JSTokenLocation&, int, int, int, VariableEnvironment&) { return StatementResult; }
240     int createExprStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
241     int createIfStatement(const JSTokenLocation&, int, int, int, int) { return StatementResult; }
242     int createIfStatement(const JSTokenLocation&, int, int, int, int, int) { return StatementResult; }
243     int createForLoop(const JSTokenLocation&, int, int, int, int, int, int, VariableEnvironment&) { return StatementResult; }
244     int createForInLoop(const JSTokenLocation&, int, int, int, int, int, int, int, int, VariableEnvironment&) { return StatementResult; }
245     int createForOfLoop(const JSTokenLocation&, int, int, int, int, int, int, int, int, VariableEnvironment&) { return StatementResult; }
246     int createEmptyStatement(const JSTokenLocation&) { return StatementResult; }
247     int createDeclarationStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
248     int createReturnStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
249     int createBreakStatement(const JSTokenLocation&, int, int) { return StatementResult; }
250     int createBreakStatement(const JSTokenLocation&, const Identifier*, int, int) { return StatementResult; }
251     int createContinueStatement(const JSTokenLocation&, int, int) { return StatementResult; }
252     int createContinueStatement(const JSTokenLocation&, const Identifier*, int, int) { return StatementResult; }
253     int createTryStatement(const JSTokenLocation&, int, const Identifier*, int, int, int, int, VariableEnvironment&) { return StatementResult; }
254     int createSwitchStatement(const JSTokenLocation&, int, int, int, int, int, int, VariableEnvironment&) { return StatementResult; }
255     int createWhileStatement(const JSTokenLocation&, int, int, int, int) { return StatementResult; }
256     int createWithStatement(const JSTokenLocation&, int, int, int, int, int, int) { return StatementResult; }
257     int createDoWhileStatement(const JSTokenLocation&, int, int, int, int) { return StatementResult; }
258     int createLabelStatement(const JSTokenLocation&, const Identifier*, int, int, int) { return StatementResult; }
259     int createThrowStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
260     int createDebugger(const JSTokenLocation&, int, int) { return StatementResult; }
261     int createConstStatement(const JSTokenLocation&, int, int, int) { return StatementResult; }
262     int createModuleSpecifier(const JSTokenLocation&, const Identifier&) { return ModuleSpecifierResult; }
263     ImportSpecifier createImportSpecifier(const JSTokenLocation&, const Identifier&, const Identifier&) { return ImportSpecifierResult; }
264     ImportSpecifierList createImportSpecifierList() { return ImportSpecifierListResult; }
265     void appendImportSpecifier(ImportSpecifierList, ImportSpecifier) { }
266     int createImportDeclaration(const JSTokenLocation&, ImportSpecifierList, ModuleSpecifier) { return StatementResult; }
267     int createExportAllDeclaration(const JSTokenLocation&, ModuleSpecifier) { return StatementResult; }
268     int createExportDefaultDeclaration(const JSTokenLocation&, int) { return StatementResult; }
269     int createExportLocalDeclaration(const JSTokenLocation&, int) { return StatementResult; }
270     int createExportNamedDeclaration(const JSTokenLocation&, ExportSpecifierList, ModuleSpecifier) { return StatementResult; }
271     ExportSpecifier createExportSpecifier(const JSTokenLocation&, const Identifier&, const Identifier&) { return ExportSpecifierResult; }
272     ExportSpecifierList createExportSpecifierList() { return ExportSpecifierListResult; }
273     void appendExportSpecifier(ExportSpecifierList, ExportSpecifier) { }
274
275     int appendConstDecl(const JSTokenLocation&, int, const Identifier*, int) { return StatementResult; }
276     Property createGetterOrSetterProperty(const JSTokenLocation&, PropertyNode::Type type, bool strict, const Identifier* name, const ParserFunctionInfo<SyntaxChecker>&, SuperBinding)
277     {
278         ASSERT(name);
279         if (!strict)
280             return Property(type);
281         return Property(name, type);
282     }
283     Property createGetterOrSetterProperty(VM* vm, ParserArena& parserArena, const JSTokenLocation&, PropertyNode::Type type, bool strict, double name, const ParserFunctionInfo<SyntaxChecker>&, SuperBinding)
284     {
285         if (!strict)
286             return Property(type);
287         return Property(&parserArena.identifierArena().makeNumericIdentifier(vm, name), type);
288     }
289
290     void appendStatement(int, int) { }
291     int combineCommaNodes(const JSTokenLocation&, int, int) { return CommaExpr; }
292     int evalCount() const { return 0; }
293     void appendBinaryExpressionInfo(int& operandStackDepth, int expr, int, int, int, bool)
294     {
295         if (!m_topBinaryExpr)
296             m_topBinaryExpr = expr;
297         else
298             m_topBinaryExpr = BinaryExpr;
299         operandStackDepth++;
300     }
301     
302     // Logic to handle datastructures used during parsing of binary expressions
303     void operatorStackPop(int& operatorStackDepth) { operatorStackDepth--; }
304     bool operatorStackHasHigherPrecedence(int&, int) { return true; }
305     BinaryOperand getFromOperandStack(int) { return m_topBinaryExpr; }
306     void shrinkOperandStackBy(int& operandStackDepth, int amount) { operandStackDepth -= amount; }
307     void appendBinaryOperation(const JSTokenLocation&, int& operandStackDepth, int&, BinaryOperand, BinaryOperand) { operandStackDepth++; }
308     void operatorStackAppend(int& operatorStackDepth, int, int) { operatorStackDepth++; }
309     int popOperandStack(int&) { int res = m_topBinaryExpr; m_topBinaryExpr = 0; return res; }
310     
311     void appendUnaryToken(int& stackDepth, int tok, int) { stackDepth = 1; m_topUnaryToken = tok; }
312     int unaryTokenStackLastType(int&) { return m_topUnaryToken; }
313     JSTextPosition unaryTokenStackLastStart(int&) { return JSTextPosition(0, 0, 0); }
314     void unaryTokenStackRemoveLast(int& stackDepth) { stackDepth = 0; }
315     
316     void assignmentStackAppend(int, int, int, int, int, Operator) { }
317     int createAssignment(const JSTokenLocation&, int, int, int, int, int) { RELEASE_ASSERT_NOT_REACHED(); return AssignmentExpr; }
318     const Identifier* getName(const Property& property) const { return property.name; }
319     PropertyNode::Type getType(const Property& property) const { return property.type; }
320     bool isResolve(ExpressionType expr) const { return expr == ResolveExpr || expr == ResolveEvalExpr; }
321     ExpressionType createDestructuringAssignment(const JSTokenLocation&, int, ExpressionType)
322     {
323         return DestructuringAssignment;
324     }
325     
326     ArrayPattern createArrayPattern(const JSTokenLocation&)
327     {
328         return ArrayDestructuring;
329     }
330     void appendArrayPatternSkipEntry(ArrayPattern, const JSTokenLocation&)
331     {
332     }
333     void appendArrayPatternEntry(ArrayPattern, const JSTokenLocation&, DestructuringPattern, int)
334     {
335     }
336     void appendArrayPatternRestEntry(ArrayPattern, const JSTokenLocation&, DestructuringPattern)
337     {
338     }
339     void finishArrayPattern(ArrayPattern, const JSTextPosition&, const JSTextPosition&, const JSTextPosition&)
340     {
341     }
342     ObjectPattern createObjectPattern(const JSTokenLocation&)
343     {
344         return ObjectDestructuring;
345     }
346     void appendObjectPatternEntry(ArrayPattern, const JSTokenLocation&, bool, const Identifier&, DestructuringPattern, int)
347     {
348     }
349     DestructuringPattern createBindingLocation(const JSTokenLocation&, const Identifier&, const JSTextPosition&, const JSTextPosition&, AssignmentContext)
350     {
351         return BindingDestructuring;
352     }
353
354     bool isBindingNode(DestructuringPattern pattern)
355     {
356         return pattern == BindingDestructuring;
357     }
358
359     void setEndOffset(int, int) { }
360     int endOffset(int) { return 0; }
361     void setStartOffset(int, int) { }
362
363 private:
364     int m_topBinaryExpr;
365     int m_topUnaryToken;
366     Vector<int, 8> m_topBinaryExprs;
367     Vector<int, 8> m_topUnaryTokens;
368 };
369
370 }
371
372 #endif