1 /* nl -- number lines of files
2 Copyright (C) 89, 92, 1995-2009 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17 /* Written by Scott Bartram (nancy!scott@uunet.uu.net)
18 Revised by David MacKenzie (djm@gnu.ai.mit.edu) */
23 #include <sys/types.h>
31 #include "linebuffer.h"
35 /* The official name of this program (e.g., no `g' prefix). */
36 #define PROGRAM_NAME "nl"
39 proper_name ("Scott Bartram"), \
40 proper_name ("David MacKenzie")
42 /* Line-number formats. They are given an int width, an intmax_t
43 value, and a string separator. */
45 /* Right justified, no leading zeroes. */
46 static char const FORMAT_RIGHT_NOLZ
[] = "%*" PRIdMAX
"%s";
48 /* Right justified, leading zeroes. */
49 static char const FORMAT_RIGHT_LZ
[] = "%0*" PRIdMAX
"%s";
51 /* Left justified, no leading zeroes. */
52 static char const FORMAT_LEFT
[] = "%-*" PRIdMAX
"%s";
54 /* Default section delimiter characters. */
55 static char const DEFAULT_SECTION_DELIMITERS
[] = "\\:";
57 /* Types of input lines: either one of the section delimiters,
61 Header
, Body
, Footer
, Text
64 /* Format of body lines (-b). */
65 static char const *body_type
= "t";
67 /* Format of header lines (-h). */
68 static char const *header_type
= "n";
70 /* Format of footer lines (-f). */
71 static char const *footer_type
= "n";
73 /* Format currently being used (body, header, or footer). */
74 static char const *current_type
;
76 /* Regex for body lines to number (-bp). */
77 static struct re_pattern_buffer body_regex
;
79 /* Regex for header lines to number (-hp). */
80 static struct re_pattern_buffer header_regex
;
82 /* Regex for footer lines to number (-fp). */
83 static struct re_pattern_buffer footer_regex
;
85 /* Fastmaps for the above. */
86 static char body_fastmap
[UCHAR_MAX
+ 1];
87 static char header_fastmap
[UCHAR_MAX
+ 1];
88 static char footer_fastmap
[UCHAR_MAX
+ 1];
90 /* Pointer to current regex, if any. */
91 static struct re_pattern_buffer
*current_regex
= NULL
;
93 /* Separator string to print after line number (-s). */
94 static char const *separator_str
= "\t";
96 /* Input section delimiter string (-d). */
97 static char const *section_del
= DEFAULT_SECTION_DELIMITERS
;
99 /* Header delimiter string. */
100 static char *header_del
= NULL
;
102 /* Header section delimiter length. */
103 static size_t header_del_len
;
105 /* Body delimiter string. */
106 static char *body_del
= NULL
;
108 /* Body section delimiter length. */
109 static size_t body_del_len
;
111 /* Footer delimiter string. */
112 static char *footer_del
= NULL
;
114 /* Footer section delimiter length. */
115 static size_t footer_del_len
;
118 static struct linebuffer line_buf
;
120 /* printf format string for unnumbered lines. */
121 static char *print_no_line_fmt
= NULL
;
123 /* Starting line number on each page (-v). */
124 static intmax_t starting_line_number
= 1;
126 /* Line number increment (-i). */
127 static intmax_t page_incr
= 1;
129 /* If true, reset line number at start of each page (-p). */
130 static bool reset_numbers
= true;
132 /* Number of blank lines to consider to be one line for numbering (-l). */
133 static intmax_t blank_join
= 1;
135 /* Width of line numbers (-w). */
136 static int lineno_width
= 6;
138 /* Line number format (-n). */
139 static char const *lineno_format
= FORMAT_RIGHT_NOLZ
;
141 /* Current print line number. */
142 static intmax_t line_no
;
144 /* True if we have ever read standard input. */
145 static bool have_read_stdin
;
149 PAGE_INCREMENT_OPTION_DEPRECATED
= CHAR_MAX
+ 1
152 static struct option
const longopts
[] =
154 {"header-numbering", required_argument
, NULL
, 'h'},
155 {"body-numbering", required_argument
, NULL
, 'b'},
156 {"footer-numbering", required_argument
, NULL
, 'f'},
157 {"starting-line-number", required_argument
, NULL
, 'v'},
158 {"line-increment", required_argument
, NULL
, 'i'},
159 /* FIXME: page-increment is deprecated, remove in dec-2011. */
160 {"page-increment", required_argument
, NULL
, PAGE_INCREMENT_OPTION_DEPRECATED
},
161 {"no-renumber", no_argument
, NULL
, 'p'},
162 {"join-blank-lines", required_argument
, NULL
, 'l'},
163 {"number-separator", required_argument
, NULL
, 's'},
164 {"number-width", required_argument
, NULL
, 'w'},
165 {"number-format", required_argument
, NULL
, 'n'},
166 {"section-delimiter", required_argument
, NULL
, 'd'},
167 {GETOPT_HELP_OPTION_DECL
},
168 {GETOPT_VERSION_OPTION_DECL
},
172 /* Print a usage message and quit. */
177 if (status
!= EXIT_SUCCESS
)
178 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
183 Usage: %s [OPTION]... [FILE]...\n\
187 Write each FILE to standard output, with line numbers added.\n\
188 With no FILE, or when FILE is -, read standard input.\n\
192 Mandatory arguments to long options are mandatory for short options too.\n\
195 -b, --body-numbering=STYLE use STYLE for numbering body lines\n\
196 -d, --section-delimiter=CC use CC for separating logical pages\n\
197 -f, --footer-numbering=STYLE use STYLE for numbering footer lines\n\
200 -h, --header-numbering=STYLE use STYLE for numbering header lines\n\
201 -i, --line-increment=NUMBER line number increment at each line\n\
202 -l, --join-blank-lines=NUMBER group of NUMBER empty lines counted as one\n\
203 -n, --number-format=FORMAT insert line numbers according to FORMAT\n\
204 -p, --no-renumber do not reset line numbers at logical pages\n\
205 -s, --number-separator=STRING add STRING after (possible) line number\n\
208 -v, --starting-line-number=NUMBER first line number on each logical page\n\
209 -w, --number-width=NUMBER use NUMBER columns for line numbers\n\
211 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
212 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
215 By default, selects -v1 -i1 -l1 -sTAB -w6 -nrn -hn -bt -fn. CC are\n\
216 two delimiter characters for separating logical pages, a missing\n\
217 second character implies :. Type \\\\ for \\. STYLE is one of:\n\
221 a number all lines\n\
222 t number only nonempty lines\n\
224 pBRE number only lines that contain a match for the basic regular\n\
229 ln left justified, no leading zeros\n\
230 rn right justified, no leading zeros\n\
231 rz right justified, leading zeros\n\
234 emit_bug_reporting_address ();
239 /* Set the command line flag TYPEP and possibly the regex pointer REGEXP,
240 according to `optarg'. */
243 build_type_arg (char const **typep
,
244 struct re_pattern_buffer
*regexp
, char *fastmap
)
258 regexp
->buffer
= NULL
;
259 regexp
->allocated
= 0;
260 regexp
->fastmap
= fastmap
;
261 regexp
->translate
= NULL
;
263 RE_SYNTAX_POSIX_BASIC
& ~RE_CONTEXT_INVALID_DUP
& ~RE_NO_EMPTY_RANGES
;
264 errmsg
= re_compile_pattern (optarg
, strlen (optarg
), regexp
);
266 error (EXIT_FAILURE
, 0, "%s", errmsg
);
275 /* Print the line number and separator; increment the line number. */
280 intmax_t next_line_no
;
282 printf (lineno_format
, lineno_width
, line_no
, separator_str
);
284 next_line_no
= line_no
+ page_incr
;
285 if (next_line_no
< line_no
)
286 error (EXIT_FAILURE
, 0, _("line number overflow"));
287 line_no
= next_line_no
;
290 /* Switch to a header section. */
295 current_type
= header_type
;
296 current_regex
= &header_regex
;
298 line_no
= starting_line_number
;
302 /* Switch to a body section. */
307 current_type
= body_type
;
308 current_regex
= &body_regex
;
312 /* Switch to a footer section. */
317 current_type
= footer_type
;
318 current_regex
= &footer_regex
;
322 /* Process a regular text line in `line_buf'. */
327 static intmax_t blank_lines
= 0; /* Consecutive blank lines so far. */
329 switch (*current_type
)
334 if (1 < line_buf
.length
|| ++blank_lines
== blank_join
)
340 fputs (print_no_line_fmt
, stdout
);
346 if (1 < line_buf
.length
)
349 fputs (print_no_line_fmt
, stdout
);
352 fputs (print_no_line_fmt
, stdout
);
355 switch (re_search (current_regex
, line_buf
.buffer
, line_buf
.length
- 1,
356 0, line_buf
.length
- 1, NULL
))
359 error (EXIT_FAILURE
, errno
, _("error in regular expression search"));
362 fputs (print_no_line_fmt
, stdout
);
370 fwrite (line_buf
.buffer
, sizeof (char), line_buf
.length
, stdout
);
373 /* Return the type of line in `line_buf'. */
378 size_t len
= line_buf
.length
- 1;
380 if (len
< 2 || memcmp (line_buf
.buffer
, section_del
, 2))
382 if (len
== header_del_len
383 && !memcmp (line_buf
.buffer
, header_del
, header_del_len
))
385 if (len
== body_del_len
386 && !memcmp (line_buf
.buffer
, body_del
, body_del_len
))
388 if (len
== footer_del_len
389 && !memcmp (line_buf
.buffer
, footer_del
, footer_del_len
))
394 /* Read and process the file pointed to by FP. */
397 process_file (FILE *fp
)
399 while (readlinebuffer (&line_buf
, fp
))
401 switch (check_section ())
419 /* Process file FILE to standard output.
420 Return true if successful. */
423 nl_file (char const *file
)
427 if (STREQ (file
, "-"))
429 have_read_stdin
= true;
434 stream
= fopen (file
, "r");
437 error (0, errno
, "%s", file
);
442 process_file (stream
);
446 error (0, errno
, "%s", file
);
449 if (STREQ (file
, "-"))
450 clearerr (stream
); /* Also clear EOF. */
451 else if (fclose (stream
) == EOF
)
453 error (0, errno
, "%s", file
);
460 main (int argc
, char **argv
)
466 initialize_main (&argc
, &argv
);
467 set_program_name (argv
[0]);
468 setlocale (LC_ALL
, "");
469 bindtextdomain (PACKAGE
, LOCALEDIR
);
470 textdomain (PACKAGE
);
472 atexit (close_stdout
);
474 have_read_stdin
= false;
476 while ((c
= getopt_long (argc
, argv
, "h:b:f:v:i:pl:s:w:n:d:", longopts
,
482 if (! build_type_arg (&header_type
, &header_regex
, header_fastmap
))
484 error (0, 0, _("invalid header numbering style: %s"),
490 if (! build_type_arg (&body_type
, &body_regex
, body_fastmap
))
492 error (0, 0, _("invalid body numbering style: %s"),
498 if (! build_type_arg (&footer_type
, &footer_regex
, footer_fastmap
))
500 error (0, 0, _("invalid footer numbering style: %s"),
506 if (xstrtoimax (optarg
, NULL
, 10, &starting_line_number
, "")
509 error (0, 0, _("invalid starting line number: %s"),
514 case PAGE_INCREMENT_OPTION_DEPRECATED
:
515 error (0, 0, _("WARNING: --page-increment is deprecated; "
516 "use --line-increment instead"));
519 if (! (xstrtoimax (optarg
, NULL
, 10, &page_incr
, "") == LONGINT_OK
522 error (0, 0, _("invalid line number increment: %s"),
528 reset_numbers
= false;
531 if (! (xstrtoimax (optarg
, NULL
, 10, &blank_join
, "") == LONGINT_OK
534 error (0, 0, _("invalid number of blank lines: %s"),
540 separator_str
= optarg
;
545 if (xstrtol (optarg
, NULL
, 10, &tmp_long
, "") != LONGINT_OK
546 || tmp_long
<= 0 || tmp_long
> INT_MAX
)
548 error (0, 0, _("invalid line number field width: %s"),
554 lineno_width
= tmp_long
;
559 if (STREQ (optarg
, "ln"))
560 lineno_format
= FORMAT_LEFT
;
561 else if (STREQ (optarg
, "rn"))
562 lineno_format
= FORMAT_RIGHT_NOLZ
;
563 else if (STREQ (optarg
, "rz"))
564 lineno_format
= FORMAT_RIGHT_LZ
;
567 error (0, 0, _("invalid line numbering format: %s"),
573 section_del
= optarg
;
575 case_GETOPT_HELP_CHAR
;
576 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
584 usage (EXIT_FAILURE
);
586 /* Initialize the section delimiters. */
587 len
= strlen (section_del
);
589 header_del_len
= len
* 3;
590 header_del
= xmalloc (header_del_len
+ 1);
591 stpcpy (stpcpy (stpcpy (header_del
, section_del
), section_del
), section_del
);
593 body_del_len
= len
* 2;
594 body_del
= xmalloc (body_del_len
+ 1);
595 stpcpy (stpcpy (body_del
, section_del
), section_del
);
597 footer_del_len
= len
;
598 footer_del
= xmalloc (footer_del_len
+ 1);
599 stpcpy (footer_del
, section_del
);
601 /* Initialize the input buffer. */
602 initbuffer (&line_buf
);
604 /* Initialize the printf format for unnumbered lines. */
605 len
= strlen (separator_str
);
606 print_no_line_fmt
= xmalloc (lineno_width
+ len
+ 1);
607 memset (print_no_line_fmt
, ' ', lineno_width
+ len
);
608 print_no_line_fmt
[lineno_width
+ len
] = '\0';
610 line_no
= starting_line_number
;
611 current_type
= body_type
;
612 current_regex
= &body_regex
;
614 /* Main processing. */
619 for (; optind
< argc
; optind
++)
620 ok
&= nl_file (argv
[optind
]);
622 if (have_read_stdin
&& fclose (stdin
) == EOF
)
623 error (EXIT_FAILURE
, errno
, "-");
625 exit (ok
? EXIT_SUCCESS
: EXIT_FAILURE
);