928a5170b1340caeeb105687020e2ad11db61136
[pspp] / src / sort.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
5    This program is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
18    02111-1307, USA. */
19
20 #if !sort_h
21 #define sort_h 1
22
23 #include "vfm.h"
24
25 /* Sort direction. */
26 enum sort_direction
27   {
28     SRT_ASCEND,                 /* A, B, C, ..., X, Y, Z. */
29     SRT_DESCEND                 /* Z, Y, X, ..., C, B, A. */
30   };
31
32 /* SORT CASES input program. */
33 struct sort_cases_pgm 
34   {
35     int ref_cnt;                        /* Reference count. */
36                         
37     struct variable **vars;             /* Variables to sort. */
38     enum sort_direction *dirs;          /* Sort directions. */
39     int var_cnt;                        /* Number of variables to sort. */
40
41     struct internal_sort *isrt;         /* Internal sort output. */
42     struct external_sort *xsrt;         /* External sort output. */
43   };
44
45 /* SORT CASES programmatic interface. */
46 struct sort_cases_pgm *parse_sort (void);
47 int sort_cases (struct sort_cases_pgm *, int separate);
48 void read_sort_output (struct sort_cases_pgm *,
49                        write_case_func *, write_case_data);
50 void destroy_sort_cases_pgm (struct sort_cases_pgm *);
51
52 #endif /* !sort_h */