[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  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"

/* 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 (char *buffer, register int bufsize, char *format, char *format_end, va_list ap)
{
  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 (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, va_arg(ap, char *));
	      /* Now copy into final output, truncating as nec.  */
	      string = (unsigned char *) sprintf_buffer;
	      goto doit;

	    case 'f':
	    case 'e':
	    case 'g':
	      {
		double d = va_arg(ap, double);
		sprintf (sprintf_buffer, fmtcpy, d);
		/* Now copy into final output, truncating as nec.  */
		string = (unsigned char *) sprintf_buffer;
		goto doit;
	      }

	    case 'S':
	      string[-1] = 's';
	    case 's':
	      if (fmtcpy[1] != 's')
		minlen = atoi (&fmtcpy[1]);
	      string = va_arg(ap, unsigned char *);
	      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--;
		  memcpy (bufptr, string, tem);
		  /* We must calculate WIDTH again.  */
		  width = strwidth (bufptr, tem);
		}
	      else
		memcpy (bufptr, string, tem);
	      bufptr += tem;
	      bufsize -= tem;
	      if (minlen < 0)
		{
		  while (minlen < - width && bufsize > 0)
		    {
		      *bufptr++ = ' ';
		      bufsize--;
		      minlen++;
		    }
		  minlen = 0;
		}
	      continue;

	    case 'c':
	      {
		/* Sometimes for %c we pass a char, which would widen
		   to int.  Sometimes we pass XFASTINT() or XINT()
		   values, which would be EMACS_INT.  Let's hope that
		   both are passed the same way, otherwise we'll need
		   to rewrite callers.  */
		EMACS_INT chr = va_arg(ap, EMACS_INT);
		tem = CHAR_STRING ((int) chr, charbuf);
		string = charbuf;
		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,
114f9c96	5	2006, 2007, 2008, 2009, 2010 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
f4c730d3 RS	51	/* Generate output from a format-spec FORMAT,
	52	terminated at position FORMAT_END.
	53	Output goes in BUFFER, which has room for BUFSIZE chars.
	54	If the output does not fit, truncate it to fit.
6afc669e	55	Returns the number of bytes stored into BUFFER.
f4c730d3	56	ARGS points to the vector of arguments, and NARGS says how many.
1513af9e RS	57	A double counts as two arguments.
	58	String arguments are passed as C strings.
	59	Integers are passed as C integers. */
f4c730d3	60
dfcf069d	61	int
6a8033e1	62	doprnt (char buffer, register int bufsize, char format, char *format_end, va_list ap)
24f98398	63	{
24f98398 JA	64	register char fmt = format; / Pointer into format string */
24f98398 JA	65	register char bufptr = buffer; / Pointer into output buffer.. */
03383aaf	66
f4c730d3	67	/* Use this for sprintf unless we need something really big. */
be65c2f4	68	char tembuf[DBL_MAX_10_EXP + 100];
03383aaf	69
f4c730d3	70	/* Size of sprintf_buffer. */
01769a73	71	unsigned size_allocated = sizeof (tembuf);
03383aaf	72
f4c730d3 RS	73	/* Buffer to use for sprintf. Either tembuf or same as BIG_BUFFER. */
f4c730d3 RS	74	char *sprintf_buffer = tembuf;
03383aaf	75
f4c730d3 RS	76	/* Buffer we have got with malloc. */
f4c730d3 RS	77	char *big_buffer = 0;
03383aaf	78
24f98398	79	register int tem;
c292461f	80	unsigned char *string;
03383aaf BF	81	char fixed_buffer[20]; /* Default buffer for small formatting. */
03383aaf BF	82	char *fmtcpy;
24f98398	83	int minlen;
1f625c6c	84	unsigned char charbuf[MAX_MULTIBYTE_LENGTH + 1]; /* Used for %c. */
24f98398 JA	85
	86	if (format_end == 0)
	87	format_end = format + strlen (format);
	88
03383aaf BF	89	if ((format_end - format + 1) < sizeof (fixed_buffer))
	90	fmtcpy = fixed_buffer;
	91	else
91098d38	92	fmtcpy = (char *) alloca (format_end - format + 1);
03383aaf	93
24f98398	94	bufsize--;
03383aaf BF	95
	96	/* Loop until end of format string or buffer full. */
	97	while (fmt != format_end && bufsize > 0)
24f98398 JA	98	{
	99	if (fmt == '%') / Check for a '%' character */
	100	{
01769a73	101	unsigned size_bound = 0;
a0ca925c	102	int width; /* Columns occupied by STRING. */
f4c730d3	103
24f98398	104	fmt++;
d427b66a	105	/* Copy this one %-spec into fmtcpy. */
01769a73	106	string = (unsigned char *) fmtcpy;
24f98398	107	*string++ = '%';
03383aaf	108	while (1)
24f98398 JA	109	{
24f98398 JA	110	string++ = fmt;
be65c2f4 PE	111	if ('0' <= fmt && fmt <= '9')
	112	{
	113	/* Get an idea of how much space we might need.
	114	This might be a field width or a precision; e.g.
	115	%1.1000f and %1000.1f both might need 1000+ bytes.
	116	Parse the width or precision, checking for overflow. */
01769a73	117	unsigned n = *fmt - '0';
be65c2f4 PE	118	while ('0' <= fmt[1] && fmt[1] <= '9')
be65c2f4 PE	119	{
26898943	120	if (n * 10 + fmt[1] - '0' < n)
be65c2f4	121	error ("Format width or precision too large");
26898943	122	n = n * 10 + fmt[1] - '0';
be65c2f4 PE	123	string++ = ++fmt;
	124	}
	125
	126	if (size_bound < n)
	127	size_bound = n;
	128	}
01769a73	129	else if (fmt == '-' \|\| fmt == ' ' \|\| fmt == '.' \|\| fmt == '+')
be65c2f4 PE	130	;
be65c2f4 PE	131	else
24f98398 JA	132	break;
	133	fmt++;
	134	}
	135	*string = 0;
03383aaf	136
be65c2f4 PE	137	/* Make the size bound large enough to handle floating point formats
be65c2f4 PE	138	with large numbers. */
01769a73	139	if (size_bound + DBL_MAX_10_EXP + 50 < size_bound)
be65c2f4	140	error ("Format width or precision too large");
01769a73	141	size_bound += DBL_MAX_10_EXP + 50;
6e951728	142
f4c730d3 RS	143	/* Make sure we have that much. */
	144	if (size_bound > size_allocated)
	145	{
	146	if (big_buffer)
	147	big_buffer = (char *) xrealloc (big_buffer, size_bound);
	148	else
	149	big_buffer = (char *) xmalloc (size_bound);
	150	sprintf_buffer = big_buffer;
	151	size_allocated = size_bound;
	152	}
24f98398 JA	153	minlen = 0;
	154	switch (*fmt++)
	155	{
	156	default:
	157	error ("Invalid format operation %%%c", fmt[-1]);
	158
	159	/* case 'b': */
	160	case 'd':
	161	case 'o':
	162	case 'x':
f9fa352f RS	163	if (sizeof (int) == sizeof (EMACS_INT))
	164	;
	165	else if (sizeof (long) == sizeof (EMACS_INT))
	166	/* Insert an `l' the right place. */
	167	string[1] = string[0],
	168	string[0] = string[-1],
	169	string[-1] = 'l',
	170	string++;
	171	else
	172	abort ();
6a8033e1	173	sprintf (sprintf_buffer, fmtcpy, va_arg(ap, char *));
f4c730d3	174	/* Now copy into final output, truncating as nec. */
01769a73	175	string = (unsigned char *) sprintf_buffer;
24f98398 JA	176	goto doit;
24f98398 JA	177
f4c730d3 RS	178	case 'f':
	179	case 'e':
	180	case 'g':
	181	{
6a8033e1 KR	182	double d = va_arg(ap, double);
6a8033e1 KR	183	sprintf (sprintf_buffer, fmtcpy, d);
f4c730d3	184	/* Now copy into final output, truncating as nec. */
01769a73	185	string = (unsigned char *) sprintf_buffer;
f4c730d3 RS	186	goto doit;
	187	}
	188
24f98398 JA	189	case 'S':
	190	string[-1] = 's';
	191	case 's':
24f98398 JA	192	if (fmtcpy[1] != 's')
24f98398 JA	193	minlen = atoi (&fmtcpy[1]);
6a8033e1	194	string = va_arg(ap, unsigned char *);
e267324c	195	tem = strlen (string);
a0ca925c	196	width = strwidth (string, tem);
1513af9e RS	197	goto doit1;
1513af9e RS	198
24f98398 JA	199	/* Copy string into final output, truncating if no room. */
24f98398 JA	200	doit:
a0ca925c KH	201	/* Coming here means STRING contains ASCII only. */
a0ca925c KH	202	width = tem = strlen (string);
35a65fce	203	doit1:
a0ca925c KH	204	/* We have already calculated:
	205	TEM -- length of STRING,
	206	WIDTH -- columns occupied by STRING when displayed, and
	207	MINLEN -- minimum columns of the output. */
24f98398 JA	208	if (minlen > 0)
24f98398 JA	209	{
a0ca925c	210	while (minlen > width && bufsize > 0)
24f98398 JA	211	{
	212	*bufptr++ = ' ';
	213	bufsize--;
	214	minlen--;
	215	}
	216	minlen = 0;
	217	}
	218	if (tem > bufsize)
a0ca925c KH	219	{
	220	/* Truncate the string at character boundary. */
	221	tem = bufsize;
a50545d9	222	while (!CHAR_HEAD_P (string[tem - 1])) tem--;
72af86bd	223	memcpy (bufptr, string, tem);
a0ca925c KH	224	/* We must calculate WIDTH again. */
	225	width = strwidth (bufptr, tem);
	226	}
	227	else
72af86bd	228	memcpy (bufptr, string, tem);
24f98398 JA	229	bufptr += tem;
	230	bufsize -= tem;
	231	if (minlen < 0)
	232	{
a0ca925c	233	while (minlen < - width && bufsize > 0)
24f98398 JA	234	{
	235	*bufptr++ = ' ';
	236	bufsize--;
	237	minlen++;
	238	}
	239	minlen = 0;
	240	}
	241	continue;
	242
	243	case 'c':
6a8033e1 KR	244	{
	245	/* Sometimes for %c we pass a char, which would widen
	246	to int. Sometimes we pass XFASTINT() or XINT()
	247	values, which would be EMACS_INT. Let's hope that
	248	both are passed the same way, otherwise we'll need
	249	to rewrite callers. */
	250	EMACS_INT chr = va_arg(ap, EMACS_INT);
	251	tem = CHAR_STRING ((int) chr, charbuf);
	252	string = charbuf;
	253	string[tem] = 0;
	254	width = strwidth (string, tem);
	255	if (fmtcpy[1] != 'c')
	256	minlen = atoi (&fmtcpy[1]);
	257	goto doit1;
	258	}
24f98398 JA	259
	260	case '%':
	261	fmt--; /* Drop thru and this % will be treated as normal */
	262	}
	263	}
a0ca925c KH	264
	265	{
	266	/* Just some character; Copy it if the whole multi-byte form
	267	fit in the buffer. */
	268	char *save_bufptr = bufptr;
	269
	270	do { bufptr++ = fmt++; }
a50545d9 RS	271	while (--bufsize > 0 && !CHAR_HEAD_P (*fmt));
a50545d9 RS	272	if (!CHAR_HEAD_P (*fmt))
a0ca925c KH	273	{
	274	bufptr = save_bufptr;
	275	break;
	276	}
	277	}
24f98398 JA	278	};
24f98398 JA	279
f4c730d3	280	/* If we had to malloc something, free it. */
70fdbb46	281	xfree (big_buffer);
f4c730d3	282
24f98398 JA	283	bufptr = 0; / Make sure our string end with a '\0' */
	284	return bufptr - buffer;
	285	}
6b61353c KH	286
	287	/* arch-tag: aa0ab528-7c5f-4c73-894c-aa2526a1efb3
	288	(do not change this comment) */