print.c 48.4 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 27 28
#include <stdio.h>
#include "lisp.h"

#ifndef standalone
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
29
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31 32 33 34
#include "window.h"
#include "process.h"
#include "dispextern.h"
#include "termchar.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
35
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
36 37
#endif /* not standalone */

Richard M. Stallman's avatar
Richard M. Stallman committed
38 39 40 41
#ifdef USE_TEXT_PROPERTIES
#include "intervals.h"
#endif

Jim Blandy's avatar
Jim Blandy committed
42 43
Lisp_Object Vstandard_output, Qstandard_output;

Erik Naggum's avatar
Erik Naggum committed
44 45 46
/* 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
47 48
#ifdef LISP_FLOAT_TYPE
Lisp_Object Vfloat_output_format, Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
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 76

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
/* 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;

Lisp_Object Qprint_escape_newlines;

Erik Naggum's avatar
Erik Naggum committed
133 134 135 136
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

137 138 139
/* 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.  */
140

141
Lisp_Object Vprint_gensym;
142 143 144 145 146

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

147
Lisp_Object Vprint_gensym_alist;
Erik Naggum's avatar
Erik Naggum committed
148

149
/* Nonzero means print newline to stdout before next minibuffer message.
Jim Blandy's avatar
Jim Blandy committed
150 151 152
   Defined in xdisp.c */

extern int noninteractive_need_newline;
153

154 155
extern int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
156 157 158 159
#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
160 161

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214

#if 0
/* Convert between chars and GLYPHs */

int
glyphlen (glyphs)
     register GLYPH *glyphs;
{
  register int i = 0;

  while (glyphs[i])
    i++;
  return i;
}

void
str_to_glyph_cpy (str, glyphs)
     char *str;
     GLYPH *glyphs;
{
  register GLYPH *gp = glyphs;
  register char *cp = str;

  while (*cp)
    *gp++ = *cp++;
}

void
str_to_glyph_ncpy (str, glyphs, n)
     char *str;
     GLYPH *glyphs;
     register int n;
{
  register GLYPH *gp = glyphs;
  register char *cp = str;

  while (n-- > 0)
    *gp++ = *cp++;
}

void
glyph_to_str_cpy (glyphs, str)
     GLYPH *glyphs;
     char *str;
{
  register GLYPH *gp = glyphs;
  register char *cp = str;

  while (*gp)
    *str++ = *gp++ & 0377;
}
#endif

215
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
216 217

/* Lisp functions to do output using a stream
218 219 220 221 222
   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,
   or call strout to output a block of characters.
Jim Blandy's avatar
Jim Blandy committed
223 224
*/ 

225 226 227
#define PRINTDECLARE						\
   struct buffer *old = current_buffer;				\
   int old_point = -1, start_point;				\
228
   int old_point_byte, start_point_byte;			\
229 230
   int specpdl_count = specpdl_ptr - specpdl;			\
   int free_print_buffer = 0;					\
231 232
   Lisp_Object original

233 234 235
#define PRINTPREPARE						\
   original = printcharfun;					\
   if (NILP (printcharfun)) printcharfun = Qt;			\
236
   if (BUFFERP (printcharfun))					\
237 238
     {								\
       if (XBUFFER (printcharfun) != current_buffer)		\
239
	 Fset_buffer (printcharfun);				\
240 241
       printcharfun = Qnil;					\
     }								\
242
   if (MARKERP (printcharfun))					\
243 244
     {								\
       if (!(XMARKER (original)->buffer))			\
245 246 247
         error ("Marker does not point anywhere");		\
       if (XMARKER (original)->buffer != current_buffer)	\
         set_buffer_internal (XMARKER (original)->buffer);	\
248
       old_point = PT;						\
249 250 251
       old_point_byte = PT_BYTE;				\
       SET_PT_BOTH (marker_position (printcharfun),		\
		    marker_byte_position (printcharfun));	\
252
       start_point = PT;					\
253
       start_point_byte = PT_BYTE;				\
254 255
       printcharfun = Qnil;					\
     }								\
256 257
   if (NILP (printcharfun))					\
     {								\
258
       Lisp_Object string;					\
259
       if (print_buffer != 0)					\
260
	 {							\
261 262 263
	   string = make_string_from_bytes (print_buffer,	\
					    print_buffer_pos,	\
					    print_buffer_pos_byte); \
264 265
	   record_unwind_protect (print_unwind, string);	\
	 }							\
266 267 268 269
       else							\
	 {							\
           print_buffer_size = 1000;				\
           print_buffer = (char *) xmalloc (print_buffer_size);	\
270
	   free_print_buffer = 1;				\
271
	 }							\
272
       print_buffer_pos = 0;					\
273
       print_buffer_pos_byte = 0;				\
274
     }								\
275 276
   if (!CONSP (Vprint_gensym))					\
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
277

278
#define PRINTFINISH					\
279
   if (NILP (printcharfun))				\
280 281
     insert_1_both (print_buffer, print_buffer_pos,	\
		    print_buffer_pos_byte, 0, 1, 0);	\
282
   if (free_print_buffer)				\
283
     {							\
284
       xfree (print_buffer);				\
285 286
       print_buffer = 0;				\
     }							\
287
   unbind_to (specpdl_count, Qnil);			\
288
   if (MARKERP (original))				\
289
     set_marker_both (original, Qnil, PT, PT_BYTE);	\
290
   if (old_point >= 0)					\
291 292 293 294
     SET_PT_BOTH (old_point + (old_point >= start_point	\
			       ? PT - start_point : 0), \
		  old_point_byte + (old_point_byte >= start_point_byte	\
			       ? PT_BYTE - start_point_byte : 0));	\
295
   if (old != current_buffer)				\
296
     set_buffer_internal (old);				\
297 298
   if (!CONSP (Vprint_gensym))				\
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
299 300 301

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

302 303 304 305 306 307 308
/* 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)))))

309 310 311 312 313 314 315 316 317
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
static Lisp_Object
print_unwind (saved_text)
     Lisp_Object saved_text;
{
  bcopy (XSTRING (saved_text)->data, print_buffer, XSTRING (saved_text)->size);
}

318
/* Index of first unused element of FRAME_MESSAGE_BUF (mini_frame). */
Jim Blandy's avatar
Jim Blandy committed
319 320 321 322
static int printbufidx;

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
323
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
324 325 326 327 328 329 330 331 332 333 334
     Lisp_Object fun;
{
  Lisp_Object ch1;

#ifdef MAX_PRINT_CHARS
  if (max_print)
    print_chars++;
#endif /* MAX_PRINT_CHARS */
#ifndef standalone
  if (EQ (fun, Qnil))
    {
Karl Heuer's avatar
Karl Heuer committed
335
      int len;
336
      unsigned char work[4], *str;
Karl Heuer's avatar
Karl Heuer committed
337

Jim Blandy's avatar
Jim Blandy committed
338
      QUIT;
Karl Heuer's avatar
Karl Heuer committed
339
      len = CHAR_STRING (ch, work, str);
340
      if (print_buffer_pos_byte + len >= print_buffer_size)
341 342
	print_buffer = (char *) xrealloc (print_buffer,
					  print_buffer_size *= 2);
343 344 345
      bcopy (str, print_buffer + print_buffer_pos_byte, len);
      print_buffer_pos += 1;
      print_buffer_pos_byte += len;
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350
      return;
    }

  if (EQ (fun, Qt))
    {
351
      FRAME_PTR mini_frame
352
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));
Karl Heuer's avatar
Karl Heuer committed
353 354
      unsigned char work[4], *str;
      int len = CHAR_STRING (ch, work, str);
355

356 357
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
358 359
      if (noninteractive)
	{
Karl Heuer's avatar
Karl Heuer committed
360 361
	  while (len--)
	    putchar (*str), str++;
Jim Blandy's avatar
Jim Blandy committed
362 363 364 365
	  noninteractive_need_newline = 1;
	  return;
	}

366
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
367 368
	  || !message_buf_print)
	{
369
	  message_log_maybe_newline ();
370
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
371
	  printbufidx = 0;
372
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
373
	  message_buf_print = 1;
374 375 376 377 378 379 380 381 382 383 384

	  if (minibuffer_auto_raise)
	    {
	      Lisp_Object mini_window;

	      /* Get the frame containing the minibuffer
		 that the selected frame is using.  */
	      mini_window = FRAME_MINIBUF_WINDOW (selected_frame);

	      Fraise_frame  (WINDOW_FRAME (XWINDOW (mini_window)));
	    }
Jim Blandy's avatar
Jim Blandy committed
385 386
	}

387
      message_dolog (str, len, 0, len > 1);
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406

      /* Convert message to multibyte if we are now adding multibyte text.  */
      if (! NILP (current_buffer->enable_multibyte_characters)
	  && ! message_enable_multibyte
	  && printbufidx > 0)
	{
	  int size = count_size_as_multibyte (FRAME_MESSAGE_BUF (mini_frame),
					      printbufidx);
	  unsigned char *tembuf = (unsigned char *) alloca (size + 1);
	  copy_text (FRAME_MESSAGE_BUF (mini_frame), tembuf, printbufidx,
		     0, 1);
	  printbufidx = size;
	  if (printbufidx > FRAME_MESSAGE_BUF_SIZE (mini_frame))
	    printbufidx = FRAME_MESSAGE_BUF_SIZE (mini_frame);
	  bcopy (tembuf, FRAME_MESSAGE_BUF (mini_frame), printbufidx);
	}
      message_enable_multibyte
	= ! NILP (current_buffer->enable_multibyte_characters);

Karl Heuer's avatar
Karl Heuer committed
407 408 409
      if (printbufidx < FRAME_MESSAGE_BUF_SIZE (mini_frame) - len)
	bcopy (str, &FRAME_MESSAGE_BUF (mini_frame)[printbufidx], len),
	printbufidx += len;
410
      FRAME_MESSAGE_BUF (mini_frame)[printbufidx] = 0;
411
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
412 413 414 415 416

      return;
    }
#endif /* not standalone */

417
  XSETFASTINT (ch1, ch);
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421
  call1 (fun, ch1);
}

static void
422
strout (ptr, size, size_byte, printcharfun, multibyte)
Jim Blandy's avatar
Jim Blandy committed
423
     char *ptr;
424
     int size, size_byte;
Jim Blandy's avatar
Jim Blandy committed
425
     Lisp_Object printcharfun;
426
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
427 428 429
{
  int i = 0;

Karl Heuer's avatar
Karl Heuer committed
430
  if (size < 0)
431
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
432

Jim Blandy's avatar
Jim Blandy committed
433 434
  if (EQ (printcharfun, Qnil))
    {
435
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
436
	{
437
	  print_buffer_size = print_buffer_size * 2 + size_byte;
438 439 440
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
441
      bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
442
      print_buffer_pos += size;
443
      print_buffer_pos_byte += size_byte;
444

Jim Blandy's avatar
Jim Blandy committed
445 446
#ifdef MAX_PRINT_CHARS
      if (max_print)
447
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
448 449 450 451 452
#endif /* MAX_PRINT_CHARS */
      return;
    }
  if (EQ (printcharfun, Qt))
    {
453
      FRAME_PTR mini_frame
454 455
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));

456 457
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
458 459
#ifdef MAX_PRINT_CHARS
      if (max_print)
Karl Heuer's avatar
Karl Heuer committed
460
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
461 462 463 464
#endif /* MAX_PRINT_CHARS */

      if (noninteractive)
	{
465
	  fwrite (ptr, 1, size_byte, stdout);
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469
	  noninteractive_need_newline = 1;
	  return;
	}

470
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
471 472
	  || !message_buf_print)
	{
473
	  message_log_maybe_newline ();
474
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
475
	  printbufidx = 0;
476
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
477
	  message_buf_print = 1;
478 479 480 481 482 483 484 485 486 487 488

	  if (minibuffer_auto_raise)
	    {
	      Lisp_Object mini_window;

	      /* Get the frame containing the minibuffer
		 that the selected frame is using.  */
	      mini_window = FRAME_MINIBUF_WINDOW (selected_frame);

	      Fraise_frame  (WINDOW_FRAME (XWINDOW (mini_window)));
	    }
Jim Blandy's avatar
Jim Blandy committed
489 490
	}

491 492
      message_dolog (ptr, size_byte, 0, multibyte);
      if (size_byte > FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1)
Karl Heuer's avatar
Karl Heuer committed
493
	{
494
	  size_byte = FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1;
Karl Heuer's avatar
Karl Heuer committed
495
	  /* Rewind incomplete multi-byte form.  */
496
	  while (size_byte && (unsigned char) ptr[size] >= 0xA0) size--;
Karl Heuer's avatar
Karl Heuer committed
497
	}
498 499
      bcopy (ptr, &FRAME_MESSAGE_BUF (mini_frame) [printbufidx], size_byte);
      printbufidx += size_byte;
500
      echo_area_glyphs_length = printbufidx;
501
      FRAME_MESSAGE_BUF (mini_frame) [printbufidx] = 0;
Jim Blandy's avatar
Jim Blandy committed
502 503 504 505

      return;
    }

Karl Heuer's avatar
Karl Heuer committed
506
  i = 0;
507 508 509 510
  if (size == size_byte)
    while (i < size_byte)
      {
	int ch = ptr[i++];
Karl Heuer's avatar
Karl Heuer committed
511

512 513 514 515 516 517 518 519 520 521 522 523 524
	PRINTCHAR (ch);
      }
  else
    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;
      }
Jim Blandy's avatar
Jim Blandy committed
525 526 527
}

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

531
static void
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
536 537
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
    /* strout is safe for output to a frame (echo area) or to print_buffer.  */
538 539
    strout (XSTRING (string)->data,
	    XSTRING (string)->size,
540
	    STRING_BYTES (XSTRING (string)),
541
	    printcharfun, STRING_MULTIBYTE (string));
Jim Blandy's avatar
Jim Blandy committed
542 543
  else
    {
544 545
      /* 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
546 547
      int i;
      int size = XSTRING (string)->size;
548
      int size_byte = STRING_BYTES (XSTRING (string));
Jim Blandy's avatar
Jim Blandy committed
549 550
      struct gcpro gcpro1;
      GCPRO1 (string);
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
      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;
	    int ch = STRING_CHAR_AND_LENGTH (XSTRING (string)->data + i,
					     size_byte - i, len);

	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
566 567 568 569 570
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
571
  "Output character CHARACTER to stream PRINTCHARFUN.\n\
Karl Heuer's avatar
Karl Heuer committed
572
PRINTCHARFUN defaults to the value of `standard-output' (which see).")
573 574
  (character, printcharfun)
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
575
{
576
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
577

Jim Blandy's avatar
Jim Blandy committed
578
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
579
    printcharfun = Vstandard_output;
580
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
581
  PRINTPREPARE;
582
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
583
  PRINTFINISH;
584
  return character;
Jim Blandy's avatar
Jim Blandy committed
585 586
}

587 588
/* 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
589 590
   Do not use this on the contents of a Lisp string.  */

591
void
Jim Blandy's avatar
Jim Blandy committed
592 593 594 595
write_string (data, size)
     char *data;
     int size;
{
596
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
597 598 599 600 601
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
602
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
603 604 605
  PRINTFINISH;
}

606 607
/* 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
608 609
   Do not use this on the contents of a Lisp string.  */

610
void
Jim Blandy's avatar
Jim Blandy committed
611 612 613 614 615
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
616
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
617 618

  PRINTPREPARE;
619
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
  PRINTFINISH;
}


#ifndef standalone

void
temp_output_buffer_setup (bufname)
    char *bufname;
{
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

  Fset_buffer (Fget_buffer_create (build_string (bufname)));

635
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
636
  current_buffer->read_only = Qnil;
637 638 639 640 641 642
  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
643 644
  Ferase_buffer ();

645
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
646 647 648 649 650 651 652 653
  specbind (Qstandard_output, buf);

  set_buffer_internal (old);
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
     char *bufname;
654
     Lisp_Object (*function) ();
Jim Blandy's avatar
Jim Blandy committed
655 656 657 658
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
659
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
660

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

  val = (*function) (args);

669
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
670
  temp_output_buffer_show (buf);
671
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
672 673 674 675 676 677 678 679 680 681 682 683

  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\
If BODY does not finish normally, the buffer BUFNAME is not displayed.\n\n\
684
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
Jim Blandy's avatar
Jim Blandy committed
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
to get the buffer displayed.  It gets one argument, the buffer to display.")
  (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);
}
#endif /* not standalone */

static void print ();

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
713 714
  "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
715 716 717
  (printcharfun)
     Lisp_Object printcharfun;
{
718
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
719

Jim Blandy's avatar
Jim Blandy committed
720
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
721 722 723 724 725 726 727 728 729 730 731
    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
732
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
733 734
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
735
{
736
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
737 738 739 740

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

/* 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.")
758 759
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
760
{
761 762
  PRINTDECLARE;
  Lisp_Object printcharfun;
763 764 765 766 767 768 769 770
  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
771 772 773 774

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print_depth = 0;
775
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
776 777 778
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
779
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
780 781 782

  Ferase_buffer ();
  set_buffer_internal (old);
783 784

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
785 786
  UNGCPRO;

787
  return object;
Jim Blandy's avatar
Jim Blandy committed
788 789 790 791 792 793
}

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
794
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
795 796
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
797
{
798
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
799

Jim Blandy's avatar
Jim Blandy committed
800
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
801 802 803
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
804
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
805
  PRINTFINISH;
806
  return object;
Jim Blandy's avatar
Jim Blandy committed
807 808 809 810 811 812
}

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
813
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
814 815
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
816
{
817
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
818 819 820 821 822 823
  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
824
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
825
    printcharfun = Vstandard_output;
826
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
827 828 829
  PRINTPREPARE;
  print_depth = 0;
  PRINTCHAR ('\n');
830
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
831 832 833 834 835 836 837
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
838
  return object;
Jim Blandy's avatar
Jim Blandy committed
839 840 841 842 843 844
}

/* 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
845 846
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
847 848
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
849 850
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
851 852 853
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
854 855 856 857 858 859 860 861 862

#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
863 864
  return character;
}
865 866 867 868 869 870 871 872

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
873
  fprintf (stderr, "\r\n");
874
}
Jim Blandy's avatar
Jim Blandy committed
875

876 877 878 879 880 881 882 883 884 885
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;

886 887 888 889 890 891 892 893 894
  /* 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;

895
  print_error_message (obj, Vprin1_to_string_buffer);
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910

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

911
void
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
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.  */
  if (!NILP (file_error) && !NILP (tail))
    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
961 962 963
#ifdef LISP_FLOAT_TYPE

/*
964
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
965
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
966 967 968 969 970 971 972 973 974 975
 * 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
 */
976 977 978

void
float_to_string (buf, data)
979
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
980 981
     double data;
{
982
  unsigned char *cp;
983
  int width;
Jim Blandy's avatar
Jim Blandy committed
984
      
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
  /* 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
1005
  if (NILP (Vfloat_output_format)
1006
      || !STRINGP (Vfloat_output_format))
Jim Blandy's avatar
Jim Blandy committed
1007
  lose:
1008
    {
Paul Eggert's avatar
Paul Eggert committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
      /* 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);
1024
    }
Jim Blandy's avatar
Jim Blandy committed
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
  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;
1038 1039

      /* Check the width specification.  */
1040
      width = -1;
1041
      if ('0' <= *cp && *cp <= '9')
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
	{
	  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
1053 1054 1055 1056 1057 1058 1059 1060 1061

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

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

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

1063 1064
  /* 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
1065 1066 1067
     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)
1068
    {
1069 1070 1071
      for (cp = buf; *cp; cp++)
	if ((*cp < '0' || *cp > '9') && *cp != '-')
	  break;
1072

1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
      if (*cp == '.' && cp[1] == 0)
	{
	  cp[1] = '0';
	  cp[2] = 0;
	}

      if (*cp == 0)
	{
	  *cp++ = '.';
	  *cp++ = '0';
	  *cp++ = 0;
	}
1085
    }
Jim Blandy's avatar
Jim Blandy committed
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
}
#endif /* LISP_FLOAT_TYPE */

static void
print (obj, printcharfun, escapeflag)
     Lisp_Object obj;
     register Lisp_Object printcharfun;
     int escapeflag;
{
  char buf[30];

  QUIT;

1099 1100 1101
#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.  */
Karl Heuer's avatar