print.c 65.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
2
   Copyright (C) 1985, 86, 88, 93, 94, 95, 97, 98, 1999, 2000, 01, 2003
3
	Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26
#include <stdio.h>
#include "lisp.h"
#include "buffer.h"
27
#include "character.h"
Kenichi Handa's avatar
Kenichi Handa 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
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
187 188

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

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

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

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

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

290 291
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
292

293 294 295 296
static Lisp_Object
print_unwind (saved_text)
     Lisp_Object saved_text;
{
297
  bcopy (SDATA (saved_text), print_buffer, SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
298
  return Qnil;
299 300
}

301 302 303 304 305

/* 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
306 307 308

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
309
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
310 311 312 313 314 315 316
     Lisp_Object fun;
{
#ifdef MAX_PRINT_CHARS
  if (max_print)
    print_chars++;
#endif /* MAX_PRINT_CHARS */

317 318 319
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
320
    {
321 322 323
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

324
      QUIT;
325

326
      if (NILP (fun))
327
	{
328 329 330 331 332 333
	  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;
334
	}
335
      else if (noninteractive)
336
	{
337 338
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
339
	}
340
      else
341
	{
342 343
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
344

345
	  setup_echo_area_for_printing (multibyte_p);
346 347
	  insert_char (ch);
	  message_dolog (str, len, 0, multibyte_p);
348
	}
Jim Blandy's avatar
Jim Blandy committed
349 350 351
    }
}

352 353 354 355 356 357 358 359 360

/* 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
361
static void
362
strout (ptr, size, size_byte, printcharfun, multibyte)
Jim Blandy's avatar
Jim Blandy committed
363
     char *ptr;
364
     int size, size_byte;
Jim Blandy's avatar
Jim Blandy committed
365
     Lisp_Object printcharfun;
366
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
367
{
Karl Heuer's avatar
Karl Heuer committed
368
  if (size < 0)
369
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
370

371
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
372
    {
373
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
374
	{
375
	  print_buffer_size = print_buffer_size * 2 + size_byte;
376 377 378
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
379
      bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
380
      print_buffer_pos += size;
381
      print_buffer_pos_byte += size_byte;
382

Jim Blandy's avatar
Jim Blandy committed
383 384
#ifdef MAX_PRINT_CHARS
      if (max_print)
385
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
386 387
#endif /* MAX_PRINT_CHARS */
    }
388
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
389
    {
390 391 392 393 394 395 396 397 398 399 400
      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);
401

402
      setup_echo_area_for_printing (multibyte_p);
403
      message_dolog (ptr, size_byte, 0, multibyte_p);
404

405
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
406
	{
407
	  for (i = 0; i < size; ++i)
408
	    insert_char ((unsigned char )*ptr++);
Jim Blandy's avatar
Jim Blandy committed
409
	}
410
      else
Jim Blandy's avatar
Jim Blandy committed
411
	{
412 413
	  int len;
	  for (i = 0; i < size_byte; i += len)
414
	    {
415 416
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
	      insert_char (ch);
417
	    }
Jim Blandy's avatar
Jim Blandy committed
418
	}
419

420 421 422 423 424 425 426 427 428
#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
429

430
      if (size == size_byte)
431
	{
432
	  while (i < size_byte)
433
	    {
434 435
	      int ch = ptr[i++];
	      PRINTCHAR (ch);
436 437
	    }
	}
438
      else
Karl Heuer's avatar
Karl Heuer committed
439
	{
440 441 442 443 444 445 446 447 448 449
	  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
450
	}
Jim Blandy's avatar
Jim Blandy committed
451 452 453 454
    }
}

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

458
static void
Jim Blandy's avatar
Jim Blandy committed
459 460 461 462
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
463
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
464 465 466
    {
      int chars;

467 468 469
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

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

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

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

Jim Blandy's avatar
Jim Blandy committed
536
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
537
    printcharfun = Vstandard_output;
538
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
539
  PRINTPREPARE;
540
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
541
  PRINTFINISH;
542
  return character;
Jim Blandy's avatar
Jim Blandy committed
543 544
}

545 546
/* 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
547 548
   Do not use this on the contents of a Lisp string.  */

549
void
Jim Blandy's avatar
Jim Blandy committed
550 551 552 553
write_string (data, size)
     char *data;
     int size;
{
554
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
555 556 557 558 559
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
560
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
561 562 563
  PRINTFINISH;
}

564 565
/* 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
566 567
   Do not use this on the contents of a Lisp string.  */

568
void
Jim Blandy's avatar
Jim Blandy committed
569 570 571 572 573
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
574
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
575 576

  PRINTPREPARE;
577
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
578 579 580 581 582 583
  PRINTFINISH;
}


void
temp_output_buffer_setup (bufname)
Ken Raeburn's avatar
Ken Raeburn committed
584
    const char *bufname;
Jim Blandy's avatar
Jim Blandy committed
585
{
Juanma Barranquero's avatar
Juanma Barranquero committed
586
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
587 588 589
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

590 591
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
592 593
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

594
  Fkill_all_local_variables ();
595
  delete_all_overlays (current_buffer);
596
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
597
  current_buffer->read_only = Qnil;
598 599
  current_buffer->filename = Qnil;
  current_buffer->undo_list = Qt;
600 601
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
602 603
  current_buffer->enable_multibyte_characters
    = buffer_defaults.enable_multibyte_characters;
Jim Blandy's avatar
Jim Blandy committed
604
  Ferase_buffer ();
605
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
606

607
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
608 609 610 611

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
612 613 614 615
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
Ken Raeburn's avatar
Ken Raeburn committed
616
     const char *bufname;
Andreas Schwab's avatar
Andreas Schwab committed
617
     Lisp_Object (*function) P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
618 619
     Lisp_Object args;
{
Juanma Barranquero's avatar
Juanma Barranquero committed
620
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
621
  Lisp_Object buf, val;
622
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
623

624
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
625 626 627
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
628
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
629 630 631

  val = (*function) (args);

632
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
633
  temp_output_buffer_show (buf);
634
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638

  return unbind_to (count, val);
}

639 640
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
641
       1, UNEVALLED, 0,
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
       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
657
buffer and calling the hook.  It gets one argument, the buffer to display.
658 659

usage: (with-output-to-temp-buffer BUFFNAME BODY ...)  */)
660
     (args)
Jim Blandy's avatar
Jim Blandy committed
661 662 663 664
     Lisp_Object args;
{
  struct gcpro gcpro1;
  Lisp_Object name;
Juanma Barranquero's avatar
Juanma Barranquero committed
665
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
666 667 668 669
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
670
  CHECK_STRING (name);
671
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
672
  buf = Vstandard_output;
673
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
674

675
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
676

677
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
678
  temp_output_buffer_show (buf);
679
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
680 681 682

  return unbind_to (count, val);
}
683

Jim Blandy's avatar
Jim Blandy committed
684 685

static void print ();
686 687 688
static void print_preprocess ();
static void print_preprocess_string ();
static void print_object ();
Jim Blandy's avatar
Jim Blandy committed
689 690

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
691 692
       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
693 694 695
  (printcharfun)
     Lisp_Object printcharfun;
{
696
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
697

Jim Blandy's avatar
Jim Blandy committed
698
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
699 700 701 702 703 704 705 706
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
707 708
       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
709
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
710
is controlled by `print-level' and `print-length', which see.
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729

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)
730
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
731
{
732
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
733 734 735 736

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
737
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
738 739
    printcharfun = Vstandard_output;
  PRINTPREPARE;
740
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
741
  PRINTFINISH;
742
  return object;
Jim Blandy's avatar
Jim Blandy committed
743 744 745 746 747 748
}

/* 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,
749 750
       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
751
when necessary to make output that `read' can handle, whenever possible,
752
unless the optional second argument NOESCAPE is non-nil.
753 754 755 756 757 758

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)
759
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
760
{
761 762
  PRINTDECLARE;
  Lisp_Object printcharfun;
763 764 765 766 767
  /* struct gcpro gcpro1, gcpro2; */
  Lisp_Object save_deactivate_mark;
  int count = specpdl_ptr - specpdl;

  specbind (Qinhibit_modification_hooks, Qt);
768 769 770 771

  /* 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.  */
772 773 774
  save_deactivate_mark = Vdeactivate_mark;
  /* GCPRO2 (object, save_deactivate_mark); */
  abort_on_gc++;
Jim Blandy's avatar
Jim Blandy committed
775 776 777

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
778
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
779 780 781
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
782
  object = Fbuffer_string ();
783 784
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
785 786 787

  Ferase_buffer ();
  set_buffer_internal (old);
788

789 790
  Vdeactivate_mark = save_deactivate_mark;
  /* UNGCPRO; */
Jim Blandy's avatar
Jim Blandy committed
791

792 793
  abort_on_gc--;
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
794 795 796
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
       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)
819
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
820
{
821
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
822

Jim Blandy's avatar
Jim Blandy committed
823
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
824 825
    printcharfun = Vstandard_output;
  PRINTPREPARE;
826
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
827
  PRINTFINISH;
828
  return object;
Jim Blandy's avatar
Jim Blandy committed
829 830 831
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
832 833
       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
834
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
835
is controlled by `print-level' and `print-length', which see.
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854

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)
855
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
856
{
857
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
858 859 860 861 862 863
  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
864
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
865
    printcharfun = Vstandard_output;
866
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
867 868
  PRINTPREPARE;
  PRINTCHAR ('\n');
869
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
870 871 872 873 874 875 876
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
877
  return object;
Jim Blandy's avatar
Jim Blandy committed
878 879 880 881 882 883
}

/* 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
884
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
885 886 887 888
       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
889
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
890
{
891
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
892
  putc (XINT (character), stderr);
893 894 895 896 897 898 899 900 901

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

Jim Blandy's avatar
Jim Blandy committed
902 903
  return character;
}
904 905 906 907 908 909 910 911

/* This is the interface for debugging printing.  */

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
912
  fprintf (stderr, "\r\n");
913
}
Jim Blandy's avatar
Jim Blandy committed
914

915 916
DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
       1, 1, 0,
917 918
       doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.  */)
     (obj)
919 920 921
     Lisp_Object obj;
{
  struct buffer *old = current_buffer;
922
  Lisp_Object value;
923 924
  struct gcpro gcpro1;

925 926 927
  /* If OBJ is (error STRING), just return STRING.
     That is not only faster, it also avoids the need to allocate
     space here when the error is due to memory full.  */
928 929 930 931 932
  if (CONSP (obj) && EQ (XCAR (obj), Qerror)
      && CONSP (XCDR (obj))
      && STRINGP (XCAR (XCDR (obj)))
      && NILP (XCDR (XCDR (obj))))
    return XCAR (XCDR (obj));
933

934
  print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
935 936 937 938 939 940 941 942 943 944 945 946

  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
  value = Fbuffer_string ();

  GCPRO1 (value);
  Ferase_buffer ();
  set_buffer_internal (old);
  UNGCPRO;

  return value;
}

947 948
/* Print an error message for the error DATA onto Lisp output stream
   STREAM (suitable for the print functions).  */
949

950
void
951
print_error_message (data, stream, context, caller)
952
     Lisp_Object data, stream;
953 954
     char *context;
     Lisp_Object caller;
955 956 957 958 959
{
  Lisp_Object errname, errmsg, file_error, tail;
  struct gcpro gcpro1;
  int i;

960 961 962 963 964 965 966 967 968 969 970 971
  if (context != 0)
    write_string_1 (context, -1, stream);

  /* If we know from where the error was signaled, show it in
   *Messages*.  */
  if (!NILP (caller) && SYMBOLP (caller))
    {
      const char *name = SDATA (SYMBOL_NAME (caller));
      message_dolog (name, strlen (name), 0, 0);
      message_dolog (": ", 2, 0, 0);
    }

972 973 974 975 976
  errname = Fcar (data);

  if (EQ (errname, Qerror))
    {
      data = Fcdr (data);
977 978
      if (!CONSP (data))
	data = Qnil;
979 980 981 982 983
      errmsg = Fcar (data);
      file_error = Qnil;
    }
  else
    {
984
      Lisp_Object error_conditions;
985
      errmsg = Fget (errname, Qerror_message);
986 987
      error_conditions = Fget (errname, Qerror_conditions);
      file_error = Fmemq (Qfile_error, error_conditions);
988 989 990 991 992 993 994 995 996
    }

  /* Print an error message including the data items.  */

  tail = Fcdr_safe (data);
  GCPRO1 (tail);

  /* For file-error, make error message by concatenating
     all the data items.  They are all strings.  */
997
  if (!NILP (file_error) && CONSP (tail))
998
    errmsg = XCAR (tail), tail = XCDR (tail);