#ifndef _cdatyp_
#define _cdatyp_

/*
********************************************************************************
**
**  (c) Copyright 2004 Hewlett-Packard Development Company, L.P.
**
**  Proprietary computer software. Valid license from HP required for
**  possession, use or copying. Consistent with FAR 12.211 and 12.212,
**  Commercial Computer Software, Computer Software Documentation, and
**  Technical Data for Commercial Items are licensed to the U.S. Government
**  under vendor's standard commercial license.
**
**  ABSTRACT:
**      This file contains the type definitions for the CDA & DDIS routines.
**
**********************************************************************************
*/

/*
 * Translate __ predefined symbols to pre ANSI C style when not
 * compiling with an ANSI C conformant compiler.
 */
#include <cdatrans.h>


/*
 * The symbol CDAbig_endian is defined here for big endian platforms.
 * When compiling applications on big endian platforms not listed below,
 * the symbol CDAbig_endian must be defined on the compile command line.
 */
#if defined(sun) || defined(hpux)
#define CDAbig_endian
#endif

/*
 * The symbol CDAlocal_DAS is defined here for platforms on which we
 * use our "portable subset" of the DECimage Application Services (DAS)
 * code.  Defining CDAlocal_DAS causes the correct version of image
 * headers files to be used in those modules that have DAS dependencies. 
 */
#if defined(sun) || defined(hpux)
#define CDAlocal_DAS
#endif

/*
 * The symbol CDA64bit is defined here for platforms with 64-bit addresses.
 * When compiling applications on 64-bit platforms not listed below,
 * the symbol CDA64bit must be defined on the compile command line.
 */

/* verified for ia64 - Gerry Gladu */
#if defined(__unix__) && (defined(__alpha__) || defined(__alpha) || defined(__ia64))
#define CDA64bit
#endif


/*
 * The CDA_EXPAND_PROTO flag along with the PROTO macro allow for tailoring
 * routine declarations to expand to function prototypes or not depending
 * on the particular platform (compiler) capabilities.
 * If CDA_EXPAND_PROTO is defined, the PROTO macro will expand to function
 * prototypes.  If OS2 or msdos turn on flag as prototypes must be used
 * on these platforms.  For other platforms it is left to the application
 * to #define CDA_EXPAND_PROTO before #include of this file if function
 * prototyping is desired.
 */
#if defined(OS2) || defined(msdos) || defined(__vaxc__) || defined(__STDC__)
#ifndef CDA_EXPAND_PROTO
#define CDA_EXPAND_PROTO 1
#endif
#endif

/*
 * CDA keyword macros.
 */
#ifndef CDA_MACROS_DEFINED
#define CDA_MACROS_DEFINED
#if defined (OS2) || defined (RATIONAL) || defined (MSWINDOWS)
#define CDA_HUGE huge
#define CDA_FAR  far
#define CDA_APIENTRY far pascal
#define CDA_CALLBACK far pascal _loadds _export
#else
#if defined(msdos)
#define CDA_HUGE huge
#define CDA_FAR  far
#define CDA_APIENTRY far cdecl
#define CDA_CALLBACK far cdecl
#else
#define CDA_FAR
#define CDA_HUGE
#define CDA_APIENTRY
#define CDA_CALLBACK
#endif
#endif
#endif

/*
 * CDA defined types.
 */
#ifndef CDA_TYPES
#define CDA_TYPES

#if defined(CDA64bit)
typedef unsigned int	CDAstatus;	/* Return status code		 */
typedef long		CDAsize;	/* Size or position arg		 */
typedef int		CDAcount;	/* Count or length arg		 */
typedef unsigned short	CDAitemcode;	/* Itemlist item code		 */
typedef unsigned short	CDAitemlength;	/* Itemlist item length		 */
typedef unsigned char * CDAbufaddr;	/* Addr. array of unsigned bytes */
typedef void *		CDAaddress;	/* Generic address argument	 */
typedef int		CDAcardinal;	/* Integer arguments		 */
typedef unsigned int	CDAidnum;	/* Numeric identifier (row number, window id, etc.) */
typedef int		CDAboolean;	/* Boolean value		 */
typedef char 		CDAenvirontext;	/* Environment specific text	 */
					/* character			 */
typedef unsigned char	CDAoctet;	/* Unsigned 8-bit entity	 */
typedef int		CDAaggtype;	/* CDA aggregate type code	 */
typedef int		CDAconstant;	/* CDA enumerated constant	 */
typedef	int		CDAindex;	/* Array index			 */
typedef void *		CDAuserparam;	/* User supplied parameter       */
typedef unsigned int	CDAflags;	/* Flags/mask longword		 */
typedef unsigned int 	CDAlargebitfield; /* Bitfield type for fields > 8   */
typedef unsigned int 	CDAsmallbitfield; /* Bitfield type for fields <= 8
                                             when needed to avoid padding   */
typedef unsigned int	CDAuint32;	/* 32-bit unsigned */
typedef int		CDAmeasurement;
#endif

#if defined (__vms__) || ( defined(__unix__) && ! defined(CDA64bit) )
typedef unsigned long	CDAstatus;	/* Return status code		    */
typedef long		CDAsize;	/* Size, length, or position arg    */
typedef int		CDAcount;	/* Count or length arg		 */
typedef unsigned short	CDAitemcode;	/* Itemlist item code		    */
typedef unsigned short	CDAitemlength;	/* Itemlist item length		    */
typedef unsigned char CDA_HUGE * CDAbufaddr; /* Addr. array of unsigned bytes */
typedef void CDA_FAR *	CDAaddress;	/* Generic address argument	    */
typedef int		CDAcardinal;	/* Integer arguments		    */
typedef unsigned long	CDAidnum;	/* Numeric identifier (row number, window id, etc.) */
typedef int		CDAboolean;	/* Boolean value		    */
typedef char 		CDAenvirontext;	/* Environment specific text	    */
					/* character			    */
typedef unsigned char	CDAoctet;	/* Unsigned 8-bit entity	    */
typedef int		CDAaggtype;	/* CDA aggregate type code	    */
typedef long 		CDAconstant;	/* CDA enumerated constant	    */
typedef	int		CDAindex;	/* Array index			    */
typedef void CDA_FAR *	CDAuserparam;   /* User supplied parameter	    */
typedef unsigned long	CDAflags;	/* Flags/mask longword		    */
typedef unsigned int 	CDAlargebitfield; /* Bitfield type		    */
typedef unsigned int 	CDAsmallbitfield; /* Bitfield type for fields <= 8
					     when needed to avoid padding   */
typedef unsigned long	CDAuint32;	/* 32-bit unsigned */
typedef long		CDAmeasurement;
#endif

#if defined(OS2) || defined(msdos)
typedef unsigned long	CDAstatus;	/* Return status code		    */
typedef long		CDAsize;	/* Size, length, or position arg    */
typedef int		CDAcount;	/* Count or length arg		 */
typedef unsigned short	CDAitemcode;	/* Itemlist item code		    */
typedef unsigned short	CDAitemlength;	/* Itemlist item length		    */
typedef unsigned char CDA_HUGE * CDAbufaddr; /* Addr. array of unsigned bytes */
typedef void CDA_FAR *	CDAaddress;	/* Generic address argument	    */
typedef int		CDAcardinal;	/* Integer arguments		    */
typedef unsigned long	CDAidnum;	/* Numeric identifier (row number, window id, etc.) */
typedef char		CDAboolean;	/* Boolean value		    */
typedef char 		CDAenvirontext;	/* Environment specific text	    */
					/* character			    */
typedef unsigned char	CDAoctet;	/* Unsigned 8-bit entity	    */
typedef int		CDAaggtype;	/* CDA aggregate type code	    */
typedef long		CDAconstant;	/* CDA enumerated constant	    */
typedef int		CDAindex;	/* Array index			    */
typedef void CDA_FAR *	CDAuserparam;   /* User supplied parameter	    */
typedef unsigned long	CDAflags;	/* Flags/mask longword		    */
typedef unsigned int 	CDAlargebitfield; /* Bitfield type for fields > 8   */
typedef unsigned char 	CDAsmallbitfield; /* Bitfield type for fields <= 8
					     when needed to avoid padding   */
typedef unsigned long	CDAuint32;	/* 32-bit unsigned */
typedef long		CDAmeasurement;
#endif

typedef struct cda_itemlist {		/* Itemlist structure		 */
    CDAitemlength item_length;
    CDAitemcode   item_code;		/* Parameter can be value or adrr*/
    union {				/* It is recommended that this   */
	CDAsize	    item_value;		/* itemlist struct be used over  */
	CDAaddress  item_address;	/* the struct cda_itemlist def'd */
	} CDAitemparam;			/* in cda_def.h (cda_def.h).	 */
    } CDAitemlist;

typedef struct cda_format_list_entry
{
    CDAconstant		domain;		/* The domain for this format.      */
    CDAconstant		febe;		/* Front end or a back end format.  */
    CDAsize		length;		/* The length of the format name.   */
    CDAenvirontext	*format;	/* A pointer to the memory location
					   at which the format name is stored
					   as an ASCII character string.    */
} CDAformatlist;


typedef struct cda_aggregate CDA_FAR *CDAagghandle; /* Aggregate handle	     */

typedef struct cda_document CDA_FAR *CDArootagghandle;/* Root aggregate handle */

typedef struct cda_converter CDA_FAR *CDAconverterhandle;   /* Converter handle	     */

typedef struct cda_frontend CDA_FAR *CDAfrontendhandle;	    /* Cvtr front end handle */

typedef struct cda_filehandle CDA_FAR *CDAfilehandle;	    /* CDA file handle	     */

typedef struct cda_text_filehandle CDA_FAR *CDAtextfilehandle; /* Text file handle   */

typedef struct cda_message CDA_FAR *CDAmessagehandle;	    /* CDA message handle    */

/*
 * DDIS defined types.
 */
typedef	struct ddis_context CDA_FAR *DDISstreamhandle;	    /* DDIS stream handle    */

typedef CDAuint32	DDIStype;	/* DDIS tag (type) argument	 */
typedef CDAuint32	DDISlength;	/* DDIS length argument ?? type ??*/
typedef CDAuint32	DDISentry;	/* DDIS parse table entry	 */

#endif				/* for the CDA_TYPES definition */

/*
 * usage: PROTO (return_type function, (arg1, arg2, arg3))
 */
#ifndef PROTO
#if CDA_EXPAND_PROTO == 1
#define PROTO(name, arg_list) name arg_list
#else
#define PROTO(name, arg_list) name ()
#endif
#endif

#endif