comparison src/doc.c @ 814:a634e3b7acc8

[xemacs-hg @ 2002-04-14 12:41:59 by ben] latest changes TODO.ben-mule-21-5: Update. make-docfile.c: Add basic support for handling ISO 2022 doc strings -- we parse the basic charset designation sequences so we know whether we're in ASCII and have to pay attention to end quotes and such. Reformat code according to coding standards. abbrev.el: Add `global-abbrev-mode', which turns on or off abbrev-mode in all buffers. Added `defining-abbrev-turns-on-abbrev-mode' -- if non-nil, defining an abbrev through an interactive function will automatically turn on abbrev-mode, either globally or locally depending on the command. This is the "what you'd expect" behavior. indent.el: general function for indenting a balanced expression in a mode-correct way. Works similar to indent-region in that a mode can specify a specific command to do the whole operation; if not, figure out the region using forward-sexp and indent each line using indent-according-to-mode. keydefs.el: Removed. Modify M-C-backslash to do indent-region-or-balanced-expression. Make S-Tab just insert a TAB char, like it's meant to do. make-docfile.el: Now that we're using the call-process-in-lisp, we need to load an extra file win32-native.el because we're running a bare temacs. menubar-items.el: Totally redo the Cmds menu so that most used commands appear directly on the menu and less used commands appear in submenus. The old way may have been very pretty, but rather impractical. process.el: Under Windows, don't ever use old-call-process-internal, even in batch mode. We can do processes in batch mode. subr.el: Someone recoded truncate-string-to-width, saying "the FSF version is too complicated and does lots of hard-to-understand stuff" but the resulting recoded version was *totally* wrong! it misunderstood the basic point of this function, which is work in *columns* not chars. i dumped ours and copied the version from FSF 21.1. Also added truncate-string-with-continuation-dots, since this idiom is used often. config.inc.samp, xemacs.mak: Separate out debug and optimize flags. Remove all vestiges of USE_MINIMAL_TAGBITS, USE_INDEXED_LRECORD_IMPLEMENTATION, and GUNG_HO, since those ifdefs have long been removed. Make error-checking support actually work. Some rearrangement of config.inc.samp to make it more logical. Remove callproc.c and ntproc.c from xemacs.mak, no longer used. Make pdump the default. lisp.h: Add support for strong type-checking of Bytecount, Bytebpos, Charcount, Charbpos, and others, by making them classes, overloading the operators to provide integer-like operation and carefully controlling what operations are allowed. Not currently enabled in C++ builds because there are still a number of compile errors, and it won't really work till we merge in my "8-bit-Mule" workspace, in which I make use of the new types Charxpos, Bytexpos, Memxpos, representing a "position" either in a buffer or a string. (This is especially important in the extent code.) abbrev.c, alloc.c, eval.c, buffer.c, buffer.h, editfns.c, fns.c, text.h: Warning fixes, some of them related to new C++ strict type checking of Bytecount, Charbpos, etc. dired.c: Caught an actual error due to strong type checking -- char len being passed when should be byte len. alloc.c, backtrace.h, bytecode.c, bytecode.h, eval.c, sysdep.c: Further optimize Ffuncall: -- process arg list at compiled-function creation time, converting into an array for extra-quick access at funcall time. -- rewrite funcall_compiled_function to use it, and inline this function. -- change the order of check for magic stuff in SPECBIND_FAST_UNSAFE to be faster. -- move the check for need to garbage collect into the allocation code, so only a single flag needs to be checked in funcall. buffer.c, symbols.c: add debug funs to check on mule optimization info in buffers and strings. eval.c, emacs.c, text.c, regex.c, scrollbar-msw.c, search.c: Fix evil crashes due to eistrings not properly reinitialized under pdump. Redo a bit some of the init routines; convert some complex_vars_of() into simple vars_of(), because they didn't need complex processing. callproc.c, emacs.c, event-stream.c, nt.c, process.c, process.h, sysdep.c, sysdep.h, syssignal.h, syswindows.h, ntproc.c: Delete. Hallelujah, praise the Lord, there is no god but Allah!!! fix so that processes can be invoked in bare temacs -- thereby eliminating any need for callproc.c. (currently only eliminated under NT.) remove all crufty and unnecessary old process code in ntproc.c and elsewhere. move non-callproc-specific stuff (mostly environment) into process.c, so callproc.c can be left out under NT. console-tty.c, doc.c, file-coding.c, file-coding.h, lstream.c, lstream.h: fix doc string handling so it works with Japanese, etc docs. change handling of "character mode" so callers don't have to manually set it (quite error-prone). event-msw.c: spacing fixes. lread.c: eliminate unused crufty vintage-19 "FSF defun hack" code. lrecord.h: improve pdump description docs. buffer.c, ntheap.c, unexnt.c, win32.c, emacs.c: Mule-ize some unexec and startup code. It was pseudo-Mule-ized before by simply always calling the ...A versions of functions, but that won't cut it -- eventually we want to be able to run properly even if XEmacs has been installed in a Japanese directory. (The current problem is the timing of the loading of the Unicode tables; this will eventually be fixed.) Go through and fix various other places where the code was not Mule-clean. Provide a function mswindows_get_module_file_name() to get our own name without resort to PATH_MAX and such. Add a big comment in main() about the problem with Unicode table load timing that I just alluded to. emacs.c: When error-checking is enabled (interpreted as "user is developing XEmacs"), don't ask user to "pause to read messages" when a fatal error has occurred, because it will wedge if we are in an inner modal loop (typically when a menu is popped up) and make us unable to get a useful stack trace in the debugger. text.c: Correct update_entirely_ascii_p_flag to actually work. lisp.h, symsinit.h: declarations for above changes.
author ben
date Sun, 14 Apr 2002 12:43:31 +0000
parents e38acbeb1cae
children 6728e641994e
comparison
equal deleted inserted replaced
813:9541922fb765 814:a634e3b7acc8
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */ 21 Boston, MA 02111-1307, USA. */
22 22
23 /* Synched up with: FSF 19.30. */ 23 /* Synched up with: FSF 19.30. */
24 24
25 /* This file has been Mule-ized except as noted. */ 25 /* This file has been Mule-ized. */
26 26
27 #include <config.h> 27 #include <config.h>
28 #include "lisp.h" 28 #include "lisp.h"
29 29
30 #include "buffer.h" 30 #include "buffer.h"
31 #include "bytecode.h" 31 #include "bytecode.h"
32 #include "file-coding.h"
32 #include "insdel.h" 33 #include "insdel.h"
33 #include "keymap.h" 34 #include "keymap.h"
35 #include "lstream.h"
34 #include "sysfile.h" 36 #include "sysfile.h"
35 37
36 Lisp_Object Vinternal_doc_file_name; 38 Lisp_Object Vinternal_doc_file_name;
37 39
38 Lisp_Object QSsubstitute; 40 Lisp_Object QSsubstitute;
39 41
40 /* Read and return doc string from open file descriptor FD 42 /* Read and return doc string or instructions from open file descriptor FD
41 at position POSITION. Does not close the file. Returns 43 at position POSITION. Does not close the file. Returns string; or if
42 string; or if error, returns a cons holding the error 44 error, returns a cons holding the error data to pass to Fsignal.
43 data to pass to Fsignal. NAME_NONRELOC and NAME_RELOC 45 NAME_NONRELOC and NAME_RELOC are only used for the error messages. */
44 are only used for the error messages. */
45 46
46 Lisp_Object 47 Lisp_Object
47 unparesseuxify_doc_string (int fd, EMACS_INT position, 48 unparesseuxify_doc_string (int fd, EMACS_INT position,
48 Intbyte *name_nonreloc, Lisp_Object name_reloc) 49 Intbyte *name_nonreloc, Lisp_Object name_reloc,
50 int standard_doc_file)
49 { 51 {
50 Intbyte buf[512 * 32 + 1]; 52 Intbyte buf[512 * 32 + 1];
51 Intbyte *buffer = buf; 53 Intbyte *buffer = buf;
52 int buffer_size = sizeof (buf); 54 int buffer_size = sizeof (buf);
53 Intbyte *from, *to; 55 Intbyte *from, *to;
54 REGISTER Intbyte *p = buffer; 56 REGISTER Intbyte *p = buffer;
55 Lisp_Object return_me; 57 Lisp_Object return_me;
58 Lisp_Object fdstream = Qnil, instream = Qnil;
59 struct gcpro gcpro1, gcpro2;
60
61 GCPRO2 (fdstream, instream);
56 62
57 if (0 > lseek (fd, position, 0)) 63 if (0 > lseek (fd, position, 0))
58 { 64 {
59 if (name_nonreloc) 65 if (name_nonreloc)
60 name_reloc = build_intstring (name_nonreloc); 66 name_reloc = build_intstring (name_nonreloc);
62 ("Position out of range in doc string file"), 68 ("Position out of range in doc string file"),
63 name_reloc, make_int (position)); 69 name_reloc, make_int (position));
64 goto done; 70 goto done;
65 } 71 }
66 72
73 fdstream = make_filedesc_input_stream (fd, 0, -1, 0);
74 Lstream_set_buffering (XLSTREAM (fdstream), LSTREAM_UNBUFFERED, 0);
75 instream =
76 make_coding_input_stream
77 /* Major trouble if we are too clever when reading byte-code
78 instructions!
79
80 #### We should have a way of handling escape-quoted elc files
81 (i.e. files with non-ASCII/Latin-1 chars in them). Currently this
82 is "solved" in bytecomp.el by never inserting lazy references in
83 such files. */
84 (XLSTREAM (fdstream), standard_doc_file ? Qundecided : Qbinary,
85 CODING_DECODE, 0);
86 Lstream_set_buffering (XLSTREAM (instream), LSTREAM_UNBUFFERED, 0);
87
67 /* Read the doc string into a buffer. 88 /* Read the doc string into a buffer.
68 Use the fixed buffer BUF if it is big enough; otherwise allocate one. 89 Use the fixed buffer BUF if it is big enough; otherwise allocate one.
69 We store the buffer in use in BUFFER and its size in BUFFER_SIZE. */ 90 We store the buffer in use in BUFFER and its size in BUFFER_SIZE. */
70 91
71 while (1) 92 while (1)
89 } 110 }
90 111
91 /* Don't read too much at one go. */ 112 /* Don't read too much at one go. */
92 if (space_left > 1024 * 8) 113 if (space_left > 1024 * 8)
93 space_left = 1024 * 8; 114 space_left = 1024 * 8;
94 nread = retry_read (fd, p, space_left); 115 nread = Lstream_read (XLSTREAM (instream), p, space_left);
95 if (nread < 0) 116 if (nread < 0)
96 { 117 {
97 return_me = list1 (build_msg_string 118 return_me = list1 (build_msg_string
98 ("Read error on documentation file")); 119 ("Read error on documentation file"));
99 goto done; 120 goto done;
100 } 121 }
101 p[nread] = 0; 122 p[nread] = 0;
102 if (!nread) 123 if (!nread)
103 break; 124 break;
104 { 125 {
105 Intbyte *p1 = qxestrchr (p, '\037'); /* End of doc string marker */ 126 Intbyte *p1 = qxestrchr (p, '\037'); /* End of doc string marker */
106 if (p1) 127 if (p1)
107 { 128 {
108 *p1 = 0; 129 *p1 = 0;
109 p = p1; 130 p = p1;
110 break; 131 break;
111 } 132 }
112 } 133 }
113 p += nread; 134 p += nread;
114 } 135 }
115 136
116 /* Scan the text and remove quoting with ^A (char code 1). 137 /* Scan the text and remove quoting with ^A (char code 1).
137 goto done; 158 goto done;
138 } 159 }
139 } 160 }
140 } 161 }
141 162
142 /* !!#### mrb: following STILL completely broken */ 163 return_me = make_string (buffer, to - buffer);
143 return_me = make_ext_string ((Extbyte *) buffer, to - buffer, Qbinary);
144 164
145 done: 165 done:
166 if (!NILP (instream))
167 {
168 Lstream_delete (XLSTREAM (instream));
169 Lstream_delete (XLSTREAM (fdstream));
170 }
171 UNGCPRO;
146 if (buffer != buf) /* We must have allocated buffer above */ 172 if (buffer != buf) /* We must have allocated buffer above */
147 xfree (buffer); 173 xfree (buffer);
148 return return_me; 174 return return_me;
149 } 175 }
150 176
170 REGISTER int fd; 196 REGISTER int fd;
171 REGISTER Intbyte *name_nonreloc = 0; 197 REGISTER Intbyte *name_nonreloc = 0;
172 EMACS_INT position; 198 EMACS_INT position;
173 Lisp_Object file, tem; 199 Lisp_Object file, tem;
174 Lisp_Object name_reloc = Qnil; 200 Lisp_Object name_reloc = Qnil;
201 int standard_doc_file = 0;
175 202
176 if (INTP (filepos)) 203 if (INTP (filepos))
177 { 204 {
178 file = Vinternal_doc_file_name; 205 file = Vinternal_doc_file_name;
206 standard_doc_file = 1;
179 position = XINT (filepos); 207 position = XINT (filepos);
180 } 208 }
181 else if (CONSP (filepos) && INTP (XCDR (filepos))) 209 else if (CONSP (filepos) && INTP (XCDR (filepos)))
182 { 210 {
183 file = XCAR (filepos); 211 file = XCAR (filepos);
230 fd = qxe_open (name_nonreloc, O_RDONLY | OPEN_BINARY, 0); 258 fd = qxe_open (name_nonreloc, O_RDONLY | OPEN_BINARY, 0);
231 } 259 }
232 #endif /* CANNOT_DUMP */ 260 #endif /* CANNOT_DUMP */
233 261
234 if (fd < 0) 262 if (fd < 0)
235 signal_error (Qfile_error, "Cannot open doc string file", 263 report_file_error ("Cannot open doc string file",
236 name_nonreloc ? build_intstring (name_nonreloc) : 264 name_nonreloc ? build_intstring (name_nonreloc) :
237 name_reloc); 265 name_reloc);
238 } 266 }
239 267
240 tem = unparesseuxify_doc_string (fd, position, name_nonreloc, name_reloc); 268 tem = unparesseuxify_doc_string (fd, position, name_nonreloc, name_reloc,
269 standard_doc_file);
241 retry_close (fd); 270 retry_close (fd);
242 271
243 if (!STRINGP (tem)) 272 if (!STRINGP (tem))
244 signal_error_1 (Qinvalid_byte_code, tem); 273 signal_error_1 (Qinvalid_byte_code, tem);
245 274
399 if (!strcmp (weirdness, GETTEXT ("duplicate"))) return; 428 if (!strcmp (weirdness, GETTEXT ("duplicate"))) return;
400 message ("Note: Strange doc (%s) for %s %s @ %d", 429 message ("Note: Strange doc (%s) for %s %s @ %d",
401 weirdness, type, XSTRING_DATA (XSYMBOL (sym)->name), pos); 430 weirdness, type, XSTRING_DATA (XSYMBOL (sym)->name), pos);
402 } 431 }
403 432
404
405 DEFUN ("Snarf-documentation", Fsnarf_documentation, 1, 1, 0, /* 433 DEFUN ("Snarf-documentation", Fsnarf_documentation, 1, 1, 0, /*
406 Used during Emacs initialization, before dumping runnable Emacs, 434 Used during Emacs initialization, before dumping runnable Emacs,
407 to find pointers to doc strings stored in `.../lib-src/DOC' and 435 to find pointers to doc strings stored in `.../lib-src/DOC' and
408 record them in function definitions. 436 record them in function definitions.
409 One arg, FILENAME, a string which does not include a directory. 437 One arg, FILENAME, a string which does not include a directory.
418 REGISTER int pos; 446 REGISTER int pos;
419 REGISTER Intbyte *p, *end; 447 REGISTER Intbyte *p, *end;
420 Lisp_Object sym, fun, tem; 448 Lisp_Object sym, fun, tem;
421 Intbyte *name; 449 Intbyte *name;
422 450
451 /* This function should not pass the data it's reading through a coding
452 stream. The reason is that the only purpose of this function is to
453 find the file offsets for the documentation of the various functions,
454 not do anything with the documentation itself. If we pass through a
455 coding stream, the pointers will get messed up when we start reading
456 ISO 2022 data because our pointers will reflect internal format, not
457 external format. */
458
423 #ifndef CANNOT_DUMP 459 #ifndef CANNOT_DUMP
424 if (!purify_flag) 460 if (!purify_flag)
425 invalid_operation ("Snarf-documentation can only be called in an undumped Emacs", Qunbound); 461 invalid_operation ("Snarf-documentation can only be called in an undumped Emacs", Qunbound);
426 #endif 462 #endif
427 463
648 } 684 }
649 retry_close (fd); 685 retry_close (fd);
650 return Qnil; 686 return Qnil;
651 } 687 }
652 688
653
654 #if 1 /* Don't warn about functions whose doc was lost because they were 689 #if 1 /* Don't warn about functions whose doc was lost because they were
655 wrapped by advice-freeze.el... */ 690 wrapped by advice-freeze.el... */
656 static int 691 static int
657 kludgily_ignore_lost_doc_p (Lisp_Object sym) 692 kludgily_ignore_lost_doc_p (Lisp_Object sym)
658 { 693 {