xref: /freebsd/usr.bin/sort/sort.h (revision 105fd928b0b5b35ab529e5f6914788dc49582901)
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)	 catgets(catalog, 1, n, nlsstr[n])
53 #endif
54 
55 extern const char *nlsstr[];
56 
57 #if defined(SORT_THREADS)
58 #define	MT_SORT_THRESHOLD (10000)
59 extern unsigned int ncpu;
60 extern size_t nthreads;
61 #endif
62 
63 /*
64  * If true, we output some debug information.
65  */
66 extern bool debug_sort;
67 
68 /*
69  * MD5 context for random hash function
70  */
71 extern MD5_CTX md5_ctx;
72 
73 /*
74  * sort.c
75  */
76 
77 /*
78  * This structure holds main sort options which are NOT affecting the sort ordering.
79  */
80 struct sort_opts
81 {
82 	wint_t		field_sep;
83 	int		sort_method;
84 	bool		cflag;
85 	bool		csilentflag;
86 	bool		kflag;
87 	bool		mflag;
88 	bool		sflag;
89 	bool		uflag;
90 	bool		zflag;
91 	bool		tflag;
92 	bool		complex_sort;
93 };
94 
95 /*
96  * Key value structure forward declaration
97  */
98 struct key_value;
99 
100 /*
101  * Cmp function
102  */
103 typedef int (*cmpcoll_t)(struct key_value *kv1, struct key_value *kv2, size_t offset);
104 
105 /*
106  * This structure holds "sort modifiers" - options which are affecting the sort ordering.
107  */
108 struct sort_mods
109 {
110 	cmpcoll_t	func;
111 	bool		bflag;
112 	bool		dflag;
113 	bool		fflag;
114 	bool		gflag;
115 	bool		iflag;
116 	bool		Mflag;
117 	bool		nflag;
118 	bool		rflag;
119 	bool		Rflag;
120 	bool		Vflag;
121 	bool		hflag;
122 };
123 
124 extern bool need_hint;
125 
126 extern struct sort_opts sort_opts_vals;
127 
128 extern struct sort_mods * const default_sort_mods;
129 
130 /*
131  * Cached value of MB_CUR_MAX. Because MB_CUR_MAX is used often throughout the program,
132  * this avoids frequent calls to __mb_cur_max.
133  */
134 extern size_t mb_cur_max;
135 
136 #endif /* __BSD_SORT_H__ */
137