Lines
92.11 %
Functions
100 %
Branches
/*
* Hurl (https://hurl.dev)
* Copyright (C) 2026 Orange
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::ast::{SourceInfo, Template};
use crate::combinator::one_or_more;
use crate::reader::Reader;
use super::error::{ParseError, ParseErrorKind};
use super::primitives::{hex_digit, literal, try_literal};
use super::{ParseResult, template};
/// Steps:
/// 1- parse String until end of stream, end of line
/// the string does not contain trailing space
/// 2- templatize
pub fn unquoted_template(reader: &mut Reader) -> ParseResult<Template> {
let start = reader.cursor();
let mut chars = vec![];
let mut spaces = vec![];
let mut end = start;
loop {
let pos = reader.cursor().pos;
match any_char(&['#'], reader) {
Err(e) => {
if e.recoverable {
break;
} else {
return Err(e);
}
Ok((c, s)) => {
if s == "\n" {
if s == " " {
spaces.push((c, s, pos));
if !spaces.is_empty() {
chars.append(&mut spaces);
spaces = vec![];
chars.push((c, s, pos));
end = reader.cursor();
reader.seek(end);
let encoded_string = template::EncodedString {
source_info: SourceInfo::new(start.pos, end.pos),
chars,
};
let elements = template::templatize(encoded_string)?;
let template = Template::new(None, elements, SourceInfo::new(start.pos, end.pos));
Ok(template)
// TODO: should return an EncodedString
// (decoding escape sequence)
pub fn quoted_oneline_string(reader: &mut Reader) -> ParseResult<String> {
literal("\"", reader)?;
let s = reader.read_while(|c| c != '"' && c != '\n');
Ok(s)
pub fn quoted_template(reader: &mut Reader) -> ParseResult<Template> {
try_literal("\"", reader)?;
let save = reader.cursor();
match any_char(&['"'], reader) {
reader.seek(save);
let template = Template::new(
Some('"'),
elements,
SourceInfo::new(start.pos, reader.cursor().pos),
);
pub fn backtick_template(reader: &mut Reader) -> ParseResult<Template> {
let delimiter = Some('`');
try_literal("`", reader)?;
match any_char(&['`', '\n'], reader) {
literal("`", reader)?;
delimiter,
fn any_char(except: &[char], reader: &mut Reader) -> ParseResult<(char, String)> {
match escape_char(reader) {
Ok(c) => Ok((c, reader.read_from(start.index))),
reader.seek(start);
match reader.read() {
None => {
let kind = ParseErrorKind::Expecting {
value: "char".to_string(),
Err(ParseError::new(start.pos, true, kind))
Some(c) => {
if except.contains(&c)
|| ['\\', '\x08', '\n', '\x0c', '\r', '\t'].contains(&c)
{
Ok((c, reader.read_from(start.index)))
Err(e)
pub fn escape_char(reader: &mut Reader) -> ParseResult<char> {
try_literal("\\", reader)?;
Some('#') => Ok('#'),
Some('"') => Ok('"'),
Some('`') => Ok('`'),
Some('\\') => Ok('\\'),
Some('/') => Ok('/'),
Some('b') => Ok('\x08'),
Some('n') => Ok('\n'),
Some('f') => Ok('\x0c'),
Some('r') => Ok('\r'),
Some('t') => Ok('\t'),
Some('u') => unicode(reader),
_ => Err(ParseError::new(
start.pos,
false,
ParseErrorKind::EscapeChar,
)),
pub(crate) fn unicode(reader: &mut Reader) -> ParseResult<char> {
literal("{", reader)?;
let v = hex_value(reader)?;
let c = match std::char::from_u32(v) {
return Err(ParseError::new(
reader.cursor().pos,
ParseErrorKind::Unicode,
));
Some(c) => c,
literal("}", reader)?;
Ok(c)
fn hex_value(reader: &mut Reader) -> ParseResult<u32> {
let mut digits = one_or_more(hex_digit, reader)?;
let mut v = 0;
let mut weight = 1;
digits.reverse();
for d in digits.iter() {
v += weight * d;
weight *= 16;
Ok(v)
#[cfg(test)]
mod tests {
use std::time::SystemTime;
use super::*;
use crate::ast::{Expr, ExprKind, Placeholder, TemplateElement, Variable, Whitespace};
use crate::reader::{CharPos, Pos};
use crate::types::ToSource;
#[test]
fn test_unquoted_template_empty() {
let mut reader = Reader::new("");
assert_eq!(
unquoted_template(&mut reader).unwrap(),
Template::new(
None,
vec![],
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 1)),
)
assert_eq!(reader.cursor().index, CharPos(0));
fn test_unquoted_template_with_hash() {
let mut reader = Reader::new("a#");
vec![TemplateElement::String {
value: "a".to_string(),
source: "a".to_source(),
}],
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 2))
assert_eq!(reader.cursor().index, CharPos(1));
fn test_unquoted_template_with_encoded_hash() {
let mut reader = Reader::new("a\\u{23}");
value: "a#".to_string(),
source: "a\\u{23}".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 8))
assert_eq!(reader.cursor().index, CharPos(7));
fn test_unquoted_template_with_quote() {
let mut reader = Reader::new("\"hi\"");
value: "\"hi\"".to_string(),
source: "\"hi\"".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 5))
assert_eq!(reader.cursor().index, CharPos(4));
fn test_unquoted_template_hello_world() {
let mut reader = Reader::new("hello\\u{20}{{name}}!");
vec![
TemplateElement::String {
value: "hello ".to_string(),
source: "hello\\u{20}".to_source(),
},
TemplateElement::Placeholder(Placeholder {
space0: Whitespace {
value: String::new(),
source_info: SourceInfo::new(Pos::new(1, 14), Pos::new(1, 14)),
expr: Expr {
kind: ExprKind::Variable(Variable {
name: "name".to_string(),
source_info: SourceInfo::new(Pos::new(1, 14), Pos::new(1, 18)),
}),
space1: Whitespace {
source_info: SourceInfo::new(Pos::new(1, 18), Pos::new(1, 18)),
value: "!".to_string(),
source: "!".to_source(),
],
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 21))
assert_eq!(reader.cursor().index, CharPos(20));
fn test_quoted_template() {
let mut reader = Reader::new("\"\"");
quoted_template(&mut reader).unwrap(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 3)),
assert_eq!(reader.cursor().index, CharPos(2));
let mut reader = Reader::new("\"a#\"");
source: "a#".to_source(),
let mut reader = Reader::new("\"{0}\"");
value: "{0}".to_string(),
source: "{0}".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 6))
assert_eq!(reader.cursor().index, CharPos(5));
fn test_quoted_template_with_quote() {
// "\"hi\""
let mut reader = Reader::new("\"\\\"hi\\\"\"");
source: "\\\"hi\\\"".to_source()
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 9))
assert_eq!(reader.cursor().index, CharPos(8));
fn test_quoted_template_error_missing_closing_quote() {
let mut reader = Reader::new("\"not found");
let error = quoted_template(&mut reader).err().unwrap();
error.pos,
Pos {
line: 1,
column: 11
assert!(!error.recoverable);
fn test_quoted_string() {
assert_eq!(quoted_oneline_string(&mut reader).unwrap(), "");
let mut reader = Reader::new("\"Hello\"");
assert_eq!(quoted_oneline_string(&mut reader).unwrap(), "Hello");
fn test_backtick_template() {
let mut reader = Reader::new("``");
backtick_template(&mut reader).unwrap(),
Some('`'),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 3))
let mut reader = Reader::new("`foo#`");
value: "foo#".to_string(),
source: "foo#".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 7))
assert_eq!(reader.cursor().index, CharPos(6));
let mut reader = Reader::new("`{0}`");
fn test_backtick_template_with_backtick() {
// `\`hi\``
let mut reader = Reader::new("`\\`hi\\``");
value: "`hi`".to_string(),
source: "\\`hi\\`".to_source()
fn test_backtick_template_error_missing_closing_backtick() {
let mut reader = Reader::new("`not found");
let error = backtick_template(&mut reader).err().unwrap();
fn test_any_char() {
let mut reader = Reader::new("a");
assert_eq!(any_char(&[], &mut reader).unwrap(), ('a', "a".to_string()));
let mut reader = Reader::new(" ");
assert_eq!(any_char(&[], &mut reader).unwrap(), (' ', " ".to_string()));
let mut reader = Reader::new("\\t");
any_char(&[], &mut reader).unwrap(),
('\t', "\\t".to_string())
let mut reader = Reader::new("#");
assert_eq!(any_char(&[], &mut reader).unwrap(), ('#', "#".to_string()));
fn test_any_char_quote() {
let mut reader = Reader::new("\\\"");
('"', "\\\"".to_string())
fn test_any_char_error() {
let error = any_char(&[], &mut reader).err().unwrap();
assert_eq!(error.pos, Pos { line: 1, column: 1 });
assert!(error.recoverable);
let error = any_char(&['#'], &mut reader).err().unwrap();
let mut reader = Reader::new("\t");
fn test_escape_char() {
let mut reader = Reader::new("\\n");
assert_eq!(escape_char(&mut reader).unwrap(), '\n');
let mut reader = Reader::new("\\u{0a}");
let mut reader = Reader::new("x");
let error = escape_char(&mut reader).err().unwrap();
error.kind,
ParseErrorKind::Expecting {
value: "\\".to_string()
fn test_unicode() {
let mut reader = Reader::new("{000a}");
assert_eq!(unicode(&mut reader).unwrap(), '\n');
let mut reader = Reader::new("{E9}");
assert_eq!(unicode(&mut reader).unwrap(), 'é');
fn test_hex_value() {
let mut reader = Reader::new("20x");
assert_eq!(hex_value(&mut reader).unwrap(), 32);
let error = hex_value(&mut reader).err().unwrap();
assert_eq!(error.kind, ParseErrorKind::HexDigit);
fn test_quoted_template_benchmark() {
// benchmark tests not in stable toolchain yet
// Simply log duration for the time-being
let mut reader = Reader::new(
format!(
"\"Hello World!\"{}",
(0..10_000_000).map(|_| "X").collect::<String>()
.as_str(),
let now = SystemTime::now();
assert!(quoted_template(&mut reader).is_ok());
assert_eq!(reader.cursor().index, CharPos(14));
eprintln!("duration= {}", now.elapsed().unwrap().as_nanos());