print.c 64 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-2011
  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 26
#include "lisp.h"
#include "buffer.h"
27
#include "character.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 50 51 52

#include <math.h>

#if STDC_HEADERS
#include <float.h>
#endif
Paul Eggert's avatar
Paul Eggert committed
53
#include <ftoastr.h>
Paul Eggert's avatar
Paul Eggert committed
54 55 56 57 58 59

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

Jim Blandy's avatar
Jim Blandy committed
60
/* Avoid actual stack overflow in print.  */
61
static int print_depth;
Jim Blandy's avatar
Jim Blandy committed
62

63
/* Level of nesting inside outputting backquote in new style.  */
64
static int new_backquote_output;
65

66 67
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
68
static Lisp_Object being_printed[PRINT_CIRCLE];
69

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

/* Size allocated in print_buffer.  */
75
static EMACS_INT print_buffer_size;
76
/* Chars stored in print_buffer.  */
77
static EMACS_INT print_buffer_pos;
78
/* Bytes stored in print_buffer.  */
79
static EMACS_INT print_buffer_pos_byte;
80

81
Lisp_Object Qprint_escape_newlines;
82
static Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
83

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

95
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
96
int print_output_debug_flag EXTERNALLY_VISIBLE = 1;
97

Jim Blandy's avatar
Jim Blandy committed
98

99
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
100 101

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

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

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

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

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

208 209
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
210

211
static Lisp_Object
212
print_unwind (Lisp_Object saved_text)
213
{
214
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
215
  return Qnil;
216 217
}

218 219 220 221 222

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

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

234
      QUIT;
235

236
      if (NILP (fun))
237
	{
238 239 240
	  if (print_buffer_pos_byte + len >= print_buffer_size)
	    print_buffer = (char *) xrealloc (print_buffer,
					      print_buffer_size *= 2);
241
	  memcpy (print_buffer + print_buffer_pos_byte, str, len);
242 243
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
244
	}
245
      else if (noninteractive)
246
	{
247 248
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
249
	}
250
      else
251
	{
252
	  int multibyte_p
Tom Tromey's avatar
Tom Tromey committed
253
	    = !NILP (BVAR (current_buffer, enable_multibyte_characters));
254

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

262 263 264 265 266 267 268

/* 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
269 270 271 272
   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.  */
273

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

281
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
282
    {
283
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
284
	{
285
	  print_buffer_size = print_buffer_size * 2 + size_byte;
286 287 288
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
289
      memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
290
      print_buffer_pos += size;
291
      print_buffer_pos_byte += size_byte;
Jim Blandy's avatar
Jim Blandy committed
292
    }
293
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
294
    {
295 296 297 298 299 300 301 302 303 304
      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
305
	= !NILP (BVAR (current_buffer, enable_multibyte_characters));
306

307
      setup_echo_area_for_printing (multibyte_p);
308
      message_dolog (ptr, size_byte, 0, multibyte_p);
309

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

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

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

360
static void
361
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
362
{
363
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
364
    {
365
      EMACS_INT chars;
366

367 368 369
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

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

383 384
	  chars = SBYTES (string);
	  bytes = parse_str_to_multibyte (SDATA (string), chars);
385 386 387
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
388
	      memcpy (SDATA (newstr), SDATA (string), chars);
389
	      str_to_multibyte (SDATA (newstr), bytes, chars);
390 391 392
	      string = newstr;
	    }
	}
393
      else
394
	chars = SBYTES (string);
395

396 397 398
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
399
	  EMACS_INT nbytes = SBYTES (string);
400 401 402 403 404 405 406
	  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);
407
	  memcpy (buffer, SDATA (string), nbytes);
408

409
	  strout (buffer, chars, SBYTES (string), printcharfun);
410 411 412 413 414

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

Jim Blandy's avatar
Jim Blandy committed
450
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
451
    printcharfun = Vstandard_output;
452
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
453
  PRINTPREPARE;
454
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
455
  PRINTFINISH;
456
  return character;
Jim Blandy's avatar
Jim Blandy committed
457 458
}

459 460
/* 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
461 462
   Do not use this on the contents of a Lisp string.  */

463
void
464
write_string (const char *data, int size)
Jim Blandy's avatar
Jim Blandy committed
465
{
466
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
467 468 469 470 471
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

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

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

Andreas Schwab's avatar
Andreas Schwab committed
480
static void
481
write_string_1 (const char *data, int size, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
482
{
483
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
484 485

  PRINTPREPARE;
486
  strout (data, size, size, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
487 488 489 490 491
  PRINTFINISH;
}


void
492
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
493
{
Juanma Barranquero's avatar
Juanma Barranquero committed
494
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
495 496 497
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

498 499
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
500 501
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

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

517
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
518 519 520 521

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
522 523
}

524 525 526 527
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
528

529
DEFUE ("terpri", Fterpri, Sterpri, 0, 1, 0,
530 531
       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
532
  (Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
533
{
534
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
535

Jim Blandy's avatar
Jim Blandy committed
536
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
537 538 539 540 541 542 543
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

544
DEFUE ("prin1", Fprin1, Sprin1, 1, 2, 0,
545 546
       doc: /* Output the printed representation of OBJECT, any Lisp object.
Quoting characters are printed when needed to make output that `read'
Eli Zaretskii's avatar
Eli Zaretskii committed
547
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
548
is controlled by `print-level' and `print-length', which see.
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.

Optional argument PRINTCHARFUN is the output stream, which can be one
of these:

   - a buffer, in which case output is inserted into that buffer at point;
   - a marker, in which case output is inserted at marker's position;
   - a function, in which case that function is called once for each
     character of OBJECT's printed representation;
   - a symbol, in which case that symbol's function definition is called; or
   - t, in which case the output is displayed in the echo area.

If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
is used instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
567
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
568
{
569
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
570

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

/* a buffer which is used to hold output being built by prin1-to-string */
Lisp_Object Vprin1_to_string_buffer;

582
DEFUE ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
583 584
       doc: /* Return a string containing the printed representation of OBJECT.
OBJECT can be any Lisp object.  This function outputs quoting characters
Pavel Janík's avatar
Pavel Janík committed
585
when necessary to make output that `read' can handle, whenever possible,
586 587
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
588 589 590 591 592

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
593
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
594
{
595
  Lisp_Object printcharfun;
596 597
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
598
  int count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
599
  struct buffer *previous;
600 601

  specbind (Qinhibit_modification_hooks, Qt);
602

Kenichi Handa's avatar
Kenichi Handa committed
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
  {
    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));
    /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
    PRINTFINISH;
  }
Jim Blandy's avatar
Jim Blandy committed
619

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

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

632 633
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
634

635 636
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
637 638
}

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

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

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

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

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

/* 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
717
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
718 719 720
       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
721
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
722
{
723
  CHECK_NUMBER (character);
724
  putc ((int) XINT (character), stderr);
725 726 727

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

Jim Blandy's avatar
Jim Blandy committed
735 736
  return character;
}
737

738 739 740
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

741
void
742
debug_output_compilation_hack (int x)
743 744 745
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
746

Andreas Schwab's avatar
Andreas Schwab committed
747
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
748 749 750 751 752 753

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

754
static FILE *initial_stderr_stream = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
755 756 757 758 759 760 761

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

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


792 793 794
/* This is the interface for debugging printing.  */

void
795
debug_print (Lisp_Object arg)
796 797
{
  Fprin1 (arg, Qexternal_debugging_output);
798
  fprintf (stderr, "\r\n");
799
}
800 801

void
802
safe_debug_print (Lisp_Object arg)
803 804 805 806 807 808 809 810
{
  int valid = valid_lisp_object_p (arg);

  if (valid > 0)
    debug_print (arg);
  else
    fprintf (stderr, "#<%s_LISP_OBJECT 0x%08lx>\r\n",
	     !valid ? "INVALID" : "SOME",
811
	     (unsigned long) XHASH (arg)
812 813 814
	     );
}

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

827 828 829
  /* 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.  */
830 831 832 833 834
  if (CONSP (obj) && EQ (XCAR (obj), Qerror)
      && CONSP (XCDR (obj))
      && STRINGP (XCAR (XCDR (obj)))
      && NILP (XCDR (XCDR (obj))))
    return XCAR (XCDR (obj));
835

836
  print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
837 838 839 840 841 842 843 844 845 846 847 848

  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
  value = Fbuffer_string ();

  GCPRO1 (value);
  Ferase_buffer ();
  set_buffer_internal (old);
  UNGCPRO;

  return value;
}

849
/* Print an error message for the error DATA onto Lisp output stream
Richard M. Stallman's avatar
Richard M. Stallman committed
850 851 852
   STREAM (suitable for the print functions).
   CONTEXT is a C string describing the context of the error.
   CALLER is the Lisp function inside which the error was signaled.  */
853