print.c 43.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
2
   Copyright (C) 1985, 86, 88, 93, 94, 95, 97 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23 24 25 26 27
#include <stdio.h>
#include "lisp.h"

#ifndef standalone
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
28
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
30 31 32 33
#include "window.h"
#include "process.h"
#include "dispextern.h"
#include "termchar.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
34
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
35 36
#endif /* not standalone */

Richard M. Stallman's avatar
Richard M. Stallman committed
37 38 39 40
#ifdef USE_TEXT_PROPERTIES
#include "intervals.h"
#endif

Jim Blandy's avatar
Jim Blandy committed
41 42
Lisp_Object Vstandard_output, Qstandard_output;

Erik Naggum's avatar
Erik Naggum committed
43 44 45
/* These are used to print like we read.  */
extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;

Jim Blandy's avatar
Jim Blandy committed
46 47
#ifdef LISP_FLOAT_TYPE
Lisp_Object Vfloat_output_format, Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

/* Work around a problem that happens because math.h on hpux 7
   defines two static variables--which, in Emacs, are not really static,
   because `static' is defined as nothing.  The problem is that they are
   defined both here and in lread.c.
   These macros prevent the name conflict.  */
#if defined (HPUX) && !defined (HPUX8)
#define _MAXLDBL print_maxldbl
#define _NMAXLDBL print_nmaxldbl
#endif

#include <math.h>

#if STDC_HEADERS
#include <float.h>
#include <stdlib.h>
#endif

/* Default to values appropriate for IEEE floating point.  */
#ifndef FLT_RADIX
#define FLT_RADIX 2
#endif
#ifndef DBL_MANT_DIG
#define DBL_MANT_DIG 53
#endif
#ifndef DBL_DIG
#define DBL_DIG 15
#endif
76 77 78 79 80 81 82 83
#ifndef DBL_MIN
#define DBL_MIN 2.2250738585072014e-308
#endif

#ifdef DBL_MIN_REPLACEMENT
#undef DBL_MIN
#define DBL_MIN DBL_MIN_REPLACEMENT
#endif
Paul Eggert's avatar
Paul Eggert committed
84 85 86 87 88 89 90 91 92 93 94 95

/* Define DOUBLE_DIGITS_BOUND, an upper bound on the number of decimal digits
   needed to express a float without losing information.
   The general-case formula is valid for the usual case, IEEE floating point,
   but many compilers can't optimize the formula to an integer constant,
   so make a special case for it.  */
#if FLT_RADIX == 2 && DBL_MANT_DIG == 53
#define DOUBLE_DIGITS_BOUND 17 /* IEEE floating point */
#else
#define DOUBLE_DIGITS_BOUND ((int) ceil (log10 (pow (FLT_RADIX, DBL_MANT_DIG))))
#endif

Jim Blandy's avatar
Jim Blandy committed
96 97 98 99 100
#endif /* LISP_FLOAT_TYPE */

/* Avoid actual stack overflow in print.  */
int print_depth;

101 102 103 104
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
Lisp_Object being_printed[PRINT_CIRCLE];

105 106 107 108 109 110 111 112 113
/* When printing into a buffer, first we put the text in this
   block, then insert it all at once.  */
char *print_buffer;

/* Size allocated in print_buffer.  */
int print_buffer_size;
/* Size used in print_buffer.  */
int print_buffer_pos;

Jim Blandy's avatar
Jim Blandy committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
/* Maximum length of list to print in full; noninteger means
   effectively infinity */

Lisp_Object Vprint_length;

/* Maximum depth of list to print in full; noninteger means
   effectively infinity.  */

Lisp_Object Vprint_level;

/* Nonzero means print newlines in strings as \n.  */

int print_escape_newlines;

Lisp_Object Qprint_escape_newlines;

Erik Naggum's avatar
Erik Naggum committed
130 131 132 133
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

134 135 136
/* Non-nil means print #: before uninterned symbols.
   Neither t nor nil means so that and don't clear Vprint_gensym_alist
   on entry to and exit from print functions.  */
137

138
Lisp_Object Vprint_gensym;
139 140 141 142 143

/* Association list of certain objects that are `eq' in the form being
   printed and which should be `eq' when read back in, using the #n=object
   and #n# reader forms.  Each element has the form (object . n).  */

144
Lisp_Object Vprint_gensym_alist;
Erik Naggum's avatar
Erik Naggum committed
145

146
/* Nonzero means print newline to stdout before next minibuffer message.
Jim Blandy's avatar
Jim Blandy committed
147 148 149
   Defined in xdisp.c */

extern int noninteractive_need_newline;
150

151 152
extern int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
153 154 155 156
#ifdef MAX_PRINT_CHARS
static int print_chars;
static int max_print;
#endif /* MAX_PRINT_CHARS */
Richard M. Stallman's avatar
Richard M. Stallman committed
157 158

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

#if 0
/* Convert between chars and GLYPHs */

int
glyphlen (glyphs)
     register GLYPH *glyphs;
{
  register int i = 0;

  while (glyphs[i])
    i++;
  return i;
}

void
str_to_glyph_cpy (str, glyphs)
     char *str;
     GLYPH *glyphs;
{
  register GLYPH *gp = glyphs;
  register char *cp = str;

  while (*cp)
    *gp++ = *cp++;
}

void
str_to_glyph_ncpy (str, glyphs, n)
     char *str;
     GLYPH *glyphs;
     register int n;
{
  register GLYPH *gp = glyphs;
  register char *cp = str;

  while (n-- > 0)
    *gp++ = *cp++;
}

void
glyph_to_str_cpy (glyphs, str)
     GLYPH *glyphs;
     char *str;
{
  register GLYPH *gp = glyphs;
  register char *cp = str;

  while (*gp)
    *str++ = *gp++ & 0377;
}
#endif

212
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
213 214

/* Lisp functions to do output using a stream
215 216 217 218 219
   must have the stream in a variable called printcharfun
   and must start with PRINTPREPARE, end with PRINTFINISH,
   and use PRINTDECLARE to declare common variables.
   Use PRINTCHAR to output one character,
   or call strout to output a block of characters.
Jim Blandy's avatar
Jim Blandy committed
220 221
*/ 

222 223 224
#define PRINTDECLARE						\
   struct buffer *old = current_buffer;				\
   int old_point = -1, start_point;				\
225
   int old_point_byte, start_point_byte;			\
226 227
   int specpdl_count = specpdl_ptr - specpdl;			\
   int free_print_buffer = 0;					\
228 229
   Lisp_Object original

230 231 232
#define PRINTPREPARE						\
   original = printcharfun;					\
   if (NILP (printcharfun)) printcharfun = Qt;			\
233
   if (BUFFERP (printcharfun))					\
234 235
     {								\
       if (XBUFFER (printcharfun) != current_buffer)		\
236
	 Fset_buffer (printcharfun);				\
237 238
       printcharfun = Qnil;					\
     }								\
239
   if (MARKERP (printcharfun))					\
240 241
     {								\
       if (!(XMARKER (original)->buffer))			\
242 243 244
         error ("Marker does not point anywhere");		\
       if (XMARKER (original)->buffer != current_buffer)	\
         set_buffer_internal (XMARKER (original)->buffer);	\
245
       old_point = PT;						\
246 247 248
       old_point_byte = PT_BYTE;				\
       SET_PT_BOTH (marker_position (printcharfun),		\
		    marker_byte_position (printcharfun));	\
249
       start_point = PT;					\
250
       start_point_byte = PT_BYTE;				\
251 252
       printcharfun = Qnil;					\
     }								\
253 254
   if (NILP (printcharfun))					\
     {								\
255 256 257 258 259 260 261 262
       if (print_buffer != 0)					\
	 record_unwind_protect (print_unwind,			\
				make_string (print_buffer,	\
					     print_buffer_pos)); \
       else							\
	 {							\
           print_buffer_size = 1000;				\
           print_buffer = (char *) xmalloc (print_buffer_size);	\
263
	   free_print_buffer = 1;				\
264
	 }							\
265 266
       print_buffer_pos = 0;					\
     }								\
267 268
   if (!CONSP (Vprint_gensym))					\
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
269

270
#define PRINTFINISH					\
271 272
   if (NILP (printcharfun))				\
     insert (print_buffer, print_buffer_pos);		\
273
   if (free_print_buffer)				\
274
     {							\
275
       xfree (print_buffer);				\
276 277
       print_buffer = 0;				\
     }							\
278
   unbind_to (specpdl_count, Qnil);			\
279
   if (MARKERP (original))				\
280
     set_marker_both (original, Qnil, PT, PT_BYTE);	\
281
   if (old_point >= 0)					\
282 283 284 285
     SET_PT_BOTH (old_point + (old_point >= start_point	\
			       ? PT - start_point : 0), \
		  old_point_byte + (old_point_byte >= start_point_byte	\
			       ? PT_BYTE - start_point_byte : 0));	\
286
   if (old != current_buffer)				\
287
     set_buffer_internal (old);				\
288 289
   if (!CONSP (Vprint_gensym))				\
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
290 291 292

#define PRINTCHAR(ch) printchar (ch, printcharfun)

293 294 295 296 297 298 299
/* Nonzero if there is no room to print any more characters
   so print might as well return right away.  */

#define PRINTFULLP()					\
 (EQ (printcharfun, Qt) && !noninteractive		\
  && printbufidx >= FRAME_WIDTH (XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)))))

300 301 302 303 304 305 306 307 308
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
static Lisp_Object
print_unwind (saved_text)
     Lisp_Object saved_text;
{
  bcopy (XSTRING (saved_text)->data, print_buffer, XSTRING (saved_text)->size);
}

309
/* Index of first unused element of FRAME_MESSAGE_BUF (mini_frame). */
Jim Blandy's avatar
Jim Blandy committed
310 311 312 313
static int printbufidx;

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
314
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
315 316 317 318 319 320 321 322 323 324 325
     Lisp_Object fun;
{
  Lisp_Object ch1;

#ifdef MAX_PRINT_CHARS
  if (max_print)
    print_chars++;
#endif /* MAX_PRINT_CHARS */
#ifndef standalone
  if (EQ (fun, Qnil))
    {
Karl Heuer's avatar
Karl Heuer committed
326
      int len;
327
      unsigned char work[4], *str;
Karl Heuer's avatar
Karl Heuer committed
328

Jim Blandy's avatar
Jim Blandy committed
329
      QUIT;
Karl Heuer's avatar
Karl Heuer committed
330 331
      len = CHAR_STRING (ch, work, str);
      if (print_buffer_pos + len >= print_buffer_size)
332 333
	print_buffer = (char *) xrealloc (print_buffer,
					  print_buffer_size *= 2);
Karl Heuer's avatar
Karl Heuer committed
334 335
      bcopy (str, print_buffer + print_buffer_pos, len);
      print_buffer_pos += len;
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339 340
      return;
    }

  if (EQ (fun, Qt))
    {
341
      FRAME_PTR mini_frame
342
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));
Karl Heuer's avatar
Karl Heuer committed
343 344
      unsigned char work[4], *str;
      int len = CHAR_STRING (ch, work, str);
345

346 347
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
348 349
      if (noninteractive)
	{
Karl Heuer's avatar
Karl Heuer committed
350 351
	  while (len--)
	    putchar (*str), str++;
Jim Blandy's avatar
Jim Blandy committed
352 353 354 355
	  noninteractive_need_newline = 1;
	  return;
	}

356
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
357 358
	  || !message_buf_print)
	{
359
	  message_log_maybe_newline ();
360
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
361
	  printbufidx = 0;
362
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
363
	  message_buf_print = 1;
364 365 366 367 368 369 370 371 372 373 374

	  if (minibuffer_auto_raise)
	    {
	      Lisp_Object mini_window;

	      /* Get the frame containing the minibuffer
		 that the selected frame is using.  */
	      mini_window = FRAME_MINIBUF_WINDOW (selected_frame);

	      Fraise_frame  (WINDOW_FRAME (XWINDOW (mini_window)));
	    }
Jim Blandy's avatar
Jim Blandy committed
375 376
	}

Karl Heuer's avatar
Karl Heuer committed
377 378 379 380
      message_dolog (str, len, 0);
      if (printbufidx < FRAME_MESSAGE_BUF_SIZE (mini_frame) - len)
	bcopy (str, &FRAME_MESSAGE_BUF (mini_frame)[printbufidx], len),
	printbufidx += len;
381
      FRAME_MESSAGE_BUF (mini_frame)[printbufidx] = 0;
382
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
383 384 385 386 387

      return;
    }
#endif /* not standalone */

388
  XSETFASTINT (ch1, ch);
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393 394 395 396 397 398 399
  call1 (fun, ch1);
}

static void
strout (ptr, size, printcharfun)
     char *ptr;
     int size;
     Lisp_Object printcharfun;
{
  int i = 0;

Karl Heuer's avatar
Karl Heuer committed
400 401 402
  if (size < 0)
    size = strlen (ptr);

Jim Blandy's avatar
Jim Blandy committed
403 404
  if (EQ (printcharfun, Qnil))
    {
405 406 407 408 409 410 411 412 413
      if (print_buffer_pos + size > print_buffer_size)
	{
	  print_buffer_size = print_buffer_size * 2 + size;
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
      bcopy (ptr, print_buffer + print_buffer_pos, size);
      print_buffer_pos += size;

Jim Blandy's avatar
Jim Blandy committed
414 415
#ifdef MAX_PRINT_CHARS
      if (max_print)
416
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
417 418 419 420 421
#endif /* MAX_PRINT_CHARS */
      return;
    }
  if (EQ (printcharfun, Qt))
    {
422
      FRAME_PTR mini_frame
423 424
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));

425 426
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
427 428
#ifdef MAX_PRINT_CHARS
      if (max_print)
Karl Heuer's avatar
Karl Heuer committed
429
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
430 431 432 433
#endif /* MAX_PRINT_CHARS */

      if (noninteractive)
	{
Karl Heuer's avatar
Karl Heuer committed
434
	  fwrite (ptr, 1, size, stdout);
Jim Blandy's avatar
Jim Blandy committed
435 436 437 438
	  noninteractive_need_newline = 1;
	  return;
	}

439
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
440 441
	  || !message_buf_print)
	{
442
	  message_log_maybe_newline ();
443
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
444
	  printbufidx = 0;
445
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
446
	  message_buf_print = 1;
447 448 449 450 451 452 453 454 455 456 457

	  if (minibuffer_auto_raise)
	    {
	      Lisp_Object mini_window;

	      /* Get the frame containing the minibuffer
		 that the selected frame is using.  */
	      mini_window = FRAME_MINIBUF_WINDOW (selected_frame);

	      Fraise_frame  (WINDOW_FRAME (XWINDOW (mini_window)));
	    }
Jim Blandy's avatar
Jim Blandy committed
458 459
	}

Karl Heuer's avatar
Karl Heuer committed
460 461 462 463 464 465 466 467 468
      message_dolog (ptr, size, 0);
      if (size > FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1)
	{
	  size = FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1;
	  /* Rewind incomplete multi-byte form.  */
	  while (size && (unsigned char) ptr[size] >= 0xA0) size--;
	}
      bcopy (ptr, &FRAME_MESSAGE_BUF (mini_frame) [printbufidx], size);
      printbufidx += size;
469
      echo_area_glyphs_length = printbufidx;
470
      FRAME_MESSAGE_BUF (mini_frame) [printbufidx] = 0;
Jim Blandy's avatar
Jim Blandy committed
471 472 473 474

      return;
    }

Karl Heuer's avatar
Karl Heuer committed
475 476 477 478 479 480 481 482 483 484 485
  i = 0;
  while (i < size)
    {
      /* Here, we must convert each multi-byte form to the
         corresponding character code before handing it to PRINTCHAR.  */
      int len;
      int ch = STRING_CHAR_AND_LENGTH (ptr + i, size - i, len);

      PRINTCHAR (ch);
      i += len;
    }
Jim Blandy's avatar
Jim Blandy committed
486 487 488
}

/* Print the contents of a string STRING using PRINTCHARFUN.
489 490
   It isn't safe to use strout in many cases,
   because printing one char can relocate.  */
Jim Blandy's avatar
Jim Blandy committed
491

492
void
Jim Blandy's avatar
Jim Blandy committed
493 494 495 496
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
497 498
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
    /* strout is safe for output to a frame (echo area) or to print_buffer.  */
Jim Blandy's avatar
Jim Blandy committed
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
    strout (XSTRING (string)->data, XSTRING (string)->size, printcharfun);
  else
    {
      /* Otherwise, fetch the string address for each character.  */
      int i;
      int size = XSTRING (string)->size;
      struct gcpro gcpro1;
      GCPRO1 (string);
      for (i = 0; i < size; i++)
	PRINTCHAR (XSTRING (string)->data[i]);
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
514
  "Output character CHARACTER to stream PRINTCHARFUN.\n\
Karl Heuer's avatar
Karl Heuer committed
515
PRINTCHARFUN defaults to the value of `standard-output' (which see).")
516 517
  (character, printcharfun)
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
518
{
519
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
520

Jim Blandy's avatar
Jim Blandy committed
521
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
522
    printcharfun = Vstandard_output;
523
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
524
  PRINTPREPARE;
525
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
526
  PRINTFINISH;
527
  return character;
Jim Blandy's avatar
Jim Blandy committed
528 529 530 531 532 533
}

/* Used from outside of print.c to print a block of SIZE chars at DATA
   on the default output stream.
   Do not use this on the contents of a Lisp string.  */

534
void
Jim Blandy's avatar
Jim Blandy committed
535 536 537 538
write_string (data, size)
     char *data;
     int size;
{
539
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
540 541 542 543 544 545 546 547 548 549 550 551 552
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
  strout (data, size, printcharfun);
  PRINTFINISH;
}

/* Used from outside of print.c to print a block of SIZE chars at DATA
   on a specified stream PRINTCHARFUN.
   Do not use this on the contents of a Lisp string.  */

553
void
Jim Blandy's avatar
Jim Blandy committed
554 555 556 557 558
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
559
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577

  PRINTPREPARE;
  strout (data, size, printcharfun);
  PRINTFINISH;
}


#ifndef standalone

void
temp_output_buffer_setup (bufname)
    char *bufname;
{
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

  Fset_buffer (Fget_buffer_create (build_string (bufname)));

578
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
579 580 581
  current_buffer->read_only = Qnil;
  Ferase_buffer ();

582
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
583 584 585 586 587 588 589 590
  specbind (Qstandard_output, buf);

  set_buffer_internal (old);
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
     char *bufname;
591
     Lisp_Object (*function) ();
Jim Blandy's avatar
Jim Blandy committed
592 593 594 595
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
596
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
597

598
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
599 600 601
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
602
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
603 604 605

  val = (*function) (args);

606
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
607
  temp_output_buffer_show (buf);
608
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
609 610 611 612 613 614 615 616 617 618 619 620

  return unbind_to (count, val);
}

DEFUN ("with-output-to-temp-buffer", Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
       1, UNEVALLED, 0,
  "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.\n\
The buffer is cleared out initially, and marked as unmodified when done.\n\
All output done by BODY is inserted in that buffer by default.\n\
The buffer is displayed in another window, but not selected.\n\
The value of the last form in BODY is returned.\n\
If BODY does not finish normally, the buffer BUFNAME is not displayed.\n\n\
621
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
Jim Blandy's avatar
Jim Blandy committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
to get the buffer displayed.  It gets one argument, the buffer to display.")
  (args)
     Lisp_Object args;
{
  struct gcpro gcpro1;
  Lisp_Object name;
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
  UNGCPRO;

  CHECK_STRING (name, 0);
  temp_output_buffer_setup (XSTRING (name)->data);
  buf = Vstandard_output;

  val = Fprogn (Fcdr (args));

  temp_output_buffer_show (buf);

  return unbind_to (count, val);
}
#endif /* not standalone */

static void print ();

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
650 651
  "Output a newline to stream PRINTCHARFUN.\n\
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.")
Jim Blandy's avatar
Jim Blandy committed
652 653 654
  (printcharfun)
     Lisp_Object printcharfun;
{
655
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
656

Jim Blandy's avatar
Jim Blandy committed
657
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
658 659 660 661 662 663 664 665 666 667 668
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
  "Output the printed representation of OBJECT, any Lisp object.\n\
Quoting characters are printed when needed to make output that `read'\n\
can handle, whenever this is possible.\n\
Karl Heuer's avatar
Karl Heuer committed
669
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
670 671
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
672
{
673
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
674 675 676 677

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
678
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
679 680 681
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
682
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
683
  PRINTFINISH;
684
  return object;
Jim Blandy's avatar
Jim Blandy committed
685 686 687 688 689 690 691 692 693 694
}

/* a buffer which is used to hold output being built by prin1-to-string */
Lisp_Object Vprin1_to_string_buffer;

DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
  "Return a string containing the printed representation of OBJECT,\n\
any Lisp object.  Quoting characters are used when needed to make output\n\
that `read' can handle, whenever this is possible, unless the optional\n\
second argument NOESCAPE is non-nil.")
695 696
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
697
{
698 699
  PRINTDECLARE;
  Lisp_Object printcharfun;
700 701 702 703 704 705 706 707
  struct gcpro gcpro1, gcpro2;
  Lisp_Object tem;

  /* Save and restore this--we are altering a buffer
     but we don't want to deactivate the mark just for that.
     No need for specbind, since errors deactivate the mark.  */
  tem = Vdeactivate_mark;
  GCPRO2 (object, tem);
Jim Blandy's avatar
Jim Blandy committed
708 709 710 711

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print_depth = 0;
712
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
713 714 715
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
716
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
717 718 719

  Ferase_buffer ();
  set_buffer_internal (old);
720 721

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
722 723
  UNGCPRO;

724
  return object;
Jim Blandy's avatar
Jim Blandy committed
725 726 727 728 729 730
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
  "Output the printed representation of OBJECT, any Lisp object.\n\
No quoting characters are used; no delimiters are printed around\n\
the contents of strings.\n\
Karl Heuer's avatar
Karl Heuer committed
731
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
732 733
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
734
{
735
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
736

Jim Blandy's avatar
Jim Blandy committed
737
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
738 739 740
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
741
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
742
  PRINTFINISH;
743
  return object;
Jim Blandy's avatar
Jim Blandy committed
744 745 746 747 748 749
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
  "Output the printed representation of OBJECT, with newlines around it.\n\
Quoting characters are printed when needed to make output that `read'\n\
can handle, whenever this is possible.\n\
Karl Heuer's avatar
Karl Heuer committed
750
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
751 752
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
753
{
754
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
755 756 757 758 759 760
  struct gcpro gcpro1;

#ifdef MAX_PRINT_CHARS
  print_chars = 0;
  max_print = MAX_PRINT_CHARS;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
761
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
762
    printcharfun = Vstandard_output;
763
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
764 765 766
  PRINTPREPARE;
  print_depth = 0;
  PRINTCHAR ('\n');
767
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
768 769 770 771 772 773 774
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
775
  return object;
Jim Blandy's avatar
Jim Blandy committed
776 777 778 779 780 781
}

/* The subroutine object for external-debugging-output is kept here
   for the convenience of the debugger.  */
Lisp_Object Qexternal_debugging_output;

Jim Blandy's avatar
Jim Blandy committed
782 783
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
  "Write CHARACTER to stderr.\n\
Jim Blandy's avatar
Jim Blandy committed
784 785
You can call print while debugging emacs, and pass it this function\n\
to make it write to the debugging output.\n")
Jim Blandy's avatar
Jim Blandy committed
786 787
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
788 789 790
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
791 792 793 794 795 796 797 798 799

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
  {
    char buf[2] = {(char) XINT (character), '\0'};
    OutputDebugString (buf);
  }
#endif

Jim Blandy's avatar
Jim Blandy committed
800 801
  return character;
}
802 803 804 805 806 807 808 809

/* This is the interface for debugging printing.  */

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
810
  fprintf (stderr, "\r\n");
811
}
Jim Blandy's avatar
Jim Blandy committed
812

813 814 815 816 817 818 819 820 821 822
DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
       1, 1, 0,
  "Convert an error value (ERROR-SYMBOL . DATA) to an error message.")
  (obj)
     Lisp_Object obj;
{
  struct buffer *old = current_buffer;
  Lisp_Object original, printcharfun, value;
  struct gcpro gcpro1;

823 824 825 826 827 828 829 830 831
  /* If OBJ is (error STRING), just return STRING.
     That is not only faster, it also avoids the need to allocate
     space here when the error is due to memory full.  */
  if (CONSP (obj) && EQ (XCONS (obj)->car, Qerror)
      && CONSP (XCONS (obj)->cdr)
      && STRINGP (XCONS (XCONS (obj)->cdr)->car)
      && NILP (XCONS (XCONS (obj)->cdr)->cdr))
    return XCONS (XCONS (obj)->cdr)->car;

832
  print_error_message (obj, Vprin1_to_string_buffer);
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847

  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
  value = Fbuffer_string ();

  GCPRO1 (value);
  Ferase_buffer ();
  set_buffer_internal (old);
  UNGCPRO;

  return value;
}

/* Print an error message for the error DATA
   onto Lisp output stream STREAM (suitable for the print functions).  */

848
void
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
print_error_message (data, stream)
     Lisp_Object data, stream;
{
  Lisp_Object errname, errmsg, file_error, tail;
  struct gcpro gcpro1;
  int i;

  errname = Fcar (data);

  if (EQ (errname, Qerror))
    {
      data = Fcdr (data);
      if (!CONSP (data)) data = Qnil;
      errmsg = Fcar (data);
      file_error = Qnil;
    }
  else
    {
      errmsg = Fget (errname, Qerror_message);
      file_error = Fmemq (Qfile_error,
			  Fget (errname, Qerror_conditions));
    }

  /* Print an error message including the data items.  */

  tail = Fcdr_safe (data);
  GCPRO1 (tail);

  /* For file-error, make error message by concatenating
     all the data items.  They are all strings.  */
  if (!NILP (file_error) && !NILP (tail))
    errmsg = XCONS (tail)->car, tail = XCONS (tail)->cdr;

  if (STRINGP (errmsg))
    Fprinc (errmsg, stream);
  else
    write_string_1 ("peculiar error", -1, stream);

  for (i = 0; CONSP (tail); tail = Fcdr (tail), i++)
    {
      write_string_1 (i ? ", " : ": ", 2, stream);
      if (!NILP (file_error))
	Fprinc (Fcar (tail), stream);
      else
	Fprin1 (Fcar (tail), stream);
    }
  UNGCPRO;
}

Jim Blandy's avatar
Jim Blandy committed
898 899 900
#ifdef LISP_FLOAT_TYPE

/*
901
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
902
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
903 904 905 906 907 908 909 910 911 912
 * 20d float_output_format, with the negative of the C-constant "HUGE"
 * from <math.h>.
 * 
 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
 * 
 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
 * case of -1e307 in 20d float_output_format. What is one to do (short of
 * re-writing _doprnt to be more sane)?
 * 			-wsr
 */
913 914 915

void
float_to_string (buf, data)
916
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
917 918
     double data;
{
919
  unsigned char *cp;
920
  int width;
Jim Blandy's avatar
Jim Blandy committed
921
      
Jim Blandy's avatar
Jim Blandy committed
922
  if (NILP (Vfloat_output_format)
923
      || !STRINGP (Vfloat_output_format))
Jim Blandy's avatar
Jim Blandy committed
924
  lose:
925
    {
Paul Eggert's avatar
Paul Eggert committed
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
      /* Generate the fewest number of digits that represent the
	 floating point value without losing information.
	 The following method is simple but a bit slow.
	 For ideas about speeding things up, please see:

	 Guy L Steele Jr & Jon L White, How to print floating-point numbers
	 accurately.  SIGPLAN notices 25, 6 (June 1990), 112-126.

	 Robert G Burger & R Kent Dybvig, Printing floating point numbers
	 quickly and accurately, SIGPLAN notices 31, 5 (May 1996), 108-116.  */

      width = fabs (data) < DBL_MIN ? 1 : DBL_DIG;
      do
	sprintf (buf, "%.*g", width, data);
      while (width++ < DOUBLE_DIGITS_BOUND && atof (buf) != data);
941
    }
Jim Blandy's avatar
Jim Blandy committed
942 943 944 945 946 947 948 949 950 951 952 953 954
  else			/* oink oink */
    {
      /* Check that the spec we have is fully valid.
	 This means not only valid for printf,
	 but meant for floats, and reasonable.  */
      cp = XSTRING (Vfloat_output_format)->data;

      if (cp[0] != '%')
	goto lose;
      if (cp[1] != '.')
	goto lose;

      cp += 2;
955 956

      /* Check the width specification.  */
957
      width = -1;
958
      if ('0' <= *cp && *cp <= '9')
959 960 961 962 963 964 965 966 967 968 969
	{
	  width = 0;
	  do
	    width = (width * 10) + (*cp++ - '0');
	  while (*cp >= '0' && *cp <= '9');

	  /* A precision of zero is valid only for %f.  */
	  if (width > DBL_DIG
	      || (width == 0 && *cp != 'f'))
	    goto lose;
	}
Jim Blandy's avatar
Jim Blandy committed
970 971 972 973 974 975 976 977 978

      if (*cp != 'e' && *cp != 'f' && *cp != 'g')
	goto lose;

      if (cp[1] != 0)
	goto lose;

      sprintf (buf, XSTRING (Vfloat_output_format)->data, data);
    }
979

980 981
  /* Make sure there is a decimal point with digit after, or an
     exponent, so that the value is readable as a float.  But don't do
982 983 984
     this with "%.0f"; it's valid for that not to produce a decimal
     point.  Note that width can be 0 only for %.0f.  */
  if (width != 0)
985
    {
986 987 988
      for (cp = buf; *cp; cp++)
	if ((*cp < '0' || *cp > '9') && *cp != '-')
	  break;
989

990 991 992 993 994 995 996 997 998 999 1000 1001
      if (*cp == '.' && cp[1] == 0)
	{
	  cp[1] = '0';
	  cp[2] = 0;
	}

      if (*cp == 0)
	{
	  *cp++ = '.';
	  *cp++ = '0';
	  *cp++ = 0;
	}
1002
    }
Jim Blandy's avatar
Jim Blandy committed
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
}
#endif /* LISP_FLOAT_TYPE */

static void
print (obj, printcharfun, escapeflag)
     Lisp_Object obj;
     register Lisp_Object printcharfun;
     int escapeflag;
{
  char buf[30];

  QUIT;

1016 1017 1018
#if 1  /* I'm not sure this is really worth doing.  */
  /* Detect circularities and truncate them.
     No need to offer any alternative--this is better than an error.  */
1019
  if (CONSP (obj) || VECTORP (obj) || COMPILEDP (obj))
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
    {
      int i;
      for (i = 0; i < print_depth; i++)
	if (EQ (obj, being_printed[i]))
	  {
	    sprintf (buf, "#%d", i);
	    strout (buf, -1, printcharfun);
	    return;
	  }
    }
#endif

  being_printed[print_depth] = obj;
Jim Blandy's avatar
Jim Blandy committed
1033 1034
  print_depth++;

1035
  if (print_depth > PRINT_CIRCLE)
Jim Blandy's avatar
Jim Blandy committed
1036 1037 1038 1039 1040 1041 1042 1043 1044
    error ("Apparently circular structure being printed");
#ifdef MAX_PRINT_CHARS
  if (max_print && print_chars > max_print)
    {
      PRINTCHAR ('\n');
      print_chars = 0;
    }
#endif /* MAX_PRINT_CHARS */

1045
  switch (XGCTYPE (obj))
Jim Blandy's avatar
Jim Blandy committed
1046
    {
1047
    case Lisp_Int:
1048 1049 1050 1051 1052 1053
      if (sizeof (int) == sizeof (EMACS_INT))
	sprintf (buf, "%d", XINT (obj));
      else if (sizeof (long) == sizeof (EMACS_INT))
	sprintf (buf, "%ld", XINT (obj));
      else
	abort ();
Jim Blandy's avatar
Jim Blandy committed
1054
      strout (buf, -1, printcharfun);
1055 1056
      break;

Karl Heuer's avatar
Karl Heuer committed
1057
#ifdef LISP_FLOAT_TYPE
1058 1059 1060
    case Lisp_Float:
      {
	char pigbuf[350];	/* see comments in float_to_string */
Jim Blandy's avatar
Jim Blandy committed
1061

1062 1063 1064 1065
	float_to_string (pigbuf, XFLOAT(obj)->data);
	strout (pigbuf, -1, printcharfun);
      }
      break;
Karl Heuer's avatar
Karl Heuer committed
1066
#endif
1067 1068

    case Lisp_String:
Jim Blandy's avatar
Jim Blandy committed
1069 1070 1071 1072 1073 1074 1075
      if (!escapeflag)
	print_string (obj, printcharfun);
      else
	{
	  register int i;
	  register unsigned char c;
	  struct gcpro gcpro1;
1076
	  int size;
Jim Blandy's avatar
Jim Blandy committed
1077

Richard M. Stallman's avatar
Richard M. Stallman committed
1078 1079 1080 1081 1082 1083 1084 1085 1086
	  GCPRO1 (obj);

#ifdef USE_TEXT_PROPERTIES
	  if (!NULL_INTERVAL_P (XSTRING (obj)->intervals))
	    {
	      PRINTCHAR ('#');
	      PRINTCHAR ('(');
	    }
#endif
Jim Blandy's avatar
Jim Blandy committed
1087 1088

	  PRINTCHAR ('\"');
1089 1090
	  size = XSTRING (obj)->size;
	  for (i = 0; i < size;)
Jim Blandy's avatar
Jim Blandy committed
1091
	    {
1092 1093 1094 1095 1096 1097
	      /* Here, we must convert each multi-byte form to the
		 corresponding character code before handing it to PRINTCHAR.  */
	      int len;
	      int c = STRING_CHAR_AND_LENGTH (&XSTRING (obj)->data[i],
					      size - i, len);
	      i += len;
Jim Blandy's avatar
Jim Blandy committed
1098
	      QUIT;
1099

Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102 1103 1104
	      if (c == '\n' && print_escape_newlines)
		{
		  PRINTCHAR ('\\');
		  PRINTCHAR ('n');
		}
1105 1106 1107 1108 1109
	      else if (c == '\f' && print_escape_newlines)
		{
		  PRINTCHAR ('\\');
		  PRINTCHAR ('f');
		}
Jim Blandy's avatar
Jim Blandy committed
1110 1111 1112 1113 1114 1115 1116 1117
	      else
		{
		  if (c == '\"' || c == '\\')
		    PRINTCHAR ('\\');
		  PRINTCHAR (c);
		}
	    }
	  PRINTCHAR ('\"');
Richard M. Stallman's avatar
Richard M. Stallman committed
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127

#ifdef USE_TEXT_PROPERTIES
	  if (!NULL_INTERVAL_P (XSTRING (obj)->intervals))
	    {
	      traverse_intervals (XSTRING (obj)->intervals,
				  0, 0, print_interval, printcharfun);
	      PRINTCHAR (')');
	    }
#endif

Jim Blandy's avatar
Jim Blandy committed
1128 1129
	  UNGCPRO;
	}
1130
      break;
Jim Blandy's avatar
Jim Blandy committed
1131

1132 1133 1134 1135 1136 1137
    case Lisp_Symbol:
      {
	register int confusing;
	register unsigned char *p = XSYMBOL (obj)->name->data;
	register unsigned char *end = p + XSYMBOL (obj)->name->size;
	register unsigned char c;
1138
	int i, size;
1139 1140 1141 1142

	if (p != end && (*p == '-' || *p == '+')) p++;
	if (p == end)
	  confusing = 0;
1143 1144 1145 1146 1147 1148 1149 1150 1151
	/* If symbol name begins with a digit, and ends with a digit,
	   and contains nothing but digits and `e', it could be treated
	   as a number.  So set CONFUSING.

	   Symbols that contain periods could also be taken as numbers,
	   but periods are always escaped, so we don't have to worry
	   about them here.  */
	else if (*p >= '0' && *p <= '9'
		 && end[-1] >= '0' && end[-1] <= '9')
1152
	  {
1153 1154 1155
	    while (p != end && ((*p >= '0' && *p <= '9')
				/* Needed for \2e10.  */
				|| *p == 'e'))
1156 1157 1158
	      p++;
	    confusing = (end == p);
	  }