*** empty log message ***
[coreutils.git] / src / pr.c
blob8681957e9dcfedd209581606e05258fcd3bbc1ee
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 "closeout.h"
322 #include "error.h"
323 #include "xstrtol.h"
325 /* The official name of this program (e.g., no `g' prefix). */
326 #define PROGRAM_NAME "pr"
328 #define AUTHORS "Pete TerMaat and Roland Huebner"
330 #ifndef TRUE
331 # define TRUE 1
332 # define FALSE 0
333 #endif
335 /* Used with start_position in the struct COLUMN described below.
336 If start_position == ANYWHERE, we aren't truncating columns and
337 can begin printing a column anywhere. Otherwise we must pad to
338 the horizontal position start_position. */
339 #define ANYWHERE 0
341 /* Each column has one of these structures allocated for it.
342 If we're only dealing with one file, fp is the same for all
343 columns.
345 The general strategy is to spend time setting up these column
346 structures (storing columns if necessary), after which printing
347 is a matter of flitting from column to column and calling
348 print_func.
350 Parallel files, single files printing across in multiple
351 columns, and single files printing down in multiple columns all
352 fit the same printing loop.
354 print_func Function used to print lines in this column.
355 If we're storing this column it will be
356 print_stored(), Otherwise it will be read_line().
358 char_func Function used to process characters in this column.
359 If we're storing this column it will be store_char(),
360 otherwise it will be print_char().
362 current_line Index of the current entry in line_vector, which
363 contains the index of the first character of the
364 current line in buff[].
366 lines_stored Number of lines in this column which are stored in
367 buff.
369 lines_to_print If we're storing this column, lines_to_print is
370 the number of stored_lines which remain to be
371 printed. Otherwise it is the number of lines
372 we can print without exceeding lines_per_body.
374 start_position The horizontal position we want to be in before we
375 print the first character in this column.
377 numbered True means precede this column with a line number. */
379 struct COLUMN
381 FILE *fp; /* Input stream for this column. */
382 char *name; /* File name. */
383 enum
385 OPEN,
386 FF_FOUND, /* used with -b option, set with \f, changed
387 to ON_HOLD after print_header */
388 ON_HOLD, /* Hit a form feed. */
389 CLOSED
391 status; /* Status of the file pointer. */
392 int (*print_func) (); /* Func to print lines in this col. */
393 void (*char_func) (); /* Func to print/store chars in this col. */
394 int current_line; /* Index of current place in line_vector. */
395 int lines_stored; /* Number of lines stored in buff. */
396 int lines_to_print; /* No. lines stored or space left on page. */
397 int start_position; /* Horizontal position of first char. */
398 int numbered;
399 int full_page_printed; /* True means printed without a FF found. */
401 /* p->full_page_printed controls a special case of "FF set by hand":
402 True means a full page has been printed without FF found. To avoid an
403 additional empty page we have to ignore a FF immediately following in
404 the next line. */
407 typedef struct COLUMN COLUMN;
409 #define NULLCOL (COLUMN *)0
411 static int char_to_clump PARAMS ((int c));
412 static int read_line PARAMS ((COLUMN *p));
413 static int print_page PARAMS ((void));
414 static int print_stored PARAMS ((COLUMN *p));
415 static int open_file PARAMS ((char *name, COLUMN *p));
416 static int skip_to_page PARAMS ((int page));
417 static void print_header PARAMS ((void));
418 static void pad_across_to PARAMS ((int position));
419 static void add_line_number PARAMS ((COLUMN *p));
420 static void getoptarg PARAMS ((char *arg, char switch_char, char *character,
421 int *number));
422 void usage PARAMS ((int status));
423 static void print_files PARAMS ((int number_of_files, char **av));
424 static void init_parameters PARAMS ((int number_of_files));
425 static void init_header PARAMS ((char *filename, int desc));
426 static int init_fps PARAMS ((int number_of_files, char **av));
427 static void init_funcs PARAMS ((void));
428 static void init_store_cols PARAMS ((void));
429 static void store_columns PARAMS ((void));
430 static void balance PARAMS ((int total_stored));
431 static void store_char PARAMS ((int c));
432 static void pad_down PARAMS ((int lines));
433 static void read_rest_of_line PARAMS ((COLUMN *p));
434 static void skip_read PARAMS ((COLUMN *p, int column_number));
435 static void print_char PARAMS ((int c));
436 static void cleanup PARAMS ((void));
437 static void first_last_page PARAMS ((char *pages));
438 static void print_sep_string PARAMS ((void));
439 static void separator_string PARAMS ((const char *optarg_S));
441 /* The name under which this program was invoked. */
442 char *program_name;
444 /* All of the columns to print. */
445 static COLUMN *column_vector;
447 /* When printing a single file in multiple downward columns,
448 we store the leftmost columns contiguously in buff.
449 To print a line from buff, get the index of the first character
450 from line_vector[i], and print up to line_vector[i + 1]. */
451 static char *buff;
453 /* Index of the position in buff where the next character
454 will be stored. */
455 static int buff_current;
457 /* The number of characters in buff.
458 Used for allocation of buff and to detect overflow of buff. */
459 static int buff_allocated;
461 /* Array of indices into buff.
462 Each entry is an index of the first character of a line.
463 This is used when storing lines to facilitate shuffling when
464 we do column balancing on the last page. */
465 static int *line_vector;
467 /* Array of horizonal positions.
468 For each line in line_vector, end_vector[line] is the horizontal
469 position we are in after printing that line. We keep track of this
470 so that we know how much we need to pad to prepare for the next
471 column. */
472 static int *end_vector;
474 /* (-m) True means we're printing multiple files in parallel. */
475 static int parallel_files = FALSE;
477 /* (-m) True means a line starts with some empty columns (some files
478 already CLOSED or ON_HOLD) which we have to align. */
479 static int align_empty_cols;
481 /* (-m) True means we have not yet found any printable column in a line.
482 align_empty_cols = TRUE has to be maintained. */
483 static int empty_line;
485 /* (-m) False means printable column output precedes a form feed found.
486 Column alignment is done only once. No additional action with that form
487 feed.
488 True means we found only a form feed in a column. Maybe we have to do
489 some column alignment with that form feed. */
490 static int FF_only;
492 /* (-[0-9]+) True means we're given an option explicitly specifying
493 number of columns. Used to detect when this option is used with -m
494 and when translating old options to new/long options. */
495 static int explicit_columns = FALSE;
497 /* (-t|-T) False means we aren't printing headers and footers. */
498 static int extremities = TRUE;
500 /* (-t) True means we retain all FF set by hand in input files.
501 False is set with -T option. */
502 static int keep_FF = FALSE;
503 static int print_a_FF = FALSE;
505 /* True means we need to print a header as soon as we know we've got input
506 to print after it. */
507 static int print_a_header;
509 /* (-h) True means we're using the standard header rather than a
510 customized one specified by the -h flag. */
511 static int standard_header = TRUE;
513 /* (-f) True means use formfeeds instead of newlines to separate pages. */
514 static int use_form_feed = FALSE;
516 /* True means we have read the standard input. */
517 static int have_read_stdin = FALSE;
519 /* True means the -a flag has been given. */
520 static int print_across_flag = FALSE;
522 /* True means we're printing one file in multiple (>1) downward columns. */
523 static int storing_columns = TRUE;
525 /* (-b) True means balance columns on the last page as Sys V does. */
526 /* That's no longer an independent option. With storing_columns = TRUE
527 balance_columns = TRUE is used too (s. function init_parameters).
528 We get a consistent formulation with "FF set by hand" in input files. */
529 static int balance_columns = FALSE;
531 /* (-l) Number of lines on a page, including header and footer lines. */
532 static int lines_per_page = 66;
534 /* Number of lines in the header and footer can be reset to 0 using
535 the -t flag. */
536 static int lines_per_header = 5;
537 static int lines_per_body;
538 static int lines_per_footer = 5;
540 /* (-w|-W) Width in characters of the page. Does not include the width of
541 the margin. */
542 static int chars_per_line = 72;
544 /* (-w|W) True means we truncate lines longer than chars_per_column. */
545 static int truncate_lines = FALSE;
547 /* (-J) True means we join lines without any line truncation. -J
548 dominates -w option. */
549 static int join_lines = FALSE;
551 /* Number of characters in a column. Based on col_sep_length and
552 page width. */
553 static int chars_per_column;
555 /* (-e) True means convert tabs to spaces on input. */
556 static int untabify_input = FALSE;
558 /* (-e) The input tab character. */
559 static char input_tab_char = '\t';
561 /* (-e) Tabstops are at chars_per_tab, 2*chars_per_tab, 3*chars_per_tab, ...
562 where the leftmost column is 1. */
563 static int chars_per_input_tab = 8;
565 /* (-i) True means convert spaces to tabs on output. */
566 static int tabify_output = FALSE;
568 /* (-i) The output tab character. */
569 static char output_tab_char = '\t';
571 /* (-i) The width of the output tab. */
572 static int chars_per_output_tab = 8;
574 /* Keeps track of pending white space. When we hit a nonspace
575 character after some whitespace, we print whitespace, tabbing
576 if necessary to get to output_position + spaces_not_printed. */
577 static int spaces_not_printed;
579 /* (-o) Number of spaces in the left margin (tabs used when possible). */
580 static int chars_per_margin = 0;
582 /* Position where the next character will fall.
583 Leftmost position is 0 + chars_per_margin.
584 Rightmost position is chars_per_margin + chars_per_line - 1.
585 This is important for converting spaces to tabs on output. */
586 static int output_position;
588 /* Horizontal position relative to the current file.
589 (output_position depends on where we are on the page;
590 input_position depends on where we are in the file.)
591 Important for converting tabs to spaces on input. */
592 static int input_position;
594 /* Count number of failed opens so we can exit with nonzero
595 status if there were any. */
596 static int failed_opens = 0;
598 /* The number of spaces taken up if we print a tab character with width
599 c_ from position h_. */
600 #define TAB_WIDTH(c_, h_) ((c_) - ((h_) % (c_)))
602 /* The horizontal position we'll be at after printing a tab character
603 of width c_ from the position h_. */
604 #define POS_AFTER_TAB(c_, h_) ((h_) + TAB_WIDTH (c_, h_))
606 /* (-NNN) Number of columns of text to print. */
607 static int columns = 1;
609 /* (+NNN:MMM) Page numbers on which to begin and stop printing.
610 first_page_number = 0 will be used to check input only. */
611 static int first_page_number = 0;
612 static int last_page_number = 0;
614 /* Number of files open (not closed, not on hold). */
615 static int files_ready_to_read = 0;
617 /* Current page number. Displayed in header. */
618 static int page_number;
620 /* Current line number. Displayed when -n flag is specified.
622 When printing files in parallel (-m flag), line numbering is as follows:
623 1 foo goo moo
624 2 hoo too zoo
626 When printing files across (-a flag), ...
627 1 foo 2 moo 3 goo
628 4 hoo 5 too 6 zoo
630 Otherwise, line numbering is as follows:
631 1 foo 3 goo 5 too
632 2 moo 4 hoo 6 zoo */
633 static int line_number;
635 /* With line_number overflow, we use power_10 to cut off the higher-order
636 digits of the line_number */
637 static int power_10;
639 /* (-n) True means lines should be preceded by numbers. */
640 static int numbered_lines = FALSE;
642 /* (-n) Character which follows each line number. */
643 static char number_separator = '\t';
645 /* (-n) line counting starts with 1st line of input file (not with 1st
646 line of 1st page printed). */
647 static int line_count = 1;
649 /* (-n) True means counting of skipped lines starts with 1st line of
650 input file. False means -N option is used in addition, counting of
651 skipped lines not required. */
652 static int skip_count = TRUE;
654 /* (-N) Counting starts with start_line_number = NUMBER at 1st line of
655 first page printed, usually not 1st page of input file. */
656 static int start_line_num = 1;
658 /* (-n) Width in characters of a line number. */
659 static int chars_per_number = 5;
661 /* Used when widening the first column to accommodate numbers -- only
662 needed when printing files in parallel. Includes width of both the
663 number and the number_separator. */
664 static int number_width;
666 /* Buffer sprintf uses to format a line number. */
667 static char *number_buff;
669 /* (-v) True means unprintable characters are printed as escape sequences.
670 control-g becomes \007. */
671 static int use_esc_sequence = FALSE;
673 /* (-c) True means unprintable characters are printed as control prefixes.
674 control-g becomes ^G. */
675 static int use_cntrl_prefix = FALSE;
677 /* (-d) True means output is double spaced. */
678 static int double_space = FALSE;
680 /* Number of files opened initially in init_files. Should be 1
681 unless we're printing multiple files in parallel. */
682 static int total_files = 0;
684 /* (-r) True means don't complain if we can't open a file. */
685 static int ignore_failed_opens = FALSE;
687 /* (-S) True means we separate columns with a specified string.
688 -S option does not affect line truncation nor column alignment. */
689 static int use_col_separator = FALSE;
691 /* String used to separate columns if the -S option has been specified.
692 Default without -S but together with one of the column options
693 -a|COLUMN|-m is a `space' and with the -J option a `tab'. */
694 static char *col_sep_string = "";
695 static int col_sep_length = 0;
696 static char *column_separator = " ";
697 static char *line_separator = "\t";
699 /* Number of separator characters waiting to be printed as soon as we
700 know that we have any input remaining to be printed. */
701 static int separators_not_printed;
703 /* Position we need to pad to, as soon as we know that we have input
704 remaining to be printed. */
705 static int padding_not_printed;
707 /* True means we should pad the end of the page. Remains false until we
708 know we have a page to print. */
709 static int pad_vertically;
711 /* (-h) String of characters used in place of the filename in the header. */
712 static char *custom_header;
714 /* String containing the date, filename or custom header, and "Page ". */
715 static char *header;
717 static int *clump_buff;
719 /* True means we read the line no. lines_per_body in skip_read
720 called by skip_to_page. That variable controls the coincidence of a
721 "FF set by hand" and "full_page_printed", see above the definition of
722 structure COLUMN. */
723 static int last_line = FALSE;
725 /* If nonzero, print a non-variable date and time with the header
726 -h HEADER using pr test-suite */
727 static int test_suite;
729 /* For long options that have no equivalent short option, use a
730 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
731 enum
733 PAGES_OPTION = CHAR_MAX + 1,
734 COLUMNS_OPTION
737 static struct option const long_options[] =
739 {"test", no_argument, &test_suite, 1},
740 {"pages", required_argument, NULL, PAGES_OPTION},
741 {"columns", required_argument, NULL, COLUMNS_OPTION},
742 {"across", no_argument, NULL, 'a'},
743 {"show-control-chars", no_argument, NULL, 'c'},
744 {"double-space", no_argument, NULL, 'd'},
745 {"expand-tabs", optional_argument, NULL, 'e'},
746 {"form-feed", no_argument, NULL, 'f'},
747 {"header", required_argument, NULL, 'h'},
748 {"output-tabs", optional_argument, NULL, 'i'},
749 {"join-lines", no_argument, NULL, 'J'},
750 {"length", required_argument, NULL, 'l'},
751 {"merge", no_argument, NULL, 'm'},
752 {"number-lines", optional_argument, NULL, 'n'},
753 {"first-line-number", required_argument, NULL, 'N'},
754 {"indent", required_argument, NULL, 'o'},
755 {"no-file-warnings", no_argument, NULL, 'r'},
756 {"separator", optional_argument, NULL, 's'},
757 {"sep-string", optional_argument, NULL, 'S'},
758 {"omit-header", no_argument, NULL, 't'},
759 {"omit-pagination", no_argument, NULL, 'T'},
760 {"show-nonprinting", no_argument, NULL, 'v'},
761 {"width", required_argument, NULL, 'w'},
762 {"page-width", required_argument, NULL, 'W'},
763 {GETOPT_HELP_OPTION_DECL},
764 {GETOPT_VERSION_OPTION_DECL},
765 {0, 0, 0, 0}
768 /* Return the number of columns that have either an open file or
769 stored lines. */
771 static int
772 cols_ready_to_print (void)
774 COLUMN *q;
775 int i;
776 int n;
778 n = 0;
779 for (q = column_vector, i = 0; i < columns; ++q, ++i)
780 if (q->status == OPEN ||
781 q->status == FF_FOUND || /* With -b: To print a header only */
782 (storing_columns && q->lines_stored > 0 && q->lines_to_print > 0))
783 ++n;
784 return n;
787 /* Estimate first_ / last_page_number
788 using option +FIRST_PAGE:LAST_PAGE */
790 static void
791 first_last_page (char *pages)
793 char *str1;
795 if (*pages == ':')
797 error (0, 0, _("`--pages' invalid range of page numbers: `%s'"), pages);
798 usage (2);
801 str1 = strchr (pages, ':');
802 if (str1 != NULL)
803 *str1 = '\0';
806 long int tmp_long;
807 if (xstrtol (pages, NULL, 10, &tmp_long, "") != LONGINT_OK
808 || tmp_long < 1 || tmp_long > INT_MAX)
809 error (EXIT_FAILURE, 0, _("`--pages' invalid starting page number: `%s'"),
810 pages);
811 first_page_number = (int) tmp_long;
814 if (str1 == NULL)
815 return;
818 long int tmp_long;
819 if (xstrtol (str1 + 1, NULL, 10, &tmp_long, "") != LONGINT_OK
820 || tmp_long <= 0 || tmp_long > INT_MAX)
821 error (EXIT_FAILURE, 0, _("`--pages' invalid ending page number: `%s'"),
822 str1 + 1);
823 last_page_number = (int) tmp_long;
826 if (first_page_number > last_page_number)
827 error (EXIT_FAILURE, 0,
828 _("`--pages' starting page number is larger than ending page number"));
831 /* Estimate length of col_sep_string with option -S[STRING] */
833 static void
834 separator_string (const char *optarg_S)
836 col_sep_length = (int) strlen (optarg_S);
837 col_sep_string = (char *) xmalloc (col_sep_length + 1);
838 strcpy (col_sep_string, optarg_S);
842 main (int argc, char **argv)
844 int c;
845 int accum = 0;
846 int n_files;
847 int old_options = FALSE;
848 int old_w = FALSE;
849 int old_s = FALSE;
850 char **file_names;
852 program_name = argv[0];
853 setlocale (LC_ALL, "");
854 bindtextdomain (PACKAGE, LOCALEDIR);
855 textdomain (PACKAGE);
857 atexit (close_stdout);
859 n_files = 0;
860 file_names = (argc > 1
861 ? (char **) xmalloc ((argc - 1) * sizeof (char *))
862 : NULL);
864 while ((c = getopt_long (argc, argv,
865 "-0123456789abcde::fFh:i::Jl:mn::N:o:rs::S::tTvw:W:",
866 long_options, NULL))
867 != -1)
869 if (ISDIGIT (c))
871 accum = accum * 10 + c - '0';
872 continue;
875 if (accum > 0)
877 columns = accum;
878 explicit_columns = TRUE;
879 accum = 0;
882 switch (c)
884 case 0: /* getopt long option */
885 break;
887 case 1: /* Non-option argument. */
888 if (*optarg == '+')
890 /* long option --page dominates old `+FIRST_PAGE ...' */
891 if (first_page_number <= 0 && last_page_number <= 0)
892 first_last_page (optarg);
894 else
895 file_names[n_files++] = optarg;
896 break;
898 case PAGES_OPTION: /* --pages=FIRST_PAGE[:LAST_PAGE] */
899 { /* dominates old opt +... */
900 if (optarg)
901 first_last_page (optarg);
902 else
903 error (EXIT_FAILURE, 0,
904 _("`--pages=FIRST_PAGE[:LAST_PAGE]' missing argument"));
905 break;
908 case COLUMNS_OPTION: /* --columns=COLUMN */
910 long int tmp_long;
911 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
912 || tmp_long <= 0 || tmp_long > INT_MAX)
914 error (EXIT_FAILURE, 0,
915 _("`--columns=COLUMN' invalid number of columns: `%s'"),
916 optarg);
918 columns = (int) tmp_long;
919 break;
922 case 'a':
923 print_across_flag = TRUE;
924 storing_columns = FALSE;
925 break;
926 case 'b':
927 balance_columns = TRUE;
928 break;
929 case 'c':
930 use_cntrl_prefix = TRUE;
931 break;
932 case 'd':
933 double_space = TRUE;
934 break;
935 case 'e':
936 if (optarg)
937 getoptarg (optarg, 'e', &input_tab_char,
938 &chars_per_input_tab);
939 /* Could check tab width > 0. */
940 untabify_input = TRUE;
941 break;
942 case 'f':
943 case 'F':
944 use_form_feed = TRUE;
945 break;
946 case 'h':
947 custom_header = optarg;
948 standard_header = FALSE;
949 break;
950 case 'i':
951 if (optarg)
952 getoptarg (optarg, 'i', &output_tab_char,
953 &chars_per_output_tab);
954 /* Could check tab width > 0. */
955 tabify_output = TRUE;
956 break;
957 case 'J':
958 join_lines = TRUE;
959 break;
960 case 'l':
962 long int tmp_long;
963 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
964 || tmp_long <= 0 || tmp_long > INT_MAX)
966 error (EXIT_FAILURE, 0,
967 _("`-l PAGE_LENGTH' invalid number of lines: `%s'"),
968 optarg);
970 lines_per_page = (int) tmp_long;
971 break;
973 case 'm':
974 parallel_files = TRUE;
975 storing_columns = FALSE;
976 break;
977 case 'n':
978 numbered_lines = TRUE;
979 if (optarg)
980 getoptarg (optarg, 'n', &number_separator,
981 &chars_per_number);
982 break;
983 case 'N':
984 skip_count = FALSE;
986 long int tmp_long;
987 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
988 || tmp_long > INT_MAX)
990 error (EXIT_FAILURE, 0,
991 _("`-N NUMBER' invalid starting line number: `%s'"),
992 optarg);
994 start_line_num = (int) tmp_long;
995 break;
997 case 'o':
999 long int tmp_long;
1000 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1001 || tmp_long < 0 || tmp_long > INT_MAX)
1002 error (EXIT_FAILURE, 0,
1003 _("`-o MARGIN' invalid line offset: `%s'"), optarg);
1004 chars_per_margin = (int) tmp_long;
1005 break;
1007 case 'r':
1008 ignore_failed_opens = TRUE;
1009 break;
1010 case 's':
1011 old_options = TRUE;
1012 old_s = TRUE;
1013 if (!use_col_separator && optarg)
1014 separator_string (optarg);
1015 break;
1016 case 'S':
1017 old_s = FALSE;
1018 /* Reset an additional input of -s, -S dominates -s */
1019 col_sep_string = "";
1020 col_sep_length = 0;
1021 use_col_separator = TRUE;
1022 if (optarg)
1023 separator_string (optarg);
1024 break;
1025 case 't':
1026 extremities = FALSE;
1027 keep_FF = TRUE;
1028 break;
1029 case 'T':
1030 extremities = FALSE;
1031 keep_FF = FALSE;
1032 break;
1033 case 'v':
1034 use_esc_sequence = TRUE;
1035 break;
1036 case 'w':
1037 old_options = TRUE;
1038 old_w = TRUE;
1040 long int tmp_long;
1041 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1042 || tmp_long <= 0 || tmp_long > INT_MAX)
1043 error (EXIT_FAILURE, 0,
1044 _("`-w PAGE_WIDTH' invalid number of characters: `%s'"), optarg);
1045 if (!truncate_lines) chars_per_line = (int) tmp_long;
1046 break;
1048 case 'W':
1049 old_w = FALSE; /* dominates -w */
1050 truncate_lines = TRUE;
1052 long int tmp_long;
1053 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
1054 || tmp_long <= 0 || tmp_long > INT_MAX)
1055 error (EXIT_FAILURE, 0,
1056 _("`-W PAGE_WIDTH' invalid number of characters: `%s'"), optarg);
1057 chars_per_line = (int) tmp_long;
1058 break;
1060 case_GETOPT_HELP_CHAR;
1061 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1062 default:
1063 usage (2);
1064 break;
1068 /* Now we can set a reasonable initial value: */
1069 if (first_page_number == 0)
1070 first_page_number = 1;
1072 if (parallel_files && explicit_columns)
1073 error (EXIT_FAILURE, 0,
1074 _("Cannot specify number of columns when printing in parallel."));
1076 if (parallel_files && print_across_flag)
1077 error (EXIT_FAILURE, 0,
1078 _("Cannot specify both printing across and printing in parallel."));
1080 /* Translate some old short options to new/long options.
1081 To meet downward compatibility with other UNIX pr utilities
1082 and some POSIX specifications. */
1084 if (old_options)
1086 if (old_w)
1088 if (parallel_files || explicit_columns)
1090 /* activate -W */
1091 truncate_lines = TRUE;
1092 if (old_s)
1093 /* adapt HP-UX and SunOS: -s = no separator;
1094 activate -S */
1095 use_col_separator = TRUE;
1097 else
1098 /* old -w sets width with columns only
1099 activate -J */
1100 join_lines = TRUE;
1102 else if (!use_col_separator)
1104 /* No -S option read */
1105 if (old_s && (parallel_files || explicit_columns))
1107 if (!truncate_lines)
1109 /* old -s (without -w and -W) annuls column alignment,
1110 uses fields, activate -J */
1111 join_lines = TRUE;
1112 if (col_sep_length > 0)
1113 /* activate -S */
1114 use_col_separator = TRUE;
1116 else
1117 /* with -W */
1118 /* adapt HP-UX and SunOS: -s = no separator;
1119 activate -S */
1120 use_col_separator = TRUE;
1125 for (; optind < argc; optind++)
1127 file_names[n_files++] = argv[optind];
1130 if (n_files == 0)
1132 /* No file arguments specified; read from standard input. */
1133 print_files (0, NULL);
1135 else
1137 if (parallel_files)
1138 print_files (n_files, file_names);
1139 else
1141 int i;
1142 for (i = 0; i < n_files; i++)
1143 print_files (1, &file_names[i]);
1147 cleanup ();
1149 if (have_read_stdin && fclose (stdin) == EOF)
1150 error (EXIT_FAILURE, errno, _("standard input"));
1151 if (failed_opens > 0)
1152 exit (EXIT_FAILURE);
1153 exit (EXIT_SUCCESS);
1156 /* Parse options of the form -scNNN.
1158 Example: -nck, where 'n' is the option, c is the optional number
1159 separator, and k is the optional width of the field used when printing
1160 a number. */
1162 static void
1163 getoptarg (char *arg, char switch_char, char *character, int *number)
1165 if (!ISDIGIT (*arg))
1166 *character = *arg++;
1167 if (*arg)
1169 long int tmp_long;
1170 if (xstrtol (arg, NULL, 10, &tmp_long, "") != LONGINT_OK
1171 || tmp_long <= 0 || tmp_long > INT_MAX)
1173 error (0, 0,
1174 _("`-%c' extra characters or invalid number in the argument: `%s'"),
1175 switch_char, arg);
1176 usage (2);
1178 *number = (int) tmp_long;
1182 /* Set parameters related to formatting. */
1184 static void
1185 init_parameters (int number_of_files)
1187 int chars_used_by_number = 0;
1189 if (use_form_feed)
1191 lines_per_header = 3;
1192 lines_per_footer = 0;
1195 lines_per_body = lines_per_page - lines_per_header - lines_per_footer;
1196 if (lines_per_body <= 0)
1198 extremities = FALSE;
1199 keep_FF = TRUE;
1201 if (extremities == FALSE)
1202 lines_per_body = lines_per_page;
1204 if (double_space)
1205 lines_per_body = lines_per_body / 2;
1207 /* If input is stdin, cannot print parallel files. BSD dumps core
1208 on this. */
1209 if (number_of_files == 0)
1210 parallel_files = FALSE;
1212 if (parallel_files)
1213 columns = number_of_files;
1215 /* One file, multi columns down: -b option is set to get a consistent
1216 formulation with "FF set by hand" in input files. */
1217 if (storing_columns)
1218 balance_columns = TRUE;
1220 /* Tabification is assumed for multiple columns. */
1221 if (columns > 1)
1223 if (!use_col_separator)
1225 /* Use default separator */
1226 if (join_lines)
1227 col_sep_string = line_separator;
1228 else
1229 col_sep_string = column_separator;
1231 col_sep_length = 1;
1232 use_col_separator = TRUE;
1234 /* It's rather pointless to define a TAB separator with column
1235 alignment */
1236 else if (!join_lines && *col_sep_string == '\t')
1237 col_sep_string = column_separator;
1239 truncate_lines = TRUE;
1240 untabify_input = TRUE;
1241 tabify_output = TRUE;
1243 else
1244 storing_columns = FALSE;
1246 /* -J dominates -w in any case */
1247 if (join_lines)
1248 truncate_lines = FALSE;
1250 if (numbered_lines)
1252 int tmp_i;
1253 int chars_per_default_tab = 8;
1255 line_count = start_line_num;
1257 /* To allow input tab-expansion (-e sensitive) use:
1258 if (number_separator == input_tab_char)
1259 number_width = chars_per_number +
1260 TAB_WIDTH (chars_per_input_tab, chars_per_number); */
1262 /* Estimate chars_per_text without any margin and keep it constant. */
1263 if (number_separator == '\t')
1264 number_width = chars_per_number +
1265 TAB_WIDTH (chars_per_default_tab, chars_per_number);
1266 else
1267 number_width = chars_per_number + 1;
1269 /* The number is part of the column width unless we are
1270 printing files in parallel. */
1271 if (parallel_files)
1272 chars_used_by_number = number_width;
1274 /* We use power_10 to cut off the higher-order digits of the
1275 line_number in function add_line_number */
1276 tmp_i = chars_per_number;
1277 for (power_10 = 1; tmp_i > 0; --tmp_i)
1278 power_10 = 10 * power_10;
1281 chars_per_column = (chars_per_line - chars_used_by_number -
1282 (columns - 1) * col_sep_length) / columns;
1284 if (chars_per_column < 1)
1285 error (EXIT_FAILURE, 0, _("page width too narrow"));
1287 if (numbered_lines)
1289 if (number_buff != NULL)
1290 free (number_buff);
1291 number_buff = (char *) xmalloc (2 * chars_per_number);
1294 /* Pick the maximum between the tab width and the width of an
1295 escape sequence.
1296 The width of an escape sequence (4) isn't the lower limit any longer.
1297 We've to use 8 as the lower limit, if we use chars_per_default_tab = 8
1298 to expand a tab which is not an input_tab-char. */
1299 if (clump_buff != NULL)
1300 free (clump_buff);
1301 clump_buff = (int *) xmalloc ((chars_per_input_tab > 8
1302 ? chars_per_input_tab : 8) * sizeof (int));
1305 /* Open the necessary files,
1306 maintaining a COLUMN structure for each column.
1308 With multiple files, each column p has a different p->fp.
1309 With single files, each column p has the same p->fp.
1310 Return 1 if (number_of_files > 0) and no files can be opened,
1311 0 otherwise.
1313 With each column/file p, p->full_page_printed is initialized,
1314 see also open_file. */
1316 static int
1317 init_fps (int number_of_files, char **av)
1319 int i, files_left;
1320 COLUMN *p;
1321 FILE *firstfp;
1322 char *firstname;
1324 total_files = 0;
1326 if (column_vector != NULLCOL)
1327 free ((char *) column_vector);
1328 column_vector = (COLUMN *) xmalloc (columns * sizeof (COLUMN));
1330 if (parallel_files)
1332 files_left = number_of_files;
1333 for (p = column_vector; files_left--; ++p, ++av)
1335 if (open_file (*av, p) == 0)
1337 --p;
1338 --columns;
1341 if (columns == 0)
1342 return 1;
1343 init_header ("", -1);
1345 else
1347 p = column_vector;
1348 if (number_of_files > 0)
1350 if (open_file (*av, p) == 0)
1351 return 1;
1352 init_header (*av, fileno (p->fp));
1353 p->lines_stored = 0;
1355 else
1357 p->name = _("standard input");
1358 p->fp = stdin;
1359 have_read_stdin = TRUE;
1360 p->status = OPEN;
1361 p->full_page_printed = FALSE;
1362 ++total_files;
1363 init_header ("", -1);
1364 p->lines_stored = 0;
1367 firstname = p->name;
1368 firstfp = p->fp;
1369 for (i = columns - 1, ++p; i; --i, ++p)
1371 p->name = firstname;
1372 p->fp = firstfp;
1373 p->status = OPEN;
1374 p->full_page_printed = FALSE;
1375 p->lines_stored = 0;
1378 files_ready_to_read = total_files;
1379 return 0;
1382 /* Determine print_func and char_func, the functions
1383 used by each column for printing and/or storing.
1385 Determine the horizontal position desired when we begin
1386 printing a column (p->start_position). */
1388 static void
1389 init_funcs (void)
1391 int i, h, h_next;
1392 COLUMN *p;
1394 h = chars_per_margin;
1396 if (!truncate_lines)
1397 h_next = ANYWHERE;
1398 else
1400 /* When numbering lines of parallel files, we enlarge the
1401 first column to accomodate the number. Looks better than
1402 the Sys V approach. */
1403 if (parallel_files && numbered_lines)
1404 h_next = h + chars_per_column + number_width;
1405 else
1406 h_next = h + chars_per_column;
1409 /* Enlarge p->start_position of first column to use the same form of
1410 padding_not_printed with all columns. */
1411 h = h + col_sep_length;
1413 /* This loop takes care of all but the rightmost column. */
1415 for (p = column_vector, i = 1; i < columns; ++p, ++i)
1417 if (storing_columns) /* One file, multi columns down. */
1419 p->char_func = store_char;
1420 p->print_func = print_stored;
1422 else
1423 /* One file, multi columns across; or parallel files. */
1425 p->char_func = print_char;
1426 p->print_func = read_line;
1429 /* Number only the first column when printing files in
1430 parallel. */
1431 p->numbered = numbered_lines && (!parallel_files || i == 1);
1432 p->start_position = h;
1434 /* If we don't truncate lines, all start_positions are
1435 ANYWHERE, except the first column's start_position when
1436 using a margin. */
1438 if (!truncate_lines)
1440 h = ANYWHERE;
1441 h_next = ANYWHERE;
1443 else
1445 h = h_next + col_sep_length;
1446 h_next = h + chars_per_column;
1450 /* The rightmost column.
1452 Doesn't need to be stored unless we intend to balance
1453 columns on the last page. */
1454 if (storing_columns && balance_columns)
1456 p->char_func = store_char;
1457 p->print_func = print_stored;
1459 else
1461 p->char_func = print_char;
1462 p->print_func = read_line;
1465 p->numbered = numbered_lines && (!parallel_files || i == 1);
1466 p->start_position = h;
1469 /* Open a file. Return nonzero if successful, zero if failed.
1471 With each file p, p->full_page_printed is initialized,
1472 see also init_fps. */
1474 static int
1475 open_file (char *name, COLUMN *p)
1477 if (STREQ (name, "-"))
1479 p->name = _("standard input");
1480 p->fp = stdin;
1481 have_read_stdin = 1;
1483 else
1485 p->name = name;
1486 p->fp = fopen (name, "r");
1488 if (p->fp == NULL)
1490 ++failed_opens;
1491 if (!ignore_failed_opens)
1492 error (0, errno, "%s", name);
1493 return 0;
1495 p->status = OPEN;
1496 p->full_page_printed = FALSE;
1497 ++total_files;
1498 return 1;
1501 /* Close the file in P.
1503 If we aren't dealing with multiple files in parallel, we change
1504 the status of all columns in the column list to reflect the close. */
1506 static void
1507 close_file (COLUMN *p)
1509 COLUMN *q;
1510 int i;
1512 if (p->status == CLOSED)
1513 return;
1514 if (ferror (p->fp))
1515 error (EXIT_FAILURE, errno, "%s", p->name);
1516 if (p->fp != stdin && fclose (p->fp) == EOF)
1517 error (EXIT_FAILURE, errno, "%s", p->name);
1519 if (!parallel_files)
1521 for (q = column_vector, i = columns; i; ++q, --i)
1523 q->status = CLOSED;
1524 if (q->lines_stored == 0)
1526 q->lines_to_print = 0;
1530 else
1532 p->status = CLOSED;
1533 p->lines_to_print = 0;
1536 --files_ready_to_read;
1539 /* Put a file on hold until we start a new page,
1540 since we've hit a form feed.
1542 If we aren't dealing with parallel files, we must change the
1543 status of all columns in the column list. */
1545 static void
1546 hold_file (COLUMN *p)
1548 COLUMN *q;
1549 int i;
1551 if (!parallel_files)
1552 for (q = column_vector, i = columns; i; ++q, --i)
1554 if (storing_columns)
1555 q->status = FF_FOUND;
1556 else
1557 q->status = ON_HOLD;
1559 else
1560 p->status = ON_HOLD;
1562 p->lines_to_print = 0;
1563 --files_ready_to_read;
1566 /* Undo hold_file -- go through the column list and change any
1567 ON_HOLD columns to OPEN. Used at the end of each page. */
1569 static void
1570 reset_status (void)
1572 int i = columns;
1573 COLUMN *p;
1575 for (p = column_vector; i; --i, ++p)
1576 if (p->status == ON_HOLD)
1578 p->status = OPEN;
1579 files_ready_to_read++;
1582 if (storing_columns)
1584 if (column_vector->status == CLOSED)
1585 /* We use the info to output an error message in skip_to_page. */
1586 files_ready_to_read = 0;
1587 else
1588 files_ready_to_read = 1;
1592 /* Print a single file, or multiple files in parallel.
1594 Set up the list of columns, opening the necessary files.
1595 Allocate space for storing columns, if necessary.
1596 Skip to first_page_number, if user has asked to skip leading pages.
1597 Determine which functions are appropriate to store/print lines
1598 in each column.
1599 Print the file(s). */
1601 static void
1602 print_files (int number_of_files, char **av)
1604 init_parameters (number_of_files);
1605 if (init_fps (number_of_files, av))
1606 return;
1607 if (storing_columns)
1608 init_store_cols ();
1610 if (first_page_number > 1)
1612 if (!skip_to_page (first_page_number))
1613 return;
1614 else
1615 page_number = first_page_number;
1617 else
1618 page_number = 1;
1620 init_funcs ();
1622 line_number = line_count;
1623 while (print_page ())
1627 /* Estimate the number of characters taken up by a short format date and
1628 time: "yy-mm-dd HH:MM" and: "Page NNNN". */
1629 #define CHARS_FOR_DATE_AND_PAGE 25
1631 #define T_BUF_FMT "%Y-%m-%d %H:%M" /* date/time short format */
1633 /* Add `2' because the expansion of %Y occupies 4 bytes, which is two more
1634 than the length of `%Y'. Each of the other formats expand to two bytes. */
1635 #define T_BUF_SIZE (2 + sizeof T_BUF_FMT)
1637 /* This string is exactly the same length as the expansion of T_BUF_FMT. */
1638 #define NO_DATE "-- Date/Time -- "
1640 /* Initialize header information.
1641 If DESC is non-negative, it is a file descriptor open to
1642 FILENAME for reading.
1644 Allocate space for a header string,
1645 Determine the time, insert file name or user-specified string.
1646 Make use of a centered header with left-hand-side truncation marked by
1647 a '*` in front, if necessary. */
1649 static void
1650 init_header (char *filename, int desc)
1652 char *f = filename;
1653 struct stat st;
1654 size_t header_buf_size;
1656 if (filename == NULL)
1657 f = "";
1659 if (header != NULL)
1660 free (header);
1662 /* Allow a space on each side of the the filename-or-header. */
1663 header_buf_size = MAX (chars_per_line, CHARS_FOR_DATE_AND_PAGE + 2) + 1;
1664 header = (char *) xmalloc (header_buf_size);
1666 if (!standard_header && *custom_header == '\0')
1667 *header = '\0'; /* blank line header */
1668 else
1670 int chars_per_middle, lhs_blanks, rhs_blanks;
1671 struct tm *tmptr;
1672 char t_buf[T_BUF_SIZE];
1673 char *header_text;
1675 /* If parallel files or standard input, use current time. */
1676 if (desc < 0 || STREQ (filename, "-") || fstat (desc, &st))
1677 st.st_mtime = time (NULL);
1679 tmptr = localtime (&st.st_mtime);
1680 strftime (t_buf, T_BUF_SIZE, T_BUF_FMT, tmptr);
1682 chars_per_middle = header_buf_size - 1 - CHARS_FOR_DATE_AND_PAGE;
1683 if (chars_per_middle < 3)
1685 header_text = ""; /* Nothing free for a heading */
1686 lhs_blanks = 1;
1687 rhs_blanks = 1;
1689 else
1691 int chars_free;
1692 header_text = standard_header ? f : custom_header;
1693 chars_free = chars_per_middle - (int) strlen (header_text);
1694 if (chars_free > 1)
1696 lhs_blanks = chars_free / 2; /* text not truncated */
1697 rhs_blanks = chars_free - lhs_blanks;
1699 else
1700 { /* lhs truncation */
1701 header_text = header_text - chars_free + 2;
1702 *header_text = '*';
1703 lhs_blanks = 1;
1704 rhs_blanks = 1;
1708 sprintf (header, _("%s%*s%s%*sPage"), (test_suite ? NO_DATE : t_buf),
1709 lhs_blanks, " ", header_text, rhs_blanks, " ");
1713 /* Set things up for printing a page
1715 Scan through the columns ...
1716 Determine which are ready to print
1717 (i.e., which have lines stored or open files)
1718 Set p->lines_to_print appropriately
1719 (to p->lines_stored if we're storing, or lines_per_body
1720 if we're reading straight from the file)
1721 Keep track of this total so we know when to stop printing */
1723 static void
1724 init_page (void)
1726 int j;
1727 COLUMN *p;
1729 if (storing_columns)
1731 store_columns ();
1732 for (j = columns - 1, p = column_vector; j; --j, ++p)
1734 p->lines_to_print = p->lines_stored;
1737 /* Last column. */
1738 if (balance_columns)
1740 p->lines_to_print = p->lines_stored;
1742 /* Since we're not balancing columns, we don't need to store
1743 the rightmost column. Read it straight from the file. */
1744 else
1746 if (p->status == OPEN)
1748 p->lines_to_print = lines_per_body;
1750 else
1751 p->lines_to_print = 0;
1754 else
1755 for (j = columns, p = column_vector; j; --j, ++p)
1756 if (p->status == OPEN)
1758 p->lines_to_print = lines_per_body;
1760 else
1761 p->lines_to_print = 0;
1764 /* Align empty columns and print separators.
1765 Empty columns will be formed by files with status ON_HOLD or CLOSED
1766 when printing multiple files in parallel. */
1768 static void
1769 align_column (COLUMN *p)
1771 padding_not_printed = p->start_position;
1772 if (padding_not_printed - col_sep_length > 0)
1774 pad_across_to (padding_not_printed - col_sep_length);
1775 padding_not_printed = ANYWHERE;
1778 if (use_col_separator)
1779 print_sep_string ();
1781 if (p->numbered)
1782 add_line_number (p);
1785 /* Print one page.
1787 As long as there are lines left on the page and columns ready to print,
1788 Scan across the column list
1789 if the column has stored lines or the file is open
1790 pad to the appropriate spot
1791 print the column
1792 pad the remainder of the page with \n or \f as requested
1793 reset the status of all files -- any files which where on hold because
1794 of formfeeds are now put back into the lineup. */
1796 static int
1797 print_page (void)
1799 int j;
1800 int lines_left_on_page;
1801 COLUMN *p;
1803 /* Used as an accumulator (with | operator) of successive values of
1804 pad_vertically. The trick is to set pad_vertically
1805 to zero before each run through the inner loop, then after that
1806 loop, it tells us whether a line was actually printed (whether a
1807 newline needs to be output -- or two for double spacing). But those
1808 values have to be accumulated (in pv) so we can invoke pad_down
1809 properly after the outer loop completes. */
1810 int pv;
1812 init_page ();
1814 if (cols_ready_to_print () == 0)
1815 return FALSE;
1817 if (extremities)
1818 print_a_header = TRUE;
1820 /* Don't pad unless we know a page was printed. */
1821 pad_vertically = FALSE;
1822 pv = FALSE;
1824 lines_left_on_page = lines_per_body;
1825 if (double_space)
1826 lines_left_on_page *= 2;
1828 while (lines_left_on_page > 0 && cols_ready_to_print () > 0)
1830 output_position = 0;
1831 spaces_not_printed = 0;
1832 separators_not_printed = 0;
1833 pad_vertically = FALSE;
1834 align_empty_cols = FALSE;
1835 empty_line = TRUE;
1837 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1839 input_position = 0;
1840 if (p->lines_to_print > 0 || p->status == FF_FOUND)
1842 FF_only = FALSE;
1843 padding_not_printed = p->start_position;
1844 if (!(p->print_func) (p))
1845 read_rest_of_line (p);
1846 pv |= pad_vertically;
1848 --p->lines_to_print;
1849 if (p->lines_to_print <= 0)
1851 if (cols_ready_to_print () <= 0)
1852 break;
1855 /* File p changed its status to ON_HOLD or CLOSED */
1856 if (parallel_files && p->status != OPEN)
1858 if (empty_line)
1859 align_empty_cols = TRUE;
1860 else if (p->status == CLOSED ||
1861 (p->status == ON_HOLD && FF_only))
1862 align_column (p);
1865 else if (parallel_files)
1867 /* File status ON_HOLD or CLOSED */
1868 if (empty_line)
1869 align_empty_cols = TRUE;
1870 else
1871 align_column (p);
1874 /* We need it also with an empty column */
1875 if (use_col_separator)
1876 ++separators_not_printed;
1879 if (pad_vertically)
1881 putchar ('\n');
1882 --lines_left_on_page;
1885 if (cols_ready_to_print () <= 0 && !extremities)
1886 break;
1888 if (double_space && pv)
1890 putchar ('\n');
1891 --lines_left_on_page;
1895 if (lines_left_on_page == 0)
1896 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
1897 if (p->status == OPEN)
1898 p->full_page_printed = TRUE;
1900 pad_vertically = pv;
1902 if (pad_vertically && extremities)
1903 pad_down (lines_left_on_page + lines_per_footer);
1904 else if (keep_FF && print_a_FF)
1906 putchar ('\f');
1907 print_a_FF = FALSE;
1910 if (last_page_number && page_number > last_page_number)
1911 return FALSE; /* Stop printing with LAST_PAGE */
1913 reset_status (); /* Change ON_HOLD to OPEN. */
1915 return TRUE; /* More pages to go. */
1918 /* Allocate space for storing columns.
1920 This is necessary when printing multiple columns from a single file.
1921 Lines are stored consecutively in buff, separated by '\0'.
1923 The following doesn't apply any longer - any tuning possible?
1924 (We can't use a fixed offset since with the '-s' flag lines aren't
1925 truncated.)
1927 We maintain a list (line_vector) of pointers to the beginnings
1928 of lines in buff. We allocate one more than the number of lines
1929 because the last entry tells us the index of the last character,
1930 which we need to know in order to print the last line in buff. */
1932 static void
1933 init_store_cols (void)
1935 int total_lines = lines_per_body * columns;
1936 int chars_if_truncate = total_lines * (chars_per_column + 1);
1938 if (line_vector != NULL)
1939 free ((int *) line_vector);
1940 /* FIXME: here's where it was allocated. */
1941 line_vector = (int *) xmalloc ((total_lines + 1) * sizeof (int *));
1943 if (end_vector != NULL)
1944 free ((int *) end_vector);
1945 end_vector = (int *) xmalloc (total_lines * sizeof (int *));
1947 if (buff != NULL)
1948 free (buff);
1949 buff_allocated = (use_col_separator
1950 ? 2 * chars_if_truncate
1951 : chars_if_truncate); /* Tune this. */
1952 buff = (char *) xmalloc (buff_allocated);
1955 /* Store all but the rightmost column.
1956 (Used when printing a single file in multiple downward columns)
1958 For each column
1959 set p->current_line to be the index in line_vector of the
1960 first line in the column
1961 For each line in the column
1962 store the line in buff
1963 add to line_vector the index of the line's first char
1964 buff_start is the index in buff of the first character in the
1965 current line. */
1967 static void
1968 store_columns (void)
1970 int i, j;
1971 int line = 0;
1972 int buff_start;
1973 int last_col; /* The rightmost column which will be saved in buff */
1974 COLUMN *p;
1976 buff_current = 0;
1977 buff_start = 0;
1979 if (balance_columns)
1980 last_col = columns;
1981 else
1982 last_col = columns - 1;
1984 for (i = 1, p = column_vector; i <= last_col; ++i, ++p)
1985 p->lines_stored = 0;
1987 for (i = 1, p = column_vector; i <= last_col && files_ready_to_read;
1988 ++i, ++p)
1990 p->current_line = line;
1991 for (j = lines_per_body; j && files_ready_to_read; --j)
1993 if (p->status == OPEN) /* Redundant. Clean up. */
1995 input_position = 0;
1997 if (!read_line (p))
1998 read_rest_of_line (p);
2000 if (p->status == OPEN
2001 || buff_start != buff_current)
2003 ++p->lines_stored;
2004 line_vector[line] = buff_start;
2005 end_vector[line++] = input_position;
2006 buff_start = buff_current;
2011 /* Keep track of the location of the last char in buff. */
2012 line_vector[line] = buff_start;
2014 if (balance_columns)
2015 balance (line);
2018 static void
2019 balance (int total_stored)
2021 COLUMN *p;
2022 int i, lines;
2023 int first_line = 0;
2025 for (i = 1, p = column_vector; i <= columns; ++i, ++p)
2027 lines = total_stored / columns;
2028 if (i <= total_stored % columns)
2029 ++lines;
2031 p->lines_stored = lines;
2032 p->current_line = first_line;
2034 first_line += lines;
2038 /* Store a character in the buffer. */
2040 static void
2041 store_char (int c)
2043 if (buff_current >= buff_allocated)
2045 /* May be too generous. */
2046 buff_allocated = 2 * buff_allocated;
2047 buff = (char *) xrealloc (buff, buff_allocated * sizeof (char));
2049 buff[buff_current++] = (char) c;
2052 static void
2053 add_line_number (COLUMN *p)
2055 int i;
2056 char *s;
2057 int left_cut;
2059 /* Cutting off the higher-order digits is more informative than
2060 lower-order cut off*/
2061 if (line_number < power_10)
2062 sprintf (number_buff, "%*d", chars_per_number, line_number);
2063 else
2065 left_cut = line_number % power_10;
2066 sprintf (number_buff, "%0*d", chars_per_number, left_cut);
2068 line_number++;
2069 s = number_buff;
2070 for (i = chars_per_number; i > 0; i--)
2071 (p->char_func) ((int) *s++);
2073 if (columns > 1)
2075 /* Tabification is assumed for multiple columns, also for n-separators,
2076 but `default n-separator = TAB' hasn't been given priority over
2077 equal column_width also specified by POSIX. */
2078 if (number_separator == '\t')
2080 i = number_width - chars_per_number;
2081 while (i-- > 0)
2082 (p->char_func) ((int) ' ');
2084 else
2085 (p->char_func) ((int) number_separator);
2087 else
2088 /* To comply with POSIX, we avoid any expansion of default TAB
2089 separator with a single column output. No column_width requirement
2090 has to be considered. */
2092 (p->char_func) ((int) number_separator);
2093 if (number_separator == '\t')
2094 output_position = POS_AFTER_TAB (chars_per_output_tab,
2095 output_position);
2098 if (truncate_lines && !parallel_files)
2099 input_position += number_width;
2102 /* Print (or store) padding until the current horizontal position
2103 is position. */
2105 static void
2106 pad_across_to (int position)
2108 register int h = output_position;
2110 if (tabify_output)
2111 spaces_not_printed = position - output_position;
2112 else
2114 while (++h <= position)
2115 putchar (' ');
2116 output_position = position;
2120 /* Pad to the bottom of the page.
2122 If the user has requested a formfeed, use one.
2123 Otherwise, use newlines. */
2125 static void
2126 pad_down (int lines)
2128 register int i;
2130 if (use_form_feed)
2131 putchar ('\f');
2132 else
2133 for (i = lines; i; --i)
2134 putchar ('\n');
2137 /* Read the rest of the line.
2139 Read from the current column's file until an end of line is
2140 hit. Used when we've truncated a line and we no longer need
2141 to print or store its characters. */
2143 static void
2144 read_rest_of_line (COLUMN *p)
2146 register int c;
2147 FILE *f = p->fp;
2149 while ((c = getc (f)) != '\n')
2151 if (c == '\f')
2153 if ((c = getc (f)) != '\n')
2154 ungetc (c, f);
2155 if (keep_FF)
2156 print_a_FF = TRUE;
2157 hold_file (p);
2158 break;
2160 else if (c == EOF)
2162 close_file (p);
2163 break;
2168 /* Read a line with skip_to_page.
2170 Read from the current column's file until an end of line is
2171 hit. Used when we read full lines to skip pages.
2172 With skip_to_page we have to check for FF-coincidence which is done
2173 in function read_line otherwise.
2174 Count lines of skipped pages to find the line number of 1st page
2175 printed relative to 1st line of input file (start_line_num). */
2177 static void
2178 skip_read (COLUMN *p, int column_number)
2180 register int c;
2181 FILE *f = p->fp;
2182 int i, single_ff = FALSE;
2183 COLUMN *q;
2185 /* Read 1st character in a line or any character succeeding a FF */
2186 if ((c = getc (f)) == '\f' && p->full_page_printed)
2187 /* A FF-coincidence with a previous full_page_printed.
2188 To avoid an additional empty page, eliminate the FF */
2189 if ((c = getc (f)) == '\n')
2190 c = getc (f);
2192 p->full_page_printed = FALSE;
2194 /* 1st character a FF means a single FF without any printable
2195 characters. Don't count it as a line with -n option. */
2196 if (c == '\f')
2197 single_ff = TRUE;
2199 /* Preparing for a FF-coincidence: Maybe we finish that page
2200 without a FF found */
2201 if (last_line)
2202 p->full_page_printed = TRUE;
2204 while (c != '\n')
2206 if (c == '\f')
2208 /* No FF-coincidence possible,
2209 no catching up of a FF-coincidence with next page */
2210 if (last_line)
2212 if (!parallel_files)
2213 for (q = column_vector, i = columns; i; ++q, --i)
2214 q->full_page_printed = FALSE;
2215 else
2216 p->full_page_printed = FALSE;
2219 if ((c = getc (f)) != '\n')
2220 ungetc (c, f);
2221 hold_file (p);
2222 break;
2224 else if (c == EOF)
2226 close_file (p);
2227 break;
2229 c = getc (f);
2232 if (skip_count)
2233 if ((!parallel_files || column_number == 1) && !single_ff)
2234 ++line_count;
2237 /* If we're tabifying output,
2239 When print_char encounters white space it keeps track
2240 of our desired horizontal position and delays printing
2241 until this function is called. */
2243 static void
2244 print_white_space (void)
2246 register int h_new;
2247 register int h_old = output_position;
2248 register int goal = h_old + spaces_not_printed;
2250 while (goal - h_old > 1
2251 && (h_new = POS_AFTER_TAB (chars_per_output_tab, h_old)) <= goal)
2253 putchar (output_tab_char);
2254 h_old = h_new;
2256 while (++h_old <= goal)
2257 putchar (' ');
2259 output_position = goal;
2260 spaces_not_printed = 0;
2263 /* Print column separators.
2265 We keep a count until we know that we'll be printing a line,
2266 then print_sep_string() is called. */
2268 static void
2269 print_sep_string ()
2271 char *s;
2272 int l = col_sep_length;
2274 s = col_sep_string;
2276 if (separators_not_printed <= 0)
2278 /* We'll be starting a line with chars_per_margin, anything else? */
2279 if (spaces_not_printed > 0)
2280 print_white_space ();
2282 else
2284 for (; separators_not_printed > 0; --separators_not_printed)
2286 while (l-- > 0)
2288 /* 3 types of sep_strings: spaces only, spaces and chars,
2289 chars only */
2290 if (*s == ' ')
2292 /* We're tabifying output; consecutive spaces in
2293 sep_string may have to be converted to tabs */
2294 s++;
2295 ++spaces_not_printed;
2297 else
2299 if (spaces_not_printed > 0)
2300 print_white_space ();
2301 putchar (*s++);
2302 ++output_position;
2305 /* sep_string ends with some spaces */
2306 if (spaces_not_printed > 0)
2307 print_white_space ();
2312 /* Print (or store, depending on p->char_func) a clump of N
2313 characters. */
2315 static void
2316 print_clump (COLUMN *p, int n, int *clump)
2318 while (n--)
2319 (p->char_func) (*clump++);
2322 /* Print a character.
2324 Update the following comment: process-char hasn't been used any
2325 longer.
2326 If we're tabifying, all tabs have been converted to spaces by
2327 process_char(). Keep a count of consecutive spaces, and when
2328 a nonspace is encountered, call print_white_space() to print the
2329 required number of tabs and spaces. */
2331 static void
2332 print_char (int c)
2334 if (tabify_output)
2336 if (c == ' ')
2338 ++spaces_not_printed;
2339 return;
2341 else if (spaces_not_printed > 0)
2342 print_white_space ();
2344 /* Nonprintables are assumed to have width 0, except '\b'. */
2345 if (!ISPRINT (c))
2347 if (c == '\b')
2348 --output_position;
2350 else
2351 ++output_position;
2353 putchar (c);
2356 /* Skip to page PAGE before printing.
2357 PAGE may be larger than total number of pages. */
2359 static int
2360 skip_to_page (int page)
2362 int n, i, j;
2363 COLUMN *p;
2365 for (n = 1; n < page; ++n)
2367 for (i = 1; i < lines_per_body; ++i)
2369 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2370 if (p->status == OPEN)
2371 skip_read (p, j);
2373 last_line = TRUE;
2374 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2375 if (p->status == OPEN)
2376 skip_read (p, j);
2378 if (storing_columns) /* change FF_FOUND to ON_HOLD */
2379 for (j = 1, p = column_vector; j <= columns; ++j, ++p)
2380 if (p->status != CLOSED)
2381 p->status = ON_HOLD;
2383 reset_status ();
2384 last_line = FALSE;
2386 if (files_ready_to_read < 1)
2388 /* It's very helpful, normally the total number of pages is
2389 not known in advance. */
2390 error (0, 0,
2391 _("starting page number larger than total number of pages: `%d'"),
2393 break;
2396 return files_ready_to_read > 0;
2399 /* Print a header.
2401 Formfeeds are assumed to use up two lines at the beginning of
2402 the page. */
2404 static void
2405 print_header (void)
2407 if (!use_form_feed)
2408 fprintf (stdout, "\n\n");
2410 output_position = 0;
2411 pad_across_to (chars_per_margin);
2412 print_white_space ();
2414 if (!standard_header && *custom_header == '\0')
2416 fprintf (stdout, "%s\n\n\n", header);
2417 page_number++;
2419 else
2420 fprintf (stdout, "%s%5d\n\n\n", header, page_number++);
2422 print_a_header = FALSE;
2423 output_position = 0;
2426 /* Print (or store, if p->char_func is store_char()) a line.
2428 Read a character to determine whether we have a line or not.
2429 (We may hit EOF, \n, or \f)
2431 Once we know we have a line,
2432 set pad_vertically = TRUE, meaning it's safe
2433 to pad down at the end of the page, since we do have a page.
2434 print a header if needed.
2435 pad across to padding_not_printed if needed.
2436 print any separators which need to be printed.
2437 print a line number if it needs to be printed.
2439 Print the clump which corresponds to the first character.
2441 Enter a loop and keep printing until an end of line condition
2442 exists, or until we exceed chars_per_column.
2444 Return FALSE if we exceed chars_per_column before reading
2445 an end of line character, TRUE otherwise. */
2447 static int
2448 read_line (COLUMN *p)
2450 int c;
2451 int chars IF_LINT (= 0);
2452 int last_input_position;
2453 int j, k;
2454 COLUMN *q;
2456 /* read 1st character in each line or any character succeeding a FF: */
2457 c = getc (p->fp);
2459 last_input_position = input_position;
2461 if (c == '\f' && p->full_page_printed)
2462 if ((c = getc (p->fp)) == '\n')
2463 c = getc (p->fp);
2464 p->full_page_printed = FALSE;
2466 switch (c)
2468 case '\f':
2469 if ((c = getc (p->fp)) != '\n')
2470 ungetc (c, p->fp);
2471 FF_only = TRUE;
2472 if (print_a_header && !storing_columns)
2474 pad_vertically = TRUE;
2475 print_header ();
2477 else if (keep_FF)
2478 print_a_FF = TRUE;
2479 hold_file (p);
2480 return TRUE;
2481 case EOF:
2482 close_file (p);
2483 return TRUE;
2484 case '\n':
2485 break;
2486 default:
2487 chars = char_to_clump (c);
2490 if (truncate_lines && input_position > chars_per_column)
2492 input_position = last_input_position;
2493 return FALSE;
2496 if (p->char_func != store_char)
2498 pad_vertically = TRUE;
2500 if (print_a_header && !storing_columns)
2501 print_header ();
2503 if (parallel_files && align_empty_cols)
2505 /* We have to align empty columns at the beginning of a line. */
2506 k = separators_not_printed;
2507 separators_not_printed = 0;
2508 for (j = 1, q = column_vector; j <= k; ++j, ++q)
2510 align_column (q);
2511 separators_not_printed += 1;
2513 padding_not_printed = p->start_position;
2514 if (truncate_lines)
2515 spaces_not_printed = chars_per_column;
2516 else
2517 spaces_not_printed = 0;
2518 align_empty_cols = FALSE;
2521 if (padding_not_printed - col_sep_length > 0)
2523 pad_across_to (padding_not_printed - col_sep_length);
2524 padding_not_printed = ANYWHERE;
2527 if (use_col_separator)
2528 print_sep_string ();
2531 if (p->numbered)
2532 add_line_number (p);
2534 empty_line = FALSE;
2535 if (c == '\n')
2536 return TRUE;
2538 print_clump (p, chars, clump_buff);
2540 for (;;)
2542 c = getc (p->fp);
2544 switch (c)
2546 case '\n':
2547 return TRUE;
2548 case '\f':
2549 if ((c = getc (p->fp)) != '\n')
2550 ungetc (c, p->fp);
2551 if (keep_FF)
2552 print_a_FF = TRUE;
2553 hold_file (p);
2554 return TRUE;
2555 case EOF:
2556 close_file (p);
2557 return TRUE;
2560 last_input_position = input_position;
2561 chars = char_to_clump (c);
2562 if (truncate_lines && input_position > chars_per_column)
2564 input_position = last_input_position;
2565 return FALSE;
2568 print_clump (p, chars, clump_buff);
2572 /* Print a line from buff.
2574 If this function has been called, we know we have "something to
2575 print". But it remains to be seen whether we have a real text page
2576 or an empty page (a single form feed) with/without a header only.
2577 Therefore first we set pad_vertically to TRUE and print a header
2578 if necessary.
2579 If FF_FOUND and we are using -t|-T option we omit any newline by
2580 setting pad_vertically to FALSE (see print_page).
2581 Otherwise we pad across if necessary, print separators if necessary
2582 and text of COLUMN *p.
2584 Return TRUE, meaning there is no need to call read_rest_of_line. */
2586 static int
2587 print_stored (COLUMN *p)
2589 COLUMN *q;
2590 int i;
2592 int line = p->current_line++;
2593 register char *first = &buff[line_vector[line]];
2594 /* FIXME
2595 UMR: Uninitialized memory read:
2596 * This is occurring while in:
2597 print_stored [pr.c:2239]
2598 * Reading 4 bytes from 0x5148c in the heap.
2599 * Address 0x5148c is 4 bytes into a malloc'd block at 0x51488 of 676 bytes
2600 * This block was allocated from:
2601 malloc [rtlib.o]
2602 xmalloc [xmalloc.c:94]
2603 init_store_cols [pr.c:1648]
2605 register char *last = &buff[line_vector[line + 1]];
2607 pad_vertically = TRUE;
2609 if (print_a_header)
2610 print_header ();
2612 if (p->status == FF_FOUND)
2614 for (i = 1, q = column_vector; i <= columns; ++i, ++q)
2615 q->status = ON_HOLD;
2616 if (column_vector->lines_to_print <= 0)
2618 if (!extremities)
2619 pad_vertically = FALSE;
2620 return TRUE; /* print a header only */
2624 if (padding_not_printed - col_sep_length > 0)
2626 pad_across_to (padding_not_printed - col_sep_length);
2627 padding_not_printed = ANYWHERE;
2630 if (use_col_separator)
2631 print_sep_string ();
2633 while (first != last)
2634 print_char (*first++);
2636 if (spaces_not_printed == 0)
2638 output_position = p->start_position + end_vector[line];
2639 if (p->start_position - col_sep_length == chars_per_margin)
2640 output_position -= col_sep_length;
2643 return TRUE;
2646 /* Convert a character to the proper format and return the number of
2647 characters in the resulting clump. Increment input_position by
2648 the width of the clump.
2650 Tabs are converted to clumps of spaces.
2651 Nonprintable characters may be converted to clumps of escape
2652 sequences or control prefixes.
2654 Note: the width of a clump is not necessarily equal to the number of
2655 characters in clump_buff. (e.g, the width of '\b' is -1, while the
2656 number of characters is 1.) */
2658 static int
2659 char_to_clump (int c)
2661 register int *s = clump_buff;
2662 register int i;
2663 char esc_buff[4];
2664 int width;
2665 int chars;
2666 int chars_per_c = 8;
2668 if (c == input_tab_char)
2669 chars_per_c = chars_per_input_tab;
2671 if (c == input_tab_char || c == '\t')
2673 width = TAB_WIDTH (chars_per_c, input_position);
2675 if (untabify_input)
2677 for (i = width; i; --i)
2678 *s++ = ' ';
2679 chars = width;
2681 else
2683 *s = c;
2684 chars = 1;
2688 else if (!ISPRINT (c))
2690 if (use_esc_sequence)
2692 width = 4;
2693 chars = 4;
2694 *s++ = '\\';
2695 sprintf (esc_buff, "%03o", c);
2696 for (i = 0; i <= 2; ++i)
2697 *s++ = (int) esc_buff[i];
2699 else if (use_cntrl_prefix)
2701 if (c < 0200)
2703 width = 2;
2704 chars = 2;
2705 *s++ = '^';
2706 *s++ = c ^ 0100;
2708 else
2710 width = 4;
2711 chars = 4;
2712 *s++ = '\\';
2713 sprintf (esc_buff, "%03o", c);
2714 for (i = 0; i <= 2; ++i)
2715 *s++ = (int) esc_buff[i];
2718 else if (c == '\b')
2720 width = -1;
2721 chars = 1;
2722 *s = c;
2724 else
2726 width = 0;
2727 chars = 1;
2728 *s = c;
2731 else
2733 width = 1;
2734 chars = 1;
2735 *s = c;
2738 input_position += width;
2739 return chars;
2742 /* We've just printed some files and need to clean up things before
2743 looking for more options and printing the next batch of files.
2745 Free everything we've xmalloc'ed, except `header'. */
2747 static void
2748 cleanup (void)
2750 if (number_buff)
2751 free (number_buff);
2752 if (clump_buff)
2753 free (clump_buff);
2754 if (column_vector)
2755 free (column_vector);
2756 if (line_vector)
2757 free (line_vector);
2758 if (end_vector)
2759 free (end_vector);
2760 if (buff)
2761 free (buff);
2764 /* Complain, print a usage message, and die. */
2766 void
2767 usage (int status)
2769 if (status != 0)
2770 fprintf (stderr, _("Try `%s --help' for more information.\n"),
2771 program_name);
2772 else
2774 printf (_("\
2775 Usage: %s [OPTION]... [FILE]...\n\
2777 program_name);
2779 printf (_("\
2780 Paginate or columnate FILE(s) for printing.\n\
2782 +FIRST_PAGE[:LAST_PAGE], --pages=FIRST_PAGE[:LAST_PAGE]\n\
2783 begin [stop] printing with page FIRST_[LAST_]PAGE\n\
2784 -COLUMN, --columns=COLUMN\n\
2785 produce COLUMN-column output and print columns down,\n\
2786 unless -a is used. Balance number of lines in the\n\
2787 columns on each page.\n\
2788 -a, --across print columns across rather than down, used together\n\
2789 with -COLUMN\n\
2790 -c, --show-control-chars\n\
2791 use hat notation (^G) and octal backslash notation\n\
2792 -d, --double-space\n\
2793 double space the output\n\
2794 -e[CHAR[WIDTH]], --expand-tabs[=CHAR[WIDTH]]\n\
2795 expand input CHARs (TABs) to tab WIDTH (8)\n\
2796 -F, -f, --form-feed\n\
2797 use form feeds instead of newlines to separate pages\n\
2798 (by a 3-line page header with -F or a 5-line header\n\
2799 and trailer without -F)\n\
2800 "));
2801 printf (_("\
2802 -h HEADER, --header=HEADER\n\
2803 use a centered HEADER instead of filename in page header,\n\
2804 with long headers left-hand-side truncation may occur,\n\
2805 -h \"\" prints a blank line, don't use -h\"\"\n\
2806 -i[CHAR[WIDTH]], --output-tabs[=CHAR[WIDTH]]\n\
2807 replace spaces with CHARs (TABs) to tab WIDTH (8)\n\
2808 -J, --join-lines merge full lines, turns off -W line truncation, no column\n\
2809 alignment, -S[STRING] sets separators\n\
2810 -l PAGE_LENGTH, --length=PAGE_LENGTH\n\
2811 set the page length to PAGE_LENGTH (66) lines\n\
2812 (default number of lines of text 56, and with -F 63)\n\
2813 -m, --merge print all files in parallel, one in each column,\n\
2814 truncate lines, but join lines of full length with -J\n\
2815 -n[SEP[DIGITS]], --number-lines[=SEP[DIGITS]]\n\
2816 number lines, use DIGITS (5) digits, then SEP (TAB),\n\
2817 default counting starts with 1st line of input file\n\
2818 -N NUMBER, --first-line-number=NUMBER\n\
2819 start counting with NUMBER at 1st line of first\n\
2820 page printed (see +FIRST_PAGE)\n\
2821 -o MARGIN, --indent=MARGIN\n\
2822 offset each line with MARGIN (zero) spaces, do not\n\
2823 affect -w or -W, MARGIN will be added to PAGE_WIDTH\n\
2824 -r, --no-file-warnings\n\
2825 omit warning when a file cannot be opened\n\
2826 "));
2827 printf (_("\
2828 -s[CHAR],--separator[=CHAR]\n\
2829 separate columns by a single character, default for CHAR\n\
2830 is the <TAB> character without -w and \'no char\' with -w\n\
2831 -s[CHAR] turns off line truncation of all 3 column\n\
2832 options (-COLUMN|-a -COLUMN|-m) except -w is set\n\
2833 -S[STRING], --sep-string[=STRING]\n\
2834 separate columns by an optional STRING, don't use\n\
2835 -S \"STRING\", -S only: No separator used (same as -S\"\"),\n\
2836 without -S: Default separator <TAB> with -J and <space>\n\
2837 otherwise (same as -S\" \"), no effect on column options\n\
2838 -t, --omit-header omit page headers and trailers\n\
2839 -T, --omit-pagination\n\
2840 omit page headers and trailers, eliminate any pagination\n\
2841 by form feeds set in input files\n\
2842 -v, --show-nonprinting\n\
2843 use octal backslash notation\n\
2844 -w PAGE_WIDTH, --width=PAGE_WIDTH\n\
2845 set page width to PAGE_WIDTH (72) characters for\n\
2846 multiple text-column output only, -s[char] turns off (72)\n\
2847 -W PAGE_WIDTH, --page-width=PAGE_WIDTH\n\
2848 set page width to PAGE_WIDTH (72) characters always,\n\
2849 truncate lines, except -J option is set, no interference\n\
2850 with -S or -s\n\
2851 --help display this help and exit\n\
2852 --version output version information and exit\n\
2854 -T implied by -l nn when nn <= 10 or <= 3 with -F. With no FILE, or when\n\
2855 FILE is -, read standard input.\n\
2856 "));
2857 puts (_("\nReport bugs to <bug-textutils@gnu.org>."));
2859 exit (status == 0 ? EXIT_SUCCESS : EXIT_FAILURE);