Enum saltwater::Definition

pub enum Definition {
    Object(Vec<Token>),
    Function {
        params: Vec<InternedStr>,
        body: Vec<Token>,
    },
}

A macro definition.

Variants

Object(Vec<Token>)

An object macro: #define a b + 1

Function

A function macro: #define f(a) a + 1

Fields of Function

params: Vec<InternedStr>

The function parameters.

In the example above, a is a function parameter. A macro may have 0 or more parameters. Variadic macros (__VA_ARGS__) are not yet implemented.

Note that function macros may be called with an empty replacement list for any parameter. For example, f() is valid and exapands to + 1. Similarly, for #define g(a, b) a + b, g(,) is valid and expands to +.

body: Vec<Token>

The body for a function macro.

The function body itself undergoes recursive macro replacement.

Trait Implementations

impl Clone for Definition

fn clone(&self) -> Definition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Definition

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

Formats the value using the given formatter.

impl From<Vec<Token>> for Definition

fn from(tokens: Vec<Token>) -> Definition

Performs the conversion.

impl PartialEq<Definition> for Definition

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Definition

impl<'_> TryFrom<&'_ str> for Definition

type Error = LexError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.