1 /* seq - print sequence of numbers to standard output.
2 Copyright (C) 1994-2023 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 <https://www.gnu.org/licenses/>. */
17 /* Written by Ulrich Drepper. */
22 #include <sys/types.h>
26 #include "cl-strtod.h"
31 /* Roll our own isfinite/isnan rather than using <math.h>, so that we don't
32 have to worry about linking -lm just for isfinite. */
34 # define isfinite(x) ((x) * 0 == 0)
37 # define isnan(x) ((x) != (x))
40 /* Limit below which seq_fast has more throughput.
41 Determined with: seq 0 200 inf | pv > /dev/null */
42 #define SEQ_FAST_STEP_LIMIT 200 /* Keep in sync with texinfo description. */
43 #define SEQ_FAST_STEP_LIMIT_DIGITS 3
45 /* The official name of this program (e.g., no 'g' prefix). */
46 #define PROGRAM_NAME "seq"
48 #define AUTHORS proper_name ("Ulrich Drepper")
50 /* True if the locale settings were honored. */
51 static bool locale_ok
;
53 /* If true print all number with equal width. */
54 static bool equal_width
;
56 /* The string used to separate two numbers. */
57 static char const *separator
;
59 /* The string output after all numbers have been output.
60 Usually "\n" or "\0". */
61 static char const terminator
[] = "\n";
63 static struct option
const long_options
[] =
65 { "equal-width", no_argument
, nullptr, 'w'},
66 { "format", required_argument
, nullptr, 'f'},
67 { "separator", required_argument
, nullptr, 's'},
68 {GETOPT_HELP_OPTION_DECL
},
69 {GETOPT_VERSION_OPTION_DECL
},
70 { nullptr, 0, nullptr, 0}
76 if (status
!= EXIT_SUCCESS
)
81 Usage: %s [OPTION]... LAST\n\
82 or: %s [OPTION]... FIRST LAST\n\
83 or: %s [OPTION]... FIRST INCREMENT LAST\n\
84 "), program_name
, program_name
, program_name
);
86 Print numbers from FIRST to LAST, in steps of INCREMENT.\n\
89 emit_mandatory_arg_note ();
92 -f, --format=FORMAT use printf style floating-point FORMAT\n\
93 -s, --separator=STRING use STRING to separate numbers (default: \\n)\n\
94 -w, --equal-width equalize width by padding with leading zeroes\n\
96 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
97 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
100 If FIRST or INCREMENT is omitted, it defaults to 1. That is, an\n\
101 omitted INCREMENT defaults to 1 even when LAST is smaller than FIRST.\n\
102 The sequence of numbers ends when the sum of the current number and\n\
103 INCREMENT would become greater than LAST.\n\
104 FIRST, INCREMENT, and LAST are interpreted as floating point values.\n\
105 INCREMENT is usually positive if FIRST is smaller than LAST, and\n\
106 INCREMENT is usually negative if FIRST is greater than LAST.\n\
107 INCREMENT must not be 0; none of FIRST, INCREMENT and LAST may be NaN.\n\
110 FORMAT must be suitable for printing one argument of type 'double';\n\
111 it defaults to %.PRECf if FIRST, INCREMENT, and LAST are all fixed point\n\
112 decimal numbers with maximum precision PREC, and to %g otherwise.\n\
114 emit_ancillary_info (PROGRAM_NAME
);
119 /* A command-line operand. */
122 /* Its value, converted to 'long double'. */
125 /* Its print width, if it were printed out in a form similar to its
126 input form. An input like "-.1" is treated like "-0.1", and an
127 input like "1." is treated like "1", but otherwise widths are
131 /* Number of digits after the decimal point, or INT_MAX if the
132 number can't easily be expressed as a fixed-point number. */
135 typedef struct operand operand
;
137 /* Description of what a number-generating format will generate. */
140 /* Number of bytes before and after the number. */
145 /* Read a long double value from the command line.
146 Return if the string is correct else signal error. */
149 scan_arg (char const *arg
)
153 if (! xstrtold (arg
, nullptr, &ret
.value
, cl_strtold
))
155 error (0, 0, _("invalid floating point argument: %s"), quote (arg
));
156 usage (EXIT_FAILURE
);
159 if (isnan (ret
.value
))
161 error (0, 0, _("invalid %s argument: %s"), quote_n (0, "not-a-number"),
163 usage (EXIT_FAILURE
);
166 /* We don't output spaces or '+' so don't include in width */
167 while (isspace (to_uchar (*arg
)) || *arg
== '+')
170 /* Default to auto width and precision. */
172 ret
.precision
= INT_MAX
;
174 /* Use no precision (and possibly fast generation) for integers. */
175 char const *decimal_point
= strchr (arg
, '.');
176 if (! decimal_point
&& ! strchr (arg
, 'p') /* not a hex float */)
179 /* auto set width and precision for decimal inputs. */
180 if (! arg
[strcspn (arg
, "xX")] && isfinite (ret
.value
))
182 size_t fraction_len
= 0;
183 ret
.width
= strlen (arg
);
187 fraction_len
= strcspn (decimal_point
+ 1, "eE");
188 if (fraction_len
<= INT_MAX
)
189 ret
.precision
= fraction_len
;
190 ret
.width
+= (fraction_len
== 0 /* #. -> # */
192 : (decimal_point
== arg
/* .# -> 0.# */
193 || ! ISDIGIT (decimal_point
[-1]))); /* -.# -> 0.# */
195 char const *e
= strchr (arg
, 'e');
197 e
= strchr (arg
, 'E');
200 long exponent
= MAX (strtol (e
+ 1, nullptr, 10), -LONG_MAX
);
201 ret
.precision
+= exponent
< 0 ? -exponent
202 : - MIN (ret
.precision
, exponent
);
203 /* Don't account for e.... in the width since this is not output. */
204 ret
.width
-= strlen (arg
) - (e
- arg
);
205 /* Adjust the width as per the exponent. */
210 if (e
== decimal_point
+ 1) /* undo #. -> # above */
215 exponent
= -exponent
;
219 if (decimal_point
&& ret
.precision
== 0 && fraction_len
)
220 ret
.width
--; /* discount space for '.' */
221 exponent
-= MIN (fraction_len
, exponent
);
223 ret
.width
+= exponent
;
230 /* If FORMAT is a valid printf format for a double argument, return
231 its long double equivalent, allocated from dynamic storage, and
232 store into *LAYOUT a description of the output layout; otherwise,
233 report an error and exit. */
236 long_double_format (char const *fmt
, struct layout
*layout
)
239 size_t prefix_len
= 0;
240 size_t suffix_len
= 0;
241 size_t length_modifier_offset
;
244 for (i
= 0; ! (fmt
[i
] == '%' && fmt
[i
+ 1] != '%'); i
+= (fmt
[i
] == '%') + 1)
247 die (EXIT_FAILURE
, 0,
248 _("format %s has no %% directive"), quote (fmt
));
253 i
+= strspn (fmt
+ i
, "-+#0 '");
254 i
+= strspn (fmt
+ i
, "0123456789");
258 i
+= strspn (fmt
+ i
, "0123456789");
261 length_modifier_offset
= i
;
262 has_L
= (fmt
[i
] == 'L');
265 die (EXIT_FAILURE
, 0, _("format %s ends in %%"), quote (fmt
));
266 if (! strchr ("efgaEFGA", fmt
[i
]))
267 die (EXIT_FAILURE
, 0,
268 _("format %s has unknown %%%c directive"), quote (fmt
), fmt
[i
]);
270 for (i
++; ; i
+= (fmt
[i
] == '%') + 1)
271 if (fmt
[i
] == '%' && fmt
[i
+ 1] != '%')
272 die (EXIT_FAILURE
, 0, _("format %s has too many %% directives"),
278 size_t format_size
= i
+ 1;
279 char *ldfmt
= xmalloc (format_size
+ 1);
280 memcpy (ldfmt
, fmt
, length_modifier_offset
);
281 ldfmt
[length_modifier_offset
] = 'L';
282 strcpy (ldfmt
+ length_modifier_offset
+ 1,
283 fmt
+ length_modifier_offset
+ has_L
);
284 layout
->prefix_len
= prefix_len
;
285 layout
->suffix_len
= suffix_len
;
293 /* FIXME: consider option to silently ignore errno=EPIPE */
295 die (EXIT_FAILURE
, errno
, _("write error"));
298 /* Actually print the sequence of numbers in the specified range, with the
299 given or default stepping and format. */
302 print_numbers (char const *fmt
, struct layout layout
,
303 long double first
, long double step
, long double last
)
305 bool out_of_range
= (step
< 0 ? first
< last
: last
< first
);
309 long double x
= first
;
315 if (printf (fmt
, x
) < 0)
319 x
= first
+ i
* step
;
320 out_of_range
= (step
< 0 ? x
< last
: last
< x
);
324 /* If the number just past LAST prints as a value equal
325 to LAST, and prints differently from the previous
326 number, then print the number. This avoids problems
327 with rounding. For example, with the x86 it causes
328 "seq 0 0.000001 0.000003" to print 0.000003 instead
329 of stopping at 0.000002. */
331 bool print_extra_number
= false;
336 setlocale (LC_NUMERIC
, "C");
337 x_strlen
= asprintf (&x_str
, fmt
, x
);
339 setlocale (LC_NUMERIC
, "");
342 x_str
[x_strlen
- layout
.suffix_len
] = '\0';
344 if (xstrtold (x_str
+ layout
.prefix_len
, nullptr,
348 char *x0_str
= nullptr;
349 int x0_strlen
= asprintf (&x0_str
, fmt
, x0
);
352 x0_str
[x0_strlen
- layout
.suffix_len
] = '\0';
353 print_extra_number
= !STREQ (x0_str
, x_str
);
358 if (! print_extra_number
)
362 if (fputs (separator
, stdout
) == EOF
)
366 if (fputs (terminator
, stdout
) == EOF
)
371 /* Return the default format given FIRST, STEP, and LAST. */
373 get_default_format (operand first
, operand step
, operand last
)
375 static char format_buf
[sizeof "%0.Lf" + 2 * INT_STRLEN_BOUND (int)];
377 int prec
= MAX (first
.precision
, step
.precision
);
379 if (prec
!= INT_MAX
&& last
.precision
!= INT_MAX
)
383 /* increase first_width by any increased precision in step */
384 size_t first_width
= first
.width
+ (prec
- first
.precision
);
385 /* adjust last_width to use precision from first/step */
386 size_t last_width
= last
.width
+ (prec
- last
.precision
);
387 if (last
.precision
&& prec
== 0)
388 last_width
--; /* don't include space for '.' */
389 if (last
.precision
== 0 && prec
)
390 last_width
++; /* include space for '.' */
391 if (first
.precision
== 0 && prec
)
392 first_width
++; /* include space for '.' */
393 size_t width
= MAX (first_width
, last_width
);
394 if (width
<= INT_MAX
)
397 sprintf (format_buf
, "%%0%d.%dLf", w
, prec
);
403 sprintf (format_buf
, "%%.%dLf", prec
);
411 /* The NUL-terminated string S0 of length S_LEN represents a valid
412 non-negative decimal integer. Adjust the string and length so
413 that the pair describe the next-larger value. */
415 incr (char **s0
, size_t *s_len
)
418 char *endp
= s
+ *s_len
- 1;
431 /* Compare A and B (each a NUL-terminated digit string), with lengths
432 given by A_LEN and B_LEN. Return +1 if A < B, -1 if B < A, else 0. */
434 cmp (char const *a
, size_t a_len
, char const *b
, size_t b_len
)
440 return (memcmp (a
, b
, a_len
));
443 /* Trim leading 0's from S, but if S is all 0's, leave one.
444 Return a pointer to the trimmed string. */
447 trim_leading_zeros (char const *s
)
453 /* If there were only 0's, back up, to leave one. */
459 /* Print all whole numbers from A to B, inclusive -- to stdout, each
460 followed by a newline. If B < A, return and print nothing.
461 Otherwise, do all the work and exit. */
463 seq_fast (char const *a
, char const *b
, uintmax_t step
)
465 bool inf
= STREQ (b
, "inf");
467 /* Skip past any leading 0's. Without this, our naive cmp
468 function would declare 000 to be larger than 99. */
469 a
= trim_leading_zeros (a
);
470 b
= trim_leading_zeros (b
);
472 size_t p_len
= strlen (a
);
473 size_t q_len
= inf
? 0 : strlen (b
);
475 /* Allow for at least 31 digits without realloc.
476 1 more than p_len is needed for the inf case. */
477 #define INITIAL_ALLOC_DIGITS 31
478 size_t inc_size
= MAX (MAX (p_len
+ 1, q_len
), INITIAL_ALLOC_DIGITS
);
479 /* Ensure we only increase by at most 1 digit at buffer boundaries. */
480 static_assert (SEQ_FAST_STEP_LIMIT_DIGITS
< INITIAL_ALLOC_DIGITS
- 1);
482 /* Copy input strings (incl NUL) to end of new buffers. */
483 char *p0
= xmalloc (inc_size
+ 1);
484 char *p
= memcpy (p0
+ inc_size
- p_len
, a
, p_len
+ 1);
489 q0
= xmalloc (inc_size
+ 1);
490 q
= memcpy (q0
+ inc_size
- q_len
, b
, q_len
+ 1);
495 bool ok
= inf
|| cmp (p
, p_len
, q
, q_len
) <= 0;
498 /* Reduce number of fwrite calls which is seen to
499 give a speed-up of more than 2x over the unbuffered code
500 when printing the first 10^9 integers. */
501 size_t buf_size
= MAX (BUFSIZ
, (inc_size
+ 1) * 2);
502 char *buf
= xmalloc (buf_size
);
503 char const *buf_end
= buf
+ buf_size
;
507 /* Write first number to buffer. */
508 bufp
= mempcpy (bufp
, p
, p_len
);
510 /* Append separator then number. */
513 for (uintmax_t n_incr
= step
; n_incr
; n_incr
--)
516 if (! inf
&& 0 < cmp (p
, p_len
, q
, q_len
))
519 *bufp
++ = *separator
;
521 /* Double up the buffers when needed for the inf case. */
522 if (p_len
== inc_size
)
525 p0
= xrealloc (p0
, inc_size
+ 1);
526 p
= memmove (p0
+ p_len
, p0
, p_len
+ 1);
528 if (buf_size
< (inc_size
+ 1) * 2)
530 size_t buf_offset
= bufp
- buf
;
531 buf_size
= (inc_size
+ 1) * 2;
532 buf
= xrealloc (buf
, buf_size
);
533 buf_end
= buf
+ buf_size
;
534 bufp
= buf
+ buf_offset
;
538 bufp
= mempcpy (bufp
, p
, p_len
);
539 /* If no place for another separator + number then
540 output buffer so far, and reset to start of buffer. */
541 if (buf_end
- (p_len
+ 1) < bufp
)
543 if (fwrite (buf
, bufp
- buf
, 1, stdout
) != 1)
549 /* Write any remaining buffered output, and the terminator. */
550 *bufp
++ = *terminator
;
551 if (fwrite (buf
, bufp
- buf
, 1, stdout
) != 1)
562 /* Return true if S consists of at least one digit and no non-digits. */
565 all_digits_p (char const *s
)
567 size_t n
= strlen (s
);
568 return ISDIGIT (s
[0]) && n
== strspn (s
, "0123456789");
572 main (int argc
, char **argv
)
575 operand first
= { 1, 1, 0 };
576 operand step
= { 1, 1, 0 };
578 struct layout layout
= { 0, 0 };
580 /* The printf(3) format used for output. */
581 char const *format_str
= nullptr;
583 initialize_main (&argc
, &argv
);
584 set_program_name (argv
[0]);
585 locale_ok
= !!setlocale (LC_ALL
, "");
586 bindtextdomain (PACKAGE
, LOCALEDIR
);
587 textdomain (PACKAGE
);
589 atexit (close_stdout
);
594 /* We have to handle negative numbers in the command line but this
595 conflicts with the command line arguments. So explicitly check first
596 whether the next argument looks like a negative number. */
597 while (optind
< argc
)
599 if (argv
[optind
][0] == '-'
600 && ((optc
= argv
[optind
][1]) == '.' || ISDIGIT (optc
)))
602 /* means negative number */
606 optc
= getopt_long (argc
, argv
, "+f:s:w", long_options
, nullptr);
624 case_GETOPT_HELP_CHAR
;
626 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
629 usage (EXIT_FAILURE
);
633 unsigned int n_args
= argc
- optind
;
636 error (0, 0, _("missing operand"));
637 usage (EXIT_FAILURE
);
642 error (0, 0, _("extra operand %s"), quote (argv
[optind
+ 3]));
643 usage (EXIT_FAILURE
);
647 format_str
= long_double_format (format_str
, &layout
);
649 if (format_str
!= nullptr && equal_width
)
651 error (0, 0, _("format string may not be specified"
652 " when printing equal width strings"));
653 usage (EXIT_FAILURE
);
656 /* If the following hold:
657 - no format string, [FIXME: relax this, eventually]
658 - integer start (or no start)
660 - integer increment <= SEQ_FAST_STEP_LIMIT
661 then use the much more efficient integer-only code,
662 operating on arbitrarily large numbers. */
663 bool fast_step_ok
= false;
665 || (all_digits_p (argv
[optind
+ 1])
666 && xstrtold (argv
[optind
+ 1], nullptr, &step
.value
, cl_strtold
)
667 && 0 < step
.value
&& step
.value
<= SEQ_FAST_STEP_LIMIT
))
670 if (all_digits_p (argv
[optind
])
671 && (n_args
== 1 || all_digits_p (argv
[optind
+ 1]))
672 && (n_args
< 3 || (fast_step_ok
673 && all_digits_p (argv
[optind
+ 2])))
674 && !equal_width
&& !format_str
&& strlen (separator
) == 1)
676 char const *s1
= n_args
== 1 ? "1" : argv
[optind
];
677 char const *s2
= argv
[optind
+ (n_args
- 1)];
678 seq_fast (s1
, s2
, step
.value
);
680 /* Upon any failure, let the more general code deal with it. */
683 last
= scan_arg (argv
[optind
++]);
688 last
= scan_arg (argv
[optind
++]);
695 error (0, 0, _("invalid Zero increment value: %s"),
696 quote (argv
[optind
- 1]));
697 usage (EXIT_FAILURE
);
700 last
= scan_arg (argv
[optind
++]);
704 /* Try the fast method again, for integers of the form 1e1 etc.,
705 or "inf" end value. */
706 if (first
.precision
== 0 && step
.precision
== 0 && last
.precision
== 0
707 && isfinite (first
.value
) && 0 <= first
.value
&& 0 <= last
.value
708 && 0 < step
.value
&& step
.value
<= SEQ_FAST_STEP_LIMIT
709 && !equal_width
&& !format_str
&& strlen (separator
) == 1)
713 if (asprintf (&s1
, "%0.Lf", first
.value
) < 0)
715 if (! isfinite (last
.value
))
716 s2
= xstrdup ("inf"); /* Ensure "inf" is used. */
717 else if (asprintf (&s2
, "%0.Lf", last
.value
) < 0)
720 if (*s1
!= '-' && *s2
!= '-')
721 seq_fast (s1
, s2
, step
.value
);
725 /* Upon any failure, let the more general code deal with it. */
728 if (format_str
== nullptr)
729 format_str
= get_default_format (first
, step
, last
);
731 print_numbers (format_str
, layout
, first
.value
, step
.value
, last
.value
);
733 main_exit (EXIT_SUCCESS
);