maint: revert "build: update gnulib submodule to latest"
[coreutils/ericb.git] / src / pr.c
blobd1adc5591f2c28e54b27e6afd90e113554cce720
1 /* pr -- convert text files for printing.
2 Copyright (C) 1988, 1991, 1995-2011 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.)
311 #include <config.h>
313 #include <getopt.h>
314 #include <sys/types.h>
315 #include "system.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"
326 /* The official name of this program (e.g., no `g' prefix). */
327 #define PROGRAM_NAME "pr"
329 #define AUTHORS \
330 proper_name ("Pete TerMaat"), \
331 proper_name ("Roland Huebner")
333 /* Used with start_position in the struct COLUMN described below.
334 If start_position == ANYWHERE, we aren't truncating columns and
335 can begin printing a column anywhere. Otherwise we must pad to
336 the horizontal position start_position. */
337 #define ANYWHERE 0
339 /* Each column has one of these structures allocated for it.
340 If we're only dealing with one file, fp is the same for all
341 columns.
343 The general strategy is to spend time setting up these column
344 structures (storing columns if necessary), after which printing
345 is a matter of flitting from column to column and calling
346 print_func.
348 Parallel files, single files printing across in multiple
349 columns, and single files printing down in multiple columns all
350 fit the same printing loop.
352 print_func Function used to print lines in this column.
353 If we're storing this column it will be
354 print_stored(), Otherwise it will be read_line().
356 char_func Function used to process characters in this column.
357 If we're storing this column it will be store_char(),
358 otherwise it will be print_char().
360 current_line Index of the current entry in line_vector, which
361 contains the index of the first character of the
362 current line in buff[].
364 lines_stored Number of lines in this column which are stored in
365 buff.
367 lines_to_print If we're storing this column, lines_to_print is
368 the number of stored_lines which remain to be
369 printed. Otherwise it is the number of lines
370 we can print without exceeding lines_per_body.
372 start_position The horizontal position we want to be in before we
373 print the first character in this column.
375 numbered True means precede this column with a line number. */
377 /* FIXME: There are many unchecked integer overflows in this file,
378 that will cause this command to misbehave given large inputs or
379 options. Many of the "int" values below should be "size_t" or
380 something else like that. */
382 struct COLUMN;
383 struct COLUMN
385 FILE *fp; /* Input stream for this column. */
386 char const *name; /* File name. */
387 enum
389 OPEN,
390 FF_FOUND, /* used with -b option, set with \f, changed
391 to ON_HOLD after print_header */
392 ON_HOLD, /* Hit a form feed. */
393 CLOSED
395 status; /* Status of the file pointer. */
397 /* Func to print lines in this col. */
398 bool (*print_func) (struct COLUMN *);
400 /* Func to print/store chars in this col. */
401 void (*char_func) (char);
403 int current_line; /* Index of current place in line_vector. */
404 int lines_stored; /* Number of lines stored in buff. */
405 int lines_to_print; /* No. lines stored or space left on page. */
406 int start_position; /* Horizontal position of first char. */
407 bool numbered;
408 bool full_page_printed; /* True means printed without a FF found. */
410 /* p->full_page_printed controls a special case of "FF set by hand":
411 True means a full page has been printed without FF found. To avoid an
412 additional empty page we have to ignore a FF immediately following in
413 the next line. */
416 typedef struct COLUMN COLUMN;
418 static int char_to_clump (char c);
419 static bool read_line (COLUMN *p);
420 static bool print_page (void);
421 static bool print_stored (COLUMN *p);
422 static bool open_file (char *name, COLUMN *p);
423 static bool skip_to_page (uintmax_t page);
424 static void print_header (void);
425 static void pad_across_to (int position);
426 static void add_line_number (COLUMN *p);
427 static void getoptarg (char *arg, char switch_char, char *character,
428 int *number);
429 void usage (int status);
430 static void print_files (int number_of_files, char **av);
431 static void init_parameters (int number_of_files);
432 static void init_header (char const *filename, int desc);
433 static bool init_fps (int number_of_files, char **av);
434 static void init_funcs (void);
435 static void init_store_cols (void);
436 static void store_columns (void);
437 static void balance (int total_stored);
438 static void store_char (char c);
439 static void pad_down (int lines);
440 static void read_rest_of_line (COLUMN *p);
441 static void skip_read (COLUMN *p, int column_number);
442 static void print_char (char c);
443 static void cleanup (void);
444 static void print_sep_string (void);
445 static void separator_string (const char *optarg_S);
447 /* All of the columns to print. */
448 static COLUMN *column_vector;
450 /* When printing a single file in multiple downward columns,
451 we store the leftmost columns contiguously in buff.
452 To print a line from buff, get the index of the first character
453 from line_vector[i], and print up to line_vector[i + 1]. */
454 static char *buff;
456 /* Index of the position in buff where the next character
457 will be stored. */
458 static unsigned int buff_current;
460 /* The number of characters in buff.
461 Used for allocation of buff and to detect overflow of buff. */
462 static size_t buff_allocated;
464 /* Array of indices into buff.
465 Each entry is an index of the first character of a line.
466 This is used when storing lines to facilitate shuffling when
467 we do column balancing on the last page. */
468 static int *line_vector;
470 /* Array of horizonal positions.
471 For each line in line_vector, end_vector[line] is the horizontal
472 position we are in after printing that line. We keep track of this
473 so that we know how much we need to pad to prepare for the next
474 column. */
475 static int *end_vector;
477 /* (-m) True means we're printing multiple files in parallel. */
478 static bool parallel_files = false;
480 /* (-m) True means a line starts with some empty columns (some files
481 already CLOSED or ON_HOLD) which we have to align. */
482 static bool align_empty_cols;
484 /* (-m) True means we have not yet found any printable column in a line.
485 align_empty_cols = true has to be maintained. */
486 static bool empty_line;
488 /* (-m) False means printable column output precedes a form feed found.
489 Column alignment is done only once. No additional action with that form
490 feed.
491 True means we found only a form feed in a column. Maybe we have to do
492 some column alignment with that form feed. */
493 static bool FF_only;
495 /* (-[0-9]+) True means we're given an option explicitly specifying
496 number of columns. Used to detect when this option is used with -m
497 and when translating old options to new/long options. */
498 static bool explicit_columns = false;
500 /* (-t|-T) False means we aren't printing headers and footers. */
501 static bool extremities = true;
503 /* (-t) True means we retain all FF set by hand in input files.
504 False is set with -T option. */
505 static bool keep_FF = false;
506 static bool print_a_FF = false;
508 /* True means we need to print a header as soon as we know we've got input
509 to print after it. */
510 static bool print_a_header;
512 /* (-f) True means use formfeeds instead of newlines to separate pages. */
513 static bool use_form_feed = false;
515 /* True means we have read the standard input. */
516 static bool have_read_stdin = false;
518 /* True means the -a flag has been given. */
519 static bool print_across_flag = false;
521 /* True means we're printing one file in multiple (>1) downward columns. */
522 static bool storing_columns = true;
524 /* (-b) True means balance columns on the last page as Sys V does. */
525 /* That's no longer an independent option. With storing_columns = true
526 balance_columns = true is used too (s. function init_parameters).
527 We get a consistent formulation with "FF set by hand" in input files. */
528 static bool balance_columns = false;
530 /* (-l) Number of lines on a page, including header and footer lines. */
531 static int lines_per_page = 66;
533 /* Number of lines in the header and footer can be reset to 0 using
534 the -t flag. */
535 enum { lines_per_header = 5 };
536 static int lines_per_body;
537 enum { lines_per_footer = 5 };
539 /* (-w|-W) Width in characters of the page. Does not include the width of
540 the margin. */
541 static int chars_per_line = 72;
543 /* (-w|W) True means we truncate lines longer than chars_per_column. */
544 static bool truncate_lines = false;
546 /* (-J) True means we join lines without any line truncation. -J
547 dominates -w option. */
548 static bool join_lines = false;
550 /* Number of characters in a column. Based on col_sep_length and
551 page width. */
552 static int chars_per_column;
554 /* (-e) True means convert tabs to spaces on input. */
555 static bool untabify_input = false;
557 /* (-e) The input tab character. */
558 static char input_tab_char = '\t';
560 /* (-e) Tabstops are at chars_per_tab, 2*chars_per_tab, 3*chars_per_tab, ...
561 where the leftmost column is 1. */
562 static int chars_per_input_tab = 8;
564 /* (-i) True means convert spaces to tabs on output. */
565 static bool tabify_output = false;
567 /* (-i) The output tab character. */
568 static char output_tab_char = '\t';
570 /* (-i) The width of the output tab. */
571 static int chars_per_output_tab = 8;
573 /* Keeps track of pending white space. When we hit a nonspace
574 character after some whitespace, we print whitespace, tabbing
575 if necessary to get to output_position + spaces_not_printed. */
576 static int spaces_not_printed;
578 /* (-o) Number of spaces in the left margin (tabs used when possible). */
579 static int chars_per_margin = 0;
581 /* Position where the next character will fall.
582 Leftmost position is 0 + chars_per_margin.
583 Rightmost position is chars_per_margin + chars_per_line - 1.
584 This is important for converting spaces to tabs on output. */
585 static int output_position;
587 /* Horizontal position relative to the current file.
588 (output_position depends on where we are on the page;
589 input_position depends on where we are in the file.)
590 Important for converting tabs to spaces on input. */
591 static int input_position;
593 /* True if there were any failed opens so we can exit with nonzero
594 status. */
595 static bool failed_opens = false;
597 /* The number of spaces taken up if we print a tab character with width
598 c_ from position h_. */
599 #define TAB_WIDTH(c_, h_) ((c_) - ((h_) % (c_)))
601 /* The horizontal position we'll be at after printing a tab character
602 of width c_ from the position h_. */
603 #define POS_AFTER_TAB(c_, h_) ((h_) + TAB_WIDTH (c_, h_))
605 /* (-NNN) Number of columns of text to print. */
606 static int columns = 1;
608 /* (+NNN:MMM) Page numbers on which to begin and stop printing.
609 first_page_number = 0 will be used to check input only. */
610 static uintmax_t first_page_number = 0;
611 static uintmax_t last_page_number = UINTMAX_MAX;
613 /* Number of files open (not closed, not on hold). */
614 static int files_ready_to_read = 0;
616 /* Current page number. Displayed in header. */
617 static uintmax_t page_number;
619 /* Current line number. Displayed when -n flag is specified.
621 When printing files in parallel (-m flag), line numbering is as follows:
622 1 foo goo moo
623 2 hoo too zoo
625 When printing files across (-a flag), ...
626 1 foo 2 moo 3 goo
627 4 hoo 5 too 6 zoo
629 Otherwise, line numbering is as follows:
630 1 foo 3 goo 5 too
631 2 moo 4 hoo 6 zoo */
632 static int line_number;
634 /* With line_number overflow, we use power_10 to cut off the higher-order
635 digits of the line_number */
636 static int power_10;
638 /* (-n) True means lines should be preceded by numbers. */
639 static bool numbered_lines = false;
641 /* (-n) Character which follows each line number. */
642 static char number_separator = '\t';
644 /* (-n) line counting starts with 1st line of input file (not with 1st
645 line of 1st page printed). */
646 static int line_count = 1;
648 /* (-n) True means counting of skipped lines starts with 1st line of
649 input file. False means -N option is used in addition, counting of
650 skipped lines not required. */
651 static bool skip_count = true;
653 /* (-N) Counting starts with start_line_number = NUMBER at 1st line of
654 first page printed, usually not 1st page of input file. */
655 static int start_line_num = 1;
657 /* (-n) Width in characters of a line number. */
658 static int chars_per_number = 5;
660 /* Used when widening the first column to accommodate numbers -- only
661 needed when printing files in parallel. Includes width of both the
662 number and the number_separator. */
663 static int number_width;
665 /* Buffer sprintf uses to format a line number. */
666 static char *number_buff;
668 /* (-v) True means unprintable characters are printed as escape sequences.
669 control-g becomes \007. */
670 static bool use_esc_sequence = false;
672 /* (-c) True means unprintable characters are printed as control prefixes.
673 control-g becomes ^G. */
674 static bool use_cntrl_prefix = false;
676 /* (-d) True means output is double spaced. */
677 static bool double_space = false;
679 /* Number of files opened initially in init_files. Should be 1
680 unless we're printing multiple files in parallel. */
681 static int total_files = 0;
683 /* (-r) True means don't complain if we can't open a file. */
684 static bool ignore_failed_opens = false;
686 /* (-S) True means we separate columns with a specified string.
687 -S option does not affect line truncation nor column alignment. */
688 static bool use_col_separator = false;
690 /* String used to separate columns if the -S option has been specified.
691 Default without -S but together with one of the column options
692 -a|COLUMN|-m is a `space' and with the -J option a `tab'. */
693 static char *col_sep_string = (char *) "";
694 static int col_sep_length = 0;
695 static char *column_separator = (char *) " ";
696 static char *line_separator = (char *) "\t";
698 /* Number of separator characters waiting to be printed as soon as we
699 know that we have any input remaining to be printed. */
700 static int separators_not_printed;
702 /* Position we need to pad to, as soon as we know that we have input
703 remaining to be printed. */
704 static int padding_not_printed;
706 /* True means we should pad the end of the page. Remains false until we
707 know we have a page to print. */
708 static bool pad_vertically;
710 /* (-h) String of characters used in place of the filename in the header. */
711 static char *custom_header;
713 /* (-D) Date format for the header. */
714 static char const *date_format;
716 /* Date and file name for the header. */
717 static char *date_text;
718 static char const *file_text;
720 /* Output columns available, not counting the date and file name. */
721 static int header_width_available;
723 static char *clump_buff;
725 /* True means we read the line no. lines_per_body in skip_read
726 called by skip_to_page. That variable controls the coincidence of a
727 "FF set by hand" and "full_page_printed", see above the definition of
728 structure COLUMN. */
729 static bool last_line = false;
731 /* For long options that have no equivalent short option, use a
732 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
733 enum
735 COLUMNS_OPTION = CHAR_MAX + 1,
736 PAGES_OPTION
739 static char const short_options[] =
740 "-0123456789D:FJN:S::TW:abcde::fh:i::l:mn::o:rs::tvw:";
742 static struct option const long_options[] =
744 {"pages", required_argument, NULL, PAGES_OPTION},
745 {"columns", required_argument, NULL, COLUMNS_OPTION},
746 {"across", no_argument, NULL, 'a'},
747 {"show-control-chars", no_argument, NULL, 'c'},
748 {"double-space", no_argument, NULL, 'd'},
749 {"date-format", required_argument, NULL, 'D'},
750 {"expand-tabs", optional_argument, NULL, 'e'},
751 {"form-feed", no_argument, NULL, 'f'},
752 {"header", required_argument, NULL, 'h'},
753 {"output-tabs", optional_argument, NULL, 'i'},
754 {"join-lines", no_argument, NULL, 'J'},
755 {"length", required_argument, NULL, 'l'},
756 {"merge", no_argument, NULL, 'm'},
757 {"number-lines", optional_argument, NULL, 'n'},
758 {"first-line-number", required_argument, NULL, 'N'},
759 {"indent", required_argument, NULL, 'o'},
760 {"no-file-warnings", no_argument, NULL, 'r'},
761 {"separator", optional_argument, NULL, 's'},
762 {"sep-string", optional_argument, NULL, 'S'},
763 {"omit-header", no_argument, NULL, 't'},
764 {"omit-pagination", no_argument, NULL, 'T'},
765 {"show-nonprinting", no_argument, NULL, 'v'},
766 {"width", required_argument, NULL, 'w'},
767 {"page-width", required_argument, NULL, 'W'},
768 {GETOPT_HELP_OPTION_DECL},
769 {GETOPT_VERSION_OPTION_DECL},
770 {NULL, 0, NULL, 0}
773 /* Return the number of columns that have either an open file or
774 stored lines. */
776 static int _GL_ATTRIBUTE_PURE
777 cols_ready_to_print (void)
779 COLUMN *q;
780 int i;
781 int n;
783 n = 0;
784 for (q = column_vector, i = 0; i < columns; ++q, ++i)
785 if (q->status == OPEN ||
786 q->status == FF_FOUND || /* With -b: To print a header only */
787 (storing_columns && q->lines_stored > 0 && q->lines_to_print > 0))
788 ++n;
789 return n;
792 /* Estimate first_ / last_page_number
793 using option +FIRST_PAGE:LAST_PAGE */
795 static bool
796 first_last_page (int oi, char c, char const *pages)
798 char *p;
799 uintmax_t first;
800 uintmax_t last = UINTMAX_MAX;
801 strtol_error err = xstrtoumax (pages, &p, 10, &first, "");
802 if (err != LONGINT_OK && err != LONGINT_INVALID_SUFFIX_CHAR)
803 xstrtol_fatal (err, oi, c, long_options, pages);
805 if (p == pages || !first)
806 return false;
808 if (*p == ':')
810 char const *p1 = p + 1;
811 err = xstrtoumax (p1, &p, 10, &last, "");
812 if (err != LONGINT_OK)
813 xstrtol_fatal (err, oi, c, long_options, pages);
814 if (p1 == p || last < first)
815 return false;
818 if (*p)
819 return false;
821 first_page_number = first;
822 last_page_number = last;
823 return true;
826 /* Parse column count string S, and if it's valid (1 or larger and
827 within range of the type of `columns') set the global variables
828 columns and explicit_columns and return true.
829 Otherwise, exit with a diagnostic. */
830 static void
831 parse_column_count (char const *s)
833 long int tmp_long;
834 if (xstrtol (s, NULL, 10, &tmp_long, "") != LONGINT_OK
835 || !(1 <= tmp_long && tmp_long <= INT_MAX))
836 error (EXIT_FAILURE, 0,
837 _("invalid number of columns: %s"), quote (s));
839 columns = tmp_long;
840 explicit_columns = true;
843 /* Estimate length of col_sep_string with option -S. */
845 static void
846 separator_string (const char *optarg_S)
848 col_sep_length = (int) strlen (optarg_S);
849 col_sep_string = xmalloc (col_sep_length + 1);
850 strcpy (col_sep_string, optarg_S);
854 main (int argc, char **argv)
856 int n_files;
857 bool old_options = false;
858 bool old_w = false;
859 bool old_s = false;
860 char **file_names;
862 /* Accumulate the digits of old-style options like -99. */
863 char *column_count_string = NULL;
864 size_t n_digits = 0;
865 size_t n_alloc = 0;
867 initialize_main (&argc, &argv);
868 set_program_name (argv[0]);
869 setlocale (LC_ALL, "");
870 bindtextdomain (PACKAGE, LOCALEDIR);
871 textdomain (PACKAGE);
873 atexit (close_stdout);
875 n_files = 0;
876 file_names = (argc > 1
877 ? xmalloc ((argc - 1) * sizeof (char *))
878 : NULL);
880 while (true)
882 int oi = -1;
883 int c = getopt_long (argc, argv, short_options, long_options, &oi);
884 if (c == -1)
885 break;
887 if (ISDIGIT (c))
889 /* Accumulate column-count digits specified via old-style options. */
890 if (n_digits + 1 >= n_alloc)
891 column_count_string
892 = X2REALLOC (column_count_string, &n_alloc);
893 column_count_string[n_digits++] = c;
894 column_count_string[n_digits] = '\0';
895 continue;
898 n_digits = 0;
900 switch (c)
902 case 1: /* Non-option argument. */
903 /* long option --page dominates old `+FIRST_PAGE ...'. */
904 if (! (first_page_number == 0
905 && *optarg == '+' && first_last_page (-2, '+', optarg + 1)))
906 file_names[n_files++] = optarg;
907 break;
909 case PAGES_OPTION: /* --pages=FIRST_PAGE[:LAST_PAGE] */
910 { /* dominates old opt +... */
911 if (! optarg)
912 error (EXIT_FAILURE, 0,
913 _("`--pages=FIRST_PAGE[:LAST_PAGE]' missing argument"));
914 else if (! first_last_page (oi, 0, optarg))
915 error (EXIT_FAILURE, 0, _("invalid page range %s"),
916 quote (optarg));
917 break;
920 case COLUMNS_OPTION: /* --columns=COLUMN */
922 parse_column_count (optarg);
924 /* If there was a prior column count specified via the
925 short-named option syntax, e.g., -9, ensure that this
926 long-name-specified value overrides it. */
927 free (column_count_string);
928 column_count_string = NULL;
929 n_alloc = 0;
930 break;
933 case 'a':
934 print_across_flag = true;
935 storing_columns = false;
936 break;
937 case 'b':
938 balance_columns = true;
939 break;
940 case 'c':
941 use_cntrl_prefix = true;
942 break;
943 case 'd':
944 double_space = true;
945 break;
946 case 'D':
947 date_format = optarg;
948 break;
949 case 'e':
950 if (optarg)
951 getoptarg (optarg, 'e', &input_tab_char,
952 &chars_per_input_tab);
953 /* Could check tab width > 0. */
954 untabify_input = true;
955 break;
956 case 'f':
957 case 'F':
958 use_form_feed = true;
959 break;
960 case 'h':
961 custom_header = optarg;
962 break;
963 case 'i':
964 if (optarg)
965 getoptarg (optarg, 'i', &output_tab_char,
966 &chars_per_output_tab);
967 /* Could check tab width > 0. */
968 tabify_output = true;
969 break;
970 case 'J':
971 join_lines = true;
972 break;
973 case 'l':
975 long int tmp_long;
976 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
977 || tmp_long <= 0 || tmp_long > INT_MAX)
979 error (EXIT_FAILURE, 0,
980 _("`-l PAGE_LENGTH' invalid number of lines: %s"),
981 quote (optarg));
983 lines_per_page = tmp_long;
984 break;
986 case 'm':
987 parallel_files = true;
988 storing_columns = false;
989 break;
990 case 'n':
991 numbered_lines = true;
992 if (optarg)
993 getoptarg (optarg, 'n', &number_separator,
994 &chars_per_number);
995 break;
996 case 'N':
997 skip_count = false;
999 long int tmp_long;
1000 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1001 || tmp_long > INT_MAX)
1003 error (EXIT_FAILURE, 0,
1004 _("`-N NUMBER' invalid starting line number: %s"),
1005 quote (optarg));
1007 start_line_num = tmp_long;
1008 break;
1010 case 'o':
1012 long int tmp_long;
1013 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1014 || tmp_long < 0 || tmp_long > INT_MAX)
1015 error (EXIT_FAILURE, 0,
1016 _("`-o MARGIN' invalid line offset: %s"), quote (optarg));
1017 chars_per_margin = tmp_long;
1018 break;
1020 case 'r':
1021 ignore_failed_opens = true;
1022 break;
1023 case 's':
1024 old_options = true;
1025 old_s = true;
1026 if (!use_col_separator && optarg)
1027 separator_string (optarg);
1028 break;
1029 case 'S':
1030 old_s = false;
1031 /* Reset an additional input of -s, -S dominates -s */
1032 col_sep_string = bad_cast ("");
1033 col_sep_length = 0;
1034 use_col_separator = true;
1035 if (optarg)
1036 separator_string (optarg);
1037 break;
1038 case 't':
1039 extremities = false;
1040 keep_FF = true;
1041 break;
1042 case 'T':
1043 extremities = false;
1044 keep_FF = false;
1045 break;
1046 case 'v':
1047 use_esc_sequence = true;
1048 break;
1049 case 'w':
1050 old_options = true;
1051 old_w = true;
1053 long int tmp_long;
1054 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1055 || tmp_long <= 0 || tmp_long > INT_MAX)
1056 error (EXIT_FAILURE, 0,
1057 _("`-w PAGE_WIDTH' invalid number of characters: %s"),
1058 quote (optarg));
1059 if (!truncate_lines)
1060 chars_per_line = tmp_long;
1061 break;
1063 case 'W':
1064 old_w = false; /* dominates -w */
1065 truncate_lines = true;
1067 long int tmp_long;
1068 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1069 || tmp_long <= 0 || tmp_long > INT_MAX)
1070 error (EXIT_FAILURE, 0,
1071 _("`-W PAGE_WIDTH' invalid number of characters: %s"),
1072 quote (optarg));
1073 chars_per_line = tmp_long;
1074 break;
1076 case_GETOPT_HELP_CHAR;
1077 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1078 default:
1079 usage (EXIT_FAILURE);
1080 break;
1084 if (column_count_string)
1086 parse_column_count (column_count_string);
1087 free (column_count_string);
1090 if (! date_format)
1091 date_format = (getenv ("POSIXLY_CORRECT") && !hard_locale (LC_TIME)
1092 ? "%b %e %H:%M %Y"
1093 : "%Y-%m-%d %H:%M");
1095 /* Now we can set a reasonable initial value: */
1096 if (first_page_number == 0)
1097 first_page_number = 1;
1099 if (parallel_files && explicit_columns)
1100 error (EXIT_FAILURE, 0,
1101 _("cannot specify number of columns when printing in parallel"));
1103 if (parallel_files && print_across_flag)
1104 error (EXIT_FAILURE, 0,
1105 _("cannot specify both printing across and printing in parallel"));
1107 /* Translate some old short options to new/long options.
1108 To meet downward compatibility with other UNIX pr utilities
1109 and some POSIX specifications. */
1111 if (old_options)
1113 if (old_w)
1115 if (parallel_files || explicit_columns)
1117 /* activate -W */
1118 truncate_lines = true;
1119 if (old_s)
1120 /* adapt HP-UX and SunOS: -s = no separator;
1121 activate -S */
1122 use_col_separator = true;
1124 else
1125 /* old -w sets width with columns only
1126 activate -J */
1127 join_lines = true;
1129 else if (!use_col_separator)
1131 /* No -S option read */
1132 if (old_s && (parallel_files || explicit_columns))
1134 if (!truncate_lines)
1136 /* old -s (without -w and -W) annuls column alignment,
1137 uses fields, activate -J */
1138 join_lines = true;
1139 if (col_sep_length > 0)
1140 /* activate -S */
1141 use_col_separator = true;
1143 else
1144 /* with -W */
1145 /* adapt HP-UX and SunOS: -s = no separator;
1146 activate -S */
1147 use_col_separator = true;
1152 for (; optind < argc; optind++)
1154 file_names[n_files++] = argv[optind];
1157 if (n_files == 0)
1159 /* No file arguments specified; read from standard input. */
1160 print_files (0, NULL);
1162 else
1164 if (parallel_files)
1165 print_files (n_files, file_names);
1166 else
1168 unsigned int i;
1169 for (i = 0; i < n_files; i++)
1170 print_files (1, &file_names[i]);
1174 cleanup ();
1176 if (have_read_stdin && fclose (stdin) == EOF)
1177 error (EXIT_FAILURE, errno, _("standard input"));
1178 if (failed_opens)
1179 exit (EXIT_FAILURE);
1180 exit (EXIT_SUCCESS);
1183 /* Parse options of the form -scNNN.
1185 Example: -nck, where 'n' is the option, c is the optional number
1186 separator, and k is the optional width of the field used when printing
1187 a number. */
1189 static void
1190 getoptarg (char *arg, char switch_char, char *character, int *number)
1192 if (!ISDIGIT (*arg))
1193 *character = *arg++;
1194 if (*arg)
1196 long int tmp_long;
1197 if (xstrtol (arg, NULL, 10, &tmp_long, "") != LONGINT_OK
1198 || tmp_long <= 0 || tmp_long > INT_MAX)
1200 error (0, 0,
1201 _("`-%c' extra characters or invalid number in the argument: %s"),
1202 switch_char, quote (arg));
1203 usage (EXIT_FAILURE);
1205 *number = tmp_long;
1209 /* Set parameters related to formatting. */
1211 static void
1212 init_parameters (int number_of_files)
1214 int chars_used_by_number = 0;
1216 lines_per_body = lines_per_page - lines_per_header - lines_per_footer;
1217 if (lines_per_body <= 0)
1219 extremities = false;
1220 keep_FF = true;
1222 if (extremities == false)
1223 lines_per_body = lines_per_page;
1225 if (double_space)
1226 lines_per_body = lines_per_body / 2;
1228 /* If input is stdin, cannot print parallel files. BSD dumps core
1229 on this. */
1230 if (number_of_files == 0)
1231 parallel_files = false;
1233 if (parallel_files)
1234 columns = number_of_files;
1236 /* One file, multi columns down: -b option is set to get a consistent
1237 formulation with "FF set by hand" in input files. */
1238 if (storing_columns)
1239 balance_columns = true;
1241 /* Tabification is assumed for multiple columns. */
1242 if (columns > 1)
1244 if (!use_col_separator)
1246 /* Use default separator */
1247 if (join_lines)
1248 col_sep_string = line_separator;
1249 else
1250 col_sep_string = column_separator;
1252 col_sep_length = 1;
1253 use_col_separator = true;
1255 /* It's rather pointless to define a TAB separator with column
1256 alignment */
1257 else if (!join_lines && *col_sep_string == '\t')
1258 col_sep_string = column_separator;
1260 truncate_lines = true;
1261 tabify_output = true;
1263 else
1264 storing_columns = false;
1266 /* -J dominates -w in any case */
1267 if (join_lines)
1268 truncate_lines = false;
1270 if (numbered_lines)
1272 int tmp_i;
1273 int chars_per_default_tab = 8;
1275 line_count = start_line_num;
1277 /* To allow input tab-expansion (-e sensitive) use:
1278 if (number_separator == input_tab_char)
1279 number_width = chars_per_number +
1280 TAB_WIDTH (chars_per_input_tab, chars_per_number); */
1282 /* Estimate chars_per_text without any margin and keep it constant. */
1283 if (number_separator == '\t')
1284 number_width = chars_per_number +
1285 TAB_WIDTH (chars_per_default_tab, chars_per_number);
1286 else
1287 number_width = chars_per_number + 1;
1289 /* The number is part of the column width unless we are
1290 printing files in parallel. */
1291 if (parallel_files)
1292 chars_used_by_number = number_width;
1294 /* We use power_10 to cut off the higher-order digits of the
1295 line_number in function add_line_number */
1296 tmp_i = chars_per_number;
1297 for (power_10 = 1; tmp_i > 0; --tmp_i)
1298 power_10 = 10 * power_10;
1301 chars_per_column = (chars_per_line - chars_used_by_number -
1302 (columns - 1) * col_sep_length) / columns;
1304 if (chars_per_column < 1)
1305 error (EXIT_FAILURE, 0, _("page width too narrow"));
1307 if (numbered_lines)
1309 free (number_buff);
1310 number_buff = xmalloc (2 * chars_per_number);
1313 /* Pick the maximum between the tab width and the width of an
1314 escape sequence.
1315 The width of an escape sequence (4) isn't the lower limit any longer.
1316 We've to use 8 as the lower limit, if we use chars_per_default_tab = 8
1317 to expand a tab which is not an input_tab-char. */
1318 free (clump_buff);
1319 clump_buff = xmalloc (MAX (8, chars_per_input_tab));
1322 /* Open the necessary files,
1323 maintaining a COLUMN structure for each column.
1325 With multiple files, each column p has a different p->fp.
1326 With single files, each column p has the same p->fp.
1327 Return false if (number_of_files > 0) and no files can be opened,
1328 true otherwise.
1330 With each column/file p, p->full_page_printed is initialized,
1331 see also open_file. */
1333 static bool
1334 init_fps (int number_of_files, char **av)
1336 int i, files_left;
1337 COLUMN *p;
1338 FILE *firstfp;
1339 char const *firstname;
1341 total_files = 0;
1343 free (column_vector);
1344 column_vector = xnmalloc (columns, sizeof (COLUMN));
1346 if (parallel_files)
1348 files_left = number_of_files;
1349 for (p = column_vector; files_left--; ++p, ++av)
1351 if (! open_file (*av, p))
1353 --p;
1354 --columns;
1357 if (columns == 0)
1358 return false;
1359 init_header ("", -1);
1361 else
1363 p = column_vector;
1364 if (number_of_files > 0)
1366 if (! open_file (*av, p))
1367 return false;
1368 init_header (*av, fileno (p->fp));
1369 p->lines_stored = 0;
1371 else
1373 p->name = _("standard input");
1374 p->fp = stdin;
1375 have_read_stdin = true;
1376 p->status = OPEN;
1377 p->full_page_printed = false;
1378 ++total_files;
1379 init_header ("", -1);
1380 p->lines_stored = 0;
1383 firstname = p->name;
1384 firstfp = p->fp;
1385 for (i = columns - 1, ++p; i; --i, ++p)
1387 p->name = firstname;
1388 p->fp = firstfp;
1389 p->status = OPEN;
1390 p->full_page_printed = false;
1391 p->lines_stored = 0;
1394 files_ready_to_read = total_files;
1395 return true;
1398 /* Determine print_func and char_func, the functions
1399 used by each column for printing and/or storing.
1401 Determine the horizontal position desired when we begin
1402 printing a column (p->start_position). */
1404 static void
1405 init_funcs (void)
1407 int i, h, h_next;
1408 COLUMN *p;
1410 h = chars_per_margin;
1412 if (!truncate_lines)
1413 h_next = ANYWHERE;
1414 else
1416 /* When numbering lines of parallel files, we enlarge the
1417 first column to accomodate the number. Looks better than
1418 the Sys V approach. */
1419 if (parallel_files && numbered_lines)
1420 h_next = h + chars_per_column + number_width;
1421 else
1422 h_next = h + chars_per_column;
1425 /* Enlarge p->start_position of first column to use the same form of
1426 padding_not_printed with all columns. */
1427 h = h + col_sep_length;
1429 /* This loop takes care of all but the rightmost column. */
1431 for (p = column_vector, i = 1; i < columns; ++p, ++i)
1433 if (storing_columns) /* One file, multi columns down. */
1435 p->char_func = store_char;
1436 p->print_func = print_stored;
1438 else
1439 /* One file, multi columns across; or parallel files. */
1441 p->char_func = print_char;
1442 p->print_func = read_line;
1445 /* Number only the first column when printing files in
1446 parallel. */
1447 p->numbered = numbered_lines && (!parallel_files || i == 1);
1448 p->start_position = h;
1450 /* If we don't truncate lines, all start_positions are
1451 ANYWHERE, except the first column's start_position when
1452 using a margin. */
1454 if (!truncate_lines)
1456 h = ANYWHERE;
1457 h_next = ANYWHERE;
1459 else
1461 h = h_next + col_sep_length;
1462 h_next = h + chars_per_column;
1466 /* The rightmost column.
1468 Doesn't need to be stored unless we intend to balance
1469 columns on the last page. */
1470 if (storing_columns && balance_columns)
1472 p->char_func = store_char;
1473 p->print_func = print_stored;
1475 else
1477 p->char_func = print_char;
1478 p->print_func = read_line;
1481 p->numbered = numbered_lines && (!parallel_files || i == 1);
1482 p->start_position = h;
1485 /* Open a file. Return true if successful.
1487 With each file p, p->full_page_printed is initialized,
1488 see also init_fps. */
1490 static bool
1491 open_file (char *name, COLUMN *p)
1493 if (STREQ (name, "-"))
1495 p->name = _("standard input");
1496 p->fp = stdin;
1497 have_read_stdin = true;
1499 else
1501 p->name = name;
1502 p->fp = fopen (name, "r");
1504 if (p->fp == NULL)
1506 failed_opens = true;
1507 if (!ignore_failed_opens)
1508 error (0, errno, "%s", name);
1509 return false;
1511 fadvise (p->fp, FADVISE_SEQUENTIAL);
1512 p->status = OPEN;
1513 p->full_page_printed = false;
1514 ++total_files;
1515 return true;
1518 /* Close the file in P.
1520 If we aren't dealing with multiple files in parallel, we change
1521 the status of all columns in the column list to reflect the close. */
1523 static void
1524 close_file (COLUMN *p)
1526 COLUMN *q;
1527 int i;
1529 if (p->status == CLOSED)
1530 return;
1531 if (ferror (p->fp))
1532 error (EXIT_FAILURE, errno, "%s", p->name);
1533 if (fileno (p->fp) != STDIN_FILENO && fclose (p->fp) != 0)
1534 error (EXIT_FAILURE, errno, "%s", p->name);
1536 if (!parallel_files)
1538 for (q = column_vector, i = columns; i; ++q, --i)
1540 q->status = CLOSED;
1541 if (q->lines_stored == 0)
1543 q->lines_to_print = 0;
1547 else
1549 p->status = CLOSED;
1550 p->lines_to_print = 0;
1553 --files_ready_to_read;
1556 /* Put a file on hold until we start a new page,
1557 since we've hit a form feed.
1559 If we aren't dealing with parallel files, we must change the
1560 status of all columns in the column list. */
1562 static void
1563 hold_file (COLUMN *p)
1565 COLUMN *q;
1566 int i;
1568 if (!parallel_files)
1569 for (q = column_vector, i = columns; i; ++q, --i)
1571 if (storing_columns)
1572 q->status = FF_FOUND;
1573 else
1574 q->status = ON_HOLD;
1576 else
1577 p->status = ON_HOLD;
1579 p->lines_to_print = 0;
1580 --files_ready_to_read;
1583 /* Undo hold_file -- go through the column list and change any
1584 ON_HOLD columns to OPEN. Used at the end of each page. */
1586 static void
1587 reset_status (void)
1589 int i = columns;
1590 COLUMN *p;
1592 for (p = column_vector; i; --i, ++p)
1593 if (p->status == ON_HOLD)
1595 p->status = OPEN;
1596 files_ready_to_read++;
1599 if (storing_columns)
1601 if (column_vector->status == CLOSED)
1602 /* We use the info to output an error message in skip_to_page. */
1603 files_ready_to_read = 0;
1604 else
1605 files_ready_to_read = 1;
1609 /* Print a single file, or multiple files in parallel.
1611 Set up the list of columns, opening the necessary files.
1612 Allocate space for storing columns, if necessary.
1613 Skip to first_page_number, if user has asked to skip leading pages.
1614 Determine which functions are appropriate to store/print lines
1615 in each column.
1616 Print the file(s). */
1618 static void
1619 print_files (int number_of_files, char **av)
1621 init_parameters (number_of_files);
1622 if (! init_fps (number_of_files, av))
1623 return;
1624 if (storing_columns)
1625 init_store_cols ();
1627 if (first_page_number > 1)
1629 if (!skip_to_page (first_page_number))
1630 return;
1631 else
1632 page_number = first_page_number;
1634 else
1635 page_number = 1;
1637 init_funcs ();
1639 line_number = line_count;
1640 while (print_page ())
1644 /* Initialize header information.
1645 If DESC is non-negative, it is a file descriptor open to
1646 FILENAME for reading. */
1648 static void
1649 init_header (char const *filename, int desc)
1651 char *buf = NULL;
1652 struct stat st;
1653 struct timespec t;
1654 int ns;
1655 struct tm *tm;
1657 /* If parallel files or standard input, use current date. */
1658 if (STREQ (filename, "-"))
1659 desc = -1;
1660 if (0 <= desc && fstat (desc, &st) == 0)
1661 t = get_stat_mtime (&st);
1662 else
1664 static struct timespec timespec;
1665 if (! timespec.tv_sec)
1666 gettime (&timespec);
1667 t = timespec;
1670 ns = t.tv_nsec;
1671 tm = localtime (&t.tv_sec);
1672 if (tm == NULL)
1674 buf = xmalloc (INT_BUFSIZE_BOUND (long int)
1675 + MAX (10, INT_BUFSIZE_BOUND (int)));
1676 sprintf (buf, "%ld.%09d", (long int) t.tv_sec, ns);
1678 else
1680 size_t bufsize = nstrftime (NULL, SIZE_MAX, date_format, tm, 0, ns) + 1;
1681 buf = xmalloc (bufsize);
1682 nstrftime (buf, bufsize, date_format, tm, 0, ns);
1685 free (date_text);
1686 date_text = buf;
1687 file_text = custom_header ? custom_header : desc < 0 ? "" : filename;
1688 header_width_available = (chars_per_line
1689 - mbswidth (date_text, 0)
1690 - mbswidth (file_text, 0));
1693 /* Set things up for printing a page
1695 Scan through the columns ...
1696 Determine which are ready to print
1697 (i.e., which have lines stored or open files)
1698 Set p->lines_to_print appropriately
1699 (to p->lines_stored if we're storing, or lines_per_body
1700 if we're reading straight from the file)
1701 Keep track of this total so we know when to stop printing */
1703 static void
1704 init_page (void)
1706 int j;
1707 COLUMN *p;
1709 if (storing_columns)
1711 store_columns ();
1712 for (j = columns - 1, p = column_vector; j; --j, ++p)
1714 p->lines_to_print = p->lines_stored;
1717 /* Last column. */
1718 if (balance_columns)
1720 p->lines_to_print = p->lines_stored;
1722 /* Since we're not balancing columns, we don't need to store
1723 the rightmost column. Read it straight from the file. */
1724 else
1726 if (p->status == OPEN)
1728 p->lines_to_print = lines_per_body;
1730 else
1731 p->lines_to_print = 0;
1734 else
1735 for (j = columns, p = column_vector; j; --j, ++p)
1736 if (p->status == OPEN)
1738 p->lines_to_print = lines_per_body;
1740 else
1741 p->lines_to_print = 0;
1744 /* Align empty columns and print separators.
1745 Empty columns will be formed by files with status ON_HOLD or CLOSED
1746 when printing multiple files in parallel. */
1748 static void
1749 align_column (COLUMN *p)
1751 padding_not_printed = p->start_position;
1752 if (padding_not_printed - col_sep_length > 0)
1754 pad_across_to (padding_not_printed - col_sep_length);
1755 padding_not_printed = ANYWHERE;
1758 if (use_col_separator)
1759 print_sep_string ();
1761 if (p->numbered)
1762 add_line_number (p);
1765 /* Print one page.
1767 As long as there are lines left on the page and columns ready to print,
1768 Scan across the column list
1769 if the column has stored lines or the file is open
1770 pad to the appropriate spot
1771 print the column
1772 pad the remainder of the page with \n or \f as requested
1773 reset the status of all files -- any files which where on hold because
1774 of formfeeds are now put back into the lineup. */
1776 static bool
1777 print_page (void)
1779 int j;
1780 int lines_left_on_page;
1781 COLUMN *p;
1783 /* Used as an accumulator (with | operator) of successive values of
1784 pad_vertically. The trick is to set pad_vertically
1785 to false before each run through the inner loop, then after that
1786 loop, it tells us whether a line was actually printed (whether a
1787 newline needs to be output -- or two for double spacing). But those
1788 values have to be accumulated (in pv) so we can invoke pad_down
1789 properly after the outer loop completes. */
1790 bool pv;
1792 init_page ();
1794 if (cols_ready_to_print () == 0)
1795 return false;
1797 if (extremities)
1798 print_a_header = true;
1800 /* Don't pad unless we know a page was printed. */
1801 pad_vertically = false;
1802 pv = false;
1804 lines_left_on_page = lines_per_body;
1805 if (double_space)
1806 lines_left_on_page *= 2;
1808 while (lines_left_on_page > 0 && cols_ready_to_print () > 0)
1810 output_position = 0;
1811 spaces_not_printed = 0;
1812 separators_not_printed = 0;
1813 pad_vertically = false;
1814 align_empty_cols = false;
1815 empty_line = true;
1817 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1819 input_position = 0;
1820 if (p->lines_to_print > 0 || p->status == FF_FOUND)
1822 FF_only = false;
1823 padding_not_printed = p->start_position;
1824 if (!(p->print_func) (p))
1825 read_rest_of_line (p);
1826 pv |= pad_vertically;
1828 --p->lines_to_print;
1829 if (p->lines_to_print <= 0)
1831 if (cols_ready_to_print () <= 0)
1832 break;
1835 /* File p changed its status to ON_HOLD or CLOSED */
1836 if (parallel_files && p->status != OPEN)
1838 if (empty_line)
1839 align_empty_cols = true;
1840 else if (p->status == CLOSED ||
1841 (p->status == ON_HOLD && FF_only))
1842 align_column (p);
1845 else if (parallel_files)
1847 /* File status ON_HOLD or CLOSED */
1848 if (empty_line)
1849 align_empty_cols = true;
1850 else
1851 align_column (p);
1854 /* We need it also with an empty column */
1855 if (use_col_separator)
1856 ++separators_not_printed;
1859 if (pad_vertically)
1861 putchar ('\n');
1862 --lines_left_on_page;
1865 if (cols_ready_to_print () <= 0 && !extremities)
1866 break;
1868 if (double_space && pv)
1870 putchar ('\n');
1871 --lines_left_on_page;
1875 if (lines_left_on_page == 0)
1876 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1877 if (p->status == OPEN)
1878 p->full_page_printed = true;
1880 pad_vertically = pv;
1882 if (pad_vertically && extremities)
1883 pad_down (lines_left_on_page + lines_per_footer);
1884 else if (keep_FF && print_a_FF)
1886 putchar ('\f');
1887 print_a_FF = false;
1890 if (last_page_number < ++page_number)
1891 return false; /* Stop printing with LAST_PAGE */
1893 reset_status (); /* Change ON_HOLD to OPEN. */
1895 return true; /* More pages to go. */
1898 /* Allocate space for storing columns.
1900 This is necessary when printing multiple columns from a single file.
1901 Lines are stored consecutively in buff, separated by '\0'.
1903 The following doesn't apply any longer - any tuning possible?
1904 (We can't use a fixed offset since with the '-s' flag lines aren't
1905 truncated.)
1907 We maintain a list (line_vector) of pointers to the beginnings
1908 of lines in buff. We allocate one more than the number of lines
1909 because the last entry tells us the index of the last character,
1910 which we need to know in order to print the last line in buff. */
1912 static void
1913 init_store_cols (void)
1915 int total_lines = lines_per_body * columns;
1916 int chars_if_truncate = total_lines * (chars_per_column + 1);
1918 free (line_vector);
1919 /* FIXME: here's where it was allocated. */
1920 line_vector = xmalloc ((total_lines + 1) * sizeof *line_vector);
1922 free (end_vector);
1923 end_vector = xmalloc (total_lines * sizeof *end_vector);
1925 free (buff);
1926 buff_allocated = (use_col_separator
1927 ? 2 * chars_if_truncate
1928 : chars_if_truncate); /* Tune this. */
1929 buff = xmalloc (buff_allocated);
1932 /* Store all but the rightmost column.
1933 (Used when printing a single file in multiple downward columns)
1935 For each column
1936 set p->current_line to be the index in line_vector of the
1937 first line in the column
1938 For each line in the column
1939 store the line in buff
1940 add to line_vector the index of the line's first char
1941 buff_start is the index in buff of the first character in the
1942 current line. */
1944 static void
1945 store_columns (void)
1947 int i, j;
1948 unsigned int line = 0;
1949 unsigned int buff_start;
1950 int last_col; /* The rightmost column which will be saved in buff */
1951 COLUMN *p;
1953 buff_current = 0;
1954 buff_start = 0;
1956 if (balance_columns)
1957 last_col = columns;
1958 else
1959 last_col = columns - 1;
1961 for (i = 1, p = column_vector; i <= last_col; ++i, ++p)
1962 p->lines_stored = 0;
1964 for (i = 1, p = column_vector; i <= last_col && files_ready_to_read;
1965 ++i, ++p)
1967 p->current_line = line;
1968 for (j = lines_per_body; j && files_ready_to_read; --j)
1970 if (p->status == OPEN) /* Redundant. Clean up. */
1972 input_position = 0;
1974 if (!read_line (p))
1975 read_rest_of_line (p);
1977 if (p->status == OPEN
1978 || buff_start != buff_current)
1980 ++p->lines_stored;
1981 line_vector[line] = buff_start;
1982 end_vector[line++] = input_position;
1983 buff_start = buff_current;
1988 /* Keep track of the location of the last char in buff. */
1989 line_vector[line] = buff_start;
1991 if (balance_columns)
1992 balance (line);
1995 static void
1996 balance (int total_stored)
1998 COLUMN *p;
1999 int i, lines;
2000 int first_line = 0;
2002 for (i = 1, p = column_vector; i <= columns; ++i, ++p)
2004 lines = total_stored / columns;
2005 if (i <= total_stored % columns)
2006 ++lines;
2008 p->lines_stored = lines;
2009 p->current_line = first_line;
2011 first_line += lines;
2015 /* Store a character in the buffer. */
2017 static void
2018 store_char (char c)
2020 if (buff_current >= buff_allocated)
2022 /* May be too generous. */
2023 buff = X2REALLOC (buff, &buff_allocated);
2025 buff[buff_current++] = c;
2028 static void
2029 add_line_number (COLUMN *p)
2031 int i;
2032 char *s;
2033 int left_cut;
2035 /* Cutting off the higher-order digits is more informative than
2036 lower-order cut off*/
2037 if (line_number < power_10)
2038 sprintf (number_buff, "%*d", chars_per_number, line_number);
2039 else
2041 left_cut = line_number % power_10;
2042 sprintf (number_buff, "%0*d", chars_per_number, left_cut);
2044 line_number++;
2045 s = number_buff;
2046 for (i = chars_per_number; i > 0; i--)
2047 (p->char_func) (*s++);
2049 if (columns > 1)
2051 /* Tabification is assumed for multiple columns, also for n-separators,
2052 but `default n-separator = TAB' hasn't been given priority over
2053 equal column_width also specified by POSIX. */
2054 if (number_separator == '\t')
2056 i = number_width - chars_per_number;
2057 while (i-- > 0)
2058 (p->char_func) (' ');
2060 else
2061 (p->char_func) (number_separator);
2063 else
2064 /* To comply with POSIX, we avoid any expansion of default TAB
2065 separator with a single column output. No column_width requirement
2066 has to be considered. */
2068 (p->char_func) (number_separator);
2069 if (number_separator == '\t')
2070 output_position = POS_AFTER_TAB (chars_per_output_tab,
2071 output_position);
2074 if (truncate_lines && !parallel_files)
2075 input_position += number_width;
2078 /* Print (or store) padding until the current horizontal position
2079 is position. */
2081 static void
2082 pad_across_to (int position)
2084 int h = output_position;
2086 if (tabify_output)
2087 spaces_not_printed = position - output_position;
2088 else
2090 while (++h <= position)
2091 putchar (' ');
2092 output_position = position;
2096 /* Pad to the bottom of the page.
2098 If the user has requested a formfeed, use one.
2099 Otherwise, use newlines. */
2101 static void
2102 pad_down (int lines)
2104 int i;
2106 if (use_form_feed)
2107 putchar ('\f');
2108 else
2109 for (i = lines; i; --i)
2110 putchar ('\n');
2113 /* Read the rest of the line.
2115 Read from the current column's file until an end of line is
2116 hit. Used when we've truncated a line and we no longer need
2117 to print or store its characters. */
2119 static void
2120 read_rest_of_line (COLUMN *p)
2122 int c;
2123 FILE *f = p->fp;
2125 while ((c = getc (f)) != '\n')
2127 if (c == '\f')
2129 if ((c = getc (f)) != '\n')
2130 ungetc (c, f);
2131 if (keep_FF)
2132 print_a_FF = true;
2133 hold_file (p);
2134 break;
2136 else if (c == EOF)
2138 close_file (p);
2139 break;
2144 /* Read a line with skip_to_page.
2146 Read from the current column's file until an end of line is
2147 hit. Used when we read full lines to skip pages.
2148 With skip_to_page we have to check for FF-coincidence which is done
2149 in function read_line otherwise.
2150 Count lines of skipped pages to find the line number of 1st page
2151 printed relative to 1st line of input file (start_line_num). */
2153 static void
2154 skip_read (COLUMN *p, int column_number)
2156 int c;
2157 FILE *f = p->fp;
2158 int i;
2159 bool single_ff = false;
2160 COLUMN *q;
2162 /* Read 1st character in a line or any character succeeding a FF */
2163 if ((c = getc (f)) == '\f' && p->full_page_printed)
2164 /* A FF-coincidence with a previous full_page_printed.
2165 To avoid an additional empty page, eliminate the FF */
2166 if ((c = getc (f)) == '\n')
2167 c = getc (f);
2169 p->full_page_printed = false;
2171 /* 1st character a FF means a single FF without any printable
2172 characters. Don't count it as a line with -n option. */
2173 if (c == '\f')
2174 single_ff = true;
2176 /* Preparing for a FF-coincidence: Maybe we finish that page
2177 without a FF found */
2178 if (last_line)
2179 p->full_page_printed = true;
2181 while (c != '\n')
2183 if (c == '\f')
2185 /* No FF-coincidence possible,
2186 no catching up of a FF-coincidence with next page */
2187 if (last_line)
2189 if (!parallel_files)
2190 for (q = column_vector, i = columns; i; ++q, --i)
2191 q->full_page_printed = false;
2192 else
2193 p->full_page_printed = false;
2196 if ((c = getc (f)) != '\n')
2197 ungetc (c, f);
2198 hold_file (p);
2199 break;
2201 else if (c == EOF)
2203 close_file (p);
2204 break;
2206 c = getc (f);
2209 if (skip_count)
2210 if ((!parallel_files || column_number == 1) && !single_ff)
2211 ++line_count;
2214 /* If we're tabifying output,
2216 When print_char encounters white space it keeps track
2217 of our desired horizontal position and delays printing
2218 until this function is called. */
2220 static void
2221 print_white_space (void)
2223 int h_new;
2224 int h_old = output_position;
2225 int goal = h_old + spaces_not_printed;
2227 while (goal - h_old > 1
2228 && (h_new = POS_AFTER_TAB (chars_per_output_tab, h_old)) <= goal)
2230 putchar (output_tab_char);
2231 h_old = h_new;
2233 while (++h_old <= goal)
2234 putchar (' ');
2236 output_position = goal;
2237 spaces_not_printed = 0;
2240 /* Print column separators.
2242 We keep a count until we know that we'll be printing a line,
2243 then print_sep_string() is called. */
2245 static void
2246 print_sep_string (void)
2248 char *s;
2249 int l = col_sep_length;
2251 s = col_sep_string;
2253 if (separators_not_printed <= 0)
2255 /* We'll be starting a line with chars_per_margin, anything else? */
2256 if (spaces_not_printed > 0)
2257 print_white_space ();
2259 else
2261 for (; separators_not_printed > 0; --separators_not_printed)
2263 while (l-- > 0)
2265 /* 3 types of sep_strings: spaces only, spaces and chars,
2266 chars only */
2267 if (*s == ' ')
2269 /* We're tabifying output; consecutive spaces in
2270 sep_string may have to be converted to tabs */
2271 s++;
2272 ++spaces_not_printed;
2274 else
2276 if (spaces_not_printed > 0)
2277 print_white_space ();
2278 putchar (*s++);
2279 ++output_position;
2282 /* sep_string ends with some spaces */
2283 if (spaces_not_printed > 0)
2284 print_white_space ();
2289 /* Print (or store, depending on p->char_func) a clump of N
2290 characters. */
2292 static void
2293 print_clump (COLUMN *p, int n, char *clump)
2295 while (n--)
2296 (p->char_func) (*clump++);
2299 /* Print a character.
2301 Update the following comment: process-char hasn't been used any
2302 longer.
2303 If we're tabifying, all tabs have been converted to spaces by
2304 process_char(). Keep a count of consecutive spaces, and when
2305 a nonspace is encountered, call print_white_space() to print the
2306 required number of tabs and spaces. */
2308 static void
2309 print_char (char c)
2311 if (tabify_output)
2313 if (c == ' ')
2315 ++spaces_not_printed;
2316 return;
2318 else if (spaces_not_printed > 0)
2319 print_white_space ();
2321 /* Nonprintables are assumed to have width 0, except '\b'. */
2322 if (! isprint (to_uchar (c)))
2324 if (c == '\b')
2325 --output_position;
2327 else
2328 ++output_position;
2330 putchar (c);
2333 /* Skip to page PAGE before printing.
2334 PAGE may be larger than total number of pages. */
2336 static bool
2337 skip_to_page (uintmax_t page)
2339 uintmax_t n;
2340 int i;
2341 int j;
2342 COLUMN *p;
2344 for (n = 1; n < page; ++n)
2346 for (i = 1; i < lines_per_body; ++i)
2348 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2349 if (p->status == OPEN)
2350 skip_read (p, j);
2352 last_line = true;
2353 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2354 if (p->status == OPEN)
2355 skip_read (p, j);
2357 if (storing_columns) /* change FF_FOUND to ON_HOLD */
2358 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2359 if (p->status != CLOSED)
2360 p->status = ON_HOLD;
2362 reset_status ();
2363 last_line = false;
2365 if (files_ready_to_read < 1)
2367 /* It's very helpful, normally the total number of pages is
2368 not known in advance. */
2369 error (0, 0,
2370 _("starting page number %"PRIuMAX
2371 " exceeds page count %"PRIuMAX),
2372 page, n);
2373 break;
2376 return files_ready_to_read > 0;
2379 /* Print a header.
2381 Formfeeds are assumed to use up two lines at the beginning of
2382 the page. */
2384 static void
2385 print_header (void)
2387 char page_text[256 + INT_STRLEN_BOUND (page_number)];
2388 int available_width;
2389 int lhs_spaces;
2390 int rhs_spaces;
2392 output_position = 0;
2393 pad_across_to (chars_per_margin);
2394 print_white_space ();
2396 if (page_number == 0)
2397 error (EXIT_FAILURE, 0, _("page number overflow"));
2399 /* The translator must ensure that formatting the translation of
2400 "Page %"PRIuMAX does not generate more than (sizeof page_text - 1)
2401 bytes. */
2402 sprintf (page_text, _("Page %"PRIuMAX), page_number);
2403 available_width = header_width_available - mbswidth (page_text, 0);
2404 available_width = MAX (0, available_width);
2405 lhs_spaces = available_width >> 1;
2406 rhs_spaces = available_width - lhs_spaces;
2408 printf ("\n\n%*s%s%*s%s%*s%s\n\n\n",
2409 chars_per_margin, "",
2410 date_text, lhs_spaces, " ",
2411 file_text, rhs_spaces, " ", page_text);
2413 print_a_header = false;
2414 output_position = 0;
2417 /* Print (or store, if p->char_func is store_char()) a line.
2419 Read a character to determine whether we have a line or not.
2420 (We may hit EOF, \n, or \f)
2422 Once we know we have a line,
2423 set pad_vertically = true, meaning it's safe
2424 to pad down at the end of the page, since we do have a page.
2425 print a header if needed.
2426 pad across to padding_not_printed if needed.
2427 print any separators which need to be printed.
2428 print a line number if it needs to be printed.
2430 Print the clump which corresponds to the first character.
2432 Enter a loop and keep printing until an end of line condition
2433 exists, or until we exceed chars_per_column.
2435 Return false if we exceed chars_per_column before reading
2436 an end of line character, true otherwise. */
2438 static bool
2439 read_line (COLUMN *p)
2441 int c;
2442 int chars IF_LINT ( = 0);
2443 int last_input_position;
2444 int j, k;
2445 COLUMN *q;
2447 /* read 1st character in each line or any character succeeding a FF: */
2448 c = getc (p->fp);
2450 last_input_position = input_position;
2452 if (c == '\f' && p->full_page_printed)
2453 if ((c = getc (p->fp)) == '\n')
2454 c = getc (p->fp);
2455 p->full_page_printed = false;
2457 switch (c)
2459 case '\f':
2460 if ((c = getc (p->fp)) != '\n')
2461 ungetc (c, p->fp);
2462 FF_only = true;
2463 if (print_a_header && !storing_columns)
2465 pad_vertically = true;
2466 print_header ();
2468 else if (keep_FF)
2469 print_a_FF = true;
2470 hold_file (p);
2471 return true;
2472 case EOF:
2473 close_file (p);
2474 return true;
2475 case '\n':
2476 break;
2477 default:
2478 chars = char_to_clump (c);
2481 if (truncate_lines && input_position > chars_per_column)
2483 input_position = last_input_position;
2484 return false;
2487 if (p->char_func != store_char)
2489 pad_vertically = true;
2491 if (print_a_header && !storing_columns)
2492 print_header ();
2494 if (parallel_files && align_empty_cols)
2496 /* We have to align empty columns at the beginning of a line. */
2497 k = separators_not_printed;
2498 separators_not_printed = 0;
2499 for (j = 1, q = column_vector; j <= k; ++j, ++q)
2501 align_column (q);
2502 separators_not_printed += 1;
2504 padding_not_printed = p->start_position;
2505 if (truncate_lines)
2506 spaces_not_printed = chars_per_column;
2507 else
2508 spaces_not_printed = 0;
2509 align_empty_cols = false;
2512 if (padding_not_printed - col_sep_length > 0)
2514 pad_across_to (padding_not_printed - col_sep_length);
2515 padding_not_printed = ANYWHERE;
2518 if (use_col_separator)
2519 print_sep_string ();
2522 if (p->numbered)
2523 add_line_number (p);
2525 empty_line = false;
2526 if (c == '\n')
2527 return true;
2529 print_clump (p, chars, clump_buff);
2531 while (true)
2533 c = getc (p->fp);
2535 switch (c)
2537 case '\n':
2538 return true;
2539 case '\f':
2540 if ((c = getc (p->fp)) != '\n')
2541 ungetc (c, p->fp);
2542 if (keep_FF)
2543 print_a_FF = true;
2544 hold_file (p);
2545 return true;
2546 case EOF:
2547 close_file (p);
2548 return true;
2551 last_input_position = input_position;
2552 chars = char_to_clump (c);
2553 if (truncate_lines && input_position > chars_per_column)
2555 input_position = last_input_position;
2556 return false;
2559 print_clump (p, chars, clump_buff);
2563 /* Print a line from buff.
2565 If this function has been called, we know we have "something to
2566 print". But it remains to be seen whether we have a real text page
2567 or an empty page (a single form feed) with/without a header only.
2568 Therefore first we set pad_vertically to true and print a header
2569 if necessary.
2570 If FF_FOUND and we are using -t|-T option we omit any newline by
2571 setting pad_vertically to false (see print_page).
2572 Otherwise we pad across if necessary, print separators if necessary
2573 and text of COLUMN *p.
2575 Return true, meaning there is no need to call read_rest_of_line. */
2577 static bool
2578 print_stored (COLUMN *p)
2580 COLUMN *q;
2581 int i;
2583 int line = p->current_line++;
2584 char *first = &buff[line_vector[line]];
2585 /* FIXME
2586 UMR: Uninitialized memory read:
2587 * This is occurring while in:
2588 print_stored [pr.c:2239]
2589 * Reading 4 bytes from 0x5148c in the heap.
2590 * Address 0x5148c is 4 bytes into a malloc'd block at 0x51488 of 676 bytes
2591 * This block was allocated from:
2592 malloc [rtlib.o]
2593 xmalloc [xmalloc.c:94]
2594 init_store_cols [pr.c:1648]
2596 char *last = &buff[line_vector[line + 1]];
2598 pad_vertically = true;
2600 if (print_a_header)
2601 print_header ();
2603 if (p->status == FF_FOUND)
2605 for (i = 1, q = column_vector; i <= columns; ++i, ++q)
2606 q->status = ON_HOLD;
2607 if (column_vector->lines_to_print <= 0)
2609 if (!extremities)
2610 pad_vertically = false;
2611 return true; /* print a header only */
2615 if (padding_not_printed - col_sep_length > 0)
2617 pad_across_to (padding_not_printed - col_sep_length);
2618 padding_not_printed = ANYWHERE;
2621 if (use_col_separator)
2622 print_sep_string ();
2624 while (first != last)
2625 print_char (*first++);
2627 if (spaces_not_printed == 0)
2629 output_position = p->start_position + end_vector[line];
2630 if (p->start_position - col_sep_length == chars_per_margin)
2631 output_position -= col_sep_length;
2634 return true;
2637 /* Convert a character to the proper format and return the number of
2638 characters in the resulting clump. Increment input_position by
2639 the width of the clump.
2641 Tabs are converted to clumps of spaces.
2642 Nonprintable characters may be converted to clumps of escape
2643 sequences or control prefixes.
2645 Note: the width of a clump is not necessarily equal to the number of
2646 characters in clump_buff. (e.g, the width of '\b' is -1, while the
2647 number of characters is 1.) */
2649 static int
2650 char_to_clump (char c)
2652 unsigned char uc = c;
2653 char *s = clump_buff;
2654 int i;
2655 char esc_buff[4];
2656 int width;
2657 int chars;
2658 int chars_per_c = 8;
2660 if (c == input_tab_char)
2661 chars_per_c = chars_per_input_tab;
2663 if (c == input_tab_char || c == '\t')
2665 width = TAB_WIDTH (chars_per_c, input_position);
2667 if (untabify_input)
2669 for (i = width; i; --i)
2670 *s++ = ' ';
2671 chars = width;
2673 else
2675 *s = c;
2676 chars = 1;
2680 else if (! isprint (uc))
2682 if (use_esc_sequence)
2684 width = 4;
2685 chars = 4;
2686 *s++ = '\\';
2687 sprintf (esc_buff, "%03o", uc);
2688 for (i = 0; i <= 2; ++i)
2689 *s++ = esc_buff[i];
2691 else if (use_cntrl_prefix)
2693 if (uc < 0200)
2695 width = 2;
2696 chars = 2;
2697 *s++ = '^';
2698 *s = c ^ 0100;
2700 else
2702 width = 4;
2703 chars = 4;
2704 *s++ = '\\';
2705 sprintf (esc_buff, "%03o", uc);
2706 for (i = 0; i <= 2; ++i)
2707 *s++ = esc_buff[i];
2710 else if (c == '\b')
2712 width = -1;
2713 chars = 1;
2714 *s = c;
2716 else
2718 width = 0;
2719 chars = 1;
2720 *s = c;
2723 else
2725 width = 1;
2726 chars = 1;
2727 *s = c;
2730 /* Too many backspaces must put us in position 0 -- never negative. */
2731 if (width < 0 && input_position == 0)
2733 chars = 0;
2734 input_position = 0;
2736 else if (width < 0 && input_position <= -width)
2737 input_position = 0;
2738 else
2739 input_position += width;
2741 return chars;
2744 /* We've just printed some files and need to clean up things before
2745 looking for more options and printing the next batch of files.
2747 Free everything we've xmalloc'ed, except `header'. */
2749 static void
2750 cleanup (void)
2752 free (number_buff);
2753 free (clump_buff);
2754 free (column_vector);
2755 free (line_vector);
2756 free (end_vector);
2757 free (buff);
2760 /* Complain, print a usage message, and die. */
2762 void
2763 usage (int status)
2765 if (status != EXIT_SUCCESS)
2766 fprintf (stderr, _("Try `%s --help' for more information.\n"),
2767 program_name);
2768 else
2770 printf (_("\
2771 Usage: %s [OPTION]... [FILE]...\n\
2773 program_name);
2775 fputs (_("\
2776 Paginate or columnate FILE(s) for printing.\n\
2778 "), stdout);
2779 fputs (_("\
2780 Mandatory arguments to long options are mandatory for short options too.\n\
2781 "), stdout);
2782 fputs (_("\
2783 +FIRST_PAGE[:LAST_PAGE], --pages=FIRST_PAGE[:LAST_PAGE]\n\
2784 begin [stop] printing with page FIRST_[LAST_]PAGE\n\
2785 -COLUMN, --columns=COLUMN\n\
2786 output COLUMN columns and print columns down,\n\
2787 unless -a is used. Balance number of lines in the\n\
2788 columns on each page\n\
2789 "), stdout);
2790 fputs (_("\
2791 -a, --across print columns across rather than down, used together\n\
2792 with -COLUMN\n\
2793 -c, --show-control-chars\n\
2794 use hat notation (^G) and octal backslash notation\n\
2795 -d, --double-space\n\
2796 double space the output\n\
2797 "), stdout);
2798 fputs (_("\
2799 -D, --date-format=FORMAT\n\
2800 use FORMAT for the header date\n\
2801 -e[CHAR[WIDTH]], --expand-tabs[=CHAR[WIDTH]]\n\
2802 expand input CHARs (TABs) to tab WIDTH (8)\n\
2803 -F, -f, --form-feed\n\
2804 use form feeds instead of newlines to separate pages\n\
2805 (by a 3-line page header with -F or a 5-line header\n\
2806 and trailer without -F)\n\
2807 "), stdout);
2808 fputs (_("\
2809 -h, --header=HEADER\n\
2810 use a centered HEADER instead of filename in page header,\n\
2811 -h \"\" prints a blank line, don't use -h\"\"\n\
2812 -i[CHAR[WIDTH]], --output-tabs[=CHAR[WIDTH]]\n\
2813 replace spaces with CHARs (TABs) to tab WIDTH (8)\n\
2814 -J, --join-lines merge full lines, turns off -W line truncation, no column\n\
2815 alignment, --sep-string[=STRING] sets separators\n\
2816 "), stdout);
2817 fputs (_("\
2818 -l, --length=PAGE_LENGTH\n\
2819 set the page length to PAGE_LENGTH (66) lines\n\
2820 (default number of lines of text 56, and with -F 63)\n\
2821 -m, --merge print all files in parallel, one in each column,\n\
2822 truncate lines, but join lines of full length with -J\n\
2823 "), stdout);
2824 fputs (_("\
2825 -n[SEP[DIGITS]], --number-lines[=SEP[DIGITS]]\n\
2826 number lines, use DIGITS (5) digits, then SEP (TAB),\n\
2827 default counting starts with 1st line of input file\n\
2828 -N, --first-line-number=NUMBER\n\
2829 start counting with NUMBER at 1st line of first\n\
2830 page printed (see +FIRST_PAGE)\n\
2831 "), stdout);
2832 fputs (_("\
2833 -o, --indent=MARGIN\n\
2834 offset each line with MARGIN (zero) spaces, do not\n\
2835 affect -w or -W, MARGIN will be added to PAGE_WIDTH\n\
2836 -r, --no-file-warnings\n\
2837 omit warning when a file cannot be opened\n\
2838 "), stdout);
2839 fputs (_("\
2840 -s[CHAR], --separator[=CHAR]\n\
2841 separate columns by a single character, default for CHAR\n\
2842 is the <TAB> character without -w and \'no char\' with -w\n\
2843 -s[CHAR] turns off line truncation of all 3 column\n\
2844 options (-COLUMN|-a -COLUMN|-m) except -w is set\n\
2845 "), stdout);
2846 fputs (_("\
2847 -SSTRING, --sep-string[=STRING]\n\
2848 separate columns by STRING,\n\
2849 without -S: Default separator <TAB> with -J and <space>\n\
2850 otherwise (same as -S\" \"), no effect on column options\n\
2851 -t, --omit-header omit page headers and trailers\n\
2852 "), stdout);
2853 fputs (_("\
2854 -T, --omit-pagination\n\
2855 omit page headers and trailers, eliminate any pagination\n\
2856 by form feeds set in input files\n\
2857 -v, --show-nonprinting\n\
2858 use octal backslash notation\n\
2859 -w, --width=PAGE_WIDTH\n\
2860 set page width to PAGE_WIDTH (72) characters for\n\
2861 multiple text-column output only, -s[char] turns off (72)\n\
2862 "), stdout);
2863 fputs (_("\
2864 -W, --page-width=PAGE_WIDTH\n\
2865 set page width to PAGE_WIDTH (72) characters always,\n\
2866 truncate lines, except -J option is set, no interference\n\
2867 with -S or -s\n\
2868 "), stdout);
2869 fputs (HELP_OPTION_DESCRIPTION, stdout);
2870 fputs (VERSION_OPTION_DESCRIPTION, stdout);
2871 fputs (_("\
2873 -t is implied if PAGE_LENGTH <= 10. With no FILE, or when FILE is -, read\n\
2874 standard input.\n\
2875 "), stdout);
2876 emit_ancillary_info ();
2878 exit (status);