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