r383: Scripting extensions using swig. This commit includes only a (LGPL)
[kai/samba.git] / source4 / scripting / swig / tdb.i
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Swig interface to tdb.
5
6    Copyright (C) 2004 Tim Potter <tpot@samba.org>
7
8      ** NOTE! The following LGPL license applies to the tdb
9      ** library. This does NOT imply that all of Samba is released
10      ** under the LGPL
11    
12    This library is free software; you can redistribute it and/or
13    modify it under the terms of the GNU Lesser General Public
14    License as published by the Free Software Foundation; either
15    version 2 of the License, or (at your option) any later version.
16
17    This library is distributed in the hope that it will be useful,
18    but WITHOUT ANY WARRANTY; without even the implied warranty of
19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20    Lesser General Public License for more details.
21
22    You should have received a copy of the GNU Lesser General Public
23    License along with this library; if not, write to the Free Software
24    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25 */
26
27 %module tdb
28
29 %{
30
31 /* The tdb_set_lock_alarm() function requires the SIG_ATOMIC_T
32    function from includes.h */
33
34 #include "include/config.h"
35 #if defined(HAVE_SIG_ATOMIC_T_TYPE)
36 typedef sig_atomic_t SIG_ATOMIC_T;
37 #else
38 typedef int SIG_ATOMIC_T;
39 #endif
40
41 /* Include tdb headers */
42
43 #include "tdb/tdb.h"
44
45 %}
46
47 /* The tdb functions will crash if a NULL tdb is passed */
48
49 %include exception.i
50
51 %typemap(check) TDB_CONTEXT* {
52         if ($1 == NULL)
53                 SWIG_exception(SWIG_ValueError, 
54                         "tdb context must be non-NULL");
55 }
56
57 /* In and out typemaps for the TDB_DATA structure.  This is converted to
58    and from the Python string type. */
59
60 %typemap(in) TDB_DATA {
61         if (!PyString_Check($input)) {
62                 PyErr_SetString(PyExc_TypeError, "string arg expected");
63                 return NULL;
64         }
65         $1.dsize = PyString_Size($input);
66         $1.dptr = PyString_AsString($input);
67 }
68
69 %typemap(out) TDB_DATA {
70         if ($1.dptr == NULL && $1.dsize == 0) {
71                 $result = Py_None;
72         } else {
73                 $result = PyString_FromStringAndSize($1.dptr, $1.dsize);
74                 free($1.dptr);
75         }
76 }
77
78 /* Treat a mode_t as an unsigned integer */
79
80 typedef unsigned int mode_t;
81
82 /* flags to tdb_store() */
83
84 #define TDB_REPLACE 1
85 #define TDB_INSERT 2
86 #define TDB_MODIFY 3
87
88 /* flags for tdb_open() */
89
90 #define TDB_DEFAULT 0 /* just a readability place holder */
91 #define TDB_CLEAR_IF_FIRST 1
92 #define TDB_INTERNAL 2 /* don't store on disk */
93 #define TDB_NOLOCK   4 /* don't do any locking */
94 #define TDB_NOMMAP   8 /* don't use mmap */
95 #define TDB_CONVERT 16 /* convert endian (internal use) */
96 #define TDB_BIGENDIAN 32 /* header is big-endian (internal use) */
97
98 TDB_CONTEXT *tdb_open(const char *name, int hash_size, int tdb_flags,
99                       int open_flags, mode_t mode);
100
101 TDB_CONTEXT *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
102                          int open_flags, mode_t mode,
103                          tdb_log_func log_fn);
104
105 int tdb_reopen(TDB_CONTEXT *tdb);
106 int tdb_reopen_all(void);
107
108 void tdb_logging_function(TDB_CONTEXT *tdb, tdb_log_func);
109 enum TDB_ERROR tdb_error(TDB_CONTEXT *tdb);
110 const char *tdb_errorstr(TDB_CONTEXT *tdb);
111 TDB_DATA tdb_fetch(TDB_CONTEXT *tdb, TDB_DATA key);
112 int tdb_delete(TDB_CONTEXT *tdb, TDB_DATA key);
113 int tdb_store(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, int flag = TDB_REPLACE);
114 int tdb_append(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA new_dbuf);
115 int tdb_close(TDB_CONTEXT *tdb);
116 TDB_DATA tdb_firstkey(TDB_CONTEXT *tdb);
117 TDB_DATA tdb_nextkey(TDB_CONTEXT *tdb, TDB_DATA key);
118 int tdb_traverse(TDB_CONTEXT *tdb, tdb_traverse_func fn, void *state);
119 int tdb_exists(TDB_CONTEXT *tdb, TDB_DATA key);
120 int tdb_lockkeys(TDB_CONTEXT *tdb, u32 number, TDB_DATA keys[]);
121 void tdb_unlockkeys(TDB_CONTEXT *tdb);
122 int tdb_lockall(TDB_CONTEXT *tdb);
123 void tdb_unlockall(TDB_CONTEXT *tdb);
124
125 /* Low level locking functions: use with care */
126 void tdb_set_lock_alarm(SIG_ATOMIC_T *palarm);
127 int tdb_chainlock(TDB_CONTEXT *tdb, TDB_DATA key);
128 int tdb_chainunlock(TDB_CONTEXT *tdb, TDB_DATA key);
129
130 /* Debug functions. Not used in production. */
131 void tdb_dump_all(TDB_CONTEXT *tdb);
132 int tdb_printfreelist(TDB_CONTEXT *tdb);