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

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