1 /* Record indices of function doc strings stored in a file.
2 Copyright (C) 1985, 86,93,94,95,97,98, 1999 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
24 #include <sys/types.h>
25 #include <sys/file.h> /* Must be after sys/types.h for USG and BSD4_1*/
44 Lisp_Object Vdoc_file_name
;
46 extern char *index ();
48 extern Lisp_Object Voverriding_local_map
;
50 /* For VMS versions with limited file name syntax,
51 convert the name to something VMS will allow. */
53 munge_doc_file_name (name
)
58 /* For VMS versions with limited file name syntax,
59 convert the name to something VMS will allow. */
67 #endif /* not VMS4_4 */
69 strcpy (name
, sys_translate_unix (name
));
74 /* Buffer used for reading from documentation file. */
75 static char *get_doc_string_buffer
;
76 static int get_doc_string_buffer_size
;
78 static unsigned char *read_bytecode_pointer
;
80 /* readchar in lread.c calls back here to fetch the next byte.
81 If UNREADFLAG is 1, we unread a byte. */
84 read_bytecode_char (unreadflag
)
89 read_bytecode_pointer
--;
92 return *read_bytecode_pointer
++;
95 /* Extract a doc string from a file. FILEPOS says where to get it.
96 If it is an integer, use that position in the standard DOC-... file.
97 If it is (FILE . INTEGER), use FILE as the file name
98 and INTEGER as the position in that file.
99 But if INTEGER is negative, make it positive.
100 (A negative integer is used for user variables, so we can distinguish
101 them without actually fetching the doc string.)
103 If UNIBYTE is nonzero, always make a unibyte string.
105 If DEFINITION is nonzero, assume this is for reading
106 a dynamic function definition; convert the bytestring
107 and the constants vector with appropriate byte handling,
108 and return a cons cell. */
111 get_doc_string (filepos
, unibyte
, definition
)
113 int unibyte
, definition
;
118 register char *p
, *p1
;
120 int offset
, position
;
121 Lisp_Object file
, tem
;
123 if (INTEGERP (filepos
))
125 file
= Vdoc_file_name
;
126 position
= XINT (filepos
);
128 else if (CONSP (filepos
))
130 file
= XCAR (filepos
);
131 position
= XINT (XCDR (filepos
));
133 position
= - position
;
138 if (!STRINGP (Vdoc_directory
))
144 /* Put the file name in NAME as a C string.
145 If it is relative, combine it with Vdoc_directory. */
147 tem
= Ffile_name_absolute_p (file
);
150 minsize
= XSTRING (Vdoc_directory
)->size
;
151 /* sizeof ("../etc/") == 8 */
154 name
= (char *) alloca (minsize
+ XSTRING (file
)->size
+ 8);
155 strcpy (name
, XSTRING (Vdoc_directory
)->data
);
156 strcat (name
, XSTRING (file
)->data
);
157 munge_doc_file_name (name
);
161 name
= (char *) XSTRING (file
)->data
;
164 fd
= emacs_open (name
, O_RDONLY
, 0);
168 if (!NILP (Vpurify_flag
))
170 /* Preparing to dump; DOC file is probably not installed.
171 So check in ../etc. */
172 strcpy (name
, "../etc/");
173 strcat (name
, XSTRING (file
)->data
);
174 munge_doc_file_name (name
);
176 fd
= emacs_open (name
, O_RDONLY
, 0);
180 error ("Cannot open doc string file \"%s\"", name
);
183 /* Seek only to beginning of disk block. */
184 offset
= position
% (8 * 1024);
185 if (0 > lseek (fd
, position
- offset
, 0))
188 error ("Position %ld out of range in doc string file \"%s\"",
192 /* Read the doc string into get_doc_string_buffer.
193 P points beyond the data just read. */
195 p
= get_doc_string_buffer
;
198 int space_left
= (get_doc_string_buffer_size
199 - (p
- get_doc_string_buffer
));
202 /* Allocate or grow the buffer if we need to. */
205 int in_buffer
= p
- get_doc_string_buffer
;
206 get_doc_string_buffer_size
+= 16 * 1024;
207 get_doc_string_buffer
208 = (char *) xrealloc (get_doc_string_buffer
,
209 get_doc_string_buffer_size
+ 1);
210 p
= get_doc_string_buffer
+ in_buffer
;
211 space_left
= (get_doc_string_buffer_size
212 - (p
- get_doc_string_buffer
));
215 /* Read a disk block at a time.
216 If we read the same block last time, maybe skip this? */
217 if (space_left
> 1024 * 8)
218 space_left
= 1024 * 8;
219 nread
= emacs_read (fd
, p
, space_left
);
223 error ("Read error on documentation file");
228 if (p
== get_doc_string_buffer
)
229 p1
= index (p
+ offset
, '\037');
231 p1
= index (p
, '\037');
242 /* Scan the text and perform quoting with ^A (char code 1).
243 ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_. */
244 from
= get_doc_string_buffer
+ offset
;
245 to
= get_doc_string_buffer
+ offset
;
261 error ("Invalid data in documentation file -- ^A followed by code 0%o", c
);
267 /* If DEFINITION, read from this buffer
268 the same way we would read bytes from a file. */
271 read_bytecode_pointer
= get_doc_string_buffer
+ offset
;
272 return Fread (Qlambda
);
276 return make_unibyte_string (get_doc_string_buffer
+ offset
,
277 to
- (get_doc_string_buffer
+ offset
));
280 /* Let the data determine whether the string is multibyte,
281 even if Emacs is running in --unibyte mode. */
282 int nchars
= multibyte_chars_in_text (get_doc_string_buffer
+ offset
,
283 to
- (get_doc_string_buffer
+ offset
));
284 return make_string_from_bytes (get_doc_string_buffer
+ offset
,
286 to
- (get_doc_string_buffer
+ offset
));
290 /* Get a string from position FILEPOS and pass it through the Lisp reader.
291 We use this for fetching the bytecode string and constants vector
292 of a compiled function from the .elc file. */
295 read_doc_string (filepos
)
298 return get_doc_string (filepos
, 0, 1);
301 DEFUN ("documentation", Fdocumentation
, Sdocumentation
, 1, 2, 0,
302 "Return the documentation string of FUNCTION.\n\
303 Unless a non-nil second argument RAW is given, the\n\
304 string is passed through `substitute-command-keys'.")
306 Lisp_Object function
, raw
;
310 Lisp_Object tem
, doc
;
312 fun
= Findirect_function (function
);
316 if (XSUBR (fun
)->doc
== 0) return Qnil
;
317 if ((EMACS_INT
) XSUBR (fun
)->doc
>= 0)
318 doc
= build_string (XSUBR (fun
)->doc
);
320 doc
= get_doc_string (make_number (- (EMACS_INT
) XSUBR (fun
)->doc
),
323 else if (COMPILEDP (fun
))
325 if ((XVECTOR (fun
)->size
& PSEUDOVECTOR_SIZE_MASK
) <= COMPILED_DOC_STRING
)
327 tem
= XVECTOR (fun
)->contents
[COMPILED_DOC_STRING
];
330 else if (NATNUMP (tem
) || CONSP (tem
))
331 doc
= get_doc_string (tem
, 0, 0);
335 else if (STRINGP (fun
) || VECTORP (fun
))
337 return build_string ("Keyboard macro.");
339 else if (CONSP (fun
))
342 if (!SYMBOLP (funcar
))
343 return Fsignal (Qinvalid_function
, Fcons (fun
, Qnil
));
344 else if (EQ (funcar
, Qkeymap
))
345 return build_string ("Prefix command (definition is a keymap associating keystrokes with commands).");
346 else if (EQ (funcar
, Qlambda
)
347 || EQ (funcar
, Qautoload
))
350 tem1
= Fcdr (Fcdr (fun
));
354 /* Handle a doc reference--but these never come last
355 in the function body, so reject them if they are last. */
356 else if ((NATNUMP (tem
) || CONSP (tem
))
357 && ! NILP (XCDR (tem1
)))
358 doc
= get_doc_string (tem
, 0, 0);
362 else if (EQ (funcar
, Qmocklisp
))
364 else if (EQ (funcar
, Qmacro
))
365 return Fdocumentation (Fcdr (fun
), raw
);
372 Fsignal (Qinvalid_function
, Fcons (fun
, Qnil
));
376 doc
= Fsubstitute_command_keys (doc
);
380 DEFUN ("documentation-property", Fdocumentation_property
, Sdocumentation_property
, 2, 3, 0,
381 "Return the documentation string that is SYMBOL's PROP property.\n\
382 This is like `get', but it can refer to strings stored in the\n\
383 `etc/DOC' file; and if the value is a string, it is passed through\n\
384 `substitute-command-keys'. A non-nil third argument RAW avoids this\n\
387 Lisp_Object symbol
, prop
, raw
;
391 tem
= Fget (symbol
, prop
);
393 tem
= get_doc_string (XINT (tem
) > 0 ? tem
: make_number (- XINT (tem
)), 0, 0);
394 else if (CONSP (tem
))
395 tem
= get_doc_string (tem
, 0, 0);
396 if (NILP (raw
) && STRINGP (tem
))
397 tem
= Fsubstitute_command_keys (tem
);
401 /* Scanning the DOC files and placing docstring offsets into functions. */
404 store_function_docstring (fun
, offset
)
406 /* Use EMACS_INT because we get this from pointer subtraction. */
409 fun
= indirect_function (fun
);
411 /* The type determines where the docstring is stored. */
413 /* Lisp_Subrs have a slot for it. */
415 XSUBR (fun
)->doc
= (char *) - offset
;
417 /* If it's a lisp form, stick it in the form. */
418 else if (CONSP (fun
))
423 if (EQ (tem
, Qlambda
) || EQ (tem
, Qautoload
))
425 tem
= Fcdr (Fcdr (fun
));
426 if (CONSP (tem
) && INTEGERP (XCAR (tem
)))
427 XSETFASTINT (XCAR (tem
), offset
);
429 else if (EQ (tem
, Qmacro
))
430 store_function_docstring (XCDR (fun
), offset
);
433 /* Bytecode objects sometimes have slots for it. */
434 else if (COMPILEDP (fun
))
436 /* This bytecode object must have a slot for the
437 docstring, since we've found a docstring for it. */
438 if ((XVECTOR (fun
)->size
& PSEUDOVECTOR_SIZE_MASK
) > COMPILED_DOC_STRING
)
439 XSETFASTINT (XVECTOR (fun
)->contents
[COMPILED_DOC_STRING
], offset
);
444 DEFUN ("Snarf-documentation", Fsnarf_documentation
, Ssnarf_documentation
,
446 "Used during Emacs initialization, before dumping runnable Emacs,\n\
447 to find pointers to doc strings stored in `etc/DOC...' and\n\
448 record them in function definitions.\n\
449 One arg, FILENAME, a string which does not include a directory.\n\
450 The file is found in `../etc' now; found in the `data-directory'\n\
451 when doc strings are referred to later in the dumped Emacs.")
453 Lisp_Object filename
;
459 register char *p
, *end
;
460 Lisp_Object sym
, fun
, tem
;
462 extern char *index ();
465 if (NILP (Vpurify_flag
))
466 error ("Snarf-documentation can only be called in an undumped Emacs");
469 CHECK_STRING (filename
, 0);
472 name
= (char *) alloca (XSTRING (filename
)->size
+ 14);
473 strcpy (name
, "../etc/");
474 #else /* CANNOT_DUMP */
475 CHECK_STRING (Vdoc_directory
, 0);
476 name
= (char *) alloca (XSTRING (filename
)->size
+
477 XSTRING (Vdoc_directory
)->size
+ 1);
478 strcpy (name
, XSTRING (Vdoc_directory
)->data
);
479 #endif /* CANNOT_DUMP */
480 strcat (name
, XSTRING (filename
)->data
); /*** Add this line ***/
483 /* For VMS versions with limited file name syntax,
484 convert the name to something VMS will allow. */
492 #endif /* not VMS4_4 */
494 strcpy (name
, sys_translate_unix (name
));
498 fd
= emacs_open (name
, O_RDONLY
, 0);
500 report_file_error ("Opening doc string file",
501 Fcons (build_string (name
), Qnil
));
502 Vdoc_file_name
= filename
;
508 filled
+= emacs_read (fd
, &buf
[filled
], sizeof buf
- 1 - filled
);
514 end
= buf
+ (filled
< 512 ? filled
: filled
- 128);
515 while (p
!= end
&& *p
!= '\037') p
++;
516 /* p points to ^_Ffunctionname\n or ^_Vvarname\n. */
519 end
= index (p
, '\n');
520 sym
= oblookup (Vobarray
, p
+ 2,
521 multibyte_chars_in_text (p
+ 2, end
- p
- 2),
525 /* Attach a docstring to a variable? */
528 /* Install file-position as variable-documentation property
529 and make it negative for a user-variable
530 (doc starts with a `*'). */
531 Fput (sym
, Qvariable_documentation
,
532 make_number ((pos
+ end
+ 1 - buf
)
533 * (end
[1] == '*' ? -1 : 1)));
536 /* Attach a docstring to a function? */
537 else if (p
[1] == 'F')
538 store_function_docstring (sym
, pos
+ end
+ 1 - buf
);
541 error ("DOC file invalid at position %d", pos
);
546 bcopy (end
, buf
, filled
);
552 DEFUN ("substitute-command-keys", Fsubstitute_command_keys
,
553 Ssubstitute_command_keys
, 1, 1, 0,
554 "Substitute key descriptions for command names in STRING.\n\
555 Return a new string which is STRING with substrings of the form \\=\\[COMMAND]\n\
556 replaced by either: a keystroke sequence that will invoke COMMAND,\n\
557 or \"M-x COMMAND\" if COMMAND is not on any keys.\n\
558 Substrings of the form \\=\\{MAPVAR} are replaced by summaries\n\
559 \(made by describe-bindings) of the value of MAPVAR, taken as a keymap.\n\
560 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR\n\
561 as the keymap for future \\=\\[COMMAND] substrings.\n\
562 \\=\\= quotes the following character and is discarded;\n\
563 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.")
569 register unsigned char *strp
;
570 register unsigned char *bufp
;
576 unsigned char *start
;
577 int length
, length_byte
;
579 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
586 CHECK_STRING (string
, 0);
590 GCPRO4 (string
, tem
, keymap
, name
);
592 multibyte
= STRING_MULTIBYTE (string
);
595 /* KEYMAP is either nil (which means search all the active keymaps)
596 or a specified local map (which means search just that and the
597 global map). If non-nil, it might come from Voverriding_local_map,
598 or from a \\<mapname> construct in STRING itself.. */
599 keymap
= current_kboard
->Voverriding_terminal_local_map
;
601 keymap
= Voverriding_local_map
;
603 bsize
= STRING_BYTES (XSTRING (string
));
604 bufp
= buf
= (unsigned char *) xmalloc (bsize
);
606 strp
= (unsigned char *) XSTRING (string
)->data
;
607 while (strp
< XSTRING (string
)->data
+ STRING_BYTES (XSTRING (string
)))
609 if (strp
[0] == '\\' && strp
[1] == '=')
611 /* \= quotes the next character;
612 thus, to put in \[ without its special meaning, use \=\[. */
618 int maxlen
= XSTRING (string
)->data
+ STRING_BYTES (XSTRING (string
)) - strp
;
620 STRING_CHAR_AND_LENGTH (strp
, maxlen
, len
);
624 bcopy (strp
, bufp
, len
);
630 *bufp
++ = *strp
++, nchars
++;
632 else if (strp
[0] == '\\' && strp
[1] == '[')
634 Lisp_Object firstkey
;
637 strp
+= 2; /* skip \[ */
640 while ((strp
- (unsigned char *) XSTRING (string
)->data
641 < STRING_BYTES (XSTRING (string
)))
644 length_byte
= strp
- start
;
648 /* Save STRP in IDX. */
649 idx
= strp
- (unsigned char *) XSTRING (string
)->data
;
650 tem
= Fintern (make_string (start
, length_byte
), Qnil
);
651 tem
= Fwhere_is_internal (tem
, keymap
, Qt
, Qnil
);
653 /* Disregard menu bar bindings; it is positively annoying to
654 mention them when there's no menu bar, and it isn't terribly
655 useful even when there is a menu bar. */
658 firstkey
= Faref (tem
, make_number (0));
659 if (EQ (firstkey
, Qmenu_bar
))
663 if (NILP (tem
)) /* but not on any keys */
665 new = (unsigned char *) xrealloc (buf
, bsize
+= 4);
668 bcopy ("M-x ", bufp
, 4);
672 length
= multibyte_chars_in_text (start
, length_byte
);
674 length
= length_byte
;
678 { /* function is on a key */
679 tem
= Fkey_description (tem
);
683 /* \{foo} is replaced with a summary of the keymap (symbol-value foo).
684 \<foo> just sets the keymap used for \[cmd]. */
685 else if (strp
[0] == '\\' && (strp
[1] == '{' || strp
[1] == '<'))
687 struct buffer
*oldbuf
;
690 strp
+= 2; /* skip \{ or \< */
693 while ((strp
- (unsigned char *) XSTRING (string
)->data
694 < XSTRING (string
)->size
)
695 && *strp
!= '}' && *strp
!= '>')
698 length_byte
= strp
- start
;
699 strp
++; /* skip } or > */
701 /* Save STRP in IDX. */
702 idx
= strp
- (unsigned char *) XSTRING (string
)->data
;
704 /* Get the value of the keymap in TEM, or nil if undefined.
705 Do this while still in the user's current buffer
706 in case it is a local variable. */
707 name
= Fintern (make_string (start
, length_byte
), Qnil
);
708 tem
= Fboundp (name
);
711 tem
= Fsymbol_value (name
);
713 tem
= get_keymap_1 (tem
, 0, 1);
716 /* Now switch to a temp buffer. */
717 oldbuf
= current_buffer
;
718 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
722 name
= Fsymbol_name (name
);
723 insert_string ("\nUses keymap \"");
724 insert_from_string (name
, 0, 0,
725 XSTRING (name
)->size
,
726 STRING_BYTES (XSTRING (name
)), 1);
727 insert_string ("\", which is not currently defined.\n");
728 if (start
[-1] == '<') keymap
= Qnil
;
730 else if (start
[-1] == '<')
733 describe_map_tree (tem
, 1, Qnil
, Qnil
, (char *)0, 1, 0, 0);
734 tem
= Fbuffer_string ();
736 set_buffer_internal (oldbuf
);
739 start
= XSTRING (tem
)->data
;
740 length
= XSTRING (tem
)->size
;
741 length_byte
= STRING_BYTES (XSTRING (tem
));
743 new = (unsigned char *) xrealloc (buf
, bsize
+= length_byte
);
746 bcopy (start
, bufp
, length_byte
);
749 /* Check STRING again in case gc relocated it. */
750 strp
= (unsigned char *) XSTRING (string
)->data
+ idx
;
752 else if (! multibyte
) /* just copy other chars */
753 *bufp
++ = *strp
++, nchars
++;
757 int maxlen
= XSTRING (string
)->data
+ STRING_BYTES (XSTRING (string
)) - strp
;
759 STRING_CHAR_AND_LENGTH (strp
, maxlen
, len
);
763 bcopy (strp
, bufp
, len
);
770 if (changed
) /* don't bother if nothing substituted */
771 tem
= make_string_from_bytes (buf
, nchars
, bufp
- buf
);
775 RETURN_UNGCPRO (tem
);
781 DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name
,
782 "Name of file containing documentation strings of built-in symbols.");
783 Vdoc_file_name
= Qnil
;
785 defsubr (&Sdocumentation
);
786 defsubr (&Sdocumentation_property
);
787 defsubr (&Ssnarf_documentation
);
788 defsubr (&Ssubstitute_command_keys
);