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

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
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23 24 25 26 27
#include <stdio.h>
#include "lisp.h"

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

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

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

Erik Naggum's avatar
Erik Naggum committed
43 44 45
/* These are used to print like we read.  */
extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;

Jim Blandy's avatar
Jim Blandy committed
46 47
#ifdef LISP_FLOAT_TYPE
Lisp_Object Vfloat_output_format, Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

/* Work around a problem that happens because math.h on hpux 7
   defines two static variables--which, in Emacs, are not really static,
   because `static' is defined as nothing.  The problem is that they are
   defined both here and in lread.c.
   These macros prevent the name conflict.  */
#if defined (HPUX) && !defined (HPUX8)
#define _MAXLDBL print_maxldbl
#define _NMAXLDBL print_nmaxldbl
#endif

#include <math.h>

#if STDC_HEADERS
#include <float.h>
#include <stdlib.h>
#endif

/* Default to values appropriate for IEEE floating point.  */
#ifndef FLT_RADIX
#define FLT_RADIX 2
#endif
#ifndef DBL_MANT_DIG
#define DBL_MANT_DIG 53
#endif
#ifndef DBL_DIG
#define DBL_DIG 15
#endif
76 77 78 79 80 81 82 83
#ifndef DBL_MIN
#define DBL_MIN 2.2250738585072014e-308
#endif

#ifdef DBL_MIN_REPLACEMENT
#undef DBL_MIN
#define DBL_MIN DBL_MIN_REPLACEMENT
#endif
Paul Eggert's avatar
Paul Eggert committed
84 85 86 87 88 89 90 91 92 93 94 95

/* Define DOUBLE_DIGITS_BOUND, an upper bound on the number of decimal digits
   needed to express a float without losing information.
   The general-case formula is valid for the usual case, IEEE floating point,
   but many compilers can't optimize the formula to an integer constant,
   so make a special case for it.  */
#if FLT_RADIX == 2 && DBL_MANT_DIG == 53
#define DOUBLE_DIGITS_BOUND 17 /* IEEE floating point */
#else
#define DOUBLE_DIGITS_BOUND ((int) ceil (log10 (pow (FLT_RADIX, DBL_MANT_DIG))))
#endif

Jim Blandy's avatar
Jim Blandy committed
96 97 98 99 100
#endif /* LISP_FLOAT_TYPE */

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

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

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

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

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

Lisp_Object Vprint_length;

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

Lisp_Object Vprint_level;

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

int print_escape_newlines;

Lisp_Object Qprint_escape_newlines;

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

int print_quoted;

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

140
Lisp_Object Vprint_gensym;
141 142 143 144 145

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

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

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

extern int noninteractive_need_newline;
152

153 154
extern int minibuffer_auto_raise;

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

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

#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

214
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
215 216

/* Lisp functions to do output using a stream
217 218 219 220 221
   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
222 223
*/ 

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

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

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

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

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

308 309 310 311 312 313 314 315 316
/* 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);
}

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

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
322
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
323 324 325 326 327 328 329 330 331 332 333
     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
334
      int len;
335
      unsigned char work[4], *str;
Karl Heuer's avatar
Karl Heuer committed
336

Jim Blandy's avatar
Jim Blandy committed
337
      QUIT;
Karl Heuer's avatar
Karl Heuer committed
338
      len = CHAR_STRING (ch, work, str);
339
      if (print_buffer_pos_byte + len >= print_buffer_size)
340 341
	print_buffer = (char *) xrealloc (print_buffer,
					  print_buffer_size *= 2);
342 343 344
      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
345 346 347 348 349
      return;
    }

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

355 356
      QUIT;

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

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

	  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
384 385
	}

386
      message_dolog (str, len, 0, len > 1);
Karl Heuer's avatar
Karl Heuer committed
387 388 389
      if (printbufidx < FRAME_MESSAGE_BUF_SIZE (mini_frame) - len)
	bcopy (str, &FRAME_MESSAGE_BUF (mini_frame)[printbufidx], len),
	printbufidx += len;
390
      FRAME_MESSAGE_BUF (mini_frame)[printbufidx] = 0;
391
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
392 393 394 395 396

      return;
    }
#endif /* not standalone */

397
  XSETFASTINT (ch1, ch);
Jim Blandy's avatar
Jim Blandy committed
398 399 400 401
  call1 (fun, ch1);
}

static void
402
strout (ptr, size, size_byte, printcharfun, multibyte)
Jim Blandy's avatar
Jim Blandy committed
403
     char *ptr;
404
     int size, size_byte;
Jim Blandy's avatar
Jim Blandy committed
405
     Lisp_Object printcharfun;
406
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
407 408 409
{
  int i = 0;

Karl Heuer's avatar
Karl Heuer committed
410
  if (size < 0)
411
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
412

Jim Blandy's avatar
Jim Blandy committed
413 414
  if (EQ (printcharfun, Qnil))
    {
415
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
416
	{
417
	  print_buffer_size = print_buffer_size * 2 + size_byte;
418 419 420
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
421
      bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
422
      print_buffer_pos += size;
423
      print_buffer_pos_byte += size_byte;
424

Jim Blandy's avatar
Jim Blandy committed
425 426
#ifdef MAX_PRINT_CHARS
      if (max_print)
427
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
428 429 430 431 432
#endif /* MAX_PRINT_CHARS */
      return;
    }
  if (EQ (printcharfun, Qt))
    {
433
      FRAME_PTR mini_frame
434 435
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));

436 437
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
438 439
#ifdef MAX_PRINT_CHARS
      if (max_print)
Karl Heuer's avatar
Karl Heuer committed
440
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
441 442 443 444
#endif /* MAX_PRINT_CHARS */

      if (noninteractive)
	{
445
	  fwrite (ptr, 1, size_byte, stdout);
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449
	  noninteractive_need_newline = 1;
	  return;
	}

450
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
451 452
	  || !message_buf_print)
	{
453
	  message_log_maybe_newline ();
454
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
455
	  printbufidx = 0;
456
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
457
	  message_buf_print = 1;
458 459 460 461 462 463 464 465 466 467 468

	  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
469 470
	}

471 472
      message_dolog (ptr, size_byte, 0, multibyte);
      if (size_byte > FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1)
Karl Heuer's avatar
Karl Heuer committed
473
	{
474
	  size_byte = FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1;
Karl Heuer's avatar
Karl Heuer committed
475
	  /* Rewind incomplete multi-byte form.  */
476
	  while (size_byte && (unsigned char) ptr[size] >= 0xA0) size--;
Karl Heuer's avatar
Karl Heuer committed
477
	}
478 479
      bcopy (ptr, &FRAME_MESSAGE_BUF (mini_frame) [printbufidx], size_byte);
      printbufidx += size_byte;
480
      echo_area_glyphs_length = printbufidx;
481
      FRAME_MESSAGE_BUF (mini_frame) [printbufidx] = 0;
Jim Blandy's avatar
Jim Blandy committed
482 483 484 485

      return;
    }

Karl Heuer's avatar
Karl Heuer committed
486
  i = 0;
487 488 489 490
  if (size == size_byte)
    while (i < size_byte)
      {
	int ch = ptr[i++];
Karl Heuer's avatar
Karl Heuer committed
491

492 493 494 495 496 497 498 499 500 501 502 503 504
	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
505 506 507
}

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

511
static void
Jim Blandy's avatar
Jim Blandy committed
512 513 514 515
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
516 517
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
    /* strout is safe for output to a frame (echo area) or to print_buffer.  */
518 519 520 521
    strout (XSTRING (string)->data,
	    XSTRING (string)->size,
	    XSTRING (string)->size_byte,
	    printcharfun, STRING_MULTIBYTE (string));
Jim Blandy's avatar
Jim Blandy committed
522 523
  else
    {
524 525
      /* 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
526 527
      int i;
      int size = XSTRING (string)->size;
528
      int size_byte = XSTRING (string)->size_byte;
Jim Blandy's avatar
Jim Blandy committed
529 530
      struct gcpro gcpro1;
      GCPRO1 (string);
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
      if (size == size_byte)
	for (i = 0; i < size; i++)
	  PRINTCHAR (XSTRING (string)->data[i]);
      else
	for (i = 0; i < size_byte; i++)
	  {
	    /* Here, we must convert each multi-byte form to the
	       corresponding character code before handing it to PRINTCHAR.  */
	    int len;
	    int ch = STRING_CHAR_AND_LENGTH (XSTRING (string)->data + i,
					     size_byte - i, len);

	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
546 547 548 549 550
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
551
  "Output character CHARACTER to stream PRINTCHARFUN.\n\
Karl Heuer's avatar
Karl Heuer committed
552
PRINTCHARFUN defaults to the value of `standard-output' (which see).")
553 554
  (character, printcharfun)
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
555
{
556
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
557

Jim Blandy's avatar
Jim Blandy committed
558
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
559
    printcharfun = Vstandard_output;
560
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
561
  PRINTPREPARE;
562
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
563
  PRINTFINISH;
564
  return character;
Jim Blandy's avatar
Jim Blandy committed
565 566
}

567 568
/* 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
569 570
   Do not use this on the contents of a Lisp string.  */

571
void
Jim Blandy's avatar
Jim Blandy committed
572 573 574 575
write_string (data, size)
     char *data;
     int size;
{
576
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580 581
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
582
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
583 584 585
  PRINTFINISH;
}

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

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

  PRINTPREPARE;
599
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
  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)));

615
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
616 617 618
  current_buffer->read_only = Qnil;
  Ferase_buffer ();

619
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
620 621 622 623 624 625 626 627
  specbind (Qstandard_output, buf);

  set_buffer_internal (old);
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
     char *bufname;
628
     Lisp_Object (*function) ();
Jim Blandy's avatar
Jim Blandy committed
629 630 631 632
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
633
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
634

635
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
636 637 638
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
639
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
640 641 642

  val = (*function) (args);

643
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
644
  temp_output_buffer_show (buf);
645
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
646 647 648 649 650 651 652 653 654 655 656 657

  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\
658
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
Jim Blandy's avatar
Jim Blandy committed
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
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
687 688
  "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
689 690 691
  (printcharfun)
     Lisp_Object printcharfun;
{
692
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
693

Jim Blandy's avatar
Jim Blandy committed
694
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698 699 700 701 702 703 704 705
    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
706
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
707 708
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
709
{
710
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
711 712 713 714

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
715
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
716 717 718
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
719
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
720
  PRINTFINISH;
721
  return object;
Jim Blandy's avatar
Jim Blandy committed
722 723 724 725 726 727 728 729 730 731
}

/* 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.")
732 733
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
734
{
735 736
  PRINTDECLARE;
  Lisp_Object printcharfun;
737 738 739 740 741 742 743 744
  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
745 746 747 748

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print_depth = 0;
749
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
750 751 752
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
753
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
754 755 756

  Ferase_buffer ();
  set_buffer_internal (old);
757 758

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
759 760
  UNGCPRO;

761
  return object;
Jim Blandy's avatar
Jim Blandy committed
762 763 764 765 766 767
}

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
768
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
769 770
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
771
{
772
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
773

Jim Blandy's avatar
Jim Blandy committed
774
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
775 776 777
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
778
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
779
  PRINTFINISH;
780
  return object;
Jim Blandy's avatar
Jim Blandy committed
781 782 783 784 785 786
}

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
787
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
788 789
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
790
{
791
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
792 793 794 795 796 797
  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
798
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
799
    printcharfun = Vstandard_output;
800
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
801 802 803
  PRINTPREPARE;
  print_depth = 0;
  PRINTCHAR ('\n');
804
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
805 806 807 808 809 810 811
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
812
  return object;
Jim Blandy's avatar
Jim Blandy committed
813 814 815 816 817 818
}

/* 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
819 820
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
821 822
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
823 824
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
825 826 827
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
828 829 830 831 832 833 834 835 836

#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
837 838
  return character;
}
839 840 841 842 843 844 845 846

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
847
  fprintf (stderr, "\r\n");
848
}
Jim Blandy's avatar
Jim Blandy committed
849

850 851 852 853 854 855 856 857 858 859
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;

860 861 862 863 864 865 866 867 868
  /* 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;

869
  print_error_message (obj, Vprin1_to_string_buffer);
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884

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

885
void
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
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
935 936 937
#ifdef LISP_FLOAT_TYPE

/*
938
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
939
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
940 941 942 943 944 945 946 947 948 949
 * 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
 */
950 951 952

void
float_to_string (buf, data)
953
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
954 955
     double data;
{
956
  unsigned char *cp;
957
  int width;
Jim Blandy's avatar
Jim Blandy committed
958
      
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
  /* 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
979
  if (NILP (Vfloat_output_format)
980
      || !STRINGP (Vfloat_output_format))
Jim Blandy's avatar
Jim Blandy committed
981
  lose:
982
    {
Paul Eggert's avatar
Paul Eggert committed
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
      /* 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);
998
    }
Jim Blandy's avatar
Jim Blandy committed
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
  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;
1012 1013

      /* Check the width specification.  */
1014
      width = -1;
1015
      if ('0' <= *cp && *cp <= '9')
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
	{
	  width = 0;
	  do
	    width = (width * 10) + (*cp++ - '0');
	  while (*cp >= '0' && *cp <= '9');

	  /* A precision of zero is valid only for %f.  */
	  if (width > DBL_DIG
	      || (width == 0 && *cp != 'f'))
	    goto lose;
	}
Jim Blandy's avatar
Jim Blandy committed
1027 1028 1029 1030 1031 1032 1033 1034 1035

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

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

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

1037 1038
  /* Make sure there is a decimal point with digit after, or an
     exponent, so that the value is readable as a float.  But don't do
1039 1040 1041
     this with "%.0f"; it's valid for that not to produce a decimal
     point.  Note that width can be 0 only for %.0f.  */
  if (width != 0)
1042
    {
1043 1044 1045
      for (cp = buf; *cp; cp++)
	if ((*cp < '0' || *cp > '9') && *cp != '-')
	  break;
1046

1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
      if (*cp == '.' && cp[1] == 0)
	{
	  cp[1] = '0';
	  cp[2] = 0;
	}

      if (*cp == 0)
	{
	  *cp++ = '.';
	  *cp++ = '0';
	  *cp++ = 0;
	}
1059
    }
Jim Blandy's avatar
Jim Blandy committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
}
#endif /* LISP_FLOAT_TYPE */

static void
print (obj, printcharfun, escapeflag)
     Lisp_Object obj;
     register Lisp_Object printcharfun;
     int escapeflag;
{
  char buf[30];

  QUIT;

1073 1074 1075
#if 1  /* I'm not sure this is really worth doing.  */
  /* Detect circularities and truncate them.
     No need to offer any alternative--this is better than an error.  */
1076
  if (CONSP (obj) || VECTORP (obj) || COMPILEDP (obj))
1077 1078 1079 1080 1081 1082
    {
      int i;
      for (i = 0; i < print_depth; i++)
	if (EQ (obj, being_printed[i]))
	  {
	    sprintf (buf, "#%d", i);
1083
	    strout (buf, -1, -1, printcharfun, 0);
1084 1085 1086 1087 1088 1089
	    return;
	  }
    }
#endif

  being_printed[print_depth] = obj;
Jim Blandy's avatar
Jim Blandy committed
1090 1091
  print_depth++;

1092
  if (print_depth > PRINT_CIRCLE)
Jim Blandy's avatar
Jim Blandy committed
1093 1094 1095 1096 1097 1098 1099 1100 1101
    error ("Apparently circular structure being printed");
#ifdef MAX_PRINT_CHARS
  if (max_print && print_chars > max_print)
    {
      PRINTCHAR ('\n');
      print_chars = 0;
    }
#endif /* MAX_PRINT_CHARS */