print.c 43 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 226
   int specpdl_count = specpdl_ptr - specpdl;			\
   int free_print_buffer = 0;					\
227 228
   Lisp_Object original

229 230 231
#define PRINTPREPARE						\
   original = printcharfun;					\
   if (NILP (printcharfun)) printcharfun = Qt;			\
232
   if (BUFFERP (printcharfun))					\
233 234
     {								\
       if (XBUFFER (printcharfun) != current_buffer)		\
235
	 Fset_buffer (printcharfun);				\
236 237
       printcharfun = Qnil;					\
     }								\
238
   if (MARKERP (printcharfun))					\
239 240
     {								\
       if (!(XMARKER (original)->buffer))			\
241 242 243
         error ("Marker does not point anywhere");		\
       if (XMARKER (original)->buffer != current_buffer)	\
         set_buffer_internal (XMARKER (original)->buffer);	\
244
       old_point = PT;						\
245
       SET_PT (marker_position (printcharfun));			\
246
       start_point = PT;					\
247 248
       printcharfun = Qnil;					\
     }								\
249 250
   if (NILP (printcharfun))					\
     {								\
251 252 253 254 255 256 257 258
       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);	\
259
	   free_print_buffer = 1;				\
260
	 }							\
261 262
       print_buffer_pos = 0;					\
     }								\
263 264
   if (!CONSP (Vprint_gensym))					\
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
265

266
#define PRINTFINISH					\
267 268
   if (NILP (printcharfun))				\
     insert (print_buffer, print_buffer_pos);		\
269
   if (free_print_buffer)				\
270
     {							\
271
       xfree (print_buffer);				\
272 273
       print_buffer = 0;				\
     }							\
274
   unbind_to (specpdl_count, Qnil);			\
275
   if (MARKERP (original))				\
276
     Fset_marker (original, make_number (PT), Qnil);	\
277 278
   if (old_point >= 0)					\
     SET_PT (old_point + (old_point >= start_point	\
279
			  ? PT - start_point : 0));	\
280
   if (old != current_buffer)				\
281
     set_buffer_internal (old);				\
282 283
   if (!CONSP (Vprint_gensym))				\
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
284 285 286

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

287 288 289 290 291 292 293
/* 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)))))

294 295 296 297 298 299 300 301 302
/* 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);
}

303
/* Index of first unused element of FRAME_MESSAGE_BUF (mini_frame). */
Jim Blandy's avatar
Jim Blandy committed
304 305 306 307
static int printbufidx;

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
308
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312 313 314 315 316 317 318 319
     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
320 321 322
      int len;
      char work[4], *str;

Jim Blandy's avatar
Jim Blandy committed
323
      QUIT;
Karl Heuer's avatar
Karl Heuer committed
324 325
      len = CHAR_STRING (ch, work, str);
      if (print_buffer_pos + len >= print_buffer_size)
326 327
	print_buffer = (char *) xrealloc (print_buffer,
					  print_buffer_size *= 2);
Karl Heuer's avatar
Karl Heuer committed
328 329
      bcopy (str, print_buffer + print_buffer_pos, len);
      print_buffer_pos += len;
Jim Blandy's avatar
Jim Blandy committed
330 331 332 333 334
      return;
    }

  if (EQ (fun, Qt))
    {
335
      FRAME_PTR mini_frame
336
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));
Karl Heuer's avatar
Karl Heuer committed
337 338
      unsigned char work[4], *str;
      int len = CHAR_STRING (ch, work, str);
339

340 341
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
342 343
      if (noninteractive)
	{
Karl Heuer's avatar
Karl Heuer committed
344 345
	  while (len--)
	    putchar (*str), str++;
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349
	  noninteractive_need_newline = 1;
	  return;
	}

350
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
351 352
	  || !message_buf_print)
	{
353
	  message_log_maybe_newline ();
354
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
355
	  printbufidx = 0;
356
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
357
	  message_buf_print = 1;
358 359 360 361 362 363 364 365 366 367 368

	  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
369 370
	}

Karl Heuer's avatar
Karl Heuer committed
371 372 373 374
      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;
375
      FRAME_MESSAGE_BUF (mini_frame)[printbufidx] = 0;
376
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
377 378 379 380 381

      return;
    }
#endif /* not standalone */

382
  XSETFASTINT (ch1, ch);
Jim Blandy's avatar
Jim Blandy committed
383 384 385 386 387 388 389 390 391 392 393
  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
394 395 396
  if (size < 0)
    size = strlen (ptr);

Jim Blandy's avatar
Jim Blandy committed
397 398
  if (EQ (printcharfun, Qnil))
    {
399 400 401 402 403 404 405 406 407
      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
408 409
#ifdef MAX_PRINT_CHARS
      if (max_print)
410
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
411 412 413 414 415
#endif /* MAX_PRINT_CHARS */
      return;
    }
  if (EQ (printcharfun, Qt))
    {
416
      FRAME_PTR mini_frame
417 418
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));

419 420
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
421 422
#ifdef MAX_PRINT_CHARS
      if (max_print)
Karl Heuer's avatar
Karl Heuer committed
423
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
424 425 426 427
#endif /* MAX_PRINT_CHARS */

      if (noninteractive)
	{
Karl Heuer's avatar
Karl Heuer committed
428
	  fwrite (ptr, 1, size, stdout);
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432
	  noninteractive_need_newline = 1;
	  return;
	}

433
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
434 435
	  || !message_buf_print)
	{
436
	  message_log_maybe_newline ();
437
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
438
	  printbufidx = 0;
439
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
440
	  message_buf_print = 1;
441 442 443 444 445 446 447 448 449 450 451

	  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
452 453
	}

Karl Heuer's avatar
Karl Heuer committed
454 455 456 457 458 459 460 461 462
      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;
463
      echo_area_glyphs_length = printbufidx;
464
      FRAME_MESSAGE_BUF (mini_frame) [printbufidx] = 0;
Jim Blandy's avatar
Jim Blandy committed
465 466 467 468

      return;
    }

Karl Heuer's avatar
Karl Heuer committed
469 470 471 472 473 474 475 476 477 478 479
  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
480 481 482
}

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

print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
490 491
  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
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
    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,
507
  "Output character CHARACTER to stream PRINTCHARFUN.\n\
Karl Heuer's avatar
Karl Heuer committed
508
PRINTCHARFUN defaults to the value of `standard-output' (which see).")
509 510
  (character, printcharfun)
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
511
{
512
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
513

Jim Blandy's avatar
Jim Blandy committed
514
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
515
    printcharfun = Vstandard_output;
516
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
517
  PRINTPREPARE;
518
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
519
  PRINTFINISH;
520
  return character;
Jim Blandy's avatar
Jim Blandy committed
521 522 523 524 525 526 527 528 529 530
}

/* 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.  */

write_string (data, size)
     char *data;
     int size;
{
531
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
  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.  */

write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
550
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568

  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)));

569
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
570 571 572
  current_buffer->read_only = Qnil;
  Ferase_buffer ();

573
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
574 575 576 577 578 579 580 581 582 583 584 585 586
  specbind (Qstandard_output, buf);

  set_buffer_internal (old);
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
     char *bufname;
     Lisp_Object (*function) ();
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
587
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
588

589
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
590 591 592
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
593
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
594 595 596

  val = (*function) (args);

597
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
598
  temp_output_buffer_show (buf);
599
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
600 601 602 603 604 605 606 607 608 609 610 611

  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\
612
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
Jim Blandy's avatar
Jim Blandy committed
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
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
641 642
  "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
643 644 645
  (printcharfun)
     Lisp_Object printcharfun;
{
646
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
647

Jim Blandy's avatar
Jim Blandy committed
648
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
649 650 651 652 653 654 655 656 657 658 659
    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
660
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
661 662
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
663
{
664
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
665 666 667 668

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
669
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
670 671 672
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
673
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
674
  PRINTFINISH;
675
  return object;
Jim Blandy's avatar
Jim Blandy committed
676 677 678 679 680 681 682 683 684 685
}

/* 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.")
686 687
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
688
{
689 690
  PRINTDECLARE;
  Lisp_Object printcharfun;
691 692 693 694 695 696 697 698
  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
699 700 701 702

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print_depth = 0;
703
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
704 705 706
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
707
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
708 709 710

  Ferase_buffer ();
  set_buffer_internal (old);
711 712

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
713 714
  UNGCPRO;

715
  return object;
Jim Blandy's avatar
Jim Blandy committed
716 717 718 719 720 721
}

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
722
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
723 724
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
725
{
726
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
727

Jim Blandy's avatar
Jim Blandy committed
728
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
729 730 731
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
732
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
733
  PRINTFINISH;
734
  return object;
Jim Blandy's avatar
Jim Blandy committed
735 736 737 738 739 740
}

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
741
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
742 743
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
744
{
745
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
746 747 748 749 750 751
  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
752
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
753
    printcharfun = Vstandard_output;
754
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
755 756 757
  PRINTPREPARE;
  print_depth = 0;
  PRINTCHAR ('\n');
758
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
759 760 761 762 763 764 765
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
766
  return object;
Jim Blandy's avatar
Jim Blandy committed
767 768 769 770 771 772
}

/* 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
773 774
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
775 776
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
777 778
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
779 780 781
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
782 783 784 785 786 787 788 789 790

#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
791 792
  return character;
}
793 794 795 796 797 798 799 800

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
801
  fprintf (stderr, "\r\n");
802
}
Jim Blandy's avatar
Jim Blandy committed
803

804 805 806 807 808 809 810 811 812 813
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;

814 815 816 817 818 819 820 821 822
  /* 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;

823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 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
  print_error_message (obj, Vprin1_to_string_buffer, NULL);

  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).  */

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
888 889 890
#ifdef LISP_FLOAT_TYPE

/*
891
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
892
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
893 894 895 896 897 898 899 900 901 902
 * 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
 */
903 904 905

void
float_to_string (buf, data)
906
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
907 908
     double data;
{
909
  unsigned char *cp;
910
  int width;
Jim Blandy's avatar
Jim Blandy committed
911
      
Jim Blandy's avatar
Jim Blandy committed
912
  if (NILP (Vfloat_output_format)
913
      || !STRINGP (Vfloat_output_format))
Jim Blandy's avatar
Jim Blandy committed
914
  lose:
915
    {
Paul Eggert's avatar
Paul Eggert committed
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
      /* 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);
931
    }
Jim Blandy's avatar
Jim Blandy committed
932 933 934 935 936 937 938 939 940 941 942 943 944
  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;
945 946

      /* Check the width specification.  */
947
      width = -1;
948
      if ('0' <= *cp && *cp <= '9')
949 950 951 952 953 954 955 956 957 958 959
	{
	  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
960 961 962 963 964 965 966 967 968

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

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

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

970 971
  /* 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
972 973 974
     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)
975
    {
976 977 978
      for (cp = buf; *cp; cp++)
	if ((*cp < '0' || *cp > '9') && *cp != '-')
	  break;
979

980 981 982 983 984 985 986 987 988 989 990 991
      if (*cp == '.' && cp[1] == 0)
	{
	  cp[1] = '0';
	  cp[2] = 0;
	}

      if (*cp == 0)
	{
	  *cp++ = '.';
	  *cp++ = '0';
	  *cp++ = 0;
	}
992
    }
Jim Blandy's avatar
Jim Blandy committed
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
}
#endif /* LISP_FLOAT_TYPE */

static void
print (obj, printcharfun, escapeflag)
     Lisp_Object obj;
     register Lisp_Object printcharfun;
     int escapeflag;
{
  char buf[30];

  QUIT;

1006 1007 1008
#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.  */
1009
  if (CONSP (obj) || VECTORP (obj) || COMPILEDP (obj))
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
    {
      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
1023 1024
  print_depth++;

1025
  if (print_depth > PRINT_CIRCLE)
Jim Blandy's avatar
Jim Blandy committed
1026 1027 1028 1029 1030 1031 1032 1033 1034
    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 */

1035
  switch (XGCTYPE (obj))
Jim Blandy's avatar
Jim Blandy committed
1036
    {
1037
    case Lisp_Int:
1038 1039 1040 1041 1042 1043
      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
1044
      strout (buf, -1, printcharfun);
1045 1046
      break;

Karl Heuer's avatar
Karl Heuer committed
1047
#ifdef LISP_FLOAT_TYPE
1048 1049 1050
    case Lisp_Float:
      {
	char pigbuf[350];	/* see comments in float_to_string */
Jim Blandy's avatar
Jim Blandy committed
1051

1052 1053 1054 1055
	float_to_string (pigbuf, XFLOAT(obj)->data);
	strout (pigbuf, -1, printcharfun);
      }
      break;
Karl Heuer's avatar
Karl Heuer committed
1056
#endif
1057 1058

    case Lisp_String:
Jim Blandy's avatar
Jim Blandy committed
1059 1060 1061 1062 1063 1064 1065 1066
      if (!escapeflag)
	print_string (obj, printcharfun);
      else
	{
	  register int i;
	  register unsigned char c;
	  struct gcpro gcpro1;

Richard M. Stallman's avatar
Richard M. Stallman committed
1067 1068 1069 1070 1071 1072 1073 1074 1075
	  GCPRO1 (obj);

#ifdef USE_TEXT_PROPERTIES
	  if (!NULL_INTERVAL_P (XSTRING (obj)->intervals))
	    {
	      PRINTCHAR ('#');
	      PRINTCHAR ('(');
	    }
#endif
Jim Blandy's avatar
Jim Blandy committed
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086

	  PRINTCHAR ('\"');
	  for (i = 0; i < XSTRING (obj)->size; i++)
	    {
	      QUIT;
	      c = XSTRING (obj)->data[i];
	      if (c == '\n' && print_escape_newlines)
		{
		  PRINTCHAR ('\\');
		  PRINTCHAR ('n');
		}
1087 1088 1089 1090 1091
	      else if (c == '\f' && print_escape_newlines)
		{
		  PRINTCHAR ('\\');
		  PRINTCHAR ('f');
		}
Jim Blandy's avatar
Jim Blandy committed
1092 1093 1094 1095 1096 1097 1098 1099
	      else
		{
		  if (c == '\"' || c == '\\')
		    PRINTCHAR ('\\');
		  PRINTCHAR (c);
		}
	    }
	  PRINTCHAR ('\"');
Richard M. Stallman's avatar
Richard M. Stallman committed
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109

#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
1110 1111
	  UNGCPRO;
	}
1112
      break;
Jim Blandy's avatar
Jim Blandy committed
1113

1114 1115 1116 1117 1118 1119
    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;
1120
	int i;
1121 1122 1123 1124

	if (p != end && (*p == '-' || *p == '+')) p++;
	if (p == end)
	  confusing = 0;
1125 1126 1127 1128 1129 1130 1131 1132 1133
	/* 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')
1134
	  {
1135 1136 1137
	    while (p != end && ((*p >= '0' && *p <= '9')
				/* Needed for \2e10.  */
				|| *p == 'e'))
1138 1139 1140
	      p++;
	    confusing = (end == p);
	  }
1141 1142
	else
	  confusing = 0;
1143

1144 1145 1146
	/* If we print an uninterned symbol as part of a complex object and
	   the flag print-gensym is non-nil, prefix it with #n= to read the
	   object back with the #n# reader syntax later if needed.  */
1147
	if (! NILP (Vprint_gensym) && NILP (XSYMBOL (obj)->obarray))
1148 1149 1150 1151
	  {
	    if (print_depth > 1)
	      {
		Lisp_Object tem;
1152
		tem = Fassq (obj, Vprint_gensym_alist);
1153 1154 1155 1156 1157 1158 1159 1160 1161
		if (CONSP (tem))
		  {
		    PRINTCHAR ('#');
		    print (XCDR (tem), printcharfun, escapeflag);
		    PRINTCHAR ('#');
		    break;
		  }
		else
		  {
1162 1163
		    if (CONSP (Vprint_gensym_alist))
		      XSETFASTINT (tem, XFASTINT (XCDR (XCAR (Vprint_gensym_alist))) + 1);
1164 1165
		    else
		      XSETFASTINT (tem, 1);
1166
		    Vprint_gensym_alist = Fcons (Fcons (obj, tem), Vprint_gensym_alist);
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176

		    PRINTCHAR ('#');
		    print (tem, printcharfun, escapeflag);
		    PRINTCHAR ('=');
		  }
	      }
	    PRINTCHAR ('#');
	    PRINTCHAR (':');
	  }

1177
	for (i = 0; i < XSYMBOL (obj)->name->size; i++)
1178 1179
	  {
	    QUIT;
1180 1181
	    c = XSYMBOL (obj)->name->data[i];

1182 1183
	    if (escapeflag)
	      {