1 /* cat -- concatenate files and print on the standard output.
2 Copyright (C) 1988, 1990, 1991, 1995 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 2, or (at your option)
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, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
18 /* Differences from the Unix cat:
19 * Always unbuffered, -u is ignored.
20 * 100 times faster with -v -u.
21 * 20 times faster with -v.
23 By tege@sics.se, Torbjorn Granlund, advised by rms, Richard Stallman. */
29 #include <sys/types.h>
31 #include <sys/ioctl.h>
37 #define max(h,i) ((h) > (i) ? (h) : (i))
45 static void next_line_num ();
46 static void simple_cat ();
48 /* Name under which this program was invoked. */
51 /* Name of input file. May be "-". */
54 /* Descriptor on which input file is open. */
55 static int input_desc;
57 /* Descriptor on which output file is open. Always is 1. */
58 static int output_desc;
60 /* Buffer for line numbers. */
61 static char line_buf[13] =
62 {' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', '0', '\t', '\0'};
64 /* Position in `line_buf' where printing starts. This will not change
65 unless the number of lines is larger than 999999. */
66 static char *line_num_print = line_buf + 5;
68 /* Position of the first digit in `line_buf'. */
69 static char *line_num_start = line_buf + 10;
71 /* Position of the last digit in `line_buf'. */
72 static char *line_num_end = line_buf + 10;
74 /* Preserves the `cat' function's local `newlines' between invocations. */
75 static int newlines2 = 0;
77 /* Count of non-fatal error conditions. */
78 static int exit_stat = 0;
85 fprintf (stderr, "Try `%s --help' for more information.\n",
90 Usage: %s [OPTION] [FILE]...\n\
95 -b, --number-nonblank number nonblank output lines\n\
96 -e equivalent to -vE\n\
97 -n, --number number all output lines\n\
98 -s, --squeeze-blank never more than one single blank line\n\
99 -t equivalent to -vT\n\
101 -v, --show-nonprinting use ^ and M- notation, save for LFD and TAB\n\
102 -A, --show-all equivalent to -vET\n\
103 -E, --show-ends display $ at end of each line\n\
104 -T, --show-tabs display TAB characters as ^I\n\
105 --help display this help and exit\n\
106 --version output version information and exit\n\
108 With no FILE, or when FILE is -, read standard input.\n\
120 /* Optimal size of i/o operations of output. */
123 /* Optimal size of i/o operations of input. */
126 /* Pointer to the input buffer. */
127 unsigned char *inbuf;
129 /* Pointer to the output buffer. */
130 unsigned char *outbuf;
134 /* Index in argv to processed argument. */
137 /* Device number of the output (file or whatever). */
140 /* I-node number of the output. */
143 /* Nonzero if the output file should not be the same as any input file. */
144 int check_redirection = 1;
146 /* Nonzero if we have ever read standard input. */
147 int have_read_stdin = 0;
149 struct stat stat_buf;
151 /* Variables that are set according to the specified options. */
153 int numbers_at_empty_lines = 1;
154 int squeeze_empty_lines = 0;
155 int mark_line_ends = 0;
159 /* If non-zero, call cat, otherwise call simple_cat to do the actual work. */
162 /* If non-zero, display usage information and exit. */
163 static int show_help;
165 /* If non-zero, print the version on standard output then exit. */
166 static int show_version;
168 static struct option const long_options[] =
170 {"number-nonblank", no_argument, NULL, 'b'},
171 {"number", no_argument, NULL, 'n'},
172 {"squeeze-blank", no_argument, NULL, 's'},
173 {"show-nonprinting", no_argument, NULL, 'v'},
174 {"show-ends", no_argument, NULL, 'E'},
175 {"show-tabs", no_argument, NULL, 'T'},
176 {"show-all", no_argument, NULL, 'A'},
177 {"help", no_argument, &show_help, 1},
178 {"version", no_argument, &show_version, 1},
182 program_name = argv[0];
184 /* Parse command line options. */
186 while ((c = getopt_long (argc, argv, "benstuvAET", long_options, (int *) 0))
197 numbers_at_empty_lines = 0;
213 squeeze_empty_lines = 1;
223 /* We provide the -u feature unconditionally. */
255 printf ("cat - %s\n", version_string);
264 /* Get device, i-node number, and optimal blocksize of output. */
266 if (fstat (output_desc, &stat_buf) < 0)
267 error (1, errno, "standard output");
269 outsize = ST_BLKSIZE (stat_buf);
270 /* Input file can be output file for non-regular files.
271 fstat on pipes returns S_IFSOCK on some systems, S_IFIFO
272 on others, so the checking should not be done for those types,
273 and to allow things like cat < /dev/tty > /dev/tty, checking
274 is not done for device files either. */
276 if (S_ISREG (stat_buf.st_mode))
278 out_dev = stat_buf.st_dev;
279 out_ino = stat_buf.st_ino;
283 check_redirection = 0;
284 #ifdef lint /* Suppress `used before initialized' warning. */
290 /* Check if any of the input files are the same as the output file. */
300 infile = argv[argind];
302 if (infile[0] == '-' && infile[1] == 0)
309 input_desc = open (infile, O_RDONLY);
312 error (0, errno, "%s", infile);
318 if (fstat (input_desc, &stat_buf) < 0)
320 error (0, errno, "%s", infile);
324 insize = ST_BLKSIZE (stat_buf);
326 /* Compare the device and i-node numbers of this input file with
327 the corresponding values of the (output file associated with)
328 stdout, and skip this input file if they coincide. Input
329 files cannot be redirected to themselves. */
331 if (check_redirection
332 && stat_buf.st_dev == out_dev && stat_buf.st_ino == out_ino)
334 error (0, 0, "%s: input file is output file", infile);
339 /* Select which version of `cat' to use. If any options (more than -u,
340 --version, or --help) were specified, use `cat', otherwise use
345 insize = max (insize, outsize);
346 inbuf = (unsigned char *) xmalloc (insize);
348 simple_cat (inbuf, insize);
352 inbuf = (unsigned char *) xmalloc (insize + 1);
354 /* Why are (OUTSIZE - 1 + INSIZE * 4 + 13) bytes allocated for
357 A test whether output needs to be written is done when the input
358 buffer empties or when a newline appears in the input. After
359 output is written, at most (OUTSIZE - 1) bytes will remain in the
360 buffer. Now INSIZE bytes of input is read. Each input character
361 may grow by a factor of 4 (by the prepending of M-^). If all
362 characters do, and no newlines appear in this block of input, we
363 will have at most (OUTSIZE - 1 + INSIZE) bytes in the buffer. If
364 the last character in the preceding block of input was a
365 newline, a line number may be written (according to the given
366 options) as the first thing in the output buffer. (Done after the
367 new input is read, but before processing of the input begins.) A
368 line number requires seldom more than 13 positions. */
370 outbuf = (unsigned char *) xmalloc (outsize - 1 + insize * 4 + 13);
372 cat (inbuf, insize, outbuf, outsize, quote,
373 output_tabs, numbers, numbers_at_empty_lines, mark_line_ends,
374 squeeze_empty_lines);
382 if (strcmp (infile, "-") && close (input_desc) < 0)
384 error (0, errno, "%s", infile);
388 while (++argind < argc);
390 if (have_read_stdin && close (0) < 0)
391 error (1, errno, "-");
393 error (1, errno, "write error");
398 /* Plain cat. Copies the file behind `input_desc' to the file behind
402 simple_cat (buf, bufsize)
403 /* Pointer to the buffer, used by reads and writes. */
406 /* Number of characters preferably read or written by each read and write
410 /* Actual number of characters read, and therefore written. */
413 /* Loop until the end of the file. */
417 /* Read a block of input. */
419 n_read = safe_read (input_desc, buf, bufsize);
422 error (0, errno, "%s", infile);
427 /* End of this file? */
432 /* Write this block out. */
434 if (full_write (output_desc, buf, n_read) < 0)
435 error (1, errno, "write error");
439 /* Cat the file behind INPUT_DESC to the file behind OUTPUT_DESC.
440 Called if any option more than -u was specified.
442 A newline character is always put at the end of the buffer, to make
443 an explicit test for buffer end unnecessary. */
446 cat (inbuf, insize, outbuf, outsize, quote,
447 output_tabs, numbers, numbers_at_empty_lines,
448 mark_line_ends, squeeze_empty_lines)
450 /* Pointer to the beginning of the input buffer. */
451 unsigned char *inbuf;
453 /* Number of characters read in each read call. */
456 /* Pointer to the beginning of the output buffer. */
457 unsigned char *outbuf;
459 /* Number of characters written by each write call. */
462 /* Variables that have values according to the specified options. */
466 int numbers_at_empty_lines;
468 int squeeze_empty_lines;
470 /* Last character read from the input buffer. */
473 /* Pointer to the next character in the input buffer. */
476 /* Pointer to the first non-valid byte in the input buffer, i.e. the
477 current end of the buffer. */
480 /* Pointer to the position where the next character shall be written. */
481 unsigned char *bpout;
483 /* Number of characters read by the last read call. */
486 /* Determines how many consecutive newlines there have been in the
487 input. 0 newlines makes NEWLINES -1, 1 newline makes NEWLINES 1,
488 etc. Initially 0 to indicate that we are at the beginning of a
489 new line. The "state" of the procedure is determined by
491 int newlines = newlines2;
494 /* If nonzero, use the FIONREAD ioctl, as an optimization.
495 (On Ultrix, it is not supported on NFS filesystems.) */
496 int use_fionread = 1;
499 /* The inbuf pointers are initialized so that BPIN > EOB, and thereby input
500 is read immediately. */
511 /* Write if there are at least OUTSIZE bytes in OUTBUF. */
513 if (bpout - outbuf >= outsize)
515 unsigned char *wp = outbuf;
518 if (full_write (output_desc, wp, outsize) < 0)
519 error (1, errno, "write error");
522 while (bpout - wp >= outsize);
524 /* Move the remaining bytes to the beginning of the
527 memmove (outbuf, wp, bpout - wp);
528 bpout = outbuf + (bpout - wp);
531 /* Is INBUF empty? */
538 /* Is there any input to read immediately?
539 If not, we are about to wait,
540 so write all buffered output before waiting. */
543 && ioctl (input_desc, FIONREAD, &n_to_read) < 0)
545 /* Ultrix returns EOPNOTSUPP on NFS;
546 HP-UX returns ENOTTY on pipes.
547 SunOS returns EINVAL and
548 More/BSD returns ENODEV on special files
550 Irix-5 returns ENOSYS on pipes. */
551 if (errno == EOPNOTSUPP || errno == ENOTTY
552 || errno == EINVAL || errno == ENODEV
560 error (0, errno, "cannot do ioctl on `%s'", infile);
562 newlines2 = newlines;
569 int n_write = bpout - outbuf;
571 if (full_write (output_desc, outbuf, n_write) < 0)
572 error (1, errno, "write error");
576 /* Read more input into INBUF. */
578 n_read = safe_read (input_desc, inbuf, insize);
581 error (0, errno, "%s", infile);
583 newlines2 = newlines;
588 newlines2 = newlines;
592 /* Update the pointers and insert a sentinel at the buffer
601 /* It was a real (not a sentinel) newline. */
603 /* Was the last line empty?
604 (i.e. have two or more consecutive newlines been read?) */
608 /* Are multiple adjacent empty lines to be substituted by
609 single ditto (-s), and this was the second empty line? */
611 if (squeeze_empty_lines && newlines >= 2)
617 /* Are line numbers to be written at empty lines (-n)? */
619 if (numbers && numbers_at_empty_lines)
622 bpout = (unsigned char *) stpcpy (bpout, line_num_print);
626 /* Output a currency symbol if requested (-e). */
631 /* Output the newline. */
639 /* Are we at the beginning of a line, and line numbers are requested? */
641 if (newlines >= 0 && numbers)
644 bpout = (unsigned char *) stpcpy (bpout, line_num_print);
647 /* Here CH cannot contain a newline character. */
649 /* The loops below continue until a newline character is found,
650 which means that the buffer is empty or that a proper newline
653 /* If quoting, i.e. at least one of -v, -e, or -t specified,
654 scan for chars that need conversion. */
677 *bpout++ = ch - 128 + 64;
680 else if (ch == '\t' && output_tabs)
694 /* Not quoting, neither of -v, -e, or -t specified. */
697 if (ch == '\t' && !output_tabs)
713 /* Compute the next line number. */
718 char *endp = line_num_end;
725 while (endp >= line_num_start);
726 *--line_num_start = '1';
727 if (line_num_start < line_num_print)