printf.c revision 1.39
1 /* $NetBSD: printf.c,v 1.39 2018/07/03 01:56:39 kre Exp $ */ 2 3 /* 4 * Copyright (c) 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 #include <sys/cdefs.h> 33 #ifndef lint 34 #if !defined(BUILTIN) && !defined(SHELL) 35 __COPYRIGHT("@(#) Copyright (c) 1989, 1993\ 36 The Regents of the University of California. All rights reserved."); 37 #endif 38 #endif 39 40 #ifndef lint 41 #if 0 42 static char sccsid[] = "@(#)printf.c 8.2 (Berkeley) 3/22/95"; 43 #else 44 __RCSID("$NetBSD: printf.c,v 1.39 2018/07/03 01:56:39 kre Exp $"); 45 #endif 46 #endif /* not lint */ 47 48 #include <sys/types.h> 49 50 #include <ctype.h> 51 #include <err.h> 52 #include <errno.h> 53 #include <inttypes.h> 54 #include <limits.h> 55 #include <locale.h> 56 #include <stdarg.h> 57 #include <stdio.h> 58 #include <stdlib.h> 59 #include <string.h> 60 #include <unistd.h> 61 62 #ifdef __GNUC__ 63 #define ESCAPE '\e' 64 #else 65 #define ESCAPE 033 66 #endif 67 68 static void conv_escape_str(char *, void (*)(int), int); 69 static char *conv_escape(char *, char *, int); 70 static char *conv_expand(const char *); 71 static char getchr(void); 72 static double getdouble(void); 73 static int getwidth(void); 74 static intmax_t getintmax(void); 75 static uintmax_t getuintmax(void); 76 static char *getstr(void); 77 static char *mklong(const char *, char); 78 static void check_conversion(const char *, const char *); 79 static void usage(void); 80 81 static void b_count(int); 82 static void b_output(int); 83 static size_t b_length; 84 static char *b_fmt; 85 86 static int rval; 87 static char **gargv; 88 89 #ifdef BUILTIN /* csh builtin */ 90 #define main progprintf 91 #endif 92 93 #ifdef SHELL /* sh (aka ash) builtin */ 94 #define main printfcmd 95 #include "../../bin/sh/bltin/bltin.h" 96 #endif /* SHELL */ 97 98 #define PF(f, func) { \ 99 if (fieldwidth != -1) { \ 100 if (precision != -1) \ 101 error = printf(f, fieldwidth, precision, func); \ 102 else \ 103 error = printf(f, fieldwidth, func); \ 104 } else if (precision != -1) \ 105 error = printf(f, precision, func); \ 106 else \ 107 error = printf(f, func); \ 108 } 109 110 #define APF(cpp, f, func) { \ 111 if (fieldwidth != -1) { \ 112 if (precision != -1) \ 113 error = asprintf(cpp, f, fieldwidth, precision, func); \ 114 else \ 115 error = asprintf(cpp, f, fieldwidth, func); \ 116 } else if (precision != -1) \ 117 error = asprintf(cpp, f, precision, func); \ 118 else \ 119 error = asprintf(cpp, f, func); \ 120 } 121 122 #ifdef main 123 int main(int, char *[]); 124 #endif 125 int main(int argc, char *argv[]) 126 { 127 char *fmt, *start; 128 int fieldwidth, precision; 129 char nextch; 130 char *format; 131 char ch; 132 int error, o; 133 134 #if !defined(SHELL) && !defined(BUILTIN) 135 (void)setlocale (LC_ALL, ""); 136 #endif 137 138 while ((o = getopt(argc, argv, "")) != -1) { 139 switch (o) { 140 case '?': 141 default: 142 usage(); 143 return 1; 144 } 145 } 146 argc -= optind; 147 argv += optind; 148 149 if (argc < 1) { 150 usage(); 151 return 1; 152 } 153 154 format = *argv; 155 gargv = ++argv; 156 157 #define SKIP1 "#-+ 0'" 158 #define SKIP2 "0123456789" 159 do { 160 /* 161 * Basic algorithm is to scan the format string for conversion 162 * specifications -- once one is found, find out if the field 163 * width or precision is a '*'; if it is, gather up value. 164 * Note, format strings are reused as necessary to use up the 165 * provided arguments, arguments of zero/null string are 166 * provided to use up the format string. 167 */ 168 169 /* find next format specification */ 170 for (fmt = format; (ch = *fmt++) != '\0';) { 171 if (ch == '\\') { 172 char c_ch; 173 fmt = conv_escape(fmt, &c_ch, 0); 174 putchar(c_ch); 175 continue; 176 } 177 if (ch != '%' || (*fmt == '%' && ++fmt)) { 178 (void)putchar(ch); 179 continue; 180 } 181 182 /* Ok - we've found a format specification, 183 Save its address for a later printf(). */ 184 start = fmt - 1; 185 186 /* skip to field width */ 187 fmt += strspn(fmt, SKIP1); 188 if (*fmt == '*') { 189 fmt++; 190 fieldwidth = getwidth(); 191 } else 192 fieldwidth = -1; 193 194 /* skip to possible '.', get following precision */ 195 fmt += strspn(fmt, SKIP2); 196 if (*fmt == '.') { 197 fmt++; 198 if (*fmt == '*') { 199 fmt++; 200 precision = getwidth(); 201 } else 202 precision = -1; 203 } else 204 precision = -1; 205 206 fmt += strspn(fmt, SKIP2); 207 208 ch = *fmt; 209 if (!ch) { 210 warnx("missing format character"); 211 return (1); 212 } 213 /* null terminate format string to we can use it 214 as an argument to printf. */ 215 nextch = fmt[1]; 216 fmt[1] = 0; 217 switch (ch) { 218 219 case 'B': { 220 const char *p = conv_expand(getstr()); 221 if (p == NULL) 222 goto out; 223 *fmt = 's'; 224 PF(start, p); 225 if (error < 0) 226 goto out; 227 break; 228 } 229 case 'b': { 230 /* There has to be a better way to do this, 231 * but the string we generate might have 232 * embedded nulls. */ 233 static char *a, *t; 234 char *cp = getstr(); 235 /* Free on entry in case shell longjumped out */ 236 if (a != NULL) 237 free(a); 238 a = NULL; 239 if (t != NULL) 240 free(t); 241 t = NULL; 242 /* Count number of bytes we want to output */ 243 b_length = 0; 244 conv_escape_str(cp, b_count, 0); 245 t = malloc(b_length + 1); 246 if (t == NULL) 247 goto out; 248 (void)memset(t, 'x', b_length); 249 t[b_length] = 0; 250 /* Get printf to calculate the lengths */ 251 *fmt = 's'; 252 APF(&a, start, t); 253 if (error == -1) 254 goto out; 255 b_fmt = a; 256 /* Output leading spaces and data bytes */ 257 conv_escape_str(cp, b_output, 1); 258 /* Add any trailing spaces */ 259 printf("%s", b_fmt); 260 break; 261 } 262 case 'c': { 263 char p = getchr(); 264 PF(start, p); 265 if (error < 0) 266 goto out; 267 break; 268 } 269 case 's': { 270 char *p = getstr(); 271 PF(start, p); 272 if (error < 0) 273 goto out; 274 break; 275 } 276 case 'd': 277 case 'i': { 278 intmax_t p = getintmax(); 279 char *f = mklong(start, ch); 280 PF(f, p); 281 if (error < 0) 282 goto out; 283 break; 284 } 285 case 'o': 286 case 'u': 287 case 'x': 288 case 'X': { 289 uintmax_t p = getuintmax(); 290 char *f = mklong(start, ch); 291 PF(f, p); 292 if (error < 0) 293 goto out; 294 break; 295 } 296 case 'e': 297 case 'E': 298 case 'f': 299 case 'g': 300 case 'G': { 301 double p = getdouble(); 302 PF(start, p); 303 if (error < 0) 304 goto out; 305 break; 306 } 307 default: 308 warnx("%s: invalid directive", start); 309 return 1; 310 } 311 *fmt++ = ch; 312 *fmt = nextch; 313 /* escape if a \c was encountered */ 314 if (rval & 0x100) 315 return rval & ~0x100; 316 } 317 } while (gargv != argv && *gargv); 318 319 return rval & ~0x100; 320 out: 321 warn("print failed"); 322 return 1; 323 } 324 325 /* helper functions for conv_escape_str */ 326 327 static void 328 /*ARGSUSED*/ 329 b_count(int ch) 330 { 331 b_length++; 332 } 333 334 /* Output one converted character for every 'x' in the 'format' */ 335 336 static void 337 b_output(int ch) 338 { 339 for (;;) { 340 switch (*b_fmt++) { 341 case 0: 342 b_fmt--; 343 return; 344 case ' ': 345 putchar(' '); 346 break; 347 default: 348 putchar(ch); 349 return; 350 } 351 } 352 } 353 354 355 /* 356 * Print SysV echo(1) style escape string 357 * Halts processing string if a \c escape is encountered. 358 */ 359 static void 360 conv_escape_str(char *str, void (*do_putchar)(int), int quiet) 361 { 362 int value; 363 int ch; 364 char c; 365 366 while ((ch = *str++) != '\0') { 367 if (ch != '\\') { 368 do_putchar(ch); 369 continue; 370 } 371 372 ch = *str++; 373 if (ch == 'c') { 374 /* \c as in SYSV echo - abort all processing.... */ 375 rval |= 0x100; 376 break; 377 } 378 379 /* 380 * %b string octal constants are not like those in C. 381 * They start with a \0, and are followed by 0, 1, 2, 382 * or 3 octal digits. 383 */ 384 if (ch == '0') { 385 int octnum = 0, i; 386 for (i = 0; i < 3; i++) { 387 if (!isdigit((unsigned char)*str) || *str > '7') 388 break; 389 octnum = (octnum << 3) | (*str++ - '0'); 390 } 391 do_putchar(octnum); 392 continue; 393 } 394 395 /* \[M][^|-]C as defined by vis(3) */ 396 if (ch == 'M' && *str == '-') { 397 do_putchar(0200 | str[1]); 398 str += 2; 399 continue; 400 } 401 if (ch == 'M' && *str == '^') { 402 str++; 403 value = 0200; 404 ch = '^'; 405 } else 406 value = 0; 407 if (ch == '^') { 408 ch = *str++; 409 if (ch == '?') 410 value |= 0177; 411 else 412 value |= ch & 037; 413 do_putchar(value); 414 continue; 415 } 416 417 /* Finally test for sequences valid in the format string */ 418 str = conv_escape(str - 1, &c, quiet); 419 do_putchar(c); 420 } 421 } 422 423 /* 424 * Print "standard" escape characters 425 */ 426 static char * 427 conv_escape(char *str, char *conv_ch, int quiet) 428 { 429 char value; 430 char ch; 431 char num_buf[4], *num_end; 432 433 ch = *str++; 434 435 switch (ch) { 436 case '\0': 437 if (!quiet) 438 warnx("incomplete escape sequence"); 439 rval = 1; 440 value = '\\'; 441 --str; 442 break; 443 444 case '0': case '1': case '2': case '3': 445 case '4': case '5': case '6': case '7': 446 num_buf[0] = ch; 447 ch = str[0]; 448 num_buf[1] = ch; 449 num_buf[2] = (char)(ch != '\0' ? str[1] : '\0'); 450 num_buf[3] = '\0'; 451 value = (char)strtoul(num_buf, &num_end, 8); 452 str += num_end - (num_buf + 1); 453 break; 454 455 case 'x': 456 /* Hexadecimal character constants are not required to be 457 supported (by SuS v1) because there is no consistent 458 way to detect the end of the constant. 459 Supporting 2 byte constants is a compromise. */ 460 ch = str[0]; 461 num_buf[0] = ch; 462 num_buf[1] = (char)(ch != '\0' ? str[1] : '\0'); 463 num_buf[2] = '\0'; 464 value = (char)strtoul(num_buf, &num_end, 16); 465 str += num_end - num_buf; 466 break; 467 468 case '\\': value = '\\'; break; /* backslash */ 469 case '\'': value = '\''; break; /* single quote */ 470 case '"': value = '"'; break; /* double quote */ 471 case 'a': value = '\a'; break; /* alert */ 472 case 'b': value = '\b'; break; /* backspace */ 473 case 'e': value = ESCAPE; break; /* escape */ 474 case 'f': value = '\f'; break; /* form-feed */ 475 case 'n': value = '\n'; break; /* newline */ 476 case 'r': value = '\r'; break; /* carriage-return */ 477 case 't': value = '\t'; break; /* tab */ 478 case 'v': value = '\v'; break; /* vertical-tab */ 479 480 default: 481 if (!quiet) 482 warnx("unknown escape sequence `\\%c'", ch); 483 rval = 1; 484 value = ch; 485 break; 486 } 487 488 *conv_ch = value; 489 return str; 490 } 491 492 /* expand a string so that everything is printable */ 493 494 static char * 495 conv_expand(const char *str) 496 { 497 static char *conv_str; 498 char *cp; 499 char ch; 500 501 if (conv_str) 502 free(conv_str); 503 /* get a buffer that is definitely large enough.... */ 504 conv_str = malloc(4 * strlen(str) + 1); 505 if (!conv_str) 506 return NULL; 507 cp = conv_str; 508 509 while ((ch = *(const char *)str++) != '\0') { 510 switch (ch) { 511 /* Use C escapes for expected control characters */ 512 case '\\': ch = '\\'; break; /* backslash */ 513 case '\'': ch = '\''; break; /* single quote */ 514 case '"': ch = '"'; break; /* double quote */ 515 case '\a': ch = 'a'; break; /* alert */ 516 case '\b': ch = 'b'; break; /* backspace */ 517 case ESCAPE: ch = 'e'; break; /* escape */ 518 case '\f': ch = 'f'; break; /* form-feed */ 519 case '\n': ch = 'n'; break; /* newline */ 520 case '\r': ch = 'r'; break; /* carriage-return */ 521 case '\t': ch = 't'; break; /* tab */ 522 case '\v': ch = 'v'; break; /* vertical-tab */ 523 default: 524 /* Copy anything printable */ 525 if (isprint((unsigned char)ch)) { 526 *cp++ = ch; 527 continue; 528 } 529 /* Use vis(3) encodings for the rest */ 530 *cp++ = '\\'; 531 if (ch & 0200) { 532 *cp++ = 'M'; 533 ch &= (char)~0200; 534 } 535 if (ch == 0177) { 536 *cp++ = '^'; 537 *cp++ = '?'; 538 continue; 539 } 540 if (ch < 040) { 541 *cp++ = '^'; 542 *cp++ = ch | 0100; 543 continue; 544 } 545 *cp++ = '-'; 546 *cp++ = ch; 547 continue; 548 } 549 *cp++ = '\\'; 550 *cp++ = ch; 551 } 552 553 *cp = 0; 554 return conv_str; 555 } 556 557 static char * 558 mklong(const char *str, char ch) 559 { 560 static char copy[64]; 561 size_t len; 562 563 len = strlen(str) + 2; 564 if (len > sizeof copy) { 565 warnx("format %s too complex", str); 566 len = 4; 567 } 568 (void)memmove(copy, str, len - 3); 569 copy[len - 3] = 'j'; 570 copy[len - 2] = ch; 571 copy[len - 1] = '\0'; 572 return copy; 573 } 574 575 static char 576 getchr(void) 577 { 578 if (!*gargv) 579 return 0; 580 return **gargv++; 581 } 582 583 static char * 584 getstr(void) 585 { 586 static char empty[] = ""; 587 if (!*gargv) 588 return empty; 589 return *gargv++; 590 } 591 592 static int 593 getwidth(void) 594 { 595 unsigned long val; 596 char *s, *ep; 597 598 s = *gargv; 599 if (!*gargv) 600 return (0); 601 gargv++; 602 603 errno = 0; 604 val = strtoul(s, &ep, 0); 605 check_conversion(s, ep); 606 607 /* Arbitrarily 'restrict' field widths to 1Mbyte */ 608 if (val > 1 << 20) { 609 warnx("%s: invalid field width", s); 610 return 0; 611 } 612 613 return (int)val; 614 } 615 616 static intmax_t 617 getintmax(void) 618 { 619 intmax_t val; 620 char *cp, *ep; 621 622 cp = *gargv; 623 if (cp == NULL) 624 return 0; 625 gargv++; 626 627 if (*cp == '\"' || *cp == '\'') 628 return *(cp + 1); 629 630 errno = 0; 631 val = strtoimax(cp, &ep, 0); 632 check_conversion(cp, ep); 633 return val; 634 } 635 636 static uintmax_t 637 getuintmax(void) 638 { 639 uintmax_t val; 640 char *cp, *ep; 641 642 cp = *gargv; 643 if (cp == NULL) 644 return 0; 645 gargv++; 646 647 if (*cp == '\"' || *cp == '\'') 648 return (uintmax_t)*(cp + 1); 649 650 /* strtoumax won't error -ve values */ 651 while (isspace(*(unsigned char *)cp)) 652 cp++; 653 if (*cp == '-') { 654 warnx("%s: expected positive numeric value", cp); 655 rval = 1; 656 return 0; 657 } 658 659 errno = 0; 660 val = strtoumax(cp, &ep, 0); 661 check_conversion(cp, ep); 662 return val; 663 } 664 665 static double 666 getdouble(void) 667 { 668 double val; 669 char *ep; 670 671 if (!*gargv) 672 return (0.0); 673 674 if (**gargv == '\"' || **gargv == '\'') 675 return (double) *((*gargv++)+1); 676 677 errno = 0; 678 val = strtod(*gargv, &ep); 679 check_conversion(*gargv++, ep); 680 return val; 681 } 682 683 static void 684 check_conversion(const char *s, const char *ep) 685 { 686 if (*ep) { 687 if (ep == s) 688 warnx("%s: expected numeric value", s); 689 else 690 warnx("%s: not completely converted", s); 691 rval = 1; 692 } else if (errno == ERANGE) { 693 warnx("%s: %s", s, strerror(ERANGE)); 694 rval = 1; 695 } 696 } 697 698 static void 699 usage(void) 700 { 701 (void)fprintf(stderr, "Usage: %s format [arg ...]\n", getprogname()); 702 } 703
Indexes created Thu Sep 25 16:09:42 GMT 2025