lread.c 101 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp parsing and input streams.
Dave Love's avatar
Dave Love committed
2
   Copyright (C) 1985, 86, 87, 88, 89, 93, 94, 95, 97, 98, 99, 2000, 01, 02
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"
Kenichi Handa's avatar
Kenichi Handa committed
32
#include "character.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"
Jim Blandy's avatar
Jim Blandy committed
38 39 40 41 42

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

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

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

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

#include <math.h>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static Lisp_Object Vloads_in_progress;

185 186 187 188 189 190 191 192 193 194 195 196 197 198
/* 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;

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
      int pt_byte = BUF_PT_BYTE (inbuffer);
223

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

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

235 236
      readchar_backlog = -1;

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

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

257
      int bytepos = marker_byte_position (readcharfun);
258

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

267 268
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
269

270 271
      readchar_backlog = -1;

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

285 286 287 288
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

      return c;
Jim Blandy's avatar
Jim Blandy committed
289
    }
290 291 292 293

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

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

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

Jim Blandy's avatar
Jim Blandy committed
317 318 319 320 321
      return c;
    }

  tem = call0 (readcharfun);

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

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

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

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

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

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

397 398
extern Lisp_Object read_char ();

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

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

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

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

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

437
  if (BUFFERP (val))
438 439
    goto retry;

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

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

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

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

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

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

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


555

556 557 558 559 560 561 562 563 564 565 566 567
/* 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;
Dave Love's avatar
Dave Love committed
568
  int safe_p = 1, version = 0;
569 570 571 572 573 574 575 576 577

  /* 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'
Dave Love's avatar
Dave Love committed
578
	 with NUL bytes following it, but note the version.  */
579
      for (i = 0; i < nbytes && buf[i] != '\n'; ++i)
Dave Love's avatar
Dave Love committed
580 581
	if (i == 4)
          version = buf[i];
582 583 584 585 586 587

      if (i < nbytes
	  && fast_c_string_match_ignore_case (Vbytecomp_version_regexp,
					      buf + i) < 0)
	safe_p = 0;
    }
Dave Love's avatar
Dave Love committed
588 589
  if (safe_p)
    safe_p = version;
590 591 592 593 594 595

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


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


607
DEFUN ("load", Fload, Sload, 1, 5, 0,
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
       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)
624
     Lisp_Object file, noerror, nomessage, nosuffix, must_suffix;
Jim Blandy's avatar
Jim Blandy committed
625 626 627 628 629 630 631 632
{
  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;
633 634 635 636
  /* 1 means we printed the ".el is newer" message.  */
  int newer = 0;
  /* 1 means we are loading a compiled file.  */
  int compiled = 0;
637
  Lisp_Object handler;
638
  int safe_p = 1;
639
  char *fmode = "r";
640
#ifdef DOS_NT
641
  fmode = "rt";
642
#endif /* DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
643

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

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

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

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

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

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

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

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

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

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

724 725 726 727 728 729 730 731 732 733
  /* 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.  */
734 735 736 737 738 739 740 741 742 743 744 745
  {
    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);
  }
746

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

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

770 771
	  compiled = 1;

Dave Love's avatar
Dave Love committed
772 773 774 775 776 777 778 779 780 781 782 783
	  if (version == 20)	/* 21 isn't used */
	    /* We're loading something compiled with Mule 3, 4 or 5,
	       and thus potentially emacs-mule-encoded; load it with
	       code conversion.  (Perhaps the test should actually be
	       <22?)  We could check further on whether the comment
	       mentions multibyte and only code-convert if it does.  I
	       doubt it's worth the effort. -- fx  */
	    {
	      Lisp_Object val;

	      if (fd >= 0)
		emacs_close (fd);
784 785 786 787 788
	      /* load-with-code-conversion currently fails with
		 emacs-mule non-ASCII doc strings.  */
	      error ("Can't currently load Emacs 20/1-compiled files: %s",
		     XSTRING (found)->data);
#if 0
Dave Love's avatar
Dave Love committed
789 790 791
	      val = call4 (intern ("load-with-code-conversion"), found, file,
			   NILP (noerror) ? Qnil : Qt,
			   NILP (nomessage) ? Qnil : Qt);
792
#endif
Dave Love's avatar
Dave Love committed
793 794 795
	      return unbind_to (count, val);
	    }

Dave Love's avatar
Dave Love committed
796
#ifdef DOS_NT
797
	  fmode = "rb";
Dave Love's avatar
Dave Love committed
798
#endif /* DOS_NT */
799 800 801 802 803 804 805
	  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;
806

807 808 809 810 811 812
	      /* 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';
813
	}
Jim Blandy's avatar
Jim Blandy committed
814
    }
Karl Heuer's avatar
Karl Heuer committed
815 816 817 818 819
  else
    {
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
820
	  Lisp_Object val;
821 822

	  if (fd >= 0)
823
	    emacs_close (fd);
824 825 826 827
	  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
828 829
	}
    }
Jim Blandy's avatar
Jim Blandy committed
830

831
#ifdef WINDOWSNT
832
  emacs_close (fd);
833 834 835 836
  stream = fopen ((char *) XSTRING (found)->data, fmode);
#else  /* not WINDOWSNT */
  stream = fdopen (fd, fmode);
#endif /* not WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
837 838
  if (stream == 0)
    {
839
      emacs_close (fd);
840
      error ("Failure to create stdio stream for %s", XSTRING (file)->data);
Jim Blandy's avatar
Jim Blandy committed
841 842
    }

843 844 845
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

846 847
  if (NILP (nomessage))
    {
848 849 850 851
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
		 file, 1);
      else if (!compiled)
852
	message_with_string ("Loading %s (source)...", file, 1);
853
      else if (newer)
854 855
	message_with_string ("Loading %s (compiled; note, source file is newer)...",
		 file, 1);
856
      else /* The typical case; compiled file newer than source file.  */
857
	message_with_string ("Loading %s...", file, 1);
858
    }
Jim Blandy's avatar
Jim Blandy committed
859

860
  GCPRO1 (file);
861
  lispstream = Fcons (Qnil, Qnil);
862 863
  XSETCARFASTINT (lispstream, (EMACS_UINT)stream >> 16);
  XSETCDRFASTINT (lispstream, (EMACS_UINT)stream & 0xffff);
Jim Blandy's avatar
Jim Blandy committed
864
  record_unwind_protect (load_unwind, lispstream);
865
  record_unwind_protect (load_descriptor_unwind, load_descriptor_list);
866
  specbind (Qload_file_name, found);
867
  specbind (Qinhibit_file_name_operation, Qnil);
868 869
  load_descriptor_list
    = Fcons (make_number (fileno (stream)), load_descriptor_list);
Jim Blandy's avatar
Jim Blandy committed
870
  load_in_progress++;
871
  readevalloop (Qget_file_char, stream, file, Feval, 0, Qnil, Qnil);
Jim Blandy's avatar
Jim Blandy committed
872 873 874
  unbind_to (count, Qnil);

  /* Run any load-hooks for this file.  */
875
  temp = Fassoc (file, Vafter_load_alist);
Jim Blandy's avatar
Jim Blandy committed
876
  if (!NILP (temp))
Jim Blandy's avatar
Jim Blandy committed
877 878 879
    Fprogn (Fcdr (temp));
  UNGCPRO;

880 881 882 883 884
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

885
  if (prev_saved_doc_string)
886
    xfree (prev_saved_doc_string);
887 888 889
  prev_saved_doc_string = 0;
  prev_saved_doc_string_size = 0;

Jim Blandy's avatar
Jim Blandy committed
890
  if (!noninteractive && NILP (nomessage))
891
    {
892 893 894 895
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
		 file, 1);
      else if (!compiled)
896
	message_with_string ("Loading %s (source)...done", file, 1);
897
      else if (newer)
898 899
	message_with_string ("Loading %s (compiled; note, source file is newer)...done",
		 file, 1);
900
      else /* The typical case; compiled file newer than source file.  */
901
	message_with_string ("Loading %s...done", file, 1);
902
    }
903

Jim Blandy's avatar
Jim Blandy committed
904 905 906 907 908 909 910
  return Qt;
}

static Lisp_Object
load_unwind (stream)  /* used as unwind-protect function in load */
     Lisp_Object stream;
{
911 912
  fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
		    | XFASTINT (XCDR (stream))));
Jim Blandy's avatar
Jim Blandy committed
913 914 915 916
  if (--load_in_progress < 0) load_in_progress = 0;
  return Qnil;
}

917 918 919 920 921
static Lisp_Object
load_descriptor_unwind (oldlist)
     Lisp_Object oldlist;
{
  load_descriptor_list = oldlist;
922
  return Qnil;
923 924 925 926 927 928 929 930
}

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

void
close_load_descs ()
{
931
#ifndef WINDOWSNT
932
  Lisp_Object tail;
933
  for (tail = load_descriptor_list; !NILP (tail); tail = XCDR (tail))
934
    emacs_close (XFASTINT (XCAR (tail)));
935
#endif
936
}
Jim Blandy's avatar
Jim Blandy committed
937 938 939 940 941 942

static int
complete_filename_p (pathname)
     Lisp_Object pathname;
{
  register unsigned char *s = XSTRING (pathname)->data;
943 944 945
  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
946 947 948 949 950 951 952 953 954 955 956 957 958
#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.

959 960 961
   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
962 963 964 965 966 967
   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.
968 969
   nil is stored there on failure.

970
   If the file we find is remote, return -2
971 972
   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
973 974

int
975
openp (path, str, suffixes, storeptr, exec_only)
Jim Blandy's avatar
Jim Blandy committed
976
     Lisp_Object path, str;
977
     Lisp_Object suffixes;
Jim Blandy's avatar
Jim Blandy committed
978 979 980 981 982 983 984 985 986
     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;
987
  Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
988
  struct stat st;
989 990 991 992 993 994
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
  Lisp_Object string, tail;
  int max_suffix_len = 0;

  for (tail = suffixes; CONSP (tail); tail = XCDR (tail))
    {
995
      CHECK_STRING_CAR (tail);
996
      max_suffix_len = max (max_suffix_len,
997
			    STRING_BYTES (XSTRING (XCAR (tail))));
998
    }
Jim Blandy's avatar
Jim Blandy committed
999

1000 1001 1002
  string = filename = Qnil;
  GCPRO5 (str, string, filename, path, suffixes);
  
Jim Blandy's avatar
Jim Blandy committed
1003 1004 1005 1006 1007 1008
  if (storeptr)
    *storeptr = Qnil;

  if (complete_filename_p (str))
    absolute = 1;

1009
  for (; CONSP (path); path = XCDR (path))
Jim Blandy's avatar
Jim Blandy committed
1010
    {
1011
      filename = Fexpand_file_name (str, XCAR (path));
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
      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.  */
1025
      want_size = max_suffix_len + STRING_BYTES (XSTRING (filename)) + 1;
Jim Blandy's avatar
Jim Blandy committed
1026 1027 1028 1029
      if (fn_size < want_size)
	fn = (char *) alloca (fn_size = 100 + want_size);

      /* Loop over suffixes.  */
1030 1031
      for (tail = NILP (suffixes) ? default_suffixes : suffixes;
	   CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
1032
	{
1033
	  int lsuffix = STRING_BYTES (XSTRING (XCAR (tail)));
1034
	  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
1035

1036 1037 1038 1039 1040 1041 1042
	  /* 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,
1043 1044
		       STRING_BYTES (XSTRING (filename)) - 2);
	      fn[STRING_BYTES (XSTRING (filename)) - 2] = 0;
1045 1046 1047
	    }
	  else
	    {
1048 1049 1050
	      strncpy (fn, XSTRING (filename)->data,
		       STRING_BYTES (XSTRING (filename)));
	      fn[STRING_BYTES (XSTRING (filename))] = 0;
1051 1052
	    }

Jim Blandy's avatar
Jim Blandy committed
1053
	  if (lsuffix != 0)  /* Bug happens on CCI if lsuffix is 0.  */
1054 1055
	    strncat (fn, XSTRING (XCAR (tail))->data, lsuffix);
	  
Richard M. Stallman's avatar