(in-package #:topic-maps.ctm)
-(defstruct template-definition name parameters body position)
+(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)))
: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 #\^)
(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 (string-equal name "UTF-8")
+ (problem 'ctm-unsupported :unsupported-encoding position "Only UTF-8 CTM input is 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))))
(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."))
- (cond ((eq :directive (token-kind (look parser))) (read-prefix-directive 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)))))
+ (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 strict UTF-8 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)
(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)))))