print.c 40.2 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985, 86, 88, 93, 94, 95 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 48 49 50 51 52
#ifdef LISP_FLOAT_TYPE
Lisp_Object Vfloat_output_format, Qfloat_output_format;
#endif /* LISP_FLOAT_TYPE */

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

53 54 55 56
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
Lisp_Object being_printed[PRINT_CIRCLE];

57 58 59 60 61 62 63 64 65
/* 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;
/* Size used in print_buffer.  */
int print_buffer_pos;

Jim Blandy's avatar
Jim Blandy committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
/* 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
82 83 84 85
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

86 87 88
/* 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.  */
89

90
Lisp_Object Vprint_gensym;
91 92 93 94 95

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

96
Lisp_Object Vprint_gensym_alist;
Erik Naggum's avatar
Erik Naggum committed
97

98
/* Nonzero means print newline to stdout before next minibuffer message.
Jim Blandy's avatar
Jim Blandy committed
99 100 101
   Defined in xdisp.c */

extern int noninteractive_need_newline;
102

Jim Blandy's avatar
Jim Blandy committed
103 104 105 106
#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
107 108

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161

#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

162
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
163 164

/* Lisp functions to do output using a stream
165 166 167 168 169
   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
170 171
*/ 

172 173 174
#define PRINTDECLARE						\
   struct buffer *old = current_buffer;				\
   int old_point = -1, start_point;				\
175 176
   int specpdl_count = specpdl_ptr - specpdl;			\
   int free_print_buffer = 0;					\
177 178
   Lisp_Object original

179 180 181
#define PRINTPREPARE						\
   original = printcharfun;					\
   if (NILP (printcharfun)) printcharfun = Qt;			\
182
   if (BUFFERP (printcharfun))					\
183 184
     {								\
       if (XBUFFER (printcharfun) != current_buffer)		\
185
	 Fset_buffer (printcharfun);				\
186 187
       printcharfun = Qnil;					\
     }								\
188
   if (MARKERP (printcharfun))					\
189 190
     {								\
       if (!(XMARKER (original)->buffer))			\
191 192 193
         error ("Marker does not point anywhere");		\
       if (XMARKER (original)->buffer != current_buffer)	\
         set_buffer_internal (XMARKER (original)->buffer);	\
194
       old_point = PT;						\
195
       SET_PT (marker_position (printcharfun));			\
196
       start_point = PT;					\
197 198
       printcharfun = Qnil;					\
     }								\
199 200
   if (NILP (printcharfun))					\
     {								\
201 202 203 204 205 206 207 208
       if (print_buffer != 0)					\
	 record_unwind_protect (print_unwind,			\
				make_string (print_buffer,	\
					     print_buffer_pos)); \
       else							\
	 {							\
           print_buffer_size = 1000;				\
           print_buffer = (char *) xmalloc (print_buffer_size);	\
209
	   free_print_buffer = 1;				\
210
	 }							\
211 212
       print_buffer_pos = 0;					\
     }								\
213 214
   if (!CONSP (Vprint_gensym))					\
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
215

216
#define PRINTFINISH					\
217 218
   if (NILP (printcharfun))				\
     insert (print_buffer, print_buffer_pos);		\
219
   if (free_print_buffer)				\
220
     {							\
221
       xfree (print_buffer);				\
222 223
       print_buffer = 0;				\
     }							\
224
   unbind_to (specpdl_count, Qnil);			\
225
   if (MARKERP (original))				\
226
     Fset_marker (original, make_number (PT), Qnil);	\
227 228
   if (old_point >= 0)					\
     SET_PT (old_point + (old_point >= start_point	\
229
			  ? PT - start_point : 0));	\
230
   if (old != current_buffer)				\
231
     set_buffer_internal (old);				\
232 233
   if (!CONSP (Vprint_gensym))				\
     Vprint_gensym_alist = Qnil
Jim Blandy's avatar
Jim Blandy committed
234 235 236

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

237 238 239 240 241 242 243
/* 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)))))

244 245 246 247 248 249 250 251 252
/* 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);
}

253
/* Index of first unused element of FRAME_MESSAGE_BUF (mini_frame). */
Jim Blandy's avatar
Jim Blandy committed
254 255 256 257
static int printbufidx;

static void
printchar (ch, fun)
Karl Heuer's avatar
Karl Heuer committed
258
     unsigned int ch;
Jim Blandy's avatar
Jim Blandy committed
259 260 261 262 263 264 265 266 267 268 269
     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
270 271 272
      int len;
      char work[4], *str;

Jim Blandy's avatar
Jim Blandy committed
273
      QUIT;
Karl Heuer's avatar
Karl Heuer committed
274 275
      len = CHAR_STRING (ch, work, str);
      if (print_buffer_pos + len >= print_buffer_size)
276 277
	print_buffer = (char *) xrealloc (print_buffer,
					  print_buffer_size *= 2);
Karl Heuer's avatar
Karl Heuer committed
278 279
      bcopy (str, print_buffer + print_buffer_pos, len);
      print_buffer_pos += len;
Jim Blandy's avatar
Jim Blandy committed
280 281 282 283 284
      return;
    }

  if (EQ (fun, Qt))
    {
285
      FRAME_PTR mini_frame
286
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));
Karl Heuer's avatar
Karl Heuer committed
287 288
      unsigned char work[4], *str;
      int len = CHAR_STRING (ch, work, str);
289

290 291
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
292 293
      if (noninteractive)
	{
Karl Heuer's avatar
Karl Heuer committed
294 295
	  while (len--)
	    putchar (*str), str++;
Jim Blandy's avatar
Jim Blandy committed
296 297 298 299
	  noninteractive_need_newline = 1;
	  return;
	}

300
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
301 302
	  || !message_buf_print)
	{
303
	  message_log_maybe_newline ();
304
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
305
	  printbufidx = 0;
306
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
307 308 309
	  message_buf_print = 1;
	}

Karl Heuer's avatar
Karl Heuer committed
310 311 312 313
      message_dolog (str, len, 0);
      if (printbufidx < FRAME_MESSAGE_BUF_SIZE (mini_frame) - len)
	bcopy (str, &FRAME_MESSAGE_BUF (mini_frame)[printbufidx], len),
	printbufidx += len;
314
      FRAME_MESSAGE_BUF (mini_frame)[printbufidx] = 0;
315
      echo_area_glyphs_length = printbufidx;
Jim Blandy's avatar
Jim Blandy committed
316 317 318 319 320

      return;
    }
#endif /* not standalone */

321
  XSETFASTINT (ch1, ch);
Jim Blandy's avatar
Jim Blandy committed
322 323 324 325 326 327 328 329 330 331 332
  call1 (fun, ch1);
}

static void
strout (ptr, size, printcharfun)
     char *ptr;
     int size;
     Lisp_Object printcharfun;
{
  int i = 0;

Karl Heuer's avatar
Karl Heuer committed
333 334 335
  if (size < 0)
    size = strlen (ptr);

Jim Blandy's avatar
Jim Blandy committed
336 337
  if (EQ (printcharfun, Qnil))
    {
338 339 340 341 342 343 344 345 346
      if (print_buffer_pos + size > print_buffer_size)
	{
	  print_buffer_size = print_buffer_size * 2 + size;
	  print_buffer = (char *) xrealloc (print_buffer,
					    print_buffer_size);
	}
      bcopy (ptr, print_buffer + print_buffer_pos, size);
      print_buffer_pos += size;

Jim Blandy's avatar
Jim Blandy committed
347 348
#ifdef MAX_PRINT_CHARS
      if (max_print)
349
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
350 351 352 353 354
#endif /* MAX_PRINT_CHARS */
      return;
    }
  if (EQ (printcharfun, Qt))
    {
355
      FRAME_PTR mini_frame
356 357
	= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)));

358 359
      QUIT;

Jim Blandy's avatar
Jim Blandy committed
360 361
#ifdef MAX_PRINT_CHARS
      if (max_print)
Karl Heuer's avatar
Karl Heuer committed
362
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
363 364 365 366
#endif /* MAX_PRINT_CHARS */

      if (noninteractive)
	{
Karl Heuer's avatar
Karl Heuer committed
367
	  fwrite (ptr, 1, size, stdout);
Jim Blandy's avatar
Jim Blandy committed
368 369 370 371
	  noninteractive_need_newline = 1;
	  return;
	}

372
      if (echo_area_glyphs != FRAME_MESSAGE_BUF (mini_frame)
Jim Blandy's avatar
Jim Blandy committed
373 374
	  || !message_buf_print)
	{
375
	  message_log_maybe_newline ();
376
	  echo_area_glyphs = FRAME_MESSAGE_BUF (mini_frame);
Jim Blandy's avatar
Jim Blandy committed
377
	  printbufidx = 0;
378
	  echo_area_glyphs_length = 0;
Jim Blandy's avatar
Jim Blandy committed
379 380 381
	  message_buf_print = 1;
	}

Karl Heuer's avatar
Karl Heuer committed
382 383 384 385 386 387 388 389 390
      message_dolog (ptr, size, 0);
      if (size > FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1)
	{
	  size = FRAME_MESSAGE_BUF_SIZE (mini_frame) - printbufidx - 1;
	  /* Rewind incomplete multi-byte form.  */
	  while (size && (unsigned char) ptr[size] >= 0xA0) size--;
	}
      bcopy (ptr, &FRAME_MESSAGE_BUF (mini_frame) [printbufidx], size);
      printbufidx += size;
391
      echo_area_glyphs_length = printbufidx;
392
      FRAME_MESSAGE_BUF (mini_frame) [printbufidx] = 0;
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396

      return;
    }

Karl Heuer's avatar
Karl Heuer committed
397 398 399 400 401 402 403 404 405 406 407
  i = 0;
  while (i < size)
    {
      /* 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 - i, len);

      PRINTCHAR (ch);
      i += len;
    }
Jim Blandy's avatar
Jim Blandy committed
408 409 410
}

/* Print the contents of a string STRING using PRINTCHARFUN.
411 412
   It isn't safe to use strout in many cases,
   because printing one char can relocate.  */
Jim Blandy's avatar
Jim Blandy committed
413 414 415 416 417

print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
418 419
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
    /* strout is safe for output to a frame (echo area) or to print_buffer.  */
Jim Blandy's avatar
Jim Blandy committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
    strout (XSTRING (string)->data, XSTRING (string)->size, printcharfun);
  else
    {
      /* Otherwise, fetch the string address for each character.  */
      int i;
      int size = XSTRING (string)->size;
      struct gcpro gcpro1;
      GCPRO1 (string);
      for (i = 0; i < size; i++)
	PRINTCHAR (XSTRING (string)->data[i]);
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
435
  "Output character CHARACTER to stream PRINTCHARFUN.\n\
Karl Heuer's avatar
Karl Heuer committed
436
PRINTCHARFUN defaults to the value of `standard-output' (which see).")
437 438
  (character, printcharfun)
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
439
{
440
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
441

Jim Blandy's avatar
Jim Blandy committed
442
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
443
    printcharfun = Vstandard_output;
444
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
445
  PRINTPREPARE;
446
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
447
  PRINTFINISH;
448
  return character;
Jim Blandy's avatar
Jim Blandy committed
449 450 451 452 453 454 455 456 457 458
}

/* Used from outside of print.c to print a block of SIZE chars at DATA
   on the default output stream.
   Do not use this on the contents of a Lisp string.  */

write_string (data, size)
     char *data;
     int size;
{
459
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
  strout (data, size, printcharfun);
  PRINTFINISH;
}

/* Used from outside of print.c to print a block of SIZE chars at DATA
   on a specified stream PRINTCHARFUN.
   Do not use this on the contents of a Lisp string.  */

write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
478
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496

  PRINTPREPARE;
  strout (data, size, printcharfun);
  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)));

497
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
498 499 500
  current_buffer->read_only = Qnil;
  Ferase_buffer ();

501
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
502 503 504 505 506 507 508 509 510 511 512 513 514
  specbind (Qstandard_output, buf);

  set_buffer_internal (old);
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
     char *bufname;
     Lisp_Object (*function) ();
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
515
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
516

517
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
518 519 520
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
521
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
522 523 524

  val = (*function) (args);

525
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
526
  temp_output_buffer_show (buf);
527
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
528 529 530 531 532 533 534 535 536 537 538 539

  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\
540
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
Jim Blandy's avatar
Jim Blandy committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
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
569 570
  "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
571 572 573
  (printcharfun)
     Lisp_Object printcharfun;
{
574
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
575

Jim Blandy's avatar
Jim Blandy committed
576
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580 581 582 583 584 585 586 587
    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
588
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
589 590
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
591
{
592
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
597
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
598 599 600
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
601
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
602
  PRINTFINISH;
603
  return object;
Jim Blandy's avatar
Jim Blandy committed
604 605 606 607 608 609 610 611 612 613
}

/* 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.")
614 615
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
616
{
617 618
  PRINTDECLARE;
  Lisp_Object printcharfun;
619 620 621 622 623 624 625 626
  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
627 628 629 630

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
  print_depth = 0;
631
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
632 633 634
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
635
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
636 637 638

  Ferase_buffer ();
  set_buffer_internal (old);
639 640

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
641 642
  UNGCPRO;

643
  return object;
Jim Blandy's avatar
Jim Blandy committed
644 645 646 647 648 649
}

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
650
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
651 652
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
653
{
654
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
655

Jim Blandy's avatar
Jim Blandy committed
656
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
657 658 659
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  print_depth = 0;
660
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
661
  PRINTFINISH;
662
  return object;
Jim Blandy's avatar
Jim Blandy committed
663 664 665 666 667 668
}

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
669
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
670 671
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
672
{
673
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
674 675 676 677 678 679
  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
680
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
681
    printcharfun = Vstandard_output;
682
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
683 684 685
  PRINTPREPARE;
  print_depth = 0;
  PRINTCHAR ('\n');
686
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
687 688 689 690 691 692 693
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
694
  return object;
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698 699 700
}

/* 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
701 702
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
703 704
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
705 706
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
707 708 709 710 711 712
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
  
  return character;
}
713 714 715 716 717 718 719 720

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
721
  fprintf (stderr, "\r\n");
722
}
Jim Blandy's avatar
Jim Blandy committed
723

724 725 726 727 728 729 730 731 732 733
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;

734 735 736 737 738 739 740 741 742
  /* 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;

743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 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 796 797 798 799 800 801 802 803 804 805 806 807
  print_error_message (obj, Vprin1_to_string_buffer, NULL);

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

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
808 809 810
#ifdef LISP_FLOAT_TYPE

/*
811
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
812
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
813 814 815 816 817 818 819 820 821 822
 * 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
 */
823 824 825

void
float_to_string (buf, data)
826
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
827 828
     double data;
{
829
  unsigned char *cp;
830
  int width;
Jim Blandy's avatar
Jim Blandy committed
831
      
Jim Blandy's avatar
Jim Blandy committed
832
  if (NILP (Vfloat_output_format)
833
      || !STRINGP (Vfloat_output_format))
Jim Blandy's avatar
Jim Blandy committed
834
  lose:
835 836 837 838
    {
      sprintf (buf, "%.17g", data);
      width = -1;
    }
Jim Blandy's avatar
Jim Blandy committed
839 840 841 842 843 844 845 846 847 848 849 850 851
  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;
852 853

      /* Check the width specification.  */
854
      width = -1;
855
      if ('0' <= *cp && *cp <= '9')
856 857 858 859 860 861 862 863 864 865 866
	{
	  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
867 868 869 870 871 872 873 874 875

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

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

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

877 878
  /* 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
879 880 881
     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)
882
    {
883 884 885
      for (cp = buf; *cp; cp++)
	if ((*cp < '0' || *cp > '9') && *cp != '-')
	  break;
886

887 888 889 890 891 892 893 894 895 896 897 898
      if (*cp == '.' && cp[1] == 0)
	{
	  cp[1] = '0';
	  cp[2] = 0;
	}

      if (*cp == 0)
	{
	  *cp++ = '.';
	  *cp++ = '0';
	  *cp++ = 0;
	}
899
    }
Jim Blandy's avatar
Jim Blandy committed
900 901 902 903 904 905 906 907 908 909 910 911 912
}
#endif /* LISP_FLOAT_TYPE */

static void
print (obj, printcharfun, escapeflag)
     Lisp_Object obj;
     register Lisp_Object printcharfun;
     int escapeflag;
{
  char buf[30];

  QUIT;

913 914 915
#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.  */
916
  if (CONSP (obj) || VECTORP (obj) || COMPILEDP (obj))
917 918 919 920 921 922 923 924 925 926 927 928 929
    {
      int i;
      for (i = 0; i < print_depth; i++)
	if (EQ (obj, being_printed[i]))
	  {
	    sprintf (buf, "#%d", i);
	    strout (buf, -1, printcharfun);
	    return;
	  }
    }
#endif

  being_printed[print_depth] = obj;
Jim Blandy's avatar
Jim Blandy committed
930 931
  print_depth++;

932
  if (print_depth > PRINT_CIRCLE)
Jim Blandy's avatar
Jim Blandy committed
933 934 935 936 937 938 939 940 941
    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 */

942
  switch (XGCTYPE (obj))
Jim Blandy's avatar
Jim Blandy committed
943
    {
944
    case Lisp_Int:
945 946 947 948 949 950
      if (sizeof (int) == sizeof (EMACS_INT))
	sprintf (buf, "%d", XINT (obj));
      else if (sizeof (long) == sizeof (EMACS_INT))
	sprintf (buf, "%ld", XINT (obj));
      else
	abort ();
Jim Blandy's avatar
Jim Blandy committed
951
      strout (buf, -1, printcharfun);
952 953
      break;

Karl Heuer's avatar
Karl Heuer committed
954
#ifdef LISP_FLOAT_TYPE
955 956 957
    case Lisp_Float:
      {
	char pigbuf[350];	/* see comments in float_to_string */
Jim Blandy's avatar
Jim Blandy committed
958

959 960 961 962
	float_to_string (pigbuf, XFLOAT(obj)->data);
	strout (pigbuf, -1, printcharfun);
      }
      break;
Karl Heuer's avatar
Karl Heuer committed
963
#endif
964 965

    case Lisp_String:
Jim Blandy's avatar
Jim Blandy committed
966 967 968 969 970 971 972 973
      if (!escapeflag)
	print_string (obj, printcharfun);
      else
	{
	  register int i;
	  register unsigned char c;
	  struct gcpro gcpro1;

Richard M. Stallman's avatar
Richard M. Stallman committed
974 975 976 977 978 979 980 981 982
	  GCPRO1 (obj);

#ifdef USE_TEXT_PROPERTIES
	  if (!NULL_INTERVAL_P (XSTRING (obj)->intervals))
	    {
	      PRINTCHAR ('#');
	      PRINTCHAR ('(');
	    }
#endif
Jim Blandy's avatar
Jim Blandy committed
983 984 985 986 987 988 989 990 991 992 993

	  PRINTCHAR ('\"');
	  for (i = 0; i < XSTRING (obj)->size; i++)
	    {
	      QUIT;
	      c = XSTRING (obj)->data[i];
	      if (c == '\n' && print_escape_newlines)
		{
		  PRINTCHAR ('\\');
		  PRINTCHAR ('n');
		}
994 995 996 997 998
	      else if (c == '\f' && print_escape_newlines)
		{
		  PRINTCHAR ('\\');
		  PRINTCHAR ('f');
		}
Jim Blandy's avatar
Jim Blandy committed
999 1000 1001 1002 1003 1004 1005 1006
	      else
		{
		  if (c == '\"' || c == '\\')
		    PRINTCHAR ('\\');
		  PRINTCHAR (c);
		}
	    }
	  PRINTCHAR ('\"');
Richard M. Stallman's avatar
Richard M. Stallman committed
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016

#ifdef USE_TEXT_PROPERTIES
	  if (!NULL_INTERVAL_P (XSTRING (obj)->intervals))
	    {
	      traverse_intervals (XSTRING (obj)->intervals,
				  0, 0, print_interval, printcharfun);
	      PRINTCHAR (')');
	    }
#endif

Jim Blandy's avatar
Jim Blandy committed
1017 1018
	  UNGCPRO;
	}
1019
      break;
Jim Blandy's avatar
Jim Blandy committed
1020

1021 1022 1023 1024 1025 1026
    case Lisp_Symbol:
      {
	register int confusing;
	register unsigned char *p = XSYMBOL (obj)->name->data;
	register unsigned char *end = p + XSYMBOL (obj)->name->size;
	register unsigned char c;
1027
	int i;
1028 1029 1030 1031

	if (p != end && (*p == '-' || *p == '+')) p++;
	if (p == end)
	  confusing = 0;
1032 1033 1034 1035 1036 1037 1038 1039 1040
	/* If symbol name begins with a digit, and ends with a digit,
	   and contains nothing but digits and `e', it could be treated
	   as a number.  So set CONFUSING.

	   Symbols that contain periods could also be taken as numbers,
	   but periods are always escaped, so we don't have to worry
	   about them here.  */
	else if (*p >= '0' && *p <= '9'
		 && end[-1] >= '0' && end[-1] <= '9')
1041
	  {
1042 1043 1044
	    while (p != end && ((*p >= '0' && *p <= '9')
				/* Needed for \2e10.  */
				|| *p == 'e'))
1045 1046 1047
	      p++;
	    confusing = (end == p);
	  }
1048 1049
	else
	  confusing = 0;
1050

1051 1052 1053
	/* If we print an uninterned symbol as part of a complex object and
	   the flag print-gensym is non-nil, prefix it with #n= to read the
	   object back with the #n# reader syntax later if needed.  */
1054
	if (! NILP (Vprint_gensym) && NILP (XSYMBOL (obj)->obarray))
1055 1056 1057 1058
	  {
	    if (print_depth > 1)
	      {
		Lisp_Object tem;
1059
		tem = Fassq (obj, Vprint_gensym_alist);
1060 1061 1062 1063 1064 1065 1066 1067 1068
		if (CONSP (tem))
		  {
		    PRINTCHAR ('#');
		    print (XCDR (tem), printcharfun, escapeflag);
		    PRINTCHAR ('#');
		    break;
		  }
		else
		  {
1069 1070
		    if (CONSP (Vprint_gensym_alist))
		      XSETFASTINT (tem, XFASTINT (XCDR (XCAR (Vprint_gensym_alist))) + 1);
1071 1072
		    else
		      XSETFASTINT (tem, 1);
1073
		    Vprint_gensym_alist = Fcons (Fcons (obj, tem), Vprint_gensym_alist);
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083

		    PRINTCHAR ('#');
		    print (tem, printcharfun, escapeflag);
		    PRINTCHAR ('=');
		  }
	      }
	    PRINTCHAR ('#');
	    PRINTCHAR (':');
	  }

1084
	for (i = 0; i < XSYMBOL (obj)->name->size; i++)
1085 1086
	  {
	    QUIT;
1087 1088
	    c = XSYMBOL (obj)->name->data[i];

1089 1090
	    if (escapeflag)
	      {
1091 1092 1093 1094 1095
		if (c == '\"' || c == '\\' || c == '\''
		    || c == ';' || c == '#' || c == '(' || c == ')'
		    || c == ',' || c =='.' || c == '`'
		    || c == '[' || c == ']' || c == '?' || c <= 040
		    || confusing)
1096 1097 1098 1099 1100 1101 1102 1103
		  PRINTCHAR ('\\'), confusing = 0;
	      }
	    PRINTCHAR (c);
	  }
      }
      break;

    case Lisp_Cons:
Jim Blandy's avatar
Jim Blandy committed
1104
      /* If deeper than spec'd depth, print placeholder.  */
1105
      if (INTEGERP (Vprint_level)
Jim Blandy's avatar
Jim Blandy committed
1106
	  && print_depth > XINT (Vprint_level))
Karl Heuer's avatar
Karl Heuer committed
1107
	strout ("...", -1, printcharfun);
Erik Naggum's avatar
Erik Naggum committed
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
      else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
	       && (EQ (XCAR (obj), Qquote)))
	{
	  PRINTCHAR ('\'');
	  print (XCAR (XCDR (obj)), printcharfun, escapeflag);
	}
      else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
	       && (EQ (XCAR (obj), Qfunction)))
	{
	  PRINTCHAR ('#');
	  PRINTCHAR ('\'');
	  print (XCAR (XCDR (obj)), printcharfun, escapeflag);
	}
      else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
	       && ((EQ (XCAR (obj), Qbackquote)
		    || EQ (XCAR (obj), Qcomma)
		    || EQ (XCAR (obj), Qcomma_at)
		    || EQ (XCAR (obj), Qcomma_dot))))
	{
	  print (XCAR (obj), printcharfun, 0);
	  print (XCAR (XCDR (obj)), printcharfun, escapeflag);
	}
Karl Heuer's avatar
Karl Heuer committed
1130
      else
Jim Blandy's avatar
Jim Blandy committed
1131
	{
Karl Heuer's avatar
Karl Heuer committed
1132
	  PRINTCHAR ('(');
Jim Blandy's avatar
Jim Blandy committed
1133
	  {
Karl Heuer's avatar
Karl Heuer committed
1134 1135 1136 1137 1138 1139 1140 1141 1142
	    register int i = 0;
	    register int max = 0;

	    if (INTEGERP (Vprint_length))
	      max = XINT (Vprint_length);
	    /* Could recognize circularities in cdrs here,
	       but that would make printing of long lists quadratic.
	       It's not worth doing.  */
	    while (CONSP (obj))
Jim Blandy's avatar
Jim Blandy committed
1143
	      {
Karl Heuer's avatar
Karl Heuer committed
1144 1145 1146 1147 1148 1149 1150
		if (i++)
		  PRINTCHAR (' ');
		if (max && i > max)
		  {
		    strout ("...", 3, printcharfun);
		    break;
		  }
Erik Naggum's avatar
Erik Naggum committed
1151 1152
		print (XCAR (obj), printcharfun, escapeflag);
		obj = XCDR (obj);
Jim Blandy's avatar
Jim Blandy committed
1153 1154
	      }
	  }
Erik Naggum's avatar
Erik Naggum committed
1155