]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - src/tmdm/merging.lisp
Support CTM associations with arbitrarily many roles
[topic-maps.git] / src / tmdm / merging.lisp
1 (in-package #:topic-maps.tmdm)
2
3 (defun identifiers (topic kind)
4 (ecase kind
5 (:item-identifier (%topic-item-identifiers topic))
6 (:subject-identifier (%topic-subject-identifiers topic))
7 (:subject-locator (%topic-subject-locators topic))))
8
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=))
12 (ecase kind
13 ((:item-identifier :subject-identifier) '(:item-identifier :subject-identifier))
14 (:subject-locator '(:subject-locator)))))
15
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))))))
21
22 (defun set-union (a b test)
23 (remove-duplicates (append a b) :test test :from-end t))
24
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))
30 (list item))))
31
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))))))
36
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."))
49 (remove-duplicates
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."))
55 current)) themes)
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)))
60
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))
70 while entry do
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))
81
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 (let ((left (topic-reified a)) (right (topic-reified b)))
86 (when (and left right (not (eq left right)))
87 (reification-problem :reifier-conflict "Topics reify different information items.")))
88 (check-variant-merge-constraints map :pair (list a b))
89 (let ((c (%make-topic map)))
90 (setf (%topic-item-identifiers c) (set-union (%topic-item-identifiers a) (%topic-item-identifiers b) #'string=)
91 (%topic-subject-identifiers c) (set-union (%topic-subject-identifiers a) (%topic-subject-identifiers b) #'string=)
92 (%topic-subject-locators c) (set-union (%topic-subject-locators a) (%topic-subject-locators b) #'string=)
93 (%topic-names c) (set-union (%topic-names a) (%topic-names b) #'eq)
94 (%topic-occurrences c) (set-union (%topic-occurrences a) (%topic-occurrences b) #'eq)
95 (%topic-map-topics map) (replace-pair (%topic-map-topics map) a b c)
96 (%topic-forward a) c (%topic-forward b) c)
97 (dolist (topic (%topic-map-topics map))
98 (dolist (name (%topic-names topic))
99 ;; Parent is the computed containing topic (TMDM 5.4).
100 (setf (%topic-name-parent name) topic
101 (%topic-name-type name) (canonical-topic (%topic-name-type name))
102 (%topic-name-scope name) (canonical-scope map (%topic-name-scope name)))
103 (dolist (item (%topic-name-variants name))
104 (setf (%variant-scope item) (canonical-scope map (%variant-scope item))))))
105 (dolist (topic (%topic-map-topics map))
106 (dolist (occurrence (%topic-occurrences topic))
107 (setf (%occurrence-parent occurrence) topic
108 (%occurrence-type occurrence) (canonical-topic (%occurrence-type occurrence))
109 (%occurrence-scope occurrence) (canonical-scope map (%occurrence-scope occurrence)))))
110 (dolist (association (%topic-map-associations map))
111 (setf (%association-type association) (canonical-topic (%association-type association))
112 (%association-scope association) (canonical-scope map (%association-scope association)))
113 (dolist (role (%association-roles association))
114 (setf (%association-role-type role) (canonical-topic (%association-role-type role))
115 (%association-role-player role) (canonical-topic (%association-role-player role)))))
116 (dolist (item (map-information-items map))
117 (when (and (reifiable-p item) (%item-reifier item))
118 (setf (%item-reifier item) (canonical-topic (%item-reifier item)))))
119 (normalize-names map)
120 (normalize-occurrences map)
121 (normalize-associations map)
122 (canonical-topic c)))
123
124 (defun normalize-topic-map (map)
125 "Reach a fixed point of same-map Topic and structural item merging."
126 (check-type map topic-map)
127 (when (needs-reification-preflight-p map)
128 (return-from normalize-topic-map
129 (preflight-reification-mutation map (lambda (ref) (normalize-topic-map (funcall ref map))))))
130 (check-variant-merge-constraints map)
131 (loop for before = (length (map-information-items map)) do
132 (loop for pair = (equal-pair (%topic-map-topics map) #'equal-topics-p)
133 while pair do (merge-two-topics map (first pair) (second pair)))
134 (normalize-names map) (normalize-occurrences map) (normalize-associations map)
135 when (= before (length (map-information-items map))) return map))
136
137 (defun live-topic (topic)
138 (let ((current (canonical-topic topic)))
139 (unless (member current (%topic-map-topics (%topic-parent current)) :test #'eq)
140 (error "Topic is not a live member of its map."))
141 current))
142
143 (defun merge-topics (a b)
144 "Merge two Topics in the same map, returning their current representative.
145 Explicit merging may assert shared subject identity beyond locator equality.
146 Cross-map merging is rejected before mutation. Obsolete handles remain resolvable."
147 (let* ((a (live-topic a)) (b (live-topic b)) (map (%topic-parent a)))
148 (unless (eq map (%topic-parent b)) (error "Cross-map Topic merging is outside this API."))
149 (when (needs-reification-preflight-p map)
150 (return-from merge-topics (preflight-reification-mutation map
151 (lambda (ref) (merge-topics (funcall ref a) (funcall ref b))))))
152 (unless (eq a b) (setf a (merge-two-topics map a b)))
153 (normalize-topic-map map)
154 (canonical-topic a)))
155
156 (defun add-topic-identifier (topic kind iri)
157 "Add a locator to its distinct identity property and perform required merging.
158 KIND is :ITEM-IDENTIFIER, :SUBJECT-IDENTIFIER or :SUBJECT-LOCATOR.
159 IRI is an already resolved, nonempty absolute locator string; CTM validates it."
160 (unless (and (stringp iri) (plusp (length iri))) (error "A nonempty locator string is required."))
161 (let ((topic (live-topic topic)))
162 (when (needs-reification-preflight-p (%topic-parent topic))
163 (return-from add-topic-identifier (preflight-reification-mutation (%topic-parent topic)
164 (lambda (ref) (add-topic-identifier (funcall ref topic) kind iri)))))
165 (check-topic-occurrence-identifiers (%topic-parent topic) kind iri)
166 ;; Check the entire prospective identity closure before adding the locator.
167 (check-variant-merge-constraints (%topic-parent topic) :identifier (list topic kind iri))
168 (ecase kind
169 (:item-identifier (pushnew (copy-seq iri) (%topic-item-identifiers topic) :test #'string=))
170 (:subject-identifier (pushnew iri (%topic-subject-identifiers topic) :test #'string=))
171 (:subject-locator (pushnew iri (%topic-subject-locators topic) :test #'string=)))
172 (normalize-topic-map (%topic-parent topic))
173 (canonical-topic topic)))
174
175 (defun intern-topic (map kind iri)
176 "Lookup/create a Topic using the same identity rule as same-map merging."
177 (check-type map topic-map)
178 (unless (and (stringp iri) (plusp (length iri))) (error "A nonempty locator string is required."))
179 ;; Validate the category even for an empty map, before adding a Topic.
180 (ecase kind ((:item-identifier :subject-identifier :subject-locator)))
181 (check-topic-occurrence-identifiers map kind iri)
182 (let ((topic (or (find-if (lambda (topic) (identifier-matches-p topic kind iri))
183 (%topic-map-topics map))
184 (let ((new (%make-topic map)))
185 (setf (%topic-map-topics map) (append (%topic-map-topics map) (list new)))
186 new))))
187 (add-topic-identifier topic kind iri)))
188
189 (defun add-name (topic value &key (type nil type-supplied-p) scope)
190 "Add a Name with VALUE, optional TYPE Topic and SCOPE Topic set (TMDM 5.4).
191 Validate all arguments before interning the default type. Retained Topic handles
192 are canonicalized, including after default-type identity merging."
193 (check-type value string)
194 (let* ((topic (live-topic topic)) (map (%topic-parent topic))
195 (scope (canonical-scope map scope))
196 (type (when type-supplied-p (live-topic type))))
197 (when (and type-supplied-p (not (eq map (%topic-parent type))))
198 (error "Name type belongs to another map."))
199 (unless type-supplied-p
200 (setf type (intern-topic map :subject-identifier (default-name-type-identifier))))
201 (let* ((topic (canonical-topic topic)) (type (canonical-topic type))
202 (scope (canonical-scope map scope))
203 (existing (find-if (lambda (name)
204 (and (string= value (%topic-name-value name))
205 (eq type (%topic-name-type name))
206 (same-scope-p scope (%topic-name-scope name))))
207 (%topic-names topic))))
208 (or existing
209 (let ((name (%make-topic-name value type topic)))
210 (setf (%topic-name-scope name) scope
211 (%topic-names topic) (append (%topic-names topic) (list name)))
212 name)))))
213
214 (defun add-default-name (topic value &key scope)
215 "Compatibility entry point for ADD-NAME with the CTM 3.11 default type."
216 (add-name topic value :scope scope))