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

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26
#include <stdio.h>
#include "lisp.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
27
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
29 30 31 32
#include "window.h"
#include "process.h"
#include "dispextern.h"
#include "termchar.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
33
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
34

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

Jim Blandy's avatar
Jim Blandy committed
39 40
Lisp_Object Vstandard_output, Qstandard_output;

41 42
Lisp_Object Qtemp_buffer_setup_hook;

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

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

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

#include <math.h>

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

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

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

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

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

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

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

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

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

129 130 131 132 133
/* Nonzero means to print single-byte non-ascii characters in strings as
   octal escapes.  */

int print_escape_nonascii;

134 135 136 137 138 139 140
/* Nonzero means to print multibyte characters in strings as hex escapes.  */

int print_escape_multibyte;

Lisp_Object Qprint_escape_newlines;
Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;

Erik Naggum's avatar
Erik Naggum committed
141 142 143 144
/* Nonzero means print (quote foo) forms as 'foo, etc.  */

int print_quoted;

145
/* Non-nil means print #: before uninterned symbols.  */
146

147
Lisp_Object Vprint_gensym;
148

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

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
Lisp_Object Vprint_circle;

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

Lisp_Object Vprint_continuous_numbering;

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

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

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

extern int noninteractive_need_newline;
177

178 179
extern int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
180 181 182 183
#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
184 185

void print_interval ();
Jim Blandy's avatar
Jim Blandy committed
186 187


188
/* Low level output routines for characters and strings */
Jim Blandy's avatar
Jim Blandy committed
189 190

/* Lisp functions to do output using a stream
191 192 193 194
   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,
195 196 197 198 199 200 201 202 203
   or call strout to output a block of characters. */ 

#define PRINTDECLARE							\
   struct buffer *old = current_buffer;					\
   int old_point = -1, start_point;					\
   int old_point_byte, start_point_byte;				\
   int specpdl_count = specpdl_ptr - specpdl;				\
   int free_print_buffer = 0;						\
   int multibyte = !NILP (current_buffer->enable_multibyte_characters);	\
204 205
   Lisp_Object original

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

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
#define PRINTFINISH							\
   if (NILP (printcharfun))						\
     {									\
       if (print_buffer_pos != print_buffer_pos_byte			\
	   && NILP (current_buffer->enable_multibyte_characters))	\
	 {								\
	   unsigned char *temp						\
	     = (unsigned char *) alloca (print_buffer_pos + 1);		\
	   copy_text (print_buffer, temp, print_buffer_pos_byte,	\
		      1, 0);						\
	   insert_1_both (temp, print_buffer_pos,			\
			  print_buffer_pos, 0, 1, 0);			\
	 }								\
       else								\
	 insert_1_both (print_buffer, print_buffer_pos,			\
			print_buffer_pos_byte, 0, 1, 0);		\
     }									\
   if (free_print_buffer)						\
     {									\
       xfree (print_buffer);						\
       print_buffer = 0;						\
     }									\
   unbind_to (specpdl_count, Qnil);					\
   if (MARKERP (original))						\
     set_marker_both (original, Qnil, PT, PT_BYTE);			\
   if (old_point >= 0)							\
     SET_PT_BOTH (old_point + (old_point >= start_point			\
			       ? PT - start_point : 0),			\
285 286
		  old_point_byte + (old_point_byte >= start_point_byte	\
			       ? PT_BYTE - start_point_byte : 0));	\
287
   if (old != current_buffer)						\
288
     set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
289 290 291

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

292 293
/* This is used to restore the saved contents of print_buffer
   when there is a recursive call to print.  */
294

295 296 297 298 299 300 301
static Lisp_Object
print_unwind (saved_text)
     Lisp_Object saved_text;
{
  bcopy (XSTRING (saved_text)->data, print_buffer, XSTRING (saved_text)->size);
}

302 303 304 305 306

/* 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
307 308 309

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

318 319 320
  if (!NILP (fun) && !EQ (fun, Qt))
    call1 (fun, make_number (ch));
  else
Jim Blandy's avatar
Jim Blandy committed
321
    {
Karl Heuer's avatar
Karl Heuer committed
322 323
      unsigned char work[4], *str;
      int len = CHAR_STRING (ch, work, str);
324
    
325
      QUIT;
326 327
      
      if (NILP (fun))
328
	{
329 330 331 332 333 334
	  if (print_buffer_pos_byte + len >= print_buffer_size)
	    print_buffer = (char *) xrealloc (print_buffer,
					      print_buffer_size *= 2);
	  bcopy (str, print_buffer + print_buffer_pos_byte, len);
	  print_buffer_pos += 1;
	  print_buffer_pos_byte += len;
335
	}
336
      else if (noninteractive)
337
	{
338 339
	  fwrite (str, 1, len, stdout);
	  noninteractive_need_newline = 1;
340
	}
341
      else
342
	{
343 344 345 346 347 348 349 350
	  int multibyte_p
	    = !NILP (current_buffer->enable_multibyte_characters);
	  
	  if (!message_buf_print)
	    setup_echo_area_for_printing (multibyte_p);

	  insert_char (ch);
	  message_dolog (str, len, 0, multibyte_p);
351
	}
Jim Blandy's avatar
Jim Blandy committed
352 353 354
    }
}

355 356 357 358 359 360 361 362 363

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

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

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

Jim Blandy's avatar
Jim Blandy committed
386 387
#ifdef MAX_PRINT_CHARS
      if (max_print)
388
        print_chars += size;
Jim Blandy's avatar
Jim Blandy committed
389 390
#endif /* MAX_PRINT_CHARS */
    }
391
  else if (noninteractive)
Jim Blandy's avatar
Jim Blandy committed
392
    {
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
      fwrite (ptr, 1, size_byte, stdout);
      noninteractive_need_newline = 1;
    }
  else if (EQ (printcharfun, Qt))
    {
      /* Output to echo area.  We're trying to avoid a little overhead
	 here, that's the reason we don't call printchar to do the
	 job.  */
      int i;
      int multibyte_p
	= !NILP (current_buffer->enable_multibyte_characters);
      
      if (!message_buf_print)
	setup_echo_area_for_printing (multibyte_p);
      
      message_dolog (ptr, size_byte, 0, multibyte_p);
      
      if (size == size_byte)
Jim Blandy's avatar
Jim Blandy committed
411
	{
412 413
	  for (i = 0; i < size; ++i)
	    insert_char (*ptr++);
Jim Blandy's avatar
Jim Blandy committed
414
	}
415
      else
Jim Blandy's avatar
Jim Blandy committed
416
	{
417 418
	  int len;
	  for (i = 0; i < size_byte; i += len)
419
	    {
420 421
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
	      insert_char (ch);
422
	    }
Jim Blandy's avatar
Jim Blandy committed
423
	}
424 425 426 427 428 429 430 431 432 433
      
#ifdef MAX_PRINT_CHARS
      if (max_print)
        print_chars += size;
#endif /* MAX_PRINT_CHARS */
    }
  else
    {
      /* PRINTCHARFUN is a Lisp function.  */
      int i = 0;
Jim Blandy's avatar
Jim Blandy committed
434

435
      if (size == size_byte)
436
	{
437
	  while (i < size_byte)
438
	    {
439 440
	      int ch = ptr[i++];
	      PRINTCHAR (ch);
441 442
	    }
	}
443
      else
Karl Heuer's avatar
Karl Heuer committed
444
	{
445 446 447 448 449 450 451 452 453 454
	  while (i < size_byte)
	    {
	      /* Here, we must convert each multi-byte form to the
		 corresponding character code before handing it to
		 PRINTCHAR.  */
	      int len;
	      int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
	      PRINTCHAR (ch);
	      i += len;
	    }
Karl Heuer's avatar
Karl Heuer committed
455
	}
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459
    }
}

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

463
static void
Jim Blandy's avatar
Jim Blandy committed
464 465 466 467
print_string (string, printcharfun)
     Lisp_Object string;
     Lisp_Object printcharfun;
{
468
  if (EQ (printcharfun, Qt) || NILP (printcharfun))
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
    {
      int chars;

      if (STRING_MULTIBYTE (string))
	chars = XSTRING (string)->size;
      else if (EQ (printcharfun, Qt)
	       ? ! NILP (buffer_defaults.enable_multibyte_characters)
	       : ! NILP (current_buffer->enable_multibyte_characters))
	chars = multibyte_chars_in_text (XSTRING (string)->data,
					 STRING_BYTES (XSTRING (string)));
      else
	chars = STRING_BYTES (XSTRING (string));

      /* strout is safe for output to a frame (echo area) or to print_buffer.  */
      strout (XSTRING (string)->data,
	      chars, STRING_BYTES (XSTRING (string)),
	      printcharfun, STRING_MULTIBYTE (string));
    }
Jim Blandy's avatar
Jim Blandy committed
487 488
  else
    {
489 490
      /* Otherwise, string may be relocated by printing one char.
	 So re-fetch the string address for each character.  */
Jim Blandy's avatar
Jim Blandy committed
491 492
      int i;
      int size = XSTRING (string)->size;
493
      int size_byte = STRING_BYTES (XSTRING (string));
Jim Blandy's avatar
Jim Blandy committed
494 495
      struct gcpro gcpro1;
      GCPRO1 (string);
496 497 498 499 500 501 502 503 504
      if (size == size_byte)
	for (i = 0; i < size; i++)
	  PRINTCHAR (XSTRING (string)->data[i]);
      else
	for (i = 0; i < size_byte; i++)
	  {
	    /* Here, we must convert each multi-byte form to the
	       corresponding character code before handing it to PRINTCHAR.  */
	    int len;
505 506
	    int ch = STRING_CHAR_AND_LENGTH (XSTRING (string)->data + i,
					     size_byte - i, len);
507 508 509 510 511
	    if (!CHAR_VALID_P (ch, 0))
	      {
		ch = XSTRING (string)->data[i];
		len = 1;
	      }
512 513 514
	    PRINTCHAR (ch);
	    i += len;
	  }
Jim Blandy's avatar
Jim Blandy committed
515 516 517 518 519
      UNGCPRO;
    }
}

DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
520
  "Output character CHARACTER to stream PRINTCHARFUN.\n\
Karl Heuer's avatar
Karl Heuer committed
521
PRINTCHARFUN defaults to the value of `standard-output' (which see).")
522 523
  (character, printcharfun)
     Lisp_Object character, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
524
{
525
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
526

Jim Blandy's avatar
Jim Blandy committed
527
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
528
    printcharfun = Vstandard_output;
529
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
530
  PRINTPREPARE;
531
  PRINTCHAR (XINT (character));
Jim Blandy's avatar
Jim Blandy committed
532
  PRINTFINISH;
533
  return character;
Jim Blandy's avatar
Jim Blandy committed
534 535
}

536 537
/* 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
538 539
   Do not use this on the contents of a Lisp string.  */

540
void
Jim Blandy's avatar
Jim Blandy committed
541 542 543 544
write_string (data, size)
     char *data;
     int size;
{
545
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
546 547 548 549 550
  Lisp_Object printcharfun;

  printcharfun = Vstandard_output;

  PRINTPREPARE;
551
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
552 553 554
  PRINTFINISH;
}

555 556
/* Used from outside of print.c to print a block of SIZE
   single-byte chars at DATA on a specified stream PRINTCHARFUN.
Jim Blandy's avatar
Jim Blandy committed
557 558
   Do not use this on the contents of a Lisp string.  */

559
void
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563 564
write_string_1 (data, size, printcharfun)
     char *data;
     int size;
     Lisp_Object printcharfun;
{
565
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
566 567

  PRINTPREPARE;
568
  strout (data, size, size, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
569 570 571 572 573 574 575 576
  PRINTFINISH;
}


void
temp_output_buffer_setup (bufname)
    char *bufname;
{
577
  int count = specpdl_ptr - specpdl;
Jim Blandy's avatar
Jim Blandy committed
578 579 580
  register struct buffer *old = current_buffer;
  register Lisp_Object buf;

581 582
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
583 584
  Fset_buffer (Fget_buffer_create (build_string (bufname)));

585
  current_buffer->directory = old->directory;
Jim Blandy's avatar
Jim Blandy committed
586
  current_buffer->read_only = Qnil;
587 588 589 590 591 592
  current_buffer->filename = Qnil;
  current_buffer->undo_list = Qt;
  current_buffer->overlays_before = Qnil;
  current_buffer->overlays_after = Qnil;
  current_buffer->enable_multibyte_characters
    = buffer_defaults.enable_multibyte_characters;
Jim Blandy's avatar
Jim Blandy committed
593
  Ferase_buffer ();
594
  XSETBUFFER (buf, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
595

596 597 598 599 600
  call1 (Vrun_hooks, Qtemp_buffer_setup_hook);

  unbind_to (count, Qnil);

  specbind (Qstandard_output, buf);
Jim Blandy's avatar
Jim Blandy committed
601 602 603 604 605
}

Lisp_Object
internal_with_output_to_temp_buffer (bufname, function, args)
     char *bufname;
Andreas Schwab's avatar
Andreas Schwab committed
606
     Lisp_Object (*function) P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
607 608 609 610
     Lisp_Object args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object buf, val;
611
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
612

613
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
614 615 616
  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
  temp_output_buffer_setup (bufname);
  buf = Vstandard_output;
617
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
618 619 620

  val = (*function) (args);

621
  GCPRO1 (val);
Jim Blandy's avatar
Jim Blandy committed
622
  temp_output_buffer_show (buf);
623
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
624 625 626 627 628 629 630 631 632 633 634

  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\
635 636 637 638 639 640 641 642
If BODY does not finish normally, the buffer BUFNAME is not displayed.\n\
\n\
The hook `temp-buffer-setup-hook' is run before BODY,\n\
with the buffer BUFNAME temporarily current.\n\
The hook `temp-buffer-show-hook' is run after the buffer is displayed,\n\
with the buffer temporarily current, and the window that was used\n\
to display it temporarily selected.\n\
\n\
643
If variable `temp-buffer-show-function' is non-nil, call it at the end\n\
644 645
to get the buffer displayed instead of just displaying the non-selected\n\
buffer and calling the hook.  It gets one argument, the buffer to display.")
Jim Blandy's avatar
Jim Blandy committed
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
  (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);
}
668

Jim Blandy's avatar
Jim Blandy committed
669 670

static void print ();
671 672 673 674 675
static void print_preprocess ();
#ifdef USE_TEXT_PROPERTIES
static void print_preprocess_string ();
#endif /* USE_TEXT_PROPERTIES */
static void print_object ();
Jim Blandy's avatar
Jim Blandy committed
676 677

DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
678 679
  "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
680 681 682
  (printcharfun)
     Lisp_Object printcharfun;
{
683
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
684

Jim Blandy's avatar
Jim Blandy committed
685
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
686 687 688 689 690 691 692 693 694 695 696
    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
697
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
698 699
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
700
{
701
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
702 703 704 705

#ifdef MAX_PRINT_CHARS
  max_print = 0;
#endif /* MAX_PRINT_CHARS */
Jim Blandy's avatar
Jim Blandy committed
706
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
707 708
    printcharfun = Vstandard_output;
  PRINTPREPARE;
709
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
710
  PRINTFINISH;
711
  return object;
Jim Blandy's avatar
Jim Blandy committed
712 713 714 715 716 717 718 719 720 721
}

/* 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.")
722 723
  (object, noescape)
     Lisp_Object object, noescape;
Jim Blandy's avatar
Jim Blandy committed
724
{
725 726
  PRINTDECLARE;
  Lisp_Object printcharfun;
727 728 729 730 731 732 733 734
  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
735 736 737

  printcharfun = Vprin1_to_string_buffer;
  PRINTPREPARE;
738
  print (object, printcharfun, NILP (noescape));
Jim Blandy's avatar
Jim Blandy committed
739 740 741
  /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
  PRINTFINISH;
  set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
742
  object = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
743 744 745

  Ferase_buffer ();
  set_buffer_internal (old);
746 747

  Vdeactivate_mark = tem;
Jim Blandy's avatar
Jim Blandy committed
748 749
  UNGCPRO;

750
  return object;
Jim Blandy's avatar
Jim Blandy committed
751 752 753 754 755 756
}

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
757
Output stream is PRINTCHARFUN, or value of standard-output (which see).")
758 759
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
760
{
761
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
762

Jim Blandy's avatar
Jim Blandy committed
763
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
764 765
    printcharfun = Vstandard_output;
  PRINTPREPARE;
766
  print (object, printcharfun, 0);
Jim Blandy's avatar
Jim Blandy committed
767
  PRINTFINISH;
768
  return object;
Jim Blandy's avatar
Jim Blandy committed
769 770 771 772 773 774
}

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
775
Output stream is PRINTCHARFUN, or value of `standard-output' (which see).")
776 777
  (object, printcharfun)
     Lisp_Object object, printcharfun;
Jim Blandy's avatar
Jim Blandy committed
778
{
779
  PRINTDECLARE;
Jim Blandy's avatar
Jim Blandy committed
780 781 782 783 784 785
  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
786
  if (NILP (printcharfun))
Jim Blandy's avatar
Jim Blandy committed
787
    printcharfun = Vstandard_output;
788
  GCPRO1 (object);
Jim Blandy's avatar
Jim Blandy committed
789 790
  PRINTPREPARE;
  PRINTCHAR ('\n');
791
  print (object, printcharfun, 1);
Jim Blandy's avatar
Jim Blandy committed
792 793 794 795 796 797 798
  PRINTCHAR ('\n');
  PRINTFINISH;
#ifdef MAX_PRINT_CHARS
  max_print = 0;
  print_chars = 0;
#endif /* MAX_PRINT_CHARS */
  UNGCPRO;
799
  return object;
Jim Blandy's avatar
Jim Blandy committed
800 801 802 803 804 805
}

/* 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
806 807
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
808 809
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
810 811
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
812 813 814
{
  CHECK_NUMBER (character, 0);
  putc (XINT (character), stderr);
815 816 817 818 819 820 821 822 823

#ifdef WINDOWSNT
  /* Send the output to a debugger (nothing happens if there isn't one).  */
  {
    char buf[2] = {(char) XINT (character), '\0'};
    OutputDebugString (buf);
  }
#endif

Jim Blandy's avatar
Jim Blandy committed
824 825
  return character;
}
826 827 828 829 830 831 832 833

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

void
debug_print (arg)
     Lisp_Object arg;
{
  Fprin1 (arg, Qexternal_debugging_output);
834
  fprintf (stderr, "\r\n");
835
}
Jim Blandy's avatar
Jim Blandy committed
836

837 838 839 840 841 842 843
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;
844
  Lisp_Object value;
845 846
  struct gcpro gcpro1;

847 848 849
  /* 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.  */
850 851 852 853 854
  if (CONSP (obj) && EQ (XCAR (obj), Qerror)
      && CONSP (XCDR (obj))
      && STRINGP (XCAR (XCDR (obj)))
      && NILP (XCDR (XCDR (obj))))
    return XCAR (XCDR (obj));
855

856
  print_error_message (obj, Vprin1_to_string_buffer);
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871

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

872
void
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
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.  */
903
  if (!NILP (file_error) && CONSP (tail))
904
    errmsg = XCAR (tail), tail = XCDR (tail);
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921

  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
922 923 924
#ifdef LISP_FLOAT_TYPE

/*
925
 * The buffer should be at least as large as the max string size of the
Karl Heuer's avatar
Karl Heuer committed
926
 * largest float, printed in the biggest notation.  This is undoubtedly
Jim Blandy's avatar
Jim Blandy committed
927 928 929 930 931 932 933 934 935 936
 * 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
 */
937 938 939

void
float_to_string (buf, data)
940
     unsigned char *buf;
Jim Blandy's avatar
Jim Blandy committed
941 942
     double data;
{
943
  unsigned char *cp;
944
  int width;
Jim Blandy's avatar
Jim Blandy committed
945
      
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
  /* Check for plus infinity in a way that won't lose
     if there is no plus infinity.  */
  if (data == data / 2 && data > 1.0)
    {
      strcpy (buf, "1.0e+INF");
      return;
    }
  /* Likewise for minus infinity.  */
  if (data == data / 2 && data < -1.0)
    {
      strcpy (buf, "-1.0e+INF");
      return;
    }
  /* Check for NaN in a way that won't fail if there are no NaNs.  */
  if (! (data * 0.0 >= 0.0))
    {
962 963 964 965 966 967 968 969 970 971 972 973 974
      /* Prepend "-" if the NaN's sign bit is negative.
	 The sign bit of a double is the bit that is 1 in -0.0.  */
      int i;
      union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
      u_data.d = data;
      u_minus_zero.d = - 0.0;
      for (i = 0; i < sizeof (double); i++)
	if (u_data.c[i] & u_minus_zero.c[i])
	  {
	    *buf++ = '-';
	    break;
	  }
      
975 976 977 978
      strcpy (buf, "0.0e+NaN");
      return;
    }

Jim Blandy's avatar
Jim Blandy committed
979
  if (NILP (Vfloat_output_format)
980
      || !STRINGP (Vfloat_output_format))
Jim Blandy's avatar
Jim Blandy committed
981
  lose:
982
    {
Paul Eggert's avatar
Paul Eggert committed
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
      /* Generate the fewest number of digits that represent the
	 floating point value without losing information.
	 The following method is simple but a bit slow.
	 For ideas about speeding things up, please see:

	 Guy L Steele Jr & Jon L White, How to print floating-point numbers
	 accurately.  SIGPLAN notices 25, 6 (June 1990), 112-126.

	 Robert G Burger & R Kent Dybvig, Printing floating point numbers
	 quickly and accurately, SIGPLAN notices 31, 5 (May 1996), 108-116.  */

      width = fabs (data) < DBL_MIN ? 1 : DBL_DIG;
      do
	sprintf (buf, "%.*g", width, data);
      while (width++ < DOUBLE_DIGITS_BOUND && atof (buf) != data);
998
    }
Jim Blandy's avatar
Jim Blandy committed
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
  else			/* oink oink */
    {
      /* Check that the spec we have is fully valid.
	 This means not only valid for printf,
	 but meant for floats, and reasonable.  */
      cp = XSTRING (Vfloat_output_format)->data;

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

      cp += 2;
1012 1013

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

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

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

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

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

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

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

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

1071 1072 1073 1074 1075 1076 1077 1078 1079
  /* Reset print_number_index and Vprint_number_table only when
     the variable Vprint_continuous_numbering is nil.  Otherwise,
     the values of these variables will be kept between several
     print functions.  */
  if (NILP (Vprint_continuous_numbering))
    {
      print_number_index = 0;
      Vprint_number_table = Qnil;
    }
Jim Blandy's avatar
Jim Blandy committed
1080

1081 1082
  /* Construct Vprint_number_table for print-gensym and print-circle.  */
  if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
1083
    {
1084
      int i, start, index;
1085
      /* Construct Vprint_number_table.  */
1086
      start = index = print_number_index;
1087 1088 1089
      print_preprocess (obj);
      /* Remove unnecessary objects, which appear only once in OBJ;
	 that is, whose status is Qnil.  */
1090
      for (i = start; i < print_number_index; i++)
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
	if (!NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
	  {
	    PRINT_NUMBER_OBJECT (Vprint_number_table, index)
	      = PRINT_NUMBER_OBJECT (Vprint_number_table, i);
	    /* Reset the status field for the next print step.  Now this
	       field means whether the object has already been printed.  */
	    PRINT_NUMBER_STATUS (Vprint_number_table, index) = Qnil;
	    index++;
	  }
      print_number_index = index;
    }

  print_object (obj, printcharfun, escapeflag);
}

/* Construct Vprint_number_table according to the structure of OBJ.
   OBJ itself and all its elements will be added to Vprint_number_table
   recursively if it is a list, vector, compiled function, char-table,
   string (its text properties will be traced), or a symbol that has
   no obarray (this is for the print-gensym feature).
   The status fields of Vprint_number_table mean whether each object appears
   more than once in OBJ: Qnil at the first time, and Qt after that .  */
static void
print_preprocess (obj)
     Lisp_Object obj;
{
  int i, size;

 loop:
  if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
      || COMPILEDP (obj) || CHAR_TABLE_P (obj)
      || (! NILP (Vprint_gensym)
	  && SYMBOLP (obj) && NILP (XSYMBOL (obj)->obarray)))
    {
1125 1126 1127
      /* In case print-circle is nil and print-gensym is t,
	 add OBJ to Vprint_number_table only when OBJ is a symbol.  */
      if (! NILP (Vprint_circle) || SYMBOLP (obj))
1128 1129
	{
	  for (i = 0; i < print_number_index; i++)
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
	    if (PRINT_NUMBER_OBJECT (Vprint_number_table, i) == obj)
	      {
		/* OBJ appears more than once.  Let's remember that.  */
		PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qt;
		return;
	      }

	  /* OBJ is not yet recorded.  Let's add to the table.  */
	  if (print_number_index == 0)
	    {
	      /* Initialize the table.  */