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