1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
use crate::VarKind; use crate::decl::VarDecl; use crate::expr::Expr; use crate::pat::Pat; use crate::{Ident, ProgramPart}; /// A slightly more granular part of an es program than ProgramPart #[derive(Debug, Clone, PartialEq)] #[cfg_attr( all(feature = "serde", not(feature = "esprima")), derive(Deserialize, Serialize) )] #[cfg_attr(all(feature = "serde", feature = "esprima"), derive(Deserialize))] pub enum Stmt<'a> { /// Any expression Expr(Expr<'a>), /// A collection of program parts wrapped in curly braces Block(BlockStmt<'a>), /// A single semi-colon Empty, /// The contextual keyword `debugger` Debugger, /// A with statement, this puts one object at the top of /// the identifier search tree. /// > note: this cannot be used in a strict context /// ```js /// function random() { /// return 0; /// } /// let rand; /// with (Math) { /// rand = floor(random() * 100) + 1; /// } /// //rand !== 0 /// ``` With(WithStmt<'a>), /// A return statement /// ```js /// function thing() { /// return 'stuff'; /// } /// function stuff() { /// return; /// } Return(Option<Expr<'a>>), /// A labeled statement /// ```js /// label: { /// break label; /// } /// ``` Labeled(LabeledStmt<'a>), /// A break statement /// ```js /// label: { /// break label; /// } /// while (true) { /// break; /// } /// ``` Break(Option<Ident<'a>>), /// A short circuit continuation of a loop /// ```js /// label: while (true) { /// if (Math.floor(Math.random() * 100) > 50) { /// continue; /// } else { /// console.log('too low') /// } /// } /// ``` Continue(Option<Ident<'a>>), /// An if statement /// ```js /// if (1 < 2) { /// console.log('Always true'); /// } else { /// console.log('Never true'); /// } /// ``` If(IfStmt<'a>), /// A switch statement /// ```js /// switch (Math.floor(Math.random()) * 10) { /// case 1: /// /// break; /// case 2: /// case 3: /// case 4: /// return false; /// default: /// return true; /// } /// ``` Switch(SwitchStmt<'a>), /// A statement that throws an error /// ```js /// function error() { /// throw 'hahahaha'; /// } /// /// function newError() { /// throw new Error('hohoho'); /// } /// ``` Throw(Expr<'a>), /// A try/catch block /// ```js /// try { /// /// } catch (e) { /// /// } finally { /// /// } /// ``` Try(TryStmt<'a>), /// A while loop /// ```js /// while (false) { /// /// } /// var i = 0; /// while (i < 100) { /// if (Math.floor(Math.random() * 100) > 50) { /// i--; /// } else { /// i += 5; /// } /// } /// ``` While(WhileStmt<'a>), /// A while loop that executes its body first /// ```js /// do { /// console.log('at least once') /// } while (Math.floor(Math.random() * 100) < 75) /// ``` DoWhile(DoWhileStmt<'a>), /// A "c-style" for loop /// ```js /// for (var i = 0; i < 100; i++) console.log(i); /// for (;;) { /// console.log('forever!'); /// } /// ``` For(ForStmt<'a>), /// A for in statement, this kind of for statement /// will extract each key from an indexable thing /// ```js /// for (var i in [2,3,4,5,6]) { /// console.log(i); /// } /// //prints 0, 1, 2, 3, 4 /// for (var k in {a: 'b', c: 'd'}) { /// console.log(k); /// } /// //prints a, b /// ``` ForIn(ForInStmt<'a>), /// A for of statement, this kind of for statement /// will extract the value from a generator or iterator /// ```js /// for (var k of [2, 3, 4, 5, 6]) { /// console.log(k); /// } /// //prints 2, 3, 4, 5, 6 /// ``` ForOf(ForOfStmt<'a>), /// A var statement /// ```js /// var x; /// var x, y = 'huh?'; /// ``` Var(Vec<VarDecl<'a>>), } /// A with statement, this puts one object at the top of /// the identifier search tree. /// > note: this cannot be used in a strict context /// ```js /// function random() { /// return 0; /// } /// let rand; /// with (Math) { /// rand = floor(random() * 100) + 1; /// } /// //rand !== 0 /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct WithStmt<'a> { pub object: Expr<'a>, pub body: Box<Stmt<'a>>, } /// A break statement /// ```js /// label: { /// break label; /// } /// while (true) { /// break; /// } /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct LabeledStmt<'a> { pub label: Ident<'a>, pub body: Box<Stmt<'a>>, } /// An if statement /// ```js /// if (1 < 2) { /// console.log('Always true'); /// } else { /// console.log('Never true'); /// } /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct IfStmt<'a> { pub test: Expr<'a>, pub consequent: Box<Stmt<'a>>, pub alternate: Option<Box<Stmt<'a>>>, } /// A switch statement /// ```js /// switch (Math.floor(Math.random()) * 10) { /// case 1: /// /// break; /// case 2: /// case 3: /// case 4: /// return false; /// default: /// return true; /// } /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct SwitchStmt<'a> { pub discriminant: Expr<'a>, pub cases: Vec<SwitchCase<'a>>, } /// A single case part of a switch statement #[derive(Debug, Clone, PartialEq)] #[cfg_attr( all(feature = "serde", not(feature = "esprima")), derive(Deserialize, Serialize) )] #[cfg_attr(all(feature = "serde", feature = "esprima"), derive(Deserialize))] pub struct SwitchCase<'a> { pub test: Option<Expr<'a>>, pub consequent: Vec<ProgramPart<'a>>, } /// A collection of program parts wrapped in curly braces #[derive(Debug, Clone, PartialEq)] #[cfg_attr( all(feature = "serde", not(feature = "esprima")), derive(Deserialize, Serialize) )] #[cfg_attr(all(feature = "serde", feature = "esprima"), derive(Deserialize))] pub struct BlockStmt<'a>(pub Vec<ProgramPart<'a>>); /// A try/catch block /// ```js /// try { /// /// } catch (e) { /// /// } finally { /// /// } /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct TryStmt<'a> { pub block: BlockStmt<'a>, pub handler: Option<CatchClause<'a>>, pub finalizer: Option<BlockStmt<'a>>, } /// The error handling part of a `TryStmt` #[derive(Debug, Clone, PartialEq)] #[cfg_attr( all(feature = "serde", not(feature = "esprima")), derive(Deserialize, Serialize) )] #[cfg_attr(all(feature = "serde", feature = "esprima"), derive(Deserialize))] pub struct CatchClause<'a> { pub param: Option<Pat<'a>>, pub body: BlockStmt<'a>, } /// A while loop /// ```js /// while (false) { /// /// } /// var i = 0; /// while (i < 100) { /// if (Math.floor(Math.random() * 100) > 50) { /// i--; /// } else { /// i += 5; /// } /// } /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct WhileStmt<'a> { pub test: Expr<'a>, pub body: Box<Stmt<'a>>, } /// A while loop that executes its body first /// ```js /// do { /// console.log('at least once') /// } while (Math.floor(Math.random() * 100) < 75) /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct DoWhileStmt<'a> { pub test: Expr<'a>, pub body: Box<Stmt<'a>>, } /// A "c-style" for loop /// ```js /// for (var i = 0; i < 100; i++) console.log(i); /// for (;;) { /// console.log('forever!'); /// } /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct ForStmt<'a> { pub init: Option<LoopInit<'a>>, pub test: Option<Expr<'a>>, pub update: Option<Expr<'a>>, pub body: Box<Stmt<'a>>, } /// The left most triple of a for loops parenthetical /// ```js /// // vvvvvvvvv /// for (var i = 0;i < 100; i++) #[derive(Debug, Clone, PartialEq)] #[cfg_attr( all(feature = "serde", not(feature = "esprima")), derive(Deserialize, Serialize) )] #[cfg_attr(all(feature = "serde", feature = "esprima"), derive(Deserialize))] pub enum LoopInit<'a> { Variable(VarKind, Vec<VarDecl<'a>>), Expr(Expr<'a>), } /// A for in statement, this kind of for statement /// will extract each key from an indexable thing /// ```js /// for (var i in [2,3,4,5,6]) { /// console.log(i); /// } /// //prints 0, 1, 2, 3, 4 /// for (var k in {a: 'b', c: 'd'}) { /// console.log(k); /// } /// //prints a, b /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct ForInStmt<'a> { pub left: LoopLeft<'a>, pub right: Expr<'a>, pub body: Box<Stmt<'a>>, } /// A for of statement, this kind of for statement /// will extract the value from a generator or iterator /// ```js /// for (var k of [2, 3, 4, 5, 6]) { /// console.log(k); /// } /// //prints 2, 3, 4, 5, 6 /// ``` #[derive(PartialEq, Debug, Clone)] #[cfg_attr(all(feature = "serialization"), derive(Deserialize, Serialize))] pub struct ForOfStmt<'a> { pub left: LoopLeft<'a>, pub right: Expr<'a>, pub body: Box<Stmt<'a>>, pub is_await: bool, } /// The values on the left hand side of the keyword /// in a for in or for of loop #[derive(Debug, Clone, PartialEq)] #[cfg_attr( all(feature = "serde", not(feature = "esprima")), derive(Deserialize, Serialize) )] #[cfg_attr(all(feature = "serde", feature = "esprima"), derive(Deserialize))] pub enum LoopLeft<'a> { Expr(Expr<'a>), Variable(VarKind, VarDecl<'a>), Pat(Pat<'a>), }