]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - src/ctm/reader.lisp
f73c242e4909fcc3cbe53c80f5222811b65813c7
[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 read-occurrence-literal (parser)
80 (let ((token (look parser)))
81 (case (token-kind token)
82 (:integer
83 (consume parser)
84 ;; Numeric-literal value policy: represent the unquoted integer value
85 ;; canonically; qualified quoted strings retain their lexical value.
86 (values (topic-maps.tmdm:canonical-integer-lexical-form (token-value token))
87 (topic-maps.tmdm:integer-datatype)))
88 (:decimal
89 (consume parser)
90 ;; Same value-representation policy as bare integers; token spelling is
91 ;; retained by the lexer, qualified strings remain lexical model data.
92 (values (topic-maps.tmdm:canonical-decimal-lexical-form (token-value token))
93 (topic-maps.tmdm:decimal-datatype)))
94 (:date
95 (consume parser)
96 (values (topic-maps.tmdm:canonical-date-lexical-form (token-value token)) (topic-maps.tmdm:date-datatype)))
97 (:datetime
98 (consume parser)
99 (multiple-value-bind (value reason) (topic-maps.tmdm:canonical-datetime-lexical-form (token-value token))
100 (unless value (problem 'ctm-unsupported
101 (if (eq reason :unsupported-timezone) :datetime-timezone-canonicalization :datetime-leap-second-context)
102 (token-position token) "DateTime value normalization requires an unsupported timezone/leap context."))
103 (values value (topic-maps.tmdm:datetime-datatype))))
104 (:excluded-literal
105 (problem 'ctm-unsupported :occurrence-literal-datatype (token-position token)
106 "The separate CTM '*' literal is outside this slice."))
107 (:string
108 (consume parser)
109 (if (punctuation-p parser #\^)
110 (let ((caret (consume parser)))
111 (unless (and (punctuation-p parser #\^)
112 (= (token-position (look parser)) (1+ (token-position caret))))
113 (problem 'ctm-rejection :invalid-datatype-marker (token-position caret) "Expected contiguous '^^'."))
114 (consume parser)
115 (let ((datatype (literal-iri-reference parser)))
116 (when (and (string= datatype (topic-maps.tmdm:integer-datatype))
117 (not (topic-maps.tmdm:integer-lexical-p (token-value token))))
118 (problem 'ctm-rejection :invalid-integer-value (token-position token)
119 "Quoted value is not an xsd:integer lexical form."))
120 (when (and (string= datatype (topic-maps.tmdm:decimal-datatype))
121 (not (topic-maps.tmdm:decimal-lexical-p (token-value token))))
122 (problem 'ctm-rejection :invalid-decimal-value (token-position token)
123 "Quoted value is not an xsd:decimal lexical form."))
124 (when (and (string= datatype (topic-maps.tmdm:date-datatype))
125 (not (topic-maps.tmdm:date-lexical-p (token-value token))))
126 (problem 'ctm-rejection :invalid-date-value (token-position token)
127 "Quoted value is not a valid XSD 1.0 date lexical form."))
128 (when (and (string= datatype (topic-maps.tmdm:datetime-datatype))
129 (not (topic-maps.tmdm:datetime-lexical-p (token-value token))))
130 (problem 'ctm-rejection :invalid-datetime-value (token-position token)
131 "Quoted value is not a valid XSD 1.0 dateTime."))
132 ;; TMDM 4.4 requires absolute anyURI content; quoted content is
133 ;; lexical data, never an IRI reference to resolve against the document.
134 (when (and (string= datatype (topic-maps.tmdm:iri-datatype))
135 (not (topic-maps.tmdm::absolute-locator-p (token-value token))))
136 (problem 'ctm-rejection :relative-uri-value (token-position token)
137 "A quoted anyURI value must already be absolute (TMDM 4.4)."))
138 (values (token-value token) datatype)))
139 (values (token-value token) (topic-maps.tmdm:string-datatype))))
140 ((:iri :qname) (values (literal-iri-reference parser) (topic-maps.tmdm:iri-datatype)))
141 (otherwise (problem 'ctm-rejection :expected-occurrence-value (token-position token)
142 "Expected an integer, decimal, date, dateTime, quoted string or IRI-form Occurrence value.")))))
143
144 (defun read-identity-tail (parser map topic)
145 (let ((start (look parser)))
146 (multiple-value-bind (kind iri) (identity-value parser)
147 (if (punctuation-p parser #\:)
148 (progn
149 (consume parser)
150 (multiple-value-bind (value datatype) (read-occurrence-literal parser)
151 (let ((type (topic-maps.tmdm:intern-topic map kind iri)))
152 (topic-maps.tmdm:add-occurrence topic type value :datatype datatype)
153 (topic-maps.tmdm:canonical-topic topic))))
154 (if (eq :identifier (token-kind start))
155 (if (punctuation-p parser #\()
156 (problem 'ctm-unsupported :topic-tail (token-position start) "Template invocations are outside this subset.")
157 (problem 'ctm-rejection :expected-occurrence-type-separator (token-position (look parser))
158 "Expected ':' after the Occurrence Type."))
159 (topic-maps.tmdm:add-topic-identifier topic kind iri))))))
160
161 (defun read-topic (parser map &optional (topic (identity-reference parser map)))
162 (let ((has-tail nil))
163 (loop
164 (cond
165 ((punctuation-p parser #\.) (consume parser) (return topic))
166 ((punctuation-p parser #\-)
167 (when has-tail
168 (problem 'ctm-rejection :expected-separator (token-position (look parser)) "Topic-tail statements need a semicolon separator."))
169 (consume parser)
170 (let ((value (consume parser)))
171 (when (member (token-kind value) '(:identifier :iri :qname))
172 ;; Recognize the typed-name syntax, without resolving its type
173 ;; or creating information items for unsupported name semantics.
174 (unless (punctuation-p parser #\:)
175 (problem 'ctm-rejection :expected-name-type-separator
176 (token-position (look parser)) "Expected ':' after the name type."))
177 (consume parser)
178 (let ((literal (consume parser)))
179 (unless (eq :string (token-kind literal))
180 (problem 'ctm-rejection :expected-name-value (token-position literal)
181 "Expected a quoted name value after the name type separator.")))
182 (problem 'ctm-unsupported :typed-name (token-position value)
183 "Typed names are outside the implemented subset (CTM 3.11)."))
184 (unless (eq :string (token-kind value))
185 (problem 'ctm-rejection :expected-name-value (token-position value)
186 "Expected a quoted name value after '-'."))
187 (topic-maps.tmdm:add-default-name topic (token-value value)))
188 (setf has-tail t))
189 ((and has-tail (punctuation-p parser #\;))
190 (consume parser)
191 (setf has-tail nil)
192 (when (punctuation-p parser #\.) (consume parser) (return topic)))
193 ((eq :eof (token-kind (look parser)))
194 (problem 'ctm-rejection :missing-period (token-position (look parser)) "Topic declaration requires a final period."))
195 ((or (and (eq :punctuation (token-kind (look parser)))
196 (find (token-value (look parser)) "=^"))
197 (member (token-kind (look parser)) '(:identifier :iri :qname)))
198 (when has-tail
199 (problem 'ctm-rejection :expected-separator (token-position (look parser)) "Topic-tail statements need a semicolon separator."))
200 (setf topic (read-identity-tail parser map topic) has-tail t))
201 ((punctuation-p parser #\()
202 (problem 'ctm-unsupported :variant (token-position (look parser)) "Variant names are outside the implemented subset."))
203 (t (problem 'ctm-rejection :unexpected-token (token-position (look parser)) "Unexpected token after topic or name."))))))
204
205 (defun read-association (parser map type)
206 "CTM 3.13, restricted to one or two role declarations; no scope/reifier."
207 (consume parser) ; opening parenthesis already recognized by the caller
208 (let ((roles nil) (third-position nil))
209 (loop
210 (when (or (punctuation-p parser #\)) (eq :eof (token-kind (look parser))))
211 (problem 'ctm-rejection :expected-role (token-position (look parser)) "Expected a nonempty Association role declaration."))
212 (when (= 2 (length roles)) (setf third-position (token-position (look parser))))
213 (let* ((role-type (identity-reference parser map))
214 (type-end (lexer-cursor (parser-lexer parser)))
215 (colon (look parser)))
216 (unless (punctuation-p parser #\:)
217 (problem 'ctm-rejection :expected-role-type-separator (token-position colon) "Expected ':' after the Role type."))
218 (consume parser)
219 (let ((player-token (look parser)))
220 ;; CTM role production requires layout on at least one side of ':'.
221 ;; skip-layout handles whitespace and comments; gaps use source offsets.
222 (unless (or (> (token-position colon) type-end)
223 (> (token-position player-token) (1+ (token-position colon))))
224 (problem 'ctm-rejection :role-separator-whitespace (token-position colon)
225 "A Role separator needs whitespace or a comment on at least one side."))
226 (when (or (eq :eof (token-kind player-token))
227 (punctuation-p parser #\)) (punctuation-p parser #\,))
228 (problem 'ctm-rejection :expected-role-player (token-position player-token) "Expected a Topic as the Role player.")))
229 (push (list role-type (identity-reference parser map)) roles))
230 (cond ((punctuation-p parser #\,) (consume parser))
231 ((punctuation-p parser #\)) (consume parser) (return))
232 ((eq :eof (token-kind (look parser)))
233 (problem 'ctm-rejection :missing-association-close (token-position (look parser)) "Expected ')' after the Roles."))
234 (t (problem 'ctm-rejection :expected-role-separator (token-position (look parser)) "Expected ',' or ')' after a Role."))))
235 (when (> (length roles) 2)
236 (problem 'ctm-unsupported :association-arity third-position "Associations with more than two Role declarations are outside Slice 3."))
237 (topic-maps.tmdm:make-association map type (nreverse roles))))
238
239 (defun deserialize-string (text &key document-iri source-name)
240 "Read the documented CTM subset, with per-document prefixes and qualified strings.
241 Source positions are zero-based character offsets; lines/columns are one-based."
242 (check-type text string)
243 (let ((*source-name* source-name) (*source-text* text))
244 (require-document-iri document-iri)
245 (let ((parser (make-parser (make-lexer text) document-iri))
246 (map (topic-maps.tmdm:make-topic-map)))
247 (loop until (eq :eof (token-kind (look parser))) do
248 (if (eq :directive (token-kind (look parser)))
249 (read-prefix-directive parser)
250 (let ((topic (identity-reference parser map)))
251 (if (punctuation-p parser #\()
252 (read-association parser map topic)
253 (read-topic parser map topic)))))
254 map)))
255
256 (defun deserialize-file (pathname &key document-iri source-name)
257 "Read a UTF-8 CTM file, with optional UTF-8 BOM, using an explicit Document IRI.
258 Other encoding directives are UNSUPPORTED. File I/O errors propagate unchanged."
259 (let ((*source-name* source-name) (*source-text* ""))
260 (require-document-iri document-iri)
261 (with-open-file (input pathname :direction :input :element-type '(unsigned-byte 8))
262 (let ((bytes (make-array (file-length input) :element-type '(unsigned-byte 8))))
263 (unless (= (length bytes) (read-sequence bytes input))
264 (error "Input file changed or was truncated during reading."))
265 (deserialize-string (decode-utf8 bytes :strip-bom t)
266 :document-iri document-iri :source-name source-name)))))