Mercurial > emacs
annotate src/doc.c @ 10040:c69ddd9fa3a6
(Man-bgproc-sentinel): No need for save-match-data.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 22 Nov 1994 04:37:43 +0000 |
parents | 5b2b7e378772 |
children | 4013c083162e |
rev | line source |
---|---|
297 | 1 /* Record indices of function doc strings stored in a file. |
7307 | 2 Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc. |
297 | 3 |
4 This file is part of GNU Emacs. | |
5 | |
6 GNU Emacs is free software; you can redistribute it and/or modify | |
7 it under the terms of the GNU General Public License as published by | |
8 the Free Software Foundation; either version 1, or (at your option) | |
9 any later version. | |
10 | |
11 GNU Emacs is distributed in the hope that it will be useful, | |
12 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 GNU General Public License for more details. | |
15 | |
16 You should have received a copy of the GNU General Public License | |
17 along with GNU Emacs; see the file COPYING. If not, write to | |
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ | |
19 | |
20 | |
4696
1fc792473491
Include <config.h> instead of "config.h".
Roland McGrath <roland@gnu.org>
parents:
3999
diff
changeset
|
21 #include <config.h> |
297 | 22 |
23 #include <sys/types.h> | |
24 #include <sys/file.h> /* Must be after sys/types.h for USG and BSD4_1*/ | |
25 | |
26 #ifdef USG5 | |
27 #include <fcntl.h> | |
28 #endif | |
29 | |
6862
653504b6b5dd
[HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents:
6030
diff
changeset
|
30 #ifdef HAVE_UNISTD_H |
653504b6b5dd
[HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents:
6030
diff
changeset
|
31 #include <unistd.h> |
653504b6b5dd
[HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents:
6030
diff
changeset
|
32 #endif |
653504b6b5dd
[HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents:
6030
diff
changeset
|
33 |
297 | 34 #ifndef O_RDONLY |
35 #define O_RDONLY 0 | |
36 #endif | |
37 | |
38 #include "lisp.h" | |
39 #include "buffer.h" | |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
40 #include "keyboard.h" |
297 | 41 |
961
8d2cbfd93066
* doc.c (Vdata_directory): Removed; this is declared in callproc.c.
Jim Blandy <jimb@redhat.com>
parents:
943
diff
changeset
|
42 Lisp_Object Vdoc_file_name; |
297 | 43 |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
44 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
|
45 |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
46 /* 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
|
47 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
|
48 static void |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
49 munge_doc_file_name (name) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
50 char *name; |
297 | 51 { |
52 #ifdef VMS | |
53 #ifndef VMS4_4 | |
54 /* For VMS versions with limited file name syntax, | |
55 convert the name to something VMS will allow. */ | |
56 p = name; | |
57 while (*p) | |
58 { | |
59 if (*p == '-') | |
60 *p = '_'; | |
61 p++; | |
62 } | |
63 #endif /* not VMS4_4 */ | |
64 #ifdef VMS4_4 | |
65 strcpy (name, sys_translate_unix (name)); | |
66 #endif /* VMS4_4 */ | |
67 #endif /* VMS */ | |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
68 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
69 |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
70 Lisp_Object |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
71 get_doc_string (filepos) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
72 long filepos; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
73 { |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
74 char buf[512 * 32 + 1]; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
75 register int fd; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
76 register char *name; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
77 register char *p, *p1; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
78 register int count; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
79 int minsize; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
80 extern char *index (); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
81 |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
82 if (!STRINGP (Vdoc_directory) || !STRINGP (Vdoc_file_name)) |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
83 return Qnil; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
84 |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
85 minsize = XSTRING (Vdoc_directory)->size; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
86 /* sizeof ("../etc/") == 8 */ |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
87 if (minsize < 8) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
88 minsize = 8; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
89 name = (char *) alloca (minsize + XSTRING (Vdoc_file_name)->size + 8); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
90 strcpy (name, XSTRING (Vdoc_directory)->data); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
91 strcat (name, XSTRING (Vdoc_file_name)->data); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
92 munge_doc_file_name (name); |
297 | 93 |
94 fd = open (name, O_RDONLY, 0); | |
95 if (fd < 0) | |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
96 { |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
97 #ifndef CANNOT_DUMP |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
98 if (!NILP (Vpurify_flag)) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
99 { |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
100 /* 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
|
101 So check in ../etc. */ |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
102 strcpy (name, "../etc/"); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
103 strcat (name, XSTRING (Vdoc_file_name)->data); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
104 munge_doc_file_name (name); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
105 |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
106 fd = open (name, O_RDONLY, 0); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
107 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
108 #endif |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
109 |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
110 if (fd < 0) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
111 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
|
112 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
113 |
297 | 114 if (0 > lseek (fd, filepos, 0)) |
115 { | |
116 close (fd); | |
117 error ("Position %ld out of range in doc string file \"%s\"", | |
118 filepos, name); | |
119 } | |
120 p = buf; | |
121 while (p != buf + sizeof buf - 1) | |
122 { | |
123 count = read (fd, p, 512); | |
124 p[count] = 0; | |
125 if (!count) | |
126 break; | |
127 p1 = index (p, '\037'); | |
128 if (p1) | |
129 { | |
130 *p1 = 0; | |
131 p = p1; | |
132 break; | |
133 } | |
134 p += count; | |
135 } | |
136 close (fd); | |
137 return make_string (buf, p - buf); | |
138 } | |
139 | |
570 | 140 DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0, |
604 | 141 "Return the documentation string of FUNCTION.\n\ |
142 Unless a non-nil second argument is given, the\n\ | |
570 | 143 string is passed through `substitute-command-keys'.") |
647 | 144 (function, raw) |
145 Lisp_Object function, raw; | |
297 | 146 { |
147 Lisp_Object fun; | |
148 Lisp_Object funcar; | |
570 | 149 Lisp_Object tem, doc; |
297 | 150 |
647 | 151 fun = Findirect_function (function); |
297 | 152 |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
153 if (SUBRP (fun)) |
297 | 154 { |
155 if (XSUBR (fun)->doc == 0) return Qnil; | |
8823
fdb7ba55f05c
(Fdocumentation): Use EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents:
8552
diff
changeset
|
156 if ((EMACS_INT) XSUBR (fun)->doc >= 0) |
570 | 157 doc = build_string (XSUBR (fun)->doc); |
297 | 158 else |
8823
fdb7ba55f05c
(Fdocumentation): Use EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents:
8552
diff
changeset
|
159 doc = get_doc_string (- (EMACS_INT) XSUBR (fun)->doc); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
160 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
161 else if (COMPILEDP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
162 { |
297 | 163 if (XVECTOR (fun)->size <= COMPILED_DOC_STRING) |
164 return Qnil; | |
165 tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING]; | |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
166 if (STRINGP (tem)) |
570 | 167 doc = tem; |
9958
25a7e3557fd3
(Fdocumentation): Use NATNUMP instead of its expansion.
Karl Heuer <kwzh@gnu.org>
parents:
9304
diff
changeset
|
168 else if (NATNUMP (tem)) |
570 | 169 doc = get_doc_string (XFASTINT (tem)); |
170 else | |
171 return Qnil; | |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
172 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
173 else if (STRINGP (fun) || VECTORP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
174 { |
297 | 175 return build_string ("Keyboard macro."); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
176 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
177 else if (CONSP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
178 { |
297 | 179 funcar = Fcar (fun); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
180 if (!SYMBOLP (funcar)) |
297 | 181 return Fsignal (Qinvalid_function, Fcons (fun, Qnil)); |
647 | 182 else if (EQ (funcar, Qkeymap)) |
297 | 183 return build_string ("Prefix command (definition is a keymap associating keystrokes with\n\ |
184 subcommands.)"); | |
647 | 185 else if (EQ (funcar, Qlambda) |
186 || EQ (funcar, Qautoload)) | |
297 | 187 { |
188 tem = Fcar (Fcdr (Fcdr (fun))); | |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
189 if (STRINGP (tem)) |
570 | 190 doc = tem; |
9958
25a7e3557fd3
(Fdocumentation): Use NATNUMP instead of its expansion.
Karl Heuer <kwzh@gnu.org>
parents:
9304
diff
changeset
|
191 else if (NATNUMP (tem)) |
570 | 192 doc = get_doc_string (XFASTINT (tem)); |
193 else | |
194 return Qnil; | |
297 | 195 } |
647 | 196 else if (EQ (funcar, Qmocklisp)) |
297 | 197 return Qnil; |
647 | 198 else if (EQ (funcar, Qmacro)) |
570 | 199 return Fdocumentation (Fcdr (fun), raw); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
200 else |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
201 goto oops; |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
202 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
203 else |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
204 { |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
205 oops: |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
206 Fsignal (Qinvalid_function, Fcons (fun, Qnil)); |
297 | 207 } |
570 | 208 |
577 | 209 if (NILP (raw)) |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
210 { |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
211 struct gcpro gcpro1; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
212 |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
213 GCPRO1 (doc); |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
214 doc = Fsubstitute_command_keys (doc); |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
215 UNGCPRO; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
216 } |
570 | 217 return doc; |
297 | 218 } |
219 | |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
220 DEFUN ("documentation-property", Fdocumentation_property, Sdocumentation_property, 2, 3, 0, |
297 | 221 "Return the documentation string that is SYMBOL's PROP property.\n\ |
570 | 222 This is like `get', but it can refer to strings stored in the\n\ |
604 | 223 `etc/DOC' file; and if the value is a string, it is passed through\n\ |
577 | 224 `substitute-command-keys'. A non-nil third argument avoids this\n\ |
225 translation.") | |
570 | 226 (sym, prop, raw) |
227 Lisp_Object sym, prop, raw; | |
297 | 228 { |
229 register Lisp_Object tem; | |
230 | |
231 tem = Fget (sym, prop); | |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
232 if (INTEGERP (tem)) |
297 | 233 tem = get_doc_string (XINT (tem) > 0 ? XINT (tem) : - XINT (tem)); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
234 if (NILP (raw) && STRINGP (tem)) |
312
adba7439e87c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
297
diff
changeset
|
235 return Fsubstitute_command_keys (tem); |
adba7439e87c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
297
diff
changeset
|
236 return tem; |
297 | 237 } |
238 | |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
239 /* 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
|
240 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
241 static void |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
242 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
|
243 Lisp_Object fun; |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
244 int offset; |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
245 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
246 fun = indirect_function (fun); |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
247 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
248 /* 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
|
249 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
250 /* Lisp_Subrs have a slot for it. */ |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
251 if (SUBRP (fun)) |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
252 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
|
253 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
254 /* 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
|
255 else if (CONSP (fun)) |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
256 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
257 Lisp_Object tem; |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
258 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
259 tem = XCONS (fun)->car; |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
260 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
|
261 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
262 tem = Fcdr (Fcdr (fun)); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
263 if (CONSP (tem) && INTEGERP (XCONS (tem)->car)) |
9304
1fbc46670cb0
(store_function_docstring): Don't use XFASTINT as an lvalue.
Karl Heuer <kwzh@gnu.org>
parents:
9133
diff
changeset
|
264 XSETFASTINT (XCONS (tem)->car, offset); |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
265 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
266 else if (EQ (tem, Qmacro)) |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
267 store_function_docstring (XCONS (fun)->cdr, offset); |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
268 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
269 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
270 /* Bytecode objects sometimes have slots for it. */ |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
271 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
|
272 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
273 /* 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
|
274 docstring, since we've found a docstring for it. */ |
8552
1353c008cf8e
(store_function_docstring): Do nothing for bytecode object
Richard M. Stallman <rms@gnu.org>
parents:
7307
diff
changeset
|
275 if (XVECTOR (fun)->size > COMPILED_DOC_STRING) |
9304
1fbc46670cb0
(store_function_docstring): Don't use XFASTINT as an lvalue.
Karl Heuer <kwzh@gnu.org>
parents:
9133
diff
changeset
|
276 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
|
277 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
278 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
279 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
280 |
297 | 281 DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation, |
282 1, 1, 0, | |
283 "Used during Emacs initialization, before dumping runnable Emacs,\n\ | |
604 | 284 to find pointers to doc strings stored in `etc/DOC...' and\n\ |
297 | 285 record them in function definitions.\n\ |
286 One arg, FILENAME, a string which does not include a directory.\n\ | |
604 | 287 The file is found in `../etc' now; found in the `data-directory'\n\ |
297 | 288 when doc strings are referred to later in the dumped Emacs.") |
289 (filename) | |
290 Lisp_Object filename; | |
291 { | |
292 int fd; | |
293 char buf[1024 + 1]; | |
294 register int filled; | |
295 register int pos; | |
296 register char *p, *end; | |
297 Lisp_Object sym, fun, tem; | |
298 char *name; | |
299 extern char *index (); | |
300 | |
1116
6d0d442e2ada
* doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents:
961
diff
changeset
|
301 #ifndef CANNOT_DUMP |
6d0d442e2ada
* doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents:
961
diff
changeset
|
302 if (NILP (Vpurify_flag)) |
6d0d442e2ada
* doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents:
961
diff
changeset
|
303 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
|
304 #endif |
6d0d442e2ada
* doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents:
961
diff
changeset
|
305 |
297 | 306 CHECK_STRING (filename, 0); |
307 | |
308 #ifndef CANNOT_DUMP | |
463 | 309 name = (char *) alloca (XSTRING (filename)->size + 14); |
604 | 310 strcpy (name, "../etc/"); |
297 | 311 #else /* CANNOT_DUMP */ |
6030
8b3f54fb451f
(get_doc_string, Snarf_documentation): Use new variable doc_directory.
Karl Heuer <kwzh@gnu.org>
parents:
5784
diff
changeset
|
312 CHECK_STRING (Vdoc_directory, 0); |
297 | 313 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
|
314 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
|
315 strcpy (name, XSTRING (Vdoc_directory)->data); |
297 | 316 #endif /* CANNOT_DUMP */ |
317 strcat (name, XSTRING (filename)->data); /*** Add this line ***/ | |
318 #ifdef VMS | |
319 #ifndef VMS4_4 | |
320 /* For VMS versions with limited file name syntax, | |
321 convert the name to something VMS will allow. */ | |
322 p = name; | |
323 while (*p) | |
324 { | |
325 if (*p == '-') | |
326 *p = '_'; | |
327 p++; | |
328 } | |
329 #endif /* not VMS4_4 */ | |
330 #ifdef VMS4_4 | |
331 strcpy (name, sys_translate_unix (name)); | |
332 #endif /* VMS4_4 */ | |
333 #endif /* VMS */ | |
334 | |
335 fd = open (name, O_RDONLY, 0); | |
336 if (fd < 0) | |
337 report_file_error ("Opening doc string file", | |
338 Fcons (build_string (name), Qnil)); | |
339 Vdoc_file_name = filename; | |
340 filled = 0; | |
341 pos = 0; | |
342 while (1) | |
343 { | |
344 if (filled < 512) | |
345 filled += read (fd, &buf[filled], sizeof buf - 1 - filled); | |
346 if (!filled) | |
347 break; | |
348 | |
349 buf[filled] = 0; | |
350 p = buf; | |
351 end = buf + (filled < 512 ? filled : filled - 128); | |
352 while (p != end && *p != '\037') p++; | |
353 /* p points to ^_Ffunctionname\n or ^_Vvarname\n. */ | |
354 if (p != end) | |
355 { | |
356 end = index (p, '\n'); | |
357 sym = oblookup (Vobarray, p + 2, end - p - 2); | |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
358 if (SYMBOLP (sym)) |
297 | 359 { |
360 /* Attach a docstring to a variable? */ | |
361 if (p[1] == 'V') | |
362 { | |
363 /* Install file-position as variable-documentation property | |
364 and make it negative for a user-variable | |
365 (doc starts with a `*'). */ | |
366 Fput (sym, Qvariable_documentation, | |
367 make_number ((pos + end + 1 - buf) | |
368 * (end[1] == '*' ? -1 : 1))); | |
369 } | |
370 | |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
371 /* Attach a docstring to a function? */ |
297 | 372 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
|
373 store_function_docstring (sym, pos + end + 1 - buf); |
297 | 374 |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
375 else |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
376 error ("DOC file invalid at position %d", pos); |
297 | 377 } |
378 } | |
379 pos += end - buf; | |
380 filled -= end - buf; | |
381 bcopy (end, buf, filled); | |
382 } | |
383 close (fd); | |
384 return Qnil; | |
385 } | |
386 | |
387 DEFUN ("substitute-command-keys", Fsubstitute_command_keys, | |
388 Ssubstitute_command_keys, 1, 1, 0, | |
389 "Substitute key descriptions for command names in STRING.\n\ | |
390 Return a new string which is STRING with substrings of the form \\=\\[COMMAND]\n\ | |
391 replaced by either: a keystroke sequence that will invoke COMMAND,\n\ | |
392 or \"M-x COMMAND\" if COMMAND is not on any keys.\n\ | |
393 Substrings of the form \\=\\{MAPVAR} are replaced by summaries\n\ | |
394 \(made by describe-bindings) of the value of MAPVAR, taken as a keymap.\n\ | |
395 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR\n\ | |
396 as the keymap for future \\=\\[COMMAND] substrings.\n\ | |
397 \\=\\= quotes the following character and is discarded;\n\ | |
398 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.") | |
399 (str) | |
400 Lisp_Object str; | |
401 { | |
402 unsigned char *buf; | |
403 int changed = 0; | |
404 register unsigned char *strp; | |
405 register unsigned char *bufp; | |
406 int idx; | |
407 int bsize; | |
408 unsigned char *new; | |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
409 Lisp_Object tem; |
297 | 410 Lisp_Object keymap; |
411 unsigned char *start; | |
412 int length; | |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
413 Lisp_Object name; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
414 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; |
297 | 415 |
485 | 416 if (NILP (str)) |
297 | 417 return Qnil; |
418 | |
419 CHECK_STRING (str, 0); | |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
420 tem = Qnil; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
421 keymap = Qnil; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
422 name = Qnil; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
423 GCPRO4 (str, tem, keymap, name); |
297 | 424 |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
425 /* 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
|
426 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
|
427 global map). If non-nil, it might come from Voverriding_local_map, |
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
428 or from a \\<mapname> construct in STR itself.. */ |
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
429 keymap = Voverriding_local_map; |
297 | 430 |
431 bsize = XSTRING (str)->size; | |
432 bufp = buf = (unsigned char *) xmalloc (bsize); | |
433 | |
434 strp = (unsigned char *) XSTRING (str)->data; | |
435 while (strp < (unsigned char *) XSTRING (str)->data + XSTRING (str)->size) | |
436 { | |
437 if (strp[0] == '\\' && strp[1] == '=') | |
438 { | |
439 /* \= quotes the next character; | |
440 thus, to put in \[ without its special meaning, use \=\[. */ | |
441 changed = 1; | |
442 *bufp++ = strp[2]; | |
443 strp += 3; | |
444 } | |
445 else if (strp[0] == '\\' && strp[1] == '[') | |
446 { | |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
447 Lisp_Object firstkey; |
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
448 |
297 | 449 changed = 1; |
450 strp += 2; /* skip \[ */ | |
451 start = strp; | |
452 | |
453 while ((strp - (unsigned char *) XSTRING (str)->data | |
454 < XSTRING (str)->size) | |
455 && *strp != ']') | |
456 strp++; | |
457 length = strp - start; | |
458 strp++; /* skip ] */ | |
459 | |
460 /* Save STRP in IDX. */ | |
461 idx = strp - (unsigned char *) XSTRING (str)->data; | |
462 tem = Fintern (make_string (start, length), Qnil); | |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
463 tem = Fwhere_is_internal (tem, keymap, Qt, Qnil); |
297 | 464 |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
465 /* 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
|
466 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
|
467 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
|
468 if (!NILP (tem)) |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
469 { |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
470 firstkey = Faref (tem, make_number (0)); |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
471 if (EQ (firstkey, Qmenu_bar)) |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
472 tem = Qnil; |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
473 } |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
474 |
485 | 475 if (NILP (tem)) /* but not on any keys */ |
297 | 476 { |
477 new = (unsigned char *) xrealloc (buf, bsize += 4); | |
478 bufp += new - buf; | |
479 buf = new; | |
480 bcopy ("M-x ", bufp, 4); | |
481 bufp += 4; | |
482 goto subst; | |
483 } | |
484 else | |
485 { /* function is on a key */ | |
486 tem = Fkey_description (tem); | |
487 goto subst_string; | |
488 } | |
489 } | |
490 /* \{foo} is replaced with a summary of the keymap (symbol-value foo). | |
491 \<foo> just sets the keymap used for \[cmd]. */ | |
492 else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<')) | |
493 { | |
494 struct buffer *oldbuf; | |
495 | |
496 changed = 1; | |
497 strp += 2; /* skip \{ or \< */ | |
498 start = strp; | |
499 | |
500 while ((strp - (unsigned char *) XSTRING (str)->data | |
501 < XSTRING (str)->size) | |
502 && *strp != '}' && *strp != '>') | |
503 strp++; | |
504 length = strp - start; | |
505 strp++; /* skip } or > */ | |
506 | |
507 /* Save STRP in IDX. */ | |
508 idx = strp - (unsigned char *) XSTRING (str)->data; | |
509 | |
510 /* Get the value of the keymap in TEM, or nil if undefined. | |
511 Do this while still in the user's current buffer | |
512 in case it is a local variable. */ | |
513 name = Fintern (make_string (start, length), Qnil); | |
514 tem = Fboundp (name); | |
485 | 515 if (! NILP (tem)) |
297 | 516 { |
517 tem = Fsymbol_value (name); | |
485 | 518 if (! NILP (tem)) |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
519 tem = get_keymap_1 (tem, 0, 1); |
297 | 520 } |
521 | |
522 /* Now switch to a temp buffer. */ | |
523 oldbuf = current_buffer; | |
524 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer)); | |
525 | |
485 | 526 if (NILP (tem)) |
297 | 527 { |
528 name = Fsymbol_name (name); | |
529 insert_string ("\nUses keymap \""); | |
4716
4382ad05411e
(Fsubstitute_command_keys): Pass new arg to insert_from_string.
Richard M. Stallman <rms@gnu.org>
parents:
4696
diff
changeset
|
530 insert_from_string (name, 0, XSTRING (name)->size, 1); |
297 | 531 insert_string ("\", which is not currently defined.\n"); |
532 if (start[-1] == '<') keymap = Qnil; | |
533 } | |
534 else if (start[-1] == '<') | |
535 keymap = tem; | |
536 else | |
5550
9e8bbed9a9b6
(Fsubstitute_command_keys): Pass new arg to describe_map_tree.
Richard M. Stallman <rms@gnu.org>
parents:
5377
diff
changeset
|
537 describe_map_tree (tem, 1, Qnil, Qnil, 0, 1); |
297 | 538 tem = Fbuffer_string (); |
539 Ferase_buffer (); | |
540 set_buffer_internal (oldbuf); | |
541 | |
542 subst_string: | |
543 start = XSTRING (tem)->data; | |
544 length = XSTRING (tem)->size; | |
545 subst: | |
546 new = (unsigned char *) xrealloc (buf, bsize += length); | |
547 bufp += new - buf; | |
548 buf = new; | |
549 bcopy (start, bufp, length); | |
550 bufp += length; | |
551 /* Check STR again in case gc relocated it. */ | |
552 strp = (unsigned char *) XSTRING (str)->data + idx; | |
553 } | |
554 else /* just copy other chars */ | |
555 *bufp++ = *strp++; | |
556 } | |
557 | |
558 if (changed) /* don't bother if nothing substituted */ | |
559 tem = make_string (buf, bufp - buf); | |
560 else | |
561 tem = str; | |
2439
b6c62e4abf59
Put interrupt input blocking in a separate file from xterm.h.
Jim Blandy <jimb@redhat.com>
parents:
1651
diff
changeset
|
562 xfree (buf); |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
563 RETURN_UNGCPRO (tem); |
297 | 564 } |
565 | |
566 syms_of_doc () | |
567 { | |
568 DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name, | |
569 "Name of file containing documentation strings of built-in symbols."); | |
570 Vdoc_file_name = Qnil; | |
571 | |
572 defsubr (&Sdocumentation); | |
573 defsubr (&Sdocumentation_property); | |
574 defsubr (&Ssnarf_documentation); | |
575 defsubr (&Ssubstitute_command_keys); | |
576 } |