print.c 50.5 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;

133 134 135 136 137
/* Nonzero means to print single-byte non-ascii characters in strings as
   octal escapes.  */

int print_escape_nonascii;

Erik Naggum's avatar
Erik Naggum committed
138 139 140 141
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

142 143 144
/* 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.  */
145

146
Lisp_Object Vprint_gensym;
147 148 149 150 151

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

152
Lisp_Object Vprint_gensym_alist;
Erik Naggum's avatar
Erik Naggum committed
153

154
/* Nonzero means print newline to stdout before next minibuffer message.
Jim Blandy's avatar
Jim Blandy committed
155 156 157
   Defined in xdisp.c */

extern int noninteractive_need_newline;
158

159 160
extern int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
161 162 163 164
#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
165 166

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
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 215 216 217 218 219

#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

220
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
221 222

/* Lisp functions to do output using a stream
223 224 225 226 227
   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
228 229
*/ 

230 231 232
#define PRINTDECLARE						\
   struct buffer *old = current_buffer;				\
   int old_point = -1, start_point;				\
233
   int old_point_byte, start_point_byte;			\
234 235
   int specpdl_count = specpdl_ptr - specpdl;			\
   int free_print_buffer = 0;					\
236 237
   Lisp_Object original

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

283
#define PRINTFINISH					\
284
   if (NILP (printcharfun))				\
285 286
     insert_1_both (print_buffer, print_buffer_pos,	\
		    print_buffer_pos_byte, 0, 1, 0);	\
287
   if (free_print_buffer)				\
288
     {							\
289
       xfree (print_buffer);				\
290 291
       print_buffer = 0;				\
     }							\
292
   unbind_to (specpdl_count, Qnil);			\
293
   if (MARKERP (original))				\
294
     set_marker_both (original, Qnil, PT, PT_BYTE);	\
295
   if (old_point >= 0)					\
296 297 298 299
     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));	\
300
   if (old != current_buffer)				\
301
     set_buffer_internal (old);				\
302 303
   if (!CONSP (Vprint_gensym))				\
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
304 305 306

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

307 308 309 310 311 312 313
/* 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)))))

314 315 316 317 318 319 320 321 322
/* 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);
}

323
/* Index of first unused element of FRAME_MESSAGE_BUF (mini_frame). */
Jim Blandy's avatar
Jim Blandy committed
324 325 326 327
static int printbufidx;

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
328
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
329 330 331 332 333 334 335 336 337 338 339
     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
340
      int len;
341
      unsigned char work[4], *str;
Karl Heuer's avatar
Karl Heuer committed
342

Jim Blandy's avatar
Jim Blandy committed
343
      QUIT;
Karl Heuer's avatar
Karl Heuer committed
344
      len = CHAR_STRING (ch, work, str);
345
      if (print_buffer_pos_byte + len >= print_buffer_size)
346 347
	print_buffer = (char *) xrealloc (print_buffer,
					  print_buffer_size *= 2);
348 349 350
      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
351 352 353 354 355
      return;
    }

  if (EQ (fun, Qt))
    {
356
      FRAME_PTR mini_frame
357
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));
Karl Heuer's avatar
Karl Heuer committed
358 359
      unsigned char work[4], *str;
      int len = CHAR_STRING (ch, work, str);
360

361 362
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
363 364
      if (noninteractive)
	{
Karl Heuer's avatar
Karl Heuer committed
365 366
	  while (len--)
	    putchar (*str), str++;
Jim Blandy's avatar
Jim Blandy committed
367 368 369 370
	  noninteractive_need_newline = 1;
	  return;
	}

371
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
372 373
	  || !message_buf_print)
	{
374
	  message_log_maybe_newline ();
375
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
376
	  printbufidx = 0;
377
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
378
	  message_buf_print = 1;
379 380 381 382 383 384 385 386 387 388 389

	  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
390 391
	}

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

      /* 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))
406 407 408 409 410 411
	    {
	      printbufidx = FRAME_MESSAGE_BUF_SIZE (mini_frame);
	      /* Rewind incomplete multi-byte form.  */
	      while (printbufidx > 0 && tembuf[printbufidx] >= 0xA0)
		printbufidx--;
	    }
412
	  bcopy (tembuf, FRAME_MESSAGE_BUF (mini_frame), printbufidx);
413
	  message_enable_multibyte = 1;
414 415
	}

Karl Heuer's avatar
Karl Heuer committed
416 417 418
      if (printbufidx < FRAME_MESSAGE_BUF_SIZE (mini_frame) - len)
	bcopy (str, &FRAME_MESSAGE_BUF (mini_frame)[printbufidx], len),
	printbufidx += len;
419
      FRAME_MESSAGE_BUF (mini_frame)[printbufidx] = 0;
420
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
421 422 423 424 425

      return;
    }
#endif /* not standalone */

426
  XSETFASTINT (ch1, ch);
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430
  call1 (fun, ch1);
}

static void
431
strout (ptr, size, size_byte, printcharfun, multibyte)
Jim Blandy's avatar
Jim Blandy committed
432
     char *ptr;
433
     int size, size_byte;
Jim Blandy's avatar
Jim Blandy committed
434
     Lisp_Object printcharfun;
435
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
436 437 438
{
  int i = 0;

Karl Heuer's avatar
Karl Heuer committed
439
  if (size < 0)
440
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
441

Jim Blandy's avatar
Jim Blandy committed
442 443
  if (EQ (printcharfun, Qnil))
    {
444
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
445
	{
446
	  print_buffer_size = print_buffer_size * 2 + size_byte;
447 448 449
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
450
      bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
451
      print_buffer_pos += size;
452
      print_buffer_pos_byte += size_byte;
453

Jim Blandy's avatar
Jim Blandy committed
454 455
#ifdef MAX_PRINT_CHARS
      if (max_print)
456
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460 461
#endif /* MAX_PRINT_CHARS */
      return;
    }
  if (EQ (printcharfun, Qt))
    {
462
      FRAME_PTR mini_frame
463 464
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));

465 466
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
467 468
#ifdef MAX_PRINT_CHARS
      if (max_print)
Karl Heuer's avatar
Karl Heuer committed
469
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
470 471 472 473
#endif /* MAX_PRINT_CHARS */

      if (noninteractive)
	{
474
	  fwrite (ptr, 1, size_byte, stdout);
Jim Blandy's avatar
Jim Blandy committed
475 476 477 478
	  noninteractive_need_newline = 1;
	  return;
	}

479
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
480 481
	  || !message_buf_print)
	{
482
	  message_log_maybe_newline ();
483
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
484
	  printbufidx = 0;
485
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
486
	  message_buf_print = 1;
487 488 489 490 491 492 493 494 495 496 497

	  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
498 499
	}

500
      message_dolog (ptr, size_byte, 0, multibyte);
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523

      /* Convert message to multibyte if we are now adding multibyte text.  */
      if (multibyte
	  && ! 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);
	      /* Rewind incomplete multi-byte form.  */
	      while (printbufidx > 0 && tembuf[printbufidx] >= 0xA0)
		printbufidx--;
	    }

	  bcopy (tembuf, FRAME_MESSAGE_BUF (mini_frame), printbufidx);
	}

524 525 526
      if (multibyte)
	message_enable_multibyte = 1;

527
      /* Compute how much of the new text will fit there.  */
528
      if (size_byte > FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1)
Karl Heuer's avatar
Karl Heuer committed
529
	{
530
	  size_byte = FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1;
Karl Heuer's avatar
Karl Heuer committed
531
	  /* Rewind incomplete multi-byte form.  */
532 533
	  while (size_byte && (unsigned char) ptr[size_byte] >= 0xA0)
	    size_byte--;
Karl Heuer's avatar
Karl Heuer committed
534
	}
535 536

      /* Put that part of the new text in.  */
537 538
      bcopy (ptr, &FRAME_MESSAGE_BUF (mini_frame) [printbufidx], size_byte);
      printbufidx += size_byte;
539
      FRAME_MESSAGE_BUF (mini_frame) [printbufidx] = 0;
540
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
541 542 543 544

      return;
    }

Karl Heuer's avatar
Karl Heuer committed
545
  i = 0;
546 547 548 549
  if (size == size_byte)
    while (i < size_byte)
      {
	int ch = ptr[i++];
Karl Heuer's avatar
Karl Heuer committed
550

551 552 553 554 555 556 557 558 559 560 561 562 563
	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
564 565 566
}

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

570
static void
Jim Blandy's avatar
Jim Blandy committed
571 572 573 574
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
575
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
    {
      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
594 595
  else
    {
596 597
      /* 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
598 599
      int i;
      int size = XSTRING (string)->size;
600
      int size_byte = STRING_BYTES (XSTRING (string));
Jim Blandy's avatar
Jim Blandy committed
601 602
      struct gcpro gcpro1;
      GCPRO1 (string);
603 604 605 606 607 608 609 610 611
      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;
612 613
	    int ch = STRING_CHAR_AND_CHAR_LENGTH (XSTRING (string)->data + i,
						  size_byte - i, len);
614 615 616 617

	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
618 619 620 621 622
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
623
  "Output character CHARACTER to stream PRINTCHARFUN.\n\
Karl Heuer's avatar
Karl Heuer committed
624
PRINTCHARFUN defaults to the value of `standard-output' (which see).")
625 626
  (character, printcharfun)
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
627
{
628
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
629

Jim Blandy's avatar
Jim Blandy committed
630
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
631
    printcharfun = Vstandard_output;
632
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
633
  PRINTPREPARE;
634
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
635
  PRINTFINISH;
636
  return character;
Jim Blandy's avatar
Jim Blandy committed
637 638
}

639 640
/* 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
641 642
   Do not use this on the contents of a Lisp string.  */

643
void
Jim Blandy's avatar
Jim Blandy committed
644 645 646 647
write_string (data, size)
     char *data;
     int size;
{
648
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
649 650 651 652 653
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
654
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
655 656 657
  PRINTFINISH;
}

658 659
/* 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
660 661
   Do not use this on the contents of a Lisp string.  */

662
void
Jim Blandy's avatar
Jim Blandy committed
663 664 665 666 667
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
668
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
669 670

  PRINTPREPARE;
671
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
  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)));

687
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
688
  current_buffer->read_only = Qnil;
689 690 691 692 693 694
  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
695 696
  Ferase_buffer ();

697
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701 702 703 704 705
  specbind (Qstandard_output, buf);

  set_buffer_internal (old);
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
     char *bufname;
Andreas Schwab's avatar
Andreas Schwab committed
706
     Lisp_Object (*function) P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
707 708 709 710
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
711
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
712

713
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
714 715 716
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
717
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
718 719 720

  val = (*function) (args);

721
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
722
  temp_output_buffer_show (buf);
723
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
724 725 726 727 728 729 730 731 732 733 734 735

  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\
736
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
Jim Blandy's avatar
Jim Blandy committed
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
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
765 766
  "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
767 768 769
  (printcharfun)
     Lisp_Object printcharfun;
{
770
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
771

Jim Blandy's avatar
Jim Blandy committed
772
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
773 774 775 776 777 778 779 780 781 782 783
    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
784
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
785 786
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
787
{
788
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
789 790 791 792

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
793
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
794 795 796
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
797
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
798
  PRINTFINISH;
799
  return object;
Jim Blandy's avatar
Jim Blandy committed
800 801 802 803 804 805 806 807 808 809
}

/* 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.")
810 811
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
812
{
813 814
  PRINTDECLARE;
  Lisp_Object printcharfun;
815 816 817 818 819 820 821 822
  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
823 824 825 826

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print_depth = 0;
827
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
828 829 830
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
831
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
832 833 834

  Ferase_buffer ();
  set_buffer_internal (old);
835 836

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
837 838
  UNGCPRO;

839
  return object;
Jim Blandy's avatar
Jim Blandy committed
840 841 842 843 844 845
}

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
846
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
847 848
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
849
{
850
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
851

Jim Blandy's avatar
Jim Blandy committed
852
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
853 854 855
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
856
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
857
  PRINTFINISH;
858
  return object;
Jim Blandy's avatar
Jim Blandy committed
859 860 861 862 863 864
}

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
865
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
866 867
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
868
{
869
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
870 871 872 873 874 875
  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
876
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
877
    printcharfun = Vstandard_output;
878
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
879 880 881
  PRINTPREPARE;
  print_depth = 0;
  PRINTCHAR ('\n');
882
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
883 884 885 886 887 888 889
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
890
  return object;
Jim Blandy's avatar
Jim Blandy committed
891 892 893 894 895 896
}

/* 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
897 898
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
899 900
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
901 902
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
903 904 905
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
906 907 908 909 910 911 912 913 914

#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
915 916
  return character;
}
917 918 919 920 921 922 923 924

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
925
  fprintf (stderr, "\r\n");
926
}
Jim Blandy's avatar
Jim Blandy committed
927

928 929 930 931 932 933 934 935 936 937
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;

938 939 940 941 942 943 944 945 946
  /* 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;

947
  print_error_message (obj, Vprin1_to_string_buffer);
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962

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

963
void
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
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
1013 1014 1015
#ifdef LISP_FLOAT_TYPE

/*
1016
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
1017
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
 * 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
 */
1028 1029 1030

void
float_to_string (buf, data)
1031
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
1032 1033
     double data;
{
1034
  unsigned char *cp;
1035
  int width;
Jim Blandy's avatar
Jim Blandy committed
1036
      
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
  /* 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
1057
  if (NILP (Vfloat_output_format)
1058
      || !STRINGP (Vfloat_output_format))
Jim Blandy's avatar
Jim Blandy committed
1059
  lose:
1060
    {
Paul Eggert's avatar
Paul Eggert committed
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
      /* 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);
1076
    }
Jim Blandy's avatar
Jim Blandy committed
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
  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;
1090 1091

      /* Check the width specification.  */
1092
      width = -1;
1093
      if ('0' <= *cp && *cp <= '9')
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
	{
	  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;
	}