(find-alternate-file): Confirm killing buffer only if it is visiting a file.
[bpt/emacs.git] / src / minibuf.c
CommitLineData
f927c5ae 1/* Minibuffer input and completion.
3a22ee35 2 Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
f927c5ae
JB
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
ffd56f97 8the Free Software Foundation; either version 2, or (at your option)
f927c5ae
JB
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
18the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20
18160b98 21#include <config.h>
f927c5ae
JB
22#include "lisp.h"
23#include "commands.h"
24#include "buffer.h"
25#include "dispextern.h"
ff11dfa1 26#include "frame.h"
f927c5ae
JB
27#include "window.h"
28#include "syntax.h"
29
30#define min(a, b) ((a) < (b) ? (a) : (b))
31
a4e71d81
KH
32extern int quit_char;
33
f927c5ae 34/* List of buffers for use as minibuffers.
4d04c1f1
KH
35 The first element of the list is used for the outermost minibuffer
36 invocation, the next element is used for a recursive minibuffer
37 invocation, etc. The list is extended at the end as deeper
38 minibuffer recursions are encountered. */
f927c5ae
JB
39Lisp_Object Vminibuffer_list;
40
4d04c1f1
KH
41/* Data to remember during recursive minibuffer invocations */
42Lisp_Object minibuf_save_list;
f927c5ae
JB
43
44/* Depth in minibuffer invocations. */
45int minibuf_level;
46
47/* Nonzero means display completion help for invalid input */
48int auto_help;
49
b278606c 50/* Fread_minibuffer leaves the input here as a string. */
f927c5ae
JB
51Lisp_Object last_minibuf_string;
52
53/* Nonzero means let functions called when within a minibuffer
54 invoke recursive minibuffers (to read arguments, or whatever) */
55int enable_recursive_minibuffers;
56
57/* help-form is bound to this while in the minibuffer. */
58
59Lisp_Object Vminibuffer_help_form;
60
770970cb
RS
61/* Variable which is the history list to add minibuffer values to. */
62
63Lisp_Object Vminibuffer_history_variable;
64
65/* Current position in the history list (adjusted by M-n and M-p). */
66
67Lisp_Object Vminibuffer_history_position;
68
69Lisp_Object Qminibuffer_history;
70
719b4a40
RS
71Lisp_Object Qread_file_name_internal;
72
177aecf9 73/* Normal hooks for entry to and exit from minibuffer. */
5c781212
RS
74
75Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
177aecf9 76Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
5c781212 77
f927c5ae
JB
78/* Nonzero means completion ignores case. */
79
80int completion_ignore_case;
81
42006772
RS
82/* List of regexps that should restrict possible completions. */
83
84Lisp_Object Vcompletion_regexp_list;
85
6a9ee000
RS
86/* Nonzero means raise the minibuffer frame when the minibuffer
87 is entered. */
88
89int minibuffer_auto_raise;
90
f927c5ae
JB
91/* If last completion attempt reported "Complete but not unique"
92 then this is the string completed then; otherwise this is nil. */
93
94static Lisp_Object last_exact_completion;
95
96Lisp_Object Quser_variable_p;
2cb6da5c
RS
97
98/* Non-nil means it is the window for C-M-v to scroll
99 when the minibuffer is selected. */
100extern Lisp_Object Vminibuf_scroll_window;
f927c5ae
JB
101\f
102/* Actual minibuffer invocation. */
103
104void read_minibuf_unwind ();
105Lisp_Object get_minibuffer ();
106Lisp_Object read_minibuf ();
107
770970cb 108/* Read from the minibuffer using keymap MAP, initial contents INITIAL
85b5fe07 109 (a string), putting point minus BACKUP_N chars from the end of INITIAL,
770970cb 110 prompting with PROMPT (a string), using history list HISTVAR
85b5fe07 111 with initial position HISTPOS. (BACKUP_N should be <= 0.)
770970cb
RS
112
113 Normally return the result as a string (the text that was read),
b278606c
BF
114 but if EXPFLAG is non-nil, read it and return the object read.
115 If HISTVAR is given, save the value read on that history only if it doesn't
116 match the front of that history list exactly. The value is pushed onto
117 the list as the string that was read, or as the object that resulted iff
118 EXPFLAG is non-nil. */
770970cb 119
f927c5ae 120Lisp_Object
770970cb 121read_minibuf (map, initial, prompt, backup_n, expflag, histvar, histpos)
f927c5ae
JB
122 Lisp_Object map;
123 Lisp_Object initial;
124 Lisp_Object prompt;
5061d9c3 125 Lisp_Object backup_n;
f927c5ae 126 int expflag;
770970cb
RS
127 Lisp_Object histvar;
128 Lisp_Object histpos;
f927c5ae
JB
129{
130 register Lisp_Object val;
131 int count = specpdl_ptr - specpdl;
5061d9c3 132 Lisp_Object mini_frame;
f927c5ae
JB
133
134 if (XTYPE (prompt) != Lisp_String)
135 prompt = build_string ("");
136
137 /* Emacs in -batch mode calls minibuffer: print the prompt. */
138 if (noninteractive && XTYPE (prompt) == Lisp_String)
139 printf ("%s", XSTRING (prompt)->data);
140
141 if (!enable_recursive_minibuffers
142 && minibuf_level > 0
143 && (EQ (selected_window, minibuf_window)))
144#if 0
ff11dfa1 145 || selected_frame != XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)))
f927c5ae
JB
146#endif
147 error ("Command attempted to use minibuffer while in minibuffer");
148
4d04c1f1
KH
149 /* Could we simply bind these variables instead? */
150 minibuf_save_list
151 = Fcons (minibuf_prompt,
152 Fcons (make_number (minibuf_prompt_width),
153 Fcons (Vhelp_form,
154 Fcons (Vcurrent_prefix_arg,
155 Fcons (Vminibuffer_history_position,
156 Fcons (Vminibuffer_history_variable,
157 minibuf_save_list))))));
f927c5ae 158 minibuf_prompt_width = 0;
f927c5ae
JB
159
160 record_unwind_protect (Fset_window_configuration,
b2b2c677
JB
161 Fcurrent_window_configuration (Qnil));
162
ff11dfa1
JB
163 /* If the minibuffer window is on a different frame, save that
164 frame's configuration too. */
5061d9c3 165#ifdef MULTI_FRAME
75f00e72 166 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
ff11dfa1 167 if (XFRAME (mini_frame) != selected_frame)
5061d9c3
RS
168 record_unwind_protect (Fset_window_configuration,
169 Fcurrent_window_configuration (mini_frame));
5563e8e8
KH
170
171 /* If the minibuffer is on an iconified or invisible frame,
172 make it visible now. */
173 Fmake_frame_visible (mini_frame);
174
6a9ee000
RS
175 if (minibuffer_auto_raise)
176 Fraise_frame (mini_frame);
5061d9c3 177#endif
f927c5ae
JB
178
179 val = current_buffer->directory;
180 Fset_buffer (get_minibuffer (minibuf_level));
64a3a3c0
JB
181
182 /* The current buffer's default directory is usually the right thing
183 for our minibuffer here. However, if you're typing a command at
184 a minibuffer-only frame when minibuf_level is zero, then buf IS
185 the current_buffer, so reset_buffer leaves buf's default
186 directory unchanged. This is a bummer when you've just started
187 up Emacs and buf's default directory is Qnil. Here's a hack; can
188 you think of something better to do? Find another buffer with a
189 better directory, and use that one instead. */
190 if (XTYPE (val) == Lisp_String)
191 current_buffer->directory = val;
192 else
193 {
194 Lisp_Object buf_list;
195
196 for (buf_list = Vbuffer_alist;
197 CONSP (buf_list);
198 buf_list = XCONS (buf_list)->cdr)
199 {
1e62748e 200 Lisp_Object other_buf;
64a3a3c0 201
1e62748e 202 other_buf = XCONS (XCONS (buf_list)->car)->cdr;
64a3a3c0
JB
203 if (XTYPE (XBUFFER (other_buf)->directory) == Lisp_String)
204 {
205 current_buffer->directory = XBUFFER (other_buf)->directory;
206 break;
207 }
208 }
209 }
210
33b1baf6 211#ifdef MULTI_FRAME
0abbff13
KH
212 if (XFRAME (mini_frame) != selected_frame)
213 Fredirect_frame_focus (Fselected_frame (), mini_frame);
33b1baf6 214#endif
f927c5ae
JB
215 Fmake_local_variable (Qprint_escape_newlines);
216 print_escape_newlines = 1;
217
43bad991 218 record_unwind_protect (read_minibuf_unwind, Qnil);
43bad991 219
f927c5ae
JB
220 Vminibuf_scroll_window = selected_window;
221 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
f927c5ae
JB
222 Fselect_window (minibuf_window);
223 XFASTINT (XWINDOW (minibuf_window)->hscroll) = 0;
224
225 Ferase_buffer ();
226 minibuf_level++;
f927c5ae 227
56a98455 228 if (!NILP (initial))
f927c5ae
JB
229 {
230 Finsert (1, &initial);
56a98455 231 if (!NILP (backup_n) && XTYPE (backup_n) == Lisp_Int)
f927c5ae
JB
232 Fforward_char (backup_n);
233 }
234
4d04c1f1 235 minibuf_prompt = Fcopy_sequence (prompt);
f927c5ae 236 echo_area_glyphs = 0;
73168c8b
RS
237 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
238 previous_echo_glyphs = 0;
f927c5ae
JB
239
240 Vhelp_form = Vminibuffer_help_form;
241 current_buffer->keymap = map;
770970cb
RS
242 Vminibuffer_history_position = histpos;
243 Vminibuffer_history_variable = histvar;
f927c5ae 244
5c781212
RS
245 /* Run our hook, but not if it is empty.
246 (run-hooks would do nothing if it is empty,
247 but it's important to save time here in the usual case. */
92d3b06e
RS
248 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
249 && !NILP (Vrun_hooks))
5c781212
RS
250 call1 (Vrun_hooks, Qminibuffer_setup_hook);
251
f927c5ae
JB
252/* ??? MCC did redraw_screen here if switching screens. */
253 recursive_edit_1 ();
254
255 /* If cursor is on the minibuffer line,
256 show the user we have exited by putting it in column 0. */
ff11dfa1 257 if ((FRAME_CURSOR_Y (selected_frame)
f927c5ae
JB
258 >= XFASTINT (XWINDOW (minibuf_window)->top))
259 && !noninteractive)
260 {
ff11dfa1
JB
261 FRAME_CURSOR_X (selected_frame) = 0;
262 update_frame (selected_frame, 1, 1);
f927c5ae
JB
263 }
264
265 /* Make minibuffer contents into a string */
ffd56f97 266 val = make_buffer_string (1, Z);
f927c5ae 267 bcopy (GAP_END_ADDR, XSTRING (val)->data + GPT - BEG, Z - GPT);
770970cb 268
b278606c
BF
269 /* VAL is the string of minibuffer text. */
270 last_minibuf_string = val;
271
7c70cfd3
KH
272 /* Add the value to the appropriate history list unless it is empty. */
273 if (XSTRING (val)->size != 0
274 && XTYPE (Vminibuffer_history_variable) == Lisp_Symbol
b278606c
BF
275 && ! EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
276 {
277 /* If the caller wanted to save the value read on a history list,
60b73b25
RS
278 then do so if the value is not already the front of the list. */
279 Lisp_Object histval;
280 histval = Fsymbol_value (Vminibuffer_history_variable);
b278606c
BF
281
282 /* The value of the history variable must be a cons or nil. Other
60b73b25 283 values are unacceptable. We silently ignore these values. */
b278606c 284 if (NILP (histval)
60b73b25
RS
285 || (CONSP (histval)
286 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
287 Fset (Vminibuffer_history_variable,
288 Fcons (last_minibuf_string, histval));
b278606c 289 }
770970cb 290
60b73b25
RS
291 /* If Lisp form desired instead of string, parse it. */
292 if (expflag)
8acd16de
KH
293 {
294 Lisp_Object expr_and_pos;
295 unsigned char *p;
296
297 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
298 /* Ignore trailing whitespace; any other trailing junk is an error. */
299 for (p = XSTRING (val)->data + XINT (Fcdr (expr_and_pos)); *p; p++)
300 if (*p != ' ' && *p != '\t' && *p != '\n')
301 error ("Trailing garbage following expression");
302 val = Fcar (expr_and_pos);
303 }
60b73b25 304
2cb6da5c
RS
305 return unbind_to (count, val); /* The appropriate frame will get selected
306 in set-window-configuration. */
f927c5ae
JB
307}
308
309/* Return a buffer to be used as the minibuffer at depth `depth'.
310 depth = 0 is the lowest allowed argument, and that is the value
311 used for nonrecursive minibuffer invocations */
312
313Lisp_Object
314get_minibuffer (depth)
315 int depth;
316{
317 Lisp_Object tail, num, buf;
9f6c23bc 318 char name[24];
f927c5ae
JB
319 extern Lisp_Object nconc2 ();
320
321 XFASTINT (num) = depth;
322 tail = Fnthcdr (num, Vminibuffer_list);
56a98455 323 if (NILP (tail))
f927c5ae
JB
324 {
325 tail = Fcons (Qnil, Qnil);
326 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
327 }
328 buf = Fcar (tail);
56a98455 329 if (NILP (buf) || NILP (XBUFFER (buf)->name))
f927c5ae
JB
330 {
331 sprintf (name, " *Minibuf-%d*", depth);
332 buf = Fget_buffer_create (build_string (name));
5d6533f1
JB
333
334 /* Although the buffer's name starts with a space, undo should be
335 enabled in it. */
336 Fbuffer_enable_undo (buf);
337
f927c5ae
JB
338 XCONS (tail)->car = buf;
339 }
340 else
5956f71d 341 {
6b3faad8
RS
342 int count = specpdl_ptr - specpdl;
343
5956f71d 344 reset_buffer (XBUFFER (buf));
6b3faad8
RS
345 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
346 Fset_buffer (buf);
347 Fkill_all_local_variables ();
348 unbind_to (count, Qnil);
5956f71d 349 }
64a3a3c0 350
f927c5ae
JB
351 return buf;
352}
353
354/* This function is called on exiting minibuffer, whether normally or not,
355 and it restores the current window, buffer, etc. */
356
357void
43bad991
JB
358read_minibuf_unwind (data)
359 Lisp_Object data;
f927c5ae 360{
0a1dd1c5
RS
361 /* We are exiting the minibuffer one way or the other,
362 so run the hook. */
363 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
364 && !NILP (Vrun_hooks))
365 call1 (Vrun_hooks, Qminibuffer_exit_hook);
366
f927c5ae
JB
367 /* Erase the minibuffer we were using at this level. */
368 Fset_buffer (XWINDOW (minibuf_window)->buffer);
369
370 /* Prevent error in erase-buffer. */
371 current_buffer->read_only = Qnil;
372 Ferase_buffer ();
373
374 /* If this was a recursive minibuffer,
375 tie the minibuffer window back to the outer level minibuffer buffer */
376 minibuf_level--;
377 /* Make sure minibuffer window is erased, not ignored */
378 windows_or_buffers_changed++;
379 XFASTINT (XWINDOW (minibuf_window)->last_modified) = 0;
380
4d04c1f1
KH
381 /* Restore prompt, etc from outer minibuffer */
382 minibuf_prompt = Fcar (minibuf_save_list);
383 minibuf_save_list = Fcdr (minibuf_save_list);
384 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
385 minibuf_save_list = Fcdr (minibuf_save_list);
386 Vhelp_form = Fcar (minibuf_save_list);
387 minibuf_save_list = Fcdr (minibuf_save_list);
388 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
389 minibuf_save_list = Fcdr (minibuf_save_list);
390 Vminibuffer_history_position = Fcar (minibuf_save_list);
391 minibuf_save_list = Fcdr (minibuf_save_list);
392 Vminibuffer_history_variable = Fcar (minibuf_save_list);
393 minibuf_save_list = Fcdr (minibuf_save_list);
f927c5ae
JB
394}
395\f
b9d721de
JB
396
397/* This comment supplies the doc string for read-from-minibuffer,
398 for make-docfile to see. We cannot put this in the real DEFUN
399 due to limits in the Unix cpp.
400
f927c5ae
JB
401DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
402 "Read a string from the minibuffer, prompting with string PROMPT.\n\
403If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
404 to be inserted into the minibuffer before reading input.\n\
770970cb
RS
405 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
406 is STRING, but point is placed POSITION characters into the string.\n\
f927c5ae
JB
407Third arg KEYMAP is a keymap to use whilst reading;\n\
408 if omitted or nil, the default is `minibuffer-local-map'.\n\
409If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
410 and return that object:\n\
411 in other words, do `(car (read-from-string INPUT-STRING))'\n\
770970cb
RS
412Fifth arg HIST, if non-nil, specifies a history list\n\
413 and optionally the initial position in the list.\n\
414 It can be a symbol, which is the history list variable to use,\n\
415 or it can be a cons cell (HISTVAR . HISTPOS).\n\
416 In that case, HISTVAR is the history list variable to use,\n\
417 and HISTPOS is the initial position (the position in the list\n\
418 which INITIAL-CONTENTS corresponds to).\n\
b9d721de
JB
419 Positions are counted starting from 1 at the beginning of the list."
420*/
421
422DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
423 0 /* See immediately above */)
68e5a8a2
RS
424 (prompt, initial_contents, keymap, read, hist)
425 Lisp_Object prompt, initial_contents, keymap, read, hist;
f927c5ae
JB
426{
427 int pos = 0;
770970cb
RS
428 Lisp_Object histvar, histpos, position;
429 position = Qnil;
f927c5ae
JB
430
431 CHECK_STRING (prompt, 0);
68e5a8a2 432 if (!NILP (initial_contents))
f927c5ae 433 {
68e5a8a2 434 if (XTYPE (initial_contents) == Lisp_Cons)
770970cb 435 {
68e5a8a2
RS
436 position = Fcdr (initial_contents);
437 initial_contents = Fcar (initial_contents);
770970cb 438 }
68e5a8a2 439 CHECK_STRING (initial_contents, 1);
56a98455 440 if (!NILP (position))
f927c5ae
JB
441 {
442 CHECK_NUMBER (position, 0);
443 /* Convert to distance from end of input. */
68e5a8a2 444 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
f927c5ae
JB
445 }
446 }
447
56a98455 448 if (NILP (keymap))
f927c5ae
JB
449 keymap = Vminibuffer_local_map;
450 else
451 keymap = get_keymap (keymap,2);
770970cb
RS
452
453 if (XTYPE (hist) == Lisp_Symbol)
454 {
455 histvar = hist;
456 histpos = Qnil;
457 }
458 else
459 {
460 histvar = Fcar_safe (hist);
461 histpos = Fcdr_safe (hist);
462 }
463 if (NILP (histvar))
464 histvar = Qminibuffer_history;
465 if (NILP (histpos))
466 XFASTINT (histpos) = 0;
467
68e5a8a2 468 return read_minibuf (keymap, initial_contents, prompt,
85b5fe07 469 make_number (pos), !NILP (read), histvar, histpos);
f927c5ae
JB
470}
471
472DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
473 "Return a Lisp object read using the minibuffer.\n\
474Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
475is a string to insert in the minibuffer before reading.")
476 (prompt, initial_contents)
477 Lisp_Object prompt, initial_contents;
478{
479 CHECK_STRING (prompt, 0);
56a98455 480 if (!NILP (initial_contents))
a1b4b084 481 CHECK_STRING (initial_contents, 1);
770970cb
RS
482 return read_minibuf (Vminibuffer_local_map, initial_contents,
483 prompt, Qnil, 1, Qminibuffer_history, make_number (0));
f927c5ae
JB
484}
485
486DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
487 "Return value of Lisp expression read using the minibuffer.\n\
488Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
489is a string to insert in the minibuffer before reading.")
490 (prompt, initial_contents)
491 Lisp_Object prompt, initial_contents;
492{
493 return Feval (Fread_minibuffer (prompt, initial_contents));
494}
495
496/* Functions that use the minibuffer to read various things. */
497
498DEFUN ("read-string", Fread_string, Sread_string, 1, 2, 0,
499 "Read a string from the minibuffer, prompting with string PROMPT.\n\
500If non-nil second arg INITIAL-INPUT is a string to insert before reading.")
501 (prompt, initial_input)
502 Lisp_Object prompt, initial_input;
503{
504 return Fread_from_minibuffer (prompt, initial_input, Qnil, Qnil, Qnil);
505}
506
b278606c 507DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 2, 0,
f927c5ae
JB
508 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
509Prompt with PROMPT, and provide INIT as an initial value of the input string.")
510 (prompt, init)
511 Lisp_Object prompt, init;
512{
513 CHECK_STRING (prompt, 0);
56a98455 514 if (! NILP (init))
f927c5ae
JB
515 CHECK_STRING (init, 1);
516
770970cb
RS
517 return read_minibuf (Vminibuffer_local_ns_map, init, prompt, Qnil, 0,
518 Qminibuffer_history, make_number (0));
f927c5ae
JB
519}
520
521DEFUN ("read-command", Fread_command, Sread_command, 1, 1, 0,
522 "One arg PROMPT, a string. Read the name of a command and return as a symbol.\n\
523Prompts with PROMPT.")
524 (prompt)
525 Lisp_Object prompt;
526{
527 return Fintern (Fcompleting_read (prompt, Vobarray, Qcommandp, Qt, Qnil, Qnil),
528 Qnil);
529}
530
531#ifdef NOTDEF
532DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
533 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
534Prompts with PROMPT.")
535 (prompt)
536 Lisp_Object prompt;
537{
538 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil),
539 Qnil);
540}
541#endif /* NOTDEF */
542
543DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 1, 0,
544 "One arg PROMPT, a string. Read the name of a user variable and return\n\
545it as a symbol. Prompts with PROMPT.\n\
546A user variable is one whose documentation starts with a `*' character.")
547 (prompt)
548 Lisp_Object prompt;
549{
550 return Fintern (Fcompleting_read (prompt, Vobarray,
551 Quser_variable_p, Qt, Qnil, Qnil),
552 Qnil);
553}
554
555DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
556 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
557Prompts with PROMPT.\n\
558Optional second arg is value to return if user enters an empty line.\n\
559If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
560 (prompt, def, require_match)
561 Lisp_Object prompt, def, require_match;
562{
563 Lisp_Object tem;
564 Lisp_Object args[3];
565 struct gcpro gcpro1;
566
567 if (XTYPE (def) == Lisp_Buffer)
568 def = XBUFFER (def)->name;
56a98455 569 if (!NILP (def))
f927c5ae
JB
570 {
571 args[0] = build_string ("%s(default %s) ");
572 args[1] = prompt;
573 args[2] = def;
574 prompt = Fformat (3, args);
575 }
576 GCPRO1 (def);
577 tem = Fcompleting_read (prompt, Vbuffer_alist, Qnil, require_match, Qnil, Qnil);
578 UNGCPRO;
579 if (XSTRING (tem)->size)
580 return tem;
581 return def;
582}
583\f
584DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
585 "Return common substring of all completions of STRING in ALIST.\n\
586Each car of each element of ALIST is tested to see if it begins with STRING.\n\
587All that match are compared together; the longest initial sequence\n\
588common to all matches is returned as a string.\n\
589If there is no match at all, nil is returned.\n\
590For an exact match, t is returned.\n\
591\n\
592ALIST can be an obarray instead of an alist.\n\
593Then the print names of all symbols in the obarray are the possible matches.\n\
594\n\
595ALIST can also be a function to do the completion itself.\n\
596It receives three arguments: the values STRING, PREDICATE and nil.\n\
597Whatever it returns becomes the value of `try-completion'.\n\
598\n\
599If optional third argument PREDICATE is non-nil,\n\
600it is used to test each possible match.\n\
601The match is a candidate only if PREDICATE returns non-nil.\n\
602The argument given to PREDICATE is the alist element or the symbol from the obarray.")
603 (string, alist, pred)
604 Lisp_Object string, alist, pred;
605{
606 Lisp_Object bestmatch, tail, elt, eltstring;
607 int bestmatchsize;
608 int compare, matchsize;
56a98455 609 int list = CONSP (alist) || NILP (alist);
f927c5ae
JB
610 int index, obsize;
611 int matchcount = 0;
612 Lisp_Object bucket, zero, end, tem;
613 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
614
615 CHECK_STRING (string, 0);
616 if (!list && XTYPE (alist) != Lisp_Vector)
617 return call3 (alist, string, pred, Qnil);
618
619 bestmatch = Qnil;
620
621 /* If ALIST is not a list, set TAIL just for gc pro. */
622 tail = alist;
623 if (! list)
624 {
625 index = 0;
626 obsize = XVECTOR (alist)->size;
627 bucket = XVECTOR (alist)->contents[index];
628 }
629
630 while (1)
631 {
632 /* Get the next element of the alist or obarray. */
633 /* Exit the loop if the elements are all used up. */
634 /* elt gets the alist element or symbol.
635 eltstring gets the name to check as a completion. */
636
637 if (list)
638 {
56a98455 639 if (NILP (tail))
f927c5ae
JB
640 break;
641 elt = Fcar (tail);
642 eltstring = Fcar (elt);
643 tail = Fcdr (tail);
644 }
645 else
646 {
647 if (XFASTINT (bucket) != 0)
648 {
649 elt = bucket;
650 eltstring = Fsymbol_name (elt);
651 if (XSYMBOL (bucket)->next)
652 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
653 else
654 XFASTINT (bucket) = 0;
655 }
656 else if (++index >= obsize)
657 break;
658 else
659 {
660 bucket = XVECTOR (alist)->contents[index];
661 continue;
662 }
663 }
664
665 /* Is this element a possible completion? */
666
42006772
RS
667 if (XTYPE (eltstring) == Lisp_String
668 && XSTRING (string)->size <= XSTRING (eltstring)->size
669 && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
670 XSTRING (string)->size))
f927c5ae
JB
671 {
672 /* Yes. */
42006772
RS
673 Lisp_Object regexps;
674 Lisp_Object zero;
675 XFASTINT (zero) = 0;
676
677 /* Ignore this element if it fails to match all the regexps. */
678 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
679 regexps = XCONS (regexps)->cdr)
680 {
681 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
682 if (NILP (tem))
683 break;
684 }
685 if (CONSP (regexps))
686 continue;
687
f927c5ae
JB
688 /* Ignore this element if there is a predicate
689 and the predicate doesn't like it. */
690
56a98455 691 if (!NILP (pred))
f927c5ae
JB
692 {
693 if (EQ (pred, Qcommandp))
694 tem = Fcommandp (elt);
695 else
696 {
697 GCPRO4 (tail, string, eltstring, bestmatch);
698 tem = call1 (pred, elt);
699 UNGCPRO;
700 }
56a98455 701 if (NILP (tem)) continue;
f927c5ae
JB
702 }
703
704 /* Update computation of how much all possible completions match */
705
706 matchcount++;
56a98455 707 if (NILP (bestmatch))
f927c5ae
JB
708 bestmatch = eltstring, bestmatchsize = XSTRING (eltstring)->size;
709 else
710 {
711 compare = min (bestmatchsize, XSTRING (eltstring)->size);
712 matchsize = scmp (XSTRING (bestmatch)->data,
713 XSTRING (eltstring)->data,
714 compare);
52b14ac0
JB
715 if (matchsize < 0)
716 matchsize = compare;
717 if (completion_ignore_case)
718 {
719 /* If this is an exact match except for case,
720 use it as the best match rather than one that is not an
721 exact match. This way, we get the case pattern
722 of the actual match. */
723 if ((matchsize == XSTRING (eltstring)->size
724 && matchsize < XSTRING (bestmatch)->size)
725 ||
726 /* If there is more than one exact match ignoring case,
727 and one of them is exact including case,
728 prefer that one. */
729 /* If there is no exact match ignoring case,
730 prefer a match that does not change the case
731 of the input. */
732 ((matchsize == XSTRING (eltstring)->size)
733 ==
734 (matchsize == XSTRING (bestmatch)->size)
735 && !bcmp (XSTRING (eltstring)->data,
736 XSTRING (string)->data, XSTRING (string)->size)
737 && bcmp (XSTRING (bestmatch)->data,
738 XSTRING (string)->data, XSTRING (string)->size)))
739 bestmatch = eltstring;
740 }
741 bestmatchsize = matchsize;
f927c5ae
JB
742 }
743 }
744 }
745
56a98455 746 if (NILP (bestmatch))
f927c5ae 747 return Qnil; /* No completions found */
52b14ac0
JB
748 /* If we are ignoring case, and there is no exact match,
749 and no additional text was supplied,
750 don't change the case of what the user typed. */
751 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
752 && XSTRING (bestmatch)->size > bestmatchsize)
753 return string;
754
755 /* Return t if the supplied string is an exact match (counting case);
756 it does not require any change to be made. */
757 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
758 && !bcmp (XSTRING (bestmatch)->data, XSTRING (string)->data,
759 bestmatchsize))
f927c5ae
JB
760 return Qt;
761
762 XFASTINT (zero) = 0; /* Else extract the part in which */
763 XFASTINT (end) = bestmatchsize; /* all completions agree */
764 return Fsubstring (bestmatch, zero, end);
765}
766
767/* Compare exactly LEN chars of strings at S1 and S2,
768 ignoring case if appropriate.
769 Return -1 if strings match,
770 else number of chars that match at the beginning. */
771
772scmp (s1, s2, len)
773 register char *s1, *s2;
774 int len;
775{
776 register int l = len;
777
778 if (completion_ignore_case)
779 {
780 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
781 l--;
782 }
783 else
784 {
785 while (l && *s1++ == *s2++)
786 l--;
787 }
788 if (l == 0)
789 return -1;
790 else return len - l;
791}
792\f
793DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 3, 0,
794 "Search for partial matches to STRING in ALIST.\n\
795Each car of each element of ALIST is tested to see if it begins with STRING.\n\
796The value is a list of all the strings from ALIST that match.\n\
797ALIST can be an obarray instead of an alist.\n\
798Then the print names of all symbols in the obarray are the possible matches.\n\
799\n\
800ALIST can also be a function to do the completion itself.\n\
801It receives three arguments: the values STRING, PREDICATE and t.\n\
802Whatever it returns becomes the value of `all-completion'.\n\
803\n\
804If optional third argument PREDICATE is non-nil,\n\
805it is used to test each possible match.\n\
806The match is a candidate only if PREDICATE returns non-nil.\n\
807The argument given to PREDICATE is the alist element or the symbol from the obarray.")
808 (string, alist, pred)
809 Lisp_Object string, alist, pred;
810{
811 Lisp_Object tail, elt, eltstring;
812 Lisp_Object allmatches;
56a98455 813 int list = CONSP (alist) || NILP (alist);
f927c5ae
JB
814 int index, obsize;
815 Lisp_Object bucket, tem;
816 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
817
818 CHECK_STRING (string, 0);
819 if (!list && XTYPE (alist) != Lisp_Vector)
820 {
821 return call3 (alist, string, pred, Qt);
822 }
823 allmatches = Qnil;
824
825 /* If ALIST is not a list, set TAIL just for gc pro. */
826 tail = alist;
827 if (! list)
828 {
829 index = 0;
830 obsize = XVECTOR (alist)->size;
831 bucket = XVECTOR (alist)->contents[index];
832 }
833
834 while (1)
835 {
836 /* Get the next element of the alist or obarray. */
837 /* Exit the loop if the elements are all used up. */
838 /* elt gets the alist element or symbol.
839 eltstring gets the name to check as a completion. */
840
841 if (list)
842 {
56a98455 843 if (NILP (tail))
f927c5ae
JB
844 break;
845 elt = Fcar (tail);
846 eltstring = Fcar (elt);
847 tail = Fcdr (tail);
848 }
849 else
850 {
851 if (XFASTINT (bucket) != 0)
852 {
853 elt = bucket;
854 eltstring = Fsymbol_name (elt);
855 if (XSYMBOL (bucket)->next)
856 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
857 else
858 XFASTINT (bucket) = 0;
859 }
860 else if (++index >= obsize)
861 break;
862 else
863 {
864 bucket = XVECTOR (alist)->contents[index];
865 continue;
866 }
867 }
868
869 /* Is this element a possible completion? */
870
2cbaf886
RS
871 if (XTYPE (eltstring) == Lisp_String
872 && XSTRING (string)->size <= XSTRING (eltstring)->size
873 /* Reject alternatives that start with space
874 unless the input starts with space. */
875 && ((XSTRING (string)->size > 0 && XSTRING (string)->data[0] == ' ')
876 || XSTRING (eltstring)->data[0] != ' ')
877 && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
878 XSTRING (string)->size))
f927c5ae
JB
879 {
880 /* Yes. */
42006772
RS
881 Lisp_Object regexps;
882 Lisp_Object zero;
883 XFASTINT (zero) = 0;
884
885 /* Ignore this element if it fails to match all the regexps. */
886 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
887 regexps = XCONS (regexps)->cdr)
888 {
889 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
890 if (NILP (tem))
891 break;
892 }
893 if (CONSP (regexps))
894 continue;
895
f927c5ae
JB
896 /* Ignore this element if there is a predicate
897 and the predicate doesn't like it. */
898
56a98455 899 if (!NILP (pred))
f927c5ae
JB
900 {
901 if (EQ (pred, Qcommandp))
902 tem = Fcommandp (elt);
903 else
904 {
905 GCPRO4 (tail, eltstring, allmatches, string);
906 tem = call1 (pred, elt);
907 UNGCPRO;
908 }
56a98455 909 if (NILP (tem)) continue;
f927c5ae
JB
910 }
911 /* Ok => put it on the list. */
912 allmatches = Fcons (eltstring, allmatches);
913 }
914 }
915
916 return Fnreverse (allmatches);
917}
918\f
919Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
920Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
921Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
922
b9d721de
JB
923/* This comment supplies the doc string for completing-read,
924 for make-docfile to see. We cannot put this in the real DEFUN
925 due to limits in the Unix cpp.
926
f927c5ae
JB
927DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
928 "Read a string in the minibuffer, with completion.\n\
770970cb 929Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, HIST.\n\
f927c5ae
JB
930PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
931TABLE is an alist whose elements' cars are strings, or an obarray.\n\
932PREDICATE limits completion to a subset of TABLE.\n\
6b3faad8
RS
933See `try-completion' and `all-completions' for more details
934 on completion, TABLE, and PREDICATE.\n\
cbbc3917 935\n\
f927c5ae 936If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
4ced3209 937 the input is (or completes to) an element of TABLE or is null.\n\
f927c5ae 938 If it is also not t, Return does not exit if it does non-null completion.\n\
cbbc3917
RS
939If the input is null, `completing-read' returns nil,\n\
940 regardless of the value of REQUIRE-MATCH.\n\
941\n\
f927c5ae 942If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
770970cb
RS
943 If it is (STRING . POSITION), the initial input\n\
944 is STRING, but point is placed POSITION characters into the string.\n\
945HIST, if non-nil, specifies a history list\n\
946 and optionally the initial position in the list.\n\
947 It can be a symbol, which is the history list variable to use,\n\
948 or it can be a cons cell (HISTVAR . HISTPOS).\n\
949 In that case, HISTVAR is the history list variable to use,\n\
950 and HISTPOS is the initial position (the position in the list\n\
951 which INITIAL-CONTENTS corresponds to).\n\
952 Positions are counted starting from 1 at the beginning of the list.\n\
953Completion ignores case if the ambient value of\n\
b9d721de
JB
954 `completion-ignore-case' is non-nil."
955*/
956DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
957 0 /* See immediately above */)
770970cb
RS
958 (prompt, table, pred, require_match, init, hist)
959 Lisp_Object prompt, table, pred, require_match, init, hist;
f927c5ae 960{
770970cb
RS
961 Lisp_Object val, histvar, histpos, position;
962 int pos = 0;
f927c5ae
JB
963 int count = specpdl_ptr - specpdl;
964 specbind (Qminibuffer_completion_table, table);
965 specbind (Qminibuffer_completion_predicate, pred);
966 specbind (Qminibuffer_completion_confirm,
967 EQ (require_match, Qt) ? Qnil : Qt);
968 last_exact_completion = Qnil;
770970cb
RS
969
970 position = Qnil;
971 if (!NILP (init))
972 {
973 if (XTYPE (init) == Lisp_Cons)
974 {
975 position = Fcdr (init);
976 init = Fcar (init);
977 }
978 CHECK_STRING (init, 0);
979 if (!NILP (position))
980 {
981 CHECK_NUMBER (position, 0);
982 /* Convert to distance from end of input. */
5dadd3a2 983 pos = XINT (position) - XSTRING (init)->size;
770970cb
RS
984 }
985 }
986
987 if (XTYPE (hist) == Lisp_Symbol)
988 {
989 histvar = hist;
990 histpos = Qnil;
991 }
992 else
993 {
994 histvar = Fcar_safe (hist);
995 histpos = Fcdr_safe (hist);
996 }
997 if (NILP (histvar))
998 histvar = Qminibuffer_history;
999 if (NILP (histpos))
1000 XFASTINT (histpos) = 0;
1001
56a98455 1002 val = read_minibuf (NILP (require_match)
f927c5ae
JB
1003 ? Vminibuffer_local_completion_map
1004 : Vminibuffer_local_must_match_map,
85b5fe07 1005 init, prompt, make_number (pos), 0,
770970cb 1006 histvar, histpos);
f927c5ae
JB
1007 return unbind_to (count, val);
1008}
1009\f
1010/* Temporarily display the string M at the end of the current
1011 minibuffer contents. This is used to display things like
1012 "[No Match]" when the user requests a completion for a prefix
1013 that has no possible completions, and other quick, unobtrusive
1014 messages. */
1015
1016temp_echo_area_glyphs (m)
1017 char *m;
1018{
f927c5ae
JB
1019 int osize = ZV;
1020 Lisp_Object oinhibit;
1021 oinhibit = Vinhibit_quit;
1022
896adf84
JB
1023 /* Clear out any old echo-area message to make way for our new thing. */
1024 message (0);
f927c5ae
JB
1025
1026 SET_PT (osize);
1027 insert_string (m);
1028 SET_PT (osize);
1029 Vinhibit_quit = Qt;
1030 Fsit_for (make_number (2), Qnil, Qnil);
a2dd849e 1031 del_range (PT, ZV);
56a98455 1032 if (!NILP (Vquit_flag))
f927c5ae
JB
1033 {
1034 Vquit_flag = Qnil;
ba71d84a 1035 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
f927c5ae
JB
1036 }
1037 Vinhibit_quit = oinhibit;
1038}
1039
1040Lisp_Object Fminibuffer_completion_help ();
52b14ac0 1041Lisp_Object assoc_for_completion ();
f927c5ae
JB
1042
1043/* returns:
1044 * 0 no possible completion
1045 * 1 was already an exact and unique completion
1046 * 3 was already an exact completion
1047 * 4 completed to an exact completion
1048 * 5 some completion happened
1049 * 6 no completion happened
1050 */
1051int
1052do_completion ()
1053{
1054 Lisp_Object completion, tem;
1055 int completedp;
1056 Lisp_Object last;
1e00c2ff 1057 struct gcpro gcpro1, gcpro2;
f927c5ae
JB
1058
1059 completion = Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table,
1060 Vminibuffer_completion_predicate);
1061 last = last_exact_completion;
1062 last_exact_completion = Qnil;
1063
4f9b95e5
KH
1064 GCPRO2 (completion, last);
1065
56a98455 1066 if (NILP (completion))
f927c5ae
JB
1067 {
1068 bitch_at_user ();
1069 temp_echo_area_glyphs (" [No match]");
1e00c2ff 1070 UNGCPRO;
f927c5ae
JB
1071 return 0;
1072 }
1073
1074 if (EQ (completion, Qt)) /* exact and unique match */
1e00c2ff
KH
1075 {
1076 UNGCPRO;
1077 return 1;
1078 }
f927c5ae
JB
1079
1080 /* compiler bug */
1081 tem = Fstring_equal (completion, Fbuffer_string());
56a98455 1082 if (completedp = NILP (tem))
f927c5ae
JB
1083 {
1084 Ferase_buffer (); /* Some completion happened */
1085 Finsert (1, &completion);
1086 }
1087
1088 /* It did find a match. Do we match some possibility exactly now? */
1089 if (CONSP (Vminibuffer_completion_table)
56a98455 1090 || NILP (Vminibuffer_completion_table))
52b14ac0
JB
1091 tem = assoc_for_completion (Fbuffer_string (),
1092 Vminibuffer_completion_table);
f927c5ae
JB
1093 else if (XTYPE (Vminibuffer_completion_table) == Lisp_Vector)
1094 {
1095 /* the primitive used by Fintern_soft */
1096 extern Lisp_Object oblookup ();
1097
1098 tem = Fbuffer_string ();
1099 /* Bypass intern-soft as that loses for nil */
1100 tem = oblookup (Vminibuffer_completion_table,
1101 XSTRING (tem)->data, XSTRING (tem)->size);
1102 if (XTYPE (tem) != Lisp_Symbol)
1103 tem = Qnil;
56a98455 1104 else if (!NILP (Vminibuffer_completion_predicate))
f927c5ae
JB
1105 tem = call1 (Vminibuffer_completion_predicate, tem);
1106 else
1107 tem = Qt;
1108 }
1109 else
1110 tem = call3 (Vminibuffer_completion_table,
1111 Fbuffer_string (),
1112 Vminibuffer_completion_predicate,
1113 Qlambda);
1114
56a98455 1115 if (NILP (tem))
1e00c2ff
KH
1116 {
1117 /* not an exact match */
1118 UNGCPRO;
f927c5ae
JB
1119 if (completedp)
1120 return 5;
1121 else if (auto_help)
1122 Fminibuffer_completion_help ();
1123 else
1124 temp_echo_area_glyphs (" [Next char not unique]");
1125 return 6;
1126 }
1127 else if (completedp)
1e00c2ff
KH
1128 {
1129 UNGCPRO;
1130 return 4;
1131 }
f927c5ae
JB
1132 /* If the last exact completion and this one were the same,
1133 it means we've already given a "Complete but not unique"
52b14ac0 1134 message and the user's hit TAB again, so now we give him help. */
f927c5ae 1135 last_exact_completion = completion;
56a98455 1136 if (!NILP (last))
f927c5ae
JB
1137 {
1138 tem = Fbuffer_string ();
56a98455 1139 if (!NILP (Fequal (tem, last)))
f927c5ae
JB
1140 Fminibuffer_completion_help ();
1141 }
1e00c2ff 1142 UNGCPRO;
f927c5ae 1143 return 3;
f927c5ae 1144}
1e00c2ff 1145
52b14ac0
JB
1146/* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1147
1148Lisp_Object
1149assoc_for_completion (key, list)
1150 register Lisp_Object key;
1151 Lisp_Object list;
1152{
1153 register Lisp_Object tail;
1154
1155 if (completion_ignore_case)
1156 key = Fupcase (key);
1157
56a98455 1158 for (tail = list; !NILP (tail); tail = Fcdr (tail))
52b14ac0
JB
1159 {
1160 register Lisp_Object elt, tem, thiscar;
1161 elt = Fcar (tail);
1162 if (!CONSP (elt)) continue;
1163 thiscar = Fcar (elt);
1164 if (XTYPE (thiscar) != Lisp_String)
1165 continue;
1166 if (completion_ignore_case)
1167 thiscar = Fupcase (thiscar);
1168 tem = Fequal (thiscar, key);
56a98455 1169 if (!NILP (tem)) return elt;
52b14ac0
JB
1170 QUIT;
1171 }
1172 return Qnil;
1173}
f927c5ae
JB
1174
1175DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
6300d782 1176 "Complete the minibuffer contents as far as possible.\n\
2cb6da5c
RS
1177Return nil if there is no valid completion, else t.\n\
1178If no characters can be completed, display a list of possible completions.\n\
1179If you repeat this command after it displayed such a list,\n\
1180scroll the window of possible completions.")
f927c5ae
JB
1181 ()
1182{
2cb6da5c
RS
1183 register int i;
1184 Lisp_Object window, tem;
1185
1186 /* If the previous command was not this, then mark the completion
1187 buffer obsolete. */
1188 if (! EQ (last_command, this_command))
1189 Vminibuf_scroll_window = Qnil;
1190
1191 window = Vminibuf_scroll_window;
1192 /* If there's a fresh completion window with a live buffer,
1193 and this command is repeated, scroll that window. */
1194 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1195 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1196 {
1197 struct buffer *obuf = current_buffer;
1198
1199 Fset_buffer (XWINDOW (window)->buffer);
1200 tem = Fpos_visible_in_window_p (make_number (ZV), window);
1201 if (! NILP (tem))
1202 /* If end is in view, scroll up to the beginning. */
8768d630 1203 Fset_window_start (window, BEGV, Qnil);
2cb6da5c
RS
1204 else
1205 /* Else scroll down one screen. */
1206 Fscroll_other_window (Qnil);
1207
1208 set_buffer_internal (obuf);
1209 return Qnil;
1210 }
1211
1212 i = do_completion ();
f927c5ae
JB
1213 switch (i)
1214 {
1215 case 0:
1216 return Qnil;
1217
1218 case 1:
1219 temp_echo_area_glyphs (" [Sole completion]");
1220 break;
1221
1222 case 3:
1223 temp_echo_area_glyphs (" [Complete, but not unique]");
1224 break;
1225 }
1226
1227 return Qt;
1228}
1229
1230DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1231 Sminibuffer_complete_and_exit, 0, 0, "",
1232 "Complete the minibuffer contents, and maybe exit.\n\
1233Exit if the name is valid with no completion needed.\n\
1234If name was completed to a valid match,\n\
1235a repetition of this command will exit.")
1236 ()
1237{
1238 register int i;
1239
1240 /* Allow user to specify null string */
1241 if (BEGV == ZV)
1242 goto exit;
1243
1244 i = do_completion ();
1245 switch (i)
1246 {
1247 case 1:
1248 case 3:
1249 goto exit;
1250
1251 case 4:
56a98455 1252 if (!NILP (Vminibuffer_completion_confirm))
f927c5ae
JB
1253 {
1254 temp_echo_area_glyphs (" [Confirm]");
1255 return Qnil;
1256 }
1257 else
1258 goto exit;
1259
1260 default:
1261 return Qnil;
1262 }
1263 exit:
1264 Fthrow (Qexit, Qnil);
1265 /* NOTREACHED */
1266}
1267
1268DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1269 0, 0, "",
1270 "Complete the minibuffer contents at most a single word.\n\
1271After one word is completed as much as possible, a space or hyphen\n\
6300d782
KH
1272is added, provided that matches some possible completion.\n\
1273Return nil if there is no valid completion, else t.")
f927c5ae
JB
1274 ()
1275{
1276 Lisp_Object completion, tem;
1277 register int i;
1278 register unsigned char *completion_string;
d7be4211 1279 struct gcpro gcpro1, gcpro2;
b278606c
BF
1280
1281 /* We keep calling Fbuffer_string rather than arrange for GC to
1282 hold onto a pointer to one of the strings thus made. */
f927c5ae
JB
1283
1284 completion = Ftry_completion (Fbuffer_string (),
1285 Vminibuffer_completion_table,
1286 Vminibuffer_completion_predicate);
56a98455 1287 if (NILP (completion))
f927c5ae
JB
1288 {
1289 bitch_at_user ();
1290 temp_echo_area_glyphs (" [No match]");
1291 return Qnil;
1292 }
1293 if (EQ (completion, Qt))
1294 return Qnil;
1295
b278606c 1296#if 0 /* How the below code used to look, for reference. */
f927c5ae
JB
1297 tem = Fbuffer_string ();
1298 b = XSTRING (tem)->data;
1299 i = ZV - 1 - XSTRING (completion)->size;
1300 p = XSTRING (completion)->data;
1301 if (i > 0 ||
1302 0 <= scmp (b, p, ZV - 1))
1303 {
1304 i = 1;
1305 /* Set buffer to longest match of buffer tail and completion head. */
1306 while (0 <= scmp (b + i, p, ZV - 1 - i))
1307 i++;
1308 del_range (1, i + 1);
1309 SET_PT (ZV);
1310 }
1311#else /* Rewritten code */
1312 {
1313 register unsigned char *buffer_string;
1314 int buffer_length, completion_length;
1315
1316 tem = Fbuffer_string ();
d7be4211 1317 GCPRO2 (completion, tem);
719b4a40
RS
1318 /* If reading a file name,
1319 expand any $ENVVAR refs in the buffer and in TEM. */
1320 if (EQ (Vminibuffer_completion_table, Qread_file_name_internal))
1321 {
1322 Lisp_Object substituted;
1323 substituted = Fsubstitute_in_file_name (tem);
1324 if (! EQ (substituted, tem))
1325 {
1326 tem = substituted;
1327 Ferase_buffer ();
3cab9ae4 1328 insert_from_string (tem, 0, XSTRING (tem)->size, 0);
719b4a40
RS
1329 }
1330 }
f927c5ae
JB
1331 buffer_string = XSTRING (tem)->data;
1332 completion_string = XSTRING (completion)->data;
1333 buffer_length = XSTRING (tem)->size; /* ie ZV - BEGV */
1334 completion_length = XSTRING (completion)->size;
1335 i = buffer_length - completion_length;
1336 /* Mly: I don't understand what this is supposed to do AT ALL */
1337 if (i > 0 ||
1338 0 <= scmp (buffer_string, completion_string, buffer_length))
1339 {
1340 /* Set buffer to longest match of buffer tail and completion head. */
1341 if (i <= 0) i = 1;
1342 buffer_string += i;
1343 buffer_length -= i;
1344 while (0 <= scmp (buffer_string++, completion_string, buffer_length--))
1345 i++;
1346 del_range (1, i + 1);
1347 SET_PT (ZV);
1348 }
d7be4211 1349 UNGCPRO;
f927c5ae
JB
1350 }
1351#endif /* Rewritten code */
1352 i = ZV - BEGV;
1353
1354 /* If completion finds next char not unique,
b278606c 1355 consider adding a space or a hyphen. */
f927c5ae
JB
1356 if (i == XSTRING (completion)->size)
1357 {
b278606c 1358 GCPRO1 (completion);
f927c5ae
JB
1359 tem = Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1360 Vminibuffer_completion_table,
1361 Vminibuffer_completion_predicate);
b278606c
BF
1362 UNGCPRO;
1363
f927c5ae
JB
1364 if (XTYPE (tem) == Lisp_String)
1365 completion = tem;
1366 else
1367 {
b278606c
BF
1368 GCPRO1 (completion);
1369 tem =
1370 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1371 Vminibuffer_completion_table,
1372 Vminibuffer_completion_predicate);
1373 UNGCPRO;
1374
f927c5ae
JB
1375 if (XTYPE (tem) == Lisp_String)
1376 completion = tem;
1377 }
1378 }
1379
1380 /* Now find first word-break in the stuff found by completion.
1381 i gets index in string of where to stop completing. */
b278606c 1382
f927c5ae
JB
1383 completion_string = XSTRING (completion)->data;
1384
1385 for (; i < XSTRING (completion)->size; i++)
1386 if (SYNTAX (completion_string[i]) != Sword) break;
1387 if (i < XSTRING (completion)->size)
1388 i = i + 1;
1389
1390 /* If got no characters, print help for user. */
1391
1392 if (i == ZV - BEGV)
1393 {
1394 if (auto_help)
1395 Fminibuffer_completion_help ();
1396 return Qnil;
1397 }
1398
1399 /* Otherwise insert in minibuffer the chars we got */
1400
1401 Ferase_buffer ();
3cab9ae4 1402 insert_from_string (completion, 0, i, 1);
f927c5ae
JB
1403 return Qt;
1404}
1405\f
1406DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
1407 1, 1, 0,
2dc2b736 1408 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
f927c5ae 1409Each element may be just a symbol or string\n\
2d7e41fe
RS
1410or may be a list of two strings to be printed as if concatenated.\n\
1411`standard-output' must be a buffer.\n\
1412At the end, run the normal hook `completion-setup-hook'.\n\
1413It can find the completion buffer in `standard-output'.")
f927c5ae
JB
1414 (completions)
1415 Lisp_Object completions;
1416{
1417 register Lisp_Object tail, elt;
1418 register int i;
2dc2b736 1419 int column = 0;
486cc7fb 1420 struct gcpro gcpro1;
2dc2b736 1421 struct buffer *old = current_buffer;
486cc7fb
RS
1422
1423 /* Note that (when it matters) every variable
1424 points to a non-string that is pointed to by COMPLETIONS. */
1425 GCPRO1 (completions);
1426
2dc2b736
RS
1427 if (XTYPE (Vstandard_output) == Lisp_Buffer)
1428 set_buffer_internal (XBUFFER (Vstandard_output));
f927c5ae 1429
56a98455 1430 if (NILP (completions))
cfc736bf
RS
1431 write_string ("There are no possible completions of what you have typed.",
1432 -1);
f927c5ae
JB
1433 else
1434 {
2dc2b736 1435 write_string ("Possible completions are:", -1);
56a98455 1436 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
f927c5ae
JB
1437 {
1438 /* this needs fixing for the case of long completions
1439 and/or narrow windows */
1440 /* Sadly, the window it will appear in is not known
1441 until after the text has been made. */
1442 if (i & 1)
2dc2b736
RS
1443 {
1444 if (XTYPE (Vstandard_output) == Lisp_Buffer)
18ae44fc 1445 Findent_to (make_number (35), make_number (2));
2dc2b736
RS
1446 else
1447 {
1448 do
1449 {
1450 write_string (" ", -1);
1451 column++;
1452 }
1453 while (column < 35);
1454 }
1455 }
f927c5ae 1456 else
2dc2b736
RS
1457 {
1458 Fterpri (Qnil);
1459 column = 0;
1460 }
f927c5ae
JB
1461 elt = Fcar (tail);
1462 if (CONSP (elt))
1463 {
2dc2b736
RS
1464 if (XTYPE (Vstandard_output) != Lisp_Buffer)
1465 {
07accdfe 1466 Lisp_Object tem;
2dc2b736
RS
1467 tem = Flength (Fcar (elt));
1468 column += XINT (tem);
1469 tem = Flength (Fcar (Fcdr (elt)));
1470 column += XINT (tem);
1471 }
f927c5ae
JB
1472 Fprinc (Fcar (elt), Qnil);
1473 Fprinc (Fcar (Fcdr (elt)), Qnil);
1474 }
1475 else
2dc2b736
RS
1476 {
1477 if (XTYPE (Vstandard_output) != Lisp_Buffer)
1478 {
1479 Lisp_Object tem;
f1b28218 1480 tem = Flength (elt);
2dc2b736
RS
1481 column += XINT (tem);
1482 }
1483 Fprinc (elt, Qnil);
1484 }
f927c5ae
JB
1485 }
1486 }
2dc2b736 1487
486cc7fb
RS
1488 UNGCPRO;
1489
2d7e41fe
RS
1490 if (XTYPE (Vstandard_output) == Lisp_Buffer)
1491 set_buffer_internal (old);
1492
cfc736bf
RS
1493 if (!NILP (Vrun_hooks))
1494 call1 (Vrun_hooks, intern ("completion-setup-hook"));
1495
f927c5ae
JB
1496 return Qnil;
1497}
1498
1499DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
1500 0, 0, "",
1501 "Display a list of possible completions of the current minibuffer contents.")
1502 ()
1503{
1504 Lisp_Object completions;
1505
1506 message ("Making completion list...");
1507 completions = Fall_completions (Fbuffer_string (),
1508 Vminibuffer_completion_table,
1509 Vminibuffer_completion_predicate);
1510 echo_area_glyphs = 0;
1511
56a98455 1512 if (NILP (completions))
f927c5ae
JB
1513 {
1514 bitch_at_user ();
1515 temp_echo_area_glyphs (" [No completions]");
1516 }
1517 else
1518 internal_with_output_to_temp_buffer ("*Completions*",
1519 Fdisplay_completion_list,
1520 Fsort (completions, Qstring_lessp));
1521 return Qnil;
1522}
1523\f
1524DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
1525 "Terminate minibuffer input.")
1526 ()
1527{
1528 if (XTYPE (last_command_char) == Lisp_Int)
1529 internal_self_insert (last_command_char, 0);
1530 else
1531 bitch_at_user ();
1532
1533 Fthrow (Qexit, Qnil);
1534}
1535
1536DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
1537 "Terminate this minibuffer argument.")
1538 ()
1539{
1540 Fthrow (Qexit, Qnil);
1541}
1542
1543DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1544 "Return current depth of activations of minibuffer, a nonnegative integer.")
1545 ()
1546{
1547 return make_number (minibuf_level);
1548}
1549
37e9a934
KH
1550DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1551 "Return the prompt string of the currently-active minibuffer.\n\
1552If no minibuffer is active, return nil.")
1553 ()
1554{
4d04c1f1 1555 return Fcopy_sequence (minibuf_prompt);
37e9a934
KH
1556}
1557
1558DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width,
1559 Sminibuffer_prompt_width, 0, 0, 0,
c5896ef4 1560 "Return the display width of the minibuffer prompt.")
37e9a934
KH
1561 ()
1562{
1563 Lisp_Object width;
c5896ef4 1564 XFASTINT (width) = minibuf_prompt_width;
37e9a934
KH
1565 return width;
1566}
f927c5ae
JB
1567\f
1568init_minibuf_once ()
1569{
1570 Vminibuffer_list = Qnil;
1571 staticpro (&Vminibuffer_list);
1572}
1573
1574syms_of_minibuf ()
1575{
1576 minibuf_level = 0;
4d04c1f1
KH
1577 minibuf_prompt = Qnil;
1578 staticpro (&minibuf_prompt);
1579
1580 minibuf_save_list = Qnil;
1581 staticpro (&minibuf_save_list);
f927c5ae 1582
719b4a40
RS
1583 Qread_file_name_internal = intern ("read-file-name-internal");
1584 staticpro (&Qread_file_name_internal);
1585
f927c5ae
JB
1586 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
1587 staticpro (&Qminibuffer_completion_table);
1588
1589 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
1590 staticpro (&Qminibuffer_completion_confirm);
1591
1592 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
1593 staticpro (&Qminibuffer_completion_predicate);
1594
1e00c2ff
KH
1595 staticpro (&last_exact_completion);
1596 last_exact_completion = Qnil;
1597
f927c5ae
JB
1598 staticpro (&last_minibuf_string);
1599 last_minibuf_string = Qnil;
1600
1601 Quser_variable_p = intern ("user-variable-p");
1602 staticpro (&Quser_variable_p);
1603
770970cb
RS
1604 Qminibuffer_history = intern ("minibuffer-history");
1605 staticpro (&Qminibuffer_history);
f927c5ae 1606
5c781212
RS
1607 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
1608 staticpro (&Qminibuffer_setup_hook);
1609
177aecf9
KH
1610 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
1611 staticpro (&Qminibuffer_exit_hook);
1612
5c781212
RS
1613 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
1614 "Normal hook run just after entry to minibuffer.");
1615 Vminibuffer_setup_hook = Qnil;
1616
177aecf9
KH
1617 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
1618 "Normal hook run just after exit from minibuffer.");
1619 Vminibuffer_exit_hook = Qnil;
1620
f927c5ae
JB
1621 DEFVAR_BOOL ("completion-auto-help", &auto_help,
1622 "*Non-nil means automatically provide help for invalid completion input.");
1623 auto_help = 1;
1624
1625 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
1626 "Non-nil means don't consider case significant in completion.");
1627 completion_ignore_case = 0;
1628
1629 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
1630 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
1631More precisely, this variable makes a difference when the minibuffer window\n\
1632is the selected window. If you are in some other window, minibuffer commands\n\
1633are allowed even if a minibuffer is active.");
1634 enable_recursive_minibuffers = 0;
1635
1636 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
1637 "Alist or obarray used for completion in the minibuffer.\n\
1638This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
1639\n\
1640The value may alternatively be a function, which is given three arguments:\n\
1641 STRING, the current buffer contents;\n\
1642 PREDICATE, the predicate for filtering possible matches;\n\
1643 CODE, which says what kind of things to do.\n\
1644CODE can be nil, t or `lambda'.\n\
1645nil means to return the best completion of STRING, or nil if there is none.\n\
1646t means to return a list of all possible completions of STRING.\n\
1647`lambda' means to return t if STRING is a valid completion as it stands.");
1648 Vminibuffer_completion_table = Qnil;
1649
1650 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
1651 "Within call to `completing-read', this holds the PREDICATE argument.");
1652 Vminibuffer_completion_predicate = Qnil;
1653
1654 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
1655 "Non-nil => demand confirmation of completion before exiting minibuffer.");
1656 Vminibuffer_completion_confirm = Qnil;
1657
1658 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
1659 "Value that `help-form' takes on inside the minibuffer.");
1660 Vminibuffer_help_form = Qnil;
1661
770970cb
RS
1662 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
1663 "History list symbol to add minibuffer values to.\n\
1664Each minibuffer output is added with\n\
1665 (set minibuffer-history-variable\n\
1666 (cons STRING (symbol-value minibuffer-history-variable)))");
1667 XFASTINT (Vminibuffer_history_variable) = 0;
1668
1669 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
1670 "Current position of redoing in the history list.");
1671 Vminibuffer_history_position = Qnil;
1672
6a9ee000
RS
1673 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
1674 "*Non-nil means entering the minibuffer raises the minibuffer's frame.");
1675 minibuffer_auto_raise = 0;
1676
42006772
RS
1677 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
1678 "List of regexps that should restrict possible completions.");
1679 Vcompletion_regexp_list = Qnil;
1680
f927c5ae
JB
1681 defsubr (&Sread_from_minibuffer);
1682 defsubr (&Seval_minibuffer);
1683 defsubr (&Sread_minibuffer);
1684 defsubr (&Sread_string);
1685 defsubr (&Sread_command);
1686 defsubr (&Sread_variable);
1687 defsubr (&Sread_buffer);
1688 defsubr (&Sread_no_blanks_input);
1689 defsubr (&Sminibuffer_depth);
37e9a934
KH
1690 defsubr (&Sminibuffer_prompt);
1691 defsubr (&Sminibuffer_prompt_width);
f927c5ae
JB
1692
1693 defsubr (&Stry_completion);
1694 defsubr (&Sall_completions);
1695 defsubr (&Scompleting_read);
1696 defsubr (&Sminibuffer_complete);
1697 defsubr (&Sminibuffer_complete_word);
1698 defsubr (&Sminibuffer_complete_and_exit);
1699 defsubr (&Sdisplay_completion_list);
1700 defsubr (&Sminibuffer_completion_help);
1701
1702 defsubr (&Sself_insert_and_exit);
1703 defsubr (&Sexit_minibuffer);
1704
1705}
1706
1707keys_of_minibuf ()
1708{
1709 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
1710 "abort-recursive-edit");
1711 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
1712 "exit-minibuffer");
1713 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
1714 "exit-minibuffer");
1715
1716 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
1717 "abort-recursive-edit");
1718 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
1719 "exit-minibuffer");
1720 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
1721 "exit-minibuffer");
1722
1723 initial_define_key (Vminibuffer_local_ns_map, ' ',
1724 "exit-minibuffer");
1725 initial_define_key (Vminibuffer_local_ns_map, '\t',
1726 "exit-minibuffer");
1727 initial_define_key (Vminibuffer_local_ns_map, '?',
1728 "self-insert-and-exit");
1729
1730 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
1731 "abort-recursive-edit");
1732 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
1733 "exit-minibuffer");
1734 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
1735 "exit-minibuffer");
1736
1737 initial_define_key (Vminibuffer_local_completion_map, '\t',
1738 "minibuffer-complete");
1739 initial_define_key (Vminibuffer_local_completion_map, ' ',
1740 "minibuffer-complete-word");
1741 initial_define_key (Vminibuffer_local_completion_map, '?',
1742 "minibuffer-completion-help");
1743
1744 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
1745 "abort-recursive-edit");
1746 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
1747 "minibuffer-complete-and-exit");
1748 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
1749 "minibuffer-complete-and-exit");
1750 initial_define_key (Vminibuffer_local_must_match_map, '\t',
1751 "minibuffer-complete");
1752 initial_define_key (Vminibuffer_local_must_match_map, ' ',
1753 "minibuffer-complete-word");
1754 initial_define_key (Vminibuffer_local_must_match_map, '?',
1755 "minibuffer-completion-help");
1756}