* lread.c (Fload): Avoid uninitialized warning.
[emacs.git] / src / lread.c
blobe701338da31ea409c73c149b50495302a3b0e54e
1 /* Lisp parsing and input streams.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2013 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
11 (at 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/>. */
22 #include <config.h>
23 #include "sysstdio.h"
24 #include <sys/types.h>
25 #include <sys/stat.h>
26 #include <sys/file.h>
27 #include <errno.h>
28 #include <limits.h> /* For CHAR_BIT. */
29 #include <stat-time.h>
30 #include "lisp.h"
31 #include "intervals.h"
32 #include "character.h"
33 #include "buffer.h"
34 #include "charset.h"
35 #include "coding.h"
36 #include <epaths.h>
37 #include "commands.h"
38 #include "keyboard.h"
39 #include "frame.h"
40 #include "termhooks.h"
41 #include "blockinput.h"
43 #ifdef MSDOS
44 #include "msdos.h"
45 #endif
47 #ifdef HAVE_NS
48 #include "nsterm.h"
49 #endif
51 #include <unistd.h>
53 #ifdef HAVE_SETLOCALE
54 #include <locale.h>
55 #endif /* HAVE_SETLOCALE */
57 #include <fcntl.h>
59 #ifdef HAVE_FSEEKO
60 #define file_offset off_t
61 #define file_tell ftello
62 #else
63 #define file_offset long
64 #define file_tell ftell
65 #endif
67 /* Hash table read constants. */
68 static Lisp_Object Qhash_table, Qdata;
69 static Lisp_Object Qtest, Qsize;
70 static Lisp_Object Qweakness;
71 static Lisp_Object Qrehash_size;
72 static Lisp_Object Qrehash_threshold;
74 static Lisp_Object Qread_char, Qget_file_char, Qcurrent_load_list;
75 Lisp_Object Qstandard_input;
76 Lisp_Object Qvariable_documentation;
77 static Lisp_Object Qascii_character, Qload, Qload_file_name;
78 Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
79 static Lisp_Object Qinhibit_file_name_operation;
80 static Lisp_Object Qeval_buffer_list;
81 Lisp_Object Qlexical_binding;
82 static Lisp_Object Qfile_truename, Qdo_after_load_evaluation; /* ACM 2006/5/16 */
84 /* Used instead of Qget_file_char while loading *.elc files compiled
85 by Emacs 21 or older. */
86 static Lisp_Object Qget_emacs_mule_file_char;
88 static Lisp_Object Qload_force_doc_strings;
90 static Lisp_Object Qload_in_progress;
92 /* The association list of objects read with the #n=object form.
93 Each member of the list has the form (n . object), and is used to
94 look up the object for the corresponding #n# construct.
95 It must be set to nil before all top-level calls to read0. */
96 static Lisp_Object read_objects;
98 /* File for get_file_char to read from. Use by load. */
99 static FILE *instream;
101 /* For use within read-from-string (this reader is non-reentrant!!) */
102 static ptrdiff_t read_from_string_index;
103 static ptrdiff_t read_from_string_index_byte;
104 static ptrdiff_t read_from_string_limit;
106 /* Number of characters read in the current call to Fread or
107 Fread_from_string. */
108 static EMACS_INT readchar_count;
110 /* This contains the last string skipped with #@. */
111 static char *saved_doc_string;
112 /* Length of buffer allocated in saved_doc_string. */
113 static ptrdiff_t saved_doc_string_size;
114 /* Length of actual data in saved_doc_string. */
115 static ptrdiff_t saved_doc_string_length;
116 /* This is the file position that string came from. */
117 static file_offset saved_doc_string_position;
119 /* This contains the previous string skipped with #@.
120 We copy it from saved_doc_string when a new string
121 is put in saved_doc_string. */
122 static char *prev_saved_doc_string;
123 /* Length of buffer allocated in prev_saved_doc_string. */
124 static ptrdiff_t prev_saved_doc_string_size;
125 /* Length of actual data in prev_saved_doc_string. */
126 static ptrdiff_t prev_saved_doc_string_length;
127 /* This is the file position that string came from. */
128 static file_offset prev_saved_doc_string_position;
130 /* True means inside a new-style backquote
131 with no surrounding parentheses.
132 Fread initializes this to false, so we need not specbind it
133 or worry about what happens to it when there is an error. */
134 static bool new_backquote_flag;
135 static Lisp_Object Qold_style_backquotes;
137 /* A list of file names for files being loaded in Fload. Used to
138 check for recursive loads. */
140 static Lisp_Object Vloads_in_progress;
142 static int read_emacs_mule_char (int, int (*) (int, Lisp_Object),
143 Lisp_Object);
145 static void readevalloop (Lisp_Object, FILE *, Lisp_Object, bool,
146 Lisp_Object, Lisp_Object,
147 Lisp_Object, Lisp_Object);
149 /* Functions that read one byte from the current source READCHARFUN
150 or unreads one byte. If the integer argument C is -1, it returns
151 one read byte, or -1 when there's no more byte in the source. If C
152 is 0 or positive, it unreads C, and the return value is not
153 interesting. */
155 static int readbyte_for_lambda (int, Lisp_Object);
156 static int readbyte_from_file (int, Lisp_Object);
157 static int readbyte_from_string (int, Lisp_Object);
159 /* Handle unreading and rereading of characters.
160 Write READCHAR to read a character,
161 UNREAD(c) to unread c to be read again.
163 These macros correctly read/unread multibyte characters. */
165 #define READCHAR readchar (readcharfun, NULL)
166 #define UNREAD(c) unreadchar (readcharfun, c)
168 /* Same as READCHAR but set *MULTIBYTE to the multibyteness of the source. */
169 #define READCHAR_REPORT_MULTIBYTE(multibyte) readchar (readcharfun, multibyte)
171 /* When READCHARFUN is Qget_file_char, Qget_emacs_mule_file_char,
172 Qlambda, or a cons, we use this to keep an unread character because
173 a file stream can't handle multibyte-char unreading. The value -1
174 means that there's no unread character. */
175 static int unread_char;
177 static int
178 readchar (Lisp_Object readcharfun, bool *multibyte)
180 Lisp_Object tem;
181 register int c;
182 int (*readbyte) (int, Lisp_Object);
183 unsigned char buf[MAX_MULTIBYTE_LENGTH];
184 int i, len;
185 bool emacs_mule_encoding = 0;
187 if (multibyte)
188 *multibyte = 0;
190 readchar_count++;
192 if (BUFFERP (readcharfun))
194 register struct buffer *inbuffer = XBUFFER (readcharfun);
196 ptrdiff_t pt_byte = BUF_PT_BYTE (inbuffer);
198 if (! BUFFER_LIVE_P (inbuffer))
199 return -1;
201 if (pt_byte >= BUF_ZV_BYTE (inbuffer))
202 return -1;
204 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
206 /* Fetch the character code from the buffer. */
207 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, pt_byte);
208 BUF_INC_POS (inbuffer, pt_byte);
209 c = STRING_CHAR (p);
210 if (multibyte)
211 *multibyte = 1;
213 else
215 c = BUF_FETCH_BYTE (inbuffer, pt_byte);
216 if (! ASCII_BYTE_P (c))
217 c = BYTE8_TO_CHAR (c);
218 pt_byte++;
220 SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
222 return c;
224 if (MARKERP (readcharfun))
226 register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
228 ptrdiff_t bytepos = marker_byte_position (readcharfun);
230 if (bytepos >= BUF_ZV_BYTE (inbuffer))
231 return -1;
233 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
235 /* Fetch the character code from the buffer. */
236 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, bytepos);
237 BUF_INC_POS (inbuffer, bytepos);
238 c = STRING_CHAR (p);
239 if (multibyte)
240 *multibyte = 1;
242 else
244 c = BUF_FETCH_BYTE (inbuffer, bytepos);
245 if (! ASCII_BYTE_P (c))
246 c = BYTE8_TO_CHAR (c);
247 bytepos++;
250 XMARKER (readcharfun)->bytepos = bytepos;
251 XMARKER (readcharfun)->charpos++;
253 return c;
256 if (EQ (readcharfun, Qlambda))
258 readbyte = readbyte_for_lambda;
259 goto read_multibyte;
262 if (EQ (readcharfun, Qget_file_char))
264 readbyte = readbyte_from_file;
265 goto read_multibyte;
268 if (STRINGP (readcharfun))
270 if (read_from_string_index >= read_from_string_limit)
271 c = -1;
272 else if (STRING_MULTIBYTE (readcharfun))
274 if (multibyte)
275 *multibyte = 1;
276 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, readcharfun,
277 read_from_string_index,
278 read_from_string_index_byte);
280 else
282 c = SREF (readcharfun, read_from_string_index_byte);
283 read_from_string_index++;
284 read_from_string_index_byte++;
286 return c;
289 if (CONSP (readcharfun))
291 /* This is the case that read_vector is reading from a unibyte
292 string that contains a byte sequence previously skipped
293 because of #@NUMBER. The car part of readcharfun is that
294 string, and the cdr part is a value of readcharfun given to
295 read_vector. */
296 readbyte = readbyte_from_string;
297 if (EQ (XCDR (readcharfun), Qget_emacs_mule_file_char))
298 emacs_mule_encoding = 1;
299 goto read_multibyte;
302 if (EQ (readcharfun, Qget_emacs_mule_file_char))
304 readbyte = readbyte_from_file;
305 emacs_mule_encoding = 1;
306 goto read_multibyte;
309 tem = call0 (readcharfun);
311 if (NILP (tem))
312 return -1;
313 return XINT (tem);
315 read_multibyte:
316 if (unread_char >= 0)
318 c = unread_char;
319 unread_char = -1;
320 return c;
322 c = (*readbyte) (-1, readcharfun);
323 if (c < 0)
324 return c;
325 if (multibyte)
326 *multibyte = 1;
327 if (ASCII_BYTE_P (c))
328 return c;
329 if (emacs_mule_encoding)
330 return read_emacs_mule_char (c, readbyte, readcharfun);
331 i = 0;
332 buf[i++] = c;
333 len = BYTES_BY_CHAR_HEAD (c);
334 while (i < len)
336 c = (*readbyte) (-1, readcharfun);
337 if (c < 0 || ! TRAILING_CODE_P (c))
339 while (--i > 1)
340 (*readbyte) (buf[i], readcharfun);
341 return BYTE8_TO_CHAR (buf[0]);
343 buf[i++] = c;
345 return STRING_CHAR (buf);
348 #define FROM_FILE_P(readcharfun) \
349 (EQ (readcharfun, Qget_file_char) \
350 || EQ (readcharfun, Qget_emacs_mule_file_char))
352 static void
353 skip_dyn_bytes (Lisp_Object readcharfun, ptrdiff_t n)
355 if (FROM_FILE_P (readcharfun))
357 block_input (); /* FIXME: Not sure if it's needed. */
358 fseek (instream, n, SEEK_CUR);
359 unblock_input ();
361 else
362 { /* We're not reading directly from a file. In that case, it's difficult
363 to reliably count bytes, since these are usually meant for the file's
364 encoding, whereas we're now typically in the internal encoding.
365 But luckily, skip_dyn_bytes is used to skip over a single
366 dynamic-docstring (or dynamic byte-code) which is always quoted such
367 that \037 is the final char. */
368 int c;
369 do {
370 c = READCHAR;
371 } while (c >= 0 && c != '\037');
375 static void
376 skip_dyn_eof (Lisp_Object readcharfun)
378 if (FROM_FILE_P (readcharfun))
380 block_input (); /* FIXME: Not sure if it's needed. */
381 fseek (instream, 0, SEEK_END);
382 unblock_input ();
384 else
385 while (READCHAR >= 0);
388 /* Unread the character C in the way appropriate for the stream READCHARFUN.
389 If the stream is a user function, call it with the char as argument. */
391 static void
392 unreadchar (Lisp_Object readcharfun, int c)
394 readchar_count--;
395 if (c == -1)
396 /* Don't back up the pointer if we're unreading the end-of-input mark,
397 since readchar didn't advance it when we read it. */
399 else if (BUFFERP (readcharfun))
401 struct buffer *b = XBUFFER (readcharfun);
402 ptrdiff_t charpos = BUF_PT (b);
403 ptrdiff_t bytepos = BUF_PT_BYTE (b);
405 if (! NILP (BVAR (b, enable_multibyte_characters)))
406 BUF_DEC_POS (b, bytepos);
407 else
408 bytepos--;
410 SET_BUF_PT_BOTH (b, charpos - 1, bytepos);
412 else if (MARKERP (readcharfun))
414 struct buffer *b = XMARKER (readcharfun)->buffer;
415 ptrdiff_t bytepos = XMARKER (readcharfun)->bytepos;
417 XMARKER (readcharfun)->charpos--;
418 if (! NILP (BVAR (b, enable_multibyte_characters)))
419 BUF_DEC_POS (b, bytepos);
420 else
421 bytepos--;
423 XMARKER (readcharfun)->bytepos = bytepos;
425 else if (STRINGP (readcharfun))
427 read_from_string_index--;
428 read_from_string_index_byte
429 = string_char_to_byte (readcharfun, read_from_string_index);
431 else if (CONSP (readcharfun))
433 unread_char = c;
435 else if (EQ (readcharfun, Qlambda))
437 unread_char = c;
439 else if (FROM_FILE_P (readcharfun))
441 unread_char = c;
443 else
444 call1 (readcharfun, make_number (c));
447 static int
448 readbyte_for_lambda (int c, Lisp_Object readcharfun)
450 return read_bytecode_char (c >= 0);
454 static int
455 readbyte_from_file (int c, Lisp_Object readcharfun)
457 if (c >= 0)
459 block_input ();
460 ungetc (c, instream);
461 unblock_input ();
462 return 0;
465 block_input ();
466 c = getc (instream);
468 /* Interrupted reads have been observed while reading over the network. */
469 while (c == EOF && ferror (instream) && errno == EINTR)
471 unblock_input ();
472 QUIT;
473 block_input ();
474 clearerr (instream);
475 c = getc (instream);
478 unblock_input ();
480 return (c == EOF ? -1 : c);
483 static int
484 readbyte_from_string (int c, Lisp_Object readcharfun)
486 Lisp_Object string = XCAR (readcharfun);
488 if (c >= 0)
490 read_from_string_index--;
491 read_from_string_index_byte
492 = string_char_to_byte (string, read_from_string_index);
495 if (read_from_string_index >= read_from_string_limit)
496 c = -1;
497 else
498 FETCH_STRING_CHAR_ADVANCE (c, string,
499 read_from_string_index,
500 read_from_string_index_byte);
501 return c;
505 /* Read one non-ASCII character from INSTREAM. The character is
506 encoded in `emacs-mule' and the first byte is already read in
507 C. */
509 static int
510 read_emacs_mule_char (int c, int (*readbyte) (int, Lisp_Object), Lisp_Object readcharfun)
512 /* Emacs-mule coding uses at most 4-byte for one character. */
513 unsigned char buf[4];
514 int len = emacs_mule_bytes[c];
515 struct charset *charset;
516 int i;
517 unsigned code;
519 if (len == 1)
520 /* C is not a valid leading-code of `emacs-mule'. */
521 return BYTE8_TO_CHAR (c);
523 i = 0;
524 buf[i++] = c;
525 while (i < len)
527 c = (*readbyte) (-1, readcharfun);
528 if (c < 0xA0)
530 while (--i > 1)
531 (*readbyte) (buf[i], readcharfun);
532 return BYTE8_TO_CHAR (buf[0]);
534 buf[i++] = c;
537 if (len == 2)
539 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
540 code = buf[1] & 0x7F;
542 else if (len == 3)
544 if (buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_11
545 || buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_12)
547 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
548 code = buf[2] & 0x7F;
550 else
552 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
553 code = ((buf[1] << 8) | buf[2]) & 0x7F7F;
556 else
558 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
559 code = ((buf[2] << 8) | buf[3]) & 0x7F7F;
561 c = DECODE_CHAR (charset, code);
562 if (c < 0)
563 Fsignal (Qinvalid_read_syntax,
564 list1 (build_string ("invalid multibyte form")));
565 return c;
569 static Lisp_Object read_internal_start (Lisp_Object, Lisp_Object,
570 Lisp_Object);
571 static Lisp_Object read0 (Lisp_Object);
572 static Lisp_Object read1 (Lisp_Object, int *, bool);
574 static Lisp_Object read_list (bool, Lisp_Object);
575 static Lisp_Object read_vector (Lisp_Object, bool);
577 static Lisp_Object substitute_object_recurse (Lisp_Object, Lisp_Object,
578 Lisp_Object);
579 static void substitute_object_in_subtree (Lisp_Object,
580 Lisp_Object);
581 static void substitute_in_interval (INTERVAL, Lisp_Object);
584 /* Get a character from the tty. */
586 /* Read input events until we get one that's acceptable for our purposes.
588 If NO_SWITCH_FRAME, switch-frame events are stashed
589 until we get a character we like, and then stuffed into
590 unread_switch_frame.
592 If ASCII_REQUIRED, check function key events to see
593 if the unmodified version of the symbol has a Qascii_character
594 property, and use that character, if present.
596 If ERROR_NONASCII, signal an error if the input we
597 get isn't an ASCII character with modifiers. If it's false but
598 ASCII_REQUIRED is true, just re-read until we get an ASCII
599 character.
601 If INPUT_METHOD, invoke the current input method
602 if the character warrants that.
604 If SECONDS is a number, wait that many seconds for input, and
605 return Qnil if no input arrives within that time. */
607 static Lisp_Object
608 read_filtered_event (bool no_switch_frame, bool ascii_required,
609 bool error_nonascii, bool input_method, Lisp_Object seconds)
611 Lisp_Object val, delayed_switch_frame;
612 EMACS_TIME end_time;
614 #ifdef HAVE_WINDOW_SYSTEM
615 if (display_hourglass_p)
616 cancel_hourglass ();
617 #endif
619 delayed_switch_frame = Qnil;
621 /* Compute timeout. */
622 if (NUMBERP (seconds))
624 double duration = extract_float (seconds);
625 EMACS_TIME wait_time = EMACS_TIME_FROM_DOUBLE (duration);
626 end_time = add_emacs_time (current_emacs_time (), wait_time);
629 /* Read until we get an acceptable event. */
630 retry:
632 val = read_char (0, Qnil, (input_method ? Qnil : Qt), 0,
633 NUMBERP (seconds) ? &end_time : NULL);
634 while (INTEGERP (val) && XINT (val) == -2); /* wrong_kboard_jmpbuf */
636 if (BUFFERP (val))
637 goto retry;
639 /* `switch-frame' events are put off until after the next ASCII
640 character. This is better than signaling an error just because
641 the last characters were typed to a separate minibuffer frame,
642 for example. Eventually, some code which can deal with
643 switch-frame events will read it and process it. */
644 if (no_switch_frame
645 && EVENT_HAS_PARAMETERS (val)
646 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (val)), Qswitch_frame))
648 delayed_switch_frame = val;
649 goto retry;
652 if (ascii_required && !(NUMBERP (seconds) && NILP (val)))
654 /* Convert certain symbols to their ASCII equivalents. */
655 if (SYMBOLP (val))
657 Lisp_Object tem, tem1;
658 tem = Fget (val, Qevent_symbol_element_mask);
659 if (!NILP (tem))
661 tem1 = Fget (Fcar (tem), Qascii_character);
662 /* Merge this symbol's modifier bits
663 with the ASCII equivalent of its basic code. */
664 if (!NILP (tem1))
665 XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
669 /* If we don't have a character now, deal with it appropriately. */
670 if (!INTEGERP (val))
672 if (error_nonascii)
674 Vunread_command_events = list1 (val);
675 error ("Non-character input-event");
677 else
678 goto retry;
682 if (! NILP (delayed_switch_frame))
683 unread_switch_frame = delayed_switch_frame;
685 #if 0
687 #ifdef HAVE_WINDOW_SYSTEM
688 if (display_hourglass_p)
689 start_hourglass ();
690 #endif
692 #endif
694 return val;
697 DEFUN ("read-char", Fread_char, Sread_char, 0, 3, 0,
698 doc: /* Read a character from the command input (keyboard or macro).
699 It is returned as a number.
700 If the character has modifiers, they are resolved and reflected to the
701 character code if possible (e.g. C-SPC -> 0).
703 If the user generates an event which is not a character (i.e. a mouse
704 click or function key event), `read-char' signals an error. As an
705 exception, switch-frame events are put off until non-character events
706 can be read.
707 If you want to read non-character events, or ignore them, call
708 `read-event' or `read-char-exclusive' instead.
710 If the optional argument PROMPT is non-nil, display that as a prompt.
711 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
712 input method is turned on in the current buffer, that input method
713 is used for reading a character.
714 If the optional argument SECONDS is non-nil, it should be a number
715 specifying the maximum number of seconds to wait for input. If no
716 input arrives in that time, return nil. SECONDS may be a
717 floating-point value. */)
718 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
720 Lisp_Object val;
722 if (! NILP (prompt))
723 message_with_string ("%s", prompt, 0);
724 val = read_filtered_event (1, 1, 1, ! NILP (inherit_input_method), seconds);
726 return (NILP (val) ? Qnil
727 : make_number (char_resolve_modifier_mask (XINT (val))));
730 DEFUN ("read-event", Fread_event, Sread_event, 0, 3, 0,
731 doc: /* Read an event object from the input stream.
732 If the optional argument PROMPT is non-nil, display that as a prompt.
733 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
734 input method is turned on in the current buffer, that input method
735 is used for reading a character.
736 If the optional argument SECONDS is non-nil, it should be a number
737 specifying the maximum number of seconds to wait for input. If no
738 input arrives in that time, return nil. SECONDS may be a
739 floating-point value. */)
740 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
742 if (! NILP (prompt))
743 message_with_string ("%s", prompt, 0);
744 return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method), seconds);
747 DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 3, 0,
748 doc: /* Read a character from the command input (keyboard or macro).
749 It is returned as a number. Non-character events are ignored.
750 If the character has modifiers, they are resolved and reflected to the
751 character code if possible (e.g. C-SPC -> 0).
753 If the optional argument PROMPT is non-nil, display that as a prompt.
754 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
755 input method is turned on in the current buffer, that input method
756 is used for reading a character.
757 If the optional argument SECONDS is non-nil, it should be a number
758 specifying the maximum number of seconds to wait for input. If no
759 input arrives in that time, return nil. SECONDS may be a
760 floating-point value. */)
761 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
763 Lisp_Object val;
765 if (! NILP (prompt))
766 message_with_string ("%s", prompt, 0);
768 val = read_filtered_event (1, 1, 0, ! NILP (inherit_input_method), seconds);
770 return (NILP (val) ? Qnil
771 : make_number (char_resolve_modifier_mask (XINT (val))));
774 DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
775 doc: /* Don't use this yourself. */)
776 (void)
778 register Lisp_Object val;
779 block_input ();
780 XSETINT (val, getc (instream));
781 unblock_input ();
782 return val;
788 /* Return true if the lisp code read using READCHARFUN defines a non-nil
789 `lexical-binding' file variable. After returning, the stream is
790 positioned following the first line, if it is a comment or #! line,
791 otherwise nothing is read. */
793 static bool
794 lisp_file_lexically_bound_p (Lisp_Object readcharfun)
796 int ch = READCHAR;
798 if (ch == '#')
800 ch = READCHAR;
801 if (ch != '!')
803 UNREAD (ch);
804 UNREAD ('#');
805 return 0;
807 while (ch != '\n' && ch != EOF)
808 ch = READCHAR;
809 if (ch == '\n') ch = READCHAR;
810 /* It is OK to leave the position after a #! line, since
811 that is what read1 does. */
814 if (ch != ';')
815 /* The first line isn't a comment, just give up. */
817 UNREAD (ch);
818 return 0;
820 else
821 /* Look for an appropriate file-variable in the first line. */
823 bool rv = 0;
824 enum {
825 NOMINAL, AFTER_FIRST_DASH, AFTER_ASTERIX
826 } beg_end_state = NOMINAL;
827 bool in_file_vars = 0;
829 #define UPDATE_BEG_END_STATE(ch) \
830 if (beg_end_state == NOMINAL) \
831 beg_end_state = (ch == '-' ? AFTER_FIRST_DASH : NOMINAL); \
832 else if (beg_end_state == AFTER_FIRST_DASH) \
833 beg_end_state = (ch == '*' ? AFTER_ASTERIX : NOMINAL); \
834 else if (beg_end_state == AFTER_ASTERIX) \
836 if (ch == '-') \
837 in_file_vars = !in_file_vars; \
838 beg_end_state = NOMINAL; \
841 /* Skip until we get to the file vars, if any. */
844 ch = READCHAR;
845 UPDATE_BEG_END_STATE (ch);
847 while (!in_file_vars && ch != '\n' && ch != EOF);
849 while (in_file_vars)
851 char var[100], val[100];
852 unsigned i;
854 ch = READCHAR;
856 /* Read a variable name. */
857 while (ch == ' ' || ch == '\t')
858 ch = READCHAR;
860 i = 0;
861 while (ch != ':' && ch != '\n' && ch != EOF && in_file_vars)
863 if (i < sizeof var - 1)
864 var[i++] = ch;
865 UPDATE_BEG_END_STATE (ch);
866 ch = READCHAR;
869 /* Stop scanning if no colon was found before end marker. */
870 if (!in_file_vars || ch == '\n' || ch == EOF)
871 break;
873 while (i > 0 && (var[i - 1] == ' ' || var[i - 1] == '\t'))
874 i--;
875 var[i] = '\0';
877 if (ch == ':')
879 /* Read a variable value. */
880 ch = READCHAR;
882 while (ch == ' ' || ch == '\t')
883 ch = READCHAR;
885 i = 0;
886 while (ch != ';' && ch != '\n' && ch != EOF && in_file_vars)
888 if (i < sizeof val - 1)
889 val[i++] = ch;
890 UPDATE_BEG_END_STATE (ch);
891 ch = READCHAR;
893 if (! in_file_vars)
894 /* The value was terminated by an end-marker, which remove. */
895 i -= 3;
896 while (i > 0 && (val[i - 1] == ' ' || val[i - 1] == '\t'))
897 i--;
898 val[i] = '\0';
900 if (strcmp (var, "lexical-binding") == 0)
901 /* This is it... */
903 rv = (strcmp (val, "nil") != 0);
904 break;
909 while (ch != '\n' && ch != EOF)
910 ch = READCHAR;
912 return rv;
916 /* Value is a version number of byte compiled code if the file
917 associated with file descriptor FD is a compiled Lisp file that's
918 safe to load. Only files compiled with Emacs are safe to load.
919 Files compiled with XEmacs can lead to a crash in Fbyte_code
920 because of an incompatible change in the byte compiler. */
922 static int
923 safe_to_load_version (int fd)
925 char buf[512];
926 int nbytes, i;
927 int version = 1;
929 /* Read the first few bytes from the file, and look for a line
930 specifying the byte compiler version used. */
931 nbytes = emacs_read (fd, buf, sizeof buf);
932 if (nbytes > 0)
934 /* Skip to the next newline, skipping over the initial `ELC'
935 with NUL bytes following it, but note the version. */
936 for (i = 0; i < nbytes && buf[i] != '\n'; ++i)
937 if (i == 4)
938 version = buf[i];
940 if (i >= nbytes
941 || fast_c_string_match_ignore_case (Vbytecomp_version_regexp,
942 buf + i, nbytes - i) < 0)
943 version = 0;
946 lseek (fd, 0, SEEK_SET);
947 return version;
951 /* Callback for record_unwind_protect. Restore the old load list OLD,
952 after loading a file successfully. */
954 static void
955 record_load_unwind (Lisp_Object old)
957 Vloads_in_progress = old;
960 /* This handler function is used via internal_condition_case_1. */
962 static Lisp_Object
963 load_error_handler (Lisp_Object data)
965 return Qnil;
968 static void
969 load_warn_old_style_backquotes (Lisp_Object file)
971 if (!NILP (Vold_style_backquotes))
973 Lisp_Object args[2];
974 args[0] = build_string ("Loading `%s': old-style backquotes detected!");
975 args[1] = file;
976 Fmessage (2, args);
980 DEFUN ("get-load-suffixes", Fget_load_suffixes, Sget_load_suffixes, 0, 0, 0,
981 doc: /* Return the suffixes that `load' should try if a suffix is \
982 required.
983 This uses the variables `load-suffixes' and `load-file-rep-suffixes'. */)
984 (void)
986 Lisp_Object lst = Qnil, suffixes = Vload_suffixes, suffix, ext;
987 while (CONSP (suffixes))
989 Lisp_Object exts = Vload_file_rep_suffixes;
990 suffix = XCAR (suffixes);
991 suffixes = XCDR (suffixes);
992 while (CONSP (exts))
994 ext = XCAR (exts);
995 exts = XCDR (exts);
996 lst = Fcons (concat2 (suffix, ext), lst);
999 return Fnreverse (lst);
1002 DEFUN ("load", Fload, Sload, 1, 5, 0,
1003 doc: /* Execute a file of Lisp code named FILE.
1004 First try FILE with `.elc' appended, then try with `.el',
1005 then try FILE unmodified (the exact suffixes in the exact order are
1006 determined by `load-suffixes'). Environment variable references in
1007 FILE are replaced with their values by calling `substitute-in-file-name'.
1008 This function searches the directories in `load-path'.
1010 If optional second arg NOERROR is non-nil,
1011 report no error if FILE doesn't exist.
1012 Print messages at start and end of loading unless
1013 optional third arg NOMESSAGE is non-nil (but `force-load-messages'
1014 overrides that).
1015 If optional fourth arg NOSUFFIX is non-nil, don't try adding
1016 suffixes `.elc' or `.el' to the specified name FILE.
1017 If optional fifth arg MUST-SUFFIX is non-nil, insist on
1018 the suffix `.elc' or `.el'; don't accept just FILE unless
1019 it ends in one of those suffixes or includes a directory name.
1021 If NOSUFFIX is nil, then if a file could not be found, try looking for
1022 a different representation of the file by adding non-empty suffixes to
1023 its name, before trying another file. Emacs uses this feature to find
1024 compressed versions of files when Auto Compression mode is enabled.
1025 If NOSUFFIX is non-nil, disable this feature.
1027 The suffixes that this function tries out, when NOSUFFIX is nil, are
1028 given by the return value of `get-load-suffixes' and the values listed
1029 in `load-file-rep-suffixes'. If MUST-SUFFIX is non-nil, only the
1030 return value of `get-load-suffixes' is used, i.e. the file name is
1031 required to have a non-empty suffix.
1033 Loading a file records its definitions, and its `provide' and
1034 `require' calls, in an element of `load-history' whose
1035 car is the file name loaded. See `load-history'.
1037 While the file is in the process of being loaded, the variable
1038 `load-in-progress' is non-nil and the variable `load-file-name'
1039 is bound to the file's name.
1041 Return t if the file exists and loads successfully. */)
1042 (Lisp_Object file, Lisp_Object noerror, Lisp_Object nomessage,
1043 Lisp_Object nosuffix, Lisp_Object must_suffix)
1045 FILE *stream;
1046 int fd;
1047 int fd_index = 0;
1048 ptrdiff_t count = SPECPDL_INDEX ();
1049 struct gcpro gcpro1, gcpro2, gcpro3;
1050 Lisp_Object found, efound, hist_file_name;
1051 /* True means we printed the ".el is newer" message. */
1052 bool newer = 0;
1053 /* True means we are loading a compiled file. */
1054 bool compiled = 0;
1055 Lisp_Object handler;
1056 bool safe_p = 1;
1057 const char *fmode = "r";
1058 int version;
1060 #ifdef DOS_NT
1061 fmode = "rt";
1062 #endif /* DOS_NT */
1064 CHECK_STRING (file);
1066 /* If file name is magic, call the handler. */
1067 /* This shouldn't be necessary any more now that `openp' handles it right.
1068 handler = Ffind_file_name_handler (file, Qload);
1069 if (!NILP (handler))
1070 return call5 (handler, Qload, file, noerror, nomessage, nosuffix); */
1072 /* Do this after the handler to avoid
1073 the need to gcpro noerror, nomessage and nosuffix.
1074 (Below here, we care only whether they are nil or not.)
1075 The presence of this call is the result of a historical accident:
1076 it used to be in every file-operation and when it got removed
1077 everywhere, it accidentally stayed here. Since then, enough people
1078 supposedly have things like (load "$PROJECT/foo.el") in their .emacs
1079 that it seemed risky to remove. */
1080 if (! NILP (noerror))
1082 file = internal_condition_case_1 (Fsubstitute_in_file_name, file,
1083 Qt, load_error_handler);
1084 if (NILP (file))
1085 return Qnil;
1087 else
1088 file = Fsubstitute_in_file_name (file);
1090 /* Avoid weird lossage with null string as arg,
1091 since it would try to load a directory as a Lisp file. */
1092 if (SCHARS (file) == 0)
1094 fd = -1;
1095 errno = ENOENT;
1097 else
1099 Lisp_Object suffixes;
1100 found = Qnil;
1101 GCPRO2 (file, found);
1103 if (! NILP (must_suffix))
1105 /* Don't insist on adding a suffix if FILE already ends with one. */
1106 ptrdiff_t size = SBYTES (file);
1107 if (size > 3
1108 && !strcmp (SSDATA (file) + size - 3, ".el"))
1109 must_suffix = Qnil;
1110 else if (size > 4
1111 && !strcmp (SSDATA (file) + size - 4, ".elc"))
1112 must_suffix = Qnil;
1113 /* Don't insist on adding a suffix
1114 if the argument includes a directory name. */
1115 else if (! NILP (Ffile_name_directory (file)))
1116 must_suffix = Qnil;
1119 if (!NILP (nosuffix))
1120 suffixes = Qnil;
1121 else
1123 suffixes = Fget_load_suffixes ();
1124 if (NILP (must_suffix))
1126 Lisp_Object arg[2];
1127 arg[0] = suffixes;
1128 arg[1] = Vload_file_rep_suffixes;
1129 suffixes = Fappend (2, arg);
1133 fd = openp (Vload_path, file, suffixes, &found, Qnil);
1134 UNGCPRO;
1137 if (fd == -1)
1139 if (NILP (noerror))
1140 report_file_error ("Cannot open load file", file);
1141 return Qnil;
1144 /* Tell startup.el whether or not we found the user's init file. */
1145 if (EQ (Qt, Vuser_init_file))
1146 Vuser_init_file = found;
1148 /* If FD is -2, that means openp found a magic file. */
1149 if (fd == -2)
1151 if (NILP (Fequal (found, file)))
1152 /* If FOUND is a different file name from FILE,
1153 find its handler even if we have already inhibited
1154 the `load' operation on FILE. */
1155 handler = Ffind_file_name_handler (found, Qt);
1156 else
1157 handler = Ffind_file_name_handler (found, Qload);
1158 if (! NILP (handler))
1159 return call5 (handler, Qload, found, noerror, nomessage, Qt);
1160 #ifdef DOS_NT
1161 /* Tramp has to deal with semi-broken packages that prepend
1162 drive letters to remote files. For that reason, Tramp
1163 catches file operations that test for file existence, which
1164 makes openp think X:/foo.elc files are remote. However,
1165 Tramp does not catch `load' operations for such files, so we
1166 end up with a nil as the `load' handler above. If we would
1167 continue with fd = -2, we will behave wrongly, and in
1168 particular try reading a .elc file in the "rt" mode instead
1169 of "rb". See bug #9311 for the results. To work around
1170 this, we try to open the file locally, and go with that if it
1171 succeeds. */
1172 fd = emacs_open (SSDATA (ENCODE_FILE (found)), O_RDONLY, 0);
1173 if (fd == -1)
1174 fd = -2;
1175 #endif
1178 if (fd >= 0)
1180 fd_index = SPECPDL_INDEX ();
1181 record_unwind_protect_int (close_file_unwind, fd);
1184 /* Check if we're stuck in a recursive load cycle.
1186 2000-09-21: It's not possible to just check for the file loaded
1187 being a member of Vloads_in_progress. This fails because of the
1188 way the byte compiler currently works; `provide's are not
1189 evaluated, see font-lock.el/jit-lock.el as an example. This
1190 leads to a certain amount of ``normal'' recursion.
1192 Also, just loading a file recursively is not always an error in
1193 the general case; the second load may do something different. */
1195 int load_count = 0;
1196 Lisp_Object tem;
1197 for (tem = Vloads_in_progress; CONSP (tem); tem = XCDR (tem))
1198 if (!NILP (Fequal (found, XCAR (tem))) && (++load_count > 3))
1199 signal_error ("Recursive load", Fcons (found, Vloads_in_progress));
1200 record_unwind_protect (record_load_unwind, Vloads_in_progress);
1201 Vloads_in_progress = Fcons (found, Vloads_in_progress);
1204 /* All loads are by default dynamic, unless the file itself specifies
1205 otherwise using a file-variable in the first line. This is bound here
1206 so that it takes effect whether or not we use
1207 Vload_source_file_function. */
1208 specbind (Qlexical_binding, Qnil);
1210 /* Get the name for load-history. */
1211 hist_file_name = (! NILP (Vpurify_flag)
1212 ? concat2 (Ffile_name_directory (file),
1213 Ffile_name_nondirectory (found))
1214 : found) ;
1216 version = -1;
1218 /* Check for the presence of old-style quotes and warn about them. */
1219 specbind (Qold_style_backquotes, Qnil);
1220 record_unwind_protect (load_warn_old_style_backquotes, file);
1222 if (!memcmp (SDATA (found) + SBYTES (found) - 4, ".elc", 4)
1223 || (fd >= 0 && (version = safe_to_load_version (fd)) > 0))
1224 /* Load .elc files directly, but not when they are
1225 remote and have no handler! */
1227 if (fd != -2)
1229 struct stat s1, s2;
1230 int result;
1232 GCPRO3 (file, found, hist_file_name);
1234 if (version < 0
1235 && ! (version = safe_to_load_version (fd)))
1237 safe_p = 0;
1238 if (!load_dangerous_libraries)
1239 error ("File `%s' was not compiled in Emacs", SDATA (found));
1240 else if (!NILP (nomessage) && !force_load_messages)
1241 message_with_string ("File `%s' not compiled in Emacs", found, 1);
1244 compiled = 1;
1246 efound = ENCODE_FILE (found);
1248 #ifdef DOS_NT
1249 fmode = "rb";
1250 #endif /* DOS_NT */
1251 result = stat (SSDATA (efound), &s1);
1252 if (result == 0)
1254 SSET (efound, SBYTES (efound) - 1, 0);
1255 result = stat (SSDATA (efound), &s2);
1256 SSET (efound, SBYTES (efound) - 1, 'c');
1259 if (result == 0
1260 && EMACS_TIME_LT (get_stat_mtime (&s1), get_stat_mtime (&s2)))
1262 /* Make the progress messages mention that source is newer. */
1263 newer = 1;
1265 /* If we won't print another message, mention this anyway. */
1266 if (!NILP (nomessage) && !force_load_messages)
1268 Lisp_Object msg_file;
1269 msg_file = Fsubstring (found, make_number (0), make_number (-1));
1270 message_with_string ("Source file `%s' newer than byte-compiled file",
1271 msg_file, 1);
1274 UNGCPRO;
1277 else
1279 /* We are loading a source file (*.el). */
1280 if (!NILP (Vload_source_file_function))
1282 Lisp_Object val;
1284 if (fd >= 0)
1286 emacs_close (fd);
1287 clear_unwind_protect (fd_index);
1289 val = call4 (Vload_source_file_function, found, hist_file_name,
1290 NILP (noerror) ? Qnil : Qt,
1291 (NILP (nomessage) || force_load_messages) ? Qnil : Qt);
1292 return unbind_to (count, val);
1296 GCPRO3 (file, found, hist_file_name);
1298 if (fd < 0)
1300 /* We somehow got here with fd == -2, meaning the file is deemed
1301 to be remote. Don't even try to reopen the file locally;
1302 just force a failure. */
1303 stream = NULL;
1304 errno = EINVAL;
1306 else
1308 #ifdef WINDOWSNT
1309 emacs_close (fd);
1310 clear_unwind_protect (fd_index);
1311 efound = ENCODE_FILE (found);
1312 stream = emacs_fopen (SSDATA (efound), fmode);
1313 #else
1314 stream = fdopen (fd, fmode);
1315 #endif
1317 if (! stream)
1318 report_file_error ("Opening stdio stream", file);
1319 set_unwind_protect_ptr (fd_index, fclose_unwind, stream);
1321 if (! NILP (Vpurify_flag))
1322 Vpreloaded_file_list = Fcons (Fpurecopy (file), Vpreloaded_file_list);
1324 if (NILP (nomessage) || force_load_messages)
1326 if (!safe_p)
1327 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
1328 file, 1);
1329 else if (!compiled)
1330 message_with_string ("Loading %s (source)...", file, 1);
1331 else if (newer)
1332 message_with_string ("Loading %s (compiled; note, source file is newer)...",
1333 file, 1);
1334 else /* The typical case; compiled file newer than source file. */
1335 message_with_string ("Loading %s...", file, 1);
1338 specbind (Qload_file_name, found);
1339 specbind (Qinhibit_file_name_operation, Qnil);
1340 specbind (Qload_in_progress, Qt);
1342 instream = stream;
1343 if (lisp_file_lexically_bound_p (Qget_file_char))
1344 Fset (Qlexical_binding, Qt);
1346 if (! version || version >= 22)
1347 readevalloop (Qget_file_char, stream, hist_file_name,
1348 0, Qnil, Qnil, Qnil, Qnil);
1349 else
1351 /* We can't handle a file which was compiled with
1352 byte-compile-dynamic by older version of Emacs. */
1353 specbind (Qload_force_doc_strings, Qt);
1354 readevalloop (Qget_emacs_mule_file_char, stream, hist_file_name,
1355 0, Qnil, Qnil, Qnil, Qnil);
1357 unbind_to (count, Qnil);
1359 /* Run any eval-after-load forms for this file. */
1360 if (!NILP (Ffboundp (Qdo_after_load_evaluation)))
1361 call1 (Qdo_after_load_evaluation, hist_file_name) ;
1363 UNGCPRO;
1365 xfree (saved_doc_string);
1366 saved_doc_string = 0;
1367 saved_doc_string_size = 0;
1369 xfree (prev_saved_doc_string);
1370 prev_saved_doc_string = 0;
1371 prev_saved_doc_string_size = 0;
1373 if (!noninteractive && (NILP (nomessage) || force_load_messages))
1375 if (!safe_p)
1376 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
1377 file, 1);
1378 else if (!compiled)
1379 message_with_string ("Loading %s (source)...done", file, 1);
1380 else if (newer)
1381 message_with_string ("Loading %s (compiled; note, source file is newer)...done",
1382 file, 1);
1383 else /* The typical case; compiled file newer than source file. */
1384 message_with_string ("Loading %s...done", file, 1);
1387 return Qt;
1390 static bool
1391 complete_filename_p (Lisp_Object pathname)
1393 const unsigned char *s = SDATA (pathname);
1394 return (IS_DIRECTORY_SEP (s[0])
1395 || (SCHARS (pathname) > 2
1396 && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2])));
1399 DEFUN ("locate-file-internal", Flocate_file_internal, Slocate_file_internal, 2, 4, 0,
1400 doc: /* Search for FILENAME through PATH.
1401 Returns the file's name in absolute form, or nil if not found.
1402 If SUFFIXES is non-nil, it should be a list of suffixes to append to
1403 file name when searching.
1404 If non-nil, PREDICATE is used instead of `file-readable-p'.
1405 PREDICATE can also be an integer to pass to the faccessat(2) function,
1406 in which case file-name-handlers are ignored.
1407 This function will normally skip directories, so if you want it to find
1408 directories, make sure the PREDICATE function returns `dir-ok' for them. */)
1409 (Lisp_Object filename, Lisp_Object path, Lisp_Object suffixes, Lisp_Object predicate)
1411 Lisp_Object file;
1412 int fd = openp (path, filename, suffixes, &file, predicate);
1413 if (NILP (predicate) && fd >= 0)
1414 emacs_close (fd);
1415 return file;
1418 static Lisp_Object Qdir_ok;
1420 /* Search for a file whose name is STR, looking in directories
1421 in the Lisp list PATH, and trying suffixes from SUFFIX.
1422 On success, return a file descriptor (or 1 or -2 as described below).
1423 On failure, return -1 and set errno.
1425 SUFFIXES is a list of strings containing possible suffixes.
1426 The empty suffix is automatically added if the list is empty.
1428 PREDICATE non-nil means don't open the files,
1429 just look for one that satisfies the predicate. In this case,
1430 return 1 on success. The predicate can be a lisp function or
1431 an integer to pass to `access' (in which case file-name-handlers
1432 are ignored).
1434 If STOREPTR is nonzero, it points to a slot where the name of
1435 the file actually found should be stored as a Lisp string.
1436 nil is stored there on failure.
1438 If the file we find is remote, return -2
1439 but store the found remote file name in *STOREPTR. */
1442 openp (Lisp_Object path, Lisp_Object str, Lisp_Object suffixes,
1443 Lisp_Object *storeptr, Lisp_Object predicate)
1445 ptrdiff_t fn_size = 100;
1446 char buf[100];
1447 char *fn = buf;
1448 bool absolute = 0;
1449 ptrdiff_t want_length;
1450 Lisp_Object filename;
1451 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
1452 Lisp_Object string, tail, encoded_fn;
1453 ptrdiff_t max_suffix_len = 0;
1454 int last_errno = ENOENT;
1456 CHECK_STRING (str);
1458 for (tail = suffixes; CONSP (tail); tail = XCDR (tail))
1460 CHECK_STRING_CAR (tail);
1461 max_suffix_len = max (max_suffix_len,
1462 SBYTES (XCAR (tail)));
1465 string = filename = encoded_fn = Qnil;
1466 GCPRO6 (str, string, filename, path, suffixes, encoded_fn);
1468 if (storeptr)
1469 *storeptr = Qnil;
1471 if (complete_filename_p (str))
1472 absolute = 1;
1474 for (; CONSP (path); path = XCDR (path))
1476 filename = Fexpand_file_name (str, XCAR (path));
1477 if (!complete_filename_p (filename))
1478 /* If there are non-absolute elts in PATH (eg "."). */
1479 /* Of course, this could conceivably lose if luser sets
1480 default-directory to be something non-absolute... */
1482 filename = Fexpand_file_name (filename, BVAR (current_buffer, directory));
1483 if (!complete_filename_p (filename))
1484 /* Give up on this path element! */
1485 continue;
1488 /* Calculate maximum length of any filename made from
1489 this path element/specified file name and any possible suffix. */
1490 want_length = max_suffix_len + SBYTES (filename);
1491 if (fn_size <= want_length)
1492 fn = alloca (fn_size = 100 + want_length);
1494 /* Loop over suffixes. */
1495 for (tail = NILP (suffixes) ? list1 (empty_unibyte_string) : suffixes;
1496 CONSP (tail); tail = XCDR (tail))
1498 ptrdiff_t fnlen, lsuffix = SBYTES (XCAR (tail));
1499 Lisp_Object handler;
1501 /* Concatenate path element/specified name with the suffix.
1502 If the directory starts with /:, remove that. */
1503 int prefixlen = ((SCHARS (filename) > 2
1504 && SREF (filename, 0) == '/'
1505 && SREF (filename, 1) == ':')
1506 ? 2 : 0);
1507 fnlen = SBYTES (filename) - prefixlen;
1508 memcpy (fn, SDATA (filename) + prefixlen, fnlen);
1509 memcpy (fn + fnlen, SDATA (XCAR (tail)), lsuffix + 1);
1510 fnlen += lsuffix;
1511 /* Check that the file exists and is not a directory. */
1512 /* We used to only check for handlers on non-absolute file names:
1513 if (absolute)
1514 handler = Qnil;
1515 else
1516 handler = Ffind_file_name_handler (filename, Qfile_exists_p);
1517 It's not clear why that was the case and it breaks things like
1518 (load "/bar.el") where the file is actually "/bar.el.gz". */
1519 string = make_string (fn, fnlen);
1520 handler = Ffind_file_name_handler (string, Qfile_exists_p);
1521 if ((!NILP (handler) || !NILP (predicate)) && !NATNUMP (predicate))
1523 bool exists;
1524 if (NILP (predicate))
1525 exists = !NILP (Ffile_readable_p (string));
1526 else
1528 Lisp_Object tmp = call1 (predicate, string);
1529 if (NILP (tmp))
1530 exists = 0;
1531 else if (EQ (tmp, Qdir_ok)
1532 || NILP (Ffile_directory_p (string)))
1533 exists = 1;
1534 else
1536 exists = 0;
1537 last_errno = EISDIR;
1541 if (exists)
1543 /* We succeeded; return this descriptor and filename. */
1544 if (storeptr)
1545 *storeptr = string;
1546 UNGCPRO;
1547 return -2;
1550 else
1552 int fd;
1553 const char *pfn;
1555 encoded_fn = ENCODE_FILE (string);
1556 pfn = SSDATA (encoded_fn);
1558 /* Check that we can access or open it. */
1559 if (NATNUMP (predicate))
1561 fd = -1;
1562 if (INT_MAX < XFASTINT (predicate))
1563 last_errno = EINVAL;
1564 else if (faccessat (AT_FDCWD, pfn, XFASTINT (predicate),
1565 AT_EACCESS)
1566 == 0)
1568 if (file_directory_p (pfn))
1569 last_errno = EISDIR;
1570 else
1571 fd = 1;
1574 else
1576 fd = emacs_open (pfn, O_RDONLY, 0);
1577 if (fd < 0)
1579 if (errno != ENOENT)
1580 last_errno = errno;
1582 else
1584 struct stat st;
1585 int err = (fstat (fd, &st) != 0 ? errno
1586 : S_ISDIR (st.st_mode) ? EISDIR : 0);
1587 if (err)
1589 last_errno = err;
1590 emacs_close (fd);
1591 fd = -1;
1596 if (fd >= 0)
1598 /* We succeeded; return this descriptor and filename. */
1599 if (storeptr)
1600 *storeptr = string;
1601 UNGCPRO;
1602 return fd;
1606 if (absolute)
1607 break;
1610 UNGCPRO;
1611 errno = last_errno;
1612 return -1;
1616 /* Merge the list we've accumulated of globals from the current input source
1617 into the load_history variable. The details depend on whether
1618 the source has an associated file name or not.
1620 FILENAME is the file name that we are loading from.
1622 ENTIRE is true if loading that entire file, false if evaluating
1623 part of it. */
1625 static void
1626 build_load_history (Lisp_Object filename, bool entire)
1628 Lisp_Object tail, prev, newelt;
1629 Lisp_Object tem, tem2;
1630 bool foundit = 0;
1632 tail = Vload_history;
1633 prev = Qnil;
1635 while (CONSP (tail))
1637 tem = XCAR (tail);
1639 /* Find the feature's previous assoc list... */
1640 if (!NILP (Fequal (filename, Fcar (tem))))
1642 foundit = 1;
1644 /* If we're loading the entire file, remove old data. */
1645 if (entire)
1647 if (NILP (prev))
1648 Vload_history = XCDR (tail);
1649 else
1650 Fsetcdr (prev, XCDR (tail));
1653 /* Otherwise, cons on new symbols that are not already members. */
1654 else
1656 tem2 = Vcurrent_load_list;
1658 while (CONSP (tem2))
1660 newelt = XCAR (tem2);
1662 if (NILP (Fmember (newelt, tem)))
1663 Fsetcar (tail, Fcons (XCAR (tem),
1664 Fcons (newelt, XCDR (tem))));
1666 tem2 = XCDR (tem2);
1667 QUIT;
1671 else
1672 prev = tail;
1673 tail = XCDR (tail);
1674 QUIT;
1677 /* If we're loading an entire file, cons the new assoc onto the
1678 front of load-history, the most-recently-loaded position. Also
1679 do this if we didn't find an existing member for the file. */
1680 if (entire || !foundit)
1681 Vload_history = Fcons (Fnreverse (Vcurrent_load_list),
1682 Vload_history);
1685 static void
1686 readevalloop_1 (int old)
1688 load_convert_to_unibyte = old;
1691 /* Signal an `end-of-file' error, if possible with file name
1692 information. */
1694 static _Noreturn void
1695 end_of_file_error (void)
1697 if (STRINGP (Vload_file_name))
1698 xsignal1 (Qend_of_file, Vload_file_name);
1700 xsignal0 (Qend_of_file);
1703 /* UNIBYTE specifies how to set load_convert_to_unibyte
1704 for this invocation.
1705 READFUN, if non-nil, is used instead of `read'.
1707 START, END specify region to read in current buffer (from eval-region).
1708 If the input is not from a buffer, they must be nil. */
1710 static void
1711 readevalloop (Lisp_Object readcharfun,
1712 FILE *stream,
1713 Lisp_Object sourcename,
1714 bool printflag,
1715 Lisp_Object unibyte, Lisp_Object readfun,
1716 Lisp_Object start, Lisp_Object end)
1718 register int c;
1719 register Lisp_Object val;
1720 ptrdiff_t count = SPECPDL_INDEX ();
1721 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1722 struct buffer *b = 0;
1723 bool continue_reading_p;
1724 Lisp_Object lex_bound;
1725 /* True if reading an entire buffer. */
1726 bool whole_buffer = 0;
1727 /* True on the first time around. */
1728 bool first_sexp = 1;
1729 Lisp_Object macroexpand = intern ("internal-macroexpand-for-load");
1731 if (NILP (Ffboundp (macroexpand))
1732 /* Don't macroexpand in .elc files, since it should have been done
1733 already. We actually don't know whether we're in a .elc file or not,
1734 so we use circumstantial evidence: .el files normally go through
1735 Vload_source_file_function -> load-with-code-conversion
1736 -> eval-buffer. */
1737 || EQ (readcharfun, Qget_file_char)
1738 || EQ (readcharfun, Qget_emacs_mule_file_char))
1739 macroexpand = Qnil;
1741 if (MARKERP (readcharfun))
1743 if (NILP (start))
1744 start = readcharfun;
1747 if (BUFFERP (readcharfun))
1748 b = XBUFFER (readcharfun);
1749 else if (MARKERP (readcharfun))
1750 b = XMARKER (readcharfun)->buffer;
1752 /* We assume START is nil when input is not from a buffer. */
1753 if (! NILP (start) && !b)
1754 emacs_abort ();
1756 specbind (Qstandard_input, readcharfun); /* GCPROs readcharfun. */
1757 specbind (Qcurrent_load_list, Qnil);
1758 record_unwind_protect_int (readevalloop_1, load_convert_to_unibyte);
1759 load_convert_to_unibyte = !NILP (unibyte);
1761 /* If lexical binding is active (either because it was specified in
1762 the file's header, or via a buffer-local variable), create an empty
1763 lexical environment, otherwise, turn off lexical binding. */
1764 lex_bound = find_symbol_value (Qlexical_binding);
1765 specbind (Qinternal_interpreter_environment,
1766 (NILP (lex_bound) || EQ (lex_bound, Qunbound)
1767 ? Qnil : list1 (Qt)));
1769 GCPRO4 (sourcename, readfun, start, end);
1771 /* Try to ensure sourcename is a truename, except whilst preloading. */
1772 if (NILP (Vpurify_flag)
1773 && !NILP (sourcename) && !NILP (Ffile_name_absolute_p (sourcename))
1774 && !NILP (Ffboundp (Qfile_truename)))
1775 sourcename = call1 (Qfile_truename, sourcename) ;
1777 LOADHIST_ATTACH (sourcename);
1779 continue_reading_p = 1;
1780 while (continue_reading_p)
1782 ptrdiff_t count1 = SPECPDL_INDEX ();
1784 if (b != 0 && !BUFFER_LIVE_P (b))
1785 error ("Reading from killed buffer");
1787 if (!NILP (start))
1789 /* Switch to the buffer we are reading from. */
1790 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1791 set_buffer_internal (b);
1793 /* Save point in it. */
1794 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1795 /* Save ZV in it. */
1796 record_unwind_protect (save_restriction_restore, save_restriction_save ());
1797 /* Those get unbound after we read one expression. */
1799 /* Set point and ZV around stuff to be read. */
1800 Fgoto_char (start);
1801 if (!NILP (end))
1802 Fnarrow_to_region (make_number (BEGV), end);
1804 /* Just for cleanliness, convert END to a marker
1805 if it is an integer. */
1806 if (INTEGERP (end))
1807 end = Fpoint_max_marker ();
1810 /* On the first cycle, we can easily test here
1811 whether we are reading the whole buffer. */
1812 if (b && first_sexp)
1813 whole_buffer = (PT == BEG && ZV == Z);
1815 instream = stream;
1816 read_next:
1817 c = READCHAR;
1818 if (c == ';')
1820 while ((c = READCHAR) != '\n' && c != -1);
1821 goto read_next;
1823 if (c < 0)
1825 unbind_to (count1, Qnil);
1826 break;
1829 /* Ignore whitespace here, so we can detect eof. */
1830 if (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r'
1831 || c == 0xa0) /* NBSP */
1832 goto read_next;
1834 if (!NILP (Vpurify_flag) && c == '(')
1836 val = read_list (0, readcharfun);
1838 else
1840 UNREAD (c);
1841 read_objects = Qnil;
1842 if (!NILP (readfun))
1844 val = call1 (readfun, readcharfun);
1846 /* If READCHARFUN has set point to ZV, we should
1847 stop reading, even if the form read sets point
1848 to a different value when evaluated. */
1849 if (BUFFERP (readcharfun))
1851 struct buffer *buf = XBUFFER (readcharfun);
1852 if (BUF_PT (buf) == BUF_ZV (buf))
1853 continue_reading_p = 0;
1856 else if (! NILP (Vload_read_function))
1857 val = call1 (Vload_read_function, readcharfun);
1858 else
1859 val = read_internal_start (readcharfun, Qnil, Qnil);
1862 if (!NILP (start) && continue_reading_p)
1863 start = Fpoint_marker ();
1865 /* Restore saved point and BEGV. */
1866 unbind_to (count1, Qnil);
1868 /* Now eval what we just read. */
1869 if (!NILP (macroexpand))
1870 val = call1 (macroexpand, val);
1871 val = eval_sub (val);
1873 if (printflag)
1875 Vvalues = Fcons (val, Vvalues);
1876 if (EQ (Vstandard_output, Qt))
1877 Fprin1 (val, Qnil);
1878 else
1879 Fprint (val, Qnil);
1882 first_sexp = 0;
1885 build_load_history (sourcename,
1886 stream || whole_buffer);
1888 UNGCPRO;
1890 unbind_to (count, Qnil);
1893 DEFUN ("eval-buffer", Feval_buffer, Seval_buffer, 0, 5, "",
1894 doc: /* Execute the current buffer as Lisp code.
1895 When called from a Lisp program (i.e., not interactively), this
1896 function accepts up to five optional arguments:
1897 BUFFER is the buffer to evaluate (nil means use current buffer).
1898 PRINTFLAG controls printing of output:
1899 A value of nil means discard it; anything else is stream for print.
1900 FILENAME specifies the file name to use for `load-history'.
1901 UNIBYTE, if non-nil, specifies `load-convert-to-unibyte' for this
1902 invocation.
1903 DO-ALLOW-PRINT, if non-nil, specifies that `print' and related
1904 functions should work normally even if PRINTFLAG is nil.
1906 This function preserves the position of point. */)
1907 (Lisp_Object buffer, Lisp_Object printflag, Lisp_Object filename, Lisp_Object unibyte, Lisp_Object do_allow_print)
1909 ptrdiff_t count = SPECPDL_INDEX ();
1910 Lisp_Object tem, buf;
1912 if (NILP (buffer))
1913 buf = Fcurrent_buffer ();
1914 else
1915 buf = Fget_buffer (buffer);
1916 if (NILP (buf))
1917 error ("No such buffer");
1919 if (NILP (printflag) && NILP (do_allow_print))
1920 tem = Qsymbolp;
1921 else
1922 tem = printflag;
1924 if (NILP (filename))
1925 filename = BVAR (XBUFFER (buf), filename);
1927 specbind (Qeval_buffer_list, Fcons (buf, Veval_buffer_list));
1928 specbind (Qstandard_output, tem);
1929 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1930 BUF_TEMP_SET_PT (XBUFFER (buf), BUF_BEGV (XBUFFER (buf)));
1931 specbind (Qlexical_binding, lisp_file_lexically_bound_p (buf) ? Qt : Qnil);
1932 readevalloop (buf, 0, filename,
1933 !NILP (printflag), unibyte, Qnil, Qnil, Qnil);
1934 unbind_to (count, Qnil);
1936 return Qnil;
1939 DEFUN ("eval-region", Feval_region, Seval_region, 2, 4, "r",
1940 doc: /* Execute the region as Lisp code.
1941 When called from programs, expects two arguments,
1942 giving starting and ending indices in the current buffer
1943 of the text to be executed.
1944 Programs can pass third argument PRINTFLAG which controls output:
1945 A value of nil means discard it; anything else is stream for printing it.
1946 Also the fourth argument READ-FUNCTION, if non-nil, is used
1947 instead of `read' to read each expression. It gets one argument
1948 which is the input stream for reading characters.
1950 This function does not move point. */)
1951 (Lisp_Object start, Lisp_Object end, Lisp_Object printflag, Lisp_Object read_function)
1953 /* FIXME: Do the eval-sexp-add-defvars dance! */
1954 ptrdiff_t count = SPECPDL_INDEX ();
1955 Lisp_Object tem, cbuf;
1957 cbuf = Fcurrent_buffer ();
1959 if (NILP (printflag))
1960 tem = Qsymbolp;
1961 else
1962 tem = printflag;
1963 specbind (Qstandard_output, tem);
1964 specbind (Qeval_buffer_list, Fcons (cbuf, Veval_buffer_list));
1966 /* `readevalloop' calls functions which check the type of start and end. */
1967 readevalloop (cbuf, 0, BVAR (XBUFFER (cbuf), filename),
1968 !NILP (printflag), Qnil, read_function,
1969 start, end);
1971 return unbind_to (count, Qnil);
1975 DEFUN ("read", Fread, Sread, 0, 1, 0,
1976 doc: /* Read one Lisp expression as text from STREAM, return as Lisp object.
1977 If STREAM is nil, use the value of `standard-input' (which see).
1978 STREAM or the value of `standard-input' may be:
1979 a buffer (read from point and advance it)
1980 a marker (read from where it points and advance it)
1981 a function (call it with no arguments for each character,
1982 call it with a char as argument to push a char back)
1983 a string (takes text from string, starting at the beginning)
1984 t (read text line using minibuffer and use it, or read from
1985 standard input in batch mode). */)
1986 (Lisp_Object stream)
1988 if (NILP (stream))
1989 stream = Vstandard_input;
1990 if (EQ (stream, Qt))
1991 stream = Qread_char;
1992 if (EQ (stream, Qread_char))
1993 /* FIXME: ¿¡ When is this used !? */
1994 return call1 (intern ("read-minibuffer"),
1995 build_string ("Lisp expression: "));
1997 return read_internal_start (stream, Qnil, Qnil);
2000 DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0,
2001 doc: /* Read one Lisp expression which is represented as text by STRING.
2002 Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
2003 FINAL-STRING-INDEX is an integer giving the position of the next
2004 remaining character in STRING.
2005 START and END optionally delimit a substring of STRING from which to read;
2006 they default to 0 and (length STRING) respectively. */)
2007 (Lisp_Object string, Lisp_Object start, Lisp_Object end)
2009 Lisp_Object ret;
2010 CHECK_STRING (string);
2011 /* `read_internal_start' sets `read_from_string_index'. */
2012 ret = read_internal_start (string, start, end);
2013 return Fcons (ret, make_number (read_from_string_index));
2016 /* Function to set up the global context we need in toplevel read
2017 calls. */
2018 static Lisp_Object
2019 read_internal_start (Lisp_Object stream, Lisp_Object start, Lisp_Object end)
2020 /* `start', `end' only used when stream is a string. */
2022 Lisp_Object retval;
2024 readchar_count = 0;
2025 new_backquote_flag = 0;
2026 read_objects = Qnil;
2027 if (EQ (Vread_with_symbol_positions, Qt)
2028 || EQ (Vread_with_symbol_positions, stream))
2029 Vread_symbol_positions_list = Qnil;
2031 if (STRINGP (stream)
2032 || ((CONSP (stream) && STRINGP (XCAR (stream)))))
2034 ptrdiff_t startval, endval;
2035 Lisp_Object string;
2037 if (STRINGP (stream))
2038 string = stream;
2039 else
2040 string = XCAR (stream);
2042 if (NILP (end))
2043 endval = SCHARS (string);
2044 else
2046 CHECK_NUMBER (end);
2047 if (! (0 <= XINT (end) && XINT (end) <= SCHARS (string)))
2048 args_out_of_range (string, end);
2049 endval = XINT (end);
2052 if (NILP (start))
2053 startval = 0;
2054 else
2056 CHECK_NUMBER (start);
2057 if (! (0 <= XINT (start) && XINT (start) <= endval))
2058 args_out_of_range (string, start);
2059 startval = XINT (start);
2061 read_from_string_index = startval;
2062 read_from_string_index_byte = string_char_to_byte (string, startval);
2063 read_from_string_limit = endval;
2066 retval = read0 (stream);
2067 if (EQ (Vread_with_symbol_positions, Qt)
2068 || EQ (Vread_with_symbol_positions, stream))
2069 Vread_symbol_positions_list = Fnreverse (Vread_symbol_positions_list);
2070 return retval;
2074 /* Signal Qinvalid_read_syntax error.
2075 S is error string of length N (if > 0) */
2077 static _Noreturn void
2078 invalid_syntax (const char *s)
2080 xsignal1 (Qinvalid_read_syntax, build_string (s));
2084 /* Use this for recursive reads, in contexts where internal tokens
2085 are not allowed. */
2087 static Lisp_Object
2088 read0 (Lisp_Object readcharfun)
2090 register Lisp_Object val;
2091 int c;
2093 val = read1 (readcharfun, &c, 0);
2094 if (!c)
2095 return val;
2097 xsignal1 (Qinvalid_read_syntax,
2098 Fmake_string (make_number (1), make_number (c)));
2101 static ptrdiff_t read_buffer_size;
2102 static char *read_buffer;
2104 /* Read a \-escape sequence, assuming we already read the `\'.
2105 If the escape sequence forces unibyte, return eight-bit char. */
2107 static int
2108 read_escape (Lisp_Object readcharfun, bool stringp)
2110 int c = READCHAR;
2111 /* \u allows up to four hex digits, \U up to eight. Default to the
2112 behavior for \u, and change this value in the case that \U is seen. */
2113 int unicode_hex_count = 4;
2115 switch (c)
2117 case -1:
2118 end_of_file_error ();
2120 case 'a':
2121 return '\007';
2122 case 'b':
2123 return '\b';
2124 case 'd':
2125 return 0177;
2126 case 'e':
2127 return 033;
2128 case 'f':
2129 return '\f';
2130 case 'n':
2131 return '\n';
2132 case 'r':
2133 return '\r';
2134 case 't':
2135 return '\t';
2136 case 'v':
2137 return '\v';
2138 case '\n':
2139 return -1;
2140 case ' ':
2141 if (stringp)
2142 return -1;
2143 return ' ';
2145 case 'M':
2146 c = READCHAR;
2147 if (c != '-')
2148 error ("Invalid escape character syntax");
2149 c = READCHAR;
2150 if (c == '\\')
2151 c = read_escape (readcharfun, 0);
2152 return c | meta_modifier;
2154 case 'S':
2155 c = READCHAR;
2156 if (c != '-')
2157 error ("Invalid escape character syntax");
2158 c = READCHAR;
2159 if (c == '\\')
2160 c = read_escape (readcharfun, 0);
2161 return c | shift_modifier;
2163 case 'H':
2164 c = READCHAR;
2165 if (c != '-')
2166 error ("Invalid escape character syntax");
2167 c = READCHAR;
2168 if (c == '\\')
2169 c = read_escape (readcharfun, 0);
2170 return c | hyper_modifier;
2172 case 'A':
2173 c = READCHAR;
2174 if (c != '-')
2175 error ("Invalid escape character syntax");
2176 c = READCHAR;
2177 if (c == '\\')
2178 c = read_escape (readcharfun, 0);
2179 return c | alt_modifier;
2181 case 's':
2182 c = READCHAR;
2183 if (stringp || c != '-')
2185 UNREAD (c);
2186 return ' ';
2188 c = READCHAR;
2189 if (c == '\\')
2190 c = read_escape (readcharfun, 0);
2191 return c | super_modifier;
2193 case 'C':
2194 c = READCHAR;
2195 if (c != '-')
2196 error ("Invalid escape character syntax");
2197 case '^':
2198 c = READCHAR;
2199 if (c == '\\')
2200 c = read_escape (readcharfun, 0);
2201 if ((c & ~CHAR_MODIFIER_MASK) == '?')
2202 return 0177 | (c & CHAR_MODIFIER_MASK);
2203 else if (! SINGLE_BYTE_CHAR_P ((c & ~CHAR_MODIFIER_MASK)))
2204 return c | ctrl_modifier;
2205 /* ASCII control chars are made from letters (both cases),
2206 as well as the non-letters within 0100...0137. */
2207 else if ((c & 0137) >= 0101 && (c & 0137) <= 0132)
2208 return (c & (037 | ~0177));
2209 else if ((c & 0177) >= 0100 && (c & 0177) <= 0137)
2210 return (c & (037 | ~0177));
2211 else
2212 return c | ctrl_modifier;
2214 case '0':
2215 case '1':
2216 case '2':
2217 case '3':
2218 case '4':
2219 case '5':
2220 case '6':
2221 case '7':
2222 /* An octal escape, as in ANSI C. */
2224 register int i = c - '0';
2225 register int count = 0;
2226 while (++count < 3)
2228 if ((c = READCHAR) >= '0' && c <= '7')
2230 i *= 8;
2231 i += c - '0';
2233 else
2235 UNREAD (c);
2236 break;
2240 if (i >= 0x80 && i < 0x100)
2241 i = BYTE8_TO_CHAR (i);
2242 return i;
2245 case 'x':
2246 /* A hex escape, as in ANSI C. */
2248 unsigned int i = 0;
2249 int count = 0;
2250 while (1)
2252 c = READCHAR;
2253 if (c >= '0' && c <= '9')
2255 i *= 16;
2256 i += c - '0';
2258 else if ((c >= 'a' && c <= 'f')
2259 || (c >= 'A' && c <= 'F'))
2261 i *= 16;
2262 if (c >= 'a' && c <= 'f')
2263 i += c - 'a' + 10;
2264 else
2265 i += c - 'A' + 10;
2267 else
2269 UNREAD (c);
2270 break;
2272 /* Allow hex escapes as large as ?\xfffffff, because some
2273 packages use them to denote characters with modifiers. */
2274 if ((CHAR_META | (CHAR_META - 1)) < i)
2275 error ("Hex character out of range: \\x%x...", i);
2276 count += count < 3;
2279 if (count < 3 && i >= 0x80)
2280 return BYTE8_TO_CHAR (i);
2281 return i;
2284 case 'U':
2285 /* Post-Unicode-2.0: Up to eight hex chars. */
2286 unicode_hex_count = 8;
2287 case 'u':
2289 /* A Unicode escape. We only permit them in strings and characters,
2290 not arbitrarily in the source code, as in some other languages. */
2292 unsigned int i = 0;
2293 int count = 0;
2295 while (++count <= unicode_hex_count)
2297 c = READCHAR;
2298 /* `isdigit' and `isalpha' may be locale-specific, which we don't
2299 want. */
2300 if (c >= '0' && c <= '9') i = (i << 4) + (c - '0');
2301 else if (c >= 'a' && c <= 'f') i = (i << 4) + (c - 'a') + 10;
2302 else if (c >= 'A' && c <= 'F') i = (i << 4) + (c - 'A') + 10;
2303 else
2304 error ("Non-hex digit used for Unicode escape");
2306 if (i > 0x10FFFF)
2307 error ("Non-Unicode character: 0x%x", i);
2308 return i;
2311 default:
2312 return c;
2316 /* Return the digit that CHARACTER stands for in the given BASE.
2317 Return -1 if CHARACTER is out of range for BASE,
2318 and -2 if CHARACTER is not valid for any supported BASE. */
2319 static int
2320 digit_to_number (int character, int base)
2322 int digit;
2324 if ('0' <= character && character <= '9')
2325 digit = character - '0';
2326 else if ('a' <= character && character <= 'z')
2327 digit = character - 'a' + 10;
2328 else if ('A' <= character && character <= 'Z')
2329 digit = character - 'A' + 10;
2330 else
2331 return -2;
2333 return digit < base ? digit : -1;
2336 /* Read an integer in radix RADIX using READCHARFUN to read
2337 characters. RADIX must be in the interval [2..36]; if it isn't, a
2338 read error is signaled . Value is the integer read. Signals an
2339 error if encountering invalid read syntax or if RADIX is out of
2340 range. */
2342 static Lisp_Object
2343 read_integer (Lisp_Object readcharfun, EMACS_INT radix)
2345 /* Room for sign, leading 0, other digits, trailing null byte.
2346 Also, room for invalid syntax diagnostic. */
2347 char buf[max (1 + 1 + sizeof (uintmax_t) * CHAR_BIT + 1,
2348 sizeof "integer, radix " + INT_STRLEN_BOUND (EMACS_INT))];
2350 int valid = -1; /* 1 if valid, 0 if not, -1 if incomplete. */
2352 if (radix < 2 || radix > 36)
2353 valid = 0;
2354 else
2356 char *p = buf;
2357 int c, digit;
2359 c = READCHAR;
2360 if (c == '-' || c == '+')
2362 *p++ = c;
2363 c = READCHAR;
2366 if (c == '0')
2368 *p++ = c;
2369 valid = 1;
2371 /* Ignore redundant leading zeros, so the buffer doesn't
2372 fill up with them. */
2374 c = READCHAR;
2375 while (c == '0');
2378 while ((digit = digit_to_number (c, radix)) >= -1)
2380 if (digit == -1)
2381 valid = 0;
2382 if (valid < 0)
2383 valid = 1;
2385 if (p < buf + sizeof buf - 1)
2386 *p++ = c;
2387 else
2388 valid = 0;
2390 c = READCHAR;
2393 UNREAD (c);
2394 *p = '\0';
2397 if (! valid)
2399 sprintf (buf, "integer, radix %"pI"d", radix);
2400 invalid_syntax (buf);
2403 return string_to_number (buf, radix, 0);
2407 /* If the next token is ')' or ']' or '.', we store that character
2408 in *PCH and the return value is not interesting. Else, we store
2409 zero in *PCH and we read and return one lisp object.
2411 FIRST_IN_LIST is true if this is the first element of a list. */
2413 static Lisp_Object
2414 read1 (Lisp_Object readcharfun, int *pch, bool first_in_list)
2416 int c;
2417 bool uninterned_symbol = 0;
2418 bool multibyte;
2420 *pch = 0;
2422 retry:
2424 c = READCHAR_REPORT_MULTIBYTE (&multibyte);
2425 if (c < 0)
2426 end_of_file_error ();
2428 switch (c)
2430 case '(':
2431 return read_list (0, readcharfun);
2433 case '[':
2434 return read_vector (readcharfun, 0);
2436 case ')':
2437 case ']':
2439 *pch = c;
2440 return Qnil;
2443 case '#':
2444 c = READCHAR;
2445 if (c == 's')
2447 c = READCHAR;
2448 if (c == '(')
2450 /* Accept extended format for hashtables (extensible to
2451 other types), e.g.
2452 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
2453 Lisp_Object tmp = read_list (0, readcharfun);
2454 Lisp_Object head = CAR_SAFE (tmp);
2455 Lisp_Object data = Qnil;
2456 Lisp_Object val = Qnil;
2457 /* The size is 2 * number of allowed keywords to
2458 make-hash-table. */
2459 Lisp_Object params[10];
2460 Lisp_Object ht;
2461 Lisp_Object key = Qnil;
2462 int param_count = 0;
2464 if (!EQ (head, Qhash_table))
2465 error ("Invalid extended read marker at head of #s list "
2466 "(only hash-table allowed)");
2468 tmp = CDR_SAFE (tmp);
2470 /* This is repetitive but fast and simple. */
2471 params[param_count] = QCsize;
2472 params[param_count + 1] = Fplist_get (tmp, Qsize);
2473 if (!NILP (params[param_count + 1]))
2474 param_count += 2;
2476 params[param_count] = QCtest;
2477 params[param_count + 1] = Fplist_get (tmp, Qtest);
2478 if (!NILP (params[param_count + 1]))
2479 param_count += 2;
2481 params[param_count] = QCweakness;
2482 params[param_count + 1] = Fplist_get (tmp, Qweakness);
2483 if (!NILP (params[param_count + 1]))
2484 param_count += 2;
2486 params[param_count] = QCrehash_size;
2487 params[param_count + 1] = Fplist_get (tmp, Qrehash_size);
2488 if (!NILP (params[param_count + 1]))
2489 param_count += 2;
2491 params[param_count] = QCrehash_threshold;
2492 params[param_count + 1] = Fplist_get (tmp, Qrehash_threshold);
2493 if (!NILP (params[param_count + 1]))
2494 param_count += 2;
2496 /* This is the hashtable data. */
2497 data = Fplist_get (tmp, Qdata);
2499 /* Now use params to make a new hashtable and fill it. */
2500 ht = Fmake_hash_table (param_count, params);
2502 while (CONSP (data))
2504 key = XCAR (data);
2505 data = XCDR (data);
2506 if (!CONSP (data))
2507 error ("Odd number of elements in hashtable data");
2508 val = XCAR (data);
2509 data = XCDR (data);
2510 Fputhash (key, val, ht);
2513 return ht;
2515 UNREAD (c);
2516 invalid_syntax ("#");
2518 if (c == '^')
2520 c = READCHAR;
2521 if (c == '[')
2523 Lisp_Object tmp;
2524 tmp = read_vector (readcharfun, 0);
2525 if (ASIZE (tmp) < CHAR_TABLE_STANDARD_SLOTS)
2526 error ("Invalid size char-table");
2527 XSETPVECTYPE (XVECTOR (tmp), PVEC_CHAR_TABLE);
2528 return tmp;
2530 else if (c == '^')
2532 c = READCHAR;
2533 if (c == '[')
2535 Lisp_Object tmp;
2536 int depth;
2537 ptrdiff_t size;
2539 tmp = read_vector (readcharfun, 0);
2540 size = ASIZE (tmp);
2541 if (size == 0)
2542 error ("Invalid size char-table");
2543 if (! RANGED_INTEGERP (1, AREF (tmp, 0), 3))
2544 error ("Invalid depth in char-table");
2545 depth = XINT (AREF (tmp, 0));
2546 if (chartab_size[depth] != size - 2)
2547 error ("Invalid size char-table");
2548 XSETPVECTYPE (XVECTOR (tmp), PVEC_SUB_CHAR_TABLE);
2549 return tmp;
2551 invalid_syntax ("#^^");
2553 invalid_syntax ("#^");
2555 if (c == '&')
2557 Lisp_Object length;
2558 length = read1 (readcharfun, pch, first_in_list);
2559 c = READCHAR;
2560 if (c == '"')
2562 Lisp_Object tmp, val;
2563 EMACS_INT size_in_chars
2564 = ((XFASTINT (length) + BOOL_VECTOR_BITS_PER_CHAR - 1)
2565 / BOOL_VECTOR_BITS_PER_CHAR);
2567 UNREAD (c);
2568 tmp = read1 (readcharfun, pch, first_in_list);
2569 if (STRING_MULTIBYTE (tmp)
2570 || (size_in_chars != SCHARS (tmp)
2571 /* We used to print 1 char too many
2572 when the number of bits was a multiple of 8.
2573 Accept such input in case it came from an old
2574 version. */
2575 && ! (XFASTINT (length)
2576 == (SCHARS (tmp) - 1) * BOOL_VECTOR_BITS_PER_CHAR)))
2577 invalid_syntax ("#&...");
2579 val = Fmake_bool_vector (length, Qnil);
2580 memcpy (XBOOL_VECTOR (val)->data, SDATA (tmp), size_in_chars);
2581 /* Clear the extraneous bits in the last byte. */
2582 if (XINT (length) != size_in_chars * BOOL_VECTOR_BITS_PER_CHAR)
2583 XBOOL_VECTOR (val)->data[size_in_chars - 1]
2584 &= (1 << (XINT (length) % BOOL_VECTOR_BITS_PER_CHAR)) - 1;
2585 return val;
2587 invalid_syntax ("#&...");
2589 if (c == '[')
2591 /* Accept compiled functions at read-time so that we don't have to
2592 build them using function calls. */
2593 Lisp_Object tmp;
2594 tmp = read_vector (readcharfun, 1);
2595 make_byte_code (XVECTOR (tmp));
2596 return tmp;
2598 if (c == '(')
2600 Lisp_Object tmp;
2601 struct gcpro gcpro1;
2602 int ch;
2604 /* Read the string itself. */
2605 tmp = read1 (readcharfun, &ch, 0);
2606 if (ch != 0 || !STRINGP (tmp))
2607 invalid_syntax ("#");
2608 GCPRO1 (tmp);
2609 /* Read the intervals and their properties. */
2610 while (1)
2612 Lisp_Object beg, end, plist;
2614 beg = read1 (readcharfun, &ch, 0);
2615 end = plist = Qnil;
2616 if (ch == ')')
2617 break;
2618 if (ch == 0)
2619 end = read1 (readcharfun, &ch, 0);
2620 if (ch == 0)
2621 plist = read1 (readcharfun, &ch, 0);
2622 if (ch)
2623 invalid_syntax ("Invalid string property list");
2624 Fset_text_properties (beg, end, plist, tmp);
2626 UNGCPRO;
2627 return tmp;
2630 /* #@NUMBER is used to skip NUMBER following bytes.
2631 That's used in .elc files to skip over doc strings
2632 and function definitions. */
2633 if (c == '@')
2635 enum { extra = 100 };
2636 ptrdiff_t i, nskip = 0, digits = 0;
2638 /* Read a decimal integer. */
2639 while ((c = READCHAR) >= 0
2640 && c >= '0' && c <= '9')
2642 if ((STRING_BYTES_BOUND - extra) / 10 <= nskip)
2643 string_overflow ();
2644 digits++;
2645 nskip *= 10;
2646 nskip += c - '0';
2647 if (digits == 2 && nskip == 0)
2648 { /* We've just seen #@00, which means "skip to end". */
2649 skip_dyn_eof (readcharfun);
2650 return Qnil;
2653 if (nskip > 0)
2654 /* We can't use UNREAD here, because in the code below we side-step
2655 READCHAR. Instead, assume the first char after #@NNN occupies
2656 a single byte, which is the case normally since it's just
2657 a space. */
2658 nskip--;
2659 else
2660 UNREAD (c);
2662 if (load_force_doc_strings
2663 && (FROM_FILE_P (readcharfun)))
2665 /* If we are supposed to force doc strings into core right now,
2666 record the last string that we skipped,
2667 and record where in the file it comes from. */
2669 /* But first exchange saved_doc_string
2670 with prev_saved_doc_string, so we save two strings. */
2672 char *temp = saved_doc_string;
2673 ptrdiff_t temp_size = saved_doc_string_size;
2674 file_offset temp_pos = saved_doc_string_position;
2675 ptrdiff_t temp_len = saved_doc_string_length;
2677 saved_doc_string = prev_saved_doc_string;
2678 saved_doc_string_size = prev_saved_doc_string_size;
2679 saved_doc_string_position = prev_saved_doc_string_position;
2680 saved_doc_string_length = prev_saved_doc_string_length;
2682 prev_saved_doc_string = temp;
2683 prev_saved_doc_string_size = temp_size;
2684 prev_saved_doc_string_position = temp_pos;
2685 prev_saved_doc_string_length = temp_len;
2688 if (saved_doc_string_size == 0)
2690 saved_doc_string = xmalloc (nskip + extra);
2691 saved_doc_string_size = nskip + extra;
2693 if (nskip > saved_doc_string_size)
2695 saved_doc_string = xrealloc (saved_doc_string, nskip + extra);
2696 saved_doc_string_size = nskip + extra;
2699 saved_doc_string_position = file_tell (instream);
2701 /* Copy that many characters into saved_doc_string. */
2702 block_input ();
2703 for (i = 0; i < nskip && c >= 0; i++)
2704 saved_doc_string[i] = c = getc (instream);
2705 unblock_input ();
2707 saved_doc_string_length = i;
2709 else
2710 /* Skip that many bytes. */
2711 skip_dyn_bytes (readcharfun, nskip);
2713 goto retry;
2715 if (c == '!')
2717 /* #! appears at the beginning of an executable file.
2718 Skip the first line. */
2719 while (c != '\n' && c >= 0)
2720 c = READCHAR;
2721 goto retry;
2723 if (c == '$')
2724 return Vload_file_name;
2725 if (c == '\'')
2726 return list2 (Qfunction, read0 (readcharfun));
2727 /* #:foo is the uninterned symbol named foo. */
2728 if (c == ':')
2730 uninterned_symbol = 1;
2731 c = READCHAR;
2732 if (!(c > 040
2733 && c != 0xa0 /* NBSP */
2734 && (c >= 0200
2735 || strchr ("\"';()[]#`,", c) == NULL)))
2737 /* No symbol character follows, this is the empty
2738 symbol. */
2739 UNREAD (c);
2740 return Fmake_symbol (empty_unibyte_string);
2742 goto read_symbol;
2744 /* ## is the empty symbol. */
2745 if (c == '#')
2746 return Fintern (empty_unibyte_string, Qnil);
2747 /* Reader forms that can reuse previously read objects. */
2748 if (c >= '0' && c <= '9')
2750 EMACS_INT n = 0;
2751 Lisp_Object tem;
2753 /* Read a non-negative integer. */
2754 while (c >= '0' && c <= '9')
2756 if (MOST_POSITIVE_FIXNUM / 10 < n
2757 || MOST_POSITIVE_FIXNUM < n * 10 + c - '0')
2758 n = MOST_POSITIVE_FIXNUM + 1;
2759 else
2760 n = n * 10 + c - '0';
2761 c = READCHAR;
2764 if (n <= MOST_POSITIVE_FIXNUM)
2766 if (c == 'r' || c == 'R')
2767 return read_integer (readcharfun, n);
2769 if (! NILP (Vread_circle))
2771 /* #n=object returns object, but associates it with
2772 n for #n#. */
2773 if (c == '=')
2775 /* Make a placeholder for #n# to use temporarily. */
2776 Lisp_Object placeholder;
2777 Lisp_Object cell;
2779 placeholder = Fcons (Qnil, Qnil);
2780 cell = Fcons (make_number (n), placeholder);
2781 read_objects = Fcons (cell, read_objects);
2783 /* Read the object itself. */
2784 tem = read0 (readcharfun);
2786 /* Now put it everywhere the placeholder was... */
2787 substitute_object_in_subtree (tem, placeholder);
2789 /* ...and #n# will use the real value from now on. */
2790 Fsetcdr (cell, tem);
2792 return tem;
2795 /* #n# returns a previously read object. */
2796 if (c == '#')
2798 tem = Fassq (make_number (n), read_objects);
2799 if (CONSP (tem))
2800 return XCDR (tem);
2804 /* Fall through to error message. */
2806 else if (c == 'x' || c == 'X')
2807 return read_integer (readcharfun, 16);
2808 else if (c == 'o' || c == 'O')
2809 return read_integer (readcharfun, 8);
2810 else if (c == 'b' || c == 'B')
2811 return read_integer (readcharfun, 2);
2813 UNREAD (c);
2814 invalid_syntax ("#");
2816 case ';':
2817 while ((c = READCHAR) >= 0 && c != '\n');
2818 goto retry;
2820 case '\'':
2821 return list2 (Qquote, read0 (readcharfun));
2823 case '`':
2825 int next_char = READCHAR;
2826 UNREAD (next_char);
2827 /* Transition from old-style to new-style:
2828 If we see "(`" it used to mean old-style, which usually works
2829 fine because ` should almost never appear in such a position
2830 for new-style. But occasionally we need "(`" to mean new
2831 style, so we try to distinguish the two by the fact that we
2832 can either write "( `foo" or "(` foo", where the first
2833 intends to use new-style whereas the second intends to use
2834 old-style. For Emacs-25, we should completely remove this
2835 first_in_list exception (old-style can still be obtained via
2836 "(\`" anyway). */
2837 if (!new_backquote_flag && first_in_list && next_char == ' ')
2839 Vold_style_backquotes = Qt;
2840 goto default_label;
2842 else
2844 Lisp_Object value;
2845 bool saved_new_backquote_flag = new_backquote_flag;
2847 new_backquote_flag = 1;
2848 value = read0 (readcharfun);
2849 new_backquote_flag = saved_new_backquote_flag;
2851 return list2 (Qbackquote, value);
2854 case ',':
2856 int next_char = READCHAR;
2857 UNREAD (next_char);
2858 /* Transition from old-style to new-style:
2859 It used to be impossible to have a new-style , other than within
2860 a new-style `. This is sufficient when ` and , are used in the
2861 normal way, but ` and , can also appear in args to macros that
2862 will not interpret them in the usual way, in which case , may be
2863 used without any ` anywhere near.
2864 So we now use the same heuristic as for backquote: old-style
2865 unquotes are only recognized when first on a list, and when
2866 followed by a space.
2867 Because it's more difficult to peek 2 chars ahead, a new-style
2868 ,@ can still not be used outside of a `, unless it's in the middle
2869 of a list. */
2870 if (new_backquote_flag
2871 || !first_in_list
2872 || (next_char != ' ' && next_char != '@'))
2874 Lisp_Object comma_type = Qnil;
2875 Lisp_Object value;
2876 int ch = READCHAR;
2878 if (ch == '@')
2879 comma_type = Qcomma_at;
2880 else if (ch == '.')
2881 comma_type = Qcomma_dot;
2882 else
2884 if (ch >= 0) UNREAD (ch);
2885 comma_type = Qcomma;
2888 value = read0 (readcharfun);
2889 return list2 (comma_type, value);
2891 else
2893 Vold_style_backquotes = Qt;
2894 goto default_label;
2897 case '?':
2899 int modifiers;
2900 int next_char;
2901 bool ok;
2903 c = READCHAR;
2904 if (c < 0)
2905 end_of_file_error ();
2907 /* Accept `single space' syntax like (list ? x) where the
2908 whitespace character is SPC or TAB.
2909 Other literal whitespace like NL, CR, and FF are not accepted,
2910 as there are well-established escape sequences for these. */
2911 if (c == ' ' || c == '\t')
2912 return make_number (c);
2914 if (c == '\\')
2915 c = read_escape (readcharfun, 0);
2916 modifiers = c & CHAR_MODIFIER_MASK;
2917 c &= ~CHAR_MODIFIER_MASK;
2918 if (CHAR_BYTE8_P (c))
2919 c = CHAR_TO_BYTE8 (c);
2920 c |= modifiers;
2922 next_char = READCHAR;
2923 ok = (next_char <= 040
2924 || (next_char < 0200
2925 && strchr ("\"';()[]#?`,.", next_char) != NULL));
2926 UNREAD (next_char);
2927 if (ok)
2928 return make_number (c);
2930 invalid_syntax ("?");
2933 case '"':
2935 char *p = read_buffer;
2936 char *end = read_buffer + read_buffer_size;
2937 int ch;
2938 /* True if we saw an escape sequence specifying
2939 a multibyte character. */
2940 bool force_multibyte = 0;
2941 /* True if we saw an escape sequence specifying
2942 a single-byte character. */
2943 bool force_singlebyte = 0;
2944 bool cancel = 0;
2945 ptrdiff_t nchars = 0;
2947 while ((ch = READCHAR) >= 0
2948 && ch != '\"')
2950 if (end - p < MAX_MULTIBYTE_LENGTH)
2952 ptrdiff_t offset = p - read_buffer;
2953 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
2954 memory_full (SIZE_MAX);
2955 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
2956 read_buffer_size *= 2;
2957 p = read_buffer + offset;
2958 end = read_buffer + read_buffer_size;
2961 if (ch == '\\')
2963 int modifiers;
2965 ch = read_escape (readcharfun, 1);
2967 /* CH is -1 if \ newline has just been seen. */
2968 if (ch == -1)
2970 if (p == read_buffer)
2971 cancel = 1;
2972 continue;
2975 modifiers = ch & CHAR_MODIFIER_MASK;
2976 ch = ch & ~CHAR_MODIFIER_MASK;
2978 if (CHAR_BYTE8_P (ch))
2979 force_singlebyte = 1;
2980 else if (! ASCII_CHAR_P (ch))
2981 force_multibyte = 1;
2982 else /* I.e. ASCII_CHAR_P (ch). */
2984 /* Allow `\C- ' and `\C-?'. */
2985 if (modifiers == CHAR_CTL)
2987 if (ch == ' ')
2988 ch = 0, modifiers = 0;
2989 else if (ch == '?')
2990 ch = 127, modifiers = 0;
2992 if (modifiers & CHAR_SHIFT)
2994 /* Shift modifier is valid only with [A-Za-z]. */
2995 if (ch >= 'A' && ch <= 'Z')
2996 modifiers &= ~CHAR_SHIFT;
2997 else if (ch >= 'a' && ch <= 'z')
2998 ch -= ('a' - 'A'), modifiers &= ~CHAR_SHIFT;
3001 if (modifiers & CHAR_META)
3003 /* Move the meta bit to the right place for a
3004 string. */
3005 modifiers &= ~CHAR_META;
3006 ch = BYTE8_TO_CHAR (ch | 0x80);
3007 force_singlebyte = 1;
3011 /* Any modifiers remaining are invalid. */
3012 if (modifiers)
3013 error ("Invalid modifier in string");
3014 p += CHAR_STRING (ch, (unsigned char *) p);
3016 else
3018 p += CHAR_STRING (ch, (unsigned char *) p);
3019 if (CHAR_BYTE8_P (ch))
3020 force_singlebyte = 1;
3021 else if (! ASCII_CHAR_P (ch))
3022 force_multibyte = 1;
3024 nchars++;
3027 if (ch < 0)
3028 end_of_file_error ();
3030 /* If purifying, and string starts with \ newline,
3031 return zero instead. This is for doc strings
3032 that we are really going to find in etc/DOC.nn.nn. */
3033 if (!NILP (Vpurify_flag) && NILP (Vdoc_file_name) && cancel)
3034 return make_number (0);
3036 if (! force_multibyte && force_singlebyte)
3038 /* READ_BUFFER contains raw 8-bit bytes and no multibyte
3039 forms. Convert it to unibyte. */
3040 nchars = str_as_unibyte ((unsigned char *) read_buffer,
3041 p - read_buffer);
3042 p = read_buffer + nchars;
3045 return make_specified_string (read_buffer, nchars, p - read_buffer,
3046 (force_multibyte
3047 || (p - read_buffer != nchars)));
3050 case '.':
3052 int next_char = READCHAR;
3053 UNREAD (next_char);
3055 if (next_char <= 040
3056 || (next_char < 0200
3057 && strchr ("\"';([#?`,", next_char) != NULL))
3059 *pch = c;
3060 return Qnil;
3063 /* Otherwise, we fall through! Note that the atom-reading loop
3064 below will now loop at least once, assuring that we will not
3065 try to UNREAD two characters in a row. */
3067 default:
3068 default_label:
3069 if (c <= 040) goto retry;
3070 if (c == 0xa0) /* NBSP */
3071 goto retry;
3073 read_symbol:
3075 char *p = read_buffer;
3076 bool quoted = 0;
3077 EMACS_INT start_position = readchar_count - 1;
3080 char *end = read_buffer + read_buffer_size;
3084 if (end - p < MAX_MULTIBYTE_LENGTH)
3086 ptrdiff_t offset = p - read_buffer;
3087 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
3088 memory_full (SIZE_MAX);
3089 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
3090 read_buffer_size *= 2;
3091 p = read_buffer + offset;
3092 end = read_buffer + read_buffer_size;
3095 if (c == '\\')
3097 c = READCHAR;
3098 if (c == -1)
3099 end_of_file_error ();
3100 quoted = 1;
3103 if (multibyte)
3104 p += CHAR_STRING (c, (unsigned char *) p);
3105 else
3106 *p++ = c;
3107 c = READCHAR;
3109 while (c > 040
3110 && c != 0xa0 /* NBSP */
3111 && (c >= 0200
3112 || strchr ("\"';()[]#`,", c) == NULL));
3114 if (p == end)
3116 ptrdiff_t offset = p - read_buffer;
3117 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
3118 memory_full (SIZE_MAX);
3119 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
3120 read_buffer_size *= 2;
3121 p = read_buffer + offset;
3122 end = read_buffer + read_buffer_size;
3124 *p = 0;
3125 UNREAD (c);
3128 if (!quoted && !uninterned_symbol)
3130 Lisp_Object result = string_to_number (read_buffer, 10, 0);
3131 if (! NILP (result))
3132 return result;
3135 Lisp_Object name, result;
3136 ptrdiff_t nbytes = p - read_buffer;
3137 ptrdiff_t nchars
3138 = (multibyte
3139 ? multibyte_chars_in_text ((unsigned char *) read_buffer,
3140 nbytes)
3141 : nbytes);
3143 name = ((uninterned_symbol && ! NILP (Vpurify_flag)
3144 ? make_pure_string : make_specified_string)
3145 (read_buffer, nchars, nbytes, multibyte));
3146 result = (uninterned_symbol ? Fmake_symbol (name)
3147 : Fintern (name, Qnil));
3149 if (EQ (Vread_with_symbol_positions, Qt)
3150 || EQ (Vread_with_symbol_positions, readcharfun))
3151 Vread_symbol_positions_list
3152 = Fcons (Fcons (result, make_number (start_position)),
3153 Vread_symbol_positions_list);
3154 return result;
3161 /* List of nodes we've seen during substitute_object_in_subtree. */
3162 static Lisp_Object seen_list;
3164 static void
3165 substitute_object_in_subtree (Lisp_Object object, Lisp_Object placeholder)
3167 Lisp_Object check_object;
3169 /* We haven't seen any objects when we start. */
3170 seen_list = Qnil;
3172 /* Make all the substitutions. */
3173 check_object
3174 = substitute_object_recurse (object, placeholder, object);
3176 /* Clear seen_list because we're done with it. */
3177 seen_list = Qnil;
3179 /* The returned object here is expected to always eq the
3180 original. */
3181 if (!EQ (check_object, object))
3182 error ("Unexpected mutation error in reader");
3185 /* Feval doesn't get called from here, so no gc protection is needed. */
3186 #define SUBSTITUTE(get_val, set_val) \
3187 do { \
3188 Lisp_Object old_value = get_val; \
3189 Lisp_Object true_value \
3190 = substitute_object_recurse (object, placeholder, \
3191 old_value); \
3193 if (!EQ (old_value, true_value)) \
3195 set_val; \
3197 } while (0)
3199 static Lisp_Object
3200 substitute_object_recurse (Lisp_Object object, Lisp_Object placeholder, Lisp_Object subtree)
3202 /* If we find the placeholder, return the target object. */
3203 if (EQ (placeholder, subtree))
3204 return object;
3206 /* If we've been to this node before, don't explore it again. */
3207 if (!EQ (Qnil, Fmemq (subtree, seen_list)))
3208 return subtree;
3210 /* If this node can be the entry point to a cycle, remember that
3211 we've seen it. It can only be such an entry point if it was made
3212 by #n=, which means that we can find it as a value in
3213 read_objects. */
3214 if (!EQ (Qnil, Frassq (subtree, read_objects)))
3215 seen_list = Fcons (subtree, seen_list);
3217 /* Recurse according to subtree's type.
3218 Every branch must return a Lisp_Object. */
3219 switch (XTYPE (subtree))
3221 case Lisp_Vectorlike:
3223 ptrdiff_t i, length = 0;
3224 if (BOOL_VECTOR_P (subtree))
3225 return subtree; /* No sub-objects anyway. */
3226 else if (CHAR_TABLE_P (subtree) || SUB_CHAR_TABLE_P (subtree)
3227 || COMPILEDP (subtree))
3228 length = ASIZE (subtree) & PSEUDOVECTOR_SIZE_MASK;
3229 else if (VECTORP (subtree))
3230 length = ASIZE (subtree);
3231 else
3232 /* An unknown pseudovector may contain non-Lisp fields, so we
3233 can't just blindly traverse all its fields. We used to call
3234 `Flength' which signaled `sequencep', so I just preserved this
3235 behavior. */
3236 wrong_type_argument (Qsequencep, subtree);
3238 for (i = 0; i < length; i++)
3239 SUBSTITUTE (AREF (subtree, i),
3240 ASET (subtree, i, true_value));
3241 return subtree;
3244 case Lisp_Cons:
3246 SUBSTITUTE (XCAR (subtree),
3247 XSETCAR (subtree, true_value));
3248 SUBSTITUTE (XCDR (subtree),
3249 XSETCDR (subtree, true_value));
3250 return subtree;
3253 case Lisp_String:
3255 /* Check for text properties in each interval.
3256 substitute_in_interval contains part of the logic. */
3258 INTERVAL root_interval = string_intervals (subtree);
3259 Lisp_Object arg = Fcons (object, placeholder);
3261 traverse_intervals_noorder (root_interval,
3262 &substitute_in_interval, arg);
3264 return subtree;
3267 /* Other types don't recurse any further. */
3268 default:
3269 return subtree;
3273 /* Helper function for substitute_object_recurse. */
3274 static void
3275 substitute_in_interval (INTERVAL interval, Lisp_Object arg)
3277 Lisp_Object object = Fcar (arg);
3278 Lisp_Object placeholder = Fcdr (arg);
3280 SUBSTITUTE (interval->plist, set_interval_plist (interval, true_value));
3284 #define LEAD_INT 1
3285 #define DOT_CHAR 2
3286 #define TRAIL_INT 4
3287 #define E_EXP 16
3290 /* Convert STRING to a number, assuming base BASE. Return a fixnum if CP has
3291 integer syntax and fits in a fixnum, else return the nearest float if CP has
3292 either floating point or integer syntax and BASE is 10, else return nil. If
3293 IGNORE_TRAILING, consider just the longest prefix of CP that has
3294 valid floating point syntax. Signal an overflow if BASE is not 10 and the
3295 number has integer syntax but does not fit. */
3297 Lisp_Object
3298 string_to_number (char const *string, int base, bool ignore_trailing)
3300 int state;
3301 char const *cp = string;
3302 int leading_digit;
3303 bool float_syntax = 0;
3304 double value = 0;
3306 /* Compute NaN and infinities using a variable, to cope with compilers that
3307 think they are smarter than we are. */
3308 double zero = 0;
3310 /* Negate the value ourselves. This treats 0, NaNs, and infinity properly on
3311 IEEE floating point hosts, and works around a formerly-common bug where
3312 atof ("-0.0") drops the sign. */
3313 bool negative = *cp == '-';
3315 bool signedp = negative || *cp == '+';
3316 cp += signedp;
3318 state = 0;
3320 leading_digit = digit_to_number (*cp, base);
3321 if (leading_digit >= 0)
3323 state |= LEAD_INT;
3325 ++cp;
3326 while (digit_to_number (*cp, base) >= 0);
3328 if (*cp == '.')
3330 state |= DOT_CHAR;
3331 cp++;
3334 if (base == 10)
3336 if ('0' <= *cp && *cp <= '9')
3338 state |= TRAIL_INT;
3340 cp++;
3341 while ('0' <= *cp && *cp <= '9');
3343 if (*cp == 'e' || *cp == 'E')
3345 char const *ecp = cp;
3346 cp++;
3347 if (*cp == '+' || *cp == '-')
3348 cp++;
3349 if ('0' <= *cp && *cp <= '9')
3351 state |= E_EXP;
3353 cp++;
3354 while ('0' <= *cp && *cp <= '9');
3356 else if (cp[-1] == '+'
3357 && cp[0] == 'I' && cp[1] == 'N' && cp[2] == 'F')
3359 state |= E_EXP;
3360 cp += 3;
3361 value = 1.0 / zero;
3363 else if (cp[-1] == '+'
3364 && cp[0] == 'N' && cp[1] == 'a' && cp[2] == 'N')
3366 state |= E_EXP;
3367 cp += 3;
3368 value = zero / zero;
3370 /* If that made a "negative" NaN, negate it. */
3372 int i;
3373 union { double d; char c[sizeof (double)]; }
3374 u_data, u_minus_zero;
3375 u_data.d = value;
3376 u_minus_zero.d = -0.0;
3377 for (i = 0; i < sizeof (double); i++)
3378 if (u_data.c[i] & u_minus_zero.c[i])
3380 value = -value;
3381 break;
3384 /* Now VALUE is a positive NaN. */
3386 else
3387 cp = ecp;
3390 float_syntax = ((state & (DOT_CHAR|TRAIL_INT)) == (DOT_CHAR|TRAIL_INT)
3391 || state == (LEAD_INT|E_EXP));
3394 /* Return nil if the number uses invalid syntax. If IGNORE_TRAILING, accept
3395 any prefix that matches. Otherwise, the entire string must match. */
3396 if (! (ignore_trailing
3397 ? ((state & LEAD_INT) != 0 || float_syntax)
3398 : (!*cp && ((state & ~DOT_CHAR) == LEAD_INT || float_syntax))))
3399 return Qnil;
3401 /* If the number uses integer and not float syntax, and is in C-language
3402 range, use its value, preferably as a fixnum. */
3403 if (leading_digit >= 0 && ! float_syntax)
3405 uintmax_t n;
3407 /* Fast special case for single-digit integers. This also avoids a
3408 glitch when BASE is 16 and IGNORE_TRAILING, because in that
3409 case some versions of strtoumax accept numbers like "0x1" that Emacs
3410 does not allow. */
3411 if (digit_to_number (string[signedp + 1], base) < 0)
3412 return make_number (negative ? -leading_digit : leading_digit);
3414 errno = 0;
3415 n = strtoumax (string + signedp, NULL, base);
3416 if (errno == ERANGE)
3418 /* Unfortunately there's no simple and accurate way to convert
3419 non-base-10 numbers that are out of C-language range. */
3420 if (base != 10)
3421 xsignal1 (Qoverflow_error, build_string (string));
3423 else if (n <= (negative ? -MOST_NEGATIVE_FIXNUM : MOST_POSITIVE_FIXNUM))
3425 EMACS_INT signed_n = n;
3426 return make_number (negative ? -signed_n : signed_n);
3428 else
3429 value = n;
3432 /* Either the number uses float syntax, or it does not fit into a fixnum.
3433 Convert it from string to floating point, unless the value is already
3434 known because it is an infinity, a NAN, or its absolute value fits in
3435 uintmax_t. */
3436 if (! value)
3437 value = atof (string + signedp);
3439 return make_float (negative ? -value : value);
3443 static Lisp_Object
3444 read_vector (Lisp_Object readcharfun, bool bytecodeflag)
3446 ptrdiff_t i, size;
3447 Lisp_Object *ptr;
3448 Lisp_Object tem, item, vector;
3449 struct Lisp_Cons *otem;
3450 Lisp_Object len;
3452 tem = read_list (1, readcharfun);
3453 len = Flength (tem);
3454 vector = Fmake_vector (len, Qnil);
3456 size = ASIZE (vector);
3457 ptr = XVECTOR (vector)->contents;
3458 for (i = 0; i < size; i++)
3460 item = Fcar (tem);
3461 /* If `load-force-doc-strings' is t when reading a lazily-loaded
3462 bytecode object, the docstring containing the bytecode and
3463 constants values must be treated as unibyte and passed to
3464 Fread, to get the actual bytecode string and constants vector. */
3465 if (bytecodeflag && load_force_doc_strings)
3467 if (i == COMPILED_BYTECODE)
3469 if (!STRINGP (item))
3470 error ("Invalid byte code");
3472 /* Delay handling the bytecode slot until we know whether
3473 it is lazily-loaded (we can tell by whether the
3474 constants slot is nil). */
3475 ASET (vector, COMPILED_CONSTANTS, item);
3476 item = Qnil;
3478 else if (i == COMPILED_CONSTANTS)
3480 Lisp_Object bytestr = ptr[COMPILED_CONSTANTS];
3482 if (NILP (item))
3484 /* Coerce string to unibyte (like string-as-unibyte,
3485 but without generating extra garbage and
3486 guaranteeing no change in the contents). */
3487 STRING_SET_CHARS (bytestr, SBYTES (bytestr));
3488 STRING_SET_UNIBYTE (bytestr);
3490 item = Fread (Fcons (bytestr, readcharfun));
3491 if (!CONSP (item))
3492 error ("Invalid byte code");
3494 otem = XCONS (item);
3495 bytestr = XCAR (item);
3496 item = XCDR (item);
3497 free_cons (otem);
3500 /* Now handle the bytecode slot. */
3501 ASET (vector, COMPILED_BYTECODE, bytestr);
3503 else if (i == COMPILED_DOC_STRING
3504 && STRINGP (item)
3505 && ! STRING_MULTIBYTE (item))
3507 if (EQ (readcharfun, Qget_emacs_mule_file_char))
3508 item = Fdecode_coding_string (item, Qemacs_mule, Qnil, Qnil);
3509 else
3510 item = Fstring_as_multibyte (item);
3513 ASET (vector, i, item);
3514 otem = XCONS (tem);
3515 tem = Fcdr (tem);
3516 free_cons (otem);
3518 return vector;
3521 /* FLAG means check for ] to terminate rather than ) and . */
3523 static Lisp_Object
3524 read_list (bool flag, Lisp_Object readcharfun)
3526 Lisp_Object val, tail;
3527 Lisp_Object elt, tem;
3528 struct gcpro gcpro1, gcpro2;
3529 /* 0 is the normal case.
3530 1 means this list is a doc reference; replace it with the number 0.
3531 2 means this list is a doc reference; replace it with the doc string. */
3532 int doc_reference = 0;
3534 /* Initialize this to 1 if we are reading a list. */
3535 bool first_in_list = flag <= 0;
3537 val = Qnil;
3538 tail = Qnil;
3540 while (1)
3542 int ch;
3543 GCPRO2 (val, tail);
3544 elt = read1 (readcharfun, &ch, first_in_list);
3545 UNGCPRO;
3547 first_in_list = 0;
3549 /* While building, if the list starts with #$, treat it specially. */
3550 if (EQ (elt, Vload_file_name)
3551 && ! NILP (elt)
3552 && !NILP (Vpurify_flag))
3554 if (NILP (Vdoc_file_name))
3555 /* We have not yet called Snarf-documentation, so assume
3556 this file is described in the DOC file
3557 and Snarf-documentation will fill in the right value later.
3558 For now, replace the whole list with 0. */
3559 doc_reference = 1;
3560 else
3561 /* We have already called Snarf-documentation, so make a relative
3562 file name for this file, so it can be found properly
3563 in the installed Lisp directory.
3564 We don't use Fexpand_file_name because that would make
3565 the directory absolute now. */
3566 elt = concat2 (build_string ("../lisp/"),
3567 Ffile_name_nondirectory (elt));
3569 else if (EQ (elt, Vload_file_name)
3570 && ! NILP (elt)
3571 && load_force_doc_strings)
3572 doc_reference = 2;
3574 if (ch)
3576 if (flag > 0)
3578 if (ch == ']')
3579 return val;
3580 invalid_syntax (") or . in a vector");
3582 if (ch == ')')
3583 return val;
3584 if (ch == '.')
3586 GCPRO2 (val, tail);
3587 if (!NILP (tail))
3588 XSETCDR (tail, read0 (readcharfun));
3589 else
3590 val = read0 (readcharfun);
3591 read1 (readcharfun, &ch, 0);
3592 UNGCPRO;
3593 if (ch == ')')
3595 if (doc_reference == 1)
3596 return make_number (0);
3597 if (doc_reference == 2 && INTEGERP (XCDR (val)))
3599 char *saved = NULL;
3600 file_offset saved_position;
3601 /* Get a doc string from the file we are loading.
3602 If it's in saved_doc_string, get it from there.
3604 Here, we don't know if the string is a
3605 bytecode string or a doc string. As a
3606 bytecode string must be unibyte, we always
3607 return a unibyte string. If it is actually a
3608 doc string, caller must make it
3609 multibyte. */
3611 /* Position is negative for user variables. */
3612 EMACS_INT pos = eabs (XINT (XCDR (val)));
3613 if (pos >= saved_doc_string_position
3614 && pos < (saved_doc_string_position
3615 + saved_doc_string_length))
3617 saved = saved_doc_string;
3618 saved_position = saved_doc_string_position;
3620 /* Look in prev_saved_doc_string the same way. */
3621 else if (pos >= prev_saved_doc_string_position
3622 && pos < (prev_saved_doc_string_position
3623 + prev_saved_doc_string_length))
3625 saved = prev_saved_doc_string;
3626 saved_position = prev_saved_doc_string_position;
3628 if (saved)
3630 ptrdiff_t start = pos - saved_position;
3631 ptrdiff_t from, to;
3633 /* Process quoting with ^A,
3634 and find the end of the string,
3635 which is marked with ^_ (037). */
3636 for (from = start, to = start;
3637 saved[from] != 037;)
3639 int c = saved[from++];
3640 if (c == 1)
3642 c = saved[from++];
3643 saved[to++] = (c == 1 ? c
3644 : c == '0' ? 0
3645 : c == '_' ? 037
3646 : c);
3648 else
3649 saved[to++] = c;
3652 return make_unibyte_string (saved + start,
3653 to - start);
3655 else
3656 return get_doc_string (val, 1, 0);
3659 return val;
3661 invalid_syntax (". in wrong context");
3663 invalid_syntax ("] in a list");
3665 tem = list1 (elt);
3666 if (!NILP (tail))
3667 XSETCDR (tail, tem);
3668 else
3669 val = tem;
3670 tail = tem;
3674 static Lisp_Object initial_obarray;
3676 /* `oblookup' stores the bucket number here, for the sake of Funintern. */
3678 static size_t oblookup_last_bucket_number;
3680 /* Get an error if OBARRAY is not an obarray.
3681 If it is one, return it. */
3683 Lisp_Object
3684 check_obarray (Lisp_Object obarray)
3686 if (!VECTORP (obarray) || ASIZE (obarray) == 0)
3688 /* If Vobarray is now invalid, force it to be valid. */
3689 if (EQ (Vobarray, obarray)) Vobarray = initial_obarray;
3690 wrong_type_argument (Qvectorp, obarray);
3692 return obarray;
3695 /* Intern the C string STR: return a symbol with that name,
3696 interned in the current obarray. */
3698 Lisp_Object
3699 intern_1 (const char *str, ptrdiff_t len)
3701 Lisp_Object obarray = check_obarray (Vobarray);
3702 Lisp_Object tem = oblookup (obarray, str, len, len);
3704 return SYMBOLP (tem) ? tem : Fintern (make_string (str, len), obarray);
3707 Lisp_Object
3708 intern_c_string_1 (const char *str, ptrdiff_t len)
3710 Lisp_Object obarray = check_obarray (Vobarray);
3711 Lisp_Object tem = oblookup (obarray, str, len, len);
3713 if (SYMBOLP (tem))
3714 return tem;
3716 if (NILP (Vpurify_flag))
3717 /* Creating a non-pure string from a string literal not
3718 implemented yet. We could just use make_string here and live
3719 with the extra copy. */
3720 emacs_abort ();
3722 return Fintern (make_pure_c_string (str, len), obarray);
3725 DEFUN ("intern", Fintern, Sintern, 1, 2, 0,
3726 doc: /* Return the canonical symbol whose name is STRING.
3727 If there is none, one is created by this function and returned.
3728 A second optional argument specifies the obarray to use;
3729 it defaults to the value of `obarray'. */)
3730 (Lisp_Object string, Lisp_Object obarray)
3732 register Lisp_Object tem, sym, *ptr;
3734 if (NILP (obarray)) obarray = Vobarray;
3735 obarray = check_obarray (obarray);
3737 CHECK_STRING (string);
3739 tem = oblookup (obarray, SSDATA (string),
3740 SCHARS (string),
3741 SBYTES (string));
3742 if (!INTEGERP (tem))
3743 return tem;
3745 if (!NILP (Vpurify_flag))
3746 string = Fpurecopy (string);
3747 sym = Fmake_symbol (string);
3749 if (EQ (obarray, initial_obarray))
3750 XSYMBOL (sym)->interned = SYMBOL_INTERNED_IN_INITIAL_OBARRAY;
3751 else
3752 XSYMBOL (sym)->interned = SYMBOL_INTERNED;
3754 if ((SREF (string, 0) == ':')
3755 && EQ (obarray, initial_obarray))
3757 XSYMBOL (sym)->constant = 1;
3758 XSYMBOL (sym)->redirect = SYMBOL_PLAINVAL;
3759 SET_SYMBOL_VAL (XSYMBOL (sym), sym);
3762 ptr = aref_addr (obarray, XINT(tem));
3763 if (SYMBOLP (*ptr))
3764 set_symbol_next (sym, XSYMBOL (*ptr));
3765 else
3766 set_symbol_next (sym, NULL);
3767 *ptr = sym;
3768 return sym;
3771 DEFUN ("intern-soft", Fintern_soft, Sintern_soft, 1, 2, 0,
3772 doc: /* Return the canonical symbol named NAME, or nil if none exists.
3773 NAME may be a string or a symbol. If it is a symbol, that exact
3774 symbol is searched for.
3775 A second optional argument specifies the obarray to use;
3776 it defaults to the value of `obarray'. */)
3777 (Lisp_Object name, Lisp_Object obarray)
3779 register Lisp_Object tem, string;
3781 if (NILP (obarray)) obarray = Vobarray;
3782 obarray = check_obarray (obarray);
3784 if (!SYMBOLP (name))
3786 CHECK_STRING (name);
3787 string = name;
3789 else
3790 string = SYMBOL_NAME (name);
3792 tem = oblookup (obarray, SSDATA (string), SCHARS (string), SBYTES (string));
3793 if (INTEGERP (tem) || (SYMBOLP (name) && !EQ (name, tem)))
3794 return Qnil;
3795 else
3796 return tem;
3799 DEFUN ("unintern", Funintern, Sunintern, 1, 2, 0,
3800 doc: /* Delete the symbol named NAME, if any, from OBARRAY.
3801 The value is t if a symbol was found and deleted, nil otherwise.
3802 NAME may be a string or a symbol. If it is a symbol, that symbol
3803 is deleted, if it belongs to OBARRAY--no other symbol is deleted.
3804 OBARRAY defaults to the value of the variable `obarray'. */)
3805 (Lisp_Object name, Lisp_Object obarray)
3807 register Lisp_Object string, tem;
3808 size_t hash;
3810 if (NILP (obarray)) obarray = Vobarray;
3811 obarray = check_obarray (obarray);
3813 if (SYMBOLP (name))
3814 string = SYMBOL_NAME (name);
3815 else
3817 CHECK_STRING (name);
3818 string = name;
3821 tem = oblookup (obarray, SSDATA (string),
3822 SCHARS (string),
3823 SBYTES (string));
3824 if (INTEGERP (tem))
3825 return Qnil;
3826 /* If arg was a symbol, don't delete anything but that symbol itself. */
3827 if (SYMBOLP (name) && !EQ (name, tem))
3828 return Qnil;
3830 /* There are plenty of other symbols which will screw up the Emacs
3831 session if we unintern them, as well as even more ways to use
3832 `setq' or `fset' or whatnot to make the Emacs session
3833 unusable. Let's not go down this silly road. --Stef */
3834 /* if (EQ (tem, Qnil) || EQ (tem, Qt))
3835 error ("Attempt to unintern t or nil"); */
3837 XSYMBOL (tem)->interned = SYMBOL_UNINTERNED;
3839 hash = oblookup_last_bucket_number;
3841 if (EQ (AREF (obarray, hash), tem))
3843 if (XSYMBOL (tem)->next)
3845 Lisp_Object sym;
3846 XSETSYMBOL (sym, XSYMBOL (tem)->next);
3847 ASET (obarray, hash, sym);
3849 else
3850 ASET (obarray, hash, make_number (0));
3852 else
3854 Lisp_Object tail, following;
3856 for (tail = AREF (obarray, hash);
3857 XSYMBOL (tail)->next;
3858 tail = following)
3860 XSETSYMBOL (following, XSYMBOL (tail)->next);
3861 if (EQ (following, tem))
3863 set_symbol_next (tail, XSYMBOL (following)->next);
3864 break;
3869 return Qt;
3872 /* Return the symbol in OBARRAY whose names matches the string
3873 of SIZE characters (SIZE_BYTE bytes) at PTR.
3874 If there is no such symbol in OBARRAY, return nil.
3876 Also store the bucket number in oblookup_last_bucket_number. */
3878 Lisp_Object
3879 oblookup (Lisp_Object obarray, register const char *ptr, ptrdiff_t size, ptrdiff_t size_byte)
3881 size_t hash;
3882 size_t obsize;
3883 register Lisp_Object tail;
3884 Lisp_Object bucket, tem;
3886 obarray = check_obarray (obarray);
3887 obsize = ASIZE (obarray);
3889 /* This is sometimes needed in the middle of GC. */
3890 obsize &= ~ARRAY_MARK_FLAG;
3891 hash = hash_string (ptr, size_byte) % obsize;
3892 bucket = AREF (obarray, hash);
3893 oblookup_last_bucket_number = hash;
3894 if (EQ (bucket, make_number (0)))
3896 else if (!SYMBOLP (bucket))
3897 error ("Bad data in guts of obarray"); /* Like CADR error message. */
3898 else
3899 for (tail = bucket; ; XSETSYMBOL (tail, XSYMBOL (tail)->next))
3901 if (SBYTES (SYMBOL_NAME (tail)) == size_byte
3902 && SCHARS (SYMBOL_NAME (tail)) == size
3903 && !memcmp (SDATA (SYMBOL_NAME (tail)), ptr, size_byte))
3904 return tail;
3905 else if (XSYMBOL (tail)->next == 0)
3906 break;
3908 XSETINT (tem, hash);
3909 return tem;
3912 void
3913 map_obarray (Lisp_Object obarray, void (*fn) (Lisp_Object, Lisp_Object), Lisp_Object arg)
3915 ptrdiff_t i;
3916 register Lisp_Object tail;
3917 CHECK_VECTOR (obarray);
3918 for (i = ASIZE (obarray) - 1; i >= 0; i--)
3920 tail = AREF (obarray, i);
3921 if (SYMBOLP (tail))
3922 while (1)
3924 (*fn) (tail, arg);
3925 if (XSYMBOL (tail)->next == 0)
3926 break;
3927 XSETSYMBOL (tail, XSYMBOL (tail)->next);
3932 static void
3933 mapatoms_1 (Lisp_Object sym, Lisp_Object function)
3935 call1 (function, sym);
3938 DEFUN ("mapatoms", Fmapatoms, Smapatoms, 1, 2, 0,
3939 doc: /* Call FUNCTION on every symbol in OBARRAY.
3940 OBARRAY defaults to the value of `obarray'. */)
3941 (Lisp_Object function, Lisp_Object obarray)
3943 if (NILP (obarray)) obarray = Vobarray;
3944 obarray = check_obarray (obarray);
3946 map_obarray (obarray, mapatoms_1, function);
3947 return Qnil;
3950 #define OBARRAY_SIZE 1511
3952 void
3953 init_obarray (void)
3955 Lisp_Object oblength;
3956 ptrdiff_t size = 100 + MAX_MULTIBYTE_LENGTH;
3958 XSETFASTINT (oblength, OBARRAY_SIZE);
3960 Vobarray = Fmake_vector (oblength, make_number (0));
3961 initial_obarray = Vobarray;
3962 staticpro (&initial_obarray);
3964 Qunbound = Fmake_symbol (build_pure_c_string ("unbound"));
3965 /* Set temporary dummy values to Qnil and Vpurify_flag to satisfy the
3966 NILP (Vpurify_flag) check in intern_c_string. */
3967 Qnil = make_number (-1); Vpurify_flag = make_number (1);
3968 Qnil = intern_c_string ("nil");
3970 /* Fmake_symbol inits fields of new symbols with Qunbound and Qnil,
3971 so those two need to be fixed manually. */
3972 SET_SYMBOL_VAL (XSYMBOL (Qunbound), Qunbound);
3973 set_symbol_function (Qunbound, Qnil);
3974 set_symbol_plist (Qunbound, Qnil);
3975 SET_SYMBOL_VAL (XSYMBOL (Qnil), Qnil);
3976 XSYMBOL (Qnil)->constant = 1;
3977 XSYMBOL (Qnil)->declared_special = 1;
3978 set_symbol_plist (Qnil, Qnil);
3979 set_symbol_function (Qnil, Qnil);
3981 Qt = intern_c_string ("t");
3982 SET_SYMBOL_VAL (XSYMBOL (Qt), Qt);
3983 XSYMBOL (Qnil)->declared_special = 1;
3984 XSYMBOL (Qt)->constant = 1;
3986 /* Qt is correct even if CANNOT_DUMP. loadup.el will set to nil at end. */
3987 Vpurify_flag = Qt;
3989 DEFSYM (Qvariable_documentation, "variable-documentation");
3991 read_buffer = xmalloc (size);
3992 read_buffer_size = size;
3995 void
3996 defsubr (struct Lisp_Subr *sname)
3998 Lisp_Object sym, tem;
3999 sym = intern_c_string (sname->symbol_name);
4000 XSETPVECTYPE (sname, PVEC_SUBR);
4001 XSETSUBR (tem, sname);
4002 set_symbol_function (sym, tem);
4005 #ifdef NOTDEF /* Use fset in subr.el now! */
4006 void
4007 defalias (struct Lisp_Subr *sname, char *string)
4009 Lisp_Object sym;
4010 sym = intern (string);
4011 XSETSUBR (XSYMBOL (sym)->function, sname);
4013 #endif /* NOTDEF */
4015 /* Define an "integer variable"; a symbol whose value is forwarded to a
4016 C variable of type EMACS_INT. Sample call (with "xx" to fool make-docfile):
4017 DEFxxVAR_INT ("emacs-priority", &emacs_priority, "Documentation"); */
4018 void
4019 defvar_int (struct Lisp_Intfwd *i_fwd,
4020 const char *namestring, EMACS_INT *address)
4022 Lisp_Object sym;
4023 sym = intern_c_string (namestring);
4024 i_fwd->type = Lisp_Fwd_Int;
4025 i_fwd->intvar = address;
4026 XSYMBOL (sym)->declared_special = 1;
4027 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4028 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)i_fwd);
4031 /* Similar but define a variable whose value is t if address contains 1,
4032 nil if address contains 0. */
4033 void
4034 defvar_bool (struct Lisp_Boolfwd *b_fwd,
4035 const char *namestring, bool *address)
4037 Lisp_Object sym;
4038 sym = intern_c_string (namestring);
4039 b_fwd->type = Lisp_Fwd_Bool;
4040 b_fwd->boolvar = address;
4041 XSYMBOL (sym)->declared_special = 1;
4042 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4043 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)b_fwd);
4044 Vbyte_boolean_vars = Fcons (sym, Vbyte_boolean_vars);
4047 /* Similar but define a variable whose value is the Lisp Object stored
4048 at address. Two versions: with and without gc-marking of the C
4049 variable. The nopro version is used when that variable will be
4050 gc-marked for some other reason, since marking the same slot twice
4051 can cause trouble with strings. */
4052 void
4053 defvar_lisp_nopro (struct Lisp_Objfwd *o_fwd,
4054 const char *namestring, Lisp_Object *address)
4056 Lisp_Object sym;
4057 sym = intern_c_string (namestring);
4058 o_fwd->type = Lisp_Fwd_Obj;
4059 o_fwd->objvar = address;
4060 XSYMBOL (sym)->declared_special = 1;
4061 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4062 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)o_fwd);
4065 void
4066 defvar_lisp (struct Lisp_Objfwd *o_fwd,
4067 const char *namestring, Lisp_Object *address)
4069 defvar_lisp_nopro (o_fwd, namestring, address);
4070 staticpro (address);
4073 /* Similar but define a variable whose value is the Lisp Object stored
4074 at a particular offset in the current kboard object. */
4076 void
4077 defvar_kboard (struct Lisp_Kboard_Objfwd *ko_fwd,
4078 const char *namestring, int offset)
4080 Lisp_Object sym;
4081 sym = intern_c_string (namestring);
4082 ko_fwd->type = Lisp_Fwd_Kboard_Obj;
4083 ko_fwd->offset = offset;
4084 XSYMBOL (sym)->declared_special = 1;
4085 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4086 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)ko_fwd);
4089 /* Check that the elements of Vload_path exist. */
4091 static void
4092 load_path_check (void)
4094 Lisp_Object path_tail;
4096 /* The only elements that might not exist are those from
4097 PATH_LOADSEARCH, EMACSLOADPATH. Anything else is only added if
4098 it exists. */
4099 for (path_tail = Vload_path; !NILP (path_tail); path_tail = XCDR (path_tail))
4101 Lisp_Object dirfile;
4102 dirfile = Fcar (path_tail);
4103 if (STRINGP (dirfile))
4105 dirfile = Fdirectory_file_name (dirfile);
4106 if (! file_accessible_directory_p (SSDATA (dirfile)))
4107 dir_warning ("Lisp directory", XCAR (path_tail));
4112 /* Record the value of load-path used at the start of dumping
4113 so we can see if the site changed it later during dumping. */
4114 static Lisp_Object dump_path;
4116 /* Compute the default Vload_path, with the following logic:
4117 If CANNOT_DUMP:
4118 use EMACSLOADPATH env-var if set; otherwise use PATH_LOADSEARCH,
4119 prepending PATH_SITELOADSEARCH unless --no-site-lisp.
4120 The remainder is what happens when dumping works:
4121 If purify-flag (ie dumping) just use PATH_DUMPLOADSEARCH.
4122 Otherwise use EMACSLOADPATH if set, else PATH_LOADSEARCH.
4124 If !initialized, then just set both Vload_path and dump_path.
4125 If initialized, then if Vload_path != dump_path, do nothing.
4126 (Presumably the load-path has already been changed by something.
4127 This can only be from a site-load file during dumping,
4128 or because EMACSLOADPATH is set.)
4129 If Vinstallation_directory is not nil (ie, running uninstalled):
4130 If installation-dir/lisp exists and not already a member,
4131 we must be running uninstalled. Reset the load-path
4132 to just installation-dir/lisp. (The default PATH_LOADSEARCH
4133 refers to the eventual installation directories. Since we
4134 are not yet installed, we should not use them, even if they exist.)
4135 If installation-dir/lisp does not exist, just add dump_path at the
4136 end instead.
4137 Add installation-dir/leim (if exists and not already a member) at the front.
4138 Add installation-dir/site-lisp (if !no_site_lisp, and exists
4139 and not already a member) at the front.
4140 If installation-dir != source-dir (ie running an uninstalled,
4141 out-of-tree build) AND install-dir/src/Makefile exists BUT
4142 install-dir/src/Makefile.in does NOT exist (this is a sanity
4143 check), then repeat the above steps for source-dir/lisp,
4144 leim and site-lisp.
4145 Finally, add the site-lisp directories at the front (if !no_site_lisp).
4148 void
4149 init_lread (void)
4151 const char *normal;
4153 #ifdef CANNOT_DUMP
4154 #ifdef HAVE_NS
4155 const char *loadpath = ns_load_path ();
4156 #endif
4158 normal = PATH_LOADSEARCH;
4159 #ifdef HAVE_NS
4160 Vload_path = decode_env_path ("EMACSLOADPATH", loadpath ? loadpath : normal);
4161 #else
4162 Vload_path = decode_env_path ("EMACSLOADPATH", normal);
4163 #endif
4165 load_path_check ();
4167 /* FIXME CANNOT_DUMP platforms should get source-dir/lisp etc added
4168 to their load-path too, AFAICS. I don't think we can tell the
4169 difference between initialized and !initialized in this case,
4170 so we'll have to do it unconditionally when Vinstallation_directory
4171 is non-nil. */
4172 if (!no_site_lisp && !egetenv ("EMACSLOADPATH"))
4174 Lisp_Object sitelisp;
4175 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH);
4176 if (! NILP (sitelisp)) Vload_path = nconc2 (sitelisp, Vload_path);
4178 #else /* !CANNOT_DUMP */
4179 if (NILP (Vpurify_flag))
4181 normal = PATH_LOADSEARCH;
4182 /* If the EMACSLOADPATH environment variable is set, use its value.
4183 This doesn't apply if we're dumping. */
4184 if (egetenv ("EMACSLOADPATH"))
4185 Vload_path = decode_env_path ("EMACSLOADPATH", normal);
4187 else
4188 normal = PATH_DUMPLOADSEARCH;
4190 /* In a dumped Emacs, we normally reset the value of Vload_path using
4191 PATH_LOADSEARCH, since the value that was dumped uses lisp/ in
4192 the source directory, instead of the path of the installed elisp
4193 libraries. However, if it appears that Vload_path has already been
4194 changed from the default that was saved before dumping, don't
4195 change it further. Changes can only be due to EMACSLOADPATH, or
4196 site-lisp files that were processed during dumping. */
4197 if (initialized)
4199 if (NILP (Fequal (dump_path, Vload_path)))
4201 /* Do not make any changes, just check the elements exist. */
4202 /* Note: --no-site-lisp is ignored.
4203 I don't know what to do about this. */
4204 load_path_check ();
4206 else
4208 #ifdef HAVE_NS
4209 const char *loadpath = ns_load_path ();
4210 Vload_path = decode_env_path (0, loadpath ? loadpath : normal);
4211 #else
4212 Vload_path = decode_env_path (0, normal);
4213 #endif
4214 if (!NILP (Vinstallation_directory))
4216 Lisp_Object tem, tem1;
4218 /* Add to the path the lisp subdir of the installation
4219 dir, if it is accessible. Note: in out-of-tree builds,
4220 this directory is empty save for Makefile. */
4221 tem = Fexpand_file_name (build_string ("lisp"),
4222 Vinstallation_directory);
4223 tem1 = Ffile_accessible_directory_p (tem);
4224 if (!NILP (tem1))
4226 if (NILP (Fmember (tem, Vload_path)))
4228 /* We are running uninstalled. The default load-path
4229 points to the eventual installed lisp, leim
4230 directories. We should not use those now, even
4231 if they exist, so start over from a clean slate. */
4232 Vload_path = list1 (tem);
4235 else
4236 /* That dir doesn't exist, so add the build-time
4237 Lisp dirs instead. */
4238 Vload_path = nconc2 (Vload_path, dump_path);
4240 /* Add leim under the installation dir, if it is accessible. */
4241 tem = Fexpand_file_name (build_string ("leim"),
4242 Vinstallation_directory);
4243 tem1 = Ffile_accessible_directory_p (tem);
4244 if (!NILP (tem1))
4246 if (NILP (Fmember (tem, Vload_path)))
4247 Vload_path = Fcons (tem, Vload_path);
4250 /* Add site-lisp under the installation dir, if it exists. */
4251 if (!no_site_lisp)
4253 tem = Fexpand_file_name (build_string ("site-lisp"),
4254 Vinstallation_directory);
4255 tem1 = Ffile_accessible_directory_p (tem);
4256 if (!NILP (tem1))
4258 if (NILP (Fmember (tem, Vload_path)))
4259 Vload_path = Fcons (tem, Vload_path);
4263 /* If Emacs was not built in the source directory,
4264 and it is run from where it was built, add to load-path
4265 the lisp, leim and site-lisp dirs under that directory. */
4267 if (NILP (Fequal (Vinstallation_directory, Vsource_directory)))
4269 Lisp_Object tem2;
4271 tem = Fexpand_file_name (build_string ("src/Makefile"),
4272 Vinstallation_directory);
4273 tem1 = Ffile_exists_p (tem);
4275 /* Don't be fooled if they moved the entire source tree
4276 AFTER dumping Emacs. If the build directory is indeed
4277 different from the source dir, src/Makefile.in and
4278 src/Makefile will not be found together. */
4279 tem = Fexpand_file_name (build_string ("src/Makefile.in"),
4280 Vinstallation_directory);
4281 tem2 = Ffile_exists_p (tem);
4282 if (!NILP (tem1) && NILP (tem2))
4284 tem = Fexpand_file_name (build_string ("lisp"),
4285 Vsource_directory);
4287 if (NILP (Fmember (tem, Vload_path)))
4288 Vload_path = Fcons (tem, Vload_path);
4290 tem = Fexpand_file_name (build_string ("leim"),
4291 Vsource_directory);
4293 if (NILP (Fmember (tem, Vload_path)))
4294 Vload_path = Fcons (tem, Vload_path);
4296 if (!no_site_lisp)
4298 tem = Fexpand_file_name (build_string ("site-lisp"),
4299 Vsource_directory);
4300 tem1 = Ffile_accessible_directory_p (tem);
4301 if (!NILP (tem1))
4303 if (NILP (Fmember (tem, Vload_path)))
4304 Vload_path = Fcons (tem, Vload_path);
4308 } /* Vinstallation_directory != Vsource_directory */
4310 } /* if Vinstallation_directory */
4312 /* Check before adding the site-lisp directories.
4313 The install should have created them, but they are not
4314 required, so no need to warn if they are absent.
4315 Or we might be running before installation. */
4316 load_path_check ();
4318 /* Add the site-lisp directories at the front. */
4319 if (!no_site_lisp)
4321 Lisp_Object sitelisp;
4322 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH);
4323 if (! NILP (sitelisp)) Vload_path = nconc2 (sitelisp, Vload_path);
4325 } /* if dump_path == Vload_path */
4327 else /* !initialized */
4329 /* NORMAL refers to PATH_DUMPLOADSEARCH, ie the lisp dir in the
4330 source directory. We used to add ../lisp (ie the lisp dir in
4331 the build directory) at the front here, but that caused trouble
4332 because it was copied from dump_path into Vload_path, above,
4333 when Vinstallation_directory was non-nil. It should not be
4334 necessary, since in out of tree builds lisp/ is empty, save
4335 for Makefile. */
4336 Vload_path = decode_env_path (0, normal);
4337 dump_path = Vload_path;
4338 /* No point calling load_path_check; load-path only contains essential
4339 elements from the source directory at this point. They cannot
4340 be missing unless something went extremely (and improbably)
4341 wrong, in which case the build will fail in obvious ways. */
4343 #endif /* !CANNOT_DUMP */
4345 Vvalues = Qnil;
4347 load_in_progress = 0;
4348 Vload_file_name = Qnil;
4349 Vstandard_input = Qt;
4350 Vloads_in_progress = Qnil;
4353 /* Print a warning that directory intended for use USE and with name
4354 DIRNAME cannot be accessed. On entry, errno should correspond to
4355 the access failure. Print the warning on stderr and put it in
4356 *Messages*. */
4358 void
4359 dir_warning (char const *use, Lisp_Object dirname)
4361 static char const format[] = "Warning: %s `%s': %s\n";
4362 int access_errno = errno;
4363 fprintf (stderr, format, use, SSDATA (dirname), strerror (access_errno));
4365 /* Don't log the warning before we've initialized!! */
4366 if (initialized)
4368 char const *diagnostic = emacs_strerror (access_errno);
4369 USE_SAFE_ALLOCA;
4370 char *buffer = SAFE_ALLOCA (sizeof format - 3 * (sizeof "%s" - 1)
4371 + strlen (use) + SBYTES (dirname)
4372 + strlen (diagnostic));
4373 ptrdiff_t message_len = esprintf (buffer, format, use, SSDATA (dirname),
4374 diagnostic);
4375 message_dolog (buffer, message_len, 0, STRING_MULTIBYTE (dirname));
4376 SAFE_FREE ();
4380 void
4381 syms_of_lread (void)
4383 defsubr (&Sread);
4384 defsubr (&Sread_from_string);
4385 defsubr (&Sintern);
4386 defsubr (&Sintern_soft);
4387 defsubr (&Sunintern);
4388 defsubr (&Sget_load_suffixes);
4389 defsubr (&Sload);
4390 defsubr (&Seval_buffer);
4391 defsubr (&Seval_region);
4392 defsubr (&Sread_char);
4393 defsubr (&Sread_char_exclusive);
4394 defsubr (&Sread_event);
4395 defsubr (&Sget_file_char);
4396 defsubr (&Smapatoms);
4397 defsubr (&Slocate_file_internal);
4399 DEFVAR_LISP ("obarray", Vobarray,
4400 doc: /* Symbol table for use by `intern' and `read'.
4401 It is a vector whose length ought to be prime for best results.
4402 The vector's contents don't make sense if examined from Lisp programs;
4403 to find all the symbols in an obarray, use `mapatoms'. */);
4405 DEFVAR_LISP ("values", Vvalues,
4406 doc: /* List of values of all expressions which were read, evaluated and printed.
4407 Order is reverse chronological. */);
4408 XSYMBOL (intern ("values"))->declared_special = 0;
4410 DEFVAR_LISP ("standard-input", Vstandard_input,
4411 doc: /* Stream for read to get input from.
4412 See documentation of `read' for possible values. */);
4413 Vstandard_input = Qt;
4415 DEFVAR_LISP ("read-with-symbol-positions", Vread_with_symbol_positions,
4416 doc: /* If non-nil, add position of read symbols to `read-symbol-positions-list'.
4418 If this variable is a buffer, then only forms read from that buffer
4419 will be added to `read-symbol-positions-list'.
4420 If this variable is t, then all read forms will be added.
4421 The effect of all other values other than nil are not currently
4422 defined, although they may be in the future.
4424 The positions are relative to the last call to `read' or
4425 `read-from-string'. It is probably a bad idea to set this variable at
4426 the toplevel; bind it instead. */);
4427 Vread_with_symbol_positions = Qnil;
4429 DEFVAR_LISP ("read-symbol-positions-list", Vread_symbol_positions_list,
4430 doc: /* A list mapping read symbols to their positions.
4431 This variable is modified during calls to `read' or
4432 `read-from-string', but only when `read-with-symbol-positions' is
4433 non-nil.
4435 Each element of the list looks like (SYMBOL . CHAR-POSITION), where
4436 CHAR-POSITION is an integer giving the offset of that occurrence of the
4437 symbol from the position where `read' or `read-from-string' started.
4439 Note that a symbol will appear multiple times in this list, if it was
4440 read multiple times. The list is in the same order as the symbols
4441 were read in. */);
4442 Vread_symbol_positions_list = Qnil;
4444 DEFVAR_LISP ("read-circle", Vread_circle,
4445 doc: /* Non-nil means read recursive structures using #N= and #N# syntax. */);
4446 Vread_circle = Qt;
4448 DEFVAR_LISP ("load-path", Vload_path,
4449 doc: /* List of directories to search for files to load.
4450 Each element is a string (directory name) or nil (try default directory).
4451 Initialized based on EMACSLOADPATH environment variable, if any,
4452 otherwise to default specified by file `epaths.h' when Emacs was built. */);
4454 DEFVAR_LISP ("load-suffixes", Vload_suffixes,
4455 doc: /* List of suffixes for (compiled or source) Emacs Lisp files.
4456 This list should not include the empty string.
4457 `load' and related functions try to append these suffixes, in order,
4458 to the specified file name if a Lisp suffix is allowed or required. */);
4459 Vload_suffixes = list2 (build_pure_c_string (".elc"),
4460 build_pure_c_string (".el"));
4461 DEFVAR_LISP ("load-file-rep-suffixes", Vload_file_rep_suffixes,
4462 doc: /* List of suffixes that indicate representations of \
4463 the same file.
4464 This list should normally start with the empty string.
4466 Enabling Auto Compression mode appends the suffixes in
4467 `jka-compr-load-suffixes' to this list and disabling Auto Compression
4468 mode removes them again. `load' and related functions use this list to
4469 determine whether they should look for compressed versions of a file
4470 and, if so, which suffixes they should try to append to the file name
4471 in order to do so. However, if you want to customize which suffixes
4472 the loading functions recognize as compression suffixes, you should
4473 customize `jka-compr-load-suffixes' rather than the present variable. */);
4474 Vload_file_rep_suffixes = list1 (empty_unibyte_string);
4476 DEFVAR_BOOL ("load-in-progress", load_in_progress,
4477 doc: /* Non-nil if inside of `load'. */);
4478 DEFSYM (Qload_in_progress, "load-in-progress");
4480 DEFVAR_LISP ("after-load-alist", Vafter_load_alist,
4481 doc: /* An alist of functions to be evalled when particular files are loaded.
4482 Each element looks like (REGEXP-OR-FEATURE FUNCS...).
4484 REGEXP-OR-FEATURE is either a regular expression to match file names, or
4485 a symbol \(a feature name).
4487 When `load' is run and the file-name argument matches an element's
4488 REGEXP-OR-FEATURE, or when `provide' is run and provides the symbol
4489 REGEXP-OR-FEATURE, the FUNCS in the element are called.
4491 An error in FORMS does not undo the load, but does prevent execution of
4492 the rest of the FORMS. */);
4493 Vafter_load_alist = Qnil;
4495 DEFVAR_LISP ("load-history", Vload_history,
4496 doc: /* Alist mapping loaded file names to symbols and features.
4497 Each alist element should be a list (FILE-NAME ENTRIES...), where
4498 FILE-NAME is the name of a file that has been loaded into Emacs.
4499 The file name is absolute and true (i.e. it doesn't contain symlinks).
4500 As an exception, one of the alist elements may have FILE-NAME nil,
4501 for symbols and features not associated with any file.
4503 The remaining ENTRIES in the alist element describe the functions and
4504 variables defined in that file, the features provided, and the
4505 features required. Each entry has the form `(provide . FEATURE)',
4506 `(require . FEATURE)', `(defun . FUNCTION)', `(autoload . SYMBOL)',
4507 `(defface . SYMBOL)', or `(t . SYMBOL)'. Entries like `(t . SYMBOL)'
4508 may precede a `(defun . FUNCTION)' entry, and means that SYMBOL was an
4509 autoload before this file redefined it as a function. In addition,
4510 entries may also be single symbols, which means that SYMBOL was
4511 defined by `defvar' or `defconst'.
4513 During preloading, the file name recorded is relative to the main Lisp
4514 directory. These file names are converted to absolute at startup. */);
4515 Vload_history = Qnil;
4517 DEFVAR_LISP ("load-file-name", Vload_file_name,
4518 doc: /* Full name of file being loaded by `load'. */);
4519 Vload_file_name = Qnil;
4521 DEFVAR_LISP ("user-init-file", Vuser_init_file,
4522 doc: /* File name, including directory, of user's initialization file.
4523 If the file loaded had extension `.elc', and the corresponding source file
4524 exists, this variable contains the name of source file, suitable for use
4525 by functions like `custom-save-all' which edit the init file.
4526 While Emacs loads and evaluates the init file, value is the real name
4527 of the file, regardless of whether or not it has the `.elc' extension. */);
4528 Vuser_init_file = Qnil;
4530 DEFVAR_LISP ("current-load-list", Vcurrent_load_list,
4531 doc: /* Used for internal purposes by `load'. */);
4532 Vcurrent_load_list = Qnil;
4534 DEFVAR_LISP ("load-read-function", Vload_read_function,
4535 doc: /* Function used by `load' and `eval-region' for reading expressions.
4536 The default is nil, which means use the function `read'. */);
4537 Vload_read_function = Qnil;
4539 DEFVAR_LISP ("load-source-file-function", Vload_source_file_function,
4540 doc: /* Function called in `load' to load an Emacs Lisp source file.
4541 The value should be a function for doing code conversion before
4542 reading a source file. It can also be nil, in which case loading is
4543 done without any code conversion.
4545 If the value is a function, it is called with four arguments,
4546 FULLNAME, FILE, NOERROR, NOMESSAGE. FULLNAME is the absolute name of
4547 the file to load, FILE is the non-absolute name (for messages etc.),
4548 and NOERROR and NOMESSAGE are the corresponding arguments passed to
4549 `load'. The function should return t if the file was loaded. */);
4550 Vload_source_file_function = Qnil;
4552 DEFVAR_BOOL ("load-force-doc-strings", load_force_doc_strings,
4553 doc: /* Non-nil means `load' should force-load all dynamic doc strings.
4554 This is useful when the file being loaded is a temporary copy. */);
4555 load_force_doc_strings = 0;
4557 DEFVAR_BOOL ("load-convert-to-unibyte", load_convert_to_unibyte,
4558 doc: /* Non-nil means `read' converts strings to unibyte whenever possible.
4559 This is normally bound by `load' and `eval-buffer' to control `read',
4560 and is not meant for users to change. */);
4561 load_convert_to_unibyte = 0;
4563 DEFVAR_LISP ("source-directory", Vsource_directory,
4564 doc: /* Directory in which Emacs sources were found when Emacs was built.
4565 You cannot count on them to still be there! */);
4566 Vsource_directory
4567 = Fexpand_file_name (build_string ("../"),
4568 Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH)));
4570 DEFVAR_LISP ("preloaded-file-list", Vpreloaded_file_list,
4571 doc: /* List of files that were preloaded (when dumping Emacs). */);
4572 Vpreloaded_file_list = Qnil;
4574 DEFVAR_LISP ("byte-boolean-vars", Vbyte_boolean_vars,
4575 doc: /* List of all DEFVAR_BOOL variables, used by the byte code optimizer. */);
4576 Vbyte_boolean_vars = Qnil;
4578 DEFVAR_BOOL ("load-dangerous-libraries", load_dangerous_libraries,
4579 doc: /* Non-nil means load dangerous compiled Lisp files.
4580 Some versions of XEmacs use different byte codes than Emacs. These
4581 incompatible byte codes can make Emacs crash when it tries to execute
4582 them. */);
4583 load_dangerous_libraries = 0;
4585 DEFVAR_BOOL ("force-load-messages", force_load_messages,
4586 doc: /* Non-nil means force printing messages when loading Lisp files.
4587 This overrides the value of the NOMESSAGE argument to `load'. */);
4588 force_load_messages = 0;
4590 DEFVAR_LISP ("bytecomp-version-regexp", Vbytecomp_version_regexp,
4591 doc: /* Regular expression matching safe to load compiled Lisp files.
4592 When Emacs loads a compiled Lisp file, it reads the first 512 bytes
4593 from the file, and matches them against this regular expression.
4594 When the regular expression matches, the file is considered to be safe
4595 to load. See also `load-dangerous-libraries'. */);
4596 Vbytecomp_version_regexp
4597 = build_pure_c_string ("^;;;.\\(in Emacs version\\|bytecomp version FSF\\)");
4599 DEFSYM (Qlexical_binding, "lexical-binding");
4600 DEFVAR_LISP ("lexical-binding", Vlexical_binding,
4601 doc: /* Whether to use lexical binding when evaluating code.
4602 Non-nil means that the code in the current buffer should be evaluated
4603 with lexical binding.
4604 This variable is automatically set from the file variables of an
4605 interpreted Lisp file read using `load'. Unlike other file local
4606 variables, this must be set in the first line of a file. */);
4607 Vlexical_binding = Qnil;
4608 Fmake_variable_buffer_local (Qlexical_binding);
4610 DEFVAR_LISP ("eval-buffer-list", Veval_buffer_list,
4611 doc: /* List of buffers being read from by calls to `eval-buffer' and `eval-region'. */);
4612 Veval_buffer_list = Qnil;
4614 DEFVAR_LISP ("old-style-backquotes", Vold_style_backquotes,
4615 doc: /* Set to non-nil when `read' encounters an old-style backquote. */);
4616 Vold_style_backquotes = Qnil;
4617 DEFSYM (Qold_style_backquotes, "old-style-backquotes");
4619 /* Vsource_directory was initialized in init_lread. */
4621 DEFSYM (Qcurrent_load_list, "current-load-list");
4622 DEFSYM (Qstandard_input, "standard-input");
4623 DEFSYM (Qread_char, "read-char");
4624 DEFSYM (Qget_file_char, "get-file-char");
4625 DEFSYM (Qget_emacs_mule_file_char, "get-emacs-mule-file-char");
4626 DEFSYM (Qload_force_doc_strings, "load-force-doc-strings");
4628 DEFSYM (Qbackquote, "`");
4629 DEFSYM (Qcomma, ",");
4630 DEFSYM (Qcomma_at, ",@");
4631 DEFSYM (Qcomma_dot, ",.");
4633 DEFSYM (Qinhibit_file_name_operation, "inhibit-file-name-operation");
4634 DEFSYM (Qascii_character, "ascii-character");
4635 DEFSYM (Qfunction, "function");
4636 DEFSYM (Qload, "load");
4637 DEFSYM (Qload_file_name, "load-file-name");
4638 DEFSYM (Qeval_buffer_list, "eval-buffer-list");
4639 DEFSYM (Qfile_truename, "file-truename");
4640 DEFSYM (Qdir_ok, "dir-ok");
4641 DEFSYM (Qdo_after_load_evaluation, "do-after-load-evaluation");
4643 staticpro (&dump_path);
4645 staticpro (&read_objects);
4646 read_objects = Qnil;
4647 staticpro (&seen_list);
4648 seen_list = Qnil;
4650 Vloads_in_progress = Qnil;
4651 staticpro (&Vloads_in_progress);
4653 DEFSYM (Qhash_table, "hash-table");
4654 DEFSYM (Qdata, "data");
4655 DEFSYM (Qtest, "test");
4656 DEFSYM (Qsize, "size");
4657 DEFSYM (Qweakness, "weakness");
4658 DEFSYM (Qrehash_size, "rehash-size");
4659 DEFSYM (Qrehash_threshold, "rehash-threshold");