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