Use `SCM_LIKELY ()' and `SCM_UNLIKELY ()' instead of rolling our own.
[guile-r6rs-libs.git] / tests / io-ports.test
blob4297721b82b11f3101ef388f3ae84875b3f258a8
1 ;;; R6RS I/O Ports.
2 ;;;
3 ;;; Copyright 2007, 2009  Ludovic Courtès <ludo@gnu.org>
4 ;;;
5 ;;;
6 ;;; This program is free software; you can redistribute it and/or modify
7 ;;; it under the terms of the GNU General Public License as published by
8 ;;; the Free Software Foundation; either version 2 of the License, or
9 ;;; (at your option) any later version.
10 ;;;
11 ;;; This program is distributed in the hope that it will be useful,
12 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 ;;; GNU General Public License for more details.
15 ;;;
16 ;;; You should have received a copy of the GNU General Public License
17 ;;; along with this program; if not, write to the Free Software
18 ;;; Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
20 (define-module (test-io-ports)
21   :use-module (test-suite lib)
22   :use-module (srfi srfi-1)
23   :use-module (srfi srfi-11)
24   :use-module (rnrs io ports)
25   :use-module (rnrs bytevector))
27 ;;; All these tests assume Guile 1.8's port system, where characters are
28 ;;; treated as octets.
31 (with-test-prefix "7.2.5 End-of-File Object"
33   (pass-if "eof-object"
34     (and (eqv? (eof-object) (eof-object))
35          (eq?  (eof-object) (eof-object)))))
38 (with-test-prefix "7.2.8 Binary Input"
40   (pass-if "get-u8"
41     (let ((port (open-input-string "A")))
42       (and (= (char->integer #\A) (get-u8 port))
43            (eof-object? (get-u8 port)))))
45   (pass-if "lookahead-u8"
46     (let ((port (open-input-string "A")))
47       (and (= (char->integer #\A) (lookahead-u8 port))
48            (not (eof-object? port))
49            (= (char->integer #\A) (get-u8 port))
50            (eof-object? (get-u8 port)))))
52   (pass-if "get-bytevector-n [short]"
53     (let* ((port (open-input-string "GNU Guile"))
54            (bv (get-bytevector-n port 4)))
55       (and (bytevector? bv)
56            (equal? (bytevector->u8-list bv)
57                    (map char->integer (string->list "GNU "))))))
59   (pass-if "get-bytevector-n [long]"
60     (let* ((port (open-input-string "GNU Guile"))
61            (bv (get-bytevector-n port 256)))
62       (and (bytevector? bv)
63            (equal? (bytevector->u8-list bv)
64                    (map char->integer (string->list "GNU Guile"))))))
66   (pass-if-exception "get-bytevector-n with closed port"
67     exception:wrong-type-arg
69     (let ((port (%make-void-port "r")))
71       (close-port port)
72       (get-bytevector-n port 3)))
74   (pass-if "get-bytevector-n! [short]"
75     (let* ((port (open-input-string "GNU Guile"))
76            (bv   (make-bytevector 4))
77            (read (get-bytevector-n! port bv 0 4)))
78       (and (equal? read 4)
79            (equal? (bytevector->u8-list bv)
80                    (map char->integer (string->list "GNU "))))))
82   (pass-if "get-bytevector-n! [long]"
83     (let* ((str  "GNU Guile")
84            (port (open-input-string str))
85            (bv   (make-bytevector 256))
86            (read (get-bytevector-n! port bv 0 256)))
87       (and (equal? read (string-length str))
88            (equal? (map (lambda (i)
89                           (bytevector-u8-ref bv i))
90                         (iota read))
91                    (map char->integer (string->list str))))))
93   (pass-if "get-bytevector-some [simple]"
94     (let* ((str  "GNU Guile")
95            (port (open-input-string str))
96            (bv   (get-bytevector-some port)))
97       (and (bytevector? bv)
98            (equal? (bytevector->u8-list bv)
99                    (map char->integer (string->list str))))))
101   (pass-if "get-bytevector-some [only-some]"
102     (let* ((str   "GNU Guile")
103            (index 0)
104            (port  (make-soft-port
105                    (vector #f #f #f
106                            (lambda ()
107                              (if (>= index (string-length str))
108                                  (eof-object)
109                                  (let ((c (string-ref str index)))
110                                    (set! index (+ index 1))
111                                    c)))
112                            (lambda () #t)
113                            (lambda ()
114                              ;; Number of readily available octets: falls to
115                              ;; zero after 4 octets have been read.
116                              (- 4 (modulo index 5))))
117                    "r"))
118            (bv    (get-bytevector-some port)))
119       (and (bytevector? bv)
120            (= index 4)
121            (= (bytevector-length bv) index)
122            (equal? (bytevector->u8-list bv)
123                    (map char->integer (string->list "GNU "))))))
125   (pass-if "get-bytevector-all"
126     (let* ((str   "GNU Guile")
127            (index 0)
128            (port  (make-soft-port
129                    (vector #f #f #f
130                            (lambda ()
131                              (if (>= index (string-length str))
132                                  (eof-object)
133                                  (let ((c (string-ref str index)))
134                                    (set! index (+ index 1))
135                                    c)))
136                            (lambda () #t)
137                            (let ((cont? #f))
138                              (lambda ()
139                                ;; Number of readily available octets: falls to
140                                ;; zero after 4 octets have been read and then
141                                ;; starts again.
142                                (let ((a (if cont?
143                                             (- (string-length str) index)
144                                             (- 4 (modulo index 5)))))
145                                  (if (= 0 a) (set! cont? #t))
146                                  a))))
147                    "r"))
148            (bv    (get-bytevector-all port)))
149       (and (bytevector? bv)
150            (= index (string-length str))
151            (= (bytevector-length bv) (string-length str))
152            (equal? (bytevector->u8-list bv)
153                    (map char->integer (string->list str)))))))
156 (define (make-soft-output-port)
157   (let* ((bv (make-bytevector 1024))
158          (read-index  0)
159          (write-index 0)
160          (write-char (lambda (chr)
161                        (bytevector-u8-set! bv write-index
162                                            (char->integer chr))
163                        (set! write-index (+ 1 write-index)))))
164     (make-soft-port
165      (vector write-char
166              (lambda (str)   ;; write-string
167                (for-each write-char (string->list str)))
168              (lambda () #t)  ;; flush-output
169              (lambda ()      ;; read-char
170                (if (>= read-index (bytevector-length bv))
171                    (eof-object)
172                    (let ((c (bytevector-u8-ref bv read-index)))
173                      (set! read-index (+ read-index 1))
174                      (integer->char c))))
175              (lambda () #t)) ;; close-port
176      "rw")))
178 (with-test-prefix "7.2.11 Binary Output"
180   (pass-if "put-u8"
181     (let ((port (make-soft-output-port)))
182       (put-u8 port 77)
183       (equal? (get-u8 port) 77)))
185   (pass-if "put-bytevector [2 args]"
186     (let ((port (make-soft-output-port))
187           (bv   (make-bytevector 256)))
188       (put-bytevector port bv)
189       (equal? (bytevector->u8-list bv)
190               (bytevector->u8-list
191                (get-bytevector-n port (bytevector-length bv))))))
193   (pass-if "put-bytevector [3 args]"
194     (let ((port  (make-soft-output-port))
195           (bv    (make-bytevector 256))
196           (start 10))
197       (put-bytevector port bv start)
198       (equal? (drop (bytevector->u8-list bv) start)
199               (bytevector->u8-list
200                (get-bytevector-n port (- (bytevector-length bv) start))))))
202   (pass-if "put-bytevector [4 args]"
203     (let ((port  (make-soft-output-port))
204           (bv    (make-bytevector 256))
205           (start 10)
206           (count 77))
207       (put-bytevector port bv start count)
208       (equal? (take (drop (bytevector->u8-list bv) start) count)
209               (bytevector->u8-list
210                (get-bytevector-n port count)))))
212   (pass-if-exception "put-bytevector with closed port"
213     exception:wrong-type-arg
215     (let* ((bv   (make-bytevector 4))
216            (port (%make-void-port "w")))
218       (close-port port)
219       (put-bytevector port bv)))
221   (pass-if "open-bytevector-output-port"
222     (let-values (((port get-content)
223                   (open-bytevector-output-port)))
224       (let ((source (make-bytevector 7777)))
225         (put-bytevector port source)
226         (and (bytevector=? (get-content) source)
227              (bytevector=? (get-content) (make-bytevector 0))))))
229   (pass-if "bytevector output port supports `port-position'"
230     (let-values (((port get-content)
231                   (open-bytevector-output-port)))
232       (let ((source (make-bytevector 7777))
233             (overwrite (make-bytevector 33)))
234         (and (port-has-port-position? port)
235              (port-has-set-port-position!? port)
236              (begin
237                (put-bytevector port source)
238                (= (bytevector-length source)
239                   (port-position port)))
240              (begin
241                (set-port-position! port 10)
242                (= 10 (port-position port)))
243              (begin
244                (put-bytevector port overwrite)
245                (bytevector-copy! overwrite 0 source 10
246                                  (bytevector-length overwrite))
247                (= (port-position port)
248                   (+ 10 (bytevector-length overwrite))))
249              (bytevector=? (get-content) source)
250              (bytevector=? (get-content) (make-bytevector 0)))))))
253 (with-test-prefix "7.2.7 Input Ports"
255   ;; This section appears here so that it can use the binary input
256   ;; primitives.
258   (pass-if "open-bytevector-input-port [1 arg]"
259     (let* ((str "Hello Port!")
260            (bv (u8-list->bytevector (map char->integer
261                                          (string->list str))))
262            (port (open-bytevector-input-port bv))
263            (read-to-string
264             (lambda (port)
265               (let loop ((chr (read-char port))
266                          (result '()))
267                 (if (eof-object? chr)
268                     (apply string (reverse! result))
269                     (loop (read-char port)
270                           (cons chr result)))))))
272       (equal? (read-to-string port) str)))
274   (pass-if-exception "bytevector-input-port is read-only"
275     exception:wrong-type-arg
277     (let* ((str "Hello Port!")
278            (bv (u8-list->bytevector (map char->integer
279                                          (string->list str))))
280            (port (open-bytevector-input-port bv)))
282       (write "hello" port)))
284   (pass-if "bytevector input port supports seeking"
285     (let* ((str "Hello Port!")
286            (bv (u8-list->bytevector (map char->integer
287                                          (string->list str))))
288            (port (open-bytevector-input-port bv)))
290       (and (port-has-port-position? port)
291            (= 0 (port-position port))
292            (port-has-set-port-position!? port)
293            (begin
294              (set-port-position! port 6)
295              (= 6 (port-position port)))
296            (bytevector=? (get-bytevector-all port)
297                          (u8-list->bytevector
298                           (map char->integer (string->list "Port!")))))))
300   (pass-if "make-custom-binary-input-port"
301     (let* ((source (make-bytevector 7777))
302            (read! (let ((pos 0)
303                         (len (bytevector-length source)))
304                     (lambda (bv start count)
305                       (let ((amount (min count (- len pos))))
306                         (if (> amount 0)
307                             (bytevector-copy! source pos
308                                               bv start amount))
309                         (set! pos (+ pos amount))
310                         amount))))
311            (port (make-custom-binary-input-port "the port" read!)))
313       (bytevector=? (get-bytevector-all port) source)))
315   (pass-if "custom binary input port does not support `port-position'"
316     (let* ((str "Hello Port!")
317            (source (open-bytevector-input-port
318                     (u8-list->bytevector
319                      (map char->integer (string->list str)))))
320            (read! (lambda (bv start count)
321                     (let ((r (get-bytevector-n! source bv start count)))
322                       (if (eof-object? r)
323                           0
324                           r))))
325            (port (make-custom-binary-input-port "the port" read!)))
326       (not (or (port-has-port-position? port)
327                (port-has-set-port-position!? port)))))
329   (pass-if "custom binary input port supports `port-position'"
330     (let* ((str "Hello Port!")
331            (source (open-bytevector-input-port
332                     (u8-list->bytevector
333                      (map char->integer (string->list str)))))
334            (read! (lambda (bv start count)
335                     (let ((r (get-bytevector-n! source bv start count)))
336                       (if (eof-object? r)
337                           0
338                           r))))
339            (get-pos (lambda ()
340                       (port-position source)))
341            (set-pos! (lambda (pos)
342                        (set-port-position! source pos)))
343            (port (make-custom-binary-input-port "the port" read!
344                                                 get-pos set-pos!)))
346       (and (port-has-port-position? port)
347            (= 0 (port-position port))
348            (port-has-set-port-position!? port)
349            (begin
350              (set-port-position! port 6)
351              (= 6 (port-position port)))
352            (bytevector=? (get-bytevector-all port)
353                          (u8-list->bytevector
354                           (map char->integer (string->list "Port!"))))))))
357 ;;; Local Variables:
358 ;;; coding: latin-1
359 ;;; mode: scheme
360 ;;; End:
362 ;;; arch-tag: fc4f49fa-18a5-4a0c-bee8-ef7554f9cf1d