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