print.c 72.5 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 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22 23


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

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

43 44
Lisp_Object Qtemp_buffer_setup_hook;

Erik Naggum's avatar
Erik Naggum committed
45 46 47
/* 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
48
Lisp_Object Vfloat_output_format, Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

/* Work around a problem that happens because math.h on hpux 7
   defines two static variables--which, in Emacs, are not really static,
   because `static' is defined as nothing.  The problem is that they are
   defined both here and in lread.c.
   These macros prevent the name conflict.  */
#if defined (HPUX) && !defined (HPUX8)
#define _MAXLDBL print_maxldbl
#define _NMAXLDBL print_nmaxldbl
#endif

#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
76 77 78 79 80 81 82 83
#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
84 85 86 87 88 89 90 91 92 93 94 95

/* 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
96 97 98
/* Avoid actual stack overflow in print.  */
int print_depth;

99 100
/* Level of nesting inside outputting backquote in new style.  */
int new_backquote_output;
101

102 103 104 105
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
Lisp_Object being_printed[PRINT_CIRCLE];

106 107 108 109 110 111
/* 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;
112
/* Chars stored in print_buffer.  */
113
int print_buffer_pos;
114 115
/* Bytes stored in print_buffer.  */
int print_buffer_pos_byte;
116

Jim Blandy's avatar
Jim Blandy committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130
/* 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;

131 132 133 134 135
/* Nonzero means to print single-byte non-ascii characters in strings as
   octal escapes.  */

int print_escape_nonascii;

136 137 138 139 140 141 142
/* 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
143 144 145 146
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

147
/* Non-nil means print #: before uninterned symbols.  */
148

149
Lisp_Object Vprint_gensym;
150

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

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
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
174

175
/* Nonzero means print newline to stdout before next minibuffer message.
Jim Blandy's avatar
Jim Blandy committed
176 177 178
   Defined in xdisp.c */

extern int noninteractive_need_newline;
179

180 181
extern int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
182 183 184 185
#ifdef MAX_PRINT_CHARS
static int print_chars;
static int max_print;
#endif /* MAX_PRINT_CHARS */
Richard M. Stallman's avatar
Richard M. Stallman committed
186 187

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
188

189 190 191
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
int print_output_debug_flag = 1;

Jim Blandy's avatar
Jim Blandy committed
192

193
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
194 195

/* Lisp functions to do output using a stream
196 197 198 199
   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,
200
   or call strout to output a block of characters. */
201 202 203

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
Gerd Moellmann's avatar
Gerd Moellmann committed
204 205
   int old_point = -1, start_point = -1;				\
   int old_point_byte = -1, start_point_byte = -1;			\
Juanma Barranquero's avatar
Juanma Barranquero committed
206
   int specpdl_count = SPECPDL_INDEX ();				\
207 208
   int free_print_buffer = 0;						\
   int multibyte = !NILP (current_buffer->enable_multibyte_characters);	\
209 210
   Lisp_Object original

211 212 213 214 215 216 217 218 219 220 221
#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))						\
     {									\
222
       EMACS_INT marker_pos;						\
Andreas Schwab's avatar
Andreas Schwab committed
223
       if (! XMARKER (printcharfun)->buffer)				\
224
         error ("Marker does not point anywhere");			\
225 226 227 228 229
       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"); \
230 231
       old_point = PT;							\
       old_point_byte = PT_BYTE;					\
232
       SET_PT_BOTH (marker_pos,						\
233 234 235 236 237 238 239 240 241 242 243
		    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);			\
244 245 246
       if (! NILP (current_buffer->enable_multibyte_characters)		\
	   && ! print_escape_nonascii)					\
         specbind (Qprint_escape_nonascii, Qt);				\
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
       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;					\
     }									\
263
   if (EQ (printcharfun, Qt) && ! noninteractive)			\
264
     setup_echo_area_for_printing (multibyte);
Jim Blandy's avatar
Jim Blandy committed
265

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
#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);		\
282
       signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
283 284 285 286 287 288 289 290 291 292 293 294
     }									\
   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),			\
295
		  old_point_byte + (old_point_byte >= start_point_byte	\
Andreas Schwab's avatar
Andreas Schwab committed
296
				    ? PT_BYTE - start_point_byte : 0));	\
297
   if (old != current_buffer)						\
298
     set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
299 300 301

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

302 303
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
304

305 306 307 308
static Lisp_Object
print_unwind (saved_text)
     Lisp_Object saved_text;
{
309
  bcopy (SDATA (saved_text), print_buffer, SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
310
  return Qnil;
311 312
}

313 314 315 316 317

/* 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
318 319 320

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
321
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
322 323 324 325 326 327 328
     Lisp_Object fun;
{
#ifdef MAX_PRINT_CHARS
  if (max_print)
    print_chars++;
#endif /* MAX_PRINT_CHARS */

329 330 331
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
332
    {
333 334 335
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

336
      QUIT;
337

338
      if (NILP (fun))
339
	{
340 341 342 343 344 345
	  if (print_buffer_pos_byte + len >= print_buffer_size)
	    print_buffer = (char *) xrealloc (print_buffer,
					      print_buffer_size *= 2);
	  bcopy (str, print_buffer + print_buffer_pos_byte, len);
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
346
	}
347
      else if (noninteractive)
348
	{
349 350
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
351
	}
352
      else
353
	{
354 355
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
356

357
	  setup_echo_area_for_printing (multibyte_p);
358 359
	  insert_char (ch);
	  message_dolog (str, len, 0, multibyte_p);
360
	}
Jim Blandy's avatar
Jim Blandy committed
361 362 363
    }
}

364 365 366 367 368 369 370

/* 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
371 372 373 374
   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.  */
375

Jim Blandy's avatar
Jim Blandy committed
376
static void
377
strout (ptr, size, size_byte, printcharfun, multibyte)
Jim Blandy's avatar
Jim Blandy committed
378
     char *ptr;
379
     int size, size_byte;
Jim Blandy's avatar
Jim Blandy committed
380
     Lisp_Object printcharfun;
381
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
382
{
Karl Heuer's avatar
Karl Heuer committed
383
  if (size < 0)
384
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
385

386
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
387
    {
388
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
389
	{
390
	  print_buffer_size = print_buffer_size * 2 + size_byte;
391 392 393
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
394
      bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
395
      print_buffer_pos += size;
396
      print_buffer_pos_byte += size_byte;
397

Jim Blandy's avatar
Jim Blandy committed
398 399
#ifdef MAX_PRINT_CHARS
      if (max_print)
400
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
401 402
#endif /* MAX_PRINT_CHARS */
    }
403
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
404
    {
405 406 407 408 409 410 411 412 413 414 415
      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);
416

417
      setup_echo_area_for_printing (multibyte_p);
418
      message_dolog (ptr, size_byte, 0, multibyte_p);
419

420
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
421
	{
422
	  for (i = 0; i < size; ++i)
Andreas Schwab's avatar
Andreas Schwab committed
423
	    insert_char ((unsigned char) *ptr++);
Jim Blandy's avatar
Jim Blandy committed
424
	}
425
      else
Jim Blandy's avatar
Jim Blandy committed
426
	{
427 428
	  int len;
	  for (i = 0; i < size_byte; i += len)
429
	    {
430 431
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
	      insert_char (ch);
432
	    }
Jim Blandy's avatar
Jim Blandy committed
433
	}
434

435 436 437 438 439 440 441 442 443
#ifdef MAX_PRINT_CHARS
      if (max_print)
        print_chars += size;
#endif /* MAX_PRINT_CHARS */
    }
  else
    {
      /* PRINTCHARFUN is a Lisp function.  */
      int i = 0;
Jim Blandy's avatar
Jim Blandy committed
444

445
      if (size == size_byte)
446
	{
447
	  while (i < size_byte)
448
	    {
449 450
	      int ch = ptr[i++];
	      PRINTCHAR (ch);
451 452
	    }
	}
453
      else
Karl Heuer's avatar
Karl Heuer committed
454
	{
455 456 457 458 459 460 461 462 463 464
	  while (i < size_byte)
	    {
	      /* Here, we must convert each multi-byte form to the
		 corresponding character code before handing it to
		 PRINTCHAR.  */
	      int len;
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
	      PRINTCHAR (ch);
	      i += len;
	    }
Karl Heuer's avatar
Karl Heuer committed
465
	}
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469
    }
}

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

473
static void
Jim Blandy's avatar
Jim Blandy committed
474 475 476 477
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
478
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
479 480 481
    {
      int chars;

482 483 484
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

485
      if (STRING_MULTIBYTE (string))
486
	chars = SCHARS (string);
487 488 489 490
      else if (! print_escape_nonascii
	       && (EQ (printcharfun, Qt)
		   ? ! NILP (buffer_defaults.enable_multibyte_characters)
		   : ! NILP (current_buffer->enable_multibyte_characters)))
491 492 493 494 495 496 497
	{
	  /* 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;

498 499
	  chars = SBYTES (string);
	  bytes = parse_str_to_multibyte (SDATA (string), chars);
500 501 502
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
503 504
	      bcopy (SDATA (string), SDATA (newstr), chars);
	      str_to_multibyte (SDATA (newstr), bytes, chars);
505 506 507
	      string = newstr;
	    }
	}
508
      else
509
	chars = SBYTES (string);
510

511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
      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);
	  bcopy (SDATA (string), buffer, nbytes);

	  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));
534
    }
Jim Blandy's avatar
Jim Blandy committed
535 536
  else
    {
537 538
      /* 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
539
      int i;
540 541
      int size = SCHARS (string);
      int size_byte = SBYTES (string);
Jim Blandy's avatar
Jim Blandy committed
542 543
      struct gcpro gcpro1;
      GCPRO1 (string);
544 545
      if (size == size_byte)
	for (i = 0; i < size; i++)
546
	  PRINTCHAR (SREF (string, i));
547
      else
Kenichi Handa's avatar
Kenichi Handa committed
548
	for (i = 0; i < size_byte; )
549 550 551 552
	  {
	    /* Here, we must convert each multi-byte form to the
	       corresponding character code before handing it to PRINTCHAR.  */
	    int len;
553
	    int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i,
554
					     size_byte - i, len);
555 556 557
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
558 559 560 561 562
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
563 564 565
       doc: /* Output character CHARACTER to stream PRINTCHARFUN.
PRINTCHARFUN defaults to the value of `standard-output' (which see).  */)
     (character, printcharfun)
566
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
567
{
568
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
569

Jim Blandy's avatar
Jim Blandy committed
570
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
571
    printcharfun = Vstandard_output;
572
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
573
  PRINTPREPARE;
574
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
575
  PRINTFINISH;
576
  return character;
Jim Blandy's avatar
Jim Blandy committed
577 578
}

579 580
/* 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
581 582
   Do not use this on the contents of a Lisp string.  */

583
void
Jim Blandy's avatar
Jim Blandy committed
584 585 586 587
write_string (data, size)
     char *data;
     int size;
{
588
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
589 590 591 592 593
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
594
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
595 596 597
  PRINTFINISH;
}

598 599
/* 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
600 601
   Do not use this on the contents of a Lisp string.  */

602
void
Jim Blandy's avatar
Jim Blandy committed
603 604 605 606 607
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
608
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
609 610

  PRINTPREPARE;
611
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
612 613 614 615 616 617
  PRINTFINISH;
}


void
temp_output_buffer_setup (bufname)
Ken Raeburn's avatar
Ken Raeburn committed
618
    const char *bufname;
Jim Blandy's avatar
Jim Blandy committed
619
{
Juanma Barranquero's avatar
Juanma Barranquero committed
620
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
621 622 623
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

624 625
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
626 627
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

628
  Fkill_all_local_variables ();
629
  delete_all_overlays (current_buffer);
630
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
631
  current_buffer->read_only = Qnil;
632 633
  current_buffer->filename = Qnil;
  current_buffer->undo_list = Qt;
634 635
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
636 637
  current_buffer->enable_multibyte_characters
    = buffer_defaults.enable_multibyte_characters;
638 639
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
640
  Ferase_buffer ();
641
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
642

643
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
644 645 646 647

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
648 649 650 651
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
Ken Raeburn's avatar
Ken Raeburn committed
652
     const char *bufname;
Andreas Schwab's avatar
Andreas Schwab committed
653
     Lisp_Object (*function) P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
654 655
     Lisp_Object args;
{
Juanma Barranquero's avatar
Juanma Barranquero committed
656
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
657
  Lisp_Object buf, val;
658
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
659

660
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
661 662 663
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
664
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
665 666 667

  val = (*function) (args);

668
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
669
  temp_output_buffer_show (buf);
670
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
671 672 673 674

  return unbind_to (count, val);
}

675 676
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
677
       1, UNEVALLED, 0,
678
       doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702

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

704
usage: (with-output-to-temp-buffer BUFNAME BODY...)  */)
705
     (args)
Jim Blandy's avatar
Jim Blandy committed
706 707 708 709
     Lisp_Object args;
{
  struct gcpro gcpro1;
  Lisp_Object name;
Juanma Barranquero's avatar
Juanma Barranquero committed
710
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
711 712 713 714
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
715
  CHECK_STRING (name);
716
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
717
  buf = Vstandard_output;
718
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
719

720
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
721

722
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
723
  temp_output_buffer_show (buf);
724
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
725 726 727

  return unbind_to (count, val);
}
728

Jim Blandy's avatar
Jim Blandy committed
729 730

static void print ();
731 732 733
static void print_preprocess ();
static void print_preprocess_string ();
static void print_object ();
Jim Blandy's avatar
Jim Blandy committed
734 735

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
736 737
       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
738 739 740
  (printcharfun)
     Lisp_Object printcharfun;
{
741
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
742

Jim Blandy's avatar
Jim Blandy committed
743
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
744 745 746 747 748 749 750 751
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

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

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)
775
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
776
{
777
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
778 779 780 781

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
782
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
783 784
    printcharfun = Vstandard_output;
  PRINTPREPARE;
785
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
786
  PRINTFINISH;
787
  return object;
Jim Blandy's avatar
Jim Blandy committed
788 789 790 791 792 793
}

/* 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,
794 795
       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
796
when necessary to make output that `read' can handle, whenever possible,
797 798
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
799 800 801 802 803 804

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)
805
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
806
{
807
  Lisp_Object printcharfun;
808 809
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
810
  int count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
811
  struct buffer *previous;
812 813

  specbind (Qinhibit_modification_hooks, Qt);
814

Kenichi Handa's avatar
Kenichi Handa committed
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
  {
    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
831

Kenichi Handa's avatar
Kenichi Handa committed
832
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
833
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
834
  object = Fbuffer_string ();
835 836
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
837

838
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
839 840
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
841
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
842
  set_buffer_internal (previous);
843

844 845
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
846

847 848
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
849 850 851
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
       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)
874
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
875
{
876
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
877

Jim Blandy's avatar
Jim Blandy committed
878
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
879 880
    printcharfun = Vstandard_output;
  PRINTPREPARE;
881
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
882
  PRINTFINISH;
883
  return object;
Jim Blandy's avatar
Jim Blandy committed
884 885 886
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
887 888
       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
889
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
890
is controlled by `print-level' and `print-length', which see.
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909

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)
910
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
911
{
912
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
913 914 915 916 917 918
  struct gcpro gcpro1;

#ifdef MAX_PRINT_CHARS
  print_chars = 0;
  max_print = MAX_PRINT_CHARS;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
919
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
920
    printcharfun = Vstandard_output;
921
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
922 923
  PRINTPREPARE;
  PRINTCHAR ('\n');
924
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
925 926 927 928 929 930 931
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
932
  return object;
Jim Blandy's avatar
Jim Blandy committed
933 934 935 936 937 938
}

/* 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
939
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
940 941 942 943
       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
944
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
945
{
946
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
947
  putc (XINT (character), stderr);
948 949 950

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
951 952 953 954 955
  if (print_output_debug_flag)
    {
      char buf[2] = {(char) XINT (character), '\0'};
      OutputDebugString (buf);
    }
956 957
#endif

Jim Blandy's avatar
Jim Blandy committed
958 959
  return character;
}
960

961 962 963
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

964
void
965 966 967 968 969
debug_output_compilation_hack (x)
     int x;
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
970

Andreas Schwab's avatar
Andreas Schwab committed
971
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
972 973 974 975 976 977 978 979 980 981 982 983 984 985

/* 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
986
append to existing target file.  */)