1112 lines
37 KiB
Rust
1112 lines
37 KiB
Rust
//! This module handles parsing a `git-config` file. Generally speaking, you
|
|
//! want to use a higher abstraction such as [`GitConfig`] unless you have some
|
|
//! explicit reason to work with events instead.
|
|
//!
|
|
//! The general workflow for interacting with this is to use one of the
|
|
//! `parse_from_*` function variants. These will return a [`Parser`] on success,
|
|
//! which can be converted into an [`Event`] iterator. The [`Parser`] also has
|
|
//! additional methods for accessing leading comments or events by section.
|
|
//!
|
|
//! [`GitConfig`]: crate::config::GitConfig
|
|
|
|
use nom::bytes::complete::{escaped, tag, take_till, take_while};
|
|
use nom::character::complete::{char, none_of, one_of};
|
|
use nom::character::{is_newline, is_space};
|
|
use nom::combinator::{map, opt};
|
|
use nom::error::{Error as NomError, ErrorKind};
|
|
use nom::sequence::delimited;
|
|
use nom::IResult;
|
|
use nom::{branch::alt, multi::many0};
|
|
use std::{borrow::Cow, iter::FusedIterator};
|
|
|
|
/// Syntactic events that occurs in the config.
|
|
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
|
|
pub enum Event<'a> {
|
|
/// A comment with a comment tag and the comment itself. Note that the
|
|
/// comment itself may contain additional whitespace and comment markers
|
|
/// at the beginning.
|
|
Comment(ParsedComment<'a>),
|
|
/// A section header containing the section name and a subsection, if it
|
|
/// exists.
|
|
SectionHeader(ParsedSectionHeader<'a>),
|
|
/// A name to a value in a section.
|
|
Key(Cow<'a, str>),
|
|
/// A completed value. This may be any string, including the empty string,
|
|
/// if an implicit boolean value is used. Note that these values may contain
|
|
/// spaces and any special character. This value is also unprocessed, so it
|
|
/// it may contain double quotes that should be replaced.
|
|
Value(Cow<'a, str>),
|
|
/// Represents any token used to signify a new line character. On Unix
|
|
/// platforms, this is typically just `\n`, but can be any valid newline
|
|
/// sequence.
|
|
Newline(Cow<'a, str>),
|
|
/// Any value that isn't completed. This occurs when the value is continued
|
|
/// onto the next line. A Newline event is guaranteed after, followed by
|
|
/// either a ValueDone, a Whitespace, or another ValueNotDone.
|
|
ValueNotDone(Cow<'a, str>),
|
|
/// The last line of a value which was continued onto another line.
|
|
ValueDone(Cow<'a, str>),
|
|
/// A continuous section of insignificant whitespace. Values with internal
|
|
/// spaces will not be separated by this event.
|
|
Whitespace(Cow<'a, str>),
|
|
}
|
|
|
|
/// A parsed section containing the header and the section events.
|
|
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
|
|
pub struct ParsedSection<'a> {
|
|
/// The section name and subsection name, if any.
|
|
pub section_header: ParsedSectionHeader<'a>,
|
|
/// The syntactic events found in this section.
|
|
pub events: Vec<Event<'a>>,
|
|
}
|
|
|
|
/// A parsed section header, containing a name and optionally a subsection name.
|
|
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
|
|
pub struct ParsedSectionHeader<'a> {
|
|
/// The name of the header.
|
|
pub name: Cow<'a, str>,
|
|
/// The separator used to determine if the section contains a subsection.
|
|
/// This is either a period `.` or a string of whitespace. Note that
|
|
/// reconstruction of subsection format is dependent on this value. If this
|
|
/// is all whitespace, then the subsection name needs to be surrounded by
|
|
/// quotes to have perfect reconstruction.
|
|
pub separator: Option<Cow<'a, str>>,
|
|
/// The subsection name without quotes if any exist.
|
|
pub subsection_name: Option<Cow<'a, str>>,
|
|
}
|
|
|
|
/// A parsed comment event containing the comment marker and comment.
|
|
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
|
|
pub struct ParsedComment<'a> {
|
|
/// The comment marker used. This is either a semicolon or octothorpe.
|
|
pub comment_tag: char,
|
|
/// The parsed comment.
|
|
pub comment: Cow<'a, str>,
|
|
}
|
|
|
|
/// The various parsing failure reasons.
|
|
#[derive(PartialEq, Debug)]
|
|
pub enum ParserError<'a> {
|
|
/// A parsing error occurred.
|
|
InvalidInput(nom::Err<NomError<&'a str>>),
|
|
/// The config was successfully parsed, but we had extraneous data after the
|
|
/// config file.
|
|
ConfigHasExtraData(&'a str),
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
impl<'a> From<nom::Err<NomError<&'a str>>> for ParserError<'a> {
|
|
fn from(e: nom::Err<NomError<&'a str>>) -> Self {
|
|
Self::InvalidInput(e)
|
|
}
|
|
}
|
|
|
|
/// A zero-copy `git-config` file parser.
|
|
///
|
|
/// This is parser exposes low-level syntactic events from a `git-config` file.
|
|
/// Generally speaking, you'll want to use [`GitConfig`] as it wraps
|
|
/// around the parser to provide a higher-level abstraction to a `git-config`
|
|
/// file, including querying, modifying, and updating values.
|
|
///
|
|
/// This parser guarantees that the events emitted are sufficient to
|
|
/// reconstruct a `git-config` file identical to the source `git-config`.
|
|
///
|
|
/// # Differences between a `.ini` parser
|
|
///
|
|
/// While the `git-config` format closely resembles the [`.ini` file format],
|
|
/// there are subtle differences that make them incompatible. For one, the file
|
|
/// format is not well defined, and there exists no formal specification to
|
|
/// adhere to. Thus, attempting to use an `.ini` parser on a `git-config` file
|
|
/// may successfully parse invalid configuration files.
|
|
///
|
|
/// For concrete examples, some notable differences are:
|
|
/// - `git-config` sections permit subsections via either a quoted string
|
|
/// (`[some-section "subsection"]`) or via the deprecated dot notation
|
|
/// (`[some-section.subsection]`). Successful parsing these section names is not
|
|
/// well defined in typical `.ini` parsers. This parser will handle these cases
|
|
/// perfectly.
|
|
/// - Comment markers are not strictly defined either. This parser will always
|
|
/// and only handle a semicolon or octothorpe (also known as a hash or number
|
|
/// sign).
|
|
/// - Global properties may be allowed in `.ini` parsers, but is strictly
|
|
/// disallowed by this parser.
|
|
/// - Only `\t`, `\n`, `\b` `\\` are valid escape characters.
|
|
/// - Quoted and semi-quoted values will be parsed (but quotes will be included
|
|
/// in event outputs). An example of a semi-quoted value is `5"hello world"`,
|
|
/// which should be interpreted as `5hello world`.
|
|
/// - Line continuations via a `\` character is supported.
|
|
/// - Whitespace handling similarly follows the `git-config` specification as
|
|
/// closely as possible, where excess whitespace after a non-quoted value are
|
|
/// trimmed, and line continuations onto a new line with excess spaces are kept.
|
|
/// - Only equal signs (optionally padded by spaces) are valid name/value
|
|
/// delimiters.
|
|
///
|
|
/// Note that that things such as case-sensitivity or duplicate sections are
|
|
/// _not_ handled. This parser is a low level _syntactic_ interpreter (as a
|
|
/// parser should be), and higher level wrappers around this parser (which may
|
|
/// or may not be zero-copy) should handle _semantic_ values. This also means
|
|
/// that string-like values are not interpreted. For example, `hello"world"`
|
|
/// would be read at a high level as `helloworld` but this parser will return
|
|
/// the former instead, with the extra quotes. This is because it is not the
|
|
/// responsibility of the parser to interpret these values, and doing so would
|
|
/// necessarily require a copy, which this parser avoids.
|
|
///
|
|
/// # Trait Implementations
|
|
///
|
|
/// - This struct does _not_ implement [`FromStr`] due to lifetime
|
|
/// constraints implied on the required `from_str` method. Instead, it provides
|
|
/// [`Parser::from_str`].
|
|
///
|
|
/// # Idioms
|
|
///
|
|
/// If you do want to use this parser, there are some idioms that may help you
|
|
/// with interpreting sequences of events.
|
|
///
|
|
/// ## `Value` events do not immediately follow `Key` events
|
|
///
|
|
/// Consider the following `git-config` example:
|
|
///
|
|
/// ```text
|
|
/// [core]
|
|
/// autocrlf = input
|
|
/// ```
|
|
///
|
|
/// Because this parser guarantees perfect reconstruction, there are many
|
|
/// non-significant events that occur in addition to the ones you may expect:
|
|
///
|
|
/// ```
|
|
/// # use serde_git_config::parser::{Event, ParsedSectionHeader, parse_from_str};
|
|
/// # use std::borrow::Cow;
|
|
/// # let section_header = ParsedSectionHeader {
|
|
/// # name: Cow::Borrowed("core"),
|
|
/// # separator: None,
|
|
/// # subsection_name: None,
|
|
/// # };
|
|
/// # let section_data = "[core]\n autocrlf = input";
|
|
/// # assert_eq!(parse_from_str(section_data).unwrap().into_vec(), vec![
|
|
/// Event::SectionHeader(section_header),
|
|
/// Event::Newline(Cow::Borrowed("\n")),
|
|
/// Event::Whitespace(Cow::Borrowed(" ")),
|
|
/// Event::Key(Cow::Borrowed("autocrlf")),
|
|
/// Event::Whitespace(Cow::Borrowed(" ")),
|
|
/// Event::Whitespace(Cow::Borrowed(" ")),
|
|
/// Event::Value(Cow::Borrowed("input")),
|
|
/// # ]);
|
|
/// ```
|
|
///
|
|
/// Note the two whitespace events between the key and value pair! Those two
|
|
/// events actually refer to the whitespace between the name and value and the
|
|
/// equal sign. So if the config instead had `autocrlf=input`, those whitespace
|
|
/// events would no longer be present.
|
|
///
|
|
/// ## Quoted values are not unquoted
|
|
///
|
|
/// Consider the following `git-config` example:
|
|
///
|
|
/// ```text
|
|
/// [core]
|
|
/// autocrlf=true""
|
|
/// filemode=fa"lse"
|
|
/// ```
|
|
///
|
|
/// Both these events, when fully processed, should normally be `true` and
|
|
/// `false`. However, because this parser is zero-copy, we cannot process
|
|
/// partially quoted values, such as the `false` example. As a result, to
|
|
/// maintain consistency, the parser will just take all values as literals. The
|
|
/// relevant event stream emitted is thus emitted as:
|
|
///
|
|
/// ```
|
|
/// # use serde_git_config::parser::{Event, ParsedSectionHeader, parse_from_str};
|
|
/// # use std::borrow::Cow;
|
|
/// # let section_header = ParsedSectionHeader {
|
|
/// # name: Cow::Borrowed("core"),
|
|
/// # separator: None,
|
|
/// # subsection_name: None,
|
|
/// # };
|
|
/// # let section_data = "[core]\nautocrlf=true\"\"\nfilemode=fa\"lse\"";
|
|
/// # assert_eq!(parse_from_str(section_data).unwrap().into_vec(), vec![
|
|
/// Event::SectionHeader(section_header),
|
|
/// Event::Newline(Cow::Borrowed("\n")),
|
|
/// Event::Key(Cow::Borrowed("autocrlf")),
|
|
/// Event::Value(Cow::Borrowed(r#"true"""#)),
|
|
/// Event::Newline(Cow::Borrowed("\n")),
|
|
/// Event::Key(Cow::Borrowed("filemode")),
|
|
/// Event::Value(Cow::Borrowed(r#"fa"lse""#)),
|
|
/// # ]);
|
|
/// ```
|
|
///
|
|
/// ## Whitespace after line continuations are part of the value
|
|
///
|
|
/// Consider the following `git-config` example:
|
|
///
|
|
/// ```text
|
|
/// [some-section]
|
|
/// file=a\
|
|
/// c
|
|
/// ```
|
|
///
|
|
/// Because how `git-config` treats continuations, the whitespace preceding `c`
|
|
/// are in fact part of the value of `file`. The fully interpreted key/value
|
|
/// pair is actually `file=a c`. As a result, the parser will provide this
|
|
/// split value accordingly:
|
|
///
|
|
/// ```
|
|
/// # use serde_git_config::parser::{Event, ParsedSectionHeader, parse_from_str};
|
|
/// # use std::borrow::Cow;
|
|
/// # let section_header = ParsedSectionHeader {
|
|
/// # name: Cow::Borrowed("some-section"),
|
|
/// # separator: None,
|
|
/// # subsection_name: None,
|
|
/// # };
|
|
/// # let section_data = "[some-section]\nfile=a\\\n c";
|
|
/// # assert_eq!(parse_from_str(section_data).unwrap().into_vec(), vec![
|
|
/// Event::SectionHeader(section_header),
|
|
/// Event::Newline(Cow::Borrowed("\n")),
|
|
/// Event::Key(Cow::Borrowed("file")),
|
|
/// Event::ValueNotDone(Cow::Borrowed("a")),
|
|
/// Event::Newline(Cow::Borrowed("\n")),
|
|
/// Event::ValueDone(Cow::Borrowed(" c")),
|
|
/// # ]);
|
|
/// ```
|
|
///
|
|
/// [`GitConfig`]: crate::config::GitConfig
|
|
/// [`.ini` file format]: https://en.wikipedia.org/wiki/INI_file
|
|
/// [`git`'s documentation]: https://git-scm.com/docs/git-config#_configuration_file
|
|
/// [`FromStr`]: std::str::FromStr
|
|
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
|
|
pub struct Parser<'a> {
|
|
init_comments: Vec<ParsedComment<'a>>,
|
|
sections: Vec<ParsedSection<'a>>,
|
|
}
|
|
|
|
impl<'a> Parser<'a> {
|
|
/// Attempt to zero-copy parse the provided `&str`. On success, returns a
|
|
/// [`Parser`] that provides methods to accessing leading comments and sections
|
|
/// of a `git-config` file and can be converted into an iterator of [`Event`]
|
|
/// for higher level processing.
|
|
///
|
|
/// This function is identical to [`parse_from_str`].
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// Returns an error if the string provided is not a valid `git-config`.
|
|
/// This generally is due to either invalid names or if there's extraneous
|
|
/// data succeeding valid `git-config` data.
|
|
pub fn from_str(s: &'a str) -> Result<Self, ParserError> {
|
|
parse_from_str(s)
|
|
}
|
|
|
|
/// Returns the leading comments (any comments before a section) from the
|
|
/// parser. Consider [`Parser::take_leading_comments`] if you need an owned
|
|
/// copy only once. If that function was called, then this will always
|
|
/// return an empty slice.
|
|
pub fn leading_comments(&self) -> &[ParsedComment<'a>] {
|
|
&self.init_comments
|
|
}
|
|
|
|
/// Takes the leading comments (any comments before a section) from the
|
|
/// parser. Subsequent calls will return an empty vec. Consider
|
|
/// [`Parser::leading_comments`] if you only need a reference to the comments.
|
|
pub fn take_leading_comments(&mut self) -> Vec<ParsedComment<'a>> {
|
|
let mut to_return = vec![];
|
|
std::mem::swap(&mut self.init_comments, &mut to_return);
|
|
to_return
|
|
}
|
|
|
|
/// Returns the parsed sections from the parser. Consider
|
|
/// [`Parser::take_sections`] if you need an owned copy only once. If that
|
|
/// function was called, then this will always return an empty slice.
|
|
pub fn sections(&self) -> &[ParsedSection<'a>] {
|
|
&self.sections
|
|
}
|
|
|
|
/// Takes the parsed sections from the parser. Subsequent calls will return
|
|
/// an empty vec. Consider [`Parser::sections`] if you only need a reference
|
|
/// to the comments.
|
|
pub fn take_sections(&mut self) -> Vec<ParsedSection<'a>> {
|
|
let mut to_return = vec![];
|
|
std::mem::swap(&mut self.sections, &mut to_return);
|
|
to_return
|
|
}
|
|
|
|
/// Consumes the parser to produce a Vec of Events.
|
|
pub fn into_vec(self) -> Vec<Event<'a>> {
|
|
self.into_iter().collect()
|
|
}
|
|
|
|
/// Consumes the parser to produce an iterator of Events.
|
|
pub fn into_iter(self) -> impl Iterator<Item = Event<'a>> + FusedIterator {
|
|
let section_iter = self
|
|
.sections
|
|
.into_iter()
|
|
.map(|section| {
|
|
vec![Event::SectionHeader(section.section_header)]
|
|
.into_iter()
|
|
.chain(section.events)
|
|
})
|
|
.flatten();
|
|
self.init_comments
|
|
.into_iter()
|
|
.map(Event::Comment)
|
|
.chain(section_iter)
|
|
}
|
|
}
|
|
|
|
/// Attempt to zero-copy parse the provided `&str`. On success, returns a
|
|
/// [`Parser`] that provides methods to accessing leading comments and sections
|
|
/// of a `git-config` file and can be converted into an iterator of [`Event`]
|
|
/// for higher level processing.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// Returns an error if the string provided is not a valid `git-config`.
|
|
/// This generally is due to either invalid names or if there's extraneous
|
|
/// data succeeding valid `git-config` data.
|
|
pub fn parse_from_str(input: &str) -> Result<Parser<'_>, ParserError> {
|
|
let (i, comments) = many0(comment)(input)?;
|
|
let (i, sections) = many0(section)(i)?;
|
|
|
|
if !i.is_empty() {
|
|
return Err(ParserError::ConfigHasExtraData(i));
|
|
}
|
|
|
|
Ok(Parser {
|
|
init_comments: comments,
|
|
sections,
|
|
})
|
|
}
|
|
|
|
fn comment<'a>(i: &'a str) -> IResult<&'a str, ParsedComment<'a>> {
|
|
let (i, comment_tag) = one_of(";#")(i)?;
|
|
let (i, comment) = take_till(is_char_newline)(i)?;
|
|
Ok((
|
|
i,
|
|
ParsedComment {
|
|
comment_tag,
|
|
comment: Cow::Borrowed(comment),
|
|
},
|
|
))
|
|
}
|
|
|
|
fn section<'a>(i: &'a str) -> IResult<&'a str, ParsedSection<'a>> {
|
|
let (i, section_header) = section_header(i)?;
|
|
let (i, items) = many0(alt((
|
|
map(take_spaces, |space| {
|
|
vec![Event::Whitespace(Cow::Borrowed(space))]
|
|
}),
|
|
map(take_newline, |newline| {
|
|
vec![Event::Newline(Cow::Borrowed(newline))]
|
|
}),
|
|
map(section_body, |(key, values)| {
|
|
let mut vec = vec![Event::Key(Cow::Borrowed(key))];
|
|
vec.extend(values);
|
|
vec
|
|
}),
|
|
map(comment, |comment| vec![Event::Comment(comment)]),
|
|
)))(i)?;
|
|
Ok((
|
|
i,
|
|
ParsedSection {
|
|
section_header,
|
|
events: items.into_iter().flatten().collect(),
|
|
},
|
|
))
|
|
}
|
|
|
|
fn section_header<'a>(i: &'a str) -> IResult<&'a str, ParsedSectionHeader<'a>> {
|
|
let (i, _) = char('[')(i)?;
|
|
// No spaces must be between section name and section start
|
|
let (i, name) = take_while(|c: char| c.is_ascii_alphanumeric() || c == '-' || c == '.')(i)?;
|
|
|
|
if let Ok((i, _)) = char::<_, NomError<&str>>(']')(i) {
|
|
// Either section does not have a subsection or using deprecated
|
|
// subsection syntax at this point.
|
|
let header = match name.rfind('.') {
|
|
Some(index) => ParsedSectionHeader {
|
|
name: Cow::Borrowed(&name[..index]),
|
|
separator: name.get(index..index + 1).map(Cow::Borrowed),
|
|
subsection_name: name.get(index + 1..).map(Cow::Borrowed),
|
|
},
|
|
None => ParsedSectionHeader {
|
|
name: Cow::Borrowed(name),
|
|
separator: None,
|
|
subsection_name: None,
|
|
},
|
|
};
|
|
|
|
return Ok((i, header));
|
|
}
|
|
|
|
// Section header must be using modern subsection syntax at this point.
|
|
|
|
let (i, whitespace) = take_spaces(i)?;
|
|
|
|
let (i, subsection_name) = delimited(
|
|
char('"'),
|
|
opt(escaped(none_of("\"\\\n\0"), '\\', one_of(r#""\"#))),
|
|
tag("\"]"),
|
|
)(i)?;
|
|
|
|
Ok((
|
|
i,
|
|
ParsedSectionHeader {
|
|
name: Cow::Borrowed(name),
|
|
separator: Some(Cow::Borrowed(whitespace)),
|
|
// We know that there's some section name here, so if we get an
|
|
// empty vec here then we actually parsed an empty section name.
|
|
subsection_name: subsection_name.or(Some("")).map(Cow::Borrowed),
|
|
},
|
|
))
|
|
}
|
|
|
|
fn section_body<'a>(i: &'a str) -> IResult<&'a str, (&'a str, Vec<Event<'a>>)> {
|
|
// maybe need to check for [ here
|
|
let (i, name) = config_name(i)?;
|
|
let (i, whitespace) = opt(take_spaces)(i)?;
|
|
let (i, value) = config_value(i)?;
|
|
if let Some(whitespace) = whitespace {
|
|
let mut events = vec![Event::Whitespace(Cow::Borrowed(whitespace))];
|
|
events.extend(value);
|
|
Ok((i, (name, events)))
|
|
} else {
|
|
Ok((i, (name, value)))
|
|
}
|
|
}
|
|
|
|
/// Parses the config name of a config pair. Assumes the input has already been
|
|
/// trimmed of any leading whitespace.
|
|
fn config_name<'a>(i: &'a str) -> IResult<&'a str, &'a str> {
|
|
if i.is_empty() {
|
|
return Err(nom::Err::Error(NomError {
|
|
input: i,
|
|
code: ErrorKind::NonEmpty,
|
|
}));
|
|
}
|
|
|
|
if !i.chars().nth(0).unwrap().is_alphabetic() {
|
|
return Err(nom::Err::Error(NomError {
|
|
input: i,
|
|
code: ErrorKind::Alpha,
|
|
}));
|
|
}
|
|
|
|
take_while(|c: char| c.is_alphanumeric() || c == '-')(i)
|
|
}
|
|
|
|
fn config_value<'a>(i: &'a str) -> IResult<&'a str, Vec<Event<'a>>> {
|
|
if let (i, Some(_)) = opt(char('='))(i)? {
|
|
let (i, whitespace) = opt(take_spaces)(i)?;
|
|
let (i, values) = value_impl(i)?;
|
|
if let Some(whitespace) = whitespace {
|
|
let mut events = vec![Event::Whitespace(Cow::Borrowed(whitespace))];
|
|
events.extend(values);
|
|
Ok((i, events))
|
|
} else {
|
|
Ok((i, values))
|
|
}
|
|
} else {
|
|
Ok((i, vec![Event::Value(Cow::Borrowed(""))]))
|
|
}
|
|
}
|
|
|
|
fn value_impl<'a>(i: &'a str) -> IResult<&'a str, Vec<Event<'a>>> {
|
|
let mut events = vec![];
|
|
let mut parsed_index: usize = 0;
|
|
let mut offset: usize = 0;
|
|
|
|
let mut was_prev_char_escape_char = false;
|
|
// This is required to ignore comment markers if they're in a quote.
|
|
let mut is_in_quotes = false;
|
|
// Used to determine if we return a Value or Value{Not,}Done
|
|
let mut partial_value_found = false;
|
|
|
|
for (index, c) in i.as_bytes().iter().enumerate() {
|
|
if was_prev_char_escape_char {
|
|
was_prev_char_escape_char = false;
|
|
match c {
|
|
// We're escaping a newline, which means we've found a
|
|
// continuation.
|
|
b'\n' => {
|
|
partial_value_found = true;
|
|
events.push(Event::ValueNotDone(Cow::Borrowed(&i[offset..index - 1])));
|
|
events.push(Event::Newline(Cow::Borrowed(&i[index..index + 1])));
|
|
offset = index + 1;
|
|
parsed_index = 0;
|
|
}
|
|
b't' | b'\\' | b'n' | b'"' => (),
|
|
_ => {
|
|
return Err(nom::Err::Error(NomError {
|
|
input: i,
|
|
code: ErrorKind::Escaped,
|
|
}));
|
|
}
|
|
}
|
|
} else {
|
|
match c {
|
|
b'\n' => {
|
|
parsed_index = index;
|
|
break;
|
|
}
|
|
b';' | b'#' if !is_in_quotes => {
|
|
parsed_index = index;
|
|
break;
|
|
}
|
|
b'\\' => was_prev_char_escape_char = true,
|
|
b'"' => is_in_quotes = !is_in_quotes,
|
|
_ => {}
|
|
}
|
|
}
|
|
}
|
|
|
|
if parsed_index == 0 {
|
|
parsed_index = i.len();
|
|
}
|
|
|
|
// Handle incomplete escape
|
|
if was_prev_char_escape_char {
|
|
return Err(nom::Err::Error(NomError {
|
|
input: i,
|
|
code: ErrorKind::Escaped,
|
|
}));
|
|
}
|
|
|
|
// Handle incomplete quotes
|
|
if is_in_quotes {
|
|
return Err(nom::Err::Error(NomError {
|
|
input: i,
|
|
code: ErrorKind::Tag,
|
|
}));
|
|
}
|
|
|
|
let (i, remainder_value) = {
|
|
let mut new_index = parsed_index;
|
|
for index in (offset..parsed_index).rev() {
|
|
if !(i.as_bytes()[index] as char).is_whitespace() {
|
|
new_index = index + 1;
|
|
break;
|
|
}
|
|
}
|
|
(&i[new_index..], &i[offset..new_index])
|
|
};
|
|
|
|
if partial_value_found {
|
|
events.push(Event::ValueDone(Cow::Borrowed(remainder_value)));
|
|
} else {
|
|
events.push(Event::Value(Cow::Borrowed(remainder_value)));
|
|
}
|
|
|
|
Ok((i, events))
|
|
}
|
|
|
|
fn is_char_newline(c: char) -> bool {
|
|
c.is_ascii() && is_newline(c as u8)
|
|
}
|
|
|
|
fn take_spaces<'a>(i: &'a str) -> IResult<&'a str, &'a str> {
|
|
take_common(i, |c: char| c.is_ascii() && is_space(c as u8))
|
|
}
|
|
|
|
fn take_newline<'a>(i: &'a str) -> IResult<&'a str, &'a str> {
|
|
take_common(i, is_char_newline)
|
|
}
|
|
|
|
fn take_common<'a, F: Fn(char) -> bool>(i: &'a str, f: F) -> IResult<&'a str, &'a str> {
|
|
let (i, v) = take_while(f)(i)?;
|
|
if v.is_empty() {
|
|
Err(nom::Err::Error(NomError {
|
|
input: i,
|
|
code: ErrorKind::Eof,
|
|
}))
|
|
} else {
|
|
Ok((i, v))
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
fn fully_consumed<T>(t: T) -> (&'static str, T) {
|
|
("", t)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
fn gen_section_header(
|
|
name: &str,
|
|
subsection: impl Into<Option<(&'static str, &'static str)>>,
|
|
) -> ParsedSectionHeader<'_> {
|
|
let name = Cow::Borrowed(name);
|
|
if let Some((separator, subsection_name)) = subsection.into() {
|
|
ParsedSectionHeader {
|
|
name,
|
|
separator: Some(separator).map(Cow::Borrowed),
|
|
subsection_name: Some(subsection_name).map(Cow::Borrowed),
|
|
}
|
|
} else {
|
|
ParsedSectionHeader {
|
|
name,
|
|
separator: None,
|
|
subsection_name: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod comments {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn semicolon() {
|
|
assert_eq!(
|
|
comment("; this is a semicolon comment").unwrap(),
|
|
fully_consumed(ParsedComment {
|
|
comment_tag: ';',
|
|
comment: Cow::Borrowed(" this is a semicolon comment"),
|
|
})
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn octothorpe() {
|
|
assert_eq!(
|
|
comment("# this is an octothorpe comment").unwrap(),
|
|
fully_consumed(ParsedComment {
|
|
comment_tag: '#',
|
|
comment: Cow::Borrowed(" this is an octothorpe comment"),
|
|
})
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn multiple_markers() {
|
|
assert_eq!(
|
|
comment("###### this is an octothorpe comment").unwrap(),
|
|
fully_consumed(ParsedComment {
|
|
comment_tag: '#',
|
|
comment: Cow::Borrowed("##### this is an octothorpe comment"),
|
|
})
|
|
);
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod section_headers {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn no_subsection() {
|
|
assert_eq!(
|
|
section_header("[hello]").unwrap(),
|
|
fully_consumed(gen_section_header("hello", None)),
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn modern_subsection() {
|
|
assert_eq!(
|
|
section_header(r#"[hello "world"]"#).unwrap(),
|
|
fully_consumed(gen_section_header("hello", (" ", "world"))),
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn escaped_subsection() {
|
|
assert_eq!(
|
|
section_header(r#"[hello "foo\\bar\""]"#).unwrap(),
|
|
fully_consumed(gen_section_header("hello", (" ", r#"foo\\bar\""#))),
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn deprecated_subsection() {
|
|
assert_eq!(
|
|
section_header(r#"[hello.world]"#).unwrap(),
|
|
fully_consumed(gen_section_header("hello", (".", "world")))
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn empty_legacy_subsection_name() {
|
|
assert_eq!(
|
|
section_header(r#"[hello.]"#).unwrap(),
|
|
fully_consumed(gen_section_header("hello", (".", "")))
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn empty_modern_subsection_name() {
|
|
assert_eq!(
|
|
section_header(r#"[hello ""]"#).unwrap(),
|
|
fully_consumed(gen_section_header("hello", (" ", "")))
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn newline_in_header() {
|
|
assert!(section_header("[hello\n]").is_err())
|
|
}
|
|
|
|
#[test]
|
|
fn null_byte_in_header() {
|
|
assert!(section_header("[hello\0]").is_err())
|
|
}
|
|
|
|
#[test]
|
|
fn right_brace_in_subsection_name() {
|
|
assert_eq!(
|
|
section_header(r#"[hello "]"]"#).unwrap(),
|
|
fully_consumed(gen_section_header("hello", (" ", "]")))
|
|
);
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod config_name {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn just_name() {
|
|
assert_eq!(config_name("name").unwrap(), fully_consumed("name"));
|
|
}
|
|
|
|
#[test]
|
|
fn must_start_with_alphabetic() {
|
|
assert!(config_name("4aaa").is_err());
|
|
assert!(config_name("-aaa").is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn cannot_be_empty() {
|
|
assert!(config_name("").is_err())
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod value_no_continuation {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn no_comment() {
|
|
assert_eq!(
|
|
value_impl("hello").unwrap(),
|
|
fully_consumed(vec![Event::Value(Cow::Borrowed("hello"))])
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn no_comment_newline() {
|
|
assert_eq!(
|
|
value_impl("hello\na").unwrap(),
|
|
("\na", vec![Event::Value(Cow::Borrowed("hello"))])
|
|
)
|
|
}
|
|
|
|
#[test]
|
|
fn semicolon_comment_not_consumed() {
|
|
assert_eq!(
|
|
value_impl("hello;world").unwrap(),
|
|
(";world", vec![Event::Value(Cow::Borrowed("hello")),])
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn octothorpe_comment_not_consumed() {
|
|
assert_eq!(
|
|
value_impl("hello#world").unwrap(),
|
|
("#world", vec![Event::Value(Cow::Borrowed("hello")),])
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn values_with_extraneous_whitespace_without_comment() {
|
|
assert_eq!(
|
|
value_impl("hello ").unwrap(),
|
|
(
|
|
" ",
|
|
vec![Event::Value(Cow::Borrowed("hello"))]
|
|
)
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn values_with_extraneous_whitespace_before_comment() {
|
|
assert_eq!(
|
|
value_impl("hello #world").unwrap(),
|
|
(
|
|
" #world",
|
|
vec![Event::Value(Cow::Borrowed("hello"))]
|
|
)
|
|
);
|
|
assert_eq!(
|
|
value_impl("hello ;world").unwrap(),
|
|
(
|
|
" ;world",
|
|
vec![Event::Value(Cow::Borrowed("hello"))]
|
|
)
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn trans_escaped_comment_marker_not_consumed() {
|
|
assert_eq!(
|
|
value_impl(r##"hello"#"world; a"##).unwrap(),
|
|
(
|
|
"; a",
|
|
vec![Event::Value(Cow::Borrowed(r##"hello"#"world"##))]
|
|
)
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn complex_test() {
|
|
assert_eq!(
|
|
value_impl(r#"value";";ahhhh"#).unwrap(),
|
|
(";ahhhh", vec![Event::Value(Cow::Borrowed(r#"value";""#))])
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn garbage_after_continution_is_err() {
|
|
assert!(value_impl("hello \\afwjdls").is_err());
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod value_continuation {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn simple_continuation() {
|
|
assert_eq!(
|
|
value_impl("hello\\\nworld").unwrap(),
|
|
fully_consumed(vec![
|
|
Event::ValueNotDone(Cow::Borrowed("hello")),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::ValueDone(Cow::Borrowed("world"))
|
|
])
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn continuation_with_whitespace() {
|
|
assert_eq!(
|
|
value_impl("hello\\\n world").unwrap(),
|
|
fully_consumed(vec![
|
|
Event::ValueNotDone(Cow::Borrowed("hello")),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::ValueDone(Cow::Borrowed(" world"))
|
|
])
|
|
)
|
|
}
|
|
|
|
#[test]
|
|
fn complex_continuation_with_leftover_comment() {
|
|
assert_eq!(
|
|
value_impl("1 \"\\\"\\\na ; e \"\\\"\\\nd # \"b\t ; c").unwrap(),
|
|
(
|
|
" # \"b\t ; c",
|
|
vec![
|
|
Event::ValueNotDone(Cow::Borrowed(r#"1 "\""#)),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::ValueNotDone(Cow::Borrowed(r#"a ; e "\""#)),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::ValueDone(Cow::Borrowed("d")),
|
|
]
|
|
)
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn quote_split_over_two_lines_with_leftover_comment() {
|
|
assert_eq!(
|
|
value_impl("\"\\\n;\";a").unwrap(),
|
|
(
|
|
";a",
|
|
vec![
|
|
Event::ValueNotDone(Cow::Borrowed("\"")),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::ValueDone(Cow::Borrowed(";\"")),
|
|
]
|
|
)
|
|
)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod section {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn empty_section() {
|
|
assert_eq!(
|
|
section("[test]").unwrap(),
|
|
fully_consumed(ParsedSection {
|
|
section_header: gen_section_header("test", None),
|
|
events: vec![]
|
|
})
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn simple_section() {
|
|
let section_data = r#"[hello]
|
|
a = b
|
|
c
|
|
d = "lol""#;
|
|
assert_eq!(
|
|
section(section_data).unwrap(),
|
|
fully_consumed(ParsedSection {
|
|
section_header: gen_section_header("hello", None),
|
|
events: vec![
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Key(Cow::Borrowed("a")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Value(Cow::Borrowed("b")),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Key(Cow::Borrowed("c")),
|
|
Event::Value(Cow::Borrowed("")),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Key(Cow::Borrowed("d")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Value(Cow::Borrowed("\"lol\""))
|
|
]
|
|
})
|
|
)
|
|
}
|
|
|
|
#[test]
|
|
fn section_single_line() {
|
|
assert_eq!(
|
|
section("[hello] c").unwrap(),
|
|
fully_consumed(ParsedSection {
|
|
section_header: gen_section_header("hello", None),
|
|
events: vec![
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Key(Cow::Borrowed("c")),
|
|
Event::Value(Cow::Borrowed(""))
|
|
]
|
|
})
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn section_very_commented() {
|
|
let section_data = r#"[hello] ; commentA
|
|
a = b # commentB
|
|
; commentC
|
|
; commentD
|
|
c = d"#;
|
|
assert_eq!(
|
|
section(section_data).unwrap(),
|
|
fully_consumed(ParsedSection {
|
|
section_header: gen_section_header("hello", None),
|
|
events: vec![
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Comment(ParsedComment {
|
|
comment_tag: ';',
|
|
comment: Cow::Borrowed(" commentA"),
|
|
}),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Key(Cow::Borrowed("a")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Value(Cow::Borrowed("b")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Comment(ParsedComment {
|
|
comment_tag: '#',
|
|
comment: Cow::Borrowed(" commentB"),
|
|
}),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Comment(ParsedComment {
|
|
comment_tag: ';',
|
|
comment: Cow::Borrowed(" commentC"),
|
|
}),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Comment(ParsedComment {
|
|
comment_tag: ';',
|
|
comment: Cow::Borrowed(" commentD"),
|
|
}),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Key(Cow::Borrowed("c")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Value(Cow::Borrowed("d")),
|
|
]
|
|
})
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn complex_continuation() {
|
|
// This test is absolute hell. Good luck if this fails.
|
|
assert_eq!(
|
|
section("[section] a = 1 \"\\\"\\\na ; e \"\\\"\\\nd # \"b\t ; c").unwrap(),
|
|
fully_consumed(ParsedSection {
|
|
section_header: gen_section_header("section", None),
|
|
events: vec![
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Key(Cow::Borrowed("a")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::ValueNotDone(Cow::Borrowed(r#"1 "\""#)),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::ValueNotDone(Cow::Borrowed(r#"a ; e "\""#)),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::ValueDone(Cow::Borrowed("d")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Comment(ParsedComment {
|
|
comment_tag: '#',
|
|
comment: Cow::Borrowed(" \"b\t ; c")
|
|
})
|
|
]
|
|
})
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn quote_split_over_two_lines() {
|
|
assert_eq!(
|
|
section("[section \"a\"] b =\"\\\n;\";a").unwrap(),
|
|
fully_consumed(ParsedSection {
|
|
section_header: gen_section_header("section", (" ", "a")),
|
|
events: vec![
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Key(Cow::Borrowed("b")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::ValueNotDone(Cow::Borrowed("\"")),
|
|
Event::Newline(Cow::Borrowed("\n")),
|
|
Event::ValueDone(Cow::Borrowed(";\"")),
|
|
Event::Comment(ParsedComment {
|
|
comment_tag: ';',
|
|
comment: Cow::Borrowed("a"),
|
|
})
|
|
]
|
|
})
|
|
)
|
|
}
|
|
|
|
#[test]
|
|
fn section_handles_extranous_whitespace_before_comment() {
|
|
assert_eq!(
|
|
section("[s]hello #world").unwrap(),
|
|
fully_consumed(ParsedSection {
|
|
section_header: gen_section_header("s", None),
|
|
events: vec![
|
|
Event::Key(Cow::Borrowed("hello")),
|
|
Event::Whitespace(Cow::Borrowed(" ")),
|
|
Event::Value(Cow::Borrowed("")),
|
|
Event::Comment(ParsedComment {
|
|
comment_tag: '#',
|
|
comment: Cow::Borrowed("world"),
|
|
}),
|
|
]
|
|
})
|
|
);
|
|
}
|
|
}
|