print.c 61.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
Gerd Moellmann's avatar
Gerd Moellmann committed
2
   Copyright (C) 1985, 86, 88, 93, 94, 95, 97, 98, 1999, 2000, 2001
3
	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
#include <stdio.h>
#include "lisp.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
27
#include "charset.h"
28
#include "keyboard.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 35
#include "intervals.h"

Jim Blandy's avatar
Jim Blandy committed
36 37
Lisp_Object Vstandard_output, Qstandard_output;

38 39
Lisp_Object Qtemp_buffer_setup_hook;

Erik Naggum's avatar
Erik Naggum committed
40 41 42
/* 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
43
Lisp_Object Vfloat_output_format, Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

/* 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>
#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
71 72 73 74 75 76 77 78
#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
79 80 81 82 83 84 85 86 87 88 89 90

/* 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
91 92 93
/* Avoid actual stack overflow in print.  */
int print_depth;

94 95 96
/* Nonzero if inside outputting backquote in old style.  */
int old_backquote_output;

97 98 99 100
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
Lisp_Object being_printed[PRINT_CIRCLE];

101 102 103 104 105 106
/* 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;
107
/* Chars stored in print_buffer.  */
108
int print_buffer_pos;
109 110
/* Bytes stored in print_buffer.  */
int print_buffer_pos_byte;
111

Jim Blandy's avatar
Jim Blandy committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125
/* 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;

126 127 128 129 130
/* Nonzero means to print single-byte non-ascii characters in strings as
   octal escapes.  */

int print_escape_nonascii;

131 132 133 134 135 136 137
/* 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
138 139 140 141
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

142
/* Non-nil means print #: before uninterned symbols.  */
143

144
Lisp_Object Vprint_gensym;
145

146
/* Non-nil means print recursive structures using #n= and #n# syntax.  */
147

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
Lisp_Object Vprint_circle;

/* Non-nil means keep continuous number for #n= and #n# syntax
   between several print functions.  */

Lisp_Object Vprint_continuous_numbering;

/* Vprint_number_table is a vector like [OBJ1 STAT1 OBJ2 STAT2 ...],
   where OBJn are objects going to be printed, and STATn are their status,
   which may be different meanings during process.  See the comments of
   the functions print and print_preprocess for details.
   print_number_index keeps the last position the next object should be added,
   twice of which is the actual vector position in Vprint_number_table.  */
int print_number_index;
Lisp_Object Vprint_number_table;

/* PRINT_NUMBER_OBJECT returns the I'th object in Vprint_number_table TABLE.
   PRINT_NUMBER_STATUS returns the status of the I'th object in TABLE.
   See the comment of the variable Vprint_number_table.  */
#define PRINT_NUMBER_OBJECT(table,i) XVECTOR ((table))->contents[(i) * 2]
#define PRINT_NUMBER_STATUS(table,i) XVECTOR ((table))->contents[(i) * 2 + 1]
Erik Naggum's avatar
Erik Naggum committed
169

170
/* Nonzero means print newline to stdout before next minibuffer message.
Jim Blandy's avatar
Jim Blandy committed
171 172 173
   Defined in xdisp.c */

extern int noninteractive_need_newline;
174

175 176
extern int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
177 178 179 180
#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
181 182

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
183 184


185
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
186 187

/* Lisp functions to do output using a stream
188 189 190 191
   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,
192
   or call strout to output a block of characters. */
193 194 195

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
Gerd Moellmann's avatar
Gerd Moellmann committed
196 197
   int old_point = -1, start_point = -1;				\
   int old_point_byte = -1, start_point_byte = -1;			\
Juanma Barranquero's avatar
Juanma Barranquero committed
198
   int specpdl_count = SPECPDL_INDEX ();				\
199 200
   int free_print_buffer = 0;						\
   int multibyte = !NILP (current_buffer->enable_multibyte_characters);	\
201 202
   Lisp_Object original

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
#define PRINTPREPARE							\
   original = printcharfun;						\
   if (NILP (printcharfun)) printcharfun = Qt;				\
   if (BUFFERP (printcharfun))						\
     {									\
       if (XBUFFER (printcharfun) != current_buffer)			\
	 Fset_buffer (printcharfun);					\
       printcharfun = Qnil;						\
     }									\
   if (MARKERP (printcharfun))						\
     {									\
       if (!(XMARKER (original)->buffer))				\
         error ("Marker does not point anywhere");			\
       if (XMARKER (original)->buffer != current_buffer)		\
         set_buffer_internal (XMARKER (original)->buffer);		\
       old_point = PT;							\
       old_point_byte = PT_BYTE;					\
       SET_PT_BOTH (marker_position (printcharfun),			\
		    marker_byte_position (printcharfun));		\
       start_point = PT;						\
       start_point_byte = PT_BYTE;					\
       printcharfun = Qnil;						\
     }									\
   if (NILP (printcharfun))						\
     {									\
       Lisp_Object string;						\
       if (NILP (current_buffer->enable_multibyte_characters)		\
	   && ! print_escape_multibyte)					\
         specbind (Qprint_escape_multibyte, Qt);			\
232 233 234
       if (! NILP (current_buffer->enable_multibyte_characters)		\
	   && ! print_escape_nonascii)					\
         specbind (Qprint_escape_nonascii, Qt);				\
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
       if (print_buffer != 0)						\
	 {								\
	   string = make_string_from_bytes (print_buffer,		\
					    print_buffer_pos,		\
					    print_buffer_pos_byte);	\
	   record_unwind_protect (print_unwind, string);		\
	 }								\
       else								\
	 {								\
           print_buffer_size = 1000;					\
           print_buffer = (char *) xmalloc (print_buffer_size);		\
	   free_print_buffer = 1;					\
	 }								\
       print_buffer_pos = 0;						\
       print_buffer_pos_byte = 0;					\
     }									\
251
   if (EQ (printcharfun, Qt) && ! noninteractive)			\
252
     setup_echo_area_for_printing (multibyte);
Jim Blandy's avatar
Jim Blandy committed
253

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
#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),			\
282 283
		  old_point_byte + (old_point_byte >= start_point_byte	\
			       ? PT_BYTE - start_point_byte : 0));	\
284
   if (old != current_buffer)						\
285
     set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
286 287 288

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

289 290
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
291

292 293 294 295
static Lisp_Object
print_unwind (saved_text)
     Lisp_Object saved_text;
{
296
  bcopy (SDATA (saved_text), print_buffer, SCHARS (saved_text));
Gerd Moellmann's avatar
Gerd Moellmann committed
297
  return Qnil;
298 299
}

300 301 302 303 304

/* Print character CH using method FUN.  FUN nil means print to
   print_buffer.  FUN t means print to echo area or stdout if
   non-interactive.  If FUN is neither nil nor t, call FUN with CH as
   argument.  */
Jim Blandy's avatar
Jim Blandy committed
305 306 307

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
308
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312 313 314 315
     Lisp_Object fun;
{
#ifdef MAX_PRINT_CHARS
  if (max_print)
    print_chars++;
#endif /* MAX_PRINT_CHARS */

316 317 318
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
319
    {
320 321 322
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

323
      QUIT;
324

325
      if (NILP (fun))
326
	{
327 328 329 330 331 332
	  if (print_buffer_pos_byte + len >= print_buffer_size)
	    print_buffer = (char *) xrealloc (print_buffer,
					      print_buffer_size *= 2);
	  bcopy (str, print_buffer + print_buffer_pos_byte, len);
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
333
	}
334
      else if (noninteractive)
335
	{
336 337
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
338
	}
339
      else
340
	{
341 342
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
343

344
	  setup_echo_area_for_printing (multibyte_p);
345 346
	  insert_char (ch);
	  message_dolog (str, len, 0, multibyte_p);
347
	}
Jim Blandy's avatar
Jim Blandy committed
348 349 350
    }
}

351 352 353 354 355 356 357 358 359

/* Output SIZE characters, SIZE_BYTE bytes from string PTR using
   method PRINTCHARFUN.  If SIZE < 0, use the string length of PTR for
   both SIZE and SIZE_BYTE.  PRINTCHARFUN nil means output to
   print_buffer.  PRINTCHARFUN t means output to the echo area or to
   stdout if non-interactive.  If neither nil nor t, call Lisp
   function PRINTCHARFUN for each character printed.  MULTIBYTE
   non-zero means PTR contains multibyte characters.  */

Jim Blandy's avatar
Jim Blandy committed
360
static void
361
strout (ptr, size, size_byte, printcharfun, multibyte)
Jim Blandy's avatar
Jim Blandy committed
362
     char *ptr;
363
     int size, size_byte;
Jim Blandy's avatar
Jim Blandy committed
364
     Lisp_Object printcharfun;
365
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
366
{
Karl Heuer's avatar
Karl Heuer committed
367
  if (size < 0)
368
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
369

370
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
371
    {
372
      if (print_buffer_pos_byte + size_byte > print_buffer_size)
373
	{
374
	  print_buffer_size = print_buffer_size * 2 + size_byte;
375 376 377
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
378
      bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
379
      print_buffer_pos += size;
380
      print_buffer_pos_byte += size_byte;
381

Jim Blandy's avatar
Jim Blandy committed
382 383
#ifdef MAX_PRINT_CHARS
      if (max_print)
384
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
385 386
#endif /* MAX_PRINT_CHARS */
    }
387
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
388
    {
389 390 391 392 393 394 395 396 397 398 399
      fwrite (ptr, 1, size_byte, stdout);
      noninteractive_need_newline = 1;
    }
  else if (EQ (printcharfun, Qt))
    {
      /* Output to echo area.  We're trying to avoid a little overhead
	 here, that's the reason we don't call printchar to do the
	 job.  */
      int i;
      int multibyte_p
	= !NILP (current_buffer->enable_multibyte_characters);
400

401
      setup_echo_area_for_printing (multibyte_p);
402
      message_dolog (ptr, size_byte, 0, multibyte_p);
403

404
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
405
	{
406
	  for (i = 0; i < size; ++i)
407
	    insert_char ((unsigned char )*ptr++);
Jim Blandy's avatar
Jim Blandy committed
408
	}
409
      else
Jim Blandy's avatar
Jim Blandy committed
410
	{
411 412
	  int len;
	  for (i = 0; i < size_byte; i += len)
413
	    {
414 415
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
	      insert_char (ch);
416
	    }
Jim Blandy's avatar
Jim Blandy committed
417
	}
418

419 420 421 422 423 424 425 426 427
#ifdef MAX_PRINT_CHARS
      if (max_print)
        print_chars += size;
#endif /* MAX_PRINT_CHARS */
    }
  else
    {
      /* PRINTCHARFUN is a Lisp function.  */
      int i = 0;
Jim Blandy's avatar
Jim Blandy committed
428

429
      if (size == size_byte)
430
	{
431
	  while (i < size_byte)
432
	    {
433 434
	      int ch = ptr[i++];
	      PRINTCHAR (ch);
435 436
	    }
	}
437
      else
Karl Heuer's avatar
Karl Heuer committed
438
	{
439 440 441 442 443 444 445 446 447 448
	  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;
	    }
Karl Heuer's avatar
Karl Heuer committed
449
	}
Jim Blandy's avatar
Jim Blandy committed
450 451 452 453
    }
}

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

457
static void
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
462
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
463 464 465 466
    {
      int chars;

      if (STRING_MULTIBYTE (string))
467
	chars = SCHARS (string);
468 469 470
      else if (EQ (printcharfun, Qt)
	       ? ! NILP (buffer_defaults.enable_multibyte_characters)
	       : ! NILP (current_buffer->enable_multibyte_characters))
471 472 473 474 475 476 477
	{
	  /* If unibyte string STRING contains 8-bit codes, we must
	     convert STRING to a multibyte string containing the same
	     character codes.  */
	  Lisp_Object newstr;
	  int bytes;

478 479
	  chars = SBYTES (string);
	  bytes = parse_str_to_multibyte (SDATA (string), chars);
480 481 482
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
483 484
	      bcopy (SDATA (string), SDATA (newstr), chars);
	      str_to_multibyte (SDATA (newstr), bytes, chars);
485 486 487
	      string = newstr;
	    }
	}
488
      else
489
	chars = SBYTES (string);
490 491

      /* strout is safe for output to a frame (echo area) or to print_buffer.  */
492 493
      strout (SDATA (string),
	      chars, SBYTES (string),
494 495
	      printcharfun, STRING_MULTIBYTE (string));
    }
Jim Blandy's avatar
Jim Blandy committed
496 497
  else
    {
498 499
      /* 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
500
      int i;
501 502
      int size = SCHARS (string);
      int size_byte = SBYTES (string);
Jim Blandy's avatar
Jim Blandy committed
503 504
      struct gcpro gcpro1;
      GCPRO1 (string);
505 506
      if (size == size_byte)
	for (i = 0; i < size; i++)
507
	  PRINTCHAR (SREF (string, i));
508 509 510 511 512 513
      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;
514
	    int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i,
515
					     size_byte - i, len);
516 517
	    if (!CHAR_VALID_P (ch, 0))
	      {
518
		ch = SREF (string, i);
519 520
		len = 1;
	      }
521 522 523
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
524 525 526 527 528
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
529 530 531
       doc: /* Output character CHARACTER to stream PRINTCHARFUN.
PRINTCHARFUN defaults to the value of `standard-output' (which see).  */)
     (character, printcharfun)
532
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
533
{
534
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
535

Jim Blandy's avatar
Jim Blandy committed
536
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
537
    printcharfun = Vstandard_output;
538
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
539
  PRINTPREPARE;
540
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
541
  PRINTFINISH;
542
  return character;
Jim Blandy's avatar
Jim Blandy committed
543 544
}

545 546
/* 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
547 548
   Do not use this on the contents of a Lisp string.  */

549
void
Jim Blandy's avatar
Jim Blandy committed
550 551 552 553
write_string (data, size)
     char *data;
     int size;
{
554
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
555 556 557 558 559
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
560
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
561 562 563
  PRINTFINISH;
}

564 565
/* 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
566 567
   Do not use this on the contents of a Lisp string.  */

568
void
Jim Blandy's avatar
Jim Blandy committed
569 570 571 572 573
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
574
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
575 576

  PRINTPREPARE;
577
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
578 579 580 581 582 583
  PRINTFINISH;
}


void
temp_output_buffer_setup (bufname)
Ken Raeburn's avatar
Ken Raeburn committed
584
    const char *bufname;
Jim Blandy's avatar
Jim Blandy committed
585
{
Juanma Barranquero's avatar
Juanma Barranquero committed
586
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
587 588 589
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

590 591
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
592 593
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

594
  Fkill_all_local_variables ();
595
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
596
  current_buffer->read_only = Qnil;
597 598 599 600 601 602
  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
603
  Ferase_buffer ();
604
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
605

606
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
607 608 609 610

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
611 612 613 614
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
Ken Raeburn's avatar
Ken Raeburn committed
615
     const char *bufname;
Andreas Schwab's avatar
Andreas Schwab committed
616
     Lisp_Object (*function) P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
617 618
     Lisp_Object args;
{
Juanma Barranquero's avatar
Juanma Barranquero committed
619
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
620
  Lisp_Object buf, val;
621
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
622

623
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
624 625 626
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
627
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
628 629 630

  val = (*function) (args);

631
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
632
  temp_output_buffer_show (buf);
633
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
634 635 636 637

  return unbind_to (count, val);
}

638 639
DEFUN ("with-output-to-temp-buffer",
       Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
Jim Blandy's avatar
Jim Blandy committed
640
       1, UNEVALLED, 0,
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
       doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
The buffer is cleared out initially, and marked as unmodified when done.
All output done by BODY is inserted in that buffer by default.
The buffer is displayed in another window, but not selected.
The value of the last form in BODY is returned.
If BODY does not finish normally, the buffer BUFNAME is not displayed.

The hook `temp-buffer-setup-hook' is run before BODY,
with the buffer BUFNAME temporarily current.
The hook `temp-buffer-show-hook' is run after the buffer is displayed,
with the buffer temporarily current, and the window that was used
to display it temporarily selected.

If variable `temp-buffer-show-function' is non-nil, call it at the end
to get the buffer displayed instead of just displaying the non-selected
656
buffer and calling the hook.  It gets one argument, the buffer to display.
657 658

usage: (with-output-to-temp-buffer BUFFNAME BODY ...)  */)
659
     (args)
Jim Blandy's avatar
Jim Blandy committed
660 661 662 663
     Lisp_Object args;
{
  struct gcpro gcpro1;
  Lisp_Object name;
Juanma Barranquero's avatar
Juanma Barranquero committed
664
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
665 666 667 668
  Lisp_Object buf, val;

  GCPRO1(args);
  name = Feval (Fcar (args));
669
  CHECK_STRING (name);
670
  temp_output_buffer_setup (SDATA (name));
Jim Blandy's avatar
Jim Blandy committed
671
  buf = Vstandard_output;
672
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
673

674
  val = Fprogn (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
675

676
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
677
  temp_output_buffer_show (buf);
678
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
679 680 681

  return unbind_to (count, val);
}
682

Jim Blandy's avatar
Jim Blandy committed
683 684

static void print ();
685 686 687
static void print_preprocess ();
static void print_preprocess_string ();
static void print_object ();
Jim Blandy's avatar
Jim Blandy committed
688 689

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
690 691
       doc: /* Output a newline to stream PRINTCHARFUN.
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.  */)
Jim Blandy's avatar
Jim Blandy committed
692 693 694
  (printcharfun)
     Lisp_Object printcharfun;
{
695
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
696

Jim Blandy's avatar
Jim Blandy committed
697
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701 702 703 704 705
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
706 707
       doc: /* Output the printed representation of OBJECT, any Lisp object.
Quoting characters are printed when needed to make output that `read'
Eli Zaretskii's avatar
Eli Zaretskii committed
708
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
709
is controlled by `print-level' and `print-length', which see.
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.

Optional argument PRINTCHARFUN is the output stream, which can be one
of these:

   - a buffer, in which case output is inserted into that buffer at point;
   - a marker, in which case output is inserted at marker's position;
   - a function, in which case that function is called once for each
     character of OBJECT's printed representation;
   - a symbol, in which case that symbol's function definition is called; or
   - t, in which case the output is displayed in the echo area.

If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
is used instead.  */)
     (object, printcharfun)
729
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
730
{
731
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
732 733 734 735

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
736
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
737 738
    printcharfun = Vstandard_output;
  PRINTPREPARE;
739
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
740
  PRINTFINISH;
741
  return object;
Jim Blandy's avatar
Jim Blandy committed
742 743 744 745 746 747
}

/* 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,
748 749
       doc: /* Return a string containing the printed representation of OBJECT.
OBJECT can be any Lisp object.  This function outputs quoting characters
Pavel Janík's avatar
Pavel Janík committed
750
when necessary to make output that `read' can handle, whenever possible,
751
unless the optional second argument NOESCAPE is non-nil.
752 753 754 755 756 757

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.  */)
     (object, noescape)
758
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
759
{
760 761
  PRINTDECLARE;
  Lisp_Object printcharfun;
762 763 764 765 766 767 768 769
  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
770 771 772

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

  Ferase_buffer ();
  set_buffer_internal (old);
783 784

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

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

DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
       doc: /* Output the printed representation of OBJECT, any Lisp object.
No quoting characters are used; no delimiters are printed around
the contents of strings.

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.

Optional argument PRINTCHARFUN is the output stream, which can be one
of these:

   - a buffer, in which case output is inserted into that buffer at point;
   - a marker, in which case output is inserted at marker's position;
   - a function, in which case that function is called once for each
     character of OBJECT's printed representation;
   - a symbol, in which case that symbol's function definition is called; or
   - t, in which case the output is displayed in the echo area.

If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
is used instead.  */)
     (object, printcharfun)
813
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
814
{
815
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
816

Jim Blandy's avatar
Jim Blandy committed
817
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
818 819
    printcharfun = Vstandard_output;
  PRINTPREPARE;
820
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
821
  PRINTFINISH;
822
  return object;
Jim Blandy's avatar
Jim Blandy committed
823 824 825
}

DEFUN ("print", Fprint, Sprint, 1, 2, 0,
826 827
       doc: /* Output the printed representation of OBJECT, with newlines around it.
Quoting characters are printed when needed to make output that `read'
Eli Zaretskii's avatar
Eli Zaretskii committed
828
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
829
is controlled by `print-level' and `print-length', which see.
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848

OBJECT is any of the Lisp data types: a number, a string, a symbol,
a list, a buffer, a window, a frame, etc.

A printed representation of an object is text which describes that object.

Optional argument PRINTCHARFUN is the output stream, which can be one
of these:

   - a buffer, in which case output is inserted into that buffer at point;
   - a marker, in which case output is inserted at marker's position;
   - a function, in which case that function is called once for each
     character of OBJECT's printed representation;
   - a symbol, in which case that symbol's function definition is called; or
   - t, in which case the output is displayed in the echo area.

If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
is used instead.  */)
     (object, printcharfun)
849
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
850
{
851
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
852 853 854 855 856 857
  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
858
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
859
    printcharfun = Vstandard_output;
860
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
861 862
  PRINTPREPARE;
  PRINTCHAR ('\n');
863
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
864 865 866 867 868 869 870
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
871
  return object;
Jim Blandy's avatar
Jim Blandy committed
872 873 874 875 876 877
}

/* 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
878
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
879 880 881 882
       doc: /* Write CHARACTER to stderr.
You can call print while debugging emacs, and pass it this function
to make it write to the debugging output.  */)
     (character)
Jim Blandy's avatar
Jim Blandy committed
883
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
884
{
885
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
886
  putc (XINT (character), stderr);
887 888 889 890 891 892 893 894 895

#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
896 897
  return character;
}
898 899 900 901 902 903 904 905

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
906
  fprintf (stderr, "\r\n");
907
}
Jim Blandy's avatar
Jim Blandy committed
908

909 910
DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
       1, 1, 0,
911 912
       doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.  */)
     (obj)
913 914 915
     Lisp_Object obj;
{
  struct buffer *old = current_buffer;
916
  Lisp_Object value;
917 918
  struct gcpro gcpro1;

919 920 921
  /* 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.  */
922 923 924 925 926
  if (CONSP (obj) && EQ (XCAR (obj), Qerror)
      && CONSP (XCDR (obj))
      && STRINGP (XCAR (XCDR (obj)))
      && NILP (XCDR (XCDR (obj))))
    return XCAR (XCDR (obj));
927

928
  print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
929 930 931 932 933 934 935 936 937 938 939 940

  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
  value = Fbuffer_string ();

  GCPRO1 (value);
  Ferase_buffer ();
  set_buffer_internal (old);
  UNGCPRO;

  return value;
}

941 942
/* Print an error message for the error DATA onto Lisp output stream
   STREAM (suitable for the print functions).  */
943

944
void
945
print_error_message (data, stream, context, caller)
946
     Lisp_Object data, stream;
947 948
     char *context;
     Lisp_Object caller;
949 950 951 952 953
{
  Lisp_Object errname, errmsg, file_error, tail;
  struct gcpro gcpro1;
  int i;

954 955 956 957 958 959 960 961 962 963 964 965
  if (context != 0)
    write_string_1 (context, -1, stream);

  /* If we know from where the error was signaled, show it in
   *Messages*.  */
  if (!NILP (caller) && SYMBOLP (caller))
    {
      const char *name = SDATA (SYMBOL_NAME (caller));
      message_dolog (name, strlen (name), 0, 0);
      message_dolog (": ", 2, 0, 0);
    }

966 967 968 969 970
  errname = Fcar (data);

  if (EQ (errname, Qerror))
    {
      data = Fcdr (data);
971 972
      if (!CONSP (data))
	data = Qnil;
973 974 975 976 977
      errmsg = Fcar (data);
      file_error = Qnil;
    }
  else
    {
978
      Lisp_Object error_conditions;
979
      errmsg = Fget (errname, Qerror_message);
980 981
      error_conditions = Fget (errname, Qerror_conditions);
      file_error = Fmemq (Qfile_error, error_conditions);
982 983 984 985 986 987 988 989 990
    }

  /* 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.  */
991
  if (!NILP (file_error) && CONSP (tail))
992
    errmsg = XCAR (tail), tail = XCDR (tail);
993 994 995 996 997 998

  if (STRINGP (errmsg))
    Fprinc (errmsg, stream);
  else
    write_string_1 ("peculiar error", -1, stream);

999
  for (i = 0; CONSP (tail); tail = XCDR (tail), i++)
1000
    {
1001 1002
      Lisp_Object obj;

1003
      write_string_1 (i ? ", " : ": ", 2, stream);
1004 1005 1006
      obj = XCAR (tail);
      if (!NILP (file_error) || EQ (errname, Qend_of_file))
	Fprinc (obj, stream);
1007
      else
1008
	Fprin1 (obj, stream);
1009
    }
1010

1011 1012
  UNGCPRO;
}
Jim Blandy's avatar
Jim Blandy committed
1013

1014 1015


Jim Blandy's avatar
Jim Blandy committed
1016
/*
1017
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
1018
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
1019 1020
 * 20d float_output_format, with the negative of the C-constant "HUGE"
 * from <math.h>.
1021
 *
Jim Blandy's avatar
Jim Blandy committed
1022
 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
1023
 *
Jim Blandy's avatar
Jim Blandy committed
1024 1025 1026 1027 1028
 * 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
 */
1029 1030 1031

void
float_to_string (buf, data)
1032
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
1033 1034
     double data;
{
1035
  unsigned char *cp;
1036
  int width;
1037

1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
  /* 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))
    {
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
      /* Prepend "-" if the NaN's sign bit is negative.
	 The sign bit of a double is the bit that is 1 in -0.0.  */
      int i;
      union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
      u_data.d = data;
      u_minus_zero.d = - 0.0;
      for (i = 0; i < sizeof (double); i++)
	if (u_data.c[i] & u_minus_zero.c[i])
	  {
	    *buf++ = '-';
	    break;
	  }
1066

1067 1068 1069 1070
      strcpy (buf, "0.0e+NaN");
      return;
    }

Jim Blandy's avatar
Jim Blandy committed
1071
  if (NILP (Vfloat_output_format)