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