annotate src/doc.c @ 31870:42f05d7aadd0

(texinfo-mode): Prevent filling lines starting with `@def' or `@multitable', in addition to ones specified by the user in auto-fill-inhibit-regexp.
author Gerd Moellmann <gerd@gnu.org>
date Mon, 25 Sep 2000 11:16:43 +0000
parents 3ecef4a7b3cd
children c3435dc00ed7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* Record indices of function doc strings stored in a file.
27560
a7b55765b7c4 Copyright up-date.
Dave Love <fx@gnu.org>
parents: 27552
diff changeset
2 Copyright (C) 1985, 86,93,94,95,97,98,99, 2000 Free Software Foundation, Inc.
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
3
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4 This file is part of GNU Emacs.
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6 GNU Emacs is free software; you can redistribute it and/or modify
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
10344
a6e8525a1a9d (store_function_docstring, Fdocumentation): Use & PSEUDOVECTOR_SIZE_MASK on
Roland McGrath <roland@gnu.org>
parents: 10330
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9 any later version.
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11 GNU Emacs is distributed in the hope that it will be useful,
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 GNU General Public License for more details.
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 along with GNU Emacs; see the file COPYING. If not, write to
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 14069
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 14069
diff changeset
19 Boston, MA 02111-1307, USA. */
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21
4696
1fc792473491 Include <config.h> instead of "config.h".
Roland McGrath <roland@gnu.org>
parents: 3999
diff changeset
22 #include <config.h>
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
23
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
24 #include <sys/types.h>
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
25 #include <sys/file.h> /* Must be after sys/types.h for USG and BSD4_1*/
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
26
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
27 #ifdef USG5
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28 #include <fcntl.h>
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
29 #endif
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
30
6862
653504b6b5dd [HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents: 6030
diff changeset
31 #ifdef HAVE_UNISTD_H
653504b6b5dd [HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents: 6030
diff changeset
32 #include <unistd.h>
653504b6b5dd [HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents: 6030
diff changeset
33 #endif
653504b6b5dd [HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents: 6030
diff changeset
34
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
35 #ifndef O_RDONLY
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
36 #define O_RDONLY 0
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37 #endif
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39 #include "lisp.h"
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40 #include "buffer.h"
1511
ff88f962a982 * doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents: 1116
diff changeset
41 #include "keyboard.h"
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
42 #include "charset.h"
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43
31336
3ecef4a7b3cd Remove includes of
Gerd Moellmann <gerd@gnu.org>
parents: 31225
diff changeset
44 #ifdef HAVE_INDEX
3ecef4a7b3cd Remove includes of
Gerd Moellmann <gerd@gnu.org>
parents: 31225
diff changeset
45 extern char *index P_ ((const char *, int));
31225
7930c46bb365 (toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents: 30154
diff changeset
46 #endif
7930c46bb365 (toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents: 30154
diff changeset
47
27552
60c820c7f330 (Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents: 26471
diff changeset
48 Lisp_Object Vdoc_file_name, Vhelp_manyarg_func_alist;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
49
28334
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
50 Lisp_Object Qfunction_documentation;
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
51
5784
9c3be8e0d2ef (Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents: 5550
diff changeset
52 extern Lisp_Object Voverriding_local_map;
9c3be8e0d2ef (Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents: 5550
diff changeset
53
9087
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
54 /* For VMS versions with limited file name syntax,
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
55 convert the name to something VMS will allow. */
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
56 static void
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
57 munge_doc_file_name (name)
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
58 char *name;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
59 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
60 #ifdef VMS
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
61 #ifndef VMS4_4
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
62 /* For VMS versions with limited file name syntax,
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
63 convert the name to something VMS will allow. */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
64 p = name;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
65 while (*p)
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
66 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
67 if (*p == '-')
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
68 *p = '_';
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
69 p++;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
70 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
71 #endif /* not VMS4_4 */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
72 #ifdef VMS4_4
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
73 strcpy (name, sys_translate_unix (name));
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
74 #endif /* VMS4_4 */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
75 #endif /* VMS */
9087
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
76 }
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
77
14648
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
78 /* Buffer used for reading from documentation file. */
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
79 static char *get_doc_string_buffer;
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
80 static int get_doc_string_buffer_size;
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
81
22690
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
82 static unsigned char *read_bytecode_pointer;
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
83
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
84 /* readchar in lread.c calls back here to fetch the next byte.
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
85 If UNREADFLAG is 1, we unread a byte. */
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
86
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
87 int
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
88 read_bytecode_char (unreadflag)
25758
fca9459a0555 (read_bytecode_char): Declare arg.
Dave Love <fx@gnu.org>
parents: 25662
diff changeset
89 int unreadflag;
22690
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
90 {
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
91 if (unreadflag)
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
92 {
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
93 read_bytecode_pointer--;
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
94 return 0;
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
95 }
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
96 return *read_bytecode_pointer++;
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
97 }
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
98
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
99 /* Extract a doc string from a file. FILEPOS says where to get it.
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
100 If it is an integer, use that position in the standard DOC-... file.
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
101 If it is (FILE . INTEGER), use FILE as the file name
11252
f610f9d7e3ca (get_doc_string): In (STRING . INTEGER), if INTEGER
Richard M. Stallman <rms@gnu.org>
parents: 10345
diff changeset
102 and INTEGER as the position in that file.
f610f9d7e3ca (get_doc_string): In (STRING . INTEGER), if INTEGER
Richard M. Stallman <rms@gnu.org>
parents: 10345
diff changeset
103 But if INTEGER is negative, make it positive.
f610f9d7e3ca (get_doc_string): In (STRING . INTEGER), if INTEGER
Richard M. Stallman <rms@gnu.org>
parents: 10345
diff changeset
104 (A negative integer is used for user variables, so we can distinguish
22043
10a9f355a346 (get_doc_string): New arg UNIBYTE
Richard M. Stallman <rms@gnu.org>
parents: 21514
diff changeset
105 them without actually fetching the doc string.)
10a9f355a346 (get_doc_string): New arg UNIBYTE
Richard M. Stallman <rms@gnu.org>
parents: 21514
diff changeset
106
22602
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
107 If UNIBYTE is nonzero, always make a unibyte string.
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
108
22562
ddb3fd464b77 (get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents: 22268
diff changeset
109 If DEFINITION is nonzero, assume this is for reading
ddb3fd464b77 (get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents: 22268
diff changeset
110 a dynamic function definition; convert the bytestring
ddb3fd464b77 (get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents: 22268
diff changeset
111 and the constants vector with appropriate byte handling,
ddb3fd464b77 (get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents: 22268
diff changeset
112 and return a cons cell. */
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
113
22268
9308a15aa8f8 (get_doc_string): Make non-static.
Richard M. Stallman <rms@gnu.org>
parents: 22043
diff changeset
114 Lisp_Object
22602
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
115 get_doc_string (filepos, unibyte, definition)
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
116 Lisp_Object filepos;
22602
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
117 int unibyte, definition;
9087
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
118 {
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
119 char *from, *to;
9087
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
120 register int fd;
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
121 register char *name;
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
122 register char *p, *p1;
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
123 int minsize;
14552
e6f31368feeb (get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
124 int offset, position;
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
125 Lisp_Object file, tem;
9087
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
126
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
127 if (INTEGERP (filepos))
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
128 {
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
129 file = Vdoc_file_name;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
130 position = XINT (filepos);
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
131 }
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
132 else if (CONSP (filepos))
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
133 {
25662
0a7261c1d487 Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents: 24573
diff changeset
134 file = XCAR (filepos);
0a7261c1d487 Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents: 24573
diff changeset
135 position = XINT (XCDR (filepos));
11252
f610f9d7e3ca (get_doc_string): In (STRING . INTEGER), if INTEGER
Richard M. Stallman <rms@gnu.org>
parents: 10345
diff changeset
136 if (position < 0)
f610f9d7e3ca (get_doc_string): In (STRING . INTEGER), if INTEGER
Richard M. Stallman <rms@gnu.org>
parents: 10345
diff changeset
137 position = - position;
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
138 }
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
139 else
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
140 return Qnil;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
141
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
142 if (!STRINGP (Vdoc_directory))
9087
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
143 return Qnil;
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
144
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
145 if (!STRINGP (file))
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
146 return Qnil;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
147
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
148 /* Put the file name in NAME as a C string.
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
149 If it is relative, combine it with Vdoc_directory. */
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
150
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
151 tem = Ffile_name_absolute_p (file);
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
152 if (NILP (tem))
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
153 {
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
154 minsize = XSTRING (Vdoc_directory)->size;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
155 /* sizeof ("../etc/") == 8 */
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
156 if (minsize < 8)
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
157 minsize = 8;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
158 name = (char *) alloca (minsize + XSTRING (file)->size + 8);
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
159 strcpy (name, XSTRING (Vdoc_directory)->data);
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
160 strcat (name, XSTRING (file)->data);
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
161 munge_doc_file_name (name);
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
162 }
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
163 else
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
164 {
11446
cee0510aa3aa (get_doc_string): Add cast.
Richard M. Stallman <rms@gnu.org>
parents: 11252
diff changeset
165 name = (char *) XSTRING (file)->data;
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
166 }
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
167
26088
b7aa6ac26872 Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents: 26076
diff changeset
168 fd = emacs_open (name, O_RDONLY, 0);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
169 if (fd < 0)
9087
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
170 {
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
171 #ifndef CANNOT_DUMP
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
172 if (!NILP (Vpurify_flag))
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
173 {
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
174 /* Preparing to dump; DOC file is probably not installed.
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
175 So check in ../etc. */
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
176 strcpy (name, "../etc/");
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
177 strcat (name, XSTRING (file)->data);
9087
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
178 munge_doc_file_name (name);
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
179
26088
b7aa6ac26872 Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents: 26076
diff changeset
180 fd = emacs_open (name, O_RDONLY, 0);
9087
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
181 }
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
182 #endif
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
183 if (fd < 0)
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
184 error ("Cannot open doc string file \"%s\"", name);
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
185 }
e3c272c7f4d2 (get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents: 8823
diff changeset
186
14552
e6f31368feeb (get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
187 /* Seek only to beginning of disk block. */
e6f31368feeb (get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
188 offset = position % (8 * 1024);
e6f31368feeb (get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
189 if (0 > lseek (fd, position - offset, 0))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
190 {
26088
b7aa6ac26872 Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents: 26076
diff changeset
191 emacs_close (fd);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
192 error ("Position %ld out of range in doc string file \"%s\"",
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
193 position, name);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
194 }
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
195
14648
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
196 /* Read the doc string into get_doc_string_buffer.
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
197 P points beyond the data just read. */
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
198
14648
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
199 p = get_doc_string_buffer;
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
200 while (1)
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
201 {
14648
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
202 int space_left = (get_doc_string_buffer_size
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
203 - (p - get_doc_string_buffer));
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
204 int nread;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
205
14552
e6f31368feeb (get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
206 /* Allocate or grow the buffer if we need to. */
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
207 if (space_left == 0)
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
208 {
14648
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
209 int in_buffer = p - get_doc_string_buffer;
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
210 get_doc_string_buffer_size += 16 * 1024;
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
211 get_doc_string_buffer
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
212 = (char *) xrealloc (get_doc_string_buffer,
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
213 get_doc_string_buffer_size + 1);
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
214 p = get_doc_string_buffer + in_buffer;
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
215 space_left = (get_doc_string_buffer_size
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
216 - (p - get_doc_string_buffer));
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
217 }
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
218
14552
e6f31368feeb (get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
219 /* Read a disk block at a time.
e6f31368feeb (get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
220 If we read the same block last time, maybe skip this? */
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
221 if (space_left > 1024 * 8)
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
222 space_left = 1024 * 8;
26088
b7aa6ac26872 Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents: 26076
diff changeset
223 nread = emacs_read (fd, p, space_left);
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
224 if (nread < 0)
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
225 {
26088
b7aa6ac26872 Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents: 26076
diff changeset
226 emacs_close (fd);
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
227 error ("Read error on documentation file");
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
228 }
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
229 p[nread] = 0;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
230 if (!nread)
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
231 break;
14648
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
232 if (p == get_doc_string_buffer)
31225
7930c46bb365 (toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents: 30154
diff changeset
233 p1 = (char *) index (p + offset, '\037');
14552
e6f31368feeb (get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
234 else
31225
7930c46bb365 (toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents: 30154
diff changeset
235 p1 = (char *) index (p, '\037');
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
236 if (p1)
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
237 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
238 *p1 = 0;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
239 p = p1;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
240 break;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
241 }
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
242 p += nread;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
243 }
26088
b7aa6ac26872 Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents: 26076
diff changeset
244 emacs_close (fd);
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
245
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
246 /* Scan the text and perform quoting with ^A (char code 1).
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
247 ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_. */
14648
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
248 from = get_doc_string_buffer + offset;
45d13c154bb4 (get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents: 14552
diff changeset
249 to = get_doc_string_buffer + offset;
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
250 while (from != p)
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
251 {
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
252 if (*from == 1)
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
253 {
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
254 int c;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
255
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
256 from++;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
257 c = *from++;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
258 if (c == 1)
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
259 *to++ = c;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
260 else if (c == '0')
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
261 *to++ = 0;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
262 else if (c == '_')
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
263 *to++ = 037;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
264 else
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
265 error ("Invalid data in documentation file -- ^A followed by code 0%o", c);
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
266 }
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
267 else
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
268 *to++ = *from++;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
269 }
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
270
22690
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
271 /* If DEFINITION, read from this buffer
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
272 the same way we would read bytes from a file. */
22562
ddb3fd464b77 (get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents: 22268
diff changeset
273 if (definition)
ddb3fd464b77 (get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents: 22268
diff changeset
274 {
22690
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
275 read_bytecode_pointer = get_doc_string_buffer + offset;
31bc848c5f18 (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22602
diff changeset
276 return Fread (Qlambda);
22562
ddb3fd464b77 (get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents: 22268
diff changeset
277 }
ddb3fd464b77 (get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents: 22268
diff changeset
278
22602
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
279 if (unibyte)
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
280 return make_unibyte_string (get_doc_string_buffer + offset,
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
281 to - (get_doc_string_buffer + offset));
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
282 else
24573
aa24b1cb428a (get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents: 23921
diff changeset
283 {
aa24b1cb428a (get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents: 23921
diff changeset
284 /* Let the data determine whether the string is multibyte,
aa24b1cb428a (get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents: 23921
diff changeset
285 even if Emacs is running in --unibyte mode. */
aa24b1cb428a (get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents: 23921
diff changeset
286 int nchars = multibyte_chars_in_text (get_doc_string_buffer + offset,
aa24b1cb428a (get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents: 23921
diff changeset
287 to - (get_doc_string_buffer + offset));
aa24b1cb428a (get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents: 23921
diff changeset
288 return make_string_from_bytes (get_doc_string_buffer + offset,
aa24b1cb428a (get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents: 23921
diff changeset
289 nchars,
aa24b1cb428a (get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents: 23921
diff changeset
290 to - (get_doc_string_buffer + offset));
aa24b1cb428a (get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents: 23921
diff changeset
291 }
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
292 }
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
293
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
294 /* Get a string from position FILEPOS and pass it through the Lisp reader.
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
295 We use this for fetching the bytecode string and constants vector
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
296 of a compiled function from the .elc file. */
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
297
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
298 Lisp_Object
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
299 read_doc_string (filepos)
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
300 Lisp_Object filepos;
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
301 {
22602
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
302 return get_doc_string (filepos, 0, 1);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
303 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
304
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
305 DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0,
604
63a8e7b3c547 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 577
diff changeset
306 "Return the documentation string of FUNCTION.\n\
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
307 Unless a non-nil second argument RAW is given, the\n\
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
308 string is passed through `substitute-command-keys'.")
647
529171c8b71c entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 604
diff changeset
309 (function, raw)
529171c8b71c entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 604
diff changeset
310 Lisp_Object function, raw;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
311 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
312 Lisp_Object fun;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
313 Lisp_Object funcar;
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
314 Lisp_Object tem, doc;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
315
28334
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
316 if (SYMBOLP (function)
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
317 && (tem = Fget (function, Qfunction_documentation),
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
318 !NILP (tem)))
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
319 return Fdocumentation_property (function, Qfunction_documentation, raw);
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
320
647
529171c8b71c entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 604
diff changeset
321 fun = Findirect_function (function);
10002
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
322 if (SUBRP (fun))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
323 {
28334
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
324 if (XSUBR (fun)->doc == 0)
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
325 return Qnil;
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
326 else if ((EMACS_INT) XSUBR (fun)->doc >= 0)
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
327 doc = build_string (XSUBR (fun)->doc);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
328 else
22602
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
329 doc = get_doc_string (make_number (- (EMACS_INT) XSUBR (fun)->doc),
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
330 0, 0);
27552
60c820c7f330 (Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents: 26471
diff changeset
331 if (! NILP (tem = Fassq (function, Vhelp_manyarg_func_alist)))
60c820c7f330 (Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents: 26471
diff changeset
332 doc = concat3 (doc, build_string ("\n"), Fcdr (tem));
10002
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
333 }
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
334 else if (COMPILEDP (fun))
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
335 {
10345
9952a5ab70d1 Fix typo in last change.
Roland McGrath <roland@gnu.org>
parents: 10344
diff changeset
336 if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING)
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
337 return Qnil;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
338 tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING];
9133
48820d57a24c (get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents: 9087
diff changeset
339 if (STRINGP (tem))
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
340 doc = tem;
10202
4013c083162e (get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 10002
diff changeset
341 else if (NATNUMP (tem) || CONSP (tem))
22890
5044c732dbde (Fdocumentation): Specify UNIBYTE = 0
Richard M. Stallman <rms@gnu.org>
parents: 22690
diff changeset
342 doc = get_doc_string (tem, 0, 0);
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
343 else
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
344 return Qnil;
10002
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
345 }
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
346 else if (STRINGP (fun) || VECTORP (fun))
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
347 {
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
348 return build_string ("Keyboard macro.");
10002
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
349 }
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
350 else if (CONSP (fun))
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
351 {
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
352 funcar = Fcar (fun);
9133
48820d57a24c (get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents: 9087
diff changeset
353 if (!SYMBOLP (funcar))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
354 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
647
529171c8b71c entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 604
diff changeset
355 else if (EQ (funcar, Qkeymap))
23921
81a6345fd5e8 (Fdocumentation): Change the doc string for prefix
Andreas Schwab <schwab@suse.de>
parents: 22890
diff changeset
356 return build_string ("Prefix command (definition is a keymap associating keystrokes with commands).");
647
529171c8b71c entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 604
diff changeset
357 else if (EQ (funcar, Qlambda)
529171c8b71c entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 604
diff changeset
358 || EQ (funcar, Qautoload))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
359 {
13521
13e55327ef5e (Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents: 13244
diff changeset
360 Lisp_Object tem1;
13e55327ef5e (Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents: 13244
diff changeset
361 tem1 = Fcdr (Fcdr (fun));
13e55327ef5e (Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents: 13244
diff changeset
362 tem = Fcar (tem1);
9133
48820d57a24c (get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents: 9087
diff changeset
363 if (STRINGP (tem))
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
364 doc = tem;
13521
13e55327ef5e (Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents: 13244
diff changeset
365 /* Handle a doc reference--but these never come last
13e55327ef5e (Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents: 13244
diff changeset
366 in the function body, so reject them if they are last. */
13e55327ef5e (Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents: 13244
diff changeset
367 else if ((NATNUMP (tem) || CONSP (tem))
25662
0a7261c1d487 Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents: 24573
diff changeset
368 && ! NILP (XCDR (tem1)))
22890
5044c732dbde (Fdocumentation): Specify UNIBYTE = 0
Richard M. Stallman <rms@gnu.org>
parents: 22690
diff changeset
369 doc = get_doc_string (tem, 0, 0);
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
370 else
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
371 return Qnil;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
372 }
647
529171c8b71c entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 604
diff changeset
373 else if (EQ (funcar, Qmocklisp))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
374 return Qnil;
647
529171c8b71c entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 604
diff changeset
375 else if (EQ (funcar, Qmacro))
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
376 return Fdocumentation (Fcdr (fun), raw);
10002
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
377 else
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
378 goto oops;
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
379 }
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
380 else
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
381 {
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
382 oops:
5b2b7e378772 (Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents: 9958
diff changeset
383 Fsignal (Qinvalid_function, Fcons (fun, Qnil));
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
384 }
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
385
577
53f29271d1b0 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 570
diff changeset
386 if (NILP (raw))
26471
b1863c0b8f9c (Fdocumentation): Remove gcpro here too.
Dave Love <fx@gnu.org>
parents: 26420
diff changeset
387 doc = Fsubstitute_command_keys (doc);
570
c5bfe6e87d93 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 485
diff changeset
388 return doc;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
389 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
390
28036
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
391 DEFUN ("documentation-property", Fdocumentation_property,
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
392 Sdocumentation_property, 2, 3, 0,
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
393 "Return the documentation string that is SYMBOL's PROP property.\n\
28036
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
394 Third argument RAW omitted or nil means pass the result through\n\
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
395 `substitute-command-keys' if it is a string.\n\
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
396 \n\
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
397 This is differs from `get' in that it can refer to strings stored in the\n\
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
398 `etc/DOC' file; and that it evaluates documentation properties that\n\
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
399 aren't strings.")
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
400 (symbol, prop, raw)
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
401 Lisp_Object symbol, prop, raw;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
402 {
26076
edbfca66058d (Fdocumentation_property): Remove register declaration for `tem'.
Dave Love <fx@gnu.org>
parents: 26075
diff changeset
403 Lisp_Object tem;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
404
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
405 tem = Fget (symbol, prop);
9133
48820d57a24c (get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents: 9087
diff changeset
406 if (INTEGERP (tem))
22602
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
407 tem = get_doc_string (XINT (tem) > 0 ? tem : make_number (- XINT (tem)), 0, 0);
28036
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
408 else if (CONSP (tem) && INTEGERP (XCDR (tem)))
22602
9c6b3b9c3c8f (get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents: 22562
diff changeset
409 tem = get_doc_string (tem, 0, 0);
28036
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
410 else if (!STRINGP (tem))
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
411 /* Feval protects its argument. */
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
412 tem = Feval (tem);
ec8b11f3d3da (Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents: 27560
diff changeset
413
9133
48820d57a24c (get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents: 9087
diff changeset
414 if (NILP (raw) && STRINGP (tem))
26420
00b7d6135be4 (Fdocumentation_property): Remove GCPRO because
Gerd Moellmann <gerd@gnu.org>
parents: 26317
diff changeset
415 tem = Fsubstitute_command_keys (tem);
312
adba7439e87c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 297
diff changeset
416 return tem;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
417 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
418
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
419 /* Scanning the DOC files and placing docstring offsets into functions. */
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
420
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
421 static void
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
422 store_function_docstring (fun, offset)
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
423 Lisp_Object fun;
10330
240a2c88d439 (store_function_docstring): Arg is now EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents: 10202
diff changeset
424 /* Use EMACS_INT because we get this from pointer subtraction. */
240a2c88d439 (store_function_docstring): Arg is now EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents: 10202
diff changeset
425 EMACS_INT offset;
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
426 {
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
427 fun = indirect_function (fun);
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
428
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
429 /* The type determines where the docstring is stored. */
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
430
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
431 /* Lisp_Subrs have a slot for it. */
9133
48820d57a24c (get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents: 9087
diff changeset
432 if (SUBRP (fun))
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
433 XSUBR (fun)->doc = (char *) - offset;
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
434
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
435 /* If it's a lisp form, stick it in the form. */
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
436 else if (CONSP (fun))
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
437 {
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
438 Lisp_Object tem;
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
439
25662
0a7261c1d487 Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents: 24573
diff changeset
440 tem = XCAR (fun);
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
441 if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
442 {
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
443 tem = Fcdr (Fcdr (fun));
25662
0a7261c1d487 Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents: 24573
diff changeset
444 if (CONSP (tem) && INTEGERP (XCAR (tem)))
0a7261c1d487 Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents: 24573
diff changeset
445 XSETFASTINT (XCAR (tem), offset);
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
446 }
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
447 else if (EQ (tem, Qmacro))
25662
0a7261c1d487 Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents: 24573
diff changeset
448 store_function_docstring (XCDR (fun), offset);
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
449 }
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
450
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
451 /* Bytecode objects sometimes have slots for it. */
9133
48820d57a24c (get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents: 9087
diff changeset
452 else if (COMPILEDP (fun))
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
453 {
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
454 /* This bytecode object must have a slot for the
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
455 docstring, since we've found a docstring for it. */
10345
9952a5ab70d1 Fix typo in last change.
Roland McGrath <roland@gnu.org>
parents: 10344
diff changeset
456 if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING)
9304
1fbc46670cb0 (store_function_docstring): Don't use XFASTINT as an lvalue.
Karl Heuer <kwzh@gnu.org>
parents: 9133
diff changeset
457 XSETFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING], offset);
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
458 }
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
459 }
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
460
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
461
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
462 DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
463 1, 1, 0,
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
464 "Used during Emacs initialization, before dumping runnable Emacs,\n\
604
63a8e7b3c547 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 577
diff changeset
465 to find pointers to doc strings stored in `etc/DOC...' and\n\
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
466 record them in function definitions.\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
467 One arg, FILENAME, a string which does not include a directory.\n\
604
63a8e7b3c547 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 577
diff changeset
468 The file is found in `../etc' now; found in the `data-directory'\n\
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
469 when doc strings are referred to later in the dumped Emacs.")
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
470 (filename)
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
471 Lisp_Object filename;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
472 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
473 int fd;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
474 char buf[1024 + 1];
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
475 register int filled;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
476 register int pos;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
477 register char *p, *end;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
478 Lisp_Object sym, fun, tem;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
479 char *name;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
480
1116
6d0d442e2ada * doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents: 961
diff changeset
481 #ifndef CANNOT_DUMP
6d0d442e2ada * doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents: 961
diff changeset
482 if (NILP (Vpurify_flag))
6d0d442e2ada * doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents: 961
diff changeset
483 error ("Snarf-documentation can only be called in an undumped Emacs");
6d0d442e2ada * doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents: 961
diff changeset
484 #endif
6d0d442e2ada * doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents: 961
diff changeset
485
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
486 CHECK_STRING (filename, 0);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
487
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
488 #ifndef CANNOT_DUMP
463
ffdbf3445088 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 312
diff changeset
489 name = (char *) alloca (XSTRING (filename)->size + 14);
604
63a8e7b3c547 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 577
diff changeset
490 strcpy (name, "../etc/");
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
491 #else /* CANNOT_DUMP */
6030
8b3f54fb451f (get_doc_string, Snarf_documentation): Use new variable doc_directory.
Karl Heuer <kwzh@gnu.org>
parents: 5784
diff changeset
492 CHECK_STRING (Vdoc_directory, 0);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
493 name = (char *) alloca (XSTRING (filename)->size +
6030
8b3f54fb451f (get_doc_string, Snarf_documentation): Use new variable doc_directory.
Karl Heuer <kwzh@gnu.org>
parents: 5784
diff changeset
494 XSTRING (Vdoc_directory)->size + 1);
8b3f54fb451f (get_doc_string, Snarf_documentation): Use new variable doc_directory.
Karl Heuer <kwzh@gnu.org>
parents: 5784
diff changeset
495 strcpy (name, XSTRING (Vdoc_directory)->data);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
496 #endif /* CANNOT_DUMP */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
497 strcat (name, XSTRING (filename)->data); /*** Add this line ***/
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
498 #ifdef VMS
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
499 #ifndef VMS4_4
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
500 /* For VMS versions with limited file name syntax,
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
501 convert the name to something VMS will allow. */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
502 p = name;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
503 while (*p)
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
504 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
505 if (*p == '-')
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
506 *p = '_';
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
507 p++;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
508 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
509 #endif /* not VMS4_4 */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
510 #ifdef VMS4_4
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
511 strcpy (name, sys_translate_unix (name));
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
512 #endif /* VMS4_4 */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
513 #endif /* VMS */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
514
26088
b7aa6ac26872 Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents: 26076
diff changeset
515 fd = emacs_open (name, O_RDONLY, 0);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
516 if (fd < 0)
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
517 report_file_error ("Opening doc string file",
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
518 Fcons (build_string (name), Qnil));
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
519 Vdoc_file_name = filename;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
520 filled = 0;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
521 pos = 0;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
522 while (1)
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
523 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
524 if (filled < 512)
26088
b7aa6ac26872 Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents: 26076
diff changeset
525 filled += emacs_read (fd, &buf[filled], sizeof buf - 1 - filled);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
526 if (!filled)
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
527 break;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
528
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
529 buf[filled] = 0;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
530 p = buf;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
531 end = buf + (filled < 512 ? filled : filled - 128);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
532 while (p != end && *p != '\037') p++;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
533 /* p points to ^_Ffunctionname\n or ^_Vvarname\n. */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
534 if (p != end)
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
535 {
31225
7930c46bb365 (toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents: 30154
diff changeset
536 end = (char *) index (p, '\n');
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
537 sym = oblookup (Vobarray, p + 2,
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
538 multibyte_chars_in_text (p + 2, end - p - 2),
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
539 end - p - 2);
9133
48820d57a24c (get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents: 9087
diff changeset
540 if (SYMBOLP (sym))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
541 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
542 /* Attach a docstring to a variable? */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
543 if (p[1] == 'V')
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
544 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
545 /* Install file-position as variable-documentation property
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
546 and make it negative for a user-variable
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
547 (doc starts with a `*'). */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
548 Fput (sym, Qvariable_documentation,
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
549 make_number ((pos + end + 1 - buf)
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
550 * (end[1] == '*' ? -1 : 1)));
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
551 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
552
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
553 /* Attach a docstring to a function? */
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
554 else if (p[1] == 'F')
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
555 store_function_docstring (sym, pos + end + 1 - buf);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
556
1651
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
557 else
ef09501a0a9b * doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents: 1511
diff changeset
558 error ("DOC file invalid at position %d", pos);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
559 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
560 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
561 pos += end - buf;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
562 filled -= end - buf;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
563 bcopy (end, buf, filled);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
564 }
26088
b7aa6ac26872 Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents: 26076
diff changeset
565 emacs_close (fd);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
566 return Qnil;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
567 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
568
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
569 DEFUN ("substitute-command-keys", Fsubstitute_command_keys,
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
570 Ssubstitute_command_keys, 1, 1, 0,
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
571 "Substitute key descriptions for command names in STRING.\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
572 Return a new string which is STRING with substrings of the form \\=\\[COMMAND]\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
573 replaced by either: a keystroke sequence that will invoke COMMAND,\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
574 or \"M-x COMMAND\" if COMMAND is not on any keys.\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
575 Substrings of the form \\=\\{MAPVAR} are replaced by summaries\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
576 \(made by describe-bindings) of the value of MAPVAR, taken as a keymap.\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
577 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
578 as the keymap for future \\=\\[COMMAND] substrings.\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
579 \\=\\= quotes the following character and is discarded;\n\
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
580 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.")
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
581 (string)
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
582 Lisp_Object string;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
583 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
584 unsigned char *buf;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
585 int changed = 0;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
586 register unsigned char *strp;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
587 register unsigned char *bufp;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
588 int idx;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
589 int bsize;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
590 unsigned char *new;
1511
ff88f962a982 * doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents: 1116
diff changeset
591 Lisp_Object tem;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
592 Lisp_Object keymap;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
593 unsigned char *start;
20802
8cd0a6343a84 (Fsubstitute_command_keys): Declare length_byte out of
Kenichi Handa <handa@m17n.org>
parents: 20708
diff changeset
594 int length, length_byte;
1511
ff88f962a982 * doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents: 1116
diff changeset
595 Lisp_Object name;
ff88f962a982 * doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents: 1116
diff changeset
596 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
597 int multibyte;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
598 int nchars;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
599
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
600 if (NILP (string))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
601 return Qnil;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
602
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
603 CHECK_STRING (string, 0);
1511
ff88f962a982 * doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents: 1116
diff changeset
604 tem = Qnil;
ff88f962a982 * doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents: 1116
diff changeset
605 keymap = Qnil;
ff88f962a982 * doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents: 1116
diff changeset
606 name = Qnil;
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
607 GCPRO4 (string, tem, keymap, name);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
608
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
609 multibyte = STRING_MULTIBYTE (string);
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
610 nchars = 0;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
611
5784
9c3be8e0d2ef (Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents: 5550
diff changeset
612 /* KEYMAP is either nil (which means search all the active keymaps)
9c3be8e0d2ef (Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents: 5550
diff changeset
613 or a specified local map (which means search just that and the
9c3be8e0d2ef (Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents: 5550
diff changeset
614 global map). If non-nil, it might come from Voverriding_local_map,
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
615 or from a \\<mapname> construct in STRING itself.. */
12261
cd2e7821bbf5 (Fsubstitute_command_keys):
Karl Heuer <kwzh@gnu.org>
parents: 11925
diff changeset
616 keymap = current_kboard->Voverriding_terminal_local_map;
cd2e7821bbf5 (Fsubstitute_command_keys):
Karl Heuer <kwzh@gnu.org>
parents: 11925
diff changeset
617 if (NILP (keymap))
cd2e7821bbf5 (Fsubstitute_command_keys):
Karl Heuer <kwzh@gnu.org>
parents: 11925
diff changeset
618 keymap = Voverriding_local_map;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
619
21244
50929073a0ba Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents: 20802
diff changeset
620 bsize = STRING_BYTES (XSTRING (string));
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
621 bufp = buf = (unsigned char *) xmalloc (bsize);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
622
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
623 strp = (unsigned char *) XSTRING (string)->data;
21244
50929073a0ba Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents: 20802
diff changeset
624 while (strp < XSTRING (string)->data + STRING_BYTES (XSTRING (string)))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
625 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
626 if (strp[0] == '\\' && strp[1] == '=')
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
627 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
628 /* \= quotes the next character;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
629 thus, to put in \[ without its special meaning, use \=\[. */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
630 changed = 1;
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
631 strp += 2;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
632 if (multibyte)
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
633 {
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
634 int len;
21244
50929073a0ba Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents: 20802
diff changeset
635 int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
636
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
637 STRING_CHAR_AND_LENGTH (strp, maxlen, len);
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
638 if (len == 1)
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
639 *bufp = *strp;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
640 else
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
641 bcopy (strp, bufp, len);
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
642 strp += len;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
643 bufp += len;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
644 nchars++;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
645 }
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
646 else
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
647 *bufp++ = *strp++, nchars++;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
648 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
649 else if (strp[0] == '\\' && strp[1] == '[')
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
650 {
5248
27d6275810a7 (Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents: 4716
diff changeset
651 Lisp_Object firstkey;
30154
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
652 int start_idx;
5248
27d6275810a7 (Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents: 4716
diff changeset
653
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
654 changed = 1;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
655 strp += 2; /* skip \[ */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
656 start = strp;
30154
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
657 start_idx = start - XSTRING (string)->data;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
658
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
659 while ((strp - (unsigned char *) XSTRING (string)->data
21244
50929073a0ba Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents: 20802
diff changeset
660 < STRING_BYTES (XSTRING (string)))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
661 && *strp != ']')
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
662 strp++;
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
663 length_byte = strp - start;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
664
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
665 strp++; /* skip ] */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
666
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
667 /* Save STRP in IDX. */
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
668 idx = strp - (unsigned char *) XSTRING (string)->data;
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
669 tem = Fintern (make_string (start, length_byte), Qnil);
30154
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
670
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
671 /* Note the Fwhere_is_internal can GC, so we have to take
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
672 relocation of string contents into account. */
5784
9c3be8e0d2ef (Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents: 5550
diff changeset
673 tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);
30154
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
674 strp = XSTRING (string)->data + idx;
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
675 start = XSTRING (string)->data + start_idx;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
676
5248
27d6275810a7 (Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents: 4716
diff changeset
677 /* Disregard menu bar bindings; it is positively annoying to
27d6275810a7 (Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents: 4716
diff changeset
678 mention them when there's no menu bar, and it isn't terribly
27d6275810a7 (Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents: 4716
diff changeset
679 useful even when there is a menu bar. */
5377
7a8463c07d8f (Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 5248
diff changeset
680 if (!NILP (tem))
7a8463c07d8f (Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 5248
diff changeset
681 {
7a8463c07d8f (Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 5248
diff changeset
682 firstkey = Faref (tem, make_number (0));
7a8463c07d8f (Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 5248
diff changeset
683 if (EQ (firstkey, Qmenu_bar))
7a8463c07d8f (Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 5248
diff changeset
684 tem = Qnil;
7a8463c07d8f (Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 5248
diff changeset
685 }
5248
27d6275810a7 (Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents: 4716
diff changeset
686
485
8c615e453683 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 463
diff changeset
687 if (NILP (tem)) /* but not on any keys */
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
688 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
689 new = (unsigned char *) xrealloc (buf, bsize += 4);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
690 bufp += new - buf;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
691 buf = new;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
692 bcopy ("M-x ", bufp, 4);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
693 bufp += 4;
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
694 nchars += 4;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
695 if (multibyte)
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
696 length = multibyte_chars_in_text (start, length_byte);
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
697 else
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
698 length = length_byte;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
699 goto subst;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
700 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
701 else
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
702 { /* function is on a key */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
703 tem = Fkey_description (tem);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
704 goto subst_string;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
705 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
706 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
707 /* \{foo} is replaced with a summary of the keymap (symbol-value foo).
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
708 \<foo> just sets the keymap used for \[cmd]. */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
709 else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<'))
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
710 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
711 struct buffer *oldbuf;
30154
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
712 int start_idx;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
713
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
714 changed = 1;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
715 strp += 2; /* skip \{ or \< */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
716 start = strp;
30154
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
717 start_idx = start - XSTRING (string)->data;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
718
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
719 while ((strp - (unsigned char *) XSTRING (string)->data
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
720 < XSTRING (string)->size)
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
721 && *strp != '}' && *strp != '>')
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
722 strp++;
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
723
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
724 length_byte = strp - start;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
725 strp++; /* skip } or > */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
726
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
727 /* Save STRP in IDX. */
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
728 idx = strp - (unsigned char *) XSTRING (string)->data;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
729
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
730 /* Get the value of the keymap in TEM, or nil if undefined.
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
731 Do this while still in the user's current buffer
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
732 in case it is a local variable. */
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
733 name = Fintern (make_string (start, length_byte), Qnil);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
734 tem = Fboundp (name);
485
8c615e453683 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 463
diff changeset
735 if (! NILP (tem))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
736 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
737 tem = Fsymbol_value (name);
485
8c615e453683 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 463
diff changeset
738 if (! NILP (tem))
30154
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
739 {
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
740 tem = get_keymap_1 (tem, 0, 1);
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
741 /* Note that get_keymap_1 can GC. */
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
742 strp = XSTRING (string)->data + idx;
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
743 start = XSTRING (string)->data + start_idx;
f8e2064c56b1 (Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents: 28334
diff changeset
744 }
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
745 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
746
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
747 /* Now switch to a temp buffer. */
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
748 oldbuf = current_buffer;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
749 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
750
485
8c615e453683 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 463
diff changeset
751 if (NILP (tem))
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
752 {
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
753 name = Fsymbol_name (name);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
754 insert_string ("\nUses keymap \"");
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
755 insert_from_string (name, 0, 0,
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
756 XSTRING (name)->size,
21244
50929073a0ba Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents: 20802
diff changeset
757 STRING_BYTES (XSTRING (name)), 1);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
758 insert_string ("\", which is not currently defined.\n");
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
759 if (start[-1] == '<') keymap = Qnil;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
760 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
761 else if (start[-1] == '<')
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
762 keymap = tem;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
763 else
18746
c7ada1684ebb (Fsubstitute_command_keys): Add missing describe_map_tree argument.
Richard M. Stallman <rms@gnu.org>
parents: 14648
diff changeset
764 describe_map_tree (tem, 1, Qnil, Qnil, (char *)0, 1, 0, 0);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
765 tem = Fbuffer_string ();
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
766 Ferase_buffer ();
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
767 set_buffer_internal (oldbuf);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
768
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
769 subst_string:
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
770 start = XSTRING (tem)->data;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
771 length = XSTRING (tem)->size;
21244
50929073a0ba Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents: 20802
diff changeset
772 length_byte = STRING_BYTES (XSTRING (tem));
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
773 subst:
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
774 new = (unsigned char *) xrealloc (buf, bsize += length_byte);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
775 bufp += new - buf;
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
776 buf = new;
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
777 bcopy (start, bufp, length_byte);
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
778 bufp += length_byte;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
779 nchars += length;
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
780 /* Check STRING again in case gc relocated it. */
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
781 strp = (unsigned char *) XSTRING (string)->data + idx;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
782 }
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
783 else if (! multibyte) /* just copy other chars */
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
784 *bufp++ = *strp++, nchars++;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
785 else
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
786 {
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
787 int len;
21244
50929073a0ba Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents: 20802
diff changeset
788 int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
20619
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
789
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
790 STRING_CHAR_AND_LENGTH (strp, maxlen, len);
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
791 if (len == 1)
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
792 *bufp = *strp;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
793 else
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
794 bcopy (strp, bufp, len);
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
795 strp += len;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
796 bufp += len;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
797 nchars++;
0a559893331d Include charset.h.
Richard M. Stallman <rms@gnu.org>
parents: 18746
diff changeset
798 }
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
799 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
800
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
801 if (changed) /* don't bother if nothing substituted */
21252
fce0c8c246d1 (Fsubstitute_command_keys): Use make_string_from_bytes.
Richard M. Stallman <rms@gnu.org>
parents: 21244
diff changeset
802 tem = make_string_from_bytes (buf, nchars, bufp - buf);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
803 else
14069
a45a97ebdf1c (Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents: 13521
diff changeset
804 tem = string;
2439
b6c62e4abf59 Put interrupt input blocking in a separate file from xterm.h.
Jim Blandy <jimb@redhat.com>
parents: 1651
diff changeset
805 xfree (buf);
1511
ff88f962a982 * doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents: 1116
diff changeset
806 RETURN_UNGCPRO (tem);
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
807 }
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
808
21514
fa9ff387d260 Fix -Wimplicit warnings.
Andreas Schwab <schwab@suse.de>
parents: 21252
diff changeset
809 void
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
810 syms_of_doc ()
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
811 {
28334
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
812 Qfunction_documentation = intern ("function-documentation");
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
813 staticpro (&Qfunction_documentation);
f9cb3463ee2a (Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents: 28036
diff changeset
814
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
815 DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name,
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
816 "Name of file containing documentation strings of built-in symbols.");
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
817 Vdoc_file_name = Qnil;
27552
60c820c7f330 (Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents: 26471
diff changeset
818 DEFVAR_LISP ("help-manyarg-func-alist", &Vhelp_manyarg_func_alist,
60c820c7f330 (Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents: 26471
diff changeset
819 "Alist of primitive functions and descriptions of their arg lists.\n\
60c820c7f330 (Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents: 26471
diff changeset
820 All special forms and primitives which effectively have &rest args\n\
60c820c7f330 (Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents: 26471
diff changeset
821 should have an entry here so that `documentation' can provide their\n\
60c820c7f330 (Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents: 26471
diff changeset
822 arg list.");
60c820c7f330 (Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents: 26471
diff changeset
823 Vhelp_manyarg_func_alist = Qnil;
297
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
824
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
825 defsubr (&Sdocumentation);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
826 defsubr (&Sdocumentation_property);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
827 defsubr (&Ssnarf_documentation);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
828 defsubr (&Ssubstitute_command_keys);
785f88514b16 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
829 }