source4/lib/ldb/pyldb.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Swig interface to ldb.
   5
   6    Copyright (C) 2007-2008 Jelmer Vernooij <jelmer@samba.org>
   7
   8      ** NOTE! The following LGPL license applies to the ldb
   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 3 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, see <http://www.gnu.org/licenses/>.
  24 */
  25
  26 #ifndef _PYLDB_H_
  27 #define _PYLDB_H_
  28
  29 #include <Python.h>
  30 #include <talloc.h>
  31
  32 typedef struct {
  33         PyObject_HEAD
  34         struct ldb_context *ldb_ctx;
  35         TALLOC_CTX *mem_ctx;
  36 } PyLdbObject;
  37
  38 #define PyLdb_AsLdbContext(pyobj) ((PyLdbObject *)pyobj)->ldb_ctx
  39 #define PyLdb_Check(ob) PyObject_TypeCheck(ob, &PyLdb)
  40
  41 typedef struct {
  42         PyObject_HEAD
  43         struct ldb_dn *dn;
  44         TALLOC_CTX *mem_ctx;
  45 } PyLdbDnObject;
  46
  47 PyObject *PyLdbDn_FromDn(struct ldb_dn *);
  48 bool PyObject_AsDn(TALLOC_CTX *mem_ctx, PyObject *object, struct ldb_context *ldb_ctx, struct ldb_dn **dn);
  49 #define PyLdbDn_AsDn(pyobj) ((PyLdbDnObject *)pyobj)->dn
  50 #define PyLdbDn_Check(ob) PyObject_TypeCheck(ob, &PyLdbDn)
  51
  52 typedef struct {
  53         PyObject_HEAD
  54         struct ldb_message *msg;
  55         TALLOC_CTX *mem_ctx;
  56 } PyLdbMessageObject;
  57 #define PyLdbMessage_Check(ob) PyObject_TypeCheck(ob, &PyLdbMessage)
  58 #define PyLdbMessage_AsMessage(pyobj) ((PyLdbMessageObject *)pyobj)->msg
  59
  60 typedef struct {
  61         PyObject_HEAD
  62         struct ldb_module *mod;
  63         TALLOC_CTX *mem_ctx;
  64 } PyLdbModuleObject;
  65 PyObject *PyLdbMessage_FromMessage(struct ldb_message *message);
  66 PyObject *PyLdbModule_FromModule(struct ldb_module *mod);
  67 #define PyLdbModule_AsModule(pyobj) ((PyLdbModuleObject *)pyobj)->mod
  68
  69 typedef struct {
  70         PyObject_HEAD
  71         struct ldb_message_element *el;
  72         TALLOC_CTX *mem_ctx;
  73 } PyLdbMessageElementObject;
  74 struct ldb_message_element *PyObject_AsMessageElement(TALLOC_CTX *mem_ctx, PyObject *obj, int flags, const char *name);
  75 PyObject *PyLdbMessageElement_FromMessageElement(struct ldb_message_element *, TALLOC_CTX *mem_ctx);
  76 #define PyLdbMessageElement_AsMessageElement(pyobj) ((PyLdbMessageElementObject *)pyobj)->el
  77 #define PyLdbMessageElement_Check(ob) PyObject_TypeCheck(ob, &PyLdbMessageElement)
  78
  79 typedef struct {
  80         PyObject_HEAD
  81         struct ldb_parse_tree *tree;
  82         TALLOC_CTX *mem_ctx;
  83 } PyLdbTreeObject;
  84 PyObject *PyLdbTree_FromTree(struct ldb_parse_tree *);
  85 #define PyLdbTree_AsTree(pyobj) ((PyLdbTreeObject *)pyobj)->tree
  86
  87 #define PyErr_LDB_ERROR_IS_ERR_RAISE(err,ret,ldb) \
  88         if (ret != LDB_SUCCESS) { \
  89                 PyErr_SetLdbError(err, ret, ldb); \
  90                 return NULL; \
  91         }
  92
  93 /* Picked out of thin air. To do this properly, we should probably have some part of the
  94  * errors in LDB be allocated to bindings ? */
  95 #define LDB_ERR_PYTHON_EXCEPTION        142
  96
  97 #endif /* _PYLDB_H_ */