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