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