* src/minibuf.c (read_minibuf): Use CONSP instead of Fconsp.
[emacs.git] / src / lread.c
blob98a4d69894b5b037fdedcb3f194fae2dd6fedaf1
1 /* Lisp parsing and input streams.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2016 Free Software Foundation,
4 Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* Tell globals.h to define tables needed by init_obarray. */
22 #define DEFINE_SYMBOLS
24 #include <config.h>
25 #include "sysstdio.h"
26 #include <sys/types.h>
27 #include <sys/stat.h>
28 #include <sys/file.h>
29 #include <errno.h>
30 #include <limits.h> /* For CHAR_BIT. */
31 #include <math.h>
32 #include <stat-time.h>
33 #include "lisp.h"
34 #include "dispextern.h"
35 #include "intervals.h"
36 #include "character.h"
37 #include "buffer.h"
38 #include "charset.h"
39 #include "coding.h"
40 #include <epaths.h>
41 #include "commands.h"
42 #include "keyboard.h"
43 #include "systime.h"
44 #include "termhooks.h"
45 #include "blockinput.h"
46 #include <c-ctype.h>
48 #ifdef MSDOS
49 #include "msdos.h"
50 #if __DJGPP__ == 2 && __DJGPP_MINOR__ < 5
51 # define INFINITY __builtin_inf()
52 # define NAN __builtin_nan("")
53 #endif
54 #endif
56 #ifdef HAVE_NS
57 #include "nsterm.h"
58 #endif
60 #include <unistd.h>
62 #ifdef HAVE_SETLOCALE
63 #include <locale.h>
64 #endif /* HAVE_SETLOCALE */
66 #include <fcntl.h>
68 #ifdef HAVE_FSEEKO
69 #define file_offset off_t
70 #define file_tell ftello
71 #else
72 #define file_offset long
73 #define file_tell ftell
74 #endif
76 /* The association list of objects read with the #n=object form.
77 Each member of the list has the form (n . object), and is used to
78 look up the object for the corresponding #n# construct.
79 It must be set to nil before all top-level calls to read0. */
80 static Lisp_Object read_objects;
82 /* File for get_file_char to read from. Use by load. */
83 static FILE *instream;
85 /* For use within read-from-string (this reader is non-reentrant!!) */
86 static ptrdiff_t read_from_string_index;
87 static ptrdiff_t read_from_string_index_byte;
88 static ptrdiff_t read_from_string_limit;
90 /* Number of characters read in the current call to Fread or
91 Fread_from_string. */
92 static EMACS_INT readchar_count;
94 /* This contains the last string skipped with #@. */
95 static char *saved_doc_string;
96 /* Length of buffer allocated in saved_doc_string. */
97 static ptrdiff_t saved_doc_string_size;
98 /* Length of actual data in saved_doc_string. */
99 static ptrdiff_t saved_doc_string_length;
100 /* This is the file position that string came from. */
101 static file_offset saved_doc_string_position;
103 /* This contains the previous string skipped with #@.
104 We copy it from saved_doc_string when a new string
105 is put in saved_doc_string. */
106 static char *prev_saved_doc_string;
107 /* Length of buffer allocated in prev_saved_doc_string. */
108 static ptrdiff_t prev_saved_doc_string_size;
109 /* Length of actual data in prev_saved_doc_string. */
110 static ptrdiff_t prev_saved_doc_string_length;
111 /* This is the file position that string came from. */
112 static file_offset prev_saved_doc_string_position;
114 /* True means inside a new-style backquote
115 with no surrounding parentheses.
116 Fread initializes this to false, so we need not specbind it
117 or worry about what happens to it when there is an error. */
118 static bool new_backquote_flag;
120 /* A list of file names for files being loaded in Fload. Used to
121 check for recursive loads. */
123 static Lisp_Object Vloads_in_progress;
125 static int read_emacs_mule_char (int, int (*) (int, Lisp_Object),
126 Lisp_Object);
128 static void readevalloop (Lisp_Object, FILE *, Lisp_Object, bool,
129 Lisp_Object, Lisp_Object,
130 Lisp_Object, Lisp_Object);
132 /* Functions that read one byte from the current source READCHARFUN
133 or unreads one byte. If the integer argument C is -1, it returns
134 one read byte, or -1 when there's no more byte in the source. If C
135 is 0 or positive, it unreads C, and the return value is not
136 interesting. */
138 static int readbyte_for_lambda (int, Lisp_Object);
139 static int readbyte_from_file (int, Lisp_Object);
140 static int readbyte_from_string (int, Lisp_Object);
142 /* Handle unreading and rereading of characters.
143 Write READCHAR to read a character,
144 UNREAD(c) to unread c to be read again.
146 These macros correctly read/unread multibyte characters. */
148 #define READCHAR readchar (readcharfun, NULL)
149 #define UNREAD(c) unreadchar (readcharfun, c)
151 /* Same as READCHAR but set *MULTIBYTE to the multibyteness of the source. */
152 #define READCHAR_REPORT_MULTIBYTE(multibyte) readchar (readcharfun, multibyte)
154 /* When READCHARFUN is Qget_file_char, Qget_emacs_mule_file_char,
155 Qlambda, or a cons, we use this to keep an unread character because
156 a file stream can't handle multibyte-char unreading. The value -1
157 means that there's no unread character. */
158 static int unread_char;
160 static int
161 readchar (Lisp_Object readcharfun, bool *multibyte)
163 Lisp_Object tem;
164 register int c;
165 int (*readbyte) (int, Lisp_Object);
166 unsigned char buf[MAX_MULTIBYTE_LENGTH];
167 int i, len;
168 bool emacs_mule_encoding = 0;
170 if (multibyte)
171 *multibyte = 0;
173 readchar_count++;
175 if (BUFFERP (readcharfun))
177 register struct buffer *inbuffer = XBUFFER (readcharfun);
179 ptrdiff_t pt_byte = BUF_PT_BYTE (inbuffer);
181 if (! BUFFER_LIVE_P (inbuffer))
182 return -1;
184 if (pt_byte >= BUF_ZV_BYTE (inbuffer))
185 return -1;
187 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
189 /* Fetch the character code from the buffer. */
190 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, pt_byte);
191 BUF_INC_POS (inbuffer, pt_byte);
192 c = STRING_CHAR (p);
193 if (multibyte)
194 *multibyte = 1;
196 else
198 c = BUF_FETCH_BYTE (inbuffer, pt_byte);
199 if (! ASCII_CHAR_P (c))
200 c = BYTE8_TO_CHAR (c);
201 pt_byte++;
203 SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
205 return c;
207 if (MARKERP (readcharfun))
209 register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
211 ptrdiff_t bytepos = marker_byte_position (readcharfun);
213 if (bytepos >= BUF_ZV_BYTE (inbuffer))
214 return -1;
216 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
218 /* Fetch the character code from the buffer. */
219 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, bytepos);
220 BUF_INC_POS (inbuffer, bytepos);
221 c = STRING_CHAR (p);
222 if (multibyte)
223 *multibyte = 1;
225 else
227 c = BUF_FETCH_BYTE (inbuffer, bytepos);
228 if (! ASCII_CHAR_P (c))
229 c = BYTE8_TO_CHAR (c);
230 bytepos++;
233 XMARKER (readcharfun)->bytepos = bytepos;
234 XMARKER (readcharfun)->charpos++;
236 return c;
239 if (EQ (readcharfun, Qlambda))
241 readbyte = readbyte_for_lambda;
242 goto read_multibyte;
245 if (EQ (readcharfun, Qget_file_char))
247 readbyte = readbyte_from_file;
248 goto read_multibyte;
251 if (STRINGP (readcharfun))
253 if (read_from_string_index >= read_from_string_limit)
254 c = -1;
255 else if (STRING_MULTIBYTE (readcharfun))
257 if (multibyte)
258 *multibyte = 1;
259 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, readcharfun,
260 read_from_string_index,
261 read_from_string_index_byte);
263 else
265 c = SREF (readcharfun, read_from_string_index_byte);
266 read_from_string_index++;
267 read_from_string_index_byte++;
269 return c;
272 if (CONSP (readcharfun) && STRINGP (XCAR (readcharfun)))
274 /* This is the case that read_vector is reading from a unibyte
275 string that contains a byte sequence previously skipped
276 because of #@NUMBER. The car part of readcharfun is that
277 string, and the cdr part is a value of readcharfun given to
278 read_vector. */
279 readbyte = readbyte_from_string;
280 if (EQ (XCDR (readcharfun), Qget_emacs_mule_file_char))
281 emacs_mule_encoding = 1;
282 goto read_multibyte;
285 if (EQ (readcharfun, Qget_emacs_mule_file_char))
287 readbyte = readbyte_from_file;
288 emacs_mule_encoding = 1;
289 goto read_multibyte;
292 tem = call0 (readcharfun);
294 if (NILP (tem))
295 return -1;
296 return XINT (tem);
298 read_multibyte:
299 if (unread_char >= 0)
301 c = unread_char;
302 unread_char = -1;
303 return c;
305 c = (*readbyte) (-1, readcharfun);
306 if (c < 0)
307 return c;
308 if (multibyte)
309 *multibyte = 1;
310 if (ASCII_CHAR_P (c))
311 return c;
312 if (emacs_mule_encoding)
313 return read_emacs_mule_char (c, readbyte, readcharfun);
314 i = 0;
315 buf[i++] = c;
316 len = BYTES_BY_CHAR_HEAD (c);
317 while (i < len)
319 c = (*readbyte) (-1, readcharfun);
320 if (c < 0 || ! TRAILING_CODE_P (c))
322 while (--i > 1)
323 (*readbyte) (buf[i], readcharfun);
324 return BYTE8_TO_CHAR (buf[0]);
326 buf[i++] = c;
328 return STRING_CHAR (buf);
331 #define FROM_FILE_P(readcharfun) \
332 (EQ (readcharfun, Qget_file_char) \
333 || EQ (readcharfun, Qget_emacs_mule_file_char))
335 static void
336 skip_dyn_bytes (Lisp_Object readcharfun, ptrdiff_t n)
338 if (FROM_FILE_P (readcharfun))
340 block_input (); /* FIXME: Not sure if it's needed. */
341 fseek (instream, n, SEEK_CUR);
342 unblock_input ();
344 else
345 { /* We're not reading directly from a file. In that case, it's difficult
346 to reliably count bytes, since these are usually meant for the file's
347 encoding, whereas we're now typically in the internal encoding.
348 But luckily, skip_dyn_bytes is used to skip over a single
349 dynamic-docstring (or dynamic byte-code) which is always quoted such
350 that \037 is the final char. */
351 int c;
352 do {
353 c = READCHAR;
354 } while (c >= 0 && c != '\037');
358 static void
359 skip_dyn_eof (Lisp_Object readcharfun)
361 if (FROM_FILE_P (readcharfun))
363 block_input (); /* FIXME: Not sure if it's needed. */
364 fseek (instream, 0, SEEK_END);
365 unblock_input ();
367 else
368 while (READCHAR >= 0);
371 /* Unread the character C in the way appropriate for the stream READCHARFUN.
372 If the stream is a user function, call it with the char as argument. */
374 static void
375 unreadchar (Lisp_Object readcharfun, int c)
377 readchar_count--;
378 if (c == -1)
379 /* Don't back up the pointer if we're unreading the end-of-input mark,
380 since readchar didn't advance it when we read it. */
382 else if (BUFFERP (readcharfun))
384 struct buffer *b = XBUFFER (readcharfun);
385 ptrdiff_t charpos = BUF_PT (b);
386 ptrdiff_t bytepos = BUF_PT_BYTE (b);
388 if (! NILP (BVAR (b, enable_multibyte_characters)))
389 BUF_DEC_POS (b, bytepos);
390 else
391 bytepos--;
393 SET_BUF_PT_BOTH (b, charpos - 1, bytepos);
395 else if (MARKERP (readcharfun))
397 struct buffer *b = XMARKER (readcharfun)->buffer;
398 ptrdiff_t bytepos = XMARKER (readcharfun)->bytepos;
400 XMARKER (readcharfun)->charpos--;
401 if (! NILP (BVAR (b, enable_multibyte_characters)))
402 BUF_DEC_POS (b, bytepos);
403 else
404 bytepos--;
406 XMARKER (readcharfun)->bytepos = bytepos;
408 else if (STRINGP (readcharfun))
410 read_from_string_index--;
411 read_from_string_index_byte
412 = string_char_to_byte (readcharfun, read_from_string_index);
414 else if (CONSP (readcharfun) && STRINGP (XCAR (readcharfun)))
416 unread_char = c;
418 else if (EQ (readcharfun, Qlambda))
420 unread_char = c;
422 else if (FROM_FILE_P (readcharfun))
424 unread_char = c;
426 else
427 call1 (readcharfun, make_number (c));
430 static int
431 readbyte_for_lambda (int c, Lisp_Object readcharfun)
433 return read_bytecode_char (c >= 0);
437 static int
438 readbyte_from_file (int c, Lisp_Object readcharfun)
440 if (c >= 0)
442 block_input ();
443 ungetc (c, instream);
444 unblock_input ();
445 return 0;
448 block_input ();
449 c = getc (instream);
451 /* Interrupted reads have been observed while reading over the network. */
452 while (c == EOF && ferror (instream) && errno == EINTR)
454 unblock_input ();
455 QUIT;
456 block_input ();
457 clearerr (instream);
458 c = getc (instream);
461 unblock_input ();
463 return (c == EOF ? -1 : c);
466 static int
467 readbyte_from_string (int c, Lisp_Object readcharfun)
469 Lisp_Object string = XCAR (readcharfun);
471 if (c >= 0)
473 read_from_string_index--;
474 read_from_string_index_byte
475 = string_char_to_byte (string, read_from_string_index);
478 if (read_from_string_index >= read_from_string_limit)
479 c = -1;
480 else
481 FETCH_STRING_CHAR_ADVANCE (c, string,
482 read_from_string_index,
483 read_from_string_index_byte);
484 return c;
488 /* Read one non-ASCII character from INSTREAM. The character is
489 encoded in `emacs-mule' and the first byte is already read in
490 C. */
492 static int
493 read_emacs_mule_char (int c, int (*readbyte) (int, Lisp_Object), Lisp_Object readcharfun)
495 /* Emacs-mule coding uses at most 4-byte for one character. */
496 unsigned char buf[4];
497 int len = emacs_mule_bytes[c];
498 struct charset *charset;
499 int i;
500 unsigned code;
502 if (len == 1)
503 /* C is not a valid leading-code of `emacs-mule'. */
504 return BYTE8_TO_CHAR (c);
506 i = 0;
507 buf[i++] = c;
508 while (i < len)
510 c = (*readbyte) (-1, readcharfun);
511 if (c < 0xA0)
513 while (--i > 1)
514 (*readbyte) (buf[i], readcharfun);
515 return BYTE8_TO_CHAR (buf[0]);
517 buf[i++] = c;
520 if (len == 2)
522 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
523 code = buf[1] & 0x7F;
525 else if (len == 3)
527 if (buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_11
528 || buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_12)
530 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
531 code = buf[2] & 0x7F;
533 else
535 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
536 code = ((buf[1] << 8) | buf[2]) & 0x7F7F;
539 else
541 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
542 code = ((buf[2] << 8) | buf[3]) & 0x7F7F;
544 c = DECODE_CHAR (charset, code);
545 if (c < 0)
546 Fsignal (Qinvalid_read_syntax,
547 list1 (build_string ("invalid multibyte form")));
548 return c;
552 static Lisp_Object read_internal_start (Lisp_Object, Lisp_Object,
553 Lisp_Object);
554 static Lisp_Object read0 (Lisp_Object);
555 static Lisp_Object read1 (Lisp_Object, int *, bool);
557 static Lisp_Object read_list (bool, Lisp_Object);
558 static Lisp_Object read_vector (Lisp_Object, bool);
560 static Lisp_Object substitute_object_recurse (Lisp_Object, Lisp_Object,
561 Lisp_Object);
562 static void substitute_object_in_subtree (Lisp_Object,
563 Lisp_Object);
564 static void substitute_in_interval (INTERVAL, Lisp_Object);
567 /* Get a character from the tty. */
569 /* Read input events until we get one that's acceptable for our purposes.
571 If NO_SWITCH_FRAME, switch-frame events are stashed
572 until we get a character we like, and then stuffed into
573 unread_switch_frame.
575 If ASCII_REQUIRED, check function key events to see
576 if the unmodified version of the symbol has a Qascii_character
577 property, and use that character, if present.
579 If ERROR_NONASCII, signal an error if the input we
580 get isn't an ASCII character with modifiers. If it's false but
581 ASCII_REQUIRED is true, just re-read until we get an ASCII
582 character.
584 If INPUT_METHOD, invoke the current input method
585 if the character warrants that.
587 If SECONDS is a number, wait that many seconds for input, and
588 return Qnil if no input arrives within that time. */
590 static Lisp_Object
591 read_filtered_event (bool no_switch_frame, bool ascii_required,
592 bool error_nonascii, bool input_method, Lisp_Object seconds)
594 Lisp_Object val, delayed_switch_frame;
595 struct timespec end_time;
597 #ifdef HAVE_WINDOW_SYSTEM
598 if (display_hourglass_p)
599 cancel_hourglass ();
600 #endif
602 delayed_switch_frame = Qnil;
604 /* Compute timeout. */
605 if (NUMBERP (seconds))
607 double duration = extract_float (seconds);
608 struct timespec wait_time = dtotimespec (duration);
609 end_time = timespec_add (current_timespec (), wait_time);
612 /* Read until we get an acceptable event. */
613 retry:
615 val = read_char (0, Qnil, (input_method ? Qnil : Qt), 0,
616 NUMBERP (seconds) ? &end_time : NULL);
617 while (INTEGERP (val) && XINT (val) == -2); /* wrong_kboard_jmpbuf */
619 if (BUFFERP (val))
620 goto retry;
622 /* `switch-frame' events are put off until after the next ASCII
623 character. This is better than signaling an error just because
624 the last characters were typed to a separate minibuffer frame,
625 for example. Eventually, some code which can deal with
626 switch-frame events will read it and process it. */
627 if (no_switch_frame
628 && EVENT_HAS_PARAMETERS (val)
629 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (val)), Qswitch_frame))
631 delayed_switch_frame = val;
632 goto retry;
635 if (ascii_required && !(NUMBERP (seconds) && NILP (val)))
637 /* Convert certain symbols to their ASCII equivalents. */
638 if (SYMBOLP (val))
640 Lisp_Object tem, tem1;
641 tem = Fget (val, Qevent_symbol_element_mask);
642 if (!NILP (tem))
644 tem1 = Fget (Fcar (tem), Qascii_character);
645 /* Merge this symbol's modifier bits
646 with the ASCII equivalent of its basic code. */
647 if (!NILP (tem1))
648 XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
652 /* If we don't have a character now, deal with it appropriately. */
653 if (!INTEGERP (val))
655 if (error_nonascii)
657 Vunread_command_events = list1 (val);
658 error ("Non-character input-event");
660 else
661 goto retry;
665 if (! NILP (delayed_switch_frame))
666 unread_switch_frame = delayed_switch_frame;
668 #if 0
670 #ifdef HAVE_WINDOW_SYSTEM
671 if (display_hourglass_p)
672 start_hourglass ();
673 #endif
675 #endif
677 return val;
680 DEFUN ("read-char", Fread_char, Sread_char, 0, 3, 0,
681 doc: /* Read a character from the command input (keyboard or macro).
682 It is returned as a number.
683 If the character has modifiers, they are resolved and reflected to the
684 character code if possible (e.g. C-SPC -> 0).
686 If the user generates an event which is not a character (i.e. a mouse
687 click or function key event), `read-char' signals an error. As an
688 exception, switch-frame events are put off until non-character events
689 can be read.
690 If you want to read non-character events, or ignore them, call
691 `read-event' or `read-char-exclusive' instead.
693 If the optional argument PROMPT is non-nil, display that as a prompt.
694 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
695 input method is turned on in the current buffer, that input method
696 is used for reading a character.
697 If the optional argument SECONDS is non-nil, it should be a number
698 specifying the maximum number of seconds to wait for input. If no
699 input arrives in that time, return nil. SECONDS may be a
700 floating-point value. */)
701 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
703 Lisp_Object val;
705 if (! NILP (prompt))
706 message_with_string ("%s", prompt, 0);
707 val = read_filtered_event (1, 1, 1, ! NILP (inherit_input_method), seconds);
709 return (NILP (val) ? Qnil
710 : make_number (char_resolve_modifier_mask (XINT (val))));
713 DEFUN ("read-event", Fread_event, Sread_event, 0, 3, 0,
714 doc: /* Read an event object from the input stream.
715 If the optional argument PROMPT is non-nil, display that as a prompt.
716 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
717 input method is turned on in the current buffer, that input method
718 is used for reading a character.
719 If the optional argument SECONDS is non-nil, it should be a number
720 specifying the maximum number of seconds to wait for input. If no
721 input arrives in that time, return nil. SECONDS may be a
722 floating-point value. */)
723 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
725 if (! NILP (prompt))
726 message_with_string ("%s", prompt, 0);
727 return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method), seconds);
730 DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 3, 0,
731 doc: /* Read a character from the command input (keyboard or macro).
732 It is returned as a number. Non-character events are ignored.
733 If the character has modifiers, they are resolved and reflected to the
734 character code if possible (e.g. C-SPC -> 0).
736 If the optional argument PROMPT is non-nil, display that as a prompt.
737 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
738 input method is turned on in the current buffer, that input method
739 is used for reading a character.
740 If the optional argument SECONDS is non-nil, it should be a number
741 specifying the maximum number of seconds to wait for input. If no
742 input arrives in that time, return nil. SECONDS may be a
743 floating-point value. */)
744 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
746 Lisp_Object val;
748 if (! NILP (prompt))
749 message_with_string ("%s", prompt, 0);
751 val = read_filtered_event (1, 1, 0, ! NILP (inherit_input_method), seconds);
753 return (NILP (val) ? Qnil
754 : make_number (char_resolve_modifier_mask (XINT (val))));
757 DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
758 doc: /* Don't use this yourself. */)
759 (void)
761 register Lisp_Object val;
762 block_input ();
763 XSETINT (val, getc (instream));
764 unblock_input ();
765 return val;
771 /* Return true if the lisp code read using READCHARFUN defines a non-nil
772 `lexical-binding' file variable. After returning, the stream is
773 positioned following the first line, if it is a comment or #! line,
774 otherwise nothing is read. */
776 static bool
777 lisp_file_lexically_bound_p (Lisp_Object readcharfun)
779 int ch = READCHAR;
781 if (ch == '#')
783 ch = READCHAR;
784 if (ch != '!')
786 UNREAD (ch);
787 UNREAD ('#');
788 return 0;
790 while (ch != '\n' && ch != EOF)
791 ch = READCHAR;
792 if (ch == '\n') ch = READCHAR;
793 /* It is OK to leave the position after a #! line, since
794 that is what read1 does. */
797 if (ch != ';')
798 /* The first line isn't a comment, just give up. */
800 UNREAD (ch);
801 return 0;
803 else
804 /* Look for an appropriate file-variable in the first line. */
806 bool rv = 0;
807 enum {
808 NOMINAL, AFTER_FIRST_DASH, AFTER_ASTERIX
809 } beg_end_state = NOMINAL;
810 bool in_file_vars = 0;
812 #define UPDATE_BEG_END_STATE(ch) \
813 if (beg_end_state == NOMINAL) \
814 beg_end_state = (ch == '-' ? AFTER_FIRST_DASH : NOMINAL); \
815 else if (beg_end_state == AFTER_FIRST_DASH) \
816 beg_end_state = (ch == '*' ? AFTER_ASTERIX : NOMINAL); \
817 else if (beg_end_state == AFTER_ASTERIX) \
819 if (ch == '-') \
820 in_file_vars = !in_file_vars; \
821 beg_end_state = NOMINAL; \
824 /* Skip until we get to the file vars, if any. */
827 ch = READCHAR;
828 UPDATE_BEG_END_STATE (ch);
830 while (!in_file_vars && ch != '\n' && ch != EOF);
832 while (in_file_vars)
834 char var[100], val[100];
835 unsigned i;
837 ch = READCHAR;
839 /* Read a variable name. */
840 while (ch == ' ' || ch == '\t')
841 ch = READCHAR;
843 i = 0;
844 while (ch != ':' && ch != '\n' && ch != EOF && in_file_vars)
846 if (i < sizeof var - 1)
847 var[i++] = ch;
848 UPDATE_BEG_END_STATE (ch);
849 ch = READCHAR;
852 /* Stop scanning if no colon was found before end marker. */
853 if (!in_file_vars || ch == '\n' || ch == EOF)
854 break;
856 while (i > 0 && (var[i - 1] == ' ' || var[i - 1] == '\t'))
857 i--;
858 var[i] = '\0';
860 if (ch == ':')
862 /* Read a variable value. */
863 ch = READCHAR;
865 while (ch == ' ' || ch == '\t')
866 ch = READCHAR;
868 i = 0;
869 while (ch != ';' && ch != '\n' && ch != EOF && in_file_vars)
871 if (i < sizeof val - 1)
872 val[i++] = ch;
873 UPDATE_BEG_END_STATE (ch);
874 ch = READCHAR;
876 if (! in_file_vars)
877 /* The value was terminated by an end-marker, which remove. */
878 i -= 3;
879 while (i > 0 && (val[i - 1] == ' ' || val[i - 1] == '\t'))
880 i--;
881 val[i] = '\0';
883 if (strcmp (var, "lexical-binding") == 0)
884 /* This is it... */
886 rv = (strcmp (val, "nil") != 0);
887 break;
892 while (ch != '\n' && ch != EOF)
893 ch = READCHAR;
895 return rv;
899 /* Value is a version number of byte compiled code if the file
900 associated with file descriptor FD is a compiled Lisp file that's
901 safe to load. Only files compiled with Emacs are safe to load.
902 Files compiled with XEmacs can lead to a crash in Fbyte_code
903 because of an incompatible change in the byte compiler. */
905 static int
906 safe_to_load_version (int fd)
908 char buf[512];
909 int nbytes, i;
910 int version = 1;
912 /* Read the first few bytes from the file, and look for a line
913 specifying the byte compiler version used. */
914 nbytes = emacs_read (fd, buf, sizeof buf);
915 if (nbytes > 0)
917 /* Skip to the next newline, skipping over the initial `ELC'
918 with NUL bytes following it, but note the version. */
919 for (i = 0; i < nbytes && buf[i] != '\n'; ++i)
920 if (i == 4)
921 version = buf[i];
923 if (i >= nbytes
924 || fast_c_string_match_ignore_case (Vbytecomp_version_regexp,
925 buf + i, nbytes - i) < 0)
926 version = 0;
929 lseek (fd, 0, SEEK_SET);
930 return version;
934 /* Callback for record_unwind_protect. Restore the old load list OLD,
935 after loading a file successfully. */
937 static void
938 record_load_unwind (Lisp_Object old)
940 Vloads_in_progress = old;
943 /* This handler function is used via internal_condition_case_1. */
945 static Lisp_Object
946 load_error_handler (Lisp_Object data)
948 return Qnil;
951 static void
952 load_warn_old_style_backquotes (Lisp_Object file)
954 if (!NILP (Vold_style_backquotes))
956 AUTO_STRING (format, "Loading `%s': old-style backquotes detected!");
957 CALLN (Fmessage, format, file);
961 DEFUN ("get-load-suffixes", Fget_load_suffixes, Sget_load_suffixes, 0, 0, 0,
962 doc: /* Return the suffixes that `load' should try if a suffix is \
963 required.
964 This uses the variables `load-suffixes' and `load-file-rep-suffixes'. */)
965 (void)
967 Lisp_Object lst = Qnil, suffixes = Vload_suffixes, suffix, ext;
968 while (CONSP (suffixes))
970 Lisp_Object exts = Vload_file_rep_suffixes;
971 suffix = XCAR (suffixes);
972 suffixes = XCDR (suffixes);
973 while (CONSP (exts))
975 ext = XCAR (exts);
976 exts = XCDR (exts);
977 lst = Fcons (concat2 (suffix, ext), lst);
980 return Fnreverse (lst);
983 /* Returns true if STRING ends with SUFFIX */
984 static bool
985 suffix_p (Lisp_Object string, const char *suffix)
987 ptrdiff_t suffix_len = strlen (suffix);
988 ptrdiff_t string_len = SBYTES (string);
990 return string_len >= suffix_len && !strcmp (SSDATA (string) + string_len - suffix_len, suffix);
993 DEFUN ("load", Fload, Sload, 1, 5, 0,
994 doc: /* Execute a file of Lisp code named FILE.
995 First try FILE with `.elc' appended, then try with `.el', then try
996 with a system-dependent suffix of dynamic modules (see `load-suffixes'),
997 then try FILE unmodified (the exact suffixes in the exact order are
998 determined by `load-suffixes'). Environment variable references in
999 FILE are replaced with their values by calling `substitute-in-file-name'.
1000 This function searches the directories in `load-path'.
1002 If optional second arg NOERROR is non-nil,
1003 report no error if FILE doesn't exist.
1004 Print messages at start and end of loading unless
1005 optional third arg NOMESSAGE is non-nil (but `force-load-messages'
1006 overrides that).
1007 If optional fourth arg NOSUFFIX is non-nil, don't try adding
1008 suffixes to the specified name FILE.
1009 If optional fifth arg MUST-SUFFIX is non-nil, insist on
1010 the suffix `.elc' or `.el' or the module suffix; don't accept just
1011 FILE unless it ends in one of those suffixes or includes a directory name.
1013 If NOSUFFIX is nil, then if a file could not be found, try looking for
1014 a different representation of the file by adding non-empty suffixes to
1015 its name, before trying another file. Emacs uses this feature to find
1016 compressed versions of files when Auto Compression mode is enabled.
1017 If NOSUFFIX is non-nil, disable this feature.
1019 The suffixes that this function tries out, when NOSUFFIX is nil, are
1020 given by the return value of `get-load-suffixes' and the values listed
1021 in `load-file-rep-suffixes'. If MUST-SUFFIX is non-nil, only the
1022 return value of `get-load-suffixes' is used, i.e. the file name is
1023 required to have a non-empty suffix.
1025 When searching suffixes, this function normally stops at the first
1026 one that exists. If the option `load-prefer-newer' is non-nil,
1027 however, it tries all suffixes, and uses whichever file is the newest.
1029 Loading a file records its definitions, and its `provide' and
1030 `require' calls, in an element of `load-history' whose
1031 car is the file name loaded. See `load-history'.
1033 While the file is in the process of being loaded, the variable
1034 `load-in-progress' is non-nil and the variable `load-file-name'
1035 is bound to the file's name.
1037 Return t if the file exists and loads successfully. */)
1038 (Lisp_Object file, Lisp_Object noerror, Lisp_Object nomessage,
1039 Lisp_Object nosuffix, Lisp_Object must_suffix)
1041 FILE *stream;
1042 int fd;
1043 int fd_index;
1044 ptrdiff_t count = SPECPDL_INDEX ();
1045 Lisp_Object found, efound, hist_file_name;
1046 /* True means we printed the ".el is newer" message. */
1047 bool newer = 0;
1048 /* True means we are loading a compiled file. */
1049 bool compiled = 0;
1050 Lisp_Object handler;
1051 bool safe_p = 1;
1052 const char *fmode = "r" FOPEN_TEXT;
1053 int version;
1055 CHECK_STRING (file);
1057 /* If file name is magic, call the handler. */
1058 /* This shouldn't be necessary any more now that `openp' handles it right.
1059 handler = Ffind_file_name_handler (file, Qload);
1060 if (!NILP (handler))
1061 return call5 (handler, Qload, file, noerror, nomessage, nosuffix); */
1063 /* The presence of this call is the result of a historical accident:
1064 it used to be in every file-operation and when it got removed
1065 everywhere, it accidentally stayed here. Since then, enough people
1066 supposedly have things like (load "$PROJECT/foo.el") in their .emacs
1067 that it seemed risky to remove. */
1068 if (! NILP (noerror))
1070 file = internal_condition_case_1 (Fsubstitute_in_file_name, file,
1071 Qt, load_error_handler);
1072 if (NILP (file))
1073 return Qnil;
1075 else
1076 file = Fsubstitute_in_file_name (file);
1078 /* Avoid weird lossage with null string as arg,
1079 since it would try to load a directory as a Lisp file. */
1080 if (SCHARS (file) == 0)
1082 fd = -1;
1083 errno = ENOENT;
1085 else
1087 Lisp_Object suffixes;
1088 found = Qnil;
1090 if (! NILP (must_suffix))
1092 /* Don't insist on adding a suffix if FILE already ends with one. */
1093 if (suffix_p (file, ".el")
1094 || suffix_p (file, ".elc")
1095 #ifdef HAVE_MODULES
1096 || suffix_p (file, MODULES_SUFFIX)
1097 #endif
1099 must_suffix = Qnil;
1100 /* Don't insist on adding a suffix
1101 if the argument includes a directory name. */
1102 else if (! NILP (Ffile_name_directory (file)))
1103 must_suffix = Qnil;
1106 if (!NILP (nosuffix))
1107 suffixes = Qnil;
1108 else
1110 suffixes = Fget_load_suffixes ();
1111 if (NILP (must_suffix))
1112 suffixes = CALLN (Fappend, suffixes, Vload_file_rep_suffixes);
1115 fd = openp (Vload_path, file, suffixes, &found, Qnil, load_prefer_newer);
1118 if (fd == -1)
1120 if (NILP (noerror))
1121 report_file_error ("Cannot open load file", file);
1122 return Qnil;
1125 /* Tell startup.el whether or not we found the user's init file. */
1126 if (EQ (Qt, Vuser_init_file))
1127 Vuser_init_file = found;
1129 /* If FD is -2, that means openp found a magic file. */
1130 if (fd == -2)
1132 if (NILP (Fequal (found, file)))
1133 /* If FOUND is a different file name from FILE,
1134 find its handler even if we have already inhibited
1135 the `load' operation on FILE. */
1136 handler = Ffind_file_name_handler (found, Qt);
1137 else
1138 handler = Ffind_file_name_handler (found, Qload);
1139 if (! NILP (handler))
1140 return call5 (handler, Qload, found, noerror, nomessage, Qt);
1141 #ifdef DOS_NT
1142 /* Tramp has to deal with semi-broken packages that prepend
1143 drive letters to remote files. For that reason, Tramp
1144 catches file operations that test for file existence, which
1145 makes openp think X:/foo.elc files are remote. However,
1146 Tramp does not catch `load' operations for such files, so we
1147 end up with a nil as the `load' handler above. If we would
1148 continue with fd = -2, we will behave wrongly, and in
1149 particular try reading a .elc file in the "rt" mode instead
1150 of "rb". See bug #9311 for the results. To work around
1151 this, we try to open the file locally, and go with that if it
1152 succeeds. */
1153 fd = emacs_open (SSDATA (ENCODE_FILE (found)), O_RDONLY, 0);
1154 if (fd == -1)
1155 fd = -2;
1156 #endif
1159 if (fd < 0)
1161 /* Pacify older GCC with --enable-gcc-warnings. */
1162 IF_LINT (fd_index = 0);
1164 else
1166 fd_index = SPECPDL_INDEX ();
1167 record_unwind_protect_int (close_file_unwind, fd);
1170 #ifdef HAVE_MODULES
1171 if (suffix_p (found, MODULES_SUFFIX))
1172 return unbind_to (count, Fmodule_load (found));
1173 #endif
1175 /* Check if we're stuck in a recursive load cycle.
1177 2000-09-21: It's not possible to just check for the file loaded
1178 being a member of Vloads_in_progress. This fails because of the
1179 way the byte compiler currently works; `provide's are not
1180 evaluated, see font-lock.el/jit-lock.el as an example. This
1181 leads to a certain amount of ``normal'' recursion.
1183 Also, just loading a file recursively is not always an error in
1184 the general case; the second load may do something different. */
1186 int load_count = 0;
1187 Lisp_Object tem;
1188 for (tem = Vloads_in_progress; CONSP (tem); tem = XCDR (tem))
1189 if (!NILP (Fequal (found, XCAR (tem))) && (++load_count > 3))
1190 signal_error ("Recursive load", Fcons (found, Vloads_in_progress));
1191 record_unwind_protect (record_load_unwind, Vloads_in_progress);
1192 Vloads_in_progress = Fcons (found, Vloads_in_progress);
1195 /* All loads are by default dynamic, unless the file itself specifies
1196 otherwise using a file-variable in the first line. This is bound here
1197 so that it takes effect whether or not we use
1198 Vload_source_file_function. */
1199 specbind (Qlexical_binding, Qnil);
1201 /* Get the name for load-history. */
1202 hist_file_name = (! NILP (Vpurify_flag)
1203 ? concat2 (Ffile_name_directory (file),
1204 Ffile_name_nondirectory (found))
1205 : found) ;
1207 version = -1;
1209 /* Check for the presence of old-style quotes and warn about them. */
1210 specbind (Qold_style_backquotes, Qnil);
1211 record_unwind_protect (load_warn_old_style_backquotes, file);
1213 if (suffix_p (found, ".elc") || (fd >= 0 && (version = safe_to_load_version (fd)) > 0))
1214 /* Load .elc files directly, but not when they are
1215 remote and have no handler! */
1217 if (fd != -2)
1219 struct stat s1, s2;
1220 int result;
1222 if (version < 0
1223 && ! (version = safe_to_load_version (fd)))
1225 safe_p = 0;
1226 if (!load_dangerous_libraries)
1227 error ("File `%s' was not compiled in Emacs", SDATA (found));
1228 else if (!NILP (nomessage) && !force_load_messages)
1229 message_with_string ("File `%s' not compiled in Emacs", found, 1);
1232 compiled = 1;
1234 efound = ENCODE_FILE (found);
1235 fmode = "r" FOPEN_BINARY;
1237 /* openp already checked for newness, no point doing it again.
1238 FIXME would be nice to get a message when openp
1239 ignores suffix order due to load_prefer_newer. */
1240 if (!load_prefer_newer)
1242 result = stat (SSDATA (efound), &s1);
1243 if (result == 0)
1245 SSET (efound, SBYTES (efound) - 1, 0);
1246 result = stat (SSDATA (efound), &s2);
1247 SSET (efound, SBYTES (efound) - 1, 'c');
1250 if (result == 0
1251 && timespec_cmp (get_stat_mtime (&s1), get_stat_mtime (&s2)) < 0)
1253 /* Make the progress messages mention that source is newer. */
1254 newer = 1;
1256 /* If we won't print another message, mention this anyway. */
1257 if (!NILP (nomessage) && !force_load_messages)
1259 Lisp_Object msg_file;
1260 msg_file = Fsubstring (found, make_number (0), make_number (-1));
1261 message_with_string ("Source file `%s' newer than byte-compiled file",
1262 msg_file, 1);
1265 } /* !load_prefer_newer */
1268 else
1270 /* We are loading a source file (*.el). */
1271 if (!NILP (Vload_source_file_function))
1273 Lisp_Object val;
1275 if (fd >= 0)
1277 emacs_close (fd);
1278 clear_unwind_protect (fd_index);
1280 val = call4 (Vload_source_file_function, found, hist_file_name,
1281 NILP (noerror) ? Qnil : Qt,
1282 (NILP (nomessage) || force_load_messages) ? Qnil : Qt);
1283 return unbind_to (count, val);
1287 if (fd < 0)
1289 /* We somehow got here with fd == -2, meaning the file is deemed
1290 to be remote. Don't even try to reopen the file locally;
1291 just force a failure. */
1292 stream = NULL;
1293 errno = EINVAL;
1295 else
1297 #ifdef WINDOWSNT
1298 emacs_close (fd);
1299 clear_unwind_protect (fd_index);
1300 efound = ENCODE_FILE (found);
1301 stream = emacs_fopen (SSDATA (efound), fmode);
1302 #else
1303 stream = fdopen (fd, fmode);
1304 #endif
1306 if (! stream)
1307 report_file_error ("Opening stdio stream", file);
1308 set_unwind_protect_ptr (fd_index, fclose_unwind, stream);
1310 if (! NILP (Vpurify_flag))
1311 Vpreloaded_file_list = Fcons (Fpurecopy (file), Vpreloaded_file_list);
1313 if (NILP (nomessage) || force_load_messages)
1315 if (!safe_p)
1316 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
1317 file, 1);
1318 else if (!compiled)
1319 message_with_string ("Loading %s (source)...", file, 1);
1320 else if (newer)
1321 message_with_string ("Loading %s (compiled; note, source file is newer)...",
1322 file, 1);
1323 else /* The typical case; compiled file newer than source file. */
1324 message_with_string ("Loading %s...", file, 1);
1327 specbind (Qload_file_name, found);
1328 specbind (Qinhibit_file_name_operation, Qnil);
1329 specbind (Qload_in_progress, Qt);
1331 instream = stream;
1332 if (lisp_file_lexically_bound_p (Qget_file_char))
1333 Fset (Qlexical_binding, Qt);
1335 if (! version || version >= 22)
1336 readevalloop (Qget_file_char, stream, hist_file_name,
1337 0, Qnil, Qnil, Qnil, Qnil);
1338 else
1340 /* We can't handle a file which was compiled with
1341 byte-compile-dynamic by older version of Emacs. */
1342 specbind (Qload_force_doc_strings, Qt);
1343 readevalloop (Qget_emacs_mule_file_char, stream, hist_file_name,
1344 0, Qnil, Qnil, Qnil, Qnil);
1346 unbind_to (count, Qnil);
1348 /* Run any eval-after-load forms for this file. */
1349 if (!NILP (Ffboundp (Qdo_after_load_evaluation)))
1350 call1 (Qdo_after_load_evaluation, hist_file_name) ;
1352 xfree (saved_doc_string);
1353 saved_doc_string = 0;
1354 saved_doc_string_size = 0;
1356 xfree (prev_saved_doc_string);
1357 prev_saved_doc_string = 0;
1358 prev_saved_doc_string_size = 0;
1360 if (!noninteractive && (NILP (nomessage) || force_load_messages))
1362 if (!safe_p)
1363 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
1364 file, 1);
1365 else if (!compiled)
1366 message_with_string ("Loading %s (source)...done", file, 1);
1367 else if (newer)
1368 message_with_string ("Loading %s (compiled; note, source file is newer)...done",
1369 file, 1);
1370 else /* The typical case; compiled file newer than source file. */
1371 message_with_string ("Loading %s...done", file, 1);
1374 return Qt;
1377 static bool
1378 complete_filename_p (Lisp_Object pathname)
1380 const unsigned char *s = SDATA (pathname);
1381 return (IS_DIRECTORY_SEP (s[0])
1382 || (SCHARS (pathname) > 2
1383 && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2])));
1386 DEFUN ("locate-file-internal", Flocate_file_internal, Slocate_file_internal, 2, 4, 0,
1387 doc: /* Search for FILENAME through PATH.
1388 Returns the file's name in absolute form, or nil if not found.
1389 If SUFFIXES is non-nil, it should be a list of suffixes to append to
1390 file name when searching.
1391 If non-nil, PREDICATE is used instead of `file-readable-p'.
1392 PREDICATE can also be an integer to pass to the faccessat(2) function,
1393 in which case file-name-handlers are ignored.
1394 This function will normally skip directories, so if you want it to find
1395 directories, make sure the PREDICATE function returns `dir-ok' for them. */)
1396 (Lisp_Object filename, Lisp_Object path, Lisp_Object suffixes, Lisp_Object predicate)
1398 Lisp_Object file;
1399 int fd = openp (path, filename, suffixes, &file, predicate, false);
1400 if (NILP (predicate) && fd >= 0)
1401 emacs_close (fd);
1402 return file;
1405 /* Search for a file whose name is STR, looking in directories
1406 in the Lisp list PATH, and trying suffixes from SUFFIX.
1407 On success, return a file descriptor (or 1 or -2 as described below).
1408 On failure, return -1 and set errno.
1410 SUFFIXES is a list of strings containing possible suffixes.
1411 The empty suffix is automatically added if the list is empty.
1413 PREDICATE t means the files are binary.
1414 PREDICATE non-nil and non-t means don't open the files,
1415 just look for one that satisfies the predicate. In this case,
1416 return 1 on success. The predicate can be a lisp function or
1417 an integer to pass to `access' (in which case file-name-handlers
1418 are ignored).
1420 If STOREPTR is nonzero, it points to a slot where the name of
1421 the file actually found should be stored as a Lisp string.
1422 nil is stored there on failure.
1424 If the file we find is remote, return -2
1425 but store the found remote file name in *STOREPTR.
1427 If NEWER is true, try all SUFFIXes and return the result for the
1428 newest file that exists. Does not apply to remote files,
1429 or if a non-nil and non-t PREDICATE is specified. */
1432 openp (Lisp_Object path, Lisp_Object str, Lisp_Object suffixes,
1433 Lisp_Object *storeptr, Lisp_Object predicate, bool newer)
1435 ptrdiff_t fn_size = 100;
1436 char buf[100];
1437 char *fn = buf;
1438 bool absolute;
1439 ptrdiff_t want_length;
1440 Lisp_Object filename;
1441 Lisp_Object string, tail, encoded_fn, save_string;
1442 ptrdiff_t max_suffix_len = 0;
1443 int last_errno = ENOENT;
1444 int save_fd = -1;
1445 USE_SAFE_ALLOCA;
1447 /* The last-modified time of the newest matching file found.
1448 Initialize it to something less than all valid timestamps. */
1449 struct timespec save_mtime = make_timespec (TYPE_MINIMUM (time_t), -1);
1451 CHECK_STRING (str);
1453 for (tail = suffixes; CONSP (tail); tail = XCDR (tail))
1455 CHECK_STRING_CAR (tail);
1456 max_suffix_len = max (max_suffix_len,
1457 SBYTES (XCAR (tail)));
1460 string = filename = encoded_fn = save_string = Qnil;
1462 if (storeptr)
1463 *storeptr = Qnil;
1465 absolute = complete_filename_p (str);
1467 for (; CONSP (path); path = XCDR (path))
1469 filename = Fexpand_file_name (str, XCAR (path));
1470 if (!complete_filename_p (filename))
1471 /* If there are non-absolute elts in PATH (eg "."). */
1472 /* Of course, this could conceivably lose if luser sets
1473 default-directory to be something non-absolute... */
1475 filename = Fexpand_file_name (filename, BVAR (current_buffer, directory));
1476 if (!complete_filename_p (filename))
1477 /* Give up on this path element! */
1478 continue;
1481 /* Calculate maximum length of any filename made from
1482 this path element/specified file name and any possible suffix. */
1483 want_length = max_suffix_len + SBYTES (filename);
1484 if (fn_size <= want_length)
1486 fn_size = 100 + want_length;
1487 fn = SAFE_ALLOCA (fn_size);
1490 /* Loop over suffixes. */
1491 for (tail = NILP (suffixes) ? list1 (empty_unibyte_string) : suffixes;
1492 CONSP (tail); tail = XCDR (tail))
1494 Lisp_Object suffix = XCAR (tail);
1495 ptrdiff_t fnlen, lsuffix = SBYTES (suffix);
1496 Lisp_Object handler;
1498 /* Concatenate path element/specified name with the suffix.
1499 If the directory starts with /:, remove that. */
1500 int prefixlen = ((SCHARS (filename) > 2
1501 && SREF (filename, 0) == '/'
1502 && SREF (filename, 1) == ':')
1503 ? 2 : 0);
1504 fnlen = SBYTES (filename) - prefixlen;
1505 memcpy (fn, SDATA (filename) + prefixlen, fnlen);
1506 memcpy (fn + fnlen, SDATA (suffix), lsuffix + 1);
1507 fnlen += lsuffix;
1508 /* Check that the file exists and is not a directory. */
1509 /* We used to only check for handlers on non-absolute file names:
1510 if (absolute)
1511 handler = Qnil;
1512 else
1513 handler = Ffind_file_name_handler (filename, Qfile_exists_p);
1514 It's not clear why that was the case and it breaks things like
1515 (load "/bar.el") where the file is actually "/bar.el.gz". */
1516 /* make_string has its own ideas on when to return a unibyte
1517 string and when a multibyte string, but we know better.
1518 We must have a unibyte string when dumping, since
1519 file-name encoding is shaky at best at that time, and in
1520 particular default-file-name-coding-system is reset
1521 several times during loadup. We therefore don't want to
1522 encode the file before passing it to file I/O library
1523 functions. */
1524 if (!STRING_MULTIBYTE (filename) && !STRING_MULTIBYTE (suffix))
1525 string = make_unibyte_string (fn, fnlen);
1526 else
1527 string = make_string (fn, fnlen);
1528 handler = Ffind_file_name_handler (string, Qfile_exists_p);
1529 if ((!NILP (handler) || (!NILP (predicate) && !EQ (predicate, Qt)))
1530 && !NATNUMP (predicate))
1532 bool exists;
1533 if (NILP (predicate) || EQ (predicate, Qt))
1534 exists = !NILP (Ffile_readable_p (string));
1535 else
1537 Lisp_Object tmp = call1 (predicate, string);
1538 if (NILP (tmp))
1539 exists = false;
1540 else if (EQ (tmp, Qdir_ok)
1541 || NILP (Ffile_directory_p (string)))
1542 exists = true;
1543 else
1545 exists = false;
1546 last_errno = EISDIR;
1550 if (exists)
1552 /* We succeeded; return this descriptor and filename. */
1553 if (storeptr)
1554 *storeptr = string;
1555 SAFE_FREE ();
1556 return -2;
1559 else
1561 int fd;
1562 const char *pfn;
1563 struct stat st;
1565 encoded_fn = ENCODE_FILE (string);
1566 pfn = SSDATA (encoded_fn);
1568 /* Check that we can access or open it. */
1569 if (NATNUMP (predicate))
1571 fd = -1;
1572 if (INT_MAX < XFASTINT (predicate))
1573 last_errno = EINVAL;
1574 else if (faccessat (AT_FDCWD, pfn, XFASTINT (predicate),
1575 AT_EACCESS)
1576 == 0)
1578 if (file_directory_p (pfn))
1579 last_errno = EISDIR;
1580 else
1581 fd = 1;
1584 else
1586 fd = emacs_open (pfn, O_RDONLY, 0);
1587 if (fd < 0)
1589 if (errno != ENOENT)
1590 last_errno = errno;
1592 else
1594 int err = (fstat (fd, &st) != 0 ? errno
1595 : S_ISDIR (st.st_mode) ? EISDIR : 0);
1596 if (err)
1598 last_errno = err;
1599 emacs_close (fd);
1600 fd = -1;
1605 if (fd >= 0)
1607 if (newer && !NATNUMP (predicate))
1609 struct timespec mtime = get_stat_mtime (&st);
1611 if (timespec_cmp (mtime, save_mtime) <= 0)
1612 emacs_close (fd);
1613 else
1615 if (0 <= save_fd)
1616 emacs_close (save_fd);
1617 save_fd = fd;
1618 save_mtime = mtime;
1619 save_string = string;
1622 else
1624 /* We succeeded; return this descriptor and filename. */
1625 if (storeptr)
1626 *storeptr = string;
1627 SAFE_FREE ();
1628 return fd;
1632 /* No more suffixes. Return the newest. */
1633 if (0 <= save_fd && ! CONSP (XCDR (tail)))
1635 if (storeptr)
1636 *storeptr = save_string;
1637 SAFE_FREE ();
1638 return save_fd;
1642 if (absolute)
1643 break;
1646 SAFE_FREE ();
1647 errno = last_errno;
1648 return -1;
1652 /* Merge the list we've accumulated of globals from the current input source
1653 into the load_history variable. The details depend on whether
1654 the source has an associated file name or not.
1656 FILENAME is the file name that we are loading from.
1658 ENTIRE is true if loading that entire file, false if evaluating
1659 part of it. */
1661 static void
1662 build_load_history (Lisp_Object filename, bool entire)
1664 Lisp_Object tail, prev, newelt;
1665 Lisp_Object tem, tem2;
1666 bool foundit = 0;
1668 tail = Vload_history;
1669 prev = Qnil;
1671 while (CONSP (tail))
1673 tem = XCAR (tail);
1675 /* Find the feature's previous assoc list... */
1676 if (!NILP (Fequal (filename, Fcar (tem))))
1678 foundit = 1;
1680 /* If we're loading the entire file, remove old data. */
1681 if (entire)
1683 if (NILP (prev))
1684 Vload_history = XCDR (tail);
1685 else
1686 Fsetcdr (prev, XCDR (tail));
1689 /* Otherwise, cons on new symbols that are not already members. */
1690 else
1692 tem2 = Vcurrent_load_list;
1694 while (CONSP (tem2))
1696 newelt = XCAR (tem2);
1698 if (NILP (Fmember (newelt, tem)))
1699 Fsetcar (tail, Fcons (XCAR (tem),
1700 Fcons (newelt, XCDR (tem))));
1702 tem2 = XCDR (tem2);
1703 QUIT;
1707 else
1708 prev = tail;
1709 tail = XCDR (tail);
1710 QUIT;
1713 /* If we're loading an entire file, cons the new assoc onto the
1714 front of load-history, the most-recently-loaded position. Also
1715 do this if we didn't find an existing member for the file. */
1716 if (entire || !foundit)
1717 Vload_history = Fcons (Fnreverse (Vcurrent_load_list),
1718 Vload_history);
1721 static void
1722 readevalloop_1 (int old)
1724 load_convert_to_unibyte = old;
1727 /* Signal an `end-of-file' error, if possible with file name
1728 information. */
1730 static _Noreturn void
1731 end_of_file_error (void)
1733 if (STRINGP (Vload_file_name))
1734 xsignal1 (Qend_of_file, Vload_file_name);
1736 xsignal0 (Qend_of_file);
1739 static Lisp_Object
1740 readevalloop_eager_expand_eval (Lisp_Object val, Lisp_Object macroexpand)
1742 /* If we macroexpand the toplevel form non-recursively and it ends
1743 up being a `progn' (or if it was a progn to start), treat each
1744 form in the progn as a top-level form. This way, if one form in
1745 the progn defines a macro, that macro is in effect when we expand
1746 the remaining forms. See similar code in bytecomp.el. */
1747 val = call2 (macroexpand, val, Qnil);
1748 if (EQ (CAR_SAFE (val), Qprogn))
1750 Lisp_Object subforms = XCDR (val);
1752 for (val = Qnil; CONSP (subforms); subforms = XCDR (subforms))
1753 val = readevalloop_eager_expand_eval (XCAR (subforms),
1754 macroexpand);
1756 else
1757 val = eval_sub (call2 (macroexpand, val, Qt));
1758 return val;
1761 /* UNIBYTE specifies how to set load_convert_to_unibyte
1762 for this invocation.
1763 READFUN, if non-nil, is used instead of `read'.
1765 START, END specify region to read in current buffer (from eval-region).
1766 If the input is not from a buffer, they must be nil. */
1768 static void
1769 readevalloop (Lisp_Object readcharfun,
1770 FILE *stream,
1771 Lisp_Object sourcename,
1772 bool printflag,
1773 Lisp_Object unibyte, Lisp_Object readfun,
1774 Lisp_Object start, Lisp_Object end)
1776 int c;
1777 Lisp_Object val;
1778 ptrdiff_t count = SPECPDL_INDEX ();
1779 struct buffer *b = 0;
1780 bool continue_reading_p;
1781 Lisp_Object lex_bound;
1782 /* True if reading an entire buffer. */
1783 bool whole_buffer = 0;
1784 /* True on the first time around. */
1785 bool first_sexp = 1;
1786 Lisp_Object macroexpand = intern ("internal-macroexpand-for-load");
1788 if (NILP (Ffboundp (macroexpand))
1789 /* Don't macroexpand in .elc files, since it should have been done
1790 already. We actually don't know whether we're in a .elc file or not,
1791 so we use circumstantial evidence: .el files normally go through
1792 Vload_source_file_function -> load-with-code-conversion
1793 -> eval-buffer. */
1794 || EQ (readcharfun, Qget_file_char)
1795 || EQ (readcharfun, Qget_emacs_mule_file_char))
1796 macroexpand = Qnil;
1798 if (MARKERP (readcharfun))
1800 if (NILP (start))
1801 start = readcharfun;
1804 if (BUFFERP (readcharfun))
1805 b = XBUFFER (readcharfun);
1806 else if (MARKERP (readcharfun))
1807 b = XMARKER (readcharfun)->buffer;
1809 /* We assume START is nil when input is not from a buffer. */
1810 if (! NILP (start) && !b)
1811 emacs_abort ();
1813 specbind (Qstandard_input, readcharfun);
1814 specbind (Qcurrent_load_list, Qnil);
1815 record_unwind_protect_int (readevalloop_1, load_convert_to_unibyte);
1816 load_convert_to_unibyte = !NILP (unibyte);
1818 /* If lexical binding is active (either because it was specified in
1819 the file's header, or via a buffer-local variable), create an empty
1820 lexical environment, otherwise, turn off lexical binding. */
1821 lex_bound = find_symbol_value (Qlexical_binding);
1822 specbind (Qinternal_interpreter_environment,
1823 (NILP (lex_bound) || EQ (lex_bound, Qunbound)
1824 ? Qnil : list1 (Qt)));
1826 /* Try to ensure sourcename is a truename, except whilst preloading. */
1827 if (NILP (Vpurify_flag)
1828 && !NILP (sourcename) && !NILP (Ffile_name_absolute_p (sourcename))
1829 && !NILP (Ffboundp (Qfile_truename)))
1830 sourcename = call1 (Qfile_truename, sourcename) ;
1832 LOADHIST_ATTACH (sourcename);
1834 continue_reading_p = 1;
1835 while (continue_reading_p)
1837 ptrdiff_t count1 = SPECPDL_INDEX ();
1839 if (b != 0 && !BUFFER_LIVE_P (b))
1840 error ("Reading from killed buffer");
1842 if (!NILP (start))
1844 /* Switch to the buffer we are reading from. */
1845 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1846 set_buffer_internal (b);
1848 /* Save point in it. */
1849 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1850 /* Save ZV in it. */
1851 record_unwind_protect (save_restriction_restore, save_restriction_save ());
1852 /* Those get unbound after we read one expression. */
1854 /* Set point and ZV around stuff to be read. */
1855 Fgoto_char (start);
1856 if (!NILP (end))
1857 Fnarrow_to_region (make_number (BEGV), end);
1859 /* Just for cleanliness, convert END to a marker
1860 if it is an integer. */
1861 if (INTEGERP (end))
1862 end = Fpoint_max_marker ();
1865 /* On the first cycle, we can easily test here
1866 whether we are reading the whole buffer. */
1867 if (b && first_sexp)
1868 whole_buffer = (PT == BEG && ZV == Z);
1870 instream = stream;
1871 read_next:
1872 c = READCHAR;
1873 if (c == ';')
1875 while ((c = READCHAR) != '\n' && c != -1);
1876 goto read_next;
1878 if (c < 0)
1880 unbind_to (count1, Qnil);
1881 break;
1884 /* Ignore whitespace here, so we can detect eof. */
1885 if (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r'
1886 || c == NO_BREAK_SPACE)
1887 goto read_next;
1889 if (!NILP (Vpurify_flag) && c == '(')
1891 val = read_list (0, readcharfun);
1893 else
1895 UNREAD (c);
1896 read_objects = Qnil;
1897 if (!NILP (readfun))
1899 val = call1 (readfun, readcharfun);
1901 /* If READCHARFUN has set point to ZV, we should
1902 stop reading, even if the form read sets point
1903 to a different value when evaluated. */
1904 if (BUFFERP (readcharfun))
1906 struct buffer *buf = XBUFFER (readcharfun);
1907 if (BUF_PT (buf) == BUF_ZV (buf))
1908 continue_reading_p = 0;
1911 else if (! NILP (Vload_read_function))
1912 val = call1 (Vload_read_function, readcharfun);
1913 else
1914 val = read_internal_start (readcharfun, Qnil, Qnil);
1917 if (!NILP (start) && continue_reading_p)
1918 start = Fpoint_marker ();
1920 /* Restore saved point and BEGV. */
1921 unbind_to (count1, Qnil);
1923 /* Now eval what we just read. */
1924 if (!NILP (macroexpand))
1925 val = readevalloop_eager_expand_eval (val, macroexpand);
1926 else
1927 val = eval_sub (val);
1929 if (printflag)
1931 Vvalues = Fcons (val, Vvalues);
1932 if (EQ (Vstandard_output, Qt))
1933 Fprin1 (val, Qnil);
1934 else
1935 Fprint (val, Qnil);
1938 first_sexp = 0;
1941 build_load_history (sourcename,
1942 stream || whole_buffer);
1944 unbind_to (count, Qnil);
1947 DEFUN ("eval-buffer", Feval_buffer, Seval_buffer, 0, 5, "",
1948 doc: /* Execute the accessible portion of current buffer as Lisp code.
1949 You can use \\[narrow-to-region] to limit the part of buffer to be evaluated.
1950 When called from a Lisp program (i.e., not interactively), this
1951 function accepts up to five optional arguments:
1952 BUFFER is the buffer to evaluate (nil means use current buffer),
1953 or a name of a buffer (a string).
1954 PRINTFLAG controls printing of output by any output functions in the
1955 evaluated code, such as `print', `princ', and `prin1':
1956 a value of nil means discard it; anything else is the stream to print to.
1957 See Info node `(elisp)Output Streams' for details on streams.
1958 FILENAME specifies the file name to use for `load-history'.
1959 UNIBYTE, if non-nil, specifies `load-convert-to-unibyte' for this
1960 invocation.
1961 DO-ALLOW-PRINT, if non-nil, specifies that output functions in the
1962 evaluated code should work normally even if PRINTFLAG is nil, in
1963 which case the output is displayed in the echo area.
1965 This function preserves the position of point. */)
1966 (Lisp_Object buffer, Lisp_Object printflag, Lisp_Object filename, Lisp_Object unibyte, Lisp_Object do_allow_print)
1968 ptrdiff_t count = SPECPDL_INDEX ();
1969 Lisp_Object tem, buf;
1971 if (NILP (buffer))
1972 buf = Fcurrent_buffer ();
1973 else
1974 buf = Fget_buffer (buffer);
1975 if (NILP (buf))
1976 error ("No such buffer");
1978 if (NILP (printflag) && NILP (do_allow_print))
1979 tem = Qsymbolp;
1980 else
1981 tem = printflag;
1983 if (NILP (filename))
1984 filename = BVAR (XBUFFER (buf), filename);
1986 specbind (Qeval_buffer_list, Fcons (buf, Veval_buffer_list));
1987 specbind (Qstandard_output, tem);
1988 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1989 BUF_TEMP_SET_PT (XBUFFER (buf), BUF_BEGV (XBUFFER (buf)));
1990 specbind (Qlexical_binding, lisp_file_lexically_bound_p (buf) ? Qt : Qnil);
1991 readevalloop (buf, 0, filename,
1992 !NILP (printflag), unibyte, Qnil, Qnil, Qnil);
1993 unbind_to (count, Qnil);
1995 return Qnil;
1998 DEFUN ("eval-region", Feval_region, Seval_region, 2, 4, "r",
1999 doc: /* Execute the region as Lisp code.
2000 When called from programs, expects two arguments,
2001 giving starting and ending indices in the current buffer
2002 of the text to be executed.
2003 Programs can pass third argument PRINTFLAG which controls output:
2004 a value of nil means discard it; anything else is stream for printing it.
2005 See Info node `(elisp)Output Streams' for details on streams.
2006 Also the fourth argument READ-FUNCTION, if non-nil, is used
2007 instead of `read' to read each expression. It gets one argument
2008 which is the input stream for reading characters.
2010 This function does not move point. */)
2011 (Lisp_Object start, Lisp_Object end, Lisp_Object printflag, Lisp_Object read_function)
2013 /* FIXME: Do the eval-sexp-add-defvars dance! */
2014 ptrdiff_t count = SPECPDL_INDEX ();
2015 Lisp_Object tem, cbuf;
2017 cbuf = Fcurrent_buffer ();
2019 if (NILP (printflag))
2020 tem = Qsymbolp;
2021 else
2022 tem = printflag;
2023 specbind (Qstandard_output, tem);
2024 specbind (Qeval_buffer_list, Fcons (cbuf, Veval_buffer_list));
2026 /* `readevalloop' calls functions which check the type of start and end. */
2027 readevalloop (cbuf, 0, BVAR (XBUFFER (cbuf), filename),
2028 !NILP (printflag), Qnil, read_function,
2029 start, end);
2031 return unbind_to (count, Qnil);
2035 DEFUN ("read", Fread, Sread, 0, 1, 0,
2036 doc: /* Read one Lisp expression as text from STREAM, return as Lisp object.
2037 If STREAM is nil, use the value of `standard-input' (which see).
2038 STREAM or the value of `standard-input' may be:
2039 a buffer (read from point and advance it)
2040 a marker (read from where it points and advance it)
2041 a function (call it with no arguments for each character,
2042 call it with a char as argument to push a char back)
2043 a string (takes text from string, starting at the beginning)
2044 t (read text line using minibuffer and use it, or read from
2045 standard input in batch mode). */)
2046 (Lisp_Object stream)
2048 if (NILP (stream))
2049 stream = Vstandard_input;
2050 if (EQ (stream, Qt))
2051 stream = Qread_char;
2052 if (EQ (stream, Qread_char))
2053 /* FIXME: ?! When is this used !? */
2054 return call1 (intern ("read-minibuffer"),
2055 build_string ("Lisp expression: "));
2057 return read_internal_start (stream, Qnil, Qnil);
2060 DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0,
2061 doc: /* Read one Lisp expression which is represented as text by STRING.
2062 Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
2063 FINAL-STRING-INDEX is an integer giving the position of the next
2064 remaining character in STRING. START and END optionally delimit
2065 a substring of STRING from which to read; they default to 0 and
2066 \(length STRING) respectively. Negative values are counted from
2067 the end of STRING. */)
2068 (Lisp_Object string, Lisp_Object start, Lisp_Object end)
2070 Lisp_Object ret;
2071 CHECK_STRING (string);
2072 /* `read_internal_start' sets `read_from_string_index'. */
2073 ret = read_internal_start (string, start, end);
2074 return Fcons (ret, make_number (read_from_string_index));
2077 /* Function to set up the global context we need in toplevel read
2078 calls. START and END only used when STREAM is a string. */
2079 static Lisp_Object
2080 read_internal_start (Lisp_Object stream, Lisp_Object start, Lisp_Object end)
2082 Lisp_Object retval;
2084 readchar_count = 0;
2085 new_backquote_flag = 0;
2086 read_objects = Qnil;
2087 if (EQ (Vread_with_symbol_positions, Qt)
2088 || EQ (Vread_with_symbol_positions, stream))
2089 Vread_symbol_positions_list = Qnil;
2091 if (STRINGP (stream)
2092 || ((CONSP (stream) && STRINGP (XCAR (stream)))))
2094 ptrdiff_t startval, endval;
2095 Lisp_Object string;
2097 if (STRINGP (stream))
2098 string = stream;
2099 else
2100 string = XCAR (stream);
2102 validate_subarray (string, start, end, SCHARS (string),
2103 &startval, &endval);
2105 read_from_string_index = startval;
2106 read_from_string_index_byte = string_char_to_byte (string, startval);
2107 read_from_string_limit = endval;
2110 retval = read0 (stream);
2111 if (EQ (Vread_with_symbol_positions, Qt)
2112 || EQ (Vread_with_symbol_positions, stream))
2113 Vread_symbol_positions_list = Fnreverse (Vread_symbol_positions_list);
2114 return retval;
2118 /* Signal Qinvalid_read_syntax error.
2119 S is error string of length N (if > 0) */
2121 static _Noreturn void
2122 invalid_syntax (const char *s)
2124 xsignal1 (Qinvalid_read_syntax, build_string (s));
2128 /* Use this for recursive reads, in contexts where internal tokens
2129 are not allowed. */
2131 static Lisp_Object
2132 read0 (Lisp_Object readcharfun)
2134 register Lisp_Object val;
2135 int c;
2137 val = read1 (readcharfun, &c, 0);
2138 if (!c)
2139 return val;
2141 xsignal1 (Qinvalid_read_syntax,
2142 Fmake_string (make_number (1), make_number (c)));
2145 static ptrdiff_t read_buffer_size;
2146 static char *read_buffer;
2148 /* Grow the read buffer by at least MAX_MULTIBYTE_LENGTH bytes. */
2150 static void
2151 grow_read_buffer (void)
2153 read_buffer = xpalloc (read_buffer, &read_buffer_size,
2154 MAX_MULTIBYTE_LENGTH, -1, 1);
2157 /* Return the scalar value that has the Unicode character name NAME.
2158 Raise 'invalid-read-syntax' if there is no such character. */
2159 static int
2160 character_name_to_code (char const *name, ptrdiff_t name_len)
2162 /* For "U+XXXX", pass the leading '+' to string_to_number to reject
2163 monstrosities like "U+-0000". */
2164 Lisp_Object code
2165 = (name[0] == 'U' && name[1] == '+'
2166 ? string_to_number (name + 1, 16, false)
2167 : call2 (Qchar_from_name, make_unibyte_string (name, name_len), Qt));
2169 if (! RANGED_INTEGERP (0, code, MAX_UNICODE_CHAR)
2170 || char_surrogate_p (XINT (code)))
2172 AUTO_STRING (format, "\\N{%s}");
2173 AUTO_STRING_WITH_LEN (namestr, name, name_len);
2174 xsignal1 (Qinvalid_read_syntax, CALLN (Fformat, format, namestr));
2177 return XINT (code);
2180 /* Bound on the length of a Unicode character name. As of
2181 Unicode 9.0.0 the maximum is 83, so this should be safe. */
2182 enum { UNICODE_CHARACTER_NAME_LENGTH_BOUND = 200 };
2184 /* Read a \-escape sequence, assuming we already read the `\'.
2185 If the escape sequence forces unibyte, return eight-bit char. */
2187 static int
2188 read_escape (Lisp_Object readcharfun, bool stringp)
2190 int c = READCHAR;
2191 /* \u allows up to four hex digits, \U up to eight. Default to the
2192 behavior for \u, and change this value in the case that \U is seen. */
2193 int unicode_hex_count = 4;
2195 switch (c)
2197 case -1:
2198 end_of_file_error ();
2200 case 'a':
2201 return '\007';
2202 case 'b':
2203 return '\b';
2204 case 'd':
2205 return 0177;
2206 case 'e':
2207 return 033;
2208 case 'f':
2209 return '\f';
2210 case 'n':
2211 return '\n';
2212 case 'r':
2213 return '\r';
2214 case 't':
2215 return '\t';
2216 case 'v':
2217 return '\v';
2218 case '\n':
2219 return -1;
2220 case ' ':
2221 if (stringp)
2222 return -1;
2223 return ' ';
2225 case 'M':
2226 c = READCHAR;
2227 if (c != '-')
2228 error ("Invalid escape character syntax");
2229 c = READCHAR;
2230 if (c == '\\')
2231 c = read_escape (readcharfun, 0);
2232 return c | meta_modifier;
2234 case 'S':
2235 c = READCHAR;
2236 if (c != '-')
2237 error ("Invalid escape character syntax");
2238 c = READCHAR;
2239 if (c == '\\')
2240 c = read_escape (readcharfun, 0);
2241 return c | shift_modifier;
2243 case 'H':
2244 c = READCHAR;
2245 if (c != '-')
2246 error ("Invalid escape character syntax");
2247 c = READCHAR;
2248 if (c == '\\')
2249 c = read_escape (readcharfun, 0);
2250 return c | hyper_modifier;
2252 case 'A':
2253 c = READCHAR;
2254 if (c != '-')
2255 error ("Invalid escape character syntax");
2256 c = READCHAR;
2257 if (c == '\\')
2258 c = read_escape (readcharfun, 0);
2259 return c | alt_modifier;
2261 case 's':
2262 c = READCHAR;
2263 if (stringp || c != '-')
2265 UNREAD (c);
2266 return ' ';
2268 c = READCHAR;
2269 if (c == '\\')
2270 c = read_escape (readcharfun, 0);
2271 return c | super_modifier;
2273 case 'C':
2274 c = READCHAR;
2275 if (c != '-')
2276 error ("Invalid escape character syntax");
2277 case '^':
2278 c = READCHAR;
2279 if (c == '\\')
2280 c = read_escape (readcharfun, 0);
2281 if ((c & ~CHAR_MODIFIER_MASK) == '?')
2282 return 0177 | (c & CHAR_MODIFIER_MASK);
2283 else if (! SINGLE_BYTE_CHAR_P ((c & ~CHAR_MODIFIER_MASK)))
2284 return c | ctrl_modifier;
2285 /* ASCII control chars are made from letters (both cases),
2286 as well as the non-letters within 0100...0137. */
2287 else if ((c & 0137) >= 0101 && (c & 0137) <= 0132)
2288 return (c & (037 | ~0177));
2289 else if ((c & 0177) >= 0100 && (c & 0177) <= 0137)
2290 return (c & (037 | ~0177));
2291 else
2292 return c | ctrl_modifier;
2294 case '0':
2295 case '1':
2296 case '2':
2297 case '3':
2298 case '4':
2299 case '5':
2300 case '6':
2301 case '7':
2302 /* An octal escape, as in ANSI C. */
2304 register int i = c - '0';
2305 register int count = 0;
2306 while (++count < 3)
2308 if ((c = READCHAR) >= '0' && c <= '7')
2310 i *= 8;
2311 i += c - '0';
2313 else
2315 UNREAD (c);
2316 break;
2320 if (i >= 0x80 && i < 0x100)
2321 i = BYTE8_TO_CHAR (i);
2322 return i;
2325 case 'x':
2326 /* A hex escape, as in ANSI C. */
2328 unsigned int i = 0;
2329 int count = 0;
2330 while (1)
2332 c = READCHAR;
2333 if (c >= '0' && c <= '9')
2335 i *= 16;
2336 i += c - '0';
2338 else if ((c >= 'a' && c <= 'f')
2339 || (c >= 'A' && c <= 'F'))
2341 i *= 16;
2342 if (c >= 'a' && c <= 'f')
2343 i += c - 'a' + 10;
2344 else
2345 i += c - 'A' + 10;
2347 else
2349 UNREAD (c);
2350 break;
2352 /* Allow hex escapes as large as ?\xfffffff, because some
2353 packages use them to denote characters with modifiers. */
2354 if ((CHAR_META | (CHAR_META - 1)) < i)
2355 error ("Hex character out of range: \\x%x...", i);
2356 count += count < 3;
2359 if (count < 3 && i >= 0x80)
2360 return BYTE8_TO_CHAR (i);
2361 return i;
2364 case 'U':
2365 /* Post-Unicode-2.0: Up to eight hex chars. */
2366 unicode_hex_count = 8;
2367 case 'u':
2369 /* A Unicode escape. We only permit them in strings and characters,
2370 not arbitrarily in the source code, as in some other languages. */
2372 unsigned int i = 0;
2373 int count = 0;
2375 while (++count <= unicode_hex_count)
2377 c = READCHAR;
2378 /* `isdigit' and `isalpha' may be locale-specific, which we don't
2379 want. */
2380 if (c >= '0' && c <= '9') i = (i << 4) + (c - '0');
2381 else if (c >= 'a' && c <= 'f') i = (i << 4) + (c - 'a') + 10;
2382 else if (c >= 'A' && c <= 'F') i = (i << 4) + (c - 'A') + 10;
2383 else
2384 error ("Non-hex digit used for Unicode escape");
2386 if (i > 0x10FFFF)
2387 error ("Non-Unicode character: 0x%x", i);
2388 return i;
2391 case 'N':
2392 /* Named character. */
2394 c = READCHAR;
2395 if (c != '{')
2396 invalid_syntax ("Expected opening brace after \\N");
2397 char name[UNICODE_CHARACTER_NAME_LENGTH_BOUND + 1];
2398 bool whitespace = false;
2399 ptrdiff_t length = 0;
2400 while (true)
2402 c = READCHAR;
2403 if (c < 0)
2404 end_of_file_error ();
2405 if (c == '}')
2406 break;
2407 if (! (0 < c && c < 0x80))
2409 AUTO_STRING (format,
2410 "Invalid character U+%04X in character name");
2411 xsignal1 (Qinvalid_read_syntax,
2412 CALLN (Fformat, format, make_natnum (c)));
2414 /* Treat multiple adjacent whitespace characters as a
2415 single space character. This makes it easier to use
2416 character names in e.g. multi-line strings. */
2417 if (c_isspace (c))
2419 if (whitespace)
2420 continue;
2421 c = ' ';
2422 whitespace = true;
2424 else
2425 whitespace = false;
2426 name[length++] = c;
2427 if (length >= sizeof name)
2428 invalid_syntax ("Character name too long");
2430 if (length == 0)
2431 invalid_syntax ("Empty character name");
2432 name[length] = '\0';
2433 return character_name_to_code (name, length);
2436 default:
2437 return c;
2441 /* Return the digit that CHARACTER stands for in the given BASE.
2442 Return -1 if CHARACTER is out of range for BASE,
2443 and -2 if CHARACTER is not valid for any supported BASE. */
2444 static int
2445 digit_to_number (int character, int base)
2447 int digit;
2449 if ('0' <= character && character <= '9')
2450 digit = character - '0';
2451 else if ('a' <= character && character <= 'z')
2452 digit = character - 'a' + 10;
2453 else if ('A' <= character && character <= 'Z')
2454 digit = character - 'A' + 10;
2455 else
2456 return -2;
2458 return digit < base ? digit : -1;
2461 /* Read an integer in radix RADIX using READCHARFUN to read
2462 characters. RADIX must be in the interval [2..36]; if it isn't, a
2463 read error is signaled . Value is the integer read. Signals an
2464 error if encountering invalid read syntax or if RADIX is out of
2465 range. */
2467 static Lisp_Object
2468 read_integer (Lisp_Object readcharfun, EMACS_INT radix)
2470 /* Room for sign, leading 0, other digits, trailing null byte.
2471 Also, room for invalid syntax diagnostic. */
2472 char buf[max (1 + 1 + sizeof (uintmax_t) * CHAR_BIT + 1,
2473 sizeof "integer, radix " + INT_STRLEN_BOUND (EMACS_INT))];
2475 int valid = -1; /* 1 if valid, 0 if not, -1 if incomplete. */
2477 if (radix < 2 || radix > 36)
2478 valid = 0;
2479 else
2481 char *p = buf;
2482 int c, digit;
2484 c = READCHAR;
2485 if (c == '-' || c == '+')
2487 *p++ = c;
2488 c = READCHAR;
2491 if (c == '0')
2493 *p++ = c;
2494 valid = 1;
2496 /* Ignore redundant leading zeros, so the buffer doesn't
2497 fill up with them. */
2499 c = READCHAR;
2500 while (c == '0');
2503 while ((digit = digit_to_number (c, radix)) >= -1)
2505 if (digit == -1)
2506 valid = 0;
2507 if (valid < 0)
2508 valid = 1;
2510 if (p < buf + sizeof buf - 1)
2511 *p++ = c;
2512 else
2513 valid = 0;
2515 c = READCHAR;
2518 UNREAD (c);
2519 *p = '\0';
2522 if (! valid)
2524 sprintf (buf, "integer, radix %"pI"d", radix);
2525 invalid_syntax (buf);
2528 return string_to_number (buf, radix, 0);
2532 /* If the next token is ')' or ']' or '.', we store that character
2533 in *PCH and the return value is not interesting. Else, we store
2534 zero in *PCH and we read and return one lisp object.
2536 FIRST_IN_LIST is true if this is the first element of a list. */
2538 static Lisp_Object
2539 read1 (Lisp_Object readcharfun, int *pch, bool first_in_list)
2541 int c;
2542 bool uninterned_symbol = 0;
2543 bool multibyte;
2545 *pch = 0;
2547 retry:
2549 c = READCHAR_REPORT_MULTIBYTE (&multibyte);
2550 if (c < 0)
2551 end_of_file_error ();
2553 switch (c)
2555 case '(':
2556 return read_list (0, readcharfun);
2558 case '[':
2559 return read_vector (readcharfun, 0);
2561 case ')':
2562 case ']':
2564 *pch = c;
2565 return Qnil;
2568 case '#':
2569 c = READCHAR;
2570 if (c == 's')
2572 c = READCHAR;
2573 if (c == '(')
2575 /* Accept extended format for hashtables (extensible to
2576 other types), e.g.
2577 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
2578 Lisp_Object tmp = read_list (0, readcharfun);
2579 Lisp_Object head = CAR_SAFE (tmp);
2580 Lisp_Object data = Qnil;
2581 Lisp_Object val = Qnil;
2582 /* The size is 2 * number of allowed keywords to
2583 make-hash-table. */
2584 Lisp_Object params[10];
2585 Lisp_Object ht;
2586 Lisp_Object key = Qnil;
2587 int param_count = 0;
2589 if (!EQ (head, Qhash_table))
2590 error ("Invalid extended read marker at head of #s list "
2591 "(only hash-table allowed)");
2593 tmp = CDR_SAFE (tmp);
2595 /* This is repetitive but fast and simple. */
2596 params[param_count] = QCsize;
2597 params[param_count + 1] = Fplist_get (tmp, Qsize);
2598 if (!NILP (params[param_count + 1]))
2599 param_count += 2;
2601 params[param_count] = QCtest;
2602 params[param_count + 1] = Fplist_get (tmp, Qtest);
2603 if (!NILP (params[param_count + 1]))
2604 param_count += 2;
2606 params[param_count] = QCweakness;
2607 params[param_count + 1] = Fplist_get (tmp, Qweakness);
2608 if (!NILP (params[param_count + 1]))
2609 param_count += 2;
2611 params[param_count] = QCrehash_size;
2612 params[param_count + 1] = Fplist_get (tmp, Qrehash_size);
2613 if (!NILP (params[param_count + 1]))
2614 param_count += 2;
2616 params[param_count] = QCrehash_threshold;
2617 params[param_count + 1] = Fplist_get (tmp, Qrehash_threshold);
2618 if (!NILP (params[param_count + 1]))
2619 param_count += 2;
2621 /* This is the hashtable data. */
2622 data = Fplist_get (tmp, Qdata);
2624 /* Now use params to make a new hashtable and fill it. */
2625 ht = Fmake_hash_table (param_count, params);
2627 while (CONSP (data))
2629 key = XCAR (data);
2630 data = XCDR (data);
2631 if (!CONSP (data))
2632 error ("Odd number of elements in hashtable data");
2633 val = XCAR (data);
2634 data = XCDR (data);
2635 Fputhash (key, val, ht);
2638 return ht;
2640 UNREAD (c);
2641 invalid_syntax ("#");
2643 if (c == '^')
2645 c = READCHAR;
2646 if (c == '[')
2648 Lisp_Object tmp;
2649 tmp = read_vector (readcharfun, 0);
2650 if (ASIZE (tmp) < CHAR_TABLE_STANDARD_SLOTS)
2651 error ("Invalid size char-table");
2652 XSETPVECTYPE (XVECTOR (tmp), PVEC_CHAR_TABLE);
2653 return tmp;
2655 else if (c == '^')
2657 c = READCHAR;
2658 if (c == '[')
2660 /* Sub char-table can't be read as a regular
2661 vector because of a two C integer fields. */
2662 Lisp_Object tbl, tmp = read_list (1, readcharfun);
2663 ptrdiff_t size = XINT (Flength (tmp));
2664 int i, depth, min_char;
2665 struct Lisp_Cons *cell;
2667 if (size == 0)
2668 error ("Zero-sized sub char-table");
2670 if (! RANGED_INTEGERP (1, XCAR (tmp), 3))
2671 error ("Invalid depth in sub char-table");
2672 depth = XINT (XCAR (tmp));
2673 if (chartab_size[depth] != size - 2)
2674 error ("Invalid size in sub char-table");
2675 cell = XCONS (tmp), tmp = XCDR (tmp), size--;
2676 free_cons (cell);
2678 if (! RANGED_INTEGERP (0, XCAR (tmp), MAX_CHAR))
2679 error ("Invalid minimum character in sub-char-table");
2680 min_char = XINT (XCAR (tmp));
2681 cell = XCONS (tmp), tmp = XCDR (tmp), size--;
2682 free_cons (cell);
2684 tbl = make_uninit_sub_char_table (depth, min_char);
2685 for (i = 0; i < size; i++)
2687 XSUB_CHAR_TABLE (tbl)->contents[i] = XCAR (tmp);
2688 cell = XCONS (tmp), tmp = XCDR (tmp);
2689 free_cons (cell);
2691 return tbl;
2693 invalid_syntax ("#^^");
2695 invalid_syntax ("#^");
2697 if (c == '&')
2699 Lisp_Object length;
2700 length = read1 (readcharfun, pch, first_in_list);
2701 c = READCHAR;
2702 if (c == '"')
2704 Lisp_Object tmp, val;
2705 EMACS_INT size_in_chars = bool_vector_bytes (XFASTINT (length));
2706 unsigned char *data;
2708 UNREAD (c);
2709 tmp = read1 (readcharfun, pch, first_in_list);
2710 if (STRING_MULTIBYTE (tmp)
2711 || (size_in_chars != SCHARS (tmp)
2712 /* We used to print 1 char too many
2713 when the number of bits was a multiple of 8.
2714 Accept such input in case it came from an old
2715 version. */
2716 && ! (XFASTINT (length)
2717 == (SCHARS (tmp) - 1) * BOOL_VECTOR_BITS_PER_CHAR)))
2718 invalid_syntax ("#&...");
2720 val = make_uninit_bool_vector (XFASTINT (length));
2721 data = bool_vector_uchar_data (val);
2722 memcpy (data, SDATA (tmp), size_in_chars);
2723 /* Clear the extraneous bits in the last byte. */
2724 if (XINT (length) != size_in_chars * BOOL_VECTOR_BITS_PER_CHAR)
2725 data[size_in_chars - 1]
2726 &= (1 << (XINT (length) % BOOL_VECTOR_BITS_PER_CHAR)) - 1;
2727 return val;
2729 invalid_syntax ("#&...");
2731 if (c == '[')
2733 /* Accept compiled functions at read-time so that we don't have to
2734 build them using function calls. */
2735 Lisp_Object tmp;
2736 struct Lisp_Vector *vec;
2737 tmp = read_vector (readcharfun, 1);
2738 vec = XVECTOR (tmp);
2739 if (vec->header.size == 0)
2740 invalid_syntax ("Empty byte-code object");
2741 make_byte_code (vec);
2742 return tmp;
2744 if (c == '(')
2746 Lisp_Object tmp;
2747 int ch;
2749 /* Read the string itself. */
2750 tmp = read1 (readcharfun, &ch, 0);
2751 if (ch != 0 || !STRINGP (tmp))
2752 invalid_syntax ("#");
2753 /* Read the intervals and their properties. */
2754 while (1)
2756 Lisp_Object beg, end, plist;
2758 beg = read1 (readcharfun, &ch, 0);
2759 end = plist = Qnil;
2760 if (ch == ')')
2761 break;
2762 if (ch == 0)
2763 end = read1 (readcharfun, &ch, 0);
2764 if (ch == 0)
2765 plist = read1 (readcharfun, &ch, 0);
2766 if (ch)
2767 invalid_syntax ("Invalid string property list");
2768 Fset_text_properties (beg, end, plist, tmp);
2771 return tmp;
2774 /* #@NUMBER is used to skip NUMBER following bytes.
2775 That's used in .elc files to skip over doc strings
2776 and function definitions. */
2777 if (c == '@')
2779 enum { extra = 100 };
2780 ptrdiff_t i, nskip = 0, digits = 0;
2782 /* Read a decimal integer. */
2783 while ((c = READCHAR) >= 0
2784 && c >= '0' && c <= '9')
2786 if ((STRING_BYTES_BOUND - extra) / 10 <= nskip)
2787 string_overflow ();
2788 digits++;
2789 nskip *= 10;
2790 nskip += c - '0';
2791 if (digits == 2 && nskip == 0)
2792 { /* We've just seen #@00, which means "skip to end". */
2793 skip_dyn_eof (readcharfun);
2794 return Qnil;
2797 if (nskip > 0)
2798 /* We can't use UNREAD here, because in the code below we side-step
2799 READCHAR. Instead, assume the first char after #@NNN occupies
2800 a single byte, which is the case normally since it's just
2801 a space. */
2802 nskip--;
2803 else
2804 UNREAD (c);
2806 if (load_force_doc_strings
2807 && (FROM_FILE_P (readcharfun)))
2809 /* If we are supposed to force doc strings into core right now,
2810 record the last string that we skipped,
2811 and record where in the file it comes from. */
2813 /* But first exchange saved_doc_string
2814 with prev_saved_doc_string, so we save two strings. */
2816 char *temp = saved_doc_string;
2817 ptrdiff_t temp_size = saved_doc_string_size;
2818 file_offset temp_pos = saved_doc_string_position;
2819 ptrdiff_t temp_len = saved_doc_string_length;
2821 saved_doc_string = prev_saved_doc_string;
2822 saved_doc_string_size = prev_saved_doc_string_size;
2823 saved_doc_string_position = prev_saved_doc_string_position;
2824 saved_doc_string_length = prev_saved_doc_string_length;
2826 prev_saved_doc_string = temp;
2827 prev_saved_doc_string_size = temp_size;
2828 prev_saved_doc_string_position = temp_pos;
2829 prev_saved_doc_string_length = temp_len;
2832 if (saved_doc_string_size == 0)
2834 saved_doc_string = xmalloc (nskip + extra);
2835 saved_doc_string_size = nskip + extra;
2837 if (nskip > saved_doc_string_size)
2839 saved_doc_string = xrealloc (saved_doc_string, nskip + extra);
2840 saved_doc_string_size = nskip + extra;
2843 saved_doc_string_position = file_tell (instream);
2845 /* Copy that many characters into saved_doc_string. */
2846 block_input ();
2847 for (i = 0; i < nskip && c >= 0; i++)
2848 saved_doc_string[i] = c = getc (instream);
2849 unblock_input ();
2851 saved_doc_string_length = i;
2853 else
2854 /* Skip that many bytes. */
2855 skip_dyn_bytes (readcharfun, nskip);
2857 goto retry;
2859 if (c == '!')
2861 /* #! appears at the beginning of an executable file.
2862 Skip the first line. */
2863 while (c != '\n' && c >= 0)
2864 c = READCHAR;
2865 goto retry;
2867 if (c == '$')
2868 return Vload_file_name;
2869 if (c == '\'')
2870 return list2 (Qfunction, read0 (readcharfun));
2871 /* #:foo is the uninterned symbol named foo. */
2872 if (c == ':')
2874 uninterned_symbol = 1;
2875 c = READCHAR;
2876 if (!(c > 040
2877 && c != NO_BREAK_SPACE
2878 && (c >= 0200
2879 || strchr ("\"';()[]#`,", c) == NULL)))
2881 /* No symbol character follows, this is the empty
2882 symbol. */
2883 UNREAD (c);
2884 return Fmake_symbol (empty_unibyte_string);
2886 goto read_symbol;
2888 /* ## is the empty symbol. */
2889 if (c == '#')
2890 return Fintern (empty_unibyte_string, Qnil);
2891 /* Reader forms that can reuse previously read objects. */
2892 if (c >= '0' && c <= '9')
2894 EMACS_INT n = 0;
2895 Lisp_Object tem;
2897 /* Read a non-negative integer. */
2898 while (c >= '0' && c <= '9')
2900 if (MOST_POSITIVE_FIXNUM / 10 < n
2901 || MOST_POSITIVE_FIXNUM < n * 10 + c - '0')
2902 n = MOST_POSITIVE_FIXNUM + 1;
2903 else
2904 n = n * 10 + c - '0';
2905 c = READCHAR;
2908 if (n <= MOST_POSITIVE_FIXNUM)
2910 if (c == 'r' || c == 'R')
2911 return read_integer (readcharfun, n);
2913 if (! NILP (Vread_circle))
2915 /* #n=object returns object, but associates it with
2916 n for #n#. */
2917 if (c == '=')
2919 /* Make a placeholder for #n# to use temporarily. */
2920 AUTO_CONS (placeholder, Qnil, Qnil);
2921 Lisp_Object cell = Fcons (make_number (n), placeholder);
2922 read_objects = Fcons (cell, read_objects);
2924 /* Read the object itself. */
2925 tem = read0 (readcharfun);
2927 /* Now put it everywhere the placeholder was... */
2928 substitute_object_in_subtree (tem, placeholder);
2930 /* ...and #n# will use the real value from now on. */
2931 Fsetcdr (cell, tem);
2933 return tem;
2936 /* #n# returns a previously read object. */
2937 if (c == '#')
2939 tem = Fassq (make_number (n), read_objects);
2940 if (CONSP (tem))
2941 return XCDR (tem);
2945 /* Fall through to error message. */
2947 else if (c == 'x' || c == 'X')
2948 return read_integer (readcharfun, 16);
2949 else if (c == 'o' || c == 'O')
2950 return read_integer (readcharfun, 8);
2951 else if (c == 'b' || c == 'B')
2952 return read_integer (readcharfun, 2);
2954 UNREAD (c);
2955 invalid_syntax ("#");
2957 case ';':
2958 while ((c = READCHAR) >= 0 && c != '\n');
2959 goto retry;
2961 case '\'':
2962 return list2 (Qquote, read0 (readcharfun));
2964 case '`':
2966 int next_char = READCHAR;
2967 UNREAD (next_char);
2968 /* Transition from old-style to new-style:
2969 If we see "(`" it used to mean old-style, which usually works
2970 fine because ` should almost never appear in such a position
2971 for new-style. But occasionally we need "(`" to mean new
2972 style, so we try to distinguish the two by the fact that we
2973 can either write "( `foo" or "(` foo", where the first
2974 intends to use new-style whereas the second intends to use
2975 old-style. For Emacs-25, we should completely remove this
2976 first_in_list exception (old-style can still be obtained via
2977 "(\`" anyway). */
2978 if (!new_backquote_flag && first_in_list && next_char == ' ')
2980 Vold_style_backquotes = Qt;
2981 goto default_label;
2983 else
2985 Lisp_Object value;
2986 bool saved_new_backquote_flag = new_backquote_flag;
2988 new_backquote_flag = 1;
2989 value = read0 (readcharfun);
2990 new_backquote_flag = saved_new_backquote_flag;
2992 return list2 (Qbackquote, value);
2995 case ',':
2997 int next_char = READCHAR;
2998 UNREAD (next_char);
2999 /* Transition from old-style to new-style:
3000 It used to be impossible to have a new-style , other than within
3001 a new-style `. This is sufficient when ` and , are used in the
3002 normal way, but ` and , can also appear in args to macros that
3003 will not interpret them in the usual way, in which case , may be
3004 used without any ` anywhere near.
3005 So we now use the same heuristic as for backquote: old-style
3006 unquotes are only recognized when first on a list, and when
3007 followed by a space.
3008 Because it's more difficult to peek 2 chars ahead, a new-style
3009 ,@ can still not be used outside of a `, unless it's in the middle
3010 of a list. */
3011 if (new_backquote_flag
3012 || !first_in_list
3013 || (next_char != ' ' && next_char != '@'))
3015 Lisp_Object comma_type = Qnil;
3016 Lisp_Object value;
3017 int ch = READCHAR;
3019 if (ch == '@')
3020 comma_type = Qcomma_at;
3021 else if (ch == '.')
3022 comma_type = Qcomma_dot;
3023 else
3025 if (ch >= 0) UNREAD (ch);
3026 comma_type = Qcomma;
3029 value = read0 (readcharfun);
3030 return list2 (comma_type, value);
3032 else
3034 Vold_style_backquotes = Qt;
3035 goto default_label;
3038 case '?':
3040 int modifiers;
3041 int next_char;
3042 bool ok;
3044 c = READCHAR;
3045 if (c < 0)
3046 end_of_file_error ();
3048 /* Accept `single space' syntax like (list ? x) where the
3049 whitespace character is SPC or TAB.
3050 Other literal whitespace like NL, CR, and FF are not accepted,
3051 as there are well-established escape sequences for these. */
3052 if (c == ' ' || c == '\t')
3053 return make_number (c);
3055 if (c == '\\')
3056 c = read_escape (readcharfun, 0);
3057 modifiers = c & CHAR_MODIFIER_MASK;
3058 c &= ~CHAR_MODIFIER_MASK;
3059 if (CHAR_BYTE8_P (c))
3060 c = CHAR_TO_BYTE8 (c);
3061 c |= modifiers;
3063 next_char = READCHAR;
3064 ok = (next_char <= 040
3065 || (next_char < 0200
3066 && strchr ("\"';()[]#?`,.", next_char) != NULL));
3067 UNREAD (next_char);
3068 if (ok)
3069 return make_number (c);
3071 invalid_syntax ("?");
3074 case '"':
3076 char *p = read_buffer;
3077 char *end = read_buffer + read_buffer_size;
3078 int ch;
3079 /* True if we saw an escape sequence specifying
3080 a multibyte character. */
3081 bool force_multibyte = 0;
3082 /* True if we saw an escape sequence specifying
3083 a single-byte character. */
3084 bool force_singlebyte = 0;
3085 bool cancel = 0;
3086 ptrdiff_t nchars = 0;
3088 while ((ch = READCHAR) >= 0
3089 && ch != '\"')
3091 if (end - p < MAX_MULTIBYTE_LENGTH)
3093 ptrdiff_t offset = p - read_buffer;
3094 grow_read_buffer ();
3095 p = read_buffer + offset;
3096 end = read_buffer + read_buffer_size;
3099 if (ch == '\\')
3101 int modifiers;
3103 ch = read_escape (readcharfun, 1);
3105 /* CH is -1 if \ newline or \ space has just been seen. */
3106 if (ch == -1)
3108 if (p == read_buffer)
3109 cancel = 1;
3110 continue;
3113 modifiers = ch & CHAR_MODIFIER_MASK;
3114 ch = ch & ~CHAR_MODIFIER_MASK;
3116 if (CHAR_BYTE8_P (ch))
3117 force_singlebyte = 1;
3118 else if (! ASCII_CHAR_P (ch))
3119 force_multibyte = 1;
3120 else /* I.e. ASCII_CHAR_P (ch). */
3122 /* Allow `\C- ' and `\C-?'. */
3123 if (modifiers == CHAR_CTL)
3125 if (ch == ' ')
3126 ch = 0, modifiers = 0;
3127 else if (ch == '?')
3128 ch = 127, modifiers = 0;
3130 if (modifiers & CHAR_SHIFT)
3132 /* Shift modifier is valid only with [A-Za-z]. */
3133 if (ch >= 'A' && ch <= 'Z')
3134 modifiers &= ~CHAR_SHIFT;
3135 else if (ch >= 'a' && ch <= 'z')
3136 ch -= ('a' - 'A'), modifiers &= ~CHAR_SHIFT;
3139 if (modifiers & CHAR_META)
3141 /* Move the meta bit to the right place for a
3142 string. */
3143 modifiers &= ~CHAR_META;
3144 ch = BYTE8_TO_CHAR (ch | 0x80);
3145 force_singlebyte = 1;
3149 /* Any modifiers remaining are invalid. */
3150 if (modifiers)
3151 error ("Invalid modifier in string");
3152 p += CHAR_STRING (ch, (unsigned char *) p);
3154 else
3156 p += CHAR_STRING (ch, (unsigned char *) p);
3157 if (CHAR_BYTE8_P (ch))
3158 force_singlebyte = 1;
3159 else if (! ASCII_CHAR_P (ch))
3160 force_multibyte = 1;
3162 nchars++;
3165 if (ch < 0)
3166 end_of_file_error ();
3168 /* If purifying, and string starts with \ newline,
3169 return zero instead. This is for doc strings
3170 that we are really going to find in etc/DOC.nn.nn. */
3171 if (!NILP (Vpurify_flag) && NILP (Vdoc_file_name) && cancel)
3172 return make_number (0);
3174 if (! force_multibyte && force_singlebyte)
3176 /* READ_BUFFER contains raw 8-bit bytes and no multibyte
3177 forms. Convert it to unibyte. */
3178 nchars = str_as_unibyte ((unsigned char *) read_buffer,
3179 p - read_buffer);
3180 p = read_buffer + nchars;
3183 return make_specified_string (read_buffer, nchars, p - read_buffer,
3184 (force_multibyte
3185 || (p - read_buffer != nchars)));
3188 case '.':
3190 int next_char = READCHAR;
3191 UNREAD (next_char);
3193 if (next_char <= 040
3194 || (next_char < 0200
3195 && strchr ("\"';([#?`,", next_char) != NULL))
3197 *pch = c;
3198 return Qnil;
3201 /* Otherwise, we fall through! Note that the atom-reading loop
3202 below will now loop at least once, assuring that we will not
3203 try to UNREAD two characters in a row. */
3205 default:
3206 default_label:
3207 if (c <= 040) goto retry;
3208 if (c == NO_BREAK_SPACE)
3209 goto retry;
3211 read_symbol:
3213 char *p = read_buffer;
3214 bool quoted = 0;
3215 EMACS_INT start_position = readchar_count - 1;
3218 char *end = read_buffer + read_buffer_size;
3222 if (end - p < MAX_MULTIBYTE_LENGTH)
3224 ptrdiff_t offset = p - read_buffer;
3225 grow_read_buffer ();
3226 p = read_buffer + offset;
3227 end = read_buffer + read_buffer_size;
3230 if (c == '\\')
3232 c = READCHAR;
3233 if (c == -1)
3234 end_of_file_error ();
3235 quoted = 1;
3238 if (multibyte)
3239 p += CHAR_STRING (c, (unsigned char *) p);
3240 else
3241 *p++ = c;
3242 c = READCHAR;
3244 while (c > 040
3245 && c != NO_BREAK_SPACE
3246 && (c >= 0200
3247 || strchr ("\"';()[]#`,", c) == NULL));
3249 if (p == end)
3251 ptrdiff_t offset = p - read_buffer;
3252 grow_read_buffer ();
3253 p = read_buffer + offset;
3254 end = read_buffer + read_buffer_size;
3256 *p = 0;
3257 UNREAD (c);
3260 if (!quoted && !uninterned_symbol)
3262 Lisp_Object result = string_to_number (read_buffer, 10, 0);
3263 if (! NILP (result))
3264 return result;
3267 Lisp_Object name, result;
3268 ptrdiff_t nbytes = p - read_buffer;
3269 ptrdiff_t nchars
3270 = (multibyte
3271 ? multibyte_chars_in_text ((unsigned char *) read_buffer,
3272 nbytes)
3273 : nbytes);
3275 name = ((uninterned_symbol && ! NILP (Vpurify_flag)
3276 ? make_pure_string : make_specified_string)
3277 (read_buffer, nchars, nbytes, multibyte));
3278 result = (uninterned_symbol ? Fmake_symbol (name)
3279 : Fintern (name, Qnil));
3281 if (EQ (Vread_with_symbol_positions, Qt)
3282 || EQ (Vread_with_symbol_positions, readcharfun))
3283 Vread_symbol_positions_list
3284 = Fcons (Fcons (result, make_number (start_position)),
3285 Vread_symbol_positions_list);
3286 return result;
3293 /* List of nodes we've seen during substitute_object_in_subtree. */
3294 static Lisp_Object seen_list;
3296 static void
3297 substitute_object_in_subtree (Lisp_Object object, Lisp_Object placeholder)
3299 Lisp_Object check_object;
3301 /* We haven't seen any objects when we start. */
3302 seen_list = Qnil;
3304 /* Make all the substitutions. */
3305 check_object
3306 = substitute_object_recurse (object, placeholder, object);
3308 /* Clear seen_list because we're done with it. */
3309 seen_list = Qnil;
3311 /* The returned object here is expected to always eq the
3312 original. */
3313 if (!EQ (check_object, object))
3314 error ("Unexpected mutation error in reader");
3317 /* Feval doesn't get called from here, so no gc protection is needed. */
3318 #define SUBSTITUTE(get_val, set_val) \
3319 do { \
3320 Lisp_Object old_value = get_val; \
3321 Lisp_Object true_value \
3322 = substitute_object_recurse (object, placeholder, \
3323 old_value); \
3325 if (!EQ (old_value, true_value)) \
3327 set_val; \
3329 } while (0)
3331 static Lisp_Object
3332 substitute_object_recurse (Lisp_Object object, Lisp_Object placeholder, Lisp_Object subtree)
3334 /* If we find the placeholder, return the target object. */
3335 if (EQ (placeholder, subtree))
3336 return object;
3338 /* If we've been to this node before, don't explore it again. */
3339 if (!EQ (Qnil, Fmemq (subtree, seen_list)))
3340 return subtree;
3342 /* If this node can be the entry point to a cycle, remember that
3343 we've seen it. It can only be such an entry point if it was made
3344 by #n=, which means that we can find it as a value in
3345 read_objects. */
3346 if (!EQ (Qnil, Frassq (subtree, read_objects)))
3347 seen_list = Fcons (subtree, seen_list);
3349 /* Recurse according to subtree's type.
3350 Every branch must return a Lisp_Object. */
3351 switch (XTYPE (subtree))
3353 case Lisp_Vectorlike:
3355 ptrdiff_t i = 0, length = 0;
3356 if (BOOL_VECTOR_P (subtree))
3357 return subtree; /* No sub-objects anyway. */
3358 else if (CHAR_TABLE_P (subtree) || SUB_CHAR_TABLE_P (subtree)
3359 || COMPILEDP (subtree) || HASH_TABLE_P (subtree))
3360 length = ASIZE (subtree) & PSEUDOVECTOR_SIZE_MASK;
3361 else if (VECTORP (subtree))
3362 length = ASIZE (subtree);
3363 else
3364 /* An unknown pseudovector may contain non-Lisp fields, so we
3365 can't just blindly traverse all its fields. We used to call
3366 `Flength' which signaled `sequencep', so I just preserved this
3367 behavior. */
3368 wrong_type_argument (Qsequencep, subtree);
3370 if (SUB_CHAR_TABLE_P (subtree))
3371 i = 2;
3372 for ( ; i < length; i++)
3373 SUBSTITUTE (AREF (subtree, i),
3374 ASET (subtree, i, true_value));
3375 return subtree;
3378 case Lisp_Cons:
3380 SUBSTITUTE (XCAR (subtree),
3381 XSETCAR (subtree, true_value));
3382 SUBSTITUTE (XCDR (subtree),
3383 XSETCDR (subtree, true_value));
3384 return subtree;
3387 case Lisp_String:
3389 /* Check for text properties in each interval.
3390 substitute_in_interval contains part of the logic. */
3392 INTERVAL root_interval = string_intervals (subtree);
3393 AUTO_CONS (arg, object, placeholder);
3395 traverse_intervals_noorder (root_interval,
3396 &substitute_in_interval, arg);
3398 return subtree;
3401 /* Other types don't recurse any further. */
3402 default:
3403 return subtree;
3407 /* Helper function for substitute_object_recurse. */
3408 static void
3409 substitute_in_interval (INTERVAL interval, Lisp_Object arg)
3411 Lisp_Object object = Fcar (arg);
3412 Lisp_Object placeholder = Fcdr (arg);
3414 SUBSTITUTE (interval->plist, set_interval_plist (interval, true_value));
3418 #define LEAD_INT 1
3419 #define DOT_CHAR 2
3420 #define TRAIL_INT 4
3421 #define E_EXP 16
3424 /* Convert STRING to a number, assuming base BASE. Return a fixnum if CP has
3425 integer syntax and fits in a fixnum, else return the nearest float if CP has
3426 either floating point or integer syntax and BASE is 10, else return nil. If
3427 IGNORE_TRAILING, consider just the longest prefix of CP that has
3428 valid floating point syntax. Signal an overflow if BASE is not 10 and the
3429 number has integer syntax but does not fit. */
3431 Lisp_Object
3432 string_to_number (char const *string, int base, bool ignore_trailing)
3434 int state;
3435 char const *cp = string;
3436 int leading_digit;
3437 bool float_syntax = 0;
3438 double value = 0;
3440 /* Negate the value ourselves. This treats 0, NaNs, and infinity properly on
3441 IEEE floating point hosts, and works around a formerly-common bug where
3442 atof ("-0.0") drops the sign. */
3443 bool negative = *cp == '-';
3445 bool signedp = negative || *cp == '+';
3446 cp += signedp;
3448 state = 0;
3450 leading_digit = digit_to_number (*cp, base);
3451 if (leading_digit >= 0)
3453 state |= LEAD_INT;
3455 ++cp;
3456 while (digit_to_number (*cp, base) >= 0);
3458 if (*cp == '.')
3460 state |= DOT_CHAR;
3461 cp++;
3464 if (base == 10)
3466 if ('0' <= *cp && *cp <= '9')
3468 state |= TRAIL_INT;
3470 cp++;
3471 while ('0' <= *cp && *cp <= '9');
3473 if (*cp == 'e' || *cp == 'E')
3475 char const *ecp = cp;
3476 cp++;
3477 if (*cp == '+' || *cp == '-')
3478 cp++;
3479 if ('0' <= *cp && *cp <= '9')
3481 state |= E_EXP;
3483 cp++;
3484 while ('0' <= *cp && *cp <= '9');
3486 else if (cp[-1] == '+'
3487 && cp[0] == 'I' && cp[1] == 'N' && cp[2] == 'F')
3489 state |= E_EXP;
3490 cp += 3;
3491 value = INFINITY;
3493 else if (cp[-1] == '+'
3494 && cp[0] == 'N' && cp[1] == 'a' && cp[2] == 'N')
3496 state |= E_EXP;
3497 cp += 3;
3498 /* NAN is a "positive" NaN on all known Emacs hosts. */
3499 value = NAN;
3501 else
3502 cp = ecp;
3505 float_syntax = ((state & (DOT_CHAR|TRAIL_INT)) == (DOT_CHAR|TRAIL_INT)
3506 || state == (LEAD_INT|E_EXP));
3509 /* Return nil if the number uses invalid syntax. If IGNORE_TRAILING, accept
3510 any prefix that matches. Otherwise, the entire string must match. */
3511 if (! (ignore_trailing
3512 ? ((state & LEAD_INT) != 0 || float_syntax)
3513 : (!*cp && ((state & ~DOT_CHAR) == LEAD_INT || float_syntax))))
3514 return Qnil;
3516 /* If the number uses integer and not float syntax, and is in C-language
3517 range, use its value, preferably as a fixnum. */
3518 if (leading_digit >= 0 && ! float_syntax)
3520 uintmax_t n;
3522 /* Fast special case for single-digit integers. This also avoids a
3523 glitch when BASE is 16 and IGNORE_TRAILING, because in that
3524 case some versions of strtoumax accept numbers like "0x1" that Emacs
3525 does not allow. */
3526 if (digit_to_number (string[signedp + 1], base) < 0)
3527 return make_number (negative ? -leading_digit : leading_digit);
3529 errno = 0;
3530 n = strtoumax (string + signedp, NULL, base);
3531 if (errno == ERANGE)
3533 /* Unfortunately there's no simple and accurate way to convert
3534 non-base-10 numbers that are out of C-language range. */
3535 if (base != 10)
3536 xsignal1 (Qoverflow_error, build_string (string));
3538 else if (n <= (negative ? -MOST_NEGATIVE_FIXNUM : MOST_POSITIVE_FIXNUM))
3540 EMACS_INT signed_n = n;
3541 return make_number (negative ? -signed_n : signed_n);
3543 else
3544 value = n;
3547 /* Either the number uses float syntax, or it does not fit into a fixnum.
3548 Convert it from string to floating point, unless the value is already
3549 known because it is an infinity, a NAN, or its absolute value fits in
3550 uintmax_t. */
3551 if (! value)
3552 value = atof (string + signedp);
3554 return make_float (negative ? -value : value);
3558 static Lisp_Object
3559 read_vector (Lisp_Object readcharfun, bool bytecodeflag)
3561 ptrdiff_t i, size;
3562 Lisp_Object *ptr;
3563 Lisp_Object tem, item, vector;
3564 struct Lisp_Cons *otem;
3565 Lisp_Object len;
3567 tem = read_list (1, readcharfun);
3568 len = Flength (tem);
3569 vector = Fmake_vector (len, Qnil);
3571 size = ASIZE (vector);
3572 ptr = XVECTOR (vector)->contents;
3573 for (i = 0; i < size; i++)
3575 item = Fcar (tem);
3576 /* If `load-force-doc-strings' is t when reading a lazily-loaded
3577 bytecode object, the docstring containing the bytecode and
3578 constants values must be treated as unibyte and passed to
3579 Fread, to get the actual bytecode string and constants vector. */
3580 if (bytecodeflag && load_force_doc_strings)
3582 if (i == COMPILED_BYTECODE)
3584 if (!STRINGP (item))
3585 error ("Invalid byte code");
3587 /* Delay handling the bytecode slot until we know whether
3588 it is lazily-loaded (we can tell by whether the
3589 constants slot is nil). */
3590 ASET (vector, COMPILED_CONSTANTS, item);
3591 item = Qnil;
3593 else if (i == COMPILED_CONSTANTS)
3595 Lisp_Object bytestr = ptr[COMPILED_CONSTANTS];
3597 if (NILP (item))
3599 /* Coerce string to unibyte (like string-as-unibyte,
3600 but without generating extra garbage and
3601 guaranteeing no change in the contents). */
3602 STRING_SET_CHARS (bytestr, SBYTES (bytestr));
3603 STRING_SET_UNIBYTE (bytestr);
3605 item = Fread (Fcons (bytestr, readcharfun));
3606 if (!CONSP (item))
3607 error ("Invalid byte code");
3609 otem = XCONS (item);
3610 bytestr = XCAR (item);
3611 item = XCDR (item);
3612 free_cons (otem);
3615 /* Now handle the bytecode slot. */
3616 ASET (vector, COMPILED_BYTECODE, bytestr);
3618 else if (i == COMPILED_DOC_STRING
3619 && STRINGP (item)
3620 && ! STRING_MULTIBYTE (item))
3622 if (EQ (readcharfun, Qget_emacs_mule_file_char))
3623 item = Fdecode_coding_string (item, Qemacs_mule, Qnil, Qnil);
3624 else
3625 item = Fstring_as_multibyte (item);
3628 ASET (vector, i, item);
3629 otem = XCONS (tem);
3630 tem = Fcdr (tem);
3631 free_cons (otem);
3633 return vector;
3636 /* FLAG means check for ']' to terminate rather than ')' and '.'. */
3638 static Lisp_Object
3639 read_list (bool flag, Lisp_Object readcharfun)
3641 Lisp_Object val, tail;
3642 Lisp_Object elt, tem;
3643 /* 0 is the normal case.
3644 1 means this list is a doc reference; replace it with the number 0.
3645 2 means this list is a doc reference; replace it with the doc string. */
3646 int doc_reference = 0;
3648 /* Initialize this to 1 if we are reading a list. */
3649 bool first_in_list = flag <= 0;
3651 val = Qnil;
3652 tail = Qnil;
3654 while (1)
3656 int ch;
3657 elt = read1 (readcharfun, &ch, first_in_list);
3659 first_in_list = 0;
3661 /* While building, if the list starts with #$, treat it specially. */
3662 if (EQ (elt, Vload_file_name)
3663 && ! NILP (elt)
3664 && !NILP (Vpurify_flag))
3666 if (NILP (Vdoc_file_name))
3667 /* We have not yet called Snarf-documentation, so assume
3668 this file is described in the DOC file
3669 and Snarf-documentation will fill in the right value later.
3670 For now, replace the whole list with 0. */
3671 doc_reference = 1;
3672 else
3673 /* We have already called Snarf-documentation, so make a relative
3674 file name for this file, so it can be found properly
3675 in the installed Lisp directory.
3676 We don't use Fexpand_file_name because that would make
3677 the directory absolute now. */
3679 AUTO_STRING (dot_dot_lisp, "../lisp/");
3680 elt = concat2 (dot_dot_lisp, Ffile_name_nondirectory (elt));
3683 else if (EQ (elt, Vload_file_name)
3684 && ! NILP (elt)
3685 && load_force_doc_strings)
3686 doc_reference = 2;
3688 if (ch)
3690 if (flag > 0)
3692 if (ch == ']')
3693 return val;
3694 invalid_syntax (") or . in a vector");
3696 if (ch == ')')
3697 return val;
3698 if (ch == '.')
3700 if (!NILP (tail))
3701 XSETCDR (tail, read0 (readcharfun));
3702 else
3703 val = read0 (readcharfun);
3704 read1 (readcharfun, &ch, 0);
3706 if (ch == ')')
3708 if (doc_reference == 1)
3709 return make_number (0);
3710 if (doc_reference == 2 && INTEGERP (XCDR (val)))
3712 char *saved = NULL;
3713 file_offset saved_position;
3714 /* Get a doc string from the file we are loading.
3715 If it's in saved_doc_string, get it from there.
3717 Here, we don't know if the string is a
3718 bytecode string or a doc string. As a
3719 bytecode string must be unibyte, we always
3720 return a unibyte string. If it is actually a
3721 doc string, caller must make it
3722 multibyte. */
3724 /* Position is negative for user variables. */
3725 EMACS_INT pos = eabs (XINT (XCDR (val)));
3726 if (pos >= saved_doc_string_position
3727 && pos < (saved_doc_string_position
3728 + saved_doc_string_length))
3730 saved = saved_doc_string;
3731 saved_position = saved_doc_string_position;
3733 /* Look in prev_saved_doc_string the same way. */
3734 else if (pos >= prev_saved_doc_string_position
3735 && pos < (prev_saved_doc_string_position
3736 + prev_saved_doc_string_length))
3738 saved = prev_saved_doc_string;
3739 saved_position = prev_saved_doc_string_position;
3741 if (saved)
3743 ptrdiff_t start = pos - saved_position;
3744 ptrdiff_t from, to;
3746 /* Process quoting with ^A,
3747 and find the end of the string,
3748 which is marked with ^_ (037). */
3749 for (from = start, to = start;
3750 saved[from] != 037;)
3752 int c = saved[from++];
3753 if (c == 1)
3755 c = saved[from++];
3756 saved[to++] = (c == 1 ? c
3757 : c == '0' ? 0
3758 : c == '_' ? 037
3759 : c);
3761 else
3762 saved[to++] = c;
3765 return make_unibyte_string (saved + start,
3766 to - start);
3768 else
3769 return get_doc_string (val, 1, 0);
3772 return val;
3774 invalid_syntax (". in wrong context");
3776 invalid_syntax ("] in a list");
3778 tem = list1 (elt);
3779 if (!NILP (tail))
3780 XSETCDR (tail, tem);
3781 else
3782 val = tem;
3783 tail = tem;
3787 static Lisp_Object initial_obarray;
3789 /* `oblookup' stores the bucket number here, for the sake of Funintern. */
3791 static size_t oblookup_last_bucket_number;
3793 /* Get an error if OBARRAY is not an obarray.
3794 If it is one, return it. */
3796 Lisp_Object
3797 check_obarray (Lisp_Object obarray)
3799 /* We don't want to signal a wrong-type-argument error when we are
3800 shutting down due to a fatal error, and we don't want to hit
3801 assertions in VECTORP and ASIZE if the fatal error was during GC. */
3802 if (!fatal_error_in_progress
3803 && (!VECTORP (obarray) || ASIZE (obarray) == 0))
3805 /* If Vobarray is now invalid, force it to be valid. */
3806 if (EQ (Vobarray, obarray)) Vobarray = initial_obarray;
3807 wrong_type_argument (Qvectorp, obarray);
3809 return obarray;
3812 /* Intern symbol SYM in OBARRAY using bucket INDEX. */
3814 static Lisp_Object
3815 intern_sym (Lisp_Object sym, Lisp_Object obarray, Lisp_Object index)
3817 Lisp_Object *ptr;
3819 XSYMBOL (sym)->interned = (EQ (obarray, initial_obarray)
3820 ? SYMBOL_INTERNED_IN_INITIAL_OBARRAY
3821 : SYMBOL_INTERNED);
3823 if (SREF (SYMBOL_NAME (sym), 0) == ':' && EQ (obarray, initial_obarray))
3825 XSYMBOL (sym)->constant = 1;
3826 XSYMBOL (sym)->redirect = SYMBOL_PLAINVAL;
3827 SET_SYMBOL_VAL (XSYMBOL (sym), sym);
3830 ptr = aref_addr (obarray, XINT (index));
3831 set_symbol_next (sym, SYMBOLP (*ptr) ? XSYMBOL (*ptr) : NULL);
3832 *ptr = sym;
3833 return sym;
3836 /* Intern a symbol with name STRING in OBARRAY using bucket INDEX. */
3838 Lisp_Object
3839 intern_driver (Lisp_Object string, Lisp_Object obarray, Lisp_Object index)
3841 return intern_sym (Fmake_symbol (string), obarray, index);
3844 /* Intern the C string STR: return a symbol with that name,
3845 interned in the current obarray. */
3847 Lisp_Object
3848 intern_1 (const char *str, ptrdiff_t len)
3850 Lisp_Object obarray = check_obarray (Vobarray);
3851 Lisp_Object tem = oblookup (obarray, str, len, len);
3853 return (SYMBOLP (tem) ? tem
3854 /* The above `oblookup' was done on the basis of nchars==nbytes, so
3855 the string has to be unibyte. */
3856 : intern_driver (make_unibyte_string (str, len),
3857 obarray, tem));
3860 Lisp_Object
3861 intern_c_string_1 (const char *str, ptrdiff_t len)
3863 Lisp_Object obarray = check_obarray (Vobarray);
3864 Lisp_Object tem = oblookup (obarray, str, len, len);
3866 if (!SYMBOLP (tem))
3868 /* Creating a non-pure string from a string literal not implemented yet.
3869 We could just use make_string here and live with the extra copy. */
3870 eassert (!NILP (Vpurify_flag));
3871 tem = intern_driver (make_pure_c_string (str, len), obarray, tem);
3873 return tem;
3876 static void
3877 define_symbol (Lisp_Object sym, char const *str)
3879 ptrdiff_t len = strlen (str);
3880 Lisp_Object string = make_pure_c_string (str, len);
3881 init_symbol (sym, string);
3883 /* Qunbound is uninterned, so that it's not confused with any symbol
3884 'unbound' created by a Lisp program. */
3885 if (! EQ (sym, Qunbound))
3887 Lisp_Object bucket = oblookup (initial_obarray, str, len, len);
3888 eassert (INTEGERP (bucket));
3889 intern_sym (sym, initial_obarray, bucket);
3893 DEFUN ("intern", Fintern, Sintern, 1, 2, 0,
3894 doc: /* Return the canonical symbol whose name is STRING.
3895 If there is none, one is created by this function and returned.
3896 A second optional argument specifies the obarray to use;
3897 it defaults to the value of `obarray'. */)
3898 (Lisp_Object string, Lisp_Object obarray)
3900 Lisp_Object tem;
3902 obarray = check_obarray (NILP (obarray) ? Vobarray : obarray);
3903 CHECK_STRING (string);
3905 tem = oblookup (obarray, SSDATA (string), SCHARS (string), SBYTES (string));
3906 if (!SYMBOLP (tem))
3907 tem = intern_driver (NILP (Vpurify_flag) ? string : Fpurecopy (string),
3908 obarray, tem);
3909 return tem;
3912 DEFUN ("intern-soft", Fintern_soft, Sintern_soft, 1, 2, 0,
3913 doc: /* Return the canonical symbol named NAME, or nil if none exists.
3914 NAME may be a string or a symbol. If it is a symbol, that exact
3915 symbol is searched for.
3916 A second optional argument specifies the obarray to use;
3917 it defaults to the value of `obarray'. */)
3918 (Lisp_Object name, Lisp_Object obarray)
3920 register Lisp_Object tem, string;
3922 if (NILP (obarray)) obarray = Vobarray;
3923 obarray = check_obarray (obarray);
3925 if (!SYMBOLP (name))
3927 CHECK_STRING (name);
3928 string = name;
3930 else
3931 string = SYMBOL_NAME (name);
3933 tem = oblookup (obarray, SSDATA (string), SCHARS (string), SBYTES (string));
3934 if (INTEGERP (tem) || (SYMBOLP (name) && !EQ (name, tem)))
3935 return Qnil;
3936 else
3937 return tem;
3940 DEFUN ("unintern", Funintern, Sunintern, 1, 2, 0,
3941 doc: /* Delete the symbol named NAME, if any, from OBARRAY.
3942 The value is t if a symbol was found and deleted, nil otherwise.
3943 NAME may be a string or a symbol. If it is a symbol, that symbol
3944 is deleted, if it belongs to OBARRAY--no other symbol is deleted.
3945 OBARRAY, if nil, defaults to the value of the variable `obarray'.
3946 usage: (unintern NAME OBARRAY) */)
3947 (Lisp_Object name, Lisp_Object obarray)
3949 register Lisp_Object string, tem;
3950 size_t hash;
3952 if (NILP (obarray)) obarray = Vobarray;
3953 obarray = check_obarray (obarray);
3955 if (SYMBOLP (name))
3956 string = SYMBOL_NAME (name);
3957 else
3959 CHECK_STRING (name);
3960 string = name;
3963 tem = oblookup (obarray, SSDATA (string),
3964 SCHARS (string),
3965 SBYTES (string));
3966 if (INTEGERP (tem))
3967 return Qnil;
3968 /* If arg was a symbol, don't delete anything but that symbol itself. */
3969 if (SYMBOLP (name) && !EQ (name, tem))
3970 return Qnil;
3972 /* There are plenty of other symbols which will screw up the Emacs
3973 session if we unintern them, as well as even more ways to use
3974 `setq' or `fset' or whatnot to make the Emacs session
3975 unusable. Let's not go down this silly road. --Stef */
3976 /* if (EQ (tem, Qnil) || EQ (tem, Qt))
3977 error ("Attempt to unintern t or nil"); */
3979 XSYMBOL (tem)->interned = SYMBOL_UNINTERNED;
3981 hash = oblookup_last_bucket_number;
3983 if (EQ (AREF (obarray, hash), tem))
3985 if (XSYMBOL (tem)->next)
3987 Lisp_Object sym;
3988 XSETSYMBOL (sym, XSYMBOL (tem)->next);
3989 ASET (obarray, hash, sym);
3991 else
3992 ASET (obarray, hash, make_number (0));
3994 else
3996 Lisp_Object tail, following;
3998 for (tail = AREF (obarray, hash);
3999 XSYMBOL (tail)->next;
4000 tail = following)
4002 XSETSYMBOL (following, XSYMBOL (tail)->next);
4003 if (EQ (following, tem))
4005 set_symbol_next (tail, XSYMBOL (following)->next);
4006 break;
4011 return Qt;
4014 /* Return the symbol in OBARRAY whose names matches the string
4015 of SIZE characters (SIZE_BYTE bytes) at PTR.
4016 If there is no such symbol, return the integer bucket number of
4017 where the symbol would be if it were present.
4019 Also store the bucket number in oblookup_last_bucket_number. */
4021 Lisp_Object
4022 oblookup (Lisp_Object obarray, register const char *ptr, ptrdiff_t size, ptrdiff_t size_byte)
4024 size_t hash;
4025 size_t obsize;
4026 register Lisp_Object tail;
4027 Lisp_Object bucket, tem;
4029 obarray = check_obarray (obarray);
4030 /* This is sometimes needed in the middle of GC. */
4031 obsize = gc_asize (obarray);
4032 hash = hash_string (ptr, size_byte) % obsize;
4033 bucket = AREF (obarray, hash);
4034 oblookup_last_bucket_number = hash;
4035 if (EQ (bucket, make_number (0)))
4037 else if (!SYMBOLP (bucket))
4038 error ("Bad data in guts of obarray"); /* Like CADR error message. */
4039 else
4040 for (tail = bucket; ; XSETSYMBOL (tail, XSYMBOL (tail)->next))
4042 if (SBYTES (SYMBOL_NAME (tail)) == size_byte
4043 && SCHARS (SYMBOL_NAME (tail)) == size
4044 && !memcmp (SDATA (SYMBOL_NAME (tail)), ptr, size_byte))
4045 return tail;
4046 else if (XSYMBOL (tail)->next == 0)
4047 break;
4049 XSETINT (tem, hash);
4050 return tem;
4053 void
4054 map_obarray (Lisp_Object obarray, void (*fn) (Lisp_Object, Lisp_Object), Lisp_Object arg)
4056 ptrdiff_t i;
4057 register Lisp_Object tail;
4058 CHECK_VECTOR (obarray);
4059 for (i = ASIZE (obarray) - 1; i >= 0; i--)
4061 tail = AREF (obarray, i);
4062 if (SYMBOLP (tail))
4063 while (1)
4065 (*fn) (tail, arg);
4066 if (XSYMBOL (tail)->next == 0)
4067 break;
4068 XSETSYMBOL (tail, XSYMBOL (tail)->next);
4073 static void
4074 mapatoms_1 (Lisp_Object sym, Lisp_Object function)
4076 call1 (function, sym);
4079 DEFUN ("mapatoms", Fmapatoms, Smapatoms, 1, 2, 0,
4080 doc: /* Call FUNCTION on every symbol in OBARRAY.
4081 OBARRAY defaults to the value of `obarray'. */)
4082 (Lisp_Object function, Lisp_Object obarray)
4084 if (NILP (obarray)) obarray = Vobarray;
4085 obarray = check_obarray (obarray);
4087 map_obarray (obarray, mapatoms_1, function);
4088 return Qnil;
4091 #define OBARRAY_SIZE 1511
4093 void
4094 init_obarray (void)
4096 Lisp_Object oblength;
4097 ptrdiff_t size = 100 + MAX_MULTIBYTE_LENGTH;
4099 XSETFASTINT (oblength, OBARRAY_SIZE);
4101 Vobarray = Fmake_vector (oblength, make_number (0));
4102 initial_obarray = Vobarray;
4103 staticpro (&initial_obarray);
4105 for (int i = 0; i < ARRAYELTS (lispsym); i++)
4106 define_symbol (builtin_lisp_symbol (i), defsym_name[i]);
4108 DEFSYM (Qunbound, "unbound");
4110 DEFSYM (Qnil, "nil");
4111 SET_SYMBOL_VAL (XSYMBOL (Qnil), Qnil);
4112 XSYMBOL (Qnil)->constant = 1;
4113 XSYMBOL (Qnil)->declared_special = true;
4115 DEFSYM (Qt, "t");
4116 SET_SYMBOL_VAL (XSYMBOL (Qt), Qt);
4117 XSYMBOL (Qt)->constant = 1;
4118 XSYMBOL (Qt)->declared_special = true;
4120 /* Qt is correct even if CANNOT_DUMP. loadup.el will set to nil at end. */
4121 Vpurify_flag = Qt;
4123 DEFSYM (Qvariable_documentation, "variable-documentation");
4125 read_buffer = xmalloc (size);
4126 read_buffer_size = size;
4129 void
4130 defsubr (struct Lisp_Subr *sname)
4132 Lisp_Object sym, tem;
4133 sym = intern_c_string (sname->symbol_name);
4134 XSETPVECTYPE (sname, PVEC_SUBR);
4135 XSETSUBR (tem, sname);
4136 set_symbol_function (sym, tem);
4139 #ifdef NOTDEF /* Use fset in subr.el now! */
4140 void
4141 defalias (struct Lisp_Subr *sname, char *string)
4143 Lisp_Object sym;
4144 sym = intern (string);
4145 XSETSUBR (XSYMBOL (sym)->function, sname);
4147 #endif /* NOTDEF */
4149 /* Define an "integer variable"; a symbol whose value is forwarded to a
4150 C variable of type EMACS_INT. Sample call (with "xx" to fool make-docfile):
4151 DEFxxVAR_INT ("emacs-priority", &emacs_priority, "Documentation"); */
4152 void
4153 defvar_int (struct Lisp_Intfwd *i_fwd,
4154 const char *namestring, EMACS_INT *address)
4156 Lisp_Object sym;
4157 sym = intern_c_string (namestring);
4158 i_fwd->type = Lisp_Fwd_Int;
4159 i_fwd->intvar = address;
4160 XSYMBOL (sym)->declared_special = 1;
4161 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4162 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)i_fwd);
4165 /* Similar but define a variable whose value is t if address contains 1,
4166 nil if address contains 0. */
4167 void
4168 defvar_bool (struct Lisp_Boolfwd *b_fwd,
4169 const char *namestring, bool *address)
4171 Lisp_Object sym;
4172 sym = intern_c_string (namestring);
4173 b_fwd->type = Lisp_Fwd_Bool;
4174 b_fwd->boolvar = address;
4175 XSYMBOL (sym)->declared_special = 1;
4176 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4177 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)b_fwd);
4178 Vbyte_boolean_vars = Fcons (sym, Vbyte_boolean_vars);
4181 /* Similar but define a variable whose value is the Lisp Object stored
4182 at address. Two versions: with and without gc-marking of the C
4183 variable. The nopro version is used when that variable will be
4184 gc-marked for some other reason, since marking the same slot twice
4185 can cause trouble with strings. */
4186 void
4187 defvar_lisp_nopro (struct Lisp_Objfwd *o_fwd,
4188 const char *namestring, Lisp_Object *address)
4190 Lisp_Object sym;
4191 sym = intern_c_string (namestring);
4192 o_fwd->type = Lisp_Fwd_Obj;
4193 o_fwd->objvar = address;
4194 XSYMBOL (sym)->declared_special = 1;
4195 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4196 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)o_fwd);
4199 void
4200 defvar_lisp (struct Lisp_Objfwd *o_fwd,
4201 const char *namestring, Lisp_Object *address)
4203 defvar_lisp_nopro (o_fwd, namestring, address);
4204 staticpro (address);
4207 /* Similar but define a variable whose value is the Lisp Object stored
4208 at a particular offset in the current kboard object. */
4210 void
4211 defvar_kboard (struct Lisp_Kboard_Objfwd *ko_fwd,
4212 const char *namestring, int offset)
4214 Lisp_Object sym;
4215 sym = intern_c_string (namestring);
4216 ko_fwd->type = Lisp_Fwd_Kboard_Obj;
4217 ko_fwd->offset = offset;
4218 XSYMBOL (sym)->declared_special = 1;
4219 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4220 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)ko_fwd);
4223 /* Check that the elements of lpath exist. */
4225 static void
4226 load_path_check (Lisp_Object lpath)
4228 Lisp_Object path_tail;
4230 /* The only elements that might not exist are those from
4231 PATH_LOADSEARCH, EMACSLOADPATH. Anything else is only added if
4232 it exists. */
4233 for (path_tail = lpath; !NILP (path_tail); path_tail = XCDR (path_tail))
4235 Lisp_Object dirfile;
4236 dirfile = Fcar (path_tail);
4237 if (STRINGP (dirfile))
4239 dirfile = Fdirectory_file_name (dirfile);
4240 if (! file_accessible_directory_p (dirfile))
4241 dir_warning ("Lisp directory", XCAR (path_tail));
4246 /* Return the default load-path, to be used if EMACSLOADPATH is unset.
4247 This does not include the standard site-lisp directories
4248 under the installation prefix (i.e., PATH_SITELOADSEARCH),
4249 but it does (unless no_site_lisp is set) include site-lisp
4250 directories in the source/build directories if those exist and we
4251 are running uninstalled.
4253 Uses the following logic:
4254 If CANNOT_DUMP: Use PATH_LOADSEARCH.
4255 The remainder is what happens when dumping works:
4256 If purify-flag (ie dumping) just use PATH_DUMPLOADSEARCH.
4257 Otherwise use PATH_LOADSEARCH.
4259 If !initialized, then just return PATH_DUMPLOADSEARCH.
4260 If initialized:
4261 If Vinstallation_directory is not nil (ie, running uninstalled):
4262 If installation-dir/lisp exists and not already a member,
4263 we must be running uninstalled. Reset the load-path
4264 to just installation-dir/lisp. (The default PATH_LOADSEARCH
4265 refers to the eventual installation directories. Since we
4266 are not yet installed, we should not use them, even if they exist.)
4267 If installation-dir/lisp does not exist, just add
4268 PATH_DUMPLOADSEARCH at the end instead.
4269 Add installation-dir/site-lisp (if !no_site_lisp, and exists
4270 and not already a member) at the front.
4271 If installation-dir != source-dir (ie running an uninstalled,
4272 out-of-tree build) AND install-dir/src/Makefile exists BUT
4273 install-dir/src/Makefile.in does NOT exist (this is a sanity
4274 check), then repeat the above steps for source-dir/lisp, site-lisp. */
4276 static Lisp_Object
4277 load_path_default (void)
4279 Lisp_Object lpath = Qnil;
4280 const char *normal;
4282 #ifdef CANNOT_DUMP
4283 #ifdef HAVE_NS
4284 const char *loadpath = ns_load_path ();
4285 #endif
4287 normal = PATH_LOADSEARCH;
4288 #ifdef HAVE_NS
4289 lpath = decode_env_path (0, loadpath ? loadpath : normal, 0);
4290 #else
4291 lpath = decode_env_path (0, normal, 0);
4292 #endif
4294 #else /* !CANNOT_DUMP */
4296 normal = NILP (Vpurify_flag) ? PATH_LOADSEARCH : PATH_DUMPLOADSEARCH;
4298 if (initialized)
4300 #ifdef HAVE_NS
4301 const char *loadpath = ns_load_path ();
4302 lpath = decode_env_path (0, loadpath ? loadpath : normal, 0);
4303 #else
4304 lpath = decode_env_path (0, normal, 0);
4305 #endif
4306 if (!NILP (Vinstallation_directory))
4308 Lisp_Object tem, tem1;
4310 /* Add to the path the lisp subdir of the installation
4311 dir, if it is accessible. Note: in out-of-tree builds,
4312 this directory is empty save for Makefile. */
4313 tem = Fexpand_file_name (build_string ("lisp"),
4314 Vinstallation_directory);
4315 tem1 = Ffile_accessible_directory_p (tem);
4316 if (!NILP (tem1))
4318 if (NILP (Fmember (tem, lpath)))
4320 /* We are running uninstalled. The default load-path
4321 points to the eventual installed lisp directories.
4322 We should not use those now, even if they exist,
4323 so start over from a clean slate. */
4324 lpath = list1 (tem);
4327 else
4328 /* That dir doesn't exist, so add the build-time
4329 Lisp dirs instead. */
4331 Lisp_Object dump_path =
4332 decode_env_path (0, PATH_DUMPLOADSEARCH, 0);
4333 lpath = nconc2 (lpath, dump_path);
4336 /* Add site-lisp under the installation dir, if it exists. */
4337 if (!no_site_lisp)
4339 tem = Fexpand_file_name (build_string ("site-lisp"),
4340 Vinstallation_directory);
4341 tem1 = Ffile_accessible_directory_p (tem);
4342 if (!NILP (tem1))
4344 if (NILP (Fmember (tem, lpath)))
4345 lpath = Fcons (tem, lpath);
4349 /* If Emacs was not built in the source directory,
4350 and it is run from where it was built, add to load-path
4351 the lisp and site-lisp dirs under that directory. */
4353 if (NILP (Fequal (Vinstallation_directory, Vsource_directory)))
4355 Lisp_Object tem2;
4357 tem = Fexpand_file_name (build_string ("src/Makefile"),
4358 Vinstallation_directory);
4359 tem1 = Ffile_exists_p (tem);
4361 /* Don't be fooled if they moved the entire source tree
4362 AFTER dumping Emacs. If the build directory is indeed
4363 different from the source dir, src/Makefile.in and
4364 src/Makefile will not be found together. */
4365 tem = Fexpand_file_name (build_string ("src/Makefile.in"),
4366 Vinstallation_directory);
4367 tem2 = Ffile_exists_p (tem);
4368 if (!NILP (tem1) && NILP (tem2))
4370 tem = Fexpand_file_name (build_string ("lisp"),
4371 Vsource_directory);
4373 if (NILP (Fmember (tem, lpath)))
4374 lpath = Fcons (tem, lpath);
4376 if (!no_site_lisp)
4378 tem = Fexpand_file_name (build_string ("site-lisp"),
4379 Vsource_directory);
4380 tem1 = Ffile_accessible_directory_p (tem);
4381 if (!NILP (tem1))
4383 if (NILP (Fmember (tem, lpath)))
4384 lpath = Fcons (tem, lpath);
4388 } /* Vinstallation_directory != Vsource_directory */
4390 } /* if Vinstallation_directory */
4392 else /* !initialized */
4394 /* NORMAL refers to PATH_DUMPLOADSEARCH, ie the lisp dir in the
4395 source directory. We used to add ../lisp (ie the lisp dir in
4396 the build directory) at the front here, but that should not
4397 be necessary, since in out of tree builds lisp/ is empty, save
4398 for Makefile. */
4399 lpath = decode_env_path (0, normal, 0);
4401 #endif /* !CANNOT_DUMP */
4403 return lpath;
4406 void
4407 init_lread (void)
4409 /* First, set Vload_path. */
4411 /* Ignore EMACSLOADPATH when dumping. */
4412 #ifdef CANNOT_DUMP
4413 bool use_loadpath = true;
4414 #else
4415 bool use_loadpath = NILP (Vpurify_flag);
4416 #endif
4418 if (use_loadpath && egetenv ("EMACSLOADPATH"))
4420 Vload_path = decode_env_path ("EMACSLOADPATH", 0, 1);
4422 /* Check (non-nil) user-supplied elements. */
4423 load_path_check (Vload_path);
4425 /* If no nils in the environment variable, use as-is.
4426 Otherwise, replace any nils with the default. */
4427 if (! NILP (Fmemq (Qnil, Vload_path)))
4429 Lisp_Object elem, elpath = Vload_path;
4430 Lisp_Object default_lpath = load_path_default ();
4432 /* Check defaults, before adding site-lisp. */
4433 load_path_check (default_lpath);
4435 /* Add the site-lisp directories to the front of the default. */
4436 if (!no_site_lisp && PATH_SITELOADSEARCH[0] != '\0')
4438 Lisp_Object sitelisp;
4439 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH, 0);
4440 if (! NILP (sitelisp))
4441 default_lpath = nconc2 (sitelisp, default_lpath);
4444 Vload_path = Qnil;
4446 /* Replace nils from EMACSLOADPATH by default. */
4447 while (CONSP (elpath))
4449 elem = XCAR (elpath);
4450 elpath = XCDR (elpath);
4451 Vload_path = CALLN (Fappend, Vload_path,
4452 NILP (elem) ? default_lpath : list1 (elem));
4454 } /* Fmemq (Qnil, Vload_path) */
4456 else
4458 Vload_path = load_path_default ();
4460 /* Check before adding site-lisp directories.
4461 The install should have created them, but they are not
4462 required, so no need to warn if they are absent.
4463 Or we might be running before installation. */
4464 load_path_check (Vload_path);
4466 /* Add the site-lisp directories at the front. */
4467 if (initialized && !no_site_lisp && PATH_SITELOADSEARCH[0] != '\0')
4469 Lisp_Object sitelisp;
4470 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH, 0);
4471 if (! NILP (sitelisp)) Vload_path = nconc2 (sitelisp, Vload_path);
4475 Vvalues = Qnil;
4477 load_in_progress = 0;
4478 Vload_file_name = Qnil;
4479 Vstandard_input = Qt;
4480 Vloads_in_progress = Qnil;
4483 /* Print a warning that directory intended for use USE and with name
4484 DIRNAME cannot be accessed. On entry, errno should correspond to
4485 the access failure. Print the warning on stderr and put it in
4486 *Messages*. */
4488 void
4489 dir_warning (char const *use, Lisp_Object dirname)
4491 static char const format[] = "Warning: %s '%s': %s\n";
4492 int access_errno = errno;
4493 fprintf (stderr, format, use, SSDATA (ENCODE_SYSTEM (dirname)),
4494 strerror (access_errno));
4496 /* Don't log the warning before we've initialized!! */
4497 if (initialized)
4499 char const *diagnostic = emacs_strerror (access_errno);
4500 USE_SAFE_ALLOCA;
4501 char *buffer = SAFE_ALLOCA (sizeof format - 3 * (sizeof "%s" - 1)
4502 + strlen (use) + SBYTES (dirname)
4503 + strlen (diagnostic));
4504 ptrdiff_t message_len = esprintf (buffer, format, use, SSDATA (dirname),
4505 diagnostic);
4506 message_dolog (buffer, message_len, 0, STRING_MULTIBYTE (dirname));
4507 SAFE_FREE ();
4511 void
4512 syms_of_lread (void)
4514 defsubr (&Sread);
4515 defsubr (&Sread_from_string);
4516 defsubr (&Sintern);
4517 defsubr (&Sintern_soft);
4518 defsubr (&Sunintern);
4519 defsubr (&Sget_load_suffixes);
4520 defsubr (&Sload);
4521 defsubr (&Seval_buffer);
4522 defsubr (&Seval_region);
4523 defsubr (&Sread_char);
4524 defsubr (&Sread_char_exclusive);
4525 defsubr (&Sread_event);
4526 defsubr (&Sget_file_char);
4527 defsubr (&Smapatoms);
4528 defsubr (&Slocate_file_internal);
4530 DEFVAR_LISP ("obarray", Vobarray,
4531 doc: /* Symbol table for use by `intern' and `read'.
4532 It is a vector whose length ought to be prime for best results.
4533 The vector's contents don't make sense if examined from Lisp programs;
4534 to find all the symbols in an obarray, use `mapatoms'. */);
4536 DEFVAR_LISP ("values", Vvalues,
4537 doc: /* List of values of all expressions which were read, evaluated and printed.
4538 Order is reverse chronological. */);
4539 XSYMBOL (intern ("values"))->declared_special = 0;
4541 DEFVAR_LISP ("standard-input", Vstandard_input,
4542 doc: /* Stream for read to get input from.
4543 See documentation of `read' for possible values. */);
4544 Vstandard_input = Qt;
4546 DEFVAR_LISP ("read-with-symbol-positions", Vread_with_symbol_positions,
4547 doc: /* If non-nil, add position of read symbols to `read-symbol-positions-list'.
4549 If this variable is a buffer, then only forms read from that buffer
4550 will be added to `read-symbol-positions-list'.
4551 If this variable is t, then all read forms will be added.
4552 The effect of all other values other than nil are not currently
4553 defined, although they may be in the future.
4555 The positions are relative to the last call to `read' or
4556 `read-from-string'. It is probably a bad idea to set this variable at
4557 the toplevel; bind it instead. */);
4558 Vread_with_symbol_positions = Qnil;
4560 DEFVAR_LISP ("read-symbol-positions-list", Vread_symbol_positions_list,
4561 doc: /* A list mapping read symbols to their positions.
4562 This variable is modified during calls to `read' or
4563 `read-from-string', but only when `read-with-symbol-positions' is
4564 non-nil.
4566 Each element of the list looks like (SYMBOL . CHAR-POSITION), where
4567 CHAR-POSITION is an integer giving the offset of that occurrence of the
4568 symbol from the position where `read' or `read-from-string' started.
4570 Note that a symbol will appear multiple times in this list, if it was
4571 read multiple times. The list is in the same order as the symbols
4572 were read in. */);
4573 Vread_symbol_positions_list = Qnil;
4575 DEFVAR_LISP ("read-circle", Vread_circle,
4576 doc: /* Non-nil means read recursive structures using #N= and #N# syntax. */);
4577 Vread_circle = Qt;
4579 DEFVAR_LISP ("load-path", Vload_path,
4580 doc: /* List of directories to search for files to load.
4581 Each element is a string (directory file name) or nil (meaning
4582 `default-directory').
4583 This list is consulted by the `require' function.
4584 Initialized during startup as described in Info node `(elisp)Library Search'.
4585 Use `directory-file-name' when adding items to this path. However, Lisp
4586 programs that process this list should tolerate directories both with
4587 and without trailing slashes. */);
4589 DEFVAR_LISP ("load-suffixes", Vload_suffixes,
4590 doc: /* List of suffixes for Emacs Lisp files and dynamic modules.
4591 This list includes suffixes for both compiled and source Emacs Lisp files.
4592 This list should not include the empty string.
4593 `load' and related functions try to append these suffixes, in order,
4594 to the specified file name if a suffix is allowed or required. */);
4595 #ifdef HAVE_MODULES
4596 Vload_suffixes = list3 (build_pure_c_string (".elc"),
4597 build_pure_c_string (".el"),
4598 build_pure_c_string (MODULES_SUFFIX));
4599 #else
4600 Vload_suffixes = list2 (build_pure_c_string (".elc"),
4601 build_pure_c_string (".el"));
4602 #endif
4603 DEFVAR_LISP ("module-file-suffix", Vmodule_file_suffix,
4604 doc: /* Suffix of loadable module file, or nil of modules are not supported. */);
4605 #ifdef HAVE_MODULES
4606 Vmodule_file_suffix = build_pure_c_string (MODULES_SUFFIX);
4607 #else
4608 Vmodule_file_suffix = Qnil;
4609 #endif
4610 DEFVAR_LISP ("load-file-rep-suffixes", Vload_file_rep_suffixes,
4611 doc: /* List of suffixes that indicate representations of \
4612 the same file.
4613 This list should normally start with the empty string.
4615 Enabling Auto Compression mode appends the suffixes in
4616 `jka-compr-load-suffixes' to this list and disabling Auto Compression
4617 mode removes them again. `load' and related functions use this list to
4618 determine whether they should look for compressed versions of a file
4619 and, if so, which suffixes they should try to append to the file name
4620 in order to do so. However, if you want to customize which suffixes
4621 the loading functions recognize as compression suffixes, you should
4622 customize `jka-compr-load-suffixes' rather than the present variable. */);
4623 Vload_file_rep_suffixes = list1 (empty_unibyte_string);
4625 DEFVAR_BOOL ("load-in-progress", load_in_progress,
4626 doc: /* Non-nil if inside of `load'. */);
4627 DEFSYM (Qload_in_progress, "load-in-progress");
4629 DEFVAR_LISP ("after-load-alist", Vafter_load_alist,
4630 doc: /* An alist of functions to be evalled when particular files are loaded.
4631 Each element looks like (REGEXP-OR-FEATURE FUNCS...).
4633 REGEXP-OR-FEATURE is either a regular expression to match file names, or
4634 a symbol (a feature name).
4636 When `load' is run and the file-name argument matches an element's
4637 REGEXP-OR-FEATURE, or when `provide' is run and provides the symbol
4638 REGEXP-OR-FEATURE, the FUNCS in the element are called.
4640 An error in FORMS does not undo the load, but does prevent execution of
4641 the rest of the FORMS. */);
4642 Vafter_load_alist = Qnil;
4644 DEFVAR_LISP ("load-history", Vload_history,
4645 doc: /* Alist mapping loaded file names to symbols and features.
4646 Each alist element should be a list (FILE-NAME ENTRIES...), where
4647 FILE-NAME is the name of a file that has been loaded into Emacs.
4648 The file name is absolute and true (i.e. it doesn't contain symlinks).
4649 As an exception, one of the alist elements may have FILE-NAME nil,
4650 for symbols and features not associated with any file.
4652 The remaining ENTRIES in the alist element describe the functions and
4653 variables defined in that file, the features provided, and the
4654 features required. Each entry has the form `(provide . FEATURE)',
4655 `(require . FEATURE)', `(defun . FUNCTION)', `(autoload . SYMBOL)',
4656 `(defface . SYMBOL)', or `(t . SYMBOL)'. Entries like `(t . SYMBOL)'
4657 may precede a `(defun . FUNCTION)' entry, and means that SYMBOL was an
4658 autoload before this file redefined it as a function. In addition,
4659 entries may also be single symbols, which means that SYMBOL was
4660 defined by `defvar' or `defconst'.
4662 During preloading, the file name recorded is relative to the main Lisp
4663 directory. These file names are converted to absolute at startup. */);
4664 Vload_history = Qnil;
4666 DEFVAR_LISP ("load-file-name", Vload_file_name,
4667 doc: /* Full name of file being loaded by `load'. */);
4668 Vload_file_name = Qnil;
4670 DEFVAR_LISP ("user-init-file", Vuser_init_file,
4671 doc: /* File name, including directory, of user's initialization file.
4672 If the file loaded had extension `.elc', and the corresponding source file
4673 exists, this variable contains the name of source file, suitable for use
4674 by functions like `custom-save-all' which edit the init file.
4675 While Emacs loads and evaluates the init file, value is the real name
4676 of the file, regardless of whether or not it has the `.elc' extension. */);
4677 Vuser_init_file = Qnil;
4679 DEFVAR_LISP ("current-load-list", Vcurrent_load_list,
4680 doc: /* Used for internal purposes by `load'. */);
4681 Vcurrent_load_list = Qnil;
4683 DEFVAR_LISP ("load-read-function", Vload_read_function,
4684 doc: /* Function used by `load' and `eval-region' for reading expressions.
4685 Called with a single argument (the stream from which to read).
4686 The default is to use the function `read'. */);
4687 DEFSYM (Qread, "read");
4688 Vload_read_function = Qread;
4690 DEFVAR_LISP ("load-source-file-function", Vload_source_file_function,
4691 doc: /* Function called in `load' to load an Emacs Lisp source file.
4692 The value should be a function for doing code conversion before
4693 reading a source file. It can also be nil, in which case loading is
4694 done without any code conversion.
4696 If the value is a function, it is called with four arguments,
4697 FULLNAME, FILE, NOERROR, NOMESSAGE. FULLNAME is the absolute name of
4698 the file to load, FILE is the non-absolute name (for messages etc.),
4699 and NOERROR and NOMESSAGE are the corresponding arguments passed to
4700 `load'. The function should return t if the file was loaded. */);
4701 Vload_source_file_function = Qnil;
4703 DEFVAR_BOOL ("load-force-doc-strings", load_force_doc_strings,
4704 doc: /* Non-nil means `load' should force-load all dynamic doc strings.
4705 This is useful when the file being loaded is a temporary copy. */);
4706 load_force_doc_strings = 0;
4708 DEFVAR_BOOL ("load-convert-to-unibyte", load_convert_to_unibyte,
4709 doc: /* Non-nil means `read' converts strings to unibyte whenever possible.
4710 This is normally bound by `load' and `eval-buffer' to control `read',
4711 and is not meant for users to change. */);
4712 load_convert_to_unibyte = 0;
4714 DEFVAR_LISP ("source-directory", Vsource_directory,
4715 doc: /* Directory in which Emacs sources were found when Emacs was built.
4716 You cannot count on them to still be there! */);
4717 Vsource_directory
4718 = Fexpand_file_name (build_string ("../"),
4719 Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0)));
4721 DEFVAR_LISP ("preloaded-file-list", Vpreloaded_file_list,
4722 doc: /* List of files that were preloaded (when dumping Emacs). */);
4723 Vpreloaded_file_list = Qnil;
4725 DEFVAR_LISP ("byte-boolean-vars", Vbyte_boolean_vars,
4726 doc: /* List of all DEFVAR_BOOL variables, used by the byte code optimizer. */);
4727 Vbyte_boolean_vars = Qnil;
4729 DEFVAR_BOOL ("load-dangerous-libraries", load_dangerous_libraries,
4730 doc: /* Non-nil means load dangerous compiled Lisp files.
4731 Some versions of XEmacs use different byte codes than Emacs. These
4732 incompatible byte codes can make Emacs crash when it tries to execute
4733 them. */);
4734 load_dangerous_libraries = 0;
4736 DEFVAR_BOOL ("force-load-messages", force_load_messages,
4737 doc: /* Non-nil means force printing messages when loading Lisp files.
4738 This overrides the value of the NOMESSAGE argument to `load'. */);
4739 force_load_messages = 0;
4741 DEFVAR_LISP ("bytecomp-version-regexp", Vbytecomp_version_regexp,
4742 doc: /* Regular expression matching safe to load compiled Lisp files.
4743 When Emacs loads a compiled Lisp file, it reads the first 512 bytes
4744 from the file, and matches them against this regular expression.
4745 When the regular expression matches, the file is considered to be safe
4746 to load. See also `load-dangerous-libraries'. */);
4747 Vbytecomp_version_regexp
4748 = build_pure_c_string ("^;;;.\\(in Emacs version\\|bytecomp version FSF\\)");
4750 DEFSYM (Qlexical_binding, "lexical-binding");
4751 DEFVAR_LISP ("lexical-binding", Vlexical_binding,
4752 doc: /* Whether to use lexical binding when evaluating code.
4753 Non-nil means that the code in the current buffer should be evaluated
4754 with lexical binding.
4755 This variable is automatically set from the file variables of an
4756 interpreted Lisp file read using `load'. Unlike other file local
4757 variables, this must be set in the first line of a file. */);
4758 Vlexical_binding = Qnil;
4759 Fmake_variable_buffer_local (Qlexical_binding);
4761 DEFVAR_LISP ("eval-buffer-list", Veval_buffer_list,
4762 doc: /* List of buffers being read from by calls to `eval-buffer' and `eval-region'. */);
4763 Veval_buffer_list = Qnil;
4765 DEFVAR_LISP ("old-style-backquotes", Vold_style_backquotes,
4766 doc: /* Set to non-nil when `read' encounters an old-style backquote. */);
4767 Vold_style_backquotes = Qnil;
4768 DEFSYM (Qold_style_backquotes, "old-style-backquotes");
4770 DEFVAR_BOOL ("load-prefer-newer", load_prefer_newer,
4771 doc: /* Non-nil means `load' prefers the newest version of a file.
4772 This applies when a filename suffix is not explicitly specified and
4773 `load' is trying various possible suffixes (see `load-suffixes' and
4774 `load-file-rep-suffixes'). Normally, it stops at the first file
4775 that exists unless you explicitly specify one or the other. If this
4776 option is non-nil, it checks all suffixes and uses whichever file is
4777 newest.
4778 Note that if you customize this, obviously it will not affect files
4779 that are loaded before your customizations are read! */);
4780 load_prefer_newer = 0;
4782 /* Vsource_directory was initialized in init_lread. */
4784 DEFSYM (Qcurrent_load_list, "current-load-list");
4785 DEFSYM (Qstandard_input, "standard-input");
4786 DEFSYM (Qread_char, "read-char");
4787 DEFSYM (Qget_file_char, "get-file-char");
4789 /* Used instead of Qget_file_char while loading *.elc files compiled
4790 by Emacs 21 or older. */
4791 DEFSYM (Qget_emacs_mule_file_char, "get-emacs-mule-file-char");
4793 DEFSYM (Qload_force_doc_strings, "load-force-doc-strings");
4795 DEFSYM (Qbackquote, "`");
4796 DEFSYM (Qcomma, ",");
4797 DEFSYM (Qcomma_at, ",@");
4798 DEFSYM (Qcomma_dot, ",.");
4800 DEFSYM (Qinhibit_file_name_operation, "inhibit-file-name-operation");
4801 DEFSYM (Qascii_character, "ascii-character");
4802 DEFSYM (Qfunction, "function");
4803 DEFSYM (Qload, "load");
4804 DEFSYM (Qload_file_name, "load-file-name");
4805 DEFSYM (Qeval_buffer_list, "eval-buffer-list");
4806 DEFSYM (Qfile_truename, "file-truename");
4807 DEFSYM (Qdir_ok, "dir-ok");
4808 DEFSYM (Qdo_after_load_evaluation, "do-after-load-evaluation");
4810 staticpro (&read_objects);
4811 read_objects = Qnil;
4812 staticpro (&seen_list);
4813 seen_list = Qnil;
4815 Vloads_in_progress = Qnil;
4816 staticpro (&Vloads_in_progress);
4818 DEFSYM (Qhash_table, "hash-table");
4819 DEFSYM (Qdata, "data");
4820 DEFSYM (Qtest, "test");
4821 DEFSYM (Qsize, "size");
4822 DEFSYM (Qweakness, "weakness");
4823 DEFSYM (Qrehash_size, "rehash-size");
4824 DEFSYM (Qrehash_threshold, "rehash-threshold");
4826 DEFSYM (Qchar_from_name, "char-from-name");