src/nl.c

   1 /* nl -- number lines of files
   2    Copyright (C) 89, 92, 95, 1996 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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
  16    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17 \f
  18 /* Written by Scott Bartram (nancy!scott@uunet.uu.net)
  19    Revised by David MacKenzie (djm@gnu.ai.mit.edu) */
  20
  21 #include <config.h>
  22
  23 #include <stdio.h>
  24 #include <sys/types.h>
  25 #include <getopt.h>
  26
  27 #if HAVE_LIMITS_H
  28 # include <limits.h>
  29 #endif
  30
  31 #if WITH_REGEX
  32 # include <regex.h>
  33 #else
  34 # include <rx.h>
  35 #endif
  36
  37 #ifndef UINT_MAX
  38 # define UINT_MAX ((unsigned int) ~(unsigned int) 0)
  39 #endif
  40
  41 #ifndef INT_MAX
  42 # define INT_MAX ((int) (UINT_MAX >> 1))
  43 #endif
  44
  45 #include "linebuffer.h"
  46 #include "system.h"
  47 #include "error.h"
  48 #include "xstrtol.h"
  49
  50 #ifndef TRUE
  51 #define TRUE   1
  52 #define FALSE  0
  53 #endif
  54
  55 /* Line-number formats. */
  56 enum number_format
  57 {
  58   FORMAT_RIGHT_NOLZ,            /* Right justified, no leading zeroes.  */
  59   FORMAT_RIGHT_LZ,              /* Right justified, leading zeroes.  */
  60   FORMAT_LEFT                   /* Left justified, no leading zeroes.  */
  61 };
  62
  63 /* Default section delimiter characters.  */
  64 #define DEFAULT_SECTION_DELIMITERS  "\\:"
  65
  66 /* Types of input lines: either one of the section delimiters,
  67    or text to output. */
  68 enum section
  69 {
  70   Header, Body, Footer, Text
  71 };
  72
  73 char *xmalloc ();
  74 char *xrealloc ();
  75
  76 /* The name this program was run with. */
  77 char *program_name;
  78
  79 /* Format of body lines (-b).  */
  80 static char *body_type = "t";
  81
  82 /* Format of header lines (-h).  */
  83 static char *header_type = "n";
  84
  85 /* Format of footer lines (-f).  */
  86 static char *footer_type = "n";
  87
  88 /* Format currently being used (body, header, or footer).  */
  89 static char *current_type;
  90
  91 /* Regex for body lines to number (-bp).  */
  92 static struct re_pattern_buffer body_regex;
  93
  94 /* Regex for header lines to number (-hp).  */
  95 static struct re_pattern_buffer header_regex;
  96
  97 /* Regex for footer lines to number (-fp).  */
  98 static struct re_pattern_buffer footer_regex;
  99
 100 /* Pointer to current regex, if any.  */
 101 static struct re_pattern_buffer *current_regex = NULL;
 102
 103 /* Separator string to print after line number (-s).  */
 104 static char *separator_str = "\t";
 105
 106 /* Input section delimiter string (-d).  */
 107 static char *section_del = DEFAULT_SECTION_DELIMITERS;
 108
 109 /* Header delimiter string.  */
 110 static char *header_del = NULL;
 111
 112 /* Header section delimiter length.  */
 113 static int header_del_len;
 114
 115 /* Body delimiter string.  */
 116 static char *body_del = NULL;
 117
 118 /* Body section delimiter length.  */
 119 static int body_del_len;
 120
 121 /* Footer delimiter string.  */
 122 static char *footer_del = NULL;
 123
 124 /* Footer section delimiter length.  */
 125 static int footer_del_len;
 126
 127 /* Input buffer.  */
 128 static struct linebuffer line_buf;
 129
 130 /* printf format string for line number.  */
 131 static char *print_fmt;
 132
 133 /* printf format string for unnumbered lines.  */
 134 static char *print_no_line_fmt = NULL;
 135
 136 /* Starting line number on each page (-v).  */
 137 static int starting_line_number = 1;
 138
 139 /* Line number increment (-i).  */
 140 static int page_incr = 1;
 141
 142 /* If TRUE, reset line number at start of each page (-p).  */
 143 static int reset_numbers = TRUE;
 144
 145 /* Number of blank lines to consider to be one line for numbering (-l).  */
 146 static int blank_join = 1;
 147
 148 /* Width of line numbers (-w).  */
 149 static int lineno_width = 6;
 150
 151 /* Line number format (-n).  */
 152 static enum number_format lineno_format = FORMAT_RIGHT_NOLZ;
 153
 154 /* Current print line number.  */
 155 static int line_no;
 156
 157 /* Nonzero if we have ever read standard input. */
 158 static int have_read_stdin;
 159
 160 /* If nonzero, display usage information and exit.  */
 161 static int show_help;
 162
 163 /* If nonzero, print the version on standard output then exit.  */
 164 static int show_version;
 165
 166 static struct option const longopts[] =
 167 {
 168   {"header-numbering", required_argument, NULL, 'h'},
 169   {"body-numbering", required_argument, NULL, 'b'},
 170   {"footer-numbering", required_argument, NULL, 'f'},
 171   {"starting-line-number", required_argument, NULL, 'v'},
 172   {"page-increment", required_argument, NULL, 'i'},
 173   {"no-renumber", no_argument, NULL, 'p'},
 174   {"join-blank-lines", required_argument, NULL, 'l'},
 175   {"number-separator", required_argument, NULL, 's'},
 176   {"number-width", required_argument, NULL, 'w'},
 177   {"number-format", required_argument, NULL, 'n'},
 178   {"section-delimiter", required_argument, NULL, 'd'},
 179   {"help", no_argument, &show_help, 1},
 180   {"version", no_argument, &show_version, 1},
 181   {NULL, 0, NULL, 0}
 182 };
 183
 184 /* Print a usage message and quit. */
 185
 186 static void
 187 usage (int status)
 188 {
 189   if (status != 0)
 190     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 191              program_name);
 192   else
 193     {
 194       printf (_("\
 195 Usage: %s [OPTION]... [FILE]...\n\
 196 "),
 197               program_name);
 198       printf (_("\
 199 Write each FILE to standard output, with line numbers added.\n\
 200 With no FILE, or when FILE is -, read standard input.\n\
 201 \n\
 202   -b, --body-numbering=STYLE      use STYLE for numbering body lines\n\
 203   -d, --section-delimiter=CC      use CC for separating logical pages\n\
 204   -f, --footer-numbering=STYLE    use STYLE for numbering footer lines\n\
 205   -h, --header-numbering=STYLE    use STYLE for numbering header lines\n\
 206   -i, --page-increment=NUMBER     line number increment at each line\n\
 207   -l, --join-blank-lines=NUMBER   group of NUMBER empty lines counted as one\n\
 208   -n, --number-format=FORMAT      insert line numbers according to FORMAT\n\
 209   -p, --no-renumber               do not reset line numbers at logical pages\n\
 210   -s, --number-separator=STRING   add STRING after (possible) line number\n\
 211   -v, --first-page=NUMBER         first line number on each logical page\n\
 212   -w, --number-width=NUMBER       use NUMBER columns for line numbers\n\
 213       --help                      display this help and exit\n\
 214       --version                   output version information and exit\n\
 215 \n\
 216 By default, selects -v1 -i1 -l1 -sTAB -w6 -nrn -hn -bt -fn.  CC are\n\
 217 two delimiter characters for separating logical pages, a missing\n\
 218 second character implies :.  Type \\\\ for \\.  STYLE is one of:\n\
 219 \n\
 220   a         number all lines\n\
 221   t         number only nonempty lines\n\
 222   n         number no lines\n\
 223   pREGEXP   number only lines that contain a match for REGEXP\n\
 224 \n\
 225 FORMAT is one of:\n\
 226 \n\
 227   ln   left justified, no leading zeros\n\
 228   rn   right justified, no leading zeros\n\
 229   rz   right justified, leading zeros\n\
 230 \n\
 231 "));
 232       puts (_("\nReport bugs to textutils-bugs@gnu.ai.mit.edu"));
 233     }
 234   exit (status == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
 235 }
 236
 237 /* Build the printf format string, based on `lineno_format'. */
 238
 239 static void
 240 build_print_fmt (void)
 241 {
 242   /* 12 = 10 chars for lineno_width, 1 for %, 1 for \0.  */
 243   print_fmt = xmalloc (strlen (separator_str) + 12);
 244   switch (lineno_format)
 245     {
 246     case FORMAT_RIGHT_NOLZ:
 247       sprintf (print_fmt, "%%%dd%s", lineno_width, separator_str);
 248       break;
 249     case FORMAT_RIGHT_LZ:
 250       sprintf (print_fmt, "%%0%dd%s", lineno_width, separator_str);
 251       break;
 252     case FORMAT_LEFT:
 253       sprintf (print_fmt, "%%-%dd%s", lineno_width, separator_str);
 254       break;
 255     }
 256 }
 257
 258 /* Set the command line flag TYPEP and possibly the regex pointer REGEXP,
 259    according to `optarg'.  */
 260
 261 static int
 262 build_type_arg (char **typep, struct re_pattern_buffer *regexp)
 263 {
 264   const char *errmsg;
 265   int rval = TRUE;
 266   int optlen;
 267
 268   switch (*optarg)
 269     {
 270     case 'a':
 271     case 't':
 272     case 'n':
 273       *typep = optarg;
 274       break;
 275     case 'p':
 276       *typep = optarg++;
 277       optlen = strlen (optarg);
 278       regexp->allocated = optlen * 2;
 279       regexp->buffer = (unsigned char *) xmalloc (regexp->allocated);
 280       regexp->translate = NULL;
 281       regexp->fastmap = xmalloc (256);
 282       regexp->fastmap_accurate = 0;
 283       errmsg = re_compile_pattern (optarg, optlen, regexp);
 284       if (errmsg)
 285         error (EXIT_FAILURE, 0, "%s", errmsg);
 286       break;
 287     default:
 288       rval = FALSE;
 289       break;
 290     }
 291   return rval;
 292 }
 293
 294 /* Print and increment the line number. */
 295
 296 static void
 297 print_lineno (void)
 298 {
 299   printf (print_fmt, line_no);
 300   line_no += page_incr;
 301 }
 302
 303 /* Switch to a header section. */
 304
 305 static void
 306 proc_header (void)
 307 {
 308   current_type = header_type;
 309   current_regex = &header_regex;
 310   if (reset_numbers)
 311     line_no = starting_line_number;
 312   putchar ('\n');
 313 }
 314
 315 /* Switch to a body section. */
 316
 317 static void
 318 proc_body (void)
 319 {
 320   current_type = body_type;
 321   current_regex = &body_regex;
 322   putchar ('\n');
 323 }
 324
 325 /* Switch to a footer section. */
 326
 327 static void
 328 proc_footer (void)
 329 {
 330   current_type = footer_type;
 331   current_regex = &footer_regex;
 332   putchar ('\n');
 333 }
 334
 335 /* Process a regular text line in `line_buf'. */
 336
 337 static void
 338 proc_text (void)
 339 {
 340   static int blank_lines = 0;   /* Consecutive blank lines so far. */
 341
 342   switch (*current_type)
 343     {
 344     case 'a':
 345       if (blank_join > 1)
 346         {
 347           if (line_buf.length || ++blank_lines == blank_join)
 348             {
 349               print_lineno ();
 350               blank_lines = 0;
 351             }
 352           else
 353             printf (print_no_line_fmt);
 354         }
 355       else
 356         print_lineno ();
 357       break;
 358     case 't':
 359       if (line_buf.length)
 360         print_lineno ();
 361       else
 362         printf (print_no_line_fmt);
 363       break;
 364     case 'n':
 365       printf (print_no_line_fmt);
 366       break;
 367     case 'p':
 368       if (re_search (current_regex, line_buf.buffer, line_buf.length,
 369                      0, line_buf.length, (struct re_registers *) 0) < 0)
 370         printf (print_no_line_fmt);
 371       else
 372         print_lineno ();
 373       break;
 374     }
 375   fwrite (line_buf.buffer, sizeof (char), line_buf.length, stdout);
 376   putchar ('\n');
 377 }
 378
 379 /* Return the type of line in `line_buf'. */
 380
 381 static enum section
 382 check_section (void)
 383 {
 384   if (line_buf.length < 2 || memcmp (line_buf.buffer, section_del, 2))
 385     return Text;
 386   if (line_buf.length == header_del_len
 387       && !memcmp (line_buf.buffer, header_del, header_del_len))
 388     return Header;
 389   if (line_buf.length == body_del_len
 390       && !memcmp (line_buf.buffer, body_del, body_del_len))
 391     return Body;
 392   if (line_buf.length == footer_del_len
 393       && !memcmp (line_buf.buffer, footer_del, footer_del_len))
 394     return Footer;
 395   return Text;
 396 }
 397
 398 /* Read and process the file pointed to by FP. */
 399
 400 static void
 401 process_file (FILE *fp)
 402 {
 403   while (readline (&line_buf, fp))
 404     {
 405       switch ((int) check_section ())
 406         {
 407         case Header:
 408           proc_header ();
 409           break;
 410         case Body:
 411           proc_body ();
 412           break;
 413         case Footer:
 414           proc_footer ();
 415           break;
 416         case Text:
 417           proc_text ();
 418           break;
 419         }
 420     }
 421 }
 422
 423 /* Process file FILE to standard output.
 424    Return 0 if successful, 1 if not. */
 425
 426 static int
 427 nl_file (const char *file)
 428 {
 429   FILE *stream;
 430
 431   if (!strcmp (file, "-"))
 432     {
 433       have_read_stdin = 1;
 434       stream = stdin;
 435     }
 436   else
 437     {
 438       stream = fopen (file, "r");
 439       if (stream == NULL)
 440         {
 441           error (0, errno, "%s", file);
 442           return 1;
 443         }
 444     }
 445
 446   process_file (stream);
 447
 448   if (ferror (stream))
 449     {
 450       error (0, errno, "%s", file);
 451       return 1;
 452     }
 453   if (!strcmp (file, "-"))
 454     clearerr (stream);          /* Also clear EOF. */
 455   else if (fclose (stream) == EOF)
 456     {
 457       error (0, errno, "%s", file);
 458       return 1;
 459     }
 460   return 0;
 461 }
 462
 463 int
 464 main (int argc, char **argv)
 465 {
 466   int c, exit_status = 0;
 467
 468   program_name = argv[0];
 469   setlocale (LC_ALL, "");
 470   bindtextdomain (PACKAGE, LOCALEDIR);
 471   textdomain (PACKAGE);
 472
 473   have_read_stdin = 0;
 474
 475   while ((c = getopt_long (argc, argv, "h:b:f:v:i:pl:s:w:n:d:", longopts,
 476                            (int *) 0)) != EOF)
 477     {
 478       switch (c)
 479         {
 480         case 0:
 481           break;
 482
 483         case 'h':
 484           if (build_type_arg (&header_type, &header_regex) != TRUE)
 485             usage (2);
 486           break;
 487         case 'b':
 488           if (build_type_arg (&body_type, &body_regex) != TRUE)
 489             usage (2);
 490           break;
 491         case 'f':
 492           if (build_type_arg (&footer_type, &footer_regex) != TRUE)
 493             usage (2);
 494           break;
 495         case 'v':
 496           {
 497             long int tmp_long;
 498             if (xstrtol (optarg, NULL, 10, &tmp_long, NULL) != LONGINT_OK
 499                 /* Allow it to be negative.  */
 500                 || tmp_long > INT_MAX)
 501               error (EXIT_FAILURE, 0, _("invalid starting line number: `%s'"),
 502                      optarg);
 503             starting_line_number = (int) tmp_long;
 504           }
 505           break;
 506         case 'i':
 507           {
 508             long int tmp_long;
 509             if (xstrtol (optarg, NULL, 10, &tmp_long, NULL) != LONGINT_OK
 510                 || tmp_long <= 0 || tmp_long > INT_MAX)
 511               error (EXIT_FAILURE, 0, _("invalid line number increment: `%s'"),
 512                      optarg);
 513             page_incr = (int) tmp_long;
 514           }
 515           break;
 516         case 'p':
 517           reset_numbers = FALSE;
 518           break;
 519         case 'l':
 520           {
 521             long int tmp_long;
 522             if (xstrtol (optarg, NULL, 10, &tmp_long, NULL) != LONGINT_OK
 523                 || tmp_long <= 0 || tmp_long > INT_MAX)
 524               error (EXIT_FAILURE, 0, _("invalid number of blank lines: `%s'"),
 525                      optarg);
 526             blank_join = (int) tmp_long;
 527           }
 528           break;
 529         case 's':
 530           separator_str = optarg;
 531           break;
 532         case 'w':
 533           {
 534             long int tmp_long;
 535             if (xstrtol (optarg, NULL, 10, &tmp_long, NULL) != LONGINT_OK
 536                 || tmp_long <= 0 || tmp_long > INT_MAX)
 537               error (EXIT_FAILURE, 0,
 538                      _("invalid line number field width: `%s'"),
 539                      optarg);
 540             lineno_width = (int) tmp_long;
 541           }
 542           break;
 543         case 'n':
 544           switch (*optarg)
 545             {
 546             case 'l':
 547               if (optarg[1] == 'n')
 548                 lineno_format = FORMAT_LEFT;
 549               else
 550                 usage (2);
 551               break;
 552             case 'r':
 553               switch (optarg[1])
 554                 {
 555                 case 'n':
 556                   lineno_format = FORMAT_RIGHT_NOLZ;
 557                   break;
 558                 case 'z':
 559                   lineno_format = FORMAT_RIGHT_LZ;
 560                   break;
 561                 default:
 562                   usage (2);
 563                   break;
 564                 }
 565               break;
 566             default:
 567               usage (2);
 568               break;
 569             }
 570           break;
 571         case 'd':
 572           section_del = optarg;
 573           break;
 574         default:
 575           usage (2);
 576           break;
 577         }
 578     }
 579
 580   if (show_version)
 581     {
 582       printf ("nl (%s) %s\n", GNU_PACKAGE, VERSION);
 583       exit (EXIT_SUCCESS);
 584     }
 585
 586   if (show_help)
 587     usage (0);
 588
 589   /* Initialize the section delimiters.  */
 590   c = strlen (section_del);
 591
 592   header_del_len = c * 3;
 593   header_del = xmalloc (header_del_len + 1);
 594   strcat (strcat (strcpy (header_del, section_del), section_del), section_del);
 595
 596   body_del_len = c * 2;
 597   body_del = xmalloc (body_del_len + 1);
 598   strcat (strcpy (body_del, section_del), section_del);
 599
 600   footer_del_len = c;
 601   footer_del = xmalloc (footer_del_len + 1);
 602   strcpy (footer_del, section_del);
 603
 604   /* Initialize the input buffer.  */
 605   initbuffer (&line_buf);
 606
 607   /* Initialize the printf format for unnumbered lines. */
 608   c = strlen (separator_str);
 609   print_no_line_fmt = xmalloc (lineno_width + c + 1);
 610   memset (print_no_line_fmt, ' ', lineno_width + c);
 611   print_no_line_fmt[lineno_width + c] = '\0';
 612
 613   line_no = starting_line_number;
 614   current_type = body_type;
 615   current_regex = &body_regex;
 616   build_print_fmt ();
 617
 618   /* Main processing. */
 619
 620   if (optind == argc)
 621     exit_status |= nl_file ("-");
 622   else
 623     for (; optind < argc; optind++)
 624       exit_status |= nl_file (argv[optind]);
 625
 626   if (have_read_stdin && fclose (stdin) == EOF)
 627     {
 628       error (0, errno, "-");
 629       exit_status = 1;
 630     }
 631   if (ferror (stdout) || fclose (stdout) == EOF)
 632     error (EXIT_FAILURE, errno, _("write error"));
 633
 634   exit (exit_status == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
 635 }