print.c 68.4 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-2016 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 "coding.h"
28
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
29
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31
#include "process.h"
32
#include "disptab.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
33
#include "intervals.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
34
#include "blockinput.h"
Paul Eggert's avatar
Paul Eggert committed
35
#include "xwidget.h"
36

37
#include <c-ctype.h>
Paul Eggert's avatar
Paul Eggert committed
38
#include <float.h>
Paul Eggert's avatar
Paul Eggert committed
39
#include <ftoastr.h>
Paul Eggert's avatar
Paul Eggert committed
40

41 42
struct terminal;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

197 198 199 200 201 202 203
/* 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;
204 205 206 207 208 209 210
  Lisp_Object coding_system = Vlocale_coding_system;
  bool encode_p = false;

  if (!NILP (Vcoding_system_for_write))
    coding_system = Vcoding_system_for_write;
  if (!NILP (coding_system))
    encode_p = true;
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

  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 =
239
	    make_multibyte_string ((char *) mbstr, 1, len);
240

241 242 243
	  if (encode_p)
	    encoded_ch = code_convert_string_norecord (encoded_ch,
						       coding_system, true);
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
	  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));
    }
}
262 263 264 265 266

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

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

278
      QUIT;
279

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

304
	  setup_echo_area_for_printing (multibyte_p);
305
	  insert_char (ch);
306
	  message_dolog ((char *) str, len, 0, multibyte_p);
307
	}
Jim Blandy's avatar
Jim Blandy committed
308 309 310
    }
}

311 312

/* Output SIZE characters, SIZE_BYTE bytes from string PTR using
313
   method PRINTCHARFUN.  PRINTCHARFUN nil means output to
314 315 316
   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
317 318 319 320
   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.  */
321

Jim Blandy's avatar
Jim Blandy committed
322
static void
323
strout (const char *ptr, ptrdiff_t size, ptrdiff_t size_byte,
324
	Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
325
{
326
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
327
    {
328
      ptrdiff_t incr = size_byte - (print_buffer_size - print_buffer_pos_byte);
329
      if (incr > 0)
330
	print_buffer = xpalloc (print_buffer, &print_buffer_size, incr, -1, 1);
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 348 349
      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);

350 351 352 353 354 355 356 357
      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;
358
      bool multibyte_p
Tom Tromey's avatar
Tom Tromey committed
359
	= !NILP (BVAR (current_buffer, enable_multibyte_characters));
360

361
      setup_echo_area_for_printing (multibyte_p);
362
      message_dolog (ptr, size_byte, 0, multibyte_p);
363

364
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
365
	{
366
	  for (i = 0; i < size; ++i)
Andreas Schwab's avatar
Andreas Schwab committed
367
	    insert_char ((unsigned char) *ptr++);
Jim Blandy's avatar
Jim Blandy committed
368
	}
369
      else
Jim Blandy's avatar
Jim Blandy committed
370
	{
371 372
	  int len;
	  for (i = 0; i < size_byte; i += len)
373
	    {
374 375
	      int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
					       len);
376
	      insert_char (ch);
377
	    }
Jim Blandy's avatar
Jim Blandy committed
378
	}
379 380 381 382
    }
  else
    {
      /* PRINTCHARFUN is a Lisp function.  */
383
      ptrdiff_t i = 0;
Jim Blandy's avatar
Jim Blandy committed
384

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

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

414
static void
415
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
416
{
417
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
418
    {
419
      ptrdiff_t chars;
420

421 422 423
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

424
      if (STRING_MULTIBYTE (string))
425
	chars = SCHARS (string);
426 427
      else if (! print_escape_nonascii
	       && (EQ (printcharfun, Qt)
Tom Tromey's avatar
Tom Tromey committed
428 429
		   ? ! NILP (BVAR (&buffer_defaults, enable_multibyte_characters))
		   : ! NILP (BVAR (current_buffer, enable_multibyte_characters))))
430 431 432 433 434
	{
	  /* If unibyte string STRING contains 8-bit codes, we must
	     convert STRING to a multibyte string containing the same
	     character codes.  */
	  Lisp_Object newstr;
435
	  ptrdiff_t bytes;
436

437
	  chars = SBYTES (string);
438
	  bytes = count_size_as_multibyte (SDATA (string), chars);
439 440 441
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
442
	      memcpy (SDATA (newstr), SDATA (string), chars);
443
	      str_to_multibyte (SDATA (newstr), bytes, chars);
444 445 446
	      string = newstr;
	    }
	}
447
      else
448
	chars = SBYTES (string);
449

450 451 452
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
453
	  ptrdiff_t nbytes = SBYTES (string);
454 455 456 457

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

461
	  strout (buffer, chars, nbytes, printcharfun);
462 463 464 465 466

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

506 507
/* 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
508 509
   Do not use this on the contents of a Lisp string.  */

510 511
static void
print_c_string (char const *string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
512
{
513 514 515
  ptrdiff_t len = strlen (string);
  strout (string, len, len, printcharfun);
}
Jim Blandy's avatar
Jim Blandy committed
516

517 518
/* 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
519

520 521 522
static void
write_string_1 (const char *data, Lisp_Object printcharfun)
{
Jim Blandy's avatar
Jim Blandy committed
523
  PRINTPREPARE;
524
  print_c_string (data, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
525 526 527
  PRINTFINISH;
}

528 529
/* 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
530 531
   Do not use this on the contents of a Lisp string.  */

532 533
void
write_string (const char *data)
Jim Blandy's avatar
Jim Blandy committed
534
{
535
  write_string_1 (data, Vstandard_output);
Jim Blandy's avatar
Jim Blandy committed
536 537 538 539
}


void
540
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
541
{
542
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
543 544 545
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

546
  record_unwind_current_buffer ();
547

Jim Blandy's avatar
Jim Blandy committed
548 549
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

550
  Fkill_all_local_variables ();
551
  delete_all_overlays (current_buffer);
Paul Eggert's avatar
Paul Eggert committed
552 553 554 555
  bset_directory (current_buffer, BVAR (old, directory));
  bset_read_only (current_buffer, Qnil);
  bset_filename (current_buffer, Qnil);
  bset_undo_list (current_buffer, Qt);
556 557
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
Paul Eggert's avatar
Paul Eggert committed
558 559
  bset_enable_multibyte_characters
    (current_buffer, BVAR (&buffer_defaults, enable_multibyte_characters));
560 561
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
562
  Ferase_buffer ();
563
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
564

565
  run_hook (Qtemp_buffer_setup_hook);
566 567 568 569

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
570 571
}

572 573 574 575
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
576

577
DEFUN ("terpri", Fterpri, Sterpri, 0, 2, 0,
578
       doc: /* Output a newline to stream PRINTCHARFUN.
579 580
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.
581
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.  */)
582
  (Lisp_Object printcharfun, Lisp_Object ensure)
Jim Blandy's avatar
Jim Blandy committed
583
{
584
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
585

Jim Blandy's avatar
Jim Blandy committed
586
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
587 588
    printcharfun = Vstandard_output;
  PRINTPREPARE;
589 590 591 592 593 594 595 596

  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;
597 598
  else
    val = NILP (Fbolp ()) ? Qt : Qnil;
599

600 601
  if (!NILP (val))
    printchar ('\n', printcharfun);
Jim Blandy's avatar
Jim Blandy committed
602
  PRINTFINISH;
603
  return val;
Jim Blandy's avatar
Jim Blandy committed
604 605
}

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

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
629
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
630
{
Jim Blandy's avatar
Jim Blandy committed
631
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
632 633
    printcharfun = Vstandard_output;
  PRINTPREPARE;
634
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
635
  PRINTFINISH;
636
  return object;
Jim Blandy's avatar
Jim Blandy committed
637 638 639 640 641
}

/* 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
642
DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
643 644
       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
645
when necessary to make output that `read' can handle, whenever possible,
646 647
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
648 649 650 651 652

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
653
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
654
{
655
  ptrdiff_t count = SPECPDL_INDEX ();
656 657

  specbind (Qinhibit_modification_hooks, Qt);
658

659 660 661 662 663 664
  /* 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
665

666 667 668 669 670 671 672
  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
673
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
674
  object = Fbuffer_string ();
675 676
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
677

678
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
679 680
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
681
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
682
  set_buffer_internal (previous);
683

684
  Vdeactivate_mark = save_deactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
685

686
  abort_on_gc = prev_abort_on_gc;
687
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
688 689
}

690
DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
       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
712
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
713
{
Jim Blandy's avatar
Jim Blandy committed
714
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
715 716
    printcharfun = Vstandard_output;
  PRINTPREPARE;
717
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
718
  PRINTFINISH;
719
  return object;
Jim Blandy's avatar
Jim Blandy committed
720 721
}

Paul Eggert's avatar
Paul Eggert committed
722
DEFUN ("print", Fprint, Sprint, 1, 2, 0,
723 724
       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
725
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
726
is controlled by `print-level' and `print-length', which see.
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744

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
745
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
746
{
Jim Blandy's avatar
Jim Blandy committed
747
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
748 749
    printcharfun = Vstandard_output;
  PRINTPREPARE;
750
  printchar ('\n', printcharfun);
751
  print (object, printcharfun, 1);
752
  printchar ('\n', printcharfun);
Jim Blandy's avatar
Jim Blandy committed
753
  PRINTFINISH;
754
  return object;
Jim Blandy's avatar
Jim Blandy committed
755 756
}

Jim Blandy's avatar
Jim Blandy committed
757
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
758 759 760
       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
761
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
762
{
763
  CHECK_NUMBER (character);
764
  printchar_to_stream (XINT (character), stderr);
Jim Blandy's avatar
Jim Blandy committed
765 766
  return character;
}
767

768 769 770
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

771
extern void debug_output_compilation_hack (bool) EXTERNALLY_VISIBLE;
772
void
773
debug_output_compilation_hack (bool x)
774 775 776
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
777 778 779 780 781 782 783

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
784
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
785
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
786
{
787 788 789 790
  /* If equal to STDERR_FILENO, stderr has not been duplicated and is OK as-is.
     Otherwise, this is a close-on-exec duplicate of the original stderr. */
  static int stderr_dup = STDERR_FILENO;
  int fd = stderr_dup;
Kenichi Handa's avatar
Kenichi Handa committed
791

792
  if (! NILP (file))
Kenichi Handa's avatar
Kenichi Handa committed
793 794
    {
      file = Fexpand_file_name (file, Qnil);
795 796

      if (stderr_dup == STDERR_FILENO)
Kenichi Handa's avatar
Kenichi Handa committed
797
	{
798 799 800 801
	  int n = fcntl (STDERR_FILENO, F_DUPFD_CLOEXEC, STDERR_FILENO + 1);
	  if (n < 0)
	    report_file_error ("dup", file);
	  stderr_dup = n;
Kenichi Handa's avatar
Kenichi Handa committed
802
	}
803 804 805 806 807 808 809

      fd = emacs_open (SSDATA (ENCODE_FILE (file)),
		       (O_WRONLY | O_CREAT
			| (! NILP (append) ? O_APPEND : O_TRUNC)),
		       0666);
      if (fd < 0)
	report_file_error ("Cannot open debugging output stream", file);
Kenichi Handa's avatar
Kenichi Handa committed
810
    }
811 812 813 814 815 816

  fflush (stderr);
  if (dup2 (fd, STDERR_FILENO) < 0)
    report_file_error ("dup2", file);
  if (fd != stderr_dup)
    emacs_close (fd);
Kenichi Handa's avatar
Kenichi Handa committed
817 818 819 820
  return Qnil;
}


821 822 823
/* This is the interface for debugging printing.  */

void
824
debug_print (Lisp_Object arg)
825 826
{
  Fprin1 (arg, Qexternal_debugging_output);
827
  fprintf (stderr, "\r\n");
828
}
829

830
void safe_debug_print (Lisp_Object) EXTERNALLY_VISIBLE;