;;;; foreign.test --- FFI. -*- mode: scheme; coding: utf-8; -*-
;;;;
-;;;; Copyright (C) 2010 Free Software Foundation, Inc.
+;;;; Copyright (C) 2010, 2011 Free Software Foundation, Inc.
;;;;
;;;; This library is free software; you can redistribute it and/or
;;;; modify it under the terms of the GNU Lesser General Public
(define-module (test-foreign)
#:use-module (system foreign)
- #:use-module (rnrs bytevector)
+ #:use-module (rnrs bytevectors)
+ #:use-module (srfi srfi-1)
+ #:use-module (srfi srfi-26)
#:use-module (test-suite lib))
\f
(with-test-prefix "null pointer"
+ (pass-if "pointer?"
+ (pointer? %null-pointer))
+
(pass-if "zero"
- (= 0 (foreign-ref %null-pointer)))
+ (= 0 (pointer-address %null-pointer)))
- (pass-if-exception "foreign-set! %null-pointer"
- exception:null-pointer-error
- (foreign-set! %null-pointer 2))
-
- (pass-if "foreign-set! other-null-pointer"
- (let ((f (bytevector->foreign (make-bytevector 2))))
- (and (not (= 0 (foreign-ref f)))
- (begin
- (foreign-set! f 0)
- (= 0 (foreign-ref f)))
- (begin
- ;; Here changing the pointer value of F is perfectly valid.
- (foreign-set! f 777)
- (= 777 (foreign-ref f))))))
-
- (pass-if-exception "foreign->bytevector %null-pointer"
- exception:null-pointer-error
- (foreign->bytevector %null-pointer))
+ (pass-if "null pointer identity"
+ (eq? %null-pointer (make-pointer 0)))
+
+ (pass-if "null-pointer? %null-pointer"
+ (null-pointer? %null-pointer))
- (pass-if-exception "foreign->bytevector other-null-pointer"
+ (pass-if-exception "pointer->bytevector %null-pointer"
exception:null-pointer-error
- (let ((f (bytevector->foreign (make-bytevector 2))))
- (foreign-set! f 0)
- (foreign->bytevector f))))
+ (pointer->bytevector %null-pointer 7)))
+
+\f
+(with-test-prefix "make-pointer"
+
+ (pass-if "pointer?"
+ (pointer? (make-pointer 123)))
+
+ (pass-if "address preserved"
+ (= 123 (pointer-address (make-pointer 123))))
+
+ (pass-if "equal?"
+ (equal? (make-pointer 123) (make-pointer 123)))
+
+ (pass-if "equal? modulo finalizer"
+ (let ((finalizer (dynamic-func "scm_is_pair" (dynamic-link))))
+ (equal? (make-pointer 123)
+ (make-pointer 123 finalizer))))
+
+ (pass-if "not equal?"
+ (not (equal? (make-pointer 123) (make-pointer 456)))))
+
+\f
+(define-wrapped-pointer-type foo
+ foo?
+ wrap-foo unwrap-foo
+ (lambda (x p)
+ (format p "#<foo! ~a>" (pointer-address (unwrap-foo x)))))
+
+(with-test-prefix "define-wrapped-pointer-type"
+
+ (pass-if "foo?"
+ (foo? (wrap-foo %null-pointer)))
+
+ (pass-if "unwrap-foo"
+ (let ((p (make-pointer 123)))
+ (eq? p (unwrap-foo (wrap-foo p)))))
+
+ (pass-if "identity"
+ (let ((p1 (make-pointer 123))
+ (p2 (make-pointer 123)))
+ (eq? (wrap-foo p1)
+ (wrap-foo p2))))
+
+ (pass-if "printer"
+ (string=? "#<foo! 123>"
+ (with-output-to-string
+ (lambda ()
+ (write (wrap-foo (make-pointer 123))))))))
+
+\f
+(with-test-prefix "pointer<->bytevector"
+
+ (pass-if "bijection"
+ (let ((bv #vu8(0 1 2 3 4 5 6 7)))
+ (equal? (pointer->bytevector (bytevector->pointer bv)
+ (bytevector-length bv))
+ bv)))
+
+ (pass-if "pointer from bits"
+ (let* ((bytes (iota (sizeof '*)))
+ (bv (u8-list->bytevector bytes)))
+ (= (pointer-address
+ (make-pointer (bytevector-uint-ref bv 0 (native-endianness)
+ (sizeof '*))))
+ (fold-right (lambda (byte address)
+ (+ byte (* 256 address)))
+ 0
+ bytes))))
+
+ (pass-if "dereference-pointer"
+ (let* ((bytes (iota (sizeof '*)))
+ (bv (u8-list->bytevector bytes)))
+ (= (pointer-address
+ (dereference-pointer (bytevector->pointer bv)))
+ (fold-right (lambda (byte address)
+ (+ byte (* 256 address)))
+ 0
+ bytes)))))
+
+\f
+(with-test-prefix "pointer<->string"
+
+ (pass-if "bijection"
+ (let ((s "hello, world"))
+ (string=? s (pointer->string (string->pointer s)))))
+
+ (pass-if "bijection [latin1]"
+ (with-latin1-locale
+ (let ((s "Szép jó napot!"))
+ (string=? s (pointer->string (string->pointer s)))))))
+
+\f
+(with-test-prefix "pointer->procedure"
+
+ (pass-if-exception "object instead of pointer"
+ exception:wrong-type-arg
+ (let ((p (pointer->procedure '* %null-pointer '(*))))
+ (p #t))))
+
+\f
+(with-test-prefix "procedure->pointer"
+
+ (define qsort
+ ;; Bindings for libc's `qsort' function.
+ (pointer->procedure void
+ (dynamic-func "qsort" (dynamic-link))
+ (list '* size_t size_t '*)))
+
+ (define (dereference-pointer-to-byte ptr)
+ (let ((b (pointer->bytevector ptr 1)))
+ (bytevector-u8-ref b 0)))
+
+ (define input
+ '(7 1 127 3 5 4 77 2 9 0))
+
+ (pass-if "qsort"
+ (if (defined? 'procedure->pointer)
+ (let* ((called? #f)
+ (cmp (lambda (x y)
+ (set! called? #t)
+ (- (dereference-pointer-to-byte x)
+ (dereference-pointer-to-byte y))))
+ (ptr (procedure->pointer int cmp (list '* '*)))
+ (bv (u8-list->bytevector input)))
+ (qsort (bytevector->pointer bv) (bytevector-length bv) 1
+ (procedure->pointer int cmp (list '* '*)))
+ (and called?
+ (equal? (bytevector->u8-list bv)
+ (sort input <))))
+ (throw 'unresolved)))
+
+ (pass-if-exception "qsort, wrong return type"
+ exception:wrong-type-arg
+
+ (if (defined? 'procedure->pointer)
+ (let* ((cmp (lambda (x y) #f)) ; wrong return type
+ (ptr (procedure->pointer int cmp (list '* '*)))
+ (bv (u8-list->bytevector input)))
+ (qsort (bytevector->pointer bv) (bytevector-length bv) 1
+ (procedure->pointer int cmp (list '* '*)))
+ #f)
+ (throw 'unresolved)))
+
+ (pass-if-exception "qsort, wrong arity"
+ exception:wrong-num-args
+
+ (if (defined? 'procedure->pointer)
+ (let* ((cmp (lambda (x y z) #f)) ; wrong arity
+ (ptr (procedure->pointer int cmp (list '* '*)))
+ (bv (u8-list->bytevector input)))
+ (qsort (bytevector->pointer bv) (bytevector-length bv) 1
+ (procedure->pointer int cmp (list '* '*)))
+ #f)
+ (throw 'unresolved)))
+
+ (pass-if "bijection"
+ (if (defined? 'procedure->pointer)
+ (let* ((proc (lambda (x y z)
+ (+ x y z 0.0)))
+ (ret double)
+ (args (list float int16 double))
+ (proc* (pointer->procedure ret
+ (procedure->pointer ret proc args)
+ args))
+ (arg1 (map (cut / <> 2.0) (iota 123)))
+ (arg2 (iota 123 32000))
+ (arg3 (map (cut / <> 4.0) (iota 123 100 4))))
+ (equal? (map proc arg1 arg2 arg3)
+ (map proc* arg1 arg2 arg3)))
+ (throw 'unresolved))))
+
+\f
+(with-test-prefix "structs"
+
+ (pass-if "sizeof { int8, double }"
+ (= (sizeof (list int8 double))
+ (+ (alignof double) (sizeof double))))
+
+ (pass-if "sizeof { short, int, long, pointer }"
+ (let ((layout (list short int long '*)))
+ (>= (sizeof layout)
+ (reduce + 0.0 (map sizeof layout)))))
+
+ (pass-if "alignof { int8, double, int8 }"
+ ;; alignment of the most strictly aligned component
+ (let ((layout (list int8 double int8)))
+ (= (alignof layout) (alignof double))))
+
+ (pass-if "parse-c-struct"
+ (let ((layout (list int64 uint8))
+ (data (list -300 43)))
+ (equal? (parse-c-struct (make-c-struct layout data)
+ layout)
+ data)))
+
+ (pass-if "alignment constraints honored"
+ (let ((layout (list int8 double))
+ (data (list -7 3.14)))
+ (equal? (parse-c-struct (make-c-struct layout data)
+ layout)
+ data)))
+
+ (pass-if "int8, pointer"
+ (let ((layout (list uint8 '*))
+ (data (list 222 (make-pointer 7777))))
+ (equal? (parse-c-struct (make-c-struct layout data)
+ layout)
+ data)))
+
+ (pass-if "unsigned-long, int8, size_t"
+ (let ((layout (list unsigned-long int8 size_t))
+ (data (list (expt 2 17) -128 (expt 2 18))))
+ (equal? (parse-c-struct (make-c-struct layout data)
+ layout)
+ data)))
+
+ (pass-if "long, int, pointer"
+ (let ((layout (list long int '*))
+ (data (list (- (expt 2 17)) -222 (make-pointer 777))))
+ (equal? (parse-c-struct (make-c-struct layout data)
+ layout)
+ data)))
+
+ (pass-if "int8, pointer, short, double"
+ (let ((layout (list int8 '* short double))
+ (data (list 77 %null-pointer -42 3.14)))
+ (equal? (parse-c-struct (make-c-struct layout data)
+ layout)
+ data)))
+
+ (pass-if "int8, { int8, double, int8 }, int16"
+ (let ((layout (list int8 (list int8 double int8) int16))
+ (data (list 77 (list 42 4.2 55) 88)))
+ (equal? (parse-c-struct (make-c-struct layout data)
+ layout)
+ data))))