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