maint: update all copyright year number ranges
[coreutils.git] / src / pr.c
blob4580c5c78069cccfdd6b4d10759773fecb417db0
1 /* pr -- convert text files for printing.
2 Copyright (C) 1988-2017 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 /* By Pete TerMaat, with considerable refinement by Roland Huebner. */
19 /* Things to watch: Sys V screws up on ...
20 pr -n -3 -s: /usr/dict/words
21 pr -m -o10 -n /usr/dict/words{,,,}
22 pr -6 -a -n -o5 /usr/dict/words
24 Ideas:
26 Keep a things_to_do list of functions to call when we know we have
27 something to print. Cleaner than current series of checks.
29 Improve the printing of control prefixes.
31 Expand the file name in the centered header line to a full file name.
34 Concept:
36 If the input_tab_char differs from the default value TAB
37 ('-e[CHAR[...]]' is used), any input text tab is expanded to the
38 default width of 8 spaces (compare char_to_clump). - Same as SunOS
39 does.
41 The treatment of the number_separator (compare add_line_number):
42 The default value TAB of the number_separator ('-n[SEP[...]]') doesn't
43 be thought to be an input character. An optional '-e'-input has no
44 effect.
45 - With single column output
46 only one POSIX requirement has to be met:
47 The default n-separator should be a TAB. The consequence is a
48 different width between the number and the text if the output position
49 of the separator changes, i.e., it depends upon the left margin used.
50 That's not nice but easy-to-use together with the defaults of other
51 utilities, e.g. sort or cut. - Same as SunOS does.
52 - With multicolumn output
53 two conflicting POSIX requirements exist:
54 First "default n-separator is TAB", second "output text columns shall
55 be of equal width". Moreover POSIX specifies the number+separator a
56 part of the column, together with '-COLUMN' and '-a -COLUMN'.
57 (With -m output the number shall occupy each line only once. Exactly
58 the same situation as single column output exists.)
59 GNU pr gives priority to the 2nd requirement and observes POSIX
60 column definition. The n-separator TAB is expanded to the same number
61 of spaces in each column using the default value 8. Tabification is
62 only performed if it is compatible with the output position.
63 Consequence: The output text columns are of equal width. The layout
64 of a page does not change if the left margin varies. - Looks better
65 than the SunOS approach.
66 SunOS pr gives priority to the 1st requirement. n-separator TAB
67 width varies with each column. Only the width of text part of the
68 column is fixed.
69 Consequence: The output text columns don't have equal width. The
70 widths and the layout of the whole page varies with the left margin.
71 An overflow of the line length (without margin) over the input value
72 PAGE_WIDTH may occur.
74 The interference of the POSIX-compliant small letter options -w and -s:
75 ("interference" means "setting a _separator_ with -s switches off the
76 column structure and the default - not generally - page_width,
77 acts on -w option")
78 options: text form / separator: equivalent new options:
79 -w l -s[x]
80 --------------------------------------------------------------------
81 1. -- -- columns / space --
82 trunc. to page_width = 72
83 2. -- -s[:] full lines / TAB[:] -J --sep-string[="<TAB>"|:]
84 no truncation
85 3. -w l -- columns / space -W l
86 trunc. to page_width = l
87 4. -w l -s[:] columns / no sep.[:] -W l --sep-string[=:]
88 trunc. to page_width = l
89 --------------------------------------------------------------------
92 Options:
94 Including version 1.22i:
95 Some SMALL LETTER options have been redefined with the object of a
96 better POSIX compliance. The output of some further cases has been
97 adapted to other UNIXes. A violation of downward compatibility has to
98 be accepted.
99 Some NEW CAPITAL LETTER options ( -J, -S, -W) has been introduced to
100 turn off unexpected interferences of small letter options (-s and -w
101 together with the three column options).
102 -N option and the second argument LAST_PAGE of +FIRST_PAGE offer more
103 flexibility; The detailed handling of form feeds set in the input
104 files requires -T option.
106 Capital letter options dominate small letter ones.
108 Some of the option-arguments cannot be specified as separate arguments
109 from the preceding option letter (already stated in POSIX specification).
111 Form feeds in the input cause page breaks in the output. Multiple
112 form feeds produce empty pages.
114 +FIRST_PAGE[:LAST_PAGE], --pages=FIRST_PAGE[:LAST_PAGE]
115 begin [stop] printing with page FIRST_[LAST_]PAGE
117 -COLUMN, --columns=COLUMN
118 Produce output that is COLUMN columns wide and
119 print columns down, unless -a is used. Balance number of
120 lines in the columns on each page.
122 -a, --across Print columns across rather than down, used
123 together with -COLUMN. The input
126 three
127 four
128 will be printed with '-a -3' as
129 one two three
130 four
132 -b Balance columns on the last page.
133 -b is no longer an independent option. It's always used
134 together with -COLUMN (unless -a is used) to get a
135 consistent formulation with "FF set by hand" in input
136 files. Each formfeed found terminates the number of lines
137 to be read with the actual page. The situation for
138 printing columns down is equivalent to that on the last
139 page. So we need a balancing.
141 Keeping -b as an underground option guarantees some
142 downward compatibility. Utilities using pr with -b
143 (a most frequently used form) still work as usual.
145 -c, --show-control-chars
146 Print unprintable characters as control prefixes.
147 Control-g is printed as ^G (use hat notation) and
148 octal backslash notation.
150 -d, --double-space Double space the output.
152 -D FORMAT, --date-format=FORMAT Use FORMAT for the header date.
154 -e[CHAR[WIDTH]], --expand-tabs[=CHAR[WIDTH]]
155 Expand tabs to spaces on input. Optional argument CHAR
156 is the input TAB character. (Default is TAB). Optional
157 argument WIDTH is the input TAB character's width.
158 (Default is 8.)
160 -F, -f, --form-feed Use formfeeds instead of newlines to separate
161 pages. A three line HEADER is used, no TRAILER with -F,
162 without -F both HEADER and TRAILER are made of five lines.
164 -h HEADER, --header=HEADER
165 Replace the filename in the header with the string HEADER.
166 A centered header is used.
168 -i[CHAR[WIDTH]], --output-tabs[=CHAR[WIDTH]]
169 Replace spaces with tabs on output. Optional argument
170 CHAR is the output TAB character. (Default is TAB).
171 Optional argument WIDTH is the output TAB character's
172 width. (Default is 8)
174 -J, --join-lines Merge lines of full length, turns off -W/-w
175 line truncation, no column alignment, --sep-string[=STRING]
176 sets separators, works with all column options
177 (-COLUMN | -a -COLUMN | -m).
178 -J has been introduced (together with -W and --sep-string) to
179 disentangle the old (POSIX compliant) options -w, -s
180 along with the 3 column options.
182 -l PAGE_LENGTH, --length=PAGE_LENGTH
183 Set the page length to PAGE_LENGTH lines. Default is 66,
184 including 5 lines of HEADER and 5 lines of TRAILER
185 without -F, but only 3 lines of HEADER and no TRAILER
186 with -F (i.e the number of text lines defaults to 56 or
187 63 respectively).
189 -m, --merge Print files in parallel; pad_across_to align
190 columns; truncate lines and print separator strings;
191 Do it also with empty columns to get a continuous line
192 numbering and column marking by separators throughout
193 the whole merged file.
195 Empty pages in some input files produce empty columns
196 [marked by separators] in the merged pages. Completely
197 empty merged pages show no column separators at all.
199 The layout of a merged page is ruled by the largest form
200 feed distance of the single pages at that page. Shorter
201 columns will be filled up with empty lines.
203 Together with -J option join lines of full length and
204 set separators when -S option is used.
206 -n[SEP[DIGITS]], --number-lines[=SEP[DIGITS]]
207 Provide DIGITS digit line numbering (default for DIGITS
208 is 5). With multicolumn output the number occupies the
209 first DIGITS column positions of each text column or only
210 each line of -m output.
211 With single column output the number precedes each line
212 just as -m output.
213 Optional argument SEP is the character appended to the
214 line number to separate it from the text followed.
215 The default separator is a TAB. In a strict sense a TAB
216 is always printed with single column output only. The
217 TAB-width varies with the TAB-position, e.g. with the
218 left margin specified by -o option.
219 With multicolumn output priority is given to "equal width
220 of output columns" (a POSIX specification). The TAB-width
221 is fixed to the value of the 1st column and does not
222 change with different values of left margin. That means a
223 fixed number of spaces is always printed in the place of
224 a TAB. The tabification depends upon the output
225 position.
227 Default counting of the line numbers starts with 1st
228 line of the input file (not the 1st line printed,
229 compare the --page option and -N option).
231 -N NUMBER, --first-line-number=NUMBER
232 Start line counting with the number NUMBER at the 1st
233 line of first page printed (mostly not the 1st line of
234 the input file).
236 -o MARGIN, --indent=MARGIN
237 Offset each line with a margin MARGIN spaces wide.
238 Total page width is the size of the margin plus the
239 PAGE_WIDTH set with -W/-w option.
241 -r, --no-file-warnings
242 Omit warning when a file cannot be opened.
244 -s[CHAR], --separator[=CHAR]
245 Separate columns by a single character CHAR, default for
246 CHAR is the TAB character without -w and 'no char' with -w.
247 Without '-s' default separator 'space' is set.
248 -s[CHAR] turns off line truncation of all 3 column options
249 (-COLUMN|-a -COLUMN|-m) except -w is set. That is a POSIX
250 compliant formulation. The source code translates -s into
251 the new options -S and -J, also -W if required.
253 -S[STRING], --sep-string[=STRING]
254 Separate columns by any string STRING. The -S option
255 doesn't react upon the -W/-w option (unlike -s option
256 does). It defines a separator nothing else.
257 Without -S: Default separator TAB is used with -J and
258 'space' otherwise (same as -S" ").
259 With -S "": No separator is used.
260 Quotes should be used with blanks and some shell active
261 characters.
262 -S is problematic because in its obsolete form you
263 cannot use -S "STRING", but in its standard form you
264 must use -S "STRING" if STRING is empty. Use
265 --sep-string to avoid the ambiguity.
267 -t, --omit-header Do not print headers or footers but retain form
268 feeds set in the input files.
270 -T, --omit-pagination
271 Do not print headers or footers, eliminate any pagination
272 by form feeds set in the input files.
274 -v, --show-nonprinting
275 Print unprintable characters as escape sequences. Use
276 octal backslash notation. Control-G becomes \007.
278 -w PAGE_WIDTH, --width=PAGE_WIDTH
279 Set page width to PAGE_WIDTH characters for multiple
280 text-column output only (default for PAGE_WIDTH is 72).
281 -s[CHAR] turns off the default page width and any line
282 truncation. Lines of full length will be merged,
283 regardless of the column options set. A POSIX compliant
284 formulation.
286 -W PAGE_WIDTH, --page-width=PAGE_WIDTH
287 Set the page width to PAGE_WIDTH characters. That's valid
288 with and without a column option. Text lines will be
289 truncated, unless -J is used. Together with one of the
290 column options (-COLUMN| -a -COLUMN| -m) column alignment
291 is always used.
292 Default is 72 characters.
293 Without -W PAGE_WIDTH
294 - but with one of the column options default truncation of
295 72 characters is used (to keep downward compatibility
296 and to simplify most frequently met column tasks).
297 Column alignment and column separators are used.
298 - and without any of the column options NO line truncation
299 is used (to keep downward compatibility and to meet most
300 frequent tasks). That's equivalent to -W 72 -J .
302 With/without -W PAGE_WIDTH the header line is always
303 truncated to avoid line overflow.
305 (In pr versions newer than 1.14 -S option does no longer
306 affect -W option.)
310 #include <config.h>
312 #include <getopt.h>
313 #include <sys/types.h>
314 #include "system.h"
315 #include "die.h"
316 #include "error.h"
317 #include "fadvise.h"
318 #include "hard-locale.h"
319 #include "mbswidth.h"
320 #include "quote.h"
321 #include "stat-time.h"
322 #include "stdio--.h"
323 #include "strftime.h"
324 #include "xstrtol.h"
325 #include "xdectoint.h"
327 /* The official name of this program (e.g., no 'g' prefix). */
328 #define PROGRAM_NAME "pr"
330 #define AUTHORS \
331 proper_name ("Pete TerMaat"), \
332 proper_name ("Roland Huebner")
334 /* Used with start_position in the struct COLUMN described below.
335 If start_position == ANYWHERE, we aren't truncating columns and
336 can begin printing a column anywhere. Otherwise we must pad to
337 the horizontal position start_position. */
338 #define ANYWHERE 0
340 /* Each column has one of these structures allocated for it.
341 If we're only dealing with one file, fp is the same for all
342 columns.
344 The general strategy is to spend time setting up these column
345 structures (storing columns if necessary), after which printing
346 is a matter of flitting from column to column and calling
347 print_func.
349 Parallel files, single files printing across in multiple
350 columns, and single files printing down in multiple columns all
351 fit the same printing loop.
353 print_func Function used to print lines in this column.
354 If we're storing this column it will be
355 print_stored(), Otherwise it will be read_line().
357 char_func Function used to process characters in this column.
358 If we're storing this column it will be store_char(),
359 otherwise it will be print_char().
361 current_line Index of the current entry in line_vector, which
362 contains the index of the first character of the
363 current line in buff[].
365 lines_stored Number of lines in this column which are stored in
366 buff.
368 lines_to_print If we're storing this column, lines_to_print is
369 the number of stored_lines which remain to be
370 printed. Otherwise it is the number of lines
371 we can print without exceeding lines_per_body.
373 start_position The horizontal position we want to be in before we
374 print the first character in this column.
376 numbered True means precede this column with a line number. */
378 /* FIXME: There are many unchecked integer overflows in this file,
379 that will cause this command to misbehave given large inputs or
380 options. Many of the "int" values below should be "size_t" or
381 something else like that. */
383 struct COLUMN;
384 struct COLUMN
386 FILE *fp; /* Input stream for this column. */
387 char const *name; /* File name. */
388 enum
390 OPEN,
391 FF_FOUND, /* used with -b option, set with \f, changed
392 to ON_HOLD after print_header */
393 ON_HOLD, /* Hit a form feed. */
394 CLOSED
396 status; /* Status of the file pointer. */
398 /* Func to print lines in this col. */
399 bool (*print_func) (struct COLUMN *);
401 /* Func to print/store chars in this col. */
402 void (*char_func) (char);
404 int current_line; /* Index of current place in line_vector. */
405 int lines_stored; /* Number of lines stored in buff. */
406 int lines_to_print; /* No. lines stored or space left on page. */
407 int start_position; /* Horizontal position of first char. */
408 bool numbered;
409 bool full_page_printed; /* True means printed without a FF found. */
411 /* p->full_page_printed controls a special case of "FF set by hand":
412 True means a full page has been printed without FF found. To avoid an
413 additional empty page we have to ignore a FF immediately following in
414 the next line. */
417 typedef struct COLUMN COLUMN;
419 static int char_to_clump (char c);
420 static bool read_line (COLUMN *p);
421 static bool print_page (void);
422 static bool print_stored (COLUMN *p);
423 static bool open_file (char *name, COLUMN *p);
424 static bool skip_to_page (uintmax_t page);
425 static void print_header (void);
426 static void pad_across_to (int position);
427 static void add_line_number (COLUMN *p);
428 static void getoptnum (const char *n_str, int min, int *num,
429 const char *errfmt);
430 static void getoptarg (char *arg, char switch_char, char *character,
431 int *number);
432 static void print_files (int number_of_files, char **av);
433 static void init_parameters (int number_of_files);
434 static void init_header (char const *filename, int desc);
435 static bool init_fps (int number_of_files, char **av);
436 static void init_funcs (void);
437 static void init_store_cols (void);
438 static void store_columns (void);
439 static void balance (int total_stored);
440 static void store_char (char c);
441 static void pad_down (unsigned int lines);
442 static void read_rest_of_line (COLUMN *p);
443 static void skip_read (COLUMN *p, int column_number);
444 static void print_char (char c);
445 static void cleanup (void);
446 static void print_sep_string (void);
447 static void separator_string (const char *optarg_S);
449 /* All of the columns to print. */
450 static COLUMN *column_vector;
452 /* When printing a single file in multiple downward columns,
453 we store the leftmost columns contiguously in buff.
454 To print a line from buff, get the index of the first character
455 from line_vector[i], and print up to line_vector[i + 1]. */
456 static char *buff;
458 /* Index of the position in buff where the next character
459 will be stored. */
460 static unsigned int buff_current;
462 /* The number of characters in buff.
463 Used for allocation of buff and to detect overflow of buff. */
464 static size_t buff_allocated;
466 /* Array of indices into buff.
467 Each entry is an index of the first character of a line.
468 This is used when storing lines to facilitate shuffling when
469 we do column balancing on the last page. */
470 static int *line_vector;
472 /* Array of horizontal positions.
473 For each line in line_vector, end_vector[line] is the horizontal
474 position we are in after printing that line. We keep track of this
475 so that we know how much we need to pad to prepare for the next
476 column. */
477 static int *end_vector;
479 /* (-m) True means we're printing multiple files in parallel. */
480 static bool parallel_files = false;
482 /* (-m) True means a line starts with some empty columns (some files
483 already CLOSED or ON_HOLD) which we have to align. */
484 static bool align_empty_cols;
486 /* (-m) True means we have not yet found any printable column in a line.
487 align_empty_cols = true has to be maintained. */
488 static bool empty_line;
490 /* (-m) False means printable column output precedes a form feed found.
491 Column alignment is done only once. No additional action with that form
492 feed.
493 True means we found only a form feed in a column. Maybe we have to do
494 some column alignment with that form feed. */
495 static bool FF_only;
497 /* (-[0-9]+) True means we're given an option explicitly specifying
498 number of columns. Used to detect when this option is used with -m
499 and when translating old options to new/long options. */
500 static bool explicit_columns = false;
502 /* (-t|-T) False means we aren't printing headers and footers. */
503 static bool extremities = true;
505 /* (-t) True means we retain all FF set by hand in input files.
506 False is set with -T option. */
507 static bool keep_FF = false;
508 static bool print_a_FF = false;
510 /* True means we need to print a header as soon as we know we've got input
511 to print after it. */
512 static bool print_a_header;
514 /* (-f) True means use formfeeds instead of newlines to separate pages. */
515 static bool use_form_feed = false;
517 /* True means we have read the standard input. */
518 static bool have_read_stdin = false;
520 /* True means the -a flag has been given. */
521 static bool print_across_flag = false;
523 /* True means we're printing one file in multiple (>1) downward columns. */
524 static bool storing_columns = true;
526 /* (-b) True means balance columns on the last page as Sys V does. */
527 /* That's no longer an independent option. With storing_columns = true
528 balance_columns = true is used too (s. function init_parameters).
529 We get a consistent formulation with "FF set by hand" in input files. */
530 static bool balance_columns = false;
532 /* (-l) Number of lines on a page, including header and footer lines. */
533 static int lines_per_page = 66;
535 /* Number of lines in the header and footer can be reset to 0 using
536 the -t flag. */
537 enum { lines_per_header = 5 };
538 static int lines_per_body;
539 enum { lines_per_footer = 5 };
541 /* (-w|-W) Width in characters of the page. Does not include the width of
542 the margin. */
543 static int chars_per_line = 72;
545 /* (-w|W) True means we truncate lines longer than chars_per_column. */
546 static bool truncate_lines = false;
548 /* (-J) True means we join lines without any line truncation. -J
549 dominates -w option. */
550 static bool join_lines = false;
552 /* Number of characters in a column. Based on col_sep_length and
553 page width. */
554 static int chars_per_column;
556 /* (-e) True means convert tabs to spaces on input. */
557 static bool untabify_input = false;
559 /* (-e) The input tab character. */
560 static char input_tab_char = '\t';
562 /* (-e) Tabstops are at chars_per_tab, 2*chars_per_tab, 3*chars_per_tab, ...
563 where the leftmost column is 1. */
564 static int chars_per_input_tab = 8;
566 /* (-i) True means convert spaces to tabs on output. */
567 static bool tabify_output = false;
569 /* (-i) The output tab character. */
570 static char output_tab_char = '\t';
572 /* (-i) The width of the output tab. */
573 static int chars_per_output_tab = 8;
575 /* Keeps track of pending white space. When we hit a nonspace
576 character after some whitespace, we print whitespace, tabbing
577 if necessary to get to output_position + spaces_not_printed. */
578 static int spaces_not_printed;
580 /* (-o) Number of spaces in the left margin (tabs used when possible). */
581 static int chars_per_margin = 0;
583 /* Position where the next character will fall.
584 Leftmost position is 0 + chars_per_margin.
585 Rightmost position is chars_per_margin + chars_per_line - 1.
586 This is important for converting spaces to tabs on output. */
587 static int output_position;
589 /* Horizontal position relative to the current file.
590 (output_position depends on where we are on the page;
591 input_position depends on where we are in the file.)
592 Important for converting tabs to spaces on input. */
593 static int input_position;
595 /* True if there were any failed opens so we can exit with nonzero
596 status. */
597 static bool failed_opens = false;
599 /* The number of spaces taken up if we print a tab character with width
600 c_ from position h_. */
601 #define TAB_WIDTH(c_, h_) ((c_) - ((h_) % (c_)))
603 /* The horizontal position we'll be at after printing a tab character
604 of width c_ from the position h_. */
605 #define POS_AFTER_TAB(c_, h_) ((h_) + TAB_WIDTH (c_, h_))
607 /* (-NNN) Number of columns of text to print. */
608 static int columns = 1;
610 /* (+NNN:MMM) Page numbers on which to begin and stop printing.
611 first_page_number = 0 will be used to check input only. */
612 static uintmax_t first_page_number = 0;
613 static uintmax_t last_page_number = UINTMAX_MAX;
615 /* Number of files open (not closed, not on hold). */
616 static int files_ready_to_read = 0;
618 /* Current page number. Displayed in header. */
619 static uintmax_t page_number;
621 /* Current line number. Displayed when -n flag is specified.
623 When printing files in parallel (-m flag), line numbering is as follows:
624 1 foo goo moo
625 2 hoo too zoo
627 When printing files across (-a flag), ...
628 1 foo 2 moo 3 goo
629 4 hoo 5 too 6 zoo
631 Otherwise, line numbering is as follows:
632 1 foo 3 goo 5 too
633 2 moo 4 hoo 6 zoo */
634 static int line_number;
636 /* (-n) True means lines should be preceded by numbers. */
637 static bool numbered_lines = false;
639 /* (-n) Character which follows each line number. */
640 static char number_separator = '\t';
642 /* (-n) line counting starts with 1st line of input file (not with 1st
643 line of 1st page printed). */
644 static int line_count = 1;
646 /* (-n) True means counting of skipped lines starts with 1st line of
647 input file. False means -N option is used in addition, counting of
648 skipped lines not required. */
649 static bool skip_count = true;
651 /* (-N) Counting starts with start_line_number = NUMBER at 1st line of
652 first page printed, usually not 1st page of input file. */
653 static int start_line_num = 1;
655 /* (-n) Width in characters of a line number. */
656 static int chars_per_number = 5;
658 /* Used when widening the first column to accommodate numbers -- only
659 needed when printing files in parallel. Includes width of both the
660 number and the number_separator. */
661 static int number_width;
663 /* Buffer sprintf uses to format a line number. */
664 static char *number_buff;
666 /* (-v) True means unprintable characters are printed as escape sequences.
667 control-g becomes \007. */
668 static bool use_esc_sequence = false;
670 /* (-c) True means unprintable characters are printed as control prefixes.
671 control-g becomes ^G. */
672 static bool use_cntrl_prefix = false;
674 /* (-d) True means output is double spaced. */
675 static bool double_space = false;
677 /* Number of files opened initially in init_files. Should be 1
678 unless we're printing multiple files in parallel. */
679 static int total_files = 0;
681 /* (-r) True means don't complain if we can't open a file. */
682 static bool ignore_failed_opens = false;
684 /* (-S) True means we separate columns with a specified string.
685 -S option does not affect line truncation nor column alignment. */
686 static bool use_col_separator = false;
688 /* String used to separate columns if the -S option has been specified.
689 Default without -S but together with one of the column options
690 -a|COLUMN|-m is a 'space' and with the -J option a 'tab'. */
691 static char const *col_sep_string = "";
692 static int col_sep_length = 0;
693 static char *column_separator = (char *) " ";
694 static char *line_separator = (char *) "\t";
696 /* Number of separator characters waiting to be printed as soon as we
697 know that we have any input remaining to be printed. */
698 static int separators_not_printed;
700 /* Position we need to pad to, as soon as we know that we have input
701 remaining to be printed. */
702 static int padding_not_printed;
704 /* True means we should pad the end of the page. Remains false until we
705 know we have a page to print. */
706 static bool pad_vertically;
708 /* (-h) String of characters used in place of the filename in the header. */
709 static char *custom_header;
711 /* (-D) Date format for the header. */
712 static char const *date_format;
714 /* The local time zone rules, as per the TZ environment variable. */
715 static timezone_t localtz;
717 /* Date and file name for the header. */
718 static char *date_text;
719 static char const *file_text;
721 /* Output columns available, not counting the date and file name. */
722 static int header_width_available;
724 static char *clump_buff;
726 /* True means we read the line no. lines_per_body in skip_read
727 called by skip_to_page. That variable controls the coincidence of a
728 "FF set by hand" and "full_page_printed", see above the definition of
729 structure COLUMN. */
730 static bool last_line = false;
732 /* For long options that have no equivalent short option, use a
733 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
734 enum
736 COLUMNS_OPTION = CHAR_MAX + 1,
737 PAGES_OPTION
740 static char const short_options[] =
741 "-0123456789D:FJN:S::TW:abcde::fh:i::l:mn::o:rs::tvw:";
743 static struct option const long_options[] =
745 {"pages", required_argument, NULL, PAGES_OPTION},
746 {"columns", required_argument, NULL, COLUMNS_OPTION},
747 {"across", no_argument, NULL, 'a'},
748 {"show-control-chars", no_argument, NULL, 'c'},
749 {"double-space", no_argument, NULL, 'd'},
750 {"date-format", required_argument, NULL, 'D'},
751 {"expand-tabs", optional_argument, NULL, 'e'},
752 {"form-feed", no_argument, NULL, 'f'},
753 {"header", required_argument, NULL, 'h'},
754 {"output-tabs", optional_argument, NULL, 'i'},
755 {"join-lines", no_argument, NULL, 'J'},
756 {"length", required_argument, NULL, 'l'},
757 {"merge", no_argument, NULL, 'm'},
758 {"number-lines", optional_argument, NULL, 'n'},
759 {"first-line-number", required_argument, NULL, 'N'},
760 {"indent", required_argument, NULL, 'o'},
761 {"no-file-warnings", no_argument, NULL, 'r'},
762 {"separator", optional_argument, NULL, 's'},
763 {"sep-string", optional_argument, NULL, 'S'},
764 {"omit-header", no_argument, NULL, 't'},
765 {"omit-pagination", no_argument, NULL, 'T'},
766 {"show-nonprinting", no_argument, NULL, 'v'},
767 {"width", required_argument, NULL, 'w'},
768 {"page-width", required_argument, NULL, 'W'},
769 {GETOPT_HELP_OPTION_DECL},
770 {GETOPT_VERSION_OPTION_DECL},
771 {NULL, 0, NULL, 0}
774 static void
775 integer_overflow (void)
777 die (EXIT_FAILURE, 0, _("integer overflow"));
780 /* Return the number of columns that have either an open file or
781 stored lines. */
783 static unsigned int _GL_ATTRIBUTE_PURE
784 cols_ready_to_print (void)
786 COLUMN *q;
787 unsigned int i;
788 unsigned int n;
790 n = 0;
791 for (q = column_vector, i = 0; i < columns; ++q, ++i)
792 if (q->status == OPEN
793 || q->status == FF_FOUND /* With -b: To print a header only */
794 || (storing_columns && q->lines_stored > 0 && q->lines_to_print > 0))
795 ++n;
796 return n;
799 /* Estimate first_ / last_page_number
800 using option +FIRST_PAGE:LAST_PAGE */
802 static bool
803 first_last_page (int oi, char c, char const *pages)
805 char *p;
806 uintmax_t first;
807 uintmax_t last = UINTMAX_MAX;
808 strtol_error err = xstrtoumax (pages, &p, 10, &first, "");
809 if (err != LONGINT_OK && err != LONGINT_INVALID_SUFFIX_CHAR)
810 xstrtol_fatal (err, oi, c, long_options, pages);
812 if (p == pages || !first)
813 return false;
815 if (*p == ':')
817 char const *p1 = p + 1;
818 err = xstrtoumax (p1, &p, 10, &last, "");
819 if (err != LONGINT_OK)
820 xstrtol_fatal (err, oi, c, long_options, pages);
821 if (p1 == p || last < first)
822 return false;
825 if (*p)
826 return false;
828 first_page_number = first;
829 last_page_number = last;
830 return true;
833 /* Parse column count string S, and if it's valid (1 or larger and
834 within range of the type of 'columns') set the global variables
835 columns and explicit_columns. Otherwise, exit with a diagnostic. */
837 static void
838 parse_column_count (char const *s)
840 getoptnum (s, 1, &columns, _("invalid number of columns"));
841 explicit_columns = true;
844 /* Estimate length of col_sep_string with option -S. */
846 static void
847 separator_string (const char *optarg_S)
849 size_t len = strlen (optarg_S);
850 if (INT_MAX < len)
851 integer_overflow ();
852 col_sep_length = len;
853 col_sep_string = optarg_S;
857 main (int argc, char **argv)
859 unsigned int n_files;
860 bool old_options = false;
861 bool old_w = false;
862 bool old_s = false;
863 char **file_names;
865 /* Accumulate the digits of old-style options like -99. */
866 char *column_count_string = NULL;
867 size_t n_digits = 0;
868 size_t n_alloc = 0;
870 initialize_main (&argc, &argv);
871 set_program_name (argv[0]);
872 setlocale (LC_ALL, "");
873 bindtextdomain (PACKAGE, LOCALEDIR);
874 textdomain (PACKAGE);
876 atexit (close_stdout);
878 n_files = 0;
879 file_names = (argc > 1
880 ? xnmalloc (argc - 1, sizeof (char *))
881 : NULL);
883 while (true)
885 int oi = -1;
886 int c = getopt_long (argc, argv, short_options, long_options, &oi);
887 if (c == -1)
888 break;
890 if (ISDIGIT (c))
892 /* Accumulate column-count digits specified via old-style options. */
893 if (n_digits + 1 >= n_alloc)
894 column_count_string
895 = X2REALLOC (column_count_string, &n_alloc);
896 column_count_string[n_digits++] = c;
897 column_count_string[n_digits] = '\0';
898 continue;
901 n_digits = 0;
903 switch (c)
905 case 1: /* Non-option argument. */
906 /* long option --page dominates old '+FIRST_PAGE ...'. */
907 if (! (first_page_number == 0
908 && *optarg == '+' && first_last_page (-2, '+', optarg + 1)))
909 file_names[n_files++] = optarg;
910 break;
912 case PAGES_OPTION: /* --pages=FIRST_PAGE[:LAST_PAGE] */
913 { /* dominates old opt +... */
914 if (! optarg)
915 die (EXIT_FAILURE, 0,
916 _("'--pages=FIRST_PAGE[:LAST_PAGE]' missing argument"));
917 else if (! first_last_page (oi, 0, optarg))
918 die (EXIT_FAILURE, 0, _("invalid page range %s"),
919 quote (optarg));
920 break;
923 case COLUMNS_OPTION: /* --columns=COLUMN */
925 parse_column_count (optarg);
927 /* If there was a prior column count specified via the
928 short-named option syntax, e.g., -9, ensure that this
929 long-name-specified value overrides it. */
930 free (column_count_string);
931 column_count_string = NULL;
932 n_alloc = 0;
933 break;
936 case 'a':
937 print_across_flag = true;
938 storing_columns = false;
939 break;
940 case 'b':
941 balance_columns = true;
942 break;
943 case 'c':
944 use_cntrl_prefix = true;
945 break;
946 case 'd':
947 double_space = true;
948 break;
949 case 'D':
950 date_format = optarg;
951 break;
952 case 'e':
953 if (optarg)
954 getoptarg (optarg, 'e', &input_tab_char,
955 &chars_per_input_tab);
956 /* Could check tab width > 0. */
957 untabify_input = true;
958 break;
959 case 'f':
960 case 'F':
961 use_form_feed = true;
962 break;
963 case 'h':
964 custom_header = optarg;
965 break;
966 case 'i':
967 if (optarg)
968 getoptarg (optarg, 'i', &output_tab_char,
969 &chars_per_output_tab);
970 /* Could check tab width > 0. */
971 tabify_output = true;
972 break;
973 case 'J':
974 join_lines = true;
975 break;
976 case 'l':
977 getoptnum (optarg, 1, &lines_per_page,
978 _("'-l PAGE_LENGTH' invalid number of lines"));
979 break;
980 case 'm':
981 parallel_files = true;
982 storing_columns = false;
983 break;
984 case 'n':
985 numbered_lines = true;
986 if (optarg)
987 getoptarg (optarg, 'n', &number_separator,
988 &chars_per_number);
989 break;
990 case 'N':
991 skip_count = false;
992 getoptnum (optarg, INT_MIN, &start_line_num,
993 _("'-N NUMBER' invalid starting line number"));
994 break;
995 case 'o':
996 getoptnum (optarg, 0, &chars_per_margin,
997 _("'-o MARGIN' invalid line offset"));
998 break;
999 case 'r':
1000 ignore_failed_opens = true;
1001 break;
1002 case 's':
1003 old_options = true;
1004 old_s = true;
1005 if (!use_col_separator && optarg)
1006 separator_string (optarg);
1007 break;
1008 case 'S':
1009 old_s = false;
1010 /* Reset an additional input of -s, -S dominates -s */
1011 col_sep_string = "";
1012 col_sep_length = 0;
1013 use_col_separator = true;
1014 if (optarg)
1015 separator_string (optarg);
1016 break;
1017 case 't':
1018 extremities = false;
1019 keep_FF = true;
1020 break;
1021 case 'T':
1022 extremities = false;
1023 keep_FF = false;
1024 break;
1025 case 'v':
1026 use_esc_sequence = true;
1027 break;
1028 case 'w':
1029 old_options = true;
1030 old_w = true;
1032 int tmp_cpl;
1033 getoptnum (optarg, 1, &tmp_cpl,
1034 _("'-w PAGE_WIDTH' invalid number of characters"));
1035 if (! truncate_lines)
1036 chars_per_line = tmp_cpl;
1038 break;
1039 case 'W':
1040 old_w = false; /* dominates -w */
1041 truncate_lines = true;
1042 getoptnum (optarg, 1, &chars_per_line,
1043 _("'-W PAGE_WIDTH' invalid number of characters"));
1044 break;
1045 case_GETOPT_HELP_CHAR;
1046 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1047 default:
1048 usage (EXIT_FAILURE);
1049 break;
1053 if (column_count_string)
1055 parse_column_count (column_count_string);
1056 free (column_count_string);
1059 if (! date_format)
1060 date_format = (getenv ("POSIXLY_CORRECT") && !hard_locale (LC_TIME)
1061 ? "%b %e %H:%M %Y"
1062 : "%Y-%m-%d %H:%M");
1064 localtz = tzalloc (getenv ("TZ"));
1066 /* Now we can set a reasonable initial value: */
1067 if (first_page_number == 0)
1068 first_page_number = 1;
1070 if (parallel_files && explicit_columns)
1071 die (EXIT_FAILURE, 0,
1072 _("cannot specify number of columns when printing in parallel"));
1074 if (parallel_files && print_across_flag)
1075 die (EXIT_FAILURE, 0,
1076 _("cannot specify both printing across and printing in parallel"));
1078 /* Translate some old short options to new/long options.
1079 To meet downward compatibility with other UNIX pr utilities
1080 and some POSIX specifications. */
1082 if (old_options)
1084 if (old_w)
1086 if (parallel_files || explicit_columns)
1088 /* activate -W */
1089 truncate_lines = true;
1090 if (old_s)
1091 /* adapt HP-UX and SunOS: -s = no separator;
1092 activate -S */
1093 use_col_separator = true;
1095 else
1096 /* old -w sets width with columns only
1097 activate -J */
1098 join_lines = true;
1100 else if (!use_col_separator)
1102 /* No -S option read */
1103 if (old_s && (parallel_files || explicit_columns))
1105 if (!truncate_lines)
1107 /* old -s (without -w and -W) annuls column alignment,
1108 uses fields, activate -J */
1109 join_lines = true;
1110 if (col_sep_length > 0)
1111 /* activate -S */
1112 use_col_separator = true;
1114 else
1115 /* with -W */
1116 /* adapt HP-UX and SunOS: -s = no separator;
1117 activate -S */
1118 use_col_separator = true;
1123 for (; optind < argc; optind++)
1125 file_names[n_files++] = argv[optind];
1128 if (n_files == 0)
1130 /* No file arguments specified; read from standard input. */
1131 print_files (0, NULL);
1133 else
1135 if (parallel_files)
1136 print_files (n_files, file_names);
1137 else
1139 unsigned int i;
1140 for (i = 0; i < n_files; i++)
1141 print_files (1, &file_names[i]);
1145 cleanup ();
1146 IF_LINT (free (file_names));
1148 if (have_read_stdin && fclose (stdin) == EOF)
1149 die (EXIT_FAILURE, errno, _("standard input"));
1150 return failed_opens ? EXIT_FAILURE : EXIT_SUCCESS;
1153 /* Parse numeric arguments, ensuring MIN <= number <= INT_MAX. */
1155 static void
1156 getoptnum (const char *n_str, int min, int *num, const char *err)
1158 intmax_t tnum = xdectoimax (n_str, min, INT_MAX, "", err, 0);
1159 *num = tnum;
1162 /* Parse options of the form -scNNN.
1164 Example: -nck, where 'n' is the option, c is the optional number
1165 separator, and k is the optional width of the field used when printing
1166 a number. */
1168 static void
1169 getoptarg (char *arg, char switch_char, char *character, int *number)
1171 if (!ISDIGIT (*arg))
1172 *character = *arg++;
1173 if (*arg)
1175 long int tmp_long;
1176 if (xstrtol (arg, NULL, 10, &tmp_long, "") != LONGINT_OK
1177 || tmp_long <= 0 || INT_MAX < tmp_long)
1179 error (0, INT_MAX < tmp_long ? EOVERFLOW : errno,
1180 _("'-%c' extra characters or invalid number in the argument: %s"),
1181 switch_char, quote (arg));
1182 usage (EXIT_FAILURE);
1184 *number = tmp_long;
1188 /* Set parameters related to formatting. */
1190 static void
1191 init_parameters (int number_of_files)
1193 int chars_used_by_number = 0;
1195 lines_per_body = lines_per_page - lines_per_header - lines_per_footer;
1196 if (lines_per_body <= 0)
1198 extremities = false;
1199 keep_FF = true;
1201 if (extremities == false)
1202 lines_per_body = lines_per_page;
1204 if (double_space)
1205 lines_per_body = lines_per_body / 2;
1207 /* If input is stdin, cannot print parallel files. BSD dumps core
1208 on this. */
1209 if (number_of_files == 0)
1210 parallel_files = false;
1212 if (parallel_files)
1213 columns = number_of_files;
1215 /* One file, multi columns down: -b option is set to get a consistent
1216 formulation with "FF set by hand" in input files. */
1217 if (storing_columns)
1218 balance_columns = true;
1220 /* Tabification is assumed for multiple columns. */
1221 if (columns > 1)
1223 if (!use_col_separator)
1225 /* Use default separator */
1226 if (join_lines)
1227 col_sep_string = line_separator;
1228 else
1229 col_sep_string = column_separator;
1231 col_sep_length = 1;
1232 use_col_separator = true;
1234 /* It's rather pointless to define a TAB separator with column
1235 alignment */
1236 else if (!join_lines && col_sep_length == 1 && *col_sep_string == '\t')
1237 col_sep_string = column_separator;
1239 truncate_lines = true;
1240 tabify_output = true;
1242 else
1243 storing_columns = false;
1245 /* -J dominates -w in any case */
1246 if (join_lines)
1247 truncate_lines = false;
1249 if (numbered_lines)
1251 int chars_per_default_tab = 8;
1253 line_count = start_line_num;
1255 /* To allow input tab-expansion (-e sensitive) use:
1256 if (number_separator == input_tab_char)
1257 number_width = chars_per_number
1258 + TAB_WIDTH (chars_per_input_tab, chars_per_number); */
1260 /* Estimate chars_per_text without any margin and keep it constant. */
1261 if (number_separator == '\t')
1262 number_width = (chars_per_number
1263 + TAB_WIDTH (chars_per_default_tab, chars_per_number));
1264 else
1265 number_width = chars_per_number + 1;
1267 /* The number is part of the column width unless we are
1268 printing files in parallel. */
1269 if (parallel_files)
1270 chars_used_by_number = number_width;
1273 int sep_chars, useful_chars;
1274 if (INT_MULTIPLY_WRAPV (columns - 1, col_sep_length, &sep_chars))
1275 sep_chars = INT_MAX;
1276 if (INT_SUBTRACT_WRAPV (chars_per_line - chars_used_by_number, sep_chars,
1277 &useful_chars))
1278 useful_chars = 0;
1279 chars_per_column = useful_chars / columns;
1281 if (chars_per_column < 1)
1282 die (EXIT_FAILURE, 0, _("page width too narrow"));
1284 if (numbered_lines)
1286 free (number_buff);
1287 number_buff = xmalloc (MAX (chars_per_number,
1288 INT_STRLEN_BOUND (line_number)) + 1);
1291 /* Pick the maximum between the tab width and the width of an
1292 escape sequence.
1293 The width of an escape sequence (4) isn't the lower limit any longer.
1294 We've to use 8 as the lower limit, if we use chars_per_default_tab = 8
1295 to expand a tab which is not an input_tab-char. */
1296 free (clump_buff);
1297 clump_buff = xmalloc (MAX (8, chars_per_input_tab));
1300 /* Open the necessary files,
1301 maintaining a COLUMN structure for each column.
1303 With multiple files, each column p has a different p->fp.
1304 With single files, each column p has the same p->fp.
1305 Return false if (number_of_files > 0) and no files can be opened,
1306 true otherwise.
1308 With each column/file p, p->full_page_printed is initialized,
1309 see also open_file. */
1311 static bool
1312 init_fps (int number_of_files, char **av)
1314 int i, files_left;
1315 COLUMN *p;
1316 FILE *firstfp;
1317 char const *firstname;
1319 total_files = 0;
1321 free (column_vector);
1322 column_vector = xnmalloc (columns, sizeof (COLUMN));
1324 if (parallel_files)
1326 files_left = number_of_files;
1327 for (p = column_vector; files_left--; ++p, ++av)
1329 if (! open_file (*av, p))
1331 --p;
1332 --columns;
1335 if (columns == 0)
1336 return false;
1337 init_header ("", -1);
1339 else
1341 p = column_vector;
1342 if (number_of_files > 0)
1344 if (! open_file (*av, p))
1345 return false;
1346 init_header (*av, fileno (p->fp));
1347 p->lines_stored = 0;
1349 else
1351 p->name = _("standard input");
1352 p->fp = stdin;
1353 have_read_stdin = true;
1354 p->status = OPEN;
1355 p->full_page_printed = false;
1356 ++total_files;
1357 init_header ("", -1);
1358 p->lines_stored = 0;
1361 firstname = p->name;
1362 firstfp = p->fp;
1363 for (i = columns - 1, ++p; i; --i, ++p)
1365 p->name = firstname;
1366 p->fp = firstfp;
1367 p->status = OPEN;
1368 p->full_page_printed = false;
1369 p->lines_stored = 0;
1372 files_ready_to_read = total_files;
1373 return true;
1376 /* Determine print_func and char_func, the functions
1377 used by each column for printing and/or storing.
1379 Determine the horizontal position desired when we begin
1380 printing a column (p->start_position). */
1382 static void
1383 init_funcs (void)
1385 int i, h, h_next;
1386 COLUMN *p;
1388 h = chars_per_margin;
1390 if (!truncate_lines)
1391 h_next = ANYWHERE;
1392 else
1394 /* When numbering lines of parallel files, we enlarge the
1395 first column to accommodate the number. Looks better than
1396 the Sys V approach. */
1397 if (parallel_files && numbered_lines)
1398 h_next = h + chars_per_column + number_width;
1399 else
1400 h_next = h + chars_per_column;
1403 /* Enlarge p->start_position of first column to use the same form of
1404 padding_not_printed with all columns. */
1405 h = h + col_sep_length;
1407 /* This loop takes care of all but the rightmost column. */
1409 for (p = column_vector, i = 1; i < columns; ++p, ++i)
1411 if (storing_columns) /* One file, multi columns down. */
1413 p->char_func = store_char;
1414 p->print_func = print_stored;
1416 else
1417 /* One file, multi columns across; or parallel files. */
1419 p->char_func = print_char;
1420 p->print_func = read_line;
1423 /* Number only the first column when printing files in
1424 parallel. */
1425 p->numbered = numbered_lines && (!parallel_files || i == 1);
1426 p->start_position = h;
1428 /* If we don't truncate lines, all start_positions are
1429 ANYWHERE, except the first column's start_position when
1430 using a margin. */
1432 if (!truncate_lines)
1434 h = ANYWHERE;
1435 h_next = ANYWHERE;
1437 else
1439 h = h_next + col_sep_length;
1440 h_next = h + chars_per_column;
1444 /* The rightmost column.
1446 Doesn't need to be stored unless we intend to balance
1447 columns on the last page. */
1448 if (storing_columns && balance_columns)
1450 p->char_func = store_char;
1451 p->print_func = print_stored;
1453 else
1455 p->char_func = print_char;
1456 p->print_func = read_line;
1459 p->numbered = numbered_lines && (!parallel_files || i == 1);
1460 p->start_position = h;
1463 /* Open a file. Return true if successful.
1465 With each file p, p->full_page_printed is initialized,
1466 see also init_fps. */
1468 static bool
1469 open_file (char *name, COLUMN *p)
1471 if (STREQ (name, "-"))
1473 p->name = _("standard input");
1474 p->fp = stdin;
1475 have_read_stdin = true;
1477 else
1479 p->name = name;
1480 p->fp = fopen (name, "r");
1482 if (p->fp == NULL)
1484 failed_opens = true;
1485 if (!ignore_failed_opens)
1486 error (0, errno, "%s", quotef (name));
1487 return false;
1489 fadvise (p->fp, FADVISE_SEQUENTIAL);
1490 p->status = OPEN;
1491 p->full_page_printed = false;
1492 ++total_files;
1493 return true;
1496 /* Close the file in P.
1498 If we aren't dealing with multiple files in parallel, we change
1499 the status of all columns in the column list to reflect the close. */
1501 static void
1502 close_file (COLUMN *p)
1504 COLUMN *q;
1505 int i;
1507 if (p->status == CLOSED)
1508 return;
1509 if (ferror (p->fp))
1510 die (EXIT_FAILURE, errno, "%s", quotef (p->name));
1511 if (fileno (p->fp) != STDIN_FILENO && fclose (p->fp) != 0)
1512 die (EXIT_FAILURE, errno, "%s", quotef (p->name));
1514 if (!parallel_files)
1516 for (q = column_vector, i = columns; i; ++q, --i)
1518 q->status = CLOSED;
1519 if (q->lines_stored == 0)
1521 q->lines_to_print = 0;
1525 else
1527 p->status = CLOSED;
1528 p->lines_to_print = 0;
1531 --files_ready_to_read;
1534 /* Put a file on hold until we start a new page,
1535 since we've hit a form feed.
1537 If we aren't dealing with parallel files, we must change the
1538 status of all columns in the column list. */
1540 static void
1541 hold_file (COLUMN *p)
1543 COLUMN *q;
1544 int i;
1546 if (!parallel_files)
1547 for (q = column_vector, i = columns; i; ++q, --i)
1549 if (storing_columns)
1550 q->status = FF_FOUND;
1551 else
1552 q->status = ON_HOLD;
1554 else
1555 p->status = ON_HOLD;
1557 p->lines_to_print = 0;
1558 --files_ready_to_read;
1561 /* Undo hold_file -- go through the column list and change any
1562 ON_HOLD columns to OPEN. Used at the end of each page. */
1564 static void
1565 reset_status (void)
1567 int i = columns;
1568 COLUMN *p;
1570 for (p = column_vector; i; --i, ++p)
1571 if (p->status == ON_HOLD)
1573 p->status = OPEN;
1574 files_ready_to_read++;
1577 if (storing_columns)
1579 if (column_vector->status == CLOSED)
1580 /* We use the info to output an error message in skip_to_page. */
1581 files_ready_to_read = 0;
1582 else
1583 files_ready_to_read = 1;
1587 /* Print a single file, or multiple files in parallel.
1589 Set up the list of columns, opening the necessary files.
1590 Allocate space for storing columns, if necessary.
1591 Skip to first_page_number, if user has asked to skip leading pages.
1592 Determine which functions are appropriate to store/print lines
1593 in each column.
1594 Print the file(s). */
1596 static void
1597 print_files (int number_of_files, char **av)
1599 init_parameters (number_of_files);
1600 if (! init_fps (number_of_files, av))
1601 return;
1602 if (storing_columns)
1603 init_store_cols ();
1605 if (first_page_number > 1)
1607 if (!skip_to_page (first_page_number))
1608 return;
1609 else
1610 page_number = first_page_number;
1612 else
1613 page_number = 1;
1615 init_funcs ();
1617 line_number = line_count;
1618 while (print_page ())
1622 /* Initialize header information.
1623 If DESC is non-negative, it is a file descriptor open to
1624 FILENAME for reading. */
1626 static void
1627 init_header (char const *filename, int desc)
1629 char *buf = NULL;
1630 struct stat st;
1631 struct timespec t;
1632 int ns;
1633 struct tm tm;
1635 /* If parallel files or standard input, use current date. */
1636 if (STREQ (filename, "-"))
1637 desc = -1;
1638 if (0 <= desc && fstat (desc, &st) == 0)
1639 t = get_stat_mtime (&st);
1640 else
1642 static struct timespec timespec;
1643 if (! timespec.tv_sec)
1644 gettime (&timespec);
1645 t = timespec;
1648 ns = t.tv_nsec;
1649 if (localtime_rz (localtz, &t.tv_sec, &tm))
1651 size_t bufsize
1652 = nstrftime (NULL, SIZE_MAX, date_format, &tm, localtz, ns) + 1;
1653 buf = xmalloc (bufsize);
1654 nstrftime (buf, bufsize, date_format, &tm, localtz, ns);
1656 else
1658 char secbuf[INT_BUFSIZE_BOUND (intmax_t)];
1659 buf = xmalloc (sizeof secbuf + MAX (10, INT_BUFSIZE_BOUND (int)));
1660 sprintf (buf, "%s.%09d", timetostr (t.tv_sec, secbuf), ns);
1663 free (date_text);
1664 date_text = buf;
1665 file_text = custom_header ? custom_header : desc < 0 ? "" : filename;
1666 header_width_available = (chars_per_line
1667 - mbswidth (date_text, 0)
1668 - mbswidth (file_text, 0));
1671 /* Set things up for printing a page
1673 Scan through the columns ...
1674 Determine which are ready to print
1675 (i.e., which have lines stored or open files)
1676 Set p->lines_to_print appropriately
1677 (to p->lines_stored if we're storing, or lines_per_body
1678 if we're reading straight from the file)
1679 Keep track of this total so we know when to stop printing */
1681 static void
1682 init_page (void)
1684 int j;
1685 COLUMN *p;
1687 if (storing_columns)
1689 store_columns ();
1690 for (j = columns - 1, p = column_vector; j; --j, ++p)
1692 p->lines_to_print = p->lines_stored;
1695 /* Last column. */
1696 if (balance_columns)
1698 p->lines_to_print = p->lines_stored;
1700 /* Since we're not balancing columns, we don't need to store
1701 the rightmost column. Read it straight from the file. */
1702 else
1704 if (p->status == OPEN)
1706 p->lines_to_print = lines_per_body;
1708 else
1709 p->lines_to_print = 0;
1712 else
1713 for (j = columns, p = column_vector; j; --j, ++p)
1714 if (p->status == OPEN)
1716 p->lines_to_print = lines_per_body;
1718 else
1719 p->lines_to_print = 0;
1722 /* Align empty columns and print separators.
1723 Empty columns will be formed by files with status ON_HOLD or CLOSED
1724 when printing multiple files in parallel. */
1726 static void
1727 align_column (COLUMN *p)
1729 padding_not_printed = p->start_position;
1730 if (col_sep_length < padding_not_printed)
1732 pad_across_to (padding_not_printed - col_sep_length);
1733 padding_not_printed = ANYWHERE;
1736 if (use_col_separator)
1737 print_sep_string ();
1739 if (p->numbered)
1740 add_line_number (p);
1743 /* Print one page.
1745 As long as there are lines left on the page and columns ready to print,
1746 Scan across the column list
1747 if the column has stored lines or the file is open
1748 pad to the appropriate spot
1749 print the column
1750 pad the remainder of the page with \n or \f as requested
1751 reset the status of all files -- any files which where on hold because
1752 of formfeeds are now put back into the lineup. */
1754 static bool
1755 print_page (void)
1757 int j;
1758 int lines_left_on_page;
1759 COLUMN *p;
1761 /* Used as an accumulator (with | operator) of successive values of
1762 pad_vertically. The trick is to set pad_vertically
1763 to false before each run through the inner loop, then after that
1764 loop, it tells us whether a line was actually printed (whether a
1765 newline needs to be output -- or two for double spacing). But those
1766 values have to be accumulated (in pv) so we can invoke pad_down
1767 properly after the outer loop completes. */
1768 bool pv;
1770 init_page ();
1772 if (cols_ready_to_print () == 0)
1773 return false;
1775 if (extremities)
1776 print_a_header = true;
1778 /* Don't pad unless we know a page was printed. */
1779 pad_vertically = false;
1780 pv = false;
1782 lines_left_on_page = lines_per_body;
1783 if (double_space)
1784 lines_left_on_page *= 2;
1786 while (lines_left_on_page > 0 && cols_ready_to_print () > 0)
1788 output_position = 0;
1789 spaces_not_printed = 0;
1790 separators_not_printed = 0;
1791 pad_vertically = false;
1792 align_empty_cols = false;
1793 empty_line = true;
1795 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1797 input_position = 0;
1798 if (p->lines_to_print > 0 || p->status == FF_FOUND)
1800 FF_only = false;
1801 padding_not_printed = p->start_position;
1802 if (!(p->print_func) (p))
1803 read_rest_of_line (p);
1804 pv |= pad_vertically;
1806 --p->lines_to_print;
1807 if (p->lines_to_print <= 0)
1809 if (cols_ready_to_print () == 0)
1810 break;
1813 /* File p changed its status to ON_HOLD or CLOSED */
1814 if (parallel_files && p->status != OPEN)
1816 if (empty_line)
1817 align_empty_cols = true;
1818 else if (p->status == CLOSED
1819 || (p->status == ON_HOLD && FF_only))
1820 align_column (p);
1823 else if (parallel_files)
1825 /* File status ON_HOLD or CLOSED */
1826 if (empty_line)
1827 align_empty_cols = true;
1828 else
1829 align_column (p);
1832 /* We need it also with an empty column */
1833 if (use_col_separator)
1834 ++separators_not_printed;
1837 if (pad_vertically)
1839 putchar ('\n');
1840 --lines_left_on_page;
1843 if (cols_ready_to_print () == 0 && !extremities)
1844 break;
1846 if (double_space && pv)
1848 putchar ('\n');
1849 --lines_left_on_page;
1853 if (lines_left_on_page == 0)
1854 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1855 if (p->status == OPEN)
1856 p->full_page_printed = true;
1858 pad_vertically = pv;
1860 if (pad_vertically && extremities)
1861 pad_down (lines_left_on_page + lines_per_footer);
1862 else if (keep_FF && print_a_FF)
1864 putchar ('\f');
1865 print_a_FF = false;
1868 if (last_page_number < ++page_number)
1869 return false; /* Stop printing with LAST_PAGE */
1871 reset_status (); /* Change ON_HOLD to OPEN. */
1873 return true; /* More pages to go. */
1876 /* Allocate space for storing columns.
1878 This is necessary when printing multiple columns from a single file.
1879 Lines are stored consecutively in buff, separated by '\0'.
1881 The following doesn't apply any longer - any tuning possible?
1882 (We can't use a fixed offset since with the '-s' flag lines aren't
1883 truncated.)
1885 We maintain a list (line_vector) of pointers to the beginnings
1886 of lines in buff. We allocate one more than the number of lines
1887 because the last entry tells us the index of the last character,
1888 which we need to know in order to print the last line in buff. */
1890 static void
1891 init_store_cols (void)
1893 int total_lines, total_lines_1, chars_per_column_1, chars_if_truncate;
1894 if (INT_MULTIPLY_WRAPV (lines_per_body, columns, &total_lines)
1895 || INT_ADD_WRAPV (total_lines, 1, &total_lines_1)
1896 || INT_ADD_WRAPV (chars_per_column, 1, &chars_per_column_1)
1897 || INT_MULTIPLY_WRAPV (total_lines, chars_per_column_1,
1898 &chars_if_truncate))
1899 integer_overflow ();
1901 free (line_vector);
1902 /* FIXME: here's where it was allocated. */
1903 line_vector = xnmalloc (total_lines_1, sizeof *line_vector);
1905 free (end_vector);
1906 end_vector = xnmalloc (total_lines, sizeof *end_vector);
1908 free (buff);
1909 buff = xnmalloc (chars_if_truncate, use_col_separator + 1);
1910 buff_allocated = chars_if_truncate; /* Tune this. */
1911 buff_allocated *= use_col_separator + 1;
1914 /* Store all but the rightmost column.
1915 (Used when printing a single file in multiple downward columns)
1917 For each column
1918 set p->current_line to be the index in line_vector of the
1919 first line in the column
1920 For each line in the column
1921 store the line in buff
1922 add to line_vector the index of the line's first char
1923 buff_start is the index in buff of the first character in the
1924 current line. */
1926 static void
1927 store_columns (void)
1929 int i, j;
1930 unsigned int line = 0;
1931 unsigned int buff_start;
1932 int last_col; /* The rightmost column which will be saved in buff */
1933 COLUMN *p;
1935 buff_current = 0;
1936 buff_start = 0;
1938 if (balance_columns)
1939 last_col = columns;
1940 else
1941 last_col = columns - 1;
1943 for (i = 1, p = column_vector; i <= last_col; ++i, ++p)
1944 p->lines_stored = 0;
1946 for (i = 1, p = column_vector; i <= last_col && files_ready_to_read;
1947 ++i, ++p)
1949 p->current_line = line;
1950 for (j = lines_per_body; j && files_ready_to_read; --j)
1952 if (p->status == OPEN) /* Redundant. Clean up. */
1954 input_position = 0;
1956 if (!read_line (p))
1957 read_rest_of_line (p);
1959 if (p->status == OPEN
1960 || buff_start != buff_current)
1962 ++p->lines_stored;
1963 line_vector[line] = buff_start;
1964 end_vector[line++] = input_position;
1965 buff_start = buff_current;
1970 /* Keep track of the location of the last char in buff. */
1971 line_vector[line] = buff_start;
1973 if (balance_columns)
1974 balance (line);
1977 static void
1978 balance (int total_stored)
1980 COLUMN *p;
1981 int i, lines;
1982 int first_line = 0;
1984 for (i = 1, p = column_vector; i <= columns; ++i, ++p)
1986 lines = total_stored / columns;
1987 if (i <= total_stored % columns)
1988 ++lines;
1990 p->lines_stored = lines;
1991 p->current_line = first_line;
1993 first_line += lines;
1997 /* Store a character in the buffer. */
1999 static void
2000 store_char (char c)
2002 if (buff_current >= buff_allocated)
2004 /* May be too generous. */
2005 buff = X2REALLOC (buff, &buff_allocated);
2007 buff[buff_current++] = c;
2010 static void
2011 add_line_number (COLUMN *p)
2013 int i;
2014 char *s;
2015 int num_width;
2017 /* Cutting off the higher-order digits is more informative than
2018 lower-order cut off. */
2019 num_width = sprintf (number_buff, "%*d", chars_per_number, line_number);
2020 line_number++;
2021 s = number_buff + (num_width - chars_per_number);
2022 for (i = chars_per_number; i > 0; i--)
2023 (p->char_func) (*s++);
2025 if (columns > 1)
2027 /* Tabification is assumed for multiple columns, also for n-separators,
2028 but 'default n-separator = TAB' hasn't been given priority over
2029 equal column_width also specified by POSIX. */
2030 if (number_separator == '\t')
2032 i = number_width - chars_per_number;
2033 while (i-- > 0)
2034 (p->char_func) (' ');
2036 else
2037 (p->char_func) (number_separator);
2039 else
2040 /* To comply with POSIX, we avoid any expansion of default TAB
2041 separator with a single column output. No column_width requirement
2042 has to be considered. */
2044 (p->char_func) (number_separator);
2045 if (number_separator == '\t')
2046 output_position = POS_AFTER_TAB (chars_per_output_tab,
2047 output_position);
2050 if (truncate_lines && !parallel_files)
2051 input_position += number_width;
2054 /* Print (or store) padding until the current horizontal position
2055 is position. */
2057 static void
2058 pad_across_to (int position)
2060 int h = output_position;
2062 if (tabify_output)
2063 spaces_not_printed = position - output_position;
2064 else
2066 while (++h <= position)
2067 putchar (' ');
2068 output_position = position;
2072 /* Pad to the bottom of the page.
2074 If the user has requested a formfeed, use one.
2075 Otherwise, use newlines. */
2077 static void
2078 pad_down (unsigned int lines)
2080 unsigned int i;
2082 if (use_form_feed)
2083 putchar ('\f');
2084 else
2085 for (i = lines; i; --i)
2086 putchar ('\n');
2089 /* Read the rest of the line.
2091 Read from the current column's file until an end of line is
2092 hit. Used when we've truncated a line and we no longer need
2093 to print or store its characters. */
2095 static void
2096 read_rest_of_line (COLUMN *p)
2098 int c;
2099 FILE *f = p->fp;
2101 while ((c = getc (f)) != '\n')
2103 if (c == '\f')
2105 if ((c = getc (f)) != '\n')
2106 ungetc (c, f);
2107 if (keep_FF)
2108 print_a_FF = true;
2109 hold_file (p);
2110 break;
2112 else if (c == EOF)
2114 close_file (p);
2115 break;
2120 /* Read a line with skip_to_page.
2122 Read from the current column's file until an end of line is
2123 hit. Used when we read full lines to skip pages.
2124 With skip_to_page we have to check for FF-coincidence which is done
2125 in function read_line otherwise.
2126 Count lines of skipped pages to find the line number of 1st page
2127 printed relative to 1st line of input file (start_line_num). */
2129 static void
2130 skip_read (COLUMN *p, int column_number)
2132 int c;
2133 FILE *f = p->fp;
2134 int i;
2135 bool single_ff = false;
2136 COLUMN *q;
2138 /* Read 1st character in a line or any character succeeding a FF */
2139 if ((c = getc (f)) == '\f' && p->full_page_printed)
2140 /* A FF-coincidence with a previous full_page_printed.
2141 To avoid an additional empty page, eliminate the FF */
2142 if ((c = getc (f)) == '\n')
2143 c = getc (f);
2145 p->full_page_printed = false;
2147 /* 1st character a FF means a single FF without any printable
2148 characters. Don't count it as a line with -n option. */
2149 if (c == '\f')
2150 single_ff = true;
2152 /* Preparing for a FF-coincidence: Maybe we finish that page
2153 without a FF found */
2154 if (last_line)
2155 p->full_page_printed = true;
2157 while (c != '\n')
2159 if (c == '\f')
2161 /* No FF-coincidence possible,
2162 no catching up of a FF-coincidence with next page */
2163 if (last_line)
2165 if (!parallel_files)
2166 for (q = column_vector, i = columns; i; ++q, --i)
2167 q->full_page_printed = false;
2168 else
2169 p->full_page_printed = false;
2172 if ((c = getc (f)) != '\n')
2173 ungetc (c, f);
2174 hold_file (p);
2175 break;
2177 else if (c == EOF)
2179 close_file (p);
2180 break;
2182 c = getc (f);
2185 if (skip_count)
2186 if ((!parallel_files || column_number == 1) && !single_ff)
2187 ++line_count;
2190 /* If we're tabifying output,
2192 When print_char encounters white space it keeps track
2193 of our desired horizontal position and delays printing
2194 until this function is called. */
2196 static void
2197 print_white_space (void)
2199 int h_new;
2200 int h_old = output_position;
2201 int goal = h_old + spaces_not_printed;
2203 while (goal - h_old > 1
2204 && (h_new = POS_AFTER_TAB (chars_per_output_tab, h_old)) <= goal)
2206 putchar (output_tab_char);
2207 h_old = h_new;
2209 while (++h_old <= goal)
2210 putchar (' ');
2212 output_position = goal;
2213 spaces_not_printed = 0;
2216 /* Print column separators.
2218 We keep a count until we know that we'll be printing a line,
2219 then print_sep_string() is called. */
2221 static void
2222 print_sep_string (void)
2224 char const *s = col_sep_string;
2225 int l = col_sep_length;
2227 if (separators_not_printed <= 0)
2229 /* We'll be starting a line with chars_per_margin, anything else? */
2230 if (spaces_not_printed > 0)
2231 print_white_space ();
2233 else
2235 for (; separators_not_printed > 0; --separators_not_printed)
2237 while (l-- > 0)
2239 /* 3 types of sep_strings: spaces only, spaces and chars,
2240 chars only */
2241 if (*s == ' ')
2243 /* We're tabifying output; consecutive spaces in
2244 sep_string may have to be converted to tabs */
2245 s++;
2246 ++spaces_not_printed;
2248 else
2250 if (spaces_not_printed > 0)
2251 print_white_space ();
2252 putchar (*s++);
2253 ++output_position;
2256 /* sep_string ends with some spaces */
2257 if (spaces_not_printed > 0)
2258 print_white_space ();
2263 /* Print (or store, depending on p->char_func) a clump of N
2264 characters. */
2266 static void
2267 print_clump (COLUMN *p, int n, char *clump)
2269 while (n--)
2270 (p->char_func) (*clump++);
2273 /* Print a character.
2275 Update the following comment: process-char hasn't been used any
2276 longer.
2277 If we're tabifying, all tabs have been converted to spaces by
2278 process_char(). Keep a count of consecutive spaces, and when
2279 a nonspace is encountered, call print_white_space() to print the
2280 required number of tabs and spaces. */
2282 static void
2283 print_char (char c)
2285 if (tabify_output)
2287 if (c == ' ')
2289 ++spaces_not_printed;
2290 return;
2292 else if (spaces_not_printed > 0)
2293 print_white_space ();
2295 /* Nonprintables are assumed to have width 0, except '\b'. */
2296 if (! isprint (to_uchar (c)))
2298 if (c == '\b')
2299 --output_position;
2301 else
2302 ++output_position;
2304 putchar (c);
2307 /* Skip to page PAGE before printing.
2308 PAGE may be larger than total number of pages. */
2310 static bool
2311 skip_to_page (uintmax_t page)
2313 uintmax_t n;
2314 int i;
2315 int j;
2316 COLUMN *p;
2318 for (n = 1; n < page; ++n)
2320 for (i = 1; i < lines_per_body; ++i)
2322 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2323 if (p->status == OPEN)
2324 skip_read (p, j);
2326 last_line = true;
2327 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2328 if (p->status == OPEN)
2329 skip_read (p, j);
2331 if (storing_columns) /* change FF_FOUND to ON_HOLD */
2332 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2333 if (p->status != CLOSED)
2334 p->status = ON_HOLD;
2336 reset_status ();
2337 last_line = false;
2339 if (files_ready_to_read < 1)
2341 /* It's very helpful, normally the total number of pages is
2342 not known in advance. */
2343 error (0, 0,
2344 _("starting page number %"PRIuMAX
2345 " exceeds page count %"PRIuMAX),
2346 page, n);
2347 break;
2350 return files_ready_to_read > 0;
2353 /* Print a header.
2355 Formfeeds are assumed to use up two lines at the beginning of
2356 the page. */
2358 static void
2359 print_header (void)
2361 char page_text[256 + INT_STRLEN_BOUND (page_number)];
2362 int available_width;
2363 int lhs_spaces;
2364 int rhs_spaces;
2366 output_position = 0;
2367 pad_across_to (chars_per_margin);
2368 print_white_space ();
2370 if (page_number == 0)
2371 die (EXIT_FAILURE, 0, _("page number overflow"));
2373 /* The translator must ensure that formatting the translation of
2374 "Page %"PRIuMAX does not generate more than (sizeof page_text - 1)
2375 bytes. */
2376 sprintf (page_text, _("Page %"PRIuMAX), page_number);
2377 available_width = header_width_available - mbswidth (page_text, 0);
2378 available_width = MAX (0, available_width);
2379 lhs_spaces = available_width >> 1;
2380 rhs_spaces = available_width - lhs_spaces;
2382 printf ("\n\n%*s%s%*s%s%*s%s\n\n\n",
2383 chars_per_margin, "",
2384 date_text, lhs_spaces, " ",
2385 file_text, rhs_spaces, " ", page_text);
2387 print_a_header = false;
2388 output_position = 0;
2391 /* Print (or store, if p->char_func is store_char()) a line.
2393 Read a character to determine whether we have a line or not.
2394 (We may hit EOF, \n, or \f)
2396 Once we know we have a line,
2397 set pad_vertically = true, meaning it's safe
2398 to pad down at the end of the page, since we do have a page.
2399 print a header if needed.
2400 pad across to padding_not_printed if needed.
2401 print any separators which need to be printed.
2402 print a line number if it needs to be printed.
2404 Print the clump which corresponds to the first character.
2406 Enter a loop and keep printing until an end of line condition
2407 exists, or until we exceed chars_per_column.
2409 Return false if we exceed chars_per_column before reading
2410 an end of line character, true otherwise. */
2412 static bool
2413 read_line (COLUMN *p)
2415 int c;
2416 int chars IF_LINT ( = 0);
2417 int last_input_position;
2418 int j, k;
2419 COLUMN *q;
2421 /* read 1st character in each line or any character succeeding a FF: */
2422 c = getc (p->fp);
2424 last_input_position = input_position;
2426 if (c == '\f' && p->full_page_printed)
2427 if ((c = getc (p->fp)) == '\n')
2428 c = getc (p->fp);
2429 p->full_page_printed = false;
2431 switch (c)
2433 case '\f':
2434 if ((c = getc (p->fp)) != '\n')
2435 ungetc (c, p->fp);
2436 FF_only = true;
2437 if (print_a_header && !storing_columns)
2439 pad_vertically = true;
2440 print_header ();
2442 else if (keep_FF)
2443 print_a_FF = true;
2444 hold_file (p);
2445 return true;
2446 case EOF:
2447 close_file (p);
2448 return true;
2449 case '\n':
2450 break;
2451 default:
2452 chars = char_to_clump (c);
2455 if (truncate_lines && input_position > chars_per_column)
2457 input_position = last_input_position;
2458 return false;
2461 if (p->char_func != store_char)
2463 pad_vertically = true;
2465 if (print_a_header && !storing_columns)
2466 print_header ();
2468 if (parallel_files && align_empty_cols)
2470 /* We have to align empty columns at the beginning of a line. */
2471 k = separators_not_printed;
2472 separators_not_printed = 0;
2473 for (j = 1, q = column_vector; j <= k; ++j, ++q)
2475 align_column (q);
2476 separators_not_printed += 1;
2478 padding_not_printed = p->start_position;
2479 if (truncate_lines)
2480 spaces_not_printed = chars_per_column;
2481 else
2482 spaces_not_printed = 0;
2483 align_empty_cols = false;
2486 if (col_sep_length < padding_not_printed)
2488 pad_across_to (padding_not_printed - col_sep_length);
2489 padding_not_printed = ANYWHERE;
2492 if (use_col_separator)
2493 print_sep_string ();
2496 if (p->numbered)
2497 add_line_number (p);
2499 empty_line = false;
2500 if (c == '\n')
2501 return true;
2503 print_clump (p, chars, clump_buff);
2505 while (true)
2507 c = getc (p->fp);
2509 switch (c)
2511 case '\n':
2512 return true;
2513 case '\f':
2514 if ((c = getc (p->fp)) != '\n')
2515 ungetc (c, p->fp);
2516 if (keep_FF)
2517 print_a_FF = true;
2518 hold_file (p);
2519 return true;
2520 case EOF:
2521 close_file (p);
2522 return true;
2525 last_input_position = input_position;
2526 chars = char_to_clump (c);
2527 if (truncate_lines && input_position > chars_per_column)
2529 input_position = last_input_position;
2530 return false;
2533 print_clump (p, chars, clump_buff);
2537 /* Print a line from buff.
2539 If this function has been called, we know we have "something to
2540 print". But it remains to be seen whether we have a real text page
2541 or an empty page (a single form feed) with/without a header only.
2542 Therefore first we set pad_vertically to true and print a header
2543 if necessary.
2544 If FF_FOUND and we are using -t|-T option we omit any newline by
2545 setting pad_vertically to false (see print_page).
2546 Otherwise we pad across if necessary, print separators if necessary
2547 and text of COLUMN *p.
2549 Return true, meaning there is no need to call read_rest_of_line. */
2551 static bool
2552 print_stored (COLUMN *p)
2554 COLUMN *q;
2555 int i;
2557 int line = p->current_line++;
2558 char *first = &buff[line_vector[line]];
2559 /* FIXME
2560 UMR: Uninitialized memory read:
2561 * This is occurring while in:
2562 print_stored [pr.c:2239]
2563 * Reading 4 bytes from 0x5148c in the heap.
2564 * Address 0x5148c is 4 bytes into a malloc'd block at 0x51488 of 676 bytes
2565 * This block was allocated from:
2566 malloc [rtlib.o]
2567 xmalloc [xmalloc.c:94]
2568 init_store_cols [pr.c:1648]
2570 char *last = &buff[line_vector[line + 1]];
2572 pad_vertically = true;
2574 if (print_a_header)
2575 print_header ();
2577 if (p->status == FF_FOUND)
2579 for (i = 1, q = column_vector; i <= columns; ++i, ++q)
2580 q->status = ON_HOLD;
2581 if (column_vector->lines_to_print <= 0)
2583 if (!extremities)
2584 pad_vertically = false;
2585 return true; /* print a header only */
2589 if (col_sep_length < padding_not_printed)
2591 pad_across_to (padding_not_printed - col_sep_length);
2592 padding_not_printed = ANYWHERE;
2595 if (use_col_separator)
2596 print_sep_string ();
2598 while (first != last)
2599 print_char (*first++);
2601 if (spaces_not_printed == 0)
2603 output_position = p->start_position + end_vector[line];
2604 if (p->start_position - col_sep_length == chars_per_margin)
2605 output_position -= col_sep_length;
2608 return true;
2611 /* Convert a character to the proper format and return the number of
2612 characters in the resulting clump. Increment input_position by
2613 the width of the clump.
2615 Tabs are converted to clumps of spaces.
2616 Nonprintable characters may be converted to clumps of escape
2617 sequences or control prefixes.
2619 Note: the width of a clump is not necessarily equal to the number of
2620 characters in clump_buff. (e.g, the width of '\b' is -1, while the
2621 number of characters is 1.) */
2623 static int
2624 char_to_clump (char c)
2626 unsigned char uc = c;
2627 char *s = clump_buff;
2628 int i;
2629 char esc_buff[4];
2630 int width;
2631 int chars;
2632 int chars_per_c = 8;
2634 if (c == input_tab_char)
2635 chars_per_c = chars_per_input_tab;
2637 if (c == input_tab_char || c == '\t')
2639 width = TAB_WIDTH (chars_per_c, input_position);
2641 if (untabify_input)
2643 for (i = width; i; --i)
2644 *s++ = ' ';
2645 chars = width;
2647 else
2649 *s = c;
2650 chars = 1;
2654 else if (! isprint (uc))
2656 if (use_esc_sequence)
2658 width = 4;
2659 chars = 4;
2660 *s++ = '\\';
2661 sprintf (esc_buff, "%03o", uc);
2662 for (i = 0; i <= 2; ++i)
2663 *s++ = esc_buff[i];
2665 else if (use_cntrl_prefix)
2667 if (uc < 0200)
2669 width = 2;
2670 chars = 2;
2671 *s++ = '^';
2672 *s = c ^ 0100;
2674 else
2676 width = 4;
2677 chars = 4;
2678 *s++ = '\\';
2679 sprintf (esc_buff, "%03o", uc);
2680 for (i = 0; i <= 2; ++i)
2681 *s++ = esc_buff[i];
2684 else if (c == '\b')
2686 width = -1;
2687 chars = 1;
2688 *s = c;
2690 else
2692 width = 0;
2693 chars = 1;
2694 *s = c;
2697 else
2699 width = 1;
2700 chars = 1;
2701 *s = c;
2704 /* Too many backspaces must put us in position 0 -- never negative. */
2705 if (width < 0 && input_position == 0)
2707 chars = 0;
2708 input_position = 0;
2710 else if (width < 0 && input_position <= -width)
2711 input_position = 0;
2712 else
2713 input_position += width;
2715 return chars;
2718 /* We've just printed some files and need to clean up things before
2719 looking for more options and printing the next batch of files.
2721 Free everything we've xmalloc'ed, except 'header'. */
2723 static void
2724 cleanup (void)
2726 free (number_buff);
2727 free (clump_buff);
2728 free (column_vector);
2729 free (line_vector);
2730 free (end_vector);
2731 free (buff);
2734 /* Complain, print a usage message, and die. */
2736 void
2737 usage (int status)
2739 if (status != EXIT_SUCCESS)
2740 emit_try_help ();
2741 else
2743 printf (_("\
2744 Usage: %s [OPTION]... [FILE]...\n\
2746 program_name);
2748 fputs (_("\
2749 Paginate or columnate FILE(s) for printing.\n\
2750 "), stdout);
2752 emit_stdin_note ();
2753 emit_mandatory_arg_note ();
2755 fputs (_("\
2756 +FIRST_PAGE[:LAST_PAGE], --pages=FIRST_PAGE[:LAST_PAGE]\n\
2757 begin [stop] printing with page FIRST_[LAST_]PAGE\n\
2758 -COLUMN, --columns=COLUMN\n\
2759 output COLUMN columns and print columns down,\n\
2760 unless -a is used. Balance number of lines in the\n\
2761 columns on each page\n\
2762 "), stdout);
2763 fputs (_("\
2764 -a, --across print columns across rather than down, used together\n\
2765 with -COLUMN\n\
2766 -c, --show-control-chars\n\
2767 use hat notation (^G) and octal backslash notation\n\
2768 -d, --double-space\n\
2769 double space the output\n\
2770 "), stdout);
2771 fputs (_("\
2772 -D, --date-format=FORMAT\n\
2773 use FORMAT for the header date\n\
2774 -e[CHAR[WIDTH]], --expand-tabs[=CHAR[WIDTH]]\n\
2775 expand input CHARs (TABs) to tab WIDTH (8)\n\
2776 -F, -f, --form-feed\n\
2777 use form feeds instead of newlines to separate pages\n\
2778 (by a 3-line page header with -F or a 5-line header\n\
2779 and trailer without -F)\n\
2780 "), stdout);
2781 fputs (_("\
2782 -h, --header=HEADER\n\
2783 use a centered HEADER instead of filename in page header,\n\
2784 -h \"\" prints a blank line, don't use -h\"\"\n\
2785 -i[CHAR[WIDTH]], --output-tabs[=CHAR[WIDTH]]\n\
2786 replace spaces with CHARs (TABs) to tab WIDTH (8)\n\
2787 -J, --join-lines merge full lines, turns off -W line truncation, no column\n\
2788 alignment, --sep-string[=STRING] sets separators\n\
2789 "), stdout);
2790 fputs (_("\
2791 -l, --length=PAGE_LENGTH\n\
2792 set the page length to PAGE_LENGTH (66) lines\n\
2793 (default number of lines of text 56, and with -F 63).\n\
2794 implies -t if PAGE_LENGTH <= 10\n\
2795 "), stdout);
2796 fputs (_("\
2797 -m, --merge print all files in parallel, one in each column,\n\
2798 truncate lines, but join lines of full length with -J\n\
2799 "), stdout);
2800 fputs (_("\
2801 -n[SEP[DIGITS]], --number-lines[=SEP[DIGITS]]\n\
2802 number lines, use DIGITS (5) digits, then SEP (TAB),\n\
2803 default counting starts with 1st line of input file\n\
2804 -N, --first-line-number=NUMBER\n\
2805 start counting with NUMBER at 1st line of first\n\
2806 page printed (see +FIRST_PAGE)\n\
2807 "), stdout);
2808 fputs (_("\
2809 -o, --indent=MARGIN\n\
2810 offset each line with MARGIN (zero) spaces, do not\n\
2811 affect -w or -W, MARGIN will be added to PAGE_WIDTH\n\
2812 -r, --no-file-warnings\n\
2813 omit warning when a file cannot be opened\n\
2814 "), stdout);
2815 fputs (_("\
2816 -s[CHAR], --separator[=CHAR]\n\
2817 separate columns by a single character, default for CHAR\n\
2818 is the <TAB> character without -w and \'no char\' with -w.\
2820 -s[CHAR] turns off line truncation of all 3 column\n\
2821 options (-COLUMN|-a -COLUMN|-m) except -w is set\n\
2822 "), stdout);
2823 fputs (_("\
2824 -S[STRING], --sep-string[=STRING]\n\
2825 separate columns by STRING,\n\
2826 without -S: Default separator <TAB> with -J and <space>\n\
2827 otherwise (same as -S\" \"), no effect on column options\n\
2828 "), stdout);
2829 fputs (_("\
2830 -t, --omit-header omit page headers and trailers;\n\
2831 implied if PAGE_LENGTH <= 10\n\
2832 "), stdout);
2833 fputs (_("\
2834 -T, --omit-pagination\n\
2835 omit page headers and trailers, eliminate any pagination\n\
2836 by form feeds set in input files\n\
2837 -v, --show-nonprinting\n\
2838 use octal backslash notation\n\
2839 -w, --width=PAGE_WIDTH\n\
2840 set page width to PAGE_WIDTH (72) characters for\n\
2841 multiple text-column output only, -s[char] turns off (72)\n\
2842 "), stdout);
2843 fputs (_("\
2844 -W, --page-width=PAGE_WIDTH\n\
2845 set page width to PAGE_WIDTH (72) characters always,\n\
2846 truncate lines, except -J option is set, no interference\n\
2847 with -S or -s\n\
2848 "), stdout);
2849 fputs (HELP_OPTION_DESCRIPTION, stdout);
2850 fputs (VERSION_OPTION_DESCRIPTION, stdout);
2851 emit_ancillary_info (PROGRAM_NAME);
2853 exit (status);