doprnt.c 11.6 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Output like sprintf to a buffer of specified size.
2 3
   Also takes args differently: pass one pointer to the end
   of the format string in addition to the format string itself.
4
   Copyright (C) 1985, 2001-2011  Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Joseph Arceneaux's avatar
Joseph Arceneaux committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
20

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
/* If you think about replacing this with some similar standard C function of
   the printf family (such as vsnprintf), please note that this function
   supports the following Emacs-specific features:

   . For %c conversions, it produces a string with the multibyte representation
     of the (`int') argument, suitable for display in an Emacs buffer.

   . For %s and %c, when field width is specified (e.g., %25s), it accounts for
     the diplay width of each character, according to char-width-table.  That
     is, it does not assume that each character takes one column on display.

   . If the size of the buffer is not enough to produce the formatted string in
     its entirety, it makes sure that truncation does not chop the last
     character in the middle of its multibyte sequence, producing an invalid
     sequence.

   . It accepts a pointer to the end of the format string, so the format string
     could include embedded null characters.

   . It signals an error if the length of the formatted string is about to
     overflow MOST_POSITIVE_FIXNUM, to avoid producing strings longer than what
     Emacs can handle.

   OTOH, this function supports only a small subset of the standard C formatted
   output facilities.  E.g., %u and %ll are not supported, and precision is
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
   ignored %s and %c conversions.  (See below for the detailed documentation of
   what is supported.)  However, this is okay, as this function is supposed to
   be called from `error' and similar functions, and thus does not need to
   support features beyond those in `Fformat', which is used by `error' on the
   Lisp level.  */

/* This function supports the following %-sequences in the `format'
   argument:

   %s means print a string argument.
   %S is silently treated as %s, for loose compatibility with `Fformat'.
   %d means print a `signed int' argument in decimal.
   %l means print a `long int' argument in decimal.
   %o means print an `unsigned int' argument in octal.
   %x means print an `unsigned int' argument in hex.
   %e means print a `double' argument in exponential notation.
   %f means print a `double' argument in decimal-point notation.
   %g means print a `double' argument in exponential notation
      or in decimal-point notation, whichever uses fewer characters.
   %c means print a `signed int' argument as a single character.
   %% means produce a literal % character.

   A %-sequence may contain optional flag, width, and precision specifiers, as
   follows:

     %<flags><width><precision>character

   where flags is [+ -0l], width is [0-9]+, and precision is .[0-9]+

   The + flag character inserts a + before any positive number, while a space
   inserts a space before any positive number; these flags only affect %d, %l,
   %o, %x, %e, %f, and %g sequences.  The - and 0 flags affect the width
   specifier, as described below.

   The l (lower-case letter ell) flag is a `long' data type modifier: it is
   supported for %d, %o, and %x conversions of integral arguments, and means
   that the respective argument is to be treated as `long int' or `unsigned
   long int'.  The EMACS_INT data type should use this modifier.

   The width specifier supplies a lower limit for the length of the printed
   representation.  The padding, if any, normally goes on the left, but it goes
   on the right if the - flag is present.  The padding character is normally a
   space, but (for numerical arguments only) it is 0 if the 0 flag is present.
   The - flag takes precedence over the 0 flag.

   For %e, %f, and %g sequences, the number after the "." in the precision
   specifier says how many decimal places to show; if zero, the decimal point
   itself is omitted.  For %s and %S, the precision specifier is ignored.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
94

Richard M. Stallman's avatar
Richard M. Stallman committed
95
#include <config.h>
Joseph Arceneaux's avatar
Joseph Arceneaux committed
96 97
#include <stdio.h>
#include <ctype.h>
98
#include <setjmp.h>
Joseph Arceneaux's avatar
Joseph Arceneaux committed
99

100
#ifdef STDC_HEADERS
101 102 103
#include <float.h>
#endif

Dave Love's avatar
Dave Love committed
104 105
#include <unistd.h>

106 107 108 109 110
#include <limits.h>
#ifndef SIZE_MAX
# define SIZE_MAX ((size_t) -1)
#endif

111 112
#include "lisp.h"

Karl Heuer's avatar
Karl Heuer committed
113 114 115
/* Since we use the macro CHAR_HEAD_P, we have to include this, but
   don't have to include others because CHAR_HEAD_P does not contains
   another macro.  */
116
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
117

118 119 120 121
#ifndef DBL_MAX_10_EXP
#define DBL_MAX_10_EXP 308 /* IEEE double */
#endif

122 123 124 125
/* Generate output from a format-spec FORMAT,
   terminated at position FORMAT_END.
   Output goes in BUFFER, which has room for BUFSIZE chars.
   If the output does not fit, truncate it to fit.
126 127
   Returns the number of bytes stored into BUFFER, excluding
   the terminating null byte.  Output is always null-terminated.
Richard M. Stallman's avatar
Richard M. Stallman committed
128 129
   String arguments are passed as C strings.
   Integers are passed as C integers.  */
130

131 132
size_t
doprnt (char *buffer, register size_t bufsize, const char *format,
133
	const char *format_end, va_list ap)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
134
{
135
  const char *fmt = format;	/* Pointer into format string */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
136
  register char *bufptr = buffer; /* Pointer into output buffer.. */
137

138
  /* Use this for sprintf unless we need something really big.  */
139
  char tembuf[DBL_MAX_10_EXP + 100];
140

141
  /* Size of sprintf_buffer.  */
142
  size_t size_allocated = sizeof (tembuf);
143

144 145
  /* Buffer to use for sprintf.  Either tembuf or same as BIG_BUFFER.  */
  char *sprintf_buffer = tembuf;
146

147
  /* Buffer we have got with malloc.  */
148
  char *big_buffer = NULL;
149

150
  register size_t tem;
151
  char *string;
152 153
  char fixed_buffer[20];	/* Default buffer for small formatting. */
  char *fmtcpy;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
154
  int minlen;
155
  char charbuf[MAX_MULTIBYTE_LENGTH + 1];	/* Used for %c.  */
156
  USE_SAFE_ALLOCA;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
157 158 159 160

  if (format_end == 0)
    format_end = format + strlen (format);

161 162 163
  if ((format_end - format + 1) < sizeof (fixed_buffer))
    fmtcpy = fixed_buffer;
  else
164
    SAFE_ALLOCA (fmtcpy, char *, format_end - format + 1);
165

Joseph Arceneaux's avatar
Joseph Arceneaux committed
166
  bufsize--;
167 168 169

  /* Loop until end of format string or buffer full. */
  while (fmt != format_end && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
170 171 172
    {
      if (*fmt == '%')	/* Check for a '%' character */
	{
173 174 175
	  size_t size_bound = 0;
	  EMACS_INT width;  /* Columns occupied by STRING on display.  */
	  int long_flag = 0;
176

Joseph Arceneaux's avatar
Joseph Arceneaux committed
177
	  fmt++;
Jim Blandy's avatar
Jim Blandy committed
178
	  /* Copy this one %-spec into fmtcpy.  */
179
	  string = fmtcpy;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
180
	  *string++ = '%';
181
	  while (1)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
182 183
	    {
	      *string++ = *fmt;
184 185 186 187 188 189
	      if ('0' <= *fmt && *fmt <= '9')
		{
		  /* Get an idea of how much space we might need.
		     This might be a field width or a precision; e.g.
		     %1.1000f and %1000.1f both might need 1000+ bytes.
		     Parse the width or precision, checking for overflow.  */
190
		  size_t n = *fmt - '0';
191 192
		  while ('0' <= fmt[1] && fmt[1] <= '9')
		    {
193 194
		      if (n >= SIZE_MAX / 10
			  || n * 10 > SIZE_MAX - (fmt[1] - '0'))
195
			error ("Format width or precision too large");
Andreas Schwab's avatar
Andreas Schwab committed
196
		      n = n * 10 + fmt[1] - '0';
197 198 199 200 201 202
		      *string++ = *++fmt;
		    }

		  if (size_bound < n)
		    size_bound = n;
		}
203
	      else if (*fmt == '-' || *fmt == ' ' || *fmt == '.' || *fmt == '+')
204
		;
205 206 207 208 209 210 211
	      else if (*fmt == 'l')
		{
		  long_flag = 1;
		  if (!strchr ("dox", fmt[1]))
		    /* %l as conversion specifier, not as modifier.  */
		    break;
		}
212
	      else
Joseph Arceneaux's avatar
Joseph Arceneaux committed
213 214 215 216
		break;
	      fmt++;
	    }
	  *string = 0;
217

218 219
	  /* Make the size bound large enough to handle floating point formats
	     with large numbers.  */
220
	  if (size_bound > SIZE_MAX - DBL_MAX_10_EXP - 50)
221
	    error ("Format width or precision too large");
222
	  size_bound += DBL_MAX_10_EXP + 50;
223

224 225 226 227 228 229 230 231 232 233
	  /* Make sure we have that much.  */
	  if (size_bound > size_allocated)
	    {
	      if (big_buffer)
		big_buffer = (char *) xrealloc (big_buffer, size_bound);
	      else
		big_buffer = (char *) xmalloc (size_bound);
	      sprintf_buffer = big_buffer;
	      size_allocated = size_bound;
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
234 235 236 237 238 239 240
	  minlen = 0;
	  switch (*fmt++)
	    {
	    default:
	      error ("Invalid format operation %%%c", fmt[-1]);

/*	    case 'b': */
241
	    case 'l':
Joseph Arceneaux's avatar
Joseph Arceneaux committed
242
	    case 'd':
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
	      {
		int i;
		long l;

		if (long_flag)
		  {
		    l = va_arg(ap, long);
		    sprintf (sprintf_buffer, fmtcpy, l);
		  }
		else
		  {
		    i = va_arg(ap, int);
		    sprintf (sprintf_buffer, fmtcpy, i);
		  }
		/* Now copy into final output, truncating as necessary.  */
		string = sprintf_buffer;
		goto doit;
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
262 263
	    case 'o':
	    case 'x':
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
	      {
		unsigned u;
		unsigned long ul;

		if (long_flag)
		  {
		    ul = va_arg(ap, unsigned long);
		    sprintf (sprintf_buffer, fmtcpy, ul);
		  }
		else
		  {
		    u = va_arg(ap, unsigned);
		    sprintf (sprintf_buffer, fmtcpy, u);
		  }
		/* Now copy into final output, truncating as necessary.  */
		string = sprintf_buffer;
		goto doit;
	      }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
282

283 284 285 286
	    case 'f':
	    case 'e':
	    case 'g':
	      {
287 288
		double d = va_arg(ap, double);
		sprintf (sprintf_buffer, fmtcpy, d);
289
		/* Now copy into final output, truncating as necessary.  */
290
		string = sprintf_buffer;
291 292 293
		goto doit;
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
294 295 296 297 298
	    case 'S':
	      string[-1] = 's';
	    case 's':
	      if (fmtcpy[1] != 's')
		minlen = atoi (&fmtcpy[1]);
299
	      string = va_arg (ap, char *);
300
	      tem = strlen (string);
301 302
	      if (tem > MOST_POSITIVE_FIXNUM)
		error ("String for %%s or %%S format is too long");
Karl Heuer's avatar
Karl Heuer committed
303
	      width = strwidth (string, tem);
Richard M. Stallman's avatar
Richard M. Stallman committed
304 305
	      goto doit1;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
306 307
	      /* Copy string into final output, truncating if no room.  */
	    doit:
Karl Heuer's avatar
Karl Heuer committed
308
	      /* Coming here means STRING contains ASCII only.  */
309 310 311 312
	      tem = strlen (string);
	      if (tem > MOST_POSITIVE_FIXNUM)
		error ("Format width or precision too large");
	      width = tem;
313
	    doit1:
Karl Heuer's avatar
Karl Heuer committed
314 315 316 317
	      /* We have already calculated:
		 TEM -- length of STRING,
		 WIDTH -- columns occupied by STRING when displayed, and
		 MINLEN -- minimum columns of the output.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
318 319
	      if (minlen > 0)
		{
Karl Heuer's avatar
Karl Heuer committed
320
		  while (minlen > width && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
321 322 323 324 325 326 327 328
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen--;
		    }
		  minlen = 0;
		}
	      if (tem > bufsize)
Karl Heuer's avatar
Karl Heuer committed
329 330 331
		{
		  /* Truncate the string at character boundary.  */
		  tem = bufsize;
332
		  while (!CHAR_HEAD_P (string[tem - 1])) tem--;
333
		  memcpy (bufptr, string, tem);
Karl Heuer's avatar
Karl Heuer committed
334 335 336 337
		  /* We must calculate WIDTH again.  */
		  width = strwidth (bufptr, tem);
		}
	      else
338
		memcpy (bufptr, string, tem);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
339 340 341 342
	      bufptr += tem;
	      bufsize -= tem;
	      if (minlen < 0)
		{
Karl Heuer's avatar
Karl Heuer committed
343
		  while (minlen < - width && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
344 345 346 347 348 349 350 351 352 353
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen++;
		    }
		  minlen = 0;
		}
	      continue;

	    case 'c':
354
	      {
355 356
		int chr = va_arg(ap, int);
		tem = CHAR_STRING (chr, (unsigned char *) charbuf);
357 358 359 360 361 362 363
		string = charbuf;
		string[tem] = 0;
		width = strwidth (string, tem);
		if (fmtcpy[1] != 'c')
		  minlen = atoi (&fmtcpy[1]);
		goto doit1;
	      }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
364 365 366 367 368

	    case '%':
	      fmt--;    /* Drop thru and this % will be treated as normal */
	    }
	}
Karl Heuer's avatar
Karl Heuer committed
369 370 371 372 373 374 375

      {
	/* Just some character; Copy it if the whole multi-byte form
	   fit in the buffer.  */
	char *save_bufptr = bufptr;

	do { *bufptr++ = *fmt++; }
376 377
	while (--bufsize > 0 && !CHAR_HEAD_P (*fmt));
	if (!CHAR_HEAD_P (*fmt))
Karl Heuer's avatar
Karl Heuer committed
378 379 380 381 382
	  {
	    bufptr = save_bufptr;
	    break;
	  }
      }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
383 384
    };

385
  /* If we had to malloc something, free it.  */
386
  xfree (big_buffer);
387

388
  *bufptr = 0;		/* Make sure our string ends with a '\0' */
389 390

  SAFE_FREE ();
Joseph Arceneaux's avatar
Joseph Arceneaux committed
391 392
  return bufptr - buffer;
}