print.c 66.2 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,
4
                 2005, 2006 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 36
#include "intervals.h"

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

39 40
Lisp_Object Qtemp_buffer_setup_hook;

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

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

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

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

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

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

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

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

int print_escape_nonascii;

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

int print_quoted;

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

145
Lisp_Object Vprint_gensym;
146

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

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

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

extern int noninteractive_need_newline;
175

176 177
extern int minibuffer_auto_raise;

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

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

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

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

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

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

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

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

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

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

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

308 309 310 311 312

/* 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
313 314 315

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

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

331
      QUIT;
332

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

352
	  setup_echo_area_for_printing (multibyte_p);
353 354
	  insert_char (ch);
	  message_dolog (str, len, 0, multibyte_p);
355
	}
Jim Blandy's avatar
Jim Blandy committed
356 357 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
   non-zero means PTR contains multibyte characters.  */

Jim Blandy's avatar
Jim Blandy committed
368
static void
369
strout (ptr, size, size_byte, printcharfun, multibyte)
Jim Blandy's avatar
Jim Blandy committed
370
     char *ptr;
371
     int size, size_byte;
Jim Blandy's avatar
Jim Blandy committed
372
     Lisp_Object printcharfun;
373
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
374
{
Karl Heuer's avatar
Karl Heuer committed
375
  if (size < 0)
376
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
377

378
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
379
    {
380
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
381
	{
382
	  print_buffer_size = print_buffer_size * 2 + size_byte;
383 384 385
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
386
      bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
387
      print_buffer_pos += size;
388
      print_buffer_pos_byte += size_byte;
389

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

409
      setup_echo_area_for_printing (multibyte_p);
410
      message_dolog (ptr, size_byte, 0, multibyte_p);
411

412
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
413
	{
414
	  for (i = 0; i < size; ++i)
415
	    insert_char ((unsigned char )*ptr++);
Jim Blandy's avatar
Jim Blandy committed
416
	}
417
      else
Jim Blandy's avatar
Jim Blandy committed
418
	{
419 420
	  int len;
	  for (i = 0; i < size_byte; i += len)
421
	    {
422 423
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
	      insert_char (ch);
424
	    }
Jim Blandy's avatar
Jim Blandy committed
425
	}
426

427 428 429 430 431 432 433 434 435
#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
436

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

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

465
static void
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
470
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
471 472 473 474
    {
      int chars;

      if (STRING_MULTIBYTE (string))
475
	chars = SCHARS (string);
476 477 478
      else if (EQ (printcharfun, Qt)
	       ? ! NILP (buffer_defaults.enable_multibyte_characters)
	       : ! NILP (current_buffer->enable_multibyte_characters))
479 480 481 482 483 484 485
	{
	  /* 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;

486 487
	  chars = SBYTES (string);
	  bytes = parse_str_to_multibyte (SDATA (string), chars);
488 489 490
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
491 492
	      bcopy (SDATA (string), SDATA (newstr), chars);
	      str_to_multibyte (SDATA (newstr), bytes, chars);
493 494 495
	      string = newstr;
	    }
	}
496
      else
497
	chars = SBYTES (string);
498 499

      /* strout is safe for output to a frame (echo area) or to print_buffer.  */
500 501
      strout (SDATA (string),
	      chars, SBYTES (string),
502 503
	      printcharfun, STRING_MULTIBYTE (string));
    }
Jim Blandy's avatar
Jim Blandy committed
504 505
  else
    {
506 507
      /* 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
508
      int i;
509 510
      int size = SCHARS (string);
      int size_byte = SBYTES (string);
Jim Blandy's avatar
Jim Blandy committed
511 512
      struct gcpro gcpro1;
      GCPRO1 (string);
513 514
      if (size == size_byte)
	for (i = 0; i < size; i++)
515
	  PRINTCHAR (SREF (string, i));
516
      else
517
	for (i = 0; i < size_byte; )
518 519 520 521
	  {
	    /* Here, we must convert each multi-byte form to the
	       corresponding character code before handing it to PRINTCHAR.  */
	    int len;
522
	    int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i,
523
					     size_byte - i, len);
524 525
	    if (!CHAR_VALID_P (ch, 0))
	      {
526
		ch = SREF (string, i);
527 528
		len = 1;
	      }
529 530 531
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
537 538 539
       doc: /* Output character CHARACTER to stream PRINTCHARFUN.
PRINTCHARFUN defaults to the value of `standard-output' (which see).  */)
     (character, printcharfun)
540
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
541
{
542
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
543

Jim Blandy's avatar
Jim Blandy committed
544
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
545
    printcharfun = Vstandard_output;
546
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
547
  PRINTPREPARE;
548
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
549
  PRINTFINISH;
550
  return character;
Jim Blandy's avatar
Jim Blandy committed
551 552
}

553 554
/* 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
555 556
   Do not use this on the contents of a Lisp string.  */

557
void
Jim Blandy's avatar
Jim Blandy committed
558 559 560 561
write_string (data, size)
     char *data;
     int size;
{
562
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
563 564 565 566 567
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

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

572 573
/* 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
574 575
   Do not use this on the contents of a Lisp string.  */

576
void
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580 581
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
582
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
583 584

  PRINTPREPARE;
585
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
586 587 588 589 590 591
  PRINTFINISH;
}


void
temp_output_buffer_setup (bufname)
Ken Raeburn's avatar
Ken Raeburn committed
592
    const char *bufname;
Jim Blandy's avatar
Jim Blandy committed
593
{
Juanma Barranquero's avatar
Juanma Barranquero committed
594
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
595 596 597
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

598 599
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
600 601
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

602
  Fkill_all_local_variables ();
603
  delete_all_overlays (current_buffer);
604
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
605
  current_buffer->read_only = Qnil;
606 607
  current_buffer->filename = Qnil;
  current_buffer->undo_list = Qt;
608 609
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
610 611
  current_buffer->enable_multibyte_characters
    = buffer_defaults.enable_multibyte_characters;
612 613
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
614
  Ferase_buffer ();
615
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
616

617
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
618 619 620 621

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
622 623 624 625
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
Ken Raeburn's avatar
Ken Raeburn committed
626
     const char *bufname;
Andreas Schwab's avatar
Andreas Schwab committed
627
     Lisp_Object (*function) P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
628 629
     Lisp_Object args;
{
Juanma Barranquero's avatar
Juanma Barranquero committed
630
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
631
  Lisp_Object buf, val;
632
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
633

634
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
635 636 637
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
638
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
639 640 641

  val = (*function) (args);

642
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
643
  temp_output_buffer_show (buf);
644
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
645 646 647 648

  return unbind_to (count, val);
}

649 650
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
651
       1, UNEVALLED, 0,
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
       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
667
buffer and calling the hook.  It gets one argument, the buffer to display.
668

669
usage: (with-output-to-temp-buffer BUFNAME BODY ...)  */)
670
     (args)
Jim Blandy's avatar
Jim Blandy committed
671 672 673 674
     Lisp_Object args;
{
  struct gcpro gcpro1;
  Lisp_Object name;
Juanma Barranquero's avatar
Juanma Barranquero committed
675
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
676 677 678 679
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
680
  CHECK_STRING (name);
681
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
682
  buf = Vstandard_output;
683
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
684

685
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
686

687
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
688
  temp_output_buffer_show (buf);
689
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
690 691 692

  return unbind_to (count, val);
}
693

Jim Blandy's avatar
Jim Blandy committed
694 695

static void print ();
696 697 698
static void print_preprocess ();
static void print_preprocess_string ();
static void print_object ();
Jim Blandy's avatar
Jim Blandy committed
699 700

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
701 702
       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
703 704 705
  (printcharfun)
     Lisp_Object printcharfun;
{
706
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
707

Jim Blandy's avatar
Jim Blandy committed
708
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
709 710 711 712 713 714 715 716
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
717 718
       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
719
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
720
is controlled by `print-level' and `print-length', which see.
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.

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)
740
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
741
{
742
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
743 744 745 746

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
747
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
748 749
    printcharfun = Vstandard_output;
  PRINTPREPARE;
750
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
751
  PRINTFINISH;
752
  return object;
Jim Blandy's avatar
Jim Blandy committed
753 754 755 756 757 758
}

/* 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,
759 760
       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
761
when necessary to make output that `read' can handle, whenever possible,
762
unless the optional second argument NOESCAPE is non-nil.
763 764 765 766 767 768

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)
769
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
770
{
771
  Lisp_Object printcharfun;
772 773 774
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
  int count = specpdl_ptr - specpdl;
775
  struct buffer *previous;
776 777

  specbind (Qinhibit_modification_hooks, Qt);
778

779 780
  {
    PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
781

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
    /* 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
797
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
798
  object = Fbuffer_string ();
799 800
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
801

802
  /* Note that this won't make prepare_to_modify_buffer call
803 804
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
805
  Ferase_buffer ();
806
  set_buffer_internal (previous);
807

808 809
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
810

811 812
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
813 814 815
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
       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)
838
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
839
{
840
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
841

Jim Blandy's avatar
Jim Blandy committed
842
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
843 844
    printcharfun = Vstandard_output;
  PRINTPREPARE;
845
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
846
  PRINTFINISH;
847
  return object;
Jim Blandy's avatar
Jim Blandy committed
848 849 850
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
851 852
       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
853
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
854
is controlled by `print-level' and `print-length', which see.
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873

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 878 879 880 881 882
  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
883
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
884
    printcharfun = Vstandard_output;
885
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
886 887
  PRINTPREPARE;
  PRINTCHAR ('\n');
888
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
889 890 891 892 893 894 895
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
896
  return object;
Jim Blandy's avatar
Jim Blandy committed
897 898 899 900 901 902
}

/* 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
903
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
904 905 906 907
       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
908
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
909
{
910
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
911
  putc (XINT (character), stderr);
912 913 914

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
915 916 917 918 919
  if (print_output_debug_flag)
    {
      char buf[2] = {(char) XINT (character), '\0'};
      OutputDebugString (buf);
    }
920 921
#endif

Jim Blandy's avatar
Jim Blandy committed
922 923
  return character;
}
924

925 926 927 928 929 930 931 932

#if defined(GNU_LINUX)

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

933 934 935 936 937 938 939 940
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
941
append to existing target file.  */)
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
     (file, append)
     Lisp_Object file, append;
{
  if (initial_stderr_stream != NULL)
    fclose(stderr);
  stderr = initial_stderr_stream;
  initial_stderr_stream = NULL;

  if (STRINGP (file))
    {
      file = Fexpand_file_name (file, Qnil);
      initial_stderr_stream = stderr;
      stderr = fopen(SDATA (file), NILP (append) ? "w" : "a");
      if (stderr == NULL)
	{
	  stderr = initial_stderr_stream;
	  initial_stderr_stream = NULL;
	  report_file_error ("Cannot open debugging output stream",
			     Fcons (file, Qnil));
	}
    }
  return Qnil;
}
965 966
#endif /* GNU_LINUX */

967

968 969 970 971 972 973 974
/* This is the interface for debugging printing.  */

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
975
  fprintf (stderr, "\r\n");
976
}
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996

void
safe_debug_print (arg)
     Lisp_Object arg;
{
  int valid = valid_lisp_object_p (arg);

  if (valid > 0)
    debug_print (arg);
  else
    fprintf (stderr, "#<%s_LISP_OBJECT 0x%08lx>\r\n",
	     !valid ? "INVALID" : "SOME",
#ifdef NO_UNION_TYPE
	     (unsigned long) arg
#else
	     (unsigned long) arg.i
#endif
	     );
}

Jim Blandy's avatar
Jim Blandy committed
997

998 999
DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
       1, 1, 0,
1000 1001 1002
       doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
See Info anchor `(elisp)Definition of signal' for some details on how this
error message is constructed.  */)