print.c 67.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
2

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2015 Free Software
4
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>
23
#include "sysstdio.h"
24

Jim Blandy's avatar
Jim Blandy committed
25
#include "lisp.h"
26
#include "character.h"
27
#include "buffer.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
#include "window.h"
#include "process.h"
#include "dispextern.h"
34
#include "disptab.h"
Jim Blandy's avatar
Jim Blandy committed
35
#include "termchar.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
36
#include "intervals.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
37
#include "blockinput.h"
38
#include "termhooks.h"		/* For struct terminal.  */
Kenichi Handa's avatar
Kenichi Handa committed
39
#include "font.h"
jave's avatar
jave committed
40

41
#include <c-ctype.h>
Paul Eggert's avatar
Paul Eggert committed
42
#include <float.h>
Paul Eggert's avatar
Paul Eggert committed
43
#include <ftoastr.h>
Paul Eggert's avatar
Paul Eggert committed
44

Jim Blandy's avatar
Jim Blandy committed
45
/* Avoid actual stack overflow in print.  */
46
static ptrdiff_t print_depth;
Jim Blandy's avatar
Jim Blandy committed
47

48
/* Level of nesting inside outputting backquote in new style.  */
49
static ptrdiff_t new_backquote_output;
50

51 52
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
53
static Lisp_Object being_printed[PRINT_CIRCLE];
54

55 56 57
/* Last char printed to stdout by printchar.  */
static unsigned int printchar_stdout_last;

58 59
/* When printing into a buffer, first we put the text in this
   block, then insert it all at once.  */
60
static char *print_buffer;
61 62

/* Size allocated in print_buffer.  */
63
static ptrdiff_t print_buffer_size;
64
/* Chars stored in print_buffer.  */
65
static ptrdiff_t print_buffer_pos;
66
/* Bytes stored in print_buffer.  */
67
static ptrdiff_t print_buffer_pos_byte;
68

69 70 71 72 73 74 75 76
/* 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.  */
77
static ptrdiff_t print_number_index;
78
static void print_interval (INTERVAL interval, Lisp_Object printcharfun);
Jim Blandy's avatar
Jim Blandy committed
79

80
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
81
bool print_output_debug_flag EXTERNALLY_VISIBLE = 1;
82

Jim Blandy's avatar
Jim Blandy committed
83

84
/* Low level output routines for characters and strings.  */
Jim Blandy's avatar
Jim Blandy committed
85 86

/* Lisp functions to do output using a stream
87
   must have the stream in a variable called printcharfun
88 89
   and must start with PRINTPREPARE, end with PRINTFINISH.
   Use printchar to output one character,
90
   or call strout to output a block of characters.  */
91

92
#define PRINTPREPARE							\
93
   struct buffer *old = current_buffer;					\
94 95 96
   ptrdiff_t old_point = -1, start_point = -1;				\
   ptrdiff_t old_point_byte = -1, start_point_byte = -1;		\
   ptrdiff_t specpdl_count = SPECPDL_INDEX ();				\
97
   bool free_print_buffer = 0;						\
98 99
   bool multibyte							\
     = !NILP (BVAR (current_buffer, enable_multibyte_characters));	\
100
   Lisp_Object original = printcharfun;					\
101 102 103 104 105 106 107 108 109
   if (NILP (printcharfun)) printcharfun = Qt;				\
   if (BUFFERP (printcharfun))						\
     {									\
       if (XBUFFER (printcharfun) != current_buffer)			\
	 Fset_buffer (printcharfun);					\
       printcharfun = Qnil;						\
     }									\
   if (MARKERP (printcharfun))						\
     {									\
110
       ptrdiff_t marker_pos;						\
Andreas Schwab's avatar
Andreas Schwab committed
111
       if (! XMARKER (printcharfun)->buffer)				\
112
         error ("Marker does not point anywhere");			\
113 114 115 116
       if (XMARKER (printcharfun)->buffer != current_buffer)		\
         set_buffer_internal (XMARKER (printcharfun)->buffer);		\
       marker_pos = marker_position (printcharfun);			\
       if (marker_pos < BEGV || marker_pos > ZV)			\
Joakim Verona's avatar
Joakim Verona committed
117 118
	 signal_error ("Marker is outside the accessible "		\
		       "part of the buffer", printcharfun);		\
119 120
       old_point = PT;							\
       old_point_byte = PT_BYTE;					\
121
       SET_PT_BOTH (marker_pos,						\
122 123 124 125 126 127 128 129
		    marker_byte_position (printcharfun));		\
       start_point = PT;						\
       start_point_byte = PT_BYTE;					\
       printcharfun = Qnil;						\
     }									\
   if (NILP (printcharfun))						\
     {									\
       Lisp_Object string;						\
Joakim Verona's avatar
Joakim Verona committed
130
       if (NILP (BVAR (current_buffer, enable_multibyte_characters))	\
131 132
	   && ! print_escape_multibyte)					\
         specbind (Qprint_escape_multibyte, Qt);			\
Joakim Verona's avatar
Joakim Verona committed
133
       if (! NILP (BVAR (current_buffer, enable_multibyte_characters))	\
134 135
	   && ! print_escape_nonascii)					\
         specbind (Qprint_escape_nonascii, Qt);				\
136 137 138 139 140 141 142 143 144
       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								\
	 {								\
145
	   int new_size = 1000;						\
Dmitry Antipov's avatar
Dmitry Antipov committed
146
	   print_buffer = xmalloc (new_size);				\
147
	   print_buffer_size = new_size;				\
148 149 150 151 152
	   free_print_buffer = 1;					\
	 }								\
       print_buffer_pos = 0;						\
       print_buffer_pos_byte = 0;					\
     }									\
153
   if (EQ (printcharfun, Qt) && ! noninteractive)			\
154
     setup_echo_area_for_printing (multibyte);
Jim Blandy's avatar
Jim Blandy committed
155

156 157 158 159
#define PRINTFINISH							\
   if (NILP (printcharfun))						\
     {									\
       if (print_buffer_pos != print_buffer_pos_byte			\
Joakim Verona's avatar
Joakim Verona committed
160
	   && NILP (BVAR (current_buffer, enable_multibyte_characters)))\
161
	 {								\
162 163
	   USE_SAFE_ALLOCA;						\
	   unsigned char *temp = SAFE_ALLOCA (print_buffer_pos + 1);	\
164 165
	   copy_text ((unsigned char *) print_buffer, temp,		\
		      print_buffer_pos_byte, 1, 0);			\
166
	   insert_1_both ((char *) temp, print_buffer_pos,		\
167
			  print_buffer_pos, 0, 1, 0);			\
168
	   SAFE_FREE ();						\
169 170 171 172
	 }								\
       else								\
	 insert_1_both (print_buffer, print_buffer_pos,			\
			print_buffer_pos_byte, 0, 1, 0);		\
173
       signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
174 175 176 177 178 179 180 181 182 183 184 185
     }									\
   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),			\
186
		  old_point_byte + (old_point_byte >= start_point_byte	\
Andreas Schwab's avatar
Andreas Schwab committed
187
				    ? PT_BYTE - start_point_byte : 0));	\
188
   set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
189

190 191
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
192

193
static void
194
print_unwind (Lisp_Object saved_text)
195
{
196
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
197 198
}

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
/* Print character CH to the stdio stream STREAM.  */

static void
printchar_to_stream (unsigned int ch, FILE *stream)
{
  Lisp_Object dv IF_LINT (= Qnil);
  ptrdiff_t i = 0, n = 1;

  if (CHAR_VALID_P (ch) && DISP_TABLE_P (Vstandard_display_table))
    {
      dv = DISP_CHAR_VECTOR (XCHAR_TABLE (Vstandard_display_table), ch);
      if (VECTORP (dv))
	{
	  n = ASIZE (dv);
	  goto next_char;
	}
    }

  while (true)
    {
      if (ASCII_CHAR_P (ch))
	{
	  putc (ch, stream);
#ifdef WINDOWSNT
	  /* Send the output to a debugger (nothing happens if there
	     isn't one).  */
	  if (print_output_debug_flag && stream == stderr)
	    OutputDebugString ((char []) {ch, '\0'});
#endif
	}
      else
	{
	  unsigned char mbstr[MAX_MULTIBYTE_LENGTH];
	  int len = CHAR_STRING (ch, mbstr);
	  Lisp_Object encoded_ch =
	    ENCODE_SYSTEM (make_multibyte_string ((char *) mbstr, 1, len));

	  fwrite (SSDATA (encoded_ch), 1, SBYTES (encoded_ch), stream);
#ifdef WINDOWSNT
	  if (print_output_debug_flag && stream == stderr)
	    OutputDebugString (SSDATA (encoded_ch));
#endif
	}

      i++;

    next_char:
      for (; i < n; i++)
	if (CHARACTERP (AREF (dv, i)))
	  break;
      if (! (i < n))
	break;
      ch = XFASTINT (AREF (dv, i));
    }
}
254 255 256 257 258

/* 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
259 260

static void
261
printchar (unsigned int ch, Lisp_Object fun)
Jim Blandy's avatar
Jim Blandy committed
262
{
263 264 265
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
266
    {
267 268 269
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

270
      QUIT;
271

272
      if (NILP (fun))
273
	{
274
	  ptrdiff_t incr = len - (print_buffer_size - print_buffer_pos_byte);
275 276 277
	  if (incr > 0)
	    print_buffer = xpalloc (print_buffer, &print_buffer_size,
				    incr, -1, 1);
278
	  memcpy (print_buffer + print_buffer_pos_byte, str, len);
279 280
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
281
	}
282
      else if (noninteractive)
283
	{
284
	  printchar_stdout_last = ch;
285 286 287 288
	  if (DISP_TABLE_P (Vstandard_display_table))
	    printchar_to_stream (ch, stdout);
	  else
	    fwrite (str, 1, len, stdout);
289
	  noninteractive_need_newline = 1;
290
	}
291
      else
292
	{
293
	  bool multibyte_p
Tom Tromey's avatar
Tom Tromey committed
294
	    = !NILP (BVAR (current_buffer, enable_multibyte_characters));
295

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

303 304

/* Output SIZE characters, SIZE_BYTE bytes from string PTR using
305
   method PRINTCHARFUN.  PRINTCHARFUN nil means output to
306 307 308
   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
309 310 311 312
   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.  */
313

Jim Blandy's avatar
Jim Blandy committed
314
static void
315
strout (const char *ptr, ptrdiff_t size, ptrdiff_t size_byte,
316
	Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
317
{
318
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
319
    {
320
      ptrdiff_t incr = size_byte - (print_buffer_size - print_buffer_pos_byte);
321
      if (incr > 0)
322
	print_buffer = xpalloc (print_buffer, &print_buffer_size, incr, -1, 1);
323
      memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
324
      print_buffer_pos += size;
325
      print_buffer_pos_byte += size_byte;
Jim Blandy's avatar
Jim Blandy committed
326
    }
327
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
328
    {
329 330 331 332 333 334 335 336 337 338 339 340 341
      if (DISP_TABLE_P (Vstandard_display_table))
	{
	  int len;
	  for (ptrdiff_t i = 0; i < size_byte; i += len)
	    {
	      int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
					       len);
	      printchar_to_stream (ch, stdout);
	    }
	}
      else
	fwrite (ptr, 1, size_byte, stdout);

342 343 344 345 346 347 348 349
      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;
350
      bool multibyte_p
Tom Tromey's avatar
Tom Tromey committed
351
	= !NILP (BVAR (current_buffer, enable_multibyte_characters));
352

353
      setup_echo_area_for_printing (multibyte_p);
354
      message_dolog (ptr, size_byte, 0, multibyte_p);
355

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

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

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

406
static void
407
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
408
{
409
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
410
    {
411
      ptrdiff_t chars;
412

413 414 415
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

416
      if (STRING_MULTIBYTE (string))
417
	chars = SCHARS (string);
418 419
      else if (! print_escape_nonascii
	       && (EQ (printcharfun, Qt)
Tom Tromey's avatar
Tom Tromey committed
420 421
		   ? ! NILP (BVAR (&buffer_defaults, enable_multibyte_characters))
		   : ! NILP (BVAR (current_buffer, enable_multibyte_characters))))
422 423 424 425 426
	{
	  /* If unibyte string STRING contains 8-bit codes, we must
	     convert STRING to a multibyte string containing the same
	     character codes.  */
	  Lisp_Object newstr;
427
	  ptrdiff_t bytes;
428

429
	  chars = SBYTES (string);
430
	  bytes = count_size_as_multibyte (SDATA (string), chars);
431 432 433
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
434
	      memcpy (SDATA (newstr), SDATA (string), chars);
435
	      str_to_multibyte (SDATA (newstr), bytes, chars);
436 437 438
	      string = newstr;
	    }
	}
439
      else
440
	chars = SBYTES (string);
441

442 443 444
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
445
	  ptrdiff_t nbytes = SBYTES (string);
446 447 448 449

	  /* Copy the string contents so that relocation of STRING by
	     GC does not cause trouble.  */
	  USE_SAFE_ALLOCA;
450
	  char *buffer = SAFE_ALLOCA (nbytes);
451
	  memcpy (buffer, SDATA (string), nbytes);
452

453
	  strout (buffer, chars, nbytes, printcharfun);
454 455 456 457 458

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

498 499
/* Print the contents of a unibyte C string STRING using PRINTCHARFUN.
   The caller should arrange to put this inside PRINTPREPARE and PRINTFINISH.
Jim Blandy's avatar
Jim Blandy committed
500 501
   Do not use this on the contents of a Lisp string.  */

502 503
static void
print_c_string (char const *string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
504
{
505 506 507
  ptrdiff_t len = strlen (string);
  strout (string, len, len, printcharfun);
}
Jim Blandy's avatar
Jim Blandy committed
508

509 510
/* Print unibyte C string at DATA on a specified stream PRINTCHARFUN.
   Do not use this on the contents of a Lisp string.  */
Jim Blandy's avatar
Jim Blandy committed
511

512 513 514
static void
write_string_1 (const char *data, Lisp_Object printcharfun)
{
Jim Blandy's avatar
Jim Blandy committed
515
  PRINTPREPARE;
516
  print_c_string (data, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
517 518 519
  PRINTFINISH;
}

520 521
/* Used from outside of print.c to print a C unibyte
   string at DATA on the default output stream.
Jim Blandy's avatar
Jim Blandy committed
522 523
   Do not use this on the contents of a Lisp string.  */

524 525
void
write_string (const char *data)
Jim Blandy's avatar
Jim Blandy committed
526
{
527
  write_string_1 (data, Vstandard_output);
Jim Blandy's avatar
Jim Blandy committed
528 529 530 531
}


void
532
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
533
{
534
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
535 536 537
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

538
  record_unwind_current_buffer ();
539

Jim Blandy's avatar
Jim Blandy committed
540 541
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

542
  Fkill_all_local_variables ();
543
  delete_all_overlays (current_buffer);
Paul Eggert's avatar
Paul Eggert committed
544 545 546 547
  bset_directory (current_buffer, BVAR (old, directory));
  bset_read_only (current_buffer, Qnil);
  bset_filename (current_buffer, Qnil);
  bset_undo_list (current_buffer, Qt);
548 549
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
Paul Eggert's avatar
Paul Eggert committed
550 551
  bset_enable_multibyte_characters
    (current_buffer, BVAR (&buffer_defaults, enable_multibyte_characters));
552 553
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
554
  Ferase_buffer ();
555
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
556

557
  run_hook (Qtemp_buffer_setup_hook);
558 559 560 561

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
562 563
}

564 565 566 567
static void print (Lisp_Object, Lisp_Object, bool);
static void print_preprocess (Lisp_Object);
static void print_preprocess_string (INTERVAL, Lisp_Object);
static void print_object (Lisp_Object, Lisp_Object, bool);
Jim Blandy's avatar
Jim Blandy committed
568

569
DEFUN ("terpri", Fterpri, Sterpri, 0, 2, 0,
570
       doc: /* Output a newline to stream PRINTCHARFUN.
571 572
If ENSURE is non-nil only output a newline if not already at the
beginning of a line.  Value is non-nil if a newline is printed.
573
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.  */)
574
  (Lisp_Object printcharfun, Lisp_Object ensure)
Jim Blandy's avatar
Jim Blandy committed
575
{
576
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
577

Jim Blandy's avatar
Jim Blandy committed
578
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
579 580
    printcharfun = Vstandard_output;
  PRINTPREPARE;
581 582 583 584 585 586 587 588

  if (NILP (ensure))
    val = Qt;
  /* Difficult to check if at line beginning so abort.  */
  else if (FUNCTIONP (printcharfun))
    signal_error ("Unsupported function argument", printcharfun);
  else if (noninteractive && !NILP (printcharfun))
    val = printchar_stdout_last == 10 ? Qnil : Qt;
589 590
  else
    val = NILP (Fbolp ()) ? Qt : Qnil;
591

592 593
  if (!NILP (val))
    printchar ('\n', printcharfun);
Jim Blandy's avatar
Jim Blandy committed
594
  PRINTFINISH;
595
  return val;
Jim Blandy's avatar
Jim Blandy committed
596 597
}

Paul Eggert's avatar
Paul Eggert committed
598
DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
599 600
       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
601
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
602
is controlled by `print-level' and `print-length', which see.
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620

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
621
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
622
{
Jim Blandy's avatar
Jim Blandy committed
623
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
624 625
    printcharfun = Vstandard_output;
  PRINTPREPARE;
626
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
627
  PRINTFINISH;
628
  return object;
Jim Blandy's avatar
Jim Blandy committed
629 630 631 632 633
}

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

Paul Eggert's avatar
Paul Eggert committed
634
DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
635 636
       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
637
when necessary to make output that `read' can handle, whenever possible,
638 639
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
640 641 642 643 644

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
645
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
646
{
647
  ptrdiff_t count = SPECPDL_INDEX ();
648 649

  specbind (Qinhibit_modification_hooks, Qt);
650

651 652 653 654 655 656
  /* 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.  */
  Lisp_Object save_deactivate_mark = Vdeactivate_mark;
  bool prev_abort_on_gc = abort_on_gc;
  abort_on_gc = true;
Jim Blandy's avatar
Jim Blandy committed
657

658 659 660 661 662 663 664
  Lisp_Object printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print (object, printcharfun, NILP (noescape));
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINISH */
  PRINTFINISH;

  struct buffer *previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
665
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
666
  object = Fbuffer_string ();
667 668
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
669

670
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
671 672
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
673
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
674
  set_buffer_internal (previous);
675

676
  Vdeactivate_mark = save_deactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
677

678
  abort_on_gc = prev_abort_on_gc;
679
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
680 681
}

682
DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
       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
704
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
705
{
Jim Blandy's avatar
Jim Blandy committed
706
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
707 708
    printcharfun = Vstandard_output;
  PRINTPREPARE;
709
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
710
  PRINTFINISH;
711
  return object;
Jim Blandy's avatar
Jim Blandy committed
712 713
}

Paul Eggert's avatar
Paul Eggert committed
714
DEFUN ("print", Fprint, Sprint, 1, 2, 0,
715 716
       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
717
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
718
is controlled by `print-level' and `print-length', which see.
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736

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
737
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
738
{
Jim Blandy's avatar
Jim Blandy committed
739
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
740 741
    printcharfun = Vstandard_output;
  PRINTPREPARE;
742
  printchar ('\n', printcharfun);
743
  print (object, printcharfun, 1);
744
  printchar ('\n', printcharfun);
Jim Blandy's avatar
Jim Blandy committed
745
  PRINTFINISH;
746
  return object;
Jim Blandy's avatar
Jim Blandy committed
747 748
}

Jim Blandy's avatar
Jim Blandy committed
749
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
750 751 752
       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
753
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
754
{
755
  CHECK_NUMBER (character);
756
  printchar_to_stream (XINT (character), stderr);
Jim Blandy's avatar
Jim Blandy committed
757 758
  return character;
}
759

760 761 762
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

763
extern void debug_output_compilation_hack (bool) EXTERNALLY_VISIBLE;
764
void
765
debug_output_compilation_hack (bool x)
766 767 768
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
769

Andreas Schwab's avatar
Andreas Schwab committed
770
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
771 772 773 774 775 776

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

777
static FILE *initial_stderr_stream = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
778 779 780 781 782 783 784

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
785
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
786
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
787 788
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
789
    {
790
      block_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
791
      fclose (stderr);
792
      unblock_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
793
    }
Kenichi Handa's avatar
Kenichi Handa committed
794 795 796 797 798 799 800
  stderr = initial_stderr_stream;
  initial_stderr_stream = NULL;

  if (STRINGP (file))
    {
      file = Fexpand_file_name (file, Qnil);
      initial_stderr_stream = stderr;
801
      stderr = emacs_fopen (SSDATA (file), NILP (append) ? "w" : "a");
Kenichi Handa's avatar
Kenichi Handa committed
802 803 804 805
      if (stderr == NULL)
	{
	  stderr = initial_stderr_stream;
	  initial_stderr_stream = NULL;
806
	  report_file_error ("Cannot open debugging output stream", file);
Kenichi Handa's avatar
Kenichi Handa committed
807 808 809 810 811 812 813
	}
    }
  return Qnil;
}
#endif /* GNU_LINUX */


814 815 816
/* This is the interface for debugging printing.  */

void
817
debug_print (Lisp_Object arg)
818 819
{
  Fprin1 (arg, Qexternal_debugging_output);
820
  fprintf (stderr, "\r\n");
821
}
822

823
void safe_debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
824
void
825
safe_debug_print (Lisp_Object arg)
826 827 828 829 830 831
{
  int valid = valid_lisp_object_p (arg);

  if (valid > 0)
    debug_print (arg);
  else
832 833 834