Korin API

Xrefs
in package
implements NodeRule

FinalYes

Xrefs and pointers. 7.0 allows only uppercase letters, digits and "_" in an xref and reserves @VOID@: a record with any other xref (@fam 1@, @note@, @VOID@) gets @X<n>@, the next free n in document order, and every pointer to it follows. A pointer to a record that does not exist (compared case-sensitively: @test@ is not @TEST@) becomes the null pointer @VOID@, except under NOTE: there it is more likely text written without "@@" escaping (@Smith family@) and stays text (NOTE @@Smith family@), so nothing is lost, and in an extension (_IN @B1@), which 7.0 leaves to the extension's definition. Needs the prepass: a pointer may come before the record it points to.

Table of Contents

Interfaces

NodeRule
A rule for one structure at a time. Rules that look at every line of a record are grouped in {@see Rule\Nodes}, which walks each record once for all of them.

Methods

needsPrepass()  : bool
Whether the rule needs Context::prepass(): facts about the whole input before the first record.
node()  : bool
Converts one structure (a record or a substructure; never a CONC/CONT line) with one of the rule's tags, as the structure is tagged when the walk reaches it, in place. Its substructures are visited after it, as they are when this returns.
tags()  : array<int, string>|null

Methods

needsPrepass()

Whether the rule needs Context::prepass(): facts about the whole input before the first record.

public needsPrepass() : bool
Return values
bool

node()

Converts one structure (a record or a substructure; never a CONC/CONT line) with one of the rule's tags, as the structure is tagged when the walk reaches it, in place. Its substructures are visited after it, as they are when this returns.

public node(Document $document, int $id, Context $context) : bool
Parameters
$document : Document
$id : int
$context : Context
Return values
bool —

false when the rule removed the structure: the rules after it and its substructures are skipped

tags()

public tags() : array<int, string>|null
Return values
array<int, string>|null —

the tags of the structures the rule converts; null for every structure

On this page

Search results