Mercurial > emacs
annotate src/doc.c @ 65912:da86e1af8629
(x_create_gc, x_free_gc) [MAC_OS]: Add BLOCK_INPUT. Add debug code.
author | YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp> |
---|---|
date | Sat, 08 Oct 2005 02:28:55 +0000 |
parents | 4a6f5ef57ed1 |
children | b9685771709d 10fe5fadaf89 |
rev | line source |
---|---|
297 | 1 /* Record indices of function doc strings stored in a file. |
64770
a0d1312ede66
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64084
diff
changeset
|
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1997, 1998, 1999, 2000, 2001, |
a0d1312ede66
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64084
diff
changeset
|
3 2002, 2003, 2004, 2005 Free Software Foundation, Inc. |
297 | 4 |
5 This file is part of GNU Emacs. | |
6 | |
7 GNU Emacs is free software; you can redistribute it and/or modify | |
8 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
|
9 the Free Software Foundation; either version 2, or (at your option) |
297 | 10 any later version. |
11 | |
12 GNU Emacs is distributed in the hope that it will be useful, | |
13 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 GNU General Public License for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
18 along with GNU Emacs; see the file COPYING. If not, write to | |
64084 | 19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
20 Boston, MA 02110-1301, USA. */ | |
297 | 21 |
22 | |
4696
1fc792473491
Include <config.h> instead of "config.h".
Roland McGrath <roland@gnu.org>
parents:
3999
diff
changeset
|
23 #include <config.h> |
297 | 24 |
25 #include <sys/types.h> | |
26 #include <sys/file.h> /* Must be after sys/types.h for USG and BSD4_1*/ | |
58087 | 27 #include <ctype.h> |
297 | 28 |
51402 | 29 #ifdef HAVE_FCNTL_H |
297 | 30 #include <fcntl.h> |
31 #endif | |
32 | |
6862
653504b6b5dd
[HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents:
6030
diff
changeset
|
33 #ifdef HAVE_UNISTD_H |
653504b6b5dd
[HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents:
6030
diff
changeset
|
34 #include <unistd.h> |
653504b6b5dd
[HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents:
6030
diff
changeset
|
35 #endif |
653504b6b5dd
[HAVE_UNISTD_H]: Include unistd.h.
Richard M. Stallman <rms@gnu.org>
parents:
6030
diff
changeset
|
36 |
297 | 37 #ifndef O_RDONLY |
38 #define O_RDONLY 0 | |
39 #endif | |
40 | |
41 #include "lisp.h" | |
42 #include "buffer.h" | |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
43 #include "keyboard.h" |
20619 | 44 #include "charset.h" |
39697
0b986bb45526
Include keymap.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39675
diff
changeset
|
45 #include "keymap.h" |
297 | 46 |
31336 | 47 #ifdef HAVE_INDEX |
48 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
|
49 #endif |
7930c46bb365
(toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents:
30154
diff
changeset
|
50 |
40139
0600331ddd52
(Vhelp_manyarg_func_alist): Variable removed.
Miles Bader <miles@gnu.org>
parents:
39973
diff
changeset
|
51 Lisp_Object Vdoc_file_name; |
297 | 52 |
28334
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
53 Lisp_Object Qfunction_documentation; |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
54 |
58068
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
55 /* A list of files used to build this Emacs binary. */ |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
56 static Lisp_Object Vbuild_files; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
57 |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
58 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
|
59 |
65391
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
60 extern Lisp_Object Qremap; |
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
61 |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
62 /* For VMS versions with limited file name syntax, |
60388
1f66922e7ad0
(munge_doc_file_name) [VMS]: Use NO_HYPHENS_IN_FILENAMES, not VMS4_4.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60065
diff
changeset
|
63 convert the name to something VMS will allow. */ |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
64 static void |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
65 munge_doc_file_name (name) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
66 char *name; |
297 | 67 { |
68 #ifdef VMS | |
60388
1f66922e7ad0
(munge_doc_file_name) [VMS]: Use NO_HYPHENS_IN_FILENAMES, not VMS4_4.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60065
diff
changeset
|
69 #ifndef NO_HYPHENS_IN_FILENAMES |
1f66922e7ad0
(munge_doc_file_name) [VMS]: Use NO_HYPHENS_IN_FILENAMES, not VMS4_4.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60065
diff
changeset
|
70 extern char * sys_translate_unix (char *ufile); |
1f66922e7ad0
(munge_doc_file_name) [VMS]: Use NO_HYPHENS_IN_FILENAMES, not VMS4_4.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60065
diff
changeset
|
71 strcpy (name, sys_translate_unix (name)); |
1f66922e7ad0
(munge_doc_file_name) [VMS]: Use NO_HYPHENS_IN_FILENAMES, not VMS4_4.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60065
diff
changeset
|
72 #else /* NO_HYPHENS_IN_FILENAMES */ |
1f66922e7ad0
(munge_doc_file_name) [VMS]: Use NO_HYPHENS_IN_FILENAMES, not VMS4_4.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60065
diff
changeset
|
73 char *p = name; |
297 | 74 while (*p) |
75 { | |
76 if (*p == '-') | |
77 *p = '_'; | |
78 p++; | |
79 } | |
60388
1f66922e7ad0
(munge_doc_file_name) [VMS]: Use NO_HYPHENS_IN_FILENAMES, not VMS4_4.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60065
diff
changeset
|
80 #endif /* NO_HYPHENS_IN_FILENAMES */ |
297 | 81 #endif /* VMS */ |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
82 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
83 |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
84 /* 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
|
85 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
|
86 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
|
87 |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
88 static unsigned char *read_bytecode_pointer; |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
89 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
|
90 |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
91 /* 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
|
92 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
|
93 |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
94 int |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
95 read_bytecode_char (unreadflag) |
25758
fca9459a0555
(read_bytecode_char): Declare arg.
Dave Love <fx@gnu.org>
parents:
25662
diff
changeset
|
96 int unreadflag; |
22690
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 if (unreadflag) |
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 read_bytecode_pointer--; |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
101 return 0; |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
102 } |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
103 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
|
104 } |
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
105 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
106 /* 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
|
107 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
|
108 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
|
109 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
|
110 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
|
111 (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
|
112 them without actually fetching the doc string.) |
10a9f355a346
(get_doc_string): New arg UNIBYTE
Richard M. Stallman <rms@gnu.org>
parents:
21514
diff
changeset
|
113 |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
114 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
|
115 (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
|
116 return nil. |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
117 |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
118 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
|
119 |
22562
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
120 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
|
121 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
|
122 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
|
123 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
|
124 |
22268
9308a15aa8f8
(get_doc_string): Make non-static.
Richard M. Stallman <rms@gnu.org>
parents:
22043
diff
changeset
|
125 Lisp_Object |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
126 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
|
127 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
|
128 int unibyte, definition; |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
129 { |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
130 char *from, *to; |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
131 register int fd; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
132 register char *name; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
133 register char *p, *p1; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
134 int minsize; |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
135 int offset, position; |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
136 Lisp_Object file, tem; |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
137 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
138 if (INTEGERP (filepos)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
139 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
140 file = Vdoc_file_name; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
141 position = XINT (filepos); |
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 if (CONSP (filepos)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
144 { |
25662
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
145 file = XCAR (filepos); |
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
146 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
|
147 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
148 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
149 return Qnil; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
150 |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
151 if (position < 0) |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
152 position = - position; |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
153 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
154 if (!STRINGP (Vdoc_directory)) |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
155 return Qnil; |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
156 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
157 if (!STRINGP (file)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
158 return Qnil; |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46370
diff
changeset
|
159 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
160 /* 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
|
161 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
|
162 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
163 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
|
164 if (NILP (tem)) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
165 { |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
166 minsize = SCHARS (Vdoc_directory); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
167 /* sizeof ("../etc/") == 8 */ |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
168 if (minsize < 8) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
169 minsize = 8; |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
170 name = (char *) alloca (minsize + SCHARS (file) + 8); |
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
171 strcpy (name, SDATA (Vdoc_directory)); |
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
172 strcat (name, SDATA (file)); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
173 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
|
174 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
175 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
176 { |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
177 name = (char *) SDATA (file); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
178 } |
297 | 179 |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
180 fd = emacs_open (name, O_RDONLY, 0); |
297 | 181 if (fd < 0) |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
182 { |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
183 #ifndef CANNOT_DUMP |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
184 if (!NILP (Vpurify_flag)) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
185 { |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
186 /* 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
|
187 So check in ../etc. */ |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
188 strcpy (name, "../etc/"); |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
189 strcat (name, SDATA (file)); |
9087
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
190 munge_doc_file_name (name); |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
191 |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
192 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
|
193 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
194 #endif |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
195 if (fd < 0) |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
196 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
|
197 } |
e3c272c7f4d2
(get_doc_string): Look in ../etc while dumping.
Richard M. Stallman <rms@gnu.org>
parents:
8823
diff
changeset
|
198 |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
199 /* 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
|
200 /* 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
|
201 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
|
202 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
|
203 if (0 > lseek (fd, position - offset, 0)) |
297 | 204 { |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
205 emacs_close (fd); |
297 | 206 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
|
207 position, name); |
297 | 208 } |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
209 |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
210 /* 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
|
211 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
|
212 |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
213 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
|
214 while (1) |
297 | 215 { |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
216 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
|
217 - (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
|
218 int nread; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
219 |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
220 /* 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
|
221 if (space_left == 0) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
222 { |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
223 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
|
224 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
|
225 get_doc_string_buffer |
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
226 = (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
|
227 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
|
228 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
|
229 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
|
230 - (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
|
231 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
232 |
14552
e6f31368feeb
(get_doc_string): Always read entire disk blocks.
Richard M. Stallman <rms@gnu.org>
parents:
14186
diff
changeset
|
233 /* 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
|
234 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
|
235 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
|
236 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
|
237 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
|
238 if (nread < 0) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
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 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
|
242 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
243 p[nread] = 0; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
244 if (!nread) |
297 | 245 break; |
14648
45d13c154bb4
(get_doc_string): Move static vars outside the function,
Richard M. Stallman <rms@gnu.org>
parents:
14552
diff
changeset
|
246 if (p == get_doc_string_buffer) |
31225
7930c46bb365
(toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents:
30154
diff
changeset
|
247 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
|
248 else |
31225
7930c46bb365
(toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents:
30154
diff
changeset
|
249 p1 = (char *) index (p, '\037'); |
297 | 250 if (p1) |
251 { | |
252 *p1 = 0; | |
253 p = p1; | |
254 break; | |
255 } | |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
256 p += nread; |
297 | 257 } |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
258 emacs_close (fd); |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
259 |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
260 /* Sanity checking. */ |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
261 if (CONSP (filepos)) |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
262 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
263 int test = 1; |
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 return Qnil; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
266 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
|
267 && 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
|
268 test++; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
269 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
|
270 || 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
|
271 return Qnil; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
272 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
273 else |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
274 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
275 int test = 1; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
276 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
|
277 return Qnil; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
278 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
|
279 test++; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
280 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
|
281 return Qnil; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
282 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
283 |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
284 /* 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
|
285 ^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
|
286 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
|
287 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
|
288 while (from != p) |
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 if (*from == 1) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
291 { |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
292 int c; |
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 from++; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
295 c = *from++; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
296 if (c == 1) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
297 *to++ = c; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
298 else if (c == '0') |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
299 *to++ = 0; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
300 else if (c == '_') |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
301 *to++ = 037; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
302 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
303 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
|
304 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
305 else |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
306 *to++ = *from++; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
307 } |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
308 |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
309 /* 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
|
310 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
|
311 if (definition) |
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
312 { |
22690
31bc848c5f18
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22602
diff
changeset
|
313 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
|
314 return Fread (Qlambda); |
22562
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
315 } |
ddb3fd464b77
(get_doc_string): 2nd arg is now DEFINITION;
Richard M. Stallman <rms@gnu.org>
parents:
22268
diff
changeset
|
316 |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
317 if (unibyte) |
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
318 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
|
319 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
|
320 else |
24573
aa24b1cb428a
(get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents:
23921
diff
changeset
|
321 { |
aa24b1cb428a
(get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents:
23921
diff
changeset
|
322 /* 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
|
323 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
|
324 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
|
325 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
|
326 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
|
327 nchars, |
aa24b1cb428a
(get_doc_string): When UNIBYTE and DEFINITION are 0,
Richard M. Stallman <rms@gnu.org>
parents:
23921
diff
changeset
|
328 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
|
329 } |
10202
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 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
332 /* 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
|
333 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
|
334 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
|
335 |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
336 Lisp_Object |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
337 read_doc_string (filepos) |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
338 Lisp_Object filepos; |
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
339 { |
22602
9c6b3b9c3c8f
(get_doc_string): Take both UNIBYTE and DEFINITION as args.
Richard M. Stallman <rms@gnu.org>
parents:
22562
diff
changeset
|
340 return get_doc_string (filepos, 0, 1); |
297 | 341 } |
342 | |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
343 static int |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
344 reread_doc_file (file) |
44355
412b4760216b
(reread_doc_file): Add missing argument declaration.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44348
diff
changeset
|
345 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
|
346 { |
45368
65ad2c8b301b
(reread_doc_file): Don't ask for confirmation.
Richard M. Stallman <rms@gnu.org>
parents:
44385
diff
changeset
|
347 #if 0 |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
348 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
|
349 struct gcpro gcpro1; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
350 GCPRO1 (file); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
351 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
|
352 prompt[1] = NILP (file) ? Vdoc_file_name : file; |
45368
65ad2c8b301b
(reread_doc_file): Don't ask for confirmation.
Richard M. Stallman <rms@gnu.org>
parents:
44385
diff
changeset
|
353 prompt[2] = build_string (" is out of sync. Reload? "); |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
354 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
|
355 UNGCPRO; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
356 if (NILP (reply)) |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
357 return 0; |
45368
65ad2c8b301b
(reread_doc_file): Don't ask for confirmation.
Richard M. Stallman <rms@gnu.org>
parents:
44385
diff
changeset
|
358 #endif |
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 if (NILP (file)) |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
361 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
|
362 else |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
363 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
|
364 |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
365 return 1; |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
366 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
367 |
570 | 368 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
|
369 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
|
370 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
|
371 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
|
372 (function, raw) |
647 | 373 Lisp_Object function, raw; |
297 | 374 { |
375 Lisp_Object fun; | |
376 Lisp_Object funcar; | |
570 | 377 Lisp_Object tem, doc; |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
378 int try_reload = 1; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
379 |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
380 documentation: |
297 | 381 |
34363
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
382 doc = Qnil; |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46370
diff
changeset
|
383 |
28334
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
384 if (SYMBOLP (function) |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
385 && (tem = Fget (function, Qfunction_documentation), |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
386 !NILP (tem))) |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
387 return Fdocumentation_property (function, Qfunction_documentation, raw); |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46370
diff
changeset
|
388 |
647 | 389 fun = Findirect_function (function); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
390 if (SUBRP (fun)) |
297 | 391 { |
28334
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
392 if (XSUBR (fun)->doc == 0) |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
393 return Qnil; |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
394 else if ((EMACS_INT) XSUBR (fun)->doc >= 0) |
570 | 395 doc = build_string (XSUBR (fun)->doc); |
297 | 396 else |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
397 doc = make_number ((EMACS_INT) XSUBR (fun)->doc); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
398 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
399 else if (COMPILEDP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
400 { |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
401 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING) |
297 | 402 return Qnil; |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
403 tem = AREF (fun, COMPILED_DOC_STRING); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
404 if (STRINGP (tem)) |
570 | 405 doc = tem; |
10202
4013c083162e
(get_doc_string): Now static. Arg now Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
10002
diff
changeset
|
406 else if (NATNUMP (tem) || CONSP (tem)) |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
407 doc = tem; |
570 | 408 else |
409 return Qnil; | |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
410 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
411 else if (STRINGP (fun) || VECTORP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
412 { |
297 | 413 return build_string ("Keyboard macro."); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
414 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
415 else if (CONSP (fun)) |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
416 { |
297 | 417 funcar = Fcar (fun); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
418 if (!SYMBOLP (funcar)) |
297 | 419 return Fsignal (Qinvalid_function, Fcons (fun, Qnil)); |
647 | 420 else if (EQ (funcar, Qkeymap)) |
23921
81a6345fd5e8
(Fdocumentation): Change the doc string for prefix
Andreas Schwab <schwab@suse.de>
parents:
22890
diff
changeset
|
421 return build_string ("Prefix command (definition is a keymap associating keystrokes with commands)."); |
647 | 422 else if (EQ (funcar, Qlambda) |
423 || EQ (funcar, Qautoload)) | |
297 | 424 { |
13521
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
425 Lisp_Object tem1; |
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
426 tem1 = Fcdr (Fcdr (fun)); |
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
427 tem = Fcar (tem1); |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
428 if (STRINGP (tem)) |
570 | 429 doc = tem; |
13521
13e55327ef5e
(Fdocumentation): Reject a file reference
Richard M. Stallman <rms@gnu.org>
parents:
13244
diff
changeset
|
430 /* 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
|
431 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
|
432 else if ((NATNUMP (tem) || (CONSP (tem) && INTEGERP (XCDR (tem)))) |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
433 && !NILP (XCDR (tem1))) |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
434 doc = tem; |
570 | 435 else |
436 return Qnil; | |
297 | 437 } |
647 | 438 else if (EQ (funcar, Qmacro)) |
570 | 439 return Fdocumentation (Fcdr (fun), raw); |
10002
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
440 else |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
441 goto oops; |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
442 } |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
443 else |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
444 { |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
445 oops: |
5b2b7e378772
(Fdocumentation): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
9958
diff
changeset
|
446 Fsignal (Qinvalid_function, Fcons (fun, Qnil)); |
297 | 447 } |
570 | 448 |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
449 /* 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
|
450 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
|
451 if (EQ (doc, make_number (0))) |
d5cf9afe17d6
(Fdocumentation): More brainos. I need sleep.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44383
diff
changeset
|
452 doc = Qnil; |
44381
15b5489c78d6
(Fdocumentation, Fdocumentation_property): When the doc
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44355
diff
changeset
|
453 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
|
454 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
455 Lisp_Object tem; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
456 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
|
457 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
|
458 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
459 /* 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
|
460 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
|
461 GCPRO2 (function, raw); |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
462 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
|
463 UNGCPRO; |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
464 if (try_reload) |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
465 { |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
466 try_reload = 0; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
467 goto documentation; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
468 } |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
469 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
470 else |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
471 doc = tem; |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
472 } |
41823
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
473 |
577 | 474 if (NILP (raw)) |
26471
b1863c0b8f9c
(Fdocumentation): Remove gcpro here too.
Dave Love <fx@gnu.org>
parents:
26420
diff
changeset
|
475 doc = Fsubstitute_command_keys (doc); |
570 | 476 return doc; |
297 | 477 } |
478 | |
28036
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
479 DEFUN ("documentation-property", Fdocumentation_property, |
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
480 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
|
481 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
|
482 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
|
483 `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
|
484 |
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
485 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
|
486 `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
|
487 aren't strings. */) |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
488 (symbol, prop, raw) |
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
489 Lisp_Object symbol, prop, raw; |
297 | 490 { |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
491 int try_reload = 1; |
26076
edbfca66058d
(Fdocumentation_property): Remove register declaration for `tem'.
Dave Love <fx@gnu.org>
parents:
26075
diff
changeset
|
492 Lisp_Object tem; |
297 | 493 |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
494 documentation_property: |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46370
diff
changeset
|
495 |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
496 tem = Fget (symbol, prop); |
44383
e44eec58a815
(Fdocumentation): Add missing parentheses.
Juanma Barranquero <lekktu@gmail.com>
parents:
44381
diff
changeset
|
497 if (EQ (tem, make_number (0))) |
44385
d5cf9afe17d6
(Fdocumentation): More brainos. I need sleep.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44383
diff
changeset
|
498 tem = Qnil; |
44381
15b5489c78d6
(Fdocumentation, Fdocumentation_property): When the doc
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44355
diff
changeset
|
499 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
|
500 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
501 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
|
502 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
|
503 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
|
504 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
505 /* 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
|
506 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
|
507 GCPRO3 (symbol, prop, raw); |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
508 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
|
509 UNGCPRO; |
44348
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
510 if (try_reload) |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
511 { |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
512 try_reload = 0; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
513 goto documentation_property; |
80c9e94bec17
(reread_doc_file): Return whether reload was attempted.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
44324
diff
changeset
|
514 } |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
515 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
516 } |
28036
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
517 else if (!STRINGP (tem)) |
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
518 /* Feval protects its argument. */ |
ec8b11f3d3da
(Fdocumentation_property): If value is not a string,
Gerd Moellmann <gerd@gnu.org>
parents:
27560
diff
changeset
|
519 tem = Feval (tem); |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46370
diff
changeset
|
520 |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
521 if (NILP (raw) && STRINGP (tem)) |
26420
00b7d6135be4
(Fdocumentation_property): Remove GCPRO because
Gerd Moellmann <gerd@gnu.org>
parents:
26317
diff
changeset
|
522 tem = Fsubstitute_command_keys (tem); |
312
adba7439e87c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
297
diff
changeset
|
523 return tem; |
297 | 524 } |
525 | |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
526 /* 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
|
527 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
528 static void |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
529 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
|
530 Lisp_Object fun; |
10330
240a2c88d439
(store_function_docstring): Arg is now EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents:
10202
diff
changeset
|
531 /* 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
|
532 EMACS_INT offset; |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
533 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
534 fun = indirect_function (fun); |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
535 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
536 /* 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
|
537 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
538 /* Lisp_Subrs have a slot for it. */ |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
539 if (SUBRP (fun)) |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
540 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
|
541 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
542 /* 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
|
543 else if (CONSP (fun)) |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
544 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
545 Lisp_Object tem; |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
546 |
25662
0a7261c1d487
Use XCAR, XCDR, and XFLOAT_DATA instead of explicit member access.
Ken Raeburn <raeburn@raeburn.org>
parents:
24573
diff
changeset
|
547 tem = XCAR (fun); |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
548 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
|
549 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
550 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
|
551 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
|
552 XSETCARFASTINT (tem, offset); |
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 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
|
555 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
|
556 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
557 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
558 /* Bytecode objects sometimes have slots for it. */ |
9133
48820d57a24c
(get_doc_string, Fdocumentation, Fdocumentation_property,
Karl Heuer <kwzh@gnu.org>
parents:
9087
diff
changeset
|
559 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
|
560 { |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
561 /* 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
|
562 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
|
563 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING) |
e192139240f2
(Fsnarf_documentation): Add prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41218
diff
changeset
|
564 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
|
565 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
566 } |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
567 |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
568 |
297 | 569 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
|
570 1, 1, 0, |
41218
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
571 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
|
572 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
|
573 records them in function and variable definitions. |
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
574 The function takes one argument, FILENAME, a string; |
ace002127a1c
(Fsnarf_documentation): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
41001
diff
changeset
|
575 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
|
576 That file is found in `../etc' now; later, when the dumped Emacs is run, |
56216
efd6af30bde2
(Fsnarf_documentation): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54927
diff
changeset
|
577 the same file name is found in the `doc-directory'. */) |
41001
a17c8b15ef1b
Change doc-string comments to `new style' [w/`doc:' keyword].
Pavel Janík <Pavel@Janik.cz>
parents:
40702
diff
changeset
|
578 (filename) |
297 | 579 Lisp_Object filename; |
580 { | |
581 int fd; | |
582 char buf[1024 + 1]; | |
583 register int filled; | |
584 register int pos; | |
585 register char *p, *end; | |
34963
681963400696
(Fsnarf_documentation): Remove unused variables `fun' and
Eli Zaretskii <eliz@gnu.org>
parents:
34363
diff
changeset
|
586 Lisp_Object sym; |
297 | 587 char *name; |
58068
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
588 int skip_file = 0; |
297 | 589 |
40656
cdfd4d09b79a
Update usage of CHECK_ macros (remove unused second argument).
Pavel Janík <Pavel@Janik.cz>
parents:
40139
diff
changeset
|
590 CHECK_STRING (filename); |
297 | 591 |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
592 if |
297 | 593 #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
|
594 (!NILP (Vpurify_flag)) |
297 | 595 #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
|
596 (0) |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
597 #endif /* CANNOT_DUMP */ |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
598 { |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
599 name = (char *) alloca (SCHARS (filename) + 14); |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
600 strcpy (name, "../etc/"); |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
601 } |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
602 else |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
603 { |
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
604 CHECK_STRING (Vdoc_directory); |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
605 name = (char *) alloca (SCHARS (filename) |
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
606 + SCHARS (Vdoc_directory) + 1); |
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
607 strcpy (name, SDATA (Vdoc_directory)); |
44324
def57419f6ec
(get_doc_string): Return nil of the location is wrong.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43155
diff
changeset
|
608 } |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
609 strcat (name, SDATA (filename)); /*** Add this line ***/ |
60388
1f66922e7ad0
(munge_doc_file_name) [VMS]: Use NO_HYPHENS_IN_FILENAMES, not VMS4_4.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60065
diff
changeset
|
610 munge_doc_file_name (name); |
297 | 611 |
58068
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
612 /* Vbuild_files is nil when temacs is run, and non-nil after that. */ |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
613 if (NILP (Vbuild_files)) |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
614 { |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
615 size_t cp_size = 0; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
616 size_t to_read; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
617 int nr_read; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
618 char *cp = NULL; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
619 char *beg, *end; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
620 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
621 fd = emacs_open ("buildobj.lst", O_RDONLY, 0); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
622 if (fd < 0) |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
623 report_file_error ("Opening file buildobj.lst", Qnil); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
624 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
625 filled = 0; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
626 for (;;) |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
627 { |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
628 cp_size += 1024; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
629 to_read = cp_size - 1 - filled; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
630 cp = xrealloc (cp, cp_size); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
631 nr_read = emacs_read (fd, &cp[filled], to_read); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
632 filled += nr_read; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
633 if (nr_read < to_read) |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
634 break; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
635 } |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
636 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
637 emacs_close (fd); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
638 cp[filled] = 0; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
639 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
640 for (beg = cp; *beg; beg = end) |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
641 { |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
642 int len; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
643 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
644 while (*beg && isspace (*beg)) ++beg; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
645 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
646 for (end = beg; *end && ! isspace (*end); ++end) |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
647 if (*end == '/') beg = end+1; /* skip directory part */ |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
648 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
649 len = end - beg; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
650 if (len > 4 && end[-4] == '.' && end[-3] == 'o') |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
651 len -= 2; /* Just take .o if it ends in .obj */ |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
652 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
653 if (len > 0) |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
654 Vbuild_files = Fcons (make_string (beg, len), Vbuild_files); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
655 } |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
656 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
657 xfree (cp); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
658 } |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
659 |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
660 fd = emacs_open (name, O_RDONLY, 0); |
297 | 661 if (fd < 0) |
662 report_file_error ("Opening doc string file", | |
663 Fcons (build_string (name), Qnil)); | |
664 Vdoc_file_name = filename; | |
665 filled = 0; | |
666 pos = 0; | |
667 while (1) | |
668 { | |
669 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
|
670 filled += emacs_read (fd, &buf[filled], sizeof buf - 1 - filled); |
297 | 671 if (!filled) |
672 break; | |
673 | |
674 buf[filled] = 0; | |
675 p = buf; | |
676 end = buf + (filled < 512 ? filled : filled - 128); | |
677 while (p != end && *p != '\037') p++; | |
678 /* p points to ^_Ffunctionname\n or ^_Vvarname\n. */ | |
679 if (p != end) | |
680 { | |
31225
7930c46bb365
(toplevel) [HAVE_STRING_H]: Include string.h.
Gerd Moellmann <gerd@gnu.org>
parents:
30154
diff
changeset
|
681 end = (char *) index (p, '\n'); |
58068
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
682 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
683 /* See if this is a file name, and if it is a file in build-files. */ |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
684 if (p[1] == 'S' && end - p > 4 && end[-2] == '.' |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
685 && (end[-1] == 'o' || end[-1] == 'c')) |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
686 { |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
687 int len = end - p - 2; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
688 char *fromfile = alloca (len + 1); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
689 strncpy (fromfile, &p[2], len); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
690 fromfile[len] = 0; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
691 if (fromfile[len-1] == 'c') |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
692 fromfile[len-1] = 'o'; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
693 |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
694 if (EQ (Fmember (build_string (fromfile), Vbuild_files), Qnil)) |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
695 skip_file = 1; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
696 else |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
697 skip_file = 0; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
698 } |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
699 |
20619 | 700 sym = oblookup (Vobarray, p + 2, |
701 multibyte_chars_in_text (p + 2, end - p - 2), | |
702 end - p - 2); | |
58068
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
703 if (! skip_file && SYMBOLP (sym)) |
297 | 704 { |
705 /* Attach a docstring to a variable? */ | |
706 if (p[1] == 'V') | |
707 { | |
708 /* Install file-position as variable-documentation property | |
709 and make it negative for a user-variable | |
710 (doc starts with a `*'). */ | |
711 Fput (sym, Qvariable_documentation, | |
712 make_number ((pos + end + 1 - buf) | |
713 * (end[1] == '*' ? -1 : 1))); | |
714 } | |
715 | |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
716 /* Attach a docstring to a function? */ |
297 | 717 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
|
718 store_function_docstring (sym, pos + end + 1 - buf); |
297 | 719 |
54745
98cf37e32872
(Fsnarf_documentation): Ignore new file name entries.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54234
diff
changeset
|
720 else if (p[1] == 'S') |
98cf37e32872
(Fsnarf_documentation): Ignore new file name entries.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54234
diff
changeset
|
721 ; /* Just a source file name boundary marker. Ignore it. */ |
98cf37e32872
(Fsnarf_documentation): Ignore new file name entries.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54234
diff
changeset
|
722 |
1651
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
723 else |
ef09501a0a9b
* doc.c (store_function_docstring): New function, made from part
Jim Blandy <jimb@redhat.com>
parents:
1511
diff
changeset
|
724 error ("DOC file invalid at position %d", pos); |
297 | 725 } |
726 } | |
727 pos += end - buf; | |
728 filled -= end - buf; | |
729 bcopy (end, buf, filled); | |
730 } | |
26088
b7aa6ac26872
Add support for large files, 64-bit Solaris, system locale codings.
Paul Eggert <eggert@twinsun.com>
parents:
26076
diff
changeset
|
731 emacs_close (fd); |
297 | 732 return Qnil; |
733 } | |
734 | |
735 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
|
736 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
|
737 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
|
738 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
|
739 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
|
740 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
|
741 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
|
742 \(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
|
743 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
|
744 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
|
745 \\=\\= 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
|
746 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
|
747 (string) |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
748 Lisp_Object string; |
297 | 749 { |
750 unsigned char *buf; | |
751 int changed = 0; | |
752 register unsigned char *strp; | |
753 register unsigned char *bufp; | |
754 int idx; | |
755 int bsize; | |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
756 Lisp_Object tem; |
297 | 757 Lisp_Object keymap; |
758 unsigned char *start; | |
20802
8cd0a6343a84
(Fsubstitute_command_keys): Declare length_byte out of
Kenichi Handa <handa@m17n.org>
parents:
20708
diff
changeset
|
759 int length, length_byte; |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
760 Lisp_Object name; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
761 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; |
20619 | 762 int multibyte; |
763 int nchars; | |
297 | 764 |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
765 if (NILP (string)) |
297 | 766 return Qnil; |
767 | |
40656
cdfd4d09b79a
Update usage of CHECK_ macros (remove unused second argument).
Pavel Janík <Pavel@Janik.cz>
parents:
40139
diff
changeset
|
768 CHECK_STRING (string); |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
769 tem = Qnil; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
770 keymap = Qnil; |
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
771 name = Qnil; |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
772 GCPRO4 (string, tem, keymap, name); |
297 | 773 |
20619 | 774 multibyte = STRING_MULTIBYTE (string); |
775 nchars = 0; | |
776 | |
5784
9c3be8e0d2ef
(Fsubstitute_command_keys): Pass keymap as that arg
Richard M. Stallman <rms@gnu.org>
parents:
5550
diff
changeset
|
777 /* 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
|
778 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
|
779 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
|
780 or from a \\<mapname> construct in STRING itself.. */ |
12261 | 781 keymap = current_kboard->Voverriding_terminal_local_map; |
782 if (NILP (keymap)) | |
783 keymap = Voverriding_local_map; | |
297 | 784 |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
785 bsize = SBYTES (string); |
297 | 786 bufp = buf = (unsigned char *) xmalloc (bsize); |
787 | |
50629
36d13cf0f114
(Fsubstitute_command_keys): Remove spurious casts.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49600
diff
changeset
|
788 strp = SDATA (string); |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
789 while (strp < SDATA (string) + SBYTES (string)) |
297 | 790 { |
791 if (strp[0] == '\\' && strp[1] == '=') | |
792 { | |
793 /* \= quotes the next character; | |
794 thus, to put in \[ without its special meaning, use \=\[. */ | |
795 changed = 1; | |
20619 | 796 strp += 2; |
797 if (multibyte) | |
798 { | |
799 int len; | |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
800 int maxlen = SDATA (string) + SBYTES (string) - strp; |
20619 | 801 |
802 STRING_CHAR_AND_LENGTH (strp, maxlen, len); | |
803 if (len == 1) | |
804 *bufp = *strp; | |
805 else | |
806 bcopy (strp, bufp, len); | |
807 strp += len; | |
808 bufp += len; | |
809 nchars++; | |
810 } | |
811 else | |
812 *bufp++ = *strp++, nchars++; | |
297 | 813 } |
814 else if (strp[0] == '\\' && strp[1] == '[') | |
815 { | |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
816 int start_idx; |
65391
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
817 int follow_remap = 1; |
5248
27d6275810a7
(Fsubstitute_command_keys): Ignore menu bar bindings.
Richard M. Stallman <rms@gnu.org>
parents:
4716
diff
changeset
|
818 |
297 | 819 changed = 1; |
820 strp += 2; /* skip \[ */ | |
821 start = strp; | |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
822 start_idx = start - SDATA (string); |
297 | 823 |
50629
36d13cf0f114
(Fsubstitute_command_keys): Remove spurious casts.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49600
diff
changeset
|
824 while ((strp - SDATA (string) |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
825 < SBYTES (string)) |
297 | 826 && *strp != ']') |
827 strp++; | |
20619 | 828 length_byte = strp - start; |
829 | |
297 | 830 strp++; /* skip ] */ |
831 | |
832 /* Save STRP in IDX. */ | |
50629
36d13cf0f114
(Fsubstitute_command_keys): Remove spurious casts.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49600
diff
changeset
|
833 idx = strp - SDATA (string); |
57497
0a4c356f307b
(Fsubstitute_command_keys): Fix remap-handling.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57441
diff
changeset
|
834 name = 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
|
835 |
65391
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
836 do_remap: |
57441
4c881805ff35
(Fsubstitute_command_keys): Ignore remappings unless there
Kim F. Storm <storm@cua.dk>
parents:
56216
diff
changeset
|
837 /* Ignore remappings unless there are no ordinary bindings. */ |
57497
0a4c356f307b
(Fsubstitute_command_keys): Fix remap-handling.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57441
diff
changeset
|
838 tem = Fwhere_is_internal (name, keymap, Qt, Qnil, Qt); |
57441
4c881805ff35
(Fsubstitute_command_keys): Ignore remappings unless there
Kim F. Storm <storm@cua.dk>
parents:
56216
diff
changeset
|
839 if (NILP (tem)) |
57497
0a4c356f307b
(Fsubstitute_command_keys): Fix remap-handling.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57441
diff
changeset
|
840 tem = Fwhere_is_internal (name, keymap, Qt, Qnil, Qnil); |
57441
4c881805ff35
(Fsubstitute_command_keys): Ignore remappings unless there
Kim F. Storm <storm@cua.dk>
parents:
56216
diff
changeset
|
841 |
65391
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
842 if (VECTORP (tem) && XVECTOR (tem)->size > 1 |
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
843 && EQ (AREF (tem, 0), Qremap) && SYMBOLP (AREF (tem, 1)) |
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
844 && follow_remap) |
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
845 { |
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
846 name = AREF (tem, 1); |
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
847 follow_remap = 0; |
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
848 goto do_remap; |
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
849 } |
4a6f5ef57ed1
(Fsubstitute_command_keys): Lookup key binding for
Kim F. Storm <storm@cua.dk>
parents:
64770
diff
changeset
|
850 |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
851 /* 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
|
852 relocation of string contents into account. */ |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
853 strp = SDATA (string) + idx; |
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
854 start = SDATA (string) + start_idx; |
297 | 855 |
485 | 856 if (NILP (tem)) /* but not on any keys */ |
297 | 857 { |
34363
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
858 int offset = bufp - buf; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
859 buf = (unsigned char *) xrealloc (buf, bsize += 4); |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
860 bufp = buf + offset; |
297 | 861 bcopy ("M-x ", bufp, 4); |
862 bufp += 4; | |
20619 | 863 nchars += 4; |
864 if (multibyte) | |
865 length = multibyte_chars_in_text (start, length_byte); | |
866 else | |
867 length = length_byte; | |
297 | 868 goto subst; |
869 } | |
870 else | |
871 { /* function is on a key */ | |
54927
7b6b4d9ae726
(Fkey_description): Change callers.
Kim F. Storm <storm@cua.dk>
parents:
54745
diff
changeset
|
872 tem = Fkey_description (tem, Qnil); |
297 | 873 goto subst_string; |
874 } | |
875 } | |
876 /* \{foo} is replaced with a summary of the keymap (symbol-value foo). | |
877 \<foo> just sets the keymap used for \[cmd]. */ | |
878 else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<')) | |
879 { | |
880 struct buffer *oldbuf; | |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
881 int start_idx; |
60065
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
882 /* This is for computing the SHADOWS arg for describe_map_tree. */ |
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
883 Lisp_Object active_maps = Fcurrent_active_maps (Qnil); |
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
884 Lisp_Object earlier_maps; |
297 | 885 |
886 changed = 1; | |
887 strp += 2; /* skip \{ or \< */ | |
888 start = strp; | |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
889 start_idx = start - SDATA (string); |
297 | 890 |
54234
e1003d782dc6
(Fsubstitute_command_keys): Fix counding bytes.
Kenichi Handa <handa@m17n.org>
parents:
52401
diff
changeset
|
891 while ((strp - SDATA (string) < SBYTES (string)) |
297 | 892 && *strp != '}' && *strp != '>') |
893 strp++; | |
20619 | 894 |
895 length_byte = strp - start; | |
297 | 896 strp++; /* skip } or > */ |
897 | |
898 /* Save STRP in IDX. */ | |
50629
36d13cf0f114
(Fsubstitute_command_keys): Remove spurious casts.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49600
diff
changeset
|
899 idx = strp - SDATA (string); |
297 | 900 |
901 /* Get the value of the keymap in TEM, or nil if undefined. | |
902 Do this while still in the user's current buffer | |
903 in case it is a local variable. */ | |
20619 | 904 name = Fintern (make_string (start, length_byte), Qnil); |
297 | 905 tem = Fboundp (name); |
485 | 906 if (! NILP (tem)) |
297 | 907 { |
908 tem = Fsymbol_value (name); | |
485 | 909 if (! NILP (tem)) |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
910 { |
32988
c3435dc00ed7
* lisp.h (KEYMAPP): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31336
diff
changeset
|
911 tem = get_keymap (tem, 0, 1); |
c3435dc00ed7
* lisp.h (KEYMAPP): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31336
diff
changeset
|
912 /* Note that get_keymap can GC. */ |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
913 strp = SDATA (string) + idx; |
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
914 start = SDATA (string) + start_idx; |
30154
f8e2064c56b1
(Fsubstitute_command_keys): Handle case that a GC
Gerd Moellmann <gerd@gnu.org>
parents:
28334
diff
changeset
|
915 } |
297 | 916 } |
917 | |
918 /* Now switch to a temp buffer. */ | |
919 oldbuf = current_buffer; | |
920 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer)); | |
921 | |
485 | 922 if (NILP (tem)) |
297 | 923 { |
924 name = Fsymbol_name (name); | |
925 insert_string ("\nUses keymap \""); | |
20619 | 926 insert_from_string (name, 0, 0, |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
927 SCHARS (name), |
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
928 SBYTES (name), 1); |
297 | 929 insert_string ("\", which is not currently defined.\n"); |
930 if (start[-1] == '<') keymap = Qnil; | |
931 } | |
932 else if (start[-1] == '<') | |
933 keymap = tem; | |
934 else | |
60065
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
935 { |
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
936 /* Get the list of active keymaps that precede this one. |
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
937 If this one's not active, get nil. */ |
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
938 earlier_maps = Fcdr (Fmemq (tem, Freverse (active_maps))); |
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
939 describe_map_tree (tem, 1, Fnreverse (earlier_maps), |
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
940 Qnil, (char *)0, 1, 0, 0, 1); |
42e18861b7b8
(Fsubstitute_command_keys): Compute list of shadowing maps
Richard M. Stallman <rms@gnu.org>
parents:
58087
diff
changeset
|
941 } |
297 | 942 tem = Fbuffer_string (); |
943 Ferase_buffer (); | |
944 set_buffer_internal (oldbuf); | |
945 | |
946 subst_string: | |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
947 start = SDATA (tem); |
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
948 length = SCHARS (tem); |
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
949 length_byte = SBYTES (tem); |
297 | 950 subst: |
34363
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
951 { |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
952 int offset = bufp - buf; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
953 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
|
954 bufp = buf + offset; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
955 bcopy (start, bufp, length_byte); |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
956 bufp += length_byte; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
957 nchars += length; |
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
958 /* Check STRING again in case gc relocated it. */ |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
959 strp = (unsigned char *) SDATA (string) + idx; |
34363
62a349fc3d3c
(Fsubstitute_command_keys): Change the way buffers
Gerd Moellmann <gerd@gnu.org>
parents:
32988
diff
changeset
|
960 } |
297 | 961 } |
20619 | 962 else if (! multibyte) /* just copy other chars */ |
963 *bufp++ = *strp++, nchars++; | |
964 else | |
965 { | |
966 int len; | |
46370
40db0673e6f0
Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents:
45368
diff
changeset
|
967 int maxlen = SDATA (string) + SBYTES (string) - strp; |
20619 | 968 |
969 STRING_CHAR_AND_LENGTH (strp, maxlen, len); | |
970 if (len == 1) | |
971 *bufp = *strp; | |
972 else | |
973 bcopy (strp, bufp, len); | |
974 strp += len; | |
975 bufp += len; | |
976 nchars++; | |
977 } | |
297 | 978 } |
979 | |
980 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
|
981 tem = make_string_from_bytes (buf, nchars, bufp - buf); |
297 | 982 else |
14069
a45a97ebdf1c
(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys):
Erik Naggum <erik@naggum.no>
parents:
13521
diff
changeset
|
983 tem = string; |
2439
b6c62e4abf59
Put interrupt input blocking in a separate file from xterm.h.
Jim Blandy <jimb@redhat.com>
parents:
1651
diff
changeset
|
984 xfree (buf); |
1511
ff88f962a982
* doc.c: #include keyboard.h.
Jim Blandy <jimb@redhat.com>
parents:
1116
diff
changeset
|
985 RETURN_UNGCPRO (tem); |
297 | 986 } |
987 | |
21514 | 988 void |
297 | 989 syms_of_doc () |
990 { | |
28334
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
991 Qfunction_documentation = intern ("function-documentation"); |
f9cb3463ee2a
(Qfunction_documentation): New variable.
Gerd Moellmann <gerd@gnu.org>
parents:
28036
diff
changeset
|
992 staticpro (&Qfunction_documentation); |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46370
diff
changeset
|
993 |
297 | 994 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
|
995 doc: /* Name of file containing documentation strings of built-in symbols. */); |
297 | 996 Vdoc_file_name = Qnil; |
997 | |
58068
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
998 DEFVAR_LISP ("build-files", &Vbuild_files, |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
999 doc: /* A list of files used to build this Emacs binary. */); |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
1000 Vbuild_files = Qnil; |
df00cdb75fc6
* doc.c: New variable Vbuild_files.
Jan Djärv <jan.h.d@swipnet.se>
parents:
57497
diff
changeset
|
1001 |
297 | 1002 defsubr (&Sdocumentation); |
1003 defsubr (&Sdocumentation_property); | |
1004 defsubr (&Ssnarf_documentation); | |
1005 defsubr (&Ssubstitute_command_keys); | |
1006 } | |
52401 | 1007 |
1008 /* arch-tag: 56281d4d-6949-43e2-be2e-f6517de744ba | |
1009 (do not change this comment) */ |