pub struct Template { /* private fields */ }Expand description
A finished, checked lowering template.
Register it in a mapping with
MappingBuilder::template, then use it
for a node kind (template_node)
or an operator (OpSpec::Template).
§Examples
use lower_lang::templates;
let t = templates::while_loop();
assert_eq!(t.name(), "while");
assert_eq!(t.hole_count(), 3);Implementations§
Source§impl Template
impl Template
Sourcepub fn name(&self) -> &str
pub fn name(&self) -> &str
The template’s name (also the expansion’s name in HIR origins).
§Examples
assert_eq!(lower_lang::templates::do_while().name(), "do-while");Sourcepub const fn expansion_kind(&self) -> ExpnKind
pub const fn expansion_kind(&self) -> ExpnKind
The expansion kind instantiations record (Template by default,
Desugar for the built-in desugarings).
§Examples
use hir_lang::ExpnKind;
assert_eq!(lower_lang::templates::while_loop().expansion_kind(), ExpnKind::Desugar);Sourcepub fn hole_count(&self) -> usize
pub fn hole_count(&self) -> usize
The number of holes; a node that uses the template binds one pick per hole, in this order.
§Examples
assert_eq!(lower_lang::templates::c_for().hole_count(), 5);Sourcepub fn hole(&self, index: usize) -> Option<(&str, HoleKind, bool)>
pub fn hole(&self, index: usize) -> Option<(&str, HoleKind, bool)>
Hole index: its name, kind, and whether it may be absent.
§Examples
use lower_lang::HoleKind;
let t = lower_lang::templates::while_loop();
assert_eq!(t.hole(0), Some(("cond", HoleKind::Expr, false)));
assert_eq!(t.hole(2), Some(("label", HoleKind::Label, true)));
assert_eq!(t.hole(3), None);Sourcepub fn parse(name: &str, text: &str) -> Result<Self, TemplateError>
pub fn parse(name: &str, text: &str) -> Result<Self, TemplateError>
Parses a template written in HIR’s textual template syntax (HIR spec
§20, LSF2 §15.8): the lazy path for [semantics.templates] and
inline [semantics.lower] texts.
Holes are ${name} (its kind — expression, pattern, type, or label —
follows from where it is written), ${name?} (optional),
${name?=<literal>} (optional with a default), and ${...name} (an
argument-list splice in a call, tuple, or array, or a statement
splice in a block). Holes are numbered in order of first appearance.
Names bound with let, let_place, a pattern, or a closure parameter
are template binders, fresh and hygienic per instantiation; labels
('l loop { … }) likewise. Free names are written global:a::b,
host symbols extern:mox.echo. Operations are written by their OPS
name: add(a, b) takes the language’s policies, add<overflow=wrap>(a, b) exactly the ones written. apply:<name>(…) needs templates
registered before this one: use
MappingBuilder::parse_template
for it. The full grammar is in docs/API.md.
§Errors
TemplateError::Syntax with the byte range and a
SyntaxError for any text that is not a valid
template (never a panic, at any length or depth); TooLarge when the
result outgrows the template tables.
§Examples
use lower_lang::{HoleKind, Template};
// PHP's `&&`, which returns a bool.
let and = Template::parse("bool_and", "if ${lhs} { not(not(${rhs})) } else { false }")?;
assert_eq!(and.hole(0), Some(("lhs", HoleKind::Expr, false)));
assert_eq!(and.hole(1), Some(("rhs", HoleKind::Expr, false)));
// `++$i`, with the place evaluated once.
let inc = Template::parse("pre_increment", "let_place p = ${place} in p = add(p, 1)")?;
assert_eq!(inc.hole_count(), 1);Sourcepub fn desugar(self) -> Self
pub fn desugar(self) -> Self
Records Desugar expansions instead of Template ones (LSF2’s
{ text = …, desugar = true }), so tools can re-sugar the output.
§Examples
use hir_lang::ExpnKind;
use lower_lang::Template;
let t = Template::parse("echo", "extern:mox.echo(${...values})")?.desugar();
assert_eq!(t.expansion_kind(), ExpnKind::Desugar);Sourcepub fn hole_index(&self, name: &str) -> Option<usize>
pub fn hole_index(&self, name: &str) -> Option<usize>
The index of the hole named name, for binding node fields to holes
by name (LSF2: a hole missing from holes takes the node’s field of
the same name).
§Examples
use lower_lang::Template;
let t = Template::parse("new_object", "extern:mox.new(${class}, ${...args})")?;
assert_eq!(t.hole_index("args"), Some(1));
assert_eq!(t.hole_index("nope"), None);