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