Lines
71.05 %
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, TemplateElement};
use crate::reader::Reader;
use crate::types::ToSource;
use super::error::{ParseError, ParseErrorKind};
use super::primitives::try_literal;
use super::{ParseResult, placeholder, string};
/// Parse a filename.
///
/// A few characters need to be escaped such as space
/// for example: file\ with\ space.txt
/// This is very similar to the behaviour in a standard shell.
pub fn parse(reader: &mut Reader) -> ParseResult<Template> {
let start = reader.cursor();
let mut elements = vec![];
loop {
match placeholder::parse(reader) {
Ok(placeholder) => {
let element = TemplateElement::Placeholder(placeholder);
elements.push(element);
}
Err(e) => {
if e.recoverable {
let value = filename_content(reader)?;
if value.is_empty() {
break;
let source = reader.read_from(start.index).to_source();
let element = TemplateElement::String { value, source };
} else {
return Err(e);
if elements.is_empty() {
let kind = ParseErrorKind::Filename;
return Err(ParseError::new(start.pos, false, kind));
if let Some(TemplateElement::String { source, .. }) = elements.first()
&& source.starts_with('[')
{
let kind = ParseErrorKind::Expecting {
value: "filename".to_string(),
};
let end = reader.cursor();
let template = Template::new(None, elements, SourceInfo::new(start.pos, end.pos));
Ok(template)
fn filename_content(reader: &mut Reader) -> ParseResult<String> {
let mut s = String::new();
match filename_escaped_char(reader) {
Ok(c) => {
s.push(c);
let s2 = filename_text(reader);
if s2.is_empty() {
s.push_str(&s2);
Ok(s)
fn filename_text(reader: &mut Reader) -> String {
let save = reader.cursor();
match reader.read() {
None => break,
Some(c) => {
if ['#', ';', '{', '}', ' ', '\n', '\r', '\\'].contains(&c) {
reader.seek(save);
s
fn filename_escaped_char(reader: &mut Reader) -> ParseResult<char> {
try_literal("\\", reader)?;
Some('\\') => Ok('\\'),
Some('b') => Ok('\x08'),
Some('f') => Ok('\x0c'),
Some('n') => Ok('\n'),
Some('r') => Ok('\r'),
Some('t') => Ok('\t'),
Some('#') => Ok('#'),
Some(';') => Ok(';'),
Some(' ') => Ok(' '),
Some('{') => Ok('{'),
Some('}') => Ok('}'),
Some('u') => string::unicode(reader),
_ => Err(ParseError::new(
start.pos,
false,
ParseErrorKind::EscapeChar,
)),
#[cfg(test)]
mod tests {
use super::*;
use crate::ast::{Expr, ExprKind, Placeholder, Variable, Whitespace};
use crate::reader::{CharPos, Pos};
#[test]
fn test_filename() {
let mut reader = Reader::new("data/data.bin");
assert_eq!(
parse(&mut reader).unwrap(),
Template::new(
None,
vec![TemplateElement::String {
value: "data/data.bin".to_string(),
source: "data/data.bin".to_source()
}],
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 14)),
)
);
assert_eq!(reader.cursor().index, CharPos(13));
let mut reader = Reader::new("data.bin");
value: "data.bin".to_string(),
source: "data.bin".to_source()
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 9)),
assert_eq!(reader.cursor().index, CharPos(8));
fn test_include_space() {
let mut reader = Reader::new("file\\ with\\ spaces");
value: "file with spaces".to_string(),
source: "file\\ with\\ spaces".to_source()
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 19)),
assert_eq!(reader.cursor().index, CharPos(18));
fn test_escaped_chars() {
let mut reader = Reader::new("filename\\{"); // to the possible escaped chars
value: "filename{".to_string(),
source: "filename\\{".to_source()
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 11))
assert_eq!(reader.cursor().index, CharPos(10));
fn test_filename_error() {
let mut reader = Reader::new("{");
let error = parse(&mut reader).err().unwrap();
assert_eq!(error.kind, ParseErrorKind::Filename);
assert_eq!(error.pos, Pos { line: 1, column: 1 });
let mut reader = Reader::new("\\:");
assert_eq!(error.kind, ParseErrorKind::EscapeChar);
assert_eq!(error.pos, Pos { line: 1, column: 2 });
fn test_filename_with_variables() {
let mut reader = Reader::new("foo_{{bar}}");
vec![
TemplateElement::String {
value: "foo_".to_string(),
source: "foo_".to_source(),
},
TemplateElement::Placeholder(Placeholder {
space0: Whitespace {
value: String::new(),
source_info: SourceInfo::new(Pos::new(1, 7), Pos::new(1, 7)),
expr: Expr {
kind: ExprKind::Variable(Variable {
name: "bar".to_string(),
source_info: SourceInfo::new(Pos::new(1, 7), Pos::new(1, 10)),
}),
space1: Whitespace {
source_info: SourceInfo::new(Pos::new(1, 10), Pos::new(1, 10)),
})
],
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 12)),
let mut reader = Reader::new("foo_{{bar}}_baz");
value: "_baz".to_string(),
source: "_baz".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 16)),
fn test_filename_with_crlf() {
let mut reader = Reader::new("foo\r\n");
value: "foo".to_string(),
source: "foo".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 4)),