print.c 66.6 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
2
   Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5

This file is part of GNU Emacs.

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

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
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
18 19


20
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
21
#include <stdio.h>
22
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
23 24
#include "lisp.h"
#include "buffer.h"
25
#include "character.h"
Kenichi Handa's avatar
Kenichi Handa committed
26
#include "charset.h"
27
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
29 30 31 32
#include "window.h"
#include "process.h"
#include "dispextern.h"
#include "termchar.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
33
#include "intervals.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
34
#include "blockinput.h"
35
#include "termhooks.h"		/* For struct terminal.  */
Kenichi Handa's avatar
Kenichi Handa committed
36
#include "font.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
37

38
Lisp_Object Qstandard_output;
Jim Blandy's avatar
Jim Blandy committed
39

40 41
Lisp_Object Qtemp_buffer_setup_hook;

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

44
Lisp_Object Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
45 46 47 48 49 50

#include <math.h>

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

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

Jim Blandy's avatar
Jim Blandy committed
58 59 60
/* Avoid actual stack overflow in print.  */
int print_depth;

61 62
/* Level of nesting inside outputting backquote in new style.  */
int new_backquote_output;
63

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

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

/* Size allocated in print_buffer.  */
73
EMACS_INT print_buffer_size;
74
/* Chars stored in print_buffer.  */
75
EMACS_INT print_buffer_pos;
76
/* Bytes stored in print_buffer.  */
77
EMACS_INT print_buffer_pos_byte;
78

79 80 81
Lisp_Object Qprint_escape_newlines;
Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;

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

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

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

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

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
108 109
   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
110
   int specpdl_count = SPECPDL_INDEX ();				\
111 112
   int free_print_buffer = 0;						\
   int multibyte = !NILP (current_buffer->enable_multibyte_characters);	\
113 114
   Lisp_Object original

115 116 117 118 119 120 121 122 123 124 125
#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))						\
     {									\
126
       EMACS_INT marker_pos;						\
Andreas Schwab's avatar
Andreas Schwab committed
127
       if (! XMARKER (printcharfun)->buffer)				\
128
         error ("Marker does not point anywhere");			\
129 130 131 132 133
       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"); \
134 135
       old_point = PT;							\
       old_point_byte = PT_BYTE;					\
136
       SET_PT_BOTH (marker_pos,						\
137 138 139 140 141 142 143 144 145 146 147
		    marker_byte_position (printcharfun));		\
       start_point = PT;						\
       start_point_byte = PT_BYTE;					\
       printcharfun = Qnil;						\
     }									\
   if (NILP (printcharfun))						\
     {									\
       Lisp_Object string;						\
       if (NILP (current_buffer->enable_multibyte_characters)		\
	   && ! print_escape_multibyte)					\
         specbind (Qprint_escape_multibyte, Qt);			\
148 149 150
       if (! NILP (current_buffer->enable_multibyte_characters)		\
	   && ! print_escape_nonascii)					\
         specbind (Qprint_escape_nonascii, Qt);				\
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
       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;					\
     }									\
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 174 175 176 177 178 179 180 181 182 183 184 185
#define PRINTFINISH							\
   if (NILP (printcharfun))						\
     {									\
       if (print_buffer_pos != print_buffer_pos_byte			\
	   && NILP (current_buffer->enable_multibyte_characters))	\
	 {								\
	   unsigned char *temp						\
	     = (unsigned char *) alloca (print_buffer_pos + 1);		\
	   copy_text (print_buffer, temp, print_buffer_pos_byte,	\
		      1, 0);						\
	   insert_1_both (temp, print_buffer_pos,			\
			  print_buffer_pos, 0, 1, 0);			\
	 }								\
       else								\
	 insert_1_both (print_buffer, print_buffer_pos,			\
			print_buffer_pos_byte, 0, 1, 0);		\
186
       signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
187 188 189 190 191 192 193 194 195 196 197 198
     }									\
   if (free_print_buffer)						\
     {									\
       xfree (print_buffer);						\
       print_buffer = 0;						\
     }									\
   unbind_to (specpdl_count, Qnil);					\
   if (MARKERP (original))						\
     set_marker_both (original, Qnil, PT, PT_BYTE);			\
   if (old_point >= 0)							\
     SET_PT_BOTH (old_point + (old_point >= start_point			\
			       ? PT - start_point : 0),			\
199
		  old_point_byte + (old_point_byte >= start_point_byte	\
Andreas Schwab's avatar
Andreas Schwab committed
200
				    ? PT_BYTE - start_point_byte : 0));	\
201
   if (old != current_buffer)						\
202
     set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
203 204 205

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

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

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

216 217 218 219 220

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

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

232
      QUIT;
233

234
      if (NILP (fun))
235
	{
236 237 238
	  if (print_buffer_pos_byte + len >= print_buffer_size)
	    print_buffer = (char *) xrealloc (print_buffer,
					      print_buffer_size *= 2);
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 251
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
252

253
	  setup_echo_area_for_printing (multibyte_p);
254 255
	  insert_char (ch);
	  message_dolog (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 274
strout (const char *ptr, EMACS_INT size, EMACS_INT size_byte,
	Lisp_Object printcharfun, int multibyte)
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
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
282
	{
283
	  print_buffer_size = print_buffer_size * 2 + size_byte;
284 285 286
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
287
      memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
288
      print_buffer_pos += size;
289
      print_buffer_pos_byte += size_byte;
Jim Blandy's avatar
Jim Blandy committed
290
    }
291
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
292
    {
293 294 295 296 297 298 299 300 301 302 303
      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
	= !NILP (current_buffer->enable_multibyte_characters);
304

305
      setup_echo_area_for_printing (multibyte_p);
306
      message_dolog (ptr, size_byte, 0, multibyte_p);
307

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

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

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

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

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

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

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

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

	  strout (buffer, chars, SBYTES (string),
		  printcharfun, STRING_MULTIBYTE (string));

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

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

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

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

  printcharfun = Vstandard_output;

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

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

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

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


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

497 498
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

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

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

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

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
521 522 523
}

Lisp_Object
524
internal_with_output_to_temp_buffer (const char *bufname, Lisp_Object (*function) (Lisp_Object), Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
525
{
Juanma Barranquero's avatar
Juanma Barranquero committed
526
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
527
  Lisp_Object buf, val;
528
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
529

530
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
531 532 533
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
534
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
535 536 537

  val = (*function) (args);

538
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
539
  temp_output_buffer_show (buf);
540
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
541 542 543 544

  return unbind_to (count, val);
}

545 546
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
547
       1, UNEVALLED, 0,
548
       doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572

This construct makes buffer BUFNAME empty before running BODY.
It does not make the buffer current for BODY.
Instead it binds `standard-output' to that buffer, so that output
generated with `prin1' and similar functions in BODY goes into
the buffer.

At the end of BODY, this marks buffer BUFNAME unmodifed and displays
it in a window, but does not select it.  The normal way to do this is
by calling `display-buffer', then running `temp-buffer-show-hook'.
However, if `temp-buffer-show-function' is non-nil, it calls that
function instead (and does not run `temp-buffer-show-hook').  The
function gets one argument, the buffer to display.

The return value of `with-output-to-temp-buffer' is the value of the
last form in BODY.  If BODY does not finish normally, the buffer
BUFNAME is not displayed.

This runs the hook `temp-buffer-setup-hook' before BODY,
with the buffer BUFNAME temporarily current.  It runs the hook
`temp-buffer-show-hook' after displaying buffer BUFNAME, with that
buffer temporarily current, and the window that was used to display it
temporarily selected.  But it doesn't run `temp-buffer-show-hook'
if it uses `temp-buffer-show-function'.
573

574
usage: (with-output-to-temp-buffer BUFNAME BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
575
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
576 577 578
{
  struct gcpro gcpro1;
  Lisp_Object name;
Juanma Barranquero's avatar
Juanma Barranquero committed
579
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
580 581 582 583
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
584
  CHECK_STRING (name);
585
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
586
  buf = Vstandard_output;
587
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
588

589
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
590

591
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
592
  temp_output_buffer_show (buf);
593
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
594 595 596

  return unbind_to (count, val);
}
597

Jim Blandy's avatar
Jim Blandy committed
598

599 600 601 602
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
603 604

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
605 606
       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
607
  (Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
608
{
609
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
610

Jim Blandy's avatar
Jim Blandy committed
611
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
612 613 614 615 616 617 618 619
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
620 621
       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
622
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
623
is controlled by `print-level' and `print-length', which see.
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641

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
642
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
643
{
644
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
645

Jim Blandy's avatar
Jim Blandy committed
646
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
647 648
    printcharfun = Vstandard_output;
  PRINTPREPARE;
649
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
650
  PRINTFINISH;
651
  return object;
Jim Blandy's avatar
Jim Blandy committed
652 653 654 655 656 657
}

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

DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
658 659
       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
660
when necessary to make output that `read' can handle, whenever possible,
661 662
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
663 664 665 666 667

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
668
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
669
{
670
  Lisp_Object printcharfun;
671 672
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
673
  int count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
674
  struct buffer *previous;
675 676

  specbind (Qinhibit_modification_hooks, Qt);
677

Kenichi Handa's avatar
Kenichi Handa committed
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
  {
    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
694

Kenichi Handa's avatar
Kenichi Handa committed
695
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
696
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
697
  object = Fbuffer_string ();
698 699
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
700

701
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
702 703
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
704
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
705
  set_buffer_internal (previous);
706

707 708
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
709

710 711
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
712 713 714
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
       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
736
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
737
{
738
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
739

Jim Blandy's avatar
Jim Blandy committed
740
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
741 742
    printcharfun = Vstandard_output;
  PRINTPREPARE;
743
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
744
  PRINTFINISH;
745
  return object;
Jim Blandy's avatar
Jim Blandy committed
746 747 748
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
749 750
       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
751
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
752
is controlled by `print-level' and `print-length', which see.
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770

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
771
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
772
{
773
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
774 775
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
776
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
777
    printcharfun = Vstandard_output;
778
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
779 780
  PRINTPREPARE;
  PRINTCHAR ('\n');
781
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
782 783 784
  PRINTCHAR ('\n');
  PRINTFINISH;
  UNGCPRO;
785
  return object;
Jim Blandy's avatar
Jim Blandy committed
786 787 788 789 790 791
}

/* 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
792
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
793 794 795
       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
796
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
797
{
798
  CHECK_NUMBER (character);
799
  putc ((int) XINT (character), stderr);
800 801 802

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
803 804 805 806 807
  if (print_output_debug_flag)
    {
      char buf[2] = {(char) XINT (character), '\0'};
      OutputDebugString (buf);
    }
808 809
#endif

Jim Blandy's avatar
Jim Blandy committed
810 811
  return character;
}
812

813 814 815
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

816
void
817
debug_output_compilation_hack (int x)
818 819 820
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
821

Andreas Schwab's avatar
Andreas Schwab committed
822
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
823 824 825 826 827 828 829 830 831 832 833 834 835 836

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

FILE *initial_stderr_stream = NULL;

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
837
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
838
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
839 840
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
841 842 843 844 845
    {
      BLOCK_INPUT;
      fclose (stderr);
      UNBLOCK_INPUT;
    }
Kenichi Handa's avatar
Kenichi Handa committed
846 847 848 849 850 851 852
  stderr = initial_stderr_stream;
  initial_stderr_stream = NULL;

  if (STRINGP (file))
    {
      file = Fexpand_file_name (file, Qnil);
      initial_stderr_stream = stderr;
Andreas Schwab's avatar
Andreas Schwab committed
853
      stderr = fopen (SDATA (file), NILP (append) ? "w" : "a");
Kenichi Handa's avatar
Kenichi Handa committed
854 855 856 857 858 859 860 861 862 863 864 865 866
      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 */


867 868 869
/* This is the interface for debugging printing.  */

void
870
debug_print (Lisp_Object arg)
871 872
{
  Fprin1 (arg, Qexternal_debugging_output);
873
  fprintf (stderr, "\r\n");
874
}
875 876

void
877
safe_debug_print (Lisp_Object arg)
878 879 880 881 882 883 884 885
{
  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",
886
	     (unsigned long) XHASH (arg)
887 888 889
	     );
}

Jim Blandy's avatar
Jim Blandy committed
890