]> git.sur5r.net Git - openldap/blobdiff - include/lber.h
Update copyright
[openldap] / include / lber.h
index 02a93cf5aad2289dd85b4dbe6f15e8e340f394e1..64ecb23e18a77d658d5f31c66722b8a10563243a 100644 (file)
@@ -1,6 +1,6 @@
 /* $OpenLDAP$ */
 /*
- * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
+ * Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms are permitted only
 #ifndef _LBER_H
 #define _LBER_H
 
-#include <ldap_cdefs.h>
 #include <lber_types.h>
 
 LDAP_BEGIN_DECL
 
-/* booleans, enumerations, and integers */
-typedef LBER_INT_T ber_int_t;
-
-/* signed and unsigned versions */
-typedef signed LBER_INT_T ber_sint_t;
-typedef unsigned LBER_INT_T ber_uint_t;
-
-/* tags */
-typedef unsigned LBER_TAG_T ber_tag_t;
-
-/* "socket" descriptors */
-typedef LBER_SOCKET_T ber_socket_t;
-
-/* lengths */
-typedef unsigned LBER_LEN_T ber_len_t;
-
-/* signed lengths */
-typedef signed LBER_LEN_T ber_slen_t;
-
-
 /* Overview of LBER tag construction
  *
  *     Bits
@@ -85,7 +64,7 @@ typedef signed LBER_LEN_T ber_slen_t;
  * as valid BER tags, and so it is safe to use them to report errors.  In
  * fact, any tag for which the following is true is invalid:
  */
-#define LBER_INVALID(t)     (((t) & (ber_tag_t) 0x080) \
+#define LBER_INVALID(t)     (((t) & (ber_tag_t) 0x080UL) \
        && (((t) & (ber_tag_t) ~ 0x0FF))
 
 #define LBER_ERROR                     ((ber_tag_t) -1)
@@ -101,15 +80,8 @@ typedef signed LBER_LEN_T ber_slen_t;
 #define LBER_SEQUENCE          ((ber_tag_t) 0x30UL)    /* constructed */
 #define LBER_SET                       ((ber_tag_t) 0x31UL)    /* constructed */
 
-typedef int (*BERTranslateProc) LDAP_P((
-       char **bufp,
-       ber_len_t *buflenp,
-       int free_input ));
-
 /* LBER BerElement options */
 #define LBER_USE_DER           0x01
-#define LBER_USE_INDEFINITE_LEN        0x02
-#define LBER_TRANSLATE_STRINGS 0x04
 
 /* get/set options for BerElement */
 #define LBER_OPT_BER_OPTIONS                   0x01
@@ -126,10 +98,15 @@ typedef int (*BERTranslateProc) LDAP_P((
 #define LBER_OPT_LOG_PRINT_FN  0x8001
 #define LBER_OPT_MEMORY_FNS            0x8002
 #define LBER_OPT_ERROR_FN              0x8003
+#define LBER_OPT_LOG_PRINT_FILE                0x8004
+
+/* get/set Memory Debug options */
+#define LBER_OPT_MEMORY_INUSE          0x8005  /* for memory debugging */
+#define LBER_OPT_LOG_PROC           0x8006  /* for external logging function */
 
 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
 
-typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
+typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
 
 typedef void* (*BER_MEMALLOC_FN)       LDAP_P(( ber_len_t size ));
 typedef void* (*BER_MEMCALLOC_FN)      LDAP_P(( ber_len_t n, ber_len_t size ));
@@ -143,11 +120,26 @@ typedef struct lber_memory_fns {
        BER_MEMFREE_FN bmf_free;
 } BerMemoryFunctions;
 
-/* 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  */
+/* LBER Sockbuf_IO options */ 
+#define LBER_SB_OPT_GET_FD             1
+#define LBER_SB_OPT_SET_FD             2
+#define LBER_SB_OPT_HAS_IO             3
+#define LBER_SB_OPT_SET_NONBLOCK       4
+#define LBER_SB_OPT_GET_SSL            7
+#define LBER_SB_OPT_DATA_READY         8
+#define LBER_SB_OPT_SET_READAHEAD      9
+#define LBER_SB_OPT_DRAIN              10
+#define LBER_SB_OPT_NEEDS_READ         11
+#define LBER_SB_OPT_NEEDS_WRITE                12
+#define LBER_SB_OPT_GET_MAX_INCOMING 13
+#define LBER_SB_OPT_SET_MAX_INCOMING 14
+/* Largest option used by the library */
+#define LBER_SB_OPT_OPT_MAX            14
+
+/* LBER IO operations stacking levels */
+#define LBER_SBIOD_LEVEL_PROVIDER      10
+#define LBER_SBIOD_LEVEL_TRANSPORT     20
+#define LBER_SBIOD_LEVEL_APPLICATION   30
 
 /* get/set options for Sockbuf */
 #define LBER_OPT_SOCKBUF_DESC          0x1000
@@ -165,6 +157,43 @@ typedef struct berelement BerElement;
 typedef struct sockbuf Sockbuf;
 typedef struct seqorset Seqorset;
 
+typedef struct sockbuf_io Sockbuf_IO;
+
+/* Structure for LBER IO operarion descriptor */
+typedef struct sockbuf_io_desc {
+       int                     sbiod_level;
+       Sockbuf                 *sbiod_sb;
+       Sockbuf_IO              *sbiod_io;
+       void                    *sbiod_pvt;
+       struct sockbuf_io_desc  *sbiod_next;
+} Sockbuf_IO_Desc;
+
+/* Structure for LBER IO operation functions */
+struct sockbuf_io {
+       int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
+       int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
+       int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
+       
+       ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
+               ber_len_t len );
+       ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
+               ber_len_t len );
+       
+       int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
+};
+
+/* Helper macros for LBER IO functions */
+#define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
+       ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
+               buf, len ) )
+#define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
+       ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
+               buf, len ) )
+#define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
+       ( (sbiod)->sbiod_next ? \
+               ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
+               (sbiod)->sbiod_next, opt, arg ) ) : 0 )
+
 /* structure for returning a sequence of octet strings + length */
 typedef struct berval {
        ber_len_t       bv_len;
@@ -172,35 +201,26 @@ typedef struct berval {
 } BerValue;
 
 /* this should be moved to lber-int.h */
-#ifdef __MINGW32__
-#   undef LDAP_F_PRE
-#   ifdef LIBLBER_DECL
-#      define LDAP_F_PRE       extern __declspec(LIBLBER_DECL)
-#   else
-#      define LDAP_F_PRE       extern
-#   endif
-#endif
 
 /*
  * in bprint.c:
  */
-LDAP_F( void )
-ber_print_error LDAP_P((
+LBER_F( void )
+ber_error_print LDAP_P((
        LDAP_CONST char *data ));
 
-LDAP_F( void )
+LBER_F( void )
 ber_bprint LDAP_P((
        LDAP_CONST char *data, ber_len_t len ));
 
-LDAP_F( void )
+LBER_F( void )
 ber_dump LDAP_P((
        BerElement *ber, int inout ));
 
-LDAP_F( void )
+LBER_F( void )
 ber_sos_dump LDAP_P((
        Seqorset *sos ));
 
-
 /*
  * in decode.c:
  */
@@ -209,80 +229,79 @@ typedef int (*BERDecodeCallback) LDAP_P((
        void *data,
        int mode ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_get_tag LDAP_P((
        BerElement *ber ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_skip_tag LDAP_P((
        BerElement *ber,
        ber_len_t *len ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_peek_tag LDAP_P((
        BerElement *ber,
        ber_len_t *len ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_get_int LDAP_P((
        BerElement *ber,
        ber_int_t *num ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
+ber_get_enum LDAP_P((
+       BerElement *ber,
+       ber_int_t *num ));
+
+LBER_F( ber_tag_t )
 ber_get_stringb LDAP_P((
        BerElement *ber,
        char *buf,
        ber_len_t *len ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_get_stringa LDAP_P((
        BerElement *ber,
        char **buf ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_get_stringal LDAP_P((
        BerElement *ber,
        struct berval **bv ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_get_bitstringa LDAP_P((
        BerElement *ber,
        char **buf,
        ber_len_t *len ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_get_null LDAP_P((
        BerElement *ber ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_get_boolean LDAP_P((
        BerElement *ber,
        ber_int_t *boolval ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_first_element LDAP_P((
        BerElement *ber,
        ber_len_t *len,
        char **last ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_next_element LDAP_P((
        BerElement *ber,
        ber_len_t *len,
        LDAP_CONST char *last ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_scanf LDAP_P((                                                               
        BerElement *ber,
        LDAP_CONST char *fmt,
        ... ));
 
-LDAP_F( void )
-ber_set_string_translators LDAP_P((
-       BerElement *ber,
-       BERTranslateProc encode_proc,
-       BERTranslateProc decode_proc ));
-
 /*
  * in encode.c
  */
@@ -290,74 +309,74 @@ typedef int (*BEREncodeCallback) LDAP_P((
        BerElement *ber,
        void *data ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_enum LDAP_P((
        BerElement *ber,
        ber_int_t num,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_int LDAP_P((
        BerElement *ber,
        ber_int_t num,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_ostring LDAP_P((
        BerElement *ber,
        LDAP_CONST char *str,
        ber_len_t len,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_berval LDAP_P((
        BerElement *ber,
        LDAP_CONST struct berval *bv,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_string LDAP_P((
        BerElement *ber,
        LDAP_CONST char *str,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_bitstring LDAP_P((
        BerElement *ber,
        LDAP_CONST char *str,
        ber_len_t bitlen,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_null LDAP_P((
        BerElement *ber,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_boolean LDAP_P((
        BerElement *ber,
        ber_int_t boolval,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_start_seq LDAP_P((
        BerElement *ber,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_start_set LDAP_P((
        BerElement *ber,
        ber_tag_t tag ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_seq LDAP_P((
        BerElement *ber ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_put_set LDAP_P((
        BerElement *ber ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_printf LDAP_P((
        BerElement *ber,
        LDAP_CONST char *fmt,
@@ -368,65 +387,65 @@ ber_printf LDAP_P((
  * in io.c:
  */
 
-LDAP_F( ber_slen_t )
+LBER_F( ber_slen_t )
 ber_read LDAP_P((
        BerElement *ber,
        char *buf,
        ber_len_t len ));
 
-LDAP_F( ber_slen_t )
+LBER_F( ber_slen_t )
 ber_write LDAP_P((
        BerElement *ber,
        LDAP_CONST char *buf,
        ber_len_t len,
        int nosos ));
 
-LDAP_F( void )
+LBER_F( void )
 ber_free LDAP_P((
        BerElement *ber,
        int freebuf ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_flush LDAP_P((
        Sockbuf *sb,
        BerElement *ber,
        int freeit ));
 
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
 ber_alloc LDAP_P(( void )); /* DEPRECATED */
 
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
 der_alloc LDAP_P(( void )); /* DEPRECATED */
 
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
 ber_alloc_t LDAP_P((
        int beroptions ));
 
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
 ber_dup LDAP_P((
        BerElement *ber ));
 
-LDAP_F( ber_tag_t )
+LBER_F( ber_tag_t )
 ber_get_next LDAP_P((
        Sockbuf *sb,
        ber_len_t *len,
        BerElement *ber ));
 
-LDAP_F( void )
-ber_init_w_nullc LDAP_P((
+LBER_F( void )
+ber_init_w_nullc LDAP_P((      /* DEPRECATED */
        BerElement *ber,
        int options ));
 
-LDAP_F( void )
+LBER_F( void )
 ber_reset LDAP_P((
        BerElement *ber,
        int was_writing ));
 
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
 ber_init LDAP_P((
        struct berval *bv ));
 
-LDAP_F( int )
+LBER_F( int )
 ber_flatten LDAP_P((
        BerElement *ber,
        struct berval **bvPtr ));
@@ -435,13 +454,13 @@ ber_flatten LDAP_P((
  * LBER ber accessor functions
  */
 
-LDAP_F( int )
+LBER_F( int )
 ber_get_option LDAP_P((
        void *item,
        int option,
        void *outvalue));
 
-LDAP_F( int )
+LBER_F( int )
 ber_set_option LDAP_P((
        void *item,
        int option,
@@ -451,62 +470,96 @@ ber_set_option LDAP_P((
  * LBER sockbuf.c
  */
 
-LDAP_F( Sockbuf * )
-ber_sockbuf_alloc( void );
+LBER_F( Sockbuf *  )
+ber_sockbuf_alloc LDAP_P((
+       void ));
+
+LBER_F( void )
+ber_sockbuf_free LDAP_P((
+       Sockbuf *sb ));
+
+LBER_F( int )
+ber_sockbuf_add_io LDAP_P((
+       Sockbuf *sb,
+       Sockbuf_IO *sbio,
+       int layer,
+       void *arg ));
+
+LBER_F( int )
+ber_sockbuf_remove_io LDAP_P((
+       Sockbuf *sb,
+       Sockbuf_IO *sbio,
+       int layer ));
 
-LDAP_F( Sockbuf *  )
-ber_sockbuf_alloc_fd(
-       ber_socket_t fd );
+LBER_F( int )
+ber_sockbuf_ctrl LDAP_P((
+       Sockbuf *sb,
+       int opt,
+       void *arg ));
 
-LDAP_F( void )
-ber_sockbuf_free(
-       Sockbuf *sb );
+LBER_F( Sockbuf_IO ) ber_sockbuf_io_tcp;
+LBER_F( Sockbuf_IO ) ber_sockbuf_io_readahead;
+LBER_F( Sockbuf_IO ) ber_sockbuf_io_fd;
+LBER_F( Sockbuf_IO ) ber_sockbuf_io_debug;
 
 /*
  * LBER memory.c
  */
-LDAP_F( void * )
+LBER_F( void * )
 ber_memalloc LDAP_P((
        ber_len_t s ));
 
-LDAP_F( void * )
+LBER_F( void * )
 ber_memrealloc LDAP_P((
        void* p,
        ber_len_t s ));
 
-LDAP_F( void * )
+LBER_F( void * )
 ber_memcalloc LDAP_P((
        ber_len_t n,
        ber_len_t s ));
 
-LDAP_F( void )
+LBER_F( void )
 ber_memfree LDAP_P((
        void* p ));
 
-LDAP_F( void )
+LBER_F( void )
 ber_memvfree LDAP_P((
        void** vector ));
 
-LDAP_F( void )
+LBER_F( void )
 ber_bvfree LDAP_P((
        struct berval *bv ));
 
-LDAP_F( void )
+LBER_F( void )
 ber_bvecfree LDAP_P((
        struct berval **bv ));
 
-LDAP_F( struct berval * )
+LBER_F( int )
+ber_bvecadd LDAP_P((
+       struct berval ***bvec,
+       struct berval *bv ));
+
+LBER_F( struct berval * )
 ber_bvdup LDAP_P((
        LDAP_CONST struct berval *bv ));
 
-LDAP_F( char * )
+LBER_F( struct berval * )
+ber_bvstr LDAP_P((
+       LDAP_CONST char * ));
+
+LBER_F( struct berval * )
+ber_bvstrdup LDAP_P((
+       LDAP_CONST char * ));
+
+LBER_F( char * )
 ber_strdup LDAP_P((
        LDAP_CONST char * ));
 
 /*
  * error.c
  */
-LDAP_F( int * ) ber_errno_addr LDAP_P((void));
+LBER_F( int * ) ber_errno_addr LDAP_P((void));
 #define ber_errno (*(ber_errno_addr)())
 
 #define LBER_ERROR_NONE                0
@@ -515,4 +568,4 @@ LDAP_F( int * ) ber_errno_addr LDAP_P((void));
 
 LDAP_END_DECL
 
-#endif /* _LBER_H */
\ No newline at end of file
+#endif /* _LBER_H */