Tizen 2.1 base
[external/libgpg-error.git] / lang / cl / gpg-error-package.lisp
1 ;;;; libgpg-error-package.lisp
2
3 ;;; Copyright (C) 2006 g10 Code GmbH
4 ;;;
5 ;;; This file is part of libgpg-error.
6 ;;;
7 ;;; libgpg-error is free software; you can redistribute it and/or
8 ;;; modify it under the terms of the GNU Lesser General Public License
9 ;;; as published by the Free Software Foundation; either version 2.1 of
10 ;;; the License, or (at your option) any later version.
11 ;;;
12 ;;; libgpg-error is distributed in the hope that it will be useful, but
13 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 ;;; Lesser General Public License for more details.
16 ;;;
17 ;;; You should have received a copy of the GNU Lesser General Public
18 ;;; License along with libgpg-error; if not, write to the Free
19 ;;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 ;;; 02111-1307, USA.
21
22 ;;; Conventions
23 ;;;
24 ;;; Error sources and codes are represented as keywords like
25 ;;; :gpg-err-source-gpg and :gpg-err-unknown-packet.
26 ;;;
27 ;;; Errors are represented as lists '(SOURCE CODE).  Other
28 ;;; representations are also accepted in some places.
29 ;;;
30 ;;; The following functions are defined which are not defined in the C API:
31 ;;; gpg-err-source-as-key, gpg-err-source-as-value
32 ;;; gpg-err-code-as-key, gpg-err-code-as-value
33 ;;; gpg-err-canonicalize, gpg-err-as-value
34 ;;; Conversion between keywords and values for error sources and codes.
35 ;;; 
36 ;;; The following functions from the C API are omitted:
37 ;;; gpg-strerror-r
38 ;;;
39 ;;; The following features work slightly differently:
40 ;;; *gpg-err-source-default* is a dynamic variable that can be set to
41 ;;; change the default for gpg-error.
42
43 (defpackage #:gpg-error
44   (:use #:common-lisp #:cffi)
45
46   (:export :gpg-err-code-as-key
47            :gpg-err-code-as-value
48            :gpg-err-source-as-key
49            :gpg-err-source-as-value
50            :gpg-err-canonicalize
51            :gpg-err-as-value
52            :gpg-err-make
53            :*gpg-err-source-default*
54            :gpg-error
55            :gpg-err-code
56            :gpg-err-source
57            :gpg-strerror
58            :gpg-strsource
59            :gpg-err-code-from-errno
60            :gpg-err-code-to-errno
61            :gpg-err-code-from-syserror
62            :gpg-err-make-from-errno
63            :gpg-error-from-errno
64            :gpg-error-from-syserror))