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, |
114f9c96 | 5 | 2006, 2007, 2008, 2009, 2010 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 | ||
36 | #ifdef HAVE_STDLIB_H | |
37 | #include <stdlib.h> | |
38 | #endif | |
39 | ||
523e9291 RS |
40 | #include "lisp.h" |
41 | ||
be65c2f4 PE |
42 | #ifndef DBL_MAX_10_EXP |
43 | #define DBL_MAX_10_EXP 308 /* IEEE double */ | |
44 | #endif | |
45 | ||
a0ca925c KH |
46 | /* Since we use the macro CHAR_HEAD_P, we have to include this, but |
47 | don't have to include others because CHAR_HEAD_P does not contains | |
48 | another macro. */ | |
83be827a | 49 | #include "character.h" |
a0ca925c | 50 | |
f4c730d3 RS |
51 | /* Generate output from a format-spec FORMAT, |
52 | terminated at position FORMAT_END. | |
53 | Output goes in BUFFER, which has room for BUFSIZE chars. | |
54 | If the output does not fit, truncate it to fit. | |
6afc669e | 55 | Returns the number of bytes stored into BUFFER. |
f4c730d3 | 56 | ARGS points to the vector of arguments, and NARGS says how many. |
1513af9e RS |
57 | A double counts as two arguments. |
58 | String arguments are passed as C strings. | |
59 | Integers are passed as C integers. */ | |
f4c730d3 | 60 | |
dfcf069d | 61 | int |
971de7fb | 62 | doprnt (char *buffer, register int bufsize, char *format, char *format_end, int nargs, char **args) |
24f98398 JA |
63 | { |
64 | int cnt = 0; /* Number of arg to gobble next */ | |
65 | register char *fmt = format; /* Pointer into format string */ | |
66 | register char *bufptr = buffer; /* Pointer into output buffer.. */ | |
03383aaf | 67 | |
f4c730d3 | 68 | /* Use this for sprintf unless we need something really big. */ |
be65c2f4 | 69 | char tembuf[DBL_MAX_10_EXP + 100]; |
03383aaf | 70 | |
f4c730d3 | 71 | /* Size of sprintf_buffer. */ |
01769a73 | 72 | unsigned size_allocated = sizeof (tembuf); |
03383aaf | 73 | |
f4c730d3 RS |
74 | /* Buffer to use for sprintf. Either tembuf or same as BIG_BUFFER. */ |
75 | char *sprintf_buffer = tembuf; | |
03383aaf | 76 | |
f4c730d3 RS |
77 | /* Buffer we have got with malloc. */ |
78 | char *big_buffer = 0; | |
03383aaf | 79 | |
24f98398 | 80 | register int tem; |
c292461f | 81 | unsigned char *string; |
03383aaf BF |
82 | char fixed_buffer[20]; /* Default buffer for small formatting. */ |
83 | char *fmtcpy; | |
24f98398 | 84 | int minlen; |
1f625c6c | 85 | unsigned char charbuf[MAX_MULTIBYTE_LENGTH + 1]; /* Used for %c. */ |
24f98398 JA |
86 | |
87 | if (format_end == 0) | |
88 | format_end = format + strlen (format); | |
89 | ||
03383aaf BF |
90 | if ((format_end - format + 1) < sizeof (fixed_buffer)) |
91 | fmtcpy = fixed_buffer; | |
92 | else | |
91098d38 | 93 | fmtcpy = (char *) alloca (format_end - format + 1); |
03383aaf | 94 | |
24f98398 | 95 | bufsize--; |
03383aaf BF |
96 | |
97 | /* Loop until end of format string or buffer full. */ | |
98 | while (fmt != format_end && bufsize > 0) | |
24f98398 JA |
99 | { |
100 | if (*fmt == '%') /* Check for a '%' character */ | |
101 | { | |
01769a73 | 102 | unsigned size_bound = 0; |
a0ca925c | 103 | int width; /* Columns occupied by STRING. */ |
f4c730d3 | 104 | |
24f98398 | 105 | fmt++; |
d427b66a | 106 | /* Copy this one %-spec into fmtcpy. */ |
01769a73 | 107 | string = (unsigned char *) fmtcpy; |
24f98398 | 108 | *string++ = '%'; |
03383aaf | 109 | while (1) |
24f98398 JA |
110 | { |
111 | *string++ = *fmt; | |
be65c2f4 PE |
112 | if ('0' <= *fmt && *fmt <= '9') |
113 | { | |
114 | /* Get an idea of how much space we might need. | |
115 | This might be a field width or a precision; e.g. | |
116 | %1.1000f and %1000.1f both might need 1000+ bytes. | |
117 | Parse the width or precision, checking for overflow. */ | |
01769a73 | 118 | unsigned n = *fmt - '0'; |
be65c2f4 PE |
119 | while ('0' <= fmt[1] && fmt[1] <= '9') |
120 | { | |
26898943 | 121 | if (n * 10 + fmt[1] - '0' < n) |
be65c2f4 | 122 | error ("Format width or precision too large"); |
26898943 | 123 | n = n * 10 + fmt[1] - '0'; |
be65c2f4 PE |
124 | *string++ = *++fmt; |
125 | } | |
126 | ||
127 | if (size_bound < n) | |
128 | size_bound = n; | |
129 | } | |
01769a73 | 130 | else if (*fmt == '-' || *fmt == ' ' || *fmt == '.' || *fmt == '+') |
be65c2f4 PE |
131 | ; |
132 | else | |
24f98398 JA |
133 | break; |
134 | fmt++; | |
135 | } | |
136 | *string = 0; | |
03383aaf | 137 | |
be65c2f4 PE |
138 | /* Make the size bound large enough to handle floating point formats |
139 | with large numbers. */ | |
01769a73 | 140 | if (size_bound + DBL_MAX_10_EXP + 50 < size_bound) |
be65c2f4 | 141 | error ("Format width or precision too large"); |
01769a73 | 142 | size_bound += DBL_MAX_10_EXP + 50; |
6e951728 | 143 | |
f4c730d3 RS |
144 | /* Make sure we have that much. */ |
145 | if (size_bound > size_allocated) | |
146 | { | |
147 | if (big_buffer) | |
148 | big_buffer = (char *) xrealloc (big_buffer, size_bound); | |
149 | else | |
150 | big_buffer = (char *) xmalloc (size_bound); | |
151 | sprintf_buffer = big_buffer; | |
152 | size_allocated = size_bound; | |
153 | } | |
24f98398 JA |
154 | minlen = 0; |
155 | switch (*fmt++) | |
156 | { | |
157 | default: | |
158 | error ("Invalid format operation %%%c", fmt[-1]); | |
159 | ||
160 | /* case 'b': */ | |
161 | case 'd': | |
162 | case 'o': | |
163 | case 'x': | |
164 | if (cnt == nargs) | |
6e951728 | 165 | error ("Not enough arguments for format string"); |
f9fa352f RS |
166 | if (sizeof (int) == sizeof (EMACS_INT)) |
167 | ; | |
168 | else if (sizeof (long) == sizeof (EMACS_INT)) | |
169 | /* Insert an `l' the right place. */ | |
170 | string[1] = string[0], | |
171 | string[0] = string[-1], | |
172 | string[-1] = 'l', | |
173 | string++; | |
174 | else | |
175 | abort (); | |
f4c730d3 RS |
176 | sprintf (sprintf_buffer, fmtcpy, args[cnt++]); |
177 | /* Now copy into final output, truncating as nec. */ | |
01769a73 | 178 | string = (unsigned char *) sprintf_buffer; |
24f98398 JA |
179 | goto doit; |
180 | ||
f4c730d3 RS |
181 | case 'f': |
182 | case 'e': | |
183 | case 'g': | |
184 | { | |
185 | union { double d; char *half[2]; } u; | |
186 | if (cnt + 1 == nargs) | |
fb08db45 | 187 | error ("Not enough arguments for format string"); |
f4c730d3 RS |
188 | u.half[0] = args[cnt++]; |
189 | u.half[1] = args[cnt++]; | |
190 | sprintf (sprintf_buffer, fmtcpy, u.d); | |
191 | /* Now copy into final output, truncating as nec. */ | |
01769a73 | 192 | string = (unsigned char *) sprintf_buffer; |
f4c730d3 RS |
193 | goto doit; |
194 | } | |
195 | ||
24f98398 JA |
196 | case 'S': |
197 | string[-1] = 's'; | |
198 | case 's': | |
199 | if (cnt == nargs) | |
fb08db45 | 200 | error ("Not enough arguments for format string"); |
24f98398 JA |
201 | if (fmtcpy[1] != 's') |
202 | minlen = atoi (&fmtcpy[1]); | |
e267324c KR |
203 | string = (unsigned char *) args[cnt++]; |
204 | tem = strlen (string); | |
a0ca925c | 205 | width = strwidth (string, tem); |
1513af9e RS |
206 | goto doit1; |
207 | ||
24f98398 JA |
208 | /* Copy string into final output, truncating if no room. */ |
209 | doit: | |
a0ca925c KH |
210 | /* Coming here means STRING contains ASCII only. */ |
211 | width = tem = strlen (string); | |
35a65fce | 212 | doit1: |
a0ca925c KH |
213 | /* We have already calculated: |
214 | TEM -- length of STRING, | |
215 | WIDTH -- columns occupied by STRING when displayed, and | |
216 | MINLEN -- minimum columns of the output. */ | |
24f98398 JA |
217 | if (minlen > 0) |
218 | { | |
a0ca925c | 219 | while (minlen > width && bufsize > 0) |
24f98398 JA |
220 | { |
221 | *bufptr++ = ' '; | |
222 | bufsize--; | |
223 | minlen--; | |
224 | } | |
225 | minlen = 0; | |
226 | } | |
227 | if (tem > bufsize) | |
a0ca925c KH |
228 | { |
229 | /* Truncate the string at character boundary. */ | |
230 | tem = bufsize; | |
a50545d9 | 231 | while (!CHAR_HEAD_P (string[tem - 1])) tem--; |
72af86bd | 232 | memcpy (bufptr, string, tem); |
a0ca925c KH |
233 | /* We must calculate WIDTH again. */ |
234 | width = strwidth (bufptr, tem); | |
235 | } | |
236 | else | |
72af86bd | 237 | memcpy (bufptr, string, tem); |
24f98398 JA |
238 | bufptr += tem; |
239 | bufsize -= tem; | |
240 | if (minlen < 0) | |
241 | { | |
a0ca925c | 242 | while (minlen < - width && bufsize > 0) |
24f98398 JA |
243 | { |
244 | *bufptr++ = ' '; | |
245 | bufsize--; | |
246 | minlen++; | |
247 | } | |
248 | minlen = 0; | |
249 | } | |
250 | continue; | |
251 | ||
252 | case 'c': | |
253 | if (cnt == nargs) | |
fb08db45 | 254 | error ("Not enough arguments for format string"); |
91f045df KH |
255 | tem = CHAR_STRING ((int) (EMACS_INT) args[cnt], charbuf); |
256 | string = charbuf; | |
a0ca925c KH |
257 | cnt++; |
258 | string[tem] = 0; | |
259 | width = strwidth (string, tem); | |
35a65fce RS |
260 | if (fmtcpy[1] != 'c') |
261 | minlen = atoi (&fmtcpy[1]); | |
262 | goto doit1; | |
24f98398 JA |
263 | |
264 | case '%': | |
265 | fmt--; /* Drop thru and this % will be treated as normal */ | |
266 | } | |
267 | } | |
a0ca925c KH |
268 | |
269 | { | |
270 | /* Just some character; Copy it if the whole multi-byte form | |
271 | fit in the buffer. */ | |
272 | char *save_bufptr = bufptr; | |
273 | ||
274 | do { *bufptr++ = *fmt++; } | |
a50545d9 RS |
275 | while (--bufsize > 0 && !CHAR_HEAD_P (*fmt)); |
276 | if (!CHAR_HEAD_P (*fmt)) | |
a0ca925c KH |
277 | { |
278 | bufptr = save_bufptr; | |
279 | break; | |
280 | } | |
281 | } | |
24f98398 JA |
282 | }; |
283 | ||
f4c730d3 | 284 | /* If we had to malloc something, free it. */ |
70fdbb46 | 285 | xfree (big_buffer); |
f4c730d3 | 286 | |
24f98398 JA |
287 | *bufptr = 0; /* Make sure our string end with a '\0' */ |
288 | return bufptr - buffer; | |
289 | } | |
6b61353c KH |
290 | |
291 | /* arch-tag: aa0ab528-7c5f-4c73-894c-aa2526a1efb3 | |
292 | (do not change this comment) */ |