vxml/blame

Source provenance for VXML trees.

Blame values attach origin information to VXML nodes, attributes, and lines. Source blame can be movable or anchored, which lets parsers and transformation pipelines preserve useful locations while slicing or moving text.

Types

Blame

</>

Provenance for a VXML node, attribute, or line.

pub type Blame {
  Src(
    comments: List(String),
    path: String,
    line_no: Int,
    char_no: Int,
    cursor: SourceCursor,
  )
  Des(comments: List(String), name: String, line_no: Int)
  Ext(comments: List(String), name: String)
  NoBlame(comments: List(String))
}

Constructors

Src(
  comments: List(String),
  path: String,
  line_no: Int,
  char_no: Int,
  cursor: SourceCursor,
)

Des(comments: List(String), name: String, line_no: Int)

Ext(comments: List(String), name: String)

```
NoBlame(comments: List(String))
```

BlameTableMarginColumnsMinMax

</>

pub type BlameTableMarginColumnsMinMax {
  BlameTableMarginColumnsMinMax(min: Int, max: Int)
}

Constructors

BlameTableMarginColumnsMinMax(min: Int, max: Int)

SourceCursor

</>

Whether a source position can move when text is sliced or shifted.

pub type SourceCursor {
  Movable
  Anchored
}

Constructors

```
Movable
```
```
Anchored
```

Values

advance

</>

pub fn advance(blame: Blame, by: Int) -> Blame

Advance movable source blame by a character offset.

append_comment

</>

pub fn append_comment(blame: Blame, comment: String) -> Blame

blame_digest

</>

pub fn blame_digest(blame: Blame) -> String

Render a short human-readable blame label.

blamed_strings_annotated_table

</>

pub fn blamed_strings_annotated_table(
  lines: List(#(Blame, String)),
  banner: String,
  blame_digest_margin: BlameTableMarginColumnsMinMax,
  comments_margin: BlameTableMarginColumnsMinMax,
) -> List(String)

clear_comments

</>

pub fn clear_comments(blame: Blame) -> Blame

Remove comments while preserving the main blame identity.

comments_digest

</>

pub fn comments_digest(blame: Blame) -> String

no_blame

</>

pub const no_blame: Blame

path_contains

</>

pub fn path_contains(blame: Blame, s: String) -> Bool

prepend_comment

</>

pub fn prepend_comment(blame: Blame, comment: String) -> Blame

Add a comment before existing blame comments.

set_anchored

</>

pub fn set_anchored(blame: Blame) -> Blame

Mark source blame as anchored.