From aa33fe42a87f536f452919b1e23238a9400aa28d Mon Sep 17 00:00:00 2001
From: Tom Alexander <tom@fizz.buzz>
Date: Wed, 11 Oct 2023 14:14:33 -0400
Subject: [PATCH] Update compare_properties to handle affiliated keywords.

---
 src/compare/compare_field.rs |  1 +
 src/compare/diff.rs          | 10 +---
 src/compare/macros.rs        | 89 ++++++++++++++++++++++++++++++++++++
 3 files changed, 91 insertions(+), 9 deletions(-)

diff --git a/src/compare/compare_field.rs b/src/compare/compare_field.rs
index 3c07aba..1fd82aa 100644
--- a/src/compare/compare_field.rs
+++ b/src/compare/compare_field.rs
@@ -431,6 +431,7 @@ pub(crate) fn compare_property_list_of_list_of_list_of_ast_nodes<
     emacs_field: &'x str,
     rust_value_getter: RG,
 ) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>> {
+    // TODO: Replace Object<'s> with generics. I hard-coded Object in to make lifetimes easier.
     let rust_value = rust_value_getter(rust_node);
     let value = get_property(emacs, emacs_field)?
         .map(Token::as_list)
diff --git a/src/compare/diff.rs b/src/compare/diff.rs
index 16f596e..2ce309d 100644
--- a/src/compare/diff.rs
+++ b/src/compare/diff.rs
@@ -768,19 +768,11 @@ fn compare_plain_list<'b, 's>(
         &mut message,
     )?;
 
-    for diff in compare_affiliated_keywords(source, emacs, rust)? {
-        diff.apply(&mut child_status, &mut this_status, &mut message);
-    }
-    let affiliated_keywords_names: Vec<String> = affiliated_keywords_names(rust).collect();
-
     for diff in compare_properties!(
         source,
         emacs,
         rust,
-        affiliated_keywords_names
-            .iter()
-            .map(String::as_str)
-            .map(EmacsField::Required),
+        [],
         (
             EmacsField::Optional(":name"),
             |r| r.name,
diff --git a/src/compare/macros.rs b/src/compare/macros.rs
index ecfd0ab..e65ca8c 100644
--- a/src/compare/macros.rs
+++ b/src/compare/macros.rs
@@ -96,6 +96,95 @@ macro_rules! compare_properties {
             new_status
         }
     };
+    // For elements with affiliated keywords
+    ($source:expr, $emacs:expr, $rust:expr, [], $(($emacs_field:expr, $rust_value_getter:expr, $compare_fn: expr)),+) => {
+        {
+            let mut new_status = Vec::new();
+            let children = $emacs.as_list()?;
+            let attributes_child = children
+            .iter()
+            .nth(1)
+            .ok_or("Should have an attributes child.")?;
+            let attributes_map = attributes_child.as_map()?;
+            let mut emacs_keys: BTreeSet<&str> = attributes_map.keys().map(|s| *s).collect();
+            if emacs_keys.contains(":standard-properties") {
+                emacs_keys.remove(":standard-properties");
+            } else {
+                new_status.push(ComparePropertiesResult::SelfChange(DiffStatus::Bad, Some(format!(
+                    "Emacs token lacks :standard-properties field.",
+                ))));
+            }
+            let affiliated_keywords_names: Vec<String> = affiliated_keywords_names($rust).collect();
+            for additional_field in affiliated_keywords_names.iter().map(String::as_str).map(EmacsField::Required) {
+                match additional_field {
+                    EmacsField::Required(name) if emacs_keys.contains(name) => {
+                        emacs_keys.remove(name);
+                    },
+                    EmacsField::Optional(name) if emacs_keys.contains(name) => {
+                        emacs_keys.remove(name);
+                    },
+                    EmacsField::Required(name) => {
+                        new_status.push(ComparePropertiesResult::SelfChange(DiffStatus::Bad, Some(format!(
+                            "Emacs token lacks required field: {}",
+                            name
+                        ))));
+                    },
+                    EmacsField::Optional(_name) => {},
+                }
+            }
+            $(
+            match $emacs_field {
+                EmacsField::Required(name) if emacs_keys.contains(name) => {
+                    emacs_keys.remove(name);
+                },
+                EmacsField::Optional(name) if emacs_keys.contains(name) => {
+                    emacs_keys.remove(name);
+                },
+                EmacsField::Required(name) => {
+                    new_status.push(ComparePropertiesResult::SelfChange(DiffStatus::Bad, Some(format!(
+                        "Emacs token lacks required field: {}",
+                        name
+                    ))));
+                },
+                EmacsField::Optional(_name) => {},
+            }
+            )+
+
+            if !emacs_keys.is_empty() {
+                let unexpected_keys: Vec<&str> = emacs_keys.into_iter().collect();
+                let unexpected_keys = unexpected_keys.join(", ");
+                new_status.push(ComparePropertiesResult::SelfChange(DiffStatus::Bad, Some(format!(
+                    "Emacs token had extra field(s): {}",
+                    unexpected_keys
+                ))));
+            }
+
+            for diff in compare_affiliated_keywords($source, $emacs, $rust)? {
+                new_status.push(diff);
+            }
+
+            $(
+            let emacs_name = match $emacs_field {
+                EmacsField::Required(name) => {
+                    name
+                },
+                EmacsField::Optional(name) => {
+                    name
+                },
+            };
+            let result = $compare_fn($source, $emacs, $rust, emacs_name, $rust_value_getter)?;
+            match result {
+                ComparePropertiesResult::SelfChange(DiffStatus::Good, _) => unreachable!("No comparison functions should return SelfChange() when DiffStatus is good."),
+                ComparePropertiesResult::NoChange => {},
+                result => {
+                    new_status.push(result);
+                }
+            }
+            )+
+
+            new_status
+        }
+    };
     // Specifies additional properties
     ($source:expr, $emacs:expr, $rust:expr, $additionalproperties: expr, $(($emacs_field:expr, $rust_value_getter:expr, $compare_fn: expr)),+) => {
         {