1 /* Lisp parsing and input streams.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #include <sys/types.h>
27 #include <limits.h> /* for CHAR_BIT */
30 #include "intervals.h"
32 #include "character.h"
39 #include "termhooks.h"
41 #include "blockinput.h"
52 #endif /* HAVE_SETLOCALE */
57 #define file_offset off_t
58 #define file_tell ftello
60 #define file_offset long
61 #define file_tell ftell
64 /* hash table read constants */
65 static Lisp_Object Qhash_table
, Qdata
;
66 static Lisp_Object Qtest
, Qsize
;
67 static Lisp_Object Qweakness
;
68 static Lisp_Object Qrehash_size
;
69 static Lisp_Object Qrehash_threshold
;
71 static Lisp_Object Qread_char
, Qget_file_char
, Qcurrent_load_list
;
72 Lisp_Object Qstandard_input
;
73 Lisp_Object Qvariable_documentation
;
74 static Lisp_Object Qascii_character
, Qload
, Qload_file_name
;
75 Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
76 static Lisp_Object Qinhibit_file_name_operation
;
77 static Lisp_Object Qeval_buffer_list
;
78 static Lisp_Object Qlexical_binding
;
79 static Lisp_Object Qfile_truename
, Qdo_after_load_evaluation
; /* ACM 2006/5/16 */
81 /* Used instead of Qget_file_char while loading *.elc files compiled
82 by Emacs 21 or older. */
83 static Lisp_Object Qget_emacs_mule_file_char
;
85 static Lisp_Object Qload_force_doc_strings
;
87 extern Lisp_Object Qinternal_interpreter_environment
;
89 static Lisp_Object Qload_in_progress
;
91 /* The association list of objects read with the #n=object form.
92 Each member of the list has the form (n . object), and is used to
93 look up the object for the corresponding #n# construct.
94 It must be set to nil before all top-level calls to read0. */
95 static Lisp_Object read_objects
;
97 /* Nonzero means READCHAR should read bytes one by one (not character)
98 when READCHARFUN is Qget_file_char or Qget_emacs_mule_file_char.
99 This is set to 1 by read1 temporarily while handling #@NUMBER. */
100 static int load_each_byte
;
102 /* List of descriptors now open for Fload. */
103 static Lisp_Object load_descriptor_list
;
105 /* File for get_file_char to read from. Use by load. */
106 static FILE *instream
;
108 /* When nonzero, read conses in pure space */
109 static int read_pure
;
111 /* For use within read-from-string (this reader is non-reentrant!!) */
112 static EMACS_INT read_from_string_index
;
113 static EMACS_INT read_from_string_index_byte
;
114 static EMACS_INT read_from_string_limit
;
116 /* Number of characters read in the current call to Fread or
117 Fread_from_string. */
118 static EMACS_INT readchar_count
;
120 /* This contains the last string skipped with #@. */
121 static char *saved_doc_string
;
122 /* Length of buffer allocated in saved_doc_string. */
123 static ptrdiff_t saved_doc_string_size
;
124 /* Length of actual data in saved_doc_string. */
125 static ptrdiff_t saved_doc_string_length
;
126 /* This is the file position that string came from. */
127 static file_offset saved_doc_string_position
;
129 /* This contains the previous string skipped with #@.
130 We copy it from saved_doc_string when a new string
131 is put in saved_doc_string. */
132 static char *prev_saved_doc_string
;
133 /* Length of buffer allocated in prev_saved_doc_string. */
134 static ptrdiff_t prev_saved_doc_string_size
;
135 /* Length of actual data in prev_saved_doc_string. */
136 static ptrdiff_t prev_saved_doc_string_length
;
137 /* This is the file position that string came from. */
138 static file_offset prev_saved_doc_string_position
;
140 /* Nonzero means inside a new-style backquote
141 with no surrounding parentheses.
142 Fread initializes this to zero, so we need not specbind it
143 or worry about what happens to it when there is an error. */
144 static int new_backquote_flag
;
145 static Lisp_Object Qold_style_backquotes
;
147 /* A list of file names for files being loaded in Fload. Used to
148 check for recursive loads. */
150 static Lisp_Object Vloads_in_progress
;
152 static int read_emacs_mule_char (int, int (*) (int, Lisp_Object
),
155 static void readevalloop (Lisp_Object
, FILE*, Lisp_Object
, int,
156 Lisp_Object
, Lisp_Object
,
157 Lisp_Object
, Lisp_Object
);
158 static Lisp_Object
load_unwind (Lisp_Object
);
159 static Lisp_Object
load_descriptor_unwind (Lisp_Object
);
161 static void invalid_syntax (const char *) NO_RETURN
;
162 static void end_of_file_error (void) NO_RETURN
;
165 /* Functions that read one byte from the current source READCHARFUN
166 or unreads one byte. If the integer argument C is -1, it returns
167 one read byte, or -1 when there's no more byte in the source. If C
168 is 0 or positive, it unreads C, and the return value is not
171 static int readbyte_for_lambda (int, Lisp_Object
);
172 static int readbyte_from_file (int, Lisp_Object
);
173 static int readbyte_from_string (int, Lisp_Object
);
175 /* Handle unreading and rereading of characters.
176 Write READCHAR to read a character,
177 UNREAD(c) to unread c to be read again.
179 These macros correctly read/unread multibyte characters. */
181 #define READCHAR readchar (readcharfun, NULL)
182 #define UNREAD(c) unreadchar (readcharfun, c)
184 /* Same as READCHAR but set *MULTIBYTE to the multibyteness of the source. */
185 #define READCHAR_REPORT_MULTIBYTE(multibyte) readchar (readcharfun, multibyte)
187 /* When READCHARFUN is Qget_file_char, Qget_emacs_mule_file_char,
188 Qlambda, or a cons, we use this to keep an unread character because
189 a file stream can't handle multibyte-char unreading. The value -1
190 means that there's no unread character. */
191 static int unread_char
;
194 readchar (Lisp_Object readcharfun
, int *multibyte
)
198 int (*readbyte
) (int, Lisp_Object
);
199 unsigned char buf
[MAX_MULTIBYTE_LENGTH
];
201 int emacs_mule_encoding
= 0;
208 if (BUFFERP (readcharfun
))
210 register struct buffer
*inbuffer
= XBUFFER (readcharfun
);
212 EMACS_INT pt_byte
= BUF_PT_BYTE (inbuffer
);
214 if (pt_byte
>= BUF_ZV_BYTE (inbuffer
))
217 if (! NILP (BVAR (inbuffer
, enable_multibyte_characters
)))
219 /* Fetch the character code from the buffer. */
220 unsigned char *p
= BUF_BYTE_ADDRESS (inbuffer
, pt_byte
);
221 BUF_INC_POS (inbuffer
, pt_byte
);
228 c
= BUF_FETCH_BYTE (inbuffer
, pt_byte
);
229 if (! ASCII_BYTE_P (c
))
230 c
= BYTE8_TO_CHAR (c
);
233 SET_BUF_PT_BOTH (inbuffer
, BUF_PT (inbuffer
) + 1, pt_byte
);
237 if (MARKERP (readcharfun
))
239 register struct buffer
*inbuffer
= XMARKER (readcharfun
)->buffer
;
241 EMACS_INT bytepos
= marker_byte_position (readcharfun
);
243 if (bytepos
>= BUF_ZV_BYTE (inbuffer
))
246 if (! NILP (BVAR (inbuffer
, enable_multibyte_characters
)))
248 /* Fetch the character code from the buffer. */
249 unsigned char *p
= BUF_BYTE_ADDRESS (inbuffer
, bytepos
);
250 BUF_INC_POS (inbuffer
, bytepos
);
257 c
= BUF_FETCH_BYTE (inbuffer
, bytepos
);
258 if (! ASCII_BYTE_P (c
))
259 c
= BYTE8_TO_CHAR (c
);
263 XMARKER (readcharfun
)->bytepos
= bytepos
;
264 XMARKER (readcharfun
)->charpos
++;
269 if (EQ (readcharfun
, Qlambda
))
271 readbyte
= readbyte_for_lambda
;
275 if (EQ (readcharfun
, Qget_file_char
))
277 readbyte
= readbyte_from_file
;
281 if (STRINGP (readcharfun
))
283 if (read_from_string_index
>= read_from_string_limit
)
285 else if (STRING_MULTIBYTE (readcharfun
))
289 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c
, readcharfun
,
290 read_from_string_index
,
291 read_from_string_index_byte
);
295 c
= SREF (readcharfun
, read_from_string_index_byte
);
296 read_from_string_index
++;
297 read_from_string_index_byte
++;
302 if (CONSP (readcharfun
))
304 /* This is the case that read_vector is reading from a unibyte
305 string that contains a byte sequence previously skipped
306 because of #@NUMBER. The car part of readcharfun is that
307 string, and the cdr part is a value of readcharfun given to
309 readbyte
= readbyte_from_string
;
310 if (EQ (XCDR (readcharfun
), Qget_emacs_mule_file_char
))
311 emacs_mule_encoding
= 1;
315 if (EQ (readcharfun
, Qget_emacs_mule_file_char
))
317 readbyte
= readbyte_from_file
;
318 emacs_mule_encoding
= 1;
322 tem
= call0 (readcharfun
);
329 if (unread_char
>= 0)
335 c
= (*readbyte
) (-1, readcharfun
);
336 if (c
< 0 || load_each_byte
)
340 if (ASCII_BYTE_P (c
))
342 if (emacs_mule_encoding
)
343 return read_emacs_mule_char (c
, readbyte
, readcharfun
);
346 len
= BYTES_BY_CHAR_HEAD (c
);
349 c
= (*readbyte
) (-1, readcharfun
);
350 if (c
< 0 || ! TRAILING_CODE_P (c
))
353 (*readbyte
) (buf
[i
], readcharfun
);
354 return BYTE8_TO_CHAR (buf
[0]);
358 return STRING_CHAR (buf
);
361 /* Unread the character C in the way appropriate for the stream READCHARFUN.
362 If the stream is a user function, call it with the char as argument. */
365 unreadchar (Lisp_Object readcharfun
, int c
)
369 /* Don't back up the pointer if we're unreading the end-of-input mark,
370 since readchar didn't advance it when we read it. */
372 else if (BUFFERP (readcharfun
))
374 struct buffer
*b
= XBUFFER (readcharfun
);
375 EMACS_INT charpos
= BUF_PT (b
);
376 EMACS_INT bytepos
= BUF_PT_BYTE (b
);
378 if (! NILP (BVAR (b
, enable_multibyte_characters
)))
379 BUF_DEC_POS (b
, bytepos
);
383 SET_BUF_PT_BOTH (b
, charpos
- 1, bytepos
);
385 else if (MARKERP (readcharfun
))
387 struct buffer
*b
= XMARKER (readcharfun
)->buffer
;
388 EMACS_INT bytepos
= XMARKER (readcharfun
)->bytepos
;
390 XMARKER (readcharfun
)->charpos
--;
391 if (! NILP (BVAR (b
, enable_multibyte_characters
)))
392 BUF_DEC_POS (b
, bytepos
);
396 XMARKER (readcharfun
)->bytepos
= bytepos
;
398 else if (STRINGP (readcharfun
))
400 read_from_string_index
--;
401 read_from_string_index_byte
402 = string_char_to_byte (readcharfun
, read_from_string_index
);
404 else if (CONSP (readcharfun
))
408 else if (EQ (readcharfun
, Qlambda
))
412 else if (EQ (readcharfun
, Qget_file_char
)
413 || EQ (readcharfun
, Qget_emacs_mule_file_char
))
418 ungetc (c
, instream
);
425 call1 (readcharfun
, make_number (c
));
429 readbyte_for_lambda (int c
, Lisp_Object readcharfun
)
431 return read_bytecode_char (c
>= 0);
436 readbyte_from_file (int c
, Lisp_Object readcharfun
)
441 ungetc (c
, instream
);
450 /* Interrupted reads have been observed while reading over the network */
451 while (c
== EOF
&& ferror (instream
) && errno
== EINTR
)
463 return (c
== EOF
? -1 : c
);
467 readbyte_from_string (int c
, Lisp_Object readcharfun
)
469 Lisp_Object string
= XCAR (readcharfun
);
473 read_from_string_index
--;
474 read_from_string_index_byte
475 = string_char_to_byte (string
, read_from_string_index
);
478 if (read_from_string_index
>= read_from_string_limit
)
481 FETCH_STRING_CHAR_ADVANCE (c
, string
,
482 read_from_string_index
,
483 read_from_string_index_byte
);
488 /* Read one non-ASCII character from INSTREAM. The character is
489 encoded in `emacs-mule' and the first byte is already read in
493 read_emacs_mule_char (int c
, int (*readbyte
) (int, Lisp_Object
), Lisp_Object readcharfun
)
495 /* Emacs-mule coding uses at most 4-byte for one character. */
496 unsigned char buf
[4];
497 int len
= emacs_mule_bytes
[c
];
498 struct charset
*charset
;
503 /* C is not a valid leading-code of `emacs-mule'. */
504 return BYTE8_TO_CHAR (c
);
510 c
= (*readbyte
) (-1, readcharfun
);
514 (*readbyte
) (buf
[i
], readcharfun
);
515 return BYTE8_TO_CHAR (buf
[0]);
522 charset
= CHARSET_FROM_ID (emacs_mule_charset
[buf
[0]]);
523 code
= buf
[1] & 0x7F;
527 if (buf
[0] == EMACS_MULE_LEADING_CODE_PRIVATE_11
528 || buf
[0] == EMACS_MULE_LEADING_CODE_PRIVATE_12
)
530 charset
= CHARSET_FROM_ID (emacs_mule_charset
[buf
[1]]);
531 code
= buf
[2] & 0x7F;
535 charset
= CHARSET_FROM_ID (emacs_mule_charset
[buf
[0]]);
536 code
= ((buf
[1] << 8) | buf
[2]) & 0x7F7F;
541 charset
= CHARSET_FROM_ID (emacs_mule_charset
[buf
[1]]);
542 code
= ((buf
[2] << 8) | buf
[3]) & 0x7F7F;
544 c
= DECODE_CHAR (charset
, code
);
546 Fsignal (Qinvalid_read_syntax
,
547 Fcons (build_string ("invalid multibyte form"), Qnil
));
552 static Lisp_Object
read_internal_start (Lisp_Object
, Lisp_Object
,
554 static Lisp_Object
read0 (Lisp_Object
);
555 static Lisp_Object
read1 (Lisp_Object
, int *, int);
557 static Lisp_Object
read_list (int, Lisp_Object
);
558 static Lisp_Object
read_vector (Lisp_Object
, int);
560 static Lisp_Object
substitute_object_recurse (Lisp_Object
, Lisp_Object
,
562 static void substitute_object_in_subtree (Lisp_Object
,
564 static void substitute_in_interval (INTERVAL
, Lisp_Object
);
567 /* Get a character from the tty. */
569 /* Read input events until we get one that's acceptable for our purposes.
571 If NO_SWITCH_FRAME is non-zero, switch-frame events are stashed
572 until we get a character we like, and then stuffed into
575 If ASCII_REQUIRED is non-zero, we check function key events to see
576 if the unmodified version of the symbol has a Qascii_character
577 property, and use that character, if present.
579 If ERROR_NONASCII is non-zero, we signal an error if the input we
580 get isn't an ASCII character with modifiers. If it's zero but
581 ASCII_REQUIRED is non-zero, we just re-read until we get an ASCII
584 If INPUT_METHOD is nonzero, we invoke the current input method
585 if the character warrants that.
587 If SECONDS is a number, we wait that many seconds for input, and
588 return Qnil if no input arrives within that time. */
591 read_filtered_event (int no_switch_frame
, int ascii_required
,
592 int error_nonascii
, int input_method
, Lisp_Object seconds
)
594 Lisp_Object val
, delayed_switch_frame
;
597 #ifdef HAVE_WINDOW_SYSTEM
598 if (display_hourglass_p
)
602 delayed_switch_frame
= Qnil
;
604 /* Compute timeout. */
605 if (NUMBERP (seconds
))
607 EMACS_TIME wait_time
;
609 double duration
= extract_float (seconds
);
611 sec
= (int) duration
;
612 usec
= (duration
- sec
) * 1000000;
613 EMACS_GET_TIME (end_time
);
614 EMACS_SET_SECS_USECS (wait_time
, sec
, usec
);
615 EMACS_ADD_TIME (end_time
, end_time
, wait_time
);
618 /* Read until we get an acceptable event. */
621 val
= read_char (0, 0, 0, (input_method
? Qnil
: Qt
), 0,
622 NUMBERP (seconds
) ? &end_time
: NULL
);
623 while (INTEGERP (val
) && XINT (val
) == -2); /* wrong_kboard_jmpbuf */
628 /* switch-frame events are put off until after the next ASCII
629 character. This is better than signaling an error just because
630 the last characters were typed to a separate minibuffer frame,
631 for example. Eventually, some code which can deal with
632 switch-frame events will read it and process it. */
634 && EVENT_HAS_PARAMETERS (val
)
635 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (val
)), Qswitch_frame
))
637 delayed_switch_frame
= val
;
641 if (ascii_required
&& !(NUMBERP (seconds
) && NILP (val
)))
643 /* Convert certain symbols to their ASCII equivalents. */
646 Lisp_Object tem
, tem1
;
647 tem
= Fget (val
, Qevent_symbol_element_mask
);
650 tem1
= Fget (Fcar (tem
), Qascii_character
);
651 /* Merge this symbol's modifier bits
652 with the ASCII equivalent of its basic code. */
654 XSETFASTINT (val
, XINT (tem1
) | XINT (Fcar (Fcdr (tem
))));
658 /* If we don't have a character now, deal with it appropriately. */
663 Vunread_command_events
= Fcons (val
, Qnil
);
664 error ("Non-character input-event");
671 if (! NILP (delayed_switch_frame
))
672 unread_switch_frame
= delayed_switch_frame
;
676 #ifdef HAVE_WINDOW_SYSTEM
677 if (display_hourglass_p
)
686 DEFUN ("read-char", Fread_char
, Sread_char
, 0, 3, 0,
687 doc
: /* Read a character from the command input (keyboard or macro).
688 It is returned as a number.
689 If the character has modifiers, they are resolved and reflected to the
690 character code if possible (e.g. C-SPC -> 0).
692 If the user generates an event which is not a character (i.e. a mouse
693 click or function key event), `read-char' signals an error. As an
694 exception, switch-frame events are put off until non-character events
696 If you want to read non-character events, or ignore them, call
697 `read-event' or `read-char-exclusive' instead.
699 If the optional argument PROMPT is non-nil, display that as a prompt.
700 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
701 input method is turned on in the current buffer, that input method
702 is used for reading a character.
703 If the optional argument SECONDS is non-nil, it should be a number
704 specifying the maximum number of seconds to wait for input. If no
705 input arrives in that time, return nil. SECONDS may be a
706 floating-point value. */)
707 (Lisp_Object prompt
, Lisp_Object inherit_input_method
, Lisp_Object seconds
)
712 message_with_string ("%s", prompt
, 0);
713 val
= read_filtered_event (1, 1, 1, ! NILP (inherit_input_method
), seconds
);
715 return (NILP (val
) ? Qnil
716 : make_number (char_resolve_modifier_mask (XINT (val
))));
719 DEFUN ("read-event", Fread_event
, Sread_event
, 0, 3, 0,
720 doc
: /* Read an event object from the input stream.
721 If the optional argument PROMPT is non-nil, display that as a prompt.
722 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
723 input method is turned on in the current buffer, that input method
724 is used for reading a character.
725 If the optional argument SECONDS is non-nil, it should be a number
726 specifying the maximum number of seconds to wait for input. If no
727 input arrives in that time, return nil. SECONDS may be a
728 floating-point value. */)
729 (Lisp_Object prompt
, Lisp_Object inherit_input_method
, Lisp_Object seconds
)
732 message_with_string ("%s", prompt
, 0);
733 return read_filtered_event (0, 0, 0, ! NILP (inherit_input_method
), seconds
);
736 DEFUN ("read-char-exclusive", Fread_char_exclusive
, Sread_char_exclusive
, 0, 3, 0,
737 doc
: /* Read a character from the command input (keyboard or macro).
738 It is returned as a number. Non-character events are ignored.
739 If the character has modifiers, they are resolved and reflected to the
740 character code if possible (e.g. C-SPC -> 0).
742 If the optional argument PROMPT is non-nil, display that as a prompt.
743 If the optional argument INHERIT-INPUT-METHOD is non-nil and some
744 input method is turned on in the current buffer, that input method
745 is used for reading a character.
746 If the optional argument SECONDS is non-nil, it should be a number
747 specifying the maximum number of seconds to wait for input. If no
748 input arrives in that time, return nil. SECONDS may be a
749 floating-point value. */)
750 (Lisp_Object prompt
, Lisp_Object inherit_input_method
, Lisp_Object seconds
)
755 message_with_string ("%s", prompt
, 0);
757 val
= read_filtered_event (1, 1, 0, ! NILP (inherit_input_method
), seconds
);
759 return (NILP (val
) ? Qnil
760 : make_number (char_resolve_modifier_mask (XINT (val
))));
763 DEFUN ("get-file-char", Fget_file_char
, Sget_file_char
, 0, 0, 0,
764 doc
: /* Don't use this yourself. */)
767 register Lisp_Object val
;
769 XSETINT (val
, getc (instream
));
777 /* Return true if the lisp code read using READCHARFUN defines a non-nil
778 `lexical-binding' file variable. After returning, the stream is
779 positioned following the first line, if it is a comment, otherwise
783 lisp_file_lexically_bound_p (Lisp_Object readcharfun
)
787 /* The first line isn't a comment, just give up. */
793 /* Look for an appropriate file-variable in the first line. */
797 NOMINAL
, AFTER_FIRST_DASH
, AFTER_ASTERIX
,
798 } beg_end_state
= NOMINAL
;
799 int in_file_vars
= 0;
801 #define UPDATE_BEG_END_STATE(ch) \
802 if (beg_end_state == NOMINAL) \
803 beg_end_state = (ch == '-' ? AFTER_FIRST_DASH : NOMINAL); \
804 else if (beg_end_state == AFTER_FIRST_DASH) \
805 beg_end_state = (ch == '*' ? AFTER_ASTERIX : NOMINAL); \
806 else if (beg_end_state == AFTER_ASTERIX) \
809 in_file_vars = !in_file_vars; \
810 beg_end_state = NOMINAL; \
813 /* Skip until we get to the file vars, if any. */
817 UPDATE_BEG_END_STATE (ch
);
819 while (!in_file_vars
&& ch
!= '\n' && ch
!= EOF
);
823 char var
[100], val
[100];
828 /* Read a variable name. */
829 while (ch
== ' ' || ch
== '\t')
833 while (ch
!= ':' && ch
!= '\n' && ch
!= EOF
&& in_file_vars
)
835 if (i
< sizeof var
- 1)
837 UPDATE_BEG_END_STATE (ch
);
841 /* Stop scanning if no colon was found before end marker. */
845 while (i
> 0 && (var
[i
- 1] == ' ' || var
[i
- 1] == '\t'))
851 /* Read a variable value. */
854 while (ch
== ' ' || ch
== '\t')
858 while (ch
!= ';' && ch
!= '\n' && ch
!= EOF
&& in_file_vars
)
860 if (i
< sizeof val
- 1)
862 UPDATE_BEG_END_STATE (ch
);
866 /* The value was terminated by an end-marker, which
869 while (i
> 0 && (val
[i
- 1] == ' ' || val
[i
- 1] == '\t'))
873 if (strcmp (var
, "lexical-binding") == 0)
876 rv
= (strcmp (val
, "nil") != 0);
882 while (ch
!= '\n' && ch
!= EOF
)
889 /* Value is a version number of byte compiled code if the file
890 associated with file descriptor FD is a compiled Lisp file that's
891 safe to load. Only files compiled with Emacs are safe to load.
892 Files compiled with XEmacs can lead to a crash in Fbyte_code
893 because of an incompatible change in the byte compiler. */
896 safe_to_load_p (int fd
)
903 /* Read the first few bytes from the file, and look for a line
904 specifying the byte compiler version used. */
905 nbytes
= emacs_read (fd
, buf
, sizeof buf
- 1);
910 /* Skip to the next newline, skipping over the initial `ELC'
911 with NUL bytes following it, but note the version. */
912 for (i
= 0; i
< nbytes
&& buf
[i
] != '\n'; ++i
)
917 || fast_c_string_match_ignore_case (Vbytecomp_version_regexp
,
924 lseek (fd
, 0, SEEK_SET
);
929 /* Callback for record_unwind_protect. Restore the old load list OLD,
930 after loading a file successfully. */
933 record_load_unwind (Lisp_Object old
)
935 return Vloads_in_progress
= old
;
938 /* This handler function is used via internal_condition_case_1. */
941 load_error_handler (Lisp_Object data
)
947 load_warn_old_style_backquotes (Lisp_Object file
)
949 if (!NILP (Vold_style_backquotes
))
952 args
[0] = build_string ("Loading `%s': old-style backquotes detected!");
959 DEFUN ("get-load-suffixes", Fget_load_suffixes
, Sget_load_suffixes
, 0, 0, 0,
960 doc
: /* Return the suffixes that `load' should try if a suffix is \
962 This uses the variables `load-suffixes' and `load-file-rep-suffixes'. */)
965 Lisp_Object lst
= Qnil
, suffixes
= Vload_suffixes
, suffix
, ext
;
966 while (CONSP (suffixes
))
968 Lisp_Object exts
= Vload_file_rep_suffixes
;
969 suffix
= XCAR (suffixes
);
970 suffixes
= XCDR (suffixes
);
975 lst
= Fcons (concat2 (suffix
, ext
), lst
);
978 return Fnreverse (lst
);
981 DEFUN ("load", Fload
, Sload
, 1, 5, 0,
982 doc
: /* Execute a file of Lisp code named FILE.
983 First try FILE with `.elc' appended, then try with `.el',
984 then try FILE unmodified (the exact suffixes in the exact order are
985 determined by `load-suffixes'). Environment variable references in
986 FILE are replaced with their values by calling `substitute-in-file-name'.
987 This function searches the directories in `load-path'.
989 If optional second arg NOERROR is non-nil,
990 report no error if FILE doesn't exist.
991 Print messages at start and end of loading unless
992 optional third arg NOMESSAGE is non-nil (but `force-load-messages'
994 If optional fourth arg NOSUFFIX is non-nil, don't try adding
995 suffixes `.elc' or `.el' to the specified name FILE.
996 If optional fifth arg MUST-SUFFIX is non-nil, insist on
997 the suffix `.elc' or `.el'; don't accept just FILE unless
998 it ends in one of those suffixes or includes a directory name.
1000 If this function fails to find a file, it may look for different
1001 representations of that file before trying another file.
1002 It does so by adding the non-empty suffixes in `load-file-rep-suffixes'
1003 to the file name. Emacs uses this feature mainly to find compressed
1004 versions of files when Auto Compression mode is enabled.
1006 The exact suffixes that this function tries out, in the exact order,
1007 are given by the value of the variable `load-file-rep-suffixes' if
1008 NOSUFFIX is non-nil and by the return value of the function
1009 `get-load-suffixes' if MUST-SUFFIX is non-nil. If both NOSUFFIX and
1010 MUST-SUFFIX are nil, this function first tries out the latter suffixes
1011 and then the former.
1013 Loading a file records its definitions, and its `provide' and
1014 `require' calls, in an element of `load-history' whose
1015 car is the file name loaded. See `load-history'.
1017 While the file is in the process of being loaded, the variable
1018 `load-in-progress' is non-nil and the variable `load-file-name'
1019 is bound to the file's name.
1021 Return t if the file exists and loads successfully. */)
1022 (Lisp_Object file
, Lisp_Object noerror
, Lisp_Object nomessage
, Lisp_Object nosuffix
, Lisp_Object must_suffix
)
1024 register FILE *stream
;
1025 register int fd
= -1;
1026 int count
= SPECPDL_INDEX ();
1027 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1028 Lisp_Object found
, efound
, hist_file_name
;
1029 /* 1 means we printed the ".el is newer" message. */
1031 /* 1 means we are loading a compiled file. */
1033 Lisp_Object handler
;
1035 const char *fmode
= "r";
1043 CHECK_STRING (file
);
1045 /* If file name is magic, call the handler. */
1046 /* This shouldn't be necessary any more now that `openp' handles it right.
1047 handler = Ffind_file_name_handler (file, Qload);
1048 if (!NILP (handler))
1049 return call5 (handler, Qload, file, noerror, nomessage, nosuffix); */
1051 /* Do this after the handler to avoid
1052 the need to gcpro noerror, nomessage and nosuffix.
1053 (Below here, we care only whether they are nil or not.)
1054 The presence of this call is the result of a historical accident:
1055 it used to be in every file-operation and when it got removed
1056 everywhere, it accidentally stayed here. Since then, enough people
1057 supposedly have things like (load "$PROJECT/foo.el") in their .emacs
1058 that it seemed risky to remove. */
1059 if (! NILP (noerror
))
1061 file
= internal_condition_case_1 (Fsubstitute_in_file_name
, file
,
1062 Qt
, load_error_handler
);
1067 file
= Fsubstitute_in_file_name (file
);
1070 /* Avoid weird lossage with null string as arg,
1071 since it would try to load a directory as a Lisp file */
1072 if (SBYTES (file
) > 0)
1074 ptrdiff_t size
= SBYTES (file
);
1077 GCPRO2 (file
, found
);
1079 if (! NILP (must_suffix
))
1081 /* Don't insist on adding a suffix if FILE already ends with one. */
1083 && !strcmp (SSDATA (file
) + size
- 3, ".el"))
1086 && !strcmp (SSDATA (file
) + size
- 4, ".elc"))
1088 /* Don't insist on adding a suffix
1089 if the argument includes a directory name. */
1090 else if (! NILP (Ffile_name_directory (file
)))
1094 fd
= openp (Vload_path
, file
,
1095 (!NILP (nosuffix
) ? Qnil
1096 : !NILP (must_suffix
) ? Fget_load_suffixes ()
1097 : Fappend (2, (tmp
[0] = Fget_load_suffixes (),
1098 tmp
[1] = Vload_file_rep_suffixes
,
1107 xsignal2 (Qfile_error
, build_string ("Cannot open load file"), file
);
1111 /* Tell startup.el whether or not we found the user's init file. */
1112 if (EQ (Qt
, Vuser_init_file
))
1113 Vuser_init_file
= found
;
1115 /* If FD is -2, that means openp found a magic file. */
1118 if (NILP (Fequal (found
, file
)))
1119 /* If FOUND is a different file name from FILE,
1120 find its handler even if we have already inhibited
1121 the `load' operation on FILE. */
1122 handler
= Ffind_file_name_handler (found
, Qt
);
1124 handler
= Ffind_file_name_handler (found
, Qload
);
1125 if (! NILP (handler
))
1126 return call5 (handler
, Qload
, found
, noerror
, nomessage
, Qt
);
1128 /* Tramp has to deal with semi-broken packages that prepend
1129 drive letters to remote files. For that reason, Tramp
1130 catches file operations that test for file existence, which
1131 makes openp think X:/foo.elc files are remote. However,
1132 Tramp does not catch `load' operations for such files, so we
1133 end up with a nil as the `load' handler above. If we would
1134 continue with fd = -2, we will behave wrongly, and in
1135 particular try reading a .elc file in the "rt" mode instead
1136 of "rb". See bug #9311 for the results. To work around
1137 this, we try to open the file locally, and go with that if it
1139 fd
= emacs_open (SSDATA (ENCODE_FILE (found
)), O_RDONLY
, 0);
1145 /* Check if we're stuck in a recursive load cycle.
1147 2000-09-21: It's not possible to just check for the file loaded
1148 being a member of Vloads_in_progress. This fails because of the
1149 way the byte compiler currently works; `provide's are not
1150 evaluated, see font-lock.el/jit-lock.el as an example. This
1151 leads to a certain amount of ``normal'' recursion.
1153 Also, just loading a file recursively is not always an error in
1154 the general case; the second load may do something different. */
1158 for (tem
= Vloads_in_progress
; CONSP (tem
); tem
= XCDR (tem
))
1159 if (!NILP (Fequal (found
, XCAR (tem
))) && (++load_count
> 3))
1163 signal_error ("Recursive load", Fcons (found
, Vloads_in_progress
));
1165 record_unwind_protect (record_load_unwind
, Vloads_in_progress
);
1166 Vloads_in_progress
= Fcons (found
, Vloads_in_progress
);
1169 /* All loads are by default dynamic, unless the file itself specifies
1170 otherwise using a file-variable in the first line. This is bound here
1171 so that it takes effect whether or not we use
1172 Vload_source_file_function. */
1173 specbind (Qlexical_binding
, Qnil
);
1175 /* Get the name for load-history. */
1176 hist_file_name
= (! NILP (Vpurify_flag
)
1177 ? Fconcat (2, (tmp
[0] = Ffile_name_directory (file
),
1178 tmp
[1] = Ffile_name_nondirectory (found
),
1184 /* Check for the presence of old-style quotes and warn about them. */
1185 specbind (Qold_style_backquotes
, Qnil
);
1186 record_unwind_protect (load_warn_old_style_backquotes
, file
);
1188 if (!memcmp (SDATA (found
) + SBYTES (found
) - 4, ".elc", 4)
1189 || (fd
>= 0 && (version
= safe_to_load_p (fd
)) > 0))
1190 /* Load .elc files directly, but not when they are
1191 remote and have no handler! */
1198 GCPRO3 (file
, found
, hist_file_name
);
1201 && ! (version
= safe_to_load_p (fd
)))
1204 if (!load_dangerous_libraries
)
1208 error ("File `%s' was not compiled in Emacs",
1211 else if (!NILP (nomessage
) && !force_load_messages
)
1212 message_with_string ("File `%s' not compiled in Emacs", found
, 1);
1217 efound
= ENCODE_FILE (found
);
1222 result
= stat (SSDATA (efound
), &s1
);
1225 SSET (efound
, SBYTES (efound
) - 1, 0);
1226 result
= stat (SSDATA (efound
), &s2
);
1227 SSET (efound
, SBYTES (efound
) - 1, 'c');
1230 if (result
== 0 && s1
.st_mtime
< s2
.st_mtime
)
1232 /* Make the progress messages mention that source is newer. */
1235 /* If we won't print another message, mention this anyway. */
1236 if (!NILP (nomessage
) && !force_load_messages
)
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",
1249 /* We are loading a source file (*.el). */
1250 if (!NILP (Vload_source_file_function
))
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
);
1263 GCPRO3 (file
, found
, hist_file_name
);
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. */
1273 stream
= fopen (SSDATA (efound
), fmode
);
1277 #else /* not WINDOWSNT */
1278 stream
= fdopen (fd
, fmode
);
1279 #endif /* not WINDOWSNT */
1283 error ("Failure to create stdio stream for %s", SDATA (file
));
1286 if (! NILP (Vpurify_flag
))
1287 Vpreloaded_file_list
= Fcons (Fpurecopy(file
), Vpreloaded_file_list
);
1289 if (NILP (nomessage
) || force_load_messages
)
1292 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...",
1295 message_with_string ("Loading %s (source)...", file
, 1);
1297 message_with_string ("Loading %s (compiled; note, source file is newer)...",
1299 else /* The typical case; compiled file newer than source file. */
1300 message_with_string ("Loading %s...", file
, 1);
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
);
1312 if (lisp_file_lexically_bound_p (Qget_file_char
))
1313 Fset (Qlexical_binding
, Qt
);
1315 if (! version
|| version
>= 22)
1316 readevalloop (Qget_file_char
, stream
, hist_file_name
,
1317 0, Qnil
, Qnil
, Qnil
, Qnil
);
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
);
1326 unbind_to (count
, Qnil
);
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
) ;
1334 xfree (saved_doc_string
);
1335 saved_doc_string
= 0;
1336 saved_doc_string_size
= 0;
1338 xfree (prev_saved_doc_string
);
1339 prev_saved_doc_string
= 0;
1340 prev_saved_doc_string_size
= 0;
1342 if (!noninteractive
&& (NILP (nomessage
) || force_load_messages
))
1345 message_with_string ("Loading %s (compiled; note unsafe, not compiled in Emacs)...done",
1348 message_with_string ("Loading %s (source)...done", file
, 1);
1350 message_with_string ("Loading %s (compiled; note, source file is newer)...done",
1352 else /* The typical case; compiled file newer than source file. */
1353 message_with_string ("Loading %s...done", file
, 1);
1360 load_unwind (Lisp_Object arg
) /* used as unwind-protect function in load */
1362 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
1373 load_descriptor_unwind (Lisp_Object oldlist
)
1375 load_descriptor_list
= oldlist
;
1379 /* Close all descriptors in use for Floads.
1380 This is used when starting a subprocess. */
1383 close_load_descs (void)
1387 for (tail
= load_descriptor_list
; CONSP (tail
); tail
= XCDR (tail
))
1388 emacs_close (XFASTINT (XCAR (tail
)));
1393 complete_filename_p (Lisp_Object pathname
)
1395 register 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])));
1401 DEFUN ("locate-file-internal", Flocate_file_internal
, Slocate_file_internal
, 2, 4, 0,
1402 doc
: /* Search for FILENAME through PATH.
1403 Returns the file's name in absolute form, or nil if not found.
1404 If SUFFIXES is non-nil, it should be a list of suffixes to append to
1405 file name when searching.
1406 If non-nil, PREDICATE is used instead of `file-readable-p'.
1407 PREDICATE can also be an integer to pass to the access(2) function,
1408 in which case file-name-handlers are ignored.
1409 This function will normally skip directories, so if you want it to find
1410 directories, make sure the PREDICATE function returns `dir-ok' for them. */)
1411 (Lisp_Object filename
, Lisp_Object path
, Lisp_Object suffixes
, Lisp_Object predicate
)
1414 int fd
= openp (path
, filename
, suffixes
, &file
, predicate
);
1415 if (NILP (predicate
) && fd
> 0)
1420 static Lisp_Object Qdir_ok
;
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.
1426 SUFFIXES is a list of strings containing possible suffixes.
1427 The empty suffix is automatically added if the list is empty.
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
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.
1439 If the file we find is remote, return -2
1440 but store the found remote file name in *STOREPTR. */
1443 openp (Lisp_Object path
, Lisp_Object str
, Lisp_Object suffixes
, Lisp_Object
*storeptr
, Lisp_Object predicate
)
1446 EMACS_INT fn_size
= 100;
1448 register char *fn
= buf
;
1450 EMACS_INT want_length
;
1451 Lisp_Object filename
;
1453 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
, gcpro6
;
1454 Lisp_Object string
, tail
, encoded_fn
;
1455 EMACS_INT max_suffix_len
= 0;
1459 for (tail
= suffixes
; CONSP (tail
); tail
= XCDR (tail
))
1461 CHECK_STRING_CAR (tail
);
1462 max_suffix_len
= max (max_suffix_len
,
1463 SBYTES (XCAR (tail
)));
1466 string
= filename
= encoded_fn
= Qnil
;
1467 GCPRO6 (str
, string
, filename
, path
, suffixes
, encoded_fn
);
1472 if (complete_filename_p (str
))
1475 for (; CONSP (path
); path
= XCDR (path
))
1477 filename
= Fexpand_file_name (str
, XCAR (path
));
1478 if (!complete_filename_p (filename
))
1479 /* If there are non-absolute elts in PATH (eg ".") */
1480 /* Of course, this could conceivably lose if luser sets
1481 default-directory to be something non-absolute... */
1483 filename
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
1484 if (!complete_filename_p (filename
))
1485 /* Give up on this path element! */
1489 /* Calculate maximum length of any filename made from
1490 this path element/specified file name and any possible suffix. */
1491 want_length
= max_suffix_len
+ SBYTES (filename
);
1492 if (fn_size
<= want_length
)
1493 fn
= (char *) alloca (fn_size
= 100 + want_length
);
1495 /* Loop over suffixes. */
1496 for (tail
= NILP (suffixes
) ? Fcons (empty_unibyte_string
, Qnil
) : suffixes
;
1497 CONSP (tail
); tail
= XCDR (tail
))
1499 ptrdiff_t lsuffix
= SBYTES (XCAR (tail
));
1500 Lisp_Object handler
;
1503 /* Concatenate path element/specified name with the suffix.
1504 If the directory starts with /:, remove that. */
1505 if (SCHARS (filename
) > 2
1506 && SREF (filename
, 0) == '/'
1507 && SREF (filename
, 1) == ':')
1509 strncpy (fn
, SSDATA (filename
) + 2,
1510 SBYTES (filename
) - 2);
1511 fn
[SBYTES (filename
) - 2] = 0;
1515 strncpy (fn
, SSDATA (filename
),
1517 fn
[SBYTES (filename
)] = 0;
1520 if (lsuffix
!= 0) /* Bug happens on CCI if lsuffix is 0. */
1521 strncat (fn
, SSDATA (XCAR (tail
)), lsuffix
);
1523 /* Check that the file exists and is not a directory. */
1524 /* We used to only check for handlers on non-absolute file names:
1528 handler = Ffind_file_name_handler (filename, Qfile_exists_p);
1529 It's not clear why that was the case and it breaks things like
1530 (load "/bar.el") where the file is actually "/bar.el.gz". */
1531 string
= build_string (fn
);
1532 handler
= Ffind_file_name_handler (string
, Qfile_exists_p
);
1533 if ((!NILP (handler
) || !NILP (predicate
)) && !NATNUMP (predicate
))
1535 if (NILP (predicate
))
1536 exists
= !NILP (Ffile_readable_p (string
));
1539 Lisp_Object tmp
= call1 (predicate
, string
);
1540 exists
= !NILP (tmp
)
1541 && (EQ (tmp
, Qdir_ok
)
1542 || NILP (Ffile_directory_p (string
)));
1547 /* We succeeded; return this descriptor and filename. */
1558 encoded_fn
= ENCODE_FILE (string
);
1559 pfn
= SSDATA (encoded_fn
);
1560 exists
= (stat (pfn
, &st
) == 0 && ! S_ISDIR (st
.st_mode
));
1563 /* Check that we can access or open it. */
1564 if (NATNUMP (predicate
))
1565 fd
= (access (pfn
, XFASTINT (predicate
)) == 0) ? 1 : -1;
1567 fd
= emacs_open (pfn
, O_RDONLY
, 0);
1571 /* We succeeded; return this descriptor and filename. */
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.
1593 FILENAME is the file name that we are loading from.
1594 ENTIRE is 1 if loading that entire file, 0 if evaluating part of it. */
1597 build_load_history (Lisp_Object filename
, int entire
)
1599 register Lisp_Object tail
, prev
, newelt
;
1600 register Lisp_Object tem
, tem2
;
1601 register int foundit
= 0;
1603 tail
= Vload_history
;
1606 while (CONSP (tail
))
1610 /* Find the feature's previous assoc list... */
1611 if (!NILP (Fequal (filename
, Fcar (tem
))))
1615 /* If we're loading the entire file, remove old data. */
1619 Vload_history
= XCDR (tail
);
1621 Fsetcdr (prev
, XCDR (tail
));
1624 /* Otherwise, cons on new symbols that are not already members. */
1627 tem2
= Vcurrent_load_list
;
1629 while (CONSP (tem2
))
1631 newelt
= XCAR (tem2
);
1633 if (NILP (Fmember (newelt
, tem
)))
1634 Fsetcar (tail
, Fcons (XCAR (tem
),
1635 Fcons (newelt
, XCDR (tem
))));
1648 /* If we're loading an entire file, cons the new assoc onto the
1649 front of load-history, the most-recently-loaded position. Also
1650 do this if we didn't find an existing member for the file. */
1651 if (entire
|| !foundit
)
1652 Vload_history
= Fcons (Fnreverse (Vcurrent_load_list
),
1657 unreadpure (Lisp_Object junk
) /* Used as unwind-protect function in readevalloop */
1664 readevalloop_1 (Lisp_Object old
)
1666 load_convert_to_unibyte
= ! NILP (old
);
1670 /* Signal an `end-of-file' error, if possible with file name
1674 end_of_file_error (void)
1676 if (STRINGP (Vload_file_name
))
1677 xsignal1 (Qend_of_file
, Vload_file_name
);
1679 xsignal0 (Qend_of_file
);
1682 /* UNIBYTE specifies how to set load_convert_to_unibyte
1683 for this invocation.
1684 READFUN, if non-nil, is used instead of `read'.
1686 START, END specify region to read in current buffer (from eval-region).
1687 If the input is not from a buffer, they must be nil. */
1690 readevalloop (Lisp_Object readcharfun
,
1692 Lisp_Object sourcename
,
1694 Lisp_Object unibyte
, Lisp_Object readfun
,
1695 Lisp_Object start
, Lisp_Object end
)
1698 register Lisp_Object val
;
1699 int count
= SPECPDL_INDEX ();
1700 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1701 struct buffer
*b
= 0;
1702 int continue_reading_p
;
1703 Lisp_Object lex_bound
;
1704 /* Nonzero if reading an entire buffer. */
1705 int whole_buffer
= 0;
1706 /* 1 on the first time around. */
1709 if (MARKERP (readcharfun
))
1712 start
= readcharfun
;
1715 if (BUFFERP (readcharfun
))
1716 b
= XBUFFER (readcharfun
);
1717 else if (MARKERP (readcharfun
))
1718 b
= XMARKER (readcharfun
)->buffer
;
1720 /* We assume START is nil when input is not from a buffer. */
1721 if (! NILP (start
) && !b
)
1724 specbind (Qstandard_input
, readcharfun
); /* GCPROs readcharfun. */
1725 specbind (Qcurrent_load_list
, Qnil
);
1726 record_unwind_protect (readevalloop_1
, load_convert_to_unibyte
? Qt
: Qnil
);
1727 load_convert_to_unibyte
= !NILP (unibyte
);
1729 /* If lexical binding is active (either because it was specified in
1730 the file's header, or via a buffer-local variable), create an empty
1731 lexical environment, otherwise, turn off lexical binding. */
1732 lex_bound
= find_symbol_value (Qlexical_binding
);
1733 specbind (Qinternal_interpreter_environment
,
1734 NILP (lex_bound
) || EQ (lex_bound
, Qunbound
)
1735 ? Qnil
: Fcons (Qt
, Qnil
));
1737 GCPRO4 (sourcename
, readfun
, start
, end
);
1739 /* Try to ensure sourcename is a truename, except whilst preloading. */
1740 if (NILP (Vpurify_flag
)
1741 && !NILP (sourcename
) && !NILP (Ffile_name_absolute_p (sourcename
))
1742 && !NILP (Ffboundp (Qfile_truename
)))
1743 sourcename
= call1 (Qfile_truename
, sourcename
) ;
1745 LOADHIST_ATTACH (sourcename
);
1747 continue_reading_p
= 1;
1748 while (continue_reading_p
)
1750 int count1
= SPECPDL_INDEX ();
1752 if (b
!= 0 && NILP (BVAR (b
, name
)))
1753 error ("Reading from killed buffer");
1757 /* Switch to the buffer we are reading from. */
1758 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1759 set_buffer_internal (b
);
1761 /* Save point in it. */
1762 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1763 /* Save ZV in it. */
1764 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
1765 /* Those get unbound after we read one expression. */
1767 /* Set point and ZV around stuff to be read. */
1770 Fnarrow_to_region (make_number (BEGV
), end
);
1772 /* Just for cleanliness, convert END to a marker
1773 if it is an integer. */
1775 end
= Fpoint_max_marker ();
1778 /* On the first cycle, we can easily test here
1779 whether we are reading the whole buffer. */
1780 if (b
&& first_sexp
)
1781 whole_buffer
= (PT
== BEG
&& ZV
== Z
);
1788 while ((c
= READCHAR
) != '\n' && c
!= -1);
1793 unbind_to (count1
, Qnil
);
1797 /* Ignore whitespace here, so we can detect eof. */
1798 if (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\f' || c
== '\r'
1799 || c
== 0x8a0) /* NBSP */
1802 if (!NILP (Vpurify_flag
) && c
== '(')
1804 record_unwind_protect (unreadpure
, Qnil
);
1805 val
= read_list (-1, readcharfun
);
1810 read_objects
= Qnil
;
1811 if (!NILP (readfun
))
1813 val
= call1 (readfun
, readcharfun
);
1815 /* If READCHARFUN has set point to ZV, we should
1816 stop reading, even if the form read sets point
1817 to a different value when evaluated. */
1818 if (BUFFERP (readcharfun
))
1820 struct buffer
*buf
= XBUFFER (readcharfun
);
1821 if (BUF_PT (buf
) == BUF_ZV (buf
))
1822 continue_reading_p
= 0;
1825 else if (! NILP (Vload_read_function
))
1826 val
= call1 (Vload_read_function
, readcharfun
);
1828 val
= read_internal_start (readcharfun
, Qnil
, Qnil
);
1831 if (!NILP (start
) && continue_reading_p
)
1832 start
= Fpoint_marker ();
1834 /* Restore saved point and BEGV. */
1835 unbind_to (count1
, Qnil
);
1837 /* Now eval what we just read. */
1838 val
= eval_sub (val
);
1842 Vvalues
= Fcons (val
, Vvalues
);
1843 if (EQ (Vstandard_output
, Qt
))
1852 build_load_history (sourcename
,
1853 stream
|| whole_buffer
);
1857 unbind_to (count
, Qnil
);
1860 DEFUN ("eval-buffer", Feval_buffer
, Seval_buffer
, 0, 5, "",
1861 doc
: /* Execute the current buffer as Lisp code.
1862 When called from a Lisp program (i.e., not interactively), this
1863 function accepts up to five optional arguments:
1864 BUFFER is the buffer to evaluate (nil means use current buffer).
1865 PRINTFLAG controls printing of output:
1866 A value of nil means discard it; anything else is stream for print.
1867 FILENAME specifies the file name to use for `load-history'.
1868 UNIBYTE, if non-nil, specifies `load-convert-to-unibyte' for this
1870 DO-ALLOW-PRINT, if non-nil, specifies that `print' and related
1871 functions should work normally even if PRINTFLAG is nil.
1873 This function preserves the position of point. */)
1874 (Lisp_Object buffer
, Lisp_Object printflag
, Lisp_Object filename
, Lisp_Object unibyte
, Lisp_Object do_allow_print
)
1876 int count
= SPECPDL_INDEX ();
1877 Lisp_Object tem
, buf
;
1880 buf
= Fcurrent_buffer ();
1882 buf
= Fget_buffer (buffer
);
1884 error ("No such buffer");
1886 if (NILP (printflag
) && NILP (do_allow_print
))
1891 if (NILP (filename
))
1892 filename
= BVAR (XBUFFER (buf
), filename
);
1894 specbind (Qeval_buffer_list
, Fcons (buf
, Veval_buffer_list
));
1895 specbind (Qstandard_output
, tem
);
1896 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1897 BUF_TEMP_SET_PT (XBUFFER (buf
), BUF_BEGV (XBUFFER (buf
)));
1898 specbind (Qlexical_binding
, lisp_file_lexically_bound_p (buf
) ? Qt
: Qnil
);
1899 readevalloop (buf
, 0, filename
,
1900 !NILP (printflag
), unibyte
, Qnil
, Qnil
, Qnil
);
1901 unbind_to (count
, Qnil
);
1906 DEFUN ("eval-region", Feval_region
, Seval_region
, 2, 4, "r",
1907 doc
: /* Execute the region as Lisp code.
1908 When called from programs, expects two arguments,
1909 giving starting and ending indices in the current buffer
1910 of the text to be executed.
1911 Programs can pass third argument PRINTFLAG which controls output:
1912 A value of nil means discard it; anything else is stream for printing it.
1913 Also the fourth argument READ-FUNCTION, if non-nil, is used
1914 instead of `read' to read each expression. It gets one argument
1915 which is the input stream for reading characters.
1917 This function does not move point. */)
1918 (Lisp_Object start
, Lisp_Object end
, Lisp_Object printflag
, Lisp_Object read_function
)
1920 /* FIXME: Do the eval-sexp-add-defvars danse! */
1921 int count
= SPECPDL_INDEX ();
1922 Lisp_Object tem
, cbuf
;
1924 cbuf
= Fcurrent_buffer ();
1926 if (NILP (printflag
))
1930 specbind (Qstandard_output
, tem
);
1931 specbind (Qeval_buffer_list
, Fcons (cbuf
, Veval_buffer_list
));
1933 /* readevalloop calls functions which check the type of start and end. */
1934 readevalloop (cbuf
, 0, BVAR (XBUFFER (cbuf
), filename
),
1935 !NILP (printflag
), Qnil
, read_function
,
1938 return unbind_to (count
, Qnil
);
1942 DEFUN ("read", Fread
, Sread
, 0, 1, 0,
1943 doc
: /* Read one Lisp expression as text from STREAM, return as Lisp object.
1944 If STREAM is nil, use the value of `standard-input' (which see).
1945 STREAM or the value of `standard-input' may be:
1946 a buffer (read from point and advance it)
1947 a marker (read from where it points and advance it)
1948 a function (call it with no arguments for each character,
1949 call it with a char as argument to push a char back)
1950 a string (takes text from string, starting at the beginning)
1951 t (read text line using minibuffer and use it, or read from
1952 standard input in batch mode). */)
1953 (Lisp_Object stream
)
1956 stream
= Vstandard_input
;
1957 if (EQ (stream
, Qt
))
1958 stream
= Qread_char
;
1959 if (EQ (stream
, Qread_char
))
1960 return Fread_minibuffer (build_string ("Lisp expression: "), Qnil
);
1962 return read_internal_start (stream
, Qnil
, Qnil
);
1965 DEFUN ("read-from-string", Fread_from_string
, Sread_from_string
, 1, 3, 0,
1966 doc
: /* Read one Lisp expression which is represented as text by STRING.
1967 Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
1968 START and END optionally delimit a substring of STRING from which to read;
1969 they default to 0 and (length STRING) respectively. */)
1970 (Lisp_Object string
, Lisp_Object start
, Lisp_Object end
)
1973 CHECK_STRING (string
);
1974 /* read_internal_start sets read_from_string_index. */
1975 ret
= read_internal_start (string
, start
, end
);
1976 return Fcons (ret
, make_number (read_from_string_index
));
1979 /* Function to set up the global context we need in toplevel read
1982 read_internal_start (Lisp_Object stream
, Lisp_Object start
, Lisp_Object end
)
1983 /* start, end only used when stream is a string. */
1988 new_backquote_flag
= 0;
1989 read_objects
= Qnil
;
1990 if (EQ (Vread_with_symbol_positions
, Qt
)
1991 || EQ (Vread_with_symbol_positions
, stream
))
1992 Vread_symbol_positions_list
= Qnil
;
1994 if (STRINGP (stream
)
1995 || ((CONSP (stream
) && STRINGP (XCAR (stream
)))))
1997 EMACS_INT startval
, endval
;
2000 if (STRINGP (stream
))
2003 string
= XCAR (stream
);
2006 endval
= SCHARS (string
);
2010 endval
= XINT (end
);
2011 if (endval
< 0 || endval
> SCHARS (string
))
2012 args_out_of_range (string
, end
);
2019 CHECK_NUMBER (start
);
2020 startval
= XINT (start
);
2021 if (startval
< 0 || startval
> endval
)
2022 args_out_of_range (string
, start
);
2024 read_from_string_index
= startval
;
2025 read_from_string_index_byte
= string_char_to_byte (string
, startval
);
2026 read_from_string_limit
= endval
;
2029 retval
= read0 (stream
);
2030 if (EQ (Vread_with_symbol_positions
, Qt
)
2031 || EQ (Vread_with_symbol_positions
, stream
))
2032 Vread_symbol_positions_list
= Fnreverse (Vread_symbol_positions_list
);
2037 /* Signal Qinvalid_read_syntax error.
2038 S is error string of length N (if > 0) */
2041 invalid_syntax (const char *s
)
2043 xsignal1 (Qinvalid_read_syntax
, build_string (s
));
2047 /* Use this for recursive reads, in contexts where internal tokens
2051 read0 (Lisp_Object readcharfun
)
2053 register Lisp_Object val
;
2056 val
= read1 (readcharfun
, &c
, 0);
2060 xsignal1 (Qinvalid_read_syntax
,
2061 Fmake_string (make_number (1), make_number (c
)));
2064 static ptrdiff_t read_buffer_size
;
2065 static char *read_buffer
;
2067 /* Read a \-escape sequence, assuming we already read the `\'.
2068 If the escape sequence forces unibyte, return eight-bit char. */
2071 read_escape (Lisp_Object readcharfun
, int stringp
)
2073 register int c
= READCHAR
;
2074 /* \u allows up to four hex digits, \U up to eight. Default to the
2075 behavior for \u, and change this value in the case that \U is seen. */
2076 int unicode_hex_count
= 4;
2081 end_of_file_error ();
2111 error ("Invalid escape character syntax");
2114 c
= read_escape (readcharfun
, 0);
2115 return c
| meta_modifier
;
2120 error ("Invalid escape character syntax");
2123 c
= read_escape (readcharfun
, 0);
2124 return c
| shift_modifier
;
2129 error ("Invalid escape character syntax");
2132 c
= read_escape (readcharfun
, 0);
2133 return c
| hyper_modifier
;
2138 error ("Invalid escape character syntax");
2141 c
= read_escape (readcharfun
, 0);
2142 return c
| alt_modifier
;
2146 if (stringp
|| c
!= '-')
2153 c
= read_escape (readcharfun
, 0);
2154 return c
| super_modifier
;
2159 error ("Invalid escape character syntax");
2163 c
= read_escape (readcharfun
, 0);
2164 if ((c
& ~CHAR_MODIFIER_MASK
) == '?')
2165 return 0177 | (c
& CHAR_MODIFIER_MASK
);
2166 else if (! SINGLE_BYTE_CHAR_P ((c
& ~CHAR_MODIFIER_MASK
)))
2167 return c
| ctrl_modifier
;
2168 /* ASCII control chars are made from letters (both cases),
2169 as well as the non-letters within 0100...0137. */
2170 else if ((c
& 0137) >= 0101 && (c
& 0137) <= 0132)
2171 return (c
& (037 | ~0177));
2172 else if ((c
& 0177) >= 0100 && (c
& 0177) <= 0137)
2173 return (c
& (037 | ~0177));
2175 return c
| ctrl_modifier
;
2185 /* An octal escape, as in ANSI C. */
2187 register int i
= c
- '0';
2188 register int count
= 0;
2191 if ((c
= READCHAR
) >= '0' && c
<= '7')
2203 if (i
>= 0x80 && i
< 0x100)
2204 i
= BYTE8_TO_CHAR (i
);
2209 /* A hex escape, as in ANSI C. */
2216 if (c
>= '0' && c
<= '9')
2221 else if ((c
>= 'a' && c
<= 'f')
2222 || (c
>= 'A' && c
<= 'F'))
2225 if (c
>= 'a' && c
<= 'f')
2236 error ("Hex character out of range: \\x%x...", i
);
2240 if (count
< 3 && i
>= 0x80)
2241 return BYTE8_TO_CHAR (i
);
2246 /* Post-Unicode-2.0: Up to eight hex chars. */
2247 unicode_hex_count
= 8;
2250 /* A Unicode escape. We only permit them in strings and characters,
2251 not arbitrarily in the source code, as in some other languages. */
2256 while (++count
<= unicode_hex_count
)
2259 /* isdigit and isalpha may be locale-specific, which we don't
2261 if (c
>= '0' && c
<= '9') i
= (i
<< 4) + (c
- '0');
2262 else if (c
>= 'a' && c
<= 'f') i
= (i
<< 4) + (c
- 'a') + 10;
2263 else if (c
>= 'A' && c
<= 'F') i
= (i
<< 4) + (c
- 'A') + 10;
2265 error ("Non-hex digit used for Unicode escape");
2268 error ("Non-Unicode character: 0x%x", i
);
2277 /* Return the digit that CHARACTER stands for in the given BASE.
2278 Return -1 if CHARACTER is out of range for BASE,
2279 and -2 if CHARACTER is not valid for any supported BASE. */
2281 digit_to_number (int character
, int base
)
2285 if ('0' <= character
&& character
<= '9')
2286 digit
= character
- '0';
2287 else if ('a' <= character
&& character
<= 'z')
2288 digit
= character
- 'a' + 10;
2289 else if ('A' <= character
&& character
<= 'Z')
2290 digit
= character
- 'A' + 10;
2294 return digit
< base
? digit
: -1;
2297 /* Read an integer in radix RADIX using READCHARFUN to read
2298 characters. RADIX must be in the interval [2..36]; if it isn't, a
2299 read error is signaled . Value is the integer read. Signals an
2300 error if encountering invalid read syntax or if RADIX is out of
2304 read_integer (Lisp_Object readcharfun
, EMACS_INT radix
)
2306 /* Room for sign, leading 0, other digits, trailing null byte.
2307 Also, room for invalid syntax diagnostic. */
2308 char buf
[max (1 + 1 + sizeof (uintmax_t) * CHAR_BIT
+ 1,
2309 sizeof "integer, radix " + INT_STRLEN_BOUND (EMACS_INT
))];
2311 int valid
= -1; /* 1 if valid, 0 if not, -1 if incomplete. */
2313 if (radix
< 2 || radix
> 36)
2321 if (c
== '-' || c
== '+')
2332 /* Ignore redundant leading zeros, so the buffer doesn't
2333 fill up with them. */
2339 while (-1 <= (digit
= digit_to_number (c
, radix
)))
2346 if (p
< buf
+ sizeof buf
- 1)
2360 sprintf (buf
, "integer, radix %"pI
"d", radix
);
2361 invalid_syntax (buf
);
2364 return string_to_number (buf
, radix
, 0);
2368 /* If the next token is ')' or ']' or '.', we store that character
2369 in *PCH and the return value is not interesting. Else, we store
2370 zero in *PCH and we read and return one lisp object.
2372 FIRST_IN_LIST is nonzero if this is the first element of a list. */
2375 read1 (register Lisp_Object readcharfun
, int *pch
, int first_in_list
)
2378 unsigned uninterned_symbol
= 0;
2386 c
= READCHAR_REPORT_MULTIBYTE (&multibyte
);
2388 end_of_file_error ();
2393 return read_list (0, readcharfun
);
2396 return read_vector (readcharfun
, 0);
2412 /* Accept extended format for hashtables (extensible to
2414 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
2415 Lisp_Object tmp
= read_list (0, readcharfun
);
2416 Lisp_Object head
= CAR_SAFE (tmp
);
2417 Lisp_Object data
= Qnil
;
2418 Lisp_Object val
= Qnil
;
2419 /* The size is 2 * number of allowed keywords to
2421 Lisp_Object params
[10];
2423 Lisp_Object key
= Qnil
;
2424 int param_count
= 0;
2426 if (!EQ (head
, Qhash_table
))
2427 error ("Invalid extended read marker at head of #s list "
2428 "(only hash-table allowed)");
2430 tmp
= CDR_SAFE (tmp
);
2432 /* This is repetitive but fast and simple. */
2433 params
[param_count
] = QCsize
;
2434 params
[param_count
+1] = Fplist_get (tmp
, Qsize
);
2435 if (!NILP (params
[param_count
+ 1]))
2438 params
[param_count
] = QCtest
;
2439 params
[param_count
+1] = Fplist_get (tmp
, Qtest
);
2440 if (!NILP (params
[param_count
+ 1]))
2443 params
[param_count
] = QCweakness
;
2444 params
[param_count
+1] = Fplist_get (tmp
, Qweakness
);
2445 if (!NILP (params
[param_count
+ 1]))
2448 params
[param_count
] = QCrehash_size
;
2449 params
[param_count
+1] = Fplist_get (tmp
, Qrehash_size
);
2450 if (!NILP (params
[param_count
+ 1]))
2453 params
[param_count
] = QCrehash_threshold
;
2454 params
[param_count
+1] = Fplist_get (tmp
, Qrehash_threshold
);
2455 if (!NILP (params
[param_count
+ 1]))
2458 /* This is the hashtable data. */
2459 data
= Fplist_get (tmp
, Qdata
);
2461 /* Now use params to make a new hashtable and fill it. */
2462 ht
= Fmake_hash_table (param_count
, params
);
2464 while (CONSP (data
))
2469 error ("Odd number of elements in hashtable data");
2472 Fputhash (key
, val
, ht
);
2478 invalid_syntax ("#");
2486 tmp
= read_vector (readcharfun
, 0);
2487 if (ASIZE (tmp
) < CHAR_TABLE_STANDARD_SLOTS
)
2488 error ("Invalid size char-table");
2489 XSETPVECTYPE (XVECTOR (tmp
), PVEC_CHAR_TABLE
);
2498 EMACS_INT depth
, size
;
2500 tmp
= read_vector (readcharfun
, 0);
2501 if (!INTEGERP (AREF (tmp
, 0)))
2502 error ("Invalid depth in char-table");
2503 depth
= XINT (AREF (tmp
, 0));
2504 if (depth
< 1 || depth
> 3)
2505 error ("Invalid depth in char-table");
2506 size
= ASIZE (tmp
) - 2;
2507 if (chartab_size
[depth
] != size
)
2508 error ("Invalid size char-table");
2509 XSETPVECTYPE (XVECTOR (tmp
), PVEC_SUB_CHAR_TABLE
);
2512 invalid_syntax ("#^^");
2514 invalid_syntax ("#^");
2519 length
= read1 (readcharfun
, pch
, first_in_list
);
2523 Lisp_Object tmp
, val
;
2524 EMACS_INT size_in_chars
2525 = ((XFASTINT (length
) + BOOL_VECTOR_BITS_PER_CHAR
- 1)
2526 / BOOL_VECTOR_BITS_PER_CHAR
);
2529 tmp
= read1 (readcharfun
, pch
, first_in_list
);
2530 if (STRING_MULTIBYTE (tmp
)
2531 || (size_in_chars
!= SCHARS (tmp
)
2532 /* We used to print 1 char too many
2533 when the number of bits was a multiple of 8.
2534 Accept such input in case it came from an old
2536 && ! (XFASTINT (length
)
2537 == (SCHARS (tmp
) - 1) * BOOL_VECTOR_BITS_PER_CHAR
)))
2538 invalid_syntax ("#&...");
2540 val
= Fmake_bool_vector (length
, Qnil
);
2541 memcpy (XBOOL_VECTOR (val
)->data
, SDATA (tmp
), size_in_chars
);
2542 /* Clear the extraneous bits in the last byte. */
2543 if (XINT (length
) != size_in_chars
* BOOL_VECTOR_BITS_PER_CHAR
)
2544 XBOOL_VECTOR (val
)->data
[size_in_chars
- 1]
2545 &= (1 << (XINT (length
) % BOOL_VECTOR_BITS_PER_CHAR
)) - 1;
2548 invalid_syntax ("#&...");
2552 /* Accept compiled functions at read-time so that we don't have to
2553 build them using function calls. */
2555 tmp
= read_vector (readcharfun
, 1);
2556 return Fmake_byte_code (ASIZE (tmp
),
2557 XVECTOR (tmp
)->contents
);
2562 struct gcpro gcpro1
;
2565 /* Read the string itself. */
2566 tmp
= read1 (readcharfun
, &ch
, 0);
2567 if (ch
!= 0 || !STRINGP (tmp
))
2568 invalid_syntax ("#");
2570 /* Read the intervals and their properties. */
2573 Lisp_Object beg
, end
, plist
;
2575 beg
= read1 (readcharfun
, &ch
, 0);
2580 end
= read1 (readcharfun
, &ch
, 0);
2582 plist
= read1 (readcharfun
, &ch
, 0);
2584 invalid_syntax ("Invalid string property list");
2585 Fset_text_properties (beg
, end
, plist
, tmp
);
2591 /* #@NUMBER is used to skip NUMBER following characters.
2592 That's used in .elc files to skip over doc strings
2593 and function definitions. */
2596 enum { extra
= 100 };
2597 ptrdiff_t i
, nskip
= 0;
2600 /* Read a decimal integer. */
2601 while ((c
= READCHAR
) >= 0
2602 && c
>= '0' && c
<= '9')
2604 if ((STRING_BYTES_BOUND
- extra
) / 10 <= nskip
)
2611 if (load_force_doc_strings
2612 && (EQ (readcharfun
, Qget_file_char
)
2613 || EQ (readcharfun
, Qget_emacs_mule_file_char
)))
2615 /* If we are supposed to force doc strings into core right now,
2616 record the last string that we skipped,
2617 and record where in the file it comes from. */
2619 /* But first exchange saved_doc_string
2620 with prev_saved_doc_string, so we save two strings. */
2622 char *temp
= saved_doc_string
;
2623 ptrdiff_t temp_size
= saved_doc_string_size
;
2624 file_offset temp_pos
= saved_doc_string_position
;
2625 ptrdiff_t temp_len
= saved_doc_string_length
;
2627 saved_doc_string
= prev_saved_doc_string
;
2628 saved_doc_string_size
= prev_saved_doc_string_size
;
2629 saved_doc_string_position
= prev_saved_doc_string_position
;
2630 saved_doc_string_length
= prev_saved_doc_string_length
;
2632 prev_saved_doc_string
= temp
;
2633 prev_saved_doc_string_size
= temp_size
;
2634 prev_saved_doc_string_position
= temp_pos
;
2635 prev_saved_doc_string_length
= temp_len
;
2638 if (saved_doc_string_size
== 0)
2640 saved_doc_string_size
= nskip
+ extra
;
2641 saved_doc_string
= (char *) xmalloc (saved_doc_string_size
);
2643 if (nskip
> saved_doc_string_size
)
2645 saved_doc_string_size
= nskip
+ extra
;
2646 saved_doc_string
= (char *) xrealloc (saved_doc_string
,
2647 saved_doc_string_size
);
2650 saved_doc_string_position
= file_tell (instream
);
2652 /* Copy that many characters into saved_doc_string. */
2653 for (i
= 0; i
< nskip
&& c
>= 0; i
++)
2654 saved_doc_string
[i
] = c
= READCHAR
;
2656 saved_doc_string_length
= i
;
2660 /* Skip that many characters. */
2661 for (i
= 0; i
< nskip
&& c
>= 0; i
++)
2670 /* #! appears at the beginning of an executable file.
2671 Skip the first line. */
2672 while (c
!= '\n' && c
>= 0)
2677 return Vload_file_name
;
2679 return Fcons (Qfunction
, Fcons (read0 (readcharfun
), Qnil
));
2680 /* #:foo is the uninterned symbol named foo. */
2683 uninterned_symbol
= 1;
2688 || strchr ("\"';()[]#`,", c
) == NULL
)))
2690 /* No symbol character follows, this is the empty
2693 return Fmake_symbol (build_string (""));
2697 /* ## is the empty symbol. */
2699 return Fintern (build_string (""), Qnil
);
2700 /* Reader forms that can reuse previously read objects. */
2701 if (c
>= '0' && c
<= '9')
2706 /* Read a non-negative integer. */
2707 while (c
>= '0' && c
<= '9')
2709 if (MOST_POSITIVE_FIXNUM
/ 10 < n
2710 || MOST_POSITIVE_FIXNUM
< n
* 10 + c
- '0')
2711 n
= MOST_POSITIVE_FIXNUM
+ 1;
2713 n
= n
* 10 + c
- '0';
2717 if (n
<= MOST_POSITIVE_FIXNUM
)
2719 if (c
== 'r' || c
== 'R')
2720 return read_integer (readcharfun
, n
);
2722 if (! NILP (Vread_circle
))
2724 /* #n=object returns object, but associates it with
2728 /* Make a placeholder for #n# to use temporarily */
2729 Lisp_Object placeholder
;
2732 placeholder
= Fcons (Qnil
, Qnil
);
2733 cell
= Fcons (make_number (n
), placeholder
);
2734 read_objects
= Fcons (cell
, read_objects
);
2736 /* Read the object itself. */
2737 tem
= read0 (readcharfun
);
2739 /* Now put it everywhere the placeholder was... */
2740 substitute_object_in_subtree (tem
, placeholder
);
2742 /* ...and #n# will use the real value from now on. */
2743 Fsetcdr (cell
, tem
);
2748 /* #n# returns a previously read object. */
2751 tem
= Fassq (make_number (n
), read_objects
);
2757 /* Fall through to error message. */
2759 else if (c
== 'x' || c
== 'X')
2760 return read_integer (readcharfun
, 16);
2761 else if (c
== 'o' || c
== 'O')
2762 return read_integer (readcharfun
, 8);
2763 else if (c
== 'b' || c
== 'B')
2764 return read_integer (readcharfun
, 2);
2767 invalid_syntax ("#");
2770 while ((c
= READCHAR
) >= 0 && c
!= '\n');
2775 return Fcons (Qquote
, Fcons (read0 (readcharfun
), Qnil
));
2780 int next_char
= READCHAR
;
2782 /* Transition from old-style to new-style:
2783 If we see "(`" it used to mean old-style, which usually works
2784 fine because ` should almost never appear in such a position
2785 for new-style. But occasionally we need "(`" to mean new
2786 style, so we try to distinguish the two by the fact that we
2787 can either write "( `foo" or "(` foo", where the first
2788 intends to use new-style whereas the second intends to use
2789 old-style. For Emacs-25, we should completely remove this
2790 first_in_list exception (old-style can still be obtained via
2792 if (!new_backquote_flag
&& first_in_list
&& next_char
== ' ')
2794 Vold_style_backquotes
= Qt
;
2801 new_backquote_flag
++;
2802 value
= read0 (readcharfun
);
2803 new_backquote_flag
--;
2805 return Fcons (Qbackquote
, Fcons (value
, Qnil
));
2810 int next_char
= READCHAR
;
2812 /* Transition from old-style to new-style:
2813 It used to be impossible to have a new-style , other than within
2814 a new-style `. This is sufficient when ` and , are used in the
2815 normal way, but ` and , can also appear in args to macros that
2816 will not interpret them in the usual way, in which case , may be
2817 used without any ` anywhere near.
2818 So we now use the same heuristic as for backquote: old-style
2819 unquotes are only recognized when first on a list, and when
2820 followed by a space.
2821 Because it's more difficult to peak 2 chars ahead, a new-style
2822 ,@ can still not be used outside of a `, unless it's in the middle
2824 if (new_backquote_flag
2826 || (next_char
!= ' ' && next_char
!= '@'))
2828 Lisp_Object comma_type
= Qnil
;
2833 comma_type
= Qcomma_at
;
2835 comma_type
= Qcomma_dot
;
2838 if (ch
>= 0) UNREAD (ch
);
2839 comma_type
= Qcomma
;
2842 value
= read0 (readcharfun
);
2843 return Fcons (comma_type
, Fcons (value
, Qnil
));
2847 Vold_style_backquotes
= Qt
;
2859 end_of_file_error ();
2861 /* Accept `single space' syntax like (list ? x) where the
2862 whitespace character is SPC or TAB.
2863 Other literal whitespace like NL, CR, and FF are not accepted,
2864 as there are well-established escape sequences for these. */
2865 if (c
== ' ' || c
== '\t')
2866 return make_number (c
);
2869 c
= read_escape (readcharfun
, 0);
2870 modifiers
= c
& CHAR_MODIFIER_MASK
;
2871 c
&= ~CHAR_MODIFIER_MASK
;
2872 if (CHAR_BYTE8_P (c
))
2873 c
= CHAR_TO_BYTE8 (c
);
2876 next_char
= READCHAR
;
2877 ok
= (next_char
<= 040
2878 || (next_char
< 0200
2879 && strchr ("\"';()[]#?`,.", next_char
) != NULL
));
2882 return make_number (c
);
2884 invalid_syntax ("?");
2889 char *p
= read_buffer
;
2890 char *end
= read_buffer
+ read_buffer_size
;
2892 /* Nonzero if we saw an escape sequence specifying
2893 a multibyte character. */
2894 int force_multibyte
= 0;
2895 /* Nonzero if we saw an escape sequence specifying
2896 a single-byte character. */
2897 int force_singlebyte
= 0;
2899 ptrdiff_t nchars
= 0;
2901 while ((ch
= READCHAR
) >= 0
2904 if (end
- p
< MAX_MULTIBYTE_LENGTH
)
2906 ptrdiff_t offset
= p
- read_buffer
;
2907 if (min (PTRDIFF_MAX
, SIZE_MAX
) / 2 < read_buffer_size
)
2908 memory_full (SIZE_MAX
);
2909 read_buffer
= (char *) xrealloc (read_buffer
,
2910 read_buffer_size
*= 2);
2911 p
= read_buffer
+ offset
;
2912 end
= read_buffer
+ read_buffer_size
;
2919 ch
= read_escape (readcharfun
, 1);
2921 /* CH is -1 if \ newline has just been seen */
2924 if (p
== read_buffer
)
2929 modifiers
= ch
& CHAR_MODIFIER_MASK
;
2930 ch
= ch
& ~CHAR_MODIFIER_MASK
;
2932 if (CHAR_BYTE8_P (ch
))
2933 force_singlebyte
= 1;
2934 else if (! ASCII_CHAR_P (ch
))
2935 force_multibyte
= 1;
2936 else /* i.e. ASCII_CHAR_P (ch) */
2938 /* Allow `\C- ' and `\C-?'. */
2939 if (modifiers
== CHAR_CTL
)
2942 ch
= 0, modifiers
= 0;
2944 ch
= 127, modifiers
= 0;
2946 if (modifiers
& CHAR_SHIFT
)
2948 /* Shift modifier is valid only with [A-Za-z]. */
2949 if (ch
>= 'A' && ch
<= 'Z')
2950 modifiers
&= ~CHAR_SHIFT
;
2951 else if (ch
>= 'a' && ch
<= 'z')
2952 ch
-= ('a' - 'A'), modifiers
&= ~CHAR_SHIFT
;
2955 if (modifiers
& CHAR_META
)
2957 /* Move the meta bit to the right place for a
2959 modifiers
&= ~CHAR_META
;
2960 ch
= BYTE8_TO_CHAR (ch
| 0x80);
2961 force_singlebyte
= 1;
2965 /* Any modifiers remaining are invalid. */
2967 error ("Invalid modifier in string");
2968 p
+= CHAR_STRING (ch
, (unsigned char *) p
);
2972 p
+= CHAR_STRING (ch
, (unsigned char *) p
);
2973 if (CHAR_BYTE8_P (ch
))
2974 force_singlebyte
= 1;
2975 else if (! ASCII_CHAR_P (ch
))
2976 force_multibyte
= 1;
2982 end_of_file_error ();
2984 /* If purifying, and string starts with \ newline,
2985 return zero instead. This is for doc strings
2986 that we are really going to find in etc/DOC.nn.nn */
2987 if (!NILP (Vpurify_flag
) && NILP (Vdoc_file_name
) && cancel
)
2988 return make_number (0);
2990 if (force_multibyte
)
2991 /* READ_BUFFER already contains valid multibyte forms. */
2993 else if (force_singlebyte
)
2995 nchars
= str_as_unibyte ((unsigned char *) read_buffer
,
2997 p
= read_buffer
+ nchars
;
3001 /* Otherwise, READ_BUFFER contains only ASCII. */
3005 return make_pure_string (read_buffer
, nchars
, p
- read_buffer
,
3007 || (p
- read_buffer
!= nchars
)));
3008 return make_specified_string (read_buffer
, nchars
, p
- read_buffer
,
3010 || (p
- read_buffer
!= nchars
)));
3015 int next_char
= READCHAR
;
3018 if (next_char
<= 040
3019 || (next_char
< 0200
3020 && strchr ("\"';([#?`,", next_char
) != NULL
))
3026 /* Otherwise, we fall through! Note that the atom-reading loop
3027 below will now loop at least once, assuring that we will not
3028 try to UNREAD two characters in a row. */
3032 if (c
<= 040) goto retry
;
3033 if (c
== 0x8a0) /* NBSP */
3038 char *p
= read_buffer
;
3040 EMACS_INT start_position
= readchar_count
- 1;
3043 char *end
= read_buffer
+ read_buffer_size
;
3047 if (end
- p
< MAX_MULTIBYTE_LENGTH
)
3049 ptrdiff_t offset
= p
- read_buffer
;
3050 if (min (PTRDIFF_MAX
, SIZE_MAX
) / 2 < read_buffer_size
)
3051 memory_full (SIZE_MAX
);
3052 read_buffer
= (char *) xrealloc (read_buffer
,
3053 read_buffer_size
*= 2);
3054 p
= read_buffer
+ offset
;
3055 end
= read_buffer
+ read_buffer_size
;
3062 end_of_file_error ();
3067 p
+= CHAR_STRING (c
, (unsigned char *) p
);
3073 && c
!= 0x8a0 /* NBSP */
3075 || strchr ("\"';()[]#`,", c
) == NULL
));
3079 ptrdiff_t offset
= p
- read_buffer
;
3080 if (min (PTRDIFF_MAX
, SIZE_MAX
) / 2 < read_buffer_size
)
3081 memory_full (SIZE_MAX
);
3082 read_buffer
= (char *) xrealloc (read_buffer
,
3083 read_buffer_size
*= 2);
3084 p
= read_buffer
+ offset
;
3085 end
= read_buffer
+ read_buffer_size
;
3091 if (!quoted
&& !uninterned_symbol
)
3093 Lisp_Object result
= string_to_number (read_buffer
, 10, 0);
3094 if (! NILP (result
))
3098 Lisp_Object name
, result
;
3099 EMACS_INT nbytes
= p
- read_buffer
;
3102 ? multibyte_chars_in_text ((unsigned char *) read_buffer
,
3106 if (uninterned_symbol
&& ! NILP (Vpurify_flag
))
3107 name
= make_pure_string (read_buffer
, nchars
, nbytes
, multibyte
);
3109 name
= make_specified_string (read_buffer
, nchars
, nbytes
,multibyte
);
3110 result
= (uninterned_symbol
? Fmake_symbol (name
)
3111 : Fintern (name
, Qnil
));
3113 if (EQ (Vread_with_symbol_positions
, Qt
)
3114 || EQ (Vread_with_symbol_positions
, readcharfun
))
3115 Vread_symbol_positions_list
=
3116 Fcons (Fcons (result
, make_number (start_position
)),
3117 Vread_symbol_positions_list
);
3125 /* List of nodes we've seen during substitute_object_in_subtree. */
3126 static Lisp_Object seen_list
;
3129 substitute_object_in_subtree (Lisp_Object object
, Lisp_Object placeholder
)
3131 Lisp_Object check_object
;
3133 /* We haven't seen any objects when we start. */
3136 /* Make all the substitutions. */
3138 = substitute_object_recurse (object
, placeholder
, object
);
3140 /* Clear seen_list because we're done with it. */
3143 /* The returned object here is expected to always eq the
3145 if (!EQ (check_object
, object
))
3146 error ("Unexpected mutation error in reader");
3149 /* Feval doesn't get called from here, so no gc protection is needed. */
3150 #define SUBSTITUTE(get_val, set_val) \
3152 Lisp_Object old_value = get_val; \
3153 Lisp_Object true_value \
3154 = substitute_object_recurse (object, placeholder, \
3157 if (!EQ (old_value, true_value)) \
3164 substitute_object_recurse (Lisp_Object object
, Lisp_Object placeholder
, Lisp_Object subtree
)
3166 /* If we find the placeholder, return the target object. */
3167 if (EQ (placeholder
, subtree
))
3170 /* If we've been to this node before, don't explore it again. */
3171 if (!EQ (Qnil
, Fmemq (subtree
, seen_list
)))
3174 /* If this node can be the entry point to a cycle, remember that
3175 we've seen it. It can only be such an entry point if it was made
3176 by #n=, which means that we can find it as a value in
3178 if (!EQ (Qnil
, Frassq (subtree
, read_objects
)))
3179 seen_list
= Fcons (subtree
, seen_list
);
3181 /* Recurse according to subtree's type.
3182 Every branch must return a Lisp_Object. */
3183 switch (XTYPE (subtree
))
3185 case Lisp_Vectorlike
:
3187 ptrdiff_t i
, length
= 0;
3188 if (BOOL_VECTOR_P (subtree
))
3189 return subtree
; /* No sub-objects anyway. */
3190 else if (CHAR_TABLE_P (subtree
) || SUB_CHAR_TABLE_P (subtree
)
3191 || COMPILEDP (subtree
))
3192 length
= ASIZE (subtree
) & PSEUDOVECTOR_SIZE_MASK
;
3193 else if (VECTORP (subtree
))
3194 length
= ASIZE (subtree
);
3196 /* An unknown pseudovector may contain non-Lisp fields, so we
3197 can't just blindly traverse all its fields. We used to call
3198 `Flength' which signaled `sequencep', so I just preserved this
3200 wrong_type_argument (Qsequencep
, subtree
);
3202 for (i
= 0; i
< length
; i
++)
3203 SUBSTITUTE (AREF (subtree
, i
),
3204 ASET (subtree
, i
, true_value
));
3210 SUBSTITUTE (XCAR (subtree
),
3211 XSETCAR (subtree
, true_value
));
3212 SUBSTITUTE (XCDR (subtree
),
3213 XSETCDR (subtree
, true_value
));
3219 /* Check for text properties in each interval.
3220 substitute_in_interval contains part of the logic. */
3222 INTERVAL root_interval
= STRING_INTERVALS (subtree
);
3223 Lisp_Object arg
= Fcons (object
, placeholder
);
3225 traverse_intervals_noorder (root_interval
,
3226 &substitute_in_interval
, arg
);
3231 /* Other types don't recurse any further. */
3237 /* Helper function for substitute_object_recurse. */
3239 substitute_in_interval (INTERVAL interval
, Lisp_Object arg
)
3241 Lisp_Object object
= Fcar (arg
);
3242 Lisp_Object placeholder
= Fcdr (arg
);
3244 SUBSTITUTE (interval
->plist
, interval
->plist
= true_value
);
3254 /* Convert STRING to a number, assuming base BASE. Return a fixnum if CP has
3255 integer syntax and fits in a fixnum, else return the nearest float if CP has
3256 either floating point or integer syntax and BASE is 10, else return nil. If
3257 IGNORE_TRAILING is nonzero, consider just the longest prefix of CP that has
3258 valid floating point syntax. Signal an overflow if BASE is not 10 and the
3259 number has integer syntax but does not fit. */
3262 string_to_number (char const *string
, int base
, int ignore_trailing
)
3265 char const *cp
= string
;
3267 int float_syntax
= 0;
3270 /* Compute NaN and infinities using a variable, to cope with compilers that
3271 think they are smarter than we are. */
3274 /* Negate the value ourselves. This treats 0, NaNs, and infinity properly on
3275 IEEE floating point hosts, and works around a formerly-common bug where
3276 atof ("-0.0") drops the sign. */
3277 int negative
= *cp
== '-';
3279 int signedp
= negative
|| *cp
== '+';
3284 leading_digit
= digit_to_number (*cp
, base
);
3285 if (0 <= leading_digit
)
3290 while (0 <= digit_to_number (*cp
, base
));
3300 if ('0' <= *cp
&& *cp
<= '9')
3305 while ('0' <= *cp
&& *cp
<= '9');
3307 if (*cp
== 'e' || *cp
== 'E')
3309 char const *ecp
= cp
;
3311 if (*cp
== '+' || *cp
== '-')
3313 if ('0' <= *cp
&& *cp
<= '9')
3318 while ('0' <= *cp
&& *cp
<= '9');
3320 else if (cp
[-1] == '+'
3321 && cp
[0] == 'I' && cp
[1] == 'N' && cp
[2] == 'F')
3327 else if (cp
[-1] == '+'
3328 && cp
[0] == 'N' && cp
[1] == 'a' && cp
[2] == 'N')
3332 value
= zero
/ zero
;
3334 /* If that made a "negative" NaN, negate it. */
3337 union { double d
; char c
[sizeof (double)]; }
3338 u_data
, u_minus_zero
;
3340 u_minus_zero
.d
= -0.0;
3341 for (i
= 0; i
< sizeof (double); i
++)
3342 if (u_data
.c
[i
] & u_minus_zero
.c
[i
])
3348 /* Now VALUE is a positive NaN. */
3354 float_syntax
= ((state
& (DOT_CHAR
|TRAIL_INT
)) == (DOT_CHAR
|TRAIL_INT
)
3355 || state
== (LEAD_INT
|E_EXP
));
3358 /* Return nil if the number uses invalid syntax. If IGNORE_TRAILING, accept
3359 any prefix that matches. Otherwise, the entire string must match. */
3360 if (! (ignore_trailing
3361 ? ((state
& LEAD_INT
) != 0 || float_syntax
)
3362 : (!*cp
&& ((state
& ~DOT_CHAR
) == LEAD_INT
|| float_syntax
))))
3365 /* If the number uses integer and not float syntax, and is in C-language
3366 range, use its value, preferably as a fixnum. */
3367 if (0 <= leading_digit
&& ! float_syntax
)
3371 /* Fast special case for single-digit integers. This also avoids a
3372 glitch when BASE is 16 and IGNORE_TRAILING is nonzero, because in that
3373 case some versions of strtoumax accept numbers like "0x1" that Emacs
3375 if (digit_to_number (string
[signedp
+ 1], base
) < 0)
3376 return make_number (negative
? -leading_digit
: leading_digit
);
3379 n
= strtoumax (string
+ signedp
, NULL
, base
);
3380 if (errno
== ERANGE
)
3382 /* Unfortunately there's no simple and accurate way to convert
3383 non-base-10 numbers that are out of C-language range. */
3385 xsignal1 (Qoverflow_error
, build_string (string
));
3387 else if (n
<= (negative
? -MOST_NEGATIVE_FIXNUM
: MOST_POSITIVE_FIXNUM
))
3389 EMACS_INT signed_n
= n
;
3390 return make_number (negative
? -signed_n
: signed_n
);
3396 /* Either the number uses float syntax, or it does not fit into a fixnum.
3397 Convert it from string to floating point, unless the value is already
3398 known because it is an infinity, a NAN, or its absolute value fits in
3401 value
= atof (string
+ signedp
);
3403 return make_float (negative
? -value
: value
);
3408 read_vector (Lisp_Object readcharfun
, int bytecodeflag
)
3411 register Lisp_Object
*ptr
;
3412 register Lisp_Object tem
, item
, vector
;
3413 register struct Lisp_Cons
*otem
;
3416 tem
= read_list (1, readcharfun
);
3417 len
= Flength (tem
);
3418 vector
= (read_pure
? make_pure_vector (XINT (len
)) : Fmake_vector (len
, Qnil
));
3420 size
= ASIZE (vector
);
3421 ptr
= XVECTOR (vector
)->contents
;
3422 for (i
= 0; i
< size
; i
++)
3425 /* If `load-force-doc-strings' is t when reading a lazily-loaded
3426 bytecode object, the docstring containing the bytecode and
3427 constants values must be treated as unibyte and passed to
3428 Fread, to get the actual bytecode string and constants vector. */
3429 if (bytecodeflag
&& load_force_doc_strings
)
3431 if (i
== COMPILED_BYTECODE
)
3433 if (!STRINGP (item
))
3434 error ("Invalid byte code");
3436 /* Delay handling the bytecode slot until we know whether
3437 it is lazily-loaded (we can tell by whether the
3438 constants slot is nil). */
3439 ptr
[COMPILED_CONSTANTS
] = item
;
3442 else if (i
== COMPILED_CONSTANTS
)
3444 Lisp_Object bytestr
= ptr
[COMPILED_CONSTANTS
];
3448 /* Coerce string to unibyte (like string-as-unibyte,
3449 but without generating extra garbage and
3450 guaranteeing no change in the contents). */
3451 STRING_SET_CHARS (bytestr
, SBYTES (bytestr
));
3452 STRING_SET_UNIBYTE (bytestr
);
3454 item
= Fread (Fcons (bytestr
, readcharfun
));
3456 error ("Invalid byte code");
3458 otem
= XCONS (item
);
3459 bytestr
= XCAR (item
);
3464 /* Now handle the bytecode slot. */
3465 ptr
[COMPILED_BYTECODE
] = read_pure
? Fpurecopy (bytestr
) : bytestr
;
3467 else if (i
== COMPILED_DOC_STRING
3469 && ! STRING_MULTIBYTE (item
))
3471 if (EQ (readcharfun
, Qget_emacs_mule_file_char
))
3472 item
= Fdecode_coding_string (item
, Qemacs_mule
, Qnil
, Qnil
);
3474 item
= Fstring_as_multibyte (item
);
3477 ptr
[i
] = read_pure
? Fpurecopy (item
) : item
;
3485 /* FLAG = 1 means check for ] to terminate rather than ) and .
3486 FLAG = -1 means check for starting with defun
3487 and make structure pure. */
3490 read_list (int flag
, register Lisp_Object readcharfun
)
3492 /* -1 means check next element for defun,
3493 0 means don't check,
3494 1 means already checked and found defun. */
3495 int defunflag
= flag
< 0 ? -1 : 0;
3496 Lisp_Object val
, tail
;
3497 register Lisp_Object elt
, tem
;
3498 struct gcpro gcpro1
, gcpro2
;
3499 /* 0 is the normal case.
3500 1 means this list is a doc reference; replace it with the number 0.
3501 2 means this list is a doc reference; replace it with the doc string. */
3502 int doc_reference
= 0;
3504 /* Initialize this to 1 if we are reading a list. */
3505 int first_in_list
= flag
<= 0;
3514 elt
= read1 (readcharfun
, &ch
, first_in_list
);
3519 /* While building, if the list starts with #$, treat it specially. */
3520 if (EQ (elt
, Vload_file_name
)
3522 && !NILP (Vpurify_flag
))
3524 if (NILP (Vdoc_file_name
))
3525 /* We have not yet called Snarf-documentation, so assume
3526 this file is described in the DOC-MM.NN file
3527 and Snarf-documentation will fill in the right value later.
3528 For now, replace the whole list with 0. */
3531 /* We have already called Snarf-documentation, so make a relative
3532 file name for this file, so it can be found properly
3533 in the installed Lisp directory.
3534 We don't use Fexpand_file_name because that would make
3535 the directory absolute now. */
3536 elt
= concat2 (build_string ("../lisp/"),
3537 Ffile_name_nondirectory (elt
));
3539 else if (EQ (elt
, Vload_file_name
)
3541 && load_force_doc_strings
)
3550 invalid_syntax (") or . in a vector");
3558 XSETCDR (tail
, read0 (readcharfun
));
3560 val
= read0 (readcharfun
);
3561 read1 (readcharfun
, &ch
, 0);
3565 if (doc_reference
== 1)
3566 return make_number (0);
3567 if (doc_reference
== 2)
3569 /* Get a doc string from the file we are loading.
3570 If it's in saved_doc_string, get it from there.
3572 Here, we don't know if the string is a
3573 bytecode string or a doc string. As a
3574 bytecode string must be unibyte, we always
3575 return a unibyte string. If it is actually a
3576 doc string, caller must make it
3579 EMACS_INT pos
= XINT (XCDR (val
));
3580 /* Position is negative for user variables. */
3581 if (pos
< 0) pos
= -pos
;
3582 if (pos
>= saved_doc_string_position
3583 && pos
< (saved_doc_string_position
3584 + saved_doc_string_length
))
3586 ptrdiff_t start
= pos
- saved_doc_string_position
;
3589 /* Process quoting with ^A,
3590 and find the end of the string,
3591 which is marked with ^_ (037). */
3592 for (from
= start
, to
= start
;
3593 saved_doc_string
[from
] != 037;)
3595 int c
= saved_doc_string
[from
++];
3598 c
= saved_doc_string
[from
++];
3600 saved_doc_string
[to
++] = c
;
3602 saved_doc_string
[to
++] = 0;
3604 saved_doc_string
[to
++] = 037;
3607 saved_doc_string
[to
++] = c
;
3610 return make_unibyte_string (saved_doc_string
+ start
,
3613 /* Look in prev_saved_doc_string the same way. */
3614 else if (pos
>= prev_saved_doc_string_position
3615 && pos
< (prev_saved_doc_string_position
3616 + prev_saved_doc_string_length
))
3619 pos
- prev_saved_doc_string_position
;
3622 /* Process quoting with ^A,
3623 and find the end of the string,
3624 which is marked with ^_ (037). */
3625 for (from
= start
, to
= start
;
3626 prev_saved_doc_string
[from
] != 037;)
3628 int c
= prev_saved_doc_string
[from
++];
3631 c
= prev_saved_doc_string
[from
++];
3633 prev_saved_doc_string
[to
++] = c
;
3635 prev_saved_doc_string
[to
++] = 0;
3637 prev_saved_doc_string
[to
++] = 037;
3640 prev_saved_doc_string
[to
++] = c
;
3643 return make_unibyte_string (prev_saved_doc_string
3648 return get_doc_string (val
, 1, 0);
3653 invalid_syntax (". in wrong context");
3655 invalid_syntax ("] in a list");
3657 tem
= (read_pure
&& flag
<= 0
3658 ? pure_cons (elt
, Qnil
)
3659 : Fcons (elt
, Qnil
));
3661 XSETCDR (tail
, tem
);
3666 defunflag
= EQ (elt
, Qdefun
);
3667 else if (defunflag
> 0)
3672 static Lisp_Object initial_obarray
;
3674 /* oblookup stores the bucket number here, for the sake of Funintern. */
3676 static size_t oblookup_last_bucket_number
;
3678 /* Get an error if OBARRAY is not an obarray.
3679 If it is one, return it. */
3682 check_obarray (Lisp_Object obarray
)
3684 if (!VECTORP (obarray
) || ASIZE (obarray
) == 0)
3686 /* If Vobarray is now invalid, force it to be valid. */
3687 if (EQ (Vobarray
, obarray
)) Vobarray
= initial_obarray
;
3688 wrong_type_argument (Qvectorp
, obarray
);
3693 /* Intern the C string STR: return a symbol with that name,
3694 interned in the current obarray. */
3697 intern (const char *str
)
3700 ptrdiff_t len
= strlen (str
);
3701 Lisp_Object obarray
;
3704 if (!VECTORP (obarray
) || ASIZE (obarray
) == 0)
3705 obarray
= check_obarray (obarray
);
3706 tem
= oblookup (obarray
, str
, len
, len
);
3709 return Fintern (make_string (str
, len
), obarray
);
3713 intern_c_string (const char *str
)
3716 ptrdiff_t len
= strlen (str
);
3717 Lisp_Object obarray
;
3720 if (!VECTORP (obarray
) || ASIZE (obarray
) == 0)
3721 obarray
= check_obarray (obarray
);
3722 tem
= oblookup (obarray
, str
, len
, len
);
3726 if (NILP (Vpurify_flag
))
3727 /* Creating a non-pure string from a string literal not
3728 implemented yet. We could just use make_string here and live
3729 with the extra copy. */
3732 return Fintern (make_pure_c_string (str
), obarray
);
3735 DEFUN ("intern", Fintern
, Sintern
, 1, 2, 0,
3736 doc
: /* Return the canonical symbol whose name is STRING.
3737 If there is none, one is created by this function and returned.
3738 A second optional argument specifies the obarray to use;
3739 it defaults to the value of `obarray'. */)
3740 (Lisp_Object string
, Lisp_Object obarray
)
3742 register Lisp_Object tem
, sym
, *ptr
;
3744 if (NILP (obarray
)) obarray
= Vobarray
;
3745 obarray
= check_obarray (obarray
);
3747 CHECK_STRING (string
);
3749 tem
= oblookup (obarray
, SSDATA (string
),
3752 if (!INTEGERP (tem
))
3755 if (!NILP (Vpurify_flag
))
3756 string
= Fpurecopy (string
);
3757 sym
= Fmake_symbol (string
);
3759 if (EQ (obarray
, initial_obarray
))
3760 XSYMBOL (sym
)->interned
= SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
3762 XSYMBOL (sym
)->interned
= SYMBOL_INTERNED
;
3764 if ((SREF (string
, 0) == ':')
3765 && EQ (obarray
, initial_obarray
))
3767 XSYMBOL (sym
)->constant
= 1;
3768 XSYMBOL (sym
)->redirect
= SYMBOL_PLAINVAL
;
3769 SET_SYMBOL_VAL (XSYMBOL (sym
), sym
);
3772 ptr
= &XVECTOR (obarray
)->contents
[XINT (tem
)];
3774 XSYMBOL (sym
)->next
= XSYMBOL (*ptr
);
3776 XSYMBOL (sym
)->next
= 0;
3781 DEFUN ("intern-soft", Fintern_soft
, Sintern_soft
, 1, 2, 0,
3782 doc
: /* Return the canonical symbol named NAME, or nil if none exists.
3783 NAME may be a string or a symbol. If it is a symbol, that exact
3784 symbol is searched for.
3785 A second optional argument specifies the obarray to use;
3786 it defaults to the value of `obarray'. */)
3787 (Lisp_Object name
, Lisp_Object obarray
)
3789 register Lisp_Object tem
, string
;
3791 if (NILP (obarray
)) obarray
= Vobarray
;
3792 obarray
= check_obarray (obarray
);
3794 if (!SYMBOLP (name
))
3796 CHECK_STRING (name
);
3800 string
= SYMBOL_NAME (name
);
3802 tem
= oblookup (obarray
, SSDATA (string
), SCHARS (string
), SBYTES (string
));
3803 if (INTEGERP (tem
) || (SYMBOLP (name
) && !EQ (name
, tem
)))
3809 DEFUN ("unintern", Funintern
, Sunintern
, 1, 2, 0,
3810 doc
: /* Delete the symbol named NAME, if any, from OBARRAY.
3811 The value is t if a symbol was found and deleted, nil otherwise.
3812 NAME may be a string or a symbol. If it is a symbol, that symbol
3813 is deleted, if it belongs to OBARRAY--no other symbol is deleted.
3814 OBARRAY defaults to the value of the variable `obarray'. */)
3815 (Lisp_Object name
, Lisp_Object obarray
)
3817 register Lisp_Object string
, tem
;
3820 if (NILP (obarray
)) obarray
= Vobarray
;
3821 obarray
= check_obarray (obarray
);
3824 string
= SYMBOL_NAME (name
);
3827 CHECK_STRING (name
);
3831 tem
= oblookup (obarray
, SSDATA (string
),
3836 /* If arg was a symbol, don't delete anything but that symbol itself. */
3837 if (SYMBOLP (name
) && !EQ (name
, tem
))
3840 /* There are plenty of other symbols which will screw up the Emacs
3841 session if we unintern them, as well as even more ways to use
3842 `setq' or `fset' or whatnot to make the Emacs session
3843 unusable. Let's not go down this silly road. --Stef */
3844 /* if (EQ (tem, Qnil) || EQ (tem, Qt))
3845 error ("Attempt to unintern t or nil"); */
3847 XSYMBOL (tem
)->interned
= SYMBOL_UNINTERNED
;
3849 hash
= oblookup_last_bucket_number
;
3851 if (EQ (XVECTOR (obarray
)->contents
[hash
], tem
))
3853 if (XSYMBOL (tem
)->next
)
3854 XSETSYMBOL (XVECTOR (obarray
)->contents
[hash
], XSYMBOL (tem
)->next
);
3856 XSETINT (XVECTOR (obarray
)->contents
[hash
], 0);
3860 Lisp_Object tail
, following
;
3862 for (tail
= XVECTOR (obarray
)->contents
[hash
];
3863 XSYMBOL (tail
)->next
;
3866 XSETSYMBOL (following
, XSYMBOL (tail
)->next
);
3867 if (EQ (following
, tem
))
3869 XSYMBOL (tail
)->next
= XSYMBOL (following
)->next
;
3878 /* Return the symbol in OBARRAY whose names matches the string
3879 of SIZE characters (SIZE_BYTE bytes) at PTR.
3880 If there is no such symbol in OBARRAY, return nil.
3882 Also store the bucket number in oblookup_last_bucket_number. */
3885 oblookup (Lisp_Object obarray
, register const char *ptr
, EMACS_INT size
, EMACS_INT size_byte
)
3889 register Lisp_Object tail
;
3890 Lisp_Object bucket
, tem
;
3892 if (!VECTORP (obarray
)
3893 || (obsize
= ASIZE (obarray
)) == 0)
3895 obarray
= check_obarray (obarray
);
3896 obsize
= ASIZE (obarray
);
3898 /* This is sometimes needed in the middle of GC. */
3899 obsize
&= ~ARRAY_MARK_FLAG
;
3900 hash
= hash_string (ptr
, size_byte
) % obsize
;
3901 bucket
= XVECTOR (obarray
)->contents
[hash
];
3902 oblookup_last_bucket_number
= hash
;
3903 if (EQ (bucket
, make_number (0)))
3905 else if (!SYMBOLP (bucket
))
3906 error ("Bad data in guts of obarray"); /* Like CADR error message */
3908 for (tail
= bucket
; ; XSETSYMBOL (tail
, XSYMBOL (tail
)->next
))
3910 if (SBYTES (SYMBOL_NAME (tail
)) == size_byte
3911 && SCHARS (SYMBOL_NAME (tail
)) == size
3912 && !memcmp (SDATA (SYMBOL_NAME (tail
)), ptr
, size_byte
))
3914 else if (XSYMBOL (tail
)->next
== 0)
3917 XSETINT (tem
, hash
);
3922 map_obarray (Lisp_Object obarray
, void (*fn
) (Lisp_Object
, Lisp_Object
), Lisp_Object arg
)
3925 register Lisp_Object tail
;
3926 CHECK_VECTOR (obarray
);
3927 for (i
= ASIZE (obarray
) - 1; i
>= 0; i
--)
3929 tail
= XVECTOR (obarray
)->contents
[i
];
3934 if (XSYMBOL (tail
)->next
== 0)
3936 XSETSYMBOL (tail
, XSYMBOL (tail
)->next
);
3942 mapatoms_1 (Lisp_Object sym
, Lisp_Object function
)
3944 call1 (function
, sym
);
3947 DEFUN ("mapatoms", Fmapatoms
, Smapatoms
, 1, 2, 0,
3948 doc
: /* Call FUNCTION on every symbol in OBARRAY.
3949 OBARRAY defaults to the value of `obarray'. */)
3950 (Lisp_Object function
, Lisp_Object obarray
)
3952 if (NILP (obarray
)) obarray
= Vobarray
;
3953 obarray
= check_obarray (obarray
);
3955 map_obarray (obarray
, mapatoms_1
, function
);
3959 #define OBARRAY_SIZE 1511
3964 Lisp_Object oblength
;
3966 XSETFASTINT (oblength
, OBARRAY_SIZE
);
3968 Vobarray
= Fmake_vector (oblength
, make_number (0));
3969 initial_obarray
= Vobarray
;
3970 staticpro (&initial_obarray
);
3972 Qunbound
= Fmake_symbol (make_pure_c_string ("unbound"));
3973 /* Set temporary dummy values to Qnil and Vpurify_flag to satisfy the
3974 NILP (Vpurify_flag) check in intern_c_string. */
3975 Qnil
= make_number (-1); Vpurify_flag
= make_number (1);
3976 Qnil
= intern_c_string ("nil");
3978 /* Fmake_symbol inits fields of new symbols with Qunbound and Qnil,
3979 so those two need to be fixed manally. */
3980 SET_SYMBOL_VAL (XSYMBOL (Qunbound
), Qunbound
);
3981 XSYMBOL (Qunbound
)->function
= Qunbound
;
3982 XSYMBOL (Qunbound
)->plist
= Qnil
;
3983 /* XSYMBOL (Qnil)->function = Qunbound; */
3984 SET_SYMBOL_VAL (XSYMBOL (Qnil
), Qnil
);
3985 XSYMBOL (Qnil
)->constant
= 1;
3986 XSYMBOL (Qnil
)->plist
= Qnil
;
3988 Qt
= intern_c_string ("t");
3989 SET_SYMBOL_VAL (XSYMBOL (Qt
), Qt
);
3990 XSYMBOL (Qt
)->constant
= 1;
3992 /* Qt is correct even if CANNOT_DUMP. loadup.el will set to nil at end. */
3995 DEFSYM (Qvariable_documentation
, "variable-documentation");
3997 read_buffer_size
= 100 + MAX_MULTIBYTE_LENGTH
;
3998 read_buffer
= (char *) xmalloc (read_buffer_size
);
4002 defsubr (struct Lisp_Subr
*sname
)
4005 sym
= intern_c_string (sname
->symbol_name
);
4006 XSETTYPED_PVECTYPE (sname
, size
, PVEC_SUBR
);
4007 XSETSUBR (XSYMBOL (sym
)->function
, sname
);
4010 #ifdef NOTDEF /* use fset in subr.el now */
4012 defalias (struct Lisp_Subr
*sname
, char *string
)
4015 sym
= intern (string
);
4016 XSETSUBR (XSYMBOL (sym
)->function
, sname
);
4020 /* Define an "integer variable"; a symbol whose value is forwarded to a
4021 C variable of type EMACS_INT. Sample call (with "xx" to fool make-docfile):
4022 DEFxxVAR_INT ("emacs-priority", &emacs_priority, "Documentation"); */
4024 defvar_int (struct Lisp_Intfwd
*i_fwd
,
4025 const char *namestring
, EMACS_INT
*address
)
4028 sym
= intern_c_string (namestring
);
4029 i_fwd
->type
= Lisp_Fwd_Int
;
4030 i_fwd
->intvar
= address
;
4031 XSYMBOL (sym
)->declared_special
= 1;
4032 XSYMBOL (sym
)->redirect
= SYMBOL_FORWARDED
;
4033 SET_SYMBOL_FWD (XSYMBOL (sym
), (union Lisp_Fwd
*)i_fwd
);
4036 /* Similar but define a variable whose value is t if address contains 1,
4037 nil if address contains 0. */
4039 defvar_bool (struct Lisp_Boolfwd
*b_fwd
,
4040 const char *namestring
, int *address
)
4043 sym
= intern_c_string (namestring
);
4044 b_fwd
->type
= Lisp_Fwd_Bool
;
4045 b_fwd
->boolvar
= address
;
4046 XSYMBOL (sym
)->declared_special
= 1;
4047 XSYMBOL (sym
)->redirect
= SYMBOL_FORWARDED
;
4048 SET_SYMBOL_FWD (XSYMBOL (sym
), (union Lisp_Fwd
*)b_fwd
);
4049 Vbyte_boolean_vars
= Fcons (sym
, Vbyte_boolean_vars
);
4052 /* Similar but define a variable whose value is the Lisp Object stored
4053 at address. Two versions: with and without gc-marking of the C
4054 variable. The nopro version is used when that variable will be
4055 gc-marked for some other reason, since marking the same slot twice
4056 can cause trouble with strings. */
4058 defvar_lisp_nopro (struct Lisp_Objfwd
*o_fwd
,
4059 const char *namestring
, Lisp_Object
*address
)
4062 sym
= intern_c_string (namestring
);
4063 o_fwd
->type
= Lisp_Fwd_Obj
;
4064 o_fwd
->objvar
= address
;
4065 XSYMBOL (sym
)->declared_special
= 1;
4066 XSYMBOL (sym
)->redirect
= SYMBOL_FORWARDED
;
4067 SET_SYMBOL_FWD (XSYMBOL (sym
), (union Lisp_Fwd
*)o_fwd
);
4071 defvar_lisp (struct Lisp_Objfwd
*o_fwd
,
4072 const char *namestring
, Lisp_Object
*address
)
4074 defvar_lisp_nopro (o_fwd
, namestring
, address
);
4075 staticpro (address
);
4078 /* Similar but define a variable whose value is the Lisp Object stored
4079 at a particular offset in the current kboard object. */
4082 defvar_kboard (struct Lisp_Kboard_Objfwd
*ko_fwd
,
4083 const char *namestring
, int offset
)
4086 sym
= intern_c_string (namestring
);
4087 ko_fwd
->type
= Lisp_Fwd_Kboard_Obj
;
4088 ko_fwd
->offset
= offset
;
4089 XSYMBOL (sym
)->declared_special
= 1;
4090 XSYMBOL (sym
)->redirect
= SYMBOL_FORWARDED
;
4091 SET_SYMBOL_FWD (XSYMBOL (sym
), (union Lisp_Fwd
*)ko_fwd
);
4094 /* Record the value of load-path used at the start of dumping
4095 so we can see if the site changed it later during dumping. */
4096 static Lisp_Object dump_path
;
4102 int turn_off_warning
= 0;
4104 /* Compute the default load-path. */
4106 normal
= PATH_LOADSEARCH
;
4107 Vload_path
= decode_env_path (0, normal
);
4109 if (NILP (Vpurify_flag
))
4110 normal
= PATH_LOADSEARCH
;
4112 normal
= PATH_DUMPLOADSEARCH
;
4114 /* In a dumped Emacs, we normally have to reset the value of
4115 Vload_path from PATH_LOADSEARCH, since the value that was dumped
4116 uses ../lisp, instead of the path of the installed elisp
4117 libraries. However, if it appears that Vload_path was changed
4118 from the default before dumping, don't override that value. */
4121 if (! NILP (Fequal (dump_path
, Vload_path
)))
4123 Vload_path
= decode_env_path (0, normal
);
4124 if (!NILP (Vinstallation_directory
))
4126 Lisp_Object tem
, tem1
, sitelisp
;
4128 /* Remove site-lisp dirs from path temporarily and store
4129 them in sitelisp, then conc them on at the end so
4130 they're always first in path. */
4134 tem
= Fcar (Vload_path
);
4135 tem1
= Fstring_match (build_string ("site-lisp"),
4139 Vload_path
= Fcdr (Vload_path
);
4140 sitelisp
= Fcons (tem
, sitelisp
);
4146 /* Add to the path the lisp subdir of the
4147 installation dir, if it exists. */
4148 tem
= Fexpand_file_name (build_string ("lisp"),
4149 Vinstallation_directory
);
4150 tem1
= Ffile_exists_p (tem
);
4153 if (NILP (Fmember (tem
, Vload_path
)))
4155 turn_off_warning
= 1;
4156 Vload_path
= Fcons (tem
, Vload_path
);
4160 /* That dir doesn't exist, so add the build-time
4161 Lisp dirs instead. */
4162 Vload_path
= nconc2 (Vload_path
, dump_path
);
4164 /* Add leim under the installation dir, if it exists. */
4165 tem
= Fexpand_file_name (build_string ("leim"),
4166 Vinstallation_directory
);
4167 tem1
= Ffile_exists_p (tem
);
4170 if (NILP (Fmember (tem
, Vload_path
)))
4171 Vload_path
= Fcons (tem
, Vload_path
);
4174 /* Add site-lisp under the installation dir, if it exists. */
4175 tem
= Fexpand_file_name (build_string ("site-lisp"),
4176 Vinstallation_directory
);
4177 tem1
= Ffile_exists_p (tem
);
4180 if (NILP (Fmember (tem
, Vload_path
)))
4181 Vload_path
= Fcons (tem
, Vload_path
);
4184 /* If Emacs was not built in the source directory,
4185 and it is run from where it was built, add to load-path
4186 the lisp, leim and site-lisp dirs under that directory. */
4188 if (NILP (Fequal (Vinstallation_directory
, Vsource_directory
)))
4192 tem
= Fexpand_file_name (build_string ("src/Makefile"),
4193 Vinstallation_directory
);
4194 tem1
= Ffile_exists_p (tem
);
4196 /* Don't be fooled if they moved the entire source tree
4197 AFTER dumping Emacs. If the build directory is indeed
4198 different from the source dir, src/Makefile.in and
4199 src/Makefile will not be found together. */
4200 tem
= Fexpand_file_name (build_string ("src/Makefile.in"),
4201 Vinstallation_directory
);
4202 tem2
= Ffile_exists_p (tem
);
4203 if (!NILP (tem1
) && NILP (tem2
))
4205 tem
= Fexpand_file_name (build_string ("lisp"),
4208 if (NILP (Fmember (tem
, Vload_path
)))
4209 Vload_path
= Fcons (tem
, Vload_path
);
4211 tem
= Fexpand_file_name (build_string ("leim"),
4214 if (NILP (Fmember (tem
, Vload_path
)))
4215 Vload_path
= Fcons (tem
, Vload_path
);
4217 tem
= Fexpand_file_name (build_string ("site-lisp"),
4220 if (NILP (Fmember (tem
, Vload_path
)))
4221 Vload_path
= Fcons (tem
, Vload_path
);
4224 if (!NILP (sitelisp
) && !no_site_lisp
)
4225 Vload_path
= nconc2 (Fnreverse (sitelisp
), Vload_path
);
4231 /* NORMAL refers to the lisp dir in the source directory. */
4232 /* We used to add ../lisp at the front here, but
4233 that caused trouble because it was copied from dump_path
4234 into Vload_path, above, when Vinstallation_directory was non-nil.
4235 It should be unnecessary. */
4236 Vload_path
= decode_env_path (0, normal
);
4237 dump_path
= Vload_path
;
4241 #if (!(defined (WINDOWSNT) || (defined (HAVE_NS))))
4242 /* When Emacs is invoked over network shares on NT, PATH_LOADSEARCH is
4243 almost never correct, thereby causing a warning to be printed out that
4244 confuses users. Since PATH_LOADSEARCH is always overridden by the
4245 EMACSLOADPATH environment variable below, disable the warning on NT. */
4247 /* Warn if dirs in the *standard* path don't exist. */
4248 if (!turn_off_warning
)
4250 Lisp_Object path_tail
;
4252 for (path_tail
= Vload_path
;
4254 path_tail
= XCDR (path_tail
))
4256 Lisp_Object dirfile
;
4257 dirfile
= Fcar (path_tail
);
4258 if (STRINGP (dirfile
))
4260 dirfile
= Fdirectory_file_name (dirfile
);
4261 if (access (SSDATA (dirfile
), 0) < 0)
4262 dir_warning ("Warning: Lisp directory `%s' does not exist.\n",
4267 #endif /* !(WINDOWSNT || HAVE_NS) */
4269 /* If the EMACSLOADPATH environment variable is set, use its value.
4270 This doesn't apply if we're dumping. */
4272 if (NILP (Vpurify_flag
)
4273 && egetenv ("EMACSLOADPATH"))
4275 Vload_path
= decode_env_path ("EMACSLOADPATH", normal
);
4279 load_in_progress
= 0;
4280 Vload_file_name
= Qnil
;
4282 load_descriptor_list
= Qnil
;
4284 Vstandard_input
= Qt
;
4285 Vloads_in_progress
= Qnil
;
4288 /* Print a warning, using format string FORMAT, that directory DIRNAME
4289 does not exist. Print it on stderr and put it in *Messages*. */
4292 dir_warning (const char *format
, Lisp_Object dirname
)
4295 = (char *) alloca (SCHARS (dirname
) + strlen (format
) + 5);
4297 fprintf (stderr
, format
, SDATA (dirname
));
4298 sprintf (buffer
, format
, SDATA (dirname
));
4299 /* Don't log the warning before we've initialized!! */
4301 message_dolog (buffer
, strlen (buffer
), 0, STRING_MULTIBYTE (dirname
));
4305 syms_of_lread (void)
4308 defsubr (&Sread_from_string
);
4310 defsubr (&Sintern_soft
);
4311 defsubr (&Sunintern
);
4312 defsubr (&Sget_load_suffixes
);
4314 defsubr (&Seval_buffer
);
4315 defsubr (&Seval_region
);
4316 defsubr (&Sread_char
);
4317 defsubr (&Sread_char_exclusive
);
4318 defsubr (&Sread_event
);
4319 defsubr (&Sget_file_char
);
4320 defsubr (&Smapatoms
);
4321 defsubr (&Slocate_file_internal
);
4323 DEFVAR_LISP ("obarray", Vobarray
,
4324 doc
: /* Symbol table for use by `intern' and `read'.
4325 It is a vector whose length ought to be prime for best results.
4326 The vector's contents don't make sense if examined from Lisp programs;
4327 to find all the symbols in an obarray, use `mapatoms'. */);
4329 DEFVAR_LISP ("values", Vvalues
,
4330 doc
: /* List of values of all expressions which were read, evaluated and printed.
4331 Order is reverse chronological. */);
4333 DEFVAR_LISP ("standard-input", Vstandard_input
,
4334 doc
: /* Stream for read to get input from.
4335 See documentation of `read' for possible values. */);
4336 Vstandard_input
= Qt
;
4338 DEFVAR_LISP ("read-with-symbol-positions", Vread_with_symbol_positions
,
4339 doc
: /* If non-nil, add position of read symbols to `read-symbol-positions-list'.
4341 If this variable is a buffer, then only forms read from that buffer
4342 will be added to `read-symbol-positions-list'.
4343 If this variable is t, then all read forms will be added.
4344 The effect of all other values other than nil are not currently
4345 defined, although they may be in the future.
4347 The positions are relative to the last call to `read' or
4348 `read-from-string'. It is probably a bad idea to set this variable at
4349 the toplevel; bind it instead. */);
4350 Vread_with_symbol_positions
= Qnil
;
4352 DEFVAR_LISP ("read-symbol-positions-list", Vread_symbol_positions_list
,
4353 doc
: /* A list mapping read symbols to their positions.
4354 This variable is modified during calls to `read' or
4355 `read-from-string', but only when `read-with-symbol-positions' is
4358 Each element of the list looks like (SYMBOL . CHAR-POSITION), where
4359 CHAR-POSITION is an integer giving the offset of that occurrence of the
4360 symbol from the position where `read' or `read-from-string' started.
4362 Note that a symbol will appear multiple times in this list, if it was
4363 read multiple times. The list is in the same order as the symbols
4365 Vread_symbol_positions_list
= Qnil
;
4367 DEFVAR_LISP ("read-circle", Vread_circle
,
4368 doc
: /* Non-nil means read recursive structures using #N= and #N# syntax. */);
4371 DEFVAR_LISP ("load-path", Vload_path
,
4372 doc
: /* *List of directories to search for files to load.
4373 Each element is a string (directory name) or nil (try default directory).
4374 Initialized based on EMACSLOADPATH environment variable, if any,
4375 otherwise to default specified by file `epaths.h' when Emacs was built. */);
4377 DEFVAR_LISP ("load-suffixes", Vload_suffixes
,
4378 doc
: /* List of suffixes for (compiled or source) Emacs Lisp files.
4379 This list should not include the empty string.
4380 `load' and related functions try to append these suffixes, in order,
4381 to the specified file name if a Lisp suffix is allowed or required. */);
4382 Vload_suffixes
= Fcons (make_pure_c_string (".elc"),
4383 Fcons (make_pure_c_string (".el"), Qnil
));
4384 DEFVAR_LISP ("load-file-rep-suffixes", Vload_file_rep_suffixes
,
4385 doc
: /* List of suffixes that indicate representations of \
4387 This list should normally start with the empty string.
4389 Enabling Auto Compression mode appends the suffixes in
4390 `jka-compr-load-suffixes' to this list and disabling Auto Compression
4391 mode removes them again. `load' and related functions use this list to
4392 determine whether they should look for compressed versions of a file
4393 and, if so, which suffixes they should try to append to the file name
4394 in order to do so. However, if you want to customize which suffixes
4395 the loading functions recognize as compression suffixes, you should
4396 customize `jka-compr-load-suffixes' rather than the present variable. */);
4397 Vload_file_rep_suffixes
= Fcons (empty_unibyte_string
, Qnil
);
4399 DEFVAR_BOOL ("load-in-progress", load_in_progress
,
4400 doc
: /* Non-nil if inside of `load'. */);
4401 DEFSYM (Qload_in_progress
, "load-in-progress");
4403 DEFVAR_LISP ("after-load-alist", Vafter_load_alist
,
4404 doc
: /* An alist of expressions to be evalled when particular files are loaded.
4405 Each element looks like (REGEXP-OR-FEATURE FORMS...).
4407 REGEXP-OR-FEATURE is either a regular expression to match file names, or
4408 a symbol \(a feature name).
4410 When `load' is run and the file-name argument matches an element's
4411 REGEXP-OR-FEATURE, or when `provide' is run and provides the symbol
4412 REGEXP-OR-FEATURE, the FORMS in the element are executed.
4414 An error in FORMS does not undo the load, but does prevent execution of
4415 the rest of the FORMS. */);
4416 Vafter_load_alist
= Qnil
;
4418 DEFVAR_LISP ("load-history", Vload_history
,
4419 doc
: /* Alist mapping loaded file names to symbols and features.
4420 Each alist element should be a list (FILE-NAME ENTRIES...), where
4421 FILE-NAME is the name of a file that has been loaded into Emacs.
4422 The file name is absolute and true (i.e. it doesn't contain symlinks).
4423 As an exception, one of the alist elements may have FILE-NAME nil,
4424 for symbols and features not associated with any file.
4426 The remaining ENTRIES in the alist element describe the functions and
4427 variables defined in that file, the features provided, and the
4428 features required. Each entry has the form `(provide . FEATURE)',
4429 `(require . FEATURE)', `(defun . FUNCTION)', `(autoload . SYMBOL)',
4430 `(defface . SYMBOL)', or `(t . SYMBOL)'. Entries like `(t . SYMBOL)'
4431 may precede a `(defun . FUNCTION)' entry, and means that SYMBOL was an
4432 autoload before this file redefined it as a function. In addition,
4433 entries may also be single symbols, which means that SYMBOL was
4434 defined by `defvar' or `defconst'.
4436 During preloading, the file name recorded is relative to the main Lisp
4437 directory. These file names are converted to absolute at startup. */);
4438 Vload_history
= Qnil
;
4440 DEFVAR_LISP ("load-file-name", Vload_file_name
,
4441 doc
: /* Full name of file being loaded by `load'. */);
4442 Vload_file_name
= Qnil
;
4444 DEFVAR_LISP ("user-init-file", Vuser_init_file
,
4445 doc
: /* File name, including directory, of user's initialization file.
4446 If the file loaded had extension `.elc', and the corresponding source file
4447 exists, this variable contains the name of source file, suitable for use
4448 by functions like `custom-save-all' which edit the init file.
4449 While Emacs loads and evaluates the init file, value is the real name
4450 of the file, regardless of whether or not it has the `.elc' extension. */);
4451 Vuser_init_file
= Qnil
;
4453 DEFVAR_LISP ("current-load-list", Vcurrent_load_list
,
4454 doc
: /* Used for internal purposes by `load'. */);
4455 Vcurrent_load_list
= Qnil
;
4457 DEFVAR_LISP ("load-read-function", Vload_read_function
,
4458 doc
: /* Function used by `load' and `eval-region' for reading expressions.
4459 The default is nil, which means use the function `read'. */);
4460 Vload_read_function
= Qnil
;
4462 DEFVAR_LISP ("load-source-file-function", Vload_source_file_function
,
4463 doc
: /* Function called in `load' for loading an Emacs Lisp source file.
4464 This function is for doing code conversion before reading the source file.
4465 If nil, loading is done without any code conversion.
4466 Arguments are FULLNAME, FILE, NOERROR, NOMESSAGE, where
4467 FULLNAME is the full name of FILE.
4468 See `load' for the meaning of the remaining arguments. */);
4469 Vload_source_file_function
= Qnil
;
4471 DEFVAR_BOOL ("load-force-doc-strings", load_force_doc_strings
,
4472 doc
: /* Non-nil means `load' should force-load all dynamic doc strings.
4473 This is useful when the file being loaded is a temporary copy. */);
4474 load_force_doc_strings
= 0;
4476 DEFVAR_BOOL ("load-convert-to-unibyte", load_convert_to_unibyte
,
4477 doc
: /* Non-nil means `read' converts strings to unibyte whenever possible.
4478 This is normally bound by `load' and `eval-buffer' to control `read',
4479 and is not meant for users to change. */);
4480 load_convert_to_unibyte
= 0;
4482 DEFVAR_LISP ("source-directory", Vsource_directory
,
4483 doc
: /* Directory in which Emacs sources were found when Emacs was built.
4484 You cannot count on them to still be there! */);
4486 = Fexpand_file_name (build_string ("../"),
4487 Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH
)));
4489 DEFVAR_LISP ("preloaded-file-list", Vpreloaded_file_list
,
4490 doc
: /* List of files that were preloaded (when dumping Emacs). */);
4491 Vpreloaded_file_list
= Qnil
;
4493 DEFVAR_LISP ("byte-boolean-vars", Vbyte_boolean_vars
,
4494 doc
: /* List of all DEFVAR_BOOL variables, used by the byte code optimizer. */);
4495 Vbyte_boolean_vars
= Qnil
;
4497 DEFVAR_BOOL ("load-dangerous-libraries", load_dangerous_libraries
,
4498 doc
: /* Non-nil means load dangerous compiled Lisp files.
4499 Some versions of XEmacs use different byte codes than Emacs. These
4500 incompatible byte codes can make Emacs crash when it tries to execute
4502 load_dangerous_libraries
= 0;
4504 DEFVAR_BOOL ("force-load-messages", force_load_messages
,
4505 doc
: /* Non-nil means force printing messages when loading Lisp files.
4506 This overrides the value of the NOMESSAGE argument to `load'. */);
4507 force_load_messages
= 0;
4509 DEFVAR_LISP ("bytecomp-version-regexp", Vbytecomp_version_regexp
,
4510 doc
: /* Regular expression matching safe to load compiled Lisp files.
4511 When Emacs loads a compiled Lisp file, it reads the first 512 bytes
4512 from the file, and matches them against this regular expression.
4513 When the regular expression matches, the file is considered to be safe
4514 to load. See also `load-dangerous-libraries'. */);
4515 Vbytecomp_version_regexp
4516 = make_pure_c_string ("^;;;.\\(in Emacs version\\|bytecomp version FSF\\)");
4518 Qlexical_binding
= intern ("lexical-binding");
4519 staticpro (&Qlexical_binding
);
4520 DEFVAR_LISP ("lexical-binding", Vlexical_binding
,
4521 doc
: /* Whether to use lexical binding when evaluating code.
4522 Non-nil means that the code in the current buffer should be evaluated
4523 with lexical binding.
4524 This variable is automatically set from the file variables of an
4525 interpreted Lisp file read using `load'. */);
4526 Fmake_variable_buffer_local (Qlexical_binding
);
4528 DEFVAR_LISP ("eval-buffer-list", Veval_buffer_list
,
4529 doc
: /* List of buffers being read from by calls to `eval-buffer' and `eval-region'. */);
4530 Veval_buffer_list
= Qnil
;
4532 DEFVAR_LISP ("old-style-backquotes", Vold_style_backquotes
,
4533 doc
: /* Set to non-nil when `read' encounters an old-style backquote. */);
4534 Vold_style_backquotes
= Qnil
;
4535 DEFSYM (Qold_style_backquotes
, "old-style-backquotes");
4537 /* Vsource_directory was initialized in init_lread. */
4539 load_descriptor_list
= Qnil
;
4540 staticpro (&load_descriptor_list
);
4542 DEFSYM (Qcurrent_load_list
, "current-load-list");
4543 DEFSYM (Qstandard_input
, "standard-input");
4544 DEFSYM (Qread_char
, "read-char");
4545 DEFSYM (Qget_file_char
, "get-file-char");
4546 DEFSYM (Qget_emacs_mule_file_char
, "get-emacs-mule-file-char");
4547 DEFSYM (Qload_force_doc_strings
, "load-force-doc-strings");
4549 DEFSYM (Qbackquote
, "`");
4550 DEFSYM (Qcomma
, ",");
4551 DEFSYM (Qcomma_at
, ",@");
4552 DEFSYM (Qcomma_dot
, ",.");
4554 DEFSYM (Qinhibit_file_name_operation
, "inhibit-file-name-operation");
4555 DEFSYM (Qascii_character
, "ascii-character");
4556 DEFSYM (Qfunction
, "function");
4557 DEFSYM (Qload
, "load");
4558 DEFSYM (Qload_file_name
, "load-file-name");
4559 DEFSYM (Qeval_buffer_list
, "eval-buffer-list");
4560 DEFSYM (Qfile_truename
, "file-truename");
4561 DEFSYM (Qdir_ok
, "dir-ok");
4562 DEFSYM (Qdo_after_load_evaluation
, "do-after-load-evaluation");
4564 staticpro (&dump_path
);
4566 staticpro (&read_objects
);
4567 read_objects
= Qnil
;
4568 staticpro (&seen_list
);
4571 Vloads_in_progress
= Qnil
;
4572 staticpro (&Vloads_in_progress
);
4574 DEFSYM (Qhash_table
, "hash-table");
4575 DEFSYM (Qdata
, "data");
4576 DEFSYM (Qtest
, "test");
4577 DEFSYM (Qsize
, "size");
4578 DEFSYM (Qweakness
, "weakness");
4579 DEFSYM (Qrehash_size
, "rehash-size");
4580 DEFSYM (Qrehash_threshold
, "rehash-threshold");