minibuf.c 52.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Minibuffer input and completion.
Jim Blandy's avatar
Jim Blandy committed
2
   Copyright (C) 1985, 1986, 1993 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 35 36 37 38 39 40 41 42 43 44 45
/* List of buffers for use as minibuffers.
  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 deeped minibuffer recursions are encountered. */
Lisp_Object Vminibuffer_list;

struct minibuf_save_data
  {
    char *prompt;
    int prompt_width;
    Lisp_Object help_form;
    Lisp_Object current_prefix_arg;
46 47
    Lisp_Object history_position;
    Lisp_Object history_variable;
Jim Blandy's avatar
Jim Blandy committed
48 49 50 51 52 53 54 55 56 57 58
  };

int minibuf_save_vector_size;
struct minibuf_save_data *minibuf_save_vector;

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

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

59
/* Fread_minibuffer leaves the input here as a string. */
Jim Blandy's avatar
Jim Blandy committed
60 61 62 63 64 65 66 67 68 69
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;

70 71 72 73 74 75 76 77 78 79
/* 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;

80 81
Lisp_Object Qread_file_name_internal;

82
/* Normal hooks for entry to and exit from minibuffer.  */
83 84

Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
85
Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
86

Jim Blandy's avatar
Jim Blandy committed
87 88 89 90
/* Nonzero means completion ignores case.  */

int completion_ignore_case;

91 92 93 94
/* List of regexps that should restrict possible completions.  */

Lisp_Object Vcompletion_regexp_list;

95 96 97 98 99
/* Nonzero means raise the minibuffer frame when the minibuffer
   is entered.  */

int minibuffer_auto_raise;

Jim Blandy's avatar
Jim Blandy committed
100 101 102 103 104 105
/* 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;
106 107 108 109

/* 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
110 111 112 113 114 115 116

/* Actual minibuffer invocation. */

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

117
/* Read from the minibuffer using keymap MAP, initial contents INITIAL
Richard M. Stallman's avatar
Richard M. Stallman committed
118
   (a string), putting point minus BACKUP_N chars from the end of INITIAL,
119
   prompting with PROMPT (a string), using history list HISTVAR
Richard M. Stallman's avatar
Richard M. Stallman committed
120
   with initial position HISTPOS.  (BACKUP_N should be <= 0.)
121 122

   Normally return the result as a string (the text that was read),
123 124 125 126 127
   but if EXPFLAG is non-nil, read it and return the object read.
   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
   the list as the string that was read, or as the object that resulted iff
   EXPFLAG is non-nil.  */
128

Jim Blandy's avatar
Jim Blandy committed
129
Lisp_Object
130
read_minibuf (map, initial, prompt, backup_n, expflag, histvar, histpos)
Jim Blandy's avatar
Jim Blandy committed
131 132 133
     Lisp_Object map;
     Lisp_Object initial;
     Lisp_Object prompt;
134
     Lisp_Object backup_n;
Jim Blandy's avatar
Jim Blandy committed
135
     int expflag;
136 137
     Lisp_Object histvar;
     Lisp_Object histpos;
Jim Blandy's avatar
Jim Blandy committed
138 139 140
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;
141
  Lisp_Object mini_frame;
Jim Blandy's avatar
Jim Blandy committed
142 143 144 145 146 147 148 149 150 151 152 153 154
  struct gcpro gcpro1, gcpro2;

  if (XTYPE (prompt) != Lisp_String)
    prompt = build_string ("");

  /* Emacs in -batch mode calls minibuffer: print the prompt.  */
  if (noninteractive && XTYPE (prompt) == Lisp_String)
    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
155
	  || selected_frame != XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)))
Jim Blandy's avatar
Jim Blandy committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
#endif
    error ("Command attempted to use minibuffer while in minibuffer");

  if (minibuf_level == minibuf_save_vector_size)
    minibuf_save_vector =
     (struct minibuf_save_data *)
       xrealloc (minibuf_save_vector,
		 (minibuf_save_vector_size *= 2)
		 * sizeof (struct minibuf_save_data)); 
  minibuf_save_vector[minibuf_level].prompt = minibuf_prompt;
  minibuf_save_vector[minibuf_level].prompt_width = minibuf_prompt_width;
  minibuf_prompt_width = 0;
  /* >> Why is this done this way rather than binding these variables? */
  minibuf_save_vector[minibuf_level].help_form = Vhelp_form;
  minibuf_save_vector[minibuf_level].current_prefix_arg = Vcurrent_prefix_arg;
171 172
  minibuf_save_vector[minibuf_level].history_position = Vminibuffer_history_position;
  minibuf_save_vector[minibuf_level].history_variable = Vminibuffer_history_variable;
Jim Blandy's avatar
Jim Blandy committed
173 174 175 176
  GCPRO2 (minibuf_save_vector[minibuf_level].help_form,
	  minibuf_save_vector[minibuf_level].current_prefix_arg);

  record_unwind_protect (Fset_window_configuration,
Jim Blandy's avatar
Jim Blandy committed
177 178
			 Fcurrent_window_configuration (Qnil));

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

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

191 192
  if (minibuffer_auto_raise)
    Fraise_frame (mini_frame);
193
#endif
Jim Blandy's avatar
Jim Blandy committed
194 195 196

  val = current_buffer->directory;
  Fset_buffer (get_minibuffer (minibuf_level));
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215

  /* 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.  */
  if (XTYPE (val) == Lisp_String)
    current_buffer->directory = val;
  else
    {
      Lisp_Object buf_list;

      for (buf_list = Vbuffer_alist;
	   CONSP (buf_list);
	   buf_list = XCONS (buf_list)->cdr)
	{
216
	  Lisp_Object other_buf;
217

218
	  other_buf = XCONS (XCONS (buf_list)->car)->cdr;
219 220 221 222 223 224 225 226
	  if (XTYPE (XBUFFER (other_buf)->directory) == Lisp_String)
	    {
	      current_buffer->directory = XBUFFER (other_buf)->directory;
	      break;
	    }
	}
    }

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

Jim Blandy's avatar
Jim Blandy committed
234 235
  record_unwind_protect (read_minibuf_unwind, Qnil);

Jim Blandy's avatar
Jim Blandy committed
236 237 238 239 240 241 242 243
  Vminibuf_scroll_window = selected_window;
  Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
  Fselect_window (minibuf_window);
  XFASTINT (XWINDOW (minibuf_window)->hscroll) = 0;

  Ferase_buffer ();
  minibuf_level++;

Jim Blandy's avatar
Jim Blandy committed
244
  if (!NILP (initial))
Jim Blandy's avatar
Jim Blandy committed
245 246
    {
      Finsert (1, &initial);
Jim Blandy's avatar
Jim Blandy committed
247
      if (!NILP (backup_n) && XTYPE (backup_n) == Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
248 249 250 251 252 253 254 255 256
	Fforward_char (backup_n);
    }

  minibuf_prompt = (char *) alloca (XSTRING (prompt)->size + 1);
  bcopy (XSTRING (prompt)->data, minibuf_prompt, XSTRING (prompt)->size + 1);
  echo_area_glyphs = 0;

  Vhelp_form = Vminibuffer_help_form;
  current_buffer->keymap = map;
257 258
  Vminibuffer_history_position = histpos;
  Vminibuffer_history_variable = histvar;
Jim Blandy's avatar
Jim Blandy committed
259

260 261 262
  /* 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.  */
263 264
  if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
      && !NILP (Vrun_hooks))
265 266
    call1 (Vrun_hooks, Qminibuffer_setup_hook);

Jim Blandy's avatar
Jim Blandy committed
267 268 269
/* ??? MCC did redraw_screen here if switching screens.  */
  recursive_edit_1 ();

270 271 272 273
  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
274 275
  /* 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
276
  if ((FRAME_CURSOR_Y (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
277 278 279
       >= XFASTINT (XWINDOW (minibuf_window)->top))
      && !noninteractive)
    {
Jim Blandy's avatar
Jim Blandy committed
280 281
      FRAME_CURSOR_X (selected_frame) = 0;
      update_frame (selected_frame, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
282 283 284
    }

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

288 289 290
  /* VAL is the string of minibuffer text.  */
  last_minibuf_string = val;

291 292
  /* Add the value to the appropriate history list.  */
  if (XTYPE (Vminibuffer_history_variable) == Lisp_Symbol
293 294 295
      && ! EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
    {
      /* If the caller wanted to save the value read on a history list,
296 297 298
	 then do so if the value is not already the front of the list.  */
      Lisp_Object histval;
      histval = Fsymbol_value (Vminibuffer_history_variable);
299 300

      /* The value of the history variable must be a cons or nil.  Other
301
	 values are unacceptable.  We silently ignore these values.  */
302
      if (NILP (histval)
303 304 305 306
	  || (CONSP (histval)
	      && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
	Fset (Vminibuffer_history_variable,
	      Fcons (last_minibuf_string, histval));
307
    }
308

309 310
  /* If Lisp form desired instead of string, parse it. */
  if (expflag)
311 312 313 314 315 316 317 318 319 320 321
    {
      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);
    }
322

Jim Blandy's avatar
Jim Blandy committed
323
  UNGCPRO;
324 325
  return unbind_to (count, val); /* The appropriate frame will get selected
				    in set-window-configuration.  */
Jim Blandy's avatar
Jim Blandy committed
326 327 328 329 330 331 332 333 334 335 336
}

/* 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;
337
  char name[24];
Jim Blandy's avatar
Jim Blandy committed
338 339 340 341
  extern Lisp_Object nconc2 ();

  XFASTINT (num) = depth;
  tail = Fnthcdr (num, Vminibuffer_list);
Jim Blandy's avatar
Jim Blandy committed
342
  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
343 344 345 346 347
    {
      tail = Fcons (Qnil, Qnil);
      Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
    }
  buf = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
348
  if (NILP (buf) || NILP (XBUFFER (buf)->name))
Jim Blandy's avatar
Jim Blandy committed
349 350 351
    {
      sprintf (name, " *Minibuf-%d*", depth);
      buf = Fget_buffer_create (build_string (name));
352 353 354 355 356

      /* 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
357 358 359 360
      XCONS (tail)->car = buf;
    }
  else
    reset_buffer (XBUFFER (buf));
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 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
{
  /* 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;
  Ferase_buffer ();

  /* 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++;
  XFASTINT (XWINDOW (minibuf_window)->last_modified) = 0;

  /* Restore prompt from outer minibuffer */
  minibuf_prompt = minibuf_save_vector[minibuf_level].prompt;
  minibuf_prompt_width = minibuf_save_vector[minibuf_level].prompt_width;
  Vhelp_form = minibuf_save_vector[minibuf_level].help_form;
  Vcurrent_prefix_arg = minibuf_save_vector[minibuf_level].current_prefix_arg;
391 392 393 394
  Vminibuffer_history_position
    = minibuf_save_vector[minibuf_level].history_position;
  Vminibuffer_history_variable
    = minibuf_save_vector[minibuf_level].history_variable;
Jim Blandy's avatar
Jim Blandy committed
395 396
}

397 398 399 400 401

/* 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
402 403 404 405
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\
406 407
  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
408 409 410 411 412
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\
413 414 415 416 417 418 419
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\
420 421 422 423 424
  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 */)
425 426
  (prompt, initial_contents, keymap, read, hist)
     Lisp_Object prompt, initial_contents, keymap, read, hist;
Jim Blandy's avatar
Jim Blandy committed
427 428
{
  int pos = 0;
429 430
  Lisp_Object histvar, histpos, position;
  position = Qnil;
Jim Blandy's avatar
Jim Blandy committed
431 432

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

Jim Blandy's avatar
Jim Blandy committed
449
  if (NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
450 451 452
    keymap = Vminibuffer_local_map;
  else
    keymap = get_keymap (keymap,2);
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468

  if (XTYPE (hist) == Lisp_Symbol)
    {
      histvar = hist;
      histpos = Qnil;
    }
  else
    {
      histvar = Fcar_safe (hist);
      histpos = Fcdr_safe (hist);
    }
  if (NILP (histvar))
    histvar = Qminibuffer_history;
  if (NILP (histpos))
    XFASTINT (histpos) = 0;

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

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
481
  if (!NILP (initial_contents))
482
    CHECK_STRING (initial_contents, 1);
483 484
  return read_minibuf (Vminibuffer_local_map, initial_contents,
		       prompt, Qnil, 1, Qminibuffer_history, make_number (0));
Jim Blandy's avatar
Jim Blandy committed
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
}

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);
}

508
DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513 514
  "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
515
  if (! NILP (init))
Jim Blandy's avatar
Jim Blandy committed
516 517
    CHECK_STRING (init, 1);

518 519
  return read_minibuf (Vminibuffer_local_ns_map, init, prompt, Qnil, 0,
		       Qminibuffer_history, make_number (0));
Jim Blandy's avatar
Jim Blandy committed
520 521 522 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
}

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;

  if (XTYPE (def) == Lisp_Buffer)
    def = XBUFFER (def)->name;
Jim Blandy's avatar
Jim Blandy committed
570
  if (!NILP (def))
Jim Blandy's avatar
Jim Blandy committed
571 572 573 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
    {
      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
610
  int list = CONSP (alist) || NILP (alist);
Jim Blandy's avatar
Jim Blandy committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 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);
  if (!list && XTYPE (alist) != Lisp_Vector)
    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
640
	  if (NILP (tail))
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 663 664 665 666 667
	    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
		XFASTINT (bucket) = 0;
	    }
	  else if (++index >= obsize)
	    break;
	  else
	    {
	      bucket = XVECTOR (alist)->contents[index];
	      continue;
	    }
	}

      /* Is this element a possible completion? */

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

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

Jim Blandy's avatar
Jim Blandy committed
692
	  if (!NILP (pred))
Jim Blandy's avatar
Jim Blandy committed
693 694 695 696 697 698 699 700 701
	    {
	      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
702
	      if (NILP (tem)) continue;
Jim Blandy's avatar
Jim Blandy committed
703 704 705 706 707
	    }

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

	  matchcount++;
Jim Blandy's avatar
Jim Blandy committed
708
	  if (NILP (bestmatch))
Jim Blandy's avatar
Jim Blandy committed
709 710 711 712 713 714 715
	    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
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
	      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
743 744 745 746
	    }
	}
    }

Jim Blandy's avatar
Jim Blandy committed
747
  if (NILP (bestmatch))
Jim Blandy's avatar
Jim Blandy committed
748
    return Qnil;		/* No completions found */
Jim Blandy's avatar
Jim Blandy committed
749 750 751 752 753 754 755 756 757 758 759 760
  /* 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
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
    return Qt;

  XFASTINT (zero) = 0;		/* Else extract the part in which */
  XFASTINT (end) = bestmatchsize;	     /* all completions agree */
  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.  */

scmp (s1, s2, len)
     register char *s1, *s2;
     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;
  else return len - l;
}

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
814
  int list = CONSP (alist) || NILP (alist);
Jim Blandy's avatar
Jim Blandy committed
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
  int index, obsize;
  Lisp_Object bucket, tem;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

  CHECK_STRING (string, 0);
  if (!list && XTYPE (alist) != Lisp_Vector)
    {
      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
844
	  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
	    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
		XFASTINT (bucket) = 0;
	    }
	  else if (++index >= obsize)
	    break;
	  else
	    {
	      bucket = XVECTOR (alist)->contents[index];
	      continue;
	    }
	}

      /* Is this element a possible completion? */

872 873 874 875 876 877 878 879
      if (XTYPE (eltstring) == Lisp_String
	  && 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
880 881
	{
	  /* Yes. */
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
	  Lisp_Object regexps;
	  Lisp_Object zero;
	  XFASTINT (zero) = 0;

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

Jim Blandy's avatar
Jim Blandy committed
900
	  if (!NILP (pred))
Jim Blandy's avatar
Jim Blandy committed
901 902 903 904 905 906 907 908 909
	    {
	      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
910
	      if (NILP (tem)) continue;
Jim Blandy's avatar
Jim Blandy committed
911 912 913 914 915 916 917 918 919 920 921 922 923
	    }
	  /* 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;

924 925 926 927
/* 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
928 929
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
  "Read a string in the minibuffer, with completion.\n\
930
Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, HIST.\n\
Jim Blandy's avatar
Jim Blandy committed
931 932 933 934 935 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\
See `try-completion' for more details on completion, TABLE, and PREDICATE.\n\
If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
 the input is (or completes to) an element of TABLE.\n\
 If it is also not t, Return does not exit if it does non-null completion.\n\
If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
939 940 941 942 943 944 945 946 947 948 949
  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\
950 951 952 953
  `completion-ignore-case' is non-nil."
*/
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
  0 /* See immediately above */)
954 955
  (prompt, table, pred, require_match, init, hist)
     Lisp_Object prompt, table, pred, require_match, init, hist;
Jim Blandy's avatar
Jim Blandy committed
956
{
957 958
  Lisp_Object val, histvar, histpos, position;
  int pos = 0;
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962 963 964
  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;
965 966 967 968 969 970 971 972 973 974 975 976 977 978

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

  if (XTYPE (hist) == Lisp_Symbol)
    {
      histvar = hist;
      histpos = Qnil;
    }
  else
    {
      histvar = Fcar_safe (hist);
      histpos = Fcdr_safe (hist);
    }
  if (NILP (histvar))
    histvar = Qminibuffer_history;
  if (NILP (histpos))
    XFASTINT (histpos) = 0;

Jim Blandy's avatar
Jim Blandy committed
998
  val = read_minibuf (NILP (require_match)
Jim Blandy's avatar
Jim Blandy committed
999 1000
		      ? Vminibuffer_local_completion_map
		      : Vminibuffer_local_must_match_map,
Richard M. Stallman's avatar
Richard M. Stallman committed
1001
		      init, prompt, make_number (pos), 0,
1002
		      histvar, histpos);
Jim Blandy's avatar
Jim Blandy committed
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
  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;

1019 1020
  /* Clear out any old echo-area message to make way for our new thing.  */
  message (0);
Jim Blandy's avatar
Jim Blandy committed
1021 1022 1023 1024 1025 1026

  SET_PT (osize);
  insert_string (m);
  SET_PT (osize);
  Vinhibit_quit = Qt;
  Fsit_for (make_number (2), Qnil, Qnil);
1027
  del_range (PT, ZV);
Jim Blandy's avatar
Jim Blandy committed
1028
  if (!NILP (Vquit_flag))
Jim Blandy's avatar
Jim Blandy committed
1029 1030
    {
      Vquit_flag = Qnil;
1031
      Vunread_command_events = Fcons (make_number (quit_char), Qnil);
Jim Blandy's avatar
Jim Blandy committed
1032 1033 1034 1035 1036
    }
  Vinhibit_quit = oinhibit;
}

Lisp_Object Fminibuffer_completion_help ();
Jim Blandy's avatar
Jim Blandy committed
1037
Lisp_Object assoc_for_completion ();
Jim Blandy's avatar
Jim Blandy committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052

/* 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;
1053
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
1054 1055 1056 1057 1058 1059

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

1060 1061
  GCPRO2 (completion, last);

Jim Blandy's avatar
Jim Blandy committed
1062
  if (NILP (completion))
Jim Blandy's avatar
Jim Blandy committed
1063 1064 1065
    {
      bitch_at_user ();
      temp_echo_area_glyphs (" [No match]");
1066
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1067 1068 1069 1070
      return 0;
    }

  if (EQ (completion, Qt))	/* exact and unique match */
1071 1072 1073 1074
    {
      UNGCPRO;
      return 1;
    }
Jim Blandy's avatar
Jim Blandy committed
1075 1076 1077

  /* compiler bug */
  tem = Fstring_equal (completion, Fbuffer_string());
Jim Blandy's avatar
Jim Blandy committed
1078
  if (completedp = NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1079 1080 1081 1082 1083 1084 1085
    {
      Ferase_buffer ();		/* Some completion happened */
      Finsert (1, &completion);
    }

  /* It did find a match.  Do we match some possibility exactly now? */
  if (CONSP (Vminibuffer_completion_table)
Jim Blandy's avatar
Jim Blandy committed
1086
      || NILP (Vminibuffer_completion_table))
Jim Blandy's avatar
Jim Blandy committed
1087 1088
    tem = assoc_for_completion (Fbuffer_string (),
				Vminibuffer_completion_table);
Jim Blandy's avatar
Jim Blandy committed
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
  else if (XTYPE (Vminibuffer_completion_table) == Lisp_Vector)
    {
      /* the primitive used by Fintern_soft */
      extern Lisp_Object oblookup ();

      tem = Fbuffer_string ();
      /* Bypass intern-soft as that loses for nil */
      tem = oblookup (Vminibuffer_completion_table,
		      XSTRING (tem)->data, XSTRING (tem)->size);
      if (XTYPE (tem) != Lisp_Symbol)
	tem = Qnil;
Jim Blandy's avatar
Jim Blandy committed
1100
      else if (!NILP (Vminibuffer_completion_predicate))
Jim Blandy's avatar
Jim Blandy committed
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
	tem = call1 (Vminibuffer_completion_predicate, tem);
      else
	tem = Qt;
    }
  else
    tem = call3 (Vminibuffer_completion_table,
		 Fbuffer_string (),
		 Vminibuffer_completion_predicate,
		 Qlambda);

Jim Blandy's avatar
Jim Blandy committed
1111
  if (NILP (tem))
1112 1113 1114
    {
      /* not an exact match */
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1115 1116 1117 1118 1119 1120 1121 1122 1123
      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)
1124 1125 1126 1127
    {
      UNGCPRO;
      return 4;
    }
Jim Blandy's avatar
Jim Blandy committed
1128 1129
  /* 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
1130
     message and the user's hit TAB again, so now we give him help.  */
Jim Blandy's avatar
Jim Blandy committed
1131
  last_exact_completion = completion;
Jim Blandy's avatar
Jim Blandy committed
1132
  if (!NILP (last))
Jim Blandy's avatar
Jim Blandy committed
1133 1134
    {
      tem = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
1135
      if (!NILP (Fequal (tem, last)))
Jim Blandy's avatar
Jim Blandy committed
1136 1137
	Fminibuffer_completion_help ();
    }
1138
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1139 1140
  return 3;
}
1141

Jim Blandy's avatar
Jim Blandy committed
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
/* 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
1154
  for (tail = list; !NILP (tail); tail = Fcdr (tail))
Jim Blandy's avatar
Jim Blandy committed
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
    {
      register Lisp_Object elt, tem, thiscar;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
      thiscar = Fcar (elt);
      if (XTYPE (thiscar) != Lisp_String)
	continue;
      if (completion_ignore_case)
	thiscar = Fupcase (thiscar);
      tem = Fequal (thiscar, key);
Jim Blandy's avatar
Jim Blandy committed
1165
      if (!NILP (tem)) return elt;
Jim Blandy's avatar
Jim Blandy committed
1166 1167 1168 1169
      QUIT;
    }
  return Qnil;
}
Jim Blandy's avatar
Jim Blandy committed
1170 1171

DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
1172
  "Complete the minibuffer contents as far as possible.\n\
1173 1174 1175 1176
Return nil if there is no valid completion, else t.\n\
If no characters can be completed, display a list of possible completions.\n\
If you repeat this command after it displayed such a list,\n\
scroll the window of possible completions.")
Jim Blandy's avatar
Jim Blandy committed
1177 1178
  ()
{
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
  register int i;
  Lisp_Object window, tem;

  /* If the previous command was not this, then mark the completion
     buffer obsolete.  */
  if (! EQ (last_command, this_command))
    Vminibuf_scroll_window = Qnil;

  window = Vminibuf_scroll_window;
  /* If there's a fresh completion window with a live buffer,
     and this command is repeated, scroll that window.  */
  if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
      && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
    {
      struct buffer *obuf = current_buffer;

      Fset_buffer (XWINDOW (window)->buffer);
      tem = Fpos_visible_in_window_p (make_number (ZV), window);
      if (! NILP (tem))
	/* If end is in view, scroll up to the beginning.  */
	Fset_window_start (window, BEGV);
      else
	/* Else scroll down one screen.  */
	Fscroll_other_window (Qnil);

      set_buffer_internal (obuf);
      return Qnil;
    }

  i = do_completion ();
Jim Blandy's avatar
Jim Blandy committed
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
  switch (i)
    {
    case 0:
      return Qnil;

    case 1:
      temp_echo_area_glyphs (" [Sole completion]");
      break;

    case 3:
      temp_echo_area_glyphs (" [Complete, but not unique]");
      break;
    }

  return Qt;
}

DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
        Sminibuffer_complete_and_exit, 0, 0, "",
  "Complete the minibuffer contents, and maybe exit.\n\
Exit if the name is valid with no completion needed.\n\
If name was completed to a valid match,\n\
a repetition of this command will exit.")
  ()
{
  register int i;

  /* Allow user to specify null string */
  if (BEGV == ZV)
    goto exit;

  i = do_completion ();
  switch (i)
    {
    case 1:
    case 3:
      goto exit;

    case 4:
Jim Blandy's avatar
Jim Blandy committed
1248
      if (!NILP (Vminibuffer_completion_confirm))
Jim Blandy's avatar
Jim Blandy committed
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
	{
	  temp_echo_area_glyphs (" [Confirm]");
	  return Qnil;
	}
      else
	goto exit;

    default:
      return Qnil;
    }
 exit:
  Fthrow (Qexit, Qnil);
  /* NOTREACHED */
}

DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
  0, 0, "",
  "Complete the minibuffer contents at most a single word.\n\
After one word is completed as much as possible, a space or hyphen\n\
1268 1269
is added, provided that matches some possible completion.\n\
Return nil if there is no valid completion, else t.")
Jim Blandy's avatar
Jim Blandy committed
1270 1271 1272 1273 1274
  ()
{
  Lisp_Object completion, tem;
  register int i;
  register unsigned char *completion_string;
1275 1276 1277 1278
  struct gcpro gcpro1;

  /* We keep calling Fbuffer_string rather than arrange for GC to
     hold onto a pointer to one of the strings thus made.  */
Jim Blandy's avatar
Jim Blandy committed
1279 1280 1281 1282

  completion = Ftry_completion (Fbuffer_string (),
				Vminibuffer_completion_table,
				Vminibuffer_completion_predicate);
Jim Blandy's avatar
Jim Blandy committed
1283
  if (NILP (completion))
Jim Blandy's avatar
Jim Blandy committed
1284 1285 1286 1287 1288 1289 1290 1291
    {
      bitch_at_user ();
      temp_echo_area_glyphs (" [No match]");
      return Qnil;
    }
  if (EQ (completion, Qt))
    return Qnil;

1292
#if 0 /* How the below code used to look, for reference. */
Jim Blandy's avatar
Jim Blandy committed
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
  tem = Fbuffer_string ();
  b = XSTRING (tem)->data;
  i = ZV - 1 - XSTRING (completion)->size;
  p = XSTRING (completion)->data;
  if (i > 0 ||
      0 <= scmp (b, p, ZV - 1))
    {
      i = 1;
      /* Set buffer to longest match of buffer tail and completion head. */
      while (0 <= scmp (b + i, p, ZV - 1 - i))
	i++;
      del_range (1, i + 1);
      SET_PT (ZV);
    }
#else /* Rewritten code */
  {
    register unsigned char *buffer_string;
    int buffer_length, completion_length;

    tem = Fbuffer_string ();
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
    /* If reading a file name,
       expand any $ENVVAR refs in the buffer and in TEM.  */
    if (EQ (Vminibuffer_completion_table, Qread_file_name_internal))
      {
	Lisp_Object substituted;
	substituted = Fsubstitute_in_file_name (tem);
	if (! EQ (substituted, tem))
	  {
	    tem = substituted;
	    Ferase_buffer ();
1323
	    insert_from_string (tem, 0, XSTRING (tem)->size, 0);
1324 1325
	  }
      }
Jim Blandy's avatar
Jim Blandy committed
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345