Weaken test conditions in filenotify-tests.el
[emacs.git] / src / lread.c
blob9f804ac319412dd7bc38b097b15205388f6e6a06
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 <epaths.h>
40 #include "commands.h"
41 #include "keyboard.h"
42 #include "systime.h"
43 #include "termhooks.h"
44 #include "blockinput.h"
45 #include <c-ctype.h>
47 #ifdef MSDOS
48 #include "msdos.h"
49 #if __DJGPP__ == 2 && __DJGPP_MINOR__ < 5
50 # define INFINITY __builtin_inf()
51 # define NAN __builtin_nan("")
52 #endif
53 #endif
55 #ifdef HAVE_NS
56 #include "nsterm.h"
57 #endif
59 #include <unistd.h>
61 #ifdef HAVE_SETLOCALE
62 #include <locale.h>
63 #endif /* HAVE_SETLOCALE */
65 #include <fcntl.h>
67 #ifdef HAVE_FSEEKO
68 #define file_offset off_t
69 #define file_tell ftello
70 #else
71 #define file_offset long
72 #define file_tell ftell
73 #endif
75 /* The association list of objects read with the #n=object form.
76 Each member of the list has the form (n . object), and is used to
77 look up the object for the corresponding #n# construct.
78 It must be set to nil before all top-level calls to read0. */
79 static Lisp_Object read_objects;
81 /* File for get_file_char to read from. Use by load. */
82 static FILE *instream;
84 /* For use within read-from-string (this reader is non-reentrant!!) */
85 static ptrdiff_t read_from_string_index;
86 static ptrdiff_t read_from_string_index_byte;
87 static ptrdiff_t read_from_string_limit;
89 /* Number of characters read in the current call to Fread or
90 Fread_from_string. */
91 static EMACS_INT readchar_count;
93 /* This contains the last string skipped with #@. */
94 static char *saved_doc_string;
95 /* Length of buffer allocated in saved_doc_string. */
96 static ptrdiff_t saved_doc_string_size;
97 /* Length of actual data in saved_doc_string. */
98 static ptrdiff_t saved_doc_string_length;
99 /* This is the file position that string came from. */
100 static file_offset saved_doc_string_position;
102 /* This contains the previous string skipped with #@.
103 We copy it from saved_doc_string when a new string
104 is put in saved_doc_string. */
105 static char *prev_saved_doc_string;
106 /* Length of buffer allocated in prev_saved_doc_string. */
107 static ptrdiff_t prev_saved_doc_string_size;
108 /* Length of actual data in prev_saved_doc_string. */
109 static ptrdiff_t prev_saved_doc_string_length;
110 /* This is the file position that string came from. */
111 static file_offset prev_saved_doc_string_position;
113 /* True means inside a new-style backquote
114 with no surrounding parentheses.
115 Fread initializes this to false, so we need not specbind it
116 or worry about what happens to it when there is an error. */
117 static bool new_backquote_flag;
119 /* A list of file names for files being loaded in Fload. Used to
120 check for recursive loads. */
122 static Lisp_Object Vloads_in_progress;
124 static int read_emacs_mule_char (int, int (*) (int, Lisp_Object),
125 Lisp_Object);
127 static void readevalloop (Lisp_Object, FILE *, Lisp_Object, bool,
128 Lisp_Object, Lisp_Object,
129 Lisp_Object, Lisp_Object);
131 /* Functions that read one byte from the current source READCHARFUN
132 or unreads one byte. If the integer argument C is -1, it returns
133 one read byte, or -1 when there's no more byte in the source. If C
134 is 0 or positive, it unreads C, and the return value is not
135 interesting. */
137 static int readbyte_for_lambda (int, Lisp_Object);
138 static int readbyte_from_file (int, Lisp_Object);
139 static int readbyte_from_string (int, Lisp_Object);
141 /* Handle unreading and rereading of characters.
142 Write READCHAR to read a character,
143 UNREAD(c) to unread c to be read again.
145 These macros correctly read/unread multibyte characters. */
147 #define READCHAR readchar (readcharfun, NULL)
148 #define UNREAD(c) unreadchar (readcharfun, c)
150 /* Same as READCHAR but set *MULTIBYTE to the multibyteness of the source. */
151 #define READCHAR_REPORT_MULTIBYTE(multibyte) readchar (readcharfun, multibyte)
153 /* When READCHARFUN is Qget_file_char, Qget_emacs_mule_file_char,
154 Qlambda, or a cons, we use this to keep an unread character because
155 a file stream can't handle multibyte-char unreading. The value -1
156 means that there's no unread character. */
157 static int unread_char;
159 static int
160 readchar (Lisp_Object readcharfun, bool *multibyte)
162 Lisp_Object tem;
163 register int c;
164 int (*readbyte) (int, Lisp_Object);
165 unsigned char buf[MAX_MULTIBYTE_LENGTH];
166 int i, len;
167 bool emacs_mule_encoding = 0;
169 if (multibyte)
170 *multibyte = 0;
172 readchar_count++;
174 if (BUFFERP (readcharfun))
176 register struct buffer *inbuffer = XBUFFER (readcharfun);
178 ptrdiff_t pt_byte = BUF_PT_BYTE (inbuffer);
180 if (! BUFFER_LIVE_P (inbuffer))
181 return -1;
183 if (pt_byte >= BUF_ZV_BYTE (inbuffer))
184 return -1;
186 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
188 /* Fetch the character code from the buffer. */
189 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, pt_byte);
190 BUF_INC_POS (inbuffer, pt_byte);
191 c = STRING_CHAR (p);
192 if (multibyte)
193 *multibyte = 1;
195 else
197 c = BUF_FETCH_BYTE (inbuffer, pt_byte);
198 if (! ASCII_CHAR_P (c))
199 c = BYTE8_TO_CHAR (c);
200 pt_byte++;
202 SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
204 return c;
206 if (MARKERP (readcharfun))
208 register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
210 ptrdiff_t bytepos = marker_byte_position (readcharfun);
212 if (bytepos >= BUF_ZV_BYTE (inbuffer))
213 return -1;
215 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
217 /* Fetch the character code from the buffer. */
218 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, bytepos);
219 BUF_INC_POS (inbuffer, bytepos);
220 c = STRING_CHAR (p);
221 if (multibyte)
222 *multibyte = 1;
224 else
226 c = BUF_FETCH_BYTE (inbuffer, bytepos);
227 if (! ASCII_CHAR_P (c))
228 c = BYTE8_TO_CHAR (c);
229 bytepos++;
232 XMARKER (readcharfun)->bytepos = bytepos;
233 XMARKER (readcharfun)->charpos++;
235 return c;
238 if (EQ (readcharfun, Qlambda))
240 readbyte = readbyte_for_lambda;
241 goto read_multibyte;
244 if (EQ (readcharfun, Qget_file_char))
246 readbyte = readbyte_from_file;
247 goto read_multibyte;
250 if (STRINGP (readcharfun))
252 if (read_from_string_index >= read_from_string_limit)
253 c = -1;
254 else if (STRING_MULTIBYTE (readcharfun))
256 if (multibyte)
257 *multibyte = 1;
258 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, readcharfun,
259 read_from_string_index,
260 read_from_string_index_byte);
262 else
264 c = SREF (readcharfun, read_from_string_index_byte);
265 read_from_string_index++;
266 read_from_string_index_byte++;
268 return c;
271 if (CONSP (readcharfun) && STRINGP (XCAR (readcharfun)))
273 /* This is the case that read_vector is reading from a unibyte
274 string that contains a byte sequence previously skipped
275 because of #@NUMBER. The car part of readcharfun is that
276 string, and the cdr part is a value of readcharfun given to
277 read_vector. */
278 readbyte = readbyte_from_string;
279 if (EQ (XCDR (readcharfun), Qget_emacs_mule_file_char))
280 emacs_mule_encoding = 1;
281 goto read_multibyte;
284 if (EQ (readcharfun, Qget_emacs_mule_file_char))
286 readbyte = readbyte_from_file;
287 emacs_mule_encoding = 1;
288 goto read_multibyte;
291 tem = call0 (readcharfun);
293 if (NILP (tem))
294 return -1;
295 return XINT (tem);
297 read_multibyte:
298 if (unread_char >= 0)
300 c = unread_char;
301 unread_char = -1;
302 return c;
304 c = (*readbyte) (-1, readcharfun);
305 if (c < 0)
306 return c;
307 if (multibyte)
308 *multibyte = 1;
309 if (ASCII_CHAR_P (c))
310 return c;
311 if (emacs_mule_encoding)
312 return read_emacs_mule_char (c, readbyte, readcharfun);
313 i = 0;
314 buf[i++] = c;
315 len = BYTES_BY_CHAR_HEAD (c);
316 while (i < len)
318 c = (*readbyte) (-1, readcharfun);
319 if (c < 0 || ! TRAILING_CODE_P (c))
321 while (--i > 1)
322 (*readbyte) (buf[i], readcharfun);
323 return BYTE8_TO_CHAR (buf[0]);
325 buf[i++] = c;
327 return STRING_CHAR (buf);
330 #define FROM_FILE_P(readcharfun) \
331 (EQ (readcharfun, Qget_file_char) \
332 || EQ (readcharfun, Qget_emacs_mule_file_char))
334 static void
335 skip_dyn_bytes (Lisp_Object readcharfun, ptrdiff_t n)
337 if (FROM_FILE_P (readcharfun))
339 block_input (); /* FIXME: Not sure if it's needed. */
340 fseek (instream, n, SEEK_CUR);
341 unblock_input ();
343 else
344 { /* We're not reading directly from a file. In that case, it's difficult
345 to reliably count bytes, since these are usually meant for the file's
346 encoding, whereas we're now typically in the internal encoding.
347 But luckily, skip_dyn_bytes is used to skip over a single
348 dynamic-docstring (or dynamic byte-code) which is always quoted such
349 that \037 is the final char. */
350 int c;
351 do {
352 c = READCHAR;
353 } while (c >= 0 && c != '\037');
357 static void
358 skip_dyn_eof (Lisp_Object readcharfun)
360 if (FROM_FILE_P (readcharfun))
362 block_input (); /* FIXME: Not sure if it's needed. */
363 fseek (instream, 0, SEEK_END);
364 unblock_input ();
366 else
367 while (READCHAR >= 0);
370 /* Unread the character C in the way appropriate for the stream READCHARFUN.
371 If the stream is a user function, call it with the char as argument. */
373 static void
374 unreadchar (Lisp_Object readcharfun, int c)
376 readchar_count--;
377 if (c == -1)
378 /* Don't back up the pointer if we're unreading the end-of-input mark,
379 since readchar didn't advance it when we read it. */
381 else if (BUFFERP (readcharfun))
383 struct buffer *b = XBUFFER (readcharfun);
384 ptrdiff_t charpos = BUF_PT (b);
385 ptrdiff_t bytepos = BUF_PT_BYTE (b);
387 if (! NILP (BVAR (b, enable_multibyte_characters)))
388 BUF_DEC_POS (b, bytepos);
389 else
390 bytepos--;
392 SET_BUF_PT_BOTH (b, charpos - 1, bytepos);
394 else if (MARKERP (readcharfun))
396 struct buffer *b = XMARKER (readcharfun)->buffer;
397 ptrdiff_t bytepos = XMARKER (readcharfun)->bytepos;
399 XMARKER (readcharfun)->charpos--;
400 if (! NILP (BVAR (b, enable_multibyte_characters)))
401 BUF_DEC_POS (b, bytepos);
402 else
403 bytepos--;
405 XMARKER (readcharfun)->bytepos = bytepos;
407 else if (STRINGP (readcharfun))
409 read_from_string_index--;
410 read_from_string_index_byte
411 = string_char_to_byte (readcharfun, read_from_string_index);
413 else if (CONSP (readcharfun) && STRINGP (XCAR (readcharfun)))
415 unread_char = c;
417 else if (EQ (readcharfun, Qlambda))
419 unread_char = c;
421 else if (FROM_FILE_P (readcharfun))
423 unread_char = c;
425 else
426 call1 (readcharfun, make_number (c));
429 static int
430 readbyte_for_lambda (int c, Lisp_Object readcharfun)
432 return read_bytecode_char (c >= 0);
436 static int
437 readbyte_from_file (int c, Lisp_Object readcharfun)
439 if (c >= 0)
441 block_input ();
442 ungetc (c, instream);
443 unblock_input ();
444 return 0;
447 block_input ();
448 c = getc (instream);
450 /* Interrupted reads have been observed while reading over the network. */
451 while (c == EOF && ferror (instream) && errno == EINTR)
453 unblock_input ();
454 QUIT;
455 block_input ();
456 clearerr (instream);
457 c = getc (instream);
460 unblock_input ();
462 return (c == EOF ? -1 : c);
465 static int
466 readbyte_from_string (int c, Lisp_Object readcharfun)
468 Lisp_Object string = XCAR (readcharfun);
470 if (c >= 0)
472 read_from_string_index--;
473 read_from_string_index_byte
474 = string_char_to_byte (string, read_from_string_index);
477 if (read_from_string_index >= read_from_string_limit)
478 c = -1;
479 else
480 FETCH_STRING_CHAR_ADVANCE (c, string,
481 read_from_string_index,
482 read_from_string_index_byte);
483 return c;
487 /* Read one non-ASCII character from INSTREAM. The character is
488 encoded in `emacs-mule' and the first byte is already read in
489 C. */
491 static int
492 read_emacs_mule_char (int c, int (*readbyte) (int, Lisp_Object), Lisp_Object readcharfun)
494 /* Emacs-mule coding uses at most 4-byte for one character. */
495 unsigned char buf[4];
496 int len = emacs_mule_bytes[c];
497 struct charset *charset;
498 int i;
499 unsigned code;
501 if (len == 1)
502 /* C is not a valid leading-code of `emacs-mule'. */
503 return BYTE8_TO_CHAR (c);
505 i = 0;
506 buf[i++] = c;
507 while (i < len)
509 c = (*readbyte) (-1, readcharfun);
510 if (c < 0xA0)
512 while (--i > 1)
513 (*readbyte) (buf[i], readcharfun);
514 return BYTE8_TO_CHAR (buf[0]);
516 buf[i++] = c;
519 if (len == 2)
521 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
522 code = buf[1] & 0x7F;
524 else if (len == 3)
526 if (buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_11
527 || buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_12)
529 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
530 code = buf[2] & 0x7F;
532 else
534 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
535 code = ((buf[1] << 8) | buf[2]) & 0x7F7F;
538 else
540 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
541 code = ((buf[2] << 8) | buf[3]) & 0x7F7F;
543 c = DECODE_CHAR (charset, code);
544 if (c < 0)
545 Fsignal (Qinvalid_read_syntax,
546 list1 (build_string ("invalid multibyte form")));
547 return c;
551 static Lisp_Object read_internal_start (Lisp_Object, Lisp_Object,
552 Lisp_Object);
553 static Lisp_Object read0 (Lisp_Object);
554 static Lisp_Object read1 (Lisp_Object, int *, bool);
556 static Lisp_Object read_list (bool, Lisp_Object);
557 static Lisp_Object read_vector (Lisp_Object, bool);
559 static Lisp_Object substitute_object_recurse (Lisp_Object, Lisp_Object,
560 Lisp_Object);
561 static void substitute_object_in_subtree (Lisp_Object,
562 Lisp_Object);
563 static void substitute_in_interval (INTERVAL, Lisp_Object);
566 /* Get a character from the tty. */
568 /* Read input events until we get one that's acceptable for our purposes.
570 If NO_SWITCH_FRAME, switch-frame events are stashed
571 until we get a character we like, and then stuffed into
572 unread_switch_frame.
574 If ASCII_REQUIRED, check function key events to see
575 if the unmodified version of the symbol has a Qascii_character
576 property, and use that character, if present.
578 If ERROR_NONASCII, signal an error if the input we
579 get isn't an ASCII character with modifiers. If it's false but
580 ASCII_REQUIRED is true, just re-read until we get an ASCII
581 character.
583 If INPUT_METHOD, invoke the current input method
584 if the character warrants that.
586 If SECONDS is a number, wait that many seconds for input, and
587 return Qnil if no input arrives within that time. */
589 static Lisp_Object
590 read_filtered_event (bool no_switch_frame, bool ascii_required,
591 bool error_nonascii, bool input_method, Lisp_Object seconds)
593 Lisp_Object val, delayed_switch_frame;
594 struct timespec end_time;
596 #ifdef HAVE_WINDOW_SYSTEM
597 if (display_hourglass_p)
598 cancel_hourglass ();
599 #endif
601 delayed_switch_frame = Qnil;
603 /* Compute timeout. */
604 if (NUMBERP (seconds))
606 double duration = extract_float (seconds);
607 struct timespec wait_time = dtotimespec (duration);
608 end_time = timespec_add (current_timespec (), wait_time);
611 /* Read until we get an acceptable event. */
612 retry:
614 val = read_char (0, Qnil, (input_method ? Qnil : Qt), 0,
615 NUMBERP (seconds) ? &end_time : NULL);
616 while (INTEGERP (val) && XINT (val) == -2); /* wrong_kboard_jmpbuf */
618 if (BUFFERP (val))
619 goto retry;
621 /* `switch-frame' events are put off until after the next ASCII
622 character. This is better than signaling an error just because
623 the last characters were typed to a separate minibuffer frame,
624 for example. Eventually, some code which can deal with
625 switch-frame events will read it and process it. */
626 if (no_switch_frame
627 && EVENT_HAS_PARAMETERS (val)
628 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (val)), Qswitch_frame))
630 delayed_switch_frame = val;
631 goto retry;
634 if (ascii_required && !(NUMBERP (seconds) && NILP (val)))
636 /* Convert certain symbols to their ASCII equivalents. */
637 if (SYMBOLP (val))
639 Lisp_Object tem, tem1;
640 tem = Fget (val, Qevent_symbol_element_mask);
641 if (!NILP (tem))
643 tem1 = Fget (Fcar (tem), Qascii_character);
644 /* Merge this symbol's modifier bits
645 with the ASCII equivalent of its basic code. */
646 if (!NILP (tem1))
647 XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
651 /* If we don't have a character now, deal with it appropriately. */
652 if (!INTEGERP (val))
654 if (error_nonascii)
656 Vunread_command_events = list1 (val);
657 error ("Non-character input-event");
659 else
660 goto retry;
664 if (! NILP (delayed_switch_frame))
665 unread_switch_frame = delayed_switch_frame;
667 #if 0
669 #ifdef HAVE_WINDOW_SYSTEM
670 if (display_hourglass_p)
671 start_hourglass ();
672 #endif
674 #endif
676 return val;
679 DEFUN ("read-char", Fread_char, Sread_char, 0, 3, 0,
680 doc: /* Read a character from the command input (keyboard or macro).
681 It is returned as a number.
682 If the character has modifiers, they are resolved and reflected to the
683 character code if possible (e.g. C-SPC -> 0).
685 If the user generates an event which is not a character (i.e. a mouse
686 click or function key event), `read-char' signals an error. As an
687 exception, switch-frame events are put off until non-character events
688 can be read.
689 If you want to read non-character events, or ignore them, call
690 `read-event' or `read-char-exclusive' instead.
692 If the optional argument PROMPT is non-nil, display that as a prompt.
693 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
694 input method is turned on in the current buffer, that input method
695 is used for reading a character.
696 If the optional argument SECONDS is non-nil, it should be a number
697 specifying the maximum number of seconds to wait for input. If no
698 input arrives in that time, return nil. SECONDS may be a
699 floating-point value. */)
700 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
702 Lisp_Object val;
704 if (! NILP (prompt))
705 message_with_string ("%s", prompt, 0);
706 val = read_filtered_event (1, 1, 1, ! NILP (inherit_input_method), seconds);
708 return (NILP (val) ? Qnil
709 : make_number (char_resolve_modifier_mask (XINT (val))));
712 DEFUN ("read-event", Fread_event, Sread_event, 0, 3, 0,
713 doc: /* Read an event object from the input stream.
714 If the optional argument PROMPT is non-nil, display that as a prompt.
715 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
716 input method is turned on in the current buffer, that input method
717 is used for reading a character.
718 If the optional argument SECONDS is non-nil, it should be a number
719 specifying the maximum number of seconds to wait for input. If no
720 input arrives in that time, return nil. SECONDS may be a
721 floating-point value. */)
722 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
724 if (! NILP (prompt))
725 message_with_string ("%s", prompt, 0);
726 return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method), seconds);
729 DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 3, 0,
730 doc: /* Read a character from the command input (keyboard or macro).
731 It is returned as a number. Non-character events are ignored.
732 If the character has modifiers, they are resolved and reflected to the
733 character code if possible (e.g. C-SPC -> 0).
735 If the optional argument PROMPT is non-nil, display that as a prompt.
736 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
737 input method is turned on in the current buffer, that input method
738 is used for reading a character.
739 If the optional argument SECONDS is non-nil, it should be a number
740 specifying the maximum number of seconds to wait for input. If no
741 input arrives in that time, return nil. SECONDS may be a
742 floating-point value. */)
743 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
745 Lisp_Object val;
747 if (! NILP (prompt))
748 message_with_string ("%s", prompt, 0);
750 val = read_filtered_event (1, 1, 0, ! NILP (inherit_input_method), seconds);
752 return (NILP (val) ? Qnil
753 : make_number (char_resolve_modifier_mask (XINT (val))));
756 DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
757 doc: /* Don't use this yourself. */)
758 (void)
760 register Lisp_Object val;
761 block_input ();
762 XSETINT (val, getc (instream));
763 unblock_input ();
764 return val;
770 /* Return true if the lisp code read using READCHARFUN defines a non-nil
771 `lexical-binding' file variable. After returning, the stream is
772 positioned following the first line, if it is a comment or #! line,
773 otherwise nothing is read. */
775 static bool
776 lisp_file_lexically_bound_p (Lisp_Object readcharfun)
778 int ch = READCHAR;
780 if (ch == '#')
782 ch = READCHAR;
783 if (ch != '!')
785 UNREAD (ch);
786 UNREAD ('#');
787 return 0;
789 while (ch != '\n' && ch != EOF)
790 ch = READCHAR;
791 if (ch == '\n') ch = READCHAR;
792 /* It is OK to leave the position after a #! line, since
793 that is what read1 does. */
796 if (ch != ';')
797 /* The first line isn't a comment, just give up. */
799 UNREAD (ch);
800 return 0;
802 else
803 /* Look for an appropriate file-variable in the first line. */
805 bool rv = 0;
806 enum {
807 NOMINAL, AFTER_FIRST_DASH, AFTER_ASTERIX
808 } beg_end_state = NOMINAL;
809 bool in_file_vars = 0;
811 #define UPDATE_BEG_END_STATE(ch) \
812 if (beg_end_state == NOMINAL) \
813 beg_end_state = (ch == '-' ? AFTER_FIRST_DASH : NOMINAL); \
814 else if (beg_end_state == AFTER_FIRST_DASH) \
815 beg_end_state = (ch == '*' ? AFTER_ASTERIX : NOMINAL); \
816 else if (beg_end_state == AFTER_ASTERIX) \
818 if (ch == '-') \
819 in_file_vars = !in_file_vars; \
820 beg_end_state = NOMINAL; \
823 /* Skip until we get to the file vars, if any. */
826 ch = READCHAR;
827 UPDATE_BEG_END_STATE (ch);
829 while (!in_file_vars && ch != '\n' && ch != EOF);
831 while (in_file_vars)
833 char var[100], val[100];
834 unsigned i;
836 ch = READCHAR;
838 /* Read a variable name. */
839 while (ch == ' ' || ch == '\t')
840 ch = READCHAR;
842 i = 0;
843 while (ch != ':' && ch != '\n' && ch != EOF && in_file_vars)
845 if (i < sizeof var - 1)
846 var[i++] = ch;
847 UPDATE_BEG_END_STATE (ch);
848 ch = READCHAR;
851 /* Stop scanning if no colon was found before end marker. */
852 if (!in_file_vars || ch == '\n' || ch == EOF)
853 break;
855 while (i > 0 && (var[i - 1] == ' ' || var[i - 1] == '\t'))
856 i--;
857 var[i] = '\0';
859 if (ch == ':')
861 /* Read a variable value. */
862 ch = READCHAR;
864 while (ch == ' ' || ch == '\t')
865 ch = READCHAR;
867 i = 0;
868 while (ch != ';' && ch != '\n' && ch != EOF && in_file_vars)
870 if (i < sizeof val - 1)
871 val[i++] = ch;
872 UPDATE_BEG_END_STATE (ch);
873 ch = READCHAR;
875 if (! in_file_vars)
876 /* The value was terminated by an end-marker, which remove. */
877 i -= 3;
878 while (i > 0 && (val[i - 1] == ' ' || val[i - 1] == '\t'))
879 i--;
880 val[i] = '\0';
882 if (strcmp (var, "lexical-binding") == 0)
883 /* This is it... */
885 rv = (strcmp (val, "nil") != 0);
886 break;
891 while (ch != '\n' && ch != EOF)
892 ch = READCHAR;
894 return rv;
898 /* Value is a version number of byte compiled code if the file
899 associated with file descriptor FD is a compiled Lisp file that's
900 safe to load. Only files compiled with Emacs are safe to load.
901 Files compiled with XEmacs can lead to a crash in Fbyte_code
902 because of an incompatible change in the byte compiler. */
904 static int
905 safe_to_load_version (int fd)
907 char buf[512];
908 int nbytes, i;
909 int version = 1;
911 /* Read the first few bytes from the file, and look for a line
912 specifying the byte compiler version used. */
913 nbytes = emacs_read (fd, buf, sizeof buf);
914 if (nbytes > 0)
916 /* Skip to the next newline, skipping over the initial `ELC'
917 with NUL bytes following it, but note the version. */
918 for (i = 0; i < nbytes && buf[i] != '\n'; ++i)
919 if (i == 4)
920 version = buf[i];
922 if (i >= nbytes
923 || fast_c_string_match_ignore_case (Vbytecomp_version_regexp,
924 buf + i, nbytes - i) < 0)
925 version = 0;
928 lseek (fd, 0, SEEK_SET);
929 return version;
933 /* Callback for record_unwind_protect. Restore the old load list OLD,
934 after loading a file successfully. */
936 static void
937 record_load_unwind (Lisp_Object old)
939 Vloads_in_progress = old;
942 /* This handler function is used via internal_condition_case_1. */
944 static Lisp_Object
945 load_error_handler (Lisp_Object data)
947 return Qnil;
950 static void
951 load_warn_old_style_backquotes (Lisp_Object file)
953 if (!NILP (Vold_style_backquotes))
955 AUTO_STRING (format, "Loading `%s': old-style backquotes detected!");
956 CALLN (Fmessage, format, file);
960 DEFUN ("get-load-suffixes", Fget_load_suffixes, Sget_load_suffixes, 0, 0, 0,
961 doc: /* Return the suffixes that `load' should try if a suffix is \
962 required.
963 This uses the variables `load-suffixes' and `load-file-rep-suffixes'. */)
964 (void)
966 Lisp_Object lst = Qnil, suffixes = Vload_suffixes, suffix, ext;
967 while (CONSP (suffixes))
969 Lisp_Object exts = Vload_file_rep_suffixes;
970 suffix = XCAR (suffixes);
971 suffixes = XCDR (suffixes);
972 while (CONSP (exts))
974 ext = XCAR (exts);
975 exts = XCDR (exts);
976 lst = Fcons (concat2 (suffix, ext), lst);
979 return Fnreverse (lst);
982 /* Returns true if STRING ends with SUFFIX */
983 static bool
984 suffix_p (Lisp_Object string, const char *suffix)
986 ptrdiff_t suffix_len = strlen (suffix);
987 ptrdiff_t string_len = SBYTES (string);
989 return string_len >= suffix_len && !strcmp (SSDATA (string) + string_len - suffix_len, suffix);
992 DEFUN ("load", Fload, Sload, 1, 5, 0,
993 doc: /* Execute a file of Lisp code named FILE.
994 First try FILE with `.elc' appended, then try with `.el', then try
995 with a system-dependent suffix of dynamic modules (see `load-suffixes'),
996 then try FILE unmodified (the exact suffixes in the exact order are
997 determined by `load-suffixes'). Environment variable references in
998 FILE are replaced with their values by calling `substitute-in-file-name'.
999 This function searches the directories in `load-path'.
1001 If optional second arg NOERROR is non-nil,
1002 report no error if FILE doesn't exist.
1003 Print messages at start and end of loading unless
1004 optional third arg NOMESSAGE is non-nil (but `force-load-messages'
1005 overrides that).
1006 If optional fourth arg NOSUFFIX is non-nil, don't try adding
1007 suffixes to the specified name FILE.
1008 If optional fifth arg MUST-SUFFIX is non-nil, insist on
1009 the suffix `.elc' or `.el' or the module suffix; don't accept just
1010 FILE unless it ends in one of those suffixes or includes a directory name.
1012 If NOSUFFIX is nil, then if a file could not be found, try looking for
1013 a different representation of the file by adding non-empty suffixes to
1014 its name, before trying another file. Emacs uses this feature to find
1015 compressed versions of files when Auto Compression mode is enabled.
1016 If NOSUFFIX is non-nil, disable this feature.
1018 The suffixes that this function tries out, when NOSUFFIX is nil, are
1019 given by the return value of `get-load-suffixes' and the values listed
1020 in `load-file-rep-suffixes'. If MUST-SUFFIX is non-nil, only the
1021 return value of `get-load-suffixes' is used, i.e. the file name is
1022 required to have a non-empty suffix.
1024 When searching suffixes, this function normally stops at the first
1025 one that exists. If the option `load-prefer-newer' is non-nil,
1026 however, it tries all suffixes, and uses whichever file is the newest.
1028 Loading a file records its definitions, and its `provide' and
1029 `require' calls, in an element of `load-history' whose
1030 car is the file name loaded. See `load-history'.
1032 While the file is in the process of being loaded, the variable
1033 `load-in-progress' is non-nil and the variable `load-file-name'
1034 is bound to the file's name.
1036 Return t if the file exists and loads successfully. */)
1037 (Lisp_Object file, Lisp_Object noerror, Lisp_Object nomessage,
1038 Lisp_Object nosuffix, Lisp_Object must_suffix)
1040 FILE *stream;
1041 int fd;
1042 int fd_index UNINIT;
1043 ptrdiff_t count = SPECPDL_INDEX ();
1044 Lisp_Object found, efound, hist_file_name;
1045 /* True means we printed the ".el is newer" message. */
1046 bool newer = 0;
1047 /* True means we are loading a compiled file. */
1048 bool compiled = 0;
1049 Lisp_Object handler;
1050 bool safe_p = 1;
1051 const char *fmode = "r" FOPEN_TEXT;
1052 int version;
1054 CHECK_STRING (file);
1056 /* If file name is magic, call the handler. */
1057 /* This shouldn't be necessary any more now that `openp' handles it right.
1058 handler = Ffind_file_name_handler (file, Qload);
1059 if (!NILP (handler))
1060 return call5 (handler, Qload, file, noerror, nomessage, nosuffix); */
1062 /* The presence of this call is the result of a historical accident:
1063 it used to be in every file-operation and when it got removed
1064 everywhere, it accidentally stayed here. Since then, enough people
1065 supposedly have things like (load "$PROJECT/foo.el") in their .emacs
1066 that it seemed risky to remove. */
1067 if (! NILP (noerror))
1069 file = internal_condition_case_1 (Fsubstitute_in_file_name, file,
1070 Qt, load_error_handler);
1071 if (NILP (file))
1072 return Qnil;
1074 else
1075 file = Fsubstitute_in_file_name (file);
1077 /* Avoid weird lossage with null string as arg,
1078 since it would try to load a directory as a Lisp file. */
1079 if (SCHARS (file) == 0)
1081 fd = -1;
1082 errno = ENOENT;
1084 else
1086 Lisp_Object suffixes;
1087 found = Qnil;
1089 if (! NILP (must_suffix))
1091 /* Don't insist on adding a suffix if FILE already ends with one. */
1092 if (suffix_p (file, ".el")
1093 || suffix_p (file, ".elc")
1094 #ifdef HAVE_MODULES
1095 || suffix_p (file, MODULES_SUFFIX)
1096 #endif
1098 must_suffix = Qnil;
1099 /* Don't insist on adding a suffix
1100 if the argument includes a directory name. */
1101 else if (! NILP (Ffile_name_directory (file)))
1102 must_suffix = Qnil;
1105 if (!NILP (nosuffix))
1106 suffixes = Qnil;
1107 else
1109 suffixes = Fget_load_suffixes ();
1110 if (NILP (must_suffix))
1111 suffixes = CALLN (Fappend, suffixes, Vload_file_rep_suffixes);
1114 fd = openp (Vload_path, file, suffixes, &found, Qnil, load_prefer_newer);
1117 if (fd == -1)
1119 if (NILP (noerror))
1120 report_file_error ("Cannot open load file", file);
1121 return Qnil;
1124 /* Tell startup.el whether or not we found the user's init file. */
1125 if (EQ (Qt, Vuser_init_file))
1126 Vuser_init_file = found;
1128 /* If FD is -2, that means openp found a magic file. */
1129 if (fd == -2)
1131 if (NILP (Fequal (found, file)))
1132 /* If FOUND is a different file name from FILE,
1133 find its handler even if we have already inhibited
1134 the `load' operation on FILE. */
1135 handler = Ffind_file_name_handler (found, Qt);
1136 else
1137 handler = Ffind_file_name_handler (found, Qload);
1138 if (! NILP (handler))
1139 return call5 (handler, Qload, found, noerror, nomessage, Qt);
1140 #ifdef DOS_NT
1141 /* Tramp has to deal with semi-broken packages that prepend
1142 drive letters to remote files. For that reason, Tramp
1143 catches file operations that test for file existence, which
1144 makes openp think X:/foo.elc files are remote. However,
1145 Tramp does not catch `load' operations for such files, so we
1146 end up with a nil as the `load' handler above. If we would
1147 continue with fd = -2, we will behave wrongly, and in
1148 particular try reading a .elc file in the "rt" mode instead
1149 of "rb". See bug #9311 for the results. To work around
1150 this, we try to open the file locally, and go with that if it
1151 succeeds. */
1152 fd = emacs_open (SSDATA (ENCODE_FILE (found)), O_RDONLY, 0);
1153 if (fd == -1)
1154 fd = -2;
1155 #endif
1158 if (0 <= fd)
1160 fd_index = SPECPDL_INDEX ();
1161 record_unwind_protect_int (close_file_unwind, fd);
1164 #ifdef HAVE_MODULES
1165 if (suffix_p (found, MODULES_SUFFIX))
1166 return unbind_to (count, Fmodule_load (found));
1167 #endif
1169 /* Check if we're stuck in a recursive load cycle.
1171 2000-09-21: It's not possible to just check for the file loaded
1172 being a member of Vloads_in_progress. This fails because of the
1173 way the byte compiler currently works; `provide's are not
1174 evaluated, see font-lock.el/jit-lock.el as an example. This
1175 leads to a certain amount of ``normal'' recursion.
1177 Also, just loading a file recursively is not always an error in
1178 the general case; the second load may do something different. */
1180 int load_count = 0;
1181 Lisp_Object tem;
1182 for (tem = Vloads_in_progress; CONSP (tem); tem = XCDR (tem))
1183 if (!NILP (Fequal (found, XCAR (tem))) && (++load_count > 3))
1184 signal_error ("Recursive load", Fcons (found, Vloads_in_progress));
1185 record_unwind_protect (record_load_unwind, Vloads_in_progress);
1186 Vloads_in_progress = Fcons (found, Vloads_in_progress);
1189 /* All loads are by default dynamic, unless the file itself specifies
1190 otherwise using a file-variable in the first line. This is bound here
1191 so that it takes effect whether or not we use
1192 Vload_source_file_function. */
1193 specbind (Qlexical_binding, Qnil);
1195 /* Get the name for load-history. */
1196 hist_file_name = (! NILP (Vpurify_flag)
1197 ? concat2 (Ffile_name_directory (file),
1198 Ffile_name_nondirectory (found))
1199 : found) ;
1201 version = -1;
1203 /* Check for the presence of old-style quotes and warn about them. */
1204 specbind (Qold_style_backquotes, Qnil);
1205 record_unwind_protect (load_warn_old_style_backquotes, file);
1207 if (suffix_p (found, ".elc") || (fd >= 0 && (version = safe_to_load_version (fd)) > 0))
1208 /* Load .elc files directly, but not when they are
1209 remote and have no handler! */
1211 if (fd != -2)
1213 struct stat s1, s2;
1214 int result;
1216 if (version < 0
1217 && ! (version = safe_to_load_version (fd)))
1219 safe_p = 0;
1220 if (!load_dangerous_libraries)
1221 error ("File `%s' was not compiled in Emacs", SDATA (found));
1222 else if (!NILP (nomessage) && !force_load_messages)
1223 message_with_string ("File `%s' not compiled in Emacs", found, 1);
1226 compiled = 1;
1228 efound = ENCODE_FILE (found);
1229 fmode = "r" FOPEN_BINARY;
1231 /* openp already checked for newness, no point doing it again.
1232 FIXME would be nice to get a message when openp
1233 ignores suffix order due to load_prefer_newer. */
1234 if (!load_prefer_newer)
1236 result = stat (SSDATA (efound), &s1);
1237 if (result == 0)
1239 SSET (efound, SBYTES (efound) - 1, 0);
1240 result = stat (SSDATA (efound), &s2);
1241 SSET (efound, SBYTES (efound) - 1, 'c');
1244 if (result == 0
1245 && timespec_cmp (get_stat_mtime (&s1), get_stat_mtime (&s2)) < 0)
1247 /* Make the progress messages mention that source is newer. */
1248 newer = 1;
1250 /* If we won't print another message, mention this anyway. */
1251 if (!NILP (nomessage) && !force_load_messages)
1253 Lisp_Object msg_file;
1254 msg_file = Fsubstring (found, make_number (0), make_number (-1));
1255 message_with_string ("Source file `%s' newer than byte-compiled file",
1256 msg_file, 1);
1259 } /* !load_prefer_newer */
1262 else
1264 /* We are loading a source file (*.el). */
1265 if (!NILP (Vload_source_file_function))
1267 Lisp_Object val;
1269 if (fd >= 0)
1271 emacs_close (fd);
1272 clear_unwind_protect (fd_index);
1274 val = call4 (Vload_source_file_function, found, hist_file_name,
1275 NILP (noerror) ? Qnil : Qt,
1276 (NILP (nomessage) || force_load_messages) ? Qnil : Qt);
1277 return unbind_to (count, val);
1281 if (fd < 0)
1283 /* We somehow got here with fd == -2, meaning the file is deemed
1284 to be remote. Don't even try to reopen the file locally;
1285 just force a failure. */
1286 stream = NULL;
1287 errno = EINVAL;
1289 else
1291 #ifdef WINDOWSNT
1292 emacs_close (fd);
1293 clear_unwind_protect (fd_index);
1294 efound = ENCODE_FILE (found);
1295 stream = emacs_fopen (SSDATA (efound), fmode);
1296 #else
1297 stream = fdopen (fd, fmode);
1298 #endif
1300 if (! stream)
1301 report_file_error ("Opening stdio stream", file);
1302 set_unwind_protect_ptr (fd_index, fclose_unwind, stream);
1304 if (! NILP (Vpurify_flag))
1305 Vpreloaded_file_list = Fcons (Fpurecopy (file), Vpreloaded_file_list);
1307 if (NILP (nomessage) || force_load_messages)
1309 if (!safe_p)
1310 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
1311 file, 1);
1312 else if (!compiled)
1313 message_with_string ("Loading %s (source)...", file, 1);
1314 else if (newer)
1315 message_with_string ("Loading %s (compiled; note, source file is newer)...",
1316 file, 1);
1317 else /* The typical case; compiled file newer than source file. */
1318 message_with_string ("Loading %s...", file, 1);
1321 specbind (Qload_file_name, found);
1322 specbind (Qinhibit_file_name_operation, Qnil);
1323 specbind (Qload_in_progress, Qt);
1325 instream = stream;
1326 if (lisp_file_lexically_bound_p (Qget_file_char))
1327 Fset (Qlexical_binding, Qt);
1329 if (! version || version >= 22)
1330 readevalloop (Qget_file_char, stream, hist_file_name,
1331 0, Qnil, Qnil, Qnil, Qnil);
1332 else
1334 /* We can't handle a file which was compiled with
1335 byte-compile-dynamic by older version of Emacs. */
1336 specbind (Qload_force_doc_strings, Qt);
1337 readevalloop (Qget_emacs_mule_file_char, stream, hist_file_name,
1338 0, Qnil, Qnil, Qnil, Qnil);
1340 unbind_to (count, Qnil);
1342 /* Run any eval-after-load forms for this file. */
1343 if (!NILP (Ffboundp (Qdo_after_load_evaluation)))
1344 call1 (Qdo_after_load_evaluation, hist_file_name) ;
1346 xfree (saved_doc_string);
1347 saved_doc_string = 0;
1348 saved_doc_string_size = 0;
1350 xfree (prev_saved_doc_string);
1351 prev_saved_doc_string = 0;
1352 prev_saved_doc_string_size = 0;
1354 if (!noninteractive && (NILP (nomessage) || force_load_messages))
1356 if (!safe_p)
1357 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
1358 file, 1);
1359 else if (!compiled)
1360 message_with_string ("Loading %s (source)...done", file, 1);
1361 else if (newer)
1362 message_with_string ("Loading %s (compiled; note, source file is newer)...done",
1363 file, 1);
1364 else /* The typical case; compiled file newer than source file. */
1365 message_with_string ("Loading %s...done", file, 1);
1368 return Qt;
1371 static bool
1372 complete_filename_p (Lisp_Object pathname)
1374 const unsigned char *s = SDATA (pathname);
1375 return (IS_DIRECTORY_SEP (s[0])
1376 || (SCHARS (pathname) > 2
1377 && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2])));
1380 DEFUN ("locate-file-internal", Flocate_file_internal, Slocate_file_internal, 2, 4, 0,
1381 doc: /* Search for FILENAME through PATH.
1382 Returns the file's name in absolute form, or nil if not found.
1383 If SUFFIXES is non-nil, it should be a list of suffixes to append to
1384 file name when searching.
1385 If non-nil, PREDICATE is used instead of `file-readable-p'.
1386 PREDICATE can also be an integer to pass to the faccessat(2) function,
1387 in which case file-name-handlers are ignored.
1388 This function will normally skip directories, so if you want it to find
1389 directories, make sure the PREDICATE function returns `dir-ok' for them. */)
1390 (Lisp_Object filename, Lisp_Object path, Lisp_Object suffixes, Lisp_Object predicate)
1392 Lisp_Object file;
1393 int fd = openp (path, filename, suffixes, &file, predicate, false);
1394 if (NILP (predicate) && fd >= 0)
1395 emacs_close (fd);
1396 return file;
1399 /* Search for a file whose name is STR, looking in directories
1400 in the Lisp list PATH, and trying suffixes from SUFFIX.
1401 On success, return a file descriptor (or 1 or -2 as described below).
1402 On failure, return -1 and set errno.
1404 SUFFIXES is a list of strings containing possible suffixes.
1405 The empty suffix is automatically added if the list is empty.
1407 PREDICATE t means the files are binary.
1408 PREDICATE non-nil and non-t means don't open the files,
1409 just look for one that satisfies the predicate. In this case,
1410 return 1 on success. The predicate can be a lisp function or
1411 an integer to pass to `access' (in which case file-name-handlers
1412 are ignored).
1414 If STOREPTR is nonzero, it points to a slot where the name of
1415 the file actually found should be stored as a Lisp string.
1416 nil is stored there on failure.
1418 If the file we find is remote, return -2
1419 but store the found remote file name in *STOREPTR.
1421 If NEWER is true, try all SUFFIXes and return the result for the
1422 newest file that exists. Does not apply to remote files,
1423 or if a non-nil and non-t PREDICATE is specified. */
1426 openp (Lisp_Object path, Lisp_Object str, Lisp_Object suffixes,
1427 Lisp_Object *storeptr, Lisp_Object predicate, bool newer)
1429 ptrdiff_t fn_size = 100;
1430 char buf[100];
1431 char *fn = buf;
1432 bool absolute;
1433 ptrdiff_t want_length;
1434 Lisp_Object filename;
1435 Lisp_Object string, tail, encoded_fn, save_string;
1436 ptrdiff_t max_suffix_len = 0;
1437 int last_errno = ENOENT;
1438 int save_fd = -1;
1439 USE_SAFE_ALLOCA;
1441 /* The last-modified time of the newest matching file found.
1442 Initialize it to something less than all valid timestamps. */
1443 struct timespec save_mtime = make_timespec (TYPE_MINIMUM (time_t), -1);
1445 CHECK_STRING (str);
1447 for (tail = suffixes; CONSP (tail); tail = XCDR (tail))
1449 CHECK_STRING_CAR (tail);
1450 max_suffix_len = max (max_suffix_len,
1451 SBYTES (XCAR (tail)));
1454 string = filename = encoded_fn = save_string = Qnil;
1456 if (storeptr)
1457 *storeptr = Qnil;
1459 absolute = complete_filename_p (str);
1461 for (; CONSP (path); path = XCDR (path))
1463 filename = Fexpand_file_name (str, XCAR (path));
1464 if (!complete_filename_p (filename))
1465 /* If there are non-absolute elts in PATH (eg "."). */
1466 /* Of course, this could conceivably lose if luser sets
1467 default-directory to be something non-absolute... */
1469 filename = Fexpand_file_name (filename, BVAR (current_buffer, directory));
1470 if (!complete_filename_p (filename))
1471 /* Give up on this path element! */
1472 continue;
1475 /* Calculate maximum length of any filename made from
1476 this path element/specified file name and any possible suffix. */
1477 want_length = max_suffix_len + SBYTES (filename);
1478 if (fn_size <= want_length)
1480 fn_size = 100 + want_length;
1481 fn = SAFE_ALLOCA (fn_size);
1484 /* Loop over suffixes. */
1485 for (tail = NILP (suffixes) ? list1 (empty_unibyte_string) : suffixes;
1486 CONSP (tail); tail = XCDR (tail))
1488 Lisp_Object suffix = XCAR (tail);
1489 ptrdiff_t fnlen, lsuffix = SBYTES (suffix);
1490 Lisp_Object handler;
1492 /* Concatenate path element/specified name with the suffix.
1493 If the directory starts with /:, remove that. */
1494 int prefixlen = ((SCHARS (filename) > 2
1495 && SREF (filename, 0) == '/'
1496 && SREF (filename, 1) == ':')
1497 ? 2 : 0);
1498 fnlen = SBYTES (filename) - prefixlen;
1499 memcpy (fn, SDATA (filename) + prefixlen, fnlen);
1500 memcpy (fn + fnlen, SDATA (suffix), lsuffix + 1);
1501 fnlen += lsuffix;
1502 /* Check that the file exists and is not a directory. */
1503 /* We used to only check for handlers on non-absolute file names:
1504 if (absolute)
1505 handler = Qnil;
1506 else
1507 handler = Ffind_file_name_handler (filename, Qfile_exists_p);
1508 It's not clear why that was the case and it breaks things like
1509 (load "/bar.el") where the file is actually "/bar.el.gz". */
1510 /* make_string has its own ideas on when to return a unibyte
1511 string and when a multibyte string, but we know better.
1512 We must have a unibyte string when dumping, since
1513 file-name encoding is shaky at best at that time, and in
1514 particular default-file-name-coding-system is reset
1515 several times during loadup. We therefore don't want to
1516 encode the file before passing it to file I/O library
1517 functions. */
1518 if (!STRING_MULTIBYTE (filename) && !STRING_MULTIBYTE (suffix))
1519 string = make_unibyte_string (fn, fnlen);
1520 else
1521 string = make_string (fn, fnlen);
1522 handler = Ffind_file_name_handler (string, Qfile_exists_p);
1523 if ((!NILP (handler) || (!NILP (predicate) && !EQ (predicate, Qt)))
1524 && !NATNUMP (predicate))
1526 bool exists;
1527 if (NILP (predicate) || EQ (predicate, Qt))
1528 exists = !NILP (Ffile_readable_p (string));
1529 else
1531 Lisp_Object tmp = call1 (predicate, string);
1532 if (NILP (tmp))
1533 exists = false;
1534 else if (EQ (tmp, Qdir_ok)
1535 || NILP (Ffile_directory_p (string)))
1536 exists = true;
1537 else
1539 exists = false;
1540 last_errno = EISDIR;
1544 if (exists)
1546 /* We succeeded; return this descriptor and filename. */
1547 if (storeptr)
1548 *storeptr = string;
1549 SAFE_FREE ();
1550 return -2;
1553 else
1555 int fd;
1556 const char *pfn;
1557 struct stat st;
1559 encoded_fn = ENCODE_FILE (string);
1560 pfn = SSDATA (encoded_fn);
1562 /* Check that we can access or open it. */
1563 if (NATNUMP (predicate))
1565 fd = -1;
1566 if (INT_MAX < XFASTINT (predicate))
1567 last_errno = EINVAL;
1568 else if (faccessat (AT_FDCWD, pfn, XFASTINT (predicate),
1569 AT_EACCESS)
1570 == 0)
1572 if (file_directory_p (pfn))
1573 last_errno = EISDIR;
1574 else
1575 fd = 1;
1578 else
1580 fd = emacs_open (pfn, O_RDONLY, 0);
1581 if (fd < 0)
1583 if (errno != ENOENT)
1584 last_errno = errno;
1586 else
1588 int err = (fstat (fd, &st) != 0 ? errno
1589 : S_ISDIR (st.st_mode) ? EISDIR : 0);
1590 if (err)
1592 last_errno = err;
1593 emacs_close (fd);
1594 fd = -1;
1599 if (fd >= 0)
1601 if (newer && !NATNUMP (predicate))
1603 struct timespec mtime = get_stat_mtime (&st);
1605 if (timespec_cmp (mtime, save_mtime) <= 0)
1606 emacs_close (fd);
1607 else
1609 if (0 <= save_fd)
1610 emacs_close (save_fd);
1611 save_fd = fd;
1612 save_mtime = mtime;
1613 save_string = string;
1616 else
1618 /* We succeeded; return this descriptor and filename. */
1619 if (storeptr)
1620 *storeptr = string;
1621 SAFE_FREE ();
1622 return fd;
1626 /* No more suffixes. Return the newest. */
1627 if (0 <= save_fd && ! CONSP (XCDR (tail)))
1629 if (storeptr)
1630 *storeptr = save_string;
1631 SAFE_FREE ();
1632 return save_fd;
1636 if (absolute)
1637 break;
1640 SAFE_FREE ();
1641 errno = last_errno;
1642 return -1;
1646 /* Merge the list we've accumulated of globals from the current input source
1647 into the load_history variable. The details depend on whether
1648 the source has an associated file name or not.
1650 FILENAME is the file name that we are loading from.
1652 ENTIRE is true if loading that entire file, false if evaluating
1653 part of it. */
1655 static void
1656 build_load_history (Lisp_Object filename, bool entire)
1658 Lisp_Object tail, prev, newelt;
1659 Lisp_Object tem, tem2;
1660 bool foundit = 0;
1662 tail = Vload_history;
1663 prev = Qnil;
1665 while (CONSP (tail))
1667 tem = XCAR (tail);
1669 /* Find the feature's previous assoc list... */
1670 if (!NILP (Fequal (filename, Fcar (tem))))
1672 foundit = 1;
1674 /* If we're loading the entire file, remove old data. */
1675 if (entire)
1677 if (NILP (prev))
1678 Vload_history = XCDR (tail);
1679 else
1680 Fsetcdr (prev, XCDR (tail));
1683 /* Otherwise, cons on new symbols that are not already members. */
1684 else
1686 tem2 = Vcurrent_load_list;
1688 while (CONSP (tem2))
1690 newelt = XCAR (tem2);
1692 if (NILP (Fmember (newelt, tem)))
1693 Fsetcar (tail, Fcons (XCAR (tem),
1694 Fcons (newelt, XCDR (tem))));
1696 tem2 = XCDR (tem2);
1697 QUIT;
1701 else
1702 prev = tail;
1703 tail = XCDR (tail);
1704 QUIT;
1707 /* If we're loading an entire file, cons the new assoc onto the
1708 front of load-history, the most-recently-loaded position. Also
1709 do this if we didn't find an existing member for the file. */
1710 if (entire || !foundit)
1711 Vload_history = Fcons (Fnreverse (Vcurrent_load_list),
1712 Vload_history);
1715 static void
1716 readevalloop_1 (int old)
1718 load_convert_to_unibyte = old;
1721 /* Signal an `end-of-file' error, if possible with file name
1722 information. */
1724 static _Noreturn void
1725 end_of_file_error (void)
1727 if (STRINGP (Vload_file_name))
1728 xsignal1 (Qend_of_file, Vload_file_name);
1730 xsignal0 (Qend_of_file);
1733 static Lisp_Object
1734 readevalloop_eager_expand_eval (Lisp_Object val, Lisp_Object macroexpand)
1736 /* If we macroexpand the toplevel form non-recursively and it ends
1737 up being a `progn' (or if it was a progn to start), treat each
1738 form in the progn as a top-level form. This way, if one form in
1739 the progn defines a macro, that macro is in effect when we expand
1740 the remaining forms. See similar code in bytecomp.el. */
1741 val = call2 (macroexpand, val, Qnil);
1742 if (EQ (CAR_SAFE (val), Qprogn))
1744 Lisp_Object subforms = XCDR (val);
1746 for (val = Qnil; CONSP (subforms); subforms = XCDR (subforms))
1747 val = readevalloop_eager_expand_eval (XCAR (subforms),
1748 macroexpand);
1750 else
1751 val = eval_sub (call2 (macroexpand, val, Qt));
1752 return val;
1755 /* UNIBYTE specifies how to set load_convert_to_unibyte
1756 for this invocation.
1757 READFUN, if non-nil, is used instead of `read'.
1759 START, END specify region to read in current buffer (from eval-region).
1760 If the input is not from a buffer, they must be nil. */
1762 static void
1763 readevalloop (Lisp_Object readcharfun,
1764 FILE *stream,
1765 Lisp_Object sourcename,
1766 bool printflag,
1767 Lisp_Object unibyte, Lisp_Object readfun,
1768 Lisp_Object start, Lisp_Object end)
1770 int c;
1771 Lisp_Object val;
1772 ptrdiff_t count = SPECPDL_INDEX ();
1773 struct buffer *b = 0;
1774 bool continue_reading_p;
1775 Lisp_Object lex_bound;
1776 /* True if reading an entire buffer. */
1777 bool whole_buffer = 0;
1778 /* True on the first time around. */
1779 bool first_sexp = 1;
1780 Lisp_Object macroexpand = intern ("internal-macroexpand-for-load");
1782 if (NILP (Ffboundp (macroexpand))
1783 /* Don't macroexpand in .elc files, since it should have been done
1784 already. We actually don't know whether we're in a .elc file or not,
1785 so we use circumstantial evidence: .el files normally go through
1786 Vload_source_file_function -> load-with-code-conversion
1787 -> eval-buffer. */
1788 || EQ (readcharfun, Qget_file_char)
1789 || EQ (readcharfun, Qget_emacs_mule_file_char))
1790 macroexpand = Qnil;
1792 if (MARKERP (readcharfun))
1794 if (NILP (start))
1795 start = readcharfun;
1798 if (BUFFERP (readcharfun))
1799 b = XBUFFER (readcharfun);
1800 else if (MARKERP (readcharfun))
1801 b = XMARKER (readcharfun)->buffer;
1803 /* We assume START is nil when input is not from a buffer. */
1804 if (! NILP (start) && !b)
1805 emacs_abort ();
1807 specbind (Qstandard_input, readcharfun);
1808 specbind (Qcurrent_load_list, Qnil);
1809 record_unwind_protect_int (readevalloop_1, load_convert_to_unibyte);
1810 load_convert_to_unibyte = !NILP (unibyte);
1812 /* If lexical binding is active (either because it was specified in
1813 the file's header, or via a buffer-local variable), create an empty
1814 lexical environment, otherwise, turn off lexical binding. */
1815 lex_bound = find_symbol_value (Qlexical_binding);
1816 specbind (Qinternal_interpreter_environment,
1817 (NILP (lex_bound) || EQ (lex_bound, Qunbound)
1818 ? Qnil : list1 (Qt)));
1820 /* Try to ensure sourcename is a truename, except whilst preloading. */
1821 if (NILP (Vpurify_flag)
1822 && !NILP (sourcename) && !NILP (Ffile_name_absolute_p (sourcename))
1823 && !NILP (Ffboundp (Qfile_truename)))
1824 sourcename = call1 (Qfile_truename, sourcename) ;
1826 LOADHIST_ATTACH (sourcename);
1828 continue_reading_p = 1;
1829 while (continue_reading_p)
1831 ptrdiff_t count1 = SPECPDL_INDEX ();
1833 if (b != 0 && !BUFFER_LIVE_P (b))
1834 error ("Reading from killed buffer");
1836 if (!NILP (start))
1838 /* Switch to the buffer we are reading from. */
1839 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1840 set_buffer_internal (b);
1842 /* Save point in it. */
1843 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1844 /* Save ZV in it. */
1845 record_unwind_protect (save_restriction_restore, save_restriction_save ());
1846 /* Those get unbound after we read one expression. */
1848 /* Set point and ZV around stuff to be read. */
1849 Fgoto_char (start);
1850 if (!NILP (end))
1851 Fnarrow_to_region (make_number (BEGV), end);
1853 /* Just for cleanliness, convert END to a marker
1854 if it is an integer. */
1855 if (INTEGERP (end))
1856 end = Fpoint_max_marker ();
1859 /* On the first cycle, we can easily test here
1860 whether we are reading the whole buffer. */
1861 if (b && first_sexp)
1862 whole_buffer = (PT == BEG && ZV == Z);
1864 instream = stream;
1865 read_next:
1866 c = READCHAR;
1867 if (c == ';')
1869 while ((c = READCHAR) != '\n' && c != -1);
1870 goto read_next;
1872 if (c < 0)
1874 unbind_to (count1, Qnil);
1875 break;
1878 /* Ignore whitespace here, so we can detect eof. */
1879 if (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r'
1880 || c == NO_BREAK_SPACE)
1881 goto read_next;
1883 if (!NILP (Vpurify_flag) && c == '(')
1885 val = read_list (0, readcharfun);
1887 else
1889 UNREAD (c);
1890 read_objects = Qnil;
1891 if (!NILP (readfun))
1893 val = call1 (readfun, readcharfun);
1895 /* If READCHARFUN has set point to ZV, we should
1896 stop reading, even if the form read sets point
1897 to a different value when evaluated. */
1898 if (BUFFERP (readcharfun))
1900 struct buffer *buf = XBUFFER (readcharfun);
1901 if (BUF_PT (buf) == BUF_ZV (buf))
1902 continue_reading_p = 0;
1905 else if (! NILP (Vload_read_function))
1906 val = call1 (Vload_read_function, readcharfun);
1907 else
1908 val = read_internal_start (readcharfun, Qnil, Qnil);
1911 if (!NILP (start) && continue_reading_p)
1912 start = Fpoint_marker ();
1914 /* Restore saved point and BEGV. */
1915 unbind_to (count1, Qnil);
1917 /* Now eval what we just read. */
1918 if (!NILP (macroexpand))
1919 val = readevalloop_eager_expand_eval (val, macroexpand);
1920 else
1921 val = eval_sub (val);
1923 if (printflag)
1925 Vvalues = Fcons (val, Vvalues);
1926 if (EQ (Vstandard_output, Qt))
1927 Fprin1 (val, Qnil);
1928 else
1929 Fprint (val, Qnil);
1932 first_sexp = 0;
1935 build_load_history (sourcename,
1936 stream || whole_buffer);
1938 unbind_to (count, Qnil);
1941 DEFUN ("eval-buffer", Feval_buffer, Seval_buffer, 0, 5, "",
1942 doc: /* Execute the accessible portion of current buffer as Lisp code.
1943 You can use \\[narrow-to-region] to limit the part of buffer to be evaluated.
1944 When called from a Lisp program (i.e., not interactively), this
1945 function accepts up to five optional arguments:
1946 BUFFER is the buffer to evaluate (nil means use current buffer),
1947 or a name of a buffer (a string).
1948 PRINTFLAG controls printing of output by any output functions in the
1949 evaluated code, such as `print', `princ', and `prin1':
1950 a value of nil means discard it; anything else is the stream to print to.
1951 See Info node `(elisp)Output Streams' for details on streams.
1952 FILENAME specifies the file name to use for `load-history'.
1953 UNIBYTE, if non-nil, specifies `load-convert-to-unibyte' for this
1954 invocation.
1955 DO-ALLOW-PRINT, if non-nil, specifies that output functions in the
1956 evaluated code should work normally even if PRINTFLAG is nil, in
1957 which case the output is displayed in the echo area.
1959 This function preserves the position of point. */)
1960 (Lisp_Object buffer, Lisp_Object printflag, Lisp_Object filename, Lisp_Object unibyte, Lisp_Object do_allow_print)
1962 ptrdiff_t count = SPECPDL_INDEX ();
1963 Lisp_Object tem, buf;
1965 if (NILP (buffer))
1966 buf = Fcurrent_buffer ();
1967 else
1968 buf = Fget_buffer (buffer);
1969 if (NILP (buf))
1970 error ("No such buffer");
1972 if (NILP (printflag) && NILP (do_allow_print))
1973 tem = Qsymbolp;
1974 else
1975 tem = printflag;
1977 if (NILP (filename))
1978 filename = BVAR (XBUFFER (buf), filename);
1980 specbind (Qeval_buffer_list, Fcons (buf, Veval_buffer_list));
1981 specbind (Qstandard_output, tem);
1982 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1983 BUF_TEMP_SET_PT (XBUFFER (buf), BUF_BEGV (XBUFFER (buf)));
1984 specbind (Qlexical_binding, lisp_file_lexically_bound_p (buf) ? Qt : Qnil);
1985 readevalloop (buf, 0, filename,
1986 !NILP (printflag), unibyte, Qnil, Qnil, Qnil);
1987 unbind_to (count, Qnil);
1989 return Qnil;
1992 DEFUN ("eval-region", Feval_region, Seval_region, 2, 4, "r",
1993 doc: /* Execute the region as Lisp code.
1994 When called from programs, expects two arguments,
1995 giving starting and ending indices in the current buffer
1996 of the text to be executed.
1997 Programs can pass third argument PRINTFLAG which controls output:
1998 a value of nil means discard it; anything else is stream for printing it.
1999 See Info node `(elisp)Output Streams' for details on streams.
2000 Also the fourth argument READ-FUNCTION, if non-nil, is used
2001 instead of `read' to read each expression. It gets one argument
2002 which is the input stream for reading characters.
2004 This function does not move point. */)
2005 (Lisp_Object start, Lisp_Object end, Lisp_Object printflag, Lisp_Object read_function)
2007 /* FIXME: Do the eval-sexp-add-defvars dance! */
2008 ptrdiff_t count = SPECPDL_INDEX ();
2009 Lisp_Object tem, cbuf;
2011 cbuf = Fcurrent_buffer ();
2013 if (NILP (printflag))
2014 tem = Qsymbolp;
2015 else
2016 tem = printflag;
2017 specbind (Qstandard_output, tem);
2018 specbind (Qeval_buffer_list, Fcons (cbuf, Veval_buffer_list));
2020 /* `readevalloop' calls functions which check the type of start and end. */
2021 readevalloop (cbuf, 0, BVAR (XBUFFER (cbuf), filename),
2022 !NILP (printflag), Qnil, read_function,
2023 start, end);
2025 return unbind_to (count, Qnil);
2029 DEFUN ("read", Fread, Sread, 0, 1, 0,
2030 doc: /* Read one Lisp expression as text from STREAM, return as Lisp object.
2031 If STREAM is nil, use the value of `standard-input' (which see).
2032 STREAM or the value of `standard-input' may be:
2033 a buffer (read from point and advance it)
2034 a marker (read from where it points and advance it)
2035 a function (call it with no arguments for each character,
2036 call it with a char as argument to push a char back)
2037 a string (takes text from string, starting at the beginning)
2038 t (read text line using minibuffer and use it, or read from
2039 standard input in batch mode). */)
2040 (Lisp_Object stream)
2042 if (NILP (stream))
2043 stream = Vstandard_input;
2044 if (EQ (stream, Qt))
2045 stream = Qread_char;
2046 if (EQ (stream, Qread_char))
2047 /* FIXME: ?! When is this used !? */
2048 return call1 (intern ("read-minibuffer"),
2049 build_string ("Lisp expression: "));
2051 return read_internal_start (stream, Qnil, Qnil);
2054 DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0,
2055 doc: /* Read one Lisp expression which is represented as text by STRING.
2056 Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
2057 FINAL-STRING-INDEX is an integer giving the position of the next
2058 remaining character in STRING. START and END optionally delimit
2059 a substring of STRING from which to read; they default to 0 and
2060 \(length STRING) respectively. Negative values are counted from
2061 the end of STRING. */)
2062 (Lisp_Object string, Lisp_Object start, Lisp_Object end)
2064 Lisp_Object ret;
2065 CHECK_STRING (string);
2066 /* `read_internal_start' sets `read_from_string_index'. */
2067 ret = read_internal_start (string, start, end);
2068 return Fcons (ret, make_number (read_from_string_index));
2071 /* Function to set up the global context we need in toplevel read
2072 calls. START and END only used when STREAM is a string. */
2073 static Lisp_Object
2074 read_internal_start (Lisp_Object stream, Lisp_Object start, Lisp_Object end)
2076 Lisp_Object retval;
2078 readchar_count = 0;
2079 new_backquote_flag = 0;
2080 read_objects = Qnil;
2081 if (EQ (Vread_with_symbol_positions, Qt)
2082 || EQ (Vread_with_symbol_positions, stream))
2083 Vread_symbol_positions_list = Qnil;
2085 if (STRINGP (stream)
2086 || ((CONSP (stream) && STRINGP (XCAR (stream)))))
2088 ptrdiff_t startval, endval;
2089 Lisp_Object string;
2091 if (STRINGP (stream))
2092 string = stream;
2093 else
2094 string = XCAR (stream);
2096 validate_subarray (string, start, end, SCHARS (string),
2097 &startval, &endval);
2099 read_from_string_index = startval;
2100 read_from_string_index_byte = string_char_to_byte (string, startval);
2101 read_from_string_limit = endval;
2104 retval = read0 (stream);
2105 if (EQ (Vread_with_symbol_positions, Qt)
2106 || EQ (Vread_with_symbol_positions, stream))
2107 Vread_symbol_positions_list = Fnreverse (Vread_symbol_positions_list);
2108 return retval;
2112 /* Signal Qinvalid_read_syntax error.
2113 S is error string of length N (if > 0) */
2115 static _Noreturn void
2116 invalid_syntax (const char *s)
2118 xsignal1 (Qinvalid_read_syntax, build_string (s));
2122 /* Use this for recursive reads, in contexts where internal tokens
2123 are not allowed. */
2125 static Lisp_Object
2126 read0 (Lisp_Object readcharfun)
2128 register Lisp_Object val;
2129 int c;
2131 val = read1 (readcharfun, &c, 0);
2132 if (!c)
2133 return val;
2135 xsignal1 (Qinvalid_read_syntax,
2136 Fmake_string (make_number (1), make_number (c)));
2139 static ptrdiff_t read_buffer_size;
2140 static char *read_buffer;
2142 /* Grow the read buffer by at least MAX_MULTIBYTE_LENGTH bytes. */
2144 static void
2145 grow_read_buffer (void)
2147 read_buffer = xpalloc (read_buffer, &read_buffer_size,
2148 MAX_MULTIBYTE_LENGTH, -1, 1);
2151 /* Return the scalar value that has the Unicode character name NAME.
2152 Raise 'invalid-read-syntax' if there is no such character. */
2153 static int
2154 character_name_to_code (char const *name, ptrdiff_t name_len)
2156 /* For "U+XXXX", pass the leading '+' to string_to_number to reject
2157 monstrosities like "U+-0000". */
2158 Lisp_Object code
2159 = (name[0] == 'U' && name[1] == '+'
2160 ? string_to_number (name + 1, 16, false)
2161 : call2 (Qchar_from_name, make_unibyte_string (name, name_len), Qt));
2163 if (! RANGED_INTEGERP (0, code, MAX_UNICODE_CHAR)
2164 || char_surrogate_p (XINT (code)))
2166 AUTO_STRING (format, "\\N{%s}");
2167 AUTO_STRING_WITH_LEN (namestr, name, name_len);
2168 xsignal1 (Qinvalid_read_syntax, CALLN (Fformat, format, namestr));
2171 return XINT (code);
2174 /* Bound on the length of a Unicode character name. As of
2175 Unicode 9.0.0 the maximum is 83, so this should be safe. */
2176 enum { UNICODE_CHARACTER_NAME_LENGTH_BOUND = 200 };
2178 /* Read a \-escape sequence, assuming we already read the `\'.
2179 If the escape sequence forces unibyte, return eight-bit char. */
2181 static int
2182 read_escape (Lisp_Object readcharfun, bool stringp)
2184 int c = READCHAR;
2185 /* \u allows up to four hex digits, \U up to eight. Default to the
2186 behavior for \u, and change this value in the case that \U is seen. */
2187 int unicode_hex_count = 4;
2189 switch (c)
2191 case -1:
2192 end_of_file_error ();
2194 case 'a':
2195 return '\007';
2196 case 'b':
2197 return '\b';
2198 case 'd':
2199 return 0177;
2200 case 'e':
2201 return 033;
2202 case 'f':
2203 return '\f';
2204 case 'n':
2205 return '\n';
2206 case 'r':
2207 return '\r';
2208 case 't':
2209 return '\t';
2210 case 'v':
2211 return '\v';
2212 case '\n':
2213 return -1;
2214 case ' ':
2215 if (stringp)
2216 return -1;
2217 return ' ';
2219 case 'M':
2220 c = READCHAR;
2221 if (c != '-')
2222 error ("Invalid escape character syntax");
2223 c = READCHAR;
2224 if (c == '\\')
2225 c = read_escape (readcharfun, 0);
2226 return c | meta_modifier;
2228 case 'S':
2229 c = READCHAR;
2230 if (c != '-')
2231 error ("Invalid escape character syntax");
2232 c = READCHAR;
2233 if (c == '\\')
2234 c = read_escape (readcharfun, 0);
2235 return c | shift_modifier;
2237 case 'H':
2238 c = READCHAR;
2239 if (c != '-')
2240 error ("Invalid escape character syntax");
2241 c = READCHAR;
2242 if (c == '\\')
2243 c = read_escape (readcharfun, 0);
2244 return c | hyper_modifier;
2246 case 'A':
2247 c = READCHAR;
2248 if (c != '-')
2249 error ("Invalid escape character syntax");
2250 c = READCHAR;
2251 if (c == '\\')
2252 c = read_escape (readcharfun, 0);
2253 return c | alt_modifier;
2255 case 's':
2256 c = READCHAR;
2257 if (stringp || c != '-')
2259 UNREAD (c);
2260 return ' ';
2262 c = READCHAR;
2263 if (c == '\\')
2264 c = read_escape (readcharfun, 0);
2265 return c | super_modifier;
2267 case 'C':
2268 c = READCHAR;
2269 if (c != '-')
2270 error ("Invalid escape character syntax");
2271 case '^':
2272 c = READCHAR;
2273 if (c == '\\')
2274 c = read_escape (readcharfun, 0);
2275 if ((c & ~CHAR_MODIFIER_MASK) == '?')
2276 return 0177 | (c & CHAR_MODIFIER_MASK);
2277 else if (! SINGLE_BYTE_CHAR_P ((c & ~CHAR_MODIFIER_MASK)))
2278 return c | ctrl_modifier;
2279 /* ASCII control chars are made from letters (both cases),
2280 as well as the non-letters within 0100...0137. */
2281 else if ((c & 0137) >= 0101 && (c & 0137) <= 0132)
2282 return (c & (037 | ~0177));
2283 else if ((c & 0177) >= 0100 && (c & 0177) <= 0137)
2284 return (c & (037 | ~0177));
2285 else
2286 return c | ctrl_modifier;
2288 case '0':
2289 case '1':
2290 case '2':
2291 case '3':
2292 case '4':
2293 case '5':
2294 case '6':
2295 case '7':
2296 /* An octal escape, as in ANSI C. */
2298 register int i = c - '0';
2299 register int count = 0;
2300 while (++count < 3)
2302 if ((c = READCHAR) >= '0' && c <= '7')
2304 i *= 8;
2305 i += c - '0';
2307 else
2309 UNREAD (c);
2310 break;
2314 if (i >= 0x80 && i < 0x100)
2315 i = BYTE8_TO_CHAR (i);
2316 return i;
2319 case 'x':
2320 /* A hex escape, as in ANSI C. */
2322 unsigned int i = 0;
2323 int count = 0;
2324 while (1)
2326 c = READCHAR;
2327 if (c >= '0' && c <= '9')
2329 i *= 16;
2330 i += c - '0';
2332 else if ((c >= 'a' && c <= 'f')
2333 || (c >= 'A' && c <= 'F'))
2335 i *= 16;
2336 if (c >= 'a' && c <= 'f')
2337 i += c - 'a' + 10;
2338 else
2339 i += c - 'A' + 10;
2341 else
2343 UNREAD (c);
2344 break;
2346 /* Allow hex escapes as large as ?\xfffffff, because some
2347 packages use them to denote characters with modifiers. */
2348 if ((CHAR_META | (CHAR_META - 1)) < i)
2349 error ("Hex character out of range: \\x%x...", i);
2350 count += count < 3;
2353 if (count < 3 && i >= 0x80)
2354 return BYTE8_TO_CHAR (i);
2355 return i;
2358 case 'U':
2359 /* Post-Unicode-2.0: Up to eight hex chars. */
2360 unicode_hex_count = 8;
2361 case 'u':
2363 /* A Unicode escape. We only permit them in strings and characters,
2364 not arbitrarily in the source code, as in some other languages. */
2366 unsigned int i = 0;
2367 int count = 0;
2369 while (++count <= unicode_hex_count)
2371 c = READCHAR;
2372 /* `isdigit' and `isalpha' may be locale-specific, which we don't
2373 want. */
2374 if (c >= '0' && c <= '9') i = (i << 4) + (c - '0');
2375 else if (c >= 'a' && c <= 'f') i = (i << 4) + (c - 'a') + 10;
2376 else if (c >= 'A' && c <= 'F') i = (i << 4) + (c - 'A') + 10;
2377 else
2378 error ("Non-hex digit used for Unicode escape");
2380 if (i > 0x10FFFF)
2381 error ("Non-Unicode character: 0x%x", i);
2382 return i;
2385 case 'N':
2386 /* Named character. */
2388 c = READCHAR;
2389 if (c != '{')
2390 invalid_syntax ("Expected opening brace after \\N");
2391 char name[UNICODE_CHARACTER_NAME_LENGTH_BOUND + 1];
2392 bool whitespace = false;
2393 ptrdiff_t length = 0;
2394 while (true)
2396 c = READCHAR;
2397 if (c < 0)
2398 end_of_file_error ();
2399 if (c == '}')
2400 break;
2401 if (! (0 < c && c < 0x80))
2403 AUTO_STRING (format,
2404 "Invalid character U+%04X in character name");
2405 xsignal1 (Qinvalid_read_syntax,
2406 CALLN (Fformat, format, make_natnum (c)));
2408 /* Treat multiple adjacent whitespace characters as a
2409 single space character. This makes it easier to use
2410 character names in e.g. multi-line strings. */
2411 if (c_isspace (c))
2413 if (whitespace)
2414 continue;
2415 c = ' ';
2416 whitespace = true;
2418 else
2419 whitespace = false;
2420 name[length++] = c;
2421 if (length >= sizeof name)
2422 invalid_syntax ("Character name too long");
2424 if (length == 0)
2425 invalid_syntax ("Empty character name");
2426 name[length] = '\0';
2427 return character_name_to_code (name, length);
2430 default:
2431 return c;
2435 /* Return the digit that CHARACTER stands for in the given BASE.
2436 Return -1 if CHARACTER is out of range for BASE,
2437 and -2 if CHARACTER is not valid for any supported BASE. */
2438 static int
2439 digit_to_number (int character, int base)
2441 int digit;
2443 if ('0' <= character && character <= '9')
2444 digit = character - '0';
2445 else if ('a' <= character && character <= 'z')
2446 digit = character - 'a' + 10;
2447 else if ('A' <= character && character <= 'Z')
2448 digit = character - 'A' + 10;
2449 else
2450 return -2;
2452 return digit < base ? digit : -1;
2455 /* Read an integer in radix RADIX using READCHARFUN to read
2456 characters. RADIX must be in the interval [2..36]; if it isn't, a
2457 read error is signaled . Value is the integer read. Signals an
2458 error if encountering invalid read syntax or if RADIX is out of
2459 range. */
2461 static Lisp_Object
2462 read_integer (Lisp_Object readcharfun, EMACS_INT radix)
2464 /* Room for sign, leading 0, other digits, trailing null byte.
2465 Also, room for invalid syntax diagnostic. */
2466 char buf[max (1 + 1 + sizeof (uintmax_t) * CHAR_BIT + 1,
2467 sizeof "integer, radix " + INT_STRLEN_BOUND (EMACS_INT))];
2469 int valid = -1; /* 1 if valid, 0 if not, -1 if incomplete. */
2471 if (radix < 2 || radix > 36)
2472 valid = 0;
2473 else
2475 char *p = buf;
2476 int c, digit;
2478 c = READCHAR;
2479 if (c == '-' || c == '+')
2481 *p++ = c;
2482 c = READCHAR;
2485 if (c == '0')
2487 *p++ = c;
2488 valid = 1;
2490 /* Ignore redundant leading zeros, so the buffer doesn't
2491 fill up with them. */
2493 c = READCHAR;
2494 while (c == '0');
2497 while ((digit = digit_to_number (c, radix)) >= -1)
2499 if (digit == -1)
2500 valid = 0;
2501 if (valid < 0)
2502 valid = 1;
2504 if (p < buf + sizeof buf - 1)
2505 *p++ = c;
2506 else
2507 valid = 0;
2509 c = READCHAR;
2512 UNREAD (c);
2513 *p = '\0';
2516 if (! valid)
2518 sprintf (buf, "integer, radix %"pI"d", radix);
2519 invalid_syntax (buf);
2522 return string_to_number (buf, radix, 0);
2526 /* If the next token is ')' or ']' or '.', we store that character
2527 in *PCH and the return value is not interesting. Else, we store
2528 zero in *PCH and we read and return one lisp object.
2530 FIRST_IN_LIST is true if this is the first element of a list. */
2532 static Lisp_Object
2533 read1 (Lisp_Object readcharfun, int *pch, bool first_in_list)
2535 int c;
2536 bool uninterned_symbol = 0;
2537 bool multibyte;
2539 *pch = 0;
2541 retry:
2543 c = READCHAR_REPORT_MULTIBYTE (&multibyte);
2544 if (c < 0)
2545 end_of_file_error ();
2547 switch (c)
2549 case '(':
2550 return read_list (0, readcharfun);
2552 case '[':
2553 return read_vector (readcharfun, 0);
2555 case ')':
2556 case ']':
2558 *pch = c;
2559 return Qnil;
2562 case '#':
2563 c = READCHAR;
2564 if (c == 's')
2566 c = READCHAR;
2567 if (c == '(')
2569 /* Accept extended format for hashtables (extensible to
2570 other types), e.g.
2571 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
2572 Lisp_Object tmp = read_list (0, readcharfun);
2573 Lisp_Object head = CAR_SAFE (tmp);
2574 Lisp_Object data = Qnil;
2575 Lisp_Object val = Qnil;
2576 /* The size is 2 * number of allowed keywords to
2577 make-hash-table. */
2578 Lisp_Object params[10];
2579 Lisp_Object ht;
2580 Lisp_Object key = Qnil;
2581 int param_count = 0;
2583 if (!EQ (head, Qhash_table))
2584 error ("Invalid extended read marker at head of #s list "
2585 "(only hash-table allowed)");
2587 tmp = CDR_SAFE (tmp);
2589 /* This is repetitive but fast and simple. */
2590 params[param_count] = QCsize;
2591 params[param_count + 1] = Fplist_get (tmp, Qsize);
2592 if (!NILP (params[param_count + 1]))
2593 param_count += 2;
2595 params[param_count] = QCtest;
2596 params[param_count + 1] = Fplist_get (tmp, Qtest);
2597 if (!NILP (params[param_count + 1]))
2598 param_count += 2;
2600 params[param_count] = QCweakness;
2601 params[param_count + 1] = Fplist_get (tmp, Qweakness);
2602 if (!NILP (params[param_count + 1]))
2603 param_count += 2;
2605 params[param_count] = QCrehash_size;
2606 params[param_count + 1] = Fplist_get (tmp, Qrehash_size);
2607 if (!NILP (params[param_count + 1]))
2608 param_count += 2;
2610 params[param_count] = QCrehash_threshold;
2611 params[param_count + 1] = Fplist_get (tmp, Qrehash_threshold);
2612 if (!NILP (params[param_count + 1]))
2613 param_count += 2;
2615 /* This is the hashtable data. */
2616 data = Fplist_get (tmp, Qdata);
2618 /* Now use params to make a new hashtable and fill it. */
2619 ht = Fmake_hash_table (param_count, params);
2621 while (CONSP (data))
2623 key = XCAR (data);
2624 data = XCDR (data);
2625 if (!CONSP (data))
2626 error ("Odd number of elements in hashtable data");
2627 val = XCAR (data);
2628 data = XCDR (data);
2629 Fputhash (key, val, ht);
2632 return ht;
2634 UNREAD (c);
2635 invalid_syntax ("#");
2637 if (c == '^')
2639 c = READCHAR;
2640 if (c == '[')
2642 Lisp_Object tmp;
2643 tmp = read_vector (readcharfun, 0);
2644 if (ASIZE (tmp) < CHAR_TABLE_STANDARD_SLOTS)
2645 error ("Invalid size char-table");
2646 XSETPVECTYPE (XVECTOR (tmp), PVEC_CHAR_TABLE);
2647 return tmp;
2649 else if (c == '^')
2651 c = READCHAR;
2652 if (c == '[')
2654 /* Sub char-table can't be read as a regular
2655 vector because of a two C integer fields. */
2656 Lisp_Object tbl, tmp = read_list (1, readcharfun);
2657 ptrdiff_t size = XINT (Flength (tmp));
2658 int i, depth, min_char;
2659 struct Lisp_Cons *cell;
2661 if (size == 0)
2662 error ("Zero-sized sub char-table");
2664 if (! RANGED_INTEGERP (1, XCAR (tmp), 3))
2665 error ("Invalid depth in sub char-table");
2666 depth = XINT (XCAR (tmp));
2667 if (chartab_size[depth] != size - 2)
2668 error ("Invalid size in sub char-table");
2669 cell = XCONS (tmp), tmp = XCDR (tmp), size--;
2670 free_cons (cell);
2672 if (! RANGED_INTEGERP (0, XCAR (tmp), MAX_CHAR))
2673 error ("Invalid minimum character in sub-char-table");
2674 min_char = XINT (XCAR (tmp));
2675 cell = XCONS (tmp), tmp = XCDR (tmp), size--;
2676 free_cons (cell);
2678 tbl = make_uninit_sub_char_table (depth, min_char);
2679 for (i = 0; i < size; i++)
2681 XSUB_CHAR_TABLE (tbl)->contents[i] = XCAR (tmp);
2682 cell = XCONS (tmp), tmp = XCDR (tmp);
2683 free_cons (cell);
2685 return tbl;
2687 invalid_syntax ("#^^");
2689 invalid_syntax ("#^");
2691 if (c == '&')
2693 Lisp_Object length;
2694 length = read1 (readcharfun, pch, first_in_list);
2695 c = READCHAR;
2696 if (c == '"')
2698 Lisp_Object tmp, val;
2699 EMACS_INT size_in_chars = bool_vector_bytes (XFASTINT (length));
2700 unsigned char *data;
2702 UNREAD (c);
2703 tmp = read1 (readcharfun, pch, first_in_list);
2704 if (STRING_MULTIBYTE (tmp)
2705 || (size_in_chars != SCHARS (tmp)
2706 /* We used to print 1 char too many
2707 when the number of bits was a multiple of 8.
2708 Accept such input in case it came from an old
2709 version. */
2710 && ! (XFASTINT (length)
2711 == (SCHARS (tmp) - 1) * BOOL_VECTOR_BITS_PER_CHAR)))
2712 invalid_syntax ("#&...");
2714 val = make_uninit_bool_vector (XFASTINT (length));
2715 data = bool_vector_uchar_data (val);
2716 memcpy (data, SDATA (tmp), size_in_chars);
2717 /* Clear the extraneous bits in the last byte. */
2718 if (XINT (length) != size_in_chars * BOOL_VECTOR_BITS_PER_CHAR)
2719 data[size_in_chars - 1]
2720 &= (1 << (XINT (length) % BOOL_VECTOR_BITS_PER_CHAR)) - 1;
2721 return val;
2723 invalid_syntax ("#&...");
2725 if (c == '[')
2727 /* Accept compiled functions at read-time so that we don't have to
2728 build them using function calls. */
2729 Lisp_Object tmp;
2730 struct Lisp_Vector *vec;
2731 tmp = read_vector (readcharfun, 1);
2732 vec = XVECTOR (tmp);
2733 if (vec->header.size == 0)
2734 invalid_syntax ("Empty byte-code object");
2735 make_byte_code (vec);
2736 return tmp;
2738 if (c == '(')
2740 Lisp_Object tmp;
2741 int ch;
2743 /* Read the string itself. */
2744 tmp = read1 (readcharfun, &ch, 0);
2745 if (ch != 0 || !STRINGP (tmp))
2746 invalid_syntax ("#");
2747 /* Read the intervals and their properties. */
2748 while (1)
2750 Lisp_Object beg, end, plist;
2752 beg = read1 (readcharfun, &ch, 0);
2753 end = plist = Qnil;
2754 if (ch == ')')
2755 break;
2756 if (ch == 0)
2757 end = read1 (readcharfun, &ch, 0);
2758 if (ch == 0)
2759 plist = read1 (readcharfun, &ch, 0);
2760 if (ch)
2761 invalid_syntax ("Invalid string property list");
2762 Fset_text_properties (beg, end, plist, tmp);
2765 return tmp;
2768 /* #@NUMBER is used to skip NUMBER following bytes.
2769 That's used in .elc files to skip over doc strings
2770 and function definitions. */
2771 if (c == '@')
2773 enum { extra = 100 };
2774 ptrdiff_t i, nskip = 0, digits = 0;
2776 /* Read a decimal integer. */
2777 while ((c = READCHAR) >= 0
2778 && c >= '0' && c <= '9')
2780 if ((STRING_BYTES_BOUND - extra) / 10 <= nskip)
2781 string_overflow ();
2782 digits++;
2783 nskip *= 10;
2784 nskip += c - '0';
2785 if (digits == 2 && nskip == 0)
2786 { /* We've just seen #@00, which means "skip to end". */
2787 skip_dyn_eof (readcharfun);
2788 return Qnil;
2791 if (nskip > 0)
2792 /* We can't use UNREAD here, because in the code below we side-step
2793 READCHAR. Instead, assume the first char after #@NNN occupies
2794 a single byte, which is the case normally since it's just
2795 a space. */
2796 nskip--;
2797 else
2798 UNREAD (c);
2800 if (load_force_doc_strings
2801 && (FROM_FILE_P (readcharfun)))
2803 /* If we are supposed to force doc strings into core right now,
2804 record the last string that we skipped,
2805 and record where in the file it comes from. */
2807 /* But first exchange saved_doc_string
2808 with prev_saved_doc_string, so we save two strings. */
2810 char *temp = saved_doc_string;
2811 ptrdiff_t temp_size = saved_doc_string_size;
2812 file_offset temp_pos = saved_doc_string_position;
2813 ptrdiff_t temp_len = saved_doc_string_length;
2815 saved_doc_string = prev_saved_doc_string;
2816 saved_doc_string_size = prev_saved_doc_string_size;
2817 saved_doc_string_position = prev_saved_doc_string_position;
2818 saved_doc_string_length = prev_saved_doc_string_length;
2820 prev_saved_doc_string = temp;
2821 prev_saved_doc_string_size = temp_size;
2822 prev_saved_doc_string_position = temp_pos;
2823 prev_saved_doc_string_length = temp_len;
2826 if (saved_doc_string_size == 0)
2828 saved_doc_string = xmalloc (nskip + extra);
2829 saved_doc_string_size = nskip + extra;
2831 if (nskip > saved_doc_string_size)
2833 saved_doc_string = xrealloc (saved_doc_string, nskip + extra);
2834 saved_doc_string_size = nskip + extra;
2837 saved_doc_string_position = file_tell (instream);
2839 /* Copy that many characters into saved_doc_string. */
2840 block_input ();
2841 for (i = 0; i < nskip && c >= 0; i++)
2842 saved_doc_string[i] = c = getc (instream);
2843 unblock_input ();
2845 saved_doc_string_length = i;
2847 else
2848 /* Skip that many bytes. */
2849 skip_dyn_bytes (readcharfun, nskip);
2851 goto retry;
2853 if (c == '!')
2855 /* #! appears at the beginning of an executable file.
2856 Skip the first line. */
2857 while (c != '\n' && c >= 0)
2858 c = READCHAR;
2859 goto retry;
2861 if (c == '$')
2862 return Vload_file_name;
2863 if (c == '\'')
2864 return list2 (Qfunction, read0 (readcharfun));
2865 /* #:foo is the uninterned symbol named foo. */
2866 if (c == ':')
2868 uninterned_symbol = 1;
2869 c = READCHAR;
2870 if (!(c > 040
2871 && c != NO_BREAK_SPACE
2872 && (c >= 0200
2873 || strchr ("\"';()[]#`,", c) == NULL)))
2875 /* No symbol character follows, this is the empty
2876 symbol. */
2877 UNREAD (c);
2878 return Fmake_symbol (empty_unibyte_string);
2880 goto read_symbol;
2882 /* ## is the empty symbol. */
2883 if (c == '#')
2884 return Fintern (empty_unibyte_string, Qnil);
2885 /* Reader forms that can reuse previously read objects. */
2886 if (c >= '0' && c <= '9')
2888 EMACS_INT n = 0;
2889 Lisp_Object tem;
2891 /* Read a non-negative integer. */
2892 while (c >= '0' && c <= '9')
2894 if (MOST_POSITIVE_FIXNUM / 10 < n
2895 || MOST_POSITIVE_FIXNUM < n * 10 + c - '0')
2896 n = MOST_POSITIVE_FIXNUM + 1;
2897 else
2898 n = n * 10 + c - '0';
2899 c = READCHAR;
2902 if (n <= MOST_POSITIVE_FIXNUM)
2904 if (c == 'r' || c == 'R')
2905 return read_integer (readcharfun, n);
2907 if (! NILP (Vread_circle))
2909 /* #n=object returns object, but associates it with
2910 n for #n#. */
2911 if (c == '=')
2913 /* Make a placeholder for #n# to use temporarily. */
2914 AUTO_CONS (placeholder, Qnil, Qnil);
2915 Lisp_Object cell = Fcons (make_number (n), placeholder);
2916 read_objects = Fcons (cell, read_objects);
2918 /* Read the object itself. */
2919 tem = read0 (readcharfun);
2921 /* Now put it everywhere the placeholder was... */
2922 substitute_object_in_subtree (tem, placeholder);
2924 /* ...and #n# will use the real value from now on. */
2925 Fsetcdr (cell, tem);
2927 return tem;
2930 /* #n# returns a previously read object. */
2931 if (c == '#')
2933 tem = Fassq (make_number (n), read_objects);
2934 if (CONSP (tem))
2935 return XCDR (tem);
2939 /* Fall through to error message. */
2941 else if (c == 'x' || c == 'X')
2942 return read_integer (readcharfun, 16);
2943 else if (c == 'o' || c == 'O')
2944 return read_integer (readcharfun, 8);
2945 else if (c == 'b' || c == 'B')
2946 return read_integer (readcharfun, 2);
2948 UNREAD (c);
2949 invalid_syntax ("#");
2951 case ';':
2952 while ((c = READCHAR) >= 0 && c != '\n');
2953 goto retry;
2955 case '\'':
2956 return list2 (Qquote, read0 (readcharfun));
2958 case '`':
2960 int next_char = READCHAR;
2961 UNREAD (next_char);
2962 /* Transition from old-style to new-style:
2963 If we see "(`" it used to mean old-style, which usually works
2964 fine because ` should almost never appear in such a position
2965 for new-style. But occasionally we need "(`" to mean new
2966 style, so we try to distinguish the two by the fact that we
2967 can either write "( `foo" or "(` foo", where the first
2968 intends to use new-style whereas the second intends to use
2969 old-style. For Emacs-25, we should completely remove this
2970 first_in_list exception (old-style can still be obtained via
2971 "(\`" anyway). */
2972 if (!new_backquote_flag && first_in_list && next_char == ' ')
2974 Vold_style_backquotes = Qt;
2975 goto default_label;
2977 else
2979 Lisp_Object value;
2980 bool saved_new_backquote_flag = new_backquote_flag;
2982 new_backquote_flag = 1;
2983 value = read0 (readcharfun);
2984 new_backquote_flag = saved_new_backquote_flag;
2986 return list2 (Qbackquote, value);
2989 case ',':
2991 int next_char = READCHAR;
2992 UNREAD (next_char);
2993 /* Transition from old-style to new-style:
2994 It used to be impossible to have a new-style , other than within
2995 a new-style `. This is sufficient when ` and , are used in the
2996 normal way, but ` and , can also appear in args to macros that
2997 will not interpret them in the usual way, in which case , may be
2998 used without any ` anywhere near.
2999 So we now use the same heuristic as for backquote: old-style
3000 unquotes are only recognized when first on a list, and when
3001 followed by a space.
3002 Because it's more difficult to peek 2 chars ahead, a new-style
3003 ,@ can still not be used outside of a `, unless it's in the middle
3004 of a list. */
3005 if (new_backquote_flag
3006 || !first_in_list
3007 || (next_char != ' ' && next_char != '@'))
3009 Lisp_Object comma_type = Qnil;
3010 Lisp_Object value;
3011 int ch = READCHAR;
3013 if (ch == '@')
3014 comma_type = Qcomma_at;
3015 else if (ch == '.')
3016 comma_type = Qcomma_dot;
3017 else
3019 if (ch >= 0) UNREAD (ch);
3020 comma_type = Qcomma;
3023 value = read0 (readcharfun);
3024 return list2 (comma_type, value);
3026 else
3028 Vold_style_backquotes = Qt;
3029 goto default_label;
3032 case '?':
3034 int modifiers;
3035 int next_char;
3036 bool ok;
3038 c = READCHAR;
3039 if (c < 0)
3040 end_of_file_error ();
3042 /* Accept `single space' syntax like (list ? x) where the
3043 whitespace character is SPC or TAB.
3044 Other literal whitespace like NL, CR, and FF are not accepted,
3045 as there are well-established escape sequences for these. */
3046 if (c == ' ' || c == '\t')
3047 return make_number (c);
3049 if (c == '\\')
3050 c = read_escape (readcharfun, 0);
3051 modifiers = c & CHAR_MODIFIER_MASK;
3052 c &= ~CHAR_MODIFIER_MASK;
3053 if (CHAR_BYTE8_P (c))
3054 c = CHAR_TO_BYTE8 (c);
3055 c |= modifiers;
3057 next_char = READCHAR;
3058 ok = (next_char <= 040
3059 || (next_char < 0200
3060 && strchr ("\"';()[]#?`,.", next_char) != NULL));
3061 UNREAD (next_char);
3062 if (ok)
3063 return make_number (c);
3065 invalid_syntax ("?");
3068 case '"':
3070 char *p = read_buffer;
3071 char *end = read_buffer + read_buffer_size;
3072 int ch;
3073 /* True if we saw an escape sequence specifying
3074 a multibyte character. */
3075 bool force_multibyte = 0;
3076 /* True if we saw an escape sequence specifying
3077 a single-byte character. */
3078 bool force_singlebyte = 0;
3079 bool cancel = 0;
3080 ptrdiff_t nchars = 0;
3082 while ((ch = READCHAR) >= 0
3083 && ch != '\"')
3085 if (end - p < MAX_MULTIBYTE_LENGTH)
3087 ptrdiff_t offset = p - read_buffer;
3088 grow_read_buffer ();
3089 p = read_buffer + offset;
3090 end = read_buffer + read_buffer_size;
3093 if (ch == '\\')
3095 int modifiers;
3097 ch = read_escape (readcharfun, 1);
3099 /* CH is -1 if \ newline or \ space has just been seen. */
3100 if (ch == -1)
3102 if (p == read_buffer)
3103 cancel = 1;
3104 continue;
3107 modifiers = ch & CHAR_MODIFIER_MASK;
3108 ch = ch & ~CHAR_MODIFIER_MASK;
3110 if (CHAR_BYTE8_P (ch))
3111 force_singlebyte = 1;
3112 else if (! ASCII_CHAR_P (ch))
3113 force_multibyte = 1;
3114 else /* I.e. ASCII_CHAR_P (ch). */
3116 /* Allow `\C- ' and `\C-?'. */
3117 if (modifiers == CHAR_CTL)
3119 if (ch == ' ')
3120 ch = 0, modifiers = 0;
3121 else if (ch == '?')
3122 ch = 127, modifiers = 0;
3124 if (modifiers & CHAR_SHIFT)
3126 /* Shift modifier is valid only with [A-Za-z]. */
3127 if (ch >= 'A' && ch <= 'Z')
3128 modifiers &= ~CHAR_SHIFT;
3129 else if (ch >= 'a' && ch <= 'z')
3130 ch -= ('a' - 'A'), modifiers &= ~CHAR_SHIFT;
3133 if (modifiers & CHAR_META)
3135 /* Move the meta bit to the right place for a
3136 string. */
3137 modifiers &= ~CHAR_META;
3138 ch = BYTE8_TO_CHAR (ch | 0x80);
3139 force_singlebyte = 1;
3143 /* Any modifiers remaining are invalid. */
3144 if (modifiers)
3145 error ("Invalid modifier in string");
3146 p += CHAR_STRING (ch, (unsigned char *) p);
3148 else
3150 p += CHAR_STRING (ch, (unsigned char *) p);
3151 if (CHAR_BYTE8_P (ch))
3152 force_singlebyte = 1;
3153 else if (! ASCII_CHAR_P (ch))
3154 force_multibyte = 1;
3156 nchars++;
3159 if (ch < 0)
3160 end_of_file_error ();
3162 /* If purifying, and string starts with \ newline,
3163 return zero instead. This is for doc strings
3164 that we are really going to find in etc/DOC.nn.nn. */
3165 if (!NILP (Vpurify_flag) && NILP (Vdoc_file_name) && cancel)
3166 return make_number (0);
3168 if (! force_multibyte && force_singlebyte)
3170 /* READ_BUFFER contains raw 8-bit bytes and no multibyte
3171 forms. Convert it to unibyte. */
3172 nchars = str_as_unibyte ((unsigned char *) read_buffer,
3173 p - read_buffer);
3174 p = read_buffer + nchars;
3177 return make_specified_string (read_buffer, nchars, p - read_buffer,
3178 (force_multibyte
3179 || (p - read_buffer != nchars)));
3182 case '.':
3184 int next_char = READCHAR;
3185 UNREAD (next_char);
3187 if (next_char <= 040
3188 || (next_char < 0200
3189 && strchr ("\"';([#?`,", next_char) != NULL))
3191 *pch = c;
3192 return Qnil;
3195 /* Otherwise, we fall through! Note that the atom-reading loop
3196 below will now loop at least once, assuring that we will not
3197 try to UNREAD two characters in a row. */
3199 default:
3200 default_label:
3201 if (c <= 040) goto retry;
3202 if (c == NO_BREAK_SPACE)
3203 goto retry;
3205 read_symbol:
3207 char *p = read_buffer;
3208 bool quoted = 0;
3209 EMACS_INT start_position = readchar_count - 1;
3212 char *end = read_buffer + read_buffer_size;
3216 if (end - p < MAX_MULTIBYTE_LENGTH)
3218 ptrdiff_t offset = p - read_buffer;
3219 grow_read_buffer ();
3220 p = read_buffer + offset;
3221 end = read_buffer + read_buffer_size;
3224 if (c == '\\')
3226 c = READCHAR;
3227 if (c == -1)
3228 end_of_file_error ();
3229 quoted = 1;
3232 if (multibyte)
3233 p += CHAR_STRING (c, (unsigned char *) p);
3234 else
3235 *p++ = c;
3236 c = READCHAR;
3238 while (c > 040
3239 && c != NO_BREAK_SPACE
3240 && (c >= 0200
3241 || strchr ("\"';()[]#`,", c) == NULL));
3243 if (p == end)
3245 ptrdiff_t offset = p - read_buffer;
3246 grow_read_buffer ();
3247 p = read_buffer + offset;
3248 end = read_buffer + read_buffer_size;
3250 *p = 0;
3251 UNREAD (c);
3254 if (!quoted && !uninterned_symbol)
3256 Lisp_Object result = string_to_number (read_buffer, 10, 0);
3257 if (! NILP (result))
3258 return result;
3261 Lisp_Object name, result;
3262 ptrdiff_t nbytes = p - read_buffer;
3263 ptrdiff_t nchars
3264 = (multibyte
3265 ? multibyte_chars_in_text ((unsigned char *) read_buffer,
3266 nbytes)
3267 : nbytes);
3269 name = ((uninterned_symbol && ! NILP (Vpurify_flag)
3270 ? make_pure_string : make_specified_string)
3271 (read_buffer, nchars, nbytes, multibyte));
3272 result = (uninterned_symbol ? Fmake_symbol (name)
3273 : Fintern (name, Qnil));
3275 if (EQ (Vread_with_symbol_positions, Qt)
3276 || EQ (Vread_with_symbol_positions, readcharfun))
3277 Vread_symbol_positions_list
3278 = Fcons (Fcons (result, make_number (start_position)),
3279 Vread_symbol_positions_list);
3280 return result;
3287 /* List of nodes we've seen during substitute_object_in_subtree. */
3288 static Lisp_Object seen_list;
3290 static void
3291 substitute_object_in_subtree (Lisp_Object object, Lisp_Object placeholder)
3293 Lisp_Object check_object;
3295 /* We haven't seen any objects when we start. */
3296 seen_list = Qnil;
3298 /* Make all the substitutions. */
3299 check_object
3300 = substitute_object_recurse (object, placeholder, object);
3302 /* Clear seen_list because we're done with it. */
3303 seen_list = Qnil;
3305 /* The returned object here is expected to always eq the
3306 original. */
3307 if (!EQ (check_object, object))
3308 error ("Unexpected mutation error in reader");
3311 /* Feval doesn't get called from here, so no gc protection is needed. */
3312 #define SUBSTITUTE(get_val, set_val) \
3313 do { \
3314 Lisp_Object old_value = get_val; \
3315 Lisp_Object true_value \
3316 = substitute_object_recurse (object, placeholder, \
3317 old_value); \
3319 if (!EQ (old_value, true_value)) \
3321 set_val; \
3323 } while (0)
3325 static Lisp_Object
3326 substitute_object_recurse (Lisp_Object object, Lisp_Object placeholder, Lisp_Object subtree)
3328 /* If we find the placeholder, return the target object. */
3329 if (EQ (placeholder, subtree))
3330 return object;
3332 /* If we've been to this node before, don't explore it again. */
3333 if (!EQ (Qnil, Fmemq (subtree, seen_list)))
3334 return subtree;
3336 /* If this node can be the entry point to a cycle, remember that
3337 we've seen it. It can only be such an entry point if it was made
3338 by #n=, which means that we can find it as a value in
3339 read_objects. */
3340 if (!EQ (Qnil, Frassq (subtree, read_objects)))
3341 seen_list = Fcons (subtree, seen_list);
3343 /* Recurse according to subtree's type.
3344 Every branch must return a Lisp_Object. */
3345 switch (XTYPE (subtree))
3347 case Lisp_Vectorlike:
3349 ptrdiff_t i = 0, length = 0;
3350 if (BOOL_VECTOR_P (subtree))
3351 return subtree; /* No sub-objects anyway. */
3352 else if (CHAR_TABLE_P (subtree) || SUB_CHAR_TABLE_P (subtree)
3353 || COMPILEDP (subtree) || HASH_TABLE_P (subtree))
3354 length = ASIZE (subtree) & PSEUDOVECTOR_SIZE_MASK;
3355 else if (VECTORP (subtree))
3356 length = ASIZE (subtree);
3357 else
3358 /* An unknown pseudovector may contain non-Lisp fields, so we
3359 can't just blindly traverse all its fields. We used to call
3360 `Flength' which signaled `sequencep', so I just preserved this
3361 behavior. */
3362 wrong_type_argument (Qsequencep, subtree);
3364 if (SUB_CHAR_TABLE_P (subtree))
3365 i = 2;
3366 for ( ; i < length; i++)
3367 SUBSTITUTE (AREF (subtree, i),
3368 ASET (subtree, i, true_value));
3369 return subtree;
3372 case Lisp_Cons:
3374 SUBSTITUTE (XCAR (subtree),
3375 XSETCAR (subtree, true_value));
3376 SUBSTITUTE (XCDR (subtree),
3377 XSETCDR (subtree, true_value));
3378 return subtree;
3381 case Lisp_String:
3383 /* Check for text properties in each interval.
3384 substitute_in_interval contains part of the logic. */
3386 INTERVAL root_interval = string_intervals (subtree);
3387 AUTO_CONS (arg, object, placeholder);
3389 traverse_intervals_noorder (root_interval,
3390 &substitute_in_interval, arg);
3392 return subtree;
3395 /* Other types don't recurse any further. */
3396 default:
3397 return subtree;
3401 /* Helper function for substitute_object_recurse. */
3402 static void
3403 substitute_in_interval (INTERVAL interval, Lisp_Object arg)
3405 Lisp_Object object = Fcar (arg);
3406 Lisp_Object placeholder = Fcdr (arg);
3408 SUBSTITUTE (interval->plist, set_interval_plist (interval, true_value));
3412 #define LEAD_INT 1
3413 #define DOT_CHAR 2
3414 #define TRAIL_INT 4
3415 #define E_EXP 16
3418 /* Convert STRING to a number, assuming base BASE. Return a fixnum if CP has
3419 integer syntax and fits in a fixnum, else return the nearest float if CP has
3420 either floating point or integer syntax and BASE is 10, else return nil. If
3421 IGNORE_TRAILING, consider just the longest prefix of CP that has
3422 valid floating point syntax. Signal an overflow if BASE is not 10 and the
3423 number has integer syntax but does not fit. */
3425 Lisp_Object
3426 string_to_number (char const *string, int base, bool ignore_trailing)
3428 int state;
3429 char const *cp = string;
3430 int leading_digit;
3431 bool float_syntax = 0;
3432 double value = 0;
3434 /* Negate the value ourselves. This treats 0, NaNs, and infinity properly on
3435 IEEE floating point hosts, and works around a formerly-common bug where
3436 atof ("-0.0") drops the sign. */
3437 bool negative = *cp == '-';
3439 bool signedp = negative || *cp == '+';
3440 cp += signedp;
3442 state = 0;
3444 leading_digit = digit_to_number (*cp, base);
3445 if (leading_digit >= 0)
3447 state |= LEAD_INT;
3449 ++cp;
3450 while (digit_to_number (*cp, base) >= 0);
3452 if (*cp == '.')
3454 state |= DOT_CHAR;
3455 cp++;
3458 if (base == 10)
3460 if ('0' <= *cp && *cp <= '9')
3462 state |= TRAIL_INT;
3464 cp++;
3465 while ('0' <= *cp && *cp <= '9');
3467 if (*cp == 'e' || *cp == 'E')
3469 char const *ecp = cp;
3470 cp++;
3471 if (*cp == '+' || *cp == '-')
3472 cp++;
3473 if ('0' <= *cp && *cp <= '9')
3475 state |= E_EXP;
3477 cp++;
3478 while ('0' <= *cp && *cp <= '9');
3480 else if (cp[-1] == '+'
3481 && cp[0] == 'I' && cp[1] == 'N' && cp[2] == 'F')
3483 state |= E_EXP;
3484 cp += 3;
3485 value = INFINITY;
3487 else if (cp[-1] == '+'
3488 && cp[0] == 'N' && cp[1] == 'a' && cp[2] == 'N')
3490 state |= E_EXP;
3491 cp += 3;
3492 /* NAN is a "positive" NaN on all known Emacs hosts. */
3493 value = NAN;
3495 else
3496 cp = ecp;
3499 float_syntax = ((state & (DOT_CHAR|TRAIL_INT)) == (DOT_CHAR|TRAIL_INT)
3500 || state == (LEAD_INT|E_EXP));
3503 /* Return nil if the number uses invalid syntax. If IGNORE_TRAILING, accept
3504 any prefix that matches. Otherwise, the entire string must match. */
3505 if (! (ignore_trailing
3506 ? ((state & LEAD_INT) != 0 || float_syntax)
3507 : (!*cp && ((state & ~DOT_CHAR) == LEAD_INT || float_syntax))))
3508 return Qnil;
3510 /* If the number uses integer and not float syntax, and is in C-language
3511 range, use its value, preferably as a fixnum. */
3512 if (leading_digit >= 0 && ! float_syntax)
3514 uintmax_t n;
3516 /* Fast special case for single-digit integers. This also avoids a
3517 glitch when BASE is 16 and IGNORE_TRAILING, because in that
3518 case some versions of strtoumax accept numbers like "0x1" that Emacs
3519 does not allow. */
3520 if (digit_to_number (string[signedp + 1], base) < 0)
3521 return make_number (negative ? -leading_digit : leading_digit);
3523 errno = 0;
3524 n = strtoumax (string + signedp, NULL, base);
3525 if (errno == ERANGE)
3527 /* Unfortunately there's no simple and accurate way to convert
3528 non-base-10 numbers that are out of C-language range. */
3529 if (base != 10)
3530 xsignal1 (Qoverflow_error, build_string (string));
3532 else if (n <= (negative ? -MOST_NEGATIVE_FIXNUM : MOST_POSITIVE_FIXNUM))
3534 EMACS_INT signed_n = n;
3535 return make_number (negative ? -signed_n : signed_n);
3537 else
3538 value = n;
3541 /* Either the number uses float syntax, or it does not fit into a fixnum.
3542 Convert it from string to floating point, unless the value is already
3543 known because it is an infinity, a NAN, or its absolute value fits in
3544 uintmax_t. */
3545 if (! value)
3546 value = atof (string + signedp);
3548 return make_float (negative ? -value : value);
3552 static Lisp_Object
3553 read_vector (Lisp_Object readcharfun, bool bytecodeflag)
3555 ptrdiff_t i, size;
3556 Lisp_Object *ptr;
3557 Lisp_Object tem, item, vector;
3558 struct Lisp_Cons *otem;
3559 Lisp_Object len;
3561 tem = read_list (1, readcharfun);
3562 len = Flength (tem);
3563 vector = Fmake_vector (len, Qnil);
3565 size = ASIZE (vector);
3566 ptr = XVECTOR (vector)->contents;
3567 for (i = 0; i < size; i++)
3569 item = Fcar (tem);
3570 /* If `load-force-doc-strings' is t when reading a lazily-loaded
3571 bytecode object, the docstring containing the bytecode and
3572 constants values must be treated as unibyte and passed to
3573 Fread, to get the actual bytecode string and constants vector. */
3574 if (bytecodeflag && load_force_doc_strings)
3576 if (i == COMPILED_BYTECODE)
3578 if (!STRINGP (item))
3579 error ("Invalid byte code");
3581 /* Delay handling the bytecode slot until we know whether
3582 it is lazily-loaded (we can tell by whether the
3583 constants slot is nil). */
3584 ASET (vector, COMPILED_CONSTANTS, item);
3585 item = Qnil;
3587 else if (i == COMPILED_CONSTANTS)
3589 Lisp_Object bytestr = ptr[COMPILED_CONSTANTS];
3591 if (NILP (item))
3593 /* Coerce string to unibyte (like string-as-unibyte,
3594 but without generating extra garbage and
3595 guaranteeing no change in the contents). */
3596 STRING_SET_CHARS (bytestr, SBYTES (bytestr));
3597 STRING_SET_UNIBYTE (bytestr);
3599 item = Fread (Fcons (bytestr, readcharfun));
3600 if (!CONSP (item))
3601 error ("Invalid byte code");
3603 otem = XCONS (item);
3604 bytestr = XCAR (item);
3605 item = XCDR (item);
3606 free_cons (otem);
3609 /* Now handle the bytecode slot. */
3610 ASET (vector, COMPILED_BYTECODE, bytestr);
3612 else if (i == COMPILED_DOC_STRING
3613 && STRINGP (item)
3614 && ! STRING_MULTIBYTE (item))
3616 if (EQ (readcharfun, Qget_emacs_mule_file_char))
3617 item = Fdecode_coding_string (item, Qemacs_mule, Qnil, Qnil);
3618 else
3619 item = Fstring_as_multibyte (item);
3622 ASET (vector, i, item);
3623 otem = XCONS (tem);
3624 tem = Fcdr (tem);
3625 free_cons (otem);
3627 return vector;
3630 /* FLAG means check for ']' to terminate rather than ')' and '.'. */
3632 static Lisp_Object
3633 read_list (bool flag, Lisp_Object readcharfun)
3635 Lisp_Object val, tail;
3636 Lisp_Object elt, tem;
3637 /* 0 is the normal case.
3638 1 means this list is a doc reference; replace it with the number 0.
3639 2 means this list is a doc reference; replace it with the doc string. */
3640 int doc_reference = 0;
3642 /* Initialize this to 1 if we are reading a list. */
3643 bool first_in_list = flag <= 0;
3645 val = Qnil;
3646 tail = Qnil;
3648 while (1)
3650 int ch;
3651 elt = read1 (readcharfun, &ch, first_in_list);
3653 first_in_list = 0;
3655 /* While building, if the list starts with #$, treat it specially. */
3656 if (EQ (elt, Vload_file_name)
3657 && ! NILP (elt)
3658 && !NILP (Vpurify_flag))
3660 if (NILP (Vdoc_file_name))
3661 /* We have not yet called Snarf-documentation, so assume
3662 this file is described in the DOC file
3663 and Snarf-documentation will fill in the right value later.
3664 For now, replace the whole list with 0. */
3665 doc_reference = 1;
3666 else
3667 /* We have already called Snarf-documentation, so make a relative
3668 file name for this file, so it can be found properly
3669 in the installed Lisp directory.
3670 We don't use Fexpand_file_name because that would make
3671 the directory absolute now. */
3673 AUTO_STRING (dot_dot_lisp, "../lisp/");
3674 elt = concat2 (dot_dot_lisp, Ffile_name_nondirectory (elt));
3677 else if (EQ (elt, Vload_file_name)
3678 && ! NILP (elt)
3679 && load_force_doc_strings)
3680 doc_reference = 2;
3682 if (ch)
3684 if (flag > 0)
3686 if (ch == ']')
3687 return val;
3688 invalid_syntax (") or . in a vector");
3690 if (ch == ')')
3691 return val;
3692 if (ch == '.')
3694 if (!NILP (tail))
3695 XSETCDR (tail, read0 (readcharfun));
3696 else
3697 val = read0 (readcharfun);
3698 read1 (readcharfun, &ch, 0);
3700 if (ch == ')')
3702 if (doc_reference == 1)
3703 return make_number (0);
3704 if (doc_reference == 2 && INTEGERP (XCDR (val)))
3706 char *saved = NULL;
3707 file_offset saved_position;
3708 /* Get a doc string from the file we are loading.
3709 If it's in saved_doc_string, get it from there.
3711 Here, we don't know if the string is a
3712 bytecode string or a doc string. As a
3713 bytecode string must be unibyte, we always
3714 return a unibyte string. If it is actually a
3715 doc string, caller must make it
3716 multibyte. */
3718 /* Position is negative for user variables. */
3719 EMACS_INT pos = eabs (XINT (XCDR (val)));
3720 if (pos >= saved_doc_string_position
3721 && pos < (saved_doc_string_position
3722 + saved_doc_string_length))
3724 saved = saved_doc_string;
3725 saved_position = saved_doc_string_position;
3727 /* Look in prev_saved_doc_string the same way. */
3728 else if (pos >= prev_saved_doc_string_position
3729 && pos < (prev_saved_doc_string_position
3730 + prev_saved_doc_string_length))
3732 saved = prev_saved_doc_string;
3733 saved_position = prev_saved_doc_string_position;
3735 if (saved)
3737 ptrdiff_t start = pos - saved_position;
3738 ptrdiff_t from, to;
3740 /* Process quoting with ^A,
3741 and find the end of the string,
3742 which is marked with ^_ (037). */
3743 for (from = start, to = start;
3744 saved[from] != 037;)
3746 int c = saved[from++];
3747 if (c == 1)
3749 c = saved[from++];
3750 saved[to++] = (c == 1 ? c
3751 : c == '0' ? 0
3752 : c == '_' ? 037
3753 : c);
3755 else
3756 saved[to++] = c;
3759 return make_unibyte_string (saved + start,
3760 to - start);
3762 else
3763 return get_doc_string (val, 1, 0);
3766 return val;
3768 invalid_syntax (". in wrong context");
3770 invalid_syntax ("] in a list");
3772 tem = list1 (elt);
3773 if (!NILP (tail))
3774 XSETCDR (tail, tem);
3775 else
3776 val = tem;
3777 tail = tem;
3781 static Lisp_Object initial_obarray;
3783 /* `oblookup' stores the bucket number here, for the sake of Funintern. */
3785 static size_t oblookup_last_bucket_number;
3787 /* Get an error if OBARRAY is not an obarray.
3788 If it is one, return it. */
3790 Lisp_Object
3791 check_obarray (Lisp_Object obarray)
3793 /* We don't want to signal a wrong-type-argument error when we are
3794 shutting down due to a fatal error, and we don't want to hit
3795 assertions in VECTORP and ASIZE if the fatal error was during GC. */
3796 if (!fatal_error_in_progress
3797 && (!VECTORP (obarray) || ASIZE (obarray) == 0))
3799 /* If Vobarray is now invalid, force it to be valid. */
3800 if (EQ (Vobarray, obarray)) Vobarray = initial_obarray;
3801 wrong_type_argument (Qvectorp, obarray);
3803 return obarray;
3806 /* Intern symbol SYM in OBARRAY using bucket INDEX. */
3808 static Lisp_Object
3809 intern_sym (Lisp_Object sym, Lisp_Object obarray, Lisp_Object index)
3811 Lisp_Object *ptr;
3813 XSYMBOL (sym)->interned = (EQ (obarray, initial_obarray)
3814 ? SYMBOL_INTERNED_IN_INITIAL_OBARRAY
3815 : SYMBOL_INTERNED);
3817 if (SREF (SYMBOL_NAME (sym), 0) == ':' && EQ (obarray, initial_obarray))
3819 XSYMBOL (sym)->constant = 1;
3820 XSYMBOL (sym)->redirect = SYMBOL_PLAINVAL;
3821 SET_SYMBOL_VAL (XSYMBOL (sym), sym);
3824 ptr = aref_addr (obarray, XINT (index));
3825 set_symbol_next (sym, SYMBOLP (*ptr) ? XSYMBOL (*ptr) : NULL);
3826 *ptr = sym;
3827 return sym;
3830 /* Intern a symbol with name STRING in OBARRAY using bucket INDEX. */
3832 Lisp_Object
3833 intern_driver (Lisp_Object string, Lisp_Object obarray, Lisp_Object index)
3835 return intern_sym (Fmake_symbol (string), obarray, index);
3838 /* Intern the C string STR: return a symbol with that name,
3839 interned in the current obarray. */
3841 Lisp_Object
3842 intern_1 (const char *str, ptrdiff_t len)
3844 Lisp_Object obarray = check_obarray (Vobarray);
3845 Lisp_Object tem = oblookup (obarray, str, len, len);
3847 return (SYMBOLP (tem) ? tem
3848 /* The above `oblookup' was done on the basis of nchars==nbytes, so
3849 the string has to be unibyte. */
3850 : intern_driver (make_unibyte_string (str, len),
3851 obarray, tem));
3854 Lisp_Object
3855 intern_c_string_1 (const char *str, ptrdiff_t len)
3857 Lisp_Object obarray = check_obarray (Vobarray);
3858 Lisp_Object tem = oblookup (obarray, str, len, len);
3860 if (!SYMBOLP (tem))
3862 /* Creating a non-pure string from a string literal not implemented yet.
3863 We could just use make_string here and live with the extra copy. */
3864 eassert (!NILP (Vpurify_flag));
3865 tem = intern_driver (make_pure_c_string (str, len), obarray, tem);
3867 return tem;
3870 static void
3871 define_symbol (Lisp_Object sym, char const *str)
3873 ptrdiff_t len = strlen (str);
3874 Lisp_Object string = make_pure_c_string (str, len);
3875 init_symbol (sym, string);
3877 /* Qunbound is uninterned, so that it's not confused with any symbol
3878 'unbound' created by a Lisp program. */
3879 if (! EQ (sym, Qunbound))
3881 Lisp_Object bucket = oblookup (initial_obarray, str, len, len);
3882 eassert (INTEGERP (bucket));
3883 intern_sym (sym, initial_obarray, bucket);
3887 DEFUN ("intern", Fintern, Sintern, 1, 2, 0,
3888 doc: /* Return the canonical symbol whose name is STRING.
3889 If there is none, one is created by this function and returned.
3890 A second optional argument specifies the obarray to use;
3891 it defaults to the value of `obarray'. */)
3892 (Lisp_Object string, Lisp_Object obarray)
3894 Lisp_Object tem;
3896 obarray = check_obarray (NILP (obarray) ? Vobarray : obarray);
3897 CHECK_STRING (string);
3899 tem = oblookup (obarray, SSDATA (string), SCHARS (string), SBYTES (string));
3900 if (!SYMBOLP (tem))
3901 tem = intern_driver (NILP (Vpurify_flag) ? string : Fpurecopy (string),
3902 obarray, tem);
3903 return tem;
3906 DEFUN ("intern-soft", Fintern_soft, Sintern_soft, 1, 2, 0,
3907 doc: /* Return the canonical symbol named NAME, or nil if none exists.
3908 NAME may be a string or a symbol. If it is a symbol, that exact
3909 symbol is searched for.
3910 A second optional argument specifies the obarray to use;
3911 it defaults to the value of `obarray'. */)
3912 (Lisp_Object name, Lisp_Object obarray)
3914 register Lisp_Object tem, string;
3916 if (NILP (obarray)) obarray = Vobarray;
3917 obarray = check_obarray (obarray);
3919 if (!SYMBOLP (name))
3921 CHECK_STRING (name);
3922 string = name;
3924 else
3925 string = SYMBOL_NAME (name);
3927 tem = oblookup (obarray, SSDATA (string), SCHARS (string), SBYTES (string));
3928 if (INTEGERP (tem) || (SYMBOLP (name) && !EQ (name, tem)))
3929 return Qnil;
3930 else
3931 return tem;
3934 DEFUN ("unintern", Funintern, Sunintern, 1, 2, 0,
3935 doc: /* Delete the symbol named NAME, if any, from OBARRAY.
3936 The value is t if a symbol was found and deleted, nil otherwise.
3937 NAME may be a string or a symbol. If it is a symbol, that symbol
3938 is deleted, if it belongs to OBARRAY--no other symbol is deleted.
3939 OBARRAY, if nil, defaults to the value of the variable `obarray'.
3940 usage: (unintern NAME OBARRAY) */)
3941 (Lisp_Object name, Lisp_Object obarray)
3943 register Lisp_Object string, tem;
3944 size_t hash;
3946 if (NILP (obarray)) obarray = Vobarray;
3947 obarray = check_obarray (obarray);
3949 if (SYMBOLP (name))
3950 string = SYMBOL_NAME (name);
3951 else
3953 CHECK_STRING (name);
3954 string = name;
3957 tem = oblookup (obarray, SSDATA (string),
3958 SCHARS (string),
3959 SBYTES (string));
3960 if (INTEGERP (tem))
3961 return Qnil;
3962 /* If arg was a symbol, don't delete anything but that symbol itself. */
3963 if (SYMBOLP (name) && !EQ (name, tem))
3964 return Qnil;
3966 /* There are plenty of other symbols which will screw up the Emacs
3967 session if we unintern them, as well as even more ways to use
3968 `setq' or `fset' or whatnot to make the Emacs session
3969 unusable. Let's not go down this silly road. --Stef */
3970 /* if (EQ (tem, Qnil) || EQ (tem, Qt))
3971 error ("Attempt to unintern t or nil"); */
3973 XSYMBOL (tem)->interned = SYMBOL_UNINTERNED;
3975 hash = oblookup_last_bucket_number;
3977 if (EQ (AREF (obarray, hash), tem))
3979 if (XSYMBOL (tem)->next)
3981 Lisp_Object sym;
3982 XSETSYMBOL (sym, XSYMBOL (tem)->next);
3983 ASET (obarray, hash, sym);
3985 else
3986 ASET (obarray, hash, make_number (0));
3988 else
3990 Lisp_Object tail, following;
3992 for (tail = AREF (obarray, hash);
3993 XSYMBOL (tail)->next;
3994 tail = following)
3996 XSETSYMBOL (following, XSYMBOL (tail)->next);
3997 if (EQ (following, tem))
3999 set_symbol_next (tail, XSYMBOL (following)->next);
4000 break;
4005 return Qt;
4008 /* Return the symbol in OBARRAY whose names matches the string
4009 of SIZE characters (SIZE_BYTE bytes) at PTR.
4010 If there is no such symbol, return the integer bucket number of
4011 where the symbol would be if it were present.
4013 Also store the bucket number in oblookup_last_bucket_number. */
4015 Lisp_Object
4016 oblookup (Lisp_Object obarray, register const char *ptr, ptrdiff_t size, ptrdiff_t size_byte)
4018 size_t hash;
4019 size_t obsize;
4020 register Lisp_Object tail;
4021 Lisp_Object bucket, tem;
4023 obarray = check_obarray (obarray);
4024 /* This is sometimes needed in the middle of GC. */
4025 obsize = gc_asize (obarray);
4026 hash = hash_string (ptr, size_byte) % obsize;
4027 bucket = AREF (obarray, hash);
4028 oblookup_last_bucket_number = hash;
4029 if (EQ (bucket, make_number (0)))
4031 else if (!SYMBOLP (bucket))
4032 error ("Bad data in guts of obarray"); /* Like CADR error message. */
4033 else
4034 for (tail = bucket; ; XSETSYMBOL (tail, XSYMBOL (tail)->next))
4036 if (SBYTES (SYMBOL_NAME (tail)) == size_byte
4037 && SCHARS (SYMBOL_NAME (tail)) == size
4038 && !memcmp (SDATA (SYMBOL_NAME (tail)), ptr, size_byte))
4039 return tail;
4040 else if (XSYMBOL (tail)->next == 0)
4041 break;
4043 XSETINT (tem, hash);
4044 return tem;
4047 void
4048 map_obarray (Lisp_Object obarray, void (*fn) (Lisp_Object, Lisp_Object), Lisp_Object arg)
4050 ptrdiff_t i;
4051 register Lisp_Object tail;
4052 CHECK_VECTOR (obarray);
4053 for (i = ASIZE (obarray) - 1; i >= 0; i--)
4055 tail = AREF (obarray, i);
4056 if (SYMBOLP (tail))
4057 while (1)
4059 (*fn) (tail, arg);
4060 if (XSYMBOL (tail)->next == 0)
4061 break;
4062 XSETSYMBOL (tail, XSYMBOL (tail)->next);
4067 static void
4068 mapatoms_1 (Lisp_Object sym, Lisp_Object function)
4070 call1 (function, sym);
4073 DEFUN ("mapatoms", Fmapatoms, Smapatoms, 1, 2, 0,
4074 doc: /* Call FUNCTION on every symbol in OBARRAY.
4075 OBARRAY defaults to the value of `obarray'. */)
4076 (Lisp_Object function, Lisp_Object obarray)
4078 if (NILP (obarray)) obarray = Vobarray;
4079 obarray = check_obarray (obarray);
4081 map_obarray (obarray, mapatoms_1, function);
4082 return Qnil;
4085 #define OBARRAY_SIZE 1511
4087 void
4088 init_obarray (void)
4090 Lisp_Object oblength;
4091 ptrdiff_t size = 100 + MAX_MULTIBYTE_LENGTH;
4093 XSETFASTINT (oblength, OBARRAY_SIZE);
4095 Vobarray = Fmake_vector (oblength, make_number (0));
4096 initial_obarray = Vobarray;
4097 staticpro (&initial_obarray);
4099 for (int i = 0; i < ARRAYELTS (lispsym); i++)
4100 define_symbol (builtin_lisp_symbol (i), defsym_name[i]);
4102 DEFSYM (Qunbound, "unbound");
4104 DEFSYM (Qnil, "nil");
4105 SET_SYMBOL_VAL (XSYMBOL (Qnil), Qnil);
4106 XSYMBOL (Qnil)->constant = 1;
4107 XSYMBOL (Qnil)->declared_special = true;
4109 DEFSYM (Qt, "t");
4110 SET_SYMBOL_VAL (XSYMBOL (Qt), Qt);
4111 XSYMBOL (Qt)->constant = 1;
4112 XSYMBOL (Qt)->declared_special = true;
4114 /* Qt is correct even if CANNOT_DUMP. loadup.el will set to nil at end. */
4115 Vpurify_flag = Qt;
4117 DEFSYM (Qvariable_documentation, "variable-documentation");
4119 read_buffer = xmalloc (size);
4120 read_buffer_size = size;
4123 void
4124 defsubr (struct Lisp_Subr *sname)
4126 Lisp_Object sym, tem;
4127 sym = intern_c_string (sname->symbol_name);
4128 XSETPVECTYPE (sname, PVEC_SUBR);
4129 XSETSUBR (tem, sname);
4130 set_symbol_function (sym, tem);
4133 #ifdef NOTDEF /* Use fset in subr.el now! */
4134 void
4135 defalias (struct Lisp_Subr *sname, char *string)
4137 Lisp_Object sym;
4138 sym = intern (string);
4139 XSETSUBR (XSYMBOL (sym)->function, sname);
4141 #endif /* NOTDEF */
4143 /* Define an "integer variable"; a symbol whose value is forwarded to a
4144 C variable of type EMACS_INT. Sample call (with "xx" to fool make-docfile):
4145 DEFxxVAR_INT ("emacs-priority", &emacs_priority, "Documentation"); */
4146 void
4147 defvar_int (struct Lisp_Intfwd *i_fwd,
4148 const char *namestring, EMACS_INT *address)
4150 Lisp_Object sym;
4151 sym = intern_c_string (namestring);
4152 i_fwd->type = Lisp_Fwd_Int;
4153 i_fwd->intvar = address;
4154 XSYMBOL (sym)->declared_special = 1;
4155 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4156 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)i_fwd);
4159 /* Similar but define a variable whose value is t if address contains 1,
4160 nil if address contains 0. */
4161 void
4162 defvar_bool (struct Lisp_Boolfwd *b_fwd,
4163 const char *namestring, bool *address)
4165 Lisp_Object sym;
4166 sym = intern_c_string (namestring);
4167 b_fwd->type = Lisp_Fwd_Bool;
4168 b_fwd->boolvar = address;
4169 XSYMBOL (sym)->declared_special = 1;
4170 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4171 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)b_fwd);
4172 Vbyte_boolean_vars = Fcons (sym, Vbyte_boolean_vars);
4175 /* Similar but define a variable whose value is the Lisp Object stored
4176 at address. Two versions: with and without gc-marking of the C
4177 variable. The nopro version is used when that variable will be
4178 gc-marked for some other reason, since marking the same slot twice
4179 can cause trouble with strings. */
4180 void
4181 defvar_lisp_nopro (struct Lisp_Objfwd *o_fwd,
4182 const char *namestring, Lisp_Object *address)
4184 Lisp_Object sym;
4185 sym = intern_c_string (namestring);
4186 o_fwd->type = Lisp_Fwd_Obj;
4187 o_fwd->objvar = address;
4188 XSYMBOL (sym)->declared_special = 1;
4189 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4190 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)o_fwd);
4193 void
4194 defvar_lisp (struct Lisp_Objfwd *o_fwd,
4195 const char *namestring, Lisp_Object *address)
4197 defvar_lisp_nopro (o_fwd, namestring, address);
4198 staticpro (address);
4201 /* Similar but define a variable whose value is the Lisp Object stored
4202 at a particular offset in the current kboard object. */
4204 void
4205 defvar_kboard (struct Lisp_Kboard_Objfwd *ko_fwd,
4206 const char *namestring, int offset)
4208 Lisp_Object sym;
4209 sym = intern_c_string (namestring);
4210 ko_fwd->type = Lisp_Fwd_Kboard_Obj;
4211 ko_fwd->offset = offset;
4212 XSYMBOL (sym)->declared_special = 1;
4213 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4214 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)ko_fwd);
4217 /* Check that the elements of lpath exist. */
4219 static void
4220 load_path_check (Lisp_Object lpath)
4222 Lisp_Object path_tail;
4224 /* The only elements that might not exist are those from
4225 PATH_LOADSEARCH, EMACSLOADPATH. Anything else is only added if
4226 it exists. */
4227 for (path_tail = lpath; !NILP (path_tail); path_tail = XCDR (path_tail))
4229 Lisp_Object dirfile;
4230 dirfile = Fcar (path_tail);
4231 if (STRINGP (dirfile))
4233 dirfile = Fdirectory_file_name (dirfile);
4234 if (! file_accessible_directory_p (dirfile))
4235 dir_warning ("Lisp directory", XCAR (path_tail));
4240 /* Return the default load-path, to be used if EMACSLOADPATH is unset.
4241 This does not include the standard site-lisp directories
4242 under the installation prefix (i.e., PATH_SITELOADSEARCH),
4243 but it does (unless no_site_lisp is set) include site-lisp
4244 directories in the source/build directories if those exist and we
4245 are running uninstalled.
4247 Uses the following logic:
4248 If CANNOT_DUMP: Use PATH_LOADSEARCH.
4249 The remainder is what happens when dumping works:
4250 If purify-flag (ie dumping) just use PATH_DUMPLOADSEARCH.
4251 Otherwise use PATH_LOADSEARCH.
4253 If !initialized, then just return PATH_DUMPLOADSEARCH.
4254 If initialized:
4255 If Vinstallation_directory is not nil (ie, running uninstalled):
4256 If installation-dir/lisp exists and not already a member,
4257 we must be running uninstalled. Reset the load-path
4258 to just installation-dir/lisp. (The default PATH_LOADSEARCH
4259 refers to the eventual installation directories. Since we
4260 are not yet installed, we should not use them, even if they exist.)
4261 If installation-dir/lisp does not exist, just add
4262 PATH_DUMPLOADSEARCH at the end instead.
4263 Add installation-dir/site-lisp (if !no_site_lisp, and exists
4264 and not already a member) at the front.
4265 If installation-dir != source-dir (ie running an uninstalled,
4266 out-of-tree build) AND install-dir/src/Makefile exists BUT
4267 install-dir/src/Makefile.in does NOT exist (this is a sanity
4268 check), then repeat the above steps for source-dir/lisp, site-lisp. */
4270 static Lisp_Object
4271 load_path_default (void)
4273 Lisp_Object lpath = Qnil;
4274 const char *normal;
4276 #ifdef CANNOT_DUMP
4277 #ifdef HAVE_NS
4278 const char *loadpath = ns_load_path ();
4279 #endif
4281 normal = PATH_LOADSEARCH;
4282 #ifdef HAVE_NS
4283 lpath = decode_env_path (0, loadpath ? loadpath : normal, 0);
4284 #else
4285 lpath = decode_env_path (0, normal, 0);
4286 #endif
4288 #else /* !CANNOT_DUMP */
4290 normal = NILP (Vpurify_flag) ? PATH_LOADSEARCH : PATH_DUMPLOADSEARCH;
4292 if (initialized)
4294 #ifdef HAVE_NS
4295 const char *loadpath = ns_load_path ();
4296 lpath = decode_env_path (0, loadpath ? loadpath : normal, 0);
4297 #else
4298 lpath = decode_env_path (0, normal, 0);
4299 #endif
4300 if (!NILP (Vinstallation_directory))
4302 Lisp_Object tem, tem1;
4304 /* Add to the path the lisp subdir of the installation
4305 dir, if it is accessible. Note: in out-of-tree builds,
4306 this directory is empty save for Makefile. */
4307 tem = Fexpand_file_name (build_string ("lisp"),
4308 Vinstallation_directory);
4309 tem1 = Ffile_accessible_directory_p (tem);
4310 if (!NILP (tem1))
4312 if (NILP (Fmember (tem, lpath)))
4314 /* We are running uninstalled. The default load-path
4315 points to the eventual installed lisp directories.
4316 We should not use those now, even if they exist,
4317 so start over from a clean slate. */
4318 lpath = list1 (tem);
4321 else
4322 /* That dir doesn't exist, so add the build-time
4323 Lisp dirs instead. */
4325 Lisp_Object dump_path =
4326 decode_env_path (0, PATH_DUMPLOADSEARCH, 0);
4327 lpath = nconc2 (lpath, dump_path);
4330 /* Add site-lisp under the installation dir, if it exists. */
4331 if (!no_site_lisp)
4333 tem = Fexpand_file_name (build_string ("site-lisp"),
4334 Vinstallation_directory);
4335 tem1 = Ffile_accessible_directory_p (tem);
4336 if (!NILP (tem1))
4338 if (NILP (Fmember (tem, lpath)))
4339 lpath = Fcons (tem, lpath);
4343 /* If Emacs was not built in the source directory,
4344 and it is run from where it was built, add to load-path
4345 the lisp and site-lisp dirs under that directory. */
4347 if (NILP (Fequal (Vinstallation_directory, Vsource_directory)))
4349 Lisp_Object tem2;
4351 tem = Fexpand_file_name (build_string ("src/Makefile"),
4352 Vinstallation_directory);
4353 tem1 = Ffile_exists_p (tem);
4355 /* Don't be fooled if they moved the entire source tree
4356 AFTER dumping Emacs. If the build directory is indeed
4357 different from the source dir, src/Makefile.in and
4358 src/Makefile will not be found together. */
4359 tem = Fexpand_file_name (build_string ("src/Makefile.in"),
4360 Vinstallation_directory);
4361 tem2 = Ffile_exists_p (tem);
4362 if (!NILP (tem1) && NILP (tem2))
4364 tem = Fexpand_file_name (build_string ("lisp"),
4365 Vsource_directory);
4367 if (NILP (Fmember (tem, lpath)))
4368 lpath = Fcons (tem, lpath);
4370 if (!no_site_lisp)
4372 tem = Fexpand_file_name (build_string ("site-lisp"),
4373 Vsource_directory);
4374 tem1 = Ffile_accessible_directory_p (tem);
4375 if (!NILP (tem1))
4377 if (NILP (Fmember (tem, lpath)))
4378 lpath = Fcons (tem, lpath);
4382 } /* Vinstallation_directory != Vsource_directory */
4384 } /* if Vinstallation_directory */
4386 else /* !initialized */
4388 /* NORMAL refers to PATH_DUMPLOADSEARCH, ie the lisp dir in the
4389 source directory. We used to add ../lisp (ie the lisp dir in
4390 the build directory) at the front here, but that should not
4391 be necessary, since in out of tree builds lisp/ is empty, save
4392 for Makefile. */
4393 lpath = decode_env_path (0, normal, 0);
4395 #endif /* !CANNOT_DUMP */
4397 return lpath;
4400 void
4401 init_lread (void)
4403 /* First, set Vload_path. */
4405 /* Ignore EMACSLOADPATH when dumping. */
4406 #ifdef CANNOT_DUMP
4407 bool use_loadpath = true;
4408 #else
4409 bool use_loadpath = NILP (Vpurify_flag);
4410 #endif
4412 if (use_loadpath && egetenv ("EMACSLOADPATH"))
4414 Vload_path = decode_env_path ("EMACSLOADPATH", 0, 1);
4416 /* Check (non-nil) user-supplied elements. */
4417 load_path_check (Vload_path);
4419 /* If no nils in the environment variable, use as-is.
4420 Otherwise, replace any nils with the default. */
4421 if (! NILP (Fmemq (Qnil, Vload_path)))
4423 Lisp_Object elem, elpath = Vload_path;
4424 Lisp_Object default_lpath = load_path_default ();
4426 /* Check defaults, before adding site-lisp. */
4427 load_path_check (default_lpath);
4429 /* Add the site-lisp directories to the front of the default. */
4430 if (!no_site_lisp && PATH_SITELOADSEARCH[0] != '\0')
4432 Lisp_Object sitelisp;
4433 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH, 0);
4434 if (! NILP (sitelisp))
4435 default_lpath = nconc2 (sitelisp, default_lpath);
4438 Vload_path = Qnil;
4440 /* Replace nils from EMACSLOADPATH by default. */
4441 while (CONSP (elpath))
4443 elem = XCAR (elpath);
4444 elpath = XCDR (elpath);
4445 Vload_path = CALLN (Fappend, Vload_path,
4446 NILP (elem) ? default_lpath : list1 (elem));
4448 } /* Fmemq (Qnil, Vload_path) */
4450 else
4452 Vload_path = load_path_default ();
4454 /* Check before adding site-lisp directories.
4455 The install should have created them, but they are not
4456 required, so no need to warn if they are absent.
4457 Or we might be running before installation. */
4458 load_path_check (Vload_path);
4460 /* Add the site-lisp directories at the front. */
4461 if (initialized && !no_site_lisp && PATH_SITELOADSEARCH[0] != '\0')
4463 Lisp_Object sitelisp;
4464 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH, 0);
4465 if (! NILP (sitelisp)) Vload_path = nconc2 (sitelisp, Vload_path);
4469 Vvalues = Qnil;
4471 load_in_progress = 0;
4472 Vload_file_name = Qnil;
4473 Vstandard_input = Qt;
4474 Vloads_in_progress = Qnil;
4477 /* Print a warning that directory intended for use USE and with name
4478 DIRNAME cannot be accessed. On entry, errno should correspond to
4479 the access failure. Print the warning on stderr and put it in
4480 *Messages*. */
4482 void
4483 dir_warning (char const *use, Lisp_Object dirname)
4485 static char const format[] = "Warning: %s '%s': %s\n";
4486 char *diagnostic = emacs_strerror (errno);
4487 fprintf (stderr, format, use, SSDATA (ENCODE_SYSTEM (dirname)), diagnostic);
4489 /* Don't log the warning before we've initialized!! */
4490 if (initialized)
4492 ptrdiff_t diaglen = strlen (diagnostic);
4493 AUTO_STRING_WITH_LEN (diag, diagnostic, diaglen);
4494 if (! NILP (Vlocale_coding_system))
4496 Lisp_Object s
4497 = code_convert_string_norecord (diag, Vlocale_coding_system, false);
4498 diagnostic = SSDATA (s);
4499 diaglen = SBYTES (s);
4501 USE_SAFE_ALLOCA;
4502 char *buffer = SAFE_ALLOCA (sizeof format - 3 * (sizeof "%s" - 1)
4503 + strlen (use) + SBYTES (dirname) + diaglen);
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");