print.c 67.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp object printing and output streams.
2

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2015 Free Software
4
Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
23
#include "sysstdio.h"
24

Jim Blandy's avatar
Jim Blandy committed
25
#include "lisp.h"
26
#include "character.h"
27
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
28
#include "charset.h"
29
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31 32 33 34
#include "window.h"
#include "process.h"
#include "dispextern.h"
#include "termchar.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
35
#include "intervals.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
36
#include "blockinput.h"
37
#include "termhooks.h"		/* For struct terminal.  */
Kenichi Handa's avatar
Kenichi Handa committed
38
#include "font.h"
jave's avatar
jave committed
39

Paul Eggert's avatar
Paul Eggert committed
40
#include <float.h>
Paul Eggert's avatar
Paul Eggert committed
41
#include <ftoastr.h>
Paul Eggert's avatar
Paul Eggert committed
42

Jim Blandy's avatar
Jim Blandy committed
43
/* Avoid actual stack overflow in print.  */
44
static ptrdiff_t print_depth;
Jim Blandy's avatar
Jim Blandy committed
45

46
/* Level of nesting inside outputting backquote in new style.  */
47
static ptrdiff_t new_backquote_output;
48

49 50
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
51
static Lisp_Object being_printed[PRINT_CIRCLE];
52

53 54 55
/* Last char printed to stdout by printchar.  */
static unsigned int printchar_stdout_last;

56 57
/* When printing into a buffer, first we put the text in this
   block, then insert it all at once.  */
58
static char *print_buffer;
59 60

/* Size allocated in print_buffer.  */
61
static ptrdiff_t print_buffer_size;
62
/* Chars stored in print_buffer.  */
63
static ptrdiff_t print_buffer_pos;
64
/* Bytes stored in print_buffer.  */
65
static ptrdiff_t print_buffer_pos_byte;
66

67 68 69 70 71 72 73 74
/* Vprint_number_table is a table, that keeps objects that are going to
   be printed, to allow use of #n= and #n# to express sharing.
   For any given object, the table can give the following values:
     t    the object will be printed only once.
     -N   the object will be printed several times and will take number N.
     N    the object has been printed so we can refer to it as #N#.
   print_number_index holds the largest N already used.
   N has to be striclty larger than 0 since we need to distinguish -N.  */
75
static ptrdiff_t print_number_index;
76
static void print_interval (INTERVAL interval, Lisp_Object printcharfun);
Jim Blandy's avatar
Jim Blandy committed
77

78
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
79
bool print_output_debug_flag EXTERNALLY_VISIBLE = 1;
80

Jim Blandy's avatar
Jim Blandy committed
81

82
/* Low level output routines for characters and strings.  */
Jim Blandy's avatar
Jim Blandy committed
83 84

/* Lisp functions to do output using a stream
85 86 87 88
   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,
89
   or call strout to output a block of characters.  */
90 91 92

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
93 94 95
   ptrdiff_t old_point = -1, start_point = -1;				\
   ptrdiff_t old_point_byte = -1, start_point_byte = -1;		\
   ptrdiff_t specpdl_count = SPECPDL_INDEX ();				\
96
   bool free_print_buffer = 0;						\
97 98
   bool multibyte							\
     = !NILP (BVAR (current_buffer, enable_multibyte_characters));	\
99 100
   Lisp_Object original

101 102 103 104 105 106 107 108 109 110 111
#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))						\
     {									\
112
       ptrdiff_t marker_pos;						\
Andreas Schwab's avatar
Andreas Schwab committed
113
       if (! XMARKER (printcharfun)->buffer)				\
114
         error ("Marker does not point anywhere");			\
115 116 117 118
       if (XMARKER (printcharfun)->buffer != current_buffer)		\
         set_buffer_internal (XMARKER (printcharfun)->buffer);		\
       marker_pos = marker_position (printcharfun);			\
       if (marker_pos < BEGV || marker_pos > ZV)			\
Joakim Verona's avatar
Joakim Verona committed
119 120
	 signal_error ("Marker is outside the accessible "		\
		       "part of the buffer", printcharfun);		\
121 122
       old_point = PT;							\
       old_point_byte = PT_BYTE;					\
123
       SET_PT_BOTH (marker_pos,						\
124 125 126 127 128 129 130 131
		    marker_byte_position (printcharfun));		\
       start_point = PT;						\
       start_point_byte = PT_BYTE;					\
       printcharfun = Qnil;						\
     }									\
   if (NILP (printcharfun))						\
     {									\
       Lisp_Object string;						\
Joakim Verona's avatar
Joakim Verona committed
132
       if (NILP (BVAR (current_buffer, enable_multibyte_characters))	\
133 134
	   && ! print_escape_multibyte)					\
         specbind (Qprint_escape_multibyte, Qt);			\
Joakim Verona's avatar
Joakim Verona committed
135
       if (! NILP (BVAR (current_buffer, enable_multibyte_characters))	\
136 137
	   && ! print_escape_nonascii)					\
         specbind (Qprint_escape_nonascii, Qt);				\
138 139 140 141 142 143 144 145 146
       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								\
	 {								\
147
	   int new_size = 1000;						\
Dmitry Antipov's avatar
Dmitry Antipov committed
148
	   print_buffer = xmalloc (new_size);				\
149
	   print_buffer_size = new_size;				\
150 151 152 153 154
	   free_print_buffer = 1;					\
	 }								\
       print_buffer_pos = 0;						\
       print_buffer_pos_byte = 0;					\
     }									\
155
   if (EQ (printcharfun, Qt) && ! noninteractive)			\
156
     setup_echo_area_for_printing (multibyte);
Jim Blandy's avatar
Jim Blandy committed
157

158 159 160 161
#define PRINTFINISH							\
   if (NILP (printcharfun))						\
     {									\
       if (print_buffer_pos != print_buffer_pos_byte			\
Joakim Verona's avatar
Joakim Verona committed
162
	   && NILP (BVAR (current_buffer, enable_multibyte_characters)))\
163
	 {								\
164 165
	   USE_SAFE_ALLOCA;						\
	   unsigned char *temp = SAFE_ALLOCA (print_buffer_pos + 1);	\
166 167
	   copy_text ((unsigned char *) print_buffer, temp,		\
		      print_buffer_pos_byte, 1, 0);			\
168
	   insert_1_both ((char *) temp, print_buffer_pos,		\
169
			  print_buffer_pos, 0, 1, 0);			\
170
	   SAFE_FREE ();						\
171 172 173 174
	 }								\
       else								\
	 insert_1_both (print_buffer, print_buffer_pos,			\
			print_buffer_pos_byte, 0, 1, 0);		\
175
       signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
176 177 178 179 180 181 182 183 184 185 186 187
     }									\
   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),			\
188
		  old_point_byte + (old_point_byte >= start_point_byte	\
Andreas Schwab's avatar
Andreas Schwab committed
189
				    ? PT_BYTE - start_point_byte : 0));	\
190
   set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
191 192 193

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

194 195
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
196

197
static void
198
print_unwind (Lisp_Object saved_text)
199
{
200
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
201 202
}

203 204 205 206 207

/* 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
208 209

static void
210
printchar (unsigned int ch, Lisp_Object fun)
Jim Blandy's avatar
Jim Blandy committed
211
{
212 213 214
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
215
    {
216 217 218
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

219
      QUIT;
220

221
      if (NILP (fun))
222
	{
223
	  ptrdiff_t incr = len - (print_buffer_size - print_buffer_pos_byte);
224 225 226
	  if (incr > 0)
	    print_buffer = xpalloc (print_buffer, &print_buffer_size,
				    incr, -1, 1);
227
	  memcpy (print_buffer + print_buffer_pos_byte, str, len);
228 229
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
230
	}
231
      else if (noninteractive)
232
	{
233
	  printchar_stdout_last = ch;
234 235
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
236
	}
237
      else
238
	{
239
	  bool multibyte_p
Tom Tromey's avatar
Tom Tromey committed
240
	    = !NILP (BVAR (current_buffer, enable_multibyte_characters));
241

242
	  setup_echo_area_for_printing (multibyte_p);
243
	  insert_char (ch);
244
	  message_dolog ((char *) str, len, 0, multibyte_p);
245
	}
Jim Blandy's avatar
Jim Blandy committed
246 247 248
    }
}

249 250 251 252 253 254 255

/* 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
256 257 258 259
   non-zero means PTR contains multibyte characters.

   In the case where PRINTCHARFUN is nil, it is safe for PTR to point
   to data in a Lisp string.  Otherwise that is not safe.  */
260

Jim Blandy's avatar
Jim Blandy committed
261
static void
262
strout (const char *ptr, ptrdiff_t size, ptrdiff_t size_byte,
263
	Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
264
{
Karl Heuer's avatar
Karl Heuer committed
265
  if (size < 0)
266
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
267

268
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
269
    {
270
      ptrdiff_t incr = size_byte - (print_buffer_size - print_buffer_pos_byte);
271
      if (incr > 0)
272
	print_buffer = xpalloc (print_buffer, &print_buffer_size, incr, -1, 1);
273
      memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
274
      print_buffer_pos += size;
275
      print_buffer_pos_byte += size_byte;
Jim Blandy's avatar
Jim Blandy committed
276
    }
277
  else if (noninteractive && EQ (printcharfun, Qt))
Jim Blandy's avatar
Jim Blandy committed
278
    {
279 280 281 282 283 284 285 286 287
      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;
288
      bool multibyte_p
Tom Tromey's avatar
Tom Tromey committed
289
	= !NILP (BVAR (current_buffer, enable_multibyte_characters));
290

291
      setup_echo_area_for_printing (multibyte_p);
292
      message_dolog (ptr, size_byte, 0, multibyte_p);
293

294
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
295
	{
296
	  for (i = 0; i < size; ++i)
Andreas Schwab's avatar
Andreas Schwab committed
297
	    insert_char ((unsigned char) *ptr++);
Jim Blandy's avatar
Jim Blandy committed
298
	}
299
      else
Jim Blandy's avatar
Jim Blandy committed
300
	{
301 302
	  int len;
	  for (i = 0; i < size_byte; i += len)
303
	    {
304 305
	      int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
					       len);
306
	      insert_char (ch);
307
	    }
Jim Blandy's avatar
Jim Blandy committed
308
	}
309 310 311 312
    }
  else
    {
      /* PRINTCHARFUN is a Lisp function.  */
313
      ptrdiff_t i = 0;
Jim Blandy's avatar
Jim Blandy committed
314

315
      if (size == size_byte)
316
	{
317
	  while (i < size_byte)
318
	    {
319 320
	      int ch = ptr[i++];
	      PRINTCHAR (ch);
321 322
	    }
	}
323
      else
Karl Heuer's avatar
Karl Heuer committed
324
	{
325 326 327 328 329 330
	  while (i < size_byte)
	    {
	      /* Here, we must convert each multi-byte form to the
		 corresponding character code before handing it to
		 PRINTCHAR.  */
	      int len;
331 332
	      int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
					       len);
333 334 335
	      PRINTCHAR (ch);
	      i += len;
	    }
Karl Heuer's avatar
Karl Heuer committed
336
	}
Jim Blandy's avatar
Jim Blandy committed
337 338 339 340
    }
}

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

344
static void
345
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
346
{
347
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
348
    {
349
      ptrdiff_t chars;
350

351 352 353
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

354
      if (STRING_MULTIBYTE (string))
355
	chars = SCHARS (string);
356 357
      else if (! print_escape_nonascii
	       && (EQ (printcharfun, Qt)
Tom Tromey's avatar
Tom Tromey committed
358 359
		   ? ! NILP (BVAR (&buffer_defaults, enable_multibyte_characters))
		   : ! NILP (BVAR (current_buffer, enable_multibyte_characters))))
360 361 362 363 364
	{
	  /* If unibyte string STRING contains 8-bit codes, we must
	     convert STRING to a multibyte string containing the same
	     character codes.  */
	  Lisp_Object newstr;
365
	  ptrdiff_t bytes;
366

367
	  chars = SBYTES (string);
368
	  bytes = count_size_as_multibyte (SDATA (string), chars);
369 370 371
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
372
	      memcpy (SDATA (newstr), SDATA (string), chars);
373
	      str_to_multibyte (SDATA (newstr), bytes, chars);
374 375 376
	      string = newstr;
	    }
	}
377
      else
378
	chars = SBYTES (string);
379

380 381 382
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
383
	  ptrdiff_t nbytes = SBYTES (string);
384 385 386 387

	  /* Copy the string contents so that relocation of STRING by
	     GC does not cause trouble.  */
	  USE_SAFE_ALLOCA;
388
	  char *buffer = SAFE_ALLOCA (nbytes);
389
	  memcpy (buffer, SDATA (string), nbytes);
390

391
	  strout (buffer, chars, nbytes, printcharfun);
392 393 394 395 396

	  SAFE_FREE ();
	}
      else
	/* No need to copy, since output to print_buffer can't GC.  */
397
	strout (SSDATA (string), chars, SBYTES (string), printcharfun);
398
    }
Jim Blandy's avatar
Jim Blandy committed
399 400
  else
    {
401 402
      /* Otherwise, string may be relocated by printing one char.
	 So re-fetch the string address for each character.  */
403 404 405
      ptrdiff_t i;
      ptrdiff_t size = SCHARS (string);
      ptrdiff_t size_byte = SBYTES (string);
Jim Blandy's avatar
Jim Blandy committed
406 407
      struct gcpro gcpro1;
      GCPRO1 (string);
408 409
      if (size == size_byte)
	for (i = 0; i < size; i++)
410
	  PRINTCHAR (SREF (string, i));
411
      else
Kenichi Handa's avatar
Kenichi Handa committed
412
	for (i = 0; i < size_byte; )
413 414 415 416
	  {
	    /* Here, we must convert each multi-byte form to the
	       corresponding character code before handing it to PRINTCHAR.  */
	    int len;
417
	    int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i, len);
418 419 420
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
421 422 423 424 425
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
426 427
       doc: /* Output character CHARACTER to stream PRINTCHARFUN.
PRINTCHARFUN defaults to the value of `standard-output' (which see).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
428
  (Lisp_Object character, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
429
{
430
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
431

Jim Blandy's avatar
Jim Blandy committed
432
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
433
    printcharfun = Vstandard_output;
434
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
435
  PRINTPREPARE;
436
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
437
  PRINTFINISH;
438
  return character;
Jim Blandy's avatar
Jim Blandy committed
439 440
}

441 442
/* 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
443 444
   Do not use this on the contents of a Lisp string.  */

445
void
446
write_string (const char *data, int size)
Jim Blandy's avatar
Jim Blandy committed
447
{
448
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
449 450 451 452 453
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
454
  strout (data, size, size, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
455 456 457
  PRINTFINISH;
}

Andreas Schwab's avatar
Andreas Schwab committed
458 459
/* Used to print a block of SIZE single-byte chars at DATA on a
   specified stream PRINTCHARFUN.
Jim Blandy's avatar
Jim Blandy committed
460 461
   Do not use this on the contents of a Lisp string.  */

Andreas Schwab's avatar
Andreas Schwab committed
462
static void
463
write_string_1 (const char *data, int size, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
464
{
465
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
466 467

  PRINTPREPARE;
468
  strout (data, size, size, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
469 470 471 472 473
  PRINTFINISH;
}


void
474
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
475
{
476
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
477 478 479
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

480
  record_unwind_current_buffer ();
481

Jim Blandy's avatar
Jim Blandy committed
482 483
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

484
  Fkill_all_local_variables ();
485
  delete_all_overlays (current_buffer);
Paul Eggert's avatar
Paul Eggert committed
486 487 488 489
  bset_directory (current_buffer, BVAR (old, directory));
  bset_read_only (current_buffer, Qnil);
  bset_filename (current_buffer, Qnil);
  bset_undo_list (current_buffer, Qt);
490 491
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
Paul Eggert's avatar
Paul Eggert committed
492 493
  bset_enable_multibyte_characters
    (current_buffer, BVAR (&buffer_defaults, enable_multibyte_characters));
494 495
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
496
  Ferase_buffer ();
497
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
498

499
  run_hook (Qtemp_buffer_setup_hook);
500 501 502 503

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
504 505
}

506 507 508 509
static void print (Lisp_Object, Lisp_Object, bool);
static void print_preprocess (Lisp_Object);
static void print_preprocess_string (INTERVAL, Lisp_Object);
static void print_object (Lisp_Object, Lisp_Object, bool);
Jim Blandy's avatar
Jim Blandy committed
510

511
DEFUN ("terpri", Fterpri, Sterpri, 0, 2, 0,
512
       doc: /* Output a newline to stream PRINTCHARFUN.
513 514
If ENSURE is non-nil only output a newline if not already at the
beginning of a line.  Value is non-nil if a newline is printed.
515
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.  */)
516
  (Lisp_Object printcharfun, Lisp_Object ensure)
Jim Blandy's avatar
Jim Blandy committed
517
{
518
  Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
519

520
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
521
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
522 523
    printcharfun = Vstandard_output;
  PRINTPREPARE;
524 525 526 527 528 529 530 531 532 533 534 535

  if (NILP (ensure))
    val = Qt;
  /* Difficult to check if at line beginning so abort.  */
  else if (FUNCTIONP (printcharfun))
    signal_error ("Unsupported function argument", printcharfun);
  else if (noninteractive && !NILP (printcharfun))
    val = printchar_stdout_last == 10 ? Qnil : Qt;
  else if (NILP (Fbolp ()))
    val = Qt;

  if (!NILP (val)) PRINTCHAR ('\n');
Jim Blandy's avatar
Jim Blandy committed
536
  PRINTFINISH;
537
  return val;
Jim Blandy's avatar
Jim Blandy committed
538 539
}

Paul Eggert's avatar
Paul Eggert committed
540
DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
541 542
       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
543
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
544
is controlled by `print-level' and `print-length', which see.
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562

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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
563
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
564
{
565
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
566

Jim Blandy's avatar
Jim Blandy committed
567
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
568 569
    printcharfun = Vstandard_output;
  PRINTPREPARE;
570
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
571
  PRINTFINISH;
572
  return object;
Jim Blandy's avatar
Jim Blandy committed
573 574 575 576 577
}

/* a buffer which is used to hold output being built by prin1-to-string */
Lisp_Object Vprin1_to_string_buffer;

Paul Eggert's avatar
Paul Eggert committed
578
DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
579 580
       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
581
when necessary to make output that `read' can handle, whenever possible,
582 583
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
584 585 586 587 588

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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
589
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
590
{
591
  Lisp_Object printcharfun;
592
  bool prev_abort_on_gc;
593
  Lisp_Object save_deactivate_mark;
594
  ptrdiff_t count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
595
  struct buffer *previous;
596 597

  specbind (Qinhibit_modification_hooks, Qt);
598

Kenichi Handa's avatar
Kenichi Handa committed
599 600 601 602 603 604 605
  {
    PRINTDECLARE;

    /* 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.  */
    save_deactivate_mark = Vdeactivate_mark;
606 607
    prev_abort_on_gc = abort_on_gc;
    abort_on_gc = 1;
Kenichi Handa's avatar
Kenichi Handa committed
608 609 610 611

    printcharfun = Vprin1_to_string_buffer;
    PRINTPREPARE;
    print (object, printcharfun, NILP (noescape));
Paul Eggert's avatar
Paul Eggert committed
612
    /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINISH */
Kenichi Handa's avatar
Kenichi Handa committed
613 614
    PRINTFINISH;
  }
Jim Blandy's avatar
Jim Blandy committed
615

Kenichi Handa's avatar
Kenichi Handa committed
616
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
617
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
618
  object = Fbuffer_string ();
619 620
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
621

622
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
623 624
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
625
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
626
  set_buffer_internal (previous);
627

628
  Vdeactivate_mark = save_deactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
629

630
  abort_on_gc = prev_abort_on_gc;
631
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
632 633
}

634
DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
656
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
657
{
658
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
659

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

Paul Eggert's avatar
Paul Eggert committed
668
DEFUN ("print", Fprint, Sprint, 1, 2, 0,
669 670
       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
671
can handle, whenever this is possible.  For complex objects, the behavior
Pavel Janík's avatar
Pavel Janík committed
672
is controlled by `print-level' and `print-length', which see.
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690

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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
691
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
692
{
693
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
694 695
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
696
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
697
    printcharfun = Vstandard_output;
698
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
699 700
  PRINTPREPARE;
  PRINTCHAR ('\n');
701
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
702 703 704
  PRINTCHAR ('\n');
  PRINTFINISH;
  UNGCPRO;
705
  return object;
Jim Blandy's avatar
Jim Blandy committed
706 707
}

Jim Blandy's avatar
Jim Blandy committed
708
DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
709 710 711
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
712
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
713
{
714
  unsigned int ch;
715

716 717 718
  CHECK_NUMBER (character);
  ch = XINT (character);
  if (ASCII_CHAR_P (ch))
719
    {
720 721 722 723 724 725 726 727 728 729
      putc (ch, stderr);
#ifdef WINDOWSNT
      /* Send the output to a debugger (nothing happens if there isn't
	 one).  */
      if (print_output_debug_flag)
	{
	  char buf[2] = {(char) XINT (character), '\0'};
	  OutputDebugString (buf);
	}
#endif
730
    }
731 732 733 734 735
  else
    {
      unsigned char mbstr[MAX_MULTIBYTE_LENGTH];
      ptrdiff_t len = CHAR_STRING (ch, mbstr);
      Lisp_Object encoded_ch =
736
	ENCODE_SYSTEM (make_multibyte_string ((char *) mbstr, 1, len));
737 738 739 740 741

      fwrite (SSDATA (encoded_ch), SBYTES (encoded_ch), 1, stderr);
#ifdef WINDOWSNT
      if (print_output_debug_flag)
	OutputDebugString (SSDATA (encoded_ch));
742
#endif
743
    }
744

Jim Blandy's avatar
Jim Blandy committed
745 746
  return character;
}
747

748 749 750
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

751
extern void debug_output_compilation_hack (bool) EXTERNALLY_VISIBLE;
752
void
753
debug_output_compilation_hack (bool x)
754 755 756
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
757

Andreas Schwab's avatar
Andreas Schwab committed
758
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
759 760 761 762 763 764

/* This functionality is not vitally important in general, so we rely on
   non-portable ability to use stderr as lvalue.  */

#define WITH_REDIRECT_DEBUGGING_OUTPUT 1

765
static FILE *initial_stderr_stream = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
766 767 768 769 770 771 772

DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
       1, 2,
       "FDebug output file: \nP",
       doc: /* Redirect debugging output (stderr stream) to file FILE.
If FILE is nil, reset target to the initial stderr stream.
Optional arg APPEND non-nil (interactively, with prefix arg) means
773
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
774
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
775 776
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
777
    {
778
      block_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
779
      fclose (stderr);
780
      unblock_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
781
    }
Kenichi Handa's avatar
Kenichi Handa committed
782 783 784 785 786 787 788
  stderr = initial_stderr_stream;
  initial_stderr_stream = NULL;

  if (STRINGP (file))
    {
      file = Fexpand_file_name (file, Qnil);
      initial_stderr_stream = stderr;
789
      stderr = emacs_fopen (SSDATA (file), NILP (append) ? "w" : "a");
Kenichi Handa's avatar
Kenichi Handa committed
790 791 792 793
      if (stderr == NULL)
	{
	  stderr = initial_stderr_stream;
	  initial_stderr_stream = NULL;
794
	  report_file_error ("Cannot open debugging output stream", file);
Kenichi Handa's avatar
Kenichi Handa committed
795 796 797 798 799 800 801
	}
    }
  return Qnil;
}
#endif /* GNU_LINUX */


802 803 804
/* This is the interface for debugging printing.  */

void
805
debug_print (Lisp_Object arg)
806 807
{
  Fprin1 (arg, Qexternal_debugging_output);
808
  fprintf (stderr, "\r\n");
809
}