codex.h

/***********************************************************************
*                                                                      *
*               This software is part of the ast package               *
*          Copyright (c) 2003-2011 AT&T Intellectual Property          *
*                      and is licensed under the                       *
*                 Eclipse Public License, Version 1.0                  *
*                    by AT&T Intellectual Property                     *
*                                                                      *
*                A copy of the License is available at                 *
*          http://www.eclipse.org/org/documents/epl-v10.html           *
*         (with md5 checksum b35adb5213ca9657e911e9befb180842)         *
*                                                                      *
*              Information and Software Systems Research               *
*                            AT&T Research                             *
*                           Florham Park NJ                            *
*                                                                      *
*                 Glenn Fowler <[email protected]>                  *
*                  David Korn <[email protected]>                   *
*                   Phong Vo <[email protected]>                    *
*                                                                      *
***********************************************************************/
#pragma prototyped

/*
 * codex public interface
 */

#ifndef _CODEX_H
#define _CODEX_H	1

#include <ast.h>
#include <error.h>

#define CODEX_VERSION		20090704L
#define CODEX_PLUGIN_VERSION	AST_PLUGIN_VERSION(CODEX_VERSION)

#define CODEX_DECODE	0x0001		/* decode supported		*/
#define CODEX_ENCODE	0x0002		/* encode supported		*/

#define CODEX_RETAIN	0x0010		/* initf-donef retain state	*/
#define CODEX_INVERT	0x0020		/* invert composition		*/
#define CODEX_TRACE	0x0040		/* enable trace			*/
#define CODEX_VERBOSE	0x0080		/* enable verbose trace		*/

#define CODEX_COMPRESS	0x0100		/* compression			*/
#define CODEX_CRYPT	0x0200		/* encryption			*/
#define CODEX_ICONV	0x0400		/* character code translation	*/
#define CODEX_SUM	0x0800		/* checksum			*/
#define CODEX_UU	0x1000		/* uuencode (ISO text)		*/

#define CODEX_CACHED	0x10000000L	/* cached entry			*/
#define CODEX_SERIAL	0x20000000L	/* serial number assigned	*/
#define CODEX_FLUSH	0x40000000L	/* flush-only sync		*/
#define CODEX_ACTIVE	0x80000000L	/* active cache entry		*/

#define CODEX_IDENT	1024		/* max ident buffer size	*/
#define CODEX_NAME	256		/* max coder name w/args	*/
#define CODEX_ARGS	32		/* max coder args in name	*/

#define CODEX(d)	((Codex_t*)(d))

typedef uint32_t Codexnum_t;

struct Codex_s; typedef struct Codex_s Codex_t;
struct Codexdata_s; typedef struct Codexdata_s Codexdata_t;
struct Codexdisc_s; typedef struct Codexdisc_s Codexdisc_t;
struct Codexmeth_s; typedef struct Codexmeth_s Codexmeth_t;

typedef Codexmeth_t* (*Codexlib_f)(const char*);

struct Codex_s				/* coder public state		*/
{
	Sfdisc_t	sfdisc;		/* coder sfio discipline	*/
	Sfio_t*		sp;		/* data base stream		*/
	Sfio_t*		dp;		/* optional data delta stream	*/
	Sfoff_t		size;		/* expected size if != -1	*/
	Codexdisc_t*	disc;		/* coder discipline		*/
	Codexmeth_t*	meth;		/* coder method			*/
	Codexnum_t	flags;		/* CODEX_* flags		*/
	Codexnum_t	index;		/* per-process index		*/
	int		serial;		/* codex() serial number	*/
	void*		data;		/* coder private state		*/
	Sfio_t*		op;		/* original stream		*/
};

struct Codexdata_s			/* codexdata() info		*/
{
	Codexnum_t	size;		/* value size			*/
	Codexnum_t	num;		/* value if buf!=0		*/
	void*		buf;		/* size byte value		*/
};

struct Codexdisc_s			/* coder discipline		*/
{
	Codexnum_t	version;	/* CODEX_VERSION		*/
	Error_f		errorf;		/* error message function	*/
	ssize_t		(*passf)(void*, size_t, Codexdisc_t*, Codexmeth_t*);
	const char*	passphrase;	/* passphrase			*/
	Sfio_t*		identify;	/* decode method string if != 0	*/
};

struct Codexmeth_s			/* coder method			*/
{
	const char*	name;		/* coder name			*/
	const char*	description;	/* coder description		*/
	const char*	options;	/* static optget() options	*/
	Codexnum_t	flags;		/* CODEX_* flags		*/

	int		(*optionsf)(Codexmeth_t*, Sfio_t*);
	int		(*identf)(Codexmeth_t*, const void*, size_t, char*, size_t);
	int		(*openf)(Codex_t*, char* const[], Codexnum_t);
	int		(*closef)(Codex_t*);
	int		(*initf)(Codex_t*);
	int		(*donef)(Codex_t*);
	ssize_t		(*readf)(Sfio_t*, void*, size_t, Sfdisc_t*);
	ssize_t		(*writef)(Sfio_t*, const void*, size_t, Sfdisc_t*);
	int		(*syncf)(Codex_t*);
	Sfoff_t		(*seekf)(Codex_t*, Sfoff_t, int);
	int		(*dataf)(Codex_t*, Codexdata_t*);

	void*		vcmeth;		/* vcodex(3) method		*/
	void*		data;		/* coder private data		*/
	Codexmeth_t*	next;		/* next in list of all coders	*/
};

#if _BLD_codex && !defined(main)

#include <codexlib.h>

#define CODEXLIB(m)
#define CODEXNEXT(m)	codex_##m##_next

#else

#ifdef __STDC__
#define CODEXLIB(m)	extern Codexmeth_t* codex_lib(const char* name) { return &codex_##m; } unsigned long plugin_version(void) { return CODEX_PLUGIN_VERSION; }
#else
#define CODEXLIB(m)	extern Codexmeth_t* codex_lib(name) char* name; { return &codex_##m; } unsigned long plugin_version() { return CODEX_PLUGIN_VERSION; }
#endif

#define CODEXNEXT(m)	0

#if defined(__EXPORT__)
#define extern		__EXPORT__
#endif

extern Codexmeth_t*	codex_lib(const char*);

#undef	extern

#endif

#define codexinit(d,e)	(memset(d,0,sizeof(*(d))),(d)->version=CODEX_VERSION,(d)->errorf=(Error_f)(e))

#if _BLD_codex && defined(__EXPORT__)
#define extern		__EXPORT__
#endif

extern int		codex(Sfio_t*, Sfio_t*, const char*, Codexnum_t, Codexdisc_t*, Codexmeth_t*);
extern int		codexpop(Sfio_t*, Sfio_t*, int);
extern int		codexcmp(const char*, const char*);
extern int		codexdata(Sfio_t*, Codexdata_t*);
extern ssize_t		codexgetpass(const char*, void*, size_t);
extern Codexmeth_t*	codexid(const void*, size_t, char*, size_t);
extern Codexmeth_t*	codexlist(Codexmeth_t*);
extern Codexmeth_t*	codexmeth(const char*);
extern int		codexadd(const char*, Codexmeth_t*);
extern Sfio_t*		codexnull(void);
extern ssize_t		codexpass(void*, size_t, Codexdisc_t*, Codexmeth_t*);
extern int		codexsize(Sfio_t*, Sfoff_t);

#undef	extern

#endif