lread.c 87.4 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp parsing and input streams.
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1985, 86, 87, 88, 89, 93, 94, 95, 97, 1998
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 30 31 32
#include "lisp.h"

#ifndef standalone
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
33
#include "charset.h"
34
#include <paths.h>
Jim Blandy's avatar
Jim Blandy committed
35
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
36
#include "keyboard.h"
37
#include "termhooks.h"
Jim Blandy's avatar
Jim Blandy committed
38 39 40 41 42 43
#endif

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

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

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

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

#ifdef LISP_FLOAT_TYPE
60 61 62
#ifdef STDC_HEADERS
#include <stdlib.h>
#endif
63

Jim Blandy's avatar
Jim Blandy committed
64 65 66
#include <math.h>
#endif /* LISP_FLOAT_TYPE */

Richard M. Stallman's avatar
Richard M. Stallman committed
67 68 69 70
#ifdef HAVE_SETLOCALE
#include <locale.h>
#endif /* HAVE_SETLOCALE */

Richard M. Stallman's avatar
Richard M. Stallman committed
71 72 73 74
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

75 76
extern int errno;

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

extern Lisp_Object Qevent_symbol_element_mask;
84
extern Lisp_Object Qfile_exists_p;
Jim Blandy's avatar
Jim Blandy committed
85 86 87 88

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

89 90 91
/* Directory in which the sources were found.  */
Lisp_Object Vsource_directory;

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

95 96 97 98
/* This is the user-visible association list that maps features to
   lists of defs in their load files. */
Lisp_Object Vload_history;

99
/* This is used to build the load history. */
100 101
Lisp_Object Vcurrent_load_list;

102 103 104
/* List of files that were preloaded.  */
Lisp_Object Vpreloaded_file_list;

105 106 107
/* Name of file actually being read by `load'.  */
Lisp_Object Vload_file_name;

108 109 110
/* Function to use for reading, in `load' and friends.  */
Lisp_Object Vload_read_function;

111 112 113 114 115 116
/* 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;

117 118 119
/* Nonzero means load should forcibly load all dynamic doc strings.  */
static int load_force_doc_strings;

120 121 122
/* Nonzero means read should convert strings to unibyte.  */
static int load_convert_to_unibyte;

Karl Heuer's avatar
Karl Heuer committed
123 124 125 126
/* Function to use for loading an Emacs lisp source file (not
   compiled) instead of readevalloop.  */
Lisp_Object Vload_source_file_function;

127 128 129
/* List of descriptors now open for Fload.  */
static Lisp_Object load_descriptor_list;

130
/* File for get_file_char to read from.  Use by load.  */
Jim Blandy's avatar
Jim Blandy committed
131 132 133 134 135
static FILE *instream;

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

136
/* For use within read-from-string (this reader is non-reentrant!!)  */
Jim Blandy's avatar
Jim Blandy committed
137
static int read_from_string_index;
138
static int read_from_string_index_byte;
Jim Blandy's avatar
Jim Blandy committed
139
static int read_from_string_limit;
140

141 142 143 144
/* Number of bytes left to read in the buffer character
   that `readchar' has already advanced over.  */
static int readchar_backlog;

145
/* This contains the last string skipped with #@.  */
146 147 148 149 150 151 152 153
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.  */
static int saved_doc_string_position;

154 155 156 157 158 159 160 161 162 163 164
/* 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.  */
static int prev_saved_doc_string_position;

165 166 167 168 169
/* Nonzero means inside a new-style backquote
   with no surrounding parentheses.
   Fread initializes this to zero, so we need not specbind it
   or worry about what happens to it when there is an error.  */
static int new_backquote_flag;
Jim Blandy's avatar
Jim Blandy committed
170 171 172

/* Handle unreading and rereading of characters.
   Write READCHAR to read a character,
Karl Heuer's avatar
Karl Heuer committed
173 174 175 176 177
   UNREAD(c) to unread c to be read again.

   These macros actually read/unread a byte code, multibyte characters
   are not handled here.  The caller should manage them if necessary.
 */
Jim Blandy's avatar
Jim Blandy committed
178 179 180 181 182 183 184 185 186 187 188

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

static int
readchar (readcharfun)
     Lisp_Object readcharfun;
{
  Lisp_Object tem;
  register int c, mpos;

189
  if (BUFFERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
190
    {
191
      register struct buffer *inbuffer = XBUFFER (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
192

193 194
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
195

196 197 198 199 200 201 202 203
      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);

204 205
      if (pt_byte >= BUF_ZV_BYTE (inbuffer))
	return -1;
Jim Blandy's avatar
Jim Blandy committed
206

207 208
      readchar_backlog = -1;

209 210
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
211 212 213 214 215
	  unsigned char workbuf[4];
	  unsigned char *str = workbuf;
	  int length;

	  /* Fetch the character code from the buffer.  */
216 217 218
	  unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, pt_byte);
	  BUF_INC_POS (inbuffer, pt_byte);
	  c = STRING_CHAR (p, pt_byte - orig_pt_byte);
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235

	  /* Find the byte-sequence representation of that character.  */
	  if (SINGLE_BYTE_CHAR_P (c))
	    length = 1, workbuf[0] = c;
	  else
	    length = non_ascii_char_to_string (c, workbuf, &str);

	  /* If the bytes for this character in the buffer
	     are not identical with what the character code implies,
	     read the bytes one by one from the buffer.  */
	  if (length != pt_byte - orig_pt_byte
	      || (length == 1 ? *str != *p : bcmp (str, p, length)))
	    {
	      readchar_backlog = pt_byte - orig_pt_byte;
	      c = BUF_FETCH_BYTE (inbuffer, orig_pt_byte);
	      readchar_backlog--;
	    }
236 237 238 239 240
	}
      else
	{
	  c = BUF_FETCH_BYTE (inbuffer, pt_byte);
	  pt_byte++;
241
	}
242
      SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
243

244
      return c;
Jim Blandy's avatar
Jim Blandy committed
245
    }
246
  if (MARKERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
247
    {
248
      register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
249

250 251
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
252

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

261 262
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
263

264 265
      readchar_backlog = -1;

266 267
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
268 269 270 271 272
	  unsigned char workbuf[4];
	  unsigned char *str = workbuf;
	  int length;

	  /* Fetch the character code from the buffer.  */
273 274 275
	  unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, bytepos);
	  BUF_INC_POS (inbuffer, bytepos);
	  c = STRING_CHAR (p, bytepos - orig_bytepos);
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

	  /* Find the byte-sequence representation of that character.  */
	  if (SINGLE_BYTE_CHAR_P (c))
	    length = 1, workbuf[0] = c;
	  else
	    length = non_ascii_char_to_string (c, workbuf, &str);

	  /* If the bytes for this character in the buffer
	     are not identical with what the character code implies,
	     read the bytes one by one from the buffer.  */
	  if (length != bytepos - orig_bytepos
	      || (length == 1 ? *str != *p : bcmp (str, p, length)))
	    {
	      readchar_backlog = bytepos - orig_bytepos;
	      c = BUF_FETCH_BYTE (inbuffer, orig_bytepos);
	      readchar_backlog--;
	    }
293 294 295 296 297
	}
      else
	{
	  c = BUF_FETCH_BYTE (inbuffer, bytepos);
	  bytepos++;
298 299
	}

300 301 302 303
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

      return c;
Jim Blandy's avatar
Jim Blandy committed
304
    }
305 306 307 308

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

Jim Blandy's avatar
Jim Blandy committed
309
  if (EQ (readcharfun, Qget_file_char))
310 311 312 313 314 315 316 317 318 319 320 321
    {
      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
322

323
  if (STRINGP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
324
    {
325
      if (read_from_string_index >= read_from_string_limit)
Jim Blandy's avatar
Jim Blandy committed
326
	c = -1;
327 328 329 330 331 332
      else if (STRING_MULTIBYTE (readcharfun))
	FETCH_STRING_CHAR_ADVANCE (c, readcharfun,
				   read_from_string_index,
				   read_from_string_index_byte);
      else
	c = XSTRING (readcharfun)->data[read_from_string_index++];
333

Jim Blandy's avatar
Jim Blandy committed
334 335 336 337 338
      return c;
    }

  tem = call0 (readcharfun);

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

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

371 372
	  BUF_PT_BYTE (b) = bytepos;
	}
373
    }
374
  else if (MARKERP (readcharfun))
375
    {
376 377
      struct buffer *b = XMARKER (readcharfun)->buffer;
      int bytepos = XMARKER (readcharfun)->bytepos;
378

379 380
      if (readchar_backlog >= 0)
	readchar_backlog++;
381
      else
382 383 384 385 386 387
	{
	  XMARKER (readcharfun)->charpos--;
	  if (! NILP (b->enable_multibyte_characters))
	    BUF_DEC_POS (b, bytepos);
	  else
	    bytepos--;
388

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

static Lisp_Object read0 (), read1 (), read_list (), read_vector ();
407
static int read_multibyte ();
Jim Blandy's avatar
Jim Blandy committed
408

409
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
410

411 412
extern Lisp_Object read_char ();

413 414 415 416 417 418 419 420 421 422 423 424 425
/* 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
426 427 428 429
   character.

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

431
Lisp_Object
432 433 434
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
435 436 437 438
{
#ifdef standalone
  return make_number (getchar ());
#else
439 440 441
  register Lisp_Object val, delayed_switch_frame;

  delayed_switch_frame = Qnil;
442 443 444

  /* Read until we get an acceptable event.  */
 retry:
445 446 447
  val = read_char (0, 0, 0,
		   (input_method ? Qnil : Qt),
		   0);
448

449
  if (BUFFERP (val))
450 451
    goto retry;

452
  /* switch-frame events are put off until after the next ASCII
Karl Heuer's avatar
Karl Heuer committed
453
     character.  This is better than signaling an error just because
454 455 456 457 458 459 460 461 462 463 464 465 466 467
     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.  */
468
      if (SYMBOLP (val))
469 470 471 472 473 474 475 476 477
	{
	  Lisp_Object tem, tem1, tem2;
	  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))
478
		XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
479 480 481 482
	    }
	}
	  
      /* If we don't have a character now, deal with it appropriately.  */
483
      if (!INTEGERP (val))
484 485 486
	{
	  if (error_nonascii)
	    {
487
	      Vunread_command_events = Fcons (val, Qnil);
488 489 490 491 492 493 494 495 496 497 498 499 500 501
	      error ("Non-character input-event");
	    }
	  else
	    goto retry;
	}
    }

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

  return val;
#endif
}

502
DEFUN ("read-char", Fread_char, Sread_char, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
503
  "Read a character from the command input (keyboard or macro).\n\
Jim Blandy's avatar
Jim Blandy committed
504 505
It is returned as a number.\n\
If the user generates an event which is not a character (i.e. a mouse\n\
Jim Blandy's avatar
Jim Blandy committed
506 507 508 509
click or function key event), `read-char' signals an error.  As an\n\
exception, switch-frame events are put off until non-ASCII events can\n\
be read.\n\
If you want to read non-character events, or ignore them, call\n\
510 511 512
`read-event' or `read-char-exclusive' instead.\n\
\n\
If the optional argument PROMPT is non-nil, display that as a prompt.\n\
513 514 515 516 517
If the optional argument INHERIT-INPUT-METHOD is non-nil and some\n\
input method is turned on in the current buffer, that input method\n\
is used for reading a character.")
  (prompt, inherit_input_method)
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
518
{
519 520
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
521
  return read_filtered_event (1, 1, 1, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
522 523
}

524 525 526
DEFUN ("read-event", Fread_event, Sread_event, 0, 2, 0,
  "Read an event object from the input stream.\n\
If the optional argument PROMPT is non-nil, display that as a prompt.\n\
527 528 529 530 531
If the optional argument INHERIT-INPUT-METHOD is non-nil and some\n\
input method is turned on in the current buffer, that input method\n\
is used for reading a character.")
  (prompt, inherit_input_method)
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
532
{
533 534
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
535
  return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
536 537
}

538
DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
539
  "Read a character from the command input (keyboard or macro).\n\
540 541 542
It is returned as a number.  Non-character events are ignored.\n\
\n\
If the optional argument PROMPT is non-nil, display that as a prompt.\n\
543 544 545 546 547
If the optional argument INHERIT-INPUT-METHOD is non-nil and some\n\
input method is turned on in the current buffer, that input method\n\
is used for reading a character.")
  (prompt, inherit_input_method)
     Lisp_Object prompt, inherit_input_method;
Jim Blandy's avatar
Jim Blandy committed
548
{
549 550
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
551
  return read_filtered_event (1, 1, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
552 553 554 555 556 557 558
}

DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
  "Don't use this yourself.")
  ()
{
  register Lisp_Object val;
559
  XSETINT (val, getc (instream));
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563 564
  return val;
}

static void readevalloop ();
static Lisp_Object load_unwind ();
565
static Lisp_Object load_descriptor_unwind ();
Jim Blandy's avatar
Jim Blandy committed
566

567
DEFUN ("load", Fload, Sload, 1, 5, 0,
Jim Blandy's avatar
Jim Blandy committed
568 569 570 571 572 573 574 575 576 577
  "Execute a file of Lisp code named FILE.\n\
First try FILE with `.elc' appended, then try with `.el',\n\
 then try FILE unmodified.\n\
This function searches the directories in `load-path'.\n\
If optional second arg NOERROR is non-nil,\n\
 report no error if FILE doesn't exist.\n\
Print messages at start and end of loading unless\n\
 optional third arg NOMESSAGE is non-nil.\n\
If optional fourth arg NOSUFFIX is non-nil, don't try adding\n\
 suffixes `.elc' or `.el' to the specified name FILE.\n\
578
If optional fifth arg MUST-SUFFIX is non-nil, insist on\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
579
 the suffix `.elc' or `.el'; don't accept just FILE unless\n\
580
 it ends in one of those suffixes or includes a directory name.\n\
Jim Blandy's avatar
Jim Blandy committed
581
Return t if file exists.")
582 583
  (file, noerror, nomessage, nosuffix, must_suffix)
     Lisp_Object file, noerror, nomessage, nosuffix, must_suffix;
Jim Blandy's avatar
Jim Blandy committed
584 585 586 587 588 589 590 591
{
  register FILE *stream;
  register int fd = -1;
  register Lisp_Object lispstream;
  int count = specpdl_ptr - specpdl;
  Lisp_Object temp;
  struct gcpro gcpro1;
  Lisp_Object found;
592 593 594 595
  /* 1 means we printed the ".el is newer" message.  */
  int newer = 0;
  /* 1 means we are loading a compiled file.  */
  int compiled = 0;
596
  Lisp_Object handler;
597
  char *fmode = "r";
598
#ifdef DOS_NT
599
  fmode = "rt";
600
#endif /* DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
601

602
  CHECK_STRING (file, 0);
Jim Blandy's avatar
Jim Blandy committed
603

604
  /* If file name is magic, call the handler.  */
605
  handler = Ffind_file_name_handler (file, Qload);
606
  if (!NILP (handler))
607
    return call5 (handler, Qload, file, noerror, nomessage, nosuffix);
608

609 610 611
  /* Do this after the handler to avoid
     the need to gcpro noerror, nomessage and nosuffix.
     (Below here, we care only whether they are nil or not.)  */
612
  file = Fsubstitute_in_file_name (file);
613

Jim Blandy's avatar
Jim Blandy committed
614 615
  /* Avoid weird lossage with null string as arg,
     since it would try to load a directory as a Lisp file */
616
  if (XSTRING (file)->size > 0)
Jim Blandy's avatar
Jim Blandy committed
617
    {
618 619
      int size = XSTRING (file)->size;

620
      GCPRO1 (file);
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636

      if (! NILP (must_suffix))
	{
	  /* Don't insist on adding a suffix if FILE already ends with one.  */
	  if (size > 3
	      && !strcmp (XSTRING (file)->data + size - 3, ".el"))
	    must_suffix = Qnil;
	  else if (size > 4
		   && !strcmp (XSTRING (file)->data + size - 4, ".elc"))
	    must_suffix = Qnil;
	  /* Don't insist on adding a suffix
	     if the argument includes a directory name.  */
	  else if (! NILP (Ffile_name_directory (file)))
	    must_suffix = Qnil;
	}

637 638 639 640
      fd = openp (Vload_path, file,
		  (!NILP (nosuffix) ? ""
		   : ! NILP (must_suffix) ? ".elc:.el"
		   : ".elc:.el:"),
Jim Blandy's avatar
Jim Blandy committed
641
		  &found, 0);
642
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
643 644 645 646
    }

  if (fd < 0)
    {
Jim Blandy's avatar
Jim Blandy committed
647
      if (NILP (noerror))
Jim Blandy's avatar
Jim Blandy committed
648 649
	while (1)
	  Fsignal (Qfile_error, Fcons (build_string ("Cannot open load file"),
650
				       Fcons (file, Qnil)));
Jim Blandy's avatar
Jim Blandy committed
651 652 653 654
      else
	return Qnil;
    }

655
  /* If FD is 0, that means openp found a magic file.  */
656 657
  if (fd == 0)
    {
658 659 660 661 662 663 664 665 666
      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);
667 668
    }

669 670
  /* Load .elc files directly, but not when they are
     remote and have no handler!  */
Jim Blandy's avatar
Jim Blandy committed
671
  if (!bcmp (&(XSTRING (found)->data[XSTRING (found)->size - 4]),
672 673
	     ".elc", 4)
      && fd != 0)
Jim Blandy's avatar
Jim Blandy committed
674 675 676 677
    {
      struct stat s1, s2;
      int result;

678 679
      compiled = 1;

680
#ifdef DOS_NT
681
      fmode = "rb";
682
#endif /* DOS_NT */
683
      stat ((char *)XSTRING (found)->data, &s1);
Jim Blandy's avatar
Jim Blandy committed
684
      XSTRING (found)->data[XSTRING (found)->size - 1] = 0;
685
      result = stat ((char *)XSTRING (found)->data, &s2);
Jim Blandy's avatar
Jim Blandy committed
686
      if (result >= 0 && (unsigned) s1.st_mtime < (unsigned) s2.st_mtime)
687
	{
688 689 690 691 692
	  /* Make the progress messages mention that source is newer.  */
	  newer = 1;

	  /* If we won't print another message, mention this anyway.  */
	  if (! NILP (nomessage))
693 694
	    message_with_string ("Source file `%s' newer than byte-compiled file",
				 found, 1);
695
	}
Jim Blandy's avatar
Jim Blandy committed
696 697
      XSTRING (found)->data[XSTRING (found)->size - 1] = 'c';
    }
Karl Heuer's avatar
Karl Heuer committed
698 699 700 701 702
  else
    {
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
703 704
	  if (fd != 0)
	    close (fd);
705
	  return call4 (Vload_source_file_function, found, file,
Karl Heuer's avatar
Karl Heuer committed
706 707 708 709
			NILP (noerror) ? Qnil : Qt,
			NILP (nomessage) ? Qnil : Qt);
	}
    }
Jim Blandy's avatar
Jim Blandy committed
710

711
#ifdef WINDOWSNT
712
  close (fd);
713 714 715 716
  stream = fopen ((char *) XSTRING (found)->data, fmode);
#else  /* not WINDOWSNT */
  stream = fdopen (fd, fmode);
#endif /* not WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
717 718 719
  if (stream == 0)
    {
      close (fd);
720
      error ("Failure to create stdio stream for %s", XSTRING (file)->data);
Jim Blandy's avatar
Jim Blandy committed
721 722
    }

723 724 725
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

726 727
  if (NILP (nomessage))
    {
728
      if (!compiled)
729
	message_with_string ("Loading %s (source)...", file, 1);
730
      else if (newer)
731 732
	message_with_string ("Loading %s (compiled; note, source file is newer)...",
		 file, 1);
733
      else /* The typical case; compiled file newer than source file.  */
734
	message_with_string ("Loading %s...", file, 1);
735
    }
Jim Blandy's avatar
Jim Blandy committed
736

737
  GCPRO1 (file);
738 739 740
  lispstream = Fcons (Qnil, Qnil);
  XSETFASTINT (XCONS (lispstream)->car, (EMACS_UINT)stream >> 16);
  XSETFASTINT (XCONS (lispstream)->cdr, (EMACS_UINT)stream & 0xffff);
Jim Blandy's avatar
Jim Blandy committed
741
  record_unwind_protect (load_unwind, lispstream);
742
  record_unwind_protect (load_descriptor_unwind, load_descriptor_list);
743
  specbind (Qload_file_name, found);
744
  specbind (Qinhibit_file_name_operation, Qnil);
745 746
  load_descriptor_list
    = Fcons (make_number (fileno (stream)), load_descriptor_list);
Jim Blandy's avatar
Jim Blandy committed
747
  load_in_progress++;
748
  readevalloop (Qget_file_char, stream, file, Feval, 0, Qnil, Qnil);
Jim Blandy's avatar
Jim Blandy committed
749 750 751
  unbind_to (count, Qnil);

  /* Run any load-hooks for this file.  */
752
  temp = Fassoc (file, Vafter_load_alist);
Jim Blandy's avatar
Jim Blandy committed
753
  if (!NILP (temp))
Jim Blandy's avatar
Jim Blandy committed
754 755 756
    Fprogn (Fcdr (temp));
  UNGCPRO;

757 758 759 760 761
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

762 763 764 765 766
  if (prev_saved_doc_string)
    free (prev_saved_doc_string);
  prev_saved_doc_string = 0;
  prev_saved_doc_string_size = 0;

Jim Blandy's avatar
Jim Blandy committed
767
  if (!noninteractive && NILP (nomessage))
768
    {
769
      if (!compiled)
770
	message_with_string ("Loading %s (source)...done", file, 1);
771
      else if (newer)
772 773
	message_with_string ("Loading %s (compiled; note, source file is newer)...done",
		 file, 1);
774
      else /* The typical case; compiled file newer than source file.  */
775
	message_with_string ("Loading %s...done", file, 1);
776
    }
Jim Blandy's avatar
Jim Blandy committed
777 778 779 780 781 782 783
  return Qt;
}

static Lisp_Object
load_unwind (stream)  /* used as unwind-protect function in load */
     Lisp_Object stream;
{
784 785
  fclose ((FILE *) (XFASTINT (XCONS (stream)->car) << 16
		    | XFASTINT (XCONS (stream)->cdr)));
Jim Blandy's avatar
Jim Blandy committed
786 787 788 789
  if (--load_in_progress < 0) load_in_progress = 0;
  return Qnil;
}

790 791 792 793 794
static Lisp_Object
load_descriptor_unwind (oldlist)
     Lisp_Object oldlist;
{
  load_descriptor_list = oldlist;
795
  return Qnil;
796 797 798 799 800 801 802 803
}

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

void
close_load_descs ()
{
804
#ifndef WINDOWSNT
805 806 807
  Lisp_Object tail;
  for (tail = load_descriptor_list; !NILP (tail); tail = XCONS (tail)->cdr)
    close (XFASTINT (XCONS (tail)->car));
808
#endif
809
}
Jim Blandy's avatar
Jim Blandy committed
810 811 812 813 814 815

static int
complete_filename_p (pathname)
     Lisp_Object pathname;
{
  register unsigned char *s = XSTRING (pathname)->data;
816 817 818
  return (IS_DIRECTORY_SEP (s[0])
	  || (XSTRING (pathname)->size > 2
	      && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2]))
Jim Blandy's avatar
Jim Blandy committed
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
#ifdef ALTOS
	  || *s == '@'
#endif
#ifdef VMS
	  || index (s, ':')
#endif /* VMS */
	  );
}

/* Search for a file whose name is STR, looking in directories
   in the Lisp list PATH, and trying suffixes from SUFFIX.
   SUFFIX is a string containing possible suffixes separated by colons.
   On success, returns a file descriptor.  On failure, returns -1.

   EXEC_ONLY nonzero means don't open the files,
   just look for one that is executable.  In this case,
   returns 1 on success.

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

   If the file we find is remote, return 0
   but store the found remote file name in *STOREPTR.
   We do not check for remote files if EXEC_ONLY is nonzero.  */
Jim Blandy's avatar
Jim Blandy committed
844 845 846 847 848 849 850 851 852 853 854 855 856 857

int
openp (path, str, suffix, storeptr, exec_only)
     Lisp_Object path, str;
     char *suffix;
     Lisp_Object *storeptr;
     int exec_only;
{
  register int fd;
  int fn_size = 100;
  char buf[100];
  register char *fn = buf;
  int absolute = 0;
  int want_size;
858
  Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
859
  struct stat st;
860
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
861

862
  GCPRO1 (str);
Jim Blandy's avatar
Jim Blandy committed
863 864 865 866 867 868
  if (storeptr)
    *storeptr = Qnil;

  if (complete_filename_p (str))
    absolute = 1;

Jim Blandy's avatar
Jim Blandy committed
869
  for (; !NILP (path); path = Fcdr (path))
Jim Blandy's avatar
Jim Blandy committed
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
    {
      char *nsuffix;

      filename = Fexpand_file_name (str, Fcar (path));
      if (!complete_filename_p (filename))
	/* If there are non-absolute elts in PATH (eg ".") */
	/* Of course, this could conceivably lose if luser sets
	   default-directory to be something non-absolute... */
	{
	  filename = Fexpand_file_name (filename, current_buffer->directory);
	  if (!complete_filename_p (filename))
	    /* Give up on this path element! */
	    continue;
	}

      /* Calculate maximum size of any filename made from
	 this path element/specified file name and any possible suffix.  */
      want_size = strlen (suffix) + XSTRING (filename)->size + 1;
      if (fn_size < want_size)
	fn = (char *) alloca (fn_size = 100 + want_size);

      nsuffix = suffix;

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

900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
	  /* Concatenate path element/specified name with the suffix.
	     If the directory starts with /:, remove that.  */
	  if (XSTRING (filename)->size > 2
	      && XSTRING (filename)->data[0] == '/'
	      && XSTRING (filename)->data[1] == ':')
	    {
	      strncpy (fn, XSTRING (filename)->data + 2,
		       XSTRING (filename)->size - 2);
	      fn[XSTRING (filename)->size - 2] = 0;
	    }
	  else
	    {
	      strncpy (fn, XSTRING (filename)->data, XSTRING (filename)->size);
	      fn[XSTRING (filename)->size] = 0;
	    }

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

919 920 921 922 923 924
	  /* Check that the file exists and is not a directory.  */
	  if (absolute)
	    handler = Qnil;
	  else
	    handler = Ffind_file_name_handler (filename, Qfile_exists_p);
	  if (! NILP (handler) && ! exec_only)
Jim Blandy's avatar
Jim Blandy committed
925
	    {
926 927
	      Lisp_Object string;
	      int exists;
Jim Blandy's avatar
Jim Blandy committed
928

929 930 931 932 933 934 935 936
	      string = build_string (fn);
	      exists = ! NILP (exec_only ? Ffile_executable_p (string)
			       : Ffile_readable_p (string));
	      if (exists
		  && ! NILP (Ffile_directory_p (build_string (fn))))
		exists = 0;

	      if (exists)
Jim Blandy's avatar
Jim Blandy committed
937 938 939 940
		{
		  /* We succeeded; return this descriptor and filename.  */
		  if (storeptr)
		    *storeptr = build_string (fn);
941
		  UNGCPRO;
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
		  return 0;
		}
	    }
	  else
	    {
	      int exists = (stat (fn, &st) >= 0
			    && (st.st_mode & S_IFMT) != S_IFDIR);
	      if (exists)
		{
		  /* Check that we can access or open it.  */
		  if (exec_only)
		    fd = (access (fn, X_OK) == 0) ? 1 : -1;
		  else
		    fd = open (fn, O_RDONLY, 0);

		  if (fd >= 0)
		    {
		      /* We succeeded; return this descriptor and filename.  */
		      if (storeptr)
			*storeptr = build_string (fn);
		      UNGCPRO;
		      return fd;
		    }
Jim Blandy's avatar
Jim Blandy committed
965 966 967 968 969 970 971 972
		}
	    }

	  /* Advance to next suffix.  */
	  if (esuffix == 0)
	    break;
	  nsuffix += lsuffix + 1;
	}
973
      if (absolute)
974
	break;
Jim Blandy's avatar
Jim Blandy committed
975 976
    }

977 978
  UNGCPRO;
  return -1;
Jim Blandy's avatar
Jim Blandy committed
979 980 981
}


982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
/* Merge the list we've accumulated of globals from the current input source
   into the load_history variable.  The details depend on whether
   the source has an associated file name or not. */

static void
build_load_history (stream, source)
     FILE *stream;
     Lisp_Object source;
{
  register Lisp_Object tail, prev, newelt;
  register Lisp_Object tem, tem2;
  register int foundit, loading;

  loading = stream || !NARROWED;

  tail = Vload_history;
  prev = Qnil;
  foundit = 0;
  while (!NILP (tail))
    {
      tem = Fcar (tail);

      /* Find the feature's previous assoc list... */
      if (!NILP (Fequal (source, Fcar (tem))))
	{
	  foundit = 1;

	  /*  If we're loading, remove it. */
	  if (loading)
	    {	  
	      if (NILP (prev))
		Vload_history = Fcdr (tail);
	      else
		Fsetcdr (prev, Fcdr (tail));
	    }

	  /*  Otherwise, cons on new symbols that are not already members.  */
	  else
	    {
	      tem2 = Vcurrent_load_list;

	      while (CONSP (tem2))
		{
		  newelt = Fcar (tem2);

		  if (NILP (Fmemq (newelt, tem)))
		    Fsetcar (tail, Fcons (Fcar (tem),
					  Fcons (newelt, Fcdr (tem))));

		  tem2 = Fcdr (tem2);
		  QUIT;
		}
	    }
	}
      else
	prev = tail;
      tail = Fcdr (tail);
      QUIT;
    }

1042 1043 1044 1045 1046 1047
  /* If we're loading, cons the new assoc onto the front of load-history,
     the most-recently-loaded position.  Also do this if we didn't find
     an existing member for the current source.  */
  if (loading || !foundit)
    Vload_history = Fcons (Fnreverse (Vcurrent_load_list),
			   Vload_history);
1048 1049
}

Jim Blandy's avatar
Jim Blandy committed
1050 1051 1052 1053 1054 1055 1056
Lisp_Object
unreadpure ()	/* Used as unwind-protect function in readevalloop */
{
  read_pure = 0;
  return Qnil;
}

1057 1058 1059 1060 1061 1062 1063 1064 1065
static Lisp_Object
readevalloop_1 (old)
     Lisp_Object old;
{
  load_convert_to_unibyte = ! NILP (old);
  return Qnil;
}

/* UNIBYTE specifies how to set load_convert_to_unibyte
1066 1067
   for this invocation.
   READFUN, if non-nil, is used instead of `read'.  */
1068

Jim Blandy's avatar
Jim Blandy committed
1069
static void
1070
readevalloop (readcharfun, stream, sourcename, evalfun, printflag, unibyte, readfun)
Jim Blandy's avatar
Jim Blandy committed
1071
     Lisp_Object readcharfun;
1072 1073
     FILE *stream;
     Lisp_Object sourcename;
Jim Blandy's avatar
Jim Blandy committed
1074 1075
     Lisp_Object (*evalfun) ();
     int printflag;
1076
     Lisp_Object unibyte, readfun;
Jim Blandy's avatar
Jim Blandy committed
1077 1078 1079 1080
{
  register int c;
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;
1081
  struct gcpro gcpro1;
1082 1083 1084 1085 1086 1087
  struct buffer *b = 0;

  if (BUFFERP (readcharfun))
    b = XBUFFER (readcharfun);
  else if (MARKERP (readcharfun))
    b = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
1088 1089

  specbind (Qstandard_input, readcharfun);
1090
  specbind (Qcurrent_load_list, Qnil);
1091 1092
  record_unwind_protect (readevalloop_1, load_convert_to_unibyte ? Qt : Qnil);
  load_convert_to_unibyte = !NILP (unibyte);
Jim Blandy's avatar
Jim Blandy committed
1093

1094
  readchar_backlog = -1;
1095

1096
  GCPRO1 (sourcename);
1097 1098 1099

  LOADHIST_ATTACH (sourcename);

Jim Blandy's avatar
Jim Blandy committed
1100 1101
  while (1)
    {
1102 1103 1104
      if (b != 0 && NILP (b->name))
	error ("Reading from killed buffer");

Jim Blandy's avatar
Jim Blandy committed
1105 1106 1107 1108 1109 1110 1111 1112
      instream = stream;
      c = READCHAR;
      if (c == ';')
	{
	  while ((c = READCHAR) != '\n' && c != -1);
	  continue;
	}
      if (c < 0) break;
1113 1114 1115 1116

      /* Ignore whitespace here, so we can detect eof.  */
      if (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r')
	continue;
Jim Blandy's avatar
Jim Blandy committed
1117

Jim Blandy's avatar
Jim Blandy committed
1118
      if (!NILP (Vpurify_flag) && c == '(')
Jim Blandy's avatar
Jim Blandy committed
1119
	{
1120
	  int count1 = specpdl_ptr - specpdl;
Jim Blandy's avatar
Jim Blandy committed
1121 1122
	  record_unwind_protect (unreadpure, Qnil);
	  val = read_list (-1, readcharfun);
1123
	  unbind_to (count1, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1124 1125 1126 1127
	}
      else
	{
	  UNREAD (c);
1128
	  read_objects = Qnil;
1129 1130 1131
	  if (! NILP (readfun))
	    val = call1 (readfun, readcharfun);
	  else if (! NILP (Vload_read_function))
1132
	    val = call1 (Vload_read_function, readcharfun);
1133 1134
	  else
	    val = read0 (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
	}

      val = (*evalfun) (val);
      if (printflag)
	{
	  Vvalues = Fcons (val, Vvalues);
	  if (EQ (Vstandard_output, Qt))
	    Fprin1 (val, Qnil);
	  else
	    Fprint (val, Qnil);
	}
    }