home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / e20313sr.zip / emacs / 20.3.1 / src / doc.c < prev    next >
C/C++ Source or Header  |  1999-07-31  |  22KB  |  799 lines
  1. /* Record indices of function doc strings stored in a file.
  2.    Copyright (C) 1985, 86, 93, 94, 95, 97, 1998 Free Software Foundation, Inc.
  3.  
  4. This file is part of GNU Emacs.
  5.  
  6. GNU Emacs is free software; you can redistribute it and/or modify
  7. it under the terms of the GNU General Public License as published by
  8. the Free Software Foundation; either version 2, or (at your option)
  9. any later version.
  10.  
  11. GNU Emacs is distributed in the hope that it will be useful,
  12. but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. GNU General Public License for more details.
  15.  
  16. You should have received a copy of the GNU General Public License
  17. along with GNU Emacs; see the file COPYING.  If not, write to
  18. the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19. Boston, MA 02111-1307, USA.  */
  20.  
  21. /* Modified for emx by Jeremy Bowen, May 1999 based on patches
  22.    to v19.33 by Eberhard Mattes */
  23.  
  24. #include <config.h>
  25.  
  26. #include <sys/types.h>
  27. #include <sys/file.h>    /* Must be after sys/types.h for USG and BSD4_1*/
  28.  
  29. #ifdef USG5
  30. #include <fcntl.h>
  31. #endif
  32.  
  33. #ifdef HAVE_UNISTD_H
  34. #include <unistd.h>
  35. #endif
  36.  
  37. #ifndef O_RDONLY
  38. #define O_RDONLY 0
  39. #endif
  40.  
  41. #include "lisp.h"
  42. #include "buffer.h"
  43. #include "keyboard.h"
  44. #include "charset.h"
  45.  
  46. Lisp_Object Vdoc_file_name;
  47.  
  48. extern char *index ();
  49.  
  50. extern Lisp_Object Voverriding_local_map;
  51.  
  52. /* For VMS versions with limited file name syntax,
  53.    convert the name to something VMS will allow. */
  54. static void
  55. munge_doc_file_name (name)
  56.      char *name;
  57. {
  58. #ifdef VMS
  59. #ifndef VMS4_4
  60.   /* For VMS versions with limited file name syntax,
  61.      convert the name to something VMS will allow.  */
  62.   p = name;
  63.   while (*p)
  64.     {
  65.       if (*p == '-')
  66.     *p = '_';
  67.       p++;
  68.     }
  69. #endif /* not VMS4_4 */
  70. #ifdef VMS4_4
  71.   strcpy (name, sys_translate_unix (name));
  72. #endif /* VMS4_4 */
  73. #endif /* VMS */
  74. }
  75.  
  76. /* Buffer used for reading from documentation file.  */
  77. static char *get_doc_string_buffer;
  78. static int get_doc_string_buffer_size;
  79.  
  80. static unsigned char *read_bytecode_pointer;
  81.  
  82. /* readchar in lread.c calls back here to fetch the next byte.
  83.    If UNREADFLAG is 1, we unread a byte.  */
  84.  
  85. int
  86. read_bytecode_char (unreadflag)
  87. {
  88.   if (unreadflag)
  89.     {
  90.       read_bytecode_pointer--;
  91.       return 0;
  92.     }
  93.   return *read_bytecode_pointer++;
  94. }
  95.  
  96. /* Extract a doc string from a file.  FILEPOS says where to get it.
  97.    If it is an integer, use that position in the standard DOC-... file.
  98.    If it is (FILE . INTEGER), use FILE as the file name
  99.    and INTEGER as the position in that file.
  100.    But if INTEGER is negative, make it positive.
  101.    (A negative integer is used for user variables, so we can distinguish
  102.    them without actually fetching the doc string.)
  103.  
  104.    If UNIBYTE is nonzero, always make a unibyte string.
  105.  
  106.    If DEFINITION is nonzero, assume this is for reading
  107.    a dynamic function definition; convert the bytestring
  108.    and the constants vector with appropriate byte handling,
  109.    and return a cons cell.  */
  110.  
  111. Lisp_Object
  112. get_doc_string (filepos, unibyte, definition)
  113.      Lisp_Object filepos;
  114.      int unibyte, definition;
  115. {
  116.   char *from, *to;
  117.   register int fd;
  118.   register char *name;
  119.   register char *p, *p1;
  120.   int minsize;
  121.   int offset, position;
  122.   Lisp_Object file, tem;
  123.  
  124.   if (INTEGERP (filepos))
  125.     {
  126.       file = Vdoc_file_name;
  127.       position = XINT (filepos);
  128.     }
  129.   else if (CONSP (filepos))
  130.     {
  131.       file = XCONS (filepos)->car;
  132.       position = XINT (XCONS (filepos)->cdr);
  133.       if (position < 0)
  134.     position = - position;
  135.     }
  136.   else
  137.     return Qnil;
  138.  
  139.   if (!STRINGP (Vdoc_directory))
  140.     return Qnil;
  141.  
  142.   if (!STRINGP (file))
  143.     return Qnil;
  144.     
  145.   /* Put the file name in NAME as a C string.
  146.      If it is relative, combine it with Vdoc_directory.  */
  147.  
  148.   tem = Ffile_name_absolute_p (file);
  149.   if (NILP (tem))
  150.     {
  151.       minsize = XSTRING (Vdoc_directory)->size;
  152.       /* sizeof ("../etc/") == 8 */
  153.       if (minsize < 8)
  154.     minsize = 8;
  155.       name = (char *) alloca (minsize + XSTRING (file)->size + 8);
  156.       strcpy (name, XSTRING (Vdoc_directory)->data);
  157.       strcat (name, XSTRING (file)->data);
  158.       munge_doc_file_name (name);
  159.     }
  160.   else
  161.     {
  162.       name = (char *) XSTRING (file)->data;
  163.     }
  164.  
  165. #ifdef EMX
  166.   fd = open (name, O_RDONLY | O_BINARY, 0);
  167. #else /* not EMX */
  168.   fd = open (name, O_RDONLY, 0);
  169. #endif /* not EMX */
  170.   if (fd < 0)
  171.     {
  172. #ifndef CANNOT_DUMP
  173.       if (!NILP (Vpurify_flag))
  174.     {
  175.       /* Preparing to dump; DOC file is probably not installed.
  176.          So check in ../etc. */
  177.       strcpy (name, "../etc/");
  178.       strcat (name, XSTRING (file)->data);
  179.       munge_doc_file_name (name);
  180.  
  181.       fd = open (name, O_RDONLY, 0);
  182.     }
  183. #endif
  184.       if (fd < 0)
  185.     error ("Cannot open doc string file \"%s\"", name);
  186.     }
  187.  
  188.   /* Seek only to beginning of disk block.  */
  189.   offset = position % (8 * 1024);
  190.   if (0 > lseek (fd, position - offset, 0))
  191.     {
  192.       close (fd);
  193.       error ("Position %ld out of range in doc string file \"%s\"",
  194.          position, name);
  195.     }
  196.  
  197.   /* Read the doc string into get_doc_string_buffer.
  198.      P points beyond the data just read.  */
  199.  
  200.   p = get_doc_string_buffer;
  201.   while (1)
  202.     {
  203.       int space_left = (get_doc_string_buffer_size
  204.             - (p - get_doc_string_buffer));
  205.       int nread;
  206.  
  207.       /* Allocate or grow the buffer if we need to.  */
  208.       if (space_left == 0)
  209.     {
  210.       int in_buffer = p - get_doc_string_buffer;
  211.       get_doc_string_buffer_size += 16 * 1024;
  212.       get_doc_string_buffer
  213.         = (char *) xrealloc (get_doc_string_buffer,
  214.                  get_doc_string_buffer_size + 1);
  215.       p = get_doc_string_buffer + in_buffer;
  216.       space_left = (get_doc_string_buffer_size
  217.             - (p - get_doc_string_buffer));
  218.     }
  219.  
  220.       /* Read a disk block at a time.
  221.          If we read the same block last time, maybe skip this?  */
  222.       if (space_left > 1024 * 8)
  223.     space_left = 1024 * 8;
  224.       nread = read (fd, p, space_left);
  225.       if (nread < 0)
  226.     {
  227.       close (fd);
  228.       error ("Read error on documentation file");
  229.     }
  230.       p[nread] = 0;
  231.       if (!nread)
  232.     break;
  233.       if (p == get_doc_string_buffer)
  234.     p1 = index (p + offset, '\037');
  235.       else
  236.     p1 = index (p, '\037');
  237.       if (p1)
  238.     {
  239.       *p1 = 0;
  240.       p = p1;
  241.       break;
  242.     }
  243.       p += nread;
  244.     }
  245.   close (fd);
  246.  
  247.   /* Scan the text and perform quoting with ^A (char code 1).
  248.      ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_.  */
  249.   from = get_doc_string_buffer + offset;
  250.   to = get_doc_string_buffer + offset;
  251.   while (from != p)
  252.     {
  253.       if (*from == 1)
  254.     {
  255.       int c;
  256.  
  257.       from++;
  258.       c = *from++;
  259.       if (c == 1)
  260.         *to++ = c;
  261.       else if (c == '0')
  262.         *to++ = 0;
  263.       else if (c == '_')
  264.         *to++ = 037;
  265.       else
  266.         error ("Invalid data in documentation file -- ^A followed by code 0%o", c);
  267.     }
  268.       else
  269.     *to++ = *from++;
  270.     }
  271.  
  272.   /* If DEFINITION, read from this buffer
  273.      the same way we would read bytes from a file.  */
  274.   if (definition)
  275.     {
  276.       read_bytecode_pointer = get_doc_string_buffer + offset;
  277.       return Fread (Qlambda);
  278.     }
  279.  
  280.   if (unibyte)
  281.     return make_unibyte_string (get_doc_string_buffer + offset,
  282.                 to - (get_doc_string_buffer + offset));
  283.   else
  284.     return make_string (get_doc_string_buffer + offset,
  285.             to - (get_doc_string_buffer + offset));
  286. }
  287.  
  288. /* Get a string from position FILEPOS and pass it through the Lisp reader.
  289.    We use this for fetching the bytecode string and constants vector
  290.    of a compiled function from the .elc file.  */
  291.  
  292. Lisp_Object
  293. read_doc_string (filepos)
  294.      Lisp_Object filepos;
  295. {
  296.   return get_doc_string (filepos, 0, 1);
  297. }
  298.  
  299. DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0,
  300.   "Return the documentation string of FUNCTION.\n\
  301. Unless a non-nil second argument RAW is given, the\n\
  302. string is passed through `substitute-command-keys'.")
  303.   (function, raw)
  304.      Lisp_Object function, raw;
  305. {
  306.   Lisp_Object fun;
  307.   Lisp_Object funcar;
  308.   Lisp_Object tem, doc;
  309.  
  310.   fun = Findirect_function (function);
  311.  
  312.   if (SUBRP (fun))
  313.     {
  314.       if (XSUBR (fun)->doc == 0) return Qnil;
  315.       if ((EMACS_INT) XSUBR (fun)->doc >= 0)
  316.     doc = build_string (XSUBR (fun)->doc);
  317.       else
  318.     doc = get_doc_string (make_number (- (EMACS_INT) XSUBR (fun)->doc),
  319.                   0, 0);
  320.     }
  321.   else if (COMPILEDP (fun))
  322.     {
  323.       if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING)
  324.     return Qnil;
  325.       tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING];
  326.       if (STRINGP (tem))
  327.     doc = tem;
  328.       else if (NATNUMP (tem) || CONSP (tem))
  329.     doc = get_doc_string (tem, 0, 0);
  330.       else
  331.     return Qnil;
  332.     }
  333.   else if (STRINGP (fun) || VECTORP (fun))
  334.     {
  335.       return build_string ("Keyboard macro.");
  336.     }
  337.   else if (CONSP (fun))
  338.     {
  339.       funcar = Fcar (fun);
  340.       if (!SYMBOLP (funcar))
  341.     return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
  342.       else if (EQ (funcar, Qkeymap))
  343.     return build_string ("Prefix command (definition is a keymap associating keystrokes with\n\
  344. subcommands.)");
  345.       else if (EQ (funcar, Qlambda)
  346.            || EQ (funcar, Qautoload))
  347.     {
  348.       Lisp_Object tem1;
  349.       tem1 = Fcdr (Fcdr (fun));
  350.       tem = Fcar (tem1);
  351.       if (STRINGP (tem))
  352.         doc = tem;
  353.       /* Handle a doc reference--but these never come last
  354.          in the function body, so reject them if they are last.  */
  355.       else if ((NATNUMP (tem) || CONSP (tem))
  356.            && ! NILP (XCONS (tem1)->cdr))
  357.         doc = get_doc_string (tem, 0, 0);
  358.       else
  359.         return Qnil;
  360.     }
  361.       else if (EQ (funcar, Qmocklisp))
  362.     return Qnil;
  363.       else if (EQ (funcar, Qmacro))
  364.     return Fdocumentation (Fcdr (fun), raw);
  365.       else
  366.     goto oops;
  367.     }
  368.   else
  369.     {
  370.     oops:
  371.       Fsignal (Qinvalid_function, Fcons (fun, Qnil));
  372.     }
  373.  
  374.   if (NILP (raw))
  375.     {
  376.       struct gcpro gcpro1;
  377.  
  378.       GCPRO1 (doc);
  379.       doc = Fsubstitute_command_keys (doc);
  380.       UNGCPRO;
  381.     }
  382.   return doc;
  383. }
  384.  
  385. DEFUN ("documentation-property", Fdocumentation_property, Sdocumentation_property, 2, 3, 0,
  386.   "Return the documentation string that is SYMBOL's PROP property.\n\
  387. This is like `get', but it can refer to strings stored in the\n\
  388. `etc/DOC' file; and if the value is a string, it is passed through\n\
  389. `substitute-command-keys'.  A non-nil third argument RAW avoids this\n\
  390. translation.")
  391.   (symbol, prop, raw)
  392.      Lisp_Object symbol, prop, raw;
  393. {
  394.   register Lisp_Object tem;
  395.  
  396.   tem = Fget (symbol, prop);
  397.   if (INTEGERP (tem))
  398.     tem = get_doc_string (XINT (tem) > 0 ? tem : make_number (- XINT (tem)), 0, 0);
  399.   else if (CONSP (tem))
  400.     tem = get_doc_string (tem, 0, 0);
  401.   if (NILP (raw) && STRINGP (tem))
  402.     return Fsubstitute_command_keys (tem);
  403.   return tem;
  404. }
  405.  
  406. /* Scanning the DOC files and placing docstring offsets into functions.  */
  407.  
  408. static void
  409. store_function_docstring (fun, offset)
  410.      Lisp_Object fun;
  411.      /* Use EMACS_INT because we get this from pointer subtraction.  */
  412.      EMACS_INT offset;
  413. {
  414.   fun = indirect_function (fun);
  415.  
  416.   /* The type determines where the docstring is stored.  */
  417.  
  418.   /* Lisp_Subrs have a slot for it.  */
  419.   if (SUBRP (fun))
  420.     XSUBR (fun)->doc = (char *) - offset;
  421.  
  422.   /* If it's a lisp form, stick it in the form.  */
  423.   else if (CONSP (fun))
  424.     {
  425.       Lisp_Object tem;
  426.  
  427.       tem = XCONS (fun)->car;
  428.       if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
  429.     {
  430.       tem = Fcdr (Fcdr (fun));
  431.       if (CONSP (tem) && INTEGERP (XCONS (tem)->car))
  432.         XSETFASTINT (XCONS (tem)->car, offset);
  433.     }
  434.       else if (EQ (tem, Qmacro))
  435.     store_function_docstring (XCONS (fun)->cdr, offset);
  436.     }
  437.  
  438.   /* Bytecode objects sometimes have slots for it.  */
  439.   else if (COMPILEDP (fun))
  440.     {
  441.       /* This bytecode object must have a slot for the
  442.      docstring, since we've found a docstring for it.  */
  443.       if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING)
  444.     XSETFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING], offset);
  445.     }
  446. }
  447.  
  448.  
  449. DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
  450.   1, 1, 0,
  451.   "Used during Emacs initialization, before dumping runnable Emacs,\n\
  452. to find pointers to doc strings stored in `etc/DOC...' and\n\
  453. record them in function definitions.\n\
  454. One arg, FILENAME, a string which does not include a directory.\n\
  455. The file is found in `../etc' now; found in the `data-directory'\n\
  456. when doc strings are referred to later in the dumped Emacs.")
  457.   (filename)
  458.      Lisp_Object filename;
  459. {
  460.   int fd;
  461.   char buf[1024 + 1];
  462.   register int filled;
  463.   register int pos;
  464.   register char *p, *end;
  465.   Lisp_Object sym, fun, tem;
  466.   char *name;
  467.   extern char *index ();
  468.  
  469. #ifndef CANNOT_DUMP
  470.   if (NILP (Vpurify_flag))
  471.     error ("Snarf-documentation can only be called in an undumped Emacs");
  472. #endif
  473.  
  474.   CHECK_STRING (filename, 0);
  475.  
  476. #ifndef CANNOT_DUMP
  477.   name = (char *) alloca (XSTRING (filename)->size + 14);
  478.   strcpy (name, "../etc/");
  479. #else /* CANNOT_DUMP */
  480.   CHECK_STRING (Vdoc_directory, 0);
  481.   name = (char *) alloca (XSTRING (filename)->size +
  482.               XSTRING (Vdoc_directory)->size + 1);
  483.   strcpy (name, XSTRING (Vdoc_directory)->data);
  484. #endif /* CANNOT_DUMP */
  485.   strcat (name, XSTRING (filename)->data);     /*** Add this line ***/
  486. #ifdef VMS
  487. #ifndef VMS4_4
  488.   /* For VMS versions with limited file name syntax,
  489.      convert the name to something VMS will allow.  */
  490.   p = name;
  491.   while (*p)
  492.     {
  493.       if (*p == '-')
  494.     *p = '_';
  495.       p++;
  496.     }
  497. #endif /* not VMS4_4 */
  498. #ifdef VMS4_4
  499.   strcpy (name, sys_translate_unix (name));
  500. #endif /* VMS4_4 */
  501. #endif /* VMS */
  502.  
  503. #ifdef EMX
  504.   fd = open (name, O_RDONLY | O_BINARY, 0);
  505. #else /* not EMX */
  506.   fd = open (name, O_RDONLY, 0);
  507. #endif /* not EMX */
  508.   if (fd < 0)
  509.     report_file_error ("Opening doc string file",
  510.                Fcons (build_string (name), Qnil));
  511.   Vdoc_file_name = filename;
  512.   filled = 0;
  513.   pos = 0;
  514.   while (1)
  515.     {
  516.       if (filled < 512)
  517.     filled += read (fd, &buf[filled], sizeof buf - 1 - filled);
  518.       if (!filled)
  519.     break;
  520.  
  521.       buf[filled] = 0;
  522.       p = buf;
  523.       end = buf + (filled < 512 ? filled : filled - 128);
  524.       while (p != end && *p != '\037') p++;
  525.       /* p points to ^_Ffunctionname\n or ^_Vvarname\n.  */
  526.       if (p != end)
  527.     {
  528.       end = index (p, '\n');
  529.       sym = oblookup (Vobarray, p + 2,
  530.               multibyte_chars_in_text (p + 2, end - p - 2),
  531.               end - p - 2);
  532.       if (SYMBOLP (sym))
  533.         {
  534.           /* Attach a docstring to a variable?  */
  535.           if (p[1] == 'V')
  536.         {
  537.           /* Install file-position as variable-documentation property
  538.              and make it negative for a user-variable
  539.              (doc starts with a `*').  */
  540.           Fput (sym, Qvariable_documentation,
  541.             make_number ((pos + end + 1 - buf)
  542.                      * (end[1] == '*' ? -1 : 1)));
  543.         }
  544.  
  545.           /* Attach a docstring to a function?  */
  546.           else if (p[1] == 'F')
  547.         store_function_docstring (sym, pos + end + 1 - buf);
  548.  
  549.           else
  550.         error ("DOC file invalid at position %d", pos);
  551.         }
  552.     }
  553.       pos += end - buf;
  554.       filled -= end - buf;
  555.       bcopy (end, buf, filled);
  556.     }
  557.   close (fd);
  558.   return Qnil;
  559. }
  560.  
  561. DEFUN ("substitute-command-keys", Fsubstitute_command_keys,
  562.   Ssubstitute_command_keys, 1, 1, 0,
  563.   "Substitute key descriptions for command names in STRING.\n\
  564. Return a new string which is STRING with substrings of the form \\=\\[COMMAND]\n\
  565. replaced by either:  a keystroke sequence that will invoke COMMAND,\n\
  566. or \"M-x COMMAND\" if COMMAND is not on any keys.\n\
  567. Substrings of the form \\=\\{MAPVAR} are replaced by summaries\n\
  568. \(made by describe-bindings) of the value of MAPVAR, taken as a keymap.\n\
  569. Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR\n\
  570. as the keymap for future \\=\\[COMMAND] substrings.\n\
  571. \\=\\= quotes the following character and is discarded;\n\
  572. thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.")
  573.   (string)
  574.      Lisp_Object string;
  575. {
  576.   unsigned char *buf;
  577.   int changed = 0;
  578.   register unsigned char *strp;
  579.   register unsigned char *bufp;
  580.   int idx;
  581.   int bsize;
  582.   unsigned char *new;
  583.   Lisp_Object tem;
  584.   Lisp_Object keymap;
  585.   unsigned char *start;
  586.   int length, length_byte;
  587.   Lisp_Object name;
  588.   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
  589.   int multibyte;
  590.   int nchars;
  591.  
  592.   if (NILP (string))
  593.     return Qnil;
  594.  
  595.   CHECK_STRING (string, 0);
  596.   tem = Qnil;
  597.   keymap = Qnil;
  598.   name = Qnil;
  599.   GCPRO4 (string, tem, keymap, name);
  600.  
  601.   multibyte = STRING_MULTIBYTE (string);
  602.   nchars = 0;
  603.  
  604.   /* KEYMAP is either nil (which means search all the active keymaps)
  605.      or a specified local map (which means search just that and the
  606.      global map).  If non-nil, it might come from Voverriding_local_map,
  607.      or from a \\<mapname> construct in STRING itself..  */
  608.   keymap = current_kboard->Voverriding_terminal_local_map;
  609.   if (NILP (keymap))
  610.     keymap = Voverriding_local_map;
  611.  
  612.   bsize = STRING_BYTES (XSTRING (string));
  613.   bufp = buf = (unsigned char *) xmalloc (bsize);
  614.  
  615.   strp = (unsigned char *) XSTRING (string)->data;
  616.   while (strp < XSTRING (string)->data + STRING_BYTES (XSTRING (string)))
  617.     {
  618.       if (strp[0] == '\\' && strp[1] == '=')
  619.     {
  620.       /* \= quotes the next character;
  621.          thus, to put in \[ without its special meaning, use \=\[.  */
  622.       changed = 1;
  623.       strp += 2;
  624.       if (multibyte)
  625.         {
  626.           int len;
  627.           int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
  628.  
  629.           STRING_CHAR_AND_LENGTH (strp, maxlen, len);
  630.           if (len == 1)
  631.         *bufp = *strp;
  632.           else
  633.         bcopy (strp, bufp, len);
  634.           strp += len;
  635.           bufp += len;
  636.           nchars++;
  637.         }
  638.       else
  639.         *bufp++ = *strp++, nchars++;
  640.     }
  641.       else if (strp[0] == '\\' && strp[1] == '[')
  642.     {
  643.       Lisp_Object firstkey;
  644.  
  645.       changed = 1;
  646.       strp += 2;        /* skip \[ */
  647.       start = strp;
  648.  
  649.       while ((strp - (unsigned char *) XSTRING (string)->data
  650.           < STRING_BYTES (XSTRING (string)))
  651.          && *strp != ']')
  652.         strp++;
  653.       length_byte = strp - start;
  654.  
  655.       strp++;        /* skip ] */
  656.  
  657.       /* Save STRP in IDX.  */
  658.       idx = strp - (unsigned char *) XSTRING (string)->data;
  659.       tem = Fintern (make_string (start, length_byte), Qnil);
  660.       tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);
  661.  
  662.       /* Disregard menu bar bindings; it is positively annoying to
  663.          mention them when there's no menu bar, and it isn't terribly
  664.          useful even when there is a menu bar.  */
  665.       if (!NILP (tem))
  666.         {
  667.           firstkey = Faref (tem, make_number (0));
  668.           if (EQ (firstkey, Qmenu_bar))
  669.         tem = Qnil;
  670.         }
  671.  
  672.       if (NILP (tem))    /* but not on any keys */
  673.         {
  674.           new = (unsigned char *) xrealloc (buf, bsize += 4);
  675.           bufp += new - buf;
  676.           buf = new;
  677.           bcopy ("M-x ", bufp, 4);
  678.           bufp += 4;
  679.           nchars += 4;
  680.           if (multibyte)
  681.         length = multibyte_chars_in_text (start, length_byte);
  682.           else
  683.         length = length_byte;
  684.           goto subst;
  685.         }
  686.       else
  687.         {            /* function is on a key */
  688.           tem = Fkey_description (tem);
  689.           goto subst_string;
  690.         }
  691.     }
  692.       /* \{foo} is replaced with a summary of the keymap (symbol-value foo).
  693.      \<foo> just sets the keymap used for \[cmd].  */
  694.       else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<'))
  695.     {
  696.       struct buffer *oldbuf;
  697.  
  698.       changed = 1;
  699.       strp += 2;        /* skip \{ or \< */
  700.       start = strp;
  701.  
  702.       while ((strp - (unsigned char *) XSTRING (string)->data
  703.           < XSTRING (string)->size)
  704.          && *strp != '}' && *strp != '>')
  705.         strp++;
  706.  
  707.       length_byte = strp - start;
  708.       strp++;            /* skip } or > */
  709.  
  710.       /* Save STRP in IDX.  */
  711.       idx = strp - (unsigned char *) XSTRING (string)->data;
  712.  
  713.       /* Get the value of the keymap in TEM, or nil if undefined.
  714.          Do this while still in the user's current buffer
  715.          in case it is a local variable.  */
  716.       name = Fintern (make_string (start, length_byte), Qnil);
  717.       tem = Fboundp (name);
  718.       if (! NILP (tem))
  719.         {
  720.           tem = Fsymbol_value (name);
  721.           if (! NILP (tem))
  722.         tem = get_keymap_1 (tem, 0, 1);
  723.         }
  724.  
  725.       /* Now switch to a temp buffer.  */
  726.       oldbuf = current_buffer;
  727.       set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
  728.  
  729.       if (NILP (tem))
  730.         {
  731.           name = Fsymbol_name (name);
  732.           insert_string ("\nUses keymap \"");
  733.           insert_from_string (name, 0, 0,
  734.                   XSTRING (name)->size,
  735.                   STRING_BYTES (XSTRING (name)), 1);
  736.           insert_string ("\", which is not currently defined.\n");
  737.           if (start[-1] == '<') keymap = Qnil;
  738.         }
  739.       else if (start[-1] == '<')
  740.         keymap = tem;
  741.       else
  742.         describe_map_tree (tem, 1, Qnil, Qnil, (char *)0, 1, 0, 0);
  743.       tem = Fbuffer_string ();
  744.       Ferase_buffer ();
  745.       set_buffer_internal (oldbuf);
  746.  
  747.     subst_string:
  748.       start = XSTRING (tem)->data;
  749.       length = XSTRING (tem)->size;
  750.       length_byte = STRING_BYTES (XSTRING (tem));
  751.     subst:
  752.       new = (unsigned char *) xrealloc (buf, bsize += length_byte);
  753.       bufp += new - buf;
  754.       buf = new;
  755.       bcopy (start, bufp, length_byte);
  756.       bufp += length_byte;
  757.       nchars += length;
  758.       /* Check STRING again in case gc relocated it.  */
  759.       strp = (unsigned char *) XSTRING (string)->data + idx;
  760.     }
  761.       else if (! multibyte)        /* just copy other chars */
  762.     *bufp++ = *strp++, nchars++;
  763.       else
  764.     {
  765.       int len;
  766.       int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
  767.  
  768.       STRING_CHAR_AND_LENGTH (strp, maxlen, len);
  769.       if (len == 1)
  770.         *bufp = *strp;
  771.       else
  772.         bcopy (strp, bufp, len);
  773.       strp += len;
  774.       bufp += len;
  775.       nchars++;
  776.     }
  777.     }
  778.  
  779.   if (changed)            /* don't bother if nothing substituted */
  780.     tem = make_string_from_bytes (buf, nchars, bufp - buf);
  781.   else
  782.     tem = string;
  783.   xfree (buf);
  784.   RETURN_UNGCPRO (tem);
  785. }
  786.  
  787. void
  788. syms_of_doc ()
  789. {
  790.   DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name,
  791.     "Name of file containing documentation strings of built-in symbols.");
  792.   Vdoc_file_name = Qnil;
  793.  
  794.   defsubr (&Sdocumentation);
  795.   defsubr (&Sdocumentation_property);
  796.   defsubr (&Ssnarf_documentation);
  797.   defsubr (&Ssubstitute_command_keys);
  798. }
  799.