(describe-function-1): Save precomputed `file-name' rather
[bpt/emacs.git] / src / minibuf.c
CommitLineData
f927c5ae 1/* Minibuffer input and completion.
526a058f
GM
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3 2000, 2001 Free Software Foundation, Inc.
f927c5ae
JB
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
ffd56f97 9the Free Software Foundation; either version 2, or (at your option)
f927c5ae
JB
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
f927c5ae
JB
21
22
18160b98 23#include <config.h>
3f708f4c 24#include <stdio.h>
f927c5ae
JB
25#include "lisp.h"
26#include "commands.h"
27#include "buffer.h"
d50a3d2a 28#include "charset.h"
f927c5ae 29#include "dispextern.h"
2538fae4 30#include "keyboard.h"
ff11dfa1 31#include "frame.h"
f927c5ae
JB
32#include "window.h"
33#include "syntax.h"
0c21eeeb 34#include "intervals.h"
f927c5ae
JB
35
36#define min(a, b) ((a) < (b) ? (a) : (b))
37
a4e71d81
KH
38extern int quit_char;
39
f927c5ae 40/* List of buffers for use as minibuffers.
4d04c1f1
KH
41 The first element of the list is used for the outermost minibuffer
42 invocation, the next element is used for a recursive minibuffer
43 invocation, etc. The list is extended at the end as deeper
44 minibuffer recursions are encountered. */
279cf52c 45
f927c5ae
JB
46Lisp_Object Vminibuffer_list;
47
4d04c1f1 48/* Data to remember during recursive minibuffer invocations */
279cf52c 49
4d04c1f1 50Lisp_Object minibuf_save_list;
f927c5ae
JB
51
52/* Depth in minibuffer invocations. */
279cf52c 53
f927c5ae
JB
54int minibuf_level;
55
77aa8edf 56/* Nonzero means display completion help for invalid input. */
279cf52c 57
739cc391 58Lisp_Object Vcompletion_auto_help;
f927c5ae 59
77aa8edf 60/* The maximum length of a minibuffer history. */
279cf52c 61
77aa8edf
RS
62Lisp_Object Qhistory_length, Vhistory_length;
63
b278606c 64/* Fread_minibuffer leaves the input here as a string. */
279cf52c 65
f927c5ae
JB
66Lisp_Object last_minibuf_string;
67
68/* Nonzero means let functions called when within a minibuffer
69 invoke recursive minibuffers (to read arguments, or whatever) */
279cf52c 70
f927c5ae
JB
71int enable_recursive_minibuffers;
72
c3421833
RS
73/* Nonzero means don't ignore text properties
74 in Fread_from_minibuffer. */
279cf52c 75
c3421833
RS
76int minibuffer_allow_text_properties;
77
f927c5ae
JB
78/* help-form is bound to this while in the minibuffer. */
79
80Lisp_Object Vminibuffer_help_form;
81
770970cb
RS
82/* Variable which is the history list to add minibuffer values to. */
83
84Lisp_Object Vminibuffer_history_variable;
85
86/* Current position in the history list (adjusted by M-n and M-p). */
87
88Lisp_Object Vminibuffer_history_position;
89
cc64f5c9
MB
90/* Text properties that are added to minibuffer prompts.
91 These are in addition to the basic `field' property, and stickiness
92 properties. */
93
94Lisp_Object Vminibuffer_prompt_properties;
95
406e55df 96Lisp_Object Qminibuffer_history, Qbuffer_name_history;
770970cb 97
719b4a40
RS
98Lisp_Object Qread_file_name_internal;
99
177aecf9 100/* Normal hooks for entry to and exit from minibuffer. */
5c781212
RS
101
102Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
177aecf9 103Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
5c781212 104
eebbfb01
KH
105/* Function to call to read a buffer name. */
106Lisp_Object Vread_buffer_function;
107
f927c5ae
JB
108/* Nonzero means completion ignores case. */
109
110int completion_ignore_case;
111
42006772
RS
112/* List of regexps that should restrict possible completions. */
113
114Lisp_Object Vcompletion_regexp_list;
115
6a9ee000
RS
116/* Nonzero means raise the minibuffer frame when the minibuffer
117 is entered. */
118
119int minibuffer_auto_raise;
120
f927c5ae
JB
121/* If last completion attempt reported "Complete but not unique"
122 then this is the string completed then; otherwise this is nil. */
123
124static Lisp_Object last_exact_completion;
125
2cb6da5c
RS
126/* Non-nil means it is the window for C-M-v to scroll
127 when the minibuffer is selected. */
279cf52c 128
2cb6da5c 129extern Lisp_Object Vminibuf_scroll_window;
30e13e56
RS
130
131extern Lisp_Object Voverriding_local_map;
cee54539 132
5744fa7c
RS
133Lisp_Object Quser_variable_p;
134
135Lisp_Object Qminibuffer_default;
136
cee54539
KH
137Lisp_Object Qcurrent_input_method, Qactivate_input_method;
138
5744fa7c 139extern Lisp_Object Qmouse_face;
279cf52c 140
8e9968c6 141extern Lisp_Object Qfield;
f927c5ae 142\f
89fdc4a0
KH
143/* Put minibuf on currently selected frame's minibuffer.
144 We do this whenever the user starts a new minibuffer
145 or when a minibuffer exits. */
146
147void
148choose_minibuf_frame ()
149{
a4aafc54
GM
150 if (FRAMEP (selected_frame)
151 && FRAME_LIVE_P (XFRAME (selected_frame))
152 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
89fdc4a0 153 {
a4aafc54
GM
154 struct frame *sf = XFRAME (selected_frame);
155 Lisp_Object buffer;
156
89fdc4a0
KH
157 /* I don't think that any frames may validly have a null minibuffer
158 window anymore. */
a4aafc54 159 if (NILP (sf->minibuffer_window))
89fdc4a0
KH
160 abort ();
161
a4aafc54
GM
162 /* Under X, we come here with minibuf_window being the
163 minibuffer window of the unused termcap window created in
164 init_window_once. That window doesn't have a buffer. */
165 buffer = XWINDOW (minibuf_window)->buffer;
166 if (BUFFERP (buffer))
167 Fset_window_buffer (sf->minibuffer_window, buffer);
168 minibuf_window = sf->minibuffer_window;
89fdc4a0 169 }
914860c2
RS
170
171 /* Make sure no other frame has a minibuffer as its selected window,
172 because the text would not be displayed in it, and that would be
07d402c8
RS
173 confusing. Only allow the selected frame to do this,
174 and that only if the minibuffer is active. */
914860c2
RS
175 {
176 Lisp_Object tail, frame;
177
178 FOR_EACH_FRAME (tail, frame)
07d402c8 179 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
a4aafc54 180 && !(EQ (frame, selected_frame)
07d402c8 181 && minibuf_level > 0))
914860c2
RS
182 Fset_frame_selected_window (frame, Fframe_first_window (frame));
183 }
89fdc4a0 184}
68313ed8 185
0c94f256
RS
186Lisp_Object
187choose_minibuf_frame_1 (ignore)
188 Lisp_Object ignore;
189{
190 choose_minibuf_frame ();
191 return Qnil;
192}
193
68313ed8
RS
194DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
195 Sset_minibuffer_window, 1, 1, 0,
196 "Specify which minibuffer window to use for the minibuffer.\n\
197This effects where the minibuffer is displayed if you put text in it\n\
198without invoking the usual minibuffer commands.")
199 (window)
200 Lisp_Object window;
201{
202 CHECK_WINDOW (window, 1);
203 if (! MINI_WINDOW_P (XWINDOW (window)))
204 error ("Window is not a minibuffer window");
205
206 minibuf_window = window;
207
208 return window;
209}
210
89fdc4a0 211\f
f927c5ae
JB
212/* Actual minibuffer invocation. */
213
af2b7cd5
RS
214static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
215static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
216 Lisp_Object, Lisp_Object,
217 int, Lisp_Object,
218 Lisp_Object, Lisp_Object,
219 int, int));
edfef199
GM
220static Lisp_Object read_minibuf_noninteractive P_ ((Lisp_Object, Lisp_Object,
221 Lisp_Object, Lisp_Object,
222 int, Lisp_Object,
223 Lisp_Object, Lisp_Object,
224 int, int));
225static Lisp_Object string_to_object P_ ((Lisp_Object, Lisp_Object));
226
227
228/* Read a Lisp object from VAL and return it. If VAL is an empty
229 string, and DEFALT is a string, read from DEFALT instead of VAL. */
230
231static Lisp_Object
232string_to_object (val, defalt)
233 Lisp_Object val, defalt;
234{
235 struct gcpro gcpro1, gcpro2;
236 Lisp_Object expr_and_pos;
237 int pos;
238
239 GCPRO2 (val, defalt);
240
241 if (STRINGP (val) && XSTRING (val)->size == 0
242 && STRINGP (defalt))
243 val = defalt;
244
245 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
246 pos = XINT (Fcdr (expr_and_pos));
247 if (pos != XSTRING (val)->size)
248 {
249 /* Ignore trailing whitespace; any other trailing junk
250 is an error. */
251 int i;
252 pos = string_char_to_byte (val, pos);
253 for (i = pos; i < STRING_BYTES (XSTRING (val)); i++)
254 {
255 int c = XSTRING (val)->data[i];
256 if (c != ' ' && c != '\t' && c != '\n')
257 error ("Trailing garbage following expression");
258 }
259 }
260
261 val = Fcar (expr_and_pos);
262 RETURN_UNGCPRO (val);
263}
264
265
266/* Like read_minibuf but reading from stdin. This function is called
267 from read_minibuf to do the job if noninteractive. */
268
269static Lisp_Object
270read_minibuf_noninteractive (map, initial, prompt, backup_n, expflag,
271 histvar, histpos, defalt, allow_props,
272 inherit_input_method)
273 Lisp_Object map;
274 Lisp_Object initial;
275 Lisp_Object prompt;
276 Lisp_Object backup_n;
277 int expflag;
278 Lisp_Object histvar;
279 Lisp_Object histpos;
280 Lisp_Object defalt;
281 int allow_props;
282 int inherit_input_method;
283{
284 int size, len;
285 char *line, *s;
edfef199
GM
286 Lisp_Object val;
287
288 fprintf (stdout, "%s", XSTRING (prompt)->data);
289 fflush (stdout);
290
6bbd7a29 291 val = Qnil;
edfef199
GM
292 size = 100;
293 len = 0;
294 line = (char *) xmalloc (size * sizeof *line);
295 while ((s = fgets (line + len, size - len, stdin)) != NULL
296 && (len = strlen (line),
297 len == size - 1 && line[len - 1] != '\n'))
298 {
299 size *= 2;
300 line = (char *) xrealloc (line, size);
301 }
302
303 if (s)
304 {
305 len = strlen (line);
306
307 if (len > 0 && line[len - 1] == '\n')
308 line[--len] = '\0';
309
310 val = build_string (line);
311 xfree (line);
312 }
313 else
314 {
315 xfree (line);
316 error ("Error reading from stdin");
317 }
318
319 /* If Lisp form desired instead of string, parse it. */
320 if (expflag)
321 val = string_to_object (val, defalt);
322
323 return val;
324}
325
f927c5ae 326
770970cb 327/* Read from the minibuffer using keymap MAP, initial contents INITIAL
a9c26562 328 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
770970cb 329 prompting with PROMPT (a string), using history list HISTVAR
85b5fe07 330 with initial position HISTPOS. (BACKUP_N should be <= 0.)
770970cb
RS
331
332 Normally return the result as a string (the text that was read),
3ab14176 333 but if EXPFLAG is nonzero, read it and return the object read.
b278606c
BF
334 If HISTVAR is given, save the value read on that history only if it doesn't
335 match the front of that history list exactly. The value is pushed onto
e5d4686b 336 the list as the string that was read.
770970cb 337
c3421833
RS
338 DEFALT specifies te default value for the sake of history commands.
339
cee54539
KH
340 If ALLOW_PROPS is nonzero, we do not throw away text properties.
341
342 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
343 current input method. */
e5d4686b
RS
344
345static Lisp_Object
346read_minibuf (map, initial, prompt, backup_n, expflag,
cee54539 347 histvar, histpos, defalt, allow_props, inherit_input_method)
f927c5ae
JB
348 Lisp_Object map;
349 Lisp_Object initial;
350 Lisp_Object prompt;
5061d9c3 351 Lisp_Object backup_n;
f927c5ae 352 int expflag;
770970cb
RS
353 Lisp_Object histvar;
354 Lisp_Object histpos;
e5d4686b 355 Lisp_Object defalt;
af2b7cd5 356 int allow_props;
cee54539 357 int inherit_input_method;
f927c5ae 358{
00a34088 359 Lisp_Object val;
f927c5ae 360 int count = specpdl_ptr - specpdl;
cee54539
KH
361 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
362 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
c75000c7 363 Lisp_Object enable_multibyte;
13c67cc6 364 extern Lisp_Object Qread_only, Qfront_sticky;
fbd1209a 365 extern Lisp_Object Qrear_nonsticky;
00a34088 366
e5d4686b
RS
367 specbind (Qminibuffer_default, defalt);
368
08f7d623 369 single_kboard_state ();
e5baa1a7 370#ifdef HAVE_X_WINDOWS
526a058f
GM
371 if (display_hourglass_p)
372 cancel_hourglass ();
e5baa1a7 373#endif
718d3251 374
00a34088 375 val = Qnil;
57ceaa8a 376 ambient_dir = current_buffer->directory;
cee54539 377 input_method = Qnil;
c75000c7 378 enable_multibyte = Qnil;
57ceaa8a 379
00a34088
RS
380 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
381 store them away before we can GC. Don't need to protect
382 BACKUP_N because we use the value only if it is an integer. */
cee54539 383 GCPRO5 (map, initial, val, ambient_dir, input_method);
f927c5ae 384
7510b296 385 if (!STRINGP (prompt))
f927c5ae
JB
386 prompt = build_string ("");
387
f927c5ae 388 if (!enable_recursive_minibuffers
be15a518
RS
389 && minibuf_level > 0)
390 {
391 if (EQ (selected_window, minibuf_window))
392 error ("Command attempted to use minibuffer while in minibuffer");
393 else
394 /* If we're in another window, cancel the minibuffer that's active. */
395 Fthrow (Qexit,
396 build_string ("Command attempted to use minibuffer while in minibuffer"));
397 }
f927c5ae 398
edfef199 399 if (noninteractive)
c28b847b
GM
400 {
401 val = read_minibuf_noninteractive (map, initial, prompt, backup_n,
402 expflag, histvar, histpos, defalt,
403 allow_props, inherit_input_method);
404 return unbind_to (count, val);
405 }
edfef199 406
748dc60a 407 /* Choose the minibuffer window and frame, and take action on them. */
f927c5ae 408
c5b6b680
RS
409 choose_minibuf_frame ();
410
0c94f256
RS
411 record_unwind_protect (choose_minibuf_frame_1, Qnil);
412
f927c5ae 413 record_unwind_protect (Fset_window_configuration,
b2b2c677
JB
414 Fcurrent_window_configuration (Qnil));
415
ff11dfa1
JB
416 /* If the minibuffer window is on a different frame, save that
417 frame's configuration too. */
75f00e72 418 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
a4aafc54 419 if (!EQ (mini_frame, selected_frame))
5061d9c3
RS
420 record_unwind_protect (Fset_window_configuration,
421 Fcurrent_window_configuration (mini_frame));
5563e8e8
KH
422
423 /* If the minibuffer is on an iconified or invisible frame,
424 make it visible now. */
425 Fmake_frame_visible (mini_frame);
426
6a9ee000
RS
427 if (minibuffer_auto_raise)
428 Fraise_frame (mini_frame);
f927c5ae 429
748dc60a
RS
430 /* We have to do this after saving the window configuration
431 since that is what restores the current buffer. */
432
433 /* Arrange to restore a number of minibuffer-related variables.
434 We could bind each variable separately, but that would use lots of
435 specpdl slots. */
436 minibuf_save_list
437 = Fcons (Voverriding_local_map,
438 Fcons (minibuf_window, minibuf_save_list));
439 minibuf_save_list
440 = Fcons (minibuf_prompt,
441 Fcons (make_number (minibuf_prompt_width),
442 Fcons (Vhelp_form,
443 Fcons (Vcurrent_prefix_arg,
444 Fcons (Vminibuffer_history_position,
445 Fcons (Vminibuffer_history_variable,
446 minibuf_save_list))))));
447
448 record_unwind_protect (read_minibuf_unwind, Qnil);
449 minibuf_level++;
450
451 /* Now that we can restore all those variables, start changing them. */
452
1e3f16d5 453 minibuf_prompt_width = 0;
748dc60a
RS
454 minibuf_prompt = Fcopy_sequence (prompt);
455 Vminibuffer_history_position = histpos;
456 Vminibuffer_history_variable = histvar;
457 Vhelp_form = Vminibuffer_help_form;
458
cee54539 459 if (inherit_input_method)
c75000c7
RS
460 {
461 /* `current-input-method' is buffer local. So, remeber it in
462 INPUT_METHOD before changing the current buffer. */
463 input_method = Fsymbol_value (Qcurrent_input_method);
464 enable_multibyte = current_buffer->enable_multibyte_characters;
465 }
cee54539 466
748dc60a
RS
467 /* Switch to the minibuffer. */
468
4f69d8f6
RS
469 minibuffer = get_minibuffer (minibuf_level);
470 Fset_buffer (minibuffer);
64a3a3c0
JB
471
472 /* The current buffer's default directory is usually the right thing
473 for our minibuffer here. However, if you're typing a command at
474 a minibuffer-only frame when minibuf_level is zero, then buf IS
475 the current_buffer, so reset_buffer leaves buf's default
476 directory unchanged. This is a bummer when you've just started
477 up Emacs and buf's default directory is Qnil. Here's a hack; can
478 you think of something better to do? Find another buffer with a
479 better directory, and use that one instead. */
748dc60a
RS
480 if (STRINGP (ambient_dir))
481 current_buffer->directory = ambient_dir;
64a3a3c0
JB
482 else
483 {
484 Lisp_Object buf_list;
485
486 for (buf_list = Vbuffer_alist;
487 CONSP (buf_list);
7539e11f 488 buf_list = XCDR (buf_list))
64a3a3c0 489 {
1e62748e 490 Lisp_Object other_buf;
64a3a3c0 491
7539e11f 492 other_buf = XCDR (XCAR (buf_list));
7510b296 493 if (STRINGP (XBUFFER (other_buf)->directory))
64a3a3c0
JB
494 {
495 current_buffer->directory = XBUFFER (other_buf)->directory;
496 break;
497 }
498 }
499 }
500
a4aafc54
GM
501 if (!EQ (mini_frame, selected_frame))
502 Fredirect_frame_focus (selected_frame, mini_frame);
43bad991 503
f927c5ae
JB
504 Vminibuf_scroll_window = selected_window;
505 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
f927c5ae 506 Fselect_window (minibuf_window);
5a866662 507 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
f927c5ae 508
748dc60a
RS
509 Fmake_local_variable (Qprint_escape_newlines);
510 print_escape_newlines = 1;
511
512 /* Erase the buffer. */
59115a22
RS
513 {
514 int count1 = specpdl_ptr - specpdl;
515 specbind (Qinhibit_read_only, Qt);
516 Ferase_buffer ();
517 unbind_to (count1, Qnil);
518 }
519
279cf52c
GM
520 if (!NILP (current_buffer->enable_multibyte_characters)
521 && ! STRING_MULTIBYTE (minibuf_prompt))
522 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
523
279cf52c
GM
524 /* Insert the prompt, record where it ends. */
525 Finsert (1, &minibuf_prompt);
279cf52c
GM
526 if (PT > BEG)
527 {
fbd1209a 528 Fput_text_property (make_number (BEG), make_number (PT),
279cf52c 529 Qfront_sticky, Qt, Qnil);
fbd1209a 530 Fput_text_property (make_number (BEG), make_number (PT),
279cf52c 531 Qrear_nonsticky, Qt, Qnil);
8e9968c6
GM
532 Fput_text_property (make_number (BEG), make_number (PT),
533 Qfield, Qt, Qnil);
cc64f5c9
MB
534 Fadd_text_properties (make_number (BEG), make_number (PT),
535 Vminibuffer_prompt_properties, Qnil);
279cf52c 536 }
1e3f16d5
GM
537
538 minibuf_prompt_width = current_column ();
279cf52c 539
094d9789
RS
540 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
541 if (inherit_input_method)
542 current_buffer->enable_multibyte_characters = enable_multibyte;
543
748dc60a 544 /* Put in the initial input. */
56a98455 545 if (!NILP (initial))
f927c5ae
JB
546 {
547 Finsert (1, &initial);
a9c26562
RS
548 if (INTEGERP (backup_n))
549 Fforward_char (backup_n);
f927c5ae
JB
550 }
551
39e98b38 552 clear_message (1, 1);
f927c5ae
JB
553 current_buffer->keymap = map;
554
cee54539 555 /* Turn on an input method stored in INPUT_METHOD if any. */
6801b300 556 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
cee54539
KH
557 call1 (Qactivate_input_method, input_method);
558
5c781212
RS
559 /* Run our hook, but not if it is empty.
560 (run-hooks would do nothing if it is empty,
748dc60a 561 but it's important to save time here in the usual case). */
92d3b06e
RS
562 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
563 && !NILP (Vrun_hooks))
5c781212
RS
564 call1 (Vrun_hooks, Qminibuffer_setup_hook);
565
4e6b7204
MB
566 /* Don't allow the user to undo past this point. */
567 current_buffer->undo_list = Qnil;
568
f927c5ae
JB
569 recursive_edit_1 ();
570
571 /* If cursor is on the minibuffer line,
572 show the user we have exited by putting it in column 0. */
279cf52c 573 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
f927c5ae
JB
574 && !noninteractive)
575 {
279cf52c
GM
576 XWINDOW (minibuf_window)->cursor.hpos = 0;
577 XWINDOW (minibuf_window)->cursor.x = 0;
578 XWINDOW (minibuf_window)->must_be_updated_p = 1;
a4aafc54 579 update_frame (XFRAME (selected_frame), 1, 1);
337aaf1f
GM
580 if (rif && rif->flush_display)
581 rif->flush_display (XFRAME (XWINDOW (minibuf_window)->frame));
f927c5ae
JB
582 }
583
c3421833 584 /* Make minibuffer contents into a string. */
4f69d8f6 585 Fset_buffer (minibuffer);
be95a9b6
DL
586 if (allow_props)
587 val = Ffield_string (make_number (ZV));
588 else
589 val = Ffield_string_no_properties (make_number (ZV));
770970cb 590
b278606c 591 /* VAL is the string of minibuffer text. */
7019cca7 592
b278606c
BF
593 last_minibuf_string = val;
594
3ab14176 595 /* Add the value to the appropriate history list unless it is empty. */
9f6131cf 596 if (XSTRING (val)->size != 0
c6d65724 597 && SYMBOLP (Vminibuffer_history_variable))
3ab14176
KH
598 {
599 /* If the caller wanted to save the value read on a history list,
600 then do so if the value is not already the front of the list. */
601 Lisp_Object histval;
c6d65724
RS
602
603 /* If variable is unbound, make it nil. */
604 if (EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
605 Fset (Vminibuffer_history_variable, Qnil);
606
3ab14176
KH
607 histval = Fsymbol_value (Vminibuffer_history_variable);
608
609 /* The value of the history variable must be a cons or nil. Other
610 values are unacceptable. We silently ignore these values. */
611 if (NILP (histval)
9f6131cf
RS
612 || (CONSP (histval)
613 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
77aa8edf
RS
614 {
615 Lisp_Object length;
616
617 histval = Fcons (last_minibuf_string, histval);
618 Fset (Vminibuffer_history_variable, histval);
619
620 /* Truncate if requested. */
621 length = Fget (Vminibuffer_history_variable, Qhistory_length);
622 if (NILP (length)) length = Vhistory_length;
e5d4686b
RS
623 if (INTEGERP (length))
624 {
625 if (XINT (length) <= 0)
626 Fset (Vminibuffer_history_variable, Qnil);
627 else
628 {
629 Lisp_Object temp;
630
631 temp = Fnthcdr (Fsub1 (length), histval);
632 if (CONSP (temp)) Fsetcdr (temp, Qnil);
633 }
634 }
77aa8edf 635 }
9f6131cf
RS
636 }
637
638 /* If Lisp form desired instead of string, parse it. */
639 if (expflag)
edfef199 640 val = string_to_object (val, defalt);
3ab14176 641
00a34088
RS
642 /* The appropriate frame will get selected
643 in set-window-configuration. */
644 RETURN_UNGCPRO (unbind_to (count, val));
f927c5ae
JB
645}
646
647/* Return a buffer to be used as the minibuffer at depth `depth'.
648 depth = 0 is the lowest allowed argument, and that is the value
649 used for nonrecursive minibuffer invocations */
650
651Lisp_Object
652get_minibuffer (depth)
653 int depth;
654{
655 Lisp_Object tail, num, buf;
9f6c23bc 656 char name[24];
f927c5ae
JB
657 extern Lisp_Object nconc2 ();
658
5a866662 659 XSETFASTINT (num, depth);
f927c5ae 660 tail = Fnthcdr (num, Vminibuffer_list);
56a98455 661 if (NILP (tail))
f927c5ae
JB
662 {
663 tail = Fcons (Qnil, Qnil);
664 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
665 }
666 buf = Fcar (tail);
56a98455 667 if (NILP (buf) || NILP (XBUFFER (buf)->name))
f927c5ae
JB
668 {
669 sprintf (name, " *Minibuf-%d*", depth);
670 buf = Fget_buffer_create (build_string (name));
5d6533f1
JB
671
672 /* Although the buffer's name starts with a space, undo should be
673 enabled in it. */
674 Fbuffer_enable_undo (buf);
675
7539e11f 676 XCAR (tail) = buf;
f927c5ae
JB
677 }
678 else
5956f71d 679 {
6b3faad8
RS
680 int count = specpdl_ptr - specpdl;
681
5956f71d 682 reset_buffer (XBUFFER (buf));
6b3faad8
RS
683 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
684 Fset_buffer (buf);
685 Fkill_all_local_variables ();
686 unbind_to (count, Qnil);
5956f71d 687 }
64a3a3c0 688
f927c5ae
JB
689 return buf;
690}
691
279cf52c
GM
692/* This function is called on exiting minibuffer, whether normally or
693 not, and it restores the current window, buffer, etc. */
f927c5ae 694
9d815fd9 695static Lisp_Object
43bad991
JB
696read_minibuf_unwind (data)
697 Lisp_Object data;
f927c5ae 698{
c24e1160 699 Lisp_Object old_deactivate_mark;
59115a22 700 Lisp_Object window;
c24e1160 701
0a1dd1c5
RS
702 /* We are exiting the minibuffer one way or the other,
703 so run the hook. */
704 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
705 && !NILP (Vrun_hooks))
060ffec1 706 safe_run_hooks (Qminibuffer_exit_hook);
0a1dd1c5 707
f927c5ae 708 /* If this was a recursive minibuffer,
59115a22 709 tie the minibuffer window back to the outer level minibuffer buffer. */
f927c5ae 710 minibuf_level--;
f927c5ae 711
59115a22 712 window = minibuf_window;
279cf52c
GM
713 /* To keep things predictable, in case it matters, let's be in the
714 minibuffer when we reset the relevant variables. */
59115a22
RS
715 Fset_buffer (XWINDOW (window)->buffer);
716
717 /* Restore prompt, etc, from outer minibuffer level. */
4d04c1f1
KH
718 minibuf_prompt = Fcar (minibuf_save_list);
719 minibuf_save_list = Fcdr (minibuf_save_list);
720 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
721 minibuf_save_list = Fcdr (minibuf_save_list);
722 Vhelp_form = Fcar (minibuf_save_list);
723 minibuf_save_list = Fcdr (minibuf_save_list);
ee9e37ab 724 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
4d04c1f1
KH
725 minibuf_save_list = Fcdr (minibuf_save_list);
726 Vminibuffer_history_position = Fcar (minibuf_save_list);
727 minibuf_save_list = Fcdr (minibuf_save_list);
728 Vminibuffer_history_variable = Fcar (minibuf_save_list);
729 minibuf_save_list = Fcdr (minibuf_save_list);
30e13e56 730 Voverriding_local_map = Fcar (minibuf_save_list);
c5b6b680 731 minibuf_save_list = Fcdr (minibuf_save_list);
914860c2
RS
732#if 0
733 temp = Fcar (minibuf_save_list);
734 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
735 minibuf_window = temp;
736#endif
30e13e56 737 minibuf_save_list = Fcdr (minibuf_save_list);
59115a22
RS
738
739 /* Erase the minibuffer we were using at this level. */
740 {
741 int count = specpdl_ptr - specpdl;
742 /* Prevent error in erase-buffer. */
743 specbind (Qinhibit_read_only, Qt);
744 old_deactivate_mark = Vdeactivate_mark;
745 Ferase_buffer ();
746 Vdeactivate_mark = old_deactivate_mark;
747 unbind_to (count, Qnil);
748 }
749
544e358d
GM
750 /* When we get to the outmost level, make sure we resize the
751 mini-window back to its normal size. */
752 if (minibuf_level == 0)
1e3f16d5 753 resize_mini_window (XWINDOW (window), 0);
544e358d 754
59115a22
RS
755 /* Make sure minibuffer window is erased, not ignored. */
756 windows_or_buffers_changed++;
757 XSETFASTINT (XWINDOW (window)->last_modified, 0);
193e4518 758 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
9d815fd9 759 return Qnil;
f927c5ae
JB
760}
761\f
b9d721de
JB
762
763/* This comment supplies the doc string for read-from-minibuffer,
764 for make-docfile to see. We cannot put this in the real DEFUN
765 due to limits in the Unix cpp.
766
cee54539 767DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
f927c5ae
JB
768 "Read a string from the minibuffer, prompting with string PROMPT.\n\
769If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
770 to be inserted into the minibuffer before reading input.\n\
770970cb 771 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
18fef111 772 is STRING, but point is placed at position POSITION in the minibuffer.\n\
f927c5ae
JB
773Third arg KEYMAP is a keymap to use whilst reading;\n\
774 if omitted or nil, the default is `minibuffer-local-map'.\n\
775If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
776 and return that object:\n\
777 in other words, do `(car (read-from-string INPUT-STRING))'\n\
770970cb
RS
778Fifth arg HIST, if non-nil, specifies a history list\n\
779 and optionally the initial position in the list.\n\
780 It can be a symbol, which is the history list variable to use,\n\
781 or it can be a cons cell (HISTVAR . HISTPOS).\n\
782 In that case, HISTVAR is the history list variable to use,\n\
783 and HISTPOS is the initial position (the position in the list\n\
784 which INITIAL-CONTENTS corresponds to).\n\
e5d4686b 785 Positions are counted starting from 1 at the beginning of the list.\n\
b9a86585
RS
786Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
787 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
788 if the user enters empty input! It returns the empty string.\n\
c8c15521
RS
789Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
790 the current input method and the setting of enable-multibyte-characters.\n\
19a4cb25 791If the variable `minibuffer-allow-text-properties' is non-nil,\n\
c3421833 792 then the string which is returned includes whatever text properties\n\
cee54539
KH
793 were present in the minibuffer. Otherwise the value has no text properties.")
794 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
795 */
b9d721de 796
cee54539 797DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
b9d721de 798 0 /* See immediately above */)
cee54539 799 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
e5d4686b 800 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
cee54539 801 Lisp_Object inherit_input_method;
f927c5ae
JB
802{
803 int pos = 0;
e5d4686b 804 Lisp_Object histvar, histpos, position, val;
1d8d92f4
RS
805 struct gcpro gcpro1;
806
770970cb 807 position = Qnil;
f927c5ae
JB
808
809 CHECK_STRING (prompt, 0);
68e5a8a2 810 if (!NILP (initial_contents))
f927c5ae 811 {
7510b296 812 if (CONSP (initial_contents))
770970cb 813 {
68e5a8a2
RS
814 position = Fcdr (initial_contents);
815 initial_contents = Fcar (initial_contents);
770970cb 816 }
68e5a8a2 817 CHECK_STRING (initial_contents, 1);
56a98455 818 if (!NILP (position))
f927c5ae
JB
819 {
820 CHECK_NUMBER (position, 0);
821 /* Convert to distance from end of input. */
18fef111
RS
822 if (XINT (position) < 1)
823 /* A number too small means the beginning of the string. */
824 pos = - XSTRING (initial_contents)->size;
825 else
826 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
f927c5ae
JB
827 }
828 }
829
56a98455 830 if (NILP (keymap))
f927c5ae
JB
831 keymap = Vminibuffer_local_map;
832 else
02067692 833 keymap = get_keymap (keymap, 1, 0);
770970cb 834
7510b296 835 if (SYMBOLP (hist))
770970cb
RS
836 {
837 histvar = hist;
838 histpos = Qnil;
839 }
840 else
841 {
842 histvar = Fcar_safe (hist);
843 histpos = Fcdr_safe (hist);
844 }
845 if (NILP (histvar))
846 histvar = Qminibuffer_history;
847 if (NILP (histpos))
5a866662 848 XSETFASTINT (histpos, 0);
770970cb 849
1d8d92f4 850 GCPRO1 (default_value);
e5d4686b
RS
851 val = read_minibuf (keymap, initial_contents, prompt,
852 make_number (pos), !NILP (read),
c3421833 853 histvar, histpos, default_value,
cee54539
KH
854 minibuffer_allow_text_properties,
855 !NILP (inherit_input_method));
1d8d92f4 856 UNGCPRO;
e5d4686b 857 return val;
f927c5ae
JB
858}
859
860DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
861 "Return a Lisp object read using the minibuffer.\n\
862Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
863is a string to insert in the minibuffer before reading.")
864 (prompt, initial_contents)
865 Lisp_Object prompt, initial_contents;
866{
867 CHECK_STRING (prompt, 0);
56a98455 868 if (!NILP (initial_contents))
a1b4b084 869 CHECK_STRING (initial_contents, 1);
770970cb 870 return read_minibuf (Vminibuffer_local_map, initial_contents,
e5d4686b 871 prompt, Qnil, 1, Qminibuffer_history,
dd9d15d6 872 make_number (0), Qnil, 0, 0);
f927c5ae
JB
873}
874
875DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
876 "Return value of Lisp expression read using the minibuffer.\n\
877Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
878is a string to insert in the minibuffer before reading.")
879 (prompt, initial_contents)
880 Lisp_Object prompt, initial_contents;
881{
882 return Feval (Fread_minibuffer (prompt, initial_contents));
883}
884
885/* Functions that use the minibuffer to read various things. */
886
cee54539 887DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
f927c5ae 888 "Read a string from the minibuffer, prompting with string PROMPT.\n\
80896ab4
RS
889If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
890The third arg HISTORY, if non-nil, specifies a history list\n\
891 and optionally the initial position in the list.\n\
cee54539 892See `read-from-minibuffer' for details of HISTORY argument.\n\
19a4cb25
SE
893Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
894 for history commands, and as the value to return if the user enters\n\
895 the empty string.\n\
896Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
c8c15521 897 the current input method and the setting of enable-multibyte-characters.")
cee54539 898 (prompt, initial_input, history, default_value, inherit_input_method)
e5d4686b 899 Lisp_Object prompt, initial_input, history, default_value;
cee54539 900 Lisp_Object inherit_input_method;
f927c5ae 901{
b9a86585
RS
902 Lisp_Object val;
903 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
904 Qnil, history, default_value,
905 inherit_input_method);
906 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (default_value))
907 val = default_value;
908 return val;
f927c5ae
JB
909}
910
cee54539 911DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
c923ccc9
RS
912 "Read a string from the terminal, not allowing blanks.\n\
913Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
c8c15521
RS
914Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
915the current input method and the setting of enable-multibyte-characters.")
c923ccc9
RS
916 (prompt, initial, inherit_input_method)
917 Lisp_Object prompt, initial, inherit_input_method;
f927c5ae
JB
918{
919 CHECK_STRING (prompt, 0);
c923ccc9
RS
920 if (! NILP (initial))
921 CHECK_STRING (initial, 1);
f927c5ae 922
c923ccc9 923 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
cee54539
KH
924 0, Qminibuffer_history, make_number (0), Qnil, 0,
925 !NILP (inherit_input_method));
f927c5ae
JB
926}
927
e5d4686b
RS
928DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
929 "Read the name of a command and return as a symbol.\n\
930Prompts with PROMPT. By default, return DEFAULT-VALUE.")
931 (prompt, default_value)
932 Lisp_Object prompt, default_value;
f927c5ae 933{
7c8d9931
RS
934 Lisp_Object name, default_string;
935
936 if (NILP (default_value))
937 default_string = Qnil;
938 else if (SYMBOLP (default_value))
6dd05c14 939 XSETSTRING (default_string, XSYMBOL (default_value)->name);
7c8d9931
RS
940 else
941 default_string = default_value;
942
943 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
944 Qnil, Qnil, default_string, Qnil);
945 if (NILP (name))
946 return name;
947 return Fintern (name, Qnil);
f927c5ae
JB
948}
949
950#ifdef NOTDEF
951DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
952 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
953Prompts with PROMPT.")
954 (prompt)
955 Lisp_Object prompt;
956{
cee54539 957 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
f927c5ae
JB
958 Qnil);
959}
960#endif /* NOTDEF */
961
e5d4686b
RS
962DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
963 "Read the name of a user variable and return it as a symbol.\n\
964Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
f927c5ae 965A user variable is one whose documentation starts with a `*' character.")
e5d4686b
RS
966 (prompt, default_value)
967 Lisp_Object prompt, default_value;
f927c5ae 968{
7c8d9931
RS
969 Lisp_Object name, default_string;
970
971 if (NILP (default_value))
972 default_string = Qnil;
973 else if (SYMBOLP (default_value))
6dd05c14 974 XSETSTRING (default_string, XSYMBOL (default_value)->name);
7c8d9931
RS
975 else
976 default_string = default_value;
977
978 name = Fcompleting_read (prompt, Vobarray,
979 Quser_variable_p, Qt,
980 Qnil, Qnil, default_string, Qnil);
981 if (NILP (name))
982 return name;
983 return Fintern (name, Qnil);
f927c5ae
JB
984}
985
986DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
987 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
988Prompts with PROMPT.\n\
e5d4686b 989Optional second arg DEF is value to return if user enters an empty line.\n\
f927c5ae
JB
990If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
991 (prompt, def, require_match)
992 Lisp_Object prompt, def, require_match;
993{
eebbfb01
KH
994 Lisp_Object args[4];
995
7510b296 996 if (BUFFERP (def))
f927c5ae 997 def = XBUFFER (def)->name;
eebbfb01
KH
998
999 if (NILP (Vread_buffer_function))
1000 {
1001 if (!NILP (def))
1002 {
1003 args[0] = build_string ("%s(default %s) ");
1004 args[1] = prompt;
1005 args[2] = def;
1006 prompt = Fformat (3, args);
1007 }
1008
1009 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
406e55df
RS
1010 require_match, Qnil, Qbuffer_name_history,
1011 def, Qnil);
eebbfb01
KH
1012 }
1013 else
f927c5ae 1014 {
eebbfb01 1015 args[0] = Vread_buffer_function;
f927c5ae
JB
1016 args[1] = prompt;
1017 args[2] = def;
eebbfb01
KH
1018 args[3] = require_match;
1019 return Ffuncall(4, args);
f927c5ae 1020 }
f927c5ae
JB
1021}
1022\f
ec067ec7
RS
1023static Lisp_Object
1024minibuf_conform_representation (string, basis)
1025 Lisp_Object string, basis;
1026{
1027 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1028 return string;
1029
1030 if (STRING_MULTIBYTE (string))
1031 return Fstring_make_unibyte (string);
1032 else
1033 return Fstring_make_multibyte (string);
1034}
1035
f927c5ae
JB
1036DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1037 "Return common substring of all completions of STRING in ALIST.\n\
1038Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1039All that match are compared together; the longest initial sequence\n\
1040common to all matches is returned as a string.\n\
1041If there is no match at all, nil is returned.\n\
7e4639db 1042For a unique match which is exact, t is returned.\n\
f927c5ae
JB
1043\n\
1044ALIST can be an obarray instead of an alist.\n\
1045Then the print names of all symbols in the obarray are the possible matches.\n\
1046\n\
1047ALIST can also be a function to do the completion itself.\n\
1048It receives three arguments: the values STRING, PREDICATE and nil.\n\
1049Whatever it returns becomes the value of `try-completion'.\n\
1050\n\
1051If optional third argument PREDICATE is non-nil,\n\
1052it is used to test each possible match.\n\
1053The match is a candidate only if PREDICATE returns non-nil.\n\
89a255dc 1054The argument given to PREDICATE is the alist element\n\
b9b84fd3
SM
1055or the symbol from the obarray.\n\
1056Additionally to this predicate, `completion-regexp-list'\n\
1057is used to further constrain the set of candidates.")
7efd36fc
EN
1058 (string, alist, predicate)
1059 Lisp_Object string, alist, predicate;
f927c5ae
JB
1060{
1061 Lisp_Object bestmatch, tail, elt, eltstring;
af2b7cd5 1062 /* Size in bytes of BESTMATCH. */
6bbd7a29 1063 int bestmatchsize = 0;
af2b7cd5 1064 /* These are in bytes, too. */
f927c5ae 1065 int compare, matchsize;
56a98455 1066 int list = CONSP (alist) || NILP (alist);
6bbd7a29 1067 int index = 0, obsize = 0;
f927c5ae
JB
1068 int matchcount = 0;
1069 Lisp_Object bucket, zero, end, tem;
1070 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1071
1072 CHECK_STRING (string, 0);
7510b296 1073 if (!list && !VECTORP (alist))
7efd36fc 1074 return call3 (alist, string, predicate, Qnil);
f927c5ae 1075
6bbd7a29 1076 bestmatch = bucket = Qnil;
f927c5ae
JB
1077
1078 /* If ALIST is not a list, set TAIL just for gc pro. */
1079 tail = alist;
1080 if (! list)
1081 {
1082 index = 0;
1083 obsize = XVECTOR (alist)->size;
1084 bucket = XVECTOR (alist)->contents[index];
1085 }
1086
1087 while (1)
1088 {
1089 /* Get the next element of the alist or obarray. */
1090 /* Exit the loop if the elements are all used up. */
1091 /* elt gets the alist element or symbol.
1092 eltstring gets the name to check as a completion. */
1093
1094 if (list)
1095 {
56a98455 1096 if (NILP (tail))
f927c5ae
JB
1097 break;
1098 elt = Fcar (tail);
1099 eltstring = Fcar (elt);
1100 tail = Fcdr (tail);
1101 }
1102 else
1103 {
1104 if (XFASTINT (bucket) != 0)
1105 {
1106 elt = bucket;
1107 eltstring = Fsymbol_name (elt);
1108 if (XSYMBOL (bucket)->next)
1109 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1110 else
5a866662 1111 XSETFASTINT (bucket, 0);
f927c5ae
JB
1112 }
1113 else if (++index >= obsize)
1114 break;
1115 else
1116 {
1117 bucket = XVECTOR (alist)->contents[index];
1118 continue;
1119 }
1120 }
1121
1122 /* Is this element a possible completion? */
1123
7510b296 1124 if (STRINGP (eltstring)
7d315986 1125 && XSTRING (string)->size <= XSTRING (eltstring)->size
69f4ef20
RS
1126 && (tem = Fcompare_strings (eltstring, make_number (0),
1127 make_number (XSTRING (string)->size),
1128 string, make_number (0), Qnil,
1129 completion_ignore_case ?Qt : Qnil),
1130 EQ (Qt, tem)))
f927c5ae
JB
1131 {
1132 /* Yes. */
42006772
RS
1133 Lisp_Object regexps;
1134 Lisp_Object zero;
5a866662 1135 XSETFASTINT (zero, 0);
42006772
RS
1136
1137 /* Ignore this element if it fails to match all the regexps. */
1138 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
7539e11f 1139 regexps = XCDR (regexps))
42006772 1140 {
7539e11f 1141 tem = Fstring_match (XCAR (regexps), eltstring, zero);
42006772
RS
1142 if (NILP (tem))
1143 break;
1144 }
1145 if (CONSP (regexps))
1146 continue;
1147
f927c5ae
JB
1148 /* Ignore this element if there is a predicate
1149 and the predicate doesn't like it. */
1150
7efd36fc 1151 if (!NILP (predicate))
f927c5ae 1152 {
7efd36fc 1153 if (EQ (predicate, Qcommandp))
f927c5ae
JB
1154 tem = Fcommandp (elt);
1155 else
1156 {
1157 GCPRO4 (tail, string, eltstring, bestmatch);
7efd36fc 1158 tem = call1 (predicate, elt);
f927c5ae
JB
1159 UNGCPRO;
1160 }
56a98455 1161 if (NILP (tem)) continue;
f927c5ae
JB
1162 }
1163
1164 /* Update computation of how much all possible completions match */
1165
1166 matchcount++;
56a98455 1167 if (NILP (bestmatch))
af2b7cd5
RS
1168 {
1169 bestmatch = eltstring;
69f4ef20 1170 bestmatchsize = XSTRING (eltstring)->size;
af2b7cd5 1171 }
f927c5ae
JB
1172 else
1173 {
69f4ef20
RS
1174 compare = min (bestmatchsize, XSTRING (eltstring)->size);
1175 tem = Fcompare_strings (bestmatch, make_number (0),
1176 make_number (compare),
1177 eltstring, make_number (0),
1178 make_number (compare),
1179 completion_ignore_case ? Qt : Qnil);
1180 if (EQ (tem, Qt))
1181 matchsize = compare;
1182 else if (XINT (tem) < 0)
1183 matchsize = - XINT (tem) - 1;
1184 else
1185 matchsize = XINT (tem) - 1;
1186
52b14ac0
JB
1187 if (matchsize < 0)
1188 matchsize = compare;
1189 if (completion_ignore_case)
1190 {
1191 /* If this is an exact match except for case,
1192 use it as the best match rather than one that is not an
1193 exact match. This way, we get the case pattern
1194 of the actual match. */
69f4ef20
RS
1195 if ((matchsize == XSTRING (eltstring)->size
1196 && matchsize < XSTRING (bestmatch)->size)
52b14ac0
JB
1197 ||
1198 /* If there is more than one exact match ignoring case,
1199 and one of them is exact including case,
1200 prefer that one. */
1201 /* If there is no exact match ignoring case,
1202 prefer a match that does not change the case
1203 of the input. */
69f4ef20 1204 ((matchsize == XSTRING (eltstring)->size)
52b14ac0 1205 ==
69f4ef20
RS
1206 (matchsize == XSTRING (bestmatch)->size)
1207 && (tem = Fcompare_strings (eltstring, make_number (0),
1208 make_number (XSTRING (string)->size),
1209 string, make_number (0),
1210 Qnil,
1211 Qnil),
1212 EQ (Qt, tem))
1213 && (tem = Fcompare_strings (bestmatch, make_number (0),
1214 make_number (XSTRING (string)->size),
1215 string, make_number (0),
1216 Qnil,
1217 Qnil),
1218 ! EQ (Qt, tem))))
52b14ac0
JB
1219 bestmatch = eltstring;
1220 }
1221 bestmatchsize = matchsize;
f927c5ae
JB
1222 }
1223 }
1224 }
1225
56a98455 1226 if (NILP (bestmatch))
f927c5ae 1227 return Qnil; /* No completions found */
52b14ac0
JB
1228 /* If we are ignoring case, and there is no exact match,
1229 and no additional text was supplied,
1230 don't change the case of what the user typed. */
69f4ef20
RS
1231 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
1232 && XSTRING (bestmatch)->size > bestmatchsize)
ec067ec7 1233 return minibuf_conform_representation (string, bestmatch);
52b14ac0
JB
1234
1235 /* Return t if the supplied string is an exact match (counting case);
1236 it does not require any change to be made. */
69f4ef20
RS
1237 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
1238 && (tem = Fcompare_strings (bestmatch, make_number (0),
1239 make_number (bestmatchsize),
1240 string, make_number (0),
1241 make_number (bestmatchsize),
1242 Qnil),
1243 EQ (Qt, tem)))
f927c5ae
JB
1244 return Qt;
1245
5a866662
KH
1246 XSETFASTINT (zero, 0); /* Else extract the part in which */
1247 XSETFASTINT (end, bestmatchsize); /* all completions agree */
f927c5ae
JB
1248 return Fsubstring (bestmatch, zero, end);
1249}
1250
1251/* Compare exactly LEN chars of strings at S1 and S2,
1252 ignoring case if appropriate.
1253 Return -1 if strings match,
1254 else number of chars that match at the beginning. */
1255
829f7f7c 1256int
f927c5ae 1257scmp (s1, s2, len)
829f7f7c 1258 register unsigned char *s1, *s2;
f927c5ae
JB
1259 int len;
1260{
1261 register int l = len;
1262
1263 if (completion_ignore_case)
1264 {
2e34157c 1265 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
f927c5ae
JB
1266 l--;
1267 }
1268 else
1269 {
1270 while (l && *s1++ == *s2++)
1271 l--;
1272 }
1273 if (l == 0)
1274 return -1;
829f7f7c 1275 else
d50a3d2a
KH
1276 {
1277 int match = len - l;
1278
1279 /* Now *--S1 is the unmatching byte. If it is in the middle of
1280 multi-byte form, we must say that the multi-byte character
1281 there doesn't match. */
1282 while (match && *--s1 >= 0xA0) match--;
1283 return match;
1284 }
f927c5ae
JB
1285}
1286\f
89a255dc 1287DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
f927c5ae
JB
1288 "Search for partial matches to STRING in ALIST.\n\
1289Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1290The value is a list of all the strings from ALIST that match.\n\
89a255dc 1291\n\
f927c5ae
JB
1292ALIST can be an obarray instead of an alist.\n\
1293Then the print names of all symbols in the obarray are the possible matches.\n\
1294\n\
1295ALIST can also be a function to do the completion itself.\n\
1296It receives three arguments: the values STRING, PREDICATE and t.\n\
d3887e33 1297Whatever it returns becomes the value of `all-completions'.\n\
f927c5ae
JB
1298\n\
1299If optional third argument PREDICATE is non-nil,\n\
1300it is used to test each possible match.\n\
1301The match is a candidate only if PREDICATE returns non-nil.\n\
89a255dc
RS
1302The argument given to PREDICATE is the alist element\n\
1303or the symbol from the obarray.\n\
b9b84fd3
SM
1304Additionally to this predicate, `completion-regexp-list'\n\
1305is used to further constrain the set of candidates.\n\
89a255dc
RS
1306\n\
1307If the optional fourth argument HIDE-SPACES is non-nil,\n\
1308strings in ALIST that start with a space\n\
1309are ignored unless STRING itself starts with a space.")
7efd36fc
EN
1310 (string, alist, predicate, hide_spaces)
1311 Lisp_Object string, alist, predicate, hide_spaces;
f927c5ae
JB
1312{
1313 Lisp_Object tail, elt, eltstring;
1314 Lisp_Object allmatches;
56a98455 1315 int list = CONSP (alist) || NILP (alist);
6bbd7a29 1316 int index = 0, obsize = 0;
f927c5ae
JB
1317 Lisp_Object bucket, tem;
1318 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1319
1320 CHECK_STRING (string, 0);
7510b296 1321 if (!list && !VECTORP (alist))
f927c5ae 1322 {
7efd36fc 1323 return call3 (alist, string, predicate, Qt);
f927c5ae 1324 }
6bbd7a29 1325 allmatches = bucket = Qnil;
f927c5ae
JB
1326
1327 /* If ALIST is not a list, set TAIL just for gc pro. */
1328 tail = alist;
1329 if (! list)
1330 {
1331 index = 0;
1332 obsize = XVECTOR (alist)->size;
1333 bucket = XVECTOR (alist)->contents[index];
1334 }
1335
1336 while (1)
1337 {
1338 /* Get the next element of the alist or obarray. */
1339 /* Exit the loop if the elements are all used up. */
1340 /* elt gets the alist element or symbol.
1341 eltstring gets the name to check as a completion. */
1342
1343 if (list)
1344 {
56a98455 1345 if (NILP (tail))
f927c5ae
JB
1346 break;
1347 elt = Fcar (tail);
1348 eltstring = Fcar (elt);
1349 tail = Fcdr (tail);
1350 }
1351 else
1352 {
1353 if (XFASTINT (bucket) != 0)
1354 {
1355 elt = bucket;
1356 eltstring = Fsymbol_name (elt);
1357 if (XSYMBOL (bucket)->next)
1358 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1359 else
5a866662 1360 XSETFASTINT (bucket, 0);
f927c5ae
JB
1361 }
1362 else if (++index >= obsize)
1363 break;
1364 else
1365 {
1366 bucket = XVECTOR (alist)->contents[index];
1367 continue;
1368 }
1369 }
1370
1371 /* Is this element a possible completion? */
1372
7510b296 1373 if (STRINGP (eltstring)
7d315986 1374 && XSTRING (string)->size <= XSTRING (eltstring)->size
89a255dc 1375 /* If HIDE_SPACES, reject alternatives that start with space
2cbaf886 1376 unless the input starts with space. */
fc932ac6 1377 && ((STRING_BYTES (XSTRING (string)) > 0
af2b7cd5 1378 && XSTRING (string)->data[0] == ' ')
89a255dc
RS
1379 || XSTRING (eltstring)->data[0] != ' '
1380 || NILP (hide_spaces))
69f4ef20
RS
1381 && (tem = Fcompare_strings (eltstring, make_number (0),
1382 make_number (XSTRING (string)->size),
1383 string, make_number (0),
1384 make_number (XSTRING (string)->size),
1385 completion_ignore_case ? Qt : Qnil),
1386 EQ (Qt, tem)))
f927c5ae
JB
1387 {
1388 /* Yes. */
42006772
RS
1389 Lisp_Object regexps;
1390 Lisp_Object zero;
5a866662 1391 XSETFASTINT (zero, 0);
42006772
RS
1392
1393 /* Ignore this element if it fails to match all the regexps. */
1394 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
7539e11f 1395 regexps = XCDR (regexps))
42006772 1396 {
7539e11f 1397 tem = Fstring_match (XCAR (regexps), eltstring, zero);
42006772
RS
1398 if (NILP (tem))
1399 break;
1400 }
1401 if (CONSP (regexps))
1402 continue;
1403
f927c5ae
JB
1404 /* Ignore this element if there is a predicate
1405 and the predicate doesn't like it. */
1406
7efd36fc 1407 if (!NILP (predicate))
f927c5ae 1408 {
7efd36fc 1409 if (EQ (predicate, Qcommandp))
f927c5ae
JB
1410 tem = Fcommandp (elt);
1411 else
1412 {
1413 GCPRO4 (tail, eltstring, allmatches, string);
7efd36fc 1414 tem = call1 (predicate, elt);
f927c5ae
JB
1415 UNGCPRO;
1416 }
56a98455 1417 if (NILP (tem)) continue;
f927c5ae
JB
1418 }
1419 /* Ok => put it on the list. */
1420 allmatches = Fcons (eltstring, allmatches);
1421 }
1422 }
1423
1424 return Fnreverse (allmatches);
1425}
1426\f
1427Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1428Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1429Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
ccf330a6 1430Lisp_Object Vminibuffer_completing_file_name;
f927c5ae 1431
b9d721de
JB
1432/* This comment supplies the doc string for completing-read,
1433 for make-docfile to see. We cannot put this in the real DEFUN
1434 due to limits in the Unix cpp.
1435
cee54539 1436DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
f927c5ae 1437 "Read a string in the minibuffer, with completion.\n\
f927c5ae
JB
1438PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1439TABLE is an alist whose elements' cars are strings, or an obarray.\n\
834938d2 1440TABLE can also be a function to do the completion itself.\n\
f927c5ae 1441PREDICATE limits completion to a subset of TABLE.\n\
60e6659c 1442See `try-completion' and `all-completions' for more details\n\
6b3faad8 1443 on completion, TABLE, and PREDICATE.\n\
cbbc3917 1444\n\
f927c5ae 1445If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
4ced3209 1446 the input is (or completes to) an element of TABLE or is null.\n\
f927c5ae 1447 If it is also not t, Return does not exit if it does non-null completion.\n\
fab95625 1448If the input is null, `completing-read' returns an empty string,\n\
cbbc3917
RS
1449 regardless of the value of REQUIRE-MATCH.\n\
1450\n\
f927c5ae 1451If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
770970cb
RS
1452 If it is (STRING . POSITION), the initial input\n\
1453 is STRING, but point is placed POSITION characters into the string.\n\
cb615a61 1454 This feature is deprecated--it is best to pass nil for INITIAL.\n\
770970cb
RS
1455HIST, if non-nil, specifies a history list\n\
1456 and optionally the initial position in the list.\n\
1457 It can be a symbol, which is the history list variable to use,\n\
1458 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1459 In that case, HISTVAR is the history list variable to use,\n\
1460 and HISTPOS is the initial position (the position in the list\n\
4356f221 1461 which INITIAL-INPUT corresponds to).\n\
770970cb 1462 Positions are counted starting from 1 at the beginning of the list.\n\
cee54539
KH
1463DEF, if non-nil, is the default value.\n\
1464\n\
1465If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
c8c15521 1466 the current input method and the setting of enable-multibyte-characters.\n\
cee54539 1467\n\
770970cb 1468Completion ignores case if the ambient value of\n\
b9d721de
JB
1469 `completion-ignore-case' is non-nil."
1470*/
cee54539 1471DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
b9d721de 1472 0 /* See immediately above */)
d43f85c2
RS
1473 (prompt, table, predicate, require_match, initial_input, hist, def, inherit_input_method)
1474 Lisp_Object prompt, table, predicate, require_match, initial_input;
1475 Lisp_Object hist, def, inherit_input_method;
f927c5ae 1476{
770970cb 1477 Lisp_Object val, histvar, histpos, position;
d43f85c2 1478 Lisp_Object init;
770970cb 1479 int pos = 0;
f927c5ae 1480 int count = specpdl_ptr - specpdl;
0c8ee1a2
RS
1481 struct gcpro gcpro1;
1482
d43f85c2 1483 init = initial_input;
0c8ee1a2
RS
1484 GCPRO1 (def);
1485
f927c5ae 1486 specbind (Qminibuffer_completion_table, table);
7efd36fc 1487 specbind (Qminibuffer_completion_predicate, predicate);
f927c5ae
JB
1488 specbind (Qminibuffer_completion_confirm,
1489 EQ (require_match, Qt) ? Qnil : Qt);
1490 last_exact_completion = Qnil;
770970cb
RS
1491
1492 position = Qnil;
1493 if (!NILP (init))
1494 {
7510b296 1495 if (CONSP (init))
770970cb
RS
1496 {
1497 position = Fcdr (init);
1498 init = Fcar (init);
1499 }
1500 CHECK_STRING (init, 0);
1501 if (!NILP (position))
1502 {
1503 CHECK_NUMBER (position, 0);
1504 /* Convert to distance from end of input. */
5dadd3a2 1505 pos = XINT (position) - XSTRING (init)->size;
770970cb
RS
1506 }
1507 }
1508
7510b296 1509 if (SYMBOLP (hist))
770970cb
RS
1510 {
1511 histvar = hist;
1512 histpos = Qnil;
1513 }
1514 else
1515 {
1516 histvar = Fcar_safe (hist);
1517 histpos = Fcdr_safe (hist);
1518 }
1519 if (NILP (histvar))
1520 histvar = Qminibuffer_history;
1521 if (NILP (histpos))
5a866662 1522 XSETFASTINT (histpos, 0);
770970cb 1523
56a98455 1524 val = read_minibuf (NILP (require_match)
f927c5ae
JB
1525 ? Vminibuffer_local_completion_map
1526 : Vminibuffer_local_must_match_map,
85b5fe07 1527 init, prompt, make_number (pos), 0,
cee54539
KH
1528 histvar, histpos, def, 0,
1529 !NILP (inherit_input_method));
b9a86585
RS
1530
1531 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (def))
1532 val = def;
1533
0c8ee1a2 1534 RETURN_UNGCPRO (unbind_to (count, val));
f927c5ae
JB
1535}
1536\f
f927c5ae 1537Lisp_Object Fminibuffer_completion_help ();
52b14ac0 1538Lisp_Object assoc_for_completion ();
5d2ca7ae
RS
1539
1540/* Test whether TXT is an exact completion. */
1541Lisp_Object
1542test_completion (txt)
1543 Lisp_Object txt;
1544{
1545 Lisp_Object tem;
1546
1547 if (CONSP (Vminibuffer_completion_table)
1548 || NILP (Vminibuffer_completion_table))
1549 return assoc_for_completion (txt, Vminibuffer_completion_table);
1550 else if (VECTORP (Vminibuffer_completion_table))
1551 {
1552 /* Bypass intern-soft as that loses for nil */
1553 tem = oblookup (Vminibuffer_completion_table,
af2b7cd5
RS
1554 XSTRING (txt)->data,
1555 XSTRING (txt)->size,
fc932ac6 1556 STRING_BYTES (XSTRING (txt)));
44472c88 1557 if (!SYMBOLP (tem))
9404446f
RS
1558 {
1559 if (STRING_MULTIBYTE (txt))
1560 txt = Fstring_make_unibyte (txt);
1561 else
1562 txt = Fstring_make_multibyte (txt);
1563
1564 tem = oblookup (Vminibuffer_completion_table,
1565 XSTRING (txt)->data,
1566 XSTRING (txt)->size,
1567 STRING_BYTES (XSTRING (txt)));
1568 if (!SYMBOLP (tem))
1569 return Qnil;
1570 }
1571 if (!NILP (Vminibuffer_completion_predicate))
5d2ca7ae
RS
1572 return call1 (Vminibuffer_completion_predicate, tem);
1573 else
1574 return Qt;
1575 }
1576 else
1577 return call3 (Vminibuffer_completion_table, txt,
1578 Vminibuffer_completion_predicate, Qlambda);
1579}
f927c5ae
JB
1580
1581/* returns:
1582 * 0 no possible completion
1583 * 1 was already an exact and unique completion
1584 * 3 was already an exact completion
1585 * 4 completed to an exact completion
1586 * 5 some completion happened
1587 * 6 no completion happened
1588 */
1589int
1590do_completion ()
1591{
0c80756e 1592 Lisp_Object completion, string, tem;
f927c5ae
JB
1593 int completedp;
1594 Lisp_Object last;
1e00c2ff 1595 struct gcpro gcpro1, gcpro2;
f927c5ae 1596
7c752c80 1597 completion = Ftry_completion (Ffield_string (make_number (ZV)),
8e9968c6 1598 Vminibuffer_completion_table,
f927c5ae
JB
1599 Vminibuffer_completion_predicate);
1600 last = last_exact_completion;
1601 last_exact_completion = Qnil;
1602
4f9b95e5
KH
1603 GCPRO2 (completion, last);
1604
56a98455 1605 if (NILP (completion))
f927c5ae
JB
1606 {
1607 bitch_at_user ();
1608 temp_echo_area_glyphs (" [No match]");
1e00c2ff 1609 UNGCPRO;
f927c5ae
JB
1610 return 0;
1611 }
1612
1613 if (EQ (completion, Qt)) /* exact and unique match */
1e00c2ff
KH
1614 {
1615 UNGCPRO;
1616 return 1;
1617 }
f927c5ae 1618
0c80756e
MB
1619 string = Ffield_string (make_number (ZV));
1620
1621 /* COMPLETEDP should be true if some completion was done, which
1622 doesn't include simply changing the case of the entered string.
1623 However, for appearance, the string is rewritten if the case
1624 changes. */
1625 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qt);
01cce3e7 1626 completedp = !EQ (tem, Qt);
0c80756e 1627
7892a68b
KH
1628 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qnil);
1629 if (!EQ (tem, Qt))
0c80756e 1630 /* Rewrite the user's input. */
f927c5ae 1631 {
98cbb9a3 1632 Fdelete_field (make_number (ZV)); /* Some completion happened */
f927c5ae 1633 Finsert (1, &completion);
6e69ab8c
MB
1634
1635 if (! completedp)
1636 /* The case of the string changed, but that's all. We're not
1637 sure whether this is a unique completion or not, so try again
1638 using the real case (this shouldn't recurse again, because
1639 the next time try-completion will return either `t' or the
1640 exact string). */
1641 {
1642 UNGCPRO;
1643 return do_completion ();
1644 }
f927c5ae
JB
1645 }
1646
1647 /* It did find a match. Do we match some possibility exactly now? */
7c752c80 1648 tem = test_completion (Ffield_string (make_number (ZV)));
56a98455 1649 if (NILP (tem))
1e00c2ff
KH
1650 {
1651 /* not an exact match */
1652 UNGCPRO;
f927c5ae
JB
1653 if (completedp)
1654 return 5;
739cc391 1655 else if (!NILP (Vcompletion_auto_help))
f927c5ae
JB
1656 Fminibuffer_completion_help ();
1657 else
1658 temp_echo_area_glyphs (" [Next char not unique]");
1659 return 6;
1660 }
1661 else if (completedp)
1e00c2ff
KH
1662 {
1663 UNGCPRO;
1664 return 4;
1665 }
f927c5ae
JB
1666 /* If the last exact completion and this one were the same,
1667 it means we've already given a "Complete but not unique"
52b14ac0 1668 message and the user's hit TAB again, so now we give him help. */
f927c5ae 1669 last_exact_completion = completion;
56a98455 1670 if (!NILP (last))
f927c5ae 1671 {
7c752c80 1672 tem = Ffield_string (make_number (ZV));
56a98455 1673 if (!NILP (Fequal (tem, last)))
f927c5ae
JB
1674 Fminibuffer_completion_help ();
1675 }
1e00c2ff 1676 UNGCPRO;
f927c5ae 1677 return 3;
f927c5ae 1678}
1e00c2ff 1679
52b14ac0
JB
1680/* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1681
1682Lisp_Object
1683assoc_for_completion (key, list)
1684 register Lisp_Object key;
1685 Lisp_Object list;
1686{
1687 register Lisp_Object tail;
1688
56a98455 1689 for (tail = list; !NILP (tail); tail = Fcdr (tail))
52b14ac0
JB
1690 {
1691 register Lisp_Object elt, tem, thiscar;
1692 elt = Fcar (tail);
1693 if (!CONSP (elt)) continue;
1694 thiscar = Fcar (elt);
7510b296 1695 if (!STRINGP (thiscar))
52b14ac0 1696 continue;
9404446f
RS
1697 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1698 key, make_number (0), Qnil,
1699 completion_ignore_case ? Qt : Qnil);
1700 if (EQ (tem, Qt))
1701 return elt;
52b14ac0
JB
1702 QUIT;
1703 }
1704 return Qnil;
1705}
f927c5ae
JB
1706
1707DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
6300d782 1708 "Complete the minibuffer contents as far as possible.\n\
2cb6da5c
RS
1709Return nil if there is no valid completion, else t.\n\
1710If no characters can be completed, display a list of possible completions.\n\
1711If you repeat this command after it displayed such a list,\n\
1712scroll the window of possible completions.")
f927c5ae
JB
1713 ()
1714{
2cb6da5c
RS
1715 register int i;
1716 Lisp_Object window, tem;
1717
df902b62
RS
1718 /* If the previous command was not this,
1719 mark the completion buffer obsolete. */
1720 if (! EQ (current_kboard->Vlast_command, Vthis_command))
2cb6da5c
RS
1721 Vminibuf_scroll_window = Qnil;
1722
1723 window = Vminibuf_scroll_window;
1724 /* If there's a fresh completion window with a live buffer,
1725 and this command is repeated, scroll that window. */
1726 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1727 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1728 {
1729 struct buffer *obuf = current_buffer;
1730
1731 Fset_buffer (XWINDOW (window)->buffer);
7d7c3861 1732 tem = Fpos_visible_in_window_p (make_number (ZV), window, Qnil);
2cb6da5c
RS
1733 if (! NILP (tem))
1734 /* If end is in view, scroll up to the beginning. */
b7df898e 1735 Fset_window_start (window, make_number (BEGV), Qnil);
2cb6da5c
RS
1736 else
1737 /* Else scroll down one screen. */
1738 Fscroll_other_window (Qnil);
1739
1740 set_buffer_internal (obuf);
1741 return Qnil;
1742 }
1743
1744 i = do_completion ();
f927c5ae
JB
1745 switch (i)
1746 {
1747 case 0:
1748 return Qnil;
1749
1750 case 1:
a1c5aa96
GM
1751 if (PT != ZV)
1752 Fgoto_char (make_number (ZV));
f927c5ae
JB
1753 temp_echo_area_glyphs (" [Sole completion]");
1754 break;
1755
1756 case 3:
9994cc69
GM
1757 if (PT != ZV)
1758 Fgoto_char (make_number (ZV));
f927c5ae
JB
1759 temp_echo_area_glyphs (" [Complete, but not unique]");
1760 break;
1761 }
1762
1763 return Qt;
1764}
e4c97a67
RS
1765\f
1766/* Subroutines of Fminibuffer_complete_and_exit. */
1767
1768/* This one is called by internal_condition_case to do the real work. */
1769
1770Lisp_Object
1771complete_and_exit_1 ()
1772{
1773 return make_number (do_completion ());
1774}
1775
1776/* This one is called by internal_condition_case if an error happens.
1777 Pretend the current value is an exact match. */
1778
1779Lisp_Object
1780complete_and_exit_2 (ignore)
1781 Lisp_Object ignore;
1782{
1783 return make_number (1);
1784}
f927c5ae
JB
1785
1786DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1787 Sminibuffer_complete_and_exit, 0, 0, "",
5d2ca7ae
RS
1788 "If the minibuffer contents is a valid completion then exit.\n\
1789Otherwise try to complete it. If completion leads to a valid completion,\n\
f927c5ae
JB
1790a repetition of this command will exit.")
1791 ()
1792{
1793 register int i;
e4c97a67 1794 Lisp_Object val;
f927c5ae
JB
1795
1796 /* Allow user to specify null string */
7c752c80 1797 if (XINT (Ffield_beginning (make_number (ZV), Qnil)) == ZV)
f927c5ae
JB
1798 goto exit;
1799
7c752c80 1800 if (!NILP (test_completion (Ffield_string (make_number (ZV)))))
5d2ca7ae
RS
1801 goto exit;
1802
e4c97a67
RS
1803 /* Call do_completion, but ignore errors. */
1804 val = internal_condition_case (complete_and_exit_1, Qerror,
1805 complete_and_exit_2);
1806
1807 i = XFASTINT (val);
f927c5ae
JB
1808 switch (i)
1809 {
1810 case 1:
1811 case 3:
1812 goto exit;
1813
1814 case 4:
56a98455 1815 if (!NILP (Vminibuffer_completion_confirm))
f927c5ae
JB
1816 {
1817 temp_echo_area_glyphs (" [Confirm]");
1818 return Qnil;
1819 }
1820 else
1821 goto exit;
1822
1823 default:
1824 return Qnil;
1825 }
1826 exit:
6bbd7a29 1827 return Fthrow (Qexit, Qnil);
f927c5ae
JB
1828 /* NOTREACHED */
1829}
1830
1831DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1832 0, 0, "",
1833 "Complete the minibuffer contents at most a single word.\n\
1834After one word is completed as much as possible, a space or hyphen\n\
6300d782
KH
1835is added, provided that matches some possible completion.\n\
1836Return nil if there is no valid completion, else t.")
f927c5ae
JB
1837 ()
1838{
69f4ef20 1839 Lisp_Object completion, tem, tem1;
af2b7cd5 1840 register int i, i_byte;
f927c5ae 1841 register unsigned char *completion_string;
d7be4211 1842 struct gcpro gcpro1, gcpro2;
8e9968c6 1843 int prompt_end_charpos;
b278606c
BF
1844
1845 /* We keep calling Fbuffer_string rather than arrange for GC to
1846 hold onto a pointer to one of the strings thus made. */
f927c5ae 1847
7c752c80 1848 completion = Ftry_completion (Ffield_string (make_number (ZV)),
f927c5ae
JB
1849 Vminibuffer_completion_table,
1850 Vminibuffer_completion_predicate);
56a98455 1851 if (NILP (completion))
f927c5ae
JB
1852 {
1853 bitch_at_user ();
1854 temp_echo_area_glyphs (" [No match]");
1855 return Qnil;
1856 }
1857 if (EQ (completion, Qt))
1858 return Qnil;
1859
b278606c 1860#if 0 /* How the below code used to look, for reference. */
7c752c80 1861 tem = Ffield_string (make_number (ZV));
f927c5ae
JB
1862 b = XSTRING (tem)->data;
1863 i = ZV - 1 - XSTRING (completion)->size;
1864 p = XSTRING (completion)->data;
1865 if (i > 0 ||
1866 0 <= scmp (b, p, ZV - 1))
1867 {
1868 i = 1;
1869 /* Set buffer to longest match of buffer tail and completion head. */
1870 while (0 <= scmp (b + i, p, ZV - 1 - i))
1871 i++;
1872 del_range (1, i + 1);
1873 SET_PT (ZV);
1874 }
1875#else /* Rewritten code */
1876 {
69f4ef20 1877 int buffer_nchars, completion_nchars;
f927c5ae 1878
59860a8c 1879 CHECK_STRING (completion, 0);
7c752c80 1880 tem = Ffield_string (make_number (ZV));
d7be4211 1881 GCPRO2 (completion, tem);
719b4a40
RS
1882 /* If reading a file name,
1883 expand any $ENVVAR refs in the buffer and in TEM. */
ccf330a6 1884 if (! NILP (Vminibuffer_completing_file_name))
719b4a40
RS
1885 {
1886 Lisp_Object substituted;
1887 substituted = Fsubstitute_in_file_name (tem);
1888 if (! EQ (substituted, tem))
1889 {
1890 tem = substituted;
98cbb9a3 1891 Fdelete_field (make_number (ZV));
af2b7cd5 1892 insert_from_string (tem, 0, 0, XSTRING (tem)->size,
fc932ac6 1893 STRING_BYTES (XSTRING (tem)), 0);
719b4a40
RS
1894 }
1895 }
69f4ef20
RS
1896 buffer_nchars = XSTRING (tem)->size; /* ie ZV - BEGV */
1897 completion_nchars = XSTRING (completion)->size;
1898 i = buffer_nchars - completion_nchars;
1899 if (i > 0
1900 ||
1901 (tem1 = Fcompare_strings (tem, make_number (0),
1902 make_number (buffer_nchars),
1903 completion, make_number (0),
1904 make_number (buffer_nchars),
1905 completion_ignore_case ? Qt : Qnil),
1906 ! EQ (tem1, Qt)))
f927c5ae 1907 {
69f4ef20
RS
1908 int start_pos;
1909
1910 /* Set buffer to longest match of buffer tail and completion head. */
1911 if (i <= 0) i = 1;
1912 start_pos= i;
1913 buffer_nchars -= i;
669c6673 1914 while (i > 0)
69f4ef20 1915 {
669c6673 1916 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
69f4ef20
RS
1917 completion, make_number (0),
1918 make_number (buffer_nchars),
1919 completion_ignore_case ? Qt : Qnil);
1920 start_pos++;
1921 if (EQ (tem1, Qt))
1922 break;
1923 i++;
669c6673 1924 buffer_nchars--;
69f4ef20
RS
1925 }
1926 del_range (1, i + 1);
a9c26562 1927 SET_PT_BOTH (ZV, ZV_BYTE);
f927c5ae 1928 }
d7be4211 1929 UNGCPRO;
f927c5ae
JB
1930 }
1931#endif /* Rewritten code */
279cf52c 1932
7c752c80 1933 prompt_end_charpos = XINT (Ffield_beginning (make_number (ZV), Qnil));
8e9968c6 1934
279cf52c 1935 {
8e9968c6 1936 int prompt_end_bytepos;
279cf52c
GM
1937 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
1938 i = ZV - prompt_end_charpos;
1939 i_byte = ZV_BYTE - prompt_end_bytepos;
1940 }
f927c5ae
JB
1941
1942 /* If completion finds next char not unique,
b278606c 1943 consider adding a space or a hyphen. */
f927c5ae
JB
1944 if (i == XSTRING (completion)->size)
1945 {
b278606c 1946 GCPRO1 (completion);
7c752c80 1947 tem = Ftry_completion (concat2 (Ffield_string (make_number (ZV)), build_string (" ")),
f927c5ae
JB
1948 Vminibuffer_completion_table,
1949 Vminibuffer_completion_predicate);
b278606c
BF
1950 UNGCPRO;
1951
7510b296 1952 if (STRINGP (tem))
f927c5ae
JB
1953 completion = tem;
1954 else
1955 {
b278606c
BF
1956 GCPRO1 (completion);
1957 tem =
7c752c80 1958 Ftry_completion (concat2 (Ffield_string (make_number (ZV)), build_string ("-")),
b278606c
BF
1959 Vminibuffer_completion_table,
1960 Vminibuffer_completion_predicate);
1961 UNGCPRO;
1962
7510b296 1963 if (STRINGP (tem))
f927c5ae
JB
1964 completion = tem;
1965 }
1966 }
1967
1968 /* Now find first word-break in the stuff found by completion.
1969 i gets index in string of where to stop completing. */
d50a3d2a
KH
1970 {
1971 int len, c;
54643b2c 1972 int bytes = STRING_BYTES (XSTRING (completion));
d50a3d2a 1973 completion_string = XSTRING (completion)->data;
fc932ac6 1974 for (; i_byte < STRING_BYTES (XSTRING (completion)); i_byte += len, i++)
d50a3d2a 1975 {
af2b7cd5 1976 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
54643b2c 1977 bytes - i_byte,
d50a3d2a
KH
1978 len);
1979 if (SYNTAX (c) != Sword)
1980 {
af2b7cd5
RS
1981 i_byte += len;
1982 i++;
d50a3d2a
KH
1983 break;
1984 }
1985 }
1986 }
f927c5ae
JB
1987
1988 /* If got no characters, print help for user. */
1989
8e9968c6 1990 if (i == ZV - prompt_end_charpos)
f927c5ae 1991 {
739cc391 1992 if (!NILP (Vcompletion_auto_help))
f927c5ae
JB
1993 Fminibuffer_completion_help ();
1994 return Qnil;
1995 }
1996
1997 /* Otherwise insert in minibuffer the chars we got */
1998
98cbb9a3 1999 Fdelete_field (make_number (ZV));
af2b7cd5 2000 insert_from_string (completion, 0, 0, i, i_byte, 1);
f927c5ae
JB
2001 return Qt;
2002}
2003\f
2004DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
2005 1, 1, 0,
2dc2b736 2006 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
f927c5ae 2007Each element may be just a symbol or string\n\
2d7e41fe
RS
2008or may be a list of two strings to be printed as if concatenated.\n\
2009`standard-output' must be a buffer.\n\
5744fa7c
RS
2010The actual completion alternatives, as inserted, are given `mouse-face'\n\
2011properties of `highlight'.\n\
2012At the end, this runs the normal hook `completion-setup-hook'.\n\
2d7e41fe 2013It can find the completion buffer in `standard-output'.")
f927c5ae
JB
2014 (completions)
2015 Lisp_Object completions;
2016{
dae36123 2017 Lisp_Object tail, elt;
f927c5ae 2018 register int i;
2dc2b736 2019 int column = 0;
dae36123 2020 struct gcpro gcpro1, gcpro2;
2dc2b736 2021 struct buffer *old = current_buffer;
681f5af4 2022 int first = 1;
486cc7fb
RS
2023
2024 /* Note that (when it matters) every variable
dae36123
RS
2025 points to a non-string that is pointed to by COMPLETIONS,
2026 except for ELT. ELT can be pointing to a string
2027 when terpri or Findent_to calls a change hook. */
2028 elt = Qnil;
2029 GCPRO2 (completions, elt);
486cc7fb 2030
7510b296 2031 if (BUFFERP (Vstandard_output))
2dc2b736 2032 set_buffer_internal (XBUFFER (Vstandard_output));
f927c5ae 2033
56a98455 2034 if (NILP (completions))
cfc736bf
RS
2035 write_string ("There are no possible completions of what you have typed.",
2036 -1);
f927c5ae
JB
2037 else
2038 {
2dc2b736 2039 write_string ("Possible completions are:", -1);
56a98455 2040 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
f927c5ae 2041 {
ec067ec7 2042 Lisp_Object tem, string;
681f5af4 2043 int length;
47d7d104 2044 Lisp_Object startpos, endpos;
681f5af4 2045
6bbd7a29
GM
2046 startpos = Qnil;
2047
681f5af4
RS
2048 elt = Fcar (tail);
2049 /* Compute the length of this element. */
2050 if (CONSP (elt))
2051 {
49db96ce 2052 tem = XCAR (elt);
681f5af4 2053 CHECK_STRING (tem, 0);
49db96ce 2054 length = XSTRING (tem)->size;
681f5af4 2055
49db96ce 2056 tem = Fcar (XCDR (elt));
681f5af4 2057 CHECK_STRING (tem, 0);
49db96ce 2058 length += XSTRING (tem)->size;
681f5af4
RS
2059 }
2060 else
2061 {
2062 CHECK_STRING (elt, 0);
49db96ce 2063 length = XSTRING (elt)->size;
681f5af4
RS
2064 }
2065
2066 /* This does a bad job for narrower than usual windows.
2067 Sadly, the window it will appear in is not known
2068 until after the text has been made. */
2069
47d7d104
RS
2070 if (BUFFERP (Vstandard_output))
2071 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2072
681f5af4
RS
2073 /* If the previous completion was very wide,
2074 or we have two on this line already,
2075 don't put another on the same line. */
2076 if (column > 33 || first
2077 /* If this is really wide, don't put it second on a line. */
13c67cc6 2078 || (column > 0 && length > 45))
681f5af4
RS
2079 {
2080 Fterpri (Qnil);
2081 column = 0;
2082 }
2083 /* Otherwise advance to column 35. */
2084 else
2dc2b736 2085 {
7510b296 2086 if (BUFFERP (Vstandard_output))
681f5af4
RS
2087 {
2088 tem = Findent_to (make_number (35), make_number (2));
47d7d104 2089
681f5af4
RS
2090 column = XINT (tem);
2091 }
2dc2b736
RS
2092 else
2093 {
2094 do
2095 {
2096 write_string (" ", -1);
2097 column++;
2098 }
2099 while (column < 35);
2100 }
2101 }
681f5af4 2102
47d7d104
RS
2103 if (BUFFERP (Vstandard_output))
2104 {
2105 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2106 Fset_text_properties (startpos, endpos,
2107 Qnil, Vstandard_output);
2108 }
2109
ec067ec7 2110 /* Output this element.
9404446f 2111 If necessary, convert it to unibyte or to multibyte first. */
f927c5ae 2112 if (CONSP (elt))
ec067ec7 2113 string = Fcar (elt);
f927c5ae 2114 else
ec067ec7
RS
2115 string = elt;
2116 if (NILP (current_buffer->enable_multibyte_characters)
2117 && STRING_MULTIBYTE (string))
2118 string = Fstring_make_unibyte (string);
9404446f
RS
2119 else if (!NILP (current_buffer->enable_multibyte_characters)
2120 && !STRING_MULTIBYTE (string))
2121 string = Fstring_make_multibyte (string);
5744fa7c
RS
2122
2123 if (BUFFERP (Vstandard_output))
2124 {
4b37311e 2125 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
5744fa7c
RS
2126
2127 Fprinc (string, Qnil);
2128
4b37311e 2129 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
5744fa7c 2130
4b37311e 2131 Fput_text_property (startpos, endpos,
5744fa7c
RS
2132 Qmouse_face, intern ("highlight"),
2133 Vstandard_output);
2134 }
2135 else
2136 {
2137 Fprinc (string, Qnil);
2138 }
ec067ec7
RS
2139
2140 /* Output the annotation for this element. */
2141 if (CONSP (elt))
4b37311e
RS
2142 {
2143 if (BUFFERP (Vstandard_output))
2144 {
2145 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2146
2147 Fprinc (Fcar (Fcdr (elt)), Qnil);
2148
2149 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2150
2151 Fset_text_properties (startpos, endpos, Qnil,
2152 Vstandard_output);
2153 }
2154 else
2155 {
2156 Fprinc (Fcar (Fcdr (elt)), Qnil);
2157 }
2158 }
2159
681f5af4 2160
ec067ec7 2161 /* Update COLUMN for what we have output. */
681f5af4
RS
2162 column += length;
2163
2164 /* If output is to a buffer, recompute COLUMN in a way
2165 that takes account of character widths. */
2166 if (BUFFERP (Vstandard_output))
2dc2b736 2167 {
681f5af4
RS
2168 tem = Fcurrent_column ();
2169 column = XINT (tem);
2dc2b736 2170 }
681f5af4
RS
2171
2172 first = 0;
f927c5ae
JB
2173 }
2174 }
2dc2b736 2175
486cc7fb
RS
2176 UNGCPRO;
2177
7510b296 2178 if (BUFFERP (Vstandard_output))
2d7e41fe
RS
2179 set_buffer_internal (old);
2180
cfc736bf
RS
2181 if (!NILP (Vrun_hooks))
2182 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2183
f927c5ae
JB
2184 return Qnil;
2185}
2186
2187DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
2188 0, 0, "",
2189 "Display a list of possible completions of the current minibuffer contents.")
2190 ()
2191{
2192 Lisp_Object completions;
2193
2194 message ("Making completion list...");
7c752c80 2195 completions = Fall_completions (Ffield_string (make_number (ZV)),
f927c5ae 2196 Vminibuffer_completion_table,
89a255dc
RS
2197 Vminibuffer_completion_predicate,
2198 Qt);
39e98b38 2199 clear_message (1, 0);
f927c5ae 2200
56a98455 2201 if (NILP (completions))
f927c5ae
JB
2202 {
2203 bitch_at_user ();
2204 temp_echo_area_glyphs (" [No completions]");
2205 }
2206 else
2207 internal_with_output_to_temp_buffer ("*Completions*",
2208 Fdisplay_completion_list,
2209 Fsort (completions, Qstring_lessp));
2210 return Qnil;
2211}
2212\f
2213DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
2214 "Terminate minibuffer input.")
2215 ()
2216{
7510b296 2217 if (INTEGERP (last_command_char))
dab3ab3c 2218 internal_self_insert (XINT (last_command_char), 0);
f927c5ae
JB
2219 else
2220 bitch_at_user ();
2221
6bbd7a29 2222 return Fthrow (Qexit, Qnil);
f927c5ae
JB
2223}
2224
2225DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
2226 "Terminate this minibuffer argument.")
2227 ()
2228{
6bbd7a29 2229 return Fthrow (Qexit, Qnil);
f927c5ae
JB
2230}
2231
2232DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2233 "Return current depth of activations of minibuffer, a nonnegative integer.")
2234 ()
2235{
2236 return make_number (minibuf_level);
2237}
2238
37e9a934
KH
2239DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2240 "Return the prompt string of the currently-active minibuffer.\n\
2241If no minibuffer is active, return nil.")
2242 ()
2243{
4d04c1f1 2244 return Fcopy_sequence (minibuf_prompt);
37e9a934
KH
2245}
2246
f927c5ae 2247\f
2d955a50
RS
2248/* Temporarily display the string M at the end of the current
2249 minibuffer contents. This is used to display things like
2250 "[No Match]" when the user requests a completion for a prefix
2251 that has no possible completions, and other quick, unobtrusive
2252 messages. */
2253
9d815fd9 2254void
2d955a50
RS
2255temp_echo_area_glyphs (m)
2256 char *m;
2257{
2258 int osize = ZV;
a9c26562 2259 int osize_byte = ZV_BYTE;
2d955a50 2260 int opoint = PT;
a9c26562 2261 int opoint_byte = PT_BYTE;
2d955a50
RS
2262 Lisp_Object oinhibit;
2263 oinhibit = Vinhibit_quit;
2264
2265 /* Clear out any old echo-area message to make way for our new thing. */
2266 message (0);
2267
a9c26562 2268 SET_PT_BOTH (osize, osize_byte);
2d955a50 2269 insert_string (m);
a9c26562 2270 SET_PT_BOTH (opoint, opoint_byte);
2d955a50
RS
2271 Vinhibit_quit = Qt;
2272 Fsit_for (make_number (2), Qnil, Qnil);
bc69581b 2273 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
a9c26562 2274 SET_PT_BOTH (opoint, opoint_byte);
2d955a50
RS
2275 if (!NILP (Vquit_flag))
2276 {
2277 Vquit_flag = Qnil;
2278 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2279 }
2280 Vinhibit_quit = oinhibit;
2281}
2282
2283DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2284 1, 1, 0,
2285 "Temporarily display STRING at the end of the minibuffer.\n\
2286The text is displayed for two seconds,\n\
2287or until the next input event arrives, whichever comes first.")
2288 (string)
2289 Lisp_Object string;
2290{
2291 temp_echo_area_glyphs (XSTRING (string)->data);
2292 return Qnil;
2293}
2294\f
9d815fd9 2295void
f927c5ae
JB
2296init_minibuf_once ()
2297{
2298 Vminibuffer_list = Qnil;
2299 staticpro (&Vminibuffer_list);
2300}
2301
9d815fd9 2302void
f927c5ae
JB
2303syms_of_minibuf ()
2304{
2305 minibuf_level = 0;
4d04c1f1
KH
2306 minibuf_prompt = Qnil;
2307 staticpro (&minibuf_prompt);
2308
2309 minibuf_save_list = Qnil;
2310 staticpro (&minibuf_save_list);
f927c5ae 2311
719b4a40
RS
2312 Qread_file_name_internal = intern ("read-file-name-internal");
2313 staticpro (&Qread_file_name_internal);
2314
e5d4686b
RS
2315 Qminibuffer_default = intern ("minibuffer-default");
2316 staticpro (&Qminibuffer_default);
2317 Fset (Qminibuffer_default, Qnil);
2318
f927c5ae
JB
2319 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2320 staticpro (&Qminibuffer_completion_table);
2321
2322 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2323 staticpro (&Qminibuffer_completion_confirm);
2324
2325 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2326 staticpro (&Qminibuffer_completion_predicate);
2327
1e00c2ff
KH
2328 staticpro (&last_exact_completion);
2329 last_exact_completion = Qnil;
2330
f927c5ae
JB
2331 staticpro (&last_minibuf_string);
2332 last_minibuf_string = Qnil;
2333
2334 Quser_variable_p = intern ("user-variable-p");
2335 staticpro (&Quser_variable_p);
2336
770970cb
RS
2337 Qminibuffer_history = intern ("minibuffer-history");
2338 staticpro (&Qminibuffer_history);
f927c5ae 2339
406e55df
RS
2340 Qbuffer_name_history = intern ("buffer-name-history");
2341 staticpro (&Qbuffer_name_history);
33d0a17f 2342 Fset (Qbuffer_name_history, Qnil);
406e55df 2343
5c781212
RS
2344 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2345 staticpro (&Qminibuffer_setup_hook);
2346
177aecf9
KH
2347 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2348 staticpro (&Qminibuffer_exit_hook);
2349
77aa8edf
RS
2350 Qhistory_length = intern ("history-length");
2351 staticpro (&Qhistory_length);
2352
cee54539
KH
2353 Qcurrent_input_method = intern ("current-input-method");
2354 staticpro (&Qcurrent_input_method);
2355
2356 Qactivate_input_method = intern ("activate-input-method");
2357 staticpro (&Qactivate_input_method);
2358
eebbfb01
KH
2359 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2360 "If this is non-nil, `read-buffer' does its work by calling this function.");
2361 Vread_buffer_function = Qnil;
2362
5c781212
RS
2363 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2364 "Normal hook run just after entry to minibuffer.");
2365 Vminibuffer_setup_hook = Qnil;
2366
177aecf9
KH
2367 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2368 "Normal hook run just after exit from minibuffer.");
2369 Vminibuffer_exit_hook = Qnil;
2370
77aa8edf
RS
2371 DEFVAR_LISP ("history-length", &Vhistory_length,
2372 "*Maximum length for history lists before truncation takes place.\n\
2373A number means that length; t means infinite. Truncation takes place\n\
2374just after a new element is inserted. Setting the history-length\n\
2375property of a history variable overrides this default.");
2376 XSETFASTINT (Vhistory_length, 30);
2377
739cc391 2378 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help,
f927c5ae 2379 "*Non-nil means automatically provide help for invalid completion input.");
739cc391 2380 Vcompletion_auto_help = Qt;
f927c5ae
JB
2381
2382 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2383 "Non-nil means don't consider case significant in completion.");
2384 completion_ignore_case = 0;
2385
2386 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2387 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
7e3e3ad1 2388This variable makes a difference whenever the minibuffer window is active.");
f927c5ae
JB
2389 enable_recursive_minibuffers = 0;
2390
2391 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2392 "Alist or obarray used for completion in the minibuffer.\n\
2393This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2394\n\
2395The value may alternatively be a function, which is given three arguments:\n\
2396 STRING, the current buffer contents;\n\
2397 PREDICATE, the predicate for filtering possible matches;\n\
2398 CODE, which says what kind of things to do.\n\
2399CODE can be nil, t or `lambda'.\n\
2400nil means to return the best completion of STRING, or nil if there is none.\n\
2401t means to return a list of all possible completions of STRING.\n\
2402`lambda' means to return t if STRING is a valid completion as it stands.");
2403 Vminibuffer_completion_table = Qnil;
2404
2405 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2406 "Within call to `completing-read', this holds the PREDICATE argument.");
2407 Vminibuffer_completion_predicate = Qnil;
2408
2409 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2410 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2411 Vminibuffer_completion_confirm = Qnil;
2412
ccf330a6
RS
2413 DEFVAR_LISP ("minibuffer-completing-file-name",
2414 &Vminibuffer_completing_file_name,
2415 "Non-nil means completing file names.");
2416 Vminibuffer_completing_file_name = Qnil;
2417
f927c5ae
JB
2418 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2419 "Value that `help-form' takes on inside the minibuffer.");
2420 Vminibuffer_help_form = Qnil;
2421
770970cb
RS
2422 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2423 "History list symbol to add minibuffer values to.\n\
2fa2413b
RS
2424Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2425is added with\n\
770970cb
RS
2426 (set minibuffer-history-variable\n\
2427 (cons STRING (symbol-value minibuffer-history-variable)))");
5a866662 2428 XSETFASTINT (Vminibuffer_history_variable, 0);
770970cb
RS
2429
2430 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2431 "Current position of redoing in the history list.");
2432 Vminibuffer_history_position = Qnil;
2433
6a9ee000 2434 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
e98bcc1a
RS
2435 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2436Some uses of the echo area also raise that frame (since they use it too).");
6a9ee000
RS
2437 minibuffer_auto_raise = 0;
2438
42006772
RS
2439 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2440 "List of regexps that should restrict possible completions.");
2441 Vcompletion_regexp_list = Qnil;
2442
c3421833
RS
2443 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2444 &minibuffer_allow_text_properties,
e9cccb71 2445 "Non-nil means `read-from-minibuffer' should not discard text properties.\n\
c3421833
RS
2446This also affects `read-string', but it does not affect `read-minibuffer',\n\
2447`read-no-blanks-input', or any of the functions that do minibuffer input\n\
2bfbde2b 2448with completion; they always discard text properties.");
c3421833
RS
2449 minibuffer_allow_text_properties = 0;
2450
cc64f5c9
MB
2451 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties,
2452 "Text properties that are added to minibuffer prompts.\n\
2453These are in addition to the basic `field' property, and stickiness\n\
2454properties.");
2455 /* We use `intern' here instead of Qread_only to avoid
2456 initialization-order problems. */
2457 Vminibuffer_prompt_properties
2458 = Fcons (intern ("read-only"), Fcons (Qt, Qnil));
2459
68313ed8 2460 defsubr (&Sset_minibuffer_window);
f927c5ae
JB
2461 defsubr (&Sread_from_minibuffer);
2462 defsubr (&Seval_minibuffer);
2463 defsubr (&Sread_minibuffer);
2464 defsubr (&Sread_string);
2465 defsubr (&Sread_command);
2466 defsubr (&Sread_variable);
2467 defsubr (&Sread_buffer);
2468 defsubr (&Sread_no_blanks_input);
2469 defsubr (&Sminibuffer_depth);
37e9a934 2470 defsubr (&Sminibuffer_prompt);
f927c5ae
JB
2471
2472 defsubr (&Stry_completion);
2473 defsubr (&Sall_completions);
2474 defsubr (&Scompleting_read);
2475 defsubr (&Sminibuffer_complete);
2476 defsubr (&Sminibuffer_complete_word);
2477 defsubr (&Sminibuffer_complete_and_exit);
2478 defsubr (&Sdisplay_completion_list);
2479 defsubr (&Sminibuffer_completion_help);
2480
2481 defsubr (&Sself_insert_and_exit);
2482 defsubr (&Sexit_minibuffer);
2483
2d955a50 2484 defsubr (&Sminibuffer_message);
f927c5ae
JB
2485}
2486
9d815fd9 2487void
f927c5ae
JB
2488keys_of_minibuf ()
2489{
2490 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2491 "abort-recursive-edit");
2492 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2493 "exit-minibuffer");
2494 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2495 "exit-minibuffer");
2496
2497 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
2498 "abort-recursive-edit");
2499 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
2500 "exit-minibuffer");
2501 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
2502 "exit-minibuffer");
2503
2504 initial_define_key (Vminibuffer_local_ns_map, ' ',
2505 "exit-minibuffer");
2506 initial_define_key (Vminibuffer_local_ns_map, '\t',
2507 "exit-minibuffer");
2508 initial_define_key (Vminibuffer_local_ns_map, '?',
2509 "self-insert-and-exit");
2510
2511 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
2512 "abort-recursive-edit");
2513 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
2514 "exit-minibuffer");
2515 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
2516 "exit-minibuffer");
2517
2518 initial_define_key (Vminibuffer_local_completion_map, '\t',
2519 "minibuffer-complete");
2520 initial_define_key (Vminibuffer_local_completion_map, ' ',
2521 "minibuffer-complete-word");
2522 initial_define_key (Vminibuffer_local_completion_map, '?',
2523 "minibuffer-completion-help");
2524
2525 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
2526 "abort-recursive-edit");
2527 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2528 "minibuffer-complete-and-exit");
2529 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2530 "minibuffer-complete-and-exit");
2531 initial_define_key (Vminibuffer_local_must_match_map, '\t',
2532 "minibuffer-complete");
2533 initial_define_key (Vminibuffer_local_must_match_map, ' ',
2534 "minibuffer-complete-word");
2535 initial_define_key (Vminibuffer_local_must_match_map, '?',
2536 "minibuffer-completion-help");
2537}