From c73e26e2d6fa0cafb246e555b5bc2c229370edcf Mon Sep 17 00:00:00 2001 From: Tom Alexander Date: Sat, 22 Jul 2023 01:49:07 -0400 Subject: [PATCH 1/2] Create structure for statistics cookies. --- src/compare/diff.rs | 25 +++++++++++++++++++++++++ src/parser/mod.rs | 2 ++ src/parser/object.rs | 13 +++++++++++++ src/parser/statistics_cookie.rs | 13 +++++++++++++ src/parser/token.rs | 1 + 5 files changed, 54 insertions(+) create mode 100644 src/parser/statistics_cookie.rs diff --git a/src/compare/diff.rs b/src/compare/diff.rs index f16111d0..74cde67e 100644 --- a/src/compare/diff.rs +++ b/src/compare/diff.rs @@ -46,6 +46,7 @@ use crate::parser::RadioTarget; use crate::parser::RegularLink; use crate::parser::Section; use crate::parser::SrcBlock; +use crate::parser::StatisticsCookie; use crate::parser::StrikeThrough; use crate::parser::Table; use crate::parser::TableCell; @@ -174,6 +175,7 @@ fn compare_object<'s>( Object::InlineSourceBlock(obj) => compare_inline_source_block(source, emacs, obj), Object::LineBreak(obj) => compare_line_break(source, emacs, obj), Object::Target(obj) => compare_target(source, emacs, obj), + Object::StatisticsCookie(obj) => compare_statistics_cookie(source, emacs, obj), } } @@ -1488,3 +1490,26 @@ fn compare_target<'s>( children: Vec::new(), }) } + +fn compare_statistics_cookie<'s>( + source: &'s str, + emacs: &'s Token<'s>, + rust: &'s StatisticsCookie<'s>, +) -> Result> { + let mut this_status = DiffStatus::Good; + let emacs_name = "statistics-cookie"; + if assert_name(emacs, emacs_name).is_err() { + this_status = DiffStatus::Bad; + } + + if assert_bounds(source, emacs, rust).is_err() { + this_status = DiffStatus::Bad; + } + + Ok(DiffResult { + status: this_status, + name: emacs_name.to_owned(), + message: None, + children: Vec::new(), + }) +} diff --git a/src/parser/mod.rs b/src/parser/mod.rs index 16866063..3f0f2842 100644 --- a/src/parser/mod.rs +++ b/src/parser/mod.rs @@ -42,6 +42,7 @@ mod radio_link; mod regular_link; pub mod sexp; mod source; +mod statistics_cookie; mod table; mod target; mod text_markup; @@ -97,6 +98,7 @@ pub use object::PlainText; pub use object::RadioLink; pub use object::RadioTarget; pub use object::RegularLink; +pub use object::StatisticsCookie; pub use object::StrikeThrough; pub use object::Target; pub use object::Underline; diff --git a/src/parser/object.rs b/src/parser/object.rs index ea705a4d..300e038a 100644 --- a/src/parser/object.rs +++ b/src/parser/object.rs @@ -25,6 +25,7 @@ pub enum Object<'s> { InlineSourceBlock(InlineSourceBlock<'s>), LineBreak(LineBreak<'s>), Target(Target<'s>), + StatisticsCookie(StatisticsCookie<'s>), } #[derive(Debug, PartialEq)] @@ -161,6 +162,11 @@ pub struct Target<'s> { pub source: &'s str, } +#[derive(Debug, PartialEq)] +pub struct StatisticsCookie<'s> { + pub source: &'s str, +} + impl<'s> Source<'s> for Object<'s> { fn get_source(&'s self) -> &'s str { match self { @@ -187,6 +193,7 @@ impl<'s> Source<'s> for Object<'s> { Object::InlineSourceBlock(obj) => obj.source, Object::LineBreak(obj) => obj.source, Object::Target(obj) => obj.source, + Object::StatisticsCookie(obj) => obj.source, } } } @@ -322,3 +329,9 @@ impl<'s> Source<'s> for Target<'s> { self.source } } + +impl<'s> Source<'s> for StatisticsCookie<'s> { + fn get_source(&'s self) -> &'s str { + self.source + } +} diff --git a/src/parser/statistics_cookie.rs b/src/parser/statistics_cookie.rs new file mode 100644 index 00000000..43008a67 --- /dev/null +++ b/src/parser/statistics_cookie.rs @@ -0,0 +1,13 @@ +use super::Context; +use crate::error::Res; +use crate::parser::util::not_yet_implemented; +use crate::parser::StatisticsCookie; + +#[tracing::instrument(ret, level = "debug")] +pub fn statistics_cookie<'r, 's>( + context: Context<'r, 's>, + input: &'s str, +) -> Res<&'s str, StatisticsCookie<'s>> { + not_yet_implemented()?; + todo!() +} diff --git a/src/parser/token.rs b/src/parser/token.rs index f3ebe822..b9ea9dd9 100644 --- a/src/parser/token.rs +++ b/src/parser/token.rs @@ -64,6 +64,7 @@ impl<'r, 's> Token<'r, 's> { Object::InlineSourceBlock(_) => Box::new(std::iter::empty()), Object::LineBreak(_) => Box::new(std::iter::empty()), Object::Target(_) => Box::new(std::iter::empty()), + Object::StatisticsCookie(_) => Box::new(std::iter::empty()), }, Token::Element(elem) => match elem { Element::Paragraph(inner) => Box::new(inner.children.iter().map(Token::Object)), From b8b2e33137b56b09968d9733497a0f46fd7ac690 Mon Sep 17 00:00:00 2001 From: Tom Alexander Date: Sat, 22 Jul 2023 02:08:42 -0400 Subject: [PATCH 2/2] Implement the statistics cookie parser. --- org_mode_samples/statistics_cookie/simple.org | 3 ++ src/parser/object_parser.rs | 17 +++++++- src/parser/statistics_cookie.rs | 41 +++++++++++++++++-- 3 files changed, 56 insertions(+), 5 deletions(-) create mode 100644 org_mode_samples/statistics_cookie/simple.org diff --git a/org_mode_samples/statistics_cookie/simple.org b/org_mode_samples/statistics_cookie/simple.org new file mode 100644 index 00000000..77d522db --- /dev/null +++ b/org_mode_samples/statistics_cookie/simple.org @@ -0,0 +1,3 @@ +[70%] +[3/5] +[-3/5] diff --git a/src/parser/object_parser.rs b/src/parser/object_parser.rs index ce8c569a..549aea82 100644 --- a/src/parser/object_parser.rs +++ b/src/parser/object_parser.rs @@ -21,6 +21,7 @@ use crate::parser::org_macro::org_macro; use crate::parser::plain_link::plain_link; use crate::parser::radio_link::radio_link; use crate::parser::radio_link::radio_target; +use crate::parser::statistics_cookie::statistics_cookie; use crate::parser::target::target; use crate::parser::text_markup::text_markup; @@ -29,10 +30,14 @@ pub fn standard_set_object<'r, 's>( context: Context<'r, 's>, input: &'s str, ) -> Res<&'s str, Object<'s>> { - // TODO: line breaks, targets (different from radio targets), statistics cookies, subscript and superscript, timestamps. + // TODO: subscript and superscript, timestamps. not(|i| context.check_exit_matcher(i))(input)?; alt(( + map( + parser_with_context!(statistics_cookie)(context), + Object::StatisticsCookie, + ), map(parser_with_context!(target)(context), Object::Target), map(parser_with_context!(line_break)(context), Object::LineBreak), map( @@ -100,6 +105,10 @@ pub fn any_object_except_plain_text<'r, 's>( ) -> Res<&'s str, Object<'s>> { // Used for exit matchers so this does not check exit matcher condition. alt(( + map( + parser_with_context!(statistics_cookie)(context), + Object::StatisticsCookie, + ), map(parser_with_context!(target)(context), Object::Target), map(parser_with_context!(line_break)(context), Object::LineBreak), map( @@ -145,8 +154,12 @@ pub fn regular_link_description_object_set<'r, 's>( context: Context<'r, 's>, input: &'s str, ) -> Res<&'s str, Object<'s>> { - // TODO: minimal set of objects as well as export snippets, and statistics cookies. It can also contain another link, but only when it is a plain or angle link. It can contain square brackets, but not ]] + // TODO: add export snippets. It can also contain another link, but only when it is a plain or angle link. It can contain square brackets, but not ]] alt(( + map( + parser_with_context!(statistics_cookie)(context), + Object::StatisticsCookie, + ), map( parser_with_context!(inline_source_block)(context), Object::InlineSourceBlock, diff --git a/src/parser/statistics_cookie.rs b/src/parser/statistics_cookie.rs index 43008a67..536fa030 100644 --- a/src/parser/statistics_cookie.rs +++ b/src/parser/statistics_cookie.rs @@ -1,6 +1,12 @@ +use nom::branch::alt; +use nom::bytes::complete::tag; +use nom::character::complete::space0; +use nom::combinator::recognize; +use nom::sequence::tuple; + use super::Context; use crate::error::Res; -use crate::parser::util::not_yet_implemented; +use crate::parser::parser_with_context::parser_with_context; use crate::parser::StatisticsCookie; #[tracing::instrument(ret, level = "debug")] @@ -8,6 +14,35 @@ pub fn statistics_cookie<'r, 's>( context: Context<'r, 's>, input: &'s str, ) -> Res<&'s str, StatisticsCookie<'s>> { - not_yet_implemented()?; - todo!() + alt(( + parser_with_context!(percent_statistics_cookie)(context), + parser_with_context!(fraction_statistics_cookie)(context), + ))(input) +} + +#[tracing::instrument(ret, level = "debug")] +pub fn percent_statistics_cookie<'r, 's>( + context: Context<'r, 's>, + input: &'s str, +) -> Res<&'s str, StatisticsCookie<'s>> { + let (remaining, source) = + recognize(tuple((tag("["), nom::character::complete::u64, tag("%]"))))(input)?; + let (remaining, _) = space0(remaining)?; + Ok((remaining, StatisticsCookie { source })) +} + +#[tracing::instrument(ret, level = "debug")] +pub fn fraction_statistics_cookie<'r, 's>( + context: Context<'r, 's>, + input: &'s str, +) -> Res<&'s str, StatisticsCookie<'s>> { + let (remaining, source) = recognize(tuple(( + tag("["), + nom::character::complete::u64, + tag("/"), + nom::character::complete::u64, + tag("]"), + )))(input)?; + let (remaining, _) = space0(remaining)?; + Ok((remaining, StatisticsCookie { source })) }