X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=include%2Flber.h;h=64664fbccadbde9ef872074a84db98169972b928;hb=dc07e765f263ef459dcd2afd1ece01cfc85a0edd;hp=c82a8c7614c1e8533bacfe8e7b5f1bbcb9fe1966;hpb=d7079a10c38e1e64d5ceded11a6e284da8c78617;p=openldap

diff --git a/include/lber.h b/include/lber.h
index c82a8c7614..64664fbcca 100644
--- a/include/lber.h
+++ b/include/lber.h
@@ -26,20 +26,37 @@
 
 LDAP_BEGIN_DECL
 
+/* Overview of LBER tag construction
+ *
+ *	Bits
+ *	______
+ *	8 7 | CLASS
+ *	0 0 = UNIVERSAL
+ *	0 1 = APPLICATION
+ *	1 0 = CONTEXT-SPECIFIC
+ *	1 1 = PRIVATE
+ *		_____
+ *		| 6 | DATA-TYPE
+ *		  0 = PRIMITIVE
+ *		  1 = CONSTRUCTED
+ *			___________
+ *			| 5 ... 1 | TAG-NUMBER
+ */
+
 /* BER classes and mask */
-#define LBER_CLASS_UNIVERSAL	0x00
-#define LBER_CLASS_APPLICATION	0x40
-#define LBER_CLASS_CONTEXT	0x80
-#define LBER_CLASS_PRIVATE	0xc0
-#define LBER_CLASS_MASK		0xc0
+#define LBER_CLASS_UNIVERSAL	0x00UL
+#define LBER_CLASS_APPLICATION	0x40UL
+#define LBER_CLASS_CONTEXT	0x80UL
+#define LBER_CLASS_PRIVATE	0xc0UL
+#define LBER_CLASS_MASK		0xc0UL
 
 /* BER encoding type and mask */
-#define LBER_PRIMITIVE		0x00
-#define LBER_CONSTRUCTED	0x20
-#define LBER_ENCODING_MASK	0x20
+#define LBER_PRIMITIVE		0x00UL
+#define LBER_CONSTRUCTED	0x20UL
+#define LBER_ENCODING_MASK	0x20UL
 
-#define LBER_BIG_TAG_MASK	0x1f
-#define LBER_MORE_TAG_MASK	0x80
+#define LBER_BIG_TAG_MASK	0x1fUL
+#define LBER_MORE_TAG_MASK	0x80UL
 
 /*
  * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
@@ -47,24 +64,26 @@ LDAP_BEGIN_DECL
  * fact, any tag for which the following is true is invalid:
  *     (( tag & 0x00000080 ) != 0 ) && (( tag & 0xFFFFFF00 ) != 0 )
  */
-#define LBER_ERROR		0xffffffffL
-#define LBER_DEFAULT		0xffffffffL
-/* #define LBER_END_SEQORSET	0xfffffffeL *//* no part of LDAP C-API */
+#define LBER_INVALID(tag) ( ( (tag) & 0xFFFFFF80UL ) != 0 )
+#define LBER_ERROR		0xffffffffUL
+#define LBER_DEFAULT		0xffffffffUL
+/* #define LBER_END_SEQORSET	0xfffffffeUL *//* no part of LDAP C-API */
 
 /* general BER types we know about */
-#define LBER_BOOLEAN		0x01L
-#define LBER_INTEGER		0x02L
-#define LBER_BITSTRING		0x03L
-#define LBER_OCTETSTRING	0x04L
-#define LBER_NULL		0x05L
-#define LBER_ENUMERATED		0x0aL
-#define LBER_SEQUENCE		0x30L	/* constructed */
-#define LBER_SET		0x31L	/* constructed */
-
-#define OLD_LBER_SEQUENCE	0x10L	/* w/o constructed bit - broken */
-#define OLD_LBER_SET		0x11L	/* w/o constructed bit - broken */
-
-typedef int (*BERTranslateProc) LDAP_P(( char **bufp,
+#define LBER_BOOLEAN		0x01UL
+#define LBER_INTEGER		0x02UL
+#define LBER_BITSTRING		0x03UL
+#define LBER_OCTETSTRING	0x04UL
+#define LBER_NULL		0x05UL
+#define LBER_ENUMERATED		0x0aUL
+#define LBER_SEQUENCE		0x30UL	/* constructed */
+#define LBER_SET		0x31UL	/* constructed */
+
+#define OLD_LBER_SEQUENCE	0x10UL	/* w/o constructed bit - broken */
+#define OLD_LBER_SET		0x11UL	/* w/o constructed bit - broken */
+
+typedef int (*BERTranslateProc) LDAP_P((
+	char **bufp,
 	unsigned long *buflenp,
 	int free_input ));
 
@@ -101,113 +120,311 @@ typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
 #define LBER_OPT_ERROR		(-1)
 
 typedef struct berelement BerElement;
-#define NULLBER	((BerElement *) 0)
-
 typedef struct sockbuf Sockbuf;
-
 typedef struct seqorset Seqorset;
-#define NULLSEQORSET ((Seqorset *) 0)
 
 /* structure for returning a sequence of octet strings + length */
-struct berval {
+typedef struct berval {
 	unsigned long	bv_len;
 	char		*bv_val;
-};
+} BerValue;
 
 /*
  * in bprint.c:
  */
-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_print_error LDAP_P((
+	LDAP_CONST char *data ));
 
-LDAP_F void ber_dump LDAP_P(( BerElement *ber, int inout ));
-LDAP_F void ber_sos_dump LDAP_P(( Seqorset *sos ));
+LDAP_F( void )
+ber_bprint LDAP_P((
+	LDAP_CONST char *data, int len ));
+
+LDAP_F( void )
+ber_dump LDAP_P((
+	LDAP_CONST BerElement *ber, int inout ));
+
+LDAP_F( void )
+ber_sos_dump LDAP_P((
+	LDAP_CONST Seqorset *sos ));
 
 
 /*
  * 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,
+typedef int (*BERDecodeCallback) LDAP_P((
+	BerElement *ber,
+	void *data,
+	int mode ));
+
+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((
+	LDAP_CONST BerElement *ber,	/* not const in c-api-02 */
 	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,
+
+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_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,
+
+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,
+
+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 ));
+
+LDAP_F( unsigned long )
+ber_scanf LDAP_P((								  
+	BerElement *ber,
+	LDAP_CONST 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((
+	LDAP_CONST struct berval *bv ));
+
+LDAP_F( void )
+ber_set_string_translators LDAP_P((
+	BerElement *ber,
+	BERTranslateProc encode_proc,
+	BERTranslateProc decode_proc ));
 
 /*
  * in encode.c
  */
-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,
+typedef int (*BEREncodeCallback) LDAP_P((
+	BerElement *ber,
+	void *data ));
+
+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,
+	LDAP_CONST char *str,
+	unsigned long len,
+	unsigned long tag ));
+
+LDAP_F( int )
+ber_put_berval LDAP_P((
+	BerElement *ber,
+	LDAP_CONST struct berval *bv,
 	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,
+
+LDAP_F( int )
+ber_put_string LDAP_P((
+	BerElement *ber,
+	LDAP_CONST char *str,
 	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, ... ));
+
+LDAP_F( int )
+ber_put_bitstring LDAP_P((
+	BerElement *ber,
+	LDAP_CONST 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,
+	LDAP_CONST 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,
+LDAP_F( long )
+ber_read LDAP_P((
+	BerElement *ber,
+	char *buf,
+	unsigned long len ));
+
+LDAP_F( long )
+ber_write LDAP_P((
+	BerElement *ber,
+	LDAP_CONST char *buf,
+	unsigned long len,
 	int nosos ));
-LDAP_F void ber_free 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,
+
+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 )); /* DEPRECATED */
+
+LDAP_F( BerElement * )
+der_alloc LDAP_P(( void )); /* DEPRECATED */
+
+LDAP_F( BerElement * )
+ber_alloc_t LDAP_P((
+	int options ));
+
+LDAP_F( BerElement * )
+ber_dup LDAP_P((
+	LDAP_CONST 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 ));
+
+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 ));
+LDAP_F( BerElement * )
+ber_init LDAP_P((
+	struct berval *bv ));
+
+LDAP_F( int )
+ber_flatten LDAP_P((
+	LDAP_CONST 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));
+LDAP_F( int )
+ber_get_option LDAP_P((
+	void *item,
+	int option,
+	void *outvalue));
+
+LDAP_F( int )
+ber_set_option LDAP_P((
+	void *item,
+	int option,
+	LDAP_CONST void *invalue));
 
 /*
- * LBER Sockbuf functions
+ * LBER sockbuf.c
  */
-LDAP_F Sockbuf *lber_sockbuf_alloc LDAP_P((void));
-LDAP_F Sockbuf *lber_sockbuf_alloc_fd LDAP_P((int fd));
-LDAP_F void lber_sockbuf_free LDAP_P((Sockbuf *sb));
+
+LDAP_F( Sockbuf * )
+ber_sockbuf_alloc( void );
+
+LDAP_F( Sockbuf *  )
+ber_sockbuf_alloc_fd(
+	int fd );
+
+LDAP_F( void )
+ber_sockbuf_free(
+	Sockbuf *sb );
+
 
 LDAP_END_DECL