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