lread.c 115 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp parsing and input streams.
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
                 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4
                 2005, 2006 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22 23


Richard M. Stallman's avatar
Richard M. Stallman committed
24
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
25 26 27 28
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/file.h>
29
#include <errno.h>
Jim Blandy's avatar
Jim Blandy committed
30
#include "lisp.h"
31
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
32
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
33
#include "charset.h"
34
#include <epaths.h>
Jim Blandy's avatar
Jim Blandy committed
35
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
36
#include "keyboard.h"
37
#include "termhooks.h"
38
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
39 40 41 42 43

#ifdef lint
#include <sys/inode.h>
#endif /* lint */

44 45 46 47 48 49 50
#ifdef MSDOS
#if __DJGPP__ < 2
#include <unistd.h>	/* to get X_OK */
#endif
#include "msdos.h"
#endif

Andreas Schwab's avatar
Andreas Schwab committed
51 52 53 54
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
55 56 57 58 59 60
#ifndef X_OK
#define X_OK 01
#endif

#include <math.h>

Richard M. Stallman's avatar
Richard M. Stallman committed
61 62 63 64
#ifdef HAVE_SETLOCALE
#include <locale.h>
#endif /* HAVE_SETLOCALE */

Dave Love's avatar
Dave Love committed
65 66 67
#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
68 69 70 71
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

72
#ifdef HAVE_FSEEKO
73 74 75 76 77 78 79
#define file_offset off_t
#define file_tell ftello
#else
#define file_offset long
#define file_tell ftell
#endif

80
#ifndef USE_CRT_DLL
81
extern int errno;
82
#endif
83

84
Lisp_Object Qread_char, Qget_file_char, Qstandard_input, Qcurrent_load_list;
Jim Blandy's avatar
Jim Blandy committed
85
Lisp_Object Qvariable_documentation, Vvalues, Vstandard_input, Vafter_load_alist;
86
Lisp_Object Qascii_character, Qload, Qload_file_name;
87
Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
88
Lisp_Object Qinhibit_file_name_operation;
89
Lisp_Object Qeval_buffer_list, Veval_buffer_list;
90
Lisp_Object Qfile_truename, Qdo_after_load_evaluation; /* ACM 2006/5/16 */
91 92

extern Lisp_Object Qevent_symbol_element_mask;
93
extern Lisp_Object Qfile_exists_p;
Jim Blandy's avatar
Jim Blandy committed
94

Lute Kamstra's avatar
Lute Kamstra committed
95
/* non-zero iff inside `load' */
Jim Blandy's avatar
Jim Blandy committed
96 97
int load_in_progress;

98 99 100
/* Directory in which the sources were found.  */
Lisp_Object Vsource_directory;

101
/* Search path and suffixes for files to be loaded. */
102
Lisp_Object Vload_path, Vload_suffixes, Vload_file_rep_suffixes;
Jim Blandy's avatar
Jim Blandy committed
103

Karl Heuer's avatar
Karl Heuer committed
104 105 106
/* File name of user's init file.  */
Lisp_Object Vuser_init_file;

107 108 109 110
/* This is the user-visible association list that maps features to
   lists of defs in their load files. */
Lisp_Object Vload_history;

111
/* This is used to build the load history. */
112 113
Lisp_Object Vcurrent_load_list;

114 115 116
/* List of files that were preloaded.  */
Lisp_Object Vpreloaded_file_list;

117 118 119
/* Name of file actually being read by `load'.  */
Lisp_Object Vload_file_name;

120 121 122
/* Function to use for reading, in `load' and friends.  */
Lisp_Object Vload_read_function;

123 124 125 126 127 128
/* The association list of objects read with the #n=object form.
   Each member of the list has the form (n . object), and is used to
   look up the object for the corresponding #n# construct.
   It must be set to nil before all top-level calls to read0.  */
Lisp_Object read_objects;

129 130 131
/* Nonzero means load should forcibly load all dynamic doc strings.  */
static int load_force_doc_strings;

132 133 134
/* Nonzero means read should convert strings to unibyte.  */
static int load_convert_to_unibyte;

Karl Heuer's avatar
Karl Heuer committed
135 136 137 138
/* Function to use for loading an Emacs lisp source file (not
   compiled) instead of readevalloop.  */
Lisp_Object Vload_source_file_function;

139 140 141
/* List of all DEFVAR_BOOL variables.  Used by the byte optimizer.  */
Lisp_Object Vbyte_boolean_vars;

142 143 144 145 146 147 148
/* Whether or not to add a `read-positions' property to symbols
   read. */
Lisp_Object Vread_with_symbol_positions;

/* List of (SYMBOL . POSITION) accumulated so far. */
Lisp_Object Vread_symbol_positions_list;

149 150 151
/* List of descriptors now open for Fload.  */
static Lisp_Object load_descriptor_list;

152
/* File for get_file_char to read from.  Use by load.  */
Jim Blandy's avatar
Jim Blandy committed
153 154 155 156 157
static FILE *instream;

/* When nonzero, read conses in pure space */
static int read_pure;

158
/* For use within read-from-string (this reader is non-reentrant!!)  */
Jim Blandy's avatar
Jim Blandy committed
159
static int read_from_string_index;
160
static int read_from_string_index_byte;
Jim Blandy's avatar
Jim Blandy committed
161
static int read_from_string_limit;
162

163 164 165
/* Number of bytes left to read in the buffer character
   that `readchar' has already advanced over.  */
static int readchar_backlog;
166 167 168
/* Number of characters read in the current call to Fread or
   Fread_from_string. */
static int readchar_count;
169

170
/* This contains the last string skipped with #@.  */
171 172 173 174 175 176
static char *saved_doc_string;
/* Length of buffer allocated in saved_doc_string.  */
static int saved_doc_string_size;
/* Length of actual data in saved_doc_string.  */
static int saved_doc_string_length;
/* This is the file position that string came from.  */
177
static file_offset saved_doc_string_position;
178

179 180 181 182 183 184 185 186 187
/* This contains the previous string skipped with #@.
   We copy it from saved_doc_string when a new string
   is put in saved_doc_string.  */
static char *prev_saved_doc_string;
/* Length of buffer allocated in prev_saved_doc_string.  */
static int prev_saved_doc_string_size;
/* Length of actual data in prev_saved_doc_string.  */
static int prev_saved_doc_string_length;
/* This is the file position that string came from.  */
188
static file_offset prev_saved_doc_string_position;
189

190 191 192 193 194
/* Nonzero means inside a new-style backquote
   with no surrounding parentheses.
   Fread initializes this to zero, so we need not specbind it
   or worry about what happens to it when there is an error.  */
static int new_backquote_flag;
195 196 197 198

/* A list of file names for files being loaded in Fload.  Used to
   check for recursive loads.  */

Lute Kamstra's avatar
Lute Kamstra committed
199
static Lisp_Object Vloads_in_progress;
200

201 202 203 204 205 206 207 208
/* Non-zero means load dangerous compiled Lisp files.  */

int load_dangerous_libraries;

/* A regular expression used to detect files compiled with Emacs.  */

static Lisp_Object Vbytecomp_version_regexp;

Gerd Moellmann's avatar
Gerd Moellmann committed
209
static void to_multibyte P_ ((char **, char **, int *));
210
static void readevalloop P_ ((Lisp_Object, FILE*, Lisp_Object,
211
			      Lisp_Object (*) (), int,
212
			      Lisp_Object, Lisp_Object,
213 214 215 216
			      Lisp_Object, Lisp_Object));
static Lisp_Object load_unwind P_ ((Lisp_Object));
static Lisp_Object load_descriptor_unwind P_ ((Lisp_Object));

217
static void invalid_syntax P_ ((const char *, int)) NO_RETURN;
218
static void end_of_file_error P_ (()) NO_RETURN;
219

Jim Blandy's avatar
Jim Blandy committed
220 221 222

/* Handle unreading and rereading of characters.
   Write READCHAR to read a character,
Karl Heuer's avatar
Karl Heuer committed
223 224
   UNREAD(c) to unread c to be read again.

225 226 227
   The READCHAR and UNREAD macros are meant for reading/unreading a
   byte code; they do not handle multibyte characters.  The caller
   should manage them if necessary.
228

229 230 231 232
   [ Actually that seems to be a lie; READCHAR will definitely read
     multibyte characters from buffer sources, at least.  Is the
     comment just out of date?
     -- Colin Walters <walters@gnu.org>, 22 May 2002 16:36:50 -0400 ]
Karl Heuer's avatar
Karl Heuer committed
233
 */
Jim Blandy's avatar
Jim Blandy committed
234 235 236 237 238 239 240 241 242

#define READCHAR readchar (readcharfun)
#define UNREAD(c) unreadchar (readcharfun, c)

static int
readchar (readcharfun)
     Lisp_Object readcharfun;
{
  Lisp_Object tem;
243
  register int c;
Jim Blandy's avatar
Jim Blandy committed
244

245
  readchar_count++;
246

247
  if (BUFFERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
248
    {
249
      register struct buffer *inbuffer = XBUFFER (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
250

251 252
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
253

254 255 256 257 258 259 260 261
      if (readchar_backlog > 0)
	/* We get the address of the byte just passed,
	   which is the last byte of the character.
	   The other bytes in this character are consecutive with it,
	   because the gap can't be in the middle of a character.  */
	return *(BUF_BYTE_ADDRESS (inbuffer, BUF_PT_BYTE (inbuffer) - 1)
		 - --readchar_backlog);

262 263
      if (pt_byte >= BUF_ZV_BYTE (inbuffer))
	return -1;
Jim Blandy's avatar
Jim Blandy committed
264

265 266
      readchar_backlog = -1;

267 268
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
269
	  /* Fetch the character code from the buffer.  */
270 271 272 273 274 275 276 277
	  unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, pt_byte);
	  BUF_INC_POS (inbuffer, pt_byte);
	  c = STRING_CHAR (p, pt_byte - orig_pt_byte);
	}
      else
	{
	  c = BUF_FETCH_BYTE (inbuffer, pt_byte);
	  pt_byte++;
278
	}
279
      SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
280

281
      return c;
Jim Blandy's avatar
Jim Blandy committed
282
    }
283
  if (MARKERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
284
    {
285
      register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
286

287 288
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
289

290 291 292 293 294 295 296 297
      if (readchar_backlog > 0)
	/* We get the address of the byte just passed,
	   which is the last byte of the character.
	   The other bytes in this character are consecutive with it,
	   because the gap can't be in the middle of a character.  */
	return *(BUF_BYTE_ADDRESS (inbuffer, XMARKER (readcharfun)->bytepos - 1)
		 - --readchar_backlog);

298 299
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
300

301 302
      readchar_backlog = -1;

303 304
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
305
	  /* Fetch the character code from the buffer.  */
306 307 308 309 310 311 312 313
	  unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, bytepos);
	  BUF_INC_POS (inbuffer, bytepos);
	  c = STRING_CHAR (p, bytepos - orig_bytepos);
	}
      else
	{
	  c = BUF_FETCH_BYTE (inbuffer, bytepos);
	  bytepos++;
314 315
	}

316 317 318 319
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

      return c;
Jim Blandy's avatar
Jim Blandy committed
320
    }
321 322 323 324

  if (EQ (readcharfun, Qlambda))
    return read_bytecode_char (0);

Jim Blandy's avatar
Jim Blandy committed
325
  if (EQ (readcharfun, Qget_file_char))
326 327 328 329 330 331
    {
      c = getc (instream);
#ifdef EINTR
      /* Interrupted reads have been observed while reading over the network */
      while (c == EOF && ferror (instream) && errno == EINTR)
	{
332
	  QUIT;
333 334 335 336 337 338
	  clearerr (instream);
	  c = getc (instream);
	}
#endif
      return c;
    }
Jim Blandy's avatar
Jim Blandy committed
339

340
  if (STRINGP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
341
    {
342
      if (read_from_string_index >= read_from_string_limit)
Jim Blandy's avatar
Jim Blandy committed
343
	c = -1;
344
      else
345 346 347
	FETCH_STRING_CHAR_ADVANCE (c, readcharfun,
				   read_from_string_index,
				   read_from_string_index_byte);
348

Jim Blandy's avatar
Jim Blandy committed
349 350 351 352 353
      return c;
    }

  tem = call0 (readcharfun);

Jim Blandy's avatar
Jim Blandy committed
354
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
355 356 357 358 359 360 361 362 363 364 365 366
    return -1;
  return XINT (tem);
}

/* Unread the character C in the way appropriate for the stream READCHARFUN.
   If the stream is a user function, call it with the char as argument.  */

static void
unreadchar (readcharfun, c)
     Lisp_Object readcharfun;
     int c;
{
367
  readchar_count--;
368 369 370 371
  if (c == -1)
    /* Don't back up the pointer if we're unreading the end-of-input mark,
       since readchar didn't advance it when we read it.  */
    ;
372
  else if (BUFFERP (readcharfun))
373
    {
374 375
      struct buffer *b = XBUFFER (readcharfun);
      int bytepos = BUF_PT_BYTE (b);
376

377 378
      if (readchar_backlog >= 0)
	readchar_backlog++;
379
      else
380 381 382 383 384 385
	{
	  BUF_PT (b)--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
386

387 388
	  BUF_PT_BYTE (b) = bytepos;
	}
389
    }
390
  else if (MARKERP (readcharfun))
391
    {
392 393
      struct buffer *b = XMARKER (readcharfun)->buffer;
      int bytepos = XMARKER (readcharfun)->bytepos;
394

395 396
      if (readchar_backlog >= 0)
	readchar_backlog++;
397
      else
398 399 400 401 402 403
	{
	  XMARKER (readcharfun)->charpos--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
404

405 406
	  XMARKER (readcharfun)->bytepos = bytepos;
	}
407
    }
408
  else if (STRINGP (readcharfun))
409 410 411 412 413
    {
      read_from_string_index--;
      read_from_string_index_byte
	= string_char_to_byte (readcharfun, read_from_string_index);
    }
414 415
  else if (EQ (readcharfun, Qlambda))
    read_bytecode_char (1);
Jim Blandy's avatar
Jim Blandy committed
416 417 418 419 420 421
  else if (EQ (readcharfun, Qget_file_char))
    ungetc (c, instream);
  else
    call1 (readcharfun, make_number (c));
}

422 423 424
static Lisp_Object read_internal_start P_ ((Lisp_Object, Lisp_Object,
					    Lisp_Object));
static Lisp_Object read0 P_ ((Lisp_Object));
425
static Lisp_Object read1 P_ ((Lisp_Object, int *, int));
426 427 428 429 430 431 432 433 434 435

static Lisp_Object read_list P_ ((int, Lisp_Object));
static Lisp_Object read_vector P_ ((Lisp_Object, int));
static int read_multibyte P_ ((int, Lisp_Object));

static Lisp_Object substitute_object_recurse P_ ((Lisp_Object, Lisp_Object,
						  Lisp_Object));
static void substitute_object_in_subtree P_ ((Lisp_Object,
					      Lisp_Object));
static void substitute_in_interval P_ ((INTERVAL, Lisp_Object));
436

Jim Blandy's avatar
Jim Blandy committed
437

438
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
439

440 441
extern Lisp_Object read_char ();

442 443 444 445 446 447 448 449 450 451 452 453 454
/* Read input events until we get one that's acceptable for our purposes.

   If NO_SWITCH_FRAME is non-zero, switch-frame events are stashed
   until we get a character we like, and then stuffed into
   unread_switch_frame.

   If ASCII_REQUIRED is non-zero, we check function key events to see
   if the unmodified version of the symbol has a Qascii_character
   property, and use that character, if present.

   If ERROR_NONASCII is non-zero, we signal an error if the input we
   get isn't an ASCII character with modifiers.  If it's zero but
   ASCII_REQUIRED is non-zero, we just re-read until we get an ASCII
455 456 457 458
   character.

   If INPUT_METHOD is nonzero, we invoke the current input method
   if the character warrants that.  */
459

460
Lisp_Object
461 462 463
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
464
{
465
  Lisp_Object val, delayed_switch_frame;
466

467
#ifdef HAVE_WINDOW_SYSTEM
468 469
  if (display_hourglass_p)
    cancel_hourglass ();
470
#endif
471

472
  delayed_switch_frame = Qnil;
473 474 475

  /* Read until we get an acceptable event.  */
 retry:
476 477 478
  val = read_char (0, 0, 0,
		   (input_method ? Qnil : Qt),
		   0);
479

480
  if (BUFFERP (val))
481 482
    goto retry;

483
  /* switch-frame events are put off until after the next ASCII
Karl Heuer's avatar
Karl Heuer committed
484
     character.  This is better than signaling an error just because
485 486 487 488 489
     the last characters were typed to a separate minibuffer frame,
     for example.  Eventually, some code which can deal with
     switch-frame events will read it and process it.  */
  if (no_switch_frame
      && EVENT_HAS_PARAMETERS (val)
490
      && EQ (EVENT_HEAD_KIND (EVENT_HEAD (val)), Qswitch_frame))
491 492 493 494 495 496 497 498
    {
      delayed_switch_frame = val;
      goto retry;
    }

  if (ascii_required)
    {
      /* Convert certain symbols to their ASCII equivalents.  */
499
      if (SYMBOLP (val))
500
	{
501
	  Lisp_Object tem, tem1;
502 503 504 505 506 507 508
	  tem = Fget (val, Qevent_symbol_element_mask);
	  if (!NILP (tem))
	    {
	      tem1 = Fget (Fcar (tem), Qascii_character);
	      /* Merge this symbol's modifier bits
		 with the ASCII equivalent of its basic code.  */
	      if (!NILP (tem1))
509
		XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
510 511
	    }
	}
512

513
      /* If we don't have a character now, deal with it appropriately.  */
514
      if (!INTEGERP (val))
515 516 517
	{
	  if (error_nonascii)
	    {
518
	      Vunread_command_events = Fcons (val, Qnil);
519 520 521 522 523 524 525 526 527 528
	      error ("Non-character input-event");
	    }
	  else
	    goto retry;
	}
    }

  if (! NILP (delayed_switch_frame))
    unread_switch_frame = delayed_switch_frame;

529 530
#if 0

531
#ifdef HAVE_WINDOW_SYSTEM
532 533
  if (display_hourglass_p)
    start_hourglass ();
534
#endif
535 536 537

#endif

538 539 540
  return val;
}

541
DEFUN ("read-char", Fread_char, Sread_char, 0, 2, 0,
542 543 544 545 546 547 548 549 550 551 552 553 554 555
       doc: /* Read a character from the command input (keyboard or macro).
It is returned as a number.
If the user generates an event which is not a character (i.e. a mouse
click or function key event), `read-char' signals an error.  As an
exception, switch-frame events are put off until non-ASCII events can
be read.
If you want to read non-character events, or ignore them, call
`read-event' or `read-char-exclusive' instead.

If the optional argument PROMPT is non-nil, display that as a prompt.
If the optional argument INHERIT-INPUT-METHOD is non-nil and some
input method is turned on in the current buffer, that input method
is used for reading a character.  */)
     (prompt, inherit_input_method)
556
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
557
{
558 559
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
560
  return read_filtered_event (1, 1, 1, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
561 562
}

563
DEFUN ("read-event", Fread_event, Sread_event, 0, 2, 0,
564 565 566 567 568 569
       doc: /* Read an event object from the input stream.
If the optional argument PROMPT is non-nil, display that as a prompt.
If the optional argument INHERIT-INPUT-METHOD is non-nil and some
input method is turned on in the current buffer, that input method
is used for reading a character.  */)
     (prompt, inherit_input_method)
570
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
571
{
572 573
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
574
  return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
575 576
}

577
DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 2, 0,
578 579 580 581 582 583 584 585
       doc: /* Read a character from the command input (keyboard or macro).
It is returned as a number.  Non-character events are ignored.

If the optional argument PROMPT is non-nil, display that as a prompt.
If the optional argument INHERIT-INPUT-METHOD is non-nil and some
input method is turned on in the current buffer, that input method
is used for reading a character.  */)
     (prompt, inherit_input_method)
586
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
587
{
588 589
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
590
  return read_filtered_event (1, 1, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
591 592 593
}

DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
594 595
       doc: /* Don't use this yourself.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
596 597
{
  register Lisp_Object val;
598
  XSETINT (val, getc (instream));
Jim Blandy's avatar
Jim Blandy committed
599 600
  return val;
}
601 602


603

604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
/* Value is non-zero if the file asswociated with file descriptor FD
   is a compiled Lisp file that's safe to load.  Only files compiled
   with Emacs are safe to load.  Files compiled with XEmacs can lead
   to a crash in Fbyte_code because of an incompatible change in the
   byte compiler.  */

static int
safe_to_load_p (fd)
     int fd;
{
  char buf[512];
  int nbytes, i;
  int safe_p = 1;

  /* Read the first few bytes from the file, and look for a line
     specifying the byte compiler version used.  */
  nbytes = emacs_read (fd, buf, sizeof buf - 1);
  if (nbytes > 0)
    {
      buf[nbytes] = '\0';

      /* Skip to the next newline, skipping over the initial `ELC'
	 with NUL bytes following it.  */
      for (i = 0; i < nbytes && buf[i] != '\n'; ++i)
	;

      if (i < nbytes
	  && fast_c_string_match_ignore_case (Vbytecomp_version_regexp,
					      buf + i) < 0)
	safe_p = 0;
    }

  lseek (fd, 0, SEEK_SET);
  return safe_p;
}


641 642 643 644 645 646 647 648 649 650
/* Callback for record_unwind_protect.  Restore the old load list OLD,
   after loading a file successfully.  */

static Lisp_Object
record_load_unwind (old)
     Lisp_Object old;
{
  return Vloads_in_progress = old;
}

651 652 653 654 655 656 657 658
/* This handler function is used via internal_condition_case_1.  */

static Lisp_Object
load_error_handler (data)
     Lisp_Object data;
{
  return Qnil;
}
659

660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
DEFUN ("get-load-suffixes", Fget_load_suffixes, Sget_load_suffixes, 0, 0, 0,
       doc: /* Return the suffixes that `load' should try if a suffix is \
required.
This uses the variables `load-suffixes' and `load-file-rep-suffixes'.  */)
     ()
{
  Lisp_Object lst = Qnil, suffixes = Vload_suffixes, suffix, ext;
  while (CONSP (suffixes))
    {
      Lisp_Object exts = Vload_file_rep_suffixes;
      suffix = XCAR (suffixes);
      suffixes = XCDR (suffixes);
      while (CONSP (exts))
	{
	  ext = XCAR (exts);
	  exts = XCDR (exts);
	  lst = Fcons (concat2 (suffix, ext), lst);
	}
    }
  return Fnreverse (lst);
}

682
DEFUN ("load", Fload, Sload, 1, 5, 0,
683 684
       doc: /* Execute a file of Lisp code named FILE.
First try FILE with `.elc' appended, then try with `.el',
685 686 687
then try FILE unmodified (the exact suffixes in the exact order are
determined by  `load-suffixes').  Environment variable references in
FILE are replaced with their values by calling `substitute-in-file-name'.
688
This function searches the directories in `load-path'.
689

690
If optional second arg NOERROR is non-nil,
691
report no error if FILE doesn't exist.
692
Print messages at start and end of loading unless
693
optional third arg NOMESSAGE is non-nil.
694
If optional fourth arg NOSUFFIX is non-nil, don't try adding
695
suffixes `.elc' or `.el' to the specified name FILE.
696
If optional fifth arg MUST-SUFFIX is non-nil, insist on
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
the suffix `.elc' or `.el'; don't accept just FILE unless
it ends in one of those suffixes or includes a directory name.

If this function fails to find a file, it may look for different
representations of that file before trying another file.
It does so by adding the non-empty suffixes in `load-file-rep-suffixes'
to the file name.  Emacs uses this feature mainly to find compressed
versions of files when Auto Compression mode is enabled.

The exact suffixes that this function tries out, in the exact order,
are given by the value of the variable `load-file-rep-suffixes' if
NOSUFFIX is non-nil and by the return value of the function
`get-load-suffixes' if MUST-SUFFIX is non-nil.  If both NOSUFFIX and
MUST-SUFFIX are nil, this function first tries out the latter suffixes
and then the former.
712 713 714 715 716

Loading a file records its definitions, and its `provide' and
`require' calls, in an element of `load-history' whose
car is the file name loaded.  See `load-history'.

717
Return t if the file exists and loads successfully.  */)
718
     (file, noerror, nomessage, nosuffix, must_suffix)
719
     Lisp_Object file, noerror, nomessage, nosuffix, must_suffix;
Jim Blandy's avatar
Jim Blandy committed
720 721 722
{
  register FILE *stream;
  register int fd = -1;
Juanma Barranquero's avatar
Juanma Barranquero committed
723
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
724
  Lisp_Object temp;
725 726
  struct gcpro gcpro1, gcpro2, gcpro3;
  Lisp_Object found, efound, hist_file_name;
727 728 729 730
  /* 1 means we printed the ".el is newer" message.  */
  int newer = 0;
  /* 1 means we are loading a compiled file.  */
  int compiled = 0;
731
  Lisp_Object handler;
732
  int safe_p = 1;
733
  char *fmode = "r";
734
  Lisp_Object tmp[2];
735
#ifdef DOS_NT
736
  fmode = "rt";
737
#endif /* DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
738

739
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
740

741
  /* If file name is magic, call the handler.  */
742 743 744 745
  /* This shouldn't be necessary any more now that `openp' handles it right.
    handler = Ffind_file_name_handler (file, Qload);
    if (!NILP (handler))
      return call5 (handler, Qload, file, noerror, nomessage, nosuffix); */
746

747 748
  /* Do this after the handler to avoid
     the need to gcpro noerror, nomessage and nosuffix.
749 750
     (Below here, we care only whether they are nil or not.)
     The presence of this call is the result of a historical accident:
751
     it used to be in every file-operation and when it got removed
752 753 754
     everywhere, it accidentally stayed here.  Since then, enough people
     supposedly have things like (load "$PROJECT/foo.el") in their .emacs
     that it seemed risky to remove.  */
755 756 757 758 759 760 761 762 763
  if (! NILP (noerror))
    {
      file = internal_condition_case_1 (Fsubstitute_in_file_name, file,
					Qt, load_error_handler);
      if (NILP (file))
	return Qnil;
    }
  else
    file = Fsubstitute_in_file_name (file);
764

765

Jim Blandy's avatar
Jim Blandy committed
766 767
  /* Avoid weird lossage with null string as arg,
     since it would try to load a directory as a Lisp file */
768
  if (SCHARS (file) > 0)
Jim Blandy's avatar
Jim Blandy committed
769
    {
770
      int size = SBYTES (file);
771

772 773
      found = Qnil;
      GCPRO2 (file, found);
774 775 776 777 778

      if (! NILP (must_suffix))
	{
	  /* Don't insist on adding a suffix if FILE already ends with one.  */
	  if (size > 3
779
	      && !strcmp (SDATA (file) + size - 3, ".el"))
780 781
	    must_suffix = Qnil;
	  else if (size > 4
782
		   && !strcmp (SDATA (file) + size - 4, ".elc"))
783 784 785 786 787 788 789
	    must_suffix = Qnil;
	  /* Don't insist on adding a suffix
	     if the argument includes a directory name.  */
	  else if (! NILP (Ffile_name_directory (file)))
	    must_suffix = Qnil;
	}

790
      fd = openp (Vload_path, file,
791
		  (!NILP (nosuffix) ? Qnil
792 793 794
		   : !NILP (must_suffix) ? Fget_load_suffixes ()
		   : Fappend (2, (tmp[0] = Fget_load_suffixes (),
				  tmp[1] = Vload_file_rep_suffixes,
795
				  tmp))),
796
		  &found, Qnil);
797
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
798 799
    }

800
  if (fd == -1)
Jim Blandy's avatar
Jim Blandy committed
801
    {
Jim Blandy's avatar
Jim Blandy committed
802
      if (NILP (noerror))
803 804
	xsignal2 (Qfile_error, build_string ("Cannot open load file"), file);
      return Qnil;
Jim Blandy's avatar
Jim Blandy committed
805 806
    }

807
  /* Tell startup.el whether or not we found the user's init file.  */
Karl Heuer's avatar
Karl Heuer committed
808 809 810
  if (EQ (Qt, Vuser_init_file))
    Vuser_init_file = found;

811 812
  /* If FD is -2, that means openp found a magic file.  */
  if (fd == -2)
813
    {
814 815 816 817 818 819 820 821 822
      if (NILP (Fequal (found, file)))
	/* If FOUND is a different file name from FILE,
	   find its handler even if we have already inhibited
	   the `load' operation on FILE.  */
	handler = Ffind_file_name_handler (found, Qt);
      else
	handler = Ffind_file_name_handler (found, Qload);
      if (! NILP (handler))
	return call5 (handler, Qload, found, noerror, nomessage, Qt);
823 824
    }

825 826 827 828 829 830 831 832 833 834
  /* Check if we're stuck in a recursive load cycle.

     2000-09-21: It's not possible to just check for the file loaded
     being a member of Vloads_in_progress.  This fails because of the
     way the byte compiler currently works; `provide's are not
     evaluted, see font-lock.el/jit-lock.el as an example.  This
     leads to a certain amount of ``normal'' recursion.

     Also, just loading a file recursively is not always an error in
     the general case; the second load may do something different.  */
835 836 837 838 839 840 841
  {
    int count = 0;
    Lisp_Object tem;
    for (tem = Vloads_in_progress; CONSP (tem); tem = XCDR (tem))
      if (!NILP (Fequal (found, XCAR (tem))))
	count++;
    if (count > 3)
842 843 844
      {
	if (fd >= 0)
	  emacs_close (fd);
845
	signal_error ("Recursive load", Fcons (found, Vloads_in_progress));
846
      }
847 848 849
    record_unwind_protect (record_load_unwind, Vloads_in_progress);
    Vloads_in_progress = Fcons (found, Vloads_in_progress);
  }
850

851 852 853 854 855 856 857
  /* Get the name for load-history. */
  hist_file_name = (! NILP (Vpurify_flag)
                    ? Fconcat (2, (tmp[0] = Ffile_name_directory (file),
                                   tmp[1] = Ffile_name_nondirectory (found),
                                   tmp))
                    : found) ;

858
  if (!bcmp (SDATA (found) + SBYTES (found) - 4,
859 860 861
	     ".elc", 4))
    /* Load .elc files directly, but not when they are
       remote and have no handler!  */
Jim Blandy's avatar
Jim Blandy committed
862
    {
863
      if (fd != -2)
864
	{
865 866
	  struct stat s1, s2;
	  int result;
867

868
	  GCPRO3 (file, found, hist_file_name);
869

870 871 872 873
	  if (!safe_to_load_p (fd))
	    {
	      safe_p = 0;
	      if (!load_dangerous_libraries)
874 875 876 877 878 879
		{
		  if (fd >= 0)
		    emacs_close (fd);
		  error ("File `%s' was not compiled in Emacs",
			 SDATA (found));
		}
880 881 882
	      else if (!NILP (nomessage))
		message_with_string ("File `%s' not compiled in Emacs", found, 1);
	    }
883

884 885
	  compiled = 1;

886 887
	  efound = ENCODE_FILE (found);

Dave Love's avatar
Dave Love committed
888
#ifdef DOS_NT
889
	  fmode = "rb";
Dave Love's avatar
Dave Love committed
890
#endif /* DOS_NT */
891
	  stat ((char *)SDATA (efound), &s1);
892
	  SSET (efound, SBYTES (efound) - 1, 0);
893
	  result = stat ((char *)SDATA (efound), &s2);
894
	  SSET (efound, SBYTES (efound) - 1, 'c');
895

896 897 898 899
	  if (result >= 0 && (unsigned) s1.st_mtime < (unsigned) s2.st_mtime)
	    {
	      /* Make the progress messages mention that source is newer.  */
	      newer = 1;
900

901
	      /* If we won't print another message, mention this anyway.  */
902 903
	      if (!NILP (nomessage))
		{
904 905
		  Lisp_Object msg_file;
		  msg_file = Fsubstring (found, make_number (0), make_number (-1));
906
		  message_with_string ("Source file `%s' newer than byte-compiled file",
907
				       msg_file, 1);
908
		}
909
	    }
910
	  UNGCPRO;
911
	}
Jim Blandy's avatar
Jim Blandy committed
912
    }
Karl Heuer's avatar
Karl Heuer committed
913 914 915 916 917
  else
    {
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
918
	  Lisp_Object val;
919 920

	  if (fd >= 0)
921
	    emacs_close (fd);
922
	  val = call4 (Vload_source_file_function, found, hist_file_name,
923 924 925
		       NILP (noerror) ? Qnil : Qt,
		       NILP (nomessage) ? Qnil : Qt);
	  return unbind_to (count, val);
Karl Heuer's avatar
Karl Heuer committed
926 927
	}
    }
Jim Blandy's avatar
Jim Blandy committed
928

929
  GCPRO3 (file, found, hist_file_name);
930

931
#ifdef WINDOWSNT
932
  emacs_close (fd);
933
  efound = ENCODE_FILE (found);
934
  stream = fopen ((char *) SDATA (efound), fmode);
935 936 937
#else  /* not WINDOWSNT */
  stream = fdopen (fd, fmode);
#endif /* not WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
938 939
  if (stream == 0)
    {
940
      emacs_close (fd);
941
      error ("Failure to create stdio stream for %s", SDATA (file));
Jim Blandy's avatar
Jim Blandy committed
942 943
    }

944 945 946
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

947 948
  if (NILP (nomessage))
    {
949 950 951 952
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
		 file, 1);
      else if (!compiled)
953
	message_with_string ("Loading %s (source)...", file, 1);
954
      else if (newer)
955 956
	message_with_string ("Loading %s (compiled; note, source file is newer)...",
		 file, 1);
957
      else /* The typical case; compiled file newer than source file.  */
958
	message_with_string ("Loading %s...", file, 1);
959
    }
Jim Blandy's avatar
Jim Blandy committed
960

961
  record_unwind_protect (load_unwind, make_save_value (stream, 0));
962
  record_unwind_protect (load_descriptor_unwind, load_descriptor_list);
963
  specbind (Qload_file_name, found);
964
  specbind (Qinhibit_file_name_operation, Qnil);
965 966
  load_descriptor_list
    = Fcons (make_number (fileno (stream)), load_descriptor_list);
Jim Blandy's avatar
Jim Blandy committed
967
  load_in_progress++;
968
  readevalloop (Qget_file_char, stream, hist_file_name,
969
		Feval, 0, Qnil, Qnil, Qnil, Qnil);
Jim Blandy's avatar
Jim Blandy committed
970 971
  unbind_to (count, Qnil);

972 973 974 975 976
  /* Run any eval-after-load forms for this file */
  if (NILP (Vpurify_flag)
      && (!NILP (Ffboundp (Qdo_after_load_evaluation))))
    call1 (Qdo_after_load_evaluation, hist_file_name) ;

Jim Blandy's avatar
Jim Blandy committed
977 978
  UNGCPRO;

979 980 981 982 983
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

984
  if (prev_saved_doc_string)
985
    xfree (prev_saved_doc_string);
986 987 988
  prev_saved_doc_string = 0;
  prev_saved_doc_string_size = 0;

Jim Blandy's avatar
Jim Blandy committed
989
  if (!noninteractive && NILP (nomessage))
990
    {
991 992 993 994
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
		 file, 1);
      else if (!compiled)
995
	message_with_string ("Loading %s (source)...done", file, 1);
996
      else if (newer)