print.c 70.6 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 148 149 150 151 152 153 154 155 156 157 158 159 160 161
Lisp_Object Vprint_circle;

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

Lisp_Object Vprint_continuous_numbering;

/* Vprint_number_table is a vector like [OBJ1 STAT1 OBJ2 STAT2 ...],
   where OBJn are objects going to be printed, and STATn are their status,
   which may be different meanings during process.  See the comments of
   the functions print and print_preprocess for details.
   print_number_index keeps the last position the next object should be added,
   twice of which is the actual vector position in Vprint_number_table.  */
int print_number_index;
Lisp_Object Vprint_number_table;

/* PRINT_NUMBER_OBJECT returns the I'th object in Vprint_number_table TABLE.
   PRINT_NUMBER_STATUS returns the status of the I'th object in TABLE.
   See the comment of the variable Vprint_number_table.  */
#define PRINT_NUMBER_OBJECT(table,i) XVECTOR ((table))->contents[(i) * 2]
#define PRINT_NUMBER_STATUS(table,i) XVECTOR ((table))->contents[(i) * 2 + 1]
Erik Naggum's avatar
Erik Naggum committed
162

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

165
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
166
int print_output_debug_flag EXTERNALLY_VISIBLE = 1;
167

Jim Blandy's avatar
Jim Blandy committed
168

169
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
170 171

/* Lisp functions to do output using a stream
172 173 174 175
   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,
176
   or call strout to output a block of characters. */
177 178 179

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

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

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

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

278 279
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
280

281
static Lisp_Object
282
print_unwind (Lisp_Object saved_text)
283
{
284
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
285
  return Qnil;
286 287
}

288 289 290 291 292

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

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

304
      QUIT;
305

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

325
	  setup_echo_area_for_printing (multibyte_p);
326 327
	  insert_char (ch);
	  message_dolog (str, len, 0, multibyte_p);
328
	}
Jim Blandy's avatar
Jim Blandy committed
329 330 331
    }
}

332 333 334 335 336 337 338

/* 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
339 340 341 342
   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.  */
343

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

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

377
      setup_echo_area_for_printing (multibyte_p);
378
      message_dolog (ptr, size_byte, 0, multibyte_p);
379

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

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

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

428
static void
429
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
430
{
431
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
432
    {
433
      EMACS_INT chars;
434

435 436 437
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

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

451 452
	  chars = SBYTES (string);
	  bytes = parse_str_to_multibyte (SDATA (string), chars);
453 454 455
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
456
	      memcpy (SDATA (newstr), SDATA (string), chars);
457
	      str_to_multibyte (SDATA (newstr), bytes, chars);
458 459 460
	      string = newstr;
	    }
	}
461
      else
462
	chars = SBYTES (string);
463

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

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

Jim Blandy's avatar
Jim Blandy committed
521
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
522
    printcharfun = Vstandard_output;
523
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
524
  PRINTPREPARE;
525
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
526
  PRINTFINISH;
527
  return character;
Jim Blandy's avatar
Jim Blandy committed
528 529
}

530 531
/* 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
532 533
   Do not use this on the contents of a Lisp string.  */

534
void
535
write_string (const char *data, int size)
Jim Blandy's avatar
Jim Blandy committed
536
{
537
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
538 539 540 541 542
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
543
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
544 545 546
  PRINTFINISH;
}

547 548
/* Used from outside of print.c to print a block of SIZE
   single-byte chars at DATA on a specified stream PRINTCHARFUN.
Jim Blandy's avatar
Jim Blandy committed
549 550
   Do not use this on the contents of a Lisp string.  */

551
void
552
write_string_1 (const char *data, int size, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
553
{
554
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
555 556

  PRINTPREPARE;
557
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
558 559 560 561 562
  PRINTFINISH;
}


void
563
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
564
{
Juanma Barranquero's avatar
Juanma Barranquero committed
565
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
566 567 568
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

569 570
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
571 572
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

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

588
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
589 590 591 592

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
593 594 595
}

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

602
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
603 604 605
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
606
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
607 608 609

  val = (*function) (args);

610
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
611
  temp_output_buffer_show (buf);
612
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
613 614 615 616

  return unbind_to (count, val);
}

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

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

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

  GCPRO1(args);
  name = Feval (Fcar (args));
656
  CHECK_STRING (name);
657
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
658
  buf = Vstandard_output;
659
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
660

661
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
662

663
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
664
  temp_output_buffer_show (buf);
665
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
666 667 668

  return unbind_to (count, val);
}
669

Jim Blandy's avatar
Jim Blandy committed
670

671 672 673 674
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
675 676

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
677 678
       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
679
  (Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
680
{
681
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
682

Jim Blandy's avatar
Jim Blandy committed
683
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
684 685 686 687 688 689 690 691
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

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

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
714
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
715
{
716
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
717

Jim Blandy's avatar
Jim Blandy committed
718
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
719 720
    printcharfun = Vstandard_output;
  PRINTPREPARE;
721
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
722
  PRINTFINISH;
723
  return object;
Jim Blandy's avatar
Jim Blandy committed
724 725 726 727 728 729
}

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

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

  specbind (Qinhibit_modification_hooks, Qt);
749

Kenichi Handa's avatar
Kenichi Handa committed
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
  {
    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
766

Kenichi Handa's avatar
Kenichi Handa committed
767
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
768
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
769
  object = Fbuffer_string ();
770 771
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
772

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

779 780
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
781

782 783
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
784 785 786
}

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

Jim Blandy's avatar
Jim Blandy committed
812
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
813 814
    printcharfun = Vstandard_output;
  PRINTPREPARE;
815
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
816
  PRINTFINISH;
817
  return object;
Jim Blandy's avatar
Jim Blandy committed
818 819 820
}

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

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
843
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
844
{
845
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
846 847
  struct gcpro gcpro1;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
882 883
  return character;
}
884

885 886 887
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

888
void
889
debug_output_compilation_hack (int x)
890 891 892
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
893

Andreas Schwab's avatar
Andreas Schwab committed
894
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
895 896 897 898 899 900 901 902 903 904 905 906 907 908

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