usr.bin/sort/sort.h

   1 /*      $FreeBSD: head/usr.bin/sort/sort.h 264744 2014-04-21 22:52:18Z pfg $    */
   2
   3 /*-
   4  * Copyright (C) 2009 Gabor Kovesdan <gabor@FreeBSD.org>
   5  * Copyright (C) 2012 Oleg Moskalenko <mom040267@gmail.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 #if defined(SORT_RANDOM)
  41 #include <md5.h>
  42 #endif
  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 #if defined(SORT_RANDOM)
  72 extern MD5_CTX md5_ctx;
  73 #endif
  74
  75 /*
  76  * sort.c
  77  */
  78
  79 /*
  80  * This structure holds main sort options which are NOT affecting the sort ordering.
  81  */
  82 struct sort_opts
  83 {
  84         wint_t          field_sep;
  85         int             sort_method;
  86         bool            cflag;
  87         bool            csilentflag;
  88         bool            kflag;
  89         bool            mflag;
  90         bool            sflag;
  91         bool            uflag;
  92         bool            zflag;
  93         bool            tflag;
  94         bool            complex_sort;
  95 };
  96
  97 /*
  98  * Key value structure forward declaration
  99  */
 100 struct key_value;
 101
 102 /*
 103  * Cmp function
 104  */
 105 typedef int (*cmpcoll_t)(struct key_value *kv1, struct key_value *kv2, size_t offset);
 106
 107 /*
 108  * This structure holds "sort modifiers" - options which are affecting the sort ordering.
 109  */
 110 struct sort_mods
 111 {
 112         cmpcoll_t       func;
 113         bool            bflag;
 114         bool            dflag;
 115         bool            fflag;
 116         bool            gflag;
 117         bool            iflag;
 118         bool            Mflag;
 119         bool            nflag;
 120         bool            rflag;
 121 #if defined(SORT_RANDOM)
 122         bool            Rflag;
 123 #endif
 124         bool            Vflag;
 125         bool            hflag;
 126 };
 127
 128 extern bool need_hint;
 129
 130 extern struct sort_opts sort_opts_vals;
 131
 132 extern struct sort_mods * const default_sort_mods;
 133
 134 #endif /* __BSD_SORT_H__ */