/* Record indices of function doc strings stored in a file.
- Copyright (C) 1985, 1986 Free Software Foundation, Inc.
+ Copyright (C) 1985, 1986, 1993 Free Software Foundation, Inc.
This file is part of GNU Emacs.
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
-#include "config.h"
+#include <config.h>
#include <sys/types.h>
#include <sys/file.h> /* Must be after sys/types.h for USG and BSD4_1*/
#define O_RDONLY 0
#endif
-#undef NULL
#include "lisp.h"
#include "buffer.h"
+#include "keyboard.h"
Lisp_Object Vdoc_file_name;
+extern Lisp_Object Voverriding_local_map;
+
Lisp_Object
get_doc_string (filepos)
long filepos;
register int count;
extern char *index ();
- if (XTYPE (Vexec_directory) != Lisp_String
+ if (XTYPE (Vdoc_directory) != Lisp_String
|| XTYPE (Vdoc_file_name) != Lisp_String)
return Qnil;
- name = (char *) alloca (XSTRING (Vexec_directory)->size
+ name = (char *) alloca (XSTRING (Vdoc_directory)->size
+ XSTRING (Vdoc_file_name)->size + 8);
- strcpy (name, XSTRING (Vexec_directory)->data);
+ strcpy (name, XSTRING (Vdoc_directory)->data);
strcat (name, XSTRING (Vdoc_file_name)->data);
#ifdef VMS
#ifndef VMS4_4
return make_string (buf, p - buf);
}
-DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 1, 0,
- "Return the documentation string of FUNCTION.")
- (fun1)
- Lisp_Object fun1;
+DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0,
+ "Return the documentation string of FUNCTION.\n\
+Unless a non-nil second argument is given, the\n\
+string is passed through `substitute-command-keys'.")
+ (function, raw)
+ Lisp_Object function, raw;
{
Lisp_Object fun;
Lisp_Object funcar;
- Lisp_Object tem;
+ Lisp_Object tem, doc;
- fun = fun1;
- while (XTYPE (fun) == Lisp_Symbol)
- {
- QUIT;
- fun = Fsymbol_function (fun);
- }
+ fun = Findirect_function (function);
switch (XTYPE (fun))
{
case Lisp_Subr:
if (XSUBR (fun)->doc == 0) return Qnil;
if ((int) XSUBR (fun)->doc >= 0)
- return Fsubstitute_command_keys (build_string (XSUBR (fun)->doc));
+ doc = build_string (XSUBR (fun)->doc);
else
- return
- Fsubstitute_command_keys (get_doc_string (- (int) XSUBR (fun)->doc));
+ doc = get_doc_string (- (int) XSUBR (fun)->doc);
+ break;
case Lisp_Compiled:
if (XVECTOR (fun)->size <= COMPILED_DOC_STRING)
return Qnil;
tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING];
if (XTYPE (tem) == Lisp_String)
- return Fsubstitute_command_keys (tem);
- if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
- return Fsubstitute_command_keys (get_doc_string (XFASTINT (tem)));
- return Qnil;
+ doc = tem;
+ else if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
+ doc = get_doc_string (XFASTINT (tem));
+ else
+ return Qnil;
+ break;
case Lisp_String:
case Lisp_Vector:
funcar = Fcar (fun);
if (XTYPE (funcar) != Lisp_Symbol)
return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
- if (XSYMBOL (funcar) == XSYMBOL (Qkeymap))
+ else if (EQ (funcar, Qkeymap))
return build_string ("Prefix command (definition is a keymap associating keystrokes with\n\
subcommands.)");
- if (XSYMBOL (funcar) == XSYMBOL (Qlambda)
- || XSYMBOL (funcar) == XSYMBOL (Qautoload))
+ else if (EQ (funcar, Qlambda)
+ || EQ (funcar, Qautoload))
{
tem = Fcar (Fcdr (Fcdr (fun)));
if (XTYPE (tem) == Lisp_String)
- return Fsubstitute_command_keys (tem);
- if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
- return Fsubstitute_command_keys (get_doc_string (XFASTINT (tem)));
- return Qnil;
+ doc = tem;
+ else if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
+ doc = get_doc_string (XFASTINT (tem));
+ else
+ return Qnil;
+
+ break;
}
- if (XSYMBOL (funcar) == XSYMBOL (Qmocklisp))
+ else if (EQ (funcar, Qmocklisp))
return Qnil;
- if (XSYMBOL (funcar) == XSYMBOL (Qmacro))
- return Fdocumentation (Fcdr (fun));
+ else if (EQ (funcar, Qmacro))
+ return Fdocumentation (Fcdr (fun), raw);
/* Fall through to the default to report an error. */
default:
return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
}
+
+ if (NILP (raw))
+ {
+ struct gcpro gcpro1;
+
+ GCPRO1 (doc);
+ doc = Fsubstitute_command_keys (doc);
+ UNGCPRO;
+ }
+ return doc;
}
-DEFUN ("documentation-property", Fdocumentation_property,
- Sdocumentation_property, 2, 2, 0,
+DEFUN ("documentation-property", Fdocumentation_property, Sdocumentation_property, 2, 3, 0,
"Return the documentation string that is SYMBOL's PROP property.\n\
-This differs from using `get' only in that it can refer to strings\n\
-stored in the `etc/DOC' file.")
- (sym, prop)
- Lisp_Object sym, prop;
+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 avoids this\n\
+translation.")
+ (sym, prop, raw)
+ Lisp_Object sym, prop, raw;
{
register Lisp_Object tem;
tem = Fget (sym, prop);
if (XTYPE (tem) == Lisp_Int)
tem = get_doc_string (XINT (tem) > 0 ? XINT (tem) : - XINT (tem));
- return Fsubstitute_command_keys (tem);
+ if (NILP (raw) && XTYPE (tem) == Lisp_String)
+ return Fsubstitute_command_keys (tem);
+ return tem;
}
\f
+/* Scanning the DOC files and placing docstring offsets into functions. */
+
+static void
+store_function_docstring (fun, offset)
+ Lisp_Object fun;
+ int offset;
+{
+ fun = indirect_function (fun);
+
+ /* The type determines where the docstring is stored. */
+
+ /* Lisp_Subrs have a slot for it. */
+ if (XTYPE (fun) == Lisp_Subr)
+ XSUBR (fun)->doc = (char *) - offset;
+
+ /* If it's a lisp form, stick it in the form. */
+ else if (CONSP (fun))
+ {
+ Lisp_Object tem;
+
+ tem = XCONS (fun)->car;
+ if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
+ {
+ tem = Fcdr (Fcdr (fun));
+ if (CONSP (tem) &&
+ XTYPE (XCONS (tem)->car) == Lisp_Int)
+ XFASTINT (XCONS (tem)->car) = offset;
+ }
+ else if (EQ (tem, Qmacro))
+ store_function_docstring (XCONS (fun)->cdr, offset);
+ }
+
+ /* Bytecode objects sometimes have slots for it. */
+ else if (XTYPE (fun) == Lisp_Compiled)
+ {
+ /* This bytecode object must have a slot for the
+ docstring, since we've found a docstring for it. */
+ if (XVECTOR (fun)->size <= COMPILED_DOC_STRING)
+ abort ();
+
+ XFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING]) = offset;
+ }
+}
+
+
DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
1, 1, 0,
"Used during Emacs initialization, before dumping runnable Emacs,\n\
to find pointers to doc strings stored in `etc/DOC...' and\n\
record them in function definitions.\n\
One arg, FILENAME, a string which does not include a directory.\n\
-The file is found in `../etc' now; found in the `exec-directory'\n\
+The file is found in `../etc' now; found in the `data-directory'\n\
when doc strings are referred to later in the dumped Emacs.")
(filename)
Lisp_Object filename;
char *name;
extern char *index ();
+#ifndef CANNOT_DUMP
+ if (NILP (Vpurify_flag))
+ error ("Snarf-documentation can only be called in an undumped Emacs");
+#endif
+
CHECK_STRING (filename, 0);
#ifndef CANNOT_DUMP
- name = (char *) alloca (XSTRING (filename)->size + 8);
+ name = (char *) alloca (XSTRING (filename)->size + 14);
strcpy (name, "../etc/");
#else /* CANNOT_DUMP */
- CHECK_STRING (Vexec_directory, 0);
+ CHECK_STRING (Vdoc_directory, 0);
name = (char *) alloca (XSTRING (filename)->size +
- XSTRING (Vexec_directory)->size + 1);
- strcpy (name, XSTRING (Vexec_directory)->data);
+ XSTRING (Vdoc_directory)->size + 1);
+ strcpy (name, XSTRING (Vdoc_directory)->data);
#endif /* CANNOT_DUMP */
strcat (name, XSTRING (filename)->data); /*** Add this line ***/
#ifdef VMS
* (end[1] == '*' ? -1 : 1)));
}
- /* Attach a docstring to a function? The type determines where
- the docstring is stored. */
+ /* Attach a docstring to a function? */
else if (p[1] == 'F')
- {
- fun = XSYMBOL (sym)->function;
-
- /* Lisp_Subrs have a slot for it. */
- if (XTYPE (fun) == Lisp_Subr)
- XSUBR (fun)->doc = (char *) - (pos + end + 1 - buf);
-
- /* If it's a lisp form, stick it in the form. */
- else if (CONSP (fun))
- {
- tem = XCONS (fun)->car;
- if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
- {
- tem = Fcdr (Fcdr (fun));
- if (CONSP (tem) &&
- XTYPE (XCONS (tem)->car) == Lisp_Int)
- XFASTINT (XCONS (tem)->car) = (pos + end + 1 - buf);
- }
- }
-
- /* Bytecode objects sometimes have slots for it. */
- else if (XTYPE (fun) == Lisp_Compiled)
- {
- /* This bytecode object must have a slot for the
- docstring, since we've found a docstring for it. */
- if (XVECTOR (fun)->size <= COMPILED_DOC_STRING)
- abort ();
-
- XFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING])
- = pos + end + 1 - buf;
- }
- }
- else error ("DOC file invalid at position %d", pos);
+ store_function_docstring (sym, pos + end + 1 - buf);
+
+ else
+ error ("DOC file invalid at position %d", pos);
}
}
pos += end - buf;
int idx;
int bsize;
unsigned char *new;
- register Lisp_Object tem;
+ Lisp_Object tem;
Lisp_Object keymap;
unsigned char *start;
int length;
- struct gcpro gcpro1;
+ Lisp_Object name;
+ struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
- if (NULL (str))
+ if (NILP (str))
return Qnil;
CHECK_STRING (str, 0);
- GCPRO1 (str);
+ tem = Qnil;
+ keymap = Qnil;
+ name = Qnil;
+ GCPRO4 (str, tem, keymap, name);
- keymap = current_buffer->keymap;
+ /* KEYMAP is either nil (which means search all the active keymaps)
+ or a specified local map (which means search just that and the
+ global map). If non-nil, it might come from Voverriding_local_map,
+ or from a \\<mapname> construct in STR itself.. */
+ keymap = Voverriding_local_map;
bsize = XSTRING (str)->size;
bufp = buf = (unsigned char *) xmalloc (bsize);
}
else if (strp[0] == '\\' && strp[1] == '[')
{
+ Lisp_Object firstkey;
+
changed = 1;
strp += 2; /* skip \[ */
start = strp;
/* Save STRP in IDX. */
idx = strp - (unsigned char *) XSTRING (str)->data;
tem = Fintern (make_string (start, length), Qnil);
- tem = Fwhere_is_internal (tem, keymap, Qnil, Qt, Qnil);
+ tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);
- if (NULL (tem)) /* but not on any keys */
+ /* Disregard menu bar bindings; it is positively annoying to
+ mention them when there's no menu bar, and it isn't terribly
+ useful even when there is a menu bar. */
+ if (!NILP (tem))
+ {
+ firstkey = Faref (tem, make_number (0));
+ if (EQ (firstkey, Qmenu_bar))
+ tem = Qnil;
+ }
+
+ if (NILP (tem)) /* but not on any keys */
{
new = (unsigned char *) xrealloc (buf, bsize += 4);
bufp += new - buf;
else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<'))
{
struct buffer *oldbuf;
- Lisp_Object name;
changed = 1;
strp += 2; /* skip \{ or \< */
in case it is a local variable. */
name = Fintern (make_string (start, length), Qnil);
tem = Fboundp (name);
- if (! NULL (tem))
+ if (! NILP (tem))
{
tem = Fsymbol_value (name);
- if (! NULL (tem))
- tem = get_keymap_1 (tem, 0);
+ if (! NILP (tem))
+ tem = get_keymap_1 (tem, 0, 1);
}
/* Now switch to a temp buffer. */
oldbuf = current_buffer;
set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
- if (NULL (tem))
+ if (NILP (tem))
{
name = Fsymbol_name (name);
insert_string ("\nUses keymap \"");
- insert_from_string (name, 0, XSTRING (name)->size);
+ insert_from_string (name, 0, XSTRING (name)->size, 1);
insert_string ("\", which is not currently defined.\n");
if (start[-1] == '<') keymap = Qnil;
}
else if (start[-1] == '<')
keymap = tem;
else
- describe_map_tree (tem, 1, Qnil);
+ describe_map_tree (tem, 1, Qnil, Qnil, 0, 1);
tem = Fbuffer_string ();
Ferase_buffer ();
set_buffer_internal (oldbuf);
tem = make_string (buf, bufp - buf);
else
tem = str;
- UNGCPRO;
- free (buf);
- return tem;
+ xfree (buf);
+ RETURN_UNGCPRO (tem);
}
\f
syms_of_doc ()
HCoop / bpt / emacs.git / blobdiff