]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - README.md
Implement XTM 2.0 identity and instanceOf reader with offline evidence
[topic-maps.git] / README.md
1 # Common Lisp Topic Maps โ€” Slice 19D1
2
3 Slice 19D1 adds **`topic-maps/xtm`**, an XTM 2.0 identity/`instanceOf` subset.
4 Six unchanged XTM sources match their original CXTM baselines byte-for-byte;
5 results are separate from the unchanged **204 PASS / 4 FAIL / 65 NOT-RUN** CTM
6 contracts. No CTM XTM-Mergemap integration or full XTM conformance is claimed.
7 See [the XTM API, model and reproduction guide](docs/slice-19d1-xtm-identity.md).
8
9
10 Slice 19D0B qualifies local, versioned CXML/closure-common encoding corrections:
11 **58 original and 88 additional XML checks PASS** in fresh offline SBCL 2.5.4.
12 The required entry point is `topic-maps.xml:parse-octets` after offline source
13 patch preparation; it enforces external-resource denial. Slice 19D1 uses that boundary for its independent XTM 2.0 identity reader. See [encoding qualification](docs/slice-19d0b-cxml-encoding.md).
14
15 Slice 19D0 made pinned CXML sources available to ASDF through the Nix source
16 environment. Its initial parser qualification failed on UTF-16 supplementary
17 characters and invalid UTF-8; those historical failures are retained. See
18 [CXML provisioning and qualification](docs/slice-19d0-cxml.md) for exact hashes,
19 offline loading, external-entity policy, the failing probes and retained regression.
20
21 Slice 19C adds `%include` with controlled resources, per-level Topic-II aliases,
22 immediate-parent Document/Wildcard environments, Counter propagation and
23 source-preserving Template import. Imported bodies execute in the caller's
24 identity/Prefix environment while errors preserve definition and invocation
25 sources. See [Reading CTM Include](docs/reading-ctm-include.md) and
26 [Slice 19C validation](docs/slice-19c-validation.md).
27 The registered corpus is **204 PASS, 4 FAIL, 65 NOT-RUN**. All twelve Include
28 contracts execute: seven byte-equal positives, three intended rejections, two
29 explicit normative/baseline mismatches. The two earlier DateTime FAILs remain.
30
31 Slice 19B adds CTM `%mergemap` with the CTM notation and an explicit
32 `:resource-resolver` on `deserialize-string` / `deserialize-file`. Resources are
33 supplied as bytes by the caller, deserialized with independent environments,
34 and transferred by Slice 19A's TMDM content import. No implicit file/network
35 retrieval is provided (Include is added by Slice 19C). XTM Mergemap remains unsupported.
36 See [Reading CTM Mergemap](docs/reading-ctm-mergemap.md) and
37 [Slice 19B validation](docs/slice-19b-validation.md).
38 The registered corpus now has **194 PASS, 2 known DateTime FAIL, 77 NOT-RUN**:
39 four new byte-exact positive contracts and three intended negative rejections.
40
41 Slice 19A adds `topic-maps.tmdm:import-map-content`: source-preserving copying
42 of Topics, Associations and their children into a target Map, followed by the
43 existing same-map identity and structural merging. Both original graphs remain
44 unchanged on semantic rejection. The returned resolver tracks canonical target
45 representatives. Source Map identifiers/reifier are excluded.
46 See [Reading Map Content Import](docs/reading-map-content-import.md) for the API,
47 object references and inspection forms, and [Slice 19A validation](docs/slice-19a-validation.md)
48 for fresh offline execution evidence. This adds no CTM import contracts:
49 **187 PASS, 2 known DateTime FAIL, 84 NOT-RUN** remain unchanged.
50
51 A working ANSI Common Lisp reader for CTM identity/name syntax and
52 Associations with one or more Roles, with same-map merging of Topics, Names, Associations
53 and Roles, plus string/IRI-valued Occurrences, in a bounded TMDM model. HyperDoc remains a possible future client
54 and is neither the codebase nor a dependency. Slice 4 adds a pure, independent
55 CXTM canonicalizer for this model. Controlled Include/Mergemap and Map content import are described above. Slice 5 adds Occurrence items and replacement merging
56 without expanding Scope, Reification or Variants. Slice 6 adds document-local
57 prefixes, QName resolution and explicit datatype locators on quoted Occurrence
58 values. Unknown datatypes retain their lexical values; Date timezone CXTM rules
59 remain explicitly unsupported. Slice 7 adds integer literals, lexical validation
60 and pure xsd:integer canonical output; qualified strings retain their stored
61 lexical values. Slice 8 adds decimal literals, exact character-based xsd:decimal
62 canonicalization and lexical validation, with the same separation of stored
63 strings, TMDM equality and canonical serialization. Slice 9 adds timezone-free
64 xsd:date literals, Gregorian calendar validation and pure CXTM Date output.
65 Negative-year leap validation follows the documented XSD 1.0 E.1 interpretation.
66 Slice 10 adds xsd:dateTime with absent/zero zones, exact fractional precision and
67 midnight rollover. A noncandidate leap-second baseline disagrees with XSD D.1
68 following-minute interpretation and remains FAIL. Slice 11 adds exact nonzero-offset UTC canonicalization; the original timezone2
69 contract now executes and reports its known inconsistent baseline as FAIL.
70 Nonzero-offset BCE day rollover and leap-second contexts remain explicitly
71 unsupported; existing zero/absent-zone behavior is retained.
72 Slice 12A adds explicitly typed Topic Names. Slice 13 adds Scope Topic sets to
73 Names, Occurrences and Associations, including reference replacement, duplicate
74 merging and canonical output. Slice 14 adds unreified Variants with proper Scope
75 supersets, canonical merge handles and pure CXTM output. Slice 15 adds per-document
76 Wildcards and recursive Embedded Topics through the shared Topic reference reader.
77 Slice 16A adds general Item Identifiers for all seven existing information-item
78 kinds, including metadata-preserving replacement merges and pure CXTM output.
79 Slice 16B adds same-map Reification, full merge cascades, atomic semantic
80 preflight and all six CTM Reifier attachment positions.
81 Slice 17A removes the two-Role CTM limit, preserving the existing model and
82 canonicalizer. Slice 17B adds `isa`/`ako` using ordinary Associations and protects
83 the distinct Core Subjects defined by TMDM 2006 ยง7. Atomic merge preflight uses
84 the existing disposable TMDM graph. No inference engine is introduced.
85
86 Slice 18 adds grammar-checked Templates, contextual positional arguments,
87 global/Tail/nested Invocations, invocation-local Wildcards and canonical handles
88 through existing model operations. Seven explicitly documented grammar contracts
89 remain open; no extra TMDM item kind or Lisp evaluation is introduced.
90
91 Start with [CTM Templates and Invocations](docs/reading-ctm-templates.md) for
92 representation, diagnostics, open grammar cases and executable inspection forms.
93 See [Slice 18 validation](docs/slice-18-validation.md) for the full offline run,
94 57 additional byte-exact original contracts and ten specific rejection contracts.
95
96 Start with [isa/ako and Core Subject Consistency](docs/reading-type-relationships.md)
97 for the exact vocabulary, object relations, normative distinctions and inspection.
98 See [Slice 17B validation](docs/slice-17b-validation.md) for the complete offline
99 regression and thirteen new original byte-exact comparisons.
100
101 Start with [Associations with Arbitrarily Many Roles](docs/reading-association-arity.md)
102 for the actual seven-Topic/three-Role example and executable inspection forms.
103 See [Slice 17A validation](docs/slice-17a-validation.md) for the full offline run
104 and the single new byte-exact original contract.
105
106 Start with [Reification](docs/reading-reification.md) for actual Reifier/Reified
107 objects, normative clauses, cascade handling and inspection forms.
108 See [General Item Identifiers](docs/reading-item-identifiers.md) for the
109 uniform API, retained handles, exact boundaries and executable inspection forms.
110
111 Systems: `topic-maps` (the retained foundation), `topic-maps/tests`,
112 `topic-maps/tmdm`, `topic-maps/ctm`, `topic-maps/ctm/tests` and
113 `topic-maps/ctm/merging-tests` and `topic-maps/ctm/association-tests`, plus `topic-maps/cxtm` and
114 `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`.
115 The core reader/model uses ANSI Common Lisp; the foundation/tooling uses
116 ASDF/UIOP and Python's standard library. No Quicklisp packages are required.
117 `topic-maps/tmdm/identifier-tests` and `topic-maps/tmdm/reification-tests` add the
118 general identifier and Reification regression suites.
119 `topic-maps/ctm/association-arity-tests` adds n-ary syntax, merge/handle checks
120 and the original `association-duplicate-role.ctm` comparison.
121 `topic-maps/ctm/type-relationship-tests` adds Core consistency, atomic failure
122 and isa/ako model/reference-graph checks.
123
124 Start with [Reading Topic References](docs/reading-topic-references.md) for Wildcard
125 IRIs/counters, recursive Embedded Topics and actual object relationships.
126 [Reading Variants](docs/reading-variants.md) for Parent Name relationships,
127 explicit/resulting Scope, merge preflight and the four original contracts.
128 [Reading Scope](docs/reading-scope.md) for Scope APIs, actual Topic
129 references, merge handles and the three original comparisons.
130 [Reading Typed Topic Names](docs/reading-typed-topic-names.md) covers Slice 12A.
131 [Reading DateTime Timezone Canonicalization](docs/reading-datetime-timezones.md)
132 for UTC conversion, calendar limits, actual stored strings and executable inspection.
133 [Reading DateTime Occurrences](docs/reading-datetime-occurrences.md)
134 for lexical/value/canonical distinctions and the two normative discrepancies.
135 [Reading Date Occurrences](docs/reading-date-occurrences.md)
136 for the ten original Date cases, calendar rules, stored values and inspection.
137 [Reading Decimal Occurrences](docs/reading-decimal-occurrences.md)
138 for the seven Decimal cases, string representation, equality and inspection.
139 [Reading Integer Occurrences](docs/reading-integer-occurrences.md)
140 for integer representation, lexical equality, canonicalization and inspection.
141 [Reading Prefixes and Explicit Datatypes](docs/reading-prefixes-and-datatypes.md)
142 for the seven original cases, current API, object properties and diagnostics.
143 [Reading the First Four CTM Occurrences](docs/reading-first-occurrences.md)
144 for actual parent/type references, literal values, datatypes and executable inspection.
145 [Reading Canonical Topic Maps](docs/reading-canonical-topic-maps.md)
146 for the CXTM API, normative clauses, base-locator policy and actual byte comparisons.
147 [Reading the First CTM Associations](docs/reading-first-ctm-associations.md)
148 for actual Association/Role items, late Topic merges and current subset boundaries.
149 [Reading Topic Identity and Merging](docs/reading-topic-merging.md)
150 for the current API, reference replacement, identifier tails and exact subset
151 boundaries. See [Reading the First Five CTM Documents](docs/reading-first-five-ctm-documents.md)
152 for original sources, actual objects, normative clauses, baseline evidence and
153 copy-pasteable DESCRIBE forms. [API and boundaries](docs/slice-1-api-and-boundaries.md)
154 document the accepted Slice 1 baseline; the Slice 2 document supersedes its
155 statements about absent identity tails, merging and immutable Name references.
156 The Slice 3 document supersedes historical statements about absent Associations/Roles.
157
158 The pinned suite targets the **CTM draft dated 2010-03-31**. Passing it alone
159 does not establish full ISO/IEC 13250-6:2010 conformity.
160
161 ## Load and inspect
162
163 In a new Common Lisp process, with this checkout selected:
164
165 ```lisp
166 (require :asdf)
167 (asdf:initialize-source-registry
168 '(:source-registry :ignore-inherited-configuration))
169 (asdf:load-asd #p"/Users/rgb/workspace/topic-maps/topic-maps.asd")
170 (asdf:load-system "topic-maps/ctm")
171 (asdf:load-system "topic-maps")
172 (defparameter *corpus* (topic-maps.test-foundation:discover-corpus))
173 (topic-maps.test-foundation:summarize-corpus *corpus*)
174 (topic-maps.test-foundation:select-cases *corpus* :category :invalid)
175 (topic-maps.test-foundation:select-cases *corpus* :id "ctm/in/simple.ctm")
176 (asdf:test-system "topic-maps/tests")
177 (asdf:test-system "topic-maps/ctm/tests")
178 (asdf:test-system "topic-maps/ctm/merging-tests")
179 (asdf:test-system "topic-maps/ctm/association-tests")
180 (asdf:test-system "topic-maps/ctm/decimal-tests") ; includes retained Integer/Prefix/Occurrence/CXTM suites
181 (topic-maps.test-foundation:write-validation-report
182 *corpus* #p"/tmp/topic-maps-inventory.json")
183 ```
184
185 Change only the checkout pathname when using another machine. The case's
186 Document IRI remains independent of that pathname. Records are inspectable
187 Common Lisp structures, with actual source/baseline pathnames and explicit
188 contracts, results, statuses, diagnostics and reviewed clauses.
189
190 ## Offline verification
191
192 ```sh
193 # SBCL must already be installed. No network is used by this command.
194 TOPIC_MAPS_REPORT=/tmp/topic-maps-validation.json ./scripts/test.sh
195 ```
196
197 Set `SBCL=/absolute/path/to/sbcl` if needed. The launcher starts a new process,
198 ignores system/user initialization, clears inherited ASDF source configuration
199 and writes FASLs outside the repository. It runs byte-integrity fixtures,
200 Common Lisp infrastructure checks and an independent JSON-schema/content check
201 when a report pathname is supplied. `nix develop path:.` supplies a minimal,
202 pinned SBCL/Python/Git environment; initial environment provisioning may need
203 network access, while test execution after provisioning does not.
204
205 The complete upstream corpus is already vendored, unchanged. If absent in a
206 source distribution, acquire it once:
207
208 ```sh
209 python3 scripts/corpus.py acquire
210 python3 scripts/corpus.py verify
211 ```
212
213 Acquisition uses the exact commit and archive digest in
214 [corpus-lock.json](references/corpus-lock.json), refuses to merge over existing
215 contents and verifies every file. Verification is offline. Valid CTM inputs
216 are selected only under `ctm/in`, invalid ones only under `ctm/invalid`, and
217 CXTM baselines only under `ctm/baseline`. Auxiliary files are reported separately.
218
219 ## Current validation and historical foundation
220
221 The complete pinned corpus remains unchanged: 231 valid CTM inputs, 42 invalid
222 inputs, 231 CXTM baselines and 22 CTM auxiliary files. One hundred sixty-five selected positive
223 cases pass actual CXTM byte comparisons. Twenty-two specific rejection contracts pass.
224 Two executed DateTime contracts remain FAIL because of documented normative
225 baseline discrepancies; 84 contracts remain NOT-RUN. A green regression run
226 preserves those two FAILs and never changes an upstream baseline. Unsupported
227 constructs and I/O errors cannot count as the required CTM rejection.
228
229 The full launcher runs the retained 54 foundation checks, two Python integrity
230 fixtures, 123 retained identity checks, 646 merge checks, 657 Association checks,
231 imported-report validation and selected baseline
232 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
233 244 general Item Identifier checks, 236 Reification checks, 337 n-ary Association
234 checks, 1,016 Core Subject/type-relationship checks, 297 Template checks and 16,294 independent Unicode NFC oracle
235 comparisons. The oracle needs Python UCD 15.0 or 15.1 (tables use UCD 15.1.0).
236 A report path also produces `<path>.semantics.json` with
237 separate model observations, plus `<path>.merging.json`, `<path>.associations.json`
238 and `<path>.cxtm.json` (complete actual/expected XML and byte counts),
239 plus `<path>.occurrences.json` with separate actual Occurrence objects/properties
240 and `<path>.prefixes.json` with all seven selected observations, plus `<path>.integers.json` for integer objects
241 and independently checked arithmetic probes, plus `<path>.decimals.json` with
242 seven Decimal object observations and 157 independent Decimal arithmetic probes,
243 plus `<path>.dates.json` with five original Date results, five original rejections,
244 396 independent date/calendar probes and 15 century decisions. `<path>.datetimes.json` records five actual DateTime
245 models, 45 independent lexical/canonical probes and two executed baseline
246 discrepancies. `<path>.timezones.json` adds exact UTC, fraction and model-purity
247 probes, including every one of the 1681 permitted signed offset minutes.
248 The merge checks include 128 graph/order variants with an independent reachability
249 oracle. Earlier slices recorded version/relocation comparisons; Slice 17A uses
250 the existing single-runtime environment. `<path>.typed-names.json` records Name value/Parent/Type relations;
251 `<path>.scopes.json` records Scope object relations and an ordering witness.
252 `<path>.variants.json` records Variant/Parent/Scope observations and XML ordering.
253 `<path>.references.json` records the new source/counter/model observations.
254 `<path>.identifiers.json` and `<path>.reification.json` retain their model evidence;
255 `<path>.arity.json` adds actual Role references and twelve canonical XML witnesses.
256 `<path>.relationships.json` records the thirteen original reference graphs and
257 atomic Core Subject conflict observations.
258 `<path>.templates.json` records the 57 model observations and ten specific
259 rejections, including original positions and invocation contexts.
260 See [Slice 19B validation](docs/slice-19b-validation.md) for current evidence.
261 [Slice 12A validation](docs/slice-12a-validation.md) records explicit Name types.
262 [Slice 11 validation](docs/slice-11-validation.md) preserves the prior timezone evidence.
263 [Slice 10 validation](docs/slice-10-validation.md) preserves the earlier DateTime baseline.
264 [Slice 9 validation](docs/slice-9-validation.md) records the accepted Date subset.
265 [Slice 8 validation](docs/slice-8-validation.md) records the accepted Decimal subset.
266 [Slice 7 validation](docs/slice-7-validation.md) records the accepted Integer subset.
267 [Slice 6 validation](docs/slice-6-validation.md) records the preceding accepted subset.
268 [Slice 5 validation](docs/slice-5-validation.md) records the preceding accepted subset.
269 [Slice 4 validation](docs/slice-4-validation.md) records the accepted baseline.
270 [Slice 3 validation](docs/slice-3-validation.md),
271 [imported contracts](reports/slice-1/validation.json) and
272 [semantic observations](reports/slice-1/semantics.json).
273
274 [Slice 0 inventory](docs/inventory.md), [architecture](docs/architecture.md),
275 [coverage](docs/coverage.md) and [validation](docs/validation.md) remain historical
276 foundation records. Their original report/logs are preserved. Their statements
277 about absent reader/model systems describe Slice 0, not the current branch.
278 Slice 1 is built from `9c83db34eb1ba8091b004433f088056717dbaa7e` on
279 `codex/ctm-slice-1`. Slice 2 starts from the accepted Slice 1a commit
280 `fb60afd548d679d83fd8ec76bc5ff384c1e23e5f` on `codex/ctm-slice-2`.
281 Slice 13 starts from `788899aea1a20b9cd8237c6106e6613e180d7362` on
282 `codex/ctm-slice-13`.
283 Slice 14 starts from `aeb017e4f4846f2e6a701e581d20eef84a8b83d9` on
284 `codex/ctm-slice-14`.
285 Slice 11 starts from `8741d155d948c7317945eee423a977940cad995e` on
286 `codex/ctm-slice-11`.
287 Slice 10 starts from `2ad41cd1a945a4ce97824464de40646bb899259e` on
288 `codex/ctm-slice-10`.
289 Slice 9 starts from `195d5f5444d776096b765d04c815c23c3db5f84c` on
290 `codex/ctm-slice-9`.
291 Slice 8 starts from `17dd58775e25ab495e3c83deb4b5a36f5e5a124b` on
292 `codex/ctm-slice-8`.
293 Slice 7 starts from `3924d1eac5a070fe5a6a26683e23ac338793f544` on
294 `codex/ctm-slice-7`.
295 Slice 6 starts from `437ad53ea7539d36db3fa871d0931650b7a6a03e` on
296 `codex/ctm-slice-6`.
297 Slice 5 starts from `8036a2b1ce009218f33d300edcc5f715ec1d1124` on
298 `codex/ctm-slice-5`.
299 Slice 4 starts from `35648c4dcc71e8dc6448b64abcacb438e53d64a2` on
300 `codex/ctm-slice-4`.
301 Slice 3 starts from accepted `66664dbff6275d60dab1bc6a232fa70f7b916b8c` on
302 `codex/ctm-slice-3`. Await review before continuing to the next slice.
303
304 Slice 15 starts from `4f7b4d26d40f8f5566594aa2e3ad6296d44fc4c3` on `codex/ctm-slice-15`.