CoCalc -- recsort.h

GitHub Repository: att/ast
Path: blob/master/src/lib/librecsort/recsort.h
¹⁸⁰⁸ views
1
/***********************************************************************
2
*                                                                      *
3
*               This software is part of the ast package               *
4
*          Copyright (c) 1996-2011 AT&T Intellectual Property          *
5
*                      and is licensed under the                       *
6
*                 Eclipse Public License, Version 1.0                  *
7
*                    by AT&T Intellectual Property                     *
8
*                                                                      *
9
*                A copy of the License is available at                 *
10
*          http://www.eclipse.org/org/documents/epl-v10.html           *
11
*         (with md5 checksum b35adb5213ca9657e911e9befb180842)         *
12
*                                                                      *
13
*              Information and Software Systems Research               *
14
*                            AT&T Research                             *
15
*                           Florham Park NJ                            *
16
*                                                                      *
17
*                   Phong Vo <[email protected]>                    *
18
*                 Glenn Fowler <[email protected]>                  *
19
*                                                                      *
20
***********************************************************************/
21
#ifndef _RECSORT_H
22
#define	_RECSORT_H		1
23

24
#if _PACKAGE_ast
25
#include <ast.h>
26
#else
27
#include <sfio.h>
28
#endif
29

30
#define RS_PLUGIN_VERSION	AST_PLUGIN_VERSION(20100528L)
31
#define RS_VERSION		20030811L
32
#define RSKEY_VERSION		20111011L
33

34
#define SORTLIB(m)		unsigned long plugin_version(void) { return RS_PLUGIN_VERSION; }
35

36
typedef struct _rsobj_s		Rsobj_t;
37
typedef struct _rs_s		Rs_t;
38
typedef struct _rsmethod_s	Rsmethod_t;
39
typedef struct _rsdisc_s	Rsdisc_t;
40
typedef ssize_t 		(*Rsdefkey_f)_ARG_((Rs_t*, unsigned char*, size_t, unsigned char*, size_t, Rsdisc_t*));
41
typedef int			(*Rsevent_f)_ARG_((Rs_t*, int, Void_t*, Void_t*, Rsdisc_t*));
42

43
typedef struct _rskey_s		Rskey_t;
44
typedef struct _rskeydisc_s	Rskeydisc_t;
45
typedef struct _rskeyfield_s	Rskeyfield_t;
46
typedef int			(*Rskeyerror_f)_ARG_((Void_t*, Void_t*, int, ...));
47

48
typedef ssize_t (*Rskeycode_f)_ARG_((Rskey_t*, Rskeyfield_t*, unsigned char*, size_t, unsigned char*, unsigned char*));
49

50
struct _rsmethod_s
51
{	int		(*insertf)_ARG_((Rs_t*, Rsobj_t*));
52
	Rsobj_t*	(*listf)_ARG_((Rs_t*));
53
	ssize_t		size;	/* size of private data			*/
54
	int		type;	/* method type				*/
55
	char*		name;	/* method name				*/
56
	char*		desc;	/* method description			*/
57
};
58

59
struct _rsdisc_s
60
{	unsigned long	version;/* interface version			*/
61
	int		type;	/* types of key&data			*/
62
	ssize_t		data;	/* length or separator			*/
63
	ssize_t		key;	/* key offset or expansion factor	*/
64
	ssize_t		keylen;	/* >0 for key length else end-offset	*/
65
	Rsdefkey_f	defkeyf;/* to define key from data		*/
66
	Rsevent_f	eventf;	/* to announce various events		*/
67
	unsigned long	events;	/* events to announce			*/
68
	Rsdisc_t*	disc;	/* next in stack			*/
69
};
70

71
struct _rsobj_s
72
{	unsigned long	order;	/* for fast compare or ordinal 		*/
73
	Rsobj_t*	left;	/* left/last link or out of order	*/
74
	Rsobj_t*	right;	/* next record in sorted list		*/
75
	Rsobj_t*	equal;	/* equivalence class			*/
76
	unsigned char*	key;	/* object key				*/
77
	ssize_t		keylen;	/* key length				*/
78
	unsigned char*	data;	/* object data				*/
79
	ssize_t		datalen;/* data length				*/
80
};
81

82
struct _rskeydisc_s
83
{	unsigned long	version;	/* interface version		*/
84
	unsigned long	flags;		/* RSKEY_* flags		*/
85
	Rskeyerror_f	errorf;		/* error function		*/
86
};
87

88
struct _rskeyfield_s
89
{	Rskeyfield_t*	next;		/* next in list			*/
90
	Rskeycode_f	coder;		/* encode data into key		*/
91
	void*		user;		/* user specific data		*/
92

93
	unsigned	flag;		/* code flag			*/
94
	unsigned char	rflag;		/* reverse order		*/
95

96
#ifdef _RSKEYFIELD_PRIVATE_
97
	_RSKEYFIELD_PRIVATE_
98
#endif
99
};
100

101
struct _rskey_s
102
{	const char*	id;		/* library id			*/
103
	Rskeydisc_t*	keydisc;	/* rskey discipline		*/
104
	Rsdisc_t*	disc;		/* rsopen() discipline		*/
105
	Rsmethod_t*	meth;		/* rsopen() method		*/
106
	int		type;		/* rsopen() type		*/
107

108
	char**		input;		/* input files			*/
109

110
	char*		output;		/* output file name		*/
111

112
	size_t		alignsize;	/* buffer alignment size	*/
113
	size_t		fixed;		/* fixed record size		*/
114
	size_t		insize;		/* input buffer size		*/
115
	size_t		outsize;	/* output buffer size		*/
116
	size_t		procsize;	/* process buffer size		*/
117
	size_t		recsize;	/* max record size		*/
118
	unsigned long	test;		/* test mask			*/
119

120
	int		merge;		/* merge sorted input files	*/
121
	int		nproc;		/* max number of processes	*/
122
	int		verbose;	/* trace execution		*/
123
	int		code;		/* global ccode translation	*/
124

125
	unsigned char	tab[32];	/* global tab char/string	*/
126

127
	Rskeyfield_t*	head;		/* key field list head		*/
128
	Rskeyfield_t*	tail;		/* key field list tail		*/
129

130
#ifdef _RSKEY_PRIVATE_
131
	_RSKEY_PRIVATE_
132
#endif
133
};
134

135
struct _rs_s
136
{	Rsmethod_t*	meth;	/* method to sort			*/
137
	Rsdisc_t*	disc;	/* discipline describing data		*/
138
	Sfulong_t	count;	/* number of accumulated objects	*/
139
	int		type;
140
#ifdef _RS_PRIVATE_
141
	_RS_PRIVATE_
142
#endif
143
};
144

145
/* events */
146
#define RS_CLOSE	0000001		/* sort context is being closed	*/
147
#define RS_DISC		0000002		/* discipline is being changed	*/
148
#define RS_METHOD	0000004		/* method is being changed	*/
149
#define RS_OPEN		0001000		/* rsopen() is being called	*/
150
#define RS_POP		0000010		/* discipline is being popped	*/
151
#define RS_PUSH		0000020		/* discipline is being pushed	*/
152
#define RS_READ		0000200		/* called for each read record	*/
153
#define RS_SUMMARY	0000040		/* RS_UNIQ summary		*/
154
#define RS_VERIFY	0000100		/* objects out of order		*/
155
#define RS_WRITE	0000400		/* called for each write record	*/
156
#define RS_FILE_WRITE	0002000		/* rsfilewrite() callout	*/
157
#define RS_FILE_READ	0004000		/* rsfileread() callout		*/
158
#define RS_FILE_CLOSE	0010000		/* rsfileclose() callout	*/
159
#define RS_TEMP_WRITE	0020000		/* rstempwrite() callout	*/
160
#define RS_TEMP_READ	0040000		/* rstempread() callout		*/
161
#define RS_TEMP_CLOSE	0100000		/* rstempclose() callout	*/
162

163
/* { RS_READ RS_SUMMARY RS_WRITE } event returns */
164
#define RS_TERMINATE	(-1)		/* terminate the sort		*/
165
#define RS_ACCEPT	0		/* accept possibly modified rec	*/
166
#define RS_DELETE	1		/* delete/ignore record		*/
167
#define RS_INSERT	2		/* insert new record		*/
168
#define RS_DONE		3		/* user defined			*/
169

170
#define RS_NEXT		0		/* rsdisc() next		*/
171

172
/* sort controls */
173
#define RS_UNIQ		000001		/* remove duplicates		*/
174
#define RS_REVERSE	000002		/* reverse sort order		*/
175
#define RS_DATA		000004		/* sort by key, then by data	*/
176
#define RS_IGNORE	000040		/* rswrite() will be ignored	*/
177
#define RS_CAT		040000		/* just catenate input files	*/
178

179
/* discipline data */
180
#define RS_KSAMELEN	000010		/* key has fixed length		*/
181
#define RS_DSAMELEN	000020		/* data has fixed length	*/
182
#define RS_TYPES	040377
183

184
/* input/output control */
185
#define RS_ITEXT	000100		/* input is plain text		*/
186
#define RS_OTEXT	000200		/* output is plain text		*/
187
#define RS_TEXT		000300
188

189
/* method type */
190
#define RS_MTVERIFY	000400
191
#define RS_MTRASP	001000
192
#define RS_MTRADIX	002000
193
#define RS_MTSPLAY	004000
194
#define RS_MTCOPY	020000
195

196
#define RSKEY_ERROR	000001		/* unrecoverable error		*/
197
#define RSKEY_KEYS	000002		/* keys specified		*/
198

199
#define RSKEYDISC(p)	(((Rskey_t*)((char*)(p)-offsetof(Rskey_t,disc)))->keydisc)
200

201
#define rscount(rs)	((rs)->count)	/* count # of rsprocess() objs	*/
202

203
_BEGIN_EXTERNS_	/* public data */
204

205
#if defined(__EXPORT__)
206
#define extern		__EXPORT__
207
#endif
208

209
extern Rsdisc_t*	rs_disc _ARG_((Rskey_t*, const char*));
210

211
#undef	extern
212

213
#if _BLD_recsort && defined(__EXPORT__)
214
#define extern		extern __EXPORT__
215
#endif
216
#if !_BLD_recsort && defined(__IMPORT__)
217
#define extern		extern __IMPORT__
218
#endif
219

220
extern Rsmethod_t* Rscopy;	/* copy original order	*/
221
extern Rsmethod_t* Rsrasp;	/* radix + splay trees	*/
222
extern Rsmethod_t* Rsradix;	/* radix only		*/
223
extern Rsmethod_t* Rssplay;	/* splay insertion	*/
224
extern Rsmethod_t* Rsverify;	/* verify order		*/
225

226
#undef extern
227
_END_EXTERNS_
228

229
_BEGIN_EXTERNS_	/* public functions */
230
#if _BLD_recsort && defined(__EXPORT__)
231
#define extern	__EXPORT__
232
#endif
233

234
extern Rs_t*		rsnew _ARG_((Rsdisc_t*));
235
extern int		rsinit _ARG_((Rs_t*, Rsmethod_t*, ssize_t, int, Rskey_t*));
236

237
extern Rs_t*		rsopen _ARG_((Rsdisc_t*, Rsmethod_t*, ssize_t, int));
238
extern int		rsclear _ARG_((Rs_t*));
239
extern int		rsclose _ARG_((Rs_t*));
240
extern ssize_t		rsprocess _ARG_((Rs_t*, Void_t*, ssize_t));
241
extern int		rslib _ARG_((Rs_t*, Rskey_t*, const char*, int));
242
extern Rsobj_t*		rslist _ARG_((Rs_t*));
243
extern int		rswrite _ARG_((Rs_t*, Sfio_t*, int));
244
extern int		rsmerge _ARG_((Rs_t*, Sfio_t*, Sfio_t**, int, int));
245
extern Rsdisc_t*	rsdisc _ARG_((Rs_t*, Rsdisc_t*, int));
246
extern Rsmethod_t*	rsmethod _ARG_((Rs_t*, Rsmethod_t*));
247

248
extern Rskey_t*		rskeyopen _ARG_((Rskeydisc_t*, Rsdisc_t*));
249
extern int		rskey _ARG_((Rskey_t*, const char*, int));
250
extern int		rskeyopt _ARG_((Rskey_t*, const char*, int));
251
extern Rsmethod_t*	rskeymeth _ARG_((Rskey_t*, const char*));
252
extern int		rskeylist _ARG_((Rskey_t*, Sfio_t*, int));
253
extern void		rskeydump _ARG_((Rskey_t*, Sfio_t*));
254
extern int		rskeyinit _ARG_((Rskey_t*));
255
extern int		rskeyclose _ARG_((Rskey_t*));
256

257
extern int		rsfilewrite _ARG_((Rs_t*, Sfio_t*, const char*));
258
extern int		rsfileread _ARG_((Rs_t*, Sfio_t*, const char*));
259
extern int		rsfileclose _ARG_((Rs_t*, Sfio_t*));
260

261
extern Sfio_t*		rstempwrite _ARG_((Rs_t*, Sfio_t*));
262
extern int		rstempread _ARG_((Rs_t*, Sfio_t*));
263
extern int		rstempclose _ARG_((Rs_t*, Sfio_t*));
264

265
#undef extern
266
_END_EXTERNS_
267

268
#endif /*_RECSORT_H*/
269

270
Product

Resources

Company
