* lisp/emacs-lisp/pcase.el: Allow (F . ARGS) in `app' patterns.
[emacs.git] / src / lread.c
blobb6f259f1a957c162da9624977f82d671a43b3985
1 /* Lisp parsing and input streams.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2014 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_CHAR_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_CHAR_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_CHAR_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 struct timespec 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 struct timespec wait_time = dtotimespec (duration);
626 end_time = timespec_add (current_timespec (), 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))
972 Fmessage (2, ((Lisp_Object [])
973 { build_local_string ("Loading `%s': old-style backquotes detected!"),
974 file }));
977 DEFUN ("get-load-suffixes", Fget_load_suffixes, Sget_load_suffixes, 0, 0, 0,
978 doc: /* Return the suffixes that `load' should try if a suffix is \
979 required.
980 This uses the variables `load-suffixes' and `load-file-rep-suffixes'. */)
981 (void)
983 Lisp_Object lst = Qnil, suffixes = Vload_suffixes, suffix, ext;
984 while (CONSP (suffixes))
986 Lisp_Object exts = Vload_file_rep_suffixes;
987 suffix = XCAR (suffixes);
988 suffixes = XCDR (suffixes);
989 while (CONSP (exts))
991 ext = XCAR (exts);
992 exts = XCDR (exts);
993 lst = Fcons (concat2 (suffix, ext), lst);
996 return Fnreverse (lst);
999 DEFUN ("load", Fload, Sload, 1, 5, 0,
1000 doc: /* Execute a file of Lisp code named FILE.
1001 First try FILE with `.elc' appended, then try with `.el',
1002 then try FILE unmodified (the exact suffixes in the exact order are
1003 determined by `load-suffixes'). Environment variable references in
1004 FILE are replaced with their values by calling `substitute-in-file-name'.
1005 This function searches the directories in `load-path'.
1007 If optional second arg NOERROR is non-nil,
1008 report no error if FILE doesn't exist.
1009 Print messages at start and end of loading unless
1010 optional third arg NOMESSAGE is non-nil (but `force-load-messages'
1011 overrides that).
1012 If optional fourth arg NOSUFFIX is non-nil, don't try adding
1013 suffixes `.elc' or `.el' to the specified name FILE.
1014 If optional fifth arg MUST-SUFFIX is non-nil, insist on
1015 the suffix `.elc' or `.el'; don't accept just FILE unless
1016 it ends in one of those suffixes or includes a directory name.
1018 If NOSUFFIX is nil, then if a file could not be found, try looking for
1019 a different representation of the file by adding non-empty suffixes to
1020 its name, before trying another file. Emacs uses this feature to find
1021 compressed versions of files when Auto Compression mode is enabled.
1022 If NOSUFFIX is non-nil, disable this feature.
1024 The suffixes that this function tries out, when NOSUFFIX is nil, are
1025 given by the return value of `get-load-suffixes' and the values listed
1026 in `load-file-rep-suffixes'. If MUST-SUFFIX is non-nil, only the
1027 return value of `get-load-suffixes' is used, i.e. the file name is
1028 required to have a non-empty suffix.
1030 When searching suffixes, this function normally stops at the first
1031 one that exists. If the option `load-prefer-newer' is non-nil,
1032 however, it tries all suffixes, and uses whichever file is the newest.
1034 Loading a file records its definitions, and its `provide' and
1035 `require' calls, in an element of `load-history' whose
1036 car is the file name loaded. See `load-history'.
1038 While the file is in the process of being loaded, the variable
1039 `load-in-progress' is non-nil and the variable `load-file-name'
1040 is bound to the file's name.
1042 Return t if the file exists and loads successfully. */)
1043 (Lisp_Object file, Lisp_Object noerror, Lisp_Object nomessage,
1044 Lisp_Object nosuffix, Lisp_Object must_suffix)
1046 FILE *stream;
1047 int fd;
1048 int fd_index;
1049 ptrdiff_t count = SPECPDL_INDEX ();
1050 struct gcpro gcpro1, gcpro2, gcpro3;
1051 Lisp_Object found, efound, hist_file_name;
1052 /* True means we printed the ".el is newer" message. */
1053 bool newer = 0;
1054 /* True means we are loading a compiled file. */
1055 bool compiled = 0;
1056 Lisp_Object handler;
1057 bool safe_p = 1;
1058 const char *fmode = "r";
1059 int version;
1061 #ifdef DOS_NT
1062 fmode = "rt";
1063 #endif /* DOS_NT */
1065 CHECK_STRING (file);
1067 /* If file name is magic, call the handler. */
1068 /* This shouldn't be necessary any more now that `openp' handles it right.
1069 handler = Ffind_file_name_handler (file, Qload);
1070 if (!NILP (handler))
1071 return call5 (handler, Qload, file, noerror, nomessage, nosuffix); */
1073 /* Do this after the handler to avoid
1074 the need to gcpro noerror, nomessage and nosuffix.
1075 (Below here, we care only whether they are nil or not.)
1076 The presence of this call is the result of a historical accident:
1077 it used to be in every file-operation and when it got removed
1078 everywhere, it accidentally stayed here. Since then, enough people
1079 supposedly have things like (load "$PROJECT/foo.el") in their .emacs
1080 that it seemed risky to remove. */
1081 if (! NILP (noerror))
1083 file = internal_condition_case_1 (Fsubstitute_in_file_name, file,
1084 Qt, load_error_handler);
1085 if (NILP (file))
1086 return Qnil;
1088 else
1089 file = Fsubstitute_in_file_name (file);
1091 /* Avoid weird lossage with null string as arg,
1092 since it would try to load a directory as a Lisp file. */
1093 if (SCHARS (file) == 0)
1095 fd = -1;
1096 errno = ENOENT;
1098 else
1100 Lisp_Object suffixes;
1101 found = Qnil;
1102 GCPRO2 (file, found);
1104 if (! NILP (must_suffix))
1106 /* Don't insist on adding a suffix if FILE already ends with one. */
1107 ptrdiff_t size = SBYTES (file);
1108 if (size > 3
1109 && !strcmp (SSDATA (file) + size - 3, ".el"))
1110 must_suffix = Qnil;
1111 else if (size > 4
1112 && !strcmp (SSDATA (file) + size - 4, ".elc"))
1113 must_suffix = Qnil;
1114 /* Don't insist on adding a suffix
1115 if the argument includes a directory name. */
1116 else if (! NILP (Ffile_name_directory (file)))
1117 must_suffix = Qnil;
1120 if (!NILP (nosuffix))
1121 suffixes = Qnil;
1122 else
1124 suffixes = Fget_load_suffixes ();
1125 if (NILP (must_suffix))
1127 Lisp_Object arg[2];
1128 arg[0] = suffixes;
1129 arg[1] = Vload_file_rep_suffixes;
1130 suffixes = Fappend (2, arg);
1134 fd = openp (Vload_path, file, suffixes, &found, Qnil, load_prefer_newer);
1135 UNGCPRO;
1138 if (fd == -1)
1140 if (NILP (noerror))
1141 report_file_error ("Cannot open load file", file);
1142 return Qnil;
1145 /* Tell startup.el whether or not we found the user's init file. */
1146 if (EQ (Qt, Vuser_init_file))
1147 Vuser_init_file = found;
1149 /* If FD is -2, that means openp found a magic file. */
1150 if (fd == -2)
1152 if (NILP (Fequal (found, file)))
1153 /* If FOUND is a different file name from FILE,
1154 find its handler even if we have already inhibited
1155 the `load' operation on FILE. */
1156 handler = Ffind_file_name_handler (found, Qt);
1157 else
1158 handler = Ffind_file_name_handler (found, Qload);
1159 if (! NILP (handler))
1160 return call5 (handler, Qload, found, noerror, nomessage, Qt);
1161 #ifdef DOS_NT
1162 /* Tramp has to deal with semi-broken packages that prepend
1163 drive letters to remote files. For that reason, Tramp
1164 catches file operations that test for file existence, which
1165 makes openp think X:/foo.elc files are remote. However,
1166 Tramp does not catch `load' operations for such files, so we
1167 end up with a nil as the `load' handler above. If we would
1168 continue with fd = -2, we will behave wrongly, and in
1169 particular try reading a .elc file in the "rt" mode instead
1170 of "rb". See bug #9311 for the results. To work around
1171 this, we try to open the file locally, and go with that if it
1172 succeeds. */
1173 fd = emacs_open (SSDATA (ENCODE_FILE (found)), O_RDONLY, 0);
1174 if (fd == -1)
1175 fd = -2;
1176 #endif
1179 if (fd < 0)
1181 /* Pacify older GCC with --enable-gcc-warnings. */
1182 IF_LINT (fd_index = 0);
1184 else
1186 fd_index = SPECPDL_INDEX ();
1187 record_unwind_protect_int (close_file_unwind, fd);
1190 /* Check if we're stuck in a recursive load cycle.
1192 2000-09-21: It's not possible to just check for the file loaded
1193 being a member of Vloads_in_progress. This fails because of the
1194 way the byte compiler currently works; `provide's are not
1195 evaluated, see font-lock.el/jit-lock.el as an example. This
1196 leads to a certain amount of ``normal'' recursion.
1198 Also, just loading a file recursively is not always an error in
1199 the general case; the second load may do something different. */
1201 int load_count = 0;
1202 Lisp_Object tem;
1203 for (tem = Vloads_in_progress; CONSP (tem); tem = XCDR (tem))
1204 if (!NILP (Fequal (found, XCAR (tem))) && (++load_count > 3))
1205 signal_error ("Recursive load", Fcons (found, Vloads_in_progress));
1206 record_unwind_protect (record_load_unwind, Vloads_in_progress);
1207 Vloads_in_progress = Fcons (found, Vloads_in_progress);
1210 /* All loads are by default dynamic, unless the file itself specifies
1211 otherwise using a file-variable in the first line. This is bound here
1212 so that it takes effect whether or not we use
1213 Vload_source_file_function. */
1214 specbind (Qlexical_binding, Qnil);
1216 /* Get the name for load-history. */
1217 hist_file_name = (! NILP (Vpurify_flag)
1218 ? concat2 (Ffile_name_directory (file),
1219 Ffile_name_nondirectory (found))
1220 : found) ;
1222 version = -1;
1224 /* Check for the presence of old-style quotes and warn about them. */
1225 specbind (Qold_style_backquotes, Qnil);
1226 record_unwind_protect (load_warn_old_style_backquotes, file);
1228 if (!memcmp (SDATA (found) + SBYTES (found) - 4, ".elc", 4)
1229 || (fd >= 0 && (version = safe_to_load_version (fd)) > 0))
1230 /* Load .elc files directly, but not when they are
1231 remote and have no handler! */
1233 if (fd != -2)
1235 struct stat s1, s2;
1236 int result;
1238 GCPRO3 (file, found, hist_file_name);
1240 if (version < 0
1241 && ! (version = safe_to_load_version (fd)))
1243 safe_p = 0;
1244 if (!load_dangerous_libraries)
1245 error ("File `%s' was not compiled in Emacs", SDATA (found));
1246 else if (!NILP (nomessage) && !force_load_messages)
1247 message_with_string ("File `%s' not compiled in Emacs", found, 1);
1250 compiled = 1;
1252 efound = ENCODE_FILE (found);
1254 #ifdef DOS_NT
1255 fmode = "rb";
1256 #endif /* DOS_NT */
1258 /* openp already checked for newness, no point doing it again.
1259 FIXME would be nice to get a message when openp
1260 ignores suffix order due to load_prefer_newer. */
1261 if (!load_prefer_newer)
1263 result = stat (SSDATA (efound), &s1);
1264 if (result == 0)
1266 SSET (efound, SBYTES (efound) - 1, 0);
1267 result = stat (SSDATA (efound), &s2);
1268 SSET (efound, SBYTES (efound) - 1, 'c');
1271 if (result == 0
1272 && timespec_cmp (get_stat_mtime (&s1), get_stat_mtime (&s2)) < 0)
1274 /* Make the progress messages mention that source is newer. */
1275 newer = 1;
1277 /* If we won't print another message, mention this anyway. */
1278 if (!NILP (nomessage) && !force_load_messages)
1280 Lisp_Object msg_file;
1281 msg_file = Fsubstring (found, make_number (0), make_number (-1));
1282 message_with_string ("Source file `%s' newer than byte-compiled file",
1283 msg_file, 1);
1286 } /* !load_prefer_newer */
1287 UNGCPRO;
1290 else
1292 /* We are loading a source file (*.el). */
1293 if (!NILP (Vload_source_file_function))
1295 Lisp_Object val;
1297 if (fd >= 0)
1299 emacs_close (fd);
1300 clear_unwind_protect (fd_index);
1302 val = call4 (Vload_source_file_function, found, hist_file_name,
1303 NILP (noerror) ? Qnil : Qt,
1304 (NILP (nomessage) || force_load_messages) ? Qnil : Qt);
1305 return unbind_to (count, val);
1309 GCPRO3 (file, found, hist_file_name);
1311 if (fd < 0)
1313 /* We somehow got here with fd == -2, meaning the file is deemed
1314 to be remote. Don't even try to reopen the file locally;
1315 just force a failure. */
1316 stream = NULL;
1317 errno = EINVAL;
1319 else
1321 #ifdef WINDOWSNT
1322 emacs_close (fd);
1323 clear_unwind_protect (fd_index);
1324 efound = ENCODE_FILE (found);
1325 stream = emacs_fopen (SSDATA (efound), fmode);
1326 #else
1327 stream = fdopen (fd, fmode);
1328 #endif
1330 if (! stream)
1331 report_file_error ("Opening stdio stream", file);
1332 set_unwind_protect_ptr (fd_index, fclose_unwind, stream);
1334 if (! NILP (Vpurify_flag))
1335 Vpreloaded_file_list = Fcons (Fpurecopy (file), Vpreloaded_file_list);
1337 if (NILP (nomessage) || force_load_messages)
1339 if (!safe_p)
1340 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
1341 file, 1);
1342 else if (!compiled)
1343 message_with_string ("Loading %s (source)...", file, 1);
1344 else if (newer)
1345 message_with_string ("Loading %s (compiled; note, source file is newer)...",
1346 file, 1);
1347 else /* The typical case; compiled file newer than source file. */
1348 message_with_string ("Loading %s...", file, 1);
1351 specbind (Qload_file_name, found);
1352 specbind (Qinhibit_file_name_operation, Qnil);
1353 specbind (Qload_in_progress, Qt);
1355 instream = stream;
1356 if (lisp_file_lexically_bound_p (Qget_file_char))
1357 Fset (Qlexical_binding, Qt);
1359 if (! version || version >= 22)
1360 readevalloop (Qget_file_char, stream, hist_file_name,
1361 0, Qnil, Qnil, Qnil, Qnil);
1362 else
1364 /* We can't handle a file which was compiled with
1365 byte-compile-dynamic by older version of Emacs. */
1366 specbind (Qload_force_doc_strings, Qt);
1367 readevalloop (Qget_emacs_mule_file_char, stream, hist_file_name,
1368 0, Qnil, Qnil, Qnil, Qnil);
1370 unbind_to (count, Qnil);
1372 /* Run any eval-after-load forms for this file. */
1373 if (!NILP (Ffboundp (Qdo_after_load_evaluation)))
1374 call1 (Qdo_after_load_evaluation, hist_file_name) ;
1376 UNGCPRO;
1378 xfree (saved_doc_string);
1379 saved_doc_string = 0;
1380 saved_doc_string_size = 0;
1382 xfree (prev_saved_doc_string);
1383 prev_saved_doc_string = 0;
1384 prev_saved_doc_string_size = 0;
1386 if (!noninteractive && (NILP (nomessage) || force_load_messages))
1388 if (!safe_p)
1389 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
1390 file, 1);
1391 else if (!compiled)
1392 message_with_string ("Loading %s (source)...done", file, 1);
1393 else if (newer)
1394 message_with_string ("Loading %s (compiled; note, source file is newer)...done",
1395 file, 1);
1396 else /* The typical case; compiled file newer than source file. */
1397 message_with_string ("Loading %s...done", file, 1);
1400 return Qt;
1403 static bool
1404 complete_filename_p (Lisp_Object pathname)
1406 const unsigned char *s = SDATA (pathname);
1407 return (IS_DIRECTORY_SEP (s[0])
1408 || (SCHARS (pathname) > 2
1409 && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2])));
1412 DEFUN ("locate-file-internal", Flocate_file_internal, Slocate_file_internal, 2, 4, 0,
1413 doc: /* Search for FILENAME through PATH.
1414 Returns the file's name in absolute form, or nil if not found.
1415 If SUFFIXES is non-nil, it should be a list of suffixes to append to
1416 file name when searching.
1417 If non-nil, PREDICATE is used instead of `file-readable-p'.
1418 PREDICATE can also be an integer to pass to the faccessat(2) function,
1419 in which case file-name-handlers are ignored.
1420 This function will normally skip directories, so if you want it to find
1421 directories, make sure the PREDICATE function returns `dir-ok' for them. */)
1422 (Lisp_Object filename, Lisp_Object path, Lisp_Object suffixes, Lisp_Object predicate)
1424 Lisp_Object file;
1425 int fd = openp (path, filename, suffixes, &file, predicate, false);
1426 if (NILP (predicate) && fd >= 0)
1427 emacs_close (fd);
1428 return file;
1431 static Lisp_Object Qdir_ok;
1433 /* Search for a file whose name is STR, looking in directories
1434 in the Lisp list PATH, and trying suffixes from SUFFIX.
1435 On success, return a file descriptor (or 1 or -2 as described below).
1436 On failure, return -1 and set errno.
1438 SUFFIXES is a list of strings containing possible suffixes.
1439 The empty suffix is automatically added if the list is empty.
1441 PREDICATE non-nil means don't open the files,
1442 just look for one that satisfies the predicate. In this case,
1443 return 1 on success. The predicate can be a lisp function or
1444 an integer to pass to `access' (in which case file-name-handlers
1445 are ignored).
1447 If STOREPTR is nonzero, it points to a slot where the name of
1448 the file actually found should be stored as a Lisp string.
1449 nil is stored there on failure.
1451 If the file we find is remote, return -2
1452 but store the found remote file name in *STOREPTR.
1454 If NEWER is true, try all SUFFIXes and return the result for the
1455 newest file that exists. Does not apply to remote files,
1456 or if PREDICATE is specified. */
1459 openp (Lisp_Object path, Lisp_Object str, Lisp_Object suffixes,
1460 Lisp_Object *storeptr, Lisp_Object predicate, bool newer)
1462 ptrdiff_t fn_size = 100;
1463 char buf[100];
1464 char *fn = buf;
1465 bool absolute;
1466 ptrdiff_t want_length;
1467 Lisp_Object filename;
1468 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6, gcpro7;
1469 Lisp_Object string, tail, encoded_fn, save_string;
1470 ptrdiff_t max_suffix_len = 0;
1471 int last_errno = ENOENT;
1472 int save_fd = -1;
1473 USE_SAFE_ALLOCA;
1475 /* The last-modified time of the newest matching file found.
1476 Initialize it to something less than all valid timestamps. */
1477 struct timespec save_mtime = make_timespec (TYPE_MINIMUM (time_t), -1);
1479 CHECK_STRING (str);
1481 for (tail = suffixes; CONSP (tail); tail = XCDR (tail))
1483 CHECK_STRING_CAR (tail);
1484 max_suffix_len = max (max_suffix_len,
1485 SBYTES (XCAR (tail)));
1488 string = filename = encoded_fn = save_string = Qnil;
1489 GCPRO7 (str, string, save_string, filename, path, suffixes, encoded_fn);
1491 if (storeptr)
1492 *storeptr = Qnil;
1494 absolute = complete_filename_p (str);
1496 for (; CONSP (path); path = XCDR (path))
1498 filename = Fexpand_file_name (str, XCAR (path));
1499 if (!complete_filename_p (filename))
1500 /* If there are non-absolute elts in PATH (eg "."). */
1501 /* Of course, this could conceivably lose if luser sets
1502 default-directory to be something non-absolute... */
1504 filename = Fexpand_file_name (filename, BVAR (current_buffer, directory));
1505 if (!complete_filename_p (filename))
1506 /* Give up on this path element! */
1507 continue;
1510 /* Calculate maximum length of any filename made from
1511 this path element/specified file name and any possible suffix. */
1512 want_length = max_suffix_len + SBYTES (filename);
1513 if (fn_size <= want_length)
1515 fn_size = 100 + want_length;
1516 fn = SAFE_ALLOCA (fn_size);
1519 /* Loop over suffixes. */
1520 for (tail = NILP (suffixes) ? list1 (empty_unibyte_string) : suffixes;
1521 CONSP (tail); tail = XCDR (tail))
1523 Lisp_Object suffix = XCAR (tail);
1524 ptrdiff_t fnlen, lsuffix = SBYTES (suffix);
1525 Lisp_Object handler;
1527 /* Concatenate path element/specified name with the suffix.
1528 If the directory starts with /:, remove that. */
1529 int prefixlen = ((SCHARS (filename) > 2
1530 && SREF (filename, 0) == '/'
1531 && SREF (filename, 1) == ':')
1532 ? 2 : 0);
1533 fnlen = SBYTES (filename) - prefixlen;
1534 memcpy (fn, SDATA (filename) + prefixlen, fnlen);
1535 memcpy (fn + fnlen, SDATA (suffix), lsuffix + 1);
1536 fnlen += lsuffix;
1537 /* Check that the file exists and is not a directory. */
1538 /* We used to only check for handlers on non-absolute file names:
1539 if (absolute)
1540 handler = Qnil;
1541 else
1542 handler = Ffind_file_name_handler (filename, Qfile_exists_p);
1543 It's not clear why that was the case and it breaks things like
1544 (load "/bar.el") where the file is actually "/bar.el.gz". */
1545 /* make_string has its own ideas on when to return a unibyte
1546 string and when a multibyte string, but we know better.
1547 We must have a unibyte string when dumping, since
1548 file-name encoding is shaky at best at that time, and in
1549 particular default-file-name-coding-system is reset
1550 several times during loadup. We therefore don't want to
1551 encode the file before passing it to file I/O library
1552 functions. */
1553 if (!STRING_MULTIBYTE (filename) && !STRING_MULTIBYTE (suffix))
1554 string = make_unibyte_string (fn, fnlen);
1555 else
1556 string = make_string (fn, fnlen);
1557 handler = Ffind_file_name_handler (string, Qfile_exists_p);
1558 if ((!NILP (handler) || !NILP (predicate)) && !NATNUMP (predicate))
1560 bool exists;
1561 if (NILP (predicate))
1562 exists = !NILP (Ffile_readable_p (string));
1563 else
1565 Lisp_Object tmp = call1 (predicate, string);
1566 if (NILP (tmp))
1567 exists = false;
1568 else if (EQ (tmp, Qdir_ok)
1569 || NILP (Ffile_directory_p (string)))
1570 exists = true;
1571 else
1573 exists = false;
1574 last_errno = EISDIR;
1578 if (exists)
1580 /* We succeeded; return this descriptor and filename. */
1581 if (storeptr)
1582 *storeptr = string;
1583 SAFE_FREE ();
1584 UNGCPRO;
1585 return -2;
1588 else
1590 int fd;
1591 const char *pfn;
1592 struct stat st;
1594 encoded_fn = ENCODE_FILE (string);
1595 pfn = SSDATA (encoded_fn);
1597 /* Check that we can access or open it. */
1598 if (NATNUMP (predicate))
1600 fd = -1;
1601 if (INT_MAX < XFASTINT (predicate))
1602 last_errno = EINVAL;
1603 else if (faccessat (AT_FDCWD, pfn, XFASTINT (predicate),
1604 AT_EACCESS)
1605 == 0)
1607 if (file_directory_p (pfn))
1608 last_errno = EISDIR;
1609 else
1610 fd = 1;
1613 else
1615 fd = emacs_open (pfn, O_RDONLY, 0);
1616 if (fd < 0)
1618 if (errno != ENOENT)
1619 last_errno = errno;
1621 else
1623 int err = (fstat (fd, &st) != 0 ? errno
1624 : S_ISDIR (st.st_mode) ? EISDIR : 0);
1625 if (err)
1627 last_errno = err;
1628 emacs_close (fd);
1629 fd = -1;
1634 if (fd >= 0)
1636 if (newer && !NATNUMP (predicate))
1638 struct timespec mtime = get_stat_mtime (&st);
1640 if (timespec_cmp (mtime, save_mtime) <= 0)
1641 emacs_close (fd);
1642 else
1644 if (0 <= save_fd)
1645 emacs_close (save_fd);
1646 save_fd = fd;
1647 save_mtime = mtime;
1648 save_string = string;
1651 else
1653 /* We succeeded; return this descriptor and filename. */
1654 if (storeptr)
1655 *storeptr = string;
1656 SAFE_FREE ();
1657 UNGCPRO;
1658 return fd;
1662 /* No more suffixes. Return the newest. */
1663 if (0 <= save_fd && ! CONSP (XCDR (tail)))
1665 if (storeptr)
1666 *storeptr = save_string;
1667 SAFE_FREE ();
1668 UNGCPRO;
1669 return save_fd;
1673 if (absolute)
1674 break;
1677 SAFE_FREE ();
1678 UNGCPRO;
1679 errno = last_errno;
1680 return -1;
1684 /* Merge the list we've accumulated of globals from the current input source
1685 into the load_history variable. The details depend on whether
1686 the source has an associated file name or not.
1688 FILENAME is the file name that we are loading from.
1690 ENTIRE is true if loading that entire file, false if evaluating
1691 part of it. */
1693 static void
1694 build_load_history (Lisp_Object filename, bool entire)
1696 Lisp_Object tail, prev, newelt;
1697 Lisp_Object tem, tem2;
1698 bool foundit = 0;
1700 tail = Vload_history;
1701 prev = Qnil;
1703 while (CONSP (tail))
1705 tem = XCAR (tail);
1707 /* Find the feature's previous assoc list... */
1708 if (!NILP (Fequal (filename, Fcar (tem))))
1710 foundit = 1;
1712 /* If we're loading the entire file, remove old data. */
1713 if (entire)
1715 if (NILP (prev))
1716 Vload_history = XCDR (tail);
1717 else
1718 Fsetcdr (prev, XCDR (tail));
1721 /* Otherwise, cons on new symbols that are not already members. */
1722 else
1724 tem2 = Vcurrent_load_list;
1726 while (CONSP (tem2))
1728 newelt = XCAR (tem2);
1730 if (NILP (Fmember (newelt, tem)))
1731 Fsetcar (tail, Fcons (XCAR (tem),
1732 Fcons (newelt, XCDR (tem))));
1734 tem2 = XCDR (tem2);
1735 QUIT;
1739 else
1740 prev = tail;
1741 tail = XCDR (tail);
1742 QUIT;
1745 /* If we're loading an entire file, cons the new assoc onto the
1746 front of load-history, the most-recently-loaded position. Also
1747 do this if we didn't find an existing member for the file. */
1748 if (entire || !foundit)
1749 Vload_history = Fcons (Fnreverse (Vcurrent_load_list),
1750 Vload_history);
1753 static void
1754 readevalloop_1 (int old)
1756 load_convert_to_unibyte = old;
1759 /* Signal an `end-of-file' error, if possible with file name
1760 information. */
1762 static _Noreturn void
1763 end_of_file_error (void)
1765 if (STRINGP (Vload_file_name))
1766 xsignal1 (Qend_of_file, Vload_file_name);
1768 xsignal0 (Qend_of_file);
1771 static Lisp_Object
1772 readevalloop_eager_expand_eval (Lisp_Object val, Lisp_Object macroexpand)
1774 /* If we macroexpand the toplevel form non-recursively and it ends
1775 up being a `progn' (or if it was a progn to start), treat each
1776 form in the progn as a top-level form. This way, if one form in
1777 the progn defines a macro, that macro is in effect when we expand
1778 the remaining forms. See similar code in bytecomp.el. */
1779 val = call2 (macroexpand, val, Qnil);
1780 if (EQ (CAR_SAFE (val), Qprogn))
1782 struct gcpro gcpro1;
1783 Lisp_Object subforms = XCDR (val);
1785 GCPRO1 (subforms);
1786 for (val = Qnil; CONSP (subforms); subforms = XCDR (subforms))
1787 val = readevalloop_eager_expand_eval (XCAR (subforms),
1788 macroexpand);
1789 UNGCPRO;
1791 else
1792 val = eval_sub (call2 (macroexpand, val, Qt));
1793 return val;
1796 /* UNIBYTE specifies how to set load_convert_to_unibyte
1797 for this invocation.
1798 READFUN, if non-nil, is used instead of `read'.
1800 START, END specify region to read in current buffer (from eval-region).
1801 If the input is not from a buffer, they must be nil. */
1803 static void
1804 readevalloop (Lisp_Object readcharfun,
1805 FILE *stream,
1806 Lisp_Object sourcename,
1807 bool printflag,
1808 Lisp_Object unibyte, Lisp_Object readfun,
1809 Lisp_Object start, Lisp_Object end)
1811 register int c;
1812 register Lisp_Object val;
1813 ptrdiff_t count = SPECPDL_INDEX ();
1814 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1815 struct buffer *b = 0;
1816 bool continue_reading_p;
1817 Lisp_Object lex_bound;
1818 /* True if reading an entire buffer. */
1819 bool whole_buffer = 0;
1820 /* True on the first time around. */
1821 bool first_sexp = 1;
1822 Lisp_Object macroexpand = intern ("internal-macroexpand-for-load");
1824 if (NILP (Ffboundp (macroexpand))
1825 /* Don't macroexpand in .elc files, since it should have been done
1826 already. We actually don't know whether we're in a .elc file or not,
1827 so we use circumstantial evidence: .el files normally go through
1828 Vload_source_file_function -> load-with-code-conversion
1829 -> eval-buffer. */
1830 || EQ (readcharfun, Qget_file_char)
1831 || EQ (readcharfun, Qget_emacs_mule_file_char))
1832 macroexpand = Qnil;
1834 if (MARKERP (readcharfun))
1836 if (NILP (start))
1837 start = readcharfun;
1840 if (BUFFERP (readcharfun))
1841 b = XBUFFER (readcharfun);
1842 else if (MARKERP (readcharfun))
1843 b = XMARKER (readcharfun)->buffer;
1845 /* We assume START is nil when input is not from a buffer. */
1846 if (! NILP (start) && !b)
1847 emacs_abort ();
1849 specbind (Qstandard_input, readcharfun); /* GCPROs readcharfun. */
1850 specbind (Qcurrent_load_list, Qnil);
1851 record_unwind_protect_int (readevalloop_1, load_convert_to_unibyte);
1852 load_convert_to_unibyte = !NILP (unibyte);
1854 /* If lexical binding is active (either because it was specified in
1855 the file's header, or via a buffer-local variable), create an empty
1856 lexical environment, otherwise, turn off lexical binding. */
1857 lex_bound = find_symbol_value (Qlexical_binding);
1858 specbind (Qinternal_interpreter_environment,
1859 (NILP (lex_bound) || EQ (lex_bound, Qunbound)
1860 ? Qnil : list1 (Qt)));
1862 GCPRO4 (sourcename, readfun, start, end);
1864 /* Try to ensure sourcename is a truename, except whilst preloading. */
1865 if (NILP (Vpurify_flag)
1866 && !NILP (sourcename) && !NILP (Ffile_name_absolute_p (sourcename))
1867 && !NILP (Ffboundp (Qfile_truename)))
1868 sourcename = call1 (Qfile_truename, sourcename) ;
1870 LOADHIST_ATTACH (sourcename);
1872 continue_reading_p = 1;
1873 while (continue_reading_p)
1875 ptrdiff_t count1 = SPECPDL_INDEX ();
1877 if (b != 0 && !BUFFER_LIVE_P (b))
1878 error ("Reading from killed buffer");
1880 if (!NILP (start))
1882 /* Switch to the buffer we are reading from. */
1883 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1884 set_buffer_internal (b);
1886 /* Save point in it. */
1887 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1888 /* Save ZV in it. */
1889 record_unwind_protect (save_restriction_restore, save_restriction_save ());
1890 /* Those get unbound after we read one expression. */
1892 /* Set point and ZV around stuff to be read. */
1893 Fgoto_char (start);
1894 if (!NILP (end))
1895 Fnarrow_to_region (make_number (BEGV), end);
1897 /* Just for cleanliness, convert END to a marker
1898 if it is an integer. */
1899 if (INTEGERP (end))
1900 end = Fpoint_max_marker ();
1903 /* On the first cycle, we can easily test here
1904 whether we are reading the whole buffer. */
1905 if (b && first_sexp)
1906 whole_buffer = (PT == BEG && ZV == Z);
1908 instream = stream;
1909 read_next:
1910 c = READCHAR;
1911 if (c == ';')
1913 while ((c = READCHAR) != '\n' && c != -1);
1914 goto read_next;
1916 if (c < 0)
1918 unbind_to (count1, Qnil);
1919 break;
1922 /* Ignore whitespace here, so we can detect eof. */
1923 if (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r'
1924 || c == 0xa0) /* NBSP */
1925 goto read_next;
1927 if (!NILP (Vpurify_flag) && c == '(')
1929 val = read_list (0, readcharfun);
1931 else
1933 UNREAD (c);
1934 read_objects = Qnil;
1935 if (!NILP (readfun))
1937 val = call1 (readfun, readcharfun);
1939 /* If READCHARFUN has set point to ZV, we should
1940 stop reading, even if the form read sets point
1941 to a different value when evaluated. */
1942 if (BUFFERP (readcharfun))
1944 struct buffer *buf = XBUFFER (readcharfun);
1945 if (BUF_PT (buf) == BUF_ZV (buf))
1946 continue_reading_p = 0;
1949 else if (! NILP (Vload_read_function))
1950 val = call1 (Vload_read_function, readcharfun);
1951 else
1952 val = read_internal_start (readcharfun, Qnil, Qnil);
1955 if (!NILP (start) && continue_reading_p)
1956 start = Fpoint_marker ();
1958 /* Restore saved point and BEGV. */
1959 unbind_to (count1, Qnil);
1961 /* Now eval what we just read. */
1962 if (!NILP (macroexpand))
1963 val = readevalloop_eager_expand_eval (val, macroexpand);
1964 else
1965 val = eval_sub (val);
1967 if (printflag)
1969 Vvalues = Fcons (val, Vvalues);
1970 if (EQ (Vstandard_output, Qt))
1971 Fprin1 (val, Qnil);
1972 else
1973 Fprint (val, Qnil);
1976 first_sexp = 0;
1979 build_load_history (sourcename,
1980 stream || whole_buffer);
1982 UNGCPRO;
1984 unbind_to (count, Qnil);
1987 DEFUN ("eval-buffer", Feval_buffer, Seval_buffer, 0, 5, "",
1988 doc: /* Execute the current buffer as Lisp code.
1989 When called from a Lisp program (i.e., not interactively), this
1990 function accepts up to five optional arguments:
1991 BUFFER is the buffer to evaluate (nil means use current buffer).
1992 PRINTFLAG controls printing of output:
1993 A value of nil means discard it; anything else is stream for print.
1994 FILENAME specifies the file name to use for `load-history'.
1995 UNIBYTE, if non-nil, specifies `load-convert-to-unibyte' for this
1996 invocation.
1997 DO-ALLOW-PRINT, if non-nil, specifies that `print' and related
1998 functions should work normally even if PRINTFLAG is nil.
2000 This function preserves the position of point. */)
2001 (Lisp_Object buffer, Lisp_Object printflag, Lisp_Object filename, Lisp_Object unibyte, Lisp_Object do_allow_print)
2003 ptrdiff_t count = SPECPDL_INDEX ();
2004 Lisp_Object tem, buf;
2006 if (NILP (buffer))
2007 buf = Fcurrent_buffer ();
2008 else
2009 buf = Fget_buffer (buffer);
2010 if (NILP (buf))
2011 error ("No such buffer");
2013 if (NILP (printflag) && NILP (do_allow_print))
2014 tem = Qsymbolp;
2015 else
2016 tem = printflag;
2018 if (NILP (filename))
2019 filename = BVAR (XBUFFER (buf), filename);
2021 specbind (Qeval_buffer_list, Fcons (buf, Veval_buffer_list));
2022 specbind (Qstandard_output, tem);
2023 record_unwind_protect (save_excursion_restore, save_excursion_save ());
2024 BUF_TEMP_SET_PT (XBUFFER (buf), BUF_BEGV (XBUFFER (buf)));
2025 specbind (Qlexical_binding, lisp_file_lexically_bound_p (buf) ? Qt : Qnil);
2026 readevalloop (buf, 0, filename,
2027 !NILP (printflag), unibyte, Qnil, Qnil, Qnil);
2028 unbind_to (count, Qnil);
2030 return Qnil;
2033 DEFUN ("eval-region", Feval_region, Seval_region, 2, 4, "r",
2034 doc: /* Execute the region as Lisp code.
2035 When called from programs, expects two arguments,
2036 giving starting and ending indices in the current buffer
2037 of the text to be executed.
2038 Programs can pass third argument PRINTFLAG which controls output:
2039 A value of nil means discard it; anything else is stream for printing it.
2040 Also the fourth argument READ-FUNCTION, if non-nil, is used
2041 instead of `read' to read each expression. It gets one argument
2042 which is the input stream for reading characters.
2044 This function does not move point. */)
2045 (Lisp_Object start, Lisp_Object end, Lisp_Object printflag, Lisp_Object read_function)
2047 /* FIXME: Do the eval-sexp-add-defvars dance! */
2048 ptrdiff_t count = SPECPDL_INDEX ();
2049 Lisp_Object tem, cbuf;
2051 cbuf = Fcurrent_buffer ();
2053 if (NILP (printflag))
2054 tem = Qsymbolp;
2055 else
2056 tem = printflag;
2057 specbind (Qstandard_output, tem);
2058 specbind (Qeval_buffer_list, Fcons (cbuf, Veval_buffer_list));
2060 /* `readevalloop' calls functions which check the type of start and end. */
2061 readevalloop (cbuf, 0, BVAR (XBUFFER (cbuf), filename),
2062 !NILP (printflag), Qnil, read_function,
2063 start, end);
2065 return unbind_to (count, Qnil);
2069 DEFUN ("read", Fread, Sread, 0, 1, 0,
2070 doc: /* Read one Lisp expression as text from STREAM, return as Lisp object.
2071 If STREAM is nil, use the value of `standard-input' (which see).
2072 STREAM or the value of `standard-input' may be:
2073 a buffer (read from point and advance it)
2074 a marker (read from where it points and advance it)
2075 a function (call it with no arguments for each character,
2076 call it with a char as argument to push a char back)
2077 a string (takes text from string, starting at the beginning)
2078 t (read text line using minibuffer and use it, or read from
2079 standard input in batch mode). */)
2080 (Lisp_Object stream)
2082 if (NILP (stream))
2083 stream = Vstandard_input;
2084 if (EQ (stream, Qt))
2085 stream = Qread_char;
2086 if (EQ (stream, Qread_char))
2087 /* FIXME: ?! When is this used !? */
2088 return call1 (intern ("read-minibuffer"),
2089 build_string ("Lisp expression: "));
2091 return read_internal_start (stream, Qnil, Qnil);
2094 DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0,
2095 doc: /* Read one Lisp expression which is represented as text by STRING.
2096 Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
2097 FINAL-STRING-INDEX is an integer giving the position of the next
2098 remaining character in STRING.
2099 START and END optionally delimit a substring of STRING from which to read;
2100 they default to 0 and (length STRING) respectively. */)
2101 (Lisp_Object string, Lisp_Object start, Lisp_Object end)
2103 Lisp_Object ret;
2104 CHECK_STRING (string);
2105 /* `read_internal_start' sets `read_from_string_index'. */
2106 ret = read_internal_start (string, start, end);
2107 return Fcons (ret, make_number (read_from_string_index));
2110 /* Function to set up the global context we need in toplevel read
2111 calls. */
2112 static Lisp_Object
2113 read_internal_start (Lisp_Object stream, Lisp_Object start, Lisp_Object end)
2114 /* `start', `end' only used when stream is a string. */
2116 Lisp_Object retval;
2118 readchar_count = 0;
2119 new_backquote_flag = 0;
2120 read_objects = Qnil;
2121 if (EQ (Vread_with_symbol_positions, Qt)
2122 || EQ (Vread_with_symbol_positions, stream))
2123 Vread_symbol_positions_list = Qnil;
2125 if (STRINGP (stream)
2126 || ((CONSP (stream) && STRINGP (XCAR (stream)))))
2128 ptrdiff_t startval, endval;
2129 Lisp_Object string;
2131 if (STRINGP (stream))
2132 string = stream;
2133 else
2134 string = XCAR (stream);
2136 if (NILP (end))
2137 endval = SCHARS (string);
2138 else
2140 CHECK_NUMBER (end);
2141 if (! (0 <= XINT (end) && XINT (end) <= SCHARS (string)))
2142 args_out_of_range (string, end);
2143 endval = XINT (end);
2146 if (NILP (start))
2147 startval = 0;
2148 else
2150 CHECK_NUMBER (start);
2151 if (! (0 <= XINT (start) && XINT (start) <= endval))
2152 args_out_of_range (string, start);
2153 startval = XINT (start);
2155 read_from_string_index = startval;
2156 read_from_string_index_byte = string_char_to_byte (string, startval);
2157 read_from_string_limit = endval;
2160 retval = read0 (stream);
2161 if (EQ (Vread_with_symbol_positions, Qt)
2162 || EQ (Vread_with_symbol_positions, stream))
2163 Vread_symbol_positions_list = Fnreverse (Vread_symbol_positions_list);
2164 return retval;
2168 /* Signal Qinvalid_read_syntax error.
2169 S is error string of length N (if > 0) */
2171 static _Noreturn void
2172 invalid_syntax (const char *s)
2174 xsignal1 (Qinvalid_read_syntax, build_string (s));
2178 /* Use this for recursive reads, in contexts where internal tokens
2179 are not allowed. */
2181 static Lisp_Object
2182 read0 (Lisp_Object readcharfun)
2184 register Lisp_Object val;
2185 int c;
2187 val = read1 (readcharfun, &c, 0);
2188 if (!c)
2189 return val;
2191 xsignal1 (Qinvalid_read_syntax,
2192 Fmake_string (make_number (1), make_number (c)));
2195 static ptrdiff_t read_buffer_size;
2196 static char *read_buffer;
2198 /* Read a \-escape sequence, assuming we already read the `\'.
2199 If the escape sequence forces unibyte, return eight-bit char. */
2201 static int
2202 read_escape (Lisp_Object readcharfun, bool stringp)
2204 int c = READCHAR;
2205 /* \u allows up to four hex digits, \U up to eight. Default to the
2206 behavior for \u, and change this value in the case that \U is seen. */
2207 int unicode_hex_count = 4;
2209 switch (c)
2211 case -1:
2212 end_of_file_error ();
2214 case 'a':
2215 return '\007';
2216 case 'b':
2217 return '\b';
2218 case 'd':
2219 return 0177;
2220 case 'e':
2221 return 033;
2222 case 'f':
2223 return '\f';
2224 case 'n':
2225 return '\n';
2226 case 'r':
2227 return '\r';
2228 case 't':
2229 return '\t';
2230 case 'v':
2231 return '\v';
2232 case '\n':
2233 return -1;
2234 case ' ':
2235 if (stringp)
2236 return -1;
2237 return ' ';
2239 case 'M':
2240 c = READCHAR;
2241 if (c != '-')
2242 error ("Invalid escape character syntax");
2243 c = READCHAR;
2244 if (c == '\\')
2245 c = read_escape (readcharfun, 0);
2246 return c | meta_modifier;
2248 case 'S':
2249 c = READCHAR;
2250 if (c != '-')
2251 error ("Invalid escape character syntax");
2252 c = READCHAR;
2253 if (c == '\\')
2254 c = read_escape (readcharfun, 0);
2255 return c | shift_modifier;
2257 case 'H':
2258 c = READCHAR;
2259 if (c != '-')
2260 error ("Invalid escape character syntax");
2261 c = READCHAR;
2262 if (c == '\\')
2263 c = read_escape (readcharfun, 0);
2264 return c | hyper_modifier;
2266 case 'A':
2267 c = READCHAR;
2268 if (c != '-')
2269 error ("Invalid escape character syntax");
2270 c = READCHAR;
2271 if (c == '\\')
2272 c = read_escape (readcharfun, 0);
2273 return c | alt_modifier;
2275 case 's':
2276 c = READCHAR;
2277 if (stringp || c != '-')
2279 UNREAD (c);
2280 return ' ';
2282 c = READCHAR;
2283 if (c == '\\')
2284 c = read_escape (readcharfun, 0);
2285 return c | super_modifier;
2287 case 'C':
2288 c = READCHAR;
2289 if (c != '-')
2290 error ("Invalid escape character syntax");
2291 case '^':
2292 c = READCHAR;
2293 if (c == '\\')
2294 c = read_escape (readcharfun, 0);
2295 if ((c & ~CHAR_MODIFIER_MASK) == '?')
2296 return 0177 | (c & CHAR_MODIFIER_MASK);
2297 else if (! SINGLE_BYTE_CHAR_P ((c & ~CHAR_MODIFIER_MASK)))
2298 return c | ctrl_modifier;
2299 /* ASCII control chars are made from letters (both cases),
2300 as well as the non-letters within 0100...0137. */
2301 else if ((c & 0137) >= 0101 && (c & 0137) <= 0132)
2302 return (c & (037 | ~0177));
2303 else if ((c & 0177) >= 0100 && (c & 0177) <= 0137)
2304 return (c & (037 | ~0177));
2305 else
2306 return c | ctrl_modifier;
2308 case '0':
2309 case '1':
2310 case '2':
2311 case '3':
2312 case '4':
2313 case '5':
2314 case '6':
2315 case '7':
2316 /* An octal escape, as in ANSI C. */
2318 register int i = c - '0';
2319 register int count = 0;
2320 while (++count < 3)
2322 if ((c = READCHAR) >= '0' && c <= '7')
2324 i *= 8;
2325 i += c - '0';
2327 else
2329 UNREAD (c);
2330 break;
2334 if (i >= 0x80 && i < 0x100)
2335 i = BYTE8_TO_CHAR (i);
2336 return i;
2339 case 'x':
2340 /* A hex escape, as in ANSI C. */
2342 unsigned int i = 0;
2343 int count = 0;
2344 while (1)
2346 c = READCHAR;
2347 if (c >= '0' && c <= '9')
2349 i *= 16;
2350 i += c - '0';
2352 else if ((c >= 'a' && c <= 'f')
2353 || (c >= 'A' && c <= 'F'))
2355 i *= 16;
2356 if (c >= 'a' && c <= 'f')
2357 i += c - 'a' + 10;
2358 else
2359 i += c - 'A' + 10;
2361 else
2363 UNREAD (c);
2364 break;
2366 /* Allow hex escapes as large as ?\xfffffff, because some
2367 packages use them to denote characters with modifiers. */
2368 if ((CHAR_META | (CHAR_META - 1)) < i)
2369 error ("Hex character out of range: \\x%x...", i);
2370 count += count < 3;
2373 if (count < 3 && i >= 0x80)
2374 return BYTE8_TO_CHAR (i);
2375 return i;
2378 case 'U':
2379 /* Post-Unicode-2.0: Up to eight hex chars. */
2380 unicode_hex_count = 8;
2381 case 'u':
2383 /* A Unicode escape. We only permit them in strings and characters,
2384 not arbitrarily in the source code, as in some other languages. */
2386 unsigned int i = 0;
2387 int count = 0;
2389 while (++count <= unicode_hex_count)
2391 c = READCHAR;
2392 /* `isdigit' and `isalpha' may be locale-specific, which we don't
2393 want. */
2394 if (c >= '0' && c <= '9') i = (i << 4) + (c - '0');
2395 else if (c >= 'a' && c <= 'f') i = (i << 4) + (c - 'a') + 10;
2396 else if (c >= 'A' && c <= 'F') i = (i << 4) + (c - 'A') + 10;
2397 else
2398 error ("Non-hex digit used for Unicode escape");
2400 if (i > 0x10FFFF)
2401 error ("Non-Unicode character: 0x%x", i);
2402 return i;
2405 default:
2406 return c;
2410 /* Return the digit that CHARACTER stands for in the given BASE.
2411 Return -1 if CHARACTER is out of range for BASE,
2412 and -2 if CHARACTER is not valid for any supported BASE. */
2413 static int
2414 digit_to_number (int character, int base)
2416 int digit;
2418 if ('0' <= character && character <= '9')
2419 digit = character - '0';
2420 else if ('a' <= character && character <= 'z')
2421 digit = character - 'a' + 10;
2422 else if ('A' <= character && character <= 'Z')
2423 digit = character - 'A' + 10;
2424 else
2425 return -2;
2427 return digit < base ? digit : -1;
2430 /* Read an integer in radix RADIX using READCHARFUN to read
2431 characters. RADIX must be in the interval [2..36]; if it isn't, a
2432 read error is signaled . Value is the integer read. Signals an
2433 error if encountering invalid read syntax or if RADIX is out of
2434 range. */
2436 static Lisp_Object
2437 read_integer (Lisp_Object readcharfun, EMACS_INT radix)
2439 /* Room for sign, leading 0, other digits, trailing null byte.
2440 Also, room for invalid syntax diagnostic. */
2441 char buf[max (1 + 1 + sizeof (uintmax_t) * CHAR_BIT + 1,
2442 sizeof "integer, radix " + INT_STRLEN_BOUND (EMACS_INT))];
2444 int valid = -1; /* 1 if valid, 0 if not, -1 if incomplete. */
2446 if (radix < 2 || radix > 36)
2447 valid = 0;
2448 else
2450 char *p = buf;
2451 int c, digit;
2453 c = READCHAR;
2454 if (c == '-' || c == '+')
2456 *p++ = c;
2457 c = READCHAR;
2460 if (c == '0')
2462 *p++ = c;
2463 valid = 1;
2465 /* Ignore redundant leading zeros, so the buffer doesn't
2466 fill up with them. */
2468 c = READCHAR;
2469 while (c == '0');
2472 while ((digit = digit_to_number (c, radix)) >= -1)
2474 if (digit == -1)
2475 valid = 0;
2476 if (valid < 0)
2477 valid = 1;
2479 if (p < buf + sizeof buf - 1)
2480 *p++ = c;
2481 else
2482 valid = 0;
2484 c = READCHAR;
2487 UNREAD (c);
2488 *p = '\0';
2491 if (! valid)
2493 sprintf (buf, "integer, radix %"pI"d", radix);
2494 invalid_syntax (buf);
2497 return string_to_number (buf, radix, 0);
2501 /* If the next token is ')' or ']' or '.', we store that character
2502 in *PCH and the return value is not interesting. Else, we store
2503 zero in *PCH and we read and return one lisp object.
2505 FIRST_IN_LIST is true if this is the first element of a list. */
2507 static Lisp_Object
2508 read1 (Lisp_Object readcharfun, int *pch, bool first_in_list)
2510 int c;
2511 bool uninterned_symbol = 0;
2512 bool multibyte;
2514 *pch = 0;
2516 retry:
2518 c = READCHAR_REPORT_MULTIBYTE (&multibyte);
2519 if (c < 0)
2520 end_of_file_error ();
2522 switch (c)
2524 case '(':
2525 return read_list (0, readcharfun);
2527 case '[':
2528 return read_vector (readcharfun, 0);
2530 case ')':
2531 case ']':
2533 *pch = c;
2534 return Qnil;
2537 case '#':
2538 c = READCHAR;
2539 if (c == 's')
2541 c = READCHAR;
2542 if (c == '(')
2544 /* Accept extended format for hashtables (extensible to
2545 other types), e.g.
2546 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
2547 Lisp_Object tmp = read_list (0, readcharfun);
2548 Lisp_Object head = CAR_SAFE (tmp);
2549 Lisp_Object data = Qnil;
2550 Lisp_Object val = Qnil;
2551 /* The size is 2 * number of allowed keywords to
2552 make-hash-table. */
2553 Lisp_Object params[10];
2554 Lisp_Object ht;
2555 Lisp_Object key = Qnil;
2556 int param_count = 0;
2558 if (!EQ (head, Qhash_table))
2559 error ("Invalid extended read marker at head of #s list "
2560 "(only hash-table allowed)");
2562 tmp = CDR_SAFE (tmp);
2564 /* This is repetitive but fast and simple. */
2565 params[param_count] = QCsize;
2566 params[param_count + 1] = Fplist_get (tmp, Qsize);
2567 if (!NILP (params[param_count + 1]))
2568 param_count += 2;
2570 params[param_count] = QCtest;
2571 params[param_count + 1] = Fplist_get (tmp, Qtest);
2572 if (!NILP (params[param_count + 1]))
2573 param_count += 2;
2575 params[param_count] = QCweakness;
2576 params[param_count + 1] = Fplist_get (tmp, Qweakness);
2577 if (!NILP (params[param_count + 1]))
2578 param_count += 2;
2580 params[param_count] = QCrehash_size;
2581 params[param_count + 1] = Fplist_get (tmp, Qrehash_size);
2582 if (!NILP (params[param_count + 1]))
2583 param_count += 2;
2585 params[param_count] = QCrehash_threshold;
2586 params[param_count + 1] = Fplist_get (tmp, Qrehash_threshold);
2587 if (!NILP (params[param_count + 1]))
2588 param_count += 2;
2590 /* This is the hashtable data. */
2591 data = Fplist_get (tmp, Qdata);
2593 /* Now use params to make a new hashtable and fill it. */
2594 ht = Fmake_hash_table (param_count, params);
2596 while (CONSP (data))
2598 key = XCAR (data);
2599 data = XCDR (data);
2600 if (!CONSP (data))
2601 error ("Odd number of elements in hashtable data");
2602 val = XCAR (data);
2603 data = XCDR (data);
2604 Fputhash (key, val, ht);
2607 return ht;
2609 UNREAD (c);
2610 invalid_syntax ("#");
2612 if (c == '^')
2614 c = READCHAR;
2615 if (c == '[')
2617 Lisp_Object tmp;
2618 tmp = read_vector (readcharfun, 0);
2619 if (ASIZE (tmp) < CHAR_TABLE_STANDARD_SLOTS)
2620 error ("Invalid size char-table");
2621 XSETPVECTYPE (XVECTOR (tmp), PVEC_CHAR_TABLE);
2622 return tmp;
2624 else if (c == '^')
2626 c = READCHAR;
2627 if (c == '[')
2629 /* Sub char-table can't be read as a regular
2630 vector because of a two C integer fields. */
2631 Lisp_Object tbl, tmp = read_list (1, readcharfun);
2632 ptrdiff_t size = XINT (Flength (tmp));
2633 int i, depth, min_char;
2634 struct Lisp_Cons *cell;
2636 if (size == 0)
2637 error ("Zero-sized sub char-table");
2639 if (! RANGED_INTEGERP (1, XCAR (tmp), 3))
2640 error ("Invalid depth in sub char-table");
2641 depth = XINT (XCAR (tmp));
2642 if (chartab_size[depth] != size - 2)
2643 error ("Invalid size in sub char-table");
2644 cell = XCONS (tmp), tmp = XCDR (tmp), size--;
2645 free_cons (cell);
2647 if (! RANGED_INTEGERP (0, XCAR (tmp), MAX_CHAR))
2648 error ("Invalid minimum character in sub-char-table");
2649 min_char = XINT (XCAR (tmp));
2650 cell = XCONS (tmp), tmp = XCDR (tmp), size--;
2651 free_cons (cell);
2653 tbl = make_uninit_sub_char_table (depth, min_char);
2654 for (i = 0; i < size; i++)
2656 XSUB_CHAR_TABLE (tbl)->contents[i] = XCAR (tmp);
2657 cell = XCONS (tmp), tmp = XCDR (tmp);
2658 free_cons (cell);
2660 return tbl;
2662 invalid_syntax ("#^^");
2664 invalid_syntax ("#^");
2666 if (c == '&')
2668 Lisp_Object length;
2669 length = read1 (readcharfun, pch, first_in_list);
2670 c = READCHAR;
2671 if (c == '"')
2673 Lisp_Object tmp, val;
2674 EMACS_INT size_in_chars = bool_vector_bytes (XFASTINT (length));
2675 unsigned char *data;
2677 UNREAD (c);
2678 tmp = read1 (readcharfun, pch, first_in_list);
2679 if (STRING_MULTIBYTE (tmp)
2680 || (size_in_chars != SCHARS (tmp)
2681 /* We used to print 1 char too many
2682 when the number of bits was a multiple of 8.
2683 Accept such input in case it came from an old
2684 version. */
2685 && ! (XFASTINT (length)
2686 == (SCHARS (tmp) - 1) * BOOL_VECTOR_BITS_PER_CHAR)))
2687 invalid_syntax ("#&...");
2689 val = make_uninit_bool_vector (XFASTINT (length));
2690 data = bool_vector_uchar_data (val);
2691 memcpy (data, SDATA (tmp), size_in_chars);
2692 /* Clear the extraneous bits in the last byte. */
2693 if (XINT (length) != size_in_chars * BOOL_VECTOR_BITS_PER_CHAR)
2694 data[size_in_chars - 1]
2695 &= (1 << (XINT (length) % BOOL_VECTOR_BITS_PER_CHAR)) - 1;
2696 return val;
2698 invalid_syntax ("#&...");
2700 if (c == '[')
2702 /* Accept compiled functions at read-time so that we don't have to
2703 build them using function calls. */
2704 Lisp_Object tmp;
2705 struct Lisp_Vector *vec;
2706 tmp = read_vector (readcharfun, 1);
2707 vec = XVECTOR (tmp);
2708 if (vec->header.size == 0)
2709 invalid_syntax ("Empty byte-code object");
2710 make_byte_code (vec);
2711 return tmp;
2713 if (c == '(')
2715 Lisp_Object tmp;
2716 struct gcpro gcpro1;
2717 int ch;
2719 /* Read the string itself. */
2720 tmp = read1 (readcharfun, &ch, 0);
2721 if (ch != 0 || !STRINGP (tmp))
2722 invalid_syntax ("#");
2723 GCPRO1 (tmp);
2724 /* Read the intervals and their properties. */
2725 while (1)
2727 Lisp_Object beg, end, plist;
2729 beg = read1 (readcharfun, &ch, 0);
2730 end = plist = Qnil;
2731 if (ch == ')')
2732 break;
2733 if (ch == 0)
2734 end = read1 (readcharfun, &ch, 0);
2735 if (ch == 0)
2736 plist = read1 (readcharfun, &ch, 0);
2737 if (ch)
2738 invalid_syntax ("Invalid string property list");
2739 Fset_text_properties (beg, end, plist, tmp);
2741 UNGCPRO;
2742 return tmp;
2745 /* #@NUMBER is used to skip NUMBER following bytes.
2746 That's used in .elc files to skip over doc strings
2747 and function definitions. */
2748 if (c == '@')
2750 enum { extra = 100 };
2751 ptrdiff_t i, nskip = 0, digits = 0;
2753 /* Read a decimal integer. */
2754 while ((c = READCHAR) >= 0
2755 && c >= '0' && c <= '9')
2757 if ((STRING_BYTES_BOUND - extra) / 10 <= nskip)
2758 string_overflow ();
2759 digits++;
2760 nskip *= 10;
2761 nskip += c - '0';
2762 if (digits == 2 && nskip == 0)
2763 { /* We've just seen #@00, which means "skip to end". */
2764 skip_dyn_eof (readcharfun);
2765 return Qnil;
2768 if (nskip > 0)
2769 /* We can't use UNREAD here, because in the code below we side-step
2770 READCHAR. Instead, assume the first char after #@NNN occupies
2771 a single byte, which is the case normally since it's just
2772 a space. */
2773 nskip--;
2774 else
2775 UNREAD (c);
2777 if (load_force_doc_strings
2778 && (FROM_FILE_P (readcharfun)))
2780 /* If we are supposed to force doc strings into core right now,
2781 record the last string that we skipped,
2782 and record where in the file it comes from. */
2784 /* But first exchange saved_doc_string
2785 with prev_saved_doc_string, so we save two strings. */
2787 char *temp = saved_doc_string;
2788 ptrdiff_t temp_size = saved_doc_string_size;
2789 file_offset temp_pos = saved_doc_string_position;
2790 ptrdiff_t temp_len = saved_doc_string_length;
2792 saved_doc_string = prev_saved_doc_string;
2793 saved_doc_string_size = prev_saved_doc_string_size;
2794 saved_doc_string_position = prev_saved_doc_string_position;
2795 saved_doc_string_length = prev_saved_doc_string_length;
2797 prev_saved_doc_string = temp;
2798 prev_saved_doc_string_size = temp_size;
2799 prev_saved_doc_string_position = temp_pos;
2800 prev_saved_doc_string_length = temp_len;
2803 if (saved_doc_string_size == 0)
2805 saved_doc_string = xmalloc (nskip + extra);
2806 saved_doc_string_size = nskip + extra;
2808 if (nskip > saved_doc_string_size)
2810 saved_doc_string = xrealloc (saved_doc_string, nskip + extra);
2811 saved_doc_string_size = nskip + extra;
2814 saved_doc_string_position = file_tell (instream);
2816 /* Copy that many characters into saved_doc_string. */
2817 block_input ();
2818 for (i = 0; i < nskip && c >= 0; i++)
2819 saved_doc_string[i] = c = getc (instream);
2820 unblock_input ();
2822 saved_doc_string_length = i;
2824 else
2825 /* Skip that many bytes. */
2826 skip_dyn_bytes (readcharfun, nskip);
2828 goto retry;
2830 if (c == '!')
2832 /* #! appears at the beginning of an executable file.
2833 Skip the first line. */
2834 while (c != '\n' && c >= 0)
2835 c = READCHAR;
2836 goto retry;
2838 if (c == '$')
2839 return Vload_file_name;
2840 if (c == '\'')
2841 return list2 (Qfunction, read0 (readcharfun));
2842 /* #:foo is the uninterned symbol named foo. */
2843 if (c == ':')
2845 uninterned_symbol = 1;
2846 c = READCHAR;
2847 if (!(c > 040
2848 && c != 0xa0 /* NBSP */
2849 && (c >= 0200
2850 || strchr ("\"';()[]#`,", c) == NULL)))
2852 /* No symbol character follows, this is the empty
2853 symbol. */
2854 UNREAD (c);
2855 return Fmake_symbol (empty_unibyte_string);
2857 goto read_symbol;
2859 /* ## is the empty symbol. */
2860 if (c == '#')
2861 return Fintern (empty_unibyte_string, Qnil);
2862 /* Reader forms that can reuse previously read objects. */
2863 if (c >= '0' && c <= '9')
2865 EMACS_INT n = 0;
2866 Lisp_Object tem;
2868 /* Read a non-negative integer. */
2869 while (c >= '0' && c <= '9')
2871 if (MOST_POSITIVE_FIXNUM / 10 < n
2872 || MOST_POSITIVE_FIXNUM < n * 10 + c - '0')
2873 n = MOST_POSITIVE_FIXNUM + 1;
2874 else
2875 n = n * 10 + c - '0';
2876 c = READCHAR;
2879 if (n <= MOST_POSITIVE_FIXNUM)
2881 if (c == 'r' || c == 'R')
2882 return read_integer (readcharfun, n);
2884 if (! NILP (Vread_circle))
2886 /* #n=object returns object, but associates it with
2887 n for #n#. */
2888 if (c == '=')
2890 /* Make a placeholder for #n# to use temporarily. */
2891 Lisp_Object placeholder;
2892 Lisp_Object cell;
2894 placeholder = scoped_cons (Qnil, Qnil);
2895 cell = Fcons (make_number (n), placeholder);
2896 read_objects = Fcons (cell, read_objects);
2898 /* Read the object itself. */
2899 tem = read0 (readcharfun);
2901 /* Now put it everywhere the placeholder was... */
2902 substitute_object_in_subtree (tem, placeholder);
2904 /* ...and #n# will use the real value from now on. */
2905 Fsetcdr (cell, tem);
2907 return tem;
2910 /* #n# returns a previously read object. */
2911 if (c == '#')
2913 tem = Fassq (make_number (n), read_objects);
2914 if (CONSP (tem))
2915 return XCDR (tem);
2919 /* Fall through to error message. */
2921 else if (c == 'x' || c == 'X')
2922 return read_integer (readcharfun, 16);
2923 else if (c == 'o' || c == 'O')
2924 return read_integer (readcharfun, 8);
2925 else if (c == 'b' || c == 'B')
2926 return read_integer (readcharfun, 2);
2928 UNREAD (c);
2929 invalid_syntax ("#");
2931 case ';':
2932 while ((c = READCHAR) >= 0 && c != '\n');
2933 goto retry;
2935 case '\'':
2936 return list2 (Qquote, read0 (readcharfun));
2938 case '`':
2940 int next_char = READCHAR;
2941 UNREAD (next_char);
2942 /* Transition from old-style to new-style:
2943 If we see "(`" it used to mean old-style, which usually works
2944 fine because ` should almost never appear in such a position
2945 for new-style. But occasionally we need "(`" to mean new
2946 style, so we try to distinguish the two by the fact that we
2947 can either write "( `foo" or "(` foo", where the first
2948 intends to use new-style whereas the second intends to use
2949 old-style. For Emacs-25, we should completely remove this
2950 first_in_list exception (old-style can still be obtained via
2951 "(\`" anyway). */
2952 if (!new_backquote_flag && first_in_list && next_char == ' ')
2954 Vold_style_backquotes = Qt;
2955 goto default_label;
2957 else
2959 Lisp_Object value;
2960 bool saved_new_backquote_flag = new_backquote_flag;
2962 new_backquote_flag = 1;
2963 value = read0 (readcharfun);
2964 new_backquote_flag = saved_new_backquote_flag;
2966 return list2 (Qbackquote, value);
2969 case ',':
2971 int next_char = READCHAR;
2972 UNREAD (next_char);
2973 /* Transition from old-style to new-style:
2974 It used to be impossible to have a new-style , other than within
2975 a new-style `. This is sufficient when ` and , are used in the
2976 normal way, but ` and , can also appear in args to macros that
2977 will not interpret them in the usual way, in which case , may be
2978 used without any ` anywhere near.
2979 So we now use the same heuristic as for backquote: old-style
2980 unquotes are only recognized when first on a list, and when
2981 followed by a space.
2982 Because it's more difficult to peek 2 chars ahead, a new-style
2983 ,@ can still not be used outside of a `, unless it's in the middle
2984 of a list. */
2985 if (new_backquote_flag
2986 || !first_in_list
2987 || (next_char != ' ' && next_char != '@'))
2989 Lisp_Object comma_type = Qnil;
2990 Lisp_Object value;
2991 int ch = READCHAR;
2993 if (ch == '@')
2994 comma_type = Qcomma_at;
2995 else if (ch == '.')
2996 comma_type = Qcomma_dot;
2997 else
2999 if (ch >= 0) UNREAD (ch);
3000 comma_type = Qcomma;
3003 value = read0 (readcharfun);
3004 return list2 (comma_type, value);
3006 else
3008 Vold_style_backquotes = Qt;
3009 goto default_label;
3012 case '?':
3014 int modifiers;
3015 int next_char;
3016 bool ok;
3018 c = READCHAR;
3019 if (c < 0)
3020 end_of_file_error ();
3022 /* Accept `single space' syntax like (list ? x) where the
3023 whitespace character is SPC or TAB.
3024 Other literal whitespace like NL, CR, and FF are not accepted,
3025 as there are well-established escape sequences for these. */
3026 if (c == ' ' || c == '\t')
3027 return make_number (c);
3029 if (c == '\\')
3030 c = read_escape (readcharfun, 0);
3031 modifiers = c & CHAR_MODIFIER_MASK;
3032 c &= ~CHAR_MODIFIER_MASK;
3033 if (CHAR_BYTE8_P (c))
3034 c = CHAR_TO_BYTE8 (c);
3035 c |= modifiers;
3037 next_char = READCHAR;
3038 ok = (next_char <= 040
3039 || (next_char < 0200
3040 && strchr ("\"';()[]#?`,.", next_char) != NULL));
3041 UNREAD (next_char);
3042 if (ok)
3043 return make_number (c);
3045 invalid_syntax ("?");
3048 case '"':
3050 char *p = read_buffer;
3051 char *end = read_buffer + read_buffer_size;
3052 int ch;
3053 /* True if we saw an escape sequence specifying
3054 a multibyte character. */
3055 bool force_multibyte = 0;
3056 /* True if we saw an escape sequence specifying
3057 a single-byte character. */
3058 bool force_singlebyte = 0;
3059 bool cancel = 0;
3060 ptrdiff_t nchars = 0;
3062 while ((ch = READCHAR) >= 0
3063 && ch != '\"')
3065 if (end - p < MAX_MULTIBYTE_LENGTH)
3067 ptrdiff_t offset = p - read_buffer;
3068 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
3069 memory_full (SIZE_MAX);
3070 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
3071 read_buffer_size *= 2;
3072 p = read_buffer + offset;
3073 end = read_buffer + read_buffer_size;
3076 if (ch == '\\')
3078 int modifiers;
3080 ch = read_escape (readcharfun, 1);
3082 /* CH is -1 if \ newline has just been seen. */
3083 if (ch == -1)
3085 if (p == read_buffer)
3086 cancel = 1;
3087 continue;
3090 modifiers = ch & CHAR_MODIFIER_MASK;
3091 ch = ch & ~CHAR_MODIFIER_MASK;
3093 if (CHAR_BYTE8_P (ch))
3094 force_singlebyte = 1;
3095 else if (! ASCII_CHAR_P (ch))
3096 force_multibyte = 1;
3097 else /* I.e. ASCII_CHAR_P (ch). */
3099 /* Allow `\C- ' and `\C-?'. */
3100 if (modifiers == CHAR_CTL)
3102 if (ch == ' ')
3103 ch = 0, modifiers = 0;
3104 else if (ch == '?')
3105 ch = 127, modifiers = 0;
3107 if (modifiers & CHAR_SHIFT)
3109 /* Shift modifier is valid only with [A-Za-z]. */
3110 if (ch >= 'A' && ch <= 'Z')
3111 modifiers &= ~CHAR_SHIFT;
3112 else if (ch >= 'a' && ch <= 'z')
3113 ch -= ('a' - 'A'), modifiers &= ~CHAR_SHIFT;
3116 if (modifiers & CHAR_META)
3118 /* Move the meta bit to the right place for a
3119 string. */
3120 modifiers &= ~CHAR_META;
3121 ch = BYTE8_TO_CHAR (ch | 0x80);
3122 force_singlebyte = 1;
3126 /* Any modifiers remaining are invalid. */
3127 if (modifiers)
3128 error ("Invalid modifier in string");
3129 p += CHAR_STRING (ch, (unsigned char *) p);
3131 else
3133 p += CHAR_STRING (ch, (unsigned char *) p);
3134 if (CHAR_BYTE8_P (ch))
3135 force_singlebyte = 1;
3136 else if (! ASCII_CHAR_P (ch))
3137 force_multibyte = 1;
3139 nchars++;
3142 if (ch < 0)
3143 end_of_file_error ();
3145 /* If purifying, and string starts with \ newline,
3146 return zero instead. This is for doc strings
3147 that we are really going to find in etc/DOC.nn.nn. */
3148 if (!NILP (Vpurify_flag) && NILP (Vdoc_file_name) && cancel)
3149 return make_number (0);
3151 if (! force_multibyte && force_singlebyte)
3153 /* READ_BUFFER contains raw 8-bit bytes and no multibyte
3154 forms. Convert it to unibyte. */
3155 nchars = str_as_unibyte ((unsigned char *) read_buffer,
3156 p - read_buffer);
3157 p = read_buffer + nchars;
3160 return make_specified_string (read_buffer, nchars, p - read_buffer,
3161 (force_multibyte
3162 || (p - read_buffer != nchars)));
3165 case '.':
3167 int next_char = READCHAR;
3168 UNREAD (next_char);
3170 if (next_char <= 040
3171 || (next_char < 0200
3172 && strchr ("\"';([#?`,", next_char) != NULL))
3174 *pch = c;
3175 return Qnil;
3178 /* Otherwise, we fall through! Note that the atom-reading loop
3179 below will now loop at least once, assuring that we will not
3180 try to UNREAD two characters in a row. */
3182 default:
3183 default_label:
3184 if (c <= 040) goto retry;
3185 if (c == 0xa0) /* NBSP */
3186 goto retry;
3188 read_symbol:
3190 char *p = read_buffer;
3191 bool quoted = 0;
3192 EMACS_INT start_position = readchar_count - 1;
3195 char *end = read_buffer + read_buffer_size;
3199 if (end - p < MAX_MULTIBYTE_LENGTH)
3201 ptrdiff_t offset = p - read_buffer;
3202 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
3203 memory_full (SIZE_MAX);
3204 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
3205 read_buffer_size *= 2;
3206 p = read_buffer + offset;
3207 end = read_buffer + read_buffer_size;
3210 if (c == '\\')
3212 c = READCHAR;
3213 if (c == -1)
3214 end_of_file_error ();
3215 quoted = 1;
3218 if (multibyte)
3219 p += CHAR_STRING (c, (unsigned char *) p);
3220 else
3221 *p++ = c;
3222 c = READCHAR;
3224 while (c > 040
3225 && c != 0xa0 /* NBSP */
3226 && (c >= 0200
3227 || strchr ("\"';()[]#`,", c) == NULL));
3229 if (p == end)
3231 ptrdiff_t offset = p - read_buffer;
3232 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
3233 memory_full (SIZE_MAX);
3234 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
3235 read_buffer_size *= 2;
3236 p = read_buffer + offset;
3237 end = read_buffer + read_buffer_size;
3239 *p = 0;
3240 UNREAD (c);
3243 if (!quoted && !uninterned_symbol)
3245 Lisp_Object result = string_to_number (read_buffer, 10, 0);
3246 if (! NILP (result))
3247 return result;
3250 Lisp_Object name, result;
3251 ptrdiff_t nbytes = p - read_buffer;
3252 ptrdiff_t nchars
3253 = (multibyte
3254 ? multibyte_chars_in_text ((unsigned char *) read_buffer,
3255 nbytes)
3256 : nbytes);
3258 name = ((uninterned_symbol && ! NILP (Vpurify_flag)
3259 ? make_pure_string : make_specified_string)
3260 (read_buffer, nchars, nbytes, multibyte));
3261 result = (uninterned_symbol ? Fmake_symbol (name)
3262 : Fintern (name, Qnil));
3264 if (EQ (Vread_with_symbol_positions, Qt)
3265 || EQ (Vread_with_symbol_positions, readcharfun))
3266 Vread_symbol_positions_list
3267 = Fcons (Fcons (result, make_number (start_position)),
3268 Vread_symbol_positions_list);
3269 return result;
3276 /* List of nodes we've seen during substitute_object_in_subtree. */
3277 static Lisp_Object seen_list;
3279 static void
3280 substitute_object_in_subtree (Lisp_Object object, Lisp_Object placeholder)
3282 Lisp_Object check_object;
3284 /* We haven't seen any objects when we start. */
3285 seen_list = Qnil;
3287 /* Make all the substitutions. */
3288 check_object
3289 = substitute_object_recurse (object, placeholder, object);
3291 /* Clear seen_list because we're done with it. */
3292 seen_list = Qnil;
3294 /* The returned object here is expected to always eq the
3295 original. */
3296 if (!EQ (check_object, object))
3297 error ("Unexpected mutation error in reader");
3300 /* Feval doesn't get called from here, so no gc protection is needed. */
3301 #define SUBSTITUTE(get_val, set_val) \
3302 do { \
3303 Lisp_Object old_value = get_val; \
3304 Lisp_Object true_value \
3305 = substitute_object_recurse (object, placeholder, \
3306 old_value); \
3308 if (!EQ (old_value, true_value)) \
3310 set_val; \
3312 } while (0)
3314 static Lisp_Object
3315 substitute_object_recurse (Lisp_Object object, Lisp_Object placeholder, Lisp_Object subtree)
3317 /* If we find the placeholder, return the target object. */
3318 if (EQ (placeholder, subtree))
3319 return object;
3321 /* If we've been to this node before, don't explore it again. */
3322 if (!EQ (Qnil, Fmemq (subtree, seen_list)))
3323 return subtree;
3325 /* If this node can be the entry point to a cycle, remember that
3326 we've seen it. It can only be such an entry point if it was made
3327 by #n=, which means that we can find it as a value in
3328 read_objects. */
3329 if (!EQ (Qnil, Frassq (subtree, read_objects)))
3330 seen_list = Fcons (subtree, seen_list);
3332 /* Recurse according to subtree's type.
3333 Every branch must return a Lisp_Object. */
3334 switch (XTYPE (subtree))
3336 case Lisp_Vectorlike:
3338 ptrdiff_t i, length = 0;
3339 if (BOOL_VECTOR_P (subtree))
3340 return subtree; /* No sub-objects anyway. */
3341 else if (CHAR_TABLE_P (subtree) || SUB_CHAR_TABLE_P (subtree)
3342 || COMPILEDP (subtree) || HASH_TABLE_P (subtree))
3343 length = ASIZE (subtree) & PSEUDOVECTOR_SIZE_MASK;
3344 else if (VECTORP (subtree))
3345 length = ASIZE (subtree);
3346 else
3347 /* An unknown pseudovector may contain non-Lisp fields, so we
3348 can't just blindly traverse all its fields. We used to call
3349 `Flength' which signaled `sequencep', so I just preserved this
3350 behavior. */
3351 wrong_type_argument (Qsequencep, subtree);
3353 for (i = 0; i < length; i++)
3354 SUBSTITUTE (AREF (subtree, i),
3355 ASET (subtree, i, true_value));
3356 return subtree;
3359 case Lisp_Cons:
3361 SUBSTITUTE (XCAR (subtree),
3362 XSETCAR (subtree, true_value));
3363 SUBSTITUTE (XCDR (subtree),
3364 XSETCDR (subtree, true_value));
3365 return subtree;
3368 case Lisp_String:
3370 /* Check for text properties in each interval.
3371 substitute_in_interval contains part of the logic. */
3373 INTERVAL root_interval = string_intervals (subtree);
3374 Lisp_Object arg = scoped_cons (object, placeholder);
3376 traverse_intervals_noorder (root_interval,
3377 &substitute_in_interval, arg);
3379 return subtree;
3382 /* Other types don't recurse any further. */
3383 default:
3384 return subtree;
3388 /* Helper function for substitute_object_recurse. */
3389 static void
3390 substitute_in_interval (INTERVAL interval, Lisp_Object arg)
3392 Lisp_Object object = Fcar (arg);
3393 Lisp_Object placeholder = Fcdr (arg);
3395 SUBSTITUTE (interval->plist, set_interval_plist (interval, true_value));
3399 #define LEAD_INT 1
3400 #define DOT_CHAR 2
3401 #define TRAIL_INT 4
3402 #define E_EXP 16
3405 /* Convert STRING to a number, assuming base BASE. Return a fixnum if CP has
3406 integer syntax and fits in a fixnum, else return the nearest float if CP has
3407 either floating point or integer syntax and BASE is 10, else return nil. If
3408 IGNORE_TRAILING, consider just the longest prefix of CP that has
3409 valid floating point syntax. Signal an overflow if BASE is not 10 and the
3410 number has integer syntax but does not fit. */
3412 Lisp_Object
3413 string_to_number (char const *string, int base, bool ignore_trailing)
3415 int state;
3416 char const *cp = string;
3417 int leading_digit;
3418 bool float_syntax = 0;
3419 double value = 0;
3421 /* Compute NaN and infinities using a variable, to cope with compilers that
3422 think they are smarter than we are. */
3423 double zero = 0;
3425 /* Negate the value ourselves. This treats 0, NaNs, and infinity properly on
3426 IEEE floating point hosts, and works around a formerly-common bug where
3427 atof ("-0.0") drops the sign. */
3428 bool negative = *cp == '-';
3430 bool signedp = negative || *cp == '+';
3431 cp += signedp;
3433 state = 0;
3435 leading_digit = digit_to_number (*cp, base);
3436 if (leading_digit >= 0)
3438 state |= LEAD_INT;
3440 ++cp;
3441 while (digit_to_number (*cp, base) >= 0);
3443 if (*cp == '.')
3445 state |= DOT_CHAR;
3446 cp++;
3449 if (base == 10)
3451 if ('0' <= *cp && *cp <= '9')
3453 state |= TRAIL_INT;
3455 cp++;
3456 while ('0' <= *cp && *cp <= '9');
3458 if (*cp == 'e' || *cp == 'E')
3460 char const *ecp = cp;
3461 cp++;
3462 if (*cp == '+' || *cp == '-')
3463 cp++;
3464 if ('0' <= *cp && *cp <= '9')
3466 state |= E_EXP;
3468 cp++;
3469 while ('0' <= *cp && *cp <= '9');
3471 else if (cp[-1] == '+'
3472 && cp[0] == 'I' && cp[1] == 'N' && cp[2] == 'F')
3474 state |= E_EXP;
3475 cp += 3;
3476 value = 1.0 / zero;
3478 else if (cp[-1] == '+'
3479 && cp[0] == 'N' && cp[1] == 'a' && cp[2] == 'N')
3481 state |= E_EXP;
3482 cp += 3;
3483 value = zero / zero;
3485 /* If that made a "negative" NaN, negate it. */
3487 int i;
3488 union { double d; char c[sizeof (double)]; }
3489 u_data, u_minus_zero;
3490 u_data.d = value;
3491 u_minus_zero.d = -0.0;
3492 for (i = 0; i < sizeof (double); i++)
3493 if (u_data.c[i] & u_minus_zero.c[i])
3495 value = -value;
3496 break;
3499 /* Now VALUE is a positive NaN. */
3501 else
3502 cp = ecp;
3505 float_syntax = ((state & (DOT_CHAR|TRAIL_INT)) == (DOT_CHAR|TRAIL_INT)
3506 || state == (LEAD_INT|E_EXP));
3509 /* Return nil if the number uses invalid syntax. If IGNORE_TRAILING, accept
3510 any prefix that matches. Otherwise, the entire string must match. */
3511 if (! (ignore_trailing
3512 ? ((state & LEAD_INT) != 0 || float_syntax)
3513 : (!*cp && ((state & ~DOT_CHAR) == LEAD_INT || float_syntax))))
3514 return Qnil;
3516 /* If the number uses integer and not float syntax, and is in C-language
3517 range, use its value, preferably as a fixnum. */
3518 if (leading_digit >= 0 && ! float_syntax)
3520 uintmax_t n;
3522 /* Fast special case for single-digit integers. This also avoids a
3523 glitch when BASE is 16 and IGNORE_TRAILING, because in that
3524 case some versions of strtoumax accept numbers like "0x1" that Emacs
3525 does not allow. */
3526 if (digit_to_number (string[signedp + 1], base) < 0)
3527 return make_number (negative ? -leading_digit : leading_digit);
3529 errno = 0;
3530 n = strtoumax (string + signedp, NULL, base);
3531 if (errno == ERANGE)
3533 /* Unfortunately there's no simple and accurate way to convert
3534 non-base-10 numbers that are out of C-language range. */
3535 if (base != 10)
3536 xsignal1 (Qoverflow_error, build_string (string));
3538 else if (n <= (negative ? -MOST_NEGATIVE_FIXNUM : MOST_POSITIVE_FIXNUM))
3540 EMACS_INT signed_n = n;
3541 return make_number (negative ? -signed_n : signed_n);
3543 else
3544 value = n;
3547 /* Either the number uses float syntax, or it does not fit into a fixnum.
3548 Convert it from string to floating point, unless the value is already
3549 known because it is an infinity, a NAN, or its absolute value fits in
3550 uintmax_t. */
3551 if (! value)
3552 value = atof (string + signedp);
3554 return make_float (negative ? -value : value);
3558 static Lisp_Object
3559 read_vector (Lisp_Object readcharfun, bool bytecodeflag)
3561 ptrdiff_t i, size;
3562 Lisp_Object *ptr;
3563 Lisp_Object tem, item, vector;
3564 struct Lisp_Cons *otem;
3565 Lisp_Object len;
3567 tem = read_list (1, readcharfun);
3568 len = Flength (tem);
3569 vector = Fmake_vector (len, Qnil);
3571 size = ASIZE (vector);
3572 ptr = XVECTOR (vector)->contents;
3573 for (i = 0; i < size; i++)
3575 item = Fcar (tem);
3576 /* If `load-force-doc-strings' is t when reading a lazily-loaded
3577 bytecode object, the docstring containing the bytecode and
3578 constants values must be treated as unibyte and passed to
3579 Fread, to get the actual bytecode string and constants vector. */
3580 if (bytecodeflag && load_force_doc_strings)
3582 if (i == COMPILED_BYTECODE)
3584 if (!STRINGP (item))
3585 error ("Invalid byte code");
3587 /* Delay handling the bytecode slot until we know whether
3588 it is lazily-loaded (we can tell by whether the
3589 constants slot is nil). */
3590 ASET (vector, COMPILED_CONSTANTS, item);
3591 item = Qnil;
3593 else if (i == COMPILED_CONSTANTS)
3595 Lisp_Object bytestr = ptr[COMPILED_CONSTANTS];
3597 if (NILP (item))
3599 /* Coerce string to unibyte (like string-as-unibyte,
3600 but without generating extra garbage and
3601 guaranteeing no change in the contents). */
3602 STRING_SET_CHARS (bytestr, SBYTES (bytestr));
3603 STRING_SET_UNIBYTE (bytestr);
3605 item = Fread (Fcons (bytestr, readcharfun));
3606 if (!CONSP (item))
3607 error ("Invalid byte code");
3609 otem = XCONS (item);
3610 bytestr = XCAR (item);
3611 item = XCDR (item);
3612 free_cons (otem);
3615 /* Now handle the bytecode slot. */
3616 ASET (vector, COMPILED_BYTECODE, bytestr);
3618 else if (i == COMPILED_DOC_STRING
3619 && STRINGP (item)
3620 && ! STRING_MULTIBYTE (item))
3622 if (EQ (readcharfun, Qget_emacs_mule_file_char))
3623 item = Fdecode_coding_string (item, Qemacs_mule, Qnil, Qnil);
3624 else
3625 item = Fstring_as_multibyte (item);
3628 ASET (vector, i, item);
3629 otem = XCONS (tem);
3630 tem = Fcdr (tem);
3631 free_cons (otem);
3633 return vector;
3636 /* FLAG means check for ']' to terminate rather than ')' and '.'. */
3638 static Lisp_Object
3639 read_list (bool flag, Lisp_Object readcharfun)
3641 Lisp_Object val, tail;
3642 Lisp_Object elt, tem;
3643 struct gcpro gcpro1, gcpro2;
3644 /* 0 is the normal case.
3645 1 means this list is a doc reference; replace it with the number 0.
3646 2 means this list is a doc reference; replace it with the doc string. */
3647 int doc_reference = 0;
3649 /* Initialize this to 1 if we are reading a list. */
3650 bool first_in_list = flag <= 0;
3652 val = Qnil;
3653 tail = Qnil;
3655 while (1)
3657 int ch;
3658 GCPRO2 (val, tail);
3659 elt = read1 (readcharfun, &ch, first_in_list);
3660 UNGCPRO;
3662 first_in_list = 0;
3664 /* While building, if the list starts with #$, treat it specially. */
3665 if (EQ (elt, Vload_file_name)
3666 && ! NILP (elt)
3667 && !NILP (Vpurify_flag))
3669 if (NILP (Vdoc_file_name))
3670 /* We have not yet called Snarf-documentation, so assume
3671 this file is described in the DOC file
3672 and Snarf-documentation will fill in the right value later.
3673 For now, replace the whole list with 0. */
3674 doc_reference = 1;
3675 else
3676 /* We have already called Snarf-documentation, so make a relative
3677 file name for this file, so it can be found properly
3678 in the installed Lisp directory.
3679 We don't use Fexpand_file_name because that would make
3680 the directory absolute now. */
3681 elt = concat2 (build_local_string ("../lisp/"),
3682 Ffile_name_nondirectory (elt));
3684 else if (EQ (elt, Vload_file_name)
3685 && ! NILP (elt)
3686 && load_force_doc_strings)
3687 doc_reference = 2;
3689 if (ch)
3691 if (flag > 0)
3693 if (ch == ']')
3694 return val;
3695 invalid_syntax (") or . in a vector");
3697 if (ch == ')')
3698 return val;
3699 if (ch == '.')
3701 GCPRO2 (val, tail);
3702 if (!NILP (tail))
3703 XSETCDR (tail, read0 (readcharfun));
3704 else
3705 val = read0 (readcharfun);
3706 read1 (readcharfun, &ch, 0);
3707 UNGCPRO;
3708 if (ch == ')')
3710 if (doc_reference == 1)
3711 return make_number (0);
3712 if (doc_reference == 2 && INTEGERP (XCDR (val)))
3714 char *saved = NULL;
3715 file_offset saved_position;
3716 /* Get a doc string from the file we are loading.
3717 If it's in saved_doc_string, get it from there.
3719 Here, we don't know if the string is a
3720 bytecode string or a doc string. As a
3721 bytecode string must be unibyte, we always
3722 return a unibyte string. If it is actually a
3723 doc string, caller must make it
3724 multibyte. */
3726 /* Position is negative for user variables. */
3727 EMACS_INT pos = eabs (XINT (XCDR (val)));
3728 if (pos >= saved_doc_string_position
3729 && pos < (saved_doc_string_position
3730 + saved_doc_string_length))
3732 saved = saved_doc_string;
3733 saved_position = saved_doc_string_position;
3735 /* Look in prev_saved_doc_string the same way. */
3736 else if (pos >= prev_saved_doc_string_position
3737 && pos < (prev_saved_doc_string_position
3738 + prev_saved_doc_string_length))
3740 saved = prev_saved_doc_string;
3741 saved_position = prev_saved_doc_string_position;
3743 if (saved)
3745 ptrdiff_t start = pos - saved_position;
3746 ptrdiff_t from, to;
3748 /* Process quoting with ^A,
3749 and find the end of the string,
3750 which is marked with ^_ (037). */
3751 for (from = start, to = start;
3752 saved[from] != 037;)
3754 int c = saved[from++];
3755 if (c == 1)
3757 c = saved[from++];
3758 saved[to++] = (c == 1 ? c
3759 : c == '0' ? 0
3760 : c == '_' ? 037
3761 : c);
3763 else
3764 saved[to++] = c;
3767 return make_unibyte_string (saved + start,
3768 to - start);
3770 else
3771 return get_doc_string (val, 1, 0);
3774 return val;
3776 invalid_syntax (". in wrong context");
3778 invalid_syntax ("] in a list");
3780 tem = list1 (elt);
3781 if (!NILP (tail))
3782 XSETCDR (tail, tem);
3783 else
3784 val = tem;
3785 tail = tem;
3789 static Lisp_Object initial_obarray;
3791 /* `oblookup' stores the bucket number here, for the sake of Funintern. */
3793 static size_t oblookup_last_bucket_number;
3795 /* Get an error if OBARRAY is not an obarray.
3796 If it is one, return it. */
3798 Lisp_Object
3799 check_obarray (Lisp_Object obarray)
3801 if (!VECTORP (obarray) || ASIZE (obarray) == 0)
3803 /* If Vobarray is now invalid, force it to be valid. */
3804 if (EQ (Vobarray, obarray)) Vobarray = initial_obarray;
3805 wrong_type_argument (Qvectorp, obarray);
3807 return obarray;
3810 /* Intern a symbol with name STRING in OBARRAY using bucket INDEX. */
3812 Lisp_Object
3813 intern_driver (Lisp_Object string, Lisp_Object obarray, ptrdiff_t index)
3815 Lisp_Object *ptr, sym = Fmake_symbol (string);
3817 XSYMBOL (sym)->interned = (EQ (obarray, initial_obarray)
3818 ? SYMBOL_INTERNED_IN_INITIAL_OBARRAY
3819 : SYMBOL_INTERNED);
3821 if ((SREF (string, 0) == ':') && EQ (obarray, initial_obarray))
3823 XSYMBOL (sym)->constant = 1;
3824 XSYMBOL (sym)->redirect = SYMBOL_PLAINVAL;
3825 SET_SYMBOL_VAL (XSYMBOL (sym), sym);
3828 ptr = aref_addr (obarray, index);
3829 set_symbol_next (sym, SYMBOLP (*ptr) ? XSYMBOL (*ptr) : NULL);
3830 *ptr = sym;
3831 return sym;
3834 /* Intern the C string STR: return a symbol with that name,
3835 interned in the current obarray. */
3837 Lisp_Object
3838 intern_1 (const char *str, ptrdiff_t len)
3840 Lisp_Object obarray = check_obarray (Vobarray);
3841 Lisp_Object tem = oblookup (obarray, str, len, len);
3843 return SYMBOLP (tem) ? tem : intern_driver (make_string (str, len),
3844 obarray, XINT (tem));
3847 Lisp_Object
3848 intern_c_string_1 (const char *str, ptrdiff_t len)
3850 Lisp_Object obarray = check_obarray (Vobarray);
3851 Lisp_Object tem = oblookup (obarray, str, len, len);
3853 if (!SYMBOLP (tem))
3855 /* Creating a non-pure string from a string literal not implemented yet.
3856 We could just use make_string here and live with the extra copy. */
3857 eassert (!NILP (Vpurify_flag));
3858 tem = intern_driver (make_pure_c_string (str, len), obarray, XINT (tem));
3860 return tem;
3863 DEFUN ("intern", Fintern, Sintern, 1, 2, 0,
3864 doc: /* Return the canonical symbol whose name is STRING.
3865 If there is none, one is created by this function and returned.
3866 A second optional argument specifies the obarray to use;
3867 it defaults to the value of `obarray'. */)
3868 (Lisp_Object string, Lisp_Object obarray)
3870 Lisp_Object tem;
3872 obarray = check_obarray (NILP (obarray) ? Vobarray : obarray);
3873 CHECK_STRING (string);
3875 tem = oblookup (obarray, SSDATA (string), SCHARS (string), SBYTES (string));
3876 if (!SYMBOLP (tem))
3877 tem = intern_driver (NILP (Vpurify_flag) ? string
3878 : Fpurecopy (string), obarray, XINT (tem));
3879 return tem;
3882 DEFUN ("intern-soft", Fintern_soft, Sintern_soft, 1, 2, 0,
3883 doc: /* Return the canonical symbol named NAME, or nil if none exists.
3884 NAME may be a string or a symbol. If it is a symbol, that exact
3885 symbol is searched for.
3886 A second optional argument specifies the obarray to use;
3887 it defaults to the value of `obarray'. */)
3888 (Lisp_Object name, Lisp_Object obarray)
3890 register Lisp_Object tem, string;
3892 if (NILP (obarray)) obarray = Vobarray;
3893 obarray = check_obarray (obarray);
3895 if (!SYMBOLP (name))
3897 CHECK_STRING (name);
3898 string = name;
3900 else
3901 string = SYMBOL_NAME (name);
3903 tem = oblookup (obarray, SSDATA (string), SCHARS (string), SBYTES (string));
3904 if (INTEGERP (tem) || (SYMBOLP (name) && !EQ (name, tem)))
3905 return Qnil;
3906 else
3907 return tem;
3910 DEFUN ("unintern", Funintern, Sunintern, 1, 2, 0,
3911 doc: /* Delete the symbol named NAME, if any, from OBARRAY.
3912 The value is t if a symbol was found and deleted, nil otherwise.
3913 NAME may be a string or a symbol. If it is a symbol, that symbol
3914 is deleted, if it belongs to OBARRAY--no other symbol is deleted.
3915 OBARRAY, if nil, defaults to the value of the variable `obarray'.
3916 usage: (unintern NAME OBARRAY) */)
3917 (Lisp_Object name, Lisp_Object obarray)
3919 register Lisp_Object string, tem;
3920 size_t hash;
3922 if (NILP (obarray)) obarray = Vobarray;
3923 obarray = check_obarray (obarray);
3925 if (SYMBOLP (name))
3926 string = SYMBOL_NAME (name);
3927 else
3929 CHECK_STRING (name);
3930 string = name;
3933 tem = oblookup (obarray, SSDATA (string),
3934 SCHARS (string),
3935 SBYTES (string));
3936 if (INTEGERP (tem))
3937 return Qnil;
3938 /* If arg was a symbol, don't delete anything but that symbol itself. */
3939 if (SYMBOLP (name) && !EQ (name, tem))
3940 return Qnil;
3942 /* There are plenty of other symbols which will screw up the Emacs
3943 session if we unintern them, as well as even more ways to use
3944 `setq' or `fset' or whatnot to make the Emacs session
3945 unusable. Let's not go down this silly road. --Stef */
3946 /* if (EQ (tem, Qnil) || EQ (tem, Qt))
3947 error ("Attempt to unintern t or nil"); */
3949 XSYMBOL (tem)->interned = SYMBOL_UNINTERNED;
3951 hash = oblookup_last_bucket_number;
3953 if (EQ (AREF (obarray, hash), tem))
3955 if (XSYMBOL (tem)->next)
3957 Lisp_Object sym;
3958 XSETSYMBOL (sym, XSYMBOL (tem)->next);
3959 ASET (obarray, hash, sym);
3961 else
3962 ASET (obarray, hash, make_number (0));
3964 else
3966 Lisp_Object tail, following;
3968 for (tail = AREF (obarray, hash);
3969 XSYMBOL (tail)->next;
3970 tail = following)
3972 XSETSYMBOL (following, XSYMBOL (tail)->next);
3973 if (EQ (following, tem))
3975 set_symbol_next (tail, XSYMBOL (following)->next);
3976 break;
3981 return Qt;
3984 /* Return the symbol in OBARRAY whose names matches the string
3985 of SIZE characters (SIZE_BYTE bytes) at PTR.
3986 If there is no such symbol, return the integer bucket number of
3987 where the symbol would be if it were present.
3989 Also store the bucket number in oblookup_last_bucket_number. */
3991 Lisp_Object
3992 oblookup (Lisp_Object obarray, register const char *ptr, ptrdiff_t size, ptrdiff_t size_byte)
3994 size_t hash;
3995 size_t obsize;
3996 register Lisp_Object tail;
3997 Lisp_Object bucket, tem;
3999 obarray = check_obarray (obarray);
4000 obsize = ASIZE (obarray);
4002 /* This is sometimes needed in the middle of GC. */
4003 obsize &= ~ARRAY_MARK_FLAG;
4004 hash = hash_string (ptr, size_byte) % obsize;
4005 bucket = AREF (obarray, hash);
4006 oblookup_last_bucket_number = hash;
4007 if (EQ (bucket, make_number (0)))
4009 else if (!SYMBOLP (bucket))
4010 error ("Bad data in guts of obarray"); /* Like CADR error message. */
4011 else
4012 for (tail = bucket; ; XSETSYMBOL (tail, XSYMBOL (tail)->next))
4014 if (SBYTES (SYMBOL_NAME (tail)) == size_byte
4015 && SCHARS (SYMBOL_NAME (tail)) == size
4016 && !memcmp (SDATA (SYMBOL_NAME (tail)), ptr, size_byte))
4017 return tail;
4018 else if (XSYMBOL (tail)->next == 0)
4019 break;
4021 XSETINT (tem, hash);
4022 return tem;
4025 void
4026 map_obarray (Lisp_Object obarray, void (*fn) (Lisp_Object, Lisp_Object), Lisp_Object arg)
4028 ptrdiff_t i;
4029 register Lisp_Object tail;
4030 CHECK_VECTOR (obarray);
4031 for (i = ASIZE (obarray) - 1; i >= 0; i--)
4033 tail = AREF (obarray, i);
4034 if (SYMBOLP (tail))
4035 while (1)
4037 (*fn) (tail, arg);
4038 if (XSYMBOL (tail)->next == 0)
4039 break;
4040 XSETSYMBOL (tail, XSYMBOL (tail)->next);
4045 static void
4046 mapatoms_1 (Lisp_Object sym, Lisp_Object function)
4048 call1 (function, sym);
4051 DEFUN ("mapatoms", Fmapatoms, Smapatoms, 1, 2, 0,
4052 doc: /* Call FUNCTION on every symbol in OBARRAY.
4053 OBARRAY defaults to the value of `obarray'. */)
4054 (Lisp_Object function, Lisp_Object obarray)
4056 if (NILP (obarray)) obarray = Vobarray;
4057 obarray = check_obarray (obarray);
4059 map_obarray (obarray, mapatoms_1, function);
4060 return Qnil;
4063 #define OBARRAY_SIZE 1511
4065 void
4066 init_obarray (void)
4068 Lisp_Object oblength;
4069 ptrdiff_t size = 100 + MAX_MULTIBYTE_LENGTH;
4071 XSETFASTINT (oblength, OBARRAY_SIZE);
4073 Vobarray = Fmake_vector (oblength, make_number (0));
4074 initial_obarray = Vobarray;
4075 staticpro (&initial_obarray);
4077 Qunbound = Fmake_symbol (build_pure_c_string ("unbound"));
4078 /* Set temporary dummy values to Qnil and Vpurify_flag to satisfy the
4079 NILP (Vpurify_flag) check in intern_c_string. */
4080 Qnil = make_number (-1); Vpurify_flag = make_number (1);
4081 Qnil = intern_c_string ("nil");
4083 /* Fmake_symbol inits fields of new symbols with Qunbound and Qnil,
4084 so those two need to be fixed manually. */
4085 SET_SYMBOL_VAL (XSYMBOL (Qunbound), Qunbound);
4086 set_symbol_function (Qunbound, Qnil);
4087 set_symbol_plist (Qunbound, Qnil);
4088 SET_SYMBOL_VAL (XSYMBOL (Qnil), Qnil);
4089 XSYMBOL (Qnil)->constant = 1;
4090 XSYMBOL (Qnil)->declared_special = 1;
4091 set_symbol_plist (Qnil, Qnil);
4092 set_symbol_function (Qnil, Qnil);
4094 Qt = intern_c_string ("t");
4095 SET_SYMBOL_VAL (XSYMBOL (Qt), Qt);
4096 XSYMBOL (Qnil)->declared_special = 1;
4097 XSYMBOL (Qt)->constant = 1;
4099 /* Qt is correct even if CANNOT_DUMP. loadup.el will set to nil at end. */
4100 Vpurify_flag = Qt;
4102 DEFSYM (Qvariable_documentation, "variable-documentation");
4104 read_buffer = xmalloc (size);
4105 read_buffer_size = size;
4108 void
4109 defsubr (struct Lisp_Subr *sname)
4111 Lisp_Object sym, tem;
4112 sym = intern_c_string (sname->symbol_name);
4113 XSETPVECTYPE (sname, PVEC_SUBR);
4114 XSETSUBR (tem, sname);
4115 set_symbol_function (sym, tem);
4118 #ifdef NOTDEF /* Use fset in subr.el now! */
4119 void
4120 defalias (struct Lisp_Subr *sname, char *string)
4122 Lisp_Object sym;
4123 sym = intern (string);
4124 XSETSUBR (XSYMBOL (sym)->function, sname);
4126 #endif /* NOTDEF */
4128 /* Define an "integer variable"; a symbol whose value is forwarded to a
4129 C variable of type EMACS_INT. Sample call (with "xx" to fool make-docfile):
4130 DEFxxVAR_INT ("emacs-priority", &emacs_priority, "Documentation"); */
4131 void
4132 defvar_int (struct Lisp_Intfwd *i_fwd,
4133 const char *namestring, EMACS_INT *address)
4135 Lisp_Object sym;
4136 sym = intern_c_string (namestring);
4137 i_fwd->type = Lisp_Fwd_Int;
4138 i_fwd->intvar = address;
4139 XSYMBOL (sym)->declared_special = 1;
4140 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4141 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)i_fwd);
4144 /* Similar but define a variable whose value is t if address contains 1,
4145 nil if address contains 0. */
4146 void
4147 defvar_bool (struct Lisp_Boolfwd *b_fwd,
4148 const char *namestring, bool *address)
4150 Lisp_Object sym;
4151 sym = intern_c_string (namestring);
4152 b_fwd->type = Lisp_Fwd_Bool;
4153 b_fwd->boolvar = address;
4154 XSYMBOL (sym)->declared_special = 1;
4155 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4156 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)b_fwd);
4157 Vbyte_boolean_vars = Fcons (sym, Vbyte_boolean_vars);
4160 /* Similar but define a variable whose value is the Lisp Object stored
4161 at address. Two versions: with and without gc-marking of the C
4162 variable. The nopro version is used when that variable will be
4163 gc-marked for some other reason, since marking the same slot twice
4164 can cause trouble with strings. */
4165 void
4166 defvar_lisp_nopro (struct Lisp_Objfwd *o_fwd,
4167 const char *namestring, Lisp_Object *address)
4169 Lisp_Object sym;
4170 sym = intern_c_string (namestring);
4171 o_fwd->type = Lisp_Fwd_Obj;
4172 o_fwd->objvar = address;
4173 XSYMBOL (sym)->declared_special = 1;
4174 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4175 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)o_fwd);
4178 void
4179 defvar_lisp (struct Lisp_Objfwd *o_fwd,
4180 const char *namestring, Lisp_Object *address)
4182 defvar_lisp_nopro (o_fwd, namestring, address);
4183 staticpro (address);
4186 /* Similar but define a variable whose value is the Lisp Object stored
4187 at a particular offset in the current kboard object. */
4189 void
4190 defvar_kboard (struct Lisp_Kboard_Objfwd *ko_fwd,
4191 const char *namestring, int offset)
4193 Lisp_Object sym;
4194 sym = intern_c_string (namestring);
4195 ko_fwd->type = Lisp_Fwd_Kboard_Obj;
4196 ko_fwd->offset = offset;
4197 XSYMBOL (sym)->declared_special = 1;
4198 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4199 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)ko_fwd);
4202 /* Check that the elements of lpath exist. */
4204 static void
4205 load_path_check (Lisp_Object lpath)
4207 Lisp_Object path_tail;
4209 /* The only elements that might not exist are those from
4210 PATH_LOADSEARCH, EMACSLOADPATH. Anything else is only added if
4211 it exists. */
4212 for (path_tail = lpath; !NILP (path_tail); path_tail = XCDR (path_tail))
4214 Lisp_Object dirfile;
4215 dirfile = Fcar (path_tail);
4216 if (STRINGP (dirfile))
4218 dirfile = Fdirectory_file_name (dirfile);
4219 if (! file_accessible_directory_p (dirfile))
4220 dir_warning ("Lisp directory", XCAR (path_tail));
4225 /* Return the default load-path, to be used if EMACSLOADPATH is unset.
4226 This does not include the standard site-lisp directories
4227 under the installation prefix (i.e., PATH_SITELOADSEARCH),
4228 but it does (unless no_site_lisp is set) include site-lisp
4229 directories in the source/build directories if those exist and we
4230 are running uninstalled.
4232 Uses the following logic:
4233 If CANNOT_DUMP: Use PATH_LOADSEARCH.
4234 The remainder is what happens when dumping works:
4235 If purify-flag (ie dumping) just use PATH_DUMPLOADSEARCH.
4236 Otherwise use PATH_LOADSEARCH.
4238 If !initialized, then just return PATH_DUMPLOADSEARCH.
4239 If initialized:
4240 If Vinstallation_directory is not nil (ie, running uninstalled):
4241 If installation-dir/lisp exists and not already a member,
4242 we must be running uninstalled. Reset the load-path
4243 to just installation-dir/lisp. (The default PATH_LOADSEARCH
4244 refers to the eventual installation directories. Since we
4245 are not yet installed, we should not use them, even if they exist.)
4246 If installation-dir/lisp does not exist, just add
4247 PATH_DUMPLOADSEARCH at the end instead.
4248 Add installation-dir/site-lisp (if !no_site_lisp, and exists
4249 and not already a member) at the front.
4250 If installation-dir != source-dir (ie running an uninstalled,
4251 out-of-tree build) AND install-dir/src/Makefile exists BUT
4252 install-dir/src/Makefile.in does NOT exist (this is a sanity
4253 check), then repeat the above steps for source-dir/lisp, site-lisp. */
4255 static Lisp_Object
4256 load_path_default (void)
4258 Lisp_Object lpath = Qnil;
4259 const char *normal;
4261 #ifdef CANNOT_DUMP
4262 #ifdef HAVE_NS
4263 const char *loadpath = ns_load_path ();
4264 #endif
4266 normal = PATH_LOADSEARCH;
4267 #ifdef HAVE_NS
4268 lpath = decode_env_path (0, loadpath ? loadpath : normal, 0);
4269 #else
4270 lpath = decode_env_path (0, normal, 0);
4271 #endif
4273 #else /* !CANNOT_DUMP */
4275 normal = NILP (Vpurify_flag) ? PATH_LOADSEARCH : PATH_DUMPLOADSEARCH;
4277 if (initialized)
4279 #ifdef HAVE_NS
4280 const char *loadpath = ns_load_path ();
4281 lpath = decode_env_path (0, loadpath ? loadpath : normal, 0);
4282 #else
4283 lpath = decode_env_path (0, normal, 0);
4284 #endif
4285 if (!NILP (Vinstallation_directory))
4287 Lisp_Object tem, tem1;
4289 /* Add to the path the lisp subdir of the installation
4290 dir, if it is accessible. Note: in out-of-tree builds,
4291 this directory is empty save for Makefile. */
4292 tem = Fexpand_file_name (build_string ("lisp"),
4293 Vinstallation_directory);
4294 tem1 = Ffile_accessible_directory_p (tem);
4295 if (!NILP (tem1))
4297 if (NILP (Fmember (tem, lpath)))
4299 /* We are running uninstalled. The default load-path
4300 points to the eventual installed lisp directories.
4301 We should not use those now, even if they exist,
4302 so start over from a clean slate. */
4303 lpath = list1 (tem);
4306 else
4307 /* That dir doesn't exist, so add the build-time
4308 Lisp dirs instead. */
4310 Lisp_Object dump_path =
4311 decode_env_path (0, PATH_DUMPLOADSEARCH, 0);
4312 lpath = nconc2 (lpath, dump_path);
4315 /* Add site-lisp under the installation dir, if it exists. */
4316 if (!no_site_lisp)
4318 tem = Fexpand_file_name (build_string ("site-lisp"),
4319 Vinstallation_directory);
4320 tem1 = Ffile_accessible_directory_p (tem);
4321 if (!NILP (tem1))
4323 if (NILP (Fmember (tem, lpath)))
4324 lpath = Fcons (tem, lpath);
4328 /* If Emacs was not built in the source directory,
4329 and it is run from where it was built, add to load-path
4330 the lisp and site-lisp dirs under that directory. */
4332 if (NILP (Fequal (Vinstallation_directory, Vsource_directory)))
4334 Lisp_Object tem2;
4336 tem = Fexpand_file_name (build_string ("src/Makefile"),
4337 Vinstallation_directory);
4338 tem1 = Ffile_exists_p (tem);
4340 /* Don't be fooled if they moved the entire source tree
4341 AFTER dumping Emacs. If the build directory is indeed
4342 different from the source dir, src/Makefile.in and
4343 src/Makefile will not be found together. */
4344 tem = Fexpand_file_name (build_string ("src/Makefile.in"),
4345 Vinstallation_directory);
4346 tem2 = Ffile_exists_p (tem);
4347 if (!NILP (tem1) && NILP (tem2))
4349 tem = Fexpand_file_name (build_string ("lisp"),
4350 Vsource_directory);
4352 if (NILP (Fmember (tem, lpath)))
4353 lpath = Fcons (tem, lpath);
4355 if (!no_site_lisp)
4357 tem = Fexpand_file_name (build_string ("site-lisp"),
4358 Vsource_directory);
4359 tem1 = Ffile_accessible_directory_p (tem);
4360 if (!NILP (tem1))
4362 if (NILP (Fmember (tem, lpath)))
4363 lpath = Fcons (tem, lpath);
4367 } /* Vinstallation_directory != Vsource_directory */
4369 } /* if Vinstallation_directory */
4371 else /* !initialized */
4373 /* NORMAL refers to PATH_DUMPLOADSEARCH, ie the lisp dir in the
4374 source directory. We used to add ../lisp (ie the lisp dir in
4375 the build directory) at the front here, but that should not
4376 be necessary, since in out of tree builds lisp/ is empty, save
4377 for Makefile. */
4378 lpath = decode_env_path (0, normal, 0);
4380 #endif /* !CANNOT_DUMP */
4382 return lpath;
4385 void
4386 init_lread (void)
4388 /* First, set Vload_path. */
4390 /* Ignore EMACSLOADPATH when dumping. */
4391 #ifdef CANNOT_DUMP
4392 bool use_loadpath = true;
4393 #else
4394 bool use_loadpath = NILP (Vpurify_flag);
4395 #endif
4397 if (use_loadpath && egetenv ("EMACSLOADPATH"))
4399 Vload_path = decode_env_path ("EMACSLOADPATH", 0, 1);
4401 /* Check (non-nil) user-supplied elements. */
4402 load_path_check (Vload_path);
4404 /* If no nils in the environment variable, use as-is.
4405 Otherwise, replace any nils with the default. */
4406 if (! NILP (Fmemq (Qnil, Vload_path)))
4408 Lisp_Object elem, elpath = Vload_path;
4409 Lisp_Object default_lpath = load_path_default ();
4411 /* Check defaults, before adding site-lisp. */
4412 load_path_check (default_lpath);
4414 /* Add the site-lisp directories to the front of the default. */
4415 if (!no_site_lisp)
4417 Lisp_Object sitelisp;
4418 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH, 0);
4419 if (! NILP (sitelisp))
4420 default_lpath = nconc2 (sitelisp, default_lpath);
4423 Vload_path = Qnil;
4425 /* Replace nils from EMACSLOADPATH by default. */
4426 while (CONSP (elpath))
4428 Lisp_Object arg[2];
4429 elem = XCAR (elpath);
4430 elpath = XCDR (elpath);
4431 arg[0] = Vload_path;
4432 arg[1] = NILP (elem) ? default_lpath : Fcons (elem, Qnil);
4433 Vload_path = Fappend (2, arg);
4435 } /* Fmemq (Qnil, Vload_path) */
4437 else
4439 Vload_path = load_path_default ();
4441 /* Check before adding site-lisp directories.
4442 The install should have created them, but they are not
4443 required, so no need to warn if they are absent.
4444 Or we might be running before installation. */
4445 load_path_check (Vload_path);
4447 /* Add the site-lisp directories at the front. */
4448 if (initialized && !no_site_lisp)
4450 Lisp_Object sitelisp;
4451 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH, 0);
4452 if (! NILP (sitelisp)) Vload_path = nconc2 (sitelisp, Vload_path);
4456 Vvalues = Qnil;
4458 load_in_progress = 0;
4459 Vload_file_name = Qnil;
4460 Vstandard_input = Qt;
4461 Vloads_in_progress = Qnil;
4464 /* Print a warning that directory intended for use USE and with name
4465 DIRNAME cannot be accessed. On entry, errno should correspond to
4466 the access failure. Print the warning on stderr and put it in
4467 *Messages*. */
4469 void
4470 dir_warning (char const *use, Lisp_Object dirname)
4472 static char const format[] = "Warning: %s `%s': %s\n";
4473 int access_errno = errno;
4474 fprintf (stderr, format, use, SSDATA (dirname), strerror (access_errno));
4476 /* Don't log the warning before we've initialized!! */
4477 if (initialized)
4479 char const *diagnostic = emacs_strerror (access_errno);
4480 USE_SAFE_ALLOCA;
4481 char *buffer = SAFE_ALLOCA (sizeof format - 3 * (sizeof "%s" - 1)
4482 + strlen (use) + SBYTES (dirname)
4483 + strlen (diagnostic));
4484 ptrdiff_t message_len = esprintf (buffer, format, use, SSDATA (dirname),
4485 diagnostic);
4486 message_dolog (buffer, message_len, 0, STRING_MULTIBYTE (dirname));
4487 SAFE_FREE ();
4491 void
4492 syms_of_lread (void)
4494 defsubr (&Sread);
4495 defsubr (&Sread_from_string);
4496 defsubr (&Sintern);
4497 defsubr (&Sintern_soft);
4498 defsubr (&Sunintern);
4499 defsubr (&Sget_load_suffixes);
4500 defsubr (&Sload);
4501 defsubr (&Seval_buffer);
4502 defsubr (&Seval_region);
4503 defsubr (&Sread_char);
4504 defsubr (&Sread_char_exclusive);
4505 defsubr (&Sread_event);
4506 defsubr (&Sget_file_char);
4507 defsubr (&Smapatoms);
4508 defsubr (&Slocate_file_internal);
4510 DEFVAR_LISP ("obarray", Vobarray,
4511 doc: /* Symbol table for use by `intern' and `read'.
4512 It is a vector whose length ought to be prime for best results.
4513 The vector's contents don't make sense if examined from Lisp programs;
4514 to find all the symbols in an obarray, use `mapatoms'. */);
4516 DEFVAR_LISP ("values", Vvalues,
4517 doc: /* List of values of all expressions which were read, evaluated and printed.
4518 Order is reverse chronological. */);
4519 XSYMBOL (intern ("values"))->declared_special = 0;
4521 DEFVAR_LISP ("standard-input", Vstandard_input,
4522 doc: /* Stream for read to get input from.
4523 See documentation of `read' for possible values. */);
4524 Vstandard_input = Qt;
4526 DEFVAR_LISP ("read-with-symbol-positions", Vread_with_symbol_positions,
4527 doc: /* If non-nil, add position of read symbols to `read-symbol-positions-list'.
4529 If this variable is a buffer, then only forms read from that buffer
4530 will be added to `read-symbol-positions-list'.
4531 If this variable is t, then all read forms will be added.
4532 The effect of all other values other than nil are not currently
4533 defined, although they may be in the future.
4535 The positions are relative to the last call to `read' or
4536 `read-from-string'. It is probably a bad idea to set this variable at
4537 the toplevel; bind it instead. */);
4538 Vread_with_symbol_positions = Qnil;
4540 DEFVAR_LISP ("read-symbol-positions-list", Vread_symbol_positions_list,
4541 doc: /* A list mapping read symbols to their positions.
4542 This variable is modified during calls to `read' or
4543 `read-from-string', but only when `read-with-symbol-positions' is
4544 non-nil.
4546 Each element of the list looks like (SYMBOL . CHAR-POSITION), where
4547 CHAR-POSITION is an integer giving the offset of that occurrence of the
4548 symbol from the position where `read' or `read-from-string' started.
4550 Note that a symbol will appear multiple times in this list, if it was
4551 read multiple times. The list is in the same order as the symbols
4552 were read in. */);
4553 Vread_symbol_positions_list = Qnil;
4555 DEFVAR_LISP ("read-circle", Vread_circle,
4556 doc: /* Non-nil means read recursive structures using #N= and #N# syntax. */);
4557 Vread_circle = Qt;
4559 DEFVAR_LISP ("load-path", Vload_path,
4560 doc: /* List of directories to search for files to load.
4561 Each element is a string (directory name) or nil (meaning `default-directory').
4562 Initialized during startup as described in Info node `(elisp)Library Search'. */);
4564 DEFVAR_LISP ("load-suffixes", Vload_suffixes,
4565 doc: /* List of suffixes for (compiled or source) Emacs Lisp files.
4566 This list should not include the empty string.
4567 `load' and related functions try to append these suffixes, in order,
4568 to the specified file name if a Lisp suffix is allowed or required. */);
4569 Vload_suffixes = list2 (build_pure_c_string (".elc"),
4570 build_pure_c_string (".el"));
4571 DEFVAR_LISP ("load-file-rep-suffixes", Vload_file_rep_suffixes,
4572 doc: /* List of suffixes that indicate representations of \
4573 the same file.
4574 This list should normally start with the empty string.
4576 Enabling Auto Compression mode appends the suffixes in
4577 `jka-compr-load-suffixes' to this list and disabling Auto Compression
4578 mode removes them again. `load' and related functions use this list to
4579 determine whether they should look for compressed versions of a file
4580 and, if so, which suffixes they should try to append to the file name
4581 in order to do so. However, if you want to customize which suffixes
4582 the loading functions recognize as compression suffixes, you should
4583 customize `jka-compr-load-suffixes' rather than the present variable. */);
4584 Vload_file_rep_suffixes = list1 (empty_unibyte_string);
4586 DEFVAR_BOOL ("load-in-progress", load_in_progress,
4587 doc: /* Non-nil if inside of `load'. */);
4588 DEFSYM (Qload_in_progress, "load-in-progress");
4590 DEFVAR_LISP ("after-load-alist", Vafter_load_alist,
4591 doc: /* An alist of functions to be evalled when particular files are loaded.
4592 Each element looks like (REGEXP-OR-FEATURE FUNCS...).
4594 REGEXP-OR-FEATURE is either a regular expression to match file names, or
4595 a symbol \(a feature name).
4597 When `load' is run and the file-name argument matches an element's
4598 REGEXP-OR-FEATURE, or when `provide' is run and provides the symbol
4599 REGEXP-OR-FEATURE, the FUNCS in the element are called.
4601 An error in FORMS does not undo the load, but does prevent execution of
4602 the rest of the FORMS. */);
4603 Vafter_load_alist = Qnil;
4605 DEFVAR_LISP ("load-history", Vload_history,
4606 doc: /* Alist mapping loaded file names to symbols and features.
4607 Each alist element should be a list (FILE-NAME ENTRIES...), where
4608 FILE-NAME is the name of a file that has been loaded into Emacs.
4609 The file name is absolute and true (i.e. it doesn't contain symlinks).
4610 As an exception, one of the alist elements may have FILE-NAME nil,
4611 for symbols and features not associated with any file.
4613 The remaining ENTRIES in the alist element describe the functions and
4614 variables defined in that file, the features provided, and the
4615 features required. Each entry has the form `(provide . FEATURE)',
4616 `(require . FEATURE)', `(defun . FUNCTION)', `(autoload . SYMBOL)',
4617 `(defface . SYMBOL)', or `(t . SYMBOL)'. Entries like `(t . SYMBOL)'
4618 may precede a `(defun . FUNCTION)' entry, and means that SYMBOL was an
4619 autoload before this file redefined it as a function. In addition,
4620 entries may also be single symbols, which means that SYMBOL was
4621 defined by `defvar' or `defconst'.
4623 During preloading, the file name recorded is relative to the main Lisp
4624 directory. These file names are converted to absolute at startup. */);
4625 Vload_history = Qnil;
4627 DEFVAR_LISP ("load-file-name", Vload_file_name,
4628 doc: /* Full name of file being loaded by `load'. */);
4629 Vload_file_name = Qnil;
4631 DEFVAR_LISP ("user-init-file", Vuser_init_file,
4632 doc: /* File name, including directory, of user's initialization file.
4633 If the file loaded had extension `.elc', and the corresponding source file
4634 exists, this variable contains the name of source file, suitable for use
4635 by functions like `custom-save-all' which edit the init file.
4636 While Emacs loads and evaluates the init file, value is the real name
4637 of the file, regardless of whether or not it has the `.elc' extension. */);
4638 Vuser_init_file = Qnil;
4640 DEFVAR_LISP ("current-load-list", Vcurrent_load_list,
4641 doc: /* Used for internal purposes by `load'. */);
4642 Vcurrent_load_list = Qnil;
4644 DEFVAR_LISP ("load-read-function", Vload_read_function,
4645 doc: /* Function used by `load' and `eval-region' for reading expressions.
4646 The default is nil, which means use the function `read'. */);
4647 Vload_read_function = Qnil;
4649 DEFVAR_LISP ("load-source-file-function", Vload_source_file_function,
4650 doc: /* Function called in `load' to load an Emacs Lisp source file.
4651 The value should be a function for doing code conversion before
4652 reading a source file. It can also be nil, in which case loading is
4653 done without any code conversion.
4655 If the value is a function, it is called with four arguments,
4656 FULLNAME, FILE, NOERROR, NOMESSAGE. FULLNAME is the absolute name of
4657 the file to load, FILE is the non-absolute name (for messages etc.),
4658 and NOERROR and NOMESSAGE are the corresponding arguments passed to
4659 `load'. The function should return t if the file was loaded. */);
4660 Vload_source_file_function = Qnil;
4662 DEFVAR_BOOL ("load-force-doc-strings", load_force_doc_strings,
4663 doc: /* Non-nil means `load' should force-load all dynamic doc strings.
4664 This is useful when the file being loaded is a temporary copy. */);
4665 load_force_doc_strings = 0;
4667 DEFVAR_BOOL ("load-convert-to-unibyte", load_convert_to_unibyte,
4668 doc: /* Non-nil means `read' converts strings to unibyte whenever possible.
4669 This is normally bound by `load' and `eval-buffer' to control `read',
4670 and is not meant for users to change. */);
4671 load_convert_to_unibyte = 0;
4673 DEFVAR_LISP ("source-directory", Vsource_directory,
4674 doc: /* Directory in which Emacs sources were found when Emacs was built.
4675 You cannot count on them to still be there! */);
4676 Vsource_directory
4677 = Fexpand_file_name (build_string ("../"),
4678 Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0)));
4680 DEFVAR_LISP ("preloaded-file-list", Vpreloaded_file_list,
4681 doc: /* List of files that were preloaded (when dumping Emacs). */);
4682 Vpreloaded_file_list = Qnil;
4684 DEFVAR_LISP ("byte-boolean-vars", Vbyte_boolean_vars,
4685 doc: /* List of all DEFVAR_BOOL variables, used by the byte code optimizer. */);
4686 Vbyte_boolean_vars = Qnil;
4688 DEFVAR_BOOL ("load-dangerous-libraries", load_dangerous_libraries,
4689 doc: /* Non-nil means load dangerous compiled Lisp files.
4690 Some versions of XEmacs use different byte codes than Emacs. These
4691 incompatible byte codes can make Emacs crash when it tries to execute
4692 them. */);
4693 load_dangerous_libraries = 0;
4695 DEFVAR_BOOL ("force-load-messages", force_load_messages,
4696 doc: /* Non-nil means force printing messages when loading Lisp files.
4697 This overrides the value of the NOMESSAGE argument to `load'. */);
4698 force_load_messages = 0;
4700 DEFVAR_LISP ("bytecomp-version-regexp", Vbytecomp_version_regexp,
4701 doc: /* Regular expression matching safe to load compiled Lisp files.
4702 When Emacs loads a compiled Lisp file, it reads the first 512 bytes
4703 from the file, and matches them against this regular expression.
4704 When the regular expression matches, the file is considered to be safe
4705 to load. See also `load-dangerous-libraries'. */);
4706 Vbytecomp_version_regexp
4707 = build_pure_c_string ("^;;;.\\(in Emacs version\\|bytecomp version FSF\\)");
4709 DEFSYM (Qlexical_binding, "lexical-binding");
4710 DEFVAR_LISP ("lexical-binding", Vlexical_binding,
4711 doc: /* Whether to use lexical binding when evaluating code.
4712 Non-nil means that the code in the current buffer should be evaluated
4713 with lexical binding.
4714 This variable is automatically set from the file variables of an
4715 interpreted Lisp file read using `load'. Unlike other file local
4716 variables, this must be set in the first line of a file. */);
4717 Vlexical_binding = Qnil;
4718 Fmake_variable_buffer_local (Qlexical_binding);
4720 DEFVAR_LISP ("eval-buffer-list", Veval_buffer_list,
4721 doc: /* List of buffers being read from by calls to `eval-buffer' and `eval-region'. */);
4722 Veval_buffer_list = Qnil;
4724 DEFVAR_LISP ("old-style-backquotes", Vold_style_backquotes,
4725 doc: /* Set to non-nil when `read' encounters an old-style backquote. */);
4726 Vold_style_backquotes = Qnil;
4727 DEFSYM (Qold_style_backquotes, "old-style-backquotes");
4729 DEFVAR_BOOL ("load-prefer-newer", load_prefer_newer,
4730 doc: /* Non-nil means `load' prefers the newest version of a file.
4731 This applies when a filename suffix is not explicitly specified and
4732 `load' is trying various possible suffixes (see `load-suffixes' and
4733 `load-file-rep-suffixes'). Normally, it stops at the first file
4734 that exists unless you explicitly specify one or the other. If this
4735 option is non-nil, it checks all suffixes and uses whichever file is
4736 newest.
4737 Note that if you customize this, obviously it will not affect files
4738 that are loaded before your customizations are read! */);
4739 load_prefer_newer = 0;
4741 /* Vsource_directory was initialized in init_lread. */
4743 DEFSYM (Qcurrent_load_list, "current-load-list");
4744 DEFSYM (Qstandard_input, "standard-input");
4745 DEFSYM (Qread_char, "read-char");
4746 DEFSYM (Qget_file_char, "get-file-char");
4747 DEFSYM (Qget_emacs_mule_file_char, "get-emacs-mule-file-char");
4748 DEFSYM (Qload_force_doc_strings, "load-force-doc-strings");
4750 DEFSYM (Qbackquote, "`");
4751 DEFSYM (Qcomma, ",");
4752 DEFSYM (Qcomma_at, ",@");
4753 DEFSYM (Qcomma_dot, ",.");
4755 DEFSYM (Qinhibit_file_name_operation, "inhibit-file-name-operation");
4756 DEFSYM (Qascii_character, "ascii-character");
4757 DEFSYM (Qfunction, "function");
4758 DEFSYM (Qload, "load");
4759 DEFSYM (Qload_file_name, "load-file-name");
4760 DEFSYM (Qeval_buffer_list, "eval-buffer-list");
4761 DEFSYM (Qfile_truename, "file-truename");
4762 DEFSYM (Qdir_ok, "dir-ok");
4763 DEFSYM (Qdo_after_load_evaluation, "do-after-load-evaluation");
4765 staticpro (&read_objects);
4766 read_objects = Qnil;
4767 staticpro (&seen_list);
4768 seen_list = Qnil;
4770 Vloads_in_progress = Qnil;
4771 staticpro (&Vloads_in_progress);
4773 DEFSYM (Qhash_table, "hash-table");
4774 DEFSYM (Qdata, "data");
4775 DEFSYM (Qtest, "test");
4776 DEFSYM (Qsize, "size");
4777 DEFSYM (Qweakness, "weakness");
4778 DEFSYM (Qrehash_size, "rehash-size");
4779 DEFSYM (Qrehash_threshold, "rehash-threshold");