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

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 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
	  message_enable_multibyte = 1;
438 439
	}

Karl Heuer's avatar
Karl Heuer committed
440 441 442
      if (printbufidx < FRAME_MESSAGE_BUF_SIZE (mini_frame) - len)
	bcopy (str, &FRAME_MESSAGE_BUF (mini_frame)[printbufidx], len),
	printbufidx += len;
443
      FRAME_MESSAGE_BUF (mini_frame)[printbufidx] = 0;
444
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
445 446 447 448 449

      return;
    }
#endif /* not standalone */

450
  XSETFASTINT (ch1, ch);
Jim Blandy's avatar
Jim Blandy committed
451 452 453 454
  call1 (fun, ch1);
}

static void
455
strout (ptr, size, size_byte, printcharfun, multibyte)
Jim Blandy's avatar
Jim Blandy committed
456
     char *ptr;
457
     int size, size_byte;
Jim Blandy's avatar
Jim Blandy committed
458
     Lisp_Object printcharfun;
459
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
460 461 462
{
  int i = 0;

Karl Heuer's avatar
Karl Heuer committed
463
  if (size < 0)
464
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
465

Jim Blandy's avatar
Jim Blandy committed
466 467
  if (EQ (printcharfun, Qnil))
    {
468
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
469
	{
470
	  print_buffer_size = print_buffer_size * 2 + size_byte;
471 472 473
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
474
      bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
475
      print_buffer_pos += size;
476
      print_buffer_pos_byte += size_byte;
477

Jim Blandy's avatar
Jim Blandy committed
478 479
#ifdef MAX_PRINT_CHARS
      if (max_print)
480
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
481 482 483 484 485
#endif /* MAX_PRINT_CHARS */
      return;
    }
  if (EQ (printcharfun, Qt))
    {
486
      FRAME_PTR mini_frame
487 488
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));

489 490
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
491 492
#ifdef MAX_PRINT_CHARS
      if (max_print)
Karl Heuer's avatar
Karl Heuer committed
493
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
494 495 496 497
#endif /* MAX_PRINT_CHARS */

      if (noninteractive)
	{
498
	  fwrite (ptr, 1, size_byte, stdout);
Jim Blandy's avatar
Jim Blandy committed
499 500 501 502
	  noninteractive_need_newline = 1;
	  return;
	}

503
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
504 505
	  || !message_buf_print)
	{
506
	  message_log_maybe_newline ();
507
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
508
	  printbufidx = 0;
509
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
510
	  message_buf_print = 1;
511 512 513 514 515 516 517 518 519 520 521

	  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
522 523
	}

524
      message_dolog (ptr, size_byte, 0, multibyte);
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547

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

548 549 550
      if (multibyte)
	message_enable_multibyte = 1;

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

      /* Put that part of the new text in.  */
561 562
      bcopy (ptr, &FRAME_MESSAGE_BUF (mini_frame) [printbufidx], size_byte);
      printbufidx += size_byte;
563
      FRAME_MESSAGE_BUF (mini_frame) [printbufidx] = 0;
564
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
565 566 567 568

      return;
    }

Karl Heuer's avatar
Karl Heuer committed
569
  i = 0;
570 571 572 573
  if (size == size_byte)
    while (i < size_byte)
      {
	int ch = ptr[i++];
Karl Heuer's avatar
Karl Heuer committed
574

575 576 577 578 579 580 581 582 583 584 585 586 587
	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
588 589 590
}

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

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

Jim Blandy's avatar
Jim Blandy committed
658
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
659
    printcharfun = Vstandard_output;
660
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
661
  PRINTPREPARE;
662
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
663
  PRINTFINISH;
664
  return character;
Jim Blandy's avatar
Jim Blandy committed
665 666
}

667 668
/* 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
669 670
   Do not use this on the contents of a Lisp string.  */

671
void
Jim Blandy's avatar
Jim Blandy committed
672 673 674 675
write_string (data, size)
     char *data;
     int size;
{
676
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
677 678 679 680 681
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
682
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
683 684 685
  PRINTFINISH;
}

686 687
/* 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
688 689
   Do not use this on the contents of a Lisp string.  */

690
void
Jim Blandy's avatar
Jim Blandy committed
691 692 693 694 695
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
696
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
697 698

  PRINTPREPARE;
699
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
  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)));

715
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
716
  current_buffer->read_only = Qnil;
717 718 719 720 721 722
  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
723 724
  Ferase_buffer ();

725
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
726 727 728 729 730 731 732 733
  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
734
     Lisp_Object (*function) P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
735 736 737 738
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
739
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
740

741
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
742 743 744
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
745
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
746 747 748

  val = (*function) (args);

749
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
750
  temp_output_buffer_show (buf);
751
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
752 753 754 755 756 757 758 759 760 761

  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\
762 763
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
764 765
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\
766
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
767 768
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
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
  (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
796 797
  "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
798 799 800
  (printcharfun)
     Lisp_Object printcharfun;
{
801
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
802

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

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
824
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
825 826 827
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
828
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
829
  PRINTFINISH;
830
  return object;
Jim Blandy's avatar
Jim Blandy committed
831 832 833 834 835 836 837 838 839 840
}

/* 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.")
841 842
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
843
{
844 845
  PRINTDECLARE;
  Lisp_Object printcharfun;
846 847 848 849 850 851 852 853
  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
854 855 856 857

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print_depth = 0;
858
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
859 860 861
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
862
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
863 864 865

  Ferase_buffer ();
  set_buffer_internal (old);
866 867

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
868 869
  UNGCPRO;

870
  return object;
Jim Blandy's avatar
Jim Blandy committed
871 872 873 874 875 876
}

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
877
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
878 879
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
880
{
881
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
882

Jim Blandy's avatar
Jim Blandy committed
883
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
884 885 886
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
887
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
888
  PRINTFINISH;
889
  return object;
Jim Blandy's avatar
Jim Blandy committed
890 891 892 893 894 895
}

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

/* 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
928 929
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
930 931
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
932 933
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
934 935 936
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
937 938 939 940 941 942 943 944 945

#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
946 947
  return character;
}
948 949 950 951 952 953 954 955

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
956
  fprintf (stderr, "\r\n");
957
}
Jim Blandy's avatar
Jim Blandy committed
958

959 960 961 962 963 964 965 966 967 968
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;

969 970 971 972 973 974 975 976 977
  /* 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;

978
  print_error_message (obj, Vprin1_to_string_buffer);
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993

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

994
void
995 996 997 998 999 1000 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
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
1044 1045 1046
#ifdef LISP_FLOAT_TYPE

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

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