usr.bin/nl/nl.c

   1 /*-
   2  * Copyright (c) 1999 The NetBSD Foundation, Inc.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to The NetBSD Foundation
   6  * by Klaus Klein.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *        This product includes software developed by the NetBSD
  19  *        Foundation, Inc. and its contributors.
  20  * 4. Neither the name of The NetBSD Foundation nor the names of its
  21  *    contributors may be used to endorse or promote products derived
  22  *    from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  25  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  26  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  27  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  28  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include <sys/cdefs.h>
  38 #ifndef lint
  39 __COPYRIGHT(
  40 "@(#) Copyright (c) 1999\
  41  The NetBSD Foundation, Inc.  All rights reserved.");
  42 __RCSID("$FreeBSD$");
  43 #endif
  44
  45 #include <sys/types.h>
  46
  47 #include <err.h>
  48 #include <errno.h>
  49 #include <limits.h>
  50 #include <locale.h>
  51 #include <regex.h>
  52 #include <stdio.h>
  53 #include <stdlib.h>
  54 #include <string.h>
  55 #include <unistd.h>
  56
  57 typedef enum {
  58         number_all,             /* number all lines */
  59         number_nonempty,        /* number non-empty lines */
  60         number_none,            /* no line numbering */
  61         number_regex            /* number lines matching regular expression */
  62 } numbering_type;
  63
  64 struct numbering_property {
  65         const char * const      name;           /* for diagnostics */
  66         numbering_type          type;           /* numbering type */
  67         regex_t                 expr;           /* for type == number_regex */
  68 };
  69
  70 /* line numbering formats */
  71 #define FORMAT_LN       "%-*d"  /* left justified, leading zeros suppressed */
  72 #define FORMAT_RN       "%*d"   /* right justified, leading zeros suppressed */
  73 #define FORMAT_RZ       "%0*d"  /* right justified, leading zeros kept */
  74
  75 #define FOOTER          0
  76 #define BODY            1
  77 #define HEADER          2
  78 #define NP_LAST         HEADER
  79
  80 static struct numbering_property numbering_properties[NP_LAST + 1] = {
  81         { "footer",     number_none     },
  82         { "body",       number_nonempty },
  83         { "header",     number_none     }
  84 };
  85
  86 #define max(a, b)       ((a) > (b) ? (a) : (b))
  87
  88 /*
  89  * Maximum number of characters required for a decimal representation of a
  90  * (signed) int; courtesy of tzcode.
  91  */
  92 #define INT_STRLEN_MAXIMUM \
  93         ((sizeof (int) * CHAR_BIT - 1) * 302 / 1000 + 2)
  94
  95 static void     filter(void);
  96 static void     parse_numbering(const char *, int);
  97 static void     usage(void);
  98
  99 /*
 100  * Pointer to dynamically allocated input line buffer, and its size.
 101  */
 102 static char *buffer;
 103 static size_t buffersize;
 104
 105 /*
 106  * Dynamically allocated buffer suitable for string representation of ints.
 107  */
 108 static char *intbuffer;
 109
 110 /*
 111  * Configurable parameters.
 112  */
 113 /* delimiter characters that indicate the start of a logical page section */
 114 static char delim[2] = { '\\', ':' };
 115
 116 /* line numbering format */
 117 static const char *format = FORMAT_RN;
 118
 119 /* increment value used to number logical page lines */
 120 static int incr = 1;
 121
 122 /* number of adjacent blank lines to be considered (and numbered) as one */
 123 static unsigned int nblank = 1;
 124
 125 /* whether to restart numbering at logical page delimiters */
 126 static int restart = 1;
 127
 128 /* characters used in separating the line number and the corrsp. text line */
 129 static const char *sep = "\t";
 130
 131 /* initial value used to number logical page lines */
 132 static int startnum = 1;
 133
 134 /* number of characters to be used for the line number */
 135 /* should be unsigned but required signed by `*' precision conversion */
 136 static int width = 6;
 137
 138
 139 int
 140 main(argc, argv)
 141         int argc;
 142         char *argv[];
 143 {
 144         int c;
 145         long val;
 146         unsigned long uval;
 147         char *ep;
 148         size_t intbuffersize;
 149
 150         (void)setlocale(LC_ALL, "");
 151
 152         while ((c = getopt(argc, argv, "pb:d:f:h:i:l:n:s:v:w:")) != -1) {
 153                 switch (c) {
 154                 case 'p':
 155                         restart = 0;
 156                         break;
 157                 case 'b':
 158                         parse_numbering(optarg, BODY);
 159                         break;
 160                 case 'd':
 161                         if (optarg[0] != '\0')
 162                                 delim[0] = optarg[0];
 163                         if (optarg[1] != '\0')
 164                                 delim[1] = optarg[1];
 165                         /* at most two delimiter characters */
 166                         if (optarg[2] != '\0') {
 167                                 errx(EXIT_FAILURE,
 168                                     "invalid delim argument -- %s",
 169                                     optarg);
 170                                 /* NOTREACHED */
 171                         }
 172                         break;
 173                 case 'f':
 174                         parse_numbering(optarg, FOOTER);
 175                         break;
 176                 case 'h':
 177                         parse_numbering(optarg, HEADER);
 178                         break;
 179                 case 'i':
 180                         errno = 0;
 181                         val = strtol(optarg, &ep, 10);
 182                         if ((ep != NULL && *ep != '\0') ||
 183                          ((val == LONG_MIN || val == LONG_MAX) && errno != 0))
 184                                 errx(EXIT_FAILURE,
 185                                     "invalid incr argument -- %s", optarg);
 186                         incr = (int)val;
 187                         break;
 188                 case 'l':
 189                         errno = 0;
 190                         uval = strtoul(optarg, &ep, 10);
 191                         if ((ep != NULL && *ep != '\0') ||
 192                             (uval == ULONG_MAX && errno != 0))
 193                                 errx(EXIT_FAILURE,
 194                                     "invalid num argument -- %s", optarg);
 195                         nblank = (unsigned int)uval;
 196                         break;
 197                 case 'n':
 198                         if (strcmp(optarg, "ln") == 0) {
 199                                 format = FORMAT_LN;
 200                         } else if (strcmp(optarg, "rn") == 0) {
 201                                 format = FORMAT_RN;
 202                         } else if (strcmp(optarg, "rz") == 0) {
 203                                 format = FORMAT_RZ;
 204                         } else
 205                                 errx(EXIT_FAILURE,
 206                                     "illegal format -- %s", optarg);
 207                         break;
 208                 case 's':
 209                         sep = optarg;
 210                         break;
 211                 case 'v':
 212                         errno = 0;
 213                         val = strtol(optarg, &ep, 10);
 214                         if ((ep != NULL && *ep != '\0') ||
 215                          ((val == LONG_MIN || val == LONG_MAX) && errno != 0))
 216                                 errx(EXIT_FAILURE,
 217                                     "invalid startnum value -- %s", optarg);
 218                         startnum = (int)val;
 219                         break;
 220                 case 'w':
 221                         errno = 0;
 222                         val = strtol(optarg, &ep, 10);
 223                         if ((ep != NULL && *ep != '\0') ||
 224                          ((val == LONG_MIN || val == LONG_MAX) && errno != 0))
 225                                 errx(EXIT_FAILURE,
 226                                     "invalid width value -- %s", optarg);
 227                         width = (int)val;
 228                         if (!(width > 0))
 229                                 errx(EXIT_FAILURE,
 230                                     "width argument must be > 0 -- %d",
 231                                     width);
 232                         break;
 233                 case '?':
 234                 default:
 235                         usage();
 236                         /* NOTREACHED */
 237                 }
 238         }
 239         argc -= optind;
 240         argv += optind;
 241
 242         switch (argc) {
 243         case 0:
 244                 break;
 245         case 1:
 246                 if (freopen(argv[0], "r", stdin) == NULL)
 247                         err(EXIT_FAILURE, "%s", argv[0]);
 248                 break;
 249         default:
 250                 usage();
 251                 /* NOTREACHED */
 252         }
 253
 254         /* Determine the maximum input line length to operate on. */
 255         if ((val = sysconf(_SC_LINE_MAX)) == -1) /* ignore errno */
 256                 val = LINE_MAX;
 257         /* Allocate sufficient buffer space (including the terminating NUL). */
 258         buffersize = (size_t)val + 1;
 259         if ((buffer = malloc(buffersize)) == NULL)
 260                 err(EXIT_FAILURE, "cannot allocate input line buffer");
 261
 262         /* Allocate a buffer suitable for preformatting line number. */
 263         intbuffersize = max(INT_STRLEN_MAXIMUM, width) + 1;     /* NUL */
 264         if ((intbuffer = malloc(intbuffersize)) == NULL)
 265                 err(EXIT_FAILURE, "cannot allocate preformatting buffer");
 266
 267         /* Do the work. */
 268         filter();
 269
 270         exit(EXIT_SUCCESS);
 271         /* NOTREACHED */
 272 }
 273
 274 static void
 275 filter()
 276 {
 277         int line;               /* logical line number */
 278         int section;            /* logical page section */
 279         unsigned int adjblank;  /* adjacent blank lines */
 280         int consumed;           /* intbuffer measurement */
 281         int donumber, idx;
 282
 283         adjblank = 0;
 284         line = startnum;
 285         section = BODY;
 286 #ifdef __GNUC__
 287         (void)&donumber;        /* avoid bogus `uninitialized' warning */
 288 #endif
 289
 290         while (fgets(buffer, (int)buffersize, stdin) != NULL) {
 291                 for (idx = FOOTER; idx <= NP_LAST; idx++) {
 292                         /* Does it look like a delimiter? */
 293                         if (buffer[2 * idx + 0] == delim[0] &&
 294                             buffer[2 * idx + 1] == delim[1]) {
 295                                 /* Was this the whole line? */
 296                                 if (buffer[2 * idx + 2] == '\n') {
 297                                         section = idx;
 298                                         adjblank = 0;
 299                                         if (restart)
 300                                                 line = startnum;
 301                                         goto nextline;
 302                                 }
 303                         } else {
 304                                 break;
 305                         }
 306                 }
 307
 308                 switch (numbering_properties[section].type) {
 309                 case number_all:
 310                         /*
 311                          * Doing this for number_all only is disputable, but
 312                          * the standard expresses an explicit dependency on
 313                          * `-b a' etc.
 314                          */
 315                         if (buffer[0] == '\n' && ++adjblank < nblank)
 316                                 donumber = 0;
 317                         else
 318                                 donumber = 1, adjblank = 0;
 319                         break;
 320                 case number_nonempty:
 321                         donumber = (buffer[0] != '\n');
 322                         break;
 323                 case number_none:
 324                         donumber = 0;
 325                         break;
 326                 case number_regex:
 327                         donumber =
 328                             (regexec(&numbering_properties[section].expr,
 329                             buffer, 0, NULL, 0) == 0);
 330                         break;
 331                 }
 332
 333                 if (donumber) {
 334                         /* Note: sprintf() is safe here. */
 335                         consumed = sprintf(intbuffer, format, width, line);
 336                         (void)printf("%s",
 337                             intbuffer + max(0, consumed - width));
 338                         line += incr;
 339                 } else {
 340                         (void)printf("%*s", width, "");
 341                 }
 342                 (void)printf("%s%s", sep, buffer);
 343
 344                 if (ferror(stdout))
 345                         err(EXIT_FAILURE, "output error");
 346 nextline:
 347                 ;
 348         }
 349
 350         if (ferror(stdin))
 351                 err(EXIT_FAILURE, "input error");
 352 }
 353
 354 /*
 355  * Various support functions.
 356  */
 357
 358 static void
 359 parse_numbering(argstr, section)
 360         const char *argstr;
 361         int section;
 362 {
 363         int error;
 364         char errorbuf[NL_TEXTMAX];
 365
 366         switch (argstr[0]) {
 367         case 'a':
 368                 numbering_properties[section].type = number_all;
 369                 break;
 370         case 'n':
 371                 numbering_properties[section].type = number_none;
 372                 break;
 373         case 't':
 374                 numbering_properties[section].type = number_nonempty;
 375                 break;
 376         case 'p':
 377                 /* If there was a previous expression, throw it away. */
 378                 if (numbering_properties[section].type == number_regex)
 379                         regfree(&numbering_properties[section].expr);
 380                 else
 381                         numbering_properties[section].type = number_regex;
 382
 383                 /* Compile/validate the supplied regular expression. */
 384                 if ((error = regcomp(&numbering_properties[section].expr,
 385                     &argstr[1], REG_NEWLINE|REG_NOSUB)) != 0) {
 386                         (void)regerror(error,
 387                             &numbering_properties[section].expr,
 388                             errorbuf, sizeof (errorbuf));
 389                         errx(EXIT_FAILURE,
 390                             "%s expr: %s -- %s",
 391                             numbering_properties[section].name, errorbuf,
 392                             &argstr[1]);
 393                 }
 394                 break;
 395         default:
 396                 errx(EXIT_FAILURE,
 397                     "illegal %s line numbering type -- %s",
 398                     numbering_properties[section].name, argstr);
 399         }
 400 }
 401
 402 static void
 403 usage()
 404 {
 405
 406         (void)fprintf(stderr, "usage: nl [-p] [-b type] [-d delim] [-f type] \
 407 [-h type] [-i incr] [-l num]\n\t[-n format] [-s sep] [-v startnum] [-w width] \
 408 [file]\n");
 409         exit(EXIT_FAILURE);
 410 }