1 /* comm -- compare two sorted files line by line.
2 Copyright (C) 86, 90, 91, 1995-2005, 2008-2009 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17 /* Written by Richard Stallman and David MacKenzie. */
22 #include <sys/types.h>
24 #include "linebuffer.h"
31 /* The official name of this program (e.g., no `g' prefix). */
32 #define PROGRAM_NAME "comm"
35 proper_name ("Richard M. Stallman"), \
36 proper_name ("David MacKenzie")
38 /* Undefine, to avoid warning about redefinition on some systems. */
40 #define min(x, y) ((x) < (y) ? (x) : (y))
42 /* True if the LC_COLLATE locale is hard. */
43 static bool hard_LC_COLLATE
;
45 /* If true, print lines that are found only in file 1. */
46 static bool only_file_1
;
48 /* If true, print lines that are found only in file 2. */
49 static bool only_file_2
;
51 /* If true, print lines that are found in both files. */
54 /* If nonzero, we have seen at least one unpairable line. */
55 static bool seen_unpairable
;
57 /* If nonzero, we have warned about disorder in that file. */
58 static bool issued_disorder_warning
[2];
60 /* If nonzero, check that the input is correctly ordered. */
68 /* Output columns will be delimited with this string, which may be set
69 on the command-line with --output-delimiter=STR. The default is a
70 single TAB character. */
71 static char const *delimiter
;
73 /* For long options that have no equivalent short option, use a
74 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
77 CHECK_ORDER_OPTION
= CHAR_MAX
+ 1,
79 OUTPUT_DELIMITER_OPTION
82 static struct option
const long_options
[] =
84 {"check-order", no_argument
, NULL
, CHECK_ORDER_OPTION
},
85 {"nocheck-order", no_argument
, NULL
, NOCHECK_ORDER_OPTION
},
86 {"output-delimiter", required_argument
, NULL
, OUTPUT_DELIMITER_OPTION
},
87 {GETOPT_HELP_OPTION_DECL
},
88 {GETOPT_VERSION_OPTION_DECL
},
97 if (status
!= EXIT_SUCCESS
)
98 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
103 Usage: %s [OPTION]... FILE1 FILE2\n\
107 Compare sorted files FILE1 and FILE2 line by line.\n\
111 With no options, produce three-column output. Column one contains\n\
112 lines unique to FILE1, column two contains lines unique to FILE2,\n\
113 and column three contains lines common to both files.\n\
117 -1 suppress lines unique to FILE1\n\
118 -2 suppress lines unique to FILE2\n\
119 -3 suppress lines that appear in both files\n\
123 --check-order check that the input is correctly sorted, even\n\
124 if all input lines are pairable\n\
125 --nocheck-order do not check that the input is correctly sorted\n\
128 --output-delimiter=STR separate columns with STR\n\
130 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
131 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
132 emit_bug_reporting_address ();
137 /* Output the line in linebuffer LINE to stream STREAM
138 provided the switches say it should be output.
139 CLASS is 1 for a line found only in file 1,
140 2 for a line only in file 2, 3 for a line in both. */
143 writeline (struct linebuffer
const *line
, FILE *stream
, int class)
155 /* Print a delimiter if we are printing lines from file 1. */
157 fputs (delimiter
, stream
);
163 /* Print a delimiter if we are printing lines from file 1. */
165 fputs (delimiter
, stream
);
166 /* Print a delimiter if we are printing lines from file 2. */
168 fputs (delimiter
, stream
);
172 fwrite (line
->buffer
, sizeof (char), line
->length
, stream
);
175 /* Check that successive input lines PREV and CURRENT from input file
176 WHATFILE are presented in order.
178 If the user specified --nocheck-order, the check is not made.
179 If the user specified --check-order, the problem is fatal.
180 Otherwise (the default), the message is simply a warning.
182 A message is printed at most once per input file.
184 This funtion was copied (nearly) verbatim from `src/join.c'. */
187 check_order (struct linebuffer
const *prev
,
188 struct linebuffer
const *current
,
192 if (check_input_order
!= CHECK_ORDER_DISABLED
193 && ((check_input_order
== CHECK_ORDER_ENABLED
) || seen_unpairable
))
195 if (!issued_disorder_warning
[whatfile
- 1])
200 order
= xmemcoll (prev
->buffer
, prev
->length
- 1,
201 current
->buffer
, current
->length
- 1);
203 order
= memcmp2 (prev
->buffer
, prev
->length
- 1,
204 current
->buffer
, current
->length
- 1);
208 error ((check_input_order
== CHECK_ORDER_ENABLED
210 0, _("file %d is not in sorted order"), whatfile
);
212 /* If we get to here, the message was just a warning, but we
213 want only to issue it once. */
214 issued_disorder_warning
[whatfile
- 1] = true;
220 /* Compare INFILES[0] and INFILES[1].
221 If either is "-", use the standard input for that file.
222 Assume that each input file is sorted;
223 merge them and output the result. */
226 compare_files (char **infiles
)
228 /* For each file, we have four linebuffers in lba. */
229 struct linebuffer lba
[2][4];
231 /* thisline[i] points to the linebuffer holding the next available line
232 in file i, or is NULL if there are no lines left in that file. */
233 struct linebuffer
*thisline
[2];
235 /* all_line[i][alt[i][0]] also points to the linebuffer holding the
236 current line in file i. We keep two buffers of history around so we
237 can look two lines back when we get to the end of a file. */
238 struct linebuffer
*all_line
[2][4];
240 /* This is used to rotate through the buffers for each input file. */
243 /* streams[i] holds the input stream for file i. */
248 /* Initialize the storage. */
249 for (i
= 0; i
< 2; i
++)
251 for (j
= 0; j
< 4; j
++)
253 initbuffer (&lba
[i
][j
]);
254 all_line
[i
][j
] = &lba
[i
][j
];
259 streams
[i
] = (STREQ (infiles
[i
], "-") ? stdin
: fopen (infiles
[i
], "r"));
261 error (EXIT_FAILURE
, errno
, "%s", infiles
[i
]);
263 thisline
[i
] = readlinebuffer (all_line
[i
][alt
[i
][0]], streams
[i
]);
264 if (ferror (streams
[i
]))
265 error (EXIT_FAILURE
, errno
, "%s", infiles
[i
]);
268 while (thisline
[0] || thisline
[1])
271 bool fill_up
[2] = { false, false };
273 /* Compare the next available lines of the two files. */
277 else if (!thisline
[1])
282 order
= xmemcoll (thisline
[0]->buffer
, thisline
[0]->length
- 1,
283 thisline
[1]->buffer
, thisline
[1]->length
- 1);
286 size_t len
= min (thisline
[0]->length
, thisline
[1]->length
) - 1;
287 order
= memcmp (thisline
[0]->buffer
, thisline
[1]->buffer
, len
);
289 order
= (thisline
[0]->length
< thisline
[1]->length
291 : thisline
[0]->length
!= thisline
[1]->length
);
295 /* Output the line that is lesser. */
297 writeline (thisline
[1], stdout
, 3);
300 seen_unpairable
= true;
302 writeline (thisline
[0], stdout
, 1);
304 writeline (thisline
[1], stdout
, 2);
307 /* Step the file the line came from.
308 If the files match, step both files. */
314 for (i
= 0; i
< 2; i
++)
317 /* Rotate the buffers for this file. */
318 alt
[i
][2] = alt
[i
][1];
319 alt
[i
][1] = alt
[i
][0];
320 alt
[i
][0] = (alt
[i
][0] + 1) & 0x03;
322 thisline
[i
] = readlinebuffer (all_line
[i
][alt
[i
][0]], streams
[i
]);
325 check_order (all_line
[i
][alt
[i
][1]], thisline
[i
], i
+ 1);
327 /* If this is the end of the file we may need to re-check
328 the order of the previous two lines, since we might have
329 discovered an unpairable match since we checked before. */
330 else if (all_line
[i
][alt
[i
][2]]->buffer
)
331 check_order (all_line
[i
][alt
[i
][2]],
332 all_line
[i
][alt
[i
][1]], i
+ 1);
334 if (ferror (streams
[i
]))
335 error (EXIT_FAILURE
, errno
, "%s", infiles
[i
]);
341 for (i
= 0; i
< 2; i
++)
342 if (fclose (streams
[i
]) != 0)
343 error (EXIT_FAILURE
, errno
, "%s", infiles
[i
]);
347 main (int argc
, char **argv
)
351 initialize_main (&argc
, &argv
);
352 set_program_name (argv
[0]);
353 setlocale (LC_ALL
, "");
354 bindtextdomain (PACKAGE
, LOCALEDIR
);
355 textdomain (PACKAGE
);
356 hard_LC_COLLATE
= hard_locale (LC_COLLATE
);
358 atexit (close_stdout
);
364 seen_unpairable
= false;
365 issued_disorder_warning
[0] = issued_disorder_warning
[1] = false;
366 check_input_order
= CHECK_ORDER_DEFAULT
;
368 while ((c
= getopt_long (argc
, argv
, "123", long_options
, NULL
)) != -1)
383 case NOCHECK_ORDER_OPTION
:
384 check_input_order
= CHECK_ORDER_DISABLED
;
387 case CHECK_ORDER_OPTION
:
388 check_input_order
= CHECK_ORDER_ENABLED
;
391 case OUTPUT_DELIMITER_OPTION
:
392 if (delimiter
&& !STREQ (delimiter
, optarg
))
393 error (EXIT_FAILURE
, 0, _("multiple delimiters specified"));
397 error (EXIT_FAILURE
, 0, _("empty %s not allowed"),
398 quote ("--output-delimiter"));
402 case_GETOPT_HELP_CHAR
;
404 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
407 usage (EXIT_FAILURE
);
410 if (argc
- optind
< 2)
413 error (0, 0, _("missing operand"));
415 error (0, 0, _("missing operand after %s"), quote (argv
[argc
- 1]));
416 usage (EXIT_FAILURE
);
419 if (2 < argc
- optind
)
421 error (0, 0, _("extra operand %s"), quote (argv
[optind
+ 2]));
422 usage (EXIT_FAILURE
);
425 /* The default delimiter is a TAB. */
429 compare_files (argv
+ optind
);
431 if (issued_disorder_warning
[0] || issued_disorder_warning
[1])