[bpt/emacs.git] / src / doprnt.c

/* 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, 2001, 2002, 2003, 2004, 2005,
                 2006, 2007, 2008, 2009, 2010, 2011  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
the Free Software Foundation, either version 3 of the License, or
(at your option) 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.  If not, see <http://www.gnu.org/licenses/>.  */


#include <config.h>
#include <stdio.h>
#include <ctype.h>
#include <setjmp.h>

#ifdef STDC_HEADERS
#include <float.h>
#endif

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

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

#include "lisp.h"

#ifndef DBL_MAX_10_EXP
#define DBL_MAX_10_EXP 308 /* IEEE double */
#endif

/* 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 "character.h"

static int doprnt1 ();

/* 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 bytes stored into BUFFER.
   ARGS points to the vector of arguments, and NARGS says how many.
   A double counts as two arguments.
   String arguments are passed as C strings.
   Integers are passed as C integers.  */

int
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.. */

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

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

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

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

  register int tem;
  unsigned char *string;
  char fixed_buffer[20];	/* Default buffer for small formatting. */
  char *fmtcpy;
  int minlen;
  unsigned char charbuf[MAX_MULTIBYTE_LENGTH + 1];	/* Used for %c.  */

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

  if ((format_end - format + 1) < sizeof (fixed_buffer))
    fmtcpy = fixed_buffer;
  else
    fmtcpy = (char *) alloca (format_end - format + 1);

  bufsize--;

  /* Loop until end of format string or buffer full. */
  while (fmt != format_end && bufsize > 0)
    {
      if (*fmt == '%')	/* Check for a '%' character */
	{
	  unsigned size_bound = 0;
	  int width;		/* Columns occupied by STRING.  */

	  fmt++;
	  /* Copy this one %-spec into fmtcpy.  */
	  string = (unsigned char *) fmtcpy;
	  *string++ = '%';
	  while (1)
	    {
	      *string++ = *fmt;
	      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.  */
		  unsigned n = *fmt - '0';
		  while ('0' <= fmt[1] && fmt[1] <= '9')
		    {
		      if (n * 10 + fmt[1] - '0' < n)
			error ("Format width or precision too large");
		      n = n * 10 + fmt[1] - '0';
		      *string++ = *++fmt;
		    }

		  if (size_bound < n)
		    size_bound = n;
		}
	      else if (*fmt == '-' || *fmt == ' ' || *fmt == '.' || *fmt == '+')
		;
	      else
		break;
	      fmt++;
	    }
	  *string = 0;

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

	  /* 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;
	    }
	  minlen = 0;
	  switch (*fmt++)
	    {
	    default:
	      error ("Invalid format operation %%%c", fmt[-1]);

/*	    case 'b': */
	    case 'd':
	    case 'o':
	    case 'x':
	      if (cnt == nargs)
		error ("Not enough arguments for format string");
	      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 ();
	      sprintf (sprintf_buffer, fmtcpy, args[cnt++]);
	      /* Now copy into final output, truncating as nec.  */
	      string = (unsigned char *) sprintf_buffer;
	      goto doit;

	    case 'f':
	    case 'e':
	    case 'g':
	      {
		union { double d; char *half[2]; } u;
		if (cnt + 1 == nargs)
		  error ("Not enough arguments for format string");
		u.half[0] = args[cnt++];
		u.half[1] = args[cnt++];
		sprintf (sprintf_buffer, fmtcpy, u.d);
		/* Now copy into final output, truncating as nec.  */
		string = (unsigned char *) sprintf_buffer;
		goto doit;
	      }

	    case 'S':
	      string[-1] = 's';
	    case 's':
	      if (cnt == nargs)
		error ("Not enough arguments for format string");
	      if (fmtcpy[1] != 's')
		minlen = atoi (&fmtcpy[1]);
	      string = (unsigned char *) args[cnt++];
	      tem = strlen (string);
	      width = strwidth (string, tem);
	      goto doit1;

	      /* Copy string into final output, truncating if no room.  */
	    doit:
	      /* Coming here means STRING contains ASCII only.  */
	      width = tem = strlen (string);
	    doit1:
	      /* We have already calculated:
		 TEM -- length of STRING,
		 WIDTH -- columns occupied by STRING when displayed, and
		 MINLEN -- minimum columns of the output.  */
	      if (minlen > 0)
		{
		  while (minlen > width && bufsize > 0)
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen--;
		    }
		  minlen = 0;
		}
	      if (tem > bufsize)
		{
		  /* Truncate the string at character boundary.  */
		  tem = bufsize;
		  while (!CHAR_HEAD_P (string[tem - 1])) tem--;
		  bcopy (string, bufptr, tem);
		  /* We must calculate WIDTH again.  */
		  width = strwidth (bufptr, tem);
		}
	      else
		bcopy (string, bufptr, tem);
	      bufptr += tem;
	      bufsize -= tem;
	      if (minlen < 0)
		{
		  while (minlen < - width && bufsize > 0)
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen++;
		    }
		  minlen = 0;
		}
	      continue;

	    case 'c':
	      if (cnt == nargs)
		error ("Not enough arguments for format string");
	      tem = CHAR_STRING ((int) (EMACS_INT) args[cnt], charbuf);
	      string = charbuf;
	      cnt++;
	      string[tem] = 0;
	      width = strwidth (string, tem);
	      if (fmtcpy[1] != 'c')
		minlen = atoi (&fmtcpy[1]);
	      goto doit1;

	    case '%':
	      fmt--;    /* Drop thru and this % will be treated as normal */
	    }
	}

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

	do { *bufptr++ = *fmt++; }
	while (--bufsize > 0 && !CHAR_HEAD_P (*fmt));
	if (!CHAR_HEAD_P (*fmt))
	  {
	    bufptr = save_bufptr;
	    break;
	  }
      }
    };

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

  *bufptr = 0;		/* Make sure our string end with a '\0' */
  return bufptr - buffer;
}

/* arch-tag: aa0ab528-7c5f-4c73-894c-aa2526a1efb3
   (do not change this comment) */
Commit	Line	Data
24f98398 JA	1	/* Output like sprintf to a buffer of specified size.
	2	Also takes args differently: pass one pointer to an array of strings
	3	in addition to the format string which is separate.
429ab54e	4	Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005,
5df4f04c	5	2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
24f98398 JA	6
	7	This file is part of GNU Emacs.
	8
9ec0b715	9	GNU Emacs is free software: you can redistribute it and/or modify
24f98398	10	it under the terms of the GNU General Public License as published by
9ec0b715 GM	11	the Free Software Foundation, either version 3 of the License, or
9ec0b715 GM	12	(at your option) any later version.
24f98398 JA	13
	14	GNU Emacs is distributed in the hope that it will be useful,
	15	but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	GNU General Public License for more details.
	18
	19	You should have received a copy of the GNU General Public License
9ec0b715	20	along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24f98398 JA	21
24f98398 JA	22
6d291527	23	#include <config.h>
24f98398 JA	24	#include <stdio.h>
24f98398 JA	25	#include <ctype.h>
d7306fe6	26	#include <setjmp.h>
24f98398	27
cf09633a	28	#ifdef STDC_HEADERS
be65c2f4 PE	29	#include <float.h>
	30	#endif
	31
48236137 DL	32	#ifdef HAVE_UNISTD_H
	33	#include <unistd.h>
	34	#endif
	35
	36	#ifdef HAVE_STDLIB_H
	37	#include <stdlib.h>
	38	#endif
	39
523e9291 RS	40	#include "lisp.h"
523e9291 RS	41
be65c2f4 PE	42	#ifndef DBL_MAX_10_EXP
	43	#define DBL_MAX_10_EXP 308 /* IEEE double */
	44	#endif
	45
a0ca925c KH	46	/* Since we use the macro CHAR_HEAD_P, we have to include this, but
	47	don't have to include others because CHAR_HEAD_P does not contains
	48	another macro. */
83be827a	49	#include "character.h"
a0ca925c	50
1513af9e RS	51	static int doprnt1 ();
1513af9e RS	52
f4c730d3 RS	53	/* Generate output from a format-spec FORMAT,
	54	terminated at position FORMAT_END.
	55	Output goes in BUFFER, which has room for BUFSIZE chars.
	56	If the output does not fit, truncate it to fit.
6afc669e	57	Returns the number of bytes stored into BUFFER.
f4c730d3	58	ARGS points to the vector of arguments, and NARGS says how many.
1513af9e RS	59	A double counts as two arguments.
	60	String arguments are passed as C strings.
	61	Integers are passed as C integers. */
f4c730d3	62
dfcf069d	63	int
24f98398 JA	64	doprnt (buffer, bufsize, format, format_end, nargs, args)
	65	char *buffer;
	66	register int bufsize;
	67	char *format;
	68	char *format_end;
	69	int nargs;
	70	char **args;
	71	{
	72	int cnt = 0; /* Number of arg to gobble next */
	73	register char fmt = format; / Pointer into format string */
	74	register char bufptr = buffer; / Pointer into output buffer.. */
03383aaf	75
f4c730d3	76	/* Use this for sprintf unless we need something really big. */
be65c2f4	77	char tembuf[DBL_MAX_10_EXP + 100];
03383aaf	78
f4c730d3	79	/* Size of sprintf_buffer. */
01769a73	80	unsigned size_allocated = sizeof (tembuf);
03383aaf	81
f4c730d3 RS	82	/* Buffer to use for sprintf. Either tembuf or same as BIG_BUFFER. */
f4c730d3 RS	83	char *sprintf_buffer = tembuf;
03383aaf	84
f4c730d3 RS	85	/* Buffer we have got with malloc. */
f4c730d3 RS	86	char *big_buffer = 0;
03383aaf	87
24f98398	88	register int tem;
c292461f	89	unsigned char *string;
03383aaf BF	90	char fixed_buffer[20]; /* Default buffer for small formatting. */
03383aaf BF	91	char *fmtcpy;
24f98398	92	int minlen;
1f625c6c	93	unsigned char charbuf[MAX_MULTIBYTE_LENGTH + 1]; /* Used for %c. */
24f98398 JA	94
	95	if (format_end == 0)
	96	format_end = format + strlen (format);
	97
03383aaf BF	98	if ((format_end - format + 1) < sizeof (fixed_buffer))
	99	fmtcpy = fixed_buffer;
	100	else
91098d38	101	fmtcpy = (char *) alloca (format_end - format + 1);
03383aaf	102
24f98398	103	bufsize--;
03383aaf BF	104
	105	/* Loop until end of format string or buffer full. */
	106	while (fmt != format_end && bufsize > 0)
24f98398 JA	107	{
	108	if (fmt == '%') / Check for a '%' character */
	109	{
01769a73	110	unsigned size_bound = 0;
a0ca925c	111	int width; /* Columns occupied by STRING. */
f4c730d3	112
24f98398	113	fmt++;
d427b66a	114	/* Copy this one %-spec into fmtcpy. */
01769a73	115	string = (unsigned char *) fmtcpy;
24f98398	116	*string++ = '%';
03383aaf	117	while (1)
24f98398 JA	118	{
24f98398 JA	119	string++ = fmt;
be65c2f4 PE	120	if ('0' <= fmt && fmt <= '9')
	121	{
	122	/* Get an idea of how much space we might need.
	123	This might be a field width or a precision; e.g.
	124	%1.1000f and %1000.1f both might need 1000+ bytes.
	125	Parse the width or precision, checking for overflow. */
01769a73	126	unsigned n = *fmt - '0';
be65c2f4 PE	127	while ('0' <= fmt[1] && fmt[1] <= '9')
be65c2f4 PE	128	{
26898943	129	if (n * 10 + fmt[1] - '0' < n)
be65c2f4	130	error ("Format width or precision too large");
26898943	131	n = n * 10 + fmt[1] - '0';
be65c2f4 PE	132	string++ = ++fmt;
	133	}
	134
	135	if (size_bound < n)
	136	size_bound = n;
	137	}
01769a73	138	else if (fmt == '-' \|\| fmt == ' ' \|\| fmt == '.' \|\| fmt == '+')
be65c2f4 PE	139	;
be65c2f4 PE	140	else
24f98398 JA	141	break;
	142	fmt++;
	143	}
	144	*string = 0;
03383aaf	145
be65c2f4 PE	146	/* Make the size bound large enough to handle floating point formats
be65c2f4 PE	147	with large numbers. */
01769a73	148	if (size_bound + DBL_MAX_10_EXP + 50 < size_bound)
be65c2f4	149	error ("Format width or precision too large");
01769a73	150	size_bound += DBL_MAX_10_EXP + 50;
6e951728	151
f4c730d3 RS	152	/* Make sure we have that much. */
	153	if (size_bound > size_allocated)
	154	{
	155	if (big_buffer)
	156	big_buffer = (char *) xrealloc (big_buffer, size_bound);
	157	else
	158	big_buffer = (char *) xmalloc (size_bound);
	159	sprintf_buffer = big_buffer;
	160	size_allocated = size_bound;
	161	}
24f98398 JA	162	minlen = 0;
	163	switch (*fmt++)
	164	{
	165	default:
	166	error ("Invalid format operation %%%c", fmt[-1]);
	167
	168	/* case 'b': */
	169	case 'd':
	170	case 'o':
	171	case 'x':
	172	if (cnt == nargs)
6e951728	173	error ("Not enough arguments for format string");
f9fa352f RS	174	if (sizeof (int) == sizeof (EMACS_INT))
	175	;
	176	else if (sizeof (long) == sizeof (EMACS_INT))
	177	/* Insert an `l' the right place. */
	178	string[1] = string[0],
	179	string[0] = string[-1],
	180	string[-1] = 'l',
	181	string++;
	182	else
	183	abort ();
f4c730d3 RS	184	sprintf (sprintf_buffer, fmtcpy, args[cnt++]);
f4c730d3 RS	185	/* Now copy into final output, truncating as nec. */
01769a73	186	string = (unsigned char *) sprintf_buffer;
24f98398 JA	187	goto doit;
24f98398 JA	188
f4c730d3 RS	189	case 'f':
	190	case 'e':
	191	case 'g':
	192	{
	193	union { double d; char *half[2]; } u;
	194	if (cnt + 1 == nargs)
fb08db45	195	error ("Not enough arguments for format string");
f4c730d3 RS	196	u.half[0] = args[cnt++];
	197	u.half[1] = args[cnt++];
	198	sprintf (sprintf_buffer, fmtcpy, u.d);
	199	/* Now copy into final output, truncating as nec. */
01769a73	200	string = (unsigned char *) sprintf_buffer;
f4c730d3 RS	201	goto doit;
	202	}
	203
24f98398 JA	204	case 'S':
	205	string[-1] = 's';
	206	case 's':
	207	if (cnt == nargs)
fb08db45	208	error ("Not enough arguments for format string");
24f98398 JA	209	if (fmtcpy[1] != 's')
24f98398 JA	210	minlen = atoi (&fmtcpy[1]);
e267324c KR	211	string = (unsigned char *) args[cnt++];
e267324c KR	212	tem = strlen (string);
a0ca925c	213	width = strwidth (string, tem);
1513af9e RS	214	goto doit1;
1513af9e RS	215
24f98398 JA	216	/* Copy string into final output, truncating if no room. */
24f98398 JA	217	doit:
a0ca925c KH	218	/* Coming here means STRING contains ASCII only. */
a0ca925c KH	219	width = tem = strlen (string);
35a65fce	220	doit1:
a0ca925c KH	221	/* We have already calculated:
	222	TEM -- length of STRING,
	223	WIDTH -- columns occupied by STRING when displayed, and
	224	MINLEN -- minimum columns of the output. */
24f98398 JA	225	if (minlen > 0)
24f98398 JA	226	{
a0ca925c	227	while (minlen > width && bufsize > 0)
24f98398 JA	228	{
	229	*bufptr++ = ' ';
	230	bufsize--;
	231	minlen--;
	232	}
	233	minlen = 0;
	234	}
	235	if (tem > bufsize)
a0ca925c KH	236	{
	237	/* Truncate the string at character boundary. */
	238	tem = bufsize;
a50545d9	239	while (!CHAR_HEAD_P (string[tem - 1])) tem--;
a0ca925c KH	240	bcopy (string, bufptr, tem);
	241	/* We must calculate WIDTH again. */
	242	width = strwidth (bufptr, tem);
	243	}
	244	else
	245	bcopy (string, bufptr, tem);
24f98398 JA	246	bufptr += tem;
	247	bufsize -= tem;
	248	if (minlen < 0)
	249	{
a0ca925c	250	while (minlen < - width && bufsize > 0)
24f98398 JA	251	{
	252	*bufptr++ = ' ';
	253	bufsize--;
	254	minlen++;
	255	}
	256	minlen = 0;
	257	}
	258	continue;
	259
	260	case 'c':
	261	if (cnt == nargs)
fb08db45	262	error ("Not enough arguments for format string");
91f045df KH	263	tem = CHAR_STRING ((int) (EMACS_INT) args[cnt], charbuf);
91f045df KH	264	string = charbuf;
a0ca925c KH	265	cnt++;
	266	string[tem] = 0;
	267	width = strwidth (string, tem);
35a65fce RS	268	if (fmtcpy[1] != 'c')
	269	minlen = atoi (&fmtcpy[1]);
	270	goto doit1;
24f98398 JA	271
	272	case '%':
	273	fmt--; /* Drop thru and this % will be treated as normal */
	274	}
	275	}
a0ca925c KH	276
	277	{
	278	/* Just some character; Copy it if the whole multi-byte form
	279	fit in the buffer. */
	280	char *save_bufptr = bufptr;
	281
	282	do { bufptr++ = fmt++; }
a50545d9 RS	283	while (--bufsize > 0 && !CHAR_HEAD_P (*fmt));
a50545d9 RS	284	if (!CHAR_HEAD_P (*fmt))
a0ca925c KH	285	{
	286	bufptr = save_bufptr;
	287	break;
	288	}
	289	}
24f98398 JA	290	};
24f98398 JA	291
f4c730d3	292	/* If we had to malloc something, free it. */
70fdbb46	293	xfree (big_buffer);
f4c730d3	294
24f98398 JA	295	bufptr = 0; / Make sure our string end with a '\0' */
	296	return bufptr - buffer;
	297	}
6b61353c KH	298
	299	/* arch-tag: aa0ab528-7c5f-4c73-894c-aa2526a1efb3
	300	(do not change this comment) */