Publish version 0.1.12.

Now that entities are stored in the settings struct, these variables are massive which makes them balloon trace sizes while being mostly unreadable. This removes Debug from them to serve as a static-analysis check that context is ALWAYS ignored in tracing calls.

.gitignore

@@ -1,2 +1,3 @@
 /target
 Cargo.lock
+TODO.org

.lighthouse/pipeline-clippy.yaml

@@ -0,0 +1,191 @@
+apiVersion: tekton.dev/v1beta1
+kind: PipelineRun
+metadata:
+  name: clippy
+spec:
+  pipelineSpec:
+    params:
+      - name: image-name
+        description: The name for the built image
+        type: string
+      - name: path-to-image-context
+        description: The path to the build context
+        type: string
+      - name: path-to-dockerfile
+        description: The path to the Dockerfile
+        type: string
+      - name: GIT_USER_NAME
+        description: The username for git
+        type: string
+        default: "fluxcdbot"
+      - name: GIT_USER_EMAIL
+        description: The email for git
+        type: string
+        default: "fluxcdbot@users.noreply.github.com"
+    tasks:
+      - name: do-stuff
+        taskSpec:
+          metadata: {}
+          stepTemplate:
+            image: alpine:3.18
+            name: ""
+            resources:
+              requests:
+                cpu: 10m
+                memory: 600Mi
+            workingDir: /workspace/source
+          steps:
+            - image: alpine:3.18
+              name: do-stuff-step
+              script: |
+                #!/usr/bin/env sh
+                echo "hello world"
+      - name: report-pending
+        taskRef:
+          name: gitea-set-status
+        runAfter:
+          - fetch-repository
+        params:
+          - name: CONTEXT
+            value: "$(params.JOB_NAME)"
+          - name: REPO_FULL_NAME
+            value: "$(params.REPO_OWNER)/$(params.REPO_NAME)"
+          - name: GITEA_HOST_URL
+            value: code.fizz.buzz
+          - name: SHA
+            value: "$(tasks.fetch-repository.results.commit)"
+          - name: DESCRIPTION
+            value: "Build $(params.JOB_NAME) has started"
+          - name: STATE
+            value: pending
+          - name: TARGET_URL
+            value: "https://tekton.fizz.buzz/#/namespaces/$(context.pipelineRun.namespace)/pipelineruns/$(context.pipelineRun.name)"
+      - name: fetch-repository
+        taskRef:
+          name: git-clone
+        workspaces:
+          - name: output
+            workspace: git-source
+        params:
+          - name: url
+            value: $(params.REPO_URL)
+          - name: revision
+            value: $(params.PULL_BASE_SHA)
+          - name: deleteExisting
+            value: "true"
+      - name: build-image
+        taskRef:
+          name: kaniko
+        params:
+          - name: IMAGE
+            value: "$(params.image-name):$(tasks.fetch-repository.results.commit)"
+          - name: CONTEXT
+            value: $(params.path-to-image-context)
+          - name: DOCKERFILE
+            value: $(params.path-to-dockerfile)
+          - name: BUILDER_IMAGE
+            value: "gcr.io/kaniko-project/executor:v1.12.1"
+          - name: EXTRA_ARGS
+            value:
+              - --cache=true
+              - --cache-copy-layers
+              - --cache-repo=harbor.fizz.buzz/kanikocache/cache
+              - --use-new-run # Should result in a speed-up
+              - --reproducible # To remove timestamps so layer caching works.
+              - --snapshot-mode=redo
+              - --skip-unused-stages=true
+              - --registry-mirror=dockerhub.dockerhub.svc.cluster.local
+        workspaces:
+          - name: source
+            workspace: git-source
+          - name: dockerconfig
+            workspace: docker-credentials
+        runAfter:
+          - fetch-repository
+      - name: clippy
+        taskRef:
+          name: run-docker-image
+        workspaces:
+          - name: source
+            workspace: git-source
+          - name: cargo-cache
+            workspace: cargo-cache
+        runAfter:
+          - build-image
+        params:
+          - name: docker-image
+            value: "$(params.image-name):$(tasks.fetch-repository.results.commit)"
+    finally:
+      - name: report-success
+        when:
+          - input: "$(tasks.status)"
+            operator: in
+            values: ["Succeeded", "Completed"]
+        taskRef:
+          name: gitea-set-status
+        params:
+          - name: CONTEXT
+            value: "$(params.JOB_NAME)"
+          - name: REPO_FULL_NAME
+            value: "$(params.REPO_OWNER)/$(params.REPO_NAME)"
+          - name: GITEA_HOST_URL
+            value: code.fizz.buzz
+          - name: SHA
+            value: "$(tasks.fetch-repository.results.commit)"
+          - name: DESCRIPTION
+            value: "Build $(params.JOB_NAME) has succeeded"
+          - name: STATE
+            value: success
+          - name: TARGET_URL
+            value: "https://tekton.fizz.buzz/#/namespaces/$(context.pipelineRun.namespace)/pipelineruns/$(context.pipelineRun.name)"
+      - name: report-failure
+        when:
+          - input: "$(tasks.status)"
+            operator: in
+            values: ["Failed"]
+        taskRef:
+          name: gitea-set-status
+        params:
+          - name: CONTEXT
+            value: "$(params.JOB_NAME)"
+          - name: REPO_FULL_NAME
+            value: "$(params.REPO_OWNER)/$(params.REPO_NAME)"
+          - name: GITEA_HOST_URL
+            value: code.fizz.buzz
+          - name: SHA
+            value: "$(tasks.fetch-repository.results.commit)"
+          - name: DESCRIPTION
+            value: "Build $(params.JOB_NAME) has failed"
+          - name: STATE
+            value: failure
+          - name: TARGET_URL
+            value: "https://tekton.fizz.buzz/#/namespaces/$(context.pipelineRun.namespace)/pipelineruns/$(context.pipelineRun.name)"
+    workspaces:
+      - name: git-source
+      - name: docker-credentials
+  workspaces:
+    - name: git-source
+      volumeClaimTemplate:
+        spec:
+          storageClassName: "nfs-client"
+          accessModes:
+            - ReadWriteOnce
+          resources:
+            requests:
+              storage: 10Gi
+      subPath: rust-source
+    - name: cargo-cache
+      persistentVolumeClaim:
+        claimName: organic-cargo-cache-clippy
+    - name: docker-credentials
+      secret:
+        secretName: harbor-plain
+  serviceAccountName: build-bot
+  timeout: 240h0m0s
+  params:
+    - name: image-name
+      value: "harbor.fizz.buzz/private/organic-clippy"
+    - name: path-to-image-context
+      value: docker/organic_clippy/
+    - name: path-to-dockerfile
+      value: docker/organic_clippy/Dockerfile

.lighthouse/pipeline-rust-build.yaml

@@ -137,7 +137,7 @@ spec:
             value: []
           - name: docker-image
             value: "$(params.image-name):$(tasks.fetch-repository.results.commit)"
-      - name: run-image-all
+      - name: run-image-tracing-compare
         taskRef:
           name: run-docker-image
         workspaces:
@@ -152,6 +152,46 @@ spec:
             value: ["--no-default-features", "--features", "tracing,compare"]
           - name: docker-image
             value: "$(params.image-name):$(tasks.fetch-repository.results.commit)"
+      - name: run-image-compare-foreign
+        taskRef:
+          name: run-docker-image
+        workspaces:
+          - name: source
+            workspace: git-source
+          - name: cargo-cache
+            workspace: cargo-cache
+        runAfter:
+          - run-image-tracing-compare
+        params:
+          - name: args
+            value:
+              [
+                "--no-default-features",
+                "--features",
+                "compare,foreign_document_test",
+              ]
+          - name: docker-image
+            value: "$(params.image-name):$(tasks.fetch-repository.results.commit)"
+      - name: run-image-all
+        taskRef:
+          name: run-docker-image
+        workspaces:
+          - name: source
+            workspace: git-source
+          - name: cargo-cache
+            workspace: cargo-cache
+        runAfter:
+          - run-image-compare-foreign
+        params:
+          - name: args
+            value:
+              [
+                "--no-default-features",
+                "--features",
+                "tracing,compare,foreign_document_test",
+              ]
+          - name: docker-image
+            value: "$(params.image-name):$(tasks.fetch-repository.results.commit)"
     finally:
       - name: report-success
         when:

.lighthouse/triggers.yaml

@@ -30,3 +30,10 @@ spec:
       skip_branches:
         # We already run on every commit, so running when the semver tags get pushed is causing needless double-processing.
         - "^v[0-9]+\\.[0-9]+\\.[0-9]+$"
+    - name: clippy
+      source: "pipeline-clippy.yaml"
+      # Override https-based url from lighthouse events.
+      clone_uri: "git@code.fizz.buzz:talexander/organic.git"
+      skip_branches:
+        # We already run on every commit, so running when the semver tags get pushed is causing needless double-processing.
+        - "^v[0-9]+\\.[0-9]+\\.[0-9]+$"

Cargo.toml

@@ -1,6 +1,8 @@
+# cargo-features = ["profile-rustflags"]
+
 [package]
 name = "organic"
-version = "0.1.9"
+version = "0.1.12"
 authors = ["Tom Alexander <tom@fizz.buzz>"]
 description = "An org-mode parser."
 edition = "2021"
@@ -31,7 +33,14 @@ path = "src/lib.rs"
   path = "src/bin_compare.rs"
   required-features = ["compare"]
 
+[[bin]]
+  # This bin exists for development purposes only. The real target of this crate is the library.
+  name = "foreign_document_test"
+  path = "src/bin_foreign_document_test.rs"
+  required-features = ["foreign_document_test"]
+
 [dependencies]
+futures = { version = "0.3.28", optional = true }
 nom = "7.1.1"
 opentelemetry = { version = "0.20.0", optional = true, default-features = false, features = ["trace", "rt-tokio"] }
 opentelemetry-otlp = { version = "0.13.0", optional = true }
@@ -40,14 +49,17 @@ tokio = { version = "1.30.0", optional = true, default-features = false, feature
 tracing = { version = "0.1.37", optional = true }
 tracing-opentelemetry = { version = "0.20.0", optional = true }
 tracing-subscriber = { version = "0.3.17", optional = true, features = ["env-filter"] }
+walkdir = { version = "2.3.3", optional = true }
 
 [build-dependencies]
 walkdir = "2.3.3"
 
 [features]
 default = []
-compare = []
+compare = ["tokio/process", "tokio/macros"]
+foreign_document_test = ["compare", "dep:futures", "tokio/sync", "dep:walkdir", "tokio/process"]
 tracing = ["dep:opentelemetry", "dep:opentelemetry-otlp", "dep:opentelemetry-semantic-conventions", "dep:tokio", "dep:tracing", "dep:tracing-opentelemetry", "dep:tracing-subscriber"]
+event_count = []
 
 # Optimized build for any sort of release.
 [profile.release-lto]
@@ -55,6 +67,13 @@ inherits = "release"
 lto = true
 strip = "symbols"
 
+# Optimized build for local execution.
+# [profile.native]
+# inherits = "release"
+# lto = true
+# strip = "symbols"
+# rustflags = ["-C", "target-cpu=native"]
+
 # Profile for performance testing with the "perf" tool. Notably keeps debug enabled and does not strip symbols to make reading the perf output easier.
 [profile.perf]
 inherits = "release"

Makefile

@@ -37,6 +37,18 @@ clean:
 format:
 > $(MAKE) -C docker/cargo_fmt run
 
+.PHONY: dockerclippy
+dockerclippy:
+> $(MAKE) -C docker/organic_clippy run
+
+.PHONY: clippy
+clippy:
+> cargo clippy --no-deps --all-targets --all-features -- -D warnings
+
+.PHONY: clippyfix
+clippyfix:
+> cargo clippy --fix --lib -p organic --all-features
+
 .PHONY: test
 test:
 > cargo test --no-default-features --features compare --no-fail-fast --lib --test test_loader -- --test-threads $(TESTJOBS)
@@ -52,6 +64,8 @@ buildtest:
 > cargo build --no-default-features --features compare
 > cargo build --no-default-features --features tracing
 > cargo build --no-default-features --features compare,tracing
+> cargo build --no-default-features --features compare,foreign_document_test
+> cargo build --no-default-features --features compare,tracing,foreign_document_test
 
 .PHONY: foreign_document_test
 foreign_document_test:

README.md

@@ -6,14 +6,13 @@ Organic is an emacs-less implementation of an [org-mode](https://orgmode.org/) p
 
 This project is still under HEAVY development. While the version remains v0.1.x the API will be changing often. Once we hit v0.2.x we will start following semver.
 
-Currently, the parser is able to correctly identify the start/end bounds of all the org-mode objects and elements (except table.el tables, org-mode tables are supported) but many of the interior properties are not yet populated.
+Currently, Organic parses most documents the same as the official org-mode parser. Most of the development right now is finding documents where the parsers differ and fixing those issues.
 
 ### Project Goals
 - We aim to provide perfect parity with the emacs org-mode parser. In that regard, any document that parses differently between Emacs and Organic is considered a bug.
-- The parser should be fast. We're not doing anything special, but since this is written in Rust and natively compiled we should be able to beat the existing parsers.
 - The parser should have minimal dependencies. This should reduce effort w.r.t.: security audits, legal compliance, portability.
 - The parser should be usable everywhere. In the interest of getting org-mode used in as many places as possible, this parser should be usable by everyone everywhere. This means:
-  - It must have a permissive license for use in proprietary code bases.
+  - It must have a permissive license.
   - We will investigate compiling to WASM. This is an important goal of the project and will definitely happen, but only after the parser has a more stable API.
   - We will investigate compiling to a C library for native linking to other code. This is more of a maybe-goal for the project.
 ### Project Non-Goals

build.rs

@@ -14,7 +14,7 @@ use walkdir::WalkDir;
 fn main() {
     let out_dir = env::var("OUT_DIR").unwrap();
     let destination = Path::new(&out_dir).join("tests.rs");
-    let mut test_file = File::create(&destination).unwrap();
+    let mut test_file = File::create(destination).unwrap();
 
     // Re-generate the tests if any org-mode files change
     println!("cargo:rerun-if-changed=org_mode_samples");
@@ -51,7 +51,7 @@ fn write_test(test_file: &mut File, test: &walkdir::DirEntry) {
         .to_lowercase()
         .strip_suffix(".org")
         .expect("Should have .org extension")
-        .replace("/", "_");
+        .replace('/', "_");
 
     write!(
         test_file,
@@ -66,10 +66,6 @@ fn write_test(test_file: &mut File, test: &walkdir::DirEntry) {
 }
 
 #[cfg(feature = "compare")]
-fn is_expect_fail(name: &str) -> Option<&str> {
-    match name {
-        "greater_element_drawer_drawer_with_headline_inside" => Some("Apparently lines with :end: become their own paragraph. This odd behavior needs to be investigated more."),
-        "element_container_priority_footnote_definition_dynamic_block" => Some("Apparently broken begin lines become their own paragraph."),
-        _ => None,
-    }
+fn is_expect_fail(_name: &str) -> Option<&str> {
+    None
 }

docker/organic_clippy/Dockerfile

@@ -0,0 +1,5 @@
+FROM rustlang/rust:nightly-alpine3.17
+
+RUN apk add --no-cache musl-dev
+
+ENTRYPOINT ["cargo", "clippy", "--no-deps", "--all-targets", "--all-features", "--", "-D", "warnings"]

docker/organic_clippy/Makefile

@@ -0,0 +1,37 @@
+IMAGE_NAME:=organic-clippy
+# REMOTE_REPO:=harbor.fizz.buzz/private
+
+.PHONY: all
+all: build push
+
+.PHONY: build
+build:
+	docker build -t $(IMAGE_NAME) -f Dockerfile .
+
+.PHONY: push
+push:
+ifdef REMOTE_REPO
+	docker tag $(IMAGE_NAME) $(REMOTE_REPO)/$(IMAGE_NAME)
+	docker push $(REMOTE_REPO)/$(IMAGE_NAME)
+else
+	@echo "REMOTE_REPO not defined, not pushing to a remote repo."
+endif
+
+.PHONY: clean
+clean:
+	docker rmi $(IMAGE_NAME)
+ifdef REMOTE_REPO
+	docker rmi $(REMOTE_REPO)/$(IMAGE_NAME)
+else
+	@echo "REMOTE_REPO not defined, not removing from remote repo."
+endif
+	docker volume rm cargo-cache
+
+# NOTE: This target will write to folders underneath the git-root
+.PHONY: run
+run: build
+	docker run --rm --init --read-only --mount type=tmpfs,destination=/tmp -v "$$(readlink -f ../../):/source" --workdir=/source --mount source=cargo-cache,target=/usr/local/cargo/registry $(IMAGE_NAME)
+
+.PHONY: shell
+shell: build
+	docker run --rm -i -t --entrypoint /bin/sh --mount type=tmpfs,destination=/tmp -v "$$(readlink -f ../../):/source" --workdir=/source --mount source=cargo-cache,target=/usr/local/cargo/registry $(IMAGE_NAME)

docker/organic_test/Dockerfile

@@ -14,7 +14,7 @@ RUN make DESTDIR="/root/dist" install
 
 
 FROM build AS build-org-mode
-ARG ORG_VERSION=c703541ffcc14965e3567f928de1683a1c1e33f6
+ARG ORG_VERSION=abf5156096c06ee5aa05795c3dc5a065f76ada97
 COPY --from=build-emacs /root/dist/ /
 RUN mkdir /root/dist
 # Savannah does not allow fetching specific revisions, so we're going to have to put unnecessary load on their server by cloning main and then checking out the revision we want.
@@ -102,6 +102,4 @@ COPY --from=foreign-document-gather /foreign_documents/doomemacs /foreign_docume
 COPY --from=foreign-document-gather /foreign_documents/worg /foreign_documents/worg
 COPY --from=build-org-mode /root/org-mode /foreign_documents/org-mode
 COPY --from=build-emacs /root/emacs /foreign_documents/emacs
-COPY foreign_document_test_entrypoint.sh /entrypoint.sh
-RUN chmod +x /entrypoint.sh
-ENTRYPOINT ["/entrypoint.sh"]
+ENTRYPOINT ["cargo", "run", "--bin", "foreign_document_test", "--features", "compare,foreign_document_test", "--profile", "release-lto"]

docker/organic_test/foreign_document_test_entrypoint.sh

@@ -1,149 +0,0 @@
-#!/usr/bin/env bash
-#
-# Run the Organic compare script against a series of documents sourced from exterior places.
-set -euo pipefail
-IFS=$'\n\t'
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-
-REALPATH=$(command -v uu-realpath || command -v realpath)
-
-function log {
-    (>&2 echo "${@}")
-}
-
-function die {
-    local status_code="$1"
-    shift
-    (>&2 echo "${@}")
-    exit "$status_code"
-}
-
-function main {
-    cargo build --no-default-features --features compare --profile release-lto
-    if [ "${CARGO_TARGET_DIR:-}" = "" ]; then
-        CARGO_TARGET_DIR=$(realpath target/)
-    fi
-    PARSE="${CARGO_TARGET_DIR}/release-lto/compare"
-
-    local all_status=0
-    set +e
-
-    (run_compare_function "org-mode" compare_all_org_document "/foreign_documents/org-mode")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "emacs" compare_all_org_document "/foreign_documents/emacs")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "worg" compare_all_org_document "/foreign_documents/worg")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "howard_abrams" compare_howard_abrams)
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "doomemacs" compare_all_org_document "/foreign_documents/doomemacs")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-
-    set -e
-    if [ "$all_status" -ne 0 ]; then
-        red_text "Some tests failed."
-    else
-        green_text "All tests passed."
-    fi
-    return "$all_status"
-}
-
-function green_text {
-    (IFS=' '; printf '\x1b[38;2;0;255;0m%s\x1b[0m' "${*}")
-}
-
-function red_text {
-    (IFS=' '; printf '\x1b[38;2;255;0;0m%s\x1b[0m' "${*}")
-}
-
-function yellow_text {
-    (IFS=' '; printf '\x1b[38;2;255;255;0m%s\x1b[0m' "${*}")
-}
-
-function indent {
-    local depth="$1"
-    local scaled_depth=$((depth * 2))
-    shift 1
-    local prefix
-    prefix=$(printf -- "%${scaled_depth}s")
-    while read -r l; do
-        (IFS=' '; printf -- '%s%s\n' "$prefix" "$l")
-    done
-}
-
-function run_compare_function {
-    local name="$1"
-    local stdoutput
-    shift 1
-    set +e
-    stdoutput=$("${@}")
-    local status=$?
-    set -e
-    if [ "$status" -eq 0 ]; then
-        echo "$(green_text "GOOD")  $name"
-        indent 1 <<<"$stdoutput"
-    else
-        echo "$(red_text "FAIL")  $name"
-        indent 1 <<<"$stdoutput"
-        return 1
-    fi
-}
-
-function compare_all_org_document {
-    local root_dir="$1"
-    local target_document
-    local all_status=0
-    while read target_document; do
-        local relative_path
-        relative_path=$($REALPATH --relative-to "$root_dir" "$target_document")
-        set +e
-        (run_compare "$relative_path" "$target_document")
-        if [ "$?" -ne 0 ]; then all_status=1; fi
-        set -e
-    done<<<"$(find "$root_dir" -type f -iname '*.org' | sort)"
-    return "$all_status"
-}
-
-function run_compare {
-    local name="$1"
-    local target_document="$2"
-    set +e
-    ($PARSE "$target_document" &> /dev/null)
-    local status=$?
-    set -e
-    if [ "$status" -eq 0 ]; then
-        echo "$(green_text "GOOD")  $name"
-    else
-        echo "$(red_text "FAIL")  $name"
-        return 1
-    fi
-}
-
-function compare_howard_abrams {
-    local all_status=0
-    set +e
-
-    (run_compare_function "dot-files" compare_all_org_document "/foreign_documents/howardabrams/dot-files")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "hamacs" compare_all_org_document "/foreign_documents/howardabrams/hamacs")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "demo-it" compare_all_org_document "/foreign_documents/howardabrams/demo-it")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "magit-demo" compare_all_org_document "/foreign_documents/howardabrams/magit-demo")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "pdx-emacs-hackers" compare_all_org_document "/foreign_documents/howardabrams/pdx-emacs-hackers")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "flora-simulator" compare_all_org_document "/foreign_documents/howardabrams/flora-simulator")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "literate-devops-demo" compare_all_org_document "/foreign_documents/howardabrams/literate-devops-demo")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "clojure-yesql-xp" compare_all_org_document "/foreign_documents/howardabrams/clojure-yesql-xp")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-    (run_compare_function "veep" compare_all_org_document "/foreign_documents/howardabrams/veep")
-    if [ "$?" -ne 0 ]; then all_status=1; fi
-
-    set -e
-    return "$all_status"
-}
-
-main "${@}"

elisp_snippets/dump_org_entities.el

@@ -1,5 +1,11 @@
-(dolist (var org-entities)
-  (when (listp var)
-      (message "\"%s\"," (nth 0 var))
-    )
+(dolist (var (sort (seq-filter 'listp  org-entities)
+                   (lambda (x y) (> (length (nth 0 x)) (length (nth 0 y))))))
+  (message "EntityDefinition {name: %s, latex_math_mode: %s, latex: %s, html: %s, ascii: %s, utf8: %s},"
+           (prin1-to-string (nth 0 var))
+           (if (nth 2 var) "true" "false")
+           (prin1-to-string (nth 1 var))
+           (prin1-to-string (nth 3 var))
+           (prin1-to-string (nth 4 var))
+           (prin1-to-string (nth 6 var))
+           )
   )

notes/affiliated_keyword_investigation/analysis.org

@@ -0,0 +1,42 @@
+* Elisp Structure
+| Keyword | Single        | Double        | Single Optval | Double Optval |
+|---------+---------------+---------------+---------------+---------------|
+| CAPTION | objtree       | objtree       | objtree       | objtree       |
+| DATA    | quoted(:name) | quoted(:name) | -             | -             |
+| HEADER  | list(quoted)  | list(quoted)  | -             | -             |
+| NAME    | quoted(:name) | quoted(:name) | -             | -             |
+| PLOT    | quoted(:plot) | quoted(:plot) | -             | -             |
+| RESULTS | optional pair | optional pair | optional pair | optional pair |
+* types
+** objtree
+Outer list: 1 per keyword
+next list: first entry = list of objects for value. remaining entries = optval
+** list(quoted)
+List of quoted strings, 1 per keyword
+** quoted(NAME)
+Quoted string under the NAME property (for example quoted(:name))
+** optional pair
+When optval is supplied this is an alist with the field value being the real value and the 3nd value being the optval.
+#+begin_src elisp
+  ("*f*" . "*bar*")
+#+end_src
+
+When optval is not supplied this is a list containing a single string of the last occurrence of this keyword.
+#+begin_src elisp
+  ("*c*")
+#+end_src
+* Default settings
+#+begin_src text
+  org-element-dual-keywords ("CAPTION" "RESULTS")
+  org-element-parsed-keywords ("CAPTION")
+  org-element-multiple-keywords ("CAPTION" "HEADER")
+  org-babel-results-keyword "RESULTS"
+#+end_src
+* Analysis
+We don't have an example of a parsed non-dual keyword
+
+Looks like multiple triggers list 1 per keyword
+
+dual triggers support for optval
+
+parsed triggers objects

notes/affiliated_keyword_investigation/run_test.bash

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+#
+set -euo pipefail
+IFS=$'\n\t'
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+file_path="${DIR}/test_document.org"
+
+for TARGET_VARIABLE in RESULTS CAPTION HEADER DATA NAME PLOT; do
+    INIT_SCRIPT=$(cat <<EOF
+(progn
+     (erase-buffer)
+     (require 'org)
+     (defun org-table-align () t)
+     (setq vc-handled-backends nil)
+     (find-file "/input/${file_path}")
+     (org-mode)
+     (replace-regexp-in-region "foo" "${TARGET_VARIABLE}")
+     (message "%s" (pp-to-string (org-element-parse-buffer)))
+)
+EOF
+               )
+    docker run --init --rm -i --mount type=tmpfs,destination=/tmp -v "/:/input:ro" -w /input --entrypoint "" organic-test emacs -q --no-site-file --no-splash --batch --eval "$INIT_SCRIPT" 2> "${DIR}/${TARGET_VARIABLE}"
+done
+
+# exec docker run --init --rm -i -t --mount type=tmpfs,destination=/tmp -v "/:/input:ro" -w /input --entrypoint "" organic-test emacs -q --no-site-file --no-splash --eval "$INIT_SCRIPT"
+
+# org-element-dual-keywords ("CAPTION" "RESULTS")
+# org-element-parsed-keywords ("CAPTION")
+# org-element-multiple-keywords ("CAPTION" "HEADER")
+# org-babel-results-keyword "RESULTS"

notes/affiliated_keyword_investigation/test_document.org

@@ -0,0 +1,25 @@
+# Single instance
+#+foo: *a*
+#+begin_example
+
+#+end_example
+
+# Two instances
+#+foo: *b*
+#+foo: *c*
+#+begin_example
+
+#+end_example
+
+# Single with optval
+#+foo[*bar*]: *d*
+#+begin_example
+
+#+end_example
+
+# Two with optval
+#+foo[*bar*]: *e*
+#+foo[*bar*]: *f*
+#+begin_example
+
+#+end_example

org_mode_samples/affiliated_keyword/optional_value.org

@@ -0,0 +1,8 @@
+#+CAPTION[foo]: *bar*
+#+CAPTION[*lorem* ipsum]: dolar
+1. baz
+
+
+#+CAPTION[foo]: *bar*
+#+CAPTION[*lorem* ipsum]: dolar
+# Comments cannot have affiliated keywords so those become regular keywords.

org_mode_samples/bullshitium/fake_paragraph/broken_end.org

@@ -0,0 +1,3 @@
+foo
+:end:
+bar

org_mode_samples/bullshitium/fake_paragraph/broken_end_isolated.org

@@ -0,0 +1,2 @@
+foo
+:end:

org_mode_samples/greater_element/drawer/affiliated_keyword.org

@@ -0,0 +1,74 @@
+* Headline
+before
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+:candle:
+inside
+
+the drawer
+:end:
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+:candle:
+inside
+
+the drawer
+:end:
+
+after

org_mode_samples/greater_element/drawer/name.org

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

org_mode_samples/greater_element/dynamic_block/affiliated_keyword.org

@@ -0,0 +1,72 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+BEGIN: clocktable :scope file :maxlevel 2
+#+CAPTION: Clock summary at [2023-08-25 Fri 05:34]
+| Headline     | Time   |
+|--------------+--------|
+| *Total time* | *0:00* |
+#+END:
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+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/dynamic_block/name.org

@@ -1,7 +0,0 @@
-#+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/footnote_definition/affiliated_keyword.org

@@ -0,0 +1,63 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+[fn:1] A footnote.
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+[fn:1] A footnote.

org_mode_samples/greater_element/greater_block/center/affiliated_keyword.org

@@ -0,0 +1,67 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+begin_center
+
+#+end_center
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+begin_center
+
+#+end_center

org_mode_samples/greater_element/greater_block/center/name.org

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

org_mode_samples/greater_element/greater_block/quote/affiliated_keyword.org

@@ -0,0 +1,67 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+begin_quote
+
+#+end_quote
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+begin_quote
+
+#+end_quote

org_mode_samples/greater_element/greater_block/quote/name.org

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

org_mode_samples/greater_element/greater_block/special/affiliated_keyword.org

@@ -0,0 +1,71 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+begin_defun
+foo
+
+{{{bar(baz)}}}
+#+end_defun
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+begin_defun
+foo
+
+{{{bar(baz)}}}
+#+end_defun

org_mode_samples/greater_element/greater_block/special/name.org

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

org_mode_samples/greater_element/plain_list/affiliated_keyword.org

@@ -0,0 +1,63 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+1. bar
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+1. BAR

org_mode_samples/greater_element/plain_list/checkbox.org

@@ -0,0 +1,3 @@
+- [ ] Foo
+- [-] Bar
+- [X] Baz

org_mode_samples/greater_element/plain_list/item/name.org

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

org_mode_samples/greater_element/plain_list/name.org

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

org_mode_samples/greater_element/plain_list/regular_link.org

@@ -0,0 +1,2 @@
+# This test causes problems with regular links if we do not create a new ContextTree when calling into confine_context.
+- foo [[info:bar][baz]] lorem

org_mode_samples/greater_element/property_drawer/headline/comment.org

@@ -0,0 +1,5 @@
+* baz
+# lorem
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/headline/comment_space.org

@@ -0,0 +1,6 @@
+* baz
+# lorem
+
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/headline/immediate.org

@@ -0,0 +1,4 @@
+* baz
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/headline/planning_before_property_drawer.org

@@ -0,0 +1,7 @@
+** Foo
+DEADLINE: <2023-10-16 Mon>
+:PROPERTIES:
+:foo:   *a*
+:Bar:   *b*
+:BAZ:   *c*
+:END:

org_mode_samples/greater_element/property_drawer/headline/space.org

@@ -0,0 +1,5 @@
+* baz
+
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/headline/space_comment_space.org

@@ -0,0 +1,13 @@
+* baz
+
+
+
+
+# lorem
+
+
+
+
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/inheritance.org

@@ -0,0 +1,19 @@
+:PROPERTIES:
+:foo: bar
+:foo+: baz
+:cat: dog
+:END:
+
+# Even though these are inheriting the properties and overwriting and/or appending to them, this is not represented in the parser AST so Organic does not do any special handling of this.
+
+* Overwrite
+:PROPERTIES:
+:foo:      lorem
+:bat:      car
+:END:
+
+* Append
+:PROPERTIES:
+:foo+:      ipsum
+:cake:      lie
+:END:

org_mode_samples/greater_element/property_drawer/name.org

@@ -0,0 +1,5 @@
+* Overwrite
+  #+NAME: foo
+  :PROPERTIES:
+  :header-args: :var foo="lorem"
+  :END:

org_mode_samples/greater_element/property_drawer/zeroth_section.org

@@ -1,25 +0,0 @@
-
-
-
-
-# Blank lines and comments can come before property drawers in the zeroth section
-:PROPERTIES:
-:FOO:    bar
-:END:
-
-
-
-* Spaces turn property drawers into regular drawers
-
-:PROPERTIES:
-:FOO:    bar
-:END:
-* Comments turn property drawers into regular drawers
-# Comment
-:PROPERTIES:
-:FOO:    bar
-:END:
-* Baseline
-:PROPERTIES:
-:FOO:    bar
-:END:

org_mode_samples/greater_element/property_drawer/zeroth_section/comment.org

@@ -0,0 +1,4 @@
+# lorem
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/zeroth_section/comment_space.org

@@ -0,0 +1,5 @@
+# lorem
+
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/zeroth_section/immediate.org

@@ -0,0 +1,3 @@
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/zeroth_section/space.org

@@ -0,0 +1,4 @@
+
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/zeroth_section/space_comment_space.org

@@ -0,0 +1,12 @@
+
+
+
+
+# lorem
+
+
+
+
+:PROPERTIES:
+:FOO:    bar
+:END:

org_mode_samples/greater_element/property_drawer/zeroth_section_spaces_after_comment.org

@@ -1,12 +0,0 @@
-
-
-
-
-# Blank lines and comments can come before property drawers in the zeroth section
-
-
-
-
-:PROPERTIES:
-:FOO:    bar
-:END:

org_mode_samples/greater_element/table/affiliated_keyword.org

@@ -0,0 +1,63 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+| foo | bar |
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+| foo | bar |

org_mode_samples/greater_element/table/name.org

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

org_mode_samples/greater_element/table/row/name.org

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

org_mode_samples/lesser_element/babel_call/affiliated_keyword.org

@@ -0,0 +1,63 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+call: foo(bar="baz")
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+call: foo(bar="baz")

org_mode_samples/lesser_element/babel_call/name.org

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

org_mode_samples/lesser_element/diary_sexp/affiliated_keyword.org

@@ -0,0 +1,63 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+%%(foo)
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+%%(foo)

org_mode_samples/lesser_element/diary_sexp/name.org

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

org_mode_samples/lesser_element/fixed_width_area/affiliated_keyword.org

@@ -0,0 +1,63 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+: bar
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+: bar

org_mode_samples/lesser_element/fixed_width_area/name.org

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

org_mode_samples/lesser_element/horizontal_rule/affiliated_keyword.org

@@ -0,0 +1,63 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+-----
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+-----

org_mode_samples/lesser_element/horizontal_rule/name.org

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

org_mode_samples/lesser_element/keyword/affiliated_keyword.org

@@ -1,8 +1,63 @@
-#+name: foo
-#+caption: bar
-#+caption: baz
-[[file:lorem/ipsum.png]]
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+foo: bar
 
-#+name: cat
-#+caption: dog
-[[file:lorem/ipsum.png]]
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+foo: bar

org_mode_samples/lesser_element/keyword/affiliated_keywords_short_version.org

@@ -1,7 +0,0 @@
-# This test is to prove that the parser works with affiliated keywords that have both a shorter and longer version.
-
-#+results:
-#+result:
-#+begin_latex
-\foo
-#+end_latex

org_mode_samples/lesser_element/keyword/name.org

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

org_mode_samples/lesser_element/latex_environment/affiliated_keyword.org

@@ -0,0 +1,67 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+\begin{foo}
+bar
+\end{foo}
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+\begin{foo}
+bar
+\end{foo}

org_mode_samples/lesser_element/latex_environment/name.org

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

org_mode_samples/lesser_element/lesser_block/comment/affiliated_keyword.org

@@ -0,0 +1,67 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+begin_comment text
+bar
+#+end_comment
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+begin_comment text
+bar
+#+end_comment

org_mode_samples/lesser_element/lesser_block/comment/name.org

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

org_mode_samples/lesser_element/lesser_block/example/affiliated_keyword.org

@@ -0,0 +1,67 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+begin_example text
+bar
+#+end_example
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+begin_example text
+bar
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/affiliated_keyword_dual_value.org

@@ -0,0 +1,16 @@
+#+results[foo]: bar
+#+results[lorem]: ipsum
+#+begin_example
+baz
+#+end_example
+
+#+caption[lorem]: ipsum
+#+caption[foo]: bar
+#+begin_example
+baz
+#+end_example
+
+#+header[foo]: bar
+#+begin_example
+baz
+#+end_example

org_mode_samples/lesser_element/lesser_block/example/name.org

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

org_mode_samples/lesser_element/lesser_block/export/affiliated_keyword.org

@@ -0,0 +1,67 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+begin_export text
+bar
+#+end_export
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+begin_export text
+bar
+#+end_export

org_mode_samples/lesser_element/lesser_block/export/name.org

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

org_mode_samples/lesser_element/lesser_block/src/affiliated_keyword.org

@@ -0,0 +1,67 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+begin_src text
+bar
+#+end_src
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+begin_src text
+bar
+#+end_src

org_mode_samples/lesser_element/lesser_block/src/name.org

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

org_mode_samples/lesser_element/lesser_block/verse/affiliated_keyword.org

@@ -0,0 +1,67 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+#+begin_verse text
+bar
+#+end_verse
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+#+begin_verse text
+bar
+#+end_verse

org_mode_samples/lesser_element/lesser_block/verse/name.org

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

org_mode_samples/lesser_element/paragraph/affiliated_keyword.org

@@ -0,0 +1,63 @@
+#+NAME: a
+#+caption: b *lorem* ipsum
+#+results: c
+#+headers: d
+#+header: e
+#+label: f
+#+plot: g
+#+resname: h
+#+result: i
+#+source: j
+#+srcname: k
+#+tblname: l
+#+attr_latex: m
+#+attr_html: n
+#+NAME: aa
+#+caption: bb *lorem* ipsum
+#+results: cc
+#+headers: dd
+#+header: ee
+#+label: ff
+#+plot: gg
+#+resname: hh
+#+result: ii
+#+source: jj
+#+srcname: kk
+#+tblname: ll
+#+attr_latex: mm
+#+attr_html: nn
+bar
+
+
+
+
+
+#+NAME: A
+#+CAPTION: B *LOREM* IPSUM
+#+RESULTS: C
+#+HEADERS: D
+#+HEADER: E
+#+LABEL: F
+#+PLOT: G
+#+RESNAME: H
+#+RESULT: I
+#+SOURCE: J
+#+SRCNAME: K
+#+TBLNAME: L
+#+ATTR_LATEX: M
+#+ATTR_HTML: N
+#+NAME: AA
+#+CAPTION: BB *LOREM* IPSUM
+#+RESULTS: CC
+#+HEADERS: DD
+#+HEADER: EE
+#+LABEL: FF
+#+PLOT: GG
+#+RESNAME: HH
+#+RESULT: II
+#+SOURCE: JJ
+#+SRCNAME: KK
+#+TBLNAME: LL
+#+ATTR_LATEX: MM
+#+ATTR_HTML: NN
+bar

org_mode_samples/lesser_element/paragraph/name.org

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

org_mode_samples/object/entity/all_entities.org

@@ -0,0 +1,414 @@
+\Agrave{}
+\agrave{}
+\Aacute{}
+\aacute{}
+\Acirc{}
+\acirc{}
+\Amacr{}
+\amacr{}
+\Atilde{}
+\atilde{}
+\Auml{}
+\auml{}
+\Aring{}
+\AA{}
+\aring{}
+\AElig{}
+\aelig{}
+\Ccedil{}
+\ccedil{}
+\Egrave{}
+\egrave{}
+\Eacute{}
+\eacute{}
+\Ecirc{}
+\ecirc{}
+\Euml{}
+\euml{}
+\Igrave{}
+\igrave{}
+\Iacute{}
+\iacute{}
+\Idot{}
+\inodot{}
+\Icirc{}
+\icirc{}
+\Iuml{}
+\iuml{}
+\Ntilde{}
+\ntilde{}
+\Ograve{}
+\ograve{}
+\Oacute{}
+\oacute{}
+\Ocirc{}
+\ocirc{}
+\Otilde{}
+\otilde{}
+\Ouml{}
+\ouml{}
+\Oslash{}
+\oslash{}
+\OElig{}
+\oelig{}
+\Scaron{}
+\scaron{}
+\szlig{}
+\Ugrave{}
+\ugrave{}
+\Uacute{}
+\uacute{}
+\Ucirc{}
+\ucirc{}
+\Uuml{}
+\uuml{}
+\Yacute{}
+\yacute{}
+\Yuml{}
+\yuml{}
+\fnof{}
+\real{}
+\image{}
+\weierp{}
+\ell{}
+\imath{}
+\jmath{}
+\Alpha{}
+\alpha{}
+\Beta{}
+\beta{}
+\Gamma{}
+\gamma{}
+\Delta{}
+\delta{}
+\Epsilon{}
+\epsilon{}
+\varepsilon{}
+\Zeta{}
+\zeta{}
+\Eta{}
+\eta{}
+\Theta{}
+\theta{}
+\thetasym{}
+\vartheta{}
+\Iota{}
+\iota{}
+\Kappa{}
+\kappa{}
+\Lambda{}
+\lambda{}
+\Mu{}
+\mu{}
+\nu{}
+\Nu{}
+\Xi{}
+\xi{}
+\Omicron{}
+\omicron{}
+\Pi{}
+\pi{}
+\Rho{}
+\rho{}
+\Sigma{}
+\sigma{}
+\sigmaf{}
+\varsigma{}
+\Tau{}
+\Upsilon{}
+\upsih{}
+\upsilon{}
+\Phi{}
+\phi{}
+\varphi{}
+\Chi{}
+\chi{}
+\acutex{}
+\Psi{}
+\psi{}
+\tau{}
+\Omega{}
+\omega{}
+\piv{}
+\varpi{}
+\partial{}
+\alefsym{}
+\aleph{}
+\gimel{}
+\beth{}
+\dalet{}
+\ETH{}
+\eth{}
+\THORN{}
+\thorn{}
+\dots{}
+\cdots{}
+\hellip{}
+\middot{}
+\iexcl{}
+\iquest{}
+\shy{}
+\ndash{}
+\mdash{}
+\quot{}
+\acute{}
+\ldquo{}
+\rdquo{}
+\bdquo{}
+\lsquo{}
+\rsquo{}
+\sbquo{}
+\laquo{}
+\raquo{}
+\lsaquo{}
+\rsaquo{}
+\circ{}
+\vert{}
+\vbar{}
+\brvbar{}
+\S{}
+\sect{}
+\P{}
+\para{}
+\amp{}
+\lt{}
+\gt{}
+\tilde{}
+\slash{}
+\plus{}
+\under{}
+\equal{}
+\asciicirc{}
+\dagger{}
+\dag{}
+\Dagger{}
+\ddag{}
+\nbsp{}
+\ensp{}
+\emsp{}
+\thinsp{}
+\curren{}
+\cent{}
+\pound{}
+\yen{}
+\euro{}
+\EUR{}
+\dollar{}
+\USD{}
+\copy{}
+\reg{}
+\trade{}
+\minus{}
+\pm{}
+\plusmn{}
+\times{}
+\frasl{}
+\colon{}
+\div{}
+\frac12{}
+\frac14{}
+\frac34{}
+\permil{}
+\sup1{}
+\sup2{}
+\sup3{}
+\radic{}
+\sum{}
+\prod{}
+\micro{}
+\macr{}
+\deg{}
+\prime{}
+\Prime{}
+\infin{}
+\infty{}
+\prop{}
+\propto{}
+\not{}
+\neg{}
+\land{}
+\wedge{}
+\lor{}
+\vee{}
+\cap{}
+\cup{}
+\smile{}
+\frown{}
+\int{}
+\therefore{}
+\there4{}
+\because{}
+\sim{}
+\cong{}
+\simeq{}
+\asymp{}
+\approx{}
+\ne{}
+\neq{}
+\equiv{}
+\triangleq{}
+\le{}
+\leq{}
+\ge{}
+\geq{}
+\lessgtr{}
+\lesseqgtr{}
+\ll{}
+\Ll{}
+\lll{}
+\gg{}
+\Gg{}
+\ggg{}
+\prec{}
+\preceq{}
+\preccurlyeq{}
+\succ{}
+\succeq{}
+\succcurlyeq{}
+\sub{}
+\subset{}
+\sup{}
+\supset{}
+\nsub{}
+\sube{}
+\nsup{}
+\supe{}
+\setminus{}
+\forall{}
+\exist{}
+\exists{}
+\nexist{}
+\nexists{}
+\empty{}
+\emptyset{}
+\isin{}
+\in{}
+\notin{}
+\ni{}
+\nabla{}
+\ang{}
+\angle{}
+\perp{}
+\parallel{}
+\sdot{}
+\cdot{}
+\lceil{}
+\rceil{}
+\lfloor{}
+\rfloor{}
+\lang{}
+\rang{}
+\langle{}
+\rangle{}
+\hbar{}
+\mho{}
+\larr{}
+\leftarrow{}
+\gets{}
+\lArr{}
+\Leftarrow{}
+\uarr{}
+\uparrow{}
+\uArr{}
+\Uparrow{}
+\rarr{}
+\to{}
+\rightarrow{}
+\rArr{}
+\Rightarrow{}
+\darr{}
+\downarrow{}
+\dArr{}
+\Downarrow{}
+\harr{}
+\leftrightarrow{}
+\hArr{}
+\Leftrightarrow{}
+\crarr{}
+\hookleftarrow{}
+\arccos{}
+\arcsin{}
+\arctan{}
+\arg{}
+\cos{}
+\cosh{}
+\cot{}
+\coth{}
+\csc{}
+\deg{}
+\det{}
+\dim{}
+\exp{}
+\gcd{}
+\hom{}
+\inf{}
+\ker{}
+\lg{}
+\lim{}
+\liminf{}
+\limsup{}
+\ln{}
+\log{}
+\max{}
+\min{}
+\Pr{}
+\sec{}
+\sin{}
+\sinh{}
+\sup{}
+\tan{}
+\tanh{}
+\bull{}
+\bullet{}
+\star{}
+\lowast{}
+\ast{}
+\odot{}
+\oplus{}
+\otimes{}
+\check{}
+\checkmark{}
+\ordf{}
+\ordm{}
+\cedil{}
+\oline{}
+\uml{}
+\zwnj{}
+\zwj{}
+\lrm{}
+\rlm{}
+\smiley{}
+\blacksmile{}
+\sad{}
+\frowny{}
+\clubs{}
+\clubsuit{}
+\spades{}
+\spadesuit{}
+\hearts{}
+\heartsuit{}
+\diams{}
+\diamondsuit{}
+\diamond{}
+\Diamond{}
+\loz{}
+\_ {}
+\_  {}
+\_   {}
+\_    {}
+\_     {}
+\_      {}
+\_       {}
+\_        {}
+\_         {}
+\_          {}
+\_           {}
+\_            {}
+\_             {}
+\_              {}
+\_               {}
+\_                {}
+\_                 {}
+\_                  {}
+\_                   {}
+\_                    {}

org_mode_samples/object/entity/all_entities_without_braces.org

@@ -0,0 +1,414 @@
+\Agrave
+\agrave
+\Aacute
+\aacute
+\Acirc
+\acirc
+\Amacr
+\amacr
+\Atilde
+\atilde
+\Auml
+\auml
+\Aring
+\AA
+\aring
+\AElig
+\aelig
+\Ccedil
+\ccedil
+\Egrave
+\egrave
+\Eacute
+\eacute
+\Ecirc
+\ecirc
+\Euml
+\euml
+\Igrave
+\igrave
+\Iacute
+\iacute
+\Idot
+\inodot
+\Icirc
+\icirc
+\Iuml
+\iuml
+\Ntilde
+\ntilde
+\Ograve
+\ograve
+\Oacute
+\oacute
+\Ocirc
+\ocirc
+\Otilde
+\otilde
+\Ouml
+\ouml
+\Oslash
+\oslash
+\OElig
+\oelig
+\Scaron
+\scaron
+\szlig
+\Ugrave
+\ugrave
+\Uacute
+\uacute
+\Ucirc
+\ucirc
+\Uuml
+\uuml
+\Yacute
+\yacute
+\Yuml
+\yuml
+\fnof
+\real
+\image
+\weierp
+\ell
+\imath
+\jmath
+\Alpha
+\alpha
+\Beta
+\beta
+\Gamma
+\gamma
+\Delta
+\delta
+\Epsilon
+\epsilon
+\varepsilon
+\Zeta
+\zeta
+\Eta
+\eta
+\Theta
+\theta
+\thetasym
+\vartheta
+\Iota
+\iota
+\Kappa
+\kappa
+\Lambda
+\lambda
+\Mu
+\mu
+\nu
+\Nu
+\Xi
+\xi
+\Omicron
+\omicron
+\Pi
+\pi
+\Rho
+\rho
+\Sigma
+\sigma
+\sigmaf
+\varsigma
+\Tau
+\Upsilon
+\upsih
+\upsilon
+\Phi
+\phi
+\varphi
+\Chi
+\chi
+\acutex
+\Psi
+\psi
+\tau
+\Omega
+\omega
+\piv
+\varpi
+\partial
+\alefsym
+\aleph
+\gimel
+\beth
+\dalet
+\ETH
+\eth
+\THORN
+\thorn
+\dots
+\cdots
+\hellip
+\middot
+\iexcl
+\iquest
+\shy
+\ndash
+\mdash
+\quot
+\acute
+\ldquo
+\rdquo
+\bdquo
+\lsquo
+\rsquo
+\sbquo
+\laquo
+\raquo
+\lsaquo
+\rsaquo
+\circ
+\vert
+\vbar
+\brvbar
+\S
+\sect
+\P
+\para
+\amp
+\lt
+\gt
+\tilde
+\slash
+\plus
+\under
+\equal
+\asciicirc
+\dagger
+\dag
+\Dagger
+\ddag
+\nbsp
+\ensp
+\emsp
+\thinsp
+\curren
+\cent
+\pound
+\yen
+\euro
+\EUR
+\dollar
+\USD
+\copy
+\reg
+\trade
+\minus
+\pm
+\plusmn
+\times
+\frasl
+\colon
+\div
+\frac12
+\frac14
+\frac34
+\permil
+\sup1
+\sup2
+\sup3
+\radic
+\sum
+\prod
+\micro
+\macr
+\deg
+\prime
+\Prime
+\infin
+\infty
+\prop
+\propto
+\not
+\neg
+\land
+\wedge
+\lor
+\vee
+\cap
+\cup
+\smile
+\frown
+\int
+\therefore
+\there4
+\because
+\sim
+\cong
+\simeq
+\asymp
+\approx
+\ne
+\neq
+\equiv
+\triangleq
+\le
+\leq
+\ge
+\geq
+\lessgtr
+\lesseqgtr
+\ll
+\Ll
+\lll
+\gg
+\Gg
+\ggg
+\prec
+\preceq
+\preccurlyeq
+\succ
+\succeq
+\succcurlyeq
+\sub
+\subset
+\sup
+\supset
+\nsub
+\sube
+\nsup
+\supe
+\setminus
+\forall
+\exist
+\exists
+\nexist
+\nexists
+\empty
+\emptyset
+\isin
+\in
+\notin
+\ni
+\nabla
+\ang
+\angle
+\perp
+\parallel
+\sdot
+\cdot
+\lceil
+\rceil
+\lfloor
+\rfloor
+\lang
+\rang
+\langle
+\rangle
+\hbar
+\mho
+\larr
+\leftarrow
+\gets
+\lArr
+\Leftarrow
+\uarr
+\uparrow
+\uArr
+\Uparrow
+\rarr
+\to
+\rightarrow
+\rArr
+\Rightarrow
+\darr
+\downarrow
+\dArr
+\Downarrow
+\harr
+\leftrightarrow
+\hArr
+\Leftrightarrow
+\crarr
+\hookleftarrow
+\arccos
+\arcsin
+\arctan
+\arg
+\cos
+\cosh
+\cot
+\coth
+\csc
+\deg
+\det
+\dim
+\exp
+\gcd
+\hom
+\inf
+\ker
+\lg
+\lim
+\liminf
+\limsup
+\ln
+\log
+\max
+\min
+\Pr
+\sec
+\sin
+\sinh
+\sup
+\tan
+\tanh
+\bull
+\bullet
+\star
+\lowast
+\ast
+\odot
+\oplus
+\otimes
+\check
+\checkmark
+\ordf
+\ordm
+\cedil
+\oline
+\uml
+\zwnj
+\zwj
+\lrm
+\rlm
+\smiley
+\blacksmile
+\sad
+\frowny
+\clubs
+\clubsuit
+\spades
+\spadesuit
+\hearts
+\heartsuit
+\diams
+\diamondsuit
+\diamond
+\Diamond
+\loz
+\_ 
+\_  
+\_   
+\_    
+\_     
+\_      
+\_       
+\_        
+\_         
+\_          
+\_           
+\_            
+\_             
+\_              
+\_               
+\_                
+\_                 
+\_                  
+\_                   
+\_                    

org_mode_samples/object/inline_babel_call/simple.org

@@ -1,3 +1,4 @@
+call_foo()
 call_foo(arguments)
 call_bar[header](arguments)
 call_baz(arguments)[header]

org_mode_samples/object/inline_source_block/simple.org

@@ -1,2 +1,3 @@
-before src_foo{ipsum} after
-src_bar[lorem]{ipsum}
+src_foo{}
+before src_bar{lorem} after
+src_baz[ipsum]{dolar}

org_mode_samples/object/macro/capitalize.org

@@ -0,0 +1 @@
+{{{Foo(Bar,Baz)}}}

org_mode_samples/object/text_markup/double_star.org

@@ -1 +1,3 @@
+**foo**
+
 foo ** bar ** baz

org_mode_samples/object/text_markup/double_underscore.org

@@ -0,0 +1 @@
+__foo_bar_baz__

org_mode_samples/object/text_markup/italic_bold.org

@@ -0,0 +1 @@
+/*foo*/

org_mode_samples/sections_and_headings/name.org

@@ -0,0 +1,3 @@
+#+NAME: foo
+* bar
+#+NAME: baz

scripts/dump_ast.bash

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+#
+# Dump the AST of an org-mode document from emacs
+set -euo pipefail
+IFS=$'\n\t'
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+REALPATH=$(command -v uu-realpath || command -v realpath)
+MAKE=$(command -v gmake || command -v make)
+
+############## Setup #########################
+
+function die {
+    local status_code="$1"
+    shift
+    (>&2 echo "${@}")
+    exit "$status_code"
+}
+
+function log {
+    (>&2 echo "${@}")
+}
+
+############## Program #########################
+
+function main {
+    if [ $# -eq 0 ]; then
+        dump_ast_stdin "${@}"
+    else
+        dump_ast_file "${@}"
+    fi
+}
+
+function dump_ast_stdin {
+    # Until we can find a good way to encode stdin as an elisp string in bash, I cannot operate on stdin.
+    die 1 "This script only works on files."
+}
+
+function dump_ast_file {
+    local target_file mounted_file elisp_script
+    target_file=$($REALPATH "$1")
+    mounted_file="/input${target_file}"
+    elisp_script=$(cat <<EOF
+(progn
+     (erase-buffer)
+     (require 'org)
+     (defun org-table-align () t)
+     (find-file-read-only "${mounted_file}")
+     (org-mode)
+     (message "%s" (pp-to-string (org-element-parse-buffer)))
+)
+EOF
+          )
+    exec docker run --init --rm -i --mount type=tmpfs,destination=/tmp -v "/:/input:ro" --entrypoint "" organic-test emacs -q --no-site-file --no-splash --batch --eval "$elisp_script"
+}
+
+
+main "${@}"

scripts/perf.bash

@@ -14,7 +14,7 @@ function main {
         additional_flags+=(--profile "$PROFILE")
     fi
     (cd "$DIR/../" && cargo build --no-default-features "${additional_flags[@]}")
-    perf record --freq=2000 --call-graph dwarf --output="$DIR/../perf.data" "$DIR/../target/${PROFILE}/parse" "${@}"
+    perf record --freq=70000 --call-graph dwarf --output="$DIR/../perf.data" "$DIR/../target/${PROFILE}/parse" "${@}"
 
     # Convert to a format firefox will read
     # flags to consider --show-info

src/bin_compare.rs

@@ -14,30 +14,40 @@ mod init_tracing;
 
 #[cfg(not(feature = "tracing"))]
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    main_body()
+    let rt = tokio::runtime::Runtime::new()?;
+    rt.block_on(async {
+        let main_body_result = main_body().await;
+        main_body_result
+    })
 }
 
 #[cfg(feature = "tracing")]
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let rt = tokio::runtime::Runtime::new()?;
-    let result = rt.block_on(async {
+    rt.block_on(async {
         init_telemetry()?;
-        let main_body_result = main_body();
+        let main_body_result = main_body().await;
         shutdown_telemetry()?;
         main_body_result
-    });
-    result
+    })
 }
 
 #[cfg_attr(feature = "tracing", tracing::instrument(ret, level = "debug"))]
-fn main_body() -> Result<(), Box<dyn std::error::Error>> {
+async fn main_body() -> Result<(), Box<dyn std::error::Error>> {
     let args = std::env::args().skip(1);
     if args.is_empty() {
         let org_contents = read_stdin_to_string()?;
-        run_anonymous_compare(org_contents)
+        if run_anonymous_compare(org_contents).await? {
+        } else {
+            Err("Diff results do not match.")?;
+        }
+        Ok(())
     } else {
         for arg in args {
-            run_compare_on_file(arg)?
+            if run_compare_on_file(arg).await? {
+            } else {
+                Err("Diff results do not match.")?;
+            }
         }
         Ok(())
     }

src/bin_foreign_document_test.rs

@@ -0,0 +1,394 @@
+#![feature(round_char_boundary)]
+#![feature(exact_size_is_empty)]
+use std::path::Path;
+use std::path::PathBuf;
+use std::process::ExitCode;
+
+use futures::future::BoxFuture;
+use futures::future::FutureExt;
+use organic::compare::silent_compare_on_file;
+use tokio::sync::Semaphore;
+use tokio::task::JoinError;
+use walkdir::WalkDir;
+
+#[cfg(feature = "tracing")]
+use crate::init_tracing::init_telemetry;
+#[cfg(feature = "tracing")]
+use crate::init_tracing::shutdown_telemetry;
+#[cfg(feature = "tracing")]
+mod init_tracing;
+
+#[cfg(not(feature = "tracing"))]
+fn main() -> Result<ExitCode, Box<dyn std::error::Error>> {
+    let rt = tokio::runtime::Runtime::new()?;
+    rt.block_on(async {
+        let main_body_result = main_body().await;
+        main_body_result
+    })
+}
+
+#[cfg(feature = "tracing")]
+fn main() -> Result<ExitCode, Box<dyn std::error::Error>> {
+    let rt = tokio::runtime::Runtime::new()?;
+    rt.block_on(async {
+        init_telemetry()?;
+        let main_body_result = main_body().await;
+        shutdown_telemetry()?;
+        main_body_result
+    })
+}
+
+#[cfg_attr(feature = "tracing", tracing::instrument(ret, level = "debug"))]
+async fn main_body() -> Result<ExitCode, Box<dyn std::error::Error>> {
+    let layer = compare_group("org-mode", || {
+        compare_all_org_document("/foreign_documents/org-mode")
+    });
+    let layer = layer.chain(compare_group("emacs", || {
+        compare_all_org_document("/foreign_documents/emacs")
+    }));
+    let layer = layer.chain(compare_group("worg", || {
+        compare_all_org_document("/foreign_documents/worg")
+    }));
+    let layer = layer.chain(compare_group("howard_abrams", compare_howard_abrams));
+    let layer = layer.chain(compare_group("doomemacs", || {
+        compare_all_org_document("/foreign_documents/doomemacs")
+    }));
+
+    let running_tests: Vec<_> = layer.map(|c| tokio::spawn(c.run_test())).collect();
+    let mut any_failed = false;
+    for test in running_tests.into_iter() {
+        let test_result = test.await??;
+        if test_result.is_immediately_bad() || test_result.has_bad_children() {
+            any_failed = true;
+        }
+        test_result.print();
+    }
+
+    if any_failed {
+        println!(
+            "{color}Some tests failed.{reset}",
+            color = TestResult::foreground_color(255, 0, 0),
+            reset = TestResult::reset_color(),
+        );
+        Ok(ExitCode::FAILURE)
+    } else {
+        println!(
+            "{color}All tests passed.{reset}",
+            color = TestResult::foreground_color(0, 255, 0),
+            reset = TestResult::reset_color(),
+        );
+        Ok(ExitCode::SUCCESS)
+    }
+}
+
+fn compare_howard_abrams() -> impl Iterator<Item = TestConfig> {
+    let layer = compare_group("dot-files", || {
+        compare_all_org_document("/foreign_documents/howardabrams/dot-files")
+    });
+    let layer = layer.chain(compare_group("hamacs", || {
+        compare_all_org_document("/foreign_documents/howardabrams/hamacs")
+    }));
+    let layer = layer.chain(compare_group("demo-it", || {
+        compare_all_org_document("/foreign_documents/howardabrams/demo-it")
+    }));
+    let layer = layer.chain(compare_group("magit-demo", || {
+        compare_all_org_document("/foreign_documents/howardabrams/magit-demo")
+    }));
+    let layer = layer.chain(compare_group("pdx-emacs-hackers", || {
+        compare_all_org_document("/foreign_documents/howardabrams/pdx-emacs-hackers")
+    }));
+    let layer = layer.chain(compare_group("flora-simulator", || {
+        compare_all_org_document("/foreign_documents/howardabrams/flora-simulator")
+    }));
+    let layer = layer.chain(compare_group("literate-devops-demo", || {
+        compare_all_org_document("/foreign_documents/howardabrams/literate-devops-demo")
+    }));
+    let layer = layer.chain(compare_group("clojure-yesql-xp", || {
+        compare_all_org_document("/foreign_documents/howardabrams/clojure-yesql-xp")
+    }));
+    layer.chain(compare_group("veep", || {
+        compare_all_org_document("/foreign_documents/howardabrams/veep")
+    }))
+}
+
+fn compare_group<N: Into<String>, F: Fn() -> I, I: Iterator<Item = TestConfig>>(
+    name: N,
+    inner: F,
+) -> impl Iterator<Item = TestConfig> {
+    std::iter::once(TestConfig::TestLayer(TestLayer {
+        name: name.into(),
+        children: inner().collect(),
+    }))
+}
+
+fn compare_all_org_document<P: AsRef<Path>>(root_dir: P) -> impl Iterator<Item = TestConfig> {
+    let root_dir = root_dir.as_ref();
+    let mut test_files = WalkDir::new(root_dir)
+        .into_iter()
+        .filter(|e| match e {
+            Ok(dir_entry) => {
+                dir_entry.file_type().is_file()
+                    && Path::new(dir_entry.file_name())
+                        .extension()
+                        .map(|ext| ext.to_ascii_lowercase() == "org")
+                        .unwrap_or(false)
+            }
+            Err(_) => true,
+        })
+        .collect::<Result<Vec<_>, _>>()
+        .unwrap();
+    test_files.sort_by_cached_key(|test_file| PathBuf::from(test_file.path()));
+    let test_configs: Vec<_> = test_files
+        .into_iter()
+        .map(|test_file| {
+            let name = test_file
+                .path()
+                .strip_prefix(root_dir)
+                .expect("Result is from walkdir so it must be below the root directory.")
+                .as_os_str()
+                .to_string_lossy()
+                .into_owned();
+            TestConfig::SingleFile(SingleFile {
+                name,
+                file_path: test_file.into_path(),
+            })
+        })
+        .collect();
+    test_configs.into_iter()
+}
+
+static TEST_PERMITS: Semaphore = Semaphore::const_new(8);
+
+#[derive(Debug)]
+enum TestConfig {
+    TestLayer(TestLayer),
+    SingleFile(SingleFile),
+}
+
+#[derive(Debug)]
+struct TestLayer {
+    name: String,
+    children: Vec<TestConfig>,
+}
+
+#[derive(Debug)]
+struct SingleFile {
+    name: String,
+    file_path: PathBuf,
+}
+
+#[derive(Debug)]
+enum TestResult {
+    ResultLayer(ResultLayer),
+    SingleFileResult(SingleFileResult),
+}
+
+#[derive(Debug)]
+struct ResultLayer {
+    name: String,
+    children: Vec<TestResult>,
+}
+
+#[derive(Debug)]
+struct SingleFileResult {
+    name: String,
+    status: TestStatus,
+}
+
+#[derive(Debug)]
+pub(crate) enum TestStatus {
+    Pass,
+    Fail,
+}
+
+impl TestConfig {
+    fn run_test(self) -> BoxFuture<'static, Result<TestResult, JoinError>> {
+        async move {
+            match self {
+                TestConfig::TestLayer(test) => Ok(TestResult::ResultLayer(test.run_test().await?)),
+                TestConfig::SingleFile(test) => {
+                    Ok(TestResult::SingleFileResult(test.run_test().await?))
+                }
+            }
+        }
+        .boxed()
+    }
+}
+
+impl SingleFile {
+    async fn run_test(self) -> Result<SingleFileResult, JoinError> {
+        let _permit = TEST_PERMITS.acquire().await.unwrap();
+        let result = silent_compare_on_file(&self.file_path).await;
+        Ok(SingleFileResult {
+            name: self.name,
+            status: if let Ok(true) = result {
+                TestStatus::Pass
+            } else {
+                TestStatus::Fail
+            },
+        })
+    }
+}
+
+impl TestLayer {
+    async fn run_test(self) -> Result<ResultLayer, JoinError> {
+        let running_children: Vec<_> = self
+            .children
+            .into_iter()
+            .map(|c| tokio::spawn(c.run_test()))
+            .collect();
+        let mut children = Vec::with_capacity(running_children.len());
+        for c in running_children {
+            children.push(c.await??);
+        }
+        Ok(ResultLayer {
+            name: self.name,
+            children,
+        })
+    }
+}
+
+impl TestResult {
+    pub fn print(&self) {
+        self.print_indented(0);
+    }
+
+    fn print_indented(&self, indentation: usize) {
+        match self {
+            TestResult::ResultLayer(result) => result.print_indented(indentation),
+            TestResult::SingleFileResult(result) => result.print_indented(indentation),
+        }
+    }
+
+    fn has_bad_children(&self) -> bool {
+        match self {
+            TestResult::ResultLayer(result) => result.has_bad_children(),
+            TestResult::SingleFileResult(result) => result.has_bad_children(),
+        }
+    }
+
+    fn is_immediately_bad(&self) -> bool {
+        match self {
+            TestResult::ResultLayer(result) => result.is_immediately_bad(),
+            TestResult::SingleFileResult(result) => result.is_immediately_bad(),
+        }
+    }
+
+    pub(crate) fn foreground_color(red: u8, green: u8, blue: u8) -> String {
+        if TestResult::should_use_color() {
+            format!(
+                "\x1b[38;2;{red};{green};{blue}m",
+                red = red,
+                green = green,
+                blue = blue
+            )
+        } else {
+            String::new()
+        }
+    }
+
+    #[allow(dead_code)]
+    pub(crate) fn background_color(red: u8, green: u8, blue: u8) -> String {
+        if TestResult::should_use_color() {
+            format!(
+                "\x1b[48;2;{red};{green};{blue}m",
+                red = red,
+                green = green,
+                blue = blue
+            )
+        } else {
+            String::new()
+        }
+    }
+
+    pub(crate) fn reset_color() -> &'static str {
+        if TestResult::should_use_color() {
+            "\x1b[0m"
+        } else {
+            ""
+        }
+    }
+
+    fn should_use_color() -> bool {
+        !std::env::var("NO_COLOR").is_ok_and(|val| !val.is_empty())
+    }
+}
+
+impl SingleFileResult {
+    fn print_indented(&self, indentation: usize) {
+        match self.status {
+            TestStatus::Pass => {
+                println!(
+                    "{indentation}{color}PASS{reset} {name}",
+                    indentation = "  ".repeat(indentation),
+                    color = TestResult::foreground_color(0, 255, 0),
+                    reset = TestResult::reset_color(),
+                    name = self.name
+                );
+            }
+            TestStatus::Fail => {
+                println!(
+                    "{indentation}{color}FAIL{reset} {name}",
+                    indentation = "  ".repeat(indentation),
+                    color = TestResult::foreground_color(255, 0, 0),
+                    reset = TestResult::reset_color(),
+                    name = self.name
+                );
+            }
+        }
+    }
+
+    fn has_bad_children(&self) -> bool {
+        false
+    }
+
+    fn is_immediately_bad(&self) -> bool {
+        match self.status {
+            TestStatus::Pass => false,
+            TestStatus::Fail => true,
+        }
+    }
+}
+
+impl ResultLayer {
+    fn print_indented(&self, indentation: usize) {
+        if self.is_immediately_bad() {
+            println!(
+                "{indentation}{color}FAIL{reset} {name}",
+                indentation = "  ".repeat(indentation),
+                color = TestResult::foreground_color(255, 0, 0),
+                reset = TestResult::reset_color(),
+                name = self.name
+            );
+        } else if self.has_bad_children() {
+            println!(
+                "{indentation}{color}BADCHILD{reset} {name}",
+                indentation = "  ".repeat(indentation),
+                color = TestResult::foreground_color(255, 255, 0),
+                reset = TestResult::reset_color(),
+                name = self.name
+            );
+        } else {
+            println!(
+                "{indentation}{color}PASS{reset} {name}",
+                indentation = "  ".repeat(indentation),
+                color = TestResult::foreground_color(0, 255, 0),
+                reset = TestResult::reset_color(),
+                name = self.name
+            );
+        }
+        self.children
+            .iter()
+            .for_each(|result| result.print_indented(indentation + 1));
+    }
+
+    fn has_bad_children(&self) -> bool {
+        self.children
+            .iter()
+            .any(|result| result.is_immediately_bad() || result.has_bad_children())
+    }
+
+    fn is_immediately_bad(&self) -> bool {
+        false
+    }
+}

src/compare/compare.rs

@@ -12,39 +12,60 @@ use crate::context::LocalFileAccessInterface;
 use crate::parser::parse_file_with_settings;
 use crate::parser::parse_with_settings;
 
-pub fn run_anonymous_compare<P: AsRef<str>>(
+pub async fn run_anonymous_compare<P: AsRef<str>>(
     org_contents: P,
-) -> Result<(), Box<dyn std::error::Error>> {
-    run_anonymous_compare_with_settings(org_contents, &GlobalSettings::default())
+) -> Result<bool, Box<dyn std::error::Error>> {
+    run_anonymous_compare_with_settings(org_contents, &GlobalSettings::default(), false).await
 }
 
-pub fn run_compare_on_file<P: AsRef<Path>>(org_path: P) -> Result<(), Box<dyn std::error::Error>> {
-    run_compare_on_file_with_settings(org_path, &GlobalSettings::default())
+pub async fn run_compare_on_file<P: AsRef<Path>>(
+    org_path: P,
+) -> Result<bool, Box<dyn std::error::Error>> {
+    run_compare_on_file_with_settings(org_path, &GlobalSettings::default(), false).await
 }
 
-pub fn run_anonymous_compare_with_settings<P: AsRef<str>>(
+pub async fn silent_anonymous_compare<P: AsRef<str>>(
     org_contents: P,
-    global_settings: &GlobalSettings,
-) -> Result<(), Box<dyn std::error::Error>> {
+) -> Result<bool, Box<dyn std::error::Error>> {
+    run_anonymous_compare_with_settings(org_contents, &GlobalSettings::default(), true).await
+}
+
+pub async fn silent_compare_on_file<P: AsRef<Path>>(
+    org_path: P,
+) -> Result<bool, Box<dyn std::error::Error>> {
+    run_compare_on_file_with_settings(org_path, &GlobalSettings::default(), true).await
+}
+
+pub async fn run_anonymous_compare_with_settings<'g, 's, P: AsRef<str>>(
+    org_contents: P,
+    global_settings: &GlobalSettings<'g, 's>,
+    silent: bool,
+) -> Result<bool, Box<dyn std::error::Error>> {
     // TODO: This is a work-around to pretend that dos line endings do not exist. It would be better to handle the difference in line endings.
     let org_contents = org_contents.as_ref().replace("\r\n", "\n");
     let org_contents = org_contents.as_str();
-    print_versions()?;
+    if !silent {
+        print_versions().await?;
+    }
     let rust_parsed = parse_with_settings(org_contents, global_settings)?;
-    let org_sexp = emacs_parse_anonymous_org_document(org_contents, global_settings)?;
+    let org_sexp = emacs_parse_anonymous_org_document(org_contents, global_settings).await?;
     let (_remaining, parsed_sexp) = sexp(org_sexp.as_str()).map_err(|e| e.to_string())?;
 
-    println!("{}\n\n\n", org_contents);
-    println!("{}", org_sexp);
-    println!("{:#?}", rust_parsed);
+    if !silent {
+        println!("{}\n\n\n", org_contents);
+        println!("{}", org_sexp);
+        println!("{:#?}", rust_parsed);
+    }
 
     // We do the diffing after printing out both parsed forms in case the diffing panics
     let diff_result = compare_document(&parsed_sexp, &rust_parsed)?;
-    diff_result.print(org_contents)?;
+    if !silent {
+        diff_result.print(org_contents)?;
+    }
 
     if diff_result.is_bad() {
-        Err("Diff results do not match.")?;
-    } else {
+        return Ok(false);
+    } else if !silent {
         println!(
             "{color}Entire document passes.{reset}",
             color = DiffResult::foreground_color(0, 255, 0),
@@ -52,15 +73,18 @@ pub fn run_anonymous_compare_with_settings<P: AsRef<str>>(
         );
     }
 
-    Ok(())
+    Ok(true)
 }
 
-pub fn run_compare_on_file_with_settings<P: AsRef<Path>>(
+pub async fn run_compare_on_file_with_settings<'g, 's, P: AsRef<Path>>(
     org_path: P,
-    global_settings: &GlobalSettings,
-) -> Result<(), Box<dyn std::error::Error>> {
+    global_settings: &GlobalSettings<'g, 's>,
+    silent: bool,
+) -> Result<bool, Box<dyn std::error::Error>> {
     let org_path = org_path.as_ref();
-    print_versions()?;
+    if !silent {
+        print_versions().await?;
+    }
     let parent_directory = org_path
         .parent()
         .ok_or("Should be contained inside a directory.")?;
@@ -77,20 +101,24 @@ pub fn run_compare_on_file_with_settings<P: AsRef<Path>>(
         global_settings
     };
     let rust_parsed = parse_file_with_settings(org_contents, &global_settings, Some(org_path))?;
-    let org_sexp = emacs_parse_file_org_document(org_path, &global_settings)?;
+    let org_sexp = emacs_parse_file_org_document(org_path, &global_settings).await?;
     let (_remaining, parsed_sexp) = sexp(org_sexp.as_str()).map_err(|e| e.to_string())?;
 
-    println!("{}\n\n\n", org_contents);
-    println!("{}", org_sexp);
-    println!("{:#?}", rust_parsed);
+    if !silent {
+        println!("{}\n\n\n", org_contents);
+        println!("{}", org_sexp);
+        println!("{:#?}", rust_parsed);
+    }
 
     // We do the diffing after printing out both parsed forms in case the diffing panics
     let diff_result = compare_document(&parsed_sexp, &rust_parsed)?;
-    diff_result.print(org_contents)?;
+    if !silent {
+        diff_result.print(org_contents)?;
+    }
 
     if diff_result.is_bad() {
-        Err("Diff results do not match.")?;
-    } else {
+        return Ok(false);
+    } else if !silent {
         println!(
             "{color}Entire document passes.{reset}",
             color = DiffResult::foreground_color(0, 255, 0),
@@ -98,11 +126,14 @@ pub fn run_compare_on_file_with_settings<P: AsRef<Path>>(
         );
     }
 
-    Ok(())
+    Ok(true)
 }
 
-fn print_versions() -> Result<(), Box<dyn std::error::Error>> {
-    eprintln!("Using emacs version: {}", get_emacs_version()?.trim());
-    eprintln!("Using org-mode version: {}", get_org_mode_version()?.trim());
+async fn print_versions() -> Result<(), Box<dyn std::error::Error>> {
+    eprintln!("Using emacs version: {}", get_emacs_version().await?.trim());
+    eprintln!(
+        "Using org-mode version: {}",
+        get_org_mode_version().await?.trim()
+    );
     Ok(())
 }

src/compare/compare_field.rs

@@ -1,49 +1,86 @@
+use std::collections::BTreeSet;
 use std::fmt::Debug;
+use std::str::FromStr;
 
+use super::diff::artificial_diff_scope;
+use super::diff::artificial_owned_diff_scope;
+use super::diff::compare_ast_node;
+use super::diff::DiffEntry;
 use super::diff::DiffStatus;
 use super::sexp::unquote;
 use super::sexp::Token;
 use super::util::get_property;
+use super::util::get_property_numeric;
 use super::util::get_property_quoted_string;
 use super::util::get_property_unquoted_atom;
+use crate::types::AstNode;
+use crate::types::CharOffsetInLine;
+use crate::types::LineNumber;
+use crate::types::RetainLabels;
+use crate::types::SwitchNumberLines;
 
 #[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)
+#[derive(Debug)]
+pub(crate) enum ComparePropertiesResult<'b, 's> {
+    NoChange,
+    /// Return when you want the status for "this" node to change (as opposed to collecting child status).
+    SelfChange(DiffStatus, Option<String>),
+    DiffEntry(DiffEntry<'b, 's>),
+}
+
+impl<'b, 's> ComparePropertiesResult<'b, 's> {
+    pub(crate) fn apply(
+        self,
+        child_status: &mut Vec<DiffEntry<'b, 's>>,
+        this_status: &mut DiffStatus,
+        message: &mut Option<String>,
+    ) {
+        match self {
+            ComparePropertiesResult::NoChange => {}
+            ComparePropertiesResult::SelfChange(new_status, new_message) => {
+                *this_status = new_status;
+                *message = new_message
+            }
+            ComparePropertiesResult::DiffEntry(diff_entry) => child_status.push(diff_entry),
+        }
+
+        // foo
+    }
 }
 
 /// 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() -> () {
-    ()
+pub(crate) fn compare_noop<'b, 's, R, RG>(
+    _source: &'s str,
+    _emacs: &'b Token<'s>,
+    _rust_node: R,
+    _emacs_field: &str,
+    _rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>> {
+    Ok(ComparePropertiesResult::NoChange)
 }
 
+/// 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.
+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>(
+pub(crate) fn compare_property_always_nil<'b, 's, R, RG>(
+    _source: &'s str,
     emacs: &'b Token<'s>,
     _rust_node: R,
-    emacs_field: &'x str,
+    emacs_field: &str,
     _rust_value_getter: RG,
-) -> Result<Option<(DiffStatus, Option<String>)>, Box<dyn std::error::Error>> {
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>> {
     let value = get_property(emacs, emacs_field)?;
     if value.is_some() {
         let this_status = DiffStatus::Bad;
@@ -51,45 +88,46 @@ pub(crate) fn compare_property_always_nil<'b, 's, 'x, R, RG>(
             "{} was expected to always be nil: {:?}",
             emacs_field, value
         ));
-        Ok(Some((this_status, message)))
+        Ok(ComparePropertiesResult::SelfChange(this_status, message))
     } else {
-        Ok(None)
+        Ok(ComparePropertiesResult::NoChange)
     }
 }
 
 pub(crate) fn compare_property_quoted_string<
     'b,
     's,
-    'x,
     R,
     RV: AsRef<str> + std::fmt::Debug,
     RG: Fn(R) -> Option<RV>,
 >(
+    _source: &'s str,
     emacs: &'b Token<'s>,
     rust_node: R,
-    emacs_field: &'x str,
+    emacs_field: &str,
     rust_value_getter: RG,
-) -> Result<Option<(DiffStatus, Option<String>)>, Box<dyn std::error::Error>> {
+) -> Result<ComparePropertiesResult<'b, 's>, 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) {
+    if rust_value.as_ref().map(|s| s.as_ref()) != value.as_deref() {
         let this_status = DiffStatus::Bad;
         let message = Some(format!(
             "{} mismatch (emacs != rust) {:?} != {:?}",
             emacs_field, value, rust_value
         ));
-        Ok(Some((this_status, message)))
+        Ok(ComparePropertiesResult::SelfChange(this_status, message))
     } else {
-        Ok(None)
+        Ok(ComparePropertiesResult::NoChange)
     }
 }
 
 pub(crate) fn compare_property_unquoted_atom<'b, 's, 'x, R, RG: Fn(R) -> Option<&'s str>>(
+    _source: &'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>> {
+) -> Result<ComparePropertiesResult<'b, 's>, 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 {
@@ -98,26 +136,58 @@ pub(crate) fn compare_property_unquoted_atom<'b, 's, 'x, R, RG: Fn(R) -> Option<
             "{} mismatch (emacs != rust) {:?} != {:?}",
             emacs_field, value, rust_value
         ));
-        Ok(Some((this_status, message)))
+        Ok(ComparePropertiesResult::SelfChange(this_status, message))
     } else {
-        Ok(None)
+        Ok(ComparePropertiesResult::NoChange)
+    }
+}
+
+pub(crate) fn compare_property_numeric<
+    'b,
+    's,
+    'x,
+    R,
+    RV: FromStr + PartialEq + Debug,
+    RG: Fn(R) -> Option<RV>,
+>(
+    _source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error + 's>>
+where
+    <RV as FromStr>::Err: std::error::Error,
+    <RV as FromStr>::Err: 's,
+{
+    let value = get_property_numeric::<RV>(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(ComparePropertiesResult::SelfChange(this_status, message))
+    } else {
+        Ok(ComparePropertiesResult::NoChange)
     }
 }
 
 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>,
 >(
+    _source: &'s str,
     emacs: &'b Token<'s>,
     rust_node: R,
-    emacs_field: &'x str,
+    emacs_field: &str,
     rust_value_getter: RG,
-) -> Result<Option<(DiffStatus, Option<String>)>, Box<dyn std::error::Error>> {
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>> {
     let value = get_property(emacs, emacs_field)?
         .map(Token::as_list)
         .map_or(Ok(None), |r| r.map(Some))?;
@@ -132,7 +202,7 @@ pub(crate) fn compare_property_list_of_quoted_string<
                 "{} mismatch (emacs != rust) {:?} != {:?}",
                 emacs_field, value, rust_value
             ));
-            return Ok(Some((this_status, message)));
+            return Ok(ComparePropertiesResult::SelfChange(this_status, message));
         }
         (Some(el), Some(rl)) if el.len() != rl.len() => {
             let this_status = DiffStatus::Bad;
@@ -140,7 +210,7 @@ pub(crate) fn compare_property_list_of_quoted_string<
                 "{} mismatch (emacs != rust) {:?} != {:?}",
                 emacs_field, value, rust_value
             ));
-            return Ok(Some((this_status, message)));
+            return Ok(ComparePropertiesResult::SelfChange(this_status, message));
         }
         (Some(el), Some(rl)) => {
             for (e, r) in el.iter().zip(rl) {
@@ -152,10 +222,524 @@ pub(crate) fn compare_property_list_of_quoted_string<
                         "{} mismatch (emacs != rust) {:?} != {:?}. Full list: {:?} != {:?}",
                         emacs_field, e, r, value, rust_value
                     ));
-                    return Ok(Some((this_status, message)));
+                    return Ok(ComparePropertiesResult::SelfChange(this_status, message));
                 }
             }
         }
     }
-    Ok(None)
+    Ok(ComparePropertiesResult::NoChange)
+}
+
+pub(crate) fn compare_property_set_of_quoted_string<
+    'a,
+    'b,
+    's,
+    'x,
+    R,
+    RV: AsRef<str> + std::fmt::Debug + Ord + 'a + ?Sized,
+    RI: Iterator<Item = &'a RV>,
+    RG: Fn(R) -> Option<RI>,
+>(
+    _source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, 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 empty = Vec::new();
+    let value = value.unwrap_or(&empty);
+    let rust_value = rust_value_getter(rust_node);
+    let rust_value = if let Some(rust_value) = rust_value {
+        let slices: BTreeSet<&str> = rust_value.map(|rv| rv.as_ref()).collect();
+        slices
+    } else {
+        BTreeSet::new()
+    };
+    let value: Vec<&str> = value
+        .iter()
+        .map(|e| e.as_atom())
+        .collect::<Result<Vec<_>, _>>()?;
+    let value: Vec<String> = value
+        .into_iter()
+        .map(unquote)
+        .collect::<Result<Vec<_>, _>>()?;
+    let value: BTreeSet<&str> = value.iter().map(|e| e.as_str()).collect();
+    let mismatched: Vec<_> = value.symmetric_difference(&rust_value).copied().collect();
+    if !mismatched.is_empty() {
+        let this_status = DiffStatus::Bad;
+        let message = Some(format!(
+            "{} mismatch. Mismatched values: {}",
+            emacs_field,
+            mismatched.join(", ")
+        ));
+        return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+    }
+    Ok(ComparePropertiesResult::NoChange)
+}
+
+pub(crate) fn compare_property_optional_pair<
+    'b,
+    's,
+    R,
+    RV: AsRef<str> + std::fmt::Debug,
+    ROV: AsRef<str> + std::fmt::Debug,
+    RG: Fn(R) -> Option<(Option<ROV>, RV)>,
+>(
+    _source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &str,
+    rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, 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);
+    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(ComparePropertiesResult::SelfChange(this_status, message));
+        }
+        (Some(el), Some((Some(_), _))) if el.len() != 3 => {
+            let this_status = DiffStatus::Bad;
+            let message = Some(format!(
+                "{} mismatch (emacs != rust) {:?} != {:?}",
+                emacs_field, value, rust_value
+            ));
+            return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+        }
+        (Some(el), Some((None, _))) if el.len() != 1 => {
+            let this_status = DiffStatus::Bad;
+            let message = Some(format!(
+                "{} mismatch (emacs != rust) {:?} != {:?}",
+                emacs_field, value, rust_value
+            ));
+            return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+        }
+        (Some(el), Some((Some(orl), rl))) => {
+            let e = el
+                .first()
+                .map(Token::as_atom)
+                .map_or(Ok(None), |r| r.map(Some))?
+                .map(unquote)
+                .map_or(Ok(None), |r| r.map(Some))?
+                .expect("Above match proved length to be 3.");
+            let oe = el
+                .get(2)
+                .map(Token::as_atom)
+                .map_or(Ok(None), |r| r.map(Some))?
+                .map(unquote)
+                .map_or(Ok(None), |r| r.map(Some))?
+                .expect("Above match proved length to be 3.");
+            let r = rl.as_ref();
+            let or = orl.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(ComparePropertiesResult::SelfChange(this_status, message));
+            }
+            if oe != or {
+                let this_status = DiffStatus::Bad;
+                let message = Some(format!(
+                    "{} mismatch (emacs != rust) {:?} != {:?}. Full list: {:?} != {:?}",
+                    emacs_field, e, r, value, rust_value
+                ));
+                return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+            }
+        }
+        (Some(el), Some((None, rl))) => {
+            let e = el
+                .first()
+                .map(Token::as_atom)
+                .map_or(Ok(None), |r| r.map(Some))?
+                .map(unquote)
+                .map_or(Ok(None), |r| r.map(Some))?
+                .expect("Above match proved length to be 1.");
+            let r = rl.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(ComparePropertiesResult::SelfChange(this_status, message));
+            }
+        }
+    }
+    Ok(ComparePropertiesResult::NoChange)
+}
+
+pub(crate) fn compare_property_boolean<'b, 's, R, RG: Fn(R) -> bool>(
+    _source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &str,
+    rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>> {
+    // get_property already converts nil to None.
+    let value = get_property(emacs, emacs_field)?.is_some();
+    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(ComparePropertiesResult::SelfChange(this_status, message))
+    } else {
+        Ok(ComparePropertiesResult::NoChange)
+    }
+}
+
+pub(crate) fn compare_property_single_ast_node<
+    'b,
+    's,
+    'x: 'b + 's,
+    R,
+    RV: std::fmt::Debug,
+    RG: Fn(R) -> Option<RV>,
+>(
+    source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>>
+where
+    AstNode<'b, 's>: From<RV>,
+{
+    let value = get_property(emacs, emacs_field)?;
+    let rust_value = rust_value_getter(rust_node);
+    match (value, rust_value) {
+        (None, None) => {}
+        (None, rv @ Some(_)) | (Some(_), rv @ None) => {
+            let this_status = DiffStatus::Bad;
+            let message = Some(format!(
+                "{} mismatch (emacs != rust) {:?} != {:?}",
+                emacs_field, value, rv
+            ));
+            return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+        }
+        (Some(ev), Some(rv)) => {
+            let child_status: Vec<DiffEntry<'b, 's>> =
+                vec![compare_ast_node(source, ev, rv.into())?];
+            let diff_scope = artificial_diff_scope(emacs_field, child_status)?;
+            return Ok(ComparePropertiesResult::DiffEntry(diff_scope));
+        }
+    }
+    Ok(ComparePropertiesResult::NoChange)
+}
+
+pub(crate) fn compare_property_list_of_ast_nodes<
+    'b,
+    's,
+    'x: 'b + 's,
+    R,
+    RV: std::fmt::Debug,
+    RI: Iterator<Item = RV>,
+    RG: Fn(R) -> Option<RI>,
+>(
+    source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>>
+where
+    AstNode<'b, 's>: From<RV>,
+{
+    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) => {}
+        (Some(el), None)
+            if el.len() == 1 && el.iter().all(|t| matches!(t.as_atom(), Ok(r#""""#))) => {}
+        (None, rv @ Some(_)) | (Some(_), rv @ None) => {
+            let this_status = DiffStatus::Bad;
+            let message = Some(format!(
+                "{} mismatch (emacs != rust) {:?} != {:?}",
+                emacs_field, value, rv
+            ));
+            return Ok(ComparePropertiesResult::SelfChange(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, el, rl
+            ));
+            return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+        }
+        (Some(el), Some(rl)) => {
+            let mut child_status: Vec<DiffEntry<'b, 's>> = Vec::with_capacity(rl.len());
+            for (e, r) in el.iter().zip(rl) {
+                child_status.push(compare_ast_node(source, e, r.into())?);
+            }
+            let diff_scope = artificial_diff_scope(emacs_field, child_status)?;
+            return Ok(ComparePropertiesResult::DiffEntry(diff_scope));
+        }
+    }
+    Ok(ComparePropertiesResult::NoChange)
+}
+
+pub(crate) fn compare_property_object_tree<
+    'b,
+    's,
+    'x,
+    R,
+    RV: std::fmt::Debug + 'b,
+    ROV: std::fmt::Debug + 'b,
+    RI: Iterator<Item = &'b (Option<Vec<ROV>>, Vec<RV>)> + ExactSizeIterator + std::fmt::Debug,
+    RG: Fn(R) -> Option<RI>,
+>(
+    source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>>
+where
+    AstNode<'b, 's>: From<&'b RV>,
+    AstNode<'b, 's>: From<&'b ROV>,
+{
+    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);
+    let (outer_emacs_list, outer_rust_list) = match (value, rust_value) {
+        (None, None) => {
+            return Ok(ComparePropertiesResult::NoChange);
+        }
+        (None, rv @ Some(_)) | (Some(_), rv @ None) => {
+            let this_status = DiffStatus::Bad;
+            let message = Some(format!(
+                "{} mismatch (emacs != rust) {:?} != {:?}",
+                emacs_field, value, rv
+            ));
+            return Ok(ComparePropertiesResult::SelfChange(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, el, rl
+            ));
+            return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+        }
+        (Some(el), Some(rl)) => (el, rl),
+    };
+    let mut full_status: Vec<DiffEntry<'b, 's>> = Vec::with_capacity(outer_rust_list.len());
+
+    for (kw_e, kw_r) in outer_emacs_list.iter().zip(outer_rust_list) {
+        let kw_e = kw_e.as_list()?;
+        let child_status_length = kw_r.1.len() + kw_r.0.as_ref().map(|opt| opt.len()).unwrap_or(0);
+        let mut child_status: Vec<DiffEntry<'b, 's>> = Vec::with_capacity(child_status_length);
+        if let Some(or) = &kw_r.0 {
+            // if optional value
+            let mut kw_e = kw_e.iter();
+            // First element is a list representing the mandatory value.
+            if let Some(val_e) = kw_e.next() {
+                let el = val_e.as_list()?;
+                if el.len() != kw_r.1.len() {
+                    let this_status = DiffStatus::Bad;
+                    let message = Some(format!(
+                        "{} mismatch (emacs != rust) {:?} != {:?}",
+                        emacs_field, kw_e, kw_r
+                    ));
+                    return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+                }
+                for (e, r) in el.iter().zip(kw_r.1.iter()) {
+                    child_status.push(compare_ast_node(source, e, r.into())?);
+                }
+            } else {
+                let this_status = DiffStatus::Bad;
+                let message = Some(format!(
+                    "{} mismatch (emacs != rust) {:?} != {:?}",
+                    emacs_field, kw_e, kw_r
+                ));
+                return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+            }
+            // Remaining elements are the optional value.
+            if kw_e.len() != or.len() {
+                let this_status = DiffStatus::Bad;
+                let message = Some(format!(
+                    "{} mismatch (emacs != rust) {:?} != {:?}",
+                    emacs_field, kw_e, kw_r
+                ));
+                return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+            }
+            for (e, r) in kw_e.zip(or.iter()) {
+                child_status.push(compare_ast_node(source, e, r.into())?);
+            }
+        } else {
+            // if no optional value
+            if !kw_e.len() == 1 {
+                let this_status = DiffStatus::Bad;
+                let message = Some(format!(
+                    "{} mismatch (emacs != rust) {:?} != {:?}",
+                    emacs_field, kw_e, kw_r
+                ));
+                return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+            }
+
+            let e = kw_e
+                .first()
+                .map(Token::as_list)
+                .map_or(Ok(None), |r| r.map(Some))?
+                .expect("The above if-statement proves this will be Some.")
+                .iter();
+            let r = kw_r.1.iter();
+
+            if e.len() != r.len() {
+                let this_status = DiffStatus::Bad;
+                let message = Some(format!(
+                    "{} mismatch (emacs != rust) {:?} != {:?}",
+                    emacs_field, kw_e, kw_r
+                ));
+                return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+            }
+
+            for (e, r) in e.zip(r) {
+                child_status.push(compare_ast_node(source, e, r.into())?);
+            }
+        }
+        if !child_status.is_empty() {
+            let diff_scope = artificial_diff_scope("mandatory value", child_status)?;
+            full_status.push(diff_scope);
+        }
+    }
+
+    if full_status.is_empty() {
+        Ok(ComparePropertiesResult::NoChange)
+    } else {
+        let diff_scope = artificial_owned_diff_scope(emacs_field, full_status)?;
+        Ok(ComparePropertiesResult::DiffEntry(diff_scope))
+    }
+}
+
+pub(crate) fn compare_property_number_lines<
+    'b,
+    's,
+    'x,
+    'y,
+    R,
+    RG: Fn(R) -> Option<&'y SwitchNumberLines>,
+>(
+    _source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>> {
+    let number_lines = get_property(emacs, emacs_field)?;
+    let rust_value = rust_value_getter(rust_node);
+    match (number_lines, &rust_value) {
+        (None, None) => {}
+        (Some(number_lines), Some(rust_number_lines)) => {
+            let token_list = number_lines.as_list()?;
+            let number_type = token_list
+                .get(0)
+                .map(Token::as_atom)
+                .map_or(Ok(None), |r| r.map(Some))?
+                .ok_or(":number-lines should have a type.")?;
+            let number_value = token_list
+                .get(2)
+                .map(Token::as_atom)
+                .map_or(Ok(None), |r| r.map(Some))?
+                .map(|val| val.parse::<LineNumber>())
+                .map_or(Ok(None), |r| r.map(Some))?
+                .ok_or(":number-lines should have a value.")?;
+            match (number_type, number_value, rust_number_lines) {
+                ("new", emacs_val, SwitchNumberLines::New(rust_val)) if emacs_val == *rust_val => {}
+                ("continued", emacs_val, SwitchNumberLines::Continued(rust_val))
+                    if emacs_val == *rust_val => {}
+                _ => {
+                    let this_status = DiffStatus::Bad;
+                    let message = Some(format!(
+                        "{} mismatch (emacs != rust) {:?} != {:?}",
+                        emacs_field, number_lines, rust_value
+                    ));
+                    return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+                }
+            }
+        }
+        _ => {
+            let this_status = DiffStatus::Bad;
+            let message = Some(format!(
+                "{} mismatch (emacs != rust) {:?} != {:?}",
+                emacs_field, number_lines, rust_value
+            ));
+            return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+        }
+    };
+
+    Ok(ComparePropertiesResult::NoChange)
+}
+
+pub(crate) fn compare_property_retain_labels<'b, 's, 'x, 'y, R, RG: Fn(R) -> &'y RetainLabels>(
+    _source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_node: R,
+    emacs_field: &'x str,
+    rust_value_getter: RG,
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error + 's>> {
+    let rust_value = rust_value_getter(rust_node);
+    let retain_labels = get_property_unquoted_atom(emacs, ":retain-labels")?;
+    if let Some(retain_labels) = retain_labels {
+        if retain_labels == "t" {
+            match rust_value {
+                RetainLabels::Yes => {}
+                _ => {
+                    let this_status = DiffStatus::Bad;
+                    let message = Some(format!(
+                        "{} mismatch (emacs != rust) {:?} != {:?}",
+                        emacs_field, retain_labels, rust_value
+                    ));
+                    return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+                }
+            }
+        } else {
+            let retain_labels: CharOffsetInLine = get_property_numeric(emacs, ":retain-labels")?.expect("Cannot be None or else the earlier get_property_unquoted_atom would have been None.");
+            match (retain_labels, rust_value) {
+                (e, RetainLabels::Keep(r)) if e == *r => {}
+                _ => {
+                    let this_status = DiffStatus::Bad;
+                    let message = Some(format!(
+                        "{} mismatch (emacs != rust) {:?} != {:?}",
+                        emacs_field, retain_labels, rust_value
+                    ));
+                    return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+                }
+            }
+        }
+    } else {
+        match rust_value {
+            RetainLabels::No => {}
+            _ => {
+                let this_status = DiffStatus::Bad;
+                let message = Some(format!(
+                    "{} mismatch (emacs != rust) {:?} != {:?}",
+                    emacs_field, retain_labels, rust_value
+                ));
+                return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+            }
+        }
+    }
+
+    Ok(ComparePropertiesResult::NoChange)
 }

src/compare/macros.rs

@@ -30,10 +30,9 @@
 ///     }
 /// ```
 macro_rules! compare_properties {
-    ($emacs:expr, $rust:expr, $(($emacs_field:expr, $rust_value_getter:expr, $compare_fn: expr)),+) => {
+    ($source:expr, $emacs:expr, $rust:expr, $(($emacs_field:expr, $rust_value_getter:expr, $compare_fn: expr)),*) => {
         {
-            let mut this_status = DiffStatus::Good;
-            let mut message: Option<String> = None;
+            let mut new_status = Vec::new();
             let children = $emacs.as_list()?;
             let attributes_child = children
             .iter()
@@ -44,10 +43,9 @@ macro_rules! compare_properties {
             if emacs_keys.contains(":standard-properties") {
                 emacs_keys.remove(":standard-properties");
             } else {
-                this_status = DiffStatus::Bad;
-                message = Some(format!(
+                new_status.push(ComparePropertiesResult::SelfChange(DiffStatus::Bad, Some(format!(
                     "Emacs token lacks :standard-properties field.",
-                ));
+                ))));
             }
             $(
             match $emacs_field {
@@ -58,24 +56,22 @@ macro_rules! compare_properties {
                     emacs_keys.remove(name);
                 },
                 EmacsField::Required(name) => {
-                    this_status = DiffStatus::Bad;
-                    message = Some(format!(
+                    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(", ");
-                this_status = DiffStatus::Bad;
-                message = Some(format!(
+                new_status.push(ComparePropertiesResult::SelfChange(DiffStatus::Bad, Some(format!(
                     "Emacs token had extra field(s): {}",
                     unexpected_keys
-                ));
+                ))));
             }
 
             $(
@@ -87,33 +83,23 @@ macro_rules! compare_properties {
                     name
                 },
             };
-            let result = $compare_fn($emacs, $rust, emacs_name, $rust_value_getter)?;
+            let result = $compare_fn($source, $emacs, $rust, emacs_name, $rust_value_getter)?;
             match result {
-                Some((DiffStatus::Good, _)) => unreachable!("No comparison functions should return Some() when DiffStatus is good."),
-                Some((status, msg)) => {
-                    this_status = status;
-                    message = msg;
-                },
-                _ => {}
-            }
-            )+
-
-            match this_status {
-                DiffStatus::Good => {
-                    let result: Result<_, Box<dyn std::error::Error>> = Ok(None);
-                    result
-                },
-                _ => {
-                    Ok(Some((this_status, message)))
+                ComparePropertiesResult::SelfChange(DiffStatus::Good, _) => unreachable!("No comparison functions should return SelfChange() when DiffStatus is good."),
+                ComparePropertiesResult::NoChange => {},
+                result => {
+                    new_status.push(result);
                 }
             }
+            )*
+
+            new_status
         }
     };
-    // Default case for when there are no expected properties except for :standard-properties
-    ($emacs:expr) => {
+    // For elements with affiliated keywords
+    ($source:expr, $emacs:expr, $rust:expr, [], $(($emacs_field:expr, $rust_value_getter:expr, $compare_fn: expr)),*) => {
         {
-            let mut this_status = DiffStatus::Good;
-            let mut message: Option<String> = None;
+            let mut new_status = Vec::new();
             let children = $emacs.as_list()?;
             let attributes_child = children
             .iter()
@@ -124,30 +110,193 @@ macro_rules! compare_properties {
             if emacs_keys.contains(":standard-properties") {
                 emacs_keys.remove(":standard-properties");
             } else {
-                this_status = DiffStatus::Bad;
-                message = Some(format!(
+                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)),*) => {
+        {
+            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.",
+                ))));
+            }
+            for additional_field in $additionalproperties {
+                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
+                ))));
+            }
+
+            $(
+            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
+        }
+    };
+    // Default case for when there are no expected properties except for :standard-properties
+    ($emacs: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.",
+                ))));
             }
 
             if !emacs_keys.is_empty() {
                 let unexpected_keys: Vec<&str> = emacs_keys.into_iter().collect();
                 let unexpected_keys = unexpected_keys.join(", ");
-                this_status = DiffStatus::Bad;
-                message = Some(format!(
+                new_status.push(ComparePropertiesResult::SelfChange(DiffStatus::Bad, Some(format!(
                     "Emacs token had extra field(s): {}",
                     unexpected_keys
-                ));
-            }
-            match this_status {
-                DiffStatus::Good => {
-                    let result: Result<_, Box<dyn std::error::Error>> = Ok(None);
-                    result
-                },
-                _ => {
-                    Ok(Some((this_status, message)))
-                }
+                ))));
             }
+            new_status
         }
     };
 }

src/compare/mod.rs

@@ -1,3 +1,4 @@
+#[allow(clippy::module_inception)]
 mod compare;
 mod compare_field;
 mod diff;
@@ -10,3 +11,5 @@ pub use compare::run_anonymous_compare;
 pub use compare::run_anonymous_compare_with_settings;
 pub use compare::run_compare_on_file;
 pub use compare::run_compare_on_file_with_settings;
+pub use compare::silent_anonymous_compare;
+pub use compare::silent_compare_on_file;

src/compare/parse.rs

@@ -1,5 +1,6 @@
 use std::path::Path;
-use std::process::Command;
+
+use tokio::process::Command;
 
 use crate::context::HeadlineLevelFilter;
 use crate::settings::GlobalSettings;
@@ -25,9 +26,9 @@ fn global_settings_elisp(global_settings: &GlobalSettings) -> String {
     ret
 }
 
-pub(crate) fn emacs_parse_anonymous_org_document<C>(
+pub(crate) async fn emacs_parse_anonymous_org_document<'g, 's, C>(
     file_contents: C,
-    global_settings: &GlobalSettings,
+    global_settings: &GlobalSettings<'g, 's>,
 ) -> Result<String, Box<dyn std::error::Error>>
 where
     C: AsRef<str>,
@@ -54,15 +55,24 @@ where
         .arg("--batch")
         .arg("--eval")
         .arg(elisp_script);
-    let out = cmd.output()?;
-    out.status.exit_ok()?;
+    let out = cmd.output().await?;
+    let status = out.status.exit_ok();
+    if status.is_err() {
+        eprintln!(
+            "Emacs errored out: {}\n{}",
+            String::from_utf8(out.stdout)?,
+            String::from_utf8(out.stderr)?
+        );
+        status?;
+        unreachable!();
+    }
     let org_sexp = out.stderr;
     Ok(String::from_utf8(org_sexp)?)
 }
 
-pub(crate) fn emacs_parse_file_org_document<P>(
+pub(crate) async fn emacs_parse_file_org_document<'g, 's, P>(
     file_path: P,
-    global_settings: &GlobalSettings,
+    global_settings: &GlobalSettings<'g, 's>,
 ) -> Result<String, Box<dyn std::error::Error>>
 where
     P: AsRef<Path>,
@@ -97,8 +107,17 @@ where
         .arg("--batch")
         .arg("--eval")
         .arg(elisp_script);
-    let out = cmd.output()?;
-    out.status.exit_ok()?;
+    let out = cmd.output().await?;
+    let status = out.status.exit_ok();
+    if status.is_err() {
+        eprintln!(
+            "Emacs errored out: {}\n{}",
+            String::from_utf8(out.stdout)?,
+            String::from_utf8(out.stderr)?
+        );
+        status?;
+        unreachable!();
+    }
     let org_sexp = out.stderr;
     Ok(String::from_utf8(org_sexp)?)
 }
@@ -125,7 +144,7 @@ where
     output
 }
 
-pub fn get_emacs_version() -> Result<String, Box<dyn std::error::Error>> {
+pub async fn get_emacs_version() -> Result<String, Box<dyn std::error::Error>> {
     let elisp_script = r#"(progn
      (message "%s" (version))
 )"#;
@@ -138,12 +157,12 @@ pub fn get_emacs_version() -> Result<String, Box<dyn std::error::Error>> {
         .arg("--eval")
         .arg(elisp_script);
 
-    let out = cmd.output()?;
+    let out = cmd.output().await?;
     out.status.exit_ok()?;
     Ok(String::from_utf8(out.stderr)?)
 }
 
-pub fn get_org_mode_version() -> Result<String, Box<dyn std::error::Error>> {
+pub async fn get_org_mode_version() -> Result<String, Box<dyn std::error::Error>> {
     let elisp_script = r#"(progn
      (org-mode)
      (message "%s" (org-version nil t nil))
@@ -157,7 +176,7 @@ pub fn get_org_mode_version() -> Result<String, Box<dyn std::error::Error>> {
         .arg("--eval")
         .arg(elisp_script);
 
-    let out = cmd.output()?;
+    let out = cmd.output().await?;
     out.status.exit_ok()?;
     Ok(String::from_utf8(out.stderr)?)
 }

src/compare/sexp.rs

@@ -113,24 +113,21 @@ fn is_slice_of(parent: &str, child: &str) -> bool {
 /// Get a slice of the string that was consumed in a parser using the original input to the parser and the remaining input after the parser.
 fn get_consumed<'s>(input: &'s str, remaining: &'s str) -> &'s str {
     debug_assert!(is_slice_of(input, remaining));
-    let source = {
-        let offset = remaining.as_ptr() as usize - input.as_ptr() as usize;
-        &input[..offset]
-    };
-    source.into()
+    let offset = remaining.as_ptr() as usize - input.as_ptr() as usize;
+    &input[..offset]
 }
 
 pub(crate) fn unquote(text: &str) -> Result<String, Box<dyn std::error::Error>> {
     let mut out: Vec<u8> = Vec::with_capacity(text.len());
-    if !text.starts_with(r#"""#) {
+    if !text.starts_with('"') {
         return Err("Quoted text does not start with quote.".into());
     }
-    if !text.ends_with(r#"""#) {
+    if !text.ends_with('"') {
         return Err("Quoted text does not end with quote.".into());
     }
     let interior_text = &text[1..(text.len() - 1)];
     let mut state = ParseState::Normal;
-    for current_char in interior_text.bytes().into_iter() {
+    for current_char in interior_text.bytes() {
         // Check to see if octal finished
         state = match (state, current_char) {
             (ParseState::Octal(octal), b'0'..=b'7') if octal.len() < MAX_OCTAL_LENGTH => {
@@ -229,11 +226,9 @@ fn atom<'s>(input: &'s str) -> Res<&'s str, Token<'s>> {
 
 #[cfg_attr(feature = "tracing", tracing::instrument(ret, level = "debug"))]
 fn unquoted_atom<'s>(input: &'s str) -> Res<&'s str, Token<'s>> {
-    let (remaining, body) = take_till1(|c| match c {
-        ' ' | '\t' | '\r' | '\n' | ')' | ']' => true,
-        _ => false,
-    })(input)?;
-    Ok((remaining, Token::Atom(body.into())))
+    let (remaining, body) =
+        take_till1(|c| matches!(c, ' ' | '\t' | '\r' | '\n' | ')' | ']'))(input)?;
+    Ok((remaining, Token::Atom(body)))
 }
 
 #[cfg_attr(feature = "tracing", tracing::instrument(ret, level = "debug"))]
@@ -264,22 +259,19 @@ fn quoted_atom<'s>(input: &'s str) -> Res<&'s str, Token<'s>> {
     }
     let (remaining, _) = tag(r#"""#)(remaining)?;
     let source = get_consumed(input, remaining);
-    Ok((remaining, Token::Atom(source.into())))
+    Ok((remaining, Token::Atom(source)))
 }
 
 #[cfg_attr(feature = "tracing", tracing::instrument(ret, level = "debug"))]
 fn hash_notation<'s>(input: &'s str) -> Res<&'s str, Token<'s>> {
     let (remaining, _) = tag("#<")(input)?;
-    let (remaining, _body) = take_till1(|c| match c {
-        '>' => true,
-        _ => false,
-    })(remaining)?;
+    let (remaining, _body) = take_till1(|c| matches!(c, '>'))(remaining)?;
     let (remaining, _) = tag(">")(remaining)?;
     let source = get_consumed(input, remaining);
-    Ok((remaining, Token::Atom(source.into())))
+    Ok((remaining, Token::Atom(source)))
 }
 
-fn text_with_properties<'s>(input: &'s str) -> Res<&'s str, Token<'s>> {
+fn text_with_properties(input: &str) -> Res<&str, Token<'_>> {
     let (remaining, _) = tag("#(")(input)?;
     let (remaining, (text, props)) = delimited(
         multispace0,
@@ -348,10 +340,7 @@ mod tests {
         let input = r#"  (foo "b(a)r" baz )  "#;
         let (remaining, parsed) = sexp(input).expect("Parse the input");
         assert_eq!(remaining, "");
-        assert!(match parsed {
-            Token::List(_) => true,
-            _ => false,
-        });
+        assert!(matches!(parsed, Token::List(_)));
         let children = match parsed {
             Token::List(children) => children,
             _ => panic!("Should be a list."),
@@ -364,14 +353,14 @@ mod tests {
             r#"foo"#
         );
         assert_eq!(
-            match children.iter().nth(1) {
+            match children.get(1) {
                 Some(Token::Atom(body)) => *body,
                 _ => panic!("Second child should be an atom."),
             },
             r#""b(a)r""#
         );
         assert_eq!(
-            match children.iter().nth(2) {
+            match children.get(2) {
                 Some(Token::Atom(body)) => *body,
                 _ => panic!("Third child should be an atom."),
             },

src/compare/util.rs

@@ -1,8 +1,19 @@
 use std::str::FromStr;
 
+use super::compare_field::compare_property_list_of_quoted_string;
+use super::compare_field::compare_property_object_tree;
+use super::compare_field::compare_property_optional_pair;
+use super::compare_field::compare_property_quoted_string;
+use super::compare_field::ComparePropertiesResult;
+use super::diff::DiffEntry;
+use super::diff::DiffStatus;
 use super::elisp_fact::GetElispFact;
 use super::sexp::Token;
+use crate::compare::diff::compare_ast_node;
 use crate::compare::sexp::unquote;
+use crate::types::AffiliatedKeywordValue;
+use crate::types::AstNode;
+use crate::types::GetAffiliatedKeywords;
 use crate::types::GetStandardProperties;
 use crate::types::StandardProperties;
 
@@ -43,8 +54,8 @@ pub(crate) fn compare_standard_properties<
     Ok(())
 }
 
-pub(crate) fn assert_name<'b, 's, S: AsRef<str>>(
-    emacs: &'b Token<'s>,
+pub(crate) fn assert_name<S: AsRef<str>>(
+    emacs: &Token<'_>,
     name: S,
 ) -> Result<(), Box<dyn std::error::Error>> {
     let name = name.as_ref();
@@ -79,9 +90,9 @@ pub(crate) fn assert_bounds<'b, 's, S: StandardProperties<'s> + ?Sized>(
         standard_properties.end.ok_or("Token should have an end.")?,
     );
     let (rust_begin, rust_end) = get_rust_byte_offsets(original_document, rust); // 0-based
-    let rust_begin_char_offset = (&original_document[..rust_begin]).chars().count() + 1; // 1-based
+    let rust_begin_char_offset = original_document[..rust_begin].chars().count() + 1; // 1-based
     let rust_end_char_offset =
-        rust_begin_char_offset + (&original_document[rust_begin..rust_end]).chars().count(); // 1-based
+        rust_begin_char_offset + original_document[rust_begin..rust_end].chars().count(); // 1-based
     if rust_begin_char_offset != begin || rust_end_char_offset != end {
         Err(format!("Rust bounds (in chars) ({rust_begin}, {rust_end}) do not match emacs bounds ({emacs_begin}, {emacs_end})", rust_begin = rust_begin_char_offset, rust_end = rust_end_char_offset, emacs_begin=begin, emacs_end=end))?;
     }
@@ -102,21 +113,18 @@ struct EmacsStandardProperties {
     post_blank: Option<usize>,
 }
 
-fn get_emacs_standard_properties<'b, 's>(
-    emacs: &'b Token<'s>,
+fn get_emacs_standard_properties(
+    emacs: &Token<'_>,
 ) -> Result<EmacsStandardProperties, Box<dyn std::error::Error>> {
     let children = emacs.as_list()?;
-    let attributes_child = children
-        .iter()
-        .nth(1)
-        .ok_or("Should have an attributes child.")?;
+    let attributes_child = children.get(1).ok_or("Should have an attributes child.")?;
     let attributes_map = attributes_child.as_map()?;
     let standard_properties = attributes_map.get(":standard-properties");
     Ok(if standard_properties.is_some() {
         let mut std_props = standard_properties
             .expect("if statement proves its Some")
             .as_vector()?
-            .into_iter();
+            .iter();
         let begin = maybe_token_to_usize(std_props.next())?;
         let post_affiliated = maybe_token_to_usize(std_props.next())?;
         let contents_begin = maybe_token_to_usize(std_props.next())?;
@@ -132,16 +140,13 @@ fn get_emacs_standard_properties<'b, 's>(
             post_blank,
         }
     } else {
-        let begin = maybe_token_to_usize(attributes_map.get(":begin").map(|token| *token))?;
-        let end = maybe_token_to_usize(attributes_map.get(":end").map(|token| *token))?;
-        let contents_begin =
-            maybe_token_to_usize(attributes_map.get(":contents-begin").map(|token| *token))?;
-        let contents_end =
-            maybe_token_to_usize(attributes_map.get(":contents-end").map(|token| *token))?;
-        let post_blank =
-            maybe_token_to_usize(attributes_map.get(":post-blank").map(|token| *token))?;
+        let begin = maybe_token_to_usize(attributes_map.get(":begin").copied())?;
+        let end = maybe_token_to_usize(attributes_map.get(":end").copied())?;
+        let contents_begin = maybe_token_to_usize(attributes_map.get(":contents-begin").copied())?;
+        let contents_end = maybe_token_to_usize(attributes_map.get(":contents-end").copied())?;
+        let post_blank = maybe_token_to_usize(attributes_map.get(":post-blank").copied())?;
         let post_affiliated =
-            maybe_token_to_usize(attributes_map.get(":post-affiliated").map(|token| *token))?;
+            maybe_token_to_usize(attributes_map.get(":post-affiliated").copied())?;
         EmacsStandardProperties {
             begin,
             post_affiliated,
@@ -159,78 +164,57 @@ fn maybe_token_to_usize(
     Ok(token
         .map(|token| token.as_atom())
         .map_or(Ok(None), |r| r.map(Some))?
-        .map(|val| {
+        .and_then(|val| {
             if val == "nil" {
                 None
             } else {
                 Some(val.parse::<usize>())
             }
         })
-        .flatten() // Outer option is whether or not the param exists, inner option is whether or not it is nil
         .map_or(Ok(None), |r| r.map(Some))?)
 }
 
 /// Get a named property from the emacs token.
 ///
 /// Returns Ok(None) if value is nil or absent.
-pub(crate) fn get_property<'b, 's, 'x>(
+pub(crate) fn get_property<'b, 's>(
     emacs: &'b Token<'s>,
-    key: &'x str,
+    key: &str,
 ) -> Result<Option<&'b Token<'s>>, Box<dyn std::error::Error>> {
     let children = emacs.as_list()?;
-    let attributes_child = children
-        .iter()
-        .nth(1)
-        .ok_or("Should have an attributes child.")?;
+    let attributes_child = children.get(1).ok_or("Should have an attributes child.")?;
     let attributes_map = attributes_child.as_map()?;
-    let prop = attributes_map.get(key).map(|token| *token);
-    match prop.map(|token| token.as_atom()) {
-        Some(Ok("nil")) => return Ok(None),
-        _ => {}
-    };
+    let prop = attributes_map.get(key).copied();
+    if let Some(Ok("nil")) = prop.map(Token::as_atom) {
+        return Ok(None);
+    }
     Ok(prop)
 }
 
 /// Get a named property containing an unquoted atom from the emacs token.
 ///
 /// Returns None if key is not found.
-pub(crate) fn get_property_unquoted_atom<'b, 's, 'x>(
-    emacs: &'b Token<'s>,
-    key: &'x str,
+pub(crate) fn get_property_unquoted_atom<'s>(
+    emacs: &Token<'s>,
+    key: &str,
 ) -> Result<Option<&'s str>, Box<dyn std::error::Error>> {
-    Ok(get_property(emacs, key)?
+    get_property(emacs, key)?
         .map(Token::as_atom)
-        .map_or(Ok(None), |r| r.map(Some))?)
+        .map_or(Ok(None), |r| r.map(Some))
 }
 
 /// Get a named property containing an quoted string from the emacs token.
 ///
 /// Returns None if key is not found.
-pub(crate) fn get_property_quoted_string<'b, 's, 'x>(
-    emacs: &'b Token<'s>,
-    key: &'x str,
+pub(crate) fn get_property_quoted_string(
+    emacs: &Token<'_>,
+    key: &str,
 ) -> Result<Option<String>, Box<dyn std::error::Error>> {
-    Ok(get_property(emacs, key)?
+    get_property(emacs, key)?
         .map(Token::as_atom)
         .map_or(Ok(None), |r| r.map(Some))?
         .map(unquote)
-        .map_or(Ok(None), |r| r.map(Some))?)
-}
-
-/// Get a named property containing a boolean value.
-///
-/// This uses the elisp convention of nil == false, non-nil == true.
-///
-/// Returns false if key is not found.
-pub(crate) fn get_property_boolean<'b, 's, 'x>(
-    emacs: &'b Token<'s>,
-    key: &'x str,
-) -> Result<bool, Box<dyn std::error::Error>> {
-    Ok(get_property(emacs, key)?
-        .map(Token::as_atom)
-        .map_or(Ok(None), |r| r.map(Some))?
-        .unwrap_or("nil")
-        != "nil")
+        .map_or(Ok(None), |r| r.map(Some))
 }
 
 /// Get a named property containing an unquoted numeric value.
@@ -252,3 +236,167 @@ where
         .map_or(Ok(None), |r| r.map(Some))?;
     Ok(parsed_number)
 }
+
+pub(crate) fn compare_children<'b, 's, 'x, RC>(
+    source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_children: &'x Vec<RC>,
+    child_status: &mut Vec<DiffEntry<'b, 's>>,
+    this_status: &mut DiffStatus,
+    message: &mut Option<String>,
+) -> Result<(), Box<dyn std::error::Error>>
+where
+    AstNode<'b, 's>: From<&'x RC>,
+{
+    let emacs_children = emacs.as_list()?;
+    let emacs_children_length = emacs_children.len() - 2;
+    if emacs_children_length != rust_children.len() {
+        *this_status = DiffStatus::Bad;
+        *message = Some(format!(
+            "Child length mismatch (emacs != rust) {:?} != {:?}",
+            emacs_children_length,
+            rust_children.len()
+        ));
+    }
+    for (emacs_child, rust_child) in emacs_children.iter().skip(2).zip(rust_children.iter()) {
+        child_status.push(compare_ast_node(source, emacs_child, rust_child.into())?);
+    }
+    Ok(())
+}
+
+pub(crate) fn compare_children_iter<'b, 's, RC, RI: Iterator<Item = RC> + ExactSizeIterator>(
+    source: &'s str,
+    emacs: &'b Token<'s>,
+    rust_children: RI,
+    child_status: &mut Vec<DiffEntry<'b, 's>>,
+    this_status: &mut DiffStatus,
+    message: &mut Option<String>,
+) -> Result<(), Box<dyn std::error::Error>>
+where
+    AstNode<'b, 's>: From<RC>,
+{
+    let emacs_children = emacs.as_list()?;
+    let emacs_children_length = emacs_children.len() - 2;
+    if emacs_children_length != rust_children.len() {
+        *this_status = DiffStatus::Bad;
+        *message = Some(format!(
+            "Child length mismatch (emacs != rust) {:?} != {:?}",
+            emacs_children_length,
+            rust_children.len()
+        ));
+    }
+    for (emacs_child, rust_child) in emacs_children.iter().skip(2).zip(rust_children) {
+        child_status.push(compare_ast_node(source, emacs_child, rust_child.into())?);
+    }
+    Ok(())
+}
+
+pub(crate) fn assert_no_children(
+    emacs: &Token<'_>,
+    this_status: &mut DiffStatus,
+    message: &mut Option<String>,
+) -> Result<(), Box<dyn std::error::Error>> {
+    let emacs_children_length = emacs.as_list()?.len();
+    // 2, one for the name of the node and one for the properties. Children would come after that.
+    if emacs_children_length != 2 {
+        *this_status = DiffStatus::Bad;
+        *message = Some(format!(
+            "Should have no children but emacs has {:?} children.",
+            emacs_children_length - 2,
+        ));
+    }
+    Ok(())
+}
+
+pub(crate) fn compare_additional_properties<'b, 's, RK, RV, RI>(
+    emacs: &'b Token<'s>,
+    rust_children: RI,
+) -> Result<ComparePropertiesResult<'b, 's>, Box<dyn std::error::Error>>
+where
+    RK: AsRef<str>,
+    RV: AsRef<str>,
+    RI: Iterator<Item = (RK, RV)> + ExactSizeIterator,
+{
+    for (rust_key, rust_value) in rust_children {
+        let rust_key = rust_key.as_ref();
+        let rust_value = rust_value.as_ref();
+        let emacs_value = get_property_quoted_string(emacs, rust_key)?;
+        if Some(rust_value) != emacs_value.as_deref() {
+            let this_status = DiffStatus::Bad;
+            let message = Some(format!(
+                "{} mismatch (emacs != rust) {:?} != {:?}",
+                rust_key, emacs_value, rust_value
+            ));
+            return Ok(ComparePropertiesResult::SelfChange(this_status, message));
+        }
+    }
+    Ok(ComparePropertiesResult::NoChange)
+}
+
+pub(crate) fn compare_affiliated_keywords<'b, 's, GAK>(
+    source: &'s str,
+    emacs: &'b Token<'s>,
+    rust: &'b GAK,
+) -> Result<Vec<ComparePropertiesResult<'b, 's>>, Box<dyn std::error::Error>>
+where
+    GAK: GetAffiliatedKeywords<'s>,
+{
+    let mut ret = Vec::new();
+    let affiliated_keywords = rust.get_affiliated_keywords();
+    for (rust_name, rust_value) in affiliated_keywords.keywords.iter() {
+        let emacs_property_name = format!(":{}", rust_name);
+        match rust_value {
+            AffiliatedKeywordValue::SingleString(rust_value) => {
+                let diff = compare_property_quoted_string(
+                    source,
+                    emacs,
+                    rust,
+                    emacs_property_name.as_str(),
+                    |_| Some(*rust_value),
+                )?;
+                ret.push(diff);
+            }
+            AffiliatedKeywordValue::ListOfStrings(rust_value) => {
+                let diff = compare_property_list_of_quoted_string(
+                    source,
+                    emacs,
+                    rust,
+                    emacs_property_name.as_str(),
+                    |_| Some(rust_value.iter()),
+                )?;
+                ret.push(diff);
+            }
+            AffiliatedKeywordValue::OptionalPair { optval, val } => {
+                let diff = compare_property_optional_pair(
+                    source,
+                    emacs,
+                    rust,
+                    emacs_property_name.as_str(),
+                    |_| Some((*optval, *val)),
+                )?;
+                ret.push(diff);
+            }
+            AffiliatedKeywordValue::ObjectTree(rust_value) => {
+                let diff = compare_property_object_tree(
+                    source,
+                    emacs,
+                    rust,
+                    emacs_property_name.as_str(),
+                    |_| Some(rust_value.iter()),
+                )?;
+                ret.push(diff);
+            }
+        };
+    }
+    Ok(ret)
+}
+
+pub(crate) fn affiliated_keywords_names<'s, GAK>(rust: &'s GAK) -> impl Iterator<Item = String> + 's
+where
+    GAK: GetAffiliatedKeywords<'s>,
+{
+    rust.get_affiliated_keywords()
+        .keywords
+        .keys()
+        .map(|k| format!(":{}", k))
+}