]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - README.md
Support CTM Wildcards and recursive Embedded Topics
[topic-maps.git] / README.md
1 # Common Lisp Topic Maps — Slice 15
2
3 A working ANSI Common Lisp reader for CTM identity/name syntax and
4 unary/binary Associations, with same-map merging of Topics, Names, Associations
5 and Roles, plus string/IRI-valued Occurrences, in a bounded TMDM model. HyperDoc remains a possible future client
6 and is neither the codebase nor a dependency. Slice 4 adds a pure, independent
7 CXTM canonicalizer for this model. Templates and cross-document merging remain
8 outside the implementation. Slice 5 adds Occurrence items and replacement merging
9 without expanding Scope, Reification or Variants. Slice 6 adds document-local
10 prefixes, QName resolution and explicit datatype locators on quoted Occurrence
11 values. Unknown datatypes retain their lexical values; Date timezone CXTM rules
12 remain explicitly unsupported. Slice 7 adds integer literals, lexical validation
13 and pure xsd:integer canonical output; qualified strings retain their stored
14 lexical values. Slice 8 adds decimal literals, exact character-based xsd:decimal
15 canonicalization and lexical validation, with the same separation of stored
16 strings, TMDM equality and canonical serialization. Slice 9 adds timezone-free
17 xsd:date literals, Gregorian calendar validation and pure CXTM Date output.
18 Negative-year leap validation follows the documented XSD 1.0 E.1 interpretation.
19 Slice 10 adds xsd:dateTime with absent/zero zones, exact fractional precision and
20 midnight rollover. A noncandidate leap-second baseline disagrees with XSD D.1
21 following-minute interpretation and remains FAIL. Slice 11 adds exact nonzero-offset UTC canonicalization; the original timezone2
22 contract now executes and reports its known inconsistent baseline as FAIL.
23 Nonzero-offset BCE day rollover and leap-second contexts remain explicitly
24 unsupported; existing zero/absent-zone behavior is retained.
25 Slice 12A adds explicitly typed Topic Names. Slice 13 adds Scope Topic sets to
26 Names, Occurrences and Associations, including reference replacement, duplicate
27 merging and canonical output. Slice 14 adds unreified Variants with proper Scope
28 supersets, canonical merge handles and pure CXTM output. Slice 15 adds per-document
29 Wildcards and recursive Embedded Topics through the shared Topic reference reader.
30
31 Systems: `topic-maps` (the retained foundation), `topic-maps/tests`,
32 `topic-maps/tmdm`, `topic-maps/ctm`, `topic-maps/ctm/tests` and
33 `topic-maps/ctm/merging-tests` and `topic-maps/ctm/association-tests`, plus `topic-maps/cxtm` and
34 `topic-maps/cxtm/tests`, `topic-maps/ctm/occurrence-tests` and `topic-maps/ctm/prefix-tests` and `topic-maps/ctm/integer-tests`, plus `topic-maps/ctm/decimal-tests` and `topic-maps/ctm/date-tests` and `topic-maps/ctm/datetime-tests` and `topic-maps/ctm/timezone-tests`, `topic-maps/ctm/typed-name-tests` and `topic-maps/ctm/scope-tests`, plus `topic-maps/ctm/variant-tests` and `topic-maps/ctm/reference-tests`.
35 The core reader/model uses ANSI Common Lisp; the foundation/tooling uses
36 ASDF/UIOP and Python's standard library. No Quicklisp packages are required.
37
38 Start with [Reading Topic References](docs/reading-topic-references.md) for Wildcard
39 IRIs/counters, recursive Embedded Topics and actual object relationships.
40 [Reading Variants](docs/reading-variants.md) for Parent Name relationships,
41 explicit/resulting Scope, merge preflight and the four original contracts.
42 [Reading Scope](docs/reading-scope.md) for Scope APIs, actual Topic
43 references, merge handles and the three original comparisons.
44 [Reading Typed Topic Names](docs/reading-typed-topic-names.md) covers Slice 12A.
45 [Reading DateTime Timezone Canonicalization](docs/reading-datetime-timezones.md)
46 for UTC conversion, calendar limits, actual stored strings and executable inspection.
47 [Reading DateTime Occurrences](docs/reading-datetime-occurrences.md)
48 for lexical/value/canonical distinctions and the two normative discrepancies.
49 [Reading Date Occurrences](docs/reading-date-occurrences.md)
50 for the ten original Date cases, calendar rules, stored values and inspection.
51 [Reading Decimal Occurrences](docs/reading-decimal-occurrences.md)
52 for the seven Decimal cases, string representation, equality and inspection.
53 [Reading Integer Occurrences](docs/reading-integer-occurrences.md)
54 for integer representation, lexical equality, canonicalization and inspection.
55 [Reading Prefixes and Explicit Datatypes](docs/reading-prefixes-and-datatypes.md)
56 for the seven original cases, current API, object properties and diagnostics.
57 [Reading the First Four CTM Occurrences](docs/reading-first-occurrences.md)
58 for actual parent/type references, literal values, datatypes and executable inspection.
59 [Reading Canonical Topic Maps](docs/reading-canonical-topic-maps.md)
60 for the CXTM API, normative clauses, base-locator policy and actual byte comparisons.
61 [Reading the First CTM Associations](docs/reading-first-ctm-associations.md)
62 for actual Association/Role items, late Topic merges and current subset boundaries.
63 [Reading Topic Identity and Merging](docs/reading-topic-merging.md)
64 for the current API, reference replacement, identifier tails and exact subset
65 boundaries. See [Reading the First Five CTM Documents](docs/reading-first-five-ctm-documents.md)
66 for original sources, actual objects, normative clauses, baseline evidence and
67 copy-pasteable DESCRIBE forms. [API and boundaries](docs/slice-1-api-and-boundaries.md)
68 document the accepted Slice 1 baseline; the Slice 2 document supersedes its
69 statements about absent identity tails, merging and immutable Name references.
70 The Slice 3 document supersedes historical statements about absent Associations/Roles.
71
72 The pinned suite targets the **CTM draft dated 2010-03-31**. Passing it alone
73 does not establish full ISO/IEC 13250-6:2010 conformity.
74
75 ## Load and inspect
76
77 In a new Common Lisp process, with this checkout selected:
78
79 ```lisp
80 (require :asdf)
81 (asdf:initialize-source-registry
82 '(:source-registry :ignore-inherited-configuration))
83 (asdf:load-asd #p"/Users/rgb/workspace/topic-maps/topic-maps.asd")
84 (asdf:load-system "topic-maps/ctm")
85 (asdf:load-system "topic-maps")
86 (defparameter *corpus* (topic-maps.test-foundation:discover-corpus))
87 (topic-maps.test-foundation:summarize-corpus *corpus*)
88 (topic-maps.test-foundation:select-cases *corpus* :category :invalid)
89 (topic-maps.test-foundation:select-cases *corpus* :id "ctm/in/simple.ctm")
90 (asdf:test-system "topic-maps/tests")
91 (asdf:test-system "topic-maps/ctm/tests")
92 (asdf:test-system "topic-maps/ctm/merging-tests")
93 (asdf:test-system "topic-maps/ctm/association-tests")
94 (asdf:test-system "topic-maps/ctm/decimal-tests") ; includes retained Integer/Prefix/Occurrence/CXTM suites
95 (topic-maps.test-foundation:write-validation-report
96 *corpus* #p"/tmp/topic-maps-inventory.json")
97 ```
98
99 Change only the checkout pathname when using another machine. The case's
100 Document IRI remains independent of that pathname. Records are inspectable
101 Common Lisp structures, with actual source/baseline pathnames and explicit
102 contracts, results, statuses, diagnostics and reviewed clauses.
103
104 ## Offline verification
105
106 ```sh
107 # SBCL must already be installed. No network is used by this command.
108 TOPIC_MAPS_REPORT=/tmp/topic-maps-validation.json ./scripts/test.sh
109 ```
110
111 Set `SBCL=/absolute/path/to/sbcl` if needed. The launcher starts a new process,
112 ignores system/user initialization, clears inherited ASDF source configuration
113 and writes FASLs outside the repository. It runs byte-integrity fixtures,
114 Common Lisp infrastructure checks and an independent JSON-schema/content check
115 when a report pathname is supplied. `nix develop path:.` supplies a minimal,
116 pinned SBCL/Python/Git environment; initial environment provisioning may need
117 network access, while test execution after provisioning does not.
118
119 The complete upstream corpus is already vendored, unchanged. If absent in a
120 source distribution, acquire it once:
121
122 ```sh
123 python3 scripts/corpus.py acquire
124 python3 scripts/corpus.py verify
125 ```
126
127 Acquisition uses the exact commit and archive digest in
128 [corpus-lock.json](references/corpus-lock.json), refuses to merge over existing
129 contents and verifies every file. Verification is offline. Valid CTM inputs
130 are selected only under `ctm/in`, invalid ones only under `ctm/invalid`, and
131 CXTM baselines only under `ctm/baseline`. Auxiliary files are reported separately.
132
133 ## Current validation and historical foundation
134
135 The complete pinned corpus remains unchanged: 231 valid CTM inputs, 42 invalid
136 inputs, 231 CXTM baselines and 22 CTM auxiliary files. Eighty-three selected positive
137 cases pass actual CXTM byte comparisons. Ten specific rejection contracts pass.
138 Two executed DateTime contracts remain FAIL because of documented normative
139 baseline discrepancies; 178 contracts remain NOT-RUN. A green regression run
140 preserves those two FAILs and never changes an upstream baseline. Unsupported
141 constructs and I/O errors cannot count as the required CTM rejection.
142
143 The full launcher runs the retained 54 foundation checks, two Python integrity
144 fixtures, 123 retained identity checks, 646 merge checks, 657 Association checks,
145 imported-report validation and selected baseline
146 property evidence, 445 retained CXTM checks, 1,101 Occurrence checks, 150 prefix/datatype checks, 665 integer checks, 715 Decimal checks, 1,806 Date checks, 217 DateTime checks, 1,944 timezone checks, 106 typed-name checks, 293 Scope checks, 324 Variant checks and 238 Topic Reference checks, plus
147 16,294 independent Unicode NFC oracle
148 comparisons. The oracle needs Python UCD 15.0 or 15.1 (tables use UCD 15.1.0).
149 A report path also produces `<path>.semantics.json` with
150 separate model observations, plus `<path>.merging.json`, `<path>.associations.json`
151 and `<path>.cxtm.json` (complete actual/expected XML and byte counts),
152 plus `<path>.occurrences.json` with separate actual Occurrence objects/properties
153 and `<path>.prefixes.json` with all seven selected observations, plus `<path>.integers.json` for integer objects
154 and independently checked arithmetic probes, plus `<path>.decimals.json` with
155 seven Decimal object observations and 157 independent Decimal arithmetic probes,
156 plus `<path>.dates.json` with five original Date results, five original rejections,
157 396 independent date/calendar probes and 15 century decisions. `<path>.datetimes.json` records five actual DateTime
158 models, 45 independent lexical/canonical probes and two executed baseline
159 discrepancies. `<path>.timezones.json` adds exact UTC, fraction and model-purity
160 probes, including every one of the 1681 permitted signed offset minutes.
161 The merge checks include 128 graph/order variants with an independent reachability
162 oracle. Reports are deterministic across the tested SBCL versions and checkout
163 relocation. `<path>.typed-names.json` records Name value/Parent/Type relations;
164 `<path>.scopes.json` records Scope object relations and an ordering witness.
165 `<path>.variants.json` records Variant/Parent/Scope observations and XML ordering.
166 `<path>.references.json` records the new source/counter/model observations.
167 See [Slice 15 validation](docs/slice-15-validation.md) for current evidence.
168 [Slice 12A validation](docs/slice-12a-validation.md) records explicit Name types.
169 [Slice 11 validation](docs/slice-11-validation.md) preserves the prior timezone evidence.
170 [Slice 10 validation](docs/slice-10-validation.md) preserves the earlier DateTime baseline.
171 [Slice 9 validation](docs/slice-9-validation.md) records the accepted Date subset.
172 [Slice 8 validation](docs/slice-8-validation.md) records the accepted Decimal subset.
173 [Slice 7 validation](docs/slice-7-validation.md) records the accepted Integer subset.
174 [Slice 6 validation](docs/slice-6-validation.md) records the preceding accepted subset.
175 [Slice 5 validation](docs/slice-5-validation.md) records the preceding accepted subset.
176 [Slice 4 validation](docs/slice-4-validation.md) records the accepted baseline.
177 [Slice 3 validation](docs/slice-3-validation.md),
178 [imported contracts](reports/slice-1/validation.json) and
179 [semantic observations](reports/slice-1/semantics.json).
180
181 [Slice 0 inventory](docs/inventory.md), [architecture](docs/architecture.md),
182 [coverage](docs/coverage.md) and [validation](docs/validation.md) remain historical
183 foundation records. Their original report/logs are preserved. Their statements
184 about absent reader/model systems describe Slice 0, not the current branch.
185 Slice 1 is built from `9c83db34eb1ba8091b004433f088056717dbaa7e` on
186 `codex/ctm-slice-1`. Slice 2 starts from the accepted Slice 1a commit
187 `fb60afd548d679d83fd8ec76bc5ff384c1e23e5f` on `codex/ctm-slice-2`.
188 Slice 13 starts from `788899aea1a20b9cd8237c6106e6613e180d7362` on
189 `codex/ctm-slice-13`.
190 Slice 14 starts from `aeb017e4f4846f2e6a701e581d20eef84a8b83d9` on
191 `codex/ctm-slice-14`.
192 Slice 11 starts from `8741d155d948c7317945eee423a977940cad995e` on
193 `codex/ctm-slice-11`.
194 Slice 10 starts from `2ad41cd1a945a4ce97824464de40646bb899259e` on
195 `codex/ctm-slice-10`.
196 Slice 9 starts from `195d5f5444d776096b765d04c815c23c3db5f84c` on
197 `codex/ctm-slice-9`.
198 Slice 8 starts from `17dd58775e25ab495e3c83deb4b5a36f5e5a124b` on
199 `codex/ctm-slice-8`.
200 Slice 7 starts from `3924d1eac5a070fe5a6a26683e23ac338793f544` on
201 `codex/ctm-slice-7`.
202 Slice 6 starts from `437ad53ea7539d36db3fa871d0931650b7a6a03e` on
203 `codex/ctm-slice-6`.
204 Slice 5 starts from `8036a2b1ce009218f33d300edcc5f715ec1d1124` on
205 `codex/ctm-slice-5`.
206 Slice 4 starts from `35648c4dcc71e8dc6448b64abcacb438e53d64a2` on
207 `codex/ctm-slice-4`.
208 Slice 3 starts from accepted `66664dbff6275d60dab1bc6a232fa70f7b916b8c` on
209 `codex/ctm-slice-3`. Await review before continuing to the next slice.
210
211 Slice 15 starts from `4f7b4d26d40f8f5566594aa2e3ad6296d44fc4c3` on `codex/ctm-slice-15`.