tests/enum.lisp

   1 ;;;; -*- Mode: lisp; indent-tabs-mode: nil -*-
   2 ;;;
   3 ;;; enum.lisp --- Tests on C enums.
   4 ;;;
   5 ;;; Copyright (C) 2005-2006, Luis Oliveira  <loliveira(@)common-lisp.net>
   6 ;;;
   7 ;;; Permission is hereby granted, free of charge, to any person
   8 ;;; obtaining a copy of this software and associated documentation
   9 ;;; files (the "Software"), to deal in the Software without
  10 ;;; restriction, including without limitation the rights to use, copy,
  11 ;;; modify, merge, publish, distribute, sublicense, and/or sell copies
  12 ;;; of the Software, and to permit persons to whom the Software is
  13 ;;; furnished to do so, subject to the following conditions:
  14 ;;;
  15 ;;; The above copyright notice and this permission notice shall be
  16 ;;; included in all copies or substantial portions of the Software.
  17 ;;;
  18 ;;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  19 ;;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20 ;;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21 ;;; NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  22 ;;; HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  23 ;;; WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24 ;;; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  25 ;;; DEALINGS IN THE SOFTWARE.
  26 ;;;
  27
  28 (in-package #:cffi-tests)
  29
  30 (defctype numeros-base-type :int)
  31
  32 (defcenum (numeros numeros-base-type)
  33   (:one 1)
  34   :two
  35   :three
  36   :four
  37   (:forty-one 41)
  38   :forty-two)
  39
  40 (defcfun "check_enums" :int
  41   (%one numeros)
  42   (%two numeros)
  43   (%three numeros)
  44   (%four numeros)
  45   (%forty-one numeros)
  46   (%forty-two numeros))
  47
  48 (deftest enum.1
  49     (check-enums :one :two :three 4 :forty-one :forty-two)
  50   1)
  51
  52 (defcenum another-boolean :false :true)
  53 (defcfun "return_enum" another-boolean (x :uint))
  54
  55 (deftest enum.2
  56     (and (eq :false (return-enum 0))
  57          (eq :true (return-enum 1)))
  58   t)
  59
  60 (defctype yet-another-boolean another-boolean)
  61 (defcfun ("return_enum" return-enum2) yet-another-boolean
  62   (x yet-another-boolean))
  63
  64 (deftest enum.3
  65     (and (eq :false (return-enum2 :false))
  66          (eq :true (return-enum2 :true)))
  67   t)
  68
  69 (defctype numeros-typedef numeros)
  70
  71 (deftest enum.typedef.1
  72     (eq (foreign-enum-keyword 'numeros-typedef 1)
  73         (foreign-enum-keyword 'numeros 1))
  74   t)
  75
  76 (deftest enum.typedef.2
  77     (eql (foreign-enum-value 'numeros-typedef :four)
  78          (foreign-enum-value 'numeros :four))
  79   t)
  80
  81 (defcenum enum-size.int
  82   (:one 1)
  83   (enum-size-int #.(1- (expt 2 (1- (* (foreign-type-size :unsigned-int) 8)))))
  84   (enum-size-negative-int #.(- (1- (expt 2 (1- (* (foreign-type-size :unsigned-int) 8))))))
  85   (:two 2))
  86
  87 (defcenum enum-size.uint
  88   (:one 1)
  89   (enum-size-uint #.(1- (expt 2 (* (foreign-type-size :unsigned-int) 8))))
  90   (:two 2))
  91
  92 (deftest enum.size
  93     (mapcar (alexandria:compose 'cffi::unparse-type
  94                                 'cffi::actual-type
  95                                 'cffi::parse-type)
  96             (list 'enum-size.int
  97                   'enum-size.uint))
  98   ;; The C standard only has weak constraints on the size of integer types, so
  99   ;; we cannot really test more than one type in a platform independent way due
 100   ;; to the possible overlaps.
 101   (:int
 102    :unsigned-int))
 103
 104 (deftest enum.size.members
 105     (mapcar (alexandria:conjoin 'boundp 'constantp)
 106             '(enum-size-int enum-size-negative-int enum-size-uint))
 107   (t t t))
 108
 109 (deftest enum.size.error-when-too-large
 110     (expecting-error
 111       (eval '(defcenum enum-size-too-large
 112               (:too-long #.(expt 2 129)))))
 113   :error)
 114
 115 ;; There are some projects that use non-integer base type. It's not in
 116 ;; adherence with the C standard, but we also don't lose much by
 117 ;; allowing it.
 118 (defcenum (enum.double :double)
 119   (:one 1)
 120   (:two 2d0)
 121   (:three 3.42)
 122   :four)
 123
 124 (deftest enum.double
 125     (values-list
 126      (mapcar (alexandria:curry 'foreign-enum-value 'enum.double)
 127              '(:one :two :three :four)))
 128   1
 129   2.0d0
 130   3.42
 131   4.42)
 132
 133 ;; Test undeclared values
 134 (defcenum (enum.undeclared :int :allow-undeclared-values T)
 135   (:one 1)
 136   (:two 2))
 137
 138 (deftest enum.undeclared
 139     (with-foreign-object (enum 'enum.undeclared 3)
 140       (setf (mem-aref enum 'enum.undeclared 0) 1)
 141       (setf (mem-aref enum 'enum.undeclared 1) 2)
 142       (setf (mem-aref enum 'enum.undeclared 2) 3)
 143       (values (mem-aref enum 'enum.undeclared 0)
 144               (mem-aref enum 'enum.undeclared 1)
 145               (mem-aref enum 'enum.undeclared 2)))
 146   :one
 147   :two
 148   3)
 149
 150 ;;;# Bitfield tests
 151
 152 ;;; Regression test: defbitfield was misbehaving when the first value
 153 ;;; was provided.
 154 (deftest bitfield.1
 155     (eval '(defbitfield (bf1 :long)
 156              (:foo 0)))
 157   bf1)
 158
 159 (defbitfield bf2
 160   one
 161   two
 162   four
 163   eight
 164   sixteen
 165   (bf2.outlier 42)
 166   thirty-two
 167   sixty-four)
 168
 169 (deftest bitfield.2
 170     (mapcar (lambda (symbol)
 171               (foreign-bitfield-value 'bf2 (list symbol)))
 172             '(one two four eight sixteen thirty-two sixty-four))
 173   (1 2 4 8 16 32 64))
 174
 175 (deftest bitfield.2.outlier
 176     (mapcar (lambda (symbol)
 177               (foreign-bitfield-value 'bf2 (list symbol)))
 178             '(one two four eight sixteen thirty-two sixty-four))
 179   (1 2 4 8 16 32 64))
 180
 181 (defbitfield (bf3 :int)
 182   (three 3)
 183   one
 184   (seven 7)
 185   two
 186   (eight 8)
 187   sixteen)
 188
 189 ;;; Non-single-bit numbers must not influence the progression of
 190 ;;; implicit values.  Single bits larger than any before *must*
 191 ;;; influence said progression.
 192 (deftest bitfield.3
 193     (mapcar (lambda (symbol)
 194               (foreign-bitfield-value 'bf3 (list symbol)))
 195             '(one two sixteen))
 196   (1 2 16))
 197
 198 (defbitfield bf4
 199   ;; zero will be a simple enum member because it's not a valid mask
 200   (zero 0)
 201   one
 202   two
 203   four
 204   (three 3)
 205   (sixteen 16))
 206
 207 ;;; Yet another edge case with the 0...
 208 (deftest bitfield.4
 209     ;; These should macroexpand to the literals in Slime
 210     ;; due to the compiler macros. Same below.
 211     (values (foreign-bitfield-value 'bf4 ())
 212             (foreign-bitfield-value 'bf4 'one)
 213             (foreign-bitfield-value 'bf4 '(one two))
 214             (foreign-bitfield-value 'bf4 '(three)) ; or should it signal an error?
 215             (foreign-bitfield-value 'bf4 '(sixteen)))
 216   0
 217   1
 218   3
 219   3
 220   16)
 221
 222 (deftest bitfield.4b
 223     (values (foreign-bitfield-symbols 'bf4 0)
 224             (foreign-bitfield-symbols 'bf4 1)
 225             (foreign-bitfield-symbols 'bf4 3)
 226             (foreign-bitfield-symbols 'bf4 8)
 227             (foreign-bitfield-symbols 'bf4 16))
 228   nil
 229   (one)
 230   (one two)
 231   nil
 232   (sixteen))
 233
 234 (deftest bitfield.translators
 235     (with-foreign-object (bf 'bf4 2)
 236       (setf (mem-aref bf 'bf4 0) 1)
 237       (setf (mem-aref bf 'bf4 1) 3)
 238       (values (mem-aref bf 'bf4 0)
 239               (mem-aref bf 'bf4 1)))
 240   (one)
 241   (one two))
 242
 243 #+nil
 244 (deftest bitfield.base-type-error
 245     (expecting-error
 246       (eval '(defbitfield (bf1 :float)
 247               (:foo 0))))
 248   :error)