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