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