doprnt.c 7.46 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-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


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

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

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

33 34
#include "lisp.h"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/*	    case 'b': */
	    case 'd':
	    case 'o':
	    case 'x':
157 158 159 160 161 162 163 164 165 166
	      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 ();
167
	      sprintf (sprintf_buffer, fmtcpy, va_arg(ap, char *));
168
	      /* Now copy into final output, truncating as nec.  */
169
	      string = sprintf_buffer;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
170 171
	      goto doit;

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

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

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

	    case 'c':
238 239 240 241 242 243 244
	      {
		/* 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);
245
		tem = CHAR_STRING ((int) chr, (unsigned char *) charbuf);
246 247 248 249 250 251 252
		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
253 254 255 256 257

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

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

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

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

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