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"
Richard M. Stallman's avatar
Richard M. Stallman committed
39

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

42
static Lisp_Object Qtemp_buffer_setup_hook;
43

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

46
static Lisp_Object Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
47 48

#include <float.h>
Paul Eggert's avatar
Paul Eggert committed
49
#include <ftoastr.h>
Paul Eggert's avatar
Paul Eggert committed
50

Jim Blandy's avatar
Jim Blandy committed
51
/* Avoid actual stack overflow in print.  */
52
static ptrdiff_t print_depth;
Jim Blandy's avatar
Jim Blandy committed
53

54
/* Level of nesting inside outputting backquote in new style.  */
55
static ptrdiff_t new_backquote_output;
56

57 58
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
59
static Lisp_Object being_printed[PRINT_CIRCLE];
60

61 62 63
/* Last char printed to stdout by printchar.  */
static unsigned int printchar_stdout_last;

64 65
/* When printing into a buffer, first we put the text in this
   block, then insert it all at once.  */
66
static char *print_buffer;
67 68

/* Size allocated in print_buffer.  */
69
static ptrdiff_t print_buffer_size;
70
/* Chars stored in print_buffer.  */
71
static ptrdiff_t print_buffer_pos;
72
/* Bytes stored in print_buffer.  */
73
static ptrdiff_t print_buffer_pos_byte;
74

75
Lisp_Object Qprint_escape_newlines;
76
static Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
77

78 79 80 81 82 83 84 85
/* 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.  */
86
static ptrdiff_t print_number_index;
87
static void print_interval (INTERVAL interval, Lisp_Object printcharfun);
Jim Blandy's avatar
Jim Blandy committed
88

89
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
90
bool print_output_debug_flag EXTERNALLY_VISIBLE = 1;
91

Jim Blandy's avatar
Jim Blandy committed
92

93
/* Low level output routines for characters and strings.  */
Jim Blandy's avatar
Jim Blandy committed
94 95

/* Lisp functions to do output using a stream
96 97 98 99
   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,
100
   or call strout to output a block of characters.  */
101 102 103

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
104 105 106
   ptrdiff_t old_point = -1, start_point = -1;				\
   ptrdiff_t old_point_byte = -1, start_point_byte = -1;		\
   ptrdiff_t specpdl_count = SPECPDL_INDEX ();				\
107
   bool free_print_buffer = 0;						\
108 109
   bool multibyte							\
     = !NILP (BVAR (current_buffer, enable_multibyte_characters));	\
110 111
   Lisp_Object original

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

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

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

205 206
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
207

208
static void
209
print_unwind (Lisp_Object saved_text)
210
{
211
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
212 213
}

214 215 216 217 218

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

static void
221
printchar (unsigned int ch, Lisp_Object fun)
Jim Blandy's avatar
Jim Blandy committed
222
{
223 224 225
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
226
    {
227 228 229
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

230
      QUIT;
231

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

253
	  setup_echo_area_for_printing (multibyte_p);
254
	  insert_char (ch);
255
	  message_dolog ((char *) str, len, 0, multibyte_p);
256
	}
Jim Blandy's avatar
Jim Blandy committed
257 258 259
    }
}

260 261 262 263 264 265 266

/* 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
267 268 269 270
   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.  */
271

Jim Blandy's avatar
Jim Blandy committed
272
static void
273
strout (const char *ptr, ptrdiff_t size, ptrdiff_t size_byte,
274
	Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
275
{
Karl Heuer's avatar
Karl Heuer committed
276
  if (size < 0)
277
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
278

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

302
      setup_echo_area_for_printing (multibyte_p);
303
      message_dolog (ptr, size_byte, 0, multibyte_p);
304

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

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

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

355
static void
356
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
357
{
358
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
359
    {
360
      ptrdiff_t chars;
361

362 363 364
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

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

378
	  chars = SBYTES (string);
379
	  bytes = count_size_as_multibyte (SDATA (string), chars);
380 381 382
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
383
	      memcpy (SDATA (newstr), SDATA (string), chars);
384
	      str_to_multibyte (SDATA (newstr), bytes, chars);
385 386 387
	      string = newstr;
	    }
	}
388
      else
389
	chars = SBYTES (string);
390

391 392 393
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
394
	  ptrdiff_t nbytes = SBYTES (string);
395 396 397 398

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

402
	  strout (buffer, chars, nbytes, printcharfun);
403 404 405 406 407

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

Jim Blandy's avatar
Jim Blandy committed
443
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
444
    printcharfun = Vstandard_output;
445
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
446
  PRINTPREPARE;
447
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
448
  PRINTFINISH;
449
  return character;
Jim Blandy's avatar
Jim Blandy committed
450 451
}

452 453
/* 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
454 455
   Do not use this on the contents of a Lisp string.  */

456
void
457
write_string (const char *data, int size)
Jim Blandy's avatar
Jim Blandy committed
458
{
459
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
460 461 462 463 464
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
465
  strout (data, size, size, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
466 467 468
  PRINTFINISH;
}

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

Andreas Schwab's avatar
Andreas Schwab committed
473
static void
474
write_string_1 (const char *data, int size, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
475
{
476
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
477 478

  PRINTPREPARE;
479
  strout (data, size, size, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
480 481 482 483 484
  PRINTFINISH;
}


void
485
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
486
{
487
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
488 489 490
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

491
  record_unwind_current_buffer ();
492

Jim Blandy's avatar
Jim Blandy committed
493 494
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

495
  Fkill_all_local_variables ();
496
  delete_all_overlays (current_buffer);
Paul Eggert's avatar
Paul Eggert committed
497 498 499 500
  bset_directory (current_buffer, BVAR (old, directory));
  bset_read_only (current_buffer, Qnil);
  bset_filename (current_buffer, Qnil);
  bset_undo_list (current_buffer, Qt);
501 502
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
Paul Eggert's avatar
Paul Eggert committed
503 504
  bset_enable_multibyte_characters
    (current_buffer, BVAR (&buffer_defaults, enable_multibyte_characters));
505 506
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
507
  Ferase_buffer ();
508
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
509

510
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
511 512 513 514

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
515 516
}

517 518 519 520
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
521

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

531
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
532
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
533 534
    printcharfun = Vstandard_output;
  PRINTPREPARE;
535 536 537 538 539 540 541 542 543 544 545 546

  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
547
  PRINTFINISH;
548
  return val;
Jim Blandy's avatar
Jim Blandy committed
549 550
}

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

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
574
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
575
{
576
  PRINTDECLARE;
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
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
582
  PRINTFINISH;
583
  return object;
Jim Blandy's avatar
Jim Blandy committed
584 585 586 587 588
}

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

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
600
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
601
{
602
  Lisp_Object printcharfun;
603
  bool prev_abort_on_gc;
604
  Lisp_Object save_deactivate_mark;
605
  ptrdiff_t count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
606
  struct buffer *previous;
607 608

  specbind (Qinhibit_modification_hooks, Qt);
609

Kenichi Handa's avatar
Kenichi Handa committed
610 611 612 613 614 615 616
  {
    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;
617 618
    prev_abort_on_gc = abort_on_gc;
    abort_on_gc = 1;
Kenichi Handa's avatar
Kenichi Handa committed
619 620 621 622

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

Kenichi Handa's avatar
Kenichi Handa committed
627
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
628
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
629
  object = Fbuffer_string ();
630 631
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
632

633
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
634 635
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
636
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
637
  set_buffer_internal (previous);
638

639
  Vdeactivate_mark = save_deactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
640

641
  abort_on_gc = prev_abort_on_gc;
642
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
643 644
}

645
DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
       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
667
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
668
{
669
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
670

Jim Blandy's avatar
Jim Blandy committed
671
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
672 673
    printcharfun = Vstandard_output;
  PRINTPREPARE;
674
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
675
  PRINTFINISH;
676
  return object;
Jim Blandy's avatar
Jim Blandy committed
677 678
}

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

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
702
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
703
{
704
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
705 706
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
707
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
708
    printcharfun = Vstandard_output;
709
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
710 711
  PRINTPREPARE;
  PRINTCHAR ('\n');
712
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
713 714 715
  PRINTCHAR ('\n');
  PRINTFINISH;
  UNGCPRO;
716
  return object;
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721 722
}

/* The subroutine object for external-debugging-output is kept here
   for the convenience of the debugger.  */
Lisp_Object Qexternal_debugging_output;

Jim Blandy's avatar
Jim Blandy committed
723
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
724 725 726
       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
727
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
728
{
729
  unsigned int ch;
730

731 732 733
  CHECK_NUMBER (character);
  ch = XINT (character);
  if (ASCII_CHAR_P (ch))
734
    {
735 736 737 738 739 740 741 742 743 744
      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
745
    }
746 747 748 749 750
  else
    {
      unsigned char mbstr[MAX_MULTIBYTE_LENGTH];
      ptrdiff_t len = CHAR_STRING (ch, mbstr);
      Lisp_Object encoded_ch =
751
	ENCODE_SYSTEM (make_multibyte_string ((char *) mbstr, 1, len));
752 753 754 755 756

      fwrite (SSDATA (encoded_ch), SBYTES (encoded_ch), 1, stderr);
#ifdef WINDOWSNT
      if (print_output_debug_flag)
	OutputDebugString (SSDATA (encoded_ch));
757
#endif
758
    }
759

Jim Blandy's avatar
Jim Blandy committed
760 761
  return character;
}
762

763 764 765
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

766
extern void debug_output_compilation_hack (bool) EXTERNALLY_VISIBLE;
767
void
768
debug_output_compilation_hack (bool x)
769 770 771
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
772

Andreas Schwab's avatar
Andreas Schwab committed
773
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
774 775 776 777 778 779

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

780
static FILE *initial_stderr_stream = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
781 782 783 784 785 786 787

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

  if (STRINGP (file))
    {
      file = Fexpand_file_name (file, Qnil);
      initial_stderr_stream = stderr;
804
      stderr = emacs_fopen (SSDATA (file), NILP (append) ? "w" : "a");
Kenichi Handa's avatar
Kenichi Handa committed
<