print.c 52.3 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
/* 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;

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

int print_escape_nonascii;

136 137 138 139 140 141 142
/* 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
143 144 145 146
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

147 148 149
/* 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.  */
150

151
Lisp_Object Vprint_gensym;
152 153 154 155 156

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

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

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

extern int noninteractive_need_newline;
163

164 165
extern int minibuffer_auto_raise;

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

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
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 220 221 222 223 224

#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

225
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
226 227

/* Lisp functions to do output using a stream
228 229 230 231 232
   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
233 234
*/ 

235 236 237
#define PRINTDECLARE						\
   struct buffer *old = current_buffer;				\
   int old_point = -1, start_point;				\
238
   int old_point_byte, start_point_byte;			\
239 240
   int specpdl_count = specpdl_ptr - specpdl;			\
   int free_print_buffer = 0;					\
241 242
   Lisp_Object original

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

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
#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),			\
322 323
		  old_point_byte + (old_point_byte >= start_point_byte	\
			       ? PT_BYTE - start_point_byte : 0));	\
324 325 326
   if (old != current_buffer)						\
     set_buffer_internal (old);						\
   if (!CONSP (Vprint_gensym))						\
327
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
328 329 330

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

331 332 333 334 335 336 337
/* 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)))))

338 339 340 341 342 343 344 345 346
/* 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);
}

347
/* Index of first unused element of FRAME_MESSAGE_BUF (mini_frame). */
Jim Blandy's avatar
Jim Blandy committed
348 349 350 351
static int printbufidx;

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
352
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
353 354 355 356 357 358 359 360 361 362 363
     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
364
      int len;
365
      unsigned char work[4], *str;
Karl Heuer's avatar
Karl Heuer committed
366

Jim Blandy's avatar
Jim Blandy committed
367
      QUIT;
Karl Heuer's avatar
Karl Heuer committed
368
      len = CHAR_STRING (ch, work, str);
369
      if (print_buffer_pos_byte + len >= print_buffer_size)
370 371
	print_buffer = (char *) xrealloc (print_buffer,
					  print_buffer_size *= 2);
372 373 374
      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
375 376 377 378 379
      return;
    }

  if (EQ (fun, Qt))
    {
380
      FRAME_PTR mini_frame
381
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));
Karl Heuer's avatar
Karl Heuer committed
382 383
      unsigned char work[4], *str;
      int len = CHAR_STRING (ch, work, str);
384

385 386
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
387 388
      if (noninteractive)
	{
Karl Heuer's avatar
Karl Heuer committed
389 390
	  while (len--)
	    putchar (*str), str++;
Jim Blandy's avatar
Jim Blandy committed
391 392 393 394
	  noninteractive_need_newline = 1;
	  return;
	}

395
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
396 397
	  || !message_buf_print)
	{
398
	  message_log_maybe_newline ();
399
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
400
	  printbufidx = 0;
401
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
402
	  message_buf_print = 1;
403 404 405 406 407 408 409 410 411 412 413

	  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
414 415
	}

416
      message_dolog (str, len, 0, len > 1);
417 418 419

      /* Convert message to multibyte if we are now adding multibyte text.  */
      if (! NILP (current_buffer->enable_multibyte_characters)
420 421
	  && ! message_enable_multibyte
	  && printbufidx > 0)
422
	{
423 424 425 426 427 428 429
	  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))
430
	    {
431 432 433 434
	      printbufidx = FRAME_MESSAGE_BUF_SIZE (mini_frame);
	      /* Rewind incomplete multi-byte form.  */
	      while (printbufidx > 0 && tembuf[printbufidx] >= 0xA0)
		printbufidx--;
435
	    }
436
	  bcopy (tembuf, FRAME_MESSAGE_BUF (mini_frame), printbufidx);
437 438
	}

439 440 441 442 443
      /* Record whether the message buffer is multibyte.
	 (If at any point some multibyte characters are added, then it is.)  */
      if (len > 0 && ! NILP (current_buffer->enable_multibyte_characters))
	message_enable_multibyte = 1;

Karl Heuer's avatar
Karl Heuer committed
444
      if (printbufidx < FRAME_MESSAGE_BUF_SIZE (mini_frame) - len)
445 446 447 448
	{
	  bcopy (str, &FRAME_MESSAGE_BUF (mini_frame)[printbufidx], len);
	  printbufidx += len;
	}
449
      FRAME_MESSAGE_BUF (mini_frame)[printbufidx] = 0;
450
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
451 452 453 454 455

      return;
    }
#endif /* not standalone */

456
  XSETFASTINT (ch1, ch);
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460
  call1 (fun, ch1);
}

static void
461
strout (ptr, size, size_byte, printcharfun, multibyte)
Jim Blandy's avatar
Jim Blandy committed
462
     char *ptr;
463
     int size, size_byte;
Jim Blandy's avatar
Jim Blandy committed
464
     Lisp_Object printcharfun;
465
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
466 467 468
{
  int i = 0;

Karl Heuer's avatar
Karl Heuer committed
469
  if (size < 0)
470
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
471

Jim Blandy's avatar
Jim Blandy committed
472 473
  if (EQ (printcharfun, Qnil))
    {
474
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
475
	{
476
	  print_buffer_size = print_buffer_size * 2 + size_byte;
477 478 479
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
480
      bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
481
      print_buffer_pos += size;
482
      print_buffer_pos_byte += size_byte;
483

Jim Blandy's avatar
Jim Blandy committed
484 485
#ifdef MAX_PRINT_CHARS
      if (max_print)
486
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
487 488 489 490 491
#endif /* MAX_PRINT_CHARS */
      return;
    }
  if (EQ (printcharfun, Qt))
    {
492
      FRAME_PTR mini_frame
493 494
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));

495 496
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
497 498
#ifdef MAX_PRINT_CHARS
      if (max_print)
Karl Heuer's avatar
Karl Heuer committed
499
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
500 501 502 503
#endif /* MAX_PRINT_CHARS */

      if (noninteractive)
	{
504
	  fwrite (ptr, 1, size_byte, stdout);
Jim Blandy's avatar
Jim Blandy committed
505 506 507 508
	  noninteractive_need_newline = 1;
	  return;
	}

509
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
510 511
	  || !message_buf_print)
	{
512
	  message_log_maybe_newline ();
513
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
514
	  printbufidx = 0;
515
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
516
	  message_buf_print = 1;
517 518 519 520 521 522 523 524 525 526 527

	  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
528 529
	}

530
      message_dolog (ptr, size_byte, 0, multibyte);
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553

      /* 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);
	}

554 555 556
      if (multibyte)
	message_enable_multibyte = 1;

557
      /* Compute how much of the new text will fit there.  */
558
      if (size_byte > FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1)
Karl Heuer's avatar
Karl Heuer committed
559
	{
560
	  size_byte = FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1;
Karl Heuer's avatar
Karl Heuer committed
561
	  /* Rewind incomplete multi-byte form.  */
562 563
	  while (size_byte && (unsigned char) ptr[size_byte] >= 0xA0)
	    size_byte--;
Karl Heuer's avatar
Karl Heuer committed
564
	}
565 566

      /* Put that part of the new text in.  */
567 568
      bcopy (ptr, &FRAME_MESSAGE_BUF (mini_frame) [printbufidx], size_byte);
      printbufidx += size_byte;
569
      FRAME_MESSAGE_BUF (mini_frame) [printbufidx] = 0;
570
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
571 572 573 574

      return;
    }

Karl Heuer's avatar
Karl Heuer committed
575
  i = 0;
576 577 578 579
  if (size == size_byte)
    while (i < size_byte)
      {
	int ch = ptr[i++];
Karl Heuer's avatar
Karl Heuer committed
580

581 582 583 584 585 586 587 588 589 590 591 592 593
	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
594 595 596
}

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

600
static void
Jim Blandy's avatar
Jim Blandy committed
601 602 603 604
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
605
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
    {
      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
624 625
  else
    {
626 627
      /* 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
628 629
      int i;
      int size = XSTRING (string)->size;
630
      int size_byte = STRING_BYTES (XSTRING (string));
Jim Blandy's avatar
Jim Blandy committed
631 632
      struct gcpro gcpro1;
      GCPRO1 (string);
633 634 635 636 637 638 639 640 641
      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;
642 643
	    int ch = STRING_CHAR_AND_CHAR_LENGTH (XSTRING (string)->data + i,
						  size_byte - i, len);
644 645 646 647 648
	    if (!CHAR_VALID_P (ch, 0))
	      {
		ch = XSTRING (string)->data[i];
		len = 1;
	      }
649 650 651
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
652 653 654 655 656
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
657
  "Output character CHARACTER to stream PRINTCHARFUN.\n\
Karl Heuer's avatar
Karl Heuer committed
658
PRINTCHARFUN defaults to the value of `standard-output' (which see).")
659 660
  (character, printcharfun)
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
661
{
662
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
663

Jim Blandy's avatar
Jim Blandy committed
664
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
665
    printcharfun = Vstandard_output;
666
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
667
  PRINTPREPARE;
668
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
669
  PRINTFINISH;
670
  return character;
Jim Blandy's avatar
Jim Blandy committed
671 672
}

673 674
/* 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
675 676
   Do not use this on the contents of a Lisp string.  */

677
void
Jim Blandy's avatar
Jim Blandy committed
678 679 680 681
write_string (data, size)
     char *data;
     int size;
{
682
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686 687
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
688
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
689 690 691
  PRINTFINISH;
}

692 693
/* 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
694 695
   Do not use this on the contents of a Lisp string.  */

696
void
Jim Blandy's avatar
Jim Blandy committed
697 698 699 700 701
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
702
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
703 704

  PRINTPREPARE;
705
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
  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)));

721
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
722
  current_buffer->read_only = Qnil;
723 724 725 726 727 728
  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
729 730
  Ferase_buffer ();

731
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
732 733 734 735 736 737 738 739
  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
740
     Lisp_Object (*function) P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
741 742 743 744
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
745
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
746

747
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
748 749 750
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
751
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
752 753 754

  val = (*function) (args);

755
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
756
  temp_output_buffer_show (buf);
757
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
758 759 760 761 762 763 764 765 766 767

  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\
768 769
The hook `temp-buffer-show-hook' is run with that window selected\n\
temporarily and its buffer current.\n\
Jim Blandy's avatar
Jim Blandy committed
770 771
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\
772
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
773 774
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
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
  (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
802 803
  "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
804 805 806
  (printcharfun)
     Lisp_Object printcharfun;
{
807
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
808

Jim Blandy's avatar
Jim Blandy committed
809
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
810 811 812 813 814 815 816 817 818 819 820
    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
821
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
822 823
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
824
{
825
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
826 827 828 829

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
830
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
831 832 833
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
834
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
835
  PRINTFINISH;
836
  return object;
Jim Blandy's avatar
Jim Blandy committed
837 838 839 840 841 842 843 844 845 846
}

/* 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.")
847 848
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
849
{
850 851
  PRINTDECLARE;
  Lisp_Object printcharfun;
852 853 854 855 856 857 858 859
  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
860 861 862 863

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print_depth = 0;
864
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
865 866 867
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
868
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
869 870 871

  Ferase_buffer ();
  set_buffer_internal (old);
872 873

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
874 875
  UNGCPRO;

876
  return object;
Jim Blandy's avatar
Jim Blandy committed
877 878 879 880 881 882
}

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
883
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
884 885
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
886
{
887
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
888

Jim Blandy's avatar
Jim Blandy committed
889
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
890 891 892
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
893
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
894
  PRINTFINISH;
895
  return object;
Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900 901
}

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
902
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
903 904
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
905
{
906
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
907 908 909 910 911 912
  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
913
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
914
    printcharfun = Vstandard_output;
915
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
916 917 918
  PRINTPREPARE;
  print_depth = 0;
  PRINTCHAR ('\n');
919
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
920 921 922 923 924 925 926
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
927
  return object;
Jim Blandy's avatar
Jim Blandy committed
928 929 930 931 932 933
}

/* 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
934 935
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
936 937
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
938 939
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
940 941 942
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
943 944 945 946 947 948 949 950 951

#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
952 953
  return character;
}
954 955 956 957 958 959 960 961

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
962
  fprintf (stderr, "\r\n");
963
}
Jim Blandy's avatar
Jim Blandy committed
964

965 966 967 968 969 970 971 972 973 974
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;

975 976 977 978 979 980 981 982 983
  /* 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;

984
  print_error_message (obj, Vprin1_to_string_buffer);
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999

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

1000
void
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
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
1050 1051 1052
#ifdef LISP_FLOAT_TYPE

/*
1053
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
1054
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
 * 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
 */
1065 1066 1067

void
float_to_string (buf, data)
1068
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
1069 1070
     double data;
{
1071
  unsigned char *cp;
1072
  int width;
Jim Blandy's avatar
Jim Blandy committed
1073
      
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
  /* 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
1094
  if (NILP (Vfloat_output_format)
1095
      || !STRINGP (Vfloat_output_format))
Jim Blandy's avatar
Jim Blandy committed
1096
  lose:
1097
    {
Paul Eggert's avatar
Paul Eggert committed
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
      /* 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);
1113
    }
Jim Blandy's avatar
Jim Blandy committed
1114 1115 1116 1117 1118 1119 1120