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