print.c 71.7 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.  */
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 65 66 67 68 69 70 71 72 73 74

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

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

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

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

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

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

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

int print_escape_nonascii;

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

int print_quoted;

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

148
Lisp_Object Vprint_gensym;
149

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

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

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

extern int noninteractive_need_newline;
178

179 180
extern int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
181 182 183 184
#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
185 186

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

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

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

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

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

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

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

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

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

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

312 313 314 315 316

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

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

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

335
      QUIT;
336

337
      if (NILP (fun))
338
	{
339 340 341 342 343 344
	  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;
345
	}
346
      else if (noninteractive)
347
	{
348 349
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
350
	}
351
      else
352
	{
353 354
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
355

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

363 364 365 366 367 368 369

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

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

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

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

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

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

434 435 436 437 438 439 440 441 442
#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
443

444
      if (size == size_byte)
445
	{
446
	  while (i < size_byte)
447
	    {
448 449
	      int ch = ptr[i++];
	      PRINTCHAR (ch);
450 451
	    }
	}
452
      else
Karl Heuer's avatar
Karl Heuer committed
453
	{
454 455 456 457 458 459 460 461 462 463
	  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
464
	}
Jim Blandy's avatar
Jim Blandy committed
465 466 467 468
    }
}

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

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

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

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

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

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

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

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

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

  printcharfun = Vstandard_output;

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

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

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

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


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

623 624
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

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

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

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

  unbind_to (count, Qnil);

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

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

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

  val = (*function) (args);

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

  return unbind_to (count, val);
}

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

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

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

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

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

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

  return unbind_to (count, val);
}
727

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

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

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

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

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

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

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

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

  specbind (Qinhibit_modification_hooks, Qt);
813

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

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

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

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

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

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

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

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

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)
909
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
910
{
911
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
912 913 914 915 916 917
  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
918
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
919
    printcharfun = Vstandard_output;
920
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
921 922
  PRINTPREPARE;
  PRINTCHAR ('\n');
923
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
924 925 926 927 928 929 930
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
931
  return object;
Jim Blandy's avatar
Jim Blandy committed
932 933 934 935 936 937
}

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

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

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

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

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

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

/* 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
985
append to existing target file.  */)
Kenichi Handa's avatar
Kenichi Handa committed
986 987 988