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

3
Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2012
4
  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
#include <setjmp.h>
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 49

#include <math.h>
#include <float.h>
Paul Eggert's avatar
Paul Eggert committed
50
#include <ftoastr.h>
Paul Eggert's avatar
Paul Eggert committed
51 52 53 54 55 56

/* Default to values appropriate for IEEE floating point.  */
#ifndef DBL_DIG
#define DBL_DIG 15
#endif

Jim Blandy's avatar
Jim Blandy committed
57
/* Avoid actual stack overflow in print.  */
58
static ptrdiff_t print_depth;
Jim Blandy's avatar
Jim Blandy committed
59

60
/* Level of nesting inside outputting backquote in new style.  */
61
static ptrdiff_t new_backquote_output;
62

63 64
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
65
static Lisp_Object being_printed[PRINT_CIRCLE];
66

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

/* Size allocated in print_buffer.  */
72
static ptrdiff_t print_buffer_size;
73
/* Chars stored in print_buffer.  */
74
static ptrdiff_t print_buffer_pos;
75
/* Bytes stored in print_buffer.  */
76
static ptrdiff_t print_buffer_pos_byte;
77

78
Lisp_Object Qprint_escape_newlines;
79
static Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
80

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

92
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
93
int print_output_debug_flag EXTERNALLY_VISIBLE = 1;
94

Jim Blandy's avatar
Jim Blandy committed
95

96
/* Low level output routines for characters and strings.  */
Jim Blandy's avatar
Jim Blandy committed
97 98

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

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
107 108 109
   ptrdiff_t old_point = -1, start_point = -1;				\
   ptrdiff_t old_point_byte = -1, start_point_byte = -1;		\
   ptrdiff_t specpdl_count = SPECPDL_INDEX ();				\
110
   int free_print_buffer = 0;						\
Tom Tromey's avatar
Tom Tromey committed
111
   int multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));	\
112 113
   Lisp_Object original

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

170 171 172 173
#define PRINTFINISH							\
   if (NILP (printcharfun))						\
     {									\
       if (print_buffer_pos != print_buffer_pos_byte			\
Tom Tromey's avatar
Tom Tromey committed
174
	   && NILP (BVAR (current_buffer, enable_multibyte_characters)))	\
175
	 {								\
176
	   unsigned char *temp = 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 181 182 183 184
			  print_buffer_pos, 0, 1, 0);			\
	 }								\
       else								\
	 insert_1_both (print_buffer, print_buffer_pos,			\
			print_buffer_pos_byte, 0, 1, 0);		\
185
       signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
186 187 188 189 190 191 192 193 194 195 196 197
     }									\
   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),			\
198
		  old_point_byte + (old_point_byte >= start_point_byte	\
Andreas Schwab's avatar
Andreas Schwab committed
199
				    ? PT_BYTE - start_point_byte : 0));	\
200
   if (old != current_buffer)						\
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 Lisp_Object
209
print_unwind (Lisp_Object saved_text)
210
{
211
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
212
  return Qnil;
213 214
}

215 216 217 218 219

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

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

231
      QUIT;
232

233
      if (NILP (fun))
234
	{
235 236 237 238
	  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);
239
	  memcpy (print_buffer + print_buffer_pos_byte, str, len);
240 241
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
242
	}
243
      else if (noninteractive)
244
	{
245 246
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
247
	}
248
      else
249
	{
250
	  int 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 282 283
      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);
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 299
      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
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 399 400 401
	  char *buffer;

	  /* Copy the string contents so that relocation of STRING by
	     GC does not cause trouble.  */
	  USE_SAFE_ALLOCA;

	  SAFE_ALLOCA (buffer, char *, nbytes);
402
	  memcpy (buffer, SDATA (string), nbytes);
403

404
	  strout (buffer, chars, SBYTES (string), printcharfun);
405 406 407 408 409

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

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

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

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

  printcharfun = Vstandard_output;

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

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

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

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


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

493 494
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
495 496
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

497
  Fkill_all_local_variables ();
498
  delete_all_overlays (current_buffer);
Tom Tromey's avatar
Tom Tromey committed
499 500 501 502
  BVAR (current_buffer, directory) = BVAR (old, directory);
  BVAR (current_buffer, read_only) = Qnil;
  BVAR (current_buffer, filename) = Qnil;
  BVAR (current_buffer, undo_list) = Qt;
503 504
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
Tom Tromey's avatar
Tom Tromey committed
505 506
  BVAR (current_buffer, enable_multibyte_characters)
    = BVAR (&buffer_defaults, enable_multibyte_characters);
507 508
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
509
  Ferase_buffer ();
510
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
511

512
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
513 514 515 516

  unbind_to (count, Qnil);

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

Paul Eggert's avatar
Paul Eggert committed
524
DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
525 526
       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
527
  (Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
528
{
529
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
530

Jim Blandy's avatar
Jim Blandy committed
531
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

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

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
562
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
563
{
564
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
565

Jim Blandy's avatar
Jim Blandy committed
566
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
567 568
    printcharfun = Vstandard_output;
  PRINTPREPARE;
569
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
570
  PRINTFINISH;
571
  return object;
Jim Blandy's avatar
Jim Blandy committed
572 573 574 575 576
}

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

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
588
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
589
{
590
  Lisp_Object printcharfun;
591 592
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
593
  ptrdiff_t count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
594
  struct buffer *previous;
595 596

  specbind (Qinhibit_modification_hooks, Qt);
597

Kenichi Handa's avatar
Kenichi Handa committed
598 599 600 601 602 603 604 605 606 607 608 609 610
  {
    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); */
    abort_on_gc++;

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

Kenichi Handa's avatar
Kenichi Handa committed
615
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
616
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
617
  object = Fbuffer_string ();
618 619
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
620

621
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
622 623
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
624
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
625
  set_buffer_internal (previous);
626

627 628
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
629

630 631
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
632 633
}

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

Jim Blandy's avatar
Jim Blandy committed
660
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
661 662
    printcharfun = Vstandard_output;
  PRINTPREPARE;
663
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
664
  PRINTFINISH;
665
  return object;
Jim Blandy's avatar
Jim Blandy committed
666 667
}

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

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
691
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
692
{
693
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
694 695
  struct gcpro gcpro1;

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

/* 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
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 719
  CHECK_NUMBER (character);
  putc (XINT (character) & 0xFF, stderr);
720 721 722

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
723 724 725 726 727
  if (print_output_debug_flag)
    {
      char buf[2] = {(char) XINT (character), '\0'};
      OutputDebugString (buf);
    }
728 729
#endif

Jim Blandy's avatar
Jim Blandy committed
730 731
  return character;
}
732

733 734 735
/* 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
736
extern void debug_output_compilation_hack (int) EXTERNALLY_VISIBLE;
737
void
738
debug_output_compilation_hack (int x)
739 740 741
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
742

Andreas Schwab's avatar
Andreas Schwab committed
743
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
744 745 746 747 748 749

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

750
static FILE *initial_stderr_stream = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
751 752 753 754 755 756 757

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
758
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
759
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
760 761
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
762 763 764 765 766
    {
      BLOCK_INPUT;
      fclose (stderr);
      UNBLOCK_INPUT;
    }
Kenichi Handa's avatar
Kenichi Handa committed
767 768 769 770 771 772 773
  stderr = initial_stderr_stream;
  initial_stderr_stream = NULL;

  if (STRINGP (file))
    {
      file = Fexpand_file_name (file, Qnil);
      initial_stderr_stream = stderr;
774
      stderr = fopen (SSDATA (file), NILP (append) ? "w" : "a");
Kenichi Handa's avatar
Kenichi Handa committed
775 776 777 778 779 780 781 782 783 784 785 786 787
      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 */


788 789 790
/* This is the interface for debugging printing.  */

void
791
debug_print (Lisp_Object arg)
792 793
{
  Fprin1 (arg, Qexternal_debugging_output);
794
  fprintf (stderr, "\r\n");
795
}
796

797
void safe_debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
798
void
799
safe_debug_print (Lisp_Object arg)
800 801 802 803 804 805
{
  int valid = valid_lisp_object_p (arg);

  if (valid > 0)
    debug_print (arg);
  else
806
    fprintf (stderr, "#<%s_LISP_OBJECT 0x%08"pI"x>\r\n",
807
	     !valid ? "INVALID" : "SOME",
808
	     XHASH (arg));
809 810
}

Jim Blandy's avatar
Jim Blandy committed
811

Paul Eggert's avatar
Paul Eggert committed
812
DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
813
       1, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
814 815 816
       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
817
  (Lisp_Object obj)
818 819
{
  struct buffer *old = current_buffer;
820
  Lisp_Object value;
821 822
  struct gcpro gcpro1;

823 824 825
  /* If OBJ is (error STRING), just return STRING.
     That is not only faster, it also avoids the need to allocate
     space here when the error is due to memory full.  */
826 827 828 829 830
  if (CONSP (obj) && EQ (XCAR (obj), Qerror)
      && CONSP (XCDR (obj))
      && STRINGP (XCAR (XCDR (obj)))
      && NILP (XCDR (XCDR (obj))))
    return XCAR (XCDR (obj));