print.c 50.1 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
2 3
   Copyright (C) 1985, 86, 88, 93, 94, 95, 97, 1998
	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"
Karl Heuer's avatar
Karl Heuer committed
27
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
29 30 31 32
#include "window.h"
#include "process.h"
#include "dispextern.h"
#include "termchar.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
33
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
34

Richard M. Stallman's avatar
Richard M. Stallman committed
35 36 37 38
#ifdef USE_TEXT_PROPERTIES
#include "intervals.h"
#endif

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

41 42
Lisp_Object Qtemp_buffer_setup_hook;

Erik Naggum's avatar
Erik Naggum committed
43 44 45
/* 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
46 47
#ifdef LISP_FLOAT_TYPE
Lisp_Object Vfloat_output_format, Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

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

/* 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
96 97 98 99 100
#endif /* LISP_FLOAT_TYPE */

/* Avoid actual stack overflow in print.  */
int print_depth;

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

105 106 107 108 109 110
/* When printing into a buffer, first we put the text in this
   block, then insert it all at once.  */
char *print_buffer;

/* Size allocated in print_buffer.  */
int print_buffer_size;
111
/* Chars stored in print_buffer.  */
112
int print_buffer_pos;
113 114
/* Bytes stored in print_buffer.  */
int print_buffer_pos_byte;
115

Jim Blandy's avatar
Jim Blandy committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129
/* Maximum length of list to print in full; noninteger means
   effectively infinity */

Lisp_Object Vprint_length;

/* Maximum depth of list to print in full; noninteger means
   effectively infinity.  */

Lisp_Object Vprint_level;

/* Nonzero means print newlines in strings as \n.  */

int print_escape_newlines;

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

int print_escape_nonascii;

135 136 137 138 139 140 141
/* Nonzero means to print multibyte characters in strings as hex escapes.  */

int print_escape_multibyte;

Lisp_Object Qprint_escape_newlines;
Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;

Erik Naggum's avatar
Erik Naggum committed
142 143 144 145
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

146 147 148
/* Non-nil means print #: before uninterned symbols.
   Neither t nor nil means so that and don't clear Vprint_gensym_alist
   on entry to and exit from print functions.  */
149

150
Lisp_Object Vprint_gensym;
151 152 153 154 155

/* Association list of certain objects that are `eq' in the form being
   printed and which should be `eq' when read back in, using the #n=object
   and #n# reader forms.  Each element has the form (object . n).  */

156
Lisp_Object Vprint_gensym_alist;
Erik Naggum's avatar
Erik Naggum committed
157

158
/* Nonzero means print newline to stdout before next minibuffer message.
Jim Blandy's avatar
Jim Blandy committed
159 160 161
   Defined in xdisp.c */

extern int noninteractive_need_newline;
162

163 164
extern int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
165 166 167 168
#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
169 170

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
171 172


173
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
174 175

/* Lisp functions to do output using a stream
176 177 178 179
   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,
180 181 182 183 184 185 186 187 188
   or call strout to output a block of characters. */ 

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
   int old_point = -1, start_point;					\
   int old_point_byte, start_point_byte;				\
   int specpdl_count = specpdl_ptr - specpdl;				\
   int free_print_buffer = 0;						\
   int multibyte = !NILP (current_buffer->enable_multibyte_characters);	\
189 190
   Lisp_Object original

191 192 193 194 195 196 197 198 199 200 201 202 203 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 233 234 235 236 237 238 239 240 241
#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);			\
       if (! NILP (current_buffer->enable_multibyte_characters)		\
	   && ! print_escape_nonascii)					\
         specbind (Qprint_escape_nonascii, Qt);				\
       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;					\
     }									\
   if (EQ (printcharfun, Qt))						\
     setup_echo_area_for_printing (multibyte);				\
   if (!CONSP (Vprint_gensym))						\
242
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
243

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
#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),			\
272 273
		  old_point_byte + (old_point_byte >= start_point_byte	\
			       ? PT_BYTE - start_point_byte : 0));	\
274 275 276
   if (old != current_buffer)						\
     set_buffer_internal (old);						\
   if (!CONSP (Vprint_gensym))						\
277
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
278 279 280

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

281 282 283 284 285 286 287
/* Nonzero if there is no room to print any more characters
   so print might as well return right away.  */

#define PRINTFULLP()					\
 (EQ (printcharfun, Qt) && !noninteractive		\
  && printbufidx >= FRAME_WIDTH (XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)))))

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

291 292 293 294 295 296 297
static Lisp_Object
print_unwind (saved_text)
     Lisp_Object saved_text;
{
  bcopy (XSTRING (saved_text)->data, print_buffer, XSTRING (saved_text)->size);
}

298 299 300 301 302

/* 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
303 304 305

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

314 315 316
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
317
    {
Karl Heuer's avatar
Karl Heuer committed
318 319
      unsigned char work[4], *str;
      int len = CHAR_STRING (ch, work, str);
320
    
321
      QUIT;
322 323
      
      if (NILP (fun))
324
	{
325 326 327 328 329 330
	  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;
331
	}
332
      else if (noninteractive)
333
	{
334 335
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
336
	}
337
      else
338
	{
339 340 341 342 343 344 345 346
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
	  
	  if (!message_buf_print)
	    setup_echo_area_for_printing (multibyte_p);

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

351 352 353 354 355 356 357 358 359

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

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

Jim Blandy's avatar
Jim Blandy committed
382 383
#ifdef MAX_PRINT_CHARS
      if (max_print)
384
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
385 386
#endif /* MAX_PRINT_CHARS */
    }
387
  else if (noninteractive)
Jim Blandy's avatar
Jim Blandy committed
388
    {
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
      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);
      
      if (!message_buf_print)
	setup_echo_area_for_printing (multibyte_p);
      
      message_dolog (ptr, size_byte, 0, multibyte_p);
      
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
407
	{
408 409
	  for (i = 0; i < size; ++i)
	    insert_char (*ptr++);
Jim Blandy's avatar
Jim Blandy committed
410
	}
411
      else
Jim Blandy's avatar
Jim Blandy committed
412
	{
413 414
	  int len;
	  for (i = 0; i < size_byte; i += len)
415
	    {
416 417
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
	      insert_char (ch);
418
	    }
Jim Blandy's avatar
Jim Blandy committed
419
	}
420 421 422 423 424 425 426 427 428 429
      
#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
430

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

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

459
static void
Jim Blandy's avatar
Jim Blandy committed
460 461 462 463
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
464
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
    {
      int chars;

      if (STRING_MULTIBYTE (string))
	chars = XSTRING (string)->size;
      else if (EQ (printcharfun, Qt)
	       ? ! NILP (buffer_defaults.enable_multibyte_characters)
	       : ! NILP (current_buffer->enable_multibyte_characters))
	chars = multibyte_chars_in_text (XSTRING (string)->data,
					 STRING_BYTES (XSTRING (string)));
      else
	chars = STRING_BYTES (XSTRING (string));

      /* strout is safe for output to a frame (echo area) or to print_buffer.  */
      strout (XSTRING (string)->data,
	      chars, STRING_BYTES (XSTRING (string)),
	      printcharfun, STRING_MULTIBYTE (string));
    }
Jim Blandy's avatar
Jim Blandy committed
483 484
  else
    {
485 486
      /* 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
487 488
      int i;
      int size = XSTRING (string)->size;
489
      int size_byte = STRING_BYTES (XSTRING (string));
Jim Blandy's avatar
Jim Blandy committed
490 491
      struct gcpro gcpro1;
      GCPRO1 (string);
492 493 494 495 496 497 498 499 500
      if (size == size_byte)
	for (i = 0; i < size; i++)
	  PRINTCHAR (XSTRING (string)->data[i]);
      else
	for (i = 0; i < size_byte; i++)
	  {
	    /* Here, we must convert each multi-byte form to the
	       corresponding character code before handing it to PRINTCHAR.  */
	    int len;
501 502
	    int ch = STRING_CHAR_AND_LENGTH (XSTRING (string)->data + i,
					     size_byte - i, len);
503 504 505 506 507
	    if (!CHAR_VALID_P (ch, 0))
	      {
		ch = XSTRING (string)->data[i];
		len = 1;
	      }
508 509 510
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
511 512 513 514 515
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
516
  "Output character CHARACTER to stream PRINTCHARFUN.\n\
Karl Heuer's avatar
Karl Heuer committed
517
PRINTCHARFUN defaults to the value of `standard-output' (which see).")
518 519
  (character, printcharfun)
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
520
{
521
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
522

Jim Blandy's avatar
Jim Blandy committed
523
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
524
    printcharfun = Vstandard_output;
525
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
526
  PRINTPREPARE;
527
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
528
  PRINTFINISH;
529
  return character;
Jim Blandy's avatar
Jim Blandy committed
530 531
}

532 533
/* 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
534 535
   Do not use this on the contents of a Lisp string.  */

536
void
Jim Blandy's avatar
Jim Blandy committed
537 538 539 540
write_string (data, size)
     char *data;
     int size;
{
541
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
542 543 544 545 546
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
547
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
548 549 550
  PRINTFINISH;
}

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

555
void
Jim Blandy's avatar
Jim Blandy committed
556 557 558 559 560
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
561
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
562 563

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


void
temp_output_buffer_setup (bufname)
    char *bufname;
{
573
  int count = specpdl_ptr - specpdl;
Jim Blandy's avatar
Jim Blandy committed
574 575 576
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

577 578
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
579 580
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

581
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
582
  current_buffer->read_only = Qnil;
583 584 585 586 587 588
  current_buffer->filename = Qnil;
  current_buffer->undo_list = Qt;
  current_buffer->overlays_before = Qnil;
  current_buffer->overlays_after = Qnil;
  current_buffer->enable_multibyte_characters
    = buffer_defaults.enable_multibyte_characters;
Jim Blandy's avatar
Jim Blandy committed
589
  Ferase_buffer ();
590
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
591

592 593 594 595 596
  call1 (Vrun_hooks, Qtemp_buffer_setup_hook);

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
597 598 599 600 601
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
     char *bufname;
Andreas Schwab's avatar
Andreas Schwab committed
602
     Lisp_Object (*function) P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
603 604 605 606
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
607
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
608

609
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
610 611 612
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
613
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
614 615 616

  val = (*function) (args);

617
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
618
  temp_output_buffer_show (buf);
619
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
620 621 622 623 624 625 626 627 628 629 630

  return unbind_to (count, val);
}

DEFUN ("with-output-to-temp-buffer", Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
       1, UNEVALLED, 0,
  "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.\n\
The buffer is cleared out initially, and marked as unmodified when done.\n\
All output done by BODY is inserted in that buffer by default.\n\
The buffer is displayed in another window, but not selected.\n\
The value of the last form in BODY is returned.\n\
631 632 633 634 635 636 637 638
If BODY does not finish normally, the buffer BUFNAME is not displayed.\n\
\n\
The hook `temp-buffer-setup-hook' is run before BODY,\n\
with the buffer BUFNAME temporarily current.\n\
The hook `temp-buffer-show-hook' is run after the buffer is displayed,\n\
with the buffer temporarily current, and the window that was used\n\
to display it temporarily selected.\n\
\n\
639
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
640 641
to get the buffer displayed instead of just displaying the non-selected\n\
buffer and calling the hook.  It gets one argument, the buffer to display.")
Jim Blandy's avatar
Jim Blandy committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
  (args)
     Lisp_Object args;
{
  struct gcpro gcpro1;
  Lisp_Object name;
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
  UNGCPRO;

  CHECK_STRING (name, 0);
  temp_output_buffer_setup (XSTRING (name)->data);
  buf = Vstandard_output;

  val = Fprogn (Fcdr (args));

  temp_output_buffer_show (buf);

  return unbind_to (count, val);
}
664

Jim Blandy's avatar
Jim Blandy committed
665 666 667 668

static void print ();

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
669 670
  "Output a newline to stream PRINTCHARFUN.\n\
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.")
Jim Blandy's avatar
Jim Blandy committed
671 672 673
  (printcharfun)
     Lisp_Object printcharfun;
{
674
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
675

Jim Blandy's avatar
Jim Blandy committed
676
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
677 678 679 680 681 682 683 684 685 686 687
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
  "Output the printed representation of OBJECT, any Lisp object.\n\
Quoting characters are printed when needed to make output that `read'\n\
can handle, whenever this is possible.\n\
Karl Heuer's avatar
Karl Heuer committed
688
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
689 690
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
691
{
692
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
693 694 695 696

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
697
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
698 699 700
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
701
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
702
  PRINTFINISH;
703
  return object;
Jim Blandy's avatar
Jim Blandy committed
704 705 706 707 708 709 710 711 712 713
}

/* 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,
  "Return a string containing the printed representation of OBJECT,\n\
any Lisp object.  Quoting characters are used when needed to make output\n\
that `read' can handle, whenever this is possible, unless the optional\n\
second argument NOESCAPE is non-nil.")
714 715
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
716
{
717 718
  PRINTDECLARE;
  Lisp_Object printcharfun;
719 720 721 722 723 724 725 726
  struct gcpro gcpro1, gcpro2;
  Lisp_Object tem;

  /* 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.  */
  tem = Vdeactivate_mark;
  GCPRO2 (object, tem);
Jim Blandy's avatar
Jim Blandy committed
727 728 729 730

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print_depth = 0;
731
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
732 733 734
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
735
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
736 737 738

  Ferase_buffer ();
  set_buffer_internal (old);
739 740

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
741 742
  UNGCPRO;

743
  return object;
Jim Blandy's avatar
Jim Blandy committed
744 745 746 747 748 749
}

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
  "Output the printed representation of OBJECT, any Lisp object.\n\
No quoting characters are used; no delimiters are printed around\n\
the contents of strings.\n\
Karl Heuer's avatar
Karl Heuer committed
750
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
751 752
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
753
{
754
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
755

Jim Blandy's avatar
Jim Blandy committed
756
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
757 758 759
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
760
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
761
  PRINTFINISH;
762
  return object;
Jim Blandy's avatar
Jim Blandy committed
763 764 765 766 767 768
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
  "Output the printed representation of OBJECT, with newlines around it.\n\
Quoting characters are printed when needed to make output that `read'\n\
can handle, whenever this is possible.\n\
Karl Heuer's avatar
Karl Heuer committed
769
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
770 771
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
772
{
773
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
774 775 776 777 778 779
  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
780
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
781
    printcharfun = Vstandard_output;
782
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
783 784 785
  PRINTPREPARE;
  print_depth = 0;
  PRINTCHAR ('\n');
786
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
787 788 789 790 791 792 793
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
794
  return object;
Jim Blandy's avatar
Jim Blandy committed
795 796 797 798 799 800
}

/* 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
801 802
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
  "Write CHARACTER to stderr.\n\
Jim Blandy's avatar
Jim Blandy committed
803 804
You can call print while debugging emacs, and pass it this function\n\
to make it write to the debugging output.\n")
Jim Blandy's avatar
Jim Blandy committed
805 806
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
807 808 809
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
810 811 812 813 814 815 816 817 818

#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
819 820
  return character;
}
821 822 823 824 825 826 827 828

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
829
  fprintf (stderr, "\r\n");
830
}
Jim Blandy's avatar
Jim Blandy committed
831

832 833 834 835 836 837 838 839 840 841
DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
       1, 1, 0,
  "Convert an error value (ERROR-SYMBOL . DATA) to an error message.")
  (obj)
     Lisp_Object obj;
{
  struct buffer *old = current_buffer;
  Lisp_Object original, printcharfun, value;
  struct gcpro gcpro1;

842 843 844 845 846 847 848 849 850
  /* 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.  */
  if (CONSP (obj) && EQ (XCONS (obj)->car, Qerror)
      && CONSP (XCONS (obj)->cdr)
      && STRINGP (XCONS (XCONS (obj)->cdr)->car)
      && NILP (XCONS (XCONS (obj)->cdr)->cdr))
    return XCONS (XCONS (obj)->cdr)->car;

851
  print_error_message (obj, Vprin1_to_string_buffer);
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866

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

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

  return value;
}

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

867
void
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
print_error_message (data, stream)
     Lisp_Object data, stream;
{
  Lisp_Object errname, errmsg, file_error, tail;
  struct gcpro gcpro1;
  int i;

  errname = Fcar (data);

  if (EQ (errname, Qerror))
    {
      data = Fcdr (data);
      if (!CONSP (data)) data = Qnil;
      errmsg = Fcar (data);
      file_error = Qnil;
    }
  else
    {
      errmsg = Fget (errname, Qerror_message);
      file_error = Fmemq (Qfile_error,
			  Fget (errname, Qerror_conditions));
    }

  /* 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.  */
898
  if (!NILP (file_error) && CONSP (tail))
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
    errmsg = XCONS (tail)->car, tail = XCONS (tail)->cdr;

  if (STRINGP (errmsg))
    Fprinc (errmsg, stream);
  else
    write_string_1 ("peculiar error", -1, stream);

  for (i = 0; CONSP (tail); tail = Fcdr (tail), i++)
    {
      write_string_1 (i ? ", " : ": ", 2, stream);
      if (!NILP (file_error))
	Fprinc (Fcar (tail), stream);
      else
	Fprin1 (Fcar (tail), stream);
    }
  UNGCPRO;
}

Jim Blandy's avatar
Jim Blandy committed
917 918 919
#ifdef LISP_FLOAT_TYPE

/*
920
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
921
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925 926 927 928 929 930 931
 * 20d float_output_format, with the negative of the C-constant "HUGE"
 * from <math.h>.
 * 
 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
 * 
 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
 * case of -1e307 in 20d float_output_format. What is one to do (short of
 * re-writing _doprnt to be more sane)?
 * 			-wsr
 */
932 933 934

void
float_to_string (buf, data)
935
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
936 937
     double data;
{
938
  unsigned char *cp;
939
  int width;
Jim Blandy's avatar
Jim Blandy committed
940
      
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
  /* Check for plus infinity in a way that won't lose
     if there is no plus infinity.  */
  if (data == data / 2 && data > 1.0)
    {
      strcpy (buf, "1.0e+INF");
      return;
    }
  /* Likewise for minus infinity.  */
  if (data == data / 2 && data < -1.0)
    {
      strcpy (buf, "-1.0e+INF");
      return;
    }
  /* Check for NaN in a way that won't fail if there are no NaNs.  */
  if (! (data * 0.0 >= 0.0))
    {
      strcpy (buf, "0.0e+NaN");
      return;
    }

Jim Blandy's avatar
Jim Blandy committed
961
  if (NILP (Vfloat_output_format)
962
      || !STRINGP (Vfloat_output_format))
Jim Blandy's avatar
Jim Blandy committed
963
  lose:
964
    {
Paul Eggert's avatar
Paul Eggert committed
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
      /* Generate the fewest number of digits that represent the
	 floating point value without losing information.
	 The following method is simple but a bit slow.
	 For ideas about speeding things up, please see:

	 Guy L Steele Jr & Jon L White, How to print floating-point numbers
	 accurately.  SIGPLAN notices 25, 6 (June 1990), 112-126.

	 Robert G Burger & R Kent Dybvig, Printing floating point numbers
	 quickly and accurately, SIGPLAN notices 31, 5 (May 1996), 108-116.  */

      width = fabs (data) < DBL_MIN ? 1 : DBL_DIG;
      do
	sprintf (buf, "%.*g", width, data);
      while (width++ < DOUBLE_DIGITS_BOUND && atof (buf) != data);
980
    }
Jim Blandy's avatar
Jim Blandy committed
981 982 983 984 985 986 987 988 989 990 991 992 993
  else			/* oink oink */
    {
      /* Check that the spec we have is fully valid.
	 This means not only valid for printf,
	 but meant for floats, and reasonable.  */
      cp = XSTRING (Vfloat_output_format)->data;

      if (cp[0] != '%')
	goto lose;
      if (cp[1] != '.')
	goto lose;

      cp += 2;
994 995

      /* Check the width specification.  */
996
      width = -1;
997
      if ('0' <= *cp && *cp <= '9')
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
	{
	  width = 0;
	  do
	    width = (width * 10) + (*cp++ - '0');
	  while (*cp >= '0' && *cp <= '9');

	  /* A precision of zero is valid only for %f.  */
	  if (width > DBL_DIG
	      || (width == 0 && *cp != 'f'))
	    goto lose;
	}
Jim Blandy's avatar
Jim Blandy committed
1009 1010 1011 1012 1013 1014 1015 1016 1017

      if (*cp != 'e' && *cp != 'f' && *cp != 'g')
	goto lose;

      if (cp[1] != 0)
	goto lose;

      sprintf (buf, XSTRING (Vfloat_output_format)->data, data);
    }
1018

1019 1020
  /* Make sure there is a decimal point with digit after, or an
     exponent, so that the value is readable as a float.  But don't do
1021 1022 1023
     this with "%.0f"; it's valid for that not to produce a decimal
     point.  Note that width can be 0 only for %.0f.  */
  if (width != 0)
1024
    {
1025 1026 1027
      for (cp = buf; *cp; cp++)
	if ((*cp < '0' || *cp > '9') && *cp != '-')
	  break;
1028

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
      if (*cp == '.' && cp[1] == 0)
	{
	  cp[1] = '0';
	  cp[2] = 0;
	}

      if (*cp == 0)
	{
	  *cp++ = '.';
	  *cp++ = '0';
	  *cp++ = 0;
	}
1041
    }
Jim Blandy's avatar
Jim Blandy committed
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
}
#endif /* LISP_FLOAT_TYPE */

static void
print (obj, printcharfun, escapeflag)
     Lisp_Object obj;
     register Lisp_Object printcharfun;
     int escapeflag;
{
  char buf[30];

  QUIT;

1055 1056 1057
#if 1  /* I'm not sure this is really worth doing.  */
  /* Detect circularities and truncate them.
     No need to offer any alternative--this is better than an error.  */
1058
  if (CONSP (obj) || VECTORP (obj) || COMPILEDP (obj))
1059 1060 1061 1062 1063 1064
    {
      int i;
      for (i = 0; i < print_depth; i++)
	if (EQ (obj, being_printed[i]))
	  {
	    sprintf (buf, "#%d", i);
1065
	    strout (buf, -1, -1, printcharfun, 0);
1066 1067 1068 1069 1070 1071
	    return;
	  }
    }
#endif

  being_printed[print_depth] = obj;
Jim Blandy's avatar
Jim Blandy committed
1072 1073
  print_depth++;

1074
  if (print_depth > PRINT_CIRCLE)
Jim Blandy's avatar
Jim Blandy committed
1075 1076 1077 1078 1079 1080 1081 1082 1083
    error ("Apparently circular structure being printed");
#ifdef MAX_PRINT_CHARS
  if (max_print && print_chars > max_print)
    {
      PRINTCHAR ('\n');
      print_chars = 0;
    }
#endif /* MAX_PRINT_CHARS */

1084
  switch (XGCTYPE (obj))
Jim Blandy's avatar
Jim Blandy committed
1085
    {
1086
    case Lisp_Int:
1087 1088 1089 1090 1091 1092
      if (sizeof (int) == sizeof (EMACS_INT))
	sprintf (buf, "%d", XINT (obj));
      else if (sizeof (long) == sizeof (EMACS_INT))
	sprintf (buf, "%ld", XINT (obj));
      else
	abort ();
1093
      strout (buf, -1, -1, printcharfun, 0);
1094 1095
      break;

Karl Heuer's avatar
Karl Heuer committed
1096
#ifdef LISP_FLOAT_TYPE
1097 1098 1099
    case Lisp_Float:
      {
	char pigbuf[350];	/* see comments in float_to_string */
Jim Blandy's avatar
Jim Blandy committed
1100

1101
	float_to_string (pigbuf, XFLOAT(obj)->data);
1102
	strout (pigbuf, -1, -1, printcharfun, 0);
1103 1104
      }
      break;
Karl Heuer's avatar
Karl Heuer committed
1105
#endif
1106 1107

    case Lisp_String:
Jim Blandy's avatar
Jim Blandy committed
1108 1109 1110 1111
      if (!escapeflag)
	print_string (obj, printcharfun);
      else
	{
1112
	  register int i, i_byte;
Jim Blandy's avatar
Jim Blandy committed
1113 1114
	  register unsigned char c;
	  struct gcpro gcpro1;
1115
	  unsigned char *str;
1116
	  int size_byte;
1117 1118 1119
	  /* 1 means we must ensure that the next character we output
	     cannot be taken as part of a hex character escape.  */
	  int need_nonhex = 0;
Jim Blandy's avatar
Jim Blandy committed
1120

Richard M. Stallman's avatar
Richard M. Stallman committed
1121 1122 1123 1124 1125 1126 1127 1128 1129
	  GCPRO1 (obj);

#ifdef USE_TEXT_PROPERTIES
	  if (!NULL_INTERVAL_P (XSTRING (obj)->intervals))
	    {
	      PRINTCHAR ('#');
	      PRINTCHAR ('(');
	    }
#endif