[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  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, 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; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */


#include <config.h>
#include <stdio.h>
#include <ctype.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;
{
  return doprnt1 (0, buffer, bufsize, format, format_end, nargs, args);
}

/* Like doprnt except that strings in ARGS are passed
   as Lisp_Object.  */

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