1 /* printf - format and print data
2 Copyright (C) 1990-2009 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 /* Usage: printf format [argument...]
19 A front end to the printf function that lets it be used from the shell.
27 \c = produce no further output
33 \ooo = octal number (ooo is 1 to 3 digits)
34 \xhh = hexadecimal number (hhh is 1 to 2 digits)
35 \uhhhh = 16-bit Unicode character (hhhh is 4 digits)
36 \Uhhhhhhhh = 32-bit Unicode character (hhhhhhhh is 8 digits)
40 %b = print an argument string, interpreting backslash escapes,
41 except that octal escapes are of the form \0 or \0ooo.
43 The `format' argument is re-used as many times as necessary
44 to convert all of the given arguments.
46 David MacKenzie <djm@gnu.ai.mit.edu> */
50 #include <sys/types.h>
56 #include "unicodeio.h"
59 /* The official name of this program (e.g., no `g' prefix). */
60 #define PROGRAM_NAME "printf"
62 #define AUTHORS proper_name ("David MacKenzie")
64 #define isodigit(c) ((c) >= '0' && (c) <= '7')
65 #define hextobin(c) ((c) >= 'a' && (c) <= 'f' ? (c) - 'a' + 10 : \
66 (c) >= 'A' && (c) <= 'F' ? (c) - 'A' + 10 : (c) - '0')
67 #define octtobin(c) ((c) - '0')
69 /* The value to return to the calling program. */
70 static int exit_status
;
72 /* True if the POSIXLY_CORRECT environment variable is set. */
73 static bool posixly_correct
;
75 /* This message appears in N_() here rather than just in _() below because
76 the sole use would have been in a #define. */
77 static char const *const cfcc_msg
=
78 N_("warning: %s: character(s) following character constant have been ignored");
83 if (status
!= EXIT_SUCCESS
)
84 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
89 Usage: %s FORMAT [ARGUMENT]...\n\
92 program_name
, program_name
);
94 Print ARGUMENT(s) according to FORMAT, or execute according to OPTION:\n\
97 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
98 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
101 FORMAT controls the output as in C printf. Interpreted sequences are:\n\
104 \\NNN character with octal value NNN (1 to 3 digits)\n\
110 \\c produce no further output\n\
115 \\r carriage return\n\
116 \\t horizontal tab\n\
120 \\xHH byte with hexadecimal value HH (1 to 2 digits)\n\
121 \\uHHHH Unicode (ISO/IEC 10646) character with hex value HHHH (4 digits)\n\
122 \\UHHHHHHHH Unicode character with hex value HHHHHHHH (8 digits)\n\
126 %b ARGUMENT as a string with `\\' escapes interpreted,\n\
127 except that octal escapes are of the form \\0 or \\0NNN\n\
129 and all C format specifications ending with one of diouxXfeEgGcs, with\n\
130 ARGUMENTs converted to proper type first. Variable widths are handled.\n\
132 printf (USAGE_BUILTIN_WARNING
, PROGRAM_NAME
);
133 emit_bug_reporting_address ();
139 verify_numeric (const char *s
, const char *end
)
143 error (0, errno
, "%s", s
);
144 exit_status
= EXIT_FAILURE
;
149 error (0, 0, _("%s: expected a numeric value"), s
);
151 error (0, 0, _("%s: value not completely converted"), s
);
152 exit_status
= EXIT_FAILURE
;
156 #define STRTOX(TYPE, FUNC_NAME, LIB_FUNC_EXPR) \
158 FUNC_NAME (char const *s) \
163 if (*s == '\"' || *s == '\'') \
165 unsigned char ch = *++s; \
167 /* If POSIXLY_CORRECT is not set, then give a warning that there \
168 are characters following the character constant and that GNU \
169 printf is ignoring those characters. If POSIXLY_CORRECT *is* \
170 set, then don't give the warning. */ \
171 if (*++s != 0 && !posixly_correct) \
172 error (0, 0, _(cfcc_msg), s); \
177 val = (LIB_FUNC_EXPR); \
178 verify_numeric (s, end); \
183 STRTOX (intmax_t, vstrtoimax, strtoimax (s, &end, 0))
184 STRTOX (uintmax_t, vstrtoumax
, strtoumax (s
, &end
, 0))
185 STRTOX (long double, vstrtold
, c_strtold (s
, &end
))
187 /* Output a single-character \ escape. */
190 print_esc_char (char c
)
194 case 'a': /* Alert. */
197 case 'b': /* Backspace. */
200 case 'c': /* Cancel the rest of the output. */
203 case 'f': /* Form feed. */
206 case 'n': /* New line. */
209 case 'r': /* Carriage return. */
212 case 't': /* Horizontal tab. */
215 case 'v': /* Vertical tab. */
224 /* Print a \ escape sequence starting at ESCSTART.
225 Return the number of characters in the escape sequence
226 besides the backslash.
227 If OCTAL_0 is nonzero, octal escapes are of the form \0ooo, where o
228 is an octal digit; otherwise they are of the form \ooo. */
231 print_esc (const char *escstart
, bool octal_0
)
233 const char *p
= escstart
+ 1;
234 int esc_value
= 0; /* Value of \nnn escape. */
235 int esc_length
; /* Length of \nnn escape. */
239 /* A hexadecimal \xhh escape sequence must have 1 or 2 hex. digits. */
240 for (esc_length
= 0, ++p
;
241 esc_length
< 2 && isxdigit (to_uchar (*p
));
243 esc_value
= esc_value
* 16 + hextobin (*p
);
245 error (EXIT_FAILURE
, 0, _("missing hexadecimal number in escape"));
248 else if (isodigit (*p
))
250 /* Parse \0ooo (if octal_0 && *p == '0') or \ooo (otherwise).
251 Allow \ooo if octal_0 && *p != '0'; this is an undocumented
252 extension to POSIX that is compatible with Bash 2.05b. */
253 for (esc_length
= 0, p
+= octal_0
&& *p
== '0';
254 esc_length
< 3 && isodigit (*p
);
256 esc_value
= esc_value
* 8 + octtobin (*p
);
259 else if (*p
&& strchr ("\"\\abcfnrtv", *p
))
260 print_esc_char (*p
++);
261 else if (*p
== 'u' || *p
== 'U')
264 unsigned int uni_value
;
267 for (esc_length
= (esc_char
== 'u' ? 4 : 8), ++p
;
271 if (! isxdigit (to_uchar (*p
)))
272 error (EXIT_FAILURE
, 0, _("missing hexadecimal number in escape"));
273 uni_value
= uni_value
* 16 + hextobin (*p
);
276 /* A universal character name shall not specify a character short
277 identifier in the range 00000000 through 00000020, 0000007F through
278 0000009F, or 0000D800 through 0000DFFF inclusive. A universal
279 character name shall not designate a character in the required
281 if ((uni_value
<= 0x9f
282 && uni_value
!= 0x24 && uni_value
!= 0x40 && uni_value
!= 0x60)
283 || (uni_value
>= 0xd800 && uni_value
<= 0xdfff))
284 error (EXIT_FAILURE
, 0, _("invalid universal character name \\%c%0*x"),
285 esc_char
, (esc_char
== 'u' ? 4 : 8), uni_value
);
287 print_unicode_char (stdout
, uni_value
, 0);
298 return p
- escstart
- 1;
301 /* Print string STR, evaluating \ escapes. */
304 print_esc_string (const char *str
)
308 str
+= print_esc (str
, true);
313 /* Evaluate a printf conversion specification. START is the start of
314 the directive, LENGTH is its length, and CONVERSION specifies the
315 type of conversion. LENGTH does not include any length modifier or
316 the conversion specifier itself. FIELD_WIDTH and PRECISION are the
317 field width and precision for '*' values, if HAVE_FIELD_WIDTH and
318 HAVE_PRECISION are true, respectively. ARGUMENT is the argument to
322 print_direc (const char *start
, size_t length
, char conversion
,
323 bool have_field_width
, int field_width
,
324 bool have_precision
, int precision
,
325 char const *argument
)
327 char *p
; /* Null-terminated copy of % directive. */
329 /* Create a null-terminated copy of the % directive, with an
330 intmax_t-wide length modifier substituted for any existing
331 integer length modifier. */
334 char const *length_modifier
;
335 size_t length_modifier_len
;
339 case 'd': case 'i': case 'o': case 'u': case 'x': case 'X':
340 length_modifier
= PRIdMAX
;
341 length_modifier_len
= sizeof PRIdMAX
- 2;
344 case 'a': case 'e': case 'f': case 'g':
345 case 'A': case 'E': case 'F': case 'G':
346 length_modifier
= "L";
347 length_modifier_len
= 1;
351 length_modifier
= start
; /* Any valid pointer will do. */
352 length_modifier_len
= 0;
356 p
= xmalloc (length
+ length_modifier_len
+ 2);
357 q
= mempcpy (p
, start
, length
);
358 q
= mempcpy (q
, length_modifier
, length_modifier_len
);
368 intmax_t arg
= vstrtoimax (argument
);
369 if (!have_field_width
)
374 xprintf (p
, precision
, arg
);
379 xprintf (p
, field_width
, arg
);
381 xprintf (p
, field_width
, precision
, arg
);
391 uintmax_t arg
= vstrtoumax (argument
);
392 if (!have_field_width
)
397 xprintf (p
, precision
, arg
);
402 xprintf (p
, field_width
, arg
);
404 xprintf (p
, field_width
, precision
, arg
);
418 long double arg
= vstrtold (argument
);
419 if (!have_field_width
)
424 xprintf (p
, precision
, arg
);
429 xprintf (p
, field_width
, arg
);
431 xprintf (p
, field_width
, precision
, arg
);
437 if (!have_field_width
)
438 xprintf (p
, *argument
);
440 xprintf (p
, field_width
, *argument
);
444 if (!have_field_width
)
447 xprintf (p
, argument
);
449 xprintf (p
, precision
, argument
);
454 xprintf (p
, field_width
, argument
);
456 xprintf (p
, field_width
, precision
, argument
);
464 /* Print the text in FORMAT, using ARGV (with ARGC elements) for
465 arguments to any `%' directives.
466 Return the number of elements of ARGV used. */
469 print_formatted (const char *format
, int argc
, char **argv
)
471 int save_argc
= argc
; /* Preserve original value. */
472 const char *f
; /* Pointer into `format'. */
473 const char *direc_start
; /* Start of % directive. */
474 size_t direc_length
; /* Length of % directive. */
475 bool have_field_width
; /* True if FIELD_WIDTH is valid. */
476 int field_width
= 0; /* Arg to first '*'. */
477 bool have_precision
; /* True if PRECISION is valid. */
478 int precision
= 0; /* Arg to second '*'. */
479 char ok
[UCHAR_MAX
+ 1]; /* ok['x'] is true if %x is allowed. */
481 for (f
= format
; *f
; ++f
)
488 have_field_width
= have_precision
= false;
496 /* FIXME: Field width and precision are not supported
497 for %b, even though POSIX requires it. */
500 print_esc_string (*argv
);
507 memset (ok
, 0, sizeof ok
);
508 ok
['a'] = ok
['A'] = ok
['c'] = ok
['d'] = ok
['e'] = ok
['E'] =
509 ok
['f'] = ok
['F'] = ok
['g'] = ok
['G'] = ok
['i'] = ok
['o'] =
510 ok
['s'] = ok
['u'] = ok
['x'] = ok
['X'] = 1;
512 for (;; f
++, direc_length
++)
515 #if (__GLIBC__ == 2 && 2 <= __GLIBC_MINOR__) || 3 <= __GLIBC__
519 ok
['a'] = ok
['A'] = ok
['c'] = ok
['e'] = ok
['E'] =
520 ok
['o'] = ok
['s'] = ok
['x'] = ok
['X'] = 0;
522 case '-': case '+': case ' ':
525 ok
['c'] = ok
['d'] = ok
['i'] = ok
['s'] = ok
['u'] = 0;
528 ok
['c'] = ok
['s'] = 0;
531 goto no_more_flag_characters
;
533 no_more_flag_characters
:;
541 intmax_t width
= vstrtoimax (*argv
);
542 if (INT_MIN
<= width
&& width
<= INT_MAX
)
545 error (EXIT_FAILURE
, 0, _("invalid field width: %s"),
552 have_field_width
= true;
571 intmax_t prec
= vstrtoimax (*argv
);
574 /* A negative precision is taken as if the
575 precision were omitted, so -1 is safe
576 here even if prec < INT_MIN. */
579 else if (INT_MAX
< prec
)
580 error (EXIT_FAILURE
, 0, _("invalid precision: %s"),
589 have_precision
= true;
599 while (*f
== 'l' || *f
== 'L' || *f
== 'h'
600 || *f
== 'j' || *f
== 't' || *f
== 'z')
604 unsigned char conversion
= *f
;
605 if (! ok
[conversion
])
606 error (EXIT_FAILURE
, 0,
607 _("%.*s: invalid conversion specification"),
608 (int) (f
+ 1 - direc_start
), direc_start
);
611 print_direc (direc_start
, direc_length
, *f
,
612 have_field_width
, field_width
,
613 have_precision
, precision
,
614 (argc
<= 0 ? "" : (argc
--, *argv
++)));
618 f
+= print_esc (f
, false);
626 return save_argc
- argc
;
630 main (int argc
, char **argv
)
635 initialize_main (&argc
, &argv
);
636 set_program_name (argv
[0]);
637 setlocale (LC_ALL
, "");
638 bindtextdomain (PACKAGE
, LOCALEDIR
);
639 textdomain (PACKAGE
);
641 atexit (close_stdout
);
643 exit_status
= EXIT_SUCCESS
;
645 posixly_correct
= (getenv ("POSIXLY_CORRECT") != NULL
);
647 /* We directly parse options, rather than use parse_long_options, in
648 order to avoid accepting abbreviations. */
651 if (STREQ (argv
[1], "--help"))
652 usage (EXIT_SUCCESS
);
654 if (STREQ (argv
[1], "--version"))
656 version_etc (stdout
, PROGRAM_NAME
, PACKAGE_NAME
, Version
, AUTHORS
,
662 /* The above handles --help and --version.
663 Since there is no other invocation of getopt, handle `--' here. */
664 if (1 < argc
&& STREQ (argv
[1], "--"))
672 error (0, 0, _("missing operand"));
673 usage (EXIT_FAILURE
);
682 args_used
= print_formatted (format
, argc
, argv
);
686 while (args_used
> 0 && argc
> 0);
690 _("warning: ignoring excess arguments, starting with %s"),