/* Record indices of function doc strings stored in a file.
- Copyright (C) 1985, 1986, 1993, 1994, 1995 Free Software Foundation, Inc.
+ Copyright (C) 1985, 86, 93, 94, 95, 97, 1998 Free Software Foundation, Inc.
This file is part of GNU Emacs.
You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING. If not, write to
-the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA. */
#include <config.h>
#include "lisp.h"
#include "buffer.h"
#include "keyboard.h"
+#include "charset.h"
Lisp_Object Vdoc_file_name;
#endif /* VMS */
}
+/* Buffer used for reading from documentation file. */
+static char *get_doc_string_buffer;
+static int get_doc_string_buffer_size;
+
/* 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
get_doc_string (filepos)
Lisp_Object filepos;
{
- char buf[512 * 32 + 1];
- char *buffer;
- int buffer_size;
- int free_it;
char *from, *to;
register int fd;
register char *name;
register char *p, *p1;
int minsize;
- int position;
+ int offset, position;
Lisp_Object file, tem;
if (INTEGERP (filepos))
fd = open (name, O_RDONLY, 0);
}
#endif
-
if (fd < 0)
error ("Cannot open doc string file \"%s\"", name);
}
- if (0 > lseek (fd, position, 0))
+ /* Seek only to beginning of disk block. */
+ offset = position % (8 * 1024);
+ if (0 > lseek (fd, position - offset, 0))
{
close (fd);
error ("Position %ld out of range in doc string file \"%s\"",
position, name);
}
- /* Read the doc string into a buffer.
- Use the fixed buffer BUF if it is big enough;
- otherwise allocate one and set FREE_IT.
- We store the buffer in use in BUFFER and its size in BUFFER_SIZE. */
+ /* Read the doc string into get_doc_string_buffer.
+ P points beyond the data just read. */
- buffer = buf;
- buffer_size = sizeof buf;
- free_it = 0;
- p = buf;
+ p = get_doc_string_buffer;
while (1)
{
- int space_left = buffer_size - (p - buffer);
+ int space_left = (get_doc_string_buffer_size
+ - (p - get_doc_string_buffer));
int nread;
- /* Switch to a bigger buffer if we need one. */
+ /* Allocate or grow the buffer if we need to. */
if (space_left == 0)
{
- if (free_it)
- {
- int offset = p - buffer;
- buffer = (char *) xrealloc (buffer,
- buffer_size *= 2);
- p = buffer + offset;
- }
- else
- {
- buffer = (char *) xmalloc (buffer_size *= 2);
- bcopy (buf, buffer, p - buf);
- p = buffer + (p - buf);
- }
- free_it = 1;
- space_left = buffer_size - (p - buffer);
+ int in_buffer = p - get_doc_string_buffer;
+ get_doc_string_buffer_size += 16 * 1024;
+ get_doc_string_buffer
+ = (char *) xrealloc (get_doc_string_buffer,
+ get_doc_string_buffer_size + 1);
+ p = get_doc_string_buffer + in_buffer;
+ space_left = (get_doc_string_buffer_size
+ - (p - get_doc_string_buffer));
}
- /* Don't read too too much at one go. */
+ /* Read a disk block at a time.
+ If we read the same block last time, maybe skip this? */
if (space_left > 1024 * 8)
space_left = 1024 * 8;
nread = read (fd, p, space_left);
p[nread] = 0;
if (!nread)
break;
- p1 = index (p, '\037');
+ if (p == get_doc_string_buffer)
+ p1 = index (p + offset, '\037');
+ else
+ p1 = index (p, '\037');
if (p1)
{
*p1 = 0;
/* Scan the text and perform quoting with ^A (char code 1).
^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_. */
- from = buffer;
- to = buffer;
+ from = get_doc_string_buffer + offset;
+ to = get_doc_string_buffer + offset;
while (from != p)
{
if (*from == 1)
*to++ = *from++;
}
- tem = make_string (buffer, to - buffer);
- if (free_it)
- free (buffer);
-
- return tem;
+ return make_string (get_doc_string_buffer + offset,
+ to - (get_doc_string_buffer + offset));
}
/* Get a string from position FILEPOS and pass it through the Lisp reader.
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 (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))
if (p != end)
{
end = index (p, '\n');
- sym = oblookup (Vobarray, p + 2, end - p - 2);
+ sym = oblookup (Vobarray, p + 2,
+ multibyte_chars_in_text (p + 2, end - p - 2),
+ end - p - 2);
if (SYMBOLP (sym))
{
/* Attach a docstring to a variable? */
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 tem;
Lisp_Object keymap;
unsigned char *start;
- int length;
+ int length, length_byte;
Lisp_Object name;
struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
+ int multibyte;
+ int nchars;
- 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);
+
+ multibyte = STRING_MULTIBYTE (string);
+ nchars = 0;
/* 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 = STRING_BYTES (XSTRING (string));
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 < XSTRING (string)->data + STRING_BYTES (XSTRING (string)))
{
if (strp[0] == '\\' && strp[1] == '=')
{
/* \= quotes the next character;
thus, to put in \[ without its special meaning, use \=\[. */
changed = 1;
- *bufp++ = strp[2];
- strp += 3;
+ strp += 2;
+ if (multibyte)
+ {
+ int len;
+ int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
+
+ STRING_CHAR_AND_LENGTH (strp, maxlen, len);
+ if (len == 1)
+ *bufp = *strp;
+ else
+ bcopy (strp, bufp, len);
+ strp += len;
+ bufp += len;
+ nchars++;
+ }
+ else
+ *bufp++ = *strp++, nchars++;
}
else 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
+ < STRING_BYTES (XSTRING (string)))
&& *strp != ']')
strp++;
- length = strp - start;
+ length_byte = strp - start;
+
strp++; /* skip ] */
/* Save STRP in IDX. */
- idx = strp - (unsigned char *) XSTRING (str)->data;
- tem = Fintern (make_string (start, length), Qnil);
+ idx = strp - (unsigned char *) XSTRING (string)->data;
+ tem = Fintern (make_string (start, length_byte), Qnil);
tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);
/* Disregard menu bar bindings; it is positively annoying to
buf = new;
bcopy ("M-x ", bufp, 4);
bufp += 4;
+ nchars += 4;
+ if (multibyte)
+ length = multibyte_chars_in_text (start, length_byte);
+ else
+ length = length_byte;
goto subst;
}
else
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;
+
+ length_byte = 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
in case it is a local variable. */
- name = Fintern (make_string (start, length), Qnil);
+ name = Fintern (make_string (start, length_byte), Qnil);
tem = Fboundp (name);
if (! NILP (tem))
{
{
name = Fsymbol_name (name);
insert_string ("\nUses keymap \"");
- insert_from_string (name, 0, XSTRING (name)->size, 1);
+ insert_from_string (name, 0, 0,
+ XSTRING (name)->size,
+ STRING_BYTES (XSTRING (name)), 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, Qnil, 0, 1);
+ describe_map_tree (tem, 1, Qnil, Qnil, (char *)0, 1, 0, 0);
tem = Fbuffer_string ();
Ferase_buffer ();
set_buffer_internal (oldbuf);
subst_string:
start = XSTRING (tem)->data;
length = XSTRING (tem)->size;
+ length_byte = STRING_BYTES (XSTRING (tem));
subst:
- new = (unsigned char *) xrealloc (buf, bsize += length);
+ new = (unsigned char *) xrealloc (buf, bsize += length_byte);
bufp += new - buf;
buf = new;
- bcopy (start, bufp, length);
- bufp += length;
- /* Check STR again in case gc relocated it. */
- strp = (unsigned char *) XSTRING (str)->data + idx;
+ 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++;
+ else
+ {
+ int len;
+ int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
+
+ STRING_CHAR_AND_LENGTH (strp, maxlen, len);
+ if (len == 1)
+ *bufp = *strp;
+ else
+ bcopy (strp, bufp, len);
+ strp += len;
+ bufp += len;
+ nchars++;
}
- else /* just copy other chars */
- *bufp++ = *strp++;
}
if (changed) /* don't bother if nothing substituted */
- tem = make_string (buf, bufp - buf);
+ tem = make_multibyte_string (buf, nchars, bufp - buf);
else
- tem = str;
+ tem = string;
xfree (buf);
RETURN_UNGCPRO (tem);
}
HCoop / bpt / emacs.git / blobdiff