vxml_pipeline/tracking

Serializes, selects, and displays VXML for pipeline tracking monitors.

Tracking first serializes VXML into SLine values so selectors can retain tree structure and blame while marking lines for display. A LineSelector selects individual lines; a Selector can inspect and transform the whole serialized list, allowing selection to expand to ancestors or neighboring lines. Rendering functions then produce either tables or verbatim VXML.

Types

LineSelector

</>

Selects one serialized VXML line.

pub type LineSelector =
  fn(SLine) -> SelectionStatus

SLine

</>

One structural line in VXML serialized for selection and tracking.

VSLine represents the tag line of a V-node.
ASLine represents one attribute line of a V-node.
TSLine represents the <> opening line of a T-node.
LSLine represents one content line of a T-node.

Every variant retains indentation, blame, serialized content, and selection status. V- and attribute lines additionally retain their parsed fields.

pub type SLine {
  VSLine(
    blame: blame.Blame,
    indent: Int,
    content: String,
    selected: SelectionStatus,
    tag: String,
  )
  ASLine(
    blame: blame.Blame,
    indent: Int,
    content: String,
    selected: SelectionStatus,
    key: String,
    val: String,
  )
  TSLine(
    blame: blame.Blame,
    indent: Int,
    content: String,
    selected: SelectionStatus,
  )
  LSLine(
    blame: blame.Blame,
    indent: Int,
    content: String,
    selected: SelectionStatus,
  )
}

Constructors

VSLine(
  blame: blame.Blame,
  indent: Int,
  content: String,
  selected: SelectionStatus,
  tag: String,
)

ASLine(
  blame: blame.Blame,
  indent: Int,
  content: String,
  selected: SelectionStatus,
  key: String,
  val: String,
)

TSLine(
  blame: blame.Blame,
  indent: Int,
  content: String,
  selected: SelectionStatus,
)

LSLine(
  blame: blame.Blame,
  indent: Int,
  content: String,
  selected: SelectionStatus,
)

SelectionStatus

</>

Whether and why a serialized VXML line is included in tracked output.

OG marks a direct selector match. Bystander marks structural or nearby context added around a match.

pub type SelectionStatus {
  NotSelected
  OG
  Bystander
}

Constructors

```
NotSelected
```
```
OG
```
```
Bystander
```

Selector

</>

Selects or expands selections across a complete serialized VXML tree.

pub type Selector =
  fn(List(SLine)) -> List(SLine)

Values

apply_line_selector_to_line

</>

pub fn apply_line_selector_to_line(
  line: SLine,
  line_selector: fn(SLine) -> SelectionStatus,
) -> SLine

Replaces one line’s selection status with the result of line_selector.

extend_selection_down

</>

pub fn extend_selection_down(
  lines: List(SLine),
  amt: Int,
) -> List(SLine)

Adds up to amt following lines as bystander context around every direct match.

extend_selection_to_ancestors

</>

pub fn extend_selection_to_ancestors(
  lines: List(SLine),
  with_elder_siblings w1: Bool,
  with_ancestor_attrs w2: Bool,
  with_elder_sibling_attrs w3: Bool,
) -> List(SLine)

Adds structural ancestor context around selected lines.

The boolean arguments additionally include elder sibling tags, ancestor attributes, and elder-sibling attributes respectively.

extend_selection_up

</>

pub fn extend_selection_up(
  lines: List(SLine),
  amt: Int,
) -> List(SLine)

Adds up to amt preceding lines as bystander context around every direct match.

extend_selector_down

</>

pub fn extend_selector_down(
  f: fn(List(SLine)) -> List(SLine),
  amt: Int,
) -> fn(List(SLine)) -> List(SLine)

Composes a selector with downward bystander expansion.

extend_selector_to_ancestors

</>

pub fn extend_selector_to_ancestors(
  f: fn(List(SLine)) -> List(SLine),
  with_elder_siblings w1: Bool,
  with_ancestor_attrs w2: Bool,
  with_elder_sibling_attrs w3: Bool,
) -> fn(List(SLine)) -> List(SLine)

Composes a selector with structural ancestor expansion.

extend_selector_up

</>

pub fn extend_selector_up(
  f: fn(List(SLine)) -> List(SLine),
  amt: Int,
) -> fn(List(SLine)) -> List(SLine)

Composes a selector with upward bystander expansion.

line_selector_to_selector

</>

pub fn line_selector_to_selector(
  line_selector: fn(SLine) -> SelectionStatus,
) -> fn(List(SLine)) -> List(SLine)

Lifts a line-level selector into a whole-tree selector.

or_selectors

</>

pub fn or_selectors(
  s1: fn(List(SLine)) -> List(SLine),
  s2: fn(List(SLine)) -> List(SLine),
) -> fn(List(SLine)) -> List(SLine)

Combines two selectors, preserving the strongest selection status assigned to each line.

select_relative_window

</>

pub fn select_relative_window(
  selector: fn(List(SLine)) -> List(SLine),
  first_offset: Int,
  last_offset: Int,
) -> fn(List(SLine)) -> List(SLine)

Restricts a selector to the inclusive line-offset interval around each direct match. Offsets may lie wholly before or wholly after a match.

vxml_to_s_lines

</>

pub fn vxml_to_s_lines(vxml: vxml.VXML) -> List(SLine)

Serializes one VXML tree into initially unselected structural lines.