home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / emacs-19.28-src.tgz / tar.out / fsf / emacs / src / doc.c < prev    next >
C/C++ Source or Header  |  1996-09-28  |  15KB  |  555 lines
  1. /* Record indices of function doc strings stored in a file.
  2.    Copyright (C) 1985, 1986, 1993, 1994 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 1, 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, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19.  
  20.  
  21. #include <config.h>
  22.  
  23. #include <sys/types.h>
  24. #include <sys/file.h>    /* Must be after sys/types.h for USG and BSD4_1*/
  25.  
  26. #ifdef USG5
  27. #include <fcntl.h>
  28. #endif
  29.  
  30. #ifdef HAVE_UNISTD_H
  31. #include <unistd.h>
  32. #endif
  33.  
  34. #ifndef O_RDONLY
  35. #define O_RDONLY 0
  36. #endif
  37.  
  38. #include "lisp.h"
  39. #include "paths.h"
  40. #include "buffer.h"
  41. #include "keyboard.h"
  42.  
  43. Lisp_Object Vdoc_file_name;
  44.  
  45. extern Lisp_Object Voverriding_local_map;
  46.  
  47. Lisp_Object
  48. get_doc_string (filepos)
  49.      long filepos;
  50. {
  51.   char buf[512 * 32 + 1];
  52.   register int fd;
  53.   register char *name;
  54.   register char *p, *p1;
  55.   register int count;
  56.   extern char *index ();
  57.  
  58.   if (XTYPE (Vdoc_directory) != Lisp_String
  59.       || XTYPE (Vdoc_file_name) != Lisp_String)
  60.     return Qnil;
  61.  
  62.   name = (char *) alloca (XSTRING (Vdoc_directory)->size
  63.               + XSTRING (Vdoc_file_name)->size + 8);
  64.   strcpy (name, XSTRING (Vdoc_directory)->data);
  65.   strcat (name, XSTRING (Vdoc_file_name)->data);
  66. #ifdef VMS
  67. #ifndef VMS4_4
  68.   /* For VMS versions with limited file name syntax,
  69.      convert the name to something VMS will allow.  */
  70.   p = name;
  71.   while (*p)
  72.     {
  73.       if (*p == '-')
  74.     *p = '_';
  75.       p++;
  76.     }
  77. #endif /* not VMS4_4 */
  78. #ifdef VMS4_4
  79.   strcpy (name, sys_translate_unix (name));
  80. #endif /* VMS4_4 */
  81. #endif /* VMS */
  82.  
  83.   fd = open (name, O_RDONLY, 0);
  84.   if (fd < 0)
  85.     error ("Cannot open doc string file \"%s\"", name);
  86.   if (0 > lseek (fd, filepos, 0))
  87.     {
  88.       close (fd);
  89.       error ("Position %ld out of range in doc string file \"%s\"",
  90.          filepos, name);
  91.     }
  92.   p = buf;
  93.   while (p != buf + sizeof buf - 1)
  94.     {
  95.       count = read (fd, p, 512);
  96.       p[count] = 0;
  97.       if (!count)
  98.     break;
  99.       p1 = index (p, '\037');
  100.       if (p1)
  101.     {
  102.       *p1 = 0;
  103.       p = p1;
  104.       break;
  105.     }
  106.       p += count;
  107.     }
  108.   close (fd);
  109.   return make_string (buf, p - buf);
  110. }
  111.  
  112. DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0,
  113.   "Return the documentation string of FUNCTION.\n\
  114. Unless a non-nil second argument is given, the\n\
  115. string is passed through `substitute-command-keys'.")
  116.   (function, raw)
  117.      Lisp_Object function, raw;
  118. {
  119.   Lisp_Object fun;
  120.   Lisp_Object funcar;
  121.   Lisp_Object tem, doc;
  122.  
  123.   fun = Findirect_function (function);
  124.  
  125.   switch (XTYPE (fun))
  126.     {
  127.     case Lisp_Subr:
  128.       if (XSUBR (fun)->doc == 0) return Qnil;
  129.       if ((int) XSUBR (fun)->doc >= 0)
  130.     doc = build_string (XSUBR (fun)->doc);
  131.       else
  132.     doc = get_doc_string (- (int) XSUBR (fun)->doc);
  133.       break;
  134.       
  135.     case Lisp_Compiled:
  136.       if (XVECTOR (fun)->size <= COMPILED_DOC_STRING)
  137.     return Qnil;
  138.       tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING];
  139.       if (XTYPE (tem) == Lisp_String)
  140.     doc = tem;
  141.       else if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
  142.     doc = get_doc_string (XFASTINT (tem));
  143.       else
  144.     return Qnil;
  145.       break;
  146.  
  147.     case Lisp_String:
  148.     case Lisp_Vector:
  149.       return build_string ("Keyboard macro.");
  150.  
  151.     case Lisp_Cons:
  152.       funcar = Fcar (fun);
  153.       if (XTYPE (funcar) != Lisp_Symbol)
  154.     return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
  155.       else if (EQ (funcar, Qkeymap))
  156.     return build_string ("Prefix command (definition is a keymap associating keystrokes with\n\
  157. subcommands.)");
  158.       else if (EQ (funcar, Qlambda)
  159.            || EQ (funcar, Qautoload))
  160.     {
  161.       tem = Fcar (Fcdr (Fcdr (fun)));
  162.       if (XTYPE (tem) == Lisp_String)
  163.         doc = tem;
  164.       else if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
  165.         doc = get_doc_string (XFASTINT (tem));
  166.       else
  167.         return Qnil;
  168.  
  169.       break;
  170.     }
  171.       else if (EQ (funcar, Qmocklisp))
  172.     return Qnil;
  173.       else if (EQ (funcar, Qmacro))
  174.     return Fdocumentation (Fcdr (fun), raw);
  175.  
  176.       /* Fall through to the default to report an error.  */
  177.  
  178.     default:
  179.       return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
  180.     }
  181.  
  182.   if (NILP (raw))
  183.     {
  184.       struct gcpro gcpro1;
  185.  
  186.       GCPRO1 (doc);
  187.       doc = Fsubstitute_command_keys (doc);
  188.       UNGCPRO;
  189.     }
  190.   return doc;
  191. }
  192.  
  193. DEFUN ("documentation-property", Fdocumentation_property, Sdocumentation_property, 2, 3, 0,
  194.   "Return the documentation string that is SYMBOL's PROP property.\n\
  195. This is like `get', but it can refer to strings stored in the\n\
  196. `etc/DOC' file; and if the value is a string, it is passed through\n\
  197. `substitute-command-keys'.  A non-nil third argument avoids this\n\
  198. translation.")
  199.   (sym, prop, raw)
  200.      Lisp_Object sym, prop, raw;
  201. {
  202.   register Lisp_Object tem;
  203.  
  204.   tem = Fget (sym, prop);
  205.   if (XTYPE (tem) == Lisp_Int)
  206.     tem = get_doc_string (XINT (tem) > 0 ? XINT (tem) : - XINT (tem));
  207.   if (NILP (raw) && XTYPE (tem) == Lisp_String)
  208.     return Fsubstitute_command_keys (tem);
  209.   return tem;
  210. }
  211.  
  212. /* Scanning the DOC files and placing docstring offsets into functions.  */
  213.  
  214. static void
  215. store_function_docstring (fun, offset)
  216.      Lisp_Object fun;
  217.      int offset;
  218. {
  219.   fun = indirect_function (fun);
  220.  
  221.   /* The type determines where the docstring is stored.  */
  222.  
  223.   /* Lisp_Subrs have a slot for it.  */
  224.   if (XTYPE (fun) == Lisp_Subr)
  225.     XSUBR (fun)->doc = (char *) - offset;
  226.  
  227.   /* If it's a lisp form, stick it in the form.  */
  228.   else if (CONSP (fun))
  229.     {
  230.       Lisp_Object tem;
  231.  
  232.       tem = XCONS (fun)->car;
  233.       if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
  234.     {
  235.       tem = Fcdr (Fcdr (fun));
  236.       if (CONSP (tem) &&
  237.           XTYPE (XCONS (tem)->car) == Lisp_Int)
  238.         XFASTINT (XCONS (tem)->car) = offset;
  239.     }
  240.       else if (EQ (tem, Qmacro))
  241.     store_function_docstring (XCONS (fun)->cdr, offset);
  242.     }
  243.  
  244.   /* Bytecode objects sometimes have slots for it.  */
  245.   else if (XTYPE (fun) == Lisp_Compiled)
  246.     {
  247.       /* This bytecode object must have a slot for the
  248.      docstring, since we've found a docstring for it.  */
  249.       if (XVECTOR (fun)->size > COMPILED_DOC_STRING)
  250.     XFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING]) = offset;
  251.     }
  252. }
  253.  
  254.  
  255. DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
  256.   1, 1, 0,
  257.   "Used during Emacs initialization, before dumping runnable Emacs,\n\
  258. to find pointers to doc strings stored in `etc/DOC...' and\n\
  259. record them in function definitions.\n\
  260. One arg, FILENAME, a string which does not include a directory.\n\
  261. The file is found in `../etc' now; found in the `data-directory'\n\
  262. when doc strings are referred to later in the dumped Emacs.")
  263.   (filename)
  264.      Lisp_Object filename;
  265. {
  266.   int fd;
  267.   char buf[1024 + 1];
  268.   register int filled;
  269.   register int pos;
  270.   register char *p, *end;
  271.   Lisp_Object sym, fun, tem;
  272.   char *name;
  273.   extern char *index ();
  274.  
  275. #ifndef CANNOT_DUMP
  276.   if (NILP (Vpurify_flag))
  277.     error ("Snarf-documentation can only be called in an undumped Emacs");
  278. #endif
  279.  
  280.   CHECK_STRING (filename, 0);
  281.  
  282. #ifndef CANNOT_DUMP
  283.   name = (char *) alloca (XSTRING (filename)->size + 14);
  284. #ifdef RELPATH_DOC
  285.   strcpy (name, RELPATH_DOC);
  286. #else
  287.   strcpy (name, "../etc/");
  288. #endif
  289. #else /* CANNOT_DUMP */
  290.   CHECK_STRING (Vdoc_directory, 0);
  291.   name = (char *) alloca (XSTRING (filename)->size +
  292.               XSTRING (Vdoc_directory)->size + 1);
  293.   strcpy (name, XSTRING (Vdoc_directory)->data);
  294. #endif /* CANNOT_DUMP */
  295.   strcat (name, XSTRING (filename)->data);     /*** Add this line ***/
  296. #ifdef VMS
  297. #ifndef VMS4_4
  298.   /* For VMS versions with limited file name syntax,
  299.      convert the name to something VMS will allow.  */
  300.   p = name;
  301.   while (*p)
  302.     {
  303.       if (*p == '-')
  304.     *p = '_';
  305.       p++;
  306.     }
  307. #endif /* not VMS4_4 */
  308. #ifdef VMS4_4
  309.   strcpy (name, sys_translate_unix (name));
  310. #endif /* VMS4_4 */
  311. #endif /* VMS */
  312.  
  313.   fd = open (name, O_RDONLY, 0);
  314.   if (fd < 0)
  315.     report_file_error ("Opening doc string file",
  316.                Fcons (build_string (name), Qnil));
  317.   Vdoc_file_name = filename;
  318.   filled = 0;
  319.   pos = 0;
  320.   while (1)
  321.     {
  322.       if (filled < 512)
  323.     filled += read (fd, &buf[filled], sizeof buf - 1 - filled);
  324.       if (!filled)
  325.     break;
  326.  
  327.       buf[filled] = 0;
  328.       p = buf;
  329.       end = buf + (filled < 512 ? filled : filled - 128);
  330.       while (p != end && *p != '\037') p++;
  331.       /* p points to ^_Ffunctionname\n or ^_Vvarname\n.  */
  332.       if (p != end)
  333.     {
  334.       end = index (p, '\n');
  335.       sym = oblookup (Vobarray, p + 2, end - p - 2);
  336.       if (XTYPE (sym) == Lisp_Symbol)
  337.         {
  338.           /* Attach a docstring to a variable?  */
  339.           if (p[1] == 'V')
  340.         {
  341.           /* Install file-position as variable-documentation property
  342.              and make it negative for a user-variable
  343.              (doc starts with a `*').  */
  344.           Fput (sym, Qvariable_documentation,
  345.             make_number ((pos + end + 1 - buf)
  346.                      * (end[1] == '*' ? -1 : 1)));
  347.         }
  348.  
  349.           /* Attach a docstring to a function?  */
  350.           else if (p[1] == 'F')
  351.         store_function_docstring (sym, pos + end + 1 - buf);
  352.  
  353.           else
  354.         error ("DOC file invalid at position %d", pos);
  355.         }
  356.     }
  357.       pos += end - buf;
  358.       filled -= end - buf;
  359.       bcopy (end, buf, filled);
  360.     }
  361.   close (fd);
  362.   return Qnil;
  363. }
  364.  
  365. DEFUN ("substitute-command-keys", Fsubstitute_command_keys,
  366.   Ssubstitute_command_keys, 1, 1, 0,
  367.   "Substitute key descriptions for command names in STRING.\n\
  368. Return a new string which is STRING with substrings of the form \\=\\[COMMAND]\n\
  369. replaced by either:  a keystroke sequence that will invoke COMMAND,\n\
  370. or \"M-x COMMAND\" if COMMAND is not on any keys.\n\
  371. Substrings of the form \\=\\{MAPVAR} are replaced by summaries\n\
  372. \(made by describe-bindings) of the value of MAPVAR, taken as a keymap.\n\
  373. Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR\n\
  374. as the keymap for future \\=\\[COMMAND] substrings.\n\
  375. \\=\\= quotes the following character and is discarded;\n\
  376. thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.")
  377.   (str)
  378.      Lisp_Object str;
  379. {
  380.   unsigned char *buf;
  381.   int changed = 0;
  382.   register unsigned char *strp;
  383.   register unsigned char *bufp;
  384.   int idx;
  385.   int bsize;
  386.   unsigned char *new;
  387.   Lisp_Object tem;
  388.   Lisp_Object keymap;
  389.   unsigned char *start;
  390.   int length;
  391.   Lisp_Object name;
  392.   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
  393.  
  394.   if (NILP (str))
  395.     return Qnil;
  396.  
  397.   CHECK_STRING (str, 0);
  398.   tem = Qnil;
  399.   keymap = Qnil;
  400.   name = Qnil;
  401.   GCPRO4 (str, tem, keymap, name);
  402.  
  403.   /* KEYMAP is either nil (which means search all the active keymaps)
  404.      or a specified local map (which means search just that and the
  405.      global map).  If non-nil, it might come from Voverriding_local_map,
  406.      or from a \\<mapname> construct in STR itself..  */
  407.   keymap = Voverriding_local_map;
  408.  
  409.   bsize = XSTRING (str)->size;
  410.   bufp = buf = (unsigned char *) xmalloc (bsize);
  411.  
  412.   strp = (unsigned char *) XSTRING (str)->data;
  413.   while (strp < (unsigned char *) XSTRING (str)->data + XSTRING (str)->size)
  414.     {
  415.       if (strp[0] == '\\' && strp[1] == '=')
  416.     {
  417.       /* \= quotes the next character;
  418.          thus, to put in \[ without its special meaning, use \=\[.  */
  419.       changed = 1;
  420.       *bufp++ = strp[2];
  421.       strp += 3;
  422.     }
  423.       else if (strp[0] == '\\' && strp[1] == '[')
  424.     {
  425.       Lisp_Object firstkey;
  426.  
  427.       changed = 1;
  428.       strp += 2;        /* skip \[ */
  429.       start = strp;
  430.  
  431.       while ((strp - (unsigned char *) XSTRING (str)->data
  432.           < XSTRING (str)->size)
  433.          && *strp != ']')
  434.         strp++;
  435.       length = strp - start;
  436.       strp++;        /* skip ] */
  437.  
  438.       /* Save STRP in IDX.  */
  439.       idx = strp - (unsigned char *) XSTRING (str)->data;
  440.       tem = Fintern (make_string (start, length), Qnil);
  441.       tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);
  442.  
  443.       /* Disregard menu bar bindings; it is positively annoying to
  444.          mention them when there's no menu bar, and it isn't terribly
  445.          useful even when there is a menu bar.  */
  446.       if (!NILP (tem))
  447.         {
  448.           firstkey = Faref (tem, make_number (0));
  449.           if (EQ (firstkey, Qmenu_bar))
  450.         tem = Qnil;
  451.         }
  452.  
  453.       if (NILP (tem))    /* but not on any keys */
  454.         {
  455.           new = (unsigned char *) xrealloc (buf, bsize += 4);
  456.           bufp += new - buf;
  457.           buf = new;
  458.           bcopy ("M-x ", bufp, 4);
  459.           bufp += 4;
  460.           goto subst;
  461.         }
  462.       else
  463.         {            /* function is on a key */
  464.           tem = Fkey_description (tem);
  465.           goto subst_string;
  466.         }
  467.     }
  468.       /* \{foo} is replaced with a summary of the keymap (symbol-value foo).
  469.      \<foo> just sets the keymap used for \[cmd].  */
  470.       else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<'))
  471.     {
  472.       struct buffer *oldbuf;
  473.  
  474.       changed = 1;
  475.       strp += 2;        /* skip \{ or \< */
  476.       start = strp;
  477.  
  478.       while ((strp - (unsigned char *) XSTRING (str)->data
  479.           < XSTRING (str)->size)
  480.          && *strp != '}' && *strp != '>')
  481.         strp++;
  482.       length = strp - start;
  483.       strp++;            /* skip } or > */
  484.  
  485.       /* Save STRP in IDX.  */
  486.       idx = strp - (unsigned char *) XSTRING (str)->data;
  487.  
  488.       /* Get the value of the keymap in TEM, or nil if undefined.
  489.          Do this while still in the user's current buffer
  490.          in case it is a local variable.  */
  491.       name = Fintern (make_string (start, length), Qnil);
  492.       tem = Fboundp (name);
  493.       if (! NILP (tem))
  494.         {
  495.           tem = Fsymbol_value (name);
  496.           if (! NILP (tem))
  497.         tem = get_keymap_1 (tem, 0, 1);
  498.         }
  499.  
  500.       /* Now switch to a temp buffer.  */
  501.       oldbuf = current_buffer;
  502.       set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
  503.  
  504.       if (NILP (tem))
  505.         {
  506.           name = Fsymbol_name (name);
  507.           insert_string ("\nUses keymap \"");
  508.           insert_from_string (name, 0, XSTRING (name)->size, 1);
  509.           insert_string ("\", which is not currently defined.\n");
  510.           if (start[-1] == '<') keymap = Qnil;
  511.         }
  512.       else if (start[-1] == '<')
  513.         keymap = tem;
  514.       else
  515.         describe_map_tree (tem, 1, Qnil, Qnil, 0, 1);
  516.       tem = Fbuffer_string ();
  517.       Ferase_buffer ();
  518.       set_buffer_internal (oldbuf);
  519.  
  520.     subst_string:
  521.       start = XSTRING (tem)->data;
  522.       length = XSTRING (tem)->size;
  523.     subst:
  524.       new = (unsigned char *) xrealloc (buf, bsize += length);
  525.       bufp += new - buf;
  526.       buf = new;
  527.       bcopy (start, bufp, length);
  528.       bufp += length;
  529.       /* Check STR again in case gc relocated it.  */
  530.       strp = (unsigned char *) XSTRING (str)->data + idx;
  531.     }
  532.       else            /* just copy other chars */
  533.     *bufp++ = *strp++;
  534.     }
  535.  
  536.   if (changed)            /* don't bother if nothing substituted */
  537.     tem = make_string (buf, bufp - buf);
  538.   else
  539.     tem = str;
  540.   xfree (buf);
  541.   RETURN_UNGCPRO (tem);
  542. }
  543.  
  544. syms_of_doc ()
  545. {
  546.   DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name,
  547.     "Name of file containing documentation strings of built-in symbols.");
  548.   Vdoc_file_name = Qnil;
  549.  
  550.   defsubr (&Sdocumentation);
  551.   defsubr (&Sdocumentation_property);
  552.   defsubr (&Ssnarf_documentation);
  553.   defsubr (&Ssubstitute_command_keys);
  554. }
  555.