lread.c 95.5 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, 1999
3
      Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

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

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

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


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 68 69 70 71 72 73 74
#ifdef HAVE_FTELLO
#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;

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

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;
Jim Blandy's avatar
Jim Blandy committed
178 179 180

/* Handle unreading and rereading of characters.
   Write READCHAR to read a character,
Karl Heuer's avatar
Karl Heuer committed
181 182 183 184 185
   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
186 187 188 189 190 191 192 193 194

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

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

197
  if (BUFFERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
198
    {
199
      register struct buffer *inbuffer = XBUFFER (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
200

201 202
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
203

204 205 206 207 208 209 210 211
      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);

212 213
      if (pt_byte >= BUF_ZV_BYTE (inbuffer))
	return -1;
Jim Blandy's avatar
Jim Blandy committed
214

215 216
      readchar_backlog = -1;

217 218
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
219
	  /* Fetch the character code from the buffer.  */
220 221 222 223 224 225 226 227
	  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++;
228
	}
229
      SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
230

231
      return c;
Jim Blandy's avatar
Jim Blandy committed
232
    }
233
  if (MARKERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
234
    {
235
      register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
236

237 238
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
239

240 241 242 243 244 245 246 247
      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);

248 249
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
250

251 252
      readchar_backlog = -1;

253 254
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
255
	  /* Fetch the character code from the buffer.  */
256 257 258 259 260 261 262 263
	  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++;
264 265
	}

266 267 268 269
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

      return c;
Jim Blandy's avatar
Jim Blandy committed
270
    }
271 272 273 274

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

Jim Blandy's avatar
Jim Blandy committed
275
  if (EQ (readcharfun, Qget_file_char))
276 277 278 279 280 281 282 283 284 285 286 287
    {
      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
288

289
  if (STRINGP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
290
    {
291
      if (read_from_string_index >= read_from_string_limit)
Jim Blandy's avatar
Jim Blandy committed
292
	c = -1;
293
      else
294 295 296
	FETCH_STRING_CHAR_ADVANCE (c, readcharfun,
				   read_from_string_index,
				   read_from_string_index_byte);
297

Jim Blandy's avatar
Jim Blandy committed
298 299 300 301 302
      return c;
    }

  tem = call0 (readcharfun);

Jim Blandy's avatar
Jim Blandy committed
303
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
304 305 306 307 308 309 310 311 312 313 314 315
    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;
{
316 317 318 319
  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.  */
    ;
320
  else if (BUFFERP (readcharfun))
321
    {
322 323
      struct buffer *b = XBUFFER (readcharfun);
      int bytepos = BUF_PT_BYTE (b);
324

325 326
      if (readchar_backlog >= 0)
	readchar_backlog++;
327
      else
328 329 330 331 332 333
	{
	  BUF_PT (b)--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
334

335 336
	  BUF_PT_BYTE (b) = bytepos;
	}
337
    }
338
  else if (MARKERP (readcharfun))
339
    {
340 341
      struct buffer *b = XMARKER (readcharfun)->buffer;
      int bytepos = XMARKER (readcharfun)->bytepos;
342

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

353 354
	  XMARKER (readcharfun)->bytepos = bytepos;
	}
355
    }
356
  else if (STRINGP (readcharfun))
357 358 359 360 361
    {
      read_from_string_index--;
      read_from_string_index_byte
	= string_char_to_byte (readcharfun, read_from_string_index);
    }
362 363
  else if (EQ (readcharfun, Qlambda))
    read_bytecode_char (1);
Jim Blandy's avatar
Jim Blandy committed
364 365 366 367 368 369 370
  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 ();
371
static int read_multibyte ();
372 373 374
static Lisp_Object substitute_object_recurse ();
static void        substitute_object_in_subtree (), substitute_in_interval ();

Jim Blandy's avatar
Jim Blandy committed
375

376
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
377

378 379
extern Lisp_Object read_char ();

380 381 382 383 384 385 386 387 388 389 390 391 392
/* 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
393 394 395 396
   character.

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

398
Lisp_Object
399 400 401
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
402
{
403 404
  register Lisp_Object val, delayed_switch_frame;

405 406 407 408 409
#ifdef HAVE_WINDOW_SYSTEM
  if (display_busy_cursor_p)
    cancel_busy_cursor ();
#endif
  
410
  delayed_switch_frame = Qnil;
411 412 413

  /* Read until we get an acceptable event.  */
 retry:
414 415 416
  val = read_char (0, 0, 0,
		   (input_method ? Qnil : Qt),
		   0);
417

418
  if (BUFFERP (val))
419 420
    goto retry;

421
  /* switch-frame events are put off until after the next ASCII
Karl Heuer's avatar
Karl Heuer committed
422
     character.  This is better than signaling an error just because
423 424 425 426 427 428 429 430 431 432 433 434 435 436
     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.  */
437
      if (SYMBOLP (val))
438
	{
439
	  Lisp_Object tem, tem1;
440 441 442 443 444 445 446
	  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))
447
		XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
448 449 450 451
	    }
	}
	  
      /* If we don't have a character now, deal with it appropriately.  */
452
      if (!INTEGERP (val))
453 454 455
	{
	  if (error_nonascii)
	    {
456
	      Vunread_command_events = Fcons (val, Qnil);
457 458 459 460 461 462 463 464 465 466
	      error ("Non-character input-event");
	    }
	  else
	    goto retry;
	}
    }

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

467 468 469 470
#ifdef HAVE_WINDOW_SYSTEM
  if (display_busy_cursor_p)
    start_busy_cursor ();
#endif
471 472 473
  return val;
}

474
DEFUN ("read-char", Fread_char, Sread_char, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
475
  "Read a character from the command input (keyboard or macro).\n\
Jim Blandy's avatar
Jim Blandy committed
476 477
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
478 479 480 481
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\
482 483 484
`read-event' or `read-char-exclusive' instead.\n\
\n\
If the optional argument PROMPT is non-nil, display that as a prompt.\n\
485 486 487 488 489
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
490
{
491 492
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
493
  return read_filtered_event (1, 1, 1, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
494 495
}

496 497 498
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\
499 500 501 502 503
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
504
{
505 506
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
507
  return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
508 509
}

510
DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
511
  "Read a character from the command input (keyboard or macro).\n\
512 513 514
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\
515 516 517 518 519
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
520
{
521 522
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
523
  return read_filtered_event (1, 1, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
524 525 526 527 528 529 530
}

DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
  "Don't use this yourself.")
  ()
{
  register Lisp_Object val;
531
  XSETINT (val, getc (instream));
Jim Blandy's avatar
Jim Blandy committed
532 533 534
  return val;
}

535 536 537 538 539
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
540

541 542 543 544 545 546 547 548 549 550 551 552 553 554 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
/* 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;


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


587
DEFUN ("load", Fload, Sload, 1, 5, 0,
Jim Blandy's avatar
Jim Blandy committed
588 589 590 591 592 593 594 595 596 597
  "Execute a file of Lisp code named FILE.\n\
First try FILE with `.elc' appended, then try with `.el',\n\
 then try FILE unmodified.\n\
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\
598
If optional fifth arg MUST-SUFFIX is non-nil, insist on\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
599
 the suffix `.elc' or `.el'; don't accept just FILE unless\n\
600
 it ends in one of those suffixes or includes a directory name.\n\
Jim Blandy's avatar
Jim Blandy committed
601
Return t if file exists.")
602 603
  (file, noerror, nomessage, nosuffix, must_suffix)
     Lisp_Object file, noerror, nomessage, nosuffix, must_suffix;
Jim Blandy's avatar
Jim Blandy committed
604 605 606 607 608 609 610 611
{
  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;
612 613 614 615
  /* 1 means we printed the ".el is newer" message.  */
  int newer = 0;
  /* 1 means we are loading a compiled file.  */
  int compiled = 0;
616
  Lisp_Object handler;
617
  int safe_p = 1;
618
  char *fmode = "r";
619
#ifdef DOS_NT
620
  fmode = "rt";
621
#endif /* DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
622

623
  CHECK_STRING (file, 0);
Jim Blandy's avatar
Jim Blandy committed
624

625
  /* If file name is magic, call the handler.  */
626
  handler = Ffind_file_name_handler (file, Qload);
627
  if (!NILP (handler))
628
    return call5 (handler, Qload, file, noerror, nomessage, nosuffix);
629

630 631 632
  /* Do this after the handler to avoid
     the need to gcpro noerror, nomessage and nosuffix.
     (Below here, we care only whether they are nil or not.)  */
633
  file = Fsubstitute_in_file_name (file);
634

Jim Blandy's avatar
Jim Blandy committed
635 636
  /* Avoid weird lossage with null string as arg,
     since it would try to load a directory as a Lisp file */
637
  if (XSTRING (file)->size > 0)
Jim Blandy's avatar
Jim Blandy committed
638
    {
639
      int size = STRING_BYTES (XSTRING (file));
640

641
      GCPRO1 (file);
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657

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

658 659
      fd = openp (Vload_path, file,
		  (!NILP (nosuffix) ? ""
660 661
		   : ! NILP (must_suffix) ? ".elc.gz:.elc:.el.gz:.el"
		   : ".elc:.elc.gz:.el.gz:.el:"),
Jim Blandy's avatar
Jim Blandy committed
662
		  &found, 0);
663
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
664 665 666 667
    }

  if (fd < 0)
    {
Jim Blandy's avatar
Jim Blandy committed
668
      if (NILP (noerror))
Jim Blandy's avatar
Jim Blandy committed
669 670
	while (1)
	  Fsignal (Qfile_error, Fcons (build_string ("Cannot open load file"),
671
				       Fcons (file, Qnil)));
Jim Blandy's avatar
Jim Blandy committed
672 673 674 675
      else
	return Qnil;
    }

676
  /* Tell startup.el whether or not we found the user's init file.  */
Karl Heuer's avatar
Karl Heuer committed
677 678 679
  if (EQ (Qt, Vuser_init_file))
    Vuser_init_file = found;

680
  /* If FD is 0, that means openp found a magic file.  */
681 682
  if (fd == 0)
    {
683 684 685 686 687 688 689 690 691
      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);
692 693
    }

694 695
  /* Load .elc files directly, but not when they are
     remote and have no handler!  */
696
  if (!bcmp (&(XSTRING (found)->data[STRING_BYTES (XSTRING (found)) - 4]),
697 698
	     ".elc", 4)
      && fd != 0)
Jim Blandy's avatar
Jim Blandy committed
699 700 701 702
    {
      struct stat s1, s2;
      int result;

703 704 705 706 707 708 709 710 711 712
      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);
	}

713 714
      compiled = 1;

715
#ifdef DOS_NT
716
      fmode = "rb";
717
#endif /* DOS_NT */
718
      stat ((char *)XSTRING (found)->data, &s1);
719
      XSTRING (found)->data[STRING_BYTES (XSTRING (found)) - 1] = 0;
720
      result = stat ((char *)XSTRING (found)->data, &s2);
Jim Blandy's avatar
Jim Blandy committed
721
      if (result >= 0 && (unsigned) s1.st_mtime < (unsigned) s2.st_mtime)
722
	{
723 724 725 726 727
	  /* Make the progress messages mention that source is newer.  */
	  newer = 1;

	  /* If we won't print another message, mention this anyway.  */
	  if (! NILP (nomessage))
728 729
	    message_with_string ("Source file `%s' newer than byte-compiled file",
				 found, 1);
730
	}
731
      XSTRING (found)->data[STRING_BYTES (XSTRING (found)) - 1] = 'c';
Jim Blandy's avatar
Jim Blandy committed
732
    }
Karl Heuer's avatar
Karl Heuer committed
733 734
  else
    {
735 736
    load_source:

Karl Heuer's avatar
Karl Heuer committed
737 738 739
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
740
	  if (fd != 0)
741
	    emacs_close (fd);
742
	  return call4 (Vload_source_file_function, found, file,
Karl Heuer's avatar
Karl Heuer committed
743 744 745 746
			NILP (noerror) ? Qnil : Qt,
			NILP (nomessage) ? Qnil : Qt);
	}
    }
Jim Blandy's avatar
Jim Blandy committed
747

748
#ifdef WINDOWSNT
749
  emacs_close (fd);
750 751 752 753
  stream = fopen ((char *) XSTRING (found)->data, fmode);
#else  /* not WINDOWSNT */
  stream = fdopen (fd, fmode);
#endif /* not WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
754 755
  if (stream == 0)
    {
756
      emacs_close (fd);
757
      error ("Failure to create stdio stream for %s", XSTRING (file)->data);
Jim Blandy's avatar
Jim Blandy committed
758 759
    }

760 761 762
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

763 764
  if (NILP (nomessage))
    {
765 766 767 768
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
		 file, 1);
      else if (!compiled)
769
	message_with_string ("Loading %s (source)...", file, 1);
770
      else if (newer)
771 772
	message_with_string ("Loading %s (compiled; note, source file is newer)...",
		 file, 1);
773
      else /* The typical case; compiled file newer than source file.  */
774
	message_with_string ("Loading %s...", file, 1);
775
    }
Jim Blandy's avatar
Jim Blandy committed
776

777
  GCPRO1 (file);
778
  lispstream = Fcons (Qnil, Qnil);
779 780
  XSETFASTINT (XCAR (lispstream), (EMACS_UINT)stream >> 16);
  XSETFASTINT (XCDR (lispstream), (EMACS_UINT)stream & 0xffff);
Jim Blandy's avatar
Jim Blandy committed
781
  record_unwind_protect (load_unwind, lispstream);
782
  record_unwind_protect (load_descriptor_unwind, load_descriptor_list);
783
  specbind (Qload_file_name, found);
784
  specbind (Qinhibit_file_name_operation, Qnil);
785 786
  load_descriptor_list
    = Fcons (make_number (fileno (stream)), load_descriptor_list);
Jim Blandy's avatar
Jim Blandy committed
787
  load_in_progress++;
788
  readevalloop (Qget_file_char, stream, file, Feval, 0, Qnil, Qnil);
Jim Blandy's avatar
Jim Blandy committed
789 790 791
  unbind_to (count, Qnil);

  /* Run any load-hooks for this file.  */
792
  temp = Fassoc (file, Vafter_load_alist);
Jim Blandy's avatar
Jim Blandy committed
793
  if (!NILP (temp))
Jim Blandy's avatar
Jim Blandy committed
794 795 796
    Fprogn (Fcdr (temp));
  UNGCPRO;

797 798 799 800 801
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

802
  if (prev_saved_doc_string)
803
    xfree (prev_saved_doc_string);
804 805 806
  prev_saved_doc_string = 0;
  prev_saved_doc_string_size = 0;

Jim Blandy's avatar
Jim Blandy committed
807
  if (!noninteractive && NILP (nomessage))
808
    {
809 810 811 812
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
		 file, 1);
      else if (!compiled)
813
	message_with_string ("Loading %s (source)...done", file, 1);
814
      else if (newer)
815 816
	message_with_string ("Loading %s (compiled; note, source file is newer)...done",
		 file, 1);
817
      else /* The typical case; compiled file newer than source file.  */
818
	message_with_string ("Loading %s...done", file, 1);
819
    }
Jim Blandy's avatar
Jim Blandy committed
820 821 822 823 824 825 826
  return Qt;
}

static Lisp_Object
load_unwind (stream)  /* used as unwind-protect function in load */
     Lisp_Object stream;
{
827 828
  fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
		    | XFASTINT (XCDR (stream))));
Jim Blandy's avatar
Jim Blandy committed
829 830 831 832
  if (--load_in_progress < 0) load_in_progress = 0;
  return Qnil;
}

833 834 835 836 837
static Lisp_Object
load_descriptor_unwind (oldlist)
     Lisp_Object oldlist;
{
  load_descriptor_list = oldlist;
838
  return Qnil;
839 840 841 842 843 844 845 846
}

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

void
close_load_descs ()
{
847
#ifndef WINDOWSNT
848
  Lisp_Object tail;
849
  for (tail = load_descriptor_list; !NILP (tail); tail = XCDR (tail))
850
    emacs_close (XFASTINT (XCAR (tail)));
851
#endif
852
}
Jim Blandy's avatar
Jim Blandy committed
853 854 855 856 857 858

static int
complete_filename_p (pathname)
     Lisp_Object pathname;
{
  register unsigned char *s = XSTRING (pathname)->data;
859 860 861
  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
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
#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.
   SUFFIX is a string containing possible suffixes separated by colons.
   On success, returns a file descriptor.  On failure, returns -1.

   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.
882 883 884 885 886
   nil is stored there on failure.

   If the file we find is remote, return 0
   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
887 888 889 890 891 892 893 894 895 896 897 898 899 900

int
openp (path, str, suffix, storeptr, exec_only)
     Lisp_Object path, str;
     char *suffix;
     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;
901
  Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
902
  struct stat st;
903
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
904

905
  GCPRO1 (str);
Jim Blandy's avatar
Jim Blandy committed
906 907 908 909 910 911
  if (storeptr)
    *storeptr = Qnil;

  if (complete_filename_p (str))
    absolute = 1;

Jim Blandy's avatar
Jim Blandy committed
912
  for (; !NILP (path); path = Fcdr (path))
Jim Blandy's avatar
Jim Blandy committed
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
    {
      char *nsuffix;

      filename = Fexpand_file_name (str, Fcar (path));
      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.  */
930
      want_size = strlen (suffix) + STRING_BYTES (XSTRING (filename)) + 1;
Jim Blandy's avatar
Jim Blandy committed
931 932 933 934 935 936 937 938 939 940
      if (fn_size < want_size)
	fn = (char *) alloca (fn_size = 100 + want_size);

      nsuffix = suffix;

      /* Loop over suffixes.  */
      while (1)
	{
	  char *esuffix = (char *) index (nsuffix, ':');
	  int lsuffix = esuffix ? esuffix - nsuffix : strlen (nsuffix);
941
	  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
942

943 944 945 946 947 948 949
	  /* 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,
950 951
		       STRING_BYTES (XSTRING (filename)) - 2);
	      fn[STRING_BYTES (XSTRING (filename)) - 2] = 0;
952 953 954
	    }
	  else
	    {
955 956 957
	      strncpy (fn, XSTRING (filename)->data,
		       STRING_BYTES (XSTRING (filename)));
	      fn[STRING_BYTES (XSTRING (filename))] = 0;
958 959
	    }

Jim Blandy's avatar
Jim Blandy committed
960 961 962
	  if (lsuffix != 0)  /* Bug happens on CCI if lsuffix is 0.  */
	    strncat (fn, nsuffix, lsuffix);

963 964 965 966 967 968
	  /* Check that the file exists and is not a directory.  */
	  if (absolute)
	    handler = Qnil;
	  else
	    handler = Ffind_file_name_handler (filename, Qfile_exists_p);
	  if (! NILP (handler) && ! exec_only)
Jim Blandy's avatar
Jim Blandy committed
969
	    {
970 971
	      Lisp_Object string;
	      int exists;
Jim Blandy's avatar
Jim Blandy committed
972

973 974 975 976 977 978 979 980
	      string = build_string (fn);
	      exists = ! NILP (exec_only ? Ffile_executable_p (string)
			       : Ffile_readable_p (string));
	      if (exists
		  && ! NILP (Ffile_directory_p (build_string (fn))))
		exists = 0;

	      if (exists)
Jim Blandy's avatar
Jim Blandy committed
981 982 983 984
		{
		  /* We succeeded; return this descriptor and filename.  */
		  if (storeptr)
		    *storeptr = build_string (fn);
985
		  UNGCPRO;
986 987 988 989 990 991 992 993 994 995 996 997 998
		  return 0;
		}
	    }
	  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
Paul Eggert's avatar