blob: a9ef61f68f327bada1c8ae69f361e056cbf99500 [file] [log] [blame]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001/* vi: set sw=4 ts=4: */
Eric Andersencc8ed391999-10-05 16:24:54 +00002/* printf - format and print data
Eric Andersencc8ed391999-10-05 16:24:54 +00003
Rob Landley251161f2006-01-06 20:28:05 +00004 Copyright 1999 Dave Cinege
5 Portions copyright (C) 1990-1996 Free Software Foundation, Inc.
Eric Andersencc8ed391999-10-05 16:24:54 +00006
Rob Landley251161f2006-01-06 20:28:05 +00007 Licensed under GPL v2 or later, see file LICENSE in this tarball for details.
8*/
Eric Andersencc8ed391999-10-05 16:24:54 +00009
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
Denis Vlasenko13858992006-10-08 12:49:22 +000033 The 'format' argument is re-used as many times as necessary
Eric Andersencc8ed391999-10-05 16:24:54 +000034 to convert all of the given arguments.
35
36 David MacKenzie <djm@gnu.ai.mit.edu> */
Erik Andersene49d5ec2000-02-08 19:58:47 +000037
Eric Andersencc8ed391999-10-05 16:24:54 +000038
39// 19990508 Busy Boxed! Dave Cinege
40
Denis Vlasenkob6adbf12007-05-26 19:00:18 +000041#include "libbb.h"
Eric Andersencc8ed391999-10-05 16:24:54 +000042
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +000043typedef void (*converter)(const char *arg, void *result);
Denis Vlasenkoc2905632006-09-23 16:01:09 +000044
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +000045static void multiconvert(const char *arg, void *result, converter convert)
Rob Landley251161f2006-01-06 20:28:05 +000046{
Denis Vlasenko339f5eb2007-03-09 16:43:01 +000047 char s[sizeof(int)*3 + 2];
48
Rob Landley251161f2006-01-06 20:28:05 +000049 if (*arg == '"' || *arg == '\'') {
Denis Vlasenkod686a042006-11-27 14:43:21 +000050 sprintf(s, "%d", (unsigned char)arg[1]);
Denis Vlasenkoc2905632006-09-23 16:01:09 +000051 arg = s;
Rob Landley251161f2006-01-06 20:28:05 +000052 }
Denis Vlasenkod686a042006-11-27 14:43:21 +000053 convert(arg, result);
Denis Vlasenko339f5eb2007-03-09 16:43:01 +000054 /* if there was conversion error, print unconverted string */
55 if (errno)
Denis Vlasenkoc2905632006-09-23 16:01:09 +000056 fputs(arg, stderr);
Rob Landley251161f2006-01-06 20:28:05 +000057}
Tim Rikerc1ef7bd2006-01-25 00:08:53 +000058
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +000059static void conv_strtoul(const char *arg, void *result)
Denis Vlasenkod686a042006-11-27 14:43:21 +000060{
Denis Vlasenko339f5eb2007-03-09 16:43:01 +000061 *(unsigned long*)result = bb_strtoul(arg, NULL, 0);
Denis Vlasenkod686a042006-11-27 14:43:21 +000062}
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +000063static void conv_strtol(const char *arg, void *result)
Denis Vlasenkod686a042006-11-27 14:43:21 +000064{
Denis Vlasenko339f5eb2007-03-09 16:43:01 +000065 *(long*)result = bb_strtol(arg, NULL, 0);
Denis Vlasenkod686a042006-11-27 14:43:21 +000066}
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +000067static void conv_strtod(const char *arg, void *result)
Denis Vlasenkod686a042006-11-27 14:43:21 +000068{
69 char *end;
70 /* Well, this one allows leading whitespace... so what */
71 /* What I like much less is that "-" is accepted too! :( */
72 *(double*)result = strtod(arg, &end);
73 if (end[0]) errno = ERANGE;
74}
75
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +000076static unsigned long my_xstrtoul(const char *arg)
Rob Landley251161f2006-01-06 20:28:05 +000077{
78 unsigned long result;
Denis Vlasenkod686a042006-11-27 14:43:21 +000079 multiconvert(arg, &result, conv_strtoul);
Rob Landley251161f2006-01-06 20:28:05 +000080 return result;
81}
82
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +000083static long my_xstrtol(const char *arg)
Rob Landley251161f2006-01-06 20:28:05 +000084{
85 long result;
Denis Vlasenkod686a042006-11-27 14:43:21 +000086 multiconvert(arg, &result, conv_strtol);
Rob Landley251161f2006-01-06 20:28:05 +000087 return result;
88}
89
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +000090static double my_xstrtod(const char *arg)
Rob Landley251161f2006-01-06 20:28:05 +000091{
92 double result;
Denis Vlasenkod686a042006-11-27 14:43:21 +000093 multiconvert(arg, &result, conv_strtod);
Rob Landley251161f2006-01-06 20:28:05 +000094 return result;
95}
96
97static void print_esc_string(char *str)
98{
99 for (; *str; str++) {
100 if (*str == '\\') {
101 str++;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000102 bb_putchar(bb_process_escape_sequence((const char **)&str));
Rob Landley251161f2006-01-06 20:28:05 +0000103 } else {
Denis Vlasenko4daad902007-09-27 10:20:47 +0000104 bb_putchar(*str);
Rob Landley251161f2006-01-06 20:28:05 +0000105 }
106
107 }
108}
109
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000110static void print_direc(char *start, size_t length, int field_width, int precision,
111 const char *argument)
Eric Andersencc8ed391999-10-05 16:24:54 +0000112{
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000113 char *p; /* Null-terminated copy of % directive. */
Eric Andersencc8ed391999-10-05 16:24:54 +0000114
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000115 p = xmalloc((unsigned) (length + 1));
116 strncpy(p, start, length);
117 p[length] = 0;
118
119 switch (p[length - 1]) {
120 case 'd':
121 case 'i':
122 if (field_width < 0) {
123 if (precision < 0)
124 printf(p, my_xstrtol(argument));
125 else
126 printf(p, precision, my_xstrtol(argument));
127 } else {
128 if (precision < 0)
129 printf(p, field_width, my_xstrtol(argument));
130 else
131 printf(p, field_width, precision, my_xstrtol(argument));
132 }
133 break;
134 case 'o':
135 case 'u':
136 case 'x':
137 case 'X':
138 if (field_width < 0) {
139 if (precision < 0)
140 printf(p, my_xstrtoul(argument));
141 else
142 printf(p, precision, my_xstrtoul(argument));
143 } else {
144 if (precision < 0)
145 printf(p, field_width, my_xstrtoul(argument));
146 else
147 printf(p, field_width, precision, my_xstrtoul(argument));
148 }
149 break;
150 case 'f':
151 case 'e':
152 case 'E':
153 case 'g':
154 case 'G':
155 if (field_width < 0) {
156 if (precision < 0)
157 printf(p, my_xstrtod(argument));
158 else
159 printf(p, precision, my_xstrtod(argument));
160 } else {
161 if (precision < 0)
162 printf(p, field_width, my_xstrtod(argument));
163 else
164 printf(p, field_width, precision, my_xstrtod(argument));
165 }
166 break;
167 case 'c':
168 printf(p, *argument);
169 break;
170 case 's':
171 if (field_width < 0) {
172 if (precision < 0)
173 printf(p, argument);
174 else
175 printf(p, precision, argument);
176 } else {
177 if (precision < 0)
178 printf(p, field_width, argument);
179 else
180 printf(p, field_width, precision, argument);
181 }
182 break;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000183 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000184
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000185 free(p);
Eric Andersencc8ed391999-10-05 16:24:54 +0000186}
187
188/* Print the text in FORMAT, using ARGV (with ARGC elements) for
Denis Vlasenko13858992006-10-08 12:49:22 +0000189 arguments to any '%' directives.
Eric Andersencc8ed391999-10-05 16:24:54 +0000190 Return the number of elements of ARGV used. */
191
Erik Andersene49d5ec2000-02-08 19:58:47 +0000192static int print_formatted(char *format, int argc, char **argv)
Eric Andersencc8ed391999-10-05 16:24:54 +0000193{
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000194 int save_argc = argc; /* Preserve original value. */
195 char *f; /* Pointer into 'format'. */
196 char *direc_start; /* Start of % directive. */
197 size_t direc_length; /* Length of % directive. */
198 int field_width; /* Arg to first '*', or -1 if none. */
199 int precision; /* Arg to second '*', or -1 if none. */
Eric Andersencc8ed391999-10-05 16:24:54 +0000200
Erik Andersene49d5ec2000-02-08 19:58:47 +0000201 for (f = format; *f; ++f) {
202 switch (*f) {
203 case '%':
204 direc_start = f++;
205 direc_length = 1;
206 field_width = precision = -1;
207 if (*f == '%') {
Denis Vlasenko4daad902007-09-27 10:20:47 +0000208 bb_putchar('%');
Erik Andersene49d5ec2000-02-08 19:58:47 +0000209 break;
210 }
211 if (*f == 'b') {
212 if (argc > 0) {
213 print_esc_string(*argv);
214 ++argv;
215 --argc;
216 }
217 break;
218 }
219 if (strchr("-+ #", *f)) {
220 ++f;
221 ++direc_length;
222 }
223 if (*f == '*') {
224 ++f;
225 ++direc_length;
226 if (argc > 0) {
Denis Vlasenko13858992006-10-08 12:49:22 +0000227 field_width = my_xstrtoul(*argv);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000228 ++argv;
229 --argc;
230 } else
231 field_width = 0;
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000232 } else {
Glenn L McGrath240a91d2004-09-15 02:05:23 +0000233 while (isdigit(*f)) {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000234 ++f;
235 ++direc_length;
236 }
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000237 }
Erik Andersene49d5ec2000-02-08 19:58:47 +0000238 if (*f == '.') {
239 ++f;
240 ++direc_length;
241 if (*f == '*') {
242 ++f;
243 ++direc_length;
244 if (argc > 0) {
Denis Vlasenko13858992006-10-08 12:49:22 +0000245 precision = my_xstrtoul(*argv);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000246 ++argv;
247 --argc;
248 } else
249 precision = 0;
250 } else
Glenn L McGrath240a91d2004-09-15 02:05:23 +0000251 while (isdigit(*f)) {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000252 ++f;
253 ++direc_length;
254 }
255 }
256 if (*f == 'l' || *f == 'L' || *f == 'h') {
257 ++f;
258 ++direc_length;
259 }
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000260 /*
Denis Vlasenkoc2905632006-09-23 16:01:09 +0000261 if (!strchr ("diouxXfeEgGcs", *f))
262 fprintf(stderr, "%%%c: invalid directive", *f);
263 */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000264 ++direc_length;
265 if (argc > 0) {
266 print_direc(direc_start, direc_length, field_width,
267 precision, *argv);
268 ++argv;
269 --argc;
270 } else
271 print_direc(direc_start, direc_length, field_width,
272 precision, "");
273 break;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000274 case '\\':
Glenn L McGrath240a91d2004-09-15 02:05:23 +0000275 if (*++f == 'c')
276 exit(0);
Denis Vlasenko4daad902007-09-27 10:20:47 +0000277 bb_putchar(bb_process_escape_sequence((const char **)&f));
Glenn L McGrath240a91d2004-09-15 02:05:23 +0000278 f--;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000279 break;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000280 default:
Denis Vlasenko4daad902007-09-27 10:20:47 +0000281 bb_putchar(*f);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000282 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000283 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000284
Erik Andersene49d5ec2000-02-08 19:58:47 +0000285 return save_argc - argc;
Eric Andersencc8ed391999-10-05 16:24:54 +0000286}
287
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000288int printf_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000289int printf_main(int argc, char **argv)
Eric Andersencc8ed391999-10-05 16:24:54 +0000290{
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000291 char *format;
292 int args_used;
Eric Andersencc8ed391999-10-05 16:24:54 +0000293
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000294 if (argc <= 1 || argv[1][0] == '-') {
295 bb_show_usage();
Eric Andersencc8ed391999-10-05 16:24:54 +0000296 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000297
Denis Vlasenko339f5eb2007-03-09 16:43:01 +0000298 format = argv[1];
299 argc -= 2;
300 argv += 2;
301
302 do {
303 args_used = print_formatted(format, argc, argv);
304 argc -= args_used;
305 argv += args_used;
306 } while (args_used > 0 && argc > 0);
307
308/* if (argc > 0)
309 fprintf(stderr, "excess args ignored");
310*/
311
312 return EXIT_SUCCESS;
Eric Andersencc8ed391999-10-05 16:24:54 +0000313}