1 /* Record indices of function doc strings stored in a file. -*- coding: utf-8 -*-
3 Copyright (C) 1985-1986, 1993-1995, 1997-2017 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"
37 #include "intervals.h"
40 /* Buffer used for reading from documentation file. */
41 static char *get_doc_string_buffer
;
42 static ptrdiff_t get_doc_string_buffer_size
;
44 static unsigned char *read_bytecode_pointer
;
46 static char const sibling_etc
[] = "../etc/";
48 /* `readchar' in lread.c calls back here to fetch the next byte.
49 If UNREADFLAG is 1, we unread a byte. */
52 read_bytecode_char (bool unreadflag
)
56 read_bytecode_pointer
--;
59 return *read_bytecode_pointer
++;
62 /* Extract a doc string from a file. FILEPOS says where to get it.
63 If it is an integer, use that position in the standard DOC file.
64 If it is (FILE . INTEGER), use FILE as the file name
65 and INTEGER as the position in that file.
66 But if INTEGER is negative, make it positive.
67 (A negative integer is used for user variables, so we can distinguish
68 them without actually fetching the doc string.)
70 If the location does not point to the beginning of a docstring
71 (e.g. because the file has been modified and the location is stale),
74 If UNIBYTE, always make a unibyte string.
76 If DEFINITION, assume this is for reading
77 a dynamic function definition; convert the bytestring
78 and the constants vector with appropriate byte handling,
79 and return a cons cell. */
82 get_doc_string (Lisp_Object filepos
, bool unibyte
, bool definition
)
84 char *from
, *to
, *name
, *p
, *p1
;
88 Lisp_Object file
, tem
, pos
;
92 if (INTEGERP (filepos
))
94 file
= Vdoc_file_name
;
97 else if (CONSP (filepos
))
99 file
= XCAR (filepos
);
100 pos
= XCDR (filepos
);
105 position
= eabs (XINT (pos
));
107 if (!STRINGP (Vdoc_directory
))
113 /* Put the file name in NAME as a C string.
114 If it is relative, combine it with Vdoc_directory. */
116 tem
= Ffile_name_absolute_p (file
);
117 file
= ENCODE_FILE (file
);
119 = NILP (tem
) ? ENCODE_FILE (Vdoc_directory
) : empty_unibyte_string
;
120 ptrdiff_t docdir_sizemax
= SBYTES (docdir
) + 1;
122 docdir_sizemax
= max (docdir_sizemax
, sizeof sibling_etc
);
124 name
= SAFE_ALLOCA (docdir_sizemax
+ SBYTES (file
));
125 lispstpcpy (lispstpcpy (name
, docdir
), file
);
127 fd
= emacs_open (name
, O_RDONLY
, 0);
131 if (!NILP (Vpurify_flag
))
133 /* Preparing to dump; DOC file is probably not installed.
134 So check in ../etc. */
135 lispstpcpy (stpcpy (name
, sibling_etc
), file
);
137 fd
= emacs_open (name
, O_RDONLY
, 0);
142 if (errno
== EMFILE
|| errno
== ENFILE
)
143 report_file_error ("Read error on documentation file", file
);
146 AUTO_STRING (cannot_open
, "Cannot open doc string file \"");
147 AUTO_STRING (quote_nl
, "\"\n");
148 return concat3 (cannot_open
, file
, quote_nl
);
151 count
= SPECPDL_INDEX ();
152 record_unwind_protect_int (close_file_unwind
, fd
);
154 /* Seek only to beginning of disk block. */
155 /* Make sure we read at least 1024 bytes before `position'
156 so we can check the leading text for consistency. */
157 offset
= min (position
, max (1024, position
% (8 * 1024)));
158 if (TYPE_MAXIMUM (off_t
) < position
159 || lseek (fd
, position
- offset
, 0) < 0)
160 error ("Position %"pI
"d out of range in doc string file \"%s\"",
163 /* Read the doc string into get_doc_string_buffer.
164 P points beyond the data just read. */
166 p
= get_doc_string_buffer
;
169 ptrdiff_t space_left
= (get_doc_string_buffer_size
- 1
170 - (p
- get_doc_string_buffer
));
173 /* Allocate or grow the buffer if we need to. */
176 ptrdiff_t in_buffer
= p
- get_doc_string_buffer
;
177 get_doc_string_buffer
178 = xpalloc (get_doc_string_buffer
, &get_doc_string_buffer_size
,
180 p
= get_doc_string_buffer
+ in_buffer
;
181 space_left
= (get_doc_string_buffer_size
- 1
182 - (p
- get_doc_string_buffer
));
185 /* Read a disk block at a time.
186 If we read the same block last time, maybe skip this? */
187 if (space_left
> 1024 * 8)
188 space_left
= 1024 * 8;
189 nread
= emacs_read_quit (fd
, p
, space_left
);
191 report_file_error ("Read error on documentation file", file
);
195 if (p
== get_doc_string_buffer
)
196 p1
= strchr (p
+ offset
, '\037');
198 p1
= strchr (p
, '\037');
207 unbind_to (count
, Qnil
);
210 /* Sanity checking. */
214 /* A dynamic docstring should be either at the very beginning of a "#@
215 comment" or right after a dynamic docstring delimiter (in case we
216 pack several such docstrings within the same comment). */
217 if (get_doc_string_buffer
[offset
- test
] != '\037')
219 if (get_doc_string_buffer
[offset
- test
++] != ' ')
221 while (get_doc_string_buffer
[offset
- test
] >= '0'
222 && get_doc_string_buffer
[offset
- test
] <= '9')
224 if (get_doc_string_buffer
[offset
- test
++] != '@'
225 || get_doc_string_buffer
[offset
- test
] != '#')
232 if (get_doc_string_buffer
[offset
- test
++] != '\n')
234 while (get_doc_string_buffer
[offset
- test
] > ' ')
236 if (get_doc_string_buffer
[offset
- test
] != '\037')
240 /* Scan the text and perform quoting with ^A (char code 1).
241 ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_. */
242 from
= get_doc_string_buffer
+ offset
;
243 to
= get_doc_string_buffer
+ offset
;
260 unsigned char uc
= c
;
262 Invalid data in documentation file -- %c followed by code %03o",
270 /* If DEFINITION, read from this buffer
271 the same way we would read bytes from a file. */
274 read_bytecode_pointer
= (unsigned char *) get_doc_string_buffer
+ offset
;
275 return Fread (Qlambda
);
279 return make_unibyte_string (get_doc_string_buffer
+ offset
,
280 to
- (get_doc_string_buffer
+ offset
));
283 /* The data determines whether the string is multibyte. */
285 = multibyte_chars_in_text (((unsigned char *) get_doc_string_buffer
287 to
- (get_doc_string_buffer
+ offset
));
288 return make_string_from_bytes (get_doc_string_buffer
+ offset
,
290 to
- (get_doc_string_buffer
+ offset
));
294 /* Get a string from position FILEPOS and pass it through the Lisp reader.
295 We use this for fetching the bytecode string and constants vector
296 of a compiled function from the .elc file. */
299 read_doc_string (Lisp_Object filepos
)
301 return get_doc_string (filepos
, 0, 1);
305 reread_doc_file (Lisp_Object file
)
308 Fsnarf_documentation (Vdoc_file_name
);
310 Fload (file
, Qt
, Qt
, Qt
, Qnil
);
315 DEFUN ("documentation", Fdocumentation
, Sdocumentation
, 1, 2, 0,
316 doc
: /* Return the documentation string of FUNCTION.
317 Unless a non-nil second argument RAW is given, the
318 string is passed through `substitute-command-keys'. */)
319 (Lisp_Object function
, Lisp_Object raw
)
330 if (SYMBOLP (function
))
332 Lisp_Object tem
= Fget (function
, Qfunction_documentation
);
334 return Fdocumentation_property (function
, Qfunction_documentation
,
338 fun
= Findirect_function (function
, Qnil
);
339 if (CONSP (fun
) && EQ (XCAR (fun
), Qmacro
))
342 doc
= make_number (XSUBR (fun
)->doc
);
343 else if (COMPILEDP (fun
))
345 if ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) <= COMPILED_DOC_STRING
)
349 Lisp_Object tem
= AREF (fun
, COMPILED_DOC_STRING
);
352 else if (NATNUMP (tem
) || CONSP (tem
))
358 else if (STRINGP (fun
) || VECTORP (fun
))
360 return build_string ("Keyboard macro.");
362 else if (CONSP (fun
))
365 if (!SYMBOLP (funcar
))
366 xsignal1 (Qinvalid_function
, fun
);
367 else if (EQ (funcar
, Qkeymap
))
368 return build_string ("Prefix command (definition is a keymap associating keystrokes with commands).");
369 else if (EQ (funcar
, Qlambda
)
370 || (EQ (funcar
, Qclosure
) && (fun
= XCDR (fun
), 1))
371 || EQ (funcar
, Qautoload
))
373 Lisp_Object tem1
= Fcdr (Fcdr (fun
));
374 Lisp_Object tem
= Fcar (tem1
);
377 /* Handle a doc reference--but these never come last
378 in the function body, so reject them if they are last. */
379 else if ((NATNUMP (tem
) || (CONSP (tem
) && INTEGERP (XCDR (tem
))))
380 && !NILP (XCDR (tem1
)))
391 xsignal1 (Qinvalid_function
, fun
);
394 /* If DOC is 0, it's typically because of a dumped file missing
395 from the DOC file (bug in src/Makefile.in). */
396 if (EQ (doc
, make_number (0)))
398 if (INTEGERP (doc
) || CONSP (doc
))
401 tem
= get_doc_string (doc
, 0, 0);
402 if (NILP (tem
) && try_reload
)
404 /* The file is newer, we need to reset the pointers. */
405 try_reload
= reread_doc_file (Fcar_safe (doc
));
417 doc
= Fsubstitute_command_keys (doc
);
421 DEFUN ("documentation-property", Fdocumentation_property
,
422 Sdocumentation_property
, 2, 3, 0,
423 doc
: /* Return the documentation string that is SYMBOL's PROP property.
424 Third argument RAW omitted or nil means pass the result through
425 `substitute-command-keys' if it is a string.
427 This differs from `get' in that it can refer to strings stored in the
428 `etc/DOC' file; and that it evaluates documentation properties that
430 (Lisp_Object symbol
, Lisp_Object prop
, Lisp_Object raw
)
435 documentation_property
:
437 tem
= Fget (symbol
, prop
);
438 if (EQ (tem
, make_number (0)))
440 if (INTEGERP (tem
) || (CONSP (tem
) && INTEGERP (XCDR (tem
))))
442 Lisp_Object doc
= tem
;
443 tem
= get_doc_string (tem
, 0, 0);
444 if (NILP (tem
) && try_reload
)
446 /* The file is newer, we need to reset the pointers. */
447 try_reload
= reread_doc_file (Fcar_safe (doc
));
451 goto documentation_property
;
455 else if (!STRINGP (tem
))
456 /* Feval protects its argument. */
457 tem
= Feval (tem
, Qnil
);
459 if (NILP (raw
) && STRINGP (tem
))
460 tem
= Fsubstitute_command_keys (tem
);
464 /* Scanning the DOC files and placing docstring offsets into functions. */
467 store_function_docstring (Lisp_Object obj
, EMACS_INT offset
)
469 /* Don't use indirect_function here, or defaliases will apply their
470 docstrings to the base functions (Bug#2603). */
471 Lisp_Object fun
= SYMBOLP (obj
) ? XSYMBOL (obj
)->function
: obj
;
473 /* The type determines where the docstring is stored. */
475 /* If it's a lisp form, stick it in the form. */
476 if (CONSP (fun
) && EQ (XCAR (fun
), Qmacro
))
483 if (EQ (tem
, Qlambda
) || EQ (tem
, Qautoload
)
484 || (EQ (tem
, Qclosure
) && (fun
= XCDR (fun
), 1)))
486 tem
= Fcdr (Fcdr (fun
));
487 if (CONSP (tem
) && INTEGERP (XCAR (tem
)))
488 /* FIXME: This modifies typically pure hash-cons'd data, so its
489 correctness is quite delicate. */
490 XSETCAR (tem
, make_number (offset
));
494 /* Lisp_Subrs have a slot for it. */
495 else if (SUBRP (fun
))
496 XSUBR (fun
)->doc
= offset
;
498 /* Bytecode objects sometimes have slots for it. */
499 else if (COMPILEDP (fun
))
501 /* This bytecode object must have a slot for the
502 docstring, since we've found a docstring for it. */
503 if ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_DOC_STRING
)
504 ASET (fun
, COMPILED_DOC_STRING
, make_number (offset
));
507 AUTO_STRING (format
, "No docstring slot for %s");
508 CALLN (Fmessage
, format
,
511 : build_string ("<anonymous>")));
517 DEFUN ("Snarf-documentation", Fsnarf_documentation
, Ssnarf_documentation
,
519 doc
: /* Used during Emacs initialization to scan the `etc/DOC...' file.
520 This searches the `etc/DOC...' file for doc strings and
521 records them in function and variable definitions.
522 The function takes one argument, FILENAME, a string;
523 it specifies the file name (without a directory) of the DOC file.
524 That file is found in `../etc' now; later, when the dumped Emacs is run,
525 the same file name is found in the `doc-directory'. */)
526 (Lisp_Object filename
)
538 /* Preloaded defcustoms using custom-initialize-delay are added to
539 this list, but kept unbound. See http://debbugs.gnu.org/11565 */
540 Lisp_Object delayed_init
=
541 find_symbol_value (intern ("custom-delayed-init-variables"));
543 if (EQ (delayed_init
, Qunbound
)) delayed_init
= Qnil
;
545 CHECK_STRING (filename
);
549 (!NILP (Vpurify_flag
))
550 #else /* CANNOT_DUMP */
552 #endif /* CANNOT_DUMP */
554 dirname
= sibling_etc
;
555 dirlen
= sizeof sibling_etc
- 1;
559 CHECK_STRING (Vdoc_directory
);
560 dirname
= SSDATA (Vdoc_directory
);
561 dirlen
= SBYTES (Vdoc_directory
);
564 count
= SPECPDL_INDEX ();
566 name
= SAFE_ALLOCA (dirlen
+ SBYTES (filename
) + 1);
567 lispstpcpy (stpcpy (name
, dirname
), filename
); /*** Add this line ***/
569 /* Vbuild_files is nil when temacs is run, and non-nil after that. */
570 if (NILP (Vbuild_files
))
572 static char const *const buildobj
[] =
574 #include "buildobj.h"
576 int i
= ARRAYELTS (buildobj
);
578 Vbuild_files
= Fcons (build_string (buildobj
[i
]), Vbuild_files
);
579 Vbuild_files
= Fpurecopy (Vbuild_files
);
582 fd
= emacs_open (name
, O_RDONLY
, 0);
585 int open_errno
= errno
;
586 report_file_errno ("Opening doc string file", build_string (name
),
589 record_unwind_protect_int (close_file_unwind
, fd
);
590 Vdoc_file_name
= filename
;
596 filled
+= emacs_read_quit (fd
, &buf
[filled
], sizeof buf
- 1 - filled
);
601 char *end
= buf
+ (filled
< 512 ? filled
: filled
- 128);
602 p
= memchr (buf
, '\037', end
- buf
);
603 /* p points to ^_Ffunctionname\n or ^_Vvarname\n or ^_Sfilename\n. */
606 end
= strchr (p
, '\n');
608 /* See if this is a file name, and if it is a file in build-files. */
612 if (end
- p
> 4 && end
[-2] == '.'
613 && (end
[-1] == 'o' || end
[-1] == 'c'))
615 ptrdiff_t len
= end
- p
- 2;
616 char *fromfile
= SAFE_ALLOCA (len
+ 1);
617 memcpy (fromfile
, &p
[2], len
);
619 if (fromfile
[len
-1] == 'c')
620 fromfile
[len
-1] = 'o';
622 skip_file
= NILP (Fmember (build_string (fromfile
),
627 sym
= oblookup (Vobarray
, p
+ 2,
628 multibyte_chars_in_text ((unsigned char *) p
+ 2,
631 /* Check skip_file so that when a function is defined several
632 times in different files (typically, once in xterm, once in
633 w32term, ...), we only pay attention to the one that
635 if (! skip_file
&& SYMBOLP (sym
))
637 /* Attach a docstring to a variable? */
640 /* Install file-position as variable-documentation property
641 and make it negative for a user-variable
642 (doc starts with a `*'). */
643 if (!NILP (Fboundp (sym
))
644 || !NILP (Fmemq (sym
, delayed_init
)))
645 Fput (sym
, Qvariable_documentation
,
646 make_number ((pos
+ end
+ 1 - buf
)
647 * (end
[1] == '*' ? -1 : 1)));
650 /* Attach a docstring to a function? */
651 else if (p
[1] == 'F')
653 if (!NILP (Ffboundp (sym
)))
654 store_function_docstring (sym
, pos
+ end
+ 1 - buf
);
656 else if (p
[1] == 'S')
657 ; /* Just a source file name boundary marker. Ignore it. */
660 error ("DOC file invalid at position %"pI
"d", pos
);
665 memmove (buf
, end
, filled
);
669 return unbind_to (count
, Qnil
);
672 /* Return true if text quoting style should default to quote `like this'. */
674 default_to_grave_quoting_style (void)
676 if (!text_quoting_flag
)
678 if (! DISP_TABLE_P (Vstandard_display_table
))
680 Lisp_Object dv
= DISP_CHAR_VECTOR (XCHAR_TABLE (Vstandard_display_table
),
681 LEFT_SINGLE_QUOTATION_MARK
);
682 return (VECTORP (dv
) && ASIZE (dv
) == 1
683 && EQ (AREF (dv
, 0), make_number ('`')));
686 /* Return the current effective text quoting style. */
687 enum text_quoting_style
688 text_quoting_style (void)
690 if (NILP (Vtext_quoting_style
)
691 ? default_to_grave_quoting_style ()
692 : EQ (Vtext_quoting_style
, Qgrave
))
693 return GRAVE_QUOTING_STYLE
;
694 else if (EQ (Vtext_quoting_style
, Qstraight
))
695 return STRAIGHT_QUOTING_STYLE
;
697 return CURVE_QUOTING_STYLE
;
700 DEFUN ("substitute-command-keys", Fsubstitute_command_keys
,
701 Ssubstitute_command_keys
, 1, 1, 0,
702 doc
: /* Substitute key descriptions for command names in STRING.
703 Each substring of the form \\=\\[COMMAND] is replaced by either a
704 keystroke sequence that invokes COMMAND, or "M-x COMMAND" if COMMAND
707 Each substring of the form \\=\\{MAPVAR} is replaced by a summary of
708 the value of MAPVAR as a keymap. This summary is similar to the one
709 produced by `describe-bindings'. The summary ends in two newlines
710 \(used by the helper function `help-make-xrefs' to find the end of the
713 Each substring of the form \\=\\<MAPVAR> specifies the use of MAPVAR
714 as the keymap for future \\=\\[COMMAND] substrings.
716 Each grave accent \\=` is replaced by left quote, and each apostrophe \\='
717 is replaced by right quote. Left and right quote characters are
718 specified by `text-quoting-style'.
720 \\=\\= quotes the following character and is discarded; thus, \\=\\=\\=\\= puts \\=\\=
721 into the output, \\=\\=\\=\\[ puts \\=\\[ into the output, and \\=\\=\\=` puts \\=` into the
724 Return the original STRING if no substitutions are made.
725 Otherwise, return a new string. */)
729 bool changed
= false;
730 bool nonquotes_changed
= false;
737 unsigned char const *start
;
738 ptrdiff_t length
, length_byte
;
745 /* If STRING contains non-ASCII unibyte data, process its
746 properly-encoded multibyte equivalent instead. This simplifies
747 the implementation and is OK since substitute-command-keys is
748 intended for use only on text strings. Keep STRING around, since
749 it will be returned if no changes occur. */
750 Lisp_Object str
= Fstring_make_multibyte (string
);
752 enum text_quoting_style quoting_style
= text_quoting_style ();
756 /* KEYMAP is either nil (which means search all the active keymaps)
757 or a specified local map (which means search just that and the
758 global map). If non-nil, it might come from Voverriding_local_map,
759 or from a \\<mapname> construct in STRING itself.. */
760 keymap
= Voverriding_local_map
;
762 ptrdiff_t strbytes
= SBYTES (str
);
765 /* Fixed-size stack buffer. */
766 char sbuf
[MAX_ALLOCA
];
768 /* Heap-allocated buffer, if any. */
771 /* Extra room for expansion due to replacing ‘\[]’ with ‘M-x ’. */
772 enum { EXTRA_ROOM
= sizeof "M-x " - sizeof "\\[]" };
774 ptrdiff_t count
= SPECPDL_INDEX ();
776 if (bsize
<= sizeof sbuf
- EXTRA_ROOM
)
784 buf
= abuf
= xpalloc (NULL
, &bsize
, EXTRA_ROOM
, STRING_BYTES_BOUND
, 1);
785 record_unwind_protect_ptr (xfree
, abuf
);
790 while (strp
< SDATA (str
) + strbytes
)
792 unsigned char *close_bracket
;
794 if (strp
[0] == '\\' && strp
[1] == '='
795 && strp
+ 2 < SDATA (str
) + strbytes
)
797 /* \= quotes the next character;
798 thus, to put in \[ without its special meaning, use \=\[. */
799 changed
= nonquotes_changed
= true;
801 /* Fall through to copy one char. */
803 else if (strp
[0] == '\\' && strp
[1] == '['
805 = memchr (strp
+ 2, ']',
806 SDATA (str
) + strbytes
- (strp
+ 2))))
808 bool follow_remap
= 1;
811 length_byte
= close_bracket
- start
;
812 idx
= close_bracket
+ 1 - SDATA (str
);
814 name
= Fintern (make_string ((char *) start
, length_byte
), Qnil
);
817 tem
= Fwhere_is_internal (name
, keymap
, Qt
, Qnil
, Qnil
);
819 if (VECTORP (tem
) && ASIZE (tem
) > 1
820 && EQ (AREF (tem
, 0), Qremap
) && SYMBOLP (AREF (tem
, 1))
823 name
= AREF (tem
, 1);
828 /* Fwhere_is_internal can GC, so take relocation of string
829 contents into account. */
830 strp
= SDATA (str
) + idx
;
831 start
= strp
- length_byte
- 1;
833 if (NILP (tem
)) /* but not on any keys */
835 memcpy (bufp
, "M-x ", 4);
838 length
= multibyte_chars_in_text (start
, length_byte
);
842 { /* function is on a key */
843 tem
= Fkey_description (tem
, Qnil
);
847 /* \{foo} is replaced with a summary of the keymap (symbol-value foo).
848 \<foo> just sets the keymap used for \[cmd]. */
849 else if (strp
[0] == '\\' && (strp
[1] == '{' || strp
[1] == '<')
851 = memchr (strp
+ 2, strp
[1] == '{' ? '}' : '>',
852 SDATA (str
) + strbytes
- (strp
+ 2))))
855 bool generate_summary
= strp
[1] == '{';
856 /* This is for computing the SHADOWS arg for describe_map_tree. */
857 Lisp_Object active_maps
= Fcurrent_active_maps (Qnil
, Qnil
);
858 ptrdiff_t count
= SPECPDL_INDEX ();
861 length_byte
= close_bracket
- start
;
862 idx
= close_bracket
+ 1 - SDATA (str
);
864 /* Get the value of the keymap in TEM, or nil if undefined.
865 Do this while still in the user's current buffer
866 in case it is a local variable. */
867 name
= Fintern (make_string ((char *) start
, length_byte
), Qnil
);
868 tem
= Fboundp (name
);
871 tem
= Fsymbol_value (name
);
873 tem
= get_keymap (tem
, 0, 1);
876 /* Now switch to a temp buffer. */
877 struct buffer
*oldbuf
= current_buffer
;
878 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
879 /* This is for an unusual case where some after-change
880 function uses 'format' or 'prin1' or something else that
881 will thrash Vprin1_to_string_buffer we are using. */
882 specbind (Qinhibit_modification_hooks
, Qt
);
886 name
= Fsymbol_name (name
);
887 AUTO_STRING (msg_prefix
, "\nUses keymap `");
888 insert1 (Fsubstitute_command_keys (msg_prefix
));
889 insert_from_string (name
, 0, 0,
892 AUTO_STRING (msg_suffix
, "', which is not currently defined.\n");
893 insert1 (Fsubstitute_command_keys (msg_suffix
));
894 if (!generate_summary
)
897 else if (!generate_summary
)
901 /* Get the list of active keymaps that precede this one.
902 If this one's not active, get nil. */
903 Lisp_Object earlier_maps
904 = Fcdr (Fmemq (tem
, Freverse (active_maps
)));
905 describe_map_tree (tem
, 1, Fnreverse (earlier_maps
),
906 Qnil
, 0, 1, 0, 0, 1);
908 tem
= Fbuffer_string ();
910 set_buffer_internal (oldbuf
);
911 unbind_to (count
, Qnil
);
915 /* Convert non-ASCII unibyte data to properly-encoded multibyte,
916 for the same reason STRING was converted to STR. */
917 tem
= Fstring_make_multibyte (tem
);
919 length
= SCHARS (tem
);
920 length_byte
= SBYTES (tem
);
922 nonquotes_changed
= true;
926 ptrdiff_t offset
= bufp
- buf
;
927 ptrdiff_t avail
= bsize
- offset
;
928 ptrdiff_t need
= strbytes
- idx
;
929 if (INT_ADD_WRAPV (need
, length_byte
+ EXTRA_ROOM
, &need
))
933 abuf
= xpalloc (abuf
, &bsize
, need
- avail
,
934 STRING_BYTES_BOUND
, 1);
937 record_unwind_protect_ptr (xfree
, abuf
);
938 memcpy (abuf
, sbuf
, offset
);
941 set_unwind_protect_ptr (count
, xfree
, abuf
);
945 memcpy (bufp
, start
, length_byte
);
949 /* Some of the previous code can GC, so take relocation of
950 string contents into account. */
951 strp
= SDATA (str
) + idx
;
956 else if ((strp
[0] == '`' || strp
[0] == '\'')
957 && quoting_style
== CURVE_QUOTING_STYLE
)
959 start
= (unsigned char const *) (strp
[0] == '`' ? uLSQM
: uRSQM
);
961 length_byte
= sizeof uLSQM
- 1;
962 idx
= strp
- SDATA (str
) + 1;
965 else if (strp
[0] == '`' && quoting_style
== STRAIGHT_QUOTING_STYLE
)
977 while (! CHAR_HEAD_P (*strp
));
981 if (changed
) /* don't bother if nothing substituted */
983 tem
= make_string_from_bytes (buf
, nchars
, bufp
- buf
);
984 if (!nonquotes_changed
)
986 /* Nothing has changed other than quoting, so copy the string’s
987 text properties. FIXME: Text properties should survive other
989 INTERVAL interval_copy
= copy_intervals (string_intervals (string
),
993 set_interval_object (interval_copy
, tem
);
994 set_string_intervals (tem
, interval_copy
);
1000 return unbind_to (count
, tem
);
1006 DEFSYM (Qfunction_documentation
, "function-documentation");
1007 DEFSYM (Qgrave
, "grave");
1008 DEFSYM (Qstraight
, "straight");
1010 DEFVAR_LISP ("internal-doc-file-name", Vdoc_file_name
,
1011 doc
: /* Name of file containing documentation strings of built-in symbols. */);
1012 Vdoc_file_name
= Qnil
;
1014 DEFVAR_LISP ("build-files", Vbuild_files
,
1015 doc
: /* A list of files used to build this Emacs binary. */);
1016 Vbuild_files
= Qnil
;
1018 DEFVAR_LISP ("text-quoting-style", Vtext_quoting_style
,
1019 doc
: /* Style to use for single quotes in help and messages.
1020 Its value should be a symbol. It works by substituting certain single
1021 quotes for grave accent and apostrophe. This is done in help output
1022 and in functions like `message' and `format-message'. It is not done
1025 `curve' means quote with curved single quotes ‘like this’.
1026 `straight' means quote with straight apostrophes \\='like this\\='.
1027 `grave' means quote with grave accent and apostrophe \\=`like this\\=';
1028 i.e., do not alter quote marks. The default value nil acts like
1029 `curve' if curved single quotes are displayable, and like `grave'
1031 Vtext_quoting_style
= Qnil
;
1033 DEFVAR_BOOL ("internal--text-quoting-flag", text_quoting_flag
,
1034 doc
: /* If nil, a nil `text-quoting-style' is treated as `grave'. */);
1035 /* Initialized by ‘main’. */
1037 defsubr (&Sdocumentation
);
1038 defsubr (&Sdocumentation_property
);
1039 defsubr (&Ssnarf_documentation
);
1040 defsubr (&Ssubstitute_command_keys
);