print.c 67.3 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
#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);		\
278
       signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
279 280 281 282 283 284 285 286 287 288 289 290
     }									\
   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),			\
291 292
		  old_point_byte + (old_point_byte >= start_point_byte	\
			       ? PT_BYTE - start_point_byte : 0));	\
293
   if (old != current_buffer)						\
294
     set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
295 296 297

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

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

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

309 310 311 312 313

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

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

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

332
      QUIT;
333

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

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

360 361 362 363 364 365 366

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  printcharfun = Vstandard_output;

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

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

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

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


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

621 622
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

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

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

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

  unbind_to (count, Qnil);

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

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

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

  val = (*function) (args);

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

  return unbind_to (count, val);
}

672 673
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
674
       1, UNEVALLED, 0,
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
       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
690
buffer and calling the hook.  It gets one argument, the buffer to display.
691

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

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

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

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

  return unbind_to (count, val);
}
716

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

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

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

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

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

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

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

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

  specbind (Qinhibit_modification_hooks, Qt);
802

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

806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
    /* 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
821
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
822
  object = Fbuffer_string ();
823 824
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
825

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

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

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

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

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

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

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

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

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

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

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

952
void
953 954 955 956 957
debug_output_compilation_hack (x)
     int x;
{
  print_output_debug_flag = x;
}
958 959 960 961 962 963 964 965

#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

966 967 968 969 970 971 972 973
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
974
append to existing target file.  */)
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
     (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;
}
998 999
#endif /* GNU_LINUX */

1000

1001