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