eslint 9.21.0 → 9.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (425) hide show
  1. package/README.md +52 -48
  2. package/bin/eslint.js +92 -90
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +1 -1
  5. package/conf/globals.js +97 -98
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +88 -92
  8. package/lib/api.js +12 -12
  9. package/lib/cli-engine/cli-engine.js +828 -808
  10. package/lib/cli-engine/file-enumerator.js +381 -387
  11. package/lib/cli-engine/formatters/formatters-meta.json +16 -16
  12. package/lib/cli-engine/formatters/html.js +107 -99
  13. package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
  14. package/lib/cli-engine/formatters/json.js +2 -2
  15. package/lib/cli-engine/formatters/stylish.js +96 -75
  16. package/lib/cli-engine/hash.js +1 -1
  17. package/lib/cli-engine/index.js +1 -1
  18. package/lib/cli-engine/lint-result-cache.js +144 -145
  19. package/lib/cli-engine/load-rules.js +16 -16
  20. package/lib/cli.js +541 -457
  21. package/lib/config/config-loader.js +648 -618
  22. package/lib/config/config.js +247 -221
  23. package/lib/config/default-config.js +54 -45
  24. package/lib/config/flat-config-array.js +167 -172
  25. package/lib/config/flat-config-helpers.js +65 -68
  26. package/lib/config/flat-config-schema.js +375 -368
  27. package/lib/config/rule-validator.js +139 -144
  28. package/lib/config-api.js +12 -0
  29. package/lib/eslint/eslint-helpers.js +709 -679
  30. package/lib/eslint/eslint.js +944 -886
  31. package/lib/eslint/index.js +2 -2
  32. package/lib/eslint/legacy-eslint.js +576 -532
  33. package/lib/languages/js/index.js +263 -264
  34. package/lib/languages/js/source-code/index.js +1 -1
  35. package/lib/languages/js/source-code/source-code.js +1129 -1054
  36. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +39 -35
  37. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +35 -36
  38. package/lib/languages/js/source-code/token-store/cursor.js +36 -36
  39. package/lib/languages/js/source-code/token-store/cursors.js +80 -52
  40. package/lib/languages/js/source-code/token-store/decorative-cursor.js +17 -18
  41. package/lib/languages/js/source-code/token-store/filter-cursor.js +19 -20
  42. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +40 -32
  43. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +40 -41
  44. package/lib/languages/js/source-code/token-store/index.js +592 -498
  45. package/lib/languages/js/source-code/token-store/limit-cursor.js +17 -18
  46. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +23 -16
  47. package/lib/languages/js/source-code/token-store/skip-cursor.js +19 -20
  48. package/lib/languages/js/source-code/token-store/utils.js +63 -60
  49. package/lib/languages/js/validate-language-options.js +104 -89
  50. package/lib/linter/apply-disable-directives.js +467 -383
  51. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -672
  52. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  53. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  54. package/lib/linter/code-path-analysis/code-path.js +307 -319
  55. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  56. package/lib/linter/code-path-analysis/fork-context.js +296 -271
  57. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  58. package/lib/linter/file-context.js +119 -120
  59. package/lib/linter/index.js +3 -3
  60. package/lib/linter/interpolate.js +16 -16
  61. package/lib/linter/linter.js +2402 -2044
  62. package/lib/linter/node-event-generator.js +284 -225
  63. package/lib/linter/report-translator.js +256 -219
  64. package/lib/linter/rule-fixer.js +122 -124
  65. package/lib/linter/rules.js +35 -35
  66. package/lib/linter/safe-emitter.js +18 -18
  67. package/lib/linter/source-code-fixer.js +94 -92
  68. package/lib/linter/timing.js +104 -101
  69. package/lib/linter/vfile.js +70 -73
  70. package/lib/options.js +375 -361
  71. package/lib/rule-tester/index.js +1 -1
  72. package/lib/rule-tester/rule-tester.js +1307 -1045
  73. package/lib/rules/accessor-pairs.js +297 -262
  74. package/lib/rules/array-bracket-newline.js +249 -237
  75. package/lib/rules/array-bracket-spacing.js +262 -223
  76. package/lib/rules/array-callback-return.js +401 -355
  77. package/lib/rules/array-element-newline.js +357 -312
  78. package/lib/rules/arrow-body-style.js +399 -280
  79. package/lib/rules/arrow-parens.js +205 -172
  80. package/lib/rules/arrow-spacing.js +168 -162
  81. package/lib/rules/block-scoped-var.js +124 -122
  82. package/lib/rules/block-spacing.js +185 -175
  83. package/lib/rules/brace-style.js +261 -198
  84. package/lib/rules/callback-return.js +202 -189
  85. package/lib/rules/camelcase.js +402 -391
  86. package/lib/rules/capitalized-comments.js +252 -231
  87. package/lib/rules/class-methods-use-this.js +179 -171
  88. package/lib/rules/comma-dangle.js +378 -345
  89. package/lib/rules/comma-spacing.js +192 -194
  90. package/lib/rules/comma-style.js +374 -315
  91. package/lib/rules/complexity.js +172 -168
  92. package/lib/rules/computed-property-spacing.js +235 -210
  93. package/lib/rules/consistent-return.js +180 -169
  94. package/lib/rules/consistent-this.js +166 -146
  95. package/lib/rules/constructor-super.js +411 -403
  96. package/lib/rules/curly.js +406 -331
  97. package/lib/rules/default-case-last.js +37 -30
  98. package/lib/rules/default-case.js +88 -84
  99. package/lib/rules/default-param-last.js +68 -53
  100. package/lib/rules/dot-location.js +121 -109
  101. package/lib/rules/dot-notation.js +191 -155
  102. package/lib/rules/eol-last.js +121 -119
  103. package/lib/rules/eqeqeq.js +167 -154
  104. package/lib/rules/for-direction.js +145 -120
  105. package/lib/rules/func-call-spacing.js +260 -230
  106. package/lib/rules/func-name-matching.js +292 -208
  107. package/lib/rules/func-names.js +164 -163
  108. package/lib/rules/func-style.js +158 -126
  109. package/lib/rules/function-call-argument-newline.js +151 -128
  110. package/lib/rules/function-paren-newline.js +348 -290
  111. package/lib/rules/generator-star-spacing.js +228 -209
  112. package/lib/rules/getter-return.js +207 -171
  113. package/lib/rules/global-require.js +84 -73
  114. package/lib/rules/grouped-accessor-pairs.js +169 -149
  115. package/lib/rules/guard-for-in.js +71 -62
  116. package/lib/rules/handle-callback-err.js +107 -102
  117. package/lib/rules/id-blacklist.js +181 -198
  118. package/lib/rules/id-denylist.js +167 -186
  119. package/lib/rules/id-length.js +196 -170
  120. package/lib/rules/id-match.js +343 -288
  121. package/lib/rules/implicit-arrow-linebreak.js +101 -78
  122. package/lib/rules/indent-legacy.js +1343 -1117
  123. package/lib/rules/indent.js +2271 -1758
  124. package/lib/rules/index.js +317 -292
  125. package/lib/rules/init-declarations.js +115 -106
  126. package/lib/rules/jsx-quotes.js +93 -81
  127. package/lib/rules/key-spacing.js +749 -632
  128. package/lib/rules/keyword-spacing.js +647 -604
  129. package/lib/rules/line-comment-position.js +141 -127
  130. package/lib/rules/linebreak-style.js +106 -105
  131. package/lib/rules/lines-around-comment.js +539 -447
  132. package/lib/rules/lines-around-directive.js +232 -202
  133. package/lib/rules/lines-between-class-members.js +304 -233
  134. package/lib/rules/logical-assignment-operators.js +581 -398
  135. package/lib/rules/max-classes-per-file.js +68 -67
  136. package/lib/rules/max-depth.js +145 -142
  137. package/lib/rules/max-len.js +472 -433
  138. package/lib/rules/max-lines-per-function.js +200 -175
  139. package/lib/rules/max-lines.js +157 -161
  140. package/lib/rules/max-nested-callbacks.js +101 -103
  141. package/lib/rules/max-params.js +77 -75
  142. package/lib/rules/max-statements-per-line.js +204 -197
  143. package/lib/rules/max-statements.js +167 -163
  144. package/lib/rules/multiline-comment-style.js +636 -478
  145. package/lib/rules/multiline-ternary.js +240 -175
  146. package/lib/rules/new-cap.js +232 -212
  147. package/lib/rules/new-parens.js +87 -78
  148. package/lib/rules/newline-after-var.js +286 -249
  149. package/lib/rules/newline-before-return.js +228 -221
  150. package/lib/rules/newline-per-chained-call.js +141 -126
  151. package/lib/rules/no-alert.js +89 -78
  152. package/lib/rules/no-array-constructor.js +121 -112
  153. package/lib/rules/no-async-promise-executor.js +29 -23
  154. package/lib/rules/no-await-in-loop.js +68 -70
  155. package/lib/rules/no-bitwise.js +123 -99
  156. package/lib/rules/no-buffer-constructor.js +54 -46
  157. package/lib/rules/no-caller.js +38 -32
  158. package/lib/rules/no-case-declarations.js +60 -56
  159. package/lib/rules/no-catch-shadow.js +75 -72
  160. package/lib/rules/no-class-assign.js +50 -47
  161. package/lib/rules/no-compare-neg-zero.js +61 -47
  162. package/lib/rules/no-cond-assign.js +147 -131
  163. package/lib/rules/no-confusing-arrow.js +97 -80
  164. package/lib/rules/no-console.js +201 -190
  165. package/lib/rules/no-const-assign.js +46 -40
  166. package/lib/rules/no-constant-binary-expression.js +499 -404
  167. package/lib/rules/no-constant-condition.js +157 -142
  168. package/lib/rules/no-constructor-return.js +48 -48
  169. package/lib/rules/no-continue.js +24 -26
  170. package/lib/rules/no-control-regex.js +124 -120
  171. package/lib/rules/no-debugger.js +27 -29
  172. package/lib/rules/no-delete-var.js +28 -28
  173. package/lib/rules/no-div-regex.js +46 -40
  174. package/lib/rules/no-dupe-args.js +67 -68
  175. package/lib/rules/no-dupe-class-members.js +92 -88
  176. package/lib/rules/no-dupe-else-if.js +99 -76
  177. package/lib/rules/no-dupe-keys.js +132 -109
  178. package/lib/rules/no-duplicate-case.js +49 -42
  179. package/lib/rules/no-duplicate-imports.js +178 -175
  180. package/lib/rules/no-else-return.js +429 -384
  181. package/lib/rules/no-empty-character-class.js +56 -49
  182. package/lib/rules/no-empty-function.js +126 -127
  183. package/lib/rules/no-empty-pattern.js +62 -57
  184. package/lib/rules/no-empty-static-block.js +36 -34
  185. package/lib/rules/no-empty.js +97 -85
  186. package/lib/rules/no-eq-null.js +36 -31
  187. package/lib/rules/no-eval.js +255 -249
  188. package/lib/rules/no-ex-assign.js +41 -38
  189. package/lib/rules/no-extend-native.js +160 -158
  190. package/lib/rules/no-extra-bind.js +200 -189
  191. package/lib/rules/no-extra-boolean-cast.js +397 -347
  192. package/lib/rules/no-extra-label.js +149 -130
  193. package/lib/rules/no-extra-parens.js +1653 -1324
  194. package/lib/rules/no-extra-semi.js +145 -143
  195. package/lib/rules/no-fallthrough.js +198 -156
  196. package/lib/rules/no-floating-decimal.js +73 -65
  197. package/lib/rules/no-func-assign.js +53 -54
  198. package/lib/rules/no-global-assign.js +77 -72
  199. package/lib/rules/no-implicit-coercion.js +348 -292
  200. package/lib/rules/no-implicit-globals.js +157 -134
  201. package/lib/rules/no-implied-eval.js +139 -111
  202. package/lib/rules/no-import-assign.js +144 -158
  203. package/lib/rules/no-inline-comments.js +100 -94
  204. package/lib/rules/no-inner-declarations.js +114 -100
  205. package/lib/rules/no-invalid-regexp.js +221 -189
  206. package/lib/rules/no-invalid-this.js +122 -116
  207. package/lib/rules/no-irregular-whitespace.js +265 -251
  208. package/lib/rules/no-iterator.js +28 -32
  209. package/lib/rules/no-label-var.js +58 -61
  210. package/lib/rules/no-labels.js +137 -132
  211. package/lib/rules/no-lone-blocks.js +126 -122
  212. package/lib/rules/no-lonely-if.js +107 -76
  213. package/lib/rules/no-loop-func.js +233 -212
  214. package/lib/rules/no-loss-of-precision.js +215 -200
  215. package/lib/rules/no-magic-numbers.js +245 -217
  216. package/lib/rules/no-misleading-character-class.js +498 -445
  217. package/lib/rules/no-mixed-operators.js +187 -181
  218. package/lib/rules/no-mixed-requires.js +252 -239
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +133 -120
  220. package/lib/rules/no-multi-assign.js +45 -43
  221. package/lib/rules/no-multi-spaces.js +162 -142
  222. package/lib/rules/no-multi-str.js +41 -40
  223. package/lib/rules/no-multiple-empty-lines.js +195 -157
  224. package/lib/rules/no-native-reassign.js +89 -84
  225. package/lib/rules/no-negated-condition.js +78 -74
  226. package/lib/rules/no-negated-in-lhs.js +44 -42
  227. package/lib/rules/no-nested-ternary.js +32 -31
  228. package/lib/rules/no-new-func.js +70 -61
  229. package/lib/rules/no-new-native-nonconstructor.js +42 -38
  230. package/lib/rules/no-new-object.js +47 -47
  231. package/lib/rules/no-new-require.js +47 -46
  232. package/lib/rules/no-new-symbol.js +51 -49
  233. package/lib/rules/no-new-wrappers.js +42 -40
  234. package/lib/rules/no-new.js +27 -28
  235. package/lib/rules/no-nonoctal-decimal-escape.js +140 -120
  236. package/lib/rules/no-obj-calls.js +65 -52
  237. package/lib/rules/no-object-constructor.js +103 -96
  238. package/lib/rules/no-octal-escape.js +39 -42
  239. package/lib/rules/no-octal.js +31 -31
  240. package/lib/rules/no-param-reassign.js +234 -216
  241. package/lib/rules/no-path-concat.js +65 -66
  242. package/lib/rules/no-plusplus.js +59 -60
  243. package/lib/rules/no-process-env.js +48 -47
  244. package/lib/rules/no-process-exit.js +53 -49
  245. package/lib/rules/no-promise-executor-return.js +213 -181
  246. package/lib/rules/no-proto.js +25 -28
  247. package/lib/rules/no-prototype-builtins.js +145 -123
  248. package/lib/rules/no-redeclare.js +153 -151
  249. package/lib/rules/no-regex-spaces.js +182 -160
  250. package/lib/rules/no-restricted-exports.js +207 -184
  251. package/lib/rules/no-restricted-globals.js +110 -111
  252. package/lib/rules/no-restricted-imports.js +656 -536
  253. package/lib/rules/no-restricted-modules.js +221 -201
  254. package/lib/rules/no-restricted-properties.js +180 -152
  255. package/lib/rules/no-restricted-syntax.js +55 -51
  256. package/lib/rules/no-return-assign.js +54 -49
  257. package/lib/rules/no-return-await.js +147 -123
  258. package/lib/rules/no-script-url.js +51 -44
  259. package/lib/rules/no-self-assign.js +147 -145
  260. package/lib/rules/no-self-compare.js +62 -45
  261. package/lib/rules/no-sequences.js +134 -115
  262. package/lib/rules/no-setter-return.js +184 -151
  263. package/lib/rules/no-shadow-restricted-names.js +60 -45
  264. package/lib/rules/no-shadow.js +341 -315
  265. package/lib/rules/no-spaced-func.js +81 -76
  266. package/lib/rules/no-sparse-arrays.js +53 -58
  267. package/lib/rules/no-sync.js +60 -59
  268. package/lib/rules/no-tabs.js +82 -71
  269. package/lib/rules/no-template-curly-in-string.js +32 -31
  270. package/lib/rules/no-ternary.js +24 -28
  271. package/lib/rules/no-this-before-super.js +320 -318
  272. package/lib/rules/no-throw-literal.js +30 -35
  273. package/lib/rules/no-trailing-spaces.js +198 -190
  274. package/lib/rules/no-undef-init.js +75 -60
  275. package/lib/rules/no-undef.js +50 -47
  276. package/lib/rules/no-undefined.js +72 -74
  277. package/lib/rules/no-underscore-dangle.js +369 -326
  278. package/lib/rules/no-unexpected-multiline.js +111 -101
  279. package/lib/rules/no-unmodified-loop-condition.js +253 -253
  280. package/lib/rules/no-unneeded-ternary.js +211 -146
  281. package/lib/rules/no-unreachable-loop.js +144 -141
  282. package/lib/rules/no-unreachable.js +254 -247
  283. package/lib/rules/no-unsafe-finally.js +92 -84
  284. package/lib/rules/no-unsafe-negation.js +104 -82
  285. package/lib/rules/no-unsafe-optional-chaining.js +191 -177
  286. package/lib/rules/no-unused-expressions.js +177 -161
  287. package/lib/rules/no-unused-labels.js +138 -123
  288. package/lib/rules/no-unused-private-class-members.js +205 -181
  289. package/lib/rules/no-unused-vars.js +1668 -1448
  290. package/lib/rules/no-use-before-define.js +228 -230
  291. package/lib/rules/no-useless-assignment.js +589 -510
  292. package/lib/rules/no-useless-backreference.js +211 -192
  293. package/lib/rules/no-useless-call.js +57 -52
  294. package/lib/rules/no-useless-catch.js +39 -39
  295. package/lib/rules/no-useless-computed-key.js +143 -114
  296. package/lib/rules/no-useless-concat.js +64 -59
  297. package/lib/rules/no-useless-constructor.js +157 -110
  298. package/lib/rules/no-useless-escape.js +341 -290
  299. package/lib/rules/no-useless-rename.js +182 -155
  300. package/lib/rules/no-useless-return.js +343 -311
  301. package/lib/rules/no-var.js +232 -211
  302. package/lib/rules/no-void.js +49 -47
  303. package/lib/rules/no-warning-comments.js +190 -185
  304. package/lib/rules/no-whitespace-before-property.js +130 -114
  305. package/lib/rules/no-with.js +23 -25
  306. package/lib/rules/nonblock-statement-body-position.js +148 -129
  307. package/lib/rules/object-curly-newline.js +305 -264
  308. package/lib/rules/object-curly-spacing.js +359 -313
  309. package/lib/rules/object-property-newline.js +136 -105
  310. package/lib/rules/object-shorthand.js +606 -501
  311. package/lib/rules/one-var-declaration-per-line.js +103 -99
  312. package/lib/rules/one-var.js +652 -536
  313. package/lib/rules/operator-assignment.js +218 -160
  314. package/lib/rules/operator-linebreak.js +294 -250
  315. package/lib/rules/padded-blocks.js +345 -307
  316. package/lib/rules/padding-line-between-statements.js +442 -438
  317. package/lib/rules/prefer-arrow-callback.js +361 -312
  318. package/lib/rules/prefer-const.js +417 -376
  319. package/lib/rules/prefer-destructuring.js +300 -278
  320. package/lib/rules/prefer-exponentiation-operator.js +175 -132
  321. package/lib/rules/prefer-named-capture-group.js +152 -139
  322. package/lib/rules/prefer-numeric-literals.js +120 -112
  323. package/lib/rules/prefer-object-has-own.js +115 -81
  324. package/lib/rules/prefer-object-spread.js +212 -192
  325. package/lib/rules/prefer-promise-reject-errors.js +139 -121
  326. package/lib/rules/prefer-reflect.js +126 -106
  327. package/lib/rules/prefer-regex-literals.js +577 -465
  328. package/lib/rules/prefer-rest-params.js +78 -79
  329. package/lib/rules/prefer-spread.js +46 -43
  330. package/lib/rules/prefer-template.js +265 -194
  331. package/lib/rules/quote-props.js +372 -306
  332. package/lib/rules/quotes.js +373 -325
  333. package/lib/rules/radix.js +151 -135
  334. package/lib/rules/require-atomic-updates.js +315 -284
  335. package/lib/rules/require-await.js +143 -115
  336. package/lib/rules/require-unicode-regexp.js +281 -176
  337. package/lib/rules/require-yield.js +52 -53
  338. package/lib/rules/rest-spread-spacing.js +127 -115
  339. package/lib/rules/semi-spacing.js +280 -249
  340. package/lib/rules/semi-style.js +175 -133
  341. package/lib/rules/semi.js +455 -435
  342. package/lib/rules/sort-imports.js +305 -232
  343. package/lib/rules/sort-keys.js +218 -187
  344. package/lib/rules/sort-vars.js +126 -92
  345. package/lib/rules/space-before-blocks.js +198 -188
  346. package/lib/rules/space-before-function-paren.js +185 -165
  347. package/lib/rules/space-in-parens.js +358 -287
  348. package/lib/rules/space-infix-ops.js +236 -200
  349. package/lib/rules/space-unary-ops.js +355 -297
  350. package/lib/rules/spaced-comment.js +362 -318
  351. package/lib/rules/strict.js +264 -229
  352. package/lib/rules/switch-colon-spacing.js +129 -121
  353. package/lib/rules/symbol-description.js +44 -47
  354. package/lib/rules/template-curly-spacing.js +147 -141
  355. package/lib/rules/template-tag-spacing.js +97 -87
  356. package/lib/rules/unicode-bom.js +53 -55
  357. package/lib/rules/use-isnan.js +236 -205
  358. package/lib/rules/utils/ast-utils.js +2039 -1860
  359. package/lib/rules/utils/char-source.js +162 -155
  360. package/lib/rules/utils/fix-tracker.js +83 -80
  361. package/lib/rules/utils/keywords.js +59 -59
  362. package/lib/rules/utils/lazy-loading-rule-map.js +79 -76
  363. package/lib/rules/utils/regular-expressions.js +32 -24
  364. package/lib/rules/utils/unicode/index.js +4 -4
  365. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  366. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  367. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  368. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  369. package/lib/rules/valid-typeof.js +152 -110
  370. package/lib/rules/vars-on-top.js +151 -144
  371. package/lib/rules/wrap-iife.js +203 -190
  372. package/lib/rules/wrap-regex.js +69 -57
  373. package/lib/rules/yield-star-spacing.js +144 -133
  374. package/lib/rules/yoda.js +282 -271
  375. package/lib/services/parser-service.js +35 -35
  376. package/lib/services/processor-service.js +66 -73
  377. package/lib/shared/ajv.js +14 -14
  378. package/lib/shared/assert.js +3 -4
  379. package/lib/shared/ast-utils.js +7 -6
  380. package/lib/shared/deep-merge-arrays.js +24 -22
  381. package/lib/shared/directives.js +3 -2
  382. package/lib/shared/flags.js +46 -17
  383. package/lib/shared/logging.js +24 -25
  384. package/lib/shared/option-utils.js +43 -36
  385. package/lib/shared/runtime-info.js +136 -127
  386. package/lib/shared/serialization.js +27 -27
  387. package/lib/shared/severity.js +22 -22
  388. package/lib/shared/stats.js +5 -5
  389. package/lib/shared/string-utils.js +16 -16
  390. package/lib/shared/text-table.js +28 -27
  391. package/lib/shared/traverser.js +153 -146
  392. package/lib/types/config-api.d.ts +8 -0
  393. package/lib/types/index.d.ts +2010 -1559
  394. package/lib/types/rules.d.ts +5312 -0
  395. package/lib/types/use-at-your-own-risk.d.ts +32 -30
  396. package/lib/unsupported-api.js +5 -5
  397. package/messages/all-files-ignored.js +3 -3
  398. package/messages/all-matched-files-ignored.js +3 -3
  399. package/messages/config-file-missing.js +2 -2
  400. package/messages/config-plugin-missing.js +3 -3
  401. package/messages/config-serialize-function.js +9 -7
  402. package/messages/eslintrc-incompat.js +13 -15
  403. package/messages/eslintrc-plugins.js +3 -4
  404. package/messages/extend-config-missing.js +3 -3
  405. package/messages/failed-to-read-json.js +3 -3
  406. package/messages/file-not-found.js +3 -3
  407. package/messages/invalid-rule-options.js +2 -2
  408. package/messages/invalid-rule-severity.js +2 -2
  409. package/messages/no-config-found.js +3 -3
  410. package/messages/plugin-conflict.js +8 -8
  411. package/messages/plugin-invalid.js +3 -3
  412. package/messages/plugin-missing.js +3 -3
  413. package/messages/print-config-with-directory-path.js +2 -2
  414. package/messages/shared.js +6 -1
  415. package/messages/whitespace-found.js +3 -3
  416. package/package.json +22 -20
  417. package/lib/types/rules/best-practices.d.ts +0 -1143
  418. package/lib/types/rules/deprecated.d.ts +0 -252
  419. package/lib/types/rules/ecmascript-6.d.ts +0 -647
  420. package/lib/types/rules/index.d.ts +0 -50
  421. package/lib/types/rules/node-commonjs.d.ts +0 -171
  422. package/lib/types/rules/possible-errors.d.ts +0 -685
  423. package/lib/types/rules/strict-mode.d.ts +0 -38
  424. package/lib/types/rules/stylistic-issues.d.ts +0 -2043
  425. package/lib/types/rules/variables.d.ts +0 -234
@@ -10,7 +10,7 @@
10
10
  //------------------------------------------------------------------------------
11
11
 
12
12
  const CodePathSegment = require("./code-path-segment"),
13
- ForkContext = require("./fork-context");
13
+ ForkContext = require("./fork-context");
14
14
 
15
15
  //-----------------------------------------------------------------------------
16
16
  // Contexts
@@ -35,68 +35,63 @@ const CodePathSegment = require("./code-path-segment"),
35
35
  * that `break` without a label is invalid.
36
36
  */
37
37
  class BreakContext {
38
-
39
- /**
40
- * Creates a new instance.
41
- * @param {BreakContext} upperContext The previous `BreakContext`.
42
- * @param {boolean} breakable Indicates if we are inside a statement where
43
- * `break` without a label will exit the statement.
44
- * @param {string|null} label The label for the statement.
45
- * @param {ForkContext} forkContext The current fork context.
46
- */
47
- constructor(upperContext, breakable, label, forkContext) {
48
-
49
- /**
50
- * The previous `BreakContext`
51
- * @type {BreakContext}
52
- */
53
- this.upper = upperContext;
54
-
55
- /**
56
- * Indicates if we are inside a statement where `break` without a label
57
- * will exit the statement.
58
- * @type {boolean}
59
- */
60
- this.breakable = breakable;
61
-
62
- /**
63
- * The label associated with the statement.
64
- * @type {string|null}
65
- */
66
- this.label = label;
67
-
68
- /**
69
- * The fork context for the `break`.
70
- * @type {ForkContext}
71
- */
72
- this.brokenForkContext = ForkContext.newEmpty(forkContext);
73
- }
38
+ /**
39
+ * Creates a new instance.
40
+ * @param {BreakContext} upperContext The previous `BreakContext`.
41
+ * @param {boolean} breakable Indicates if we are inside a statement where
42
+ * `break` without a label will exit the statement.
43
+ * @param {string|null} label The label for the statement.
44
+ * @param {ForkContext} forkContext The current fork context.
45
+ */
46
+ constructor(upperContext, breakable, label, forkContext) {
47
+ /**
48
+ * The previous `BreakContext`
49
+ * @type {BreakContext}
50
+ */
51
+ this.upper = upperContext;
52
+
53
+ /**
54
+ * Indicates if we are inside a statement where `break` without a label
55
+ * will exit the statement.
56
+ * @type {boolean}
57
+ */
58
+ this.breakable = breakable;
59
+
60
+ /**
61
+ * The label associated with the statement.
62
+ * @type {string|null}
63
+ */
64
+ this.label = label;
65
+
66
+ /**
67
+ * The fork context for the `break`.
68
+ * @type {ForkContext}
69
+ */
70
+ this.brokenForkContext = ForkContext.newEmpty(forkContext);
71
+ }
74
72
  }
75
73
 
76
74
  /**
77
75
  * Represents the context for `ChainExpression` nodes.
78
76
  */
79
77
  class ChainContext {
80
-
81
- /**
82
- * Creates a new instance.
83
- * @param {ChainContext} upperContext The previous `ChainContext`.
84
- */
85
- constructor(upperContext) {
86
-
87
- /**
88
- * The previous `ChainContext`
89
- * @type {ChainContext}
90
- */
91
- this.upper = upperContext;
92
-
93
- /**
94
- * The number of choice contexts inside of the `ChainContext`.
95
- * @type {number}
96
- */
97
- this.choiceContextCount = 0;
98
-
99
- }
78
+ /**
79
+ * Creates a new instance.
80
+ * @param {ChainContext} upperContext The previous `ChainContext`.
81
+ */
82
+ constructor(upperContext) {
83
+ /**
84
+ * The previous `ChainContext`
85
+ * @type {ChainContext}
86
+ */
87
+ this.upper = upperContext;
88
+
89
+ /**
90
+ * The number of choice contexts inside of the `ChainContext`.
91
+ * @type {number}
92
+ */
93
+ this.choiceContextCount = 0;
94
+ }
100
95
  }
101
96
 
102
97
  /**
@@ -124,249 +119,241 @@ class ChainContext {
124
119
  * we fork to the right expression (tracked by `nullishForkContext`).
125
120
  */
126
121
  class ChoiceContext {
127
-
128
- /**
129
- * Creates a new instance.
130
- * @param {ChoiceContext} upperContext The previous `ChoiceContext`.
131
- * @param {string} kind The kind of choice. If it's a logical or assignment expression, this
132
- * is `"&&"` or `"||"` or `"??"`; if it's an `if` statement or
133
- * conditional expression, this is `"test"`; otherwise, this is `"loop"`.
134
- * @param {boolean} isForkingAsResult Indicates if the result of the choice
135
- * creates a fork.
136
- * @param {ForkContext} forkContext The containing `ForkContext`.
137
- */
138
- constructor(upperContext, kind, isForkingAsResult, forkContext) {
139
-
140
- /**
141
- * The previous `ChoiceContext`
142
- * @type {ChoiceContext}
143
- */
144
- this.upper = upperContext;
145
-
146
- /**
147
- * The kind of choice. If it's a logical or assignment expression, this
148
- * is `"&&"` or `"||"` or `"??"`; if it's an `if` statement or
149
- * conditional expression, this is `"test"`; otherwise, this is `"loop"`.
150
- * @type {string}
151
- */
152
- this.kind = kind;
153
-
154
- /**
155
- * Indicates if the result of the choice forks the code path.
156
- * @type {boolean}
157
- */
158
- this.isForkingAsResult = isForkingAsResult;
159
-
160
- /**
161
- * The fork context for the `true` path of the choice.
162
- * @type {ForkContext}
163
- */
164
- this.trueForkContext = ForkContext.newEmpty(forkContext);
165
-
166
- /**
167
- * The fork context for the `false` path of the choice.
168
- * @type {ForkContext}
169
- */
170
- this.falseForkContext = ForkContext.newEmpty(forkContext);
171
-
172
- /**
173
- * The fork context for when the choice result is `null` or `undefined`.
174
- * @type {ForkContext}
175
- */
176
- this.nullishForkContext = ForkContext.newEmpty(forkContext);
177
-
178
- /**
179
- * Indicates if any of `trueForkContext`, `falseForkContext`, or
180
- * `nullishForkContext` have been updated with segments from a child context.
181
- * @type {boolean}
182
- */
183
- this.processed = false;
184
- }
185
-
122
+ /**
123
+ * Creates a new instance.
124
+ * @param {ChoiceContext} upperContext The previous `ChoiceContext`.
125
+ * @param {string} kind The kind of choice. If it's a logical or assignment expression, this
126
+ * is `"&&"` or `"||"` or `"??"`; if it's an `if` statement or
127
+ * conditional expression, this is `"test"`; otherwise, this is `"loop"`.
128
+ * @param {boolean} isForkingAsResult Indicates if the result of the choice
129
+ * creates a fork.
130
+ * @param {ForkContext} forkContext The containing `ForkContext`.
131
+ */
132
+ constructor(upperContext, kind, isForkingAsResult, forkContext) {
133
+ /**
134
+ * The previous `ChoiceContext`
135
+ * @type {ChoiceContext}
136
+ */
137
+ this.upper = upperContext;
138
+
139
+ /**
140
+ * The kind of choice. If it's a logical or assignment expression, this
141
+ * is `"&&"` or `"||"` or `"??"`; if it's an `if` statement or
142
+ * conditional expression, this is `"test"`; otherwise, this is `"loop"`.
143
+ * @type {string}
144
+ */
145
+ this.kind = kind;
146
+
147
+ /**
148
+ * Indicates if the result of the choice forks the code path.
149
+ * @type {boolean}
150
+ */
151
+ this.isForkingAsResult = isForkingAsResult;
152
+
153
+ /**
154
+ * The fork context for the `true` path of the choice.
155
+ * @type {ForkContext}
156
+ */
157
+ this.trueForkContext = ForkContext.newEmpty(forkContext);
158
+
159
+ /**
160
+ * The fork context for the `false` path of the choice.
161
+ * @type {ForkContext}
162
+ */
163
+ this.falseForkContext = ForkContext.newEmpty(forkContext);
164
+
165
+ /**
166
+ * The fork context for when the choice result is `null` or `undefined`.
167
+ * @type {ForkContext}
168
+ */
169
+ this.nullishForkContext = ForkContext.newEmpty(forkContext);
170
+
171
+ /**
172
+ * Indicates if any of `trueForkContext`, `falseForkContext`, or
173
+ * `nullishForkContext` have been updated with segments from a child context.
174
+ * @type {boolean}
175
+ */
176
+ this.processed = false;
177
+ }
186
178
  }
187
179
 
188
180
  /**
189
181
  * Base class for all loop contexts.
190
182
  */
191
183
  class LoopContextBase {
192
-
193
- /**
194
- * Creates a new instance.
195
- * @param {LoopContext|null} upperContext The previous `LoopContext`.
196
- * @param {string} type The AST node's `type` for the loop.
197
- * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
198
- * @param {BreakContext} breakContext The context for breaking the loop.
199
- */
200
- constructor(upperContext, type, label, breakContext) {
201
-
202
- /**
203
- * The previous `LoopContext`.
204
- * @type {LoopContext}
205
- */
206
- this.upper = upperContext;
207
-
208
- /**
209
- * The AST node's `type` for the loop.
210
- * @type {string}
211
- */
212
- this.type = type;
213
-
214
- /**
215
- * The label for the loop from an enclosing `LabeledStatement`.
216
- * @type {string|null}
217
- */
218
- this.label = label;
219
-
220
- /**
221
- * The fork context for when `break` is encountered.
222
- * @type {ForkContext}
223
- */
224
- this.brokenForkContext = breakContext.brokenForkContext;
225
- }
184
+ /**
185
+ * Creates a new instance.
186
+ * @param {LoopContext|null} upperContext The previous `LoopContext`.
187
+ * @param {string} type The AST node's `type` for the loop.
188
+ * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
189
+ * @param {BreakContext} breakContext The context for breaking the loop.
190
+ */
191
+ constructor(upperContext, type, label, breakContext) {
192
+ /**
193
+ * The previous `LoopContext`.
194
+ * @type {LoopContext}
195
+ */
196
+ this.upper = upperContext;
197
+
198
+ /**
199
+ * The AST node's `type` for the loop.
200
+ * @type {string}
201
+ */
202
+ this.type = type;
203
+
204
+ /**
205
+ * The label for the loop from an enclosing `LabeledStatement`.
206
+ * @type {string|null}
207
+ */
208
+ this.label = label;
209
+
210
+ /**
211
+ * The fork context for when `break` is encountered.
212
+ * @type {ForkContext}
213
+ */
214
+ this.brokenForkContext = breakContext.brokenForkContext;
215
+ }
226
216
  }
227
217
 
228
218
  /**
229
219
  * Represents the context for a `while` loop.
230
220
  */
231
221
  class WhileLoopContext extends LoopContextBase {
232
-
233
- /**
234
- * Creates a new instance.
235
- * @param {LoopContext|null} upperContext The previous `LoopContext`.
236
- * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
237
- * @param {BreakContext} breakContext The context for breaking the loop.
238
- */
239
- constructor(upperContext, label, breakContext) {
240
- super(upperContext, "WhileStatement", label, breakContext);
241
-
242
- /**
243
- * The hardcoded literal boolean test condition for
244
- * the loop. Used to catch infinite or skipped loops.
245
- * @type {boolean|undefined}
246
- */
247
- this.test = void 0;
248
-
249
- /**
250
- * The segments representing the test condition where `continue` will
251
- * jump to. The test condition will typically have just one segment but
252
- * it's possible for there to be more than one.
253
- * @type {Array<CodePathSegment>|null}
254
- */
255
- this.continueDestSegments = null;
256
- }
222
+ /**
223
+ * Creates a new instance.
224
+ * @param {LoopContext|null} upperContext The previous `LoopContext`.
225
+ * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
226
+ * @param {BreakContext} breakContext The context for breaking the loop.
227
+ */
228
+ constructor(upperContext, label, breakContext) {
229
+ super(upperContext, "WhileStatement", label, breakContext);
230
+
231
+ /**
232
+ * The hardcoded literal boolean test condition for
233
+ * the loop. Used to catch infinite or skipped loops.
234
+ * @type {boolean|undefined}
235
+ */
236
+ this.test = void 0;
237
+
238
+ /**
239
+ * The segments representing the test condition where `continue` will
240
+ * jump to. The test condition will typically have just one segment but
241
+ * it's possible for there to be more than one.
242
+ * @type {Array<CodePathSegment>|null}
243
+ */
244
+ this.continueDestSegments = null;
245
+ }
257
246
  }
258
247
 
259
248
  /**
260
249
  * Represents the context for a `do-while` loop.
261
250
  */
262
251
  class DoWhileLoopContext extends LoopContextBase {
263
-
264
- /**
265
- * Creates a new instance.
266
- * @param {LoopContext|null} upperContext The previous `LoopContext`.
267
- * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
268
- * @param {BreakContext} breakContext The context for breaking the loop.
269
- * @param {ForkContext} forkContext The enclosing fork context.
270
- */
271
- constructor(upperContext, label, breakContext, forkContext) {
272
- super(upperContext, "DoWhileStatement", label, breakContext);
273
-
274
- /**
275
- * The hardcoded literal boolean test condition for
276
- * the loop. Used to catch infinite or skipped loops.
277
- * @type {boolean|undefined}
278
- */
279
- this.test = void 0;
280
-
281
- /**
282
- * The segments at the start of the loop body. This is the only loop
283
- * where the test comes at the end, so the first iteration always
284
- * happens and we need a reference to the first statements.
285
- * @type {Array<CodePathSegment>|null}
286
- */
287
- this.entrySegments = null;
288
-
289
- /**
290
- * The fork context to follow when a `continue` is found.
291
- * @type {ForkContext}
292
- */
293
- this.continueForkContext = ForkContext.newEmpty(forkContext);
294
- }
252
+ /**
253
+ * Creates a new instance.
254
+ * @param {LoopContext|null} upperContext The previous `LoopContext`.
255
+ * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
256
+ * @param {BreakContext} breakContext The context for breaking the loop.
257
+ * @param {ForkContext} forkContext The enclosing fork context.
258
+ */
259
+ constructor(upperContext, label, breakContext, forkContext) {
260
+ super(upperContext, "DoWhileStatement", label, breakContext);
261
+
262
+ /**
263
+ * The hardcoded literal boolean test condition for
264
+ * the loop. Used to catch infinite or skipped loops.
265
+ * @type {boolean|undefined}
266
+ */
267
+ this.test = void 0;
268
+
269
+ /**
270
+ * The segments at the start of the loop body. This is the only loop
271
+ * where the test comes at the end, so the first iteration always
272
+ * happens and we need a reference to the first statements.
273
+ * @type {Array<CodePathSegment>|null}
274
+ */
275
+ this.entrySegments = null;
276
+
277
+ /**
278
+ * The fork context to follow when a `continue` is found.
279
+ * @type {ForkContext}
280
+ */
281
+ this.continueForkContext = ForkContext.newEmpty(forkContext);
282
+ }
295
283
  }
296
284
 
297
285
  /**
298
286
  * Represents the context for a `for` loop.
299
287
  */
300
288
  class ForLoopContext extends LoopContextBase {
301
-
302
- /**
303
- * Creates a new instance.
304
- * @param {LoopContext|null} upperContext The previous `LoopContext`.
305
- * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
306
- * @param {BreakContext} breakContext The context for breaking the loop.
307
- */
308
- constructor(upperContext, label, breakContext) {
309
- super(upperContext, "ForStatement", label, breakContext);
310
-
311
- /**
312
- * The hardcoded literal boolean test condition for
313
- * the loop. Used to catch infinite or skipped loops.
314
- * @type {boolean|undefined}
315
- */
316
- this.test = void 0;
317
-
318
- /**
319
- * The end of the init expression. This may change during the lifetime
320
- * of the instance as we traverse the loop because some loops don't have
321
- * an init expression.
322
- * @type {Array<CodePathSegment>|null}
323
- */
324
- this.endOfInitSegments = null;
325
-
326
- /**
327
- * The start of the test expression. This may change during the lifetime
328
- * of the instance as we traverse the loop because some loops don't have
329
- * a test expression.
330
- * @type {Array<CodePathSegment>|null}
331
- */
332
- this.testSegments = null;
333
-
334
- /**
335
- * The end of the test expression. This may change during the lifetime
336
- * of the instance as we traverse the loop because some loops don't have
337
- * a test expression.
338
- * @type {Array<CodePathSegment>|null}
339
- */
340
- this.endOfTestSegments = null;
341
-
342
- /**
343
- * The start of the update expression. This may change during the lifetime
344
- * of the instance as we traverse the loop because some loops don't have
345
- * an update expression.
346
- * @type {Array<CodePathSegment>|null}
347
- */
348
- this.updateSegments = null;
349
-
350
- /**
351
- * The end of the update expresion. This may change during the lifetime
352
- * of the instance as we traverse the loop because some loops don't have
353
- * an update expression.
354
- * @type {Array<CodePathSegment>|null}
355
- */
356
- this.endOfUpdateSegments = null;
357
-
358
- /**
359
- * The segments representing the test condition where `continue` will
360
- * jump to. The test condition will typically have just one segment but
361
- * it's possible for there to be more than one. This may change during the
362
- * lifetime of the instance as we traverse the loop because some loops
363
- * don't have an update expression. When there is an update expression, this
364
- * will end up pointing to that expression; otherwise it will end up pointing
365
- * to the test expression.
366
- * @type {Array<CodePathSegment>|null}
367
- */
368
- this.continueDestSegments = null;
369
- }
289
+ /**
290
+ * Creates a new instance.
291
+ * @param {LoopContext|null} upperContext The previous `LoopContext`.
292
+ * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
293
+ * @param {BreakContext} breakContext The context for breaking the loop.
294
+ */
295
+ constructor(upperContext, label, breakContext) {
296
+ super(upperContext, "ForStatement", label, breakContext);
297
+
298
+ /**
299
+ * The hardcoded literal boolean test condition for
300
+ * the loop. Used to catch infinite or skipped loops.
301
+ * @type {boolean|undefined}
302
+ */
303
+ this.test = void 0;
304
+
305
+ /**
306
+ * The end of the init expression. This may change during the lifetime
307
+ * of the instance as we traverse the loop because some loops don't have
308
+ * an init expression.
309
+ * @type {Array<CodePathSegment>|null}
310
+ */
311
+ this.endOfInitSegments = null;
312
+
313
+ /**
314
+ * The start of the test expression. This may change during the lifetime
315
+ * of the instance as we traverse the loop because some loops don't have
316
+ * a test expression.
317
+ * @type {Array<CodePathSegment>|null}
318
+ */
319
+ this.testSegments = null;
320
+
321
+ /**
322
+ * The end of the test expression. This may change during the lifetime
323
+ * of the instance as we traverse the loop because some loops don't have
324
+ * a test expression.
325
+ * @type {Array<CodePathSegment>|null}
326
+ */
327
+ this.endOfTestSegments = null;
328
+
329
+ /**
330
+ * The start of the update expression. This may change during the lifetime
331
+ * of the instance as we traverse the loop because some loops don't have
332
+ * an update expression.
333
+ * @type {Array<CodePathSegment>|null}
334
+ */
335
+ this.updateSegments = null;
336
+
337
+ /**
338
+ * The end of the update expresion. This may change during the lifetime
339
+ * of the instance as we traverse the loop because some loops don't have
340
+ * an update expression.
341
+ * @type {Array<CodePathSegment>|null}
342
+ */
343
+ this.endOfUpdateSegments = null;
344
+
345
+ /**
346
+ * The segments representing the test condition where `continue` will
347
+ * jump to. The test condition will typically have just one segment but
348
+ * it's possible for there to be more than one. This may change during the
349
+ * lifetime of the instance as we traverse the loop because some loops
350
+ * don't have an update expression. When there is an update expression, this
351
+ * will end up pointing to that expression; otherwise it will end up pointing
352
+ * to the test expression.
353
+ * @type {Array<CodePathSegment>|null}
354
+ */
355
+ this.continueDestSegments = null;
356
+ }
370
357
  }
371
358
 
372
359
  /**
@@ -379,114 +366,112 @@ class ForLoopContext extends LoopContextBase {
379
366
  * example, in `for (var x in y)`, the right is `y`.
380
367
  */
381
368
  class ForInLoopContext extends LoopContextBase {
382
-
383
- /**
384
- * Creates a new instance.
385
- * @param {LoopContext|null} upperContext The previous `LoopContext`.
386
- * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
387
- * @param {BreakContext} breakContext The context for breaking the loop.
388
- */
389
- constructor(upperContext, label, breakContext) {
390
- super(upperContext, "ForInStatement", label, breakContext);
391
-
392
- /**
393
- * The segments that came immediately before the start of the loop.
394
- * This allows you to traverse backwards out of the loop into the
395
- * surrounding code. This is necessary to evaluate the right expression
396
- * correctly, as it must be evaluated in the same way as the left
397
- * expression, but the pointer to these segments would otherwise be
398
- * lost if not stored on the instance. Once the right expression has
399
- * been evaluated, this property is no longer used.
400
- * @type {Array<CodePathSegment>|null}
401
- */
402
- this.prevSegments = null;
403
-
404
- /**
405
- * Segments representing the start of everything to the left of the
406
- * `in` keyword. This can be used to move forward towards
407
- * `endOfLeftSegments`. `leftSegments` and `endOfLeftSegments` are
408
- * effectively the head and tail of a doubly-linked list.
409
- * @type {Array<CodePathSegment>|null}
410
- */
411
- this.leftSegments = null;
412
-
413
- /**
414
- * Segments representing the end of everything to the left of the
415
- * `in` keyword. This can be used to move backward towards `leftSegments`.
416
- * `leftSegments` and `endOfLeftSegments` are effectively the head
417
- * and tail of a doubly-linked list.
418
- * @type {Array<CodePathSegment>|null}
419
- */
420
- this.endOfLeftSegments = null;
421
-
422
- /**
423
- * The segments representing the left expression where `continue` will
424
- * jump to. In `for-in` loops, `continue` must always re-execute the
425
- * left expression each time through the loop. This contains the same
426
- * segments as `leftSegments`, but is duplicated here so each loop
427
- * context has the same property pointing to where `continue` should
428
- * end up.
429
- * @type {Array<CodePathSegment>|null}
430
- */
431
- this.continueDestSegments = null;
432
- }
369
+ /**
370
+ * Creates a new instance.
371
+ * @param {LoopContext|null} upperContext The previous `LoopContext`.
372
+ * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
373
+ * @param {BreakContext} breakContext The context for breaking the loop.
374
+ */
375
+ constructor(upperContext, label, breakContext) {
376
+ super(upperContext, "ForInStatement", label, breakContext);
377
+
378
+ /**
379
+ * The segments that came immediately before the start of the loop.
380
+ * This allows you to traverse backwards out of the loop into the
381
+ * surrounding code. This is necessary to evaluate the right expression
382
+ * correctly, as it must be evaluated in the same way as the left
383
+ * expression, but the pointer to these segments would otherwise be
384
+ * lost if not stored on the instance. Once the right expression has
385
+ * been evaluated, this property is no longer used.
386
+ * @type {Array<CodePathSegment>|null}
387
+ */
388
+ this.prevSegments = null;
389
+
390
+ /**
391
+ * Segments representing the start of everything to the left of the
392
+ * `in` keyword. This can be used to move forward towards
393
+ * `endOfLeftSegments`. `leftSegments` and `endOfLeftSegments` are
394
+ * effectively the head and tail of a doubly-linked list.
395
+ * @type {Array<CodePathSegment>|null}
396
+ */
397
+ this.leftSegments = null;
398
+
399
+ /**
400
+ * Segments representing the end of everything to the left of the
401
+ * `in` keyword. This can be used to move backward towards `leftSegments`.
402
+ * `leftSegments` and `endOfLeftSegments` are effectively the head
403
+ * and tail of a doubly-linked list.
404
+ * @type {Array<CodePathSegment>|null}
405
+ */
406
+ this.endOfLeftSegments = null;
407
+
408
+ /**
409
+ * The segments representing the left expression where `continue` will
410
+ * jump to. In `for-in` loops, `continue` must always re-execute the
411
+ * left expression each time through the loop. This contains the same
412
+ * segments as `leftSegments`, but is duplicated here so each loop
413
+ * context has the same property pointing to where `continue` should
414
+ * end up.
415
+ * @type {Array<CodePathSegment>|null}
416
+ */
417
+ this.continueDestSegments = null;
418
+ }
433
419
  }
434
420
 
435
421
  /**
436
422
  * Represents the context for a `for-of` loop.
437
423
  */
438
424
  class ForOfLoopContext extends LoopContextBase {
439
-
440
- /**
441
- * Creates a new instance.
442
- * @param {LoopContext|null} upperContext The previous `LoopContext`.
443
- * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
444
- * @param {BreakContext} breakContext The context for breaking the loop.
445
- */
446
- constructor(upperContext, label, breakContext) {
447
- super(upperContext, "ForOfStatement", label, breakContext);
448
-
449
- /**
450
- * The segments that came immediately before the start of the loop.
451
- * This allows you to traverse backwards out of the loop into the
452
- * surrounding code. This is necessary to evaluate the right expression
453
- * correctly, as it must be evaluated in the same way as the left
454
- * expression, but the pointer to these segments would otherwise be
455
- * lost if not stored on the instance. Once the right expression has
456
- * been evaluated, this property is no longer used.
457
- * @type {Array<CodePathSegment>|null}
458
- */
459
- this.prevSegments = null;
460
-
461
- /**
462
- * Segments representing the start of everything to the left of the
463
- * `of` keyword. This can be used to move forward towards
464
- * `endOfLeftSegments`. `leftSegments` and `endOfLeftSegments` are
465
- * effectively the head and tail of a doubly-linked list.
466
- * @type {Array<CodePathSegment>|null}
467
- */
468
- this.leftSegments = null;
469
-
470
- /**
471
- * Segments representing the end of everything to the left of the
472
- * `of` keyword. This can be used to move backward towards `leftSegments`.
473
- * `leftSegments` and `endOfLeftSegments` are effectively the head
474
- * and tail of a doubly-linked list.
475
- * @type {Array<CodePathSegment>|null}
476
- */
477
- this.endOfLeftSegments = null;
478
-
479
- /**
480
- * The segments representing the left expression where `continue` will
481
- * jump to. In `for-in` loops, `continue` must always re-execute the
482
- * left expression each time through the loop. This contains the same
483
- * segments as `leftSegments`, but is duplicated here so each loop
484
- * context has the same property pointing to where `continue` should
485
- * end up.
486
- * @type {Array<CodePathSegment>|null}
487
- */
488
- this.continueDestSegments = null;
489
- }
425
+ /**
426
+ * Creates a new instance.
427
+ * @param {LoopContext|null} upperContext The previous `LoopContext`.
428
+ * @param {string|null} label The label for the loop from an enclosing `LabeledStatement`.
429
+ * @param {BreakContext} breakContext The context for breaking the loop.
430
+ */
431
+ constructor(upperContext, label, breakContext) {
432
+ super(upperContext, "ForOfStatement", label, breakContext);
433
+
434
+ /**
435
+ * The segments that came immediately before the start of the loop.
436
+ * This allows you to traverse backwards out of the loop into the
437
+ * surrounding code. This is necessary to evaluate the right expression
438
+ * correctly, as it must be evaluated in the same way as the left
439
+ * expression, but the pointer to these segments would otherwise be
440
+ * lost if not stored on the instance. Once the right expression has
441
+ * been evaluated, this property is no longer used.
442
+ * @type {Array<CodePathSegment>|null}
443
+ */
444
+ this.prevSegments = null;
445
+
446
+ /**
447
+ * Segments representing the start of everything to the left of the
448
+ * `of` keyword. This can be used to move forward towards
449
+ * `endOfLeftSegments`. `leftSegments` and `endOfLeftSegments` are
450
+ * effectively the head and tail of a doubly-linked list.
451
+ * @type {Array<CodePathSegment>|null}
452
+ */
453
+ this.leftSegments = null;
454
+
455
+ /**
456
+ * Segments representing the end of everything to the left of the
457
+ * `of` keyword. This can be used to move backward towards `leftSegments`.
458
+ * `leftSegments` and `endOfLeftSegments` are effectively the head
459
+ * and tail of a doubly-linked list.
460
+ * @type {Array<CodePathSegment>|null}
461
+ */
462
+ this.endOfLeftSegments = null;
463
+
464
+ /**
465
+ * The segments representing the left expression where `continue` will
466
+ * jump to. In `for-in` loops, `continue` must always re-execute the
467
+ * left expression each time through the loop. This contains the same
468
+ * segments as `leftSegments`, but is duplicated here so each loop
469
+ * context has the same property pointing to where `continue` should
470
+ * end up.
471
+ * @type {Array<CodePathSegment>|null}
472
+ */
473
+ this.continueDestSegments = null;
474
+ }
490
475
  }
491
476
 
492
477
  /**
@@ -498,127 +483,123 @@ class ForOfLoopContext extends LoopContextBase {
498
483
  * Represents the context for a `switch` statement.
499
484
  */
500
485
  class SwitchContext {
501
-
502
- /**
503
- * Creates a new instance.
504
- * @param {SwitchContext} upperContext The previous context.
505
- * @param {boolean} hasCase Indicates if there is at least one `case` statement.
506
- * `default` doesn't count.
507
- */
508
- constructor(upperContext, hasCase) {
509
-
510
- /**
511
- * The previous context.
512
- * @type {SwitchContext}
513
- */
514
- this.upper = upperContext;
515
-
516
- /**
517
- * Indicates if there is at least one `case` statement. `default` doesn't count.
518
- * @type {boolean}
519
- */
520
- this.hasCase = hasCase;
521
-
522
- /**
523
- * The `default` keyword.
524
- * @type {Array<CodePathSegment>|null}
525
- */
526
- this.defaultSegments = null;
527
-
528
- /**
529
- * The default case body starting segments.
530
- * @type {Array<CodePathSegment>|null}
531
- */
532
- this.defaultBodySegments = null;
533
-
534
- /**
535
- * Indicates if a `default` case and is empty exists.
536
- * @type {boolean}
537
- */
538
- this.foundEmptyDefault = false;
539
-
540
- /**
541
- * Indicates that a `default` exists and is the last case.
542
- * @type {boolean}
543
- */
544
- this.lastIsDefault = false;
545
-
546
- /**
547
- * The number of fork contexts created. This is equivalent to the
548
- * number of `case` statements plus a `default` statement (if present).
549
- * @type {number}
550
- */
551
- this.forkCount = 0;
552
- }
486
+ /**
487
+ * Creates a new instance.
488
+ * @param {SwitchContext} upperContext The previous context.
489
+ * @param {boolean} hasCase Indicates if there is at least one `case` statement.
490
+ * `default` doesn't count.
491
+ */
492
+ constructor(upperContext, hasCase) {
493
+ /**
494
+ * The previous context.
495
+ * @type {SwitchContext}
496
+ */
497
+ this.upper = upperContext;
498
+
499
+ /**
500
+ * Indicates if there is at least one `case` statement. `default` doesn't count.
501
+ * @type {boolean}
502
+ */
503
+ this.hasCase = hasCase;
504
+
505
+ /**
506
+ * The `default` keyword.
507
+ * @type {Array<CodePathSegment>|null}
508
+ */
509
+ this.defaultSegments = null;
510
+
511
+ /**
512
+ * The default case body starting segments.
513
+ * @type {Array<CodePathSegment>|null}
514
+ */
515
+ this.defaultBodySegments = null;
516
+
517
+ /**
518
+ * Indicates if a `default` case and is empty exists.
519
+ * @type {boolean}
520
+ */
521
+ this.foundEmptyDefault = false;
522
+
523
+ /**
524
+ * Indicates that a `default` exists and is the last case.
525
+ * @type {boolean}
526
+ */
527
+ this.lastIsDefault = false;
528
+
529
+ /**
530
+ * The number of fork contexts created. This is equivalent to the
531
+ * number of `case` statements plus a `default` statement (if present).
532
+ * @type {number}
533
+ */
534
+ this.forkCount = 0;
535
+ }
553
536
  }
554
537
 
555
538
  /**
556
539
  * Represents the context for a `try` statement.
557
540
  */
558
541
  class TryContext {
559
-
560
- /**
561
- * Creates a new instance.
562
- * @param {TryContext} upperContext The previous context.
563
- * @param {boolean} hasFinalizer Indicates if the `try` statement has a
564
- * `finally` block.
565
- * @param {ForkContext} forkContext The enclosing fork context.
566
- */
567
- constructor(upperContext, hasFinalizer, forkContext) {
568
-
569
- /**
570
- * The previous context.
571
- * @type {TryContext}
572
- */
573
- this.upper = upperContext;
574
-
575
- /**
576
- * Indicates if the `try` statement has a `finally` block.
577
- * @type {boolean}
578
- */
579
- this.hasFinalizer = hasFinalizer;
580
-
581
- /**
582
- * Tracks the traversal position inside of the `try` statement. This is
583
- * used to help determine the context necessary to create paths because
584
- * a `try` statement may or may not have `catch` or `finally` blocks,
585
- * and code paths behave differently in those blocks.
586
- * @type {"try"|"catch"|"finally"}
587
- */
588
- this.position = "try";
589
-
590
- /**
591
- * If the `try` statement has a `finally` block, this affects how a
592
- * `return` statement behaves in the `try` block. Without `finally`,
593
- * `return` behaves as usual and doesn't require a fork; with `finally`,
594
- * `return` forks into the `finally` block, so we need a fork context
595
- * to track it.
596
- * @type {ForkContext|null}
597
- */
598
- this.returnedForkContext = hasFinalizer
599
- ? ForkContext.newEmpty(forkContext)
600
- : null;
601
-
602
- /**
603
- * When a `throw` occurs inside of a `try` block, the code path forks
604
- * into the `catch` or `finally` blocks, and this fork context tracks
605
- * that path.
606
- * @type {ForkContext}
607
- */
608
- this.thrownForkContext = ForkContext.newEmpty(forkContext);
609
-
610
- /**
611
- * Indicates if the last segment in the `try` block is reachable.
612
- * @type {boolean}
613
- */
614
- this.lastOfTryIsReachable = false;
615
-
616
- /**
617
- * Indicates if the last segment in the `catch` block is reachable.
618
- * @type {boolean}
619
- */
620
- this.lastOfCatchIsReachable = false;
621
- }
542
+ /**
543
+ * Creates a new instance.
544
+ * @param {TryContext} upperContext The previous context.
545
+ * @param {boolean} hasFinalizer Indicates if the `try` statement has a
546
+ * `finally` block.
547
+ * @param {ForkContext} forkContext The enclosing fork context.
548
+ */
549
+ constructor(upperContext, hasFinalizer, forkContext) {
550
+ /**
551
+ * The previous context.
552
+ * @type {TryContext}
553
+ */
554
+ this.upper = upperContext;
555
+
556
+ /**
557
+ * Indicates if the `try` statement has a `finally` block.
558
+ * @type {boolean}
559
+ */
560
+ this.hasFinalizer = hasFinalizer;
561
+
562
+ /**
563
+ * Tracks the traversal position inside of the `try` statement. This is
564
+ * used to help determine the context necessary to create paths because
565
+ * a `try` statement may or may not have `catch` or `finally` blocks,
566
+ * and code paths behave differently in those blocks.
567
+ * @type {"try"|"catch"|"finally"}
568
+ */
569
+ this.position = "try";
570
+
571
+ /**
572
+ * If the `try` statement has a `finally` block, this affects how a
573
+ * `return` statement behaves in the `try` block. Without `finally`,
574
+ * `return` behaves as usual and doesn't require a fork; with `finally`,
575
+ * `return` forks into the `finally` block, so we need a fork context
576
+ * to track it.
577
+ * @type {ForkContext|null}
578
+ */
579
+ this.returnedForkContext = hasFinalizer
580
+ ? ForkContext.newEmpty(forkContext)
581
+ : null;
582
+
583
+ /**
584
+ * When a `throw` occurs inside of a `try` block, the code path forks
585
+ * into the `catch` or `finally` blocks, and this fork context tracks
586
+ * that path.
587
+ * @type {ForkContext}
588
+ */
589
+ this.thrownForkContext = ForkContext.newEmpty(forkContext);
590
+
591
+ /**
592
+ * Indicates if the last segment in the `try` block is reachable.
593
+ * @type {boolean}
594
+ */
595
+ this.lastOfTryIsReachable = false;
596
+
597
+ /**
598
+ * Indicates if the last segment in the `catch` block is reachable.
599
+ * @type {boolean}
600
+ */
601
+ this.lastOfCatchIsReachable = false;
602
+ }
622
603
  }
623
604
 
624
605
  //------------------------------------------------------------------------------
@@ -638,14 +619,14 @@ class TryContext {
638
619
  * @returns {void}
639
620
  */
640
621
  function addToReturnedOrThrown(dest, others, all, segments) {
641
- for (let i = 0; i < segments.length; ++i) {
642
- const segment = segments[i];
643
-
644
- dest.push(segment);
645
- if (!others.includes(segment)) {
646
- all.push(segment);
647
- }
648
- }
622
+ for (let i = 0; i < segments.length; ++i) {
623
+ const segment = segments[i];
624
+
625
+ dest.push(segment);
626
+ if (!others.includes(segment)) {
627
+ all.push(segment);
628
+ }
629
+ }
649
630
  }
650
631
 
651
632
  /**
@@ -655,21 +636,21 @@ function addToReturnedOrThrown(dest, others, all, segments) {
655
636
  * @returns {LoopContext} A loop-context for a `continue` statement.
656
637
  */
657
638
  function getContinueContext(state, label) {
658
- if (!label) {
659
- return state.loopContext;
660
- }
639
+ if (!label) {
640
+ return state.loopContext;
641
+ }
661
642
 
662
- let context = state.loopContext;
643
+ let context = state.loopContext;
663
644
 
664
- while (context) {
665
- if (context.label === label) {
666
- return context;
667
- }
668
- context = context.upper;
669
- }
645
+ while (context) {
646
+ if (context.label === label) {
647
+ return context;
648
+ }
649
+ context = context.upper;
650
+ }
670
651
 
671
- /* c8 ignore next */
672
- return null;
652
+ /* c8 ignore next */
653
+ return null;
673
654
  }
674
655
 
675
656
  /**
@@ -679,17 +660,17 @@ function getContinueContext(state, label) {
679
660
  * @returns {BreakContext} A context for a `break` statement.
680
661
  */
681
662
  function getBreakContext(state, label) {
682
- let context = state.breakContext;
663
+ let context = state.breakContext;
683
664
 
684
- while (context) {
685
- if (label ? context.label === label : context.breakable) {
686
- return context;
687
- }
688
- context = context.upper;
689
- }
665
+ while (context) {
666
+ if (label ? context.label === label : context.breakable) {
667
+ return context;
668
+ }
669
+ context = context.upper;
670
+ }
690
671
 
691
- /* c8 ignore next */
692
- return null;
672
+ /* c8 ignore next */
673
+ return null;
693
674
  }
694
675
 
695
676
  /**
@@ -700,16 +681,16 @@ function getBreakContext(state, label) {
700
681
  * @returns {TryContext|CodePathState} A context for a `return` statement.
701
682
  */
702
683
  function getReturnContext(state) {
703
- let context = state.tryContext;
684
+ let context = state.tryContext;
704
685
 
705
- while (context) {
706
- if (context.hasFinalizer && context.position !== "finally") {
707
- return context;
708
- }
709
- context = context.upper;
710
- }
686
+ while (context) {
687
+ if (context.hasFinalizer && context.position !== "finally") {
688
+ return context;
689
+ }
690
+ context = context.upper;
691
+ }
711
692
 
712
- return state;
693
+ return state;
713
694
  }
714
695
 
715
696
  /**
@@ -721,18 +702,19 @@ function getReturnContext(state) {
721
702
  * @returns {TryContext|CodePathState} A context for a `throw` statement.
722
703
  */
723
704
  function getThrowContext(state) {
724
- let context = state.tryContext;
725
-
726
- while (context) {
727
- if (context.position === "try" ||
728
- (context.hasFinalizer && context.position === "catch")
729
- ) {
730
- return context;
731
- }
732
- context = context.upper;
733
- }
734
-
735
- return state;
705
+ let context = state.tryContext;
706
+
707
+ while (context) {
708
+ if (
709
+ context.position === "try" ||
710
+ (context.hasFinalizer && context.position === "catch")
711
+ ) {
712
+ return context;
713
+ }
714
+ context = context.upper;
715
+ }
716
+
717
+ return state;
736
718
  }
737
719
 
738
720
  /**
@@ -742,7 +724,7 @@ function getThrowContext(state) {
742
724
  * @returns {void}
743
725
  */
744
726
  function removeFromArray(elements, value) {
745
- elements.splice(elements.indexOf(value), 1);
727
+ elements.splice(elements.indexOf(value), 1);
746
728
  }
747
729
 
748
730
  /**
@@ -756,15 +738,15 @@ function removeFromArray(elements, value) {
756
738
  * @returns {void}
757
739
  */
758
740
  function disconnectSegments(prevSegments, nextSegments) {
759
- for (let i = 0; i < prevSegments.length; ++i) {
760
- const prevSegment = prevSegments[i];
761
- const nextSegment = nextSegments[i];
762
-
763
- removeFromArray(prevSegment.nextSegments, nextSegment);
764
- removeFromArray(prevSegment.allNextSegments, nextSegment);
765
- removeFromArray(nextSegment.prevSegments, prevSegment);
766
- removeFromArray(nextSegment.allPrevSegments, prevSegment);
767
- }
741
+ for (let i = 0; i < prevSegments.length; ++i) {
742
+ const prevSegment = prevSegments[i];
743
+ const nextSegment = nextSegments[i];
744
+
745
+ removeFromArray(prevSegment.nextSegments, nextSegment);
746
+ removeFromArray(prevSegment.allNextSegments, nextSegment);
747
+ removeFromArray(nextSegment.prevSegments, prevSegment);
748
+ removeFromArray(nextSegment.allPrevSegments, prevSegment);
749
+ }
768
750
  }
769
751
 
770
752
  /**
@@ -776,58 +758,60 @@ function disconnectSegments(prevSegments, nextSegments) {
776
758
  * @returns {void}
777
759
  */
778
760
  function makeLooped(state, unflattenedFromSegments, unflattenedToSegments) {
779
-
780
- const fromSegments = CodePathSegment.flattenUnusedSegments(unflattenedFromSegments);
781
- const toSegments = CodePathSegment.flattenUnusedSegments(unflattenedToSegments);
782
- const end = Math.min(fromSegments.length, toSegments.length);
783
-
784
- /*
785
- * This loop effectively updates a doubly-linked list between two collections
786
- * of segments making sure that segments in the same array indices are
787
- * combined to create a path.
788
- */
789
- for (let i = 0; i < end; ++i) {
790
-
791
- // get the segments in matching array indices
792
- const fromSegment = fromSegments[i];
793
- const toSegment = toSegments[i];
794
-
795
- /*
796
- * If the destination segment is reachable, then create a path from the
797
- * source segment to the destination segment.
798
- */
799
- if (toSegment.reachable) {
800
- fromSegment.nextSegments.push(toSegment);
801
- }
802
-
803
- /*
804
- * If the source segment is reachable, then create a path from the
805
- * destination segment back to the source segment.
806
- */
807
- if (fromSegment.reachable) {
808
- toSegment.prevSegments.push(fromSegment);
809
- }
810
-
811
- /*
812
- * Also update the arrays that don't care if the segments are reachable
813
- * or not. This should always happen regardless of anything else.
814
- */
815
- fromSegment.allNextSegments.push(toSegment);
816
- toSegment.allPrevSegments.push(fromSegment);
817
-
818
- /*
819
- * If the destination segment has at least two previous segments in its
820
- * path then that means there was one previous segment before this iteration
821
- * of the loop was executed. So, we need to mark the source segment as
822
- * looped.
823
- */
824
- if (toSegment.allPrevSegments.length >= 2) {
825
- CodePathSegment.markPrevSegmentAsLooped(toSegment, fromSegment);
826
- }
827
-
828
- // let the code path analyzer know that there's been a loop created
829
- state.notifyLooped(fromSegment, toSegment);
830
- }
761
+ const fromSegments = CodePathSegment.flattenUnusedSegments(
762
+ unflattenedFromSegments,
763
+ );
764
+ const toSegments = CodePathSegment.flattenUnusedSegments(
765
+ unflattenedToSegments,
766
+ );
767
+ const end = Math.min(fromSegments.length, toSegments.length);
768
+
769
+ /*
770
+ * This loop effectively updates a doubly-linked list between two collections
771
+ * of segments making sure that segments in the same array indices are
772
+ * combined to create a path.
773
+ */
774
+ for (let i = 0; i < end; ++i) {
775
+ // get the segments in matching array indices
776
+ const fromSegment = fromSegments[i];
777
+ const toSegment = toSegments[i];
778
+
779
+ /*
780
+ * If the destination segment is reachable, then create a path from the
781
+ * source segment to the destination segment.
782
+ */
783
+ if (toSegment.reachable) {
784
+ fromSegment.nextSegments.push(toSegment);
785
+ }
786
+
787
+ /*
788
+ * If the source segment is reachable, then create a path from the
789
+ * destination segment back to the source segment.
790
+ */
791
+ if (fromSegment.reachable) {
792
+ toSegment.prevSegments.push(fromSegment);
793
+ }
794
+
795
+ /*
796
+ * Also update the arrays that don't care if the segments are reachable
797
+ * or not. This should always happen regardless of anything else.
798
+ */
799
+ fromSegment.allNextSegments.push(toSegment);
800
+ toSegment.allPrevSegments.push(fromSegment);
801
+
802
+ /*
803
+ * If the destination segment has at least two previous segments in its
804
+ * path then that means there was one previous segment before this iteration
805
+ * of the loop was executed. So, we need to mark the source segment as
806
+ * looped.
807
+ */
808
+ if (toSegment.allPrevSegments.length >= 2) {
809
+ CodePathSegment.markPrevSegmentAsLooped(toSegment, fromSegment);
810
+ }
811
+
812
+ // let the code path analyzer know that there's been a loop created
813
+ state.notifyLooped(fromSegment, toSegment);
814
+ }
831
815
  }
832
816
 
833
817
  /**
@@ -841,28 +825,27 @@ function makeLooped(state, unflattenedFromSegments, unflattenedToSegments) {
841
825
  * @returns {void}
842
826
  */
843
827
  function finalizeTestSegmentsOfFor(context, choiceContext, head) {
844
-
845
- /*
846
- * If this choice context doesn't already contain paths from a
847
- * child context, then add the current head to each potential path.
848
- */
849
- if (!choiceContext.processed) {
850
- choiceContext.trueForkContext.add(head);
851
- choiceContext.falseForkContext.add(head);
852
- choiceContext.nullishForkContext.add(head);
853
- }
854
-
855
- /*
856
- * If the test condition isn't a hardcoded truthy value, then `break`
857
- * must follow the same path as if the test condition is false. To represent
858
- * that, we append the path for when the loop test is false (represented by
859
- * `falseForkContext`) to the `brokenForkContext`.
860
- */
861
- if (context.test !== true) {
862
- context.brokenForkContext.addAll(choiceContext.falseForkContext);
863
- }
864
-
865
- context.endOfTestSegments = choiceContext.trueForkContext.makeNext(0, -1);
828
+ /*
829
+ * If this choice context doesn't already contain paths from a
830
+ * child context, then add the current head to each potential path.
831
+ */
832
+ if (!choiceContext.processed) {
833
+ choiceContext.trueForkContext.add(head);
834
+ choiceContext.falseForkContext.add(head);
835
+ choiceContext.nullishForkContext.add(head);
836
+ }
837
+
838
+ /*
839
+ * If the test condition isn't a hardcoded truthy value, then `break`
840
+ * must follow the same path as if the test condition is false. To represent
841
+ * that, we append the path for when the loop test is false (represented by
842
+ * `falseForkContext`) to the `brokenForkContext`.
843
+ */
844
+ if (context.test !== true) {
845
+ context.brokenForkContext.addAll(choiceContext.falseForkContext);
846
+ }
847
+
848
+ context.endOfTestSegments = choiceContext.trueForkContext.makeNext(0, -1);
866
849
  }
867
850
 
868
851
  //------------------------------------------------------------------------------
@@ -873,1476 +856,1515 @@ function finalizeTestSegmentsOfFor(context, choiceContext, head) {
873
856
  * A class which manages state to analyze code paths.
874
857
  */
875
858
  class CodePathState {
876
-
877
- /**
878
- * Creates a new instance.
879
- * @param {IdGenerator} idGenerator An id generator to generate id for code
880
- * path segments.
881
- * @param {Function} onLooped A callback function to notify looping.
882
- */
883
- constructor(idGenerator, onLooped) {
884
-
885
- /**
886
- * The ID generator to use when creating new segments.
887
- * @type {IdGenerator}
888
- */
889
- this.idGenerator = idGenerator;
890
-
891
- /**
892
- * A callback function to call when there is a loop.
893
- * @type {Function}
894
- */
895
- this.notifyLooped = onLooped;
896
-
897
- /**
898
- * The root fork context for this state.
899
- * @type {ForkContext}
900
- */
901
- this.forkContext = ForkContext.newRoot(idGenerator);
902
-
903
- /**
904
- * Context for logical expressions, conditional expressions, `if` statements,
905
- * and loops.
906
- * @type {ChoiceContext}
907
- */
908
- this.choiceContext = null;
909
-
910
- /**
911
- * Context for `switch` statements.
912
- * @type {SwitchContext}
913
- */
914
- this.switchContext = null;
915
-
916
- /**
917
- * Context for `try` statements.
918
- * @type {TryContext}
919
- */
920
- this.tryContext = null;
921
-
922
- /**
923
- * Context for loop statements.
924
- * @type {LoopContext}
925
- */
926
- this.loopContext = null;
927
-
928
- /**
929
- * Context for `break` statements.
930
- * @type {BreakContext}
931
- */
932
- this.breakContext = null;
933
-
934
- /**
935
- * Context for `ChainExpression` nodes.
936
- * @type {ChainContext}
937
- */
938
- this.chainContext = null;
939
-
940
- /**
941
- * An array that tracks the current segments in the state. The array
942
- * starts empty and segments are added with each `onCodePathSegmentStart`
943
- * event and removed with each `onCodePathSegmentEnd` event. Effectively,
944
- * this is tracking the code path segment traversal as the state is
945
- * modified.
946
- * @type {Array<CodePathSegment>}
947
- */
948
- this.currentSegments = [];
949
-
950
- /**
951
- * Tracks the starting segment for this path. This value never changes.
952
- * @type {CodePathSegment}
953
- */
954
- this.initialSegment = this.forkContext.head[0];
955
-
956
- /**
957
- * The final segments of the code path which are either `return` or `throw`.
958
- * This is a union of the segments in `returnedForkContext` and `thrownForkContext`.
959
- * @type {Array<CodePathSegment>}
960
- */
961
- this.finalSegments = [];
962
-
963
- /**
964
- * The final segments of the code path which are `return`. These
965
- * segments are also contained in `finalSegments`.
966
- * @type {Array<CodePathSegment>}
967
- */
968
- this.returnedForkContext = [];
969
-
970
- /**
971
- * The final segments of the code path which are `throw`. These
972
- * segments are also contained in `finalSegments`.
973
- * @type {Array<CodePathSegment>}
974
- */
975
- this.thrownForkContext = [];
976
-
977
- /*
978
- * We add an `add` method so that these look more like fork contexts and
979
- * can be used interchangeably when a fork context is needed to add more
980
- * segments to a path.
981
- *
982
- * Ultimately, we want anything added to `returned` or `thrown` to also
983
- * be added to `final`. We only add reachable and used segments to these
984
- * arrays.
985
- */
986
- const final = this.finalSegments;
987
- const returned = this.returnedForkContext;
988
- const thrown = this.thrownForkContext;
989
-
990
- returned.add = addToReturnedOrThrown.bind(null, returned, thrown, final);
991
- thrown.add = addToReturnedOrThrown.bind(null, thrown, returned, final);
992
- }
993
-
994
- /**
995
- * A passthrough property exposing the current pointer as part of the API.
996
- * @type {CodePathSegment[]}
997
- */
998
- get headSegments() {
999
- return this.forkContext.head;
1000
- }
1001
-
1002
- /**
1003
- * The parent forking context.
1004
- * This is used for the root of new forks.
1005
- * @type {ForkContext}
1006
- */
1007
- get parentForkContext() {
1008
- const current = this.forkContext;
1009
-
1010
- return current && current.upper;
1011
- }
1012
-
1013
- /**
1014
- * Creates and stacks new forking context.
1015
- * @param {boolean} forkLeavingPath A flag which shows being in a
1016
- * "finally" block.
1017
- * @returns {ForkContext} The created context.
1018
- */
1019
- pushForkContext(forkLeavingPath) {
1020
- this.forkContext = ForkContext.newEmpty(
1021
- this.forkContext,
1022
- forkLeavingPath
1023
- );
1024
-
1025
- return this.forkContext;
1026
- }
1027
-
1028
- /**
1029
- * Pops and merges the last forking context.
1030
- * @returns {ForkContext} The last context.
1031
- */
1032
- popForkContext() {
1033
- const lastContext = this.forkContext;
1034
-
1035
- this.forkContext = lastContext.upper;
1036
- this.forkContext.replaceHead(lastContext.makeNext(0, -1));
1037
-
1038
- return lastContext;
1039
- }
1040
-
1041
- /**
1042
- * Creates a new path.
1043
- * @returns {void}
1044
- */
1045
- forkPath() {
1046
- this.forkContext.add(this.parentForkContext.makeNext(-1, -1));
1047
- }
1048
-
1049
- /**
1050
- * Creates a bypass path.
1051
- * This is used for such as IfStatement which does not have "else" chunk.
1052
- * @returns {void}
1053
- */
1054
- forkBypassPath() {
1055
- this.forkContext.add(this.parentForkContext.head);
1056
- }
1057
-
1058
- //--------------------------------------------------------------------------
1059
- // ConditionalExpression, LogicalExpression, IfStatement
1060
- //--------------------------------------------------------------------------
1061
-
1062
- /**
1063
- * Creates a context for ConditionalExpression, LogicalExpression, AssignmentExpression (logical assignments only),
1064
- * IfStatement, WhileStatement, DoWhileStatement, or ForStatement.
1065
- *
1066
- * LogicalExpressions have cases that it goes different paths between the
1067
- * `true` case and the `false` case.
1068
- *
1069
- * For Example:
1070
- *
1071
- * if (a || b) {
1072
- * foo();
1073
- * } else {
1074
- * bar();
1075
- * }
1076
- *
1077
- * In this case, `b` is evaluated always in the code path of the `else`
1078
- * block, but it's not so in the code path of the `if` block.
1079
- * So there are 3 paths.
1080
- *
1081
- * a -> foo();
1082
- * a -> b -> foo();
1083
- * a -> b -> bar();
1084
- * @param {string} kind A kind string.
1085
- * If the new context is LogicalExpression's or AssignmentExpression's, this is `"&&"` or `"||"` or `"??"`.
1086
- * If it's IfStatement's or ConditionalExpression's, this is `"test"`.
1087
- * Otherwise, this is `"loop"`.
1088
- * @param {boolean} isForkingAsResult Indicates if the result of the choice
1089
- * creates a fork.
1090
- * @returns {void}
1091
- */
1092
- pushChoiceContext(kind, isForkingAsResult) {
1093
- this.choiceContext = new ChoiceContext(this.choiceContext, kind, isForkingAsResult, this.forkContext);
1094
- }
1095
-
1096
- /**
1097
- * Pops the last choice context and finalizes it.
1098
- * This is called upon leaving a node that represents a choice.
1099
- * @throws {Error} (Unreachable.)
1100
- * @returns {ChoiceContext} The popped context.
1101
- */
1102
- popChoiceContext() {
1103
- const poppedChoiceContext = this.choiceContext;
1104
- const forkContext = this.forkContext;
1105
- const head = forkContext.head;
1106
-
1107
- this.choiceContext = poppedChoiceContext.upper;
1108
-
1109
- switch (poppedChoiceContext.kind) {
1110
- case "&&":
1111
- case "||":
1112
- case "??":
1113
-
1114
- /*
1115
- * The `head` are the path of the right-hand operand.
1116
- * If we haven't previously added segments from child contexts,
1117
- * then we add these segments to all possible forks.
1118
- */
1119
- if (!poppedChoiceContext.processed) {
1120
- poppedChoiceContext.trueForkContext.add(head);
1121
- poppedChoiceContext.falseForkContext.add(head);
1122
- poppedChoiceContext.nullishForkContext.add(head);
1123
- }
1124
-
1125
- /*
1126
- * If this context is the left (test) expression for another choice
1127
- * context, such as `a || b` in the expression `a || b || c`,
1128
- * then we take the segments for this context and move them up
1129
- * to the parent context.
1130
- */
1131
- if (poppedChoiceContext.isForkingAsResult) {
1132
- const parentContext = this.choiceContext;
1133
-
1134
- parentContext.trueForkContext.addAll(poppedChoiceContext.trueForkContext);
1135
- parentContext.falseForkContext.addAll(poppedChoiceContext.falseForkContext);
1136
- parentContext.nullishForkContext.addAll(poppedChoiceContext.nullishForkContext);
1137
- parentContext.processed = true;
1138
-
1139
- // Exit early so we don't collapse all paths into one.
1140
- return poppedChoiceContext;
1141
- }
1142
-
1143
- break;
1144
-
1145
- case "test":
1146
- if (!poppedChoiceContext.processed) {
1147
-
1148
- /*
1149
- * The head segments are the path of the `if` block here.
1150
- * Updates the `true` path with the end of the `if` block.
1151
- */
1152
- poppedChoiceContext.trueForkContext.clear();
1153
- poppedChoiceContext.trueForkContext.add(head);
1154
- } else {
1155
-
1156
- /*
1157
- * The head segments are the path of the `else` block here.
1158
- * Updates the `false` path with the end of the `else`
1159
- * block.
1160
- */
1161
- poppedChoiceContext.falseForkContext.clear();
1162
- poppedChoiceContext.falseForkContext.add(head);
1163
- }
1164
-
1165
- break;
1166
-
1167
- case "loop":
1168
-
1169
- /*
1170
- * Loops are addressed in `popLoopContext()` so just return
1171
- * the context without modification.
1172
- */
1173
- return poppedChoiceContext;
1174
-
1175
- /* c8 ignore next */
1176
- default:
1177
- throw new Error("unreachable");
1178
- }
1179
-
1180
- /*
1181
- * Merge the true path with the false path to create a single path.
1182
- */
1183
- const combinedForkContext = poppedChoiceContext.trueForkContext;
1184
-
1185
- combinedForkContext.addAll(poppedChoiceContext.falseForkContext);
1186
- forkContext.replaceHead(combinedForkContext.makeNext(0, -1));
1187
-
1188
- return poppedChoiceContext;
1189
- }
1190
-
1191
- /**
1192
- * Creates a code path segment to represent right-hand operand of a logical
1193
- * expression.
1194
- * This is called in the preprocessing phase when entering a node.
1195
- * @throws {Error} (Unreachable.)
1196
- * @returns {void}
1197
- */
1198
- makeLogicalRight() {
1199
- const currentChoiceContext = this.choiceContext;
1200
- const forkContext = this.forkContext;
1201
-
1202
- if (currentChoiceContext.processed) {
1203
-
1204
- /*
1205
- * This context was already assigned segments from a child
1206
- * choice context. In this case, we are concerned only about
1207
- * the path that does not short-circuit and so ends up on the
1208
- * right-hand operand of the logical expression.
1209
- */
1210
- let prevForkContext;
1211
-
1212
- switch (currentChoiceContext.kind) {
1213
- case "&&": // if true then go to the right-hand side.
1214
- prevForkContext = currentChoiceContext.trueForkContext;
1215
- break;
1216
- case "||": // if false then go to the right-hand side.
1217
- prevForkContext = currentChoiceContext.falseForkContext;
1218
- break;
1219
- case "??": // Both true/false can short-circuit, so needs the third path to go to the right-hand side. That's nullishForkContext.
1220
- prevForkContext = currentChoiceContext.nullishForkContext;
1221
- break;
1222
- default:
1223
- throw new Error("unreachable");
1224
- }
1225
-
1226
- /*
1227
- * Create the segment for the right-hand operand of the logical expression
1228
- * and adjust the fork context pointer to point there. The right-hand segment
1229
- * is added at the end of all segments in `prevForkContext`.
1230
- */
1231
- forkContext.replaceHead(prevForkContext.makeNext(0, -1));
1232
-
1233
- /*
1234
- * We no longer need this list of segments.
1235
- *
1236
- * Reset `processed` because we've removed the segments from the child
1237
- * choice context. This allows `popChoiceContext()` to continue adding
1238
- * segments later.
1239
- */
1240
- prevForkContext.clear();
1241
- currentChoiceContext.processed = false;
1242
-
1243
- } else {
1244
-
1245
- /*
1246
- * This choice context was not assigned segments from a child
1247
- * choice context, which means that it's a terminal logical
1248
- * expression.
1249
- *
1250
- * `head` is the segments for the left-hand operand of the
1251
- * logical expression.
1252
- *
1253
- * Each of the fork contexts below are empty at this point. We choose
1254
- * the path(s) that will short-circuit and add the segment for the
1255
- * left-hand operand to it. Ultimately, this will be the only segment
1256
- * in that path due to the short-circuting, so we are just seeding
1257
- * these paths to start.
1258
- */
1259
- switch (currentChoiceContext.kind) {
1260
- case "&&":
1261
-
1262
- /*
1263
- * In most contexts, when a && expression evaluates to false,
1264
- * it short circuits, so we need to account for that by setting
1265
- * the `falseForkContext` to the left operand.
1266
- *
1267
- * When a && expression is the left-hand operand for a ??
1268
- * expression, such as `(a && b) ?? c`, a nullish value will
1269
- * also short-circuit in a different way than a false value,
1270
- * so we also set the `nullishForkContext` to the left operand.
1271
- * This path is only used with a ?? expression and is thrown
1272
- * away for any other type of logical expression, so it's safe
1273
- * to always add.
1274
- */
1275
- currentChoiceContext.falseForkContext.add(forkContext.head);
1276
- currentChoiceContext.nullishForkContext.add(forkContext.head);
1277
- break;
1278
- case "||": // the true path can short-circuit.
1279
- currentChoiceContext.trueForkContext.add(forkContext.head);
1280
- break;
1281
- case "??": // both can short-circuit.
1282
- currentChoiceContext.trueForkContext.add(forkContext.head);
1283
- currentChoiceContext.falseForkContext.add(forkContext.head);
1284
- break;
1285
- default:
1286
- throw new Error("unreachable");
1287
- }
1288
-
1289
- /*
1290
- * Create the segment for the right-hand operand of the logical expression
1291
- * and adjust the fork context pointer to point there.
1292
- */
1293
- forkContext.replaceHead(forkContext.makeNext(-1, -1));
1294
- }
1295
- }
1296
-
1297
- /**
1298
- * Makes a code path segment of the `if` block.
1299
- * @returns {void}
1300
- */
1301
- makeIfConsequent() {
1302
- const context = this.choiceContext;
1303
- const forkContext = this.forkContext;
1304
-
1305
- /*
1306
- * If any result were not transferred from child contexts,
1307
- * this sets the head segments to both cases.
1308
- * The head segments are the path of the test expression.
1309
- */
1310
- if (!context.processed) {
1311
- context.trueForkContext.add(forkContext.head);
1312
- context.falseForkContext.add(forkContext.head);
1313
- context.nullishForkContext.add(forkContext.head);
1314
- }
1315
-
1316
- context.processed = false;
1317
-
1318
- // Creates new path from the `true` case.
1319
- forkContext.replaceHead(
1320
- context.trueForkContext.makeNext(0, -1)
1321
- );
1322
- }
1323
-
1324
- /**
1325
- * Makes a code path segment of the `else` block.
1326
- * @returns {void}
1327
- */
1328
- makeIfAlternate() {
1329
- const context = this.choiceContext;
1330
- const forkContext = this.forkContext;
1331
-
1332
- /*
1333
- * The head segments are the path of the `if` block.
1334
- * Updates the `true` path with the end of the `if` block.
1335
- */
1336
- context.trueForkContext.clear();
1337
- context.trueForkContext.add(forkContext.head);
1338
- context.processed = true;
1339
-
1340
- // Creates new path from the `false` case.
1341
- forkContext.replaceHead(
1342
- context.falseForkContext.makeNext(0, -1)
1343
- );
1344
- }
1345
-
1346
- //--------------------------------------------------------------------------
1347
- // ChainExpression
1348
- //--------------------------------------------------------------------------
1349
-
1350
- /**
1351
- * Pushes a new `ChainExpression` context to the stack. This method is
1352
- * called when entering a `ChainExpression` node. A chain context is used to
1353
- * count forking in the optional chain then merge them on the exiting from the
1354
- * `ChainExpression` node.
1355
- * @returns {void}
1356
- */
1357
- pushChainContext() {
1358
- this.chainContext = new ChainContext(this.chainContext);
1359
- }
1360
-
1361
- /**
1362
- * Pop a `ChainExpression` context from the stack. This method is called on
1363
- * exiting from each `ChainExpression` node. This merges all forks of the
1364
- * last optional chaining.
1365
- * @returns {void}
1366
- */
1367
- popChainContext() {
1368
- const context = this.chainContext;
1369
-
1370
- this.chainContext = context.upper;
1371
-
1372
- // pop all choice contexts of this.
1373
- for (let i = context.choiceContextCount; i > 0; --i) {
1374
- this.popChoiceContext();
1375
- }
1376
- }
1377
-
1378
- /**
1379
- * Create a choice context for optional access.
1380
- * This method is called on entering to each `(Call|Member)Expression[optional=true]` node.
1381
- * This creates a choice context as similar to `LogicalExpression[operator="??"]` node.
1382
- * @returns {void}
1383
- */
1384
- makeOptionalNode() {
1385
- if (this.chainContext) {
1386
- this.chainContext.choiceContextCount += 1;
1387
- this.pushChoiceContext("??", false);
1388
- }
1389
- }
1390
-
1391
- /**
1392
- * Create a fork.
1393
- * This method is called on entering to the `arguments|property` property of each `(Call|Member)Expression` node.
1394
- * @returns {void}
1395
- */
1396
- makeOptionalRight() {
1397
- if (this.chainContext) {
1398
- this.makeLogicalRight();
1399
- }
1400
- }
1401
-
1402
- //--------------------------------------------------------------------------
1403
- // SwitchStatement
1404
- //--------------------------------------------------------------------------
1405
-
1406
- /**
1407
- * Creates a context object of SwitchStatement and stacks it.
1408
- * @param {boolean} hasCase `true` if the switch statement has one or more
1409
- * case parts.
1410
- * @param {string|null} label The label text.
1411
- * @returns {void}
1412
- */
1413
- pushSwitchContext(hasCase, label) {
1414
- this.switchContext = new SwitchContext(this.switchContext, hasCase);
1415
- this.pushBreakContext(true, label);
1416
- }
1417
-
1418
- /**
1419
- * Pops the last context of SwitchStatement and finalizes it.
1420
- *
1421
- * - Disposes all forking stack for `case` and `default`.
1422
- * - Creates the next code path segment from `context.brokenForkContext`.
1423
- * - If the last `SwitchCase` node is not a `default` part, creates a path
1424
- * to the `default` body.
1425
- * @returns {void}
1426
- */
1427
- popSwitchContext() {
1428
- const context = this.switchContext;
1429
-
1430
- this.switchContext = context.upper;
1431
-
1432
- const forkContext = this.forkContext;
1433
- const brokenForkContext = this.popBreakContext().brokenForkContext;
1434
-
1435
- if (context.forkCount === 0) {
1436
-
1437
- /*
1438
- * When there is only one `default` chunk and there is one or more
1439
- * `break` statements, even if forks are nothing, it needs to merge
1440
- * those.
1441
- */
1442
- if (!brokenForkContext.empty) {
1443
- brokenForkContext.add(forkContext.makeNext(-1, -1));
1444
- forkContext.replaceHead(brokenForkContext.makeNext(0, -1));
1445
- }
1446
-
1447
- return;
1448
- }
1449
-
1450
- const lastSegments = forkContext.head;
1451
-
1452
- this.forkBypassPath();
1453
- const lastCaseSegments = forkContext.head;
1454
-
1455
- /*
1456
- * `brokenForkContext` is used to make the next segment.
1457
- * It must add the last segment into `brokenForkContext`.
1458
- */
1459
- brokenForkContext.add(lastSegments);
1460
-
1461
- /*
1462
- * Any value that doesn't match a `case` test should flow to the default
1463
- * case. That happens normally when the default case is last in the `switch`,
1464
- * but if it's not, we need to rewire some of the paths to be correct.
1465
- */
1466
- if (!context.lastIsDefault) {
1467
- if (context.defaultBodySegments) {
1468
-
1469
- /*
1470
- * There is a non-empty default case, so remove the path from the `default`
1471
- * label to its body for an accurate representation.
1472
- */
1473
- disconnectSegments(context.defaultSegments, context.defaultBodySegments);
1474
-
1475
- /*
1476
- * Connect the path from the last non-default case to the body of the
1477
- * default case.
1478
- */
1479
- makeLooped(this, lastCaseSegments, context.defaultBodySegments);
1480
-
1481
- } else {
1482
-
1483
- /*
1484
- * There is no default case, so we treat this as if the last case
1485
- * had a `break` in it.
1486
- */
1487
- brokenForkContext.add(lastCaseSegments);
1488
- }
1489
- }
1490
-
1491
- // Traverse up to the original fork context for the `switch` statement
1492
- for (let i = 0; i < context.forkCount; ++i) {
1493
- this.forkContext = this.forkContext.upper;
1494
- }
1495
-
1496
- /*
1497
- * Creates a path from all `brokenForkContext` paths.
1498
- * This is a path after `switch` statement.
1499
- */
1500
- this.forkContext.replaceHead(brokenForkContext.makeNext(0, -1));
1501
- }
1502
-
1503
- /**
1504
- * Makes a code path segment for a `SwitchCase` node.
1505
- * @param {boolean} isCaseBodyEmpty `true` if the body is empty.
1506
- * @param {boolean} isDefaultCase `true` if the body is the default case.
1507
- * @returns {void}
1508
- */
1509
- makeSwitchCaseBody(isCaseBodyEmpty, isDefaultCase) {
1510
- const context = this.switchContext;
1511
-
1512
- if (!context.hasCase) {
1513
- return;
1514
- }
1515
-
1516
- /*
1517
- * Merge forks.
1518
- * The parent fork context has two segments.
1519
- * Those are from the current `case` and the body of the previous case.
1520
- */
1521
- const parentForkContext = this.forkContext;
1522
- const forkContext = this.pushForkContext();
1523
-
1524
- forkContext.add(parentForkContext.makeNext(0, -1));
1525
-
1526
- /*
1527
- * Add information about the default case.
1528
- *
1529
- * The purpose of this is to identify the starting segments for the
1530
- * default case to make sure there is a path there.
1531
- */
1532
- if (isDefaultCase) {
1533
-
1534
- /*
1535
- * This is the default case in the `switch`.
1536
- *
1537
- * We first save the current pointer as `defaultSegments` to point
1538
- * to the `default` keyword.
1539
- */
1540
- context.defaultSegments = parentForkContext.head;
1541
-
1542
- /*
1543
- * If the body of the case is empty then we just set
1544
- * `foundEmptyDefault` to true; otherwise, we save a reference
1545
- * to the current pointer as `defaultBodySegments`.
1546
- */
1547
- if (isCaseBodyEmpty) {
1548
- context.foundEmptyDefault = true;
1549
- } else {
1550
- context.defaultBodySegments = forkContext.head;
1551
- }
1552
-
1553
- } else {
1554
-
1555
- /*
1556
- * This is not the default case in the `switch`.
1557
- *
1558
- * If it's not empty and there is already an empty default case found,
1559
- * that means the default case actually comes before this case,
1560
- * and that it will fall through to this case. So, we can now
1561
- * ignore the previous default case (reset `foundEmptyDefault` to false)
1562
- * and set `defaultBodySegments` to the current segments because this is
1563
- * effectively the new default case.
1564
- */
1565
- if (!isCaseBodyEmpty && context.foundEmptyDefault) {
1566
- context.foundEmptyDefault = false;
1567
- context.defaultBodySegments = forkContext.head;
1568
- }
1569
- }
1570
-
1571
- // keep track if the default case ends up last
1572
- context.lastIsDefault = isDefaultCase;
1573
- context.forkCount += 1;
1574
- }
1575
-
1576
- //--------------------------------------------------------------------------
1577
- // TryStatement
1578
- //--------------------------------------------------------------------------
1579
-
1580
- /**
1581
- * Creates a context object of TryStatement and stacks it.
1582
- * @param {boolean} hasFinalizer `true` if the try statement has a
1583
- * `finally` block.
1584
- * @returns {void}
1585
- */
1586
- pushTryContext(hasFinalizer) {
1587
- this.tryContext = new TryContext(this.tryContext, hasFinalizer, this.forkContext);
1588
- }
1589
-
1590
- /**
1591
- * Pops the last context of TryStatement and finalizes it.
1592
- * @returns {void}
1593
- */
1594
- popTryContext() {
1595
- const context = this.tryContext;
1596
-
1597
- this.tryContext = context.upper;
1598
-
1599
- /*
1600
- * If we're inside the `catch` block, that means there is no `finally`,
1601
- * so we can process the `try` and `catch` blocks the simple way and
1602
- * merge their two paths.
1603
- */
1604
- if (context.position === "catch") {
1605
- this.popForkContext();
1606
- return;
1607
- }
1608
-
1609
- /*
1610
- * The following process is executed only when there is a `finally`
1611
- * block.
1612
- */
1613
-
1614
- const originalReturnedForkContext = context.returnedForkContext;
1615
- const originalThrownForkContext = context.thrownForkContext;
1616
-
1617
- // no `return` or `throw` in `try` or `catch` so there's nothing left to do
1618
- if (originalReturnedForkContext.empty && originalThrownForkContext.empty) {
1619
- return;
1620
- }
1621
-
1622
- /*
1623
- * The following process is executed only when there is a `finally`
1624
- * block and there was a `return` or `throw` in the `try` or `catch`
1625
- * blocks.
1626
- */
1627
-
1628
- // Separate head to normal paths and leaving paths.
1629
- const headSegments = this.forkContext.head;
1630
-
1631
- this.forkContext = this.forkContext.upper;
1632
- const normalSegments = headSegments.slice(0, headSegments.length / 2 | 0);
1633
- const leavingSegments = headSegments.slice(headSegments.length / 2 | 0);
1634
-
1635
- // Forwards the leaving path to upper contexts.
1636
- if (!originalReturnedForkContext.empty) {
1637
- getReturnContext(this).returnedForkContext.add(leavingSegments);
1638
- }
1639
- if (!originalThrownForkContext.empty) {
1640
- getThrowContext(this).thrownForkContext.add(leavingSegments);
1641
- }
1642
-
1643
- // Sets the normal path as the next.
1644
- this.forkContext.replaceHead(normalSegments);
1645
-
1646
- /*
1647
- * If both paths of the `try` block and the `catch` block are
1648
- * unreachable, the next path becomes unreachable as well.
1649
- */
1650
- if (!context.lastOfTryIsReachable && !context.lastOfCatchIsReachable) {
1651
- this.forkContext.makeUnreachable();
1652
- }
1653
- }
1654
-
1655
- /**
1656
- * Makes a code path segment for a `catch` block.
1657
- * @returns {void}
1658
- */
1659
- makeCatchBlock() {
1660
- const context = this.tryContext;
1661
- const forkContext = this.forkContext;
1662
- const originalThrownForkContext = context.thrownForkContext;
1663
-
1664
- /*
1665
- * We are now in a catch block so we need to update the context
1666
- * with that information. This includes creating a new fork
1667
- * context in case we encounter any `throw` statements here.
1668
- */
1669
- context.position = "catch";
1670
- context.thrownForkContext = ForkContext.newEmpty(forkContext);
1671
- context.lastOfTryIsReachable = forkContext.reachable;
1672
-
1673
- // Merge the thrown paths from the `try` and `catch` blocks
1674
- originalThrownForkContext.add(forkContext.head);
1675
- const thrownSegments = originalThrownForkContext.makeNext(0, -1);
1676
-
1677
- // Fork to a bypass and the merged thrown path.
1678
- this.pushForkContext();
1679
- this.forkBypassPath();
1680
- this.forkContext.add(thrownSegments);
1681
- }
1682
-
1683
- /**
1684
- * Makes a code path segment for a `finally` block.
1685
- *
1686
- * In the `finally` block, parallel paths are created. The parallel paths
1687
- * are used as leaving-paths. The leaving-paths are paths from `return`
1688
- * statements and `throw` statements in a `try` block or a `catch` block.
1689
- * @returns {void}
1690
- */
1691
- makeFinallyBlock() {
1692
- const context = this.tryContext;
1693
- let forkContext = this.forkContext;
1694
- const originalReturnedForkContext = context.returnedForkContext;
1695
- const originalThrownForContext = context.thrownForkContext;
1696
- const headOfLeavingSegments = forkContext.head;
1697
-
1698
- // Update state.
1699
- if (context.position === "catch") {
1700
-
1701
- // Merges two paths from the `try` block and `catch` block.
1702
- this.popForkContext();
1703
- forkContext = this.forkContext;
1704
-
1705
- context.lastOfCatchIsReachable = forkContext.reachable;
1706
- } else {
1707
- context.lastOfTryIsReachable = forkContext.reachable;
1708
- }
1709
-
1710
-
1711
- context.position = "finally";
1712
-
1713
- /*
1714
- * If there was no `return` or `throw` in either the `try` or `catch`
1715
- * blocks, then there's no further code paths to create for `finally`.
1716
- */
1717
- if (originalReturnedForkContext.empty && originalThrownForContext.empty) {
1718
-
1719
- // This path does not leave.
1720
- return;
1721
- }
1722
-
1723
- /*
1724
- * Create a parallel segment from merging returned and thrown.
1725
- * This segment will leave at the end of this `finally` block.
1726
- */
1727
- const segments = forkContext.makeNext(-1, -1);
1728
-
1729
- for (let i = 0; i < forkContext.count; ++i) {
1730
- const prevSegsOfLeavingSegment = [headOfLeavingSegments[i]];
1731
-
1732
- for (let j = 0; j < originalReturnedForkContext.segmentsList.length; ++j) {
1733
- prevSegsOfLeavingSegment.push(originalReturnedForkContext.segmentsList[j][i]);
1734
- }
1735
- for (let j = 0; j < originalThrownForContext.segmentsList.length; ++j) {
1736
- prevSegsOfLeavingSegment.push(originalThrownForContext.segmentsList[j][i]);
1737
- }
1738
-
1739
- segments.push(
1740
- CodePathSegment.newNext(
1741
- this.idGenerator.next(),
1742
- prevSegsOfLeavingSegment
1743
- )
1744
- );
1745
- }
1746
-
1747
- this.pushForkContext(true);
1748
- this.forkContext.add(segments);
1749
- }
1750
-
1751
- /**
1752
- * Makes a code path segment from the first throwable node to the `catch`
1753
- * block or the `finally` block.
1754
- * @returns {void}
1755
- */
1756
- makeFirstThrowablePathInTryBlock() {
1757
- const forkContext = this.forkContext;
1758
-
1759
- if (!forkContext.reachable) {
1760
- return;
1761
- }
1762
-
1763
- const context = getThrowContext(this);
1764
-
1765
- if (context === this ||
1766
- context.position !== "try" ||
1767
- !context.thrownForkContext.empty
1768
- ) {
1769
- return;
1770
- }
1771
-
1772
- context.thrownForkContext.add(forkContext.head);
1773
- forkContext.replaceHead(forkContext.makeNext(-1, -1));
1774
- }
1775
-
1776
- //--------------------------------------------------------------------------
1777
- // Loop Statements
1778
- //--------------------------------------------------------------------------
1779
-
1780
- /**
1781
- * Creates a context object of a loop statement and stacks it.
1782
- * @param {string} type The type of the node which was triggered. One of
1783
- * `WhileStatement`, `DoWhileStatement`, `ForStatement`, `ForInStatement`,
1784
- * and `ForStatement`.
1785
- * @param {string|null} label A label of the node which was triggered.
1786
- * @throws {Error} (Unreachable - unknown type.)
1787
- * @returns {void}
1788
- */
1789
- pushLoopContext(type, label) {
1790
- const forkContext = this.forkContext;
1791
-
1792
- // All loops need a path to account for `break` statements
1793
- const breakContext = this.pushBreakContext(true, label);
1794
-
1795
- switch (type) {
1796
- case "WhileStatement":
1797
- this.pushChoiceContext("loop", false);
1798
- this.loopContext = new WhileLoopContext(this.loopContext, label, breakContext);
1799
- break;
1800
-
1801
- case "DoWhileStatement":
1802
- this.pushChoiceContext("loop", false);
1803
- this.loopContext = new DoWhileLoopContext(this.loopContext, label, breakContext, forkContext);
1804
- break;
1805
-
1806
- case "ForStatement":
1807
- this.pushChoiceContext("loop", false);
1808
- this.loopContext = new ForLoopContext(this.loopContext, label, breakContext);
1809
- break;
1810
-
1811
- case "ForInStatement":
1812
- this.loopContext = new ForInLoopContext(this.loopContext, label, breakContext);
1813
- break;
1814
-
1815
- case "ForOfStatement":
1816
- this.loopContext = new ForOfLoopContext(this.loopContext, label, breakContext);
1817
- break;
1818
-
1819
- /* c8 ignore next */
1820
- default:
1821
- throw new Error(`unknown type: "${type}"`);
1822
- }
1823
- }
1824
-
1825
- /**
1826
- * Pops the last context of a loop statement and finalizes it.
1827
- * @throws {Error} (Unreachable - unknown type.)
1828
- * @returns {void}
1829
- */
1830
- popLoopContext() {
1831
- const context = this.loopContext;
1832
-
1833
- this.loopContext = context.upper;
1834
-
1835
- const forkContext = this.forkContext;
1836
- const brokenForkContext = this.popBreakContext().brokenForkContext;
1837
-
1838
- // Creates a looped path.
1839
- switch (context.type) {
1840
- case "WhileStatement":
1841
- case "ForStatement":
1842
- this.popChoiceContext();
1843
-
1844
- /*
1845
- * Creates the path from the end of the loop body up to the
1846
- * location where `continue` would jump to.
1847
- */
1848
- makeLooped(
1849
- this,
1850
- forkContext.head,
1851
- context.continueDestSegments
1852
- );
1853
- break;
1854
-
1855
- case "DoWhileStatement": {
1856
- const choiceContext = this.popChoiceContext();
1857
-
1858
- if (!choiceContext.processed) {
1859
- choiceContext.trueForkContext.add(forkContext.head);
1860
- choiceContext.falseForkContext.add(forkContext.head);
1861
- }
1862
-
1863
- /*
1864
- * If this isn't a hardcoded `true` condition, then `break`
1865
- * should continue down the path as if the condition evaluated
1866
- * to false.
1867
- */
1868
- if (context.test !== true) {
1869
- brokenForkContext.addAll(choiceContext.falseForkContext);
1870
- }
1871
-
1872
- /*
1873
- * When the condition is true, the loop continues back to the top,
1874
- * so create a path from each possible true condition back to the
1875
- * top of the loop.
1876
- */
1877
- const segmentsList = choiceContext.trueForkContext.segmentsList;
1878
-
1879
- for (let i = 0; i < segmentsList.length; ++i) {
1880
- makeLooped(
1881
- this,
1882
- segmentsList[i],
1883
- context.entrySegments
1884
- );
1885
- }
1886
- break;
1887
- }
1888
-
1889
- case "ForInStatement":
1890
- case "ForOfStatement":
1891
- brokenForkContext.add(forkContext.head);
1892
-
1893
- /*
1894
- * Creates the path from the end of the loop body up to the
1895
- * left expression (left of `in` or `of`) of the loop.
1896
- */
1897
- makeLooped(
1898
- this,
1899
- forkContext.head,
1900
- context.leftSegments
1901
- );
1902
- break;
1903
-
1904
- /* c8 ignore next */
1905
- default:
1906
- throw new Error("unreachable");
1907
- }
1908
-
1909
- /*
1910
- * If there wasn't a `break` statement in the loop, then we're at
1911
- * the end of the loop's path, so we make an unreachable segment
1912
- * to mark that.
1913
- *
1914
- * If there was a `break` statement, then we continue on into the
1915
- * `brokenForkContext`.
1916
- */
1917
- if (brokenForkContext.empty) {
1918
- forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
1919
- } else {
1920
- forkContext.replaceHead(brokenForkContext.makeNext(0, -1));
1921
- }
1922
- }
1923
-
1924
- /**
1925
- * Makes a code path segment for the test part of a WhileStatement.
1926
- * @param {boolean|undefined} test The test value (only when constant).
1927
- * @returns {void}
1928
- */
1929
- makeWhileTest(test) {
1930
- const context = this.loopContext;
1931
- const forkContext = this.forkContext;
1932
- const testSegments = forkContext.makeNext(0, -1);
1933
-
1934
- // Update state.
1935
- context.test = test;
1936
- context.continueDestSegments = testSegments;
1937
- forkContext.replaceHead(testSegments);
1938
- }
1939
-
1940
- /**
1941
- * Makes a code path segment for the body part of a WhileStatement.
1942
- * @returns {void}
1943
- */
1944
- makeWhileBody() {
1945
- const context = this.loopContext;
1946
- const choiceContext = this.choiceContext;
1947
- const forkContext = this.forkContext;
1948
-
1949
- if (!choiceContext.processed) {
1950
- choiceContext.trueForkContext.add(forkContext.head);
1951
- choiceContext.falseForkContext.add(forkContext.head);
1952
- }
1953
-
1954
- /*
1955
- * If this isn't a hardcoded `true` condition, then `break`
1956
- * should continue down the path as if the condition evaluated
1957
- * to false.
1958
- */
1959
- if (context.test !== true) {
1960
- context.brokenForkContext.addAll(choiceContext.falseForkContext);
1961
- }
1962
- forkContext.replaceHead(choiceContext.trueForkContext.makeNext(0, -1));
1963
- }
1964
-
1965
- /**
1966
- * Makes a code path segment for the body part of a DoWhileStatement.
1967
- * @returns {void}
1968
- */
1969
- makeDoWhileBody() {
1970
- const context = this.loopContext;
1971
- const forkContext = this.forkContext;
1972
- const bodySegments = forkContext.makeNext(-1, -1);
1973
-
1974
- // Update state.
1975
- context.entrySegments = bodySegments;
1976
- forkContext.replaceHead(bodySegments);
1977
- }
1978
-
1979
- /**
1980
- * Makes a code path segment for the test part of a DoWhileStatement.
1981
- * @param {boolean|undefined} test The test value (only when constant).
1982
- * @returns {void}
1983
- */
1984
- makeDoWhileTest(test) {
1985
- const context = this.loopContext;
1986
- const forkContext = this.forkContext;
1987
-
1988
- context.test = test;
1989
-
1990
- /*
1991
- * If there is a `continue` statement in the loop then `continueForkContext`
1992
- * won't be empty. We wire up the path from `continue` to the loop
1993
- * test condition and then continue the traversal in the root fork context.
1994
- */
1995
- if (!context.continueForkContext.empty) {
1996
- context.continueForkContext.add(forkContext.head);
1997
- const testSegments = context.continueForkContext.makeNext(0, -1);
1998
-
1999
- forkContext.replaceHead(testSegments);
2000
- }
2001
- }
2002
-
2003
- /**
2004
- * Makes a code path segment for the test part of a ForStatement.
2005
- * @param {boolean|undefined} test The test value (only when constant).
2006
- * @returns {void}
2007
- */
2008
- makeForTest(test) {
2009
- const context = this.loopContext;
2010
- const forkContext = this.forkContext;
2011
- const endOfInitSegments = forkContext.head;
2012
- const testSegments = forkContext.makeNext(-1, -1);
2013
-
2014
- /*
2015
- * Update the state.
2016
- *
2017
- * The `continueDestSegments` are set to `testSegments` because we
2018
- * don't yet know if there is an update expression in this loop. So,
2019
- * from what we already know at this point, a `continue` statement
2020
- * will jump back to the test expression.
2021
- */
2022
- context.test = test;
2023
- context.endOfInitSegments = endOfInitSegments;
2024
- context.continueDestSegments = context.testSegments = testSegments;
2025
- forkContext.replaceHead(testSegments);
2026
- }
2027
-
2028
- /**
2029
- * Makes a code path segment for the update part of a ForStatement.
2030
- * @returns {void}
2031
- */
2032
- makeForUpdate() {
2033
- const context = this.loopContext;
2034
- const choiceContext = this.choiceContext;
2035
- const forkContext = this.forkContext;
2036
-
2037
- // Make the next paths of the test.
2038
- if (context.testSegments) {
2039
- finalizeTestSegmentsOfFor(
2040
- context,
2041
- choiceContext,
2042
- forkContext.head
2043
- );
2044
- } else {
2045
- context.endOfInitSegments = forkContext.head;
2046
- }
2047
-
2048
- /*
2049
- * Update the state.
2050
- *
2051
- * The `continueDestSegments` are now set to `updateSegments` because we
2052
- * know there is an update expression in this loop. So, a `continue` statement
2053
- * in the loop will jump to the update expression first, and then to any
2054
- * test expression the loop might have.
2055
- */
2056
- const updateSegments = forkContext.makeDisconnected(-1, -1);
2057
-
2058
- context.continueDestSegments = context.updateSegments = updateSegments;
2059
- forkContext.replaceHead(updateSegments);
2060
- }
2061
-
2062
- /**
2063
- * Makes a code path segment for the body part of a ForStatement.
2064
- * @returns {void}
2065
- */
2066
- makeForBody() {
2067
- const context = this.loopContext;
2068
- const choiceContext = this.choiceContext;
2069
- const forkContext = this.forkContext;
2070
-
2071
- /*
2072
- * Determine what to do based on which part of the `for` loop are present.
2073
- * 1. If there is an update expression, then `updateSegments` is not null and
2074
- * we need to assign `endOfUpdateSegments`, and if there is a test
2075
- * expression, we then need to create the looped path to get back to
2076
- * the test condition.
2077
- * 2. If there is no update expression but there is a test expression,
2078
- * then we only need to update the test segment information.
2079
- * 3. If there is no update expression and no test expression, then we
2080
- * just save `endOfInitSegments`.
2081
- */
2082
- if (context.updateSegments) {
2083
- context.endOfUpdateSegments = forkContext.head;
2084
-
2085
- /*
2086
- * In a `for` loop that has both an update expression and a test
2087
- * condition, execution flows from the test expression into the
2088
- * loop body, to the update expression, and then back to the test
2089
- * expression to determine if the loop should continue.
2090
- *
2091
- * To account for that, we need to make a path from the end of the
2092
- * update expression to the start of the test expression. This is
2093
- * effectively what creates the loop in the code path.
2094
- */
2095
- if (context.testSegments) {
2096
- makeLooped(
2097
- this,
2098
- context.endOfUpdateSegments,
2099
- context.testSegments
2100
- );
2101
- }
2102
- } else if (context.testSegments) {
2103
- finalizeTestSegmentsOfFor(
2104
- context,
2105
- choiceContext,
2106
- forkContext.head
2107
- );
2108
- } else {
2109
- context.endOfInitSegments = forkContext.head;
2110
- }
2111
-
2112
- let bodySegments = context.endOfTestSegments;
2113
-
2114
- /*
2115
- * If there is a test condition, then there `endOfTestSegments` is also
2116
- * the start of the loop body. If there isn't a test condition then
2117
- * `bodySegments` will be null and we need to look elsewhere to find
2118
- * the start of the body.
2119
- *
2120
- * The body starts at the end of the init expression and ends at the end
2121
- * of the update expression, so we use those locations to determine the
2122
- * body segments.
2123
- */
2124
- if (!bodySegments) {
2125
-
2126
- const prevForkContext = ForkContext.newEmpty(forkContext);
2127
-
2128
- prevForkContext.add(context.endOfInitSegments);
2129
- if (context.endOfUpdateSegments) {
2130
- prevForkContext.add(context.endOfUpdateSegments);
2131
- }
2132
-
2133
- bodySegments = prevForkContext.makeNext(0, -1);
2134
- }
2135
-
2136
- /*
2137
- * If there was no test condition and no update expression, then
2138
- * `continueDestSegments` will be null. In that case, a
2139
- * `continue` should skip directly to the body of the loop.
2140
- * Otherwise, we want to keep the current `continueDestSegments`.
2141
- */
2142
- context.continueDestSegments = context.continueDestSegments || bodySegments;
2143
-
2144
- // move pointer to the body
2145
- forkContext.replaceHead(bodySegments);
2146
- }
2147
-
2148
- /**
2149
- * Makes a code path segment for the left part of a ForInStatement and a
2150
- * ForOfStatement.
2151
- * @returns {void}
2152
- */
2153
- makeForInOfLeft() {
2154
- const context = this.loopContext;
2155
- const forkContext = this.forkContext;
2156
- const leftSegments = forkContext.makeDisconnected(-1, -1);
2157
-
2158
- // Update state.
2159
- context.prevSegments = forkContext.head;
2160
- context.leftSegments = context.continueDestSegments = leftSegments;
2161
- forkContext.replaceHead(leftSegments);
2162
- }
2163
-
2164
- /**
2165
- * Makes a code path segment for the right part of a ForInStatement and a
2166
- * ForOfStatement.
2167
- * @returns {void}
2168
- */
2169
- makeForInOfRight() {
2170
- const context = this.loopContext;
2171
- const forkContext = this.forkContext;
2172
- const temp = ForkContext.newEmpty(forkContext);
2173
-
2174
- temp.add(context.prevSegments);
2175
- const rightSegments = temp.makeNext(-1, -1);
2176
-
2177
- // Update state.
2178
- context.endOfLeftSegments = forkContext.head;
2179
- forkContext.replaceHead(rightSegments);
2180
- }
2181
-
2182
- /**
2183
- * Makes a code path segment for the body part of a ForInStatement and a
2184
- * ForOfStatement.
2185
- * @returns {void}
2186
- */
2187
- makeForInOfBody() {
2188
- const context = this.loopContext;
2189
- const forkContext = this.forkContext;
2190
- const temp = ForkContext.newEmpty(forkContext);
2191
-
2192
- temp.add(context.endOfLeftSegments);
2193
- const bodySegments = temp.makeNext(-1, -1);
2194
-
2195
- // Make a path: `right` -> `left`.
2196
- makeLooped(this, forkContext.head, context.leftSegments);
2197
-
2198
- // Update state.
2199
- context.brokenForkContext.add(forkContext.head);
2200
- forkContext.replaceHead(bodySegments);
2201
- }
2202
-
2203
- //--------------------------------------------------------------------------
2204
- // Control Statements
2205
- //--------------------------------------------------------------------------
2206
-
2207
- /**
2208
- * Creates new context in which a `break` statement can be used. This occurs inside of a loop,
2209
- * labeled statement, or switch statement.
2210
- * @param {boolean} breakable Indicates if we are inside a statement where
2211
- * `break` without a label will exit the statement.
2212
- * @param {string|null} label The label associated with the statement.
2213
- * @returns {BreakContext} The new context.
2214
- */
2215
- pushBreakContext(breakable, label) {
2216
- this.breakContext = new BreakContext(this.breakContext, breakable, label, this.forkContext);
2217
- return this.breakContext;
2218
- }
2219
-
2220
- /**
2221
- * Removes the top item of the break context stack.
2222
- * @returns {Object} The removed context.
2223
- */
2224
- popBreakContext() {
2225
- const context = this.breakContext;
2226
- const forkContext = this.forkContext;
2227
-
2228
- this.breakContext = context.upper;
2229
-
2230
- // Process this context here for other than switches and loops.
2231
- if (!context.breakable) {
2232
- const brokenForkContext = context.brokenForkContext;
2233
-
2234
- if (!brokenForkContext.empty) {
2235
- brokenForkContext.add(forkContext.head);
2236
- forkContext.replaceHead(brokenForkContext.makeNext(0, -1));
2237
- }
2238
- }
2239
-
2240
- return context;
2241
- }
2242
-
2243
- /**
2244
- * Makes a path for a `break` statement.
2245
- *
2246
- * It registers the head segment to a context of `break`.
2247
- * It makes new unreachable segment, then it set the head with the segment.
2248
- * @param {string|null} label A label of the break statement.
2249
- * @returns {void}
2250
- */
2251
- makeBreak(label) {
2252
- const forkContext = this.forkContext;
2253
-
2254
- if (!forkContext.reachable) {
2255
- return;
2256
- }
2257
-
2258
- const context = getBreakContext(this, label);
2259
-
2260
-
2261
- if (context) {
2262
- context.brokenForkContext.add(forkContext.head);
2263
- }
2264
-
2265
- /* c8 ignore next */
2266
- forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
2267
- }
2268
-
2269
- /**
2270
- * Makes a path for a `continue` statement.
2271
- *
2272
- * It makes a looping path.
2273
- * It makes new unreachable segment, then it set the head with the segment.
2274
- * @param {string|null} label A label of the continue statement.
2275
- * @returns {void}
2276
- */
2277
- makeContinue(label) {
2278
- const forkContext = this.forkContext;
2279
-
2280
- if (!forkContext.reachable) {
2281
- return;
2282
- }
2283
-
2284
- const context = getContinueContext(this, label);
2285
-
2286
- if (context) {
2287
- if (context.continueDestSegments) {
2288
- makeLooped(this, forkContext.head, context.continueDestSegments);
2289
-
2290
- // If the context is a for-in/of loop, this affects a break also.
2291
- if (context.type === "ForInStatement" ||
2292
- context.type === "ForOfStatement"
2293
- ) {
2294
- context.brokenForkContext.add(forkContext.head);
2295
- }
2296
- } else {
2297
- context.continueForkContext.add(forkContext.head);
2298
- }
2299
- }
2300
- forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
2301
- }
2302
-
2303
- /**
2304
- * Makes a path for a `return` statement.
2305
- *
2306
- * It registers the head segment to a context of `return`.
2307
- * It makes new unreachable segment, then it set the head with the segment.
2308
- * @returns {void}
2309
- */
2310
- makeReturn() {
2311
- const forkContext = this.forkContext;
2312
-
2313
- if (forkContext.reachable) {
2314
- getReturnContext(this).returnedForkContext.add(forkContext.head);
2315
- forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
2316
- }
2317
- }
2318
-
2319
- /**
2320
- * Makes a path for a `throw` statement.
2321
- *
2322
- * It registers the head segment to a context of `throw`.
2323
- * It makes new unreachable segment, then it set the head with the segment.
2324
- * @returns {void}
2325
- */
2326
- makeThrow() {
2327
- const forkContext = this.forkContext;
2328
-
2329
- if (forkContext.reachable) {
2330
- getThrowContext(this).thrownForkContext.add(forkContext.head);
2331
- forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
2332
- }
2333
- }
2334
-
2335
- /**
2336
- * Makes the final path.
2337
- * @returns {void}
2338
- */
2339
- makeFinal() {
2340
- const segments = this.currentSegments;
2341
-
2342
- if (segments.length > 0 && segments[0].reachable) {
2343
- this.returnedForkContext.add(segments);
2344
- }
2345
- }
859
+ /**
860
+ * Creates a new instance.
861
+ * @param {IdGenerator} idGenerator An id generator to generate id for code
862
+ * path segments.
863
+ * @param {Function} onLooped A callback function to notify looping.
864
+ */
865
+ constructor(idGenerator, onLooped) {
866
+ /**
867
+ * The ID generator to use when creating new segments.
868
+ * @type {IdGenerator}
869
+ */
870
+ this.idGenerator = idGenerator;
871
+
872
+ /**
873
+ * A callback function to call when there is a loop.
874
+ * @type {Function}
875
+ */
876
+ this.notifyLooped = onLooped;
877
+
878
+ /**
879
+ * The root fork context for this state.
880
+ * @type {ForkContext}
881
+ */
882
+ this.forkContext = ForkContext.newRoot(idGenerator);
883
+
884
+ /**
885
+ * Context for logical expressions, conditional expressions, `if` statements,
886
+ * and loops.
887
+ * @type {ChoiceContext}
888
+ */
889
+ this.choiceContext = null;
890
+
891
+ /**
892
+ * Context for `switch` statements.
893
+ * @type {SwitchContext}
894
+ */
895
+ this.switchContext = null;
896
+
897
+ /**
898
+ * Context for `try` statements.
899
+ * @type {TryContext}
900
+ */
901
+ this.tryContext = null;
902
+
903
+ /**
904
+ * Context for loop statements.
905
+ * @type {LoopContext}
906
+ */
907
+ this.loopContext = null;
908
+
909
+ /**
910
+ * Context for `break` statements.
911
+ * @type {BreakContext}
912
+ */
913
+ this.breakContext = null;
914
+
915
+ /**
916
+ * Context for `ChainExpression` nodes.
917
+ * @type {ChainContext}
918
+ */
919
+ this.chainContext = null;
920
+
921
+ /**
922
+ * An array that tracks the current segments in the state. The array
923
+ * starts empty and segments are added with each `onCodePathSegmentStart`
924
+ * event and removed with each `onCodePathSegmentEnd` event. Effectively,
925
+ * this is tracking the code path segment traversal as the state is
926
+ * modified.
927
+ * @type {Array<CodePathSegment>}
928
+ */
929
+ this.currentSegments = [];
930
+
931
+ /**
932
+ * Tracks the starting segment for this path. This value never changes.
933
+ * @type {CodePathSegment}
934
+ */
935
+ this.initialSegment = this.forkContext.head[0];
936
+
937
+ /**
938
+ * The final segments of the code path which are either `return` or `throw`.
939
+ * This is a union of the segments in `returnedForkContext` and `thrownForkContext`.
940
+ * @type {Array<CodePathSegment>}
941
+ */
942
+ this.finalSegments = [];
943
+
944
+ /**
945
+ * The final segments of the code path which are `return`. These
946
+ * segments are also contained in `finalSegments`.
947
+ * @type {Array<CodePathSegment>}
948
+ */
949
+ this.returnedForkContext = [];
950
+
951
+ /**
952
+ * The final segments of the code path which are `throw`. These
953
+ * segments are also contained in `finalSegments`.
954
+ * @type {Array<CodePathSegment>}
955
+ */
956
+ this.thrownForkContext = [];
957
+
958
+ /*
959
+ * We add an `add` method so that these look more like fork contexts and
960
+ * can be used interchangeably when a fork context is needed to add more
961
+ * segments to a path.
962
+ *
963
+ * Ultimately, we want anything added to `returned` or `thrown` to also
964
+ * be added to `final`. We only add reachable and used segments to these
965
+ * arrays.
966
+ */
967
+ const final = this.finalSegments;
968
+ const returned = this.returnedForkContext;
969
+ const thrown = this.thrownForkContext;
970
+
971
+ returned.add = addToReturnedOrThrown.bind(
972
+ null,
973
+ returned,
974
+ thrown,
975
+ final,
976
+ );
977
+ thrown.add = addToReturnedOrThrown.bind(null, thrown, returned, final);
978
+ }
979
+
980
+ /**
981
+ * A passthrough property exposing the current pointer as part of the API.
982
+ * @type {CodePathSegment[]}
983
+ */
984
+ get headSegments() {
985
+ return this.forkContext.head;
986
+ }
987
+
988
+ /**
989
+ * The parent forking context.
990
+ * This is used for the root of new forks.
991
+ * @type {ForkContext}
992
+ */
993
+ get parentForkContext() {
994
+ const current = this.forkContext;
995
+
996
+ return current && current.upper;
997
+ }
998
+
999
+ /**
1000
+ * Creates and stacks new forking context.
1001
+ * @param {boolean} forkLeavingPath A flag which shows being in a
1002
+ * "finally" block.
1003
+ * @returns {ForkContext} The created context.
1004
+ */
1005
+ pushForkContext(forkLeavingPath) {
1006
+ this.forkContext = ForkContext.newEmpty(
1007
+ this.forkContext,
1008
+ forkLeavingPath,
1009
+ );
1010
+
1011
+ return this.forkContext;
1012
+ }
1013
+
1014
+ /**
1015
+ * Pops and merges the last forking context.
1016
+ * @returns {ForkContext} The last context.
1017
+ */
1018
+ popForkContext() {
1019
+ const lastContext = this.forkContext;
1020
+
1021
+ this.forkContext = lastContext.upper;
1022
+ this.forkContext.replaceHead(lastContext.makeNext(0, -1));
1023
+
1024
+ return lastContext;
1025
+ }
1026
+
1027
+ /**
1028
+ * Creates a new path.
1029
+ * @returns {void}
1030
+ */
1031
+ forkPath() {
1032
+ this.forkContext.add(this.parentForkContext.makeNext(-1, -1));
1033
+ }
1034
+
1035
+ /**
1036
+ * Creates a bypass path.
1037
+ * This is used for such as IfStatement which does not have "else" chunk.
1038
+ * @returns {void}
1039
+ */
1040
+ forkBypassPath() {
1041
+ this.forkContext.add(this.parentForkContext.head);
1042
+ }
1043
+
1044
+ //--------------------------------------------------------------------------
1045
+ // ConditionalExpression, LogicalExpression, IfStatement
1046
+ //--------------------------------------------------------------------------
1047
+
1048
+ /**
1049
+ * Creates a context for ConditionalExpression, LogicalExpression, AssignmentExpression (logical assignments only),
1050
+ * IfStatement, WhileStatement, DoWhileStatement, or ForStatement.
1051
+ *
1052
+ * LogicalExpressions have cases that it goes different paths between the
1053
+ * `true` case and the `false` case.
1054
+ *
1055
+ * For Example:
1056
+ *
1057
+ * if (a || b) {
1058
+ * foo();
1059
+ * } else {
1060
+ * bar();
1061
+ * }
1062
+ *
1063
+ * In this case, `b` is evaluated always in the code path of the `else`
1064
+ * block, but it's not so in the code path of the `if` block.
1065
+ * So there are 3 paths.
1066
+ *
1067
+ * a -> foo();
1068
+ * a -> b -> foo();
1069
+ * a -> b -> bar();
1070
+ * @param {string} kind A kind string.
1071
+ * If the new context is LogicalExpression's or AssignmentExpression's, this is `"&&"` or `"||"` or `"??"`.
1072
+ * If it's IfStatement's or ConditionalExpression's, this is `"test"`.
1073
+ * Otherwise, this is `"loop"`.
1074
+ * @param {boolean} isForkingAsResult Indicates if the result of the choice
1075
+ * creates a fork.
1076
+ * @returns {void}
1077
+ */
1078
+ pushChoiceContext(kind, isForkingAsResult) {
1079
+ this.choiceContext = new ChoiceContext(
1080
+ this.choiceContext,
1081
+ kind,
1082
+ isForkingAsResult,
1083
+ this.forkContext,
1084
+ );
1085
+ }
1086
+
1087
+ /**
1088
+ * Pops the last choice context and finalizes it.
1089
+ * This is called upon leaving a node that represents a choice.
1090
+ * @throws {Error} (Unreachable.)
1091
+ * @returns {ChoiceContext} The popped context.
1092
+ */
1093
+ popChoiceContext() {
1094
+ const poppedChoiceContext = this.choiceContext;
1095
+ const forkContext = this.forkContext;
1096
+ const head = forkContext.head;
1097
+
1098
+ this.choiceContext = poppedChoiceContext.upper;
1099
+
1100
+ switch (poppedChoiceContext.kind) {
1101
+ case "&&":
1102
+ case "||":
1103
+ case "??":
1104
+ /*
1105
+ * The `head` are the path of the right-hand operand.
1106
+ * If we haven't previously added segments from child contexts,
1107
+ * then we add these segments to all possible forks.
1108
+ */
1109
+ if (!poppedChoiceContext.processed) {
1110
+ poppedChoiceContext.trueForkContext.add(head);
1111
+ poppedChoiceContext.falseForkContext.add(head);
1112
+ poppedChoiceContext.nullishForkContext.add(head);
1113
+ }
1114
+
1115
+ /*
1116
+ * If this context is the left (test) expression for another choice
1117
+ * context, such as `a || b` in the expression `a || b || c`,
1118
+ * then we take the segments for this context and move them up
1119
+ * to the parent context.
1120
+ */
1121
+ if (poppedChoiceContext.isForkingAsResult) {
1122
+ const parentContext = this.choiceContext;
1123
+
1124
+ parentContext.trueForkContext.addAll(
1125
+ poppedChoiceContext.trueForkContext,
1126
+ );
1127
+ parentContext.falseForkContext.addAll(
1128
+ poppedChoiceContext.falseForkContext,
1129
+ );
1130
+ parentContext.nullishForkContext.addAll(
1131
+ poppedChoiceContext.nullishForkContext,
1132
+ );
1133
+ parentContext.processed = true;
1134
+
1135
+ // Exit early so we don't collapse all paths into one.
1136
+ return poppedChoiceContext;
1137
+ }
1138
+
1139
+ break;
1140
+
1141
+ case "test":
1142
+ if (!poppedChoiceContext.processed) {
1143
+ /*
1144
+ * The head segments are the path of the `if` block here.
1145
+ * Updates the `true` path with the end of the `if` block.
1146
+ */
1147
+ poppedChoiceContext.trueForkContext.clear();
1148
+ poppedChoiceContext.trueForkContext.add(head);
1149
+ } else {
1150
+ /*
1151
+ * The head segments are the path of the `else` block here.
1152
+ * Updates the `false` path with the end of the `else`
1153
+ * block.
1154
+ */
1155
+ poppedChoiceContext.falseForkContext.clear();
1156
+ poppedChoiceContext.falseForkContext.add(head);
1157
+ }
1158
+
1159
+ break;
1160
+
1161
+ case "loop":
1162
+ /*
1163
+ * Loops are addressed in `popLoopContext()` so just return
1164
+ * the context without modification.
1165
+ */
1166
+ return poppedChoiceContext;
1167
+
1168
+ /* c8 ignore next */
1169
+ default:
1170
+ throw new Error("unreachable");
1171
+ }
1172
+
1173
+ /*
1174
+ * Merge the true path with the false path to create a single path.
1175
+ */
1176
+ const combinedForkContext = poppedChoiceContext.trueForkContext;
1177
+
1178
+ combinedForkContext.addAll(poppedChoiceContext.falseForkContext);
1179
+ forkContext.replaceHead(combinedForkContext.makeNext(0, -1));
1180
+
1181
+ return poppedChoiceContext;
1182
+ }
1183
+
1184
+ /**
1185
+ * Creates a code path segment to represent right-hand operand of a logical
1186
+ * expression.
1187
+ * This is called in the preprocessing phase when entering a node.
1188
+ * @throws {Error} (Unreachable.)
1189
+ * @returns {void}
1190
+ */
1191
+ makeLogicalRight() {
1192
+ const currentChoiceContext = this.choiceContext;
1193
+ const forkContext = this.forkContext;
1194
+
1195
+ if (currentChoiceContext.processed) {
1196
+ /*
1197
+ * This context was already assigned segments from a child
1198
+ * choice context. In this case, we are concerned only about
1199
+ * the path that does not short-circuit and so ends up on the
1200
+ * right-hand operand of the logical expression.
1201
+ */
1202
+ let prevForkContext;
1203
+
1204
+ switch (currentChoiceContext.kind) {
1205
+ case "&&": // if true then go to the right-hand side.
1206
+ prevForkContext = currentChoiceContext.trueForkContext;
1207
+ break;
1208
+ case "||": // if false then go to the right-hand side.
1209
+ prevForkContext = currentChoiceContext.falseForkContext;
1210
+ break;
1211
+ case "??": // Both true/false can short-circuit, so needs the third path to go to the right-hand side. That's nullishForkContext.
1212
+ prevForkContext = currentChoiceContext.nullishForkContext;
1213
+ break;
1214
+ default:
1215
+ throw new Error("unreachable");
1216
+ }
1217
+
1218
+ /*
1219
+ * Create the segment for the right-hand operand of the logical expression
1220
+ * and adjust the fork context pointer to point there. The right-hand segment
1221
+ * is added at the end of all segments in `prevForkContext`.
1222
+ */
1223
+ forkContext.replaceHead(prevForkContext.makeNext(0, -1));
1224
+
1225
+ /*
1226
+ * We no longer need this list of segments.
1227
+ *
1228
+ * Reset `processed` because we've removed the segments from the child
1229
+ * choice context. This allows `popChoiceContext()` to continue adding
1230
+ * segments later.
1231
+ */
1232
+ prevForkContext.clear();
1233
+ currentChoiceContext.processed = false;
1234
+ } else {
1235
+ /*
1236
+ * This choice context was not assigned segments from a child
1237
+ * choice context, which means that it's a terminal logical
1238
+ * expression.
1239
+ *
1240
+ * `head` is the segments for the left-hand operand of the
1241
+ * logical expression.
1242
+ *
1243
+ * Each of the fork contexts below are empty at this point. We choose
1244
+ * the path(s) that will short-circuit and add the segment for the
1245
+ * left-hand operand to it. Ultimately, this will be the only segment
1246
+ * in that path due to the short-circuting, so we are just seeding
1247
+ * these paths to start.
1248
+ */
1249
+ switch (currentChoiceContext.kind) {
1250
+ case "&&":
1251
+ /*
1252
+ * In most contexts, when a && expression evaluates to false,
1253
+ * it short circuits, so we need to account for that by setting
1254
+ * the `falseForkContext` to the left operand.
1255
+ *
1256
+ * When a && expression is the left-hand operand for a ??
1257
+ * expression, such as `(a && b) ?? c`, a nullish value will
1258
+ * also short-circuit in a different way than a false value,
1259
+ * so we also set the `nullishForkContext` to the left operand.
1260
+ * This path is only used with a ?? expression and is thrown
1261
+ * away for any other type of logical expression, so it's safe
1262
+ * to always add.
1263
+ */
1264
+ currentChoiceContext.falseForkContext.add(forkContext.head);
1265
+ currentChoiceContext.nullishForkContext.add(
1266
+ forkContext.head,
1267
+ );
1268
+ break;
1269
+ case "||": // the true path can short-circuit.
1270
+ currentChoiceContext.trueForkContext.add(forkContext.head);
1271
+ break;
1272
+ case "??": // both can short-circuit.
1273
+ currentChoiceContext.trueForkContext.add(forkContext.head);
1274
+ currentChoiceContext.falseForkContext.add(forkContext.head);
1275
+ break;
1276
+ default:
1277
+ throw new Error("unreachable");
1278
+ }
1279
+
1280
+ /*
1281
+ * Create the segment for the right-hand operand of the logical expression
1282
+ * and adjust the fork context pointer to point there.
1283
+ */
1284
+ forkContext.replaceHead(forkContext.makeNext(-1, -1));
1285
+ }
1286
+ }
1287
+
1288
+ /**
1289
+ * Makes a code path segment of the `if` block.
1290
+ * @returns {void}
1291
+ */
1292
+ makeIfConsequent() {
1293
+ const context = this.choiceContext;
1294
+ const forkContext = this.forkContext;
1295
+
1296
+ /*
1297
+ * If any result were not transferred from child contexts,
1298
+ * this sets the head segments to both cases.
1299
+ * The head segments are the path of the test expression.
1300
+ */
1301
+ if (!context.processed) {
1302
+ context.trueForkContext.add(forkContext.head);
1303
+ context.falseForkContext.add(forkContext.head);
1304
+ context.nullishForkContext.add(forkContext.head);
1305
+ }
1306
+
1307
+ context.processed = false;
1308
+
1309
+ // Creates new path from the `true` case.
1310
+ forkContext.replaceHead(context.trueForkContext.makeNext(0, -1));
1311
+ }
1312
+
1313
+ /**
1314
+ * Makes a code path segment of the `else` block.
1315
+ * @returns {void}
1316
+ */
1317
+ makeIfAlternate() {
1318
+ const context = this.choiceContext;
1319
+ const forkContext = this.forkContext;
1320
+
1321
+ /*
1322
+ * The head segments are the path of the `if` block.
1323
+ * Updates the `true` path with the end of the `if` block.
1324
+ */
1325
+ context.trueForkContext.clear();
1326
+ context.trueForkContext.add(forkContext.head);
1327
+ context.processed = true;
1328
+
1329
+ // Creates new path from the `false` case.
1330
+ forkContext.replaceHead(context.falseForkContext.makeNext(0, -1));
1331
+ }
1332
+
1333
+ //--------------------------------------------------------------------------
1334
+ // ChainExpression
1335
+ //--------------------------------------------------------------------------
1336
+
1337
+ /**
1338
+ * Pushes a new `ChainExpression` context to the stack. This method is
1339
+ * called when entering a `ChainExpression` node. A chain context is used to
1340
+ * count forking in the optional chain then merge them on the exiting from the
1341
+ * `ChainExpression` node.
1342
+ * @returns {void}
1343
+ */
1344
+ pushChainContext() {
1345
+ this.chainContext = new ChainContext(this.chainContext);
1346
+ }
1347
+
1348
+ /**
1349
+ * Pop a `ChainExpression` context from the stack. This method is called on
1350
+ * exiting from each `ChainExpression` node. This merges all forks of the
1351
+ * last optional chaining.
1352
+ * @returns {void}
1353
+ */
1354
+ popChainContext() {
1355
+ const context = this.chainContext;
1356
+
1357
+ this.chainContext = context.upper;
1358
+
1359
+ // pop all choice contexts of this.
1360
+ for (let i = context.choiceContextCount; i > 0; --i) {
1361
+ this.popChoiceContext();
1362
+ }
1363
+ }
1364
+
1365
+ /**
1366
+ * Create a choice context for optional access.
1367
+ * This method is called on entering to each `(Call|Member)Expression[optional=true]` node.
1368
+ * This creates a choice context as similar to `LogicalExpression[operator="??"]` node.
1369
+ * @returns {void}
1370
+ */
1371
+ makeOptionalNode() {
1372
+ if (this.chainContext) {
1373
+ this.chainContext.choiceContextCount += 1;
1374
+ this.pushChoiceContext("??", false);
1375
+ }
1376
+ }
1377
+
1378
+ /**
1379
+ * Create a fork.
1380
+ * This method is called on entering to the `arguments|property` property of each `(Call|Member)Expression` node.
1381
+ * @returns {void}
1382
+ */
1383
+ makeOptionalRight() {
1384
+ if (this.chainContext) {
1385
+ this.makeLogicalRight();
1386
+ }
1387
+ }
1388
+
1389
+ //--------------------------------------------------------------------------
1390
+ // SwitchStatement
1391
+ //--------------------------------------------------------------------------
1392
+
1393
+ /**
1394
+ * Creates a context object of SwitchStatement and stacks it.
1395
+ * @param {boolean} hasCase `true` if the switch statement has one or more
1396
+ * case parts.
1397
+ * @param {string|null} label The label text.
1398
+ * @returns {void}
1399
+ */
1400
+ pushSwitchContext(hasCase, label) {
1401
+ this.switchContext = new SwitchContext(this.switchContext, hasCase);
1402
+ this.pushBreakContext(true, label);
1403
+ }
1404
+
1405
+ /**
1406
+ * Pops the last context of SwitchStatement and finalizes it.
1407
+ *
1408
+ * - Disposes all forking stack for `case` and `default`.
1409
+ * - Creates the next code path segment from `context.brokenForkContext`.
1410
+ * - If the last `SwitchCase` node is not a `default` part, creates a path
1411
+ * to the `default` body.
1412
+ * @returns {void}
1413
+ */
1414
+ popSwitchContext() {
1415
+ const context = this.switchContext;
1416
+
1417
+ this.switchContext = context.upper;
1418
+
1419
+ const forkContext = this.forkContext;
1420
+ const brokenForkContext = this.popBreakContext().brokenForkContext;
1421
+
1422
+ if (context.forkCount === 0) {
1423
+ /*
1424
+ * When there is only one `default` chunk and there is one or more
1425
+ * `break` statements, even if forks are nothing, it needs to merge
1426
+ * those.
1427
+ */
1428
+ if (!brokenForkContext.empty) {
1429
+ brokenForkContext.add(forkContext.makeNext(-1, -1));
1430
+ forkContext.replaceHead(brokenForkContext.makeNext(0, -1));
1431
+ }
1432
+
1433
+ return;
1434
+ }
1435
+
1436
+ const lastSegments = forkContext.head;
1437
+
1438
+ this.forkBypassPath();
1439
+ const lastCaseSegments = forkContext.head;
1440
+
1441
+ /*
1442
+ * `brokenForkContext` is used to make the next segment.
1443
+ * It must add the last segment into `brokenForkContext`.
1444
+ */
1445
+ brokenForkContext.add(lastSegments);
1446
+
1447
+ /*
1448
+ * Any value that doesn't match a `case` test should flow to the default
1449
+ * case. That happens normally when the default case is last in the `switch`,
1450
+ * but if it's not, we need to rewire some of the paths to be correct.
1451
+ */
1452
+ if (!context.lastIsDefault) {
1453
+ if (context.defaultBodySegments) {
1454
+ /*
1455
+ * There is a non-empty default case, so remove the path from the `default`
1456
+ * label to its body for an accurate representation.
1457
+ */
1458
+ disconnectSegments(
1459
+ context.defaultSegments,
1460
+ context.defaultBodySegments,
1461
+ );
1462
+
1463
+ /*
1464
+ * Connect the path from the last non-default case to the body of the
1465
+ * default case.
1466
+ */
1467
+ makeLooped(this, lastCaseSegments, context.defaultBodySegments);
1468
+ } else {
1469
+ /*
1470
+ * There is no default case, so we treat this as if the last case
1471
+ * had a `break` in it.
1472
+ */
1473
+ brokenForkContext.add(lastCaseSegments);
1474
+ }
1475
+ }
1476
+
1477
+ // Traverse up to the original fork context for the `switch` statement
1478
+ for (let i = 0; i < context.forkCount; ++i) {
1479
+ this.forkContext = this.forkContext.upper;
1480
+ }
1481
+
1482
+ /*
1483
+ * Creates a path from all `brokenForkContext` paths.
1484
+ * This is a path after `switch` statement.
1485
+ */
1486
+ this.forkContext.replaceHead(brokenForkContext.makeNext(0, -1));
1487
+ }
1488
+
1489
+ /**
1490
+ * Makes a code path segment for a `SwitchCase` node.
1491
+ * @param {boolean} isCaseBodyEmpty `true` if the body is empty.
1492
+ * @param {boolean} isDefaultCase `true` if the body is the default case.
1493
+ * @returns {void}
1494
+ */
1495
+ makeSwitchCaseBody(isCaseBodyEmpty, isDefaultCase) {
1496
+ const context = this.switchContext;
1497
+
1498
+ if (!context.hasCase) {
1499
+ return;
1500
+ }
1501
+
1502
+ /*
1503
+ * Merge forks.
1504
+ * The parent fork context has two segments.
1505
+ * Those are from the current `case` and the body of the previous case.
1506
+ */
1507
+ const parentForkContext = this.forkContext;
1508
+ const forkContext = this.pushForkContext();
1509
+
1510
+ forkContext.add(parentForkContext.makeNext(0, -1));
1511
+
1512
+ /*
1513
+ * Add information about the default case.
1514
+ *
1515
+ * The purpose of this is to identify the starting segments for the
1516
+ * default case to make sure there is a path there.
1517
+ */
1518
+ if (isDefaultCase) {
1519
+ /*
1520
+ * This is the default case in the `switch`.
1521
+ *
1522
+ * We first save the current pointer as `defaultSegments` to point
1523
+ * to the `default` keyword.
1524
+ */
1525
+ context.defaultSegments = parentForkContext.head;
1526
+
1527
+ /*
1528
+ * If the body of the case is empty then we just set
1529
+ * `foundEmptyDefault` to true; otherwise, we save a reference
1530
+ * to the current pointer as `defaultBodySegments`.
1531
+ */
1532
+ if (isCaseBodyEmpty) {
1533
+ context.foundEmptyDefault = true;
1534
+ } else {
1535
+ context.defaultBodySegments = forkContext.head;
1536
+ }
1537
+ } else {
1538
+ /*
1539
+ * This is not the default case in the `switch`.
1540
+ *
1541
+ * If it's not empty and there is already an empty default case found,
1542
+ * that means the default case actually comes before this case,
1543
+ * and that it will fall through to this case. So, we can now
1544
+ * ignore the previous default case (reset `foundEmptyDefault` to false)
1545
+ * and set `defaultBodySegments` to the current segments because this is
1546
+ * effectively the new default case.
1547
+ */
1548
+ if (!isCaseBodyEmpty && context.foundEmptyDefault) {
1549
+ context.foundEmptyDefault = false;
1550
+ context.defaultBodySegments = forkContext.head;
1551
+ }
1552
+ }
1553
+
1554
+ // keep track if the default case ends up last
1555
+ context.lastIsDefault = isDefaultCase;
1556
+ context.forkCount += 1;
1557
+ }
1558
+
1559
+ //--------------------------------------------------------------------------
1560
+ // TryStatement
1561
+ //--------------------------------------------------------------------------
1562
+
1563
+ /**
1564
+ * Creates a context object of TryStatement and stacks it.
1565
+ * @param {boolean} hasFinalizer `true` if the try statement has a
1566
+ * `finally` block.
1567
+ * @returns {void}
1568
+ */
1569
+ pushTryContext(hasFinalizer) {
1570
+ this.tryContext = new TryContext(
1571
+ this.tryContext,
1572
+ hasFinalizer,
1573
+ this.forkContext,
1574
+ );
1575
+ }
1576
+
1577
+ /**
1578
+ * Pops the last context of TryStatement and finalizes it.
1579
+ * @returns {void}
1580
+ */
1581
+ popTryContext() {
1582
+ const context = this.tryContext;
1583
+
1584
+ this.tryContext = context.upper;
1585
+
1586
+ /*
1587
+ * If we're inside the `catch` block, that means there is no `finally`,
1588
+ * so we can process the `try` and `catch` blocks the simple way and
1589
+ * merge their two paths.
1590
+ */
1591
+ if (context.position === "catch") {
1592
+ this.popForkContext();
1593
+ return;
1594
+ }
1595
+
1596
+ /*
1597
+ * The following process is executed only when there is a `finally`
1598
+ * block.
1599
+ */
1600
+
1601
+ const originalReturnedForkContext = context.returnedForkContext;
1602
+ const originalThrownForkContext = context.thrownForkContext;
1603
+
1604
+ // no `return` or `throw` in `try` or `catch` so there's nothing left to do
1605
+ if (
1606
+ originalReturnedForkContext.empty &&
1607
+ originalThrownForkContext.empty
1608
+ ) {
1609
+ return;
1610
+ }
1611
+
1612
+ /*
1613
+ * The following process is executed only when there is a `finally`
1614
+ * block and there was a `return` or `throw` in the `try` or `catch`
1615
+ * blocks.
1616
+ */
1617
+
1618
+ // Separate head to normal paths and leaving paths.
1619
+ const headSegments = this.forkContext.head;
1620
+
1621
+ this.forkContext = this.forkContext.upper;
1622
+ const normalSegments = headSegments.slice(
1623
+ 0,
1624
+ (headSegments.length / 2) | 0,
1625
+ );
1626
+ const leavingSegments = headSegments.slice(
1627
+ (headSegments.length / 2) | 0,
1628
+ );
1629
+
1630
+ // Forwards the leaving path to upper contexts.
1631
+ if (!originalReturnedForkContext.empty) {
1632
+ getReturnContext(this).returnedForkContext.add(leavingSegments);
1633
+ }
1634
+ if (!originalThrownForkContext.empty) {
1635
+ getThrowContext(this).thrownForkContext.add(leavingSegments);
1636
+ }
1637
+
1638
+ // Sets the normal path as the next.
1639
+ this.forkContext.replaceHead(normalSegments);
1640
+
1641
+ /*
1642
+ * If both paths of the `try` block and the `catch` block are
1643
+ * unreachable, the next path becomes unreachable as well.
1644
+ */
1645
+ if (!context.lastOfTryIsReachable && !context.lastOfCatchIsReachable) {
1646
+ this.forkContext.makeUnreachable();
1647
+ }
1648
+ }
1649
+
1650
+ /**
1651
+ * Makes a code path segment for a `catch` block.
1652
+ * @returns {void}
1653
+ */
1654
+ makeCatchBlock() {
1655
+ const context = this.tryContext;
1656
+ const forkContext = this.forkContext;
1657
+ const originalThrownForkContext = context.thrownForkContext;
1658
+
1659
+ /*
1660
+ * We are now in a catch block so we need to update the context
1661
+ * with that information. This includes creating a new fork
1662
+ * context in case we encounter any `throw` statements here.
1663
+ */
1664
+ context.position = "catch";
1665
+ context.thrownForkContext = ForkContext.newEmpty(forkContext);
1666
+ context.lastOfTryIsReachable = forkContext.reachable;
1667
+
1668
+ // Merge the thrown paths from the `try` and `catch` blocks
1669
+ originalThrownForkContext.add(forkContext.head);
1670
+ const thrownSegments = originalThrownForkContext.makeNext(0, -1);
1671
+
1672
+ // Fork to a bypass and the merged thrown path.
1673
+ this.pushForkContext();
1674
+ this.forkBypassPath();
1675
+ this.forkContext.add(thrownSegments);
1676
+ }
1677
+
1678
+ /**
1679
+ * Makes a code path segment for a `finally` block.
1680
+ *
1681
+ * In the `finally` block, parallel paths are created. The parallel paths
1682
+ * are used as leaving-paths. The leaving-paths are paths from `return`
1683
+ * statements and `throw` statements in a `try` block or a `catch` block.
1684
+ * @returns {void}
1685
+ */
1686
+ makeFinallyBlock() {
1687
+ const context = this.tryContext;
1688
+ let forkContext = this.forkContext;
1689
+ const originalReturnedForkContext = context.returnedForkContext;
1690
+ const originalThrownForContext = context.thrownForkContext;
1691
+ const headOfLeavingSegments = forkContext.head;
1692
+
1693
+ // Update state.
1694
+ if (context.position === "catch") {
1695
+ // Merges two paths from the `try` block and `catch` block.
1696
+ this.popForkContext();
1697
+ forkContext = this.forkContext;
1698
+
1699
+ context.lastOfCatchIsReachable = forkContext.reachable;
1700
+ } else {
1701
+ context.lastOfTryIsReachable = forkContext.reachable;
1702
+ }
1703
+
1704
+ context.position = "finally";
1705
+
1706
+ /*
1707
+ * If there was no `return` or `throw` in either the `try` or `catch`
1708
+ * blocks, then there's no further code paths to create for `finally`.
1709
+ */
1710
+ if (
1711
+ originalReturnedForkContext.empty &&
1712
+ originalThrownForContext.empty
1713
+ ) {
1714
+ // This path does not leave.
1715
+ return;
1716
+ }
1717
+
1718
+ /*
1719
+ * Create a parallel segment from merging returned and thrown.
1720
+ * This segment will leave at the end of this `finally` block.
1721
+ */
1722
+ const segments = forkContext.makeNext(-1, -1);
1723
+
1724
+ for (let i = 0; i < forkContext.count; ++i) {
1725
+ const prevSegsOfLeavingSegment = [headOfLeavingSegments[i]];
1726
+
1727
+ for (
1728
+ let j = 0;
1729
+ j < originalReturnedForkContext.segmentsList.length;
1730
+ ++j
1731
+ ) {
1732
+ prevSegsOfLeavingSegment.push(
1733
+ originalReturnedForkContext.segmentsList[j][i],
1734
+ );
1735
+ }
1736
+ for (
1737
+ let j = 0;
1738
+ j < originalThrownForContext.segmentsList.length;
1739
+ ++j
1740
+ ) {
1741
+ prevSegsOfLeavingSegment.push(
1742
+ originalThrownForContext.segmentsList[j][i],
1743
+ );
1744
+ }
1745
+
1746
+ segments.push(
1747
+ CodePathSegment.newNext(
1748
+ this.idGenerator.next(),
1749
+ prevSegsOfLeavingSegment,
1750
+ ),
1751
+ );
1752
+ }
1753
+
1754
+ this.pushForkContext(true);
1755
+ this.forkContext.add(segments);
1756
+ }
1757
+
1758
+ /**
1759
+ * Makes a code path segment from the first throwable node to the `catch`
1760
+ * block or the `finally` block.
1761
+ * @returns {void}
1762
+ */
1763
+ makeFirstThrowablePathInTryBlock() {
1764
+ const forkContext = this.forkContext;
1765
+
1766
+ if (!forkContext.reachable) {
1767
+ return;
1768
+ }
1769
+
1770
+ const context = getThrowContext(this);
1771
+
1772
+ if (
1773
+ context === this ||
1774
+ context.position !== "try" ||
1775
+ !context.thrownForkContext.empty
1776
+ ) {
1777
+ return;
1778
+ }
1779
+
1780
+ context.thrownForkContext.add(forkContext.head);
1781
+ forkContext.replaceHead(forkContext.makeNext(-1, -1));
1782
+ }
1783
+
1784
+ //--------------------------------------------------------------------------
1785
+ // Loop Statements
1786
+ //--------------------------------------------------------------------------
1787
+
1788
+ /**
1789
+ * Creates a context object of a loop statement and stacks it.
1790
+ * @param {string} type The type of the node which was triggered. One of
1791
+ * `WhileStatement`, `DoWhileStatement`, `ForStatement`, `ForInStatement`,
1792
+ * and `ForStatement`.
1793
+ * @param {string|null} label A label of the node which was triggered.
1794
+ * @throws {Error} (Unreachable - unknown type.)
1795
+ * @returns {void}
1796
+ */
1797
+ pushLoopContext(type, label) {
1798
+ const forkContext = this.forkContext;
1799
+
1800
+ // All loops need a path to account for `break` statements
1801
+ const breakContext = this.pushBreakContext(true, label);
1802
+
1803
+ switch (type) {
1804
+ case "WhileStatement":
1805
+ this.pushChoiceContext("loop", false);
1806
+ this.loopContext = new WhileLoopContext(
1807
+ this.loopContext,
1808
+ label,
1809
+ breakContext,
1810
+ );
1811
+ break;
1812
+
1813
+ case "DoWhileStatement":
1814
+ this.pushChoiceContext("loop", false);
1815
+ this.loopContext = new DoWhileLoopContext(
1816
+ this.loopContext,
1817
+ label,
1818
+ breakContext,
1819
+ forkContext,
1820
+ );
1821
+ break;
1822
+
1823
+ case "ForStatement":
1824
+ this.pushChoiceContext("loop", false);
1825
+ this.loopContext = new ForLoopContext(
1826
+ this.loopContext,
1827
+ label,
1828
+ breakContext,
1829
+ );
1830
+ break;
1831
+
1832
+ case "ForInStatement":
1833
+ this.loopContext = new ForInLoopContext(
1834
+ this.loopContext,
1835
+ label,
1836
+ breakContext,
1837
+ );
1838
+ break;
1839
+
1840
+ case "ForOfStatement":
1841
+ this.loopContext = new ForOfLoopContext(
1842
+ this.loopContext,
1843
+ label,
1844
+ breakContext,
1845
+ );
1846
+ break;
1847
+
1848
+ /* c8 ignore next */
1849
+ default:
1850
+ throw new Error(`unknown type: "${type}"`);
1851
+ }
1852
+ }
1853
+
1854
+ /**
1855
+ * Pops the last context of a loop statement and finalizes it.
1856
+ * @throws {Error} (Unreachable - unknown type.)
1857
+ * @returns {void}
1858
+ */
1859
+ popLoopContext() {
1860
+ const context = this.loopContext;
1861
+
1862
+ this.loopContext = context.upper;
1863
+
1864
+ const forkContext = this.forkContext;
1865
+ const brokenForkContext = this.popBreakContext().brokenForkContext;
1866
+
1867
+ // Creates a looped path.
1868
+ switch (context.type) {
1869
+ case "WhileStatement":
1870
+ case "ForStatement":
1871
+ this.popChoiceContext();
1872
+
1873
+ /*
1874
+ * Creates the path from the end of the loop body up to the
1875
+ * location where `continue` would jump to.
1876
+ */
1877
+ makeLooped(
1878
+ this,
1879
+ forkContext.head,
1880
+ context.continueDestSegments,
1881
+ );
1882
+ break;
1883
+
1884
+ case "DoWhileStatement": {
1885
+ const choiceContext = this.popChoiceContext();
1886
+
1887
+ if (!choiceContext.processed) {
1888
+ choiceContext.trueForkContext.add(forkContext.head);
1889
+ choiceContext.falseForkContext.add(forkContext.head);
1890
+ }
1891
+
1892
+ /*
1893
+ * If this isn't a hardcoded `true` condition, then `break`
1894
+ * should continue down the path as if the condition evaluated
1895
+ * to false.
1896
+ */
1897
+ if (context.test !== true) {
1898
+ brokenForkContext.addAll(choiceContext.falseForkContext);
1899
+ }
1900
+
1901
+ /*
1902
+ * When the condition is true, the loop continues back to the top,
1903
+ * so create a path from each possible true condition back to the
1904
+ * top of the loop.
1905
+ */
1906
+ const segmentsList = choiceContext.trueForkContext.segmentsList;
1907
+
1908
+ for (let i = 0; i < segmentsList.length; ++i) {
1909
+ makeLooped(this, segmentsList[i], context.entrySegments);
1910
+ }
1911
+ break;
1912
+ }
1913
+
1914
+ case "ForInStatement":
1915
+ case "ForOfStatement":
1916
+ brokenForkContext.add(forkContext.head);
1917
+
1918
+ /*
1919
+ * Creates the path from the end of the loop body up to the
1920
+ * left expression (left of `in` or `of`) of the loop.
1921
+ */
1922
+ makeLooped(this, forkContext.head, context.leftSegments);
1923
+ break;
1924
+
1925
+ /* c8 ignore next */
1926
+ default:
1927
+ throw new Error("unreachable");
1928
+ }
1929
+
1930
+ /*
1931
+ * If there wasn't a `break` statement in the loop, then we're at
1932
+ * the end of the loop's path, so we make an unreachable segment
1933
+ * to mark that.
1934
+ *
1935
+ * If there was a `break` statement, then we continue on into the
1936
+ * `brokenForkContext`.
1937
+ */
1938
+ if (brokenForkContext.empty) {
1939
+ forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
1940
+ } else {
1941
+ forkContext.replaceHead(brokenForkContext.makeNext(0, -1));
1942
+ }
1943
+ }
1944
+
1945
+ /**
1946
+ * Makes a code path segment for the test part of a WhileStatement.
1947
+ * @param {boolean|undefined} test The test value (only when constant).
1948
+ * @returns {void}
1949
+ */
1950
+ makeWhileTest(test) {
1951
+ const context = this.loopContext;
1952
+ const forkContext = this.forkContext;
1953
+ const testSegments = forkContext.makeNext(0, -1);
1954
+
1955
+ // Update state.
1956
+ context.test = test;
1957
+ context.continueDestSegments = testSegments;
1958
+ forkContext.replaceHead(testSegments);
1959
+ }
1960
+
1961
+ /**
1962
+ * Makes a code path segment for the body part of a WhileStatement.
1963
+ * @returns {void}
1964
+ */
1965
+ makeWhileBody() {
1966
+ const context = this.loopContext;
1967
+ const choiceContext = this.choiceContext;
1968
+ const forkContext = this.forkContext;
1969
+
1970
+ if (!choiceContext.processed) {
1971
+ choiceContext.trueForkContext.add(forkContext.head);
1972
+ choiceContext.falseForkContext.add(forkContext.head);
1973
+ }
1974
+
1975
+ /*
1976
+ * If this isn't a hardcoded `true` condition, then `break`
1977
+ * should continue down the path as if the condition evaluated
1978
+ * to false.
1979
+ */
1980
+ if (context.test !== true) {
1981
+ context.brokenForkContext.addAll(choiceContext.falseForkContext);
1982
+ }
1983
+ forkContext.replaceHead(choiceContext.trueForkContext.makeNext(0, -1));
1984
+ }
1985
+
1986
+ /**
1987
+ * Makes a code path segment for the body part of a DoWhileStatement.
1988
+ * @returns {void}
1989
+ */
1990
+ makeDoWhileBody() {
1991
+ const context = this.loopContext;
1992
+ const forkContext = this.forkContext;
1993
+ const bodySegments = forkContext.makeNext(-1, -1);
1994
+
1995
+ // Update state.
1996
+ context.entrySegments = bodySegments;
1997
+ forkContext.replaceHead(bodySegments);
1998
+ }
1999
+
2000
+ /**
2001
+ * Makes a code path segment for the test part of a DoWhileStatement.
2002
+ * @param {boolean|undefined} test The test value (only when constant).
2003
+ * @returns {void}
2004
+ */
2005
+ makeDoWhileTest(test) {
2006
+ const context = this.loopContext;
2007
+ const forkContext = this.forkContext;
2008
+
2009
+ context.test = test;
2010
+
2011
+ /*
2012
+ * If there is a `continue` statement in the loop then `continueForkContext`
2013
+ * won't be empty. We wire up the path from `continue` to the loop
2014
+ * test condition and then continue the traversal in the root fork context.
2015
+ */
2016
+ if (!context.continueForkContext.empty) {
2017
+ context.continueForkContext.add(forkContext.head);
2018
+ const testSegments = context.continueForkContext.makeNext(0, -1);
2019
+
2020
+ forkContext.replaceHead(testSegments);
2021
+ }
2022
+ }
2023
+
2024
+ /**
2025
+ * Makes a code path segment for the test part of a ForStatement.
2026
+ * @param {boolean|undefined} test The test value (only when constant).
2027
+ * @returns {void}
2028
+ */
2029
+ makeForTest(test) {
2030
+ const context = this.loopContext;
2031
+ const forkContext = this.forkContext;
2032
+ const endOfInitSegments = forkContext.head;
2033
+ const testSegments = forkContext.makeNext(-1, -1);
2034
+
2035
+ /*
2036
+ * Update the state.
2037
+ *
2038
+ * The `continueDestSegments` are set to `testSegments` because we
2039
+ * don't yet know if there is an update expression in this loop. So,
2040
+ * from what we already know at this point, a `continue` statement
2041
+ * will jump back to the test expression.
2042
+ */
2043
+ context.test = test;
2044
+ context.endOfInitSegments = endOfInitSegments;
2045
+ context.continueDestSegments = context.testSegments = testSegments;
2046
+ forkContext.replaceHead(testSegments);
2047
+ }
2048
+
2049
+ /**
2050
+ * Makes a code path segment for the update part of a ForStatement.
2051
+ * @returns {void}
2052
+ */
2053
+ makeForUpdate() {
2054
+ const context = this.loopContext;
2055
+ const choiceContext = this.choiceContext;
2056
+ const forkContext = this.forkContext;
2057
+
2058
+ // Make the next paths of the test.
2059
+ if (context.testSegments) {
2060
+ finalizeTestSegmentsOfFor(context, choiceContext, forkContext.head);
2061
+ } else {
2062
+ context.endOfInitSegments = forkContext.head;
2063
+ }
2064
+
2065
+ /*
2066
+ * Update the state.
2067
+ *
2068
+ * The `continueDestSegments` are now set to `updateSegments` because we
2069
+ * know there is an update expression in this loop. So, a `continue` statement
2070
+ * in the loop will jump to the update expression first, and then to any
2071
+ * test expression the loop might have.
2072
+ */
2073
+ const updateSegments = forkContext.makeDisconnected(-1, -1);
2074
+
2075
+ context.continueDestSegments = context.updateSegments = updateSegments;
2076
+ forkContext.replaceHead(updateSegments);
2077
+ }
2078
+
2079
+ /**
2080
+ * Makes a code path segment for the body part of a ForStatement.
2081
+ * @returns {void}
2082
+ */
2083
+ makeForBody() {
2084
+ const context = this.loopContext;
2085
+ const choiceContext = this.choiceContext;
2086
+ const forkContext = this.forkContext;
2087
+
2088
+ /*
2089
+ * Determine what to do based on which part of the `for` loop are present.
2090
+ * 1. If there is an update expression, then `updateSegments` is not null and
2091
+ * we need to assign `endOfUpdateSegments`, and if there is a test
2092
+ * expression, we then need to create the looped path to get back to
2093
+ * the test condition.
2094
+ * 2. If there is no update expression but there is a test expression,
2095
+ * then we only need to update the test segment information.
2096
+ * 3. If there is no update expression and no test expression, then we
2097
+ * just save `endOfInitSegments`.
2098
+ */
2099
+ if (context.updateSegments) {
2100
+ context.endOfUpdateSegments = forkContext.head;
2101
+
2102
+ /*
2103
+ * In a `for` loop that has both an update expression and a test
2104
+ * condition, execution flows from the test expression into the
2105
+ * loop body, to the update expression, and then back to the test
2106
+ * expression to determine if the loop should continue.
2107
+ *
2108
+ * To account for that, we need to make a path from the end of the
2109
+ * update expression to the start of the test expression. This is
2110
+ * effectively what creates the loop in the code path.
2111
+ */
2112
+ if (context.testSegments) {
2113
+ makeLooped(
2114
+ this,
2115
+ context.endOfUpdateSegments,
2116
+ context.testSegments,
2117
+ );
2118
+ }
2119
+ } else if (context.testSegments) {
2120
+ finalizeTestSegmentsOfFor(context, choiceContext, forkContext.head);
2121
+ } else {
2122
+ context.endOfInitSegments = forkContext.head;
2123
+ }
2124
+
2125
+ let bodySegments = context.endOfTestSegments;
2126
+
2127
+ /*
2128
+ * If there is a test condition, then there `endOfTestSegments` is also
2129
+ * the start of the loop body. If there isn't a test condition then
2130
+ * `bodySegments` will be null and we need to look elsewhere to find
2131
+ * the start of the body.
2132
+ *
2133
+ * The body starts at the end of the init expression and ends at the end
2134
+ * of the update expression, so we use those locations to determine the
2135
+ * body segments.
2136
+ */
2137
+ if (!bodySegments) {
2138
+ const prevForkContext = ForkContext.newEmpty(forkContext);
2139
+
2140
+ prevForkContext.add(context.endOfInitSegments);
2141
+ if (context.endOfUpdateSegments) {
2142
+ prevForkContext.add(context.endOfUpdateSegments);
2143
+ }
2144
+
2145
+ bodySegments = prevForkContext.makeNext(0, -1);
2146
+ }
2147
+
2148
+ /*
2149
+ * If there was no test condition and no update expression, then
2150
+ * `continueDestSegments` will be null. In that case, a
2151
+ * `continue` should skip directly to the body of the loop.
2152
+ * Otherwise, we want to keep the current `continueDestSegments`.
2153
+ */
2154
+ context.continueDestSegments =
2155
+ context.continueDestSegments || bodySegments;
2156
+
2157
+ // move pointer to the body
2158
+ forkContext.replaceHead(bodySegments);
2159
+ }
2160
+
2161
+ /**
2162
+ * Makes a code path segment for the left part of a ForInStatement and a
2163
+ * ForOfStatement.
2164
+ * @returns {void}
2165
+ */
2166
+ makeForInOfLeft() {
2167
+ const context = this.loopContext;
2168
+ const forkContext = this.forkContext;
2169
+ const leftSegments = forkContext.makeDisconnected(-1, -1);
2170
+
2171
+ // Update state.
2172
+ context.prevSegments = forkContext.head;
2173
+ context.leftSegments = context.continueDestSegments = leftSegments;
2174
+ forkContext.replaceHead(leftSegments);
2175
+ }
2176
+
2177
+ /**
2178
+ * Makes a code path segment for the right part of a ForInStatement and a
2179
+ * ForOfStatement.
2180
+ * @returns {void}
2181
+ */
2182
+ makeForInOfRight() {
2183
+ const context = this.loopContext;
2184
+ const forkContext = this.forkContext;
2185
+ const temp = ForkContext.newEmpty(forkContext);
2186
+
2187
+ temp.add(context.prevSegments);
2188
+ const rightSegments = temp.makeNext(-1, -1);
2189
+
2190
+ // Update state.
2191
+ context.endOfLeftSegments = forkContext.head;
2192
+ forkContext.replaceHead(rightSegments);
2193
+ }
2194
+
2195
+ /**
2196
+ * Makes a code path segment for the body part of a ForInStatement and a
2197
+ * ForOfStatement.
2198
+ * @returns {void}
2199
+ */
2200
+ makeForInOfBody() {
2201
+ const context = this.loopContext;
2202
+ const forkContext = this.forkContext;
2203
+ const temp = ForkContext.newEmpty(forkContext);
2204
+
2205
+ temp.add(context.endOfLeftSegments);
2206
+ const bodySegments = temp.makeNext(-1, -1);
2207
+
2208
+ // Make a path: `right` -> `left`.
2209
+ makeLooped(this, forkContext.head, context.leftSegments);
2210
+
2211
+ // Update state.
2212
+ context.brokenForkContext.add(forkContext.head);
2213
+ forkContext.replaceHead(bodySegments);
2214
+ }
2215
+
2216
+ //--------------------------------------------------------------------------
2217
+ // Control Statements
2218
+ //--------------------------------------------------------------------------
2219
+
2220
+ /**
2221
+ * Creates new context in which a `break` statement can be used. This occurs inside of a loop,
2222
+ * labeled statement, or switch statement.
2223
+ * @param {boolean} breakable Indicates if we are inside a statement where
2224
+ * `break` without a label will exit the statement.
2225
+ * @param {string|null} label The label associated with the statement.
2226
+ * @returns {BreakContext} The new context.
2227
+ */
2228
+ pushBreakContext(breakable, label) {
2229
+ this.breakContext = new BreakContext(
2230
+ this.breakContext,
2231
+ breakable,
2232
+ label,
2233
+ this.forkContext,
2234
+ );
2235
+ return this.breakContext;
2236
+ }
2237
+
2238
+ /**
2239
+ * Removes the top item of the break context stack.
2240
+ * @returns {Object} The removed context.
2241
+ */
2242
+ popBreakContext() {
2243
+ const context = this.breakContext;
2244
+ const forkContext = this.forkContext;
2245
+
2246
+ this.breakContext = context.upper;
2247
+
2248
+ // Process this context here for other than switches and loops.
2249
+ if (!context.breakable) {
2250
+ const brokenForkContext = context.brokenForkContext;
2251
+
2252
+ if (!brokenForkContext.empty) {
2253
+ brokenForkContext.add(forkContext.head);
2254
+ forkContext.replaceHead(brokenForkContext.makeNext(0, -1));
2255
+ }
2256
+ }
2257
+
2258
+ return context;
2259
+ }
2260
+
2261
+ /**
2262
+ * Makes a path for a `break` statement.
2263
+ *
2264
+ * It registers the head segment to a context of `break`.
2265
+ * It makes new unreachable segment, then it set the head with the segment.
2266
+ * @param {string|null} label A label of the break statement.
2267
+ * @returns {void}
2268
+ */
2269
+ makeBreak(label) {
2270
+ const forkContext = this.forkContext;
2271
+
2272
+ if (!forkContext.reachable) {
2273
+ return;
2274
+ }
2275
+
2276
+ const context = getBreakContext(this, label);
2277
+
2278
+ if (context) {
2279
+ context.brokenForkContext.add(forkContext.head);
2280
+ }
2281
+
2282
+ /* c8 ignore next */
2283
+ forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
2284
+ }
2285
+
2286
+ /**
2287
+ * Makes a path for a `continue` statement.
2288
+ *
2289
+ * It makes a looping path.
2290
+ * It makes new unreachable segment, then it set the head with the segment.
2291
+ * @param {string|null} label A label of the continue statement.
2292
+ * @returns {void}
2293
+ */
2294
+ makeContinue(label) {
2295
+ const forkContext = this.forkContext;
2296
+
2297
+ if (!forkContext.reachable) {
2298
+ return;
2299
+ }
2300
+
2301
+ const context = getContinueContext(this, label);
2302
+
2303
+ if (context) {
2304
+ if (context.continueDestSegments) {
2305
+ makeLooped(
2306
+ this,
2307
+ forkContext.head,
2308
+ context.continueDestSegments,
2309
+ );
2310
+
2311
+ // If the context is a for-in/of loop, this affects a break also.
2312
+ if (
2313
+ context.type === "ForInStatement" ||
2314
+ context.type === "ForOfStatement"
2315
+ ) {
2316
+ context.brokenForkContext.add(forkContext.head);
2317
+ }
2318
+ } else {
2319
+ context.continueForkContext.add(forkContext.head);
2320
+ }
2321
+ }
2322
+ forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
2323
+ }
2324
+
2325
+ /**
2326
+ * Makes a path for a `return` statement.
2327
+ *
2328
+ * It registers the head segment to a context of `return`.
2329
+ * It makes new unreachable segment, then it set the head with the segment.
2330
+ * @returns {void}
2331
+ */
2332
+ makeReturn() {
2333
+ const forkContext = this.forkContext;
2334
+
2335
+ if (forkContext.reachable) {
2336
+ getReturnContext(this).returnedForkContext.add(forkContext.head);
2337
+ forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
2338
+ }
2339
+ }
2340
+
2341
+ /**
2342
+ * Makes a path for a `throw` statement.
2343
+ *
2344
+ * It registers the head segment to a context of `throw`.
2345
+ * It makes new unreachable segment, then it set the head with the segment.
2346
+ * @returns {void}
2347
+ */
2348
+ makeThrow() {
2349
+ const forkContext = this.forkContext;
2350
+
2351
+ if (forkContext.reachable) {
2352
+ getThrowContext(this).thrownForkContext.add(forkContext.head);
2353
+ forkContext.replaceHead(forkContext.makeUnreachable(-1, -1));
2354
+ }
2355
+ }
2356
+
2357
+ /**
2358
+ * Makes the final path.
2359
+ * @returns {void}
2360
+ */
2361
+ makeFinal() {
2362
+ const segments = this.currentSegments;
2363
+
2364
+ if (segments.length > 0 && segments[0].reachable) {
2365
+ this.returnedForkContext.add(segments);
2366
+ }
2367
+ }
2346
2368
  }
2347
2369
 
2348
2370
  module.exports = CodePathState;