End of Lab1
[akaros.git] / lib / printfmt.c
1 // Stripped-down primitive printf-style formatting routines,
2 // used in common by printf, sprintf, fprintf, etc.
3 // This code is also used by both the kernel and user programs.
4
5 #include <inc/types.h>
6 #include <inc/stdio.h>
7 #include <inc/string.h>
8 #include <inc/stdarg.h>
9 #include <inc/error.h>
10
11 /*
12  * Space or zero padding and a field width are supported for the numeric
13  * formats only. 
14  * 
15  * The special format %e takes an integer error code
16  * and prints a string describing the error.
17  * The integer may be positive or negative,
18  * so that -E_NO_MEM and E_NO_MEM are equivalent.
19  */
20
21 static const char * const error_string[MAXERROR + 1] =
22 {
23         NULL,
24         "unspecified error",
25         "bad environment",
26         "invalid parameter",
27         "out of memory",
28         "out of environments",
29         "segmentation fault",
30 };
31
32 /*
33  * Print a number (base <= 16) in reverse order,
34  * using specified putch function and associated pointer putdat.
35  */
36 static void
37 printnum(void (*putch)(int, void*), void *putdat,
38          unsigned long long num, unsigned base, int width, int padc)
39 {
40         // first recursively print all preceding (more significant) digits
41         if (num >= base) {
42                 printnum(putch, putdat, num / base, base, width - 1, padc);
43         } else {
44                 // print any needed pad characters before first digit
45                 while (--width > 0)
46                         putch(padc, putdat);
47         }
48
49         // then print this (the least significant) digit
50         putch("0123456789abcdef"[num % base], putdat);
51 }
52
53 // Get an unsigned int of various possible sizes from a varargs list,
54 // depending on the lflag parameter.
55 static unsigned long long
56 getuint(va_list *ap, int lflag)
57 {
58         if (lflag >= 2)
59                 return va_arg(*ap, unsigned long long);
60         else if (lflag)
61                 return va_arg(*ap, unsigned long);
62         else
63                 return va_arg(*ap, unsigned int);
64 }
65
66 // Same as getuint but signed - can't use getuint
67 // because of sign extension
68 static long long
69 getint(va_list *ap, int lflag)
70 {
71         if (lflag >= 2)
72                 return va_arg(*ap, long long);
73         else if (lflag)
74                 return va_arg(*ap, long);
75         else
76                 return va_arg(*ap, int);
77 }
78
79
80 // Main function to format and print a string.
81 void printfmt(void (*putch)(int, void*), void *putdat, const char *fmt, ...);
82
83 void
84 vprintfmt(void (*putch)(int, void*), void *putdat, const char *fmt, va_list ap)
85 {
86         register const char *p;
87         register int ch, err;
88         unsigned long long num;
89         int base, lflag, width, precision, altflag;
90         char padc;
91
92         while (1) {
93                 while ((ch = *(unsigned char *) fmt++) != '%') {
94                         if (ch == '\0')
95                                 return;
96                         putch(ch, putdat);
97                 }
98
99                 // Process a %-escape sequence
100                 padc = ' ';
101                 width = -1;
102                 precision = -1;
103                 lflag = 0;
104                 altflag = 0;
105         reswitch:
106                 switch (ch = *(unsigned char *) fmt++) {
107
108                 // flag to pad on the right
109                 case '-':
110                         padc = '-';
111                         goto reswitch;
112                         
113                 // flag to pad with 0's instead of spaces
114                 case '0':
115                         padc = '0';
116                         goto reswitch;
117
118                 // width field
119                 case '1':
120                 case '2':
121                 case '3':
122                 case '4':
123                 case '5':
124                 case '6':
125                 case '7':
126                 case '8':
127                 case '9':
128                         for (precision = 0; ; ++fmt) {
129                                 precision = precision * 10 + ch - '0';
130                                 ch = *fmt;
131                                 if (ch < '0' || ch > '9')
132                                         break;
133                         }
134                         goto process_precision;
135
136                 case '*':
137                         precision = va_arg(ap, int);
138                         goto process_precision;
139
140                 case '.':
141                         if (width < 0)
142                                 width = 0;
143                         goto reswitch;
144
145                 case '#':
146                         altflag = 1;
147                         goto reswitch;
148
149                 process_precision:
150                         if (width < 0)
151                                 width = precision, precision = -1;
152                         goto reswitch;
153
154                 // long flag (doubled for long long)
155                 case 'l':
156                         lflag++;
157                         goto reswitch;
158
159                 // character
160                 case 'c':
161                         putch(va_arg(ap, int), putdat);
162                         break;
163
164                 // error message
165                 case 'e':
166                         err = va_arg(ap, int);
167                         if (err < 0)
168                                 err = -err;
169                         if (err > MAXERROR || (p = error_string[err]) == NULL)
170                                 printfmt(putch, putdat, "error %d", err);
171                         else
172                                 printfmt(putch, putdat, "%s", p);
173                         break;
174
175                 // string
176                 case 's':
177                         if ((p = va_arg(ap, char *)) == NULL)
178                                 p = "(null)";
179                         if (width > 0 && padc != '-')
180                                 for (width -= strnlen(p, precision); width > 0; width--)
181                                         putch(padc, putdat);
182                         for (; (ch = *p++) != '\0' && (precision < 0 || --precision >= 0); width--)
183                                 if (altflag && (ch < ' ' || ch > '~'))
184                                         putch('?', putdat);
185                                 else
186                                         putch(ch, putdat);
187                         for (; width > 0; width--)
188                                 putch(' ', putdat);
189                         break;
190
191                 // (signed) decimal
192                 case 'd':
193                         num = getint(&ap, lflag);
194                         if ((long long) num < 0) {
195                                 putch('-', putdat);
196                                 num = -(long long) num;
197                         }
198                         base = 10;
199                         goto number;
200
201                 // unsigned decimal
202                 case 'u':
203                         num = getuint(&ap, lflag);
204                         base = 10;
205                         goto number;
206
207                 // (unsigned) octal
208                 case 'o':
209                         // should do something with padding so it's always 3 octits
210                         num = getuint(&ap, lflag);
211                         base = 8;
212                         goto number;
213
214                 // pointer
215                 case 'p':
216                         putch('0', putdat);
217                         putch('x', putdat);
218                         num = (unsigned long long)
219                                 (uintptr_t) va_arg(ap, void *);
220                         base = 16;
221                         goto number;
222
223                 // (unsigned) hexadecimal
224                 case 'x':
225                         num = getuint(&ap, lflag);
226                         base = 16;
227                 number:
228                         printnum(putch, putdat, num, base, width, padc);
229                         break;
230
231                 // escaped '%' character
232                 case '%':
233                         putch(ch, putdat);
234                         break;
235                         
236                 // unrecognized escape sequence - just print it literally
237                 default:
238                         putch('%', putdat);
239                         for (fmt--; fmt[-1] != '%'; fmt--)
240                                 /* do nothing */;
241                         break;
242                 }
243         }
244 }
245
246 void
247 printfmt(void (*putch)(int, void*), void *putdat, const char *fmt, ...)
248 {
249         va_list ap;
250
251         va_start(ap, fmt);
252         vprintfmt(putch, putdat, fmt, ap);
253         va_end(ap);
254 }
255
256 struct sprintbuf {
257         char *buf;
258         char *ebuf;
259         int cnt;
260 };
261
262 static void
263 sprintputch(int ch, struct sprintbuf *b)
264 {
265         b->cnt++;
266         if (b->buf < b->ebuf)
267                 *b->buf++ = ch;
268 }
269
270 int
271 vsnprintf(char *buf, int n, const char *fmt, va_list ap)
272 {
273         struct sprintbuf b = {buf, buf+n-1, 0};
274
275         if (buf == NULL || n < 1)
276                 return -E_INVAL;
277
278         // print the string to the buffer
279         vprintfmt((void*)sprintputch, &b, fmt, ap);
280
281         // null terminate the buffer
282         *b.buf = '\0';
283
284         return b.cnt;
285 }
286
287 int
288 snprintf(char *buf, int n, const char *fmt, ...)
289 {
290         va_list ap;
291         int rc;
292
293         va_start(ap, fmt);
294         rc = vsnprintf(buf, n, fmt, ap);
295         va_end(ap);
296
297         return rc;
298 }
299
300