doprnt.c 7.59 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1 2 3
/* Output like sprintf to a buffer of specified size.
   Also takes args differently: pass one pointer to an array of strings
   in addition to the format string which is separate.
4
   Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005,
5
                 2006, 2007, 2008, 2009, 2010, 2011  Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
6 7 8

This file is part of GNU Emacs.

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

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
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
21 22


Richard M. Stallman's avatar
Richard M. Stallman committed
23
#include <config.h>
Joseph Arceneaux's avatar
Joseph Arceneaux committed
24 25
#include <stdio.h>
#include <ctype.h>
26
#include <setjmp.h>
Joseph Arceneaux's avatar
Joseph Arceneaux committed
27

28
#ifdef STDC_HEADERS
29 30 31
#include <float.h>
#endif

Dave Love's avatar
Dave Love committed
32 33
#include <unistd.h>

34 35
#include "lisp.h"

Karl Heuer's avatar
Karl Heuer committed
36 37 38
/* 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.  */
39
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
40

41 42 43 44
#ifndef DBL_MAX_10_EXP
#define DBL_MAX_10_EXP 308 /* IEEE double */
#endif

45 46 47 48
/* 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.
Richard M. Stallman's avatar
Richard M. Stallman committed
49
   Returns the number of bytes stored into BUFFER.
50
   ARGS points to the vector of arguments, and NARGS says how many.
Richard M. Stallman's avatar
Richard M. Stallman committed
51 52 53
   A double counts as two arguments.
   String arguments are passed as C strings.
   Integers are passed as C integers.  */
54

55
EMACS_INT
56 57
doprnt (char *buffer, register int bufsize, const char *format,
	const char *format_end, va_list ap)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
58
{
59
  const char *fmt = format;	/* Pointer into format string */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
60
  register char *bufptr = buffer; /* Pointer into output buffer.. */
61

62
  /* Use this for sprintf unless we need something really big.  */
63
  char tembuf[DBL_MAX_10_EXP + 100];
64

65
  /* Size of sprintf_buffer.  */
66
  unsigned size_allocated = sizeof (tembuf);
67

68 69
  /* Buffer to use for sprintf.  Either tembuf or same as BIG_BUFFER.  */
  char *sprintf_buffer = tembuf;
70

71 72
  /* Buffer we have got with malloc.  */
  char *big_buffer = 0;
73

Joseph Arceneaux's avatar
Joseph Arceneaux committed
74
  register int tem;
75
  unsigned char *string;
76 77
  char fixed_buffer[20];	/* Default buffer for small formatting. */
  char *fmtcpy;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
78
  int minlen;
79
  unsigned char charbuf[MAX_MULTIBYTE_LENGTH + 1];	/* Used for %c.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
80 81 82 83

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

84 85 86
  if ((format_end - format + 1) < sizeof (fixed_buffer))
    fmtcpy = fixed_buffer;
  else
87
    fmtcpy = (char *) alloca (format_end - format + 1);
88

Joseph Arceneaux's avatar
Joseph Arceneaux committed
89
  bufsize--;
90 91 92

  /* Loop until end of format string or buffer full. */
  while (fmt != format_end && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
93 94 95
    {
      if (*fmt == '%')	/* Check for a '%' character */
	{
96
	  unsigned size_bound = 0;
97
	  EMACS_INT width;  /* Columns occupied by STRING.  */
98

Joseph Arceneaux's avatar
Joseph Arceneaux committed
99
	  fmt++;
Jim Blandy's avatar
Jim Blandy committed
100
	  /* Copy this one %-spec into fmtcpy.  */
101
	  string = (unsigned char *) fmtcpy;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
102
	  *string++ = '%';
103
	  while (1)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
104 105
	    {
	      *string++ = *fmt;
106 107 108 109 110 111
	      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.  */
112
		  unsigned n = *fmt - '0';
113 114
		  while ('0' <= fmt[1] && fmt[1] <= '9')
		    {
Andreas Schwab's avatar
Andreas Schwab committed
115
		      if (n * 10 + fmt[1] - '0' < n)
116
			error ("Format width or precision too large");
Andreas Schwab's avatar
Andreas Schwab committed
117
		      n = n * 10 + fmt[1] - '0';
118 119 120 121 122 123
		      *string++ = *++fmt;
		    }

		  if (size_bound < n)
		    size_bound = n;
		}
124
	      else if (*fmt == '-' || *fmt == ' ' || *fmt == '.' || *fmt == '+')
125 126
		;
	      else
Joseph Arceneaux's avatar
Joseph Arceneaux committed
127 128 129 130
		break;
	      fmt++;
	    }
	  *string = 0;
131

132 133
	  /* Make the size bound large enough to handle floating point formats
	     with large numbers.  */
134
	  if (size_bound + DBL_MAX_10_EXP + 50 < size_bound)
135
	    error ("Format width or precision too large");
136
	  size_bound += DBL_MAX_10_EXP + 50;
137

138 139 140 141 142 143 144 145 146 147
	  /* 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
148 149 150 151 152 153 154 155 156 157
	  minlen = 0;
	  switch (*fmt++)
	    {
	    default:
	      error ("Invalid format operation %%%c", fmt[-1]);

/*	    case 'b': */
	    case 'd':
	    case 'o':
	    case 'x':
158 159 160 161 162 163 164 165 166 167
	      if (sizeof (int) == sizeof (EMACS_INT))
		;
	      else if (sizeof (long) == sizeof (EMACS_INT))
		/* Insert an `l' the right place.  */
		string[1] = string[0],
		string[0] = string[-1],
		string[-1] = 'l',
		string++;
	      else
		abort ();
168
	      sprintf (sprintf_buffer, fmtcpy, va_arg(ap, char *));
169
	      /* Now copy into final output, truncating as nec.  */
170
	      string = (unsigned char *) sprintf_buffer;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
171 172
	      goto doit;

173 174 175 176
	    case 'f':
	    case 'e':
	    case 'g':
	      {
177 178
		double d = va_arg(ap, double);
		sprintf (sprintf_buffer, fmtcpy, d);
179
		/* Now copy into final output, truncating as nec.  */
180
		string = (unsigned char *) sprintf_buffer;
181 182 183
		goto doit;
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
184 185 186 187 188
	    case 'S':
	      string[-1] = 's';
	    case 's':
	      if (fmtcpy[1] != 's')
		minlen = atoi (&fmtcpy[1]);
189
	      string = va_arg(ap, unsigned char *);
190
	      tem = strlen (string);
Karl Heuer's avatar
Karl Heuer committed
191
	      width = strwidth (string, tem);
Richard M. Stallman's avatar
Richard M. Stallman committed
192 193
	      goto doit1;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
194 195
	      /* Copy string into final output, truncating if no room.  */
	    doit:
Karl Heuer's avatar
Karl Heuer committed
196 197
	      /* Coming here means STRING contains ASCII only.  */
	      width = tem = strlen (string);
198
	    doit1:
Karl Heuer's avatar
Karl Heuer committed
199 200 201 202
	      /* 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
203 204
	      if (minlen > 0)
		{
Karl Heuer's avatar
Karl Heuer committed
205
		  while (minlen > width && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
206 207 208 209 210 211 212 213
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen--;
		    }
		  minlen = 0;
		}
	      if (tem > bufsize)
Karl Heuer's avatar
Karl Heuer committed
214 215 216
		{
		  /* Truncate the string at character boundary.  */
		  tem = bufsize;
217
		  while (!CHAR_HEAD_P (string[tem - 1])) tem--;
218
		  memcpy (bufptr, string, tem);
Karl Heuer's avatar
Karl Heuer committed
219 220 221 222
		  /* We must calculate WIDTH again.  */
		  width = strwidth (bufptr, tem);
		}
	      else
223
		memcpy (bufptr, string, tem);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
224 225 226 227
	      bufptr += tem;
	      bufsize -= tem;
	      if (minlen < 0)
		{
Karl Heuer's avatar
Karl Heuer committed
228
		  while (minlen < - width && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
229 230 231 232 233 234 235 236 237 238
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen++;
		    }
		  minlen = 0;
		}
	      continue;

	    case 'c':
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
	      {
		/* Sometimes for %c we pass a char, which would widen
		   to int.  Sometimes we pass XFASTINT() or XINT()
		   values, which would be EMACS_INT.  Let's hope that
		   both are passed the same way, otherwise we'll need
		   to rewrite callers.  */
		EMACS_INT chr = va_arg(ap, EMACS_INT);
		tem = CHAR_STRING ((int) chr, charbuf);
		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
254 255 256 257 258

	    case '%':
	      fmt--;    /* Drop thru and this % will be treated as normal */
	    }
	}
Karl Heuer's avatar
Karl Heuer committed
259 260 261 262 263 264 265

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

	do { *bufptr++ = *fmt++; }
266 267
	while (--bufsize > 0 && !CHAR_HEAD_P (*fmt));
	if (!CHAR_HEAD_P (*fmt))
Karl Heuer's avatar
Karl Heuer committed
268 269 270 271 272
	  {
	    bufptr = save_bufptr;
	    break;
	  }
      }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
273 274
    };

275
  /* If we had to malloc something, free it.  */
276
  xfree (big_buffer);
277

Joseph Arceneaux's avatar
Joseph Arceneaux committed
278 279 280
  *bufptr = 0;		/* Make sure our string end with a '\0' */
  return bufptr - buffer;
}
Kenichi Handa's avatar
Kenichi Handa committed
281