(noinst_HEADERS): Add nanosleep.h.
[coreutils.git] / src / pr.c
blob115b6a4a5f3555fa50c5a0af7d3295ed2b4cf5cc
1 /* pr -- convert text files for printing.
2 Copyright (C) 88, 91, 1995-2000 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
7 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, write to the Free Software Foundation,
16 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18 /* By Pete TerMaat, with considerable refinement by Roland Huebner. */
20 /* Things to watch: Sys V screws up on ...
21 pr -n -3 -s: /usr/dict/words
22 pr -m -o10 -n /usr/dict/words{,,,}
23 pr -6 -a -n -o5 /usr/dict/words
25 Ideas:
27 Keep a things_to_do list of functions to call when we know we have
28 something to print. Cleaner than current series of checks.
30 Improve the printing of control prefixes.
32 Expand the filename in the centered header line to a full pathname.
35 Concept:
37 If the input_tab_char differs from the default value TAB
38 (`-e[CHAR[...]]' is used), any input text tab is expanded to the
39 default width of 8 spaces (compare char_to_clump). - Same as SunOS
40 does.
42 The treatment of the number_separator (compare add_line_number):
43 The default value TAB of the number_separator (`-n[SEP[...]]') doesn't
44 be thought to be an input character. An optional `-e'-input has no
45 effect.
46 - With single column output
47 only one POSIX requirement has to be met:
48 The default n-separator should be a TAB. The consequence is a
49 different width between the number an the text if the output position
50 of the separator changes, i.e. it depends upon the left margin used.
51 That's not nice but easy-to-use together with the defaults of other
52 utilities, e.g. sort or cut. - Same as SunOS does.
53 - With multicolumn output
54 two conflicting POSIX requirements exist:
55 First `default n-separator is TAB', second `output text columns shall
56 be of equal width'. Moreover POSIX specifies the number+separator a
57 part of the column, together with `-COLUMN' and `-a -COLUMN'.
58 (With -m output the number shall occupy each line only once. Exactly
59 the same situation as single column output exists.)
60 GNU pr gives priority to the 2nd requirement and observes POSIX
61 column definition. The n-separator TAB is expanded to the same number
62 of spaces in each column using the default value 8. Tabification is
63 only performed if it is compatible with the output position.
64 Consequence: The output text columns are of equal width. The layout
65 of a page does not change if the left margin varies. - Looks better
66 than the SunOS approach.
67 SunOS pr gives priority to the 1st requirement. n-separator TAB
68 width varies with each column. Only the width of text part of the
69 column is fixed.
70 Consequence: The output text columns don't have equal width. The
71 widths and the layout of the whole page varies with the left margin.
72 An overflow of the line length (without margin) over the input value
73 PAGE_WIDTH may occur.
75 The interference of the POSIX-compliant small letter options -w and -s:
76 (`interference' means `setting a _separator_ with -s switches off the
77 column sturctur and the default - not generally - page_width,
78 acts on -w option')
79 options: text form / separator: equivalent new capital
80 -w l -s[x] letter options:
81 --------------------------------------------------------------------
82 1. -- -- columns / space --
83 trunc. to page_width = 72
84 2. -- -s[:] full lines / TAB[:] -J -S["<TAB>"|:]
85 no truncation
86 3. -w l -- columns / space -W l
87 trunc. to page_width = l
88 4. -w l -s[:] columns / no sep.[:] -W l -S[:]
89 trunc. to page_width = l
90 --------------------------------------------------------------------
93 Options:
95 Including version 1.22i:
96 Some SMALL LETTER options has been redefined with the object of a
97 better POSIX compliance. The output of some further cases has been
98 adapted to other UNIXes. A violation of downward compatibility has to
99 be accepted.
100 Some NEW CAPITAL LETTER options ( -J, -S, -W) has been introduced to
101 turn off unexpected interferences of small letter options (-s and -w
102 together with the three column options).
103 -N option and the second argument LAST_PAGE of +FIRST_PAGE offer more
104 flexibility; The detailed handling of form feeds set in the input
105 files requires -T option.
107 Capital letter options dominate small letter ones.
109 Some of the option-arguments cannot be specified as separate arguments
110 from the preceding option letter (already stated in POSIX specification).
112 Form feeds in the input cause page breaks in the output. Multiple
113 form feeds produce empty pages.
115 +FIRST_PAGE[:LAST_PAGE], --pages=FIRST_PAGE[:LAST_PAGE]
116 begin [stop] printing with page FIRST_[LAST_]PAGE
118 -COLUMN, --columns=COLUMN
119 Produce output that is COLUMN columns wide and
120 print columns down, unless -a is used. Balance number of
121 lines in the columns on each page.
123 -a, --across Print columns across rather than down, used
124 together with -COLUMN. The input
127 three
128 four
129 will be printed with `-a -3' as
130 one two three
131 four
133 -b Balance columns on the last page.
134 -b is no longer an independent option. It's always used
135 together with -COLUMN (unless -a is used) to get a
136 consistent formulation with "FF set by hand" in input
137 files. Each formfeed found terminates the number of lines
138 to be read with the actual page. The situation for
139 printing columns down is equivalent to that on the last
140 page. So we need a balancing.
142 Keeping -b as an underground option guarantees some
143 downward compatibility. Utilities using pr with -b
144 (a most frequently used form) still work as usual.
146 -c, --show-control-chars
147 Print unprintable characters as control prefixes.
148 Control-g is printed as ^G (use hat notation) and
149 octal backslash notation.
151 -d, --double-space Double space the output.
153 -e[CHAR[WIDTH]], --expand-tabs[=CHAR[WIDTH]]
154 Expand tabs to spaces on input. Optional argument CHAR
155 is the input TAB character. (Default is TAB). Optional
156 argument WIDTH is the input TAB character's width.
157 (Default is 8.)
159 -F, -f, --form-feed Use formfeeds instead of newlines to separate
160 pages. A three line HEADER is used, no TRAILER with -F,
161 without -F both HEADER and TRAILER are made of five lines.
163 -h HEADER, --header=HEADER
164 Replace the filename in the header with the string HEADER.
165 Checking and left-hand-side truncation of the length of the
166 standard and custom header string. A centered header is used.
167 The format of date and time has been shortened
168 to yyyy-mm-dd HH:MM to give place to a maximal filename
169 information.
170 -h "" now prints a blank line header. -h"" shows an error.
172 -i[CHAR[WIDTH]], --output-tabs[=CHAR[WIDTH]]
173 Replace spaces with tabs on output. Optional argument
174 CHAR is the output TAB character. (Default is TAB).
175 Optional argument WIDTH is the output TAB character's
176 width. (Default is 8)
178 -J, --join-lines Merge lines of full length, turns off -W/-w
179 line truncation, no column alignment, -S[STRING] sets
180 separators, works with all column options
181 (-COLUMN | -a -COLUMN | -m).
182 -J has been introduced (together with -W and -S) to
183 disentangle the old (POSIX compliant) options -w, -s
184 along with the 3 column options.
186 -l PAGE_LENGTH, --length=PAGE_LENGTH
187 Set the page length to PAGE_LENGTH lines. Default is 66,
188 including 5 lines of HEADER and 5 lines of TRAILER
189 without -F, but only 3 lines of HEADER and no TRAILER
190 with -F (i.e the number of text lines defaults to 56 or
191 63 respectively).
193 -m, --merge Print files in parallel; pad_across_to align
194 columns; truncate lines and print separator strings;
195 Do it also with empty columns to get a continuous line
196 numbering and column marking by separators throughout
197 the whole merged file.
199 Empty pages in some input files produce empty columns
200 [marked by separators] in the merged pages. Completely
201 empty merged pages show no column separators at all.
203 The layout of a merged page is ruled by the largest form
204 feed distance of the single pages at that page. Shorter
205 columns will be filled up with empty lines.
207 Together with -J option join lines of full length and
208 set separators when -S option is used.
210 -n[SEP[DIGITS]], --number-lines[=SEP[DIGITS]]
211 Provide DIGITS digit line numbering (default for DIGITS
212 is 5). With multicolumn output the number occupies the
213 first DIGITS column positions of each text column or only
214 each line of -m output.
215 With single column output the number precedes each line
216 just as -m output.
217 Optional argument SEP is the character appended to the
218 line number to separate it from the text followed.
219 The default separator is a TAB. In a strict sense a TAB
220 is always printed with single column output only. The
221 TAB-width varies with the TAB-position, e.g. with the
222 left margin specified by -o option.
223 With multicolumn output priority is given to `equal width
224 of output columns' (a POSIX specification). The TAB-width
225 is fixed to the value of the 1st column and does not
226 change with different values of left margin. That means a
227 fixed number of spaces is always printed in the place of
228 a TAB. The tabification depends upon the output
229 position.
231 Default counting of the line numbers starts with 1st
232 line of the input file (not the 1st line printed,
233 compare the --page option and -N option).
235 -N NUMBER, --first-line-number=NUMBER
236 Start line counting with the number NUMBER at the 1st
237 line of first page printed (mostly not the 1st line of
238 the input file).
240 -o MARGIN, --indent=MARGIN
241 Offset each line with a margin MARGIN spaces wide.
242 Total page width is the size of the margin plus the
243 PAGE_WIDTH set with -W/-w option.
245 -r, --no-file-warnings
246 Omit warning when a file cannot be opened.
248 -s[CHAR], --separator[=CHAR]
249 Separate columns by a single character CHAR, default for
250 CHAR is the TAB character without -w and 'no char' with -w.
251 Without `-s' default separator `space' is set.
252 -s[CHAR] turns off line truncation of all 3 column options
253 (-COLUMN|-a -COLUMN|-m) except -w is set. That is a POSIX
254 compliant formulation. The source code translates -s into
255 the new options -S and -J, also -W if required.
257 -S[STRING], --sep-string[=STRING]
258 Separate columns by any string STRING. The -S option
259 doesn't react upon the -W/-w option (unlike -s option
260 does). It defines a separator nothing else.
261 Without -S: Default separator TAB is used with -J and
262 `space' otherwise (same as -S" ").
263 With -S only: No separator is used, same as -S"".
264 Quotes should be used with blanks and some shell active
265 characters.
266 Don't use -S "STRING". Some of the options don't allow the
267 option letter to be separated from its argument. -S/-s is
268 one of them. That's POSIX compliant.
270 -t, --omit-header Do not print headers or footers but retain form
271 feeds set in the input files.
273 -T, --omit-pagination
274 Do not print headers or footers, eliminate any pagination
275 by form feeds set in the input files.
277 -v, --show-nonprinting
278 Print unprintable characters as escape sequences. Use
279 octal backslash notation. Control-G becomes \007.
281 -w PAGE_WIDTH, --width=PAGE_WIDTH
282 Set page width to PAGE_WIDTH characters for multiple
283 text-column output only (default for PAGE_WIDTH is 72).
284 -s[CHAR] turns off the default page width and any line
285 truncation. Lines of full length will be merged,
286 regardless of the column options set. A POSIX compliant
287 formulation.
289 -W PAGE_WIDTH, --page-width=PAGE_WIDTH
290 Set the page width to PAGE_WIDTH characters. That's valid
291 with and without a column option. Text lines will be
292 truncated, unless -J is used. Together with one of the
293 column options (-COLUMN| -a -COLUMN| -m) column alignment
294 is always used.
295 Default is 72 characters.
296 Without -W PAGE_WIDTH
297 - but with one of the column options default truncation of
298 72 characters is used (to keep downward compatibility
299 and to simplify most frequently met column tasks).
300 Column alignment and column separators are used.
301 - and without any of the column options NO line truncation
302 is used (to keep downward compatibility and to meet most
303 frequent tasks). That's equivalent to -W 72 -J .
305 With/without -W PAGE_WIDTH the header line is always
306 truncated to avoid line overflow.
308 (In pr versions newer than 1.14 -S option does no longer
309 affect -W option.)
314 #include <config.h>
316 #include <stdio.h>
317 #include <getopt.h>
318 #include <sys/types.h>
319 #include <time.h>
320 #include "system.h"
321 #include "error.h"
322 #include "xstrtol.h"
324 /* The official name of this program (e.g., no `g' prefix). */
325 #define PROGRAM_NAME "pr"
327 #define AUTHORS "Pete TerMaat and Roland Huebner"
329 #ifndef TRUE
330 # define TRUE 1
331 # define FALSE 0
332 #endif
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 struct COLUMN
380 FILE *fp; /* Input stream for this column. */
381 char *name; /* File name. */
382 enum
384 OPEN,
385 FF_FOUND, /* used with -b option, set with \f, changed
386 to ON_HOLD after print_header */
387 ON_HOLD, /* Hit a form feed. */
388 CLOSED
390 status; /* Status of the file pointer. */
391 int (*print_func) (); /* Func to print lines in this col. */
392 void (*char_func) (); /* Func to print/store chars in this col. */
393 int current_line; /* Index of current place in line_vector. */
394 int lines_stored; /* Number of lines stored in buff. */
395 int lines_to_print; /* No. lines stored or space left on page. */
396 int start_position; /* Horizontal position of first char. */
397 int numbered;
398 int full_page_printed; /* True means printed without a FF found. */
400 /* p->full_page_printed controls a special case of "FF set by hand":
401 True means a full page has been printed without FF found. To avoid an
402 additional empty page we have to ignore a FF immediately following in
403 the next line. */
406 typedef struct COLUMN COLUMN;
408 #define NULLCOL (COLUMN *)0
410 static int char_to_clump PARAMS ((int c));
411 static int read_line PARAMS ((COLUMN *p));
412 static int print_page PARAMS ((void));
413 static int print_stored PARAMS ((COLUMN *p));
414 static int open_file PARAMS ((char *name, COLUMN *p));
415 static int skip_to_page PARAMS ((int page));
416 static void print_header PARAMS ((void));
417 static void pad_across_to PARAMS ((int position));
418 static void add_line_number PARAMS ((COLUMN *p));
419 static void getoptarg PARAMS ((char *arg, char switch_char, char *character,
420 int *number));
421 void usage PARAMS ((int status));
422 static void print_files PARAMS ((int number_of_files, char **av));
423 static void init_parameters PARAMS ((int number_of_files));
424 static void init_header PARAMS ((char *filename, int desc));
425 static int init_fps PARAMS ((int number_of_files, char **av));
426 static void init_funcs PARAMS ((void));
427 static void init_store_cols PARAMS ((void));
428 static void store_columns PARAMS ((void));
429 static void balance PARAMS ((int total_stored));
430 static void store_char PARAMS ((int c));
431 static void pad_down PARAMS ((int lines));
432 static void read_rest_of_line PARAMS ((COLUMN *p));
433 static void skip_read PARAMS ((COLUMN *p, int column_number));
434 static void print_char PARAMS ((int c));
435 static void cleanup PARAMS ((void));
436 static void first_last_page PARAMS ((char *pages));
437 static void print_sep_string PARAMS ((void));
438 static void separator_string PARAMS ((const char *optarg_S));
440 /* The name under which this program was invoked. */
441 char *program_name;
443 /* All of the columns to print. */
444 static COLUMN *column_vector;
446 /* When printing a single file in multiple downward columns,
447 we store the leftmost columns contiguously in buff.
448 To print a line from buff, get the index of the first character
449 from line_vector[i], and print up to line_vector[i + 1]. */
450 static char *buff;
452 /* Index of the position in buff where the next character
453 will be stored. */
454 static int buff_current;
456 /* The number of characters in buff.
457 Used for allocation of buff and to detect overflow of buff. */
458 static int buff_allocated;
460 /* Array of indices into buff.
461 Each entry is an index of the first character of a line.
462 This is used when storing lines to facilitate shuffling when
463 we do column balancing on the last page. */
464 static int *line_vector;
466 /* Array of horizonal positions.
467 For each line in line_vector, end_vector[line] is the horizontal
468 position we are in after printing that line. We keep track of this
469 so that we know how much we need to pad to prepare for the next
470 column. */
471 static int *end_vector;
473 /* (-m) True means we're printing multiple files in parallel. */
474 static int parallel_files = FALSE;
476 /* (-m) True means a line starts with some empty columns (some files
477 already CLOSED or ON_HOLD) which we have to align. */
478 static int align_empty_cols;
480 /* (-m) True means we have not yet found any printable column in a line.
481 align_empty_cols = TRUE has to be maintained. */
482 static int empty_line;
484 /* (-m) False means printable column output precedes a form feed found.
485 Column alignment is done only once. No additional action with that form
486 feed.
487 True means we found only a form feed in a column. Maybe we have to do
488 some column alignment with that form feed. */
489 static int FF_only;
491 /* (-[0-9]+) True means we're given an option explicitly specifying
492 number of columns. Used to detect when this option is used with -m
493 and when translating old options to new/long options. */
494 static int explicit_columns = FALSE;
496 /* (-t|-T) False means we aren't printing headers and footers. */
497 static int extremities = TRUE;
499 /* (-t) True means we retain all FF set by hand in input files.
500 False is set with -T option. */
501 static int keep_FF = FALSE;
502 static int print_a_FF = FALSE;
504 /* True means we need to print a header as soon as we know we've got input
505 to print after it. */
506 static int print_a_header;
508 /* (-h) True means we're using the standard header rather than a
509 customized one specified by the -h flag. */
510 static int standard_header = TRUE;
512 /* (-f) True means use formfeeds instead of newlines to separate pages. */
513 static int use_form_feed = FALSE;
515 /* True means we have read the standard input. */
516 static int have_read_stdin = FALSE;
518 /* True means the -a flag has been given. */
519 static int print_across_flag = FALSE;
521 /* True means we're printing one file in multiple (>1) downward columns. */
522 static int 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 int 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 static int lines_per_header = 5;
536 static int lines_per_body;
537 static int 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 int truncate_lines = FALSE;
546 /* (-J) True means we join lines without any line truncation. -J
547 dominates -w option. */
548 static int 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 int 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 int 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 /* Count number of failed opens so we can exit with nonzero
594 status if there were any. */
595 static int failed_opens = 0;
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 int first_page_number = 0;
611 static int last_page_number = 0;
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 int 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 int 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 int 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 int use_esc_sequence = FALSE;
672 /* (-c) True means unprintable characters are printed as control prefixes.
673 control-g becomes ^G. */
674 static int use_cntrl_prefix = FALSE;
676 /* (-d) True means output is double spaced. */
677 static int 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 int 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 int 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 = "";
694 static int col_sep_length = 0;
695 static char *column_separator = " ";
696 static char *line_separator = "\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 int pad_vertically;
710 /* (-h) String of characters used in place of the filename in the header. */
711 static char *custom_header;
713 /* String containing the date, filename or custom header, and "Page ". */
714 static char *header;
716 static int *clump_buff;
718 /* True means we read the line no. lines_per_body in skip_read
719 called by skip_to_page. That variable controls the coincidence of a
720 "FF set by hand" and "full_page_printed", see above the definition of
721 structure COLUMN. */
722 static int last_line = FALSE;
724 /* If nonzero, print a non-variable date and time with the header
725 -h HEADER using pr test-suite */
726 static int test_suite;
728 /* For long options that have no equivalent short option, use a
729 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
730 enum
732 PAGES_OPTION = CHAR_MAX + 1,
733 COLUMNS_OPTION
736 static struct option const long_options[] =
738 {"test", no_argument, &test_suite, 1},
739 {"pages", required_argument, NULL, PAGES_OPTION},
740 {"columns", required_argument, NULL, COLUMNS_OPTION},
741 {"across", no_argument, NULL, 'a'},
742 {"show-control-chars", no_argument, NULL, 'c'},
743 {"double-space", no_argument, NULL, 'd'},
744 {"expand-tabs", optional_argument, NULL, 'e'},
745 {"form-feed", no_argument, NULL, 'f'},
746 {"header", required_argument, NULL, 'h'},
747 {"output-tabs", optional_argument, NULL, 'i'},
748 {"join-lines", no_argument, NULL, 'J'},
749 {"length", required_argument, NULL, 'l'},
750 {"merge", no_argument, NULL, 'm'},
751 {"number-lines", optional_argument, NULL, 'n'},
752 {"first-line-number", required_argument, NULL, 'N'},
753 {"indent", required_argument, NULL, 'o'},
754 {"no-file-warnings", no_argument, NULL, 'r'},
755 {"separator", optional_argument, NULL, 's'},
756 {"sep-string", optional_argument, NULL, 'S'},
757 {"omit-header", no_argument, NULL, 't'},
758 {"omit-pagination", no_argument, NULL, 'T'},
759 {"show-nonprinting", no_argument, NULL, 'v'},
760 {"width", required_argument, NULL, 'w'},
761 {"page-width", required_argument, NULL, 'W'},
762 {GETOPT_HELP_OPTION_DECL},
763 {GETOPT_VERSION_OPTION_DECL},
764 {0, 0, 0, 0}
767 /* Return the number of columns that have either an open file or
768 stored lines. */
770 static int
771 cols_ready_to_print (void)
773 COLUMN *q;
774 int i;
775 int n;
777 n = 0;
778 for (q = column_vector, i = 0; i < columns; ++q, ++i)
779 if (q->status == OPEN ||
780 q->status == FF_FOUND || /* With -b: To print a header only */
781 (storing_columns && q->lines_stored > 0 && q->lines_to_print > 0))
782 ++n;
783 return n;
786 /* Estimate first_ / last_page_number
787 using option +FIRST_PAGE:LAST_PAGE */
789 static void
790 first_last_page (char *pages)
792 char *str1;
794 if (*pages == ':')
796 error (0, 0, _("`--pages' invalid range of page numbers: `%s'"), pages);
797 usage (2);
800 str1 = strchr (pages, ':');
801 if (str1 != NULL)
802 *str1 = '\0';
805 long int tmp_long;
806 if (xstrtol (pages, NULL, 10, &tmp_long, "") != LONGINT_OK
807 || tmp_long < 1 || tmp_long > INT_MAX)
808 error (EXIT_FAILURE, 0, _("`--pages' invalid starting page number: `%s'"),
809 pages);
810 first_page_number = (int) tmp_long;
813 if (str1 == NULL)
814 return;
817 long int tmp_long;
818 if (xstrtol (str1 + 1, NULL, 10, &tmp_long, "") != LONGINT_OK
819 || tmp_long <= 0 || tmp_long > INT_MAX)
820 error (EXIT_FAILURE, 0, _("`--pages' invalid ending page number: `%s'"),
821 str1 + 1);
822 last_page_number = (int) tmp_long;
825 if (first_page_number > last_page_number)
826 error (EXIT_FAILURE, 0,
827 _("`--pages' starting page number is larger than ending page number"));
830 /* Estimate length of col_sep_string with option -S[STRING] */
832 static void
833 separator_string (const char *optarg_S)
835 col_sep_length = (int) strlen (optarg_S);
836 col_sep_string = (char *) xmalloc (col_sep_length + 1);
837 strcpy (col_sep_string, optarg_S);
841 main (int argc, char **argv)
843 int c;
844 int accum = 0;
845 int n_files;
846 int old_options = FALSE;
847 int old_w = FALSE;
848 int old_s = FALSE;
849 char **file_names;
851 program_name = argv[0];
852 setlocale (LC_ALL, "");
853 bindtextdomain (PACKAGE, LOCALEDIR);
854 textdomain (PACKAGE);
856 n_files = 0;
857 file_names = (argc > 1
858 ? (char **) xmalloc ((argc - 1) * sizeof (char *))
859 : NULL);
861 while (1)
863 c = getopt_long (argc, argv,
864 "-0123456789abcde::fFh:i::Jl:mn::N:o:rs::S::tTvw:W:",
865 long_options, NULL);
866 if (c == 1) /* Non-option argument. */
868 char *s;
869 s = optarg;
870 if (*s == '+')
872 /* long option --page dominates old `+FIRST_PAGE ...' */
873 if (first_page_number > 0 || last_page_number > 0)
874 continue;
875 ++s;
876 first_last_page (s);
878 else
880 file_names[n_files++] = optarg;
883 else
885 if (ISDIGIT (c))
887 accum = accum * 10 + c - '0';
888 continue;
890 else
892 if (accum > 0)
894 columns = accum;
895 explicit_columns = TRUE;
896 accum = 0;
901 if (c == 1)
902 continue;
904 if (c == EOF)
905 break;
907 switch (c)
909 case 0: /* getopt long option */
910 break;
912 case PAGES_OPTION: /* --pages=FIRST_PAGE[:LAST_PAGE] */
913 { /* dominates old opt +... */
914 if (optarg)
915 first_last_page (optarg);
916 else
917 error (EXIT_FAILURE, 0,
918 _("`--pages=FIRST_PAGE[:LAST_PAGE]' missing argument"));
919 break;
922 case COLUMNS_OPTION: /* --columns=COLUMN */
924 long int tmp_long;
925 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
926 || tmp_long <= 0 || tmp_long > INT_MAX)
928 error (EXIT_FAILURE, 0,
929 _("`--columns=COLUMN' invalid number of columns: `%s'"),
930 optarg);
932 columns = (int) tmp_long;
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 '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 standard_header = FALSE;
963 break;
964 case 'i':
965 if (optarg)
966 getoptarg (optarg, 'i', &output_tab_char,
967 &chars_per_output_tab);
968 /* Could check tab width > 0. */
969 tabify_output = TRUE;
970 break;
971 case 'J':
972 join_lines = TRUE;
973 break;
974 case 'l':
976 long int tmp_long;
977 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
978 || tmp_long <= 0 || tmp_long > INT_MAX)
980 error (EXIT_FAILURE, 0,
981 _("`-l PAGE_LENGTH' invalid number of lines: `%s'"),
982 optarg);
984 lines_per_page = (int) tmp_long;
985 break;
987 case 'm':
988 parallel_files = TRUE;
989 storing_columns = FALSE;
990 break;
991 case 'n':
992 numbered_lines = TRUE;
993 if (optarg)
994 getoptarg (optarg, 'n', &number_separator,
995 &chars_per_number);
996 break;
997 case 'N':
998 skip_count = FALSE;
1000 long int tmp_long;
1001 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1002 || tmp_long > INT_MAX)
1004 error (EXIT_FAILURE, 0,
1005 _("`-N NUMBER' invalid starting line number: `%s'"),
1006 optarg);
1008 start_line_num = (int) tmp_long;
1009 break;
1011 case 'o':
1013 long int tmp_long;
1014 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1015 || tmp_long < 0 || tmp_long > INT_MAX)
1016 error (EXIT_FAILURE, 0,
1017 _("`-o MARGIN' invalid line offset: `%s'"), optarg);
1018 chars_per_margin = (int) tmp_long;
1019 break;
1021 case 'r':
1022 ignore_failed_opens = TRUE;
1023 break;
1024 case 's':
1025 old_options = TRUE;
1026 old_s = TRUE;
1027 if (!use_col_separator && optarg)
1028 separator_string (optarg);
1029 break;
1030 case 'S':
1031 old_s = FALSE;
1032 /* Reset an additional input of -s, -S dominates -s */
1033 col_sep_string = "";
1034 col_sep_length = 0;
1035 use_col_separator = TRUE;
1036 if (optarg)
1037 separator_string (optarg);
1038 break;
1039 case 't':
1040 extremities = FALSE;
1041 keep_FF = TRUE;
1042 break;
1043 case 'T':
1044 extremities = FALSE;
1045 keep_FF = FALSE;
1046 break;
1047 case 'v':
1048 use_esc_sequence = TRUE;
1049 break;
1050 case 'w':
1051 old_options = TRUE;
1052 old_w = TRUE;
1054 long int tmp_long;
1055 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1056 || tmp_long <= 0 || tmp_long > INT_MAX)
1057 error (EXIT_FAILURE, 0,
1058 _("`-w PAGE_WIDTH' invalid number of characters: `%s'"), optarg);
1059 if (!truncate_lines) chars_per_line = (int) tmp_long;
1060 break;
1062 case 'W':
1063 old_w = FALSE; /* dominates -w */
1064 truncate_lines = TRUE;
1066 long int tmp_long;
1067 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1068 || tmp_long <= 0 || tmp_long > INT_MAX)
1069 error (EXIT_FAILURE, 0,
1070 _("`-W PAGE_WIDTH' invalid number of characters: `%s'"), optarg);
1071 chars_per_line = (int) tmp_long;
1072 break;
1074 case_GETOPT_HELP_CHAR;
1075 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1076 default:
1077 usage (2);
1078 break;
1082 /* Now we can set a reasonable initial value: */
1083 if (first_page_number == 0)
1084 first_page_number = 1;
1086 if (parallel_files && explicit_columns)
1087 error (EXIT_FAILURE, 0,
1088 _("Cannot specify number of columns when printing in parallel."));
1090 if (parallel_files && print_across_flag)
1091 error (EXIT_FAILURE, 0,
1092 _("Cannot specify both printing across and printing in parallel."));
1094 /* Translate some old short options to new/long options.
1095 To meet downward compatibility with other UNIX pr utilities
1096 and some POSIX specifications. */
1098 if (old_options)
1100 if (old_w)
1102 if (parallel_files || explicit_columns)
1104 /* activate -W */
1105 truncate_lines = TRUE;
1106 if (old_s)
1107 /* adapt HP-UX and SunOS: -s = no separator;
1108 activate -S */
1109 use_col_separator = TRUE;
1111 else
1112 /* old -w sets width with columns only
1113 activate -J */
1114 join_lines = TRUE;
1116 else if (!use_col_separator)
1118 /* No -S option read */
1119 if (old_s && (parallel_files || explicit_columns))
1121 if (!truncate_lines)
1123 /* old -s (without -w and -W) annuls column alignment,
1124 uses fields, activate -J */
1125 join_lines = TRUE;
1126 if (col_sep_length > 0)
1127 /* activate -S */
1128 use_col_separator = TRUE;
1130 else
1131 /* with -W */
1132 /* adapt HP-UX and SunOS: -s = no separator;
1133 activate -S */
1134 use_col_separator = TRUE;
1139 for (; optind < argc; optind++)
1141 file_names[n_files++] = argv[optind];
1144 if (n_files == 0)
1146 /* No file arguments specified; read from standard input. */
1147 print_files (0, NULL);
1149 else
1151 if (parallel_files)
1152 print_files (n_files, file_names);
1153 else
1155 int i;
1156 for (i = 0; i < n_files; i++)
1157 print_files (1, &file_names[i]);
1161 cleanup ();
1163 if (have_read_stdin && fclose (stdin) == EOF)
1164 error (EXIT_FAILURE, errno, _("standard input"));
1165 if (ferror (stdout) || fclose (stdout) == EOF)
1166 error (EXIT_FAILURE, errno, _("write error"));
1167 if (failed_opens > 0)
1168 exit (EXIT_FAILURE);
1169 exit (EXIT_SUCCESS);
1172 /* Parse options of the form -scNNN.
1174 Example: -nck, where 'n' is the option, c is the optional number
1175 separator, and k is the optional width of the field used when printing
1176 a number. */
1178 static void
1179 getoptarg (char *arg, char switch_char, char *character, int *number)
1181 if (!ISDIGIT (*arg))
1182 *character = *arg++;
1183 if (*arg)
1185 long int tmp_long;
1186 if (xstrtol (arg, NULL, 10, &tmp_long, "") != LONGINT_OK
1187 || tmp_long <= 0 || tmp_long > INT_MAX)
1189 error (0, 0,
1190 _("`-%c' extra characters or invalid number in the argument: `%s'"),
1191 switch_char, arg);
1192 usage (2);
1194 *number = (int) tmp_long;
1198 /* Set parameters related to formatting. */
1200 static void
1201 init_parameters (int number_of_files)
1203 int chars_used_by_number = 0;
1205 if (use_form_feed)
1207 lines_per_header = 3;
1208 lines_per_footer = 0;
1211 lines_per_body = lines_per_page - lines_per_header - lines_per_footer;
1212 if (lines_per_body <= 0)
1214 extremities = FALSE;
1215 keep_FF = TRUE;
1217 if (extremities == FALSE)
1218 lines_per_body = lines_per_page;
1220 if (double_space)
1221 lines_per_body = lines_per_body / 2;
1223 /* If input is stdin, cannot print parallel files. BSD dumps core
1224 on this. */
1225 if (number_of_files == 0)
1226 parallel_files = FALSE;
1228 if (parallel_files)
1229 columns = number_of_files;
1231 /* One file, multi columns down: -b option is set to get a consistent
1232 formulation with "FF set by hand" in input files. */
1233 if (storing_columns)
1234 balance_columns = TRUE;
1236 /* Tabification is assumed for multiple columns. */
1237 if (columns > 1)
1239 if (!use_col_separator)
1241 /* Use default separator */
1242 if (join_lines)
1243 col_sep_string = line_separator;
1244 else
1245 col_sep_string = column_separator;
1247 col_sep_length = 1;
1248 use_col_separator = TRUE;
1250 /* It's rather pointless to define a TAB separator with column
1251 alignment */
1252 else if (!join_lines && *col_sep_string == '\t')
1253 col_sep_string = column_separator;
1255 truncate_lines = TRUE;
1256 untabify_input = TRUE;
1257 tabify_output = TRUE;
1259 else
1260 storing_columns = FALSE;
1262 /* -J dominates -w in any case */
1263 if (join_lines)
1264 truncate_lines = FALSE;
1266 if (numbered_lines)
1268 int tmp_i;
1269 int chars_per_default_tab = 8;
1271 line_count = start_line_num;
1273 /* To allow input tab-expansion (-e sensitive) use:
1274 if (number_separator == input_tab_char)
1275 number_width = chars_per_number +
1276 TAB_WIDTH (chars_per_input_tab, chars_per_number); */
1278 /* Estimate chars_per_text without any margin and keep it constant. */
1279 if (number_separator == '\t')
1280 number_width = chars_per_number +
1281 TAB_WIDTH (chars_per_default_tab, chars_per_number);
1282 else
1283 number_width = chars_per_number + 1;
1285 /* The number is part of the column width unless we are
1286 printing files in parallel. */
1287 if (parallel_files)
1288 chars_used_by_number = number_width;
1290 /* We use power_10 to cut off the higher-order digits of the
1291 line_number in function add_line_number */
1292 tmp_i = chars_per_number;
1293 for (power_10 = 1; tmp_i > 0; --tmp_i)
1294 power_10 = 10 * power_10;
1297 chars_per_column = (chars_per_line - chars_used_by_number -
1298 (columns - 1) * col_sep_length) / columns;
1300 if (chars_per_column < 1)
1301 error (EXIT_FAILURE, 0, _("page width too narrow"));
1303 if (numbered_lines)
1305 if (number_buff != NULL)
1306 free (number_buff);
1307 number_buff = (char *) xmalloc (2 * chars_per_number);
1310 /* Pick the maximum between the tab width and the width of an
1311 escape sequence.
1312 The width of an escape sequence (4) isn't the lower limit any longer.
1313 We've to use 8 as the lower limit, if we use chars_per_default_tab = 8
1314 to expand a tab which is not an input_tab-char. */
1315 if (clump_buff != NULL)
1316 free (clump_buff);
1317 clump_buff = (int *) xmalloc ((chars_per_input_tab > 8
1318 ? chars_per_input_tab : 8) * sizeof (int));
1321 /* Open the necessary files,
1322 maintaining a COLUMN structure for each column.
1324 With multiple files, each column p has a different p->fp.
1325 With single files, each column p has the same p->fp.
1326 Return 1 if (number_of_files > 0) and no files can be opened,
1327 0 otherwise.
1329 With each column/file p, p->full_page_printed is initialized,
1330 see also open_file. */
1332 static int
1333 init_fps (int number_of_files, char **av)
1335 int i, files_left;
1336 COLUMN *p;
1337 FILE *firstfp;
1338 char *firstname;
1340 total_files = 0;
1342 if (column_vector != NULLCOL)
1343 free ((char *) column_vector);
1344 column_vector = (COLUMN *) xmalloc (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) == 0)
1353 --p;
1354 --columns;
1357 if (columns == 0)
1358 return 1;
1359 init_header ("", -1);
1361 else
1363 p = column_vector;
1364 if (number_of_files > 0)
1366 if (open_file (*av, p) == 0)
1367 return 1;
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 0;
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 nonzero if successful, zero if failed.
1487 With each file p, p->full_page_printed is initialized,
1488 see also init_fps. */
1490 static int
1491 open_file (char *name, COLUMN *p)
1493 if (STREQ (name, "-"))
1495 p->name = _("standard input");
1496 p->fp = stdin;
1497 have_read_stdin = 1;
1499 else
1501 p->name = name;
1502 p->fp = fopen (name, "r");
1504 if (p->fp == NULL)
1506 ++failed_opens;
1507 if (!ignore_failed_opens)
1508 error (0, errno, "%s", name);
1509 return 0;
1511 p->status = OPEN;
1512 p->full_page_printed = FALSE;
1513 ++total_files;
1514 return 1;
1517 /* Close the file in P.
1519 If we aren't dealing with multiple files in parallel, we change
1520 the status of all columns in the column list to reflect the close. */
1522 static void
1523 close_file (COLUMN *p)
1525 COLUMN *q;
1526 int i;
1528 if (p->status == CLOSED)
1529 return;
1530 if (ferror (p->fp))
1531 error (EXIT_FAILURE, errno, "%s", p->name);
1532 if (p->fp != stdin && fclose (p->fp) == EOF)
1533 error (EXIT_FAILURE, errno, "%s", p->name);
1535 if (!parallel_files)
1537 for (q = column_vector, i = columns; i; ++q, --i)
1539 q->status = CLOSED;
1540 if (q->lines_stored == 0)
1542 q->lines_to_print = 0;
1546 else
1548 p->status = CLOSED;
1549 p->lines_to_print = 0;
1552 --files_ready_to_read;
1555 /* Put a file on hold until we start a new page,
1556 since we've hit a form feed.
1558 If we aren't dealing with parallel files, we must change the
1559 status of all columns in the column list. */
1561 static void
1562 hold_file (COLUMN *p)
1564 COLUMN *q;
1565 int i;
1567 if (!parallel_files)
1568 for (q = column_vector, i = columns; i; ++q, --i)
1570 if (storing_columns)
1571 q->status = FF_FOUND;
1572 else
1573 q->status = ON_HOLD;
1575 else
1576 p->status = ON_HOLD;
1578 p->lines_to_print = 0;
1579 --files_ready_to_read;
1582 /* Undo hold_file -- go through the column list and change any
1583 ON_HOLD columns to OPEN. Used at the end of each page. */
1585 static void
1586 reset_status (void)
1588 int i = columns;
1589 COLUMN *p;
1591 for (p = column_vector; i; --i, ++p)
1592 if (p->status == ON_HOLD)
1594 p->status = OPEN;
1595 files_ready_to_read++;
1598 if (storing_columns)
1600 if (column_vector->status == CLOSED)
1601 /* We use the info to output an error message in skip_to_page. */
1602 files_ready_to_read = 0;
1603 else
1604 files_ready_to_read = 1;
1608 /* Print a single file, or multiple files in parallel.
1610 Set up the list of columns, opening the necessary files.
1611 Allocate space for storing columns, if necessary.
1612 Skip to first_page_number, if user has asked to skip leading pages.
1613 Determine which functions are appropriate to store/print lines
1614 in each column.
1615 Print the file(s). */
1617 static void
1618 print_files (int number_of_files, char **av)
1620 init_parameters (number_of_files);
1621 if (init_fps (number_of_files, av))
1622 return;
1623 if (storing_columns)
1624 init_store_cols ();
1626 if (first_page_number > 1)
1628 if (!skip_to_page (first_page_number))
1629 return;
1630 else
1631 page_number = first_page_number;
1633 else
1634 page_number = 1;
1636 init_funcs ();
1638 line_number = line_count;
1639 while (print_page ())
1643 /* Estimate the number of characters taken up by a short format date and
1644 time: "yy-mm-dd HH:MM" and: "Page NNNN". */
1645 #define CHARS_FOR_DATE_AND_PAGE 25
1647 /* Initialize header information.
1648 If DESC is non-negative, it is a file descriptor open to
1649 FILENAME for reading.
1651 Allocate space for a header string,
1652 Determine the time, insert file name or user-specified string.
1653 Make use of a centered header with left-hand-side truncation marked by
1654 a '*` in front, if necessary. */
1656 static void
1657 init_header (char *filename, int desc)
1659 int chars_per_middle, chars_free, lhs_blanks, rhs_blanks;
1660 char *f = filename;
1661 char *no_middle = "";
1662 char *header_text;
1663 struct tm *tmptr;
1664 struct stat st;
1665 char *datim = "-- Date/Time -- ";
1667 if (filename == NULL)
1668 f = "";
1670 if (header != NULL)
1671 free (header);
1672 header = (char *) xmalloc (chars_per_line + 1);
1674 if (!standard_header && *custom_header == '\0')
1675 *header = '\0'; /* blank line header */
1676 else
1678 #define T_BUF_FMT "%Y-%m-%d %H:%M" /* date/time short format */
1679 #define T_BUF_SIZE 17 /* FIXME: using a literal here is fragile. */
1680 char t_buf[T_BUF_SIZE];
1682 /* If parallel files or standard input, use current time. */
1683 if (desc < 0 || STREQ (filename, "-") || fstat (desc, &st))
1684 st.st_mtime = time (NULL);
1686 tmptr = localtime (&st.st_mtime);
1687 strftime (t_buf, T_BUF_SIZE, T_BUF_FMT, tmptr);
1689 chars_per_middle = chars_per_line - CHARS_FOR_DATE_AND_PAGE;
1690 if (chars_per_middle < 3)
1692 header_text = no_middle; /* Nothing free for a heading */
1693 lhs_blanks = 1;
1694 rhs_blanks = 1;
1696 else
1698 header_text = standard_header ? f : custom_header;
1699 chars_free = chars_per_middle - (int) strlen (header_text);
1700 if (chars_free > 1)
1702 lhs_blanks = chars_free / 2; /* text not truncated */
1703 rhs_blanks = chars_free - lhs_blanks;
1705 else
1706 { /* lhs truncation */
1707 header_text = header_text - chars_free + 2;
1708 *header_text = '*';
1709 lhs_blanks = 1;
1710 rhs_blanks = 1;
1714 sprintf (header, _("%s%*s%s%*sPage"), (test_suite ? datim : t_buf),
1715 lhs_blanks, " ", header_text, rhs_blanks, " ");
1719 /* Set things up for printing a page
1721 Scan through the columns ...
1722 Determine which are ready to print
1723 (i.e., which have lines stored or open files)
1724 Set p->lines_to_print appropriately
1725 (to p->lines_stored if we're storing, or lines_per_body
1726 if we're reading straight from the file)
1727 Keep track of this total so we know when to stop printing */
1729 static void
1730 init_page (void)
1732 int j;
1733 COLUMN *p;
1735 if (storing_columns)
1737 store_columns ();
1738 for (j = columns - 1, p = column_vector; j; --j, ++p)
1740 p->lines_to_print = p->lines_stored;
1743 /* Last column. */
1744 if (balance_columns)
1746 p->lines_to_print = p->lines_stored;
1748 /* Since we're not balancing columns, we don't need to store
1749 the rightmost column. Read it straight from the file. */
1750 else
1752 if (p->status == OPEN)
1754 p->lines_to_print = lines_per_body;
1756 else
1757 p->lines_to_print = 0;
1760 else
1761 for (j = columns, p = column_vector; j; --j, ++p)
1762 if (p->status == OPEN)
1764 p->lines_to_print = lines_per_body;
1766 else
1767 p->lines_to_print = 0;
1770 /* Align empty columns and print separators.
1771 Empty columns will be formed by files with status ON_HOLD or CLOSED
1772 when printing multiple files in parallel. */
1774 static void
1775 align_column (COLUMN *p)
1777 padding_not_printed = p->start_position;
1778 if (padding_not_printed - col_sep_length > 0)
1780 pad_across_to (padding_not_printed - col_sep_length);
1781 padding_not_printed = ANYWHERE;
1784 if (use_col_separator)
1785 print_sep_string ();
1787 if (p->numbered)
1788 add_line_number (p);
1791 /* Print one page.
1793 As long as there are lines left on the page and columns ready to print,
1794 Scan across the column list
1795 if the column has stored lines or the file is open
1796 pad to the appropriate spot
1797 print the column
1798 pad the remainder of the page with \n or \f as requested
1799 reset the status of all files -- any files which where on hold because
1800 of formfeeds are now put back into the lineup. */
1802 static int
1803 print_page (void)
1805 int j;
1806 int lines_left_on_page;
1807 COLUMN *p;
1809 /* Used as an accumulator (with | operator) of successive values of
1810 pad_vertically. The trick is to set pad_vertically
1811 to zero before each run through the inner loop, then after that
1812 loop, it tells us whether a line was actually printed (whether a
1813 newline needs to be output -- or two for double spacing). But those
1814 values have to be accumulated (in pv) so we can invoke pad_down
1815 properly after the outer loop completes. */
1816 int pv;
1818 init_page ();
1820 if (cols_ready_to_print () == 0)
1821 return FALSE;
1823 if (extremities)
1824 print_a_header = TRUE;
1826 /* Don't pad unless we know a page was printed. */
1827 pad_vertically = FALSE;
1828 pv = FALSE;
1830 lines_left_on_page = lines_per_body;
1831 if (double_space)
1832 lines_left_on_page *= 2;
1834 while (lines_left_on_page > 0 && cols_ready_to_print () > 0)
1836 output_position = 0;
1837 spaces_not_printed = 0;
1838 separators_not_printed = 0;
1839 pad_vertically = FALSE;
1840 align_empty_cols = FALSE;
1841 empty_line = TRUE;
1843 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1845 input_position = 0;
1846 if (p->lines_to_print > 0 || p->status == FF_FOUND)
1848 FF_only = FALSE;
1849 padding_not_printed = p->start_position;
1850 if (!(p->print_func) (p))
1851 read_rest_of_line (p);
1852 pv |= pad_vertically;
1854 --p->lines_to_print;
1855 if (p->lines_to_print <= 0)
1857 if (cols_ready_to_print () <= 0)
1858 break;
1861 /* File p changed its status to ON_HOLD or CLOSED */
1862 if (parallel_files && p->status != OPEN)
1864 if (empty_line)
1865 align_empty_cols = TRUE;
1866 else if (p->status == CLOSED ||
1867 (p->status == ON_HOLD && FF_only))
1868 align_column (p);
1871 else if (parallel_files)
1873 /* File status ON_HOLD or CLOSED */
1874 if (empty_line)
1875 align_empty_cols = TRUE;
1876 else
1877 align_column (p);
1880 /* We need it also with an empty column */
1881 if (use_col_separator)
1882 ++separators_not_printed;
1885 if (pad_vertically)
1887 putchar ('\n');
1888 --lines_left_on_page;
1891 if (cols_ready_to_print () <= 0 && !extremities)
1892 break;
1894 if (double_space && pv)
1896 putchar ('\n');
1897 --lines_left_on_page;
1901 if (lines_left_on_page == 0)
1902 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1903 if (p->status == OPEN)
1904 p->full_page_printed = TRUE;
1906 pad_vertically = pv;
1908 if (pad_vertically && extremities)
1909 pad_down (lines_left_on_page + lines_per_footer);
1910 else if (keep_FF && print_a_FF)
1912 putchar ('\f');
1913 print_a_FF = FALSE;
1916 if (last_page_number && page_number > last_page_number)
1917 return FALSE; /* Stop printing with LAST_PAGE */
1919 reset_status (); /* Change ON_HOLD to OPEN. */
1921 return TRUE; /* More pages to go. */
1924 /* Allocate space for storing columns.
1926 This is necessary when printing multiple columns from a single file.
1927 Lines are stored consecutively in buff, separated by '\0'.
1929 The following doesn't apply any longer - any tuning possible?
1930 (We can't use a fixed offset since with the '-s' flag lines aren't
1931 truncated.)
1933 We maintain a list (line_vector) of pointers to the beginnings
1934 of lines in buff. We allocate one more than the number of lines
1935 because the last entry tells us the index of the last character,
1936 which we need to know in order to print the last line in buff. */
1938 static void
1939 init_store_cols (void)
1941 int total_lines = lines_per_body * columns;
1942 int chars_if_truncate = total_lines * (chars_per_column + 1);
1944 if (line_vector != NULL)
1945 free ((int *) line_vector);
1946 /* FIXME: here's where it was allocated. */
1947 line_vector = (int *) xmalloc ((total_lines + 1) * sizeof (int *));
1949 if (end_vector != NULL)
1950 free ((int *) end_vector);
1951 end_vector = (int *) xmalloc (total_lines * sizeof (int *));
1953 if (buff != NULL)
1954 free (buff);
1955 buff_allocated = (use_col_separator
1956 ? 2 * chars_if_truncate
1957 : chars_if_truncate); /* Tune this. */
1958 buff = (char *) xmalloc (buff_allocated);
1961 /* Store all but the rightmost column.
1962 (Used when printing a single file in multiple downward columns)
1964 For each column
1965 set p->current_line to be the index in line_vector of the
1966 first line in the column
1967 For each line in the column
1968 store the line in buff
1969 add to line_vector the index of the line's first char
1970 buff_start is the index in buff of the first character in the
1971 current line. */
1973 static void
1974 store_columns (void)
1976 int i, j;
1977 int line = 0;
1978 int buff_start;
1979 int last_col; /* The rightmost column which will be saved in buff */
1980 COLUMN *p;
1982 buff_current = 0;
1983 buff_start = 0;
1985 if (balance_columns)
1986 last_col = columns;
1987 else
1988 last_col = columns - 1;
1990 for (i = 1, p = column_vector; i <= last_col; ++i, ++p)
1991 p->lines_stored = 0;
1993 for (i = 1, p = column_vector; i <= last_col && files_ready_to_read;
1994 ++i, ++p)
1996 p->current_line = line;
1997 for (j = lines_per_body; j && files_ready_to_read; --j)
1999 if (p->status == OPEN) /* Redundant. Clean up. */
2001 input_position = 0;
2003 if (!read_line (p))
2004 read_rest_of_line (p);
2006 if (p->status == OPEN
2007 || buff_start != buff_current)
2009 ++p->lines_stored;
2010 line_vector[line] = buff_start;
2011 end_vector[line++] = input_position;
2012 buff_start = buff_current;
2017 /* Keep track of the location of the last char in buff. */
2018 line_vector[line] = buff_start;
2020 if (balance_columns && p->lines_stored != lines_per_body)
2021 balance (line);
2024 static void
2025 balance (int total_stored)
2027 COLUMN *p;
2028 int i, lines;
2029 int first_line = 0;
2031 for (i = 1, p = column_vector; i <= columns; ++i, ++p)
2033 lines = total_stored / columns;
2034 if (i <= total_stored % columns)
2035 ++lines;
2037 p->lines_stored = lines;
2038 p->current_line = first_line;
2040 first_line += lines;
2044 /* Store a character in the buffer. */
2046 static void
2047 store_char (int c)
2049 if (buff_current >= buff_allocated)
2051 /* May be too generous. */
2052 buff_allocated = 2 * buff_allocated;
2053 buff = (char *) xrealloc (buff, buff_allocated * sizeof (char));
2055 buff[buff_current++] = (char) c;
2058 static void
2059 add_line_number (COLUMN *p)
2061 int i;
2062 char *s;
2063 int left_cut;
2065 /* Cutting off the higher-order digits is more informative than
2066 lower-order cut off*/
2067 if (line_number < power_10)
2068 sprintf (number_buff, "%*d", chars_per_number, line_number);
2069 else
2071 left_cut = line_number % power_10;
2072 sprintf (number_buff, "%0*d", chars_per_number, left_cut);
2074 line_number++;
2075 s = number_buff;
2076 for (i = chars_per_number; i > 0; i--)
2077 (p->char_func) ((int) *s++);
2079 if (columns > 1)
2081 /* Tabification is assumed for multiple columns, also for n-separators,
2082 but `default n-separator = TAB' hasn't been given priority over
2083 equal column_width also specified by POSIX. */
2084 if (number_separator == '\t')
2086 i = number_width - chars_per_number;
2087 while (i-- > 0)
2088 (p->char_func) ((int) ' ');
2090 else
2091 (p->char_func) ((int) number_separator);
2093 else
2094 /* To comply with POSIX, we avoid any expansion of default TAB
2095 separator with a single column output. No column_width requirement
2096 has to be considered. */
2098 (p->char_func) ((int) number_separator);
2099 if (number_separator == '\t')
2100 output_position = POS_AFTER_TAB (chars_per_output_tab,
2101 output_position);
2104 if (truncate_lines && !parallel_files)
2105 input_position += number_width;
2108 /* Print (or store) padding until the current horizontal position
2109 is position. */
2111 static void
2112 pad_across_to (int position)
2114 register int h = output_position;
2116 if (tabify_output)
2117 spaces_not_printed = position - output_position;
2118 else
2120 while (++h <= position)
2121 putchar (' ');
2122 output_position = position;
2126 /* Pad to the bottom of the page.
2128 If the user has requested a formfeed, use one.
2129 Otherwise, use newlines. */
2131 static void
2132 pad_down (int lines)
2134 register int i;
2136 if (use_form_feed)
2137 putchar ('\f');
2138 else
2139 for (i = lines; i; --i)
2140 putchar ('\n');
2143 /* Read the rest of the line.
2145 Read from the current column's file until an end of line is
2146 hit. Used when we've truncated a line and we no longer need
2147 to print or store its characters. */
2149 static void
2150 read_rest_of_line (COLUMN *p)
2152 register int c;
2153 FILE *f = p->fp;
2155 while ((c = getc (f)) != '\n')
2157 if (c == '\f')
2159 if ((c = getc (f)) != '\n')
2160 ungetc (c, f);
2161 if (keep_FF)
2162 print_a_FF = TRUE;
2163 hold_file (p);
2164 break;
2166 else if (c == EOF)
2168 close_file (p);
2169 break;
2174 /* Read a line with skip_to_page.
2176 Read from the current column's file until an end of line is
2177 hit. Used when we read full lines to skip pages.
2178 With skip_to_page we have to check for FF-coincidence which is done
2179 in function read_line otherwise.
2180 Count lines of skipped pages to find the line number of 1st page
2181 printed relative to 1st line of input file (start_line_num). */
2183 static void
2184 skip_read (COLUMN *p, int column_number)
2186 register int c;
2187 FILE *f = p->fp;
2188 int i, single_ff = FALSE;
2189 COLUMN *q;
2191 /* Read 1st character in a line or any character succeeding a FF */
2192 if ((c = getc (f)) == '\f' && p->full_page_printed)
2193 /* A FF-coincidence with a previous full_page_printed.
2194 To avoid an additional empty page, eliminate the FF */
2195 if ((c = getc (f)) == '\n')
2196 c = getc (f);
2198 p->full_page_printed = FALSE;
2200 /* 1st character a FF means a single FF without any printable
2201 characters. Don't count it as a line with -n option. */
2202 if (c == '\f')
2203 single_ff = TRUE;
2205 /* Preparing for a FF-coincidence: Maybe we finish that page
2206 without a FF found */
2207 if (last_line)
2208 p->full_page_printed = TRUE;
2210 while (c != '\n')
2212 if (c == '\f')
2214 /* No FF-coincidence possible,
2215 no catching up of a FF-coincidence with next page */
2216 if (last_line)
2218 if (!parallel_files)
2219 for (q = column_vector, i = columns; i; ++q, --i)
2220 q->full_page_printed = FALSE;
2221 else
2222 p->full_page_printed = FALSE;
2225 if ((c = getc (f)) != '\n')
2226 ungetc (c, f);
2227 hold_file (p);
2228 break;
2230 else if (c == EOF)
2232 close_file (p);
2233 break;
2235 c = getc (f);
2238 if (skip_count)
2239 if ((!parallel_files || column_number == 1) && !single_ff)
2240 ++line_count;
2243 /* If we're tabifying output,
2245 When print_char encounters white space it keeps track
2246 of our desired horizontal position and delays printing
2247 until this function is called. */
2249 static void
2250 print_white_space (void)
2252 register int h_new;
2253 register int h_old = output_position;
2254 register int goal = h_old + spaces_not_printed;
2256 while (goal - h_old > 1
2257 && (h_new = POS_AFTER_TAB (chars_per_output_tab, h_old)) <= goal)
2259 putchar (output_tab_char);
2260 h_old = h_new;
2262 while (++h_old <= goal)
2263 putchar (' ');
2265 output_position = goal;
2266 spaces_not_printed = 0;
2269 /* Print column separators.
2271 We keep a count until we know that we'll be printing a line,
2272 then print_sep_string() is called. */
2274 static void
2275 print_sep_string ()
2277 char *s;
2278 int l = col_sep_length;
2280 s = col_sep_string;
2282 if (separators_not_printed <= 0)
2284 /* We'll be starting a line with chars_per_margin, anything else? */
2285 if (spaces_not_printed > 0)
2286 print_white_space ();
2288 else
2290 for (; separators_not_printed > 0; --separators_not_printed)
2292 while (l-- > 0)
2294 /* 3 types of sep_strings: spaces only, spaces and chars,
2295 chars only */
2296 if (*s == ' ')
2298 /* We're tabifying output; consecutive spaces in
2299 sep_string may have to be converted to tabs */
2300 s++;
2301 ++spaces_not_printed;
2303 else
2305 if (spaces_not_printed > 0)
2306 print_white_space ();
2307 putchar (*s++);
2308 ++output_position;
2311 /* sep_string ends with some spaces */
2312 if (spaces_not_printed > 0)
2313 print_white_space ();
2318 /* Print (or store, depending on p->char_func) a clump of N
2319 characters. */
2321 static void
2322 print_clump (COLUMN *p, int n, int *clump)
2324 while (n--)
2325 (p->char_func) (*clump++);
2328 /* Print a character.
2330 Update the following comment: process-char hasn't been used any
2331 longer.
2332 If we're tabifying, all tabs have been converted to spaces by
2333 process_char(). Keep a count of consecutive spaces, and when
2334 a nonspace is encountered, call print_white_space() to print the
2335 required number of tabs and spaces. */
2337 static void
2338 print_char (int c)
2340 if (tabify_output)
2342 if (c == ' ')
2344 ++spaces_not_printed;
2345 return;
2347 else if (spaces_not_printed > 0)
2348 print_white_space ();
2350 /* Nonprintables are assumed to have width 0, except '\b'. */
2351 if (!ISPRINT (c))
2353 if (c == '\b')
2354 --output_position;
2356 else
2357 ++output_position;
2359 putchar (c);
2362 /* Skip to page PAGE before printing.
2363 PAGE may be larger than total number of pages. */
2365 static int
2366 skip_to_page (int page)
2368 int n, i, j;
2369 COLUMN *p;
2371 for (n = 1; n < page; ++n)
2373 for (i = 1; i < lines_per_body; ++i)
2375 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2376 if (p->status == OPEN)
2377 skip_read (p, j);
2379 last_line = TRUE;
2380 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2381 if (p->status == OPEN)
2382 skip_read (p, j);
2384 if (storing_columns) /* change FF_FOUND to ON_HOLD */
2385 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2386 if (p->status != CLOSED)
2387 p->status = ON_HOLD;
2389 reset_status ();
2390 last_line = FALSE;
2392 if (files_ready_to_read < 1)
2394 /* It's very helpful, normally the total number of pages is
2395 not known in advance. */
2396 error (0, 0,
2397 _("starting page number larger than total number of pages: `%d'"),
2399 break;
2402 return files_ready_to_read > 0;
2405 /* Print a header.
2407 Formfeeds are assumed to use up two lines at the beginning of
2408 the page. */
2410 static void
2411 print_header (void)
2413 if (!use_form_feed)
2414 fprintf (stdout, "\n\n");
2416 output_position = 0;
2417 pad_across_to (chars_per_margin);
2418 print_white_space ();
2420 if (!standard_header && *custom_header == '\0')
2422 fprintf (stdout, "%s\n\n\n", header);
2423 page_number++;
2425 else
2426 fprintf (stdout, "%s%5d\n\n\n", header, page_number++);
2428 print_a_header = FALSE;
2429 output_position = 0;
2432 /* Print (or store, if p->char_func is store_char()) a line.
2434 Read a character to determine whether we have a line or not.
2435 (We may hit EOF, \n, or \f)
2437 Once we know we have a line,
2438 set pad_vertically = TRUE, meaning it's safe
2439 to pad down at the end of the page, since we do have a page.
2440 print a header if needed.
2441 pad across to padding_not_printed if needed.
2442 print any separators which need to be printed.
2443 print a line number if it needs to be printed.
2445 Print the clump which corresponds to the first character.
2447 Enter a loop and keep printing until an end of line condition
2448 exists, or until we exceed chars_per_column.
2450 Return FALSE if we exceed chars_per_column before reading
2451 an end of line character, TRUE otherwise. */
2453 static int
2454 read_line (COLUMN *p)
2456 int c;
2457 int chars IF_LINT (= 0);
2458 int last_input_position;
2459 int j, k;
2460 COLUMN *q;
2462 /* read 1st character in each line or any character succeeding a FF: */
2463 c = getc (p->fp);
2465 last_input_position = input_position;
2467 if (c == '\f' && p->full_page_printed)
2468 if ((c = getc (p->fp)) == '\n')
2469 c = getc (p->fp);
2470 p->full_page_printed = FALSE;
2472 switch (c)
2474 case '\f':
2475 if ((c = getc (p->fp)) != '\n')
2476 ungetc (c, p->fp);
2477 FF_only = TRUE;
2478 if (print_a_header && !storing_columns)
2480 pad_vertically = TRUE;
2481 print_header ();
2483 else if (keep_FF)
2484 print_a_FF = TRUE;
2485 hold_file (p);
2486 return TRUE;
2487 case EOF:
2488 close_file (p);
2489 return TRUE;
2490 case '\n':
2491 break;
2492 default:
2493 chars = char_to_clump (c);
2496 if (truncate_lines && input_position > chars_per_column)
2498 input_position = last_input_position;
2499 return FALSE;
2502 if (p->char_func != store_char)
2504 pad_vertically = TRUE;
2506 if (print_a_header && !storing_columns)
2507 print_header ();
2509 if (parallel_files && align_empty_cols)
2511 /* We have to align empty columns at the beginning of a line. */
2512 k = separators_not_printed;
2513 separators_not_printed = 0;
2514 for (j = 1, q = column_vector; j <= k; ++j, ++q)
2516 align_column (q);
2517 separators_not_printed += 1;
2519 padding_not_printed = p->start_position;
2520 if (truncate_lines)
2521 spaces_not_printed = chars_per_column;
2522 else
2523 spaces_not_printed = 0;
2524 align_empty_cols = FALSE;
2527 if (padding_not_printed - col_sep_length > 0)
2529 pad_across_to (padding_not_printed - col_sep_length);
2530 padding_not_printed = ANYWHERE;
2533 if (use_col_separator)
2534 print_sep_string ();
2537 if (p->numbered)
2538 add_line_number (p);
2540 empty_line = FALSE;
2541 if (c == '\n')
2542 return TRUE;
2544 print_clump (p, chars, clump_buff);
2546 for (;;)
2548 c = getc (p->fp);
2550 switch (c)
2552 case '\n':
2553 return TRUE;
2554 case '\f':
2555 if ((c = getc (p->fp)) != '\n')
2556 ungetc (c, p->fp);
2557 if (keep_FF)
2558 print_a_FF = TRUE;
2559 hold_file (p);
2560 return TRUE;
2561 case EOF:
2562 close_file (p);
2563 return TRUE;
2566 last_input_position = input_position;
2567 chars = char_to_clump (c);
2568 if (truncate_lines && input_position > chars_per_column)
2570 input_position = last_input_position;
2571 return FALSE;
2574 print_clump (p, chars, clump_buff);
2578 /* Print a line from buff.
2580 If this function has been called, we know we have "something to
2581 print". But it remains to be seen whether we have a real text page
2582 or an empty page (a single form feed) with/without a header only.
2583 Therefore first we set pad_vertically to TRUE and print a header
2584 if necessary.
2585 If FF_FOUND and we are using -t|-T option we omit any newline by
2586 setting pad_vertically to FALSE (see print_page).
2587 Otherwise we pad across if necessary, print separators if necessary
2588 and text of COLUMN *p.
2590 Return TRUE, meaning there is no need to call read_rest_of_line. */
2592 static int
2593 print_stored (COLUMN *p)
2595 COLUMN *q;
2596 int i;
2598 int line = p->current_line++;
2599 register char *first = &buff[line_vector[line]];
2600 /* FIXME
2601 UMR: Uninitialized memory read:
2602 * This is occurring while in:
2603 print_stored [pr.c:2239]
2604 * Reading 4 bytes from 0x5148c in the heap.
2605 * Address 0x5148c is 4 bytes into a malloc'd block at 0x51488 of 676 bytes
2606 * This block was allocated from:
2607 malloc [rtlib.o]
2608 xmalloc [xmalloc.c:94]
2609 init_store_cols [pr.c:1648]
2611 register char *last = &buff[line_vector[line + 1]];
2613 pad_vertically = TRUE;
2615 if (print_a_header)
2616 print_header ();
2618 if (p->status == FF_FOUND)
2620 for (i = 1, q = column_vector; i <= columns; ++i, ++q)
2621 q->status = ON_HOLD;
2622 if (column_vector->lines_to_print <= 0)
2624 if (!extremities)
2625 pad_vertically = FALSE;
2626 return TRUE; /* print a header only */
2630 if (padding_not_printed - col_sep_length > 0)
2632 pad_across_to (padding_not_printed - col_sep_length);
2633 padding_not_printed = ANYWHERE;
2636 if (use_col_separator)
2637 print_sep_string ();
2639 while (first != last)
2640 print_char (*first++);
2642 if (spaces_not_printed == 0)
2644 output_position = p->start_position + end_vector[line];
2645 if (p->start_position - col_sep_length == chars_per_margin)
2646 output_position -= col_sep_length;
2649 return TRUE;
2652 /* Convert a character to the proper format and return the number of
2653 characters in the resulting clump. Increment input_position by
2654 the width of the clump.
2656 Tabs are converted to clumps of spaces.
2657 Nonprintable characters may be converted to clumps of escape
2658 sequences or control prefixes.
2660 Note: the width of a clump is not necessarily equal to the number of
2661 characters in clump_buff. (e.g, the width of '\b' is -1, while the
2662 number of characters is 1.) */
2664 static int
2665 char_to_clump (int c)
2667 register int *s = clump_buff;
2668 register int i;
2669 char esc_buff[4];
2670 int width;
2671 int chars;
2672 int chars_per_c = 8;
2674 if (c == input_tab_char)
2675 chars_per_c = chars_per_input_tab;
2677 if (c == input_tab_char || c == '\t')
2679 width = TAB_WIDTH (chars_per_c, input_position);
2681 if (untabify_input)
2683 for (i = width; i; --i)
2684 *s++ = ' ';
2685 chars = width;
2687 else
2689 *s = c;
2690 chars = 1;
2694 else if (!ISPRINT (c))
2696 if (use_esc_sequence)
2698 width = 4;
2699 chars = 4;
2700 *s++ = '\\';
2701 sprintf (esc_buff, "%03o", c);
2702 for (i = 0; i <= 2; ++i)
2703 *s++ = (int) esc_buff[i];
2705 else if (use_cntrl_prefix)
2707 if (c < 0200)
2709 width = 2;
2710 chars = 2;
2711 *s++ = '^';
2712 *s++ = c ^ 0100;
2714 else
2716 width = 4;
2717 chars = 4;
2718 *s++ = '\\';
2719 sprintf (esc_buff, "%03o", c);
2720 for (i = 0; i <= 2; ++i)
2721 *s++ = (int) esc_buff[i];
2724 else if (c == '\b')
2726 width = -1;
2727 chars = 1;
2728 *s = c;
2730 else
2732 width = 0;
2733 chars = 1;
2734 *s = c;
2737 else
2739 width = 1;
2740 chars = 1;
2741 *s = c;
2744 input_position += width;
2745 return chars;
2748 /* We've just printed some files and need to clean up things before
2749 looking for more options and printing the next batch of files.
2751 Free everything we've xmalloc'ed, except `header'. */
2753 static void
2754 cleanup (void)
2756 if (number_buff)
2757 free (number_buff);
2758 if (clump_buff)
2759 free (clump_buff);
2760 if (column_vector)
2761 free (column_vector);
2762 if (line_vector)
2763 free (line_vector);
2764 if (end_vector)
2765 free (end_vector);
2766 if (buff)
2767 free (buff);
2770 /* Complain, print a usage message, and die. */
2772 void
2773 usage (int status)
2775 if (status != 0)
2776 fprintf (stderr, _("Try `%s --help' for more information.\n"),
2777 program_name);
2778 else
2780 printf (_("\
2781 Usage: %s [OPTION]... [FILE]...\n\
2783 program_name);
2785 printf (_("\
2786 Paginate or columnate FILE(s) for printing.\n\
2788 +FIRST_PAGE[:LAST_PAGE], --pages=FIRST_PAGE[:LAST_PAGE]\n\
2789 begin [stop] printing with page FIRST_[LAST_]PAGE\n\
2790 -COLUMN, --columns=COLUMN\n\
2791 produce COLUMN-column output and print columns down,\n\
2792 unless -a is used. Balance number of lines in the\n\
2793 columns on each page.\n\
2794 -a, --across print columns across rather than down, used together\n\
2795 with -COLUMN\n\
2796 -c, --show-control-chars\n\
2797 use hat notation (^G) and octal backslash notation\n\
2798 -d, --double-space\n\
2799 double space the output\n\
2800 -e[CHAR[WIDTH]], --expand-tabs[=CHAR[WIDTH]]\n\
2801 expand input CHARs (TABs) to tab WIDTH (8)\n\
2802 -F, -f, --form-feed\n\
2803 use form feeds instead of newlines to separate pages\n\
2804 (by a 3-line page header with -F or a 5-line header\n\
2805 and trailer without -F)\n\
2806 "));
2807 printf (_("\
2808 -h HEADER, --header=HEADER\n\
2809 use a centered HEADER instead of filename in page header,\n\
2810 with long headers left-hand-side truncation may occur,\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, -S[STRING] sets separators\n\
2816 -l PAGE_LENGTH, --length=PAGE_LENGTH\n\
2817 set the page length to PAGE_LENGTH (66) lines\n\
2818 (default number of lines of text 56, and with -F 63)\n\
2819 -m, --merge print all files in parallel, one in each column,\n\
2820 truncate lines, but join lines of full length with -J\n\
2821 -n[SEP[DIGITS]], --number-lines[=SEP[DIGITS]]\n\
2822 number lines, use DIGITS (5) digits, then SEP (TAB),\n\
2823 default counting starts with 1st line of input file\n\
2824 -N NUMBER, --first-line-number=NUMBER\n\
2825 start counting with NUMBER at 1st line of first\n\
2826 page printed (see +FIRST_PAGE)\n\
2827 -o MARGIN, --indent=MARGIN\n\
2828 offset each line with MARGIN (zero) spaces, do not\n\
2829 affect -w or -W, MARGIN will be added to PAGE_WIDTH\n\
2830 -r, --no-file-warnings\n\
2831 omit warning when a file cannot be opened\n\
2832 "));
2833 printf (_("\
2834 -s[CHAR],--separator[=CHAR]\n\
2835 separate columns by a single character, default for CHAR\n\
2836 is the <TAB> character without -w and \'no char\' with -w\n\
2837 -s[CHAR] turns off line truncation of all 3 column\n\
2838 options (-COLUMN|-a -COLUMN|-m) except -w is set\n\
2839 -S[STRING], --sep-string[=STRING]\n\
2840 separate columns by an optional STRING, don't use\n\
2841 -S \"STRING\", -S only: No separator used (same as -S\"\"),\n\
2842 without -S: Default separator <TAB> with -J and <space>\n\
2843 otherwise (same as -S\" \"), no effect on column options\n\
2844 -t, --omit-header omit page headers and trailers\n\
2845 -T, --omit-pagination\n\
2846 omit page headers and trailers, eliminate any pagination\n\
2847 by form feeds set in input files\n\
2848 -v, --show-nonprinting\n\
2849 use octal backslash notation\n\
2850 -w PAGE_WIDTH, --width=PAGE_WIDTH\n\
2851 set page width to PAGE_WIDTH (72) characters for\n\
2852 multiple text-column output only, -s[char] turns off (72)\n\
2853 -W PAGE_WIDTH, --page-width=PAGE_WIDTH\n\
2854 set page width to PAGE_WIDTH (72) characters always,\n\
2855 truncate lines, except -J option is set, no interference\n\
2856 with -S or -s\n\
2857 --help display this help and exit\n\
2858 --version output version information and exit\n\
2860 -T implied by -l nn when nn <= 10 or <= 3 with -F. With no FILE, or when\n\
2861 FILE is -, read standard input.\n\
2862 "));
2863 puts (_("\nReport bugs to <bug-textutils@gnu.org>."));
2865 exit (status == 0 ? EXIT_SUCCESS : EXIT_FAILURE);