print.c 67.8 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 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"
jave's avatar
jave committed
39

40
#ifdef HAVE_XWIDGETS
41
#include "xwidget.h"
42
#endif
Paul Eggert's avatar
Paul Eggert committed
43 44

#include <float.h>
Paul Eggert's avatar
Paul Eggert committed
45
#include <ftoastr.h>
Paul Eggert's avatar
Paul Eggert committed
46

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

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

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

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

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

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

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

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

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

/* Lisp functions to do output using a stream
89 90 91 92
   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,
93
   or call strout to output a block of characters.  */
94 95 96

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
97 98 99
   ptrdiff_t old_point = -1, start_point = -1;				\
   ptrdiff_t old_point_byte = -1, start_point_byte = -1;		\
   ptrdiff_t specpdl_count = SPECPDL_INDEX ();				\
100
   bool free_print_buffer = 0;						\
101 102
   bool multibyte							\
     = !NILP (BVAR (current_buffer, enable_multibyte_characters));	\
103 104
   Lisp_Object original

105 106 107 108 109 110 111 112 113 114 115
#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))						\
     {									\
116
       ptrdiff_t marker_pos;						\
Andreas Schwab's avatar
Andreas Schwab committed
117
       if (! XMARKER (printcharfun)->buffer)				\
118
         error ("Marker does not point anywhere");			\
119 120 121 122
       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
123 124
	 signal_error ("Marker is outside the accessible "		\
		       "part of the buffer", printcharfun);		\
125 126
       old_point = PT;							\
       old_point_byte = PT_BYTE;					\
127
       SET_PT_BOTH (marker_pos,						\
128 129 130 131 132 133 134 135
		    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
136
       if (NILP (BVAR (current_buffer, enable_multibyte_characters))	\
137 138
	   && ! print_escape_multibyte)					\
         specbind (Qprint_escape_multibyte, Qt);			\
Joakim Verona's avatar
Joakim Verona committed
139
       if (! NILP (BVAR (current_buffer, enable_multibyte_characters))	\
140 141
	   && ! print_escape_nonascii)					\
         specbind (Qprint_escape_nonascii, Qt);				\
142 143 144 145 146 147 148 149 150
       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								\
	 {								\
151
	   int new_size = 1000;						\
Dmitry Antipov's avatar
Dmitry Antipov committed
152
	   print_buffer = xmalloc (new_size);				\
153
	   print_buffer_size = new_size;				\
154 155 156 157 158
	   free_print_buffer = 1;					\
	 }								\
       print_buffer_pos = 0;						\
       print_buffer_pos_byte = 0;					\
     }									\
159
   if (EQ (printcharfun, Qt) && ! noninteractive)			\
160
     setup_echo_area_for_printing (multibyte);
Jim Blandy's avatar
Jim Blandy committed
161

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

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

198 199
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
200

201
static void
202
print_unwind (Lisp_Object saved_text)
203
{
204
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
205 206
}

207 208 209 210 211

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

static void
214
printchar (unsigned int ch, Lisp_Object fun)
Jim Blandy's avatar
Jim Blandy committed
215
{
216 217 218
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
219
    {
220 221 222
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

223
      QUIT;
224

225
      if (NILP (fun))
226
	{
227
	  ptrdiff_t incr = len - (print_buffer_size - print_buffer_pos_byte);
228 229 230
	  if (incr > 0)
	    print_buffer = xpalloc (print_buffer, &print_buffer_size,
				    incr, -1, 1);
231
	  memcpy (print_buffer + print_buffer_pos_byte, str, len);
232 233
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
234
	}
235
      else if (noninteractive)
236
	{
237
	  printchar_stdout_last = ch;
238 239
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
240
	}
241
      else
242
	{
243
	  bool multibyte_p
Tom Tromey's avatar
Tom Tromey committed
244
	    = !NILP (BVAR (current_buffer, enable_multibyte_characters));
245

246
	  setup_echo_area_for_printing (multibyte_p);
247
	  insert_char (ch);
248
	  message_dolog ((char *) str, len, 0, multibyte_p);
249
	}
Jim Blandy's avatar
Jim Blandy committed
250 251 252
    }
}

253 254 255 256 257 258 259

/* 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
260 261 262 263
   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.  */
264

Jim Blandy's avatar
Jim Blandy committed
265
static void
266
strout (const char *ptr, ptrdiff_t size, ptrdiff_t size_byte,
267
	Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
268
{
Karl Heuer's avatar
Karl Heuer committed
269
  if (size < 0)
270
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
271

272
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
273
    {
274
      ptrdiff_t incr = size_byte - (print_buffer_size - print_buffer_pos_byte);
275
      if (incr > 0)
276
	print_buffer = xpalloc (print_buffer, &print_buffer_size, incr, -1, 1);
277
      memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
278
      print_buffer_pos += size;
279
      print_buffer_pos_byte += size_byte;
Jim Blandy's avatar
Jim Blandy committed
280
    }
281
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
282
    {
283 284 285 286 287 288 289 290 291
      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;
292
      bool multibyte_p
Tom Tromey's avatar
Tom Tromey committed
293
	= !NILP (BVAR (current_buffer, enable_multibyte_characters));
294

295
      setup_echo_area_for_printing (multibyte_p);
296
      message_dolog (ptr, size_byte, 0, multibyte_p);
297

298
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
299
	{
300
	  for (i = 0; i < size; ++i)
Andreas Schwab's avatar
Andreas Schwab committed
301
	    insert_char ((unsigned char) *ptr++);
Jim Blandy's avatar
Jim Blandy committed
302
	}
303
      else
Jim Blandy's avatar
Jim Blandy committed
304
	{
305 306
	  int len;
	  for (i = 0; i < size_byte; i += len)
307
	    {
308 309
	      int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
					       len);
310
	      insert_char (ch);
311
	    }
Jim Blandy's avatar
Jim Blandy committed
312
	}
313 314 315 316
    }
  else
    {
      /* PRINTCHARFUN is a Lisp function.  */
317
      ptrdiff_t i = 0;
Jim Blandy's avatar
Jim Blandy committed
318

319
      if (size == size_byte)
320
	{
321
	  while (i < size_byte)
322
	    {
323 324
	      int ch = ptr[i++];
	      PRINTCHAR (ch);
325 326
	    }
	}
327
      else
Karl Heuer's avatar
Karl Heuer committed
328
	{
329 330 331 332 333 334
	  while (i < size_byte)
	    {
	      /* Here, we must convert each multi-byte form to the
		 corresponding character code before handing it to
		 PRINTCHAR.  */
	      int len;
335 336
	      int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
					       len);
337 338 339
	      PRINTCHAR (ch);
	      i += len;
	    }
Karl Heuer's avatar
Karl Heuer committed
340
	}
Jim Blandy's avatar
Jim Blandy committed
341 342 343 344
    }
}

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

348
static void
349
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
350
{
351
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
352
    {
353
      ptrdiff_t chars;
354

355 356 357
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

358
      if (STRING_MULTIBYTE (string))
359
	chars = SCHARS (string);
360 361
      else if (! print_escape_nonascii
	       && (EQ (printcharfun, Qt)
Tom Tromey's avatar
Tom Tromey committed
362 363
		   ? ! NILP (BVAR (&buffer_defaults, enable_multibyte_characters))
		   : ! NILP (BVAR (current_buffer, enable_multibyte_characters))))
364 365 366 367 368
	{
	  /* If unibyte string STRING contains 8-bit codes, we must
	     convert STRING to a multibyte string containing the same
	     character codes.  */
	  Lisp_Object newstr;
369
	  ptrdiff_t bytes;
370

371
	  chars = SBYTES (string);
372
	  bytes = count_size_as_multibyte (SDATA (string), chars);
373 374 375
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
376
	      memcpy (SDATA (newstr), SDATA (string), chars);
377
	      str_to_multibyte (SDATA (newstr), bytes, chars);
378 379 380
	      string = newstr;
	    }
	}
381
      else
382
	chars = SBYTES (string);
383

384 385 386
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
387
	  ptrdiff_t nbytes = SBYTES (string);
388 389 390 391

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

395
	  strout (buffer, chars, nbytes, printcharfun);
396 397 398 399 400

	  SAFE_FREE ();
	}
      else
	/* No need to copy, since output to print_buffer can't GC.  */
401
	strout (SSDATA (string), chars, SBYTES (string), printcharfun);
402
    }
Jim Blandy's avatar
Jim Blandy committed
403 404
  else
    {
405 406
      /* Otherwise, string may be relocated by printing one char.
	 So re-fetch the string address for each character.  */
407 408 409
      ptrdiff_t i;
      ptrdiff_t size = SCHARS (string);
      ptrdiff_t size_byte = SBYTES (string);
Jim Blandy's avatar
Jim Blandy committed
410 411
      struct gcpro gcpro1;
      GCPRO1 (string);
412 413
      if (size == size_byte)
	for (i = 0; i < size; i++)
414
	  PRINTCHAR (SREF (string, i));
415
      else
Kenichi Handa's avatar
Kenichi Handa committed
416
	for (i = 0; i < size_byte; )
417 418 419 420
	  {
	    /* Here, we must convert each multi-byte form to the
	       corresponding character code before handing it to PRINTCHAR.  */
	    int len;
421
	    int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i, len);
422 423 424
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
425 426 427 428 429
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
430 431
       doc: /* Output character CHARACTER to stream PRINTCHARFUN.
PRINTCHARFUN defaults to the value of `standard-output' (which see).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
432
  (Lisp_Object character, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
433
{
434
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
435

Jim Blandy's avatar
Jim Blandy committed
436
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
437
    printcharfun = Vstandard_output;
438
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
439
  PRINTPREPARE;
440
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
441
  PRINTFINISH;
442
  return character;
Jim Blandy's avatar
Jim Blandy committed
443 444
}

445 446
/* 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
447 448
   Do not use this on the contents of a Lisp string.  */

449
void
450
write_string (const char *data, int size)
Jim Blandy's avatar
Jim Blandy committed
451
{
452
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
453 454 455 456 457
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
458
  strout (data, size, size, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
459 460 461
  PRINTFINISH;
}

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

Andreas Schwab's avatar
Andreas Schwab committed
466
static void
467
write_string_1 (const char *data, int size, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
468
{
469
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
470 471

  PRINTPREPARE;
472
  strout (data, size, size, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
473 474 475 476 477
  PRINTFINISH;
}


void
478
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
479
{
480
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
481 482 483
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

484
  record_unwind_current_buffer ();
485

Jim Blandy's avatar
Jim Blandy committed
486 487
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

488
  Fkill_all_local_variables ();
489
  delete_all_overlays (current_buffer);
Paul Eggert's avatar
Paul Eggert committed
490 491 492 493
  bset_directory (current_buffer, BVAR (old, directory));
  bset_read_only (current_buffer, Qnil);
  bset_filename (current_buffer, Qnil);
  bset_undo_list (current_buffer, Qt);
494 495
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
Paul Eggert's avatar
Paul Eggert committed
496 497
  bset_enable_multibyte_characters
    (current_buffer, BVAR (&buffer_defaults, enable_multibyte_characters));
498 499
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
500
  Ferase_buffer ();
501
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
502

503
  run_hook (Qtemp_buffer_setup_hook);
504 505 506 507

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
508 509
}

510 511 512 513
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
514

515
DEFUN ("terpri", Fterpri, Sterpri, 0, 2, 0,
516
       doc: /* Output a newline to stream PRINTCHARFUN.
517 518
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.
519
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.  */)
520
  (Lisp_Object printcharfun, Lisp_Object ensure)
Jim Blandy's avatar
Jim Blandy committed
521
{
522
  Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
523

524
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
525
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
526 527
    printcharfun = Vstandard_output;
  PRINTPREPARE;
528 529 530 531 532 533 534 535 536 537 538 539

  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;
  else if (NILP (Fbolp ()))
    val = Qt;

  if (!NILP (val)) PRINTCHAR ('\n');
Jim Blandy's avatar
Jim Blandy committed
540
  PRINTFINISH;
541
  return val;
Jim Blandy's avatar
Jim Blandy committed
542 543
}

Paul Eggert's avatar
Paul Eggert committed
544
DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
545 546
       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
547
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
548
is controlled by `print-level' and `print-length', which see.
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566

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
567
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
568
{
569
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
570

Jim Blandy's avatar
Jim Blandy committed
571
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
572 573
    printcharfun = Vstandard_output;
  PRINTPREPARE;
574
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
575
  PRINTFINISH;
576
  return object;
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580 581
}

/* 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
582
DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
583 584
       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
585
when necessary to make output that `read' can handle, whenever possible,
586 587
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
588 589 590 591 592

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
593
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
594
{
595
  Lisp_Object printcharfun;
596
  bool prev_abort_on_gc;
597
  Lisp_Object save_deactivate_mark;
598
  ptrdiff_t count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
599
  struct buffer *previous;
600 601

  specbind (Qinhibit_modification_hooks, Qt);
602

Kenichi Handa's avatar
Kenichi Handa committed
603 604 605 606 607 608 609
  {
    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;
610 611
    prev_abort_on_gc = abort_on_gc;
    abort_on_gc = 1;
Kenichi Handa's avatar
Kenichi Handa committed
612 613 614 615

    printcharfun = Vprin1_to_string_buffer;
    PRINTPREPARE;
    print (object, printcharfun, NILP (noescape));
Paul Eggert's avatar
Paul Eggert committed
616
    /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINISH */
Kenichi Handa's avatar
Kenichi Handa committed
617 618
    PRINTFINISH;
  }
Jim Blandy's avatar
Jim Blandy committed
619

Kenichi Handa's avatar
Kenichi Handa committed
620
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
621
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
622
  object = Fbuffer_string ();
623 624
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
625

626
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
627 628
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
629
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
630
  set_buffer_internal (previous);
631

632
  Vdeactivate_mark = save_deactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
633

634
  abort_on_gc = prev_abort_on_gc;
635
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
636 637
}

638
DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
       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
660
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
661
{
662
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
663

Jim Blandy's avatar
Jim Blandy committed
664
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
665 666
    printcharfun = Vstandard_output;
  PRINTPREPARE;
667
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
668
  PRINTFINISH;
669
  return object;
Jim Blandy's avatar
Jim Blandy committed
670 671
}

Paul Eggert's avatar
Paul Eggert committed
672
DEFUN ("print", Fprint, Sprint, 1, 2, 0,
673 674
       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
675
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
676
is controlled by `print-level' and `print-length', which see.
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694

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
695
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
696
{
697
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
698 699
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
700
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
701
    printcharfun = Vstandard_output;
702
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
703 704
  PRINTPREPARE;
  PRINTCHAR ('\n');
705
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
706 707 708
  PRINTCHAR ('\n');
  PRINTFINISH;
  UNGCPRO;
709
  return object;
Jim Blandy's avatar
Jim Blandy committed
710 711
}

Jim Blandy's avatar
Jim Blandy committed
712
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
713 714 715
       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
716
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
717
{
718
  unsigned int ch;
719

720 721 722
  CHECK_NUMBER (character);
  ch = XINT (character);
  if (ASCII_CHAR_P (ch))
723
    {
724 725 726 727 728 729 730 731 732 733
      putc (ch, stderr);
#ifdef WINDOWSNT
      /* Send the output to a debugger (nothing happens if there isn't
	 one).  */
      if (print_output_debug_flag)
	{
	  char buf[2] = {(char) XINT (character), '\0'};
	  OutputDebugString (buf);
	}
#endif
734
    }
735 736 737 738 739
  else
    {
      unsigned char mbstr[MAX_MULTIBYTE_LENGTH];
      ptrdiff_t len = CHAR_STRING (ch, mbstr);
      Lisp_Object encoded_ch =
740
	ENCODE_SYSTEM (make_multibyte_string ((char *) mbstr, 1, len));
741 742 743 744 745

      fwrite (SSDATA (encoded_ch), SBYTES (encoded_ch), 1, stderr);
#ifdef WINDOWSNT
      if (print_output_debug_flag)
	OutputDebugString (SSDATA (encoded_ch));
746
#endif
747
    }
748

Jim Blandy's avatar
Jim Blandy committed
749 750
  return character;
}
751

752 753 754
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

755
extern void debug_output_compilation_hack (bool) EXTERNALLY_VISIBLE;
756
void
757
debug_output_compilation_hack (bool x)
758 759 760
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
761

Andreas Schwab's avatar
Andreas Schwab committed
762
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
763 764 765 766 767 768

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

769
static FILE *initial_stderr_stream = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
770 771 772 773 774 775 776

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
777
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
778
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
779 780
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
781
    {
782
      block_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
783
      fclose (stderr);
784
      unblock_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
785
    }
Kenichi Handa's avatar
Kenichi Handa committed
786 787 788 789 790 791 792
  stderr = initial_stderr_stream;
  initial_stderr_stream = NULL;

  if (STRINGP (file))
    {
      file = Fexpand_file_name (file, Qnil);
      initial_stderr_stream = stderr;
793
      stderr = emacs_fopen (SSDATA (file), NILP (append) ? "w" : "a");
Kenichi Handa's avatar
Kenichi Handa committed
794 795 796 797
      if (stderr == NULL)
	{
	  stderr = initial_stderr_stream;
	  initial_stderr_stream = NULL;
798
	  report_file_error ("Cannot open debugging output stream", file);
Kenichi Handa's avatar
Kenichi Handa committed
799 800 801 802 803 804 805
	}
    }
  return Qnil;
}
#endif /* GNU_LINUX */


806 807 808
/* This is the interface for debugging printing.  */

void
809
debug_print (Lisp_Object arg)
810