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

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

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

Andreas Schwab's avatar
Andreas Schwab committed
63
int
Joseph Arceneaux's avatar
Joseph Arceneaux committed
64 65 66 67 68 69 70 71 72 73 74
doprnt (buffer, bufsize, format, format_end, nargs, args)
     char *buffer;
     register int bufsize;
     char *format;
     char *format_end;
     int nargs;
     char **args;
{
  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.. */
75

76
  /* Use this for sprintf unless we need something really big.  */
77
  char tembuf[DBL_MAX_10_EXP + 100];
78

79
  /* Size of sprintf_buffer.  */
80
  unsigned size_allocated = sizeof (tembuf);
81

82 83
  /* Buffer to use for sprintf.  Either tembuf or same as BIG_BUFFER.  */
  char *sprintf_buffer = tembuf;
84

85 86
  /* Buffer we have got with malloc.  */
  char *big_buffer = 0;
87

Joseph Arceneaux's avatar
Joseph Arceneaux committed
88
  register int tem;
89
  unsigned char *string;
90 91
  char fixed_buffer[20];	/* Default buffer for small formatting. */
  char *fmtcpy;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
92
  int minlen;
93
  unsigned char charbuf[MAX_MULTIBYTE_LENGTH + 1];	/* Used for %c.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
94 95 96 97

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

98 99 100
  if ((format_end - format + 1) < sizeof (fixed_buffer))
    fmtcpy = fixed_buffer;
  else
101
    fmtcpy = (char *) alloca (format_end - format + 1);
102

Joseph Arceneaux's avatar
Joseph Arceneaux committed
103
  bufsize--;
104 105 106

  /* Loop until end of format string or buffer full. */
  while (fmt != format_end && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
107 108 109
    {
      if (*fmt == '%')	/* Check for a '%' character */
	{
110
	  unsigned size_bound = 0;
Karl Heuer's avatar
Karl Heuer committed
111
	  int width;		/* Columns occupied by STRING.  */
112

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

		  if (size_bound < n)
		    size_bound = n;
		}
138
	      else if (*fmt == '-' || *fmt == ' ' || *fmt == '.' || *fmt == '+')
139 140
		;
	      else
Joseph Arceneaux's avatar
Joseph Arceneaux committed
141 142 143 144
		break;
	      fmt++;
	    }
	  *string = 0;
145

146 147
	  /* Make the size bound large enough to handle floating point formats
	     with large numbers.  */
148
	  if (size_bound + DBL_MAX_10_EXP + 50 < size_bound)
149
	    error ("Format width or precision too large");
150
	  size_bound += DBL_MAX_10_EXP + 50;
151

152 153 154 155 156 157 158 159 160 161
	  /* 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
162 163 164 165 166 167 168 169 170 171 172
	  minlen = 0;
	  switch (*fmt++)
	    {
	    default:
	      error ("Invalid format operation %%%c", fmt[-1]);

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

189 190 191 192 193 194
	    case 'f':
	    case 'e':
	    case 'g':
	      {
		union { double d; char *half[2]; } u;
		if (cnt + 1 == nargs)
195
		  error ("Not enough arguments for format string");
196 197 198 199
		u.half[0] = args[cnt++];
		u.half[1] = args[cnt++];
		sprintf (sprintf_buffer, fmtcpy, u.d);
		/* Now copy into final output, truncating as nec.  */
200
		string = (unsigned char *) sprintf_buffer;
201 202 203
		goto doit;
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
204 205 206 207
	    case 'S':
	      string[-1] = 's';
	    case 's':
	      if (cnt == nargs)
208
		error ("Not enough arguments for format string");
Joseph Arceneaux's avatar
Joseph Arceneaux committed
209 210
	      if (fmtcpy[1] != 's')
		minlen = atoi (&fmtcpy[1]);
211 212
	      string = (unsigned char *) args[cnt++];
	      tem = strlen (string);
Karl Heuer's avatar
Karl Heuer committed
213
	      width = strwidth (string, tem);
Richard M. Stallman's avatar
Richard M. Stallman committed
214 215
	      goto doit1;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
216 217
	      /* Copy string into final output, truncating if no room.  */
	    doit:
Karl Heuer's avatar
Karl Heuer committed
218 219
	      /* Coming here means STRING contains ASCII only.  */
	      width = tem = strlen (string);
220
	    doit1:
Karl Heuer's avatar
Karl Heuer committed
221 222 223 224
	      /* 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
225 226
	      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
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen--;
		    }
		  minlen = 0;
		}
	      if (tem > bufsize)
Karl Heuer's avatar
Karl Heuer committed
236 237 238
		{
		  /* Truncate the string at character boundary.  */
		  tem = bufsize;
239
		  while (!CHAR_HEAD_P (string[tem - 1])) tem--;
Karl Heuer's avatar
Karl Heuer committed
240 241 242 243 244 245
		  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
246 247 248 249
	      bufptr += tem;
	      bufsize -= tem;
	      if (minlen < 0)
		{
Karl Heuer's avatar
Karl Heuer committed
250
		  while (minlen < - width && bufsize > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
251 252 253 254 255 256 257 258 259 260 261
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen++;
		    }
		  minlen = 0;
		}
	      continue;

	    case 'c':
	      if (cnt == nargs)
262
		error ("Not enough arguments for format string");
263 264
	      tem = CHAR_STRING ((int) (EMACS_INT) args[cnt], charbuf);
	      string = charbuf;
Karl Heuer's avatar
Karl Heuer committed
265 266 267
	      cnt++;
	      string[tem] = 0;
	      width = strwidth (string, tem);
268 269 270
	      if (fmtcpy[1] != 'c')
		minlen = atoi (&fmtcpy[1]);
	      goto doit1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
271 272 273 274 275

	    case '%':
	      fmt--;    /* Drop thru and this % will be treated as normal */
	    }
	}
Karl Heuer's avatar
Karl Heuer committed
276 277 278 279 280 281 282

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

	do { *bufptr++ = *fmt++; }
283 284
	while (--bufsize > 0 && !CHAR_HEAD_P (*fmt));
	if (!CHAR_HEAD_P (*fmt))
Karl Heuer's avatar
Karl Heuer committed
285 286 287 288 289
	  {
	    bufptr = save_bufptr;
	    break;
	  }
      }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
290 291
    };

292
  /* If we had to malloc something, free it.  */
293
  xfree (big_buffer);
294

Joseph Arceneaux's avatar
Joseph Arceneaux committed
295 296 297
  *bufptr = 0;		/* Make sure our string end with a '\0' */
  return bufptr - buffer;
}
Kenichi Handa's avatar
Kenichi Handa committed
298 299 300

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