coreutils/printf.c

   1 /* vi: set sw=4 ts=4: */
   2 /* printf - format and print data
   3
   4    Copyright 1999 Dave Cinege
   5    Portions copyright (C) 1990-1996 Free Software Foundation, Inc.
   6
   7    Licensed under GPLv2 or later, see file LICENSE in this source tree.
   8 */
   9
  10 /* Usage: printf format [argument...]
  11
  12    A front end to the printf function that lets it be used from the shell.
  13
  14    Backslash escapes:
  15
  16    \" = double quote
  17    \\ = backslash
  18    \a = alert (bell)
  19    \b = backspace
  20    \c = produce no further output
  21    \f = form feed
  22    \n = new line
  23    \r = carriage return
  24    \t = horizontal tab
  25    \v = vertical tab
  26    \0ooo = octal number (ooo is 0 to 3 digits)
  27    \xhhh = hexadecimal number (hhh is 1 to 3 digits)
  28
  29    Additional directive:
  30
  31    %b = print an argument string, interpreting backslash escapes
  32
  33    The 'format' argument is re-used as many times as necessary
  34    to convert all of the given arguments.
  35
  36    David MacKenzie <djm@gnu.ai.mit.edu>
  37 */
  38
  39 /* 19990508 Busy Boxed! Dave Cinege */
  40
  41 //config:config PRINTF
  42 //config:       bool "printf (3.3 kb)"
  43 //config:       default y
  44 //config:       help
  45 //config:       printf is used to format and print specified strings.
  46 //config:       It's similar to `echo' except it has more options.
  47
  48 //applet:IF_PRINTF(APPLET_NOFORK(printf, printf, BB_DIR_USR_BIN, BB_SUID_DROP, printf))
  49
  50 //kbuild:lib-$(CONFIG_PRINTF) += printf.o
  51
  52 //kbuild:lib-$(CONFIG_ASH_PRINTF)  += printf.o
  53 //kbuild:lib-$(CONFIG_HUSH_PRINTF) += printf.o
  54
  55 //usage:#define printf_trivial_usage
  56 //usage:       "FORMAT [ARG]..."
  57 //usage:#define printf_full_usage "\n\n"
  58 //usage:       "Format and print ARG(s) according to FORMAT (a-la C printf)"
  59 //usage:
  60 //usage:#define printf_example_usage
  61 //usage:       "$ printf \"Val=%d\\n\" 5\n"
  62 //usage:       "Val=5\n"
  63
  64 #include "libbb.h"
  65
  66 /* A note on bad input: neither bash 3.2 nor coreutils 6.10 stop on it.
  67  * They report it:
  68  *  bash: printf: XXX: invalid number
  69  *  printf: XXX: expected a numeric value
  70  *  bash: printf: 123XXX: invalid number
  71  *  printf: 123XXX: value not completely converted
  72  * but then they use 0 (or partially converted numeric prefix) as a value
  73  * and continue. They exit with 1 in this case.
  74  * Both accept insane field width/precision (e.g. %9999999999.9999999999d).
  75  * Both print error message and assume 0 if %*.*f width/precision is "bad"
  76  *  (but negative numbers are not "bad").
  77  * Both accept negative numbers for %u specifier.
  78  *
  79  * We try to be compatible.
  80  */
  81
  82 typedef void FAST_FUNC (*converter)(const char *arg, void *result);
  83
  84 static int multiconvert(const char *arg, void *result, converter convert)
  85 {
  86         if (*arg == '"' || *arg == '\'') {
  87                 arg = utoa((unsigned char)arg[1]);
  88         }
  89         errno = 0;
  90         convert(arg, result);
  91         if (errno) {
  92                 bb_error_msg("invalid number '%s'", arg);
  93                 return 1;
  94         }
  95         return 0;
  96 }
  97
  98 static void FAST_FUNC conv_strtoull(const char *arg, void *result)
  99 {
 100         *(unsigned long long*)result = bb_strtoull(arg, NULL, 0);
 101         /* both coreutils 6.10 and bash 3.2:
 102          * $ printf '%x\n' -2
 103          * fffffffffffffffe
 104          * Mimic that:
 105          */
 106         if (errno) {
 107                 *(unsigned long long*)result = bb_strtoll(arg, NULL, 0);
 108         }
 109 }
 110 static void FAST_FUNC conv_strtoll(const char *arg, void *result)
 111 {
 112         *(long long*)result = bb_strtoll(arg, NULL, 0);
 113 }
 114 static void FAST_FUNC conv_strtod(const char *arg, void *result)
 115 {
 116         char *end;
 117         /* Well, this one allows leading whitespace... so what? */
 118         /* What I like much less is that "-" accepted too! :( */
 119         *(double*)result = strtod(arg, &end);
 120         if (end[0]) {
 121                 errno = ERANGE;
 122                 *(double*)result = 0;
 123         }
 124 }
 125
 126 /* Callers should check errno to detect errors */
 127 static unsigned long long my_xstrtoull(const char *arg)
 128 {
 129         unsigned long long result;
 130         if (multiconvert(arg, &result, conv_strtoull))
 131                 result = 0;
 132         return result;
 133 }
 134 static long long my_xstrtoll(const char *arg)
 135 {
 136         long long result;
 137         if (multiconvert(arg, &result, conv_strtoll))
 138                 result = 0;
 139         return result;
 140 }
 141 static double my_xstrtod(const char *arg)
 142 {
 143         double result;
 144         multiconvert(arg, &result, conv_strtod);
 145         return result;
 146 }
 147
 148 /* Handles %b; return 1 if output is to be short-circuited by \c */
 149 static int print_esc_string(const char *str)
 150 {
 151         char c;
 152         while ((c = *str) != '\0') {
 153                 str++;
 154                 if (c == '\\') {
 155                         /* %b also accepts 4-digit octals of the form \0### */
 156                         if (*str == '0') {
 157                                 if ((unsigned char)(str[1] - '0') < 8) {
 158                                         /* 2nd char is 0..7: skip leading '0' */
 159                                         str++;
 160                                 }
 161                         }
 162                         else if (*str == 'c') {
 163                                 return 1;
 164                         }
 165                         {
 166                                 /* optimization: don't force arg to be on-stack,
 167                                  * use another variable for that. */
 168                                 const char *z = str;
 169                                 c = bb_process_escape_sequence(&z);
 170                                 str = z;
 171                         }
 172                 }
 173                 putchar(c);
 174         }
 175
 176         return 0;
 177 }
 178
 179 static void print_direc(char *format, unsigned fmt_length,
 180                 int field_width, int precision,
 181                 const char *argument)
 182 {
 183         long long llv;
 184         double dv;
 185         char saved;
 186         char *have_prec, *have_width;
 187
 188         saved = format[fmt_length];
 189         format[fmt_length] = '\0';
 190
 191         have_prec = strstr(format, ".*");
 192         have_width = strchr(format, '*');
 193         if (have_width - 1 == have_prec)
 194                 have_width = NULL;
 195
 196         errno = 0;
 197
 198         switch (format[fmt_length - 1]) {
 199         case 'c':
 200                 printf(format, *argument);
 201                 break;
 202         case 'd':
 203         case 'i':
 204                 llv = my_xstrtoll(argument);
 205  print_long:
 206                 if (!have_width) {
 207                         if (!have_prec)
 208                                 printf(format, llv);
 209                         else
 210                                 printf(format, precision, llv);
 211                 } else {
 212                         if (!have_prec)
 213                                 printf(format, field_width, llv);
 214                         else
 215                                 printf(format, field_width, precision, llv);
 216                 }
 217                 break;
 218         case 'o':
 219         case 'u':
 220         case 'x':
 221         case 'X':
 222                 llv = my_xstrtoull(argument);
 223                 /* cheat: unsigned long and long have same width, so... */
 224                 goto print_long;
 225         case 's':
 226                 /* Are char* and long long the same? */
 227                 if (sizeof(argument) == sizeof(llv)) {
 228                         llv = (long long)(ptrdiff_t)argument;
 229                         goto print_long;
 230                 } else {
 231                         /* Hope compiler will optimize it out by moving call
 232                          * instruction after the ifs... */
 233                         if (!have_width) {
 234                                 if (!have_prec)
 235                                         printf(format, argument, /*unused:*/ argument, argument);
 236                                 else
 237                                         printf(format, precision, argument, /*unused:*/ argument);
 238                         } else {
 239                                 if (!have_prec)
 240                                         printf(format, field_width, argument, /*unused:*/ argument);
 241                                 else
 242                                         printf(format, field_width, precision, argument);
 243                         }
 244                         break;
 245                 }
 246         case 'f':
 247         case 'e':
 248         case 'E':
 249         case 'g':
 250         case 'G':
 251                 dv = my_xstrtod(argument);
 252                 if (!have_width) {
 253                         if (!have_prec)
 254                                 printf(format, dv);
 255                         else
 256                                 printf(format, precision, dv);
 257                 } else {
 258                         if (!have_prec)
 259                                 printf(format, field_width, dv);
 260                         else
 261                                 printf(format, field_width, precision, dv);
 262                 }
 263                 break;
 264         } /* switch */
 265
 266         format[fmt_length] = saved;
 267 }
 268
 269 /* Handle params for "%*.*f". Negative numbers are ok (compat). */
 270 static int get_width_prec(const char *str)
 271 {
 272         int v = bb_strtoi(str, NULL, 10);
 273         if (errno) {
 274                 bb_error_msg("invalid number '%s'", str);
 275                 v = 0;
 276         }
 277         return v;
 278 }
 279
 280 /* Print the text in FORMAT, using ARGV for arguments to any '%' directives.
 281    Return advanced ARGV.  */
 282 static char **print_formatted(char *f, char **argv, int *conv_err)
 283 {
 284         char *direc_start;      /* Start of % directive.  */
 285         unsigned direc_length;  /* Length of % directive.  */
 286         int field_width;        /* Arg to first '*' */
 287         int precision;          /* Arg to second '*' */
 288         char **saved_argv = argv;
 289
 290         for (; *f; ++f) {
 291                 switch (*f) {
 292                 case '%':
 293                         direc_start = f++;
 294                         direc_length = 1;
 295                         field_width = precision = 0;
 296                         if (*f == '%') {
 297                                 bb_putchar('%');
 298                                 break;
 299                         }
 300                         if (*f == 'b') {
 301                                 if (*argv) {
 302                                         if (print_esc_string(*argv))
 303                                                 return saved_argv; /* causes main() to exit */
 304                                         ++argv;
 305                                 }
 306                                 break;
 307                         }
 308                         if (*f && strchr("-+ #", *f)) {
 309                                 ++f;
 310                                 ++direc_length;
 311                         }
 312                         if (*f == '*') {
 313                                 ++f;
 314                                 ++direc_length;
 315                                 if (*argv)
 316                                         field_width = get_width_prec(*argv++);
 317                         } else {
 318                                 while (isdigit(*f)) {
 319                                         ++f;
 320                                         ++direc_length;
 321                                 }
 322                         }
 323                         if (*f == '.') {
 324                                 ++f;
 325                                 ++direc_length;
 326                                 if (*f == '*') {
 327                                         ++f;
 328                                         ++direc_length;
 329                                         if (*argv)
 330                                                 precision = get_width_prec(*argv++);
 331                                 } else {
 332                                         while (isdigit(*f)) {
 333                                                 ++f;
 334                                                 ++direc_length;
 335                                         }
 336                                 }
 337                         }
 338
 339                         /* Remove "lLhz" size modifiers, repeatedly.
 340                          * bash does not like "%lld", but coreutils
 341                          * happily takes even "%Llllhhzhhzd"!
 342                          * We are permissive like coreutils */
 343                         while ((*f | 0x20) == 'l' || *f == 'h' || *f == 'z') {
 344                                 overlapping_strcpy(f, f + 1);
 345                         }
 346                         /* Add "ll" if integer modifier, then print */
 347                         {
 348                                 static const char format_chars[] ALIGN1 = "diouxXfeEgGcs";
 349                                 char *p = strchr(format_chars, *f);
 350                                 /* needed - try "printf %" without it */
 351                                 if (p == NULL || *f == '\0') {
 352                                         bb_error_msg("%s: invalid format", direc_start);
 353                                         /* causes main() to exit with error */
 354                                         return saved_argv - 1;
 355                                 }
 356                                 ++direc_length;
 357                                 if (p - format_chars <= 5) {
 358                                         /* it is one of "diouxX" */
 359                                         p = xmalloc(direc_length + 3);
 360                                         memcpy(p, direc_start, direc_length);
 361                                         p[direc_length + 1] = p[direc_length - 1];
 362                                         p[direc_length - 1] = 'l';
 363                                         p[direc_length] = 'l';
 364                                         //bb_error_msg("<%s>", p);
 365                                         direc_length += 2;
 366                                         direc_start = p;
 367                                 } else {
 368                                         p = NULL;
 369                                 }
 370                                 if (*argv) {
 371                                         print_direc(direc_start, direc_length, field_width,
 372                                                                 precision, *argv++);
 373                                 } else {
 374                                         print_direc(direc_start, direc_length, field_width,
 375                                                                 precision, "");
 376                                 }
 377                                 *conv_err |= errno;
 378                                 free(p);
 379                         }
 380                         break;
 381                 case '\\':
 382                         if (*++f == 'c') {
 383                                 return saved_argv; /* causes main() to exit */
 384                         }
 385                         bb_putchar(bb_process_escape_sequence((const char **)&f));
 386                         f--;
 387                         break;
 388                 default:
 389                         putchar(*f);
 390                 }
 391         }
 392
 393         return argv;
 394 }
 395
 396 int printf_main(int argc UNUSED_PARAM, char **argv)
 397 {
 398         int conv_err;
 399         char *format;
 400         char **argv2;
 401
 402         /* We must check that stdout is not closed.
 403          * The reason for this is highly non-obvious.
 404          * printf_main is used from shell.
 405          * Shell must correctly handle 'printf "%s" foo'
 406          * if stdout is closed. With stdio, output gets shoveled into
 407          * stdout buffer, and even fflush cannot clear it out. It seems that
 408          * even if libc receives EBADF on write attempts, it feels determined
 409          * to output data no matter what. So it will try later,
 410          * and possibly will clobber future output. Not good. */
 411 // TODO: check fcntl() & O_ACCMODE == O_WRONLY or O_RDWR?
 412         if (fcntl(1, F_GETFL) == -1)
 413                 return 1; /* match coreutils 6.10 (sans error msg to stderr) */
 414         //if (dup2(1, 1) != 1) - old way
 415         //      return 1;
 416
 417         /* bash builtin errors out on "printf '-%s-\n' foo",
 418          * coreutils-6.9 works. Both work with "printf -- '-%s-\n' foo".
 419          * We will mimic coreutils. */
 420         if (argv[1] && argv[1][0] == '-' && argv[1][1] == '-' && !argv[1][2])
 421                 argv++;
 422         if (!argv[1]) {
 423                 if (ENABLE_ASH_PRINTF
 424                  && applet_name[0] != 'p'
 425                 ) {
 426                         bb_error_msg("usage: printf FORMAT [ARGUMENT...]");
 427                         return 2; /* bash compat */
 428                 }
 429                 bb_show_usage();
 430         }
 431
 432         format = argv[1];
 433         argv2 = argv + 2;
 434
 435         conv_err = 0;
 436         do {
 437                 argv = argv2;
 438                 argv2 = print_formatted(format, argv, &conv_err);
 439         } while (argv2 > argv && *argv2);
 440
 441         /* coreutils compat (bash doesn't do this):
 442         if (*argv)
 443                 fprintf(stderr, "excess args ignored");
 444         */
 445
 446         return (argv2 < argv) /* if true, print_formatted errored out */
 447                 || conv_err; /* print_formatted saw invalid number */
 448 }