doprnt.c 8.77 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 5
   Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005,
                 2006, 2007  Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
6 7 8 9 10

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
21 22
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
23 24


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

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

Dave Love's avatar
Dave Love committed
33 34 35 36 37 38 39 40
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

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

41 42
#include "lisp.h"

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
52 53
static int doprnt1 ();

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

Andreas Schwab's avatar
Andreas Schwab committed
64
int
Joseph Arceneaux's avatar
Joseph Arceneaux committed
65 66 67 68 69 70 71
doprnt (buffer, bufsize, format, format_end, nargs, args)
     char *buffer;
     register int bufsize;
     char *format;
     char *format_end;
     int nargs;
     char **args;
Richard M. Stallman's avatar
Richard M. Stallman committed
72 73 74 75 76 77 78
{
  return doprnt1 (0, buffer, bufsize, format, format_end, nargs, args);
}

/* Like doprnt except that strings in ARGS are passed
   as Lisp_Object.  */

Andreas Schwab's avatar
Andreas Schwab committed
79
int
Richard M. Stallman's avatar
Richard M. Stallman committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
doprnt_lisp (buffer, bufsize, format, format_end, nargs, args)
     char *buffer;
     register int bufsize;
     char *format;
     char *format_end;
     int nargs;
     char **args;
{
  return doprnt1 (1, buffer, bufsize, format, format_end, nargs, args);
}

static int
doprnt1 (lispstrings, buffer, bufsize, format, format_end, nargs, args)
     int lispstrings;
     char *buffer;
     register int bufsize;
     char *format;
     char *format_end;
     int nargs;
     char **args;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
100 101 102 103
{
  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.. */
104

105
  /* Use this for sprintf unless we need something really big.  */
106
  char tembuf[DBL_MAX_10_EXP + 100];
107

108
  /* Size of sprintf_buffer.  */
109
  int size_allocated = sizeof (tembuf);
110

111 112
  /* Buffer to use for sprintf.  Either tembuf or same as BIG_BUFFER.  */
  char *sprintf_buffer = tembuf;
113

114 115
  /* Buffer we have got with malloc.  */
  char *big_buffer = 0;
116

Joseph Arceneaux's avatar
Joseph Arceneaux committed
117
  register int tem;
118
  unsigned char *string;
119 120
  char fixed_buffer[20];	/* Default buffer for small formatting. */
  char *fmtcpy;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
121
  int minlen;
122
  unsigned char charbuf[5];	/* Used for %c.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
123 124 125 126

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

127 128 129
  if ((format_end - format + 1) < sizeof (fixed_buffer))
    fmtcpy = fixed_buffer;
  else
130
    fmtcpy = (char *) alloca (format_end - format + 1);
131

Joseph Arceneaux's avatar
Joseph Arceneaux committed
132
  bufsize--;
133 134 135

  /* Loop until end of format string or buffer full. */
  while (fmt != format_end && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
136 137 138
    {
      if (*fmt == '%')	/* Check for a '%' character */
	{
139
	  int size_bound = 0;
Karl Heuer's avatar
Karl Heuer committed
140
	  int width;		/* Columns occupied by STRING.  */
141

Joseph Arceneaux's avatar
Joseph Arceneaux committed
142
	  fmt++;
Jim Blandy's avatar
Jim Blandy committed
143
	  /* Copy this one %-spec into fmtcpy.  */
144
	  string = (unsigned char *)fmtcpy;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
145
	  *string++ = '%';
146
	  while (1)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
147 148
	    {
	      *string++ = *fmt;
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
	      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.  */
		  int n = *fmt - '0';
		  while ('0' <= fmt[1] && fmt[1] <= '9')
		    {
		      if (n * 10 / 10 != n
			  || (n = n * 10 + (fmt[1] - '0')) < 0)
			error ("Format width or precision too large");
		      *string++ = *++fmt;
		    }

		  if (size_bound < n)
		    size_bound = n;
		}
	      else if (*fmt == '-' || *fmt == ' ' || *fmt == '.')
		;
	      else
Joseph Arceneaux's avatar
Joseph Arceneaux committed
170 171 172 173
		break;
	      fmt++;
	    }
	  *string = 0;
174

175 176 177
	  /* Make the size bound large enough to handle floating point formats
	     with large numbers.  */
	  size_bound += DBL_MAX_10_EXP + 50;
178

179 180
	  if (size_bound < 0)
	    error ("Format width or precision too large");
181

182 183 184 185 186 187 188 189 190 191
	  /* 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
192 193 194 195 196 197 198 199 200 201 202
	  minlen = 0;
	  switch (*fmt++)
	    {
	    default:
	      error ("Invalid format operation %%%c", fmt[-1]);

/*	    case 'b': */
	    case 'd':
	    case 'o':
	    case 'x':
	      if (cnt == nargs)
203
		error ("Not enough arguments for format string");
204 205 206 207 208 209 210 211 212 213
	      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 ();
214 215
	      sprintf (sprintf_buffer, fmtcpy, args[cnt++]);
	      /* Now copy into final output, truncating as nec.  */
216
	      string = (unsigned char *)sprintf_buffer;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
217 218
	      goto doit;

219 220 221 222 223 224
	    case 'f':
	    case 'e':
	    case 'g':
	      {
		union { double d; char *half[2]; } u;
		if (cnt + 1 == nargs)
225
		  error ("Not enough arguments for format string");
226 227 228 229
		u.half[0] = args[cnt++];
		u.half[1] = args[cnt++];
		sprintf (sprintf_buffer, fmtcpy, u.d);
		/* Now copy into final output, truncating as nec.  */
230
		string = (unsigned char *)sprintf_buffer;
231 232 233
		goto doit;
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
234 235 236 237
	    case 'S':
	      string[-1] = 's';
	    case 's':
	      if (cnt == nargs)
238
		error ("Not enough arguments for format string");
Joseph Arceneaux's avatar
Joseph Arceneaux committed
239 240
	      if (fmtcpy[1] != 's')
		minlen = atoi (&fmtcpy[1]);
Richard M. Stallman's avatar
Richard M. Stallman committed
241 242
	      if (lispstrings)
		{
243
		  string = ((struct Lisp_String *)args[cnt])->data;
244
		  tem = STRING_BYTES ((struct Lisp_String *)args[cnt]);
Richard M. Stallman's avatar
Richard M. Stallman committed
245 246 247 248
		  cnt++;
		}
	      else
		{
249
		  string = (unsigned char *)args[cnt++];
Richard M. Stallman's avatar
Richard M. Stallman committed
250 251
		  tem = strlen (string);
		}
Karl Heuer's avatar
Karl Heuer committed
252
	      width = strwidth (string, tem);
Richard M. Stallman's avatar
Richard M. Stallman committed
253 254
	      goto doit1;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
255 256
	      /* Copy string into final output, truncating if no room.  */
	    doit:
Karl Heuer's avatar
Karl Heuer committed
257 258
	      /* Coming here means STRING contains ASCII only.  */
	      width = tem = strlen (string);
259
	    doit1:
Karl Heuer's avatar
Karl Heuer committed
260 261 262 263
	      /* 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
264 265
	      if (minlen > 0)
		{
Karl Heuer's avatar
Karl Heuer committed
266
		  while (minlen > width && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
267 268 269 270 271 272 273 274
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen--;
		    }
		  minlen = 0;
		}
	      if (tem > bufsize)
Karl Heuer's avatar
Karl Heuer committed
275 276 277
		{
		  /* Truncate the string at character boundary.  */
		  tem = bufsize;
278
		  while (!CHAR_HEAD_P (string[tem - 1])) tem--;
Karl Heuer's avatar
Karl Heuer committed
279 280 281 282 283 284
		  bcopy (string, bufptr, tem);
		  /* We must calculate WIDTH again.  */
		  width = strwidth (bufptr, tem);
		}
	      else
		bcopy (string, bufptr, tem);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
285 286 287 288
	      bufptr += tem;
	      bufsize -= tem;
	      if (minlen < 0)
		{
Karl Heuer's avatar
Karl Heuer committed
289
		  while (minlen < - width && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
290 291 292 293 294 295 296 297 298 299 300
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen++;
		    }
		  minlen = 0;
		}
	      continue;

	    case 'c':
	      if (cnt == nargs)
301
		error ("Not enough arguments for format string");
302 303
	      tem = CHAR_STRING ((int) (EMACS_INT) args[cnt], charbuf);
	      string = charbuf;
Karl Heuer's avatar
Karl Heuer committed
304 305 306
	      cnt++;
	      string[tem] = 0;
	      width = strwidth (string, tem);
307 308 309
	      if (fmtcpy[1] != 'c')
		minlen = atoi (&fmtcpy[1]);
	      goto doit1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
310 311 312 313 314

	    case '%':
	      fmt--;    /* Drop thru and this % will be treated as normal */
	    }
	}
Karl Heuer's avatar
Karl Heuer committed
315 316 317 318 319 320 321

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

	do { *bufptr++ = *fmt++; }
322 323
	while (--bufsize > 0 && !CHAR_HEAD_P (*fmt));
	if (!CHAR_HEAD_P (*fmt))
Karl Heuer's avatar
Karl Heuer committed
324 325 326 327 328
	  {
	    bufptr = save_bufptr;
	    break;
	  }
      }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
329 330
    };

331 332
  /* If we had to malloc something, free it.  */
  if (big_buffer)
333
    xfree (big_buffer);
334

Joseph Arceneaux's avatar
Joseph Arceneaux committed
335 336 337
  *bufptr = 0;		/* Make sure our string end with a '\0' */
  return bufptr - buffer;
}
Miles Bader's avatar
Miles Bader committed
338 339 340

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