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

This file is part of GNU Emacs.

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

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

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


Richard M. Stallman's avatar
Richard M. Stallman committed
23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 27
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/file.h>
28
#include <errno.h>
Jim Blandy's avatar
Jim Blandy committed
29
#include "lisp.h"
30
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
31 32 33

#ifndef standalone
#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 "termhooks.h"
Jim Blandy's avatar
Jim Blandy committed
39 40 41 42 43 44
#endif

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

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

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

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

#ifdef LISP_FLOAT_TYPE
#include <math.h>
#endif /* LISP_FLOAT_TYPE */

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

Richard M. Stallman's avatar
Richard M. Stallman committed
68 69 70 71
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

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

80 81
extern int errno;

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
97 98 99
/* Search path for files to be loaded. */
Lisp_Object Vload_path;

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

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

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

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

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

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

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

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

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

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

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

138 139 140
/* List of descriptors now open for Fload.  */
static Lisp_Object load_descriptor_list;

141
/* File for get_file_char to read from.  Use by load.  */
Jim Blandy's avatar
Jim Blandy committed
142 143 144 145 146
static FILE *instream;

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

147
/* For use within read-from-string (this reader is non-reentrant!!)  */
Jim Blandy's avatar
Jim Blandy committed
148
static int read_from_string_index;
149
static int read_from_string_index_byte;
Jim Blandy's avatar
Jim Blandy committed
150
static int read_from_string_limit;
151

152 153 154 155
/* Number of bytes left to read in the buffer character
   that `readchar' has already advanced over.  */
static int readchar_backlog;

156
/* This contains the last string skipped with #@.  */
157 158 159 160 161 162
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.  */
163
static file_offset saved_doc_string_position;
164

165 166 167 168 169 170 171 172 173
/* 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.  */
174
static file_offset prev_saved_doc_string_position;
175

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

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

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

200
  if (BUFFERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
201
    {
202
      register struct buffer *inbuffer = XBUFFER (readcharfun);
Jim Blandy's avatar
Jim Blandy committed
203

204 205
      int pt_byte = BUF_PT_BYTE (inbuffer);
      int orig_pt_byte = pt_byte;
206

207 208 209 210 211 212 213 214
      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);

215 216
      if (pt_byte >= BUF_ZV_BYTE (inbuffer))
	return -1;
Jim Blandy's avatar
Jim Blandy committed
217

218 219
      readchar_backlog = -1;

220 221
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
222 223 224 225 226
	  unsigned char workbuf[4];
	  unsigned char *str = workbuf;
	  int length;

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

	  /* 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--;
	    }
247 248 249 250 251
	}
      else
	{
	  c = BUF_FETCH_BYTE (inbuffer, pt_byte);
	  pt_byte++;
252
	}
253
      SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
254

255
      return c;
Jim Blandy's avatar
Jim Blandy committed
256
    }
257
  if (MARKERP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
258
    {
259
      register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
Jim Blandy's avatar
Jim Blandy committed
260

261 262
      int bytepos = marker_byte_position (readcharfun);
      int orig_bytepos = bytepos;
263

264 265 266 267 268 269 270 271
      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);

272 273
      if (bytepos >= BUF_ZV_BYTE (inbuffer))
	return -1;
274

275 276
      readchar_backlog = -1;

277 278
      if (! NILP (inbuffer->enable_multibyte_characters))
	{
279 280 281 282 283
	  unsigned char workbuf[4];
	  unsigned char *str = workbuf;
	  int length;

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

	  /* 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--;
	    }
304 305 306 307 308
	}
      else
	{
	  c = BUF_FETCH_BYTE (inbuffer, bytepos);
	  bytepos++;
309 310
	}

311 312 313 314
      XMARKER (readcharfun)->bytepos = bytepos;
      XMARKER (readcharfun)->charpos++;

      return c;
Jim Blandy's avatar
Jim Blandy committed
315
    }
316 317 318 319

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

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

334
  if (STRINGP (readcharfun))
Jim Blandy's avatar
Jim Blandy committed
335
    {
336
      if (read_from_string_index >= read_from_string_limit)
Jim Blandy's avatar
Jim Blandy committed
337
	c = -1;
338 339 340 341 342 343
      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++];
344

Jim Blandy's avatar
Jim Blandy committed
345 346 347 348 349
      return c;
    }

  tem = call0 (readcharfun);

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
422

423
/* Get a character from the tty.  */
Jim Blandy's avatar
Jim Blandy committed
424

425 426
extern Lisp_Object read_char ();

427 428 429 430 431 432 433 434 435 436 437 438 439
/* 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
440 441 442 443
   character.

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

445
Lisp_Object
446 447 448
read_filtered_event (no_switch_frame, ascii_required, error_nonascii,
		     input_method)
     int no_switch_frame, ascii_required, error_nonascii, input_method;
449 450 451 452
{
#ifdef standalone
  return make_number (getchar ());
#else
453 454 455
  register Lisp_Object val, delayed_switch_frame;

  delayed_switch_frame = Qnil;
456 457 458

  /* Read until we get an acceptable event.  */
 retry:
459 460 461
  val = read_char (0, 0, 0,
		   (input_method ? Qnil : Qt),
		   0);
462

463
  if (BUFFERP (val))
464 465
    goto retry;

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

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

  return val;
#endif
}

516
DEFUN ("read-char", Fread_char, Sread_char, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
517
  "Read a character from the command input (keyboard or macro).\n\
Jim Blandy's avatar
Jim Blandy committed
518 519
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
520 521 522 523
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\
524 525 526
`read-event' or `read-char-exclusive' instead.\n\
\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 (1, 1, 1, ! NILP (inherit_input_method));
Jim Blandy's avatar
Jim Blandy committed
536 537
}

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

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

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

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

616
  CHECK_STRING (file, 0);
Jim Blandy's avatar
Jim Blandy committed
617

618
  /* If file name is magic, call the handler.  */
619
  handler = Ffind_file_name_handler (file, Qload);
620
  if (!NILP (handler))
621
    return call5 (handler, Qload, file, noerror, nomessage, nosuffix);
622

623 624 625
  /* 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.)  */
626
  file = Fsubstitute_in_file_name (file);
627

Jim Blandy's avatar
Jim Blandy committed
628 629
  /* Avoid weird lossage with null string as arg,
     since it would try to load a directory as a Lisp file */
630
  if (XSTRING (file)->size > 0)
Jim Blandy's avatar
Jim Blandy committed
631
    {
632
      int size = STRING_BYTES (XSTRING (file));
633

634
      GCPRO1 (file);
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650

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

651 652 653 654
      fd = openp (Vload_path, file,
		  (!NILP (nosuffix) ? ""
		   : ! NILP (must_suffix) ? ".elc:.el"
		   : ".elc:.el:"),
Jim Blandy's avatar
Jim Blandy committed
655
		  &found, 0);
656
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
657 658 659 660
    }

  if (fd < 0)
    {
Jim Blandy's avatar
Jim Blandy committed
661
      if (NILP (noerror))
Jim Blandy's avatar
Jim Blandy committed
662 663
	while (1)
	  Fsignal (Qfile_error, Fcons (build_string ("Cannot open load file"),
664
				       Fcons (file, Qnil)));
Jim Blandy's avatar
Jim Blandy committed
665 666 667 668
      else
	return Qnil;
    }

Karl Heuer's avatar
Karl Heuer committed
669 670 671
  if (EQ (Qt, Vuser_init_file))
    Vuser_init_file = found;

672
  /* If FD is 0, that means openp found a magic file.  */
673 674
  if (fd == 0)
    {
675 676 677 678 679 680 681 682 683
      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);
684 685
    }

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

695 696
      compiled = 1;

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

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

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

740 741 742
  if (! NILP (Vpurify_flag))
    Vpreloaded_file_list = Fcons (file, Vpreloaded_file_list);

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

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

  /* Run any load-hooks for this file.  */
769
  temp = Fassoc (file, Vafter_load_alist);
Jim Blandy's avatar
Jim Blandy committed
770
  if (!NILP (temp))
Jim Blandy's avatar
Jim Blandy committed
771 772 773
    Fprogn (Fcdr (temp));
  UNGCPRO;

774 775 776 777 778
  if (saved_doc_string)
    free (saved_doc_string);
  saved_doc_string = 0;
  saved_doc_string_size = 0;

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

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

807 808 809 810 811
static Lisp_Object
load_descriptor_unwind (oldlist)
     Lisp_Object oldlist;
{
  load_descriptor_list = oldlist;
812
  return Qnil;
813 814 815 816 817 818 819 820
}

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

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

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;
875
  Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
876
  struct stat st;
877
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
878

879
  GCPRO1 (str);
Jim Blandy's avatar
Jim Blandy committed
880 881 882 883 884 885
  if (storeptr)
    *storeptr = Qnil;

  if (complete_filename_p (str))
    absolute = 1;

Jim Blandy's avatar
Jim Blandy committed
886
  for (; !NILP (path); path = Fcdr (path))
Jim Blandy's avatar
Jim Blandy committed
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
    {
      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.  */
904
      want_size = strlen (suffix) + STRING_BYTES (XSTRING (filename)) + 1;
Jim Blandy's avatar
Jim Blandy committed
905 906 907 908 909 910 911 912 913 914
      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);
915
	  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
916

917 918 919 920 921 922 923
	  /* 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,
924 925
		       STRING_BYTES (XSTRING (filename)) - 2);
	      fn[STRING_BYTES (XSTRING (filename)) - 2] = 0;
926 927 928
	    }
	  else
	    {
929 930 931
	      strncpy (fn, XSTRING (filename)->data,
		       STRING_BYTES (XSTRING (filename)));
	      fn[STRING_BYTES (XSTRING (filename))] = 0;
932 933
	    }

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

937 938 939 940 941 942
	  /* 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
943
	    {
944 945
	      Lisp_Object string;
	      int exists;
Jim Blandy's avatar
Jim Blandy committed
946

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

		  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
983 984 985 986 987 988 989 990
		}
	    }

	  /* Advance to next suffix.  */
	  if (esuffix == 0)
	    break;
	  nsuffix += lsuffix + 1;
	}
991
      if (absolute)
992
	break;
Jim Blandy's avatar
Jim Blandy committed
993 994
    }

995 996
  UNGCPRO;
  return -1;
Jim Blandy's avatar
Jim Blandy committed
997 998 999
}


1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010