print.c 67.4 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 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
Jim Blandy's avatar
Jim Blandy committed
10
the Free Software Foundation; either version 2, 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"
Karl Heuer's avatar
Karl Heuer 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"
Richard M. Stallman's avatar
Richard M. Stallman committed
37

Jim Blandy's avatar
Jim Blandy committed
38 39
Lisp_Object Vstandard_output, Qstandard_output;

40 41
Lisp_Object Qtemp_buffer_setup_hook;

Erik Naggum's avatar
Erik Naggum committed
42 43 44
/* 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
45
Lisp_Object Vfloat_output_format, Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
46 47 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

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

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

96 97 98
/* Nonzero if inside outputting backquote in old style.  */
int old_backquote_output;

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

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

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

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

int print_escape_nonascii;

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

int print_quoted;

144
/* Non-nil means print #: before uninterned symbols.  */
145

146
Lisp_Object Vprint_gensym;
147

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

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

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

extern int noninteractive_need_newline;
176

177 178
extern int minibuffer_auto_raise;

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

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

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

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

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

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

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

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

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

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

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

310 311 312 313 314

/* 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
315 316 317

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

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

333
      QUIT;
334

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

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

361 362 363 364 365 366 367

/* 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
368 369 370 371
   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.  */
372

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

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

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

414
      setup_echo_area_for_printing (multibyte_p);
415
      message_dolog (ptr, size_byte, 0, multibyte_p);
416

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

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

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

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

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

      if (STRING_MULTIBYTE (string))
480
	chars = SCHARS (string);
481 482 483
      else if (EQ (printcharfun, Qt)
	       ? ! NILP (buffer_defaults.enable_multibyte_characters)
	       : ! NILP (current_buffer->enable_multibyte_characters))
484 485 486 487 488 489 490
	{
	  /* 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;

491 492
	  chars = SBYTES (string);
	  bytes = parse_str_to_multibyte (SDATA (string), chars);
493 494 495
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
496 497
	      bcopy (SDATA (string), SDATA (newstr), chars);
	      str_to_multibyte (SDATA (newstr), bytes, chars);
498 499 500
	      string = newstr;
	    }
	}
501
      else
502
	chars = SBYTES (string);
503

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

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

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

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

  printcharfun = Vstandard_output;

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

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

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

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


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

622 623
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

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

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

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

  unbind_to (count, Qnil);

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

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

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

  val = (*function) (args);

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

  return unbind_to (count, val);
}

673 674
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
675
       1, UNEVALLED, 0,
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
       doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
The buffer is cleared out initially, and marked as unmodified when done.
All output done by BODY is inserted in that buffer by default.
The buffer is displayed in another window, but not selected.
The value of the last form in BODY is returned.
If BODY does not finish normally, the buffer BUFNAME is not displayed.

The hook `temp-buffer-setup-hook' is run before BODY,
with the buffer BUFNAME temporarily current.
The hook `temp-buffer-show-hook' is run after the buffer is displayed,
with the buffer temporarily current, and the window that was used
to display it temporarily selected.

If variable `temp-buffer-show-function' is non-nil, call it at the end
to get the buffer displayed instead of just displaying the non-selected
691
buffer and calling the hook.  It gets one argument, the buffer to display.
692

693
usage: (with-output-to-temp-buffer BUFNAME BODY ...)  */)
694
     (args)
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698
     Lisp_Object args;
{
  struct gcpro gcpro1;
  Lisp_Object name;
Juanma Barranquero's avatar
Juanma Barranquero committed
699
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
700 701 702 703
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
704
  CHECK_STRING (name);
705
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
706
  buf = Vstandard_output;
707
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
708

709
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
710

711
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
712
  temp_output_buffer_show (buf);
713
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
714 715 716

  return unbind_to (count, val);
}
717

Jim Blandy's avatar
Jim Blandy committed
718 719

static void print ();
720 721 722
static void print_preprocess ();
static void print_preprocess_string ();
static void print_object ();
Jim Blandy's avatar
Jim Blandy committed
723 724

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
725 726
       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
727 728 729
  (printcharfun)
     Lisp_Object printcharfun;
{
730
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
731

Jim Blandy's avatar
Jim Blandy committed
732
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
733 734 735 736 737 738 739 740
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
741 742
       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
743
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
744
is controlled by `print-level' and `print-length', which see.
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763

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)
764
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
765
{
766
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
767 768 769 770

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
771
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
772 773
    printcharfun = Vstandard_output;
  PRINTPREPARE;
774
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
775
  PRINTFINISH;
776
  return object;
Jim Blandy's avatar
Jim Blandy committed
777 778 779 780 781 782
}

/* 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,
783 784
       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
785
when necessary to make output that `read' can handle, whenever possible,
786 787
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
788 789 790 791 792 793

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)
794
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
795
{
796
  Lisp_Object printcharfun;
797 798
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
799
  int count = SPECPDL_INDEX ();
800
  struct buffer *previous;
801 802

  specbind (Qinhibit_modification_hooks, Qt);
803

804 805
  {
    PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
806

807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
    /* 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;
  }

  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
822
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
823
  object = Fbuffer_string ();
824 825
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
826

827
  /* Note that this won't make prepare_to_modify_buffer call
828 829
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
830
  Ferase_buffer ();
831
  set_buffer_internal (previous);
832

833 834
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
835

836 837
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
838 839 840
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
       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)
863
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
864
{
865
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
866

Jim Blandy's avatar
Jim Blandy committed
867
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
868 869
    printcharfun = Vstandard_output;
  PRINTPREPARE;
870
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
871
  PRINTFINISH;
872
  return object;
Jim Blandy's avatar
Jim Blandy committed
873 874 875
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
876 877
       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
878
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
879
is controlled by `print-level' and `print-length', which see.
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898

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)
899
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
900
{
901
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
902 903 904 905 906 907
  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
908
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
909
    printcharfun = Vstandard_output;
910
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
911 912
  PRINTPREPARE;
  PRINTCHAR ('\n');
913
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
914 915 916 917 918 919 920
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
921
  return object;
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925 926 927
}

/* 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
928
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
929 930 931 932
       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
933
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
934
{
935
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
936
  putc (XINT (character), stderr);
937 938 939

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
940 941 942 943 944
  if (print_output_debug_flag)
    {
      char buf[2] = {(char) XINT (character), '\0'};
      OutputDebugString (buf);
    }
945 946
#endif

Jim Blandy's avatar
Jim Blandy committed
947 948
  return character;
}
949

950 951 952
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

953
void
954 955 956 957 958
debug_output_compilation_hack (x)
     int x;
{
  print_output_debug_flag = x;
}
959

Andreas Schwab's avatar
Andreas Schwab committed
960
#if defined (GNU_LINUX)
961 962 963 964 965 966

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

967 968 969 970 971 972 973 974
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
975
append to existing target file.  */)
976 977 978 979
     (file, append)
     Lisp_Object file, append;
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
980 981 982 983 984
    {
      BLOCK_INPUT;
      fclose (stderr);
      UNBLOCK_INPUT;
    }