2ef342fca4dcd1bca42ccdac4bdc6c88eb68d96a
[uffi.git] / examples / strtol.lisp
1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
4 ;;;;
5 ;;;; Name:          strtol.cl
6 ;;;; Purpose:       UFFI Example file to strtol, uses pointer arithmetic
7 ;;;; Programmer:    Kevin M. Rosenberg
8 ;;;; Date Started:  Feb 2002
9 ;;;;
10 ;;;; $Id$
11 ;;;;
12 ;;;; This file, part of UFFI, is Copyright (c) 2002-2005 by Kevin M. Rosenberg
13 ;;;;
14 ;;;; *************************************************************************
15
16 (in-package :cl-user)
17
18 (uffi:def-foreign-type char-ptr (* :unsigned-char))
19
20 ;; This example does not use :cstring to pass the input string since
21 ;; the routine needs to do pointer arithmetic to see how many characters
22 ;; were parsed
23
24 (uffi:def-function ("strtol" c-strtol)
25     ((nptr char-ptr)
26      (endptr (* char-ptr))
27      (base :int))
28   :returning :long)
29
30 (defun strtol (str &optional (base 10))
31   "Returns a long int from a string. Returns number and condition flag.
32 Condition flag is T if all of string parses as a long, NIL if
33 their was no string at all, or an integer indicating position in string
34 of first non-valid character"
35   (let* ((str-native (uffi:convert-to-foreign-string str))
36          (endptr (uffi:allocate-foreign-object 'char-ptr))
37          (value (c-strtol str-native endptr base))
38          (endptr-value (uffi:deref-pointer endptr 'char-ptr)))
39
40     (unwind-protect
41          (if (uffi:null-pointer-p endptr-value)
42              (values value t)
43              (let ((next-char-value (uffi:deref-pointer endptr-value :unsigned-char))
44                    (chars-parsed (- (uffi:pointer-address endptr-value)
45                                     (uffi:pointer-address str-native))))
46                (cond
47                  ((zerop chars-parsed)
48                   (values nil nil))
49                  ((uffi:null-char-p next-char-value)
50                   (values value t))
51                  (t
52                   (values value chars-parsed)))))
53       (progn
54         (uffi:free-foreign-object str-native)
55         (uffi:free-foreign-object endptr)))))
56
57
58
59 #+examples-uffi
60 (progn
61   (flet ((print-results (str)
62            (multiple-value-bind (result flag) (strtol str)
63              (format t "~&(strtol ~S) => ~S,~S" str result flag))))
64     (print-results "55")
65     (print-results "55.3")
66     (print-results "a")))
67
68 #+test-uffi
69 (progn
70   (flet ((test-strtol (str results)
71            (util.test:test (multiple-value-list (strtol str)) results
72                            :test #'equal
73                            :fail-info "Error testing strtol")))
74     (test-strtol "123" '(123 t))
75     (test-strtol "0" '(0 t))
76     (test-strtol "55a" '(55 2))
77     (test-strtol "a" '(nil nil))))
78
79
80