Mercurial > emacs
annotate src/doc.c @ 45038:8db238933124
Delete ediff-hook.el page.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 30 Apr 2002 17:48:09 +0000 |
parents | d5cf9afe17d6 |
children | 65ad2c8b301b |
rev | line source |
---|---|
297 | 1 /* Record indices of function doc strings stored in a file. |
27560 | 2 Copyright (C) 1985, 86,93,94,95,97,98,99, 2000 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 | |
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 | 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 | |
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 | 20 |
21 | |
4696
1fc792473491
Include <config.h> instead of "config.h".
Roland McGrath <roland@gnu.org>
parents:
3999
diff
changeset
|
22 #include <config.h> |
297 | 23 |
24 #include <sys/types.h> | |
25 #include <sys/file.h> /* Must be after sys/types.h for USG and BSD4_1*/ | |
26 | |
27 #ifdef USG5 | |
28 #include <fcntl.h> | |
29 #endif | |
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 | 35 #ifndef O_RDONLY |
36 #define O_RDONLY 0 | |
37 #endif | |
38 | |
39 #include "lisp.h" | |
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 | 42 #include "charset.h" |
39697
0b986bb45526
Include keymap.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39675
diff
changeset
|
43 #include "keymap.h" |
297 | 44 |
31336 | 45 #ifdef HAVE_INDEX |
46 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
|
47 #endif |
7930c46bb365
(toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents:
30154
diff
changeset
|
48 |
40139
0600331ddd52
(Vhelp_manyarg_func_alist): Variable removed.
Miles Bader <miles@gnu.org>
parents:
39973
diff
changeset
|
49 Lisp_Object Vdoc_file_name; |
297 | 50 |
28334
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
51 Lisp_Object Qfunction_documentation; |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
52 |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
53 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
|
54 |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
55 /* 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
|
56 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
|
57 static void |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
58 munge_doc_file_name (name) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
59 char *name; |
297 | 60 { |
61 #ifdef VMS | |
62 #ifndef VMS4_4 | |
63 /* For VMS versions with limited file name syntax, | |
64 convert the name to something VMS will allow. */ | |
65 p = name; | |
66 while (*p) | |
67 { | |
68 if (*p == '-') | |
69 *p = '_'; | |
70 p++; | |
71 } | |
72 #endif /* not VMS4_4 */ | |
73 #ifdef VMS4_4 | |
74 strcpy (name, sys_translate_unix (name)); | |
75 #endif /* VMS4_4 */ | |
76 #endif /* VMS */ | |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
77 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
78 |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
79 /* 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
|
80 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
|
81 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
|
82 |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
83 static unsigned char *read_bytecode_pointer; |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
84 Lisp_Object Fsnarf_documentation P_ ((Lisp_Object)); |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
85 |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
86 /* 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
|
87 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
|
88 |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
89 int |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
90 read_bytecode_char (unreadflag) |
25758
fca9459a0555
(read_bytecode_char): Declare arg.
Dave Love <fx@gnu.org>
parents:
25662
diff
changeset
|
91 int unreadflag; |
22690
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 if (unreadflag) |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
94 { |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
95 read_bytecode_pointer--; |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
96 return 0; |
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 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
|
99 } |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
100 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
101 /* 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
|
102 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
|
103 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
|
104 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
|
105 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
|
106 (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
|
107 them without actually fetching the doc string.) |
10a9f355a346
(get_doc_string): New arg UNIBYTE
Richard M. Stallman <rms@gnu.org>
parents:
21514
diff
changeset
|
108 |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
109 If the location does not point to the beginning of a docstring |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
110 (e.g. because the file has been modified and the location is stale), |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
111 return nil. |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
112 |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
113 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
|
114 |
22562
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
115 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
|
116 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
|
117 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
|
118 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
|
119 |
22268
9308a15aa8f8
(get_doc_string): Make non-static.
Richard M. Stallman <rms@gnu.org>
parents:
22043
diff
changeset
|
120 Lisp_Object |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
121 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
|
122 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
|
123 int unibyte, definition; |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
124 { |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
125 char *from, *to; |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
126 register int fd; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
127 register char *name; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
128 register char *p, *p1; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
129 int minsize; |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
130 int offset, position; |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
131 Lisp_Object file, tem; |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
132 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
133 if (INTEGERP (filepos)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
134 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
135 file = Vdoc_file_name; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
136 position = XINT (filepos); |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
137 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
138 else if (CONSP (filepos)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
139 { |
25662
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
140 file = XCAR (filepos); |
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
141 position = XINT (XCDR (filepos)); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
142 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
143 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
144 return Qnil; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
145 |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
146 if (position < 0) |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
147 position = - position; |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
148 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
149 if (!STRINGP (Vdoc_directory)) |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
150 return Qnil; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
151 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
152 if (!STRINGP (file)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
153 return Qnil; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
154 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
155 /* 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
|
156 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
|
157 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
158 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
|
159 if (NILP (tem)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
160 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
161 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
|
162 /* sizeof ("../etc/") == 8 */ |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
163 if (minsize < 8) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
164 minsize = 8; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
165 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
|
166 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
|
167 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
|
168 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
|
169 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
170 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
171 { |
11446
cee0510aa3aa
(get_doc_string): Add cast.
Richard M. Stallman <rms@gnu.org>
parents:
11252
diff
changeset
|
172 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
|
173 } |
297 | 174 |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
175 fd = emacs_open (name, O_RDONLY, 0); |
297 | 176 if (fd < 0) |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
177 { |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
178 #ifndef CANNOT_DUMP |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
179 if (!NILP (Vpurify_flag)) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
180 { |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
181 /* 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
|
182 So check in ../etc. */ |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
183 strcpy (name, "../etc/"); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
184 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
|
185 munge_doc_file_name (name); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
186 |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
187 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
|
188 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
189 #endif |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
190 if (fd < 0) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
191 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
|
192 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
193 |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
194 /* Seek only to beginning of disk block. */ |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
195 /* Make sure we read at least 1024 bytes before `position' |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
196 so we can check the leading text for consistency. */ |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
197 offset = min (position, max (1024, position % (8 * 1024))); |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
198 if (0 > lseek (fd, position - offset, 0)) |
297 | 199 { |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
200 emacs_close (fd); |
297 | 201 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
|
202 position, name); |
297 | 203 } |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
204 |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
205 /* 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
|
206 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
|
207 |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
208 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
|
209 while (1) |
297 | 210 { |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
211 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
|
212 - (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
|
213 int nread; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
214 |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
215 /* 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
|
216 if (space_left == 0) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
217 { |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
218 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
|
219 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
|
220 get_doc_string_buffer |
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
221 = (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
|
222 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
|
223 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
|
224 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
|
225 - (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
|
226 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
227 |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
228 /* 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
|
229 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
|
230 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
|
231 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
|
232 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
|
233 if (nread < 0) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
234 { |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
235 emacs_close (fd); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
236 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
|
237 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
238 p[nread] = 0; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
239 if (!nread) |
297 | 240 break; |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
241 if (p == get_doc_string_buffer) |
31225
7930c46bb365
(toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents:
30154
diff
changeset
|
242 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
|
243 else |
31225
7930c46bb365
(toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents:
30154
diff
changeset
|
244 p1 = (char *) index (p, '\037'); |
297 | 245 if (p1) |
246 { | |
247 *p1 = 0; | |
248 p = p1; | |
249 break; | |
250 } | |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
251 p += nread; |
297 | 252 } |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
253 emacs_close (fd); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
254 |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
255 /* Sanity checking. */ |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
256 if (CONSP (filepos)) |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
257 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
258 int test = 1; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
259 if (get_doc_string_buffer[offset - test++] != ' ') |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
260 return Qnil; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
261 while (get_doc_string_buffer[offset - test] >= '0' |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
262 && get_doc_string_buffer[offset - test] <= '9') |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
263 test++; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
264 if (get_doc_string_buffer[offset - test++] != '@' |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
265 || get_doc_string_buffer[offset - test] != '#') |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
266 return Qnil; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
267 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
268 else |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
269 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
270 int test = 1; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
271 if (get_doc_string_buffer[offset - test++] != '\n') |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
272 return Qnil; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
273 while (get_doc_string_buffer[offset - test] > ' ') |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
274 test++; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
275 if (get_doc_string_buffer[offset - test] != '\037') |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
276 return Qnil; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
277 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
278 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
279 /* 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
|
280 ^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
|
281 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
|
282 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
|
283 while (from != p) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
284 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
285 if (*from == 1) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
286 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
287 int c; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
288 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
289 from++; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
290 c = *from++; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
291 if (c == 1) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
292 *to++ = c; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
293 else if (c == '0') |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
294 *to++ = 0; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
295 else if (c == '_') |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
296 *to++ = 037; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
297 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
298 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
|
299 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
300 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
301 *to++ = *from++; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
302 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
303 |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
304 /* 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
|
305 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
|
306 if (definition) |
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
307 { |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
308 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
|
309 return Fread (Qlambda); |
22562
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
310 } |
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
311 |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
312 if (unibyte) |
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
313 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
|
314 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
|
315 else |
24573
aa24b1cb428a
(get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents:
23921
diff
changeset
|
316 { |
aa24b1cb428a
(get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents:
23921
diff
changeset
|
317 /* 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
|
318 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
|
319 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
|
320 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
|
321 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
|
322 nchars, |
aa24b1cb428a
(get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents:
23921
diff
changeset
|
323 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
|
324 } |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
325 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
326 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
327 /* 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
|
328 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
|
329 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
|
330 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
331 Lisp_Object |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
332 read_doc_string (filepos) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
333 Lisp_Object filepos; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
334 { |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
335 return get_doc_string (filepos, 0, 1); |
297 | 336 } |
337 | |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
338 static int |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
339 reread_doc_file (file) |
44355
412b4760216b
(reread_doc_file): Add missing argument declaration.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44348
diff
changeset
|
340 Lisp_Object file; |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
341 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
342 Lisp_Object reply, prompt[3]; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
343 struct gcpro gcpro1; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
344 GCPRO1 (file); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
345 prompt[0] = build_string ("File "); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
346 prompt[1] = NILP (file) ? Vdoc_file_name : file; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
347 prompt[2] = build_string (" is out-of-sync. Reload? "); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
348 reply = Fy_or_n_p (Fconcat (3, prompt)); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
349 UNGCPRO; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
350 if (NILP (reply)) |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
351 return 0; |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
352 |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
353 if (NILP (file)) |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
354 Fsnarf_documentation (Vdoc_file_name); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
355 else |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
356 Fload (file, Qt, Qt, Qt, Qnil); |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
357 |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
358 return 1; |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
359 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
360 |
570 | 361 DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0, |
41001
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
362 doc: /* Return the documentation string of FUNCTION. |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
363 Unless a non-nil second argument RAW is given, the |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
364 string is passed through `substitute-command-keys'. */) |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
365 (function, raw) |
647 | 366 Lisp_Object function, raw; |
297 | 367 { |
368 Lisp_Object fun; | |
369 Lisp_Object funcar; | |
570 | 370 Lisp_Object tem, doc; |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
371 int try_reload = 1; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
372 |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
373 documentation: |
297 | 374 |
34363
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
375 doc = Qnil; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
376 |
28334
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
377 if (SYMBOLP (function) |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
378 && (tem = Fget (function, Qfunction_documentation), |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
379 !NILP (tem))) |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
380 return Fdocumentation_property (function, Qfunction_documentation, raw); |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
381 |
647 | 382 fun = Findirect_function (function); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
383 if (SUBRP (fun)) |
297 | 384 { |
28334
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
385 if (XSUBR (fun)->doc == 0) |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
386 return Qnil; |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
387 else if ((EMACS_INT) XSUBR (fun)->doc >= 0) |
570 | 388 doc = build_string (XSUBR (fun)->doc); |
297 | 389 else |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
390 doc = make_number ((EMACS_INT) XSUBR (fun)->doc); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
391 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
392 else if (COMPILEDP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
393 { |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
394 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING) |
297 | 395 return Qnil; |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
396 tem = AREF (fun, COMPILED_DOC_STRING); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
397 if (STRINGP (tem)) |
570 | 398 doc = tem; |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
399 else if (NATNUMP (tem) || CONSP (tem)) |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
400 doc = tem; |
570 | 401 else |
402 return Qnil; | |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
403 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
404 else if (STRINGP (fun) || VECTORP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
405 { |
297 | 406 return build_string ("Keyboard macro."); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
407 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
408 else if (CONSP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
409 { |
297 | 410 funcar = Fcar (fun); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
411 if (!SYMBOLP (funcar)) |
297 | 412 return Fsignal (Qinvalid_function, Fcons (fun, Qnil)); |
647 | 413 else if (EQ (funcar, Qkeymap)) |
23921
81a6345fd5e8
(Fdocumentation): Change the doc string for prefix
Andreas Schwab <schwab@suse.de>
parents:
22890
diff
changeset
|
414 return build_string ("Prefix command (definition is a keymap associating keystrokes with commands)."); |
647 | 415 else if (EQ (funcar, Qlambda) |
416 || EQ (funcar, Qautoload)) | |
297 | 417 { |
13521
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
418 Lisp_Object tem1; |
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
419 tem1 = Fcdr (Fcdr (fun)); |
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
420 tem = Fcar (tem1); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
421 if (STRINGP (tem)) |
570 | 422 doc = tem; |
13521
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
423 /* 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
|
424 in the function body, so reject them if they are last. */ |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
425 else if ((NATNUMP (tem) || (CONSP (tem) && INTEGERP (XCDR (tem)))) |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
426 && !NILP (XCDR (tem1))) |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
427 doc = tem; |
570 | 428 else |
429 return Qnil; | |
297 | 430 } |
647 | 431 else if (EQ (funcar, Qmacro)) |
570 | 432 return Fdocumentation (Fcdr (fun), raw); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
433 else |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
434 goto oops; |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
435 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
436 else |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
437 { |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
438 oops: |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
439 Fsignal (Qinvalid_function, Fcons (fun, Qnil)); |
297 | 440 } |
570 | 441 |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
442 /* If DOC is 0, it's typically because of a dumped file missing |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
443 from the DOC file (bug in src/Makefile.in). */ |
44385
d5cf9afe17d6
(Fdocumentation): More brainos. I need sleep.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44383
diff
changeset
|
444 if (EQ (doc, make_number (0))) |
d5cf9afe17d6
(Fdocumentation): More brainos. I need sleep.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44383
diff
changeset
|
445 doc = Qnil; |
44381
15b5489c78d6
(Fdocumentation, Fdocumentation_property): When the doc
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44355
diff
changeset
|
446 if (INTEGERP (doc) || CONSP (doc)) |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
447 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
448 Lisp_Object tem; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
449 tem = get_doc_string (doc, 0, 0); |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
450 if (NILP (tem) && try_reload) |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
451 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
452 /* The file is newer, we need to reset the pointers. */ |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
453 struct gcpro gcpro1, gcpro2; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
454 GCPRO2 (function, raw); |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
455 try_reload = reread_doc_file (Fcar_safe (doc)); |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
456 UNGCPRO; |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
457 if (try_reload) |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
458 { |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
459 try_reload = 0; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
460 goto documentation; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
461 } |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
462 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
463 else |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
464 doc = tem; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
465 } |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
466 |
577 | 467 if (NILP (raw)) |
26471
b1863c0b8f9c
(Fdocumentation): Remove gcpro here too.
Dave Love <fx@gnu.org>
parents:
26420
diff
changeset
|
468 doc = Fsubstitute_command_keys (doc); |
570 | 469 return doc; |
297 | 470 } |
471 | |
28036
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
472 DEFUN ("documentation-property", Fdocumentation_property, |
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
473 Sdocumentation_property, 2, 3, 0, |
41001
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
474 doc: /* Return the documentation string that is SYMBOL's PROP property. |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
475 Third argument RAW omitted or nil means pass the result through |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
476 `substitute-command-keys' if it is a string. |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
477 |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
478 This differs from `get' in that it can refer to strings stored in the |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
479 `etc/DOC' file; and that it evaluates documentation properties that |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
480 aren't strings. */) |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
481 (symbol, prop, raw) |
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
482 Lisp_Object symbol, prop, raw; |
297 | 483 { |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
484 int try_reload = 1; |
26076
edbfca66058d
(Fdocumentation_property): Remove register declaration for `tem'.
Dave Love <fx@gnu.org>
parents:
26075
diff
changeset
|
485 Lisp_Object tem; |
297 | 486 |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
487 documentation_property: |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
488 |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
489 tem = Fget (symbol, prop); |
44383
e44eec58a815
(Fdocumentation): Add missing parentheses.
Juanma Barranquero <lekktu@gmail.com>
parents:
44381
diff
changeset
|
490 if (EQ (tem, make_number (0))) |
44385
d5cf9afe17d6
(Fdocumentation): More brainos. I need sleep.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44383
diff
changeset
|
491 tem = Qnil; |
44381
15b5489c78d6
(Fdocumentation, Fdocumentation_property): When the doc
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44355
diff
changeset
|
492 if (INTEGERP (tem) || (CONSP (tem) && INTEGERP (XCDR (tem)))) |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
493 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
494 Lisp_Object doc = tem; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
495 tem = get_doc_string (tem, 0, 0); |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
496 if (NILP (tem) && try_reload) |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
497 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
498 /* The file is newer, we need to reset the pointers. */ |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
499 struct gcpro gcpro1, gcpro2, gcpro3; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
500 GCPRO3 (symbol, prop, raw); |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
501 try_reload = reread_doc_file (Fcar_safe (doc)); |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
502 UNGCPRO; |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
503 if (try_reload) |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
504 { |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
505 try_reload = 0; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
506 goto documentation_property; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
507 } |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
508 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
509 } |
28036
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
510 else if (!STRINGP (tem)) |
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
511 /* Feval protects its argument. */ |
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
512 tem = Feval (tem); |
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
513 |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
514 if (NILP (raw) && STRINGP (tem)) |
26420
00b7d6135be4
(Fdocumentation_property): Remove GCPRO because
Gerd Moellmann <gerd@gnu.org>
parents:
26317
diff
changeset
|
515 tem = Fsubstitute_command_keys (tem); |
312
adba7439e87c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
297
diff
changeset
|
516 return tem; |
297 | 517 } |
518 | |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
519 /* 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
|
520 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
521 static void |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
522 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
|
523 Lisp_Object fun; |
10330
240a2c88d439
(store_function_docstring): Arg is now EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents:
10202
diff
changeset
|
524 /* 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
|
525 EMACS_INT offset; |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
526 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
527 fun = indirect_function (fun); |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
528 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
529 /* 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
|
530 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
531 /* Lisp_Subrs have a slot for it. */ |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
532 if (SUBRP (fun)) |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
533 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
|
534 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
535 /* 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
|
536 else if (CONSP (fun)) |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
537 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
538 Lisp_Object tem; |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
539 |
25662
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
540 tem = XCAR (fun); |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
541 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
|
542 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
543 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
|
544 if (CONSP (tem) && INTEGERP (XCAR (tem))) |
39973
579177964efa
Avoid (most) uses of XCAR/XCDR as lvalues, for flexibility in experimenting
Ken Raeburn <raeburn@raeburn.org>
parents:
39697
diff
changeset
|
545 XSETCARFASTINT (tem, offset); |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
546 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
547 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
|
548 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
|
549 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
550 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
551 /* Bytecode objects sometimes have slots for it. */ |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
552 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
|
553 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
554 /* 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
|
555 docstring, since we've found a docstring for it. */ |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
556 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING) |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
557 XSETFASTINT (AREF (fun, 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
|
558 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
559 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
560 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
561 |
297 | 562 DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation, |
41001
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
563 1, 1, 0, |
41218
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
564 doc: /* Used during Emacs initialization to scan the `etc/DOC...' file. |
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
565 This searches the `etc/DOC...' file for doc strings and |
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
566 records them in function and variable definitions. |
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
567 The function takes one argument, FILENAME, a string; |
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
568 it specifies the file name (without a directory) of the DOC file. |
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
569 That file is found in `../etc' now; later, when the dumped Emacs is run, |
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
570 the same file name is found in the `data-directory'. */) |
41001
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
571 (filename) |
297 | 572 Lisp_Object filename; |
573 { | |
574 int fd; | |
575 char buf[1024 + 1]; | |
576 register int filled; | |
577 register int pos; | |
578 register char *p, *end; | |
34963
681963400696
(Fsnarf_documentation): Remove unused variables `fun' and
Eli Zaretskii <eliz@gnu.org>
parents:
34363
diff
changeset
|
579 Lisp_Object sym; |
297 | 580 char *name; |
581 | |
40656
cdfd4d09b79a
Update usage of CHECK_ macros (remove unused second argument).
Pavel Janík <Pavel@Janik.cz>
parents:
40139
diff
changeset
|
582 CHECK_STRING (filename); |
297 | 583 |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
584 if |
297 | 585 #ifndef CANNOT_DUMP |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
586 (!NILP (Vpurify_flag)) |
297 | 587 #else /* CANNOT_DUMP */ |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
588 (0) |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
589 #endif /* CANNOT_DUMP */ |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
590 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
591 name = (char *) alloca (XSTRING (filename)->size + 14); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
592 strcpy (name, "../etc/"); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
593 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
594 else |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
595 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
596 CHECK_STRING (Vdoc_directory); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
597 name = (char *) alloca (XSTRING (filename)->size |
40702 | 598 + XSTRING (Vdoc_directory)->size + 1); |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
599 strcpy (name, XSTRING (Vdoc_directory)->data); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
600 } |
297 | 601 strcat (name, XSTRING (filename)->data); /*** Add this line ***/ |
602 #ifdef VMS | |
603 #ifndef VMS4_4 | |
604 /* For VMS versions with limited file name syntax, | |
605 convert the name to something VMS will allow. */ | |
606 p = name; | |
607 while (*p) | |
608 { | |
609 if (*p == '-') | |
610 *p = '_'; | |
611 p++; | |
612 } | |
613 #endif /* not VMS4_4 */ | |
614 #ifdef VMS4_4 | |
615 strcpy (name, sys_translate_unix (name)); | |
616 #endif /* VMS4_4 */ | |
617 #endif /* VMS */ | |
618 | |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
619 fd = emacs_open (name, O_RDONLY, 0); |
297 | 620 if (fd < 0) |
621 report_file_error ("Opening doc string file", | |
622 Fcons (build_string (name), Qnil)); | |
623 Vdoc_file_name = filename; | |
624 filled = 0; | |
625 pos = 0; | |
626 while (1) | |
627 { | |
628 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
|
629 filled += emacs_read (fd, &buf[filled], sizeof buf - 1 - filled); |
297 | 630 if (!filled) |
631 break; | |
632 | |
633 buf[filled] = 0; | |
634 p = buf; | |
635 end = buf + (filled < 512 ? filled : filled - 128); | |
636 while (p != end && *p != '\037') p++; | |
637 /* p points to ^_Ffunctionname\n or ^_Vvarname\n. */ | |
638 if (p != end) | |
639 { | |
31225
7930c46bb365
(toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents:
30154
diff
changeset
|
640 end = (char *) index (p, '\n'); |
20619 | 641 sym = oblookup (Vobarray, p + 2, |
642 multibyte_chars_in_text (p + 2, end - p - 2), | |
643 end - p - 2); | |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
644 if (SYMBOLP (sym)) |
297 | 645 { |
646 /* Attach a docstring to a variable? */ | |
647 if (p[1] == 'V') | |
648 { | |
649 /* Install file-position as variable-documentation property | |
650 and make it negative for a user-variable | |
651 (doc starts with a `*'). */ | |
652 Fput (sym, Qvariable_documentation, | |
653 make_number ((pos + end + 1 - buf) | |
654 * (end[1] == '*' ? -1 : 1))); | |
655 } | |
656 | |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
657 /* Attach a docstring to a function? */ |
297 | 658 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
|
659 store_function_docstring (sym, pos + end + 1 - buf); |
297 | 660 |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
661 else |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
662 error ("DOC file invalid at position %d", pos); |
297 | 663 } |
664 } | |
665 pos += end - buf; | |
666 filled -= end - buf; | |
667 bcopy (end, buf, filled); | |
668 } | |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
669 emacs_close (fd); |
297 | 670 return Qnil; |
671 } | |
672 | |
673 DEFUN ("substitute-command-keys", Fsubstitute_command_keys, | |
41001
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
674 Ssubstitute_command_keys, 1, 1, 0, |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
675 doc: /* Substitute key descriptions for command names in STRING. |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
676 Return a new string which is STRING with substrings of the form \\=\\[COMMAND] |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
677 replaced by either: a keystroke sequence that will invoke COMMAND, |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
678 or "M-x COMMAND" if COMMAND is not on any keys. |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
679 Substrings of the form \\=\\{MAPVAR} are replaced by summaries |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
680 \(made by describe-bindings) of the value of MAPVAR, taken as a keymap. |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
681 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
682 as the keymap for future \\=\\[COMMAND] substrings. |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
683 \\=\\= quotes the following character and is discarded; |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
684 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. */) |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
685 (string) |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
686 Lisp_Object string; |
297 | 687 { |
688 unsigned char *buf; | |
689 int changed = 0; | |
690 register unsigned char *strp; | |
691 register unsigned char *bufp; | |
692 int idx; | |
693 int bsize; | |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
694 Lisp_Object tem; |
297 | 695 Lisp_Object keymap; |
696 unsigned char *start; | |
20802
8cd0a6343a84
(Fsubstitute_command_keys): Declare length_byte out of
Kenichi Handa <handa@m17n.org>
parents:
20708
diff
changeset
|
697 int length, length_byte; |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
698 Lisp_Object name; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
699 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; |
20619 | 700 int multibyte; |
701 int nchars; | |
297 | 702 |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
703 if (NILP (string)) |
297 | 704 return Qnil; |
705 | |
40656
cdfd4d09b79a
Update usage of CHECK_ macros (remove unused second argument).
Pavel Janík <Pavel@Janik.cz>
parents:
40139
diff
changeset
|
706 CHECK_STRING (string); |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
707 tem = Qnil; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
708 keymap = Qnil; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
709 name = Qnil; |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
710 GCPRO4 (string, tem, keymap, name); |
297 | 711 |
20619 | 712 multibyte = STRING_MULTIBYTE (string); |
713 nchars = 0; | |
714 | |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
715 /* 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
|
716 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
|
717 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
|
718 or from a \\<mapname> construct in STRING itself.. */ |
12261 | 719 keymap = current_kboard->Voverriding_terminal_local_map; |
720 if (NILP (keymap)) | |
721 keymap = Voverriding_local_map; | |
297 | 722 |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
723 bsize = STRING_BYTES (XSTRING (string)); |
297 | 724 bufp = buf = (unsigned char *) xmalloc (bsize); |
725 | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
726 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
|
727 while (strp < XSTRING (string)->data + STRING_BYTES (XSTRING (string))) |
297 | 728 { |
729 if (strp[0] == '\\' && strp[1] == '=') | |
730 { | |
731 /* \= quotes the next character; | |
732 thus, to put in \[ without its special meaning, use \=\[. */ | |
733 changed = 1; | |
20619 | 734 strp += 2; |
735 if (multibyte) | |
736 { | |
737 int len; | |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
738 int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp; |
20619 | 739 |
740 STRING_CHAR_AND_LENGTH (strp, maxlen, len); | |
741 if (len == 1) | |
742 *bufp = *strp; | |
743 else | |
744 bcopy (strp, bufp, len); | |
745 strp += len; | |
746 bufp += len; | |
747 nchars++; | |
748 } | |
749 else | |
750 *bufp++ = *strp++, nchars++; | |
297 | 751 } |
752 else if (strp[0] == '\\' && strp[1] == '[') | |
753 { | |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
754 Lisp_Object firstkey; |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
755 int start_idx; |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
756 |
297 | 757 changed = 1; |
758 strp += 2; /* skip \[ */ | |
759 start = strp; | |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
760 start_idx = start - XSTRING (string)->data; |
297 | 761 |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
762 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
|
763 < STRING_BYTES (XSTRING (string))) |
297 | 764 && *strp != ']') |
765 strp++; | |
20619 | 766 length_byte = strp - start; |
767 | |
297 | 768 strp++; /* skip ] */ |
769 | |
770 /* Save STRP in IDX. */ | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
771 idx = strp - (unsigned char *) XSTRING (string)->data; |
20619 | 772 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
|
773 |
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
774 /* 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
|
775 relocation of string contents into account. */ |
43155
5943cc278b4c
Changed call to Fwhere_is_internal.
Kim F. Storm <storm@cua.dk>
parents:
42275
diff
changeset
|
776 tem = Fwhere_is_internal (tem, keymap, Qt, Qnil, Qnil); |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
777 strp = XSTRING (string)->data + idx; |
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
778 start = XSTRING (string)->data + start_idx; |
297 | 779 |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
780 /* 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
|
781 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
|
782 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
|
783 if (!NILP (tem)) |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
784 { |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
785 firstkey = Faref (tem, make_number (0)); |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
786 if (EQ (firstkey, Qmenu_bar)) |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
787 tem = Qnil; |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
788 } |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
789 |
485 | 790 if (NILP (tem)) /* but not on any keys */ |
297 | 791 { |
34363
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
792 int offset = bufp - buf; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
793 buf = (unsigned char *) xrealloc (buf, bsize += 4); |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
794 bufp = buf + offset; |
297 | 795 bcopy ("M-x ", bufp, 4); |
796 bufp += 4; | |
20619 | 797 nchars += 4; |
798 if (multibyte) | |
799 length = multibyte_chars_in_text (start, length_byte); | |
800 else | |
801 length = length_byte; | |
297 | 802 goto subst; |
803 } | |
804 else | |
805 { /* function is on a key */ | |
806 tem = Fkey_description (tem); | |
807 goto subst_string; | |
808 } | |
809 } | |
810 /* \{foo} is replaced with a summary of the keymap (symbol-value foo). | |
811 \<foo> just sets the keymap used for \[cmd]. */ | |
812 else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<')) | |
813 { | |
814 struct buffer *oldbuf; | |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
815 int start_idx; |
297 | 816 |
817 changed = 1; | |
818 strp += 2; /* skip \{ or \< */ | |
819 start = strp; | |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
820 start_idx = start - XSTRING (string)->data; |
297 | 821 |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
822 while ((strp - (unsigned char *) XSTRING (string)->data |
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
823 < XSTRING (string)->size) |
297 | 824 && *strp != '}' && *strp != '>') |
825 strp++; | |
20619 | 826 |
827 length_byte = strp - start; | |
297 | 828 strp++; /* skip } or > */ |
829 | |
830 /* Save STRP in IDX. */ | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
831 idx = strp - (unsigned char *) XSTRING (string)->data; |
297 | 832 |
833 /* Get the value of the keymap in TEM, or nil if undefined. | |
834 Do this while still in the user's current buffer | |
835 in case it is a local variable. */ | |
20619 | 836 name = Fintern (make_string (start, length_byte), Qnil); |
297 | 837 tem = Fboundp (name); |
485 | 838 if (! NILP (tem)) |
297 | 839 { |
840 tem = Fsymbol_value (name); | |
485 | 841 if (! NILP (tem)) |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
842 { |
32988
c3435dc00ed7
* lisp.h (KEYMAPP): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31336
diff
changeset
|
843 tem = get_keymap (tem, 0, 1); |
c3435dc00ed7
* lisp.h (KEYMAPP): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31336
diff
changeset
|
844 /* Note that get_keymap can GC. */ |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
845 strp = XSTRING (string)->data + idx; |
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
846 start = XSTRING (string)->data + start_idx; |
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
847 } |
297 | 848 } |
849 | |
850 /* Now switch to a temp buffer. */ | |
851 oldbuf = current_buffer; | |
852 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer)); | |
853 | |
485 | 854 if (NILP (tem)) |
297 | 855 { |
856 name = Fsymbol_name (name); | |
857 insert_string ("\nUses keymap \""); | |
20619 | 858 insert_from_string (name, 0, 0, |
859 XSTRING (name)->size, | |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
860 STRING_BYTES (XSTRING (name)), 1); |
297 | 861 insert_string ("\", which is not currently defined.\n"); |
862 if (start[-1] == '<') keymap = Qnil; | |
863 } | |
864 else if (start[-1] == '<') | |
865 keymap = tem; | |
866 else | |
18746
c7ada1684ebb
(Fsubstitute_command_keys): Add missing describe_map_tree argument.
Richard M. Stallman <rms@gnu.org>
parents:
14648
diff
changeset
|
867 describe_map_tree (tem, 1, Qnil, Qnil, (char *)0, 1, 0, 0); |
297 | 868 tem = Fbuffer_string (); |
869 Ferase_buffer (); | |
870 set_buffer_internal (oldbuf); | |
871 | |
872 subst_string: | |
873 start = XSTRING (tem)->data; | |
874 length = XSTRING (tem)->size; | |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
875 length_byte = STRING_BYTES (XSTRING (tem)); |
297 | 876 subst: |
34363
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
877 { |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
878 int offset = bufp - buf; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
879 buf = (unsigned char *) xrealloc (buf, bsize += length_byte); |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
880 bufp = buf + offset; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
881 bcopy (start, bufp, length_byte); |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
882 bufp += length_byte; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
883 nchars += length; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
884 /* Check STRING again in case gc relocated it. */ |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
885 strp = (unsigned char *) XSTRING (string)->data + idx; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
886 } |
297 | 887 } |
20619 | 888 else if (! multibyte) /* just copy other chars */ |
889 *bufp++ = *strp++, nchars++; | |
890 else | |
891 { | |
892 int len; | |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
893 int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp; |
20619 | 894 |
895 STRING_CHAR_AND_LENGTH (strp, maxlen, len); | |
896 if (len == 1) | |
897 *bufp = *strp; | |
898 else | |
899 bcopy (strp, bufp, len); | |
900 strp += len; | |
901 bufp += len; | |
902 nchars++; | |
903 } | |
297 | 904 } |
905 | |
906 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
|
907 tem = make_string_from_bytes (buf, nchars, bufp - buf); |
297 | 908 else |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
909 tem = string; |
2439
b6c62e4abf59
Put interrupt input blocking in a separate file from xterm.h.
Jim Blandy <jimb@redhat.com>
parents:
1651
diff
changeset
|
910 xfree (buf); |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
911 RETURN_UNGCPRO (tem); |
297 | 912 } |
913 | |
21514 | 914 void |
297 | 915 syms_of_doc () |
916 { | |
28334
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
917 Qfunction_documentation = intern ("function-documentation"); |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
918 staticpro (&Qfunction_documentation); |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
919 |
297 | 920 DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name, |
41001
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
921 doc: /* Name of file containing documentation strings of built-in symbols. */); |
297 | 922 Vdoc_file_name = Qnil; |
923 | |
924 defsubr (&Sdocumentation); | |
925 defsubr (&Sdocumentation_property); | |
926 defsubr (&Ssnarf_documentation); | |
927 defsubr (&Ssubstitute_command_keys); | |
928 } |