minibuf.c 47.1 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 32 33 34 35 36 37 38 39 40 41 42 43
#include "window.h"
#include "syntax.h"

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

/* 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;
44 45
    Lisp_Object history_position;
    Lisp_Object history_variable;
Jim Blandy's avatar
Jim Blandy committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
  };

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;

/* Fread_minibuffer leaves the input, as a string, here */
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;

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

78 79
Lisp_Object Qread_file_name_internal;

80 81 82 83
/* Normal hook for entry to minibuffer.  */

Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;

Jim Blandy's avatar
Jim Blandy committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
/* Nonzero means completion ignores case.  */

int completion_ignore_case;

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


/* Actual minibuffer invocation. */

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

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

   Normally return the result as a string (the text that was read),
   but if EXPFLAG is non-nil, read it and return the object read.  */

Jim Blandy's avatar
Jim Blandy committed
110
Lisp_Object
111
read_minibuf (map, initial, prompt, backup_n, expflag, histvar, histpos)
Jim Blandy's avatar
Jim Blandy committed
112 113 114
     Lisp_Object map;
     Lisp_Object initial;
     Lisp_Object prompt;
115
     Lisp_Object backup_n;
Jim Blandy's avatar
Jim Blandy committed
116
     int expflag;
117 118
     Lisp_Object histvar;
     Lisp_Object histpos;
Jim Blandy's avatar
Jim Blandy committed
119 120 121
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;
122
  Lisp_Object mini_frame;
Jim Blandy's avatar
Jim Blandy committed
123 124 125 126 127 128 129 130 131 132 133 134 135
  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
136
	  || selected_frame != XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)))
Jim Blandy's avatar
Jim Blandy committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
#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;
152 153
  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
154 155 156 157
  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
158 159
			 Fcurrent_window_configuration (Qnil));

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

  val = current_buffer->directory;
  Fset_buffer (get_minibuffer (minibuf_level));
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

  /* 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)
	{
	  Lisp_Object other_buf = XCONS (XCONS (buf_list)->car)->cdr;

	  if (XTYPE (XBUFFER (other_buf)->directory) == Lisp_String)
	    {
	      current_buffer->directory = XBUFFER (other_buf)->directory;
	      break;
	    }
	}
    }

200
#ifdef MULTI_FRAME
201
  Fredirect_frame_focus (Fselected_frame (), mini_frame);
202
#endif
Jim Blandy's avatar
Jim Blandy committed
203 204 205
  Fmake_local_variable (Qprint_escape_newlines);
  print_escape_newlines = 1;

Jim Blandy's avatar
Jim Blandy committed
206 207
  record_unwind_protect (read_minibuf_unwind, Qnil);

Jim Blandy's avatar
Jim Blandy committed
208 209 210 211 212 213 214 215
  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
216
  if (!NILP (initial))
Jim Blandy's avatar
Jim Blandy committed
217 218
    {
      Finsert (1, &initial);
Jim Blandy's avatar
Jim Blandy committed
219
      if (!NILP (backup_n) && XTYPE (backup_n) == Lisp_Int)
Jim Blandy's avatar
Jim Blandy committed
220 221 222 223 224 225 226 227 228
	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;
229 230
  Vminibuffer_history_position = histpos;
  Vminibuffer_history_variable = histvar;
Jim Blandy's avatar
Jim Blandy committed
231

232 233 234 235 236 237
  /* 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.  */
  if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound))
    call1 (Vrun_hooks, Qminibuffer_setup_hook);

Jim Blandy's avatar
Jim Blandy committed
238 239 240 241 242
/* ??? 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
243
  if ((FRAME_CURSOR_Y (selected_frame)
Jim Blandy's avatar
Jim Blandy committed
244 245 246
       >= XFASTINT (XWINDOW (minibuf_window)->top))
      && !noninteractive)
    {
Jim Blandy's avatar
Jim Blandy committed
247 248
      FRAME_CURSOR_X (selected_frame) = 0;
      update_frame (selected_frame, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
249 250 251
    }

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

  /* Add the value to the appropriate history list.  */
  if (XTYPE (Vminibuffer_history_variable) == Lisp_Symbol
257
      && ! EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
258 259 260
    Fset (Vminibuffer_history_variable,
	  Fcons (val, Fsymbol_value (Vminibuffer_history_variable)));

Jim Blandy's avatar
Jim Blandy committed
261
  unbind_to (count, Qnil);	/* The appropriate frame will get selected
Jim Blandy's avatar
Jim Blandy committed
262
				   in set-window-configuration.  */
Jim Blandy's avatar
Jim Blandy committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

  UNGCPRO;

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

  /* If Lisp form desired instead of string, parse it */
  if (expflag)
    val = Fread (val);

  return val;
}

/* 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;
  char name[14];
  extern Lisp_Object nconc2 ();

  XFASTINT (num) = depth;
  tail = Fnthcdr (num, Vminibuffer_list);
Jim Blandy's avatar
Jim Blandy committed
290
  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
291 292 293 294 295
    {
      tail = Fcons (Qnil, Qnil);
      Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
    }
  buf = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
296
  if (NILP (buf) || NILP (XBUFFER (buf)->name))
Jim Blandy's avatar
Jim Blandy committed
297 298 299
    {
      sprintf (name, " *Minibuf-%d*", depth);
      buf = Fget_buffer_create (build_string (name));
300 301 302 303 304

      /* 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
305 306 307 308
      XCONS (tail)->car = buf;
    }
  else
    reset_buffer (XBUFFER (buf));
309

Jim Blandy's avatar
Jim Blandy committed
310 311 312 313 314 315 316
  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
317 318
read_minibuf_unwind (data)
     Lisp_Object data;
Jim Blandy's avatar
Jim Blandy committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
{
  /* 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;
339 340 341 342
  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
343 344
}

345 346 347 348 349

/* 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
350 351 352 353
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\
354 355
  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
356 357 358 359 360
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\
361 362 363 364 365 366 367
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\
368 369 370 371 372
  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 */)
373 374
  (prompt, initial_input, keymap, read, hist)
     Lisp_Object prompt, initial_input, keymap, read, hist;
Jim Blandy's avatar
Jim Blandy committed
375 376
{
  int pos = 0;
377 378
  Lisp_Object histvar, histpos, position;
  position = Qnil;
Jim Blandy's avatar
Jim Blandy committed
379 380

  CHECK_STRING (prompt, 0);
Jim Blandy's avatar
Jim Blandy committed
381
  if (!NILP (initial_input))
Jim Blandy's avatar
Jim Blandy committed
382
    {
383 384 385 386 387
      if (XTYPE (initial_input) == Lisp_Cons)
	{
	  position = Fcdr (initial_input);
	  initial_input = Fcar (initial_input);
	}
Jim Blandy's avatar
Jim Blandy committed
388
      CHECK_STRING (initial_input, 1);
Jim Blandy's avatar
Jim Blandy committed
389
      if (!NILP (position))
Jim Blandy's avatar
Jim Blandy committed
390 391 392 393 394 395 396
	{
	  CHECK_NUMBER (position, 0);
	  /* Convert to distance from end of input.  */
	  pos = XINT (position) - 1 - XSTRING (initial_input)->size;
	}
    }

Jim Blandy's avatar
Jim Blandy committed
397
  if (NILP (keymap))
Jim Blandy's avatar
Jim Blandy committed
398 399 400
    keymap = Vminibuffer_local_map;
  else
    keymap = get_keymap (keymap,2);
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416

  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
417
  return read_minibuf (keymap, initial_input, prompt,
Richard M. Stallman's avatar
Richard M. Stallman committed
418
		       make_number (pos), !NILP (read), histvar, histpos);
Jim Blandy's avatar
Jim Blandy committed
419 420 421 422 423 424 425 426 427 428
}

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
429
  if (!NILP (initial_contents))
430
    CHECK_STRING (initial_contents, 1);
431 432
  return read_minibuf (Vminibuffer_local_map, initial_contents,
		       prompt, Qnil, 1, Qminibuffer_history, make_number (0));
Jim Blandy's avatar
Jim Blandy committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
}

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

Jim Blandy's avatar
Jim Blandy committed
456
DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 2, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460 461 462
  "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
463
  if (! NILP (init))
Jim Blandy's avatar
Jim Blandy committed
464 465
    CHECK_STRING (init, 1);

466 467
  return read_minibuf (Vminibuffer_local_ns_map, init, prompt, Qnil, 0,
		       Qminibuffer_history, make_number (0));
Jim Blandy's avatar
Jim Blandy committed
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
}

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
518
  if (!NILP (def))
Jim Blandy's avatar
Jim Blandy committed
519 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
    {
      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
558
  int list = CONSP (alist) || NILP (alist);
Jim Blandy's avatar
Jim Blandy committed
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
  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
588
	  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
589 590 591 592 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
	    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? */

      if (XTYPE (eltstring) == Lisp_String &&
	  XSTRING (string)->size <= XSTRING (eltstring)->size &&
	  0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
		    XSTRING (string)->size))
	{
	  /* Yes. */
	  /* Ignore this element if there is a predicate
	     and the predicate doesn't like it. */

Jim Blandy's avatar
Jim Blandy committed
625
	  if (!NILP (pred))
Jim Blandy's avatar
Jim Blandy committed
626 627 628 629 630 631 632 633 634
	    {
	      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
635
	      if (NILP (tem)) continue;
Jim Blandy's avatar
Jim Blandy committed
636 637 638 639 640
	    }

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

	  matchcount++;
Jim Blandy's avatar
Jim Blandy committed
641
	  if (NILP (bestmatch))
Jim Blandy's avatar
Jim Blandy committed
642 643 644 645 646 647 648
	    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
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
	      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
676 677 678 679
	    }
	}
    }

Jim Blandy's avatar
Jim Blandy committed
680
  if (NILP (bestmatch))
Jim Blandy's avatar
Jim Blandy committed
681
    return Qnil;		/* No completions found */
Jim Blandy's avatar
Jim Blandy committed
682 683 684 685 686 687 688 689 690 691 692 693
  /* 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
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 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 743 744 745 746
    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
747
  int list = CONSP (alist) || NILP (alist);
Jim Blandy's avatar
Jim Blandy committed
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
  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
777
	  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
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 814
	    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? */

      if (XTYPE (eltstring) == Lisp_String &&
	  XSTRING (string)->size <= XSTRING (eltstring)->size &&
	  XSTRING (eltstring)->data[0] != ' ' &&
	  0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
		    XSTRING (string)->size))
	{
	  /* Yes. */
	  /* Ignore this element if there is a predicate
	     and the predicate doesn't like it. */

Jim Blandy's avatar
Jim Blandy committed
815
	  if (!NILP (pred))
Jim Blandy's avatar
Jim Blandy committed
816 817 818 819 820 821 822 823 824
	    {
	      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
825
	      if (NILP (tem)) continue;
Jim Blandy's avatar
Jim Blandy committed
826 827 828 829 830 831 832 833 834 835 836 837 838
	    }
	  /* 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;

839 840 841 842
/* 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
843 844
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
  "Read a string in the minibuffer, with completion.\n\
845
Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, HIST.\n\
Jim Blandy's avatar
Jim Blandy committed
846 847 848 849 850 851 852 853
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\
854 855 856 857 858 859 860 861 862 863 864
  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\
865 866 867 868
  `completion-ignore-case' is non-nil."
*/
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
  0 /* See immediately above */)
869 870
  (prompt, table, pred, require_match, init, hist)
     Lisp_Object prompt, table, pred, require_match, init, hist;
Jim Blandy's avatar
Jim Blandy committed
871
{
872 873
  Lisp_Object val, histvar, histpos, position;
  int pos = 0;
Jim Blandy's avatar
Jim Blandy committed
874 875 876 877 878 879
  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;
880 881 882 883 884 885 886 887 888 889 890 891 892 893

  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.  */
894
	  pos = XINT (position) - XSTRING (init)->size;
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
	}
    }

  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
913
  val = read_minibuf (NILP (require_match)
Jim Blandy's avatar
Jim Blandy committed
914 915
		      ? Vminibuffer_local_completion_map
		      : Vminibuffer_local_must_match_map,
Richard M. Stallman's avatar
Richard M. Stallman committed
916
		      init, prompt, make_number (pos), 0,
917
		      histvar, histpos);
Jim Blandy's avatar
Jim Blandy committed
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
  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;

934 935
  /* Clear out any old echo-area message to make way for our new thing.  */
  message (0);
Jim Blandy's avatar
Jim Blandy committed
936 937 938 939 940 941 942

  SET_PT (osize);
  insert_string (m);
  SET_PT (osize);
  Vinhibit_quit = Qt;
  Fsit_for (make_number (2), Qnil, Qnil);
  del_range (point, ZV);
Jim Blandy's avatar
Jim Blandy committed
943
  if (!NILP (Vquit_flag))
Jim Blandy's avatar
Jim Blandy committed
944 945
    {
      Vquit_flag = Qnil;
Jim Blandy's avatar
Jim Blandy committed
946
      unread_command_events = Fcons (make_number (Ctl ('g')), Qnil);
Jim Blandy's avatar
Jim Blandy committed
947 948 949 950 951
    }
  Vinhibit_quit = oinhibit;
}

Lisp_Object Fminibuffer_completion_help ();
Jim Blandy's avatar
Jim Blandy committed
952
Lisp_Object assoc_for_completion ();
Jim Blandy's avatar
Jim Blandy committed
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973

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

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

Jim Blandy's avatar
Jim Blandy committed
974
  if (NILP (completion))
Jim Blandy's avatar
Jim Blandy committed
975 976 977 978 979 980 981 982 983 984 985
    {
      bitch_at_user ();
      temp_echo_area_glyphs (" [No match]");
      return 0;
    }

  if (EQ (completion, Qt))	/* exact and unique match */
    return 1;

  /* compiler bug */
  tem = Fstring_equal (completion, Fbuffer_string());
Jim Blandy's avatar
Jim Blandy committed
986
  if (completedp = NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
987 988 989 990 991 992 993
    {
      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
994
      || NILP (Vminibuffer_completion_table))
Jim Blandy's avatar
Jim Blandy committed
995 996
    tem = assoc_for_completion (Fbuffer_string (),
				Vminibuffer_completion_table);
Jim Blandy's avatar
Jim Blandy committed
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
  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
1008
      else if (!NILP (Vminibuffer_completion_predicate))
Jim Blandy's avatar
Jim Blandy committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
	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
1019
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
    { /* not an exact match */
      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)
    return 4;
  /* 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
1033
     message and the user's hit TAB again, so now we give him help.  */
Jim Blandy's avatar
Jim Blandy committed
1034
  last_exact_completion = completion;
Jim Blandy's avatar
Jim Blandy committed
1035
  if (!NILP (last))
Jim Blandy's avatar
Jim Blandy committed
1036 1037
    {
      tem = Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
1038
      if (!NILP (Fequal (tem, last)))
Jim Blandy's avatar
Jim Blandy committed
1039 1040 1041 1042 1043
	Fminibuffer_completion_help ();
    }
  return 3;
}
  
Jim Blandy's avatar
Jim Blandy committed
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
/* 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
1056
  for (tail = list; !NILP (tail); tail = Fcdr (tail))
Jim Blandy's avatar
Jim Blandy committed
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
    {
      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
1067
      if (!NILP (tem)) return elt;
Jim Blandy's avatar
Jim Blandy committed
1068 1069 1070 1071
      QUIT;
    }
  return Qnil;
}
Jim Blandy's avatar
Jim Blandy committed
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116

DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
  "Complete the minibuffer contents as far as possible.")
  ()
{
  register int i = do_completion ();
  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
1117
      if (!NILP (Vminibuffer_completion_confirm))
Jim Blandy's avatar
Jim Blandy committed
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
	{
	  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\
is added, provided that matches some possible completion.")
  ()
{
  Lisp_Object completion, tem;
  register int i;
  register unsigned char *completion_string;
  /* We keep calling Fbuffer_string
     rather than arrange for GC to hold onto a pointer to
     one of the strings thus made.  */

  completion = Ftry_completion (Fbuffer_string (),
				Vminibuffer_completion_table,
				Vminibuffer_completion_predicate);
Jim Blandy's avatar
Jim Blandy committed
1150
  if (NILP (completion))
Jim Blandy's avatar
Jim Blandy committed
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
    {
      bitch_at_user ();
      temp_echo_area_glyphs (" [No match]");
      return Qnil;
    }
  if (EQ (completion, Qt))
    return Qnil;

#if 0 /* How the below code used to look, for reference */
  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 ();
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
    /* 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 ();
	    insert_from_string (tem, 0, XSTRING (tem)->size);
	  }
      }
Jim Blandy's avatar
Jim Blandy committed
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 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 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
    buffer_string = XSTRING (tem)->data;
    completion_string = XSTRING (completion)->data;
    buffer_length = XSTRING (tem)->size; /* ie ZV - BEGV */
    completion_length = XSTRING (completion)->size;
    i = buffer_length - completion_length;
    /* Mly: I don't understand what this is supposed to do AT ALL */
    if (i > 0 ||
	0 <= scmp (buffer_string, completion_string, buffer_length))
      {
	/* Set buffer to longest match of buffer tail and completion head. */
	if (i <= 0) i = 1;
	buffer_string += i;
	buffer_length -= i;
	while (0 <= scmp (buffer_string++, completion_string, buffer_length--))
	  i++;
	del_range (1, i + 1);
	SET_PT (ZV);
      }
  }
#endif /* Rewritten code */
  i = ZV - BEGV;

  /* If completion finds next char not unique,
     consider adding a space or a hyphen */
  if (i == XSTRING (completion)->size)
    {
      tem = Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
			     Vminibuffer_completion_table,
			     Vminibuffer_completion_predicate);
      if (XTYPE (tem) == Lisp_String)
	completion = tem;
      else
	{
	  tem = Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
				 Vminibuffer_completion_table,
				 Vminibuffer_completion_predicate);
	  if (XTYPE (tem) == Lisp_String)
	    completion = tem;
	}
    }      

  /* Now find first word-break in the stuff found by completion.
     i gets index in string of where to stop completing.  */
  completion_string = XSTRING (completion)->data;

  for (; i < XSTRING (completion)->size; i++)
    if (SYNTAX (completion_string[i]) != Sword) break;
  if (i < XSTRING (completion)->size)
    i = i + 1;

  /* If got no characters, print help for user.  */

  if (i == ZV - BEGV)
    {
      if (auto_help)
	Fminibuffer_completion_help ();
      return Qnil;
    }

  /* Otherwise insert in minibuffer the chars we got */

  Ferase_buffer ();
  insert_from_string (completion, 0, i);
  return Qt;
}

DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
       1, 1, 0,
1261
  "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
Jim Blandy's avatar
Jim Blandy committed
1262 1263 1264 1265 1266 1267 1268
Each element may be just a symbol or string\n\
or may be a list of two strings to be printed as if concatenated.")
  (completions)
     Lisp_Object completions;
{
  register Lisp_Object tail, elt;
  register int i;
1269
  int column = 0;
Jim Blandy's avatar
Jim Blandy committed
1270 1271
  /* No GCPRO needed, since (when it matters) every variable
     points to a non-string that is pointed to by COMPLETIONS.  */
1272 1273 1274
  struct buffer *old = current_buffer;
  if (XTYPE (Vstandard_output) == Lisp_Buffer)
    set_buffer_internal (XBUFFER (Vstandard_output));
Jim Blandy's avatar
Jim Blandy committed
1275

Jim Blandy's avatar
Jim Blandy committed
1276
  if (NILP (completions))
1277 1278
    write_string ("There are no possible completions of what you have typed.",
		  -1);
Jim Blandy's avatar
Jim Blandy committed
1279 1280
  else
    {
1281
      write_string ("Possible completions are:", -1);
Jim Blandy's avatar
Jim Blandy committed
1282
      for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
Jim Blandy's avatar
Jim Blandy committed
1283 1284 1285 1286 1287 1288
	{
	  /* this needs fixing for the case of long completions
	     and/or narrow windows */
	  /* Sadly, the window it will appear in is not known
	     until after the text has been made. */
	  if (i & 1)
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
	    {
	      if (XTYPE (Vstandard_output) == Lisp_Buffer)
		Findent_to (make_number (35), make_number (1));
	      else
		{
		  do
		    {
		      write_string (" ", -1);
		      column++;
		    }
		  while (column < 35);
		}
	    }
Jim Blandy's avatar
Jim Blandy committed
1302
	  else
1303 1304 1305 1306
	    {
	      Fterpri (Qnil);
	      column = 0;
	    }
Jim Blandy's avatar
Jim Blandy committed
1307 1308 1309
	  elt = Fcar (tail);
	  if (CONSP (elt))
	    {
1310 1311
	      if (XTYPE (Vstandard_output) != Lisp_Buffer)
		{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1312
		  Lisp_Object tem;
1313 1314 1315 1316 1317
		  tem = Flength (Fcar (elt));
		  column += XINT (tem);
		  tem = Flength (Fcar (Fcdr (elt)));
		  column += XINT (tem);
		}
Jim Blandy's avatar
Jim Blandy committed
1318 1319 1320 1321
	      Fprinc (Fcar (elt), Qnil);
	      Fprinc (Fcar (Fcdr (elt)), Qnil);
	    }
	  else
1322 1323 1324 1325
	    {
	      if (XTYPE (Vstandard_output) != Lisp_Buffer)
		{
		  Lisp_Object tem;
1326
		  tem = Flength (elt);
1327 1328 1329 1330
		  column += XINT (tem);
		}
	      Fprinc (elt, Qnil);
	    }
Jim Blandy's avatar
Jim Blandy committed
1331 1332
	}
    }
1333

1334 1335 1336
  if (!NILP (Vrun_hooks))
    call1 (Vrun_hooks, intern ("completion-setup-hook"));

1337 1338
  if (XTYPE (Vstandard_output) == Lisp_Buffer)
    set_buffer_internal (old);
Jim Blandy's avatar
Jim Blandy committed
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
  return Qnil;
}

DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
  0, 0, "",
  "Display a list of possible completions of the current minibuffer contents.")
  ()
{
  Lisp_Object completions;

  message ("Making completion list...");
  completions = Fall_completions (Fbuffer_string (),
				  Vminibuffer_completion_table,
				  Vminibuffer_completion_predicate);
  echo_area_glyphs = 0;

Jim Blandy's avatar
Jim Blandy committed
1355
  if (NILP (completions))
Jim Blandy's avatar
Jim Blandy committed
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406
    {
      bitch_at_user ();
      temp_echo_area_glyphs (" [No completions]");
    }
  else
    internal_with_output_to_temp_buffer ("*Completions*",
					 Fdisplay_completion_list,
					 Fsort (completions, Qstring_lessp));
  return Qnil;
}

DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
  "Terminate minibuffer input.")
  ()
{
  if (XTYPE (last_command_char) == Lisp_Int)
    internal_self_insert (last_command_char, 0);
  else
    bitch_at_user ();

  Fthrow (Qexit, Qnil);
}

DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
  "Terminate this minibuffer argument.")
  ()
{
  Fthrow (Qexit, Qnil);
}

DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
  "Return current depth of activations of minibuffer, a nonnegative integer.")
  ()
{
  return make_number (minibuf_level);
}


init_minibuf_once ()
{
  Vminibuffer_list = Qnil;
  staticpro (&Vminibuffer_list);
}

syms_of_minibuf ()
{
  minibuf_level = 0;
  minibuf_prompt = 0;
  minibuf_save_vector_size = 5;
  minibuf_save_vector = (struct minibuf_save_data *) malloc (5 * sizeof (struct minibuf_save_data));

1407 1408 1409
  Qread_file_name_internal = intern ("read-file-name-internal");
  staticpro (&Qread_file_name_internal);

Jim Blandy's avatar
Jim Blandy committed
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
  Qminibuffer_completion_table = intern ("minibuffer-completion-table");
  staticpro (&Qminibuffer_completion_table);

  Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
  staticpro (&Qminibuffer_completion_confirm);

  Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
  staticpro (&Qminibuffer_completion_predicate);

  staticpro (&last_minibuf_string);
  last_minibuf_string = Qnil;

  Quser_variable_p = intern ("user-variable-p");
  staticpro (&Quser_variable_p);

1425 1426
  Qminibuffer_history = intern ("minibuffer-history");
  staticpro (&Qminibuffer_history);
Jim Blandy's avatar
Jim Blandy committed
1427

1428 1429 1430 1431 1432 1433 1434
  Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
  staticpro (&Qminibuffer_setup_hook);

  DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook, 
    "Normal hook run just after entry to minibuffer.");
  Vminibuffer_setup_hook = Qnil;

Jim Blandy's avatar
Jim Blandy committed
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
  DEFVAR_BOOL ("completion-auto-help", &auto_help,
    "*Non-nil means automatically provide help for invalid completion input.");
  auto_help = 1;

  DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
    "Non-nil means don't consider case significant in completion.");
  completion_ignore_case = 0;

  DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
    "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
More precisely, this variable makes a difference when the minibuffer window\n\
is the selected window.  If you are in some other window, minibuffer commands\n\
are allowed even if a minibuffer is active.");
  enable_recursive_minibuffers = 0;

  DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
    "Alist or obarray used for completion in the minibuffer.\n\
This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
\n\
The value may alternatively be a function, which is given three arguments:\n\
  STRING, the current buffer contents;\n\
  PREDICATE, the predicate for filtering possible matches;\n\
  CODE, which says what kind of things to do.\n\
CODE can be nil, t or `lambda'.\n\
nil means to return the best completion of STRING, or nil if there is none.\n\
t means to return a list of all possible completions of STRING.\n\
`lambda' means to return t if STRING is a valid completion as it stands.");
  Vminibuffer_completion_table = Qnil;

  DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
    "Within call to `completing-read', this holds the PREDICATE argument.");
  Vminibuffer_completion_predicate = Qnil;

  DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
    "Non-nil => demand confirmation of completion before exiting minibuffer.");
  Vminibuffer_completion_confirm = Qnil;

  DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
    "Value that `help-form' takes on inside the minibuffer.");
  Vminibuffer_help_form = Qnil;

1476