lread.c 106 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp parsing and input streams.
2
   Copyright (C) 1985, 86, 87, 88, 89, 93, 94, 95, 97, 98, 99, 2000, 2001
3
      Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

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

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

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


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

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 139 140 141 142
/* 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;

143 144 145
/* List of descriptors now open for Fload.  */
static Lisp_Object load_descriptor_list;

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

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

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

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

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

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

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

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

static Lisp_Object Vloads_in_progress;

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

215 216 217 218 219 220 221 222
   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.
   
   [ 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
223
 */
Jim Blandy's avatar
Jim Blandy committed
224 225 226 227 228 229 230 231 232

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

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

235 236
  readchar_count++;
  
237
  if (BUFFERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
238
    {
239
      register struct buffer *inbuffer = XBUFFER (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
240

241 242
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
243

244 245 246 247 248 249 250 251
      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);

252 253
      if (pt_byte >= BUF_ZV_BYTE (inbuffer))
	return -1;
Jim Blandy's avatar
Jim Blandy committed
254

255 256
      readchar_backlog = -1;

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

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

277 278
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
279

280 281 282 283 284 285 286 287
      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);

288 289
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
290

291 292
      readchar_backlog = -1;

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

306 307 308 309
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

      return c;
Jim Blandy's avatar
Jim Blandy committed
310
    }
311 312 313 314

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

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

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

Jim Blandy's avatar
Jim Blandy committed
338 339 340 341 342
      return c;
    }

  tem = call0 (readcharfun);

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

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

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

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

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

411 412 413 414 415 416 417 418 419 420 421 422 423 424
static Lisp_Object read_internal_start P_ ((Lisp_Object, Lisp_Object,
					    Lisp_Object));
static Lisp_Object read0 P_ ((Lisp_Object));
static Lisp_Object read1 P_ ((Lisp_Object, int *, int)); 

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));
425

Jim Blandy's avatar
Jim Blandy committed
426

427
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
428

429 430
extern Lisp_Object read_char ();

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

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

449
Lisp_Object
450 451 452
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
453
{
454 455
  register Lisp_Object val, delayed_switch_frame;

456
#ifdef HAVE_WINDOW_SYSTEM
457 458
  if (display_hourglass_p)
    cancel_hourglass ();
459 460
#endif
  
461
  delayed_switch_frame = Qnil;
462 463 464

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

469
  if (BUFFERP (val))
470 471
    goto retry;

472
  /* switch-frame events are put off until after the next ASCII
Karl Heuer's avatar
Karl Heuer committed
473
     character.  This is better than signaling an error just because
474 475 476 477 478 479 480 481 482 483 484 485 486 487
     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.  */
488
      if (SYMBOLP (val))
489
	{
490
	  Lisp_Object tem, tem1;
491 492 493 494 495 496 497
	  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))
498
		XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
499 500 501 502
	    }
	}
	  
      /* If we don't have a character now, deal with it appropriately.  */
503
      if (!INTEGERP (val))
504 505 506
	{
	  if (error_nonascii)
	    {
507
	      Vunread_command_events = Fcons (val, Qnil);
508 509 510 511 512 513 514 515 516 517
	      error ("Non-character input-event");
	    }
	  else
	    goto retry;
	}
    }

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

518 519
#if 0

520
#ifdef HAVE_WINDOW_SYSTEM
521 522
  if (display_hourglass_p)
    start_hourglass ();
523
#endif
524 525 526

#endif

527 528 529
  return val;
}

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

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

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

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


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


630 631 632 633 634 635 636 637 638 639
/* 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;
}

640 641 642 643 644 645 646 647
/* This handler function is used via internal_condition_case_1.  */

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

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

687
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
688

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

695 696
  /* Do this after the handler to avoid
     the need to gcpro noerror, nomessage and nosuffix.
697 698 699 700 701 702
     (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.  */
703 704 705 706 707 708 709 710 711 712
  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);
    
713

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

721
      GCPRO1 (file);
722 723 724 725 726

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

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

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

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

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

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

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

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

822 823
	  compiled = 1;

824 825 826
	  GCPRO1 (efound);
	  efound = ENCODE_FILE (found);

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

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

841
	      /* If we won't print another message, mention this anyway.  */
842 843 844 845 846
	      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",
847
				       file, STRING_MULTIBYTE (file));
848
		}
849
	    }
850
	}
Jim Blandy's avatar
Jim Blandy committed
851
    }
Karl Heuer's avatar
Karl Heuer committed
852 853 854 855 856
  else
    {
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
857
	  Lisp_Object val;
858 859

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

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

883 884 885
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

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

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

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

920 921 922 923 924
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

925
  if (prev_saved_doc_string)
926
    xfree (prev_saved_doc_string);
927 928 929
  prev_saved_doc_string = 0;
  prev_saved_doc_string_size = 0;

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

Jim Blandy's avatar
Jim Blandy committed
944 945 946 947 948 949 950
  return Qt;
}

static Lisp_Object
load_unwind (stream)  /* used as unwind-protect function in load */
     Lisp_Object stream;
{
951 952
  fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
		    | XFASTINT (XCDR (stream))));
Jim Blandy's avatar
Jim Blandy committed
953 954 955 956
  if (--load_in_progress < 0) load_in_progress = 0;
  return Qnil;
}

957 958 959 960 961
static Lisp_Object
load_descriptor_unwind (oldlist)
     Lisp_Object oldlist;
{
  load_descriptor_list = oldlist;
962
  return Qnil;
963 964 965 966 967 968 969 970
}

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

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

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
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
1013 1014 1015 1016
/* 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.

1017 1018 1019
   SUFFIXES is a list of strings containing possible suffixes.
   The empty suffix is automatically added iff the list is empty.

1020 1021 1022 1023 1024
   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
1025 1026 1027

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

1030
   If the file we find is remote, return -2
1031
   but store the found remote file name in *STOREPTR.  */
Jim Blandy's avatar
Jim Blandy committed
1032 1033

int
1034
openp (path, str, suffixes, storeptr, predicate)
Jim Blandy's avatar
Jim Blandy committed
1035
     Lisp_Object path, str;
1036
     Lisp_Object suffixes;
Jim Blandy's avatar
Jim Blandy committed
1037
     Lisp_Object *storeptr;
1038
     Lisp_Object predicate;
Jim Blandy's avatar
Jim Blandy committed
1039 1040 1041 1042 1043 1044 1045
{
  register int fd;
  int fn_size = 100;
  char buf[100];
  register char *fn = buf;
  int absolute = 0;
  int want_size;
1046
  Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
1047
  struct stat st;
1048 1049
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
  Lisp_Object string, tail, encoded_fn;