Skip to content

README.md

Latest commit

 

History

History
31 lines (21 loc) · 3.03 KB

README.md

File metadata and controls

31 lines (21 loc) · 3.03 KB
Raw

Source navigation workshop · Scarp alpha.6

This is an executable two-module project, separate from the 51 numbered lessons. The source is adapted from Scarp's published v0.0.6-alpha.1 example examples/symbol_navigation.srp: the import path is relocated into this project's src/lib/ directory. The helper and exact expected output are from the same tagged upstream source; see third-party notices. No sample JSON is fabricated.

From the Scarp by Example repository root, using the pinned compiler:

scarp verify tutorials/source-navigation
scarp inspect modules --json tutorials/source-navigation
scarp inspect symbols --json tutorials/source-navigation
scarp inspect references --json tutorials/source-navigation
scarp launch tutorials/source-navigation

The read-only inspection commands never execute ordinary program statements. launch runs the actual interpreter and prints 30 followed by LF, matching expected.stdout. You can replace the directory argument with tutorials/source-navigation/src/main.srp for the two symbol/reference commands.

What to look for

  1. Find the public offset and adjust declarations in the imported module, and the private private_seed. The library alias is defined in main.srp.
  2. Locate the two different base declarations: the outer one is used to initialize the inner one; the inner one is used by the accumulator.
  3. Find the named argument sites value: and n: and identify the parameter declarations to which their references resolve.
  4. Look for the step loop index and the call to twice.
  5. Compare file- and directory-based inspection. Display paths may differ, and symbol.id is local to one snapshot. Do not compare IDs across invocations.

The browser website displays the original source, expected output and instructions, but it does not run Scarp. Read the English teaching guide, Hindi guide or workshop page.

Clickable, offline-safe reference explorer

The workshop site now links 11 selected declarations to 20 use sites in both real source files. Click either a declaration or a use to highlight matching occurrences and show the English/Hindi explanations. With JavaScript disabled, each code link still jumps to its explanation. The code is not editable or executed in the browser.

The human-readable reference-map.json uses stable course-local keys such as base-outer and base-inner, not Scarp's compilation-local numeric symbol IDs. Every recorded declaration, use kind, target, source file, line and Unicode-scalar column is checked against the real scarp inspect references --json result in CI on Linux, Windows and macOS. A compiler change that changes the links fails verification instead of publishing an outdated diagram.