[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 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 2, 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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */


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

#ifdef STDC_HEADERS
#include <float.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 "charset.h"

extern long *xmalloc (), *xrealloc ();

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 characters 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.  */
  int 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;
  char *string;
  char fixed_buffer[20];	/* Default buffer for small formatting. */
  char *fmtcpy;
  int minlen;
  int size;			/* Field width factor; e.g., %90d */
  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 */
	{
	  int size_bound = 0;
	  int width;		/* Columns occupied by STRING.  */

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

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

	  /* Make the size bound large enough to handle floating point formats
	     with large numbers.  */
	  size_bound += DBL_MAX_10_EXP + 50;

	  if (size_bound < 0)
	    error ("Format width or precision too large");

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