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

3 4
Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2013 Free Software
Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23
#include <stdio.h>
24

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
/* When printing into a buffer, first we put the text in this
   block, then insert it all at once.  */
63
static char *print_buffer;
64 65

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

72
Lisp_Object Qprint_escape_newlines;
73
static Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
74

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

86
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
87
int print_output_debug_flag EXTERNALLY_VISIBLE = 1;
88

Jim Blandy's avatar
Jim Blandy committed
89

90
/* Low level output routines for characters and strings.  */
Jim Blandy's avatar
Jim Blandy committed
91 92

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

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

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

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

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

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

202
static Lisp_Object
203
print_unwind (Lisp_Object saved_text)
204
{
205
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
206
  return Qnil;
207 208
}

209 210 211 212 213

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

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

225
      QUIT;
226

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

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

254 255 256 257 258 259 260

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

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

273
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
274
    {
275 276 277
      ptrdiff_t incr = size_byte - (print_buffer_size - print_buffer_pos_byte);
      if (0 < incr)
	print_buffer = xpalloc (print_buffer, &print_buffer_size, incr, -1, 1);
278
      memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
279
      print_buffer_pos += size;
280
      print_buffer_pos_byte += size_byte;
Jim Blandy's avatar
Jim Blandy committed
281
    }
282
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
283
    {
284 285 286 287 288 289 290 291 292 293
      fwrite (ptr, 1, size_byte, stdout);
      noninteractive_need_newline = 1;
    }
  else if (EQ (printcharfun, Qt))
    {
      /* Output to echo area.  We're trying to avoid a little overhead
	 here, that's the reason we don't call printchar to do the
	 job.  */
      int i;
      int multibyte_p
Tom Tromey's avatar
Tom Tromey committed
294
	= !NILP (BVAR (current_buffer, enable_multibyte_characters));
295

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  printcharfun = Vstandard_output;

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

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

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

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


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

485
  record_unwind_current_buffer ();
486

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

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

504
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
505 506 507 508

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
509 510
}

511 512 513 514
static void print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
static void print_preprocess (Lisp_Object obj);
static void print_preprocess_string (INTERVAL interval, Lisp_Object arg);
static void print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
Jim Blandy's avatar
Jim Blandy committed
515

Paul Eggert's avatar
Paul Eggert committed
516
DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
517 518
       doc: /* Output a newline to stream PRINTCHARFUN.
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
519
  (Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
520
{
521
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
522

Jim Blandy's avatar
Jim Blandy committed
523
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
524 525 526 527 528 529 530
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

Paul Eggert's avatar
Paul Eggert committed
531
DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
532 533
       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
534
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
535
is controlled by `print-level' and `print-length', which see.
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553

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
554
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
555
{
556
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
557

Jim Blandy's avatar
Jim Blandy committed
558
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
559 560
    printcharfun = Vstandard_output;
  PRINTPREPARE;
561
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
562
  PRINTFINISH;
563
  return object;
Jim Blandy's avatar
Jim Blandy committed
564 565 566 567 568
}

/* 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
569
DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
570 571
       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
572
when necessary to make output that `read' can handle, whenever possible,
573 574
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
575 576 577 578 579

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
580
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
581
{
582
  Lisp_Object printcharfun;
583
  bool prev_abort_on_gc;
584 585
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
586
  ptrdiff_t count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
587
  struct buffer *previous;
588 589

  specbind (Qinhibit_modification_hooks, Qt);
590

Kenichi Handa's avatar
Kenichi Handa committed
591 592 593 594 595 596 597 598
  {
    PRINTDECLARE;

    /* Save and restore this--we are altering a buffer
       but we don't want to deactivate the mark just for that.
       No need for specbind, since errors deactivate the mark.  */
    save_deactivate_mark = Vdeactivate_mark;
    /* GCPRO2 (object, save_deactivate_mark); */
599 600
    prev_abort_on_gc = abort_on_gc;
    abort_on_gc = 1;
Kenichi Handa's avatar
Kenichi Handa committed
601 602 603 604

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

Kenichi Handa's avatar
Kenichi Handa committed
609
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
610
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
611
  object = Fbuffer_string ();
612 613
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
614

615
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
616 617
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
618
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
619
  set_buffer_internal (previous);
620

621 622
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
623

624
  abort_on_gc = prev_abort_on_gc;
625
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
626 627
}

628
DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
       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
650
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
651
{
652
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
653

Jim Blandy's avatar
Jim Blandy committed
654
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
655 656
    printcharfun = Vstandard_output;
  PRINTPREPARE;
657
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
658
  PRINTFINISH;
659
  return object;
Jim Blandy's avatar
Jim Blandy committed
660 661
}

Paul Eggert's avatar
Paul Eggert committed
662
DEFUN ("print", Fprint, Sprint, 1, 2, 0,
663 664
       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
665
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
666
is controlled by `print-level' and `print-length', which see.
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684

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
685
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
686
{
687
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
688 689
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
690
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
691
    printcharfun = Vstandard_output;
692
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
693 694
  PRINTPREPARE;
  PRINTCHAR ('\n');
695
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
696 697 698
  PRINTCHAR ('\n');
  PRINTFINISH;
  UNGCPRO;
699
  return object;
Jim Blandy's avatar
Jim Blandy committed
700 701 702 703 704 705
}

/* 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
706
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
707 708 709
       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
710
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
711
{
712 713
  CHECK_NUMBER (character);
  putc (XINT (character) & 0xFF, stderr);
714 715 716

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
717 718 719 720 721
  if (print_output_debug_flag)
    {
      char buf[2] = {(char) XINT (character), '\0'};
      OutputDebugString (buf);
    }
722 723
#endif

Jim Blandy's avatar
Jim Blandy committed
724 725
  return character;
}
726

727 728 729
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

Paul Eggert's avatar
Paul Eggert committed
730
extern void debug_output_compilation_hack (int) EXTERNALLY_VISIBLE;
731
void
732
debug_output_compilation_hack (int x)
733 734 735
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
736

Andreas Schwab's avatar
Andreas Schwab committed
737
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
738 739 740 741 742 743

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

744
static FILE *initial_stderr_stream = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
745 746 747 748 749 750 751

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
752
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
753
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
754 755
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
756
    {
757
      block_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
758
      fclose (stderr);
759
      unblock_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
760
    }
Kenichi Handa's avatar
Kenichi Handa committed
761 762 763 764 765 766 767
  stderr = initial_stderr_stream;
  initial_stderr_stream = NULL;

  if (STRINGP (file))
    {
      file = Fexpand_file_name (file, Qnil);
      initial_stderr_stream = stderr;
768
      stderr = fopen (SSDATA (file), NILP (append) ? "w" : "a");
Kenichi Handa's avatar
Kenichi Handa committed
769 770 771 772 773 774 775 776 777 778 779 780 781
      if (stderr == NULL)
	{
	  stderr = initial_stderr_stream;
	  initial_stderr_stream = NULL;
	  report_file_error ("Cannot open debugging output stream",
			     Fcons (file, Qnil));
	}
    }
  return Qnil;
}
#endif /* GNU_LINUX */


782 783 784
/* This is the interface for debugging printing.  */

void
785
debug_print (Lisp_Object arg)
786 787
{
  Fprin1 (arg, Qexternal_debugging_output);
788
  fprintf (stderr, "\r\n");
789
}
790

791
void safe_debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
792
void
793
safe_debug_print (Lisp_Object arg)
794 795 796 797 798 799
{
  int valid = valid_lisp_object_p (arg);

  if (valid > 0)
    debug_print (arg);
  else
800
    fprintf (stderr, "#<%s_LISP_OBJECT 0x%08"pI"x>\r\n",
801
	     !valid ? "INVALID" : "SOME",
802
	     XLI (arg));
803 804
}

Jim Blandy's avatar
Jim Blandy committed
805

Paul Eggert's avatar
Paul Eggert committed
806
DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
807
       1, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
808 809 810
       doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
See Info anchor `(elisp)Definition of signal' for some details on how this
error message is constructed.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
811
  (Lisp_Object obj)
812 813
{
  struct buffer *old = current_buffer;
814
  Lisp_Object value;
815