summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/typ/builtins-gui.json6
-rw-r--r--docs/typ/builtins-tty.json6
-rw-r--r--docs/typ/guide.typ33
-rw-r--r--docs/typ/reference.typ10
4 files changed, 53 insertions, 2 deletions
diff --git a/docs/typ/builtins-gui.json b/docs/typ/builtins-gui.json
index 83a410dc..f602ee92 100644
--- a/docs/typ/builtins-gui.json
+++ b/docs/typ/builtins-gui.json
@@ -6,6 +6,10 @@
{"name": "BootShell", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "keep, replace", "doc": "A document dropped where a lone untouched shell stands: keep the shell, or replace it."},
{"name": "Callees", "leader": "SPC l C", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "List the functions the function under the cursor calls."},
{"name": "Callers", "leader": "SPC l c", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "List the callers of the function under the cursor."},
+ {"name": "Callstack", "leader": "SPC l b", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Show outermost callers first, with signatures and call sites (gc)."},
+ {"name": "CallstackCorners", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "rounded, square", "doc": "Callstack tree corners: rounded (the default) or square; bare, it switches styles. Applies to the next Callstack query."},
+ {"name": "CallstackDepth", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": null, "doc": "Caller levels collected by Callstack, 1 through 64; default 8. Bare, it says the current limit."},
+ {"name": "CallstackLayout", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "inline, stacked", "doc": "Callstack snippets below their locations (stacked, the default) or beside them (inline); bare, it switches layouts. Applies to the next Callstack query."},
{"name": "Changelog", "leader": "SPC h c", "also": ["topbar"], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "This build's version and what changed to reach it, printed into an output buffer the same way Config prints the live settings."},
{"name": "ChipShadow", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "on, off", "doc": "In a terminal, a notice chip casts a cell's shadow right and down, on or off."},
{"name": "ClipPaste", "leader": "SPC p", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Paste the system clipboard after the selection."},
@@ -65,6 +69,8 @@
{"name": "Ligatures", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "on, off", "doc": "A font's programming ligatures draw across their cells, on or off."},
{"name": "LocationsConfig", "leader": null, "also": [], "arg": true, "scope": "root", "setting": false, "choices": null, "doc": "Set how location rows are drawn, or show how they are when bare."},
{"name": "Look", "leader": null, "also": ["enter", "right-click"], "arg": true, "scope": "pane", "setting": false, "choices": null, "doc": "Look at its argument: open the file or address it names, else find the word, as a right click does."},
+ {"name": "LookNext", "leader": "SPC j n", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Select the next Look location across panes; Enter opens it."},
+ {"name": "LookPrev", "leader": "SPC j p", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Select the previous Look location across panes; Enter opens it."},
{"name": "LookWord", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "search, list", "doc": "A plain word looked at: search selects its next place in the pane, list lists every place in a +Search."},
{"name": "Lspinfo", "leader": "SPC l i", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Show which language servers serve this file and their state."},
{"name": "Lspwhy", "leader": "SPC l w", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Explain how the last language server request was answered, step by step."},
diff --git a/docs/typ/builtins-tty.json b/docs/typ/builtins-tty.json
index 35e12875..e02f4201 100644
--- a/docs/typ/builtins-tty.json
+++ b/docs/typ/builtins-tty.json
@@ -5,6 +5,10 @@
{"name": "BootShell", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "keep, replace", "doc": "A document dropped where a lone untouched shell stands: keep the shell, or replace it."},
{"name": "Callees", "leader": "SPC l C", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "List the functions the function under the cursor calls."},
{"name": "Callers", "leader": "SPC l c", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "List the callers of the function under the cursor."},
+ {"name": "Callstack", "leader": "SPC l b", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Show outermost callers first, with signatures and call sites (gc)."},
+ {"name": "CallstackCorners", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "rounded, square", "doc": "Callstack tree corners: rounded (the default) or square; bare, it switches styles. Applies to the next Callstack query."},
+ {"name": "CallstackDepth", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": null, "doc": "Caller levels collected by Callstack, 1 through 64; default 8. Bare, it says the current limit."},
+ {"name": "CallstackLayout", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "inline, stacked", "doc": "Callstack snippets below their locations (stacked, the default) or beside them (inline); bare, it switches layouts. Applies to the next Callstack query."},
{"name": "Changelog", "leader": "SPC h c", "also": ["topbar"], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "This build's version and what changed to reach it, printed into an output buffer the same way Config prints the live settings."},
{"name": "ChipShadow", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "on, off", "doc": "In a terminal, a notice chip casts a cell's shadow right and down, on or off."},
{"name": "ClipPaste", "leader": "SPC p", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Paste the system clipboard after the selection."},
@@ -55,6 +59,8 @@
{"name": "Left", "leader": "SPC w h", "also": ["C-w h", "C-w left"], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Move the keyboard to the pane, or column tag, to the left."},
{"name": "LocationsConfig", "leader": null, "also": [], "arg": true, "scope": "root", "setting": false, "choices": null, "doc": "Set how location rows are drawn, or show how they are when bare."},
{"name": "Look", "leader": null, "also": ["enter", "right-click"], "arg": true, "scope": "pane", "setting": false, "choices": null, "doc": "Look at its argument: open the file or address it names, else find the word, as a right click does."},
+ {"name": "LookNext", "leader": "SPC j n", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Select the next Look location across panes; Enter opens it."},
+ {"name": "LookPrev", "leader": "SPC j p", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Select the previous Look location across panes; Enter opens it."},
{"name": "LookWord", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "search, list", "doc": "A plain word looked at: search selects its next place in the pane, list lists every place in a +Search."},
{"name": "Lspinfo", "leader": "SPC l i", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Show which language servers serve this file and their state."},
{"name": "Lspwhy", "leader": "SPC l w", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Explain how the last language server request was answered, step by step."},
diff --git a/docs/typ/guide.typ b/docs/typ/guide.typ
index 55f8a4f0..7058592f 100644
--- a/docs/typ/guide.typ
+++ b/docs/typ/guide.typ
@@ -218,10 +218,39 @@ around it, a `+`/`-` before each line, the words a changed line changed
tinted and a line added or removed whole faintly. A mailed patch keeps its
message and diffstat above. The files are found from the diff's directory
or one above it. #word("Diff") on a `+Diff` shows the diff itself as
-text (a paged one's `+Pager` is folded under it), and on the text stacks
+text (a paged one's `+Pager` is closed once stacked), and on the text stacks
it again; #word("DiffLook") `text` in the startup file opens the text
first.
+= Call hierarchy <callstack>
+
+Put the cursor on a function and run #word("Callstack") (#key("g c") or #key("SPC l b")).
+`+Callstack` starts at the outermost callers and follows calls down toward
+the selected function, with shared callers grouped and vertical guides
+joining the levels with rounded corners. Each caller has a clickable location and its function
+signature, extracted by the same tree-sitter context mechanism as other
+location results. Signatures and call-site snippets use source syntax colors;
+only calls to the selected function receive background emphasis. Guides
+continue alongside every line of a multiline signature and through screen
+wrapping. Cross-directory Look paths are shortened when possible.
+#btn("B3") or #key("Enter") on a location opens and reveals that source
+pane. #word("LookNext") / #word("LookPrev") (#keys("SPC j n", "SPC j p"))
+select locations without opening them. The view follows the language
+server's static call hierarchy; recursive paths are marked `↻`, and a
+large hierarchy invites continuing from another function.
+#word("CallstackDepth") reports the current caller depth;
+`CallstackDepth 16` changes it for subsequent queries. The default is 8
+levels, and the accepted range is 1–64. The view also caps collection at
+64 callers.
+
+`CallstackLayout stacked` (the default) puts each signature and call snippet below its
+location, aligned with the location text; `CallstackLayout inline` puts it
+beside the location again. A bare #word("CallstackLayout") switches modes.
+`CallstackCorners rounded` (the default) uses rounded tree guides;
+`CallstackCorners square` restores sharp corners. Bare #word("CallstackCorners")
+switches styles. Layout and corner changes apply to the next query. These settings are retained
+by #word("Dump") / #word("Restore").
+
= `pardes FILE` and `--wait` <editor>
In a pane's shell:
@@ -242,7 +271,7 @@ refusals and `--nested` are in the reference.
[#key("x"), #key("v"), #key(";")], [select the line; extend; collapse to the cursor],
[#key("s")], [a cursor per regex match; every edit acts at each],
[#key("/"), #keys("n", "N")], [substring search; repeat the search in the current text, wrapping at the ends],
- [#keys("Space j n", "Space j p")], [#word("LookNext") / #word("LookPrev"): select locations across panes; #key("Enter") opens one],
+ [#keys("SPC j n", "SPC j p")], [#word("LookNext") / #word("LookPrev"): select locations across panes; #key("Enter") opens one],
[#key("g l")], [line end],
[`12G`], [line 12; a bare #key("G") does nothing],
[#key("SPC ?")], [#word("Help"): every builtin, with its leader path and keys; `SPC w ?` only the paths under `SPC w`; #word("Tutor") (#key("SPC h t")) practises them],
diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ
index 909c1e1a..05176951 100644
--- a/docs/typ/reference.typ
+++ b/docs/typ/reference.typ
@@ -262,6 +262,16 @@ A line written to #file("exec") is #word("Exec"):
the server answers in this file alone while another open file of its
language still holds the old name, a row per such file (zls renaming at
a declaration; from a use it reaches every file);
+ #word("Callstack") (#key("g c") or #key("SPC l b")) opens and focuses `+Callstack`,
+ with static caller ancestry, tree-sitter signatures and Look locations
+ for callers and call sites. #word("CallstackDepth") reports or sets the
+ runtime depth (1–64, default 8) for subsequent queries.
+ `CallstackLayout stacked` (the default) aligns snippets below their locations;
+ `CallstackLayout inline` places the snippets beside them.
+ `CallstackCorners rounded` (the default) or `CallstackCorners square`
+ selects the tree corner style for the next query; bare, it switches styles.
+ #word("Callers") and #word("Callees") keep their short
+ lists and single-result jumps.
#word("Diagnostics") and #word("Symbols") list the file's in `+Search`;
#word("Lspinfo") fills `+Lsp`, the pane its write answers, with which
server serves the file and its state (`not started yet` until its first