(in-package #:topic-maps.ctm)
-(defstruct (parser (:constructor make-parser (lexer document-iri)))
- lexer document-iri lookahead (prefixes (make-hash-table :test #'equal)))
+(defstruct (parser (:constructor make-parser (lexer document-iri wildcard-iri wildcard-counter)))
+ lexer document-iri wildcard-iri wildcard-counter lookahead
+ (wildcards (make-hash-table :test #'equal)) (prefixes (make-hash-table :test #'equal)))
(defun look (parser)
(or (parser-lookahead parser)
(setf (parser-lookahead parser) (next-token (parser-lexer parser)))))
(and (eq :punctuation (token-kind (look parser)))
(eql character (token-value (look parser)))))
+(defun require-wildcard-environment (iri counter)
+ (handler-case (require-document-iri iri)
+ (ctm-rejection () (problem 'ctm-rejection :invalid-wildcard-iri 0 "Wildcard IRI must be an absolute, fragment-free IRI.")))
+ (unless (and (integerp counter) (>= counter 0))
+ (problem 'ctm-rejection :invalid-wildcard-counter 0 "Wildcard counter must be a non-negative integer.")))
+
+(defun wildcard-locator (parser &optional name)
+ "CTM 3.3.8: cache locators, not Lisp object handles; identity uses INTERN-TOPIC."
+ (or (and name (gethash name (parser-wildcards parser)))
+ (let ((iri (format nil "~A#$__~D~@[.~A~]" (parser-wildcard-iri parser)
+ (incf (parser-wildcard-counter parser)) name)))
+ (when name (setf (gethash name (parser-wildcards parser)) iri)) iri)))
+
+(defun topic-reference-start-p (token)
+ (or (member (token-kind token) '(:identifier :iri :qname :wildcard))
+ (and (eq :punctuation (token-kind token)) (find (token-value token) "=^["))))
+
(defun resolve-qname (parser token)
"CTM 3.3.4: concatenate the resolved binding and local part exactly once."
(let* ((text (token-value token)) (colon (position #\: text))
(values (or explicit-kind :subject-identifier)
(resolve-iri (token-value token) (parser-document-iri parser) (token-position token))))
(:qname (values (or explicit-kind :subject-identifier) (resolve-qname parser token)))
+ (:wildcard
+ (when explicit-kind
+ (problem 'ctm-rejection :expected-iri (token-position token) "Explicit = or ^ needs an IRI reference."))
+ (values :item-identifier (wildcard-locator parser (token-value token))))
(:punctuation
(case (token-value token)
(#\= (if explicit-kind
(multiple-value-bind (kind iri) (identity-value parser)
(topic-maps.tmdm:intern-topic map kind iri)))
+(defun topic-reference (parser map)
+ "CTM 3.3.7: one recursive reference path for Types, Players and Scope themes."
+ (if (punctuation-p parser #\[)
+ (progn
+ (consume parser)
+ (let ((topic (topic-maps.tmdm:intern-topic map :item-identifier (wildcard-locator parser))))
+ (read-topic-tail parser map topic #\] :required t)))
+ (identity-reference parser map)))
+
+(defun read-scope (parser map)
+ "CTM 3.3.9: optional @ followed by a nonempty comma-separated Topic set.
+Use the shared Topic reference resolver, including Embedded Topics and Wildcards.
+The owning information item is not constructed until this function finishes."
+ (when (punctuation-p parser #\@)
+ (consume parser)
+ (let ((themes nil))
+ (loop
+ ;; A reifier marker where a Theme is required is malformed Scope,
+ ;; while a reifier after a complete Scope belongs to its statement.
+ (unless (parser-lookahead parser)
+ (skip-layout (parser-lexer parser))
+ (when (eql #\~ (peek-character (parser-lexer parser)))
+ (problem 'ctm-rejection :expected-scope-theme (lexer-cursor (parser-lexer parser))
+ "Expected a Theme, not a reifier marker.")))
+ (let ((token (look parser)))
+ (unless (topic-reference-start-p token)
+ (problem 'ctm-rejection :expected-scope-theme (token-position token)
+ "Expected a Topic reference after '@' or the scope comma."))
+ (push (topic-reference parser map) themes))
+ (if (punctuation-p parser #\,) (consume parser) (return (nreverse themes)))))))
+
(defun literal-iri-reference (parser)
"An IRI locator, not a Topic identity. Used for values/datatype syntax."
(let ((token (consume parser)))
(otherwise (problem 'ctm-rejection :expected-datatype-iri (token-position token)
"A datatype qualifier requires an IRI reference, not a Topic identifier.")))))
-(defun read-occurrence-literal (parser)
+(defun read-literal (parser &optional (context :occurrence))
+ "Shared CTM 3.4.1 literal reader for Occurrences and Variants."
(let ((token (look parser)))
(case (token-kind token)
(:integer
(consume parser)
(multiple-value-bind (value reason) (topic-maps.tmdm:canonical-datetime-lexical-form (token-value token))
(unless value (problem 'ctm-unsupported
- (if (eq reason :unsupported-timezone) :datetime-timezone-canonicalization :datetime-leap-second-context)
- (token-position token) "DateTime value normalization requires an unsupported timezone/leap context."))
+ (if (eq reason :unsupported-bce-timezone-rollover)
+ :datetime-bce-timezone-rollover :datetime-leap-second-context)
+ (token-position token) "DateTime normalization is outside the supported BCE/leap-second calendar context."))
(values value (topic-maps.tmdm:datetime-datatype))))
(:excluded-literal
- (problem 'ctm-unsupported :occurrence-literal-datatype (token-position token)
+ (problem 'ctm-unsupported (if (eq context :variant) :variant-literal-datatype :occurrence-literal-datatype) (token-position token)
"The separate CTM '*' literal is outside this slice."))
(:string
(consume parser)
(values (token-value token) datatype)))
(values (token-value token) (topic-maps.tmdm:string-datatype))))
((:iri :qname) (values (literal-iri-reference parser) (topic-maps.tmdm:iri-datatype)))
- (otherwise (problem 'ctm-rejection :expected-occurrence-value (token-position token)
- "Expected an integer, decimal, date, dateTime, quoted string or IRI-form Occurrence value.")))))
+ (otherwise (problem 'ctm-rejection (if (eq context :variant) :expected-variant-value :expected-occurrence-value)
+ (token-position token) "Expected a supported CTM literal value.")))))
+
+(defun read-reifier (parser map)
+ "CTM 3.3.10: reuse the full Topic reference resolver, retaining the marker position."
+ (when (punctuation-p parser #\~)
+ (let ((position (token-position (consume parser))))
+ (unless (topic-reference-start-p (look parser))
+ (problem 'ctm-rejection :expected-reifier-topic (token-position (look parser)) "Expected a Topic reference after '~'."))
+ (values (topic-reference parser map) position))))
+(defun attach-reifier (item topic position)
+ (when topic
+ (handler-case (setf item (topic-maps.tmdm:set-item-reifier item topic))
+ (topic-maps.tmdm:reification-error (c)
+ (problem 'ctm-rejection (topic-maps.tmdm:reification-error-code c) position (princ-to-string c)))
+ (topic-maps.tmdm:variant-error (c)
+ (problem 'ctm-rejection (topic-maps.tmdm:variant-error-code c) position (princ-to-string c)))))
+ item)
(defun read-identity-tail (parser map topic)
- (let ((start (look parser)))
- (multiple-value-bind (kind iri) (identity-value parser)
+ (let* ((start (look parser)) (embedded (punctuation-p parser #\[))
+ (type (when embedded (topic-reference parser map))))
+ ;; Identity tail statements add directly to their owner, without constructing
+ ;; an intermediate Topic. Identity-form Type references use the same resolver.
+ (multiple-value-bind (kind iri) (unless embedded (identity-value parser))
(if (punctuation-p parser #\:)
(progn
(consume parser)
- (multiple-value-bind (value datatype) (read-occurrence-literal parser)
- (let ((type (topic-maps.tmdm:intern-topic map kind iri)))
- (topic-maps.tmdm:add-occurrence topic type value :datatype datatype)
+ (multiple-value-bind (value datatype) (read-literal parser)
+ (let* ((type (or type (topic-maps.tmdm:intern-topic map kind iri)))
+ (scope (read-scope parser map)))
+ (multiple-value-bind (r position) (read-reifier parser map)
+ (attach-reifier (topic-maps.tmdm:add-occurrence topic type value :datatype datatype :scope scope) r position))
(topic-maps.tmdm:canonical-topic topic))))
- (if (eq :identifier (token-kind start))
- (if (punctuation-p parser #\()
+ (if (or embedded (member (token-kind start) '(:identifier :wildcard)))
+ (if (and (eq :identifier (token-kind start)) (punctuation-p parser #\())
(problem 'ctm-unsupported :topic-tail (token-position start) "Template invocations are outside this subset.")
(problem 'ctm-rejection :expected-occurrence-type-separator (token-position (look parser))
"Expected ':' after the Occurrence Type."))
(topic-maps.tmdm:add-topic-identifier topic kind iri))))))
-(defun read-topic (parser map &optional (topic (identity-reference parser map)))
- (let ((has-tail nil))
+(defun read-variant (parser map name)
+ (consume parser)
+ (multiple-value-bind (value datatype) (read-literal parser :variant)
+ (unless (punctuation-p parser #\@)
+ (problem 'ctm-rejection :expected-variant-scope (token-position (look parser)) "A Variant requires an explicit '@' Scope."))
+ (let* ((scope-position (token-position (look parser))) (themes (read-scope parser map)))
+ (multiple-value-bind (r position) (read-reifier parser map)
+ (unless (punctuation-p parser #\))
+ (problem 'ctm-rejection :missing-variant-close (token-position (look parser)) "Expected ')' after the Variant Scope/Reifier."))
+ (consume parser)
+ (handler-case
+ (attach-reifier (topic-maps.tmdm:add-variant name value :datatype datatype
+ :scope (append (topic-maps.tmdm:topic-name-scope name) themes)) r position)
+ (topic-maps.tmdm:variant-error (c)
+ (problem 'ctm-rejection (topic-maps.tmdm:variant-error-code c) scope-position (princ-to-string c))))))))
+
+(defun read-name (parser map topic)
+ "CTM 3.11: optional Topic reference plus ':' followed by a string.
+Use the shared Topic reference resolver."
+ (let* ((token (look parser))
+ (typed (topic-reference-start-p token))
+ (type (when typed (topic-reference parser map))))
+ (when typed
+ (unless (punctuation-p parser #\:)
+ (problem 'ctm-rejection :expected-name-type-separator
+ (token-position (look parser)) "Expected ':' after the name type."))
+ (consume parser))
+ (let ((value (consume parser)))
+ (unless (eq :string (token-kind value))
+ (problem 'ctm-rejection :expected-name-value (token-position value)
+ "Expected a quoted name value after '-' or the name type separator."))
+ (let ((scope (read-scope parser map)))
+ (multiple-value-bind (r position) (read-reifier parser map)
+ (let ((name (attach-reifier
+ (if typed (topic-maps.tmdm:add-name topic (token-value value) :type type :scope scope)
+ (topic-maps.tmdm:add-name topic (token-value value) :scope scope)) r position)))
+ (loop while (punctuation-p parser #\() do (read-variant parser map name))))))
+ (topic-maps.tmdm:canonical-topic topic)))
+
+(defun read-topic-tail (parser map topic terminator &key required)
+ "CTM 3.9: the same Tail reader ends at '.' or the caller's Embedded ']'."
+ (let ((has-tail nil) (seen-tail nil))
(loop
(cond
- ((punctuation-p parser #\.) (consume parser) (return topic))
+ ((punctuation-p parser terminator)
+ (when (and required (not seen-tail))
+ (problem 'ctm-rejection :expected-topic-tail (token-position (look parser)) "An Embedded Topic requires a nonempty Topic Tail."))
+ (consume parser) (return (topic-maps.tmdm:canonical-topic topic)))
+ ((and (char= terminator #\]) (punctuation-p parser #\.))
+ (problem 'ctm-rejection :missing-embedded-close (token-position (look parser)) "Embedded Topics end with ']', not a period."))
((punctuation-p parser #\-)
(when has-tail
(problem 'ctm-rejection :expected-separator (token-position (look parser)) "Topic-tail statements need a semicolon separator."))
(consume parser)
- (let ((value (consume parser)))
- (when (member (token-kind value) '(:identifier :iri :qname))
- ;; Recognize the typed-name syntax, without resolving its type
- ;; or creating information items for unsupported name semantics.
- (unless (punctuation-p parser #\:)
- (problem 'ctm-rejection :expected-name-type-separator
- (token-position (look parser)) "Expected ':' after the name type."))
- (consume parser)
- (let ((literal (consume parser)))
- (unless (eq :string (token-kind literal))
- (problem 'ctm-rejection :expected-name-value (token-position literal)
- "Expected a quoted name value after the name type separator.")))
- (problem 'ctm-unsupported :typed-name (token-position value)
- "Typed names are outside the implemented subset (CTM 3.11)."))
- (unless (eq :string (token-kind value))
- (problem 'ctm-rejection :expected-name-value (token-position value)
- "Expected a quoted name value after '-'."))
- (topic-maps.tmdm:add-default-name topic (token-value value)))
- (setf has-tail t))
+ (setf topic (read-name parser map topic))
+ (setf has-tail t seen-tail t))
((and has-tail (punctuation-p parser #\;))
(consume parser)
- (setf has-tail nil)
- (when (punctuation-p parser #\.) (consume parser) (return topic)))
+ (setf has-tail nil))
((eq :eof (token-kind (look parser)))
- (problem 'ctm-rejection :missing-period (token-position (look parser)) "Topic declaration requires a final period."))
- ((or (and (eq :punctuation (token-kind (look parser)))
- (find (token-value (look parser)) "=^"))
- (member (token-kind (look parser)) '(:identifier :iri :qname)))
+ (problem 'ctm-rejection (if (char= terminator #\]) :missing-embedded-close :missing-period)
+ (token-position (look parser)) "Expected the closing Topic/Embedded Topic delimiter."))
+ ((topic-reference-start-p (look parser))
(when has-tail
(problem 'ctm-rejection :expected-separator (token-position (look parser)) "Topic-tail statements need a semicolon separator."))
- (setf topic (read-identity-tail parser map topic) has-tail t))
+ (setf topic (read-identity-tail parser map topic) has-tail t seen-tail t))
((punctuation-p parser #\()
- (problem 'ctm-unsupported :variant (token-position (look parser)) "Variant names are outside the implemented subset."))
+ (problem 'ctm-rejection :unexpected-variant (token-position (look parser)) "A Variant must immediately follow a Topic Name."))
(t (problem 'ctm-rejection :unexpected-token (token-position (look parser)) "Unexpected token after topic or name."))))))
(defun read-association (parser map type)
- "CTM 3.13, restricted to one or two role declarations; no scope/reifier."
+ "CTM 3.13: one or more Role declarations; optional Scope and Reifiers."
(consume parser) ; opening parenthesis already recognized by the caller
- (let ((roles nil) (third-position nil))
+ (let ((roles nil) (role-reifiers nil))
(loop
(when (or (punctuation-p parser #\)) (eq :eof (token-kind (look parser))))
(problem 'ctm-rejection :expected-role (token-position (look parser)) "Expected a nonempty Association role declaration."))
- (when (= 2 (length roles)) (setf third-position (token-position (look parser))))
- (let* ((role-type (identity-reference parser map))
+ (let* ((role-type (topic-reference parser map))
(type-end (lexer-cursor (parser-lexer parser)))
(colon (look parser)))
(unless (punctuation-p parser #\:)
(when (or (eq :eof (token-kind player-token))
(punctuation-p parser #\)) (punctuation-p parser #\,))
(problem 'ctm-rejection :expected-role-player (token-position player-token) "Expected a Topic as the Role player.")))
- (push (list role-type (identity-reference parser map)) roles))
+ (let ((player (topic-reference parser map)))
+ (push (list role-type player) roles)
+ (multiple-value-bind (r position) (read-reifier parser map)
+ (push (list role-type player r position) role-reifiers))))
(cond ((punctuation-p parser #\,) (consume parser))
((punctuation-p parser #\)) (consume parser) (return))
((eq :eof (token-kind (look parser)))
(problem 'ctm-rejection :missing-association-close (token-position (look parser)) "Expected ')' after the Roles."))
(t (problem 'ctm-rejection :expected-role-separator (token-position (look parser)) "Expected ',' or ')' after a Role."))))
- (when (> (length roles) 2)
- (problem 'ctm-unsupported :association-arity third-position "Associations with more than two Role declarations are outside Slice 3."))
- (topic-maps.tmdm:make-association map type (nreverse roles))))
+ (let ((scope (read-scope parser map)))
+ (multiple-value-bind (r position) (read-reifier parser map)
+ (let ((association (topic-maps.tmdm:make-association map type (nreverse roles) :scope scope)))
+ (dolist (entry (nreverse role-reifiers))
+ (destructuring-bind (role-type player reifier marker) entry
+ (let ((role (find-if (lambda (role)
+ (and (eq (topic-maps.tmdm:canonical-topic role-type) (topic-maps.tmdm:association-role-type role))
+ (eq (topic-maps.tmdm:canonical-topic player) (topic-maps.tmdm:association-role-player role))))
+ (topic-maps.tmdm:association-roles association))))
+ (attach-reifier role reifier marker))))
+ (attach-reifier (topic-maps.tmdm:canonical-association association) r position))))))
-(defun deserialize-string (text &key document-iri source-name)
+(defun deserialize-string (text &key document-iri source-name (wildcard-iri document-iri) (wildcard-counter 0))
"Read the documented CTM subset, with per-document prefixes and qualified strings.
+Return the Map and final Wildcard Counter as two values. Wildcard IRI defaults
+to Document IRI; local identifiers and relative IRIs still use Document IRI.
Source positions are zero-based character offsets; lines/columns are one-based."
(check-type text string)
(let ((*source-name* source-name) (*source-text* text))
(require-document-iri document-iri)
- (let ((parser (make-parser (make-lexer text) document-iri))
+ (require-wildcard-environment wildcard-iri wildcard-counter)
+ (let ((parser (make-parser (make-lexer text) document-iri wildcard-iri wildcard-counter))
(map (topic-maps.tmdm:make-topic-map)))
- (loop until (eq :eof (token-kind (look parser))) do
- (if (eq :directive (token-kind (look parser)))
- (read-prefix-directive parser)
- (let ((topic (identity-reference parser map)))
- (if (punctuation-p parser #\()
- (read-association parser map topic)
- (read-topic parser map topic)))))
- map)))
+ (handler-bind ((topic-maps.tmdm:variant-error
+ (lambda (c) (problem 'ctm-rejection (topic-maps.tmdm:variant-error-code c)
+ (lexer-cursor (parser-lexer parser)) (princ-to-string c))))
+ (topic-maps.tmdm:reification-error
+ (lambda (c) (problem 'ctm-rejection (topic-maps.tmdm:reification-error-code c)
+ (lexer-cursor (parser-lexer parser)) (princ-to-string c)))))
+ (loop while (eq :directive (token-kind (look parser))) do (read-prefix-directive parser))
+ (multiple-value-bind (r position) (read-reifier parser map) (attach-reifier map r position))
+ (loop until (eq :eof (token-kind (look parser))) do
+ (when (punctuation-p parser #\~)
+ (problem 'ctm-rejection :topic-map-reifier-position (token-position (look parser))
+ "Topic Map Reifier must precede all body declarations."))
+ (if (eq :directive (token-kind (look parser)))
+ (read-prefix-directive parser)
+ (let* ((embedded (punctuation-p parser #\[)) (topic (topic-reference parser map)))
+ (if (punctuation-p parser #\()
+ (read-association parser map topic)
+ (if embedded
+ (problem 'ctm-rejection :embedded-topic-at-top-level (token-position (look parser))
+ "An Embedded Topic at top level must be an Association Type, not a standalone declaration.")
+ (read-topic-tail parser map topic #\.)))))))
+ (values map (parser-wildcard-counter parser)))))
-(defun deserialize-file (pathname &key document-iri source-name)
+(defun deserialize-file (pathname &key document-iri source-name (wildcard-iri document-iri) (wildcard-counter 0))
"Read a UTF-8 CTM file, with optional UTF-8 BOM, using an explicit Document IRI.
Other encoding directives are UNSUPPORTED. File I/O errors propagate unchanged."
(let ((*source-name* source-name) (*source-text* ""))
(require-document-iri document-iri)
+ (require-wildcard-environment wildcard-iri wildcard-counter)
(with-open-file (input pathname :direction :input :element-type '(unsigned-byte 8))
(let ((bytes (make-array (file-length input) :element-type '(unsigned-byte 8))))
(unless (= (length bytes) (read-sequence bytes input))
(error "Input file changed or was truncated during reading."))
(deserialize-string (decode-utf8 bytes :strip-bom t)
- :document-iri document-iri :source-name source-name)))))
+ :document-iri document-iri :source-name source-name
+ :wildcard-iri wildcard-iri :wildcard-counter wildcard-counter)))))