1 /* Record indices of function doc strings stored in a file. -*- coding: utf-8 -*-
3 Copyright (C) 1985-1986, 1993-1995, 1997-2016 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
25 #include <sys/types.h>
26 #include <sys/file.h> /* Must be after sys/types.h for USG. */
33 #include "character.h"
39 /* Buffer used for reading from documentation file. */
40 static char *get_doc_string_buffer
;
41 static ptrdiff_t get_doc_string_buffer_size
;
43 static unsigned char *read_bytecode_pointer
;
45 static char const sibling_etc
[] = "../etc/";
47 /* `readchar' in lread.c calls back here to fetch the next byte.
48 If UNREADFLAG is 1, we unread a byte. */
51 read_bytecode_char (bool unreadflag
)
55 read_bytecode_pointer
--;
58 return *read_bytecode_pointer
++;
61 /* Extract a doc string from a file. FILEPOS says where to get it.
62 If it is an integer, use that position in the standard DOC file.
63 If it is (FILE . INTEGER), use FILE as the file name
64 and INTEGER as the position in that file.
65 But if INTEGER is negative, make it positive.
66 (A negative integer is used for user variables, so we can distinguish
67 them without actually fetching the doc string.)
69 If the location does not point to the beginning of a docstring
70 (e.g. because the file has been modified and the location is stale),
73 If UNIBYTE, always make a unibyte string.
75 If DEFINITION, assume this is for reading
76 a dynamic function definition; convert the bytestring
77 and the constants vector with appropriate byte handling,
78 and return a cons cell. */
81 get_doc_string (Lisp_Object filepos
, bool unibyte
, bool definition
)
83 char *from
, *to
, *name
, *p
, *p1
;
87 Lisp_Object file
, tem
, pos
;
91 if (INTEGERP (filepos
))
93 file
= Vdoc_file_name
;
96 else if (CONSP (filepos
))
98 file
= XCAR (filepos
);
104 position
= eabs (XINT (pos
));
106 if (!STRINGP (Vdoc_directory
))
112 /* Put the file name in NAME as a C string.
113 If it is relative, combine it with Vdoc_directory. */
115 tem
= Ffile_name_absolute_p (file
);
116 file
= ENCODE_FILE (file
);
118 = NILP (tem
) ? ENCODE_FILE (Vdoc_directory
) : empty_unibyte_string
;
119 ptrdiff_t docdir_sizemax
= SBYTES (docdir
) + 1;
121 docdir_sizemax
= max (docdir_sizemax
, sizeof sibling_etc
);
123 name
= SAFE_ALLOCA (docdir_sizemax
+ SBYTES (file
));
124 lispstpcpy (lispstpcpy (name
, docdir
), file
);
126 fd
= emacs_open (name
, O_RDONLY
, 0);
130 if (!NILP (Vpurify_flag
))
132 /* Preparing to dump; DOC file is probably not installed.
133 So check in ../etc. */
134 lispstpcpy (stpcpy (name
, sibling_etc
), file
);
136 fd
= emacs_open (name
, O_RDONLY
, 0);
141 if (errno
== EMFILE
|| errno
== ENFILE
)
142 report_file_error ("Read error on documentation file", file
);
145 AUTO_STRING (cannot_open
, "Cannot open doc string file \"");
146 AUTO_STRING (quote_nl
, "\"\n");
147 return concat3 (cannot_open
, file
, quote_nl
);
150 count
= SPECPDL_INDEX ();
151 record_unwind_protect_int (close_file_unwind
, fd
);
153 /* Seek only to beginning of disk block. */
154 /* Make sure we read at least 1024 bytes before `position'
155 so we can check the leading text for consistency. */
156 offset
= min (position
, max (1024, position
% (8 * 1024)));
157 if (TYPE_MAXIMUM (off_t
) < position
158 || lseek (fd
, position
- offset
, 0) < 0)
159 error ("Position %"pI
"d out of range in doc string file \"%s\"",
162 /* Read the doc string into get_doc_string_buffer.
163 P points beyond the data just read. */
165 p
= get_doc_string_buffer
;
168 ptrdiff_t space_left
= (get_doc_string_buffer_size
- 1
169 - (p
- get_doc_string_buffer
));
172 /* Allocate or grow the buffer if we need to. */
175 ptrdiff_t in_buffer
= p
- get_doc_string_buffer
;
176 get_doc_string_buffer
177 = xpalloc (get_doc_string_buffer
, &get_doc_string_buffer_size
,
179 p
= get_doc_string_buffer
+ in_buffer
;
180 space_left
= (get_doc_string_buffer_size
- 1
181 - (p
- get_doc_string_buffer
));
184 /* Read a disk block at a time.
185 If we read the same block last time, maybe skip this? */
186 if (space_left
> 1024 * 8)
187 space_left
= 1024 * 8;
188 nread
= emacs_read (fd
, p
, space_left
);
190 report_file_error ("Read error on documentation file", file
);
194 if (p
== get_doc_string_buffer
)
195 p1
= strchr (p
+ offset
, '\037');
197 p1
= strchr (p
, '\037');
206 unbind_to (count
, Qnil
);
209 /* Sanity checking. */
213 /* A dynamic docstring should be either at the very beginning of a "#@
214 comment" or right after a dynamic docstring delimiter (in case we
215 pack several such docstrings within the same comment). */
216 if (get_doc_string_buffer
[offset
- test
] != '\037')
218 if (get_doc_string_buffer
[offset
- test
++] != ' ')
220 while (get_doc_string_buffer
[offset
- test
] >= '0'
221 && get_doc_string_buffer
[offset
- test
] <= '9')
223 if (get_doc_string_buffer
[offset
- test
++] != '@'
224 || get_doc_string_buffer
[offset
- test
] != '#')
231 if (get_doc_string_buffer
[offset
- test
++] != '\n')
233 while (get_doc_string_buffer
[offset
- test
] > ' ')
235 if (get_doc_string_buffer
[offset
- test
] != '\037')
239 /* Scan the text and perform quoting with ^A (char code 1).
240 ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_. */
241 from
= get_doc_string_buffer
+ offset
;
242 to
= get_doc_string_buffer
+ offset
;
259 unsigned char uc
= c
;
261 Invalid data in documentation file -- %c followed by code %03o",
269 /* If DEFINITION, read from this buffer
270 the same way we would read bytes from a file. */
273 read_bytecode_pointer
= (unsigned char *) get_doc_string_buffer
+ offset
;
274 return Fread (Qlambda
);
278 return make_unibyte_string (get_doc_string_buffer
+ offset
,
279 to
- (get_doc_string_buffer
+ offset
));
282 /* The data determines whether the string is multibyte. */
284 = multibyte_chars_in_text (((unsigned char *) get_doc_string_buffer
286 to
- (get_doc_string_buffer
+ offset
));
287 return make_string_from_bytes (get_doc_string_buffer
+ offset
,
289 to
- (get_doc_string_buffer
+ offset
));
293 /* Get a string from position FILEPOS and pass it through the Lisp reader.
294 We use this for fetching the bytecode string and constants vector
295 of a compiled function from the .elc file. */
298 read_doc_string (Lisp_Object filepos
)
300 return get_doc_string (filepos
, 0, 1);
304 reread_doc_file (Lisp_Object file
)
307 Fsnarf_documentation (Vdoc_file_name
);
309 Fload (file
, Qt
, Qt
, Qt
, Qnil
);
314 DEFUN ("documentation", Fdocumentation
, Sdocumentation
, 1, 2, 0,
315 doc
: /* Return the documentation string of FUNCTION.
316 Unless a non-nil second argument RAW is given, the
317 string is passed through `substitute-command-keys'. */)
318 (Lisp_Object function
, Lisp_Object raw
)
329 if (SYMBOLP (function
))
331 Lisp_Object tem
= Fget (function
, Qfunction_documentation
);
333 return Fdocumentation_property (function
, Qfunction_documentation
,
337 fun
= Findirect_function (function
, Qnil
);
338 if (CONSP (fun
) && EQ (XCAR (fun
), Qmacro
))
342 if (XSUBR (fun
)->doc
== 0)
344 /* FIXME: This is not portable, as it assumes that string
345 pointers have the top bit clear. */
346 else if ((intptr_t) XSUBR (fun
)->doc
>= 0)
347 doc
= build_string (XSUBR (fun
)->doc
);
349 doc
= make_number ((intptr_t) XSUBR (fun
)->doc
);
351 else if (COMPILEDP (fun
))
353 if ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) <= COMPILED_DOC_STRING
)
357 Lisp_Object tem
= AREF (fun
, COMPILED_DOC_STRING
);
360 else if (NATNUMP (tem
) || CONSP (tem
))
366 else if (STRINGP (fun
) || VECTORP (fun
))
368 return build_string ("Keyboard macro.");
370 else if (CONSP (fun
))
373 if (!SYMBOLP (funcar
))
374 xsignal1 (Qinvalid_function
, fun
);
375 else if (EQ (funcar
, Qkeymap
))
376 return build_string ("Prefix command (definition is a keymap associating keystrokes with commands).");
377 else if (EQ (funcar
, Qlambda
)
378 || (EQ (funcar
, Qclosure
) && (fun
= XCDR (fun
), 1))
379 || EQ (funcar
, Qautoload
))
381 Lisp_Object tem1
= Fcdr (Fcdr (fun
));
382 Lisp_Object tem
= Fcar (tem1
);
385 /* Handle a doc reference--but these never come last
386 in the function body, so reject them if they are last. */
387 else if ((NATNUMP (tem
) || (CONSP (tem
) && INTEGERP (XCDR (tem
))))
388 && !NILP (XCDR (tem1
)))
399 xsignal1 (Qinvalid_function
, fun
);
402 /* If DOC is 0, it's typically because of a dumped file missing
403 from the DOC file (bug in src/Makefile.in). */
404 if (EQ (doc
, make_number (0)))
406 if (INTEGERP (doc
) || CONSP (doc
))
409 tem
= get_doc_string (doc
, 0, 0);
410 if (NILP (tem
) && try_reload
)
412 /* The file is newer, we need to reset the pointers. */
413 try_reload
= reread_doc_file (Fcar_safe (doc
));
425 doc
= Fsubstitute_command_keys (doc
);
429 DEFUN ("documentation-property", Fdocumentation_property
,
430 Sdocumentation_property
, 2, 3, 0,
431 doc
: /* Return the documentation string that is SYMBOL's PROP property.
432 Third argument RAW omitted or nil means pass the result through
433 `substitute-command-keys' if it is a string.
435 This differs from `get' in that it can refer to strings stored in the
436 `etc/DOC' file; and that it evaluates documentation properties that
438 (Lisp_Object symbol
, Lisp_Object prop
, Lisp_Object raw
)
443 documentation_property
:
445 tem
= Fget (symbol
, prop
);
446 if (EQ (tem
, make_number (0)))
448 if (INTEGERP (tem
) || (CONSP (tem
) && INTEGERP (XCDR (tem
))))
450 Lisp_Object doc
= tem
;
451 tem
= get_doc_string (tem
, 0, 0);
452 if (NILP (tem
) && try_reload
)
454 /* The file is newer, we need to reset the pointers. */
455 try_reload
= reread_doc_file (Fcar_safe (doc
));
459 goto documentation_property
;
463 else if (!STRINGP (tem
))
464 /* Feval protects its argument. */
465 tem
= Feval (tem
, Qnil
);
467 if (NILP (raw
) && STRINGP (tem
))
468 tem
= Fsubstitute_command_keys (tem
);
472 /* Scanning the DOC files and placing docstring offsets into functions. */
475 store_function_docstring (Lisp_Object obj
, ptrdiff_t offset
)
477 /* Don't use indirect_function here, or defaliases will apply their
478 docstrings to the base functions (Bug#2603). */
479 Lisp_Object fun
= SYMBOLP (obj
) ? XSYMBOL (obj
)->function
: obj
;
481 /* The type determines where the docstring is stored. */
483 /* Lisp_Subrs have a slot for it. */
486 intptr_t negative_offset
= - offset
;
487 XSUBR (fun
)->doc
= (char *) negative_offset
;
490 /* If it's a lisp form, stick it in the form. */
491 else if (CONSP (fun
))
496 if (EQ (tem
, Qlambda
) || EQ (tem
, Qautoload
)
497 || (EQ (tem
, Qclosure
) && (fun
= XCDR (fun
), 1)))
499 tem
= Fcdr (Fcdr (fun
));
500 if (CONSP (tem
) && INTEGERP (XCAR (tem
)))
501 /* FIXME: This modifies typically pure hash-cons'd data, so its
502 correctness is quite delicate. */
503 XSETCAR (tem
, make_number (offset
));
505 else if (EQ (tem
, Qmacro
))
506 store_function_docstring (XCDR (fun
), offset
);
509 /* Bytecode objects sometimes have slots for it. */
510 else if (COMPILEDP (fun
))
512 /* This bytecode object must have a slot for the
513 docstring, since we've found a docstring for it. */
514 if ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_DOC_STRING
)
515 ASET (fun
, COMPILED_DOC_STRING
, make_number (offset
));
518 AUTO_STRING (format
, "No docstring slot for %s");
519 CALLN (Fmessage
, format
,
522 : build_string ("<anonymous>")));
528 DEFUN ("Snarf-documentation", Fsnarf_documentation
, Ssnarf_documentation
,
530 doc
: /* Used during Emacs initialization to scan the `etc/DOC...' file.
531 This searches the `etc/DOC...' file for doc strings and
532 records them in function and variable definitions.
533 The function takes one argument, FILENAME, a string;
534 it specifies the file name (without a directory) of the DOC file.
535 That file is found in `../etc' now; later, when the dumped Emacs is run,
536 the same file name is found in the `doc-directory'. */)
537 (Lisp_Object filename
)
549 /* Preloaded defcustoms using custom-initialize-delay are added to
550 this list, but kept unbound. See http://debbugs.gnu.org/11565 */
551 Lisp_Object delayed_init
=
552 find_symbol_value (intern ("custom-delayed-init-variables"));
554 if (EQ (delayed_init
, Qunbound
)) delayed_init
= Qnil
;
556 CHECK_STRING (filename
);
560 (!NILP (Vpurify_flag
))
561 #else /* CANNOT_DUMP */
563 #endif /* CANNOT_DUMP */
565 dirname
= sibling_etc
;
566 dirlen
= sizeof sibling_etc
- 1;
570 CHECK_STRING (Vdoc_directory
);
571 dirname
= SSDATA (Vdoc_directory
);
572 dirlen
= SBYTES (Vdoc_directory
);
575 count
= SPECPDL_INDEX ();
577 name
= SAFE_ALLOCA (dirlen
+ SBYTES (filename
) + 1);
578 lispstpcpy (stpcpy (name
, dirname
), filename
); /*** Add this line ***/
580 /* Vbuild_files is nil when temacs is run, and non-nil after that. */
581 if (NILP (Vbuild_files
))
583 static char const *const buildobj
[] =
585 #include "buildobj.h"
587 int i
= ARRAYELTS (buildobj
);
589 Vbuild_files
= Fcons (build_string (buildobj
[i
]), Vbuild_files
);
590 Vbuild_files
= Fpurecopy (Vbuild_files
);
593 fd
= emacs_open (name
, O_RDONLY
, 0);
596 int open_errno
= errno
;
597 report_file_errno ("Opening doc string file", build_string (name
),
600 record_unwind_protect_int (close_file_unwind
, fd
);
601 Vdoc_file_name
= filename
;
608 filled
+= emacs_read (fd
, &buf
[filled
], sizeof buf
- 1 - filled
);
613 end
= buf
+ (filled
< 512 ? filled
: filled
- 128);
614 p
= memchr (buf
, '\037', end
- buf
);
615 /* p points to ^_Ffunctionname\n or ^_Vvarname\n or ^_Sfilename\n. */
618 end
= strchr (p
, '\n');
620 /* See if this is a file name, and if it is a file in build-files. */
624 if (end
- p
> 4 && end
[-2] == '.'
625 && (end
[-1] == 'o' || end
[-1] == 'c'))
627 ptrdiff_t len
= end
- p
- 2;
628 char *fromfile
= SAFE_ALLOCA (len
+ 1);
629 memcpy (fromfile
, &p
[2], len
);
631 if (fromfile
[len
-1] == 'c')
632 fromfile
[len
-1] = 'o';
634 skip_file
= NILP (Fmember (build_string (fromfile
),
639 sym
= oblookup (Vobarray
, p
+ 2,
640 multibyte_chars_in_text ((unsigned char *) p
+ 2,
643 /* Check skip_file so that when a function is defined several
644 times in different files (typically, once in xterm, once in
645 w32term, ...), we only pay attention to the one that
647 if (! skip_file
&& SYMBOLP (sym
))
649 /* Attach a docstring to a variable? */
652 /* Install file-position as variable-documentation property
653 and make it negative for a user-variable
654 (doc starts with a `*'). */
655 if (!NILP (Fboundp (sym
))
656 || !NILP (Fmemq (sym
, delayed_init
)))
657 Fput (sym
, Qvariable_documentation
,
658 make_number ((pos
+ end
+ 1 - buf
)
659 * (end
[1] == '*' ? -1 : 1)));
662 /* Attach a docstring to a function? */
663 else if (p
[1] == 'F')
665 if (!NILP (Ffboundp (sym
)))
666 store_function_docstring (sym
, pos
+ end
+ 1 - buf
);
668 else if (p
[1] == 'S')
669 ; /* Just a source file name boundary marker. Ignore it. */
672 error ("DOC file invalid at position %"pI
"d", pos
);
677 memmove (buf
, end
, filled
);
681 return unbind_to (count
, Qnil
);
684 /* Return true if text quoting style should default to quote `like this'. */
686 default_to_grave_quoting_style (void)
688 if (!text_quoting_flag
)
690 if (! DISP_TABLE_P (Vstandard_display_table
))
692 Lisp_Object dv
= DISP_CHAR_VECTOR (XCHAR_TABLE (Vstandard_display_table
),
693 LEFT_SINGLE_QUOTATION_MARK
);
694 return (VECTORP (dv
) && ASIZE (dv
) == 1
695 && EQ (AREF (dv
, 0), make_number ('`')));
698 /* Return the current effective text quoting style. */
699 enum text_quoting_style
700 text_quoting_style (void)
702 if (NILP (Vtext_quoting_style
)
703 ? default_to_grave_quoting_style ()
704 : EQ (Vtext_quoting_style
, Qgrave
))
705 return GRAVE_QUOTING_STYLE
;
706 else if (EQ (Vtext_quoting_style
, Qstraight
))
707 return STRAIGHT_QUOTING_STYLE
;
709 return CURVE_QUOTING_STYLE
;
712 DEFUN ("substitute-command-keys", Fsubstitute_command_keys
,
713 Ssubstitute_command_keys
, 1, 1, 0,
714 doc
: /* Substitute key descriptions for command names in STRING.
715 Each substring of the form \\=\\[COMMAND] is replaced by either a
716 keystroke sequence that invokes COMMAND, or "M-x COMMAND" if COMMAND
719 Each substring of the form \\=\\{MAPVAR} is replaced by a summary of
720 the value of MAPVAR as a keymap. This summary is similar to the one
721 produced by `describe-bindings'. The summary ends in two newlines
722 \(used by the helper function `help-make-xrefs' to find the end of the
725 Each substring of the form \\=\\<MAPVAR> specifies the use of MAPVAR
726 as the keymap for future \\=\\[COMMAND] substrings.
728 Each \\=‘ and \\=` is replaced by left quote, and each \\=’ and \\='
729 is replaced by right quote. Left and right quote characters are
730 specified by `text-quoting-style'.
732 \\=\\= quotes the following character and is discarded; thus,
733 \\=\\=\\=\\= puts \\=\\= into the output, \\=\\=\\=\\[ puts \\=\\[ into the output, and
734 \\=\\=\\=` puts \\=` into the output.
736 Return the original STRING if no substitutions are made.
737 Otherwise, return a new string. */)
741 bool changed
= false;
748 unsigned char const *start
;
749 ptrdiff_t length
, length_byte
;
757 CHECK_STRING (string
);
762 enum text_quoting_style quoting_style
= text_quoting_style ();
764 multibyte
= STRING_MULTIBYTE (string
);
767 /* KEYMAP is either nil (which means search all the active keymaps)
768 or a specified local map (which means search just that and the
769 global map). If non-nil, it might come from Voverriding_local_map,
770 or from a \\<mapname> construct in STRING itself.. */
771 keymap
= Voverriding_local_map
;
773 bsize
= SBYTES (string
);
775 /* Add some room for expansion due to quote replacement. */
776 enum { EXTRA_ROOM
= 20 };
777 if (bsize
<= STRING_BYTES_BOUND
- EXTRA_ROOM
)
780 bufp
= buf
= xmalloc (bsize
);
782 strp
= SDATA (string
);
783 while (strp
< SDATA (string
) + SBYTES (string
))
785 if (strp
[0] == '\\' && strp
[1] == '=')
787 /* \= quotes the next character;
788 thus, to put in \[ without its special meaning, use \=\[. */
795 STRING_CHAR_AND_LENGTH (strp
, len
);
799 memcpy (bufp
, strp
, len
);
805 *bufp
++ = *strp
++, nchars
++;
807 else if (strp
[0] == '\\' && strp
[1] == '[')
810 bool follow_remap
= 1;
812 strp
+= 2; /* skip \[ */
814 start_idx
= start
- SDATA (string
);
816 while ((strp
- SDATA (string
)
820 length_byte
= strp
- start
;
824 /* Save STRP in IDX. */
825 idx
= strp
- SDATA (string
);
826 name
= Fintern (make_string ((char *) start
, length_byte
), Qnil
);
829 tem
= Fwhere_is_internal (name
, keymap
, Qt
, Qnil
, Qnil
);
831 if (VECTORP (tem
) && ASIZE (tem
) > 1
832 && EQ (AREF (tem
, 0), Qremap
) && SYMBOLP (AREF (tem
, 1))
835 name
= AREF (tem
, 1);
840 /* Note the Fwhere_is_internal can GC, so we have to take
841 relocation of string contents into account. */
842 strp
= SDATA (string
) + idx
;
843 start
= SDATA (string
) + start_idx
;
845 if (NILP (tem
)) /* but not on any keys */
847 ptrdiff_t offset
= bufp
- buf
;
848 if (STRING_BYTES_BOUND
- 4 < bsize
)
850 buf
= xrealloc (buf
, bsize
+= 4);
852 memcpy (bufp
, "M-x ", 4);
856 length
= multibyte_chars_in_text (start
, length_byte
);
858 length
= length_byte
;
862 { /* function is on a key */
863 tem
= Fkey_description (tem
, Qnil
);
867 /* \{foo} is replaced with a summary of the keymap (symbol-value foo).
868 \<foo> just sets the keymap used for \[cmd]. */
869 else if (strp
[0] == '\\' && (strp
[1] == '{' || strp
[1] == '<'))
871 struct buffer
*oldbuf
;
873 /* This is for computing the SHADOWS arg for describe_map_tree. */
874 Lisp_Object active_maps
= Fcurrent_active_maps (Qnil
, Qnil
);
875 Lisp_Object earlier_maps
;
876 ptrdiff_t count
= SPECPDL_INDEX ();
878 strp
+= 2; /* skip \{ or \< */
880 start_idx
= start
- SDATA (string
);
882 while ((strp
- SDATA (string
) < SBYTES (string
))
883 && *strp
!= '}' && *strp
!= '>')
886 length_byte
= strp
- start
;
887 strp
++; /* skip } or > */
889 /* Save STRP in IDX. */
890 idx
= strp
- SDATA (string
);
892 /* Get the value of the keymap in TEM, or nil if undefined.
893 Do this while still in the user's current buffer
894 in case it is a local variable. */
895 name
= Fintern (make_string ((char *) start
, length_byte
), Qnil
);
896 tem
= Fboundp (name
);
899 tem
= Fsymbol_value (name
);
902 tem
= get_keymap (tem
, 0, 1);
903 /* Note that get_keymap can GC. */
904 strp
= SDATA (string
) + idx
;
905 start
= SDATA (string
) + start_idx
;
909 /* Now switch to a temp buffer. */
910 oldbuf
= current_buffer
;
911 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
912 /* This is for an unusual case where some after-change
913 function uses 'format' or 'prin1' or something else that
914 will thrash Vprin1_to_string_buffer we are using. */
915 specbind (Qinhibit_modification_hooks
, Qt
);
919 name
= Fsymbol_name (name
);
920 AUTO_STRING (msg_prefix
, "\nUses keymap `");
921 insert1 (Fsubstitute_command_keys (msg_prefix
));
922 insert_from_string (name
, 0, 0,
925 AUTO_STRING (msg_suffix
, "', which is not currently defined.\n");
926 insert1 (Fsubstitute_command_keys (msg_suffix
));
927 if (start
[-1] == '<') keymap
= Qnil
;
929 else if (start
[-1] == '<')
933 /* Get the list of active keymaps that precede this one.
934 If this one's not active, get nil. */
935 earlier_maps
= Fcdr (Fmemq (tem
, Freverse (active_maps
)));
936 describe_map_tree (tem
, 1, Fnreverse (earlier_maps
),
937 Qnil
, 0, 1, 0, 0, 1);
939 tem
= Fbuffer_string ();
941 set_buffer_internal (oldbuf
);
942 unbind_to (count
, Qnil
);
946 length
= SCHARS (tem
);
947 length_byte
= SBYTES (tem
);
951 ptrdiff_t offset
= bufp
- buf
;
952 if (STRING_BYTES_BOUND
- length_byte
< bsize
)
954 buf
= xrealloc (buf
, bsize
+= length_byte
);
956 memcpy (bufp
, start
, length_byte
);
959 /* Check STRING again in case gc relocated it. */
960 strp
= SDATA (string
) + idx
;
963 else if ((strp
[0] == '`' || strp
[0] == '\'')
964 && quoting_style
== CURVE_QUOTING_STYLE
)
966 start
= (unsigned char const *) (strp
[0] == '`' ? uLSQM
: uRSQM
);
968 length_byte
= sizeof uLSQM
- 1;
969 idx
= strp
- SDATA (string
) + 1;
972 else if (strp
[0] == '`' && quoting_style
== STRAIGHT_QUOTING_STYLE
)
979 else if (! multibyte
)
980 *bufp
++ = *strp
++, nchars
++;
984 int ch
= STRING_CHAR_AND_LENGTH (strp
, len
);
985 if ((ch
== LEFT_SINGLE_QUOTATION_MARK
986 || ch
== RIGHT_SINGLE_QUOTATION_MARK
)
987 && quoting_style
!= CURVE_QUOTING_STYLE
)
989 *bufp
++ = ((ch
== LEFT_SINGLE_QUOTATION_MARK
990 && quoting_style
== GRAVE_QUOTING_STYLE
)
1005 if (changed
) /* don't bother if nothing substituted */
1006 tem
= make_string_from_bytes (buf
, nchars
, bufp
- buf
);
1016 DEFSYM (Qfunction_documentation
, "function-documentation");
1017 DEFSYM (Qgrave
, "grave");
1018 DEFSYM (Qstraight
, "straight");
1020 DEFVAR_LISP ("internal-doc-file-name", Vdoc_file_name
,
1021 doc
: /* Name of file containing documentation strings of built-in symbols. */);
1022 Vdoc_file_name
= Qnil
;
1024 DEFVAR_LISP ("build-files", Vbuild_files
,
1025 doc
: /* A list of files used to build this Emacs binary. */);
1026 Vbuild_files
= Qnil
;
1028 DEFVAR_LISP ("text-quoting-style", Vtext_quoting_style
,
1029 doc
: /* Style to use for single quotes in help and messages.
1030 Its value should be a symbol.
1031 `curve' means quote with curved single quotes \\=‘like this\\=’.
1032 `straight' means quote with straight apostrophes \\='like this\\='.
1033 `grave' means quote with grave accent and apostrophe \\=`like this\\='.
1034 The default value nil acts like `curve' if curved single quotes are
1035 displayable, and like `grave' otherwise. */);
1036 Vtext_quoting_style
= Qnil
;
1038 DEFVAR_BOOL ("internal--text-quoting-flag", text_quoting_flag
,
1039 doc
: /* If nil, a nil `text-quoting-style' is treated as `grave'. */);
1040 /* Initialized by ‘main’. */
1042 defsubr (&Sdocumentation
);
1043 defsubr (&Sdocumentation_property
);
1044 defsubr (&Ssnarf_documentation
);
1045 defsubr (&Ssubstitute_command_keys
);