minibuf.c 53.4 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Minibuffer input and completion.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17 18 19 20
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


21
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
22 23 24 25
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
26
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
27 28 29 30 31
#include "window.h"
#include "syntax.h"

#define min(a, b) ((a) < (b) ? (a) : (b))

32 33
extern int quit_char;

Jim Blandy's avatar
Jim Blandy committed
34
/* List of buffers for use as minibuffers.
35 36 37 38
   The first element of the list is used for the outermost minibuffer
   invocation, the next element is used for a recursive minibuffer
   invocation, etc.  The list is extended at the end as deeper
   minibuffer recursions are encountered.  */
Jim Blandy's avatar
Jim Blandy committed
39 40
Lisp_Object Vminibuffer_list;

41 42
/* Data to remember during recursive minibuffer invocations  */
Lisp_Object minibuf_save_list;
Jim Blandy's avatar
Jim Blandy committed
43 44 45 46 47 48 49

/* Depth in minibuffer invocations.  */
int minibuf_level;

/* Nonzero means display completion help for invalid input */
int auto_help;

50
/* Fread_minibuffer leaves the input here as a string. */
Jim Blandy's avatar
Jim Blandy committed
51 52 53 54 55 56 57 58 59 60
Lisp_Object last_minibuf_string;

/* Nonzero means let functions called when within a minibuffer 
   invoke recursive minibuffers (to read arguments, or whatever) */
int enable_recursive_minibuffers;

/* help-form is bound to this while in the minibuffer.  */

Lisp_Object Vminibuffer_help_form;

61 62 63 64 65 66 67 68 69 70
/* Variable which is the history list to add minibuffer values to.  */

Lisp_Object Vminibuffer_history_variable;

/* Current position in the history list (adjusted by M-n and M-p).  */

Lisp_Object Vminibuffer_history_position;

Lisp_Object Qminibuffer_history;

71 72
Lisp_Object Qread_file_name_internal;

73
/* Normal hooks for entry to and exit from minibuffer.  */
74 75

Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
76
Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
77

Jim Blandy's avatar
Jim Blandy committed
78 79 80 81
/* Nonzero means completion ignores case.  */

int completion_ignore_case;

82 83 84 85
/* List of regexps that should restrict possible completions.  */

Lisp_Object Vcompletion_regexp_list;

86 87 88 89 90
/* Nonzero means raise the minibuffer frame when the minibuffer
   is entered.  */

int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
91 92 93 94 95 96
/* If last completion attempt reported "Complete but not unique"
   then this is the string completed then; otherwise this is nil.  */

static Lisp_Object last_exact_completion;

Lisp_Object Quser_variable_p;
97 98 99 100

/* Non-nil means it is the window for C-M-v to scroll
   when the minibuffer is selected.  */
extern Lisp_Object Vminibuf_scroll_window;
Jim Blandy's avatar
Jim Blandy committed
101 102 103 104 105 106 107

/* Actual minibuffer invocation. */

void read_minibuf_unwind ();
Lisp_Object get_minibuffer ();
Lisp_Object read_minibuf ();

108
/* Read from the minibuffer using keymap MAP, initial contents INITIAL
Richard M. Stallman's avatar
Richard M. Stallman committed
109
   (a string), putting point minus BACKUP_N chars from the end of INITIAL,
110
   prompting with PROMPT (a string), using history list HISTVAR
Richard M. Stallman's avatar
Richard M. Stallman committed
111
   with initial position HISTPOS.  (BACKUP_N should be <= 0.)
112 113

   Normally return the result as a string (the text that was read),
114
   but if EXPFLAG is nonzero, read it and return the object read.
115 116
   If HISTVAR is given, save the value read on that history only if it doesn't
   match the front of that history list exactly.  The value is pushed onto
Karl Heuer's avatar
Karl Heuer committed
117
   the list as the string that was read.  */
118

Jim Blandy's avatar
Jim Blandy committed
119
Lisp_Object
120
read_minibuf (map, initial, prompt, backup_n, expflag, histvar, histpos)
Jim Blandy's avatar
Jim Blandy committed
121 122 123
     Lisp_Object map;
     Lisp_Object initial;
     Lisp_Object prompt;
124
     Lisp_Object backup_n;
Jim Blandy's avatar
Jim Blandy committed
125
     int expflag;
126 127
     Lisp_Object histvar;
     Lisp_Object histpos;
Jim Blandy's avatar
Jim Blandy committed
128 129 130
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;
131
  Lisp_Object mini_frame;
Jim Blandy's avatar
Jim Blandy committed
132

133
  if (!STRINGP (prompt))
Jim Blandy's avatar
Jim Blandy committed
134 135 136
    prompt = build_string ("");

  /* Emacs in -batch mode calls minibuffer: print the prompt.  */
137
  if (noninteractive && STRINGP (prompt))
Jim Blandy's avatar
Jim Blandy committed
138 139 140 141 142 143
    printf ("%s", XSTRING (prompt)->data);

  if (!enable_recursive_minibuffers
      && minibuf_level > 0
      && (EQ (selected_window, minibuf_window)))
#if 0
Jim Blandy's avatar
Jim Blandy committed
144
	  || selected_frame != XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)))
Jim Blandy's avatar
Jim Blandy committed
145 146 147
#endif
    error ("Command attempted to use minibuffer while in minibuffer");

148 149 150 151 152 153 154 155 156
  /* Could we simply bind these variables instead?  */
  minibuf_save_list
    = Fcons (minibuf_prompt,
	     Fcons (make_number (minibuf_prompt_width),
		    Fcons (Vhelp_form,
			   Fcons (Vcurrent_prefix_arg,
				  Fcons (Vminibuffer_history_position,
					 Fcons (Vminibuffer_history_variable,
						minibuf_save_list))))));
Jim Blandy's avatar
Jim Blandy committed
157 158 159
  minibuf_prompt_width = 0;

  record_unwind_protect (Fset_window_configuration,
Jim Blandy's avatar
Jim Blandy committed
160 161
			 Fcurrent_window_configuration (Qnil));

Jim Blandy's avatar
Jim Blandy committed
162 163
  /* If the minibuffer window is on a different frame, save that
     frame's configuration too.  */
164
#ifdef MULTI_FRAME
165
  mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
Jim Blandy's avatar
Jim Blandy committed
166
  if (XFRAME (mini_frame) != selected_frame)
167 168
    record_unwind_protect (Fset_window_configuration,
			   Fcurrent_window_configuration (mini_frame));
169 170 171 172 173

  /* If the minibuffer is on an iconified or invisible frame,
     make it visible now.  */
  Fmake_frame_visible (mini_frame);

174 175
  if (minibuffer_auto_raise)
    Fraise_frame (mini_frame);
176
#endif
Jim Blandy's avatar
Jim Blandy committed
177 178 179

  val = current_buffer->directory;
  Fset_buffer (get_minibuffer (minibuf_level));
180 181 182 183 184 185 186 187 188

  /* The current buffer's default directory is usually the right thing
     for our minibuffer here.  However, if you're typing a command at
     a minibuffer-only frame when minibuf_level is zero, then buf IS
     the current_buffer, so reset_buffer leaves buf's default
     directory unchanged.  This is a bummer when you've just started
     up Emacs and buf's default directory is Qnil.  Here's a hack; can
     you think of something better to do?  Find another buffer with a
     better directory, and use that one instead.  */
189
  if (STRINGP (val))
190 191 192 193 194 195 196 197 198
    current_buffer->directory = val;
  else
    {
      Lisp_Object buf_list;

      for (buf_list = Vbuffer_alist;
	   CONSP (buf_list);
	   buf_list = XCONS (buf_list)->cdr)
	{
199
	  Lisp_Object other_buf;
200

201
	  other_buf = XCONS (XCONS (buf_list)->car)->cdr;
202
	  if (STRINGP (XBUFFER (other_buf)->directory))
203 204 205 206 207 208 209
	    {
	      current_buffer->directory = XBUFFER (other_buf)->directory;
	      break;
	    }
	}
    }

210
#ifdef MULTI_FRAME
211 212
  if (XFRAME (mini_frame) != selected_frame)
    Fredirect_frame_focus (Fselected_frame (), mini_frame);
213
#endif
Jim Blandy's avatar
Jim Blandy committed
214 215 216
  Fmake_local_variable (Qprint_escape_newlines);
  print_escape_newlines = 1;

Jim Blandy's avatar
Jim Blandy committed
217 218
  record_unwind_protect (read_minibuf_unwind, Qnil);

Jim Blandy's avatar
Jim Blandy committed
219 220 221
  Vminibuf_scroll_window = selected_window;
  Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
  Fselect_window (minibuf_window);
222
  XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
Jim Blandy's avatar
Jim Blandy committed
223 224 225 226

  Ferase_buffer ();
  minibuf_level++;

Jim Blandy's avatar
Jim Blandy committed
227
  if (!NILP (initial))
Jim Blandy's avatar
Jim Blandy committed
228 229
    {
      Finsert (1, &initial);
230
      if (!NILP (backup_n) && INTEGERP (backup_n))
Jim Blandy's avatar
Jim Blandy committed
231 232 233
	Fforward_char (backup_n);
    }

234
  minibuf_prompt = Fcopy_sequence (prompt);
Jim Blandy's avatar
Jim Blandy committed
235
  echo_area_glyphs = 0;
236 237
  /* This is in case the minibuffer-setup-hook calls Fsit_for.  */
  previous_echo_glyphs = 0;
Jim Blandy's avatar
Jim Blandy committed
238 239 240

  Vhelp_form = Vminibuffer_help_form;
  current_buffer->keymap = map;
241 242
  Vminibuffer_history_position = histpos;
  Vminibuffer_history_variable = histvar;
Jim Blandy's avatar
Jim Blandy committed
243

244 245 246
  /* Run our hook, but not if it is empty.
     (run-hooks would do nothing if it is empty,
     but it's important to save time here in the usual case.  */
247 248
  if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
      && !NILP (Vrun_hooks))
249 250
    call1 (Vrun_hooks, Qminibuffer_setup_hook);

Jim Blandy's avatar
Jim Blandy committed
251 252 253 254 255
/* ??? MCC did redraw_screen here if switching screens.  */
  recursive_edit_1 ();

  /* If cursor is on the minibuffer line,
     show the user we have exited by putting it in column 0.  */
Jim Blandy's avatar
Jim Blandy committed
256
  if ((FRAME_CURSOR_Y (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
257 258 259
       >= XFASTINT (XWINDOW (minibuf_window)->top))
      && !noninteractive)
    {
Jim Blandy's avatar
Jim Blandy committed
260 261
      FRAME_CURSOR_X (selected_frame) = 0;
      update_frame (selected_frame, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
262 263 264
    }

  /* Make minibuffer contents into a string */
Jim Blandy's avatar
Jim Blandy committed
265
  val = make_buffer_string (1, Z);
Jim Blandy's avatar
Jim Blandy committed
266
  bcopy (GAP_END_ADDR, XSTRING (val)->data + GPT - BEG, Z - GPT);
267

268 269 270
  /* VAL is the string of minibuffer text.  */
  last_minibuf_string = val;

271
  /* Add the value to the appropriate history list unless it is empty.  */
272
  if (XSTRING (val)->size != 0
273 274 275 276 277 278 279 280 281 282 283
      && SYMBOLP (Vminibuffer_history_variable)
      && ! EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
    {
      /* If the caller wanted to save the value read on a history list,
	 then do so if the value is not already the front of the list.  */
      Lisp_Object histval;
      histval = Fsymbol_value (Vminibuffer_history_variable);

      /* The value of the history variable must be a cons or nil.  Other
	 values are unacceptable.  We silently ignore these values.  */
      if (NILP (histval)
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
	  || (CONSP (histval)
	      && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
	Fset (Vminibuffer_history_variable,
	      Fcons (last_minibuf_string, histval));
    }

  /* If Lisp form desired instead of string, parse it. */
  if (expflag)
    {
      Lisp_Object expr_and_pos;
      unsigned char *p;

      expr_and_pos = Fread_from_string (val, Qnil, Qnil);
      /* Ignore trailing whitespace; any other trailing junk is an error.  */
      for (p = XSTRING (val)->data + XINT (Fcdr (expr_and_pos)); *p; p++)
	if (*p != ' ' && *p != '\t' && *p != '\n')
	  error ("Trailing garbage following expression");
      val = Fcar (expr_and_pos);
302 303
    }

304 305
  return unbind_to (count, val); /* The appropriate frame will get selected
				    in set-window-configuration.  */
Jim Blandy's avatar
Jim Blandy committed
306 307 308 309 310 311 312 313 314 315 316
}

/* Return a buffer to be used as the minibuffer at depth `depth'.
 depth = 0 is the lowest allowed argument, and that is the value
 used for nonrecursive minibuffer invocations */

Lisp_Object
get_minibuffer (depth)
     int depth;
{
  Lisp_Object tail, num, buf;
317
  char name[24];
Jim Blandy's avatar
Jim Blandy committed
318 319
  extern Lisp_Object nconc2 ();

320
  XSETFASTINT (num, depth);
Jim Blandy's avatar
Jim Blandy committed
321
  tail = Fnthcdr (num, Vminibuffer_list);
Jim Blandy's avatar
Jim Blandy committed
322
  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
323 324 325 326 327
    {
      tail = Fcons (Qnil, Qnil);
      Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
    }
  buf = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
328
  if (NILP (buf) || NILP (XBUFFER (buf)->name))
Jim Blandy's avatar
Jim Blandy committed
329 330 331
    {
      sprintf (name, " *Minibuf-%d*", depth);
      buf = Fget_buffer_create (build_string (name));
332 333 334 335 336

      /* Although the buffer's name starts with a space, undo should be
	 enabled in it.  */
      Fbuffer_enable_undo (buf);

Jim Blandy's avatar
Jim Blandy committed
337 338 339
      XCONS (tail)->car = buf;
    }
  else
340
    {
341 342
      int count = specpdl_ptr - specpdl;

343
      reset_buffer (XBUFFER (buf));
344 345 346 347
      record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
      Fset_buffer (buf);
      Fkill_all_local_variables ();
      unbind_to (count, Qnil);
348
    }
349

Jim Blandy's avatar
Jim Blandy committed
350 351 352 353 354 355 356
  return buf;
}

/* This function is called on exiting minibuffer, whether normally or not,
 and it restores the current window, buffer, etc. */

void
Jim Blandy's avatar
Jim Blandy committed
357 358
read_minibuf_unwind (data)
     Lisp_Object data;
Jim Blandy's avatar
Jim Blandy committed
359
{
360 361
  Lisp_Object old_deactivate_mark;

362 363 364 365 366 367
  /* We are exiting the minibuffer one way or the other,
     so run the hook.  */
  if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
      && !NILP (Vrun_hooks))
    call1 (Vrun_hooks, Qminibuffer_exit_hook);

Jim Blandy's avatar
Jim Blandy committed
368 369 370 371 372
  /* Erase the minibuffer we were using at this level.  */
  Fset_buffer (XWINDOW (minibuf_window)->buffer);

  /* Prevent error in erase-buffer.  */
  current_buffer->read_only = Qnil;
373 374

  old_deactivate_mark = Vdeactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
375
  Ferase_buffer ();
376
  Vdeactivate_mark = old_deactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
377 378 379 380 381 382

  /* If this was a recursive minibuffer,
     tie the minibuffer window back to the outer level minibuffer buffer */
  minibuf_level--;
  /* Make sure minibuffer window is erased, not ignored */
  windows_or_buffers_changed++;
383
  XSETFASTINT (XWINDOW (minibuf_window)->last_modified, 0);
Jim Blandy's avatar
Jim Blandy committed
384

385 386 387 388 389 390 391 392 393 394 395 396 397
  /* Restore prompt, etc from outer minibuffer */
  minibuf_prompt = Fcar (minibuf_save_list);
  minibuf_save_list = Fcdr (minibuf_save_list);
  minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
  minibuf_save_list = Fcdr (minibuf_save_list);
  Vhelp_form = Fcar (minibuf_save_list);
  minibuf_save_list = Fcdr (minibuf_save_list);
  Vcurrent_prefix_arg = Fcar (minibuf_save_list);
  minibuf_save_list = Fcdr (minibuf_save_list);
  Vminibuffer_history_position = Fcar (minibuf_save_list);
  minibuf_save_list = Fcdr (minibuf_save_list);
  Vminibuffer_history_variable = Fcar (minibuf_save_list);
  minibuf_save_list = Fcdr (minibuf_save_list);
Jim Blandy's avatar
Jim Blandy committed
398 399
}

400 401 402 403 404

/* This comment supplies the doc string for read-from-minibuffer, 
   for make-docfile to see.  We cannot put this in the real DEFUN
   due to limits in the Unix cpp.

Jim Blandy's avatar
Jim Blandy committed
405 406 407 408
DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
  "Read a string from the minibuffer, prompting with string PROMPT.\n\
If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
  to be inserted into the minibuffer before reading input.\n\
409 410
  If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
  is STRING, but point is placed POSITION characters into the string.\n\
Jim Blandy's avatar
Jim Blandy committed
411 412 413 414 415
Third arg KEYMAP is a keymap to use whilst reading;\n\
  if omitted or nil, the default is `minibuffer-local-map'.\n\
If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
  and return that object:\n\
  in other words, do `(car (read-from-string INPUT-STRING))'\n\
416 417 418 419 420 421 422
Fifth arg HIST, if non-nil, specifies a history list\n\
  and optionally the initial position in the list.\n\
  It can be a symbol, which is the history list variable to use,\n\
  or it can be a cons cell (HISTVAR . HISTPOS).\n\
  In that case, HISTVAR is the history list variable to use,\n\
  and HISTPOS is the initial position (the position in the list\n\
  which INITIAL-CONTENTS corresponds to).\n\
423 424 425 426 427
  Positions are counted starting from 1 at the beginning of the list."
*/

DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
  0 /* See immediately above */)
428 429
  (prompt, initial_contents, keymap, read, hist)
     Lisp_Object prompt, initial_contents, keymap, read, hist;
Jim Blandy's avatar
Jim Blandy committed
430 431
{
  int pos = 0;
432 433
  Lisp_Object histvar, histpos, position;
  position = Qnil;
Jim Blandy's avatar
Jim Blandy committed
434 435

  CHECK_STRING (prompt, 0);
436
  if (!NILP (initial_contents))
Jim Blandy's avatar
Jim Blandy committed
437
    {
438
      if (CONSP (initial_contents))
439
	{
440 441
	  position = Fcdr (initial_contents);
	  initial_contents = Fcar (initial_contents);
442
	}
443
      CHECK_STRING (initial_contents, 1);
Jim Blandy's avatar
Jim Blandy committed
444
      if (!NILP (position))
Jim Blandy's avatar
Jim Blandy committed
445 446 447
	{
	  CHECK_NUMBER (position, 0);
	  /* Convert to distance from end of input.  */
448
	  pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
Jim Blandy's avatar
Jim Blandy committed
449 450 451
	}
    }

Jim Blandy's avatar
Jim Blandy committed
452
  if (NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
453 454 455
    keymap = Vminibuffer_local_map;
  else
    keymap = get_keymap (keymap,2);
456

457
  if (SYMBOLP (hist))
458 459 460 461 462 463 464 465 466 467 468 469
    {
      histvar = hist;
      histpos = Qnil;
    }
  else
    {
      histvar = Fcar_safe (hist);
      histpos = Fcdr_safe (hist);
    }
  if (NILP (histvar))
    histvar = Qminibuffer_history;
  if (NILP (histpos))
470
    XSETFASTINT (histpos, 0);
471

472
  return read_minibuf (keymap, initial_contents, prompt,
Richard M. Stallman's avatar
Richard M. Stallman committed
473
		       make_number (pos), !NILP (read), histvar, histpos);
Jim Blandy's avatar
Jim Blandy committed
474 475 476 477 478 479 480 481 482 483
}

DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
  "Return a Lisp object read using the minibuffer.\n\
Prompt with PROMPT.  If non-nil, optional second arg INITIAL-CONTENTS\n\
is a string to insert in the minibuffer before reading.")
  (prompt, initial_contents)
     Lisp_Object prompt, initial_contents;
{
  CHECK_STRING (prompt, 0);
Jim Blandy's avatar
Jim Blandy committed
484
  if (!NILP (initial_contents))
485
    CHECK_STRING (initial_contents, 1);
486 487
  return read_minibuf (Vminibuffer_local_map, initial_contents,
		       prompt, Qnil, 1, Qminibuffer_history, make_number (0));
Jim Blandy's avatar
Jim Blandy committed
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
}

DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
  "Return value of Lisp expression read using the minibuffer.\n\
Prompt with PROMPT.  If non-nil, optional second arg INITIAL-CONTENTS\n\
is a string to insert in the minibuffer before reading.")
  (prompt, initial_contents)
     Lisp_Object prompt, initial_contents;
{
  return Feval (Fread_minibuffer (prompt, initial_contents));
}

/* Functions that use the minibuffer to read various things. */

DEFUN ("read-string", Fread_string, Sread_string, 1, 2, 0,
  "Read a string from the minibuffer, prompting with string PROMPT.\n\
If non-nil second arg INITIAL-INPUT is a string to insert before reading.")
  (prompt, initial_input)
     Lisp_Object prompt, initial_input;
{
  return Fread_from_minibuffer (prompt, initial_input, Qnil, Qnil, Qnil);
}

511
DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
512 513 514 515 516 517
  "Args PROMPT and INIT, strings.  Read a string from the terminal, not allowing blanks.\n\
Prompt with PROMPT, and provide INIT as an initial value of the input string.")
  (prompt, init)
     Lisp_Object prompt, init;
{
  CHECK_STRING (prompt, 0);
Jim Blandy's avatar
Jim Blandy committed
518
  if (! NILP (init))
Jim Blandy's avatar
Jim Blandy committed
519 520
    CHECK_STRING (init, 1);

521 522
  return read_minibuf (Vminibuffer_local_ns_map, init, prompt, Qnil, 0,
		       Qminibuffer_history, make_number (0));
Jim Blandy's avatar
Jim Blandy committed
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
}

DEFUN ("read-command", Fread_command, Sread_command, 1, 1, 0,
  "One arg PROMPT, a string.  Read the name of a command and return as a symbol.\n\
Prompts with PROMPT.")
  (prompt)
     Lisp_Object prompt;
{
  return Fintern (Fcompleting_read (prompt, Vobarray, Qcommandp, Qt, Qnil, Qnil),
		  Qnil);
}

#ifdef NOTDEF
DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
  "One arg PROMPT, a string.  Read the name of a function and return as a symbol.\n\
Prompts with PROMPT.")
  (prompt)
     Lisp_Object prompt;
{
  return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil),
		  Qnil);
}
#endif /* NOTDEF */

DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 1, 0,
  "One arg PROMPT, a string.  Read the name of a user variable and return\n\
it as a symbol.  Prompts with PROMPT.\n\
A user variable is one whose documentation starts with a `*' character.")
  (prompt)
     Lisp_Object prompt;
{
  return Fintern (Fcompleting_read (prompt, Vobarray,
				    Quser_variable_p, Qt, Qnil, Qnil),
		  Qnil);
}

DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
  "One arg PROMPT, a string.  Read the name of a buffer and return as a string.\n\
Prompts with PROMPT.\n\
Optional second arg is value to return if user enters an empty line.\n\
If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
  (prompt, def, require_match)
     Lisp_Object prompt, def, require_match;
{
  Lisp_Object tem;
  Lisp_Object args[3];
  struct gcpro gcpro1;

571
  if (BUFFERP (def))
Jim Blandy's avatar
Jim Blandy committed
572
    def = XBUFFER (def)->name;
Jim Blandy's avatar
Jim Blandy committed
573
  if (!NILP (def))
Jim Blandy's avatar
Jim Blandy committed
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
    {
      args[0] = build_string ("%s(default %s) ");
      args[1] = prompt;
      args[2] = def;
      prompt = Fformat (3, args);
    }
  GCPRO1 (def);
  tem = Fcompleting_read (prompt, Vbuffer_alist, Qnil, require_match, Qnil, Qnil);
  UNGCPRO;
  if (XSTRING (tem)->size)
    return tem;
  return def;
}

DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
  "Return common substring of all completions of STRING in ALIST.\n\
Each car of each element of ALIST is tested to see if it begins with STRING.\n\
All that match are compared together; the longest initial sequence\n\
common to all matches is returned as a string.\n\
If there is no match at all, nil is returned.\n\
For an exact match, t is returned.\n\
\n\
ALIST can be an obarray instead of an alist.\n\
Then the print names of all symbols in the obarray are the possible matches.\n\
\n\
ALIST can also be a function to do the completion itself.\n\
It receives three arguments: the values STRING, PREDICATE and nil.\n\
Whatever it returns becomes the value of `try-completion'.\n\
\n\
If optional third argument PREDICATE is non-nil,\n\
it is used to test each possible match.\n\
The match is a candidate only if PREDICATE returns non-nil.\n\
The argument given to PREDICATE is the alist element or the symbol from the obarray.")
  (string, alist, pred)
     Lisp_Object string, alist, pred;
{
  Lisp_Object bestmatch, tail, elt, eltstring;
  int bestmatchsize;
  int compare, matchsize;
Jim Blandy's avatar
Jim Blandy committed
613
  int list = CONSP (alist) || NILP (alist);
Jim Blandy's avatar
Jim Blandy committed
614 615 616 617 618 619
  int index, obsize;
  int matchcount = 0;
  Lisp_Object bucket, zero, end, tem;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

  CHECK_STRING (string, 0);
620
  if (!list && !VECTORP (alist))
Jim Blandy's avatar
Jim Blandy committed
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
    return call3 (alist, string, pred, Qnil);

  bestmatch = Qnil;

  /* If ALIST is not a list, set TAIL just for gc pro.  */
  tail = alist;
  if (! list)
    {
      index = 0;
      obsize = XVECTOR (alist)->size;
      bucket = XVECTOR (alist)->contents[index];
    }

  while (1)
    {
      /* Get the next element of the alist or obarray. */
      /* Exit the loop if the elements are all used up. */
      /* elt gets the alist element or symbol.
	 eltstring gets the name to check as a completion. */

      if (list)
	{
Jim Blandy's avatar
Jim Blandy committed
643
	  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657
	    break;
	  elt = Fcar (tail);
	  eltstring = Fcar (elt);
	  tail = Fcdr (tail);
	}
      else
	{
	  if (XFASTINT (bucket) != 0)
	    {
	      elt = bucket;
	      eltstring = Fsymbol_name (elt);
	      if (XSYMBOL (bucket)->next)
		XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
	      else
658
		XSETFASTINT (bucket, 0);
Jim Blandy's avatar
Jim Blandy committed
659 660 661 662 663 664 665 666 667 668 669 670
	    }
	  else if (++index >= obsize)
	    break;
	  else
	    {
	      bucket = XVECTOR (alist)->contents[index];
	      continue;
	    }
	}

      /* Is this element a possible completion? */

671
      if (STRINGP (eltstring)
672 673 674
	  && XSTRING (string)->size <= XSTRING (eltstring)->size
	  && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
		       XSTRING (string)->size))
Jim Blandy's avatar
Jim Blandy committed
675 676
	{
	  /* Yes. */
677 678
	  Lisp_Object regexps;
	  Lisp_Object zero;
679
	  XSETFASTINT (zero, 0);
680 681 682 683 684 685 686 687 688 689 690 691

	  /* Ignore this element if it fails to match all the regexps.  */
	  for (regexps = Vcompletion_regexp_list; CONSP (regexps);
	       regexps = XCONS (regexps)->cdr)
	    {
	      tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
	      if (NILP (tem))
		break;
	    }
	  if (CONSP (regexps))
	    continue;

Jim Blandy's avatar
Jim Blandy committed
692 693 694
	  /* Ignore this element if there is a predicate
	     and the predicate doesn't like it. */

Jim Blandy's avatar
Jim Blandy committed
695
	  if (!NILP (pred))
Jim Blandy's avatar
Jim Blandy committed
696 697 698 699 700 701 702 703 704
	    {
	      if (EQ (pred, Qcommandp))
		tem = Fcommandp (elt);
	      else
		{
		  GCPRO4 (tail, string, eltstring, bestmatch);
		  tem = call1 (pred, elt);
		  UNGCPRO;
		}
Jim Blandy's avatar
Jim Blandy committed
705
	      if (NILP (tem)) continue;
Jim Blandy's avatar
Jim Blandy committed
706 707 708 709 710
	    }

	  /* Update computation of how much all possible completions match */

	  matchcount++;
Jim Blandy's avatar
Jim Blandy committed
711
	  if (NILP (bestmatch))
Jim Blandy's avatar
Jim Blandy committed
712 713 714 715 716 717 718
	    bestmatch = eltstring, bestmatchsize = XSTRING (eltstring)->size;
	  else
	    {
	      compare = min (bestmatchsize, XSTRING (eltstring)->size);
	      matchsize = scmp (XSTRING (bestmatch)->data,
				XSTRING (eltstring)->data,
				compare);
Jim Blandy's avatar
Jim Blandy committed
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
	      if (matchsize < 0)
		matchsize = compare;
	      if (completion_ignore_case)
		{
		  /* If this is an exact match except for case,
		     use it as the best match rather than one that is not an
		     exact match.  This way, we get the case pattern
		     of the actual match.  */
		  if ((matchsize == XSTRING (eltstring)->size
		       && matchsize < XSTRING (bestmatch)->size)
		      ||
		      /* If there is more than one exact match ignoring case,
			 and one of them is exact including case,
			 prefer that one.  */
		      /* If there is no exact match ignoring case,
			 prefer a match that does not change the case
			 of the input.  */
		      ((matchsize == XSTRING (eltstring)->size)
		       ==
		       (matchsize == XSTRING (bestmatch)->size)
		       && !bcmp (XSTRING (eltstring)->data,
				 XSTRING (string)->data, XSTRING (string)->size)
		       && bcmp (XSTRING (bestmatch)->data,
				XSTRING (string)->data, XSTRING (string)->size)))
		    bestmatch = eltstring;
		}
	      bestmatchsize = matchsize;
Jim Blandy's avatar
Jim Blandy committed
746 747 748 749
	    }
	}
    }

Jim Blandy's avatar
Jim Blandy committed
750
  if (NILP (bestmatch))
Jim Blandy's avatar
Jim Blandy committed
751
    return Qnil;		/* No completions found */
Jim Blandy's avatar
Jim Blandy committed
752 753 754 755 756 757 758 759 760 761 762 763
  /* If we are ignoring case, and there is no exact match,
     and no additional text was supplied,
     don't change the case of what the user typed.  */
  if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
      && XSTRING (bestmatch)->size > bestmatchsize)
    return string;

  /* Return t if the supplied string is an exact match (counting case);
     it does not require any change to be made.  */
  if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
      && !bcmp (XSTRING (bestmatch)->data, XSTRING (string)->data,
		bestmatchsize))
Jim Blandy's avatar
Jim Blandy committed
764 765
    return Qt;

766 767
  XSETFASTINT (zero, 0);		/* Else extract the part in which */
  XSETFASTINT (end, bestmatchsize);	/* all completions agree */
Jim Blandy's avatar
Jim Blandy committed
768 769 770 771 772 773 774 775
  return Fsubstring (bestmatch, zero, end);
}

/* Compare exactly LEN chars of strings at S1 and S2,
   ignoring case if appropriate.
   Return -1 if strings match,
   else number of chars that match at the beginning.  */

776
int
Jim Blandy's avatar
Jim Blandy committed
777
scmp (s1, s2, len)
778
     register unsigned char *s1, *s2;
Jim Blandy's avatar
Jim Blandy committed
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
     int len;
{
  register int l = len;

  if (completion_ignore_case)
    {
      while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
	l--;
    }
  else
    {
      while (l && *s1++ == *s2++)
	l--;
    }
  if (l == 0)
    return -1;
795 796
  else
    return len - l;
Jim Blandy's avatar
Jim Blandy committed
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
}

DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 3, 0,
  "Search for partial matches to STRING in ALIST.\n\
Each car of each element of ALIST is tested to see if it begins with STRING.\n\
The value is a list of all the strings from ALIST that match.\n\
ALIST can be an obarray instead of an alist.\n\
Then the print names of all symbols in the obarray are the possible matches.\n\
\n\
ALIST can also be a function to do the completion itself.\n\
It receives three arguments: the values STRING, PREDICATE and t.\n\
Whatever it returns becomes the value of `all-completion'.\n\
\n\
If optional third argument PREDICATE is non-nil,\n\
it is used to test each possible match.\n\
The match is a candidate only if PREDICATE returns non-nil.\n\
The argument given to PREDICATE is the alist element or the symbol from the obarray.")
  (string, alist, pred)
     Lisp_Object string, alist, pred;
{
  Lisp_Object tail, elt, eltstring;
  Lisp_Object allmatches;
Jim Blandy's avatar
Jim Blandy committed
819
  int list = CONSP (alist) || NILP (alist);
Jim Blandy's avatar
Jim Blandy committed
820 821 822 823 824
  int index, obsize;
  Lisp_Object bucket, tem;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

  CHECK_STRING (string, 0);
825
  if (!list && !VECTORP (alist))
Jim Blandy's avatar
Jim Blandy committed
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
    {
      return call3 (alist, string, pred, Qt);
    }
  allmatches = Qnil;

  /* If ALIST is not a list, set TAIL just for gc pro.  */
  tail = alist;
  if (! list)
    {
      index = 0;
      obsize = XVECTOR (alist)->size;
      bucket = XVECTOR (alist)->contents[index];
    }

  while (1)
    {
      /* Get the next element of the alist or obarray. */
      /* Exit the loop if the elements are all used up. */
      /* elt gets the alist element or symbol.
	 eltstring gets the name to check as a completion. */

      if (list)
	{
Jim Blandy's avatar
Jim Blandy committed
849
	  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
850 851 852 853 854 855 856 857 858 859 860 861 862 863
	    break;
	  elt = Fcar (tail);
	  eltstring = Fcar (elt);
	  tail = Fcdr (tail);
	}
      else
	{
	  if (XFASTINT (bucket) != 0)
	    {
	      elt = bucket;
	      eltstring = Fsymbol_name (elt);
	      if (XSYMBOL (bucket)->next)
		XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
	      else
864
		XSETFASTINT (bucket, 0);
Jim Blandy's avatar
Jim Blandy committed
865 866 867 868 869 870 871 872 873 874 875 876
	    }
	  else if (++index >= obsize)
	    break;
	  else
	    {
	      bucket = XVECTOR (alist)->contents[index];
	      continue;
	    }
	}

      /* Is this element a possible completion? */

877
      if (STRINGP (eltstring)
878 879 880 881 882 883 884
	  && XSTRING (string)->size <= XSTRING (eltstring)->size
	  /* Reject alternatives that start with space
	     unless the input starts with space.  */
	  && ((XSTRING (string)->size > 0 && XSTRING (string)->data[0] == ' ')
	      || XSTRING (eltstring)->data[0] != ' ')
	  && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
		       XSTRING (string)->size))
Jim Blandy's avatar
Jim Blandy committed
885 886
	{
	  /* Yes. */
887 888
	  Lisp_Object regexps;
	  Lisp_Object zero;
889
	  XSETFASTINT (zero, 0);
890 891 892 893 894 895 896 897 898 899 900 901

	  /* Ignore this element if it fails to match all the regexps.  */
	  for (regexps = Vcompletion_regexp_list; CONSP (regexps);
	       regexps = XCONS (regexps)->cdr)
	    {
	      tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
	      if (NILP (tem))
		break;
	    }
	  if (CONSP (regexps))
	    continue;

Jim Blandy's avatar
Jim Blandy committed
902 903 904
	  /* Ignore this element if there is a predicate
	     and the predicate doesn't like it. */

Jim Blandy's avatar
Jim Blandy committed
905
	  if (!NILP (pred))
Jim Blandy's avatar
Jim Blandy committed
906 907 908 909 910 911 912 913 914
	    {
	      if (EQ (pred, Qcommandp))
		tem = Fcommandp (elt);
	      else
		{
		  GCPRO4 (tail, eltstring, allmatches, string);
		  tem = call1 (pred, elt);
		  UNGCPRO;
		}
Jim Blandy's avatar
Jim Blandy committed
915
	      if (NILP (tem)) continue;
Jim Blandy's avatar
Jim Blandy committed
916 917 918 919 920 921 922 923 924 925 926 927 928
	    }
	  /* Ok => put it on the list. */
	  allmatches = Fcons (eltstring, allmatches);
	}
    }

  return Fnreverse (allmatches);
}

Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;

929 930 931 932
/* This comment supplies the doc string for completing-read,
   for make-docfile to see.  We cannot put this in the real DEFUN
   due to limits in the Unix cpp.

Jim Blandy's avatar
Jim Blandy committed
933 934
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
  "Read a string in the minibuffer, with completion.\n\
935
Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, HIST.\n\
Jim Blandy's avatar
Jim Blandy committed
936 937 938
PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
TABLE is an alist whose elements' cars are strings, or an obarray.\n\
PREDICATE limits completion to a subset of TABLE.\n\
939 940
See `try-completion' and `all-completions' for more details
 on completion, TABLE, and PREDICATE.\n\
941
\n\
Jim Blandy's avatar
Jim Blandy committed
942
If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
943
 the input is (or completes to) an element of TABLE or is null.\n\
Jim Blandy's avatar
Jim Blandy committed
944
 If it is also not t, Return does not exit if it does non-null completion.\n\
945 946 947
If the input is null, `completing-read' returns nil,\n\
 regardless of the value of REQUIRE-MATCH.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
948
If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
949 950 951 952 953 954 955 956 957 958 959
  If it is (STRING . POSITION), the initial input\n\
  is STRING, but point is placed POSITION characters into the string.\n\
HIST, if non-nil, specifies a history list\n\
  and optionally the initial position in the list.\n\
  It can be a symbol, which is the history list variable to use,\n\
  or it can be a cons cell (HISTVAR . HISTPOS).\n\
  In that case, HISTVAR is the history list variable to use,\n\
  and HISTPOS is the initial position (the position in the list\n\
  which INITIAL-CONTENTS corresponds to).\n\
  Positions are counted starting from 1 at the beginning of the list.\n\
Completion ignores case if the ambient value of\n\
960 961 962 963
  `completion-ignore-case' is non-nil."
*/
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
  0 /* See immediately above */)
964 965
  (prompt, table, pred, require_match, init, hist)
     Lisp_Object prompt, table, pred, require_match, init, hist;
Jim Blandy's avatar
Jim Blandy committed
966
{
967 968
  Lisp_Object val, histvar, histpos, position;
  int pos = 0;
Jim Blandy's avatar
Jim Blandy committed
969 970 971 972 973 974
  int count = specpdl_ptr - specpdl;
  specbind (Qminibuffer_completion_table, table);
  specbind (Qminibuffer_completion_predicate, pred);
  specbind (Qminibuffer_completion_confirm,
	    EQ (require_match, Qt) ? Qnil : Qt);
  last_exact_completion = Qnil;
975 976 977 978

  position = Qnil;
  if (!NILP (init))
    {
979
      if (CONSP (init))
980 981 982 983 984 985 986 987 988
	{
	  position = Fcdr (init);
	  init = Fcar (init);
	}
      CHECK_STRING (init, 0);
      if (!NILP (position))
	{
	  CHECK_NUMBER (position, 0);
	  /* Convert to distance from end of input.  */
989
	  pos = XINT (position) - XSTRING (init)->size;
990 991 992
	}
    }

993
  if (SYMBOLP (hist))
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
    {
      histvar = hist;
      histpos = Qnil;
    }
  else
    {
      histvar = Fcar_safe (hist);
      histpos = Fcdr_safe (hist);
    }
  if (NILP (histvar))
    histvar = Qminibuffer_history;
  if (NILP (histpos))
1006
    XSETFASTINT (histpos, 0);
1007

Jim Blandy's avatar
Jim Blandy committed
1008
  val = read_minibuf (NILP (require_match)
Jim Blandy's avatar
Jim Blandy committed
1009 1010
		      ? Vminibuffer_local_completion_map
		      : Vminibuffer_local_must_match_map,
Richard M. Stallman's avatar
Richard M. Stallman committed
1011
		      init, prompt, make_number (pos), 0,
1012
		      histvar, histpos);
Jim Blandy's avatar
Jim Blandy committed
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
  return unbind_to (count, val);
}

/* Temporarily display the string M at the end of the current
   minibuffer contents.  This is used to display things like
   "[No Match]" when the user requests a completion for a prefix
   that has no possible completions, and other quick, unobtrusive
   messages.  */

temp_echo_area_glyphs (m)
     char *m;
{
  int osize = ZV;
  Lisp_Object oinhibit;
  oinhibit = Vinhibit_quit;

1029 1030
  /* Clear out any old echo-area message to make way for our new thing.  */
  message (0);
Jim Blandy's avatar
Jim Blandy committed
1031 1032 1033 1034 1035 1036

  SET_PT (osize);
  insert_string (m);
  SET_PT (osize);
  Vinhibit_quit = Qt;
  Fsit_for (make_number (2), Qnil, Qnil);
1037
  del_range (PT, ZV);
Jim Blandy's avatar
Jim Blandy committed
1038
  if (!NILP (Vquit_flag))
Jim Blandy's avatar
Jim Blandy committed
1039 1040
    {
      Vquit_flag = Qnil;
1041
      Vunread_command_events = Fcons (make_number (quit_char), Qnil);
Jim Blandy's avatar
Jim Blandy committed
1042 1043 1044 1045 1046
    }
  Vinhibit_quit = oinhibit;
}

Lisp_Object Fminibuffer_completion_help ();
Jim Blandy's avatar
Jim Blandy committed
1047
Lisp_Object assoc_for_completion ();
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
/* A subroutine of Fintern_soft.  */
extern Lisp_Object oblookup ();


/* Test whether TXT is an exact completion.  */
Lisp_Object
test_completion (txt)
     Lisp_Object txt;
{
  Lisp_Object tem;

  if (CONSP (Vminibuffer_completion_table)
      || NILP (Vminibuffer_completion_table))
    return assoc_for_completion (txt, Vminibuffer_completion_table);
  else if (VECTORP (Vminibuffer_completion_table))
    {
      /* Bypass intern-soft as that loses for nil */
      tem = oblookup (Vminibuffer_completion_table,
		      XSTRING (txt)->data, XSTRING (txt)->size);
1067
      if (!SYMBOLP (tem))
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
	return Qnil;
      else if (!NILP (Vminibuffer_completion_predicate))
	return call1 (Vminibuffer_completion_predicate, tem);
      else
	return Qt;
    }
  else
    return call3 (Vminibuffer_completion_table, txt,
		  Vminibuffer_completion_predicate, Qlambda);
}
Jim Blandy's avatar
Jim Blandy committed
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092

/* returns:
 * 0 no possible completion
 * 1 was already an exact and unique completion
 * 3 was already an exact completion
 * 4 completed to an exact completion
 * 5 some completion happened
 * 6 no completion happened
 */
int
do_completion ()
{
  Lisp_Object completion, tem;
  int completedp;
  Lisp_Object last;
1093
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
1094 1095 1096 1097 1098 1099

  completion = Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table,
				Vminibuffer_completion_predicate);
  last = last_exact_completion;
  last_exact_completion = Qnil;

1100 1101
  GCPRO2 (completion, last);

Jim Blandy's avatar
Jim Blandy committed
1102
  if (NILP (completion))
Jim Blandy's avatar
Jim Blandy committed
1103 1104 1105
    {
      bitch_at_user ();
      temp_echo_area_glyphs (" [No match]");
1106
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1107 1108 1109 1110
      return 0;
    }

  if (EQ (completion, Qt))	/* exact and unique match */
1111 1112 1113 1114
    {
      UNGCPRO;
      return 1;
    }
Jim Blandy's avatar
Jim Blandy committed
1115 1116 1117

  /* compiler bug */
  tem = Fstring_equal (completion, Fbuffer_string());
Jim Blandy's avatar
Jim Blandy committed
1118
  if (completedp = NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1119 1120 1121 1122 1123 1124
    {
      Ferase_buffer ();		/* Some completion happened */
      Finsert (1, &completion);
    }

  /* It did find a match.  Do we match some possibility exactly now? */
1125
  tem = test_completion (Fbuffer_string ());
Jim Blandy's avatar
Jim Blandy committed
1126
  if (NILP (tem))
1127 1128 1129
    {
      /* not an exact match */
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1130 1131 1132 1133 1134 1135 1136 1137 1138
      if (completedp)
	return 5;
      else if (auto_help)
	Fminibuffer_completion_help ();
      else
	temp_echo_area_glyphs (" [Next char not unique]");
      return 6;
    }
  else if (completedp)
1139 1140 1141 1142
    {
      UNGCPRO;
      return 4;
    }
Jim Blandy's avatar
Jim Blandy committed
1143 1144
  /* If the last exact completion and this one were the same,
     it means we've already given a "Complete but not unique"
Jim Blandy's avatar
Jim Blandy committed
1145
     message and the user's hit TAB again, so now we give him help.  */
Jim Blandy's avatar
Jim Blandy committed
1146
  last_exact_completion = completion;
Jim Blandy's avatar
Jim Blandy committed
1147
  if (!NILP (last))
Jim Blandy's avatar
Jim Blandy committed
1148 1149
    {
      tem = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
1150
      if (!NILP (Fequal (tem, last)))
Jim Blandy's avatar
Jim Blandy committed
1151 1152
	Fminibuffer_completion_help ();
    }
1153
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1154 1155
  return 3;
}
1156

Jim Blandy's avatar
Jim Blandy committed
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
/* Like assoc but assumes KEY is a string, and ignores case if appropriate.  */

Lisp_Object
assoc_for_completion (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;

  if (completion_ignore_case)
    key = Fupcase (key);

Jim Blandy's avatar
Jim Blandy committed
1169
  for (tail = list; !NILP (tail); tail = Fcdr (tail))
Jim Blandy's avatar
Jim Blandy committed
1170 1171 1172 1173 1174
    {
      register Lisp_Object elt, tem, thiscar;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
      thiscar = Fcar (elt);
1175
      if (!STRINGP (thiscar))
Jim Blandy's avatar
Jim Blandy committed
1176 1177 1178 1179
	continue;
      if (completion_ignore_case)
	thiscar = Fupcase (thiscar);
      tem = Fequal (thiscar, key);
Jim Blandy's avatar
Jim Blandy committed
1180
      if (!NILP (tem)) return elt;
Jim Blandy's avatar
Jim Blandy committed
1181 1182 1183 1184
      QUIT;
    }
  return Qnil;
}
Jim Blandy's avatar
Jim Blandy committed