xref: /freebsd/usr.bin/sort/sort.h (revision 298cf604ccf133b101c6fad42d1a078a1fac58ca)
1 /*	$FreeBSD$	*/
2 
3 /*-
4  * Copyright (C) 2009 Gabor Kovesdan <gabor@FreeBSD.org>
5  * Copyright (C) 2012 Oleg Moskalenko <oleg.moskalenko@citrix.com>
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #if !defined(__BSD_SORT_H__)
31 #define __BSD_SORT_H__
32 
33 #include <errno.h>
34 #include <stdbool.h>
35 #include <stdio.h>
36 #include <sysexits.h>
37 #include <wchar.h>
38 
39 #include <sys/types.h>
40 #include <md5.h>
41 
42 #define	VERSION	"2.3-FreeBSD"
43 
44 #ifdef WITHOUT_NLS
45 #define	getstr(n)	 nlsstr[n]
46 #else
47 #include <nl_types.h>
48 
49 extern nl_catd catalog;
50 #define	getstr(n)	 catgets(catalog, 1, n, nlsstr[n])
51 #endif
52 
53 extern const char *nlsstr[];
54 
55 #if defined(SORT_THREADS)
56 #define MT_SORT_THRESHOLD (10000)
57 extern unsigned int ncpu;
58 extern size_t nthreads;
59 #endif
60 
61 /*
62  * If true, we output some debug information.
63  */
64 extern bool debug_sort;
65 
66 /*
67  * MD5 context for random hash function
68  */
69 extern MD5_CTX md5_ctx;
70 
71 /*
72  * sort.c
73  */
74 
75 /*
76  * This structure holds main sort options which are NOT affecting the sort ordering.
77  */
78 struct sort_opts
79 {
80 	wint_t		field_sep;
81 	int		sort_method;
82 	bool		cflag;
83 	bool		csilentflag;
84 	bool		kflag;
85 	bool		mflag;
86 	bool		sflag;
87 	bool		uflag;
88 	bool		zflag;
89 	bool		tflag;
90 	bool		complex_sort;
91 };
92 
93 /*
94  * Key value structure forward declaration
95  */
96 struct key_value;
97 
98 /*
99  * Cmp function
100  */
101 typedef int (*cmpcoll_t)(struct key_value *kv1, struct key_value *kv2, size_t offset);
102 
103 /*
104  * This structure holds "sort modifiers" - options which are affecting the sort ordering.
105  */
106 struct sort_mods
107 {
108 	cmpcoll_t	func;
109 	bool		bflag;
110 	bool		dflag;
111 	bool		fflag;
112 	bool		gflag;
113 	bool		iflag;
114 	bool		Mflag;
115 	bool		nflag;
116 	bool		rflag;
117 	bool		Rflag;
118 	bool		Vflag;
119 	bool		hflag;
120 };
121 
122 extern bool need_hint;
123 
124 extern struct sort_opts sort_opts_vals;
125 
126 extern struct sort_mods * const default_sort_mods;
127 
128 #endif /* __BSD_SORT_H__ */
129