(defun unsupported (node)
(reject :unsupported-construct (format nil "XTM ~A is not implemented in this subset." (node-name node))
node 'xtm-unsupported))
-(defun check-reifier (node)
- (when (attr node "reifier")
- (reject :reification "XTM Reification is outside this subset." node 'xtm-unsupported)))
(defun leaf-href (node)
(attributes node '("href") '("href"))
(when (elements node) (reject :unexpected-child "A locator element must be empty." node))
(when (< next phase) (reject :element-order "topicMap child order is invalid." child))
(setf phase next)
(validate child '("itemIdentity" "mergeMap" "topic" "association"))))))
+ ((string= name "mergeMap") (mergemap-iri node))
((string= name "topic")
(attributes node '("id") '("id"))
(let ((id (collapse-space (attr node "id"))))
(dolist (child (elements node)) (validate child '("topicRef"))))
((string= name "name")
(attributes node '("reifier") nil)
- (check-reifier node)
+ (when (attr node "reifier")
+ (resolve-iri (attr node "reifier") *document-iri* node))
(let ((phase 0) (type-seen nil) (scope-seen nil) (value-seen nil))
(dolist (child (elements node))
(check-namespace child)
(unless value-seen (reject :missing-name-value "name requires a value element." node))))
((string= name "variant")
(attributes node '("reifier") nil)
- (check-reifier node)
+ (when (attr node "reifier") (resolve-iri (attr node "reifier") *document-iri* node))
(let ((phase 0) (scope-seen nil) (resource-seen nil))
(dolist (child (elements node))
(check-namespace child)
(validate child '("itemIdentity" "scope" "resourceData" "resourceRef"))))
(unless scope-seen (reject :missing-variant-scope "variant requires a scope element." node))
(unless resource-seen (reject :missing-variant-resource "variant requires a resource element." node))))
+ ((string= name "occurrence")
+ (attributes node '("reifier") nil)
+ (when (attr node "reifier")
+ (resolve-iri (attr node "reifier") *document-iri* node)
+ (reject :unsupported-construct "XTM occurrence reification is not implemented in this subset." node 'xtm-unsupported))
+ (let ((phase 0) (type-seen nil) (scope-seen nil) (resource-seen nil))
+ (dolist (child (elements node))
+ (check-namespace child)
+ (let* ((kind (node-name child))
+ (next (cond ((string= kind "itemIdentity") 0)
+ ((string= kind "type") 1)
+ ((string= kind "scope") 2)
+ ((member kind '("resourceData" "resourceRef") :test #'string=) 3))))
+ (unless next (reject :unexpected-element (format nil "Unexpected ~A element." kind) child))
+ (when (< next phase) (reject :element-order "occurrence child order is invalid." child))
+ (setf phase next)
+ (cond
+ ((string= kind "itemIdentity") nil)
+ ((string= kind "type")
+ (when type-seen (reject :duplicate-occurrence-type "Only one occurrence type is allowed." child))
+ (setf type-seen t))
+ ((string= kind "scope")
+ (unless type-seen (reject :missing-occurrence-type "occurrence requires type before scope." child))
+ (when scope-seen (reject :duplicate-occurrence-scope "Only one occurrence scope is allowed." child))
+ (setf scope-seen t))
+ (t
+ (unless type-seen (reject :missing-occurrence-type "occurrence requires type before its resource." child))
+ (when resource-seen (reject :occurrence-resource-cardinality "occurrence requires exactly one resource." child))
+ (setf resource-seen t)))
+ (validate child '("itemIdentity" "type" "scope" "resourceData" "resourceRef"))))
+ (unless type-seen (reject :missing-occurrence-type "occurrence requires a type element." node))
+ (unless resource-seen (reject :missing-occurrence-resource "occurrence requires a resource element." node))))
+ ((member name '("association" "role") :test #'string=)
+ (attributes node '("reifier") nil)
+ (when (attr node "reifier")
+ (resolve-iri (attr node "reifier") *document-iri* node)
+ (reject :unsupported-construct
+ (format nil "XTM ~A reification is not implemented in this subset." name) node 'xtm-unsupported))
+ (let ((association-p (string= name "association"))
+ (phase 0) (type-seen nil) (scope-seen nil) (participants 0))
+ (dolist (child (elements node))
+ (check-namespace child)
+ (let* ((kind (node-name child))
+ (next (cond ((string= kind "itemIdentity") 0)
+ ((string= kind "type") 1)
+ ((and association-p (string= kind "scope")) 2)
+ ((string= kind (if association-p "role" "topicRef")) 3))))
+ (unless next (reject :unexpected-element (format nil "Unexpected ~A element." kind) child))
+ (when (< next phase) (reject :element-order (format nil "~A child order is invalid." name) child))
+ (setf phase next)
+ (cond
+ ((string= kind "itemIdentity") nil)
+ ((string= kind "type")
+ (when type-seen (reject :duplicate-type (format nil "Only one ~A type is allowed." name) child))
+ (setf type-seen t))
+ (t
+ (unless type-seen
+ (reject :missing-type (format nil "~A requires type before ~A." name kind) child))
+ (if (string= kind "scope")
+ (progn
+ (when scope-seen (reject :duplicate-scope "Only one association scope is allowed." child))
+ (setf scope-seen t))
+ (progn
+ (incf participants)
+ (when (and (not association-p) (> participants 1))
+ (reject :role-player-cardinality "role requires exactly one topicRef player." child))))))
+ (validate child (if association-p '("itemIdentity" "type" "scope" "role") '("itemIdentity" "type" "topicRef")))))
+ (unless type-seen (reject :missing-type (format nil "~A requires a type element." name) node))
+ (when (zerop participants)
+ (reject (if association-p :missing-roles :missing-role-player)
+ (if association-p "association requires at least one role." "role requires a topicRef player.") node))))
((string= name "resourceRef") (leaf-href node))
((string= name "resourceData")
(attributes node '("datatype") nil)
(unless (iri-parts-scheme (split-iri datatype))
(reject :invalid-resource-data-datatype "resourceData datatype must be an absolute IRI." node))
(validate-decoded-reference (unescape-reference datatype node) node)
- (unless (member datatype (list (topic-maps.tmdm:string-datatype) (topic-maps.tmdm:iri-datatype)) :test #'equal)
- (reject :resource-data-datatype "Only textual xsd:string and xsd:anyURI resourceData are implemented." node 'xtm-unsupported)))
+ (when (equal datatype "http://www.w3.org/2001/XMLSchema#anyType")
+ (reject :resource-data-datatype "xsd:anyType XML canonicalization is outside this subset." node 'xtm-unsupported)))
(dolist (child (node-children node))
(unless (stringp child)
- (if (or (equal datatype (topic-maps.tmdm:iri-datatype)) (equal (node-uri child) +namespace+))
- (reject :unexpected-child
- (if (equal datatype (topic-maps.tmdm:iri-datatype))
- "anyURI resourceData cannot contain child elements."
- "resourceData cannot contain XTM markup.") child)
- (reject :resource-data-markup "Embedded XML resourceData is outside this subset." child 'xtm-unsupported))))))
+ (reject :unexpected-child "Textual resourceData cannot contain child elements." child)))))
((string= name "type")
(attributes node nil nil)
(let ((refs (elements node)))
(topic-maps.tmdm:topic-map-topics map))))
(if topic (topic-maps.tmdm:canonical-topic topic)
(topic-maps.tmdm:intern-topic map :item-identifier iri))))
-(defun read-map-reifier (node map)
+(defun read-item-reifier (node item map)
;; XTM 4.3.2 looks up Item Identifiers only, unlike topicRef (4.20).
;; INTERN-TOPIC adds the II on a miss; any SI/II identity merging then
;; follows the existing TMDM rules, independently of this lookup.
:test (lambda (iri topic)
(member iri (topic-maps.tmdm:topic-item-identifiers topic) :test #'string=)))
(topic-maps.tmdm:intern-topic map :item-identifier iri))))
- (topic-maps.tmdm:set-item-reifier map topic)))
- map)
+ (return-from read-item-reifier (topic-maps.tmdm:set-item-reifier item topic))))
+ item)
+(defun read-map-reifier (node map)
+ (read-item-reifier node map map))
(defun core-topic (map local)
(topic-maps.tmdm:intern-topic map :subject-identifier
(concatenate 'string "http://psi.topicmaps.org/iso13250/model/" local)))
(topic-maps.tmdm:make-association map (core-topic map "type-instance")
(list (list (core-topic map "type") type)
(list (core-topic map "instance") (topic-maps.tmdm:canonical-topic owner)))))))
+(defun read-item-identities (node item)
+ ;; XTM 4.6: assign locators to the actual canonical item, never intern Topics.
+ ;; ADD-ITEM-IDENTIFIER owns set semantics and cross-item conflict checks.
+ (dolist (child (elements node) item)
+ (when (string= (node-name child) "itemIdentity")
+ (setf item (topic-maps.tmdm:add-item-identifier item (leaf-href child))))))
+(defun read-association (node map)
+ ;; Resolve references in source order, then construct the complete native
+ ;; Association. The constructor may already merge Associations AND Roles.
+ (let ((type nil) (scope nil) (roles nil) (role-nodes nil))
+ (labels ((reference (ref) (find-reference-topic map (reference-iri ref)))
+ (type-reference (node) (reference (first (elements node)))))
+ (dolist (child (elements node))
+ (cond ((string= (node-name child) "type") (setf type (type-reference child)))
+ ((string= (node-name child) "scope") (setf scope (mapcar #'reference (elements child))))
+ ((string= (node-name child) "role")
+ (let ((children (elements child)))
+ (push (list (type-reference (find "type" children :key #'node-name :test #'string=))
+ (reference (find "topicRef" children :key #'node-name :test #'string=))) roles)
+ (push child role-nodes)))))
+ (let ((association (read-item-identities node
+ (topic-maps.tmdm:make-association map type (reverse roles) :scope scope))))
+ ;; Match source metadata to the native Role by its complete signature
+ ;; within THIS canonical Parent. Role order/II are not equality keys.
+ (loop for pair in (reverse roles) for source in (reverse role-nodes) do
+ (let ((role (find-if (lambda (role)
+ (and (eq (topic-maps.tmdm:association-role-type role)
+ (topic-maps.tmdm:canonical-topic (first pair)))
+ (eq (topic-maps.tmdm:association-role-player role)
+ (topic-maps.tmdm:canonical-topic (second pair)))))
+ (topic-maps.tmdm:association-roles association))))
+ (read-item-identities source role)))
+ (topic-maps.tmdm:canonical-association association)))))
+(defun read-resource-value (resource)
+ "Return value and datatype for a validated resource node (XTM 4.16/4.17).
+This operation neither looks up Topics nor fetches resources. ANYTYPE is rejected
+by source validation before model construction. Preserve other datatype IRIs."
+ (if (string= (node-name resource) "resourceRef")
+ (values (leaf-href resource) (topic-maps.tmdm:iri-datatype))
+ (let ((datatype (or (attr resource "datatype") (topic-maps.tmdm:string-datatype)))
+ (text (with-output-to-string (out)
+ (dolist (part (node-children resource)) (write-string part out)))))
+ (values (if (equal datatype (topic-maps.tmdm:iri-datatype))
+ (resolve-iri text *document-iri* resource)
+ text)
+ datatype))))
(defun read-variant (node name map)
(let* ((children (elements node))
(scope-node (find "scope" children :key #'node-name :test #'string=))
(resource (find-if (lambda (child) (member (node-name child) '("resourceData" "resourceRef") :test #'string=)) children))
- (reference-p (string= (node-name resource) "resourceRef"))
- (uri-data-p (and (not reference-p) (equal (attr resource "datatype") (topic-maps.tmdm:iri-datatype))))
- (explicit (mapcar (lambda (ref) (find-reference-topic map (reference-iri ref))) (elements scope-node)))
- ;; A resource locator is a value, not a topic reference. LEAF-HREF uses
- ;; the shared XTM IRI resolver without topic lookup or resource access.
- (text (unless reference-p (with-output-to-string (out)
- (dolist (part (node-children resource)) (write-string part out)))))
- (value (cond (reference-p (leaf-href resource))
- (uri-data-p (resolve-iri text *document-iri* resource))
- (t text))))
- ;; ADD-VARIANT canonicalizes the union and enforces the proper superset.
- ;; A nonempty explicit scope may still add no theme to the Name scope.
- (let ((variant (topic-maps.tmdm:add-variant name value
- :datatype (if (or reference-p uri-data-p) (topic-maps.tmdm:iri-datatype) (topic-maps.tmdm:string-datatype))
- :scope (append (topic-maps.tmdm:topic-name-scope name) explicit))))
- ;; Normalize first: an equal Variant may already own this identifier.
- ;; Keep the native canonical result and its global conflict conditions.
- (dolist (child children variant)
- (when (string= (node-name child) "itemIdentity")
- (setf variant (topic-maps.tmdm:add-item-identifier variant (leaf-href child))))))))
+ (explicit (mapcar (lambda (ref) (find-reference-topic map (reference-iri ref))) (elements scope-node))))
+ (multiple-value-bind (value datatype) (read-resource-value resource)
+ ;; ADD-VARIANT owns canonicalization and the proper-superset constraint.
+ (let ((variant (topic-maps.tmdm:add-variant name value :datatype datatype
+ :scope (append (topic-maps.tmdm:topic-name-scope name) explicit))))
+ (setf variant (read-item-identities node variant))
+ ;; Reification may normalize again; retain the native canonical handle.
+ (topic-maps.tmdm:canonical-variant (read-item-reifier node variant map))))))
(defun read-name (node owner map)
(let* ((children (elements node))
(type-node (find "type" children :key #'node-name :test #'string=))
(topic-maps.tmdm:add-default-name owner value :scope scope))))
;; Item identifiers belong to the canonical Name, never its owner/type.
;; Use the shared model API for set semantics and global conflicts.
- (dolist (child children name)
- (cond ((string= (node-name child) "itemIdentity")
- (setf name (topic-maps.tmdm:add-item-identifier name (leaf-href child))))
- ((string= (node-name child) "variant") (read-variant child name map)))))))
+ (setf name (read-item-identities node name))
+ ;; ADD-NAME may have returned an existing canonical Name. Reifier
+ ;; resolution/merging can normalize it again: retain the native result
+ ;; before processing Variants and return the current Name handle.
+ (setf name (read-item-reifier node name map))
+ (dolist (child children)
+ (when (string= (node-name child) "variant") (read-variant child name map)))
+ (topic-maps.tmdm:canonical-topic-name name))))
+(defun read-occurrence (node owner map)
+ ;; XTM 4.13-4.17/4.20: reuse native Topics and the qualified resource path.
+ ;; ADD-OCCURRENCE owns live Parent/Type/Scope handles and TMDM 5.6/6.5 merging.
+ (let* ((children (elements node))
+ (type-node (find "type" children :key #'node-name :test #'string=))
+ (type (find-reference-topic map (reference-iri (first (elements type-node)))))
+ (scope-node (find "scope" children :key #'node-name :test #'string=))
+ (scope (when scope-node (mapcar (lambda (ref) (find-reference-topic map (reference-iri ref)))
+ (elements scope-node))))
+ (resource (find-if (lambda (child) (member (node-name child) '("resourceData" "resourceRef") :test #'string=)) children)))
+ (multiple-value-bind (value datatype) (read-resource-value resource)
+ (topic-maps.tmdm:canonical-occurrence
+ (read-item-identities node
+ (topic-maps.tmdm:add-occurrence owner type value :datatype datatype :scope scope))))))
(defun read-topic (node map)
(let ((topic (topic-maps.tmdm:intern-topic map :item-identifier
(concatenate 'string *document-iri* "#" (collapse-space (attr node "id"))))))
(cond
((string= name "instanceOf") (read-instance-of child topic map))
((string= name "name") (read-name child topic map))
+ ((string= name "occurrence") (read-occurrence child topic map))
(t (setf topic (topic-maps.tmdm:add-topic-identifier topic
(cond ((string= name "itemIdentity") :item-identifier)
((string= name "subjectIdentifier") :subject-identifier)
(t :subject-locator))
(leaf-href child)))))))
(topic-maps.tmdm:canonical-topic topic)))
-(defun deserialize-octets (bytes &key document-iri source-key)
- "Deserialize raw XML octets into a new TMDM Topic Map (XTM 2.0 identity/Name subset).
-DOCUMENT-IRI is required, absolute and fragment-free. SOURCE-KEY is a diagnostic
-label only. XML positions are approximate SAX line/column values, not spans.
-XML-policy errors, XTM rejection/unsupported and original TMDM conflicts remain
-distinct. No resources are fetched. No externally supplied Map is mutated."
+(defun mergemap-iri (node)
+ (let ((iri (leaf-href node)))
+ (when (iri-parts-fragment (split-iri iri))
+ (reject :mergemap-fragment "mergeMap href must not have a fragment identifier." node))
+ iri))
+(defun resource-failure (code detail node &optional cause)
+ (error 'xtm-resource-error :code code :detail detail :cause cause
+ :document-iri *document-iri* :source-key *source-key*
+ :line (node-line node) :column (node-column node)))
+(defun resource-octets-p (value)
+ ;; Same resolver value convention as CTM, without a dependency on its Reader.
+ (and (vectorp value) (not (stringp value))
+ (every (lambda (n) (and (integerp n) (<= 0 n 255))) value)))
+(defun read-mergemap (node map resolver max-depth active-iris)
+ (let ((resource (mergemap-iri node)))
+ (unless resolver
+ (reject :resource-resolver-required "mergeMap requires an explicit resource resolver; no resource was loaded." node 'xtm-unsupported))
+ ;; These are finite resource-policy guards, not normative cycle semantics.
+ ;; Each independent public call starts a new active path; siblings may repeat.
+ (when (member resource active-iris :test #'string=)
+ (reject :cyclic-mergemap "Active recursive XTM resource dependency; cycle processing is not implemented." node 'xtm-unsupported))
+ (when (>= (length active-iris) (1+ max-depth))
+ (reject :resource-depth-limit "Configured nested XTM resource limit reached; this is implementation policy." node 'xtm-unsupported))
+ (multiple-value-bind (bytes source-key)
+ (handler-case
+ (funcall resolver resource :purpose :mergemap :from-document-iri *document-iri*
+ :notation "http://psi.topicmaps.org/iso13250/xtm")
+ (error (c) (resource-failure :resource-resolver-failure (princ-to-string c) node c)))
+ (unless bytes
+ (resource-failure :resource-unavailable "Resolver declined or did not supply the requested XTM resource." node))
+ (unless (and (resource-octets-p bytes) (or (null source-key) (stringp source-key)))
+ (resource-failure :invalid-resource-result "Resolver must return an octet vector and a string source key or NIL." node))
+ (let ((source (deserialize-document
+ (if (typep bytes '(vector (unsigned-byte 8))) bytes
+ (map '(vector (unsigned-byte 8)) #'identity bytes))
+ resource (or source-key resource) resolver max-depth active-iris)))
+ ;; Import only Topics/Associations. The existing operation preflights
+ ;; conflicts, preserves SOURCE, and excludes its Map identifiers/reifier.
+ (handler-case (topic-maps.tmdm:import-map-content map source)
+ (error (c) (resource-failure :mergemap-import-failure (princ-to-string c) node c)))))))
+(defun deserialize-octets (bytes &key document-iri source-key resource-resolver (max-resource-depth 32))
+ "Deserialize raw XTM 2.0 octets into a fresh TMDM Map.
+DOCUMENT-IRI is required, absolute and fragment-free. SOURCE-KEY is diagnostic.
+RESOURCE-RESOLVER is optional: (resolver absolute-iri :purpose :mergemap
+ :from-document-iri parent-iri :notation XTM-notation-IRI)
+returns raw octets and an optional diagnostic source key. No implicit I/O.
+Children use their resolved IRI as Document IRI and the same explicit resolver.
+MAX-RESOURCE-DEPTH bounds nested imports (default 32); active cycles are
+Unsupported implementation policy, not a normative XTM invalidity decision.
+Child XML/XTM/model errors retain their original contexts; resolver/import
+failures use XTM-RESOURCE-ERROR with the original ERROR-CAUSE. No supplied Map
+is mutated. Each public call has its own resource recursion context."
+ (check-type max-resource-depth (integer 0 *))
+ (deserialize-document bytes document-iri source-key resource-resolver max-resource-depth nil))
+(defun deserialize-document (bytes document-iri source-key resource-resolver max-resource-depth active-iris)
(check-type bytes (vector (unsigned-byte 8)))
(let ((*document-iri* document-iri) (*source-key* source-key)
(handler (make-instance 'source-handler)))
;; The attribute is processed before itemIdentity and later Topic nodes.
(read-map-reifier root map)
(dolist (child (elements root))
- (if (string= (node-name child) "itemIdentity")
- (topic-maps.tmdm:add-item-identifier map (leaf-href child))
- (read-topic child map)))
+ (cond ((string= (node-name child) "itemIdentity")
+ (topic-maps.tmdm:add-item-identifier map (leaf-href child)))
+ ((string= (node-name child) "mergeMap")
+ (read-mergemap child map resource-resolver max-resource-depth
+ (cons document-iri active-iris)))
+ ((string= (node-name child) "association") (read-association child map))
+ (t (read-topic child map))))
map)))