]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - README.md
Support explicitly typed Topic Names with merge and CXTM evidence
[topic-maps.git] / README.md
1 # Common Lisp Topic Maps — Slice 11
2
3 A working ANSI Common Lisp reader for CTM identity/default-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
26 Systems: `topic-maps` (the retained foundation), `topic-maps/tests`,
27 `topic-maps/tmdm`, `topic-maps/ctm`, `topic-maps/ctm/tests` and
28 `topic-maps/ctm/merging-tests` and `topic-maps/ctm/association-tests`, plus `topic-maps/cxtm` and
29 `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`.
30 The core reader/model uses ANSI Common Lisp; the foundation/tooling uses
31 ASDF/UIOP and Python's standard library. No Quicklisp packages are required.
32
33 Start with [Reading DateTime Timezone Canonicalization](docs/reading-datetime-timezones.md)
34 for UTC conversion, calendar limits, actual stored strings and executable inspection.
35 [Reading DateTime Occurrences](docs/reading-datetime-occurrences.md)
36 for lexical/value/canonical distinctions and the two normative discrepancies.
37 [Reading Date Occurrences](docs/reading-date-occurrences.md)
38 for the ten original Date cases, calendar rules, stored values and inspection.
39 [Reading Decimal Occurrences](docs/reading-decimal-occurrences.md)
40 for the seven Decimal cases, string representation, equality and inspection.
41 [Reading Integer Occurrences](docs/reading-integer-occurrences.md)
42 for integer representation, lexical equality, canonicalization and inspection.
43 [Reading Prefixes and Explicit Datatypes](docs/reading-prefixes-and-datatypes.md)
44 for the seven original cases, current API, object properties and diagnostics.
45 [Reading the First Four CTM Occurrences](docs/reading-first-occurrences.md)
46 for actual parent/type references, literal values, datatypes and executable inspection.
47 [Reading Canonical Topic Maps](docs/reading-canonical-topic-maps.md)
48 for the CXTM API, normative clauses, base-locator policy and actual byte comparisons.
49 [Reading the First CTM Associations](docs/reading-first-ctm-associations.md)
50 for actual Association/Role items, late Topic merges and current subset boundaries.
51 [Reading Topic Identity and Merging](docs/reading-topic-merging.md)
52 for the current API, reference replacement, identifier tails and exact subset
53 boundaries. See [Reading the First Five CTM Documents](docs/reading-first-five-ctm-documents.md)
54 for original sources, actual objects, normative clauses, baseline evidence and
55 copy-pasteable DESCRIBE forms. [API and boundaries](docs/slice-1-api-and-boundaries.md)
56 document the accepted Slice 1 baseline; the Slice 2 document supersedes its
57 statements about absent identity tails, merging and immutable Name references.
58 The Slice 3 document supersedes historical statements about absent Associations/Roles.
59
60 The pinned suite targets the **CTM draft dated 2010-03-31**. Passing it alone
61 does not establish full ISO/IEC 13250-6:2010 conformity.
62
63 ## Load and inspect
64
65 In a new Common Lisp process, with this checkout selected:
66
67 ```lisp
68 (require :asdf)
69 (asdf:initialize-source-registry
70 '(:source-registry :ignore-inherited-configuration))
71 (asdf:load-asd #p"/Users/rgb/workspace/topic-maps/topic-maps.asd")
72 (asdf:load-system "topic-maps/ctm")
73 (asdf:load-system "topic-maps")
74 (defparameter *corpus* (topic-maps.test-foundation:discover-corpus))
75 (topic-maps.test-foundation:summarize-corpus *corpus*)
76 (topic-maps.test-foundation:select-cases *corpus* :category :invalid)
77 (topic-maps.test-foundation:select-cases *corpus* :id "ctm/in/simple.ctm")
78 (asdf:test-system "topic-maps/tests")
79 (asdf:test-system "topic-maps/ctm/tests")
80 (asdf:test-system "topic-maps/ctm/merging-tests")
81 (asdf:test-system "topic-maps/ctm/association-tests")
82 (asdf:test-system "topic-maps/ctm/decimal-tests") ; includes retained Integer/Prefix/Occurrence/CXTM suites
83 (topic-maps.test-foundation:write-validation-report
84 *corpus* #p"/tmp/topic-maps-inventory.json")
85 ```
86
87 Change only the checkout pathname when using another machine. The case's
88 Document IRI remains independent of that pathname. Records are inspectable
89 Common Lisp structures, with actual source/baseline pathnames and explicit
90 contracts, results, statuses, diagnostics and reviewed clauses.
91
92 ## Offline verification
93
94 ```sh
95 # SBCL must already be installed. No network is used by this command.
96 TOPIC_MAPS_REPORT=/tmp/topic-maps-validation.json ./scripts/test.sh
97 ```
98
99 Set `SBCL=/absolute/path/to/sbcl` if needed. The launcher starts a new process,
100 ignores system/user initialization, clears inherited ASDF source configuration
101 and writes FASLs outside the repository. It runs byte-integrity fixtures,
102 Common Lisp infrastructure checks and an independent JSON-schema/content check
103 when a report pathname is supplied. `nix develop path:.` supplies a minimal,
104 pinned SBCL/Python/Git environment; initial environment provisioning may need
105 network access, while test execution after provisioning does not.
106
107 The complete upstream corpus is already vendored, unchanged. If absent in a
108 source distribution, acquire it once:
109
110 ```sh
111 python3 scripts/corpus.py acquire
112 python3 scripts/corpus.py verify
113 ```
114
115 Acquisition uses the exact commit and archive digest in
116 [corpus-lock.json](references/corpus-lock.json), refuses to merge over existing
117 contents and verifies every file. Verification is offline. Valid CTM inputs
118 are selected only under `ctm/in`, invalid ones only under `ctm/invalid`, and
119 CXTM baselines only under `ctm/baseline`. Auxiliary files are reported separately.
120
121 ## Current validation and historical foundation
122
123 The complete pinned corpus remains unchanged: 231 valid CTM inputs, 42 invalid
124 inputs, 231 CXTM baselines and 22 CTM auxiliary files. Fifty-four selected positive
125 cases pass actual CXTM byte comparisons, including three added by Slice 10. These 54 `:CXTM-EQUAL`
126 contracts are PASS. Eight rejection contracts also pass: the five selected Date
127 cases and `prefix-undefined`, `prefix-collision`, `prefix-undefined2`.
128 One executed leap-second `:CXTM-EQUAL` contract is FAIL due to a documented normative
129 baseline discrepancy; 210 imported contracts remain NOT-RUN, including the
130 nonzero-offset DateTime original. A green local test run preserves that FAIL,
131 rather than changing the upstream baseline. Unsupported constructs and I/O errors
132 cannot count as that required rejection.
133
134 The full launcher runs the retained 54 foundation checks, two Python integrity
135 fixtures, 123 retained identity checks, 646 merge checks, 657 Association checks,
136 imported-report validation and selected baseline
137 property evidence, 445 retained CXTM checks, 1,101 Occurrence checks, 150 prefix/datatype checks, 665 integer checks, 715 Decimal checks, 1,806 Date checks, 215 DateTime checks and
138 16,294 independent Unicode NFC oracle
139 comparisons. The oracle needs Python UCD 15.0 or 15.1 (tables use UCD 15.1.0).
140 A report path also produces `<path>.semantics.json` with
141 separate model observations, plus `<path>.merging.json`, `<path>.associations.json`
142 and `<path>.cxtm.json` (complete actual/expected XML and byte counts),
143 plus `<path>.occurrences.json` with separate actual Occurrence objects/properties
144 and `<path>.prefixes.json` with all seven selected observations, plus `<path>.integers.json` for integer objects
145 and independently checked arithmetic probes, plus `<path>.decimals.json` with
146 seven Decimal object observations and 157 independent Decimal arithmetic probes,
147 plus `<path>.dates.json` with five original Date results, five original rejections,
148 396 independent date/calendar probes and 15 century decisions. `<path>.datetimes.json` records five actual DateTime
149 models, 45 independent lexical/canonical probes and two executed baseline
150 discrepancies. `<path>.timezones.json` adds exact UTC, fraction and model-purity
151 probes, including every one of the 1681 permitted signed offset minutes.
152 The merge checks include 128 graph/order variants with an independent reachability
153 oracle. Reports are deterministic across the tested SBCL versions and checkout
154 relocation. See [Slice 11 validation](docs/slice-11-validation.md) for current evidence.
155 [Slice 10 validation](docs/slice-10-validation.md) preserves the earlier DateTime baseline.
156 [Slice 9 validation](docs/slice-9-validation.md) records the accepted Date subset.
157 [Slice 8 validation](docs/slice-8-validation.md) records the accepted Decimal subset.
158 [Slice 7 validation](docs/slice-7-validation.md) records the accepted Integer subset.
159 [Slice 6 validation](docs/slice-6-validation.md) records the preceding accepted subset.
160 [Slice 5 validation](docs/slice-5-validation.md) records the preceding accepted subset.
161 [Slice 4 validation](docs/slice-4-validation.md) records the accepted baseline.
162 [Slice 3 validation](docs/slice-3-validation.md),
163 [imported contracts](reports/slice-1/validation.json) and
164 [semantic observations](reports/slice-1/semantics.json).
165
166 [Slice 0 inventory](docs/inventory.md), [architecture](docs/architecture.md),
167 [coverage](docs/coverage.md) and [validation](docs/validation.md) remain historical
168 foundation records. Their original report/logs are preserved. Their statements
169 about absent reader/model systems describe Slice 0, not the current branch.
170 Slice 1 is built from `9c83db34eb1ba8091b004433f088056717dbaa7e` on
171 `codex/ctm-slice-1`. Slice 2 starts from the accepted Slice 1a commit
172 `fb60afd548d679d83fd8ec76bc5ff384c1e23e5f` on `codex/ctm-slice-2`.
173 Slice 11 starts from `8741d155d948c7317945eee423a977940cad995e` on
174 `codex/ctm-slice-11`.
175 Slice 10 starts from `2ad41cd1a945a4ce97824464de40646bb899259e` on
176 `codex/ctm-slice-10`.
177 Slice 9 starts from `195d5f5444d776096b765d04c815c23c3db5f84c` on
178 `codex/ctm-slice-9`.
179 Slice 8 starts from `17dd58775e25ab495e3c83deb4b5a36f5e5a124b` on
180 `codex/ctm-slice-8`.
181 Slice 7 starts from `3924d1eac5a070fe5a6a26683e23ac338793f544` on
182 `codex/ctm-slice-7`.
183 Slice 6 starts from `437ad53ea7539d36db3fa871d0931650b7a6a03e` on
184 `codex/ctm-slice-6`.
185 Slice 5 starts from `8036a2b1ce009218f33d300edcc5f715ec1d1124` on
186 `codex/ctm-slice-5`.
187 Slice 4 starts from `35648c4dcc71e8dc6448b64abcacb438e53d64a2` on
188 `codex/ctm-slice-4`.
189 Slice 3 starts from accepted `66664dbff6275d60dab1bc6a232fa70f7b916b8c` on
190 `codex/ctm-slice-3`. Await review before continuing to the next slice.