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

3
Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2014 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"
Richard M. Stallman's avatar
Richard M. Stallman committed
39

40
Lisp_Object Qstandard_output;
Jim Blandy's avatar
Jim Blandy committed
41

42
static Lisp_Object Qtemp_buffer_setup_hook;
43

Erik Naggum's avatar
Erik Naggum committed
44 45
/* These are used to print like we read.  */

46
static Lisp_Object Qfloat_output_format;
Paul Eggert's avatar
Paul Eggert committed
47 48

#include <float.h>
Paul Eggert's avatar
Paul Eggert committed
49
#include <ftoastr.h>
Paul Eggert's avatar
Paul Eggert committed
50

Jim Blandy's avatar
Jim Blandy committed
51
/* Avoid actual stack overflow in print.  */
52
static ptrdiff_t print_depth;
Jim Blandy's avatar
Jim Blandy committed
53

54
/* Level of nesting inside outputting backquote in new style.  */
55
static ptrdiff_t new_backquote_output;
56

57 58
/* Detect most circularities to print finite output.  */
#define PRINT_CIRCLE 200
59
static Lisp_Object being_printed[PRINT_CIRCLE];
60

61 62
/* When printing into a buffer, first we put the text in this
   block, then insert it all at once.  */
63
static char *print_buffer;
64 65

/* Size allocated in print_buffer.  */
66
static ptrdiff_t print_buffer_size;
67
/* Chars stored in print_buffer.  */
68
static ptrdiff_t print_buffer_pos;
69
/* Bytes stored in print_buffer.  */
70
static ptrdiff_t print_buffer_pos_byte;
71

72
Lisp_Object Qprint_escape_newlines;
73
static Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
74

75 76 77 78 79 80 81 82
/* 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.  */
83
static ptrdiff_t print_number_index;
84
static void print_interval (INTERVAL interval, Lisp_Object printcharfun);
Jim Blandy's avatar
Jim Blandy committed
85

86
/* GDB resets this to zero on W32 to disable OutputDebugString calls.  */
87
bool print_output_debug_flag EXTERNALLY_VISIBLE = 1;
88

Jim Blandy's avatar
Jim Blandy committed
89

90
/* Low level output routines for characters and strings.  */
Jim Blandy's avatar
Jim Blandy committed
91 92

/* Lisp functions to do output using a stream
93 94 95 96
   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,
97
   or call strout to output a block of characters.  */
98 99 100

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
101 102 103
   ptrdiff_t old_point = -1, start_point = -1;				\
   ptrdiff_t old_point_byte = -1, start_point_byte = -1;		\
   ptrdiff_t specpdl_count = SPECPDL_INDEX ();				\
104
   bool free_print_buffer = 0;						\
105 106
   bool multibyte							\
     = !NILP (BVAR (current_buffer, enable_multibyte_characters));	\
107 108
   Lisp_Object original

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

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

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

202 203
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
204

205
static void
206
print_unwind (Lisp_Object saved_text)
207
{
208
  memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
209 210
}

211 212 213 214 215

/* 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
216 217

static void
218
printchar (unsigned int ch, Lisp_Object fun)
Jim Blandy's avatar
Jim Blandy committed
219
{
220 221 222
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
223
    {
224 225 226
      unsigned char str[MAX_MULTIBYTE_LENGTH];
      int len = CHAR_STRING (ch, str);

227
      QUIT;
228

229
      if (NILP (fun))
230
	{
231
	  ptrdiff_t incr = len - (print_buffer_size - print_buffer_pos_byte);
232 233 234
	  if (incr > 0)
	    print_buffer = xpalloc (print_buffer, &print_buffer_size,
				    incr, -1, 1);
235
	  memcpy (print_buffer + print_buffer_pos_byte, str, len);
236 237
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
238
	}
239
      else if (noninteractive)
240
	{
241 242
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
243
	}
244
      else
245
	{
246
	  bool multibyte_p
Tom Tromey's avatar
Tom Tromey committed
247
	    = !NILP (BVAR (current_buffer, enable_multibyte_characters));
248

249
	  setup_echo_area_for_printing (multibyte_p);
250
	  insert_char (ch);
251
	  message_dolog ((char *) str, len, 0, multibyte_p);
252
	}
Jim Blandy's avatar
Jim Blandy committed
253 254 255
    }
}

256 257 258 259 260 261 262

/* 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
263 264 265 266
   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.  */
267

Jim Blandy's avatar
Jim Blandy committed
268
static void
269
strout (const char *ptr, ptrdiff_t size, ptrdiff_t size_byte,
270
	Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
271
{
Karl Heuer's avatar
Karl Heuer committed
272
  if (size < 0)
273
    size_byte = size = strlen (ptr);
Karl Heuer's avatar
Karl Heuer committed
274

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

298
      setup_echo_area_for_printing (multibyte_p);
299
      message_dolog (ptr, size_byte, 0, multibyte_p);
300

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

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

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

351
static void
352
print_string (Lisp_Object string, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
353
{
354
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
355
    {
356
      ptrdiff_t chars;
357

358 359 360
      if (print_escape_nonascii)
	string = string_escape_byte8 (string);

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

374
	  chars = SBYTES (string);
375
	  bytes = count_size_as_multibyte (SDATA (string), chars);
376 377 378
	  if (chars < bytes)
	    {
	      newstr = make_uninit_multibyte_string (chars, bytes);
379
	      memcpy (SDATA (newstr), SDATA (string), chars);
380
	      str_to_multibyte (SDATA (newstr), bytes, chars);
381 382 383
	      string = newstr;
	    }
	}
384
      else
385
	chars = SBYTES (string);
386

387 388 389
      if (EQ (printcharfun, Qt))
	{
	  /* Output to echo area.  */
390
	  ptrdiff_t nbytes = SBYTES (string);
391 392 393 394

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

398
	  strout (buffer, chars, nbytes, printcharfun);
399 400 401 402 403

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

Jim Blandy's avatar
Jim Blandy committed
439
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
440
    printcharfun = Vstandard_output;
441
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
442
  PRINTPREPARE;
443
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
444
  PRINTFINISH;
445
  return character;
Jim Blandy's avatar
Jim Blandy committed
446 447
}

448 449
/* 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
450 451
   Do not use this on the contents of a Lisp string.  */

452
void
453
write_string (const char *data, int size)
Jim Blandy's avatar
Jim Blandy committed
454
{
455
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459 460
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
461
  strout (data, size, size, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
462 463 464
  PRINTFINISH;
}

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

Andreas Schwab's avatar
Andreas Schwab committed
469
static void
470
write_string_1 (const char *data, int size, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
471
{
472
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
473 474

  PRINTPREPARE;
475
  strout (data, size, size, printcharfun);
Jim Blandy's avatar
Jim Blandy committed
476 477 478 479 480
  PRINTFINISH;
}


void
481
temp_output_buffer_setup (const char *bufname)
Jim Blandy's avatar
Jim Blandy committed
482
{
483
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
484 485 486
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

487
  record_unwind_current_buffer ();
488

Jim Blandy's avatar
Jim Blandy committed
489 490
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

491
  Fkill_all_local_variables ();
492
  delete_all_overlays (current_buffer);
Paul Eggert's avatar
Paul Eggert committed
493 494 495 496
  bset_directory (current_buffer, BVAR (old, directory));
  bset_read_only (current_buffer, Qnil);
  bset_filename (current_buffer, Qnil);
  bset_undo_list (current_buffer, Qt);
497 498
  eassert (current_buffer->overlays_before == NULL);
  eassert (current_buffer->overlays_after == NULL);
Paul Eggert's avatar
Paul Eggert committed
499 500
  bset_enable_multibyte_characters
    (current_buffer, BVAR (&buffer_defaults, enable_multibyte_characters));
501 502
  specbind (Qinhibit_read_only, Qt);
  specbind (Qinhibit_modification_hooks, Qt);
Jim Blandy's avatar
Jim Blandy committed
503
  Ferase_buffer ();
504
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
505

506
  Frun_hooks (1, &Qtemp_buffer_setup_hook);
507 508 509 510

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
511 512
}

513 514 515 516
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
517

Paul Eggert's avatar
Paul Eggert committed
518
DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
519 520
       doc: /* Output a newline to stream PRINTCHARFUN.
If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
521
  (Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
522
{
523
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
524

Jim Blandy's avatar
Jim Blandy committed
525
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
526 527 528 529 530 531 532
    printcharfun = Vstandard_output;
  PRINTPREPARE;
  PRINTCHAR ('\n');
  PRINTFINISH;
  return Qt;
}

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

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
556
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
557
{
558
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
559

Jim Blandy's avatar
Jim Blandy committed
560
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
561 562
    printcharfun = Vstandard_output;
  PRINTPREPARE;
563
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
564
  PRINTFINISH;
565
  return object;
Jim Blandy's avatar
Jim Blandy committed
566 567 568 569 570
}

/* 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
571
DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
572 573
       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
574
when necessary to make output that `read' can handle, whenever possible,
575 576
unless the optional second argument NOESCAPE is non-nil.  For complex objects,
the behavior is controlled by `print-level' and `print-length', which see.
577 578 579 580 581

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
582
  (Lisp_Object object, Lisp_Object noescape)
Jim Blandy's avatar
Jim Blandy committed
583
{
584
  Lisp_Object printcharfun;
585
  bool prev_abort_on_gc;
586
  Lisp_Object save_deactivate_mark;
587
  ptrdiff_t count = SPECPDL_INDEX ();
Kenichi Handa's avatar
Kenichi Handa committed
588
  struct buffer *previous;
589 590

  specbind (Qinhibit_modification_hooks, Qt);
591

Kenichi Handa's avatar
Kenichi Handa committed
592 593 594 595 596 597 598
  {
    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;
599 600
    prev_abort_on_gc = abort_on_gc;
    abort_on_gc = 1;
Kenichi Handa's avatar
Kenichi Handa committed
601 602 603 604

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

Kenichi Handa's avatar
Kenichi Handa committed
609
  previous = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
610
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
611
  object = Fbuffer_string ();
612 613
  if (SBYTES (object) == SCHARS (object))
    STRING_SET_UNIBYTE (object);
Jim Blandy's avatar
Jim Blandy committed
614

615
  /* Note that this won't make prepare_to_modify_buffer call
Kenichi Handa's avatar
Kenichi Handa committed
616 617
     ask-user-about-supersession-threat because this buffer
     does not visit a file.  */
Jim Blandy's avatar
Jim Blandy committed
618
  Ferase_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
619
  set_buffer_internal (previous);
620

621
  Vdeactivate_mark = save_deactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
622

623
  abort_on_gc = prev_abort_on_gc;
624
  return unbind_to (count, object);
Jim Blandy's avatar
Jim Blandy committed
625 626
}

627
DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
       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
649
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
650
{
651
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
652

Jim Blandy's avatar
Jim Blandy committed
653
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
654 655
    printcharfun = Vstandard_output;
  PRINTPREPARE;
656
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
657
  PRINTFINISH;
658
  return object;
Jim Blandy's avatar
Jim Blandy committed
659 660
}

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

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
684
  (Lisp_Object object, Lisp_Object printcharfun)
Jim Blandy's avatar
Jim Blandy committed
685
{
686
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
687 688
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
689
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
690
    printcharfun = Vstandard_output;
691
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
692 693
  PRINTPREPARE;
  PRINTCHAR ('\n');
694
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
695 696 697
  PRINTCHAR ('\n');
  PRINTFINISH;
  UNGCPRO;
698
  return object;
Jim Blandy's avatar
Jim Blandy committed
699 700 701 702 703 704
}

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

713 714 715
  CHECK_NUMBER (character);
  ch = XINT (character);
  if (ASCII_CHAR_P (ch))
716
    {
717 718 719 720 721 722 723 724 725 726
      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
727
    }
728 729 730 731 732
  else
    {
      unsigned char mbstr[MAX_MULTIBYTE_LENGTH];
      ptrdiff_t len = CHAR_STRING (ch, mbstr);
      Lisp_Object encoded_ch =
733
	ENCODE_SYSTEM (make_multibyte_string ((char *) mbstr, 1, len));
734 735 736 737 738

      fwrite (SSDATA (encoded_ch), SBYTES (encoded_ch), 1, stderr);
#ifdef WINDOWSNT
      if (print_output_debug_flag)
	OutputDebugString (SSDATA (encoded_ch));
739
#endif
740
    }
741

Jim Blandy's avatar
Jim Blandy committed
742 743
  return character;
}
744

745 746 747
/* This function is never called.  Its purpose is to prevent
   print_output_debug_flag from being optimized away.  */

748
extern void debug_output_compilation_hack (bool) EXTERNALLY_VISIBLE;
749
void
750
debug_output_compilation_hack (bool x)
751 752 753
{
  print_output_debug_flag = x;
}
Kenichi Handa's avatar
Kenichi Handa committed
754

Andreas Schwab's avatar
Andreas Schwab committed
755
#if defined (GNU_LINUX)
Kenichi Handa's avatar
Kenichi Handa committed
756 757 758 759 760 761

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

762
static FILE *initial_stderr_stream = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
763 764 765 766 767 768 769

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
770
append to existing target file.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
771
  (Lisp_Object file, Lisp_Object append)
Kenichi Handa's avatar
Kenichi Handa committed
772 773
{
  if (initial_stderr_stream != NULL)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
774
    {
775
      block_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
776
      fclose (stderr);
777
      unblock_input ();
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
778
    }
Kenichi Handa's avatar
Kenichi Handa committed
779 780 781 782 783 784 785
  stderr = initial_stderr_stream;
  initial_stderr_stream = NULL;

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


799 800 801
/* This is the interface for debugging printing.  */

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