This file is indexed.

/usr/share/common-lisp/source/closure-common/encodings.lisp is in cl-closure-common 20101107-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
(in-package :runes-encoding)

(eval-when (:compile-toplevel :load-toplevel :execute)
  (defparameter +buffer-byte+
    #+rune-is-utf-16 '(unsigned-byte 16)
    #-rune-is-utf-16 '(unsigned-byte 32)))

(define-condition encoding-error (simple-error) ())

(defun xerror (fmt &rest args)
  (error 'encoding-error :format-control fmt :format-arguments args))

;;;; ---------------------------------------------------------------------------
;;;; Encoding names
;;;;

(defvar *names* (make-hash-table :test #'eq))

(defun canon-name (string)
  (with-output-to-string (bag)
    (map nil (lambda (ch)
               (cond ((char= ch #\_) (write-char #\- bag))
                     (t (write-char (char-upcase ch) bag))))
         string)))

(defun canon-name-2 (string)
  (with-output-to-string (bag)
    (map nil (lambda (ch)
               (cond ((char= ch #\_))
                     ((char= ch #\-))
                     (t (write-char (char-upcase ch) bag))))
         string)))

(defmethod encoding-names ((encoding symbol))
  (gethash encoding *names*))

(defmethod (setf encoding-names) (new-value (encoding symbol))
  (setf (gethash encoding *names*) new-value))

(defun add-name (encoding name)
  (pushnew (canon-name name) (encoding-names encoding) :test #'string=))

(defun resolve-name (string)
  (cond ((symbolp string)
         string)
        (t
         (setq string (canon-name string))
         (or
          (block nil
            (maphash (lambda (x y) 
                       (when (member string y :test #'string=)
                         (return x)))
                     *names*)
            nil)
          (block nil
            (maphash (lambda (x y) 
                       (when (member string y 
                                     :test #'(lambda (x y)
                                               (string= (canon-name-2 x) 
                                                        (canon-name-2 y))))
                         (return x)))
                     *names*)
            nil)))))

;;;; ---------------------------------------------------------------------------
;;;;  Encodings
;;;;

(defvar *encodings* (make-hash-table :test #'eq))

(defmacro define-encoding (name init-form)
  `(progn
     (setf (gethash ',name *encodings*)
       (list nil (lambda () ,init-form)))
     ',name))

(defun find-encoding (name)
  (let ((x (gethash (resolve-name name) *encodings*)))
    (and x
         (or (first x)
             (setf (first x) (funcall (second x)))))))

(defclass encoding () ())

(defclass simple-8-bit-encoding (encoding)
  ((table :initarg :table)))

(defun make-simple-8-bit-encoding (&key charset)
  (make-instance 'simple-8-bit-encoding
    :table (coerce (to-unicode-table charset) '(simple-array #.+buffer-byte+ (256)))))

;;;;;;;

(defmacro fx-op (op &rest xs) 
  `(the fixnum (,op ,@(mapcar (lambda (x) `(the fixnum ,x)) xs))))
(defmacro fx-pred (op &rest xs) 
  `(,op ,@(mapcar (lambda (x) `(the fixnum ,x)) xs)))

(defmacro %+   (&rest xs) `(fx-op + ,@xs))
(defmacro %-   (&rest xs) `(fx-op - ,@xs))
(defmacro %*   (&rest xs) `(fx-op * ,@xs))
(defmacro %/   (&rest xs) `(fx-op floor ,@xs))
(defmacro %and (&rest xs) `(fx-op logand ,@xs))
(defmacro %ior (&rest xs) `(fx-op logior ,@xs))
(defmacro %xor (&rest xs) `(fx-op logxor ,@xs))
(defmacro %ash (&rest xs) `(fx-op ash ,@xs))
(defmacro %mod (&rest xs) `(fx-op mod ,@xs))

(defmacro %=  (&rest xs)  `(fx-pred = ,@xs))
(defmacro %<= (&rest xs)  `(fx-pred <= ,@xs))
(defmacro %>= (&rest xs)  `(fx-pred >= ,@xs))
(defmacro %<  (&rest xs)  `(fx-pred < ,@xs))
(defmacro %>  (&rest xs)  `(fx-pred > ,@xs))

;;; Decoders

;; The decoders share a common signature:
;;
;; DECODE input input-start input-end
;;        output output-start output-end
;;        eof-p
;; -> first-not-written ; first-not-read
;;
;; These decode functions should decode as much characters off `input'
;; into the `output' as possible and return the indexes to the first
;; not read and first not written element of `input' and `output'
;; respectively.  If there are not enough bytes in `input' to decode a
;; full character, decoding shold be abandomed; the caller has to
;; ensure that the remaining bytes of `input' are passed to the
;; decoder again with more bytes appended.
;;
;; `eof-p' now in turn indicates, if the given input sequence, is all
;; the producer does have and might be used to produce error messages
;; in case of incomplete codes or decided what to do.
;;
;; Decoders are expected to handle the various CR/NL conventions and
;; canonicalize each end of line into a single NL rune (#xA) in good
;; old Lisp tradition.
;;

;; TODO: change this to an encoding class, which then might carry
;; additional state. Stateless encodings could been represented by
;; keywords. e.g.
;;
;;  defmethod DECODE-SEQUENCE ((encoding (eql :utf-8)) ...)
;;

(defmethod decode-sequence ((encoding (eql :utf-16-big-endian))
                            in in-start in-end out out-start out-end eof?)
  ;; -> new wptr, new rptr
  (let ((wptr out-start)
        (rptr in-start))
    (loop
      (when (%= wptr out-end)
        (return))
      (when (>= (%+ rptr 1) in-end)
        (return))
      (let* ((hi (aref in rptr))
	     (lo (aref in (%+ 1 rptr)))
	     (x (logior (ash hi 8) lo)))
        (when (or (eql x #xFFFE) (eql x #xFFFF))
	  (xerror "not a valid code point: #x~X" x))
	(when (<= #xDC00 x #xDFFF)
	  (xerror "unexpected high surrogate: #x~X" x))
	(when (<= #xD800 x #xDBFF)
	  ;; seen low surrogate, look for high surrogate now
	  (when (>= (%+ rptr 3) in-end)
	    (return))
	  (let* ((hi2 (aref in (%+ 2 rptr)))
		 (lo2 (aref in (%+ 3 rptr)))
		 (y (logior (ash hi2 8) lo2)))
	    (unless (<= #xDC00 x #xDFFF)
	      (xerror "expected a high surrogate but found: #x~X" x))
	    #-rune-is-utf-16
	    (progn
	      (setf x (logior (ash (%- x #xd7c0) 10) (%and y #x3FF)))
	      (setf rptr (%+ 2 rptr))))
	  ;; end of surrogate handling
	  )
	(setf (aref out wptr) x)
        (setf rptr (%+ 2 rptr))
        (setf wptr (%+ 1 wptr))))
    (values wptr rptr)))

(defmethod decode-sequence ((encoding (eql :utf-16-little-endian))
                            in in-start in-end out out-start out-end eof?)
  ;; -> new wptr, new rptr
  (let ((wptr out-start)
        (rptr in-start))
    (loop
      (when (%= wptr out-end)
        (return))
      (when (>= (%+ rptr 1) in-end)
        (return))
      (let* ((lo (aref in rptr))
	     (hi (aref in (%+ 1 rptr)))
	     (x (logior (ash hi 8) lo)))
        (when (or (eql x #xFFFE) (eql x #xFFFF))
	  (xerror "not a valid code point: #x~X" x))
	(when (<= #xDC00 x #xDFFF)
	  (xerror "unexpected high surrogate: #x~X" x))
	(when (<= #xD800 x #xDBFF)
	  ;; seen low surrogate, look for high surrogate now
	  (when (>= (%+ rptr 3) in-end)
	    (return))
	  (let* ((lo2 (aref in (%+ 2 rptr)))
		 (hi2 (aref in (%+ 3 rptr)))
		 (y (logior (ash hi2 8) lo2)))
	    (unless (<= #xDC00 x #xDFFF)
	      (xerror "expected a high surrogate but found: #x~X" x))
	    #-rune-is-utf-16
	    (progn
	      (setf x (logior (ash (%- x #xd7c0) 10) (%and y #x3FF)))
	      (setf rptr (%+ 2 rptr))))
	  ;; end of surrogate handling
	  )
	(setf (aref out wptr) x)
        (setf rptr (%+ 2 rptr))
        (setf wptr (%+ 1 wptr))))
    (values wptr rptr)))

(defmethod decode-sequence ((encoding (eql :utf-8))
                            in in-start in-end out out-start out-end eof?)
  (declare (optimize (speed 3) (safety 0))
           (type (simple-array (unsigned-byte 8) (*)) in)
           (type (simple-array #.+buffer-byte+ (*))
		 out)
           (type fixnum in-start in-end out-start out-end))
  (let ((wptr out-start)
        (rptr in-start)
        byte0)
    (macrolet ((put (x)
                 `((lambda (x)
                     (when (or (<= #xD800 x #xDBFF)
			       (<= #xDC00 x #xDFFF))
		       (xerror "surrogate encoded in UTF-8: #x~X." x))
                     (cond ((or (%> x #x10FFFF)
				(eql x #xFFFE)
				(eql x #xFFFF))
                            (xerror "not a valid code point: #x~X" x))
			   #+rune-is-utf-16
		           ((%> x #xFFFF)
                            (setf (aref out (%+ 0 wptr)) (%+ #xD7C0 (ash x -10))
                                  (aref out (%+ 1 wptr)) (%ior #xDC00 (%and x #x3FF)))
                            (setf wptr (%+ wptr 2)))
                           (t
                            (setf (aref out wptr) x)
                            (setf wptr (%+ wptr 1)))))
                   ,x))
               (put1 (x)
                 `(progn
                    (setf (aref out wptr) ,x)
                    (setf wptr (%+ wptr 1)))))
      (loop
        (when (%= (+ wptr 1) out-end) (return))
        (when (%>= rptr in-end) (return))
        (setq byte0 (aref in rptr))
        (cond ((= byte0 #x0D)
               ;; CR handling
               ;; we need to know the following character
               (cond ((>= (%+ rptr 1) in-end)
                      ;; no characters in buffer
                      (cond (eof?
                             ;; at EOF, pass it as NL
                             (put #x0A)
                             (setf rptr (%+ rptr 1)))
                            (t
                             ;; demand more characters
                             (return))))
                     ((= (aref in (%+ rptr 1)) #x0A)
                      ;; we see CR NL, so forget this CR and the next NL will be
                      ;; inserted literally
                      (setf rptr (%+ rptr 1)))
                     (t
                      ;; singleton CR, pass it as NL
                      (put #x0A)
                      (setf rptr (%+ rptr 1)))))
                    
              ((%<= #|#b00000000|# byte0 #b01111111)
               (put1 byte0)
               (setf rptr (%+ rptr 1)))
            
              ((%<= #|#b10000000|# byte0 #b10111111)
               (xerror "Corrupted UTF-8 input (initial byte was #b~8,'0B)" byte0)
               (setf rptr (%+ rptr 1)))
            
              ((%<= #|#b11000000|# byte0 #b11011111)
               (cond ((<= (%+ rptr 2) in-end)
                      (put
                       (dpb (ldb (byte 5 0) byte0) (byte 5 6)
                            (dpb (ldb (byte 6 0) (aref in (%+ rptr 1))) (byte 6 0)
                                 0)))
                      (setf rptr (%+ rptr 2)))
                     (t
                      (return))))
            
              ((%<= #|#b11100000|# byte0 #b11101111)
               (cond ((<= (%+ rptr 3) in-end)
                      (put
                       (dpb (ldb (byte 4 0) byte0) (byte 4 12)
                            (dpb (ldb (byte 6 0) (aref in (%+ 1 rptr))) (byte 6 6)
                                 (dpb (ldb (byte 6 0) (aref in (%+ 2 rptr))) (byte 6 0)
                                      0))))
                      (setf rptr (%+ rptr 3)))
                     (t
                      (return))))
            
              ((%<= #|#b11110000|# byte0 #b11110111)
               (cond ((<= (%+ rptr 4) in-end)
                      (put
                       (dpb (ldb (byte 3 0) byte0) (byte 3 18)
                            (dpb (ldb (byte 6 0) (aref in (%+ 1 rptr))) (byte 6 12)
                                 (dpb (ldb (byte 6 0) (aref in (%+ 2 rptr))) (byte 6 6)
                                      (dpb (ldb (byte 6 0) (aref in (%+ 3 rptr))) (byte 6 0)
                                           0)))))
                      (setf rptr (%+ rptr 4)))
                     (t
                      (return))))
            
              ((%<= #|#b11111000|# byte0 #b11111011)
               (cond ((<= (%+ rptr 5) in-end)
                      (put
                       (dpb (ldb (byte 2 0) byte0) (byte 2 24)
                            (dpb (ldb (byte 6 0) (aref in (%+ 1 rptr))) (byte 6 18)
                                 (dpb (ldb (byte 6 0) (aref in (%+ 2 rptr))) (byte 6 12)
                                      (dpb (ldb (byte 6 0) (aref in (%+ 3 rptr))) (byte 6 6)
                                           (dpb (ldb (byte 6 0) (aref in (%+ 4 rptr))) (byte 6 0)
                                                0))))))
                      (setf rptr (%+ rptr 5)))
                     (t
                      (return))))
            
              ((%<= #|#b11111100|# byte0 #b11111101)
               (cond ((<= (%+ rptr 6) in-end)
                      (put
                       (dpb (ldb (byte 1 0) byte0) (byte 1 30)
                            (dpb (ldb (byte 6 0) (aref in (%+ 1 rptr))) (byte 6 24)
                                 (dpb (ldb (byte 6 0) (aref in (%+ 2 rptr))) (byte 6 18)
                                      (dpb (ldb (byte 6 0) (aref in (%+ 3 rptr))) (byte 6 12)
                                           (dpb (ldb (byte 6 0) (aref in (%+ 4 rptr))) (byte 6 6)
                                                (dpb (ldb (byte 6 0) (aref in (%+ 5 rptr))) (byte 6 0)
                                                     0)))))))
                      (setf rptr (%+ rptr 6)))
                     (t
                      (return))))
            
              (t
               (xerror "Corrupted UTF-8 input (initial byte was #b~8,'0B)" byte0)) ) )) 
    (values wptr rptr))  )

(defmethod encoding-p ((object (eql :utf-16-little-endian))) t)
(defmethod encoding-p ((object (eql :utf-16-big-endian))) t)
(defmethod encoding-p ((object (eql :utf-8))) t)

(defmethod encoding-p ((object encoding)) t)

(defmethod decode-sequence ((encoding simple-8-bit-encoding)
                            in in-start in-end
                            out out-start out-end 
                            eof?)
  (declare (optimize (speed 3) (safety 0))
           (type (simple-array (unsigned-byte 8) (*)) in)
           (type (simple-array #.+buffer-byte+ (*)) out)
           (type fixnum in-start in-end out-start out-end))
  (let ((wptr out-start)
        (rptr in-start)
        (byte 0)
        (table (slot-value encoding 'table))) 
    (declare (type fixnum wptr rptr)
             (type (unsigned-byte 8) byte)
             (type (simple-array #.+buffer-byte+ (*)) table))
    (loop
      (when (%= wptr out-end) (return))
      (when (%>= rptr in-end) (return))
      (setq byte (aref in rptr))
      (cond ((= byte #x0D)
             ;; CR handling
             ;; we need to know the following character
             (cond ((>= (%+ rptr 1) in-end)
                    ;; no characters in buffer
                    (cond (eof?
                           ;; at EOF, pass it as NL
                           (setf (aref out wptr) #x0A)
                           (setf wptr (%+ wptr 1))
                           (setf rptr (%+ rptr 1)))
                          (t
                           ;; demand more characters
                           (return))))
                   ((= (aref in (%+ rptr 1)) #x0A)
                    ;; we see CR NL, so forget this CR and the next NL will be
                    ;; inserted literally
                    (setf rptr (%+ rptr 1)))
                   (t
                    ;; singleton CR, pass it as NL
                    (setf (aref out wptr) #x0A)
                    (setf wptr (%+ wptr 1))
                    (setf rptr (%+ rptr 1)))))
                    
            (t
             (setf (aref out wptr) (aref table byte))
             (setf wptr (%+ wptr 1))
             (setf rptr (%+ rptr 1))) ))
    (values wptr rptr)))

;;;; ---------------------------------------------------------------------------
;;;;  Character sets
;;;;

(defvar *charsets* (make-hash-table :test #'eq))

(defclass 8-bit-charset ()
  ((name :initarg :name)
   (to-unicode-table 
    :initarg :to-unicode-table
    :reader to-unicode-table)))

(defmacro define-8-bit-charset (name &rest codes)
  (assert (= 256 (length codes)))
  `(progn
     (setf (gethash ',name *charsets*)
         (make-instance '8-bit-charset
           :name ',name
           :to-unicode-table
           ',(make-array 256 
                         :element-type '#.+buffer-byte+
                         :initial-contents codes)))
     ',name))

(defun find-charset (name)
  (or (gethash name *charsets*)
      (xerror "There is no character set named ~S." name)))