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