id: support multiple specified users
[coreutils.git] / src / pr.c
blob7d72b4198c55bd30a5470f16462f83ab0a95fcc2
1 /* pr -- convert text files for printing.
2 Copyright (C) 1988-2018 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 <https://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 for (unsigned int i = 0; i < n_files; i++)
1140 print_files (1, &file_names[i]);
1144 cleanup ();
1145 IF_LINT (free (file_names));
1147 if (have_read_stdin && fclose (stdin) == EOF)
1148 die (EXIT_FAILURE, errno, _("standard input"));
1149 return failed_opens ? EXIT_FAILURE : EXIT_SUCCESS;
1152 /* Parse numeric arguments, ensuring MIN <= number <= INT_MAX. */
1154 static void
1155 getoptnum (const char *n_str, int min, int *num, const char *err)
1157 intmax_t tnum = xdectoimax (n_str, min, INT_MAX, "", err, 0);
1158 *num = tnum;
1161 /* Parse options of the form -scNNN.
1163 Example: -nck, where 'n' is the option, c is the optional number
1164 separator, and k is the optional width of the field used when printing
1165 a number. */
1167 static void
1168 getoptarg (char *arg, char switch_char, char *character, int *number)
1170 if (!ISDIGIT (*arg))
1171 *character = *arg++;
1172 if (*arg)
1174 long int tmp_long;
1175 if (xstrtol (arg, NULL, 10, &tmp_long, "") != LONGINT_OK
1176 || tmp_long <= 0 || INT_MAX < tmp_long)
1178 error (0, INT_MAX < tmp_long ? EOVERFLOW : errno,
1179 _("'-%c' extra characters or invalid number in the argument: %s"),
1180 switch_char, quote (arg));
1181 usage (EXIT_FAILURE);
1183 *number = tmp_long;
1187 /* Set parameters related to formatting. */
1189 static void
1190 init_parameters (int number_of_files)
1192 int chars_used_by_number = 0;
1194 lines_per_body = lines_per_page - lines_per_header - lines_per_footer;
1195 if (lines_per_body <= 0)
1197 extremities = false;
1198 keep_FF = true;
1200 if (extremities == false)
1201 lines_per_body = lines_per_page;
1203 if (double_space)
1204 lines_per_body = lines_per_body / 2;
1206 /* If input is stdin, cannot print parallel files. BSD dumps core
1207 on this. */
1208 if (number_of_files == 0)
1209 parallel_files = false;
1211 if (parallel_files)
1212 columns = number_of_files;
1214 /* One file, multi columns down: -b option is set to get a consistent
1215 formulation with "FF set by hand" in input files. */
1216 if (storing_columns)
1217 balance_columns = true;
1219 /* Tabification is assumed for multiple columns. */
1220 if (columns > 1)
1222 if (!use_col_separator)
1224 /* Use default separator */
1225 if (join_lines)
1226 col_sep_string = line_separator;
1227 else
1228 col_sep_string = column_separator;
1230 col_sep_length = 1;
1231 use_col_separator = true;
1233 /* It's rather pointless to define a TAB separator with column
1234 alignment */
1235 else if (!join_lines && col_sep_length == 1 && *col_sep_string == '\t')
1236 col_sep_string = column_separator;
1238 truncate_lines = true;
1239 tabify_output = true;
1241 else
1242 storing_columns = false;
1244 /* -J dominates -w in any case */
1245 if (join_lines)
1246 truncate_lines = false;
1248 if (numbered_lines)
1250 int chars_per_default_tab = 8;
1252 line_count = start_line_num;
1254 /* To allow input tab-expansion (-e sensitive) use:
1255 if (number_separator == input_tab_char)
1256 number_width = chars_per_number
1257 + TAB_WIDTH (chars_per_input_tab, chars_per_number); */
1259 /* Estimate chars_per_text without any margin and keep it constant. */
1260 if (number_separator == '\t')
1261 number_width = (chars_per_number
1262 + TAB_WIDTH (chars_per_default_tab, chars_per_number));
1263 else
1264 number_width = chars_per_number + 1;
1266 /* The number is part of the column width unless we are
1267 printing files in parallel. */
1268 if (parallel_files)
1269 chars_used_by_number = number_width;
1272 int sep_chars, useful_chars;
1273 if (INT_MULTIPLY_WRAPV (columns - 1, col_sep_length, &sep_chars))
1274 sep_chars = INT_MAX;
1275 if (INT_SUBTRACT_WRAPV (chars_per_line - chars_used_by_number, sep_chars,
1276 &useful_chars))
1277 useful_chars = 0;
1278 chars_per_column = useful_chars / columns;
1280 if (chars_per_column < 1)
1281 die (EXIT_FAILURE, 0, _("page width too narrow"));
1283 if (numbered_lines)
1285 free (number_buff);
1286 number_buff = xmalloc (MAX (chars_per_number,
1287 INT_STRLEN_BOUND (line_number)) + 1);
1290 /* Pick the maximum between the tab width and the width of an
1291 escape sequence.
1292 The width of an escape sequence (4) isn't the lower limit any longer.
1293 We've to use 8 as the lower limit, if we use chars_per_default_tab = 8
1294 to expand a tab which is not an input_tab-char. */
1295 free (clump_buff);
1296 clump_buff = xmalloc (MAX (8, chars_per_input_tab));
1299 /* Open the necessary files,
1300 maintaining a COLUMN structure for each column.
1302 With multiple files, each column p has a different p->fp.
1303 With single files, each column p has the same p->fp.
1304 Return false if (number_of_files > 0) and no files can be opened,
1305 true otherwise.
1307 With each column/file p, p->full_page_printed is initialized,
1308 see also open_file. */
1310 static bool
1311 init_fps (int number_of_files, char **av)
1313 COLUMN *p;
1315 total_files = 0;
1317 free (column_vector);
1318 column_vector = xnmalloc (columns, sizeof (COLUMN));
1320 if (parallel_files)
1322 int files_left = number_of_files;
1323 for (p = column_vector; files_left--; ++p, ++av)
1325 if (! open_file (*av, p))
1327 --p;
1328 --columns;
1331 if (columns == 0)
1332 return false;
1333 init_header ("", -1);
1335 else
1337 p = column_vector;
1338 if (number_of_files > 0)
1340 if (! open_file (*av, p))
1341 return false;
1342 init_header (*av, fileno (p->fp));
1343 p->lines_stored = 0;
1345 else
1347 p->name = _("standard input");
1348 p->fp = stdin;
1349 have_read_stdin = true;
1350 p->status = OPEN;
1351 p->full_page_printed = false;
1352 ++total_files;
1353 init_header ("", -1);
1354 p->lines_stored = 0;
1357 char const *firstname = p->name;
1358 FILE *firstfp = p->fp;
1359 int i;
1360 for (i = columns - 1, ++p; i; --i, ++p)
1362 p->name = firstname;
1363 p->fp = firstfp;
1364 p->status = OPEN;
1365 p->full_page_printed = false;
1366 p->lines_stored = 0;
1369 files_ready_to_read = total_files;
1370 return true;
1373 /* Determine print_func and char_func, the functions
1374 used by each column for printing and/or storing.
1376 Determine the horizontal position desired when we begin
1377 printing a column (p->start_position). */
1379 static void
1380 init_funcs (void)
1382 int i, h, h_next;
1383 COLUMN *p;
1385 h = chars_per_margin;
1387 if (!truncate_lines)
1388 h_next = ANYWHERE;
1389 else
1391 /* When numbering lines of parallel files, we enlarge the
1392 first column to accommodate the number. Looks better than
1393 the Sys V approach. */
1394 if (parallel_files && numbered_lines)
1395 h_next = h + chars_per_column + number_width;
1396 else
1397 h_next = h + chars_per_column;
1400 /* Enlarge p->start_position of first column to use the same form of
1401 padding_not_printed with all columns. */
1402 h = h + col_sep_length;
1404 /* This loop takes care of all but the rightmost column. */
1406 for (p = column_vector, i = 1; i < columns; ++p, ++i)
1408 if (storing_columns) /* One file, multi columns down. */
1410 p->char_func = store_char;
1411 p->print_func = print_stored;
1413 else
1414 /* One file, multi columns across; or parallel files. */
1416 p->char_func = print_char;
1417 p->print_func = read_line;
1420 /* Number only the first column when printing files in
1421 parallel. */
1422 p->numbered = numbered_lines && (!parallel_files || i == 1);
1423 p->start_position = h;
1425 /* If we don't truncate lines, all start_positions are
1426 ANYWHERE, except the first column's start_position when
1427 using a margin. */
1429 if (!truncate_lines)
1431 h = ANYWHERE;
1432 h_next = ANYWHERE;
1434 else
1436 h = h_next + col_sep_length;
1437 h_next = h + chars_per_column;
1441 /* The rightmost column.
1443 Doesn't need to be stored unless we intend to balance
1444 columns on the last page. */
1445 if (storing_columns && balance_columns)
1447 p->char_func = store_char;
1448 p->print_func = print_stored;
1450 else
1452 p->char_func = print_char;
1453 p->print_func = read_line;
1456 p->numbered = numbered_lines && (!parallel_files || i == 1);
1457 p->start_position = h;
1460 /* Open a file. Return true if successful.
1462 With each file p, p->full_page_printed is initialized,
1463 see also init_fps. */
1465 static bool
1466 open_file (char *name, COLUMN *p)
1468 if (STREQ (name, "-"))
1470 p->name = _("standard input");
1471 p->fp = stdin;
1472 have_read_stdin = true;
1474 else
1476 p->name = name;
1477 p->fp = fopen (name, "r");
1479 if (p->fp == NULL)
1481 failed_opens = true;
1482 if (!ignore_failed_opens)
1483 error (0, errno, "%s", quotef (name));
1484 return false;
1486 fadvise (p->fp, FADVISE_SEQUENTIAL);
1487 p->status = OPEN;
1488 p->full_page_printed = false;
1489 ++total_files;
1490 return true;
1493 /* Close the file in P.
1495 If we aren't dealing with multiple files in parallel, we change
1496 the status of all columns in the column list to reflect the close. */
1498 static void
1499 close_file (COLUMN *p)
1501 COLUMN *q;
1502 int i;
1504 if (p->status == CLOSED)
1505 return;
1506 if (ferror (p->fp))
1507 die (EXIT_FAILURE, errno, "%s", quotef (p->name));
1508 if (fileno (p->fp) != STDIN_FILENO && fclose (p->fp) != 0)
1509 die (EXIT_FAILURE, errno, "%s", quotef (p->name));
1511 if (!parallel_files)
1513 for (q = column_vector, i = columns; i; ++q, --i)
1515 q->status = CLOSED;
1516 if (q->lines_stored == 0)
1518 q->lines_to_print = 0;
1522 else
1524 p->status = CLOSED;
1525 p->lines_to_print = 0;
1528 --files_ready_to_read;
1531 /* Put a file on hold until we start a new page,
1532 since we've hit a form feed.
1534 If we aren't dealing with parallel files, we must change the
1535 status of all columns in the column list. */
1537 static void
1538 hold_file (COLUMN *p)
1540 COLUMN *q;
1541 int i;
1543 if (!parallel_files)
1544 for (q = column_vector, i = columns; i; ++q, --i)
1546 if (storing_columns)
1547 q->status = FF_FOUND;
1548 else
1549 q->status = ON_HOLD;
1551 else
1552 p->status = ON_HOLD;
1554 p->lines_to_print = 0;
1555 --files_ready_to_read;
1558 /* Undo hold_file -- go through the column list and change any
1559 ON_HOLD columns to OPEN. Used at the end of each page. */
1561 static void
1562 reset_status (void)
1564 int i = columns;
1565 COLUMN *p;
1567 for (p = column_vector; i; --i, ++p)
1568 if (p->status == ON_HOLD)
1570 p->status = OPEN;
1571 files_ready_to_read++;
1574 if (storing_columns)
1576 if (column_vector->status == CLOSED)
1577 /* We use the info to output an error message in skip_to_page. */
1578 files_ready_to_read = 0;
1579 else
1580 files_ready_to_read = 1;
1584 /* Print a single file, or multiple files in parallel.
1586 Set up the list of columns, opening the necessary files.
1587 Allocate space for storing columns, if necessary.
1588 Skip to first_page_number, if user has asked to skip leading pages.
1589 Determine which functions are appropriate to store/print lines
1590 in each column.
1591 Print the file(s). */
1593 static void
1594 print_files (int number_of_files, char **av)
1596 init_parameters (number_of_files);
1597 if (! init_fps (number_of_files, av))
1598 return;
1599 if (storing_columns)
1600 init_store_cols ();
1602 if (first_page_number > 1)
1604 if (!skip_to_page (first_page_number))
1605 return;
1606 else
1607 page_number = first_page_number;
1609 else
1610 page_number = 1;
1612 init_funcs ();
1614 line_number = line_count;
1615 while (print_page ())
1619 /* Initialize header information.
1620 If DESC is non-negative, it is a file descriptor open to
1621 FILENAME for reading. */
1623 static void
1624 init_header (char const *filename, int desc)
1626 char *buf = NULL;
1627 struct stat st;
1628 struct timespec t;
1629 int ns;
1630 struct tm tm;
1632 /* If parallel files or standard input, use current date. */
1633 if (STREQ (filename, "-"))
1634 desc = -1;
1635 if (0 <= desc && fstat (desc, &st) == 0)
1636 t = get_stat_mtime (&st);
1637 else
1639 static struct timespec timespec;
1640 if (! timespec.tv_sec)
1641 gettime (&timespec);
1642 t = timespec;
1645 ns = t.tv_nsec;
1646 if (localtime_rz (localtz, &t.tv_sec, &tm))
1648 size_t bufsize
1649 = nstrftime (NULL, SIZE_MAX, date_format, &tm, localtz, ns) + 1;
1650 buf = xmalloc (bufsize);
1651 nstrftime (buf, bufsize, date_format, &tm, localtz, ns);
1653 else
1655 char secbuf[INT_BUFSIZE_BOUND (intmax_t)];
1656 buf = xmalloc (sizeof secbuf + MAX (10, INT_BUFSIZE_BOUND (int)));
1657 sprintf (buf, "%s.%09d", timetostr (t.tv_sec, secbuf), ns);
1660 free (date_text);
1661 date_text = buf;
1662 file_text = custom_header ? custom_header : desc < 0 ? "" : filename;
1663 header_width_available = (chars_per_line
1664 - mbswidth (date_text, 0)
1665 - mbswidth (file_text, 0));
1668 /* Set things up for printing a page
1670 Scan through the columns ...
1671 Determine which are ready to print
1672 (i.e., which have lines stored or open files)
1673 Set p->lines_to_print appropriately
1674 (to p->lines_stored if we're storing, or lines_per_body
1675 if we're reading straight from the file)
1676 Keep track of this total so we know when to stop printing */
1678 static void
1679 init_page (void)
1681 int j;
1682 COLUMN *p;
1684 if (storing_columns)
1686 store_columns ();
1687 for (j = columns - 1, p = column_vector; j; --j, ++p)
1689 p->lines_to_print = p->lines_stored;
1692 /* Last column. */
1693 if (balance_columns)
1695 p->lines_to_print = p->lines_stored;
1697 /* Since we're not balancing columns, we don't need to store
1698 the rightmost column. Read it straight from the file. */
1699 else
1701 if (p->status == OPEN)
1703 p->lines_to_print = lines_per_body;
1705 else
1706 p->lines_to_print = 0;
1709 else
1710 for (j = columns, p = column_vector; j; --j, ++p)
1711 if (p->status == OPEN)
1713 p->lines_to_print = lines_per_body;
1715 else
1716 p->lines_to_print = 0;
1719 /* Align empty columns and print separators.
1720 Empty columns will be formed by files with status ON_HOLD or CLOSED
1721 when printing multiple files in parallel. */
1723 static void
1724 align_column (COLUMN *p)
1726 padding_not_printed = p->start_position;
1727 if (col_sep_length < padding_not_printed)
1729 pad_across_to (padding_not_printed - col_sep_length);
1730 padding_not_printed = ANYWHERE;
1733 if (use_col_separator)
1734 print_sep_string ();
1736 if (p->numbered)
1737 add_line_number (p);
1740 /* Print one page.
1742 As long as there are lines left on the page and columns ready to print,
1743 Scan across the column list
1744 if the column has stored lines or the file is open
1745 pad to the appropriate spot
1746 print the column
1747 pad the remainder of the page with \n or \f as requested
1748 reset the status of all files -- any files which where on hold because
1749 of formfeeds are now put back into the lineup. */
1751 static bool
1752 print_page (void)
1754 int j;
1755 int lines_left_on_page;
1756 COLUMN *p;
1758 /* Used as an accumulator (with | operator) of successive values of
1759 pad_vertically. The trick is to set pad_vertically
1760 to false before each run through the inner loop, then after that
1761 loop, it tells us whether a line was actually printed (whether a
1762 newline needs to be output -- or two for double spacing). But those
1763 values have to be accumulated (in pv) so we can invoke pad_down
1764 properly after the outer loop completes. */
1765 bool pv;
1767 init_page ();
1769 if (cols_ready_to_print () == 0)
1770 return false;
1772 if (extremities)
1773 print_a_header = true;
1775 /* Don't pad unless we know a page was printed. */
1776 pad_vertically = false;
1777 pv = false;
1779 lines_left_on_page = lines_per_body;
1780 if (double_space)
1781 lines_left_on_page *= 2;
1783 while (lines_left_on_page > 0 && cols_ready_to_print () > 0)
1785 output_position = 0;
1786 spaces_not_printed = 0;
1787 separators_not_printed = 0;
1788 pad_vertically = false;
1789 align_empty_cols = false;
1790 empty_line = true;
1792 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1794 input_position = 0;
1795 if (p->lines_to_print > 0 || p->status == FF_FOUND)
1797 FF_only = false;
1798 padding_not_printed = p->start_position;
1799 if (!(p->print_func) (p))
1800 read_rest_of_line (p);
1801 pv |= pad_vertically;
1803 --p->lines_to_print;
1804 if (p->lines_to_print <= 0)
1806 if (cols_ready_to_print () == 0)
1807 break;
1810 /* File p changed its status to ON_HOLD or CLOSED */
1811 if (parallel_files && p->status != OPEN)
1813 if (empty_line)
1814 align_empty_cols = true;
1815 else if (p->status == CLOSED
1816 || (p->status == ON_HOLD && FF_only))
1817 align_column (p);
1820 else if (parallel_files)
1822 /* File status ON_HOLD or CLOSED */
1823 if (empty_line)
1824 align_empty_cols = true;
1825 else
1826 align_column (p);
1829 /* We need it also with an empty column */
1830 if (use_col_separator)
1831 ++separators_not_printed;
1834 if (pad_vertically)
1836 putchar ('\n');
1837 --lines_left_on_page;
1840 if (cols_ready_to_print () == 0 && !extremities)
1841 break;
1843 if (double_space && pv)
1845 putchar ('\n');
1846 --lines_left_on_page;
1850 if (lines_left_on_page == 0)
1851 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1852 if (p->status == OPEN)
1853 p->full_page_printed = true;
1855 pad_vertically = pv;
1857 if (pad_vertically && extremities)
1858 pad_down (lines_left_on_page + lines_per_footer);
1859 else if (keep_FF && print_a_FF)
1861 putchar ('\f');
1862 print_a_FF = false;
1865 if (last_page_number < ++page_number)
1866 return false; /* Stop printing with LAST_PAGE */
1868 reset_status (); /* Change ON_HOLD to OPEN. */
1870 return true; /* More pages to go. */
1873 /* Allocate space for storing columns.
1875 This is necessary when printing multiple columns from a single file.
1876 Lines are stored consecutively in buff, separated by '\0'.
1878 The following doesn't apply any longer - any tuning possible?
1879 (We can't use a fixed offset since with the '-s' flag lines aren't
1880 truncated.)
1882 We maintain a list (line_vector) of pointers to the beginnings
1883 of lines in buff. We allocate one more than the number of lines
1884 because the last entry tells us the index of the last character,
1885 which we need to know in order to print the last line in buff. */
1887 static void
1888 init_store_cols (void)
1890 int total_lines, total_lines_1, chars_per_column_1, chars_if_truncate;
1891 if (INT_MULTIPLY_WRAPV (lines_per_body, columns, &total_lines)
1892 || INT_ADD_WRAPV (total_lines, 1, &total_lines_1)
1893 || INT_ADD_WRAPV (chars_per_column, 1, &chars_per_column_1)
1894 || INT_MULTIPLY_WRAPV (total_lines, chars_per_column_1,
1895 &chars_if_truncate))
1896 integer_overflow ();
1898 free (line_vector);
1899 /* FIXME: here's where it was allocated. */
1900 line_vector = xnmalloc (total_lines_1, sizeof *line_vector);
1902 free (end_vector);
1903 end_vector = xnmalloc (total_lines, sizeof *end_vector);
1905 free (buff);
1906 buff = xnmalloc (chars_if_truncate, use_col_separator + 1);
1907 buff_allocated = chars_if_truncate; /* Tune this. */
1908 buff_allocated *= use_col_separator + 1;
1911 /* Store all but the rightmost column.
1912 (Used when printing a single file in multiple downward columns)
1914 For each column
1915 set p->current_line to be the index in line_vector of the
1916 first line in the column
1917 For each line in the column
1918 store the line in buff
1919 add to line_vector the index of the line's first char
1920 buff_start is the index in buff of the first character in the
1921 current line. */
1923 static void
1924 store_columns (void)
1926 int i, j;
1927 unsigned int line = 0;
1928 unsigned int buff_start;
1929 int last_col; /* The rightmost column which will be saved in buff */
1930 COLUMN *p;
1932 buff_current = 0;
1933 buff_start = 0;
1935 if (balance_columns)
1936 last_col = columns;
1937 else
1938 last_col = columns - 1;
1940 for (i = 1, p = column_vector; i <= last_col; ++i, ++p)
1941 p->lines_stored = 0;
1943 for (i = 1, p = column_vector; i <= last_col && files_ready_to_read;
1944 ++i, ++p)
1946 p->current_line = line;
1947 for (j = lines_per_body; j && files_ready_to_read; --j)
1949 if (p->status == OPEN) /* Redundant. Clean up. */
1951 input_position = 0;
1953 if (!read_line (p))
1954 read_rest_of_line (p);
1956 if (p->status == OPEN
1957 || buff_start != buff_current)
1959 ++p->lines_stored;
1960 line_vector[line] = buff_start;
1961 end_vector[line++] = input_position;
1962 buff_start = buff_current;
1967 /* Keep track of the location of the last char in buff. */
1968 line_vector[line] = buff_start;
1970 if (balance_columns)
1971 balance (line);
1974 static void
1975 balance (int total_stored)
1977 COLUMN *p;
1978 int i, lines;
1979 int first_line = 0;
1981 for (i = 1, p = column_vector; i <= columns; ++i, ++p)
1983 lines = total_stored / columns;
1984 if (i <= total_stored % columns)
1985 ++lines;
1987 p->lines_stored = lines;
1988 p->current_line = first_line;
1990 first_line += lines;
1994 /* Store a character in the buffer. */
1996 static void
1997 store_char (char c)
1999 if (buff_current >= buff_allocated)
2001 /* May be too generous. */
2002 buff = X2REALLOC (buff, &buff_allocated);
2004 buff[buff_current++] = c;
2007 static void
2008 add_line_number (COLUMN *p)
2010 int i;
2011 char *s;
2012 int num_width;
2014 /* Cutting off the higher-order digits is more informative than
2015 lower-order cut off. */
2016 num_width = sprintf (number_buff, "%*d", chars_per_number, line_number);
2017 line_number++;
2018 s = number_buff + (num_width - chars_per_number);
2019 for (i = chars_per_number; i > 0; i--)
2020 (p->char_func) (*s++);
2022 if (columns > 1)
2024 /* Tabification is assumed for multiple columns, also for n-separators,
2025 but 'default n-separator = TAB' hasn't been given priority over
2026 equal column_width also specified by POSIX. */
2027 if (number_separator == '\t')
2029 i = number_width - chars_per_number;
2030 while (i-- > 0)
2031 (p->char_func) (' ');
2033 else
2034 (p->char_func) (number_separator);
2036 else
2037 /* To comply with POSIX, we avoid any expansion of default TAB
2038 separator with a single column output. No column_width requirement
2039 has to be considered. */
2041 (p->char_func) (number_separator);
2042 if (number_separator == '\t')
2043 output_position = POS_AFTER_TAB (chars_per_output_tab,
2044 output_position);
2047 if (truncate_lines && !parallel_files)
2048 input_position += number_width;
2051 /* Print (or store) padding until the current horizontal position
2052 is position. */
2054 static void
2055 pad_across_to (int position)
2057 int h = output_position;
2059 if (tabify_output)
2060 spaces_not_printed = position - output_position;
2061 else
2063 while (++h <= position)
2064 putchar (' ');
2065 output_position = position;
2069 /* Pad to the bottom of the page.
2071 If the user has requested a formfeed, use one.
2072 Otherwise, use newlines. */
2074 static void
2075 pad_down (unsigned int lines)
2077 if (use_form_feed)
2078 putchar ('\f');
2079 else
2080 for (unsigned int i = lines; i; --i)
2081 putchar ('\n');
2084 /* Read the rest of the line.
2086 Read from the current column's file until an end of line is
2087 hit. Used when we've truncated a line and we no longer need
2088 to print or store its characters. */
2090 static void
2091 read_rest_of_line (COLUMN *p)
2093 int c;
2094 FILE *f = p->fp;
2096 while ((c = getc (f)) != '\n')
2098 if (c == '\f')
2100 if ((c = getc (f)) != '\n')
2101 ungetc (c, f);
2102 if (keep_FF)
2103 print_a_FF = true;
2104 hold_file (p);
2105 break;
2107 else if (c == EOF)
2109 close_file (p);
2110 break;
2115 /* Read a line with skip_to_page.
2117 Read from the current column's file until an end of line is
2118 hit. Used when we read full lines to skip pages.
2119 With skip_to_page we have to check for FF-coincidence which is done
2120 in function read_line otherwise.
2121 Count lines of skipped pages to find the line number of 1st page
2122 printed relative to 1st line of input file (start_line_num). */
2124 static void
2125 skip_read (COLUMN *p, int column_number)
2127 int c;
2128 FILE *f = p->fp;
2129 int i;
2130 bool single_ff = false;
2131 COLUMN *q;
2133 /* Read 1st character in a line or any character succeeding a FF */
2134 if ((c = getc (f)) == '\f' && p->full_page_printed)
2135 /* A FF-coincidence with a previous full_page_printed.
2136 To avoid an additional empty page, eliminate the FF */
2137 if ((c = getc (f)) == '\n')
2138 c = getc (f);
2140 p->full_page_printed = false;
2142 /* 1st character a FF means a single FF without any printable
2143 characters. Don't count it as a line with -n option. */
2144 if (c == '\f')
2145 single_ff = true;
2147 /* Preparing for a FF-coincidence: Maybe we finish that page
2148 without a FF found */
2149 if (last_line)
2150 p->full_page_printed = true;
2152 while (c != '\n')
2154 if (c == '\f')
2156 /* No FF-coincidence possible,
2157 no catching up of a FF-coincidence with next page */
2158 if (last_line)
2160 if (!parallel_files)
2161 for (q = column_vector, i = columns; i; ++q, --i)
2162 q->full_page_printed = false;
2163 else
2164 p->full_page_printed = false;
2167 if ((c = getc (f)) != '\n')
2168 ungetc (c, f);
2169 hold_file (p);
2170 break;
2172 else if (c == EOF)
2174 close_file (p);
2175 break;
2177 c = getc (f);
2180 if (skip_count)
2181 if ((!parallel_files || column_number == 1) && !single_ff)
2182 ++line_count;
2185 /* If we're tabifying output,
2187 When print_char encounters white space it keeps track
2188 of our desired horizontal position and delays printing
2189 until this function is called. */
2191 static void
2192 print_white_space (void)
2194 int h_new;
2195 int h_old = output_position;
2196 int goal = h_old + spaces_not_printed;
2198 while (goal - h_old > 1
2199 && (h_new = POS_AFTER_TAB (chars_per_output_tab, h_old)) <= goal)
2201 putchar (output_tab_char);
2202 h_old = h_new;
2204 while (++h_old <= goal)
2205 putchar (' ');
2207 output_position = goal;
2208 spaces_not_printed = 0;
2211 /* Print column separators.
2213 We keep a count until we know that we'll be printing a line,
2214 then print_sep_string() is called. */
2216 static void
2217 print_sep_string (void)
2219 char const *s = col_sep_string;
2220 int l = col_sep_length;
2222 if (separators_not_printed <= 0)
2224 /* We'll be starting a line with chars_per_margin, anything else? */
2225 if (spaces_not_printed > 0)
2226 print_white_space ();
2228 else
2230 for (; separators_not_printed > 0; --separators_not_printed)
2232 while (l-- > 0)
2234 /* 3 types of sep_strings: spaces only, spaces and chars,
2235 chars only */
2236 if (*s == ' ')
2238 /* We're tabifying output; consecutive spaces in
2239 sep_string may have to be converted to tabs */
2240 s++;
2241 ++spaces_not_printed;
2243 else
2245 if (spaces_not_printed > 0)
2246 print_white_space ();
2247 putchar (*s++);
2248 ++output_position;
2251 /* sep_string ends with some spaces */
2252 if (spaces_not_printed > 0)
2253 print_white_space ();
2258 /* Print (or store, depending on p->char_func) a clump of N
2259 characters. */
2261 static void
2262 print_clump (COLUMN *p, int n, char *clump)
2264 while (n--)
2265 (p->char_func) (*clump++);
2268 /* Print a character.
2270 Update the following comment: process-char hasn't been used any
2271 longer.
2272 If we're tabifying, all tabs have been converted to spaces by
2273 process_char(). Keep a count of consecutive spaces, and when
2274 a nonspace is encountered, call print_white_space() to print the
2275 required number of tabs and spaces. */
2277 static void
2278 print_char (char c)
2280 if (tabify_output)
2282 if (c == ' ')
2284 ++spaces_not_printed;
2285 return;
2287 else if (spaces_not_printed > 0)
2288 print_white_space ();
2290 /* Nonprintables are assumed to have width 0, except '\b'. */
2291 if (! isprint (to_uchar (c)))
2293 if (c == '\b')
2294 --output_position;
2296 else
2297 ++output_position;
2299 putchar (c);
2302 /* Skip to page PAGE before printing.
2303 PAGE may be larger than total number of pages. */
2305 static bool
2306 skip_to_page (uintmax_t page)
2308 for (uintmax_t n = 1; n < page; ++n)
2310 COLUMN *p;
2311 int j;
2313 for (int i = 1; i < lines_per_body; ++i)
2315 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2316 if (p->status == OPEN)
2317 skip_read (p, j);
2319 last_line = true;
2320 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2321 if (p->status == OPEN)
2322 skip_read (p, j);
2324 if (storing_columns) /* change FF_FOUND to ON_HOLD */
2325 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2326 if (p->status != CLOSED)
2327 p->status = ON_HOLD;
2329 reset_status ();
2330 last_line = false;
2332 if (files_ready_to_read < 1)
2334 /* It's very helpful, normally the total number of pages is
2335 not known in advance. */
2336 error (0, 0,
2337 _("starting page number %"PRIuMAX
2338 " exceeds page count %"PRIuMAX),
2339 page, n);
2340 break;
2343 return files_ready_to_read > 0;
2346 /* Print a header.
2348 Formfeeds are assumed to use up two lines at the beginning of
2349 the page. */
2351 static void
2352 print_header (void)
2354 char page_text[256 + INT_STRLEN_BOUND (page_number)];
2355 int available_width;
2356 int lhs_spaces;
2357 int rhs_spaces;
2359 output_position = 0;
2360 pad_across_to (chars_per_margin);
2361 print_white_space ();
2363 if (page_number == 0)
2364 die (EXIT_FAILURE, 0, _("page number overflow"));
2366 /* The translator must ensure that formatting the translation of
2367 "Page %"PRIuMAX does not generate more than (sizeof page_text - 1)
2368 bytes. */
2369 sprintf (page_text, _("Page %"PRIuMAX), page_number);
2370 available_width = header_width_available - mbswidth (page_text, 0);
2371 available_width = MAX (0, available_width);
2372 lhs_spaces = available_width >> 1;
2373 rhs_spaces = available_width - lhs_spaces;
2375 printf ("\n\n%*s%s%*s%s%*s%s\n\n\n",
2376 chars_per_margin, "",
2377 date_text, lhs_spaces, " ",
2378 file_text, rhs_spaces, " ", page_text);
2380 print_a_header = false;
2381 output_position = 0;
2384 /* Print (or store, if p->char_func is store_char()) a line.
2386 Read a character to determine whether we have a line or not.
2387 (We may hit EOF, \n, or \f)
2389 Once we know we have a line,
2390 set pad_vertically = true, meaning it's safe
2391 to pad down at the end of the page, since we do have a page.
2392 print a header if needed.
2393 pad across to padding_not_printed if needed.
2394 print any separators which need to be printed.
2395 print a line number if it needs to be printed.
2397 Print the clump which corresponds to the first character.
2399 Enter a loop and keep printing until an end of line condition
2400 exists, or until we exceed chars_per_column.
2402 Return false if we exceed chars_per_column before reading
2403 an end of line character, true otherwise. */
2405 static bool
2406 read_line (COLUMN *p)
2408 int c;
2409 int chars IF_LINT ( = 0);
2410 int last_input_position;
2411 int j, k;
2412 COLUMN *q;
2414 /* read 1st character in each line or any character succeeding a FF: */
2415 c = getc (p->fp);
2417 last_input_position = input_position;
2419 if (c == '\f' && p->full_page_printed)
2420 if ((c = getc (p->fp)) == '\n')
2421 c = getc (p->fp);
2422 p->full_page_printed = false;
2424 switch (c)
2426 case '\f':
2427 if ((c = getc (p->fp)) != '\n')
2428 ungetc (c, p->fp);
2429 FF_only = true;
2430 if (print_a_header && !storing_columns)
2432 pad_vertically = true;
2433 print_header ();
2435 else if (keep_FF)
2436 print_a_FF = true;
2437 hold_file (p);
2438 return true;
2439 case EOF:
2440 close_file (p);
2441 return true;
2442 case '\n':
2443 break;
2444 default:
2445 chars = char_to_clump (c);
2448 if (truncate_lines && input_position > chars_per_column)
2450 input_position = last_input_position;
2451 return false;
2454 if (p->char_func != store_char)
2456 pad_vertically = true;
2458 if (print_a_header && !storing_columns)
2459 print_header ();
2461 if (parallel_files && align_empty_cols)
2463 /* We have to align empty columns at the beginning of a line. */
2464 k = separators_not_printed;
2465 separators_not_printed = 0;
2466 for (j = 1, q = column_vector; j <= k; ++j, ++q)
2468 align_column (q);
2469 separators_not_printed += 1;
2471 padding_not_printed = p->start_position;
2472 if (truncate_lines)
2473 spaces_not_printed = chars_per_column;
2474 else
2475 spaces_not_printed = 0;
2476 align_empty_cols = false;
2479 if (col_sep_length < padding_not_printed)
2481 pad_across_to (padding_not_printed - col_sep_length);
2482 padding_not_printed = ANYWHERE;
2485 if (use_col_separator)
2486 print_sep_string ();
2489 if (p->numbered)
2490 add_line_number (p);
2492 empty_line = false;
2493 if (c == '\n')
2494 return true;
2496 print_clump (p, chars, clump_buff);
2498 while (true)
2500 c = getc (p->fp);
2502 switch (c)
2504 case '\n':
2505 return true;
2506 case '\f':
2507 if ((c = getc (p->fp)) != '\n')
2508 ungetc (c, p->fp);
2509 if (keep_FF)
2510 print_a_FF = true;
2511 hold_file (p);
2512 return true;
2513 case EOF:
2514 close_file (p);
2515 return true;
2518 last_input_position = input_position;
2519 chars = char_to_clump (c);
2520 if (truncate_lines && input_position > chars_per_column)
2522 input_position = last_input_position;
2523 return false;
2526 print_clump (p, chars, clump_buff);
2530 /* Print a line from buff.
2532 If this function has been called, we know we have "something to
2533 print". But it remains to be seen whether we have a real text page
2534 or an empty page (a single form feed) with/without a header only.
2535 Therefore first we set pad_vertically to true and print a header
2536 if necessary.
2537 If FF_FOUND and we are using -t|-T option we omit any newline by
2538 setting pad_vertically to false (see print_page).
2539 Otherwise we pad across if necessary, print separators if necessary
2540 and text of COLUMN *p.
2542 Return true, meaning there is no need to call read_rest_of_line. */
2544 static bool
2545 print_stored (COLUMN *p)
2547 COLUMN *q;
2549 int line = p->current_line++;
2550 char *first = &buff[line_vector[line]];
2551 /* FIXME
2552 UMR: Uninitialized memory read:
2553 * This is occurring while in:
2554 print_stored [pr.c:2239]
2555 * Reading 4 bytes from 0x5148c in the heap.
2556 * Address 0x5148c is 4 bytes into a malloc'd block at 0x51488 of 676 bytes
2557 * This block was allocated from:
2558 malloc [rtlib.o]
2559 xmalloc [xmalloc.c:94]
2560 init_store_cols [pr.c:1648]
2562 char *last = &buff[line_vector[line + 1]];
2564 pad_vertically = true;
2566 if (print_a_header)
2567 print_header ();
2569 if (p->status == FF_FOUND)
2571 int i;
2572 for (i = 1, q = column_vector; i <= columns; ++i, ++q)
2573 q->status = ON_HOLD;
2574 if (column_vector->lines_to_print <= 0)
2576 if (!extremities)
2577 pad_vertically = false;
2578 return true; /* print a header only */
2582 if (col_sep_length < padding_not_printed)
2584 pad_across_to (padding_not_printed - col_sep_length);
2585 padding_not_printed = ANYWHERE;
2588 if (use_col_separator)
2589 print_sep_string ();
2591 while (first != last)
2592 print_char (*first++);
2594 if (spaces_not_printed == 0)
2596 output_position = p->start_position + end_vector[line];
2597 if (p->start_position - col_sep_length == chars_per_margin)
2598 output_position -= col_sep_length;
2601 return true;
2604 /* Convert a character to the proper format and return the number of
2605 characters in the resulting clump. Increment input_position by
2606 the width of the clump.
2608 Tabs are converted to clumps of spaces.
2609 Nonprintable characters may be converted to clumps of escape
2610 sequences or control prefixes.
2612 Note: the width of a clump is not necessarily equal to the number of
2613 characters in clump_buff. (e.g, the width of '\b' is -1, while the
2614 number of characters is 1.) */
2616 static int
2617 char_to_clump (char c)
2619 unsigned char uc = c;
2620 char *s = clump_buff;
2621 int i;
2622 char esc_buff[4];
2623 int width;
2624 int chars;
2625 int chars_per_c = 8;
2627 if (c == input_tab_char)
2628 chars_per_c = chars_per_input_tab;
2630 if (c == input_tab_char || c == '\t')
2632 width = TAB_WIDTH (chars_per_c, input_position);
2634 if (untabify_input)
2636 for (i = width; i; --i)
2637 *s++ = ' ';
2638 chars = width;
2640 else
2642 *s = c;
2643 chars = 1;
2647 else if (! isprint (uc))
2649 if (use_esc_sequence)
2651 width = 4;
2652 chars = 4;
2653 *s++ = '\\';
2654 sprintf (esc_buff, "%03o", uc);
2655 for (i = 0; i <= 2; ++i)
2656 *s++ = esc_buff[i];
2658 else if (use_cntrl_prefix)
2660 if (uc < 0200)
2662 width = 2;
2663 chars = 2;
2664 *s++ = '^';
2665 *s = c ^ 0100;
2667 else
2669 width = 4;
2670 chars = 4;
2671 *s++ = '\\';
2672 sprintf (esc_buff, "%03o", uc);
2673 for (i = 0; i <= 2; ++i)
2674 *s++ = esc_buff[i];
2677 else if (c == '\b')
2679 width = -1;
2680 chars = 1;
2681 *s = c;
2683 else
2685 width = 0;
2686 chars = 1;
2687 *s = c;
2690 else
2692 width = 1;
2693 chars = 1;
2694 *s = c;
2697 /* Too many backspaces must put us in position 0 -- never negative. */
2698 if (width < 0 && input_position == 0)
2700 chars = 0;
2701 input_position = 0;
2703 else if (width < 0 && input_position <= -width)
2704 input_position = 0;
2705 else
2706 input_position += width;
2708 return chars;
2711 /* We've just printed some files and need to clean up things before
2712 looking for more options and printing the next batch of files.
2714 Free everything we've xmalloc'ed, except 'header'. */
2716 static void
2717 cleanup (void)
2719 free (number_buff);
2720 free (clump_buff);
2721 free (column_vector);
2722 free (line_vector);
2723 free (end_vector);
2724 free (buff);
2727 /* Complain, print a usage message, and die. */
2729 void
2730 usage (int status)
2732 if (status != EXIT_SUCCESS)
2733 emit_try_help ();
2734 else
2736 printf (_("\
2737 Usage: %s [OPTION]... [FILE]...\n\
2739 program_name);
2741 fputs (_("\
2742 Paginate or columnate FILE(s) for printing.\n\
2743 "), stdout);
2745 emit_stdin_note ();
2746 emit_mandatory_arg_note ();
2748 fputs (_("\
2749 +FIRST_PAGE[:LAST_PAGE], --pages=FIRST_PAGE[:LAST_PAGE]\n\
2750 begin [stop] printing with page FIRST_[LAST_]PAGE\n\
2751 -COLUMN, --columns=COLUMN\n\
2752 output COLUMN columns and print columns down,\n\
2753 unless -a is used. Balance number of lines in the\n\
2754 columns on each page\n\
2755 "), stdout);
2756 fputs (_("\
2757 -a, --across print columns across rather than down, used together\n\
2758 with -COLUMN\n\
2759 -c, --show-control-chars\n\
2760 use hat notation (^G) and octal backslash notation\n\
2761 -d, --double-space\n\
2762 double space the output\n\
2763 "), stdout);
2764 fputs (_("\
2765 -D, --date-format=FORMAT\n\
2766 use FORMAT for the header date\n\
2767 -e[CHAR[WIDTH]], --expand-tabs[=CHAR[WIDTH]]\n\
2768 expand input CHARs (TABs) to tab WIDTH (8)\n\
2769 -F, -f, --form-feed\n\
2770 use form feeds instead of newlines to separate pages\n\
2771 (by a 3-line page header with -F or a 5-line header\n\
2772 and trailer without -F)\n\
2773 "), stdout);
2774 fputs (_("\
2775 -h, --header=HEADER\n\
2776 use a centered HEADER instead of filename in page header,\n\
2777 -h \"\" prints a blank line, don't use -h\"\"\n\
2778 -i[CHAR[WIDTH]], --output-tabs[=CHAR[WIDTH]]\n\
2779 replace spaces with CHARs (TABs) to tab WIDTH (8)\n\
2780 -J, --join-lines merge full lines, turns off -W line truncation, no column\n\
2781 alignment, --sep-string[=STRING] sets separators\n\
2782 "), stdout);
2783 fputs (_("\
2784 -l, --length=PAGE_LENGTH\n\
2785 set the page length to PAGE_LENGTH (66) lines\n\
2786 (default number of lines of text 56, and with -F 63).\n\
2787 implies -t if PAGE_LENGTH <= 10\n\
2788 "), stdout);
2789 fputs (_("\
2790 -m, --merge print all files in parallel, one in each column,\n\
2791 truncate lines, but join lines of full length with -J\n\
2792 "), stdout);
2793 fputs (_("\
2794 -n[SEP[DIGITS]], --number-lines[=SEP[DIGITS]]\n\
2795 number lines, use DIGITS (5) digits, then SEP (TAB),\n\
2796 default counting starts with 1st line of input file\n\
2797 -N, --first-line-number=NUMBER\n\
2798 start counting with NUMBER at 1st line of first\n\
2799 page printed (see +FIRST_PAGE)\n\
2800 "), stdout);
2801 fputs (_("\
2802 -o, --indent=MARGIN\n\
2803 offset each line with MARGIN (zero) spaces, do not\n\
2804 affect -w or -W, MARGIN will be added to PAGE_WIDTH\n\
2805 -r, --no-file-warnings\n\
2806 omit warning when a file cannot be opened\n\
2807 "), stdout);
2808 fputs (_("\
2809 -s[CHAR], --separator[=CHAR]\n\
2810 separate columns by a single character, default for CHAR\n\
2811 is the <TAB> character without -w and \'no char\' with -w.\
2813 -s[CHAR] turns off line truncation of all 3 column\n\
2814 options (-COLUMN|-a -COLUMN|-m) except -w is set\n\
2815 "), stdout);
2816 fputs (_("\
2817 -S[STRING], --sep-string[=STRING]\n\
2818 separate columns by STRING,\n\
2819 without -S: Default separator <TAB> with -J and <space>\n\
2820 otherwise (same as -S\" \"), no effect on column options\n\
2821 "), stdout);
2822 fputs (_("\
2823 -t, --omit-header omit page headers and trailers;\n\
2824 implied if PAGE_LENGTH <= 10\n\
2825 "), stdout);
2826 fputs (_("\
2827 -T, --omit-pagination\n\
2828 omit page headers and trailers, eliminate any pagination\n\
2829 by form feeds set in input files\n\
2830 -v, --show-nonprinting\n\
2831 use octal backslash notation\n\
2832 -w, --width=PAGE_WIDTH\n\
2833 set page width to PAGE_WIDTH (72) characters for\n\
2834 multiple text-column output only, -s[char] turns off (72)\n\
2835 "), stdout);
2836 fputs (_("\
2837 -W, --page-width=PAGE_WIDTH\n\
2838 set page width to PAGE_WIDTH (72) characters always,\n\
2839 truncate lines, except -J option is set, no interference\n\
2840 with -S or -s\n\
2841 "), stdout);
2842 fputs (HELP_OPTION_DESCRIPTION, stdout);
2843 fputs (VERSION_OPTION_DESCRIPTION, stdout);
2844 emit_ancillary_info (PROGRAM_NAME);
2846 exit (status);