/* Record indices of function doc strings stored in a file.
- Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
+ Copyright (C) 1985, 1986, 1993, 1994, 1995 Free Software Foundation, Inc.
This file is part of GNU Emacs.
GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 1, or (at your option)
+the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Emacs is distributed in the hope that it will be useful,
/* Extract a doc string from a file. FILEPOS says where to get it.
If it is an integer, use that position in the standard DOC-... file.
If it is (FILE . INTEGER), use FILE as the file name
- and INTEGER as the position in that file. */
+ and INTEGER as the position in that file.
+ But if INTEGER is negative, make it positive.
+ (A negative integer is used for user variables, so we can distinguish
+ them without actually fetching the doc string.) */
static Lisp_Object
get_doc_string (filepos)
{
file = XCONS (filepos)->car;
position = XINT (XCONS (filepos)->cdr);
+ if (position < 0)
+ position = - position;
}
else
return Qnil;
}
else
{
- name = XSTRING (file)->data;
+ name = (char *) XSTRING (file)->data;
}
fd = open (name, O_RDONLY, 0);
DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0,
"Return the documentation string of FUNCTION.\n\
-Unless a non-nil second argument is given, the\n\
+Unless a non-nil second argument RAW is given, the\n\
string is passed through `substitute-command-keys'.")
(function, raw)
Lisp_Object function, raw;
}
else if (COMPILEDP (fun))
{
- if (XVECTOR (fun)->size <= COMPILED_DOC_STRING)
+ if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING)
return Qnil;
tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING];
if (STRINGP (tem))
else if (EQ (funcar, Qlambda)
|| EQ (funcar, Qautoload))
{
- tem = Fcar (Fcdr (Fcdr (fun)));
+ Lisp_Object tem1;
+ tem1 = Fcdr (Fcdr (fun));
+ tem = Fcar (tem1);
if (STRINGP (tem))
doc = tem;
- else if (NATNUMP (tem) || CONSP (tem))
+ /* Handle a doc reference--but these never come last
+ in the function body, so reject them if they are last. */
+ else if ((NATNUMP (tem) || CONSP (tem))
+ && ! NILP (XCONS (tem1)->cdr))
doc = get_doc_string (tem);
else
return Qnil;
"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 avoids this\n\
+`substitute-command-keys'. A non-nil third argument RAW avoids this\n\
translation.")
- (sym, prop, raw)
- Lisp_Object sym, prop, raw;
+ (symbol, prop, raw)
+ Lisp_Object symbol, prop, raw;
{
register Lisp_Object tem;
- tem = Fget (sym, prop);
+ tem = Fget (symbol, prop);
if (INTEGERP (tem))
tem = get_doc_string (XINT (tem) > 0 ? tem : make_number (- XINT (tem)));
else if (CONSP (tem))
{
/* 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)
+ if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING)
XSETFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING], offset);
}
}
as the keymap for future \\=\\[COMMAND] substrings.\n\
\\=\\= quotes the following character and is discarded;\n\
thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.")
- (str)
- Lisp_Object str;
+ (string)
+ Lisp_Object string;
{
unsigned char *buf;
int changed = 0;
Lisp_Object name;
struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
- if (NILP (str))
+ if (NILP (string))
return Qnil;
- CHECK_STRING (str, 0);
+ CHECK_STRING (string, 0);
tem = Qnil;
keymap = Qnil;
name = Qnil;
- GCPRO4 (str, tem, keymap, name);
+ GCPRO4 (string, tem, keymap, name);
/* 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;
+ or from a \\<mapname> construct in STRING itself.. */
+ keymap = current_kboard->Voverriding_terminal_local_map;
+ if (NILP (keymap))
+ keymap = Voverriding_local_map;
- bsize = XSTRING (str)->size;
+ bsize = XSTRING (string)->size;
bufp = buf = (unsigned char *) xmalloc (bsize);
- strp = (unsigned char *) XSTRING (str)->data;
- while (strp < (unsigned char *) XSTRING (str)->data + XSTRING (str)->size)
+ strp = (unsigned char *) XSTRING (string)->data;
+ while (strp < (unsigned char *) XSTRING (string)->data + XSTRING (string)->size)
{
if (strp[0] == '\\' && strp[1] == '=')
{
strp += 2; /* skip \[ */
start = strp;
- while ((strp - (unsigned char *) XSTRING (str)->data
- < XSTRING (str)->size)
+ while ((strp - (unsigned char *) XSTRING (string)->data
+ < XSTRING (string)->size)
&& *strp != ']')
strp++;
length = strp - start;
strp++; /* skip ] */
/* Save STRP in IDX. */
- idx = strp - (unsigned char *) XSTRING (str)->data;
+ idx = strp - (unsigned char *) XSTRING (string)->data;
tem = Fintern (make_string (start, length), Qnil);
tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);
strp += 2; /* skip \{ or \< */
start = strp;
- while ((strp - (unsigned char *) XSTRING (str)->data
- < XSTRING (str)->size)
+ while ((strp - (unsigned char *) XSTRING (string)->data
+ < XSTRING (string)->size)
&& *strp != '}' && *strp != '>')
strp++;
length = strp - start;
strp++; /* skip } or > */
/* Save STRP in IDX. */
- idx = strp - (unsigned char *) XSTRING (str)->data;
+ idx = strp - (unsigned char *) XSTRING (string)->data;
/* Get the value of the keymap in TEM, or nil if undefined.
Do this while still in the user's current buffer
else if (start[-1] == '<')
keymap = tem;
else
- describe_map_tree (tem, 1, Qnil, Qnil, 0, 1);
+ describe_map_tree (tem, 1, Qnil, Qnil, (char *)0, 1, 0);
tem = Fbuffer_string ();
Ferase_buffer ();
set_buffer_internal (oldbuf);
buf = new;
bcopy (start, bufp, length);
bufp += length;
- /* Check STR again in case gc relocated it. */
- strp = (unsigned char *) XSTRING (str)->data + idx;
+ /* Check STRING again in case gc relocated it. */
+ strp = (unsigned char *) XSTRING (string)->data + idx;
}
else /* just copy other chars */
*bufp++ = *strp++;
if (changed) /* don't bother if nothing substituted */
tem = make_string (buf, bufp - buf);
else
- tem = str;
+ tem = string;
xfree (buf);
RETURN_UNGCPRO (tem);
}