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