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