XEmacs 21.2.14.
[chise/xemacs-chise.git.1] / src / lread.c
1 /* Lisp parsing and input streams.
2    Copyright (C) 1985-1989, 1992-1995 Free Software Foundation, Inc.
3    Copyright (C) 1995 Tinker Systems.
4    Copyright (C) 1996 Ben Wing.
5
6 This file is part of XEmacs.
7
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
11 later version.
12
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING.  If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA.  */
22
23 /* Synched up with: Mule 2.0, FSF 19.30. */
24
25 /* This file has been Mule-ized. */
26
27 #include <config.h>
28 #include "lisp.h"
29
30 #include "buffer.h"
31 #include "bytecode.h"
32 #include "elhash.h"
33 #include "lstream.h"
34 #include "opaque.h"
35 #ifdef FILE_CODING
36 #include "file-coding.h"
37 #endif
38
39 #include "sysfile.h"
40
41 #ifdef LISP_FLOAT_TYPE
42 #define THIS_FILENAME lread
43 #include "sysfloat.h"
44 #endif /* LISP_FLOAT_TYPE */
45
46 Lisp_Object Qread_char, Qstandard_input;
47 Lisp_Object Qvariable_documentation;
48 #define LISP_BACKQUOTES
49 #ifdef LISP_BACKQUOTES
50 /*
51    Nonzero means inside a new-style backquote
52    with no surrounding parentheses.
53    Fread initializes this to zero, so we need not specbind it
54    or worry about what happens to it when there is an error.
55
56 XEmacs:
57    Nested backquotes are perfectly legal and fail utterly with
58    this silliness. */
59 static int new_backquote_flag, old_backquote_flag;
60 Lisp_Object Qbackquote, Qbacktick, Qcomma, Qcomma_at, Qcomma_dot;
61 #endif
62 Lisp_Object Qvariable_domain;   /* I18N3 */
63 Lisp_Object Vvalues, Vstandard_input, Vafter_load_alist;
64 Lisp_Object Qcurrent_load_list;
65 Lisp_Object Qload, Qload_file_name;
66 Lisp_Object Qfset;
67
68 /* Hash-table that maps directory names to hashes of their contents.  */
69 static Lisp_Object Vlocate_file_hash_table;
70
71 Lisp_Object Qexists, Qreadable, Qwritable, Qexecutable;
72
73 /* See read_escape() for an explanation of this.  */
74 #if 0
75 int fail_on_bucky_bit_character_escapes;
76 #endif
77
78 /* This symbol is also used in fns.c */
79 #define FEATUREP_SYNTAX
80
81 #ifdef FEATUREP_SYNTAX
82 Lisp_Object Qfeaturep;
83 #endif
84
85 /* non-zero if inside `load' */
86 int load_in_progress;
87
88 /* Whether Fload_internal() should check whether the .el is newer
89    when loading .elc */
90 int load_warn_when_source_newer;
91 /* Whether Fload_internal() should check whether the .elc doesn't exist */
92 int load_warn_when_source_only;
93 /* Whether Fload_internal() should ignore .elc files when no suffix is given */
94 int load_ignore_elc_files;
95
96 /* Search path for files to be loaded. */
97 Lisp_Object Vload_path;
98
99 /* Search path for files when dumping. */
100 /* Lisp_Object Vdump_load_path; */
101
102 /* This is the user-visible association list that maps features to
103    lists of defs in their load files. */
104 Lisp_Object Vload_history;
105
106 /* This is used to build the load history.  */
107 Lisp_Object Vcurrent_load_list;
108
109 /* Name of file actually being read by `load'.  */
110 Lisp_Object Vload_file_name;
111
112 /* Same as Vload_file_name but not Lisp-accessible.  This ensures that
113    our #$ checks are reliable. */
114 Lisp_Object Vload_file_name_internal;
115
116 Lisp_Object Vload_file_name_internal_the_purecopy;
117
118 /* Function to use for reading, in `load' and friends.  */
119 Lisp_Object Vload_read_function;
120
121 /* The association list of objects read with the #n=object form.
122    Each member of the list has the form (n . object), and is used to
123    look up the object for the corresponding #n# construct.
124    It must be set to nil before all top-level calls to read0.  */
125 Lisp_Object Vread_objects;
126
127 /* Nonzero means load should forcibly load all dynamic doc strings.  */
128 /* Note that this always happens (with some special behavior) when
129    purify_flag is set. */
130 static int load_force_doc_strings;
131
132 /* List of descriptors now open for Fload_internal.  */
133 static Lisp_Object Vload_descriptor_list;
134
135 /* In order to implement "load_force_doc_strings", we keep
136    a list of all the compiled-function objects and such
137    that we have created in the process of loading this file.
138    See the rant below.
139
140    We specbind this just like Vload_file_name, so there's no
141    problems with recursive loading. */
142 static Lisp_Object Vload_force_doc_string_list;
143
144 /* A resizing-buffer stream used to temporarily hold data while reading */
145 static Lisp_Object Vread_buffer_stream;
146
147 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
148 Lisp_Object Vcurrent_compiled_function_annotation;
149 #endif
150
151 static int load_byte_code_version;
152
153 /* An array describing all known built-in structure types */
154 static structure_type_dynarr *the_structure_type_dynarr;
155
156 #if 0 /* FSF defun hack */
157 /* When nonzero, read conses in pure space */
158 static int read_pure;
159 #endif
160
161 #if 0 /* FSF stuff */
162 /* For use within read-from-string (this reader is non-reentrant!!)  */
163 static int read_from_string_index;
164 static int read_from_string_limit;
165 #endif
166
167 #if 0 /* More FSF implementation kludges. */
168 /* In order to implement load-force-doc-string, FSF saves the
169    #@-quoted string when it's seen, and goes back and retrieves
170    it later.
171
172    This approach is not only kludgy, but it in general won't work
173    correctly because there's no stack of remembered #@-quoted-strings
174    and those strings don't generally appear in the file in the same
175    order as their #$ references. (Yes, that is amazingly stupid too.
176
177    It would be trivially easy to always encode the #@ string
178    [which is a comment, anyway] in the middle of the (#$ . INT) cons
179    reference.  That way, it would be really easy to implement
180    load-force-doc-string in a non-kludgy way by just retrieving the
181    string immediately, because it's delivered on a silver platter.)
182
183    And finally, this stupid approach doesn't work under Mule, or
184    under MS-DOS or Windows NT, or under VMS, or any other place
185    where you either can't do an ftell() or don't get back a byte
186    count.
187
188    Oh, and one more lossage in this approach: If you attempt to
189    dump any ELC files that were compiled with `byte-compile-dynamic'
190    (as opposed to just `byte-compile-dynamic-docstring'), you
191    get hosed.  FMH! (as the illustrious JWZ was prone to utter)
192
193    The approach we use is clean, solves all of these problems, and is
194    probably easier to implement anyway.  We just save a list of all
195    the containing objects that have (#$ . INT) conses in them (this
196    will only be compiled-function objects and lists), and when the
197    file is finished loading, we go through and fill in all the
198    doc strings at once. */
199
200  /* This contains the last string skipped with #@.  */
201 static char *saved_doc_string;
202 /* Length of buffer allocated in saved_doc_string.  */
203 static int saved_doc_string_size;
204 /* Length of actual data in saved_doc_string.  */
205 static int saved_doc_string_length;
206 /* This is the file position that string came from.  */
207 static int saved_doc_string_position;
208 #endif
209
210 EXFUN (Fread_from_string, 3);
211
212 /* When errors are signaled, the actual readcharfun should not be used
213    as an argument if it is an lstream, so that lstreams don't escape
214    to the Lisp level.  */
215 #define READCHARFUN_MAYBE(x) (LSTREAMP (x)                                      \
216                               ? (build_string ("internal input stream"))        \
217                               : (x))
218 \f
219
220 static DOESNT_RETURN
221 syntax_error (CONST char *string)
222 {
223   signal_error (Qinvalid_read_syntax,
224                 list1 (build_translated_string (string)));
225 }
226
227 static Lisp_Object
228 continuable_syntax_error (CONST char *string)
229 {
230   return Fsignal (Qinvalid_read_syntax,
231                   list1 (build_translated_string (string)));
232 }
233
234 \f
235 /* Handle unreading and rereading of characters. */
236 static Emchar
237 readchar (Lisp_Object readcharfun)
238 {
239   /* This function can GC */
240
241   if (BUFFERP (readcharfun))
242     {
243       Emchar c;
244       struct buffer *b = XBUFFER (readcharfun);
245
246       if (!BUFFER_LIVE_P (b))
247         error ("Reading from killed buffer");
248
249       if (BUF_PT (b) >= BUF_ZV (b))
250         return -1;
251       c = BUF_FETCH_CHAR (b, BUF_PT (b));
252       BUF_SET_PT (b, BUF_PT (b) + 1);
253
254       return c;
255     }
256   else if (LSTREAMP (readcharfun))
257     {
258       Emchar c = Lstream_get_emchar (XLSTREAM (readcharfun));
259 #ifdef DEBUG_XEMACS /* testing Mule */
260       static int testing_mule = 0; /* Change via debugger */
261       if (testing_mule) {
262         if (c >= 0x20 && c <= 0x7E) fprintf (stderr, "%c", c);
263         else if (c == '\n')         fprintf (stderr, "\\n\n");
264         else                        fprintf (stderr, "\\%o ", c);
265       }
266 #endif
267       return c;
268     }
269   else if (MARKERP (readcharfun))
270     {
271       Emchar c;
272       Bufpos mpos = marker_position (readcharfun);
273       struct buffer *inbuffer = XMARKER (readcharfun)->buffer;
274
275       if (mpos >= BUF_ZV (inbuffer))
276         return -1;
277       c = BUF_FETCH_CHAR (inbuffer, mpos);
278       set_marker_position (readcharfun, mpos + 1);
279       return c;
280     }
281   else
282     {
283       Lisp_Object tem = call0 (readcharfun);
284
285       if (!CHAR_OR_CHAR_INTP (tem))
286         return -1;
287       return XCHAR_OR_CHAR_INT (tem);
288     }
289 }
290
291 /* Unread the character C in the way appropriate for the stream READCHARFUN.
292    If the stream is a user function, call it with the char as argument.  */
293
294 static void
295 unreadchar (Lisp_Object readcharfun, Emchar c)
296 {
297   if (c == -1)
298     /* Don't back up the pointer if we're unreading the end-of-input mark,
299        since readchar didn't advance it when we read it.  */
300     ;
301   else if (BUFFERP (readcharfun))
302     BUF_SET_PT (XBUFFER (readcharfun), BUF_PT (XBUFFER (readcharfun)) - 1);
303   else if (LSTREAMP (readcharfun))
304     {
305       Lstream_unget_emchar (XLSTREAM (readcharfun), c);
306 #ifdef DEBUG_XEMACS /* testing Mule */
307       {
308         static int testing_mule = 0; /* Set this using debugger */
309         if (testing_mule)
310           fprintf (stderr,
311                    (c >= 0x20 && c <= 0x7E) ? "UU%c" :
312                    ((c == '\n') ? "UU\\n\n" : "UU\\%o"), c);
313       }
314 #endif
315     }
316   else if (MARKERP (readcharfun))
317     set_marker_position (readcharfun, marker_position (readcharfun) - 1);
318   else
319     call1 (readcharfun, make_char (c));
320 }
321
322 static Lisp_Object read0 (Lisp_Object readcharfun);
323 static Lisp_Object read1 (Lisp_Object readcharfun);
324 /* allow_dotted_lists means that something like (foo bar . baz)
325    is acceptable.  If -1, means check for starting with defun
326    and make structure pure. (not implemented, probably for very
327    good reasons)
328 */
329 /*
330    If check_for_doc_references, look for (#$ . INT) doc references
331    in the list and record if load_force_doc_strings is non-zero.
332    (Such doc references will be destroyed during the loadup phase
333    by replacing with Qzero, because Snarf-documentation will fill
334    them in again.)
335
336    WARNING: If you set this, you sure as hell better not call
337    free_list() on the returned list here. */
338
339 static Lisp_Object read_list (Lisp_Object readcharfun,
340                               Emchar terminator,
341                               int allow_dotted_lists,
342                               int check_for_doc_references);
343 \f
344 static void readevalloop (Lisp_Object readcharfun,
345                           Lisp_Object sourcefile,
346                           Lisp_Object (*evalfun) (Lisp_Object),
347                           int printflag);
348
349 static Lisp_Object
350 load_unwind (Lisp_Object stream)  /* used as unwind-protect function in load */
351 {
352   Lstream_close (XLSTREAM (stream));
353   if (--load_in_progress < 0)
354     load_in_progress = 0;
355   return Qnil;
356 }
357
358 static Lisp_Object
359 load_descriptor_unwind (Lisp_Object oldlist)
360 {
361   Vload_descriptor_list = oldlist;
362   return Qnil;
363 }
364
365 static Lisp_Object
366 load_file_name_internal_unwind (Lisp_Object oldval)
367 {
368   Vload_file_name_internal = oldval;
369   return Qnil;
370 }
371
372 static Lisp_Object
373 load_file_name_internal_the_purecopy_unwind (Lisp_Object oldval)
374 {
375   Vload_file_name_internal_the_purecopy = oldval;
376   return Qnil;
377 }
378
379 static Lisp_Object
380 load_byte_code_version_unwind (Lisp_Object oldval)
381 {
382   load_byte_code_version = XINT (oldval);
383   return Qnil;
384 }
385
386 /* The plague is coming.
387
388    Ring around the rosy, pocket full of posy,
389    Ashes ashes, they all fall down.
390    */
391 void
392 ebolify_bytecode_constants (Lisp_Object vector)
393 {
394   int len = XVECTOR_LENGTH (vector);
395   int i;
396
397   for (i = 0; i < len; i++)
398     {
399       Lisp_Object el = XVECTOR_DATA (vector)[i];
400
401       /* We don't check for `eq', `equal', and the others that have
402          bytecode opcodes.  This might lose if someone passes #'eq or
403          something to `funcall', but who would really do that?  As
404          they say in law, we've made a "good-faith effort" to
405          unfuckify ourselves.  And doing it this way avoids screwing
406          up args to `make-hash-table' and such.  As it is, we have to
407          add an extra Ebola check in decode_weak_list_type(). --ben */
408       if      (EQ (el, Qassoc))  el = Qold_assoc;
409       else if (EQ (el, Qdelq))   el = Qold_delq;
410 #if 0
411       /* I think this is a bad idea because it will probably mess
412          with keymap code. */
413       else if (EQ (el, Qdelete)) el = Qold_delete;
414 #endif
415       else if (EQ (el, Qrassq))  el = Qold_rassq;
416       else if (EQ (el, Qrassoc)) el = Qold_rassoc;
417
418       XVECTOR_DATA (vector)[i] = el;
419     }
420 }
421
422 static Lisp_Object
423 pas_de_lache_ici (int fd, Lisp_Object victim)
424 {
425   Lisp_Object tem;
426   EMACS_INT pos;
427
428   if (!INTP (XCDR (victim)))
429     signal_simple_error ("Bogus doc string reference", victim);
430   pos = XINT (XCDR (victim));
431   if (pos < 0)
432     pos = -pos; /* kludge to mark a user variable */
433   tem = unparesseuxify_doc_string (fd, pos, 0, Vload_file_name_internal);
434   if (!STRINGP (tem))
435     signal_error (Qerror, tem);
436   return tem;
437 }
438
439 static Lisp_Object
440 load_force_doc_string_unwind (Lisp_Object oldlist)
441 {
442   struct gcpro gcpro1;
443   Lisp_Object list = Vload_force_doc_string_list;
444   Lisp_Object tail;
445   int fd = XINT (XCAR (Vload_descriptor_list));
446   /* NOTE: If purify_flag is true, we're in-place modifying objects that
447      may be in purespace (and if not, they will be).  Therefore, we have
448      to be VERY careful to make sure that all objects that we create
449      are purecopied -- objects in purespace are not marked for GC, and
450      if we leave any impure objects inside of pure ones, we're really
451      screwed. */
452
453   GCPRO1 (list);
454   /* restore the old value first just in case an error occurs. */
455   Vload_force_doc_string_list = oldlist;
456
457   LIST_LOOP (tail, list)
458     {
459       Lisp_Object john = Fcar (tail);
460       if (CONSP (john))
461         {
462           assert (CONSP (XCAR (john)));
463           assert (!purify_flag); /* should have been handled in read_list() */
464           XCAR (john) = pas_de_lache_ici (fd, XCAR (john));
465         }
466       else
467         {
468           Lisp_Object doc;
469
470           assert (COMPILED_FUNCTIONP (john));
471           if (CONSP (XCOMPILED_FUNCTION (john)->instructions))
472             {
473               struct gcpro ngcpro1;
474               Lisp_Object juan = (pas_de_lache_ici
475                                   (fd, XCOMPILED_FUNCTION (john)->instructions));
476               Lisp_Object ivan;
477
478               NGCPRO1 (juan);
479               ivan = Fread (juan);
480               if (!CONSP (ivan))
481                 signal_simple_error ("invalid lazy-loaded byte code", ivan);
482               /* Remember to purecopy; see above. */
483               XCOMPILED_FUNCTION (john)->instructions = Fpurecopy (XCAR (ivan));
484               /* v18 or v19 bytecode file.  Need to Ebolify. */
485               if (XCOMPILED_FUNCTION (john)->flags.ebolified
486                   && VECTORP (XCDR (ivan)))
487                 ebolify_bytecode_constants (XCDR (ivan));
488               XCOMPILED_FUNCTION (john)->constants = Fpurecopy (XCDR (ivan));
489               NUNGCPRO;
490             }
491           doc = compiled_function_documentation (XCOMPILED_FUNCTION (john));
492           if (CONSP (doc))
493             {
494               assert (!purify_flag); /* should have been handled in
495                                         read_compiled_function() */
496               doc = pas_de_lache_ici (fd, doc);
497               set_compiled_function_documentation (XCOMPILED_FUNCTION (john),
498                                                    doc);
499             }
500         }
501     }
502
503   if (!NILP (list))
504     free_list (list);
505
506   UNGCPRO;
507   return Qnil;
508 }
509
510 /* Close all descriptors in use for Fload_internal.
511    This is used when starting a subprocess.  */
512
513 void
514 close_load_descs (void)
515 {
516   Lisp_Object tail;
517   LIST_LOOP (tail, Vload_descriptor_list)
518     close (XINT (XCAR (tail)));
519 }
520
521 #ifdef I18N3
522 Lisp_Object Vfile_domain;
523
524 Lisp_Object
525 restore_file_domain (Lisp_Object val)
526 {
527   Vfile_domain = val;
528   return Qnil;
529 }
530 #endif /* I18N3 */
531
532 DEFUN ("load-internal", Fload_internal, 1, 6, 0, /*
533 Execute a file of Lisp code named FILE; no coding-system frobbing.
534 This function is identical to `load' except for the handling of the
535 CODESYS and USED-CODESYS arguments under XEmacs/Mule. (When Mule
536 support is not present, both functions are identical and ignore the
537 CODESYS and USED-CODESYS arguments.)
538
539 If support for Mule exists in this Emacs, the file is decoded
540 according to CODESYS; if omitted, no conversion happens.  If
541 USED-CODESYS is non-nil, it should be a symbol, and the actual coding
542 system that was used for the decoding is stored into it.  It will in
543 general be different from CODESYS if CODESYS specifies automatic
544 encoding detection or end-of-line detection.
545 */
546        (file, no_error, nomessage, nosuffix, codesys, used_codesys))
547 {
548   /* This function can GC */
549   int fd = -1;
550   int speccount = specpdl_depth ();
551   int source_only = 0;
552   Lisp_Object newer   = Qnil;
553   Lisp_Object handler = Qnil;
554   Lisp_Object found   = Qnil;
555   struct gcpro gcpro1, gcpro2, gcpro3;
556   int reading_elc = 0;
557   int message_p = NILP (nomessage);
558 /*#ifdef DEBUG_XEMACS*/
559   static Lisp_Object last_file_loaded;
560 /*#endif*/
561   struct stat s1, s2;
562   GCPRO3 (file, newer, found);
563
564   CHECK_STRING (file);
565
566 /*#ifdef DEBUG_XEMACS*/
567   if (purify_flag && noninteractive)
568     {
569       message_p = 1;
570       last_file_loaded = file;
571     }
572 /*#endif / * DEBUG_XEMACS */
573
574   /* If file name is magic, call the handler.  */
575   handler = Ffind_file_name_handler (file, Qload);
576   if (!NILP (handler))
577     RETURN_UNGCPRO (call5 (handler, Qload, file, no_error,
578                           nomessage, nosuffix));
579
580   /* Do this after the handler to avoid
581      the need to gcpro noerror, nomessage and nosuffix.
582      (Below here, we care only whether they are nil or not.)  */
583   file = Fsubstitute_in_file_name (file);
584 #ifdef FILE_CODING
585   if (!NILP (used_codesys))
586     CHECK_SYMBOL (used_codesys);
587 #endif
588
589   /* Avoid weird lossage with null string as arg,
590      since it would try to load a directory as a Lisp file.
591      Unix truly sucks. */
592   if (XSTRING_LENGTH (file) > 0)
593     {
594       char *foundstr;
595       int foundlen;
596
597       fd = locate_file (Vload_path, file,
598                         ((!NILP (nosuffix)) ? Qnil :
599                          build_string (load_ignore_elc_files ? ".el:" :
600                                        ".elc:.el:")),
601                         &found,
602                         -1);
603
604       if (fd < 0)
605         {
606           if (NILP (no_error))
607             signal_file_error ("Cannot open load file", file);
608           else
609             {
610               UNGCPRO;
611               return Qnil;
612             }
613         }
614
615       foundstr = (char *) alloca (XSTRING_LENGTH (found) + 1);
616       strcpy (foundstr, (char *) XSTRING_DATA (found));
617       foundlen = strlen (foundstr);
618
619       /* The omniscient JWZ thinks this is worthless, but I beg to
620          differ. --ben */
621       if (load_ignore_elc_files)
622         {
623           newer = Ffile_name_nondirectory (found);
624         }
625       else if (load_warn_when_source_newer &&
626                !memcmp (".elc", foundstr + foundlen - 4, 4))
627         {
628           if (! fstat (fd, &s1))        /* can't fail, right? */
629             {
630               int result;
631               /* temporarily hack the 'c' off the end of the filename */
632               foundstr[foundlen - 1] = '\0';
633               result = stat (foundstr, &s2);
634               if (result >= 0 &&
635                   (unsigned) s1.st_mtime < (unsigned) s2.st_mtime)
636               {
637                 Lisp_Object newer_name = make_string ((Bufbyte *) foundstr,
638                                                       foundlen - 1);
639                 struct gcpro nngcpro1;
640                 NNGCPRO1 (newer_name);
641                 newer = Ffile_name_nondirectory (newer_name);
642                 NNUNGCPRO;
643               }
644               /* put the 'c' back on (kludge-o-rama) */
645               foundstr[foundlen - 1] = 'c';
646             }
647         }
648       else if (load_warn_when_source_only &&
649                /* `found' ends in ".el" */
650                !memcmp (".el", foundstr + foundlen - 3, 3) &&
651                /* `file' does not end in ".el" */
652                memcmp (".el",
653                        XSTRING_DATA (file) + XSTRING_LENGTH (file) - 3,
654                        3))
655         {
656           source_only = 1;
657         }
658
659       if (!memcmp (".elc", foundstr + foundlen - 4, 4))
660         reading_elc = 1;
661     }
662
663 #define PRINT_LOADING_MESSAGE(done) do {                                \
664   if (load_ignore_elc_files)                                            \
665     {                                                                   \
666       if (message_p)                                                    \
667         message ("Loading %s..." done, XSTRING_DATA (newer));           \
668     }                                                                   \
669   else if (!NILP (newer))                                               \
670     message ("Loading %s..." done " (file %s is newer)",                \
671              XSTRING_DATA (file),                                       \
672              XSTRING_DATA (newer));                                     \
673   else if (source_only)                                                 \
674     message ("Loading %s..." done " (file %s.elc does not exist)",      \
675              XSTRING_DATA (file),                                       \
676              XSTRING_DATA (Ffile_name_nondirectory (file)));            \
677   else if (message_p)                                                   \
678     message ("Loading %s..." done, XSTRING_DATA (file));                \
679   } while (0)
680
681   PRINT_LOADING_MESSAGE ("");
682
683   {
684     /* Lisp_Object's must be malloc'ed, not stack-allocated */
685     Lisp_Object lispstream = Qnil;
686     CONST int block_size = 8192;
687     struct gcpro ngcpro1;
688
689     NGCPRO1 (lispstream);
690     lispstream = make_filedesc_input_stream (fd, 0, -1, LSTR_CLOSING);
691     /* 64K is used for normal files; 8K should be OK here because Lisp
692        files aren't really all that big. */
693     Lstream_set_buffering (XLSTREAM (lispstream), LSTREAM_BLOCKN_BUFFERED,
694                            block_size);
695 #ifdef FILE_CODING
696     lispstream = make_decoding_input_stream
697       (XLSTREAM (lispstream), Fget_coding_system (codesys));
698     Lstream_set_buffering (XLSTREAM (lispstream), LSTREAM_BLOCKN_BUFFERED,
699                            block_size);
700 #endif
701     /* NOTE: Order of these is very important.  Don't rearrange them. */
702     record_unwind_protect (load_unwind, lispstream);
703     record_unwind_protect (load_descriptor_unwind, Vload_descriptor_list);
704     record_unwind_protect (load_file_name_internal_unwind,
705                            Vload_file_name_internal);
706     record_unwind_protect (load_file_name_internal_the_purecopy_unwind,
707                            Vload_file_name_internal_the_purecopy);
708     record_unwind_protect (load_force_doc_string_unwind,
709                            Vload_force_doc_string_list);
710     Vload_file_name_internal = found;
711     Vload_file_name_internal_the_purecopy = Qnil;
712     specbind (Qload_file_name, found);
713     Vload_descriptor_list = Fcons (make_int (fd), Vload_descriptor_list);
714     Vload_force_doc_string_list = Qnil;
715 #ifdef I18N3
716     record_unwind_protect (restore_file_domain, Vfile_domain);
717     Vfile_domain = Qnil; /* set it to nil; a call to #'domain will set it. */
718 #endif
719     load_in_progress++;
720
721     /* Now determine what sort of ELC file we're reading in. */
722     record_unwind_protect (load_byte_code_version_unwind,
723                            make_int (load_byte_code_version));
724     if (reading_elc)
725       {
726         char elc_header[8];
727         int num_read;
728
729         num_read = Lstream_read (XLSTREAM (lispstream), elc_header, 8);
730         if (num_read < 8
731             || strncmp (elc_header, ";ELC", 4))
732           {
733             /* Huh?  Probably not a valid ELC file. */
734             load_byte_code_version = 100; /* no Ebolification needed */
735             Lstream_unread (XLSTREAM (lispstream), elc_header, num_read);
736           }
737         else
738           load_byte_code_version = elc_header[4];
739       }
740     else
741       load_byte_code_version = 100; /* no Ebolification needed */
742
743     readevalloop (lispstream, file, Feval, 0);
744 #ifdef FILE_CODING
745     if (!NILP (used_codesys))
746       Fset (used_codesys,
747             XCODING_SYSTEM_NAME
748             (decoding_stream_coding_system (XLSTREAM (lispstream))));
749 #endif
750     unbind_to (speccount, Qnil);
751
752     NUNGCPRO;
753   }
754
755   {
756     Lisp_Object tem;
757     /* #### Disgusting kludge */
758     /* Run any load-hooks for this file.  */
759     /* #### An even more disgusting kludge.  There is horrible code */
760     /* that is relying on the fact that dumped lisp files are found */
761     /* via `load-path' search. */
762     Lisp_Object name = file;
763
764     if (!NILP(Ffile_name_absolute_p(file)))
765       {
766         name = Ffile_name_nondirectory(file);
767       }
768
769     {
770       struct gcpro ngcpro1;
771
772       NGCPRO1 (name);
773       tem = Fassoc (name, Vafter_load_alist);
774       NUNGCPRO;
775     }
776     if (!NILP (tem))
777       {
778         struct gcpro ngcpro1;
779
780         NGCPRO1 (tem);
781         /* Use eval so that errors give a semi-meaningful backtrace.  --Stig */
782         tem = Fcons (Qprogn, Fcdr (tem));
783         Feval (tem);
784         NUNGCPRO;
785       }
786   }
787
788 /*#ifdef DEBUG_XEMACS*/
789   if (purify_flag && noninteractive)
790     {
791       if (!EQ (last_file_loaded, file))
792         message ("Loading %s ...done", XSTRING_DATA (file));
793     }
794 /*#endif / * DEBUG_XEMACS */
795
796   if (!noninteractive)
797     PRINT_LOADING_MESSAGE ("done");
798
799   UNGCPRO;
800   return Qt;
801 }
802
803 \f
804 /* ------------------------------- */
805 /*          locate_file            */
806 /* ------------------------------- */
807
808 static int
809 decode_mode_1 (Lisp_Object mode)
810 {
811   if (EQ (mode, Qexists))
812     return F_OK;
813   else if (EQ (mode, Qexecutable))
814     return X_OK;
815   else if (EQ (mode, Qwritable))
816     return W_OK;
817   else if (EQ (mode, Qreadable))
818     return R_OK;
819   else if (INTP (mode))
820     {
821       check_int_range (XINT (mode), 0, 7);
822       return XINT (mode);
823     }
824   else
825     signal_simple_error ("Invalid value", mode);
826   return 0;                     /* unreached */
827 }
828
829 static int
830 decode_mode (Lisp_Object mode)
831 {
832   if (NILP (mode))
833     return R_OK;
834   else if (CONSP (mode))
835     {
836       Lisp_Object tail;
837       int mask = 0;
838       EXTERNAL_LIST_LOOP (tail, mode)
839         mask |= decode_mode_1 (XCAR (tail));
840       return mask;
841     }
842   else
843     return decode_mode_1 (mode);
844 }
845
846 DEFUN ("locate-file", Flocate_file, 2, 4, 0, /*
847 Search for FILENAME through PATH-LIST.
848
849 If SUFFIXES is non-nil, it should be a list of suffixes to append to
850 file name when searching.
851
852 If MODE is non-nil, it should be a symbol or a list of symbol representing
853 requirements.  Allowed symbols are `exists', `executable', `writable', and
854 `readable'.  If MODE is nil, it defaults to `readable'.
855
856 `locate-file' keeps hash tables of the directories it searches through,
857 in order to speed things up.  It tries valiantly to not get confused in
858 the face of a changing and unpredictable environment, but can occasionally
859 get tripped up.  In this case, you will have to call
860 `locate-file-clear-hashing' to get it back on track.  See that function
861 for details.
862 */
863        (filename, path_list, suffixes, mode))
864 {
865   /* This function can GC */
866   Lisp_Object tp;
867
868   CHECK_STRING (filename);
869
870   if (LISTP (suffixes))
871     {
872       Lisp_Object tail;
873       EXTERNAL_LIST_LOOP (tail, suffixes)
874         CHECK_STRING (XCAR (tail));
875     }
876   else
877     CHECK_STRING (suffixes);
878
879   locate_file (path_list, filename, suffixes, &tp, decode_mode (mode));
880   return tp;
881 }
882
883 /* Recalculate the hash table for the given string.  DIRECTORY should
884    better have been through Fexpand_file_name() by now.  */
885
886 static Lisp_Object
887 locate_file_refresh_hashing (Lisp_Object directory)
888 {
889   Lisp_Object hash =
890     make_directory_hash_table ((char *) XSTRING_DATA (directory));
891
892   if (!NILP (hash))
893     Fputhash (directory, hash, Vlocate_file_hash_table);
894   return hash;
895 }
896
897 /* find the hash table for the given directory, recalculating if necessary */
898
899 static Lisp_Object
900 locate_file_find_directory_hash_table (Lisp_Object directory)
901 {
902   Lisp_Object hash = Fgethash (directory, Vlocate_file_hash_table, Qnil);
903   if (NILP (hash))
904     return locate_file_refresh_hashing (directory);
905   else
906     return hash;
907 }
908
909 /* The SUFFIXES argument in any of the locate_file* functions can be
910    nil, a list, or a string (for backward compatibility), with the
911    following semantics:
912
913    a) nil    - no suffix, just search for file name intact (semantically
914                different from "empty suffix list")
915    b) list   - list of suffixes to append to file name.  Each of these
916                must be a string.
917    c) string - colon-separated suffixes to append to file name (backward
918                compatibility).
919
920    All of this got hairy, so I decided to use write a mapper.  Calling
921    a function for each suffix shouldn't slow things down, since
922    locate_file is rarely call with enough suffixes for it to make a
923    difference.  */
924
925 /* Map FUN over SUFFIXES, as described above.  FUN will be called with a
926    char * containing the current file name, and ARG.  Mapping stops when
927    FUN returns non-zero. */
928 void
929 locate_file_map_suffixes (Lisp_Object filename, Lisp_Object suffixes,
930                           int (*fun) (char *, void *),
931                           void *arg)
932 {
933   /* This function can GC */
934   char *fn;
935   int fn_len, max;
936
937   /* Calculate maximum size of any filename made from
938      this path element/specified file name and any possible suffix.  */
939   if (CONSP (suffixes))
940     {
941       /* We must traverse the list, so why not do it right. */
942       Lisp_Object tail;
943       max = 0;
944       LIST_LOOP (tail, suffixes)
945         {
946           if (XSTRING_LENGTH (XCAR (tail)) > max)
947             max = XSTRING_LENGTH (XCAR (tail));
948         }
949     }
950   else if (NILP (suffixes))
951     max = 0;
952   else
953     /* Just take the easy way out */
954     max = XSTRING_LENGTH (suffixes);
955
956   fn_len = XSTRING_LENGTH (filename);
957   fn = (char *) alloca (max + fn_len + 1);
958   memcpy (fn, (char *) XSTRING_DATA (filename), fn_len);
959
960   /* Loop over suffixes.  */
961   if (!STRINGP (suffixes))
962     {
963       if (NILP (suffixes))
964         {
965           /* Case a) discussed in the comment above. */
966           fn[fn_len] = 0;
967           if ((*fun) (fn, arg))
968             return;
969         }
970       else
971         {
972           /* Case b) */
973           Lisp_Object tail;
974           LIST_LOOP (tail, suffixes)
975             {
976               memcpy (fn + fn_len, XSTRING_DATA (XCAR (tail)),
977                       XSTRING_LENGTH (XCAR (tail)));
978               fn[fn_len + XSTRING_LENGTH (XCAR (tail))] = 0;
979               if ((*fun) (fn, arg))
980                 return;
981             }
982         }
983     }
984   else
985     {
986       /* Case c) */
987       CONST char *nsuffix = XSTRING_DATA (suffixes);
988
989       while (1)
990         {
991           char *esuffix = (char *) strchr (nsuffix, ':');
992           int lsuffix = ((esuffix) ? (esuffix - nsuffix) : strlen (nsuffix));
993
994           /* Concatenate path element/specified name with the suffix.  */
995           strncpy (fn + fn_len, nsuffix, lsuffix);
996           fn[fn_len + lsuffix] = 0;
997
998           if ((*fun) (fn, arg))
999             return;
1000
1001           /* Advance to next suffix.  */
1002           if (esuffix == 0)
1003             break;
1004           nsuffix += lsuffix + 1;
1005         }
1006     }
1007 }
1008
1009 struct locate_file_in_directory_mapper_closure {
1010   int fd;
1011   Lisp_Object *storeptr;
1012   int mode;
1013 };
1014
1015 static int
1016 locate_file_in_directory_mapper (char *fn, void *arg)
1017 {
1018   struct locate_file_in_directory_mapper_closure *closure =
1019     (struct locate_file_in_directory_mapper_closure *)arg;
1020   struct stat st;
1021
1022   /* Ignore file if it's a directory.  */
1023   if (stat (fn, &st) >= 0
1024       && (st.st_mode & S_IFMT) != S_IFDIR)
1025     {
1026       /* Check that we can access or open it.  */
1027       if (closure->mode >= 0)
1028         closure->fd = access (fn, closure->mode);
1029       else
1030         closure->fd = open (fn, O_RDONLY | OPEN_BINARY, 0);
1031
1032       if (closure->fd >= 0)
1033         {
1034           /* We succeeded; return this descriptor and filename.  */
1035           if (closure->storeptr)
1036             *closure->storeptr = build_string (fn);
1037
1038 #ifndef WINDOWSNT
1039           /* If we actually opened the file, set close-on-exec flag
1040              on the new descriptor so that subprocesses can't whack
1041              at it.  */
1042           if (closure->mode < 0)
1043             (void) fcntl (closure->fd, F_SETFD, FD_CLOEXEC);
1044 #endif
1045
1046           return 1;
1047         }
1048     }
1049   /* Keep mapping. */
1050   return 0;
1051 }
1052
1053
1054 /* look for STR in PATH, optionally adding SUFFIXES.  DIRECTORY need
1055    not have been expanded.  */
1056
1057 static int
1058 locate_file_in_directory (Lisp_Object directory, Lisp_Object str,
1059                           Lisp_Object suffixes, Lisp_Object *storeptr,
1060                           int mode)
1061 {
1062   /* This function can GC */
1063   struct locate_file_in_directory_mapper_closure closure;
1064   Lisp_Object filename = Qnil;
1065   struct gcpro gcpro1, gcpro2, gcpro3;
1066
1067   GCPRO3 (directory, str, filename);
1068
1069   filename = Fexpand_file_name (str, directory);
1070   if (NILP (filename) || NILP (Ffile_name_absolute_p (filename)))
1071     /* If there are non-absolute elts in PATH (eg ".") */
1072     /* Of course, this could conceivably lose if luser sets
1073        default-directory to be something non-absolute ... */
1074     {
1075       if (NILP (filename))
1076         /* NIL means current directory */
1077         filename = current_buffer->directory;
1078       else
1079         filename = Fexpand_file_name (filename,
1080                                       current_buffer->directory);
1081       if (NILP (Ffile_name_absolute_p (filename)))
1082         {
1083           /* Give up on this directory! */
1084           UNGCPRO;
1085           return -1;
1086         }
1087     }
1088
1089   closure.fd = -1;
1090   closure.storeptr = storeptr;
1091   closure.mode = mode;
1092
1093   locate_file_map_suffixes (filename, suffixes, locate_file_in_directory_mapper,
1094                             &closure);
1095
1096   UNGCPRO;
1097   return closure.fd;
1098 }
1099
1100 /* do the same as locate_file() but don't use any hash tables. */
1101
1102 static int
1103 locate_file_without_hash (Lisp_Object path, Lisp_Object str,
1104                           Lisp_Object suffixes, Lisp_Object *storeptr,
1105                           int mode)
1106 {
1107   /* This function can GC */
1108   int absolute = !NILP (Ffile_name_absolute_p (str));
1109
1110   EXTERNAL_LIST_LOOP (path, path)
1111     {
1112       int val = locate_file_in_directory (XCAR (path), str, suffixes, storeptr,
1113                                           mode);
1114       if (val >= 0)
1115         return val;
1116       if (absolute)
1117         break;
1118     }
1119   return -1;
1120 }
1121
1122 static int
1123 locate_file_construct_suffixed_files_mapper (char *fn, void *arg)
1124 {
1125   Lisp_Object *tail = (Lisp_Object *)arg;
1126   *tail = Fcons (build_string (fn), *tail);
1127   return 0;
1128 }
1129
1130 /* Construct a list of all files to search for.
1131    It makes sense to have this despite locate_file_map_suffixes()
1132    because we need Lisp strings to access the hash-table, and it would
1133    be inefficient to create them on the fly, again and again for each
1134    path component.  See locate_file(). */
1135
1136 static Lisp_Object
1137 locate_file_construct_suffixed_files (Lisp_Object filename,
1138                                       Lisp_Object suffixes)
1139 {
1140   Lisp_Object tail = Qnil;
1141   struct gcpro gcpro1;
1142   GCPRO1 (tail);
1143
1144   locate_file_map_suffixes (filename, suffixes,
1145                             locate_file_construct_suffixed_files_mapper,
1146                             &tail);
1147
1148   UNGCPRO;
1149   return Fnreverse (tail);
1150 }
1151
1152 DEFUN ("locate-file-clear-hashing", Flocate_file_clear_hashing, 1, 1, 0, /*
1153 Clear the hash records for the specified list of directories.
1154 `locate-file' uses a hashing scheme to speed lookup, and will correctly
1155 track the following environmental changes:
1156
1157 -- changes of any sort to the list of directories to be searched.
1158 -- addition and deletion of non-shadowing files (see below) from the
1159    directories in the list.
1160 -- byte-compilation of a .el file into a .elc file.
1161
1162 `locate-file' will primarily get confused if you add a file that shadows
1163 \(i.e. has the same name as) another file further down in the directory list.
1164 In this case, you must call `locate-file-clear-hashing'.
1165
1166 If PATH is t, it means to fully clear all the accumulated hashes.  This
1167 can be used if the internal tables grow too large, or when dumping.
1168 */
1169        (path))
1170 {
1171   if (EQ (path, Qt))
1172     Fclrhash (Vlocate_file_hash_table);
1173   else
1174     {
1175       Lisp_Object pathtail;
1176       EXTERNAL_LIST_LOOP (pathtail, path)
1177         {
1178           Lisp_Object pathel = Fexpand_file_name (XCAR (pathtail), Qnil);
1179           Fremhash (pathel, Vlocate_file_hash_table);
1180         }
1181     }
1182   return Qnil;
1183 }
1184
1185 /* Search for a file whose name is STR, looking in directories
1186    in the Lisp list PATH, and trying suffixes from SUFFIXES.
1187    SUFFIXES is a list of possible suffixes, or (for backward
1188    compatibility) a string containing possible suffixes separated by
1189    colons.
1190    On success, returns a file descriptor.  On failure, returns -1.
1191
1192    MODE nonnegative means don't open the files,
1193    just look for one for which access(file,MODE) succeeds.  In this case,
1194    returns 1 on success.
1195
1196    If STOREPTR is nonzero, it points to a slot where the name of
1197    the file actually found should be stored as a Lisp string.
1198    Nil is stored there on failure.
1199
1200    Called openp() in FSFmacs. */
1201
1202 int
1203 locate_file (Lisp_Object path, Lisp_Object str, Lisp_Object suffixes,
1204              Lisp_Object *storeptr, int mode)
1205 {
1206   /* This function can GC */
1207   Lisp_Object suffixtab = Qnil;
1208   Lisp_Object pathtail, pathel_expanded;
1209   int val;
1210   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1211
1212   if (storeptr)
1213     *storeptr = Qnil;
1214
1215   /* Is it really necessary to gcpro path and str?  It shouldn't be
1216      unless some caller has fucked up.  There are known instances that
1217      call us with build_string("foo:bar") as SUFFIXES, though. */
1218   GCPRO4 (path, str, suffixes, suffixtab);
1219
1220   /* if this filename has directory components, it's too complicated
1221      to try and use the hash tables. */
1222   if (!NILP (Ffile_name_directory (str)))
1223     {
1224       val = locate_file_without_hash (path, str, suffixes, storeptr, mode);
1225       UNGCPRO;
1226       return val;
1227     }
1228
1229   suffixtab = locate_file_construct_suffixed_files (str, suffixes);
1230
1231   EXTERNAL_LIST_LOOP (pathtail, path)
1232     {
1233       Lisp_Object pathel = XCAR (pathtail);
1234       Lisp_Object hash_table;
1235       Lisp_Object tail;
1236       int found = 0;
1237
1238       /* If this path element is relative, we have to look by hand. */
1239       if (NILP (Ffile_name_absolute_p (pathel)))
1240         {
1241           val = locate_file_in_directory (pathel, str, suffixes, storeptr,
1242                                           mode);
1243           if (val >= 0)
1244             {
1245               UNGCPRO;
1246               return val;
1247             }
1248           continue;
1249         }
1250
1251       pathel_expanded = Fexpand_file_name (pathel, Qnil);
1252       hash_table = locate_file_find_directory_hash_table (pathel_expanded);
1253
1254       if (!NILP (hash_table))
1255         {
1256           /* Loop over suffixes.  */
1257           LIST_LOOP (tail, suffixtab)
1258             if (!NILP (Fgethash (XCAR (tail), hash_table, Qnil)))
1259               {
1260                 found = 1;
1261                 break;
1262               }
1263         }
1264
1265       if (found)
1266         {
1267           /* This is a likely candidate.  Look by hand in this directory
1268              so we don't get thrown off if someone byte-compiles a file. */
1269           val = locate_file_in_directory (pathel, str, suffixes, storeptr,
1270                                           mode);
1271           if (val >= 0)
1272             {
1273               UNGCPRO;
1274               return val;
1275             }
1276
1277           /* Hmm ...  the file isn't actually there. (Or possibly it's
1278              a directory ...)  So refresh our hashing. */
1279           locate_file_refresh_hashing (pathel_expanded);
1280         }
1281     }
1282
1283   /* File is probably not there, but check the hard way just in case. */
1284   val = locate_file_without_hash (path, str, suffixes, storeptr, mode);
1285   if (val >= 0)
1286     {
1287       /* Sneaky user added a file without telling us. */
1288       Flocate_file_clear_hashing (path);
1289     }
1290
1291   UNGCPRO;
1292   return val;
1293 }
1294
1295 \f
1296 #ifdef LOADHIST
1297
1298 /* Merge the list we've accumulated of globals from the current input source
1299    into the load_history variable.  The details depend on whether
1300    the source has an associated file name or not. */
1301
1302 static void
1303 build_load_history (int loading, Lisp_Object source)
1304 {
1305   REGISTER Lisp_Object tail, prev, newelt;
1306   REGISTER Lisp_Object tem, tem2;
1307   int foundit;
1308
1309 #if !defined(LOADHIST_DUMPED)
1310   /* Don't bother recording anything for preloaded files.  */
1311   if (purify_flag)
1312     return;
1313 #endif
1314
1315   tail = Vload_history;
1316   prev = Qnil;
1317   foundit = 0;
1318   while (!NILP (tail))
1319     {
1320       tem = Fcar (tail);
1321
1322       /* Find the feature's previous assoc list... */
1323       if (internal_equal (source, Fcar (tem), 0))
1324         {
1325           foundit = 1;
1326
1327           /*  If we're loading, remove it. */
1328           if (loading)
1329             {
1330               if (NILP (prev))
1331                 Vload_history = Fcdr (tail);
1332               else
1333                 Fsetcdr (prev, Fcdr (tail));
1334             }
1335
1336           /*  Otherwise, cons on new symbols that are not already members.  */
1337           else
1338             {
1339               tem2 = Vcurrent_load_list;
1340
1341               while (CONSP (tem2))
1342                 {
1343                   newelt = XCAR (tem2);
1344
1345                   if (NILP (Fmemq (newelt, tem)))
1346                     Fsetcar (tail, Fcons (Fcar (tem),
1347                                           Fcons (newelt, Fcdr (tem))));
1348
1349                   tem2 = XCDR (tem2);
1350                   QUIT;
1351                 }
1352             }
1353         }
1354       else
1355         prev = tail;
1356       tail = Fcdr (tail);
1357       QUIT;
1358     }
1359
1360   /* If we're loading, cons the new assoc onto the front of load-history,
1361      the most-recently-loaded position.  Also do this if we didn't find
1362      an existing member for the current source.  */
1363   if (loading || !foundit)
1364     Vload_history = Fcons (Fnreverse (Vcurrent_load_list),
1365                            Vload_history);
1366 }
1367
1368 #else /* !LOADHIST */
1369 #define build_load_history(x,y)
1370 #endif /* !LOADHIST */
1371
1372 \f
1373 #if 0 /* FSFmacs defun hack */
1374 Lisp_Object
1375 unreadpure (void)       /* Used as unwind-protect function in readevalloop */
1376 {
1377   read_pure = 0;
1378   return Qnil;
1379 }
1380 #endif /* 0 */
1381
1382 static void
1383 readevalloop (Lisp_Object readcharfun,
1384               Lisp_Object sourcename,
1385               Lisp_Object (*evalfun) (Lisp_Object),
1386               int printflag)
1387 {
1388   /* This function can GC */
1389   REGISTER Emchar c;
1390   REGISTER Lisp_Object val = Qnil;
1391   int speccount = specpdl_depth ();
1392   struct gcpro gcpro1, gcpro2;
1393   struct buffer *b = 0;
1394
1395   if (BUFFERP (readcharfun))
1396     b = XBUFFER (readcharfun);
1397   else if (MARKERP (readcharfun))
1398     b = XMARKER (readcharfun)->buffer;
1399
1400   /* Don't do this.  It is not necessary, and it needlessly exposes
1401      READCHARFUN (which can be a stream) to Lisp.  --hniksic */
1402   /*specbind (Qstandard_input, readcharfun);*/
1403
1404   specbind (Qcurrent_load_list, Qnil);
1405
1406 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
1407   Vcurrent_compiled_function_annotation = Qnil;
1408 #endif
1409   GCPRO2 (val, sourcename);
1410
1411   LOADHIST_ATTACH (sourcename);
1412
1413   while (1)
1414     {
1415       QUIT;
1416
1417       if (b != 0 && !BUFFER_LIVE_P (b))
1418         error ("Reading from killed buffer");
1419
1420       c = readchar (readcharfun);
1421       if (c == ';')
1422         {
1423           /* Skip comment */
1424           while ((c = readchar (readcharfun)) != '\n' && c != -1)
1425             QUIT;
1426           continue;
1427         }
1428       if (c < 0)
1429         break;
1430
1431       /* Ignore whitespace here, so we can detect eof.  */
1432       if (c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r')
1433         continue;
1434
1435 #if 0 /* FSFmacs defun hack */
1436       if (purify_flag && c == '(')
1437         {
1438           int count1 = specpdl_depth ();
1439           record_unwind_protect (unreadpure, Qnil);
1440           val = read_list (readcharfun, ')', -1, 1);
1441           unbind_to (count1, Qnil);
1442         }
1443       else
1444 #else /* No "defun hack" -- Emacs 19 uses read-time syntax for bytecodes */
1445         {
1446           unreadchar (readcharfun, c);
1447           Vread_objects = Qnil;
1448           if (NILP (Vload_read_function))
1449             val = read0 (readcharfun);
1450           else
1451             val = call1 (Vload_read_function, readcharfun);
1452         }
1453 #endif
1454       val = (*evalfun) (val);
1455       if (printflag)
1456         {
1457           Vvalues = Fcons (val, Vvalues);
1458           if (EQ (Vstandard_output, Qt))
1459             Fprin1 (val, Qnil);
1460           else
1461             Fprint (val, Qnil);
1462         }
1463     }
1464
1465   build_load_history (LSTREAMP (readcharfun) ||
1466                       /* This looks weird, but it's what's in FSFmacs */
1467                       (b ? BUF_NARROWED (b) : BUF_NARROWED (current_buffer)),
1468                       sourcename);
1469   UNGCPRO;
1470
1471   unbind_to (speccount, Qnil);
1472 }
1473
1474 DEFUN ("eval-buffer", Feval_buffer, 0, 2, "bBuffer: ", /*
1475 Execute BUFFER as Lisp code.
1476 Programs can pass two arguments, BUFFER and PRINTFLAG.
1477 BUFFER is the buffer to evaluate (nil means use current buffer).
1478 PRINTFLAG controls printing of output:
1479 nil means discard it; anything else is stream for print.
1480
1481 If there is no error, point does not move.  If there is an error,
1482 point remains at the end of the last character read from the buffer.
1483 Execute BUFFER as Lisp code.
1484 */
1485        (bufname, printflag))
1486 {
1487   /* This function can GC */
1488   int speccount = specpdl_depth ();
1489   Lisp_Object tem, buf;
1490
1491   if (NILP (bufname))
1492     buf = Fcurrent_buffer ();
1493   else
1494     buf = Fget_buffer (bufname);
1495   if (NILP (buf))
1496     error ("No such buffer.");
1497
1498   if (NILP (printflag))
1499     tem = Qsymbolp;             /* #### #@[]*&$#*[& SI:NULL-STREAM */
1500   else
1501     tem = printflag;
1502   specbind (Qstandard_output, tem);
1503   record_unwind_protect (save_excursion_restore, save_excursion_save ());
1504   BUF_SET_PT (XBUFFER (buf), BUF_BEGV (XBUFFER (buf)));
1505   readevalloop (buf, XBUFFER (buf)->filename, Feval,
1506                 !NILP (printflag));
1507
1508   return unbind_to (speccount, Qnil);
1509 }
1510
1511 #if 0
1512 xxDEFUN ("eval-current-buffer", Feval_current_buffer, 0, 1, "", /*
1513 Execute the current buffer as Lisp code.
1514 Programs can pass argument PRINTFLAG which controls printing of output:
1515 nil means discard it; anything else is stream for print.
1516
1517 If there is no error, point does not move.  If there is an error,
1518 point remains at the end of the last character read from the buffer.
1519 */
1520          (printflag))
1521 {
1522   code omitted;
1523 }
1524 #endif /* 0 */
1525
1526 DEFUN ("eval-region", Feval_region, 2, 3, "r", /*
1527 Execute the region as Lisp code.
1528 When called from programs, expects two arguments,
1529 giving starting and ending indices in the current buffer
1530 of the text to be executed.
1531 Programs can pass third argument PRINTFLAG which controls output:
1532 nil means discard it; anything else is stream for printing it.
1533
1534 If there is no error, point does not move.  If there is an error,
1535 point remains at the end of the last character read from the buffer.
1536
1537 Note:  Before evaling the region, this function narrows the buffer to it.
1538 If the code being eval'd should happen to trigger a redisplay you may
1539 see some text temporarily disappear because of this.
1540 */
1541        (b, e, printflag))
1542 {
1543   /* This function can GC */
1544   int speccount = specpdl_depth ();
1545   Lisp_Object tem;
1546   Lisp_Object cbuf = Fcurrent_buffer ();
1547
1548   if (NILP (printflag))
1549     tem = Qsymbolp;             /* #### #@[]*&$#*[& SI:NULL-STREAM */
1550   else
1551     tem = printflag;
1552   specbind (Qstandard_output, tem);
1553
1554   if (NILP (printflag))
1555     record_unwind_protect (save_excursion_restore, save_excursion_save ());
1556   record_unwind_protect (save_restriction_restore, save_restriction_save ());
1557
1558   /* This both uses b and checks its type.  */
1559   Fgoto_char (b, cbuf);
1560   Fnarrow_to_region (make_int (BUF_BEGV (current_buffer)), e, cbuf);
1561   readevalloop (cbuf, XBUFFER (cbuf)->filename, Feval,
1562                 !NILP (printflag));
1563
1564   return unbind_to (speccount, Qnil);
1565 }
1566 \f
1567 DEFUN ("read", Fread, 0, 1, 0, /*
1568 Read one Lisp expression as text from STREAM, return as Lisp object.
1569 If STREAM is nil, use the value of `standard-input' (which see).
1570 STREAM or the value of `standard-input' may be:
1571  a buffer (read from point and advance it)
1572  a marker (read from where it points and advance it)
1573  a function (call it with no arguments for each character,
1574      call it with a char as argument to push a char back)
1575  a string (takes text from string, starting at the beginning)
1576  t (read text line using minibuffer and use it).
1577 */
1578        (stream))
1579 {
1580   if (NILP (stream))
1581     stream = Vstandard_input;
1582   if (EQ (stream, Qt))
1583     stream = Qread_char;
1584
1585   Vread_objects = Qnil;
1586
1587 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
1588   Vcurrent_compiled_function_annotation = Qnil;
1589 #endif
1590   if (EQ (stream, Qread_char))
1591     {
1592       Lisp_Object val = call1 (Qread_from_minibuffer,
1593                                build_translated_string ("Lisp expression: "));
1594       return Fcar (Fread_from_string (val, Qnil, Qnil));
1595     }
1596
1597   if (STRINGP (stream))
1598     return Fcar (Fread_from_string (stream, Qnil, Qnil));
1599
1600   return read0 (stream);
1601 }
1602
1603 DEFUN ("read-from-string", Fread_from_string, 1, 3, 0, /*
1604 Read one Lisp expression which is represented as text by STRING.
1605 Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
1606 START and END optionally delimit a substring of STRING from which to read;
1607  they default to 0 and (length STRING) respectively.
1608 */
1609        (string, start, end))
1610 {
1611   Bytecount startval, endval;
1612   Lisp_Object tem;
1613   Lisp_Object lispstream = Qnil;
1614   struct gcpro gcpro1;
1615
1616 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
1617   Vcurrent_compiled_function_annotation = Qnil;
1618 #endif
1619   GCPRO1 (lispstream);
1620   CHECK_STRING (string);
1621   get_string_range_byte (string, start, end, &startval, &endval,
1622                          GB_HISTORICAL_STRING_BEHAVIOR);
1623   lispstream = make_lisp_string_input_stream (string, startval,
1624                                               endval - startval);
1625
1626   Vread_objects = Qnil;
1627
1628   tem = read0 (lispstream);
1629   /* Yeah, it's ugly.  Gonna make something of it?
1630      At least our reader is reentrant ... */
1631   tem =
1632     (Fcons (tem, make_int
1633             (bytecount_to_charcount
1634              (XSTRING_DATA (string),
1635               startval + Lstream_byte_count (XLSTREAM (lispstream))))));
1636   Lstream_delete (XLSTREAM (lispstream));
1637   UNGCPRO;
1638   return tem;
1639 }
1640
1641 \f
1642 #ifdef LISP_BACKQUOTES
1643
1644 static Lisp_Object
1645 backquote_unwind (Lisp_Object ptr)
1646 {  /* used as unwind-protect function in read0() */
1647   int *counter = (int *) get_opaque_ptr (ptr);
1648   if (--*counter < 0)
1649     *counter = 0;
1650   free_opaque_ptr (ptr);
1651   return Qnil;
1652 }
1653
1654 #endif
1655
1656 /* Use this for recursive reads, in contexts where internal tokens
1657    are not allowed.  See also read1(). */
1658 static Lisp_Object
1659 read0 (Lisp_Object readcharfun)
1660 {
1661   Lisp_Object val = read1 (readcharfun);
1662
1663   if (CONSP (val) && UNBOUNDP (XCAR (val)))
1664     {
1665       Emchar c = XCHAR (XCDR (val));
1666       free_cons (XCONS (val));
1667       return Fsignal (Qinvalid_read_syntax,
1668                       list1 (Fchar_to_string (make_char (c))));
1669     }
1670
1671   return val;
1672 }
1673 \f
1674 static Emchar
1675 read_escape (Lisp_Object readcharfun)
1676 {
1677   /* This function can GC */
1678   Emchar c = readchar (readcharfun);
1679
1680   if (c < 0)
1681     signal_error (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));
1682
1683   switch (c)
1684     {
1685     case 'a': return '\007';
1686     case 'b': return '\b';
1687     case 'd': return 0177;
1688     case 'e': return 033;
1689     case 'f': return '\f';
1690     case 'n': return '\n';
1691     case 'r': return '\r';
1692     case 't': return '\t';
1693     case 'v': return '\v';
1694     case '\n': return -1;
1695
1696     case 'M':
1697       c = readchar (readcharfun);
1698       if (c < 0)
1699         signal_error (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));
1700       if (c != '-')
1701         error ("Invalid escape character syntax");
1702       c = readchar (readcharfun);
1703       if (c < 0)
1704         signal_error (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));
1705       if (c == '\\')
1706         c = read_escape (readcharfun);
1707       return c | 0200;
1708
1709       /* Originally, FSF_KEYS provided a degree of FSF Emacs
1710          compatibility by defining character "modifiers" alt, super,
1711          hyper and shift to infest the characters (i.e. integers).
1712
1713          However, this doesn't cut it for XEmacs 20, which
1714          distinguishes characters from integers.  Without Mule, ?\H-a
1715          simply returns ?a because every character is clipped into
1716          0-255.  Under Mule it is much worse -- ?\H-a with FSF_KEYS
1717          produces an illegal character, and moves us to crash-land.
1718
1719          For these reasons, FSF_KEYS hack is useless and without hope
1720          of ever working under XEmacs 20.  */
1721 #undef FSF_KEYS
1722
1723 #ifdef FSF_KEYS
1724 #define alt_modifier   (0x040000)
1725 #define super_modifier (0x080000)
1726 #define hyper_modifier (0x100000)
1727 #define shift_modifier (0x200000)
1728 /* fsf uses a different modifiers for meta and control.  Possibly
1729    byte_compiled code will still work fsfmacs, though... --Stig
1730
1731    #define ctl_modifier   (0x400000)
1732    #define meta_modifier  (0x800000)
1733 */
1734 #define FSF_LOSSAGE(mask)                                                       \
1735       if (fail_on_bucky_bit_character_escapes ||                                \
1736           ((c = readchar (readcharfun)) != '-'))                                \
1737         error ("Invalid escape character syntax");                              \
1738       c = readchar (readcharfun);                                               \
1739       if (c < 0)                                                                \
1740         signal_error (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));   \
1741       if (c == '\\')                                                            \
1742         c = read_escape (readcharfun);                                          \
1743       return c | mask
1744
1745     case 'S': FSF_LOSSAGE (shift_modifier);
1746     case 'H': FSF_LOSSAGE (hyper_modifier);
1747     case 'A': FSF_LOSSAGE (alt_modifier);
1748     case 's': FSF_LOSSAGE (super_modifier);
1749 #undef alt_modifier
1750 #undef super_modifier
1751 #undef hyper_modifier
1752 #undef shift_modifier
1753 #undef FSF_LOSSAGE
1754
1755 #endif /* FSF_KEYS */
1756
1757     case 'C':
1758       c = readchar (readcharfun);
1759       if (c < 0)
1760         signal_error (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));
1761       if (c != '-')
1762         error ("Invalid escape character syntax");
1763     case '^':
1764       c = readchar (readcharfun);
1765       if (c < 0)
1766         signal_error (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));
1767       if (c == '\\')
1768         c = read_escape (readcharfun);
1769       /* FSFmacs junk for non-ASCII controls.
1770          Not used here. */
1771       if (c == '?')
1772         return 0177;
1773       else
1774         return c & (0200 | 037);
1775
1776     case '0':
1777     case '1':
1778     case '2':
1779     case '3':
1780     case '4':
1781     case '5':
1782     case '6':
1783     case '7':
1784       /* An octal escape, as in ANSI C.  */
1785       {
1786         REGISTER Emchar i = c - '0';
1787         REGISTER int count = 0;
1788         while (++count < 3)
1789           {
1790             if ((c = readchar (readcharfun)) >= '0' && c <= '7')
1791               i = (i << 3) + (c - '0');
1792             else
1793               {
1794                 unreadchar (readcharfun, c);
1795                 break;
1796               }
1797           }
1798         return i;
1799       }
1800
1801     case 'x':
1802       /* A hex escape, as in ANSI C, except that we only allow latin-1
1803          characters to be read this way.  What is "\x4e03" supposed to
1804          mean, anyways, if the internal representation is hidden?
1805          This is also consistent with the treatment of octal escapes. */
1806       {
1807         REGISTER Emchar i = 0;
1808         REGISTER int count = 0;
1809         while (++count <= 2)
1810           {
1811             c = readchar (readcharfun);
1812             /* Remember, can't use isdigit(), isalpha() etc. on Emchars */
1813             if      (c >= '0' && c <= '9')  i = (i << 4) + (c - '0');
1814             else if (c >= 'a' && c <= 'f')  i = (i << 4) + (c - 'a') + 10;
1815             else if (c >= 'A' && c <= 'F')  i = (i << 4) + (c - 'A') + 10;
1816             else
1817               {
1818                 unreadchar (readcharfun, c);
1819                 break;
1820               }
1821           }
1822         return i;
1823       }
1824
1825 #ifdef MULE
1826       /* #### need some way of reading an extended character with
1827          an escape sequence. */
1828 #endif
1829
1830     default:
1831         return c;
1832     }
1833 }
1834
1835
1836 \f
1837 /* read symbol-constituent stuff into `Vread_buffer_stream'. */
1838 static Bytecount
1839 read_atom_0 (Lisp_Object readcharfun, Emchar firstchar, int *saw_a_backslash)
1840 {
1841   /* This function can GC */
1842   Emchar c = ((firstchar) >= 0 ? firstchar : readchar (readcharfun));
1843   Lstream_rewind (XLSTREAM (Vread_buffer_stream));
1844
1845   *saw_a_backslash = 0;
1846
1847   while (c > 040        /* #### - comma should be here as should backquote */
1848          && !(c == '\"' || c == '\'' || c == ';'
1849               || c == '(' || c == ')'
1850 #ifndef LISP_FLOAT_TYPE
1851               /* If we have floating-point support, then we need
1852                  to allow <digits><dot><digits>.  */
1853               || c =='.'
1854 #endif /* not LISP_FLOAT_TYPE */
1855               || c == '[' || c == ']' || c == '#'
1856               ))
1857     {
1858       if (c == '\\')
1859         {
1860           c = readchar (readcharfun);
1861           if (c < 0)
1862             signal_error (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));
1863           *saw_a_backslash = 1;
1864         }
1865       Lstream_put_emchar (XLSTREAM (Vread_buffer_stream), c);
1866       QUIT;
1867       c = readchar (readcharfun);
1868     }
1869
1870   if (c >= 0)
1871     unreadchar (readcharfun, c);
1872   /* blasted terminating 0 */
1873   Lstream_put_emchar (XLSTREAM (Vread_buffer_stream), 0);
1874   Lstream_flush (XLSTREAM (Vread_buffer_stream));
1875
1876   return Lstream_byte_count (XLSTREAM (Vread_buffer_stream)) - 1;
1877 }
1878
1879 static Lisp_Object parse_integer (CONST Bufbyte *buf, Bytecount len, int base);
1880
1881 static Lisp_Object
1882 read_atom (Lisp_Object readcharfun,
1883            Emchar firstchar,
1884            int uninterned_symbol)
1885 {
1886   /* This function can GC */
1887   int saw_a_backslash;
1888   Bytecount len = read_atom_0 (readcharfun, firstchar, &saw_a_backslash);
1889   char *read_ptr = (char *)
1890     resizing_buffer_stream_ptr (XLSTREAM (Vread_buffer_stream));
1891
1892   /* Is it an integer? */
1893   if (! (saw_a_backslash || uninterned_symbol))
1894     {
1895       /* If a token had any backslashes in it, it is disqualified from
1896          being an integer or a float.  This means that 123\456 is a
1897          symbol, as is \123 (which is the way (intern "123") prints).
1898          Also, if token was preceded by #:, it's always a symbol.
1899        */
1900       char *p = read_ptr + len;
1901       char *p1 = read_ptr;
1902
1903       if (*p1 == '+' || *p1 == '-') p1++;
1904       if (p1 != p)
1905         {
1906           int c;
1907
1908           while (p1 != p && (c = *p1) >= '0' && c <= '9')
1909             p1++;
1910 #ifdef LISP_FLOAT_TYPE
1911           /* Integers can have trailing decimal points.  */
1912           if (p1 > read_ptr && p1 < p && *p1 == '.')
1913             p1++;
1914 #endif
1915           if (p1 == p)
1916             {
1917               /* It is an integer. */
1918 #ifdef LISP_FLOAT_TYPE
1919               if (p1[-1] == '.')
1920                 p1[-1] = '\0';
1921 #endif
1922 #if 0
1923               {
1924                 int number = 0;
1925                 if (sizeof (int) == sizeof (EMACS_INT))
1926                   number = atoi (read_buffer);
1927                 else if (sizeof (long) == sizeof (EMACS_INT))
1928                   number = atol (read_buffer);
1929                 else
1930                   abort ();
1931                 return make_int (number);
1932               }
1933 #else
1934               return parse_integer ((Bufbyte *) read_ptr, len, 10);
1935 #endif
1936             }
1937         }
1938 #ifdef LISP_FLOAT_TYPE
1939       if (isfloat_string (read_ptr))
1940         return make_float (atof (read_ptr));
1941 #endif
1942     }
1943
1944   {
1945     Lisp_Object sym;
1946     if (uninterned_symbol)
1947       sym = Fmake_symbol ( make_string ((Bufbyte *) read_ptr, len));
1948     else
1949       {
1950         /* intern will purecopy pname if necessary */
1951         Lisp_Object name = make_string ((Bufbyte *) read_ptr, len);
1952         sym = Fintern (name, Qnil);
1953       }
1954     return sym;
1955   }
1956 }
1957
1958
1959 static Lisp_Object
1960 parse_integer (CONST Bufbyte *buf, Bytecount len, int base)
1961 {
1962   CONST Bufbyte *lim = buf + len;
1963   CONST Bufbyte *p = buf;
1964   EMACS_UINT num = 0;
1965   int negativland = 0;
1966
1967   if (*p == '-')
1968     {
1969       negativland = 1;
1970       p++;
1971     }
1972   else if (*p == '+')
1973     {
1974       p++;
1975     }
1976
1977   if (p == lim)
1978     goto loser;
1979
1980   for (; (p < lim) && (*p != '\0'); p++)
1981     {
1982       int c = *p;
1983       EMACS_UINT onum;
1984
1985       if (isdigit (c))
1986         c = c - '0';
1987       else if (isupper (c))
1988         c = c - 'A' + 10;
1989       else if (islower (c))
1990         c = c - 'a' + 10;
1991       else
1992         goto loser;
1993
1994       if (c < 0 || c >= base)
1995         goto loser;
1996
1997       onum = num;
1998       num = num * base + c;
1999       if (num < onum)
2000         goto overflow;
2001     }
2002
2003   {
2004     EMACS_INT int_result = negativland ? - (EMACS_INT) num : (EMACS_INT) num;
2005     Lisp_Object result = make_int (int_result);
2006     if (num && ((XINT (result) < 0) != negativland))
2007       goto overflow;
2008     if (XINT (result) != int_result)
2009       goto overflow;
2010     return result;
2011   }
2012  overflow:
2013   return Fsignal (Qinvalid_read_syntax,
2014                   list3 (build_translated_string
2015                          ("Integer constant overflow in reader"),
2016                          make_string (buf, len),
2017                          make_int (base)));
2018  loser:
2019   return Fsignal (Qinvalid_read_syntax,
2020                   list3 (build_translated_string
2021                          ("Invalid integer constant in reader"),
2022                          make_string (buf, len),
2023                          make_int (base)));
2024 }
2025
2026
2027 static Lisp_Object
2028 read_integer (Lisp_Object readcharfun, int base)
2029 {
2030   /* This function can GC */
2031   int saw_a_backslash;
2032   Bytecount len = read_atom_0 (readcharfun, -1, &saw_a_backslash);
2033   return (parse_integer
2034           (resizing_buffer_stream_ptr (XLSTREAM (Vread_buffer_stream)),
2035            ((saw_a_backslash)
2036             ? 0 /* make parse_integer signal error */
2037             : len),
2038            base));
2039 }
2040
2041 static Lisp_Object
2042 read_bit_vector (Lisp_Object readcharfun)
2043 {
2044   unsigned_char_dynarr *dyn = Dynarr_new (unsigned_char);
2045   Emchar c;
2046
2047   while (1)
2048     {
2049       c = readchar (readcharfun);
2050       if (c != '0' && c != '1')
2051         break;
2052       Dynarr_add (dyn, (unsigned char) (c - '0'));
2053     }
2054
2055   if (c >= 0)
2056     unreadchar (readcharfun, c);
2057
2058   return make_bit_vector_from_byte_vector (Dynarr_atp (dyn, 0),
2059                                            Dynarr_length (dyn));
2060 }
2061
2062 \f
2063
2064 /* structures */
2065
2066 struct structure_type *
2067 define_structure_type (Lisp_Object type,
2068                        int (*validate) (Lisp_Object data,
2069                                         Error_behavior errb),
2070                        Lisp_Object (*instantiate) (Lisp_Object data))
2071 {
2072   struct structure_type st;
2073
2074   st.type = type;
2075   st.keywords = Dynarr_new (structure_keyword_entry);
2076   st.validate = validate;
2077   st.instantiate = instantiate;
2078   Dynarr_add (the_structure_type_dynarr, st);
2079
2080   return Dynarr_atp (the_structure_type_dynarr,
2081                      Dynarr_length (the_structure_type_dynarr) - 1);
2082 }
2083
2084 void
2085 define_structure_type_keyword (struct structure_type *st, Lisp_Object keyword,
2086                                int (*validate) (Lisp_Object keyword,
2087                                                 Lisp_Object value,
2088                                                 Error_behavior errb))
2089 {
2090   struct structure_keyword_entry en;
2091
2092   en.keyword = keyword;
2093   en.validate = validate;
2094   Dynarr_add (st->keywords, en);
2095 }
2096
2097 static struct structure_type *
2098 recognized_structure_type (Lisp_Object type)
2099 {
2100   int i;
2101
2102   for (i = 0; i < Dynarr_length (the_structure_type_dynarr); i++)
2103     {
2104       struct structure_type *st = Dynarr_atp (the_structure_type_dynarr, i);
2105       if (EQ (st->type, type))
2106         return st;
2107     }
2108
2109   return 0;
2110 }
2111
2112 static Lisp_Object
2113 read_structure (Lisp_Object readcharfun)
2114 {
2115   Emchar c = readchar (readcharfun);
2116   Lisp_Object list = Qnil;
2117   Lisp_Object orig_list = Qnil;
2118   Lisp_Object already_seen = Qnil;
2119   int keyword_count;
2120   struct structure_type *st;
2121   struct gcpro gcpro1, gcpro2;
2122
2123   GCPRO2 (orig_list, already_seen);
2124   if (c != '(')
2125     RETURN_UNGCPRO (continuable_syntax_error ("#s not followed by paren"));
2126   list = read_list (readcharfun, ')', 0, 0);
2127   orig_list = list;
2128   {
2129     int len = XINT (Flength (list));
2130     if (len == 0)
2131       RETURN_UNGCPRO (continuable_syntax_error
2132                       ("structure type not specified"));
2133     if (!(len & 1))
2134       RETURN_UNGCPRO
2135         (continuable_syntax_error
2136          ("structures must have alternating keyword/value pairs"));
2137   }
2138
2139   st = recognized_structure_type (XCAR (list));
2140   if (!st)
2141     RETURN_UNGCPRO (Fsignal (Qinvalid_read_syntax,
2142                              list2 (build_translated_string
2143                                     ("unrecognized structure type"),
2144                                     XCAR (list))));
2145
2146   list = Fcdr (list);
2147   keyword_count = Dynarr_length (st->keywords);
2148   while (!NILP (list))
2149     {
2150       Lisp_Object keyword, value;
2151       int i;
2152       struct structure_keyword_entry *en = NULL;
2153
2154       keyword = Fcar (list);
2155       list = Fcdr (list);
2156       value = Fcar (list);
2157       list = Fcdr (list);
2158
2159       if (!NILP (memq_no_quit (keyword, already_seen)))
2160         RETURN_UNGCPRO (Fsignal (Qinvalid_read_syntax,
2161                                  list2 (build_translated_string
2162                                         ("structure keyword already seen"),
2163                                         keyword)));
2164
2165       for (i = 0; i < keyword_count; i++)
2166         {
2167           en = Dynarr_atp (st->keywords, i);
2168           if (EQ (keyword, en->keyword))
2169             break;
2170         }
2171
2172       if (i == keyword_count)
2173         RETURN_UNGCPRO (Fsignal (Qinvalid_read_syntax,
2174                                    list2 (build_translated_string
2175                                           ("unrecognized structure keyword"),
2176                                           keyword)));
2177
2178       if (en->validate && ! (en->validate) (keyword, value, ERROR_ME))
2179         RETURN_UNGCPRO
2180           (Fsignal (Qinvalid_read_syntax,
2181                     list3 (build_translated_string
2182                            ("invalid value for structure keyword"),
2183                            keyword, value)));
2184
2185       already_seen = Fcons (keyword, already_seen);
2186     }
2187
2188   if (st->validate && ! (st->validate) (orig_list, ERROR_ME))
2189     RETURN_UNGCPRO (Fsignal (Qinvalid_read_syntax,
2190                              list2 (build_translated_string
2191                                     ("invalid structure initializer"),
2192                                     orig_list)));
2193
2194   RETURN_UNGCPRO ((st->instantiate) (XCDR (orig_list)));
2195 }
2196
2197 \f
2198 static Lisp_Object read_compiled_function (Lisp_Object readcharfun,
2199                                            int terminator);
2200 static Lisp_Object read_vector (Lisp_Object readcharfun, int terminator);
2201
2202 /* Get the next character; filter out whitespace and comments */
2203
2204 static Emchar
2205 reader_nextchar (Lisp_Object readcharfun)
2206 {
2207   /* This function can GC */
2208   Emchar c;
2209
2210  retry:
2211   QUIT;
2212   c = readchar (readcharfun);
2213   if (c < 0)
2214     signal_error (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));
2215
2216   switch (c)
2217     {
2218     default:
2219       {
2220         /* Ignore whitespace and control characters */
2221         if (c <= 040)
2222           goto retry;
2223         return c;
2224       }
2225
2226     case ';':
2227       {
2228         /* Comment */
2229         while ((c = readchar (readcharfun)) >= 0 && c != '\n')
2230           QUIT;
2231         goto retry;
2232       }
2233     }
2234 }
2235
2236 #if 0
2237 static Lisp_Object
2238 list2_pure (int pure, Lisp_Object a, Lisp_Object b)
2239 {
2240   return pure ? pure_cons (a, pure_cons (b, Qnil)) : list2 (a, b);
2241 }
2242 #endif
2243
2244 /* Read the next Lisp object from the stream READCHARFUN and return it.
2245    If the return value is a cons whose car is Qunbound, then read1()
2246    encountered a misplaced token (e.g. a right bracket, right paren,
2247    or dot followed by a non-number).  To filter this stuff out,
2248    use read0(). */
2249
2250 static Lisp_Object
2251 read1 (Lisp_Object readcharfun)
2252 {
2253   Emchar c;
2254
2255 retry:
2256   c = reader_nextchar (readcharfun);
2257
2258   switch (c)
2259     {
2260     case '(':
2261       {
2262 #ifdef LISP_BACKQUOTES  /* old backquote compatibility in lisp reader */
2263         /* if this is disabled, then other code in eval.c must be enabled */
2264         Emchar ch = reader_nextchar (readcharfun);
2265         switch (ch)
2266           {
2267           case '`':
2268             {
2269               Lisp_Object tem;
2270               int speccount = specpdl_depth ();
2271               ++old_backquote_flag;
2272               record_unwind_protect (backquote_unwind,
2273                                      make_opaque_ptr (&old_backquote_flag));
2274               tem = read0 (readcharfun);
2275               unbind_to (speccount, Qnil);
2276               ch = reader_nextchar (readcharfun);
2277               if (ch != ')')
2278                 {
2279                   unreadchar (readcharfun, ch);
2280                   return Fsignal (Qinvalid_read_syntax,
2281                                   list1 (build_string
2282                                          ("Weird old-backquote syntax")));
2283                 }
2284               return list2 (Qbacktick, tem);
2285             }
2286           case ',':
2287             {
2288               if (old_backquote_flag)
2289                 {
2290                   Lisp_Object tem, comma_type;
2291                   ch = readchar (readcharfun);
2292                   if (ch == '@')
2293                     comma_type = Qcomma_at;
2294                   else
2295                     {
2296                       if (ch >= 0)
2297                         unreadchar (readcharfun, ch);
2298                       comma_type = Qcomma;
2299                     }
2300                   tem = read0 (readcharfun);
2301                   ch = reader_nextchar (readcharfun);
2302                   if (ch != ')')
2303                     {
2304                       unreadchar (readcharfun, ch);
2305                       return Fsignal (Qinvalid_read_syntax,
2306                                       list1 (build_string
2307                                              ("Weird old-backquote syntax")));
2308                     }
2309                   return list2 (comma_type, tem);
2310                 }
2311               else
2312                 {
2313                   unreadchar (readcharfun, ch);
2314 #if 0
2315                   return Fsignal (Qinvalid_read_syntax,
2316                        list1 (build_string ("Comma outside of backquote")));
2317 #else
2318                   /* #### - yuck....but this is reverse compatible. */
2319                   /* mostly this is required by edebug, which does its own
2320                      annotated reading.  We need to have an annotated_read
2321                      function that records (with markers) the buffer
2322                      positions of the elements that make up lists, then that
2323                      can be used in edebug and bytecomp and the check above
2324                      can go back in. --Stig */
2325                   break;
2326 #endif
2327                 }
2328             }
2329           default:
2330             unreadchar (readcharfun, ch);
2331           }                     /* switch(ch) */
2332 #endif /* old backquote crap... */
2333         return read_list (readcharfun, ')', 1, 1);
2334       }
2335     case '[':
2336       return read_vector (readcharfun, ']');
2337
2338     case ')':
2339     case ']':
2340       /* #### - huh? these don't do what they seem... */
2341       return noseeum_cons (Qunbound, make_char (c));
2342     case '.':
2343       {
2344 #ifdef LISP_FLOAT_TYPE
2345         /* If a period is followed by a number, then we should read it
2346            as a floating point number.  Otherwise, it denotes a dotted
2347            pair.
2348          */
2349         c = readchar (readcharfun);
2350         unreadchar (readcharfun, c);
2351
2352         /* Can't use isdigit on Emchars */
2353         if (c < '0' || c > '9')
2354           return noseeum_cons (Qunbound, make_char ('.'));
2355
2356         /* Note that read_atom will loop
2357            at least once, assuring that we will not try to UNREAD
2358            two characters in a row.
2359            (I think this doesn't matter anymore because there should
2360            be no more danger in unreading multiple characters) */
2361         return read_atom (readcharfun, '.', 0);
2362
2363 #else /* ! LISP_FLOAT_TYPE */
2364         return noseeum_cons (Qunbound, make_char ('.'));
2365 #endif /* ! LISP_FLOAT_TYPE */
2366       }
2367
2368     case '#':
2369       {
2370         c = readchar (readcharfun);
2371         switch (c)
2372           {
2373 #if 0 /* FSFmacs silly char-table syntax */
2374           case '^':
2375 #endif
2376 #if 0 /* FSFmacs silly bool-vector syntax */
2377           case '&':
2378 #endif
2379             /* "#["-- byte-code constant syntax */
2380             /* purecons #[...] syntax */
2381           case '[': return read_compiled_function (readcharfun, ']'
2382                                                    /*, purify_flag */ );
2383             /* "#:"-- gensym syntax */
2384           case ':': return read_atom (readcharfun, -1, 1);
2385             /* #'x => (function x) */
2386           case '\'': return list2 (Qfunction, read0 (readcharfun));
2387 #if 0
2388             /* RMS uses this syntax for fat-strings.
2389                If we use it for vectors, then obscure bugs happen.
2390              */
2391             /* "#(" -- Scheme/CL vector syntax */
2392           case '(': return read_vector (readcharfun, ')');
2393 #endif
2394 #if 0 /* FSFmacs */
2395           case '(':
2396             {
2397               Lisp_Object tmp;
2398               struct gcpro gcpro1;
2399
2400               /* Read the string itself.  */
2401               tmp = read1 (readcharfun);
2402               if (!STRINGP (tmp))
2403                 {
2404                   if (CONSP (tmp) && UNBOUNDP (XCAR (tmp)))
2405                     free_cons (XCONS (tmp));
2406                   return Fsignal (Qinvalid_read_syntax,
2407                                    list1 (build_string ("#")));
2408                 }
2409               GCPRO1 (tmp);
2410               /* Read the intervals and their properties.  */
2411               while (1)
2412                 {
2413                   Lisp_Object beg, end, plist;
2414                   Emchar ch;
2415                   int invalid = 0;
2416
2417                   beg = read1 (readcharfun);
2418                   if (CONSP (beg) && UNBOUNDP (XCAR (beg)))
2419                     {
2420                       ch = XCHAR (XCDR (beg));
2421                       free_cons (XCONS (beg));
2422                       if (ch == ')')
2423                         break;
2424                       else
2425                         invalid = 1;
2426                     }
2427                   if (!invalid)
2428                     {
2429                       end = read1 (readcharfun);
2430                       if (CONSP (end) && UNBOUNDP (XCAR (end)))
2431                         {
2432                           free_cons (XCONS (end));
2433                           invalid = 1;
2434                         }
2435                     }
2436                   if (!invalid)
2437                     {
2438                       plist = read1 (readcharfun);
2439                       if (CONSP (plist) && UNBOUNDP (XCAR (plist)))
2440                         {
2441                           free_cons (XCONS (plist));
2442                           invalid = 1;
2443                         }
2444                     }
2445                   if (invalid)
2446                     RETURN_UNGCPRO
2447                       (Fsignal (Qinvalid_read_syntax,
2448                                 list2
2449                                 (build_string ("invalid string property list"),
2450                                  XCDR (plist))));
2451                   Fset_text_properties (beg, end, plist, tmp);
2452                 }
2453               UNGCPRO;
2454               return tmp;
2455             }
2456 #endif /* 0 */
2457           case '@':
2458             {
2459               /* #@NUMBER is used to skip NUMBER following characters.
2460                  That's used in .elc files to skip over doc strings
2461                  and function definitions.  */
2462               int i, nskip = 0;
2463
2464               /* Read a decimal integer.  */
2465               while ((c = readchar (readcharfun)) >= 0
2466                      && c >= '0' && c <= '9')
2467                 nskip = (10 * nskip) + (c - '0');
2468               if (c >= 0)
2469                 unreadchar (readcharfun, c);
2470
2471               /* FSF has code here that maybe caches the skipped
2472                  string.  See above for why this is totally
2473                  losing.  We handle this differently. */
2474
2475               /* Skip that many characters.  */
2476               for (i = 0; i < nskip && c >= 0; i++)
2477                 c = readchar (readcharfun);
2478
2479               goto retry;
2480             }
2481           case '$': return Vload_file_name_internal;
2482             /* bit vectors */
2483           case '*': return read_bit_vector (readcharfun);
2484             /* #o10 => 8 -- octal constant syntax */
2485           case 'o': return read_integer (readcharfun, 8);
2486             /* #xdead => 57005 -- hex constant syntax */
2487           case 'x': return read_integer (readcharfun, 16);
2488             /* #b010 => 2 -- binary constant syntax */
2489           case 'b': return read_integer (readcharfun, 2);
2490             /* #s(foobar key1 val1 key2 val2) -- structure syntax */
2491           case 's': return read_structure (readcharfun);
2492           case '<':
2493             {
2494               unreadchar (readcharfun, c);
2495               return Fsignal (Qinvalid_read_syntax,
2496                     list1 (build_string ("Cannot read unreadable object")));
2497             }
2498 #ifdef FEATUREP_SYNTAX
2499           case '+':
2500           case '-':
2501             {
2502               Lisp_Object fexp, obj, tem;
2503               struct gcpro gcpro1, gcpro2;
2504
2505               fexp = read0(readcharfun);
2506               obj = read0(readcharfun);
2507
2508               /* the call to `featurep' may GC. */
2509               GCPRO2 (fexp, obj);
2510               tem = call1 (Qfeaturep, fexp);
2511               UNGCPRO;
2512
2513               if (c == '+' &&  NILP(tem)) goto retry;
2514               if (c == '-' && !NILP(tem)) goto retry;
2515               return obj;
2516             }
2517 #endif
2518           case '0': case '1': case '2': case '3': case '4':
2519           case '5': case '6': case '7': case '8': case '9':
2520             /* Reader forms that can reuse previously read objects.  */
2521             {
2522               int n = 0;
2523               Lisp_Object found;
2524
2525               /* Using read_integer() here is impossible, because it
2526                  chokes on `='.  Using parse_integer() is too hard.
2527                  So we simply read it in, and ignore overflows, which
2528                  is safe.  */
2529               while (c >= '0' && c <= '9')
2530                 {
2531                   n *= 10;
2532                   n += c - '0';
2533                   c = readchar (readcharfun);
2534                 }
2535               found = assq_no_quit (make_int (n), Vread_objects);
2536               if (c == '=')
2537                 {
2538                   /* #n=object returns object, but associates it with
2539                      n for #n#.  */
2540                   Lisp_Object obj;
2541                   if (CONSP (found))
2542                     return Fsignal (Qinvalid_read_syntax,
2543                                     list2 (build_translated_string
2544                                            ("Multiply defined symbol label"),
2545                                            make_int (n)));
2546                   obj = read0 (readcharfun);
2547                   Vread_objects = Fcons (Fcons (make_int (n), obj),
2548                                          Vread_objects);
2549                   return obj;
2550                 }
2551               else if (c == '#')
2552                 {
2553                   /* #n# returns a previously read object.  */
2554                   if (CONSP (found))
2555                     return XCDR (found);
2556                   else
2557                     return Fsignal (Qinvalid_read_syntax,
2558                                     list2 (build_translated_string
2559                                            ("Undefined symbol label"),
2560                                            make_int (n)));
2561                 }
2562               return Fsignal (Qinvalid_read_syntax,
2563                               list1 (build_string ("#")));
2564             }
2565           default:
2566             {
2567               unreadchar (readcharfun, c);
2568               return Fsignal (Qinvalid_read_syntax,
2569                               list1 (build_string ("#")));
2570             }
2571           }
2572       }
2573
2574       /* Quote */
2575     case '\'': return list2 (Qquote, read0 (readcharfun));
2576
2577 #ifdef LISP_BACKQUOTES
2578     case '`':
2579       {
2580         Lisp_Object tem;
2581         int speccount = specpdl_depth ();
2582         ++new_backquote_flag;
2583         record_unwind_protect (backquote_unwind,
2584                                make_opaque_ptr (&new_backquote_flag));
2585         tem = read0 (readcharfun);
2586         unbind_to (speccount, Qnil);
2587         return list2 (Qbackquote, tem);
2588       }
2589
2590     case ',':
2591       {
2592         if (new_backquote_flag)
2593           {
2594             Lisp_Object comma_type = Qnil;
2595             int ch = readchar (readcharfun);
2596
2597             if (ch == '@')
2598               comma_type = Qcomma_at;
2599             else if (ch == '.')
2600               comma_type = Qcomma_dot;
2601             else
2602               {
2603                 if (ch >= 0)
2604                   unreadchar (readcharfun, ch);
2605                 comma_type = Qcomma;
2606               }
2607             return list2 (comma_type, read0 (readcharfun));
2608           }
2609         else
2610           {
2611             /* YUCK.  99.999% backwards compatibility.  The Right
2612                Thing(tm) is to signal an error here, because it's
2613                really invalid read syntax.  Instead, this permits
2614                commas to begin symbols (unless they're inside
2615                backquotes).  If an error is signalled here in the
2616                future, then commas should be invalid read syntax
2617                outside of backquotes anywhere they're found (i.e.
2618                they must be quoted in symbols) -- Stig */
2619             return read_atom (readcharfun, c, 0);
2620           }
2621       }
2622 #endif
2623
2624     case '?':
2625       {
2626         /* Evil GNU Emacs "character" (ie integer) syntax */
2627         c = readchar (readcharfun);
2628         if (c < 0)
2629           return Fsignal (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));
2630
2631         if (c == '\\')
2632           c = read_escape (readcharfun);
2633         return make_char (c);
2634       }
2635
2636     case '\"':
2637       {
2638         /* String */
2639 #ifdef I18N3
2640         /* #### If the input stream is translating, then the string
2641            should be marked as translatable by setting its
2642            `string-translatable' property to t.  .el and .elc files
2643            normally are translating input streams.  See Fgettext()
2644            and print_internal(). */
2645 #endif
2646         int cancel = 0;
2647
2648         Lstream_rewind (XLSTREAM (Vread_buffer_stream));
2649         while ((c = readchar (readcharfun)) >= 0
2650                && c != '\"')
2651           {
2652             if (c == '\\')
2653               c = read_escape (readcharfun);
2654             /* c is -1 if \ newline has just been seen */
2655             if (c == -1)
2656               {
2657                 if (Lstream_byte_count (XLSTREAM (Vread_buffer_stream)) == 0)
2658                   cancel = 1;
2659               }
2660             else
2661               Lstream_put_emchar (XLSTREAM (Vread_buffer_stream), c);
2662             QUIT;
2663           }
2664         if (c < 0)
2665           return Fsignal (Qend_of_file, list1 (READCHARFUN_MAYBE (readcharfun)));
2666
2667         /* If purifying, and string starts with \ newline,
2668            return zero instead.  This is for doc strings
2669            that we are really going to find in lib-src/DOC.nn.nn  */
2670         if (purify_flag && NILP (Vinternal_doc_file_name) && cancel)
2671           return Qzero;
2672
2673         Lstream_flush (XLSTREAM (Vread_buffer_stream));
2674         return
2675           make_string
2676           (resizing_buffer_stream_ptr (XLSTREAM (Vread_buffer_stream)),
2677            Lstream_byte_count (XLSTREAM (Vread_buffer_stream)));
2678       }
2679
2680     default:
2681       {
2682         /* Ignore whitespace and control characters */
2683         if (c <= 040)
2684           goto retry;
2685         return read_atom (readcharfun, c, 0);
2686       }
2687     }
2688 }
2689
2690
2691 \f
2692 #ifdef LISP_FLOAT_TYPE
2693
2694 #define LEAD_INT 1
2695 #define DOT_CHAR 2
2696 #define TRAIL_INT 4
2697 #define E_CHAR 8
2698 #define EXP_INT 16
2699
2700 int
2701 isfloat_string (CONST char *cp)
2702 {
2703   int state = 0;
2704   CONST Bufbyte *ucp = (CONST Bufbyte *) cp;
2705
2706   if (*ucp == '+' || *ucp == '-')
2707     ucp++;
2708
2709   if (*ucp >= '0' && *ucp <= '9')
2710     {
2711       state |= LEAD_INT;
2712       while (*ucp >= '0' && *ucp <= '9')
2713         ucp++;
2714     }
2715   if (*ucp == '.')
2716     {
2717       state |= DOT_CHAR;
2718       ucp++;
2719     }
2720   if (*ucp >= '0' && *ucp <= '9')
2721     {
2722       state |= TRAIL_INT;
2723       while (*ucp >= '0' && *ucp <= '9')
2724         ucp++;
2725     }
2726   if (*ucp == 'e' || *ucp == 'E')
2727     {
2728       state |= E_CHAR;
2729       ucp++;
2730       if ((*ucp == '+') || (*ucp == '-'))
2731         ucp++;
2732     }
2733
2734   if (*ucp >= '0' && *ucp <= '9')
2735     {
2736       state |= EXP_INT;
2737       while (*ucp >= '0' && *ucp <= '9')
2738         ucp++;
2739     }
2740   return (((*ucp == 0) || (*ucp == ' ') || (*ucp == '\t') || (*ucp == '\n')
2741            || (*ucp == '\r') || (*ucp == '\f'))
2742           && (state == (LEAD_INT|DOT_CHAR|TRAIL_INT)
2743               || state == (DOT_CHAR|TRAIL_INT)
2744               || state == (LEAD_INT|E_CHAR|EXP_INT)
2745               || state == (LEAD_INT|DOT_CHAR|TRAIL_INT|E_CHAR|EXP_INT)
2746               || state == (DOT_CHAR|TRAIL_INT|E_CHAR|EXP_INT)));
2747 }
2748 #endif /* LISP_FLOAT_TYPE */
2749 \f
2750 static void *
2751 sequence_reader (Lisp_Object readcharfun,
2752                  Emchar terminator,
2753                  void *state,
2754                  void * (*conser) (Lisp_Object readcharfun,
2755                                    void *state, Charcount len))
2756 {
2757   Charcount len;
2758
2759   for (len = 0; ; len++)
2760     {
2761       Emchar ch;
2762
2763       QUIT;
2764       ch = reader_nextchar (readcharfun);
2765
2766       if (ch == terminator)
2767         return state;
2768       else
2769         unreadchar (readcharfun, ch);
2770 #ifdef FEATUREP_SYNTAX
2771       if (ch == ']')
2772         syntax_error ("\"]\" in a list");
2773       else if (ch == ')')
2774         syntax_error ("\")\" in a vector");
2775 #endif
2776       state = ((conser) (readcharfun, state, len));
2777     }
2778 }
2779
2780
2781 struct read_list_state
2782   {
2783     Lisp_Object head;
2784     Lisp_Object tail;
2785     int length;
2786     int allow_dotted_lists;
2787     Emchar terminator;
2788   };
2789
2790 static void *
2791 read_list_conser (Lisp_Object readcharfun, void *state, Charcount len)
2792 {
2793   struct read_list_state *s = (struct read_list_state *) state;
2794   Lisp_Object elt;
2795
2796   elt = read1 (readcharfun);
2797
2798   if (CONSP (elt) && UNBOUNDP (XCAR (elt)))
2799     {
2800       Lisp_Object tem = elt;
2801       Emchar ch;
2802
2803       elt = XCDR (elt);
2804       free_cons (XCONS (tem));
2805       tem = Qnil;
2806       ch = XCHAR (elt);
2807 #ifdef FEATUREP_SYNTAX
2808       if (ch == s->terminator) /* deal with #+, #- reader macros */
2809         {
2810           unreadchar (readcharfun, s->terminator);
2811           goto done;
2812         }
2813       else if (ch == ']')
2814         syntax_error ("']' in a list");
2815       else if (ch == ')')
2816         syntax_error ("')' in a vector");
2817       else
2818 #endif
2819       if (ch != '.')
2820         signal_simple_error ("BUG! Internal reader error", elt);
2821       else if (!s->allow_dotted_lists)
2822         syntax_error ("\".\" in a vector");
2823       else
2824         {
2825           if (!NILP (s->tail))
2826             XCDR (s->tail) = read0 (readcharfun);
2827           else
2828             s->head = read0 (readcharfun);
2829           elt = read1 (readcharfun);
2830           if (CONSP (elt) && UNBOUNDP (XCAR (elt)))
2831             {
2832               ch = XCHAR (XCDR (elt));
2833               free_cons (XCONS (elt));
2834               if (ch == s->terminator)
2835                 {
2836                   unreadchar (readcharfun, s->terminator);
2837                   goto done;
2838                 }
2839             }
2840           syntax_error (". in wrong context");
2841         }
2842     }
2843
2844 #if 0 /* FSFmacs defun hack, or something ... */
2845   if (NILP (tail) && defun_hack && EQ (elt, Qdefun) && !read_pure)
2846     {
2847       record_unwind_protect (unreadpure, Qzero);
2848       read_pure = 1;
2849     }
2850 #endif
2851
2852 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
2853   if (s->length == 1 && s->allow_dotted_lists && EQ (XCAR (s->head), Qfset))
2854     {
2855       if (CONSP (elt) && EQ (XCAR (elt), Qquote) && CONSP (XCDR (elt)))
2856         Vcurrent_compiled_function_annotation = XCAR (XCDR (elt));
2857       else
2858         Vcurrent_compiled_function_annotation = elt;
2859     }
2860 #endif
2861
2862   elt = Fcons (elt, Qnil);
2863   if (!NILP (s->tail))
2864     XCDR (s->tail) = elt;
2865   else
2866     s->head = elt;
2867   s->tail = elt;
2868  done:
2869   s->length++;
2870   return s;
2871 }
2872
2873 \f
2874 #if 0 /* FSFmacs defun hack */
2875 /* -1 for allow_dotted_lists means allow_dotted_lists and check
2876    for starting with defun and make structure pure. */
2877 #endif
2878
2879 static Lisp_Object
2880 read_list (Lisp_Object readcharfun,
2881            Emchar terminator,
2882            int allow_dotted_lists,
2883            int check_for_doc_references)
2884 {
2885   struct read_list_state s;
2886   struct gcpro gcpro1, gcpro2;
2887 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
2888   Lisp_Object old_compiled_function_annotation =
2889     Vcurrent_compiled_function_annotation;
2890 #endif
2891
2892   s.head = Qnil;
2893   s.tail = Qnil;
2894   s.length = 0;
2895   s.allow_dotted_lists = allow_dotted_lists;
2896   s.terminator = terminator;
2897   GCPRO2 (s.head, s.tail);
2898
2899   sequence_reader (readcharfun, terminator, &s, read_list_conser);
2900 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
2901   Vcurrent_compiled_function_annotation = old_compiled_function_annotation;
2902 #endif
2903
2904   if ((purify_flag || load_force_doc_strings) && check_for_doc_references)
2905     {
2906       /* check now for any doc string references and record them
2907          for later. */
2908       Lisp_Object tail;
2909
2910       /* We might be dealing with an imperfect list so don't
2911          use LIST_LOOP */
2912       for (tail = s.head; CONSP (tail); tail = XCDR (tail))
2913         {
2914           Lisp_Object holding_cons = Qnil;
2915
2916           {
2917             Lisp_Object elem = XCAR (tail);
2918             /* elem might be (#$ . INT) ... */
2919             if (CONSP (elem) && EQ (XCAR (elem), Vload_file_name_internal))
2920               holding_cons = tail;
2921             /* or it might be (quote (#$ . INT)) i.e.
2922                (quote . ((#$ . INT) . nil)) in the case of
2923                `autoload' (autoload evaluates its arguments, while
2924                `defvar', `defun', etc. don't). */
2925             if (CONSP (elem) && EQ (XCAR (elem), Qquote)
2926                 && CONSP (XCDR (elem)))
2927               {
2928                 elem = XCAR (XCDR (elem));
2929                 if (CONSP (elem) && EQ (XCAR (elem), Vload_file_name_internal))
2930                   holding_cons = XCDR (XCAR (tail));
2931               }
2932           }
2933
2934           if (CONSP (holding_cons))
2935             {
2936               if (purify_flag)
2937                 {
2938                   if (NILP (Vinternal_doc_file_name))
2939                     /* We have not yet called Snarf-documentation, so
2940                        assume this file is described in the DOC file
2941                        and Snarf-documentation will fill in the right
2942                        value later.  For now, replace the whole list
2943                        with 0.  */
2944                     XCAR (holding_cons) = Qzero;
2945                   else
2946                     /* We have already called Snarf-documentation, so
2947                        make a relative file name for this file, so it
2948                        can be found properly in the installed Lisp
2949                        directory.  We don't use Fexpand_file_name
2950                        because that would make the directory absolute
2951                        now.  */
2952                     XCAR (XCAR (holding_cons)) =
2953                       concat2 (build_string ("../lisp/"),
2954                                Ffile_name_nondirectory
2955                                (Vload_file_name_internal));
2956                 }
2957               else
2958                 /* Not pure.  Just add to Vload_force_doc_string_list,
2959                    and the string will be filled in properly in
2960                    load_force_doc_string_unwind(). */
2961                 Vload_force_doc_string_list =
2962                   /* We pass the cons that holds the (#$ . INT) so we
2963                      can modify it in-place. */
2964                   Fcons (holding_cons, Vload_force_doc_string_list);
2965             }
2966         }
2967     }
2968
2969   UNGCPRO;
2970   return s.head;
2971 }
2972
2973 static Lisp_Object
2974 read_vector (Lisp_Object readcharfun,
2975              Emchar terminator)
2976 {
2977   Lisp_Object tem;
2978   Lisp_Object *p;
2979   int len;
2980   int i;
2981   struct read_list_state s;
2982   struct gcpro gcpro1, gcpro2;
2983
2984   s.head = Qnil;
2985   s.tail = Qnil;
2986   s.length = 0;
2987   s.allow_dotted_lists = 0;
2988   GCPRO2 (s.head, s.tail);
2989
2990   sequence_reader (readcharfun, terminator, &s, read_list_conser);
2991
2992   UNGCPRO;
2993   tem = s.head;
2994   len = XINT (Flength (tem));
2995
2996 #if 0 /* FSFmacs defun hack */
2997   if (read_pure)
2998     s.head = make_pure_vector (len, Qnil);
2999   else
3000 #endif
3001     s.head = make_vector (len, Qnil);
3002
3003   for (i = 0, p = &(XVECTOR_DATA (s.head)[0]);
3004        i < len;
3005        i++, p++)
3006   {
3007     struct Lisp_Cons *otem = XCONS (tem);
3008 #if 0 /* FSFmacs defun hack */
3009     if (read_pure)
3010       tem = Fpurecopy (Fcar (tem));
3011     else
3012 #endif
3013       tem = Fcar (tem);
3014     *p = tem;
3015     tem = otem->cdr;
3016     free_cons (otem);
3017   }
3018   return s.head;
3019 }
3020
3021 static Lisp_Object
3022 read_compiled_function (Lisp_Object readcharfun, Emchar terminator)
3023 {
3024   /* Accept compiled functions at read-time so that we don't
3025      have to build them at load-time. */
3026   Lisp_Object stuff;
3027   Lisp_Object make_byte_code_args[COMPILED_DOMAIN + 1];
3028   struct gcpro gcpro1;
3029   int len;
3030   int iii;
3031   int saw_a_doc_ref = 0;
3032
3033   /* Note: we tell read_list not to search for doc references
3034      because we need to handle the "doc reference" for the
3035      instructions and constants differently. */
3036   stuff = read_list (readcharfun, terminator, 0, 0);
3037   len = XINT (Flength (stuff));
3038   if (len < COMPILED_STACK_DEPTH + 1 || len > COMPILED_DOMAIN + 1)
3039     return
3040       continuable_syntax_error ("#[...] used with wrong number of elements");
3041
3042   for (iii = 0; CONSP (stuff); iii++)
3043     {
3044       struct Lisp_Cons *victim = XCONS (stuff);
3045       make_byte_code_args[iii] = Fcar (stuff);
3046       if ((purify_flag || load_force_doc_strings)
3047            && CONSP (make_byte_code_args[iii])
3048           && EQ (XCAR (make_byte_code_args[iii]), Vload_file_name_internal))
3049         {
3050           if (purify_flag && iii == COMPILED_DOC_STRING)
3051             {
3052               /* same as in read_list(). */
3053               if (NILP (Vinternal_doc_file_name))
3054                 make_byte_code_args[iii] = Qzero;
3055               else
3056                 XCAR (make_byte_code_args[iii]) =
3057                   concat2 (build_string ("../lisp/"),
3058                            Ffile_name_nondirectory
3059                            (Vload_file_name_internal));
3060             }
3061           else
3062             saw_a_doc_ref = 1;
3063         }
3064       stuff = Fcdr (stuff);
3065       free_cons (victim);
3066     }
3067   GCPRO1 (make_byte_code_args[0]);
3068   gcpro1.nvars = len;
3069
3070   /* v18 or v19 bytecode file.  Need to Ebolify. */
3071   if (load_byte_code_version < 20 && VECTORP (make_byte_code_args[2]))
3072     ebolify_bytecode_constants (make_byte_code_args[2]);
3073
3074   /* make-byte-code looks at purify_flag, which should have the same
3075    *  value as our "read-pure" argument */
3076   stuff = Fmake_byte_code (len, make_byte_code_args);
3077   XCOMPILED_FUNCTION (stuff)->flags.ebolified = (load_byte_code_version < 20);
3078   if (saw_a_doc_ref)
3079     Vload_force_doc_string_list = Fcons (stuff, Vload_force_doc_string_list);
3080   UNGCPRO;
3081   return stuff;
3082 }
3083
3084
3085 \f
3086 void
3087 init_lread (void)
3088 {
3089   Vvalues = Qnil;
3090
3091   load_in_progress = 0;
3092
3093   Vload_descriptor_list = Qnil;
3094
3095   /* kludge: locate-file does not work for a null load-path, even if
3096      the file name is absolute. */
3097
3098   Vload_path = Fcons (build_string (""), Qnil);
3099
3100   /* This used to get initialized in init_lread because all streams
3101      got closed when dumping occurs.  This is no longer true --
3102      Vread_buffer_stream is a resizing output stream, and there is no
3103      reason to close it at dump-time.
3104
3105      Vread_buffer_stream is set to Qnil in vars_of_lread, and this
3106      will initialize it only once, at dump-time.  */
3107   if (NILP (Vread_buffer_stream))
3108     Vread_buffer_stream = make_resizing_buffer_output_stream ();
3109
3110   Vload_force_doc_string_list = Qnil;
3111 }
3112
3113 void
3114 syms_of_lread (void)
3115 {
3116   DEFSUBR (Fread);
3117   DEFSUBR (Fread_from_string);
3118   DEFSUBR (Fload_internal);
3119   DEFSUBR (Flocate_file);
3120   DEFSUBR (Flocate_file_clear_hashing);
3121   DEFSUBR (Feval_buffer);
3122   DEFSUBR (Feval_region);
3123
3124   defsymbol (&Qstandard_input, "standard-input");
3125   defsymbol (&Qread_char, "read-char");
3126   defsymbol (&Qcurrent_load_list, "current-load-list");
3127   defsymbol (&Qload, "load");
3128   defsymbol (&Qload_file_name, "load-file-name");
3129   defsymbol (&Qfset, "fset");
3130
3131 #ifdef LISP_BACKQUOTES
3132   defsymbol (&Qbackquote, "backquote");
3133   defsymbol (&Qbacktick, "`");
3134   defsymbol (&Qcomma, ",");
3135   defsymbol (&Qcomma_at, ",@");
3136   defsymbol (&Qcomma_dot, ",.");
3137 #endif
3138
3139   defsymbol (&Qexists, "exists");
3140   defsymbol (&Qreadable, "readable");
3141   defsymbol (&Qwritable, "writable");
3142   defsymbol (&Qexecutable, "executable");
3143 }
3144
3145 void
3146 structure_type_create (void)
3147 {
3148   the_structure_type_dynarr = Dynarr_new (structure_type);
3149 }
3150
3151 void
3152 vars_of_lread (void)
3153 {
3154   DEFVAR_LISP ("values", &Vvalues /*
3155 List of values of all expressions which were read, evaluated and printed.
3156 Order is reverse chronological.
3157 */ );
3158
3159   DEFVAR_LISP ("standard-input", &Vstandard_input /*
3160 Stream for read to get input from.
3161 See documentation of `read' for possible values.
3162 */ );
3163   Vstandard_input = Qt;
3164
3165   DEFVAR_LISP ("load-path", &Vload_path /*
3166 *List of directories to search for files to load.
3167 Each element is a string (directory name) or nil (try default directory).
3168
3169 Note that the elements of this list *may not* begin with "~", so you must
3170 call `expand-file-name' on them before adding them to this list.
3171
3172 Initialized based on EMACSLOADPATH environment variable, if any,
3173 otherwise to default specified in by file `paths.h' when XEmacs was built.
3174 If there were no paths specified in `paths.h', then XEmacs chooses a default
3175 value for this variable by looking around in the file-system near the
3176 directory in which the XEmacs executable resides.
3177 */ );
3178   Vload_path = Qnil;
3179
3180 /*  xxxDEFVAR_LISP ("dump-load-path", &Vdump_load_path,
3181     "*Location of lisp files to be used when dumping ONLY."); */
3182
3183   DEFVAR_BOOL ("load-in-progress", &load_in_progress /*
3184 Non-nil iff inside of `load'.
3185 */ );
3186
3187   DEFVAR_LISP ("after-load-alist", &Vafter_load_alist /*
3188 An alist of expressions to be evalled when particular files are loaded.
3189 Each element looks like (FILENAME FORMS...).
3190 When `load' is run and the file-name argument is FILENAME,
3191 the FORMS in the corresponding element are executed at the end of loading.
3192
3193 FILENAME must match exactly!  Normally FILENAME is the name of a library,
3194 with no directory specified, since that is how `load' is normally called.
3195 An error in FORMS does not undo the load,
3196 but does prevent execution of the rest of the FORMS.
3197 */ );
3198   Vafter_load_alist = Qnil;
3199
3200   DEFVAR_BOOL ("load-warn-when-source-newer", &load_warn_when_source_newer /*
3201 *Whether `load' should check whether the source is newer than the binary.
3202 If this variable is true, then when a `.elc' file is being loaded and the
3203 corresponding `.el' is newer, a warning message will be printed.
3204 */ );
3205   load_warn_when_source_newer = 0;
3206
3207   DEFVAR_BOOL ("load-warn-when-source-only", &load_warn_when_source_only /*
3208 *Whether `load' should warn when loading a `.el' file instead of an `.elc'.
3209 If this variable is true, then when `load' is called with a filename without
3210 an extension, and the `.elc' version doesn't exist but the `.el' version does,
3211 then a message will be printed.  If an explicit extension is passed to `load',
3212 no warning will be printed.
3213 */ );
3214   load_warn_when_source_only = 0;
3215
3216   DEFVAR_BOOL ("load-ignore-elc-files", &load_ignore_elc_files /*
3217 *Whether `load' should ignore `.elc' files when a suffix is not given.
3218 This is normally used only to bootstrap the `.elc' files when building XEmacs.
3219 */ );
3220   load_ignore_elc_files = 0;
3221
3222 #ifdef LOADHIST
3223   DEFVAR_LISP ("load-history", &Vload_history /*
3224 Alist mapping source file names to symbols and features.
3225 Each alist element is a list that starts with a file name,
3226 except for one element (optional) that starts with nil and describes
3227 definitions evaluated from buffers not visiting files.
3228 The remaining elements of each list are symbols defined as functions
3229 or variables, and cons cells `(provide . FEATURE)' and `(require . FEATURE)'.
3230 */ );
3231   Vload_history = Qnil;
3232
3233   DEFVAR_LISP ("current-load-list", &Vcurrent_load_list /*
3234 Used for internal purposes by `load'.
3235 */ );
3236   Vcurrent_load_list = Qnil;
3237 #endif
3238
3239   DEFVAR_LISP ("load-file-name", &Vload_file_name /*
3240 Full name of file being loaded by `load'.
3241 */ );
3242   Vload_file_name = Qnil;
3243
3244   DEFVAR_LISP ("load-read-function", &Vload_read_function /*
3245 Function used by `load' and `eval-region' for reading expressions.
3246 The default is nil, which means use the function `read'.
3247 */ );
3248   Vload_read_function = Qnil;
3249
3250   DEFVAR_BOOL ("load-force-doc-strings", &load_force_doc_strings /*
3251 Non-nil means `load' should force-load all dynamic doc strings.
3252 This is useful when the file being loaded is a temporary copy.
3253 */ );
3254   load_force_doc_strings = 0;
3255
3256   /* See read_escape().  */
3257 #if 0
3258   /* Used to be named `puke-on-fsf-keys' */
3259   DEFVAR_BOOL ("fail-on-bucky-bit-character-escapes",
3260                &fail_on_bucky_bit_character_escapes /*
3261 Whether `read' should signal an error when it encounters unsupported
3262 character escape syntaxes or just read them incorrectly.
3263 */ );
3264   fail_on_bucky_bit_character_escapes = 0;
3265 #endif
3266
3267   /* This must be initialized in init_lread otherwise it may start out
3268      with values saved when the image is dumped. */
3269   staticpro (&Vload_descriptor_list);
3270
3271   Vread_buffer_stream = Qnil;
3272   staticpro (&Vread_buffer_stream);
3273
3274   /* Initialized in init_lread. */
3275   staticpro (&Vload_force_doc_string_list);
3276
3277   Vload_file_name_internal = Qnil;
3278   staticpro (&Vload_file_name_internal);
3279
3280   Vload_file_name_internal_the_purecopy = Qnil;
3281   staticpro (&Vload_file_name_internal_the_purecopy);
3282
3283 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
3284   Vcurrent_compiled_function_annotation = Qnil;
3285   staticpro (&Vcurrent_compiled_function_annotation);
3286 #endif
3287
3288   /* So that early-early stuff will work */
3289   Ffset (Qload, intern ("load-internal"));
3290
3291 #ifdef FEATUREP_SYNTAX
3292   defsymbol (&Qfeaturep, "featurep");
3293   Fprovide(intern("xemacs"));
3294 #ifdef INFODOCK
3295   Fprovide(intern("infodock"));
3296 #endif /* INFODOCK */
3297 #endif /* FEATUREP_SYNTAX */
3298
3299 #ifdef LISP_BACKQUOTES
3300   old_backquote_flag = new_backquote_flag = 0;
3301 #endif
3302
3303 #ifdef I18N3
3304   Vfile_domain = Qnil;
3305 #endif
3306
3307   Vread_objects = Qnil;
3308   staticpro (&Vread_objects);
3309
3310   Vlocate_file_hash_table = make_lisp_hash_table (200,
3311                                                   HASH_TABLE_NON_WEAK,
3312                                                   HASH_TABLE_EQUAL);
3313   staticpro (&Vlocate_file_hash_table);
3314 #ifdef DEBUG_XEMACS
3315   symbol_value (XSYMBOL (intern ("Vlocate-file-hash-table")))
3316     = Vlocate_file_hash_table;
3317 #endif
3318 }