|
428
|
1 /* Record indices of function doc strings stored in a file.
|
|
|
2 Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995
|
|
|
3 Free Software Foundation, Inc.
|
|
2367
|
4 Copyright (C) 2001, 2002, 2004 Ben Wing.
|
|
428
|
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: FSF 19.30. */
|
|
|
24
|
|
814
|
25 /* This file has been Mule-ized. */
|
|
428
|
26
|
|
|
27 #include <config.h>
|
|
|
28 #include "lisp.h"
|
|
|
29
|
|
|
30 #include "buffer.h"
|
|
|
31 #include "bytecode.h"
|
|
814
|
32 #include "file-coding.h"
|
|
428
|
33 #include "insdel.h"
|
|
|
34 #include "keymap.h"
|
|
814
|
35 #include "lstream.h"
|
|
428
|
36 #include "sysfile.h"
|
|
|
37
|
|
|
38 Lisp_Object Vinternal_doc_file_name;
|
|
|
39
|
|
|
40 Lisp_Object QSsubstitute;
|
|
|
41
|
|
3368
|
42 /* Work out what source file a function or variable came from, taking the
|
|
|
43 information from the documentation file. */
|
|
|
44
|
|
|
45 static Lisp_Object
|
|
|
46 extract_object_file_name (int fd, EMACS_INT doc_pos,
|
|
|
47 Ibyte *name_nonreloc, Lisp_Object name_reloc,
|
|
|
48 int standard_doc_file)
|
|
|
49 {
|
|
3383
|
50 Ibyte buf[DOC_MAX_FILENAME_LENGTH+1];
|
|
3368
|
51 Ibyte *buffer = buf;
|
|
3411
|
52 int buffer_size = sizeof (buf) - 1, space_left;
|
|
3368
|
53 Ibyte *from, *to;
|
|
|
54 REGISTER Ibyte *p = buffer;
|
|
|
55 Lisp_Object return_me;
|
|
|
56 Lisp_Object fdstream = Qnil, instream = Qnil;
|
|
|
57 struct gcpro gcpro1, gcpro2;
|
|
|
58 EMACS_INT position, seenS = 0;
|
|
|
59
|
|
|
60 GCPRO2 (fdstream, instream);
|
|
|
61
|
|
3411
|
62 position = doc_pos > buffer_size ?
|
|
|
63 doc_pos - buffer_size : 0;
|
|
3368
|
64
|
|
|
65 if (0 > lseek (fd, position, 0))
|
|
|
66 {
|
|
|
67 if (name_nonreloc)
|
|
|
68 name_reloc = build_intstring (name_nonreloc);
|
|
|
69 return_me = list3 (build_msg_string
|
|
|
70 ("Position out of range in doc string file"),
|
|
|
71 name_reloc, make_int (position));
|
|
|
72 goto done;
|
|
|
73 }
|
|
|
74
|
|
|
75 fdstream = make_filedesc_input_stream (fd, 0, -1, 0);
|
|
|
76 Lstream_set_buffering (XLSTREAM (fdstream), LSTREAM_UNBUFFERED, 0);
|
|
|
77 instream =
|
|
|
78 make_coding_input_stream
|
|
|
79 (XLSTREAM (fdstream), standard_doc_file ? Qescape_quoted : Qbinary,
|
|
|
80 CODING_DECODE, 0);
|
|
|
81 Lstream_set_buffering (XLSTREAM (instream), LSTREAM_UNBUFFERED, 0);
|
|
|
82
|
|
|
83 space_left = buffer_size - (p - buffer);
|
|
|
84 while (space_left > 0)
|
|
|
85 {
|
|
|
86 int nread;
|
|
|
87
|
|
|
88 nread = Lstream_read (XLSTREAM (instream), p, space_left);
|
|
|
89 if (nread < 0)
|
|
|
90 {
|
|
|
91 return_me = list1 (build_msg_string
|
|
|
92 ("Read error on documentation file"));
|
|
|
93 goto done;
|
|
|
94 }
|
|
|
95
|
|
|
96 p[nread] = 0;
|
|
|
97
|
|
|
98 if (!nread)
|
|
|
99 break;
|
|
|
100
|
|
|
101 p += nread;
|
|
|
102 space_left = buffer_size - (p - buffer);
|
|
|
103 }
|
|
|
104
|
|
|
105 /* First, search backward for the "\037S" that marks the beginning of the
|
|
|
106 file name, then search forward from that to the newline or to the end
|
|
|
107 of the buffer. */
|
|
|
108 from = p;
|
|
|
109
|
|
|
110 while (from > buf)
|
|
|
111 {
|
|
|
112 --from;
|
|
|
113 if (seenS)
|
|
|
114 {
|
|
|
115 if ('\037' == *from)
|
|
|
116 {
|
|
|
117 /* Got a file name; adjust `from' to point to it, break out of
|
|
|
118 the loop. */
|
|
|
119 from += 2;
|
|
|
120 break;
|
|
|
121 }
|
|
|
122 }
|
|
|
123 /* Is *from 'S' ? */
|
|
|
124 seenS = ('S' == *from);
|
|
|
125 }
|
|
|
126
|
|
|
127 if (buf == from)
|
|
|
128 {
|
|
|
129 /* We've scanned back to the beginning of the buffer without hitting
|
|
|
130 the file name. Either the file name plus the symbol name is longer
|
|
|
131 than DOC_MAX_FILENAME_LENGTH--which shouldn't happen, because it'll
|
|
|
132 trigger an assertion failure in make-docfile, the DOC file is
|
|
|
133 corrupt, or it was produced by a version of make-docfile that
|
|
|
134 doesn't store the file name with the symbol name and docstring. */
|
|
|
135 return_me = list1 (build_msg_string
|
|
|
136 ("Object file name not stored in doc file"));
|
|
|
137 goto done;
|
|
|
138 }
|
|
|
139
|
|
|
140 to = from;
|
|
|
141 /* Search for the end of the file name. */
|
|
|
142 while (++to < p)
|
|
|
143 {
|
|
|
144 if ('\n' == *to || '\037' == *to)
|
|
|
145 {
|
|
|
146 break;
|
|
|
147 }
|
|
|
148 }
|
|
|
149
|
|
|
150 /* Don't require the file name to end in a newline. */
|
|
|
151 return_me = make_string (from, to - from);
|
|
|
152
|
|
|
153 done:
|
|
|
154 if (!NILP (instream))
|
|
|
155 {
|
|
|
156 Lstream_delete (XLSTREAM (instream));
|
|
|
157 Lstream_delete (XLSTREAM (fdstream));
|
|
|
158 }
|
|
|
159
|
|
|
160 UNGCPRO;
|
|
|
161 return return_me;
|
|
|
162 }
|
|
428
|
163
|
|
|
164 Lisp_Object
|
|
|
165 unparesseuxify_doc_string (int fd, EMACS_INT position,
|
|
867
|
166 Ibyte *name_nonreloc, Lisp_Object name_reloc,
|
|
814
|
167 int standard_doc_file)
|
|
428
|
168 {
|
|
867
|
169 Ibyte buf[512 * 32 + 1];
|
|
|
170 Ibyte *buffer = buf;
|
|
3411
|
171 int buffer_size = sizeof (buf) - 1;
|
|
867
|
172 Ibyte *from, *to;
|
|
|
173 REGISTER Ibyte *p = buffer;
|
|
428
|
174 Lisp_Object return_me;
|
|
814
|
175 Lisp_Object fdstream = Qnil, instream = Qnil;
|
|
|
176 struct gcpro gcpro1, gcpro2;
|
|
|
177
|
|
|
178 GCPRO2 (fdstream, instream);
|
|
428
|
179
|
|
|
180 if (0 > lseek (fd, position, 0))
|
|
|
181 {
|
|
|
182 if (name_nonreloc)
|
|
771
|
183 name_reloc = build_intstring (name_nonreloc);
|
|
|
184 return_me = list3 (build_msg_string
|
|
428
|
185 ("Position out of range in doc string file"),
|
|
|
186 name_reloc, make_int (position));
|
|
|
187 goto done;
|
|
|
188 }
|
|
|
189
|
|
814
|
190 fdstream = make_filedesc_input_stream (fd, 0, -1, 0);
|
|
|
191 Lstream_set_buffering (XLSTREAM (fdstream), LSTREAM_UNBUFFERED, 0);
|
|
|
192 instream =
|
|
|
193 make_coding_input_stream
|
|
|
194 /* Major trouble if we are too clever when reading byte-code
|
|
|
195 instructions!
|
|
|
196
|
|
|
197 #### We should have a way of handling escape-quoted elc files
|
|
|
198 (i.e. files with non-ASCII/Latin-1 chars in them). Currently this
|
|
|
199 is "solved" in bytecomp.el by never inserting lazy references in
|
|
|
200 such files. */
|
|
826
|
201 (XLSTREAM (fdstream), standard_doc_file ? Qescape_quoted : Qbinary,
|
|
814
|
202 CODING_DECODE, 0);
|
|
|
203 Lstream_set_buffering (XLSTREAM (instream), LSTREAM_UNBUFFERED, 0);
|
|
|
204
|
|
428
|
205 /* Read the doc string into a buffer.
|
|
|
206 Use the fixed buffer BUF if it is big enough; otherwise allocate one.
|
|
|
207 We store the buffer in use in BUFFER and its size in BUFFER_SIZE. */
|
|
|
208
|
|
|
209 while (1)
|
|
|
210 {
|
|
|
211 int space_left = buffer_size - (p - buffer);
|
|
|
212 int nread;
|
|
|
213
|
|
|
214 /* Switch to a bigger buffer if we need one. */
|
|
|
215 if (space_left == 0)
|
|
|
216 {
|
|
867
|
217 Ibyte *old_buffer = buffer;
|
|
3411
|
218 buffer_size *= 2;
|
|
|
219
|
|
771
|
220 if (buffer == buf)
|
|
|
221 {
|
|
3411
|
222 buffer = xnew_ibytes (buffer_size + 1);
|
|
771
|
223 memcpy (buffer, old_buffer, p - old_buffer);
|
|
|
224 }
|
|
|
225 else
|
|
3411
|
226 XREALLOC_ARRAY (buffer, Ibyte, buffer_size + 1);
|
|
428
|
227 p += buffer - old_buffer;
|
|
|
228 space_left = buffer_size - (p - buffer);
|
|
|
229 }
|
|
|
230
|
|
|
231 /* Don't read too much at one go. */
|
|
|
232 if (space_left > 1024 * 8)
|
|
|
233 space_left = 1024 * 8;
|
|
814
|
234 nread = Lstream_read (XLSTREAM (instream), p, space_left);
|
|
428
|
235 if (nread < 0)
|
|
|
236 {
|
|
771
|
237 return_me = list1 (build_msg_string
|
|
428
|
238 ("Read error on documentation file"));
|
|
|
239 goto done;
|
|
|
240 }
|
|
|
241 p[nread] = 0;
|
|
|
242 if (!nread)
|
|
|
243 break;
|
|
|
244 {
|
|
867
|
245 Ibyte *p1 = qxestrchr (p, '\037'); /* End of doc string marker */
|
|
814
|
246 if (p1)
|
|
|
247 {
|
|
|
248 *p1 = 0;
|
|
|
249 p = p1;
|
|
|
250 break;
|
|
|
251 }
|
|
428
|
252 }
|
|
|
253 p += nread;
|
|
|
254 }
|
|
|
255
|
|
|
256 /* Scan the text and remove quoting with ^A (char code 1).
|
|
|
257 ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_. */
|
|
|
258 from = to = buffer;
|
|
|
259 while (from < p)
|
|
|
260 {
|
|
|
261 if (*from != 1 /*^A*/)
|
|
|
262 *to++ = *from++;
|
|
|
263 else
|
|
|
264 {
|
|
|
265 int c = *(++from);
|
|
|
266
|
|
|
267 from++;
|
|
|
268 switch (c)
|
|
|
269 {
|
|
|
270 case 1: *to++ = c; break;
|
|
|
271 case '0': *to++ = '\0'; break;
|
|
|
272 case '_': *to++ = '\037'; break;
|
|
|
273 default:
|
|
771
|
274 return_me = list2 (build_msg_string
|
|
428
|
275 ("Invalid data in documentation file -- ^A followed by weird code"),
|
|
|
276 make_int (c));
|
|
|
277 goto done;
|
|
|
278 }
|
|
|
279 }
|
|
|
280 }
|
|
|
281
|
|
814
|
282 return_me = make_string (buffer, to - buffer);
|
|
428
|
283
|
|
|
284 done:
|
|
814
|
285 if (!NILP (instream))
|
|
|
286 {
|
|
|
287 Lstream_delete (XLSTREAM (instream));
|
|
|
288 Lstream_delete (XLSTREAM (fdstream));
|
|
|
289 }
|
|
|
290 UNGCPRO;
|
|
428
|
291 if (buffer != buf) /* We must have allocated buffer above */
|
|
1726
|
292 xfree (buffer, Ibyte *);
|
|
428
|
293 return return_me;
|
|
|
294 }
|
|
|
295
|
|
771
|
296 #define string_join(dest, s1, s2) \
|
|
|
297 memcpy (dest, XSTRING_DATA (s1), XSTRING_LENGTH (s1)); \
|
|
|
298 memcpy (dest + XSTRING_LENGTH (s1), XSTRING_DATA (s2), \
|
|
|
299 XSTRING_LENGTH (s2)); \
|
|
428
|
300 dest[XSTRING_LENGTH (s1) + XSTRING_LENGTH (s2)] = '\0'
|
|
|
301
|
|
|
302 /* Extract a doc string from a file. FILEPOS says where to get it.
|
|
|
303 (This could actually be byte code instructions/constants instead
|
|
|
304 of a doc string.)
|
|
|
305 If it is an integer, use that position in the standard DOC file.
|
|
|
306 If it is (FILE . INTEGER), use FILE as the file name
|
|
|
307 and INTEGER as the position in that file.
|
|
|
308 But if INTEGER is negative, make it positive.
|
|
|
309 (A negative integer is used for user variables, so we can distinguish
|
|
|
310 them without actually fetching the doc string.) */
|
|
|
311
|
|
|
312 static Lisp_Object
|
|
|
313 get_doc_string (Lisp_Object filepos)
|
|
|
314 {
|
|
|
315 REGISTER int fd;
|
|
867
|
316 REGISTER Ibyte *name_nonreloc = 0;
|
|
428
|
317 EMACS_INT position;
|
|
|
318 Lisp_Object file, tem;
|
|
|
319 Lisp_Object name_reloc = Qnil;
|
|
814
|
320 int standard_doc_file = 0;
|
|
428
|
321
|
|
|
322 if (INTP (filepos))
|
|
|
323 {
|
|
|
324 file = Vinternal_doc_file_name;
|
|
814
|
325 standard_doc_file = 1;
|
|
428
|
326 position = XINT (filepos);
|
|
|
327 }
|
|
|
328 else if (CONSP (filepos) && INTP (XCDR (filepos)))
|
|
|
329 {
|
|
|
330 file = XCAR (filepos);
|
|
|
331 position = XINT (XCDR (filepos));
|
|
|
332 if (position < 0)
|
|
|
333 position = - position;
|
|
|
334 }
|
|
|
335 else
|
|
|
336 return Qnil;
|
|
|
337
|
|
|
338 if (!STRINGP (file))
|
|
|
339 return Qnil;
|
|
|
340
|
|
|
341 /* Put the file name in NAME as a C string.
|
|
|
342 If it is relative, combine it with Vdoc_directory. */
|
|
|
343
|
|
|
344 tem = Ffile_name_absolute_p (file);
|
|
|
345 if (NILP (tem))
|
|
|
346 {
|
|
647
|
347 Bytecount minsize;
|
|
428
|
348 /* XEmacs: Move this check here. OK if called during loadup to
|
|
|
349 load byte code instructions. */
|
|
|
350 if (!STRINGP (Vdoc_directory))
|
|
|
351 return Qnil;
|
|
|
352
|
|
|
353 minsize = XSTRING_LENGTH (Vdoc_directory);
|
|
|
354 /* sizeof ("../lib-src/") == 12 */
|
|
|
355 if (minsize < 12)
|
|
|
356 minsize = 12;
|
|
867
|
357 name_nonreloc = alloca_ibytes (minsize + XSTRING_LENGTH (file) + 8);
|
|
428
|
358 string_join (name_nonreloc, Vdoc_directory, file);
|
|
|
359 }
|
|
|
360 else
|
|
|
361 name_reloc = file;
|
|
|
362
|
|
771
|
363 fd = qxe_open (name_nonreloc ? name_nonreloc :
|
|
|
364 XSTRING_DATA (name_reloc), O_RDONLY | OPEN_BINARY, 0);
|
|
428
|
365 if (fd < 0)
|
|
|
366 {
|
|
|
367 if (purify_flag)
|
|
|
368 {
|
|
|
369 /* sizeof ("../lib-src/") == 12 */
|
|
2367
|
370 name_nonreloc = alloca_ibytes (12 + XSTRING_LENGTH (file) + 8);
|
|
428
|
371 /* Preparing to dump; DOC file is probably not installed.
|
|
|
372 So check in ../lib-src. */
|
|
2367
|
373 qxestrcpy_ascii (name_nonreloc, "../lib-src/");
|
|
771
|
374 qxestrcat (name_nonreloc, XSTRING_DATA (file));
|
|
428
|
375
|
|
771
|
376 fd = qxe_open (name_nonreloc, O_RDONLY | OPEN_BINARY, 0);
|
|
428
|
377 }
|
|
|
378
|
|
|
379 if (fd < 0)
|
|
814
|
380 report_file_error ("Cannot open doc string file",
|
|
|
381 name_nonreloc ? build_intstring (name_nonreloc) :
|
|
|
382 name_reloc);
|
|
428
|
383 }
|
|
|
384
|
|
814
|
385 tem = unparesseuxify_doc_string (fd, position, name_nonreloc, name_reloc,
|
|
|
386 standard_doc_file);
|
|
771
|
387 retry_close (fd);
|
|
428
|
388
|
|
|
389 if (!STRINGP (tem))
|
|
563
|
390 signal_error_1 (Qinvalid_byte_code, tem);
|
|
428
|
391
|
|
|
392 return tem;
|
|
|
393 }
|
|
|
394
|
|
|
395 /* Get a string from position FILEPOS and pass it through the Lisp reader.
|
|
|
396 We use this for fetching the bytecode string and constants vector
|
|
|
397 of a compiled function from the .elc file. */
|
|
|
398
|
|
|
399 Lisp_Object
|
|
|
400 read_doc_string (Lisp_Object filepos)
|
|
|
401 {
|
|
|
402 Lisp_Object string = get_doc_string (filepos);
|
|
|
403
|
|
|
404 if (!STRINGP (string))
|
|
563
|
405 invalid_state ("loading bytecode failed to return string", string);
|
|
428
|
406 return Fread (string);
|
|
|
407 }
|
|
|
408
|
|
3368
|
409 static Lisp_Object
|
|
|
410 get_object_file_name (Lisp_Object filepos)
|
|
|
411 {
|
|
|
412 REGISTER int fd;
|
|
|
413 REGISTER Ibyte *name_nonreloc = 0;
|
|
|
414 EMACS_INT position;
|
|
|
415 Lisp_Object file, tem;
|
|
|
416 Lisp_Object name_reloc = Qnil;
|
|
|
417 int standard_doc_file = 0;
|
|
|
418
|
|
|
419 if (INTP (filepos))
|
|
|
420 {
|
|
|
421 file = Vinternal_doc_file_name;
|
|
|
422 standard_doc_file = 1;
|
|
|
423 position = XINT (filepos);
|
|
|
424 }
|
|
|
425 else if (CONSP (filepos) && INTP (XCDR (filepos)))
|
|
|
426 {
|
|
|
427 file = XCAR (filepos);
|
|
|
428 position = XINT (XCDR (filepos));
|
|
|
429 if (position < 0)
|
|
|
430 position = - position;
|
|
|
431 }
|
|
|
432 else
|
|
|
433 return Qnil;
|
|
|
434
|
|
|
435 if (!STRINGP (file))
|
|
|
436 return Qnil;
|
|
|
437
|
|
|
438 /* Put the file name in NAME as a C string.
|
|
|
439 If it is relative, combine it with Vdoc_directory. */
|
|
|
440
|
|
|
441 tem = Ffile_name_absolute_p (file);
|
|
|
442 if (NILP (tem))
|
|
|
443 {
|
|
|
444 Bytecount minsize;
|
|
|
445 /* XEmacs: Move this check here. OK if called during loadup to
|
|
|
446 load byte code instructions. */
|
|
|
447 if (!STRINGP (Vdoc_directory))
|
|
|
448 return Qnil;
|
|
|
449
|
|
|
450 minsize = XSTRING_LENGTH (Vdoc_directory);
|
|
|
451 /* sizeof ("../lib-src/") == 12 */
|
|
|
452 if (minsize < 12)
|
|
|
453 minsize = 12;
|
|
|
454 name_nonreloc = alloca_ibytes (minsize + XSTRING_LENGTH (file) + 8);
|
|
|
455 string_join (name_nonreloc, Vdoc_directory, file);
|
|
|
456 }
|
|
|
457 else
|
|
|
458 name_reloc = file;
|
|
|
459
|
|
|
460 fd = qxe_open (name_nonreloc ? name_nonreloc :
|
|
|
461 XSTRING_DATA (name_reloc), O_RDONLY | OPEN_BINARY, 0);
|
|
|
462 if (fd < 0)
|
|
|
463 {
|
|
|
464 if (purify_flag)
|
|
|
465 {
|
|
|
466 /* sizeof ("../lib-src/") == 12 */
|
|
|
467 name_nonreloc = alloca_ibytes (12 + XSTRING_LENGTH (file) + 8);
|
|
|
468 /* Preparing to dump; DOC file is probably not installed.
|
|
|
469 So check in ../lib-src. */
|
|
|
470 qxestrcpy_ascii (name_nonreloc, "../lib-src/");
|
|
|
471 qxestrcat (name_nonreloc, XSTRING_DATA (file));
|
|
|
472
|
|
|
473 fd = qxe_open (name_nonreloc, O_RDONLY | OPEN_BINARY, 0);
|
|
|
474 }
|
|
|
475
|
|
|
476 if (fd < 0)
|
|
|
477 report_file_error ("Cannot open doc string file",
|
|
|
478 name_nonreloc ? build_intstring (name_nonreloc) :
|
|
|
479 name_reloc);
|
|
|
480 }
|
|
|
481
|
|
|
482 tem = extract_object_file_name (fd, position, name_nonreloc, name_reloc,
|
|
|
483 standard_doc_file);
|
|
|
484 retry_close (fd);
|
|
|
485
|
|
|
486 if (!STRINGP (tem))
|
|
|
487 signal_error_1 (Qinvalid_byte_code, tem);
|
|
|
488
|
|
|
489 return tem;
|
|
|
490 }
|
|
|
491
|
|
|
492
|
|
|
493 static void
|
|
|
494 weird_doc (Lisp_Object sym, const CIbyte *weirdness, const CIbyte *type,
|
|
|
495 int pos)
|
|
|
496 {
|
|
|
497 if (!strcmp (weirdness, GETTEXT ("duplicate"))) return;
|
|
|
498 message ("Note: Strange doc (%s) for %s %s @ %d",
|
|
|
499 weirdness, type, XSTRING_DATA (XSYMBOL (sym)->name), pos);
|
|
|
500 }
|
|
|
501
|
|
|
502 DEFUN ("built-in-symbol-file", Fbuilt_in_symbol_file, 1, 1, 0, /*
|
|
|
503 Return the C source file built-in symbol SYM comes from.
|
|
|
504 Don't use this. Use the more general `symbol-file' (q.v.) instead.
|
|
|
505 */
|
|
|
506 (symbol))
|
|
|
507 {
|
|
|
508 /* This function can GC */
|
|
|
509 Lisp_Object fun;
|
|
|
510 Lisp_Object filename = Qnil;
|
|
|
511
|
|
|
512 if (EQ(Ffboundp(symbol), Qt))
|
|
|
513 {
|
|
|
514 fun = Findirect_function (symbol);
|
|
|
515
|
|
|
516 if (SUBRP (fun))
|
|
|
517 {
|
|
|
518 if (XSUBR (fun)->doc == 0)
|
|
|
519 return Qnil;
|
|
|
520
|
|
|
521 if ((EMACS_INT) XSUBR (fun)->doc >= 0)
|
|
|
522 {
|
|
|
523 weird_doc (symbol, "No file info available for function",
|
|
|
524 GETTEXT("function"), 0);
|
|
|
525 return Qnil;
|
|
|
526 }
|
|
|
527 else
|
|
|
528 filename = get_object_file_name
|
|
|
529 (make_int (- (EMACS_INT) XSUBR (fun)->doc));
|
|
|
530 }
|
|
|
531 }
|
|
|
532 else if (EQ(Fboundp(symbol), Qt))
|
|
|
533 {
|
|
|
534 Lisp_Object doc_offset = Fget (symbol, Qvariable_documentation, Qnil);
|
|
|
535
|
|
|
536 if (!NILP(doc_offset))
|
|
|
537 {
|
|
|
538 if (INTP(doc_offset))
|
|
|
539 {
|
|
|
540 filename = get_object_file_name
|
|
|
541 (XINT (doc_offset) > 0 ? doc_offset
|
|
|
542 : make_int (- XINT (doc_offset)));
|
|
|
543 }
|
|
|
544 else if (CONSP(doc_offset))
|
|
|
545 {
|
|
|
546 filename = get_object_file_name(doc_offset);
|
|
|
547 }
|
|
|
548 }
|
|
|
549 }
|
|
|
550 return filename;
|
|
|
551 }
|
|
|
552
|
|
428
|
553 DEFUN ("documentation", Fdocumentation, 1, 2, 0, /*
|
|
|
554 Return the documentation string of FUNCTION.
|
|
444
|
555 Unless a non-nil second argument RAW is given, the
|
|
428
|
556 string is passed through `substitute-command-keys'.
|
|
|
557 */
|
|
|
558 (function, raw))
|
|
|
559 {
|
|
|
560 /* This function can GC */
|
|
|
561 Lisp_Object fun;
|
|
|
562 Lisp_Object doc;
|
|
|
563
|
|
|
564 fun = Findirect_function (function);
|
|
|
565
|
|
|
566 if (SUBRP (fun))
|
|
|
567 {
|
|
|
568 if (XSUBR (fun)->doc == 0)
|
|
|
569 return Qnil;
|
|
|
570 if ((EMACS_INT) XSUBR (fun)->doc >= 0)
|
|
|
571 doc = build_string (XSUBR (fun)->doc);
|
|
|
572 else
|
|
|
573 doc = get_doc_string (make_int (- (EMACS_INT) XSUBR (fun)->doc));
|
|
|
574 }
|
|
|
575 else if (COMPILED_FUNCTIONP (fun))
|
|
|
576 {
|
|
|
577 Lisp_Object tem;
|
|
440
|
578 Lisp_Compiled_Function *f = XCOMPILED_FUNCTION (fun);
|
|
428
|
579 if (! (f->flags.documentationp))
|
|
|
580 return Qnil;
|
|
|
581 tem = compiled_function_documentation (f);
|
|
|
582 if (STRINGP (tem))
|
|
|
583 doc = tem;
|
|
|
584 else if (NATNUMP (tem) || CONSP (tem))
|
|
|
585 doc = get_doc_string (tem);
|
|
|
586 else
|
|
|
587 return Qnil;
|
|
|
588 }
|
|
|
589 else if (KEYMAPP (fun))
|
|
771
|
590 return build_msg_string ("Prefix command (definition is a keymap of subcommands).");
|
|
428
|
591 else if (STRINGP (fun) || VECTORP (fun))
|
|
771
|
592 return build_msg_string ("Keyboard macro.");
|
|
428
|
593 else if (CONSP (fun))
|
|
|
594 {
|
|
|
595 Lisp_Object funcar = Fcar (fun);
|
|
|
596
|
|
|
597 if (!SYMBOLP (funcar))
|
|
|
598 return Fsignal (Qinvalid_function, list1 (fun));
|
|
|
599 else if (EQ (funcar, Qlambda)
|
|
|
600 || EQ (funcar, Qautoload))
|
|
|
601 {
|
|
|
602 Lisp_Object tem, tem1;
|
|
|
603 tem1 = Fcdr (Fcdr (fun));
|
|
|
604 tem = Fcar (tem1);
|
|
|
605 if (STRINGP (tem))
|
|
|
606 doc = tem;
|
|
|
607 /* Handle a doc reference--but these never come last
|
|
|
608 in the function body, so reject them if they are last. */
|
|
|
609 else if ((NATNUMP (tem) || CONSP (tem))
|
|
|
610 && ! NILP (XCDR (tem1)))
|
|
|
611 doc = get_doc_string (tem);
|
|
|
612 else
|
|
|
613 return Qnil;
|
|
|
614 }
|
|
|
615 else if (EQ (funcar, Qmacro))
|
|
|
616 return Fdocumentation (Fcdr (fun), raw);
|
|
|
617 else
|
|
|
618 goto oops;
|
|
|
619 }
|
|
|
620 else
|
|
|
621 {
|
|
|
622 oops:
|
|
|
623 return Fsignal (Qinvalid_function, list1 (fun));
|
|
|
624 }
|
|
|
625
|
|
|
626 if (NILP (raw))
|
|
|
627 {
|
|
|
628 struct gcpro gcpro1;
|
|
|
629 #ifdef I18N3
|
|
|
630 Lisp_Object domain = Qnil;
|
|
|
631 if (COMPILED_FUNCTIONP (fun))
|
|
|
632 domain = compiled_function_domain (XCOMPILED_FUNCTION (fun));
|
|
|
633 if (NILP (domain))
|
|
|
634 doc = Fgettext (doc);
|
|
|
635 else
|
|
|
636 doc = Fdgettext (domain, doc);
|
|
|
637 #endif
|
|
|
638
|
|
|
639 GCPRO1 (doc);
|
|
|
640 doc = Fsubstitute_command_keys (doc);
|
|
|
641 UNGCPRO;
|
|
|
642 }
|
|
|
643 return doc;
|
|
|
644 }
|
|
|
645
|
|
|
646 DEFUN ("documentation-property", Fdocumentation_property, 2, 3, 0, /*
|
|
|
647 Return the documentation string that is SYMBOL's PROP property.
|
|
|
648 This is like `get', but it can refer to strings stored in the
|
|
|
649 `doc-directory/DOC' file; and if the value is a string, it is passed
|
|
|
650 through `substitute-command-keys'. A non-nil third argument avoids this
|
|
|
651 translation.
|
|
|
652 */
|
|
444
|
653 (symbol, prop, raw))
|
|
428
|
654 {
|
|
|
655 /* This function can GC */
|
|
1849
|
656 Lisp_Object doc = Qnil;
|
|
428
|
657 #ifdef I18N3
|
|
|
658 REGISTER Lisp_Object domain;
|
|
|
659 #endif
|
|
|
660 struct gcpro gcpro1;
|
|
|
661
|
|
|
662 GCPRO1 (doc);
|
|
|
663
|
|
444
|
664 doc = Fget (symbol, prop, Qnil);
|
|
428
|
665 if (INTP (doc))
|
|
|
666 doc = get_doc_string (XINT (doc) > 0 ? doc : make_int (- XINT (doc)));
|
|
|
667 else if (CONSP (doc))
|
|
|
668 doc = get_doc_string (doc);
|
|
|
669 #ifdef I18N3
|
|
|
670 if (!NILP (doc))
|
|
|
671 {
|
|
444
|
672 domain = Fget (symbol, Qvariable_domain, Qnil);
|
|
428
|
673 if (NILP (domain))
|
|
|
674 doc = Fgettext (doc);
|
|
|
675 else
|
|
|
676 doc = Fdgettext (domain, doc);
|
|
|
677 }
|
|
|
678 #endif
|
|
|
679 if (NILP (raw) && STRINGP (doc))
|
|
|
680 doc = Fsubstitute_command_keys (doc);
|
|
|
681 UNGCPRO;
|
|
|
682 return doc;
|
|
|
683 }
|
|
|
684
|
|
|
685
|
|
|
686 DEFUN ("Snarf-documentation", Fsnarf_documentation, 1, 1, 0, /*
|
|
|
687 Used during Emacs initialization, before dumping runnable Emacs,
|
|
|
688 to find pointers to doc strings stored in `.../lib-src/DOC' and
|
|
|
689 record them in function definitions.
|
|
|
690 One arg, FILENAME, a string which does not include a directory.
|
|
|
691 The file is written to `../lib-src', and later found in `exec-directory'
|
|
|
692 when doc strings are referred to in the dumped Emacs.
|
|
|
693 */
|
|
|
694 (filename))
|
|
|
695 {
|
|
|
696 int fd;
|
|
867
|
697 Ibyte buf[1024 + 1];
|
|
428
|
698 REGISTER int filled;
|
|
|
699 REGISTER int pos;
|
|
867
|
700 REGISTER Ibyte *p, *end;
|
|
428
|
701 Lisp_Object sym, fun, tem;
|
|
867
|
702 Ibyte *name;
|
|
428
|
703
|
|
814
|
704 /* This function should not pass the data it's reading through a coding
|
|
|
705 stream. The reason is that the only purpose of this function is to
|
|
|
706 find the file offsets for the documentation of the various functions,
|
|
|
707 not do anything with the documentation itself. If we pass through a
|
|
|
708 coding stream, the pointers will get messed up when we start reading
|
|
|
709 ISO 2022 data because our pointers will reflect internal format, not
|
|
|
710 external format. */
|
|
|
711
|
|
428
|
712 if (!purify_flag)
|
|
563
|
713 invalid_operation ("Snarf-documentation can only be called in an undumped Emacs", Qunbound);
|
|
428
|
714
|
|
|
715 CHECK_STRING (filename);
|
|
|
716
|
|
1330
|
717 {
|
|
|
718 name = alloca_ibytes (XSTRING_LENGTH (filename) + 14);
|
|
2367
|
719 qxestrcpy_ascii (name, "../lib-src/");
|
|
1330
|
720 }
|
|
428
|
721
|
|
771
|
722 qxestrcat (name, XSTRING_DATA (filename));
|
|
428
|
723
|
|
771
|
724 fd = qxe_open (name, O_RDONLY | OPEN_BINARY, 0);
|
|
428
|
725 if (fd < 0)
|
|
771
|
726 report_file_error ("Opening doc string file", build_intstring (name));
|
|
428
|
727 Vinternal_doc_file_name = filename;
|
|
|
728 filled = 0;
|
|
|
729 pos = 0;
|
|
|
730 while (1)
|
|
|
731 {
|
|
|
732 if (filled < 512)
|
|
771
|
733 filled += retry_read (fd, &buf[filled], sizeof (buf) - 1 - filled);
|
|
428
|
734 if (!filled)
|
|
|
735 break;
|
|
|
736
|
|
|
737 buf[filled] = 0;
|
|
|
738 p = buf;
|
|
|
739 end = buf + (filled < 512 ? filled : filled - 128);
|
|
|
740 while (p != end && *p != '\037') p++;
|
|
|
741 /* p points to ^_Ffunctionname\n or ^_Vvarname\n. */
|
|
|
742 if (p != end)
|
|
|
743 {
|
|
771
|
744 end = qxestrchr (p, '\n');
|
|
3548
|
745 /* If you trigger a failure with this assertion, you probably
|
|
|
746 configured with --quick-build and need to rebuild your DOC
|
|
3545
|
747 file. */
|
|
|
748 assert((end - p - 2) > -1);
|
|
771
|
749 sym = oblookup (Vobarray, p + 2, end - p - 2);
|
|
428
|
750 if (SYMBOLP (sym))
|
|
|
751 {
|
|
|
752 Lisp_Object offset = make_int (pos + end + 1 - buf);
|
|
|
753 /* Attach a docstring to a variable */
|
|
|
754 if (p[1] == 'V')
|
|
|
755 {
|
|
|
756 /* Install file-position as variable-documentation property
|
|
|
757 and make it negative for a user-variable
|
|
|
758 (doc starts with a `*'). */
|
|
|
759 Lisp_Object old = Fget (sym, Qvariable_documentation, Qzero);
|
|
|
760 if (!ZEROP (old))
|
|
|
761 {
|
|
|
762 weird_doc (sym, GETTEXT ("duplicate"),
|
|
|
763 GETTEXT ("variable"), pos);
|
|
|
764 /* In the case of duplicate doc file entries, always
|
|
|
765 take the later one. But if the doc is not an int
|
|
|
766 (a string, say) leave it alone. */
|
|
|
767 if (!INTP (old))
|
|
|
768 goto weird;
|
|
|
769 }
|
|
|
770 Fput (sym, Qvariable_documentation,
|
|
|
771 ((end[1] == '*')
|
|
|
772 ? make_int (- XINT (offset))
|
|
|
773 : offset));
|
|
|
774 }
|
|
|
775 /* Attach a docstring to a function.
|
|
|
776 The type determines where the docstring is stored. */
|
|
|
777 else if (p[1] == 'F')
|
|
|
778 {
|
|
|
779 fun = indirect_function (sym,0);
|
|
|
780
|
|
|
781 if (CONSP (fun) && EQ (XCAR (fun), Qmacro))
|
|
|
782 fun = XCDR (fun);
|
|
|
783
|
|
|
784 if (UNBOUNDP (fun))
|
|
|
785 {
|
|
771
|
786 #if 0 /* There are lots of legitimate cases where this message will appear
|
|
|
787 (e.g. any function that's only defined when MULE is defined,
|
|
|
788 provided that the function is used somewhere in a dumped Lisp
|
|
|
789 file, so that the symbol is interned in the dumped XEmacs), and
|
|
|
790 there's not a lot that can be done to eliminate the warning other
|
|
|
791 than kludges like moving the function to a Mule-only source file,
|
|
|
792 which often results in ugly code. Furthermore, the only point of
|
|
|
793 this warning is to warn you when you have a DEFUN that you forget
|
|
|
794 to DEFSUBR, but the compiler will also warn you, because the DEFUN
|
|
|
795 declares a static object, and the object will be unused -- you'll
|
|
|
796 get something like
|
|
|
797
|
|
|
798 /src/xemacs/mule/src/abbrev.c:269: warning: `SFexpand_abbrev' defined but not used
|
|
|
799
|
|
|
800 So I'm disabling this. --ben */
|
|
|
801
|
|
428
|
802 /* May have been #if'ed out or something */
|
|
|
803 weird_doc (sym, GETTEXT ("not fboundp"),
|
|
|
804 GETTEXT ("function"), pos);
|
|
771
|
805 #endif
|
|
428
|
806 goto weird;
|
|
|
807 }
|
|
|
808 else if (SUBRP (fun))
|
|
|
809 {
|
|
|
810 /* Lisp_Subrs have a slot for it. */
|
|
|
811 if (XSUBR (fun)->doc)
|
|
|
812 {
|
|
|
813 weird_doc (sym, GETTEXT ("duplicate"),
|
|
|
814 GETTEXT ("subr"), pos);
|
|
|
815 goto weird;
|
|
|
816 }
|
|
|
817 XSUBR (fun)->doc = (char *) (- XINT (offset));
|
|
|
818 }
|
|
|
819 else if (CONSP (fun))
|
|
|
820 {
|
|
|
821 /* If it's a lisp form, stick it in the form. */
|
|
|
822 tem = XCAR (fun);
|
|
|
823 if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
|
|
|
824 {
|
|
|
825 tem = Fcdr (Fcdr (fun));
|
|
|
826 if (CONSP (tem) &&
|
|
|
827 INTP (XCAR (tem)))
|
|
|
828 {
|
|
|
829 Lisp_Object old = XCAR (tem);
|
|
|
830 if (!ZEROP (old))
|
|
|
831 {
|
|
|
832 weird_doc (sym, GETTEXT ("duplicate"),
|
|
|
833 (EQ (tem, Qlambda)
|
|
|
834 ? GETTEXT ("lambda")
|
|
|
835 : GETTEXT ("autoload")),
|
|
|
836 pos);
|
|
|
837 /* In the case of duplicate doc file entries,
|
|
|
838 always take the later one. But if the doc
|
|
|
839 is not an int (a string, say) leave it
|
|
|
840 alone. */
|
|
|
841 if (!INTP (old))
|
|
|
842 goto weird;
|
|
|
843 }
|
|
|
844 XCAR (tem) = offset;
|
|
|
845 }
|
|
|
846 else if (!CONSP (tem))
|
|
|
847 {
|
|
|
848 weird_doc (sym, GETTEXT ("!CONSP(tem)"),
|
|
|
849 GETTEXT ("function"), pos);
|
|
|
850 goto cont;
|
|
|
851 }
|
|
|
852 else
|
|
|
853 {
|
|
|
854 /* DOC string is a string not integer 0 */
|
|
|
855 #if 0
|
|
|
856 weird_doc (sym, GETTEXT ("!INTP(XCAR(tem))"),
|
|
|
857 GETTEXT ("function"), pos);
|
|
|
858 #endif
|
|
|
859 goto cont;
|
|
|
860 }
|
|
|
861 }
|
|
|
862 else
|
|
|
863 {
|
|
|
864 weird_doc (sym, GETTEXT ("not lambda or autoload"),
|
|
|
865 GETTEXT ("function"), pos);
|
|
|
866 goto cont;
|
|
|
867 }
|
|
|
868 }
|
|
|
869 else if (COMPILED_FUNCTIONP (fun))
|
|
|
870 {
|
|
|
871 /* Compiled-Function objects sometimes have
|
|
|
872 slots for it. */
|
|
440
|
873 Lisp_Compiled_Function *f = XCOMPILED_FUNCTION (fun);
|
|
428
|
874
|
|
|
875 /* This compiled-function object must have a
|
|
|
876 slot for the docstring, since we've found a
|
|
|
877 docstring for it. Unless there were multiple
|
|
|
878 definitions of it, and the latter one didn't
|
|
|
879 have any doc, which is a legal if slightly
|
|
|
880 bogus situation, so don't blow up. */
|
|
|
881
|
|
|
882 if (! (f->flags.documentationp))
|
|
|
883 {
|
|
|
884 weird_doc (sym, GETTEXT ("no doc slot"),
|
|
|
885 GETTEXT ("bytecode"), pos);
|
|
|
886 goto weird;
|
|
|
887 }
|
|
|
888 else
|
|
|
889 {
|
|
|
890 Lisp_Object old =
|
|
|
891 compiled_function_documentation (f);
|
|
|
892 if (!ZEROP (old))
|
|
|
893 {
|
|
|
894 weird_doc (sym, GETTEXT ("duplicate"),
|
|
|
895 GETTEXT ("bytecode"), pos);
|
|
|
896 /* In the case of duplicate doc file entries,
|
|
|
897 always take the later one. But if the doc is
|
|
|
898 not an int (a string, say) leave it alone. */
|
|
|
899 if (!INTP (old))
|
|
|
900 goto weird;
|
|
|
901 }
|
|
|
902 set_compiled_function_documentation (f, offset);
|
|
|
903 }
|
|
|
904 }
|
|
|
905 else
|
|
|
906 {
|
|
|
907 /* Otherwise the function is undefined or
|
|
|
908 otherwise weird. Ignore it. */
|
|
|
909 weird_doc (sym, GETTEXT ("weird function"),
|
|
|
910 GETTEXT ("function"), pos);
|
|
|
911 goto weird;
|
|
|
912 }
|
|
|
913 }
|
|
|
914 else
|
|
|
915 {
|
|
|
916 /* lose: */
|
|
771
|
917 signal_error (Qfile_error, "DOC file invalid at position",
|
|
|
918 make_int (pos));
|
|
428
|
919 weird:
|
|
|
920 /* goto lose */;
|
|
|
921 }
|
|
|
922 }
|
|
|
923 }
|
|
|
924 cont:
|
|
|
925 pos += end - buf;
|
|
|
926 filled -= end - buf;
|
|
|
927 memmove (buf, end, filled);
|
|
|
928 }
|
|
771
|
929 retry_close (fd);
|
|
428
|
930 return Qnil;
|
|
|
931 }
|
|
|
932
|
|
|
933 #if 1 /* Don't warn about functions whose doc was lost because they were
|
|
|
934 wrapped by advice-freeze.el... */
|
|
|
935 static int
|
|
|
936 kludgily_ignore_lost_doc_p (Lisp_Object sym)
|
|
|
937 {
|
|
|
938 # define kludge_prefix "ad-Orig-"
|
|
793
|
939 Lisp_Object name = XSYMBOL (sym)->name;
|
|
|
940 return (XSTRING_LENGTH (name) > (Bytecount) (sizeof (kludge_prefix)) &&
|
|
2367
|
941 !qxestrncmp_ascii (XSTRING_DATA (name), kludge_prefix,
|
|
793
|
942 sizeof (kludge_prefix) - 1));
|
|
428
|
943 # undef kludge_prefix
|
|
|
944 }
|
|
|
945 #else
|
|
|
946 # define kludgily_ignore_lost_doc_p(sym) 0
|
|
|
947 #endif
|
|
|
948
|
|
|
949
|
|
|
950 static int
|
|
|
951 verify_doc_mapper (Lisp_Object sym, void *arg)
|
|
|
952 {
|
|
793
|
953 Lisp_Object closure = * (Lisp_Object *) arg;
|
|
428
|
954
|
|
|
955 if (!NILP (Ffboundp (sym)))
|
|
|
956 {
|
|
|
957 int doc = 0;
|
|
|
958 Lisp_Object fun = XSYMBOL (sym)->function;
|
|
|
959 if (CONSP (fun) &&
|
|
|
960 EQ (XCAR (fun), Qmacro))
|
|
|
961 fun = XCDR (fun);
|
|
|
962
|
|
|
963 if (SUBRP (fun))
|
|
|
964 doc = (EMACS_INT) XSUBR (fun)->doc;
|
|
|
965 else if (SYMBOLP (fun))
|
|
|
966 doc = -1;
|
|
|
967 else if (KEYMAPP (fun))
|
|
|
968 doc = -1;
|
|
|
969 else if (CONSP (fun))
|
|
|
970 {
|
|
|
971 Lisp_Object tem = XCAR (fun);
|
|
|
972 if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
|
|
|
973 {
|
|
|
974 doc = -1;
|
|
|
975 tem = Fcdr (Fcdr (fun));
|
|
|
976 if (CONSP (tem) &&
|
|
|
977 INTP (XCAR (tem)))
|
|
|
978 doc = XINT (XCAR (tem));
|
|
|
979 }
|
|
|
980 }
|
|
|
981 else if (COMPILED_FUNCTIONP (fun))
|
|
|
982 {
|
|
440
|
983 Lisp_Compiled_Function *f = XCOMPILED_FUNCTION (fun);
|
|
428
|
984 if (! (f->flags.documentationp))
|
|
|
985 doc = -1;
|
|
|
986 else
|
|
|
987 {
|
|
|
988 Lisp_Object tem = compiled_function_documentation (f);
|
|
|
989 if (INTP (tem))
|
|
|
990 doc = XINT (tem);
|
|
|
991 }
|
|
|
992 }
|
|
|
993
|
|
|
994 if (doc == 0 && !kludgily_ignore_lost_doc_p (sym))
|
|
|
995 {
|
|
|
996 message ("Warning: doc lost for function %s.",
|
|
793
|
997 XSTRING_DATA (XSYMBOL (sym)->name));
|
|
428
|
998 XCDR (closure) = Qt;
|
|
|
999 }
|
|
|
1000 }
|
|
|
1001 if (!NILP (Fboundp (sym)))
|
|
|
1002 {
|
|
|
1003 Lisp_Object doc = Fget (sym, Qvariable_documentation, Qnil);
|
|
|
1004 if (ZEROP (doc))
|
|
|
1005 {
|
|
|
1006 message ("Warning: doc lost for variable %s.",
|
|
793
|
1007 XSTRING_DATA (XSYMBOL (sym)->name));
|
|
428
|
1008 XCDR (closure) = Qt;
|
|
|
1009 }
|
|
|
1010 }
|
|
|
1011 return 0; /* Never stop */
|
|
|
1012 }
|
|
|
1013
|
|
|
1014 DEFUN ("Verify-documentation", Fverify_documentation, 0, 0, 0, /*
|
|
|
1015 Used to make sure everything went well with Snarf-documentation.
|
|
|
1016 Writes to stderr if not.
|
|
|
1017 */
|
|
|
1018 ())
|
|
|
1019 {
|
|
|
1020 Lisp_Object closure = Fcons (Qnil, Qnil);
|
|
|
1021 struct gcpro gcpro1;
|
|
|
1022 GCPRO1 (closure);
|
|
|
1023 map_obarray (Vobarray, verify_doc_mapper, &closure);
|
|
|
1024 if (!NILP (Fcdr (closure)))
|
|
|
1025 message ("\n"
|
|
|
1026 "This is usually because some files were preloaded by loaddefs.el or\n"
|
|
|
1027 "site-load.el, but were not passed to make-docfile by Makefile.\n");
|
|
|
1028 UNGCPRO;
|
|
|
1029 return NILP (Fcdr (closure)) ? Qt : Qnil;
|
|
|
1030 }
|
|
|
1031
|
|
|
1032
|
|
|
1033 DEFUN ("substitute-command-keys", Fsubstitute_command_keys, 1, 1, 0, /*
|
|
|
1034 Substitute key descriptions for command names in STRING.
|
|
|
1035 Return a new string which is STRING with substrings of the form \\=\\[COMMAND]
|
|
|
1036 replaced by either: a keystroke sequence that will invoke COMMAND,
|
|
|
1037 or "M-x COMMAND" if COMMAND is not on any keys.
|
|
|
1038 Substrings of the form \\=\\{MAPVAR} are replaced by summaries
|
|
444
|
1039 \(made by `describe-bindings') of the value of MAPVAR, taken as a keymap.
|
|
428
|
1040 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR
|
|
|
1041 as the keymap for future \\=\\[COMMAND] substrings.
|
|
|
1042 \\=\\= quotes the following character and is discarded;
|
|
|
1043 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.
|
|
|
1044 */
|
|
444
|
1045 (string))
|
|
428
|
1046 {
|
|
|
1047 /* This function can GC */
|
|
867
|
1048 Ibyte *buf;
|
|
428
|
1049 int changed = 0;
|
|
867
|
1050 REGISTER Ibyte *strdata;
|
|
|
1051 REGISTER Ibyte *bufp;
|
|
428
|
1052 Bytecount strlength;
|
|
|
1053 Bytecount idx;
|
|
|
1054 Bytecount bsize;
|
|
3025
|
1055 Ibyte *new_;
|
|
444
|
1056 Lisp_Object tem = Qnil;
|
|
|
1057 Lisp_Object keymap = Qnil;
|
|
|
1058 Lisp_Object name = Qnil;
|
|
867
|
1059 Ibyte *start;
|
|
428
|
1060 Bytecount length;
|
|
|
1061 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
|
|
|
1062
|
|
444
|
1063 if (NILP (string))
|
|
428
|
1064 return Qnil;
|
|
|
1065
|
|
444
|
1066 CHECK_STRING (string);
|
|
|
1067 GCPRO4 (string, tem, keymap, name);
|
|
428
|
1068
|
|
|
1069 /* There is the possibility that the string is not destined for a
|
|
|
1070 translating stream, and it could be argued that we should do the
|
|
|
1071 same thing here as in Fformat(), but there are very few times
|
|
|
1072 when this will be the case and many calls to this function
|
|
|
1073 would have to have `gettext' calls added. (I18N3) */
|
|
444
|
1074 string = LISP_GETTEXT (string);
|
|
428
|
1075
|
|
|
1076 /* KEYMAP is either nil (which means search all the active keymaps)
|
|
|
1077 or a specified local map (which means search just that and the
|
|
|
1078 global map). If non-nil, it might come from Voverriding_local_map,
|
|
444
|
1079 or from a \\<mapname> construct in STRING itself.. */
|
|
428
|
1080 #if 0 /* FSFmacs */
|
|
|
1081 /* This is really weird and garbagey. If keymap is nil and there's
|
|
|
1082 an overriding-local-map, `where-is-internal' will correctly note
|
|
|
1083 this, so there's no reason to do it here. Maybe FSFmacs
|
|
|
1084 `where-is-internal' is broken. */
|
|
|
1085 /*
|
|
|
1086 keymap = current_kboard->Voverriding_terminal_local_map;
|
|
|
1087 if (NILP (keymap))
|
|
|
1088 keymap = Voverriding_local_map;
|
|
|
1089 */
|
|
|
1090 #endif
|
|
|
1091
|
|
444
|
1092 strlength = XSTRING_LENGTH (string);
|
|
2367
|
1093 bsize = ITEXT_ZTERM_SIZE + strlength;
|
|
|
1094 buf = xnew_ibytes (bsize);
|
|
428
|
1095 bufp = buf;
|
|
|
1096
|
|
|
1097 /* Have to reset strdata every time GC might be called */
|
|
444
|
1098 strdata = XSTRING_DATA (string);
|
|
428
|
1099 for (idx = 0; idx < strlength; )
|
|
|
1100 {
|
|
867
|
1101 Ibyte *strp = strdata + idx;
|
|
428
|
1102
|
|
|
1103 if (strp[0] != '\\')
|
|
|
1104 {
|
|
|
1105 /* just copy other chars */
|
|
|
1106 /* As it happens, this will work with Mule even if the
|
|
|
1107 character quoted is multi-byte; the remaining multi-byte
|
|
|
1108 characters will just be copied by this loop. */
|
|
|
1109 *bufp++ = *strp;
|
|
|
1110 idx++;
|
|
|
1111 }
|
|
|
1112 else switch (strp[1])
|
|
|
1113 {
|
|
|
1114 default:
|
|
|
1115 {
|
|
|
1116 /* just copy unknown escape sequences */
|
|
|
1117 *bufp++ = *strp;
|
|
|
1118 idx++;
|
|
|
1119 break;
|
|
|
1120 }
|
|
|
1121 case '=':
|
|
|
1122 {
|
|
|
1123 /* \= quotes the next character;
|
|
|
1124 thus, to put in \[ without its special meaning, use \=\[. */
|
|
|
1125 /* As it happens, this will work with Mule even if the
|
|
|
1126 character quoted is multi-byte; the remaining multi-byte
|
|
|
1127 characters will just be copied by this loop. */
|
|
|
1128 changed = 1;
|
|
|
1129 *bufp++ = strp[2];
|
|
|
1130 idx += 3;
|
|
|
1131 break;
|
|
|
1132 }
|
|
|
1133 case '[':
|
|
|
1134 {
|
|
|
1135 changed = 1;
|
|
|
1136 idx += 2; /* skip \[ */
|
|
|
1137 strp += 2;
|
|
|
1138 start = strp;
|
|
|
1139
|
|
|
1140 while ((idx < strlength)
|
|
|
1141 && *strp != ']')
|
|
|
1142 {
|
|
|
1143 strp++;
|
|
|
1144 idx++;
|
|
|
1145 }
|
|
|
1146 length = strp - start;
|
|
|
1147 idx++; /* skip ] */
|
|
|
1148
|
|
|
1149 tem = Fintern (make_string (start, length), Qnil);
|
|
|
1150 tem = Fwhere_is_internal (tem, keymap, Qt, Qnil, Qnil);
|
|
|
1151
|
|
|
1152 #if 0 /* FSFmacs */
|
|
444
|
1153 /* Disregard menu bar bindings; it is positively annoying to
|
|
|
1154 mention them when there's no menu bar, and it isn't terribly
|
|
|
1155 useful even when there is a menu bar. */
|
|
|
1156 if (!NILP (tem))
|
|
|
1157 {
|
|
|
1158 firstkey = Faref (tem, Qzero);
|
|
|
1159 if (EQ (firstkey, Qmenu_bar))
|
|
|
1160 tem = Qnil;
|
|
|
1161 }
|
|
428
|
1162 #endif
|
|
|
1163
|
|
|
1164 if (NILP (tem)) /* but not on any keys */
|
|
|
1165 {
|
|
3025
|
1166 new_ = (Ibyte *) xrealloc (buf, bsize += 4);
|
|
|
1167 bufp += new_ - buf;
|
|
|
1168 buf = new_;
|
|
428
|
1169 memcpy (bufp, "M-x ", 4);
|
|
|
1170 bufp += 4;
|
|
|
1171 goto subst;
|
|
|
1172 }
|
|
|
1173 else
|
|
|
1174 { /* function is on a key */
|
|
|
1175 tem = Fkey_description (tem);
|
|
|
1176 goto subst_string;
|
|
|
1177 }
|
|
|
1178 }
|
|
|
1179 case '{':
|
|
|
1180 case '<':
|
|
|
1181 {
|
|
444
|
1182 Lisp_Object buffer = Fget_buffer_create (QSsubstitute);
|
|
|
1183 struct buffer *buf_ = XBUFFER (buffer);
|
|
428
|
1184
|
|
|
1185 Fbuffer_disable_undo (buffer);
|
|
|
1186 Ferase_buffer (buffer);
|
|
|
1187
|
|
|
1188 /* \{foo} is replaced with a summary of keymap (symbol-value foo).
|
|
|
1189 \<foo> just sets the keymap used for \[cmd]. */
|
|
|
1190 changed = 1;
|
|
|
1191 idx += 2; /* skip \{ or \< */
|
|
|
1192 strp += 2;
|
|
|
1193 start = strp;
|
|
|
1194
|
|
|
1195 while ((idx < strlength)
|
|
|
1196 && *strp != '}' && *strp != '>')
|
|
|
1197 {
|
|
|
1198 strp++;
|
|
|
1199 idx++;
|
|
|
1200 }
|
|
|
1201 length = strp - start;
|
|
|
1202 idx++; /* skip } or > */
|
|
|
1203
|
|
|
1204 /* Get the value of the keymap in TEM, or nil if undefined.
|
|
|
1205 Do this while still in the user's current buffer
|
|
|
1206 in case it is a local variable. */
|
|
|
1207 name = Fintern (make_string (start, length), Qnil);
|
|
|
1208 tem = Fboundp (name);
|
|
|
1209 if (! NILP (tem))
|
|
|
1210 {
|
|
|
1211 tem = Fsymbol_value (name);
|
|
|
1212 if (! NILP (tem))
|
|
|
1213 tem = get_keymap (tem, 0, 1);
|
|
|
1214 }
|
|
|
1215
|
|
|
1216 if (NILP (tem))
|
|
|
1217 {
|
|
444
|
1218 buffer_insert_c_string (buf_, "(uses keymap \"");
|
|
|
1219 buffer_insert_lisp_string (buf_, Fsymbol_name (name));
|
|
|
1220 buffer_insert_c_string (buf_, "\", which is not currently defined) ");
|
|
428
|
1221
|
|
|
1222 if (start[-1] == '<') keymap = Qnil;
|
|
|
1223 }
|
|
|
1224 else if (start[-1] == '<')
|
|
|
1225 keymap = tem;
|
|
|
1226 else
|
|
|
1227 describe_map_tree (tem, 1, Qnil, Qnil, 0, buffer);
|
|
|
1228
|
|
|
1229 tem = make_string_from_buffer (buf_, BUF_BEG (buf_),
|
|
|
1230 BUF_Z (buf_) - BUF_BEG (buf_));
|
|
|
1231 Ferase_buffer (buffer);
|
|
444
|
1232 }
|
|
|
1233 goto subst_string;
|
|
428
|
1234
|
|
444
|
1235 subst_string:
|
|
|
1236 start = XSTRING_DATA (tem);
|
|
|
1237 length = XSTRING_LENGTH (tem);
|
|
|
1238 subst:
|
|
|
1239 bsize += length;
|
|
3025
|
1240 new_ = (Ibyte *) xrealloc (buf, bsize);
|
|
|
1241 bufp += new_ - buf;
|
|
|
1242 buf = new_;
|
|
444
|
1243 memcpy (bufp, start, length);
|
|
|
1244 bufp += length;
|
|
428
|
1245
|
|
444
|
1246 /* Reset STRDATA in case gc relocated it. */
|
|
|
1247 strdata = XSTRING_DATA (string);
|
|
428
|
1248
|
|
444
|
1249 break;
|
|
428
|
1250 }
|
|
|
1251 }
|
|
|
1252
|
|
|
1253 if (changed) /* don't bother if nothing substituted */
|
|
|
1254 tem = make_string (buf, bufp - buf);
|
|
|
1255 else
|
|
444
|
1256 tem = string;
|
|
1726
|
1257 xfree (buf, Ibyte *);
|
|
428
|
1258 UNGCPRO;
|
|
|
1259 return tem;
|
|
|
1260 }
|
|
|
1261
|
|
|
1262
|
|
|
1263 /************************************************************************/
|
|
|
1264 /* initialization */
|
|
|
1265 /************************************************************************/
|
|
|
1266
|
|
|
1267 void
|
|
|
1268 syms_of_doc (void)
|
|
|
1269 {
|
|
3368
|
1270 DEFSUBR (Fbuilt_in_symbol_file);
|
|
428
|
1271 DEFSUBR (Fdocumentation);
|
|
|
1272 DEFSUBR (Fdocumentation_property);
|
|
|
1273 DEFSUBR (Fsnarf_documentation);
|
|
|
1274 DEFSUBR (Fverify_documentation);
|
|
|
1275 DEFSUBR (Fsubstitute_command_keys);
|
|
|
1276 }
|
|
|
1277
|
|
|
1278 void
|
|
|
1279 vars_of_doc (void)
|
|
|
1280 {
|
|
|
1281 DEFVAR_LISP ("internal-doc-file-name", &Vinternal_doc_file_name /*
|
|
|
1282 Name of file containing documentation strings of built-in symbols.
|
|
|
1283 */ );
|
|
|
1284 Vinternal_doc_file_name = Qnil;
|
|
|
1285
|
|
|
1286 QSsubstitute = build_string (" *substitute*");
|
|
|
1287 staticpro (&QSsubstitute);
|
|
|
1288 }
|
