Give scope, binding, link, pick and head one meaning each: renderEnv, nodeSet, pipeline, resolvedRef, resolveTemplates, drawItem and a read's start
This commit is contained in:
@@ -16,20 +16,26 @@ package fejkdata
|
||||
|
||||
// Vocabulary
|
||||
//
|
||||
// - draw — one pick from a choice, or one row taken from a table: `pick`,
|
||||
// `resolveChoice`, `renderScope.drawRowOf`. Every {…} draws afresh, bar a read of a name.
|
||||
// - draw — one item taken from a choice, or one row from a table: `drawItem`,
|
||||
// `drawThroughChoices`, `renderEnv.drawRowOf`. Every {…} draws afresh, bar a read of a name.
|
||||
// - expansion — one render of one format: `expand`.
|
||||
// - render — one walk of the tree from an entry point, over one `frameStack`:
|
||||
// `Generator.Fake`, `FakeRecord`, `Template.Fake` and `RecordTemplate.Fake`
|
||||
// start one each, and `FakeStruct` one per record.
|
||||
// - env — what a render reads names and rows through: `renderEnv`.
|
||||
// - named pick — the draw a token such as {/person as p} binds to a name, drawn
|
||||
// on its first read and kept while its scope renders: a category, or one
|
||||
// repeat iteration: `nameBinding`, `nameScope`, `namedPick`, `pickFrame`.
|
||||
// A scope is only ever a name's.
|
||||
// - memo — what a named pick keeps its draws in, the variant drawn at each level
|
||||
// and the value each path read: `drawMemo`.
|
||||
// - pin — fixing which row of a table one path, or one named pick, uses:
|
||||
// `pinSet`, `namedPick.pins`, `table.drawStep`.
|
||||
// - family — a table and every table reaching it through a chain of parent
|
||||
// links (`table.linkParent`).
|
||||
// links (`table.linkParent`). Only a table links.
|
||||
// - resolve — tying each template's references and names to the merged tree:
|
||||
// `resolveTemplates`.
|
||||
// - head — a read's first segment, a string: `arm.head`. The node it names is
|
||||
// the read's start: `template.startOf`, `nameTarget.start`.
|
||||
// - fence — a load-time check, run over each category, template or struct as it
|
||||
// loads or compiles, so rendering a compiled tree cannot fail.
|
||||
|
||||
Reference in New Issue
Block a user