lread.c 92.8 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 <epaths.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;

Karl Heuer's avatar
Karl Heuer committed
95 96 97
/* File name of user's init file.  */
Lisp_Object Vuser_init_file;

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

102
/* This is used to build the load history. */
103 104
Lisp_Object Vcurrent_load_list;

105 106 107
/* List of files that were preloaded.  */
Lisp_Object Vpreloaded_file_list;

108 109 110
/* Name of file actually being read by `load'.  */
Lisp_Object Vload_file_name;

111 112 113
/* Function to use for reading, in `load' and friends.  */
Lisp_Object Vload_read_function;

114 115 116 117 118 119
/* 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;

120 121 122
/* Nonzero means load should forcibly load all dynamic doc strings.  */
static int load_force_doc_strings;

123 124 125
/* Nonzero means read should convert strings to unibyte.  */
static int load_convert_to_unibyte;

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

130 131 132
/* List of all DEFVAR_BOOL variables.  Used by the byte optimizer.  */
Lisp_Object Vbyte_boolean_vars;

133 134 135
/* List of descriptors now open for Fload.  */
static Lisp_Object load_descriptor_list;

136
/* File for get_file_char to read from.  Use by load.  */
Jim Blandy's avatar
Jim Blandy committed
137 138 139 140 141
static FILE *instream;

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

142
/* For use within read-from-string (this reader is non-reentrant!!)  */
Jim Blandy's avatar
Jim Blandy committed
143
static int read_from_string_index;
144
static int read_from_string_index_byte;
Jim Blandy's avatar
Jim Blandy committed
145
static int read_from_string_limit;
146

147 148 149 150
/* Number of bytes left to read in the buffer character
   that `readchar' has already advanced over.  */
static int readchar_backlog;

151
/* This contains the last string skipped with #@.  */
152 153 154 155 156 157 158 159
static char *saved_doc_string;
/* Length of buffer allocated in saved_doc_string.  */
static int saved_doc_string_size;
/* Length of actual data in saved_doc_string.  */
static int saved_doc_string_length;
/* This is the file position that string came from.  */
static int saved_doc_string_position;

160 161 162 163 164 165 166 167 168 169 170
/* This contains the previous string skipped with #@.
   We copy it from saved_doc_string when a new string
   is put in saved_doc_string.  */
static char *prev_saved_doc_string;
/* Length of buffer allocated in prev_saved_doc_string.  */
static int prev_saved_doc_string_size;
/* Length of actual data in prev_saved_doc_string.  */
static int prev_saved_doc_string_length;
/* This is the file position that string came from.  */
static int prev_saved_doc_string_position;

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

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

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

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

199 200
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
201

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

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

213 214
      readchar_backlog = -1;

215 216
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
217 218 219 220 221
	  unsigned char workbuf[4];
	  unsigned char *str = workbuf;
	  int length;

	  /* Fetch the character code from the buffer.  */
222 223 224
	  unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, pt_byte);
	  BUF_INC_POS (inbuffer, pt_byte);
	  c = STRING_CHAR (p, pt_byte - orig_pt_byte);
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

	  /* 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--;
	    }
242 243 244 245 246
	}
      else
	{
	  c = BUF_FETCH_BYTE (inbuffer, pt_byte);
	  pt_byte++;
247
	}
248
      SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
249

250
      return c;
Jim Blandy's avatar
Jim Blandy committed
251
    }
252
  if (MARKERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
253
    {
254
      register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
255

256 257
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
258

259 260 261 262 263 264 265 266
      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);

267 268
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
269

270 271
      readchar_backlog = -1;

272 273
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
274 275 276 277 278
	  unsigned char workbuf[4];
	  unsigned char *str = workbuf;
	  int length;

	  /* Fetch the character code from the buffer.  */
279 280 281
	  unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, bytepos);
	  BUF_INC_POS (inbuffer, bytepos);
	  c = STRING_CHAR (p, bytepos - orig_bytepos);
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298

	  /* 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--;
	    }
299 300 301 302 303
	}
      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 334 335 336 337 338
      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++];
339

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

  tem = call0 (readcharfun);

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

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

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

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

395 396
	  XMARKER (readcharfun)->bytepos = bytepos;
	}
397
    }
398
  else if (STRINGP (readcharfun))
399 400 401 402 403
    {
      read_from_string_index--;
      read_from_string_index_byte
	= string_char_to_byte (readcharfun, read_from_string_index);
    }
404 405
  else if (EQ (readcharfun, Qlambda))
    read_bytecode_char (1);
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409 410 411 412
  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 ();
413
static int read_multibyte ();
414 415 416
static Lisp_Object substitute_object_recurse ();
static void        substitute_object_in_subtree (), substitute_in_interval ();

Jim Blandy's avatar
Jim Blandy committed
417

418
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
419

420 421
extern Lisp_Object read_char ();

422 423 424 425 426 427 428 429 430 431 432 433 434
/* 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
435 436 437 438
   character.

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

440
Lisp_Object
441 442 443
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
444 445 446 447
{
#ifdef standalone
  return make_number (getchar ());
#else
448 449 450
  register Lisp_Object val, delayed_switch_frame;

  delayed_switch_frame = Qnil;
451 452 453

  /* Read until we get an acceptable event.  */
 retry:
454 455 456
  val = read_char (0, 0, 0,
		   (input_method ? Qnil : Qt),
		   0);
457

458
  if (BUFFERP (val))
459 460
    goto retry;

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

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

  return val;
#endif
}

511
DEFUN ("read-char", Fread_char, Sread_char, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
512
  "Read a character from the command input (keyboard or macro).\n\
Jim Blandy's avatar
Jim Blandy committed
513 514
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
515 516 517 518
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\
519 520 521
`read-event' or `read-char-exclusive' instead.\n\
\n\
If the optional argument PROMPT is non-nil, display that as a prompt.\n\
522 523 524 525 526
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
527
{
528 529
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
530
  return read_filtered_event (1, 1, 1, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
531 532
}

533 534 535
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\
536 537 538 539 540
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
541
{
542 543
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
544
  return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
545 546
}

547
DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
548
  "Read a character from the command input (keyboard or macro).\n\
549 550 551
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\
552 553 554 555 556
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
557
{
558 559
  if (! NILP (prompt))
    message_with_string ("%s", prompt, 0);
560
  return read_filtered_event (1, 1, 0, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
561 562 563 564 565 566 567
}

DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
  "Don't use this yourself.")
  ()
{
  register Lisp_Object val;
568
  XSETINT (val, getc (instream));
Jim Blandy's avatar
Jim Blandy committed
569 570 571 572 573
  return val;
}

static void readevalloop ();
static Lisp_Object load_unwind ();
574
static Lisp_Object load_descriptor_unwind ();
Jim Blandy's avatar
Jim Blandy committed
575

576
DEFUN ("load", Fload, Sload, 1, 5, 0,
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580 581 582 583 584 585 586
  "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\
587
If optional fifth arg MUST-SUFFIX is non-nil, insist on\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
588
 the suffix `.elc' or `.el'; don't accept just FILE unless\n\
589
 it ends in one of those suffixes or includes a directory name.\n\
Jim Blandy's avatar
Jim Blandy committed
590
Return t if file exists.")
591 592
  (file, noerror, nomessage, nosuffix, must_suffix)
     Lisp_Object file, noerror, nomessage, nosuffix, must_suffix;
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596 597 598 599 600
{
  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;
601 602 603 604
  /* 1 means we printed the ".el is newer" message.  */
  int newer = 0;
  /* 1 means we are loading a compiled file.  */
  int compiled = 0;
605
  Lisp_Object handler;
606
  char *fmode = "r";
607
#ifdef DOS_NT
608
  fmode = "rt";
609
#endif /* DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
610

611
  CHECK_STRING (file, 0);
Jim Blandy's avatar
Jim Blandy committed
612

613
  /* If file name is magic, call the handler.  */
614
  handler = Ffind_file_name_handler (file, Qload);
615
  if (!NILP (handler))
616
    return call5 (handler, Qload, file, noerror, nomessage, nosuffix);
617

618 619 620
  /* 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.)  */
621
  file = Fsubstitute_in_file_name (file);
622

Jim Blandy's avatar
Jim Blandy committed
623 624
  /* Avoid weird lossage with null string as arg,
     since it would try to load a directory as a Lisp file */
625
  if (XSTRING (file)->size > 0)
Jim Blandy's avatar
Jim Blandy committed
626
    {
627 628
      int size = XSTRING (file)->size;

629
      GCPRO1 (file);
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645

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

646 647 648 649
      fd = openp (Vload_path, file,
		  (!NILP (nosuffix) ? ""
		   : ! NILP (must_suffix) ? ".elc:.el"
		   : ".elc:.el:"),
Jim Blandy's avatar
Jim Blandy committed
650
		  &found, 0);
651
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
652 653 654 655
    }

  if (fd < 0)
    {
Jim Blandy's avatar
Jim Blandy committed
656
      if (NILP (noerror))
Jim Blandy's avatar
Jim Blandy committed
657 658
	while (1)
	  Fsignal (Qfile_error, Fcons (build_string ("Cannot open load file"),
659
				       Fcons (file, Qnil)));
Jim Blandy's avatar
Jim Blandy committed
660 661 662 663
      else
	return Qnil;
    }

Karl Heuer's avatar
Karl Heuer committed
664 665 666
  if (EQ (Qt, Vuser_init_file))
    Vuser_init_file = found;

667
  /* If FD is 0, that means openp found a magic file.  */
668 669
  if (fd == 0)
    {
670 671 672 673 674 675 676 677 678
      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);
679 680
    }

681 682
  /* Load .elc files directly, but not when they are
     remote and have no handler!  */
Jim Blandy's avatar
Jim Blandy committed
683
  if (!bcmp (&(XSTRING (found)->data[XSTRING (found)->size - 4]),
684 685
	     ".elc", 4)
      && fd != 0)
Jim Blandy's avatar
Jim Blandy committed
686 687 688 689
    {
      struct stat s1, s2;
      int result;

690 691
      compiled = 1;

692
#ifdef DOS_NT
693
      fmode = "rb";
694
#endif /* DOS_NT */
695
      stat ((char *)XSTRING (found)->data, &s1);
Jim Blandy's avatar
Jim Blandy committed
696
      XSTRING (found)->data[XSTRING (found)->size - 1] = 0;
697
      result = stat ((char *)XSTRING (found)->data, &s2);
Jim Blandy's avatar
Jim Blandy committed
698
      if (result >= 0 && (unsigned) s1.st_mtime < (unsigned) s2.st_mtime)
699
	{
700 701 702 703 704
	  /* Make the progress messages mention that source is newer.  */
	  newer = 1;

	  /* If we won't print another message, mention this anyway.  */
	  if (! NILP (nomessage))
705 706
	    message_with_string ("Source file `%s' newer than byte-compiled file",
				 found, 1);
707
	}
Jim Blandy's avatar
Jim Blandy committed
708 709
      XSTRING (found)->data[XSTRING (found)->size - 1] = 'c';
    }
Karl Heuer's avatar
Karl Heuer committed
710 711 712 713 714
  else
    {
      /* We are loading a source file (*.el).  */
      if (!NILP (Vload_source_file_function))
	{
715 716
	  if (fd != 0)
	    close (fd);
717
	  return call4 (Vload_source_file_function, found, file,
Karl Heuer's avatar
Karl Heuer committed
718 719 720 721
			NILP (noerror) ? Qnil : Qt,
			NILP (nomessage) ? Qnil : Qt);
	}
    }
Jim Blandy's avatar
Jim Blandy committed
722

723
#ifdef WINDOWSNT
724
  close (fd);
725 726 727 728
  stream = fopen ((char *) XSTRING (found)->data, fmode);
#else  /* not WINDOWSNT */
  stream = fdopen (fd, fmode);
#endif /* not WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
729 730 731
  if (stream == 0)
    {
      close (fd);
732
      error ("Failure to create stdio stream for %s", XSTRING (file)->data);
Jim Blandy's avatar
Jim Blandy committed
733 734
    }

735 736 737
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

738 739
  if (NILP (nomessage))
    {
740
      if (!compiled)
741
	message_with_string ("Loading %s (source)...", file, 1);
742
      else if (newer)
743 744
	message_with_string ("Loading %s (compiled; note, source file is newer)...",
		 file, 1);
745
      else /* The typical case; compiled file newer than source file.  */
746
	message_with_string ("Loading %s...", file, 1);
747
    }
Jim Blandy's avatar
Jim Blandy committed
748

749
  GCPRO1 (file);
750
  lispstream = Fcons (Qnil, Qnil);
751 752
  XSETFASTINT (XCAR (lispstream), (EMACS_UINT)stream >> 16);
  XSETFASTINT (XCDR (lispstream), (EMACS_UINT)stream & 0xffff);
Jim Blandy's avatar
Jim Blandy committed
753
  record_unwind_protect (load_unwind, lispstream);
754
  record_unwind_protect (load_descriptor_unwind, load_descriptor_list);
755
  specbind (Qload_file_name, found);
756
  specbind (Qinhibit_file_name_operation, Qnil);
757 758
  load_descriptor_list
    = Fcons (make_number (fileno (stream)), load_descriptor_list);
Jim Blandy's avatar
Jim Blandy committed
759
  load_in_progress++;
760
  readevalloop (Qget_file_char, stream, file, Feval, 0, Qnil, Qnil);
Jim Blandy's avatar
Jim Blandy committed
761 762 763
  unbind_to (count, Qnil);

  /* Run any load-hooks for this file.  */
764
  temp = Fassoc (file, Vafter_load_alist);
Jim Blandy's avatar
Jim Blandy committed
765
  if (!NILP (temp))
Jim Blandy's avatar
Jim Blandy committed
766 767 768
    Fprogn (Fcdr (temp));
  UNGCPRO;

769 770 771 772 773
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

774 775 776 777 778
  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
779
  if (!noninteractive && NILP (nomessage))
780
    {
781
      if (!compiled)
782
	message_with_string ("Loading %s (source)...done", file, 1);
783
      else if (newer)
784 785
	message_with_string ("Loading %s (compiled; note, source file is newer)...done",
		 file, 1);
786
      else /* The typical case; compiled file newer than source file.  */
787
	message_with_string ("Loading %s...done", file, 1);
788
    }
Jim Blandy's avatar
Jim Blandy committed
789 790 791 792 793 794 795
  return Qt;
}

static Lisp_Object
load_unwind (stream)  /* used as unwind-protect function in load */
     Lisp_Object stream;
{
796 797
  fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
		    | XFASTINT (XCDR (stream))));
Jim Blandy's avatar
Jim Blandy committed
798 799 800 801
  if (--load_in_progress < 0) load_in_progress = 0;
  return Qnil;
}

802 803 804 805 806
static Lisp_Object
load_descriptor_unwind (oldlist)
     Lisp_Object oldlist;
{
  load_descriptor_list = oldlist;
807
  return Qnil;
808 809 810 811 812 813 814 815
}

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

void
close_load_descs ()
{
816
#ifndef WINDOWSNT
817
  Lisp_Object tail;
818 819
  for (tail = load_descriptor_list; !NILP (tail); tail = XCDR (tail))
    close (XFASTINT (XCAR (tail)));
820
#endif
821
}
Jim Blandy's avatar
Jim Blandy committed
822 823 824 825 826 827

static int
complete_filename_p (pathname)
     Lisp_Object pathname;
{
  register unsigned char *s = XSTRING (pathname)->data;
828 829 830
  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
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
#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.
851 852 853 854 855
   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
856 857 858 859 860 861 862 863 864 865 866 867 868 869

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;
870
  Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
871
  struct stat st;
872
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
873

874
  GCPRO1 (str);
Jim Blandy's avatar
Jim Blandy committed
875 876 877 878 879 880
  if (storeptr)
    *storeptr = Qnil;

  if (complete_filename_p (str))
    absolute = 1;

Jim Blandy's avatar
Jim Blandy committed
881
  for (; !NILP (path); path = Fcdr (path))
Jim Blandy's avatar
Jim Blandy committed
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
    {
      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);
910
	  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
911

912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
	  /* 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
928 929 930
	  if (lsuffix != 0)  /* Bug happens on CCI if lsuffix is 0.  */
	    strncat (fn, nsuffix, lsuffix);

931 932 933 934 935 936
	  /* 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
937
	    {
938 939
	      Lisp_Object string;
	      int exists;
Jim Blandy's avatar
Jim Blandy committed
940

941 942 943 944 945 946 947 948
	      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
949 950 951 952
		{
		  /* We succeeded; return this descriptor and filename.  */
		  if (storeptr)
		    *storeptr = build_string (fn);
953
		  UNGCPRO;
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
		  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
977 978 979 980 981 982 983 984
		}
	    }

	  /* Advance to next suffix.  */
	  if (esuffix == 0)
	    break;
	  nsuffix += lsuffix + 1;
	}
985
      if (absolute)
986
	break;
Jim Blandy's avatar
Jim Blandy committed
987 988
    }

989 990
  UNGCPRO;
  return -1;
Jim Blandy's avatar
Jim Blandy committed
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 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
/* 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;
    }

1054 1055 1056 1057 1058 1059
  /* 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);
1060 1061
}

Jim Blandy's avatar
Jim Blandy committed
1062 1063 1064 1065 1066 1067 1068
Lisp_Object
unreadpure ()	/* Used as unwind-protect function in readevalloop */
{
  read_pure = 0;
  return Qnil;
}

1069 1070 1071 1072 1073 1074 1075 1076 1077
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
1078 1079
   for this invocation.
   READFUN, if non-nil, is used instead of `read'.  */
1080

Jim Blandy's avatar
Jim Blandy committed
1081
static void
1082
readevalloop (readcharfun, stream, sourcename, evalfun, printflag, unibyte, readfun)
Jim Blandy's avatar
Jim Blandy committed
1083
     Lisp_Object readcharfun;
1084 1085
     FILE *stream;
     Lisp_Object sourcename;
Jim Blandy's avatar
Jim Blandy committed
1086 1087
     Lisp_Object (*evalfun) ();
     int printflag;
1088
     Lisp_Object unibyte, readfun;
Jim Blandy's avatar
Jim Blandy committed
1089 1090 1091 1092
{
  register int c;
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;
1093
  struct gcpro gcpro1;
1094 1095 1096 1097 1098 1099
  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
1100 1101

  specbind (Qstandard_input, readcharfun);
1102
  specbind (Qcurrent_load_list, Qnil);
1103 1104
  record_unwind_protect (readevalloop_1, load_convert_to_unibyte ? Qt : Qnil);
  load_convert_to_unibyte = !NILP (unibyte);
Jim Blandy's avatar
Jim Blandy committed
1105

1106
  readchar_backlog = -1;
1107

1108
  GCPRO1 (sourcename);
1109 1110 1111

  LOADHIST_ATTACH (sourcename);

Jim Blandy's avatar
Jim Blandy committed
1112 1113
  while (1)
    {
1114 1115 1116
      if (b != 0 && NILP (b->name))
	error ("Reading from killed buffer");

Jim Blandy's avatar
Jim Blandy committed
1117 1118 1119 1120 1121 1122 1123 1124
      instream = stream;
      c = READCHAR;
      if (c == ';')
	{
	  while ((c = READCHAR) != '\n' && c != -1);
	  continue;
	}
      if (c < 0) break;
1125 1126 1127 1128

      /* 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
1129

Jim Blandy's avatar
Jim Blandy committed
1130
      if (!NILP (Vpurify_flag) && c == '(')
Jim Blandy's avatar
Jim Blandy committed
1131
	{
1132
	  int count1 = specpdl_ptr - specpdl;
Jim Blandy's avatar
Jim Blandy committed
1133 1134
	  record_unwind_protect (unreadpure, Qnil);
	  val = read_list (-1, readcharfun);
1135
	  unbind_to (count1, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1136 1137 1138 1139
	}
      else
	{
	  UNREAD (c);
1140
	  read_objects = Qnil;
1141 1142 1143
	  if (! NILP (readfun))
	    val = <