pytalloc: Use consistent prefix for functions, add ABI file.
[sfrench/samba-autobuild/.git] / lib / talloc / pytalloc.h
1 /* 
2    Unix SMB/CIFS implementation.
3    Samba utility functions
4    Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2008
5    
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #ifndef _PYTALLOC_H_
21 #define _PYTALLOC_H_
22
23 #include <Python.h>
24 #include <talloc.h>
25
26 typedef struct {
27         PyObject_HEAD
28         TALLOC_CTX *talloc_ctx;
29         void *ptr;
30 } pytalloc_Object;
31
32 PyTypeObject *pytalloc_GetObjectType(void);
33 int pytalloc_Check(PyObject *);
34
35 /* Retrieve the pointer for a pytalloc_object. Like talloc_get_type() 
36  * but for pytalloc_Objects. */
37
38 /* FIXME: Call PyErr_SetString(PyExc_TypeError, "expected " __STR(type) ") 
39  * when talloc_get_type() returns NULL. */
40 #define pytalloc_get_type(py_obj, type) (talloc_get_type(pytalloc_get_ptr(py_obj), type))
41
42 #define pytalloc_get_ptr(py_obj) (((pytalloc_Object *)py_obj)->ptr)
43 #define pytalloc_get_mem_ctx(py_obj)  ((pytalloc_Object *)py_obj)->talloc_ctx
44
45 PyObject *pytalloc_steal_ex(PyTypeObject *py_type, TALLOC_CTX *mem_ctx, void *ptr);
46 PyObject *pytalloc_steal(PyTypeObject *py_type, void *ptr);
47 PyObject *pytalloc_reference_ex(PyTypeObject *py_type, TALLOC_CTX *mem_ctx, void *ptr);
48 #define pytalloc_reference(py_type, talloc_ptr) pytalloc_reference_ex(py_type, talloc_ptr, talloc_ptr)
49
50 #define pytalloc_new(type, typeobj) pytalloc_steal(typeobj, talloc_zero(NULL, type))
51
52 PyObject *pytalloc_CObject_FromTallocPtr(void *);
53
54 #endif /* _PYTALLOC_H_ */