Commit | Line | Data |
---|---|---|
24f98398 JA |
1 | /* Output like sprintf to a buffer of specified size. |
2 | Also takes args differently: pass one pointer to an array of strings | |
3 | in addition to the format string which is separate. | |
429ab54e | 4 | Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005, |
5df4f04c | 5 | 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. |
24f98398 JA |
6 | |
7 | This file is part of GNU Emacs. | |
8 | ||
9ec0b715 | 9 | GNU Emacs is free software: you can redistribute it and/or modify |
24f98398 | 10 | it under the terms of the GNU General Public License as published by |
9ec0b715 GM |
11 | the Free Software Foundation, either version 3 of the License, or |
12 | (at your option) any later version. | |
24f98398 JA |
13 | |
14 | GNU Emacs is distributed in the hope that it will be useful, | |
15 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | GNU General Public License for more details. | |
18 | ||
19 | You should have received a copy of the GNU General Public License | |
9ec0b715 | 20 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
24f98398 JA |
21 | |
22 | ||
6d291527 | 23 | #include <config.h> |
24f98398 JA |
24 | #include <stdio.h> |
25 | #include <ctype.h> | |
d7306fe6 | 26 | #include <setjmp.h> |
24f98398 | 27 | |
cf09633a | 28 | #ifdef STDC_HEADERS |
be65c2f4 PE |
29 | #include <float.h> |
30 | #endif | |
31 | ||
48236137 DL |
32 | #ifdef HAVE_UNISTD_H |
33 | #include <unistd.h> | |
34 | #endif | |
35 | ||
523e9291 RS |
36 | #include "lisp.h" |
37 | ||
a0ca925c KH |
38 | /* Since we use the macro CHAR_HEAD_P, we have to include this, but |
39 | don't have to include others because CHAR_HEAD_P does not contains | |
40 | another macro. */ | |
83be827a | 41 | #include "character.h" |
a0ca925c | 42 | |
92bc9a36 DN |
43 | #ifndef DBL_MAX_10_EXP |
44 | #define DBL_MAX_10_EXP 308 /* IEEE double */ | |
45 | #endif | |
46 | ||
f4c730d3 RS |
47 | /* Generate output from a format-spec FORMAT, |
48 | terminated at position FORMAT_END. | |
49 | Output goes in BUFFER, which has room for BUFSIZE chars. | |
50 | If the output does not fit, truncate it to fit. | |
6afc669e | 51 | Returns the number of bytes stored into BUFFER. |
f4c730d3 | 52 | ARGS points to the vector of arguments, and NARGS says how many. |
1513af9e RS |
53 | A double counts as two arguments. |
54 | String arguments are passed as C strings. | |
55 | Integers are passed as C integers. */ | |
f4c730d3 | 56 | |
84c9ce05 | 57 | EMACS_INT |
a8fe7202 AS |
58 | doprnt (char *buffer, register int bufsize, const char *format, |
59 | const char *format_end, va_list ap) | |
24f98398 | 60 | { |
a8fe7202 | 61 | const char *fmt = format; /* Pointer into format string */ |
24f98398 | 62 | register char *bufptr = buffer; /* Pointer into output buffer.. */ |
03383aaf | 63 | |
f4c730d3 | 64 | /* Use this for sprintf unless we need something really big. */ |
be65c2f4 | 65 | char tembuf[DBL_MAX_10_EXP + 100]; |
03383aaf | 66 | |
f4c730d3 | 67 | /* Size of sprintf_buffer. */ |
01769a73 | 68 | unsigned size_allocated = sizeof (tembuf); |
03383aaf | 69 | |
f4c730d3 RS |
70 | /* Buffer to use for sprintf. Either tembuf or same as BIG_BUFFER. */ |
71 | char *sprintf_buffer = tembuf; | |
03383aaf | 72 | |
f4c730d3 RS |
73 | /* Buffer we have got with malloc. */ |
74 | char *big_buffer = 0; | |
03383aaf | 75 | |
24f98398 | 76 | register int tem; |
c292461f | 77 | unsigned char *string; |
03383aaf BF |
78 | char fixed_buffer[20]; /* Default buffer for small formatting. */ |
79 | char *fmtcpy; | |
24f98398 | 80 | int minlen; |
1f625c6c | 81 | unsigned char charbuf[MAX_MULTIBYTE_LENGTH + 1]; /* Used for %c. */ |
24f98398 JA |
82 | |
83 | if (format_end == 0) | |
84 | format_end = format + strlen (format); | |
85 | ||
03383aaf BF |
86 | if ((format_end - format + 1) < sizeof (fixed_buffer)) |
87 | fmtcpy = fixed_buffer; | |
88 | else | |
91098d38 | 89 | fmtcpy = (char *) alloca (format_end - format + 1); |
03383aaf | 90 | |
24f98398 | 91 | bufsize--; |
03383aaf BF |
92 | |
93 | /* Loop until end of format string or buffer full. */ | |
94 | while (fmt != format_end && bufsize > 0) | |
24f98398 JA |
95 | { |
96 | if (*fmt == '%') /* Check for a '%' character */ | |
97 | { | |
01769a73 | 98 | unsigned size_bound = 0; |
84c9ce05 | 99 | EMACS_INT width; /* Columns occupied by STRING. */ |
f4c730d3 | 100 | |
24f98398 | 101 | fmt++; |
d427b66a | 102 | /* Copy this one %-spec into fmtcpy. */ |
01769a73 | 103 | string = (unsigned char *) fmtcpy; |
24f98398 | 104 | *string++ = '%'; |
03383aaf | 105 | while (1) |
24f98398 JA |
106 | { |
107 | *string++ = *fmt; | |
be65c2f4 PE |
108 | if ('0' <= *fmt && *fmt <= '9') |
109 | { | |
110 | /* Get an idea of how much space we might need. | |
111 | This might be a field width or a precision; e.g. | |
112 | %1.1000f and %1000.1f both might need 1000+ bytes. | |
113 | Parse the width or precision, checking for overflow. */ | |
01769a73 | 114 | unsigned n = *fmt - '0'; |
be65c2f4 PE |
115 | while ('0' <= fmt[1] && fmt[1] <= '9') |
116 | { | |
26898943 | 117 | if (n * 10 + fmt[1] - '0' < n) |
be65c2f4 | 118 | error ("Format width or precision too large"); |
26898943 | 119 | n = n * 10 + fmt[1] - '0'; |
be65c2f4 PE |
120 | *string++ = *++fmt; |
121 | } | |
122 | ||
123 | if (size_bound < n) | |
124 | size_bound = n; | |
125 | } | |
01769a73 | 126 | else if (*fmt == '-' || *fmt == ' ' || *fmt == '.' || *fmt == '+') |
be65c2f4 PE |
127 | ; |
128 | else | |
24f98398 JA |
129 | break; |
130 | fmt++; | |
131 | } | |
132 | *string = 0; | |
03383aaf | 133 | |
be65c2f4 PE |
134 | /* Make the size bound large enough to handle floating point formats |
135 | with large numbers. */ | |
01769a73 | 136 | if (size_bound + DBL_MAX_10_EXP + 50 < size_bound) |
be65c2f4 | 137 | error ("Format width or precision too large"); |
01769a73 | 138 | size_bound += DBL_MAX_10_EXP + 50; |
6e951728 | 139 | |
f4c730d3 RS |
140 | /* Make sure we have that much. */ |
141 | if (size_bound > size_allocated) | |
142 | { | |
143 | if (big_buffer) | |
144 | big_buffer = (char *) xrealloc (big_buffer, size_bound); | |
145 | else | |
146 | big_buffer = (char *) xmalloc (size_bound); | |
147 | sprintf_buffer = big_buffer; | |
148 | size_allocated = size_bound; | |
149 | } | |
24f98398 JA |
150 | minlen = 0; |
151 | switch (*fmt++) | |
152 | { | |
153 | default: | |
154 | error ("Invalid format operation %%%c", fmt[-1]); | |
155 | ||
156 | /* case 'b': */ | |
157 | case 'd': | |
158 | case 'o': | |
159 | case 'x': | |
f9fa352f RS |
160 | if (sizeof (int) == sizeof (EMACS_INT)) |
161 | ; | |
162 | else if (sizeof (long) == sizeof (EMACS_INT)) | |
163 | /* Insert an `l' the right place. */ | |
164 | string[1] = string[0], | |
165 | string[0] = string[-1], | |
166 | string[-1] = 'l', | |
167 | string++; | |
168 | else | |
169 | abort (); | |
6a8033e1 | 170 | sprintf (sprintf_buffer, fmtcpy, va_arg(ap, char *)); |
f4c730d3 | 171 | /* Now copy into final output, truncating as nec. */ |
01769a73 | 172 | string = (unsigned char *) sprintf_buffer; |
24f98398 JA |
173 | goto doit; |
174 | ||
f4c730d3 RS |
175 | case 'f': |
176 | case 'e': | |
177 | case 'g': | |
178 | { | |
6a8033e1 KR |
179 | double d = va_arg(ap, double); |
180 | sprintf (sprintf_buffer, fmtcpy, d); | |
f4c730d3 | 181 | /* Now copy into final output, truncating as nec. */ |
01769a73 | 182 | string = (unsigned char *) sprintf_buffer; |
f4c730d3 RS |
183 | goto doit; |
184 | } | |
185 | ||
24f98398 JA |
186 | case 'S': |
187 | string[-1] = 's'; | |
188 | case 's': | |
24f98398 JA |
189 | if (fmtcpy[1] != 's') |
190 | minlen = atoi (&fmtcpy[1]); | |
6a8033e1 | 191 | string = va_arg(ap, unsigned char *); |
e267324c | 192 | tem = strlen (string); |
a0ca925c | 193 | width = strwidth (string, tem); |
1513af9e RS |
194 | goto doit1; |
195 | ||
24f98398 JA |
196 | /* Copy string into final output, truncating if no room. */ |
197 | doit: | |
a0ca925c KH |
198 | /* Coming here means STRING contains ASCII only. */ |
199 | width = tem = strlen (string); | |
35a65fce | 200 | doit1: |
a0ca925c KH |
201 | /* We have already calculated: |
202 | TEM -- length of STRING, | |
203 | WIDTH -- columns occupied by STRING when displayed, and | |
204 | MINLEN -- minimum columns of the output. */ | |
24f98398 JA |
205 | if (minlen > 0) |
206 | { | |
a0ca925c | 207 | while (minlen > width && bufsize > 0) |
24f98398 JA |
208 | { |
209 | *bufptr++ = ' '; | |
210 | bufsize--; | |
211 | minlen--; | |
212 | } | |
213 | minlen = 0; | |
214 | } | |
215 | if (tem > bufsize) | |
a0ca925c KH |
216 | { |
217 | /* Truncate the string at character boundary. */ | |
218 | tem = bufsize; | |
a50545d9 | 219 | while (!CHAR_HEAD_P (string[tem - 1])) tem--; |
72af86bd | 220 | memcpy (bufptr, string, tem); |
a0ca925c KH |
221 | /* We must calculate WIDTH again. */ |
222 | width = strwidth (bufptr, tem); | |
223 | } | |
224 | else | |
72af86bd | 225 | memcpy (bufptr, string, tem); |
24f98398 JA |
226 | bufptr += tem; |
227 | bufsize -= tem; | |
228 | if (minlen < 0) | |
229 | { | |
a0ca925c | 230 | while (minlen < - width && bufsize > 0) |
24f98398 JA |
231 | { |
232 | *bufptr++ = ' '; | |
233 | bufsize--; | |
234 | minlen++; | |
235 | } | |
236 | minlen = 0; | |
237 | } | |
238 | continue; | |
239 | ||
240 | case 'c': | |
6a8033e1 KR |
241 | { |
242 | /* Sometimes for %c we pass a char, which would widen | |
243 | to int. Sometimes we pass XFASTINT() or XINT() | |
244 | values, which would be EMACS_INT. Let's hope that | |
245 | both are passed the same way, otherwise we'll need | |
246 | to rewrite callers. */ | |
247 | EMACS_INT chr = va_arg(ap, EMACS_INT); | |
248 | tem = CHAR_STRING ((int) chr, charbuf); | |
249 | string = charbuf; | |
250 | string[tem] = 0; | |
251 | width = strwidth (string, tem); | |
252 | if (fmtcpy[1] != 'c') | |
253 | minlen = atoi (&fmtcpy[1]); | |
254 | goto doit1; | |
255 | } | |
24f98398 JA |
256 | |
257 | case '%': | |
258 | fmt--; /* Drop thru and this % will be treated as normal */ | |
259 | } | |
260 | } | |
a0ca925c KH |
261 | |
262 | { | |
263 | /* Just some character; Copy it if the whole multi-byte form | |
264 | fit in the buffer. */ | |
265 | char *save_bufptr = bufptr; | |
266 | ||
267 | do { *bufptr++ = *fmt++; } | |
a50545d9 RS |
268 | while (--bufsize > 0 && !CHAR_HEAD_P (*fmt)); |
269 | if (!CHAR_HEAD_P (*fmt)) | |
a0ca925c KH |
270 | { |
271 | bufptr = save_bufptr; | |
272 | break; | |
273 | } | |
274 | } | |
24f98398 JA |
275 | }; |
276 | ||
f4c730d3 | 277 | /* If we had to malloc something, free it. */ |
70fdbb46 | 278 | xfree (big_buffer); |
f4c730d3 | 279 | |
24f98398 JA |
280 | *bufptr = 0; /* Make sure our string end with a '\0' */ |
281 | return bufptr - buffer; | |
282 | } | |
6b61353c KH |
283 | |
284 | /* arch-tag: aa0ab528-7c5f-4c73-894c-aa2526a1efb3 | |
285 | (do not change this comment) */ |