avail/avail.persistence.cache.record/PhrasePathRecord

PhrasePathRecord

class PhrasePathRecord(val rootTrees: MutableList<PhrasePathRecord.PhraseNode> = mutableListOf())

Information for efficiently navigating from any position in a module's source to the hierarchy of A_Phrases containing that position.

Constructors

PhrasePathRecord

constructor(rootTrees: MutableList<PhrasePathRecord.PhraseNode> = mutableListOf())

Construct an instance from an optional list of PhraseNodes.

Types

PhraseNode

class PhraseNode(val atomModuleName: A_String?, val atomName: A_String?, val usageType: NamesIndex.UsageType, val tokenSpans: List<PhrasePathRecord.PhraseNode.PhraseNodeToken>, var parent: PhrasePathRecord.PhraseNode?, val children: MutableList<PhrasePathRecord.PhraseNode> = mutableListOf())

A node of a tree that represents an occurrence of an A_Phrase in this A_Module. If the phrase is a send or macro invocation, the information about which atom's bundle was sent is available, as are the tokens that are part of the phrase (but not its subphrases).

Properties

rootTrees

val rootTrees: MutableList<PhrasePathRecord.PhraseNode>

The PhraseNodes representing the sequence of top-level phrases of the module.

Functions

phraseNodesDo

fun phraseNodesDo(action: (PhrasePathRecord.PhraseNode) -> Unit)

For each PhraseNode in this module, working top-down, invoke the action with that PhraseNode.

toString

open override fun toString(): String