]> dreyeck.freedombox.rocks Git - topic-maps.git/blobdiff - src/ctm/reader.lisp
docs: design draft for a read-only SHOP3 adapter over TMDM objects
[topic-maps.git] / src / ctm / reader.lisp
index 820985063bbf99f5e093a6527c8595f57c093143..f8741a7e8b59aab4f711aeed6fd3d37729047dcb 100644 (file)
@@ -1,13 +1,29 @@
 (in-package #:topic-maps.ctm)
 
+(defvar *active-resource-iris* nil)
+
+(defstruct template-definition name parameters body position source-name source-text document-iri)
+;; Validated concrete syntax, never TMDM information items or Lisp forms.
+(defstruct ctm-statement kind tokens position)
+(defstruct template-argument kind token topic value datatype plain-string-p)
 (defstruct (parser (:constructor make-parser (lexer document-iri wildcard-iri wildcard-counter)))
-  lexer document-iri wildcard-iri wildcard-counter lookahead
+  lexer document-iri wildcard-iri wildcard-counter lookahead resource-resolver (max-resource-depth 32)
+  replay-p remaining recording recorded bindings
+  (templates (make-hash-table :test #'equal))
   (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)))))
+      (setf (parser-lookahead parser)
+        (if (parser-replay-p parser)
+            (let ((token (or (pop (parser-remaining parser))
+                             (make-token :kind :eof :position (lexer-cursor (parser-lexer parser))))))
+              (setf (lexer-cursor (parser-lexer parser)) (or (token-end token) (token-position token))) token)
+            (let ((token (next-token (parser-lexer parser))))
+              (setf (token-end token) (lexer-cursor (parser-lexer parser))) token)))))
 (defun consume (parser)
-  (prog1 (look parser) (setf (parser-lookahead parser) nil)))
+  (let ((token (look parser)))
+    (when (parser-recording parser) (push token (parser-recorded parser)))
+    (setf (parser-lookahead parser) nil) token))
 (defun punctuation-p (parser character)
   (and (eq :punctuation (token-kind (look parser)))
        (eql character (token-value (look parser)))))
@@ -26,7 +42,7 @@
         (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))
+  (or (member (token-kind token) '(:identifier :iri :qname :wildcard :variable))
       (and (eq :punctuation (token-kind token)) (find (token-value token) "=^["))))
 
 (defun resolve-qname (parser token)
 (defun identity-value (parser &optional explicit-kind)
   (let ((token (consume parser)))
     (case (token-kind token)
+      (:variable (bound-identity parser token explicit-kind))
       (:identifier
        (when explicit-kind
          (problem 'ctm-rejection :expected-iri (token-position token) "Explicit = or ^ needs an IRI reference."))
        (when (member (token-value token) '("isa" "ako") :test #'string=)
          (problem 'ctm-rejection :reserved-topic-identifier (token-position token) "A relationship keyword is not a Topic identity."))
        (when (member (token-value token) '("def" "end") :test #'string=)
-         (problem 'ctm-unsupported :unsupported-keyword (token-position token) "This keyword is outside the implemented subset."))
+         (problem 'ctm-rejection :unexpected-template-keyword (token-position token) "Unexpected template delimiter."))
        (values :item-identifier
           (concatenate 'string (parser-document-iri parser) "#" (token-value token))))
       (:iri
 (defun identity-reference (parser map)
   (let ((position (token-position (look parser))))
     (multiple-value-bind (kind iri) (identity-value parser)
-      (handler-case (topic-maps.tmdm:intern-topic map kind iri)
+      (handler-case (if (eq kind :bound-topic) (topic-maps.tmdm:canonical-topic iri)
+                        (topic-maps.tmdm:intern-topic map kind iri))
         (topic-maps.tmdm:core-subject-error (c)
           (problem 'ctm-rejection (topic-maps.tmdm:core-subject-error-code c) position (princ-to-string c)))))))
 
@@ -138,6 +156,7 @@ The owning information item is not constructed until this function finishes."
   "Shared CTM 3.4.1 literal reader for Occurrences and Variants."
   (let ((token (look parser)))
     (case (token-kind token)
+      (:variable (consume parser) (bound-literal parser token))
       (:integer
        (consume parser)
        ;; Numeric-literal value policy: represent the unquoted integer value
@@ -161,9 +180,10 @@ The owning information item is not constructed until this function finishes."
                              :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 (if (eq context :variant) :variant-literal-datatype :occurrence-literal-datatype) (token-position token)
-                "The separate CTM '*' literal is outside this slice."))
+      (:ctm-integer
+       (consume parser)
+       ;; CTM 3.4.1 [33]: opaque lexical value, unrelated to Wildcards/counters.
+       (values "*" "http://psi.topicmaps.org/iso13250/ctm-integer"))
       (:string
        (consume parser)
        (if (punctuation-p parser #\^)
@@ -229,16 +249,15 @@ The owning information item is not constructed until this function finishes."
           (progn
             (consume parser)
             (multiple-value-bind (value datatype) (read-literal parser)
-              (let* ((type (or type (topic-maps.tmdm:intern-topic map kind iri)))
+              (let* ((type (or type (if (eq kind :bound-topic) (topic-maps.tmdm:canonical-topic iri)
+                                       (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 (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."))
+          (if (or embedded (member (token-kind start) '(:identifier :wildcard :variable)))
+              (problem 'ctm-rejection :expected-occurrence-type-separator (token-position (look parser))
+                       "Expected ':' after the Occurrence Type.")
               (handler-case (topic-maps.tmdm:add-topic-identifier topic kind iri)
                 (topic-maps.tmdm:core-subject-error (c)
                   (problem 'ctm-rejection (topic-maps.tmdm:core-subject-error-code c)
@@ -264,22 +283,24 @@ The owning information item is not constructed until this function finishes."
   "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))
+         (typed (and (topic-reference-start-p token)
+                     (or (not (eq :variable (token-kind token))) (next-punctuation-p parser #\:))))
          (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))
+    (let* ((value (consume parser))
+           (name-value (if (eq :variable (token-kind value)) (bound-name parser value) (token-value value))))
+      (unless (member (token-kind value) '(:string :variable))
         (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)))
+                        (if typed (topic-maps.tmdm:add-name topic name-value :type type :scope scope)
+                            (topic-maps.tmdm:add-name topic name-value :scope scope)) r position)))
             (loop while (punctuation-p parser #\() do (read-variant parser map name))))))
     (topic-maps.tmdm:canonical-topic topic)))
 
@@ -338,6 +359,11 @@ Use the shared Topic reference resolver."
          (when has-tail
            (problem 'ctm-rejection :expected-separator (token-position (look parser)) "Topic-tail statements need a semicolon separator."))
          (setf topic (read-type-relationship parser map topic) has-tail t seen-tail t))
+        ((tail-invocation-p parser)
+         (when has-tail
+           (problem 'ctm-rejection :expected-separator (token-position (look parser)) "Topic-tail statements need a semicolon separator."))
+         (read-template-invocation parser map topic)
+         (setf topic (topic-maps.tmdm:canonical-topic topic) has-tail t seen-tail t))
         ((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."))
@@ -390,17 +416,56 @@ Use the shared Topic reference resolver."
                 (attach-reifier role reifier marker))))
           (attach-reifier (topic-maps.tmdm:canonical-association association) r position))))))
 
-(defun deserialize-string (text &key document-iri source-name (wildcard-iri document-iri) (wildcard-counter 0))
+(defun read-prolog (parser)
+  "CTM 3.5: one initial encoding header, then one optional version 1.0."
+  (when (and (eq :directive (token-kind (look parser)))
+             (string= "encoding" (token-value (look parser))))
+    (let ((token (consume parser)))
+      (unless (zerop (token-position token))
+        (problem 'ctm-rejection :misplaced-encoding (token-position token)
+                 "Encoding declaration must be the first characters of the CTM stream."))
+      (multiple-value-bind (name end position)
+          (ctm-encoding-name *source-text* (token-position token) :character)
+        (unless (ctm-encoding-kind name)
+          (problem 'ctm-unsupported :unsupported-encoding position "Only UTF-8 and ISO-8859-5 CTM input are implemented."))
+        (setf (lexer-cursor (parser-lexer parser)) end))))
+  (when (and (eq :directive (token-kind (look parser)))
+             (string= "version" (token-value (look parser))))
+    (consume parser)
+    (let ((lexer (parser-lexer parser)))
+      (skip-layout lexer)
+      (let ((start (lexer-cursor lexer)))
+        ;; Match the fixed terminal before the numeric-literal lexer. A Topic
+        ;; can follow immediately; extra numeric spelling is not version 1.0.
+        (unless (and (ctm-ascii-prefix-p *source-text* start "1.0")
+                     (let ((end (+ start 3)))
+                       (not (and (< end (length *source-text*))
+                                 (find (char *source-text* end) "0123456789.+-")))))
+          (problem 'ctm-rejection :invalid-version start "The only CTM version is the exact spelling 1.0."))
+        (setf (lexer-cursor lexer) (+ start 3))))))
+
+(defun deserialize-context (text &key document-iri source-name (wildcard-iri document-iri) (wildcard-counter 0)
+                                      resource-resolver (max-resource-depth 32))
   "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
+Internal result: Map, final Wildcard Counter and parser environment. 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."
+Source positions are zero-based character offsets; lines/columns are one-based.
+RESOURCE-RESOLVER, if supplied, is called with an absolute IRI and :PURPOSE,
+:FROM-DOCUMENT-IRI and :NOTATION, returning octets and an optional source key.
+There is no implicit retrieval. MAX-RESOURCE-DEPTH bounds nested imports (default
+32, zero disables them); it is an implementation limit, not a CTM validity rule."
   (check-type text string)
-  (let ((*source-name* source-name) (*source-text* text))
+  (let ((*source-name* source-name) (*source-text* text)
+        (*active-resource-iris* (cons document-iri *active-resource-iris*)))
     (require-document-iri document-iri)
     (require-wildcard-environment wildcard-iri wildcard-counter)
+    (when (and resource-resolver (not (functionp resource-resolver)))
+      (problem 'ctm-resource-error :invalid-resource-resolver 0 "Supply a resolver function or NIL."))
+    (unless (and (integerp max-resource-depth) (>= max-resource-depth 0))
+      (problem 'ctm-resource-error :invalid-resource-depth-limit 0 "Resource depth limit must be a non-negative integer."))
     (let ((parser (make-parser (make-lexer text) document-iri wildcard-iri wildcard-counter))
           (map (topic-maps.tmdm:make-topic-map)))
+      (setf (parser-resource-resolver parser) resource-resolver (parser-max-resource-depth parser) max-resource-depth)
       (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))))
@@ -410,26 +475,36 @@ Source positions are zero-based character offsets; lines/columns are one-based."
                      (topic-maps.tmdm:core-subject-error
                        (lambda (c) (problem 'ctm-rejection (topic-maps.tmdm:core-subject-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))
+        (read-prolog parser)
+        (loop while (eq :directive (token-kind (look parser))) do (read-directive parser map))
         (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)))))
+          (cond ((eq :directive (token-kind (look parser))) (read-directive parser map))
+                ((identifier-p (look parser) "def") (read-template-definition parser))
+                (t (read-statement parser map)))))
+      (values map (parser-wildcard-counter parser) parser))))
+
+(defun deserialize-string (text &key document-iri source-name (wildcard-iri document-iri) (wildcard-counter 0)
+                                      resource-resolver (max-resource-depth 32))
+  "Deserialize CTM using explicit Document IRI and optional controlled resources.
+Return the Topic Map and final Wildcard Counter. Includes import Templates and
+Topic aliases; Mergemap imports Map content only. No implicit I/O is performed.
+The resolver receives :PURPOSE (:INCLUDE or :MERGEMAP), :FROM-DOCUMENT-IRI and
+:NOTATION (NIL for Include). Source keys are diagnostic, never identity bases."
+  (multiple-value-bind (map counter)
+      (deserialize-context text :document-iri document-iri :source-name source-name
+        :wildcard-iri wildcard-iri :wildcard-counter wildcard-counter
+        :resource-resolver resource-resolver :max-resource-depth max-resource-depth)
+    (values map counter)))
 
-(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."
+(defun deserialize-file (pathname &key document-iri source-name encoding (wildcard-iri document-iri) (wildcard-counter 0)
+                                        resource-resolver (max-resource-depth 32))
+  "Read CTM octets using an explicit Document IRI and optional supplied ENCODING.
+Check supplied encoding/BOM/declaration conflicts before UTF-8 or ISO-8859-5 decoding.
+Other charsets remain 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)
@@ -437,6 +512,7 @@ Other encoding directives are UNSUPPORTED. File I/O errors propagate unchanged."
       (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)
+        (deserialize-string (decode-ctm-octets bytes :encoding encoding)
                             :document-iri document-iri :source-name source-name
-                            :wildcard-iri wildcard-iri :wildcard-counter wildcard-counter)))))
+                            :wildcard-iri wildcard-iri :wildcard-counter wildcard-counter
+                            :resource-resolver resource-resolver :max-resource-depth max-resource-depth)))))