1 (in-package #:topic-maps.tmdm)
3 (defun identifiers (topic kind)
5 (:item-identifier (%topic-item-identifiers topic))
6 (:subject-identifier (%topic-subject-identifiers topic))
7 (:subject-locator (%topic-subject-locators topic))))
9 (defun identifier-matches-p (topic kind iri)
10 ;; One identity rule for lookup and merging: TMDM 5.3.5, excluding reification.
11 (some (lambda (property) (member iri (identifiers topic property) :test #'string=))
13 ((:item-identifier :subject-identifier) '(:item-identifier :subject-identifier))
14 (:subject-locator '(:subject-locator)))))
16 (defun equal-topics-p (a b)
17 (or (some (lambda (kind)
18 (some (lambda (iri) (identifier-matches-p a kind iri)) (identifiers b kind)))
19 '(:item-identifier :subject-identifier :subject-locator))
20 (let ((target (topic-reified a))) (and target (eq target (topic-reified b))))))
22 (defun set-union (a b test)
23 (remove-duplicates (append a b) :test test :from-end t))
25 (defun replace-pair (items a b replacement)
26 ;; Set ordering is not normative; retain the first replaced position.
27 (loop with inserted = nil for item in items
28 append (if (or (eq item a) (eq item b))
29 (unless inserted (setf inserted t) (list replacement))
32 (defun equal-pair (items predicate)
33 (loop for tail on items do
34 (let ((other (find-if (lambda (item) (funcall predicate (first tail) item)) (rest tail))))
35 (when other (return (list (first tail) other))))))
37 (define-condition scope-error (error)
38 ((code :initarg :code :reader scope-error-code)
39 (detail :initarg :detail :reader scope-error-detail))
40 (:report (lambda (c stream) (format stream "Scope ~A: ~A" (scope-error-code c) (scope-error-detail c)))))
41 (defun scope-problem (code detail) (error 'scope-error :code code :detail detail))
42 (defun proper-list-p (value)
43 ;; LIST-LENGTH detects cycles; dotted tails signal TYPE-ERROR. ANSI CL only.
44 (and (listp value) (handler-case (integerp (list-length value)) (type-error () nil))))
45 (defun canonical-scope (map themes)
46 "Validate before mutation and copy a set of current same-map Topic references."
47 (unless (proper-list-p themes)
48 (scope-problem :invalid-scope "Supply a proper finite list of Topics."))
50 (mapcar (lambda (theme)
51 (unless (typep theme 'topic) (scope-problem :invalid-theme "A theme must be a Topic object."))
52 (let ((current (live-topic theme)))
53 (unless (eq map (%topic-parent current))
54 (scope-problem :foreign-theme "Every theme must belong to the item's Topic Map."))
56 :test #'eq :from-end t))
57 (defun same-scope-p (a b)
58 ;; Storage is canonical and duplicate-free; equality has no sequence ordering.
59 (and (= (length a) (length b)) (every (lambda (theme) (member theme b :test #'eq)) a)))
61 (defun normalize-names (map)
62 ;; Rescan live owners after each replacement: merging Reifiers can replace
63 ;; the owner/type/theme of the very Name currently being normalized.
64 (loop for entry = (loop for topic in (%topic-map-topics map)
65 for pair = (equal-pair (%topic-names topic)
66 (lambda (a b) (and (string= (%topic-name-value a) (%topic-name-value b))
67 (eq (%topic-name-type a) (%topic-name-type b))
68 (same-scope-p (%topic-name-scope a) (%topic-name-scope b)))))
69 when pair return (cons topic pair))
71 (let* ((topic (first entry)) (a (second entry)) (b (third entry))
72 (c (%make-topic-name (%topic-name-value a) (%topic-name-type a) topic)))
73 (setf (%topic-name-scope c) (copy-list (%topic-name-scope a))
74 (%topic-name-item-identifiers c) (set-union (%topic-name-item-identifiers a) (%topic-name-item-identifiers b) #'string=)
75 (%topic-name-variants c) (set-union (%topic-name-variants a) (%topic-name-variants b) #'eq)
76 (%topic-names topic) (replace-pair (%topic-names topic) a b c)
77 (%topic-name-forward a) c (%topic-name-forward b) c)
78 (dolist (v (%topic-name-variants c)) (setf (%variant-parent v) c))
79 (merge-item-reifiers c a b)))
80 (normalize-variants map))
82 (defun merge-two-topics (map a b)
83 ;; TMDM 6.2: create C, union supported properties, replace model references.
84 ;; TMDM 6.2 conflict is checked against current targets BEFORE replacement.
85 (check-core-subject-identifiers (append (%topic-subject-identifiers a) (%topic-subject-identifiers b)))
86 (let ((left (topic-reified a)) (right (topic-reified b)))
87 (when (and left right (not (eq left right)))
88 (reification-problem :reifier-conflict "Topics reify different information items.")))
89 (check-variant-merge-constraints map :pair (list a b))
90 (let ((c (%make-topic map)))
91 (setf (%topic-item-identifiers c) (set-union (%topic-item-identifiers a) (%topic-item-identifiers b) #'string=)
92 (%topic-subject-identifiers c) (set-union (%topic-subject-identifiers a) (%topic-subject-identifiers b) #'string=)
93 (%topic-subject-locators c) (set-union (%topic-subject-locators a) (%topic-subject-locators b) #'string=)
94 (%topic-names c) (set-union (%topic-names a) (%topic-names b) #'eq)
95 (%topic-occurrences c) (set-union (%topic-occurrences a) (%topic-occurrences b) #'eq)
96 (%topic-map-topics map) (replace-pair (%topic-map-topics map) a b c)
97 (%topic-forward a) c (%topic-forward b) c)
98 (dolist (topic (%topic-map-topics map))
99 (dolist (name (%topic-names topic))
100 ;; Parent is the computed containing topic (TMDM 5.4).
101 (setf (%topic-name-parent name) topic
102 (%topic-name-type name) (canonical-topic (%topic-name-type name))
103 (%topic-name-scope name) (canonical-scope map (%topic-name-scope name)))
104 (dolist (item (%topic-name-variants name))
105 (setf (%variant-scope item) (canonical-scope map (%variant-scope item))))))
106 (dolist (topic (%topic-map-topics map))
107 (dolist (occurrence (%topic-occurrences topic))
108 (setf (%occurrence-parent occurrence) topic
109 (%occurrence-type occurrence) (canonical-topic (%occurrence-type occurrence))
110 (%occurrence-scope occurrence) (canonical-scope map (%occurrence-scope occurrence)))))
111 (dolist (association (%topic-map-associations map))
112 (setf (%association-type association) (canonical-topic (%association-type association))
113 (%association-scope association) (canonical-scope map (%association-scope association)))
114 (dolist (role (%association-roles association))
115 (setf (%association-role-type role) (canonical-topic (%association-role-type role))
116 (%association-role-player role) (canonical-topic (%association-role-player role)))))
117 (dolist (item (map-information-items map))
118 (when (and (reifiable-p item) (%item-reifier item))
119 (setf (%item-reifier item) (canonical-topic (%item-reifier item)))))
120 (normalize-names map)
121 (normalize-occurrences map)
122 (normalize-associations map)
123 (canonical-topic c)))
125 (defun normalize-topic-map (map)
126 "Reach a fixed point of same-map Topic and structural item merging."
127 (check-type map topic-map)
128 (when (needs-merge-preflight-p map)
129 (return-from normalize-topic-map
130 (preflight-merge-mutation map (lambda (ref) (normalize-topic-map (funcall ref map))))))
131 (validate-map-core-subjects map)
132 (check-variant-merge-constraints map)
133 (loop for before = (length (map-information-items map)) do
134 (loop for pair = (equal-pair (%topic-map-topics map) #'equal-topics-p)
135 while pair do (merge-two-topics map (first pair) (second pair)))
136 (normalize-names map) (normalize-occurrences map) (normalize-associations map)
137 when (= before (length (map-information-items map))) return map))
139 (defun live-topic (topic)
140 (let ((current (canonical-topic topic)))
141 (unless (member current (%topic-map-topics (%topic-parent current)) :test #'eq)
142 (error "Topic is not a live member of its map."))
145 (defun merge-topics (a b)
146 "Merge two Topics in the same map, returning their current representative.
147 Explicit merging may assert shared subject identity beyond locator equality.
148 Cross-map merging is rejected before mutation. Obsolete handles remain resolvable."
149 (let* ((a (live-topic a)) (b (live-topic b)) (map (%topic-parent a)))
150 (unless (eq map (%topic-parent b)) (error "Cross-map Topic merging is outside this API."))
151 (when (needs-merge-preflight-p map)
152 (return-from merge-topics (preflight-merge-mutation map
153 (lambda (ref) (merge-topics (funcall ref a) (funcall ref b))))))
154 (unless (eq a b) (setf a (merge-two-topics map a b)))
155 (normalize-topic-map map)
156 (canonical-topic a)))
158 (defun add-topic-identifier (topic kind iri)
159 "Add a locator to its distinct identity property and perform required merging.
160 KIND is :ITEM-IDENTIFIER, :SUBJECT-IDENTIFIER or :SUBJECT-LOCATOR.
161 IRI is an already resolved, nonempty absolute locator string; CTM validates it."
162 (unless (and (stringp iri) (plusp (length iri))) (error "A nonempty locator string is required."))
163 (let ((topic (live-topic topic)))
164 (when (needs-merge-preflight-p (%topic-parent topic))
165 (return-from add-topic-identifier (preflight-merge-mutation (%topic-parent topic)
166 (lambda (ref) (add-topic-identifier (funcall ref topic) kind iri)))))
167 (when (eq kind :subject-identifier)
168 (check-core-subject-identifiers (cons iri (%topic-subject-identifiers topic))))
169 (check-topic-occurrence-identifiers (%topic-parent topic) kind iri)
170 ;; Check the entire prospective identity closure before adding the locator.
171 (check-variant-merge-constraints (%topic-parent topic) :identifier (list topic kind iri))
173 (:item-identifier (pushnew (copy-seq iri) (%topic-item-identifiers topic) :test #'string=))
174 (:subject-identifier (pushnew iri (%topic-subject-identifiers topic) :test #'string=))
175 (:subject-locator (pushnew iri (%topic-subject-locators topic) :test #'string=)))
176 (normalize-topic-map (%topic-parent topic))
177 (canonical-topic topic)))
179 (defun intern-topic (map kind iri)
180 "Lookup/create a Topic using the same identity rule as same-map merging."
181 (check-type map topic-map)
182 (unless (and (stringp iri) (plusp (length iri))) (error "A nonempty locator string is required."))
183 ;; Validate the category even for an empty map, before adding a Topic.
184 (ecase kind ((:item-identifier :subject-identifier :subject-locator)))
185 (check-topic-occurrence-identifiers map kind iri)
186 ;; Preflight BEFORE creating a new Topic, so rejected cascades cannot leave
187 ;; even an empty newly interned item in the original Map.
188 (when (needs-merge-preflight-p map)
189 (return-from intern-topic (preflight-merge-mutation map
190 (lambda (ref) (intern-topic (funcall ref map) kind iri)))))
191 (let ((topic (or (find-if (lambda (topic) (identifier-matches-p topic kind iri))
192 (%topic-map-topics map))
193 (let ((new (%make-topic map)))
194 (setf (%topic-map-topics map) (append (%topic-map-topics map) (list new)))
196 (add-topic-identifier topic kind iri)))
198 (defun add-name (topic value &key (type nil type-supplied-p) scope)
199 "Add a Name with VALUE, optional TYPE Topic and SCOPE Topic set (TMDM 5.4).
200 Validate all arguments before interning the default type. Retained Topic handles
201 are canonicalized, including after default-type identity merging."
202 (check-type value string)
203 (let* ((topic (live-topic topic)) (map (%topic-parent topic))
204 (scope (canonical-scope map scope))
205 (type (when type-supplied-p (live-topic type))))
206 (when (and type-supplied-p (not (eq map (%topic-parent type))))
207 (error "Name type belongs to another map."))
208 (unless type-supplied-p
209 (setf type (intern-topic map :subject-identifier (default-name-type-identifier))))
210 (let* ((topic (canonical-topic topic)) (type (canonical-topic type))
211 (scope (canonical-scope map scope))
212 (existing (find-if (lambda (name)
213 (and (string= value (%topic-name-value name))
214 (eq type (%topic-name-type name))
215 (same-scope-p scope (%topic-name-scope name))))
216 (%topic-names topic))))
218 (let ((name (%make-topic-name value type topic)))
219 (setf (%topic-name-scope name) scope
220 (%topic-names topic) (append (%topic-names topic) (list name)))
223 (defun add-default-name (topic value &key scope)
224 "Compatibility entry point for ADD-NAME with the CTM 3.11 default type."
225 (add-name topic value :scope scope))