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