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
/* 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
192
static void to_multibyte P_ ((char **, char **, int *));
193 194 195 196 197 198
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
199 200 201

/* Handle unreading and rereading of characters.
   Write READCHAR to read a character,
Karl Heuer's avatar
Karl Heuer committed
202 203 204 205 206
   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
207 208 209 210 211 212 213 214 215

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

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

218
  if (BUFFERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
219
    {
220
      register struct buffer *inbuffer = XBUFFER (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
221

222 223
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
224

225 226 227 228 229 230 231 232
      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);

233 234
      if (pt_byte >= BUF_ZV_BYTE (inbuffer))
	return -1;
Jim Blandy's avatar
Jim Blandy committed
235

236 237
      readchar_backlog = -1;

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

252
      return c;
Jim Blandy's avatar
Jim Blandy committed
253
    }
254
  if (MARKERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
255
    {
256
      register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
257

258 259
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
260

261 262 263 264 265 266 267 268
      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);

269 270
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
271

272 273
      readchar_backlog = -1;

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

287 288 289 290
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

      return c;
Jim Blandy's avatar
Jim Blandy committed
291
    }
292 293 294 295

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

Jim Blandy's avatar
Jim Blandy committed
296
  if (EQ (readcharfun, Qget_file_char))
297 298 299 300 301 302 303 304 305 306 307 308
    {
      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
309

310
  if (STRINGP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
311
    {
312
      if (read_from_string_index >= read_from_string_limit)
Jim Blandy's avatar
Jim Blandy committed
313
	c = -1;
314
      else
315 316 317
	FETCH_STRING_CHAR_ADVANCE (c, readcharfun,
				   read_from_string_index,
				   read_from_string_index_byte);
318

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

  tem = call0 (readcharfun);

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

346 347
      if (readchar_backlog >= 0)
	readchar_backlog++;
348
      else
349 350 351 352 353 354
	{
	  BUF_PT (b)--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
355

356 357
	  BUF_PT_BYTE (b) = bytepos;
	}
358
    }
359
  else if (MARKERP (readcharfun))
360
    {
361 362
      struct buffer *b = XMARKER (readcharfun)->buffer;
      int bytepos = XMARKER (readcharfun)->bytepos;
363

364 365
      if (readchar_backlog >= 0)
	readchar_backlog++;
366
      else
367 368 369 370 371 372
	{
	  XMARKER (readcharfun)->charpos--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
373

374 375
	  XMARKER (readcharfun)->bytepos = bytepos;
	}
376
    }
377
  else if (STRINGP (readcharfun))
378 379 380 381 382
    {
      read_from_string_index--;
      read_from_string_index_byte
	= string_char_to_byte (readcharfun, read_from_string_index);
    }
383 384
  else if (EQ (readcharfun, Qlambda))
    read_bytecode_char (1);
Jim Blandy's avatar
Jim Blandy committed
385 386 387 388 389 390 391
  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 ();
392
static int read_multibyte ();
393 394 395
static Lisp_Object substitute_object_recurse ();
static void        substitute_object_in_subtree (), substitute_in_interval ();

Jim Blandy's avatar
Jim Blandy committed
396

397
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
398

399 400
extern Lisp_Object read_char ();

401 402 403 404 405 406 407 408 409 410 411 412 413
/* 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
414 415 416 417
   character.

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

419
Lisp_Object
420 421 422
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
423
{
424 425
  register Lisp_Object val, delayed_switch_frame;

426
#ifdef HAVE_WINDOW_SYSTEM
427 428
  if (display_hourglass_p)
    cancel_hourglass ();
429 430
#endif
  
431
  delayed_switch_frame = Qnil;
432 433 434

  /* Read until we get an acceptable event.  */
 retry:
435 436 437
  val = read_char (0, 0, 0,
		   (input_method ? Qnil : Qt),
		   0);
438

439
  if (BUFFERP (val))
440 441
    goto retry;

442
  /* switch-frame events are put off until after the next ASCII
Karl Heuer's avatar
Karl Heuer committed
443
     character.  This is better than signaling an error just because
444 445 446 447 448 449 450 451 452 453 454 455 456 457
     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.  */
458
      if (SYMBOLP (val))
459
	{
460
	  Lisp_Object tem, tem1;
461 462 463 464 465 466 467
	  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))
468
		XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
469 470 471 472
	    }
	}
	  
      /* If we don't have a character now, deal with it appropriately.  */
473
      if (!INTEGERP (val))
474 475 476
	{
	  if (error_nonascii)
	    {
477
	      Vunread_command_events = Fcons (val, Qnil);
478 479 480 481 482 483 484 485 486 487
	      error ("Non-character input-event");
	    }
	  else
	    goto retry;
	}
    }

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

488
#ifdef HAVE_WINDOW_SYSTEM
489 490
  if (display_hourglass_p)
    start_hourglass ();
491
#endif
492 493 494
  return val;
}

495
DEFUN ("read-char", Fread_char, Sread_char, 0, 2, 0,
496 497 498 499 500 501 502 503 504 505 506 507 508 509
       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)
510
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
511
{
512 513
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
514
  return read_filtered_event (1, 1, 1, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
515 516
}

517
DEFUN ("read-event", Fread_event, Sread_event, 0, 2, 0,
518 519 520 521 522 523
       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)
524
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
525
{
526 527
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
528
  return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
529 530
}

531
DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 2, 0,
532 533 534 535 536 537 538 539
       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)
540
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
541
{
542 543
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
544
  return read_filtered_event (1, 1, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
545 546 547
}

DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
548 549
       doc: /* Don't use this yourself.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
550 551
{
  register Lisp_Object val;
552
  XSETINT (val, getc (instream));
Jim Blandy's avatar
Jim Blandy committed
553 554
  return val;
}
555 556


557

558 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
/* 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;
}


595 596 597 598 599 600 601 602 603 604 605
/* 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;
}


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

643
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
644

645
  /* If file name is magic, call the handler.  */
646 647 648 649
  /* 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); */
650

651 652
  /* Do this after the handler to avoid
     the need to gcpro noerror, nomessage and nosuffix.
653 654 655 656 657 658
     (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.  */
659
  file = Fsubstitute_in_file_name (file);
660

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

668
      GCPRO1 (file);
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684

      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;
	}

685
      fd = openp (Vload_path, file,
686 687 688 689 690
		  (!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
691
		  &found, 0);
692
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
693 694
    }

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

705
  /* Tell startup.el whether or not we found the user's init file.  */
Karl Heuer's avatar
Karl Heuer committed
706 707 708
  if (EQ (Qt, Vuser_init_file))
    Vuser_init_file = found;

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

723 724 725 726 727 728 729 730 731 732
  /* 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.  */
733 734 735 736 737 738 739 740 741 742 743 744
  {
    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)
      Fsignal (Qerror, Fcons (build_string ("Recursive load"),
			      Fcons (found, Vloads_in_progress)));
    record_unwind_protect (record_load_unwind, Vloads_in_progress);
    Vloads_in_progress = Fcons (found, Vloads_in_progress);
  }
745

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

756 757 758 759 760 761 762 763 764
	  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);
	    }
765

766 767
	  compiled = 1;

Dave Love's avatar
Dave Love committed
768
#ifdef DOS_NT
769
	  fmode = "rb";
Dave Love's avatar
Dave Love committed
770
#endif /* DOS_NT */
771 772 773 774 775 776 777
	  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;
778

779 780 781 782 783 784
	      /* 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';
785
	}
Jim Blandy's avatar
Jim Blandy committed
786
    }
Karl Heuer's avatar
Karl Heuer committed
787 788 789 790 791
  else
    {
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
792
	  Lisp_Object val;
793 794

	  if (fd >= 0)
795
	    emacs_close (fd);
796 797 798 799
	  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
800 801
	}
    }
Jim Blandy's avatar
Jim Blandy committed
802

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

815 816 817
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

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

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

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

852 853 854 855 856
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

857
  if (prev_saved_doc_string)
858
    xfree (prev_saved_doc_string);
859 860 861
  prev_saved_doc_string = 0;
  prev_saved_doc_string_size = 0;

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

Jim Blandy's avatar
Jim Blandy committed
876 877 878 879 880 881 882
  return Qt;
}

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

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

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

void
close_load_descs ()
{
903
#ifndef WINDOWSNT
904
  Lisp_Object tail;
905
  for (tail = load_descriptor_list; !NILP (tail); tail = XCDR (tail))
906
    emacs_close (XFASTINT (XCAR (tail)));
907
#endif
908
}
Jim Blandy's avatar
Jim Blandy committed
909 910 911 912 913 914

static int
complete_filename_p (pathname)
     Lisp_Object pathname;
{
  register unsigned char *s = XSTRING (pathname)->data;
915 916 917
  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
918 919 920 921 922 923 924 925 926 927 928 929 930
#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.

931 932 933
   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
934 935 936 937 938 939
   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.
940 941
   nil is stored there on failure.

942
   If the file we find is remote, return -2
943 944
   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
945 946

int
947
openp (path, str, suffixes, storeptr, exec_only)
Jim Blandy's avatar
Jim Blandy committed
948
     Lisp_Object path, str;
949
     Lisp_Object suffixes;
Jim Blandy's avatar
Jim Blandy committed
950 951 952 953 954 955 956 957 958
     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;
959
  Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
960
  struct stat st;
961 962 963 964 965 966
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
  Lisp_Object string, tail;
  int max_suffix_len = 0;

  for (tail = suffixes; CONSP (tail); tail = XCDR (tail))
    {
967
      CHECK_STRING_CAR (tail);
968
      max_suffix_len = max (max_suffix_len,
969
			    STRING_BYTES (XSTRING (XCAR (tail))));
970
    }
Jim Blandy's avatar
Jim Blandy committed
971

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

  if (complete_filename_p (str))
    absolute = 1;

981
  for (; CONSP (path); path = XCDR (path))
Jim Blandy's avatar
Jim Blandy committed
982
    {
983
      filename = Fexpand_file_name (str, XCAR (path));
Jim Blandy's avatar
Jim Blandy committed
984 985 986 987 988 989 990 991 992 993 994 995 996
      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.  */
997
      want_size = max_suffix_len + STRING_BYTES (XSTRING (filename)) + 1;
Jim Blandy's avatar
Jim Blandy committed
998 999 1000 1001
      if (fn_size < want_size)
	fn = (char *) alloca (fn_size = 100 + want_size);

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

1008 1009 1010 1011 1012 1013 1014
	  /* 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,
1015 1016
		       STRING_BYTES (XSTRING (filename)) - 2);
	      fn[STRING_BYTES (XSTRING (filename)) - 2] = 0;
1017 1018 1019
	    }
	  else
	    {
1020 1021 1022
	      strncpy (fn, XSTRING (filename)->data,
		       STRING_BYTES (XSTRING (filename)));
	      fn[STRING_BYTES (XSTRING (filename))] = 0;
1023 1024
	    }

Jim Blandy's avatar
Jim Blandy committed
1025
	  if (lsuffix != 0)  /* Bug happens on CCI if lsuffix is 0.  */
1026 1027
	    strncat (fn, XSTRING (XCAR (tail))->data, lsuffix);
	  
1028
	  /* Check that the file exists and is not a directory.  */
1029 1030 1031 1032 1033 1034 1035 1036 1037
	  /* We used to only check for handlers on non-absolute file names:
	        if (absolute)
	          handler = Qnil;
	        else
		  handler = Ffind_file_name_handler (filename, Qfile_exists_p);
	     It's not clear why that was the case and it breaks things like
	     (load "/bar.el") where the file is actually "/bar.el.gz".  */
	  handler = Ffind_file_name_handler (filename, Qfile_exists_p);
	  if (!NILP (handler) && !exec_only)
Jim Blandy's avatar
Jim Blandy committed
1038
	    {
1039
	      int exists;
Jim Blandy's avatar
Jim Blandy committed
1040

1041
	      string = build_string (fn);
1042 1043
	      exists = !NILP (Ffile_readable_p (string));
	      if (exists && !NILP (Ffile_directory_p (build_string (fn))))
1044 1045 1046
		exists = 0;

	      if (exists)
Jim Blandy's avatar
Jim Blandy committed
1047 1048 1049 1050
		{
		  /* We succeeded; return this descriptor and filename.  */
		  if (storeptr)
		    *storeptr = build_string (fn);
1051
		  UNGCPRO;
1052
		  return -2;
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
		}
	    }
	  else
	    {
	      int exists = (stat (fn, &st) >= 0
			    && (st.st_mode & S_IFMT) != S_IFDIR);
	      if (exists)
		{
		  /* Check that we can access or open it.  */
		  if (exec_only)
		    fd = (access (fn, X_OK) == 0) ? 1 : -1;
		  else