/* Record indices of function doc strings stored in a file.
- Copyright (C) 1985, 86,93,94,95,97,98, 1999 Free Software Foundation, Inc.
+ Copyright (C) 1985, 86,93,94,95,97,98,99, 2000 Free Software Foundation, Inc.
This file is part of GNU Emacs.
#include "keyboard.h"
#include "charset.h"
-Lisp_Object Vdoc_file_name;
+#ifdef HAVE_INDEX
+extern char *index P_ ((const char *, int));
+#endif
+
+Lisp_Object Vdoc_file_name, Vhelp_manyarg_func_alist;
-extern char *index ();
+Lisp_Object Qfunction_documentation;
extern Lisp_Object Voverriding_local_map;
if (!nread)
break;
if (p == get_doc_string_buffer)
- p1 = index (p + offset, '\037');
+ p1 = (char *) index (p + offset, '\037');
else
- p1 = index (p, '\037');
+ p1 = (char *) index (p, '\037');
if (p1)
{
*p1 = 0;
Lisp_Object funcar;
Lisp_Object tem, doc;
+ doc = Qnil;
+
+ if (SYMBOLP (function)
+ && (tem = Fget (function, Qfunction_documentation),
+ !NILP (tem)))
+ return Fdocumentation_property (function, Qfunction_documentation, raw);
+
fun = Findirect_function (function);
-
if (SUBRP (fun))
{
- if (XSUBR (fun)->doc == 0) return Qnil;
- if ((EMACS_INT) XSUBR (fun)->doc >= 0)
+ if (XSUBR (fun)->doc == 0)
+ return Qnil;
+ else if ((EMACS_INT) XSUBR (fun)->doc >= 0)
doc = build_string (XSUBR (fun)->doc);
else
doc = get_doc_string (make_number (- (EMACS_INT) XSUBR (fun)->doc),
0, 0);
+ if (! NILP (tem = Fassq (function, Vhelp_manyarg_func_alist)))
+ doc = concat3 (doc, build_string ("\n"), Fcdr (tem));
}
else if (COMPILEDP (fun))
{
}
if (NILP (raw))
- {
- struct gcpro gcpro1;
-
- GCPRO1 (doc);
- doc = Fsubstitute_command_keys (doc);
- UNGCPRO;
- }
+ doc = Fsubstitute_command_keys (doc);
return doc;
}
-DEFUN ("documentation-property", Fdocumentation_property, Sdocumentation_property, 2, 3, 0,
+DEFUN ("documentation-property", Fdocumentation_property,
+ Sdocumentation_property, 2, 3, 0,
"Return the documentation string that is SYMBOL's PROP property.\n\
-This is like `get', but it can refer to strings stored in the\n\
-`etc/DOC' file; and if the value is a string, it is passed through\n\
-`substitute-command-keys'. A non-nil third argument RAW avoids this\n\
-translation.")
+Third argument RAW omitted or nil means pass the result through\n\
+`substitute-command-keys' if it is a string.\n\
+\n\
+This is differs from `get' in that it can refer to strings stored in the\n\
+`etc/DOC' file; and that it evaluates documentation properties that\n\
+aren't strings.")
(symbol, prop, raw)
Lisp_Object symbol, prop, raw;
{
tem = Fget (symbol, prop);
if (INTEGERP (tem))
tem = get_doc_string (XINT (tem) > 0 ? tem : make_number (- XINT (tem)), 0, 0);
- else if (CONSP (tem))
+ else if (CONSP (tem) && INTEGERP (XCDR (tem)))
tem = get_doc_string (tem, 0, 0);
+ else if (!STRINGP (tem))
+ /* Feval protects its argument. */
+ tem = Feval (tem);
+
if (NILP (raw) && STRINGP (tem))
- {
- struct gcpro gcpro1;
-
- GCPRO1 (tem);
- return Fsubstitute_command_keys (tem);
- UNGCPRO;
- }
+ tem = Fsubstitute_command_keys (tem);
return tem;
}
\f
register int filled;
register int pos;
register char *p, *end;
- Lisp_Object sym, fun, tem;
+ Lisp_Object sym;
char *name;
- extern char *index ();
#ifndef CANNOT_DUMP
if (NILP (Vpurify_flag))
/* p points to ^_Ffunctionname\n or ^_Vvarname\n. */
if (p != end)
{
- end = index (p, '\n');
+ end = (char *) index (p, '\n');
sym = oblookup (Vobarray, p + 2,
multibyte_chars_in_text (p + 2, end - p - 2),
end - p - 2);
register unsigned char *bufp;
int idx;
int bsize;
- unsigned char *new;
Lisp_Object tem;
Lisp_Object keymap;
unsigned char *start;
else if (strp[0] == '\\' && strp[1] == '[')
{
Lisp_Object firstkey;
+ int start_idx;
changed = 1;
strp += 2; /* skip \[ */
start = strp;
+ start_idx = start - XSTRING (string)->data;
while ((strp - (unsigned char *) XSTRING (string)->data
< STRING_BYTES (XSTRING (string)))
/* Save STRP in IDX. */
idx = strp - (unsigned char *) XSTRING (string)->data;
tem = Fintern (make_string (start, length_byte), Qnil);
+
+ /* Note the Fwhere_is_internal can GC, so we have to take
+ relocation of string contents into account. */
tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);
+ strp = XSTRING (string)->data + idx;
+ start = XSTRING (string)->data + start_idx;
/* Disregard menu bar bindings; it is positively annoying to
mention them when there's no menu bar, and it isn't terribly
if (NILP (tem)) /* but not on any keys */
{
- new = (unsigned char *) xrealloc (buf, bsize += 4);
- bufp += new - buf;
- buf = new;
+ int offset = bufp - buf;
+ buf = (unsigned char *) xrealloc (buf, bsize += 4);
+ bufp = buf + offset;
bcopy ("M-x ", bufp, 4);
bufp += 4;
nchars += 4;
else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<'))
{
struct buffer *oldbuf;
+ int start_idx;
changed = 1;
strp += 2; /* skip \{ or \< */
start = strp;
+ start_idx = start - XSTRING (string)->data;
while ((strp - (unsigned char *) XSTRING (string)->data
< XSTRING (string)->size)
{
tem = Fsymbol_value (name);
if (! NILP (tem))
- tem = get_keymap_1 (tem, 0, 1);
+ {
+ tem = get_keymap (tem, 0, 1);
+ /* Note that get_keymap can GC. */
+ strp = XSTRING (string)->data + idx;
+ start = XSTRING (string)->data + start_idx;
+ }
}
/* Now switch to a temp buffer. */
length = XSTRING (tem)->size;
length_byte = STRING_BYTES (XSTRING (tem));
subst:
- new = (unsigned char *) xrealloc (buf, bsize += length_byte);
- bufp += new - buf;
- buf = new;
- bcopy (start, bufp, length_byte);
- bufp += length_byte;
- nchars += length;
- /* Check STRING again in case gc relocated it. */
- strp = (unsigned char *) XSTRING (string)->data + idx;
+ {
+ int offset = bufp - buf;
+ buf = (unsigned char *) xrealloc (buf, bsize += length_byte);
+ bufp = buf + offset;
+ bcopy (start, bufp, length_byte);
+ bufp += length_byte;
+ nchars += length;
+ /* Check STRING again in case gc relocated it. */
+ strp = (unsigned char *) XSTRING (string)->data + idx;
+ }
}
else if (! multibyte) /* just copy other chars */
*bufp++ = *strp++, nchars++;
void
syms_of_doc ()
{
+ Qfunction_documentation = intern ("function-documentation");
+ staticpro (&Qfunction_documentation);
+
DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name,
"Name of file containing documentation strings of built-in symbols.");
Vdoc_file_name = Qnil;
+ DEFVAR_LISP ("help-manyarg-func-alist", &Vhelp_manyarg_func_alist,
+ "Alist of primitive functions and descriptions of their arg lists.\n\
+All special forms and primitives which effectively have &rest args\n\
+should have an entry here so that `documentation' can provide their\n\
+arg list.");
+ Vhelp_manyarg_func_alist = Qnil;
defsubr (&Sdocumentation);
defsubr (&Sdocumentation_property);