doprnt.c 7.9 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 36 37 38 39
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif

40 41
#include "lisp.h"

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

Karl Heuer's avatar
Karl Heuer committed
46 47 48
/* 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.  */
49
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
50

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

Andreas Schwab's avatar
Andreas Schwab committed
61
int
62
doprnt (char *buffer, register int bufsize, char *format, char *format_end, int nargs, char **args)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
63 64 65 66
{
  int cnt = 0;			/* Number of arg to gobble next */
  register char *fmt = format;	/* Pointer into format string */
  register char *bufptr = buffer; /* Pointer into output buffer.. */
67

68
  /* Use this for sprintf unless we need something really big.  */
69
  char tembuf[DBL_MAX_10_EXP + 100];
70

71
  /* Size of sprintf_buffer.  */
72
  unsigned size_allocated = sizeof (tembuf);
73

74 75
  /* Buffer to use for sprintf.  Either tembuf or same as BIG_BUFFER.  */
  char *sprintf_buffer = tembuf;
76

77 78
  /* Buffer we have got with malloc.  */
  char *big_buffer = 0;
79

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

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

90 91 92
  if ((format_end - format + 1) < sizeof (fixed_buffer))
    fmtcpy = fixed_buffer;
  else
93
    fmtcpy = (char *) alloca (format_end - format + 1);
94

Joseph Arceneaux's avatar
Joseph Arceneaux committed
95
  bufsize--;
96 97 98

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

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

		  if (size_bound < n)
		    size_bound = n;
		}
130
	      else if (*fmt == '-' || *fmt == ' ' || *fmt == '.' || *fmt == '+')
131 132
		;
	      else
Joseph Arceneaux's avatar
Joseph Arceneaux committed
133 134 135 136
		break;
	      fmt++;
	    }
	  *string = 0;
137

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

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

/*	    case 'b': */
	    case 'd':
	    case 'o':
	    case 'x':
	      if (cnt == nargs)
165
		error ("Not enough arguments for format string");
166 167 168 169 170 171 172 173 174 175
	      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 ();
176 177
	      sprintf (sprintf_buffer, fmtcpy, args[cnt++]);
	      /* Now copy into final output, truncating as nec.  */
178
	      string = (unsigned char *) sprintf_buffer;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
179 180
	      goto doit;

181 182 183 184 185 186
	    case 'f':
	    case 'e':
	    case 'g':
	      {
		union { double d; char *half[2]; } u;
		if (cnt + 1 == nargs)
187
		  error ("Not enough arguments for format string");
188 189 190 191
		u.half[0] = args[cnt++];
		u.half[1] = args[cnt++];
		sprintf (sprintf_buffer, fmtcpy, u.d);
		/* Now copy into final output, truncating as nec.  */
192
		string = (unsigned char *) sprintf_buffer;
193 194 195
		goto doit;
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
196 197 198 199
	    case 'S':
	      string[-1] = 's';
	    case 's':
	      if (cnt == nargs)
200
		error ("Not enough arguments for format string");
Joseph Arceneaux's avatar
Joseph Arceneaux committed
201 202
	      if (fmtcpy[1] != 's')
		minlen = atoi (&fmtcpy[1]);
203 204
	      string = (unsigned char *) args[cnt++];
	      tem = strlen (string);
Karl Heuer's avatar
Karl Heuer committed
205
	      width = strwidth (string, tem);
Richard M. Stallman's avatar
Richard M. Stallman committed
206 207
	      goto doit1;

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

	    case 'c':
	      if (cnt == nargs)
254
		error ("Not enough arguments for format string");
255 256
	      tem = CHAR_STRING ((int) (EMACS_INT) args[cnt], charbuf);
	      string = charbuf;
Karl Heuer's avatar
Karl Heuer committed
257 258 259
	      cnt++;
	      string[tem] = 0;
	      width = strwidth (string, tem);
260 261 262
	      if (fmtcpy[1] != 'c')
		minlen = atoi (&fmtcpy[1]);
	      goto doit1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
263 264 265 266 267

	    case '%':
	      fmt--;    /* Drop thru and this % will be treated as normal */
	    }
	}
Karl Heuer's avatar
Karl Heuer committed
268 269 270 271 272 273 274

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

	do { *bufptr++ = *fmt++; }
275 276
	while (--bufsize > 0 && !CHAR_HEAD_P (*fmt));
	if (!CHAR_HEAD_P (*fmt))
Karl Heuer's avatar
Karl Heuer committed
277 278 279 280 281
	  {
	    bufptr = save_bufptr;
	    break;
	  }
      }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
282 283
    };

284
  /* If we had to malloc something, free it.  */
285
  xfree (big_buffer);
286

Joseph Arceneaux's avatar
Joseph Arceneaux committed
287 288 289
  *bufptr = 0;		/* Make sure our string end with a '\0' */
  return bufptr - buffer;
}
Kenichi Handa's avatar
Kenichi Handa committed
290 291 292

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