1 /* Record indices of function doc strings stored in a file.
2 Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 1, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
23 #include <sys/types.h>
24 #include <sys/file.h> /* Must be after sys/types.h for USG and BSD4_1*/
37 Lisp_Object Vdoc_file_name
;
40 get_doc_string (filepos
)
43 char buf
[512 * 32 + 1];
46 register char *p
, *p1
;
48 extern char *index ();
50 if (XTYPE (Vdata_directory
) != Lisp_String
51 || XTYPE (Vdoc_file_name
) != Lisp_String
)
54 name
= (char *) alloca (XSTRING (Vdata_directory
)->size
55 + XSTRING (Vdoc_file_name
)->size
+ 8);
56 strcpy (name
, XSTRING (Vdata_directory
)->data
);
57 strcat (name
, XSTRING (Vdoc_file_name
)->data
);
60 /* For VMS versions with limited file name syntax,
61 convert the name to something VMS will allow. */
69 #endif /* not VMS4_4 */
71 strcpy (name
, sys_translate_unix (name
));
75 fd
= open (name
, O_RDONLY
, 0);
77 error ("Cannot open doc string file \"%s\"", name
);
78 if (0 > lseek (fd
, filepos
, 0))
81 error ("Position %ld out of range in doc string file \"%s\"",
85 while (p
!= buf
+ sizeof buf
- 1)
87 count
= read (fd
, p
, 512);
91 p1
= index (p
, '\037');
101 return make_string (buf
, p
- buf
);
104 DEFUN ("documentation", Fdocumentation
, Sdocumentation
, 1, 2, 0,
105 "Return the documentation string of FUNCTION.\n\
106 Unless a non-nil second argument is given, the\n\
107 string is passed through `substitute-command-keys'.")
109 Lisp_Object function
, raw
;
113 Lisp_Object tem
, doc
;
115 fun
= Findirect_function (function
);
120 if (XSUBR (fun
)->doc
== 0) return Qnil
;
121 if ((int) XSUBR (fun
)->doc
>= 0)
122 doc
= build_string (XSUBR (fun
)->doc
);
124 doc
= get_doc_string (- (int) XSUBR (fun
)->doc
);
128 if (XVECTOR (fun
)->size
<= COMPILED_DOC_STRING
)
130 tem
= XVECTOR (fun
)->contents
[COMPILED_DOC_STRING
];
131 if (XTYPE (tem
) == Lisp_String
)
133 else if (XTYPE (tem
) == Lisp_Int
&& XINT (tem
) >= 0)
134 doc
= get_doc_string (XFASTINT (tem
));
141 return build_string ("Keyboard macro.");
145 if (XTYPE (funcar
) != Lisp_Symbol
)
146 return Fsignal (Qinvalid_function
, Fcons (fun
, Qnil
));
147 else if (EQ (funcar
, Qkeymap
))
148 return build_string ("Prefix command (definition is a keymap associating keystrokes with\n\
150 else if (EQ (funcar
, Qlambda
)
151 || EQ (funcar
, Qautoload
))
153 tem
= Fcar (Fcdr (Fcdr (fun
)));
154 if (XTYPE (tem
) == Lisp_String
)
156 else if (XTYPE (tem
) == Lisp_Int
&& XINT (tem
) >= 0)
157 doc
= get_doc_string (XFASTINT (tem
));
163 else if (EQ (funcar
, Qmocklisp
))
165 else if (EQ (funcar
, Qmacro
))
166 return Fdocumentation (Fcdr (fun
), raw
);
168 /* Fall through to the default to report an error. */
171 return Fsignal (Qinvalid_function
, Fcons (fun
, Qnil
));
175 doc
= Fsubstitute_command_keys (doc
);
179 DEFUN ("documentation-property", Fdocumentation_property
, Sdocumentation_property
, 2, 2, 0,
180 "Return the documentation string that is SYMBOL's PROP property.\n\
181 This is like `get', but it can refer to strings stored in the\n\
182 `etc/DOC' file; and if the value is a string, it is passed through\n\
183 `substitute-command-keys'. A non-nil third argument avoids this\n\
186 Lisp_Object sym
, prop
, raw
;
188 register Lisp_Object tem
;
190 tem
= Fget (sym
, prop
);
191 if (XTYPE (tem
) == Lisp_Int
)
192 tem
= get_doc_string (XINT (tem
) > 0 ? XINT (tem
) : - XINT (tem
));
193 if (NILP (raw
) && XTYPE (tem
) == Lisp_String
)
194 return Fsubstitute_command_keys (tem
);
198 DEFUN ("Snarf-documentation", Fsnarf_documentation
, Ssnarf_documentation
,
200 "Used during Emacs initialization, before dumping runnable Emacs,\n\
201 to find pointers to doc strings stored in `etc/DOC...' and\n\
202 record them in function definitions.\n\
203 One arg, FILENAME, a string which does not include a directory.\n\
204 The file is found in `../etc' now; found in the `data-directory'\n\
205 when doc strings are referred to later in the dumped Emacs.")
207 Lisp_Object filename
;
213 register char *p
, *end
;
214 Lisp_Object sym
, fun
, tem
;
216 extern char *index ();
219 if (NILP (Vpurify_flag
))
220 error ("Snarf-documentation can only be called in an undumped Emacs");
223 CHECK_STRING (filename
, 0);
226 name
= (char *) alloca (XSTRING (filename
)->size
+ 14);
227 strcpy (name
, "../etc/");
228 #else /* CANNOT_DUMP */
229 CHECK_STRING (Vdata_directory
, 0);
230 name
= (char *) alloca (XSTRING (filename
)->size
+
231 XSTRING (Vdata_directory
)->size
+ 1);
232 strcpy (name
, XSTRING (Vdata_directory
)->data
);
233 #endif /* CANNOT_DUMP */
234 strcat (name
, XSTRING (filename
)->data
); /*** Add this line ***/
237 /* For VMS versions with limited file name syntax,
238 convert the name to something VMS will allow. */
246 #endif /* not VMS4_4 */
248 strcpy (name
, sys_translate_unix (name
));
252 fd
= open (name
, O_RDONLY
, 0);
254 report_file_error ("Opening doc string file",
255 Fcons (build_string (name
), Qnil
));
256 Vdoc_file_name
= filename
;
262 filled
+= read (fd
, &buf
[filled
], sizeof buf
- 1 - filled
);
268 end
= buf
+ (filled
< 512 ? filled
: filled
- 128);
269 while (p
!= end
&& *p
!= '\037') p
++;
270 /* p points to ^_Ffunctionname\n or ^_Vvarname\n. */
273 end
= index (p
, '\n');
274 sym
= oblookup (Vobarray
, p
+ 2, end
- p
- 2);
275 if (XTYPE (sym
) == Lisp_Symbol
)
277 /* Attach a docstring to a variable? */
280 /* Install file-position as variable-documentation property
281 and make it negative for a user-variable
282 (doc starts with a `*'). */
283 Fput (sym
, Qvariable_documentation
,
284 make_number ((pos
+ end
+ 1 - buf
)
285 * (end
[1] == '*' ? -1 : 1)));
288 /* Attach a docstring to a function? The type determines where
289 the docstring is stored. */
290 else if (p
[1] == 'F')
292 fun
= XSYMBOL (sym
)->function
;
294 /* Lisp_Subrs have a slot for it. */
295 if (XTYPE (fun
) == Lisp_Subr
)
296 XSUBR (fun
)->doc
= (char *) - (pos
+ end
+ 1 - buf
);
298 /* If it's a lisp form, stick it in the form. */
299 else if (CONSP (fun
))
301 tem
= XCONS (fun
)->car
;
302 if (EQ (tem
, Qlambda
) || EQ (tem
, Qautoload
))
304 tem
= Fcdr (Fcdr (fun
));
306 XTYPE (XCONS (tem
)->car
) == Lisp_Int
)
307 XFASTINT (XCONS (tem
)->car
) = (pos
+ end
+ 1 - buf
);
311 /* Bytecode objects sometimes have slots for it. */
312 else if (XTYPE (fun
) == Lisp_Compiled
)
314 /* This bytecode object must have a slot for the
315 docstring, since we've found a docstring for it. */
316 if (XVECTOR (fun
)->size
<= COMPILED_DOC_STRING
)
319 XFASTINT (XVECTOR (fun
)->contents
[COMPILED_DOC_STRING
])
320 = pos
+ end
+ 1 - buf
;
323 else error ("DOC file invalid at position %d", pos
);
328 bcopy (end
, buf
, filled
);
334 DEFUN ("substitute-command-keys", Fsubstitute_command_keys
,
335 Ssubstitute_command_keys
, 1, 1, 0,
336 "Substitute key descriptions for command names in STRING.\n\
337 Return a new string which is STRING with substrings of the form \\=\\[COMMAND]\n\
338 replaced by either: a keystroke sequence that will invoke COMMAND,\n\
339 or \"M-x COMMAND\" if COMMAND is not on any keys.\n\
340 Substrings of the form \\=\\{MAPVAR} are replaced by summaries\n\
341 \(made by describe-bindings) of the value of MAPVAR, taken as a keymap.\n\
342 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR\n\
343 as the keymap for future \\=\\[COMMAND] substrings.\n\
344 \\=\\= quotes the following character and is discarded;\n\
345 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.")
351 register unsigned char *strp
;
352 register unsigned char *bufp
;
356 register Lisp_Object tem
;
358 unsigned char *start
;
365 CHECK_STRING (str
, 0);
368 keymap
= current_buffer
->keymap
;
370 bsize
= XSTRING (str
)->size
;
371 bufp
= buf
= (unsigned char *) xmalloc (bsize
);
373 strp
= (unsigned char *) XSTRING (str
)->data
;
374 while (strp
< (unsigned char *) XSTRING (str
)->data
+ XSTRING (str
)->size
)
376 if (strp
[0] == '\\' && strp
[1] == '=')
378 /* \= quotes the next character;
379 thus, to put in \[ without its special meaning, use \=\[. */
384 else if (strp
[0] == '\\' && strp
[1] == '[')
387 strp
+= 2; /* skip \[ */
390 while ((strp
- (unsigned char *) XSTRING (str
)->data
391 < XSTRING (str
)->size
)
394 length
= strp
- start
;
397 /* Save STRP in IDX. */
398 idx
= strp
- (unsigned char *) XSTRING (str
)->data
;
399 tem
= Fintern (make_string (start
, length
), Qnil
);
400 tem
= Fwhere_is_internal (tem
, keymap
, Qnil
, Qt
, Qnil
);
402 if (NILP (tem
)) /* but not on any keys */
404 new = (unsigned char *) xrealloc (buf
, bsize
+= 4);
407 bcopy ("M-x ", bufp
, 4);
412 { /* function is on a key */
413 tem
= Fkey_description (tem
);
417 /* \{foo} is replaced with a summary of the keymap (symbol-value foo).
418 \<foo> just sets the keymap used for \[cmd]. */
419 else if (strp
[0] == '\\' && (strp
[1] == '{' || strp
[1] == '<'))
421 struct buffer
*oldbuf
;
425 strp
+= 2; /* skip \{ or \< */
428 while ((strp
- (unsigned char *) XSTRING (str
)->data
429 < XSTRING (str
)->size
)
430 && *strp
!= '}' && *strp
!= '>')
432 length
= strp
- start
;
433 strp
++; /* skip } or > */
435 /* Save STRP in IDX. */
436 idx
= strp
- (unsigned char *) XSTRING (str
)->data
;
438 /* Get the value of the keymap in TEM, or nil if undefined.
439 Do this while still in the user's current buffer
440 in case it is a local variable. */
441 name
= Fintern (make_string (start
, length
), Qnil
);
442 tem
= Fboundp (name
);
445 tem
= Fsymbol_value (name
);
447 tem
= get_keymap_1 (tem
, 0);
450 /* Now switch to a temp buffer. */
451 oldbuf
= current_buffer
;
452 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
456 name
= Fsymbol_name (name
);
457 insert_string ("\nUses keymap \"");
458 insert_from_string (name
, 0, XSTRING (name
)->size
);
459 insert_string ("\", which is not currently defined.\n");
460 if (start
[-1] == '<') keymap
= Qnil
;
462 else if (start
[-1] == '<')
465 describe_map_tree (tem
, 1, Qnil
);
466 tem
= Fbuffer_string ();
468 set_buffer_internal (oldbuf
);
471 start
= XSTRING (tem
)->data
;
472 length
= XSTRING (tem
)->size
;
474 new = (unsigned char *) xrealloc (buf
, bsize
+= length
);
477 bcopy (start
, bufp
, length
);
479 /* Check STR again in case gc relocated it. */
480 strp
= (unsigned char *) XSTRING (str
)->data
+ idx
;
482 else /* just copy other chars */
486 if (changed
) /* don't bother if nothing substituted */
487 tem
= make_string (buf
, bufp
- buf
);
497 DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name
,
498 "Name of file containing documentation strings of built-in symbols.");
499 Vdoc_file_name
= Qnil
;
501 defsubr (&Sdocumentation
);
502 defsubr (&Sdocumentation_property
);
503 defsubr (&Ssnarf_documentation
);
504 defsubr (&Ssubstitute_command_keys
);