home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / lucid / lemacs-19.6 / src / minibuf.c < prev    next >
Encoding:
C/C++ Source or Header  |  1993-01-17  |  13.6 KB  |  504 lines
  1. /* Minibuffer input and completion.
  2.    Copyright (C) 1985-1993 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, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19.  
  20.  
  21. #include <stdio.h>
  22. #include "config.h"
  23.  
  24. #include "lisp.h"
  25. #include "commands.h"
  26. #include "buffer.h"
  27. #include "screen.h"
  28. #include "window.h"
  29. #include "syntax.h"
  30.  
  31. #define min(a, b) ((a) < (b) ? (a) : (b))
  32.  
  33. /* Depth in minibuffer invocations.  */
  34. int minibuf_level;
  35.  
  36. /* help-form is bound to this while in the minibuffer.  */
  37. Lisp_Object Vminibuffer_help_form;
  38.  
  39. /* Nonzero means completion ignores case.  */
  40. int completion_ignore_case;
  41.  
  42. /* Width in columns of current minibuffer prompt.  */
  43. extern int minibuf_prompt_width;
  44.  
  45. /* Width in pixels of current minibuffer prompt.  */
  46. extern int minibuf_prompt_pix_width;
  47.  
  48. #ifdef MULTI_SCREEN
  49. /* When the global-minibuffer-screen is not used, this is the screen
  50.    where the minbuffer is active, and thus where certain windows
  51.    (completions, etc.) should appear. */
  52. struct screen *active_screen;
  53.  
  54. extern Lisp_Object Vglobal_minibuffer_screen;
  55. #endif
  56.  
  57. /* Actual minibuffer invocation. */
  58.  
  59. DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
  60.   "Return current depth of activations of minibuffer, a nonnegative integer.")
  61.   ()
  62. {
  63.   return make_number (minibuf_level);
  64. }
  65.  
  66. /* The default buffer to use as the window-buffer of minibuffer windows */
  67. /*  Note there is special code in kill-buffer to make this unkillable */
  68. Lisp_Object Vminibuffer_zero;
  69.  
  70.  
  71.  
  72.  
  73. static Lisp_Object
  74. read_minibuffer_internal_unwind (Lisp_Object unwind_data)
  75. {
  76.   windows_or_buffers_changed++;
  77.   XFASTINT (XWINDOW (minibuf_window)->last_modified) = 0;
  78.   XFASTINT (XWINDOW (minibuf_window)->last_facechange) = 0;
  79.   Vminibuf_prompt = Felt (unwind_data, make_number (0));
  80.   minibuf_prompt_width = XFASTINT (Felt (unwind_data, make_number (1)));
  81.   minibuf_prompt_pix_width = XFASTINT (Felt (unwind_data, make_number (2)));
  82.   minibuf_level = XFASTINT (Felt (unwind_data, make_number (3)));
  83.   while (CONSP (unwind_data))
  84.   {
  85.     Lisp_Object victim = unwind_data;
  86.     unwind_data = XCONS (unwind_data)->cdr;
  87.     free_cons (XCONS (victim));
  88.   }
  89.   return Qnil;
  90. }
  91.  
  92. extern Lisp_Object command_loop_2 (Lisp_Object);
  93.  
  94. DEFUN ("read-minibuffer-internal", 
  95.        Fread_minibuffer_internal, Sread_minibuffer_internal, 
  96.        1, 1, 0,
  97.        "Lowest-level interface to minibuffers.  Don't call this.")
  98.   (prompt)
  99.      Lisp_Object prompt;
  100. {
  101.   int speccount = specpdl_depth;
  102.   Lisp_Object val;
  103.  
  104.   CHECK_STRING (prompt, 0);
  105.  
  106.   record_unwind_protect (read_minibuffer_internal_unwind,
  107.                          list4 (Vminibuf_prompt,
  108.                                 make_number (minibuf_prompt_width),
  109.                                 make_number (minibuf_prompt_pix_width),
  110.                                 make_number (minibuf_level)));
  111.   Vminibuf_prompt = prompt;
  112.   minibuf_level++;
  113.  
  114. #ifdef MULTI_SCREEN
  115.   if (SCREENP (Vglobal_minibuffer_screen))
  116.     active_screen = selected_screen;
  117. #endif
  118.  
  119.   echo_area_glyphs = 0;
  120.  
  121.   val = command_loop_2 (Qnil);
  122.  
  123.   /* If cursor is on the minibuffer line,
  124.      show the user we have exited by putting it in column 0.  */
  125.   if ((SCREEN_CURSOR_Y (selected_screen)
  126.        >= XFASTINT (XWINDOW (minibuf_window)->top))
  127.       && !noninteractive)
  128.     {
  129.       SCREEN_CURSOR_X (selected_screen) = 0;
  130.       update_screen (selected_screen, 1, 1);
  131.     }
  132. #ifdef MULTI_SCREEN
  133.   if (active_screen)
  134.     active_screen = (struct screen *) 0;
  135. #endif
  136.  
  137.   return (unbind_to (speccount, val));
  138. }
  139.  
  140.  
  141.  
  142.  
  143. /* Completion hair */
  144.  
  145. /* Compare exactly LEN chars of strings at S1 and S2,
  146.    ignoring case if appropriate.
  147.    Return -1 if strings match,
  148.    else number of chars that match at the beginning.  */
  149.  
  150. int
  151. scmp (s1, s2, len)
  152.      register const char *s1, *s2;
  153.      int len;
  154. {
  155.   register int l = len;
  156.  
  157.   if (completion_ignore_case)
  158.     {
  159.       while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
  160.     l--;
  161.     }
  162.   else
  163.     {
  164.       while (l && *s1++ == *s2++)
  165.     l--;
  166.     }
  167.   if (l == 0)
  168.     return -1;
  169.   else return len - l;
  170. }
  171.  
  172. DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
  173.   "Return common substring of all completions of STRING in ALIST.\n\
  174. Each car of each element of ALIST is tested to see if it begins with STRING.\n\
  175. All that match are compared together; the longest initial sequence\n\
  176. common to all matches is returned as a string.\n\
  177. If there is no match at all, nil is returned.\n\
  178. For an exact match, t is returned.\n\
  179. \n\
  180. ALIST can be an obarray instead of an alist.\n\
  181. Then the print names of all symbols in the obarray are the possible matches.\n\
  182. \n\
  183. ALIST can also be a function to do the completion itself.\n\
  184. It receives three arguments: the values STRING, PREDICATE and nil.\n\
  185. Whatever it returns becomes the value of `try-completion'.\n\
  186. \n\
  187. If optional third argument PREDICATE is non-nil,\n\
  188. it is used to test each possible match.\n\
  189. The match is a candidate only if PREDICATE returns non-nil.\n\
  190. The argument given to PREDICATE is the alist element or the symbol from the obarray.")
  191.   (string, alist, pred)
  192.      Lisp_Object string, alist, pred;
  193. {
  194.   Lisp_Object bestmatch, tail, elt, eltstring;
  195.   int bestmatchsize;
  196.   int compare, matchsize;
  197.   int list;
  198.   int index, obsize;
  199.   int matchcount = 0;
  200.   Lisp_Object bucket, zero, end, tem;
  201.   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
  202.  
  203.   CHECK_STRING (string, 0);
  204.  
  205.   if (CONSP (alist))
  206.   {
  207.     tem = XCONS (alist)->car;
  208.     if (SYMBOLP (tem))          /* lambda, autoload, etc.  Emacs-lisp sucks */
  209.       return call3 (alist, string, pred, Qnil);
  210.     else
  211.       list = 1;
  212.   }
  213.   else if (VECTORP (alist))
  214.     list = 0;
  215.   else if (NILP (alist))
  216.     list = 1;
  217.   else
  218.     return call3 (alist, string, pred, Qnil);
  219.  
  220.   bestmatch = Qnil;
  221.  
  222.   /* If ALIST is not a list, set TAIL just for gc pro.  */
  223.   tail = alist;
  224.   if (! list)
  225.     {
  226.       index = 0;
  227.       obsize = XVECTOR (alist)->size;
  228.       bucket = XVECTOR (alist)->contents[index];
  229.     }
  230.  
  231.   while (1)
  232.     {
  233.       /* Get the next element of the alist or obarray. */
  234.       /* Exit the loop if the elements are all used up. */
  235.       /* elt gets the alist element or symbol.
  236.      eltstring gets the name to check as a completion. */
  237.  
  238.       if (list)
  239.     {
  240.       if (NILP (tail))
  241.         break;
  242.       elt = Fcar (tail);
  243.       eltstring = Fcar (elt);
  244.       tail = Fcdr (tail);
  245.     }
  246.       else
  247.     {
  248.       if (XFASTINT (bucket) != 0)
  249.         {
  250.               struct Lisp_Symbol *next = symbol_next (XSYMBOL (bucket));
  251.           elt = bucket;
  252.           eltstring = Fsymbol_name (elt);
  253.               if (next)
  254.         XSET (bucket, Lisp_Symbol, next);
  255.           else
  256.         XFASTINT (bucket) = 0;
  257.         }
  258.       else if (++index >= obsize)
  259.         break;
  260.       else
  261.         {
  262.           bucket = XVECTOR (alist)->contents[index];
  263.           continue;
  264.         }
  265.     }
  266.  
  267.       /* Is this element a possible completion? */
  268.  
  269.       if (STRINGP (eltstring) &&
  270.       XSTRING (string)->size <= XSTRING (eltstring)->size &&
  271.       0 > scmp ((char *) XSTRING (eltstring)->data,
  272.             (char *) XSTRING (string)->data,
  273.             XSTRING (string)->size))
  274.     {
  275.       /* Yes. */
  276.       /* Ignore this element if there is a predicate
  277.          and the predicate doesn't like it. */
  278.  
  279.       if (!NILP (pred))
  280.         {
  281.           if (EQ (pred, Qcommandp))
  282.         tem = Fcommandp (elt);
  283.           else
  284.         {
  285.           GCPRO4 (tail, string, eltstring, bestmatch);
  286.           tem = call1 (pred, elt);
  287.           UNGCPRO;
  288.         }
  289.           if (NILP (tem)) continue;
  290.         }
  291.  
  292.       /* Update computation of how much all possible completions match */
  293.  
  294.       matchcount++;
  295.       if (NILP (bestmatch))
  296.         bestmatch = eltstring, bestmatchsize = XSTRING (eltstring)->size;
  297.       else
  298.         {
  299.           compare = min (bestmatchsize, XSTRING (eltstring)->size);
  300.           matchsize = scmp ((char *) XSTRING (bestmatch)->data,
  301.                 (char *) XSTRING (eltstring)->data,
  302.                 compare);
  303.           if (matchsize < 0)
  304.         matchsize = compare;
  305.           if (completion_ignore_case)
  306.         {
  307.           /* If this is an exact match except for case,
  308.              use it as the best match rather than one that is not an
  309.              exact match.  This way, we get the case pattern
  310.              of the actual match.  */
  311.           if ((matchsize == XSTRING (eltstring)->size
  312.                && matchsize < XSTRING (bestmatch)->size)
  313.               ||
  314.               /* If there is more than one exact match ignoring case,
  315.              and one of them is exact including case,
  316.              prefer that one.  */
  317.               /* If there is no exact match ignoring case,
  318.              prefer a match that does not change the case
  319.              of the input.  */
  320.               ((matchsize == XSTRING (eltstring)->size)
  321.                ==
  322.                (matchsize == XSTRING (bestmatch)->size)
  323.                && !memcmp ((char *) XSTRING (eltstring)->data,
  324.                    (char *) XSTRING (string)->data,
  325.                    XSTRING (string)->size)
  326.                && memcmp ((char *) XSTRING (bestmatch)->data,
  327.                   (char *) XSTRING (string)->data, 
  328.                   XSTRING (string)->size)))
  329.             bestmatch = eltstring;
  330.         }
  331.           bestmatchsize = matchsize;
  332.         }
  333.     }
  334.     }
  335.  
  336.   if (NILP (bestmatch))
  337.     return Qnil;        /* No completions found */
  338.   /* If we are ignoring case, and there is no exact match,
  339.      and no additional text was supplied,
  340.      don't change the case of what the user typed.  */
  341.   if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
  342.       && XSTRING (bestmatch)->size > bestmatchsize)
  343.     return string;
  344.  
  345.   /* Return t if the supplied string is an exact match (counting case);
  346.      it does not require any change to be made.  */
  347.   if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
  348.       && !memcmp (XSTRING (bestmatch)->data, XSTRING (string)->data,
  349.           bestmatchsize))
  350.     return Qt;
  351.  
  352.   XFASTINT (zero) = 0;        /* Else extract the part in which */
  353.   XFASTINT (end) = bestmatchsize;         /* all completions agree */
  354.   return Fsubstring (bestmatch, zero, end);
  355. }
  356.  
  357.  
  358. DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 3, 0,
  359.   "Search for partial matches to STRING in ALIST.\n\
  360. Each car of each element of ALIST is tested to see if it begins with STRING.\n\
  361. The value is a list of all the strings from ALIST that match.\n\
  362. ALIST can be an obarray instead of an alist.\n\
  363. Then the print names of all symbols in the obarray are the possible matches.\n\
  364. \n\
  365. ALIST can also be a function to do the completion itself.\n\
  366. It receives three arguments: the values STRING, PREDICATE and t.\n\
  367. Whatever it returns becomes the value of `all-completions'.\n\
  368. \n\
  369. If optional third argument PREDICATE is non-nil,\n\
  370. it is used to test each possible match.\n\
  371. The match is a candidate only if PREDICATE returns non-nil.\n\
  372. The argument given to PREDICATE is the alist element or\n\
  373. the symbol from the obarray.")
  374.   (string, alist, pred)
  375.      Lisp_Object string, alist, pred;
  376. {
  377.   Lisp_Object tail, elt, eltstring;
  378.   Lisp_Object allmatches;
  379.   int list;
  380.   int index, obsize;
  381.   Lisp_Object bucket, tem;
  382.   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
  383.  
  384.   CHECK_STRING (string, 0);
  385.  
  386.   if (CONSP (alist))
  387.   {
  388.     tem = XCONS (alist)->car;
  389.     if (SYMBOLP (tem))          /* lambda, autoload, etc.  Emacs-lisp sucks */
  390.       return call3 (alist, string, pred, Qt);
  391.     else
  392.       list = 1;
  393.   }
  394.   else if (VECTORP (alist))
  395.     list = 0;
  396.   else if (NILP (alist))
  397.     list = 1;
  398.   else
  399.     return call3 (alist, string, pred, Qt);
  400.  
  401.   allmatches = Qnil;
  402.  
  403.   /* If ALIST is not a list, set TAIL just for gc pro.  */
  404.   tail = alist;
  405.   if (! list)
  406.     {
  407.       index = 0;
  408.       obsize = XVECTOR (alist)->size;
  409.       bucket = XVECTOR (alist)->contents[index];
  410.     }
  411.  
  412.   while (1)
  413.     {
  414.       /* Get the next element of the alist or obarray. */
  415.       /* Exit the loop if the elements are all used up. */
  416.       /* elt gets the alist element or symbol.
  417.      eltstring gets the name to check as a completion. */
  418.  
  419.       if (list)
  420.     {
  421.       if (NILP (tail))
  422.         break;
  423.       elt = Fcar (tail);
  424.       eltstring = Fcar (elt);
  425.       tail = Fcdr (tail);
  426.     }
  427.       else
  428.     {
  429.       if (XFASTINT (bucket) != 0)
  430.         {
  431.               struct Lisp_Symbol *next = symbol_next (XSYMBOL (bucket));
  432.           elt = bucket;
  433.           eltstring = Fsymbol_name (elt);
  434.               if (next)
  435.         XSET (bucket, Lisp_Symbol, next);
  436.           else
  437.         XFASTINT (bucket) = 0;
  438.             }
  439.       else if (++index >= obsize)
  440.         break;
  441.       else
  442.         {
  443.           bucket = XVECTOR (alist)->contents[index];
  444.           continue;
  445.         }
  446.     }
  447.  
  448.       /* Is this element a possible completion? */
  449.  
  450.       if (STRINGP (eltstring) &&
  451.       XSTRING (string)->size <= XSTRING (eltstring)->size &&
  452.       XSTRING (eltstring)->data[0] != ' ' &&
  453.       0 > scmp ((char *) XSTRING (eltstring)->data,
  454.             (char *) XSTRING (string)->data,
  455.             XSTRING (string)->size))
  456.     {
  457.       /* Yes. */
  458.       /* Ignore this element if there is a predicate
  459.          and the predicate doesn't like it. */
  460.  
  461.       if (!NILP (pred))
  462.         {
  463.           if (EQ (pred, Qcommandp))
  464.         tem = Fcommandp (elt);
  465.           else
  466.         {
  467.           GCPRO4 (tail, eltstring, allmatches, string);
  468.           tem = call1 (pred, elt);
  469.           UNGCPRO;
  470.         }
  471.           if (NILP (tem)) continue;
  472.         }
  473.       /* Ok => put it on the list. */
  474.       allmatches = Fcons (eltstring, allmatches);
  475.     }
  476.     }
  477.  
  478.   return Fnreverse (allmatches);
  479. }
  480.  
  481.  
  482. void
  483. init_minibuf_once ()
  484. {
  485.   Vminibuffer_zero = Fget_buffer_create (build_string (" *Minibuf-0*"));
  486. }
  487.  
  488. void
  489. syms_of_minibuf ()
  490. {
  491.   minibuf_level = 0;
  492.  
  493.   DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
  494.     "Non-nil means don't consider case significant in completion.");
  495.   completion_ignore_case = 0;
  496.  
  497.   defsubr (&Sminibuffer_depth);
  498.  
  499.   defsubr (&Sread_minibuffer_internal);
  500.  
  501.   defsubr (&Stry_completion);
  502.   defsubr (&Sall_completions);
  503. }
  504.