]> git.sur5r.net Git - openldap/blobdiff - include/lber.h
Fix "configurations".
[openldap] / include / lber.h
index fa3e94855e37cfd748116dd36791f7b731560b10..bf939f90b31a44449621c6106830f797745cb657 100644 (file)
@@ -1,4 +1,13 @@
 /*
+ * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms are permitted only
+ * as authorized by the OpenLDAP Public License.  A copy of this
+ * license is available at http://www.OpenLDAP.org/license.html or
+ * in file LICENSE in the top-level directory of the distribution.
+ */
+/* Portions
  * Copyright (c) 1990 Regents of the University of Michigan.
  * All rights reserved.
  *
 #ifndef _LBER_H
 #define _LBER_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
+#include <ldap_cdefs.h>
 
-#if !defined( NEEDPROTOS ) && defined(__STDC__)
-#define NEEDPROTOS     1
-#endif
+LDAP_BEGIN_DECL
 
 /* BER classes and mask */
 #define LBER_CLASS_UNIVERSAL   0x00
@@ -44,6 +49,7 @@ extern "C" {
  */
 #define LBER_ERROR             0xffffffffL
 #define LBER_DEFAULT           0xffffffffL
+/* #define LBER_END_SEQORSET   0xfffffffeL *//* no part of LDAP C-API */
 
 /* general BER types we know about */
 #define LBER_BOOLEAN           0x01L
@@ -58,64 +64,49 @@ extern "C" {
 #define OLD_LBER_SEQUENCE      0x10L   /* w/o constructed bit - broken */
 #define OLD_LBER_SET           0x11L   /* w/o constructed bit - broken */
 
-#ifdef NEEDPROTOS
-typedef int (*BERTranslateProc)( char **bufp, unsigned long *buflenp,
-       int free_input );
-#else /* NEEDPROTOS */
-typedef int (*BERTranslateProc)();
-#endif /* NEEDPROTOS */
-
-typedef struct berelement {
-       char            *ber_buf;
-       char            *ber_ptr;
-       char            *ber_end;
-       struct seqorset *ber_sos;
-       unsigned long   ber_tag;
-       unsigned long   ber_len;
-       int             ber_usertag;
-       char            ber_options;
+typedef int (*BERTranslateProc) LDAP_P(( char **bufp,
+       unsigned long *buflenp,
+       int free_input ));
+
+/* LBER BerElement options */
 #define LBER_USE_DER           0x01
 #define LBER_USE_INDEFINITE_LEN        0x02
 #define LBER_TRANSLATE_STRINGS 0x04
-       char            *ber_rwptr;
-       BERTranslateProc ber_encode_translate_proc;
-       BERTranslateProc ber_decode_translate_proc;
-} BerElement;
+
+/* get/set options for BerElement */
+#define LBER_OPT_BER_OPTIONS   0x01
+#define LBER_OPT_BER_DEBUG             0x02
+
+#define LBER_OPT_DEBUG_LEVEL   LBER_OPT_BER_DEBUG
+#define LBER_OPT_LOG_PRINT_FN  0x8001
+
+typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
+
+/* LBER Sockbuf options */ 
+#define LBER_TO_FILE           0x01    /* to a file referenced by sb_fd   */
+#define LBER_TO_FILE_ONLY      0x02    /* only write to file, not network */
+#define LBER_MAX_INCOMING_SIZE 0x04    /* impose limit on incoming stuff  */
+#define LBER_NO_READ_AHEAD     0x08    /* read only as much as requested  */
+
+/* get/set options for Sockbuf */
+#define LBER_OPT_SOCKBUF_DESC          0x1000
+#define LBER_OPT_SOCKBUF_OPTIONS       0x1001
+#define LBER_OPT_SOCKBUF_DEBUG         0x1002
+
+/* on/off values */
+#define LBER_OPT_ON            ((void *) 1)
+#define LBER_OPT_OFF   ((void *) 0)
+
+#define LBER_OPT_SUCCESS       0
+#define LBER_OPT_ERROR         (-1)
+
+typedef struct berelement BerElement;
 #define NULLBER        ((BerElement *) 0)
 
-typedef struct sockbuf {
-#ifndef MACOS
-       int             sb_sd;
-#else /* MACOS */
-       void            *sb_sd;
-#endif /* MACOS */
-       BerElement      sb_ber;
-
-       int             sb_naddr;       /* > 0 implies using CLDAP (UDP) */
-       void            *sb_useaddr;    /* pointer to sockaddr to use next */
-       void            *sb_fromaddr;   /* pointer to message source sockaddr */
-       void            **sb_addrs;     /* actually an array of pointers to
-                                               sockaddrs */
-
-       int             sb_options;     /* to support copying ber elements */
-#define LBER_TO_FILE           0x01    /* to a file referenced by sb_fd   */
-#define LBER_TO_FILE_ONLY      0x02    /* only write to file, not network */
-#define LBER_MAX_INCOMING_SIZE 0x04    /* impose limit on incoming stuff  */
-#define LBER_NO_READ_AHEAD     0x08    /* read only as much as requested  */
-       int             sb_fd;
-       long            sb_max_incoming;
-} Sockbuf;
-#define READBUFSIZ     8192
-
-typedef struct seqorset {
-       BerElement      *sos_ber;
-       unsigned long   sos_clen;
-       unsigned long   sos_tag;
-       char            *sos_first;
-       char            *sos_ptr;
-       struct seqorset *sos_next;
-} Seqorset;
-#define NULLSEQORSET   ((Seqorset *) 0)
+typedef struct sockbuf Sockbuf;
+
+typedef struct seqorset Seqorset;
+#define NULLSEQORSET ((Seqorset *) 0)
 
 /* structure for returning a sequence of octet strings + length */
 struct berval {
@@ -123,62 +114,102 @@ struct berval {
        char            *bv_val;
 };
 
-#ifndef NEEDPROTOS
-extern BerElement *ber_alloc();
-extern BerElement *der_alloc();
-extern BerElement *ber_alloc_t();
-extern BerElement *ber_dup();
-extern int lber_debug;
-extern void ber_bvfree();
-extern void ber_bvecfree();
-extern struct berval *ber_bvdup();
-extern void ber_dump();
-extern void ber_sos_dump();
-extern void lber_bprint();
-extern void ber_reset();
-extern void ber_init();
-#else /* NEEDPROTOS */
-#if defined(WINSOCK)
-#include "proto-lb.h"
-#else
-#include "proto-lber.h"
-#endif
-#endif /* NEEDPROTOS */
-
-#if !defined(__alpha) || defined(VMS)
-
-#define LBER_HTONL( l )        htonl( l )
-#define LBER_NTOHL( l )        ntohl( l )
-
-#else /* __alpha */
 /*
- * htonl and ntohl on the DEC Alpha under OSF 1 seem to only swap the
- * lower-order 32-bits of a (64-bit) long, so we define correct versions
- * here.
+ * in bprint.c:
  */
-#define LBER_HTONL( l )        (((long)htonl( (l) & 0x00000000FFFFFFFF )) << 32 \
-                       | htonl( ( (l) & 0xFFFFFFFF00000000 ) >> 32 ))
+LDAP_F void ber_print_error LDAP_P(( char *data ));
+LDAP_F void ber_bprint LDAP_P(( char *data, int len ));
+#define lber_bprint(d,l)       ber_bprint((d),(l))
+
+LDAP_F void ber_dump LDAP_P(( BerElement *ber, int inout ));
+LDAP_F void ber_sos_dump LDAP_P(( Seqorset *sos ));
 
-#define LBER_NTOHL( l )        (((long)ntohl( (l) & 0x00000000FFFFFFFF )) << 32 \
-                       | ntohl( ( (l) & 0xFFFFFFFF00000000 ) >> 32 ))
-#endif /* __alpha */
 
+/*
+ * in decode.c:
+ */
+LDAP_F unsigned long ber_get_tag LDAP_P(( BerElement *ber ));
+LDAP_F unsigned long ber_skip_tag LDAP_P(( BerElement *ber, unsigned long *len ));
+LDAP_F unsigned long ber_peek_tag LDAP_P(( BerElement *ber, unsigned long *len ));
+LDAP_F unsigned long ber_get_int LDAP_P(( BerElement *ber, long *num ));
+LDAP_F unsigned long ber_get_stringb LDAP_P(( BerElement *ber, char *buf,
+       unsigned long *len ));
+LDAP_F unsigned long ber_get_stringa LDAP_P(( BerElement *ber, char **buf ));
+LDAP_F unsigned long ber_get_stringal LDAP_P(( BerElement *ber, struct berval **bv ));
+LDAP_F unsigned long ber_get_bitstringa LDAP_P(( BerElement *ber, char **buf,
+       unsigned long *len ));
+LDAP_F unsigned long ber_get_null LDAP_P(( BerElement *ber ));
+LDAP_F unsigned long ber_get_boolean LDAP_P(( BerElement *ber, int *boolval ));
+LDAP_F unsigned long ber_first_element LDAP_P(( BerElement *ber, unsigned long *len,
+       char **last ));
+LDAP_F unsigned long ber_next_element LDAP_P(( BerElement *ber, unsigned long *len,
+       char *last ));
+LDAP_F unsigned long ber_scanf LDAP_P(( BerElement *ber, char *fmt, ... ));
+LDAP_F void ber_bvfree LDAP_P(( struct berval *bv ));
+LDAP_F void ber_bvecfree LDAP_P(( struct berval **bv ));
+LDAP_F struct berval *ber_bvdup LDAP_P(( struct berval *bv ));
+LDAP_F void ber_set_string_translators LDAP_P(( BerElement *ber,
+       BERTranslateProc encode_proc, BERTranslateProc decode_proc ));
 
 /*
- * SAFEMEMCPY is an overlap-safe copy from s to d of n bytes
+ * in encode.c
  */
-#ifdef MACOS
-#define SAFEMEMCPY( d, s, n )  BlockMoveData( (Ptr)(s), (Ptr)(d), (n) )
-#else /* MACOS */
-#ifdef sunos4
-#define SAFEMEMCPY( d, s, n )  bcopy( (s), (d), (n) )
-#else /* sunos4 */
-#define SAFEMEMCPY( d, s, n )  memmove( (d), (s), (n) )
-#endif /* sunos4 */
-#endif /* MACOS */
-
-
-#ifdef __cplusplus
-}
-#endif
+LDAP_F int ber_put_enum LDAP_P(( BerElement *ber, long num, unsigned long tag ));
+LDAP_F int ber_put_int LDAP_P(( BerElement *ber, long num, unsigned long tag ));
+LDAP_F int ber_put_ostring LDAP_P(( BerElement *ber, char *str, unsigned long len,
+       unsigned long tag ));
+LDAP_F int ber_put_string LDAP_P(( BerElement *ber, char *str, unsigned long tag ));
+LDAP_F int ber_put_bitstring LDAP_P(( BerElement *ber, char *str,
+       unsigned long bitlen, unsigned long tag ));
+LDAP_F int ber_put_null LDAP_P(( BerElement *ber, unsigned long tag ));
+LDAP_F int ber_put_boolean LDAP_P(( BerElement *ber, int boolval,
+       unsigned long tag ));
+LDAP_F int ber_start_seq LDAP_P(( BerElement *ber, unsigned long tag ));
+LDAP_F int ber_start_set LDAP_P(( BerElement *ber, unsigned long tag ));
+LDAP_F int ber_put_seq LDAP_P(( BerElement *ber ));
+LDAP_F int ber_put_set LDAP_P(( BerElement *ber ));
+LDAP_F int ber_printf LDAP_P(( BerElement *ber, char *fmt, ... ));
+/*
+ * in io.c:
+ */
+
+LDAP_F long ber_read LDAP_P(( BerElement *ber, char *buf, unsigned long len ));
+LDAP_F long ber_write LDAP_P(( BerElement *ber, char *buf, unsigned long len,
+       int nosos ));
+LDAP_F void ber_free LDAP_P(( BerElement *ber, int freebuf ));
+LDAP_F void ber_clear LDAP_P(( BerElement *ber, int freebuf ));
+LDAP_F int ber_flush LDAP_P(( Sockbuf *sb, BerElement *ber, int freeit ));
+LDAP_F BerElement *ber_alloc LDAP_P(( void ));
+LDAP_F BerElement *der_alloc LDAP_P(( void ));
+LDAP_F BerElement *ber_alloc_t LDAP_P(( int options ));
+LDAP_F BerElement *ber_dup LDAP_P(( BerElement *ber ));
+LDAP_F unsigned long ber_get_next LDAP_P(( Sockbuf *sb, unsigned long *len,
+       BerElement *ber ));
+LDAP_F void ber_init_w_nullc LDAP_P(( BerElement *ber, int options ));
+LDAP_F void ber_reset LDAP_P(( BerElement *ber, int was_writing ));
+
+/*
+ * LBER draft-ietf-ldapext-ldap-c-api-01 routines
+ */
+LDAP_F BerElement *ber_init LDAP_P(( struct berval *bv ));
+LDAP_F int ber_flatten LDAP_P(( BerElement *ber, struct berval **bvPtr ));
+
+/*
+ * LBER ber accessor functions
+ */
+LDAP_F int
+lber_get_option LDAP_P((void *item, int option, void *outvalue));
+
+LDAP_F int
+lber_set_option LDAP_P((void *item, int option, void *invalue));
+
+/*
+ * LBER Sockbuf functions
+ */
+LDAP_F Sockbuf *lber_pvt_sk_alloc LDAP_P((void));
+LDAP_F Sockbuf *lber_pvt_sb_alloc_fd LDAP_P((int fd));
+LDAP_F void lber_pvt_sb_free LDAP_P((Sockbuf *sb));
+
+LDAP_END_DECL
+
 #endif /* _LBER_H */