Fix races with threads and file descriptors.
[bpt/emacs.git] / src / lread.c
1 /* Lisp parsing and input streams.
2
3 Copyright (C) 1985-1989, 1993-1995, 1997-2013 Free Software Foundation,
4 Inc.
5
6 This file is part of GNU Emacs.
7
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.
12
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.
17
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/>. */
20
21
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"
42
43 #ifdef MSDOS
44 #include "msdos.h"
45 #endif
46
47 #ifdef HAVE_NS
48 #include "nsterm.h"
49 #endif
50
51 #include <unistd.h>
52
53 #ifdef HAVE_SETLOCALE
54 #include <locale.h>
55 #endif /* HAVE_SETLOCALE */
56
57 #include <fcntl.h>
58
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
66
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;
73
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 */
83
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;
87
88 static Lisp_Object Qload_force_doc_strings;
89
90 static Lisp_Object Qload_in_progress;
91
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;
97
98 /* File for get_file_char to read from. Use by load. */
99 static FILE *instream;
100
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;
105
106 /* Number of characters read in the current call to Fread or
107 Fread_from_string. */
108 static EMACS_INT readchar_count;
109
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;
118
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;
129
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;
136
137 /* A list of file names for files being loaded in Fload. Used to
138 check for recursive loads. */
139
140 static Lisp_Object Vloads_in_progress;
141
142 static int read_emacs_mule_char (int, int (*) (int, Lisp_Object),
143 Lisp_Object);
144
145 static void readevalloop (Lisp_Object, FILE *, Lisp_Object, bool,
146 Lisp_Object, Lisp_Object,
147 Lisp_Object, Lisp_Object);
148 static Lisp_Object load_unwind (Lisp_Object);
149 \f
150 /* Functions that read one byte from the current source READCHARFUN
151 or unreads one byte. If the integer argument C is -1, it returns
152 one read byte, or -1 when there's no more byte in the source. If C
153 is 0 or positive, it unreads C, and the return value is not
154 interesting. */
155
156 static int readbyte_for_lambda (int, Lisp_Object);
157 static int readbyte_from_file (int, Lisp_Object);
158 static int readbyte_from_string (int, Lisp_Object);
159
160 /* Handle unreading and rereading of characters.
161 Write READCHAR to read a character,
162 UNREAD(c) to unread c to be read again.
163
164 These macros correctly read/unread multibyte characters. */
165
166 #define READCHAR readchar (readcharfun, NULL)
167 #define UNREAD(c) unreadchar (readcharfun, c)
168
169 /* Same as READCHAR but set *MULTIBYTE to the multibyteness of the source. */
170 #define READCHAR_REPORT_MULTIBYTE(multibyte) readchar (readcharfun, multibyte)
171
172 /* When READCHARFUN is Qget_file_char, Qget_emacs_mule_file_char,
173 Qlambda, or a cons, we use this to keep an unread character because
174 a file stream can't handle multibyte-char unreading. The value -1
175 means that there's no unread character. */
176 static int unread_char;
177
178 static int
179 readchar (Lisp_Object readcharfun, bool *multibyte)
180 {
181 Lisp_Object tem;
182 register int c;
183 int (*readbyte) (int, Lisp_Object);
184 unsigned char buf[MAX_MULTIBYTE_LENGTH];
185 int i, len;
186 bool emacs_mule_encoding = 0;
187
188 if (multibyte)
189 *multibyte = 0;
190
191 readchar_count++;
192
193 if (BUFFERP (readcharfun))
194 {
195 register struct buffer *inbuffer = XBUFFER (readcharfun);
196
197 ptrdiff_t pt_byte = BUF_PT_BYTE (inbuffer);
198
199 if (! BUFFER_LIVE_P (inbuffer))
200 return -1;
201
202 if (pt_byte >= BUF_ZV_BYTE (inbuffer))
203 return -1;
204
205 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
206 {
207 /* Fetch the character code from the buffer. */
208 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, pt_byte);
209 BUF_INC_POS (inbuffer, pt_byte);
210 c = STRING_CHAR (p);
211 if (multibyte)
212 *multibyte = 1;
213 }
214 else
215 {
216 c = BUF_FETCH_BYTE (inbuffer, pt_byte);
217 if (! ASCII_BYTE_P (c))
218 c = BYTE8_TO_CHAR (c);
219 pt_byte++;
220 }
221 SET_BUF_PT_BOTH (inbuffer, BUF_PT (inbuffer) + 1, pt_byte);
222
223 return c;
224 }
225 if (MARKERP (readcharfun))
226 {
227 register struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
228
229 ptrdiff_t bytepos = marker_byte_position (readcharfun);
230
231 if (bytepos >= BUF_ZV_BYTE (inbuffer))
232 return -1;
233
234 if (! NILP (BVAR (inbuffer, enable_multibyte_characters)))
235 {
236 /* Fetch the character code from the buffer. */
237 unsigned char *p = BUF_BYTE_ADDRESS (inbuffer, bytepos);
238 BUF_INC_POS (inbuffer, bytepos);
239 c = STRING_CHAR (p);
240 if (multibyte)
241 *multibyte = 1;
242 }
243 else
244 {
245 c = BUF_FETCH_BYTE (inbuffer, bytepos);
246 if (! ASCII_BYTE_P (c))
247 c = BYTE8_TO_CHAR (c);
248 bytepos++;
249 }
250
251 XMARKER (readcharfun)->bytepos = bytepos;
252 XMARKER (readcharfun)->charpos++;
253
254 return c;
255 }
256
257 if (EQ (readcharfun, Qlambda))
258 {
259 readbyte = readbyte_for_lambda;
260 goto read_multibyte;
261 }
262
263 if (EQ (readcharfun, Qget_file_char))
264 {
265 readbyte = readbyte_from_file;
266 goto read_multibyte;
267 }
268
269 if (STRINGP (readcharfun))
270 {
271 if (read_from_string_index >= read_from_string_limit)
272 c = -1;
273 else if (STRING_MULTIBYTE (readcharfun))
274 {
275 if (multibyte)
276 *multibyte = 1;
277 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, readcharfun,
278 read_from_string_index,
279 read_from_string_index_byte);
280 }
281 else
282 {
283 c = SREF (readcharfun, read_from_string_index_byte);
284 read_from_string_index++;
285 read_from_string_index_byte++;
286 }
287 return c;
288 }
289
290 if (CONSP (readcharfun))
291 {
292 /* This is the case that read_vector is reading from a unibyte
293 string that contains a byte sequence previously skipped
294 because of #@NUMBER. The car part of readcharfun is that
295 string, and the cdr part is a value of readcharfun given to
296 read_vector. */
297 readbyte = readbyte_from_string;
298 if (EQ (XCDR (readcharfun), Qget_emacs_mule_file_char))
299 emacs_mule_encoding = 1;
300 goto read_multibyte;
301 }
302
303 if (EQ (readcharfun, Qget_emacs_mule_file_char))
304 {
305 readbyte = readbyte_from_file;
306 emacs_mule_encoding = 1;
307 goto read_multibyte;
308 }
309
310 tem = call0 (readcharfun);
311
312 if (NILP (tem))
313 return -1;
314 return XINT (tem);
315
316 read_multibyte:
317 if (unread_char >= 0)
318 {
319 c = unread_char;
320 unread_char = -1;
321 return c;
322 }
323 c = (*readbyte) (-1, readcharfun);
324 if (c < 0)
325 return c;
326 if (multibyte)
327 *multibyte = 1;
328 if (ASCII_BYTE_P (c))
329 return c;
330 if (emacs_mule_encoding)
331 return read_emacs_mule_char (c, readbyte, readcharfun);
332 i = 0;
333 buf[i++] = c;
334 len = BYTES_BY_CHAR_HEAD (c);
335 while (i < len)
336 {
337 c = (*readbyte) (-1, readcharfun);
338 if (c < 0 || ! TRAILING_CODE_P (c))
339 {
340 while (--i > 1)
341 (*readbyte) (buf[i], readcharfun);
342 return BYTE8_TO_CHAR (buf[0]);
343 }
344 buf[i++] = c;
345 }
346 return STRING_CHAR (buf);
347 }
348
349 #define FROM_FILE_P(readcharfun) \
350 (EQ (readcharfun, Qget_file_char) \
351 || EQ (readcharfun, Qget_emacs_mule_file_char))
352
353 static void
354 skip_dyn_bytes (Lisp_Object readcharfun, ptrdiff_t n)
355 {
356 if (FROM_FILE_P (readcharfun))
357 {
358 block_input (); /* FIXME: Not sure if it's needed. */
359 fseek (instream, n, SEEK_CUR);
360 unblock_input ();
361 }
362 else
363 { /* We're not reading directly from a file. In that case, it's difficult
364 to reliably count bytes, since these are usually meant for the file's
365 encoding, whereas we're now typically in the internal encoding.
366 But luckily, skip_dyn_bytes is used to skip over a single
367 dynamic-docstring (or dynamic byte-code) which is always quoted such
368 that \037 is the final char. */
369 int c;
370 do {
371 c = READCHAR;
372 } while (c >= 0 && c != '\037');
373 }
374 }
375
376 static void
377 skip_dyn_eof (Lisp_Object readcharfun)
378 {
379 if (FROM_FILE_P (readcharfun))
380 {
381 block_input (); /* FIXME: Not sure if it's needed. */
382 fseek (instream, 0, SEEK_END);
383 unblock_input ();
384 }
385 else
386 while (READCHAR >= 0);
387 }
388
389 /* Unread the character C in the way appropriate for the stream READCHARFUN.
390 If the stream is a user function, call it with the char as argument. */
391
392 static void
393 unreadchar (Lisp_Object readcharfun, int c)
394 {
395 readchar_count--;
396 if (c == -1)
397 /* Don't back up the pointer if we're unreading the end-of-input mark,
398 since readchar didn't advance it when we read it. */
399 ;
400 else if (BUFFERP (readcharfun))
401 {
402 struct buffer *b = XBUFFER (readcharfun);
403 ptrdiff_t charpos = BUF_PT (b);
404 ptrdiff_t bytepos = BUF_PT_BYTE (b);
405
406 if (! NILP (BVAR (b, enable_multibyte_characters)))
407 BUF_DEC_POS (b, bytepos);
408 else
409 bytepos--;
410
411 SET_BUF_PT_BOTH (b, charpos - 1, bytepos);
412 }
413 else if (MARKERP (readcharfun))
414 {
415 struct buffer *b = XMARKER (readcharfun)->buffer;
416 ptrdiff_t bytepos = XMARKER (readcharfun)->bytepos;
417
418 XMARKER (readcharfun)->charpos--;
419 if (! NILP (BVAR (b, enable_multibyte_characters)))
420 BUF_DEC_POS (b, bytepos);
421 else
422 bytepos--;
423
424 XMARKER (readcharfun)->bytepos = bytepos;
425 }
426 else if (STRINGP (readcharfun))
427 {
428 read_from_string_index--;
429 read_from_string_index_byte
430 = string_char_to_byte (readcharfun, read_from_string_index);
431 }
432 else if (CONSP (readcharfun))
433 {
434 unread_char = c;
435 }
436 else if (EQ (readcharfun, Qlambda))
437 {
438 unread_char = c;
439 }
440 else if (FROM_FILE_P (readcharfun))
441 {
442 unread_char = c;
443 }
444 else
445 call1 (readcharfun, make_number (c));
446 }
447
448 static int
449 readbyte_for_lambda (int c, Lisp_Object readcharfun)
450 {
451 return read_bytecode_char (c >= 0);
452 }
453
454
455 static int
456 readbyte_from_file (int c, Lisp_Object readcharfun)
457 {
458 if (c >= 0)
459 {
460 block_input ();
461 ungetc (c, instream);
462 unblock_input ();
463 return 0;
464 }
465
466 block_input ();
467 c = getc (instream);
468
469 /* Interrupted reads have been observed while reading over the network. */
470 while (c == EOF && ferror (instream) && errno == EINTR)
471 {
472 unblock_input ();
473 QUIT;
474 block_input ();
475 clearerr (instream);
476 c = getc (instream);
477 }
478
479 unblock_input ();
480
481 return (c == EOF ? -1 : c);
482 }
483
484 static int
485 readbyte_from_string (int c, Lisp_Object readcharfun)
486 {
487 Lisp_Object string = XCAR (readcharfun);
488
489 if (c >= 0)
490 {
491 read_from_string_index--;
492 read_from_string_index_byte
493 = string_char_to_byte (string, read_from_string_index);
494 }
495
496 if (read_from_string_index >= read_from_string_limit)
497 c = -1;
498 else
499 FETCH_STRING_CHAR_ADVANCE (c, string,
500 read_from_string_index,
501 read_from_string_index_byte);
502 return c;
503 }
504
505
506 /* Read one non-ASCII character from INSTREAM. The character is
507 encoded in `emacs-mule' and the first byte is already read in
508 C. */
509
510 static int
511 read_emacs_mule_char (int c, int (*readbyte) (int, Lisp_Object), Lisp_Object readcharfun)
512 {
513 /* Emacs-mule coding uses at most 4-byte for one character. */
514 unsigned char buf[4];
515 int len = emacs_mule_bytes[c];
516 struct charset *charset;
517 int i;
518 unsigned code;
519
520 if (len == 1)
521 /* C is not a valid leading-code of `emacs-mule'. */
522 return BYTE8_TO_CHAR (c);
523
524 i = 0;
525 buf[i++] = c;
526 while (i < len)
527 {
528 c = (*readbyte) (-1, readcharfun);
529 if (c < 0xA0)
530 {
531 while (--i > 1)
532 (*readbyte) (buf[i], readcharfun);
533 return BYTE8_TO_CHAR (buf[0]);
534 }
535 buf[i++] = c;
536 }
537
538 if (len == 2)
539 {
540 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
541 code = buf[1] & 0x7F;
542 }
543 else if (len == 3)
544 {
545 if (buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_11
546 || buf[0] == EMACS_MULE_LEADING_CODE_PRIVATE_12)
547 {
548 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
549 code = buf[2] & 0x7F;
550 }
551 else
552 {
553 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[0]]);
554 code = ((buf[1] << 8) | buf[2]) & 0x7F7F;
555 }
556 }
557 else
558 {
559 charset = CHARSET_FROM_ID (emacs_mule_charset[buf[1]]);
560 code = ((buf[2] << 8) | buf[3]) & 0x7F7F;
561 }
562 c = DECODE_CHAR (charset, code);
563 if (c < 0)
564 Fsignal (Qinvalid_read_syntax,
565 Fcons (build_string ("invalid multibyte form"), Qnil));
566 return c;
567 }
568
569
570 static Lisp_Object read_internal_start (Lisp_Object, Lisp_Object,
571 Lisp_Object);
572 static Lisp_Object read0 (Lisp_Object);
573 static Lisp_Object read1 (Lisp_Object, int *, bool);
574
575 static Lisp_Object read_list (bool, Lisp_Object);
576 static Lisp_Object read_vector (Lisp_Object, bool);
577
578 static Lisp_Object substitute_object_recurse (Lisp_Object, Lisp_Object,
579 Lisp_Object);
580 static void substitute_object_in_subtree (Lisp_Object,
581 Lisp_Object);
582 static void substitute_in_interval (INTERVAL, Lisp_Object);
583
584 \f
585 /* Get a character from the tty. */
586
587 /* Read input events until we get one that's acceptable for our purposes.
588
589 If NO_SWITCH_FRAME, switch-frame events are stashed
590 until we get a character we like, and then stuffed into
591 unread_switch_frame.
592
593 If ASCII_REQUIRED, check function key events to see
594 if the unmodified version of the symbol has a Qascii_character
595 property, and use that character, if present.
596
597 If ERROR_NONASCII, signal an error if the input we
598 get isn't an ASCII character with modifiers. If it's false but
599 ASCII_REQUIRED is true, just re-read until we get an ASCII
600 character.
601
602 If INPUT_METHOD, invoke the current input method
603 if the character warrants that.
604
605 If SECONDS is a number, wait that many seconds for input, and
606 return Qnil if no input arrives within that time. */
607
608 static Lisp_Object
609 read_filtered_event (bool no_switch_frame, bool ascii_required,
610 bool error_nonascii, bool input_method, Lisp_Object seconds)
611 {
612 Lisp_Object val, delayed_switch_frame;
613 EMACS_TIME end_time;
614
615 #ifdef HAVE_WINDOW_SYSTEM
616 if (display_hourglass_p)
617 cancel_hourglass ();
618 #endif
619
620 delayed_switch_frame = Qnil;
621
622 /* Compute timeout. */
623 if (NUMBERP (seconds))
624 {
625 double duration = extract_float (seconds);
626 EMACS_TIME wait_time = EMACS_TIME_FROM_DOUBLE (duration);
627 end_time = add_emacs_time (current_emacs_time (), wait_time);
628 }
629
630 /* Read until we get an acceptable event. */
631 retry:
632 do
633 val = read_char (0, Qnil, (input_method ? Qnil : Qt), 0,
634 NUMBERP (seconds) ? &end_time : NULL);
635 while (INTEGERP (val) && XINT (val) == -2); /* wrong_kboard_jmpbuf */
636
637 if (BUFFERP (val))
638 goto retry;
639
640 /* `switch-frame' events are put off until after the next ASCII
641 character. This is better than signaling an error just because
642 the last characters were typed to a separate minibuffer frame,
643 for example. Eventually, some code which can deal with
644 switch-frame events will read it and process it. */
645 if (no_switch_frame
646 && EVENT_HAS_PARAMETERS (val)
647 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (val)), Qswitch_frame))
648 {
649 delayed_switch_frame = val;
650 goto retry;
651 }
652
653 if (ascii_required && !(NUMBERP (seconds) && NILP (val)))
654 {
655 /* Convert certain symbols to their ASCII equivalents. */
656 if (SYMBOLP (val))
657 {
658 Lisp_Object tem, tem1;
659 tem = Fget (val, Qevent_symbol_element_mask);
660 if (!NILP (tem))
661 {
662 tem1 = Fget (Fcar (tem), Qascii_character);
663 /* Merge this symbol's modifier bits
664 with the ASCII equivalent of its basic code. */
665 if (!NILP (tem1))
666 XSETFASTINT (val, XINT (tem1) | XINT (Fcar (Fcdr (tem))));
667 }
668 }
669
670 /* If we don't have a character now, deal with it appropriately. */
671 if (!INTEGERP (val))
672 {
673 if (error_nonascii)
674 {
675 Vunread_command_events = Fcons (val, Qnil);
676 error ("Non-character input-event");
677 }
678 else
679 goto retry;
680 }
681 }
682
683 if (! NILP (delayed_switch_frame))
684 unread_switch_frame = delayed_switch_frame;
685
686 #if 0
687
688 #ifdef HAVE_WINDOW_SYSTEM
689 if (display_hourglass_p)
690 start_hourglass ();
691 #endif
692
693 #endif
694
695 return val;
696 }
697
698 DEFUN ("read-char", Fread_char, Sread_char, 0, 3, 0,
699 doc: /* Read a character from the command input (keyboard or macro).
700 It is returned as a number.
701 If the character has modifiers, they are resolved and reflected to the
702 character code if possible (e.g. C-SPC -> 0).
703
704 If the user generates an event which is not a character (i.e. a mouse
705 click or function key event), `read-char' signals an error. As an
706 exception, switch-frame events are put off until non-character events
707 can be read.
708 If you want to read non-character events, or ignore them, call
709 `read-event' or `read-char-exclusive' instead.
710
711 If the optional argument PROMPT is non-nil, display that as a prompt.
712 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
713 input method is turned on in the current buffer, that input method
714 is used for reading a character.
715 If the optional argument SECONDS is non-nil, it should be a number
716 specifying the maximum number of seconds to wait for input. If no
717 input arrives in that time, return nil. SECONDS may be a
718 floating-point value. */)
719 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
720 {
721 Lisp_Object val;
722
723 if (! NILP (prompt))
724 message_with_string ("%s", prompt, 0);
725 val = read_filtered_event (1, 1, 1, ! NILP (inherit_input_method), seconds);
726
727 return (NILP (val) ? Qnil
728 : make_number (char_resolve_modifier_mask (XINT (val))));
729 }
730
731 DEFUN ("read-event", Fread_event, Sread_event, 0, 3, 0,
732 doc: /* Read an event object from the input stream.
733 If the optional argument PROMPT is non-nil, display that as a prompt.
734 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
735 input method is turned on in the current buffer, that input method
736 is used for reading a character.
737 If the optional argument SECONDS is non-nil, it should be a number
738 specifying the maximum number of seconds to wait for input. If no
739 input arrives in that time, return nil. SECONDS may be a
740 floating-point value. */)
741 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
742 {
743 if (! NILP (prompt))
744 message_with_string ("%s", prompt, 0);
745 return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method), seconds);
746 }
747
748 DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 3, 0,
749 doc: /* Read a character from the command input (keyboard or macro).
750 It is returned as a number. Non-character events are ignored.
751 If the character has modifiers, they are resolved and reflected to the
752 character code if possible (e.g. C-SPC -> 0).
753
754 If the optional argument PROMPT is non-nil, display that as a prompt.
755 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
756 input method is turned on in the current buffer, that input method
757 is used for reading a character.
758 If the optional argument SECONDS is non-nil, it should be a number
759 specifying the maximum number of seconds to wait for input. If no
760 input arrives in that time, return nil. SECONDS may be a
761 floating-point value. */)
762 (Lisp_Object prompt, Lisp_Object inherit_input_method, Lisp_Object seconds)
763 {
764 Lisp_Object val;
765
766 if (! NILP (prompt))
767 message_with_string ("%s", prompt, 0);
768
769 val = read_filtered_event (1, 1, 0, ! NILP (inherit_input_method), seconds);
770
771 return (NILP (val) ? Qnil
772 : make_number (char_resolve_modifier_mask (XINT (val))));
773 }
774
775 DEFUN ("get-file-char", Fget_file_char, Sget_file_char, 0, 0, 0,
776 doc: /* Don't use this yourself. */)
777 (void)
778 {
779 register Lisp_Object val;
780 block_input ();
781 XSETINT (val, getc (instream));
782 unblock_input ();
783 return val;
784 }
785
786
787 \f
788
789 /* Return true if the lisp code read using READCHARFUN defines a non-nil
790 `lexical-binding' file variable. After returning, the stream is
791 positioned following the first line, if it is a comment or #! line,
792 otherwise nothing is read. */
793
794 static bool
795 lisp_file_lexically_bound_p (Lisp_Object readcharfun)
796 {
797 int ch = READCHAR;
798
799 if (ch == '#')
800 {
801 ch = READCHAR;
802 if (ch != '!')
803 {
804 UNREAD (ch);
805 UNREAD ('#');
806 return 0;
807 }
808 while (ch != '\n' && ch != EOF)
809 ch = READCHAR;
810 if (ch == '\n') ch = READCHAR;
811 /* It is OK to leave the position after a #! line, since
812 that is what read1 does. */
813 }
814
815 if (ch != ';')
816 /* The first line isn't a comment, just give up. */
817 {
818 UNREAD (ch);
819 return 0;
820 }
821 else
822 /* Look for an appropriate file-variable in the first line. */
823 {
824 bool rv = 0;
825 enum {
826 NOMINAL, AFTER_FIRST_DASH, AFTER_ASTERIX
827 } beg_end_state = NOMINAL;
828 bool in_file_vars = 0;
829
830 #define UPDATE_BEG_END_STATE(ch) \
831 if (beg_end_state == NOMINAL) \
832 beg_end_state = (ch == '-' ? AFTER_FIRST_DASH : NOMINAL); \
833 else if (beg_end_state == AFTER_FIRST_DASH) \
834 beg_end_state = (ch == '*' ? AFTER_ASTERIX : NOMINAL); \
835 else if (beg_end_state == AFTER_ASTERIX) \
836 { \
837 if (ch == '-') \
838 in_file_vars = !in_file_vars; \
839 beg_end_state = NOMINAL; \
840 }
841
842 /* Skip until we get to the file vars, if any. */
843 do
844 {
845 ch = READCHAR;
846 UPDATE_BEG_END_STATE (ch);
847 }
848 while (!in_file_vars && ch != '\n' && ch != EOF);
849
850 while (in_file_vars)
851 {
852 char var[100], val[100];
853 unsigned i;
854
855 ch = READCHAR;
856
857 /* Read a variable name. */
858 while (ch == ' ' || ch == '\t')
859 ch = READCHAR;
860
861 i = 0;
862 while (ch != ':' && ch != '\n' && ch != EOF && in_file_vars)
863 {
864 if (i < sizeof var - 1)
865 var[i++] = ch;
866 UPDATE_BEG_END_STATE (ch);
867 ch = READCHAR;
868 }
869
870 /* Stop scanning if no colon was found before end marker. */
871 if (!in_file_vars || ch == '\n' || ch == EOF)
872 break;
873
874 while (i > 0 && (var[i - 1] == ' ' || var[i - 1] == '\t'))
875 i--;
876 var[i] = '\0';
877
878 if (ch == ':')
879 {
880 /* Read a variable value. */
881 ch = READCHAR;
882
883 while (ch == ' ' || ch == '\t')
884 ch = READCHAR;
885
886 i = 0;
887 while (ch != ';' && ch != '\n' && ch != EOF && in_file_vars)
888 {
889 if (i < sizeof val - 1)
890 val[i++] = ch;
891 UPDATE_BEG_END_STATE (ch);
892 ch = READCHAR;
893 }
894 if (! in_file_vars)
895 /* The value was terminated by an end-marker, which remove. */
896 i -= 3;
897 while (i > 0 && (val[i - 1] == ' ' || val[i - 1] == '\t'))
898 i--;
899 val[i] = '\0';
900
901 if (strcmp (var, "lexical-binding") == 0)
902 /* This is it... */
903 {
904 rv = (strcmp (val, "nil") != 0);
905 break;
906 }
907 }
908 }
909
910 while (ch != '\n' && ch != EOF)
911 ch = READCHAR;
912
913 return rv;
914 }
915 }
916 \f
917 /* Value is a version number of byte compiled code if the file
918 associated with file descriptor FD is a compiled Lisp file that's
919 safe to load. Only files compiled with Emacs are safe to load.
920 Files compiled with XEmacs can lead to a crash in Fbyte_code
921 because of an incompatible change in the byte compiler. */
922
923 static int
924 safe_to_load_version (int fd)
925 {
926 char buf[512];
927 int nbytes, i;
928 int version = 1;
929
930 /* Read the first few bytes from the file, and look for a line
931 specifying the byte compiler version used. */
932 nbytes = emacs_read (fd, buf, sizeof buf);
933 if (nbytes > 0)
934 {
935 /* Skip to the next newline, skipping over the initial `ELC'
936 with NUL bytes following it, but note the version. */
937 for (i = 0; i < nbytes && buf[i] != '\n'; ++i)
938 if (i == 4)
939 version = buf[i];
940
941 if (i >= nbytes
942 || fast_c_string_match_ignore_case (Vbytecomp_version_regexp,
943 buf + i, nbytes - i) < 0)
944 version = 0;
945 }
946
947 lseek (fd, 0, SEEK_SET);
948 return version;
949 }
950
951
952 /* Callback for record_unwind_protect. Restore the old load list OLD,
953 after loading a file successfully. */
954
955 static Lisp_Object
956 record_load_unwind (Lisp_Object old)
957 {
958 return Vloads_in_progress = old;
959 }
960
961 /* This handler function is used via internal_condition_case_1. */
962
963 static Lisp_Object
964 load_error_handler (Lisp_Object data)
965 {
966 return Qnil;
967 }
968
969 static Lisp_Object
970 load_warn_old_style_backquotes (Lisp_Object file)
971 {
972 if (!NILP (Vold_style_backquotes))
973 {
974 Lisp_Object args[2];
975 args[0] = build_string ("Loading `%s': old-style backquotes detected!");
976 args[1] = file;
977 Fmessage (2, args);
978 }
979 return Qnil;
980 }
981
982 DEFUN ("get-load-suffixes", Fget_load_suffixes, Sget_load_suffixes, 0, 0, 0,
983 doc: /* Return the suffixes that `load' should try if a suffix is \
984 required.
985 This uses the variables `load-suffixes' and `load-file-rep-suffixes'. */)
986 (void)
987 {
988 Lisp_Object lst = Qnil, suffixes = Vload_suffixes, suffix, ext;
989 while (CONSP (suffixes))
990 {
991 Lisp_Object exts = Vload_file_rep_suffixes;
992 suffix = XCAR (suffixes);
993 suffixes = XCDR (suffixes);
994 while (CONSP (exts))
995 {
996 ext = XCAR (exts);
997 exts = XCDR (exts);
998 lst = Fcons (concat2 (suffix, ext), lst);
999 }
1000 }
1001 return Fnreverse (lst);
1002 }
1003
1004 DEFUN ("load", Fload, Sload, 1, 5, 0,
1005 doc: /* Execute a file of Lisp code named FILE.
1006 First try FILE with `.elc' appended, then try with `.el',
1007 then try FILE unmodified (the exact suffixes in the exact order are
1008 determined by `load-suffixes'). Environment variable references in
1009 FILE are replaced with their values by calling `substitute-in-file-name'.
1010 This function searches the directories in `load-path'.
1011
1012 If optional second arg NOERROR is non-nil,
1013 report no error if FILE doesn't exist.
1014 Print messages at start and end of loading unless
1015 optional third arg NOMESSAGE is non-nil (but `force-load-messages'
1016 overrides that).
1017 If optional fourth arg NOSUFFIX is non-nil, don't try adding
1018 suffixes `.elc' or `.el' to the specified name FILE.
1019 If optional fifth arg MUST-SUFFIX is non-nil, insist on
1020 the suffix `.elc' or `.el'; don't accept just FILE unless
1021 it ends in one of those suffixes or includes a directory name.
1022
1023 If NOSUFFIX is nil, then if a file could not be found, try looking for
1024 a different representation of the file by adding non-empty suffixes to
1025 its name, before trying another file. Emacs uses this feature to find
1026 compressed versions of files when Auto Compression mode is enabled.
1027 If NOSUFFIX is non-nil, disable this feature.
1028
1029 The suffixes that this function tries out, when NOSUFFIX is nil, are
1030 given by the return value of `get-load-suffixes' and the values listed
1031 in `load-file-rep-suffixes'. If MUST-SUFFIX is non-nil, only the
1032 return value of `get-load-suffixes' is used, i.e. the file name is
1033 required to have a non-empty suffix.
1034
1035 Loading a file records its definitions, and its `provide' and
1036 `require' calls, in an element of `load-history' whose
1037 car is the file name loaded. See `load-history'.
1038
1039 While the file is in the process of being loaded, the variable
1040 `load-in-progress' is non-nil and the variable `load-file-name'
1041 is bound to the file's name.
1042
1043 Return t if the file exists and loads successfully. */)
1044 (Lisp_Object file, Lisp_Object noerror, Lisp_Object nomessage, Lisp_Object nosuffix, Lisp_Object must_suffix)
1045 {
1046 register FILE *stream;
1047 register int fd = -1;
1048 ptrdiff_t count = SPECPDL_INDEX ();
1049 struct gcpro gcpro1, gcpro2, gcpro3;
1050 Lisp_Object found, efound, hist_file_name;
1051 /* True means we printed the ".el is newer" message. */
1052 bool newer = 0;
1053 /* True means we are loading a compiled file. */
1054 bool compiled = 0;
1055 Lisp_Object handler;
1056 bool safe_p = 1;
1057 const char *fmode = "r";
1058 Lisp_Object tmp[2];
1059 int version;
1060
1061 #ifdef DOS_NT
1062 fmode = "rt";
1063 #endif /* DOS_NT */
1064
1065 CHECK_STRING (file);
1066
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); */
1072
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))
1082 {
1083 file = internal_condition_case_1 (Fsubstitute_in_file_name, file,
1084 Qt, load_error_handler);
1085 if (NILP (file))
1086 return Qnil;
1087 }
1088 else
1089 file = Fsubstitute_in_file_name (file);
1090
1091
1092 /* Avoid weird lossage with null string as arg,
1093 since it would try to load a directory as a Lisp file. */
1094 if (SBYTES (file) > 0)
1095 {
1096 ptrdiff_t size = SBYTES (file);
1097
1098 found = Qnil;
1099 GCPRO2 (file, found);
1100
1101 if (! NILP (must_suffix))
1102 {
1103 /* Don't insist on adding a suffix if FILE already ends with one. */
1104 if (size > 3
1105 && !strcmp (SSDATA (file) + size - 3, ".el"))
1106 must_suffix = Qnil;
1107 else if (size > 4
1108 && !strcmp (SSDATA (file) + size - 4, ".elc"))
1109 must_suffix = Qnil;
1110 /* Don't insist on adding a suffix
1111 if the argument includes a directory name. */
1112 else if (! NILP (Ffile_name_directory (file)))
1113 must_suffix = Qnil;
1114 }
1115
1116 fd = openp (Vload_path, file,
1117 (!NILP (nosuffix) ? Qnil
1118 : !NILP (must_suffix) ? Fget_load_suffixes ()
1119 : Fappend (2, (tmp[0] = Fget_load_suffixes (),
1120 tmp[1] = Vload_file_rep_suffixes,
1121 tmp))),
1122 &found, Qnil);
1123 UNGCPRO;
1124 }
1125
1126 if (fd == -1)
1127 {
1128 if (NILP (noerror))
1129 xsignal2 (Qfile_error, build_string ("Cannot open load file"), file);
1130 return Qnil;
1131 }
1132
1133 /* Tell startup.el whether or not we found the user's init file. */
1134 if (EQ (Qt, Vuser_init_file))
1135 Vuser_init_file = found;
1136
1137 /* If FD is -2, that means openp found a magic file. */
1138 if (fd == -2)
1139 {
1140 if (NILP (Fequal (found, file)))
1141 /* If FOUND is a different file name from FILE,
1142 find its handler even if we have already inhibited
1143 the `load' operation on FILE. */
1144 handler = Ffind_file_name_handler (found, Qt);
1145 else
1146 handler = Ffind_file_name_handler (found, Qload);
1147 if (! NILP (handler))
1148 return call5 (handler, Qload, found, noerror, nomessage, Qt);
1149 #ifdef DOS_NT
1150 /* Tramp has to deal with semi-broken packages that prepend
1151 drive letters to remote files. For that reason, Tramp
1152 catches file operations that test for file existence, which
1153 makes openp think X:/foo.elc files are remote. However,
1154 Tramp does not catch `load' operations for such files, so we
1155 end up with a nil as the `load' handler above. If we would
1156 continue with fd = -2, we will behave wrongly, and in
1157 particular try reading a .elc file in the "rt" mode instead
1158 of "rb". See bug #9311 for the results. To work around
1159 this, we try to open the file locally, and go with that if it
1160 succeeds. */
1161 fd = emacs_open (SSDATA (ENCODE_FILE (found)), O_RDONLY, 0);
1162 if (fd == -1)
1163 fd = -2;
1164 #endif
1165 }
1166
1167 /* Check if we're stuck in a recursive load cycle.
1168
1169 2000-09-21: It's not possible to just check for the file loaded
1170 being a member of Vloads_in_progress. This fails because of the
1171 way the byte compiler currently works; `provide's are not
1172 evaluated, see font-lock.el/jit-lock.el as an example. This
1173 leads to a certain amount of ``normal'' recursion.
1174
1175 Also, just loading a file recursively is not always an error in
1176 the general case; the second load may do something different. */
1177 {
1178 int load_count = 0;
1179 Lisp_Object tem;
1180 for (tem = Vloads_in_progress; CONSP (tem); tem = XCDR (tem))
1181 if (!NILP (Fequal (found, XCAR (tem))) && (++load_count > 3))
1182 {
1183 if (fd >= 0)
1184 emacs_close (fd);
1185 signal_error ("Recursive load", Fcons (found, Vloads_in_progress));
1186 }
1187 record_unwind_protect (record_load_unwind, Vloads_in_progress);
1188 Vloads_in_progress = Fcons (found, Vloads_in_progress);
1189 }
1190
1191 /* All loads are by default dynamic, unless the file itself specifies
1192 otherwise using a file-variable in the first line. This is bound here
1193 so that it takes effect whether or not we use
1194 Vload_source_file_function. */
1195 specbind (Qlexical_binding, Qnil);
1196
1197 /* Get the name for load-history. */
1198 hist_file_name = (! NILP (Vpurify_flag)
1199 ? Fconcat (2, (tmp[0] = Ffile_name_directory (file),
1200 tmp[1] = Ffile_name_nondirectory (found),
1201 tmp))
1202 : found) ;
1203
1204 version = -1;
1205
1206 /* Check for the presence of old-style quotes and warn about them. */
1207 specbind (Qold_style_backquotes, Qnil);
1208 record_unwind_protect (load_warn_old_style_backquotes, file);
1209
1210 if (!memcmp (SDATA (found) + SBYTES (found) - 4, ".elc", 4)
1211 || (fd >= 0 && (version = safe_to_load_version (fd)) > 0))
1212 /* Load .elc files directly, but not when they are
1213 remote and have no handler! */
1214 {
1215 if (fd != -2)
1216 {
1217 struct stat s1, s2;
1218 int result;
1219
1220 GCPRO3 (file, found, hist_file_name);
1221
1222 if (version < 0
1223 && ! (version = safe_to_load_version (fd)))
1224 {
1225 safe_p = 0;
1226 if (!load_dangerous_libraries)
1227 {
1228 if (fd >= 0)
1229 emacs_close (fd);
1230 error ("File `%s' was not compiled in Emacs",
1231 SDATA (found));
1232 }
1233 else if (!NILP (nomessage) && !force_load_messages)
1234 message_with_string ("File `%s' not compiled in Emacs", found, 1);
1235 }
1236
1237 compiled = 1;
1238
1239 efound = ENCODE_FILE (found);
1240
1241 #ifdef DOS_NT
1242 fmode = "rb";
1243 #endif /* DOS_NT */
1244 result = stat (SSDATA (efound), &s1);
1245 if (result == 0)
1246 {
1247 SSET (efound, SBYTES (efound) - 1, 0);
1248 result = stat (SSDATA (efound), &s2);
1249 SSET (efound, SBYTES (efound) - 1, 'c');
1250 }
1251
1252 if (result == 0
1253 && EMACS_TIME_LT (get_stat_mtime (&s1), get_stat_mtime (&s2)))
1254 {
1255 /* Make the progress messages mention that source is newer. */
1256 newer = 1;
1257
1258 /* If we won't print another message, mention this anyway. */
1259 if (!NILP (nomessage) && !force_load_messages)
1260 {
1261 Lisp_Object msg_file;
1262 msg_file = Fsubstring (found, make_number (0), make_number (-1));
1263 message_with_string ("Source file `%s' newer than byte-compiled file",
1264 msg_file, 1);
1265 }
1266 }
1267 UNGCPRO;
1268 }
1269 }
1270 else
1271 {
1272 /* We are loading a source file (*.el). */
1273 if (!NILP (Vload_source_file_function))
1274 {
1275 Lisp_Object val;
1276
1277 if (fd >= 0)
1278 emacs_close (fd);
1279 val = call4 (Vload_source_file_function, found, hist_file_name,
1280 NILP (noerror) ? Qnil : Qt,
1281 (NILP (nomessage) || force_load_messages) ? Qnil : Qt);
1282 return unbind_to (count, val);
1283 }
1284 }
1285
1286 GCPRO3 (file, found, hist_file_name);
1287
1288 #ifdef WINDOWSNT
1289 efound = ENCODE_FILE (found);
1290 /* If we somehow got here with fd == -2, meaning the file is deemed
1291 to be remote, don't even try to reopen the file locally; just
1292 force a failure instead. */
1293 if (fd >= 0)
1294 {
1295 emacs_close (fd);
1296 stream = emacs_fopen (SSDATA (efound), fmode);
1297 }
1298 else
1299 stream = NULL;
1300 #else /* not WINDOWSNT */
1301 stream = fdopen (fd, fmode);
1302 #endif /* not WINDOWSNT */
1303 if (stream == 0)
1304 {
1305 emacs_close (fd);
1306 error ("Failure to create stdio stream for %s", SDATA (file));
1307 }
1308
1309 if (! NILP (Vpurify_flag))
1310 Vpreloaded_file_list = Fcons (Fpurecopy (file), Vpreloaded_file_list);
1311
1312 if (NILP (nomessage) || force_load_messages)
1313 {
1314 if (!safe_p)
1315 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
1316 file, 1);
1317 else if (!compiled)
1318 message_with_string ("Loading %s (source)...", file, 1);
1319 else if (newer)
1320 message_with_string ("Loading %s (compiled; note, source file is newer)...",
1321 file, 1);
1322 else /* The typical case; compiled file newer than source file. */
1323 message_with_string ("Loading %s...", file, 1);
1324 }
1325
1326 record_unwind_protect (load_unwind, make_save_pointer (stream));
1327 specbind (Qload_file_name, found);
1328 specbind (Qinhibit_file_name_operation, Qnil);
1329 specbind (Qload_in_progress, Qt);
1330
1331 instream = stream;
1332 if (lisp_file_lexically_bound_p (Qget_file_char))
1333 Fset (Qlexical_binding, Qt);
1334
1335 if (! version || version >= 22)
1336 readevalloop (Qget_file_char, stream, hist_file_name,
1337 0, Qnil, Qnil, Qnil, Qnil);
1338 else
1339 {
1340 /* We can't handle a file which was compiled with
1341 byte-compile-dynamic by older version of Emacs. */
1342 specbind (Qload_force_doc_strings, Qt);
1343 readevalloop (Qget_emacs_mule_file_char, stream, hist_file_name,
1344 0, Qnil, Qnil, Qnil, Qnil);
1345 }
1346 unbind_to (count, Qnil);
1347
1348 /* Run any eval-after-load forms for this file. */
1349 if (!NILP (Ffboundp (Qdo_after_load_evaluation)))
1350 call1 (Qdo_after_load_evaluation, hist_file_name) ;
1351
1352 UNGCPRO;
1353
1354 xfree (saved_doc_string);
1355 saved_doc_string = 0;
1356 saved_doc_string_size = 0;
1357
1358 xfree (prev_saved_doc_string);
1359 prev_saved_doc_string = 0;
1360 prev_saved_doc_string_size = 0;
1361
1362 if (!noninteractive && (NILP (nomessage) || force_load_messages))
1363 {
1364 if (!safe_p)
1365 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
1366 file, 1);
1367 else if (!compiled)
1368 message_with_string ("Loading %s (source)...done", file, 1);
1369 else if (newer)
1370 message_with_string ("Loading %s (compiled; note, source file is newer)...done",
1371 file, 1);
1372 else /* The typical case; compiled file newer than source file. */
1373 message_with_string ("Loading %s...done", file, 1);
1374 }
1375
1376 return Qt;
1377 }
1378
1379 static Lisp_Object
1380 load_unwind (Lisp_Object arg) /* Used as unwind-protect function in load. */
1381 {
1382 FILE *stream = XSAVE_POINTER (arg, 0);
1383 if (stream != NULL)
1384 {
1385 block_input ();
1386 fclose (stream);
1387 unblock_input ();
1388 }
1389 return Qnil;
1390 }
1391 \f
1392 static bool
1393 complete_filename_p (Lisp_Object pathname)
1394 {
1395 const unsigned char *s = SDATA (pathname);
1396 return (IS_DIRECTORY_SEP (s[0])
1397 || (SCHARS (pathname) > 2
1398 && IS_DEVICE_SEP (s[1]) && IS_DIRECTORY_SEP (s[2])));
1399 }
1400
1401 DEFUN ("locate-file-internal", Flocate_file_internal, Slocate_file_internal, 2, 4, 0,
1402 doc: /* Search for FILENAME through PATH.
1403 Returns the file's name in absolute form, or nil if not found.
1404 If SUFFIXES is non-nil, it should be a list of suffixes to append to
1405 file name when searching.
1406 If non-nil, PREDICATE is used instead of `file-readable-p'.
1407 PREDICATE can also be an integer to pass to the faccessat(2) function,
1408 in which case file-name-handlers are ignored.
1409 This function will normally skip directories, so if you want it to find
1410 directories, make sure the PREDICATE function returns `dir-ok' for them. */)
1411 (Lisp_Object filename, Lisp_Object path, Lisp_Object suffixes, Lisp_Object predicate)
1412 {
1413 Lisp_Object file;
1414 int fd = openp (path, filename, suffixes, &file, predicate);
1415 if (NILP (predicate) && fd > 0)
1416 emacs_close (fd);
1417 return file;
1418 }
1419
1420 static Lisp_Object Qdir_ok;
1421
1422 /* Search for a file whose name is STR, looking in directories
1423 in the Lisp list PATH, and trying suffixes from SUFFIX.
1424 On success, return a file descriptor (or 1 or -2 as described below).
1425 On failure, return -1 and set errno.
1426
1427 SUFFIXES is a list of strings containing possible suffixes.
1428 The empty suffix is automatically added if the list is empty.
1429
1430 PREDICATE non-nil means don't open the files,
1431 just look for one that satisfies the predicate. In this case,
1432 return 1 on success. The predicate can be a lisp function or
1433 an integer to pass to `access' (in which case file-name-handlers
1434 are ignored).
1435
1436 If STOREPTR is nonzero, it points to a slot where the name of
1437 the file actually found should be stored as a Lisp string.
1438 nil is stored there on failure.
1439
1440 If the file we find is remote, return -2
1441 but store the found remote file name in *STOREPTR. */
1442
1443 int
1444 openp (Lisp_Object path, Lisp_Object str, Lisp_Object suffixes,
1445 Lisp_Object *storeptr, Lisp_Object predicate)
1446 {
1447 ptrdiff_t fn_size = 100;
1448 char buf[100];
1449 char *fn = buf;
1450 bool absolute = 0;
1451 ptrdiff_t want_length;
1452 Lisp_Object filename;
1453 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
1454 Lisp_Object string, tail, encoded_fn;
1455 ptrdiff_t max_suffix_len = 0;
1456 int last_errno = ENOENT;
1457
1458 CHECK_STRING (str);
1459
1460 for (tail = suffixes; CONSP (tail); tail = XCDR (tail))
1461 {
1462 CHECK_STRING_CAR (tail);
1463 max_suffix_len = max (max_suffix_len,
1464 SBYTES (XCAR (tail)));
1465 }
1466
1467 string = filename = encoded_fn = Qnil;
1468 GCPRO6 (str, string, filename, path, suffixes, encoded_fn);
1469
1470 if (storeptr)
1471 *storeptr = Qnil;
1472
1473 if (complete_filename_p (str))
1474 absolute = 1;
1475
1476 for (; CONSP (path); path = XCDR (path))
1477 {
1478 filename = Fexpand_file_name (str, XCAR (path));
1479 if (!complete_filename_p (filename))
1480 /* If there are non-absolute elts in PATH (eg "."). */
1481 /* Of course, this could conceivably lose if luser sets
1482 default-directory to be something non-absolute... */
1483 {
1484 filename = Fexpand_file_name (filename, BVAR (current_buffer, directory));
1485 if (!complete_filename_p (filename))
1486 /* Give up on this path element! */
1487 continue;
1488 }
1489
1490 /* Calculate maximum length of any filename made from
1491 this path element/specified file name and any possible suffix. */
1492 want_length = max_suffix_len + SBYTES (filename);
1493 if (fn_size <= want_length)
1494 fn = alloca (fn_size = 100 + want_length);
1495
1496 /* Loop over suffixes. */
1497 for (tail = NILP (suffixes) ? Fcons (empty_unibyte_string, Qnil) : suffixes;
1498 CONSP (tail); tail = XCDR (tail))
1499 {
1500 ptrdiff_t fnlen, lsuffix = SBYTES (XCAR (tail));
1501 Lisp_Object handler;
1502
1503 /* Concatenate path element/specified name with the suffix.
1504 If the directory starts with /:, remove that. */
1505 int prefixlen = ((SCHARS (filename) > 2
1506 && SREF (filename, 0) == '/'
1507 && SREF (filename, 1) == ':')
1508 ? 2 : 0);
1509 fnlen = SBYTES (filename) - prefixlen;
1510 memcpy (fn, SDATA (filename) + prefixlen, fnlen);
1511 memcpy (fn + fnlen, SDATA (XCAR (tail)), lsuffix + 1);
1512 fnlen += lsuffix;
1513 /* Check that the file exists and is not a directory. */
1514 /* We used to only check for handlers on non-absolute file names:
1515 if (absolute)
1516 handler = Qnil;
1517 else
1518 handler = Ffind_file_name_handler (filename, Qfile_exists_p);
1519 It's not clear why that was the case and it breaks things like
1520 (load "/bar.el") where the file is actually "/bar.el.gz". */
1521 string = make_string (fn, fnlen);
1522 handler = Ffind_file_name_handler (string, Qfile_exists_p);
1523 if ((!NILP (handler) || !NILP (predicate)) && !NATNUMP (predicate))
1524 {
1525 bool exists;
1526 last_errno = ENOENT;
1527 if (NILP (predicate))
1528 exists = !NILP (Ffile_readable_p (string));
1529 else
1530 {
1531 Lisp_Object tmp = call1 (predicate, string);
1532 if (NILP (tmp))
1533 exists = 0;
1534 else if (EQ (tmp, Qdir_ok)
1535 || NILP (Ffile_directory_p (string)))
1536 exists = 1;
1537 else
1538 {
1539 exists = 0;
1540 last_errno = EISDIR;
1541 }
1542 }
1543
1544 if (exists)
1545 {
1546 /* We succeeded; return this descriptor and filename. */
1547 if (storeptr)
1548 *storeptr = string;
1549 UNGCPRO;
1550 return -2;
1551 }
1552 }
1553 else
1554 {
1555 int fd;
1556 const char *pfn;
1557
1558 encoded_fn = ENCODE_FILE (string);
1559 pfn = SSDATA (encoded_fn);
1560
1561 /* Check that we can access or open it. */
1562 if (NATNUMP (predicate))
1563 {
1564 fd = -1;
1565 if (INT_MAX < XFASTINT (predicate))
1566 last_errno = EINVAL;
1567 else if (faccessat (AT_FDCWD, pfn, XFASTINT (predicate),
1568 AT_EACCESS)
1569 == 0)
1570 {
1571 if (file_directory_p (pfn))
1572 last_errno = EISDIR;
1573 else
1574 fd = 1;
1575 }
1576 }
1577 else
1578 {
1579 fd = emacs_open (pfn, O_RDONLY, 0);
1580 if (fd < 0)
1581 last_errno = errno;
1582 else
1583 {
1584 struct stat st;
1585 int err = (fstat (fd, &st) != 0 ? errno
1586 : S_ISDIR (st.st_mode) ? EISDIR : 0);
1587 if (err)
1588 {
1589 last_errno = err;
1590 emacs_close (fd);
1591 fd = -1;
1592 }
1593 }
1594 }
1595
1596 if (fd >= 0)
1597 {
1598 /* We succeeded; return this descriptor and filename. */
1599 if (storeptr)
1600 *storeptr = string;
1601 UNGCPRO;
1602 return fd;
1603 }
1604 }
1605 }
1606 if (absolute)
1607 break;
1608 }
1609
1610 UNGCPRO;
1611 errno = last_errno;
1612 return -1;
1613 }
1614
1615 \f
1616 /* Merge the list we've accumulated of globals from the current input source
1617 into the load_history variable. The details depend on whether
1618 the source has an associated file name or not.
1619
1620 FILENAME is the file name that we are loading from.
1621
1622 ENTIRE is true if loading that entire file, false if evaluating
1623 part of it. */
1624
1625 static void
1626 build_load_history (Lisp_Object filename, bool entire)
1627 {
1628 Lisp_Object tail, prev, newelt;
1629 Lisp_Object tem, tem2;
1630 bool foundit = 0;
1631
1632 tail = Vload_history;
1633 prev = Qnil;
1634
1635 while (CONSP (tail))
1636 {
1637 tem = XCAR (tail);
1638
1639 /* Find the feature's previous assoc list... */
1640 if (!NILP (Fequal (filename, Fcar (tem))))
1641 {
1642 foundit = 1;
1643
1644 /* If we're loading the entire file, remove old data. */
1645 if (entire)
1646 {
1647 if (NILP (prev))
1648 Vload_history = XCDR (tail);
1649 else
1650 Fsetcdr (prev, XCDR (tail));
1651 }
1652
1653 /* Otherwise, cons on new symbols that are not already members. */
1654 else
1655 {
1656 tem2 = Vcurrent_load_list;
1657
1658 while (CONSP (tem2))
1659 {
1660 newelt = XCAR (tem2);
1661
1662 if (NILP (Fmember (newelt, tem)))
1663 Fsetcar (tail, Fcons (XCAR (tem),
1664 Fcons (newelt, XCDR (tem))));
1665
1666 tem2 = XCDR (tem2);
1667 QUIT;
1668 }
1669 }
1670 }
1671 else
1672 prev = tail;
1673 tail = XCDR (tail);
1674 QUIT;
1675 }
1676
1677 /* If we're loading an entire file, cons the new assoc onto the
1678 front of load-history, the most-recently-loaded position. Also
1679 do this if we didn't find an existing member for the file. */
1680 if (entire || !foundit)
1681 Vload_history = Fcons (Fnreverse (Vcurrent_load_list),
1682 Vload_history);
1683 }
1684
1685 static Lisp_Object
1686 readevalloop_1 (Lisp_Object old)
1687 {
1688 load_convert_to_unibyte = ! NILP (old);
1689 return Qnil;
1690 }
1691
1692 /* Signal an `end-of-file' error, if possible with file name
1693 information. */
1694
1695 static _Noreturn void
1696 end_of_file_error (void)
1697 {
1698 if (STRINGP (Vload_file_name))
1699 xsignal1 (Qend_of_file, Vload_file_name);
1700
1701 xsignal0 (Qend_of_file);
1702 }
1703
1704 /* UNIBYTE specifies how to set load_convert_to_unibyte
1705 for this invocation.
1706 READFUN, if non-nil, is used instead of `read'.
1707
1708 START, END specify region to read in current buffer (from eval-region).
1709 If the input is not from a buffer, they must be nil. */
1710
1711 static void
1712 readevalloop (Lisp_Object readcharfun,
1713 FILE *stream,
1714 Lisp_Object sourcename,
1715 bool printflag,
1716 Lisp_Object unibyte, Lisp_Object readfun,
1717 Lisp_Object start, Lisp_Object end)
1718 {
1719 register int c;
1720 register Lisp_Object val;
1721 ptrdiff_t count = SPECPDL_INDEX ();
1722 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1723 struct buffer *b = 0;
1724 bool continue_reading_p;
1725 Lisp_Object lex_bound;
1726 /* True if reading an entire buffer. */
1727 bool whole_buffer = 0;
1728 /* True on the first time around. */
1729 bool first_sexp = 1;
1730 Lisp_Object macroexpand = intern ("internal-macroexpand-for-load");
1731
1732 if (NILP (Ffboundp (macroexpand))
1733 /* Don't macroexpand in .elc files, since it should have been done
1734 already. We actually don't know whether we're in a .elc file or not,
1735 so we use circumstantial evidence: .el files normally go through
1736 Vload_source_file_function -> load-with-code-conversion
1737 -> eval-buffer. */
1738 || EQ (readcharfun, Qget_file_char)
1739 || EQ (readcharfun, Qget_emacs_mule_file_char))
1740 macroexpand = Qnil;
1741
1742 if (MARKERP (readcharfun))
1743 {
1744 if (NILP (start))
1745 start = readcharfun;
1746 }
1747
1748 if (BUFFERP (readcharfun))
1749 b = XBUFFER (readcharfun);
1750 else if (MARKERP (readcharfun))
1751 b = XMARKER (readcharfun)->buffer;
1752
1753 /* We assume START is nil when input is not from a buffer. */
1754 if (! NILP (start) && !b)
1755 emacs_abort ();
1756
1757 specbind (Qstandard_input, readcharfun); /* GCPROs readcharfun. */
1758 specbind (Qcurrent_load_list, Qnil);
1759 record_unwind_protect (readevalloop_1, load_convert_to_unibyte ? Qt : Qnil);
1760 load_convert_to_unibyte = !NILP (unibyte);
1761
1762 /* If lexical binding is active (either because it was specified in
1763 the file's header, or via a buffer-local variable), create an empty
1764 lexical environment, otherwise, turn off lexical binding. */
1765 lex_bound = find_symbol_value (Qlexical_binding);
1766 specbind (Qinternal_interpreter_environment,
1767 NILP (lex_bound) || EQ (lex_bound, Qunbound)
1768 ? Qnil : Fcons (Qt, Qnil));
1769
1770 GCPRO4 (sourcename, readfun, start, end);
1771
1772 /* Try to ensure sourcename is a truename, except whilst preloading. */
1773 if (NILP (Vpurify_flag)
1774 && !NILP (sourcename) && !NILP (Ffile_name_absolute_p (sourcename))
1775 && !NILP (Ffboundp (Qfile_truename)))
1776 sourcename = call1 (Qfile_truename, sourcename) ;
1777
1778 LOADHIST_ATTACH (sourcename);
1779
1780 continue_reading_p = 1;
1781 while (continue_reading_p)
1782 {
1783 ptrdiff_t count1 = SPECPDL_INDEX ();
1784
1785 if (b != 0 && !BUFFER_LIVE_P (b))
1786 error ("Reading from killed buffer");
1787
1788 if (!NILP (start))
1789 {
1790 /* Switch to the buffer we are reading from. */
1791 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1792 set_buffer_internal (b);
1793
1794 /* Save point in it. */
1795 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1796 /* Save ZV in it. */
1797 record_unwind_protect (save_restriction_restore, save_restriction_save ());
1798 /* Those get unbound after we read one expression. */
1799
1800 /* Set point and ZV around stuff to be read. */
1801 Fgoto_char (start);
1802 if (!NILP (end))
1803 Fnarrow_to_region (make_number (BEGV), end);
1804
1805 /* Just for cleanliness, convert END to a marker
1806 if it is an integer. */
1807 if (INTEGERP (end))
1808 end = Fpoint_max_marker ();
1809 }
1810
1811 /* On the first cycle, we can easily test here
1812 whether we are reading the whole buffer. */
1813 if (b && first_sexp)
1814 whole_buffer = (PT == BEG && ZV == Z);
1815
1816 instream = stream;
1817 read_next:
1818 c = READCHAR;
1819 if (c == ';')
1820 {
1821 while ((c = READCHAR) != '\n' && c != -1);
1822 goto read_next;
1823 }
1824 if (c < 0)
1825 {
1826 unbind_to (count1, Qnil);
1827 break;
1828 }
1829
1830 /* Ignore whitespace here, so we can detect eof. */
1831 if (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r'
1832 || c == 0xa0) /* NBSP */
1833 goto read_next;
1834
1835 if (!NILP (Vpurify_flag) && c == '(')
1836 {
1837 val = read_list (0, readcharfun);
1838 }
1839 else
1840 {
1841 UNREAD (c);
1842 read_objects = Qnil;
1843 if (!NILP (readfun))
1844 {
1845 val = call1 (readfun, readcharfun);
1846
1847 /* If READCHARFUN has set point to ZV, we should
1848 stop reading, even if the form read sets point
1849 to a different value when evaluated. */
1850 if (BUFFERP (readcharfun))
1851 {
1852 struct buffer *buf = XBUFFER (readcharfun);
1853 if (BUF_PT (buf) == BUF_ZV (buf))
1854 continue_reading_p = 0;
1855 }
1856 }
1857 else if (! NILP (Vload_read_function))
1858 val = call1 (Vload_read_function, readcharfun);
1859 else
1860 val = read_internal_start (readcharfun, Qnil, Qnil);
1861 }
1862
1863 if (!NILP (start) && continue_reading_p)
1864 start = Fpoint_marker ();
1865
1866 /* Restore saved point and BEGV. */
1867 unbind_to (count1, Qnil);
1868
1869 /* Now eval what we just read. */
1870 if (!NILP (macroexpand))
1871 val = call1 (macroexpand, val);
1872 val = eval_sub (val);
1873
1874 if (printflag)
1875 {
1876 Vvalues = Fcons (val, Vvalues);
1877 if (EQ (Vstandard_output, Qt))
1878 Fprin1 (val, Qnil);
1879 else
1880 Fprint (val, Qnil);
1881 }
1882
1883 first_sexp = 0;
1884 }
1885
1886 build_load_history (sourcename,
1887 stream || whole_buffer);
1888
1889 UNGCPRO;
1890
1891 unbind_to (count, Qnil);
1892 }
1893
1894 DEFUN ("eval-buffer", Feval_buffer, Seval_buffer, 0, 5, "",
1895 doc: /* Execute the current buffer as Lisp code.
1896 When called from a Lisp program (i.e., not interactively), this
1897 function accepts up to five optional arguments:
1898 BUFFER is the buffer to evaluate (nil means use current buffer).
1899 PRINTFLAG controls printing of output:
1900 A value of nil means discard it; anything else is stream for print.
1901 FILENAME specifies the file name to use for `load-history'.
1902 UNIBYTE, if non-nil, specifies `load-convert-to-unibyte' for this
1903 invocation.
1904 DO-ALLOW-PRINT, if non-nil, specifies that `print' and related
1905 functions should work normally even if PRINTFLAG is nil.
1906
1907 This function preserves the position of point. */)
1908 (Lisp_Object buffer, Lisp_Object printflag, Lisp_Object filename, Lisp_Object unibyte, Lisp_Object do_allow_print)
1909 {
1910 ptrdiff_t count = SPECPDL_INDEX ();
1911 Lisp_Object tem, buf;
1912
1913 if (NILP (buffer))
1914 buf = Fcurrent_buffer ();
1915 else
1916 buf = Fget_buffer (buffer);
1917 if (NILP (buf))
1918 error ("No such buffer");
1919
1920 if (NILP (printflag) && NILP (do_allow_print))
1921 tem = Qsymbolp;
1922 else
1923 tem = printflag;
1924
1925 if (NILP (filename))
1926 filename = BVAR (XBUFFER (buf), filename);
1927
1928 specbind (Qeval_buffer_list, Fcons (buf, Veval_buffer_list));
1929 specbind (Qstandard_output, tem);
1930 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1931 BUF_TEMP_SET_PT (XBUFFER (buf), BUF_BEGV (XBUFFER (buf)));
1932 specbind (Qlexical_binding, lisp_file_lexically_bound_p (buf) ? Qt : Qnil);
1933 readevalloop (buf, 0, filename,
1934 !NILP (printflag), unibyte, Qnil, Qnil, Qnil);
1935 unbind_to (count, Qnil);
1936
1937 return Qnil;
1938 }
1939
1940 DEFUN ("eval-region", Feval_region, Seval_region, 2, 4, "r",
1941 doc: /* Execute the region as Lisp code.
1942 When called from programs, expects two arguments,
1943 giving starting and ending indices in the current buffer
1944 of the text to be executed.
1945 Programs can pass third argument PRINTFLAG which controls output:
1946 A value of nil means discard it; anything else is stream for printing it.
1947 Also the fourth argument READ-FUNCTION, if non-nil, is used
1948 instead of `read' to read each expression. It gets one argument
1949 which is the input stream for reading characters.
1950
1951 This function does not move point. */)
1952 (Lisp_Object start, Lisp_Object end, Lisp_Object printflag, Lisp_Object read_function)
1953 {
1954 /* FIXME: Do the eval-sexp-add-defvars dance! */
1955 ptrdiff_t count = SPECPDL_INDEX ();
1956 Lisp_Object tem, cbuf;
1957
1958 cbuf = Fcurrent_buffer ();
1959
1960 if (NILP (printflag))
1961 tem = Qsymbolp;
1962 else
1963 tem = printflag;
1964 specbind (Qstandard_output, tem);
1965 specbind (Qeval_buffer_list, Fcons (cbuf, Veval_buffer_list));
1966
1967 /* `readevalloop' calls functions which check the type of start and end. */
1968 readevalloop (cbuf, 0, BVAR (XBUFFER (cbuf), filename),
1969 !NILP (printflag), Qnil, read_function,
1970 start, end);
1971
1972 return unbind_to (count, Qnil);
1973 }
1974
1975 \f
1976 DEFUN ("read", Fread, Sread, 0, 1, 0,
1977 doc: /* Read one Lisp expression as text from STREAM, return as Lisp object.
1978 If STREAM is nil, use the value of `standard-input' (which see).
1979 STREAM or the value of `standard-input' may be:
1980 a buffer (read from point and advance it)
1981 a marker (read from where it points and advance it)
1982 a function (call it with no arguments for each character,
1983 call it with a char as argument to push a char back)
1984 a string (takes text from string, starting at the beginning)
1985 t (read text line using minibuffer and use it, or read from
1986 standard input in batch mode). */)
1987 (Lisp_Object stream)
1988 {
1989 if (NILP (stream))
1990 stream = Vstandard_input;
1991 if (EQ (stream, Qt))
1992 stream = Qread_char;
1993 if (EQ (stream, Qread_char))
1994 /* FIXME: ¿¡ When is this used !? */
1995 return call1 (intern ("read-minibuffer"),
1996 build_string ("Lisp expression: "));
1997
1998 return read_internal_start (stream, Qnil, Qnil);
1999 }
2000
2001 DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0,
2002 doc: /* Read one Lisp expression which is represented as text by STRING.
2003 Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
2004 FINAL-STRING-INDEX is an integer giving the position of the next
2005 remaining character in STRING.
2006 START and END optionally delimit a substring of STRING from which to read;
2007 they default to 0 and (length STRING) respectively. */)
2008 (Lisp_Object string, Lisp_Object start, Lisp_Object end)
2009 {
2010 Lisp_Object ret;
2011 CHECK_STRING (string);
2012 /* `read_internal_start' sets `read_from_string_index'. */
2013 ret = read_internal_start (string, start, end);
2014 return Fcons (ret, make_number (read_from_string_index));
2015 }
2016
2017 /* Function to set up the global context we need in toplevel read
2018 calls. */
2019 static Lisp_Object
2020 read_internal_start (Lisp_Object stream, Lisp_Object start, Lisp_Object end)
2021 /* `start', `end' only used when stream is a string. */
2022 {
2023 Lisp_Object retval;
2024
2025 readchar_count = 0;
2026 new_backquote_flag = 0;
2027 read_objects = Qnil;
2028 if (EQ (Vread_with_symbol_positions, Qt)
2029 || EQ (Vread_with_symbol_positions, stream))
2030 Vread_symbol_positions_list = Qnil;
2031
2032 if (STRINGP (stream)
2033 || ((CONSP (stream) && STRINGP (XCAR (stream)))))
2034 {
2035 ptrdiff_t startval, endval;
2036 Lisp_Object string;
2037
2038 if (STRINGP (stream))
2039 string = stream;
2040 else
2041 string = XCAR (stream);
2042
2043 if (NILP (end))
2044 endval = SCHARS (string);
2045 else
2046 {
2047 CHECK_NUMBER (end);
2048 if (! (0 <= XINT (end) && XINT (end) <= SCHARS (string)))
2049 args_out_of_range (string, end);
2050 endval = XINT (end);
2051 }
2052
2053 if (NILP (start))
2054 startval = 0;
2055 else
2056 {
2057 CHECK_NUMBER (start);
2058 if (! (0 <= XINT (start) && XINT (start) <= endval))
2059 args_out_of_range (string, start);
2060 startval = XINT (start);
2061 }
2062 read_from_string_index = startval;
2063 read_from_string_index_byte = string_char_to_byte (string, startval);
2064 read_from_string_limit = endval;
2065 }
2066
2067 retval = read0 (stream);
2068 if (EQ (Vread_with_symbol_positions, Qt)
2069 || EQ (Vread_with_symbol_positions, stream))
2070 Vread_symbol_positions_list = Fnreverse (Vread_symbol_positions_list);
2071 return retval;
2072 }
2073 \f
2074
2075 /* Signal Qinvalid_read_syntax error.
2076 S is error string of length N (if > 0) */
2077
2078 static _Noreturn void
2079 invalid_syntax (const char *s)
2080 {
2081 xsignal1 (Qinvalid_read_syntax, build_string (s));
2082 }
2083
2084
2085 /* Use this for recursive reads, in contexts where internal tokens
2086 are not allowed. */
2087
2088 static Lisp_Object
2089 read0 (Lisp_Object readcharfun)
2090 {
2091 register Lisp_Object val;
2092 int c;
2093
2094 val = read1 (readcharfun, &c, 0);
2095 if (!c)
2096 return val;
2097
2098 xsignal1 (Qinvalid_read_syntax,
2099 Fmake_string (make_number (1), make_number (c)));
2100 }
2101 \f
2102 static ptrdiff_t read_buffer_size;
2103 static char *read_buffer;
2104
2105 /* Read a \-escape sequence, assuming we already read the `\'.
2106 If the escape sequence forces unibyte, return eight-bit char. */
2107
2108 static int
2109 read_escape (Lisp_Object readcharfun, bool stringp)
2110 {
2111 int c = READCHAR;
2112 /* \u allows up to four hex digits, \U up to eight. Default to the
2113 behavior for \u, and change this value in the case that \U is seen. */
2114 int unicode_hex_count = 4;
2115
2116 switch (c)
2117 {
2118 case -1:
2119 end_of_file_error ();
2120
2121 case 'a':
2122 return '\007';
2123 case 'b':
2124 return '\b';
2125 case 'd':
2126 return 0177;
2127 case 'e':
2128 return 033;
2129 case 'f':
2130 return '\f';
2131 case 'n':
2132 return '\n';
2133 case 'r':
2134 return '\r';
2135 case 't':
2136 return '\t';
2137 case 'v':
2138 return '\v';
2139 case '\n':
2140 return -1;
2141 case ' ':
2142 if (stringp)
2143 return -1;
2144 return ' ';
2145
2146 case 'M':
2147 c = READCHAR;
2148 if (c != '-')
2149 error ("Invalid escape character syntax");
2150 c = READCHAR;
2151 if (c == '\\')
2152 c = read_escape (readcharfun, 0);
2153 return c | meta_modifier;
2154
2155 case 'S':
2156 c = READCHAR;
2157 if (c != '-')
2158 error ("Invalid escape character syntax");
2159 c = READCHAR;
2160 if (c == '\\')
2161 c = read_escape (readcharfun, 0);
2162 return c | shift_modifier;
2163
2164 case 'H':
2165 c = READCHAR;
2166 if (c != '-')
2167 error ("Invalid escape character syntax");
2168 c = READCHAR;
2169 if (c == '\\')
2170 c = read_escape (readcharfun, 0);
2171 return c | hyper_modifier;
2172
2173 case 'A':
2174 c = READCHAR;
2175 if (c != '-')
2176 error ("Invalid escape character syntax");
2177 c = READCHAR;
2178 if (c == '\\')
2179 c = read_escape (readcharfun, 0);
2180 return c | alt_modifier;
2181
2182 case 's':
2183 c = READCHAR;
2184 if (stringp || c != '-')
2185 {
2186 UNREAD (c);
2187 return ' ';
2188 }
2189 c = READCHAR;
2190 if (c == '\\')
2191 c = read_escape (readcharfun, 0);
2192 return c | super_modifier;
2193
2194 case 'C':
2195 c = READCHAR;
2196 if (c != '-')
2197 error ("Invalid escape character syntax");
2198 case '^':
2199 c = READCHAR;
2200 if (c == '\\')
2201 c = read_escape (readcharfun, 0);
2202 if ((c & ~CHAR_MODIFIER_MASK) == '?')
2203 return 0177 | (c & CHAR_MODIFIER_MASK);
2204 else if (! SINGLE_BYTE_CHAR_P ((c & ~CHAR_MODIFIER_MASK)))
2205 return c | ctrl_modifier;
2206 /* ASCII control chars are made from letters (both cases),
2207 as well as the non-letters within 0100...0137. */
2208 else if ((c & 0137) >= 0101 && (c & 0137) <= 0132)
2209 return (c & (037 | ~0177));
2210 else if ((c & 0177) >= 0100 && (c & 0177) <= 0137)
2211 return (c & (037 | ~0177));
2212 else
2213 return c | ctrl_modifier;
2214
2215 case '0':
2216 case '1':
2217 case '2':
2218 case '3':
2219 case '4':
2220 case '5':
2221 case '6':
2222 case '7':
2223 /* An octal escape, as in ANSI C. */
2224 {
2225 register int i = c - '0';
2226 register int count = 0;
2227 while (++count < 3)
2228 {
2229 if ((c = READCHAR) >= '0' && c <= '7')
2230 {
2231 i *= 8;
2232 i += c - '0';
2233 }
2234 else
2235 {
2236 UNREAD (c);
2237 break;
2238 }
2239 }
2240
2241 if (i >= 0x80 && i < 0x100)
2242 i = BYTE8_TO_CHAR (i);
2243 return i;
2244 }
2245
2246 case 'x':
2247 /* A hex escape, as in ANSI C. */
2248 {
2249 unsigned int i = 0;
2250 int count = 0;
2251 while (1)
2252 {
2253 c = READCHAR;
2254 if (c >= '0' && c <= '9')
2255 {
2256 i *= 16;
2257 i += c - '0';
2258 }
2259 else if ((c >= 'a' && c <= 'f')
2260 || (c >= 'A' && c <= 'F'))
2261 {
2262 i *= 16;
2263 if (c >= 'a' && c <= 'f')
2264 i += c - 'a' + 10;
2265 else
2266 i += c - 'A' + 10;
2267 }
2268 else
2269 {
2270 UNREAD (c);
2271 break;
2272 }
2273 /* Allow hex escapes as large as ?\xfffffff, because some
2274 packages use them to denote characters with modifiers. */
2275 if ((CHAR_META | (CHAR_META - 1)) < i)
2276 error ("Hex character out of range: \\x%x...", i);
2277 count += count < 3;
2278 }
2279
2280 if (count < 3 && i >= 0x80)
2281 return BYTE8_TO_CHAR (i);
2282 return i;
2283 }
2284
2285 case 'U':
2286 /* Post-Unicode-2.0: Up to eight hex chars. */
2287 unicode_hex_count = 8;
2288 case 'u':
2289
2290 /* A Unicode escape. We only permit them in strings and characters,
2291 not arbitrarily in the source code, as in some other languages. */
2292 {
2293 unsigned int i = 0;
2294 int count = 0;
2295
2296 while (++count <= unicode_hex_count)
2297 {
2298 c = READCHAR;
2299 /* `isdigit' and `isalpha' may be locale-specific, which we don't
2300 want. */
2301 if (c >= '0' && c <= '9') i = (i << 4) + (c - '0');
2302 else if (c >= 'a' && c <= 'f') i = (i << 4) + (c - 'a') + 10;
2303 else if (c >= 'A' && c <= 'F') i = (i << 4) + (c - 'A') + 10;
2304 else
2305 error ("Non-hex digit used for Unicode escape");
2306 }
2307 if (i > 0x10FFFF)
2308 error ("Non-Unicode character: 0x%x", i);
2309 return i;
2310 }
2311
2312 default:
2313 return c;
2314 }
2315 }
2316
2317 /* Return the digit that CHARACTER stands for in the given BASE.
2318 Return -1 if CHARACTER is out of range for BASE,
2319 and -2 if CHARACTER is not valid for any supported BASE. */
2320 static int
2321 digit_to_number (int character, int base)
2322 {
2323 int digit;
2324
2325 if ('0' <= character && character <= '9')
2326 digit = character - '0';
2327 else if ('a' <= character && character <= 'z')
2328 digit = character - 'a' + 10;
2329 else if ('A' <= character && character <= 'Z')
2330 digit = character - 'A' + 10;
2331 else
2332 return -2;
2333
2334 return digit < base ? digit : -1;
2335 }
2336
2337 /* Read an integer in radix RADIX using READCHARFUN to read
2338 characters. RADIX must be in the interval [2..36]; if it isn't, a
2339 read error is signaled . Value is the integer read. Signals an
2340 error if encountering invalid read syntax or if RADIX is out of
2341 range. */
2342
2343 static Lisp_Object
2344 read_integer (Lisp_Object readcharfun, EMACS_INT radix)
2345 {
2346 /* Room for sign, leading 0, other digits, trailing null byte.
2347 Also, room for invalid syntax diagnostic. */
2348 char buf[max (1 + 1 + sizeof (uintmax_t) * CHAR_BIT + 1,
2349 sizeof "integer, radix " + INT_STRLEN_BOUND (EMACS_INT))];
2350
2351 int valid = -1; /* 1 if valid, 0 if not, -1 if incomplete. */
2352
2353 if (radix < 2 || radix > 36)
2354 valid = 0;
2355 else
2356 {
2357 char *p = buf;
2358 int c, digit;
2359
2360 c = READCHAR;
2361 if (c == '-' || c == '+')
2362 {
2363 *p++ = c;
2364 c = READCHAR;
2365 }
2366
2367 if (c == '0')
2368 {
2369 *p++ = c;
2370 valid = 1;
2371
2372 /* Ignore redundant leading zeros, so the buffer doesn't
2373 fill up with them. */
2374 do
2375 c = READCHAR;
2376 while (c == '0');
2377 }
2378
2379 while ((digit = digit_to_number (c, radix)) >= -1)
2380 {
2381 if (digit == -1)
2382 valid = 0;
2383 if (valid < 0)
2384 valid = 1;
2385
2386 if (p < buf + sizeof buf - 1)
2387 *p++ = c;
2388 else
2389 valid = 0;
2390
2391 c = READCHAR;
2392 }
2393
2394 UNREAD (c);
2395 *p = '\0';
2396 }
2397
2398 if (! valid)
2399 {
2400 sprintf (buf, "integer, radix %"pI"d", radix);
2401 invalid_syntax (buf);
2402 }
2403
2404 return string_to_number (buf, radix, 0);
2405 }
2406
2407
2408 /* If the next token is ')' or ']' or '.', we store that character
2409 in *PCH and the return value is not interesting. Else, we store
2410 zero in *PCH and we read and return one lisp object.
2411
2412 FIRST_IN_LIST is true if this is the first element of a list. */
2413
2414 static Lisp_Object
2415 read1 (Lisp_Object readcharfun, int *pch, bool first_in_list)
2416 {
2417 int c;
2418 bool uninterned_symbol = 0;
2419 bool multibyte;
2420
2421 *pch = 0;
2422
2423 retry:
2424
2425 c = READCHAR_REPORT_MULTIBYTE (&multibyte);
2426 if (c < 0)
2427 end_of_file_error ();
2428
2429 switch (c)
2430 {
2431 case '(':
2432 return read_list (0, readcharfun);
2433
2434 case '[':
2435 return read_vector (readcharfun, 0);
2436
2437 case ')':
2438 case ']':
2439 {
2440 *pch = c;
2441 return Qnil;
2442 }
2443
2444 case '#':
2445 c = READCHAR;
2446 if (c == 's')
2447 {
2448 c = READCHAR;
2449 if (c == '(')
2450 {
2451 /* Accept extended format for hashtables (extensible to
2452 other types), e.g.
2453 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
2454 Lisp_Object tmp = read_list (0, readcharfun);
2455 Lisp_Object head = CAR_SAFE (tmp);
2456 Lisp_Object data = Qnil;
2457 Lisp_Object val = Qnil;
2458 /* The size is 2 * number of allowed keywords to
2459 make-hash-table. */
2460 Lisp_Object params[10];
2461 Lisp_Object ht;
2462 Lisp_Object key = Qnil;
2463 int param_count = 0;
2464
2465 if (!EQ (head, Qhash_table))
2466 error ("Invalid extended read marker at head of #s list "
2467 "(only hash-table allowed)");
2468
2469 tmp = CDR_SAFE (tmp);
2470
2471 /* This is repetitive but fast and simple. */
2472 params[param_count] = QCsize;
2473 params[param_count + 1] = Fplist_get (tmp, Qsize);
2474 if (!NILP (params[param_count + 1]))
2475 param_count += 2;
2476
2477 params[param_count] = QCtest;
2478 params[param_count + 1] = Fplist_get (tmp, Qtest);
2479 if (!NILP (params[param_count + 1]))
2480 param_count += 2;
2481
2482 params[param_count] = QCweakness;
2483 params[param_count + 1] = Fplist_get (tmp, Qweakness);
2484 if (!NILP (params[param_count + 1]))
2485 param_count += 2;
2486
2487 params[param_count] = QCrehash_size;
2488 params[param_count + 1] = Fplist_get (tmp, Qrehash_size);
2489 if (!NILP (params[param_count + 1]))
2490 param_count += 2;
2491
2492 params[param_count] = QCrehash_threshold;
2493 params[param_count + 1] = Fplist_get (tmp, Qrehash_threshold);
2494 if (!NILP (params[param_count + 1]))
2495 param_count += 2;
2496
2497 /* This is the hashtable data. */
2498 data = Fplist_get (tmp, Qdata);
2499
2500 /* Now use params to make a new hashtable and fill it. */
2501 ht = Fmake_hash_table (param_count, params);
2502
2503 while (CONSP (data))
2504 {
2505 key = XCAR (data);
2506 data = XCDR (data);
2507 if (!CONSP (data))
2508 error ("Odd number of elements in hashtable data");
2509 val = XCAR (data);
2510 data = XCDR (data);
2511 Fputhash (key, val, ht);
2512 }
2513
2514 return ht;
2515 }
2516 UNREAD (c);
2517 invalid_syntax ("#");
2518 }
2519 if (c == '^')
2520 {
2521 c = READCHAR;
2522 if (c == '[')
2523 {
2524 Lisp_Object tmp;
2525 tmp = read_vector (readcharfun, 0);
2526 if (ASIZE (tmp) < CHAR_TABLE_STANDARD_SLOTS)
2527 error ("Invalid size char-table");
2528 XSETPVECTYPE (XVECTOR (tmp), PVEC_CHAR_TABLE);
2529 return tmp;
2530 }
2531 else if (c == '^')
2532 {
2533 c = READCHAR;
2534 if (c == '[')
2535 {
2536 Lisp_Object tmp;
2537 int depth;
2538 ptrdiff_t size;
2539
2540 tmp = read_vector (readcharfun, 0);
2541 size = ASIZE (tmp);
2542 if (size == 0)
2543 error ("Invalid size char-table");
2544 if (! RANGED_INTEGERP (1, AREF (tmp, 0), 3))
2545 error ("Invalid depth in char-table");
2546 depth = XINT (AREF (tmp, 0));
2547 if (chartab_size[depth] != size - 2)
2548 error ("Invalid size char-table");
2549 XSETPVECTYPE (XVECTOR (tmp), PVEC_SUB_CHAR_TABLE);
2550 return tmp;
2551 }
2552 invalid_syntax ("#^^");
2553 }
2554 invalid_syntax ("#^");
2555 }
2556 if (c == '&')
2557 {
2558 Lisp_Object length;
2559 length = read1 (readcharfun, pch, first_in_list);
2560 c = READCHAR;
2561 if (c == '"')
2562 {
2563 Lisp_Object tmp, val;
2564 EMACS_INT size_in_chars
2565 = ((XFASTINT (length) + BOOL_VECTOR_BITS_PER_CHAR - 1)
2566 / BOOL_VECTOR_BITS_PER_CHAR);
2567
2568 UNREAD (c);
2569 tmp = read1 (readcharfun, pch, first_in_list);
2570 if (STRING_MULTIBYTE (tmp)
2571 || (size_in_chars != SCHARS (tmp)
2572 /* We used to print 1 char too many
2573 when the number of bits was a multiple of 8.
2574 Accept such input in case it came from an old
2575 version. */
2576 && ! (XFASTINT (length)
2577 == (SCHARS (tmp) - 1) * BOOL_VECTOR_BITS_PER_CHAR)))
2578 invalid_syntax ("#&...");
2579
2580 val = Fmake_bool_vector (length, Qnil);
2581 memcpy (XBOOL_VECTOR (val)->data, SDATA (tmp), size_in_chars);
2582 /* Clear the extraneous bits in the last byte. */
2583 if (XINT (length) != size_in_chars * BOOL_VECTOR_BITS_PER_CHAR)
2584 XBOOL_VECTOR (val)->data[size_in_chars - 1]
2585 &= (1 << (XINT (length) % BOOL_VECTOR_BITS_PER_CHAR)) - 1;
2586 return val;
2587 }
2588 invalid_syntax ("#&...");
2589 }
2590 if (c == '[')
2591 {
2592 /* Accept compiled functions at read-time so that we don't have to
2593 build them using function calls. */
2594 Lisp_Object tmp;
2595 tmp = read_vector (readcharfun, 1);
2596 make_byte_code (XVECTOR (tmp));
2597 return tmp;
2598 }
2599 if (c == '(')
2600 {
2601 Lisp_Object tmp;
2602 struct gcpro gcpro1;
2603 int ch;
2604
2605 /* Read the string itself. */
2606 tmp = read1 (readcharfun, &ch, 0);
2607 if (ch != 0 || !STRINGP (tmp))
2608 invalid_syntax ("#");
2609 GCPRO1 (tmp);
2610 /* Read the intervals and their properties. */
2611 while (1)
2612 {
2613 Lisp_Object beg, end, plist;
2614
2615 beg = read1 (readcharfun, &ch, 0);
2616 end = plist = Qnil;
2617 if (ch == ')')
2618 break;
2619 if (ch == 0)
2620 end = read1 (readcharfun, &ch, 0);
2621 if (ch == 0)
2622 plist = read1 (readcharfun, &ch, 0);
2623 if (ch)
2624 invalid_syntax ("Invalid string property list");
2625 Fset_text_properties (beg, end, plist, tmp);
2626 }
2627 UNGCPRO;
2628 return tmp;
2629 }
2630
2631 /* #@NUMBER is used to skip NUMBER following bytes.
2632 That's used in .elc files to skip over doc strings
2633 and function definitions. */
2634 if (c == '@')
2635 {
2636 enum { extra = 100 };
2637 ptrdiff_t i, nskip = 0, digits = 0;
2638
2639 /* Read a decimal integer. */
2640 while ((c = READCHAR) >= 0
2641 && c >= '0' && c <= '9')
2642 {
2643 if ((STRING_BYTES_BOUND - extra) / 10 <= nskip)
2644 string_overflow ();
2645 digits++;
2646 nskip *= 10;
2647 nskip += c - '0';
2648 if (digits == 2 && nskip == 0)
2649 { /* We've just seen #@00, which means "skip to end". */
2650 skip_dyn_eof (readcharfun);
2651 return Qnil;
2652 }
2653 }
2654 if (nskip > 0)
2655 /* We can't use UNREAD here, because in the code below we side-step
2656 READCHAR. Instead, assume the first char after #@NNN occupies
2657 a single byte, which is the case normally since it's just
2658 a space. */
2659 nskip--;
2660 else
2661 UNREAD (c);
2662
2663 if (load_force_doc_strings
2664 && (FROM_FILE_P (readcharfun)))
2665 {
2666 /* If we are supposed to force doc strings into core right now,
2667 record the last string that we skipped,
2668 and record where in the file it comes from. */
2669
2670 /* But first exchange saved_doc_string
2671 with prev_saved_doc_string, so we save two strings. */
2672 {
2673 char *temp = saved_doc_string;
2674 ptrdiff_t temp_size = saved_doc_string_size;
2675 file_offset temp_pos = saved_doc_string_position;
2676 ptrdiff_t temp_len = saved_doc_string_length;
2677
2678 saved_doc_string = prev_saved_doc_string;
2679 saved_doc_string_size = prev_saved_doc_string_size;
2680 saved_doc_string_position = prev_saved_doc_string_position;
2681 saved_doc_string_length = prev_saved_doc_string_length;
2682
2683 prev_saved_doc_string = temp;
2684 prev_saved_doc_string_size = temp_size;
2685 prev_saved_doc_string_position = temp_pos;
2686 prev_saved_doc_string_length = temp_len;
2687 }
2688
2689 if (saved_doc_string_size == 0)
2690 {
2691 saved_doc_string = xmalloc (nskip + extra);
2692 saved_doc_string_size = nskip + extra;
2693 }
2694 if (nskip > saved_doc_string_size)
2695 {
2696 saved_doc_string = xrealloc (saved_doc_string, nskip + extra);
2697 saved_doc_string_size = nskip + extra;
2698 }
2699
2700 saved_doc_string_position = file_tell (instream);
2701
2702 /* Copy that many characters into saved_doc_string. */
2703 block_input ();
2704 for (i = 0; i < nskip && c >= 0; i++)
2705 saved_doc_string[i] = c = getc (instream);
2706 unblock_input ();
2707
2708 saved_doc_string_length = i;
2709 }
2710 else
2711 /* Skip that many bytes. */
2712 skip_dyn_bytes (readcharfun, nskip);
2713
2714 goto retry;
2715 }
2716 if (c == '!')
2717 {
2718 /* #! appears at the beginning of an executable file.
2719 Skip the first line. */
2720 while (c != '\n' && c >= 0)
2721 c = READCHAR;
2722 goto retry;
2723 }
2724 if (c == '$')
2725 return Vload_file_name;
2726 if (c == '\'')
2727 return Fcons (Qfunction, Fcons (read0 (readcharfun), Qnil));
2728 /* #:foo is the uninterned symbol named foo. */
2729 if (c == ':')
2730 {
2731 uninterned_symbol = 1;
2732 c = READCHAR;
2733 if (!(c > 040
2734 && c != 0xa0 /* NBSP */
2735 && (c >= 0200
2736 || strchr ("\"';()[]#`,", c) == NULL)))
2737 {
2738 /* No symbol character follows, this is the empty
2739 symbol. */
2740 UNREAD (c);
2741 return Fmake_symbol (empty_unibyte_string);
2742 }
2743 goto read_symbol;
2744 }
2745 /* ## is the empty symbol. */
2746 if (c == '#')
2747 return Fintern (empty_unibyte_string, Qnil);
2748 /* Reader forms that can reuse previously read objects. */
2749 if (c >= '0' && c <= '9')
2750 {
2751 EMACS_INT n = 0;
2752 Lisp_Object tem;
2753
2754 /* Read a non-negative integer. */
2755 while (c >= '0' && c <= '9')
2756 {
2757 if (MOST_POSITIVE_FIXNUM / 10 < n
2758 || MOST_POSITIVE_FIXNUM < n * 10 + c - '0')
2759 n = MOST_POSITIVE_FIXNUM + 1;
2760 else
2761 n = n * 10 + c - '0';
2762 c = READCHAR;
2763 }
2764
2765 if (n <= MOST_POSITIVE_FIXNUM)
2766 {
2767 if (c == 'r' || c == 'R')
2768 return read_integer (readcharfun, n);
2769
2770 if (! NILP (Vread_circle))
2771 {
2772 /* #n=object returns object, but associates it with
2773 n for #n#. */
2774 if (c == '=')
2775 {
2776 /* Make a placeholder for #n# to use temporarily. */
2777 Lisp_Object placeholder;
2778 Lisp_Object cell;
2779
2780 placeholder = Fcons (Qnil, Qnil);
2781 cell = Fcons (make_number (n), placeholder);
2782 read_objects = Fcons (cell, read_objects);
2783
2784 /* Read the object itself. */
2785 tem = read0 (readcharfun);
2786
2787 /* Now put it everywhere the placeholder was... */
2788 substitute_object_in_subtree (tem, placeholder);
2789
2790 /* ...and #n# will use the real value from now on. */
2791 Fsetcdr (cell, tem);
2792
2793 return tem;
2794 }
2795
2796 /* #n# returns a previously read object. */
2797 if (c == '#')
2798 {
2799 tem = Fassq (make_number (n), read_objects);
2800 if (CONSP (tem))
2801 return XCDR (tem);
2802 }
2803 }
2804 }
2805 /* Fall through to error message. */
2806 }
2807 else if (c == 'x' || c == 'X')
2808 return read_integer (readcharfun, 16);
2809 else if (c == 'o' || c == 'O')
2810 return read_integer (readcharfun, 8);
2811 else if (c == 'b' || c == 'B')
2812 return read_integer (readcharfun, 2);
2813
2814 UNREAD (c);
2815 invalid_syntax ("#");
2816
2817 case ';':
2818 while ((c = READCHAR) >= 0 && c != '\n');
2819 goto retry;
2820
2821 case '\'':
2822 {
2823 return Fcons (Qquote, Fcons (read0 (readcharfun), Qnil));
2824 }
2825
2826 case '`':
2827 {
2828 int next_char = READCHAR;
2829 UNREAD (next_char);
2830 /* Transition from old-style to new-style:
2831 If we see "(`" it used to mean old-style, which usually works
2832 fine because ` should almost never appear in such a position
2833 for new-style. But occasionally we need "(`" to mean new
2834 style, so we try to distinguish the two by the fact that we
2835 can either write "( `foo" or "(` foo", where the first
2836 intends to use new-style whereas the second intends to use
2837 old-style. For Emacs-25, we should completely remove this
2838 first_in_list exception (old-style can still be obtained via
2839 "(\`" anyway). */
2840 if (!new_backquote_flag && first_in_list && next_char == ' ')
2841 {
2842 Vold_style_backquotes = Qt;
2843 goto default_label;
2844 }
2845 else
2846 {
2847 Lisp_Object value;
2848 bool saved_new_backquote_flag = new_backquote_flag;
2849
2850 new_backquote_flag = 1;
2851 value = read0 (readcharfun);
2852 new_backquote_flag = saved_new_backquote_flag;
2853
2854 return Fcons (Qbackquote, Fcons (value, Qnil));
2855 }
2856 }
2857 case ',':
2858 {
2859 int next_char = READCHAR;
2860 UNREAD (next_char);
2861 /* Transition from old-style to new-style:
2862 It used to be impossible to have a new-style , other than within
2863 a new-style `. This is sufficient when ` and , are used in the
2864 normal way, but ` and , can also appear in args to macros that
2865 will not interpret them in the usual way, in which case , may be
2866 used without any ` anywhere near.
2867 So we now use the same heuristic as for backquote: old-style
2868 unquotes are only recognized when first on a list, and when
2869 followed by a space.
2870 Because it's more difficult to peek 2 chars ahead, a new-style
2871 ,@ can still not be used outside of a `, unless it's in the middle
2872 of a list. */
2873 if (new_backquote_flag
2874 || !first_in_list
2875 || (next_char != ' ' && next_char != '@'))
2876 {
2877 Lisp_Object comma_type = Qnil;
2878 Lisp_Object value;
2879 int ch = READCHAR;
2880
2881 if (ch == '@')
2882 comma_type = Qcomma_at;
2883 else if (ch == '.')
2884 comma_type = Qcomma_dot;
2885 else
2886 {
2887 if (ch >= 0) UNREAD (ch);
2888 comma_type = Qcomma;
2889 }
2890
2891 value = read0 (readcharfun);
2892 return Fcons (comma_type, Fcons (value, Qnil));
2893 }
2894 else
2895 {
2896 Vold_style_backquotes = Qt;
2897 goto default_label;
2898 }
2899 }
2900 case '?':
2901 {
2902 int modifiers;
2903 int next_char;
2904 bool ok;
2905
2906 c = READCHAR;
2907 if (c < 0)
2908 end_of_file_error ();
2909
2910 /* Accept `single space' syntax like (list ? x) where the
2911 whitespace character is SPC or TAB.
2912 Other literal whitespace like NL, CR, and FF are not accepted,
2913 as there are well-established escape sequences for these. */
2914 if (c == ' ' || c == '\t')
2915 return make_number (c);
2916
2917 if (c == '\\')
2918 c = read_escape (readcharfun, 0);
2919 modifiers = c & CHAR_MODIFIER_MASK;
2920 c &= ~CHAR_MODIFIER_MASK;
2921 if (CHAR_BYTE8_P (c))
2922 c = CHAR_TO_BYTE8 (c);
2923 c |= modifiers;
2924
2925 next_char = READCHAR;
2926 ok = (next_char <= 040
2927 || (next_char < 0200
2928 && strchr ("\"';()[]#?`,.", next_char) != NULL));
2929 UNREAD (next_char);
2930 if (ok)
2931 return make_number (c);
2932
2933 invalid_syntax ("?");
2934 }
2935
2936 case '"':
2937 {
2938 char *p = read_buffer;
2939 char *end = read_buffer + read_buffer_size;
2940 int ch;
2941 /* True if we saw an escape sequence specifying
2942 a multibyte character. */
2943 bool force_multibyte = 0;
2944 /* True if we saw an escape sequence specifying
2945 a single-byte character. */
2946 bool force_singlebyte = 0;
2947 bool cancel = 0;
2948 ptrdiff_t nchars = 0;
2949
2950 while ((ch = READCHAR) >= 0
2951 && ch != '\"')
2952 {
2953 if (end - p < MAX_MULTIBYTE_LENGTH)
2954 {
2955 ptrdiff_t offset = p - read_buffer;
2956 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
2957 memory_full (SIZE_MAX);
2958 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
2959 read_buffer_size *= 2;
2960 p = read_buffer + offset;
2961 end = read_buffer + read_buffer_size;
2962 }
2963
2964 if (ch == '\\')
2965 {
2966 int modifiers;
2967
2968 ch = read_escape (readcharfun, 1);
2969
2970 /* CH is -1 if \ newline has just been seen. */
2971 if (ch == -1)
2972 {
2973 if (p == read_buffer)
2974 cancel = 1;
2975 continue;
2976 }
2977
2978 modifiers = ch & CHAR_MODIFIER_MASK;
2979 ch = ch & ~CHAR_MODIFIER_MASK;
2980
2981 if (CHAR_BYTE8_P (ch))
2982 force_singlebyte = 1;
2983 else if (! ASCII_CHAR_P (ch))
2984 force_multibyte = 1;
2985 else /* I.e. ASCII_CHAR_P (ch). */
2986 {
2987 /* Allow `\C- ' and `\C-?'. */
2988 if (modifiers == CHAR_CTL)
2989 {
2990 if (ch == ' ')
2991 ch = 0, modifiers = 0;
2992 else if (ch == '?')
2993 ch = 127, modifiers = 0;
2994 }
2995 if (modifiers & CHAR_SHIFT)
2996 {
2997 /* Shift modifier is valid only with [A-Za-z]. */
2998 if (ch >= 'A' && ch <= 'Z')
2999 modifiers &= ~CHAR_SHIFT;
3000 else if (ch >= 'a' && ch <= 'z')
3001 ch -= ('a' - 'A'), modifiers &= ~CHAR_SHIFT;
3002 }
3003
3004 if (modifiers & CHAR_META)
3005 {
3006 /* Move the meta bit to the right place for a
3007 string. */
3008 modifiers &= ~CHAR_META;
3009 ch = BYTE8_TO_CHAR (ch | 0x80);
3010 force_singlebyte = 1;
3011 }
3012 }
3013
3014 /* Any modifiers remaining are invalid. */
3015 if (modifiers)
3016 error ("Invalid modifier in string");
3017 p += CHAR_STRING (ch, (unsigned char *) p);
3018 }
3019 else
3020 {
3021 p += CHAR_STRING (ch, (unsigned char *) p);
3022 if (CHAR_BYTE8_P (ch))
3023 force_singlebyte = 1;
3024 else if (! ASCII_CHAR_P (ch))
3025 force_multibyte = 1;
3026 }
3027 nchars++;
3028 }
3029
3030 if (ch < 0)
3031 end_of_file_error ();
3032
3033 /* If purifying, and string starts with \ newline,
3034 return zero instead. This is for doc strings
3035 that we are really going to find in etc/DOC.nn.nn. */
3036 if (!NILP (Vpurify_flag) && NILP (Vdoc_file_name) && cancel)
3037 return make_number (0);
3038
3039 if (! force_multibyte && force_singlebyte)
3040 {
3041 /* READ_BUFFER contains raw 8-bit bytes and no multibyte
3042 forms. Convert it to unibyte. */
3043 nchars = str_as_unibyte ((unsigned char *) read_buffer,
3044 p - read_buffer);
3045 p = read_buffer + nchars;
3046 }
3047
3048 return make_specified_string (read_buffer, nchars, p - read_buffer,
3049 (force_multibyte
3050 || (p - read_buffer != nchars)));
3051 }
3052
3053 case '.':
3054 {
3055 int next_char = READCHAR;
3056 UNREAD (next_char);
3057
3058 if (next_char <= 040
3059 || (next_char < 0200
3060 && strchr ("\"';([#?`,", next_char) != NULL))
3061 {
3062 *pch = c;
3063 return Qnil;
3064 }
3065
3066 /* Otherwise, we fall through! Note that the atom-reading loop
3067 below will now loop at least once, assuring that we will not
3068 try to UNREAD two characters in a row. */
3069 }
3070 default:
3071 default_label:
3072 if (c <= 040) goto retry;
3073 if (c == 0xa0) /* NBSP */
3074 goto retry;
3075
3076 read_symbol:
3077 {
3078 char *p = read_buffer;
3079 bool quoted = 0;
3080 EMACS_INT start_position = readchar_count - 1;
3081
3082 {
3083 char *end = read_buffer + read_buffer_size;
3084
3085 do
3086 {
3087 if (end - p < MAX_MULTIBYTE_LENGTH)
3088 {
3089 ptrdiff_t offset = p - read_buffer;
3090 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
3091 memory_full (SIZE_MAX);
3092 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
3093 read_buffer_size *= 2;
3094 p = read_buffer + offset;
3095 end = read_buffer + read_buffer_size;
3096 }
3097
3098 if (c == '\\')
3099 {
3100 c = READCHAR;
3101 if (c == -1)
3102 end_of_file_error ();
3103 quoted = 1;
3104 }
3105
3106 if (multibyte)
3107 p += CHAR_STRING (c, (unsigned char *) p);
3108 else
3109 *p++ = c;
3110 c = READCHAR;
3111 }
3112 while (c > 040
3113 && c != 0xa0 /* NBSP */
3114 && (c >= 0200
3115 || strchr ("\"';()[]#`,", c) == NULL));
3116
3117 if (p == end)
3118 {
3119 ptrdiff_t offset = p - read_buffer;
3120 if (min (PTRDIFF_MAX, SIZE_MAX) / 2 < read_buffer_size)
3121 memory_full (SIZE_MAX);
3122 read_buffer = xrealloc (read_buffer, read_buffer_size * 2);
3123 read_buffer_size *= 2;
3124 p = read_buffer + offset;
3125 end = read_buffer + read_buffer_size;
3126 }
3127 *p = 0;
3128 UNREAD (c);
3129 }
3130
3131 if (!quoted && !uninterned_symbol)
3132 {
3133 Lisp_Object result = string_to_number (read_buffer, 10, 0);
3134 if (! NILP (result))
3135 return result;
3136 }
3137 {
3138 Lisp_Object name, result;
3139 ptrdiff_t nbytes = p - read_buffer;
3140 ptrdiff_t nchars
3141 = (multibyte
3142 ? multibyte_chars_in_text ((unsigned char *) read_buffer,
3143 nbytes)
3144 : nbytes);
3145
3146 name = ((uninterned_symbol && ! NILP (Vpurify_flag)
3147 ? make_pure_string : make_specified_string)
3148 (read_buffer, nchars, nbytes, multibyte));
3149 result = (uninterned_symbol ? Fmake_symbol (name)
3150 : Fintern (name, Qnil));
3151
3152 if (EQ (Vread_with_symbol_positions, Qt)
3153 || EQ (Vread_with_symbol_positions, readcharfun))
3154 Vread_symbol_positions_list
3155 = Fcons (Fcons (result, make_number (start_position)),
3156 Vread_symbol_positions_list);
3157 return result;
3158 }
3159 }
3160 }
3161 }
3162 \f
3163
3164 /* List of nodes we've seen during substitute_object_in_subtree. */
3165 static Lisp_Object seen_list;
3166
3167 static void
3168 substitute_object_in_subtree (Lisp_Object object, Lisp_Object placeholder)
3169 {
3170 Lisp_Object check_object;
3171
3172 /* We haven't seen any objects when we start. */
3173 seen_list = Qnil;
3174
3175 /* Make all the substitutions. */
3176 check_object
3177 = substitute_object_recurse (object, placeholder, object);
3178
3179 /* Clear seen_list because we're done with it. */
3180 seen_list = Qnil;
3181
3182 /* The returned object here is expected to always eq the
3183 original. */
3184 if (!EQ (check_object, object))
3185 error ("Unexpected mutation error in reader");
3186 }
3187
3188 /* Feval doesn't get called from here, so no gc protection is needed. */
3189 #define SUBSTITUTE(get_val, set_val) \
3190 do { \
3191 Lisp_Object old_value = get_val; \
3192 Lisp_Object true_value \
3193 = substitute_object_recurse (object, placeholder, \
3194 old_value); \
3195 \
3196 if (!EQ (old_value, true_value)) \
3197 { \
3198 set_val; \
3199 } \
3200 } while (0)
3201
3202 static Lisp_Object
3203 substitute_object_recurse (Lisp_Object object, Lisp_Object placeholder, Lisp_Object subtree)
3204 {
3205 /* If we find the placeholder, return the target object. */
3206 if (EQ (placeholder, subtree))
3207 return object;
3208
3209 /* If we've been to this node before, don't explore it again. */
3210 if (!EQ (Qnil, Fmemq (subtree, seen_list)))
3211 return subtree;
3212
3213 /* If this node can be the entry point to a cycle, remember that
3214 we've seen it. It can only be such an entry point if it was made
3215 by #n=, which means that we can find it as a value in
3216 read_objects. */
3217 if (!EQ (Qnil, Frassq (subtree, read_objects)))
3218 seen_list = Fcons (subtree, seen_list);
3219
3220 /* Recurse according to subtree's type.
3221 Every branch must return a Lisp_Object. */
3222 switch (XTYPE (subtree))
3223 {
3224 case Lisp_Vectorlike:
3225 {
3226 ptrdiff_t i, length = 0;
3227 if (BOOL_VECTOR_P (subtree))
3228 return subtree; /* No sub-objects anyway. */
3229 else if (CHAR_TABLE_P (subtree) || SUB_CHAR_TABLE_P (subtree)
3230 || COMPILEDP (subtree))
3231 length = ASIZE (subtree) & PSEUDOVECTOR_SIZE_MASK;
3232 else if (VECTORP (subtree))
3233 length = ASIZE (subtree);
3234 else
3235 /* An unknown pseudovector may contain non-Lisp fields, so we
3236 can't just blindly traverse all its fields. We used to call
3237 `Flength' which signaled `sequencep', so I just preserved this
3238 behavior. */
3239 wrong_type_argument (Qsequencep, subtree);
3240
3241 for (i = 0; i < length; i++)
3242 SUBSTITUTE (AREF (subtree, i),
3243 ASET (subtree, i, true_value));
3244 return subtree;
3245 }
3246
3247 case Lisp_Cons:
3248 {
3249 SUBSTITUTE (XCAR (subtree),
3250 XSETCAR (subtree, true_value));
3251 SUBSTITUTE (XCDR (subtree),
3252 XSETCDR (subtree, true_value));
3253 return subtree;
3254 }
3255
3256 case Lisp_String:
3257 {
3258 /* Check for text properties in each interval.
3259 substitute_in_interval contains part of the logic. */
3260
3261 INTERVAL root_interval = string_intervals (subtree);
3262 Lisp_Object arg = Fcons (object, placeholder);
3263
3264 traverse_intervals_noorder (root_interval,
3265 &substitute_in_interval, arg);
3266
3267 return subtree;
3268 }
3269
3270 /* Other types don't recurse any further. */
3271 default:
3272 return subtree;
3273 }
3274 }
3275
3276 /* Helper function for substitute_object_recurse. */
3277 static void
3278 substitute_in_interval (INTERVAL interval, Lisp_Object arg)
3279 {
3280 Lisp_Object object = Fcar (arg);
3281 Lisp_Object placeholder = Fcdr (arg);
3282
3283 SUBSTITUTE (interval->plist, set_interval_plist (interval, true_value));
3284 }
3285
3286 \f
3287 #define LEAD_INT 1
3288 #define DOT_CHAR 2
3289 #define TRAIL_INT 4
3290 #define E_EXP 16
3291
3292
3293 /* Convert STRING to a number, assuming base BASE. Return a fixnum if CP has
3294 integer syntax and fits in a fixnum, else return the nearest float if CP has
3295 either floating point or integer syntax and BASE is 10, else return nil. If
3296 IGNORE_TRAILING, consider just the longest prefix of CP that has
3297 valid floating point syntax. Signal an overflow if BASE is not 10 and the
3298 number has integer syntax but does not fit. */
3299
3300 Lisp_Object
3301 string_to_number (char const *string, int base, bool ignore_trailing)
3302 {
3303 int state;
3304 char const *cp = string;
3305 int leading_digit;
3306 bool float_syntax = 0;
3307 double value = 0;
3308
3309 /* Compute NaN and infinities using a variable, to cope with compilers that
3310 think they are smarter than we are. */
3311 double zero = 0;
3312
3313 /* Negate the value ourselves. This treats 0, NaNs, and infinity properly on
3314 IEEE floating point hosts, and works around a formerly-common bug where
3315 atof ("-0.0") drops the sign. */
3316 bool negative = *cp == '-';
3317
3318 bool signedp = negative || *cp == '+';
3319 cp += signedp;
3320
3321 state = 0;
3322
3323 leading_digit = digit_to_number (*cp, base);
3324 if (leading_digit >= 0)
3325 {
3326 state |= LEAD_INT;
3327 do
3328 ++cp;
3329 while (digit_to_number (*cp, base) >= 0);
3330 }
3331 if (*cp == '.')
3332 {
3333 state |= DOT_CHAR;
3334 cp++;
3335 }
3336
3337 if (base == 10)
3338 {
3339 if ('0' <= *cp && *cp <= '9')
3340 {
3341 state |= TRAIL_INT;
3342 do
3343 cp++;
3344 while ('0' <= *cp && *cp <= '9');
3345 }
3346 if (*cp == 'e' || *cp == 'E')
3347 {
3348 char const *ecp = cp;
3349 cp++;
3350 if (*cp == '+' || *cp == '-')
3351 cp++;
3352 if ('0' <= *cp && *cp <= '9')
3353 {
3354 state |= E_EXP;
3355 do
3356 cp++;
3357 while ('0' <= *cp && *cp <= '9');
3358 }
3359 else if (cp[-1] == '+'
3360 && cp[0] == 'I' && cp[1] == 'N' && cp[2] == 'F')
3361 {
3362 state |= E_EXP;
3363 cp += 3;
3364 value = 1.0 / zero;
3365 }
3366 else if (cp[-1] == '+'
3367 && cp[0] == 'N' && cp[1] == 'a' && cp[2] == 'N')
3368 {
3369 state |= E_EXP;
3370 cp += 3;
3371 value = zero / zero;
3372
3373 /* If that made a "negative" NaN, negate it. */
3374 {
3375 int i;
3376 union { double d; char c[sizeof (double)]; }
3377 u_data, u_minus_zero;
3378 u_data.d = value;
3379 u_minus_zero.d = -0.0;
3380 for (i = 0; i < sizeof (double); i++)
3381 if (u_data.c[i] & u_minus_zero.c[i])
3382 {
3383 value = -value;
3384 break;
3385 }
3386 }
3387 /* Now VALUE is a positive NaN. */
3388 }
3389 else
3390 cp = ecp;
3391 }
3392
3393 float_syntax = ((state & (DOT_CHAR|TRAIL_INT)) == (DOT_CHAR|TRAIL_INT)
3394 || state == (LEAD_INT|E_EXP));
3395 }
3396
3397 /* Return nil if the number uses invalid syntax. If IGNORE_TRAILING, accept
3398 any prefix that matches. Otherwise, the entire string must match. */
3399 if (! (ignore_trailing
3400 ? ((state & LEAD_INT) != 0 || float_syntax)
3401 : (!*cp && ((state & ~DOT_CHAR) == LEAD_INT || float_syntax))))
3402 return Qnil;
3403
3404 /* If the number uses integer and not float syntax, and is in C-language
3405 range, use its value, preferably as a fixnum. */
3406 if (leading_digit >= 0 && ! float_syntax)
3407 {
3408 uintmax_t n;
3409
3410 /* Fast special case for single-digit integers. This also avoids a
3411 glitch when BASE is 16 and IGNORE_TRAILING, because in that
3412 case some versions of strtoumax accept numbers like "0x1" that Emacs
3413 does not allow. */
3414 if (digit_to_number (string[signedp + 1], base) < 0)
3415 return make_number (negative ? -leading_digit : leading_digit);
3416
3417 errno = 0;
3418 n = strtoumax (string + signedp, NULL, base);
3419 if (errno == ERANGE)
3420 {
3421 /* Unfortunately there's no simple and accurate way to convert
3422 non-base-10 numbers that are out of C-language range. */
3423 if (base != 10)
3424 xsignal1 (Qoverflow_error, build_string (string));
3425 }
3426 else if (n <= (negative ? -MOST_NEGATIVE_FIXNUM : MOST_POSITIVE_FIXNUM))
3427 {
3428 EMACS_INT signed_n = n;
3429 return make_number (negative ? -signed_n : signed_n);
3430 }
3431 else
3432 value = n;
3433 }
3434
3435 /* Either the number uses float syntax, or it does not fit into a fixnum.
3436 Convert it from string to floating point, unless the value is already
3437 known because it is an infinity, a NAN, or its absolute value fits in
3438 uintmax_t. */
3439 if (! value)
3440 value = atof (string + signedp);
3441
3442 return make_float (negative ? -value : value);
3443 }
3444
3445 \f
3446 static Lisp_Object
3447 read_vector (Lisp_Object readcharfun, bool bytecodeflag)
3448 {
3449 ptrdiff_t i, size;
3450 Lisp_Object *ptr;
3451 Lisp_Object tem, item, vector;
3452 struct Lisp_Cons *otem;
3453 Lisp_Object len;
3454
3455 tem = read_list (1, readcharfun);
3456 len = Flength (tem);
3457 vector = Fmake_vector (len, Qnil);
3458
3459 size = ASIZE (vector);
3460 ptr = XVECTOR (vector)->contents;
3461 for (i = 0; i < size; i++)
3462 {
3463 item = Fcar (tem);
3464 /* If `load-force-doc-strings' is t when reading a lazily-loaded
3465 bytecode object, the docstring containing the bytecode and
3466 constants values must be treated as unibyte and passed to
3467 Fread, to get the actual bytecode string and constants vector. */
3468 if (bytecodeflag && load_force_doc_strings)
3469 {
3470 if (i == COMPILED_BYTECODE)
3471 {
3472 if (!STRINGP (item))
3473 error ("Invalid byte code");
3474
3475 /* Delay handling the bytecode slot until we know whether
3476 it is lazily-loaded (we can tell by whether the
3477 constants slot is nil). */
3478 ASET (vector, COMPILED_CONSTANTS, item);
3479 item = Qnil;
3480 }
3481 else if (i == COMPILED_CONSTANTS)
3482 {
3483 Lisp_Object bytestr = ptr[COMPILED_CONSTANTS];
3484
3485 if (NILP (item))
3486 {
3487 /* Coerce string to unibyte (like string-as-unibyte,
3488 but without generating extra garbage and
3489 guaranteeing no change in the contents). */
3490 STRING_SET_CHARS (bytestr, SBYTES (bytestr));
3491 STRING_SET_UNIBYTE (bytestr);
3492
3493 item = Fread (Fcons (bytestr, readcharfun));
3494 if (!CONSP (item))
3495 error ("Invalid byte code");
3496
3497 otem = XCONS (item);
3498 bytestr = XCAR (item);
3499 item = XCDR (item);
3500 free_cons (otem);
3501 }
3502
3503 /* Now handle the bytecode slot. */
3504 ASET (vector, COMPILED_BYTECODE, bytestr);
3505 }
3506 else if (i == COMPILED_DOC_STRING
3507 && STRINGP (item)
3508 && ! STRING_MULTIBYTE (item))
3509 {
3510 if (EQ (readcharfun, Qget_emacs_mule_file_char))
3511 item = Fdecode_coding_string (item, Qemacs_mule, Qnil, Qnil);
3512 else
3513 item = Fstring_as_multibyte (item);
3514 }
3515 }
3516 ASET (vector, i, item);
3517 otem = XCONS (tem);
3518 tem = Fcdr (tem);
3519 free_cons (otem);
3520 }
3521 return vector;
3522 }
3523
3524 /* FLAG means check for ] to terminate rather than ) and . */
3525
3526 static Lisp_Object
3527 read_list (bool flag, Lisp_Object readcharfun)
3528 {
3529 Lisp_Object val, tail;
3530 Lisp_Object elt, tem;
3531 struct gcpro gcpro1, gcpro2;
3532 /* 0 is the normal case.
3533 1 means this list is a doc reference; replace it with the number 0.
3534 2 means this list is a doc reference; replace it with the doc string. */
3535 int doc_reference = 0;
3536
3537 /* Initialize this to 1 if we are reading a list. */
3538 bool first_in_list = flag <= 0;
3539
3540 val = Qnil;
3541 tail = Qnil;
3542
3543 while (1)
3544 {
3545 int ch;
3546 GCPRO2 (val, tail);
3547 elt = read1 (readcharfun, &ch, first_in_list);
3548 UNGCPRO;
3549
3550 first_in_list = 0;
3551
3552 /* While building, if the list starts with #$, treat it specially. */
3553 if (EQ (elt, Vload_file_name)
3554 && ! NILP (elt)
3555 && !NILP (Vpurify_flag))
3556 {
3557 if (NILP (Vdoc_file_name))
3558 /* We have not yet called Snarf-documentation, so assume
3559 this file is described in the DOC file
3560 and Snarf-documentation will fill in the right value later.
3561 For now, replace the whole list with 0. */
3562 doc_reference = 1;
3563 else
3564 /* We have already called Snarf-documentation, so make a relative
3565 file name for this file, so it can be found properly
3566 in the installed Lisp directory.
3567 We don't use Fexpand_file_name because that would make
3568 the directory absolute now. */
3569 elt = concat2 (build_string ("../lisp/"),
3570 Ffile_name_nondirectory (elt));
3571 }
3572 else if (EQ (elt, Vload_file_name)
3573 && ! NILP (elt)
3574 && load_force_doc_strings)
3575 doc_reference = 2;
3576
3577 if (ch)
3578 {
3579 if (flag > 0)
3580 {
3581 if (ch == ']')
3582 return val;
3583 invalid_syntax (") or . in a vector");
3584 }
3585 if (ch == ')')
3586 return val;
3587 if (ch == '.')
3588 {
3589 GCPRO2 (val, tail);
3590 if (!NILP (tail))
3591 XSETCDR (tail, read0 (readcharfun));
3592 else
3593 val = read0 (readcharfun);
3594 read1 (readcharfun, &ch, 0);
3595 UNGCPRO;
3596 if (ch == ')')
3597 {
3598 if (doc_reference == 1)
3599 return make_number (0);
3600 if (doc_reference == 2 && INTEGERP (XCDR (val)))
3601 {
3602 char *saved = NULL;
3603 file_offset saved_position;
3604 /* Get a doc string from the file we are loading.
3605 If it's in saved_doc_string, get it from there.
3606
3607 Here, we don't know if the string is a
3608 bytecode string or a doc string. As a
3609 bytecode string must be unibyte, we always
3610 return a unibyte string. If it is actually a
3611 doc string, caller must make it
3612 multibyte. */
3613
3614 /* Position is negative for user variables. */
3615 EMACS_INT pos = eabs (XINT (XCDR (val)));
3616 if (pos >= saved_doc_string_position
3617 && pos < (saved_doc_string_position
3618 + saved_doc_string_length))
3619 {
3620 saved = saved_doc_string;
3621 saved_position = saved_doc_string_position;
3622 }
3623 /* Look in prev_saved_doc_string the same way. */
3624 else if (pos >= prev_saved_doc_string_position
3625 && pos < (prev_saved_doc_string_position
3626 + prev_saved_doc_string_length))
3627 {
3628 saved = prev_saved_doc_string;
3629 saved_position = prev_saved_doc_string_position;
3630 }
3631 if (saved)
3632 {
3633 ptrdiff_t start = pos - saved_position;
3634 ptrdiff_t from, to;
3635
3636 /* Process quoting with ^A,
3637 and find the end of the string,
3638 which is marked with ^_ (037). */
3639 for (from = start, to = start;
3640 saved[from] != 037;)
3641 {
3642 int c = saved[from++];
3643 if (c == 1)
3644 {
3645 c = saved[from++];
3646 saved[to++] = (c == 1 ? c
3647 : c == '0' ? 0
3648 : c == '_' ? 037
3649 : c);
3650 }
3651 else
3652 saved[to++] = c;
3653 }
3654
3655 return make_unibyte_string (saved + start,
3656 to - start);
3657 }
3658 else
3659 return get_doc_string (val, 1, 0);
3660 }
3661
3662 return val;
3663 }
3664 invalid_syntax (". in wrong context");
3665 }
3666 invalid_syntax ("] in a list");
3667 }
3668 tem = Fcons (elt, Qnil);
3669 if (!NILP (tail))
3670 XSETCDR (tail, tem);
3671 else
3672 val = tem;
3673 tail = tem;
3674 }
3675 }
3676 \f
3677 static Lisp_Object initial_obarray;
3678
3679 /* `oblookup' stores the bucket number here, for the sake of Funintern. */
3680
3681 static size_t oblookup_last_bucket_number;
3682
3683 /* Get an error if OBARRAY is not an obarray.
3684 If it is one, return it. */
3685
3686 Lisp_Object
3687 check_obarray (Lisp_Object obarray)
3688 {
3689 if (!VECTORP (obarray) || ASIZE (obarray) == 0)
3690 {
3691 /* If Vobarray is now invalid, force it to be valid. */
3692 if (EQ (Vobarray, obarray)) Vobarray = initial_obarray;
3693 wrong_type_argument (Qvectorp, obarray);
3694 }
3695 return obarray;
3696 }
3697
3698 /* Intern the C string STR: return a symbol with that name,
3699 interned in the current obarray. */
3700
3701 Lisp_Object
3702 intern_1 (const char *str, ptrdiff_t len)
3703 {
3704 Lisp_Object obarray = check_obarray (Vobarray);
3705 Lisp_Object tem = oblookup (obarray, str, len, len);
3706
3707 return SYMBOLP (tem) ? tem : Fintern (make_string (str, len), obarray);
3708 }
3709
3710 Lisp_Object
3711 intern_c_string_1 (const char *str, ptrdiff_t len)
3712 {
3713 Lisp_Object obarray = check_obarray (Vobarray);
3714 Lisp_Object tem = oblookup (obarray, str, len, len);
3715
3716 if (SYMBOLP (tem))
3717 return tem;
3718
3719 if (NILP (Vpurify_flag))
3720 /* Creating a non-pure string from a string literal not
3721 implemented yet. We could just use make_string here and live
3722 with the extra copy. */
3723 emacs_abort ();
3724
3725 return Fintern (make_pure_c_string (str, len), obarray);
3726 }
3727 \f
3728 DEFUN ("intern", Fintern, Sintern, 1, 2, 0,
3729 doc: /* Return the canonical symbol whose name is STRING.
3730 If there is none, one is created by this function and returned.
3731 A second optional argument specifies the obarray to use;
3732 it defaults to the value of `obarray'. */)
3733 (Lisp_Object string, Lisp_Object obarray)
3734 {
3735 register Lisp_Object tem, sym, *ptr;
3736
3737 if (NILP (obarray)) obarray = Vobarray;
3738 obarray = check_obarray (obarray);
3739
3740 CHECK_STRING (string);
3741
3742 tem = oblookup (obarray, SSDATA (string),
3743 SCHARS (string),
3744 SBYTES (string));
3745 if (!INTEGERP (tem))
3746 return tem;
3747
3748 if (!NILP (Vpurify_flag))
3749 string = Fpurecopy (string);
3750 sym = Fmake_symbol (string);
3751
3752 if (EQ (obarray, initial_obarray))
3753 XSYMBOL (sym)->interned = SYMBOL_INTERNED_IN_INITIAL_OBARRAY;
3754 else
3755 XSYMBOL (sym)->interned = SYMBOL_INTERNED;
3756
3757 if ((SREF (string, 0) == ':')
3758 && EQ (obarray, initial_obarray))
3759 {
3760 XSYMBOL (sym)->constant = 1;
3761 XSYMBOL (sym)->redirect = SYMBOL_PLAINVAL;
3762 SET_SYMBOL_VAL (XSYMBOL (sym), sym);
3763 }
3764
3765 ptr = aref_addr (obarray, XINT(tem));
3766 if (SYMBOLP (*ptr))
3767 set_symbol_next (sym, XSYMBOL (*ptr));
3768 else
3769 set_symbol_next (sym, NULL);
3770 *ptr = sym;
3771 return sym;
3772 }
3773
3774 DEFUN ("intern-soft", Fintern_soft, Sintern_soft, 1, 2, 0,
3775 doc: /* Return the canonical symbol named NAME, or nil if none exists.
3776 NAME may be a string or a symbol. If it is a symbol, that exact
3777 symbol is searched for.
3778 A second optional argument specifies the obarray to use;
3779 it defaults to the value of `obarray'. */)
3780 (Lisp_Object name, Lisp_Object obarray)
3781 {
3782 register Lisp_Object tem, string;
3783
3784 if (NILP (obarray)) obarray = Vobarray;
3785 obarray = check_obarray (obarray);
3786
3787 if (!SYMBOLP (name))
3788 {
3789 CHECK_STRING (name);
3790 string = name;
3791 }
3792 else
3793 string = SYMBOL_NAME (name);
3794
3795 tem = oblookup (obarray, SSDATA (string), SCHARS (string), SBYTES (string));
3796 if (INTEGERP (tem) || (SYMBOLP (name) && !EQ (name, tem)))
3797 return Qnil;
3798 else
3799 return tem;
3800 }
3801 \f
3802 DEFUN ("unintern", Funintern, Sunintern, 1, 2, 0,
3803 doc: /* Delete the symbol named NAME, if any, from OBARRAY.
3804 The value is t if a symbol was found and deleted, nil otherwise.
3805 NAME may be a string or a symbol. If it is a symbol, that symbol
3806 is deleted, if it belongs to OBARRAY--no other symbol is deleted.
3807 OBARRAY defaults to the value of the variable `obarray'. */)
3808 (Lisp_Object name, Lisp_Object obarray)
3809 {
3810 register Lisp_Object string, tem;
3811 size_t hash;
3812
3813 if (NILP (obarray)) obarray = Vobarray;
3814 obarray = check_obarray (obarray);
3815
3816 if (SYMBOLP (name))
3817 string = SYMBOL_NAME (name);
3818 else
3819 {
3820 CHECK_STRING (name);
3821 string = name;
3822 }
3823
3824 tem = oblookup (obarray, SSDATA (string),
3825 SCHARS (string),
3826 SBYTES (string));
3827 if (INTEGERP (tem))
3828 return Qnil;
3829 /* If arg was a symbol, don't delete anything but that symbol itself. */
3830 if (SYMBOLP (name) && !EQ (name, tem))
3831 return Qnil;
3832
3833 /* There are plenty of other symbols which will screw up the Emacs
3834 session if we unintern them, as well as even more ways to use
3835 `setq' or `fset' or whatnot to make the Emacs session
3836 unusable. Let's not go down this silly road. --Stef */
3837 /* if (EQ (tem, Qnil) || EQ (tem, Qt))
3838 error ("Attempt to unintern t or nil"); */
3839
3840 XSYMBOL (tem)->interned = SYMBOL_UNINTERNED;
3841
3842 hash = oblookup_last_bucket_number;
3843
3844 if (EQ (AREF (obarray, hash), tem))
3845 {
3846 if (XSYMBOL (tem)->next)
3847 {
3848 Lisp_Object sym;
3849 XSETSYMBOL (sym, XSYMBOL (tem)->next);
3850 ASET (obarray, hash, sym);
3851 }
3852 else
3853 ASET (obarray, hash, make_number (0));
3854 }
3855 else
3856 {
3857 Lisp_Object tail, following;
3858
3859 for (tail = AREF (obarray, hash);
3860 XSYMBOL (tail)->next;
3861 tail = following)
3862 {
3863 XSETSYMBOL (following, XSYMBOL (tail)->next);
3864 if (EQ (following, tem))
3865 {
3866 set_symbol_next (tail, XSYMBOL (following)->next);
3867 break;
3868 }
3869 }
3870 }
3871
3872 return Qt;
3873 }
3874 \f
3875 /* Return the symbol in OBARRAY whose names matches the string
3876 of SIZE characters (SIZE_BYTE bytes) at PTR.
3877 If there is no such symbol in OBARRAY, return nil.
3878
3879 Also store the bucket number in oblookup_last_bucket_number. */
3880
3881 Lisp_Object
3882 oblookup (Lisp_Object obarray, register const char *ptr, ptrdiff_t size, ptrdiff_t size_byte)
3883 {
3884 size_t hash;
3885 size_t obsize;
3886 register Lisp_Object tail;
3887 Lisp_Object bucket, tem;
3888
3889 obarray = check_obarray (obarray);
3890 obsize = ASIZE (obarray);
3891
3892 /* This is sometimes needed in the middle of GC. */
3893 obsize &= ~ARRAY_MARK_FLAG;
3894 hash = hash_string (ptr, size_byte) % obsize;
3895 bucket = AREF (obarray, hash);
3896 oblookup_last_bucket_number = hash;
3897 if (EQ (bucket, make_number (0)))
3898 ;
3899 else if (!SYMBOLP (bucket))
3900 error ("Bad data in guts of obarray"); /* Like CADR error message. */
3901 else
3902 for (tail = bucket; ; XSETSYMBOL (tail, XSYMBOL (tail)->next))
3903 {
3904 if (SBYTES (SYMBOL_NAME (tail)) == size_byte
3905 && SCHARS (SYMBOL_NAME (tail)) == size
3906 && !memcmp (SDATA (SYMBOL_NAME (tail)), ptr, size_byte))
3907 return tail;
3908 else if (XSYMBOL (tail)->next == 0)
3909 break;
3910 }
3911 XSETINT (tem, hash);
3912 return tem;
3913 }
3914 \f
3915 void
3916 map_obarray (Lisp_Object obarray, void (*fn) (Lisp_Object, Lisp_Object), Lisp_Object arg)
3917 {
3918 ptrdiff_t i;
3919 register Lisp_Object tail;
3920 CHECK_VECTOR (obarray);
3921 for (i = ASIZE (obarray) - 1; i >= 0; i--)
3922 {
3923 tail = AREF (obarray, i);
3924 if (SYMBOLP (tail))
3925 while (1)
3926 {
3927 (*fn) (tail, arg);
3928 if (XSYMBOL (tail)->next == 0)
3929 break;
3930 XSETSYMBOL (tail, XSYMBOL (tail)->next);
3931 }
3932 }
3933 }
3934
3935 static void
3936 mapatoms_1 (Lisp_Object sym, Lisp_Object function)
3937 {
3938 call1 (function, sym);
3939 }
3940
3941 DEFUN ("mapatoms", Fmapatoms, Smapatoms, 1, 2, 0,
3942 doc: /* Call FUNCTION on every symbol in OBARRAY.
3943 OBARRAY defaults to the value of `obarray'. */)
3944 (Lisp_Object function, Lisp_Object obarray)
3945 {
3946 if (NILP (obarray)) obarray = Vobarray;
3947 obarray = check_obarray (obarray);
3948
3949 map_obarray (obarray, mapatoms_1, function);
3950 return Qnil;
3951 }
3952
3953 #define OBARRAY_SIZE 1511
3954
3955 void
3956 init_obarray (void)
3957 {
3958 Lisp_Object oblength;
3959 ptrdiff_t size = 100 + MAX_MULTIBYTE_LENGTH;
3960
3961 XSETFASTINT (oblength, OBARRAY_SIZE);
3962
3963 Vobarray = Fmake_vector (oblength, make_number (0));
3964 initial_obarray = Vobarray;
3965 staticpro (&initial_obarray);
3966
3967 Qunbound = Fmake_symbol (build_pure_c_string ("unbound"));
3968 /* Set temporary dummy values to Qnil and Vpurify_flag to satisfy the
3969 NILP (Vpurify_flag) check in intern_c_string. */
3970 Qnil = make_number (-1); Vpurify_flag = make_number (1);
3971 Qnil = intern_c_string ("nil");
3972
3973 /* Fmake_symbol inits fields of new symbols with Qunbound and Qnil,
3974 so those two need to be fixed manually. */
3975 SET_SYMBOL_VAL (XSYMBOL (Qunbound), Qunbound);
3976 set_symbol_function (Qunbound, Qnil);
3977 set_symbol_plist (Qunbound, Qnil);
3978 SET_SYMBOL_VAL (XSYMBOL (Qnil), Qnil);
3979 XSYMBOL (Qnil)->constant = 1;
3980 XSYMBOL (Qnil)->declared_special = 1;
3981 set_symbol_plist (Qnil, Qnil);
3982 set_symbol_function (Qnil, Qnil);
3983
3984 Qt = intern_c_string ("t");
3985 SET_SYMBOL_VAL (XSYMBOL (Qt), Qt);
3986 XSYMBOL (Qnil)->declared_special = 1;
3987 XSYMBOL (Qt)->constant = 1;
3988
3989 /* Qt is correct even if CANNOT_DUMP. loadup.el will set to nil at end. */
3990 Vpurify_flag = Qt;
3991
3992 DEFSYM (Qvariable_documentation, "variable-documentation");
3993
3994 read_buffer = xmalloc (size);
3995 read_buffer_size = size;
3996 }
3997 \f
3998 void
3999 defsubr (struct Lisp_Subr *sname)
4000 {
4001 Lisp_Object sym, tem;
4002 sym = intern_c_string (sname->symbol_name);
4003 XSETPVECTYPE (sname, PVEC_SUBR);
4004 XSETSUBR (tem, sname);
4005 set_symbol_function (sym, tem);
4006 }
4007
4008 #ifdef NOTDEF /* Use fset in subr.el now! */
4009 void
4010 defalias (struct Lisp_Subr *sname, char *string)
4011 {
4012 Lisp_Object sym;
4013 sym = intern (string);
4014 XSETSUBR (XSYMBOL (sym)->function, sname);
4015 }
4016 #endif /* NOTDEF */
4017
4018 /* Define an "integer variable"; a symbol whose value is forwarded to a
4019 C variable of type EMACS_INT. Sample call (with "xx" to fool make-docfile):
4020 DEFxxVAR_INT ("emacs-priority", &emacs_priority, "Documentation"); */
4021 void
4022 defvar_int (struct Lisp_Intfwd *i_fwd,
4023 const char *namestring, EMACS_INT *address)
4024 {
4025 Lisp_Object sym;
4026 sym = intern_c_string (namestring);
4027 i_fwd->type = Lisp_Fwd_Int;
4028 i_fwd->intvar = address;
4029 XSYMBOL (sym)->declared_special = 1;
4030 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4031 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)i_fwd);
4032 }
4033
4034 /* Similar but define a variable whose value is t if address contains 1,
4035 nil if address contains 0. */
4036 void
4037 defvar_bool (struct Lisp_Boolfwd *b_fwd,
4038 const char *namestring, bool *address)
4039 {
4040 Lisp_Object sym;
4041 sym = intern_c_string (namestring);
4042 b_fwd->type = Lisp_Fwd_Bool;
4043 b_fwd->boolvar = address;
4044 XSYMBOL (sym)->declared_special = 1;
4045 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4046 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)b_fwd);
4047 Vbyte_boolean_vars = Fcons (sym, Vbyte_boolean_vars);
4048 }
4049
4050 /* Similar but define a variable whose value is the Lisp Object stored
4051 at address. Two versions: with and without gc-marking of the C
4052 variable. The nopro version is used when that variable will be
4053 gc-marked for some other reason, since marking the same slot twice
4054 can cause trouble with strings. */
4055 void
4056 defvar_lisp_nopro (struct Lisp_Objfwd *o_fwd,
4057 const char *namestring, Lisp_Object *address)
4058 {
4059 Lisp_Object sym;
4060 sym = intern_c_string (namestring);
4061 o_fwd->type = Lisp_Fwd_Obj;
4062 o_fwd->objvar = address;
4063 XSYMBOL (sym)->declared_special = 1;
4064 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4065 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)o_fwd);
4066 }
4067
4068 void
4069 defvar_lisp (struct Lisp_Objfwd *o_fwd,
4070 const char *namestring, Lisp_Object *address)
4071 {
4072 defvar_lisp_nopro (o_fwd, namestring, address);
4073 staticpro (address);
4074 }
4075
4076 /* Similar but define a variable whose value is the Lisp Object stored
4077 at a particular offset in the current kboard object. */
4078
4079 void
4080 defvar_kboard (struct Lisp_Kboard_Objfwd *ko_fwd,
4081 const char *namestring, int offset)
4082 {
4083 Lisp_Object sym;
4084 sym = intern_c_string (namestring);
4085 ko_fwd->type = Lisp_Fwd_Kboard_Obj;
4086 ko_fwd->offset = offset;
4087 XSYMBOL (sym)->declared_special = 1;
4088 XSYMBOL (sym)->redirect = SYMBOL_FORWARDED;
4089 SET_SYMBOL_FWD (XSYMBOL (sym), (union Lisp_Fwd *)ko_fwd);
4090 }
4091 \f
4092 /* Check that the elements of Vload_path exist. */
4093
4094 static void
4095 load_path_check (void)
4096 {
4097 Lisp_Object path_tail;
4098
4099 /* The only elements that might not exist are those from
4100 PATH_LOADSEARCH, EMACSLOADPATH. Anything else is only added if
4101 it exists. */
4102 for (path_tail = Vload_path; !NILP (path_tail); path_tail = XCDR (path_tail))
4103 {
4104 Lisp_Object dirfile;
4105 dirfile = Fcar (path_tail);
4106 if (STRINGP (dirfile))
4107 {
4108 dirfile = Fdirectory_file_name (dirfile);
4109 if (! file_accessible_directory_p (SSDATA (dirfile)))
4110 dir_warning ("Lisp directory", XCAR (path_tail));
4111 }
4112 }
4113 }
4114
4115 /* Record the value of load-path used at the start of dumping
4116 so we can see if the site changed it later during dumping. */
4117 static Lisp_Object dump_path;
4118
4119 /* Compute the default Vload_path, with the following logic:
4120 If CANNOT_DUMP:
4121 use EMACSLOADPATH env-var if set; otherwise use PATH_LOADSEARCH,
4122 prepending PATH_SITELOADSEARCH unless --no-site-lisp.
4123 The remainder is what happens when dumping works:
4124 If purify-flag (ie dumping) just use PATH_DUMPLOADSEARCH.
4125 Otherwise use EMACSLOADPATH if set, else PATH_LOADSEARCH.
4126
4127 If !initialized, then just set both Vload_path and dump_path.
4128 If initialized, then if Vload_path != dump_path, do nothing.
4129 (Presumably the load-path has already been changed by something.
4130 This can only be from a site-load file during dumping,
4131 or because EMACSLOADPATH is set.)
4132 If Vinstallation_directory is not nil (ie, running uninstalled):
4133 If installation-dir/lisp exists and not already a member,
4134 we must be running uninstalled. Reset the load-path
4135 to just installation-dir/lisp. (The default PATH_LOADSEARCH
4136 refers to the eventual installation directories. Since we
4137 are not yet installed, we should not use them, even if they exist.)
4138 If installation-dir/lisp does not exist, just add dump_path at the
4139 end instead.
4140 Add installation-dir/leim (if exists and not already a member) at the front.
4141 Add installation-dir/site-lisp (if !no_site_lisp, and exists
4142 and not already a member) at the front.
4143 If installation-dir != source-dir (ie running an uninstalled,
4144 out-of-tree build) AND install-dir/src/Makefile exists BUT
4145 install-dir/src/Makefile.in does NOT exist (this is a sanity
4146 check), then repeat the above steps for source-dir/lisp,
4147 leim and site-lisp.
4148 Finally, add the site-lisp directories at the front (if !no_site_lisp).
4149 */
4150
4151 void
4152 init_lread (void)
4153 {
4154 const char *normal;
4155
4156 #ifdef CANNOT_DUMP
4157 #ifdef HAVE_NS
4158 const char *loadpath = ns_load_path ();
4159 #endif
4160
4161 normal = PATH_LOADSEARCH;
4162 #ifdef HAVE_NS
4163 Vload_path = decode_env_path ("EMACSLOADPATH", loadpath ? loadpath : normal);
4164 #else
4165 Vload_path = decode_env_path ("EMACSLOADPATH", normal);
4166 #endif
4167
4168 load_path_check ();
4169
4170 /* FIXME CANNOT_DUMP platforms should get source-dir/lisp etc added
4171 to their load-path too, AFAICS. I don't think we can tell the
4172 difference between initialized and !initialized in this case,
4173 so we'll have to do it unconditionally when Vinstallation_directory
4174 is non-nil. */
4175 if (!no_site_lisp && !egetenv ("EMACSLOADPATH"))
4176 {
4177 Lisp_Object sitelisp;
4178 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH);
4179 if (! NILP (sitelisp)) Vload_path = nconc2 (sitelisp, Vload_path);
4180 }
4181 #else /* !CANNOT_DUMP */
4182 if (NILP (Vpurify_flag))
4183 {
4184 normal = PATH_LOADSEARCH;
4185 /* If the EMACSLOADPATH environment variable is set, use its value.
4186 This doesn't apply if we're dumping. */
4187 if (egetenv ("EMACSLOADPATH"))
4188 Vload_path = decode_env_path ("EMACSLOADPATH", normal);
4189 }
4190 else
4191 normal = PATH_DUMPLOADSEARCH;
4192
4193 /* In a dumped Emacs, we normally reset the value of Vload_path using
4194 PATH_LOADSEARCH, since the value that was dumped uses lisp/ in
4195 the source directory, instead of the path of the installed elisp
4196 libraries. However, if it appears that Vload_path has already been
4197 changed from the default that was saved before dumping, don't
4198 change it further. Changes can only be due to EMACSLOADPATH, or
4199 site-lisp files that were processed during dumping. */
4200 if (initialized)
4201 {
4202 if (NILP (Fequal (dump_path, Vload_path)))
4203 {
4204 /* Do not make any changes, just check the elements exist. */
4205 /* Note: --no-site-lisp is ignored.
4206 I don't know what to do about this. */
4207 load_path_check ();
4208 }
4209 else
4210 {
4211 #ifdef HAVE_NS
4212 const char *loadpath = ns_load_path ();
4213 Vload_path = decode_env_path (0, loadpath ? loadpath : normal);
4214 #else
4215 Vload_path = decode_env_path (0, normal);
4216 #endif
4217 if (!NILP (Vinstallation_directory))
4218 {
4219 Lisp_Object tem, tem1;
4220
4221 /* Add to the path the lisp subdir of the installation
4222 dir, if it is accessible. Note: in out-of-tree builds,
4223 this directory is empty save for Makefile. */
4224 tem = Fexpand_file_name (build_string ("lisp"),
4225 Vinstallation_directory);
4226 tem1 = Ffile_accessible_directory_p (tem);
4227 if (!NILP (tem1))
4228 {
4229 if (NILP (Fmember (tem, Vload_path)))
4230 {
4231 /* We are running uninstalled. The default load-path
4232 points to the eventual installed lisp, leim
4233 directories. We should not use those now, even
4234 if they exist, so start over from a clean slate. */
4235 Vload_path = Fcons (tem, Qnil);
4236 }
4237 }
4238 else
4239 /* That dir doesn't exist, so add the build-time
4240 Lisp dirs instead. */
4241 Vload_path = nconc2 (Vload_path, dump_path);
4242
4243 /* Add leim under the installation dir, if it is accessible. */
4244 tem = Fexpand_file_name (build_string ("leim"),
4245 Vinstallation_directory);
4246 tem1 = Ffile_accessible_directory_p (tem);
4247 if (!NILP (tem1))
4248 {
4249 if (NILP (Fmember (tem, Vload_path)))
4250 Vload_path = Fcons (tem, Vload_path);
4251 }
4252
4253 /* Add site-lisp under the installation dir, if it exists. */
4254 if (!no_site_lisp)
4255 {
4256 tem = Fexpand_file_name (build_string ("site-lisp"),
4257 Vinstallation_directory);
4258 tem1 = Ffile_accessible_directory_p (tem);
4259 if (!NILP (tem1))
4260 {
4261 if (NILP (Fmember (tem, Vload_path)))
4262 Vload_path = Fcons (tem, Vload_path);
4263 }
4264 }
4265
4266 /* If Emacs was not built in the source directory,
4267 and it is run from where it was built, add to load-path
4268 the lisp, leim and site-lisp dirs under that directory. */
4269
4270 if (NILP (Fequal (Vinstallation_directory, Vsource_directory)))
4271 {
4272 Lisp_Object tem2;
4273
4274 tem = Fexpand_file_name (build_string ("src/Makefile"),
4275 Vinstallation_directory);
4276 tem1 = Ffile_exists_p (tem);
4277
4278 /* Don't be fooled if they moved the entire source tree
4279 AFTER dumping Emacs. If the build directory is indeed
4280 different from the source dir, src/Makefile.in and
4281 src/Makefile will not be found together. */
4282 tem = Fexpand_file_name (build_string ("src/Makefile.in"),
4283 Vinstallation_directory);
4284 tem2 = Ffile_exists_p (tem);
4285 if (!NILP (tem1) && NILP (tem2))
4286 {
4287 tem = Fexpand_file_name (build_string ("lisp"),
4288 Vsource_directory);
4289
4290 if (NILP (Fmember (tem, Vload_path)))
4291 Vload_path = Fcons (tem, Vload_path);
4292
4293 tem = Fexpand_file_name (build_string ("leim"),
4294 Vsource_directory);
4295
4296 if (NILP (Fmember (tem, Vload_path)))
4297 Vload_path = Fcons (tem, Vload_path);
4298
4299 if (!no_site_lisp)
4300 {
4301 tem = Fexpand_file_name (build_string ("site-lisp"),
4302 Vsource_directory);
4303 tem1 = Ffile_accessible_directory_p (tem);
4304 if (!NILP (tem1))
4305 {
4306 if (NILP (Fmember (tem, Vload_path)))
4307 Vload_path = Fcons (tem, Vload_path);
4308 }
4309 }
4310 }
4311 } /* Vinstallation_directory != Vsource_directory */
4312
4313 } /* if Vinstallation_directory */
4314
4315 /* Check before adding the site-lisp directories.
4316 The install should have created them, but they are not
4317 required, so no need to warn if they are absent.
4318 Or we might be running before installation. */
4319 load_path_check ();
4320
4321 /* Add the site-lisp directories at the front. */
4322 if (!no_site_lisp)
4323 {
4324 Lisp_Object sitelisp;
4325 sitelisp = decode_env_path (0, PATH_SITELOADSEARCH);
4326 if (! NILP (sitelisp)) Vload_path = nconc2 (sitelisp, Vload_path);
4327 }
4328 } /* if dump_path == Vload_path */
4329 }
4330 else /* !initialized */
4331 {
4332 /* NORMAL refers to PATH_DUMPLOADSEARCH, ie the lisp dir in the
4333 source directory. We used to add ../lisp (ie the lisp dir in
4334 the build directory) at the front here, but that caused trouble
4335 because it was copied from dump_path into Vload_path, above,
4336 when Vinstallation_directory was non-nil. It should not be
4337 necessary, since in out of tree builds lisp/ is empty, save
4338 for Makefile. */
4339 Vload_path = decode_env_path (0, normal);
4340 dump_path = Vload_path;
4341 /* No point calling load_path_check; load-path only contains essential
4342 elements from the source directory at this point. They cannot
4343 be missing unless something went extremely (and improbably)
4344 wrong, in which case the build will fail in obvious ways. */
4345 }
4346 #endif /* !CANNOT_DUMP */
4347
4348 Vvalues = Qnil;
4349
4350 load_in_progress = 0;
4351 Vload_file_name = Qnil;
4352 Vstandard_input = Qt;
4353 Vloads_in_progress = Qnil;
4354 }
4355
4356 /* Print a warning that directory intended for use USE and with name
4357 DIRNAME cannot be accessed. On entry, errno should correspond to
4358 the access failure. Print the warning on stderr and put it in
4359 *Messages*. */
4360
4361 void
4362 dir_warning (char const *use, Lisp_Object dirname)
4363 {
4364 static char const format[] = "Warning: %s `%s': %s\n";
4365 int access_errno = errno;
4366 fprintf (stderr, format, use, SSDATA (dirname), strerror (access_errno));
4367
4368 /* Don't log the warning before we've initialized!! */
4369 if (initialized)
4370 {
4371 char const *diagnostic = emacs_strerror (access_errno);
4372 USE_SAFE_ALLOCA;
4373 char *buffer = SAFE_ALLOCA (sizeof format - 3 * (sizeof "%s" - 1)
4374 + strlen (use) + SBYTES (dirname)
4375 + strlen (diagnostic));
4376 ptrdiff_t message_len = esprintf (buffer, format, use, SSDATA (dirname),
4377 diagnostic);
4378 message_dolog (buffer, message_len, 0, STRING_MULTIBYTE (dirname));
4379 SAFE_FREE ();
4380 }
4381 }
4382
4383 void
4384 syms_of_lread (void)
4385 {
4386 defsubr (&Sread);
4387 defsubr (&Sread_from_string);
4388 defsubr (&Sintern);
4389 defsubr (&Sintern_soft);
4390 defsubr (&Sunintern);
4391 defsubr (&Sget_load_suffixes);
4392 defsubr (&Sload);
4393 defsubr (&Seval_buffer);
4394 defsubr (&Seval_region);
4395 defsubr (&Sread_char);
4396 defsubr (&Sread_char_exclusive);
4397 defsubr (&Sread_event);
4398 defsubr (&Sget_file_char);
4399 defsubr (&Smapatoms);
4400 defsubr (&Slocate_file_internal);
4401
4402 DEFVAR_LISP ("obarray", Vobarray,
4403 doc: /* Symbol table for use by `intern' and `read'.
4404 It is a vector whose length ought to be prime for best results.
4405 The vector's contents don't make sense if examined from Lisp programs;
4406 to find all the symbols in an obarray, use `mapatoms'. */);
4407
4408 DEFVAR_LISP ("values", Vvalues,
4409 doc: /* List of values of all expressions which were read, evaluated and printed.
4410 Order is reverse chronological. */);
4411 XSYMBOL (intern ("values"))->declared_special = 0;
4412
4413 DEFVAR_LISP ("standard-input", Vstandard_input,
4414 doc: /* Stream for read to get input from.
4415 See documentation of `read' for possible values. */);
4416 Vstandard_input = Qt;
4417
4418 DEFVAR_LISP ("read-with-symbol-positions", Vread_with_symbol_positions,
4419 doc: /* If non-nil, add position of read symbols to `read-symbol-positions-list'.
4420
4421 If this variable is a buffer, then only forms read from that buffer
4422 will be added to `read-symbol-positions-list'.
4423 If this variable is t, then all read forms will be added.
4424 The effect of all other values other than nil are not currently
4425 defined, although they may be in the future.
4426
4427 The positions are relative to the last call to `read' or
4428 `read-from-string'. It is probably a bad idea to set this variable at
4429 the toplevel; bind it instead. */);
4430 Vread_with_symbol_positions = Qnil;
4431
4432 DEFVAR_LISP ("read-symbol-positions-list", Vread_symbol_positions_list,
4433 doc: /* A list mapping read symbols to their positions.
4434 This variable is modified during calls to `read' or
4435 `read-from-string', but only when `read-with-symbol-positions' is
4436 non-nil.
4437
4438 Each element of the list looks like (SYMBOL . CHAR-POSITION), where
4439 CHAR-POSITION is an integer giving the offset of that occurrence of the
4440 symbol from the position where `read' or `read-from-string' started.
4441
4442 Note that a symbol will appear multiple times in this list, if it was
4443 read multiple times. The list is in the same order as the symbols
4444 were read in. */);
4445 Vread_symbol_positions_list = Qnil;
4446
4447 DEFVAR_LISP ("read-circle", Vread_circle,
4448 doc: /* Non-nil means read recursive structures using #N= and #N# syntax. */);
4449 Vread_circle = Qt;
4450
4451 DEFVAR_LISP ("load-path", Vload_path,
4452 doc: /* List of directories to search for files to load.
4453 Each element is a string (directory name) or nil (try default directory).
4454 Initialized based on EMACSLOADPATH environment variable, if any,
4455 otherwise to default specified by file `epaths.h' when Emacs was built. */);
4456
4457 DEFVAR_LISP ("load-suffixes", Vload_suffixes,
4458 doc: /* List of suffixes for (compiled or source) Emacs Lisp files.
4459 This list should not include the empty string.
4460 `load' and related functions try to append these suffixes, in order,
4461 to the specified file name if a Lisp suffix is allowed or required. */);
4462 Vload_suffixes = Fcons (build_pure_c_string (".elc"),
4463 Fcons (build_pure_c_string (".el"), Qnil));
4464 DEFVAR_LISP ("load-file-rep-suffixes", Vload_file_rep_suffixes,
4465 doc: /* List of suffixes that indicate representations of \
4466 the same file.
4467 This list should normally start with the empty string.
4468
4469 Enabling Auto Compression mode appends the suffixes in
4470 `jka-compr-load-suffixes' to this list and disabling Auto Compression
4471 mode removes them again. `load' and related functions use this list to
4472 determine whether they should look for compressed versions of a file
4473 and, if so, which suffixes they should try to append to the file name
4474 in order to do so. However, if you want to customize which suffixes
4475 the loading functions recognize as compression suffixes, you should
4476 customize `jka-compr-load-suffixes' rather than the present variable. */);
4477 Vload_file_rep_suffixes = Fcons (empty_unibyte_string, Qnil);
4478
4479 DEFVAR_BOOL ("load-in-progress", load_in_progress,
4480 doc: /* Non-nil if inside of `load'. */);
4481 DEFSYM (Qload_in_progress, "load-in-progress");
4482
4483 DEFVAR_LISP ("after-load-alist", Vafter_load_alist,
4484 doc: /* An alist of functions to be evalled when particular files are loaded.
4485 Each element looks like (REGEXP-OR-FEATURE FUNCS...).
4486
4487 REGEXP-OR-FEATURE is either a regular expression to match file names, or
4488 a symbol \(a feature name).
4489
4490 When `load' is run and the file-name argument matches an element's
4491 REGEXP-OR-FEATURE, or when `provide' is run and provides the symbol
4492 REGEXP-OR-FEATURE, the FUNCS in the element are called.
4493
4494 An error in FORMS does not undo the load, but does prevent execution of
4495 the rest of the FORMS. */);
4496 Vafter_load_alist = Qnil;
4497
4498 DEFVAR_LISP ("load-history", Vload_history,
4499 doc: /* Alist mapping loaded file names to symbols and features.
4500 Each alist element should be a list (FILE-NAME ENTRIES...), where
4501 FILE-NAME is the name of a file that has been loaded into Emacs.
4502 The file name is absolute and true (i.e. it doesn't contain symlinks).
4503 As an exception, one of the alist elements may have FILE-NAME nil,
4504 for symbols and features not associated with any file.
4505
4506 The remaining ENTRIES in the alist element describe the functions and
4507 variables defined in that file, the features provided, and the
4508 features required. Each entry has the form `(provide . FEATURE)',
4509 `(require . FEATURE)', `(defun . FUNCTION)', `(autoload . SYMBOL)',
4510 `(defface . SYMBOL)', or `(t . SYMBOL)'. Entries like `(t . SYMBOL)'
4511 may precede a `(defun . FUNCTION)' entry, and means that SYMBOL was an
4512 autoload before this file redefined it as a function. In addition,
4513 entries may also be single symbols, which means that SYMBOL was
4514 defined by `defvar' or `defconst'.
4515
4516 During preloading, the file name recorded is relative to the main Lisp
4517 directory. These file names are converted to absolute at startup. */);
4518 Vload_history = Qnil;
4519
4520 DEFVAR_LISP ("load-file-name", Vload_file_name,
4521 doc: /* Full name of file being loaded by `load'. */);
4522 Vload_file_name = Qnil;
4523
4524 DEFVAR_LISP ("user-init-file", Vuser_init_file,
4525 doc: /* File name, including directory, of user's initialization file.
4526 If the file loaded had extension `.elc', and the corresponding source file
4527 exists, this variable contains the name of source file, suitable for use
4528 by functions like `custom-save-all' which edit the init file.
4529 While Emacs loads and evaluates the init file, value is the real name
4530 of the file, regardless of whether or not it has the `.elc' extension. */);
4531 Vuser_init_file = Qnil;
4532
4533 DEFVAR_LISP ("current-load-list", Vcurrent_load_list,
4534 doc: /* Used for internal purposes by `load'. */);
4535 Vcurrent_load_list = Qnil;
4536
4537 DEFVAR_LISP ("load-read-function", Vload_read_function,
4538 doc: /* Function used by `load' and `eval-region' for reading expressions.
4539 The default is nil, which means use the function `read'. */);
4540 Vload_read_function = Qnil;
4541
4542 DEFVAR_LISP ("load-source-file-function", Vload_source_file_function,
4543 doc: /* Function called in `load' to load an Emacs Lisp source file.
4544 The value should be a function for doing code conversion before
4545 reading a source file. It can also be nil, in which case loading is
4546 done without any code conversion.
4547
4548 If the value is a function, it is called with four arguments,
4549 FULLNAME, FILE, NOERROR, NOMESSAGE. FULLNAME is the absolute name of
4550 the file to load, FILE is the non-absolute name (for messages etc.),
4551 and NOERROR and NOMESSAGE are the corresponding arguments passed to
4552 `load'. The function should return t if the file was loaded. */);
4553 Vload_source_file_function = Qnil;
4554
4555 DEFVAR_BOOL ("load-force-doc-strings", load_force_doc_strings,
4556 doc: /* Non-nil means `load' should force-load all dynamic doc strings.
4557 This is useful when the file being loaded is a temporary copy. */);
4558 load_force_doc_strings = 0;
4559
4560 DEFVAR_BOOL ("load-convert-to-unibyte", load_convert_to_unibyte,
4561 doc: /* Non-nil means `read' converts strings to unibyte whenever possible.
4562 This is normally bound by `load' and `eval-buffer' to control `read',
4563 and is not meant for users to change. */);
4564 load_convert_to_unibyte = 0;
4565
4566 DEFVAR_LISP ("source-directory", Vsource_directory,
4567 doc: /* Directory in which Emacs sources were found when Emacs was built.
4568 You cannot count on them to still be there! */);
4569 Vsource_directory
4570 = Fexpand_file_name (build_string ("../"),
4571 Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH)));
4572
4573 DEFVAR_LISP ("preloaded-file-list", Vpreloaded_file_list,
4574 doc: /* List of files that were preloaded (when dumping Emacs). */);
4575 Vpreloaded_file_list = Qnil;
4576
4577 DEFVAR_LISP ("byte-boolean-vars", Vbyte_boolean_vars,
4578 doc: /* List of all DEFVAR_BOOL variables, used by the byte code optimizer. */);
4579 Vbyte_boolean_vars = Qnil;
4580
4581 DEFVAR_BOOL ("load-dangerous-libraries", load_dangerous_libraries,
4582 doc: /* Non-nil means load dangerous compiled Lisp files.
4583 Some versions of XEmacs use different byte codes than Emacs. These
4584 incompatible byte codes can make Emacs crash when it tries to execute
4585 them. */);
4586 load_dangerous_libraries = 0;
4587
4588 DEFVAR_BOOL ("force-load-messages", force_load_messages,
4589 doc: /* Non-nil means force printing messages when loading Lisp files.
4590 This overrides the value of the NOMESSAGE argument to `load'. */);
4591 force_load_messages = 0;
4592
4593 DEFVAR_LISP ("bytecomp-version-regexp", Vbytecomp_version_regexp,
4594 doc: /* Regular expression matching safe to load compiled Lisp files.
4595 When Emacs loads a compiled Lisp file, it reads the first 512 bytes
4596 from the file, and matches them against this regular expression.
4597 When the regular expression matches, the file is considered to be safe
4598 to load. See also `load-dangerous-libraries'. */);
4599 Vbytecomp_version_regexp
4600 = build_pure_c_string ("^;;;.\\(in Emacs version\\|bytecomp version FSF\\)");
4601
4602 DEFSYM (Qlexical_binding, "lexical-binding");
4603 DEFVAR_LISP ("lexical-binding", Vlexical_binding,
4604 doc: /* Whether to use lexical binding when evaluating code.
4605 Non-nil means that the code in the current buffer should be evaluated
4606 with lexical binding.
4607 This variable is automatically set from the file variables of an
4608 interpreted Lisp file read using `load'. Unlike other file local
4609 variables, this must be set in the first line of a file. */);
4610 Vlexical_binding = Qnil;
4611 Fmake_variable_buffer_local (Qlexical_binding);
4612
4613 DEFVAR_LISP ("eval-buffer-list", Veval_buffer_list,
4614 doc: /* List of buffers being read from by calls to `eval-buffer' and `eval-region'. */);
4615 Veval_buffer_list = Qnil;
4616
4617 DEFVAR_LISP ("old-style-backquotes", Vold_style_backquotes,
4618 doc: /* Set to non-nil when `read' encounters an old-style backquote. */);
4619 Vold_style_backquotes = Qnil;
4620 DEFSYM (Qold_style_backquotes, "old-style-backquotes");
4621
4622 /* Vsource_directory was initialized in init_lread. */
4623
4624 DEFSYM (Qcurrent_load_list, "current-load-list");
4625 DEFSYM (Qstandard_input, "standard-input");
4626 DEFSYM (Qread_char, "read-char");
4627 DEFSYM (Qget_file_char, "get-file-char");
4628 DEFSYM (Qget_emacs_mule_file_char, "get-emacs-mule-file-char");
4629 DEFSYM (Qload_force_doc_strings, "load-force-doc-strings");
4630
4631 DEFSYM (Qbackquote, "`");
4632 DEFSYM (Qcomma, ",");
4633 DEFSYM (Qcomma_at, ",@");
4634 DEFSYM (Qcomma_dot, ",.");
4635
4636 DEFSYM (Qinhibit_file_name_operation, "inhibit-file-name-operation");
4637 DEFSYM (Qascii_character, "ascii-character");
4638 DEFSYM (Qfunction, "function");
4639 DEFSYM (Qload, "load");
4640 DEFSYM (Qload_file_name, "load-file-name");
4641 DEFSYM (Qeval_buffer_list, "eval-buffer-list");
4642 DEFSYM (Qfile_truename, "file-truename");
4643 DEFSYM (Qdir_ok, "dir-ok");
4644 DEFSYM (Qdo_after_load_evaluation, "do-after-load-evaluation");
4645
4646 staticpro (&dump_path);
4647
4648 staticpro (&read_objects);
4649 read_objects = Qnil;
4650 staticpro (&seen_list);
4651 seen_list = Qnil;
4652
4653 Vloads_in_progress = Qnil;
4654 staticpro (&Vloads_in_progress);
4655
4656 DEFSYM (Qhash_table, "hash-table");
4657 DEFSYM (Qdata, "data");
4658 DEFSYM (Qtest, "test");
4659 DEFSYM (Qsize, "size");
4660 DEFSYM (Qweakness, "weakness");
4661 DEFSYM (Qrehash_size, "rehash-size");
4662 DEFSYM (Qrehash_threshold, "rehash-threshold");
4663 }