print.c 69.1 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, 1994, 1995, 1997,
                 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007, 2008, 2009, 2010 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

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

42 43
Lisp_Object Qtemp_buffer_setup_hook;

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

Jim Blandy's avatar
Jim Blandy committed
46
Lisp_Object Vfloat_output_format, Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

#include <math.h>

#if STDC_HEADERS
#include <float.h>
#endif

/* Default to values appropriate for IEEE floating point.  */
#ifndef FLT_RADIX
#define FLT_RADIX 2
#endif
#ifndef DBL_MANT_DIG
#define DBL_MANT_DIG 53
#endif
#ifndef DBL_DIG
#define DBL_DIG 15
#endif
64 65 66 67 68 69 70 71
#ifndef DBL_MIN
#define DBL_MIN 2.2250738585072014e-308
#endif

#ifdef DBL_MIN_REPLACEMENT
#undef DBL_MIN
#define DBL_MIN DBL_MIN_REPLACEMENT
#endif
Paul Eggert's avatar
Paul Eggert committed
72 73 74 75 76 77 78 79 80 81 82 83

/* Define DOUBLE_DIGITS_BOUND, an upper bound on the number of decimal digits
   needed to express a float without losing information.
   The general-case formula is valid for the usual case, IEEE floating point,
   but many compilers can't optimize the formula to an integer constant,
   so make a special case for it.  */
#if FLT_RADIX == 2 && DBL_MANT_DIG == 53
#define DOUBLE_DIGITS_BOUND 17 /* IEEE floating point */
#else
#define DOUBLE_DIGITS_BOUND ((int) ceil (log10 (pow (FLT_RADIX, DBL_MANT_DIG))))
#endif

Jim Blandy's avatar
Jim Blandy committed
84 85 86
/* Avoid actual stack overflow in print.  */
int print_depth;

87 88
/* Level of nesting inside outputting backquote in new style.  */
int new_backquote_output;
89

90 91 92 93
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
Lisp_Object being_printed[PRINT_CIRCLE];

94 95 96 97 98
/* 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.  */
99
EMACS_INT print_buffer_size;
100
/* Chars stored in print_buffer.  */
101
EMACS_INT print_buffer_pos;
102
/* Bytes stored in print_buffer.  */
103
EMACS_INT print_buffer_pos_byte;
104

Jim Blandy's avatar
Jim Blandy committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118
/* Maximum length of list to print in full; noninteger means
   effectively infinity */

Lisp_Object Vprint_length;

/* Maximum depth of list to print in full; noninteger means
   effectively infinity.  */

Lisp_Object Vprint_level;

/* Nonzero means print newlines in strings as \n.  */

int print_escape_newlines;

119 120 121 122 123
/* Nonzero means to print single-byte non-ascii characters in strings as
   octal escapes.  */

int print_escape_nonascii;

124 125 126 127 128 129 130
/* Nonzero means to print multibyte characters in strings as hex escapes.  */

int print_escape_multibyte;

Lisp_Object Qprint_escape_newlines;
Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;

Erik Naggum's avatar
Erik Naggum committed
131 132 133 134
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

135
/* Non-nil means print #: before uninterned symbols.  */
136

137
Lisp_Object Vprint_gensym;
138

139
/* Non-nil means print recursive structures using #n= and #n# syntax.  */
140

141 142 143 144 145 146 147
Lisp_Object Vprint_circle;

/* Non-nil means keep continuous number for #n= and #n# syntax
   between several print functions.  */

Lisp_Object Vprint_continuous_numbering;

148 149 150 151 152 153 154 155
/* 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.  */
156 157 158
int print_number_index;
Lisp_Object Vprint_number_table;

159
void print_interval (INTERVAL interval, Lisp_Object printcharfun);
Jim Blandy's avatar
Jim Blandy committed
160

161
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
162
int print_output_debug_flag EXTERNALLY_VISIBLE = 1;
163

Jim Blandy's avatar
Jim Blandy committed
164

165
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
166 167

/* Lisp functions to do output using a stream
168 169 170 171
   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,
172
   or call strout to output a block of characters. */
173 174 175

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
176 177
   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
178
   int specpdl_count = SPECPDL_INDEX ();				\
179 180
   int free_print_buffer = 0;						\
   int multibyte = !NILP (current_buffer->enable_multibyte_characters);	\
181 182
   Lisp_Object original

183 184 185 186 187 188 189 190 191 192 193
#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))						\
     {									\
194
       EMACS_INT marker_pos;						\
Andreas Schwab's avatar
Andreas Schwab committed
195
       if (! XMARKER (printcharfun)->buffer)				\
196
         error ("Marker does not point anywhere");			\
197 198 199 200 201
       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"); \
202 203
       old_point = PT;							\
       old_point_byte = PT_BYTE;					\
204
       SET_PT_BOTH (marker_pos,						\
205 206 207 208 209 210 211 212 213 214 215
		    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);			\
216 217 218
       if (! NILP (current_buffer->enable_multibyte_characters)		\
	   && ! print_escape_nonascii)					\
         specbind (Qprint_escape_nonascii, Qt);				\
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
       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;					\
     }									\
235
   if (EQ (printcharfun, Qt) && ! noninteractive)			\
236
     setup_echo_area_for_printing (multibyte);
Jim Blandy's avatar
Jim Blandy committed
237

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
#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);		\
254
       signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
255 256 257 258 259 260 261 262 263 264 265 266
     }									\
   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),			\
267
		  old_point_byte + (old_point_byte >= start_point_byte	\
Andreas Schwab's avatar
Andreas Schwab committed
268
				    ? PT_BYTE - start_point_byte : 0));	\
269
   if (old != current_buffer)						\
270
     set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
271 272 273

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

274 275
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
276

277
static Lisp_Object
278
print_unwind (Lisp_Object saved_text)
279
{
280
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
281
  return Qnil;
282 283
}

284 285 286 287 288

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

static void
291
printchar (unsigned int ch, Lisp_Object fun)
Jim Blandy's avatar
Jim Blandy committed
292
{
293 294 295
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
296
    {
297 298 299
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

300
      QUIT;
301

302
      if (NILP (fun))
303
	{
304 305 306
	  if (print_buffer_pos_byte + len >= print_buffer_size)
	    print_buffer = (char *) xrealloc (print_buffer,
					      print_buffer_size *= 2);
307
	  memcpy (print_buffer + print_buffer_pos_byte, str, len);
308 309
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
310
	}
311
      else if (noninteractive)
312
	{
313 314
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
315
	}
316
      else
317
	{
318 319
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
320

321
	  setup_echo_area_for_printing (multibyte_p);
322 323
	  insert_char (ch);
	  message_dolog (str, len, 0, multibyte_p);
324
	}
Jim Blandy's avatar
Jim Blandy committed
325 326 327
    }
}

328 329 330 331 332 333 334

/* 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
335 336 337 338
   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.  */
339

Jim Blandy's avatar
Jim Blandy committed
340
static void
341 342
strout (const char *ptr, EMACS_INT size, EMACS_INT size_byte,
	Lisp_Object printcharfun, int multibyte)
Jim Blandy's avatar
Jim Blandy committed
343
{
Karl Heuer's avatar
Karl Heuer committed
344
  if (size < 0)
345
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
346

347
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
348
    {
349
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
350
	{
351
	  print_buffer_size = print_buffer_size * 2 + size_byte;
352 353 354
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
355
      memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
356
      print_buffer_pos += size;
357
      print_buffer_pos_byte += size_byte;
Jim Blandy's avatar
Jim Blandy committed
358
    }
359
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
360
    {
361 362 363 364 365 366 367 368 369 370 371
      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);
372

373
      setup_echo_area_for_printing (multibyte_p);
374
      message_dolog (ptr, size_byte, 0, multibyte_p);
375

376
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
377
	{
378
	  for (i = 0; i < size; ++i)
Andreas Schwab's avatar
Andreas Schwab committed
379
	    insert_char ((unsigned char) *ptr++);
Jim Blandy's avatar
Jim Blandy committed
380
	}
381
      else
Jim Blandy's avatar
Jim Blandy committed
382
	{
383 384
	  int len;
	  for (i = 0; i < size_byte; i += len)
385
	    {
386
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, len);
387
	      insert_char (ch);
388
	    }
Jim Blandy's avatar
Jim Blandy committed
389
	}
390 391 392 393
    }
  else
    {
      /* PRINTCHARFUN is a Lisp function.  */
394
      EMACS_INT i = 0;
Jim Blandy's avatar
Jim Blandy committed
395

396
      if (size == size_byte)
397
	{
398
	  while (i < size_byte)
399
	    {
400 401
	      int ch = ptr[i++];
	      PRINTCHAR (ch);
402 403
	    }
	}
404
      else
Karl Heuer's avatar
Karl Heuer committed
405
	{
406 407 408 409 410 411
	  while (i < size_byte)
	    {
	      /* Here, we must convert each multi-byte form to the
		 corresponding character code before handing it to
		 PRINTCHAR.  */
	      int len;
412
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, len);
413 414 415
	      PRINTCHAR (ch);
	      i += len;
	    }
Karl Heuer's avatar
Karl Heuer committed
416
	}
Jim Blandy's avatar
Jim Blandy committed
417 418 419 420
    }
}

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

424
static void
425
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
426
{
427
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
428
    {
429
      EMACS_INT chars;
430

431 432 433
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

434
      if (STRING_MULTIBYTE (string))
435
	chars = SCHARS (string);
436 437 438 439
      else if (! print_escape_nonascii
	       && (EQ (printcharfun, Qt)
		   ? ! NILP (buffer_defaults.enable_multibyte_characters)
		   : ! NILP (current_buffer->enable_multibyte_characters)))
440 441 442 443 444
	{
	  /* If unibyte string STRING contains 8-bit codes, we must
	     convert STRING to a multibyte string containing the same
	     character codes.  */
	  Lisp_Object newstr;
445
	  EMACS_INT bytes;
446

447 448
	  chars = SBYTES (string);
	  bytes = parse_str_to_multibyte (SDATA (string), chars);
449 450 451
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
452
	      memcpy (SDATA (newstr), SDATA (string), chars);
453
	      str_to_multibyte (SDATA (newstr), bytes, chars);
454 455 456
	      string = newstr;
	    }
	}
457
      else
458
	chars = SBYTES (string);
459

460 461 462
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
463
	  EMACS_INT nbytes = SBYTES (string);
464 465 466 467 468 469 470
	  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);
471
	  memcpy (buffer, SDATA (string), nbytes);
472 473 474 475 476 477 478 479 480 481 482

	  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));
483
    }
Jim Blandy's avatar
Jim Blandy committed
484 485
  else
    {
486 487
      /* Otherwise, string may be relocated by printing one char.
	 So re-fetch the string address for each character.  */
488
      EMACS_INT i;
489 490
      EMACS_INT size = SCHARS (string);
      EMACS_INT size_byte = SBYTES (string);
Jim Blandy's avatar
Jim Blandy committed
491 492
      struct gcpro gcpro1;
      GCPRO1 (string);
493 494
      if (size == size_byte)
	for (i = 0; i < size; i++)
495
	  PRINTCHAR (SREF (string, i));
496
      else
Kenichi Handa's avatar
Kenichi Handa committed
497
	for (i = 0; i < size_byte; )
498 499 500 501
	  {
	    /* Here, we must convert each multi-byte form to the
	       corresponding character code before handing it to PRINTCHAR.  */
	    int len;
502
	    int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i, len);
503 504 505
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
506 507 508 509 510
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
511 512
       doc: /* Output character CHARACTER to stream PRINTCHARFUN.
PRINTCHARFUN defaults to the value of `standard-output' (which see).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
513
  (Lisp_Object character, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
514
{
515
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
516

Jim Blandy's avatar
Jim Blandy committed
517
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
518
    printcharfun = Vstandard_output;
519
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
520
  PRINTPREPARE;
521
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
522
  PRINTFINISH;
523
  return character;
Jim Blandy's avatar
Jim Blandy committed
524 525
}

526 527
/* 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
528 529
   Do not use this on the contents of a Lisp string.  */

530
void
531
write_string (const char *data, int size)
Jim Blandy's avatar
Jim Blandy committed
532
{
533
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
534 535 536 537 538
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
539
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
540 541 542
  PRINTFINISH;
}

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

Andreas Schwab's avatar
Andreas Schwab committed
547
static void
548
write_string_1 (const char *data, int size, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
549
{
550
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
551 552

  PRINTPREPARE;
553
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
554 555 556 557 558
  PRINTFINISH;
}


void
559
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
560
{
Juanma Barranquero's avatar
Juanma Barranquero committed
561
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
562 563 564
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

565 566
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
567 568
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

569
  Fkill_all_local_variables ();
570
  delete_all_overlays (current_buffer);
571
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
572
  current_buffer->read_only = Qnil;
573 574
  current_buffer->filename = Qnil;
  current_buffer->undo_list = Qt;
575 576
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
577 578
  current_buffer->enable_multibyte_characters
    = buffer_defaults.enable_multibyte_characters;
579 580
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
581
  Ferase_buffer ();
582
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
583

584
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
585 586 587 588

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
589 590 591
}

Lisp_Object
592
internal_with_output_to_temp_buffer (const char *bufname, Lisp_Object (*function) (Lisp_Object), Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
593
{
Juanma Barranquero's avatar
Juanma Barranquero committed
594
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
595
  Lisp_Object buf, val;
596
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
597

598
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
599 600 601
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
602
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
603 604 605

  val = (*function) (args);

606
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
607
  temp_output_buffer_show (buf);
608
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
609 610 611 612

  return unbind_to (count, val);
}

613 614
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
615
       1, UNEVALLED, 0,
616
       doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640

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'.
641

642
usage: (with-output-to-temp-buffer BUFNAME BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
643
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
644 645 646
{
  struct gcpro gcpro1;
  Lisp_Object name;
Juanma Barranquero's avatar
Juanma Barranquero committed
647
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
648 649 650 651
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
652
  CHECK_STRING (name);
653
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
654
  buf = Vstandard_output;
655
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
656

657
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
658

659
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
660
  temp_output_buffer_show (buf);
661
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
662 663 664

  return unbind_to (count, val);
}
665

Jim Blandy's avatar
Jim Blandy committed
666

667 668 669 670
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
671 672

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
673 674
       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
675
  (Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
676
{
677
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
678

Jim Blandy's avatar
Jim Blandy committed
679
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
680 681 682 683 684 685 686 687
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
688 689
       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
690
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
691
is controlled by `print-level' and `print-length', which see.
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709

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
710
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
711
{
712
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
713

Jim Blandy's avatar
Jim Blandy committed
714
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
715 716
    printcharfun = Vstandard_output;
  PRINTPREPARE;
717
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
718
  PRINTFINISH;
719
  return object;
Jim Blandy's avatar
Jim Blandy committed
720 721 722 723 724 725
}

/* 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,
726 727
       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
728
when necessary to make output that `read' can handle, whenever possible,
729 730
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
731 732 733 734 735

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
736
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
737
{
738
  Lisp_Object printcharfun;
739 740
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
741
  int count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
742
  struct buffer *previous;
743 744

  specbind (Qinhibit_modification_hooks, Qt);
745

Kenichi Handa's avatar
Kenichi Handa committed
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
  {
    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
762

Kenichi Handa's avatar
Kenichi Handa committed
763
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
764
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
765
  object = Fbuffer_string ();
766 767
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
768

769
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
770 771
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
772
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
773
  set_buffer_internal (previous);
774

775 776
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
777

778 779
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
780 781 782
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
       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
804
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
805
{
806
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
807

Jim Blandy's avatar
Jim Blandy committed
808
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
809 810
    printcharfun = Vstandard_output;
  PRINTPREPARE;
811
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
812
  PRINTFINISH;
813
  return object;
Jim Blandy's avatar
Jim Blandy committed
814 815 816
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
817 818
       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
819
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
820
is controlled by `print-level' and `print-length', which see.
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838

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
839
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
840
{
841
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
842 843
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
844
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
845
    printcharfun = Vstandard_output;
846
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
847 848
  PRINTPREPARE;
  PRINTCHAR ('\n');
849
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
850 851 852
  PRINTCHAR ('\n');
  PRINTFINISH;
  UNGCPRO;
853
  return object;
Jim Blandy's avatar
Jim Blandy committed
854 855 856 857 858 859
}

/* 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
860
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
861 862 863
       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
864
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
865
{
866
  CHECK_NUMBER (character);
867
  putc ((int) XINT (character), stderr);
868 869 870

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
871 872 873 874 875
  if (print_output_debug_flag)
    {
      char buf[2] = {(char) XINT (character), '\0'};
      OutputDebugString (buf);
    }
876 877
#endif

Jim Blandy's avatar
Jim Blandy committed
878 879
  return character;
}
880

881 882 883
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

884
void
885
debug_output_compilation_hack (int x)
886 887 888
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
889

Andreas Schwab's avatar
Andreas Schwab committed
890
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
891 892 893 894 895 896 897 898 899 900 901 902 903 904

/* 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
905
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
906
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
907 908
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
909 910 911 912