Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add string interpolation parsing #670

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ members = [
"location",
"symbol",
"ast",
"interpolate",
"fir",
"flatten",
"name_resolve",
Expand All @@ -33,6 +34,7 @@ members = [
[dependencies]
ast = { path = "ast" }
ast-sanitizer = { path = "ast-sanitizer" }
interpolate = { path = "interpolate" }
fir = { path = "fir" }
debug-fir = { path = "debug-fir" }
flatten = { path = "flatten" }
Expand Down
15 changes: 15 additions & 0 deletions interpolate/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[package]
name = "interpolate"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
ast = { path = "../ast" }
error = { path = "../error" }
symbol = { path = "../symbol" }
location = { path = "../location" }
xparser = { path = "../xparser" }
nom = "7.0"
nom_locate = "4.0"
186 changes: 186 additions & 0 deletions interpolate/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
use ast::{Ast, Node, Value, Visitor};
use error::{ErrKind, Error};
use location::{Location, Source, SpanTuple};
use nom::multi::many0;
use xparser::{Error as ParseError, ParseInput, ParseResult};

use nom::character::complete::char;
use nom::{bytes::complete::take_until, combinator::opt};
use nom_locate::{position, LocatedSpan};

struct Ctx;

fn parse_expr(input: ParseInput) -> ParseResult<ParseInput, Ast> {
let (input, _) = char('{')(input)?;
let (input, expr) = xparser::expr(input)?;
let (input, _) = char('}')(input)?;

Ok((input, expr))
}

fn parse_str(input: ParseInput) -> ParseResult<ParseInput, ParseInput> {
// how to handle reaching the end of the string?
take_until("{")(input)
}

pub(crate) fn pos_to_loc(
input: ParseInput,
start: impl Into<Location>,
end: impl Into<Location>,
) -> SpanTuple {
SpanTuple::with_source_ref(input.extra, start.into(), end.into())
}

fn parse_inner(input: ParseInput) -> ParseResult<ParseInput, Ast> {
let (input, start) = position(input)?;
let (input, s) = opt(parse_str)(input)?;
let (input, end) = position(input)?;
if let Some(s) = s {
return Ok((
input,
Ast {
location: pos_to_loc(input, start, end),
node: Node::Constant(Value::Str(s.fragment().to_string())),
},
));
}

let (input, s) = opt(parse_expr)(input)?;
let (input, end) = position(input)?;
if let Some(expr) = s {
return Ok((input, expr));
}

let loc = pos_to_loc(input, start, end);

Error::new(ErrKind::Parsing)
.with_msg(format!("unexpected character in format string: {input}"))
.with_loc(Some(loc))

Check failure on line 58 in interpolate/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

mismatched types

error[E0308]: mismatched types --> interpolate/src/lib.rs:58:19 | 58 | .with_loc(Some(loc)) | -------- ^^^^^^^^^ expected `SpanTuple`, found `Option<SpanTuple>` | | | arguments to this method are incorrect | = note: expected struct `location::SpanTuple` found enum `std::option::Option<location::SpanTuple>` note: method defined here --> /home/runner/work/jinko/jinko/error/src/lib.rs:271:12 | 271 | pub fn with_loc(self, loc: SpanTuple) -> Error { | ^^^^^^^^
.emit();

Err(nom::Err::Error(ParseError))

Check failure on line 61 in interpolate/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

expected value, found enum `ParseError`

error[E0423]: expected value, found enum `ParseError` --> interpolate/src/lib.rs:61:25 | 61 | Err(nom::Err::Error(ParseError)) | ^^^^^^^^^^ | help: the following enum variants are available | 61 | Err(nom::Err::Error((ParseError::Incomplete(/* fields */)))) | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 61 | Err(nom::Err::Error((ParseError::Msg(/* fields */)))) | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 61 | Err(nom::Err::Error((ParseError::Mult(/* fields */)))) | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 61 | Err(nom::Err::Error((ParseError::Nom(/* fields */)))) | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
}

/// This function parses the following grammar: `double_quote ( .* ( '{' expr '}' )* )* double_quote`
fn parse_format_string(to_parse: &str) -> Result<Vec<Ast>, Error> {
let input = LocatedSpan::new_extra(to_parse, Source::Input(to_parse));

let res = many0(parse_inner)(input);

if let Ok((_, exprs)) = res {
Ok(exprs)
} else {
Err(Error::new(ErrKind::Parsing))
}
}

impl Visitor for Ctx {
fn visit_constant(&mut self, location: SpanTuple, value: Value) -> Result<Ast, Error> {
let s = match value {
Value::Str(s) => s,
any_const => {
return Ok(Ast {
location,
node: Node::Constant(any_const),
})
}
};

Error::new(ErrKind::Hint)
.with_loc(Some(location.clone()))

Check failure on line 90 in interpolate/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

mismatched types

error[E0308]: mismatched types --> interpolate/src/lib.rs:90:23 | 90 | .with_loc(Some(location.clone())) | -------- ^^^^^^^^^^^^^^^^^^^^^^ expected `SpanTuple`, found `Option<SpanTuple>` | | | arguments to this method are incorrect | = note: expected struct `location::SpanTuple` found enum `std::option::Option<location::SpanTuple>` note: method defined here --> /home/runner/work/jinko/jinko/error/src/lib.rs:271:12 | 271 | pub fn with_loc(self, loc: SpanTuple) -> Error { | ^^^^^^^^
.with_msg(format!("saw a string: {s}!"))
.emit_debug();

let exprs = parse_format_string(&s)?;
dbg!(exprs);

Ok(Ast {
location,
node: Node::Constant(Value::Str(s)),
})
}
}

pub trait Interpolator: Sized {
fn interpolate(self) -> Result<Self, Error>;
}

impl Interpolator for Ast {
fn interpolate(self) -> Result<Self, Error> {
Ctx.visit(self)
}
}

pub fn add(left: usize, right: usize) -> usize {
left + right
}

#[cfg(test)]
mod tests {
use super::*;
use ast::{Node::*, Operator, Value::*};

macro_rules! loc {
() => {
location::SpanTuple::with_source(
location::SourceOwned::Empty,
location::Location::new(1, 0),
location::Location::new(1, 0),
)
};
}

macro_rules! ast {
($n:expr) => {
Ast {
location: loc!(),
node: $n,
}
};
}

#[test]
fn parse_one() {
let s = "hello";

let expected = ast! {
Constant(Str(String::from("hello")))
};

assert_eq!(parse_format_string(s).unwrap()[0].node, expected.node)
}

#[test]
fn parse_one_expr() {
let s = "{15}";

let expected = ast! {
Constant(Integer(15))
};

assert_eq!(parse_format_string(s).unwrap()[0].node, expected.node)
}

#[test]
fn parse_one_expr_one_string() {
let s = "hello {15 + 4}";

let expected_s = ast! {
Constant(Str(String::from("hello ")))
};
let expected_expr = ast! {
BinaryOp(
Operator::Add,
Box::new(ast! {
Constant(Integer(15))
}),
Box::new(ast! {
Constant(Integer(4))
}),
)
};

assert_eq!(parse_format_string(s).unwrap()[0].node, expected_s.node);
assert_eq!(parse_format_string(s).unwrap()[1].node, expected_expr.node);
}
}
2 changes: 2 additions & 0 deletions interpreter/jinko.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use fire::instance::Instance;
use fire::Interpret;
use flatten::{FlattenAst, FlattenData};
use include_code::IncludeCode;
use interpolate::Interpolator;
use loop_desugar::DesugarLoops;
use name_resolve::NameResolve;

Expand Down Expand Up @@ -123,6 +124,7 @@ fn experimental_pipeline(input: &str, file: &Path) -> InteractResult {

let ast = x_try!(ast.desugar_loops());
let ast = x_try!(ast_sanitizer::only_while_loops(ast));
let ast = x_try!(ast.interpolate());

let ast = x_try!(ast.resolve_includes());
let ast = x_try!(ast_sanitizer::no_incl(ast));
Expand Down
3 changes: 3 additions & 0 deletions xparser/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
mod constructs;
mod tokens;

pub use constructs::*;
pub use tokens::*;

use ast::Ast;
use location::Source;

Expand Down
Loading