xref: /freebsd/usr.bin/sort/sort.h (revision e39e854e27f53a784c3982cbeb68f4ad1cfd9162)
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 #define	UNUSED_ARG(A) do { A=A; } while(0)
45 
46 #ifdef WITHOUT_NLS
47 #define	getstr(n)	 nlsstr[n]
48 #else
49 #include <nl_types.h>
50 
51 extern nl_catd catalog;
52 #define	getstr(n)	 catgets(catalog, 1, n, nlsstr[n])
53 #endif
54 
55 extern const char *nlsstr[];
56 
57 #if defined(SORT_THREADS)
58 extern size_t ncpu;
59 extern size_t nthreads;
60 #endif
61 
62 /*
63  * If true, we output some debug information.
64  */
65 extern bool debug_sort;
66 
67 /*
68  * MD5 context for random hash function
69  */
70 extern MD5_CTX md5_ctx;
71 
72 /*
73  * sort.c
74  */
75 
76 /*
77  * This structure holds main sort options which are NOT affecting the sort ordering.
78  */
79 struct sort_opts
80 {
81 	wchar_t		field_sep;
82 	int		sort_method;
83 	bool		cflag;
84 	bool		csilentflag;
85 	bool		kflag;
86 	bool		mflag;
87 	bool		sflag;
88 	bool		uflag;
89 	bool		zflag;
90 	bool		tflag;
91 	bool		complex_sort;
92 };
93 
94 /*
95  * Key value structure forward declaration
96  */
97 struct key_value;
98 
99 /*
100  * Cmp function
101  */
102 typedef int (*cmpcoll_t)(struct key_value *kv1, struct key_value *kv2, size_t offset);
103 
104 /*
105  * This structure holds "sort modifiers" - options which are affecting the sort ordering.
106  */
107 struct sort_mods
108 {
109 	cmpcoll_t	func;
110 	bool		bflag;
111 	bool		dflag;
112 	bool		fflag;
113 	bool		gflag;
114 	bool		iflag;
115 	bool		Mflag;
116 	bool		nflag;
117 	bool		rflag;
118 	bool		Rflag;
119 	bool		Vflag;
120 	bool		hflag;
121 };
122 
123 extern bool need_hint;
124 
125 extern struct sort_opts sort_opts_vals;
126 
127 extern struct sort_mods * const default_sort_mods;
128 
129 #endif /* __BSD_SORT_H__ */
130