Switch to using coalesce_whitespace_escaped for macro args.

Since I bothered to do the right thing and implement these as returning Cow so I can avoid unnecessary allocations, I figure I should move them to a util file so they can be re-used.

Makefile

@@ -46,6 +46,13 @@ dockertest:
 > $(MAKE) -C docker/organic_test
 > docker run --init --rm -i -t --read-only -v "$$(readlink -f ./):/source:ro" --mount type=tmpfs,destination=/tmp --mount source=cargo-cache,target=/usr/local/cargo/registry --mount source=rust-cache,target=/target --env CARGO_TARGET_DIR=/target -w /source organic-test --no-default-features --features compare --no-fail-fast --lib --test test_loader -- --test-threads $(TESTJOBS)
 
+.PHONY: buildtest
+buildtest:
+> cargo build --no-default-features
+> cargo build --no-default-features --features compare
+> cargo build --no-default-features --features tracing
+> cargo build --no-default-features --features compare,tracing
+
 .PHONY: foreign_document_test
 foreign_document_test:
 > $(MAKE) -C docker/organic_test run_foreign_document_test

org_mode_samples/affiliated_keyword/all_name.org

@@ -0,0 +1,17 @@
+#+name: foo
+: bar
+
+#+source: foo
+: bar
+
+#+tblname: foo
+: bar
+
+#+resname: foo
+: bar
+
+#+srcname: foo
+: bar
+
+#+label: foo
+: bar

org_mode_samples/affiliated_keyword/case_insensitive.org

@@ -0,0 +1,8 @@
+#+NAME: foo
+bar
+
+#+NaMe: baz
+cat
+
+#+name: lorem
+ipsum

org_mode_samples/affiliated_keyword/multiple_name.org

@@ -0,0 +1,6 @@
+#+name: foo
+#+source: bar
+#+name: baz
+#+tblname: lorem
+#+label: ipsum
+: dolar

org_mode_samples/affiliated_keyword/tblname_on_non_table.org

@@ -0,0 +1,2 @@
+#+tblname: foo
+: bar

org_mode_samples/greater_element/drawer/name.org

@@ -0,0 +1,10 @@
+* Headline
+before
+#+NAME: foo
+:candle:
+inside
+
+the drawer
+:end:
+
+after

org_mode_samples/greater_element/dynamic_block/name.org

@@ -0,0 +1,7 @@
+#+NAME: foo
+#+BEGIN: clocktable :scope file :maxlevel 2
+#+CAPTION: Clock summary at [2023-08-25 Fri 05:34]
+| Headline     | Time   |
+|--------------+--------|
+| *Total time* | *0:00* |
+#+END:

org_mode_samples/greater_element/greater_block/center/empty_with_name_inside.org

@@ -0,0 +1,8 @@
+#+begin_center
+
+#+end_center
+
+#+begin_center
+#+NAME: foo
+
+#+end_center

org_mode_samples/greater_element/greater_block/center/name.org

@@ -0,0 +1,4 @@
+#+NAME: foo
+#+begin_center
+
+#+end_center

org_mode_samples/greater_element/greater_block/quote/name.org

@@ -0,0 +1,4 @@
+#+NAME: foo
+#+begin_quote
+
+#+end_quote

org_mode_samples/greater_element/greater_block/special/name.org

@@ -0,0 +1,6 @@
+#+NAME: foo
+#+begin_defun
+foo
+
+{{{bar(baz)}}}
+#+end_defun

org_mode_samples/greater_element/plain_list/name.org

@@ -0,0 +1,2 @@
+#+NAME: foo
+1. bar

org_mode_samples/greater_element/table/name.org

@@ -0,0 +1,2 @@
+#+NAME: foo
+| foo | bar |

org_mode_samples/lesser_element/babel_call/empty.org

@@ -0,0 +1,3 @@
+#+call:
+
+#+call:    

org_mode_samples/lesser_element/babel_call/header_arguments.org

@@ -0,0 +1,3 @@
+#+call: foo[inside](bar="baz")[outside]
+
+#+call: foo[](bar="baz")[]

org_mode_samples/lesser_element/babel_call/name.org

@@ -1 +1,2 @@
+#+NAME: foo
 #+call: foo(bar="baz")

org_mode_samples/lesser_element/babel_call/nested_brackets.org

@@ -0,0 +1,7 @@
+#+call: foo[inside](bar="baz")[outside]
+
+#+call: foo[[inside]](bar="baz")[outside]
+
+#+call: foo[inside]((bar="baz"))[outside]
+
+#+call: foo[inside](bar="baz")[[outside]]

org_mode_samples/lesser_element/babel_call/no_closing_parenthesis.org

@@ -0,0 +1 @@
+#+call: foo(bar="baz"

org_mode_samples/lesser_element/babel_call/simple.org

@@ -0,0 +1,7 @@
+#+call: foo(bar="baz")
+
+#+call: lorem ipsum
+
+#+call: dolar cat(dog)
+
+#+call: (bat)

org_mode_samples/lesser_element/babel_call/spaces.org

@@ -0,0 +1,3 @@
+#+call: foo [inside] (bar="baz") [outside] 
+
+#+call: foo (bar="baz") [outside] 

org_mode_samples/lesser_element/clock/date_range_without_duration.org

@@ -0,0 +1 @@
+CLOCK: [2023-04-21 Fri 19:32]--[2023-04-21 Fri 19:35]

org_mode_samples/lesser_element/clock/name.org

@@ -0,0 +1,3 @@
+CLOCK: [2023-04-21 Fri 19:32]--[2023-04-21 Fri 19:35] =>  0:03
+#+NAME: foo
+CLOCK: [2023-04-21 Fri 19:43]

org_mode_samples/lesser_element/clock/non_range_with_duration.org

@@ -0,0 +1 @@
+CLOCK: [2023-04-21 Fri 19:43] =>  0:03

org_mode_samples/lesser_element/clock/time_range.org

@@ -0,0 +1,2 @@
+CLOCK: [1970-01-01 Thu 8:15-13:15otherrest +1w -1d] =>  0:03
+CLOCK: [1970-01-01 Thu 8:15-13:15otherrest +1w -1d]

org_mode_samples/lesser_element/comment/name.org

@@ -0,0 +1,2 @@
+#+NAME: foo
+# Comments cannot have affiliated keywords.

org_mode_samples/lesser_element/diary_sexp/name.org

@@ -0,0 +1,2 @@
+#+NAME: foo
+%%(foo)

org_mode_samples/lesser_element/fixed_width_area/name.org

@@ -0,0 +1,2 @@
+#+NAME: foo
+: bar

org_mode_samples/lesser_element/horizontal_rule/name.org

@@ -0,0 +1,2 @@
+#+NAME: foo
+-----

org_mode_samples/lesser_element/keyword/name.org

@@ -0,0 +1,2 @@
+#+NAME: foo
+#+FOO: BAR

org_mode_samples/lesser_element/latex_environment/name.org

@@ -0,0 +1,4 @@
+#+NAME: foo
+\begin{foo}
+bar
+\end{foo}

org_mode_samples/lesser_element/lesser_block/comment/escaped_lines.org

@@ -0,0 +1,10 @@
+#+begin_comment
+,* foo
+,,,** bar
+   ,*** baz
+    lorem
+    , ipsum
+,#+begin_src dolar
+
+,#+end_src
+#+end_comment

org_mode_samples/lesser_element/lesser_block/comment/name.org

@@ -0,0 +1,4 @@
+#+NAME: foo
+#+begin_comment text
+bar
+#+end_comment

org_mode_samples/lesser_element/lesser_block/comment/with_comma.org

@@ -0,0 +1,4 @@
+#+begin_comment
+This is a comment
+,* with an escaped line.
+#+end_comment

org_mode_samples/lesser_element/lesser_block/comment/with_switches.org

@@ -0,0 +1,3 @@
+#+begin_comment -n 20
+foo
+#+end_comment

org_mode_samples/lesser_element/lesser_block/example/escaped_lines.org

@@ -0,0 +1,10 @@
+#+begin_example
+,* foo
+,,,** bar
+   ,*** baz
+    lorem
+    , ipsum
+,#+begin_src dolar
+
+,#+end_src
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/exports_flag.org

@@ -0,0 +1,7 @@
+#+begin_example python :exports results
+print("foo")
+#+end_example
+
+#+begin_example python -n :exports results
+print("foo")
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/language_and_switches.org

@@ -0,0 +1,3 @@
+#+begin_example elisp -n 5
+foo
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/line_number_negative.org

@@ -0,0 +1,7 @@
+#+begin_example -n -10
+foo
+#+end_example
+
+#+begin_example +n -15
+bar
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/line_number_zero.org

@@ -0,0 +1,7 @@
+#+begin_example -n 0
+foo
+#+end_example
+
+#+begin_example +n 0
+bar
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/line_numbers.org

@@ -0,0 +1,8 @@
+#+begin_example -n 5
+foo
+#+end_example
+
+# Line numbering starts at 15 for the example below since it uses +n.
+#+begin_example +n 10
+bar
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/name.org

@@ -0,0 +1,4 @@
+#+NAME: foo
+#+begin_example text
+bar
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/only_k.org

@@ -0,0 +1,3 @@
+#+begin_example foo -k
+bar
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/parameters_without_colon.org

@@ -0,0 +1,3 @@
+#+begin_example foo -n bar -k baz
+
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/preserve_indent.org

@@ -0,0 +1,15 @@
+#+begin_example text -i
+     foo
+#+end_example
+
+#+begin_example text    -n -i
+     foo
+#+end_example
+
+#+begin_example text
+     foo
+#+end_example
+
+#+begin_example text    -n -r -k
+     foo
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/reference.org

@@ -0,0 +1,6 @@
+#+begin_example text
+  foo
+  bar (ref:here)
+  baz
+#+end_example
+Link to the reference: [[(here)]]

org_mode_samples/lesser_element/lesser_block/example/space_for_parameters.org

@@ -0,0 +1,2 @@
+#+begin_example 
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/switches_with_label.org

@@ -0,0 +1,15 @@
+#+BEGIN_EXAMPLE elisp -n -r -l "((%s))"
+   foo
+#+END_EXAMPLE
+
+#+BEGIN_EXAMPLE elisp -k -n -r -l "((%s))"
+   foo
+#+END_EXAMPLE
+
+#+BEGIN_EXAMPLE elisp -k 8 -n -r -l "((%s))"
+   foo
+#+END_EXAMPLE
+
+#+BEGIN_EXAMPLE elisp -n -r -k -l "((%s))"
+   foo
+#+END_EXAMPLE

org_mode_samples/lesser_element/lesser_block/example/switches_with_trailing_whitespace.org

@@ -0,0 +1,3 @@
+#+begin_example +n 10     
+foo
+#+end_example

org_mode_samples/lesser_element/lesser_block/export/escaped_lines.org

@@ -0,0 +1,10 @@
+#+begin_export html
+,* foo
+,,,** bar
+   ,*** baz
+    lorem
+    , ipsum
+,#+begin_src dolar
+
+,#+end_src
+#+end_export

org_mode_samples/lesser_element/lesser_block/export/name.org

@@ -0,0 +1,4 @@
+#+NAME: foo
+#+begin_export text
+bar
+#+end_export

org_mode_samples/lesser_element/lesser_block/export/one_word.org

@@ -0,0 +1,3 @@
+#+begin_export latex
+This would be LaTeX code.
+#+end_export

org_mode_samples/lesser_element/lesser_block/nested.org

@@ -0,0 +1,6 @@
+# Verse blocks are the only lesser blocks that contain objects
+#+begin_verse
+#+begin_comment
+This is a comment.
+#+end_comment
+#+end_verse

org_mode_samples/lesser_element/lesser_block/src/exports_flag.org

@@ -0,0 +1,7 @@
+#+begin_src python :exports results
+print("foo")
+#+end_src
+
+#+begin_src python -n :exports results
+print("foo")
+#+end_src

org_mode_samples/lesser_element/lesser_block/src/name.org

@@ -0,0 +1,4 @@
+#+NAME: foo
+#+begin_src text
+bar
+#+end_src

org_mode_samples/lesser_element/lesser_block/src/parameters_with_trailing_space.org

@@ -0,0 +1,7 @@
+#+begin_src python :exports results 
+print("foo")
+#+end_src
+
+#+begin_src python -n :exports results 
+print("foo")
+#+end_src

org_mode_samples/lesser_element/lesser_block/src/parameters_without_colon.org

@@ -0,0 +1,3 @@
+#+begin_src foo -n bar -k baz
+
+#+end_src

org_mode_samples/lesser_element/lesser_block/src/preserve_indent.org

@@ -0,0 +1,15 @@
+#+begin_src text -i
+     foo
+#+end_src
+
+#+begin_src text    -n -i
+     foo
+#+end_src
+
+#+begin_src text
+     foo
+#+end_src
+
+#+begin_src text    -n -r -k
+     foo
+#+end_src

org_mode_samples/lesser_element/lesser_block/src/reference.org

@@ -0,0 +1,6 @@
+#+begin_src text
+  foo
+  bar (ref:here)
+  baz
+#+end_src
+Link to the reference: [[(here)]]

org_mode_samples/lesser_element/lesser_block/verse/name.org

@@ -0,0 +1,4 @@
+#+NAME: foo
+#+begin_verse text
+bar
+#+end_verse

org_mode_samples/lesser_element/paragraph/name.org

@@ -0,0 +1,2 @@
+#+NAME: foo
+bar

org_mode_samples/object/angle_link/application.org

@@ -0,0 +1,2 @@
+<file+sys://foo>
+<file+emacs://foo>

org_mode_samples/object/angle_link/code_ref_link.org

@@ -0,0 +1,13 @@
+<(foo)>
+
+<((bar))>
+
+<((baz)>
+
+<(lo
+rem)>
+
+# These become fuzzy
+<(foo) >
+< (foo)>
+<(foo)::3>

org_mode_samples/object/angle_link/custom_id_link.org

@@ -0,0 +1,6 @@
+<#foo>
+
+<#fo
+o>
+
+<#foo::3>

org_mode_samples/object/angle_link/elisp.org

@@ -0,0 +1 @@
+<elisp:(local-set-key "\M-\x" 'foo-bar-baz)>

org_mode_samples/object/angle_link/file_link.org

@@ -0,0 +1,21 @@
+<./simple.org>
+<../simple.org>
+</simple.org>
+<file:simple.org>
+<file:sim  ple.org>
+
+<file:simp
+le.org>
+
+<file:simple.org::3>
+<file:simple.org::foo>
+<file:simple.org::#foo>
+<file:simple.org::foo  bar>
+<file:simple.org::foo
+bar>
+<file:simple.org::foo  
+bar>
+<file:simple.org::foo  
+  bar>
+<file:simple.org::foo::bar>
+<file:simple.org::/foo/>

org_mode_samples/object/angle_link/fuzzy_link.org

@@ -0,0 +1,6 @@
+<elisp.org>
+
+<eli
+sp.org>
+
+<elisp.org::3>

org_mode_samples/object/angle_link/id_link.org

@@ -0,0 +1,6 @@
+<id:83986bdf-987c-465d-8851-44cb4c02a86c>
+
+<id:83986bdf-987c-465d
+-8851-44cb4c02a86c>
+
+<id:83986bdf-987c-465d-8851-44cb4c02a86c::foo>

org_mode_samples/object/angle_link/multiple_slashes.org

@@ -0,0 +1,20 @@
+<file:foo>
+<file:/bar>
+<file://baz>
+<file:///lorem>
+<file:////ipsum>
+<file://///dolar>
+
+<foo>
+</bar>
+<//baz>
+<///lorem>
+<////ipsum>
+</////dolar>
+
+<https:foo>
+<https:/bar>
+<https://baz>
+<https:///lorem>
+<https:////ipsum>
+<https://///dolar>

org_mode_samples/object/angle_link/protocol_link.org

@@ -0,0 +1,6 @@
+<shell:foo>
+
+<shell:fo
+o>
+
+<shell:foo::3>

org_mode_samples/object/angle_link/search_option.org

@@ -0,0 +1,16 @@
+<file:simple.org::foo>
+
+<file:simple.org::#foo>
+<file:simple.org::foo  bar>
+<file:simple.org::foo
+bar>
+<file:simple.org::foo::bar>
+<file:simple.org::/foo/>
+
+<file://en.wikipedia.org/wiki/Shebang_(Uni::x)>
+
+
+<file:simple.org::*>
+<file:simple.org::* foo>
+<file:simple.org::*bar>
+<file:simple.org::b*az>

org_mode_samples/object/angle_link/simple.org

@@ -0,0 +1 @@
+<https://fizz.buzz/>

org_mode_samples/object/angle_link/template.org

@@ -0,0 +1,6 @@
+#+LINK:       foo https://foo.bar/baz#%s
+<foo::lorem>
+
+<cat::bat>
+#+LINK:       cat dog%s
+<cat:bat>

org_mode_samples/object/angle_link/with_parenthesis.org

@@ -0,0 +1 @@
+<https://en.wikipedia.org/wiki/Shebang_(Unix)>

org_mode_samples/object/macro/escape.org

@@ -0,0 +1,7 @@
+{{{foo}}}
+
+{{{fo\o}}}
+
+{{{foo(b\ar)}}}
+
+{{{foo(b\,r)}}}

org_mode_samples/object/macro/whitespace_in_args.org

@@ -0,0 +1,4 @@
+{{{foo(bar  baz)}}}
+
+{{{foo(bar
+baz)}}}

org_mode_samples/object/plain_link/all_default_links_with_search_option.org

@@ -0,0 +1,25 @@
+non-link text::foo
+eww://foo::foo
+rmail://foo::foo
+mhe://foo::foo
+irc://foo::foo
+info://foo::foo
+gnus://foo::foo
+docview://foo::foo
+bibtex://foo::foo
+bbdb://foo::foo
+w3m://foo::foo
+doi://foo::foo
+file+sys://foo::foo
+file+emacs://foo::foo
+shell://foo::foo
+news://foo::foo
+mailto://foo::foo
+https://foo::foo
+http://foo::foo
+ftp://foo::foo
+help://foo::foo
+file://foo::foo
+elisp://foo::foo
+randomfakeprotocl://foo::foo
+non-link text::foo

org_mode_samples/object/plain_link/multiple_slashes.org

@@ -0,0 +1,13 @@
+file:foo
+file:/bar
+file://baz
+file:///lorem
+file:////ipsum
+file://///dolar
+
+https:foo
+https:/bar
+https://baz
+https:///lorem
+https:////ipsum
+https://///dolar

org_mode_samples/object/plain_link/relative_path.org

@@ -0,0 +1,4 @@
+# These do not become links
+./simple.org::foo
+../simple.org::foo
+/simple.org::foo

org_mode_samples/object/plain_link/search_option.org

@@ -0,0 +1,15 @@
+file:simple.org::foo
+
+file:simple.org::#foo
+file:simple.org::foo  bar
+file:simple.org::foo
+bar
+file:simple.org::foo::bar
+file:simple.org::/foo/
+
+file://en.wikipedia.org/wiki/Shebang_(Uni::x)
+
+
+file:simple.org::* foo
+file:simple.org::*bar
+file:simple.org::b*az

org_mode_samples/object/plain_link/template.org

@@ -0,0 +1,8 @@
+# None of these end up as links.
+
+#+LINK:       foo https://foo.bar/baz#%s
+foo::lorem
+
+cat::bat
+#+LINK:       cat https://dog%s
+cat:bat

org_mode_samples/object/regular_link/all_default_links.org

@@ -0,0 +1,25 @@
+non-link text
+[[eww://foo]]
+[[rmail://foo]]
+[[mhe://foo]]
+[[irc://foo]]
+[[info://foo]]
+[[gnus://foo]]
+[[docview://foo]]
+[[bibtex://foo]]
+[[bbdb://foo]]
+[[w3m://foo]]
+[[doi://foo]]
+[[file+sys://foo]]
+[[file+emacs://foo]]
+[[shell://foo]]
+[[news://foo]]
+[[mailto://foo]]
+[[https://foo]]
+[[http://foo]]
+[[ftp://foo]]
+[[help://foo]]
+[[file://foo]]
+[[elisp://foo]]
+[[randomfakeprotocl://foo]]
+non-link text

org_mode_samples/object/regular_link/application.org

@@ -0,0 +1,2 @@
+[[file+sys://foo]]
+[[file+emacs://foo]]

org_mode_samples/object/regular_link/code_ref_link.org

@@ -0,0 +1,13 @@
+[[(foo)]]
+
+[[((bar))]]
+
+[[((baz)]]
+
+[[(lo
+rem)]]
+
+# These become fuzzy
+[[(foo) ]]
+[[ (foo)]]
+[[(foo)::3]]

org_mode_samples/object/regular_link/custom_id_link.org

@@ -0,0 +1,6 @@
+[[#foo]]
+
+[[#fo
+o]]
+
+[[#foo::3]]

org_mode_samples/object/regular_link/file_link.org

@@ -0,0 +1,21 @@
+[[./simple.org]]
+[[../simple.org]]
+[[/simple.org]]
+[[file:simple.org]]
+[[file:sim  ple.org]]
+
+[[file:simp
+le.org]]
+
+[[file:simple.org::3]]
+[[file:simple.org::foo]]
+[[file:simple.org::#foo]]
+[[file:simple.org::foo  bar]]
+[[file:simple.org::foo
+bar]]
+[[file:simple.org::foo  
+bar]]
+[[file:simple.org::foo  
+  bar]]
+[[file:simple.org::foo::bar]]
+[[file:simple.org::/foo/]]

org_mode_samples/object/regular_link/fuzzy_link.org

@@ -0,0 +1,6 @@
+[[elisp.org]]
+
+[[eli
+sp.org]]
+
+[[elisp.org::3]]

org_mode_samples/object/regular_link/id_link.org

@@ -0,0 +1,6 @@
+[[id:83986bdf-987c-465d-8851-44cb4c02a86c]]
+
+[[id:83986bdf-987c-465d
+-8851-44cb4c02a86c]]
+
+[[id:83986bdf-987c-465d-8851-44cb4c02a86c::foo]]

org_mode_samples/object/regular_link/multiple_slashes.org

@@ -0,0 +1,20 @@
+[[file:foo]]
+[[file:/bar]]
+[[file://baz]]
+[[file:///lorem]]
+[[file:////ipsum]]
+[[file://///dolar]]
+
+[[foo]]
+[[/bar]]
+[[//baz]]
+[[///lorem]]
+[[////ipsum]]
+[[/////dolar]]
+
+[[https:foo]]
+[[https:/bar]]
+[[https://baz]]
+[[https:///lorem]]
+[[https:////ipsum]]
+[[https://///dolar]]

org_mode_samples/object/regular_link/protocol_link.org

@@ -0,0 +1,6 @@
+[[shell:foo]]
+
+[[shell:fo
+o]]
+
+[[shell:foo::3]]

org_mode_samples/object/regular_link/search_option.org

@@ -0,0 +1,16 @@
+[[file:simple.org::foo]]
+
+[[file:simple.org::#foo]]
+[[file:simple.org::foo  bar]]
+[[file:simple.org::foo
+bar]]
+[[file:simple.org::foo::bar]]
+[[file:simple.org::/foo/]]
+
+[[file://en.wikipedia.org/wiki/Shebang_(Uni::x)]]
+
+
+[[file:simple.org::*]]
+[[file:simple.org::* foo]]
+[[file:simple.org::*bar]]
+[[file:simple.org::b*az]]

org_mode_samples/object/regular_link/template.org

@@ -0,0 +1,7 @@
+#+LINK:       foo https://foo.bar/baz#%s
+[[foo::lorem]]
+[[foo::ipsum][dolar]]
+
+[[cat::bat]]
+#+LINK:       cat dog%s
+[[cat:bat]]

src/compare/compare.rs

@@ -1,6 +1,7 @@
 use std::path::Path;
 
 use crate::compare::diff::compare_document;
+use crate::compare::diff::DiffResult;
 use crate::compare::parse::emacs_parse_anonymous_org_document;
 use crate::compare::parse::emacs_parse_file_org_document;
 use crate::compare::parse::get_emacs_version;
@@ -43,6 +44,12 @@ pub fn run_anonymous_compare_with_settings<P: AsRef<str>>(
 
     if diff_result.is_bad() {
         Err("Diff results do not match.")?;
+    } else {
+        println!(
+            "{color}Entire document passes.{reset}",
+            color = DiffResult::foreground_color(0, 255, 0),
+            reset = DiffResult::reset_color(),
+        );
     }
 
     Ok(())
@@ -83,6 +90,12 @@ pub fn run_compare_on_file_with_settings<P: AsRef<Path>>(
 
     if diff_result.is_bad() {
         Err("Diff results do not match.")?;
+    } else {
+        println!(
+            "{color}Entire document passes.{reset}",
+            color = DiffResult::foreground_color(0, 255, 0),
+            reset = DiffResult::reset_color(),
+        );
     }
 
     Ok(())

src/compare/compare_field.rs

@@ -0,0 +1,161 @@
+use std::fmt::Debug;
+
+use super::diff::DiffStatus;
+use super::sexp::unquote;
+use super::sexp::Token;
+use super::util::get_property;
+use super::util::get_property_quoted_string;
+use super::util::get_property_unquoted_atom;
+
+#[derive(Debug)]
+pub(crate) enum EmacsField<'s> {
+    Required(&'s str),
+    #[allow(dead_code)]
+    Optional(&'s str),
+}
+
+/// Do no comparison.
+///
+/// This is for when you want to acknowledge that a field exists in the emacs token, but you do not have any validation for it when using the compare_properties!() macro. Ideally, this should be kept to a minimum since this represents untested values.
+#[allow(dead_code)]
+pub(crate) fn compare_noop<'b, 's, 'x, R, RG>(
+    _emacs: &'b Token<'s>,
+    _rust_node: R,
+    _emacs_field: &'x str,
+    _rust_value_getter: RG,
+) -> Result<Option<(DiffStatus, Option<String>)>, Box<dyn std::error::Error>> {
+    Ok(None)
+}
+
+/// Do no comparison.
+///
+/// This is for when you want to acknowledge that a field exists in the emacs token, but you do not have any validation for it when using the compare_properties!() macro. Ideally, this should be kept to a minimum since this represents untested values.
+#[allow(dead_code)]
+pub(crate) fn compare_identity() -> () {
+    ()
+}
+
+/// Assert that the emacs value is always nil or absent.
+///
+/// This is usually used for fields which, in my testing, are always nil. Using this compare function instead of simply doing a compare_noop will enable us to be alerted when we finally come across an org-mode document that has a value other than nil for the property.
+pub(crate) fn compare_property_always_nil<'b, 's, 'x, R, RG>(
+    emacs: &'b Token<'s>,
+    _rust_node: R,
+    emacs_field: &'x str,
+    _rust_value_getter: RG,
+) -> Result<Option<(DiffStatus, Option<String>)>, Box<dyn std::error::Error>> {
+    let value = get_property(emacs, emacs_field)?;
+    if value.is_some() {
+        let this_status = DiffStatus::Bad;
+        let message = Some(format!(
+            "{} was expected to always be nil: {:?}",
+            emacs_field, value
+        ));
+        Ok(Some((this_status, message)))
+    } else {
+        Ok(None)
+    }
+}
+
+pub(crate) fn compare_property_quoted_string<
+    'b,
+    's,
+    'x,
+    R,
+    RV: AsRef<str> + std::fmt::Debug,
+    RG: Fn(R) -> Option<RV>,
+>(
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<Option<(DiffStatus, Option<String>)>, Box<dyn std::error::Error>> {
+    let value = get_property_quoted_string(emacs, emacs_field)?;
+    let rust_value = rust_value_getter(rust_node);
+    if rust_value.as_ref().map(|s| s.as_ref()) != value.as_ref().map(String::as_str) {
+        let this_status = DiffStatus::Bad;
+        let message = Some(format!(
+            "{} mismatch (emacs != rust) {:?} != {:?}",
+            emacs_field, value, rust_value
+        ));
+        Ok(Some((this_status, message)))
+    } else {
+        Ok(None)
+    }
+}
+
+pub(crate) fn compare_property_unquoted_atom<'b, 's, 'x, R, RG: Fn(R) -> Option<&'s str>>(
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<Option<(DiffStatus, Option<String>)>, Box<dyn std::error::Error>> {
+    let value = get_property_unquoted_atom(emacs, emacs_field)?;
+    let rust_value = rust_value_getter(rust_node);
+    if rust_value != value {
+        let this_status = DiffStatus::Bad;
+        let message = Some(format!(
+            "{} mismatch (emacs != rust) {:?} != {:?}",
+            emacs_field, value, rust_value
+        ));
+        Ok(Some((this_status, message)))
+    } else {
+        Ok(None)
+    }
+}
+
+pub(crate) fn compare_property_list_of_quoted_string<
+    'b,
+    's,
+    'x,
+    R,
+    RV: AsRef<str> + std::fmt::Debug,
+    RI: Iterator<Item = RV>,
+    RG: Fn(R) -> Option<RI>,
+>(
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<Option<(DiffStatus, Option<String>)>, Box<dyn std::error::Error>> {
+    let value = get_property(emacs, emacs_field)?
+        .map(Token::as_list)
+        .map_or(Ok(None), |r| r.map(Some))?;
+    let rust_value = rust_value_getter(rust_node);
+    // TODO: Seems we are needlessly coverting to a vec here.
+    let rust_value: Option<Vec<RV>> = rust_value.map(|it| it.collect());
+    match (value, &rust_value) {
+        (None, None) => {}
+        (None, Some(_)) | (Some(_), None) => {
+            let this_status = DiffStatus::Bad;
+            let message = Some(format!(
+                "{} mismatch (emacs != rust) {:?} != {:?}",
+                emacs_field, value, rust_value
+            ));
+            return Ok(Some((this_status, message)));
+        }
+        (Some(el), Some(rl)) if el.len() != rl.len() => {
+            let this_status = DiffStatus::Bad;
+            let message = Some(format!(
+                "{} mismatch (emacs != rust) {:?} != {:?}",
+                emacs_field, value, rust_value
+            ));
+            return Ok(Some((this_status, message)));
+        }
+        (Some(el), Some(rl)) => {
+            for (e, r) in el.iter().zip(rl) {
+                let e = unquote(e.as_atom()?)?;
+                let r = r.as_ref();
+                if e != r {
+                    let this_status = DiffStatus::Bad;
+                    let message = Some(format!(
+                        "{} mismatch (emacs != rust) {:?} != {:?}. Full list: {:?} != {:?}",
+                        emacs_field, e, r, value, rust_value
+                    ));
+                    return Ok(Some((this_status, message)));
+                }
+            }
+        }
+    }
+    Ok(None)
+}