minibuf.c 55.3 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Minibuffer input and completion.
2
   Copyright (C) 1985, 1986, 1993, 1994, 1995 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
#include "window.h"
#include "syntax.h"
29
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
30 31 32

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

33 34
extern int quit_char;

Jim Blandy's avatar
Jim Blandy committed
35
/* List of buffers for use as minibuffers.
36 37 38 39
   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
40 41
Lisp_Object Vminibuffer_list;

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

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

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

51
/* Fread_minibuffer leaves the input here as a string. */
Jim Blandy's avatar
Jim Blandy committed
52 53 54 55 56 57 58 59 60 61
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;

62 63 64 65 66 67 68 69 70 71
/* 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;

72 73
Lisp_Object Qread_file_name_internal;

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

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

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

int completion_ignore_case;

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

Lisp_Object Vcompletion_regexp_list;

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

int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
92 93 94 95 96 97
/* 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;
98 99 100 101

/* Non-nil means it is the window for C-M-v to scroll
   when the minibuffer is selected.  */
extern Lisp_Object Vminibuf_scroll_window;
102 103

extern Lisp_Object Voverriding_local_map;
Jim Blandy's avatar
Jim Blandy committed
104 105 106 107 108 109 110

/* Actual minibuffer invocation. */

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

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

   Normally return the result as a string (the text that was read),
117
   but if EXPFLAG is nonzero, read it and return the object read.
118 119
   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
120
   the list as the string that was read.  */
121

Jim Blandy's avatar
Jim Blandy committed
122
Lisp_Object
123
read_minibuf (map, initial, prompt, backup_n, expflag, histvar, histpos)
Jim Blandy's avatar
Jim Blandy committed
124 125 126
     Lisp_Object map;
     Lisp_Object initial;
     Lisp_Object prompt;
127
     Lisp_Object backup_n;
Jim Blandy's avatar
Jim Blandy committed
128
     int expflag;
129 130
     Lisp_Object histvar;
     Lisp_Object histpos;
Jim Blandy's avatar
Jim Blandy committed
131
{
132
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
133
  int count = specpdl_ptr - specpdl;
134
  Lisp_Object mini_frame;
135 136
  struct gcpro gcpro1, gcpro2, gcpro3;

137
  single_kboard_state ();
138

139 140 141 142 143
  val = Qnil;
  /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
     store them away before we can GC.  Don't need to protect
     BACKUP_N because we use the value only if it is an integer.  */
  GCPRO3 (map, initial, val);
Jim Blandy's avatar
Jim Blandy committed
144

145
  if (!STRINGP (prompt))
Jim Blandy's avatar
Jim Blandy committed
146 147 148 149 150 151 152
    prompt = build_string ("");

  if (!enable_recursive_minibuffers
      && minibuf_level > 0
      && (EQ (selected_window, minibuf_window)))
    error ("Command attempted to use minibuffer while in minibuffer");

153
  /* Could we simply bind these variables instead?  */
154 155 156
  minibuf_save_list
    = Fcons (Voverriding_local_map,
	     Fcons (minibuf_window, minibuf_save_list));
157 158 159 160
  minibuf_save_list
    = Fcons (minibuf_prompt,
	     Fcons (make_number (minibuf_prompt_width),
		    Fcons (Vhelp_form,
161
			   Fcons (Vcurrent_prefix_arg,
162 163
				  Fcons (Vminibuffer_history_position,
					 Fcons (Vminibuffer_history_variable,
164 165
						minibuf_save_list))))));

166 167 168 169
  minibuf_prompt_width = 0;	/* xdisp.c puts in the right value.  */
  minibuf_prompt = Fcopy_sequence (prompt);
  Vminibuffer_history_position = histpos;
  Vminibuffer_history_variable = histvar;
Jim Blandy's avatar
Jim Blandy committed
170

171 172
  choose_minibuf_frame ();

Jim Blandy's avatar
Jim Blandy committed
173
  record_unwind_protect (Fset_window_configuration,
Jim Blandy's avatar
Jim Blandy committed
174 175
			 Fcurrent_window_configuration (Qnil));

Jim Blandy's avatar
Jim Blandy committed
176 177
  /* If the minibuffer window is on a different frame, save that
     frame's configuration too.  */
178
#ifdef MULTI_FRAME
179
  mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
Jim Blandy's avatar
Jim Blandy committed
180
  if (XFRAME (mini_frame) != selected_frame)
181 182
    record_unwind_protect (Fset_window_configuration,
			   Fcurrent_window_configuration (mini_frame));
183 184 185 186 187

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

188 189
  if (minibuffer_auto_raise)
    Fraise_frame (mini_frame);
190
#endif
Jim Blandy's avatar
Jim Blandy committed
191 192 193

  val = current_buffer->directory;
  Fset_buffer (get_minibuffer (minibuf_level));
194 195 196 197 198 199 200 201 202

  /* 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.  */
203
  if (STRINGP (val))
204 205 206 207 208 209 210 211 212
    current_buffer->directory = val;
  else
    {
      Lisp_Object buf_list;

      for (buf_list = Vbuffer_alist;
	   CONSP (buf_list);
	   buf_list = XCONS (buf_list)->cdr)
	{
213
	  Lisp_Object other_buf;
214

215
	  other_buf = XCONS (XCONS (buf_list)->car)->cdr;
216
	  if (STRINGP (XBUFFER (other_buf)->directory))
217 218 219 220 221 222 223
	    {
	      current_buffer->directory = XBUFFER (other_buf)->directory;
	      break;
	    }
	}
    }

224
#ifdef MULTI_FRAME
225 226
  if (XFRAME (mini_frame) != selected_frame)
    Fredirect_frame_focus (Fselected_frame (), mini_frame);
227
#endif
Jim Blandy's avatar
Jim Blandy committed
228 229 230
  Fmake_local_variable (Qprint_escape_newlines);
  print_escape_newlines = 1;

Jim Blandy's avatar
Jim Blandy committed
231 232
  record_unwind_protect (read_minibuf_unwind, Qnil);

Jim Blandy's avatar
Jim Blandy committed
233 234 235
  Vminibuf_scroll_window = selected_window;
  Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
  Fselect_window (minibuf_window);
236
  XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
Jim Blandy's avatar
Jim Blandy committed
237 238 239 240

  Ferase_buffer ();
  minibuf_level++;

Jim Blandy's avatar
Jim Blandy committed
241
  if (!NILP (initial))
Jim Blandy's avatar
Jim Blandy committed
242 243
    {
      Finsert (1, &initial);
244
      if (!NILP (backup_n) && INTEGERP (backup_n))
Jim Blandy's avatar
Jim Blandy committed
245 246 247 248
	Fforward_char (backup_n);
    }

  echo_area_glyphs = 0;
249 250
  /* This is in case the minibuffer-setup-hook calls Fsit_for.  */
  previous_echo_glyphs = 0;
Jim Blandy's avatar
Jim Blandy committed
251 252 253 254

  Vhelp_form = Vminibuffer_help_form;
  current_buffer->keymap = map;

255 256 257
  /* 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.  */
258 259
  if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
      && !NILP (Vrun_hooks))
260 261
    call1 (Vrun_hooks, Qminibuffer_setup_hook);

Jim Blandy's avatar
Jim Blandy committed
262 263 264 265 266
/* ??? 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
267
  if ((FRAME_CURSOR_Y (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
268 269 270
       >= XFASTINT (XWINDOW (minibuf_window)->top))
      && !noninteractive)
    {
Jim Blandy's avatar
Jim Blandy committed
271 272
      FRAME_CURSOR_X (selected_frame) = 0;
      update_frame (selected_frame, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
273 274 275
    }

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

279 280 281
  /* VAL is the string of minibuffer text.  */
  last_minibuf_string = val;

282
  /* Add the value to the appropriate history list unless it is empty.  */
283
  if (XSTRING (val)->size != 0
284 285 286 287 288 289 290 291 292 293 294
      && 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)
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
	  || (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);
313 314
    }

315 316 317
  /* The appropriate frame will get selected
     in set-window-configuration.  */
  RETURN_UNGCPRO (unbind_to (count, val));
Jim Blandy's avatar
Jim Blandy committed
318 319 320 321 322 323 324 325 326 327 328
}

/* 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;
329
  char name[24];
Jim Blandy's avatar
Jim Blandy committed
330 331
  extern Lisp_Object nconc2 ();

332
  XSETFASTINT (num, depth);
Jim Blandy's avatar
Jim Blandy committed
333
  tail = Fnthcdr (num, Vminibuffer_list);
Jim Blandy's avatar
Jim Blandy committed
334
  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
335 336 337 338 339
    {
      tail = Fcons (Qnil, Qnil);
      Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
    }
  buf = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
340
  if (NILP (buf) || NILP (XBUFFER (buf)->name))
Jim Blandy's avatar
Jim Blandy committed
341 342 343
    {
      sprintf (name, " *Minibuf-%d*", depth);
      buf = Fget_buffer_create (build_string (name));
344 345 346 347 348

      /* 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
349 350 351
      XCONS (tail)->car = buf;
    }
  else
352
    {
353 354
      int count = specpdl_ptr - specpdl;

355
      reset_buffer (XBUFFER (buf));
356 357 358 359
      record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
      Fset_buffer (buf);
      Fkill_all_local_variables ();
      unbind_to (count, Qnil);
360
    }
361

Jim Blandy's avatar
Jim Blandy committed
362 363 364 365 366 367 368
  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
369 370
read_minibuf_unwind (data)
     Lisp_Object data;
Jim Blandy's avatar
Jim Blandy committed
371
{
372 373
  Lisp_Object old_deactivate_mark;

374 375 376 377 378 379
  /* 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
380 381 382 383 384
  /* 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;
385 386

  old_deactivate_mark = Vdeactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
387
  Ferase_buffer ();
388
  Vdeactivate_mark = old_deactivate_mark;
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393 394

  /* 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++;
395
  XSETFASTINT (XWINDOW (minibuf_window)->last_modified, 0);
Jim Blandy's avatar
Jim Blandy committed
396

397 398 399 400 401 402 403
  /* 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);
404
  Vcurrent_prefix_arg = Fcar (minibuf_save_list);
405 406 407 408 409
  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);
410
  Voverriding_local_map = Fcar (minibuf_save_list);
411 412
  minibuf_save_list = Fcdr (minibuf_save_list);
  minibuf_window = Fcar (minibuf_save_list);
413
  minibuf_save_list = Fcdr (minibuf_save_list);
Jim Blandy's avatar
Jim Blandy committed
414 415
}

416 417 418 419 420

/* 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
421 422 423 424
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\
425 426
  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
427 428 429 430 431
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\
432 433 434 435 436 437 438
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\
439 440 441 442 443
  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 */)
444 445
  (prompt, initial_contents, keymap, read, hist)
     Lisp_Object prompt, initial_contents, keymap, read, hist;
Jim Blandy's avatar
Jim Blandy committed
446 447
{
  int pos = 0;
448 449
  Lisp_Object histvar, histpos, position;
  position = Qnil;
Jim Blandy's avatar
Jim Blandy committed
450 451

  CHECK_STRING (prompt, 0);
452
  if (!NILP (initial_contents))
Jim Blandy's avatar
Jim Blandy committed
453
    {
454
      if (CONSP (initial_contents))
455
	{
456 457
	  position = Fcdr (initial_contents);
	  initial_contents = Fcar (initial_contents);
458
	}
459
      CHECK_STRING (initial_contents, 1);
Jim Blandy's avatar
Jim Blandy committed
460
      if (!NILP (position))
Jim Blandy's avatar
Jim Blandy committed
461 462 463
	{
	  CHECK_NUMBER (position, 0);
	  /* Convert to distance from end of input.  */
464
	  pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
Jim Blandy's avatar
Jim Blandy committed
465 466 467
	}
    }

Jim Blandy's avatar
Jim Blandy committed
468
  if (NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
469 470 471
    keymap = Vminibuffer_local_map;
  else
    keymap = get_keymap (keymap,2);
472

473
  if (SYMBOLP (hist))
474 475 476 477 478 479 480 481 482 483 484 485
    {
      histvar = hist;
      histpos = Qnil;
    }
  else
    {
      histvar = Fcar_safe (hist);
      histpos = Fcdr_safe (hist);
    }
  if (NILP (histvar))
    histvar = Qminibuffer_history;
  if (NILP (histpos))
486
    XSETFASTINT (histpos, 0);
487

488
  return read_minibuf (keymap, initial_contents, prompt,
Richard M. Stallman's avatar
Richard M. Stallman committed
489
		       make_number (pos), !NILP (read), histvar, histpos);
Jim Blandy's avatar
Jim Blandy committed
490 491 492 493 494 495 496 497 498 499
}

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
500
  if (!NILP (initial_contents))
501
    CHECK_STRING (initial_contents, 1);
502 503
  return read_minibuf (Vminibuffer_local_map, initial_contents,
		       prompt, Qnil, 1, Qminibuffer_history, make_number (0));
Jim Blandy's avatar
Jim Blandy committed
504 505 506 507 508 509 510 511 512 513 514 515 516 517
}

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. */

518
DEFUN ("read-string", Fread_string, Sread_string, 1, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
519
  "Read a string from the minibuffer, prompting with string PROMPT.\n\
520 521 522 523 524 525
If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
The third arg HISTORY, if non-nil, specifies a history list\n\
  and optionally the initial position in the list.\n\
See `read-from-minibuffer' for details of HISTORY argument.")
  (prompt, initial_input, history)
     Lisp_Object prompt, initial_input, history;
Jim Blandy's avatar
Jim Blandy committed
526
{
527
  return Fread_from_minibuffer (prompt, initial_input, Qnil, Qnil, history);
Jim Blandy's avatar
Jim Blandy committed
528 529
}

530
DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
531 532 533 534 535 536
  "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
537
  if (! NILP (init))
Jim Blandy's avatar
Jim Blandy committed
538 539
    CHECK_STRING (init, 1);

540 541
  return read_minibuf (Vminibuffer_local_ns_map, init, prompt, Qnil, 0,
		       Qminibuffer_history, make_number (0));
Jim Blandy's avatar
Jim Blandy committed
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 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
}

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;

590
  if (BUFFERP (def))
Jim Blandy's avatar
Jim Blandy committed
591
    def = XBUFFER (def)->name;
Jim Blandy's avatar
Jim Blandy committed
592
  if (!NILP (def))
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
    {
      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\
625 626
The argument given to PREDICATE is the alist element\n\
or the symbol from the obarray.")
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630 631 632
  (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
633
  int list = CONSP (alist) || NILP (alist);
Jim Blandy's avatar
Jim Blandy committed
634 635 636 637 638 639
  int index, obsize;
  int matchcount = 0;
  Lisp_Object bucket, zero, end, tem;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

  CHECK_STRING (string, 0);
640
  if (!list && !VECTORP (alist))
Jim Blandy's avatar
Jim Blandy committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
    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
663
	  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
664 665 666 667 668 669 670 671 672 673 674 675 676 677
	    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
678
		XSETFASTINT (bucket, 0);
Jim Blandy's avatar
Jim Blandy committed
679 680 681 682 683 684 685 686 687 688 689 690
	    }
	  else if (++index >= obsize)
	    break;
	  else
	    {
	      bucket = XVECTOR (alist)->contents[index];
	      continue;
	    }
	}

      /* Is this element a possible completion? */

691
      if (STRINGP (eltstring)
692 693 694
	  && XSTRING (string)->size <= XSTRING (eltstring)->size
	  && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
		       XSTRING (string)->size))
Jim Blandy's avatar
Jim Blandy committed
695 696
	{
	  /* Yes. */
697 698
	  Lisp_Object regexps;
	  Lisp_Object zero;
699
	  XSETFASTINT (zero, 0);
700 701 702 703 704 705 706 707 708 709 710 711

	  /* 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
712 713 714
	  /* Ignore this element if there is a predicate
	     and the predicate doesn't like it. */

Jim Blandy's avatar
Jim Blandy committed
715
	  if (!NILP (pred))
Jim Blandy's avatar
Jim Blandy committed
716 717 718 719 720 721 722 723 724
	    {
	      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
725
	      if (NILP (tem)) continue;
Jim Blandy's avatar
Jim Blandy committed
726 727 728 729 730
	    }

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

	  matchcount++;
Jim Blandy's avatar
Jim Blandy committed
731
	  if (NILP (bestmatch))
Jim Blandy's avatar
Jim Blandy committed
732 733 734 735 736 737 738
	    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
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
	      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
766 767 768 769
	    }
	}
    }

Jim Blandy's avatar
Jim Blandy committed
770
  if (NILP (bestmatch))
Jim Blandy's avatar
Jim Blandy committed
771
    return Qnil;		/* No completions found */
Jim Blandy's avatar
Jim Blandy committed
772 773 774 775 776 777 778 779 780 781 782 783
  /* 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
784 785
    return Qt;

786 787
  XSETFASTINT (zero, 0);		/* Else extract the part in which */
  XSETFASTINT (end, bestmatchsize);	/* all completions agree */
Jim Blandy's avatar
Jim Blandy committed
788 789 790 791 792 793 794 795
  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.  */

796
int
Jim Blandy's avatar
Jim Blandy committed
797
scmp (s1, s2, len)
798
     register unsigned char *s1, *s2;
Jim Blandy's avatar
Jim Blandy committed
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
     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;
815 816
  else
    return len - l;
Jim Blandy's avatar
Jim Blandy committed
817 818
}

819
DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
Jim Blandy's avatar
Jim Blandy committed
820 821 822
  "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\
823
\n\
Jim Blandy's avatar
Jim Blandy committed
824 825 826 827 828 829 830 831 832 833
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\
834 835 836 837 838 839 840 841
The argument given to PREDICATE is the alist element\n\
or the symbol from the obarray.\n\
\n\
If the optional fourth argument HIDE-SPACES is non-nil,\n\
strings in ALIST that start with a space\n\
are ignored unless STRING itself starts with a space.")
  (string, alist, pred, hide_spaces)
     Lisp_Object string, alist, pred, hide_spaces;
Jim Blandy's avatar
Jim Blandy committed
842 843 844
{
  Lisp_Object tail, elt, eltstring;
  Lisp_Object allmatches;
Jim Blandy's avatar
Jim Blandy committed
845
  int list = CONSP (alist) || NILP (alist);
Jim Blandy's avatar
Jim Blandy committed
846 847 848 849 850
  int index, obsize;
  Lisp_Object bucket, tem;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

  CHECK_STRING (string, 0);
851
  if (!list && !VECTORP (alist))
Jim Blandy's avatar
Jim Blandy committed
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
    {
      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
875
	  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
876 877 878 879 880 881 882 883 884 885 886 887 888 889
	    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
890
		XSETFASTINT (bucket, 0);
Jim Blandy's avatar
Jim Blandy committed
891 892 893 894 895 896 897 898 899 900 901 902
	    }
	  else if (++index >= obsize)
	    break;
	  else
	    {
	      bucket = XVECTOR (alist)->contents[index];
	      continue;
	    }
	}

      /* Is this element a possible completion? */

903
      if (STRINGP (eltstring)
904
	  && XSTRING (string)->size <= XSTRING (eltstring)->size
905
	  /* If HIDE_SPACES, reject alternatives that start with space
906 907
	     unless the input starts with space.  */
	  && ((XSTRING (string)->size > 0 && XSTRING (string)->data[0] == ' ')
908 909
	      || XSTRING (eltstring)->data[0] != ' '
	      || NILP (hide_spaces))
910 911
	  && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
		       XSTRING (string)->size))
Jim Blandy's avatar
Jim Blandy committed
912 913
	{
	  /* Yes. */
914 915
	  Lisp_Object regexps;
	  Lisp_Object zero;
916
	  XSETFASTINT (zero, 0);
917 918 919 920 921 922 923 924 925 926 927 928

	  /* 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
929 930 931
	  /* Ignore this element if there is a predicate
	     and the predicate doesn't like it. */

Jim Blandy's avatar
Jim Blandy committed
932
	  if (!NILP (pred))
Jim Blandy's avatar
Jim Blandy committed
933 934 935 936 937 938 939 940 941
	    {
	      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
942
	      if (NILP (tem)) continue;
Jim Blandy's avatar
Jim Blandy committed
943 944 945 946 947 948 949 950 951 952 953 954 955
	    }
	  /* 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;

956 957 958 959
/* 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
960 961
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
  "Read a string in the minibuffer, with completion.\n\
962
Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, HIST.\n\
Jim Blandy's avatar
Jim Blandy committed
963 964 965
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\
966 967
See `try-completion' and `all-completions' for more details
 on completion, TABLE, and PREDICATE.\n\
968
\n\
Jim Blandy's avatar
Jim Blandy committed
969
If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
970
 the input is (or completes to) an element of TABLE or is null.\n\
Jim Blandy's avatar
Jim Blandy committed
971
 If it is also not t, Return does not exit if it does non-null completion.\n\
972 973 974
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
975
If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
976 977 978 979 980 981 982 983 984 985 986
  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\
987 988 989 990
  `completion-ignore-case' is non-nil."
*/
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
  0 /* See immediately above */)
991 992
  (prompt, table, pred, require_match, init, hist)
     Lisp_Object prompt, table, pred, require_match, init, hist;
Jim Blandy's avatar
Jim Blandy committed
993
{
994 995
  Lisp_Object val, histvar, histpos, position;
  int pos = 0;
Jim Blandy's avatar
Jim Blandy committed
996 997 998 999 1000 1001
  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;
1002 1003 1004 1005

  position = Qnil;
  if (!NILP (init))
    {
1006
      if (CONSP (init))
1007 1008 1009 1010 1011 1012 1013 1014 1015
	{
	  position = Fcdr (init);
	  init = Fcar (init);
	}
      CHECK_STRING (init, 0);
      if (!NILP (position))
	{
	  CHECK_NUMBER (position, 0);
	  /* Convert to distance from end of input.  */
1016
	  pos = XINT (position) - XSTRING (init)->size;
1017 1018 1019
	}
    }

1020
  if (SYMBOLP (hist))
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
    {
      histvar = hist;
      histpos = Qnil;
    }
  else
    {
      histvar = Fcar_safe (hist);
      histpos = Fcdr_safe (hist);
    }
  if (NILP (histvar))
    histvar = Qminibuffer_history;
  if (NILP (histpos))
1033
    XSETFASTINT (histpos, 0);
1034

Jim Blandy's avatar
Jim Blandy committed
1035
  val = read_minibuf (NILP (require_match)
Jim Blandy's avatar
Jim Blandy committed
1036 1037
		      ? Vminibuffer_local_completion_map
		      : Vminibuffer_local_must_match_map,
Richard M. Stallman's avatar
Richard M. Stallman committed
1038
		      init, prompt, make_number (pos), 0,
1039
		      histvar, histpos);
Jim Blandy's avatar
Jim Blandy committed
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
  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;

1056 1057
  /* Clear out any old echo-area message to make way for our new thing.  */
  message (0);
Jim Blandy's avatar
Jim Blandy committed
1058 1059 1060 1061 1062 1063

  SET_PT (osize);
  insert_string (m);
  SET_PT (osize);
  Vinhibit_quit = Qt;
  Fsit_for (make_number (2), Qnil, Qnil);
1064
  del_range (PT, ZV);
Jim Blandy's avatar
Jim Blandy committed
1065
  if (!NILP (Vquit_flag))
Jim Blandy's avatar
Jim Blandy committed
1066 1067
    {
      Vquit_flag = Qnil;
1068
      Vunread_command_events = Fcons (make_number (quit_char), Qnil);
Jim Blandy's avatar
Jim Blandy committed
1069 1070 1071 1072 1073
    }
  Vinhibit_quit = oinhibit;
}

Lisp_Object Fminibuffer_completion_help ();
Jim Blandy's avatar
Jim Blandy committed
1074
Lisp_Object assoc_for_completion ();
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
/* 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);
1094
      if (!SYMBOLP (tem))
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
	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
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119

/* 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;
1120
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
1121 1122 1123 1124 1125 1126

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

1127 1128
  GCPRO2 (completion, last);

Jim Blandy's avatar
Jim Blandy committed
1129
  if (NILP (completion))
Jim Blandy's avatar
Jim Blandy committed
1130 1131 1132
    {
      bitch_at_user ();
      temp_echo_area_glyphs (" [No match]");
1133
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1134 1135 1136 1137
      return 0;
    }

  if (EQ (completion, Qt))	/* exact and unique match */
1138 1139 1140 1141
    {
      UNGCPRO;
      return 1;
    }
Jim Blandy's avatar
Jim Blandy committed
1142 1143 1144

  /* compiler bug */
  tem = Fstring_equal (completion, Fbuffer_string());
Jim Blandy's avatar
Jim Blandy committed
1145
  if (completedp = NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1146 1147 1148 1149 1150 1151
    {
      Ferase_buffer ();		/* Some completion happened */
      Finsert (1, &completion);
    }

  /* It did find a match.  Do we match some possibility exactly now? */