]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - src/ctm/reader.lisp
Implement CTM prefix directives and explicit occurrence datatypes
[topic-maps.git] / src / ctm / reader.lisp
1 (in-package #:topic-maps.ctm)
2
3 (defstruct (parser (:constructor make-parser (lexer document-iri)))
4 lexer document-iri lookahead (prefixes (make-hash-table :test #'equal)))
5 (defun look (parser)
6 (or (parser-lookahead parser)
7 (setf (parser-lookahead parser) (next-token (parser-lexer parser)))))
8 (defun consume (parser)
9 (prog1 (look parser) (setf (parser-lookahead parser) nil)))
10 (defun punctuation-p (parser character)
11 (and (eq :punctuation (token-kind (look parser)))
12 (eql character (token-value (look parser)))))
13
14 (defun resolve-qname (parser token)
15 "CTM 3.3.4: concatenate the resolved binding and local part exactly once."
16 (let* ((text (token-value token)) (colon (position #\: text))
17 (prefix (subseq text 0 colon)) (bound (gethash prefix (parser-prefixes parser))))
18 (unless bound
19 (problem 'undefined-prefix :undefined-prefix (token-position token)
20 (format nil "Prefix ~S has no binding." prefix)))
21 ;; Do not re-resolve or percent-decode an already resolved binding.
22 (validate-iri-characters (concatenate 'string bound (subseq text (1+ colon)))
23 (token-position token))))
24
25 (defun read-prefix-directive (parser)
26 "CTM 3.16.1: document-ordered, per-deserialization bindings; reference is an IRI."
27 (consume parser) ; %prefix
28 (let ((name (consume parser)) (reference (consume parser)))
29 (unless (eq :identifier (token-kind name))
30 (problem 'ctm-rejection :expected-prefix-name (token-position name) "Expected a prefix identifier."))
31 (unless (eq :iri (token-kind reference))
32 (problem 'ctm-rejection :expected-prefix-iri (token-position reference)
33 "A prefix binding requires an IRI, not a QName or Topic identifier."))
34 (let* ((iri (resolve-iri (token-value reference) (parser-document-iri parser) (token-position reference)))
35 (old (gethash (token-value name) (parser-prefixes parser))))
36 (when (and old (not (string= old iri)))
37 (problem 'prefix-collision :prefix-collision (token-position name)
38 (format nil "Prefix ~S is already bound to ~S, not ~S." (token-value name) old iri)))
39 (setf (gethash (token-value name) (parser-prefixes parser)) iri))))
40
41 (defun identity-value (parser &optional explicit-kind)
42 (let ((token (consume parser)))
43 (case (token-kind token)
44 (:identifier
45 (when explicit-kind
46 (problem 'ctm-rejection :expected-iri (token-position token) "Explicit = or ^ needs an IRI reference."))
47 (when (member (token-value token) '("def" "isa" "ako" "end") :test #'string=)
48 (problem 'ctm-unsupported :unsupported-keyword (token-position token) "This keyword is outside the implemented subset."))
49 (values :item-identifier
50 (concatenate 'string (parser-document-iri parser) "#" (token-value token))))
51 (:iri
52 (values (or explicit-kind :subject-identifier)
53 (resolve-iri (token-value token) (parser-document-iri parser) (token-position token))))
54 (:qname (values (or explicit-kind :subject-identifier) (resolve-qname parser token)))
55 (:punctuation
56 (case (token-value token)
57 (#\= (if explicit-kind
58 (problem 'ctm-rejection :expected-iri (token-position token) "Unexpected identity marker.")
59 (identity-value parser :subject-locator)))
60 (#\^ (if explicit-kind
61 (problem 'ctm-rejection :expected-iri (token-position token) "Unexpected identity marker.")
62 (identity-value parser :item-identifier)))
63 (otherwise (problem 'ctm-rejection :expected-topic-identity (token-position token) "Expected topic identity."))))
64 (otherwise (problem 'ctm-rejection :expected-topic-identity (token-position token) "Expected topic identity.")))))
65
66 (defun identity-reference (parser map)
67 (multiple-value-bind (kind iri) (identity-value parser)
68 (topic-maps.tmdm:intern-topic map kind iri)))
69
70 (defun literal-iri-reference (parser)
71 "An IRI locator, not a Topic identity. Used for values/datatype syntax."
72 (let ((token (consume parser)))
73 (case (token-kind token)
74 (:iri (resolve-iri (token-value token) (parser-document-iri parser) (token-position token)))
75 (:qname (resolve-qname parser token))
76 (otherwise (problem 'ctm-rejection :expected-datatype-iri (token-position token)
77 "A datatype qualifier requires an IRI reference, not a Topic identifier.")))))
78
79 (defun excluded-literal-p (text)
80 "Recognize unsupported numeric/date literal syntax, without constructing values."
81 (labels ((digits (s) (and (plusp (length s)) (every (lambda (c) (find c "0123456789")) s)))
82 (numeric (s)
83 (let* ((s (if (and (plusp (length s)) (find (char s 0) "+-")) (subseq s 1) s))
84 (dot (position #\. s)))
85 (if dot (and (or (zerop dot) (digits (subseq s 0 dot))) (digits (subseq s (1+ dot)))) (digits s))))
86 (date (s)
87 (let* ((s (if (and (plusp (length s)) (char= (char s 0) #\-)) (subseq s 1) s))
88 (dash (position #\- s)))
89 (and dash (>= dash 4) (digits (subseq s 0 dash))
90 (= (length s) (+ dash 6)) (char= (char s (+ dash 3)) #\-)
91 (digits (subseq s (1+ dash) (+ dash 3))) (digits (subseq s (+ dash 4)))
92 (<= 1 (parse-integer s :start (1+ dash) :end (+ dash 3)) 12)
93 (<= 1 (parse-integer s :start (+ dash 4)) 31))))
94 (time-literal (s)
95 (and (>= (length s) 8) (digits (subseq s 0 2)) (char= (char s 2) #\:)
96 (digits (subseq s 3 5)) (char= (char s 5) #\:) (digits (subseq s 6 8))
97 (let* ((rest (subseq s 8))
98 (end (position-if (lambda (c) (find c "Z+-")) rest))
99 (fraction (subseq rest 0 end)) (zone (if end (subseq rest end) "")))
100 (and (or (zerop (length fraction))
101 (and (char= (char fraction 0) #\.) (digits (subseq fraction 1))))
102 (or (member zone '("" "Z") :test #'string=)
103 (and (= 6 (length zone)) (find (char zone 0) "+-")
104 (digits (subseq zone 1 3)) (char= (char zone 3) #\:)
105 (digits (subseq zone 4 6)))))))))
106 (or (numeric text) (date text) (string= text "*")
107 (let ((tee (position #\T text))) (and tee (date (subseq text 0 tee)) (time-literal (subseq text (1+ tee))))))))
108
109 (defun read-occurrence-literal (parser)
110 ;; The dedicated lexer already preserves multiline strings and escape values.
111 ;; Numeric/date sugar is recognized only to report an unsupported construct.
112 (unless (parser-lookahead parser)
113 (let ((lexer (parser-lexer parser)))
114 (skip-layout lexer)
115 (let ((c (peek-character lexer)) (start (lexer-cursor lexer)))
116 (when (and c (or (find c "0123456789+*")
117 (and (find c "-.") (peek-character lexer 1)
118 (find (peek-character lexer 1) "0123456789"))))
119 (let* ((end (position-if (lambda (c) (or (whitespace-p c) (find c ";@~)")))
120 (lexer-text lexer) :start start))
121 (text (subseq (lexer-text lexer) start end))
122 (text (if (and (plusp (length text)) (char= (char text (1- (length text))) #\.))
123 (subseq text 0 (1- (length text))) text)))
124 (problem (if (excluded-literal-p text) 'ctm-unsupported 'ctm-rejection)
125 (if (excluded-literal-p text) :occurrence-literal-datatype :invalid-occurrence-literal)
126 start "Only string and IRI-form Occurrence literals are implemented."))))))
127 (let ((token (look parser)))
128 (case (token-kind token)
129 (:string
130 (consume parser)
131 (if (punctuation-p parser #\^)
132 (let ((caret (consume parser)))
133 (unless (and (punctuation-p parser #\^)
134 (= (token-position (look parser)) (1+ (token-position caret))))
135 (problem 'ctm-rejection :invalid-datatype-marker (token-position caret) "Expected contiguous '^^'."))
136 (consume parser)
137 (let ((datatype (literal-iri-reference parser)))
138 ;; TMDM 4.4 requires absolute anyURI content; quoted content is
139 ;; lexical data, never an IRI reference to resolve against the document.
140 (when (and (string= datatype (topic-maps.tmdm:iri-datatype))
141 (not (topic-maps.tmdm::absolute-locator-p (token-value token))))
142 (problem 'ctm-rejection :relative-uri-value (token-position token)
143 "A quoted anyURI value must already be absolute (TMDM 4.4)."))
144 (values (token-value token) datatype)))
145 (values (token-value token) (topic-maps.tmdm:string-datatype))))
146 ((:iri :qname) (values (literal-iri-reference parser) (topic-maps.tmdm:iri-datatype)))
147 (otherwise (problem 'ctm-rejection :expected-occurrence-value (token-position token)
148 "Expected a quoted string or IRI-form Occurrence value.")))))
149
150 (defun read-identity-tail (parser map topic)
151 (let ((start (look parser)))
152 (multiple-value-bind (kind iri) (identity-value parser)
153 (if (punctuation-p parser #\:)
154 (progn
155 (consume parser)
156 (multiple-value-bind (value datatype) (read-occurrence-literal parser)
157 (let ((type (topic-maps.tmdm:intern-topic map kind iri)))
158 (topic-maps.tmdm:add-occurrence topic type value :datatype datatype)
159 (topic-maps.tmdm:canonical-topic topic))))
160 (if (eq :identifier (token-kind start))
161 (if (punctuation-p parser #\()
162 (problem 'ctm-unsupported :topic-tail (token-position start) "Template invocations are outside this subset.")
163 (problem 'ctm-rejection :expected-occurrence-type-separator (token-position (look parser))
164 "Expected ':' after the Occurrence Type."))
165 (topic-maps.tmdm:add-topic-identifier topic kind iri))))))
166
167 (defun read-topic (parser map &optional (topic (identity-reference parser map)))
168 (let ((has-tail nil))
169 (loop
170 (cond
171 ((punctuation-p parser #\.) (consume parser) (return topic))
172 ((punctuation-p parser #\-)
173 (when has-tail
174 (problem 'ctm-rejection :expected-separator (token-position (look parser)) "Topic-tail statements need a semicolon separator."))
175 (consume parser)
176 (let ((value (consume parser)))
177 (when (member (token-kind value) '(:identifier :iri :qname))
178 ;; Recognize the typed-name syntax, without resolving its type
179 ;; or creating information items for unsupported name semantics.
180 (unless (punctuation-p parser #\:)
181 (problem 'ctm-rejection :expected-name-type-separator
182 (token-position (look parser)) "Expected ':' after the name type."))
183 (consume parser)
184 (let ((literal (consume parser)))
185 (unless (eq :string (token-kind literal))
186 (problem 'ctm-rejection :expected-name-value (token-position literal)
187 "Expected a quoted name value after the name type separator.")))
188 (problem 'ctm-unsupported :typed-name (token-position value)
189 "Typed names are outside the implemented subset (CTM 3.11)."))
190 (unless (eq :string (token-kind value))
191 (problem 'ctm-rejection :expected-name-value (token-position value)
192 "Expected a quoted name value after '-'."))
193 (topic-maps.tmdm:add-default-name topic (token-value value)))
194 (setf has-tail t))
195 ((and has-tail (punctuation-p parser #\;))
196 (consume parser)
197 (setf has-tail nil)
198 (when (punctuation-p parser #\.) (consume parser) (return topic)))
199 ((eq :eof (token-kind (look parser)))
200 (problem 'ctm-rejection :missing-period (token-position (look parser)) "Topic declaration requires a final period."))
201 ((or (and (eq :punctuation (token-kind (look parser)))
202 (find (token-value (look parser)) "=^"))
203 (member (token-kind (look parser)) '(:identifier :iri :qname)))
204 (when has-tail
205 (problem 'ctm-rejection :expected-separator (token-position (look parser)) "Topic-tail statements need a semicolon separator."))
206 (setf topic (read-identity-tail parser map topic) has-tail t))
207 ((punctuation-p parser #\()
208 (problem 'ctm-unsupported :variant (token-position (look parser)) "Variant names are outside the implemented subset."))
209 (t (problem 'ctm-rejection :unexpected-token (token-position (look parser)) "Unexpected token after topic or name."))))))
210
211 (defun read-association (parser map type)
212 "CTM 3.13, restricted to one or two role declarations; no scope/reifier."
213 (consume parser) ; opening parenthesis already recognized by the caller
214 (let ((roles nil) (third-position nil))
215 (loop
216 (when (or (punctuation-p parser #\)) (eq :eof (token-kind (look parser))))
217 (problem 'ctm-rejection :expected-role (token-position (look parser)) "Expected a nonempty Association role declaration."))
218 (when (= 2 (length roles)) (setf third-position (token-position (look parser))))
219 (let* ((role-type (identity-reference parser map))
220 (type-end (lexer-cursor (parser-lexer parser)))
221 (colon (look parser)))
222 (unless (punctuation-p parser #\:)
223 (problem 'ctm-rejection :expected-role-type-separator (token-position colon) "Expected ':' after the Role type."))
224 (consume parser)
225 (let ((player-token (look parser)))
226 ;; CTM role production requires layout on at least one side of ':'.
227 ;; skip-layout handles whitespace and comments; gaps use source offsets.
228 (unless (or (> (token-position colon) type-end)
229 (> (token-position player-token) (1+ (token-position colon))))
230 (problem 'ctm-rejection :role-separator-whitespace (token-position colon)
231 "A Role separator needs whitespace or a comment on at least one side."))
232 (when (or (eq :eof (token-kind player-token))
233 (punctuation-p parser #\)) (punctuation-p parser #\,))
234 (problem 'ctm-rejection :expected-role-player (token-position player-token) "Expected a Topic as the Role player.")))
235 (push (list role-type (identity-reference parser map)) roles))
236 (cond ((punctuation-p parser #\,) (consume parser))
237 ((punctuation-p parser #\)) (consume parser) (return))
238 ((eq :eof (token-kind (look parser)))
239 (problem 'ctm-rejection :missing-association-close (token-position (look parser)) "Expected ')' after the Roles."))
240 (t (problem 'ctm-rejection :expected-role-separator (token-position (look parser)) "Expected ',' or ')' after a Role."))))
241 (when (> (length roles) 2)
242 (problem 'ctm-unsupported :association-arity third-position "Associations with more than two Role declarations are outside Slice 3."))
243 (topic-maps.tmdm:make-association map type (nreverse roles))))
244
245 (defun deserialize-string (text &key document-iri source-name)
246 "Read the documented CTM subset, with per-document prefixes and qualified strings.
247 Source positions are zero-based character offsets; lines/columns are one-based."
248 (check-type text string)
249 (let ((*source-name* source-name) (*source-text* text))
250 (require-document-iri document-iri)
251 (let ((parser (make-parser (make-lexer text) document-iri))
252 (map (topic-maps.tmdm:make-topic-map)))
253 (loop until (eq :eof (token-kind (look parser))) do
254 (if (eq :directive (token-kind (look parser)))
255 (read-prefix-directive parser)
256 (let ((topic (identity-reference parser map)))
257 (if (punctuation-p parser #\()
258 (read-association parser map topic)
259 (read-topic parser map topic)))))
260 map)))
261
262 (defun deserialize-file (pathname &key document-iri source-name)
263 "Read a UTF-8 CTM file, with optional UTF-8 BOM, using an explicit Document IRI.
264 Other encoding directives are UNSUPPORTED. File I/O errors propagate unchanged."
265 (let ((*source-name* source-name) (*source-text* ""))
266 (require-document-iri document-iri)
267 (with-open-file (input pathname :direction :input :element-type '(unsigned-byte 8))
268 (let ((bytes (make-array (file-length input) :element-type '(unsigned-byte 8))))
269 (unless (= (length bytes) (read-sequence bytes input))
270 (error "Input file changed or was truncated during reading."))
271 (deserialize-string (decode-utf8 bytes :strip-bom t)
272 :document-iri document-iri :source-name source-name)))))