print.c 67.9 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
2 3
   Copyright (C) 1985, 1986, 1988, 1993, 1994, 1995, 1997,
                 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4
                 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23
#include <stdio.h>
24
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
25 26
#include "lisp.h"
#include "buffer.h"
27
#include "character.h"
Kenichi Handa's avatar
Kenichi Handa committed
28
#include "charset.h"
29
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31 32 33 34
#include "window.h"
#include "process.h"
#include "dispextern.h"
#include "termchar.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
35
#include "intervals.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
36
#include "blockinput.h"
37
#include "termhooks.h"		/* For struct terminal.  */
Kenichi Handa's avatar
Kenichi Handa committed
38
#include "font.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
39

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

42 43
Lisp_Object Qtemp_buffer_setup_hook;

Erik Naggum's avatar
Erik Naggum committed
44 45
/* These are used to print like we read.  */

Jim Blandy's avatar
Jim Blandy committed
46
Lisp_Object Vfloat_output_format, Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
47 48 49 50 51 52

#include <math.h>

#if STDC_HEADERS
#include <float.h>
#endif
Paul Eggert's avatar
Paul Eggert committed
53
#include <ftoastr.h>
Paul Eggert's avatar
Paul Eggert committed
54 55 56 57 58 59

/* Default to values appropriate for IEEE floating point.  */
#ifndef DBL_DIG
#define DBL_DIG 15
#endif

Jim Blandy's avatar
Jim Blandy committed
60 61 62
/* Avoid actual stack overflow in print.  */
int print_depth;

63 64
/* Level of nesting inside outputting backquote in new style.  */
int new_backquote_output;
65

66 67 68 69
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
Lisp_Object being_printed[PRINT_CIRCLE];

70 71 72 73 74
/* 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.  */
75
EMACS_INT print_buffer_size;
76
/* Chars stored in print_buffer.  */
77
EMACS_INT print_buffer_pos;
78
/* Bytes stored in print_buffer.  */
79
EMACS_INT print_buffer_pos_byte;
80

Jim Blandy's avatar
Jim Blandy committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94
/* 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;

95 96 97 98 99
/* Nonzero means to print single-byte non-ascii characters in strings as
   octal escapes.  */

int print_escape_nonascii;

100 101 102 103 104 105 106
/* Nonzero means to print multibyte characters in strings as hex escapes.  */

int print_escape_multibyte;

Lisp_Object Qprint_escape_newlines;
Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;

Erik Naggum's avatar
Erik Naggum committed
107 108 109 110
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

111
/* Non-nil means print #: before uninterned symbols.  */
112

113
Lisp_Object Vprint_gensym;
114

115
/* Non-nil means print recursive structures using #n= and #n# syntax.  */
116

117 118 119 120 121 122 123
Lisp_Object Vprint_circle;

/* Non-nil means keep continuous number for #n= and #n# syntax
   between several print functions.  */

Lisp_Object Vprint_continuous_numbering;

124 125 126 127 128 129 130 131
/* Vprint_number_table is a table, that keeps objects that are going to
   be printed, to allow use of #n= and #n# to express sharing.
   For any given object, the table can give the following values:
     t    the object will be printed only once.
     -N   the object will be printed several times and will take number N.
     N    the object has been printed so we can refer to it as #N#.
   print_number_index holds the largest N already used.
   N has to be striclty larger than 0 since we need to distinguish -N.  */
132 133 134
int print_number_index;
Lisp_Object Vprint_number_table;

135
void print_interval (INTERVAL interval, Lisp_Object printcharfun);
Jim Blandy's avatar
Jim Blandy committed
136

137
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
138
int print_output_debug_flag EXTERNALLY_VISIBLE = 1;
139

Jim Blandy's avatar
Jim Blandy committed
140

141
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
142 143

/* Lisp functions to do output using a stream
144 145 146 147
   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,
148
   or call strout to output a block of characters. */
149 150 151

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
152 153
   EMACS_INT old_point = -1, start_point = -1;				\
   EMACS_INT old_point_byte = -1, start_point_byte = -1;		\
Juanma Barranquero's avatar
Juanma Barranquero committed
154
   int specpdl_count = SPECPDL_INDEX ();				\
155 156
   int free_print_buffer = 0;						\
   int multibyte = !NILP (current_buffer->enable_multibyte_characters);	\
157 158
   Lisp_Object original

159 160 161 162 163 164 165 166 167 168 169
#define PRINTPREPARE							\
   original = printcharfun;						\
   if (NILP (printcharfun)) printcharfun = Qt;				\
   if (BUFFERP (printcharfun))						\
     {									\
       if (XBUFFER (printcharfun) != current_buffer)			\
	 Fset_buffer (printcharfun);					\
       printcharfun = Qnil;						\
     }									\
   if (MARKERP (printcharfun))						\
     {									\
170
       EMACS_INT marker_pos;						\
Andreas Schwab's avatar
Andreas Schwab committed
171
       if (! XMARKER (printcharfun)->buffer)				\
172
         error ("Marker does not point anywhere");			\
173 174 175 176 177
       if (XMARKER (printcharfun)->buffer != current_buffer)		\
         set_buffer_internal (XMARKER (printcharfun)->buffer);		\
       marker_pos = marker_position (printcharfun);			\
       if (marker_pos < BEGV || marker_pos > ZV)			\
	 error ("Marker is outside the accessible part of the buffer"); \
178 179
       old_point = PT;							\
       old_point_byte = PT_BYTE;					\
180
       SET_PT_BOTH (marker_pos,						\
181 182 183 184 185 186 187 188 189 190 191
		    marker_byte_position (printcharfun));		\
       start_point = PT;						\
       start_point_byte = PT_BYTE;					\
       printcharfun = Qnil;						\
     }									\
   if (NILP (printcharfun))						\
     {									\
       Lisp_Object string;						\
       if (NILP (current_buffer->enable_multibyte_characters)		\
	   && ! print_escape_multibyte)					\
         specbind (Qprint_escape_multibyte, Qt);			\
192 193 194
       if (! NILP (current_buffer->enable_multibyte_characters)		\
	   && ! print_escape_nonascii)					\
         specbind (Qprint_escape_nonascii, Qt);				\
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
       if (print_buffer != 0)						\
	 {								\
	   string = make_string_from_bytes (print_buffer,		\
					    print_buffer_pos,		\
					    print_buffer_pos_byte);	\
	   record_unwind_protect (print_unwind, string);		\
	 }								\
       else								\
	 {								\
           print_buffer_size = 1000;					\
           print_buffer = (char *) xmalloc (print_buffer_size);		\
	   free_print_buffer = 1;					\
	 }								\
       print_buffer_pos = 0;						\
       print_buffer_pos_byte = 0;					\
     }									\
211
   if (EQ (printcharfun, Qt) && ! noninteractive)			\
212
     setup_echo_area_for_printing (multibyte);
Jim Blandy's avatar
Jim Blandy committed
213

214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
#define PRINTFINISH							\
   if (NILP (printcharfun))						\
     {									\
       if (print_buffer_pos != print_buffer_pos_byte			\
	   && NILP (current_buffer->enable_multibyte_characters))	\
	 {								\
	   unsigned char *temp						\
	     = (unsigned char *) alloca (print_buffer_pos + 1);		\
	   copy_text (print_buffer, temp, print_buffer_pos_byte,	\
		      1, 0);						\
	   insert_1_both (temp, print_buffer_pos,			\
			  print_buffer_pos, 0, 1, 0);			\
	 }								\
       else								\
	 insert_1_both (print_buffer, print_buffer_pos,			\
			print_buffer_pos_byte, 0, 1, 0);		\
230
       signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
231 232 233 234 235 236 237 238 239 240 241 242
     }									\
   if (free_print_buffer)						\
     {									\
       xfree (print_buffer);						\
       print_buffer = 0;						\
     }									\
   unbind_to (specpdl_count, Qnil);					\
   if (MARKERP (original))						\
     set_marker_both (original, Qnil, PT, PT_BYTE);			\
   if (old_point >= 0)							\
     SET_PT_BOTH (old_point + (old_point >= start_point			\
			       ? PT - start_point : 0),			\
243
		  old_point_byte + (old_point_byte >= start_point_byte	\
Andreas Schwab's avatar
Andreas Schwab committed
244
				    ? PT_BYTE - start_point_byte : 0));	\
245
   if (old != current_buffer)						\
246
     set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
247 248 249

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

250 251
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
252

253
static Lisp_Object
254
print_unwind (Lisp_Object saved_text)
255
{
256
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
257
  return Qnil;
258 259
}

260 261 262 263 264

/* Print character CH using method FUN.  FUN nil means print to
   print_buffer.  FUN t means print to echo area or stdout if
   non-interactive.  If FUN is neither nil nor t, call FUN with CH as
   argument.  */
Jim Blandy's avatar
Jim Blandy committed
265 266

static void
267
printchar (unsigned int ch, Lisp_Object fun)
Jim Blandy's avatar
Jim Blandy committed
268
{
269 270 271
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
272
    {
273 274 275
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

276
      QUIT;
277

278
      if (NILP (fun))
279
	{
280 281 282
	  if (print_buffer_pos_byte + len >= print_buffer_size)
	    print_buffer = (char *) xrealloc (print_buffer,
					      print_buffer_size *= 2);
283
	  memcpy (print_buffer + print_buffer_pos_byte, str, len);
284 285
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
286
	}
287
      else if (noninteractive)
288
	{
289 290
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
291
	}
292
      else
293
	{
294 295
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
296

297
	  setup_echo_area_for_printing (multibyte_p);
298 299
	  insert_char (ch);
	  message_dolog (str, len, 0, multibyte_p);
300
	}
Jim Blandy's avatar
Jim Blandy committed
301 302 303
    }
}

304 305 306 307 308 309 310

/* Output SIZE characters, SIZE_BYTE bytes from string PTR using
   method PRINTCHARFUN.  If SIZE < 0, use the string length of PTR for
   both SIZE and SIZE_BYTE.  PRINTCHARFUN nil means output to
   print_buffer.  PRINTCHARFUN t means output to the echo area or to
   stdout if non-interactive.  If neither nil nor t, call Lisp
   function PRINTCHARFUN for each character printed.  MULTIBYTE
311 312 313 314
   non-zero means PTR contains multibyte characters.

   In the case where PRINTCHARFUN is nil, it is safe for PTR to point
   to data in a Lisp string.  Otherwise that is not safe.  */
315

Jim Blandy's avatar
Jim Blandy committed
316
static void
317 318
strout (const char *ptr, EMACS_INT size, EMACS_INT size_byte,
	Lisp_Object printcharfun, int multibyte)
Jim Blandy's avatar
Jim Blandy committed
319
{
Karl Heuer's avatar
Karl Heuer committed
320
  if (size < 0)
321
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
322

323
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
324
    {
325
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
326
	{
327
	  print_buffer_size = print_buffer_size * 2 + size_byte;
328 329 330
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
331
      memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
332
      print_buffer_pos += size;
333
      print_buffer_pos_byte += size_byte;
Jim Blandy's avatar
Jim Blandy committed
334
    }
335
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
336
    {
337 338 339 340 341 342 343 344 345 346 347
      fwrite (ptr, 1, size_byte, stdout);
      noninteractive_need_newline = 1;
    }
  else if (EQ (printcharfun, Qt))
    {
      /* Output to echo area.  We're trying to avoid a little overhead
	 here, that's the reason we don't call printchar to do the
	 job.  */
      int i;
      int multibyte_p
	= !NILP (current_buffer->enable_multibyte_characters);
348

349
      setup_echo_area_for_printing (multibyte_p);
350
      message_dolog (ptr, size_byte, 0, multibyte_p);
351

352
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
353
	{
354
	  for (i = 0; i < size; ++i)
Andreas Schwab's avatar
Andreas Schwab committed
355
	    insert_char ((unsigned char) *ptr++);
Jim Blandy's avatar
Jim Blandy committed
356
	}
357
      else
Jim Blandy's avatar
Jim Blandy committed
358
	{
359 360
	  int len;
	  for (i = 0; i < size_byte; i += len)
361
	    {
362
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, len);
363
	      insert_char (ch);
364
	    }
Jim Blandy's avatar
Jim Blandy committed
365
	}
366 367 368 369
    }
  else
    {
      /* PRINTCHARFUN is a Lisp function.  */
370
      EMACS_INT i = 0;
Jim Blandy's avatar
Jim Blandy committed
371

372
      if (size == size_byte)
373
	{
374
	  while (i < size_byte)
375
	    {
376 377
	      int ch = ptr[i++];
	      PRINTCHAR (ch);
378 379
	    }
	}
380
      else
Karl Heuer's avatar
Karl Heuer committed
381
	{
382 383 384 385 386 387
	  while (i < size_byte)
	    {
	      /* Here, we must convert each multi-byte form to the
		 corresponding character code before handing it to
		 PRINTCHAR.  */
	      int len;
388
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, len);
389 390 391
	      PRINTCHAR (ch);
	      i += len;
	    }
Karl Heuer's avatar
Karl Heuer committed
392
	}
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396
    }
}

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

400
static void
401
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
402
{
403
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
404
    {
405
      EMACS_INT chars;
406

407 408 409
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

410
      if (STRING_MULTIBYTE (string))
411
	chars = SCHARS (string);
412 413 414 415
      else if (! print_escape_nonascii
	       && (EQ (printcharfun, Qt)
		   ? ! NILP (buffer_defaults.enable_multibyte_characters)
		   : ! NILP (current_buffer->enable_multibyte_characters)))
416 417 418 419 420
	{
	  /* If unibyte string STRING contains 8-bit codes, we must
	     convert STRING to a multibyte string containing the same
	     character codes.  */
	  Lisp_Object newstr;
421
	  EMACS_INT bytes;
422

423 424
	  chars = SBYTES (string);
	  bytes = parse_str_to_multibyte (SDATA (string), chars);
425 426 427
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
428
	      memcpy (SDATA (newstr), SDATA (string), chars);
429
	      str_to_multibyte (SDATA (newstr), bytes, chars);
430 431 432
	      string = newstr;
	    }
	}
433
      else
434
	chars = SBYTES (string);
435

436 437 438
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
439
	  EMACS_INT nbytes = SBYTES (string);
440 441 442 443 444 445 446
	  char *buffer;

	  /* Copy the string contents so that relocation of STRING by
	     GC does not cause trouble.  */
	  USE_SAFE_ALLOCA;

	  SAFE_ALLOCA (buffer, char *, nbytes);
447
	  memcpy (buffer, SDATA (string), nbytes);
448 449 450 451 452 453 454 455 456 457 458

	  strout (buffer, chars, SBYTES (string),
		  printcharfun, STRING_MULTIBYTE (string));

	  SAFE_FREE ();
	}
      else
	/* No need to copy, since output to print_buffer can't GC.  */
	strout (SDATA (string),
		chars, SBYTES (string),
		printcharfun, STRING_MULTIBYTE (string));
459
    }
Jim Blandy's avatar
Jim Blandy committed
460 461
  else
    {
462 463
      /* Otherwise, string may be relocated by printing one char.
	 So re-fetch the string address for each character.  */
464
      EMACS_INT i;
465 466
      EMACS_INT size = SCHARS (string);
      EMACS_INT size_byte = SBYTES (string);
Jim Blandy's avatar
Jim Blandy committed
467 468
      struct gcpro gcpro1;
      GCPRO1 (string);
469 470
      if (size == size_byte)
	for (i = 0; i < size; i++)
471
	  PRINTCHAR (SREF (string, i));
472
      else
Kenichi Handa's avatar
Kenichi Handa committed
473
	for (i = 0; i < size_byte; )
474 475 476 477
	  {
	    /* Here, we must convert each multi-byte form to the
	       corresponding character code before handing it to PRINTCHAR.  */
	    int len;
478
	    int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i, len);
479 480 481
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
482 483 484 485 486
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
487 488
       doc: /* Output character CHARACTER to stream PRINTCHARFUN.
PRINTCHARFUN defaults to the value of `standard-output' (which see).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
489
  (Lisp_Object character, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
490
{
491
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
492

Jim Blandy's avatar
Jim Blandy committed
493
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
494
    printcharfun = Vstandard_output;
495
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
496
  PRINTPREPARE;
497
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
498
  PRINTFINISH;
499
  return character;
Jim Blandy's avatar
Jim Blandy committed
500 501
}

502 503
/* Used from outside of print.c to print a block of SIZE
   single-byte chars at DATA on the default output stream.
Jim Blandy's avatar
Jim Blandy committed
504 505
   Do not use this on the contents of a Lisp string.  */

506
void
507
write_string (const char *data, int size)
Jim Blandy's avatar
Jim Blandy committed
508
{
509
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513 514
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
515
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
516 517 518
  PRINTFINISH;
}

Andreas Schwab's avatar
Andreas Schwab committed
519 520
/* Used to print a block of SIZE single-byte chars at DATA on a
   specified stream PRINTCHARFUN.
Jim Blandy's avatar
Jim Blandy committed
521 522
   Do not use this on the contents of a Lisp string.  */

Andreas Schwab's avatar
Andreas Schwab committed
523
static void
524
write_string_1 (const char *data, int size, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
525
{
526
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
527 528

  PRINTPREPARE;
529
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
530 531 532 533 534
  PRINTFINISH;
}


void
535
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
536
{
Juanma Barranquero's avatar
Juanma Barranquero committed
537
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
538 539 540
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

541 542
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
543 544
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

545
  Fkill_all_local_variables ();
546
  delete_all_overlays (current_buffer);
547
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
548
  current_buffer->read_only = Qnil;
549 550
  current_buffer->filename = Qnil;
  current_buffer->undo_list = Qt;
551 552
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
553 554
  current_buffer->enable_multibyte_characters
    = buffer_defaults.enable_multibyte_characters;
555 556
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
557
  Ferase_buffer ();
558
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
559

560
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
561 562 563 564

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
565 566 567
}

Lisp_Object
568
internal_with_output_to_temp_buffer (const char *bufname, Lisp_Object (*function) (Lisp_Object), Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
569
{
Juanma Barranquero's avatar
Juanma Barranquero committed
570
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
571
  Lisp_Object buf, val;
572
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
573

574
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
575 576 577
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
578
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
579 580 581

  val = (*function) (args);

582
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
583
  temp_output_buffer_show (buf);
584
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
585 586 587 588

  return unbind_to (count, val);
}

589 590
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
591
       1, UNEVALLED, 0,
592
       doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616

This construct makes buffer BUFNAME empty before running BODY.
It does not make the buffer current for BODY.
Instead it binds `standard-output' to that buffer, so that output
generated with `prin1' and similar functions in BODY goes into
the buffer.

At the end of BODY, this marks buffer BUFNAME unmodifed and displays
it in a window, but does not select it.  The normal way to do this is
by calling `display-buffer', then running `temp-buffer-show-hook'.
However, if `temp-buffer-show-function' is non-nil, it calls that
function instead (and does not run `temp-buffer-show-hook').  The
function gets one argument, the buffer to display.

The return value of `with-output-to-temp-buffer' is the value of the
last form in BODY.  If BODY does not finish normally, the buffer
BUFNAME is not displayed.

This runs the hook `temp-buffer-setup-hook' before BODY,
with the buffer BUFNAME temporarily current.  It runs the hook
`temp-buffer-show-hook' after displaying buffer BUFNAME, with that
buffer temporarily current, and the window that was used to display it
temporarily selected.  But it doesn't run `temp-buffer-show-hook'
if it uses `temp-buffer-show-function'.
617

618
usage: (with-output-to-temp-buffer BUFNAME BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
619
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
620 621 622
{
  struct gcpro gcpro1;
  Lisp_Object name;
Juanma Barranquero's avatar
Juanma Barranquero committed
623
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
624 625 626 627
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
628
  CHECK_STRING (name);
629
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
630
  buf = Vstandard_output;
631
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
632

633
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
634

635
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
636
  temp_output_buffer_show (buf);
637
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
638 639 640

  return unbind_to (count, val);
}
641

Jim Blandy's avatar
Jim Blandy committed
642

643 644 645 646
static void print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
static void print_preprocess (Lisp_Object obj);
static void print_preprocess_string (INTERVAL interval, Lisp_Object arg);
static void print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
Jim Blandy's avatar
Jim Blandy committed
647 648

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
649 650
       doc: /* Output a newline to stream PRINTCHARFUN.
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
651
  (Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
652
{
653
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
654

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

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
664 665
       doc: /* Output the printed representation of OBJECT, any Lisp object.
Quoting characters are printed when needed to make output that `read'
Eli Zaretskii's avatar
Eli Zaretskii committed
666
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
667
is controlled by `print-level' and `print-length', which see.
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.

Optional argument PRINTCHARFUN is the output stream, which can be one
of these:

   - a buffer, in which case output is inserted into that buffer at point;
   - a marker, in which case output is inserted at marker's position;
   - a function, in which case that function is called once for each
     character of OBJECT's printed representation;
   - a symbol, in which case that symbol's function definition is called; or
   - t, in which case the output is displayed in the echo area.

If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
is used instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
686
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
687
{
688
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
689

Jim Blandy's avatar
Jim Blandy committed
690
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
691 692
    printcharfun = Vstandard_output;
  PRINTPREPARE;
693
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
694
  PRINTFINISH;
695
  return object;
Jim Blandy's avatar
Jim Blandy committed
696 697 698 699 700 701
}

/* 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,
702 703
       doc: /* Return a string containing the printed representation of OBJECT.
OBJECT can be any Lisp object.  This function outputs quoting characters
Pavel Janík's avatar
Pavel Janík committed
704
when necessary to make output that `read' can handle, whenever possible,
705 706
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
707 708 709 710 711

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
712
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
713
{
714
  Lisp_Object printcharfun;
715 716
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
717
  int count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
718
  struct buffer *previous;
719 720

  specbind (Qinhibit_modification_hooks, Qt);
721

Kenichi Handa's avatar
Kenichi Handa committed
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
  {
    PRINTDECLARE;

    /* 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.  */
    save_deactivate_mark = Vdeactivate_mark;
    /* GCPRO2 (object, save_deactivate_mark); */
    abort_on_gc++;

    printcharfun = Vprin1_to_string_buffer;
    PRINTPREPARE;
    print (object, printcharfun, NILP (noescape));
    /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
    PRINTFINISH;
  }
Jim Blandy's avatar
Jim Blandy committed
738

Kenichi Handa's avatar
Kenichi Handa committed
739
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
740
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
741
  object = Fbuffer_string ();
742 743
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
744

745
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
746 747
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
748
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
749
  set_buffer_internal (previous);
750

751 752
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
753

754 755
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
756 757 758
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
       doc: /* Output the printed representation of OBJECT, any Lisp object.
No quoting characters are used; no delimiters are printed around
the contents of strings.

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.

Optional argument PRINTCHARFUN is the output stream, which can be one
of these:

   - a buffer, in which case output is inserted into that buffer at point;
   - a marker, in which case output is inserted at marker's position;
   - a function, in which case that function is called once for each
     character of OBJECT's printed representation;
   - a symbol, in which case that symbol's function definition is called; or
   - t, in which case the output is displayed in the echo area.

If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
is used instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
780
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
781
{
782
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
783

Jim Blandy's avatar
Jim Blandy committed
784
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
785 786
    printcharfun = Vstandard_output;
  PRINTPREPARE;
787
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
788
  PRINTFINISH;
789
  return object;
Jim Blandy's avatar
Jim Blandy committed
790 791 792
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
793 794
       doc: /* Output the printed representation of OBJECT, with newlines around it.
Quoting characters are printed when needed to make output that `read'
Eli Zaretskii's avatar
Eli Zaretskii committed
795
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
796
is controlled by `print-level' and `print-length', which see.
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.

Optional argument PRINTCHARFUN is the output stream, which can be one
of these:

   - a buffer, in which case output is inserted into that buffer at point;
   - a marker, in which case output is inserted at marker's position;
   - a function, in which case that function is called once for each
     character of OBJECT's printed representation;
   - a symbol, in which case that symbol's function definition is called; or
   - t, in which case the output is displayed in the echo area.

If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
is used instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
815
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
816
{
817
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
818 819
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
820
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
821
    printcharfun = Vstandard_output;
822
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
823 824
  PRINTPREPARE;
  PRINTCHAR ('\n');
825
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
826 827 828
  PRINTCHAR ('\n');
  PRINTFINISH;
  UNGCPRO;
829
  return object;
Jim Blandy's avatar
Jim Blandy committed
830 831 832 833 834 835
}

/* 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
836
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
837 838 839
       doc: /* Write CHARACTER to stderr.
You can call print while debugging emacs, and pass it this function
to make it write to the debugging output.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
840
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
841
{
842
  CHECK_NUMBER (character);
843
  putc ((int) XINT (character), stderr);
844 845 846

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

Jim Blandy's avatar
Jim Blandy committed
854 855
  return character;
}
856

857 858 859
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

860
void
861
debug_output_compilation_hack (int x)
862 863 864
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
865

Andreas Schwab's avatar
Andreas Schwab committed
866
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
867 868 869 870 871 872 873 874 875 876 877 878 879 880

/* This functionality is not vitally important in general, so we rely on
   non-portable ability to use stderr as lvalue.  */

#define WITH_REDIRECT_DEBUGGING_OUTPUT 1

FILE *initial_stderr_stream = NULL;

DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
       1, 2,
       "FDebug output file: \nP",
       doc: /* Redirect debugging output (stderr stream) to file FILE.
If FILE is nil, reset target to the initial stderr stream.
Optional arg APPEND non-nil (interactively, with prefix arg) means
881
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
882
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
883 884
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
885 886 887 888 889
    {
      BLOCK_INPUT;
      fclose (stderr);
      UNBLOCK_INPUT;
    }
Kenichi Handa's avatar
Kenichi Handa committed
890 891 892 893 894 895 896
  stderr = initial_stderr_stream;
  initial_stderr_stream = NULL;

  if (STRINGP (file))
    {
      file = Fexpand_file_name (file, Qnil);
      initial_stderr_stream = stderr;
Andreas Schwab's avatar
Andreas Schwab committed
897
      stderr = fopen (SDATA (file), NILP (append) ? "w" : "a");
Kenichi Handa's avatar
Kenichi Handa committed
898 899 900 901 902 903 904 905 906 907 908 909 910
      if (stderr == NULL)
	{
	  stderr = initial_stderr_stream;
	  initial_stderr_stream = NULL;
	  report_file_error ("Cannot open debugging output stream",
			     Fcons (file, Qnil));
	}
    }
  return Qnil;
}
#endif /* GNU_LINUX */


911 912 913
/* This is the interface for debugging printing.  */

void
914
debug_print (Lisp_Object arg)
915 916
{
  Fprin1 (arg, Qexternal_debugging_output);
917
  fprintf (stderr, "\r\n");
918
}
919 920

void
921
safe_debug_print (Lisp_Object arg)
922 923 924 925 926 927 928 929
{
  int valid = valid_lisp_object_p (arg);

  if (valid > 0)
    debug_print (arg);
  else
    fprintf (stderr, "#<%s_LISP_OBJECT 0x%08lx>\r\n",
	     !valid ? "INVALID" : "SOME",
930
	     (unsigned long) XHASH (arg)
931 932 933
	     );
}

Jim Blandy's avatar
Jim Blandy committed
934

935 936
DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
       1, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
937 938 939
       doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
See Info anchor `(elisp)Definition of signal' for some details on how this
error message is constructed.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
940
  (Lisp_Object obj)
941 942
{
  struct buffer *old = current_buffer;
943
  Lisp_Object value;
944 945
  struct gcpro gcpro1;

946 947 948
  /* 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.  */
949 950 951 952 953
  if (CONSP (obj) && EQ (XCAR (obj), Qerror)
      && CONSP (XCDR (obj))
      && STRINGP (XCAR (XCDR (obj)))
      && NILP (XCDR (XCDR (obj))))
    return XCAR (XCDR (obj));
954

955
  print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
956 957