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