2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 1999 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
32 #include <sys/types.h>
46 number_all, /* number all lines */
47 number_nonempty, /* number non-empty lines */
48 number_none, /* no line numbering */
49 number_regex /* number lines matching regular expression */
52 struct numbering_property {
53 const char * const name; /* for diagnostics */
54 numbering_type type; /* numbering type */
55 regex_t expr; /* for type == number_regex */
58 /* line numbering formats */
59 #define FORMAT_LN "%-*d" /* left justified, leading zeros suppressed */
60 #define FORMAT_RN "%*d" /* right justified, leading zeros suppressed */
61 #define FORMAT_RZ "%0*d" /* right justified, leading zeros kept */
66 #define NP_LAST HEADER
68 static struct numbering_property numbering_properties[NP_LAST + 1] = {
69 { .name = "footer", .type = number_none },
70 { .name = "body", .type = number_nonempty },
71 { .name = "header", .type = number_none }
74 #define max(a, b) ((a) > (b) ? (a) : (b))
77 * Maximum number of characters required for a decimal representation of a
78 * (signed) int; courtesy of tzcode.
80 #define INT_STRLEN_MAXIMUM \
81 ((sizeof (int) * CHAR_BIT - 1) * 302 / 1000 + 2)
83 static void filter(void);
84 static void parse_numbering(const char *, int);
85 static void usage(void);
88 * Dynamically allocated buffer suitable for string representation of ints.
90 static char *intbuffer;
92 /* delimiter characters that indicate the start of a logical page section */
93 static char delim[2 * MB_LEN_MAX];
97 * Configurable parameters.
100 /* line numbering format */
101 static const char *format = FORMAT_RN;
103 /* increment value used to number logical page lines */
106 /* number of adjacent blank lines to be considered (and numbered) as one */
107 static unsigned int nblank = 1;
109 /* whether to restart numbering at logical page delimiters */
110 static int restart = 1;
112 /* characters used in separating the line number and the corrsp. text line */
113 static const char *sep = "\t";
115 /* initial value used to number logical page lines */
116 static int startnum = 1;
118 /* number of characters to be used for the line number */
119 /* should be unsigned but required signed by `*' precision conversion */
120 static int width = 6;
124 main(int argc, char *argv[])
130 size_t intbuffersize, clen;
131 char delim1[MB_LEN_MAX] = { '\\' }, delim2[MB_LEN_MAX] = { ':' };
132 size_t delim1len = 1, delim2len = 1;
134 (void)setlocale(LC_ALL, "");
136 while ((c = getopt(argc, argv, "pb:d:f:h:i:l:n:s:v:w:")) != -1) {
142 parse_numbering(optarg, BODY);
145 clen = mbrlen(optarg, MB_CUR_MAX, NULL);
146 if (clen == (size_t)-1 || clen == (size_t)-2)
147 errc(EXIT_FAILURE, EILSEQ, NULL);
149 memcpy(delim1, optarg, delim1len = clen);
150 clen = mbrlen(optarg + delim1len,
152 if (clen == (size_t)-1 ||
154 errc(EXIT_FAILURE, EILSEQ, NULL);
156 memcpy(delim2, optarg + delim1len,
158 if (optarg[delim1len + clen] != '\0')
160 "invalid delim argument -- %s",
166 parse_numbering(optarg, FOOTER);
169 parse_numbering(optarg, HEADER);
173 val = strtol(optarg, &ep, 10);
174 if ((ep != NULL && *ep != '\0') ||
175 ((val == LONG_MIN || val == LONG_MAX) && errno != 0))
177 "invalid incr argument -- %s", optarg);
182 uval = strtoul(optarg, &ep, 10);
183 if ((ep != NULL && *ep != '\0') ||
184 (uval == ULONG_MAX && errno != 0))
186 "invalid num argument -- %s", optarg);
187 nblank = (unsigned int)uval;
190 if (strcmp(optarg, "ln") == 0) {
192 } else if (strcmp(optarg, "rn") == 0) {
194 } else if (strcmp(optarg, "rz") == 0) {
198 "illegal format -- %s", optarg);
205 val = strtol(optarg, &ep, 10);
206 if ((ep != NULL && *ep != '\0') ||
207 ((val == LONG_MIN || val == LONG_MAX) && errno != 0))
209 "invalid startnum value -- %s", optarg);
214 val = strtol(optarg, &ep, 10);
215 if ((ep != NULL && *ep != '\0') ||
216 ((val == LONG_MIN || val == LONG_MAX) && errno != 0))
218 "invalid width value -- %s", optarg);
222 "width argument must be > 0 -- %d",
238 if (strcmp(argv[0], "-") != 0 &&
239 freopen(argv[0], "r", stdin) == NULL)
240 err(EXIT_FAILURE, "%s", argv[0]);
247 /* Generate the delimiter sequence */
248 memcpy(delim, delim1, delim1len);
249 memcpy(delim + delim1len, delim2, delim2len);
250 delimlen = delim1len + delim2len;
252 /* Allocate a buffer suitable for preformatting line number. */
253 intbuffersize = max((int)INT_STRLEN_MAXIMUM, width) + 1; /* NUL */
254 if ((intbuffer = malloc(intbuffersize)) == NULL)
255 err(EXIT_FAILURE, "cannot allocate preformatting buffer");
270 int line; /* logical line number */
271 int section; /* logical page section */
272 unsigned int adjblank; /* adjacent blank lines */
273 int consumed; /* intbuffer measurement */
274 int donumber = 0, idx;
282 while ((linelen = getline(&buffer, &buffersize, stdin)) > 0) {
283 for (idx = FOOTER; idx <= NP_LAST; idx++) {
284 /* Does it look like a delimiter? */
285 if (delimlen * (idx + 1) > linelen)
287 if (memcmp(buffer + delimlen * idx, delim,
290 /* Was this the whole line? */
291 if (buffer[delimlen * (idx + 1)] == '\n') {
300 switch (numbering_properties[section].type) {
303 * Doing this for number_all only is disputable, but
304 * the standard expresses an explicit dependency on
307 if (buffer[0] == '\n' && ++adjblank < nblank)
310 donumber = 1, adjblank = 0;
312 case number_nonempty:
313 donumber = (buffer[0] != '\n');
320 (regexec(&numbering_properties[section].expr,
321 buffer, 0, NULL, 0) == 0);
326 /* Note: sprintf() is safe here. */
327 consumed = sprintf(intbuffer, format, width, line);
329 intbuffer + max(0, consumed - width));
332 (void)printf("%*s", width, "");
334 (void)fputs(sep, stdout);
335 (void)fwrite(buffer, linelen, 1, stdout);
338 err(EXIT_FAILURE, "output error");
344 err(EXIT_FAILURE, "input error");
350 * Various support functions.
354 parse_numbering(const char *argstr, int section)
357 char errorbuf[NL_TEXTMAX];
361 numbering_properties[section].type = number_all;
364 numbering_properties[section].type = number_none;
367 numbering_properties[section].type = number_nonempty;
370 /* If there was a previous expression, throw it away. */
371 if (numbering_properties[section].type == number_regex)
372 regfree(&numbering_properties[section].expr);
374 numbering_properties[section].type = number_regex;
376 /* Compile/validate the supplied regular expression. */
377 if ((error = regcomp(&numbering_properties[section].expr,
378 &argstr[1], REG_NEWLINE|REG_NOSUB)) != 0) {
379 (void)regerror(error,
380 &numbering_properties[section].expr,
381 errorbuf, sizeof (errorbuf));
384 numbering_properties[section].name, errorbuf,
390 "illegal %s line numbering type -- %s",
391 numbering_properties[section].name, argstr);
399 (void)fprintf(stderr,
400 "usage: nl [-p] [-b type] [-d delim] [-f type] [-h type] [-i incr] [-l num]\n"
401 " [-n format] [-s sep] [-v startnum] [-w width] [file]\n");