lread.c 107 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, 01, 2003
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"
37
#include "coding.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 */

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

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

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

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

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

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

95 96 97
/* Directory in which the sources were found.  */
Lisp_Object Vsource_directory;

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

Karl Heuer's avatar
Karl Heuer committed
101 102 103
/* File name of user's init file.  */
Lisp_Object Vuser_init_file;

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

108
/* This is used to build the load history. */
109 110
Lisp_Object Vcurrent_load_list;

111 112 113
/* List of files that were preloaded.  */
Lisp_Object Vpreloaded_file_list;

114 115 116
/* Name of file actually being read by `load'.  */
Lisp_Object Vload_file_name;

117 118 119
/* Function to use for reading, in `load' and friends.  */
Lisp_Object Vload_read_function;

120 121 122 123 124 125
/* 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;

126 127 128
/* Nonzero means load should forcibly load all dynamic doc strings.  */
static int load_force_doc_strings;

129 130 131
/* Nonzero means read should convert strings to unibyte.  */
static int load_convert_to_unibyte;

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

136 137 138
/* List of all DEFVAR_BOOL variables.  Used by the byte optimizer.  */
Lisp_Object Vbyte_boolean_vars;

139 140 141 142 143 144 145
/* Whether or not to add a `read-positions' property to symbols
   read. */
Lisp_Object Vread_with_symbol_positions;

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

146 147 148
/* List of descriptors now open for Fload.  */
static Lisp_Object load_descriptor_list;

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

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

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

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

167
/* This contains the last string skipped with #@.  */
168 169 170 171 172 173
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.  */
174
static file_offset saved_doc_string_position;
175

176 177 178 179 180 181 182 183 184
/* 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.  */
185
static file_offset prev_saved_doc_string_position;
186

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

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

static Lisp_Object Vloads_in_progress;

198 199 200 201 202 203 204 205
/* 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
206
static void to_multibyte P_ ((char **, char **, int *));
207
static void readevalloop P_ ((Lisp_Object, FILE*, Lisp_Object,
208 209 210 211 212
			      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
213 214 215

/* Handle unreading and rereading of characters.
   Write READCHAR to read a character,
Karl Heuer's avatar
Karl Heuer committed
216 217
   UNREAD(c) to unread c to be read again.

218 219 220
   The READCHAR and UNREAD macros are meant for reading/unreading a
   byte code; they do not handle multibyte characters.  The caller
   should manage them if necessary.
221

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

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

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

238
  readchar_count++;
239

240
  if (BUFFERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
241
    {
242
      register struct buffer *inbuffer = XBUFFER (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
243

244 245
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
246

247 248 249 250 251 252 253 254
      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);

255 256
      if (pt_byte >= BUF_ZV_BYTE (inbuffer))
	return -1;
Jim Blandy's avatar
Jim Blandy committed
257

258 259
      readchar_backlog = -1;

260 261
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
262
	  /* Fetch the character code from the buffer.  */
263 264 265 266 267 268 269 270
	  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++;
271
	}
272
      SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
273

274
      return c;
Jim Blandy's avatar
Jim Blandy committed
275
    }
276
  if (MARKERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
277
    {
278
      register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
279

280 281
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
282

283 284 285 286 287 288 289 290
      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);

291 292
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
293

294 295
      readchar_backlog = -1;

296 297
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
298
	  /* Fetch the character code from the buffer.  */
299 300 301 302 303 304 305 306
	  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++;
307 308
	}

309 310 311 312
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

      return c;
Jim Blandy's avatar
Jim Blandy committed
313
    }
314 315 316 317

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

Jim Blandy's avatar
Jim Blandy committed
318
  if (EQ (readcharfun, Qget_file_char))
319 320 321 322 323 324 325 326 327 328 329 330
    {
      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
331

332
  if (STRINGP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
333
    {
334
      if (read_from_string_index >= read_from_string_limit)
Jim Blandy's avatar
Jim Blandy committed
335
	c = -1;
336
      else
337 338 339
	FETCH_STRING_CHAR_ADVANCE (c, readcharfun,
				   read_from_string_index,
				   read_from_string_index_byte);
340

Jim Blandy's avatar
Jim Blandy committed
341 342 343 344 345
      return c;
    }

  tem = call0 (readcharfun);

Jim Blandy's avatar
Jim Blandy committed
346
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
347 348 349 350 351 352 353 354 355 356 357 358
    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;
{
359
  readchar_count--;
360 361 362 363
  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.  */
    ;
364
  else if (BUFFERP (readcharfun))
365
    {
366 367
      struct buffer *b = XBUFFER (readcharfun);
      int bytepos = BUF_PT_BYTE (b);
368

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

379 380
	  BUF_PT_BYTE (b) = bytepos;
	}
381
    }
382
  else if (MARKERP (readcharfun))
383
    {
384 385
      struct buffer *b = XMARKER (readcharfun)->buffer;
      int bytepos = XMARKER (readcharfun)->bytepos;
386

387 388
      if (readchar_backlog >= 0)
	readchar_backlog++;
389
      else
390 391 392 393 394 395
	{
	  XMARKER (readcharfun)->charpos--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
396

397 398
	  XMARKER (readcharfun)->bytepos = bytepos;
	}
399
    }
400
  else if (STRINGP (readcharfun))
401 402 403 404 405
    {
      read_from_string_index--;
      read_from_string_index_byte
	= string_char_to_byte (readcharfun, read_from_string_index);
    }
406 407
  else if (EQ (readcharfun, Qlambda))
    read_bytecode_char (1);
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411 412 413
  else if (EQ (readcharfun, Qget_file_char))
    ungetc (c, instream);
  else
    call1 (readcharfun, make_number (c));
}

414 415 416
static Lisp_Object read_internal_start P_ ((Lisp_Object, Lisp_Object,
					    Lisp_Object));
static Lisp_Object read0 P_ ((Lisp_Object));
417
static Lisp_Object read1 P_ ((Lisp_Object, int *, int));
418 419 420 421 422 423 424 425 426 427

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

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

Jim Blandy's avatar
Jim Blandy committed
429

430
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
431

432 433
extern Lisp_Object read_char ();

434 435 436 437 438 439 440 441 442 443 444 445 446
/* 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
447 448 449 450
   character.

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

452
Lisp_Object
453 454 455
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
456
{
457 458
  register Lisp_Object val, delayed_switch_frame;

459
#ifdef HAVE_WINDOW_SYSTEM
460 461
  if (display_hourglass_p)
    cancel_hourglass ();
462
#endif
463

464
  delayed_switch_frame = Qnil;
465 466 467

  /* Read until we get an acceptable event.  */
 retry:
468 469 470
  val = read_char (0, 0, 0,
		   (input_method ? Qnil : Qt),
		   0);
471

472
  if (BUFFERP (val))
473 474
    goto retry;

475
  /* switch-frame events are put off until after the next ASCII
Karl Heuer's avatar
Karl Heuer committed
476
     character.  This is better than signaling an error just because
477 478 479 480 481 482 483 484 485 486 487 488 489 490
     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.  */
491
      if (SYMBOLP (val))
492
	{
493
	  Lisp_Object tem, tem1;
494 495 496 497 498 499 500
	  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))
501
		XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
502 503
	    }
	}
504

505
      /* If we don't have a character now, deal with it appropriately.  */
506
      if (!INTEGERP (val))
507 508 509
	{
	  if (error_nonascii)
	    {
510
	      Vunread_command_events = Fcons (val, Qnil);
511 512 513 514 515 516 517 518 519 520
	      error ("Non-character input-event");
	    }
	  else
	    goto retry;
	}
    }

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

521 522
#if 0

523
#ifdef HAVE_WINDOW_SYSTEM
524 525
  if (display_hourglass_p)
    start_hourglass ();
526
#endif
527 528 529

#endif

530 531 532
  return val;
}

533
DEFUN ("read-char", Fread_char, Sread_char, 0, 2, 0,
534 535 536 537 538 539 540 541 542 543 544 545 546 547
       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)
548
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
549
{
550 551
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
552
  return read_filtered_event (1, 1, 1, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
553 554
}

555
DEFUN ("read-event", Fread_event, Sread_event, 0, 2, 0,
556 557 558 559 560 561
       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)
562
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
563
{
564 565
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
566
  return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
567 568
}

569
DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 2, 0,
570 571 572 573 574 575 576 577
       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)
578
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
579
{
580 581
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
582
  return read_filtered_event (1, 1, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
583 584 585
}

DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
586 587
       doc: /* Don't use this yourself.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
588 589
{
  register Lisp_Object val;
590
  XSETINT (val, getc (instream));
Jim Blandy's avatar
Jim Blandy committed
591 592
  return val;
}
593 594


595

596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
/* 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;
}


633 634 635 636 637 638 639 640 641 642
/* 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;
}

643 644 645 646 647 648 649 650
/* This handler function is used via internal_condition_case_1.  */

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

652
DEFUN ("load", Fload, Sload, 1, 5, 0,
653 654
       doc: /* Execute a file of Lisp code named FILE.
First try FILE with `.elc' appended, then try with `.el',
Markus Rost's avatar
Markus Rost committed
655 656
 then try FILE unmodified (the exact suffixes are determined by
`load-suffixes').  Environment variable references in FILE
657 658 659 660 661 662 663 664 665 666 667 668 669
 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)
670
     Lisp_Object file, noerror, nomessage, nosuffix, must_suffix;
Jim Blandy's avatar
Jim Blandy committed
671 672 673 674
{
  register FILE *stream;
  register int fd = -1;
  register Lisp_Object lispstream;
Juanma Barranquero's avatar
Juanma Barranquero committed
675
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
676 677
  Lisp_Object temp;
  struct gcpro gcpro1;
678
  Lisp_Object found, efound;
679 680 681 682
  /* 1 means we printed the ".el is newer" message.  */
  int newer = 0;
  /* 1 means we are loading a compiled file.  */
  int compiled = 0;
683
  Lisp_Object handler;
684
  int safe_p = 1;
685
  char *fmode = "r";
686
#ifdef DOS_NT
687
  fmode = "rt";
688
#endif /* DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
689

690
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
691

692
  /* If file name is magic, call the handler.  */
693 694 695 696
  /* 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); */
697

698 699
  /* Do this after the handler to avoid
     the need to gcpro noerror, nomessage and nosuffix.
700 701 702 703 704 705
     (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.  */
706 707 708 709 710 711 712 713 714
  if (! NILP (noerror))
    {
      file = internal_condition_case_1 (Fsubstitute_in_file_name, file,
					Qt, load_error_handler);
      if (NILP (file))
	return Qnil;
    }
  else
    file = Fsubstitute_in_file_name (file);
715

716

Jim Blandy's avatar
Jim Blandy committed
717 718
  /* Avoid weird lossage with null string as arg,
     since it would try to load a directory as a Lisp file */
719
  if (SCHARS (file) > 0)
Jim Blandy's avatar
Jim Blandy committed
720
    {
721
      int size = SBYTES (file);
722
      Lisp_Object tmp[2];
723

724
      GCPRO1 (file);
725 726 727 728 729

      if (! NILP (must_suffix))
	{
	  /* Don't insist on adding a suffix if FILE already ends with one.  */
	  if (size > 3
730
	      && !strcmp (SDATA (file) + size - 3, ".el"))
731 732
	    must_suffix = Qnil;
	  else if (size > 4
733
		   && !strcmp (SDATA (file) + size - 4, ".elc"))
734 735 736 737 738 739 740
	    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;
	}

741
      fd = openp (Vload_path, file,
742 743 744 745 746
		  (!NILP (nosuffix) ? Qnil
		   : !NILP (must_suffix) ? Vload_suffixes
		   : Fappend (2, (tmp[0] = Vload_suffixes,
				  tmp[1] = default_suffixes,
				  tmp))),
747
		  &found, Qnil);
748
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
749 750
    }

751
  if (fd == -1)
Jim Blandy's avatar
Jim Blandy committed
752
    {
Jim Blandy's avatar
Jim Blandy committed
753
      if (NILP (noerror))
754 755
	Fsignal (Qfile_error, Fcons (build_string ("Cannot open load file"),
				     Fcons (file, Qnil)));
Jim Blandy's avatar
Jim Blandy committed
756 757 758 759
      else
	return Qnil;
    }

760
  /* Tell startup.el whether or not we found the user's init file.  */
Karl Heuer's avatar
Karl Heuer committed
761 762 763
  if (EQ (Qt, Vuser_init_file))
    Vuser_init_file = found;

764 765
  /* If FD is -2, that means openp found a magic file.  */
  if (fd == -2)
766
    {
767 768 769 770 771 772 773 774 775
      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);
776 777
    }

778 779 780 781 782 783 784 785 786 787
  /* 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.  */
788 789 790 791 792 793 794 795 796 797 798 799
  {
    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);
  }
800

801
  if (!bcmp (SDATA (found) + SBYTES (found) - 4,
802 803 804
	     ".elc", 4))
    /* Load .elc files directly, but not when they are
       remote and have no handler!  */
Jim Blandy's avatar
Jim Blandy committed
805
    {
806
      if (fd != -2)
807
	{
808 809
	  struct stat s1, s2;
	  int result;
810

811 812 813 814
	  if (!safe_to_load_p (fd))
	    {
	      safe_p = 0;
	      if (!load_dangerous_libraries)
815 816 817 818 819 820
		{
		  if (fd >= 0)
		    emacs_close (fd);
		  error ("File `%s' was not compiled in Emacs",
			 SDATA (found));
		}
821 822 823
	      else if (!NILP (nomessage))
		message_with_string ("File `%s' not compiled in Emacs", found, 1);
	    }
824

825 826
	  compiled = 1;

827 828 829
	  GCPRO1 (efound);
	  efound = ENCODE_FILE (found);

Dave Love's avatar
Dave Love committed
830
#ifdef DOS_NT
831
	  fmode = "rb";
Dave Love's avatar
Dave Love committed
832
#endif /* DOS_NT */
833
	  stat ((char *)SDATA (efound), &s1);
834
	  SSET (efound, SBYTES (efound) - 1, 0);
835
	  result = stat ((char *)SDATA (efound), &s2);
836
	  SSET (efound, SBYTES (efound) - 1, 'c');
837 838
	  UNGCPRO;

839 840 841 842
	  if (result >= 0 && (unsigned) s1.st_mtime < (unsigned) s2.st_mtime)
	    {
	      /* Make the progress messages mention that source is newer.  */
	      newer = 1;
843

844
	      /* If we won't print another message, mention this anyway.  */
845 846 847 848 849
	      if (!NILP (nomessage))
		{
		  Lisp_Object file;
		  file = Fsubstring (found, make_number (0), make_number (-1));
		  message_with_string ("Source file `%s' newer than byte-compiled file",
850
				       file, 1);
851
		}
852
	    }
853
	}
Jim Blandy's avatar
Jim Blandy committed
854
    }
Karl Heuer's avatar
Karl Heuer committed
855 856 857 858 859
  else
    {
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
860
	  Lisp_Object val;
861 862

	  if (fd >= 0)
863
	    emacs_close (fd);
864 865 866 867
	  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
868 869
	}
    }
Jim Blandy's avatar
Jim Blandy committed
870

871
#ifdef WINDOWSNT
872
  emacs_close (fd);
873 874
  GCPRO1 (efound);
  efound = ENCODE_FILE (found);
875
  stream = fopen ((char *) SDATA (efound), fmode);
876
  UNGCPRO;
877 878 879
#else  /* not WINDOWSNT */
  stream = fdopen (fd, fmode);
#endif /* not WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
880 881
  if (stream == 0)
    {
882
      emacs_close (fd);
883
      error ("Failure to create stdio stream for %s", SDATA (file));
Jim Blandy's avatar
Jim Blandy committed
884 885
    }

886 887 888
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

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

903
  GCPRO1 (file);
904
  lispstream = Fcons (Qnil, Qnil);
905 906
  XSETCARFASTINT (lispstream, (EMACS_UINT)stream >> 16);
  XSETCDRFASTINT (lispstream, (EMACS_UINT)stream & 0xffff);
Jim Blandy's avatar
Jim Blandy committed
907
  record_unwind_protect (load_unwind, lispstream);
908
  record_unwind_protect (load_descriptor_unwind, load_descriptor_list);
909
  specbind (Qload_file_name, found);
910
  specbind (Qinhibit_file_name_operation, Qnil);
911 912
  load_descriptor_list
    = Fcons (make_number (fileno (stream)), load_descriptor_list);
Jim Blandy's avatar
Jim Blandy committed
913
  load_in_progress++;
914
  readevalloop (Qget_file_char, stream, file, Feval, 0, Qnil, Qnil);
Jim Blandy's avatar
Jim Blandy committed
915 916 917
  unbind_to (count, Qnil);

  /* Run any load-hooks for this file.  */
918
  temp = Fassoc (file, Vafter_load_alist);
Jim Blandy's avatar
Jim Blandy committed
919
  if (!NILP (temp))
Jim Blandy's avatar
Jim Blandy committed
920 921 922
    Fprogn (Fcdr (temp));
  UNGCPRO;

923 924 925 926 927
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

928
  if (prev_saved_doc_string)
929
    xfree (prev_saved_doc_string);
930 931 932
  prev_saved_doc_string = 0;
  prev_saved_doc_string_size = 0;

Jim Blandy's avatar
Jim Blandy committed
933
  if (!noninteractive && NILP (nomessage))
934
    {
935 936 937 938
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
		 file, 1);
      else if (!compiled)
939
	message_with_string ("Loading %s (source)...done", file, 1);
940
      else if (newer)
941 942
	message_with_string ("Loading %s (compiled; note, source file is newer)...done",
		 file, 1);
943
      else /* The typical case; compiled file newer than source file.  */
944
	message_with_string ("Loading %s...done", file, 1);
945
    }
946

947 948 949 950 951
  if (!NILP (Fequal (build_string ("obsolete"),
		     Ffile_name_nondirectory
		     (Fdirectory_file_name (Ffile_name_directory (found))))))
    message_with_string ("Package %s is obsolete", file, 1);

Jim Blandy's avatar
Jim Blandy committed
952 953 954 955 956 957 958
  return Qt;
}

static Lisp_Object
load_unwind (stream)  /* used as unwind-protect function in load */
     Lisp_Object stream;
{
959 960
  fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
		    | XFASTINT (XCDR (stream))));
Jim Blandy's avatar
Jim Blandy committed
961 962 963 964
  if (--load_in_progress < 0) load_in_progress = 0;
  return Qnil;
}

965 966 967 968 969
static Lisp_Object
load_descriptor_unwind (oldlist)
     Lisp_Object oldlist;
{
  load_descriptor_list = oldlist;
970
  return Qnil;
971 972 973 974 975 976 977 978
}

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

void
close_load_descs ()
{
979
#ifndef WINDOWSNT
980
  Lisp_Object tail;
981
  for (tail = load_descriptor_list; !NILP (tail); tail = XCDR (tail))
982
    emacs_close (XFASTINT (XCAR (tail)));
983
#endif
984
}
Jim Blandy's avatar
Jim Blandy committed
985 986 987 988 989

static int
complete_filename_p (pathname)
     Lisp_Object pathname;
{
990
  register const unsigned char *s = SDATA (pathname);
991
  return (IS_DIRECTORY_SEP (s[0])
992
	  || (SCHARS (pathname) > 2
993
	      && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2]))
Jim Blandy's avatar
Jim Blandy committed
994 995 996 997 998 999 1000 1001 1002
#ifdef ALTOS
	  || *s == '@'
#endif
#ifdef VMS
	  || index (s, ':')
#endif /* VMS */
	  );
}

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
DEFUN ("locate-file-internal", Flocate_file_internal, Slocate_file_internal, 2, 4, 0,
       doc: /* Search for FILENAME through PATH.
If SUFFIXES is non-nil, it should be a list of suffixes to append to
file name when searching.
If non-nil, PREDICATE is used instead of `file-readable-p'.
PREDICATE can also be an integer to pass to the access(2) function,
in which case file-name-handlers are ignored.  */)
     (filename, path, suffixes, predicate)
     Lisp_Object filename, path, suffixes, predicate;
{
  Lisp_Object file;
  int fd = openp (path, filename, suffixes, &file, predicate);
  if (NILP (predicate) && fd > 0)
    close (fd);
  return file;
}


Jim Blandy's avatar
Jim Blandy committed
1021 1022 1023 1024
/* 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.

1025 1026 1027
   SUFFIXES is a list of strings containing possible suffixes.
   The empty suffix is automatically added iff the list is empty.

1028 1029 1030 1031 1032
   PREDICATE non-nil means don't open the files,
   just look for one that satisfies the predicate.  In this case,
   returns 1 on success.  The predicate can be a lisp function or
   an integer to pass to `access' (in which case file-name-handlers
   are ignored).
Jim Blandy's avatar
Jim Blandy committed
1033 1034 1035

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

1038
   If the file we find is remote, return -2
1039
   but store the found remote file name in *STOREPTR.  */
Jim Blandy's avatar
Jim Blandy committed
1040 1041

int