fmtparse 0.2.0

#![warn(rust_2018_idioms, unreachable_pub)]
#![forbid(elided_lifetimes_in_paths, unsafe_code)]

#[cfg(test)]
mod tests;

use chumsky::{
	prelude::*,
	text::{self, whitespace}
};
use std::{fmt::Debug, iter, str::FromStr};

type PError = Simple<char>;

/// A parser for an unsigned integer.
fn uint<T>(radix: u32) -> impl Parser<char, T, Error = PError> + Clone
where
	T: FromStr,
	T::Err: Debug
{
	text::int(radix).map(|s: String| s.parse().unwrap())
}

fn is_relaxed(ch: &char) -> bool {
	!ch.is_whitespace() && !ch.is_control() && *ch != ':' && *ch != '{' && *ch != '}'
}

/// A parser for an identifier. This can be either chumsky's `text::ident` parser which
/// parses any C-style identifier, or a relaxed identifier.
///
/// A relaxed identifier doesn't start with a numeric character and contains any
/// characters that are
///  - not control chars
///  - not a whitespace
///  - not a colon (`:`)
///  - no braces (`{` or `}`)
fn ident(relaxed: bool) -> impl Parser<char, String, Error = PError> + Clone {
	if relaxed {
		filter(|ch: &char| is_relaxed(ch) && !ch.is_numeric())
			.then(filter(is_relaxed).repeated())
			.map(|(first, chars)| iter::once(first).chain(chars.into_iter()).collect())
			.boxed()
	} else {
		text::ident().boxed()
	}
}

/// A variable name. This can be one of these 3 cases:
///
///  - `{}` is [`VarName::None`]
///  - `{1}` is [`VarName::Index(1)`]
///  - `{foo}` is [`VarName::Ident("foo")`]
#[derive(Debug, Eq, PartialEq)]
pub enum VarName {
	None,
	Index(usize),
	Ident(String)
}

impl VarName {
	fn parser(relaxed: bool) -> impl Parser<char, Self, Error = PError> + Clone {
		choice((
			uint(10).map(Self::Index),
			ident(relaxed).map(Self::Ident),
			empty().map(|_| Self::None)
		))
	}
}

/// A parameter to an option. Can be either a constant or dependent on a variable.
#[derive(Debug, Eq, PartialEq)]
pub enum Param {
	Const(usize),
	Dynamic(VarName)
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Align {
	Left,
	Center,
	Right
}

impl Align {
	fn parser() -> impl Parser<char, Self, Error = PError> + Clone {
		choice((
			just("<").map(|_| Self::Left),
			just("^").map(|_| Self::Center),
			just(">").map(|_| Self::Right),
			empty().map(|_| Self::Left)
		))
		.debug("Align Parser")
	}
}

#[derive(Debug, Eq, PartialEq)]
pub enum Padding {
	/// Padding with zeroes. Usually for numbers.
	ZeroPadding { width: usize },

	/// Padding a custom char. Using spaces by default.
	TextPadding {
		ch: char,
		align: Align,
		width: Param
	}
}

impl Padding {
	fn zero_padding_parser() -> impl Parser<char, Self, Error = PError> + Clone {
		just("0")
			.ignore_then(uint(10))
			.map(|width| Self::ZeroPadding { width })
			.debug("Padding::ZeroPadding Parser")
	}

	fn text_padding_parser() -> impl Parser<char, Self, Error = PError> + Clone {
		let width_parser = choice((
			uint(10)
				.then_ignore(just("$"))
				.map(|idx| Param::Dynamic(VarName::Index(idx))),
			ident(false)
				.then_ignore(just("$"))
				.map(|name| Param::Dynamic(VarName::Ident(name))),
			uint(10).map(Param::Const)
		));

		// we need two parsers here, otherwise the any() would parse the token that
		// specifies the alignment if only the alignment is specified
		choice((
			empty()
				.map(|_| ' ')
				.then(Align::parser())
				.then(width_parser.clone()),
			any().then(Align::parser()).then(width_parser)
		))
		.map(|((ch, align), width)| Self::TextPadding { ch, align, width })
		.debug("Padding::TextPadding Parser")
	}
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Style {
	Display,
	Debug,
	LowerHex,
	UpperHex,
	Binary,
	Octal
}

impl Style {
	fn parser() -> impl Parser<char, Self, Error = PError> + Clone {
		choice((
			just("?").map(|_| Self::Debug),
			just("x").map(|_| Self::LowerHex),
			just("X").map(|_| Self::UpperHex),
			just("b").map(|_| Self::Binary),
			just("o").map(|_| Self::Octal),
			empty().map(|_| Self::Display)
		))
	}
}

#[derive(Debug, Eq, PartialEq)]
pub enum Token {
	/// A text token. Double braces (`{{` and `}}`) have already been converted to single
	/// braces.
	Text(String),

	/// A variable/placeholder.
	Variable {
		/// The name of the variable. Can be empty, an index, or an ident.
		name: VarName,

		/// The padding/fill/alignment of the variable.
		padding: Option<Padding>,
		/// The precision of the argument.
		precision: Option<Param>,

		/// The style of the variable.
		style: Style,
		/// Whether to use pretty printing (`{:#}`).
		pretty: bool,
		/// Whether to print signs (`{:+}`).
		sign: bool
	}
}

impl Token {
	fn parser(relaxed: bool) -> impl Parser<char, Self, Error = PError> + Clone {
		// a parser that parses text occurences and unescapes {{ and }} while parsing
		let text_parser = none_of("{}")
			.or(just("{{").map(|_| '{'))
			.or(just("}}").map(|_| '}'))
			.repeated()
			.at_least(1)
			.map(|text| Self::Text(text.into_iter().collect()));

		// a parser that parses simple variables consisting only of braces and name
		let simple_var_parser = just("{")
			.ignore_then(VarName::parser(relaxed))
			.then_ignore(whitespace())
			.then_ignore(just("}"))
			.map(|name| Self::Variable {
				name,
				padding: None,
				precision: None,
				style: Style::Display,
				pretty: false,
				sign: false
			});

		// a parser that parses the precision option of variables
		let precision_parser = just(".")
			.ignore_then(choice((
				uint(10)
					.then_ignore(just("$"))
					.map(|idx| Param::Dynamic(VarName::Index(idx))),
				ident(false)
					.then_ignore(just("$"))
					.map(|ident| Param::Dynamic(VarName::Ident(ident))),
				just("*").map(|_| Param::Dynamic(VarName::None)),
				uint(10).map(Param::Const)
			)))
			.map(Some)
			.or(empty().map(|_| None));

		// a parser for variables that might have text padding but no zero padding
		let text_padding_parser = just("{")
			.ignore_then(VarName::parser(relaxed))
			.then_ignore(just(":"))
			.then(
				Padding::text_padding_parser()
					.map(Some)
					.or(empty().map(|_| None))
			)
			.then(just("+").map(|_| true).or(empty().map(|_| false)))
			.then(just("#").map(|_| true).or(empty().map(|_| false)))
			.then(precision_parser.clone())
			.then(Style::parser())
			.then_ignore(whitespace())
			.then_ignore(just("}"))
			.map(|(((((name, padding), sign), pretty), precision), style)| {
				Self::Variable {
					name,
					padding,
					precision,
					style,
					pretty,
					sign
				}
			});

		// a parser for variables that might have zero padding but no text padding
		let zero_padding_parser = just("{")
			.ignore_then(VarName::parser(relaxed))
			.then_ignore(just(":"))
			.then(just("+").map(|_| true).or(empty().map(|_| false)))
			.then(just("#").map(|_| true).or(empty().map(|_| false)))
			.then(
				Padding::zero_padding_parser()
					.map(Some)
					.or(empty().map(|_| None))
			)
			.then(precision_parser)
			.then(Style::parser())
			.then_ignore(whitespace())
			.then_ignore(just("}"))
			.map(|(((((name, sign), pretty), padding), precision), style)| {
				Self::Variable {
					name,
					padding,
					precision,
					style,
					pretty,
					sign
				}
			});

		choice((
			text_parser,
			simple_var_parser,
			text_padding_parser,
			zero_padding_parser
		))
	}
}

pub type Error = Vec<PError>;

/// Parse a format string. This should mimic the behaviour of Rust. All deviations (both
/// inputs accepted by Rust but not this function and vice versa) are considered bugs.
pub fn parse(input: &str) -> Result<Vec<Token>, Error> {
	Token::parser(false)
		.repeated()
		.then_ignore(end())
		.parse(input)
}

/// Parse a format string with relaxed idents. Only the initial identifier of a variable
/// is relaxed,
///
/// A relaxed identifier doesn't start with a numeric character and contains any
/// characters that are
///  - not control chars
///  - not a whitespace
///  - not a colon (`:`)
///  - no braces (`{` or `}`)
pub fn parse_relaxed(input: &str) -> Result<Vec<Token>, Error> {
	Token::parser(true)
		.repeated()
		.then_ignore(end())
		.parse(input)
}