1 /* nl -- number lines of files
2 Copyright (C) 89, 92, 1995-2008 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;
147 static struct option const longopts[] =
149 {"header-numbering", required_argument, NULL, 'h'},
150 {"body-numbering", required_argument, NULL, 'b'},
151 {"footer-numbering", required_argument, NULL, 'f'},
152 {"starting-line-number", required_argument, NULL, 'v'},
153 {"page-increment", required_argument, NULL, 'i'},
154 {"no-renumber", no_argument, NULL, 'p'},
155 {"join-blank-lines", required_argument, NULL, 'l'},
156 {"number-separator", required_argument, NULL, 's'},
157 {"number-width", required_argument, NULL, 'w'},
158 {"number-format", required_argument, NULL, 'n'},
159 {"section-delimiter", required_argument, NULL, 'd'},
160 {GETOPT_HELP_OPTION_DECL},
161 {GETOPT_VERSION_OPTION_DECL},
165 /* Print a usage message and quit. */
170 if (status != EXIT_SUCCESS)
171 fprintf (stderr, _("Try `%s --help' for more information.\n"),
176 Usage: %s [OPTION]... [FILE]...\n\
180 Write each FILE to standard output, with line numbers added.\n\
181 With no FILE, or when FILE is -, read standard input.\n\
185 Mandatory arguments to long options are mandatory for short options too.\n\
188 -b, --body-numbering=STYLE use STYLE for numbering body lines\n\
189 -d, --section-delimiter=CC use CC for separating logical pages\n\
190 -f, --footer-numbering=STYLE use STYLE for numbering footer lines\n\
193 -h, --header-numbering=STYLE use STYLE for numbering header lines\n\
194 -i, --page-increment=NUMBER line number increment at each line\n\
195 -l, --join-blank-lines=NUMBER group of NUMBER empty lines counted as one\n\
196 -n, --number-format=FORMAT insert line numbers according to FORMAT\n\
197 -p, --no-renumber do not reset line numbers at logical pages\n\
198 -s, --number-separator=STRING add STRING after (possible) line number\n\
201 -v, --first-page=NUMBER first line number on each logical page\n\
202 -w, --number-width=NUMBER use NUMBER columns for line numbers\n\
204 fputs (HELP_OPTION_DESCRIPTION, stdout);
205 fputs (VERSION_OPTION_DESCRIPTION, stdout);
208 By default, selects -v1 -i1 -l1 -sTAB -w6 -nrn -hn -bt -fn. CC are\n\
209 two delimiter characters for separating logical pages, a missing\n\
210 second character implies :. Type \\\\ for \\. STYLE is one of:\n\
214 a number all lines\n\
215 t number only nonempty lines\n\
217 pBRE number only lines that contain a match for the basic regular\n\
222 ln left justified, no leading zeros\n\
223 rn right justified, no leading zeros\n\
224 rz right justified, leading zeros\n\
227 emit_bug_reporting_address ();
232 /* Set the command line flag TYPEP and possibly the regex pointer REGEXP,
233 according to `optarg'. */
236 build_type_arg (char const **typep,
237 struct re_pattern_buffer *regexp, char *fastmap)
251 regexp->buffer = NULL;
252 regexp->allocated = 0;
253 regexp->fastmap = fastmap;
254 regexp->translate = NULL;
256 RE_SYNTAX_POSIX_BASIC & ~RE_CONTEXT_INVALID_DUP & ~RE_NO_EMPTY_RANGES;
257 errmsg = re_compile_pattern (optarg, strlen (optarg), regexp);
259 error (EXIT_FAILURE, 0, "%s", errmsg);
268 /* Print the line number and separator; increment the line number. */
273 intmax_t next_line_no;
275 printf (lineno_format, lineno_width, line_no, separator_str);
277 next_line_no = line_no + page_incr;
278 if (next_line_no < line_no)
279 error (EXIT_FAILURE, 0, _("line number overflow"));
280 line_no = next_line_no;
283 /* Switch to a header section. */
288 current_type = header_type;
289 current_regex = &header_regex;
291 line_no = starting_line_number;
295 /* Switch to a body section. */
300 current_type = body_type;
301 current_regex = &body_regex;
305 /* Switch to a footer section. */
310 current_type = footer_type;
311 current_regex = &footer_regex;
315 /* Process a regular text line in `line_buf'. */
320 static intmax_t blank_lines = 0; /* Consecutive blank lines so far. */
322 switch (*current_type)
327 if (1 < line_buf.length || ++blank_lines == blank_join)
333 fputs (print_no_line_fmt, stdout);
339 if (1 < line_buf.length)
342 fputs (print_no_line_fmt, stdout);
345 fputs (print_no_line_fmt, stdout);
348 switch (re_search (current_regex, line_buf.buffer, line_buf.length - 1,
349 0, line_buf.length - 1, NULL))
352 error (EXIT_FAILURE, errno, _("error in regular expression search"));
355 fputs (print_no_line_fmt, stdout);
363 fwrite (line_buf.buffer, sizeof (char), line_buf.length, stdout);
366 /* Return the type of line in `line_buf'. */
371 size_t len = line_buf.length - 1;
373 if (len < 2 || memcmp (line_buf.buffer, section_del, 2))
375 if (len == header_del_len
376 && !memcmp (line_buf.buffer, header_del, header_del_len))
378 if (len == body_del_len
379 && !memcmp (line_buf.buffer, body_del, body_del_len))
381 if (len == footer_del_len
382 && !memcmp (line_buf.buffer, footer_del, footer_del_len))
387 /* Read and process the file pointed to by FP. */
390 process_file (FILE *fp)
392 while (readlinebuffer (&line_buf, fp))
394 switch (check_section ())
412 /* Process file FILE to standard output.
413 Return true if successful. */
416 nl_file (char const *file)
420 if (STREQ (file, "-"))
422 have_read_stdin = true;
427 stream = fopen (file, "r");
430 error (0, errno, "%s", file);
435 process_file (stream);
439 error (0, errno, "%s", file);
442 if (STREQ (file, "-"))
443 clearerr (stream); /* Also clear EOF. */
444 else if (fclose (stream) == EOF)
446 error (0, errno, "%s", file);
453 main (int argc, char **argv)
459 initialize_main (&argc, &argv);
460 set_program_name (argv[0]);
461 setlocale (LC_ALL, "");
462 bindtextdomain (PACKAGE, LOCALEDIR);
463 textdomain (PACKAGE);
465 atexit (close_stdout);
467 have_read_stdin = false;
469 while ((c = getopt_long (argc, argv, "h:b:f:v:i:pl:s:w:n:d:", longopts,
475 if (! build_type_arg (&header_type, &header_regex, header_fastmap))
477 error (0, 0, _("invalid header numbering style: %s"),
483 if (! build_type_arg (&body_type, &body_regex, body_fastmap))
485 error (0, 0, _("invalid body numbering style: %s"),
491 if (! build_type_arg (&footer_type, &footer_regex, footer_fastmap))
493 error (0, 0, _("invalid footer numbering style: %s"),
499 if (xstrtoimax (optarg, NULL, 10, &starting_line_number, "")
502 error (0, 0, _("invalid starting line number: %s"),
508 if (! (xstrtoimax (optarg, NULL, 10, &page_incr, "") == LONGINT_OK
511 error (0, 0, _("invalid line number increment: %s"),
517 reset_numbers = false;
520 if (! (xstrtoimax (optarg, NULL, 10, &blank_join, "") == LONGINT_OK
523 error (0, 0, _("invalid number of blank lines: %s"),
529 separator_str = optarg;
534 if (xstrtol (optarg, NULL, 10, &tmp_long, "") != LONGINT_OK
535 || tmp_long <= 0 || tmp_long > INT_MAX)
537 error (0, 0, _("invalid line number field width: %s"),
543 lineno_width = tmp_long;
548 if (STREQ (optarg, "ln"))
549 lineno_format = FORMAT_LEFT;
550 else if (STREQ (optarg, "rn"))
551 lineno_format = FORMAT_RIGHT_NOLZ;
552 else if (STREQ (optarg, "rz"))
553 lineno_format = FORMAT_RIGHT_LZ;
556 error (0, 0, _("invalid line numbering format: %s"),
562 section_del = optarg;
564 case_GETOPT_HELP_CHAR;
565 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
573 usage (EXIT_FAILURE);
575 /* Initialize the section delimiters. */
576 len = strlen (section_del);
578 header_del_len = len * 3;
579 header_del = xmalloc (header_del_len + 1);
580 strcat (strcat (strcpy (header_del, section_del), section_del), section_del);
582 body_del_len = len * 2;
583 body_del = xmalloc (body_del_len + 1);
584 strcat (strcpy (body_del, section_del), section_del);
586 footer_del_len = len;
587 footer_del = xmalloc (footer_del_len + 1);
588 strcpy (footer_del, section_del);
590 /* Initialize the input buffer. */
591 initbuffer (&line_buf);
593 /* Initialize the printf format for unnumbered lines. */
594 len = strlen (separator_str);
595 print_no_line_fmt = xmalloc (lineno_width + len + 1);
596 memset (print_no_line_fmt, ' ', lineno_width + len);
597 print_no_line_fmt[lineno_width + len] = '\0';
599 line_no = starting_line_number;
600 current_type = body_type;
601 current_regex = &body_regex;
603 /* Main processing. */
608 for (; optind < argc; optind++)
609 ok &= nl_file (argv[optind]);
611 if (have_read_stdin && fclose (stdin) == EOF)
612 error (EXIT_FAILURE, errno, "-");
614 exit (ok ? EXIT_SUCCESS : EXIT_FAILURE);