├── .editorconfig
├── .github
    ├── ISSUE_TEMPLATE
    │   └── broken_syntax_highlighting.md
    ├── PULL_REQUEST_TEMPLATE
    │   └── simple_pull_request.md
    └── workflows
    │   └── continuous-integration.yml
├── .gitignore
├── .vscode
    ├── launch.json
    └── tasks.json
├── LICENSE
├── README.md
├── build
    ├── build.ts
    ├── helpers.ts
    ├── tsconfig.json
    └── types.ts
├── grammars
    ├── Ink-Visual-Studio.tmLanguage
    ├── Ink.YAML-tmLanguage
    └── Ink.tmLanguage
├── package-lock.json
├── package.json
├── tests
    ├── cases
    │   ├── bindings
    │   │   ├── external_binding.ink
    │   │   ├── game_ink_back_and_forth.ink
    │   │   └── variable_observer.ink
    │   ├── builtins
    │   │   ├── floor_ceiling_and_casts.ink
    │   │   ├── read_count_across_callstack.ink
    │   │   ├── read_count_across_threads.ink
    │   │   ├── read_count_dot_separated_path.ink
    │   │   ├── read_count_variable_target.ink
    │   │   ├── turns.ink
    │   │   ├── turns_since.ink
    │   │   ├── turns_since_nested.ink
    │   │   ├── turns_since_with_variable_target.ink
    │   │   └── visit_counts_when_choosing.ink
    │   ├── callstack
    │   │   ├── call_stack_evaluation.ink
    │   │   └── clean_callstack_reset_on_path_choice.ink
    │   ├── choices
    │   │   ├── choice_count.ink
    │   │   ├── choice_diverts_to_done.ink
    │   │   ├── choice_thread_forking.ink
    │   │   ├── choice_with_brackets_only.ink
    │   │   ├── conditional_choices.ink
    │   │   ├── default_choices.ink
    │   │   ├── default_simple_gather.ink
    │   │   ├── fallback_choice_on_thread.ink
    │   │   ├── gather_choice_same_line.ink
    │   │   ├── has_read_on_choice.ink
    │   │   ├── logic_in_choices.ink
    │   │   ├── non_text_in_choice_inner_content.ink
    │   │   ├── once_only_choices_can_link_back_to_self.ink
    │   │   ├── once_only_choices_with_own_content.ink
    │   │   ├── should_not_gather_due_to_choice.ink
    │   │   ├── sticky_choices_stay_sticky.ink
    │   │   └── various_default_choices.ink
    │   ├── conditions
    │   │   └── conditionals.ink
    │   ├── diverts
    │   │   ├── basic_tunnel.ink
    │   │   ├── compare_divert_targets.ink
    │   │   ├── complex_tunnels.ink
    │   │   ├── divert_in_conditional.ink
    │   │   ├── divert_targets_with_parameters.ink
    │   │   ├── divert_to_weave_points.ink
    │   │   ├── done_stops_thread.ink
    │   │   ├── path_to_self.ink
    │   │   ├── same_line_divert_is_inline.ink
    │   │   ├── tunnel_onwards_after_tunnel.ink
    │   │   ├── tunnel_onwards_divert_after_with_arg.ink
    │   │   ├── tunnel_onwards_divert_override.ink
    │   │   ├── tunnel_onwards_with_param_default_choice.ink
    │   │   └── tunnel_vs_thread_behaviour.ink
    │   ├── evaluation
    │   │   ├── arithmetic.ink
    │   │   ├── basic_string_literals.ink
    │   │   └── evaluating_function_variable_state_bug.ink
    │   ├── extra
    │   │   ├── gather_tunnel_threads.ink
    │   │   ├── knot_stitch_function_declaration.ink
    │   │   ├── tags.ink
    │   │   ├── todo.ink
    │   │   └── variable_declarations.ink
    │   └── glue
    │   │   └── simple_glue.ink
    ├── tsonfig.json
    └── visual-inspection
    │   ├── evaluation
    │       ├── evaluating_ink_functions_from_game.ink
    │       ├── evaluating_ink_functions_from_game_2.ink
    │       ├── evaluation_stack_leaks.ink
    │       ├── factorial_by_reference.ink
    │       ├── factorial_recursive.ink
    │       ├── increment.ink
    │       └── literal_unary.ink
    │   ├── lists
    │       ├── empty_list_origin.ink
    │       ├── empty_list_origin_after_assignment.ink
    │       ├── list_basic_operations.ink
    │       ├── list_mixed_items.ink
    │       ├── list_random.ink
    │       ├── list_range.ink
    │       ├── list_save_load.ink
    │       └── more_list_operations.ink
    │   ├── logic
    │       ├── logic_lines_with_newlines.ink
    │       ├── multiline_logic_with_glue.ink
    │       ├── nested_pass_by_reference.ink
    │       └── print_num.ink
    │   ├── misc
    │       ├── empty.ink
    │       ├── end.ink
    │       ├── end2.ink
    │       ├── end_of_content.ink
    │       ├── escape_character.ink
    │       ├── hello_world.ink
    │       ├── identifiers_can_start_with_number.ink
    │       ├── include.ink
    │       ├── includes
    │       │   ├── included_file.ink
    │       │   ├── included_file_2.ink
    │       │   ├── included_file_3.ink
    │       │   └── included_file_4.ink
    │       ├── nested_include.ink
    │       ├── quote_character_significance.ink
    │       └── whitespace.ink
    │   ├── newlines
    │       ├── newline_at_start_of_multiline_conditional.ink
    │       ├── newline_consistency_1.ink
    │       ├── newline_consistency_2.ink
    │       ├── newline_consistency_3.ink
    │       ├── newlines_trimming_with_func_external_fallback.ink
    │       └── newlines_with_string_eval.ink
    │   ├── sequences
    │       ├── all_sequences_types.ink
    │       ├── blanks_in_inline_sequences.ink
    │       ├── empty_sequence_content.ink
    │       ├── gather_read_count_with_initial_sequence.ink
    │       ├── leading_newline_multiline_sequence.ink
    │       └── shuffle_stack_muddying.ink
    │   ├── stories
    │       ├── LD41 Emoji.ink
    │       ├── The Intercept.ink
    │       ├── extra_knots.ink
    │       ├── include.ink
    │       ├── include_2.ink
    │       ├── lists.ink
    │       └── test.ink
    │   ├── strings
    │       ├── string_constants.ink
    │       ├── string_contains.ink
    │       ├── string_type_coercion.ink
    │       └── strings_in_choices.ink
    │   ├── threads
    │       ├── multi_thread.ink
    │       ├── thread_done.ink
    │       ├── thread_in_logic.ink
    │       └── top_flow_terminator_should_not_kill_thread_choices.ink
    │   ├── variables
    │       ├── const.ink
    │       ├── multiple_constant_references.ink
    │       ├── set_non_existant_variable.ink
    │       ├── temp_global_conflict.ink
    │       ├── temp_not_found.ink
    │       ├── temp_usage_in_options.ink
    │       ├── temporaries_at_global_scope.ink
    │       ├── variable_declaration_in_conditional.ink
    │       ├── variable_divert_target.ink
    │       ├── variable_get_set_api.ink
    │       ├── variable_pointer_ref_from_knot.ink
    │       ├── variable_swap_recurse.ink
    │       ├── warn_variable_not_found_1.ink
    │       └── warn_variable_not_found_2.ink
    │   ├── weaves
    │       ├── conditional_choice_in_weave.ink
    │       ├── conditional_choice_in_weave_2.ink
    │       ├── unbalanced_weave_indentation.ink
    │       ├── weave_gathers.ink
    │       ├── weave_options.ink
    │       └── weave_within_sequence.ink
    │   └── writing_with_ink
    │       ├── part_1_1.ink
    │       ├── part_1_2.ink
    │       ├── part_1_3.ink
    │       ├── part_1_4.ink
    │       ├── part_1_5.ink
    │       ├── part_1_6.ink
    │       ├── part_1_7.ink
    │       ├── part_1_8.ink
    │       ├── part_1_9.ink
    │       ├── part_2_1.ink
    │       ├── part_2_2.ink
    │       ├── part_2_3.ink
    │       ├── part_3_1.ink
    │       ├── part_3_2.ink
    │       ├── part_3_3.ink
    │       ├── part_3_4.ink
    │       ├── part_3_5.ink
    │       ├── part_3_6.ink
    │       ├── part_4_1.ink
    │       ├── part_4_2.ink
    │       ├── part_5_1.ink
    │       ├── part_5_2.ink
    │       ├── part_5_3.ink
    │       ├── part_5_4.ink
    │       ├── part_5_5.ink
    │       ├── part_5_6.ink
    │       ├── part_5_7.ink
    │       └── part_5_8.ink
└── tslint.json


/.editorconfig:
--------------------------------------------------------------------------------
 1 | 
 2 | root = true
 3 | 
 4 | [*]
 5 | end_of_line = lf
 6 | insert_final_newline = true
 7 | charset = utf-8
 8 | 
 9 | 
10 | [*.{js,ts}]
11 | indent_style = space
12 | indent_size = 2
13 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/broken_syntax_highlighting.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Broken syntax highlighting
 3 | about: Create a report to help us improve the grammar
 4 | ---
 5 | 
 6 | ## Describe where the syntax highlighting breaks
 7 | <!-- A clear and concise description of what causes the syntax highlighting to break -->
 8 | 
 9 | ## Ink snippet
10 | <!--
11 |     A quick snippet desmonstrating the issue is critical to fix it.
12 |     Put the code below, between the backticks.
13 | -->
14 | ```
15 | 
16 | ```
17 | 
18 | ## Environment
19 |  - OS: <!-- e.g. Windows / macOS / Linux Distribution -->
20 |  - Editor (Version): <!-- e.g. Textmate (2.0.0) -->
21 | 
22 | <!-- Delete non applicable items -->
23 | 
24 | <!--
25 |     This is only applicable if you imported the grammar manually,
26 |     if you used an editor extension, see below.
27 | -->
28 |  - Grammar version:
29 | <!-- ----------------------------------------------------------------------- -->
30 |  - Editor extension:
31 | <!--
32 |     Link to the editor extension and specify its version.
33 |     e. g. sequitur/ink-vscode 0.1.0
34 | -->
35 | 
36 | ## Additional context
37 | <!-- Add any other context about the problem here. -->
38 | 


--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE/simple_pull_request.md:
--------------------------------------------------------------------------------
1 | ### Checklist
2 | 
3 | - [ ] I have added new tests to cover the changes made by this PR (Only if applicable).
4 | - [ ] I have run the tests (`npm test`) and made sure my addition passed them.
5 | 
6 | ### Description
7 | 
8 | <!-- Please describe your pull request. ->
9 | 


--------------------------------------------------------------------------------
/.github/workflows/continuous-integration.yml:
--------------------------------------------------------------------------------
 1 | name: build
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |     - master
 7 |   pull_request:
 8 |     branches:
 9 |     - master
10 | 
11 | jobs:
12 |   test:
13 |     name: Build & test
14 |     runs-on: ubuntu-18.04
15 | 
16 |     steps:
17 |       - name: Check out the repository
18 |         uses: actions/checkout@v2
19 | 
20 |       - name: Install dependencies
21 |         run: npm install
22 | 
23 |       - name: Build
24 |         run: npm run-script build
25 | 
26 |       - name: Test
27 |         run: npm test
28 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | ## Node
 2 | 
 3 | # Logs
 4 | logs
 5 | *.log
 6 | npm-debug.log*
 7 | yarn-debug.log*
 8 | yarn-error.log*
 9 | 
10 | # Runtime data
11 | pids
12 | *.pid
13 | *.seed
14 | *.pid.lock
15 | 
16 | # Directory for instrumented libs generated by jscoverage/JSCover
17 | lib-cov
18 | 
19 | # Coverage directory used by tools like istanbul
20 | coverage
21 | 
22 | # nyc test coverage
23 | .nyc_output
24 | 
25 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
26 | .grunt
27 | 
28 | # Bower dependency directory (https://bower.io/)
29 | bower_components
30 | 
31 | # node-waf configuration
32 | .lock-wscript
33 | 
34 | # Compiled binary addons (https://nodejs.org/api/addons.html)
35 | build/Release
36 | 
37 | # Dependency directories
38 | node_modules/
39 | jspm_packages/
40 | 
41 | # TypeScript v1 declaration files
42 | typings/
43 | 
44 | # Optional npm cache directory
45 | .npm
46 | 
47 | # Optional eslint cache
48 | .eslintcache
49 | 
50 | # Optional REPL history
51 | .node_repl_history
52 | 
53 | # Output of 'npm pack'
54 | *.tgz
55 | 
56 | # Yarn Integrity file
57 | .yarn-integrity
58 | 
59 | # dotenv environment variables file
60 | .env
61 | 
62 | # parcel-bundler cache (https://parceljs.org/)
63 | .cache
64 | 
65 | # next.js build output
66 | .next
67 | 
68 | # nuxt.js build output
69 | .nuxt
70 | 
71 | # vuepress build output
72 | .vuepress/dist
73 | 
74 | # Serverless directories
75 | .serverless
76 | 
77 | ## Project
78 | 
79 | build/*.js
80 | *.snap
81 | playground.ink
82 | 


--------------------------------------------------------------------------------
/.vscode/launch.json:
--------------------------------------------------------------------------------
 1 | // A launch configuration that launches the extension inside a new window
 2 | // Use IntelliSense to learn about possible attributes.
 3 | // Hover to view descriptions of existing attributes.
 4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 5 | {
 6 |   "version": "0.2.0",
 7 |   "configurations": [
 8 |     {
 9 |       "type": "node",
10 |       "request": "launch",
11 |       "name": "Jest All",
12 |       "program": "${workspaceFolder}/node_modules/.bin/jest",
13 |       "args": ["--runInBand"],
14 |       "console": "integratedTerminal",
15 |       "internalConsoleOptions": "neverOpen",
16 |       "disableOptimisticBPs": true,
17 |       "windows": {
18 |         "program": "${workspaceFolder}/node_modules/jest/bin/jest",
19 |       }
20 |     },
21 |     {
22 |       "type": "node",
23 |       "request": "launch",
24 |       "name": "Jest Current File",
25 |       "program": "${workspaceFolder}/node_modules/.bin/jest",
26 |       "args": [
27 |         "${fileBasenameNoExtension}",
28 |         "--config",
29 |         "jest.config.js"
30 |       ],
31 |       "console": "integratedTerminal",
32 |       "internalConsoleOptions": "neverOpen",
33 |       "disableOptimisticBPs": true,
34 |       "windows": {
35 |         "program": "${workspaceFolder}/node_modules/jest/bin/jest",
36 |       }
37 |     },
38 |   ]
39 | }
40 | 


--------------------------------------------------------------------------------
/.vscode/tasks.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   // See https://go.microsoft.com/fwlink/?LinkId=733558
 3 |   // for the documentation about the tasks.json format
 4 |   "version": "2.0.0",
 5 |   "tasks": [
 6 |     {
 7 |       "label": "Test all files",
 8 |       "type": "shell",
 9 |       "command": "npx vscode-tmgrammar-test -c -s source.ink -g grammars/Ink.tmLanguage -t \"tests/cases/**/*.ink\"",
10 |       "group": "test",
11 |       "presentation": {
12 |         "reveal": "always",
13 |         "panel":"new"
14 |       },
15 |       "problemMatcher": {
16 |         "fileLocation": [
17 |           "relative",
18 |           "${workspaceFolder}"
19 |         ],
20 |         "pattern": [
21 |           {
22 |             "regexp": "^(ERROR)\\s([^:]+):(\\d+):(\\d+):(\\d+)\\s(.*)$",
23 |             "severity": 1,
24 |             "file": 2,
25 |             "line": 3,
26 |             "column": 4,
27 |             "endColumn": 5,
28 |             "message": 6
29 |           }
30 |         ]
31 |       }
32 |     },
33 |     {
34 |       "label": "Test current file",
35 |       "type": "shell",
36 |       "command": "npx vscode-tmgrammar-test -c -s source.ink -g grammars/Ink.tmLanguage -t ${file}",
37 |       "group": "test",
38 |       "presentation": {
39 |         "reveal": "always",
40 |         "panel":"new"
41 |       },
42 |       "problemMatcher": {
43 |         "fileLocation": [
44 |           "relative",
45 |           "${workspaceFolder}"
46 |         ],
47 |         "pattern": [
48 |           {
49 |             "regexp": "^(ERROR)\\s([^:]+):(\\d+):(\\d+):(\\d+)\\s(.*)$",
50 |             "severity": 1,
51 |             "file": 2,
52 |             "line": 3,
53 |             "column": 4,
54 |             "endColumn": 5,
55 |             "message": 6
56 |           }
57 |         ]
58 |       }
59 |     }
60 |   ]
61 | }
62 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2018-present Frédéric Maquin <fred@ephread.com>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # ![Ink TMLanguage](https://i.imgur.com/oLMOVfq.png)
  2 | 
  3 | [![Build Status](https://github.com/inkle/ink-tmlanguage/workflows/build/badge.svg)](https://github.com/inkle/ink-tmlanguage/actions)
  4 | [![npm version](https://img.shields.io/npm/v/ink-tmlanguage.svg)](https://www.npmjs.com/package/ink-tmlanguage)
  5 | [![Licence](https://img.shields.io/npm/l/ink-tmlanguage.svg)](https://github.com/inkle/ink-tmlanguage/blob/master/LICENSE)
  6 | [![Dependencies](https://david-dm.org/ephread/ink-tmlanguage/status.svg)](https://david-dm.org/inkle/ink-tmlanguage)
  7 | 
  8 | Brings syntax highlighting for inkle's Ink, in your editor of choice (as long as
  9 | it supports TextMate grammars).
 10 | 
 11 | If you're just looking for the plist-based grammar, head over to the [releases](https://github.com/inkle/ink-tmlanguage/releases)!
 12 | 
 13 | ## Table of contents
 14 | 
 15 |   * [Building the grammar](#building-the-grammar)
 16 |   * [Limitations](#limitations)
 17 |   * [Building a custom theme](#building-a-custom-theme)
 18 |   * [Availability through NPM](#availability-through-npm)
 19 |   * [Contributing](#contributing)
 20 |   * [License](#license)
 21 | 
 22 | ## Building the grammar
 23 | 
 24 | The grammar is written using the `YAML-tmLanguage` format, with a couple of
 25 | additions borrowed from [TypeScript-TmLanguage](https://github.com/Microsoft/TypeScript-TmLanguage).
 26 | 
 27 | Building the grammar is easy, you need the latest version of node.js and your favourite npm-compatible package manager.
 28 | 
 29 | 1. clone this repository;
 30 | 2. run `npm install` or `yarn install`;
 31 | 3. run `npm run build` or `yarn run build`;
 32 | 4. the `Ink.tmLanguage` file should be available in `grammars/`.
 33 | 
 34 | ## Limitations
 35 | 
 36 | ### `{ }` constructs
 37 | 
 38 | In Ink, `{ }` can be an alternative, a sequence, a switch, a conditional, etc.
 39 | Since TextMate grammars can only match one line at a time, there are some small limitations.
 40 | 
 41 | #### Expressions
 42 | 
 43 | Expressions will not be fully highlighted in conditionals.
 44 | Anything contained in the condition (before `:`) is named with the same scope.
 45 | 
 46 | ```ink
 47 | { x == 0: Hello }
 48 | { x == 0: Hello | hi }
 49 | { x == 0:
 50 | 	Hello
 51 |   - else:
 52 |   	Hi
 53 | }
 54 | {
 55 | 	- x == 0:
 56 | 		Hello
 57 | }
 58 | { window_opts < 2 || learnt(fingerprints_on_glass) || GlassState ? steamed:
 59 | 	I looked away from the dreary glass.
 60 | }
 61 | ```
 62 | 
 63 | This is not the case in the following example, where all expression tokens are named with their own scopes.
 64 | 
 65 | ```ink
 66 | ~ y = (x == 0)
 67 | ~ myFunction(x == 0)
 68 | ```
 69 | 
 70 | Additionally, while the following is perfectly valid ink, there's a false positive on both `else:` and `then:`.
 71 | 
 72 | ```ink
 73 | {conditional()}
 74 | {conditional()}
 75 | {conditional()}
 76 | {conditional()}
 77 | 
 78 | === function conditional() ===
 79 | {once:
 80 |   - if condition
 81 |   - then: do this
 82 |   - else: do that
 83 |   - end
 84 | }
 85 | ```
 86 | 
 87 | This limitation can be worked around by escaping the colon:
 88 | 
 89 | ```ink
 90 | === function conditional() ===
 91 | {once:
 92 |   - if condition
 93 |   - then\: do this
 94 |   - else\: do that
 95 |   - end
 96 | }
 97 | ```
 98 | 
 99 | ### Choices
100 | 
101 | In choice, it's sometimes possible for the content to be expressed on the next line
102 | if it's preceded by a condition. In the example below, the text supression of
103 | the first choice will not be highlighted, as it won't be matched as part of the choice.
104 | The second choice will however be highlighted properly.
105 | 
106 | ```ink
107 | VAR x = 0
108 | 
109 | * (firstChoice) {x == 0}
110 | "Hello John Doe[."], I need to tell you something special"
111 | 
112 | * (secondChoice) {x != 0} "Hello John Doe[."], I won't say a word"
113 | ```
114 | 
115 | ## Building a custom theme
116 | 
117 | All the captures support the generic scopes recommended by the [Sublime Text documentation](https://www.sublimetext.com/docs/3/scope_naming.html), narrowed down to `.ink`. This means that the grammar will work out of box with existing themes.
118 | 
119 | Most of the captures are multi-scoped, with the first scope defined by the theme being used. Some of these multi-scoped captures support ink-specific scopes, which can be implemented by your custom theme. They are described below:
120 | 
121 | - `string.label.ink` → `(label)`
122 | - `entity.tag.ink` → `#tag`
123 | - `entity.todo.ink` → `TODO`
124 | - `keyword.glue.ink` → `<>`
125 | - `keyword.choice.ink` → `*`
126 | - `keyword.choice.sticky.ink` → `+`
127 | - `keyword.choice.suppression.ink` → `[ ]`
128 | - `keyword.logic.ink` → `~`
129 | - `keyword.gather.ink` → `-`
130 | - `keyword.divert.ink` → `->` or `<-`
131 | - `keyword.alternative.type.ink` → `&` or `~` or `!` inside `{ }`
132 | - `storage.knot.ink` → Identifier after / between `=`
133 | - `variable.other.knot.ink` → a knot identifier in a divert
134 | - `variable.other.stitch.ink` → a stitch identifier in a divert
135 | - `variable.other.label.ink` → a label identifier in a divert
136 | 
137 | ## Availability through npm
138 | 
139 | As a convenience, the grammar is also available through the npm registry.
140 | If you're building an extension for Atom or VS Code, you may want to depend on this package.
141 | 
142 | Once installed, the grammar can be found in `node_modules/ink-tmlanguage/grammars/Ink.tmLanguage`.
143 | 
144 | ## Contributing
145 | 
146 | If the grammar is missing something, open an issue or fix it and submit a pull request!
147 | When working on the grammar, you may want to use `npm run watch`, which will rebuild the plist grammar on every change.
148 | 
149 | ## License
150 | 
151 | The grammar is released under the MIT license. See LICENSE for details.
152 | 
153 | This project borrows some code from [TypeScript-TmLanguage](https://github.com/Microsoft/TypeScript-TmLanguage), licensed under the [MIT license](https://github.com/Microsoft/TypeScript-TmLanguage/blob/4a620294f8652e4e3a4a605308650a52773ccec6/LICENSE.txt).
154 | 


--------------------------------------------------------------------------------
/build/build.ts:
--------------------------------------------------------------------------------
 1 | // Parts of file were originally extracted from the
 2 | // TypeScript-TMLanguage project.
 3 | // https://github.com/Microsoft/TypeScript-TmLanguage
 4 | //
 5 | // The original code is licensed under the MIT License
 6 | // Copyright (c) Microsoft Corporation
 7 | // All rights reserved.
 8 | 
 9 | import * as Fs from "fs";
10 | import * as Yaml from "js-yaml";
11 | import * as Path from "path";
12 | import * as Plist from "plist";
13 | import { VariableReplacer, updateGrammarVariables } from './helpers';
14 | 
15 | enum GrammarName {
16 |   Generic = "Ink",
17 |   VisualStudio = "Ink-Visual-Studio"
18 | }
19 | 
20 | enum Extension {
21 |   TmLanguage = "tmLanguage",
22 |   YamlTmLangauge = "YAML-tmLanguage"
23 | }
24 | 
25 | /* ************************************************************************** */
26 | 
27 | /**
28 |  * Build a file path from the given `name` and `extension`.
29 |  *
30 |  * @param name name of the grammar
31 |  * @param extension extension of the grammar
32 |  */
33 | function file(name: GrammarName, extension: Extension) {
34 |   return Path.join(__dirname, "..", "grammars", `${name}.${extension}`);
35 | }
36 | 
37 | /**
38 |  * Write the given `grammar` as a TextMate Grammar plist.
39 |  *
40 |  * @param grammar the grammar to write
41 |  * @param fileName a path to which to write the grammar
42 |  */
43 | function writePlistFile(grammar: TmGrammar | TmTheme, fileName: string) {
44 |   const text = Plist.build(grammar);
45 |   Fs.writeFileSync(fileName, text);
46 | }
47 | 
48 | /**
49 |  * Load a YAML file from the given path.
50 |  *
51 |  * @param fileName the path at which the YAML file can be found
52 |  */
53 | function readYaml(fileName: string) {
54 |   const text = Fs.readFileSync(fileName, "utf8");
55 |   return Yaml.load(text);
56 | }
57 | 
58 | /**
59 |  * Load and perform variable subtitution in the YAML grammar.
60 |  *
61 |  * @param scopeReplacementRules an optional set of rules to replace scopes
62 |  */
63 | export function getGrammar(scopeReplacementRules?: VariableReplacer[]) {
64 |   const filePath = file(GrammarName.Generic, Extension.YamlTmLangauge);
65 |   const grammar = readYaml(filePath) as TmGrammar;
66 | 
67 |   if (scopeReplacementRules) {
68 |     return updateGrammarVariables(grammar, scopeReplacementRules);
69 |   } else {
70 |     return updateGrammarVariables(grammar);
71 |   }
72 | }
73 | 
74 | /* ************************************************************************** */
75 | 
76 | function buildGenericGrammar() {
77 |   const tsGrammar = getGrammar();
78 |   writePlistFile(tsGrammar, file(GrammarName.Generic, Extension.TmLanguage));
79 | }
80 | 
81 | function buildVisualStudioGrammar() {
82 |   const scopeReplacementRules: VariableReplacer[] = [
83 |     [new RegExp("(?<!\.)variable\.other\.ink(?!\.)"), "entity.name.variable.other.ink"],
84 |     [new RegExp("(?<!\.)variable\.function\.ink(?!\.)"), "entity.name.function.ink"]
85 |   ];
86 | 
87 |   const tsGrammar = getGrammar(scopeReplacementRules);
88 |   writePlistFile(tsGrammar, file(GrammarName.VisualStudio, Extension.TmLanguage));
89 | }
90 | 
91 | buildGenericGrammar();
92 | buildVisualStudioGrammar();
93 | 


--------------------------------------------------------------------------------
/build/helpers.ts:
--------------------------------------------------------------------------------
  1 | // Parts of file were originally extracted from the
  2 | // TypeScript-TMLanguage project.
  3 | // https://github.com/Microsoft/TypeScript-TmLanguage
  4 | //
  5 | // The original code is licensed under the MIT License
  6 | // Copyright (c) Microsoft Corporation
  7 | // All rights reserved.
  8 | 
  9 | // tslint:disable:no-shadowed-variable
 10 | // tslint:disable:forin
 11 | 
 12 | export type VariableReplacer = [RegExp, string];
 13 | 
 14 | /* ************************************************************************** */
 15 | 
 16 | /**
 17 |  * Replace all the patterns (`{{variableName}}`) with the values defined in
 18 |  * `grammar.variables`.
 19 |  *
 20 |  * @param grammar the grammar to transform
 21 |  * @param scopeReplacementRules an optional set of rules used to
 22 |  *                              replace entire scopes.
 23 |  */
 24 | export function updateGrammarVariables(
 25 |   grammar: TmGrammar,
 26 |   scopeReplacementRules?: VariableReplacer[]
 27 | ) {
 28 |   // Keep a copy of the variable for later use and delete them from the grammar.
 29 |   const variables = grammar.variables;
 30 | 
 31 |   const variableReplacers: VariableReplacer[] = [];
 32 |   for (const variableName in variables) {
 33 |     // Replace the pattern with earlier variables
 34 |     const pattern = replacePatternVariables(
 35 |       variables[variableName],
 36 |       variableReplacers
 37 |     );
 38 | 
 39 |     // When a variable is resolved, it's added to replacers. Then it can be used
 40 |     // if another variable depends on it.
 41 |     variableReplacers.push([new RegExp(`{{${variableName}}}`, "gim"), pattern]);
 42 |   }
 43 | 
 44 |   transformGrammarRepository(
 45 |     grammar,
 46 |     ["begin", "end", "match"],
 47 |     pattern => replacePatternVariables(pattern, variableReplacers),
 48 |   );
 49 | 
 50 |   if (scopeReplacementRules) {
 51 |     transformGrammarRepository(
 52 |       grammar,
 53 |       ["name"],
 54 |       pattern => replaceScopes(pattern, scopeReplacementRules)
 55 |     );
 56 |   }
 57 | 
 58 |   return grammar;
 59 | }
 60 | 
 61 | /**
 62 |  * If a declared variable itself depends on other variables, this
 63 |  * function performs the substitutions, so that the variable is
 64 |  * fully resolved.
 65 |  *
 66 |  * @param pattern the variable name
 67 |  * @param variableReplacers a list of replacers, which is expected to
 68 |  *                          grow each time a new variable is resolved.
 69 |  */
 70 | function replacePatternVariables(
 71 |   pattern: string,
 72 |   variableReplacers: VariableReplacer[]
 73 | ) {
 74 |   let result = pattern;
 75 |   for (const [variableName, value] of variableReplacers) {
 76 |     result = result.replace(variableName, value);
 77 |   }
 78 |   return result;
 79 | }
 80 | 
 81 | function replaceScopes(
 82 |   pattern: string,
 83 |   scopeReplacementRules: VariableReplacer[]
 84 | ) {
 85 |   let result = pattern;
 86 |   for (const [variableName, value] of scopeReplacementRules) {
 87 |     result = result.replace(variableName, value);
 88 |   }
 89 |   return result;
 90 | }
 91 | 
 92 | /**
 93 |  * In each rule of the repository, substitute variables for the given
 94 |  * `propertyNames` using `transformProperty`.
 95 |  *
 96 |  * @param grammar
 97 |  * @param propertyNames
 98 |  * @param transformProperty
 99 |  */
100 | function transformGrammarRepository(
101 |   grammar: TmGrammar,
102 |   propertyNames: string[],
103 |   transformProperty: (ruleProperty: string) => string,
104 |   replaceScopes?: (ruleProperty: string) => string
105 | ) {
106 |   const repository = grammar.repository;
107 |   for (const key in repository) {
108 |     transformGrammarRule(repository[key], propertyNames, transformProperty);
109 |   }
110 | 
111 |   if (replaceScopes) {
112 |     for (const key in repository) {
113 |       transformGrammarRule(repository[key], propertyNames, replaceScopes);
114 |     }
115 |   }
116 | }
117 | 
118 | /**
119 |  * Look into the `rule` and then recursively perform transformations for
120 |  * the given `propertyNames` using `transformProperty`.
121 |  *
122 |  * @param rule
123 |  * @param propertyNames
124 |  * @param transformProperty
125 |  */
126 | function transformGrammarRule(
127 |   rule: Record<string, any>,
128 |   propertyNames: string[],
129 |   transformProperty: (ruleProperty: string) => string,
130 | ) {
131 |   for (const propertyName of propertyNames) {
132 |     const value = rule[propertyName];
133 |     if (typeof value === "string") {
134 |       rule[propertyName] = transformProperty(value);
135 |     }
136 |   }
137 | 
138 |   for (const propertyName in rule) {
139 |     const value = rule[propertyName];
140 |     if (typeof value === "object") {
141 |       transformGrammarRule(value, propertyNames, transformProperty);
142 |     }
143 |   }
144 | }
145 | 


--------------------------------------------------------------------------------
/build/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "compilerOptions": {
 3 |         "module": "commonjs",
 4 |         "target": "es5",
 5 |         "strict": true
 6 |     },
 7 |     "exclude": [
 8 |         "node_modules"
 9 |     ]
10 | }


--------------------------------------------------------------------------------
/build/types.ts:
--------------------------------------------------------------------------------
 1 | // This file was originally extracted from the TypeScript-TMLanguage project.
 2 | // https://github.com/Microsoft/TypeScript-TmLanguage
 3 | //
 4 | // The original code is licensed under the MIT License
 5 | // Copyright (c) Microsoft Corporation
 6 | // All rights reserved.
 7 | 
 8 | declare module "plist" {
 9 |     export function build(json: any): string;
10 | }
11 | 
12 | declare interface MapLike<T> {
13 |     [s: string]: T;
14 | }
15 | 
16 | declare interface TmGrammarRuleName {
17 |     name: string;
18 | }
19 | 
20 | declare interface TmGrammarRule {
21 |     name?: string;
22 | }
23 | declare interface TmGrammarMatchRule extends TmGrammarRule {
24 |     match: string;
25 |     captures: MapLike<TmGrammarRuleName>;
26 | }
27 | declare interface TmGrammarBeginEndRule extends TmGrammarRule {
28 |     contentName?: string;
29 |     begin: string;
30 |     end: string;
31 |     beginCaptures?: MapLike<TmGrammarRuleName>;
32 |     endCaptures?: MapLike<TmGrammarRuleName>;
33 |     patterns: AnyTmGrammarRule[];
34 | }
35 | declare interface TmGrammarIncludeRule extends TmGrammarRule {
36 |     include: string;
37 | }
38 | declare type AnyTmGrammarRule = TmGrammarMatchRule | TmGrammarBeginEndRule | TmGrammarIncludeRule;
39 | declare interface TmGrammarRepositoryPatterns {
40 |     patterns: AnyTmGrammarRule[];
41 | }
42 | declare type TmGrammarRepositaryRule = AnyTmGrammarRule | TmGrammarRepositoryPatterns;
43 | declare interface TmGrammar {
44 |     name: string;
45 |     scopeName: string;
46 |     fileTypes: string[];
47 |     uuid: string;
48 |     variables: MapLike<string>;
49 |     patterns?: AnyTmGrammarRule[];
50 |     repository: MapLike<TmGrammarRepositaryRule>;
51 | }
52 | 
53 | declare interface TmThemeSetting {
54 |     scope: string;
55 |     settings: { vsclassificationtype: string; };
56 | }
57 | declare interface TmTheme {
58 |     name: string;
59 |     uuid: string;
60 |     settings: TmThemeSetting[];
61 | }
62 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "ink-tmlanguage",
 3 |   "version": "0.2.3",
 4 |   "description": "TextMate grammar files for Ink. (VS Code, Sublime Text, and Atom)",
 5 |   "keywords": [
 6 |     "ink",
 7 |     "inkle",
 8 |     "inky",
 9 |     "TextMate Language",
10 |     "TMLanguage",
11 |     "TextMate Grammar",
12 |     "Grammar",
13 |     "Syntax Highlighting"
14 |   ],
15 |   "homepage": "https://github.com/inkle/ink-tmlanguage#readme",
16 |   "bugs": {
17 |     "url": "https://github.com/inkle/ink-tmlanguage/issues"
18 |   },
19 |   "repository": {
20 |     "type": "git",
21 |     "url": "git+https://github.com/inkle/ink-tmlanguage.git"
22 |   },
23 |   "license": "MIT",
24 |   "author": "Frédéric Maquin <fred@ephread.com> (https://ephread.com/)",
25 |   "files": [
26 |     "grammars/Ink.tmLanguage"
27 |   ],
28 |   "scripts": {
29 |     "build": "tsc -p build && node build/build.js",
30 |     "prepublishOnly": "npm run build",
31 |     "watch": "npm run build && chokidar 'grammars/*.YAML-tmLanguage' -c 'npm run build'",
32 |     "test": "npx vscode-tmgrammar-test -c -s source.ink -g grammars/Ink.tmLanguage -t 'tests/cases/**/*.ink'"
33 |   },
34 |   "devDependencies": {
35 |     "@types/jest": "^27.4.0",
36 |     "@types/js-yaml": "^4.0.5",
37 |     "@types/node": "^17.0.8",
38 |     "chokidar": "^3.5.2",
39 |     "chokidar-cli": "^3.0.0",
40 |     "js-yaml": "^4.1.0",
41 |     "plist": "^3.0.4",
42 |     "typescript": "^4.5.4",
43 |     "vscode-textmate": "^6.0.0",
44 |     "vscode-tmgrammar-test": "0.0.11"
45 |   }
46 | }
47 | 


--------------------------------------------------------------------------------
/tests/cases/bindings/external_binding.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | EXTERNAL message(x)
 4 | //<----- storage.type.external.ink
 5 | //      ^ source.ink
 6 | //       ^^^^^^^ entity.name.function.ink
 7 | //              ^ punctuation.section.parens.begin.ink
 8 | //               ^ variable.parameter.function.ink
 9 | //                ^ punctuation.section.parens.end.ink
10 | EXTERNAL multiply(x,y)
11 | //<----- storage.type.external.ink
12 | //      ^ source.ink
13 | //       ^^^^^^^^ entity.name.function.ink
14 | //               ^ punctuation.section.parens.begin.ink
15 | //                ^ variable.parameter.function.ink
16 | //                 ^ punctuation.separator.ink
17 | //                  ^ variable.parameter.function.ink
18 | //                   ^ punctuation.section.parens.end.ink
19 | EXTERNAL times(i,str)
20 | //<----- storage.type.external.ink
21 | //      ^ source.ink
22 | //       ^^^^^ entity.name.function.ink
23 | //            ^ punctuation.section.parens.begin.ink
24 | //             ^ variable.parameter.function.ink
25 | //              ^ punctuation.separator.ink
26 | //               ^^^ variable.parameter.function.ink
27 | //                  ^ punctuation.section.parens.end.ink
28 | ~ message("hello world")
29 | //<~ keyword.logic.ink
30 | //<~- source.ink
31 | //^^^^^^^ variable.function.ink
32 | //       ^ source.ink
33 | //        ^ punctuation.definition.string.begin.ink
34 | //         ^^^^^^^^^^^ string.quoted.double.ink
35 | //                    ^ punctuation.definition.string.end.ink
36 | //                     ^ source.ink
37 | {multiply(5.0, 3)}
38 | //<- keyword.control.ink
39 | //<~---------------- keyword.control.ink
40 | //               ^ keyword.control.ink
41 | {times(3, "knock ")}
42 | //<- keyword.control.ink
43 | //<~------------------ keyword.control.ink
44 | //                 ^ keyword.control.ink
45 | 


--------------------------------------------------------------------------------
/tests/cases/bindings/game_ink_back_and_forth.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | EXTERNAL gameInc(x)
 4 | //<-------- storage.type.external.ink
 5 | //       ^^^^^^^ entity.name.function.ink
 6 | //              ^ punctuation.section.parens.begin.ink
 7 | //               ^ variable.parameter.function.ink
 8 | //                ^ punctuation.section.parens.end.ink
 9 | == function topExternal(x)
10 | //<-- storage.knot.ink storage.type.ink
11 | // ^^^^^^^^ storage.type.ink
12 | //          ^^^^^^^^^^^ entity.name.function.ink
13 | //                     ^ punctuation.section.parens.begin.ink
14 | //                      ^ variable.parameter.function.ink
15 | //                       ^ punctuation.section.parens.end.ink
16 | In top external
17 | //<---------------- source.ink
18 | ~ return gameInc(x)
19 | //<- keyword.logic.ink
20 | //<~- source.ink
21 | //^^^^^^ keyword.control.ink
22 | //       ^^^^^^^ variable.function.ink
23 | //              ^ source.ink
24 | //               ^ variable.other.ink
25 | //                ^ source.ink
26 | == function inkInc(x)
27 | //<-- storage.knot.ink storage.type.ink
28 | // ^^^^^^^^ storage.type.ink
29 | //          ^^^^^^ entity.name.function.ink
30 | //                ^ punctuation.section.parens.begin.ink
31 | //                 ^ variable.parameter.function.ink
32 | //                  ^ punctuation.section.parens.end.ink
33 | ~ return x + 1
34 | //<- keyword.logic.ink
35 | //<~- source.ink
36 | //^^^^^^ keyword.control.ink
37 | //       ^  variable.other.ink
38 | //         ^ keyword.operator.arithmetic.ink
39 | //           ^ constant.numeric.ink
40 | 


--------------------------------------------------------------------------------
/tests/cases/bindings/variable_observer.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | VAR testVar = 5
 4 | //<--- storage.type.ink storage.type.var.ink
 5 | // ^ source.ink
 6 | //  ^^^^^^^ variable.other.ink
 7 | //         ^ source.ink
 8 | //          ^ keyword.operator.assignment.ink
 9 | //           ^ source.ink
10 | //            ^ constant.numeric.ink
11 | VAR testVar2 = 10
12 | //<--- storage.type.ink storage.type.var.ink
13 | // ^ source.ink
14 | //  ^^^^^^^^ variable.other.ink
15 | //          ^ source.ink
16 | //           ^ keyword.operator.assignment.ink
17 | //            ^ source.ink
18 | //             ^^ constant.numeric.ink
19 | Hello world!
20 | //<------------ source.ink
21 | ~ testVar = 15
22 | //<- keyword.logic.ink
23 | //<~- source.ink
24 | //^^^^^^^ variable.other.ink
25 | //        ^ keyword.operator.assignment.ink
26 | //         ^ source.ink
27 | //          ^^ constant.numeric.ink
28 | ~ testVar2 = 100
29 | //<- keyword.logic.ink
30 | //<~- source.ink
31 | //^^^^^^^^ variable.other.ink
32 | //         ^ keyword.operator.assignment.ink
33 | //          ^ source.ink
34 | //           ^^^ constant.numeric.ink
35 | Hello world 2!
36 | //<-------------- source.ink
37 | * choice
38 | //<- keyword.choice.ink
39 | //^^^^^^^ source.ink
40 |     ~ testVar = 25
41 | //<---- source.ink
42 | //  ^ keyword.logic.ink
43 | //   ^ source.ink
44 | //    ^^^^^^^  variable.other.ink
45 | //            ^ keyword.operator.assignment.ink
46 | //             ^ source.ink
47 | //              ^^ constant.numeric.ink
48 |     ~ testVar2 = 200
49 | //<---- source.ink
50 | //  ^ keyword.logic.ink
51 | //   ^ source.ink
52 | //    ^^^^^^^^  variable.other.ink
53 | //             ^ keyword.operator.assignment.ink
54 | //              ^ source.ink
55 | //               ^^^ constant.numeric.ink
56 |     -> END
57 | //<---- source.ink
58 | //  ^^ keyword.divert.ink keyword.other.ink
59 | //    ^ source.ink
60 | //     ^^^ support.constant.ink
61 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/floor_ceiling_and_casts.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | {FLOOR(1.2)}
 4 | //<- keyword.control.ink
 5 | //<---------- keyword.control.ink
 6 | //         ^ keyword.control.ink
 7 | {INT(1.2)}
 8 | //<- keyword.control.ink
 9 | //<-------- keyword.control.ink
10 | //       ^ keyword.control.ink
11 | {CEILING(1.2)}
12 | //<- keyword.control.ink
13 | //<------------ keyword.control.ink
14 | //           ^ keyword.control.ink
15 | {CEILING(1.2) / 3}
16 | //<- keyword.control.ink
17 | //<---------------- keyword.control.ink
18 | //               ^ keyword.control.ink
19 | {INT(CEILING(1.2)) / 3}
20 | //<- keyword.control.ink
21 | //<--------------------- keyword.control.ink
22 | //                    ^ keyword.control.ink
23 | {FLOOR(1)}
24 | //<- keyword.control.ink
25 | //<-------- keyword.control.ink
26 | //     ^ keyword.control.ink
27 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/read_count_across_callstack.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> first
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^^ variable.other.knot.ink
 7 | == first ==
 8 | //<-- storage.knot.ink storage.type.ink
 9 | //^ source.ink
10 | // ^^^^^ entity.name.function.ink
11 | //      ^ source.ink
12 | //       ^^ storage.knot.ink storage.type.ink
13 | 1) Seen first {first} times.
14 | //<-------------- source.ink
15 | //            ^ keyword.control.ink
16 | //            ^^^^^^ keyword.control.ink
17 | //                  ^ keyword.control.ink
18 | //                   ^^^^^^^^ source.ink
19 | -> second ->
20 | //<-- keyword.divert.ink keyword.other.ink
21 | //^ source.ink
22 | // ^^^^^^ variable.other.knot.ink
23 | //       ^ source.ink
24 | //        ^^ keyword.divert.ink keyword.other.ink
25 | 2) Seen first {first} times.
26 | //<-------------- source.ink
27 | //            ^ keyword.control.ink
28 | //             ^^^^^ keyword.control.ink
29 | //                  ^ keyword.control.ink
30 | //                   ^^^^^^^^ source.ink
31 | -> DONE
32 | //<-- keyword.divert.ink keyword.other.ink
33 | //^ source.ink
34 | // ^^^^ support.constant.ink
35 | == second ==
36 | //<-- storage.knot.ink storage.type.ink
37 | //^ source.ink
38 | // ^^^^^^ entity.name.function.ink
39 | //       ^ source.ink
40 | //        ^^ storage.knot.ink storage.type.ink
41 | In second.
42 | //<---------- source.ink
43 | ->->
44 | //<-- keyword.divert.ink keyword.other.ink
45 | //^^ keyword.divert.ink keyword.other.ink
46 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/read_count_across_threads.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 |     -> top
 4 | //<---- source.ink
 5 | //  ^^ keyword.divert.ink keyword.other.ink
 6 | //    ^ source.ink
 7 | //     ^^^ variable.other.knot.ink
 8 | = top
 9 | //<- storage.knot.ink storage.type.ink
10 | //<~- source.ink
11 | //^^^ entity.name.function.ink
12 |     {top}
13 | //  ^ keyword.control.ink
14 | //   ^^^ keyword.control.ink
15 | //      ^ keyword.control.ink
16 |     <- aside
17 | //  ^^ keyword.divert.ink keyword.other.ink
18 | //    ^ source.ink
19 | //     ^^^^^ variable.other.knot.ink
20 |     {top}
21 | //  ^ keyword.control.ink
22 | //   ^^^ keyword.control.ink
23 | //      ^ keyword.control.ink
24 |     -> DONE
25 | //<---- source.ink
26 | //  ^^ keyword.divert.ink keyword.other.ink
27 | //    ^ source.ink
28 | //     ^^^^ support.constant.ink
29 | = aside
30 | //<- storage.knot.ink storage.type.ink
31 | //<~- source.ink
32 | //^^^^^ entity.name.function.ink
33 |     * {false} DONE
34 | //<---- source.ink
35 | //  ^  keyword.choice.ink
36 | //    ^ keyword.control.ink
37 | //     ^^^^^ keyword.control.ink
38 | //          ^ keyword.control.ink
39 | //           ^^^^^^ source.ink
40 |     - -> DONE
41 | //<---- source.ink
42 | //  ^  keyword.gather.ink
43 | //    ^^ keyword.divert.ink keyword.other.ink
44 | //      ^ source.ink
45 | //       ^^^^ support.constant.ink
46 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/read_count_dot_separated_path.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> hi ->
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^ variable.other.knot.ink
 7 | //   ^ source.ink
 8 | //    ^^ keyword.divert.ink keyword.other.ink
 9 | -> hi ->
10 | //<-- keyword.divert.ink keyword.other.ink
11 | //^ source.ink
12 | // ^^ variable.other.knot.ink
13 | //   ^ source.ink
14 | //    ^^ keyword.divert.ink keyword.other.ink
15 | -> hi ->
16 | //<-- keyword.divert.ink keyword.other.ink
17 | //^ source.ink
18 | // ^^ variable.other.knot.ink
19 | //   ^ source.ink
20 | //    ^^ keyword.divert.ink keyword.other.ink
21 | { hi.stitch_to_count }
22 | //<- keyword.control.ink
23 | //<-------------------- keyword.control.ink
24 | //                   ^ keyword.control.ink
25 | == hi ==
26 | //<-- storage.knot.ink storage.type.ink
27 | //^ source.ink
28 | // ^^ entity.name.function.ink
29 | //   ^ source.ink
30 | //    ^^ storage.knot.ink storage.type.ink
31 | = stitch_to_count
32 | //<- storage.knot.ink storage.type.ink
33 | //<~- source.ink
34 | //^^^^^^^^^^^^^^^ entity.name.function.ink
35 | hi
36 | //<-- source.ink
37 | ->->
38 | //<-- keyword.divert.ink keyword.other.ink
39 | //^^ keyword.divert.ink keyword.other.ink
40 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/read_count_variable_target.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | VAR x = ->knot
 4 | //<--- storage.type.ink storage.type.var.ink
 5 | // ^ source.ink
 6 | //  ^ variable.other.ink
 7 | //   ^ source.ink
 8 | //    ^ keyword.operator.assignment.ink
 9 | //     ^ source.ink
10 | //      ^^ keyword.divert.ink keyword.other.ink
11 | //        ^^^^ variable.other.knot.ink
12 | Count start: {READ_COUNT (x)} {READ_COUNT (-> knot)} {knot}
13 | //<------------- source.ink
14 | //           ^ keyword.control.ink
15 | //            ^^^^^^^^^^^^^^^ keyword.control.ink
16 | //                           ^ source.ink
17 | //                            ^^^^^^^^^^^^^^^^^^^^^ keyword.control.ink
18 | //                                                 ^ keyword.control.ink
19 | //                                                   ^ keyword.control.ink
20 | //                                                    ^^^^ keyword.control.ink
21 | //                                                        ^ keyword.control.ink
22 | -> x (1) ->
23 | //<-- keyword.divert.ink keyword.other.ink
24 | //^ source.ink
25 | // ^ variable.function.ink
26 | //  ^^^ source.ink
27 | //     ^ source.ink
28 | //      ^ source.ink
29 | //       ^^ keyword.divert.ink keyword.other.ink
30 | -> x (2) ->
31 | //<-- keyword.divert.ink keyword.other.ink
32 | //^ source.ink
33 | // ^ variable.function.ink
34 | //  ^^^ source.ink
35 | //     ^ source.ink
36 | //      ^ source.ink
37 | //       ^^ keyword.divert.ink keyword.other.ink
38 | -> x (3) ->
39 | //<-- keyword.divert.ink keyword.other.ink
40 | //^ source.ink
41 | // ^ variable.function.ink
42 | //  ^^^ source.ink
43 | //     ^ source.ink
44 | //      ^ source.ink
45 | //       ^^ keyword.divert.ink keyword.other.ink
46 | Count end: {READ_COUNT (x)} {READ_COUNT (-> knot)} {knot}
47 | //<----------- source.ink
48 | //         ^ keyword.control.ink
49 | //          ^^^^^^^^^^^^^^ keyword.control.ink
50 | //                        ^ keyword.control.ink
51 | //                         ^ source.ink
52 | //                          ^ keyword.control.ink
53 | //                           ^^^^^^^^^^^^^^^^^^^^ keyword.control.ink
54 | //                                               ^ keyword.control.ink
55 | //                                                ^ source.ink
56 | //                                                 ^ keyword.control.ink
57 | //                                                  ^^^^ keyword.control.ink
58 | //                                                      ^ keyword.control.ink
59 | -> END
60 | //<-- keyword.divert.ink keyword.other.ink
61 | //^ source.ink
62 | // ^^^ support.constant.ink
63 | == knot (a) ==
64 | //<-- storage.knot.ink storage.type.ink
65 | //^ source.ink
66 | // ^^^^ entity.name.function.ink
67 | //     ^ source.ink
68 | //      ^ punctuation.section.parens.begin.ink
69 | //       ^ variable.parameter.function.ink
70 | //        ^ punctuation.section.parens.end.ink
71 | //         ^ source.ink
72 | //          ^^ storage.knot.ink storage.type.ink
73 | {a}
74 | //<- keyword.control.ink
75 | //<~- keyword.control.ink
76 | //^ keyword.control.ink
77 | ->->
78 | //<-- keyword.divert.ink keyword.other.ink
79 | //^^ keyword.divert.ink keyword.other.ink
80 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/turns.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> c
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^ variable.other.knot.ink
 7 | - (top)
 8 | //<- keyword.gather.ink
 9 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
10 | // ^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
11 | //    ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
12 | + (c) [choice]
13 | //<- keyword.choice.sticky.ink
14 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
15 | // ^ string.label.ink entity.name.label.ink string.quoted.other.ink
16 | //  ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
17 | //   ^ source.ink
18 | //    ^ keyword.choice.suppression.ink keyword.control.ink
19 | //     ^^^^^^ source.ink
20 | //           ^ keyword.choice.suppression.ink keyword.control.ink
21 |     {TURNS ()}
22 | //<---- source.ink
23 | //  ^ keyword.control.ink
24 | //   ^^^^^^^^ keyword.control.ink
25 | //           ^ keyword.control.ink
26 |     -> top
27 | //<---- source.ink
28 | //  ^^ keyword.divert.ink keyword.other.ink
29 | //    ^ source.ink
30 | //     ^^^ variable.other.knot.ink
31 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/turns_since.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | { TURNS_SINCE(-> test) }
 4 | //<- keyword.control.ink
 5 | //<---------------------- keyword.control.ink
 6 | //                     ^ keyword.control.ink
 7 | ~ test()
 8 | //<- keyword.logic.ink
 9 | //<~- source.ink
10 | //^^^^ variable.function.ink
11 | //    ^^ source.ink
12 | { TURNS_SINCE(-> test) }
13 | //<- keyword.control.ink
14 | //<---------------------- keyword.control.ink
15 | //                     ^ keyword.control.ink
16 | * [choice 1]
17 | //<- keyword.choice.ink
18 | //^ keyword.choice.suppression.ink keyword.control.ink
19 | // ^^^^^^^^ source.ink
20 | //         ^ keyword.choice.suppression.ink keyword.control.ink
21 | - { TURNS_SINCE(-> test) }
22 | //<- keyword.gather.ink
23 | //^ keyword.control.ink
24 | // ^^^^^^^^^^^^^^^^^^^^^^ keyword.control.ink
25 | //                       ^ keyword.control.ink
26 | * [choice 2]
27 | //<- keyword.choice.ink
28 | //^ keyword.choice.suppression.ink keyword.control.ink
29 | // ^^^^^^^^ source.ink
30 | //         ^ keyword.choice.suppression.ink keyword.control.ink
31 | - { TURNS_SINCE(-> test) }
32 | //<- keyword.gather.ink
33 | //^ keyword.control.ink
34 | // ^^^^^^^^^^^^^^^^^^^^^^ keyword.control.ink
35 | //                       ^ keyword.control.ink
36 | == function test ==
37 | //<-- storage.knot.ink storage.type.ink
38 | //^ source.ink
39 | // ^^^^^^^^ storage.type.ink
40 | //         ^ source.ink
41 | //          ^^^^ entity.name.function.ink
42 | //              ^ source.ink
43 | //               ^^ storage.knot.ink storage.type.ink
44 | ~ return
45 | //<- keyword.logic.ink
46 | //<~- source.ink
47 | //^^^^^^ keyword.control.ink
48 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/turns_since_nested.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> empty_world
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^^^^^^^^ variable.other.knot.ink
 7 | === empty_world ===
 8 | //<--- storage.knot.ink storage.type.ink
 9 | // ^ source.ink
10 | //  ^^^^^^^^^^^ entity.name.function.ink
11 | //             ^ source.ink
12 | //              ^^^ storage.knot.ink storage.type.ink
13 |     {TURNS_SINCE(-> then)} = -1
14 | //<---- source.ink
15 | //  ^ keyword.control.ink
16 | //   ^^^^^^^^^^^^^^^^^^^^ keyword.control.ink
17 | //                       ^ keyword.control.ink
18 | //                        ^^^^^^ source.ink
19 |     * (then) stuff
20 | //<---- source.ink
21 | //  ^  keyword.choice.ink
22 | //    ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
23 | //     ^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
24 | //         ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
25 | //          ^^^^^^^ source.ink
26 |         {TURNS_SINCE(-> then)} = 0
27 | //<-------- source.ink
28 | //      ^ keyword.control.ink
29 | //       ^^^^^^^^^^^^^^^^^^^^ keyword.control.ink
30 | //                           ^ keyword.control.ink
31 | //                            ^^^^^ source.ink
32 |         * * (next) more stuff
33 | //<-------- source.ink
34 | //      ^^^  keyword.choice.ink
35 | //          ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
36 | //           ^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
37 | //               ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
38 | //                ^^^^^^^^^^^^ source.ink
39 |             {TURNS_SINCE(-> then)} = 1
40 | //<------------ source.ink
41 | //          ^ keyword.control.ink
42 | //           ^^^^^^^^^^^^^^^^^^^^ keyword.control.ink
43 | //                               ^ keyword.control.ink
44 | //                                ^^^^^ source.ink
45 |         -> DONE
46 | //<-------- source.ink
47 | //      ^^ keyword.divert.ink keyword.other.ink
48 | //        ^ source.ink
49 | //         ^^^^ support.constant.ink
50 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/turns_since_with_variable_target.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> start
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^^ variable.other.knot.ink
 7 | === start ===
 8 | //<--- storage.knot.ink storage.type.ink
 9 | // ^ source.ink
10 | //  ^^^^^ entity.name.function.ink
11 | //       ^ source.ink
12 | //        ^^^ storage.knot.ink storage.type.ink
13 |     {beats(-> start)}
14 | //<---- source.ink
15 | //  ^ keyword.control.ink
16 | //   ^^^^^^^^^^^^^^^ keyword.control.ink
17 | //                  ^ keyword.control.ink
18 |     {beats(-> start)}
19 | //<---- source.ink
20 | //  ^ keyword.control.ink
21 | //   ^^^^^^^^^^^^^^^ keyword.control.ink
22 | //                  ^ keyword.control.ink
23 |     *   [Choice]  -> next
24 | //<---- source.ink
25 | //  ^    keyword.choice.ink
26 | //      ^ keyword.choice.suppression.ink keyword.control.ink
27 | //       ^^^^^^ source.ink
28 | //             ^ keyword.choice.suppression.ink keyword.control.ink
29 | //              ^^ source.ink
30 | //                ^^ keyword.divert.ink keyword.other.ink
31 | //                  ^ source.ink
32 | //                   ^^^^ variable.other.knot.ink
33 | = next
34 | //<- storage.knot.ink storage.type.ink
35 | //<~- source.ink
36 | //^^^^ entity.name.function.ink
37 |     {beats(-> start)}
38 | //<---- source.ink
39 | //  ^ keyword.control.ink
40 | //   ^^^^^^^^^^^^^^^ keyword.control.ink
41 | //                  ^ keyword.control.ink
42 |     -> END
43 | //<---- source.ink
44 | //  ^^ keyword.divert.ink keyword.other.ink
45 | //    ^ source.ink
46 | //     ^^^ support.constant.ink
47 | === function beats(x) ===
48 | //<--- storage.knot.ink storage.type.ink
49 | // ^ source.ink
50 | //  ^^^^^^^^ storage.type.ink
51 | //          ^ source.ink
52 | //           ^^^^^ entity.name.function.ink
53 | //                ^ punctuation.section.parens.begin.ink
54 | //                 ^ variable.parameter.function.ink
55 | //                  ^ punctuation.section.parens.end.ink
56 | //                   ^ source.ink
57 | //                    ^^^ storage.knot.ink storage.type.ink
58 |     ~ return TURNS_SINCE(x)
59 | //<---- source.ink
60 | //  ^ keyword.logic.ink
61 | //   ^ source.ink
62 | //    ^^^^^^ keyword.control.ink
63 | //          ^ source.ink
64 | //           ^^^^^^^^^^^ constant.language.ink
65 | //                      ^  punctuation.section.parens.begin.ink
66 | //                       ^ variable.other.ink
67 | //                        ^  punctuation.section.parens.end.ink
68 | 


--------------------------------------------------------------------------------
/tests/cases/builtins/visit_counts_when_choosing.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | == TestKnot ==
 4 | //<-- storage.knot.ink storage.type.ink
 5 | //^ source.ink
 6 | // ^^^^^^^^ entity.name.function.ink
 7 | //         ^ source.ink
 8 | //          ^^ storage.knot.ink storage.type.ink
 9 | this is a test
10 | //<-------------- source.ink
11 | + [Next] -> TestKnot2
12 | //<- keyword.choice.sticky.ink
13 | //^ keyword.choice.suppression.ink keyword.control.ink
14 | // ^^^^ source.ink
15 | //     ^ keyword.choice.suppression.ink keyword.control.ink
16 | //      ^ source.ink
17 | //       ^^ keyword.divert.ink keyword.other.ink
18 | //         ^ source.ink
19 | //          ^^^^^^^^^ variable.other.knot.ink
20 | == TestKnot2 ==
21 | //<-- storage.knot.ink storage.type.ink
22 | //^ source.ink
23 | // ^^^^^^^^^ entity.name.function.ink
24 | //          ^ source.ink
25 | //           ^^ storage.knot.ink storage.type.ink
26 | this is the end
27 | //<--------------- source.ink
28 | -> END
29 | //<-- keyword.divert.ink keyword.other.ink
30 | //^ source.ink
31 | // ^^^ support.constant.ink
32 | 


--------------------------------------------------------------------------------
/tests/cases/callstack/call_stack_evaluation.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 |     { six() + two() }
 4 | //<---- source.ink
 5 | //  ^ keyword.control.ink
 6 | //   ^^^^^^^^^^^^^^^ keyword.control.ink
 7 | //                  ^ keyword.control.ink
 8 |     -> END
 9 | //<---- source.ink
10 | //  ^^ keyword.divert.ink keyword.other.ink
11 | //    ^ source.ink
12 | //     ^^^ support.constant.ink
13 | === function six
14 | //<--- storage.knot.ink storage.type.ink
15 | // ^ source.ink
16 | //  ^^^^^^^^ storage.type.ink
17 | //          ^ source.ink
18 | //           ^^^ entity.name.function.ink
19 |     ~ return four() + two()
20 | //<---- source.ink
21 | //  ^ keyword.logic.ink
22 | //   ^ source.ink
23 | //    ^^^^^^ keyword.control.ink
24 | //          ^ source.ink
25 | //           ^^^^ variable.function.ink
26 | //               ^  punctuation.section.parens.begin.ink
27 | //                ^  punctuation.section.parens.end.ink
28 | //                 ^ source.ink
29 | //                  ^ keyword.operator.arithmetic.ink
30 | //                   ^ source.ink
31 | //                    ^^^ variable.function.ink
32 | //                       ^  punctuation.section.parens.begin.ink
33 | //                        ^  punctuation.section.parens.end.ink
34 | === function four
35 | //<--- storage.knot.ink storage.type.ink
36 | // ^ source.ink
37 | //  ^^^^^^^^ storage.type.ink
38 | //          ^ source.ink
39 | //           ^^^^ entity.name.function.ink
40 |     ~ return two() + two()
41 | //<---- source.ink
42 | //  ^ keyword.logic.ink
43 | //   ^ source.ink
44 | //    ^^^^^^ keyword.control.ink
45 | //          ^ source.ink
46 | //           ^^^ variable.function.ink
47 | //              ^  punctuation.section.parens.begin.ink
48 | //               ^  punctuation.section.parens.end.ink
49 | //                ^ source.ink
50 | //                 ^ keyword.operator.arithmetic.ink
51 | //                  ^ source.ink
52 | //                   ^^^ variable.function.ink
53 | //                      ^  punctuation.section.parens.begin.ink
54 | //                       ^  punctuation.section.parens.end.ink
55 | === function two
56 | //<--- storage.knot.ink storage.type.ink
57 | // ^ source.ink
58 | //  ^^^^^^^^ storage.type.ink
59 | //          ^ source.ink
60 | //           ^^^ entity.name.function.ink
61 |     ~ return 2
62 | //<---- source.ink
63 | //  ^ keyword.logic.ink
64 | //   ^ source.ink
65 | //    ^^^^^^ keyword.control.ink
66 | //          ^ source.ink
67 | //           ^ constant.numeric.ink
68 | 


--------------------------------------------------------------------------------
/tests/cases/callstack/clean_callstack_reset_on_path_choice.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | {RunAThing()}
 4 | //<- keyword.control.ink
 5 | //<----------- keyword.control.ink
 6 | //          ^ keyword.control.ink
 7 | == function RunAThing ==
 8 | //<-- storage.knot.ink storage.type.ink
 9 | //^ source.ink
10 | // ^^^^^^^^ storage.type.ink
11 | //         ^ source.ink
12 | //          ^^^^^^^^^ entity.name.function.ink
13 | //                   ^ source.ink
14 | //                    ^^ storage.knot.ink storage.type.ink
15 | The first line.
16 | //<--------------- source.ink
17 | The second line.
18 | //<---------------- source.ink
19 | == SomewhereElse ==
20 | //<-- storage.knot.ink storage.type.ink
21 | //^ source.ink
22 | // ^^^^^^^^^^^^^ entity.name.function.ink
23 | //              ^ source.ink
24 | //               ^^ storage.knot.ink storage.type.ink
25 | {"somewhere else"}
26 | //^ keyword.control.ink
27 | //<---------------- keyword.control.ink
28 | //               ^ keyword.control.ink
29 | ->END
30 | //<-- keyword.divert.ink keyword.other.ink
31 | //^^^ support.constant.ink
32 | 
33 | 


--------------------------------------------------------------------------------
/tests/cases/choices/choice_count.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | <- choices
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^^^^ variable.other.knot.ink
 7 | { CHOICE_COUNT() }
 8 | //^ keyword.control.ink
 9 | //<---------------- keyword.control.ink
10 | //               ^ keyword.control.ink
11 | = end
12 | //<- storage.knot.ink storage.type.ink
13 | //<~- source.ink
14 | //^^^ entity.name.function.ink
15 | -> END
16 | //<-- keyword.divert.ink keyword.other.ink
17 | //^ source.ink
18 | // ^^^ support.constant.ink
19 | = choices
20 | //<- storage.knot.ink storage.type.ink
21 | //<~- source.ink
22 | //^^^^^^^ entity.name.function.ink
23 | * one -> end
24 | //<- keyword.choice.ink
25 | //^^^ source.ink
26 | //   ^ source.ink
27 | //    ^^ keyword.divert.ink keyword.other.ink
28 | //      ^ source.ink
29 | //       ^^^ variable.other.knot.ink
30 | * two -> end
31 | //<- keyword.choice.ink
32 | //^^^ source.ink
33 | //   ^ source.ink
34 | //    ^^ keyword.divert.ink keyword.other.ink
35 | //      ^ source.ink
36 | //       ^^^ variable.other.knot.ink
37 | 


--------------------------------------------------------------------------------
/tests/cases/choices/choice_diverts_to_done.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | * choice -> DONE
 4 | //<- keyword.choice.ink
 5 | //^^^^^^ source.ink
 6 | //      ^ source.ink
 7 | //       ^^ keyword.divert.ink keyword.other.ink
 8 | //         ^ source.ink
 9 | //          ^^^^ support.constant.ink
10 | 


--------------------------------------------------------------------------------
/tests/cases/choices/choice_thread_forking.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> generate_choice(1) ->
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^^^^^^^^^^^^ variable.function.ink
 7 | //                ^^ source.ink
 8 | //                  ^ source.ink
 9 | //                   ^ source.ink
10 | //                    ^^ keyword.divert.ink keyword.other.ink
11 | == generate_choice(x) ==
12 | //<-- storage.knot.ink storage.type.ink
13 | //^ source.ink
14 | // ^^^^^^^^^^^^^^^ entity.name.function.ink
15 | //                ^ punctuation.section.parens.begin.ink
16 | //                 ^ variable.parameter.function.ink
17 | //                  ^ punctuation.section.parens.end.ink
18 | //                   ^ source.ink
19 | //                    ^^ storage.knot.ink storage.type.ink
20 | {true:
21 | //<- keyword.control.ink
22 | //<~---- keyword.control.ink
23 | //   ^ keyword.control.ink
24 |     + A choice
25 | //<---- source.ink
26 | //  ^ keyword.choice.sticky.ink
27 | //    ^^^^^^^^^ source.ink
28 |         Vaue of local var is: {x}
29 | //<------------------------------ source.ink
30 | //                            ^^^ keyword.control.ink
31 |         -> END
32 | //<-------- source.ink
33 | //      ^^ keyword.divert.ink keyword.other.ink
34 | //        ^ source.ink
35 | //         ^^^ support.constant.ink
36 | }
37 | //<- keyword.control.ink
38 | ->->
39 | //<-- keyword.divert.ink keyword.other.ink
40 | //^^ keyword.divert.ink keyword.other.ink
41 | 


--------------------------------------------------------------------------------
/tests/cases/choices/choice_with_brackets_only.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | *   [Option]
 4 | //<- keyword.choice.ink
 5 | //  ^ keyword.choice.suppression.ink keyword.control.ink
 6 | //   ^^^^^^ source.ink
 7 | //         ^ keyword.choice.suppression.ink keyword.control.ink
 8 |     Text
 9 | //<-------- source.ink
10 | 


--------------------------------------------------------------------------------
/tests/cases/choices/conditional_choices.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | * { true } { false } not displayed
 4 | //<- keyword.choice.ink
 5 | //^ keyword.control.ink
 6 | // ^^^^^^ keyword.control.ink
 7 | //       ^ keyword.control.ink
 8 | //         ^ keyword.control.ink
 9 | //          ^^^^^^^ keyword.control.ink
10 | //                 ^ keyword.control.ink
11 | //                  ^^^^^^^^^^^^^^^ source.ink
12 | * { true } { true }
13 | //<- keyword.choice.ink
14 | //^ keyword.control.ink
15 | // ^^^^^^ keyword.control.ink
16 | //       ^ keyword.control.ink
17 | //         ^ keyword.control.ink
18 | //          ^^^^^^ keyword.control.ink
19 | //                ^ keyword.control.ink
20 |   { true and true }  one
21 | //<-- source.ink
22 | //^ keyword.control.ink
23 | // ^^^^^^^^^^^^^^^ keyword.control.ink
24 | //                ^ keyword.control.ink
25 | //                 ^^^^^^ source.ink
26 | * { false } not displayed
27 | //<- keyword.choice.ink
28 | //^ keyword.control.ink
29 | // ^^^^^^^ keyword.control.ink
30 | //        ^ keyword.control.ink
31 | //         ^^^^^^^^^^^^^^^ source.ink
32 | * (name) { true } two
33 | //<- keyword.choice.ink
34 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
35 | // ^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
36 | //     ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
37 | //       ^ keyword.control.ink
38 | //        ^^^^^^ keyword.control.ink
39 | //              ^ keyword.control.ink
40 | //               ^^^^^ source.ink
41 | * { true }
42 | //<- keyword.choice.ink
43 | //^ keyword.control.ink
44 | // ^^^^^^ keyword.control.ink
45 | //       ^ keyword.control.ink
46 |   { true }
47 | //<-- source.ink
48 | //^ keyword.control.ink
49 | // ^^^^^^ keyword.control.ink
50 | //       ^ keyword.control.ink
51 |   three
52 | //<------- source.ink
53 | * { true }
54 | //<- keyword.choice.ink
55 | //^ keyword.control.ink
56 | // ^^^^^^ keyword.control.ink
57 | //       ^ keyword.control.ink
58 |   four
59 | //<------- source.ink
60 | 


--------------------------------------------------------------------------------
/tests/cases/choices/default_choices.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 |  - (start)
 4 | //<~- keyword.gather.ink
 5 | // ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
 6 | //  ^^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
 7 | //       ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
 8 |  * [Choice 1]
 9 | //<~- keyword.choice.ink
10 | // ^ keyword.choice.suppression.ink keyword.control.ink
11 | //  ^^^^^^^^ source.ink
12 | //          ^ keyword.choice.suppression.ink keyword.control.ink
13 |  * [Choice 2]
14 | //<~- keyword.choice.ink
15 | // ^ keyword.choice.suppression.ink keyword.control.ink
16 | //  ^^^^^^^^ source.ink
17 | //          ^ keyword.choice.suppression.ink keyword.control.ink
18 |  * {false} Impossible choice
19 | //<~- keyword.choice.ink
20 | // ^ keyword.control.ink
21 | //  ^^^^^ keyword.control.ink
22 | //       ^ keyword.control.ink
23 | //        ^^^^^^^^^^^^^^^^^^^ source.ink
24 |  * -> default
25 | //<~- keyword.choice.ink
26 | // ^^ keyword.divert.ink keyword.other.ink
27 | //   ^ source.ink
28 | //    ^^^^^^^ variable.other.knot.ink
29 |  - After choice
30 | //<~- keyword.gather.ink
31 | // ^^^^^^^^^^^^^ source.ink
32 |  -> start
33 | //<- source.ink
34 | //<~-- keyword.divert.ink keyword.other.ink
35 | // ^ source.ink
36 | //  ^^^^^ variable.other.knot.ink
37 | == default ==
38 | //<-- storage.knot.ink storage.type.ink
39 | //^ source.ink
40 | // ^^^^^^^ entity.name.function.ink
41 | //        ^ source.ink
42 | //         ^^ storage.knot.ink storage.type.ink
43 | This is default.
44 | //<---------------- source.ink
45 | -> DONE
46 | //<-- keyword.divert.ink keyword.other.ink
47 | //^ source.ink
48 | // ^^^^ support.constant.ink
49 | 


--------------------------------------------------------------------------------
/tests/cases/choices/default_simple_gather.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | * ->
 4 | //<- keyword.choice.ink
 5 | //^^ keyword.divert.ink keyword.other.ink
 6 | - x
 7 | //<- keyword.gather.ink
 8 | //^ source.ink
 9 | -> DONE
10 | //<-- keyword.divert.ink keyword.other.ink
11 | // ^^^^ support.constant.ink
12 | 


--------------------------------------------------------------------------------
/tests/cases/choices/fallback_choice_on_thread.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | <- knot
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^ variable.other.knot.ink
 7 | == knot
 8 | //<-- storage.knot.ink storage.type.ink
 9 | //^ source.ink
10 | // ^^^^ entity.name.function.ink
11 |    ~ temp x = 1
12 | //<--- source.ink
13 | // ^ keyword.logic.ink
14 | //  ^ source.ink
15 | //   ^^^^ storage.modifier.ink
16 | //        ^  variable.other.ink
17 | //          ^ keyword.assignment.ink
18 | //            ^ constant.numeric.ink
19 |    *   ->
20 | //<--- source.ink
21 | // ^ keyword.choice.ink
22 | //     ^^ keyword.divert.ink keyword.other.ink
23 |        Should be 1 not 0: {x}.
24 | //<-------------------------- source.ink
25 | //                        ^ keyword.control.ink
26 | //                         ^ keyword.control.ink
27 | //                          ^ keyword.control.ink
28 | //                           ^^ source.ink
29 |        -> DONE
30 | //<--------- source.ink
31 | //     ^^ keyword.divert.ink keyword.other.ink
32 | //       ^ source.ink
33 | //        ^^^^ support.constant.ink
34 | 


--------------------------------------------------------------------------------
/tests/cases/choices/gather_choice_same_line.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | - * hello
 4 | //<- keyword.gather.ink
 5 | //<~- source.ink
 6 | //^ keyword.choice.ink
 7 | // ^^^^^^ source.ink
 8 | - * world
 9 | //<- keyword.gather.ink
10 | //<~- source.ink
11 | //^ keyword.choice.ink
12 | // ^^^^^^ source.ink
13 | 


--------------------------------------------------------------------------------
/tests/cases/choices/has_read_on_choice.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | * { not test } visible choice
 4 | //<- keyword.choice.ink
 5 | //<~- source.ink
 6 | //^ keyword.control.ink
 7 | // ^^^^^^^^^^ keyword.control.ink
 8 | //           ^ keyword.control.ink
 9 | //            ^^^^^^^^^^^^^^^ source.ink
10 | * { test } visible choice
11 | //<- keyword.choice.ink
12 | //<~- source.ink
13 | //^ keyword.control.ink
14 | // ^^^^^^ keyword.control.ink
15 | //       ^ keyword.control.ink
16 | //        ^^^^^^^^^^^^^^^ source.ink
17 | == test ==
18 | //<-- storage.knot.ink storage.type.ink
19 | //^ source.ink
20 | // ^^^^ entity.name.function.ink
21 | //     ^ source.ink
22 | //      ^^ storage.knot.ink storage.type.ink
23 | -> END
24 | //<-- keyword.divert.ink keyword.other.ink
25 | //^ source.ink
26 | // ^^^ support.constant.ink
27 | 


--------------------------------------------------------------------------------
/tests/cases/choices/logic_in_choices.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | * 'Hello {name()}[, your name is {name()}.'],' I said, knowing full well that his name was {name()}.
 4 | //<- keyword.choice.ink
 5 | //<~------- source.ink
 6 | //       ^ keyword.control.ink
 7 | //        ^^^^^^ keyword.control.ink
 8 | //              ^ keyword.control.ink
 9 | //               ^ keyword.choice.suppression.ink keyword.control.ink
10 | //                ^^^^^^^^^^^^^^^ source.ink
11 | //                               ^ keyword.control.ink
12 | //                                ^^^^^^ keyword.control.ink
13 | //                                      ^ keyword.control.ink
14 | //                                       ^^ source.ink
15 | //                                         ^ keyword.choice.suppression.ink keyword.control.ink
16 | //                                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ink
17 | //                                                                                         ^ keyword.control.ink
18 | //                                                                                          ^^^^^^ keyword.control.ink
19 | //                                                                                                ^ keyword.control.ink
20 | //                                                                                                 ^ source.ink
21 | -> DONE
22 | //<-- keyword.divert.ink keyword.other.ink
23 | //^ source.ink
24 | // ^^^^ support.constant.ink
25 | == function name ==
26 | //<-- storage.knot.ink storage.type.ink
27 | //^ source.ink
28 | // ^^^^^^^^ storage.type.ink
29 | //         ^ source.ink
30 | //          ^^^^ entity.name.function.ink
31 | //              ^ source.ink
32 | //               ^^ storage.knot.ink storage.type.ink
33 | Joe
34 | //<--- source.ink
35 | 


--------------------------------------------------------------------------------
/tests/cases/choices/non_text_in_choice_inner_content.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> knot
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^ variable.other.knot.ink
 7 | == knot
 8 | //<-- storage.knot.ink storage.type.ink
 9 | //^ source.ink
10 | // ^^^^ entity.name.function.ink
11 |    *   option text[]. {true: Conditional bit.} -> next
12 | //<--- source.ink
13 | // ^ keyword.choice.ink
14 | //  ^^^^^^^^^^^^^^ source.ink
15 | //                ^ keyword.choice.suppression.ink keyword.control.ink
16 | //                 ^ keyword.choice.suppression.ink keyword.control.ink
17 | //                  ^^ source.ink
18 | //                    ^ keyword.control.ink
19 | //                     ^^^^^ keyword.control.ink
20 | //                          ^ source.ink
21 | //                           ^^^^^^^^^^^^^^^^ source.ink
22 | //                                           ^ keyword.control.ink
23 | //                                            ^ source.ink
24 | //                                             ^^ keyword.divert.ink keyword.other.ink
25 | //                                               ^ source.ink
26 | //                                                ^^^^ variable.other.knot.ink
27 |    -> DONE
28 | //<--- source.ink
29 | // ^^ keyword.divert.ink keyword.other.ink
30 | //   ^ source.ink
31 | //    ^^^^ support.constant.ink
32 | == next
33 | //<-- storage.knot.ink storage.type.ink
34 | //^ source.ink
35 | // ^^^^ entity.name.function.ink
36 |     Next.
37 | //<--------- source.ink
38 |     -> DONE
39 | //<---- source.ink
40 | //  ^^ keyword.divert.ink keyword.other.ink
41 | //    ^ source.ink
42 | //     ^^^^ support.constant.ink
43 | 


--------------------------------------------------------------------------------
/tests/cases/choices/once_only_choices_can_link_back_to_self.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> opts
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^ variable.other.knot.ink
 7 | = opts
 8 | //<- storage.knot.ink storage.type.ink
 9 | //<~- source.ink
10 | //^^^^ entity.name.function.ink
11 | *   (firstOpt) [First choice]   ->  opts
12 | //<- keyword.choice.ink
13 | //<~--- source.ink
14 | //  ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
15 | //   ^^^^^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
16 | //           ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
17 | //            ^ source.ink
18 | //             ^ keyword.choice.suppression.ink keyword.control.ink
19 | //              ^^^^^^^^^^^^ source.ink
20 | //                          ^ keyword.choice.suppression.ink keyword.control.ink
21 | //                           ^^^ source.ink
22 | //                              ^^ keyword.divert.ink keyword.other.ink
23 | //                                ^^ source.ink
24 | //                                  ^^^^ variable.other.knot.ink
25 | *   {firstOpt} [Second choice]  ->  opts
26 | //<- keyword.choice.ink
27 | //<~--- source.ink
28 | //  ^ keyword.control.ink
29 | //   ^^^^^^^^ keyword.control.ink
30 | //           ^ keyword.control.ink
31 | //            ^ source.ink
32 | //             ^ keyword.choice.suppression.ink keyword.control.ink
33 | //              ^^^^^^^^^^^^^ source.ink
34 | //                           ^ keyword.choice.suppression.ink keyword.control.ink
35 | //                            ^^ source.ink
36 | //                              ^^ keyword.divert.ink keyword.other.ink
37 | //                                ^^ source.ink
38 | //                                  ^^^^ variable.other.knot.ink
39 | * -> end
40 | //<- keyword.choice.ink
41 | //<~- source.ink
42 | //^^ keyword.divert.ink keyword.other.ink
43 | //  ^ source.ink
44 | //   ^^^ variable.other.knot.ink
45 | - (end)
46 | //<- keyword.gather.ink
47 | //<~- source.ink
48 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
49 | // ^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
50 | //    ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
51 |     -> END
52 | //<---- source.ink
53 | //  ^^ keyword.divert.ink keyword.other.ink
54 | //    ^ source.ink
55 | //     ^^^ support.constant.ink
56 | 


--------------------------------------------------------------------------------
/tests/cases/choices/once_only_choices_with_own_content.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | VAR times = 3
 4 | //<--- storage.type.ink storage.type.var.ink
 5 | // ^ source.ink
 6 | //  ^^^^^ variable.other.ink
 7 | //       ^ source.ink
 8 | //        ^ keyword.operator.assignment.ink
 9 | //         ^ source.ink
10 | //          ^ constant.numeric.ink
11 | -> home
12 | //<-- keyword.divert.ink keyword.other.ink
13 | //^ source.ink
14 | // ^^^^ variable.other.knot.ink
15 | == home ==
16 | //<-- storage.knot.ink storage.type.ink
17 | //^ source.ink
18 | // ^^^^ entity.name.function.ink
19 | //     ^ source.ink
20 | //      ^^ storage.knot.ink storage.type.ink
21 | ~ times = times - 1
22 | //<- keyword.logic.ink
23 | //<~- source.ink
24 | //^^^^^ variable.other.ink
25 | //     ^ source.ink
26 | //      ^ keyword.operator.assignment.ink
27 | //       ^ source.ink
28 | //        ^^^^^ variable.other.ink
29 | //             ^^^ keyword.operator.arithmetic.ink
30 | //                ^ constant.numeric.ink
31 | {times >= 0:-> eat}
32 | //<- keyword.control.ink
33 | //<------------ keyword.control.ink
34 | //          ^^ keyword.divert.ink keyword.other.ink
35 | //            ^ source.ink
36 | //             ^^^ variable.other.knot.ink
37 | //                ^ keyword.control.ink
38 | I've finished eating now.
39 | //<------------------------- source.ink
40 | -> END
41 | //<-- keyword.divert.ink keyword.other.ink
42 | //^ source.ink
43 | // ^^^ support.constant.ink
44 | == eat ==
45 | //<-- storage.knot.ink storage.type.ink
46 | //^ source.ink
47 | // ^^^ entity.name.function.ink
48 | //    ^ source.ink
49 | //     ^^ storage.knot.ink storage.type.ink
50 | This is the {first|second|third} time.
51 | //<------------ source.ink
52 | //          ^ keyword.control.ink
53 | //           ^^^^^ source.ink
54 | //                ^ keyword.control.ink
55 | //                 ^^^^^^ source.ink
56 | //                       ^ keyword.control.ink
57 | //                        ^^^^^ source.ink
58 | //                             ^ keyword.control.ink
59 | //                              ^^^^^^^ source.ink
60 | * Eat ice-cream[]
61 | //<- keyword.choice.ink
62 | //<~------------- source.ink
63 | //             ^ keyword.choice.suppression.ink keyword.control.ink
64 | //              ^ keyword.choice.suppression.ink keyword.control.ink
65 | * Drink coke[]
66 | //<- keyword.choice.ink
67 | //<~---------- source.ink
68 | //          ^ keyword.choice.suppression.ink keyword.control.ink
69 | //           ^ keyword.choice.suppression.ink keyword.control.ink
70 | * Munch cookies[]
71 | //<- keyword.choice.ink
72 | //<~------------- source.ink
73 | //             ^ keyword.choice.suppression.ink keyword.control.ink
74 | //              ^ keyword.choice.suppression.ink keyword.control.ink
75 | -
76 | //<- keyword.gather.ink
77 | -> home
78 | //<-- keyword.divert.ink keyword.other.ink
79 | //^ source.ink
80 | // ^^^^ variable.other.knot.ink
81 | 


--------------------------------------------------------------------------------
/tests/cases/choices/should_not_gather_due_to_choice.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | * opt
 4 | //<- keyword.choice.ink
 5 | //<~---- source.ink
 6 |     - - text
 7 | //<---- source.ink
 8 | //  ^^^ keyword.gather.ink
 9 | //     ^^^^^ source.ink
10 |     * * {false} impossible
11 | //<---- source.ink
12 | //  ^^^ keyword.choice.ink
13 | //     ^ source.ink
14 | //      ^ keyword.control.ink
15 | //       ^^^^^ keyword.control.ink
16 | //            ^ keyword.control.ink
17 | //             ^^^^^^^^^^^ source.ink
18 | - gather
19 | //<- keyword.gather.ink
20 | //<------- source.ink
21 | 


--------------------------------------------------------------------------------
/tests/cases/choices/sticky_choices_stay_sticky.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> test
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^ variable.other.knot.ink
 7 | == test ==
 8 | //<-- storage.knot.ink storage.type.ink
 9 | //^ source.ink
10 | // ^^^^ entity.name.function.ink
11 | //     ^ source.ink
12 | //      ^^ storage.knot.ink storage.type.ink
13 | First line.
14 | //<----------- source.ink
15 | Second line.
16 | //<------------ source.ink
17 | + Choice 1
18 | //<- keyword.choice.sticky.ink
19 | //<--------- source.ink
20 | + Choice 2
21 | //<- keyword.choice.sticky.ink
22 | //<--------- source.ink
23 | - -> test
24 | //<- keyword.gather.ink
25 | //<~- source.ink
26 | //^^ keyword.divert.ink keyword.other.ink
27 | //  ^ source.ink
28 | //   ^^^^ variable.other.knot.ink
29 | 


--------------------------------------------------------------------------------
/tests/cases/choices/various_default_choices.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | * -> hello
 4 | //<- keyword.choice.ink
 5 | //<~- source.ink
 6 | //^^ keyword.divert.ink keyword.other.ink
 7 | //  ^ source.ink
 8 | //   ^^^^^ variable.other.knot.ink
 9 | Unreachable
10 | //<----------- source.ink
11 | - (hello) 1
12 | //<- keyword.gather.ink
13 | //<~- source.ink
14 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
15 | // ^^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
16 | //      ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
17 | //       ^^ source.ink
18 | * ->
19 | //<- keyword.choice.ink
20 | //<~- source.ink
21 | //^^ keyword.divert.ink keyword.other.ink
22 |    - - 2
23 | //<--- source.ink
24 | // ^^^ keyword.gather.ink
25 | //    ^^ source.ink
26 | - 3
27 | //<- keyword.gather.ink
28 | //<~-- source.ink
29 | -> END
30 | //<-- keyword.divert.ink keyword.other.ink
31 | //^ source.ink
32 | // ^^^ support.constant.ink
33 | 


--------------------------------------------------------------------------------
/tests/cases/conditions/conditionals.ink:
--------------------------------------------------------------------------------
  1 | // SYNTAX TEST "source.ink"
  2 | 
  3 | {false:not true|true}
  4 | //<- keyword.control.ink
  5 | //<------ keyword.control.ink
  6 | //     ^^^^^^^^ source.ink
  7 | //             ^ keyword.control.ink
  8 | //              ^^^^ source.ink
  9 | //                  ^ keyword.control.ink
 10 | {
 11 | //<- keyword.control.ink
 12 |    - 4 > 5: not true
 13 | //<--- source.ink
 14 | // ^ keyword.control.ink
 15 | //  ^ source.ink
 16 | //   ^^^^^ keyword.control.ink
 17 | //        ^ keyword.control.ink
 18 | //         ^^^^^^^^^^ source.ink
 19 |    - 5 > 4: true
 20 | //<--- source.ink
 21 | // ^ keyword.control.ink
 22 | //  ^ source.ink
 23 | //   ^^^^^ keyword.control.ink
 24 | //        ^ keyword.control.ink
 25 | //         ^^^^^^ source.ink
 26 | }
 27 | //<- keyword.control.ink
 28 | { 2*2 > 3:
 29 | //<- keyword.control.ink
 30 | //<--------- keyword.control.ink
 31 |    - true
 32 | //<--- source.ink
 33 | // ^ keyword.control.ink
 34 | //  ^^^^^^ source.ink
 35 |    - not true
 36 | //<--- source.ink
 37 | // ^ keyword.control.ink
 38 | //  ^^^^^^^^^^ source.ink
 39 | }
 40 | //<- keyword.control.ink
 41 | {
 42 | //<- keyword.control.ink
 43 |    - 1 > 3: not true
 44 | //<--- source.ink
 45 | // ^ keyword.control.ink
 46 | //  ^ source.ink
 47 | //   ^^^^^ keyword.control.ink
 48 | //        ^ keyword.control.ink
 49 | //         ^^^^^^^^^^ source.ink
 50 |    - { 2+2 == 4:
 51 | //<--- source.ink
 52 | // ^ keyword.control.ink
 53 | //  ^ source.ink
 54 | //   ^ keyword.control.ink
 55 | //    ^^^^^^^^^^ keyword.control.ink
 56 |         - true
 57 | //<-------- source.ink
 58 | //      ^ keyword.control.ink
 59 | //       ^^^^^^ source.ink
 60 |         - not true
 61 | //<-------- source.ink
 62 | //      ^ keyword.control.ink
 63 | //       ^^^^^^^^^^ source.ink
 64 |    }
 65 | //<--- source.ink
 66 | // ^ keyword.control.ink
 67 | }
 68 | //<- keyword.control.ink
 69 | { 2*3:
 70 | //<----- keyword.control.ink
 71 |    - 1+7: not true
 72 | //<--- source.ink
 73 | // ^ keyword.control.ink
 74 | //  ^ source.ink
 75 | //   ^^^ keyword.control.ink
 76 | //      ^ keyword.control.ink
 77 | //       ^^^^^^^^^^ source.ink
 78 |    - 9: not true
 79 | //<--- source.ink
 80 | // ^ keyword.control.ink
 81 | //  ^ source.ink
 82 | //   ^ keyword.control.ink
 83 | //    ^ keyword.control.ink
 84 | //     ^^^^^^^^^^ source.ink
 85 |    - 1+1+1+3: true
 86 | //<--- source.ink
 87 | // ^ keyword.control.ink
 88 | //  ^ source.ink
 89 | //   ^^^^^^^ keyword.control.ink
 90 | //          ^ keyword.control.ink
 91 | //           ^^^^^^ source.ink
 92 |    - 9-3: also true but not printed
 93 | //<--- source.ink
 94 | // ^ keyword.control.ink
 95 | //  ^ source.ink
 96 | //   ^^^ keyword.control.ink
 97 | //      ^ keyword.control.ink
 98 | //       ^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ink
 99 | }
100 | //<- keyword.control.ink
101 | { true:
102 | //<- keyword.control.ink
103 | //<------ keyword.control.ink
104 |     great
105 | //<--------- source.ink
106 |     right?
107 | //<---------- source.ink
108 | }
109 | //<- keyword.control.ink
110 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/basic_tunnel.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> f ->
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^ variable.other.knot.ink
 7 | //  ^ source.ink
 8 | //   ^^ keyword.divert.ink keyword.other.ink
 9 | <> world
10 | //<-- keyword.glue.ink keyword.other.ink
11 | //^^^^^^^ source.ink
12 | == f ==
13 | //<-- storage.knot.ink storage.type.ink
14 | //^ source.ink
15 | // ^ entity.name.function.ink
16 | //  ^ source.ink
17 | //   ^^ storage.knot.ink storage.type.ink
18 | Hello
19 | //<----- source.ink
20 | ->->
21 | //<-- keyword.divert.ink keyword.other.ink
22 | //^^ keyword.divert.ink keyword.other.ink
23 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/compare_divert_targets.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | VAR to_one = -> one
 4 | //<--- storage.type.ink storage.type.var.ink
 5 | // ^ source.ink
 6 | //  ^^^^^^ variable.other.ink
 7 | //        ^ source.ink
 8 | //         ^ keyword.operator.assignment.ink
 9 | //          ^ source.ink
10 | //           ^^ keyword.divert.ink keyword.other.ink
11 | //             ^ source.ink
12 | //              ^^^ variable.other.knot.ink
13 | VAR to_two = -> two
14 | //<--- storage.type.ink storage.type.var.ink
15 | // ^ source.ink
16 | //  ^^^^^^ variable.other.ink
17 | //        ^ source.ink
18 | //         ^ keyword.operator.assignment.ink
19 | //          ^ source.ink
20 | //           ^^ keyword.divert.ink keyword.other.ink
21 | //             ^ source.ink
22 | //              ^^^ variable.other.knot.ink
23 | {to_one == to_two:same knot|different knot}
24 | //<- keyword.control.ink
25 | //<----------------- keyword.control.ink
26 | //                ^^^^^^^^^ source.ink
27 | //                         ^ keyword.control.ink
28 | //                          ^^^^^^^^^^^^^^ source.ink
29 | //                                        ^ keyword.control.ink
30 | {to_one == to_one:same knot|different knot}
31 | //<- keyword.control.ink
32 | //<----------------- keyword.control.ink
33 | //                ^^^^^^^^^ source.ink
34 | //                         ^ keyword.control.ink
35 | //                          ^^^^^^^^^^^^^^ source.ink
36 | //                                        ^ keyword.control.ink
37 | {to_two == to_two:same knot|different knot}
38 | //<- keyword.control.ink
39 | //<----------------- keyword.control.ink
40 | //                ^^^^^^^^^ source.ink
41 | //                         ^ keyword.control.ink
42 | //                          ^^^^^^^^^^^^^^ source.ink
43 | //                                        ^ keyword.control.ink
44 | { -> one == -> two:same knot|different knot}
45 | //<- keyword.control.ink
46 | //<------------------ keyword.control.ink
47 | //                 ^^^^^^^^^ source.ink
48 | //                          ^ keyword.control.ink
49 | //                           ^^^^^^^^^^^^^^ source.ink
50 | //                                         ^ keyword.control.ink
51 | { -> one == to_one:same knot|different knot}
52 | //<- keyword.control.ink
53 | //<----------------- keyword.control.ink
54 | //                 ^^^^^^^^^ source.ink
55 | //                          ^ keyword.control.ink
56 | //                           ^^^^^^^^^^^^^^ source.ink
57 | //                                         ^ keyword.control.ink
58 | { to_one == -> one:same knot|different knot}
59 | //<- keyword.control.ink
60 | //<----------------- keyword.control.ink
61 | //                 ^^^^^^^^^ source.ink
62 | //                          ^ keyword.control.ink
63 | //                           ^^^^^^^^^^^^^^ source.ink
64 | //                                         ^ keyword.control.ink
65 | == one
66 | //<-- storage.knot.ink storage.type.ink
67 | //^ source.ink
68 | // ^^^ entity.name.function.ink
69 |     One
70 | //<------ source.ink
71 |     -> DONE
72 | //<---- source.ink
73 | //  ^^ keyword.divert.ink keyword.other.ink
74 | //    ^ source.ink
75 | //     ^^^^ support.constant.ink
76 | === two
77 | //<--- storage.knot.ink storage.type.ink
78 | // ^ source.ink
79 | //  ^^^ entity.name.function.ink
80 |     Two
81 | //<------- source.ink
82 |     -> DONE
83 | //<---- source.ink
84 | //  ^^ keyword.divert.ink keyword.other.ink
85 | //    ^ source.ink
86 | //     ^^^^ support.constant.ink
87 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/complex_tunnels.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> one (1) -> two (2) ->
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^ variable.function.ink
 7 | //    ^ source.ink
 8 | //     ^ punctuation.section.parens.begin.ink
 9 | //      ^ constant.numeric.ink
10 | //       ^ punctuation.section.parens.end.ink
11 | //        ^ source.ink
12 | //         ^^ keyword.divert.ink keyword.other.ink
13 | //           ^ source.ink
14 | //            ^^^ variable.function.ink
15 | //               ^ source.ink
16 | //                ^ punctuation.section.parens.begin.ink
17 | //                 ^ constant.numeric.ink
18 | //                  ^ punctuation.section.parens.end.ink
19 | //                   ^ source.ink
20 | three (3)
21 | //<--------- source.ink
22 | == one(num) ==
23 | //<-- storage.knot.ink storage.type.ink
24 | //^ source.ink
25 | // ^^^ entity.name.function.ink
26 | //    ^ punctuation.section.parens.begin.ink
27 | //     ^^^ variable.parameter.function.ink
28 | //        ^ punctuation.section.parens.end.ink
29 | //         ^ source.ink
30 | //          ^^ storage.knot.ink storage.type.ink
31 | one ({num})
32 | //<----- source.ink
33 | //   ^ keyword.control.ink
34 | //    ^^^ keyword.control.ink
35 | //       ^ keyword.control.ink
36 | //        ^^ source.ink
37 | -> oneAndAHalf (1.5) ->
38 | //<-- keyword.divert.ink keyword.other.ink
39 | //^ source.ink
40 | // ^^^^^^^^^^^ variable.function.ink
41 | //            ^ source.ink
42 | //             ^ punctuation.section.parens.begin.ink
43 | //              ^^^ constant.numeric.ink
44 | //                 ^ punctuation.section.parens.end.ink
45 | //                  ^ source.ink
46 | //                   ^^ keyword.divert.ink keyword.other.ink
47 | ->->
48 | //<-- keyword.divert.ink keyword.other.ink
49 | //^^ keyword.divert.ink keyword.other.ink
50 | == oneAndAHalf(num) ==
51 | //<-- storage.knot.ink storage.type.ink
52 | //^ source.ink
53 | // ^^^^^^^^^^^ entity.name.function.ink
54 | //            ^ punctuation.section.parens.begin.ink
55 | //             ^^^ variable.parameter.function.ink
56 | //                ^ punctuation.section.parens.end.ink
57 | //                 ^ source.ink
58 | //                  ^^ storage.knot.ink storage.type.ink
59 | one and a half ({num})
60 | //<---------------- source.ink
61 | //              ^ keyword.control.ink
62 | //               ^^^ keyword.control.ink
63 | //                  ^ keyword.control.ink
64 | //                   ^^ source.ink
65 | ->->
66 | //<-- keyword.divert.ink keyword.other.ink
67 | //^^ keyword.divert.ink keyword.other.ink
68 | == two (num) ==
69 | //<-- storage.knot.ink storage.type.ink
70 | //^ source.ink
71 | // ^^^ entity.name.function.ink
72 | //    ^ source.ink
73 | //     ^ punctuation.section.parens.begin.ink
74 | //      ^^^ variable.parameter.function.ink
75 | //         ^ punctuation.section.parens.end.ink
76 | //          ^ source.ink
77 | //           ^^ storage.knot.ink storage.type.ink
78 | two ({num})
79 | //<----- source.ink
80 | //   ^ keyword.control.ink
81 | //    ^^^ keyword.control.ink
82 | //       ^ keyword.control.ink
83 | //        ^^ source.ink
84 | ->->
85 | //<-- keyword.divert.ink keyword.other.ink
86 | //^^ keyword.divert.ink keyword.other.ink
87 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/divert_in_conditional.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | === intro
 4 | //<--- storage.knot.ink storage.type.ink
 5 | // ^ source.ink
 6 | //  ^^^^^ entity.name.function.ink
 7 | = top
 8 | //<- storage.knot.ink storage.type.ink
 9 | //<~- source.ink
10 | //^^^ entity.name.function.ink
11 |     { main: -> done }
12 | //<---- source.ink
13 | //  ^ keyword.control.ink
14 | //   ^^^^^^ keyword.control.ink
15 | //         ^ source.ink
16 | //          ^^ keyword.divert.ink keyword.other.ink
17 | //            ^ source.ink
18 | //             ^^^^ variable.other.knot.ink
19 | //                 ^ source.ink
20 | //                  ^ keyword.control.ink
21 |     -> END
22 | //<---- source.ink
23 | //  ^^ keyword.divert.ink keyword.other.ink
24 | //    ^ source.ink
25 | //     ^^^ support.constant.ink
26 | = main
27 | //<- storage.knot.ink storage.type.ink
28 | //<~- source.ink
29 | //^^^^ entity.name.function.ink
30 |     -> top
31 | //<---- source.ink
32 | //  ^^ keyword.divert.ink keyword.other.ink
33 | //    ^ source.ink
34 | //     ^^^ variable.other.knot.ink
35 | = done
36 | //<- storage.knot.ink storage.type.ink
37 | //<~- source.ink
38 | //^^^^ entity.name.function.ink
39 |     -> END
40 | //<---- source.ink
41 | //  ^^ keyword.divert.ink keyword.other.ink
42 | //    ^ source.ink
43 | //     ^^^ support.constant.ink
44 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/divert_targets_with_parameters.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | VAR x = ->place
 4 | //<--- storage.type.ink storage.type.var.ink
 5 | // ^ source.ink
 6 | //  ^ variable.other.ink
 7 | //   ^ source.ink
 8 | //    ^ keyword.operator.assignment.ink
 9 | //     ^ source.ink
10 | //      ^^ keyword.divert.ink keyword.other.ink
11 | //        ^^^^^ variable.other.knot.ink
12 | ->x (5)
13 | //<-- keyword.divert.ink keyword.other.ink
14 | //^ variable.function.ink
15 | // ^ source.ink
16 | //  ^ punctuation.section.parens.begin.ink
17 | //   ^ constant.numeric.ink
18 | //    ^ punctuation.section.parens.end.ink
19 | == place (a) ==
20 | //<-- storage.knot.ink storage.type.ink
21 | //^ source.ink
22 | // ^^^^^ entity.name.function.ink
23 | //      ^ source.ink
24 | //       ^ punctuation.section.parens.begin.ink
25 | //        ^ variable.parameter.function.ink
26 | //         ^ punctuation.section.parens.end.ink
27 | //          ^ source.ink
28 | //           ^^ storage.knot.ink storage.type.ink
29 | {a}
30 | //<- keyword.control.ink
31 | //<~- keyword.control.ink
32 | //^ keyword.control.ink
33 | -> DONE
34 | //<-- keyword.divert.ink keyword.other.ink
35 | //^ source.ink
36 | // ^^^^ support.constant.ink
37 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/divert_to_weave_points.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> knot.stitch.gather
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^ variable.other.knot.ink
 7 | //     ^ punctuation.accessor.ink
 8 | //      ^^^^^^ variable.other.stitch.ink
 9 | //            ^ punctuation.accessor.ink
10 | //             ^^^^^^ variable.other.label.ink
11 | == knot ==
12 | //<-- storage.knot.ink storage.type.ink
13 | //^ source.ink
14 | // ^^^^ entity.name.function.ink
15 | //     ^ source.ink
16 | //      ^^ storage.knot.ink storage.type.ink
17 | = stitch
18 | //<- storage.knot.ink storage.type.ink
19 | //<~- source.ink
20 | //^^^^^^ entity.name.function.ink
21 | - hello
22 | //<- keyword.gather.ink
23 | //<------ source.ink
24 |     * (choice) test
25 | //<---- source.ink
26 | //  ^ keyword.choice.ink
27 | //   ^ source.ink
28 | //    ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
29 | //     ^^^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
30 | //           ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
31 | //            ^^^^^ source.ink
32 |         choice content
33 | //<---------------------- source.ink
34 | - (gather)
35 | //<- keyword.gather.ink
36 | //<~- source.ink
37 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
38 | // ^^^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
39 | //       ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
40 |   gather
41 | //<-------- source.ink
42 |   {stopping:
43 | //<-- source.ink
44 | //^ keyword.control.ink
45 | // ^^^^^^^^^ keyword.control.ink
46 |     - -> knot.stitch.choice
47 | //<---- source.ink
48 | //  ^ keyword.control.ink
49 | //   ^ source.ink
50 | //    ^^ keyword.divert.ink keyword.other.ink
51 | //      ^ source.ink
52 | //       ^^^^ variable.other.knot.ink
53 | //           ^ punctuation.accessor.ink
54 | //            ^^^^^^ variable.other.stitch.ink
55 | //                  ^ punctuation.accessor.ink
56 | //                   ^^^^^^ variable.other.label.ink
57 |     - second time round
58 | //<---- source.ink
59 | //  ^ keyword.control.ink
60 | //   ^^^^^^^^^^^^^^^^^^^ source.ink
61 |   }
62 | //<-- source.ink
63 | //^ keyword.control.ink
64 | -> END
65 | //<-- keyword.divert.ink keyword.other.ink
66 | //^ source.ink
67 | // ^^^ support.constant.ink
68 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/done_stops_thread.ink:
--------------------------------------------------------------------------------
1 | // SYNTAX TEST "source.ink"
2 | 
3 | -> DONE
4 | //<-- keyword.divert.ink keyword.other.ink
5 | //  ^ source.ink
6 | //   ^^^^ support.constant.ink
7 | This content is inaccessible.
8 | //<----------------------------- source.ink
9 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/path_to_self.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | - (dododo)
 4 | //<- keyword.gather.ink
 5 | //<~- source.ink
 6 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
 7 | // ^^^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
 8 | //       ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
 9 | -> tunnel ->
10 | //<-- keyword.divert.ink keyword.other.ink
11 | //^ source.ink
12 | // ^^^^^^ variable.other.knot.ink
13 | //       ^ source.ink
14 | //        ^^ keyword.divert.ink keyword.other.ink
15 | -> dododo
16 | //<-- keyword.divert.ink keyword.other.ink
17 | //^ source.ink
18 | // ^^^^^^ variable.other.knot.ink
19 | == tunnel
20 | //<-- storage.knot.ink storage.type.ink
21 | //^ source.ink
22 | // ^^^^^^ entity.name.function.ink
23 | + A
24 | //<- keyword.choice.sticky.ink
25 | //<~--- source.ink
26 | ->->
27 | //<-- keyword.divert.ink keyword.other.ink
28 | //^^ keyword.divert.ink keyword.other.ink
29 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/same_line_divert_is_inline.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> hurry_home
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^^^^^^^ variable.other.knot.ink
 7 | === hurry_home ===
 8 | //<--- storage.knot.ink storage.type.ink
 9 | // ^ source.ink
10 | //  ^^^^^^^^^^ entity.name.function.ink
11 | //            ^ source.ink
12 | //             ^^^ storage.knot.ink storage.type.ink
13 | We hurried home to Savile Row -> as_fast_as_we_could
14 | //<----------------------------- source.ink
15 | //                           ^ source.ink
16 | //                            ^^ keyword.divert.ink keyword.other.ink
17 | //                              ^ source.ink
18 | //                               ^^^^^^^^^^^^^^^^^^^ variable.other.knot.ink
19 | === as_fast_as_we_could ===
20 | //<--- storage.knot.ink storage.type.ink
21 | // ^ source.ink
22 | //  ^^^^^^^^^^^^^^^^^^^ entity.name.function.ink
23 | //                     ^ source.ink
24 | //                      ^^^ storage.knot.ink storage.type.ink
25 | as fast as we could.
26 | //<-------------------- source.ink
27 | -> DONE
28 | //<-- keyword.divert.ink keyword.other.ink
29 | //^ source.ink
30 | // ^^^^ support.constant.ink
31 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/tunnel_onwards_after_tunnel.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> tunnel1 ->
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^^^^ variable.other.knot.ink
 7 | //        ^ source.ink
 8 | //         ^^ keyword.divert.ink keyword.other.ink
 9 | The End.
10 | //<-------- source.ink
11 | -> END
12 | //<-- keyword.divert.ink keyword.other.ink
13 | //^ source.ink
14 | // ^^^ support.constant.ink
15 | == tunnel1 ==
16 | //<-- storage.knot.ink storage.type.ink
17 | //^ source.ink
18 | // ^^^^^^^ entity.name.function.ink
19 | //        ^ source.ink
20 | //         ^^ storage.knot.ink storage.type.ink
21 | Hello...
22 | //<-------- source.ink
23 | -> tunnel2 ->->
24 | //<-- keyword.divert.ink keyword.other.ink
25 | //^ source.ink
26 | // ^^^^^^^ variable.other.knot.ink
27 | //        ^ source.ink
28 | //         ^^ keyword.divert.ink keyword.other.ink
29 | //           ^^ keyword.divert.ink keyword.other.ink
30 | == tunnel2 ==
31 | //<-- storage.knot.ink storage.type.ink
32 | //^ source.ink
33 | // ^^^^^^^ entity.name.function.ink
34 | //        ^ source.ink
35 | //         ^^ storage.knot.ink storage.type.ink
36 | ...world.
37 | //<--------- source.ink
38 | ->->
39 | //<-- keyword.divert.ink keyword.other.ink
40 | //^^ keyword.divert.ink keyword.other.ink
41 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/tunnel_onwards_divert_after_with_arg.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> a ->
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^ variable.other.knot.ink
 7 | //  ^ source.ink
 8 | //   ^^ keyword.divert.ink keyword.other.ink
 9 | === a ===
10 | //<--- storage.knot.ink storage.type.ink
11 | // ^ source.ink
12 | //  ^ entity.name.function.ink
13 | //   ^ source.ink
14 | //    ^^^ storage.knot.ink storage.type.ink
15 | ->-> b (5 + 3)
16 | //<-- keyword.divert.ink keyword.other.ink
17 | //^^ keyword.divert.ink keyword.other.ink
18 | //  ^ source.ink
19 | //   ^ variable.function.ink
20 | //    ^ source.ink
21 | //     ^ punctuation.section.parens.begin.ink
22 | //      ^ constant.numeric.ink
23 | //       ^ source.ink
24 | //        ^ keyword.operator.arithmetic.ink
25 | //         ^ source.ink
26 | //          ^ constant.numeric.ink
27 | //           ^ punctuation.section.parens.end.ink
28 | === b (x) ===
29 | //<--- storage.knot.ink storage.type.ink
30 | // ^ source.ink
31 | //  ^ entity.name.function.ink
32 | //   ^ source.ink
33 | //    ^ punctuation.section.parens.begin.ink
34 | //     ^ variable.parameter.function.ink
35 | //      ^ punctuation.section.parens.end.ink
36 | //       ^ source.ink
37 | //        ^^^ storage.knot.ink storage.type.ink
38 | {x}
39 | //<- keyword.control.ink
40 | //<~- keyword.control.ink
41 | //^ keyword.control.ink
42 | -> END
43 | //<-- keyword.divert.ink keyword.other.ink
44 | //^ source.ink
45 | // ^^^ support.constant.ink
46 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/tunnel_onwards_divert_override.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> A ->
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^ variable.other.knot.ink
 7 | //  ^ source.ink
 8 | //   ^^ keyword.divert.ink keyword.other.ink
 9 | We will never return to here!
10 | //<----------------------------- source.ink
11 | == A ==
12 | //<-- storage.knot.ink storage.type.ink
13 | //^ source.ink
14 | // ^ entity.name.function.ink
15 | //  ^ source.ink
16 | //   ^^ storage.knot.ink storage.type.ink
17 | This is A
18 | //<--------- source.ink
19 | ->-> B
20 | //<-- keyword.divert.ink keyword.other.ink
21 | //^^ keyword.divert.ink keyword.other.ink
22 | //  ^ source.ink
23 | //   ^ variable.other.knot.ink
24 | == B ==
25 | //<-- storage.knot.ink storage.type.ink
26 | //^ source.ink
27 | // ^ entity.name.function.ink
28 | //  ^ source.ink
29 | //   ^^ storage.knot.ink storage.type.ink
30 | Now in B.
31 | //<--------- source.ink
32 | -> END
33 | //<-- keyword.divert.ink keyword.other.ink
34 | //^ source.ink
35 | // ^^^ support.constant.ink
36 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/tunnel_onwards_with_param_default_choice.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> tunnel ->
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^^^ variable.other.knot.ink
 7 | //       ^ source.ink
 8 | //        ^^ keyword.divert.ink keyword.other.ink
 9 | == tunnel ==
10 | //<-- storage.knot.ink storage.type.ink
11 | //^ source.ink
12 | // ^^^^^^ entity.name.function.ink
13 | //       ^ source.ink
14 | //        ^^ storage.knot.ink storage.type.ink
15 | * ->-> elsewhere (8)
16 | //<- keyword.choice.ink
17 | //<~- source.ink
18 | //^^ keyword.divert.ink keyword.other.ink
19 | //  ^^ keyword.divert.ink keyword.other.ink
20 | //    ^ source.ink
21 | //     ^^^^^^^^^ variable.function.ink
22 | //              ^ source.ink
23 | //               ^ punctuation.section.parens.begin.ink
24 | //                ^ constant.numeric.ink
25 | //                 ^ punctuation.section.parens.end.ink
26 | == elsewhere (x) ==
27 | //<-- storage.knot.ink storage.type.ink
28 | //^ source.ink
29 | // ^^^^^^^^^ entity.name.function.ink
30 | //          ^ source.ink
31 | //           ^ punctuation.section.parens.begin.ink
32 | //            ^ variable.parameter.function.ink
33 | //             ^ punctuation.section.parens.end.ink
34 | //              ^ source.ink
35 | //               ^^ storage.knot.ink storage.type.ink
36 | {x}
37 | //<- keyword.control.ink
38 | //<~- keyword.control.ink
39 | //^ keyword.control.ink
40 | -> END
41 | //<-- keyword.divert.ink keyword.other.ink
42 | //^ source.ink
43 | // ^^^ support.constant.ink
44 | 


--------------------------------------------------------------------------------
/tests/cases/diverts/tunnel_vs_thread_behaviour.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | -> knot_with_options ->
 4 | //<-- keyword.divert.ink keyword.other.ink
 5 | //^ source.ink
 6 | // ^^^^^^^^^^^^^^^^^ variable.other.knot.ink
 7 | //                  ^ source.ink
 8 | //                   ^^ keyword.divert.ink keyword.other.ink
 9 | Finished tunnel.
10 | //<---------------- source.ink
11 | Starting thread.
12 | //<---------------- source.ink
13 | <- thread_with_options
14 | //<-- keyword.divert.ink keyword.other.ink
15 | //^ source.ink
16 | // ^^^^^^^^^^^^^^^^^^^ variable.other.knot.ink
17 | * E
18 | //<- keyword.choice.ink
19 | //<~-- source.ink
20 | -
21 | //<- keyword.gather.ink
22 | Done.
23 | //<----- source.ink
24 | == knot_with_options ==
25 | //<-- storage.knot.ink storage.type.ink
26 | //^ source.ink
27 | // ^^^^^^^^^^^^^^^^^ entity.name.function.ink
28 | //                  ^ source.ink
29 | //                   ^^ storage.knot.ink storage.type.ink
30 | * A
31 | //<- keyword.choice.ink
32 | //<~-- source.ink
33 | * B
34 | //<- keyword.choice.ink
35 | //<~-- source.ink
36 | -
37 | //<- keyword.gather.ink
38 | ->->
39 | //<-- keyword.divert.ink keyword.other.ink
40 | //^^ keyword.divert.ink keyword.other.ink
41 | == thread_with_options ==
42 | //<-- storage.knot.ink storage.type.ink
43 | //^ source.ink
44 | // ^^^^^^^^^^^^^^^^^^^ entity.name.function.ink
45 | //                    ^ source.ink
46 | //                     ^^ storage.knot.ink storage.type.ink
47 | * C
48 | //<- keyword.choice.ink
49 | //<~-- source.ink
50 | * D
51 | //<- keyword.choice.ink
52 | //<~-- source.ink
53 | - -> DONE
54 | //<- keyword.gather.ink
55 | //<~- source.ink
56 | //^^ keyword.divert.ink keyword.other.ink
57 | //  ^ source.ink
58 | //   ^^^^ support.constant.ink
59 | 


--------------------------------------------------------------------------------
/tests/cases/evaluation/arithmetic.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | { 2 * 3 + 5 * 6 }
 4 | //<- keyword.control.ink
 5 | //<--------------- keyword.control.ink
 6 | //              ^ keyword.control.ink
 7 | {8 mod 3}
 8 | //<- keyword.control.ink
 9 | //<------- keyword.control.ink
10 | //      ^ keyword.control.ink
11 | {13 % 5}
12 | //<- keyword.control.ink
13 | //<------ keyword.control.ink
14 | //     ^ keyword.control.ink
15 | { 7 / 3 }
16 | //<- keyword.control.ink
17 | //<-------- keyword.control.ink
18 | //      ^ keyword.control.ink
19 | { 7 / 3.0 }
20 | //<- keyword.control.ink
21 | //<--------- keyword.control.ink
22 | //        ^ keyword.control.ink
23 | { 10 - 2 }
24 | //<- keyword.control.ink
25 | //<-------- keyword.control.ink
26 | //       ^ keyword.control.ink
27 | { 2 * (5-1) }
28 | //<- keyword.control.ink
29 | //<----------- keyword.control.ink
30 | //          ^ keyword.control.ink
31 | 


--------------------------------------------------------------------------------
/tests/cases/evaluation/basic_string_literals.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | VAR x = "Hello world 1"
 4 | //<--- storage.type.ink storage.type.var.ink
 5 | // ^ source.ink
 6 | //  ^ variable.other.ink
 7 | //   ^ source.ink
 8 | //    ^ keyword.operator.assignment.ink
 9 | //     ^ source.ink
10 | //      ^ punctuation.definition.string.begin.ink
11 | //       ^^^^^^^^^^^^^ string.quoted.double.ink
12 | //                    ^ punctuation.definition.string.end.ink
13 | {x}
14 | //<- keyword.control.ink
15 | //<~- keyword.control.ink
16 | //^ keyword.control.ink
17 | Hello {"world"} 2.
18 | //<----- source.ink
19 | //    ^ keyword.control.ink
20 | //     ^^^^^^^ keyword.control.ink
21 | //            ^ keyword.control.ink
22 | //             ^^^^ source.ink
23 | 


--------------------------------------------------------------------------------
/tests/cases/evaluation/evaluating_function_variable_state_bug.ink:
--------------------------------------------------------------------------------
  1 | // SYNTAX TEST "source.ink"
  2 | 
  3 | Start
  4 | //<----- source.ink
  5 | -> tunnel ->
  6 | //<-- keyword.divert.ink keyword.other.ink
  7 | //^ source.ink
  8 | // ^^^^^^ variable.other.knot.ink
  9 | //       ^ source.ink
 10 | //        ^^ keyword.divert.ink keyword.other.ink
 11 | End
 12 | //<--- source.ink
 13 | -> END
 14 | //<-- keyword.divert.ink keyword.other.ink
 15 | //^ source.ink
 16 | // ^^^ support.constant.ink
 17 | == tunnel ==
 18 | //<-- storage.knot.ink storage.type.ink
 19 | //^ source.ink
 20 | // ^^^^^^ entity.name.function.ink
 21 | //       ^ source.ink
 22 | //        ^^ storage.knot.ink storage.type.ink
 23 | In tunnel.
 24 | //<---------- source.ink
 25 | ->->
 26 | //<-- keyword.divert.ink keyword.other.ink
 27 | //^^ keyword.divert.ink keyword.other.ink
 28 | === function function_to_evaluate() ===
 29 | //<--- storage.knot.ink storage.type.ink
 30 | // ^ source.ink
 31 | //  ^^^^^^^^ storage.type.ink
 32 | //          ^ source.ink
 33 | //           ^^^^^^^^^^^^^^^^^^^^ entity.name.function.ink
 34 | //                               ^ punctuation.section.parens.begin.ink
 35 | //                                ^ punctuation.section.parens.end.ink
 36 | //                                 ^ source.ink
 37 | //                                  ^^^ storage.knot.ink storage.type.ink
 38 |     { zero_equals_(1):
 39 | //<---- source.ink
 40 | //  ^ keyword.control.ink
 41 | //   ^^^^^^^^^^^^^^^^^ keyword.control.ink
 42 |         ~ return "WRONG"
 43 | //<-------- source.ink
 44 | //      ^ keyword.logic.ink
 45 | //       ^ source.ink
 46 | //        ^^^^^^ keyword.control.ink
 47 | //              ^ source.ink
 48 | //               ^ punctuation.definition.string.begin.ink
 49 | //                ^^^^^ string.quoted.double.ink
 50 | //                     ^ punctuation.definition.string.end.ink
 51 |     - else:
 52 | //<---- source.ink
 53 | //  ^ keyword.control.ink
 54 | //   ^ source.ink
 55 | //    ^^^^ keyword.control.ink
 56 | //        ^ keyword.control.ink
 57 |         ~ return "RIGHT"
 58 | //<-------- source.ink
 59 | //      ^ keyword.logic.ink
 60 | //       ^ source.ink
 61 | //        ^^^^^^ keyword.control.ink
 62 | //              ^ source.ink
 63 | //               ^ punctuation.definition.string.begin.ink
 64 | //                ^^^^^ string.quoted.double.ink
 65 | //                     ^ punctuation.definition.string.end.ink
 66 |     }
 67 | //<---- source.ink
 68 | //  ^ keyword.control.ink
 69 | === function zero_equals_(k) ===
 70 | //<--- storage.knot.ink storage.type.ink
 71 | // ^ source.ink
 72 | //  ^^^^^^^^ storage.type.ink
 73 | //          ^ source.ink
 74 | //           ^^^^^^^^^^^^ entity.name.function.ink
 75 | //                       ^ punctuation.section.parens.begin.ink
 76 | //                        ^ variable.parameter.function.ink
 77 | //                         ^ punctuation.section.parens.end.ink
 78 | //                          ^ source.ink
 79 | //                           ^^^ storage.knot.ink storage.type.ink
 80 |     ~ do_nothing(0)
 81 | //<---- source.ink
 82 | //  ^ keyword.logic.ink
 83 | //   ^ source.ink
 84 | //    ^^^^^^^^^^ variable.function.ink
 85 | //              ^ punctuation.section.parens.begin.ink
 86 | //               ^ constant.numeric.ink
 87 | //                ^ punctuation.section.parens.end.ink
 88 |     ~ return  (0 == k)
 89 | //<---- source.ink
 90 | //  ^ keyword.logic.ink
 91 | //   ^ source.ink
 92 | //    ^^^^^^ keyword.control.ink
 93 | //          ^^ source.ink
 94 | //            ^ punctuation.section.parens.begin.ink
 95 | //             ^ constant.numeric.ink
 96 | //              ^ source.ink
 97 | //               ^^ keyword.operator.comparison.ink
 98 | //                 ^ source.ink
 99 | //                  ^ variable.other.ink
100 | //                   ^ punctuation.section.parens.end.ink
101 | === function do_nothing(k)
102 | //<--- storage.knot.ink storage.type.ink
103 | // ^ source.ink
104 | //  ^^^^^^^^ storage.type.ink
105 | //          ^ source.ink
106 | //           ^^^^^^^^^^ entity.name.function.ink
107 | //                     ^ punctuation.section.parens.begin.ink
108 | //                      ^ variable.parameter.function.ink
109 | //                       ^ punctuation.section.parens.end.ink
110 |     ~ return 0
111 | //<---- source.ink
112 | //  ^ keyword.logic.ink
113 | //   ^ source.ink
114 | //    ^^^^^^ keyword.control.ink
115 | //          ^ source.ink
116 | //           ^ constant.numeric.ink
117 | 


--------------------------------------------------------------------------------
/tests/cases/extra/gather_tunnel_threads.ink:
--------------------------------------------------------------------------------
  1 | // SYNTAX TEST "source.ink"
  2 | 
  3 | /** MISC **********************************************************************/
  4 | 
  5 | -> knot
  6 | //<-- keyword.divert.ink keyword.other.ink
  7 | //^ source.ink
  8 | // ^^^^ variable.other.knot.ink
  9 | === knot
 10 | //<--- storage.knot.ink storage.type.ink
 11 | // ^ source.ink
 12 | //  ^^^^ entity.name.function.ink
 13 | -> knot.gather
 14 | //<-- keyword.divert.ink keyword.other.ink
 15 | //^ source.ink
 16 | // ^^^^ variable.other.knot.ink
 17 | //     ^ punctuation.accessor.ink
 18 | //      ^^^^^^ variable.other.stitch.ink
 19 | - (gather) g
 20 | //<- keyword.gather.ink
 21 | //<~- source.ink
 22 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
 23 | // ^^^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
 24 | //       ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
 25 | //        ^^ source.ink
 26 | -> DONE
 27 | //<-- keyword.divert.ink keyword.other.ink
 28 | //^ source.ink
 29 | // ^^^^ support.constant.ink
 30 | 
 31 | VAR knotCount = 0
 32 | //<--- storage.type.ink storage.type.var.ink
 33 | // ^ source.ink
 34 | //  ^^^^^^^^^ variable.other.ink
 35 | //           ^ source.ink
 36 | //            ^ keyword.operator.assignment.ink
 37 | //             ^ source.ink
 38 | //              ^ constant.numeric.ink
 39 | VAR stitchCount = 0
 40 | //<--- storage.type.ink storage.type.var.ink
 41 | // ^ source.ink
 42 | //  ^^^^^^^^^^^ variable.other.ink
 43 | //             ^ source.ink
 44 | //              ^ keyword.operator.assignment.ink
 45 | //               ^ source.ink
 46 | //                ^ constant.numeric.ink
 47 | -> gather_count_test ->
 48 | //<-- keyword.divert.ink keyword.other.ink
 49 | //^ source.ink
 50 | // ^^^^^^^^^^^^^^^^^ variable.other.knot.ink
 51 | //                  ^ source.ink
 52 | //                   ^^ keyword.divert.ink keyword.other.ink
 53 | ~ knotCount = 0
 54 | //<- keyword.logic.ink
 55 | //<~- source.ink
 56 | //^^^^^^^^^ variable.other.ink
 57 | //         ^ source.ink
 58 | //          ^ keyword.operator.assignment.ink
 59 | //           ^ source.ink
 60 | //            ^ constant.numeric.ink
 61 | -> knot_count_test ->
 62 | //<-- keyword.divert.ink keyword.other.ink
 63 | //^ source.ink
 64 | // ^^^^^^^^^^^^^^^ variable.other.knot.ink
 65 | //                ^ source.ink
 66 | //                 ^^ keyword.divert.ink keyword.other.ink
 67 | ~ knotCount = 0
 68 | //<- keyword.logic.ink
 69 | //<~- source.ink
 70 | //^^^^^^^^^ variable.other.ink
 71 | //         ^ source.ink
 72 | //          ^ keyword.operator.assignment.ink
 73 | //           ^ source.ink
 74 | //            ^ constant.numeric.ink
 75 | -> knot_count_test ->
 76 | //<-- keyword.divert.ink keyword.other.ink
 77 | //^ source.ink
 78 | // ^^^^^^^^^^^^^^^ variable.other.knot.ink
 79 | //                ^ source.ink
 80 | //                 ^^ keyword.divert.ink keyword.other.ink
 81 | -> stitch_count_test ->
 82 | //<-- keyword.divert.ink keyword.other.ink
 83 | //^ source.ink
 84 | // ^^^^^^^^^^^^^^^^^ variable.other.knot.ink
 85 | //                  ^ source.ink
 86 | //                   ^^ keyword.divert.ink keyword.other.ink
 87 | == gather_count_test ==
 88 | //<-- storage.knot.ink storage.type.ink
 89 | //^ source.ink
 90 | // ^^^^^^^^^^^^^^^^^ entity.name.function.ink
 91 | //                  ^ source.ink
 92 | //                   ^^ storage.knot.ink storage.type.ink
 93 | VAR gatherCount = 0
 94 | //<--- storage.type.ink storage.type.var.ink
 95 | // ^ source.ink
 96 | //  ^^^^^^^^^^^ variable.other.ink
 97 | //             ^ source.ink
 98 | //              ^ keyword.operator.assignment.ink
 99 | //               ^ source.ink
100 | //                ^ constant.numeric.ink
101 | - (loop)
102 | //<- keyword.gather.ink
103 | //<~- source.ink
104 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
105 | // ^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
106 | //     ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
107 | ~ gatherCount++
108 | //<- keyword.logic.ink
109 | //<~- source.ink
110 | //^^^^^^^^^^^ variable.other.ink
111 | //           ^^ keyword.operator.arithmetic.ink
112 | {gatherCount} {loop}
113 | //<- keyword.control.ink
114 | //<~----------- keyword.control.ink
115 | //          ^ keyword.control.ink
116 | //           ^ source.ink
117 | //            ^ keyword.control.ink
118 | //             ^^^^ keyword.control.ink
119 | //                 ^ keyword.control.ink
120 | {gatherCount<3:->loop}
121 | //<~- keyword.control.ink
122 | //<-------------- keyword.control.ink
123 | //             ^^ keyword.divert.ink keyword.other.ink
124 | //               ^^^^ variable.other.knot.ink
125 | //                   ^ keyword.control.ink
126 | ->->
127 | //<-- keyword.divert.ink keyword.other.ink
128 | //^^ keyword.divert.ink keyword.other.ink
129 | == knot_count_test ==
130 | //<-- storage.knot.ink storage.type.ink
131 | //^ source.ink
132 | // ^^^^^^^^^^^^^^^ entity.name.function.ink
133 | //                ^ source.ink
134 | //                 ^^ storage.knot.ink storage.type.ink
135 | ~ knotCount++
136 | //<- keyword.logic.ink
137 | //<~- source.ink
138 | //^^^^^^^^^ variable.other.ink
139 | //         ^^ keyword.operator.arithmetic.ink
140 | {knotCount} {knot_count_test}
141 | //<- keyword.control.ink
142 | //<~--------- keyword.control.ink
143 | //        ^ keyword.control.ink
144 | //         ^ source.ink
145 | //          ^ keyword.control.ink
146 | //           ^^^^^^^^^^^^^^^ keyword.control.ink
147 | //                          ^ keyword.control.ink
148 | {knotCount<3:->knot_count_test}
149 | //^ keyword.control.ink
150 | //<~------------ keyword.control.ink
151 | //           ^^ keyword.divert.ink keyword.other.ink
152 | //             ^^^^^^^^^^^^^^^ variable.other.knot.ink
153 | //                            ^ keyword.control.ink
154 | ->->
155 | //<-- keyword.divert.ink keyword.other.ink
156 | //^^ keyword.divert.ink keyword.other.ink
157 | == stitch_count_test ==
158 | //<-- storage.knot.ink storage.type.ink
159 | //^ source.ink
160 | // ^^^^^^^^^^^^^^^^^ entity.name.function.ink
161 | //                  ^ source.ink
162 | //                   ^^ storage.knot.ink storage.type.ink
163 | ~ stitchCount = 0
164 | //<- keyword.logic.ink
165 | //<~- source.ink
166 | //^^^^^^^^^^^ variable.other.ink
167 | //           ^ source.ink
168 | //            ^ keyword.operator.assignment.ink
169 | //             ^ source.ink
170 | //              ^ constant.numeric.ink
171 | -> stitch ->
172 | //<-- keyword.divert.ink keyword.other.ink
173 | //^ source.ink
174 | // ^^^^^^ variable.other.knot.ink
175 | //       ^ source.ink
176 | //        ^^ keyword.divert.ink keyword.other.ink
177 | ~ stitchCount = 0
178 | //<- keyword.logic.ink
179 | //<~- source.ink
180 | //^^^^^^^^^^^ variable.other.ink
181 | //           ^ source.ink
182 | //            ^ keyword.operator.assignment.ink
183 | //             ^ source.ink
184 | //              ^ constant.numeric.ink
185 | -> stitch ->
186 | //<-- keyword.divert.ink keyword.other.ink
187 | //^ source.ink
188 | // ^^^^^^ variable.other.knot.ink
189 | //       ^ source.ink
190 | //        ^^ keyword.divert.ink keyword.other.ink
191 | ->->
192 | //<-- keyword.divert.ink keyword.other.ink
193 | //^^ keyword.divert.ink keyword.other.ink
194 | = stitch
195 | //<- storage.knot.ink storage.type.ink
196 | //<~- source.ink
197 | //^^^^^^ entity.name.function.ink
198 | ~ stitchCount++
199 | //<- keyword.logic.ink
200 | //<~- source.ink
201 | //^^^^^^^^^^^ variable.other.ink
202 | //           ^^ keyword.operator.arithmetic.ink
203 | {stitchCount} {stitch}
204 | //<- keyword.control.ink
205 | //<----------- keyword.control.ink
206 | //          ^ keyword.control.ink
207 | //           ^ source.ink
208 | //            ^ keyword.control.ink
209 | //             ^^^^^^ keyword.control.ink
210 | //                   ^ keyword.control.ink
211 | {stitchCount<3:->stitch}
212 | //<- keyword.control.ink
213 | //<-------------- keyword.control.ink
214 | //             ^^ keyword.divert.ink keyword.other.ink
215 | //               ^^^^^^ variable.other.knot.ink
216 | //                     ^ keyword.control.ink
217 | ->->
218 | //<-- keyword.divert.ink keyword.other.ink
219 | //^^ keyword.divert.ink keyword.other.ink
220 | 
221 | -> knot
222 | //<-- keyword.divert.ink keyword.other.ink
223 | //^ source.ink
224 | // ^^^^ variable.other.knot.ink
225 | === knot
226 | //<--- storage.knot.ink storage.type.ink
227 | // ^ source.ink
228 | //  ^^^^ entity.name.function.ink
229 |     <- threadA
230 | //<---- source.ink
231 | //  ^^ keyword.divert.ink keyword.other.ink
232 | //    ^ source.ink
233 | //     ^^^^^^^ variable.other.knot.ink
234 |     When should this get printed?
235 | //<--------------------------------- source.ink
236 |     -> DONE
237 | //<---- source.ink
238 | //  ^^ keyword.divert.ink keyword.other.ink
239 | //    ^ source.ink
240 | //     ^^^^ support.constant.ink
241 | === threadA
242 | //<--- storage.knot.ink storage.type.ink
243 | // ^ source.ink
244 | //  ^^^^^^^ entity.name.function.ink
245 |     -> tunnel ->
246 | //<---- source.ink
247 | //  ^^ keyword.divert.ink keyword.other.ink
248 | //    ^ source.ink
249 | //     ^^^^^^ variable.other.knot.ink
250 | //           ^ source.ink
251 | //            ^^ keyword.divert.ink keyword.other.ink
252 |     Finishing thread.
253 | //<--------------------- source.ink
254 |     -> DONE
255 | //<---- source.ink
256 | //  ^^ keyword.divert.ink keyword.other.ink
257 | //    ^ source.ink
258 | //     ^^^^ support.constant.ink
259 | === tunnel
260 | //<--- storage.knot.ink storage.type.ink
261 | // ^ source.ink
262 | //  ^^^^^^ entity.name.function.ink
263 |     -   I’m in a tunnel
264 | //<---- source.ink
265 | //  ^ keyword.gather.ink
266 | //   ^^^^^^^^^^^^^^^^^^ source.ink
267 |     *   I’m an option
268 | //<---- source.ink
269 | //  ^ keyword.choice.ink
270 | //   ^^^^^^^^^^^^^^^^ source.ink
271 |     -   ->->
272 | //<---- source.ink
273 | //  ^ keyword.gather.ink
274 | //   ^^^ source.ink
275 | //      ^^ keyword.divert.ink keyword.other.ink
276 | //        ^^ keyword.divert.ink keyword.other.ink
277 | 
278 | -> knot
279 | //<-- keyword.divert.ink keyword.other.ink
280 | //^ source.ink
281 | // ^^^^ variable.other.knot.ink
282 | === knot
283 | //<--- storage.knot.ink storage.type.ink
284 | // ^ source.ink
285 | //  ^^^^ entity.name.function.ink
286 |     <- threadB
287 | //<---- source.ink
288 | //  ^^ keyword.divert.ink keyword.other.ink
289 | //    ^ source.ink
290 | //     ^^^^^^^ variable.other.knot.ink
291 |     -> tunnel ->
292 | //<---- source.ink
293 | //  ^^ keyword.divert.ink keyword.other.ink
294 | //    ^ source.ink
295 | //     ^^^^^^ variable.other.knot.ink
296 | //           ^ source.ink
297 | //            ^^ keyword.divert.ink keyword.other.ink
298 |     THE END
299 | //<----------- source.ink
300 |     -> END
301 | //<---- source.ink
302 | //  ^^ keyword.divert.ink keyword.other.ink
303 | //    ^ source.ink
304 | //     ^^^ support.constant.ink
305 | === tunnel
306 | //<--- storage.knot.ink storage.type.ink
307 | // ^ source.ink
308 | //  ^^^^^^ entity.name.function.ink
309 |     - blah blah
310 | //<--- source.ink
311 | //  ^ keyword.gather.ink
312 | //   ^^^^^^^^^^ source.ink
313 |     * wigwag
314 | //<--- source.ink
315 | //  ^ keyword.choice.ink
316 | //   ^^^^^^^ source.ink
317 |     - ->->
318 | //<---- source.ink
319 | //  ^ keyword.gather.ink
320 | //   ^ source.ink
321 | //    ^^ keyword.divert.ink keyword.other.ink
322 | //      ^^ keyword.divert.ink keyword.other.ink
323 | === threadB
324 | //<--- storage.knot.ink storage.type.ink
325 | // ^ source.ink
326 | //  ^^^^^^^ entity.name.function.ink
327 |     *   option
328 | //<---- source.ink
329 | //  ^ keyword.choice.ink
330 | //   ^^^^^^^^^ source.ink
331 |     -   something
332 | //<---- source.ink
333 | //  ^ keyword.gather.ink
334 | //   ^^^^^^^^^^^^ source.ink
335 |         -> DONE
336 | //<-------- source.ink
337 | //      ^^ keyword.divert.ink keyword.other.ink
338 | //        ^ source.ink
339 | //         ^^^^ support.constant.ink
340 | 
341 | -> one_then_tother(-> tunnel)
342 | //<-- keyword.divert.ink keyword.other.ink
343 | //^ source.ink
344 | // ^^^^^^^^^^^^^^^ variable.function.ink
345 | //                ^ punctuation.section.parens.begin.ink
346 | //                 ^^ keyword.divert.ink keyword.other.ink
347 | //                   ^ source.ink
348 | //                    ^^^^^^ variable.other.knot.ink
349 | //                          ^ punctuation.section.parens.end.ink
350 | === one_then_tother(-> x) ===
351 | //<--- storage.knot.ink storage.type.ink
352 | // ^ source.ink
353 | //  ^^^^^^^^^^^^^^^ entity.name.function.ink
354 | //                 ^ punctuation.section.parens.begin.ink
355 | //                  ^^ keyword.divert.ink keyword.other.ink
356 | //                    ^ source.ink
357 | //                     ^ variable.other.knot.ink
358 | //                      ^ punctuation.section.parens.end.ink
359 | //                       ^ source.ink
360 | //                        ^^^ storage.knot.ink storage.type.ink
361 |     -> x -> end
362 | //<---- source.ink
363 | //  ^^ keyword.divert.ink keyword.other.ink
364 | //    ^ source.ink
365 | //     ^ variable.other.knot.ink
366 | //      ^ source.ink
367 | //       ^^ keyword.divert.ink keyword.other.ink
368 | //         ^ source.ink
369 | //          ^^^ variable.other.knot.ink
370 | === tunnel ===
371 | //<--- storage.knot.ink storage.type.ink
372 | // ^ source.ink
373 | //  ^^^^^^ entity.name.function.ink
374 | //        ^ source.ink
375 | //         ^^^ storage.knot.ink storage.type.ink
376 |     STUFF
377 | //<--------- source.ink
378 |     ->->
379 | //<---- source.ink
380 | //  ^^ keyword.divert.ink keyword.other.ink
381 | //    ^^ keyword.divert.ink keyword.other.ink
382 | === end ===
383 | //<--- storage.knot.ink storage.type.ink
384 | // ^ source.ink
385 | //  ^^^ entity.name.function.ink
386 | //     ^ source.ink
387 | //      ^^^ storage.knot.ink storage.type.ink
388 |     -> END
389 | //<---- source.ink
390 | //  ^^ keyword.divert.ink keyword.other.ink
391 | //    ^ source.ink
392 | //     ^^^^ support.constant.ink
393 | 


--------------------------------------------------------------------------------
/tests/cases/extra/knot_stitch_function_declaration.ink:
--------------------------------------------------------------------------------
  1 | // SYNTAX TEST "source.ink"
  2 | 
  3 | /** EXTERNALS *****************************************************************/
  4 | 
  5 | EXTERNAL message(x)
  6 | //<----- storage.type.external.ink
  7 | //      ^ source.ink
  8 | //       ^^^^^^^ entity.name.function.ink
  9 | //              ^ punctuation.section.parens.begin.ink
 10 | //               ^ variable.parameter.function.ink
 11 | //                ^ punctuation.section.parens.end.ink
 12 | EXTERNAL multiply(x,y)
 13 | //<----- storage.type.external.ink
 14 | //      ^ source.ink
 15 | //       ^^^^^^^^ entity.name.function.ink
 16 | //               ^ punctuation.section.parens.begin.ink
 17 | //                ^ variable.parameter.function.ink
 18 | //                 ^ punctuation.separator.ink
 19 | //                  ^ variable.parameter.function.ink
 20 | //                   ^ punctuation.section.parens.end.ink
 21 | EXTERNAL times(i, str)
 22 | //<----- storage.type.external.ink
 23 | //      ^ source.ink
 24 | //       ^^^^^ entity.name.function.ink
 25 | //            ^ punctuation.section.parens.begin.ink
 26 | //             ^ variable.parameter.function.ink
 27 | //              ^ punctuation.separator.ink
 28 | //               ^ source.ink
 29 | //                ^^^ variable.parameter.function.ink
 30 | //                   ^ punctuation.section.parens.end.ink
 31 | 
 32 | /** FUNCTIONS *****************************************************************/
 33 | 
 34 | == function passthrough(x)
 35 | //<-- storage.knot.ink storage.type.ink
 36 | //^ source.ink
 37 | // ^^^^^^^^ storage.type.ink
 38 | //         ^ source.ink
 39 | //          ^^^^^^^^^^^ entity.name.function.ink
 40 | //                     ^ punctuation.section.parens.begin.ink
 41 | //                      ^ variable.parameter.function.ink
 42 | //                       ^ punctuation.section.parens.end.ink
 43 | In passthrough
 44 | //<-------------- source.ink
 45 | ~ return x
 46 | //<- keyword.logic.ink
 47 | //<~- source.ink
 48 | //^^^^^^ keyword.control.ink
 49 | //      ^ source.ink
 50 | //       ^ variable.other.ink
 51 | 
 52 | == function increment(x) ==
 53 | //<-- storage.knot.ink storage.type.ink
 54 | //^ source.ink
 55 | // ^^^^^^^^ storage.type.ink
 56 | //         ^ source.ink
 57 | //          ^^^^^^^^^ entity.name.function.ink
 58 | //                   ^ punctuation.section.parens.begin.ink
 59 | //                    ^ variable.parameter.function.ink
 60 | //                     ^ punctuation.section.parens.end.ink
 61 | //                      ^ source.ink
 62 | //                       ^^ storage.knot.ink storage.type.ink
 63 | ~ return x + 1
 64 | //<- keyword.logic.ink
 65 | //<~- source.ink
 66 | //^^^^^^ keyword.control.ink
 67 | //      ^ source.ink
 68 | //       ^  variable.other.ink
 69 | //        ^ source.ink
 70 | //         ^ keyword.operator.arithmetic.ink
 71 | //          ^ source.ink
 72 | //           ^ constant.numeric.ink
 73 | 
 74 | ==  function multiply( x ,  abc ) ===
 75 | //<-- storage.knot.ink storage.type.ink
 76 | //^^ source.ink
 77 | //  ^^^^^^^^ storage.type.ink
 78 | //          ^ source.ink
 79 | //           ^^^^^^^^ entity.name.function.ink
 80 | //                   ^ punctuation.section.parens.begin.ink
 81 | //                    ^ source.ink
 82 | //                     ^ variable.parameter.function.ink
 83 | //                      ^ source.ink
 84 | //                       ^ punctuation.separator.ink
 85 | //                        ^^ source.ink
 86 | //                          ^^^ variable.parameter.function.ink
 87 | //                             ^ source.ink
 88 | //                              ^ punctuation.section.parens.end.ink
 89 | //                               ^ source.ink
 90 | //                                ^^^ storage.knot.ink storage.type.ink
 91 | ~ return x * abc
 92 | //<- keyword.logic.ink
 93 | //<~- source.ink
 94 | //^^^^^^ keyword.control.ink
 95 | //      ^ source.ink
 96 | //       ^ variable.other.ink
 97 | //        ^ source.ink
 98 | //         ^ keyword.operator.arithmetic.ink
 99 | //          ^ source.ink
100 | //           ^^^ variable.other.ink
101 | 
102 | === 1_knot ===
103 | //<--- storage.knot.ink storage.type.ink
104 | // ^ source.ink
105 | //  ^^^^^^ entity.name.function.ink
106 | //        ^ source.ink
107 | //          ^^^ storage.knot.ink storage.type.ink
108 | = 1stitch
109 | //<- storage.knot.ink storage.type.ink
110 | //<~- source.ink
111 | //^^^^^^^^ entity.name.function.ink
112 |     ...
113 | //<------- source.ink
114 | = stitch2(ab)
115 | //<- storage.knot.ink storage.type.ink
116 | //<~- source.ink
117 | //^^^^^^^ entity.name.function.ink
118 | //       ^ punctuation.section.parens.begin.ink
119 | //        ^^ variable.parameter.function.ink
120 | //          ^ punctuation.section.parens.end.ink
121 |     ...
122 | //<------- source.ink
123 | 
124 | === 2_knot(with, param)   ==
125 | //<--- storage.knot.ink storage.type.ink
126 | // ^ source.ink
127 | //  ^^^^^^ entity.name.function.ink
128 | //        ^ punctuation.section.parens.begin.ink
129 | //         ^^^^ variable.parameter.function.ink
130 | //             ^ punctuation.separator.ink
131 | //              ^ source.ink
132 | //               ^^^^^ variable.parameter.function.ink
133 | //                    ^ punctuation.section.parens.end.ink
134 | //                     ^^^ source.ink
135 | //                        ^^ storage.knot.ink storage.type.ink
136 | 


--------------------------------------------------------------------------------
/tests/cases/extra/tags.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | * [Hi] Hello -> END #hey
 4 | //<- keyword.choice.ink
 5 | //<~- source.ink
 6 | //^ keyword.choice.suppression.ink keyword.control.ink
 7 | // ^^ source.ink
 8 | //   ^ keyword.choice.suppression.ink keyword.control.ink
 9 | //    ^^^^^^ source.ink
10 | //          ^ source.ink
11 | //           ^^ keyword.divert.ink keyword.other.ink
12 | //             ^ source.ink
13 | //              ^^^ support.constant.ink
14 | //                 ^ source.ink
15 | //                  ^ string.quoted.other.ink entity.tag.ink punctuation.definition.comment.ink comment.line.ink entity.tag.begin.ink
16 | //                   ^^^ string.quoted.other.ink entity.tag.ink
17 | 
18 | * { test } visible choice #hey
19 | //<- keyword.choice.ink
20 | //<~- source.ink
21 | //^ keyword.control.ink
22 | // ^^^^^^ keyword.control.ink
23 | //       ^ keyword.control.ink
24 | //        ^^^^^^^^^^^^^^^ source.ink
25 | //                       ^ source.ink
26 | //                        ^ string.quoted.other.ink entity.tag.ink punctuation.definition.comment.ink comment.line.ink entity.tag.begin.ink
27 | //                         ^^^ string.quoted.other.ink entity.tag.ink
28 | 
29 | *   (firstOpt) [First choice]   #tag
30 | //<- keyword.choice.ink
31 | //<~--- source.ink
32 | //  ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
33 | //   ^^^^^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
34 | //           ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
35 | //            ^ source.ink
36 | //             ^ keyword.choice.suppression.ink keyword.control.ink
37 | //              ^^^^^^^^^^^^ source.ink
38 | //                          ^ keyword.choice.suppression.ink keyword.control.ink
39 | //                           ^^^ source.ink
40 | //                              ^ string.quoted.other.ink entity.tag.ink punctuation.definition.comment.ink comment.line.ink entity.tag.begin.ink
41 | //                               ^^^ string.quoted.other.ink entity.tag.ink
42 | 
43 | VAR x = 2
44 | //<--- storage.type.ink storage.type.var.ink
45 | // ^ source.ink
46 | //  ^ variable.other.ink
47 | //   ^ source.ink
48 | //    ^ keyword.operator.assignment.ink
49 | //     ^ source.ink
50 | //      ^ constant.numeric.ink
51 | # author: Joe
52 | //<- string.quoted.other.ink entity.tag.ink punctuation.definition.comment.ink comment.line.ink entity.tag.begin.ink
53 | //<------------ string.quoted.other.ink entity.tag.ink
54 | # title: My Great Story
55 | //<- string.quoted.other.ink entity.tag.ink punctuation.definition.comment.ink comment.line.ink entity.tag.begin.ink
56 | //<---------------------- string.quoted.other.ink entity.tag.ink
57 | This is the content
58 | //<------------------- source.ink
59 | == knot ==
60 | //<-- storage.knot.ink storage.type.ink
61 | //^ source.ink
62 | // ^^^^ entity.name.function.ink
63 | //     ^ source.ink
64 | //      ^^ storage.knot.ink storage.type.ink
65 | # knot tag
66 | //<- string.quoted.other.ink entity.tag.ink punctuation.definition.comment.ink comment.line.ink entity.tag.begin.ink
67 | //<--------- string.quoted.other.ink entity.tag.ink
68 | Knot content
69 | //<------------ source.ink
70 | # end of knot tag
71 | //<- string.quoted.other.ink entity.tag.ink punctuation.definition.comment.ink comment.line.ink entity.tag.begin.ink
72 | //<---------------- string.quoted.other.ink entity.tag.ink
73 | -> END
74 | //<-- keyword.divert.ink keyword.other.ink
75 | //^ source.ink
76 | // ^^^ support.constant.ink
77 | = stitch
78 | //<- storage.knot.ink storage.type.ink
79 | //<~- source.ink
80 | //^^^^^^ entity.name.function.ink
81 | # stitch tag
82 | //<- string.quoted.other.ink entity.tag.ink punctuation.definition.comment.ink comment.line.ink entity.tag.begin.ink
83 | //<----------- string.quoted.other.ink entity.tag.ink
84 | Stitch content
85 | //<-------------- source.ink
86 | # this tag is below some content so isn't included in the static tags for the stitch
87 | //<- string.quoted.other.ink entity.tag.ink punctuation.definition.comment.ink comment.line.ink entity.tag.begin.ink
88 | //<----------------------------------------------------------------------------------- string.quoted.other.ink entity.tag.ink
89 | -> END
90 | //<-- keyword.divert.ink keyword.other.ink
91 | //^ source.ink
92 | // ^^^ support.constant.ink
93 | 


--------------------------------------------------------------------------------
/tests/cases/extra/todo.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | TODO: Lorem ipsum
 4 | //<---- comment.line.ink entity.todo.ink constant.other entity.todo.begin.ink
 5 | //  ^^^^^^^^^^^^^ comment.line.ink entity.todo.ink
 6 | 
 7 | === knot ===
 8 | //<--- storage.knot.ink storage.type.ink
 9 | // ^ source.ink
10 | //  ^^^^ entity.name.function.ink
11 | //      ^ source.ink
12 | //       ^^^ storage.knot.ink storage.type.ink
13 | = stitch
14 | //<- storage.knot.ink storage.type.ink
15 | //<~- source.ink
16 | //^^^^^^ entity.name.function.ink
17 |     {
18 | //<---- source.ink
19 | //  ^ keyword.control.ink
20 |         - (variable != 4):
21 | //<-------- source.ink
22 | //      ^ keyword.control.ink
23 | //       ^ source.ink
24 | //        ^^^^^^^^^^^^^^^ keyword.control.ink
25 | //                       ^ keyword.control.ink
26 |             TODO: Lorem ipsum
27 | //<------------ comment.line.ink entity.todo.ink
28 | //          ^^^^ comment.line.ink entity.todo.ink constant.other entity.todo.begin.ink
29 | //              ^^^^^^^^^^^^^ comment.line.ink entity.todo.ink
30 |             Text
31 | //<------------ source.ink
32 |     }
33 | //<---- source.ink
34 | //  ^ keyword.control.ink
35 | 
36 |     {condition:
37 | //<---- source.ink
38 | //  ^ keyword.control.ink
39 | //   ^^^^^^^^^^ keyword.control.ink
40 |         TODO: Lorem ipsum
41 | //<-------- comment.line.ink entity.todo.ink
42 | //      ^^^^ comment.line.ink entity.todo.ink constant.other entity.todo.begin.ink
43 | //          ^^^^^^^^^^^^^ comment.line.ink entity.todo.ink
44 |         Text
45 | //<-------- source.ink
46 |     }
47 | //<---- source.ink
48 | //  ^ keyword.control.ink
49 | 
50 | TODO: Lorem ipsum
51 | //<---- comment.line.ink entity.todo.ink constant.other entity.todo.begin.ink
52 | //  ^^^^^^^^^^^^^ comment.line.ink entity.todo.ink
53 | 
54 | * (label) {condition} [Hello] Choice
55 | //<- keyword.choice.ink
56 | //<~- source.ink
57 | //^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
58 | // ^^^^^ string.label.ink entity.name.label.ink string.quoted.other.ink
59 | //      ^ string.label.ink entity.name.label.ink string.quoted.other.ink punctuation.definition.string.label.begin.ink punctuation.definition.string.begin.ink
60 | //       ^ source.ink
61 | //        ^ keyword.control.ink
62 | //         ^^^^^^^^^ keyword.control.ink
63 | //                  ^ keyword.control.ink
64 | //                   ^ source.ink
65 | //                    ^ keyword.choice.suppression.ink keyword.control.ink
66 | //                     ^^^^^ source.ink
67 | //                          ^ keyword.choice.suppression.ink keyword.control.ink
68 | //                           ^^^^^^^ source.ink
69 | TODO: Lorem ipsum
70 | //<---- comment.line.ink entity.todo.ink constant.other entity.todo.begin.ink
71 | //  ^^^^^^^^^^^^^ comment.line.ink entity.todo.ink
72 | -> the_end
73 | //<-- keyword.divert.ink keyword.other.ink
74 | //^ source.ink
75 | // ^^^^^^^ variable.other.knot.ink entity.name.variable.other.knot.ink
76 | 
77 | /*
78 | //<-- comment.block.ink punctuation.definition.comment.ink
79 |     TODO: Lorem ipsum
80 | //<--------------------- comment.block.ink
81 | */
82 | //<-- comment.block.ink punctuation.definition.comment.ink
83 | 


--------------------------------------------------------------------------------
/tests/cases/glue/simple_glue.ink:
--------------------------------------------------------------------------------
 1 | // SYNTAX TEST "source.ink"
 2 | 
 3 | Some <>
 4 | //<----- source.ink
 5 | //   ^^ keyword.glue.ink keyword.other.ink
 6 | content<> with glue.
 7 | //<-------source.ink
 8 | //     ^^ keyword.glue.ink keyword.other.ink
 9 | //       ^^^^^^^^^^^^ source.ink
10 | 


--------------------------------------------------------------------------------
/tests/tsonfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "module": "commonjs",
 4 |     "target": "es5",
 5 |     "strict": true,
 6 |     "skipLibCheck": true
 7 |   },
 8 |   "exclude": [
 9 |     "cases",
10 |     "baselines",
11 |     "generated",
12 |     "node_modules"
13 |   ]
14 | }
15 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/evaluation/evaluating_ink_functions_from_game.ink:
--------------------------------------------------------------------------------
1 | Top level content
2 | * choice
3 | == somewhere ==
4 | = here
5 | -> DONE
6 | == function test ==
7 | ~ return -> somewhere.here
8 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/evaluation/evaluating_ink_functions_from_game_2.ink:
--------------------------------------------------------------------------------
 1 | One
 2 | Two
 3 | Three
 4 | == function func1 ==
 5 | This is a function
 6 | ~ return 5
 7 | == function func2 ==
 8 | This is a function without a return value
 9 | ~ return
10 | == function add(x,y) ==
11 | x = {x}, y = {y}
12 | ~ return x + y
13 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/evaluation/evaluation_stack_leaks.ink:
--------------------------------------------------------------------------------
 1 | {false:
 2 | 
 3 | - else:
 4 |     else
 5 | }
 6 | {6:
 7 | - 5: five
 8 | - else: else
 9 | }
10 | -> onceTest ->
11 | -> onceTest ->
12 | == onceTest ==
13 | {once:
14 | - hi
15 | }
16 | ->->
17 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/evaluation/factorial_by_reference.ink:
--------------------------------------------------------------------------------
 1 | VAR result = 0
 2 | ~ factorialByRef(result, 5)
 3 | { result }
 4 | == function factorialByRef(ref r, n) ==
 5 | { r == 0:
 6 |     ~ r = 1
 7 | }
 8 | { n > 1:
 9 |     ~ r = r * n
10 |     ~ factorialByRef(r, n-1)
11 | }
12 | ~ return
13 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/evaluation/factorial_recursive.ink:
--------------------------------------------------------------------------------
1 | { factorial(5) }
2 | == function factorial(n) ==
3 |  { n == 1:
4 |     ~ return 1
5 |  - else:
6 |     ~ return (n * factorial(n-1))
7 |  }
8 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/evaluation/increment.ink:
--------------------------------------------------------------------------------
1 | VAR x = 5
2 | ~ x++
3 | {x}
4 | ~ x--
5 | {x}
6 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/evaluation/literal_unary.ink:
--------------------------------------------------------------------------------
1 | VAR negativeLiteral = -1
2 | VAR negativeLiteral2 = not not false
3 | VAR negativeLiteral3 = !(0)
4 | {negativeLiteral}
5 | {negativeLiteral2}
6 | {negativeLiteral3}
7 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/lists/empty_list_origin.ink:
--------------------------------------------------------------------------------
1 | LIST list = a, b
2 | {LIST_ALL(list)}
3 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/lists/empty_list_origin_after_assignment.ink:
--------------------------------------------------------------------------------
1 | LIST x = a, b, c
2 | ~ x = ()
3 | {LIST_ALL(x)}
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/lists/list_basic_operations.ink:
--------------------------------------------------------------------------------
1 | LIST list = a, (b), c, (d), e
2 | {list}
3 | {(a, c) + (b, e)}
4 | {(a, b, c) ^ (c, b, e)}
5 | {list ? (b, d, e)}
6 | {list ? (d, b)}
7 | {list !? (c)}
8 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/lists/list_mixed_items.ink:
--------------------------------------------------------------------------------
1 | LIST list = (a), b, (c), d, e
2 | LIST list2 = x, (y), z
3 | {list + list2}
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/lists/list_random.ink:
--------------------------------------------------------------------------------
 1 | LIST l = A, (B), (C), (D), E
 2 | {LIST_RANDOM(l)}
 3 | {LIST_RANDOM (l)}
 4 | {LIST_RANDOM (l)}
 5 | {LIST_RANDOM (l)}
 6 | {LIST_RANDOM (l)}
 7 | {LIST_RANDOM (l)}
 8 | {LIST_RANDOM (l)}
 9 | {LIST_RANDOM (l)}
10 | {LIST_RANDOM (l)}
11 | {LIST_RANDOM (l)}
12 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/lists/list_range.ink:
--------------------------------------------------------------------------------
 1 | LIST Food = Pizza, Pasta, Curry, Paella
 2 | LIST Currency = Pound, Euro, Dollar
 3 | LIST Numbers = One, Two, Three, Four, Five, Six, Seven
 4 | VAR all = ()
 5 | ~ all = LIST_ALL(Food) + LIST_ALL(Currency)
 6 | {all}
 7 | {LIST_RANGE(all, 2, 3)}
 8 | {LIST_RANGE(LIST_ALL(Numbers), Two, Six)}
 9 | {LIST_RANGE((Pizza, Pasta), -1, 100)} // allow out of range
10 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/lists/list_save_load.ink:
--------------------------------------------------------------------------------
 1 | LIST l1 = (a), b, (c)
 2 | LIST l2 = (x), y, z
 3 | VAR t = ()
 4 | ~ t = l1 + l2
 5 | {t}
 6 | == elsewhere ==
 7 | ~ t += z
 8 | {t}
 9 | -> END
10 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/lists/more_list_operations.ink:
--------------------------------------------------------------------------------
 1 | LIST list = l, m = 5, n
 2 | {LIST_VALUE(l)}
 3 | {list(1)}
 4 | ~ temp t = list()
 5 | ~ t += n
 6 | {t}
 7 | ~ t = LIST_ALL(t)
 8 | ~ t -= n
 9 | {t}
10 | ~ t = LIST_INVERT(t)
11 | {t}
12 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/logic/logic_lines_with_newlines.ink:
--------------------------------------------------------------------------------
1 | ~ func ()
2 | text 2
3 | ~ temp tempVar = func ()
4 | text 2
5 | == function func ()
6 |     text1
7 |     ~ return true
8 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/logic/multiline_logic_with_glue.ink:
--------------------------------------------------------------------------------
1 | {true:
2 |     a
3 | } <> b
4 | {true:
5 |     a
6 | } <> { true:
7 |     b
8 | }
9 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/logic/nested_pass_by_reference.ink:
--------------------------------------------------------------------------------
 1 | VAR globalVal = 5
 2 | {globalVal}
 3 | ~ squaresquare(globalVal)
 4 | {globalVal}
 5 | == function squaresquare(ref x) ==
 6 |  {square(x)} {square(x)}
 7 |  ~ return
 8 | == function square(ref x) ==
 9 |  ~ x = x * x
10 |  ~ return
11 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/logic/print_num.ink:
--------------------------------------------------------------------------------
 1 | . {print_num(4)} .
 2 | . {print_num(15)} .
 3 | . {print_num(37)} .
 4 | . {print_num(101)} .
 5 | . {print_num(222)} .
 6 | . {print_num(1234)} .
 7 | 
 8 | === function print_num(x) ===
 9 | {
10 |     - x >= 1000:
11 |         {print_num(x / 1000)} thousand { x mod 1000 > 0:{print_num(x mod 1000)}}
12 |     - x >= 100:
13 |         {print_num(x / 100)} hundred { x mod 100 > 0:and {print_num(x mod 100)}}
14 |     - x == 0:
15 |         zero
16 |     - else:
17 |         { x >= 20:
18 |             { x / 10:
19 |                 - 2: twenty
20 |                 - 3: thirty
21 |                 - 4: forty
22 |                 - 5: fifty
23 |                 - 6: sixty
24 |                 - 7: seventy
25 |                 - 8: eighty
26 |                 - 9: ninety
27 |             }
28 |             { x mod 10 > 0:<>-<>}
29 |         }
30 |         { x < 10 || x > 20:
31 |             { x mod 10:
32 |                 - 1: one
33 |                 - 2: two
34 |                 - 3: three
35 |                 - 4: four
36 |                 - 5: five
37 |                 - 6: six
38 |                 - 7: seven
39 |                 - 8: eight
40 |                 - 9: nine
41 |             }
42 |         - else:
43 |             { x:
44 |                 - 10: ten
45 |                 - 11: eleven
46 |                 - 12: twelve
47 |                 - 13: thirteen
48 |                 - 14: fourteen
49 |                 - 15: fifteen
50 |                 - 16: sixteen
51 |                 - 17: seventeen
52 |                 - 18: eighteen
53 |                 - 19: nineteen
54 |             }
55 |         }
56 | }
57 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/empty.ink:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/inkle/ink-tmlanguage/246fba563dec373a1076894a4ee78b8e99ac160d/tests/visual-inspection/misc/empty.ink


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/end.ink:
--------------------------------------------------------------------------------
1 | hello
2 | -> END
3 | world
4 | -> END
5 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/end2.ink:
--------------------------------------------------------------------------------
1 | -> test
2 | == test ==
3 | hello
4 | -> END
5 | world
6 | -> END
7 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/end_of_content.ink:
--------------------------------------------------------------------------------
1 | == test ==
2 | Content
3 | -> END
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/escape_character.ink:
--------------------------------------------------------------------------------
1 | {true:this is a '\|' character|this isn't}
2 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/hello_world.ink:
--------------------------------------------------------------------------------
1 | Hello world
2 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/identifiers_can_start_with_number.ink:
--------------------------------------------------------------------------------
1 | -> 2tests
2 | == 2tests ==
3 | ~ temp 512x2 = 512 * 2
4 | ~ temp 512x2p2 = 512x2 + 2
5 | 512x2 = {512x2}
6 | 512x2p2 = {512x2p2}
7 | -> DONE
8 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/include.ink:
--------------------------------------------------------------------------------
1 | INCLUDE includes/included_file.ink
2 |   INCLUDE includes/included_file_2.ink
3 | This is the main file.


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/includes/included_file.ink:
--------------------------------------------------------------------------------
1 | This is include 1.
2 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/includes/included_file_2.ink:
--------------------------------------------------------------------------------
1 | This is include 2.
2 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/includes/included_file_3.ink:
--------------------------------------------------------------------------------
1 | INCLUDE includes/included_file_4.ink
2 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/includes/included_file_4.ink:
--------------------------------------------------------------------------------
1 | VAR t2 = 5
2 | 
3 | The value of a variable in test file 2 is { t2 }.
4 | 
5 | == knot_in_2 ==
6 |  The value when accessed from knot_in_2 is { t2 }.
7 |  -> END
8 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/nested_include.ink:
--------------------------------------------------------------------------------
1 | INCLUDE includes/included_file_3.ink
2 | This is the main file
3 | -> knot_in_2
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/quote_character_significance.ink:
--------------------------------------------------------------------------------
1 | My name is "{"J{"o"}e"}"
2 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/misc/whitespace.ink:
--------------------------------------------------------------------------------
1 | -> firstKnot
2 | === firstKnot
3 |     Hello!
4 |     -> anotherKnot
5 | === anotherKnot
6 |     World.
7 |     -> END
8 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/newlines/newline_at_start_of_multiline_conditional.ink:
--------------------------------------------------------------------------------
1 | {isTrue():
2 |     x
3 | }
4 | === function isTrue()
5 |     X
6 |     ~ return true
7 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/newlines/newline_consistency_1.ink:
--------------------------------------------------------------------------------
1 | hello -> world
2 | == world
3 | world
4 | -> END
5 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/newlines/newline_consistency_2.ink:
--------------------------------------------------------------------------------
1 | * hello -> world
2 | == world
3 | world
4 | -> END
5 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/newlines/newline_consistency_3.ink:
--------------------------------------------------------------------------------
1 | * hello
2 | 	-> world
3 | == world
4 | world
5 | -> END
6 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/newlines/newlines_trimming_with_func_external_fallback.ink:
--------------------------------------------------------------------------------
1 | EXTERNAL TRUE ()
2 | Phrase 1
3 | { TRUE ():
4 |     Phrase 2
5 | }
6 | -> END
7 | === function TRUE ()
8 |     ~ return true
9 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/newlines/newlines_with_string_eval.ink:
--------------------------------------------------------------------------------
 1 | A
 2 | ~temp someTemp = string()
 3 | B
 4 | A
 5 | {string()}
 6 | B
 7 | === function string()
 8 |     ~ return "{3}"
 9 | }
10 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/sequences/all_sequences_types.ink:
--------------------------------------------------------------------------------
 1 | ~ SEED_RANDOM(1)
 2 | 
 3 | Once: {f_once()} {f_once()} {f_once()} {f_once()}
 4 | Stopping: {f_stopping()} {f_stopping()} {f_stopping()} {f_stopping()}
 5 | Default: {f_default()} {f_default()} {f_default()} {f_default()}
 6 | Cycle: {f_cycle()} {f_cycle()} {f_cycle()} {f_cycle()}
 7 | Shuffle: {f_shuffle()} {f_shuffle()} {f_shuffle()} {f_shuffle()}
 8 | Shuffle stopping: {f_shuffle_stopping()} {f_shuffle_stopping()} {f_shuffle_stopping()} {f_shuffle_stopping()}
 9 | Shuffle once: {f_shuffle_once()} {f_shuffle_once()} {f_shuffle_once()} {f_shuffle_once()}
10 | 
11 | == function f_once ==
12 | {once:
13 |     - one
14 |     - two
15 | }
16 | 
17 | == function f_stopping ==
18 | {stopping:
19 |     - one
20 |     - two
21 | }
22 | 
23 | == function f_default ==
24 | {one|two}
25 | 
26 | == function f_cycle ==
27 | {cycle:
28 |     - one
29 |     - two
30 | }
31 | 
32 | == function f_shuffle ==
33 | {shuffle:
34 |     - one
35 |     - two
36 | }
37 | 
38 | == function f_shuffle_stopping ==
39 | {stopping shuffle:
40 |     - one
41 |     - two
42 |     - final
43 | }
44 | 
45 | == function f_shuffle_once ==
46 | {shuffle once:
47 |     - one
48 |     - two
49 | }
50 | 
51 | == function f_shuffle_stopping_abbreviated ==
52 | {~$: one|two|final}
53 | 
54 | == function f_shuffle_once_abbreviated ==
55 | {~!: one|two}
56 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/sequences/blanks_in_inline_sequences.ink:
--------------------------------------------------------------------------------
 1 | 1. -> seq1 ->
 2 | 2. -> seq1 ->
 3 | 3. -> seq1 ->
 4 | 4. -> seq1 ->
 5 | \---
 6 | 1. -> seq2 ->
 7 | 2. -> seq2 ->
 8 | 3. -> seq2 ->
 9 | \---
10 | 1. -> seq3 ->
11 | 2. -> seq3 ->
12 | 3. -> seq3 ->
13 | \---
14 | 1. -> seq4 ->
15 | 2. -> seq4 ->
16 | 3. -> seq4 ->
17 | == seq1 ==
18 | {a||b}
19 | ->->
20 | == seq2 ==
21 | {|a}
22 | ->->
23 | == seq3 ==
24 | {a|}
25 | ->->
26 | == seq4 ==
27 | {|}
28 | ->->
29 | 
30 | // RESULT:
31 | // 1. a
32 | // 2.
33 | // 3. b
34 | // 4. b
35 | // ---
36 | // 1.
37 | // 2. a
38 | // 3. a
39 | // ---
40 | // 1. a
41 | // 2.
42 | // 3.
43 | // ---
44 | // 1.
45 | // 2.
46 | // 3.
47 | // ContinueMaximally
48 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/sequences/empty_sequence_content.ink:
--------------------------------------------------------------------------------
 1 | -> thing ->
 2 | -> thing ->
 3 | -> thing ->
 4 | -> thing ->
 5 | -> thing ->
 6 | Done.
 7 | == thing ==
 8 | {once:
 9 |   - Wait for it....
10 |   -
11 |   -
12 |   -  Surprise!
13 | }
14 | ->->
15 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/sequences/gather_read_count_with_initial_sequence.ink:
--------------------------------------------------------------------------------
1 | - (opts)
2 | {test:seen test}
3 | - (test)
4 | { -> opts |}
5 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/sequences/leading_newline_multiline_sequence.ink:
--------------------------------------------------------------------------------
1 | {stopping:
2 | - a line after an empty line
3 | - blah
4 | }
5 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/sequences/shuffle_stack_muddying.ink:
--------------------------------------------------------------------------------
 1 | * {condFunc()} [choice 1]
 2 | * {condFunc()} [choice 2]
 3 | * {condFunc()} [choice 3]
 4 | * {condFunc()} [choice 4]
 5 | === function condFunc() ===
 6 | {shuffle:
 7 |     - ~ return false
 8 |     - ~ return true
 9 |     - ~ return true
10 |     - ~ return false
11 | }
12 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/stories/extra_knots.ink:
--------------------------------------------------------------------------------
1 | === extra_knot ===
2 | - (extra_knot_gather) Knot Gather
3 | -> DONE
4 | 
5 | = extra_stitch
6 | - (extra_stitch_gather) Stitch Gather
7 | 
8 | -> DONE
9 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/stories/include.ink:
--------------------------------------------------------------------------------
1 | INCLUDE include_2.ink
2 | 
3 | === that_knot_2 ===
4 | Hello lala
5 | -> DONE
6 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/stories/include_2.ink:
--------------------------------------------------------------------------------
1 | 
2 | === that_knot_3 ===
3 | Hello lala
4 | -> DONE
5 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/stories/lists.ink:
--------------------------------------------------------------------------------
 1 | 
 2 | // // LIST volumeLevel = off, quiet, medium, loud, deafening
 3 | // // // ~ volumeLevel++
 4 | // // // ~ volumeLevel += 1
 5 | 
 6 | 
 7 | // // VAR lecturersVolume = quiet
 8 | // // VAR murmurersVolume = quiet
 9 | 
10 | // // VAR bidule = 0
11 | 
12 | // // LIST primeNumbers = two = 2, three = 3, five = 5
13 | 
14 | // // LIST DoctorsInSurgery = (Adams), Bernard, (Cartwright), Denver, Eamonn
15 | 
16 | // === knot_name ===
17 | 
18 | // {TURNS_SINCE(-> knot_name)}
19 | // {POW(0, 3)}
20 | 
21 | // {!toto: hello}
22 | 
23 | // -> DONE
24 | 
25 | // // { lecturersVolume < deafening:
26 | // // 	~ lecturersVolume++
27 | // // 	~ volumeLevel++
28 | // // 	~ volumeLevel += 1
29 | 
30 | // // 	{ lecturersVolume > murmurersVolume:
31 | // // 		~ murmurersVolume++
32 | // // 		The murmuring gets louder.
33 | // // 	}
34 | // // }
35 | 
36 | // // The lecturer has {LIST_VALUE(deafening) - LIST_VALUE(lecturersVolume)} notches still available to him.
37 | 
38 | // // ~ bidule = two
39 | 
40 | // // ~ DoctorsInSurgery = DoctorsInSurgery + Adams
41 | // // ~ DoctorsInSurgery += Adams  // this is the same as the above
42 | // // ~ DoctorsInSurgery -= Eamonn
43 | // // ~ DoctorsInSurgery += (Eamonn, Denver)
44 | // // ~ DoctorsInSurgery -= (Adams, Eamonn, Denver)
45 | 
46 | === knot_name ===
47 | 
48 | Yolo
49 | 
50 | -> DONE
51 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/stories/test.ink:
--------------------------------------------------------------------------------
 1 | INCLUDE extra_knots.ink
 2 | 
 3 | // Local diverts
 4 | -> knot
 5 | -> knot.knot_gather
 6 | 
 7 | -> knot.stitch
 8 | -> knot.stitch.stitch_choice
 9 | -> knot.stitch.stitch_gather
10 | 
11 | // Cross-files diverts
12 | -> extra_knot
13 | -> extra_knot.extra_knot_gather
14 | 
15 | -> extra_knot.extra_stitch
16 | -> extra_knot.extra_stitch.extra_stitch_gather
17 | 
18 | === knot ===
19 | Hello lala
20 | - (knot_gather) Named Gather
21 | -> DONE
22 | 
23 | = stitch
24 | * (stitch_choice) Named Choice
25 | - (stitch_gather) Named Gather
26 | -> DONE
27 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/strings/string_constants.ink:
--------------------------------------------------------------------------------
1 | {x}
2 | VAR x = kX
3 | CONST kX = "hi"
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/strings/string_contains.ink:
--------------------------------------------------------------------------------
1 | {"hello world" ? "o wo"}
2 | {"hello world" ? "something else"}
3 | {"hello" ? ""}
4 | {"" ? ""}
5 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/strings/string_type_coercion.ink:
--------------------------------------------------------------------------------
1 | {"5" == 5:same|different}
2 | {"blah" == 5:same|different}
3 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/strings/strings_in_choices.ink:
--------------------------------------------------------------------------------
1 | * \ {"test1"} ["test2 {"test3"}"] {"test4"}
2 | -> DONE
3 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/threads/multi_thread.ink:
--------------------------------------------------------------------------------
 1 | -> start
 2 | == start ==
 3 | -> tunnel ->
 4 | The end
 5 | -> END
 6 | == tunnel ==
 7 | <- place1
 8 | <- place2
 9 | -> DONE
10 | == place1 ==
11 | This is place 1.
12 | * choice in place 1
13 | - ->->
14 | == place2 ==
15 | This is place 2.
16 | * choice in place 2
17 | - ->->
18 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/threads/thread_done.ink:
--------------------------------------------------------------------------------
1 | This is a thread example
2 | <- example_thread
3 | The example is now complete.
4 | == example_thread ==
5 | Hello.
6 | -> DONE
7 | World.
8 | -> DONE
9 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/threads/thread_in_logic.ink:
--------------------------------------------------------------------------------
1 | -> once ->
2 | -> once ->
3 | == once ==
4 | {<- content|}
5 | ->->
6 | == content ==
7 | Content
8 | -> DONE
9 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/threads/top_flow_terminator_should_not_kill_thread_choices.ink:
--------------------------------------------------------------------------------
1 | <- move
2 | Limes
3 | === move
4 |     * boop
5 |         -> END
6 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/const.ink:
--------------------------------------------------------------------------------
1 | VAR x = c
2 | CONST c = 5
3 | {x}
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/multiple_constant_references.ink:
--------------------------------------------------------------------------------
1 | CONST CONST_STR = "ConstantString"
2 | VAR varStr = CONST_STR
3 | {varStr == CONST_STR:success}
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/set_non_existant_variable.ink:
--------------------------------------------------------------------------------
1 | VAR x = "world"
2 | Hello {x}.
3 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/temp_global_conflict.ink:
--------------------------------------------------------------------------------
 1 | -> outer
 2 | === outer
 3 | ~ temp x = 0
 4 | ~ f(x)
 5 | {x}
 6 | -> DONE
 7 | === function f(ref x)
 8 | ~temp local = 0
 9 | ~x=x
10 | {setTo3(local)}
11 | === function setTo3(ref x)
12 | ~x = 3
13 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/temp_not_found.ink:
--------------------------------------------------------------------------------
1 | {x}
2 | ~temp x = 5
3 | hello
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/temp_usage_in_options.ink:
--------------------------------------------------------------------------------
1 | ~ temp one = 1
2 | * \ {one}
3 | - End of choice
4 |     -> another
5 | * (another) this [is] another
6 |  -> DONE
7 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/temporaries_at_global_scope.ink:
--------------------------------------------------------------------------------
1 | VAR x = 5
2 | ~ temp y = 4
3 | {x}{y}
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/variable_declaration_in_conditional.ink:
--------------------------------------------------------------------------------
1 | VAR x = 0
2 | {true:
3 |     - ~ x = 5
4 | }
5 | {x}
6 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/variable_divert_target.ink:
--------------------------------------------------------------------------------
1 | VAR x = -> here
2 | -> there
3 | == there ==
4 | -> x
5 | == here ==
6 | Here.
7 | -> DONE
8 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/variable_get_set_api.ink:
--------------------------------------------------------------------------------
 1 | VAR x = 5
 2 | {x}
 3 | * [choice]
 4 | -
 5 | {x}
 6 | * [choice]
 7 | -
 8 | {x}
 9 | * [choice]
10 | -
11 | {x}
12 | -> DONE
13 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/variable_pointer_ref_from_knot.ink:
--------------------------------------------------------------------------------
 1 | VAR val = 5
 2 | -> knot ->
 3 | -> END
 4 | == knot ==
 5 | ~ inc(val)
 6 | {val}
 7 | ->->
 8 | == function inc(ref x) ==
 9 |     ~ x = x + 1
10 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/variable_swap_recurse.ink:
--------------------------------------------------------------------------------
 1 | ~ f(1, 1)
 2 | == function f(x, y) ==
 3 | { x == 1 and y == 1:
 4 |   ~ x = 2
 5 |   ~ f(y, x)
 6 | - else:
 7 |   {x} {y}
 8 | }
 9 | ~ return
10 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/warn_variable_not_found_1.ink:
--------------------------------------------------------------------------------
1 | VAR x = 0
2 | Hello world!
3 | {x}
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/variables/warn_variable_not_found_2.ink:
--------------------------------------------------------------------------------
1 | VAR y = 0
2 | Hello world!
3 | {y}
4 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/weaves/conditional_choice_in_weave.ink:
--------------------------------------------------------------------------------
 1 | - start
 2 |  {
 3 |     - true: * [go to a stitch] -> a_stitch
 4 |  }
 5 | - gather should be seen
 6 | -> DONE
 7 | 
 8 | = a_stitch
 9 |     result
10 |     -> END
11 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/weaves/conditional_choice_in_weave_2.ink:
--------------------------------------------------------------------------------
1 | - first gather
2 |     * [option 1]
3 |     * [option 2]
4 | - the main gather
5 | {false:
6 |     * unreachable option -> END
7 | }
8 | - bottom gather
9 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/weaves/unbalanced_weave_indentation.ink:
--------------------------------------------------------------------------------
1 | * * * First
2 | * * * * Very indented
3 | - - End
4 | -> END
5 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/weaves/weave_gathers.ink:
--------------------------------------------------------------------------------
1 | -
2 |  * one
3 |     * * two
4 |    - - three
5 |  *  four
6 |    - - five
7 | - six
8 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/weaves/weave_options.ink:
--------------------------------------------------------------------------------
1 | -> test
2 | === test
3 |     * Hello[.], world.
4 |     -> END


--------------------------------------------------------------------------------
/tests/visual-inspection/weaves/weave_within_sequence.ink:
--------------------------------------------------------------------------------
1 | { shuffle:
2 | -   * choice
3 |     nextline
4 |     -> END
5 | }
6 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_1_1.ink:
--------------------------------------------------------------------------------
 1 | "What do you make of this?" she asked.
 2 | 
 3 | // Something unprintable...
 4 | 
 5 | "I couldn't possibly comment," I replied.
 6 | 
 7 | /*
 8 | 	... or an unlimited block of text
 9 | */
10 | 
11 | TODO: Write this section properly!
12 | 
13 | A line of normal game-text. # colour it blue
14 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_1_2.ink:
--------------------------------------------------------------------------------
 1 | Hello world!
 2 | *	Hello back!
 3 | 	Nice to hear from you!
 4 | 
 5 | Hello world!
 6 | *	[Hello back!]
 7 | 	Nice to hear from you!
 8 | 
 9 | Hello world!
10 | *	Hello [back!] right back to you!
11 | 	Nice to hear from you!
12 | 
13 | "What's that?" my master asked.
14 | *	"I am somewhat tired[."]," I repeated.
15 | 	"Really," he responded. "How deleterious."
16 | 
17 | "What's that?" my master asked.
18 | *	"I am somewhat tired[."]," I repeated.
19 | 	"Really," he responded. "How deleterious."
20 | *	"Nothing, Monsieur!"[] I replied.
21 | 	"Very good, then."
22 | *  "I said, this journey is appalling[."] and I want no more of it."
23 | 	"Ah," he replied, not unkindly. "I see you are feeling frustrated. Tomorrow, things will improve."
24 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_1_3.ink:
--------------------------------------------------------------------------------
 1 | === empty_knot ===
 2 | 
 3 | === back_in_london ===
 4 | 
 5 | We arrived into London at 9.45pm exactly.
 6 | 
 7 | -> top_knot
 8 | 
 9 | === top_knot ===
10 | Hello world!
11 | -> END
12 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_1_4.ink:
--------------------------------------------------------------------------------
 1 | === back_in_london ===
 2 | 
 3 | We arrived into London at 9.45pm exactly.
 4 | -> hurry_home
 5 | 
 6 | === hurry_home ===
 7 | We hurried home to Savile Row as fast as we could.
 8 | 
 9 | === hurry_home ===
10 | We hurried home to Savile Row -> as_fast_as_we_could
11 | 
12 | === as_fast_as_we_could ===
13 | as fast as we could.
14 | 
15 | === hurry_home ===
16 | We hurried home <>
17 | -> to_savile_row
18 | 
19 | === to_savile_row ===
20 | to Savile Row
21 | -> as_fast_as_we_could
22 | 
23 | === as_fast_as_we_could ===
24 | <> as fast as we could.
25 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_1_5.ink:
--------------------------------------------------------------------------------
 1 | === paragraph_1 ===
 2 | You stand by the wall of Analand, sword in hand.
 3 | * [Open the gate] -> paragraph_2
 4 | * [Smash down the gate] -> paragraph_3
 5 | * [Turn back and go home] -> paragraph_4
 6 | 
 7 | === paragraph_2 ===
 8 | You open the gate, and step out onto the path.
 9 | 
10 | === back_in_london ===
11 | 
12 | We arrived into London at 9.45pm exactly.
13 | 
14 | *	"There is not a moment to lose!"[] I declared.
15 | 	-> hurry_outside
16 | 
17 | *	"Monsieur, let us savour this moment!"[] I declared.
18 | 	My master clouted me firmly around the head and dragged me out of the door.
19 | 	-> dragged_outside
20 | 
21 | *	[We hurried home] -> hurry_outside
22 | 
23 | 
24 | === hurry_outside ===
25 | We hurried home to Savile Row -> as_fast_as_we_could
26 | 
27 | 
28 | === dragged_outside ===
29 | He insisted that we hurried home to Savile Row
30 | -> as_fast_as_we_could
31 | 
32 | 
33 | === as_fast_as_we_could ===
34 | <> as fast as we could.
35 | 
36 | === round ===
37 | and
38 | -> round
39 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_1_6.ink:
--------------------------------------------------------------------------------
 1 | === the_orient_express ===
 2 | = in_first_class
 3 | 	...
 4 | = in_third_class
 5 | 	...
 6 | = in_the_guards_van
 7 | 	...
 8 | = missed_the_train
 9 | 	...
10 | 
11 | *	[Travel in third class]
12 | 	-> the_orient_express.in_third_class
13 | 
14 | *	[Travel in the guard's van]
15 | 	-> the_orient_express.in_the_guards_van
16 | 
17 | *	[Travel in first class]
18 | 	"First class, Monsieur. Where else?"
19 | 	-> the_orient_express
20 | 
21 | *	[Travel in first class]
22 | 	"First class, Monsieur. Where else?"
23 | 	-> the_orient_express.in_first_class
24 | 
25 | === the_orient_express ===
26 | 
27 | We boarded the train, but where?
28 | *	[First class] -> in_first_class
29 | *	[Second class] -> in_second_class
30 | 
31 | = in_first_class
32 | 	...
33 | = in_second_class
34 | 	...
35 | 
36 | -> the_orient_express
37 | 
38 | === the_orient_express ===
39 | = in_first_class
40 | 	I settled my master.
41 | 	*	[Move to third class]
42 | 		-> in_third_class
43 | 
44 | = in_third_class
45 | 	I put myself in third.
46 | 
47 | INCLUDE newspaper.ink
48 | INCLUDE cities/vienna.ink
49 | INCLUDE journeys/orient_express.ink
50 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_1_7.ink:
--------------------------------------------------------------------------------
 1 | === find_help ===
 2 | 
 3 | 	You search desperately for a friendly face in the crowd.
 4 | 	*	The woman in the hat[?] pushes you roughly aside. -> find_help
 5 | 	*	The man with the briefcase[?] looks disgusted as you stumble past him. -> find_help
 6 | 	*	-> out_of_options
 7 | 
 8 | === find_help ===
 9 | 
10 | 	You search desperately for a friendly face in the crowd.
11 | 	*	The woman in the hat[?] pushes you roughly aside. -> find_help
12 | 	*	The man with the briefcase[?] looks disgusted as you stumble past him. -> find_help
13 | 	*	->
14 | 		But it is too late: you collapse onto the station platform. This is the end.
15 | 		-> END
16 | 
17 | === homers_couch ===
18 | 	+	[Eat another donut]
19 | 		You eat another donut. -> homers_couch
20 | 	*	[Get off the couch]
21 | 		You struggle up off the couch to go and compose epic poetry.
22 | 		-> END
23 | 
24 | === conversation_loop
25 | 	*	[Talk about the weather] -> chat_weather
26 | 	*	[Talk about the children] -> chat_children
27 | 	+	-> sit_in_silence_again
28 | 
29 | *	{ not visit_paris } 	[Go to Paris] -> visit_paris
30 | + 	{ visit_paris 	 } 		[Return to Paris] -> visit_paris
31 | 
32 | *	{ visit_paris.met_estelle } [ Telephone Mme Estelle ] -> phone_estelle
33 | 
34 | *	{ not visit_paris } 	[Go to Paris] -> visit_paris
35 | + 	{ visit_paris } { not bored_of_paris }
36 | 	[Return to Paris] -> visit_paris
37 | 
38 | *	{ not (visit_paris or visit_rome) && (visit_london || visit_new_york) } [ Wait. Go where? I'm confused. ] -> visit_someplace
39 | 
40 | *	{seen_clue} [Accuse Mr Jefferson]
41 | 
42 | * {seen_clue > 3} [Flat-out arrest Mr Jefferson]
43 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_1_8.ink:
--------------------------------------------------------------------------------
 1 | The radio hissed into life. {"Three!"|"Two!"|"One!"|There was the white noise racket of an explosion.|But it was just static.}
 2 | 
 3 | {I bought a coffee with my five-pound note.|I bought a second coffee for my friend.|I didn't have enough money to buy any more coffee.}
 4 | 
 5 | It was {&Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday} today.
 6 | 
 7 | He told me a joke. {!I laughed politely.|I smiled.|I grimaced.|I promised myself to not react again.}
 8 | 
 9 | I tossed the coin. {~Heads|Tails}.
10 | 
11 | I took a step forward. {!||||Then the lights went out. -> eek}
12 | 
13 | The Ratbear {&{wastes no time and |}swipes|scratches} {&at you|into your {&leg|arm|cheek}}.
14 | 
15 | I {waited.|waited some more.|snoozed.|woke up and waited more.|gave up and left. -> leave_post_office}
16 | 
17 | + 	"Hello, {&Master|Monsieur Fogg|you|brown-eyes}!"[] I declared.
18 | 
19 | === whack_a_mole ===
20 | 	{I heft the hammer.|{~Missed!|Nothing!|No good. Where is he?|Ah-ha! Got him! -> END}}
21 | 	The {&mole|{&nasty|blasted|foul} {&creature|rodent}} is {in here somewhere|hiding somewhere|still at large|laughing at me|still unwhacked|doomed}. <>
22 | 	{!I'll show him!|But this time he won't escape!}
23 | 	* 	[{&Hit|Smash|Try} top-left] 	-> whack_a_mole
24 | 	*  [{&Whallop|Splat|Whack} top-right] -> whack_a_mole
25 | 	*  [{&Blast|Hammer} middle] -> whack_a_mole
26 | 	*  [{&Clobber|Bosh} bottom-left] 	-> whack_a_mole
27 | 	*  [{&Nail|Thump} bottom-right] 	-> whack_a_mole
28 | 	*  [] Then you collapse from hunger. The mole has defeated you!
29 | 		-> END
30 | 
31 | === turn_on_television ===
32 | I turned on the television {for the first time|for the second time|again|once more}, but there was {nothing good on, so I turned it off again|still nothing worth watching|even less to hold my interest than before|nothing but rubbish|a program about sharks and I don't like sharks|nothing on}.
33 | +	[Try it again]	 		-> turn_on_television
34 | *	[Go outside instead]	-> go_outside_instead
35 | 
36 | === go_outside_instead ===
37 | -> END
38 | 
39 | {met_blofeld: "I saw him. Only for a moment." }
40 | 
41 | "His real name was {met_blofeld.learned_his_name: Franz|a secret}."
42 | 
43 | {met_blofeld: "I saw him. Only for a moment. His real name was {met_blofeld.learned_his_name: Franz|kept a secret}." | "I missed him. Was he particularly evil?" }
44 | 
45 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_1_9.ink:
--------------------------------------------------------------------------------
1 | *	{false} Option A
2 | * 	{true} Option B
3 | *  {CHOICE_COUNT() == 1} Option C
4 | 
5 | *	{TURNS_SINCE(-> sleeping.intro) > 10} You are feeling tired... -> sleeping
6 | * 	{TURNS_SINCE(-> laugh) == 0}  You try to stop laughing.
7 | 
8 | ~ SEED_RANDOM(235)
9 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_2_1.ink:
--------------------------------------------------------------------------------
 1 | "What's that?" my master asked.
 2 | 	*	"I am somewhat tired[."]," I repeated.
 3 | 		"Really," he responded. "How deleterious."
 4 | 	*	"Nothing, Monsieur!"[] I replied.
 5 | 	*  "I said, this journey is appalling[."] and I want no more of it."
 6 | 		"Ah," he replied, not unkindly. "I see you are feeling frustrated. Tomorrow, things will improve."
 7 | 
 8 | "What's that?" my master asked.
 9 | 	*	"I am somewhat tired[."]," I repeated.
10 | 		"Really," he responded. "How deleterious."
11 | 	*	"Nothing, Monsieur!"[] I replied.
12 | 		"Very good, then."
13 | 	*  "I said, this journey is appalling[."] and I want no more of it."
14 | 	"Ah," he replied, not unkindly. "I see you are feeling frustrated. Tomorrow, things will improve."
15 | 
16 | -	With that Monsieur Fogg left the room.
17 | 
18 | === escape ===
19 | I ran through the forest, the dogs snapping at my heels.
20 | 
21 | 	* 	I checked the jewels[] were still in my pocket, and the feel of them brought a spring to my step. <>
22 | 
23 | 	*  I did not pause for breath[] but kept on running. <>
24 | 
25 | 	*	I cheered with joy. <>
26 | 
27 | - 	The road could not be much further! Mackie would have the engine running, and then I'd be safe.
28 | 
29 | 	*	I reached the road and looked about[]. And would you believe it?
30 | 	* 	I should interrupt to say Mackie is normally very reliable[]. He's never once let me down. Or rather, never once, previously to that night.
31 | 
32 | -	The road was empty. Mackie was nowhere to be seen.
33 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_2_2.ink:
--------------------------------------------------------------------------------
 1 | - 	"Well, Poirot? Murder or suicide?"
 2 | *	"Murder!"
 3 | * 	"Suicide!"
 4 | -	Ms. Christie lowered her manuscript a moment. The rest of the writing group sat, open-mouthed.
 5 | 
 6 | - 	"Well, Poirot? Murder or suicide?"
 7 | 	*	"Murder!"
 8 | 	 	"And who did it?"
 9 | 		* * 	"Detective-Inspector Japp!"
10 | 		* * 	"Captain Hastings!"
11 | 		* * 	"Myself!"
12 | 	* 	"Suicide!"
13 | 	-	Mrs. Christie lowered her manuscript a moment. The rest of the writing group sat, open-mouthed.
14 | 
15 | - 	"Well, Poirot? Murder or suicide?"
16 | 	*	"Murder!"
17 | 	 	"And who did it?"
18 | 		* * 	"Detective-Inspector Japp!"
19 | 		* * 	"Captain Hastings!"
20 | 		* * 	"Myself!"
21 | 	* 	"Suicide!"
22 | 		"Really, Poirot? Are you quite sure?"
23 | 		* * 	"Quite sure."
24 | 		* *		"It is perfectly obvious."
25 | 	-	Mrs. Christie lowered her manuscript a moment. The rest of the writing group sat, open-mouthed.
26 | 
27 | "Well, Poirot? Murder or suicide?"
28 | 		*	"Murder!"
29 | 		 	"And who did it?"
30 | 			* * 	"Detective-Inspector Japp!"
31 | 			* * 	"Captain Hastings!"
32 | 			* * 	"Myself!"
33 | 			- - 	"You must be joking!"
34 | 			* * 	"Mon ami, I am deadly serious."
35 | 			* *		"If only..."
36 | 		* 	"Suicide!"
37 | 			"Really, Poirot? Are you quite sure?"
38 | 			* * 	"Quite sure."
39 | 			* *		"It is perfectly obvious."
40 | 		-	Mrs. Christie lowered her manuscript a moment. The rest of the writing group sat, open-mouthed.
41 | 
42 | -	"Tell us a tale, Captain!"
43 | 	*	"Very well, you sea-dogs. Here's a tale..."
44 | 		* * 	"It was a dark and stormy night..."
45 | 				* * * 	"...and the crew were restless..."
46 | 						* * * *  "... and they said to their Captain..."
47 | 								* * * * *		"...Tell us a tale Captain!"
48 | 	*	"No, it's past your bed-time."
49 | -	To a man, the crew began to yawn.
50 | 
51 | - I looked at Monsieur Fogg
52 | *	... and I could contain myself no longer.
53 | 	'What is the purpose of our journey, Monsieur?'
54 | 	'A wager,' he replied.
55 | 	* * 	'A wager!'[] I returned.
56 | 			He nodded.
57 | 			* * * 	'But surely that is foolishness!'
58 | 			* * *  'A most serious matter then!'
59 | 			- - - 	He nodded again.
60 | 			* * *	'But can we win?'
61 | 					'That is what we will endeavour to find out,' he answered.
62 | 			* * *	'A modest wager, I trust?'
63 | 					'Twenty thousand pounds,' he replied, quite flatly.
64 | 			* * * 	I asked nothing further of him then[.], and after a final, polite cough, he offered nothing more to me. <>
65 | 	* * 	'Ah[.'],' I replied, uncertain what I thought.
66 | 	- - 	After that, <>
67 | *	... but I said nothing[] and <>
68 | - we passed the day in silence.
69 | - -> END
70 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_2_3.ink:
--------------------------------------------------------------------------------
 1 | -  (top)
 2 | 
 3 | === meet_guard ===
 4 | The guard frowns at you.
 5 | 
 6 | * 	(greet) [Greet him]
 7 | 	'Greetings.'
 8 | *	(get_out) 'Get out of my way[.'],' you tell the guard.
 9 | 
10 | - 	'Hmm,' replies the guard.
11 | 
12 | *	{greet} 	'Having a nice day?' // only if you greeted him
13 | 
14 | * 	'Hmm?'[] you reply.
15 | 
16 | *	{get_out} [Shove him aside] 	 // only if you threatened him
17 | 	You shove him sharply. He stares in reply, and draws his sword!
18 | 	-> fight_guard 			// this route diverts out of the weave
19 | 
20 | -	'Mff,' the guard replies, and then offers you a paper bag. 'Toffee?'
21 | 
22 | === knot ===
23 | = stitch_one
24 | 	- (gatherpoint) Some content.
25 | = stitch_two
26 | 	*	{stitch_one.gatherpoint} Option
27 | 
28 | === knot_one ===
29 | -	(gather_one)
30 | 	* {knot_two.stitch_two.gather_two} Option
31 | 
32 | === knot_two ===
33 | = stitch_two
34 | 	- (gather_two)
35 | 		*	{knot_one.gather_one} Option
36 | 
37 | === fight_guard ===
38 | ...
39 | = throw_something
40 | *	(rock) [Throw rock at guard] -> throw
41 | * 	(sand) [Throw sand at guard] -> throw
42 | 
43 | = throw
44 | You hurl {throw_something.rock:a rock|a handful of sand} at the guard.
45 | 
46 | - (opts)
47 | 	*	'Can I get a uniform from somewhere?'[] you ask the cheerful guard.
48 | 		'Sure. In the locker.' He grins. 'Don't think it'll fit you, though.'
49 | 	*	'Tell me about the security system.'
50 | 		'It's ancient,' the guard assures you. 'Old as coal.'
51 | 	*	'Are there dogs?'
52 | 		'Hundreds,' the guard answers, with a toothy grin. 'Hungry devils, too.'
53 | 	// We require the player to ask at least one question
54 | 	*	{loop} [Enough talking]
55 | 		-> done
56 | - (loop)
57 | 	// loop a few times before the guard gets bored
58 | 	{ -> opts | -> opts | }
59 | 	He scratches his head.
60 | 	'Well, can't stand around talking all day,' he declares.
61 | - (done)
62 | 	You thank the guard, and move away.
63 | 
64 | - (opts)
65 | *	[Pull a face]
66 | 	You pull a face, and the soldier comes at you! -> shove
67 | 
68 | *	(shove) [Shove the guard aside] You shove the guard to one side, but he comes back swinging.
69 | 
70 | *	{shove} [Grapple and fight] -> fight_the_guard
71 | 
72 | - 	-> opts
73 | 
74 | *	"Are you quite well, Monsieur?"[] I asked.
75 | 	- - (quitewell) "Quite well," he replied.
76 | *	"How did you do at the crossword, Monsieur?"[] I asked.
77 | 	-> quitewell
78 | *	I said nothing[] and neither did my Master.
79 | -	We feel into companionable silence once more.
80 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_3_1.ink:
--------------------------------------------------------------------------------
 1 | VAR knowledge_of_the_cure = false
 2 | VAR players_name = "Emilia"
 3 | VAR number_of_infected_people = 521
 4 | VAR current_epilogue = -> they_all_die_of_the_plague
 5 | 
 6 | === the_train ===
 7 | 	The train jolted and rattled. { mood > 0:I was feeling positive enough, however, and did not mind the odd bump|It was more than I could bear}.
 8 | 	*	{ not knows_about_wager } 'But, Monsieur, why are we travelling?'[] I asked.
 9 | 	* 	{ knows_about_wager} I contemplated our strange adventure[]. Would it be possible?
10 | 
11 | VAR 	current_epilogue = -> everybody_dies
12 | 
13 | === continue_or_quit ===
14 | Give up now, or keep trying to save your Kingdom?
15 | *  [Keep trying!] 	-> more_hopeless_introspection
16 | *  [Give up] 		-> current_epilogue
17 | 
18 | VAR friendly_name_of_player = "Jackie"
19 | VAR age = 23
20 | 
21 | My name is Jean Passepartout, but my friend's call me {friendly_name_of_player}. I'm {age} years old.
22 | 
23 | VAR a_colour = ""
24 | 
25 | ~ a_colour = "{~red|blue|green|yellow}"
26 | 
27 | {a_colour}
28 | 
29 | The goon hits you, and sparks fly before you eyes, {a_colour} and {a_colour}.
30 | 
31 | VAR a_colour = "{~red|blue|green|yellow}"
32 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_3_2.ink:
--------------------------------------------------------------------------------
 1 | === set_some_variables ===
 2 | 	~ knows_about_wager = true
 3 | 	~ x = (x * x) - (y * y) + c
 4 | 	~ y = 2 * x * y
 5 | 
 6 | { x == 1.2 }
 7 | { x / 2 > 4 }
 8 | { y - 1 <= x * x }
 9 | 
10 | {POW(3, 2)} is 9.
11 | {POW(16, 0.5)} is 4.
12 | 
13 | ~ temp dice_roll = RANDOM(1, 6)
14 | 
15 | ~ temp lazy_grading_for_test_paper = RANDOM(30, 75)
16 | 
17 | ~ temp number_of_heads_the_serpent_has = RANDOM(3, 8)
18 | 
19 | ~ x = 2 / 3
20 | ~ y = 7 / 3
21 | ~ z = 1.2 / 0.5
22 | 
23 | {INT(3.2)} is 3.
24 | {FLOOR(4.8)} is 4.
25 | {INT(-4.8)} is -4.
26 | {FLOOR(-4.8)} is -5.
27 | 
28 | {FLOAT(4)} is, um, still 4.
29 | 
30 | { "Yes, please." == "Yes, please." }
31 | { "No, thank you." != "Yes, please." }
32 | { "Yes, please" ? "ease" }
33 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_3_3.ink:
--------------------------------------------------------------------------------
  1 | { x > 0:
  2 | 	~ y = x - 1
  3 | }
  4 | 
  5 | { x > 0:
  6 | 	~ y = x - 1
  7 | - else:
  8 | 	~ y = x + 1
  9 | }
 10 | 
 11 | {
 12 | 	- x > 0:
 13 | 		~ y = x - 1
 14 | 	- else:
 15 | 		~ y = x + 1
 16 | }
 17 | 
 18 | {
 19 | 	- x == 0:
 20 | 		~ y = 0
 21 | 	- x > 0:
 22 | 		~ y = x - 1
 23 | 	- else:
 24 | 		~ y = x + 1
 25 | }
 26 | 
 27 | { x:
 28 | - 0: 	zero
 29 | - 1: 	one
 30 | - 2: 	two
 31 | - else: lots
 32 | }
 33 | 
 34 | === dream ===
 35 | 	{
 36 | 		- visited_snakes && not dream_about_snakes:
 37 | 			~ fear++
 38 | 			-> dream_about_snakes
 39 | 
 40 | 		- visited_poland && not dream_about_polish_beer:
 41 | 			~ fear--
 42 | 			-> dream_about_polish_beer
 43 | 
 44 | 		- else:
 45 | 			// breakfast-based dreams have no effect
 46 | 			-> dream_about_marmalade
 47 | 	}
 48 | 
 49 | I stared at Monsieur Fogg.
 50 | { know_about_wager:
 51 | 	<> "But surely you are not serious?" I demanded.
 52 | - else:
 53 | 	<> "But there must be a reason for this trip," I observed.
 54 | }
 55 | He said nothing in reply, merely considering his newspaper with as much thoroughness as entomologist considering his latest pinned addition.
 56 | 
 57 | { door_open:
 58 | 	* 	I strode out of the compartment[] and I fancied I heard my master quietly tutting to himself. 			-> go_outside
 59 | - else:
 60 | 	*	I asked permission to leave[] and Monsieur Fogg looked surprised. 	-> open_door
 61 | 	* 	I stood and went to open the door[]. Monsieur Fogg seemed untroubled by this small rebellion. -> open_door
 62 | }
 63 | 
 64 | // Sequence: go through the alternatives, and stick on last
 65 | { stopping:
 66 | 	-	I entered the casino.
 67 | 	-  I entered the casino again.
 68 | 	-  Once more, I went inside.
 69 | }
 70 | 
 71 | // Shuffle: show one at random
 72 | At the table, I drew a card. <>
 73 | { shuffle:
 74 | 	- 	Ace of Hearts.
 75 | 	- 	King of Spades.
 76 | 	- 	2 of Diamonds.
 77 | 		'You lose this time!' crowed the croupier.
 78 | }
 79 | 
 80 | // Cycle: show each in turn, and then cycle
 81 | { cycle:
 82 | 	- I held my breath.
 83 | 	- I waited impatiently.
 84 | 	- I paused.
 85 | }
 86 | 
 87 | // Once: show each, once, in turn, until all have been shown
 88 | { once:
 89 | 	- Would my luck hold?
 90 | 	- Could I win the hand?
 91 | }
 92 | 
 93 | { shuffle once:
 94 | -	The sun was hot.
 95 | - 	It was a hot day.
 96 | }
 97 | 
 98 | { shuffle stopping:
 99 | - 	A silver BMW roars past.
100 | -	A bright yellow Mustang takes the turn.
101 | - 	There are like, cars, here.
102 | }
103 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_3_4.ink:
--------------------------------------------------------------------------------
 1 | === near_north_pole ===
 2 | 	~ temp number_of_warm_things = 0
 3 | 	{ blanket:
 4 | 		~ number_of_warm_things++
 5 | 	}
 6 | 	{ ear_muffs:
 7 | 		~ number_of_warm_things++
 8 | 	}
 9 | 	{ gloves:
10 | 		~ number_of_warm_things++
11 | 	}
12 | 	{ number_of_warm_things > 2:
13 | 		Despite the snow, I felt incorrigibly snug.
14 | 	- else:
15 | 		That night I was colder than I have ever been.
16 | 	}
17 | 
18 | *	[Accuse Hasting]
19 | 		-> accuse("Hastings")
20 | *	[Accuse Mrs Black]
21 | 		-> accuse("Claudia")
22 | *	[Accuse myself]
23 | 		-> accuse("myself")
24 | 
25 | === accuse(who) ===
26 | 	"I accuse {who}!" Poirot declared.
27 | 	"Really?" Japp replied. "{who == "myself":You did it?|{who}?}"
28 | 	"And why not?" Poirot shot back.
29 | 
30 | -> add_one_to_one_hundred(0, 1)
31 | 
32 | === add_one_to_one_hundred(total, x) ===
33 | 	~ total = total + x
34 | 	{ x == 100:
35 | 		-> finished(total)
36 | 	- else:
37 | 		-> add_one_to_one_hundred(total, x + 1)
38 | 	}
39 | 
40 | === finished(total) ===
41 | 	"The result is {total}!" you announce.
42 | 	Gauss stares at you in horror.
43 | 	-> END
44 | 
45 | === sleeping_in_hut ===
46 | 	You lie down and close your eyes.
47 | 	-> generic_sleep (-> waking_in_the_hut)
48 | 
49 | ===	 generic_sleep (-> waking)
50 | 	You sleep perchance to dream etc. etc.
51 | 	-> waking
52 | 
53 | === waking_in_the_hut
54 | 	You get back to your feet, ready to continue your journey.
55 | 
56 | === sleeping_in_hut ===
57 | 	You lie down and close your eyes.
58 | 	-> generic_sleep (waking_in_the_hut)
59 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_3_5.ink:
--------------------------------------------------------------------------------
 1 | === function say_yes_to_everything ===
 2 | 	~ return true
 3 | 
 4 | === function lerp(a, b, k) ===
 5 | 	~ return ((b - a) * k) + a
 6 | 
 7 | ~ x = lerp(2, 8, 0.3)
 8 | 
 9 | *	{say_yes_to_everything()} 'Yes.'
10 | 
11 | === function say_no_to_nothing ===
12 | 	~ return say_yes_to_everything()
13 | 
14 | === function harm(x) ===
15 | 	{ stamina < x:
16 | 		~ stamina = 0
17 | 	- else:
18 | 		~ stamina = stamina - x
19 | 	}
20 | 
21 | Monsieur Fogg was looking {describe_health(health)}.
22 | 
23 | === function describe_health(x) ===
24 | {
25 | - x == 100:
26 | 	~ return "spritely"
27 | - x > 75:
28 | 	~ return "chipper"
29 | - x > 45:
30 | 	~ return "somewhat flagging"
31 | - else:
32 | 	~ return "despondent"
33 | }
34 | 
35 | === function max(a,b) ===
36 | 	{ a < b:
37 | 		~ return b
38 | 	- else:
39 | 		~ return a
40 | 	}
41 | 
42 | === function exp(x, e) ===
43 | 	// returns x to the power e where e is an integer
44 | 	{ e <= 0:
45 | 		~ return 1
46 | 	- else:
47 | 		~ return x * exp(x, e - 1)
48 | 	}
49 | 
50 | ~ price = 15
51 | 
52 | I pulled out {print_num(price)} coins from my pocket and slowly counted them.
53 | "Oh, never mind," the trader replied. "I'll take half." And she took {print_num(price / 2)}, and pushed the rest back over to me.
54 | 
55 | === function alter(ref x, k) ===
56 | 	~ x = x + k
57 | 
58 | ~ gold = gold + 7
59 | ~ health = health - 4
60 | 
61 | ~ alter(gold, 7)
62 | ~ alter(health, -4)
63 | 
64 | *	I ate a biscuit[] and felt refreshed. {alter(health, 2)}
65 | * 	I gave a biscuit to Monsieur Fogg[] and he wolfed it down most undecorously. {alter(foggs_health, 1)}
66 | -	<> Then we continued on our way.
67 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_3_6.ink:
--------------------------------------------------------------------------------
 1 | CONST HASTINGS = "Hastings"
 2 | CONST POIROT = "Poirot"
 3 | CONST JAPP = "Japp"
 4 | 
 5 | VAR current_chief_suspect = HASTINGS
 6 | 
 7 | === review_evidence ===
 8 | 	{ found_japps_bloodied_glove:
 9 | 		~ current_chief_suspect = POIROT
10 | 	}
11 | 	Current Suspect: {current_chief_suspect}
12 | 
13 | CONST PI = 3.14
14 | CONST VALUE_OF_TEN_POUND_NOTE = 10
15 | 
16 | CONST LOBBY = 1
17 | CONST STAIRCASE = 2
18 | CONST HALLWAY = 3
19 | 
20 | CONST HELD_BY_AGENT = -1
21 | 
22 | VAR secret_agent_location = LOBBY
23 | VAR suitcase_location = HALLWAY
24 | 
25 | === report_progress ===
26 | {  secret_agent_location == suitcase_location:
27 | 	The secret agent grabs the suitcase!
28 | 	~ suitcase_location = HELD_BY_AGENT
29 | 
30 | -  secret_agent_location < suitcase_location:
31 | 	The secret agent moves forward.
32 | 	~ secret_agent_location++
33 | }
34 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_4_1.ink:
--------------------------------------------------------------------------------
 1 | === crossing_the_date_line ===
 2 | *	"Monsieur!"[] I declared with sudden horror. "I have just realised. We have crossed the international date line!"
 3 | -	Monsieur Fogg barely lifted an eyebrow. "I have adjusted for it."
 4 | *	I mopped the sweat from my brow[]. A relief!
 5 | * 	I nodded, becalmed[]. Of course he had!
 6 | *  I cursed, under my breath[]. Once again, I had been belittled!
 7 | 
 8 | === crossing_the_date_line(-> return_to) ===
 9 | ...
10 | -	-> return_to
11 | 
12 | ...
13 | 
14 | === outside_honolulu ===
15 | We arrived at the large island of Honolulu.
16 | - (postscript)
17 | 	-> crossing_the_date_line(-> done)
18 | - (done)
19 | 	-> END
20 | 
21 | ...
22 | 
23 | === outside_pitcairn_island ===
24 | The boat sailed along the water towards the tiny island.
25 | - (postscript)
26 | 	-> crossing_the_date_line(-> done)
27 | - (done)
28 | 	-> END
29 | 
30 | -> crossing_the_date_line ->
31 | 
32 | === crossing_the_date_line ===
33 | // this is a tunnel!
34 | ...
35 | - 	->->
36 | 
37 | ...
38 | // this runs the tunnel, then diverts to 'done'
39 | -> crossing_the_date_line -> done
40 | ...
41 | 
42 | ...
43 | //this runs one tunnel, then another, then diverts to 'done'
44 | -> crossing_the_date_line -> check_foggs_health -> done
45 | ...
46 | 
47 | === plains ===
48 | = night_time
49 | 	The dark grass is soft under your feet.
50 | 	+	[Sleep]
51 | 		-> sleep_here -> wake_here -> day_time
52 | = day_time
53 | 	It is time to move on.
54 | 
55 | === wake_here ===
56 | 	You wake as the sun rises.
57 | 	+	[Eat something]
58 | 		-> eat_something ->
59 | 	+	[Make a move]
60 | 	-	->->
61 | 
62 | === sleep_here ===
63 | 	You lie down and try to close your eyes.
64 | 	-> monster_attacks ->
65 | 	Then it is time to sleep.
66 | 	-> dream ->
67 | 	->->
68 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_4_2.ink:
--------------------------------------------------------------------------------
  1 | == thread_example ==
  2 | I had a headache; threading is hard to get your head around.
  3 | <- conversation
  4 | <- walking
  5 | 
  6 | 
  7 | == conversation ==
  8 | It was a tense moment for Monty and me.
  9 |  * "What did you have for lunch today?"[] I asked.
 10 |     "Spam and eggs," he replied.
 11 |  * "Nice weather, we're having,"[] I said.
 12 |     "I've seen better," he replied.
 13 |  - -> house
 14 | 
 15 | == walking ==
 16 | We continued to walk down the dusty road.
 17 |  * [Continue walking]
 18 |     -> house
 19 | 
 20 | == house ==
 21 | Before long, we arrived at his house.
 22 | -> END
 23 | 
 24 | 
 25 | CONST HALLWAY = 1
 26 | CONST OFFICE = 2
 27 | 
 28 | VAR player_location = HALLWAY
 29 | VAR generals_location = HALLWAY
 30 | VAR doctors_location = OFFICE
 31 | 
 32 | == run_player_location
 33 | 	{
 34 | 		- player_location == HALLWAY: -> hallway
 35 | 	}
 36 | 
 37 | == hallway ==
 38 | 	<- characters_present(HALLWAY)
 39 | 	*	[Drawers]	-> examine_drawers
 40 | 	* 	[Wardrobe] -> examine_wardrobe
 41 | 	*  [Go to Office] 	-> go_office
 42 | 	-	-> run_player_location
 43 | = examine_drawers
 44 | 	// etc...
 45 | 
 46 | // Here's the thread, which mixes in dialogue for characters you share the room with at the moment.
 47 | 
 48 | == characters_present(room)
 49 | 	{ generals_location == room:
 50 | 		<- general_conversation
 51 | 	}
 52 | 	{ doctors_location == room:
 53 | 		<- doctor_conversation
 54 | 	}
 55 | 	-> DONE
 56 | 
 57 | == general_conversation
 58 | 	*	[Ask the General about the bloodied knife]
 59 | 		"It's a bad business, I can tell you."
 60 | 	-	-> run_player_location
 61 | 
 62 | == doctor_conversation
 63 | 	*	[Ask the Doctor about the bloodied knife]
 64 | 		"There's nothing strange about blood, is there?"
 65 | 	-	-> run_player_location
 66 | 
 67 | == thread_example ==
 68 | I had a headache; threading is hard to get your head around.
 69 | <- conversation
 70 | <- walking
 71 | -> DONE
 72 | 
 73 | === outside_the_house
 74 | The front step. The house smells. Of murder. And lavender.
 75 | - (top)
 76 | 	<- review_case_notes(-> top)
 77 | 	*	[Go through the front door]
 78 | 		I stepped inside the house.
 79 | 		-> the_hallway
 80 | 	* 	[Sniff the air]
 81 | 		I hate lavender. It makes me think of soap, and soap makes me think about my marriage.
 82 | 		-> top
 83 | 
 84 | === the_hallway
 85 | The hallway. Front door open to the street. Little bureau.
 86 | - (top)
 87 | 	<- review_case_notes(-> top)
 88 | 	*	[Go through the front door]
 89 | 		I stepped out into the cool sunshine.
 90 | 		-> outside_the_house
 91 | 	* 	[Open the bureau]
 92 | 		Keys. More keys. Even more keys. How many locks do these people need?
 93 | 		-> top
 94 | 
 95 | === review_case_notes(-> go_back_to)
 96 | +	{not done || TURNS_SINCE(-> done) > 10}
 97 | 	[Review my case notes]
 98 | 	// the conditional ensures you don't get the option to check repeatedly
 99 |  	{I|Once again, I} flicked through the notes I'd made so far. Still not obvious suspects.
100 | - 	(done) -> go_back_to
101 | 
102 | <- childhood_memories(-> next)
103 | *	[Look out of the window]
104 |  	I daydreamed as we rolled along...
105 |  - (next) Then the whistle blew...
106 | 
107 | *	[Remember my childhood]
108 | 	-> think_back ->
109 | *	[Look out of the window]
110 | 	I daydreamed as we rolled along...
111 | - 	(next) Then the whistle blew...
112 | 
113 | === the_kitchen
114 | - (top)
115 | 	<- drawers(-> top)
116 | 	<- cupboards(-> top)
117 | 	<- room_exits
118 | = drawers (-> goback)
119 | 	// choices about the drawers...
120 | 	...
121 | = cupboards(-> goback)
122 | 	// choices about cupboards
123 | 	...
124 | = room_exits
125 | 	// exits; doesn't need a "return point" as if you leave, you go elsewhere
126 | 	...
127 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_5_1.ink:
--------------------------------------------------------------------------------
 1 | LIST kettleState = cold, boiling, recently_boiled
 2 | 
 3 | ~ kettleState = cold
 4 | 
 5 | *	[Turn on kettle]
 6 | 	The kettle begins to bubble and boil.
 7 | 	~ kettleState = boiling
 8 | 
 9 | *	[Touch the kettle]
10 | 	{ kettleState == cold:
11 | 		The kettle is cool to the touch.
12 | 	- else:
13 | 	 	The outside of the kettle is very warm!
14 | 	}
15 | 
16 | LIST kettleState = cold, (boiling), recently_boiled
17 | // at the start of the game, this kettle is switched on. Edgy, huh?
18 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_5_2.ink:
--------------------------------------------------------------------------------
 1 | LIST daysOfTheWeek = Monday, Tuesday, Wednesday, Thursday, Friday
 2 | VAR today = Monday
 3 | VAR tomorrow = Tuesday
 4 | 
 5 | LIST heatedWaterStates = cold, boiling, recently_boiled
 6 | VAR kettleState = cold
 7 | VAR potState = cold
 8 | 
 9 | *	{kettleState == cold} [Turn on kettle]
10 | 	The kettle begins to boil and bubble.
11 | 	~ kettleState = boiling
12 | *	{potState == cold} [Light stove]
13 |  	The water in the pot begins to boil and bubble.
14 |  	~ potState = boiling
15 | 
16 | LIST heatedWaterStates = cold, boiling, recently_boiled
17 | VAR kettleState = cold
18 | VAR potState = cold
19 | VAR microwaveState = cold
20 | 
21 | === function boilSomething(ref thingToBoil, nameOfThing)
22 | 	The {nameOfThing} begins to heat up.
23 | 	~ thingToBoil = boiling
24 | 
25 | === do_cooking
26 | *	{kettleState == cold} [Turn on kettle]
27 | 	{boilSomething(kettleState, "kettle")}
28 | *	{potState == cold} [Light stove]
29 | 	{boilSomething(potState, "pot")}
30 | *	{microwaveState == cold} [Turn on microwave]
31 | 	{boilSomething(microwaveState, "microwave")}
32 | 
33 | LIST heatedWaterStates = cold, boiling, recently_boiled
34 | VAR kettleState = cold
35 | VAR potState = cold
36 | VAR microwaveState = cold
37 | 
38 | === cook_with(nameOfThing, ref thingToBoil)
39 | + 	{thingToBoil == cold} [Turn on {nameOfThing}]
40 |   	The {nameOfThing} begins to heat up.
41 | 	~ thingToBoil = boiling
42 | 	-> do_cooking.done
43 | 
44 | === do_cooking
45 | <- cook_with("kettle", kettleState)
46 | <- cook_with("pot", potState)
47 | <- cook_with("microwave", microwaveState)
48 | - (done)
49 | 
50 | LIST colours = red, green, blue, purple
51 | LIST moods = mad, happy, blue
52 | 
53 | VAR status = blue
54 | 
55 | VAR status = colours.blue
56 | 
57 | { statesOfGrace == statesOfGrace.fallen:
58 | 	// is the current state "fallen"
59 | }
60 | 
61 | LIST statesOfGrace = ambiguous, saintly, fallen
62 | 
63 | LIST statesOfGrace = ambiguous, saintly, fallen
64 | 
65 | ~ statesOfGrace = 3.1415 // set the variable to a number not a list value
66 | 
67 | ~ temp anotherStateOfGrace = statesOfGrace.saintly
68 | 
69 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_5_3.ink:
--------------------------------------------------------------------------------
 1 | LIST volumeLevel = off, quiet, medium, loud, deafening
 2 | VAR lecturersVolume = quiet
 3 | VAR murmurersVolume = quiet
 4 | 
 5 | { lecturersVolume < deafening:
 6 | 	~ lecturersVolume++
 7 | 
 8 | 	{ lecturersVolume > murmurersVolume:
 9 | 		~ murmurersVolume++
10 | 		The murmuring gets louder.
11 | 	}
12 | }
13 | 
14 | The lecturer's voice becomes {lecturersVolume}.
15 | 
16 | The lecturer has {LIST_VALUE(deafening) - LIST_VALUE(lecturersVolume)} notches still available to him.
17 | 
18 | LIST Numbers = one, two, three
19 | VAR score = one
20 | ~ score = Numbers(2) // score will be "two"
21 | 
22 | LIST primeNumbers = two = 2, three = 3, five = 5
23 | LIST primeNumbers = two = 2, three, five = 5
24 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_5_4.ink:
--------------------------------------------------------------------------------
  1 | LIST DoctorsInSurgery = Adams, Bernard, Cartwright, Denver, Eamonn
  2 | 
  3 | LIST DoctorsInSurgery = (Adams), (Bernard), (Cartwright), (Denver), (Eamonn)
  4 | 
  5 | LIST DoctorsInSurgery = (Adams), Bernard, (Cartwright), Denver, Eamonn
  6 | 
  7 | LIST primeNumbers = (two = 2), (three) = 3, (five = 5)
  8 | 
  9 | ~ DoctorsInSurgery = (Adams, Bernard)
 10 | ~ DoctorsInSurgery = (Adams, Bernard, Eamonn)
 11 | 
 12 | ~ DoctorsInSurgery = ()
 13 | 
 14 | ~ DoctorsInSurgery = DoctorsInSurgery + Adams
 15 | ~ DoctorsInSurgery += Adams  // this is the same as the above
 16 | ~ DoctorsInSurgery -= Eamonn
 17 | ~ DoctorsInSurgery += (Eamonn, Denver)
 18 | ~ DoctorsInSurgery -= (Adams, Eamonn, Denver)
 19 | 
 20 | LIST DoctorsInSurgery = (Adams), Bernard, (Cartwright), Denver, Eamonn
 21 | 
 22 | {LIST_COUNT(DoctorsInSurgery)} 	//  "2"
 23 | {LIST_MIN(DoctorsInSurgery)} 		//  "Adams"
 24 | {LIST_MAX(DoctorsInSurgery)} 		//  "Cartwright"
 25 | {LIST_RANDOM(DoctorsInSurgery)} 	//  "Adams" or "Cartwright"
 26 | 
 27 | { DoctorsInSurgery: The surgery is open today. | Everyone has gone home. }
 28 | 
 29 | { DoctorsInSurgery == (Adams, Bernard):
 30 | 	Dr Adams and Dr Bernard are having a loud argument in one corner.
 31 | }
 32 | 
 33 | { DoctorsInSurgery != (Adams, Bernard):
 34 | 	At least Adams and Bernard aren't arguing.
 35 | }
 36 | 
 37 | { DoctorsInSurgery ? (Adams, Bernard):
 38 | 	Dr Adams and Dr Bernard are having a hushed argument in one corner.
 39 | }
 40 | 
 41 | { DoctorsInSurgery has Eamonn:
 42 | 	Dr Eamonn is polishing his glasses.
 43 | }
 44 | 
 45 | DoctorsInSurgery !? (Adams, Bernard)
 46 | 
 47 | LIST Facts = (Fogg_is_fairly_odd), 	first_name_phileas, (Fogg_is_English)
 48 | 
 49 | {Facts ? Fogg_is_fairly_odd:I smiled politely.|I frowned. Was he a lunatic?}
 50 | '{Facts ? first_name_phileas:Phileas|Monsieur}, really!' I cried.
 51 | 
 52 | { Facts ? (Fogg_is_English, Fogg_is_fairly_odd):
 53 | 	<> 'I know Englishmen are strange, but this is *incredible*!'
 54 | }
 55 | 
 56 | LIST DoctorsInSurgery = (Adams), Bernard, Cartwright, (Denver), Eamonn
 57 | 
 58 | -> waiting_room
 59 | 
 60 | === function whos_in_today()
 61 | 	In the surgery today are {DoctorsInSurgery}.
 62 | 
 63 | === function doctorEnters(who)
 64 | 	{ DoctorsInSurgery !? who:
 65 | 		~ DoctorsInSurgery += who
 66 | 		Dr {who} arrives in a fluster.
 67 | 	}
 68 | 
 69 | === function doctorLeaves(who)
 70 | 	{ DoctorsInSurgery ? who:
 71 | 		~ DoctorsInSurgery -= who
 72 | 		Dr {who} leaves for lunch.
 73 | 	}
 74 | 
 75 | === waiting_room
 76 | 	{whos_in_today()}
 77 | 	*	[Time passes...]
 78 | 		{doctorLeaves(Adams)} {doctorEnters(Cartwright)} {doctorEnters(Eamonn)}
 79 | 		{whos_in_today()}
 80 | 
 81 | === function listWithCommas(list, if_empty)
 82 |     {LIST_COUNT(list):
 83 |     - 2:
 84 |         	{LIST_MIN(list)} and {listWithCommas(list - LIST_MIN(list), if_empty)}
 85 |     - 1:
 86 |         	{list}
 87 |     - 0:
 88 | 			{if_empty}
 89 |     - else:
 90 |       		{LIST_MIN(list)}, {listWithCommas(list - LIST_MIN(list), if_empty)}
 91 |     }
 92 | 
 93 | LIST favouriteDinosaurs = (stegosaurs), brachiosaur, (anklyosaurus), (pleiosaur)
 94 | 
 95 | My favourite dinosaurs are {listWithCommas(favouriteDinosaurs, "all extinct")}.
 96 | 
 97 | === function isAre(list)
 98 | 	{LIST_COUNT(list) == 1:is|are}
 99 | 
100 | My favourite dinosaurs {isAre(favouriteDinosaurs)} {listWithCommas(favouriteDinosaurs, "all extinct")}.
101 | 
102 | My favourite dinosaur{LIST_COUNT(favouriteDinosaurs) != 1:s} {isAre(favouriteDinosaurs)} {listWithCommas(favouriteDinosaurs, "all extinct")}.
103 | 
104 | {LIST_ALL(DoctorsInSurgery)} // Adams, Bernard, Cartwright, Denver, Eamonn
105 | {LIST_COUNT(LIST_ALL(DoctorsInSurgery))} // "5"
106 | {LIST_MIN(LIST_ALL(Eamonn))}
107 | 
108 | LIST ValueList = first_value, second_value, third_value
109 | VAR myList = ()
110 | 
111 | ~ myList = ValueList()
112 | 
113 | { LIST_ALL(myList) }
114 | 
115 | LIST Discs = one, two, three, four, five, six, seven
116 | VAR post1 = ()
117 | VAR post2 = ()
118 | VAR post3 = ()
119 | 
120 | ~ post1 = LIST_ALL(Discs)
121 | 
122 | -> gameloop
123 | 
124 | === function can_move(from_list, to_list) ===
125 |     {
126 |     -   LIST_COUNT(from_list) == 0:
127 |         // no discs to move
128 |         ~ return false
129 |     -   LIST_COUNT(to_list) > 0 && LIST_MIN(from_list) > LIST_MIN(to_list):
130 |         // the moving disc is bigger than the smallest of the discs on the new tower
131 |         ~ return false
132 |     -   else:
133 |     	 // nothing stands in your way!
134 |         ~ return true
135 | 
136 |     }
137 | 
138 | === function move_ring( ref from, ref to ) ===
139 |     ~ temp whichRingToMove = LIST_MIN(from)
140 |     ~ from -= whichRingToMove
141 |     ~ to += whichRingToMove
142 | 
143 | == function getListForTower(towerNum)
144 |     { towerNum:
145 |         - 1:    ~ return post1
146 |         - 2:    ~ return post2
147 |         - 3:    ~ return post3
148 |     }
149 | 
150 | === function name(postNum)
151 |     the {postToPlace(postNum)} temple
152 | 
153 | === function Name(postNum)
154 |     The {postToPlace(postNum)} temple
155 | 
156 | === function postToPlace(postNum)
157 |     { postNum:
158 |         - 1: first
159 |         - 2: second
160 |         - 3: third
161 |     }
162 | 
163 | === function describe_pillar(listNum) ==
164 |     ~ temp list = getListForTower(listNum)
165 |     {
166 |     - LIST_COUNT(list) == 0:
167 |         {Name(listNum)} is empty.
168 |     - LIST_COUNT(list) == 1:
169 |         The {list} ring lies on {name(listNum)}.
170 |     - else:
171 |         On {name(listNum)}, are the discs numbered {list}.
172 |     }
173 | 
174 | 
175 | === gameloop
176 |     Staring down from the heavens you see your followers finishing construction of the last of the great temples, ready to begin the work.
177 | - (top)
178 |     +  (describe) {true || TURNS_SINCE(-> describe) >= 2 || !describe} [ Regard the temples]
179 |         You regard each of the temples in turn. On each is stacked the rings of stone. {describe_pillar(1)} {describe_pillar(2)} {describe_pillar(3)}
180 |     <- move_post(1, 2, post1, post2)
181 |     <- move_post(2, 1, post2, post1)
182 |     <- move_post(1, 3, post1, post3)
183 |     <- move_post(3, 1, post3, post1)
184 |     <- move_post(3, 2, post3, post2)
185 |     <- move_post(2, 3, post2, post3)
186 |     -> DONE
187 | 
188 | = move_post(from_post_num, to_post_num, ref from_post_list, ref to_post_list)
189 |     +   { can_move(from_post_list, to_post_list) }
190 |         [ Move a ring from {name(from_post_num)} to {name(to_post_num)} ]
191 |         { move_ring(from_post_list, to_post_list) }
192 |         { stopping:
193 |         -   The priests far below construct a great harness, and after many years of work, the great stone ring is lifted up into the air, and swung over to the next of the temples.
194 |             The ropes are slashed, and in the blink of an eye it falls once more.
195 |         -   Your next decree is met with a great feast and many sacrifices. After the funeary smoke has cleared, work to shift the great stone ring begins in earnest. A generation grows and falls, and the ring falls into its ordained place.
196 |         -   {cycle:
197 |             - Years pass as the ring is slowly moved.
198 |             - The priests below fight a war over what colour robes to wear, but while they fall and die, the work is still completed.
199 |             }
200 |         }
201 |     -> top
202 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_5_5.ink:
--------------------------------------------------------------------------------
 1 | LIST GuardsOnDuty = (Smith), (Jones), Carter, Braithwaite
 2 | 
 3 | === function changingOfTheGuard
 4 | 	~ GuardsOnDuty = LIST_INVERT(GuardsOnDuty)
 5 | 
 6 | === function changingOfTheGuard
 7 | 	{!GuardsOnDuty: // "is GuardsOnDuty empty right now?"
 8 | 		~ GuardsOnDuty = LIST_ALL(Smith)
 9 | 	- else:
10 | 		~ GuardsOnDuty = LIST_INVERT(GuardsOnDuty)
11 | 	}
12 | 
13 | ~ list = ~ list
14 | 
15 | LIST CoreValues = strength, courage, compassion, greed, nepotism, self_belief, delusions_of_godhood
16 | VAR desiredValues = (strength, courage, compassion, self_belief )
17 | VAR actualValues =  ( greed, nepotism, self_belief, delusions_of_godhood )
18 | 
19 | {desiredValues ^ actualValues} // prints "self_belief"
20 | 
21 | {desiredValues ^ actualValues: The new president has at least one desirable quality.}
22 | 
23 | {LIST_COUNT(desiredValues ^ actualValues) == 1: Correction, the new president has only one desirable quality. {desiredValues ^ actualValues == self_belief: It's the scary one.}}
24 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_5_6.ink:
--------------------------------------------------------------------------------
 1 | LIST Characters = Alfred, Batman, Robin
 2 | LIST Props = champagne_glass, newspaper
 3 | 
 4 | VAR BallroomContents = (Alfred, Batman, newspaper)
 5 | VAR HallwayContents = (Robin, champagne_glass)
 6 | 
 7 | === function describe_room(roomState)
 8 | 	{ roomState ? Alfred: Alfred is here, standing quietly in a corner. } { roomState ? Batman: Batman's presence dominates all. } { roomState ? Robin: Robin is all but forgotten. }
 9 | 	<> { roomState ? champagne_glass: A champagne glass lies discarded on the floor. } { roomState ? newspaper: On one table, a headline blares out WHO IS THE BATMAN? AND *WHO* IS HIS BARELY-REMEMBERED ASSISTANT? }
10 | 
11 | { describe_room(BallroomContents) }
12 | { describe_room(HallwayContents) }
13 | 
14 | *	{ currentRoomState ? (Batman, Alfred) } [Talk to Alfred and Batman]
15 | 	'Say, do you two know each other?'
16 | 
17 | LIST OnOff = on, off
18 | LIST HotCold = cold, warm, hot
19 | 
20 | VAR kettleState = off, cold
21 | 
22 | === function turnOnKettle() ===
23 | { kettleState ? hot:
24 | 	You turn on the kettle, but it immediately flips off again.
25 | - else:
26 | 	The water in the kettle begins to heat up.
27 | 	~ kettleState -= off
28 | 	~ kettleState += on
29 | 	// note we avoid "=" as it'll remove all existing states
30 | }
31 | 
32 | === function can_make_tea() ===
33 | 	~ return kettleState ? (hot, off)
34 | 
35 | === function changeStateTo(ref stateVariable, stateToReach)
36 | 	// remove all states of this type
37 | 	~ stateVariable -= LIST_ALL(stateToReach)
38 | 	// put back the state we want
39 | 	~ stateVariable += stateToReach
40 | 
41 | ~ changeState(kettleState, on)
42 | ~ changeState(kettleState, warm)
43 | 
44 | LIST Letters = a,b,c
45 | LIST Numbers = one, two, three
46 | 
47 | VAR mixedList = (a, three, c)
48 | 
49 | {LIST_ALL(mixedList)}   // a, one, b, two, c, three
50 | {LIST_COUNT(mixedList)} // 3
51 | {LIST_MIN(mixedList)}   // a
52 | {LIST_MAX(mixedList)}   // three or c, albeit unpredictably
53 | 
54 | {mixedList ? (a,b) }        // false
55 | {mixedList ^ LIST_ALL(a)}   // a, c
56 | 
57 | { mixedList >= (one, a) }   // true
58 | { mixedList < (three) }     // false
59 | 
60 | { LIST_INVERT(mixedList) }            // one, b, two
61 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_5_7.ink:
--------------------------------------------------------------------------------
  1 | -> murder_scene
  2 | 
  3 | //
  4 | // 	System: items can have various states
  5 | //	Some are general, some specific to particular items
  6 | //
  7 | 
  8 | LIST OffOn = off, on
  9 | LIST SeenUnseen = unseen, seen
 10 | 
 11 | LIST GlassState = (none), steamed, steam_gone
 12 | LIST BedState = (made_up), covers_shifted, covers_off, stain_visible
 13 | 
 14 | //
 15 | // System: inventory
 16 | //
 17 | 
 18 | LIST Inventory = (none), cane, knife
 19 | 
 20 | === function get(x)
 21 |     ~ Inventory += x
 22 | 
 23 | //
 24 | // System: positioning things
 25 | // Items can be put in and on places
 26 | //
 27 | 
 28 | LIST Supporters = on_desk, on_floor, on_bed, under_bed, held, with_joe
 29 | 
 30 | === function move_to_supporter(ref item_state, new_supporter) ===
 31 |     ~ item_state -= LIST_ALL(Supporters)
 32 |     ~ item_state += new_supporter
 33 | 
 34 | //
 35 | // System: Incremental knowledge.
 36 | // Each list is a chains of facts. Each fact supercedes the fact before it.
 37 | //
 38 | 
 39 | 
 40 | LIST BedKnowledge = (none), neatly_made, crumpled_duvet, hastily_remade, body_on_bed, murdered_in_bed, murdered_while_asleep
 41 | LIST KnifeKnowledge = (none), prints_on_knife, joe_seen_prints_on_knife,joe_wants_better_prints, joe_got_better_prints
 42 | LIST WindowKnowledge = (none), steam_on_glass, fingerprints_on_glass, fingerprints_on_glass_match_knife
 43 | 
 44 | VAR knowledgeState = ()
 45 | 
 46 | === function learn(x) ===
 47 | 	// learn this fact
 48 |     ~ knowledgeState += x
 49 | 
 50 | === function learnt(x) ===
 51 | 	// have you learnt this fact, or indeed a stronger one
 52 |     ~ return highest_state_for_set_of_state(x) >= x
 53 | 
 54 | === function between(x, y) ===
 55 | 	// are you between two ideas? Not necessarily in the same knowledge tree.
 56 |     ~ return learnt(x) && not learnt(y)
 57 | 
 58 | === function think(x) ===
 59 | 	// is this your current "strongest" idea in this knowledge set?
 60 |     ~ return highest_state_for_set_of_state(x) == x
 61 | 
 62 | === function highest_state_for_set_of_state(x) ===
 63 |     ~ return LIST_MAX(knowledgeState ^ LIST_ALL(x))
 64 | 
 65 | === function did_learn(x) ===
 66 | 	//	did you learn this particular fact?
 67 |     ~ return knowledgeState ? x
 68 | 
 69 | //
 70 | // Set up the scene
 71 | //
 72 | 
 73 | VAR bedroomLightState = (off, on_desk)
 74 | VAR knifeState = (under_bed)
 75 | 
 76 | //
 77 | // Content
 78 | //
 79 | 
 80 | === murder_scene ===
 81 |     The bedroom. This is where it happened. Now to look for clues.
 82 | - (top)
 83 |     { bedroomLightState ? seen:     <- seen_light  }
 84 |     <- compare_prints(-> top)
 85 | 
 86 |     *   (dobed) [The bed...]
 87 |         The bed was low to the ground, but not so low something might not roll underneath. It was still neatly made.
 88 |         ~ learn(neatly_made)
 89 |         - - (bedhub)
 90 |         * *     [Lift the bedcover]
 91 |                 I lifted back the bedcover. The duvet underneath was crumpled.
 92 |                 ~ learn(crumpled_duvet)
 93 |                 ~ BedState = covers_shifted
 94 |         * *     (uncover) {learnt(crumpled_duvet)}
 95 |                 [Remove the cover]
 96 |                 Careful not to disturb anything beneath, I removed the cover entirely. The duvet below was rumpled.
 97 |                 Not the work of the maid, who was conscientious to a point. Clearly this had been thrown on in a hurry.
 98 |                 ~ learn(hastily_remade)
 99 |                 ~ BedState = covers_off
100 |         * *     (duvet) {BedState == covers_off} [ Pull back the duvet ]
101 |                 I pulled back the duvet. Beneath it was a sheet, sticky with blood.
102 |                 ~ BedState = stain_visible
103 |                 ~ learn(body_on_bed)
104 |                 Either the body had been moved here before being dragged to the floor - or this is was where the murder had taken place.
105 |         * *     {!(BedState ? made_up)} [ Remake the bed ]
106 |                 Carefully, I pulled the bedsheets back into place, trying to make it seem undisturbed.
107 |                 ~ BedState = made_up
108 |         * *     [Test the bed]
109 |                 I pushed the bed with spread fingers. It creaked a little, but not so much as to be obnoxious.
110 |         * *     (darkunder) [Look under the bed]
111 |                 Lying down, I peered under the bed, but could make nothing out.
112 | 
113 |         * *     {TURNS_SINCE(-> dobed) > 1} [Something else?]
114 |                 I took a step back from the bed and looked around.
115 |                 -> top
116 |         - -     -> bedhub
117 | 
118 |     *   {darkunder && bedroomLightState ? on_floor && bedroomLightState ? on}
119 |         [ Look under the bed ]
120 |         I peered under the bed. Something glinted back at me.
121 |         - - (reaching)
122 |         * *     [ Reach for it ]
123 |                 I fished with one arm under the bed, but whatever it was, it had been kicked far enough back that I couldn't get my fingers on it.
124 |                 -> reaching
125 |         * *     {Inventory ? cane} [Knock it with the cane]
126 |                 -> knock_with_cane
127 | 
128 |         * *     {reaching > 1 } [ Stand up ]
129 |                 I stood up once more, and brushed my coat down.
130 |                 -> top
131 | 
132 |     *   (knock_with_cane) {reaching && TURNS_SINCE(-> reaching) >= 4 &&  Inventory ? cane } [Use the cane to reach under the bed ]
133 |         Positioning the cane above the carpet, I gave the glinting thing a sharp tap. It slid out from the under the foot of the bed.
134 |         ~ move_to_supporter( knifeState, on_floor )
135 |         * *     (standup) [Stand up]
136 |                 Satisfied, I stood up, and saw I had knocked free a bloodied knife.
137 |                 -> top
138 |         * *     [Look under the bed once more]
139 |                 Moving the cane aside, I looked under the bed once more, but there was nothing more there.
140 |                 -> standup
141 | 
142 |     *   {knifeState ? on_floor} [Pick up the knife]
143 |         Careful not to touch the handle, I lifted the blade from the carpet.
144 |         ~ get(knife)
145 | 
146 |     *   {Inventory ? knife} [Look at the knife]
147 |         The blood was dry enough. Dry enough to show up partial prints on the hilt!
148 |         ~ learn(prints_on_knife)
149 | 
150 |     *   [   The desk... ]
151 |         I turned my attention to the desk. A lamp sat in one corner, a neat, empty in-tray in the other. There was nothing else out.
152 |         Leaning against the desk was a wooden cane.
153 |         ~ bedroomLightState += seen
154 |         - - (deskstate)
155 |         * *     (pickup_cane) {Inventory !? cane}    [Pick up the cane ]
156 |                 ~ get(cane)
157 |                 I picked up the wooden cane. It was heavy, and unmarked.
158 | 
159 |         * *    { bedroomLightState !? on } [Turn on the lamp]
160 |                 -> operate_lamp ->
161 |         * *     [Look at the in-tray ]
162 |                 I regarded the in-tray, but there was nothing to be seen. Either the victim's papers were taken, or his line of work had seriously dried up. Or the in-tray was all for show.
163 |         + +     (open)  {open < 3} [Open a drawer]
164 |                 I tried {a drawer at random|another drawer|a third drawer}. {Locked|Also locked|Unsurprisingly, locked as well}.
165 | 
166 |         * *     {deskstate >= 2} [Something else?]
167 |                 I took a step away from the desk once more.
168 |                 -> top
169 |         - -     -> deskstate
170 | 
171 |     *     {(Inventory ? cane) && TURNS_SINCE(-> deskstate) <= 2} [Swoosh the cane]
172 |         I was still holding the cane: I gave it an experimental swoosh. It was heavy indeed, though not heavy enough to be used as a bludgeon.
173 |         But it might have been useful in self-defence. Why hadn't the victim reached for it? Knocked it over?
174 | 
175 |     *   [The window...]
176 |         I went over to the window and peered out. A dismal view of the little brook that ran down beside the house.
177 |         - - (window_opts)
178 |         <- compare_prints(-> window_opts)
179 |         * *     (downy) [Look down at the brook]
180 |                 { GlassState ? steamed:
181 |                     Through the steamed glass I couldn't see the brook. -> see_prints_on_glass -> window_opts
182 |                 }
183 |                 I watched the little stream rush past for a while. The house probably had damp but otherwise, it told me nothing.
184 |         * *     (greasy) [Look at the glass]
185 |                 { GlassState ? steamed: -> downy }
186 |                 The glass in the window was greasy. No one had cleaned it in a while, inside or out.
187 |         * *     { GlassState ? steamed && not see_prints_on_glass && downy && greasy }
188 |                 [ Look at the steam ]
189 |                 A cold day outside. Natural my breath should steam. -> see_prints_on_glass ->
190 |         + +     {GlassState ? steam_gone} [ Breathe on the glass ]
191 |                 I breathed gently on the glass once more. {learnt(fingerprints_on_glass): The fingerprints reappeared. }
192 |                 ~ GlassState = steamed
193 | 
194 |         + +     [Something else?]
195 |                 { window_opts < 2 || learnt(fingerprints_on_glass) || GlassState ? steamed:
196 |                     I looked away from the dreary glass.
197 |                     {GlassState ? steamed:
198 |                         ~ GlassState = steam_gone
199 |                         <> The steam from my breath faded.
200 |                     }
201 |                     -> top
202 |                 }
203 |                 I leant back from the glass. My breath had steamed up the pane a little.
204 |                ~ GlassState = steamed
205 |         - -     -> window_opts
206 | 
207 | 
208 | 
209 |     *   {top >= 5} [Leave the room]
210 |         I'd seen enough. I {bedroomLightState ? on:switched off the lamp, then} turned and left the room.
211 |         -> joe_in_hall
212 |     -   -> top
213 | 
214 | = see_prints_on_glass
215 |     ~ learn(fingerprints_on_glass)
216 |     {But I could see a few fingerprints, as though someone had leant their palm against it.|The fingerprints were quite clear and well-formed.} They faded as I watched.
217 |     ~ GlassState = steam_gone
218 |     ->->
219 | 
220 | = compare_prints (-> backto)
221 |     *   {learnt(fingerprints_on_glass) && learnt(prints_on_knife) && !learnt(fingerprints_on_glass_match_knife)} [Compare the prints on the knife and the window ]
222 |         Holding the bloodied knife near the window, I breathed to bring out the prints once more, and compared them as best I could.
223 |         Hardly scientific, but they seemed very similar - very similiar indeed.
224 |         ~ learn(fingerprints_on_glass_match_knife)
225 |         -> backto
226 | 
227 | = operate_lamp
228 |     I flicked the light switch.
229 |     { bedroomLightState ? on:
230 |         <> The bulb fell dark.
231 |         ~ bedroomLightState += off
232 |         ~ bedroomLightState -= on
233 |     - else:
234 |         { bedroomLightState ? on_floor: <> A little light spilled under the bed.} { bedroomLightState ? on_desk : <> The light gleamed on the polished tabletop. }
235 |         ~ bedroomLightState -= off
236 |         ~ bedroomLightState += on
237 |     }
238 |     ->->
239 | 
240 | = seen_light
241 |     *   {!(bedroomLightState ? on)} [ Turn on lamp ]
242 |         -> operate_lamp ->
243 | 
244 |     *   { !(bedroomLightState ? on_bed)  && BedState ? stain_visible }
245 |         [ Move the light to the bed ]
246 |         ~ move_to_supporter(bedroomLightState, on_bed)
247 |         I moved the light over to the bloodstain and peered closely at it. It had soaked deeply into the fibres of the cotton sheet.
248 |         There was no doubt about it. This was where the blow had been struck.
249 |         ~ learn(murdered_in_bed)
250 | 
251 |     *   { !(bedroomLightState ? on_desk) } {TURNS_SINCE(-> floorit) >= 2 }
252 |         [ Move the light back to the desk ]
253 |         ~ move_to_supporter(bedroomLightState, on_desk)
254 |         I moved the light back to the desk, setting it down where it had originally been.
255 |     *   (floorit) { !(bedroomLightState ? on_floor) && darkunder }
256 |         [Move the light to the floor ]
257 |         ~ move_to_supporter(bedroomLightState, on_floor)
258 |         I picked the light up and set it down on the floor.
259 |     -   -> top
260 | 
261 | === joe_in_hall
262 |     My police contact, Joe, was waiting in the hall. 'So?' he demanded. 'Did you find anything interesting?'
263 | - (found)
264 |     *   {found == 1} 'Nothing.'
265 |         He shrugged. 'Shame.'
266 |         -> done
267 |     *   { Inventory ? knife } 'I found the murder weapon.'
268 |         'Good going!' Joe replied with a grin. 'We thought the murderer had gotten rid of it. I'll bag that for you now.'
269 |         ~ move_to_supporter(knifeState, with_joe)
270 |     *   {learnt(prints_on_knife)} { knifeState ? with_joe }
271 |         'There are prints on the blade[.'],' I told him.
272 |         He regarded them carefully.
273 |         'Hrm. Not very complete. It'll be hard to get a match from these.'
274 |         ~ learn(joe_seen_prints_on_knife)
275 |     *   { learnt(fingerprints_on_glass_match_knife) && learnt(joe_seen_prints_on_knife) }
276 |         'They match a set of prints on the window, too.'
277 |         'Anyone could have touched the window,' Joe replied thoughtfully. 'But if they're more complete, they should help us get a decent match!'
278 |         ~ learn(joe_wants_better_prints)
279 |     *   { between(body_on_bed, murdered_in_bed)}
280 |         'The body was moved to the bed at some point[.'],' I told him. 'And then moved back to the floor.'
281 |         'Why?'
282 |         * *     'I don't know.'
283 |                 Joe nods. 'All right.'
284 |         * *     'Perhaps to get something from the floor?'
285 |                 'You wouldn't move a whole body for that.'
286 |         * *     'Perhaps he was killed in bed.'
287 |                 'It's just speculation at this point,' Joe remarks.
288 |     *   { learnt(murdered_in_bed) }
289 |         'The victim was murdered in bed, and then the body was moved to the floor.'
290 |         'Why?'
291 |         * *     'I don't know.'
292 |                 Joe nods. 'All right, then.'
293 |         * *     'Perhaps the murderer wanted to mislead us.'
294 |                 'How so?'
295 |             * * *   'They wanted us to think the victim was awake[.'], I replied thoughtfully. 'That they were meeting their attacker, rather than being stabbed in their sleep.'
296 |             * * *   'They wanted us to think there was some kind of struggle[.'],' I replied. 'That the victim wasn't simply stabbed in their sleep.'
297 |             - - -   'But if they were killed in bed, that's most likely what happened. Stabbed, while sleeping.'
298 |                     ~ learn(murdered_while_asleep)
299 |         * *     'Perhaps the murderer hoped to clean up the scene.'
300 |                 'But they were disturbed? It's possible.'
301 | 
302 | 
303 |     *   { found > 1} 'That's it.'
304 |         'All right. It's a start,' Joe replied.
305 |         -> done
306 |     -   -> found
307 | -   (done)
308 |     {
309 |     - between(joe_wants_better_prints, joe_got_better_prints):
310 |         ~ learn(joe_got_better_prints)
311 |         <>  He moved for the door.  'I'll get those prints from the window now.'
312 |     - learnt(joe_seen_prints_on_knife):
313 |         <> 'I'll run those prints as best I can.'
314 |     - else:
315 |         <> 'Not much to go on.'
316 |     }
317 |     -> END
318 | 


--------------------------------------------------------------------------------
/tests/visual-inspection/writing_with_ink/part_5_8.ink:
--------------------------------------------------------------------------------
 1 | LIST GameEvents = foundSword, openedCasket, metGorgon // Toto
 2 | { GameEvents ? openedCasket }
 3 | { GameEvents ? (foundSword, metGorgon) }
 4 | ~ GameEvents += metGorgon
 5 | 
 6 | LIST PancakeState = ingredients_gathered, batter_mix, pan_hot, pancakes_tossed, ready_to_eat
 7 | { PancakeState == batter_mix }
 8 | { PancakeState < ready_to_eat }
 9 | ~ PancakeState++
10 | 
11 | LIST OnOffState = on, off
12 | LIST ChargeState = uncharged, charging, charged
13 | 
14 | VAR PhoneState = (off, uncharged)
15 | 
16 | *	{PhoneState !? uncharged } [Plug in phone]
17 | 	~ PhoneState -= LIST_ALL(ChargeState)
18 | 	~ PhoneState += charging
19 | 	You plug the phone into charge.
20 | *	{ PhoneState ? (on, charged) } [ Call my mother ]
21 | 
22 | 


--------------------------------------------------------------------------------
/tslint.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "extends": [
 3 |         "tslint:recommended",
 4 |         "tslint-config-prettier"
 5 |     ],
 6 |     "jsRules": {},
 7 |     "rules": {
 8 |         "interface-name": false,
 9 |         "object-literal-sort-keys": false,
10 |         "semicolon": true
11 |     },
12 |     "rulesDirectory": []
13 | }
14 | 


--------------------------------------------------------------------------------