doprnt.c 8.69 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1 2 3 4 5 6 7 8 9
/* 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.
   Copyright (C) 1985 Free Software Foundation, Inc.

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
10
the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
11 12 13 14 15 16 17 18 19
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
20 21
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
22 23


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

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 49 50
/* 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"

51 52
extern long *xmalloc (), *xrealloc ();

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

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

Andreas Schwab's avatar
Andreas Schwab committed
65
int
Joseph Arceneaux's avatar
Joseph Arceneaux committed
66 67 68 69 70 71 72
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
73 74 75 76 77 78 79
{
  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
80
int
Richard M. Stallman's avatar
Richard M. Stallman committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
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
101 102 103 104
{
  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.. */
105

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

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
118
  register int tem;
119
  unsigned char *string;
120 121
  char fixed_buffer[20];	/* Default buffer for small formatting. */
  char *fmtcpy;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
122 123
  int minlen;
  int size;			/* Field width factor; e.g., %90d */
124
  unsigned char charbuf[5];	/* Used for %c.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
125 126 127 128

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
134
  bufsize--;
135 136 137

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
144
	  fmt++;
Jim Blandy's avatar
Jim Blandy committed
145
	  /* Copy this one %-spec into fmtcpy.  */
146
	  string = (unsigned char *)fmtcpy;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
147
	  *string++ = '%';
148
	  while (1)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
149 150
	    {
	      *string++ = *fmt;
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
	      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
172 173 174 175
		break;
	      fmt++;
	    }
	  *string = 0;
176

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

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

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

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

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

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

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

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

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

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

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

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

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