More NEWS copyedits, and some reordering
[emacs.git] / src / lread.c
blobbe7b44e603bad007d3649ddb8b9af31bcf314fb7
1 /* Lisp parsing and input streams.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <stdio.h>
23 #include <sys/types.h>
24 #include <sys/stat.h>
25 #include <sys/file.h>
26 #include <errno.h>
27 #include <limits.h> /* For CHAR_BIT. */
28 #include <stat-time.h>
29 #include "lisp.h"
30 #include "intervals.h"
31 #include "character.h"
32 #include "buffer.h"
33 #include "charset.h"
34 #include "coding.h"
35 #include <epaths.h>
36 #include "commands.h"
37 #include "keyboard.h"
38 #include "frame.h"
39 #include "termhooks.h"
40 #include "coding.h"
41 #include "blockinput.h"
43 #ifdef MSDOS
44 #include "msdos.h"
45 #endif
47 #ifdef HAVE_NS
48 #include "nsterm.h"
49 #endif
51 #include <unistd.h>
53 #ifdef HAVE_SETLOCALE
54 #include <locale.h>
55 #endif /* HAVE_SETLOCALE */
57 #include <fcntl.h>
59 #ifdef HAVE_FSEEKO
60 #define file_offset off_t
61 #define file_tell ftello
62 #else
63 #define file_offset long
64 #define file_tell ftell
65 #endif
67 /* Hash table read constants. */
68 static Lisp_Object Qhash_table, Qdata;
69 static Lisp_Object Qtest, Qsize;
70 static Lisp_Object Qweakness;
71 static Lisp_Object Qrehash_size;
72 static Lisp_Object Qrehash_threshold;
74 static Lisp_Object Qread_char, Qget_file_char, Qcurrent_load_list;
75 Lisp_Object Qstandard_input;
76 Lisp_Object Qvariable_documentation;
77 static Lisp_Object Qascii_character, Qload, Qload_file_name;
78 Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
79 static Lisp_Object Qinhibit_file_name_operation;
80 static Lisp_Object Qeval_buffer_list;
81 Lisp_Object Qlexical_binding;
82 static Lisp_Object Qfile_truename, Qdo_after_load_evaluation; /* ACM 2006/5/16 */
84 /* Used instead of Qget_file_char while loading *.elc files compiled
85 by Emacs 21 or older. */
86 static Lisp_Object Qget_emacs_mule_file_char;
88 static Lisp_Object Qload_force_doc_strings;
90 static Lisp_Object Qload_in_progress;
92 /* The association list of objects read with the #n=object form.
93 Each member of the list has the form (n . object), and is used to
94 look up the object for the corresponding #n# construct.
95 It must be set to nil before all top-level calls to read0. */
96 static Lisp_Object read_objects;
98 /* True means READCHAR should read bytes one by one (not character)
99 when READCHARFUN is Qget_file_char or Qget_emacs_mule_file_char.
100 This is set by read1 temporarily while handling #@NUMBER. */
101 static bool load_each_byte;
103 /* List of descriptors now open for Fload. */
104 static Lisp_Object load_descriptor_list;
106 /* File for get_file_char to read from. Use by load. */
107 static FILE *instream;
109 /* For use within read-from-string (this reader is non-reentrant!!) */
110 static ptrdiff_t read_from_string_index;
111 static ptrdiff_t read_from_string_index_byte;
112 static ptrdiff_t read_from_string_limit;
114 /* Number of characters read in the current call to Fread or
115 Fread_from_string. */
116 static EMACS_INT readchar_count;
118 /* This contains the last string skipped with #@. */
119 static char *saved_doc_string;
120 /* Length of buffer allocated in saved_doc_string. */
121 static ptrdiff_t saved_doc_string_size;
122 /* Length of actual data in saved_doc_string. */
123 static ptrdiff_t saved_doc_string_length;
124 /* This is the file position that string came from. */
125 static file_offset saved_doc_string_position;
127 /* This contains the previous string skipped with #@.
128 We copy it from saved_doc_string when a new string
129 is put in saved_doc_string. */
130 static char *prev_saved_doc_string;
131 /* Length of buffer allocated in prev_saved_doc_string. */
132 static ptrdiff_t prev_saved_doc_string_size;
133 /* Length of actual data in prev_saved_doc_string. */
134 static ptrdiff_t prev_saved_doc_string_length;
135 /* This is the file position that string came from. */
136 static file_offset prev_saved_doc_string_position;
138 /* True means inside a new-style backquote
139 with no surrounding parentheses.
140 Fread initializes this to false, so we need not specbind it
141 or worry about what happens to it when there is an error. */
142 static bool new_backquote_flag;
143 static Lisp_Object Qold_style_backquotes;
145 /* A list of file names for files being loaded in Fload. Used to
146 check for recursive loads. */
148 static Lisp_Object Vloads_in_progress;
150 static int read_emacs_mule_char (int, int (*) (int, Lisp_Object),
151 Lisp_Object);
153 static void readevalloop (Lisp_Object, FILE *, Lisp_Object, bool,
154 Lisp_Object, Lisp_Object,
155 Lisp_Object, Lisp_Object);
156 static Lisp_Object load_unwind (Lisp_Object);
157 static Lisp_Object load_descriptor_unwind (Lisp_Object);
159 /* Functions that read one byte from the current source READCHARFUN
160 or unreads one byte. If the integer argument C is -1, it returns
161 one read byte, or -1 when there's no more byte in the source. If C
162 is 0 or positive, it unreads C, and the return value is not
163 interesting. */
165 static int readbyte_for_lambda (int, Lisp_Object);
166 static int readbyte_from_file (int, Lisp_Object);
167 static int readbyte_from_string (int, Lisp_Object);
169 /* Handle unreading and rereading of characters.
170 Write READCHAR to read a character,
171 UNREAD(c) to unread c to be read again.
173 These macros correctly read/unread multibyte characters. */
175 #define READCHAR readchar (readcharfun, NULL)
176 #define UNREAD(c) unreadchar (readcharfun, c)
178 /* Same as READCHAR but set *MULTIBYTE to the multibyteness of the source. */
179 #define READCHAR_REPORT_MULTIBYTE(multibyte) readchar (readcharfun, multibyte)
181 /* When READCHARFUN is Qget_file_char, Qget_emacs_mule_file_char,
182 Qlambda, or a cons, we use this to keep an unread character because
183 a file stream can't handle multibyte-char unreading. The value -1
184 means that there's no unread character. */
185 static int unread_char;
187 static int
188 readchar (Lisp_Object readcharfun, bool *multibyte)
190 Lisp_Object tem;
191 register int c;
192 int (*readbyte) (int, Lisp_Object);
193 unsigned char buf[MAX_MULTIBYTE_LENGTH];
194 int i, len;
195 bool emacs_mule_encoding = 0;
197 if (multibyte)
198 *multibyte = 0;
200 readchar_count++;
202 if (BUFFERP (readcharfun))
204 register struct buffer *inbuffer = XBUFFER (readcharfun);
206 ptrdiff_t pt_byte = BUF_PT_BYTE (inbuffer);
208 if (pt_byte >= BUF_ZV_BYTE (inbuffer))
209 return -1;
211 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
213 /* Fetch the character code from the buffer. */
214 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, pt_byte);
215 BUF_INC_POS (inbuffer, pt_byte);
216 c = STRING_CHAR (p);
217 if (multibyte)
218 *multibyte = 1;
220 else
222 c = BUF_FETCH_BYTE (inbuffer, pt_byte);
223 if (! ASCII_BYTE_P (c))
224 c = BYTE8_TO_CHAR (c);
225 pt_byte++;
227 SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
229 return c;
231 if (MARKERP (readcharfun))
233 register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
235 ptrdiff_t bytepos = marker_byte_position (readcharfun);
237 if (bytepos >= BUF_ZV_BYTE (inbuffer))
238 return -1;
240 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
242 /* Fetch the character code from the buffer. */
243 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, bytepos);
244 BUF_INC_POS (inbuffer, bytepos);
245 c = STRING_CHAR (p);
246 if (multibyte)
247 *multibyte = 1;
249 else
251 c = BUF_FETCH_BYTE (inbuffer, bytepos);
252 if (! ASCII_BYTE_P (c))
253 c = BYTE8_TO_CHAR (c);
254 bytepos++;
257 XMARKER (readcharfun)->bytepos = bytepos;
258 XMARKER (readcharfun)->charpos++;
260 return c;
263 if (EQ (readcharfun, Qlambda))
265 readbyte = readbyte_for_lambda;
266 goto read_multibyte;
269 if (EQ (readcharfun, Qget_file_char))
271 readbyte = readbyte_from_file;
272 goto read_multibyte;
275 if (STRINGP (readcharfun))
277 if (read_from_string_index >= read_from_string_limit)
278 c = -1;
279 else if (STRING_MULTIBYTE (readcharfun))
281 if (multibyte)
282 *multibyte = 1;
283 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, readcharfun,
284 read_from_string_index,
285 read_from_string_index_byte);
287 else
289 c = SREF (readcharfun, read_from_string_index_byte);
290 read_from_string_index++;
291 read_from_string_index_byte++;
293 return c;
296 if (CONSP (readcharfun))
298 /* This is the case that read_vector is reading from a unibyte
299 string that contains a byte sequence previously skipped
300 because of #@NUMBER. The car part of readcharfun is that
301 string, and the cdr part is a value of readcharfun given to
302 read_vector. */
303 readbyte = readbyte_from_string;
304 if (EQ (XCDR (readcharfun), Qget_emacs_mule_file_char))
305 emacs_mule_encoding = 1;
306 goto read_multibyte;
309 if (EQ (readcharfun, Qget_emacs_mule_file_char))
311 readbyte = readbyte_from_file;
312 emacs_mule_encoding = 1;
313 goto read_multibyte;
316 tem = call0 (readcharfun);
318 if (NILP (tem))
319 return -1;
320 return XINT (tem);
322 read_multibyte:
323 if (unread_char >= 0)
325 c = unread_char;
326 unread_char = -1;
327 return c;
329 c = (*readbyte) (-1, readcharfun);
330 if (c < 0 || load_each_byte)
331 return c;
332 if (multibyte)
333 *multibyte = 1;
334 if (ASCII_BYTE_P (c))
335 return c;
336 if (emacs_mule_encoding)
337 return read_emacs_mule_char (c, readbyte, readcharfun);
338 i = 0;
339 buf[i++] = c;
340 len = BYTES_BY_CHAR_HEAD (c);
341 while (i < len)
343 c = (*readbyte) (-1, readcharfun);
344 if (c < 0 || ! TRAILING_CODE_P (c))
346 while (--i > 1)
347 (*readbyte) (buf[i], readcharfun);
348 return BYTE8_TO_CHAR (buf[0]);
350 buf[i++] = c;
352 return STRING_CHAR (buf);
355 /* Unread the character C in the way appropriate for the stream READCHARFUN.
356 If the stream is a user function, call it with the char as argument. */
358 static void
359 unreadchar (Lisp_Object readcharfun, int c)
361 readchar_count--;
362 if (c == -1)
363 /* Don't back up the pointer if we're unreading the end-of-input mark,
364 since readchar didn't advance it when we read it. */
366 else if (BUFFERP (readcharfun))
368 struct buffer *b = XBUFFER (readcharfun);
369 ptrdiff_t charpos = BUF_PT (b);
370 ptrdiff_t bytepos = BUF_PT_BYTE (b);
372 if (! NILP (BVAR (b, enable_multibyte_characters)))
373 BUF_DEC_POS (b, bytepos);
374 else
375 bytepos--;
377 SET_BUF_PT_BOTH (b, charpos - 1, bytepos);
379 else if (MARKERP (readcharfun))
381 struct buffer *b = XMARKER (readcharfun)->buffer;
382 ptrdiff_t bytepos = XMARKER (readcharfun)->bytepos;
384 XMARKER (readcharfun)->charpos--;
385 if (! NILP (BVAR (b, enable_multibyte_characters)))
386 BUF_DEC_POS (b, bytepos);
387 else
388 bytepos--;
390 XMARKER (readcharfun)->bytepos = bytepos;
392 else if (STRINGP (readcharfun))
394 read_from_string_index--;
395 read_from_string_index_byte
396 = string_char_to_byte (readcharfun, read_from_string_index);
398 else if (CONSP (readcharfun))
400 unread_char = c;
402 else if (EQ (readcharfun, Qlambda))
404 unread_char = c;
406 else if (EQ (readcharfun, Qget_file_char)
407 || EQ (readcharfun, Qget_emacs_mule_file_char))
409 if (load_each_byte)
411 block_input ();
412 ungetc (c, instream);
413 unblock_input ();
415 else
416 unread_char = c;
418 else
419 call1 (readcharfun, make_number (c));
422 static int
423 readbyte_for_lambda (int c, Lisp_Object readcharfun)
425 return read_bytecode_char (c >= 0);
429 static int
430 readbyte_from_file (int c, Lisp_Object readcharfun)
432 if (c >= 0)
434 block_input ();
435 ungetc (c, instream);
436 unblock_input ();
437 return 0;
440 block_input ();
441 c = getc (instream);
443 #ifdef EINTR
444 /* Interrupted reads have been observed while reading over the network. */
445 while (c == EOF && ferror (instream) && errno == EINTR)
447 unblock_input ();
448 QUIT;
449 block_input ();
450 clearerr (instream);
451 c = getc (instream);
453 #endif
455 unblock_input ();
457 return (c == EOF ? -1 : c);
460 static int
461 readbyte_from_string (int c, Lisp_Object readcharfun)
463 Lisp_Object string = XCAR (readcharfun);
465 if (c >= 0)
467 read_from_string_index--;
468 read_from_string_index_byte
469 = string_char_to_byte (string, read_from_string_index);
472 if (read_from_string_index >= read_from_string_limit)
473 c = -1;
474 else
475 FETCH_STRING_CHAR_ADVANCE (c, string,
476 read_from_string_index,
477 read_from_string_index_byte);
478 return c;
482 /* Read one non-ASCII character from INSTREAM. The character is
483 encoded in `emacs-mule' and the first byte is already read in
484 C. */
486 static int
487 read_emacs_mule_char (int c, int (*readbyte) (int, Lisp_Object), Lisp_Object readcharfun)
489 /* Emacs-mule coding uses at most 4-byte for one character. */
490 unsigned char buf[4];
491 int len = emacs_mule_bytes[c];
492 struct charset *charset;
493 int i;
494 unsigned code;
496 if (len == 1)
497 /* C is not a valid leading-code of `emacs-mule'. */
498 return BYTE8_TO_CHAR (c);
500 i = 0;
501 buf[i++] = c;
502 while (i < len)
504 c = (*readbyte) (-1, readcharfun);
505 if (c < 0xA0)
507 while (--i > 1)
508 (*readbyte) (buf[i], readcharfun);
509 return BYTE8_TO_CHAR (buf[0]);
511 buf[i++] = c;
514 if (len == 2)
516 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
517 code = buf[1] & 0x7F;
519 else if (len == 3)
521 if (buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_11
522 || buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_12)
524 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
525 code = buf[2] & 0x7F;
527 else
529 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
530 code = ((buf[1] << 8) | buf[2]) & 0x7F7F;
533 else
535 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
536 code = ((buf[2] << 8) | buf[3]) & 0x7F7F;
538 c = DECODE_CHAR (charset, code);
539 if (c < 0)
540 Fsignal (Qinvalid_read_syntax,
541 Fcons (build_string ("invalid multibyte form"), Qnil));
542 return c;
546 static Lisp_Object read_internal_start (Lisp_Object, Lisp_Object,
547 Lisp_Object);
548 static Lisp_Object read0 (Lisp_Object);
549 static Lisp_Object read1 (Lisp_Object, int *, bool);
551 static Lisp_Object read_list (bool, Lisp_Object);
552 static Lisp_Object read_vector (Lisp_Object, bool);
554 static Lisp_Object substitute_object_recurse (Lisp_Object, Lisp_Object,
555 Lisp_Object);
556 static void substitute_object_in_subtree (Lisp_Object,
557 Lisp_Object);
558 static void substitute_in_interval (INTERVAL, Lisp_Object);
561 /* Get a character from the tty. */
563 /* Read input events until we get one that's acceptable for our purposes.
565 If NO_SWITCH_FRAME, switch-frame events are stashed
566 until we get a character we like, and then stuffed into
567 unread_switch_frame.
569 If ASCII_REQUIRED, check function key events to see
570 if the unmodified version of the symbol has a Qascii_character
571 property, and use that character, if present.
573 If ERROR_NONASCII, signal an error if the input we
574 get isn't an ASCII character with modifiers. If it's false but
575 ASCII_REQUIRED is true, just re-read until we get an ASCII
576 character.
578 If INPUT_METHOD, invoke the current input method
579 if the character warrants that.
581 If SECONDS is a number, wait that many seconds for input, and
582 return Qnil if no input arrives within that time. */
584 static Lisp_Object
585 read_filtered_event (bool no_switch_frame, bool ascii_required,
586 bool error_nonascii, bool input_method, Lisp_Object seconds)
588 Lisp_Object val, delayed_switch_frame;
589 EMACS_TIME end_time;
591 #ifdef HAVE_WINDOW_SYSTEM
592 if (display_hourglass_p)
593 cancel_hourglass ();
594 #endif
596 delayed_switch_frame = Qnil;
598 /* Compute timeout. */
599 if (NUMBERP (seconds))
601 double duration = extract_float (seconds);
602 EMACS_TIME wait_time = EMACS_TIME_FROM_DOUBLE (duration);
603 end_time = add_emacs_time (current_emacs_time (), wait_time);
606 /* Read until we get an acceptable event. */
607 retry:
609 val = read_char (0, 0, 0, (input_method ? Qnil : Qt), 0,
610 NUMBERP (seconds) ? &end_time : NULL);
611 while (INTEGERP (val) && XINT (val) == -2); /* wrong_kboard_jmpbuf */
613 if (BUFFERP (val))
614 goto retry;
616 /* switch-frame events are put off until after the next ASCII
617 character. This is better than signaling an error just because
618 the last characters were typed to a separate minibuffer frame,
619 for example. Eventually, some code which can deal with
620 switch-frame events will read it and process it. */
621 if (no_switch_frame
622 && EVENT_HAS_PARAMETERS (val)
623 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (val)), Qswitch_frame))
625 delayed_switch_frame = val;
626 goto retry;
629 if (ascii_required && !(NUMBERP (seconds) && NILP (val)))
631 /* Convert certain symbols to their ASCII equivalents. */
632 if (SYMBOLP (val))
634 Lisp_Object tem, tem1;
635 tem = Fget (val, Qevent_symbol_element_mask);
636 if (!NILP (tem))
638 tem1 = Fget (Fcar (tem), Qascii_character);
639 /* Merge this symbol's modifier bits
640 with the ASCII equivalent of its basic code. */
641 if (!NILP (tem1))
642 XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
646 /* If we don't have a character now, deal with it appropriately. */
647 if (!INTEGERP (val))
649 if (error_nonascii)
651 Vunread_command_events = Fcons (val, Qnil);
652 error ("Non-character input-event");
654 else
655 goto retry;
659 if (! NILP (delayed_switch_frame))
660 unread_switch_frame = delayed_switch_frame;
662 #if 0
664 #ifdef HAVE_WINDOW_SYSTEM
665 if (display_hourglass_p)
666 start_hourglass ();
667 #endif
669 #endif
671 return val;
674 DEFUN ("read-char", Fread_char, Sread_char, 0, 3, 0,
675 doc: /* Read a character from the command input (keyboard or macro).
676 It is returned as a number.
677 If the character has modifiers, they are resolved and reflected to the
678 character code if possible (e.g. C-SPC -> 0).
680 If the user generates an event which is not a character (i.e. a mouse
681 click or function key event), `read-char' signals an error. As an
682 exception, switch-frame events are put off until non-character events
683 can be read.
684 If you want to read non-character events, or ignore them, call
685 `read-event' or `read-char-exclusive' instead.
687 If the optional argument PROMPT is non-nil, display that as a prompt.
688 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
689 input method is turned on in the current buffer, that input method
690 is used for reading a character.
691 If the optional argument SECONDS is non-nil, it should be a number
692 specifying the maximum number of seconds to wait for input. If no
693 input arrives in that time, return nil. SECONDS may be a
694 floating-point value. */)
695 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
697 Lisp_Object val;
699 if (! NILP (prompt))
700 message_with_string ("%s", prompt, 0);
701 val = read_filtered_event (1, 1, 1, ! NILP (inherit_input_method), seconds);
703 return (NILP (val) ? Qnil
704 : make_number (char_resolve_modifier_mask (XINT (val))));
707 DEFUN ("read-event", Fread_event, Sread_event, 0, 3, 0,
708 doc: /* Read an event object from the input stream.
709 If the optional argument PROMPT is non-nil, display that as a prompt.
710 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
711 input method is turned on in the current buffer, that input method
712 is used for reading a character.
713 If the optional argument SECONDS is non-nil, it should be a number
714 specifying the maximum number of seconds to wait for input. If no
715 input arrives in that time, return nil. SECONDS may be a
716 floating-point value. */)
717 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
719 if (! NILP (prompt))
720 message_with_string ("%s", prompt, 0);
721 return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method), seconds);
724 DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 3, 0,
725 doc: /* Read a character from the command input (keyboard or macro).
726 It is returned as a number. Non-character events are ignored.
727 If the character has modifiers, they are resolved and reflected to the
728 character code if possible (e.g. C-SPC -> 0).
730 If the optional argument PROMPT is non-nil, display that as a prompt.
731 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
732 input method is turned on in the current buffer, that input method
733 is used for reading a character.
734 If the optional argument SECONDS is non-nil, it should be a number
735 specifying the maximum number of seconds to wait for input. If no
736 input arrives in that time, return nil. SECONDS may be a
737 floating-point value. */)
738 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
740 Lisp_Object val;
742 if (! NILP (prompt))
743 message_with_string ("%s", prompt, 0);
745 val = read_filtered_event (1, 1, 0, ! NILP (inherit_input_method), seconds);
747 return (NILP (val) ? Qnil
748 : make_number (char_resolve_modifier_mask (XINT (val))));
751 DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
752 doc: /* Don't use this yourself. */)
753 (void)
755 register Lisp_Object val;
756 block_input ();
757 XSETINT (val, getc (instream));
758 unblock_input ();
759 return val;
765 /* Return true if the lisp code read using READCHARFUN defines a non-nil
766 `lexical-binding' file variable. After returning, the stream is
767 positioned following the first line, if it is a comment or #! line,
768 otherwise nothing is read. */
770 static bool
771 lisp_file_lexically_bound_p (Lisp_Object readcharfun)
773 int ch = READCHAR;
775 if (ch == '#')
777 ch = READCHAR;
778 if (ch != '!')
780 UNREAD (ch);
781 UNREAD ('#');
782 return 0;
784 while (ch != '\n' && ch != EOF)
785 ch = READCHAR;
786 if (ch == '\n') ch = READCHAR;
787 /* It is OK to leave the position after a #! line, since
788 that is what read1 does. */
791 if (ch != ';')
792 /* The first line isn't a comment, just give up. */
794 UNREAD (ch);
795 return 0;
797 else
798 /* Look for an appropriate file-variable in the first line. */
800 bool rv = 0;
801 enum {
802 NOMINAL, AFTER_FIRST_DASH, AFTER_ASTERIX,
803 } beg_end_state = NOMINAL;
804 bool in_file_vars = 0;
806 #define UPDATE_BEG_END_STATE(ch) \
807 if (beg_end_state == NOMINAL) \
808 beg_end_state = (ch == '-' ? AFTER_FIRST_DASH : NOMINAL); \
809 else if (beg_end_state == AFTER_FIRST_DASH) \
810 beg_end_state = (ch == '*' ? AFTER_ASTERIX : NOMINAL); \
811 else if (beg_end_state == AFTER_ASTERIX) \
813 if (ch == '-') \
814 in_file_vars = !in_file_vars; \
815 beg_end_state = NOMINAL; \
818 /* Skip until we get to the file vars, if any. */
821 ch = READCHAR;
822 UPDATE_BEG_END_STATE (ch);
824 while (!in_file_vars && ch != '\n' && ch != EOF);
826 while (in_file_vars)
828 char var[100], val[100];
829 unsigned i;
831 ch = READCHAR;
833 /* Read a variable name. */
834 while (ch == ' ' || ch == '\t')
835 ch = READCHAR;
837 i = 0;
838 while (ch != ':' && ch != '\n' && ch != EOF && in_file_vars)
840 if (i < sizeof var - 1)
841 var[i++] = ch;
842 UPDATE_BEG_END_STATE (ch);
843 ch = READCHAR;
846 /* Stop scanning if no colon was found before end marker. */
847 if (!in_file_vars || ch == '\n' || ch == EOF)
848 break;
850 while (i > 0 && (var[i - 1] == ' ' || var[i - 1] == '\t'))
851 i--;
852 var[i] = '\0';
854 if (ch == ':')
856 /* Read a variable value. */
857 ch = READCHAR;
859 while (ch == ' ' || ch == '\t')
860 ch = READCHAR;
862 i = 0;
863 while (ch != ';' && ch != '\n' && ch != EOF && in_file_vars)
865 if (i < sizeof val - 1)
866 val[i++] = ch;
867 UPDATE_BEG_END_STATE (ch);
868 ch = READCHAR;
870 if (! in_file_vars)
871 /* The value was terminated by an end-marker, which remove. */
872 i -= 3;
873 while (i > 0 && (val[i - 1] == ' ' || val[i - 1] == '\t'))
874 i--;
875 val[i] = '\0';
877 if (strcmp (var, "lexical-binding") == 0)
878 /* This is it... */
880 rv = (strcmp (val, "nil") != 0);
881 break;
886 while (ch != '\n' && ch != EOF)
887 ch = READCHAR;
889 return rv;
893 /* Value is a version number of byte compiled code if the file
894 associated with file descriptor FD is a compiled Lisp file that's
895 safe to load. Only files compiled with Emacs are safe to load.
896 Files compiled with XEmacs can lead to a crash in Fbyte_code
897 because of an incompatible change in the byte compiler. */
899 static int
900 safe_to_load_version (int fd)
902 char buf[512];
903 int nbytes, i;
904 int version = 1;
906 /* Read the first few bytes from the file, and look for a line
907 specifying the byte compiler version used. */
908 nbytes = emacs_read (fd, buf, sizeof buf);
909 if (nbytes > 0)
911 /* Skip to the next newline, skipping over the initial `ELC'
912 with NUL bytes following it, but note the version. */
913 for (i = 0; i < nbytes && buf[i] != '\n'; ++i)
914 if (i == 4)
915 version = buf[i];
917 if (i >= nbytes
918 || fast_c_string_match_ignore_case (Vbytecomp_version_regexp,
919 buf + i, nbytes - i) < 0)
920 version = 0;
923 lseek (fd, 0, SEEK_SET);
924 return version;
928 /* Callback for record_unwind_protect. Restore the old load list OLD,
929 after loading a file successfully. */
931 static Lisp_Object
932 record_load_unwind (Lisp_Object old)
934 return Vloads_in_progress = old;
937 /* This handler function is used via internal_condition_case_1. */
939 static Lisp_Object
940 load_error_handler (Lisp_Object data)
942 return Qnil;
945 static Lisp_Object
946 load_warn_old_style_backquotes (Lisp_Object file)
948 if (!NILP (Vold_style_backquotes))
950 Lisp_Object args[2];
951 args[0] = build_string ("Loading `%s': old-style backquotes detected!");
952 args[1] = file;
953 Fmessage (2, args);
955 return Qnil;
958 DEFUN ("get-load-suffixes", Fget_load_suffixes, Sget_load_suffixes, 0, 0, 0,
959 doc: /* Return the suffixes that `load' should try if a suffix is \
960 required.
961 This uses the variables `load-suffixes' and `load-file-rep-suffixes'. */)
962 (void)
964 Lisp_Object lst = Qnil, suffixes = Vload_suffixes, suffix, ext;
965 while (CONSP (suffixes))
967 Lisp_Object exts = Vload_file_rep_suffixes;
968 suffix = XCAR (suffixes);
969 suffixes = XCDR (suffixes);
970 while (CONSP (exts))
972 ext = XCAR (exts);
973 exts = XCDR (exts);
974 lst = Fcons (concat2 (suffix, ext), lst);
977 return Fnreverse (lst);
980 DEFUN ("load", Fload, Sload, 1, 5, 0,
981 doc: /* Execute a file of Lisp code named FILE.
982 First try FILE with `.elc' appended, then try with `.el',
983 then try FILE unmodified (the exact suffixes in the exact order are
984 determined by `load-suffixes'). Environment variable references in
985 FILE are replaced with their values by calling `substitute-in-file-name'.
986 This function searches the directories in `load-path'.
988 If optional second arg NOERROR is non-nil,
989 report no error if FILE doesn't exist.
990 Print messages at start and end of loading unless
991 optional third arg NOMESSAGE is non-nil (but `force-load-messages'
992 overrides that).
993 If optional fourth arg NOSUFFIX is non-nil, don't try adding
994 suffixes `.elc' or `.el' to the specified name FILE.
995 If optional fifth arg MUST-SUFFIX is non-nil, insist on
996 the suffix `.elc' or `.el'; don't accept just FILE unless
997 it ends in one of those suffixes or includes a directory name.
999 If NOSUFFIX is nil, then if a file could not be found, try looking for
1000 a different representation of the file by adding non-empty suffixes to
1001 its name, before trying another file. Emacs uses this feature to find
1002 compressed versions of files when Auto Compression mode is enabled.
1003 If NOSUFFIX is non-nil, disable this feature.
1005 The suffixes that this function tries out, when NOSUFFIX is nil, are
1006 given by the return value of `get-load-suffixes' and the values listed
1007 in `load-file-rep-suffixes'. If MUST-SUFFIX is non-nil, only the
1008 return value of `get-load-suffixes' is used, i.e. the file name is
1009 required to have a non-empty suffix.
1011 Loading a file records its definitions, and its `provide' and
1012 `require' calls, in an element of `load-history' whose
1013 car is the file name loaded. See `load-history'.
1015 While the file is in the process of being loaded, the variable
1016 `load-in-progress' is non-nil and the variable `load-file-name'
1017 is bound to the file's name.
1019 Return t if the file exists and loads successfully. */)
1020 (Lisp_Object file, Lisp_Object noerror, Lisp_Object nomessage, Lisp_Object nosuffix, Lisp_Object must_suffix)
1022 register FILE *stream;
1023 register int fd = -1;
1024 ptrdiff_t count = SPECPDL_INDEX ();
1025 struct gcpro gcpro1, gcpro2, gcpro3;
1026 Lisp_Object found, efound, hist_file_name;
1027 /* True means we printed the ".el is newer" message. */
1028 bool newer = 0;
1029 /* True means we are loading a compiled file. */
1030 bool compiled = 0;
1031 Lisp_Object handler;
1032 bool safe_p = 1;
1033 const char *fmode = "r";
1034 Lisp_Object tmp[2];
1035 int version;
1037 #ifdef DOS_NT
1038 fmode = "rt";
1039 #endif /* DOS_NT */
1041 CHECK_STRING (file);
1043 /* If file name is magic, call the handler. */
1044 /* This shouldn't be necessary any more now that `openp' handles it right.
1045 handler = Ffind_file_name_handler (file, Qload);
1046 if (!NILP (handler))
1047 return call5 (handler, Qload, file, noerror, nomessage, nosuffix); */
1049 /* Do this after the handler to avoid
1050 the need to gcpro noerror, nomessage and nosuffix.
1051 (Below here, we care only whether they are nil or not.)
1052 The presence of this call is the result of a historical accident:
1053 it used to be in every file-operation and when it got removed
1054 everywhere, it accidentally stayed here. Since then, enough people
1055 supposedly have things like (load "$PROJECT/foo.el") in their .emacs
1056 that it seemed risky to remove. */
1057 if (! NILP (noerror))
1059 file = internal_condition_case_1 (Fsubstitute_in_file_name, file,
1060 Qt, load_error_handler);
1061 if (NILP (file))
1062 return Qnil;
1064 else
1065 file = Fsubstitute_in_file_name (file);
1068 /* Avoid weird lossage with null string as arg,
1069 since it would try to load a directory as a Lisp file. */
1070 if (SBYTES (file) > 0)
1072 ptrdiff_t size = SBYTES (file);
1074 found = Qnil;
1075 GCPRO2 (file, found);
1077 if (! NILP (must_suffix))
1079 /* Don't insist on adding a suffix if FILE already ends with one. */
1080 if (size > 3
1081 && !strcmp (SSDATA (file) + size - 3, ".el"))
1082 must_suffix = Qnil;
1083 else if (size > 4
1084 && !strcmp (SSDATA (file) + size - 4, ".elc"))
1085 must_suffix = Qnil;
1086 /* Don't insist on adding a suffix
1087 if the argument includes a directory name. */
1088 else if (! NILP (Ffile_name_directory (file)))
1089 must_suffix = Qnil;
1092 fd = openp (Vload_path, file,
1093 (!NILP (nosuffix) ? Qnil
1094 : !NILP (must_suffix) ? Fget_load_suffixes ()
1095 : Fappend (2, (tmp[0] = Fget_load_suffixes (),
1096 tmp[1] = Vload_file_rep_suffixes,
1097 tmp))),
1098 &found, Qnil);
1099 UNGCPRO;
1102 if (fd == -1)
1104 if (NILP (noerror))
1105 xsignal2 (Qfile_error, build_string ("Cannot open load file"), file);
1106 return Qnil;
1109 /* Tell startup.el whether or not we found the user's init file. */
1110 if (EQ (Qt, Vuser_init_file))
1111 Vuser_init_file = found;
1113 /* If FD is -2, that means openp found a magic file. */
1114 if (fd == -2)
1116 if (NILP (Fequal (found, file)))
1117 /* If FOUND is a different file name from FILE,
1118 find its handler even if we have already inhibited
1119 the `load' operation on FILE. */
1120 handler = Ffind_file_name_handler (found, Qt);
1121 else
1122 handler = Ffind_file_name_handler (found, Qload);
1123 if (! NILP (handler))
1124 return call5 (handler, Qload, found, noerror, nomessage, Qt);
1125 #ifdef DOS_NT
1126 /* Tramp has to deal with semi-broken packages that prepend
1127 drive letters to remote files. For that reason, Tramp
1128 catches file operations that test for file existence, which
1129 makes openp think X:/foo.elc files are remote. However,
1130 Tramp does not catch `load' operations for such files, so we
1131 end up with a nil as the `load' handler above. If we would
1132 continue with fd = -2, we will behave wrongly, and in
1133 particular try reading a .elc file in the "rt" mode instead
1134 of "rb". See bug #9311 for the results. To work around
1135 this, we try to open the file locally, and go with that if it
1136 succeeds. */
1137 fd = emacs_open (SSDATA (ENCODE_FILE (found)), O_RDONLY, 0);
1138 if (fd == -1)
1139 fd = -2;
1140 #endif
1143 /* Check if we're stuck in a recursive load cycle.
1145 2000-09-21: It's not possible to just check for the file loaded
1146 being a member of Vloads_in_progress. This fails because of the
1147 way the byte compiler currently works; `provide's are not
1148 evaluated, see font-lock.el/jit-lock.el as an example. This
1149 leads to a certain amount of ``normal'' recursion.
1151 Also, just loading a file recursively is not always an error in
1152 the general case; the second load may do something different. */
1154 int load_count = 0;
1155 Lisp_Object tem;
1156 for (tem = Vloads_in_progress; CONSP (tem); tem = XCDR (tem))
1157 if (!NILP (Fequal (found, XCAR (tem))) && (++load_count > 3))
1159 if (fd >= 0)
1160 emacs_close (fd);
1161 signal_error ("Recursive load", Fcons (found, Vloads_in_progress));
1163 record_unwind_protect (record_load_unwind, Vloads_in_progress);
1164 Vloads_in_progress = Fcons (found, Vloads_in_progress);
1167 /* All loads are by default dynamic, unless the file itself specifies
1168 otherwise using a file-variable in the first line. This is bound here
1169 so that it takes effect whether or not we use
1170 Vload_source_file_function. */
1171 specbind (Qlexical_binding, Qnil);
1173 /* Get the name for load-history. */
1174 hist_file_name = (! NILP (Vpurify_flag)
1175 ? Fconcat (2, (tmp[0] = Ffile_name_directory (file),
1176 tmp[1] = Ffile_name_nondirectory (found),
1177 tmp))
1178 : found) ;
1180 version = -1;
1182 /* Check for the presence of old-style quotes and warn about them. */
1183 specbind (Qold_style_backquotes, Qnil);
1184 record_unwind_protect (load_warn_old_style_backquotes, file);
1186 if (!memcmp (SDATA (found) + SBYTES (found) - 4, ".elc", 4)
1187 || (fd >= 0 && (version = safe_to_load_version (fd)) > 0))
1188 /* Load .elc files directly, but not when they are
1189 remote and have no handler! */
1191 if (fd != -2)
1193 struct stat s1, s2;
1194 int result;
1196 GCPRO3 (file, found, hist_file_name);
1198 if (version < 0
1199 && ! (version = safe_to_load_version (fd)))
1201 safe_p = 0;
1202 if (!load_dangerous_libraries)
1204 if (fd >= 0)
1205 emacs_close (fd);
1206 error ("File `%s' was not compiled in Emacs",
1207 SDATA (found));
1209 else if (!NILP (nomessage) && !force_load_messages)
1210 message_with_string ("File `%s' not compiled in Emacs", found, 1);
1213 compiled = 1;
1215 efound = ENCODE_FILE (found);
1217 #ifdef DOS_NT
1218 fmode = "rb";
1219 #endif /* DOS_NT */
1220 result = stat (SSDATA (efound), &s1);
1221 if (result == 0)
1223 SSET (efound, SBYTES (efound) - 1, 0);
1224 result = stat (SSDATA (efound), &s2);
1225 SSET (efound, SBYTES (efound) - 1, 'c');
1228 if (result == 0
1229 && EMACS_TIME_LT (get_stat_mtime (&s1), get_stat_mtime (&s2)))
1231 /* Make the progress messages mention that source is newer. */
1232 newer = 1;
1234 /* If we won't print another message, mention this anyway. */
1235 if (!NILP (nomessage) && !force_load_messages)
1237 Lisp_Object msg_file;
1238 msg_file = Fsubstring (found, make_number (0), make_number (-1));
1239 message_with_string ("Source file `%s' newer than byte-compiled file",
1240 msg_file, 1);
1243 UNGCPRO;
1246 else
1248 /* We are loading a source file (*.el). */
1249 if (!NILP (Vload_source_file_function))
1251 Lisp_Object val;
1253 if (fd >= 0)
1254 emacs_close (fd);
1255 val = call4 (Vload_source_file_function, found, hist_file_name,
1256 NILP (noerror) ? Qnil : Qt,
1257 (NILP (nomessage) || force_load_messages) ? Qnil : Qt);
1258 return unbind_to (count, val);
1262 GCPRO3 (file, found, hist_file_name);
1264 #ifdef WINDOWSNT
1265 efound = ENCODE_FILE (found);
1266 /* If we somehow got here with fd == -2, meaning the file is deemed
1267 to be remote, don't even try to reopen the file locally; just
1268 force a failure instead. */
1269 if (fd >= 0)
1271 emacs_close (fd);
1272 stream = fopen (SSDATA (efound), fmode);
1274 else
1275 stream = NULL;
1276 #else /* not WINDOWSNT */
1277 stream = fdopen (fd, fmode);
1278 #endif /* not WINDOWSNT */
1279 if (stream == 0)
1281 emacs_close (fd);
1282 error ("Failure to create stdio stream for %s", SDATA (file));
1285 if (! NILP (Vpurify_flag))
1286 Vpreloaded_file_list = Fcons (Fpurecopy (file), Vpreloaded_file_list);
1288 if (NILP (nomessage) || force_load_messages)
1290 if (!safe_p)
1291 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
1292 file, 1);
1293 else if (!compiled)
1294 message_with_string ("Loading %s (source)...", file, 1);
1295 else if (newer)
1296 message_with_string ("Loading %s (compiled; note, source file is newer)...",
1297 file, 1);
1298 else /* The typical case; compiled file newer than source file. */
1299 message_with_string ("Loading %s...", file, 1);
1302 record_unwind_protect (load_unwind, make_save_value (stream, 0));
1303 record_unwind_protect (load_descriptor_unwind, load_descriptor_list);
1304 specbind (Qload_file_name, found);
1305 specbind (Qinhibit_file_name_operation, Qnil);
1306 load_descriptor_list
1307 = Fcons (make_number (fileno (stream)), load_descriptor_list);
1308 specbind (Qload_in_progress, Qt);
1310 instream = stream;
1311 if (lisp_file_lexically_bound_p (Qget_file_char))
1312 Fset (Qlexical_binding, Qt);
1314 if (! version || version >= 22)
1315 readevalloop (Qget_file_char, stream, hist_file_name,
1316 0, Qnil, Qnil, Qnil, Qnil);
1317 else
1319 /* We can't handle a file which was compiled with
1320 byte-compile-dynamic by older version of Emacs. */
1321 specbind (Qload_force_doc_strings, Qt);
1322 readevalloop (Qget_emacs_mule_file_char, stream, hist_file_name,
1323 0, Qnil, Qnil, Qnil, Qnil);
1325 unbind_to (count, Qnil);
1327 /* Run any eval-after-load forms for this file. */
1328 if (!NILP (Ffboundp (Qdo_after_load_evaluation)))
1329 call1 (Qdo_after_load_evaluation, hist_file_name) ;
1331 UNGCPRO;
1333 xfree (saved_doc_string);
1334 saved_doc_string = 0;
1335 saved_doc_string_size = 0;
1337 xfree (prev_saved_doc_string);
1338 prev_saved_doc_string = 0;
1339 prev_saved_doc_string_size = 0;
1341 if (!noninteractive && (NILP (nomessage) || force_load_messages))
1343 if (!safe_p)
1344 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
1345 file, 1);
1346 else if (!compiled)
1347 message_with_string ("Loading %s (source)...done", file, 1);
1348 else if (newer)
1349 message_with_string ("Loading %s (compiled; note, source file is newer)...done",
1350 file, 1);
1351 else /* The typical case; compiled file newer than source file. */
1352 message_with_string ("Loading %s...done", file, 1);
1355 return Qt;
1358 static Lisp_Object
1359 load_unwind (Lisp_Object arg) /* Used as unwind-protect function in load. */
1361 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
1362 if (stream != NULL)
1364 block_input ();
1365 fclose (stream);
1366 unblock_input ();
1368 return Qnil;
1371 static Lisp_Object
1372 load_descriptor_unwind (Lisp_Object oldlist)
1374 load_descriptor_list = oldlist;
1375 return Qnil;
1378 /* Close all descriptors in use for Floads.
1379 This is used when starting a subprocess. */
1381 void
1382 close_load_descs (void)
1384 #ifndef WINDOWSNT
1385 Lisp_Object tail;
1386 for (tail = load_descriptor_list; CONSP (tail); tail = XCDR (tail))
1387 emacs_close (XFASTINT (XCAR (tail)));
1388 #endif
1391 static bool
1392 complete_filename_p (Lisp_Object pathname)
1394 const unsigned char *s = SDATA (pathname);
1395 return (IS_DIRECTORY_SEP (s[0])
1396 || (SCHARS (pathname) > 2
1397 && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2])));
1400 DEFUN ("locate-file-internal", Flocate_file_internal, Slocate_file_internal, 2, 4, 0,
1401 doc: /* Search for FILENAME through PATH.
1402 Returns the file's name in absolute form, or nil if not found.
1403 If SUFFIXES is non-nil, it should be a list of suffixes to append to
1404 file name when searching.
1405 If non-nil, PREDICATE is used instead of `file-readable-p'.
1406 PREDICATE can also be an integer to pass to the access(2) function,
1407 in which case file-name-handlers are ignored.
1408 This function will normally skip directories, so if you want it to find
1409 directories, make sure the PREDICATE function returns `dir-ok' for them. */)
1410 (Lisp_Object filename, Lisp_Object path, Lisp_Object suffixes, Lisp_Object predicate)
1412 Lisp_Object file;
1413 int fd = openp (path, filename, suffixes, &file, predicate);
1414 if (NILP (predicate) && fd > 0)
1415 close (fd);
1416 return file;
1419 static Lisp_Object Qdir_ok;
1421 /* Search for a file whose name is STR, looking in directories
1422 in the Lisp list PATH, and trying suffixes from SUFFIX.
1423 On success, returns a file descriptor. On failure, returns -1.
1425 SUFFIXES is a list of strings containing possible suffixes.
1426 The empty suffix is automatically added if the list is empty.
1428 PREDICATE non-nil means don't open the files,
1429 just look for one that satisfies the predicate. In this case,
1430 returns 1 on success. The predicate can be a lisp function or
1431 an integer to pass to `access' (in which case file-name-handlers
1432 are ignored).
1434 If STOREPTR is nonzero, it points to a slot where the name of
1435 the file actually found should be stored as a Lisp string.
1436 nil is stored there on failure.
1438 If the file we find is remote, return -2
1439 but store the found remote file name in *STOREPTR. */
1442 openp (Lisp_Object path, Lisp_Object str, Lisp_Object suffixes, Lisp_Object *storeptr, Lisp_Object predicate)
1444 int fd;
1445 ptrdiff_t fn_size = 100;
1446 char buf[100];
1447 char *fn = buf;
1448 bool absolute = 0;
1449 ptrdiff_t want_length;
1450 Lisp_Object filename;
1451 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
1452 Lisp_Object string, tail, encoded_fn;
1453 ptrdiff_t max_suffix_len = 0;
1455 CHECK_STRING (str);
1457 for (tail = suffixes; CONSP (tail); tail = XCDR (tail))
1459 CHECK_STRING_CAR (tail);
1460 max_suffix_len = max (max_suffix_len,
1461 SBYTES (XCAR (tail)));
1464 string = filename = encoded_fn = Qnil;
1465 GCPRO6 (str, string, filename, path, suffixes, encoded_fn);
1467 if (storeptr)
1468 *storeptr = Qnil;
1470 if (complete_filename_p (str))
1471 absolute = 1;
1473 for (; CONSP (path); path = XCDR (path))
1475 filename = Fexpand_file_name (str, XCAR (path));
1476 if (!complete_filename_p (filename))
1477 /* If there are non-absolute elts in PATH (eg "."). */
1478 /* Of course, this could conceivably lose if luser sets
1479 default-directory to be something non-absolute... */
1481 filename = Fexpand_file_name (filename, BVAR (current_buffer, directory));
1482 if (!complete_filename_p (filename))
1483 /* Give up on this path element! */
1484 continue;
1487 /* Calculate maximum length of any filename made from
1488 this path element/specified file name and any possible suffix. */
1489 want_length = max_suffix_len + SBYTES (filename);
1490 if (fn_size <= want_length)
1491 fn = alloca (fn_size = 100 + want_length);
1493 /* Loop over suffixes. */
1494 for (tail = NILP (suffixes) ? Fcons (empty_unibyte_string, Qnil) : suffixes;
1495 CONSP (tail); tail = XCDR (tail))
1497 ptrdiff_t fnlen, lsuffix = SBYTES (XCAR (tail));
1498 Lisp_Object handler;
1499 bool exists;
1501 /* Concatenate path element/specified name with the suffix.
1502 If the directory starts with /:, remove that. */
1503 int prefixlen = ((SCHARS (filename) > 2
1504 && SREF (filename, 0) == '/'
1505 && SREF (filename, 1) == ':')
1506 ? 2 : 0);
1507 fnlen = SBYTES (filename) - prefixlen;
1508 memcpy (fn, SDATA (filename) + prefixlen, fnlen);
1509 memcpy (fn + fnlen, SDATA (XCAR (tail)), lsuffix + 1);
1510 fnlen += lsuffix;
1511 /* Check that the file exists and is not a directory. */
1512 /* We used to only check for handlers on non-absolute file names:
1513 if (absolute)
1514 handler = Qnil;
1515 else
1516 handler = Ffind_file_name_handler (filename, Qfile_exists_p);
1517 It's not clear why that was the case and it breaks things like
1518 (load "/bar.el") where the file is actually "/bar.el.gz". */
1519 string = make_string (fn, fnlen);
1520 handler = Ffind_file_name_handler (string, Qfile_exists_p);
1521 if ((!NILP (handler) || !NILP (predicate)) && !NATNUMP (predicate))
1523 if (NILP (predicate))
1524 exists = !NILP (Ffile_readable_p (string));
1525 else
1527 Lisp_Object tmp = call1 (predicate, string);
1528 exists = !NILP (tmp)
1529 && (EQ (tmp, Qdir_ok)
1530 || NILP (Ffile_directory_p (string)));
1533 if (exists)
1535 /* We succeeded; return this descriptor and filename. */
1536 if (storeptr)
1537 *storeptr = string;
1538 UNGCPRO;
1539 return -2;
1542 else
1544 #ifndef WINDOWSNT
1545 struct stat st;
1546 #endif
1547 const char *pfn;
1549 encoded_fn = ENCODE_FILE (string);
1550 pfn = SSDATA (encoded_fn);
1551 #ifdef WINDOWSNT
1552 exists = access (pfn, F_OK) == 0 && access (pfn, D_OK) < 0;
1553 #else
1554 exists = (stat (pfn, &st) == 0 && ! S_ISDIR (st.st_mode));
1555 #endif
1556 if (exists)
1558 /* Check that we can access or open it. */
1559 if (NATNUMP (predicate))
1560 fd = (((XFASTINT (predicate) & ~INT_MAX) == 0
1561 && access (pfn, XFASTINT (predicate)) == 0)
1562 ? 1 : -1);
1563 else
1564 fd = emacs_open (pfn, O_RDONLY, 0);
1566 if (fd >= 0)
1568 /* We succeeded; return this descriptor and filename. */
1569 if (storeptr)
1570 *storeptr = string;
1571 UNGCPRO;
1572 return fd;
1577 if (absolute)
1578 break;
1581 UNGCPRO;
1582 return -1;
1586 /* Merge the list we've accumulated of globals from the current input source
1587 into the load_history variable. The details depend on whether
1588 the source has an associated file name or not.
1590 FILENAME is the file name that we are loading from.
1592 ENTIRE is true if loading that entire file, false if evaluating
1593 part of it. */
1595 static void
1596 build_load_history (Lisp_Object filename, bool entire)
1598 Lisp_Object tail, prev, newelt;
1599 Lisp_Object tem, tem2;
1600 bool foundit = 0;
1602 tail = Vload_history;
1603 prev = Qnil;
1605 while (CONSP (tail))
1607 tem = XCAR (tail);
1609 /* Find the feature's previous assoc list... */
1610 if (!NILP (Fequal (filename, Fcar (tem))))
1612 foundit = 1;
1614 /* If we're loading the entire file, remove old data. */
1615 if (entire)
1617 if (NILP (prev))
1618 Vload_history = XCDR (tail);
1619 else
1620 Fsetcdr (prev, XCDR (tail));
1623 /* Otherwise, cons on new symbols that are not already members. */
1624 else
1626 tem2 = Vcurrent_load_list;
1628 while (CONSP (tem2))
1630 newelt = XCAR (tem2);
1632 if (NILP (Fmember (newelt, tem)))
1633 Fsetcar (tail, Fcons (XCAR (tem),
1634 Fcons (newelt, XCDR (tem))));
1636 tem2 = XCDR (tem2);
1637 QUIT;
1641 else
1642 prev = tail;
1643 tail = XCDR (tail);
1644 QUIT;
1647 /* If we're loading an entire file, cons the new assoc onto the
1648 front of load-history, the most-recently-loaded position. Also
1649 do this if we didn't find an existing member for the file. */
1650 if (entire || !foundit)
1651 Vload_history = Fcons (Fnreverse (Vcurrent_load_list),
1652 Vload_history);
1655 static Lisp_Object
1656 readevalloop_1 (Lisp_Object old)
1658 load_convert_to_unibyte = ! NILP (old);
1659 return Qnil;
1662 /* Signal an `end-of-file' error, if possible with file name
1663 information. */
1665 static _Noreturn void
1666 end_of_file_error (void)
1668 if (STRINGP (Vload_file_name))
1669 xsignal1 (Qend_of_file, Vload_file_name);
1671 xsignal0 (Qend_of_file);
1674 /* UNIBYTE specifies how to set load_convert_to_unibyte
1675 for this invocation.
1676 READFUN, if non-nil, is used instead of `read'.
1678 START, END specify region to read in current buffer (from eval-region).
1679 If the input is not from a buffer, they must be nil. */
1681 static void
1682 readevalloop (Lisp_Object readcharfun,
1683 FILE *stream,
1684 Lisp_Object sourcename,
1685 bool printflag,
1686 Lisp_Object unibyte, Lisp_Object readfun,
1687 Lisp_Object start, Lisp_Object end)
1689 register int c;
1690 register Lisp_Object val;
1691 ptrdiff_t count = SPECPDL_INDEX ();
1692 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1693 struct buffer *b = 0;
1694 bool continue_reading_p;
1695 Lisp_Object lex_bound;
1696 /* True if reading an entire buffer. */
1697 bool whole_buffer = 0;
1698 /* True on the first time around. */
1699 bool first_sexp = 1;
1700 Lisp_Object macroexpand = intern ("internal-macroexpand-for-load");
1702 if (NILP (Ffboundp (macroexpand))
1703 /* Don't macroexpand in .elc files, since it should have been done
1704 already. We actually don't know whether we're in a .elc file or not,
1705 so we use circumstantial evidence: .el files normally go through
1706 Vload_source_file_function -> load-with-code-conversion
1707 -> eval-buffer. */
1708 || EQ (readcharfun, Qget_file_char)
1709 || EQ (readcharfun, Qget_emacs_mule_file_char))
1710 macroexpand = Qnil;
1712 if (MARKERP (readcharfun))
1714 if (NILP (start))
1715 start = readcharfun;
1718 if (BUFFERP (readcharfun))
1719 b = XBUFFER (readcharfun);
1720 else if (MARKERP (readcharfun))
1721 b = XMARKER (readcharfun)->buffer;
1723 /* We assume START is nil when input is not from a buffer. */
1724 if (! NILP (start) && !b)
1725 emacs_abort ();
1727 specbind (Qstandard_input, readcharfun); /* GCPROs readcharfun. */
1728 specbind (Qcurrent_load_list, Qnil);
1729 record_unwind_protect (readevalloop_1, load_convert_to_unibyte ? Qt : Qnil);
1730 load_convert_to_unibyte = !NILP (unibyte);
1732 /* If lexical binding is active (either because it was specified in
1733 the file's header, or via a buffer-local variable), create an empty
1734 lexical environment, otherwise, turn off lexical binding. */
1735 lex_bound = find_symbol_value (Qlexical_binding);
1736 specbind (Qinternal_interpreter_environment,
1737 NILP (lex_bound) || EQ (lex_bound, Qunbound)
1738 ? Qnil : Fcons (Qt, Qnil));
1740 GCPRO4 (sourcename, readfun, start, end);
1742 /* Try to ensure sourcename is a truename, except whilst preloading. */
1743 if (NILP (Vpurify_flag)
1744 && !NILP (sourcename) && !NILP (Ffile_name_absolute_p (sourcename))
1745 && !NILP (Ffboundp (Qfile_truename)))
1746 sourcename = call1 (Qfile_truename, sourcename) ;
1748 LOADHIST_ATTACH (sourcename);
1750 continue_reading_p = 1;
1751 while (continue_reading_p)
1753 ptrdiff_t count1 = SPECPDL_INDEX ();
1755 if (b != 0 && !BUFFER_LIVE_P (b))
1756 error ("Reading from killed buffer");
1758 if (!NILP (start))
1760 /* Switch to the buffer we are reading from. */
1761 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1762 set_buffer_internal (b);
1764 /* Save point in it. */
1765 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1766 /* Save ZV in it. */
1767 record_unwind_protect (save_restriction_restore, save_restriction_save ());
1768 /* Those get unbound after we read one expression. */
1770 /* Set point and ZV around stuff to be read. */
1771 Fgoto_char (start);
1772 if (!NILP (end))
1773 Fnarrow_to_region (make_number (BEGV), end);
1775 /* Just for cleanliness, convert END to a marker
1776 if it is an integer. */
1777 if (INTEGERP (end))
1778 end = Fpoint_max_marker ();
1781 /* On the first cycle, we can easily test here
1782 whether we are reading the whole buffer. */
1783 if (b && first_sexp)
1784 whole_buffer = (PT == BEG && ZV == Z);
1786 instream = stream;
1787 read_next:
1788 c = READCHAR;
1789 if (c == ';')
1791 while ((c = READCHAR) != '\n' && c != -1);
1792 goto read_next;
1794 if (c < 0)
1796 unbind_to (count1, Qnil);
1797 break;
1800 /* Ignore whitespace here, so we can detect eof. */
1801 if (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r'
1802 || c == 0xa0) /* NBSP */
1803 goto read_next;
1805 if (!NILP (Vpurify_flag) && c == '(')
1807 val = read_list (0, readcharfun);
1809 else
1811 UNREAD (c);
1812 read_objects = Qnil;
1813 if (!NILP (readfun))
1815 val = call1 (readfun, readcharfun);
1817 /* If READCHARFUN has set point to ZV, we should
1818 stop reading, even if the form read sets point
1819 to a different value when evaluated. */
1820 if (BUFFERP (readcharfun))
1822 struct buffer *buf = XBUFFER (readcharfun);
1823 if (BUF_PT (buf) == BUF_ZV (buf))
1824 continue_reading_p = 0;
1827 else if (! NILP (Vload_read_function))
1828 val = call1 (Vload_read_function, readcharfun);
1829 else
1830 val = read_internal_start (readcharfun, Qnil, Qnil);
1833 if (!NILP (start) && continue_reading_p)
1834 start = Fpoint_marker ();
1836 /* Restore saved point and BEGV. */
1837 unbind_to (count1, Qnil);
1839 /* Now eval what we just read. */
1840 if (!NILP (macroexpand))
1841 val = call1 (macroexpand, val);
1842 val = eval_sub (val);
1844 if (printflag)
1846 Vvalues = Fcons (val, Vvalues);
1847 if (EQ (Vstandard_output, Qt))
1848 Fprin1 (val, Qnil);
1849 else
1850 Fprint (val, Qnil);
1853 first_sexp = 0;
1856 build_load_history (sourcename,
1857 stream || whole_buffer);
1859 UNGCPRO;
1861 unbind_to (count, Qnil);
1864 DEFUN ("eval-buffer", Feval_buffer, Seval_buffer, 0, 5, "",
1865 doc: /* Execute the current buffer as Lisp code.
1866 When called from a Lisp program (i.e., not interactively), this
1867 function accepts up to five optional arguments:
1868 BUFFER is the buffer to evaluate (nil means use current buffer).
1869 PRINTFLAG controls printing of output:
1870 A value of nil means discard it; anything else is stream for print.
1871 FILENAME specifies the file name to use for `load-history'.
1872 UNIBYTE, if non-nil, specifies `load-convert-to-unibyte' for this
1873 invocation.
1874 DO-ALLOW-PRINT, if non-nil, specifies that `print' and related
1875 functions should work normally even if PRINTFLAG is nil.
1877 This function preserves the position of point. */)
1878 (Lisp_Object buffer, Lisp_Object printflag, Lisp_Object filename, Lisp_Object unibyte, Lisp_Object do_allow_print)
1880 ptrdiff_t count = SPECPDL_INDEX ();
1881 Lisp_Object tem, buf;
1883 if (NILP (buffer))
1884 buf = Fcurrent_buffer ();
1885 else
1886 buf = Fget_buffer (buffer);
1887 if (NILP (buf))
1888 error ("No such buffer");
1890 if (NILP (printflag) && NILP (do_allow_print))
1891 tem = Qsymbolp;
1892 else
1893 tem = printflag;
1895 if (NILP (filename))
1896 filename = BVAR (XBUFFER (buf), filename);
1898 specbind (Qeval_buffer_list, Fcons (buf, Veval_buffer_list));
1899 specbind (Qstandard_output, tem);
1900 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1901 BUF_TEMP_SET_PT (XBUFFER (buf), BUF_BEGV (XBUFFER (buf)));
1902 specbind (Qlexical_binding, lisp_file_lexically_bound_p (buf) ? Qt : Qnil);
1903 readevalloop (buf, 0, filename,
1904 !NILP (printflag), unibyte, Qnil, Qnil, Qnil);
1905 unbind_to (count, Qnil);
1907 return Qnil;
1910 DEFUN ("eval-region", Feval_region, Seval_region, 2, 4, "r",
1911 doc: /* Execute the region as Lisp code.
1912 When called from programs, expects two arguments,
1913 giving starting and ending indices in the current buffer
1914 of the text to be executed.
1915 Programs can pass third argument PRINTFLAG which controls output:
1916 A value of nil means discard it; anything else is stream for printing it.
1917 Also the fourth argument READ-FUNCTION, if non-nil, is used
1918 instead of `read' to read each expression. It gets one argument
1919 which is the input stream for reading characters.
1921 This function does not move point. */)
1922 (Lisp_Object start, Lisp_Object end, Lisp_Object printflag, Lisp_Object read_function)
1924 /* FIXME: Do the eval-sexp-add-defvars dance! */
1925 ptrdiff_t count = SPECPDL_INDEX ();
1926 Lisp_Object tem, cbuf;
1928 cbuf = Fcurrent_buffer ();
1930 if (NILP (printflag))
1931 tem = Qsymbolp;
1932 else
1933 tem = printflag;
1934 specbind (Qstandard_output, tem);
1935 specbind (Qeval_buffer_list, Fcons (cbuf, Veval_buffer_list));
1937 /* `readevalloop' calls functions which check the type of start and end. */
1938 readevalloop (cbuf, 0, BVAR (XBUFFER (cbuf), filename),
1939 !NILP (printflag), Qnil, read_function,
1940 start, end);
1942 return unbind_to (count, Qnil);
1946 DEFUN ("read", Fread, Sread, 0, 1, 0,
1947 doc: /* Read one Lisp expression as text from STREAM, return as Lisp object.
1948 If STREAM is nil, use the value of `standard-input' (which see).
1949 STREAM or the value of `standard-input' may be:
1950 a buffer (read from point and advance it)
1951 a marker (read from where it points and advance it)
1952 a function (call it with no arguments for each character,
1953 call it with a char as argument to push a char back)
1954 a string (takes text from string, starting at the beginning)
1955 t (read text line using minibuffer and use it, or read from
1956 standard input in batch mode). */)
1957 (Lisp_Object stream)
1959 if (NILP (stream))
1960 stream = Vstandard_input;
1961 if (EQ (stream, Qt))
1962 stream = Qread_char;
1963 if (EQ (stream, Qread_char))
1964 return Fread_minibuffer (build_string ("Lisp expression: "), Qnil);
1966 return read_internal_start (stream, Qnil, Qnil);
1969 DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0,
1970 doc: /* Read one Lisp expression which is represented as text by STRING.
1971 Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
1972 FINAL-STRING-INDEX is an integer giving the position of the next
1973 remaining character in STRING.
1974 START and END optionally delimit a substring of STRING from which to read;
1975 they default to 0 and (length STRING) respectively. */)
1976 (Lisp_Object string, Lisp_Object start, Lisp_Object end)
1978 Lisp_Object ret;
1979 CHECK_STRING (string);
1980 /* `read_internal_start' sets `read_from_string_index'. */
1981 ret = read_internal_start (string, start, end);
1982 return Fcons (ret, make_number (read_from_string_index));
1985 /* Function to set up the global context we need in toplevel read
1986 calls. */
1987 static Lisp_Object
1988 read_internal_start (Lisp_Object stream, Lisp_Object start, Lisp_Object end)
1989 /* `start', `end' only used when stream is a string. */
1991 Lisp_Object retval;
1993 readchar_count = 0;
1994 new_backquote_flag = 0;
1995 read_objects = Qnil;
1996 if (EQ (Vread_with_symbol_positions, Qt)
1997 || EQ (Vread_with_symbol_positions, stream))
1998 Vread_symbol_positions_list = Qnil;
2000 if (STRINGP (stream)
2001 || ((CONSP (stream) && STRINGP (XCAR (stream)))))
2003 ptrdiff_t startval, endval;
2004 Lisp_Object string;
2006 if (STRINGP (stream))
2007 string = stream;
2008 else
2009 string = XCAR (stream);
2011 if (NILP (end))
2012 endval = SCHARS (string);
2013 else
2015 CHECK_NUMBER (end);
2016 if (! (0 <= XINT (end) && XINT (end) <= SCHARS (string)))
2017 args_out_of_range (string, end);
2018 endval = XINT (end);
2021 if (NILP (start))
2022 startval = 0;
2023 else
2025 CHECK_NUMBER (start);
2026 if (! (0 <= XINT (start) && XINT (start) <= endval))
2027 args_out_of_range (string, start);
2028 startval = XINT (start);
2030 read_from_string_index = startval;
2031 read_from_string_index_byte = string_char_to_byte (string, startval);
2032 read_from_string_limit = endval;
2035 retval = read0 (stream);
2036 if (EQ (Vread_with_symbol_positions, Qt)
2037 || EQ (Vread_with_symbol_positions, stream))
2038 Vread_symbol_positions_list = Fnreverse (Vread_symbol_positions_list);
2039 return retval;
2043 /* Signal Qinvalid_read_syntax error.
2044 S is error string of length N (if > 0) */
2046 static _Noreturn void
2047 invalid_syntax (const char *s)
2049 xsignal1 (Qinvalid_read_syntax, build_string (s));
2053 /* Use this for recursive reads, in contexts where internal tokens
2054 are not allowed. */
2056 static Lisp_Object
2057 read0 (Lisp_Object readcharfun)
2059 register Lisp_Object val;
2060 int c;
2062 val = read1 (readcharfun, &c, 0);
2063 if (!c)
2064 return val;
2066 xsignal1 (Qinvalid_read_syntax,
2067 Fmake_string (make_number (1), make_number (c)));
2070 static ptrdiff_t read_buffer_size;
2071 static char *read_buffer;
2073 /* Read a \-escape sequence, assuming we already read the `\'.
2074 If the escape sequence forces unibyte, return eight-bit char. */
2076 static int
2077 read_escape (Lisp_Object readcharfun, bool stringp)
2079 int c = READCHAR;
2080 /* \u allows up to four hex digits, \U up to eight. Default to the
2081 behavior for \u, and change this value in the case that \U is seen. */
2082 int unicode_hex_count = 4;
2084 switch (c)
2086 case -1:
2087 end_of_file_error ();
2089 case 'a':
2090 return '\007';
2091 case 'b':
2092 return '\b';
2093 case 'd':
2094 return 0177;
2095 case 'e':
2096 return 033;
2097 case 'f':
2098 return '\f';
2099 case 'n':
2100 return '\n';
2101 case 'r':
2102 return '\r';
2103 case 't':
2104 return '\t';
2105 case 'v':
2106 return '\v';
2107 case '\n':
2108 return -1;
2109 case ' ':
2110 if (stringp)
2111 return -1;
2112 return ' ';
2114 case 'M':
2115 c = READCHAR;
2116 if (c != '-')
2117 error ("Invalid escape character syntax");
2118 c = READCHAR;
2119 if (c == '\\')
2120 c = read_escape (readcharfun, 0);
2121 return c | meta_modifier;
2123 case 'S':
2124 c = READCHAR;
2125 if (c != '-')
2126 error ("Invalid escape character syntax");
2127 c = READCHAR;
2128 if (c == '\\')
2129 c = read_escape (readcharfun, 0);
2130 return c | shift_modifier;
2132 case 'H':
2133 c = READCHAR;
2134 if (c != '-')
2135 error ("Invalid escape character syntax");
2136 c = READCHAR;
2137 if (c == '\\')
2138 c = read_escape (readcharfun, 0);
2139 return c | hyper_modifier;
2141 case 'A':
2142 c = READCHAR;
2143 if (c != '-')
2144 error ("Invalid escape character syntax");
2145 c = READCHAR;
2146 if (c == '\\')
2147 c = read_escape (readcharfun, 0);
2148 return c | alt_modifier;
2150 case 's':
2151 c = READCHAR;
2152 if (stringp || c != '-')
2154 UNREAD (c);
2155 return ' ';
2157 c = READCHAR;
2158 if (c == '\\')
2159 c = read_escape (readcharfun, 0);
2160 return c | super_modifier;
2162 case 'C':
2163 c = READCHAR;
2164 if (c != '-')
2165 error ("Invalid escape character syntax");
2166 case '^':
2167 c = READCHAR;
2168 if (c == '\\')
2169 c = read_escape (readcharfun, 0);
2170 if ((c & ~CHAR_MODIFIER_MASK) == '?')
2171 return 0177 | (c & CHAR_MODIFIER_MASK);
2172 else if (! SINGLE_BYTE_CHAR_P ((c & ~CHAR_MODIFIER_MASK)))
2173 return c | ctrl_modifier;
2174 /* ASCII control chars are made from letters (both cases),
2175 as well as the non-letters within 0100...0137. */
2176 else if ((c & 0137) >= 0101 && (c & 0137) <= 0132)
2177 return (c & (037 | ~0177));
2178 else if ((c & 0177) >= 0100 && (c & 0177) <= 0137)
2179 return (c & (037 | ~0177));
2180 else
2181 return c | ctrl_modifier;
2183 case '0':
2184 case '1':
2185 case '2':
2186 case '3':
2187 case '4':
2188 case '5':
2189 case '6':
2190 case '7':
2191 /* An octal escape, as in ANSI C. */
2193 register int i = c - '0';
2194 register int count = 0;
2195 while (++count < 3)
2197 if ((c = READCHAR) >= '0' && c <= '7')
2199 i *= 8;
2200 i += c - '0';
2202 else
2204 UNREAD (c);
2205 break;
2209 if (i >= 0x80 && i < 0x100)
2210 i = BYTE8_TO_CHAR (i);
2211 return i;
2214 case 'x':
2215 /* A hex escape, as in ANSI C. */
2217 unsigned int i = 0;
2218 int count = 0;
2219 while (1)
2221 c = READCHAR;
2222 if (c >= '0' && c <= '9')
2224 i *= 16;
2225 i += c - '0';
2227 else if ((c >= 'a' && c <= 'f')
2228 || (c >= 'A' && c <= 'F'))
2230 i *= 16;
2231 if (c >= 'a' && c <= 'f')
2232 i += c - 'a' + 10;
2233 else
2234 i += c - 'A' + 10;
2236 else
2238 UNREAD (c);
2239 break;
2241 /* Allow hex escapes as large as ?\xfffffff, because some
2242 packages use them to denote characters with modifiers. */
2243 if ((CHAR_META | (CHAR_META - 1)) < i)
2244 error ("Hex character out of range: \\x%x...", i);
2245 count += count < 3;
2248 if (count < 3 && i >= 0x80)
2249 return BYTE8_TO_CHAR (i);
2250 return i;
2253 case 'U':
2254 /* Post-Unicode-2.0: Up to eight hex chars. */
2255 unicode_hex_count = 8;
2256 case 'u':
2258 /* A Unicode escape. We only permit them in strings and characters,
2259 not arbitrarily in the source code, as in some other languages. */
2261 unsigned int i = 0;
2262 int count = 0;
2264 while (++count <= unicode_hex_count)
2266 c = READCHAR;
2267 /* `isdigit' and `isalpha' may be locale-specific, which we don't
2268 want. */
2269 if (c >= '0' && c <= '9') i = (i << 4) + (c - '0');
2270 else if (c >= 'a' && c <= 'f') i = (i << 4) + (c - 'a') + 10;
2271 else if (c >= 'A' && c <= 'F') i = (i << 4) + (c - 'A') + 10;
2272 else
2273 error ("Non-hex digit used for Unicode escape");
2275 if (i > 0x10FFFF)
2276 error ("Non-Unicode character: 0x%x", i);
2277 return i;
2280 default:
2281 return c;
2285 /* Return the digit that CHARACTER stands for in the given BASE.
2286 Return -1 if CHARACTER is out of range for BASE,
2287 and -2 if CHARACTER is not valid for any supported BASE. */
2288 static int
2289 digit_to_number (int character, int base)
2291 int digit;
2293 if ('0' <= character && character <= '9')
2294 digit = character - '0';
2295 else if ('a' <= character && character <= 'z')
2296 digit = character - 'a' + 10;
2297 else if ('A' <= character && character <= 'Z')
2298 digit = character - 'A' + 10;
2299 else
2300 return -2;
2302 return digit < base ? digit : -1;
2305 /* Read an integer in radix RADIX using READCHARFUN to read
2306 characters. RADIX must be in the interval [2..36]; if it isn't, a
2307 read error is signaled . Value is the integer read. Signals an
2308 error if encountering invalid read syntax or if RADIX is out of
2309 range. */
2311 static Lisp_Object
2312 read_integer (Lisp_Object readcharfun, EMACS_INT radix)
2314 /* Room for sign, leading 0, other digits, trailing null byte.
2315 Also, room for invalid syntax diagnostic. */
2316 char buf[max (1 + 1 + sizeof (uintmax_t) * CHAR_BIT + 1,
2317 sizeof "integer, radix " + INT_STRLEN_BOUND (EMACS_INT))];
2319 int valid = -1; /* 1 if valid, 0 if not, -1 if incomplete. */
2321 if (radix < 2 || radix > 36)
2322 valid = 0;
2323 else
2325 char *p = buf;
2326 int c, digit;
2328 c = READCHAR;
2329 if (c == '-' || c == '+')
2331 *p++ = c;
2332 c = READCHAR;
2335 if (c == '0')
2337 *p++ = c;
2338 valid = 1;
2340 /* Ignore redundant leading zeros, so the buffer doesn't
2341 fill up with them. */
2343 c = READCHAR;
2344 while (c == '0');
2347 while (-1 <= (digit = digit_to_number (c, radix)))
2349 if (digit == -1)
2350 valid = 0;
2351 if (valid < 0)
2352 valid = 1;
2354 if (p < buf + sizeof buf - 1)
2355 *p++ = c;
2356 else
2357 valid = 0;
2359 c = READCHAR;
2362 UNREAD (c);
2363 *p = '\0';
2366 if (! valid)
2368 sprintf (buf, "integer, radix %"pI"d", radix);
2369 invalid_syntax (buf);
2372 return string_to_number (buf, radix, 0);
2376 /* If the next token is ')' or ']' or '.', we store that character
2377 in *PCH and the return value is not interesting. Else, we store
2378 zero in *PCH and we read and return one lisp object.
2380 FIRST_IN_LIST is true if this is the first element of a list. */
2382 static Lisp_Object
2383 read1 (Lisp_Object readcharfun, int *pch, bool first_in_list)
2385 int c;
2386 bool uninterned_symbol = 0;
2387 bool multibyte;
2389 *pch = 0;
2390 load_each_byte = 0;
2392 retry:
2394 c = READCHAR_REPORT_MULTIBYTE (&multibyte);
2395 if (c < 0)
2396 end_of_file_error ();
2398 switch (c)
2400 case '(':
2401 return read_list (0, readcharfun);
2403 case '[':
2404 return read_vector (readcharfun, 0);
2406 case ')':
2407 case ']':
2409 *pch = c;
2410 return Qnil;
2413 case '#':
2414 c = READCHAR;
2415 if (c == 's')
2417 c = READCHAR;
2418 if (c == '(')
2420 /* Accept extended format for hashtables (extensible to
2421 other types), e.g.
2422 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
2423 Lisp_Object tmp = read_list (0, readcharfun);
2424 Lisp_Object head = CAR_SAFE (tmp);
2425 Lisp_Object data = Qnil;
2426 Lisp_Object val = Qnil;
2427 /* The size is 2 * number of allowed keywords to
2428 make-hash-table. */
2429 Lisp_Object params[10];
2430 Lisp_Object ht;
2431 Lisp_Object key = Qnil;
2432 int param_count = 0;
2434 if (!EQ (head, Qhash_table))
2435 error ("Invalid extended read marker at head of #s list "
2436 "(only hash-table allowed)");
2438 tmp = CDR_SAFE (tmp);
2440 /* This is repetitive but fast and simple. */
2441 params[param_count] = QCsize;
2442 params[param_count + 1] = Fplist_get (tmp, Qsize);
2443 if (!NILP (params[param_count + 1]))
2444 param_count += 2;
2446 params[param_count] = QCtest;
2447 params[param_count + 1] = Fplist_get (tmp, Qtest);
2448 if (!NILP (params[param_count + 1]))
2449 param_count += 2;
2451 params[param_count] = QCweakness;
2452 params[param_count + 1] = Fplist_get (tmp, Qweakness);
2453 if (!NILP (params[param_count + 1]))
2454 param_count += 2;
2456 params[param_count] = QCrehash_size;
2457 params[param_count + 1] = Fplist_get (tmp, Qrehash_size);
2458 if (!NILP (params[param_count + 1]))
2459 param_count += 2;
2461 params[param_count] = QCrehash_threshold;
2462 params[param_count + 1] = Fplist_get (tmp, Qrehash_threshold);
2463 if (!NILP (params[param_count + 1]))
2464 param_count += 2;
2466 /* This is the hashtable data. */
2467 data = Fplist_get (tmp, Qdata);
2469 /* Now use params to make a new hashtable and fill it. */
2470 ht = Fmake_hash_table (param_count, params);
2472 while (CONSP (data))
2474 key = XCAR (data);
2475 data = XCDR (data);
2476 if (!CONSP (data))
2477 error ("Odd number of elements in hashtable data");
2478 val = XCAR (data);
2479 data = XCDR (data);
2480 Fputhash (key, val, ht);
2483 return ht;
2485 UNREAD (c);
2486 invalid_syntax ("#");
2488 if (c == '^')
2490 c = READCHAR;
2491 if (c == '[')
2493 Lisp_Object tmp;
2494 tmp = read_vector (readcharfun, 0);
2495 if (ASIZE (tmp) < CHAR_TABLE_STANDARD_SLOTS)
2496 error ("Invalid size char-table");
2497 XSETPVECTYPE (XVECTOR (tmp), PVEC_CHAR_TABLE);
2498 return tmp;
2500 else if (c == '^')
2502 c = READCHAR;
2503 if (c == '[')
2505 Lisp_Object tmp;
2506 int depth;
2507 ptrdiff_t size;
2509 tmp = read_vector (readcharfun, 0);
2510 size = ASIZE (tmp);
2511 if (size == 0)
2512 error ("Invalid size char-table");
2513 if (! RANGED_INTEGERP (1, AREF (tmp, 0), 3))
2514 error ("Invalid depth in char-table");
2515 depth = XINT (AREF (tmp, 0));
2516 if (chartab_size[depth] != size - 2)
2517 error ("Invalid size char-table");
2518 XSETPVECTYPE (XVECTOR (tmp), PVEC_SUB_CHAR_TABLE);
2519 return tmp;
2521 invalid_syntax ("#^^");
2523 invalid_syntax ("#^");
2525 if (c == '&')
2527 Lisp_Object length;
2528 length = read1 (readcharfun, pch, first_in_list);
2529 c = READCHAR;
2530 if (c == '"')
2532 Lisp_Object tmp, val;
2533 EMACS_INT size_in_chars
2534 = ((XFASTINT (length) + BOOL_VECTOR_BITS_PER_CHAR - 1)
2535 / BOOL_VECTOR_BITS_PER_CHAR);
2537 UNREAD (c);
2538 tmp = read1 (readcharfun, pch, first_in_list);
2539 if (STRING_MULTIBYTE (tmp)
2540 || (size_in_chars != SCHARS (tmp)
2541 /* We used to print 1 char too many
2542 when the number of bits was a multiple of 8.
2543 Accept such input in case it came from an old
2544 version. */
2545 && ! (XFASTINT (length)
2546 == (SCHARS (tmp) - 1) * BOOL_VECTOR_BITS_PER_CHAR)))
2547 invalid_syntax ("#&...");
2549 val = Fmake_bool_vector (length, Qnil);
2550 memcpy (XBOOL_VECTOR (val)->data, SDATA (tmp), size_in_chars);
2551 /* Clear the extraneous bits in the last byte. */
2552 if (XINT (length) != size_in_chars * BOOL_VECTOR_BITS_PER_CHAR)
2553 XBOOL_VECTOR (val)->data[size_in_chars - 1]
2554 &= (1 << (XINT (length) % BOOL_VECTOR_BITS_PER_CHAR)) - 1;
2555 return val;
2557 invalid_syntax ("#&...");
2559 if (c == '[')
2561 /* Accept compiled functions at read-time so that we don't have to
2562 build them using function calls. */
2563 Lisp_Object tmp;
2564 tmp = read_vector (readcharfun, 1);
2565 make_byte_code (XVECTOR (tmp));
2566 return tmp;
2568 if (c == '(')
2570 Lisp_Object tmp;
2571 struct gcpro gcpro1;
2572 int ch;
2574 /* Read the string itself. */
2575 tmp = read1 (readcharfun, &ch, 0);
2576 if (ch != 0 || !STRINGP (tmp))
2577 invalid_syntax ("#");
2578 GCPRO1 (tmp);
2579 /* Read the intervals and their properties. */
2580 while (1)
2582 Lisp_Object beg, end, plist;
2584 beg = read1 (readcharfun, &ch, 0);
2585 end = plist = Qnil;
2586 if (ch == ')')
2587 break;
2588 if (ch == 0)
2589 end = read1 (readcharfun, &ch, 0);
2590 if (ch == 0)
2591 plist = read1 (readcharfun, &ch, 0);
2592 if (ch)
2593 invalid_syntax ("Invalid string property list");
2594 Fset_text_properties (beg, end, plist, tmp);
2596 UNGCPRO;
2597 return tmp;
2600 /* #@NUMBER is used to skip NUMBER following characters.
2601 That's used in .elc files to skip over doc strings
2602 and function definitions. */
2603 if (c == '@')
2605 enum { extra = 100 };
2606 ptrdiff_t i, nskip = 0;
2608 load_each_byte = 1;
2609 /* Read a decimal integer. */
2610 while ((c = READCHAR) >= 0
2611 && c >= '0' && c <= '9')
2613 if ((STRING_BYTES_BOUND - extra) / 10 <= nskip)
2614 string_overflow ();
2615 nskip *= 10;
2616 nskip += c - '0';
2618 UNREAD (c);
2620 if (load_force_doc_strings
2621 && (EQ (readcharfun, Qget_file_char)
2622 || EQ (readcharfun, Qget_emacs_mule_file_char)))
2624 /* If we are supposed to force doc strings into core right now,
2625 record the last string that we skipped,
2626 and record where in the file it comes from. */
2628 /* But first exchange saved_doc_string
2629 with prev_saved_doc_string, so we save two strings. */
2631 char *temp = saved_doc_string;
2632 ptrdiff_t temp_size = saved_doc_string_size;
2633 file_offset temp_pos = saved_doc_string_position;
2634 ptrdiff_t temp_len = saved_doc_string_length;
2636 saved_doc_string = prev_saved_doc_string;
2637 saved_doc_string_size = prev_saved_doc_string_size;
2638 saved_doc_string_position = prev_saved_doc_string_position;
2639 saved_doc_string_length = prev_saved_doc_string_length;
2641 prev_saved_doc_string = temp;
2642 prev_saved_doc_string_size = temp_size;
2643 prev_saved_doc_string_position = temp_pos;
2644 prev_saved_doc_string_length = temp_len;
2647 if (saved_doc_string_size == 0)
2649 saved_doc_string = xmalloc (nskip + extra);
2650 saved_doc_string_size = nskip + extra;
2652 if (nskip > saved_doc_string_size)
2654 saved_doc_string = xrealloc (saved_doc_string, nskip + extra);
2655 saved_doc_string_size = nskip + extra;
2658 saved_doc_string_position = file_tell (instream);
2660 /* Copy that many characters into saved_doc_string. */
2661 for (i = 0; i < nskip && c >= 0; i++)
2662 saved_doc_string[i] = c = READCHAR;
2664 saved_doc_string_length = i;
2666 else
2668 /* Skip that many characters. */
2669 for (i = 0; i < nskip && c >= 0; i++)
2670 c = READCHAR;
2673 load_each_byte = 0;
2674 goto retry;
2676 if (c == '!')
2678 /* #! appears at the beginning of an executable file.
2679 Skip the first line. */
2680 while (c != '\n' && c >= 0)
2681 c = READCHAR;
2682 goto retry;
2684 if (c == '$')
2685 return Vload_file_name;
2686 if (c == '\'')
2687 return Fcons (Qfunction, Fcons (read0 (readcharfun), Qnil));
2688 /* #:foo is the uninterned symbol named foo. */
2689 if (c == ':')
2691 uninterned_symbol = 1;
2692 c = READCHAR;
2693 if (!(c > 040
2694 && c != 0xa0 /* NBSP */
2695 && (c >= 0200
2696 || strchr ("\"';()[]#`,", c) == NULL)))
2698 /* No symbol character follows, this is the empty
2699 symbol. */
2700 UNREAD (c);
2701 return Fmake_symbol (empty_unibyte_string);
2703 goto read_symbol;
2705 /* ## is the empty symbol. */
2706 if (c == '#')
2707 return Fintern (empty_unibyte_string, Qnil);
2708 /* Reader forms that can reuse previously read objects. */
2709 if (c >= '0' && c <= '9')
2711 EMACS_INT n = 0;
2712 Lisp_Object tem;
2714 /* Read a non-negative integer. */
2715 while (c >= '0' && c <= '9')
2717 if (MOST_POSITIVE_FIXNUM / 10 < n
2718 || MOST_POSITIVE_FIXNUM < n * 10 + c - '0')
2719 n = MOST_POSITIVE_FIXNUM + 1;
2720 else
2721 n = n * 10 + c - '0';
2722 c = READCHAR;
2725 if (n <= MOST_POSITIVE_FIXNUM)
2727 if (c == 'r' || c == 'R')
2728 return read_integer (readcharfun, n);
2730 if (! NILP (Vread_circle))
2732 /* #n=object returns object, but associates it with
2733 n for #n#. */
2734 if (c == '=')
2736 /* Make a placeholder for #n# to use temporarily. */
2737 Lisp_Object placeholder;
2738 Lisp_Object cell;
2740 placeholder = Fcons (Qnil, Qnil);
2741 cell = Fcons (make_number (n), placeholder);
2742 read_objects = Fcons (cell, read_objects);
2744 /* Read the object itself. */
2745 tem = read0 (readcharfun);
2747 /* Now put it everywhere the placeholder was... */
2748 substitute_object_in_subtree (tem, placeholder);
2750 /* ...and #n# will use the real value from now on. */
2751 Fsetcdr (cell, tem);
2753 return tem;
2756 /* #n# returns a previously read object. */
2757 if (c == '#')
2759 tem = Fassq (make_number (n), read_objects);
2760 if (CONSP (tem))
2761 return XCDR (tem);
2765 /* Fall through to error message. */
2767 else if (c == 'x' || c == 'X')
2768 return read_integer (readcharfun, 16);
2769 else if (c == 'o' || c == 'O')
2770 return read_integer (readcharfun, 8);
2771 else if (c == 'b' || c == 'B')
2772 return read_integer (readcharfun, 2);
2774 UNREAD (c);
2775 invalid_syntax ("#");
2777 case ';':
2778 while ((c = READCHAR) >= 0 && c != '\n');
2779 goto retry;
2781 case '\'':
2783 return Fcons (Qquote, Fcons (read0 (readcharfun), Qnil));
2786 case '`':
2788 int next_char = READCHAR;
2789 UNREAD (next_char);
2790 /* Transition from old-style to new-style:
2791 If we see "(`" it used to mean old-style, which usually works
2792 fine because ` should almost never appear in such a position
2793 for new-style. But occasionally we need "(`" to mean new
2794 style, so we try to distinguish the two by the fact that we
2795 can either write "( `foo" or "(` foo", where the first
2796 intends to use new-style whereas the second intends to use
2797 old-style. For Emacs-25, we should completely remove this
2798 first_in_list exception (old-style can still be obtained via
2799 "(\`" anyway). */
2800 if (!new_backquote_flag && first_in_list && next_char == ' ')
2802 Vold_style_backquotes = Qt;
2803 goto default_label;
2805 else
2807 Lisp_Object value;
2808 bool saved_new_backquote_flag = new_backquote_flag;
2810 new_backquote_flag = 1;
2811 value = read0 (readcharfun);
2812 new_backquote_flag = saved_new_backquote_flag;
2814 return Fcons (Qbackquote, Fcons (value, Qnil));
2817 case ',':
2819 int next_char = READCHAR;
2820 UNREAD (next_char);
2821 /* Transition from old-style to new-style:
2822 It used to be impossible to have a new-style , other than within
2823 a new-style `. This is sufficient when ` and , are used in the
2824 normal way, but ` and , can also appear in args to macros that
2825 will not interpret them in the usual way, in which case , may be
2826 used without any ` anywhere near.
2827 So we now use the same heuristic as for backquote: old-style
2828 unquotes are only recognized when first on a list, and when
2829 followed by a space.
2830 Because it's more difficult to peek 2 chars ahead, a new-style
2831 ,@ can still not be used outside of a `, unless it's in the middle
2832 of a list. */
2833 if (new_backquote_flag
2834 || !first_in_list
2835 || (next_char != ' ' && next_char != '@'))
2837 Lisp_Object comma_type = Qnil;
2838 Lisp_Object value;
2839 int ch = READCHAR;
2841 if (ch == '@')
2842 comma_type = Qcomma_at;
2843 else if (ch == '.')
2844 comma_type = Qcomma_dot;
2845 else
2847 if (ch >= 0) UNREAD (ch);
2848 comma_type = Qcomma;
2851 value = read0 (readcharfun);
2852 return Fcons (comma_type, Fcons (value, Qnil));
2854 else
2856 Vold_style_backquotes = Qt;
2857 goto default_label;
2860 case '?':
2862 int modifiers;
2863 int next_char;
2864 bool ok;
2866 c = READCHAR;
2867 if (c < 0)
2868 end_of_file_error ();
2870 /* Accept `single space' syntax like (list ? x) where the
2871 whitespace character is SPC or TAB.
2872 Other literal whitespace like NL, CR, and FF are not accepted,
2873 as there are well-established escape sequences for these. */
2874 if (c == ' ' || c == '\t')
2875 return make_number (c);
2877 if (c == '\\')
2878 c = read_escape (readcharfun, 0);
2879 modifiers = c & CHAR_MODIFIER_MASK;
2880 c &= ~CHAR_MODIFIER_MASK;
2881 if (CHAR_BYTE8_P (c))
2882 c = CHAR_TO_BYTE8 (c);
2883 c |= modifiers;
2885 next_char = READCHAR;
2886 ok = (next_char <= 040
2887 || (next_char < 0200
2888 && strchr ("\"';()[]#?`,.", next_char) != NULL));
2889 UNREAD (next_char);
2890 if (ok)
2891 return make_number (c);
2893 invalid_syntax ("?");
2896 case '"':
2898 char *p = read_buffer;
2899 char *end = read_buffer + read_buffer_size;
2900 int ch;
2901 /* True if we saw an escape sequence specifying
2902 a multibyte character. */
2903 bool force_multibyte = 0;
2904 /* True if we saw an escape sequence specifying
2905 a single-byte character. */
2906 bool force_singlebyte = 0;
2907 bool cancel = 0;
2908 ptrdiff_t nchars = 0;
2910 while ((ch = READCHAR) >= 0
2911 && ch != '\"')
2913 if (end - p < MAX_MULTIBYTE_LENGTH)
2915 ptrdiff_t offset = p - read_buffer;
2916 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
2917 memory_full (SIZE_MAX);
2918 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
2919 read_buffer_size *= 2;
2920 p = read_buffer + offset;
2921 end = read_buffer + read_buffer_size;
2924 if (ch == '\\')
2926 int modifiers;
2928 ch = read_escape (readcharfun, 1);
2930 /* CH is -1 if \ newline has just been seen. */
2931 if (ch == -1)
2933 if (p == read_buffer)
2934 cancel = 1;
2935 continue;
2938 modifiers = ch & CHAR_MODIFIER_MASK;
2939 ch = ch & ~CHAR_MODIFIER_MASK;
2941 if (CHAR_BYTE8_P (ch))
2942 force_singlebyte = 1;
2943 else if (! ASCII_CHAR_P (ch))
2944 force_multibyte = 1;
2945 else /* I.e. ASCII_CHAR_P (ch). */
2947 /* Allow `\C- ' and `\C-?'. */
2948 if (modifiers == CHAR_CTL)
2950 if (ch == ' ')
2951 ch = 0, modifiers = 0;
2952 else if (ch == '?')
2953 ch = 127, modifiers = 0;
2955 if (modifiers & CHAR_SHIFT)
2957 /* Shift modifier is valid only with [A-Za-z]. */
2958 if (ch >= 'A' && ch <= 'Z')
2959 modifiers &= ~CHAR_SHIFT;
2960 else if (ch >= 'a' && ch <= 'z')
2961 ch -= ('a' - 'A'), modifiers &= ~CHAR_SHIFT;
2964 if (modifiers & CHAR_META)
2966 /* Move the meta bit to the right place for a
2967 string. */
2968 modifiers &= ~CHAR_META;
2969 ch = BYTE8_TO_CHAR (ch | 0x80);
2970 force_singlebyte = 1;
2974 /* Any modifiers remaining are invalid. */
2975 if (modifiers)
2976 error ("Invalid modifier in string");
2977 p += CHAR_STRING (ch, (unsigned char *) p);
2979 else
2981 p += CHAR_STRING (ch, (unsigned char *) p);
2982 if (CHAR_BYTE8_P (ch))
2983 force_singlebyte = 1;
2984 else if (! ASCII_CHAR_P (ch))
2985 force_multibyte = 1;
2987 nchars++;
2990 if (ch < 0)
2991 end_of_file_error ();
2993 /* If purifying, and string starts with \ newline,
2994 return zero instead. This is for doc strings
2995 that we are really going to find in etc/DOC.nn.nn. */
2996 if (!NILP (Vpurify_flag) && NILP (Vdoc_file_name) && cancel)
2997 return make_number (0);
2999 if (! force_multibyte && force_singlebyte)
3001 /* READ_BUFFER contains raw 8-bit bytes and no multibyte
3002 forms. Convert it to unibyte. */
3003 nchars = str_as_unibyte ((unsigned char *) read_buffer,
3004 p - read_buffer);
3005 p = read_buffer + nchars;
3008 return make_specified_string (read_buffer, nchars, p - read_buffer,
3009 (force_multibyte
3010 || (p - read_buffer != nchars)));
3013 case '.':
3015 int next_char = READCHAR;
3016 UNREAD (next_char);
3018 if (next_char <= 040
3019 || (next_char < 0200
3020 && strchr ("\"';([#?`,", next_char) != NULL))
3022 *pch = c;
3023 return Qnil;
3026 /* Otherwise, we fall through! Note that the atom-reading loop
3027 below will now loop at least once, assuring that we will not
3028 try to UNREAD two characters in a row. */
3030 default:
3031 default_label:
3032 if (c <= 040) goto retry;
3033 if (c == 0xa0) /* NBSP */
3034 goto retry;
3036 read_symbol:
3038 char *p = read_buffer;
3039 bool quoted = 0;
3040 EMACS_INT start_position = readchar_count - 1;
3043 char *end = read_buffer + read_buffer_size;
3047 if (end - p < MAX_MULTIBYTE_LENGTH)
3049 ptrdiff_t offset = p - read_buffer;
3050 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
3051 memory_full (SIZE_MAX);
3052 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
3053 read_buffer_size *= 2;
3054 p = read_buffer + offset;
3055 end = read_buffer + read_buffer_size;
3058 if (c == '\\')
3060 c = READCHAR;
3061 if (c == -1)
3062 end_of_file_error ();
3063 quoted = 1;
3066 if (multibyte)
3067 p += CHAR_STRING (c, (unsigned char *) p);
3068 else
3069 *p++ = c;
3070 c = READCHAR;
3072 while (c > 040
3073 && c != 0xa0 /* NBSP */
3074 && (c >= 0200
3075 || strchr ("\"';()[]#`,", c) == NULL));
3077 if (p == end)
3079 ptrdiff_t offset = p - read_buffer;
3080 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
3081 memory_full (SIZE_MAX);
3082 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
3083 read_buffer_size *= 2;
3084 p = read_buffer + offset;
3085 end = read_buffer + read_buffer_size;
3087 *p = 0;
3088 UNREAD (c);
3091 if (!quoted && !uninterned_symbol)
3093 Lisp_Object result = string_to_number (read_buffer, 10, 0);
3094 if (! NILP (result))
3095 return result;
3098 Lisp_Object name, result;
3099 ptrdiff_t nbytes = p - read_buffer;
3100 ptrdiff_t nchars
3101 = (multibyte
3102 ? multibyte_chars_in_text ((unsigned char *) read_buffer,
3103 nbytes)
3104 : nbytes);
3106 name = ((uninterned_symbol && ! NILP (Vpurify_flag)
3107 ? make_pure_string : make_specified_string)
3108 (read_buffer, nchars, nbytes, multibyte));
3109 result = (uninterned_symbol ? Fmake_symbol (name)
3110 : Fintern (name, Qnil));
3112 if (EQ (Vread_with_symbol_positions, Qt)
3113 || EQ (Vread_with_symbol_positions, readcharfun))
3114 Vread_symbol_positions_list
3115 = Fcons (Fcons (result, make_number (start_position)),
3116 Vread_symbol_positions_list);
3117 return result;
3124 /* List of nodes we've seen during substitute_object_in_subtree. */
3125 static Lisp_Object seen_list;
3127 static void
3128 substitute_object_in_subtree (Lisp_Object object, Lisp_Object placeholder)
3130 Lisp_Object check_object;
3132 /* We haven't seen any objects when we start. */
3133 seen_list = Qnil;
3135 /* Make all the substitutions. */
3136 check_object
3137 = substitute_object_recurse (object, placeholder, object);
3139 /* Clear seen_list because we're done with it. */
3140 seen_list = Qnil;
3142 /* The returned object here is expected to always eq the
3143 original. */
3144 if (!EQ (check_object, object))
3145 error ("Unexpected mutation error in reader");
3148 /* Feval doesn't get called from here, so no gc protection is needed. */
3149 #define SUBSTITUTE(get_val, set_val) \
3150 do { \
3151 Lisp_Object old_value = get_val; \
3152 Lisp_Object true_value \
3153 = substitute_object_recurse (object, placeholder, \
3154 old_value); \
3156 if (!EQ (old_value, true_value)) \
3158 set_val; \
3160 } while (0)
3162 static Lisp_Object
3163 substitute_object_recurse (Lisp_Object object, Lisp_Object placeholder, Lisp_Object subtree)
3165 /* If we find the placeholder, return the target object. */
3166 if (EQ (placeholder, subtree))
3167 return object;
3169 /* If we've been to this node before, don't explore it again. */
3170 if (!EQ (Qnil, Fmemq (subtree, seen_list)))
3171 return subtree;
3173 /* If this node can be the entry point to a cycle, remember that
3174 we've seen it. It can only be such an entry point if it was made
3175 by #n=, which means that we can find it as a value in
3176 read_objects. */
3177 if (!EQ (Qnil, Frassq (subtree, read_objects)))
3178 seen_list = Fcons (subtree, seen_list);
3180 /* Recurse according to subtree's type.
3181 Every branch must return a Lisp_Object. */
3182 switch (XTYPE (subtree))
3184 case Lisp_Vectorlike:
3186 ptrdiff_t i, length = 0;
3187 if (BOOL_VECTOR_P (subtree))
3188 return subtree; /* No sub-objects anyway. */
3189 else if (CHAR_TABLE_P (subtree) || SUB_CHAR_TABLE_P (subtree)
3190 || COMPILEDP (subtree))
3191 length = ASIZE (subtree) & PSEUDOVECTOR_SIZE_MASK;
3192 else if (VECTORP (subtree))
3193 length = ASIZE (subtree);
3194 else
3195 /* An unknown pseudovector may contain non-Lisp fields, so we
3196 can't just blindly traverse all its fields. We used to call
3197 `Flength' which signaled `sequencep', so I just preserved this
3198 behavior. */
3199 wrong_type_argument (Qsequencep, subtree);
3201 for (i = 0; i < length; i++)
3202 SUBSTITUTE (AREF (subtree, i),
3203 ASET (subtree, i, true_value));
3204 return subtree;
3207 case Lisp_Cons:
3209 SUBSTITUTE (XCAR (subtree),
3210 XSETCAR (subtree, true_value));
3211 SUBSTITUTE (XCDR (subtree),
3212 XSETCDR (subtree, true_value));
3213 return subtree;
3216 case Lisp_String:
3218 /* Check for text properties in each interval.
3219 substitute_in_interval contains part of the logic. */
3221 INTERVAL root_interval = string_intervals (subtree);
3222 Lisp_Object arg = Fcons (object, placeholder);
3224 traverse_intervals_noorder (root_interval,
3225 &substitute_in_interval, arg);
3227 return subtree;
3230 /* Other types don't recurse any further. */
3231 default:
3232 return subtree;
3236 /* Helper function for substitute_object_recurse. */
3237 static void
3238 substitute_in_interval (INTERVAL interval, Lisp_Object arg)
3240 Lisp_Object object = Fcar (arg);
3241 Lisp_Object placeholder = Fcdr (arg);
3243 SUBSTITUTE (interval->plist, set_interval_plist (interval, true_value));
3247 #define LEAD_INT 1
3248 #define DOT_CHAR 2
3249 #define TRAIL_INT 4
3250 #define E_EXP 16
3253 /* Convert STRING to a number, assuming base BASE. Return a fixnum if CP has
3254 integer syntax and fits in a fixnum, else return the nearest float if CP has
3255 either floating point or integer syntax and BASE is 10, else return nil. If
3256 IGNORE_TRAILING, consider just the longest prefix of CP that has
3257 valid floating point syntax. Signal an overflow if BASE is not 10 and the
3258 number has integer syntax but does not fit. */
3260 Lisp_Object
3261 string_to_number (char const *string, int base, bool ignore_trailing)
3263 int state;
3264 char const *cp = string;
3265 int leading_digit;
3266 bool float_syntax = 0;
3267 double value = 0;
3269 /* Compute NaN and infinities using a variable, to cope with compilers that
3270 think they are smarter than we are. */
3271 double zero = 0;
3273 /* Negate the value ourselves. This treats 0, NaNs, and infinity properly on
3274 IEEE floating point hosts, and works around a formerly-common bug where
3275 atof ("-0.0") drops the sign. */
3276 bool negative = *cp == '-';
3278 bool signedp = negative || *cp == '+';
3279 cp += signedp;
3281 state = 0;
3283 leading_digit = digit_to_number (*cp, base);
3284 if (0 <= leading_digit)
3286 state |= LEAD_INT;
3288 ++cp;
3289 while (0 <= digit_to_number (*cp, base));
3291 if (*cp == '.')
3293 state |= DOT_CHAR;
3294 cp++;
3297 if (base == 10)
3299 if ('0' <= *cp && *cp <= '9')
3301 state |= TRAIL_INT;
3303 cp++;
3304 while ('0' <= *cp && *cp <= '9');
3306 if (*cp == 'e' || *cp == 'E')
3308 char const *ecp = cp;
3309 cp++;
3310 if (*cp == '+' || *cp == '-')
3311 cp++;
3312 if ('0' <= *cp && *cp <= '9')
3314 state |= E_EXP;
3316 cp++;
3317 while ('0' <= *cp && *cp <= '9');
3319 else if (cp[-1] == '+'
3320 && cp[0] == 'I' && cp[1] == 'N' && cp[2] == 'F')
3322 state |= E_EXP;
3323 cp += 3;
3324 value = 1.0 / zero;
3326 else if (cp[-1] == '+'
3327 && cp[0] == 'N' && cp[1] == 'a' && cp[2] == 'N')
3329 state |= E_EXP;
3330 cp += 3;
3331 value = zero / zero;
3333 /* If that made a "negative" NaN, negate it. */
3335 int i;
3336 union { double d; char c[sizeof (double)]; }
3337 u_data, u_minus_zero;
3338 u_data.d = value;
3339 u_minus_zero.d = -0.0;
3340 for (i = 0; i < sizeof (double); i++)
3341 if (u_data.c[i] & u_minus_zero.c[i])
3343 value = -value;
3344 break;
3347 /* Now VALUE is a positive NaN. */
3349 else
3350 cp = ecp;
3353 float_syntax = ((state & (DOT_CHAR|TRAIL_INT)) == (DOT_CHAR|TRAIL_INT)
3354 || state == (LEAD_INT|E_EXP));
3357 /* Return nil if the number uses invalid syntax. If IGNORE_TRAILING, accept
3358 any prefix that matches. Otherwise, the entire string must match. */
3359 if (! (ignore_trailing
3360 ? ((state & LEAD_INT) != 0 || float_syntax)
3361 : (!*cp && ((state & ~DOT_CHAR) == LEAD_INT || float_syntax))))
3362 return Qnil;
3364 /* If the number uses integer and not float syntax, and is in C-language
3365 range, use its value, preferably as a fixnum. */
3366 if (0 <= leading_digit && ! float_syntax)
3368 uintmax_t n;
3370 /* Fast special case for single-digit integers. This also avoids a
3371 glitch when BASE is 16 and IGNORE_TRAILING, because in that
3372 case some versions of strtoumax accept numbers like "0x1" that Emacs
3373 does not allow. */
3374 if (digit_to_number (string[signedp + 1], base) < 0)
3375 return make_number (negative ? -leading_digit : leading_digit);
3377 errno = 0;
3378 n = strtoumax (string + signedp, NULL, base);
3379 if (errno == ERANGE)
3381 /* Unfortunately there's no simple and accurate way to convert
3382 non-base-10 numbers that are out of C-language range. */
3383 if (base != 10)
3384 xsignal1 (Qoverflow_error, build_string (string));
3386 else if (n <= (negative ? -MOST_NEGATIVE_FIXNUM : MOST_POSITIVE_FIXNUM))
3388 EMACS_INT signed_n = n;
3389 return make_number (negative ? -signed_n : signed_n);
3391 else
3392 value = n;
3395 /* Either the number uses float syntax, or it does not fit into a fixnum.
3396 Convert it from string to floating point, unless the value is already
3397 known because it is an infinity, a NAN, or its absolute value fits in
3398 uintmax_t. */
3399 if (! value)
3400 value = atof (string + signedp);
3402 return make_float (negative ? -value : value);
3406 static Lisp_Object
3407 read_vector (Lisp_Object readcharfun, bool bytecodeflag)
3409 ptrdiff_t i, size;
3410 Lisp_Object *ptr;
3411 Lisp_Object tem, item, vector;
3412 struct Lisp_Cons *otem;
3413 Lisp_Object len;
3415 tem = read_list (1, readcharfun);
3416 len = Flength (tem);
3417 vector = Fmake_vector (len, Qnil);
3419 size = ASIZE (vector);
3420 ptr = XVECTOR (vector)->contents;
3421 for (i = 0; i < size; i++)
3423 item = Fcar (tem);
3424 /* If `load-force-doc-strings' is t when reading a lazily-loaded
3425 bytecode object, the docstring containing the bytecode and
3426 constants values must be treated as unibyte and passed to
3427 Fread, to get the actual bytecode string and constants vector. */
3428 if (bytecodeflag && load_force_doc_strings)
3430 if (i == COMPILED_BYTECODE)
3432 if (!STRINGP (item))
3433 error ("Invalid byte code");
3435 /* Delay handling the bytecode slot until we know whether
3436 it is lazily-loaded (we can tell by whether the
3437 constants slot is nil). */
3438 ASET (vector, COMPILED_CONSTANTS, item);
3439 item = Qnil;
3441 else if (i == COMPILED_CONSTANTS)
3443 Lisp_Object bytestr = ptr[COMPILED_CONSTANTS];
3445 if (NILP (item))
3447 /* Coerce string to unibyte (like string-as-unibyte,
3448 but without generating extra garbage and
3449 guaranteeing no change in the contents). */
3450 STRING_SET_CHARS (bytestr, SBYTES (bytestr));
3451 STRING_SET_UNIBYTE (bytestr);
3453 item = Fread (Fcons (bytestr, readcharfun));
3454 if (!CONSP (item))
3455 error ("Invalid byte code");
3457 otem = XCONS (item);
3458 bytestr = XCAR (item);
3459 item = XCDR (item);
3460 free_cons (otem);
3463 /* Now handle the bytecode slot. */
3464 ASET (vector, COMPILED_BYTECODE, bytestr);
3466 else if (i == COMPILED_DOC_STRING
3467 && STRINGP (item)
3468 && ! STRING_MULTIBYTE (item))
3470 if (EQ (readcharfun, Qget_emacs_mule_file_char))
3471 item = Fdecode_coding_string (item, Qemacs_mule, Qnil, Qnil);
3472 else
3473 item = Fstring_as_multibyte (item);
3476 ASET (vector, i, item);
3477 otem = XCONS (tem);
3478 tem = Fcdr (tem);
3479 free_cons (otem);
3481 return vector;
3484 /* FLAG means check for ] to terminate rather than ) and . */
3486 static Lisp_Object
3487 read_list (bool flag, Lisp_Object readcharfun)
3489 Lisp_Object val, tail;
3490 Lisp_Object elt, tem;
3491 struct gcpro gcpro1, gcpro2;
3492 /* 0 is the normal case.
3493 1 means this list is a doc reference; replace it with the number 0.
3494 2 means this list is a doc reference; replace it with the doc string. */
3495 int doc_reference = 0;
3497 /* Initialize this to 1 if we are reading a list. */
3498 bool first_in_list = flag <= 0;
3500 val = Qnil;
3501 tail = Qnil;
3503 while (1)
3505 int ch;
3506 GCPRO2 (val, tail);
3507 elt = read1 (readcharfun, &ch, first_in_list);
3508 UNGCPRO;
3510 first_in_list = 0;
3512 /* While building, if the list starts with #$, treat it specially. */
3513 if (EQ (elt, Vload_file_name)
3514 && ! NILP (elt)
3515 && !NILP (Vpurify_flag))
3517 if (NILP (Vdoc_file_name))
3518 /* We have not yet called Snarf-documentation, so assume
3519 this file is described in the DOC-MM.NN file
3520 and Snarf-documentation will fill in the right value later.
3521 For now, replace the whole list with 0. */
3522 doc_reference = 1;
3523 else
3524 /* We have already called Snarf-documentation, so make a relative
3525 file name for this file, so it can be found properly
3526 in the installed Lisp directory.
3527 We don't use Fexpand_file_name because that would make
3528 the directory absolute now. */
3529 elt = concat2 (build_string ("../lisp/"),
3530 Ffile_name_nondirectory (elt));
3532 else if (EQ (elt, Vload_file_name)
3533 && ! NILP (elt)
3534 && load_force_doc_strings)
3535 doc_reference = 2;
3537 if (ch)
3539 if (flag > 0)
3541 if (ch == ']')
3542 return val;
3543 invalid_syntax (") or . in a vector");
3545 if (ch == ')')
3546 return val;
3547 if (ch == '.')
3549 GCPRO2 (val, tail);
3550 if (!NILP (tail))
3551 XSETCDR (tail, read0 (readcharfun));
3552 else
3553 val = read0 (readcharfun);
3554 read1 (readcharfun, &ch, 0);
3555 UNGCPRO;
3556 if (ch == ')')
3558 if (doc_reference == 1)
3559 return make_number (0);
3560 if (doc_reference == 2)
3562 /* Get a doc string from the file we are loading.
3563 If it's in saved_doc_string, get it from there.
3565 Here, we don't know if the string is a
3566 bytecode string or a doc string. As a
3567 bytecode string must be unibyte, we always
3568 return a unibyte string. If it is actually a
3569 doc string, caller must make it
3570 multibyte. */
3572 EMACS_INT pos = XINT (XCDR (val));
3573 /* Position is negative for user variables. */
3574 if (pos < 0) pos = -pos;
3575 if (pos >= saved_doc_string_position
3576 && pos < (saved_doc_string_position
3577 + saved_doc_string_length))
3579 ptrdiff_t start = pos - saved_doc_string_position;
3580 ptrdiff_t from, to;
3582 /* Process quoting with ^A,
3583 and find the end of the string,
3584 which is marked with ^_ (037). */
3585 for (from = start, to = start;
3586 saved_doc_string[from] != 037;)
3588 int c = saved_doc_string[from++];
3589 if (c == 1)
3591 c = saved_doc_string[from++];
3592 if (c == 1)
3593 saved_doc_string[to++] = c;
3594 else if (c == '0')
3595 saved_doc_string[to++] = 0;
3596 else if (c == '_')
3597 saved_doc_string[to++] = 037;
3599 else
3600 saved_doc_string[to++] = c;
3603 return make_unibyte_string (saved_doc_string + start,
3604 to - start);
3606 /* Look in prev_saved_doc_string the same way. */
3607 else if (pos >= prev_saved_doc_string_position
3608 && pos < (prev_saved_doc_string_position
3609 + prev_saved_doc_string_length))
3611 ptrdiff_t start =
3612 pos - prev_saved_doc_string_position;
3613 ptrdiff_t from, to;
3615 /* Process quoting with ^A,
3616 and find the end of the string,
3617 which is marked with ^_ (037). */
3618 for (from = start, to = start;
3619 prev_saved_doc_string[from] != 037;)
3621 int c = prev_saved_doc_string[from++];
3622 if (c == 1)
3624 c = prev_saved_doc_string[from++];
3625 if (c == 1)
3626 prev_saved_doc_string[to++] = c;
3627 else if (c == '0')
3628 prev_saved_doc_string[to++] = 0;
3629 else if (c == '_')
3630 prev_saved_doc_string[to++] = 037;
3632 else
3633 prev_saved_doc_string[to++] = c;
3636 return make_unibyte_string (prev_saved_doc_string
3637 + start,
3638 to - start);
3640 else
3641 return get_doc_string (val, 1, 0);
3644 return val;
3646 invalid_syntax (". in wrong context");
3648 invalid_syntax ("] in a list");
3650 tem = Fcons (elt, Qnil);
3651 if (!NILP (tail))
3652 XSETCDR (tail, tem);
3653 else
3654 val = tem;
3655 tail = tem;
3659 static Lisp_Object initial_obarray;
3661 /* `oblookup' stores the bucket number here, for the sake of Funintern. */
3663 static size_t oblookup_last_bucket_number;
3665 /* Get an error if OBARRAY is not an obarray.
3666 If it is one, return it. */
3668 Lisp_Object
3669 check_obarray (Lisp_Object obarray)
3671 if (!VECTORP (obarray) || ASIZE (obarray) == 0)
3673 /* If Vobarray is now invalid, force it to be valid. */
3674 if (EQ (Vobarray, obarray)) Vobarray = initial_obarray;
3675 wrong_type_argument (Qvectorp, obarray);
3677 return obarray;
3680 /* Intern the C string STR: return a symbol with that name,
3681 interned in the current obarray. */
3683 Lisp_Object
3684 intern_1 (const char *str, ptrdiff_t len)
3686 Lisp_Object obarray = check_obarray (Vobarray);
3687 Lisp_Object tem = oblookup (obarray, str, len, len);
3689 return SYMBOLP (tem) ? tem : Fintern (make_string (str, len), obarray);
3692 Lisp_Object
3693 intern_c_string_1 (const char *str, ptrdiff_t len)
3695 Lisp_Object obarray = check_obarray (Vobarray);
3696 Lisp_Object tem = oblookup (obarray, str, len, len);
3698 if (SYMBOLP (tem))
3699 return tem;
3701 if (NILP (Vpurify_flag))
3702 /* Creating a non-pure string from a string literal not
3703 implemented yet. We could just use make_string here and live
3704 with the extra copy. */
3705 emacs_abort ();
3707 return Fintern (make_pure_c_string (str, len), obarray);
3710 DEFUN ("intern", Fintern, Sintern, 1, 2, 0,
3711 doc: /* Return the canonical symbol whose name is STRING.
3712 If there is none, one is created by this function and returned.
3713 A second optional argument specifies the obarray to use;
3714 it defaults to the value of `obarray'. */)
3715 (Lisp_Object string, Lisp_Object obarray)
3717 register Lisp_Object tem, sym, *ptr;
3719 if (NILP (obarray)) obarray = Vobarray;
3720 obarray = check_obarray (obarray);
3722 CHECK_STRING (string);
3724 tem = oblookup (obarray, SSDATA (string),
3725 SCHARS (string),
3726 SBYTES (string));
3727 if (!INTEGERP (tem))
3728 return tem;
3730 if (!NILP (Vpurify_flag))
3731 string = Fpurecopy (string);
3732 sym = Fmake_symbol (string);
3734 if (EQ (obarray, initial_obarray))
3735 XSYMBOL (sym)->interned = SYMBOL_INTERNED_IN_INITIAL_OBARRAY;
3736 else
3737 XSYMBOL (sym)->interned = SYMBOL_INTERNED;
3739 if ((SREF (string, 0) == ':')
3740 && EQ (obarray, initial_obarray))
3742 XSYMBOL (sym)->constant = 1;
3743 XSYMBOL (sym)->redirect = SYMBOL_PLAINVAL;
3744 SET_SYMBOL_VAL (XSYMBOL (sym), sym);
3747 ptr = aref_addr (obarray, XINT(tem));
3748 if (SYMBOLP (*ptr))
3749 set_symbol_next (sym, XSYMBOL (*ptr));
3750 else
3751 set_symbol_next (sym, NULL);
3752 *ptr = sym;
3753 return sym;
3756 DEFUN ("intern-soft", Fintern_soft, Sintern_soft, 1, 2, 0,
3757 doc: /* Return the canonical symbol named NAME, or nil if none exists.
3758 NAME may be a string or a symbol. If it is a symbol, that exact
3759 symbol is searched for.
3760 A second optional argument specifies the obarray to use;
3761 it defaults to the value of `obarray'. */)
3762 (Lisp_Object name, Lisp_Object obarray)
3764 register Lisp_Object tem, string;
3766 if (NILP (obarray)) obarray = Vobarray;
3767 obarray = check_obarray (obarray);
3769 if (!SYMBOLP (name))
3771 CHECK_STRING (name);
3772 string = name;
3774 else
3775 string = SYMBOL_NAME (name);
3777 tem = oblookup (obarray, SSDATA (string), SCHARS (string), SBYTES (string));
3778 if (INTEGERP (tem) || (SYMBOLP (name) && !EQ (name, tem)))
3779 return Qnil;
3780 else
3781 return tem;
3784 DEFUN ("unintern", Funintern, Sunintern, 1, 2, 0,
3785 doc: /* Delete the symbol named NAME, if any, from OBARRAY.
3786 The value is t if a symbol was found and deleted, nil otherwise.
3787 NAME may be a string or a symbol. If it is a symbol, that symbol
3788 is deleted, if it belongs to OBARRAY--no other symbol is deleted.
3789 OBARRAY defaults to the value of the variable `obarray'. */)
3790 (Lisp_Object name, Lisp_Object obarray)
3792 register Lisp_Object string, tem;
3793 size_t hash;
3795 if (NILP (obarray)) obarray = Vobarray;
3796 obarray = check_obarray (obarray);
3798 if (SYMBOLP (name))
3799 string = SYMBOL_NAME (name);
3800 else
3802 CHECK_STRING (name);
3803 string = name;
3806 tem = oblookup (obarray, SSDATA (string),
3807 SCHARS (string),
3808 SBYTES (string));
3809 if (INTEGERP (tem))
3810 return Qnil;
3811 /* If arg was a symbol, don't delete anything but that symbol itself. */
3812 if (SYMBOLP (name) && !EQ (name, tem))
3813 return Qnil;
3815 /* There are plenty of other symbols which will screw up the Emacs
3816 session if we unintern them, as well as even more ways to use
3817 `setq' or `fset' or whatnot to make the Emacs session
3818 unusable. Let's not go down this silly road. --Stef */
3819 /* if (EQ (tem, Qnil) || EQ (tem, Qt))
3820 error ("Attempt to unintern t or nil"); */
3822 XSYMBOL (tem)->interned = SYMBOL_UNINTERNED;
3824 hash = oblookup_last_bucket_number;
3826 if (EQ (AREF (obarray, hash), tem))
3828 if (XSYMBOL (tem)->next)
3830 Lisp_Object sym;
3831 XSETSYMBOL (sym, XSYMBOL (tem)->next);
3832 ASET (obarray, hash, sym);
3834 else
3835 ASET (obarray, hash, make_number (0));
3837 else
3839 Lisp_Object tail, following;
3841 for (tail = AREF (obarray, hash);
3842 XSYMBOL (tail)->next;
3843 tail = following)
3845 XSETSYMBOL (following, XSYMBOL (tail)->next);
3846 if (EQ (following, tem))
3848 set_symbol_next (tail, XSYMBOL (following)->next);
3849 break;
3854 return Qt;
3857 /* Return the symbol in OBARRAY whose names matches the string
3858 of SIZE characters (SIZE_BYTE bytes) at PTR.
3859 If there is no such symbol in OBARRAY, return nil.
3861 Also store the bucket number in oblookup_last_bucket_number. */
3863 Lisp_Object
3864 oblookup (Lisp_Object obarray, register const char *ptr, ptrdiff_t size, ptrdiff_t size_byte)
3866 size_t hash;
3867 size_t obsize;
3868 register Lisp_Object tail;
3869 Lisp_Object bucket, tem;
3871 obarray = check_obarray (obarray);
3872 obsize = ASIZE (obarray);
3874 /* This is sometimes needed in the middle of GC. */
3875 obsize &= ~ARRAY_MARK_FLAG;
3876 hash = hash_string (ptr, size_byte) % obsize;
3877 bucket = AREF (obarray, hash);
3878 oblookup_last_bucket_number = hash;
3879 if (EQ (bucket, make_number (0)))
3881 else if (!SYMBOLP (bucket))
3882 error ("Bad data in guts of obarray"); /* Like CADR error message. */
3883 else
3884 for (tail = bucket; ; XSETSYMBOL (tail, XSYMBOL (tail)->next))
3886 if (SBYTES (SYMBOL_NAME (tail)) == size_byte
3887 && SCHARS (SYMBOL_NAME (tail)) == size
3888 && !memcmp (SDATA (SYMBOL_NAME (tail)), ptr, size_byte))
3889 return tail;
3890 else if (XSYMBOL (tail)->next == 0)
3891 break;
3893 XSETINT (tem, hash);
3894 return tem;
3897 void
3898 map_obarray (Lisp_Object obarray, void (*fn) (Lisp_Object, Lisp_Object), Lisp_Object arg)
3900 ptrdiff_t i;
3901 register Lisp_Object tail;
3902 CHECK_VECTOR (obarray);
3903 for (i = ASIZE (obarray) - 1; i >= 0; i--)
3905 tail = AREF (obarray, i);
3906 if (SYMBOLP (tail))
3907 while (1)
3909 (*fn) (tail, arg);
3910 if (XSYMBOL (tail)->next == 0)
3911 break;
3912 XSETSYMBOL (tail, XSYMBOL (tail)->next);
3917 static void
3918 mapatoms_1 (Lisp_Object sym, Lisp_Object function)
3920 call1 (function, sym);
3923 DEFUN ("mapatoms", Fmapatoms, Smapatoms, 1, 2, 0,
3924 doc: /* Call FUNCTION on every symbol in OBARRAY.
3925 OBARRAY defaults to the value of `obarray'. */)
3926 (Lisp_Object function, Lisp_Object obarray)
3928 if (NILP (obarray)) obarray = Vobarray;
3929 obarray = check_obarray (obarray);
3931 map_obarray (obarray, mapatoms_1, function);
3932 return Qnil;
3935 #define OBARRAY_SIZE 1511
3937 void
3938 init_obarray (void)
3940 Lisp_Object oblength;
3941 ptrdiff_t size = 100 + MAX_MULTIBYTE_LENGTH;
3943 XSETFASTINT (oblength, OBARRAY_SIZE);
3945 Vobarray = Fmake_vector (oblength, make_number (0));
3946 initial_obarray = Vobarray;
3947 staticpro (&initial_obarray);
3949 Qunbound = Fmake_symbol (build_pure_c_string ("unbound"));
3950 /* Set temporary dummy values to Qnil and Vpurify_flag to satisfy the
3951 NILP (Vpurify_flag) check in intern_c_string. */
3952 Qnil = make_number (-1); Vpurify_flag = make_number (1);
3953 Qnil = intern_c_string ("nil");
3955 /* Fmake_symbol inits fields of new symbols with Qunbound and Qnil,
3956 so those two need to be fixed manually. */
3957 SET_SYMBOL_VAL (XSYMBOL (Qunbound), Qunbound);
3958 set_symbol_function (Qunbound, Qunbound);
3959 set_symbol_plist (Qunbound, Qnil);
3960 SET_SYMBOL_VAL (XSYMBOL (Qnil), Qnil);
3961 XSYMBOL (Qnil)->constant = 1;
3962 XSYMBOL (Qnil)->declared_special = 1;
3963 set_symbol_plist (Qnil, Qnil);
3965 Qt = intern_c_string ("t");
3966 SET_SYMBOL_VAL (XSYMBOL (Qt), Qt);
3967 XSYMBOL (Qnil)->declared_special = 1;
3968 XSYMBOL (Qt)->constant = 1;
3970 /* Qt is correct even if CANNOT_DUMP. loadup.el will set to nil at end. */
3971 Vpurify_flag = Qt;
3973 DEFSYM (Qvariable_documentation, "variable-documentation");
3975 read_buffer = xmalloc (size);
3976 read_buffer_size = size;
3979 void
3980 defsubr (struct Lisp_Subr *sname)
3982 Lisp_Object sym, tem;
3983 sym = intern_c_string (sname->symbol_name);
3984 XSETTYPED_PVECTYPE (sname, size, PVEC_SUBR);
3985 XSETSUBR (tem, sname);
3986 set_symbol_function (sym, tem);
3989 #ifdef NOTDEF /* Use fset in subr.el now! */
3990 void
3991 defalias (struct Lisp_Subr *sname, char *string)
3993 Lisp_Object sym;
3994 sym = intern (string);
3995 XSETSUBR (XSYMBOL (sym)->function, sname);
3997 #endif /* NOTDEF */
3999 /* Define an "integer variable"; a symbol whose value is forwarded to a
4000 C variable of type EMACS_INT. Sample call (with "xx" to fool make-docfile):
4001 DEFxxVAR_INT ("emacs-priority", &emacs_priority, "Documentation"); */
4002 void
4003 defvar_int (struct Lisp_Intfwd *i_fwd,
4004 const char *namestring, EMACS_INT *address)
4006 Lisp_Object sym;
4007 sym = intern_c_string (namestring);
4008 i_fwd->type = Lisp_Fwd_Int;
4009 i_fwd->intvar = address;
4010 XSYMBOL (sym)->declared_special = 1;
4011 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4012 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)i_fwd);
4015 /* Similar but define a variable whose value is t if address contains 1,
4016 nil if address contains 0. */
4017 void
4018 defvar_bool (struct Lisp_Boolfwd *b_fwd,
4019 const char *namestring, bool *address)
4021 Lisp_Object sym;
4022 sym = intern_c_string (namestring);
4023 b_fwd->type = Lisp_Fwd_Bool;
4024 b_fwd->boolvar = address;
4025 XSYMBOL (sym)->declared_special = 1;
4026 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4027 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)b_fwd);
4028 Vbyte_boolean_vars = Fcons (sym, Vbyte_boolean_vars);
4031 /* Similar but define a variable whose value is the Lisp Object stored
4032 at address. Two versions: with and without gc-marking of the C
4033 variable. The nopro version is used when that variable will be
4034 gc-marked for some other reason, since marking the same slot twice
4035 can cause trouble with strings. */
4036 void
4037 defvar_lisp_nopro (struct Lisp_Objfwd *o_fwd,
4038 const char *namestring, Lisp_Object *address)
4040 Lisp_Object sym;
4041 sym = intern_c_string (namestring);
4042 o_fwd->type = Lisp_Fwd_Obj;
4043 o_fwd->objvar = address;
4044 XSYMBOL (sym)->declared_special = 1;
4045 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4046 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)o_fwd);
4049 void
4050 defvar_lisp (struct Lisp_Objfwd *o_fwd,
4051 const char *namestring, Lisp_Object *address)
4053 defvar_lisp_nopro (o_fwd, namestring, address);
4054 staticpro (address);
4057 /* Similar but define a variable whose value is the Lisp Object stored
4058 at a particular offset in the current kboard object. */
4060 void
4061 defvar_kboard (struct Lisp_Kboard_Objfwd *ko_fwd,
4062 const char *namestring, int offset)
4064 Lisp_Object sym;
4065 sym = intern_c_string (namestring);
4066 ko_fwd->type = Lisp_Fwd_Kboard_Obj;
4067 ko_fwd->offset = offset;
4068 XSYMBOL (sym)->declared_special = 1;
4069 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4070 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)ko_fwd);
4073 /* Check that the elements of Vload_path exist. */
4075 static void
4076 load_path_check (void)
4078 Lisp_Object path_tail;
4080 /* The only elements that might not exist are those from
4081 PATH_LOADSEARCH, EMACSLOADPATH. Anything else is only added if
4082 it exists. */
4083 for (path_tail = Vload_path; !NILP (path_tail); path_tail = XCDR (path_tail))
4085 Lisp_Object dirfile;
4086 dirfile = Fcar (path_tail);
4087 if (STRINGP (dirfile))
4089 dirfile = Fdirectory_file_name (dirfile);
4090 if (access (SSDATA (dirfile), 0) < 0)
4091 dir_warning ("Warning: Lisp directory `%s' does not exist.\n",
4092 XCAR (path_tail));
4097 /* Record the value of load-path used at the start of dumping
4098 so we can see if the site changed it later during dumping. */
4099 static Lisp_Object dump_path;
4101 /* Compute the default Vload_path, with the following logic:
4102 If CANNOT_DUMP:
4103 use EMACSLOADPATH env-var if set; otherwise use PATH_LOADSEARCH,
4104 prepending PATH_SITELOADSEARCH unless --no-site-lisp.
4105 The remainder is what happens when dumping works:
4106 If purify-flag (ie dumping) just use PATH_DUMPLOADSEARCH.
4107 Otherwise use EMACSLOADPATH if set, else PATH_LOADSEARCH.
4109 If !initialized, then just set both Vload_path and dump_path.
4110 If initialized, then if Vload_path != dump_path, do nothing.
4111 (Presumably the load-path has already been changed by something.
4112 This can only be from a site-load file during dumping,
4113 or because EMACSLOADPATH is set.)
4114 If Vinstallation_directory is not nil (ie, running uninstalled):
4115 If installation-dir/lisp exists and not already a member,
4116 we must be running uninstalled. Reset the load-path
4117 to just installation-dir/lisp. (The default PATH_LOADSEARCH
4118 refers to the eventual installation directories. Since we
4119 are not yet installed, we should not use them, even if they exist.)
4120 If installation-dir/lisp does not exist, just add dump_path at the
4121 end instead.
4122 Add installation-dir/leim (if exists and not already a member) at the front.
4123 Add installation-dir/site-lisp (if !no_site_lisp, and exists
4124 and not already a member) at the front.
4125 If installation-dir != source-dir (ie running an uninstalled,
4126 out-of-tree build) AND install-dir/src/Makefile exists BUT
4127 install-dir/src/Makefile.in does NOT exist (this is a sanity
4128 check), then repeat the above steps for source-dir/lisp,
4129 leim and site-lisp.
4130 Finally, add the site-lisp directories at the front (if !no_site_lisp).
4133 void
4134 init_lread (void)
4136 const char *normal;
4138 #ifdef CANNOT_DUMP
4139 #ifdef HAVE_NS
4140 const char *loadpath = ns_load_path ();
4141 #endif
4143 normal = PATH_LOADSEARCH;
4144 #ifdef HAVE_NS
4145 Vload_path = decode_env_path ("EMACSLOADPATH", loadpath ? loadpath : normal);
4146 #else
4147 Vload_path = decode_env_path ("EMACSLOADPATH", normal);
4148 #endif
4150 load_path_check ();
4152 /* FIXME CANNOT_DUMP platforms should get source-dir/lisp etc added
4153 to their load-path too, AFAICS. I don't think we can tell the
4154 difference between initialized and !initialized in this case,
4155 so we'll have to do it unconditionally when Vinstallation_directory
4156 is non-nil. */
4157 if (!no_site_lisp && !egetenv ("EMACSLOADPATH"))
4159 Lisp_Object sitelisp;
4160 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH);
4161 if (! NILP (sitelisp)) Vload_path = nconc2 (sitelisp, Vload_path);
4163 #else /* !CANNOT_DUMP */
4164 if (NILP (Vpurify_flag))
4166 normal = PATH_LOADSEARCH;
4167 /* If the EMACSLOADPATH environment variable is set, use its value.
4168 This doesn't apply if we're dumping. */
4169 if (egetenv ("EMACSLOADPATH"))
4170 Vload_path = decode_env_path ("EMACSLOADPATH", normal);
4172 else
4173 normal = PATH_DUMPLOADSEARCH;
4175 /* In a dumped Emacs, we normally reset the value of Vload_path using
4176 PATH_LOADSEARCH, since the value that was dumped uses lisp/ in
4177 the source directory, instead of the path of the installed elisp
4178 libraries. However, if it appears that Vload_path has already been
4179 changed from the default that was saved before dumping, don't
4180 change it further. Changes can only be due to EMACSLOADPATH, or
4181 site-lisp files that were processed during dumping. */
4182 if (initialized)
4184 if (NILP (Fequal (dump_path, Vload_path)))
4186 /* Do not make any changes, just check the elements exist. */
4187 /* Note: --no-site-lisp is ignored.
4188 I don't know what to do about this. */
4189 load_path_check ();
4191 else
4193 #ifdef HAVE_NS
4194 const char *loadpath = ns_load_path ();
4195 Vload_path = decode_env_path (0, loadpath ? loadpath : normal);
4196 #else
4197 Vload_path = decode_env_path (0, normal);
4198 #endif
4199 if (!NILP (Vinstallation_directory))
4201 Lisp_Object tem, tem1;
4203 /* Add to the path the lisp subdir of the installation
4204 dir, if it exists. Note: in out-of-tree builds,
4205 this directory is empty save for Makefile. */
4206 tem = Fexpand_file_name (build_string ("lisp"),
4207 Vinstallation_directory);
4208 tem1 = Ffile_exists_p (tem);
4209 if (!NILP (tem1))
4211 if (NILP (Fmember (tem, Vload_path)))
4213 /* We are running uninstalled. The default load-path
4214 points to the eventual installed lisp, leim
4215 directories. We should not use those now, even
4216 if they exist, so start over from a clean slate. */
4217 Vload_path = Fcons (tem, Qnil);
4220 else
4221 /* That dir doesn't exist, so add the build-time
4222 Lisp dirs instead. */
4223 Vload_path = nconc2 (Vload_path, dump_path);
4225 /* Add leim under the installation dir, if it exists. */
4226 tem = Fexpand_file_name (build_string ("leim"),
4227 Vinstallation_directory);
4228 tem1 = Ffile_exists_p (tem);
4229 if (!NILP (tem1))
4231 if (NILP (Fmember (tem, Vload_path)))
4232 Vload_path = Fcons (tem, Vload_path);
4235 /* Add site-lisp under the installation dir, if it exists. */
4236 if (!no_site_lisp)
4238 tem = Fexpand_file_name (build_string ("site-lisp"),
4239 Vinstallation_directory);
4240 tem1 = Ffile_exists_p (tem);
4241 if (!NILP (tem1))
4243 if (NILP (Fmember (tem, Vload_path)))
4244 Vload_path = Fcons (tem, Vload_path);
4248 /* If Emacs was not built in the source directory,
4249 and it is run from where it was built, add to load-path
4250 the lisp, leim and site-lisp dirs under that directory. */
4252 if (NILP (Fequal (Vinstallation_directory, Vsource_directory)))
4254 Lisp_Object tem2;
4256 tem = Fexpand_file_name (build_string ("src/Makefile"),
4257 Vinstallation_directory);
4258 tem1 = Ffile_exists_p (tem);
4260 /* Don't be fooled if they moved the entire source tree
4261 AFTER dumping Emacs. If the build directory is indeed
4262 different from the source dir, src/Makefile.in and
4263 src/Makefile will not be found together. */
4264 tem = Fexpand_file_name (build_string ("src/Makefile.in"),
4265 Vinstallation_directory);
4266 tem2 = Ffile_exists_p (tem);
4267 if (!NILP (tem1) && NILP (tem2))
4269 tem = Fexpand_file_name (build_string ("lisp"),
4270 Vsource_directory);
4272 if (NILP (Fmember (tem, Vload_path)))
4273 Vload_path = Fcons (tem, Vload_path);
4275 tem = Fexpand_file_name (build_string ("leim"),
4276 Vsource_directory);
4278 if (NILP (Fmember (tem, Vload_path)))
4279 Vload_path = Fcons (tem, Vload_path);
4281 if (!no_site_lisp)
4283 tem = Fexpand_file_name (build_string ("site-lisp"),
4284 Vsource_directory);
4285 tem1 = Ffile_exists_p (tem);
4286 if (!NILP (tem1))
4288 if (NILP (Fmember (tem, Vload_path)))
4289 Vload_path = Fcons (tem, Vload_path);
4293 } /* Vinstallation_directory != Vsource_directory */
4295 } /* if Vinstallation_directory */
4297 /* Check before adding the site-lisp directories.
4298 The install should have created them, but they are not
4299 required, so no need to warn if they are absent.
4300 Or we might be running before installation. */
4301 load_path_check ();
4303 /* Add the site-lisp directories at the front. */
4304 if (!no_site_lisp)
4306 Lisp_Object sitelisp;
4307 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH);
4308 if (! NILP (sitelisp)) Vload_path = nconc2 (sitelisp, Vload_path);
4310 } /* if dump_path == Vload_path */
4312 else /* !initialized */
4314 /* NORMAL refers to PATH_DUMPLOADSEARCH, ie the lisp dir in the
4315 source directory. We used to add ../lisp (ie the lisp dir in
4316 the build directory) at the front here, but that caused trouble
4317 because it was copied from dump_path into Vload_path, above,
4318 when Vinstallation_directory was non-nil. It should not be
4319 necessary, since in out of tree builds lisp/ is empty, save
4320 for Makefile. */
4321 Vload_path = decode_env_path (0, normal);
4322 dump_path = Vload_path;
4323 /* No point calling load_path_check; load-path only contains essential
4324 elements from the source directory at this point. They cannot
4325 be missing unless something went extremely (and improbably)
4326 wrong, in which case the build will fail in obvious ways. */
4328 #endif /* !CANNOT_DUMP */
4330 Vvalues = Qnil;
4332 load_in_progress = 0;
4333 Vload_file_name = Qnil;
4335 load_descriptor_list = Qnil;
4337 Vstandard_input = Qt;
4338 Vloads_in_progress = Qnil;
4341 /* Print a warning, using format string FORMAT, that directory DIRNAME
4342 does not exist. Print it on stderr and put it in *Messages*. */
4344 void
4345 dir_warning (const char *format, Lisp_Object dirname)
4347 fprintf (stderr, format, SDATA (dirname));
4349 /* Don't log the warning before we've initialized!! */
4350 if (initialized)
4352 USE_SAFE_ALLOCA;
4353 char *buffer = SAFE_ALLOCA (SBYTES (dirname)
4354 + strlen (format) - (sizeof "%s" - 1) + 1);
4355 ptrdiff_t message_len = esprintf (buffer, format, SDATA (dirname));
4356 message_dolog (buffer, message_len, 0, STRING_MULTIBYTE (dirname));
4357 SAFE_FREE ();
4361 void
4362 syms_of_lread (void)
4364 defsubr (&Sread);
4365 defsubr (&Sread_from_string);
4366 defsubr (&Sintern);
4367 defsubr (&Sintern_soft);
4368 defsubr (&Sunintern);
4369 defsubr (&Sget_load_suffixes);
4370 defsubr (&Sload);
4371 defsubr (&Seval_buffer);
4372 defsubr (&Seval_region);
4373 defsubr (&Sread_char);
4374 defsubr (&Sread_char_exclusive);
4375 defsubr (&Sread_event);
4376 defsubr (&Sget_file_char);
4377 defsubr (&Smapatoms);
4378 defsubr (&Slocate_file_internal);
4380 DEFVAR_LISP ("obarray", Vobarray,
4381 doc: /* Symbol table for use by `intern' and `read'.
4382 It is a vector whose length ought to be prime for best results.
4383 The vector's contents don't make sense if examined from Lisp programs;
4384 to find all the symbols in an obarray, use `mapatoms'. */);
4386 DEFVAR_LISP ("values", Vvalues,
4387 doc: /* List of values of all expressions which were read, evaluated and printed.
4388 Order is reverse chronological. */);
4389 XSYMBOL (intern ("values"))->declared_special = 0;
4391 DEFVAR_LISP ("standard-input", Vstandard_input,
4392 doc: /* Stream for read to get input from.
4393 See documentation of `read' for possible values. */);
4394 Vstandard_input = Qt;
4396 DEFVAR_LISP ("read-with-symbol-positions", Vread_with_symbol_positions,
4397 doc: /* If non-nil, add position of read symbols to `read-symbol-positions-list'.
4399 If this variable is a buffer, then only forms read from that buffer
4400 will be added to `read-symbol-positions-list'.
4401 If this variable is t, then all read forms will be added.
4402 The effect of all other values other than nil are not currently
4403 defined, although they may be in the future.
4405 The positions are relative to the last call to `read' or
4406 `read-from-string'. It is probably a bad idea to set this variable at
4407 the toplevel; bind it instead. */);
4408 Vread_with_symbol_positions = Qnil;
4410 DEFVAR_LISP ("read-symbol-positions-list", Vread_symbol_positions_list,
4411 doc: /* A list mapping read symbols to their positions.
4412 This variable is modified during calls to `read' or
4413 `read-from-string', but only when `read-with-symbol-positions' is
4414 non-nil.
4416 Each element of the list looks like (SYMBOL . CHAR-POSITION), where
4417 CHAR-POSITION is an integer giving the offset of that occurrence of the
4418 symbol from the position where `read' or `read-from-string' started.
4420 Note that a symbol will appear multiple times in this list, if it was
4421 read multiple times. The list is in the same order as the symbols
4422 were read in. */);
4423 Vread_symbol_positions_list = Qnil;
4425 DEFVAR_LISP ("read-circle", Vread_circle,
4426 doc: /* Non-nil means read recursive structures using #N= and #N# syntax. */);
4427 Vread_circle = Qt;
4429 DEFVAR_LISP ("load-path", Vload_path,
4430 doc: /* List of directories to search for files to load.
4431 Each element is a string (directory name) or nil (try default directory).
4432 Initialized based on EMACSLOADPATH environment variable, if any,
4433 otherwise to default specified by file `epaths.h' when Emacs was built. */);
4435 DEFVAR_LISP ("load-suffixes", Vload_suffixes,
4436 doc: /* List of suffixes for (compiled or source) Emacs Lisp files.
4437 This list should not include the empty string.
4438 `load' and related functions try to append these suffixes, in order,
4439 to the specified file name if a Lisp suffix is allowed or required. */);
4440 Vload_suffixes = Fcons (build_pure_c_string (".elc"),
4441 Fcons (build_pure_c_string (".el"), Qnil));
4442 DEFVAR_LISP ("load-file-rep-suffixes", Vload_file_rep_suffixes,
4443 doc: /* List of suffixes that indicate representations of \
4444 the same file.
4445 This list should normally start with the empty string.
4447 Enabling Auto Compression mode appends the suffixes in
4448 `jka-compr-load-suffixes' to this list and disabling Auto Compression
4449 mode removes them again. `load' and related functions use this list to
4450 determine whether they should look for compressed versions of a file
4451 and, if so, which suffixes they should try to append to the file name
4452 in order to do so. However, if you want to customize which suffixes
4453 the loading functions recognize as compression suffixes, you should
4454 customize `jka-compr-load-suffixes' rather than the present variable. */);
4455 Vload_file_rep_suffixes = Fcons (empty_unibyte_string, Qnil);
4457 DEFVAR_BOOL ("load-in-progress", load_in_progress,
4458 doc: /* Non-nil if inside of `load'. */);
4459 DEFSYM (Qload_in_progress, "load-in-progress");
4461 DEFVAR_LISP ("after-load-alist", Vafter_load_alist,
4462 doc: /* An alist of expressions to be evalled when particular files are loaded.
4463 Each element looks like (REGEXP-OR-FEATURE FORMS...).
4465 REGEXP-OR-FEATURE is either a regular expression to match file names, or
4466 a symbol \(a feature name).
4468 When `load' is run and the file-name argument matches an element's
4469 REGEXP-OR-FEATURE, or when `provide' is run and provides the symbol
4470 REGEXP-OR-FEATURE, the FORMS in the element are executed.
4472 An error in FORMS does not undo the load, but does prevent execution of
4473 the rest of the FORMS. */);
4474 Vafter_load_alist = Qnil;
4476 DEFVAR_LISP ("load-history", Vload_history,
4477 doc: /* Alist mapping loaded file names to symbols and features.
4478 Each alist element should be a list (FILE-NAME ENTRIES...), where
4479 FILE-NAME is the name of a file that has been loaded into Emacs.
4480 The file name is absolute and true (i.e. it doesn't contain symlinks).
4481 As an exception, one of the alist elements may have FILE-NAME nil,
4482 for symbols and features not associated with any file.
4484 The remaining ENTRIES in the alist element describe the functions and
4485 variables defined in that file, the features provided, and the
4486 features required. Each entry has the form `(provide . FEATURE)',
4487 `(require . FEATURE)', `(defun . FUNCTION)', `(autoload . SYMBOL)',
4488 `(defface . SYMBOL)', or `(t . SYMBOL)'. Entries like `(t . SYMBOL)'
4489 may precede a `(defun . FUNCTION)' entry, and means that SYMBOL was an
4490 autoload before this file redefined it as a function. In addition,
4491 entries may also be single symbols, which means that SYMBOL was
4492 defined by `defvar' or `defconst'.
4494 During preloading, the file name recorded is relative to the main Lisp
4495 directory. These file names are converted to absolute at startup. */);
4496 Vload_history = Qnil;
4498 DEFVAR_LISP ("load-file-name", Vload_file_name,
4499 doc: /* Full name of file being loaded by `load'. */);
4500 Vload_file_name = Qnil;
4502 DEFVAR_LISP ("user-init-file", Vuser_init_file,
4503 doc: /* File name, including directory, of user's initialization file.
4504 If the file loaded had extension `.elc', and the corresponding source file
4505 exists, this variable contains the name of source file, suitable for use
4506 by functions like `custom-save-all' which edit the init file.
4507 While Emacs loads and evaluates the init file, value is the real name
4508 of the file, regardless of whether or not it has the `.elc' extension. */);
4509 Vuser_init_file = Qnil;
4511 DEFVAR_LISP ("current-load-list", Vcurrent_load_list,
4512 doc: /* Used for internal purposes by `load'. */);
4513 Vcurrent_load_list = Qnil;
4515 DEFVAR_LISP ("load-read-function", Vload_read_function,
4516 doc: /* Function used by `load' and `eval-region' for reading expressions.
4517 The default is nil, which means use the function `read'. */);
4518 Vload_read_function = Qnil;
4520 DEFVAR_LISP ("load-source-file-function", Vload_source_file_function,
4521 doc: /* Function called in `load' to load an Emacs Lisp source file.
4522 The value should be a function for doing code conversion before
4523 reading a source file. It can also be nil, in which case loading is
4524 done without any code conversion.
4526 If the value is a function, it is called with four arguments,
4527 FULLNAME, FILE, NOERROR, NOMESSAGE. FULLNAME is the absolute name of
4528 the file to load, FILE is the non-absolute name (for messages etc.),
4529 and NOERROR and NOMESSAGE are the corresponding arguments passed to
4530 `load'. The function should return t if the file was loaded. */);
4531 Vload_source_file_function = Qnil;
4533 DEFVAR_BOOL ("load-force-doc-strings", load_force_doc_strings,
4534 doc: /* Non-nil means `load' should force-load all dynamic doc strings.
4535 This is useful when the file being loaded is a temporary copy. */);
4536 load_force_doc_strings = 0;
4538 DEFVAR_BOOL ("load-convert-to-unibyte", load_convert_to_unibyte,
4539 doc: /* Non-nil means `read' converts strings to unibyte whenever possible.
4540 This is normally bound by `load' and `eval-buffer' to control `read',
4541 and is not meant for users to change. */);
4542 load_convert_to_unibyte = 0;
4544 DEFVAR_LISP ("source-directory", Vsource_directory,
4545 doc: /* Directory in which Emacs sources were found when Emacs was built.
4546 You cannot count on them to still be there! */);
4547 Vsource_directory
4548 = Fexpand_file_name (build_string ("../"),
4549 Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH)));
4551 DEFVAR_LISP ("preloaded-file-list", Vpreloaded_file_list,
4552 doc: /* List of files that were preloaded (when dumping Emacs). */);
4553 Vpreloaded_file_list = Qnil;
4555 DEFVAR_LISP ("byte-boolean-vars", Vbyte_boolean_vars,
4556 doc: /* List of all DEFVAR_BOOL variables, used by the byte code optimizer. */);
4557 Vbyte_boolean_vars = Qnil;
4559 DEFVAR_BOOL ("load-dangerous-libraries", load_dangerous_libraries,
4560 doc: /* Non-nil means load dangerous compiled Lisp files.
4561 Some versions of XEmacs use different byte codes than Emacs. These
4562 incompatible byte codes can make Emacs crash when it tries to execute
4563 them. */);
4564 load_dangerous_libraries = 0;
4566 DEFVAR_BOOL ("force-load-messages", force_load_messages,
4567 doc: /* Non-nil means force printing messages when loading Lisp files.
4568 This overrides the value of the NOMESSAGE argument to `load'. */);
4569 force_load_messages = 0;
4571 DEFVAR_LISP ("bytecomp-version-regexp", Vbytecomp_version_regexp,
4572 doc: /* Regular expression matching safe to load compiled Lisp files.
4573 When Emacs loads a compiled Lisp file, it reads the first 512 bytes
4574 from the file, and matches them against this regular expression.
4575 When the regular expression matches, the file is considered to be safe
4576 to load. See also `load-dangerous-libraries'. */);
4577 Vbytecomp_version_regexp
4578 = build_pure_c_string ("^;;;.\\(in Emacs version\\|bytecomp version FSF\\)");
4580 DEFSYM (Qlexical_binding, "lexical-binding");
4581 DEFVAR_LISP ("lexical-binding", Vlexical_binding,
4582 doc: /* Whether to use lexical binding when evaluating code.
4583 Non-nil means that the code in the current buffer should be evaluated
4584 with lexical binding.
4585 This variable is automatically set from the file variables of an
4586 interpreted Lisp file read using `load'. Unlike other file local
4587 variables, this must be set in the first line of a file. */);
4588 Vlexical_binding = Qnil;
4589 Fmake_variable_buffer_local (Qlexical_binding);
4591 DEFVAR_LISP ("eval-buffer-list", Veval_buffer_list,
4592 doc: /* List of buffers being read from by calls to `eval-buffer' and `eval-region'. */);
4593 Veval_buffer_list = Qnil;
4595 DEFVAR_LISP ("old-style-backquotes", Vold_style_backquotes,
4596 doc: /* Set to non-nil when `read' encounters an old-style backquote. */);
4597 Vold_style_backquotes = Qnil;
4598 DEFSYM (Qold_style_backquotes, "old-style-backquotes");
4600 /* Vsource_directory was initialized in init_lread. */
4602 load_descriptor_list = Qnil;
4603 staticpro (&load_descriptor_list);
4605 DEFSYM (Qcurrent_load_list, "current-load-list");
4606 DEFSYM (Qstandard_input, "standard-input");
4607 DEFSYM (Qread_char, "read-char");
4608 DEFSYM (Qget_file_char, "get-file-char");
4609 DEFSYM (Qget_emacs_mule_file_char, "get-emacs-mule-file-char");
4610 DEFSYM (Qload_force_doc_strings, "load-force-doc-strings");
4612 DEFSYM (Qbackquote, "`");
4613 DEFSYM (Qcomma, ",");
4614 DEFSYM (Qcomma_at, ",@");
4615 DEFSYM (Qcomma_dot, ",.");
4617 DEFSYM (Qinhibit_file_name_operation, "inhibit-file-name-operation");
4618 DEFSYM (Qascii_character, "ascii-character");
4619 DEFSYM (Qfunction, "function");
4620 DEFSYM (Qload, "load");
4621 DEFSYM (Qload_file_name, "load-file-name");
4622 DEFSYM (Qeval_buffer_list, "eval-buffer-list");
4623 DEFSYM (Qfile_truename, "file-truename");
4624 DEFSYM (Qdir_ok, "dir-ok");
4625 DEFSYM (Qdo_after_load_evaluation, "do-after-load-evaluation");
4627 staticpro (&dump_path);
4629 staticpro (&read_objects);
4630 read_objects = Qnil;
4631 staticpro (&seen_list);
4632 seen_list = Qnil;
4634 Vloads_in_progress = Qnil;
4635 staticpro (&Vloads_in_progress);
4637 DEFSYM (Qhash_table, "hash-table");
4638 DEFSYM (Qdata, "data");
4639 DEFSYM (Qtest, "test");
4640 DEFSYM (Qsize, "size");
4641 DEFSYM (Qweakness, "weakness");
4642 DEFSYM (Qrehash_size, "rehash-size");
4643 DEFSYM (Qrehash_threshold, "rehash-threshold");