
/*
 * Copyright (c) 2001-2002 Packet Design, LLC.
 * All rights reserved.
 * 
 * Subject to the following obligations and disclaimer of warranty,
 * use and redistribution of this software, in source or object code
 * forms, with or without modifications are expressly permitted by
 * Packet Design; provided, however, that:
 * 
 *    (i)  Any and all reproductions of the source or object code
 *         must include the copyright notice above and the following
 *         disclaimer of warranties; and
 *    (ii) No rights are granted, in any manner or form, to use
 *         Packet Design trademarks, including the mark "PACKET DESIGN"
 *         on advertising, endorsements, or otherwise except as such
 *         appears in the above copyright notice or in the software.
 * 
 * THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
 * THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
 * OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
 * OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
 * OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
 * RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
 * LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
 * OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
 * DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
 * USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Author: Archie Cobbs <archie@freebsd.org>
 */

#ifndef _PDEL_STRUCTS_TYPE_DATA_H_
#define _PDEL_STRUCTS_TYPE_DATA_H_

/*********************************************************************
			BINARY DATA TYPE
*********************************************************************/

/*
 * The data is a "struct structs_data".
 *
 * The ASCII form is base-64 or hex encoded.
 */

__BEGIN_DECLS

extern structs_copy_t		structs_data_copy;
extern structs_equal_t		structs_data_equal;
extern structs_ascify_t		structs_data_ascify;
extern structs_binify_t		structs_data_binify;
extern structs_encode_t		structs_data_encode;
extern structs_decode_t		structs_data_decode;
extern structs_uninit_t		structs_data_free;

__END_DECLS

/*
 * Macro arguments:
 *	[const char *]		Encoding character set (or NULL for default
 *				  or empty string for hex encoding)
 *	[const char *]		Memory allocation type for byte buffer
 */
#define STRUCTS_DATA_TYPE(charset, mtype) {				\
	sizeof(struct structs_data),					\
	"data",								\
	STRUCTS_TYPE_PRIMITIVE,						\
	structs_region_init,						\
	structs_data_copy,						\
	structs_data_equal,						\
	structs_data_ascify,						\
	structs_data_binify,						\
	structs_data_encode,						\
	structs_data_decode,						\
	structs_data_free,						\
	{ { (void *)(charset) }, { (void *)(mtype) } }			\
}

#define STRUCTS_DATA_MEMTYPE	"structs_data"

__BEGIN_DECLS

/*
 * Built-in type using default charset and mem type STRUCTS_DATA_MEMTYPE.
 */
extern const struct structs_type	structs_type_data;

/*
 * Built-in type using hex ASCII encoding and mem type STRUCTS_DATA_MEMTYPE.
 */
extern const struct structs_type	structs_type_hexdata;

__END_DECLS

/*********************************************************************
		    FIXED LENGTH BINARY DATA TYPE
*********************************************************************/

__BEGIN_DECLS

/*
 * The data is a fixed length array of u_char.
 *
 * The ASCII form is (length * 2) hex digits.
 */
extern structs_ascify_t		structs_fixeddata_ascify;
extern structs_binify_t		structs_fixeddata_binify;
extern structs_encode_t		structs_fixeddata_encode;
extern structs_decode_t		structs_fixeddata_decode;

__END_DECLS

/*
 * Macro arguments:
 *	[int]		Length of array.
 */
#define STRUCTS_FIXEDDATA_TYPE(length) {				\
	(length),							\
	"fixeddata",							\
	STRUCTS_TYPE_PRIMITIVE,						\
	structs_region_init,						\
	structs_region_copy,						\
	structs_region_equal,						\
	structs_fixeddata_ascify,					\
	structs_fixeddata_binify,					\
	structs_fixeddata_encode,					\
	structs_fixeddata_decode,					\
	structs_nothing_free,						\
}

#endif	/* _PDEL_STRUCTS_TYPE_DATA_H_ */

