XEmacs 21.2-b1

[chise/xemacs-chise.git] / src / eldap.h

diff --git a/src/eldap.h b/src/eldap.h
new file mode 100644 (file)
index 0000000..fb0abbb
--- /dev/null
+++ b/src/eldap.h
@@ -0,0 +1,74 @@
+/* Definitions for the LDAP client interface for XEmacs.
+   Copyright (C) 1998 Free Software Foundation, Inc.
+
+This file is part of XEmacs.
+
+XEmacs is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2, or (at your option) any
+later version.
+
+XEmacs is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with XEmacs; see the file COPYING.  If not, write to
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.  */
+
+#ifndef _XEMACS_ELDAP_H_
+#define _XEMACS_ELDAP_H_
+
+#include <lber.h>
+#include <ldap.h>
+
+/*
+ * The following structure records pertinent information about a
+ * LDAP connection.
+ */
+
+struct Lisp_LDAP
+{
+  /* lcrecord header */
+  struct lcrecord_header header;
+  /* The LDAP connection handle used by the LDAP API */
+  LDAP *ld;
+  /* Name of the host we connected to */
+  Lisp_Object host;
+  /* Status of the LDAP connection.  */
+  int livep;
+};
+
+
+DECLARE_LRECORD (ldap, struct Lisp_LDAP);
+#define XLDAP(x) XRECORD (x, ldap, struct Lisp_LDAP)
+#define XSETLDAP(x, p) XSETRECORD (x, p, ldap)
+#define LDAPP(x) RECORDP (x, ldap)
+#define GC_LDAPP(x) GC_RECORDP (x, ldap)
+#define CHECK_LDAP(x) CHECK_RECORD (x, ldap)
+#define CONCHECK_LDAP(x) CONCHECK_RECORD (x, ldap)
+
+#define CHECK_LIVE_LDAP(ldap) do {                                     \
+  CHECK_LDAP (ldap);                                                   \
+  if (!XLDAP (ldap)->livep)                                            \
+    signal_simple_error ("Attempting to access closed LDAP connection",        \
+                         ldap);                                                \
+} while (0)
+
+
+Lisp_Object Fldapp (Lisp_Object object);
+Lisp_Object Fldap_host (Lisp_Object ldap);
+Lisp_Object Fldap_status (Lisp_Object ldap);
+Lisp_Object Fldap_open (Lisp_Object host,
+                        Lisp_Object ldap_plist);
+Lisp_Object Fldap_close (Lisp_Object ldap);
+Lisp_Object Fldap_search_internal (Lisp_Object ldap,
+                                   Lisp_Object filter,
+                                   Lisp_Object base,
+                                   Lisp_Object scope,
+                                   Lisp_Object attrs,
+                                   Lisp_Object attrsonly);
+
+#endif /* _XEMACS_ELDAP_H_ */