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