lread.c 101 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp parsing and input streams.
2
   Copyright (C) 1985, 86, 87, 88, 89, 93, 94, 95, 97, 98, 99, 2000, 2001
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


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

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

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

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

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

#include <math.h>

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

Richard M. Stallman's avatar
Richard M. Stallman committed
63 64 65 66
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

67
#ifdef HAVE_FSEEKO
68 69 70 71 72 73 74
#define file_offset off_t
#define file_tell ftello
#else
#define file_offset long
#define file_tell ftell
#endif

75
#ifndef USE_CRT_DLL
76
extern int errno;
77
#endif
78

79
Lisp_Object Qread_char, Qget_file_char, Qstandard_input, Qcurrent_load_list;
Jim Blandy's avatar
Jim Blandy committed
80
Lisp_Object Qvariable_documentation, Vvalues, Vstandard_input, Vafter_load_alist;
81
Lisp_Object Qascii_character, Qload, Qload_file_name;
82
Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
83
Lisp_Object Qinhibit_file_name_operation;
84 85

extern Lisp_Object Qevent_symbol_element_mask;
86
extern Lisp_Object Qfile_exists_p;
Jim Blandy's avatar
Jim Blandy committed
87 88 89 90

/* non-zero if inside `load' */
int load_in_progress;

91 92 93
/* Directory in which the sources were found.  */
Lisp_Object Vsource_directory;

94 95
/* Search path and suffixes for files to be loaded. */
Lisp_Object Vload_path, Vload_suffixes, default_suffixes;
Jim Blandy's avatar
Jim Blandy committed
96

Karl Heuer's avatar
Karl Heuer committed
97 98 99
/* File name of user's init file.  */
Lisp_Object Vuser_init_file;

100 101 102 103
/* This is the user-visible association list that maps features to
   lists of defs in their load files. */
Lisp_Object Vload_history;

104
/* This is used to build the load history. */
105 106
Lisp_Object Vcurrent_load_list;

107 108 109
/* List of files that were preloaded.  */
Lisp_Object Vpreloaded_file_list;

110 111 112
/* Name of file actually being read by `load'.  */
Lisp_Object Vload_file_name;

113 114 115
/* Function to use for reading, in `load' and friends.  */
Lisp_Object Vload_read_function;

116 117 118 119 120 121
/* 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;

122 123 124
/* Nonzero means load should forcibly load all dynamic doc strings.  */
static int load_force_doc_strings;

125 126 127
/* Nonzero means read should convert strings to unibyte.  */
static int load_convert_to_unibyte;

Karl Heuer's avatar
Karl Heuer committed
128 129 130 131
/* Function to use for loading an Emacs lisp source file (not
   compiled) instead of readevalloop.  */
Lisp_Object Vload_source_file_function;

132 133 134
/* List of all DEFVAR_BOOL variables.  Used by the byte optimizer.  */
Lisp_Object Vbyte_boolean_vars;

135 136 137
/* List of descriptors now open for Fload.  */
static Lisp_Object load_descriptor_list;

138
/* File for get_file_char to read from.  Use by load.  */
Jim Blandy's avatar
Jim Blandy committed
139 140 141 142 143
static FILE *instream;

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

144
/* For use within read-from-string (this reader is non-reentrant!!)  */
Jim Blandy's avatar
Jim Blandy committed
145
static int read_from_string_index;
146
static int read_from_string_index_byte;
Jim Blandy's avatar
Jim Blandy committed
147
static int read_from_string_limit;
148

149 150 151 152
/* Number of bytes left to read in the buffer character
   that `readchar' has already advanced over.  */
static int readchar_backlog;

153
/* This contains the last string skipped with #@.  */
154 155 156 157 158 159
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.  */
160
static file_offset saved_doc_string_position;
161

162 163 164 165 166 167 168 169 170
/* 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.  */
171
static file_offset prev_saved_doc_string_position;
172

173 174 175 176 177
/* 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;
178 179 180 181 182 183

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

static Lisp_Object Vloads_in_progress;

184 185 186 187 188 189 190 191 192 193 194 195
/* Limit of the depth of recursive loads.  */

Lisp_Object Vrecursive_load_depth_limit;

/* 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
196
static void to_multibyte P_ ((char **, char **, int *));
197 198 199 200 201 202
static void readevalloop P_ ((Lisp_Object, FILE*, Lisp_Object, 
			      Lisp_Object (*) (), int,
			      Lisp_Object, Lisp_Object));
static Lisp_Object load_unwind P_ ((Lisp_Object));
static Lisp_Object load_descriptor_unwind P_ ((Lisp_Object));

Jim Blandy's avatar
Jim Blandy committed
203 204 205

/* Handle unreading and rereading of characters.
   Write READCHAR to read a character,
Karl Heuer's avatar
Karl Heuer committed
206 207 208 209 210
   UNREAD(c) to unread c to be read again.

   These macros actually read/unread a byte code, multibyte characters
   are not handled here.  The caller should manage them if necessary.
 */
Jim Blandy's avatar
Jim Blandy committed
211 212 213 214 215 216 217 218 219

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

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

222
  if (BUFFERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
223
    {
224
      register struct buffer *inbuffer = XBUFFER (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
225

226 227
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
228

229 230 231 232 233 234 235 236
      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);

237 238
      if (pt_byte >= BUF_ZV_BYTE (inbuffer))
	return -1;
Jim Blandy's avatar
Jim Blandy committed
239

240 241
      readchar_backlog = -1;

242 243
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
244
	  /* Fetch the character code from the buffer.  */
245 246 247 248 249 250 251 252
	  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++;
253
	}
254
      SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
255

256
      return c;
Jim Blandy's avatar
Jim Blandy committed
257
    }
258
  if (MARKERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
259
    {
260
      register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
261

262 263
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
264

265 266 267 268 269 270 271 272
      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);

273 274
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
275

276 277
      readchar_backlog = -1;

278 279
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
280
	  /* Fetch the character code from the buffer.  */
281 282 283 284 285 286 287 288
	  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++;
289 290
	}

291 292 293 294
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

      return c;
Jim Blandy's avatar
Jim Blandy committed
295
    }
296 297 298 299

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

Jim Blandy's avatar
Jim Blandy committed
300
  if (EQ (readcharfun, Qget_file_char))
301 302 303 304 305 306 307 308 309 310 311 312
    {
      c = getc (instream);
#ifdef EINTR
      /* Interrupted reads have been observed while reading over the network */
      while (c == EOF && ferror (instream) && errno == EINTR)
	{
	  clearerr (instream);
	  c = getc (instream);
	}
#endif
      return c;
    }
Jim Blandy's avatar
Jim Blandy committed
313

314
  if (STRINGP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
315
    {
316
      if (read_from_string_index >= read_from_string_limit)
Jim Blandy's avatar
Jim Blandy committed
317
	c = -1;
318
      else
319 320 321
	FETCH_STRING_CHAR_ADVANCE (c, readcharfun,
				   read_from_string_index,
				   read_from_string_index_byte);
322

Jim Blandy's avatar
Jim Blandy committed
323 324 325 326 327
      return c;
    }

  tem = call0 (readcharfun);

Jim Blandy's avatar
Jim Blandy committed
328
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
329 330 331 332 333 334 335 336 337 338 339 340
    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;
{
341 342 343 344
  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.  */
    ;
345
  else if (BUFFERP (readcharfun))
346
    {
347 348
      struct buffer *b = XBUFFER (readcharfun);
      int bytepos = BUF_PT_BYTE (b);
349

350 351
      if (readchar_backlog >= 0)
	readchar_backlog++;
352
      else
353 354 355 356 357 358
	{
	  BUF_PT (b)--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
359

360 361
	  BUF_PT_BYTE (b) = bytepos;
	}
362
    }
363
  else if (MARKERP (readcharfun))
364
    {
365 366
      struct buffer *b = XMARKER (readcharfun)->buffer;
      int bytepos = XMARKER (readcharfun)->bytepos;
367

368 369
      if (readchar_backlog >= 0)
	readchar_backlog++;
370
      else
371 372 373 374 375 376
	{
	  XMARKER (readcharfun)->charpos--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
377

378 379
	  XMARKER (readcharfun)->bytepos = bytepos;
	}
380
    }
381
  else if (STRINGP (readcharfun))
382 383 384 385 386
    {
      read_from_string_index--;
      read_from_string_index_byte
	= string_char_to_byte (readcharfun, read_from_string_index);
    }
387 388
  else if (EQ (readcharfun, Qlambda))
    read_bytecode_char (1);
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393 394 395
  else if (EQ (readcharfun, Qget_file_char))
    ungetc (c, instream);
  else
    call1 (readcharfun, make_number (c));
}

static Lisp_Object read0 (), read1 (), read_list (), read_vector ();
396
static int read_multibyte ();
397 398 399
static Lisp_Object substitute_object_recurse ();
static void        substitute_object_in_subtree (), substitute_in_interval ();

Jim Blandy's avatar
Jim Blandy committed
400

401
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
402

403 404
extern Lisp_Object read_char ();

405 406 407 408 409 410 411 412 413 414 415 416 417
/* 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
418 419 420 421
   character.

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

423
Lisp_Object
424 425 426
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
427
{
428 429
  register Lisp_Object val, delayed_switch_frame;

430
#ifdef HAVE_WINDOW_SYSTEM
431 432
  if (display_hourglass_p)
    cancel_hourglass ();
433 434
#endif
  
435
  delayed_switch_frame = Qnil;
436 437 438

  /* Read until we get an acceptable event.  */
 retry:
439 440 441
  val = read_char (0, 0, 0,
		   (input_method ? Qnil : Qt),
		   0);
442

443
  if (BUFFERP (val))
444 445
    goto retry;

446
  /* switch-frame events are put off until after the next ASCII
Karl Heuer's avatar
Karl Heuer committed
447
     character.  This is better than signaling an error just because
448 449 450 451 452 453 454 455 456 457 458 459 460 461
     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)
      && EQ (EVENT_HEAD (val), Qswitch_frame))
    {
      delayed_switch_frame = val;
      goto retry;
    }

  if (ascii_required)
    {
      /* Convert certain symbols to their ASCII equivalents.  */
462
      if (SYMBOLP (val))
463
	{
464
	  Lisp_Object tem, tem1;
465 466 467 468 469 470 471
	  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))
472
		XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
473 474 475 476
	    }
	}
	  
      /* If we don't have a character now, deal with it appropriately.  */
477
      if (!INTEGERP (val))
478 479 480
	{
	  if (error_nonascii)
	    {
481
	      Vunread_command_events = Fcons (val, Qnil);
482 483 484 485 486 487 488 489 490 491
	      error ("Non-character input-event");
	    }
	  else
	    goto retry;
	}
    }

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

492
#ifdef HAVE_WINDOW_SYSTEM
493 494
  if (display_hourglass_p)
    start_hourglass ();
495
#endif
496 497 498
  return val;
}

499
DEFUN ("read-char", Fread_char, Sread_char, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
500
  "Read a character from the command input (keyboard or macro).\n\
Jim Blandy's avatar
Jim Blandy committed
501 502
It is returned as a number.\n\
If the user generates an event which is not a character (i.e. a mouse\n\
Jim Blandy's avatar
Jim Blandy committed
503 504 505 506
click or function key event), `read-char' signals an error.  As an\n\
exception, switch-frame events are put off until non-ASCII events can\n\
be read.\n\
If you want to read non-character events, or ignore them, call\n\
507 508 509
`read-event' or `read-char-exclusive' instead.\n\
\n\
If the optional argument PROMPT is non-nil, display that as a prompt.\n\
510 511 512 513 514
If the optional argument INHERIT-INPUT-METHOD is non-nil and some\n\
input method is turned on in the current buffer, that input method\n\
is used for reading a character.")
  (prompt, inherit_input_method)
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
515
{
516 517
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
518
  return read_filtered_event (1, 1, 1, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
519 520
}

521 522 523
DEFUN ("read-event", Fread_event, Sread_event, 0, 2, 0,
  "Read an event object from the input stream.\n\
If the optional argument PROMPT is non-nil, display that as a prompt.\n\
524 525 526 527 528
If the optional argument INHERIT-INPUT-METHOD is non-nil and some\n\
input method is turned on in the current buffer, that input method\n\
is used for reading a character.")
  (prompt, inherit_input_method)
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
529
{
530 531
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
532
  return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
533 534
}

535
DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
536
  "Read a character from the command input (keyboard or macro).\n\
537 538 539
It is returned as a number.  Non-character events are ignored.\n\
\n\
If the optional argument PROMPT is non-nil, display that as a prompt.\n\
540 541 542 543 544
If the optional argument INHERIT-INPUT-METHOD is non-nil and some\n\
input method is turned on in the current buffer, that input method\n\
is used for reading a character.")
  (prompt, inherit_input_method)
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
545
{
546 547
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
548
  return read_filtered_event (1, 1, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
549 550 551 552 553 554 555
}

DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
  "Don't use this yourself.")
  ()
{
  register Lisp_Object val;
556
  XSETINT (val, getc (instream));
Jim Blandy's avatar
Jim Blandy committed
557 558
  return val;
}
559 560


561

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
/* 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;
}


599 600 601 602 603 604 605 606 607 608 609
/* 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;
}


610
DEFUN ("load", Fload, Sload, 1, 5, 0,
Jim Blandy's avatar
Jim Blandy committed
611 612
  "Execute a file of Lisp code named FILE.\n\
First try FILE with `.elc' appended, then try with `.el',\n\
613 614
 then try FILE unmodified.  Environment variable references in FILE\n\
 are replaced with their values by calling `substitute-in-file-name'.\n\
Jim Blandy's avatar
Jim Blandy committed
615 616 617 618 619 620 621
This function searches the directories in `load-path'.\n\
If optional second arg NOERROR is non-nil,\n\
 report no error if FILE doesn't exist.\n\
Print messages at start and end of loading unless\n\
 optional third arg NOMESSAGE is non-nil.\n\
If optional fourth arg NOSUFFIX is non-nil, don't try adding\n\
 suffixes `.elc' or `.el' to the specified name FILE.\n\
622
If optional fifth arg MUST-SUFFIX is non-nil, insist on\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
623
 the suffix `.elc' or `.el'; don't accept just FILE unless\n\
624
 it ends in one of those suffixes or includes a directory name.\n\
Jim Blandy's avatar
Jim Blandy committed
625
Return t if file exists.")
626 627
  (file, noerror, nomessage, nosuffix, must_suffix)
     Lisp_Object file, noerror, nomessage, nosuffix, must_suffix;
Jim Blandy's avatar
Jim Blandy committed
628 629 630 631 632 633 634 635
{
  register FILE *stream;
  register int fd = -1;
  register Lisp_Object lispstream;
  int count = specpdl_ptr - specpdl;
  Lisp_Object temp;
  struct gcpro gcpro1;
  Lisp_Object found;
636 637 638 639
  /* 1 means we printed the ".el is newer" message.  */
  int newer = 0;
  /* 1 means we are loading a compiled file.  */
  int compiled = 0;
640
  Lisp_Object handler;
641
  int safe_p = 1;
642
  char *fmode = "r";
643
#ifdef DOS_NT
644
  fmode = "rt";
645
#endif /* DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
646

647
  CHECK_STRING (file, 0);
Jim Blandy's avatar
Jim Blandy committed
648

649
  /* If file name is magic, call the handler.  */
650 651 652 653
  /* 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); */
654

655 656
  /* Do this after the handler to avoid
     the need to gcpro noerror, nomessage and nosuffix.
657 658 659 660 661 662
     (Below here, we care only whether they are nil or not.)
     The presence of this call is the result of a historical accident:
     it used to be in every file-operations and when it got removed
     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.  */
663
  file = Fsubstitute_in_file_name (file);
664

Jim Blandy's avatar
Jim Blandy committed
665 666
  /* Avoid weird lossage with null string as arg,
     since it would try to load a directory as a Lisp file */
667
  if (XSTRING (file)->size > 0)
Jim Blandy's avatar
Jim Blandy committed
668
    {
669
      int size = STRING_BYTES (XSTRING (file));
670
      Lisp_Object tmp[2];
671

672
      GCPRO1 (file);
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688

      if (! NILP (must_suffix))
	{
	  /* Don't insist on adding a suffix if FILE already ends with one.  */
	  if (size > 3
	      && !strcmp (XSTRING (file)->data + size - 3, ".el"))
	    must_suffix = Qnil;
	  else if (size > 4
		   && !strcmp (XSTRING (file)->data + size - 4, ".elc"))
	    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;
	}

689
      fd = openp (Vload_path, file,
690 691 692 693 694
		  (!NILP (nosuffix) ? Qnil
		   : !NILP (must_suffix) ? Vload_suffixes
		   : Fappend (2, (tmp[0] = Vload_suffixes,
				  tmp[1] = default_suffixes,
				  tmp))),
Jim Blandy's avatar
Jim Blandy committed
695
		  &found, 0);
696
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
697 698
    }

699
  if (fd == -1)
Jim Blandy's avatar
Jim Blandy committed
700
    {
Jim Blandy's avatar
Jim Blandy committed
701
      if (NILP (noerror))
Jim Blandy's avatar
Jim Blandy committed
702 703
	while (1)
	  Fsignal (Qfile_error, Fcons (build_string ("Cannot open load file"),
704
				       Fcons (file, Qnil)));
Jim Blandy's avatar
Jim Blandy committed
705 706 707 708
      else
	return Qnil;
    }

709
  /* Tell startup.el whether or not we found the user's init file.  */
Karl Heuer's avatar
Karl Heuer committed
710 711 712
  if (EQ (Qt, Vuser_init_file))
    Vuser_init_file = found;

713 714
  /* If FD is -2, that means openp found a magic file.  */
  if (fd == -2)
715
    {
716 717 718 719 720 721 722 723 724
      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);
725 726
    }

727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
  /* 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.  */
  if (INTEGERP (Vrecursive_load_depth_limit)
      && XINT (Vrecursive_load_depth_limit) > 0)
    {
      Lisp_Object len = Flength (Vloads_in_progress);
      if (XFASTINT (len) > XFASTINT (Vrecursive_load_depth_limit))
	Fsignal (Qerror, Fcons (build_string ("Recursive load suspected"),
				Fcons (found, Vloads_in_progress)));
      record_unwind_protect (record_load_unwind, Vloads_in_progress);
      Vloads_in_progress = Fcons (found, Vloads_in_progress);
    }
747

748
  if (!bcmp (&(XSTRING (found)->data[STRING_BYTES (XSTRING (found)) - 4]),
749 750 751
	     ".elc", 4))
    /* Load .elc files directly, but not when they are
       remote and have no handler!  */
Jim Blandy's avatar
Jim Blandy committed
752
    {
753
      if (fd != -2)
754
	{
755 756
	  struct stat s1, s2;
	  int result;
757

758 759 760 761 762 763 764 765 766
	  if (!safe_to_load_p (fd))
	    {
	      safe_p = 0;
	      if (!load_dangerous_libraries)
		error ("File `%s' was not compiled in Emacs",
		       XSTRING (found)->data);
	      else if (!NILP (nomessage))
		message_with_string ("File `%s' not compiled in Emacs", found, 1);
	    }
767

768 769
	  compiled = 1;

Dave Love's avatar
Dave Love committed
770
#ifdef DOS_NT
771
	  fmode = "rb";
Dave Love's avatar
Dave Love committed
772
#endif /* DOS_NT */
773 774 775 776 777 778 779
	  stat ((char *)XSTRING (found)->data, &s1);
	  XSTRING (found)->data[STRING_BYTES (XSTRING (found)) - 1] = 0;
	  result = stat ((char *)XSTRING (found)->data, &s2);
	  if (result >= 0 && (unsigned) s1.st_mtime < (unsigned) s2.st_mtime)
	    {
	      /* Make the progress messages mention that source is newer.  */
	      newer = 1;
780

781 782 783 784 785 786
	      /* If we won't print another message, mention this anyway.  */
	      if (! NILP (nomessage))
		message_with_string ("Source file `%s' newer than byte-compiled file",
				     found, 1);
	    }
	  XSTRING (found)->data[STRING_BYTES (XSTRING (found)) - 1] = 'c';
787
	}
Jim Blandy's avatar
Jim Blandy committed
788
    }
Karl Heuer's avatar
Karl Heuer committed
789 790 791 792 793
  else
    {
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
794
	  Lisp_Object val;
795 796

	  if (fd >= 0)
797
	    emacs_close (fd);
798 799 800 801
	  val = call4 (Vload_source_file_function, found, file,
		       NILP (noerror) ? Qnil : Qt,
		       NILP (nomessage) ? Qnil : Qt);
	  return unbind_to (count, val);
Karl Heuer's avatar
Karl Heuer committed
802 803
	}
    }
Jim Blandy's avatar
Jim Blandy committed
804

805
#ifdef WINDOWSNT
806
  emacs_close (fd);
807 808 809 810
  stream = fopen ((char *) XSTRING (found)->data, fmode);
#else  /* not WINDOWSNT */
  stream = fdopen (fd, fmode);
#endif /* not WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
811 812
  if (stream == 0)
    {
813
      emacs_close (fd);
814
      error ("Failure to create stdio stream for %s", XSTRING (file)->data);
Jim Blandy's avatar
Jim Blandy committed
815 816
    }

817 818 819
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

820 821
  if (NILP (nomessage))
    {
822 823 824 825
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
		 file, 1);
      else if (!compiled)
826
	message_with_string ("Loading %s (source)...", file, 1);
827
      else if (newer)
828 829
	message_with_string ("Loading %s (compiled; note, source file is newer)...",
		 file, 1);
830
      else /* The typical case; compiled file newer than source file.  */
831
	message_with_string ("Loading %s...", file, 1);
832
    }
Jim Blandy's avatar
Jim Blandy committed
833

834
  GCPRO1 (file);
835
  lispstream = Fcons (Qnil, Qnil);
836 837
  XSETFASTINT (XCAR (lispstream), (EMACS_UINT)stream >> 16);
  XSETFASTINT (XCDR (lispstream), (EMACS_UINT)stream & 0xffff);
Jim Blandy's avatar
Jim Blandy committed
838
  record_unwind_protect (load_unwind, lispstream);
839
  record_unwind_protect (load_descriptor_unwind, load_descriptor_list);
840
  specbind (Qload_file_name, found);
841
  specbind (Qinhibit_file_name_operation, Qnil);
842 843
  load_descriptor_list
    = Fcons (make_number (fileno (stream)), load_descriptor_list);
Jim Blandy's avatar
Jim Blandy committed
844
  load_in_progress++;
845
  readevalloop (Qget_file_char, stream, file, Feval, 0, Qnil, Qnil);
Jim Blandy's avatar
Jim Blandy committed
846 847 848
  unbind_to (count, Qnil);

  /* Run any load-hooks for this file.  */
849
  temp = Fassoc (file, Vafter_load_alist);
Jim Blandy's avatar
Jim Blandy committed
850
  if (!NILP (temp))
Jim Blandy's avatar
Jim Blandy committed
851 852 853
    Fprogn (Fcdr (temp));
  UNGCPRO;

854 855 856 857 858
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

859
  if (prev_saved_doc_string)
860
    xfree (prev_saved_doc_string);
861 862 863
  prev_saved_doc_string = 0;
  prev_saved_doc_string_size = 0;

Jim Blandy's avatar
Jim Blandy committed
864
  if (!noninteractive && NILP (nomessage))
865
    {
866 867 868 869
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
		 file, 1);
      else if (!compiled)
870
	message_with_string ("Loading %s (source)...done", file, 1);
871
      else if (newer)
872 873
	message_with_string ("Loading %s (compiled; note, source file is newer)...done",
		 file, 1);
874
      else /* The typical case; compiled file newer than source file.  */
875
	message_with_string ("Loading %s...done", file, 1);
876
    }
877

Jim Blandy's avatar
Jim Blandy committed
878 879 880 881 882 883 884
  return Qt;
}

static Lisp_Object
load_unwind (stream)  /* used as unwind-protect function in load */
     Lisp_Object stream;
{
885 886
  fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
		    | XFASTINT (XCDR (stream))));
Jim Blandy's avatar
Jim Blandy committed
887 888 889 890
  if (--load_in_progress < 0) load_in_progress = 0;
  return Qnil;
}

891 892 893 894 895
static Lisp_Object
load_descriptor_unwind (oldlist)
     Lisp_Object oldlist;
{
  load_descriptor_list = oldlist;
896
  return Qnil;
897 898 899 900 901 902 903 904
}

/* Close all descriptors in use for Floads.
   This is used when starting a subprocess.  */

void
close_load_descs ()
{
905
#ifndef WINDOWSNT
906
  Lisp_Object tail;
907
  for (tail = load_descriptor_list; !NILP (tail); tail = XCDR (tail))
908
    emacs_close (XFASTINT (XCAR (tail)));
909
#endif
910
}
Jim Blandy's avatar
Jim Blandy committed
911 912 913 914 915 916

static int
complete_filename_p (pathname)
     Lisp_Object pathname;
{
  register unsigned char *s = XSTRING (pathname)->data;
917 918 919
  return (IS_DIRECTORY_SEP (s[0])
	  || (XSTRING (pathname)->size > 2
	      && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2]))
Jim Blandy's avatar
Jim Blandy committed
920 921 922 923 924 925 926 927 928 929 930 931 932
#ifdef ALTOS
	  || *s == '@'
#endif
#ifdef VMS
	  || index (s, ':')
#endif /* VMS */
	  );
}

/* Search for a file whose name is STR, looking in directories
   in the Lisp list PATH, and trying suffixes from SUFFIX.
   On success, returns a file descriptor.  On failure, returns -1.

933 934 935
   SUFFIXES is a list of strings containing possible suffixes.
   The empty suffix is automatically added iff the list is empty.

Jim Blandy's avatar
Jim Blandy committed
936 937 938 939 940 941
   EXEC_ONLY nonzero means don't open the files,
   just look for one that is executable.  In this case,
   returns 1 on success.

   If STOREPTR is nonzero, it points to a slot where the name of
   the file actually found should be stored as a Lisp string.
942 943
   nil is stored there on failure.

944
   If the file we find is remote, return -2
945 946
   but store the found remote file name in *STOREPTR.
   We do not check for remote files if EXEC_ONLY is nonzero.  */
Jim Blandy's avatar
Jim Blandy committed
947 948

int
949
openp (path, str, suffixes, storeptr, exec_only)
Jim Blandy's avatar
Jim Blandy committed
950
     Lisp_Object path, str;
951
     Lisp_Object suffixes;
Jim Blandy's avatar
Jim Blandy committed
952 953 954 955 956 957 958 959 960
     Lisp_Object *storeptr;
     int exec_only;
{
  register int fd;
  int fn_size = 100;
  char buf[100];
  register char *fn = buf;
  int absolute = 0;
  int want_size;
961
  Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
962
  struct stat st;
963 964 965 966 967 968
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
  Lisp_Object string, tail;
  int max_suffix_len = 0;

  for (tail = suffixes; CONSP (tail); tail = XCDR (tail))
    {
969
      CHECK_STRING (XCAR (tail), 0);
970
      max_suffix_len = max (max_suffix_len,
971
			    STRING_BYTES (XSTRING (XCAR (tail))));
972
    }
Jim Blandy's avatar
Jim Blandy committed
973

974 975 976
  string = filename = Qnil;
  GCPRO5 (str, string, filename, path, suffixes);
  
Jim Blandy's avatar
Jim Blandy committed
977 978 979 980 981 982
  if (storeptr)
    *storeptr = Qnil;

  if (complete_filename_p (str))
    absolute = 1;

983
  for (; CONSP (path); path = XCDR (path))
Jim Blandy's avatar
Jim Blandy committed
984
    {
985
      filename = Fexpand_file_name (str, XCAR (path));
Jim Blandy's avatar
Jim Blandy committed
986 987 988 989 990 991 992 993 994 995 996 997 998
      if (!complete_filename_p (filename))
	/* If there are non-absolute elts in PATH (eg ".") */
	/* Of course, this could conceivably lose if luser sets
	   default-directory to be something non-absolute... */
	{
	  filename = Fexpand_file_name (filename, current_buffer->directory);
	  if (!complete_filename_p (filename))
	    /* Give up on this path element! */
	    continue;
	}

      /* Calculate maximum size of any filename made from
	 this path element/specified file name and any possible suffix.  */
999
      want_size = max_suffix_len + STRING_BYTES (XSTRING (filename)) + 1;
Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002 1003
      if (fn_size < want_size)
	fn = (char *) alloca (fn_size = 100 + want_size);

      /* Loop over suffixes.  */
1004 1005
      for (tail = NILP (suffixes) ? default_suffixes : suffixes;
	   CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
1006
	{
1007
	  int lsuffix = STRING_BYTES (XSTRING (XCAR (tail)));
1008
	  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
1009

1010 1011 1012 1013 1014 1015 1016
	  /* Concatenate path element/specified name with the suffix.
	     If the directory starts with /:, remove that.  */
	  if (XSTRING (filename)->size > 2
	      && XSTRING (filename)->data[0] == '/'
	      && XSTRING (filename)->data[1] == ':')
	    {
	      strncpy (fn, XSTRING (filename)->data + 2,
1017 1018
		       STRING_BYTES (XSTRING (filename)) - 2);
	      fn[STRING_BYTES (XSTRING (filename)) - 2] = 0;