ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Google Inc. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
Ethan Nicholas | 11d5397 | 2016-11-28 11:23:23 -0500 | [diff] [blame] | 7 | |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 8 | #ifndef SKSL_PARSER |
| 9 | #define SKSL_PARSER |
| 10 | |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 11 | #include <vector> |
| 12 | #include <memory> |
Ethan Nicholas | 3614d9a | 2017-02-15 12:33:30 -0500 | [diff] [blame] | 13 | #include <unordered_map> |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 14 | #include <unordered_set> |
| 15 | #include "SkSLErrorReporter.h" |
| 16 | #include "SkSLToken.h" |
| 17 | |
| 18 | struct yy_buffer_state; |
| 19 | #define YY_TYPEDEF_YY_BUFFER_STATE |
| 20 | typedef struct yy_buffer_state *YY_BUFFER_STATE; |
| 21 | |
| 22 | namespace SkSL { |
| 23 | |
| 24 | struct ASTBlock; |
| 25 | struct ASTBreakStatement; |
| 26 | struct ASTContinueStatement; |
| 27 | struct ASTDeclaration; |
| 28 | struct ASTDiscardStatement; |
| 29 | struct ASTDoStatement; |
| 30 | struct ASTExpression; |
| 31 | struct ASTExpressionStatement; |
| 32 | struct ASTForStatement; |
| 33 | struct ASTIfStatement; |
| 34 | struct ASTInterfaceBlock; |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 35 | struct ASTParameter; |
ethannicholas | 5961bc9 | 2016-10-12 06:39:56 -0700 | [diff] [blame] | 36 | struct ASTPrecision; |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 37 | struct ASTReturnStatement; |
| 38 | struct ASTStatement; |
| 39 | struct ASTSuffix; |
Ethan Nicholas | af19769 | 2017-02-27 13:26:45 -0500 | [diff] [blame] | 40 | struct ASTSwitchCase; |
| 41 | struct ASTSwitchStatement; |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 42 | struct ASTType; |
| 43 | struct ASTWhileStatement; |
ethannicholas | 14fe8cc | 2016-09-07 13:37:16 -0700 | [diff] [blame] | 44 | struct ASTVarDeclarations; |
Ethan Nicholas | 11d5397 | 2016-11-28 11:23:23 -0500 | [diff] [blame] | 45 | struct Layout; |
| 46 | struct Modifiers; |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 47 | class SymbolTable; |
| 48 | |
| 49 | /** |
| 50 | * Consumes .sksl text and produces an abstract syntax tree describing the contents. |
| 51 | */ |
| 52 | class Parser { |
| 53 | public: |
Ethan Nicholas | 0df1b04 | 2017-03-31 13:56:23 -0400 | [diff] [blame] | 54 | Parser(String text, SymbolTable& types, ErrorReporter& errors); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 55 | |
| 56 | ~Parser(); |
| 57 | |
| 58 | /** |
| 59 | * Consumes a complete .sksl file and produces a list of declarations. Errors are reported via |
| 60 | * the ErrorReporter; the return value may contain some declarations even when errors have |
| 61 | * occurred. |
| 62 | */ |
| 63 | std::vector<std::unique_ptr<ASTDeclaration>> file(); |
| 64 | |
| 65 | private: |
| 66 | /** |
| 67 | * Return the next token from the parse stream. |
| 68 | */ |
| 69 | Token nextToken(); |
| 70 | |
| 71 | /** |
| 72 | * Push a token back onto the parse stream, so that it is the next one read. Only a single level |
| 73 | * of pushback is supported (that is, it is an error to call pushback() twice in a row without |
| 74 | * an intervening nextToken()). |
| 75 | */ |
| 76 | void pushback(Token t); |
| 77 | |
| 78 | /** |
Ethan Nicholas | 11d5397 | 2016-11-28 11:23:23 -0500 | [diff] [blame] | 79 | * Returns the next token without consuming it from the stream. |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 80 | */ |
| 81 | Token peek(); |
| 82 | |
| 83 | /** |
Ethan Nicholas | 0c9d13b | 2017-05-08 16:18:19 -0400 | [diff] [blame^] | 84 | * Checks to see if the next token is of the specified type. If so, stores it in result (if |
| 85 | * result is non-null) and returns true. Otherwise, pushes it back and returns false. |
| 86 | */ |
| 87 | bool checkNext(Token::Kind kind, Token* result = nullptr); |
| 88 | |
| 89 | /** |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 90 | * Reads the next token and generates an error if it is not the expected type. The 'expected' |
| 91 | * string is part of the error message, which reads: |
| 92 | * |
| 93 | * "expected <expected>, but found '<actual text>'" |
| 94 | * |
| 95 | * If 'result' is non-null, it is set to point to the token that was read. |
| 96 | * Returns true if the read token was as expected, false otherwise. |
| 97 | */ |
Ethan Nicholas | 9e1138d | 2016-11-21 10:39:35 -0500 | [diff] [blame] | 98 | bool expect(Token::Kind kind, const char* expected, Token* result = nullptr); |
Ethan Nicholas | 0df1b04 | 2017-03-31 13:56:23 -0400 | [diff] [blame] | 99 | bool expect(Token::Kind kind, String expected, Token* result = nullptr); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 100 | |
Ethan Nicholas | 9e1138d | 2016-11-21 10:39:35 -0500 | [diff] [blame] | 101 | void error(Position p, const char* msg); |
Ethan Nicholas | 0df1b04 | 2017-03-31 13:56:23 -0400 | [diff] [blame] | 102 | void error(Position p, String msg); |
| 103 | |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 104 | /** |
| 105 | * Returns true if the 'name' identifier refers to a type name. For instance, isType("int") will |
| 106 | * always return true. |
| 107 | */ |
Ethan Nicholas | 0df1b04 | 2017-03-31 13:56:23 -0400 | [diff] [blame] | 108 | bool isType(String name); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 109 | |
| 110 | // these functions parse individual grammar rules from the current parse position; you probably |
| 111 | // don't need to call any of these outside of the parser. The function declarations in the .cpp |
| 112 | // file have comments describing the grammar rules. |
| 113 | |
ethannicholas | 5961bc9 | 2016-10-12 06:39:56 -0700 | [diff] [blame] | 114 | std::unique_ptr<ASTDeclaration> precision(); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 115 | |
| 116 | std::unique_ptr<ASTDeclaration> directive(); |
| 117 | |
| 118 | std::unique_ptr<ASTDeclaration> declaration(); |
| 119 | |
ethannicholas | 14fe8cc | 2016-09-07 13:37:16 -0700 | [diff] [blame] | 120 | std::unique_ptr<ASTVarDeclarations> varDeclarations(); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 121 | |
| 122 | std::unique_ptr<ASTType> structDeclaration(); |
| 123 | |
Ethan Nicholas | 11d5397 | 2016-11-28 11:23:23 -0500 | [diff] [blame] | 124 | std::unique_ptr<ASTVarDeclarations> structVarDeclaration(Modifiers modifiers); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 125 | |
Ethan Nicholas | 11d5397 | 2016-11-28 11:23:23 -0500 | [diff] [blame] | 126 | std::unique_ptr<ASTVarDeclarations> varDeclarationEnd(Modifiers modifiers, |
| 127 | std::unique_ptr<ASTType> type, |
Ethan Nicholas | 0df1b04 | 2017-03-31 13:56:23 -0400 | [diff] [blame] | 128 | String name); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 129 | |
| 130 | std::unique_ptr<ASTParameter> parameter(); |
| 131 | |
| 132 | int layoutInt(); |
Ethan Nicholas | 0df1b04 | 2017-03-31 13:56:23 -0400 | [diff] [blame] | 133 | |
Ethan Nicholas | 11d5397 | 2016-11-28 11:23:23 -0500 | [diff] [blame] | 134 | Layout layout(); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 135 | |
Ethan Nicholas | 11d5397 | 2016-11-28 11:23:23 -0500 | [diff] [blame] | 136 | Modifiers modifiers(); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 137 | |
Ethan Nicholas | 11d5397 | 2016-11-28 11:23:23 -0500 | [diff] [blame] | 138 | Modifiers modifiersWithDefaults(int defaultFlags); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 139 | |
| 140 | std::unique_ptr<ASTStatement> statement(); |
| 141 | |
| 142 | std::unique_ptr<ASTType> type(); |
| 143 | |
Ethan Nicholas | 11d5397 | 2016-11-28 11:23:23 -0500 | [diff] [blame] | 144 | std::unique_ptr<ASTDeclaration> interfaceBlock(Modifiers mods); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 145 | |
| 146 | std::unique_ptr<ASTIfStatement> ifStatement(); |
| 147 | |
| 148 | std::unique_ptr<ASTDoStatement> doStatement(); |
| 149 | |
| 150 | std::unique_ptr<ASTWhileStatement> whileStatement(); |
| 151 | |
| 152 | std::unique_ptr<ASTForStatement> forStatement(); |
| 153 | |
Ethan Nicholas | af19769 | 2017-02-27 13:26:45 -0500 | [diff] [blame] | 154 | std::unique_ptr<ASTSwitchCase> switchCase(); |
| 155 | |
| 156 | std::unique_ptr<ASTStatement> switchStatement(); |
| 157 | |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 158 | std::unique_ptr<ASTReturnStatement> returnStatement(); |
| 159 | |
| 160 | std::unique_ptr<ASTBreakStatement> breakStatement(); |
| 161 | |
| 162 | std::unique_ptr<ASTContinueStatement> continueStatement(); |
| 163 | |
| 164 | std::unique_ptr<ASTDiscardStatement> discardStatement(); |
| 165 | |
| 166 | std::unique_ptr<ASTBlock> block(); |
| 167 | |
| 168 | std::unique_ptr<ASTExpressionStatement> expressionStatement(); |
| 169 | |
| 170 | std::unique_ptr<ASTExpression> expression(); |
| 171 | |
| 172 | std::unique_ptr<ASTExpression> assignmentExpression(); |
Ethan Nicholas | 0df1b04 | 2017-03-31 13:56:23 -0400 | [diff] [blame] | 173 | |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 174 | std::unique_ptr<ASTExpression> ternaryExpression(); |
| 175 | |
| 176 | std::unique_ptr<ASTExpression> logicalOrExpression(); |
| 177 | |
| 178 | std::unique_ptr<ASTExpression> logicalXorExpression(); |
| 179 | |
| 180 | std::unique_ptr<ASTExpression> logicalAndExpression(); |
| 181 | |
| 182 | std::unique_ptr<ASTExpression> bitwiseOrExpression(); |
| 183 | |
| 184 | std::unique_ptr<ASTExpression> bitwiseXorExpression(); |
| 185 | |
| 186 | std::unique_ptr<ASTExpression> bitwiseAndExpression(); |
| 187 | |
| 188 | std::unique_ptr<ASTExpression> equalityExpression(); |
| 189 | |
| 190 | std::unique_ptr<ASTExpression> relationalExpression(); |
| 191 | |
| 192 | std::unique_ptr<ASTExpression> shiftExpression(); |
| 193 | |
| 194 | std::unique_ptr<ASTExpression> additiveExpression(); |
| 195 | |
| 196 | std::unique_ptr<ASTExpression> multiplicativeExpression(); |
| 197 | |
| 198 | std::unique_ptr<ASTExpression> unaryExpression(); |
| 199 | |
| 200 | std::unique_ptr<ASTExpression> postfixExpression(); |
| 201 | |
| 202 | std::unique_ptr<ASTSuffix> suffix(); |
| 203 | |
| 204 | std::unique_ptr<ASTExpression> term(); |
| 205 | |
| 206 | bool intLiteral(int64_t* dest); |
| 207 | |
| 208 | bool floatLiteral(double* dest); |
| 209 | |
| 210 | bool boolLiteral(bool* dest); |
| 211 | |
Ethan Nicholas | 0df1b04 | 2017-03-31 13:56:23 -0400 | [diff] [blame] | 212 | bool identifier(String* dest); |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 213 | |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 214 | void* fScanner; |
Ethan Nicholas | bfe15f6 | 2017-03-01 11:46:51 -0500 | [diff] [blame] | 215 | void* fLayoutScanner; |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 216 | YY_BUFFER_STATE fBuffer; |
ethannicholas | cad6416 | 2016-10-27 10:54:02 -0700 | [diff] [blame] | 217 | // current parse depth, used to enforce a recursion limit to try to keep us from overflowing the |
| 218 | // stack on pathological inputs |
| 219 | int fDepth = 0; |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 220 | Token fPushback; |
| 221 | SymbolTable& fTypes; |
| 222 | ErrorReporter& fErrors; |
ethannicholas | cad6416 | 2016-10-27 10:54:02 -0700 | [diff] [blame] | 223 | |
| 224 | friend class AutoDepth; |
ethannicholas | b3058bd | 2016-07-01 08:22:01 -0700 | [diff] [blame] | 225 | }; |
| 226 | |
| 227 | } // namespace |
| 228 | |
| 229 | #endif |