Mercurial > emacs
annotate src/doc.c @ 27998:e61be6a5e321
(xm_manage_resizing): Rewritten.
author | Gerd Moellmann <gerd@gnu.org> |
---|---|
date | Sun, 05 Mar 2000 14:31:41 +0000 |
parents | a7b55765b7c4 |
children | ec8b11f3d3da |
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" |
297 | 43 |
27552
60c820c7f330
(Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents:
26471
diff
changeset
|
44 Lisp_Object Vdoc_file_name, Vhelp_manyarg_func_alist; |
297 | 45 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
46 extern char *index (); |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
47 |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
48 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
|
49 |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
50 /* 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
|
51 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
|
52 static void |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
53 munge_doc_file_name (name) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
54 char *name; |
297 | 55 { |
56 #ifdef VMS | |
57 #ifndef VMS4_4 | |
58 /* For VMS versions with limited file name syntax, | |
59 convert the name to something VMS will allow. */ | |
60 p = name; | |
61 while (*p) | |
62 { | |
63 if (*p == '-') | |
64 *p = '_'; | |
65 p++; | |
66 } | |
67 #endif /* not VMS4_4 */ | |
68 #ifdef VMS4_4 | |
69 strcpy (name, sys_translate_unix (name)); | |
70 #endif /* VMS4_4 */ | |
71 #endif /* VMS */ | |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
72 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
73 |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
74 /* 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
|
75 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
|
76 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
|
77 |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
78 static unsigned char *read_bytecode_pointer; |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
79 |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
80 /* 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
|
81 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
|
82 |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
83 int |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
84 read_bytecode_char (unreadflag) |
25758
fca9459a0555
(read_bytecode_char): Declare arg.
Dave Love <fx@gnu.org>
parents:
25662
diff
changeset
|
85 int unreadflag; |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
86 { |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
87 if (unreadflag) |
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 read_bytecode_pointer--; |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
90 return 0; |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
91 } |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
92 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
|
93 } |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
94 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
95 /* 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
|
96 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
|
97 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
|
98 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
|
99 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
|
100 (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
|
101 them without actually fetching the doc string.) |
10a9f355a346
(get_doc_string): New arg UNIBYTE
Richard M. Stallman <rms@gnu.org>
parents:
21514
diff
changeset
|
102 |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
103 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
|
104 |
22562
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
105 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
|
106 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
|
107 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
|
108 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
|
109 |
22268
9308a15aa8f8
(get_doc_string): Make non-static.
Richard M. Stallman <rms@gnu.org>
parents:
22043
diff
changeset
|
110 Lisp_Object |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
111 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
|
112 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
|
113 int unibyte, definition; |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
114 { |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
115 char *from, *to; |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
116 register int fd; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
117 register char *name; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
118 register char *p, *p1; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
119 int minsize; |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
120 int offset, position; |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
121 Lisp_Object file, tem; |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
122 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
123 if (INTEGERP (filepos)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
124 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
125 file = Vdoc_file_name; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
126 position = XINT (filepos); |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
127 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
128 else if (CONSP (filepos)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
129 { |
25662
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
130 file = XCAR (filepos); |
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
131 position = XINT (XCDR (filepos)); |
11252
f610f9d7e3ca
(get_doc_string): In (STRING . INTEGER), if INTEGER
Richard M. Stallman <rms@gnu.org>
parents:
10345
diff
changeset
|
132 if (position < 0) |
f610f9d7e3ca
(get_doc_string): In (STRING . INTEGER), if INTEGER
Richard M. Stallman <rms@gnu.org>
parents:
10345
diff
changeset
|
133 position = - position; |
10202
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 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
136 return Qnil; |
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 if (!STRINGP (Vdoc_directory)) |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
139 return Qnil; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
140 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
141 if (!STRINGP (file)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
142 return Qnil; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
143 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
144 /* 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
|
145 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
|
146 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
147 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
|
148 if (NILP (tem)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
149 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
150 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
|
151 /* sizeof ("../etc/") == 8 */ |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
152 if (minsize < 8) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
153 minsize = 8; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
154 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
|
155 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
|
156 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
|
157 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
|
158 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
159 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
160 { |
11446
cee0510aa3aa
(get_doc_string): Add cast.
Richard M. Stallman <rms@gnu.org>
parents:
11252
diff
changeset
|
161 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
|
162 } |
297 | 163 |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
164 fd = emacs_open (name, O_RDONLY, 0); |
297 | 165 if (fd < 0) |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
166 { |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
167 #ifndef CANNOT_DUMP |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
168 if (!NILP (Vpurify_flag)) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
169 { |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
170 /* 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
|
171 So check in ../etc. */ |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
172 strcpy (name, "../etc/"); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
173 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
|
174 munge_doc_file_name (name); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
175 |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
176 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
|
177 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
178 #endif |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
179 if (fd < 0) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
180 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
|
181 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
182 |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
183 /* Seek only to beginning of disk block. */ |
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
184 offset = position % (8 * 1024); |
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
185 if (0 > lseek (fd, position - offset, 0)) |
297 | 186 { |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
187 emacs_close (fd); |
297 | 188 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
|
189 position, name); |
297 | 190 } |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
191 |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
192 /* 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
|
193 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
|
194 |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
195 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
|
196 while (1) |
297 | 197 { |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
198 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
|
199 - (p - get_doc_string_buffer)); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
200 int nread; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
201 |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
202 /* 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
|
203 if (space_left == 0) |
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 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
|
206 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
|
207 get_doc_string_buffer |
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
208 = (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
|
209 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
|
210 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
|
211 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 } |
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 /* 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
|
216 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
|
217 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
|
218 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
|
219 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
|
220 if (nread < 0) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
221 { |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
222 emacs_close (fd); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
223 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
|
224 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
225 p[nread] = 0; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
226 if (!nread) |
297 | 227 break; |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
228 if (p == get_doc_string_buffer) |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
229 p1 = index (p + offset, '\037'); |
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
230 else |
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
231 p1 = index (p, '\037'); |
297 | 232 if (p1) |
233 { | |
234 *p1 = 0; | |
235 p = p1; | |
236 break; | |
237 } | |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
238 p += nread; |
297 | 239 } |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
240 emacs_close (fd); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
241 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
242 /* 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
|
243 ^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
|
244 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
|
245 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
|
246 while (from != p) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
247 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
248 if (*from == 1) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
249 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
250 int c; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
251 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
252 from++; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
253 c = *from++; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
254 if (c == 1) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
255 *to++ = c; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
256 else if (c == '0') |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
257 *to++ = 0; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
258 else if (c == '_') |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
259 *to++ = 037; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
260 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
261 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
|
262 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
263 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
264 *to++ = *from++; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
265 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
266 |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
267 /* 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
|
268 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
|
269 if (definition) |
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
270 { |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
271 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
|
272 return Fread (Qlambda); |
22562
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
273 } |
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
274 |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
275 if (unibyte) |
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
276 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
|
277 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
|
278 else |
24573
aa24b1cb428a
(get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents:
23921
diff
changeset
|
279 { |
aa24b1cb428a
(get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents:
23921
diff
changeset
|
280 /* 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
|
281 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
|
282 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
|
283 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
|
284 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
|
285 nchars, |
aa24b1cb428a
(get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents:
23921
diff
changeset
|
286 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
|
287 } |
10202
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 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
290 /* 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
|
291 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
|
292 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
|
293 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
294 Lisp_Object |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
295 read_doc_string (filepos) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
296 Lisp_Object filepos; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
297 { |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
298 return get_doc_string (filepos, 0, 1); |
297 | 299 } |
300 | |
570 | 301 DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0, |
604 | 302 "Return the documentation string of FUNCTION.\n\ |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
303 Unless a non-nil second argument RAW is given, the\n\ |
570 | 304 string is passed through `substitute-command-keys'.") |
647 | 305 (function, raw) |
306 Lisp_Object function, raw; | |
297 | 307 { |
308 Lisp_Object fun; | |
309 Lisp_Object funcar; | |
570 | 310 Lisp_Object tem, doc; |
297 | 311 |
647 | 312 fun = Findirect_function (function); |
297 | 313 |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
314 if (SUBRP (fun)) |
297 | 315 { |
316 if (XSUBR (fun)->doc == 0) return Qnil; | |
8823
fdb7ba55f05c
(Fdocumentation): Use EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents:
8552
diff
changeset
|
317 if ((EMACS_INT) XSUBR (fun)->doc >= 0) |
570 | 318 doc = build_string (XSUBR (fun)->doc); |
297 | 319 else |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
320 doc = get_doc_string (make_number (- (EMACS_INT) XSUBR (fun)->doc), |
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
321 0, 0); |
27552
60c820c7f330
(Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents:
26471
diff
changeset
|
322 if (! NILP (tem = Fassq (function, Vhelp_manyarg_func_alist))) |
60c820c7f330
(Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents:
26471
diff
changeset
|
323 doc = concat3 (doc, build_string ("\n"), Fcdr (tem)); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
324 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
325 else if (COMPILEDP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
326 { |
10345 | 327 if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING) |
297 | 328 return Qnil; |
329 tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING]; | |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
330 if (STRINGP (tem)) |
570 | 331 doc = tem; |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
332 else if (NATNUMP (tem) || CONSP (tem)) |
22890
5044c732dbde
(Fdocumentation): Specify UNIBYTE = 0
Richard M. Stallman <rms@gnu.org>
parents:
22690
diff
changeset
|
333 doc = get_doc_string (tem, 0, 0); |
570 | 334 else |
335 return Qnil; | |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
336 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
337 else if (STRINGP (fun) || VECTORP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
338 { |
297 | 339 return build_string ("Keyboard macro."); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
340 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
341 else if (CONSP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
342 { |
297 | 343 funcar = Fcar (fun); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
344 if (!SYMBOLP (funcar)) |
297 | 345 return Fsignal (Qinvalid_function, Fcons (fun, Qnil)); |
647 | 346 else if (EQ (funcar, Qkeymap)) |
23921
81a6345fd5e8
(Fdocumentation): Change the doc string for prefix
Andreas Schwab <schwab@suse.de>
parents:
22890
diff
changeset
|
347 return build_string ("Prefix command (definition is a keymap associating keystrokes with commands)."); |
647 | 348 else if (EQ (funcar, Qlambda) |
349 || EQ (funcar, Qautoload)) | |
297 | 350 { |
13521
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
351 Lisp_Object tem1; |
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
352 tem1 = Fcdr (Fcdr (fun)); |
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
353 tem = Fcar (tem1); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
354 if (STRINGP (tem)) |
570 | 355 doc = tem; |
13521
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
356 /* 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
|
357 in the function body, so reject them if they are last. */ |
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
358 else if ((NATNUMP (tem) || CONSP (tem)) |
25662
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
359 && ! NILP (XCDR (tem1))) |
22890
5044c732dbde
(Fdocumentation): Specify UNIBYTE = 0
Richard M. Stallman <rms@gnu.org>
parents:
22690
diff
changeset
|
360 doc = get_doc_string (tem, 0, 0); |
570 | 361 else |
362 return Qnil; | |
297 | 363 } |
647 | 364 else if (EQ (funcar, Qmocklisp)) |
297 | 365 return Qnil; |
647 | 366 else if (EQ (funcar, Qmacro)) |
570 | 367 return Fdocumentation (Fcdr (fun), raw); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
368 else |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
369 goto oops; |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
370 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
371 else |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
372 { |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
373 oops: |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
374 Fsignal (Qinvalid_function, Fcons (fun, Qnil)); |
297 | 375 } |
570 | 376 |
577 | 377 if (NILP (raw)) |
26471
b1863c0b8f9c
(Fdocumentation): Remove gcpro here too.
Dave Love <fx@gnu.org>
parents:
26420
diff
changeset
|
378 doc = Fsubstitute_command_keys (doc); |
570 | 379 return doc; |
297 | 380 } |
381 | |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
382 DEFUN ("documentation-property", Fdocumentation_property, Sdocumentation_property, 2, 3, 0, |
297 | 383 "Return the documentation string that is SYMBOL's PROP property.\n\ |
570 | 384 This is like `get', but it can refer to strings stored in the\n\ |
604 | 385 `etc/DOC' file; and if the value is a string, it is passed through\n\ |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
386 `substitute-command-keys'. A non-nil third argument RAW avoids this\n\ |
577 | 387 translation.") |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
388 (symbol, prop, raw) |
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
389 Lisp_Object symbol, prop, raw; |
297 | 390 { |
26076
edbfca66058d
(Fdocumentation_property): Remove register declaration for `tem'.
Dave Love <fx@gnu.org>
parents:
26075
diff
changeset
|
391 Lisp_Object tem; |
297 | 392 |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
393 tem = Fget (symbol, prop); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
394 if (INTEGERP (tem)) |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
395 tem = get_doc_string (XINT (tem) > 0 ? tem : make_number (- XINT (tem)), 0, 0); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
396 else if (CONSP (tem)) |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
397 tem = get_doc_string (tem, 0, 0); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
398 if (NILP (raw) && STRINGP (tem)) |
26420
00b7d6135be4
(Fdocumentation_property): Remove GCPRO because
Gerd Moellmann <gerd@gnu.org>
parents:
26317
diff
changeset
|
399 tem = Fsubstitute_command_keys (tem); |
312
adba7439e87c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
297
diff
changeset
|
400 return tem; |
297 | 401 } |
402 | |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
403 /* 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
|
404 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
405 static void |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
406 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
|
407 Lisp_Object fun; |
10330
240a2c88d439
(store_function_docstring): Arg is now EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents:
10202
diff
changeset
|
408 /* 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
|
409 EMACS_INT offset; |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
410 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
411 fun = indirect_function (fun); |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
412 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
413 /* 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
|
414 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
415 /* Lisp_Subrs have a slot for it. */ |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
416 if (SUBRP (fun)) |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
417 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
|
418 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
419 /* 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
|
420 else if (CONSP (fun)) |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
421 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
422 Lisp_Object tem; |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
423 |
25662
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
424 tem = XCAR (fun); |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
425 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
|
426 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
427 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
|
428 if (CONSP (tem) && INTEGERP (XCAR (tem))) |
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
429 XSETFASTINT (XCAR (tem), offset); |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
430 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
431 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
|
432 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
|
433 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
434 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
435 /* Bytecode objects sometimes have slots for it. */ |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
436 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
|
437 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
438 /* 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
|
439 docstring, since we've found a docstring for it. */ |
10345 | 440 if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING) |
9304
1fbc46670cb0
(store_function_docstring): Don't use XFASTINT as an lvalue.
Karl Heuer <kwzh@gnu.org>
parents:
9133
diff
changeset
|
441 XSETFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING], offset); |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
442 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
443 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
444 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
445 |
297 | 446 DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation, |
447 1, 1, 0, | |
448 "Used during Emacs initialization, before dumping runnable Emacs,\n\ | |
604 | 449 to find pointers to doc strings stored in `etc/DOC...' and\n\ |
297 | 450 record them in function definitions.\n\ |
451 One arg, FILENAME, a string which does not include a directory.\n\ | |
604 | 452 The file is found in `../etc' now; found in the `data-directory'\n\ |
297 | 453 when doc strings are referred to later in the dumped Emacs.") |
454 (filename) | |
455 Lisp_Object filename; | |
456 { | |
457 int fd; | |
458 char buf[1024 + 1]; | |
459 register int filled; | |
460 register int pos; | |
461 register char *p, *end; | |
462 Lisp_Object sym, fun, tem; | |
463 char *name; | |
464 extern char *index (); | |
465 | |
1116
6d0d442e2ada
* doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents:
961
diff
changeset
|
466 #ifndef CANNOT_DUMP |
6d0d442e2ada
* doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents:
961
diff
changeset
|
467 if (NILP (Vpurify_flag)) |
6d0d442e2ada
* doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents:
961
diff
changeset
|
468 error ("Snarf-documentation can only be called in an undumped Emacs"); |
6d0d442e2ada
* doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents:
961
diff
changeset
|
469 #endif |
6d0d442e2ada
* doc.c (Fsnarf_documentation): Signal an error if this is
Jim Blandy <jimb@redhat.com>
parents:
961
diff
changeset
|
470 |
297 | 471 CHECK_STRING (filename, 0); |
472 | |
473 #ifndef CANNOT_DUMP | |
463 | 474 name = (char *) alloca (XSTRING (filename)->size + 14); |
604 | 475 strcpy (name, "../etc/"); |
297 | 476 #else /* CANNOT_DUMP */ |
6030
8b3f54fb451f
(get_doc_string, Snarf_documentation): Use new variable doc_directory.
Karl Heuer <kwzh@gnu.org>
parents:
5784
diff
changeset
|
477 CHECK_STRING (Vdoc_directory, 0); |
297 | 478 name = (char *) alloca (XSTRING (filename)->size + |
6030
8b3f54fb451f
(get_doc_string, Snarf_documentation): Use new variable doc_directory.
Karl Heuer <kwzh@gnu.org>
parents:
5784
diff
changeset
|
479 XSTRING (Vdoc_directory)->size + 1); |
8b3f54fb451f
(get_doc_string, Snarf_documentation): Use new variable doc_directory.
Karl Heuer <kwzh@gnu.org>
parents:
5784
diff
changeset
|
480 strcpy (name, XSTRING (Vdoc_directory)->data); |
297 | 481 #endif /* CANNOT_DUMP */ |
482 strcat (name, XSTRING (filename)->data); /*** Add this line ***/ | |
483 #ifdef VMS | |
484 #ifndef VMS4_4 | |
485 /* For VMS versions with limited file name syntax, | |
486 convert the name to something VMS will allow. */ | |
487 p = name; | |
488 while (*p) | |
489 { | |
490 if (*p == '-') | |
491 *p = '_'; | |
492 p++; | |
493 } | |
494 #endif /* not VMS4_4 */ | |
495 #ifdef VMS4_4 | |
496 strcpy (name, sys_translate_unix (name)); | |
497 #endif /* VMS4_4 */ | |
498 #endif /* VMS */ | |
499 | |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
500 fd = emacs_open (name, O_RDONLY, 0); |
297 | 501 if (fd < 0) |
502 report_file_error ("Opening doc string file", | |
503 Fcons (build_string (name), Qnil)); | |
504 Vdoc_file_name = filename; | |
505 filled = 0; | |
506 pos = 0; | |
507 while (1) | |
508 { | |
509 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
|
510 filled += emacs_read (fd, &buf[filled], sizeof buf - 1 - filled); |
297 | 511 if (!filled) |
512 break; | |
513 | |
514 buf[filled] = 0; | |
515 p = buf; | |
516 end = buf + (filled < 512 ? filled : filled - 128); | |
517 while (p != end && *p != '\037') p++; | |
518 /* p points to ^_Ffunctionname\n or ^_Vvarname\n. */ | |
519 if (p != end) | |
520 { | |
521 end = index (p, '\n'); | |
20619 | 522 sym = oblookup (Vobarray, p + 2, |
523 multibyte_chars_in_text (p + 2, end - p - 2), | |
524 end - p - 2); | |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
525 if (SYMBOLP (sym)) |
297 | 526 { |
527 /* Attach a docstring to a variable? */ | |
528 if (p[1] == 'V') | |
529 { | |
530 /* Install file-position as variable-documentation property | |
531 and make it negative for a user-variable | |
532 (doc starts with a `*'). */ | |
533 Fput (sym, Qvariable_documentation, | |
534 make_number ((pos + end + 1 - buf) | |
535 * (end[1] == '*' ? -1 : 1))); | |
536 } | |
537 | |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
538 /* Attach a docstring to a function? */ |
297 | 539 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
|
540 store_function_docstring (sym, pos + end + 1 - buf); |
297 | 541 |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
542 else |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
543 error ("DOC file invalid at position %d", pos); |
297 | 544 } |
545 } | |
546 pos += end - buf; | |
547 filled -= end - buf; | |
548 bcopy (end, buf, filled); | |
549 } | |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
550 emacs_close (fd); |
297 | 551 return Qnil; |
552 } | |
553 | |
554 DEFUN ("substitute-command-keys", Fsubstitute_command_keys, | |
555 Ssubstitute_command_keys, 1, 1, 0, | |
556 "Substitute key descriptions for command names in STRING.\n\ | |
557 Return a new string which is STRING with substrings of the form \\=\\[COMMAND]\n\ | |
558 replaced by either: a keystroke sequence that will invoke COMMAND,\n\ | |
559 or \"M-x COMMAND\" if COMMAND is not on any keys.\n\ | |
560 Substrings of the form \\=\\{MAPVAR} are replaced by summaries\n\ | |
561 \(made by describe-bindings) of the value of MAPVAR, taken as a keymap.\n\ | |
562 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR\n\ | |
563 as the keymap for future \\=\\[COMMAND] substrings.\n\ | |
564 \\=\\= quotes the following character and is discarded;\n\ | |
565 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.") | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
566 (string) |
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
567 Lisp_Object string; |
297 | 568 { |
569 unsigned char *buf; | |
570 int changed = 0; | |
571 register unsigned char *strp; | |
572 register unsigned char *bufp; | |
573 int idx; | |
574 int bsize; | |
575 unsigned char *new; | |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
576 Lisp_Object tem; |
297 | 577 Lisp_Object keymap; |
578 unsigned char *start; | |
20802
8cd0a6343a84
(Fsubstitute_command_keys): Declare length_byte out of
Kenichi Handa <handa@m17n.org>
parents:
20708
diff
changeset
|
579 int length, length_byte; |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
580 Lisp_Object name; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
581 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; |
20619 | 582 int multibyte; |
583 int nchars; | |
297 | 584 |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
585 if (NILP (string)) |
297 | 586 return Qnil; |
587 | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
588 CHECK_STRING (string, 0); |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
589 tem = Qnil; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
590 keymap = Qnil; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
591 name = Qnil; |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
592 GCPRO4 (string, tem, keymap, name); |
297 | 593 |
20619 | 594 multibyte = STRING_MULTIBYTE (string); |
595 nchars = 0; | |
596 | |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
597 /* 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
|
598 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
|
599 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
|
600 or from a \\<mapname> construct in STRING itself.. */ |
12261 | 601 keymap = current_kboard->Voverriding_terminal_local_map; |
602 if (NILP (keymap)) | |
603 keymap = Voverriding_local_map; | |
297 | 604 |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
605 bsize = STRING_BYTES (XSTRING (string)); |
297 | 606 bufp = buf = (unsigned char *) xmalloc (bsize); |
607 | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
608 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
|
609 while (strp < XSTRING (string)->data + STRING_BYTES (XSTRING (string))) |
297 | 610 { |
611 if (strp[0] == '\\' && strp[1] == '=') | |
612 { | |
613 /* \= quotes the next character; | |
614 thus, to put in \[ without its special meaning, use \=\[. */ | |
615 changed = 1; | |
20619 | 616 strp += 2; |
617 if (multibyte) | |
618 { | |
619 int len; | |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
620 int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp; |
20619 | 621 |
622 STRING_CHAR_AND_LENGTH (strp, maxlen, len); | |
623 if (len == 1) | |
624 *bufp = *strp; | |
625 else | |
626 bcopy (strp, bufp, len); | |
627 strp += len; | |
628 bufp += len; | |
629 nchars++; | |
630 } | |
631 else | |
632 *bufp++ = *strp++, nchars++; | |
297 | 633 } |
634 else if (strp[0] == '\\' && strp[1] == '[') | |
635 { | |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
636 Lisp_Object firstkey; |
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
637 |
297 | 638 changed = 1; |
639 strp += 2; /* skip \[ */ | |
640 start = strp; | |
641 | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
642 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
|
643 < STRING_BYTES (XSTRING (string))) |
297 | 644 && *strp != ']') |
645 strp++; | |
20619 | 646 length_byte = strp - start; |
647 | |
297 | 648 strp++; /* skip ] */ |
649 | |
650 /* Save STRP in IDX. */ | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
651 idx = strp - (unsigned char *) XSTRING (string)->data; |
20619 | 652 tem = Fintern (make_string (start, length_byte), Qnil); |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
653 tem = Fwhere_is_internal (tem, keymap, Qt, Qnil); |
297 | 654 |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
655 /* 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
|
656 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
|
657 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
|
658 if (!NILP (tem)) |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
659 { |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
660 firstkey = Faref (tem, make_number (0)); |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
661 if (EQ (firstkey, Qmenu_bar)) |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
662 tem = Qnil; |
7a8463c07d8f
(Fsubstitute_command_keys): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
5248
diff
changeset
|
663 } |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
664 |
485 | 665 if (NILP (tem)) /* but not on any keys */ |
297 | 666 { |
667 new = (unsigned char *) xrealloc (buf, bsize += 4); | |
668 bufp += new - buf; | |
669 buf = new; | |
670 bcopy ("M-x ", bufp, 4); | |
671 bufp += 4; | |
20619 | 672 nchars += 4; |
673 if (multibyte) | |
674 length = multibyte_chars_in_text (start, length_byte); | |
675 else | |
676 length = length_byte; | |
297 | 677 goto subst; |
678 } | |
679 else | |
680 { /* function is on a key */ | |
681 tem = Fkey_description (tem); | |
682 goto subst_string; | |
683 } | |
684 } | |
685 /* \{foo} is replaced with a summary of the keymap (symbol-value foo). | |
686 \<foo> just sets the keymap used for \[cmd]. */ | |
687 else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<')) | |
688 { | |
689 struct buffer *oldbuf; | |
690 | |
691 changed = 1; | |
692 strp += 2; /* skip \{ or \< */ | |
693 start = strp; | |
694 | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
695 while ((strp - (unsigned char *) XSTRING (string)->data |
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
696 < XSTRING (string)->size) |
297 | 697 && *strp != '}' && *strp != '>') |
698 strp++; | |
20619 | 699 |
700 length_byte = strp - start; | |
297 | 701 strp++; /* skip } or > */ |
702 | |
703 /* Save STRP in IDX. */ | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
704 idx = strp - (unsigned char *) XSTRING (string)->data; |
297 | 705 |
706 /* Get the value of the keymap in TEM, or nil if undefined. | |
707 Do this while still in the user's current buffer | |
708 in case it is a local variable. */ | |
20619 | 709 name = Fintern (make_string (start, length_byte), Qnil); |
297 | 710 tem = Fboundp (name); |
485 | 711 if (! NILP (tem)) |
297 | 712 { |
713 tem = Fsymbol_value (name); | |
485 | 714 if (! NILP (tem)) |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
715 tem = get_keymap_1 (tem, 0, 1); |
297 | 716 } |
717 | |
718 /* Now switch to a temp buffer. */ | |
719 oldbuf = current_buffer; | |
720 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer)); | |
721 | |
485 | 722 if (NILP (tem)) |
297 | 723 { |
724 name = Fsymbol_name (name); | |
725 insert_string ("\nUses keymap \""); | |
20619 | 726 insert_from_string (name, 0, 0, |
727 XSTRING (name)->size, | |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
728 STRING_BYTES (XSTRING (name)), 1); |
297 | 729 insert_string ("\", which is not currently defined.\n"); |
730 if (start[-1] == '<') keymap = Qnil; | |
731 } | |
732 else if (start[-1] == '<') | |
733 keymap = tem; | |
734 else | |
18746
c7ada1684ebb
(Fsubstitute_command_keys): Add missing describe_map_tree argument.
Richard M. Stallman <rms@gnu.org>
parents:
14648
diff
changeset
|
735 describe_map_tree (tem, 1, Qnil, Qnil, (char *)0, 1, 0, 0); |
297 | 736 tem = Fbuffer_string (); |
737 Ferase_buffer (); | |
738 set_buffer_internal (oldbuf); | |
739 | |
740 subst_string: | |
741 start = XSTRING (tem)->data; | |
742 length = XSTRING (tem)->size; | |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
743 length_byte = STRING_BYTES (XSTRING (tem)); |
297 | 744 subst: |
20619 | 745 new = (unsigned char *) xrealloc (buf, bsize += length_byte); |
297 | 746 bufp += new - buf; |
747 buf = new; | |
20619 | 748 bcopy (start, bufp, length_byte); |
749 bufp += length_byte; | |
750 nchars += length; | |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
751 /* Check STRING again in case gc relocated it. */ |
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
752 strp = (unsigned char *) XSTRING (string)->data + idx; |
297 | 753 } |
20619 | 754 else if (! multibyte) /* just copy other chars */ |
755 *bufp++ = *strp++, nchars++; | |
756 else | |
757 { | |
758 int len; | |
21244
50929073a0ba
Use STRING_BYTES and SET_STRING_BYTES.
Richard M. Stallman <rms@gnu.org>
parents:
20802
diff
changeset
|
759 int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp; |
20619 | 760 |
761 STRING_CHAR_AND_LENGTH (strp, maxlen, len); | |
762 if (len == 1) | |
763 *bufp = *strp; | |
764 else | |
765 bcopy (strp, bufp, len); | |
766 strp += len; | |
767 bufp += len; | |
768 nchars++; | |
769 } | |
297 | 770 } |
771 | |
772 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
|
773 tem = make_string_from_bytes (buf, nchars, bufp - buf); |
297 | 774 else |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
775 tem = string; |
2439
b6c62e4abf59
Put interrupt input blocking in a separate file from xterm.h.
Jim Blandy <jimb@redhat.com>
parents:
1651
diff
changeset
|
776 xfree (buf); |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
777 RETURN_UNGCPRO (tem); |
297 | 778 } |
779 | |
21514 | 780 void |
297 | 781 syms_of_doc () |
782 { | |
783 DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name, | |
784 "Name of file containing documentation strings of built-in symbols."); | |
785 Vdoc_file_name = Qnil; | |
27552
60c820c7f330
(Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents:
26471
diff
changeset
|
786 DEFVAR_LISP ("help-manyarg-func-alist", &Vhelp_manyarg_func_alist, |
60c820c7f330
(Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents:
26471
diff
changeset
|
787 "Alist of primitive functions and descriptions of their arg lists.\n\ |
60c820c7f330
(Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents:
26471
diff
changeset
|
788 All special forms and primitives which effectively have &rest args\n\ |
60c820c7f330
(Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents:
26471
diff
changeset
|
789 should have an entry here so that `documentation' can provide their\n\ |
60c820c7f330
(Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents:
26471
diff
changeset
|
790 arg list."); |
60c820c7f330
(Vhelp_manyarg_func_alist): New variable.
Dave Love <fx@gnu.org>
parents:
26471
diff
changeset
|
791 Vhelp_manyarg_func_alist = Qnil; |
297 | 792 |
793 defsubr (&Sdocumentation); | |
794 defsubr (&Sdocumentation_property); | |
795 defsubr (&Ssnarf_documentation); | |
796 defsubr (&Ssubstitute_command_keys); | |
797 } |