doprnt.c 8.75 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  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 26
#include <stdio.h>
#include <ctype.h>

27
#ifdef STDC_HEADERS
28 29 30
#include <float.h>
#endif

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

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

39 40
#include "lisp.h"

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

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

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

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

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

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

106
  /* Size of sprintf_buffer.  */
107
  unsigned size_allocated = sizeof (tembuf);
108

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

112 113
  /* Buffer we have got with malloc.  */
  char *big_buffer = 0;
114

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
130
  bufsize--;
131 132 133

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

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

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

173 174
	  /* Make the size bound large enough to handle floating point formats
	     with large numbers.  */
175
	  if (size_bound + DBL_MAX_10_EXP + 50 < size_bound)
176
	    error ("Format width or precision too large");
177
	  size_bound += DBL_MAX_10_EXP + 50;
178

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

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

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

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

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

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

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

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

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

328
  /* If we had to malloc something, free it.  */
329
  xfree (big_buffer);
330

Joseph Arceneaux's avatar
Joseph Arceneaux committed
331 332 333
  *bufptr = 0;		/* Make sure our string end with a '\0' */
  return bufptr - buffer;
}
Kenichi Handa's avatar
Kenichi Handa committed
334 335 336

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