Skip to main content

Template

Struct Template 

Source
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

Source

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");
Source

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);
Source

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);
Source

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);
Source

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);
Source

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);
Source

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);

Trait Implementations§

Source§

impl Clone for Template

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Template

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Template

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Template

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.