print.c 70.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
2 3
   Copyright (C) 1985, 1986, 1988, 1993, 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 46
/* These are used to print like we read.  */
extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;

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

#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
65 66 67 68 69 70 71 72
#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
73 74 75 76 77 78 79 80 81 82 83 84

/* 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
85 86 87
/* Avoid actual stack overflow in print.  */
int print_depth;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119
/* 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;

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

int print_escape_nonascii;

125 126 127 128 129 130 131
/* 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
132 133 134 135
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

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

138
Lisp_Object Vprint_gensym;
139

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

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
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
163

164
/* Nonzero means print newline to stdout before next minibuffer message.
Jim Blandy's avatar
Jim Blandy committed
165 166 167
   Defined in xdisp.c */

extern int noninteractive_need_newline;
168

169 170
extern int minibuffer_auto_raise;

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

173 174 175
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
int print_output_debug_flag = 1;

Jim Blandy's avatar
Jim Blandy committed
176

177
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
178 179

/* Lisp functions to do output using a stream
180 181 182 183
   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,
184
   or call strout to output a block of characters. */
185 186 187

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
Gerd Moellmann's avatar
Gerd Moellmann committed
188 189
   int old_point = -1, start_point = -1;				\
   int old_point_byte = -1, start_point_byte = -1;			\
Juanma Barranquero's avatar
Juanma Barranquero committed
190
   int specpdl_count = SPECPDL_INDEX ();				\
191 192
   int free_print_buffer = 0;						\
   int multibyte = !NILP (current_buffer->enable_multibyte_characters);	\
193 194
   Lisp_Object original

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

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

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

286 287
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
288

289
static Lisp_Object
290
print_unwind (Lisp_Object saved_text)
291
{
292
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
293
  return Qnil;
294 295
}

296 297 298 299 300

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

static void
303
printchar (unsigned int ch, Lisp_Object fun)
Jim Blandy's avatar
Jim Blandy committed
304
{
305 306 307
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
308
    {
309 310 311
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

312
      QUIT;
313

314
      if (NILP (fun))
315
	{
316 317 318
	  if (print_buffer_pos_byte + len >= print_buffer_size)
	    print_buffer = (char *) xrealloc (print_buffer,
					      print_buffer_size *= 2);
319
	  memcpy (print_buffer + print_buffer_pos_byte, str, len);
320 321
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
322
	}
323
      else if (noninteractive)
324
	{
325 326
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
327
	}
328
      else
329
	{
330 331
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
332

333
	  setup_echo_area_for_printing (multibyte_p);
334 335
	  insert_char (ch);
	  message_dolog (str, len, 0, multibyte_p);
336
	}
Jim Blandy's avatar
Jim Blandy committed
337 338 339
    }
}

340 341 342 343 344 345 346

/* 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
347 348 349 350
   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.  */
351

Jim Blandy's avatar
Jim Blandy committed
352
static void
353 354
strout (const char *ptr, int size, int size_byte, Lisp_Object printcharfun,
	int multibyte)
Jim Blandy's avatar
Jim Blandy committed
355
{
Karl Heuer's avatar
Karl Heuer committed
356
  if (size < 0)
357
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
358

359
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
360
    {
361
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
362
	{
363
	  print_buffer_size = print_buffer_size * 2 + size_byte;
364 365 366
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
367
      memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
368
      print_buffer_pos += size;
369
      print_buffer_pos_byte += size_byte;
Jim Blandy's avatar
Jim Blandy committed
370
    }
371
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
372
    {
373 374 375 376 377 378 379 380 381 382 383
      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);
384

385
      setup_echo_area_for_printing (multibyte_p);
386
      message_dolog (ptr, size_byte, 0, multibyte_p);
387

388
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
389
	{
390
	  for (i = 0; i < size; ++i)
Andreas Schwab's avatar
Andreas Schwab committed
391
	    insert_char ((unsigned char) *ptr++);
Jim Blandy's avatar
Jim Blandy committed
392
	}
393
      else
Jim Blandy's avatar
Jim Blandy committed
394
	{
395 396
	  int len;
	  for (i = 0; i < size_byte; i += len)
397
	    {
398
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, len);
399
	      insert_char (ch);
400
	    }
Jim Blandy's avatar
Jim Blandy committed
401
	}
402 403 404 405 406
    }
  else
    {
      /* PRINTCHARFUN is a Lisp function.  */
      int i = 0;
Jim Blandy's avatar
Jim Blandy committed
407

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

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

436
static void
437
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
438
{
439
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
440 441 442
    {
      int chars;

443 444 445
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

446
      if (STRING_MULTIBYTE (string))
447
	chars = SCHARS (string);
448 449 450 451
      else if (! print_escape_nonascii
	       && (EQ (printcharfun, Qt)
		   ? ! NILP (buffer_defaults.enable_multibyte_characters)
		   : ! NILP (current_buffer->enable_multibyte_characters)))
452 453 454 455 456 457 458
	{
	  /* If unibyte string STRING contains 8-bit codes, we must
	     convert STRING to a multibyte string containing the same
	     character codes.  */
	  Lisp_Object newstr;
	  int bytes;

459 460
	  chars = SBYTES (string);
	  bytes = parse_str_to_multibyte (SDATA (string), chars);
461 462 463
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
464
	      memcpy (SDATA (newstr), SDATA (string), chars);
465
	      str_to_multibyte (SDATA (newstr), bytes, chars);
466 467 468
	      string = newstr;
	    }
	}
469
      else
470
	chars = SBYTES (string);
471

472 473 474 475 476 477 478 479 480 481 482
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
	  int nbytes = SBYTES (string);
	  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);
483
	  memcpy (buffer, SDATA (string), nbytes);
484 485 486 487 488 489 490 491 492 493 494

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

Jim Blandy's avatar
Jim Blandy committed
530
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
531
    printcharfun = Vstandard_output;
532
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
533
  PRINTPREPARE;
534
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
535
  PRINTFINISH;
536
  return character;
Jim Blandy's avatar
Jim Blandy committed
537 538
}

539 540
/* 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
541 542
   Do not use this on the contents of a Lisp string.  */

543
void
544
write_string (char *data, int size)
Jim Blandy's avatar
Jim Blandy committed
545
{
546
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

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

556 557
/* 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
558 559
   Do not use this on the contents of a Lisp string.  */

560
void
561
write_string_1 (char *data, int size, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
562
{
563
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
564 565

  PRINTPREPARE;
566
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
567 568 569 570 571
  PRINTFINISH;
}


void
572
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
573
{
Juanma Barranquero's avatar
Juanma Barranquero committed
574
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
575 576 577
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

578 579
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
580 581
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

582
  Fkill_all_local_variables ();
583
  delete_all_overlays (current_buffer);
584
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
585
  current_buffer->read_only = Qnil;
586 587
  current_buffer->filename = Qnil;
  current_buffer->undo_list = Qt;
588 589
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
590 591
  current_buffer->enable_multibyte_characters
    = buffer_defaults.enable_multibyte_characters;
592 593
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
594
  Ferase_buffer ();
595
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
596

597
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
598 599 600 601

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
602 603 604
}

Lisp_Object
605
internal_with_output_to_temp_buffer (const char *bufname, Lisp_Object (*function) (Lisp_Object), Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
606
{
Juanma Barranquero's avatar
Juanma Barranquero committed
607
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
608
  Lisp_Object buf, val;
609
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
610

611
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
612 613 614
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
615
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
616 617 618

  val = (*function) (args);

619
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
620
  temp_output_buffer_show (buf);
621
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
622 623 624 625

  return unbind_to (count, val);
}

626 627
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
628
       1, UNEVALLED, 0,
629
       doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653

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

655
usage: (with-output-to-temp-buffer BUFNAME BODY...)  */)
656
     (args)
Jim Blandy's avatar
Jim Blandy committed
657 658 659 660
     Lisp_Object args;
{
  struct gcpro gcpro1;
  Lisp_Object name;
Juanma Barranquero's avatar
Juanma Barranquero committed
661
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
662 663 664 665
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
666
  CHECK_STRING (name);
667
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
668
  buf = Vstandard_output;
669
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
670

671
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
672

673
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
674
  temp_output_buffer_show (buf);
675
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
676 677 678

  return unbind_to (count, val);
}
679

Jim Blandy's avatar
Jim Blandy committed
680

681 682 683 684
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
685 686

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
687 688
       doc: /* Output a newline to stream PRINTCHARFUN.
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.  */)
Jim Blandy's avatar
Jim Blandy committed
689 690 691
  (printcharfun)
     Lisp_Object printcharfun;
{
692
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
693

Jim Blandy's avatar
Jim Blandy committed
694
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698 699 700 701 702
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
703 704
       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
705
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
706
is controlled by `print-level' and `print-length', which see.
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725

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.  */)
     (object, printcharfun)
726
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
727
{
728
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
729

Jim Blandy's avatar
Jim Blandy committed
730
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
731 732
    printcharfun = Vstandard_output;
  PRINTPREPARE;
733
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
734
  PRINTFINISH;
735
  return object;
Jim Blandy's avatar
Jim Blandy committed
736 737 738 739 740 741
}

/* 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,
742 743
       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
744
when necessary to make output that `read' can handle, whenever possible,
745 746
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
747 748 749 750 751 752

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.  */)
     (object, noescape)
753
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
754
{
755
  Lisp_Object printcharfun;
756 757
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
758
  int count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
759
  struct buffer *previous;
760 761

  specbind (Qinhibit_modification_hooks, Qt);
762

Kenichi Handa's avatar
Kenichi Handa committed
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
  {
    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
779

Kenichi Handa's avatar
Kenichi Handa committed
780
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
781
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
782
  object = Fbuffer_string ();
783 784
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
785

786
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
787 788
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
789
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
790
  set_buffer_internal (previous);
791

792 793
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
794

795 796
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
797 798 799
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
       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.  */)
     (object, printcharfun)
822
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
823
{
824
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
825

Jim Blandy's avatar
Jim Blandy committed
826
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
827 828
    printcharfun = Vstandard_output;
  PRINTPREPARE;
829
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
830
  PRINTFINISH;
831
  return object;
Jim Blandy's avatar
Jim Blandy committed
832 833 834
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
835 836
       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
837
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
838
is controlled by `print-level' and `print-length', which see.
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857

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.  */)
     (object, printcharfun)
858
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
859
{
860
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
861 862
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
863
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
864
    printcharfun = Vstandard_output;
865
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
866 867
  PRINTPREPARE;
  PRINTCHAR ('\n');
868
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
869 870 871
  PRINTCHAR ('\n');
  PRINTFINISH;
  UNGCPRO;
872
  return object;
Jim Blandy's avatar
Jim Blandy committed
873 874 875 876 877 878
}

/* 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
879
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
880 881 882 883
       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.  */)
     (character)
Jim Blandy's avatar
Jim Blandy committed
884
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
885
{
886
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
887
  putc (XINT (character), stderr);
888 889 890

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
891 892 893 894 895
  if (print_output_debug_flag)
    {
      char buf[2] = {(char) XINT (character), '\0'};
      OutputDebugString (buf);
    }
896 897
#endif

Jim Blandy's avatar
Jim Blandy committed
898 899
  return character;
}
900

901 902 903
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

904
void
905
debug_output_compilation_hack (int x)
906 907 908
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
909

Andreas Schwab's avatar
Andreas Schwab committed
910
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
911 912 913 914 915 916 917 918 919 920 921 922 923 924

/* 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
925
append to existing target file.  */)
Kenichi Handa's avatar
Kenichi Handa committed
926 927 928 929
     (file, append)
     Lisp_Object file, append;
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
930 931 932 933 934
    {
      BLOCK_INPUT;
      fclose (stderr);
      UNBLOCK_INPUT;
    }
Kenichi Handa's avatar
Kenichi Handa committed
935 936 937 938 939 940 941
  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
942
      stderr = fopen (SDATA (file), NILP (append) ? "w" : "a");
Kenichi Handa's avatar
Kenichi Handa committed
943 944 945 946 947 948 949 950 951 952 953 954 955
      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 */


956 957 958
/* This is the interface for debugging printing.  */

void
959
debug_print (Lisp_Object arg)
960 961
{
  Fprin1 (arg, Qexternal_debugging_output);
962
  fprintf (stderr, "\r\n");
963
}
964 965

void
966
safe_debug_print (Lisp_Object arg)
967 968 969 970 971 972 973 974
{
  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",
975
	     (unsigned long) XHASH (arg)
976 977 978
	     );
}

Jim Blandy's avatar
Jim Blandy committed
979

980 981
DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
       1, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
982 983 984
       doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
See Info anchor `(elisp)Definition of signal' for some details on how this
error message is constructed.  */)
985
     (obj)
986 987 988
     Lisp_Object obj;
{
  struct buffer *old = current_buffer;
989
  Lisp_Object value;
990 991
  struct gcpro gcpro1;

992 993 994
  /* If OBJ is (error STRING), just return STRING.
     That is not only faster, it also avoids the need to allocate
     space here when the error is due to memory full.  */
995 996 997 998 999
  if (CONSP (obj) && EQ (XCAR (obj), Qerror)
      && CONSP (XCDR (obj))
      && STRINGP (XCAR (XCDR (obj)))
      && NILP (XCDR (XCDR (obj))))
    return XCAR (XCDR (obj));
1000

1001
  print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);