doprnt.c 7.69 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,
Glenn Morris's avatar
Glenn Morris committed
5
                 2006, 2007, 2008, 2009, 2010  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 34 35
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

36 37
#include "lisp.h"

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

43 44 45 46
#ifndef DBL_MAX_10_EXP
#define DBL_MAX_10_EXP 308 /* IEEE double */
#endif

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

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

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

67
  /* Size of sprintf_buffer.  */
68
  unsigned size_allocated = sizeof (tembuf);
69

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

73 74
  /* Buffer we have got with malloc.  */
  char *big_buffer = 0;
75

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
91
  bufsize--;
92 93 94

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

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

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

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

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

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

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

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

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

	    case 'c':
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
	      {
		/* 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
256 257 258 259 260

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

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

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

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

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

/* arch-tag: aa0ab528-7c5f-4c73-894c-aa2526a1efb3
   (do not change this comment) */