lread.c 111 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp parsing and input streams.
2 3 4
   Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
                 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
                 2005 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22 23


Richard M. Stallman's avatar
Richard M. Stallman committed
24
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
25 26 27 28
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/file.h>
29
#include <errno.h>
30
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
31
#include "lisp.h"
32
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
33
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
34
#include "charset.h"
35
#include <epaths.h>
Jim Blandy's avatar
Jim Blandy committed
36
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
37
#include "keyboard.h"
38
#include "frame.h"
39
#include "termhooks.h"
40
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
41 42 43 44 45

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

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

Andreas Schwab's avatar
Andreas Schwab committed
53 54 55 56
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
57 58 59 60 61 62
#ifndef X_OK
#define X_OK 01
#endif

#include <math.h>

Richard M. Stallman's avatar
Richard M. Stallman committed
63 64 65 66
#ifdef HAVE_SETLOCALE
#include <locale.h>
#endif /* HAVE_SETLOCALE */

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

74
#ifdef HAVE_FSEEKO
75 76 77 78 79 80 81
#define file_offset off_t
#define file_tell ftello
#else
#define file_offset long
#define file_tell ftell
#endif

82
#ifndef USE_CRT_DLL
83
extern int errno;
84
#endif
85

86
Lisp_Object Qread_char, Qget_file_char, Qstandard_input, Qcurrent_load_list;
Jim Blandy's avatar
Jim Blandy committed
87
Lisp_Object Qvariable_documentation, Vvalues, Vstandard_input, Vafter_load_alist;
88
Lisp_Object Qascii_character, Qload, Qload_file_name;
89
Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
90
Lisp_Object Qinhibit_file_name_operation;
91
Lisp_Object Qeval_buffer_list, Veval_buffer_list;
92 93

extern Lisp_Object Qevent_symbol_element_mask;
94
extern Lisp_Object Qfile_exists_p;
Jim Blandy's avatar
Jim Blandy committed
95

Lute Kamstra's avatar
Lute Kamstra committed
96
/* non-zero iff inside `load' */
Jim Blandy's avatar
Jim Blandy committed
97 98
int load_in_progress;

99 100 101
/* Directory in which the sources were found.  */
Lisp_Object Vsource_directory;

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

Karl Heuer's avatar
Karl Heuer committed
105 106 107
/* File name of user's init file.  */
Lisp_Object Vuser_init_file;

108 109 110 111
/* This is the user-visible association list that maps features to
   lists of defs in their load files. */
Lisp_Object Vload_history;

112
/* This is used to build the load history. */
113 114
Lisp_Object Vcurrent_load_list;

115 116 117
/* List of files that were preloaded.  */
Lisp_Object Vpreloaded_file_list;

118 119 120
/* Name of file actually being read by `load'.  */
Lisp_Object Vload_file_name;

121 122 123
/* Function to use for reading, in `load' and friends.  */
Lisp_Object Vload_read_function;

124 125 126 127 128 129
/* 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;

130 131 132
/* Nonzero means load should forcibly load all dynamic doc strings.  */
static int load_force_doc_strings;

133 134 135
/* Nonzero means read should convert strings to unibyte.  */
static int load_convert_to_unibyte;

Karl Heuer's avatar
Karl Heuer committed
136 137 138 139
/* Function to use for loading an Emacs lisp source file (not
   compiled) instead of readevalloop.  */
Lisp_Object Vload_source_file_function;

140 141 142
/* List of all DEFVAR_BOOL variables.  Used by the byte optimizer.  */
Lisp_Object Vbyte_boolean_vars;

143 144 145 146 147 148 149
/* 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;

150 151 152
/* List of descriptors now open for Fload.  */
static Lisp_Object load_descriptor_list;

153
/* File for get_file_char to read from.  Use by load.  */
Jim Blandy's avatar
Jim Blandy committed
154 155 156 157 158
static FILE *instream;

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

159
/* For use within read-from-string (this reader is non-reentrant!!)  */
Jim Blandy's avatar
Jim Blandy committed
160
static int read_from_string_index;
161
static int read_from_string_index_byte;
Jim Blandy's avatar
Jim Blandy committed
162
static int read_from_string_limit;
163

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

171
/* This contains the last string skipped with #@.  */
172 173 174 175 176 177
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.  */
178
static file_offset saved_doc_string_position;
179

180 181 182 183 184 185 186 187 188
/* 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.  */
189
static file_offset prev_saved_doc_string_position;
190

191 192 193 194 195
/* 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;
196 197 198 199

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

Lute Kamstra's avatar
Lute Kamstra committed
200
static Lisp_Object Vloads_in_progress;
201

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

223 224 225
   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.
226

227 228 229 230
   [ 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
231
 */
Jim Blandy's avatar
Jim Blandy committed
232 233 234 235 236 237 238 239 240

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

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

243
  readchar_count++;
244

245
  if (BUFFERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
246
    {
247
      register struct buffer *inbuffer = XBUFFER (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
248

249 250
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
251

252 253 254 255 256 257 258 259
      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);

260 261
      if (pt_byte >= BUF_ZV_BYTE (inbuffer))
	return -1;
Jim Blandy's avatar
Jim Blandy committed
262

263 264
      readchar_backlog = -1;

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

279
      return c;
Jim Blandy's avatar
Jim Blandy committed
280
    }
281
  if (MARKERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
282
    {
283
      register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
284

285 286
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
287

288 289 290 291 292 293 294 295
      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);

296 297
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
298

299 300
      readchar_backlog = -1;

301 302
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
303
	  /* Fetch the character code from the buffer.  */
304 305 306 307 308 309 310 311
	  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++;
312 313
	}

314 315 316 317
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

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

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

Jim Blandy's avatar
Jim Blandy committed
323
  if (EQ (readcharfun, Qget_file_char))
324 325 326 327 328 329
    {
      c = getc (instream);
#ifdef EINTR
      /* Interrupted reads have been observed while reading over the network */
      while (c == EOF && ferror (instream) && errno == EINTR)
	{
330
	  QUIT;
331 332 333 334 335 336
	  clearerr (instream);
	  c = getc (instream);
	}
#endif
      return c;
    }
Jim Blandy's avatar
Jim Blandy committed
337

338
  if (STRINGP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
339
    {
340
      if (read_from_string_index >= read_from_string_limit)
Jim Blandy's avatar
Jim Blandy committed
341
	c = -1;
342
      else
343 344 345
	FETCH_STRING_CHAR_ADVANCE (c, readcharfun,
				   read_from_string_index,
				   read_from_string_index_byte);
346

Jim Blandy's avatar
Jim Blandy committed
347 348 349 350 351
      return c;
    }

  tem = call0 (readcharfun);

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

375 376
      if (readchar_backlog >= 0)
	readchar_backlog++;
377
      else
378 379 380 381 382 383
	{
	  BUF_PT (b)--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
384

385 386
	  BUF_PT_BYTE (b) = bytepos;
	}
387
    }
388
  else if (MARKERP (readcharfun))
389
    {
390 391
      struct buffer *b = XMARKER (readcharfun)->buffer;
      int bytepos = XMARKER (readcharfun)->bytepos;
392

393 394
      if (readchar_backlog >= 0)
	readchar_backlog++;
395
      else
396 397 398 399 400 401
	{
	  XMARKER (readcharfun)->charpos--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
402

403 404
	  XMARKER (readcharfun)->bytepos = bytepos;
	}
405
    }
406
  else if (STRINGP (readcharfun))
407 408 409 410 411
    {
      read_from_string_index--;
      read_from_string_index_byte
	= string_char_to_byte (readcharfun, read_from_string_index);
    }
412 413
  else if (EQ (readcharfun, Qlambda))
    read_bytecode_char (1);
Jim Blandy's avatar
Jim Blandy committed
414 415 416 417 418 419
  else if (EQ (readcharfun, Qget_file_char))
    ungetc (c, instream);
  else
    call1 (readcharfun, make_number (c));
}

420 421 422
static Lisp_Object read_internal_start P_ ((Lisp_Object, Lisp_Object,
					    Lisp_Object));
static Lisp_Object read0 P_ ((Lisp_Object));
423
static Lisp_Object read1 P_ ((Lisp_Object, int *, int));
424 425 426 427 428 429 430 431 432 433

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

Jim Blandy's avatar
Jim Blandy committed
435

436
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
437

438
extern Lisp_Object read_char P_ ((int, int, Lisp_Object *, Lisp_Object, int *, jmp_buf *));
439

440 441 442 443 444 445 446 447 448 449 450 451 452
/* 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
453 454 455 456
   character.

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

458
Lisp_Object
459 460 461
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
462
{
463 464
  volatile register Lisp_Object val, delayed_switch_frame;
  jmp_buf *volatile wrong_kboard_jmpbuf = alloca (sizeof (jmp_buf));
465

466
#ifdef HAVE_WINDOW_SYSTEM
467 468
  if (display_hourglass_p)
    cancel_hourglass ();
469
#endif
470

471
  delayed_switch_frame = Qnil;
472 473 474

  /* Read until we get an acceptable event.  */
 retry:
475 476
  setjmp (*wrong_kboard_jmpbuf);

477 478
  val = read_char (0, 0, 0,
		   (input_method ? Qnil : Qt),
479 480
		   0, wrong_kboard_jmpbuf);
 
481
  if (BUFFERP (val))
482 483
    goto retry;

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

514
      /* If we don't have a character now, deal with it appropriately.  */
515
      if (!INTEGERP (val))
516 517 518
	{
	  if (error_nonascii)
	    {
519
	      Vunread_command_events = Fcons (val, Qnil);
520 521 522 523 524 525 526 527 528 529
	      error ("Non-character input-event");
	    }
	  else
	    goto retry;
	}
    }

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

530 531
#if 0

532
#ifdef HAVE_WINDOW_SYSTEM
533 534
  if (display_hourglass_p)
    start_hourglass ();
535
#endif
536 537 538

#endif

539 540 541
  return val;
}

542
DEFUN ("read-char", Fread_char, Sread_char, 0, 2, 0,
543 544 545 546 547 548 549 550 551 552 553 554 555 556
       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)
557
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
558
{
559 560
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
561
  return read_filtered_event (1, 1, 1, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
562 563
}

564
DEFUN ("read-event", Fread_event, Sread_event, 0, 2, 0,
565 566 567 568 569 570
       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)
571
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
572
{
573 574
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
575
  return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
576 577
}

578
DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 2, 0,
579 580 581 582 583 584 585 586
       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)
587
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
588
{
589 590
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
591
  return read_filtered_event (1, 1, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
592 593 594
}

DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
595 596
       doc: /* Don't use this yourself.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
597 598
{
  register Lisp_Object val;
599
  XSETINT (val, getc (instream));
Jim Blandy's avatar
Jim Blandy committed
600 601
  return val;
}
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 633 634 635 636 637 638 639 640 641
/* 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;
}


642 643 644 645 646 647 648 649 650 651
/* 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;
}

652 653 654 655 656 657 658 659
/* This handler function is used via internal_condition_case_1.  */

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

661
DEFUN ("load", Fload, Sload, 1, 5, 0,
662 663
       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
664 665
 then try FILE unmodified (the exact suffixes are determined by
`load-suffixes').  Environment variable references in FILE
666 667 668 669 670 671 672 673 674 675 676
 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.
677 678 679 680 681

Loading a file records its definitions, and its `provide' and
`require' calls, in an element of `load-history' whose
car is the file name loaded.  See `load-history'.

682 683
Return t if file exists.  */)
     (file, noerror, nomessage, nosuffix, must_suffix)
684
     Lisp_Object file, noerror, nomessage, nosuffix, must_suffix;
Jim Blandy's avatar
Jim Blandy committed
685 686 687
{
  register FILE *stream;
  register int fd = -1;
Juanma Barranquero's avatar
Juanma Barranquero committed
688
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
689
  Lisp_Object temp;
690
  struct gcpro gcpro1, gcpro2;
691
  Lisp_Object found, efound;
692 693 694 695
  /* 1 means we printed the ".el is newer" message.  */
  int newer = 0;
  /* 1 means we are loading a compiled file.  */
  int compiled = 0;
696
  Lisp_Object handler;
697
  int safe_p = 1;
698
  char *fmode = "r";
699
#ifdef DOS_NT
700
  fmode = "rt";
701
#endif /* DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
702

703
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
704

705
  /* If file name is magic, call the handler.  */
706 707 708 709
  /* 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); */
710

711 712
  /* Do this after the handler to avoid
     the need to gcpro noerror, nomessage and nosuffix.
713 714 715 716 717 718
     (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.  */
719 720 721 722 723 724 725 726 727
  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);
728

729

Jim Blandy's avatar
Jim Blandy committed
730 731
  /* Avoid weird lossage with null string as arg,
     since it would try to load a directory as a Lisp file */
732
  if (SCHARS (file) > 0)
Jim Blandy's avatar
Jim Blandy committed
733
    {
734
      int size = SBYTES (file);
735
      Lisp_Object tmp[2];
736

737 738
      found = Qnil;
      GCPRO2 (file, found);
739 740 741 742 743

      if (! NILP (must_suffix))
	{
	  /* Don't insist on adding a suffix if FILE already ends with one.  */
	  if (size > 3
744
	      && !strcmp (SDATA (file) + size - 3, ".el"))
745 746
	    must_suffix = Qnil;
	  else if (size > 4
747
		   && !strcmp (SDATA (file) + size - 4, ".elc"))
748 749 750 751 752 753 754
	    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;
	}

755
      fd = openp (Vload_path, file,
756 757 758 759 760
		  (!NILP (nosuffix) ? Qnil
		   : !NILP (must_suffix) ? Vload_suffixes
		   : Fappend (2, (tmp[0] = Vload_suffixes,
				  tmp[1] = default_suffixes,
				  tmp))),
761
		  &found, Qnil);
762
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
763 764
    }

765
  if (fd == -1)
Jim Blandy's avatar
Jim Blandy committed
766
    {
Jim Blandy's avatar
Jim Blandy committed
767
      if (NILP (noerror))
768 769
	Fsignal (Qfile_error, Fcons (build_string ("Cannot open load file"),
				     Fcons (file, Qnil)));
Jim Blandy's avatar
Jim Blandy committed
770 771 772 773
      else
	return Qnil;
    }

774
  /* Tell startup.el whether or not we found the user's init file.  */
Karl Heuer's avatar
Karl Heuer committed
775 776 777
  if (EQ (Qt, Vuser_init_file))
    Vuser_init_file = found;

778 779
  /* If FD is -2, that means openp found a magic file.  */
  if (fd == -2)
780
    {
781 782 783 784 785 786 787 788 789
      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);
790 791
    }

792 793 794 795 796 797 798 799 800 801
  /* 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.  */
802 803 804 805 806 807 808 809 810 811 812 813
  {
    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);
  }
814

815
  if (!bcmp (SDATA (found) + SBYTES (found) - 4,
816 817 818
	     ".elc", 4))
    /* Load .elc files directly, but not when they are
       remote and have no handler!  */
Jim Blandy's avatar
Jim Blandy committed
819
    {
820
      if (fd != -2)
821
	{
822 823
	  struct stat s1, s2;
	  int result;
824

825 826
	  GCPRO2 (file, found);

827 828 829 830
	  if (!safe_to_load_p (fd))
	    {
	      safe_p = 0;
	      if (!load_dangerous_libraries)
831 832 833 834 835 836
		{
		  if (fd >= 0)
		    emacs_close (fd);
		  error ("File `%s' was not compiled in Emacs",
			 SDATA (found));
		}
837 838 839
	      else if (!NILP (nomessage))
		message_with_string ("File `%s' not compiled in Emacs", found, 1);
	    }
840

841 842
	  compiled = 1;

843 844
	  efound = ENCODE_FILE (found);

Dave Love's avatar
Dave Love committed
845
#ifdef DOS_NT
846
	  fmode = "rb";
Dave Love's avatar
Dave Love committed
847
#endif /* DOS_NT */
848
	  stat ((char *)SDATA (efound), &s1);
849
	  SSET (efound, SBYTES (efound) - 1, 0);
850
	  result = stat ((char *)SDATA (efound), &s2);
851
	  SSET (efound, SBYTES (efound) - 1, 'c');
852

853 854 855 856
	  if (result >= 0 && (unsigned) s1.st_mtime < (unsigned) s2.st_mtime)
	    {
	      /* Make the progress messages mention that source is newer.  */
	      newer = 1;
857

858
	      /* If we won't print another message, mention this anyway.  */
859 860
	      if (!NILP (nomessage))
		{
861 862
		  Lisp_Object msg_file;
		  msg_file = Fsubstring (found, make_number (0), make_number (-1));
863
		  message_with_string ("Source file `%s' newer than byte-compiled file",
864
				       msg_file, 1);
865
		}
866
	    }
867
	  UNGCPRO;
868
	}
Jim Blandy's avatar
Jim Blandy committed
869
    }
Karl Heuer's avatar
Karl Heuer committed
870 871 872 873 874
  else
    {
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
875
	  Lisp_Object val;
876 877

	  if (fd >= 0)
878
	    emacs_close (fd);
879 880 881 882
	  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
883 884
	}
    }
Jim Blandy's avatar
Jim Blandy committed
885

886 887
  GCPRO2 (file, found);

888
#ifdef WINDOWSNT
889
  emacs_close (fd);
890
  efound = ENCODE_FILE (found);
891
  stream = fopen ((char *) SDATA (efound), fmode);
892 893 894
#else  /* not WINDOWSNT */
  stream = fdopen (fd, fmode);
#endif /* not WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
895 896
  if (stream == 0)
    {
897
      emacs_close (fd);
898
      error ("Failure to create stdio stream for %s", SDATA (file));
Jim Blandy's avatar
Jim Blandy committed
899 900
    }

901 902 903
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

904 905
  if (NILP (nomessage))
    {
906 907 908 909
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
		 file, 1);
      else if (!compiled)
910
	message_with_string ("Loading %s (source)...", file, 1);
911
      else if (newer)
912 913
	message_with_string ("Loading %s (compiled; note, source file is newer)...",
		 file, 1);
914
      else /* The typical case; compiled file newer than source file.  */
915
	message_with_string ("Loading %s...", file, 1);
916
    }
Jim Blandy's avatar
Jim Blandy committed
917

918
  record_unwind_protect (load_unwind, make_save_value (stream, 0));
919
  record_unwind_protect (load_descriptor_unwind, load_descriptor_list);
920
  specbind (Qload_file_name, found);
921
  specbind (Qinhibit_file_name_operation, Qnil);
922 923
  load_descriptor_list
    = Fcons (make_number (fileno (stream)), load_descriptor_list);
Jim Blandy's avatar
Jim Blandy committed
924
  load_in_progress++;
925 926
  readevalloop (Qget_file_char, stream, (! NILP (Vpurify_flag) ? file : found),
		Feval, 0, Qnil, Qnil, Qnil, Qnil);
Jim Blandy's avatar
Jim Blandy committed
927 928 929
  unbind_to (count, Qnil);

  /* Run any load-hooks for this file.  */
930
  temp = Fassoc (file, Vafter_load_alist);
Jim Blandy's avatar
Jim Blandy committed
931
  if (!NILP (temp))
Jim Blandy's avatar
Jim Blandy committed
932 933 934
    Fprogn (Fcdr (temp));
  UNGCPRO;

935 936 937 938 939
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

940
  if (prev_saved_doc_string)
941
    xfree (prev_saved_doc_string);
942 943 944
  prev_saved_doc_string = 0;
  prev_saved_doc_string_size = 0;

Jim Blandy's avatar
Jim Blandy committed
945
  if (!noninteractive && NILP (nomessage))
946
    {
947 948 949 950
      if (!safe_p)
	message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
		 file, 1);
      else if (!compiled)
951
	message_with_string ("Loading %s (source)...done", file, 1);
952
      else if (newer)
953 954
	message_with_string ("Loading %s (compiled; note, source file is newer)...done",
		 file, 1);
955
      else /* The typical case; compiled file newer than source file.  */
956
	message_with_string ("Loading %s...done", file, 1);
957
    }
958

959 960 961 962 963
  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
964 965 966 967
  return Qt;
}

static Lisp_Object
968 969
load_unwind (arg)  /* used as unwind-protect function in load */
     Lisp_Object arg;
Jim Blandy's avatar
Jim Blandy committed
970
{
971 972 973
  FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
  if (stream != NULL)
    fclose (stream);
Jim Blandy's avatar
Jim Blandy committed
974 975 976 977
  if (--load_in_progress < 0) load_in_progress = 0;
  return Qnil;
}

978 979 980 981 982
static Lisp_Object
load_descriptor_unwind (oldlist)
     Lisp_Object oldlist;
{
  load_descriptor_list = oldlist;
983
  return Qnil;
984 985 986 987 988 989 990 991
}

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

void
close_load_descs ()
{
992
#ifndef WINDOWSNT
993
  Lisp_Object tail;
994
  for (tail = load_descriptor_list; !NILP (tail); tail = XCDR (tail))
995
    emacs_close (XFASTINT (XCAR (tail)));
996
#endif
997
}
Jim Blandy's avatar
Jim Blandy committed
998 999 1000 1001 1002

static int
complete_filename_p (pathname)
     Lisp_Object pathname;
{
1003
  register const unsigned char *s = SDATA (pathname);
1004
  return (IS_DIRECTORY_SEP (s[0])
1005
	  || (SCHARS (pathname) > 2
1006
	      && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2]))
Jim Blandy's avatar
Jim Blandy committed