Commit | Line | Data |
---|---|---|
c6045832 | 1 | /* Record indices of function doc strings stored in a file. |
73b0cd50 | 2 | Copyright (C) 1985-1986, 1993-1995, 1997-2011 |
8cabe764 | 3 | Free Software Foundation, Inc. |
c6045832 JB |
4 | |
5 | This file is part of GNU Emacs. | |
6 | ||
9ec0b715 | 7 | GNU Emacs is free software: you can redistribute it and/or modify |
c6045832 | 8 | it under the terms of the GNU General Public License as published by |
9ec0b715 GM |
9 | the Free Software Foundation, either version 3 of the License, or |
10 | (at your option) any later version. | |
c6045832 JB |
11 | |
12 | GNU Emacs is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
9ec0b715 | 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
c6045832 JB |
19 | |
20 | ||
18160b98 | 21 | #include <config.h> |
c6045832 JB |
22 | |
23 | #include <sys/types.h> | |
f2a77c3a | 24 | #include <sys/file.h> /* Must be after sys/types.h for USG*/ |
9f77d2aa | 25 | #include <ctype.h> |
d7306fe6 | 26 | #include <setjmp.h> |
c6045832 | 27 | #include <fcntl.h> |
29beb080 | 28 | #include <unistd.h> |
29beb080 | 29 | |
c6045832 JB |
30 | #include "lisp.h" |
31 | #include "buffer.h" | |
665d3046 | 32 | #include "keyboard.h" |
83be827a | 33 | #include "character.h" |
8feddab4 | 34 | #include "keymap.h" |
878bde49 | 35 | #include "buildobj.h" |
c6045832 | 36 | |
9191c8ae GM |
37 | Lisp_Object Qfunction_documentation; |
38 | ||
c566235d | 39 | extern Lisp_Object Qclosure; |
912e8480 RS |
40 | /* Buffer used for reading from documentation file. */ |
41 | static char *get_doc_string_buffer; | |
3d0c92a2 | 42 | static ptrdiff_t get_doc_string_buffer_size; |
912e8480 | 43 | |
32caae30 | 44 | static unsigned char *read_bytecode_pointer; |
cd64ea1d PE |
45 | static Lisp_Object Fdocumentation_property (Lisp_Object, Lisp_Object, |
46 | Lisp_Object); | |
47 | static Lisp_Object Fsnarf_documentation (Lisp_Object); | |
32caae30 RS |
48 | |
49 | /* readchar in lread.c calls back here to fetch the next byte. | |
50 | If UNREADFLAG is 1, we unread a byte. */ | |
51 | ||
52 | int | |
971de7fb | 53 | read_bytecode_char (int unreadflag) |
32caae30 RS |
54 | { |
55 | if (unreadflag) | |
56 | { | |
57 | read_bytecode_pointer--; | |
58 | return 0; | |
59 | } | |
60 | return *read_bytecode_pointer++; | |
61 | } | |
62 | ||
700ea809 RS |
63 | /* Extract a doc string from a file. FILEPOS says where to get it. |
64 | If it is an integer, use that position in the standard DOC-... file. | |
65 | If it is (FILE . INTEGER), use FILE as the file name | |
0c00bc70 RS |
66 | and INTEGER as the position in that file. |
67 | But if INTEGER is negative, make it positive. | |
68 | (A negative integer is used for user variables, so we can distinguish | |
ba29c3c9 RS |
69 | them without actually fetching the doc string.) |
70 | ||
a154a4ef SM |
71 | If the location does not point to the beginning of a docstring |
72 | (e.g. because the file has been modified and the location is stale), | |
73 | return nil. | |
74 | ||
e96179b3 RS |
75 | If UNIBYTE is nonzero, always make a unibyte string. |
76 | ||
f1df0d67 RS |
77 | If DEFINITION is nonzero, assume this is for reading |
78 | a dynamic function definition; convert the bytestring | |
79 | and the constants vector with appropriate byte handling, | |
80 | and return a cons cell. */ | |
700ea809 | 81 | |
0c3debbc | 82 | Lisp_Object |
971de7fb | 83 | get_doc_string (Lisp_Object filepos, int unibyte, int definition) |
778d47c7 | 84 | { |
700ea809 | 85 | char *from, *to; |
778d47c7 RS |
86 | register int fd; |
87 | register char *name; | |
88 | register char *p, *p1; | |
84c9ce05 LMI |
89 | EMACS_INT minsize; |
90 | EMACS_INT offset, position; | |
700ea809 | 91 | Lisp_Object file, tem; |
778d47c7 | 92 | |
700ea809 RS |
93 | if (INTEGERP (filepos)) |
94 | { | |
95 | file = Vdoc_file_name; | |
96 | position = XINT (filepos); | |
97 | } | |
98 | else if (CONSP (filepos)) | |
99 | { | |
03699b14 KR |
100 | file = XCAR (filepos); |
101 | position = XINT (XCDR (filepos)); | |
700ea809 RS |
102 | } |
103 | else | |
778d47c7 RS |
104 | return Qnil; |
105 | ||
87afdd65 SM |
106 | if (position < 0) |
107 | position = - position; | |
108 | ||
700ea809 RS |
109 | if (!STRINGP (Vdoc_directory)) |
110 | return Qnil; | |
111 | ||
112 | if (!STRINGP (file)) | |
113 | return Qnil; | |
177c0ea7 | 114 | |
700ea809 RS |
115 | /* Put the file name in NAME as a C string. |
116 | If it is relative, combine it with Vdoc_directory. */ | |
117 | ||
118 | tem = Ffile_name_absolute_p (file); | |
119 | if (NILP (tem)) | |
120 | { | |
d5db4077 | 121 | minsize = SCHARS (Vdoc_directory); |
700ea809 RS |
122 | /* sizeof ("../etc/") == 8 */ |
123 | if (minsize < 8) | |
124 | minsize = 8; | |
d5db4077 | 125 | name = (char *) alloca (minsize + SCHARS (file) + 8); |
42a5b22f PE |
126 | strcpy (name, SSDATA (Vdoc_directory)); |
127 | strcat (name, SSDATA (file)); | |
700ea809 RS |
128 | } |
129 | else | |
130 | { | |
51b59d79 | 131 | name = SSDATA (file); |
700ea809 | 132 | } |
c6045832 | 133 | |
68c45bf0 | 134 | fd = emacs_open (name, O_RDONLY, 0); |
c6045832 | 135 | if (fd < 0) |
778d47c7 RS |
136 | { |
137 | #ifndef CANNOT_DUMP | |
138 | if (!NILP (Vpurify_flag)) | |
139 | { | |
140 | /* Preparing to dump; DOC file is probably not installed. | |
141 | So check in ../etc. */ | |
142 | strcpy (name, "../etc/"); | |
42a5b22f | 143 | strcat (name, SSDATA (file)); |
778d47c7 | 144 | |
68c45bf0 | 145 | fd = emacs_open (name, O_RDONLY, 0); |
778d47c7 RS |
146 | } |
147 | #endif | |
778d47c7 RS |
148 | if (fd < 0) |
149 | error ("Cannot open doc string file \"%s\"", name); | |
150 | } | |
151 | ||
0fded513 | 152 | /* Seek only to beginning of disk block. */ |
a154a4ef SM |
153 | /* Make sure we read at least 1024 bytes before `position' |
154 | so we can check the leading text for consistency. */ | |
155 | offset = min (position, max (1024, position % (8 * 1024))); | |
0fded513 | 156 | if (0 > lseek (fd, position - offset, 0)) |
c6045832 | 157 | { |
68c45bf0 | 158 | emacs_close (fd); |
c2982e87 | 159 | error ("Position %"pI"d out of range in doc string file \"%s\"", |
700ea809 | 160 | position, name); |
c6045832 | 161 | } |
700ea809 | 162 | |
912e8480 RS |
163 | /* Read the doc string into get_doc_string_buffer. |
164 | P points beyond the data just read. */ | |
0fded513 | 165 | |
912e8480 | 166 | p = get_doc_string_buffer; |
700ea809 | 167 | while (1) |
c6045832 | 168 | { |
3d0c92a2 | 169 | ptrdiff_t space_left = (get_doc_string_buffer_size |
84c9ce05 | 170 | - (p - get_doc_string_buffer)); |
700ea809 RS |
171 | int nread; |
172 | ||
0fded513 | 173 | /* Allocate or grow the buffer if we need to. */ |
700ea809 RS |
174 | if (space_left == 0) |
175 | { | |
3d0c92a2 | 176 | ptrdiff_t in_buffer = p - get_doc_string_buffer; |
0065d054 PE |
177 | get_doc_string_buffer = |
178 | xpalloc (get_doc_string_buffer, &get_doc_string_buffer_size, | |
179 | 16 * 1024, -1, 1); | |
912e8480 RS |
180 | p = get_doc_string_buffer + in_buffer; |
181 | space_left = (get_doc_string_buffer_size | |
182 | - (p - get_doc_string_buffer)); | |
700ea809 RS |
183 | } |
184 | ||
0fded513 RS |
185 | /* Read a disk block at a time. |
186 | If we read the same block last time, maybe skip this? */ | |
700ea809 RS |
187 | if (space_left > 1024 * 8) |
188 | space_left = 1024 * 8; | |
68c45bf0 | 189 | nread = emacs_read (fd, p, space_left); |
700ea809 RS |
190 | if (nread < 0) |
191 | { | |
68c45bf0 | 192 | emacs_close (fd); |
700ea809 RS |
193 | error ("Read error on documentation file"); |
194 | } | |
195 | p[nread] = 0; | |
196 | if (!nread) | |
c6045832 | 197 | break; |
912e8480 | 198 | if (p == get_doc_string_buffer) |
8966b757 | 199 | p1 = strchr (p + offset, '\037'); |
0fded513 | 200 | else |
8966b757 | 201 | p1 = strchr (p, '\037'); |
c6045832 JB |
202 | if (p1) |
203 | { | |
204 | *p1 = 0; | |
205 | p = p1; | |
206 | break; | |
207 | } | |
700ea809 | 208 | p += nread; |
c6045832 | 209 | } |
68c45bf0 | 210 | emacs_close (fd); |
700ea809 | 211 | |
a154a4ef SM |
212 | /* Sanity checking. */ |
213 | if (CONSP (filepos)) | |
214 | { | |
215 | int test = 1; | |
216 | if (get_doc_string_buffer[offset - test++] != ' ') | |
217 | return Qnil; | |
218 | while (get_doc_string_buffer[offset - test] >= '0' | |
219 | && get_doc_string_buffer[offset - test] <= '9') | |
220 | test++; | |
221 | if (get_doc_string_buffer[offset - test++] != '@' | |
222 | || get_doc_string_buffer[offset - test] != '#') | |
223 | return Qnil; | |
224 | } | |
225 | else | |
226 | { | |
227 | int test = 1; | |
228 | if (get_doc_string_buffer[offset - test++] != '\n') | |
229 | return Qnil; | |
230 | while (get_doc_string_buffer[offset - test] > ' ') | |
231 | test++; | |
232 | if (get_doc_string_buffer[offset - test] != '\037') | |
233 | return Qnil; | |
234 | } | |
235 | ||
700ea809 RS |
236 | /* Scan the text and perform quoting with ^A (char code 1). |
237 | ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_. */ | |
912e8480 RS |
238 | from = get_doc_string_buffer + offset; |
239 | to = get_doc_string_buffer + offset; | |
700ea809 RS |
240 | while (from != p) |
241 | { | |
242 | if (*from == 1) | |
243 | { | |
244 | int c; | |
245 | ||
246 | from++; | |
247 | c = *from++; | |
248 | if (c == 1) | |
249 | *to++ = c; | |
250 | else if (c == '0') | |
251 | *to++ = 0; | |
252 | else if (c == '_') | |
253 | *to++ = 037; | |
254 | else | |
684a03ef PE |
255 | { |
256 | unsigned char uc = c; | |
257 | error ("\ | |
762b15be | 258 | Invalid data in documentation file -- %c followed by code %03o", |
684a03ef PE |
259 | 1, uc); |
260 | } | |
700ea809 RS |
261 | } |
262 | else | |
263 | *to++ = *from++; | |
264 | } | |
265 | ||
32caae30 RS |
266 | /* If DEFINITION, read from this buffer |
267 | the same way we would read bytes from a file. */ | |
f1df0d67 RS |
268 | if (definition) |
269 | { | |
9eee99eb | 270 | read_bytecode_pointer = (unsigned char *) get_doc_string_buffer + offset; |
32caae30 | 271 | return Fread (Qlambda); |
f1df0d67 RS |
272 | } |
273 | ||
e96179b3 RS |
274 | if (unibyte) |
275 | return make_unibyte_string (get_doc_string_buffer + offset, | |
276 | to - (get_doc_string_buffer + offset)); | |
277 | else | |
fb2fdea7 | 278 | { |
198a7a97 | 279 | /* The data determines whether the string is multibyte. */ |
9eee99eb PE |
280 | EMACS_INT nchars = |
281 | multibyte_chars_in_text (((unsigned char *) get_doc_string_buffer | |
282 | + offset), | |
283 | to - (get_doc_string_buffer + offset)); | |
fb2fdea7 RS |
284 | return make_string_from_bytes (get_doc_string_buffer + offset, |
285 | nchars, | |
286 | to - (get_doc_string_buffer + offset)); | |
287 | } | |
700ea809 RS |
288 | } |
289 | ||
290 | /* Get a string from position FILEPOS and pass it through the Lisp reader. | |
291 | We use this for fetching the bytecode string and constants vector | |
292 | of a compiled function from the .elc file. */ | |
293 | ||
294 | Lisp_Object | |
971de7fb | 295 | read_doc_string (Lisp_Object filepos) |
700ea809 | 296 | { |
e96179b3 | 297 | return get_doc_string (filepos, 0, 1); |
c6045832 JB |
298 | } |
299 | ||
e5aa79fa | 300 | static int |
971de7fb | 301 | reread_doc_file (Lisp_Object file) |
a154a4ef | 302 | { |
13d7dc77 | 303 | #if 0 |
a154a4ef SM |
304 | Lisp_Object reply, prompt[3]; |
305 | struct gcpro gcpro1; | |
306 | GCPRO1 (file); | |
307 | prompt[0] = build_string ("File "); | |
308 | prompt[1] = NILP (file) ? Vdoc_file_name : file; | |
13d7dc77 | 309 | prompt[2] = build_string (" is out of sync. Reload? "); |
a154a4ef SM |
310 | reply = Fy_or_n_p (Fconcat (3, prompt)); |
311 | UNGCPRO; | |
312 | if (NILP (reply)) | |
e5aa79fa | 313 | return 0; |
13d7dc77 | 314 | #endif |
a154a4ef SM |
315 | |
316 | if (NILP (file)) | |
317 | Fsnarf_documentation (Vdoc_file_name); | |
318 | else | |
319 | Fload (file, Qt, Qt, Qt, Qnil); | |
e5aa79fa SM |
320 | |
321 | return 1; | |
a154a4ef SM |
322 | } |
323 | ||
ee04dc54 | 324 | DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0, |
335c5470 PJ |
325 | doc: /* Return the documentation string of FUNCTION. |
326 | Unless a non-nil second argument RAW is given, the | |
327 | string is passed through `substitute-command-keys'. */) | |
5842a27b | 328 | (Lisp_Object function, Lisp_Object raw) |
c6045832 JB |
329 | { |
330 | Lisp_Object fun; | |
331 | Lisp_Object funcar; | |
a415e694 | 332 | Lisp_Object doc; |
e5aa79fa SM |
333 | int try_reload = 1; |
334 | ||
335 | documentation: | |
c6045832 | 336 | |
8d17fe0b | 337 | doc = Qnil; |
177c0ea7 | 338 | |
a415e694 PE |
339 | if (SYMBOLP (function)) |
340 | { | |
341 | Lisp_Object tem = Fget (function, Qfunction_documentation); | |
342 | if (!NILP (tem)) | |
343 | return Fdocumentation_property (function, Qfunction_documentation, | |
344 | raw); | |
345 | } | |
177c0ea7 | 346 | |
a7f96a35 | 347 | fun = Findirect_function (function, Qnil); |
5b5f6883 | 348 | if (SUBRP (fun)) |
c6045832 | 349 | { |
9191c8ae GM |
350 | if (XSUBR (fun)->doc == 0) |
351 | return Qnil; | |
8f41de3a PE |
352 | /* FIXME: This is not portable, as it assumes that string |
353 | pointers have the top bit clear. */ | |
d01a7826 | 354 | else if ((intptr_t) XSUBR (fun)->doc >= 0) |
ee04dc54 | 355 | doc = build_string (XSUBR (fun)->doc); |
c6045832 | 356 | else |
d01a7826 | 357 | doc = make_number ((intptr_t) XSUBR (fun)->doc); |
5b5f6883 KH |
358 | } |
359 | else if (COMPILEDP (fun)) | |
360 | { | |
87afdd65 | 361 | if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING) |
c6045832 | 362 | return Qnil; |
ee04dc54 | 363 | else |
a415e694 PE |
364 | { |
365 | Lisp_Object tem = AREF (fun, COMPILED_DOC_STRING); | |
366 | if (STRINGP (tem)) | |
367 | doc = tem; | |
368 | else if (NATNUMP (tem) || CONSP (tem)) | |
369 | doc = tem; | |
370 | else | |
371 | return Qnil; | |
372 | } | |
5b5f6883 KH |
373 | } |
374 | else if (STRINGP (fun) || VECTORP (fun)) | |
375 | { | |
c6045832 | 376 | return build_string ("Keyboard macro."); |
5b5f6883 KH |
377 | } |
378 | else if (CONSP (fun)) | |
379 | { | |
c6045832 | 380 | funcar = Fcar (fun); |
e6d12642 | 381 | if (!SYMBOLP (funcar)) |
2f0a47f9 | 382 | xsignal1 (Qinvalid_function, fun); |
502ddf23 | 383 | else if (EQ (funcar, Qkeymap)) |
a3cec380 | 384 | return build_string ("Prefix command (definition is a keymap associating keystrokes with commands)."); |
502ddf23 | 385 | else if (EQ (funcar, Qlambda) |
23aba0ea | 386 | || (EQ (funcar, Qclosure) && (fun = XCDR (fun), 1)) |
502ddf23 | 387 | || EQ (funcar, Qautoload)) |
c6045832 | 388 | { |
a415e694 PE |
389 | Lisp_Object tem1 = Fcdr (Fcdr (fun)); |
390 | Lisp_Object tem = Fcar (tem1); | |
e6d12642 | 391 | if (STRINGP (tem)) |
ee04dc54 | 392 | doc = tem; |
ae44f7a4 RS |
393 | /* Handle a doc reference--but these never come last |
394 | in the function body, so reject them if they are last. */ | |
87afdd65 SM |
395 | else if ((NATNUMP (tem) || (CONSP (tem) && INTEGERP (XCDR (tem)))) |
396 | && !NILP (XCDR (tem1))) | |
397 | doc = tem; | |
ee04dc54 RM |
398 | else |
399 | return Qnil; | |
c6045832 | 400 | } |
502ddf23 | 401 | else if (EQ (funcar, Qmacro)) |
ee04dc54 | 402 | return Fdocumentation (Fcdr (fun), raw); |
5b5f6883 KH |
403 | else |
404 | goto oops; | |
405 | } | |
406 | else | |
407 | { | |
408 | oops: | |
2f0a47f9 | 409 | xsignal1 (Qinvalid_function, fun); |
c6045832 | 410 | } |
ee04dc54 | 411 | |
db3534c3 JB |
412 | /* Check for an advised function. Its doc string |
413 | has an `ad-advice-info' text property. */ | |
414 | if (STRINGP (doc)) | |
415 | { | |
416 | Lisp_Object innerfunc; | |
417 | innerfunc = Fget_text_property (make_number (0), | |
418 | intern ("ad-advice-info"), | |
419 | doc); | |
420 | if (! NILP (innerfunc)) | |
421 | doc = call1 (intern ("ad-make-advised-docstring"), innerfunc); | |
422 | } | |
423 | ||
e5aa79fa SM |
424 | /* If DOC is 0, it's typically because of a dumped file missing |
425 | from the DOC file (bug in src/Makefile.in). */ | |
71cdb109 SM |
426 | if (EQ (doc, make_number (0))) |
427 | doc = Qnil; | |
68d8a8e1 | 428 | if (INTEGERP (doc) || CONSP (doc)) |
a154a4ef SM |
429 | { |
430 | Lisp_Object tem; | |
431 | tem = get_doc_string (doc, 0, 0); | |
e5aa79fa | 432 | if (NILP (tem) && try_reload) |
a154a4ef SM |
433 | { |
434 | /* The file is newer, we need to reset the pointers. */ | |
435 | struct gcpro gcpro1, gcpro2; | |
436 | GCPRO2 (function, raw); | |
e5aa79fa | 437 | try_reload = reread_doc_file (Fcar_safe (doc)); |
a154a4ef | 438 | UNGCPRO; |
e5aa79fa SM |
439 | if (try_reload) |
440 | { | |
441 | try_reload = 0; | |
442 | goto documentation; | |
443 | } | |
a154a4ef SM |
444 | } |
445 | else | |
446 | doc = tem; | |
447 | } | |
87afdd65 | 448 | |
956ace37 | 449 | if (NILP (raw)) |
441d75e5 | 450 | doc = Fsubstitute_command_keys (doc); |
ee04dc54 | 451 | return doc; |
c6045832 JB |
452 | } |
453 | ||
f6ee1260 GM |
454 | DEFUN ("documentation-property", Fdocumentation_property, |
455 | Sdocumentation_property, 2, 3, 0, | |
335c5470 PJ |
456 | doc: /* Return the documentation string that is SYMBOL's PROP property. |
457 | Third argument RAW omitted or nil means pass the result through | |
458 | `substitute-command-keys' if it is a string. | |
459 | ||
460 | This differs from `get' in that it can refer to strings stored in the | |
461 | `etc/DOC' file; and that it evaluates documentation properties that | |
462 | aren't strings. */) | |
5842a27b | 463 | (Lisp_Object symbol, Lisp_Object prop, Lisp_Object raw) |
c6045832 | 464 | { |
e5aa79fa | 465 | int try_reload = 1; |
2f0b74ea | 466 | Lisp_Object tem; |
c6045832 | 467 | |
e5aa79fa | 468 | documentation_property: |
177c0ea7 | 469 | |
4acb738e | 470 | tem = Fget (symbol, prop); |
44766095 | 471 | if (EQ (tem, make_number (0))) |
71cdb109 | 472 | tem = Qnil; |
68d8a8e1 | 473 | if (INTEGERP (tem) || (CONSP (tem) && INTEGERP (XCDR (tem)))) |
a154a4ef SM |
474 | { |
475 | Lisp_Object doc = tem; | |
476 | tem = get_doc_string (tem, 0, 0); | |
e5aa79fa | 477 | if (NILP (tem) && try_reload) |
a154a4ef SM |
478 | { |
479 | /* The file is newer, we need to reset the pointers. */ | |
480 | struct gcpro gcpro1, gcpro2, gcpro3; | |
481 | GCPRO3 (symbol, prop, raw); | |
e5aa79fa | 482 | try_reload = reread_doc_file (Fcar_safe (doc)); |
a154a4ef | 483 | UNGCPRO; |
e5aa79fa SM |
484 | if (try_reload) |
485 | { | |
486 | try_reload = 0; | |
487 | goto documentation_property; | |
488 | } | |
a154a4ef SM |
489 | } |
490 | } | |
f6ee1260 GM |
491 | else if (!STRINGP (tem)) |
492 | /* Feval protects its argument. */ | |
a0ee6f27 | 493 | tem = Feval (tem, Qnil); |
177c0ea7 | 494 | |
e6d12642 | 495 | if (NILP (raw) && STRINGP (tem)) |
bbd7d5d3 | 496 | tem = Fsubstitute_command_keys (tem); |
992d176e | 497 | return tem; |
c6045832 JB |
498 | } |
499 | \f | |
283e1184 JB |
500 | /* Scanning the DOC files and placing docstring offsets into functions. */ |
501 | ||
502 | static void | |
971de7fb | 503 | store_function_docstring (Lisp_Object fun, EMACS_INT offset) |
b8ce688b | 504 | /* Use EMACS_INT because we get offset from pointer subtraction. */ |
283e1184 JB |
505 | { |
506 | fun = indirect_function (fun); | |
507 | ||
508 | /* The type determines where the docstring is stored. */ | |
509 | ||
510 | /* Lisp_Subrs have a slot for it. */ | |
e6d12642 | 511 | if (SUBRP (fun)) |
b08a63cc PE |
512 | { |
513 | intptr_t negative_offset = - offset; | |
514 | XSUBR (fun)->doc = (char *) negative_offset; | |
515 | } | |
283e1184 JB |
516 | |
517 | /* If it's a lisp form, stick it in the form. */ | |
518 | else if (CONSP (fun)) | |
519 | { | |
520 | Lisp_Object tem; | |
521 | ||
03699b14 | 522 | tem = XCAR (fun); |
23aba0ea SM |
523 | if (EQ (tem, Qlambda) || EQ (tem, Qautoload) |
524 | || (EQ (tem, Qclosure) && (fun = XCDR (fun), 1))) | |
283e1184 JB |
525 | { |
526 | tem = Fcdr (Fcdr (fun)); | |
03699b14 | 527 | if (CONSP (tem) && INTEGERP (XCAR (tem))) |
d6d23852 | 528 | XSETCAR (tem, make_number (offset)); |
283e1184 JB |
529 | } |
530 | else if (EQ (tem, Qmacro)) | |
03699b14 | 531 | store_function_docstring (XCDR (fun), offset); |
283e1184 JB |
532 | } |
533 | ||
534 | /* Bytecode objects sometimes have slots for it. */ | |
e6d12642 | 535 | else if (COMPILEDP (fun)) |
283e1184 JB |
536 | { |
537 | /* This bytecode object must have a slot for the | |
538 | docstring, since we've found a docstring for it. */ | |
87afdd65 | 539 | if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING) |
3ae565b3 | 540 | ASET (fun, COMPILED_DOC_STRING, make_number (offset)); |
283e1184 JB |
541 | } |
542 | } | |
543 | ||
878bde49 | 544 | static const char buildobj[] = BUILDOBJ; |
283e1184 | 545 | |
c6045832 | 546 | DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation, |
335c5470 | 547 | 1, 1, 0, |
f4e25f94 RS |
548 | doc: /* Used during Emacs initialization to scan the `etc/DOC...' file. |
549 | This searches the `etc/DOC...' file for doc strings and | |
550 | records them in function and variable definitions. | |
551 | The function takes one argument, FILENAME, a string; | |
552 | it specifies the file name (without a directory) of the DOC file. | |
553 | That file is found in `../etc' now; later, when the dumped Emacs is run, | |
98b6690a | 554 | the same file name is found in the `doc-directory'. */) |
5842a27b | 555 | (Lisp_Object filename) |
c6045832 JB |
556 | { |
557 | int fd; | |
558 | char buf[1024 + 1]; | |
84c9ce05 LMI |
559 | register EMACS_INT filled; |
560 | register EMACS_INT pos; | |
a415e694 | 561 | register char *p; |
24109c98 | 562 | Lisp_Object sym; |
c6045832 | 563 | char *name; |
d87a9ab8 | 564 | int skip_file = 0; |
c6045832 | 565 | |
b7826503 | 566 | CHECK_STRING (filename); |
c6045832 | 567 | |
a154a4ef | 568 | if |
c6045832 | 569 | #ifndef CANNOT_DUMP |
a154a4ef | 570 | (!NILP (Vpurify_flag)) |
c6045832 | 571 | #else /* CANNOT_DUMP */ |
a154a4ef | 572 | (0) |
c6045832 | 573 | #endif /* CANNOT_DUMP */ |
a154a4ef | 574 | { |
d5db4077 | 575 | name = (char *) alloca (SCHARS (filename) + 14); |
a154a4ef SM |
576 | strcpy (name, "../etc/"); |
577 | } | |
578 | else | |
579 | { | |
580 | CHECK_STRING (Vdoc_directory); | |
d5db4077 KR |
581 | name = (char *) alloca (SCHARS (filename) |
582 | + SCHARS (Vdoc_directory) + 1); | |
42a5b22f | 583 | strcpy (name, SSDATA (Vdoc_directory)); |
a154a4ef | 584 | } |
42a5b22f | 585 | strcat (name, SSDATA (filename)); /*** Add this line ***/ |
c6045832 | 586 | |
d87a9ab8 JD |
587 | /* Vbuild_files is nil when temacs is run, and non-nil after that. */ |
588 | if (NILP (Vbuild_files)) | |
589 | { | |
878bde49 | 590 | const char *beg, *end; |
d87a9ab8 | 591 | |
878bde49 | 592 | for (beg = buildobj; *beg; beg = end) |
d87a9ab8 | 593 | { |
84c9ce05 | 594 | EMACS_INT len; |
d87a9ab8 JD |
595 | |
596 | while (*beg && isspace (*beg)) ++beg; | |
597 | ||
598 | for (end = beg; *end && ! isspace (*end); ++end) | |
599 | if (*end == '/') beg = end+1; /* skip directory part */ | |
600 | ||
601 | len = end - beg; | |
602 | if (len > 4 && end[-4] == '.' && end[-3] == 'o') | |
603 | len -= 2; /* Just take .o if it ends in .obj */ | |
604 | ||
605 | if (len > 0) | |
606 | Vbuild_files = Fcons (make_string (beg, len), Vbuild_files); | |
607 | } | |
a4ada374 | 608 | Vbuild_files = Fpurecopy (Vbuild_files); |
d87a9ab8 JD |
609 | } |
610 | ||
68c45bf0 | 611 | fd = emacs_open (name, O_RDONLY, 0); |
c6045832 JB |
612 | if (fd < 0) |
613 | report_file_error ("Opening doc string file", | |
614 | Fcons (build_string (name), Qnil)); | |
615 | Vdoc_file_name = filename; | |
616 | filled = 0; | |
617 | pos = 0; | |
618 | while (1) | |
619 | { | |
a415e694 | 620 | register char *end; |
c6045832 | 621 | if (filled < 512) |
68c45bf0 | 622 | filled += emacs_read (fd, &buf[filled], sizeof buf - 1 - filled); |
c6045832 JB |
623 | if (!filled) |
624 | break; | |
625 | ||
626 | buf[filled] = 0; | |
627 | p = buf; | |
628 | end = buf + (filled < 512 ? filled : filled - 128); | |
629 | while (p != end && *p != '\037') p++; | |
983b8302 | 630 | /* p points to ^_Ffunctionname\n or ^_Vvarname\n or ^_Sfilename\n. */ |
c6045832 JB |
631 | if (p != end) |
632 | { | |
8966b757 | 633 | end = strchr (p, '\n'); |
d87a9ab8 JD |
634 | |
635 | /* See if this is a file name, and if it is a file in build-files. */ | |
983b8302 | 636 | if (p[1] == 'S') |
d87a9ab8 | 637 | { |
983b8302 J |
638 | skip_file = 0; |
639 | if (end - p > 4 && end[-2] == '.' | |
640 | && (end[-1] == 'o' || end[-1] == 'c')) | |
641 | { | |
84c9ce05 | 642 | EMACS_INT len = end - p - 2; |
983b8302 J |
643 | char *fromfile = alloca (len + 1); |
644 | strncpy (fromfile, &p[2], len); | |
645 | fromfile[len] = 0; | |
646 | if (fromfile[len-1] == 'c') | |
647 | fromfile[len-1] = 'o'; | |
648 | ||
649 | skip_file = NILP (Fmember (build_string (fromfile), | |
650 | Vbuild_files)); | |
651 | } | |
d87a9ab8 JD |
652 | } |
653 | ||
141199d1 | 654 | sym = oblookup (Vobarray, p + 2, |
9eee99eb PE |
655 | multibyte_chars_in_text ((unsigned char *) p + 2, |
656 | end - p - 2), | |
141199d1 | 657 | end - p - 2); |
11fb4bdb SM |
658 | /* Check skip_file so that when a function is defined several |
659 | times in different files (typically, once in xterm, once in | |
660 | w32term, ...), we only pay attention to the one that | |
661 | matters. */ | |
d87a9ab8 | 662 | if (! skip_file && SYMBOLP (sym)) |
c6045832 JB |
663 | { |
664 | /* Attach a docstring to a variable? */ | |
665 | if (p[1] == 'V') | |
666 | { | |
667 | /* Install file-position as variable-documentation property | |
668 | and make it negative for a user-variable | |
669 | (doc starts with a `*'). */ | |
670 | Fput (sym, Qvariable_documentation, | |
671 | make_number ((pos + end + 1 - buf) | |
672 | * (end[1] == '*' ? -1 : 1))); | |
673 | } | |
674 | ||
283e1184 | 675 | /* Attach a docstring to a function? */ |
c6045832 | 676 | else if (p[1] == 'F') |
283e1184 JB |
677 | store_function_docstring (sym, pos + end + 1 - buf); |
678 | ||
6b61353c KH |
679 | else if (p[1] == 'S') |
680 | ; /* Just a source file name boundary marker. Ignore it. */ | |
681 | ||
283e1184 | 682 | else |
c2982e87 | 683 | error ("DOC file invalid at position %"pI"d", pos); |
c6045832 JB |
684 | } |
685 | } | |
686 | pos += end - buf; | |
687 | filled -= end - buf; | |
840b985a | 688 | memmove (buf, end, filled); |
c6045832 | 689 | } |
68c45bf0 | 690 | emacs_close (fd); |
c6045832 JB |
691 | return Qnil; |
692 | } | |
693 | \f | |
a7ca3326 | 694 | DEFUN ("substitute-command-keys", Fsubstitute_command_keys, |
335c5470 PJ |
695 | Ssubstitute_command_keys, 1, 1, 0, |
696 | doc: /* Substitute key descriptions for command names in STRING. | |
c698360f KS |
697 | Substrings of the form \\=\\[COMMAND] replaced by either: a keystroke |
698 | sequence that will invoke COMMAND, or "M-x COMMAND" if COMMAND is not | |
699 | on any keys. | |
335c5470 | 700 | Substrings of the form \\=\\{MAPVAR} are replaced by summaries |
04bf6783 | 701 | \(made by `describe-bindings') of the value of MAPVAR, taken as a keymap. |
335c5470 PJ |
702 | Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR |
703 | as the keymap for future \\=\\[COMMAND] substrings. | |
704 | \\=\\= quotes the following character and is discarded; | |
c698360f KS |
705 | thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. |
706 | ||
2610bf68 | 707 | Returns original STRING if no substitutions were made. Otherwise, |
c698360f | 708 | a new string, without any text properties, is returned. */) |
5842a27b | 709 | (Lisp_Object string) |
c6045832 | 710 | { |
9eee99eb | 711 | char *buf; |
c6045832 JB |
712 | int changed = 0; |
713 | register unsigned char *strp; | |
9eee99eb | 714 | register char *bufp; |
3d0c92a2 PE |
715 | ptrdiff_t idx; |
716 | ptrdiff_t bsize; | |
665d3046 | 717 | Lisp_Object tem; |
c6045832 JB |
718 | Lisp_Object keymap; |
719 | unsigned char *start; | |
3d0c92a2 | 720 | ptrdiff_t length, length_byte; |
665d3046 JB |
721 | Lisp_Object name; |
722 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; | |
141199d1 | 723 | int multibyte; |
3d0c92a2 | 724 | ptrdiff_t nchars; |
c6045832 | 725 | |
4acb738e | 726 | if (NILP (string)) |
c6045832 JB |
727 | return Qnil; |
728 | ||
b7826503 | 729 | CHECK_STRING (string); |
665d3046 JB |
730 | tem = Qnil; |
731 | keymap = Qnil; | |
732 | name = Qnil; | |
4acb738e | 733 | GCPRO4 (string, tem, keymap, name); |
c6045832 | 734 | |
141199d1 RS |
735 | multibyte = STRING_MULTIBYTE (string); |
736 | nchars = 0; | |
737 | ||
9a425dcb RS |
738 | /* KEYMAP is either nil (which means search all the active keymaps) |
739 | or a specified local map (which means search just that and the | |
740 | global map). If non-nil, it might come from Voverriding_local_map, | |
4acb738e | 741 | or from a \\<mapname> construct in STRING itself.. */ |
1344aad4 | 742 | keymap = KVAR (current_kboard, Voverriding_terminal_local_map); |
f73d1163 KH |
743 | if (NILP (keymap)) |
744 | keymap = Voverriding_local_map; | |
c6045832 | 745 | |
d5db4077 | 746 | bsize = SBYTES (string); |
9eee99eb | 747 | bufp = buf = (char *) xmalloc (bsize); |
c6045832 | 748 | |
8a7bde3e | 749 | strp = SDATA (string); |
d5db4077 | 750 | while (strp < SDATA (string) + SBYTES (string)) |
c6045832 JB |
751 | { |
752 | if (strp[0] == '\\' && strp[1] == '=') | |
753 | { | |
754 | /* \= quotes the next character; | |
755 | thus, to put in \[ without its special meaning, use \=\[. */ | |
756 | changed = 1; | |
141199d1 RS |
757 | strp += 2; |
758 | if (multibyte) | |
759 | { | |
760 | int len; | |
141199d1 | 761 | |
62a6e103 | 762 | STRING_CHAR_AND_LENGTH (strp, len); |
141199d1 RS |
763 | if (len == 1) |
764 | *bufp = *strp; | |
765 | else | |
72af86bd | 766 | memcpy (bufp, strp, len); |
141199d1 RS |
767 | strp += len; |
768 | bufp += len; | |
769 | nchars++; | |
770 | } | |
771 | else | |
772 | *bufp++ = *strp++, nchars++; | |
c6045832 JB |
773 | } |
774 | else if (strp[0] == '\\' && strp[1] == '[') | |
775 | { | |
3d0c92a2 | 776 | ptrdiff_t start_idx; |
a1d3a188 | 777 | int follow_remap = 1; |
b6c53774 | 778 | |
c6045832 JB |
779 | changed = 1; |
780 | strp += 2; /* skip \[ */ | |
781 | start = strp; | |
d5db4077 | 782 | start_idx = start - SDATA (string); |
c6045832 | 783 | |
8a7bde3e | 784 | while ((strp - SDATA (string) |
d5db4077 | 785 | < SBYTES (string)) |
c6045832 JB |
786 | && *strp != ']') |
787 | strp++; | |
141199d1 RS |
788 | length_byte = strp - start; |
789 | ||
c6045832 JB |
790 | strp++; /* skip ] */ |
791 | ||
792 | /* Save STRP in IDX. */ | |
8a7bde3e | 793 | idx = strp - SDATA (string); |
9eee99eb | 794 | name = Fintern (make_string ((char *) start, length_byte), Qnil); |
11f9d6e1 | 795 | |
a1d3a188 | 796 | do_remap: |
a88a5372 | 797 | tem = Fwhere_is_internal (name, keymap, Qt, Qnil, Qnil); |
332e51c1 | 798 | |
77b37c05 | 799 | if (VECTORP (tem) && ASIZE (tem) > 1 |
a1d3a188 KS |
800 | && EQ (AREF (tem, 0), Qremap) && SYMBOLP (AREF (tem, 1)) |
801 | && follow_remap) | |
802 | { | |
803 | name = AREF (tem, 1); | |
804 | follow_remap = 0; | |
805 | goto do_remap; | |
806 | } | |
807 | ||
11f9d6e1 GM |
808 | /* Note the Fwhere_is_internal can GC, so we have to take |
809 | relocation of string contents into account. */ | |
d5db4077 KR |
810 | strp = SDATA (string) + idx; |
811 | start = SDATA (string) + start_idx; | |
c6045832 | 812 | |
265a9e55 | 813 | if (NILP (tem)) /* but not on any keys */ |
c6045832 | 814 | { |
3d0c92a2 PE |
815 | ptrdiff_t offset = bufp - buf; |
816 | if (STRING_BYTES_BOUND - 4 < bsize) | |
817 | string_overflow (); | |
9eee99eb | 818 | buf = (char *) xrealloc (buf, bsize += 4); |
8d17fe0b | 819 | bufp = buf + offset; |
72af86bd | 820 | memcpy (bufp, "M-x ", 4); |
c6045832 | 821 | bufp += 4; |
141199d1 RS |
822 | nchars += 4; |
823 | if (multibyte) | |
824 | length = multibyte_chars_in_text (start, length_byte); | |
825 | else | |
826 | length = length_byte; | |
c6045832 JB |
827 | goto subst; |
828 | } | |
829 | else | |
830 | { /* function is on a key */ | |
a1bfe073 | 831 | tem = Fkey_description (tem, Qnil); |
c6045832 JB |
832 | goto subst_string; |
833 | } | |
834 | } | |
835 | /* \{foo} is replaced with a summary of the keymap (symbol-value foo). | |
836 | \<foo> just sets the keymap used for \[cmd]. */ | |
837 | else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<')) | |
838 | { | |
839 | struct buffer *oldbuf; | |
3d0c92a2 | 840 | ptrdiff_t start_idx; |
e679a3c1 | 841 | /* This is for computing the SHADOWS arg for describe_map_tree. */ |
9a51747b | 842 | Lisp_Object active_maps = Fcurrent_active_maps (Qnil, Qnil); |
e679a3c1 | 843 | Lisp_Object earlier_maps; |
c6045832 JB |
844 | |
845 | changed = 1; | |
846 | strp += 2; /* skip \{ or \< */ | |
847 | start = strp; | |
d5db4077 | 848 | start_idx = start - SDATA (string); |
c6045832 | 849 | |
ccddfb9e | 850 | while ((strp - SDATA (string) < SBYTES (string)) |
c6045832 JB |
851 | && *strp != '}' && *strp != '>') |
852 | strp++; | |
141199d1 RS |
853 | |
854 | length_byte = strp - start; | |
c6045832 JB |
855 | strp++; /* skip } or > */ |
856 | ||
857 | /* Save STRP in IDX. */ | |
8a7bde3e | 858 | idx = strp - SDATA (string); |
c6045832 JB |
859 | |
860 | /* Get the value of the keymap in TEM, or nil if undefined. | |
861 | Do this while still in the user's current buffer | |
862 | in case it is a local variable. */ | |
9eee99eb | 863 | name = Fintern (make_string ((char *) start, length_byte), Qnil); |
c6045832 | 864 | tem = Fboundp (name); |
265a9e55 | 865 | if (! NILP (tem)) |
c6045832 JB |
866 | { |
867 | tem = Fsymbol_value (name); | |
265a9e55 | 868 | if (! NILP (tem)) |
11f9d6e1 | 869 | { |
02067692 SM |
870 | tem = get_keymap (tem, 0, 1); |
871 | /* Note that get_keymap can GC. */ | |
d5db4077 KR |
872 | strp = SDATA (string) + idx; |
873 | start = SDATA (string) + start_idx; | |
11f9d6e1 | 874 | } |
c6045832 JB |
875 | } |
876 | ||
877 | /* Now switch to a temp buffer. */ | |
878 | oldbuf = current_buffer; | |
879 | set_buffer_internal (XBUFFER (Vprin1_to_string_buffer)); | |
880 | ||
265a9e55 | 881 | if (NILP (tem)) |
c6045832 JB |
882 | { |
883 | name = Fsymbol_name (name); | |
884 | insert_string ("\nUses keymap \""); | |
141199d1 | 885 | insert_from_string (name, 0, 0, |
d5db4077 KR |
886 | SCHARS (name), |
887 | SBYTES (name), 1); | |
c6045832 JB |
888 | insert_string ("\", which is not currently defined.\n"); |
889 | if (start[-1] == '<') keymap = Qnil; | |
890 | } | |
891 | else if (start[-1] == '<') | |
892 | keymap = tem; | |
893 | else | |
e679a3c1 RS |
894 | { |
895 | /* Get the list of active keymaps that precede this one. | |
896 | If this one's not active, get nil. */ | |
897 | earlier_maps = Fcdr (Fmemq (tem, Freverse (active_maps))); | |
898 | describe_map_tree (tem, 1, Fnreverse (earlier_maps), | |
899 | Qnil, (char *)0, 1, 0, 0, 1); | |
900 | } | |
c6045832 JB |
901 | tem = Fbuffer_string (); |
902 | Ferase_buffer (); | |
903 | set_buffer_internal (oldbuf); | |
904 | ||
905 | subst_string: | |
d5db4077 KR |
906 | start = SDATA (tem); |
907 | length = SCHARS (tem); | |
908 | length_byte = SBYTES (tem); | |
c6045832 | 909 | subst: |
8d17fe0b | 910 | { |
3d0c92a2 PE |
911 | ptrdiff_t offset = bufp - buf; |
912 | if (STRING_BYTES_BOUND - length_byte < bsize) | |
913 | string_overflow (); | |
9eee99eb | 914 | buf = (char *) xrealloc (buf, bsize += length_byte); |
8d17fe0b | 915 | bufp = buf + offset; |
72af86bd | 916 | memcpy (bufp, start, length_byte); |
8d17fe0b GM |
917 | bufp += length_byte; |
918 | nchars += length; | |
919 | /* Check STRING again in case gc relocated it. */ | |
51b59d79 | 920 | strp = SDATA (string) + idx; |
8d17fe0b | 921 | } |
c6045832 | 922 | } |
141199d1 RS |
923 | else if (! multibyte) /* just copy other chars */ |
924 | *bufp++ = *strp++, nchars++; | |
925 | else | |
926 | { | |
927 | int len; | |
141199d1 | 928 | |
62a6e103 | 929 | STRING_CHAR_AND_LENGTH (strp, len); |
141199d1 RS |
930 | if (len == 1) |
931 | *bufp = *strp; | |
932 | else | |
72af86bd | 933 | memcpy (bufp, strp, len); |
141199d1 RS |
934 | strp += len; |
935 | bufp += len; | |
936 | nchars++; | |
937 | } | |
c6045832 JB |
938 | } |
939 | ||
940 | if (changed) /* don't bother if nothing substituted */ | |
cc5bf9eb | 941 | tem = make_string_from_bytes (buf, nchars, bufp - buf); |
c6045832 | 942 | else |
4acb738e | 943 | tem = string; |
9ac0d9e0 | 944 | xfree (buf); |
665d3046 | 945 | RETURN_UNGCPRO (tem); |
c6045832 JB |
946 | } |
947 | \f | |
dfcf069d | 948 | void |
971de7fb | 949 | syms_of_doc (void) |
c6045832 | 950 | { |
cd3520a4 | 951 | DEFSYM (Qfunction_documentation, "function-documentation"); |
177c0ea7 | 952 | |
29208e82 | 953 | DEFVAR_LISP ("internal-doc-file-name", Vdoc_file_name, |
335c5470 | 954 | doc: /* Name of file containing documentation strings of built-in symbols. */); |
c6045832 JB |
955 | Vdoc_file_name = Qnil; |
956 | ||
29208e82 | 957 | DEFVAR_LISP ("build-files", Vbuild_files, |
d87a9ab8 JD |
958 | doc: /* A list of files used to build this Emacs binary. */); |
959 | Vbuild_files = Qnil; | |
960 | ||
c6045832 JB |
961 | defsubr (&Sdocumentation); |
962 | defsubr (&Sdocumentation_property); | |
963 | defsubr (&Ssnarf_documentation); | |
964 | defsubr (&Ssubstitute_command_keys); | |
965 | } |