* net/browse-url.el (browse-url): Identify alist with "consp and
[bpt/emacs.git] / src / minibuf.c
CommitLineData
f927c5ae 1/* Minibuffer input and completion.
9ec0b715
GM
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
76b6f707 4 2008, 2009 Free Software Foundation, Inc.
f927c5ae
JB
5
6This file is part of GNU Emacs.
7
9ec0b715 8GNU Emacs is free software: you can redistribute it and/or modify
f927c5ae 9it under the terms of the GNU General Public License as published by
9ec0b715
GM
10the Free Software Foundation, either version 3 of the License, or
11(at your option) any later version.
f927c5ae
JB
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
9ec0b715 19along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
f927c5ae
JB
20
21
18160b98 22#include <config.h>
3f708f4c 23#include <stdio.h>
af52c32d 24
f927c5ae
JB
25#include "lisp.h"
26#include "commands.h"
27#include "buffer.h"
83be827a 28#include "character.h"
f927c5ae 29#include "dispextern.h"
2538fae4 30#include "keyboard.h"
ff11dfa1 31#include "frame.h"
f927c5ae
JB
32#include "window.h"
33#include "syntax.h"
0c21eeeb 34#include "intervals.h"
8feddab4 35#include "keymap.h"
fa971ac3 36#include "termhooks.h"
f927c5ae 37
a4e71d81
KH
38extern int quit_char;
39
f927c5ae 40/* List of buffers for use as minibuffers.
4d04c1f1
KH
41 The first element of the list is used for the outermost minibuffer
42 invocation, the next element is used for a recursive minibuffer
43 invocation, etc. The list is extended at the end as deeper
44 minibuffer recursions are encountered. */
279cf52c 45
f927c5ae
JB
46Lisp_Object Vminibuffer_list;
47
4d04c1f1 48/* Data to remember during recursive minibuffer invocations */
279cf52c 49
4d04c1f1 50Lisp_Object minibuf_save_list;
f927c5ae
JB
51
52/* Depth in minibuffer invocations. */
279cf52c 53
f927c5ae
JB
54int minibuf_level;
55
77aa8edf 56/* The maximum length of a minibuffer history. */
279cf52c 57
77aa8edf
RS
58Lisp_Object Qhistory_length, Vhistory_length;
59
0da4d471
JL
60/* No duplicates in history. */
61
62int history_delete_duplicates;
63
179a4ca7
JL
64/* Non-nil means add new input to history. */
65
66Lisp_Object Vhistory_add_new_input;
67
b278606c 68/* Fread_minibuffer leaves the input here as a string. */
279cf52c 69
f927c5ae
JB
70Lisp_Object last_minibuf_string;
71
9ab4a725 72/* Nonzero means let functions called when within a minibuffer
f927c5ae 73 invoke recursive minibuffers (to read arguments, or whatever) */
279cf52c 74
f927c5ae
JB
75int enable_recursive_minibuffers;
76
c3421833
RS
77/* Nonzero means don't ignore text properties
78 in Fread_from_minibuffer. */
279cf52c 79
c3421833
RS
80int minibuffer_allow_text_properties;
81
f927c5ae
JB
82/* help-form is bound to this while in the minibuffer. */
83
84Lisp_Object Vminibuffer_help_form;
85
770970cb
RS
86/* Variable which is the history list to add minibuffer values to. */
87
88Lisp_Object Vminibuffer_history_variable;
89
90/* Current position in the history list (adjusted by M-n and M-p). */
91
92Lisp_Object Vminibuffer_history_position;
93
cc64f5c9
MB
94/* Text properties that are added to minibuffer prompts.
95 These are in addition to the basic `field' property, and stickiness
96 properties. */
97
98Lisp_Object Vminibuffer_prompt_properties;
99
406e55df 100Lisp_Object Qminibuffer_history, Qbuffer_name_history;
770970cb 101
719b4a40
RS
102Lisp_Object Qread_file_name_internal;
103
177aecf9 104/* Normal hooks for entry to and exit from minibuffer. */
5c781212
RS
105
106Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
177aecf9 107Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
5c781212 108
eebbfb01 109/* Function to call to read a buffer name. */
9ab4a725 110Lisp_Object Vread_buffer_function;
eebbfb01 111
f927c5ae
JB
112/* Nonzero means completion ignores case. */
113
114int completion_ignore_case;
9fa5c213 115Lisp_Object Qcompletion_ignore_case;
33df281c 116int read_buffer_completion_ignore_case;
f927c5ae 117
42006772
RS
118/* List of regexps that should restrict possible completions. */
119
120Lisp_Object Vcompletion_regexp_list;
121
6a9ee000
RS
122/* Nonzero means raise the minibuffer frame when the minibuffer
123 is entered. */
124
125int minibuffer_auto_raise;
126
627fb581
RS
127/* Keymap for reading expressions. */
128Lisp_Object Vread_expression_map;
cee54539 129
3372a51b
RS
130Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
131Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
132Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
133Lisp_Object Vminibuffer_completing_file_name;
134
5744fa7c
RS
135Lisp_Object Quser_variable_p;
136
137Lisp_Object Qminibuffer_default;
138
cee54539
KH
139Lisp_Object Qcurrent_input_method, Qactivate_input_method;
140
6b61353c
KH
141Lisp_Object Qcase_fold_search;
142
627fb581
RS
143Lisp_Object Qread_expression_history;
144
145extern Lisp_Object Voverriding_local_map;
146
5744fa7c 147extern Lisp_Object Qmouse_face;
279cf52c 148
8e9968c6 149extern Lisp_Object Qfield;
f927c5ae 150\f
89fdc4a0
KH
151/* Put minibuf on currently selected frame's minibuffer.
152 We do this whenever the user starts a new minibuffer
153 or when a minibuffer exits. */
154
155void
156choose_minibuf_frame ()
157{
a4aafc54
GM
158 if (FRAMEP (selected_frame)
159 && FRAME_LIVE_P (XFRAME (selected_frame))
160 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
89fdc4a0 161 {
a4aafc54
GM
162 struct frame *sf = XFRAME (selected_frame);
163 Lisp_Object buffer;
9ab4a725 164
89fdc4a0
KH
165 /* I don't think that any frames may validly have a null minibuffer
166 window anymore. */
a4aafc54 167 if (NILP (sf->minibuffer_window))
89fdc4a0
KH
168 abort ();
169
a4aafc54
GM
170 /* Under X, we come here with minibuf_window being the
171 minibuffer window of the unused termcap window created in
172 init_window_once. That window doesn't have a buffer. */
173 buffer = XWINDOW (minibuf_window)->buffer;
174 if (BUFFERP (buffer))
cbbfe056 175 Fset_window_buffer (sf->minibuffer_window, buffer, Qnil);
a4aafc54 176 minibuf_window = sf->minibuffer_window;
89fdc4a0 177 }
914860c2
RS
178
179 /* Make sure no other frame has a minibuffer as its selected window,
180 because the text would not be displayed in it, and that would be
07d402c8
RS
181 confusing. Only allow the selected frame to do this,
182 and that only if the minibuffer is active. */
914860c2
RS
183 {
184 Lisp_Object tail, frame;
185
186 FOR_EACH_FRAME (tail, frame)
07d402c8 187 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
a4aafc54 188 && !(EQ (frame, selected_frame)
07d402c8 189 && minibuf_level > 0))
c8938ab6 190 Fset_frame_selected_window (frame, Fframe_first_window (frame), Qnil);
914860c2 191 }
89fdc4a0 192}
68313ed8 193
0c94f256
RS
194Lisp_Object
195choose_minibuf_frame_1 (ignore)
196 Lisp_Object ignore;
197{
198 choose_minibuf_frame ();
199 return Qnil;
200}
201
68313ed8
RS
202DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
203 Sset_minibuffer_window, 1, 1, 0,
af52c32d 204 doc: /* Specify which minibuffer window to use for the minibuffer.
6b61353c 205This affects where the minibuffer is displayed if you put text in it
af52c32d
MB
206without invoking the usual minibuffer commands. */)
207 (window)
68313ed8
RS
208 Lisp_Object window;
209{
b7826503 210 CHECK_WINDOW (window);
68313ed8
RS
211 if (! MINI_WINDOW_P (XWINDOW (window)))
212 error ("Window is not a minibuffer window");
213
214 minibuf_window = window;
215
216 return window;
217}
218
89fdc4a0 219\f
f927c5ae
JB
220/* Actual minibuffer invocation. */
221
af2b7cd5 222static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
7292839d 223static Lisp_Object run_exit_minibuf_hook P_ ((Lisp_Object));
af2b7cd5
RS
224static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
225 Lisp_Object, Lisp_Object,
226 int, Lisp_Object,
227 Lisp_Object, Lisp_Object,
b35cd215 228 int, int));
edfef199
GM
229static Lisp_Object read_minibuf_noninteractive P_ ((Lisp_Object, Lisp_Object,
230 Lisp_Object, Lisp_Object,
231 int, Lisp_Object,
232 Lisp_Object, Lisp_Object,
233 int, int));
234static Lisp_Object string_to_object P_ ((Lisp_Object, Lisp_Object));
235
236
237/* Read a Lisp object from VAL and return it. If VAL is an empty
238 string, and DEFALT is a string, read from DEFALT instead of VAL. */
239
240static Lisp_Object
241string_to_object (val, defalt)
242 Lisp_Object val, defalt;
243{
244 struct gcpro gcpro1, gcpro2;
245 Lisp_Object expr_and_pos;
246 int pos;
9ab4a725 247
edfef199 248 GCPRO2 (val, defalt);
9ab4a725 249
fb30dfd2
JL
250 if (STRINGP (val) && SCHARS (val) == 0)
251 {
252 if (STRINGP (defalt))
253 val = defalt;
254 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
255 val = XCAR (defalt);
256 }
9ab4a725 257
edfef199
GM
258 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
259 pos = XINT (Fcdr (expr_and_pos));
d5db4077 260 if (pos != SCHARS (val))
edfef199
GM
261 {
262 /* Ignore trailing whitespace; any other trailing junk
263 is an error. */
264 int i;
265 pos = string_char_to_byte (val, pos);
d5db4077 266 for (i = pos; i < SBYTES (val); i++)
edfef199 267 {
d5db4077 268 int c = SREF (val, i);
edfef199
GM
269 if (c != ' ' && c != '\t' && c != '\n')
270 error ("Trailing garbage following expression");
271 }
272 }
9ab4a725 273
edfef199
GM
274 val = Fcar (expr_and_pos);
275 RETURN_UNGCPRO (val);
276}
277
278
279/* Like read_minibuf but reading from stdin. This function is called
280 from read_minibuf to do the job if noninteractive. */
281
282static Lisp_Object
283read_minibuf_noninteractive (map, initial, prompt, backup_n, expflag,
284 histvar, histpos, defalt, allow_props,
285 inherit_input_method)
286 Lisp_Object map;
287 Lisp_Object initial;
288 Lisp_Object prompt;
289 Lisp_Object backup_n;
290 int expflag;
291 Lisp_Object histvar;
292 Lisp_Object histpos;
293 Lisp_Object defalt;
294 int allow_props;
295 int inherit_input_method;
296{
297 int size, len;
298 char *line, *s;
edfef199
GM
299 Lisp_Object val;
300
d5db4077 301 fprintf (stdout, "%s", SDATA (prompt));
edfef199
GM
302 fflush (stdout);
303
6bbd7a29 304 val = Qnil;
edfef199
GM
305 size = 100;
306 len = 0;
307 line = (char *) xmalloc (size * sizeof *line);
308 while ((s = fgets (line + len, size - len, stdin)) != NULL
309 && (len = strlen (line),
310 len == size - 1 && line[len - 1] != '\n'))
311 {
312 size *= 2;
313 line = (char *) xrealloc (line, size);
314 }
315
316 if (s)
317 {
318 len = strlen (line);
9ab4a725 319
edfef199
GM
320 if (len > 0 && line[len - 1] == '\n')
321 line[--len] = '\0';
9ab4a725 322
edfef199
GM
323 val = build_string (line);
324 xfree (line);
325 }
326 else
327 {
328 xfree (line);
329 error ("Error reading from stdin");
330 }
9ab4a725 331
edfef199
GM
332 /* If Lisp form desired instead of string, parse it. */
333 if (expflag)
fb30dfd2 334 val = string_to_object (val, CONSP (defalt) ? XCAR (defalt) : defalt);
9ab4a725 335
edfef199
GM
336 return val;
337}
1011edb5 338\f
873ef78e 339DEFUN ("minibufferp", Fminibufferp,
6d1b1d7b
JPW
340 Sminibufferp, 0, 1, 0,
341 doc: /* Return t if BUFFER is a minibuffer.
6b61353c
KH
342No argument or nil as argument means use current buffer as BUFFER.
343BUFFER can be a buffer or a buffer name. */)
6d1b1d7b
JPW
344 (buffer)
345 Lisp_Object buffer;
873ef78e
RS
346{
347 Lisp_Object tem;
348
6d1b1d7b
JPW
349 if (NILP (buffer))
350 buffer = Fcurrent_buffer ();
351 else if (STRINGP (buffer))
352 buffer = Fget_buffer (buffer);
353 else
354 CHECK_BUFFER (buffer);
355
356 tem = Fmemq (buffer, Vminibuffer_list);
873ef78e
RS
357 return ! NILP (tem) ? Qt : Qnil;
358}
359
a346ec72
MB
360DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
361 Sminibuffer_prompt_end, 0, 0, 0,
af52c32d 362 doc: /* Return the buffer position of the end of the minibuffer prompt.
eb7c9b64 363Return (point-min) if current buffer is not a minibuffer. */)
af52c32d 364 ()
a346ec72
MB
365{
366 /* This function is written to be most efficient when there's a prompt. */
873ef78e
RS
367 Lisp_Object beg, end, tem;
368 beg = make_number (BEGV);
369
370 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
371 if (NILP (tem))
372 return beg;
373
374 end = Ffield_end (beg, Qnil, Qnil);
9ab4a725 375
a346ec72 376 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
b056f36d 377 return beg;
a346ec72
MB
378 else
379 return end;
380}
381
382DEFUN ("minibuffer-contents", Fminibuffer_contents,
383 Sminibuffer_contents, 0, 0, 0,
029a305c 384 doc: /* Return the user input in a minibuffer as a string.
6cc62df0 385If the current buffer is not a minibuffer, return its entire contents. */)
af52c32d 386 ()
a346ec72
MB
387{
388 int prompt_end = XINT (Fminibuffer_prompt_end ());
389 return make_buffer_string (prompt_end, ZV, 1);
390}
391
392DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
393 Sminibuffer_contents_no_properties, 0, 0, 0,
029a305c 394 doc: /* Return the user input in a minibuffer as a string, without text-properties.
6cc62df0 395If the current buffer is not a minibuffer, return its entire contents. */)
af52c32d 396 ()
a346ec72
MB
397{
398 int prompt_end = XINT (Fminibuffer_prompt_end ());
399 return make_buffer_string (prompt_end, ZV, 0);
400}
401
b5e1e449
JL
402DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
403 Sminibuffer_completion_contents, 0, 0, 0,
404 doc: /* Return the user input in a minibuffer before point as a string.
405That is what completion commands operate on.
6cc62df0 406If the current buffer is not a minibuffer, return its entire contents. */)
b5e1e449
JL
407 ()
408{
409 int prompt_end = XINT (Fminibuffer_prompt_end ());
410 if (PT < prompt_end)
411 error ("Cannot do completion in the prompt");
412 return make_buffer_string (prompt_end, PT, 1);
413}
414
1011edb5 415\f
6b61353c
KH
416/* Read from the minibuffer using keymap MAP and initial contents INITIAL,
417 putting point minus BACKUP_N bytes from the end of INITIAL,
770970cb 418 prompting with PROMPT (a string), using history list HISTVAR
6b61353c
KH
419 with initial position HISTPOS. INITIAL should be a string or a
420 cons of a string and an integer. BACKUP_N should be <= 0, or
421 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
422 ignored and replaced with an integer that puts point at one-indexed
423 position N in INITIAL, where N is the CDR of INITIAL, or at the
424 beginning of INITIAL if N <= 0.
770970cb
RS
425
426 Normally return the result as a string (the text that was read),
3ab14176 427 but if EXPFLAG is nonzero, read it and return the object read.
b278606c
BF
428 If HISTVAR is given, save the value read on that history only if it doesn't
429 match the front of that history list exactly. The value is pushed onto
e5d4686b 430 the list as the string that was read.
770970cb 431
4f9f637a 432 DEFALT specifies the default value for the sake of history commands.
c3421833 433
cee54539
KH
434 If ALLOW_PROPS is nonzero, we do not throw away text properties.
435
6b61353c 436 if INHERIT_INPUT_METHOD is nonzero, the minibuffer inherits the
cee54539 437 current input method. */
e5d4686b
RS
438
439static Lisp_Object
440read_minibuf (map, initial, prompt, backup_n, expflag,
b35cd215 441 histvar, histpos, defalt, allow_props, inherit_input_method)
f927c5ae
JB
442 Lisp_Object map;
443 Lisp_Object initial;
444 Lisp_Object prompt;
5061d9c3 445 Lisp_Object backup_n;
f927c5ae 446 int expflag;
770970cb
RS
447 Lisp_Object histvar;
448 Lisp_Object histpos;
e5d4686b 449 Lisp_Object defalt;
af2b7cd5 450 int allow_props;
cee54539 451 int inherit_input_method;
f927c5ae 452{
00a34088 453 Lisp_Object val;
aed13378 454 int count = SPECPDL_INDEX ();
cee54539
KH
455 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
456 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
c75000c7 457 Lisp_Object enable_multibyte;
6b61353c 458 int pos = INTEGERP (backup_n) ? XINT (backup_n) : 0;
4f9f637a
RS
459 /* String to add to the history. */
460 Lisp_Object histstring;
461
b20de1cd
RS
462 Lisp_Object empty_minibuf;
463 Lisp_Object dummy, frame;
464
04012254 465 extern Lisp_Object Qfront_sticky;
fbd1209a 466 extern Lisp_Object Qrear_nonsticky;
00a34088 467
e5d4686b
RS
468 specbind (Qminibuffer_default, defalt);
469
ef72eaff
KS
470 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
471 in previous recursive minibuffer, but was not set explicitly
472 to t for this invocation, so set it to nil in this minibuffer.
473 Save the old value now, before we change it. */
474 specbind (intern ("minibuffer-completing-file-name"), Vminibuffer_completing_file_name);
475 if (EQ (Vminibuffer_completing_file_name, Qlambda))
476 Vminibuffer_completing_file_name = Qnil;
477
d148e14d 478#ifdef HAVE_WINDOW_SYSTEM
526a058f
GM
479 if (display_hourglass_p)
480 cancel_hourglass ();
e5baa1a7 481#endif
718d3251 482
6b61353c
KH
483 if (!NILP (initial))
484 {
485 if (CONSP (initial))
486 {
487 backup_n = Fcdr (initial);
488 initial = Fcar (initial);
489 CHECK_STRING (initial);
490 if (!NILP (backup_n))
491 {
492 CHECK_NUMBER (backup_n);
493 /* Convert to distance from end of input. */
494 if (XINT (backup_n) < 1)
495 /* A number too small means the beginning of the string. */
496 pos = - SCHARS (initial);
497 else
498 pos = XINT (backup_n) - 1 - SCHARS (initial);
499 }
500 }
501 else
502 CHECK_STRING (initial);
503 }
00a34088 504 val = Qnil;
57ceaa8a 505 ambient_dir = current_buffer->directory;
cee54539 506 input_method = Qnil;
c75000c7 507 enable_multibyte = Qnil;
57ceaa8a 508
00a34088
RS
509 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
510 store them away before we can GC. Don't need to protect
511 BACKUP_N because we use the value only if it is an integer. */
cee54539 512 GCPRO5 (map, initial, val, ambient_dir, input_method);
f927c5ae 513
7510b296 514 if (!STRINGP (prompt))
a2665596 515 prompt = empty_unibyte_string;
f927c5ae 516
f927c5ae 517 if (!enable_recursive_minibuffers
be15a518
RS
518 && minibuf_level > 0)
519 {
520 if (EQ (selected_window, minibuf_window))
521 error ("Command attempted to use minibuffer while in minibuffer");
522 else
523 /* If we're in another window, cancel the minibuffer that's active. */
524 Fthrow (Qexit,
525 build_string ("Command attempted to use minibuffer while in minibuffer"));
526 }
f927c5ae 527
a9051c88
DN
528 if ((noninteractive
529 /* In case we are running as a daemon, only do this before
530 detaching from the terminal. */
531 || (IS_DAEMON && (daemon_pipe[1] >= 0)))
532 && NILP (Vexecuting_kbd_macro))
c28b847b 533 {
6b61353c
KH
534 val = read_minibuf_noninteractive (map, initial, prompt,
535 make_number (pos),
c28b847b
GM
536 expflag, histvar, histpos, defalt,
537 allow_props, inherit_input_method);
f9b9ccef 538 UNGCPRO;
c28b847b
GM
539 return unbind_to (count, val);
540 }
edfef199 541
748dc60a 542 /* Choose the minibuffer window and frame, and take action on them. */
f927c5ae 543
c5b6b680
RS
544 choose_minibuf_frame ();
545
0c94f256
RS
546 record_unwind_protect (choose_minibuf_frame_1, Qnil);
547
f927c5ae 548 record_unwind_protect (Fset_window_configuration,
b2b2c677
JB
549 Fcurrent_window_configuration (Qnil));
550
ff11dfa1
JB
551 /* If the minibuffer window is on a different frame, save that
552 frame's configuration too. */
75f00e72 553 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
a4aafc54 554 if (!EQ (mini_frame, selected_frame))
5061d9c3
RS
555 record_unwind_protect (Fset_window_configuration,
556 Fcurrent_window_configuration (mini_frame));
5563e8e8
KH
557
558 /* If the minibuffer is on an iconified or invisible frame,
559 make it visible now. */
560 Fmake_frame_visible (mini_frame);
561
6a9ee000
RS
562 if (minibuffer_auto_raise)
563 Fraise_frame (mini_frame);
f927c5ae 564
b3e6f69c 565 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
256c9c3a 566
748dc60a
RS
567 /* We have to do this after saving the window configuration
568 since that is what restores the current buffer. */
569
570 /* Arrange to restore a number of minibuffer-related variables.
571 We could bind each variable separately, but that would use lots of
572 specpdl slots. */
573 minibuf_save_list
574 = Fcons (Voverriding_local_map,
3372a51b 575 Fcons (minibuf_window,
ef72eaff 576 minibuf_save_list));
748dc60a
RS
577 minibuf_save_list
578 = Fcons (minibuf_prompt,
579 Fcons (make_number (minibuf_prompt_width),
580 Fcons (Vhelp_form,
581 Fcons (Vcurrent_prefix_arg,
582 Fcons (Vminibuffer_history_position,
583 Fcons (Vminibuffer_history_variable,
584 minibuf_save_list))))));
585
586 record_unwind_protect (read_minibuf_unwind, Qnil);
587 minibuf_level++;
7292839d
SM
588 /* We are exiting the minibuffer one way or the other, so run the hook.
589 It should be run before unwinding the minibuf settings. Do it
590 separately from read_minibuf_unwind because we need to make sure that
591 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
592 signals an error. --Stef */
593 record_unwind_protect (run_exit_minibuf_hook, Qnil);
748dc60a
RS
594
595 /* Now that we can restore all those variables, start changing them. */
596
1e3f16d5 597 minibuf_prompt_width = 0;
748dc60a
RS
598 minibuf_prompt = Fcopy_sequence (prompt);
599 Vminibuffer_history_position = histpos;
600 Vminibuffer_history_variable = histvar;
601 Vhelp_form = Vminibuffer_help_form;
ef72eaff
KS
602 /* If this minibuffer is reading a file name, that doesn't mean
603 recursive ones are. But we cannot set it to nil, because
604 completion code still need to know the minibuffer is completing a
605 file name. So use `lambda' as intermediate value meaning
606 "t" in this minibuffer, but "nil" in next minibuffer. */
607 if (!NILP (Vminibuffer_completing_file_name))
608 Vminibuffer_completing_file_name = Qlambda;
748dc60a 609
cee54539 610 if (inherit_input_method)
c75000c7 611 {
fd771ceb 612 /* `current-input-method' is buffer local. So, remember it in
c75000c7
RS
613 INPUT_METHOD before changing the current buffer. */
614 input_method = Fsymbol_value (Qcurrent_input_method);
615 enable_multibyte = current_buffer->enable_multibyte_characters;
616 }
cee54539 617
748dc60a
RS
618 /* Switch to the minibuffer. */
619
4f69d8f6
RS
620 minibuffer = get_minibuffer (minibuf_level);
621 Fset_buffer (minibuffer);
64a3a3c0 622
1d69c502
RS
623 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
624 if (inherit_input_method)
625 current_buffer->enable_multibyte_characters = enable_multibyte;
626
64a3a3c0
JB
627 /* The current buffer's default directory is usually the right thing
628 for our minibuffer here. However, if you're typing a command at
629 a minibuffer-only frame when minibuf_level is zero, then buf IS
630 the current_buffer, so reset_buffer leaves buf's default
631 directory unchanged. This is a bummer when you've just started
632 up Emacs and buf's default directory is Qnil. Here's a hack; can
633 you think of something better to do? Find another buffer with a
634 better directory, and use that one instead. */
748dc60a
RS
635 if (STRINGP (ambient_dir))
636 current_buffer->directory = ambient_dir;
64a3a3c0
JB
637 else
638 {
639 Lisp_Object buf_list;
640
641 for (buf_list = Vbuffer_alist;
642 CONSP (buf_list);
7539e11f 643 buf_list = XCDR (buf_list))
64a3a3c0 644 {
1e62748e 645 Lisp_Object other_buf;
64a3a3c0 646
7539e11f 647 other_buf = XCDR (XCAR (buf_list));
7510b296 648 if (STRINGP (XBUFFER (other_buf)->directory))
64a3a3c0
JB
649 {
650 current_buffer->directory = XBUFFER (other_buf)->directory;
651 break;
652 }
653 }
654 }
655
a4aafc54
GM
656 if (!EQ (mini_frame, selected_frame))
657 Fredirect_frame_focus (selected_frame, mini_frame);
43bad991 658
f927c5ae 659 Vminibuf_scroll_window = selected_window;
6122844a 660 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
5705966b 661 minibuf_selected_window = selected_window;
b20de1cd
RS
662
663 /* Empty out the minibuffers of all frames other than the one
664 where we are going to display one now.
665 Set them to point to ` *Minibuf-0*', which is always empty. */
666 empty_minibuf = Fget_buffer (build_string (" *Minibuf-0*"));
667
668 FOR_EACH_FRAME (dummy, frame)
669 {
670 Lisp_Object root_window = Fframe_root_window (frame);
671 Lisp_Object mini_window = XWINDOW (root_window)->next;
672
dd95745a
RS
673 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
674 && !NILP (Fwindow_minibuffer_p (mini_window)))
b20de1cd
RS
675 Fset_window_buffer (mini_window, empty_minibuf, Qnil);
676 }
677
678 /* Display this minibuffer in the proper window. */
cbbfe056 679 Fset_window_buffer (minibuf_window, Fcurrent_buffer (), Qnil);
f1321dc3 680 Fselect_window (minibuf_window, Qnil);
5a866662 681 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
f927c5ae 682
748dc60a
RS
683 Fmake_local_variable (Qprint_escape_newlines);
684 print_escape_newlines = 1;
685
686 /* Erase the buffer. */
59115a22 687 {
331379bf 688 int count1 = SPECPDL_INDEX ();
59115a22 689 specbind (Qinhibit_read_only, Qt);
a41edd99 690 specbind (Qinhibit_modification_hooks, Qt);
59115a22 691 Ferase_buffer ();
d9d7b298
SM
692
693 if (!NILP (current_buffer->enable_multibyte_characters)
694 && ! STRING_MULTIBYTE (minibuf_prompt))
695 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
6cc62df0 696
d9d7b298
SM
697 /* Insert the prompt, record where it ends. */
698 Finsert (1, &minibuf_prompt);
699 if (PT > BEG)
700 {
701 Fput_text_property (make_number (BEG), make_number (PT),
702 Qfront_sticky, Qt, Qnil);
703 Fput_text_property (make_number (BEG), make_number (PT),
704 Qrear_nonsticky, Qt, Qnil);
705 Fput_text_property (make_number (BEG), make_number (PT),
706 Qfield, Qt, Qnil);
707 Fadd_text_properties (make_number (BEG), make_number (PT),
708 Vminibuffer_prompt_properties, Qnil);
709 }
59115a22
RS
710 unbind_to (count1, Qnil);
711 }
712
9ab4a725
TTN
713 minibuf_prompt_width = (int) current_column (); /* iftc */
714
748dc60a 715 /* Put in the initial input. */
56a98455 716 if (!NILP (initial))
f927c5ae
JB
717 {
718 Finsert (1, &initial);
6b61353c 719 Fforward_char (make_number (pos));
f927c5ae
JB
720 }
721
39e98b38 722 clear_message (1, 1);
f927c5ae
JB
723 current_buffer->keymap = map;
724
cee54539 725 /* Turn on an input method stored in INPUT_METHOD if any. */
6801b300 726 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
cee54539
KH
727 call1 (Qactivate_input_method, input_method);
728
5c781212
RS
729 /* Run our hook, but not if it is empty.
730 (run-hooks would do nothing if it is empty,
fd771ceb 731 but it's important to save time here in the usual case.) */
92d3b06e
RS
732 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
733 && !NILP (Vrun_hooks))
5c781212
RS
734 call1 (Vrun_hooks, Qminibuffer_setup_hook);
735
4e6b7204
MB
736 /* Don't allow the user to undo past this point. */
737 current_buffer->undo_list = Qnil;
738
f927c5ae
JB
739 recursive_edit_1 ();
740
741 /* If cursor is on the minibuffer line,
742 show the user we have exited by putting it in column 0. */
279cf52c 743 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
f927c5ae
JB
744 && !noninteractive)
745 {
279cf52c
GM
746 XWINDOW (minibuf_window)->cursor.hpos = 0;
747 XWINDOW (minibuf_window)->cursor.x = 0;
748 XWINDOW (minibuf_window)->must_be_updated_p = 1;
a4aafc54 749 update_frame (XFRAME (selected_frame), 1, 1);
fa971ac3
KL
750 {
751 struct frame *f = XFRAME (XWINDOW (minibuf_window)->frame);
752 struct redisplay_interface *rif = FRAME_RIF (f);
753 if (rif && rif->flush_display)
754 rif->flush_display (f);
755 }
f927c5ae
JB
756 }
757
c3421833 758 /* Make minibuffer contents into a string. */
4f69d8f6 759 Fset_buffer (minibuffer);
be95a9b6 760 if (allow_props)
a346ec72 761 val = Fminibuffer_contents ();
be95a9b6 762 else
a346ec72 763 val = Fminibuffer_contents_no_properties ();
770970cb 764
b278606c 765 /* VAL is the string of minibuffer text. */
7019cca7 766
b278606c
BF
767 last_minibuf_string = val;
768
4f9f637a 769 /* Choose the string to add to the history. */
b35cd215 770 if (SCHARS (val) != 0)
4f9f637a
RS
771 histstring = val;
772 else if (STRINGP (defalt))
773 histstring = defalt;
fb30dfd2
JL
774 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
775 histstring = XCAR (defalt);
4f9f637a
RS
776 else
777 histstring = Qnil;
778
779 /* Add the value to the appropriate history list, if any. */
179a4ca7
JL
780 if (!NILP (Vhistory_add_new_input)
781 && SYMBOLP (Vminibuffer_history_variable)
4f9f637a 782 && !NILP (histstring))
3ab14176
KH
783 {
784 /* If the caller wanted to save the value read on a history list,
785 then do so if the value is not already the front of the list. */
786 Lisp_Object histval;
c6d65724
RS
787
788 /* If variable is unbound, make it nil. */
c6d65724 789
8c2dccbf
SM
790 histval = find_symbol_value (Vminibuffer_history_variable);
791 if (EQ (histval, Qunbound))
792 Fset (Vminibuffer_history_variable, Qnil);
3ab14176
KH
793
794 /* The value of the history variable must be a cons or nil. Other
795 values are unacceptable. We silently ignore these values. */
4f9f637a 796
3ab14176 797 if (NILP (histval)
9f6131cf 798 || (CONSP (histval)
4f9f637a 799 /* Don't duplicate the most recent entry in the history. */
b35cd215 800 && (NILP (Fequal (histstring, Fcar (histval))))))
77aa8edf
RS
801 {
802 Lisp_Object length;
803
0da4d471 804 if (history_delete_duplicates) Fdelete (histstring, histval);
4f9f637a 805 histval = Fcons (histstring, histval);
77aa8edf
RS
806 Fset (Vminibuffer_history_variable, histval);
807
808 /* Truncate if requested. */
809 length = Fget (Vminibuffer_history_variable, Qhistory_length);
810 if (NILP (length)) length = Vhistory_length;
e5d4686b
RS
811 if (INTEGERP (length))
812 {
813 if (XINT (length) <= 0)
814 Fset (Vminibuffer_history_variable, Qnil);
815 else
816 {
817 Lisp_Object temp;
818
819 temp = Fnthcdr (Fsub1 (length), histval);
820 if (CONSP (temp)) Fsetcdr (temp, Qnil);
821 }
822 }
77aa8edf 823 }
9f6131cf
RS
824 }
825
826 /* If Lisp form desired instead of string, parse it. */
827 if (expflag)
edfef199 828 val = string_to_object (val, defalt);
3ab14176 829
00a34088
RS
830 /* The appropriate frame will get selected
831 in set-window-configuration. */
f9b9ccef
SM
832 UNGCPRO;
833 return unbind_to (count, val);
f927c5ae
JB
834}
835
836/* Return a buffer to be used as the minibuffer at depth `depth'.
837 depth = 0 is the lowest allowed argument, and that is the value
838 used for nonrecursive minibuffer invocations */
839
840Lisp_Object
841get_minibuffer (depth)
842 int depth;
843{
844 Lisp_Object tail, num, buf;
9f6c23bc 845 char name[24];
f927c5ae
JB
846 extern Lisp_Object nconc2 ();
847
5a866662 848 XSETFASTINT (num, depth);
f927c5ae 849 tail = Fnthcdr (num, Vminibuffer_list);
56a98455 850 if (NILP (tail))
f927c5ae
JB
851 {
852 tail = Fcons (Qnil, Qnil);
853 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
854 }
855 buf = Fcar (tail);
56a98455 856 if (NILP (buf) || NILP (XBUFFER (buf)->name))
f927c5ae
JB
857 {
858 sprintf (name, " *Minibuf-%d*", depth);
859 buf = Fget_buffer_create (build_string (name));
5d6533f1
JB
860
861 /* Although the buffer's name starts with a space, undo should be
862 enabled in it. */
863 Fbuffer_enable_undo (buf);
864
f3fbd155 865 XSETCAR (tail, buf);
f927c5ae
JB
866 }
867 else
5956f71d 868 {
aed13378 869 int count = SPECPDL_INDEX ();
7f856567
SM
870 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
871 have to empty the list, otherwise we end up with overlays that
872 think they belong to this buffer while the buffer doesn't know about
873 them any more. */
599ca9c2
SM
874 delete_all_overlays (XBUFFER (buf));
875 reset_buffer (XBUFFER (buf));
6b3faad8
RS
876 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
877 Fset_buffer (buf);
878 Fkill_all_local_variables ();
879 unbind_to (count, Qnil);
5956f71d 880 }
64a3a3c0 881
f927c5ae
JB
882 return buf;
883}
884
7292839d
SM
885static Lisp_Object
886run_exit_minibuf_hook (data)
887 Lisp_Object data;
888{
889 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
890 && !NILP (Vrun_hooks))
891 safe_run_hooks (Qminibuffer_exit_hook);
892
893 return Qnil;
894}
895
279cf52c
GM
896/* This function is called on exiting minibuffer, whether normally or
897 not, and it restores the current window, buffer, etc. */
f927c5ae 898
9d815fd9 899static Lisp_Object
43bad991
JB
900read_minibuf_unwind (data)
901 Lisp_Object data;
f927c5ae 902{
c24e1160 903 Lisp_Object old_deactivate_mark;
59115a22 904 Lisp_Object window;
c24e1160 905
f927c5ae 906 /* If this was a recursive minibuffer,
59115a22 907 tie the minibuffer window back to the outer level minibuffer buffer. */
f927c5ae 908 minibuf_level--;
f927c5ae 909
59115a22 910 window = minibuf_window;
279cf52c
GM
911 /* To keep things predictable, in case it matters, let's be in the
912 minibuffer when we reset the relevant variables. */
59115a22
RS
913 Fset_buffer (XWINDOW (window)->buffer);
914
915 /* Restore prompt, etc, from outer minibuffer level. */
4d04c1f1
KH
916 minibuf_prompt = Fcar (minibuf_save_list);
917 minibuf_save_list = Fcdr (minibuf_save_list);
918 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
919 minibuf_save_list = Fcdr (minibuf_save_list);
920 Vhelp_form = Fcar (minibuf_save_list);
921 minibuf_save_list = Fcdr (minibuf_save_list);
ee9e37ab 922 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
4d04c1f1
KH
923 minibuf_save_list = Fcdr (minibuf_save_list);
924 Vminibuffer_history_position = Fcar (minibuf_save_list);
925 minibuf_save_list = Fcdr (minibuf_save_list);
926 Vminibuffer_history_variable = Fcar (minibuf_save_list);
927 minibuf_save_list = Fcdr (minibuf_save_list);
30e13e56 928 Voverriding_local_map = Fcar (minibuf_save_list);
c5b6b680 929 minibuf_save_list = Fcdr (minibuf_save_list);
914860c2
RS
930#if 0
931 temp = Fcar (minibuf_save_list);
932 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
933 minibuf_window = temp;
934#endif
30e13e56 935 minibuf_save_list = Fcdr (minibuf_save_list);
59115a22
RS
936
937 /* Erase the minibuffer we were using at this level. */
938 {
aed13378 939 int count = SPECPDL_INDEX ();
59115a22
RS
940 /* Prevent error in erase-buffer. */
941 specbind (Qinhibit_read_only, Qt);
bd819d14 942 specbind (Qinhibit_modification_hooks, Qt);
59115a22
RS
943 old_deactivate_mark = Vdeactivate_mark;
944 Ferase_buffer ();
945 Vdeactivate_mark = old_deactivate_mark;
946 unbind_to (count, Qnil);
947 }
948
544e358d
GM
949 /* When we get to the outmost level, make sure we resize the
950 mini-window back to its normal size. */
951 if (minibuf_level == 0)
1e3f16d5 952 resize_mini_window (XWINDOW (window), 0);
544e358d 953
59115a22
RS
954 /* Make sure minibuffer window is erased, not ignored. */
955 windows_or_buffers_changed++;
956 XSETFASTINT (XWINDOW (window)->last_modified, 0);
193e4518 957 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
9d815fd9 958 return Qnil;
f927c5ae
JB
959}
960\f
b9d721de 961
b35cd215 962DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
af52c32d 963 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
6b61353c
KH
964The optional second arg INITIAL-CONTENTS is an obsolete alternative to
965 DEFAULT-VALUE. It normally should be nil in new code, except when
966 HIST is a cons. It is discussed in more detail below.
a1f17501
PJ
967Third arg KEYMAP is a keymap to use whilst reading;
968 if omitted or nil, the default is `minibuffer-local-map'.
fd771ceb 969If fourth arg READ is non-nil, then interpret the result as a Lisp object
a1f17501
PJ
970 and return that object:
971 in other words, do `(car (read-from-string INPUT-STRING))'
6b61353c
KH
972Fifth arg HIST, if non-nil, specifies a history list and optionally
973 the initial position in the list. It can be a symbol, which is the
974 history list variable to use, or it can be a cons cell
975 (HISTVAR . HISTPOS). In that case, HISTVAR is the history list variable
976 to use, and HISTPOS is the initial position for use by the minibuffer
977 history commands. For consistency, you should also specify that
978 element of the history as the value of INITIAL-CONTENTS. Positions
979 are counted starting from 1 at the beginning of the list.
2e3148e2
JL
980Sixth arg DEFAULT-VALUE is the default value or the list of default values.
981 If non-nil, it is available for history commands, and as the value
982 (or the first element of the list of default values) to return
983 if the user enters the empty string. But, unless READ is non-nil,
984 `read-from-minibuffer' does NOT return DEFAULT-VALUE if the user enters
985 empty input! It returns the empty string.
a1f17501 986Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
029a305c 987 the current input method and the setting of `enable-multibyte-characters'.
a1f17501
PJ
988If the variable `minibuffer-allow-text-properties' is non-nil,
989 then the string which is returned includes whatever text properties
6b61353c
KH
990 were present in the minibuffer. Otherwise the value has no text properties.
991
992The remainder of this documentation string describes the
993INITIAL-CONTENTS argument in more detail. It is only relevant when
994studying existing code, or when HIST is a cons. If non-nil,
995INITIAL-CONTENTS is a string to be inserted into the minibuffer before
996reading input. Normally, point is put at the end of that string.
997However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
998input is STRING, but point is placed at _one-indexed_ position
999POSITION in the minibuffer. Any integer value less than or equal to
1000one puts point at the beginning of the string. *Note* that this
1001behavior differs from the way such arguments are used in `completing-read'
1002and some related functions, which use zero-indexing for POSITION. */)
4bafae49 1003 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
e5d4686b 1004 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
b35cd215 1005 Lisp_Object inherit_input_method;
f927c5ae 1006{
6b61353c 1007 Lisp_Object histvar, histpos, val;
1d8d92f4
RS
1008 struct gcpro gcpro1;
1009
b7826503 1010 CHECK_STRING (prompt);
56a98455 1011 if (NILP (keymap))
f927c5ae
JB
1012 keymap = Vminibuffer_local_map;
1013 else
02067692 1014 keymap = get_keymap (keymap, 1, 0);
770970cb 1015
7510b296 1016 if (SYMBOLP (hist))
770970cb
RS
1017 {
1018 histvar = hist;
1019 histpos = Qnil;
1020 }
1021 else
1022 {
1023 histvar = Fcar_safe (hist);
1024 histpos = Fcdr_safe (hist);
1025 }
1026 if (NILP (histvar))
1027 histvar = Qminibuffer_history;
1028 if (NILP (histpos))
5a866662 1029 XSETFASTINT (histpos, 0);
770970cb 1030
1d8d92f4 1031 GCPRO1 (default_value);
e5d4686b 1032 val = read_minibuf (keymap, initial_contents, prompt,
6b61353c 1033 Qnil, !NILP (read),
c3421833 1034 histvar, histpos, default_value,
cee54539 1035 minibuffer_allow_text_properties,
b35cd215 1036 !NILP (inherit_input_method));
1d8d92f4 1037 UNGCPRO;
e5d4686b 1038 return val;
f927c5ae
JB
1039}
1040
1041DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
6b61353c 1042 doc: /* Return a Lisp object read using the minibuffer, unevaluated.
a1f17501 1043Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
6b61353c 1044is a string to insert in the minibuffer before reading.
e298936f
JB
1045\(INITIAL-CONTENTS can also be a cons of a string and an integer.
1046Such arguments are used as in `read-from-minibuffer'.) */)
af52c32d 1047 (prompt, initial_contents)
f927c5ae
JB
1048 Lisp_Object prompt, initial_contents;
1049{
b7826503 1050 CHECK_STRING (prompt);
770970cb 1051 return read_minibuf (Vminibuffer_local_map, initial_contents,
e5d4686b 1052 prompt, Qnil, 1, Qminibuffer_history,
b35cd215 1053 make_number (0), Qnil, 0, 0);
f927c5ae
JB
1054}
1055
1056DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
af52c32d 1057 doc: /* Return value of Lisp expression read using the minibuffer.
a1f17501 1058Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
6b61353c 1059is a string to insert in the minibuffer before reading.
e298936f
JB
1060\(INITIAL-CONTENTS can also be a cons of a string and an integer.
1061Such arguments are used as in `read-from-minibuffer'.) */)
af52c32d 1062 (prompt, initial_contents)
f927c5ae
JB
1063 Lisp_Object prompt, initial_contents;
1064{
627fb581
RS
1065 return Feval (read_minibuf (Vread_expression_map, initial_contents,
1066 prompt, Qnil, 1, Qread_expression_history,
1067 make_number (0), Qnil, 0, 0));
f927c5ae
JB
1068}
1069
1070/* Functions that use the minibuffer to read various things. */
1071
cee54539 1072DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
af52c32d 1073 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
a1f17501 1074If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
6b61353c
KH
1075 This argument has been superseded by DEFAULT-VALUE and should normally
1076 be nil in new code. It behaves as in `read-from-minibuffer'. See the
1077 documentation string of that function for details.
a1f17501
PJ
1078The third arg HISTORY, if non-nil, specifies a history list
1079 and optionally the initial position in the list.
1080See `read-from-minibuffer' for details of HISTORY argument.
2e3148e2
JL
1081Fourth arg DEFAULT-VALUE is the default value or the list of default values.
1082 If non-nil, it is used for history commands, and as the value (or the first
1083 element of the list of default values) to return if the user enters the
1084 empty string.
a1f17501 1085Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
029a305c 1086 the current input method and the setting of `enable-multibyte-characters'. */)
af52c32d 1087 (prompt, initial_input, history, default_value, inherit_input_method)
e5d4686b 1088 Lisp_Object prompt, initial_input, history, default_value;
cee54539 1089 Lisp_Object inherit_input_method;
f927c5ae 1090{
b9a86585
RS
1091 Lisp_Object val;
1092 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
1093 Qnil, history, default_value,
b35cd215 1094 inherit_input_method);
d5db4077 1095 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
fb30dfd2 1096 val = CONSP (default_value) ? XCAR (default_value) : default_value;
b9a86585 1097 return val;
f927c5ae
JB
1098}
1099
cee54539 1100DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
af52c32d 1101 doc: /* Read a string from the terminal, not allowing blanks.
6b61353c
KH
1102Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1103non-nil, it should be a string, which is used as initial input, with
1104point positioned at the end, so that SPACE will accept the input.
1105\(Actually, INITIAL can also be a cons of a string and an integer.
1106Such values are treated as in `read-from-minibuffer', but are normally
1107not useful in this function.)
a1f17501 1108Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
6b61353c 1109the current input method and the setting of`enable-multibyte-characters'. */)
af52c32d 1110 (prompt, initial, inherit_input_method)
c923ccc9 1111 Lisp_Object prompt, initial, inherit_input_method;
f927c5ae 1112{
b7826503 1113 CHECK_STRING (prompt);
c923ccc9 1114 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
cee54539 1115 0, Qminibuffer_history, make_number (0), Qnil, 0,
b35cd215 1116 !NILP (inherit_input_method));
f927c5ae
JB
1117}
1118
e5d4686b 1119DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
af52c32d 1120 doc: /* Read the name of a command and return as a symbol.
2e3148e2
JL
1121Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1122if it is a list. */)
af52c32d 1123 (prompt, default_value)
e5d4686b 1124 Lisp_Object prompt, default_value;
f927c5ae 1125{
7c8d9931
RS
1126 Lisp_Object name, default_string;
1127
1128 if (NILP (default_value))
1129 default_string = Qnil;
1130 else if (SYMBOLP (default_value))
caa4733e 1131 default_string = SYMBOL_NAME (default_value);
7c8d9931
RS
1132 else
1133 default_string = default_value;
9ab4a725 1134
7c8d9931
RS
1135 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1136 Qnil, Qnil, default_string, Qnil);
1137 if (NILP (name))
1138 return name;
1139 return Fintern (name, Qnil);
f927c5ae
JB
1140}
1141
1142#ifdef NOTDEF
1143DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
af52c32d 1144 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
fd771ceb 1145Prompt with PROMPT. */)
af52c32d 1146 (prompt)
f927c5ae
JB
1147 Lisp_Object prompt;
1148{
cee54539 1149 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
f927c5ae
JB
1150 Qnil);
1151}
1152#endif /* NOTDEF */
1153
e5d4686b 1154DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
af52c32d 1155 doc: /* Read the name of a user variable and return it as a symbol.
2e3148e2
JL
1156Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1157if it is a list.
316f9bfc 1158A user variable is one for which `user-variable-p' returns non-nil. */)
af52c32d 1159 (prompt, default_value)
e5d4686b 1160 Lisp_Object prompt, default_value;
f927c5ae 1161{
7c8d9931
RS
1162 Lisp_Object name, default_string;
1163
1164 if (NILP (default_value))
1165 default_string = Qnil;
1166 else if (SYMBOLP (default_value))
caa4733e 1167 default_string = SYMBOL_NAME (default_value);
7c8d9931
RS
1168 else
1169 default_string = default_value;
9ab4a725 1170
7c8d9931
RS
1171 name = Fcompleting_read (prompt, Vobarray,
1172 Quser_variable_p, Qt,
1173 Qnil, Qnil, default_string, Qnil);
1174 if (NILP (name))
1175 return name;
1176 return Fintern (name, Qnil);
f927c5ae
JB
1177}
1178
1179DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
fd771ceb
PJ
1180 doc: /* Read the name of a buffer and return as a string.
1181Prompt with PROMPT.
a1f17501 1182Optional second arg DEF is value to return if user enters an empty line.
2e3148e2 1183 If DEF is a list of default values, return its first element.
5fedada7
CY
1184Optional third arg REQUIRE-MATCH determines whether non-existing
1185 buffer names are allowed. It has the same meaning as the
1186 REQUIRE-MATCH argument of `confirm-after-completion'.
33df281c
CY
1187The argument PROMPT should be a string ending with a colon and a space.
1188If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1189case while reading the buffer name.
1190If `read-buffer-function' is non-nil, this works by calling it as a
1191function, instead of the usual behavior. */)
af52c32d 1192 (prompt, def, require_match)
f927c5ae
JB
1193 Lisp_Object prompt, def, require_match;
1194{
33df281c 1195 Lisp_Object args[4], result;
97c3e4cc
RF
1196 unsigned char *s;
1197 int len;
33df281c 1198 int count = SPECPDL_INDEX ();
9ab4a725 1199
7510b296 1200 if (BUFFERP (def))
f927c5ae 1201 def = XBUFFER (def)->name;
eebbfb01 1202
33df281c
CY
1203 specbind (Qcompletion_ignore_case,
1204 read_buffer_completion_ignore_case ? Qt : Qnil);
1205
eebbfb01
KH
1206 if (NILP (Vread_buffer_function))
1207 {
1208 if (!NILP (def))
1209 {
97c3e4cc
RF
1210 /* A default value was provided: we must change PROMPT,
1211 editing the default value in before the colon. To achieve
1212 this, we replace PROMPT with a substring that doesn't
1213 contain the terminal space and colon (if present). They
1214 are then added back using Fformat. */
1215
1216 if (STRINGP (prompt))
1217 {
1218 s = SDATA (prompt);
1219 len = strlen (s);
1220 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1221 len = len - 2;
1222 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1223 len--;
1224
1225 prompt = make_specified_string (s, -1, len,
1226 STRING_MULTIBYTE (prompt));
1227 }
1228
1229 args[0] = build_string ("%s (default %s): ");
eebbfb01 1230 args[1] = prompt;
fb30dfd2 1231 args[2] = CONSP (def) ? XCAR (def) : def;
eebbfb01
KH
1232 prompt = Fformat (3, args);
1233 }
1234
33df281c
CY
1235 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1236 Qnil, require_match, Qnil, Qbuffer_name_history,
1237 def, Qnil);
eebbfb01
KH
1238 }
1239 else
f927c5ae 1240 {
eebbfb01 1241 args[0] = Vread_buffer_function;
f927c5ae
JB
1242 args[1] = prompt;
1243 args[2] = def;
eebbfb01 1244 args[3] = require_match;
33df281c 1245 result = Ffuncall(4, args);
f927c5ae 1246 }
33df281c 1247 return unbind_to (count, result);
f927c5ae
JB
1248}
1249\f
ec067ec7
RS
1250static Lisp_Object
1251minibuf_conform_representation (string, basis)
1252 Lisp_Object string, basis;
1253{
1254 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1255 return string;
1256
1257 if (STRING_MULTIBYTE (string))
1258 return Fstring_make_unibyte (string);
1259 else
1260 return Fstring_make_multibyte (string);
1261}
1262
f927c5ae 1263DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
a284cdbb
RS
1264 doc: /* Return common substring of all completions of STRING in COLLECTION.
1265Test each possible completion specified by COLLECTION
1266to see if it begins with STRING. The possible completions may be
3809648a
KS
1267strings or symbols. Symbols are converted to strings before testing,
1268see `symbol-name'.
a284cdbb
RS
1269All that match STRING are compared together; the longest initial sequence
1270common to all these matches is the return value.
1271If there is no match at all, the return value is nil.
1272For a unique match which is exact, the return value is t.
1273
1274If COLLECTION is an alist, the keys (cars of elements) are the
1275possible completions. If an element is not a cons cell, then the
1276element itself is the possible completion.
1277If COLLECTION is a hash-table, all the keys that are strings or symbols
1278are the possible completions.
1279If COLLECTION is an obarray, the names of all symbols in the obarray
1280are the possible completions.
1281
1282COLLECTION can also be a function to do the completion itself.
a1f17501
PJ
1283It receives three arguments: the values STRING, PREDICATE and nil.
1284Whatever it returns becomes the value of `try-completion'.
1285
1286If optional third argument PREDICATE is non-nil,
1287it is used to test each possible match.
1288The match is a candidate only if PREDICATE returns non-nil.
1289The argument given to PREDICATE is the alist element
a284cdbb 1290or the symbol from the obarray. If COLLECTION is a hash-table,
85cd4372 1291predicate is called with two arguments: the key and the value.
a1f17501 1292Additionally to this predicate, `completion-regexp-list'
af52c32d 1293is used to further constrain the set of candidates. */)
a284cdbb
RS
1294 (string, collection, predicate)
1295 Lisp_Object string, collection, predicate;
f927c5ae
JB
1296{
1297 Lisp_Object bestmatch, tail, elt, eltstring;
af2b7cd5 1298 /* Size in bytes of BESTMATCH. */
6bbd7a29 1299 int bestmatchsize = 0;
af2b7cd5 1300 /* These are in bytes, too. */
f927c5ae 1301 int compare, matchsize;
f6d4c7a4
RS
1302 enum { function_table, list_table, obarray_table, hash_table}
1303 type = (HASH_TABLE_P (collection) ? hash_table
1304 : VECTORP (collection) ? obarray_table
1305 : ((NILP (collection)
1306 || (CONSP (collection)
1307 && (!SYMBOLP (XCAR (collection))
1308 || NILP (XCAR (collection)))))
1309 ? list_table : function_table));
6bbd7a29 1310 int index = 0, obsize = 0;
f927c5ae 1311 int matchcount = 0;
acd81db9 1312 int bindcount = -1;
f927c5ae
JB
1313 Lisp_Object bucket, zero, end, tem;
1314 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1315
b7826503 1316 CHECK_STRING (string);
f6d4c7a4 1317 if (type == function_table)
a284cdbb 1318 return call3 (collection, string, predicate, Qnil);
f927c5ae 1319
6bbd7a29 1320 bestmatch = bucket = Qnil;
c8ae863b 1321 zero = make_number (0);
f927c5ae 1322
a284cdbb
RS
1323 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1324 tail = collection;
f6d4c7a4 1325 if (type == obarray_table)
f927c5ae 1326 {
a284cdbb
RS
1327 collection = check_obarray (collection);
1328 obsize = XVECTOR (collection)->size;
1329 bucket = XVECTOR (collection)->contents[index];
f927c5ae
JB
1330 }
1331
1332 while (1)
1333 {
85cd4372 1334 /* Get the next element of the alist, obarray, or hash-table. */
f927c5ae
JB
1335 /* Exit the loop if the elements are all used up. */
1336 /* elt gets the alist element or symbol.
1337 eltstring gets the name to check as a completion. */
1338
f6d4c7a4 1339 if (type == list_table)
f927c5ae 1340 {
695deb18 1341 if (!CONSP (tail))
f927c5ae 1342 break;
695deb18
SM
1343 elt = XCAR (tail);
1344 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1345 tail = XCDR (tail);
f927c5ae 1346 }
f6d4c7a4 1347 else if (type == obarray_table)
f927c5ae 1348 {
c8ae863b 1349 if (!EQ (bucket, zero))
f927c5ae 1350 {
9b6b374a
JB
1351 if (!SYMBOLP (bucket))
1352 error ("Bad data in guts of obarray");
f927c5ae 1353 elt = bucket;
3809648a 1354 eltstring = elt;
f927c5ae
JB
1355 if (XSYMBOL (bucket)->next)
1356 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1357 else
5a866662 1358 XSETFASTINT (bucket, 0);
f927c5ae
JB
1359 }
1360 else if (++index >= obsize)
1361 break;
1362 else
1363 {
a284cdbb 1364 bucket = XVECTOR (collection)->contents[index];
f927c5ae
JB
1365 continue;
1366 }
1367 }
f6d4c7a4 1368 else /* if (type == hash_table) */
85cd4372 1369 {
a284cdbb
RS
1370 while (index < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1371 && NILP (HASH_HASH (XHASH_TABLE (collection), index)))
85cd4372 1372 index++;
a284cdbb 1373 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
85cd4372
SM
1374 break;
1375 else
a284cdbb 1376 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), index++);
85cd4372 1377 }
f927c5ae
JB
1378
1379 /* Is this element a possible completion? */
1380
3809648a
KS
1381 if (SYMBOLP (eltstring))
1382 eltstring = Fsymbol_name (eltstring);
1383
7510b296 1384 if (STRINGP (eltstring)
d5db4077 1385 && SCHARS (string) <= SCHARS (eltstring)
c8ae863b 1386 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1387 make_number (SCHARS (string)),
c8ae863b 1388 string, zero, Qnil,
6b61353c 1389 completion_ignore_case ? Qt : Qnil),
69f4ef20 1390 EQ (Qt, tem)))
f927c5ae
JB
1391 {
1392 /* Yes. */
42006772 1393 Lisp_Object regexps;
42006772
RS
1394
1395 /* Ignore this element if it fails to match all the regexps. */
6b61353c 1396 {
6b61353c
KH
1397 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1398 regexps = XCDR (regexps))
1399 {
acd81db9
DK
1400 if (bindcount < 0) {
1401 bindcount = SPECPDL_INDEX ();
1402 specbind (Qcase_fold_search,
1403 completion_ignore_case ? Qt : Qnil);
77443789 1404 }
6b61353c
KH
1405 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1406 if (NILP (tem))
1407 break;
1408 }
6b61353c
KH
1409 if (CONSP (regexps))
1410 continue;
1411 }
42006772 1412
f927c5ae
JB
1413 /* Ignore this element if there is a predicate
1414 and the predicate doesn't like it. */
1415
7efd36fc 1416 if (!NILP (predicate))
f927c5ae 1417 {
7efd36fc 1418 if (EQ (predicate, Qcommandp))
c837f4f9 1419 tem = Fcommandp (elt, Qnil);
f927c5ae
JB
1420 else
1421 {
f6d4c7a4
RS
1422 if (bindcount >= 0)
1423 {
1424 unbind_to (bindcount, Qnil);
1425 bindcount = -1;
1426 }
f927c5ae 1427 GCPRO4 (tail, string, eltstring, bestmatch);
f6d4c7a4
RS
1428 tem = (type == hash_table
1429 ? call2 (predicate, elt,
1430 HASH_VALUE (XHASH_TABLE (collection),
1431 index - 1))
1432 : call1 (predicate, elt));
f927c5ae
JB
1433 UNGCPRO;
1434 }
56a98455 1435 if (NILP (tem)) continue;
f927c5ae
JB
1436 }
1437
1438 /* Update computation of how much all possible completions match */
1439
56a98455 1440 if (NILP (bestmatch))
af2b7cd5 1441 {
85cd4372 1442 matchcount = 1;
af2b7cd5 1443 bestmatch = eltstring;
d5db4077 1444 bestmatchsize = SCHARS (eltstring);
af2b7cd5 1445 }
f927c5ae
JB
1446 else
1447 {
d5db4077 1448 compare = min (bestmatchsize, SCHARS (eltstring));
c8ae863b 1449 tem = Fcompare_strings (bestmatch, zero,
69f4ef20 1450 make_number (compare),
c8ae863b 1451 eltstring, zero,
69f4ef20
RS
1452 make_number (compare),
1453 completion_ignore_case ? Qt : Qnil);
1454 if (EQ (tem, Qt))
1455 matchsize = compare;
1456 else if (XINT (tem) < 0)
1457 matchsize = - XINT (tem) - 1;
1458 else
1459 matchsize = XINT (tem) - 1;
1460
52b14ac0
JB
1461 if (completion_ignore_case)
1462 {
1463 /* If this is an exact match except for case,
1464 use it as the best match rather than one that is not an
1465 exact match. This way, we get the case pattern
1466 of the actual match. */
d5db4077
KR
1467 if ((matchsize == SCHARS (eltstring)
1468 && matchsize < SCHARS (bestmatch))
52b14ac0
JB
1469 ||
1470 /* If there is more than one exact match ignoring case,
1471 and one of them is exact including case,
1472 prefer that one. */
1473 /* If there is no exact match ignoring case,
1474 prefer a match that does not change the case
1475 of the input. */
d5db4077 1476 ((matchsize == SCHARS (eltstring))
52b14ac0 1477 ==
d5db4077 1478 (matchsize == SCHARS (bestmatch))
c8ae863b 1479 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1480 make_number (SCHARS (string)),
c8ae863b 1481 string, zero,
69f4ef20
RS
1482 Qnil,
1483 Qnil),
1484 EQ (Qt, tem))
c8ae863b 1485 && (tem = Fcompare_strings (bestmatch, zero,
d5db4077 1486 make_number (SCHARS (string)),
c8ae863b 1487 string, zero,
69f4ef20
RS
1488 Qnil,
1489 Qnil),
1490 ! EQ (Qt, tem))))
52b14ac0
JB
1491 bestmatch = eltstring;
1492 }
d5db4077 1493 if (bestmatchsize != SCHARS (eltstring)
85cd4372
SM
1494 || bestmatchsize != matchsize)
1495 /* Don't count the same string multiple times. */
1496 matchcount++;
52b14ac0 1497 bestmatchsize = matchsize;
d5db4077 1498 if (matchsize <= SCHARS (string)
78893e05
CY
1499 /* If completion-ignore-case is non-nil, don't
1500 short-circuit because we want to find the best
1501 possible match *including* case differences. */
1502 && !completion_ignore_case
695deb18
SM
1503 && matchcount > 1)
1504 /* No need to look any further. */
1505 break;
f927c5ae
JB
1506 }
1507 }
1508 }
1509
acd81db9
DK
1510 if (bindcount >= 0) {
1511 unbind_to (bindcount, Qnil);
1512 bindcount = -1;
1513 }
1514
56a98455 1515 if (NILP (bestmatch))
f927c5ae 1516 return Qnil; /* No completions found */
52b14ac0
JB
1517 /* If we are ignoring case, and there is no exact match,
1518 and no additional text was supplied,
1519 don't change the case of what the user typed. */
d5db4077
KR
1520 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1521 && SCHARS (bestmatch) > bestmatchsize)
ec067ec7 1522 return minibuf_conform_representation (string, bestmatch);
52b14ac0
JB
1523
1524 /* Return t if the supplied string is an exact match (counting case);
1525 it does not require any change to be made. */
928b5acc 1526 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
f927c5ae
JB
1527 return Qt;
1528
5a866662
KH
1529 XSETFASTINT (zero, 0); /* Else extract the part in which */
1530 XSETFASTINT (end, bestmatchsize); /* all completions agree */
f927c5ae
JB
1531 return Fsubstring (bestmatch, zero, end);
1532}
f927c5ae 1533\f
89a255dc 1534DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
a284cdbb
RS
1535 doc: /* Search for partial matches to STRING in COLLECTION.
1536Test each of the possible completions specified by COLLECTION
1537to see if it begins with STRING. The possible completions may be
3809648a
KS
1538strings or symbols. Symbols are converted to strings before testing,
1539see `symbol-name'.
a284cdbb 1540The value is a list of all the possible completions that match STRING.
a1f17501 1541
a284cdbb
RS
1542If COLLECTION is an alist, the keys (cars of elements) are the
1543possible completions. If an element is not a cons cell, then the
1544element itself is the possible completion.
1545If COLLECTION is a hash-table, all the keys that are strings or symbols
1546are the possible completions.
1547If COLLECTION is an obarray, the names of all symbols in the obarray
1548are the possible completions.
a1f17501 1549
a284cdbb 1550COLLECTION can also be a function to do the completion itself.
a1f17501
PJ
1551It receives three arguments: the values STRING, PREDICATE and t.
1552Whatever it returns becomes the value of `all-completions'.
1553
1554If optional third argument PREDICATE is non-nil,
1555it is used to test each possible match.
1556The match is a candidate only if PREDICATE returns non-nil.
1557The argument given to PREDICATE is the alist element
a284cdbb 1558or the symbol from the obarray. If COLLECTION is a hash-table,
85cd4372 1559predicate is called with two arguments: the key and the value.
a1f17501
PJ
1560Additionally to this predicate, `completion-regexp-list'
1561is used to further constrain the set of candidates.
1562
1563If the optional fourth argument HIDE-SPACES is non-nil,
a284cdbb 1564strings in COLLECTION that start with a space
af52c32d 1565are ignored unless STRING itself starts with a space. */)
a284cdbb
RS
1566 (string, collection, predicate, hide_spaces)
1567 Lisp_Object string, collection, predicate, hide_spaces;
f927c5ae
JB
1568{
1569 Lisp_Object tail, elt, eltstring;
1570 Lisp_Object allmatches;
a284cdbb
RS
1571 int type = HASH_TABLE_P (collection) ? 3
1572 : VECTORP (collection) ? 2
1573 : NILP (collection) || (CONSP (collection)
1574 && (!SYMBOLP (XCAR (collection))
1575 || NILP (XCAR (collection))));
6bbd7a29 1576 int index = 0, obsize = 0;
acd81db9 1577 int bindcount = -1;
c8ae863b 1578 Lisp_Object bucket, tem, zero;
f927c5ae
JB
1579 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1580
b7826503 1581 CHECK_STRING (string);
85cd4372 1582 if (type == 0)
a284cdbb 1583 return call3 (collection, string, predicate, Qt);
6bbd7a29 1584 allmatches = bucket = Qnil;
c8ae863b 1585 zero = make_number (0);
f927c5ae 1586
a284cdbb
RS
1587 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1588 tail = collection;
85cd4372 1589 if (type == 2)
f927c5ae 1590 {
a284cdbb
RS
1591 obsize = XVECTOR (collection)->size;
1592 bucket = XVECTOR (collection)->contents[index];
f927c5ae
JB
1593 }
1594
1595 while (1)
1596 {
85cd4372 1597 /* Get the next element of the alist, obarray, or hash-table. */
f927c5ae
JB
1598 /* Exit the loop if the elements are all used up. */
1599 /* elt gets the alist element or symbol.
1600 eltstring gets the name to check as a completion. */
1601
85cd4372 1602 if (type == 1)
f927c5ae 1603 {
695deb18 1604 if (!CONSP (tail))
f927c5ae 1605 break;
695deb18
SM
1606 elt = XCAR (tail);
1607 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1608 tail = XCDR (tail);
f927c5ae 1609 }
85cd4372 1610 else if (type == 2)
f927c5ae 1611 {
c8ae863b 1612 if (!EQ (bucket, zero))
f927c5ae
JB
1613 {
1614 elt = bucket;
3809648a 1615 eltstring = elt;
f927c5ae
JB
1616 if (XSYMBOL (bucket)->next)
1617 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1618 else
5a866662 1619 XSETFASTINT (bucket, 0);
f927c5ae
JB
1620 }
1621 else if (++index >= obsize)
1622 break;
1623 else
1624 {
a284cdbb 1625 bucket = XVECTOR (collection)->contents[index];
f927c5ae
JB
1626 continue;
1627 }
1628 }
85cd4372
SM
1629 else /* if (type == 3) */
1630 {
a284cdbb
RS
1631 while (index < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1632 && NILP (HASH_HASH (XHASH_TABLE (collection), index)))
85cd4372 1633 index++;
a284cdbb 1634 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
85cd4372
SM
1635 break;
1636 else
a284cdbb 1637 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), index++);
85cd4372 1638 }
f927c5ae
JB
1639
1640 /* Is this element a possible completion? */
1641
3809648a
KS
1642 if (SYMBOLP (eltstring))
1643 eltstring = Fsymbol_name (eltstring);
1644
7510b296 1645 if (STRINGP (eltstring)
d5db4077 1646 && SCHARS (string) <= SCHARS (eltstring)
89a255dc 1647 /* If HIDE_SPACES, reject alternatives that start with space
2cbaf886 1648 unless the input starts with space. */
d5db4077
KR
1649 && ((SBYTES (string) > 0
1650 && SREF (string, 0) == ' ')
1651 || SREF (eltstring, 0) != ' '
89a255dc 1652 || NILP (hide_spaces))
c8ae863b 1653 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1654 make_number (SCHARS (string)),
c8ae863b 1655 string, zero,
d5db4077 1656 make_number (SCHARS (string)),
69f4ef20
RS
1657 completion_ignore_case ? Qt : Qnil),
1658 EQ (Qt, tem)))
f927c5ae
JB
1659 {
1660 /* Yes. */
42006772
RS
1661 Lisp_Object regexps;
1662 Lisp_Object zero;
5a866662 1663 XSETFASTINT (zero, 0);
42006772
RS
1664
1665 /* Ignore this element if it fails to match all the regexps. */
6b61353c 1666 {
6b61353c
KH
1667 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1668 regexps = XCDR (regexps))
1669 {
acd81db9
DK
1670 if (bindcount < 0) {
1671 bindcount = SPECPDL_INDEX ();
1672 specbind (Qcase_fold_search,
1673 completion_ignore_case ? Qt : Qnil);
77443789 1674 }
6b61353c
KH
1675 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1676 if (NILP (tem))
1677 break;
1678 }
6b61353c
KH
1679 if (CONSP (regexps))
1680 continue;
1681 }
42006772 1682
f927c5ae
JB
1683 /* Ignore this element if there is a predicate
1684 and the predicate doesn't like it. */
1685
7efd36fc 1686 if (!NILP (predicate))
f927c5ae 1687 {
7efd36fc 1688 if (EQ (predicate, Qcommandp))
c837f4f9 1689 tem = Fcommandp (elt, Qnil);
f927c5ae
JB
1690 else
1691 {
acd81db9
DK
1692 if (bindcount >= 0) {
1693 unbind_to (bindcount, Qnil);
1694 bindcount = -1;
1695 }
f927c5ae 1696 GCPRO4 (tail, eltstring, allmatches, string);
85cd4372
SM
1697 tem = type == 3
1698 ? call2 (predicate, elt,
a284cdbb 1699 HASH_VALUE (XHASH_TABLE (collection), index - 1))
85cd4372 1700 : call1 (predicate, elt);
f927c5ae
JB
1701 UNGCPRO;
1702 }
56a98455 1703 if (NILP (tem)) continue;
f927c5ae
JB
1704 }
1705 /* Ok => put it on the list. */
1706 allmatches = Fcons (eltstring, allmatches);
1707 }
1708 }
1709
acd81db9
DK
1710 if (bindcount >= 0) {
1711 unbind_to (bindcount, Qnil);
1712 bindcount = -1;
1713 }
1714
f927c5ae
JB
1715 return Fnreverse (allmatches);
1716}
1717\f
cee54539 1718DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
af52c32d 1719 doc: /* Read a string in the minibuffer, with completion.
a1f17501 1720PROMPT is a string to prompt with; normally it ends in a colon and a space.
a284cdbb
RS
1721COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1722COLLECTION can also be a function to do the completion itself.
1723PREDICATE limits completion to a subset of COLLECTION.
a1f17501 1724See `try-completion' and `all-completions' for more details
a284cdbb 1725 on completion, COLLECTION, and PREDICATE.
a1f17501 1726
4d02fc25
SM
1727REQUIRE-MATCH can take the following values:
1728- t means that the user is not allowed to exit unless
1729 the input is (or completes to) an element of COLLECTION or is null.
1730- nil means that the user can exit with any input.
b47d0e56
CY
1731- `confirm' means that the user can exit with any input, but she needs
1732 to confirm her choice if the input is not an element of COLLECTION.
1733- `confirm-after-completion' means that the user can exit with any
1734 input, but she needs to confirm her choice if she called
1735 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1736 and the input is not an element of COLLECTION.
4d02fc25
SM
1737- anything else behaves like t except that typing RET does not exit if it
1738 does non-null completion.
1739
2e3148e2
JL
1740If the input is null, `completing-read' returns DEF, or the first element
1741of the list of default values, or an empty string if DEF is nil,
1742regardless of the value of REQUIRE-MATCH.
6b61353c
KH
1743
1744If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1745 with point positioned at the end.
1746 If it is (STRING . POSITION), the initial input is STRING, but point
1747 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1748 that this is different from `read-from-minibuffer' and related
1749 functions, which use one-indexing for POSITION.) This feature is
1750 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1751 default value DEF instead. The user can yank the default value into
1752 the minibuffer easily using \\[next-history-element].
1753
1754HIST, if non-nil, specifies a history list and optionally the initial
1755 position in the list. It can be a symbol, which is the history list
1756 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1757 that case, HISTVAR is the history list variable to use, and HISTPOS
1758 is the initial position (the position in the list used by the
1759 minibuffer history commands). For consistency, you should also
1760 specify that element of the history as the value of
1fb101f3 1761 INITIAL-INPUT. (This is the only case in which you should use
6b61353c
KH
1762 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1763 1 at the beginning of the list. The variable `history-length'
1764 controls the maximum length of a history list.
38668f81 1765
2e3148e2 1766DEF, if non-nil, is the default value or the list of default values.
a1f17501
PJ
1767
1768If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
029a305c 1769 the current input method and the setting of `enable-multibyte-characters'.
a1f17501
PJ
1770
1771Completion ignores case if the ambient value of
af52c32d 1772 `completion-ignore-case' is non-nil. */)
a284cdbb
RS
1773 (prompt, collection, predicate, require_match, initial_input, hist, def, inherit_input_method)
1774 Lisp_Object prompt, collection, predicate, require_match, initial_input;
d43f85c2 1775 Lisp_Object hist, def, inherit_input_method;
f927c5ae 1776{
770970cb 1777 Lisp_Object val, histvar, histpos, position;
d43f85c2 1778 Lisp_Object init;
770970cb 1779 int pos = 0;
aed13378 1780 int count = SPECPDL_INDEX ();
0c8ee1a2
RS
1781 struct gcpro gcpro1;
1782
d43f85c2 1783 init = initial_input;
0c8ee1a2
RS
1784 GCPRO1 (def);
1785
a284cdbb 1786 specbind (Qminibuffer_completion_table, collection);
7efd36fc 1787 specbind (Qminibuffer_completion_predicate, predicate);
f927c5ae 1788 specbind (Qminibuffer_completion_confirm,
695deb18 1789 EQ (require_match, Qt) ? Qnil : require_match);
770970cb
RS
1790
1791 position = Qnil;
1792 if (!NILP (init))
1793 {
7510b296 1794 if (CONSP (init))
770970cb
RS
1795 {
1796 position = Fcdr (init);
1797 init = Fcar (init);
1798 }
b7826503 1799 CHECK_STRING (init);
770970cb
RS
1800 if (!NILP (position))
1801 {
b7826503 1802 CHECK_NUMBER (position);
770970cb 1803 /* Convert to distance from end of input. */
d5db4077 1804 pos = XINT (position) - SCHARS (init);
770970cb
RS
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 1830 ? Vminibuffer_local_must_match_map
8ba31f36 1831 : Vminibuffer_local_filename_must_match_map),
85b5fe07 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))
fb30dfd2 1837 val = CONSP (def) ? XCAR (def) : def;
b9a86585 1838
0c8ee1a2 1839 RETURN_UNGCPRO (unbind_to (count, val));
f927c5ae
JB
1840}
1841\f
695deb18 1842Lisp_Object Fassoc_string ();
5d2ca7ae
RS
1843
1844/* Test whether TXT is an exact completion. */
695deb18
SM
1845DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1846 doc: /* Return non-nil if STRING is a valid completion.
1847Takes the same arguments as `all-completions' and `try-completion'.
a284cdbb 1848If COLLECTION is a function, it is called with three arguments:
695deb18 1849the values STRING, PREDICATE and `lambda'. */)
a284cdbb
RS
1850 (string, collection, predicate)
1851 Lisp_Object string, collection, predicate;
5d2ca7ae 1852{
6b61353c 1853 Lisp_Object regexps, tail, tem = Qnil;
85cd4372 1854 int i = 0;
5d2ca7ae 1855
695deb18
SM
1856 CHECK_STRING (string);
1857
a284cdbb
RS
1858 if ((CONSP (collection)
1859 && (!SYMBOLP (XCAR (collection)) || NILP (XCAR (collection))))
1860 || NILP (collection))
695deb18 1861 {
a284cdbb 1862 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
9f4a578d 1863 if (NILP (tem))
695deb18
SM
1864 return Qnil;
1865 }
a284cdbb 1866 else if (VECTORP (collection))
5d2ca7ae 1867 {
695deb18 1868 /* Bypass intern-soft as that loses for nil. */
a284cdbb 1869 tem = oblookup (collection,
d5db4077
KR
1870 SDATA (string),
1871 SCHARS (string),
1872 SBYTES (string));
44472c88 1873 if (!SYMBOLP (tem))
9404446f 1874 {
695deb18
SM
1875 if (STRING_MULTIBYTE (string))
1876 string = Fstring_make_unibyte (string);
9404446f 1877 else
695deb18 1878 string = Fstring_make_multibyte (string);
9404446f 1879
a284cdbb 1880 tem = oblookup (collection,
d5db4077
KR
1881 SDATA (string),
1882 SCHARS (string),
1883 SBYTES (string));
9404446f 1884 }
6b61353c
KH
1885
1886 if (completion_ignore_case && !SYMBOLP (tem))
1887 {
a284cdbb 1888 for (i = XVECTOR (collection)->size - 1; i >= 0; i--)
6b61353c 1889 {
a284cdbb 1890 tail = XVECTOR (collection)->contents[i];
6b61353c
KH
1891 if (SYMBOLP (tail))
1892 while (1)
1893 {
1894 if (EQ((Fcompare_strings (string, make_number (0), Qnil,
1895 Fsymbol_name (tail),
1896 make_number (0) , Qnil, Qt)),
1897 Qt))
1898 {
1899 tem = tail;
1900 break;
1901 }
1902 if (XSYMBOL (tail)->next == 0)
1903 break;
1904 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1905 }
1906 }
1907 }
1908
1909 if (!SYMBOLP (tem))
1910 return Qnil;
5d2ca7ae 1911 }
a284cdbb 1912 else if (HASH_TABLE_P (collection))
85cd4372 1913 {
a284cdbb 1914 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
6b61353c 1915 i = hash_lookup (h, string, NULL);
85cd4372 1916 if (i >= 0)
6b61353c 1917 tem = HASH_KEY (h, i);
85cd4372 1918 else
6b61353c
KH
1919 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1920 if (!NILP (HASH_HASH (h, i)) &&
1921 EQ (Fcompare_strings (string, make_number (0), Qnil,
1922 HASH_KEY (h, i), make_number (0) , Qnil,
1923 completion_ignore_case ? Qt : Qnil),
1924 Qt))
1925 {
1926 tem = HASH_KEY (h, i);
1927 break;
1928 }
1929 if (!STRINGP (tem))
85cd4372
SM
1930 return Qnil;
1931 }
5d2ca7ae 1932 else
a284cdbb 1933 return call3 (collection, string, predicate, Qlambda);
695deb18
SM
1934
1935 /* Reject this element if it fails to match all the regexps. */
77443789
AS
1936 if (CONSP (Vcompletion_regexp_list))
1937 {
1938 int count = SPECPDL_INDEX ();
1939 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1940 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1941 regexps = XCDR (regexps))
1942 {
1943 if (NILP (Fstring_match (XCAR (regexps),
1944 SYMBOLP (tem) ? string : tem,
1945 Qnil)))
1946 return unbind_to (count, Qnil);
1947 }
1948 unbind_to (count, Qnil);
1949 }
695deb18
SM
1950
1951 /* Finally, check the predicate. */
1952 if (!NILP (predicate))
6b61353c 1953 {
a284cdbb
RS
1954 return HASH_TABLE_P (collection)
1955 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
6b61353c
KH
1956 : call1 (predicate, tem);
1957 }
695deb18
SM
1958 else
1959 return Qt;
5d2ca7ae 1960}
f927c5ae 1961
655ea21c
JD
1962DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1963 doc: /* Perform completion on buffer names.
1964If the argument FLAG is nil, invoke `try-completion', if it's t, invoke
1965`all-completions', otherwise invoke `test-completion'.
1966
ba5524f4 1967The arguments STRING and PREDICATE are as in `try-completion',
655ea21c
JD
1968`all-completions', and `test-completion'. */)
1969 (string, predicate, flag)
1970 Lisp_Object string, predicate, flag;
1971{
1972 if (NILP (flag))
1973 return Ftry_completion (string, Vbuffer_alist, predicate);
1974 else if (EQ (flag, Qt))
8c2dccbf 1975 {
73913e2e 1976 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
8c2dccbf
SM
1977 if (SCHARS (string) > 0)
1978 return res;
1979 else
1980 { /* Strip out internal buffers. */
1981 Lisp_Object bufs = res;
1982 /* First, look for a non-internal buffer in `res'. */
1983 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1984 bufs = XCDR (bufs);
1985 if (NILP (bufs))
1986 /* All bufs in `res' are internal, so don't trip them out. */
1987 return res;
1988 res = bufs;
1989 while (CONSP (XCDR (bufs)))
1990 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1991 XSETCDR (bufs, XCDR (XCDR (bufs)));
1992 else
1993 bufs = XCDR (bufs);
1994 return res;
1995 }
1996 }
655ea21c
JD
1997 else /* assume `lambda' */
1998 return Ftest_completion (string, Vbuffer_alist, predicate);
1999}
2000
52b14ac0
JB
2001/* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
2002
695deb18 2003DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
d3fc66fb 2004 doc: /* Like `assoc' but specifically for strings (and symbols).
c6a82c18
CY
2005
2006This returns the first element of LIST whose car matches the string or
2007symbol KEY, or nil if no match exists. When performing the
2008comparison, symbols are first converted to strings, and unibyte
2009strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
2010is ignored.
2011
2012Unlike `assoc', KEY can also match an entry in LIST consisting of a
2013single string, rather than a cons cell whose car is a string. */)
695deb18 2014 (key, list, case_fold)
52b14ac0 2015 register Lisp_Object key;
695deb18 2016 Lisp_Object list, case_fold;
52b14ac0
JB
2017{
2018 register Lisp_Object tail;
2019
d3fc66fb
KS
2020 if (SYMBOLP (key))
2021 key = Fsymbol_name (key);
2022
99784d63 2023 for (tail = list; CONSP (tail); tail = XCDR (tail))
52b14ac0
JB
2024 {
2025 register Lisp_Object elt, tem, thiscar;
99784d63 2026 elt = XCAR (tail);
695deb18 2027 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1954495f
KS
2028 if (SYMBOLP (thiscar))
2029 thiscar = Fsymbol_name (thiscar);
2030 else if (!STRINGP (thiscar))
52b14ac0 2031 continue;
9404446f
RS
2032 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
2033 key, make_number (0), Qnil,
695deb18 2034 case_fold);
9404446f
RS
2035 if (EQ (tem, Qt))
2036 return elt;
52b14ac0
JB
2037 QUIT;
2038 }
2039 return Qnil;
2040}
f927c5ae 2041
e4c97a67 2042\f
f927c5ae 2043DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
af52c32d
MB
2044 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
2045 ()
f927c5ae
JB
2046{
2047 return make_number (minibuf_level);
2048}
2049
37e9a934 2050DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
af52c32d
MB
2051 doc: /* Return the prompt string of the currently-active minibuffer.
2052If no minibuffer is active, return nil. */)
2053 ()
37e9a934 2054{
4d04c1f1 2055 return Fcopy_sequence (minibuf_prompt);
37e9a934
KH
2056}
2057
f927c5ae 2058\f
9d815fd9 2059void
f927c5ae
JB
2060init_minibuf_once ()
2061{
2062 Vminibuffer_list = Qnil;
2063 staticpro (&Vminibuffer_list);
2064}
2065
9d815fd9 2066void
f927c5ae
JB
2067syms_of_minibuf ()
2068{
2069 minibuf_level = 0;
4d04c1f1
KH
2070 minibuf_prompt = Qnil;
2071 staticpro (&minibuf_prompt);
2072
2073 minibuf_save_list = Qnil;
2074 staticpro (&minibuf_save_list);
f927c5ae 2075
9fa5c213
GM
2076 Qcompletion_ignore_case = intern ("completion-ignore-case");
2077 staticpro (&Qcompletion_ignore_case);
2078
719b4a40
RS
2079 Qread_file_name_internal = intern ("read-file-name-internal");
2080 staticpro (&Qread_file_name_internal);
2081
e5d4686b
RS
2082 Qminibuffer_default = intern ("minibuffer-default");
2083 staticpro (&Qminibuffer_default);
2084 Fset (Qminibuffer_default, Qnil);
2085
f927c5ae
JB
2086 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2087 staticpro (&Qminibuffer_completion_table);
2088
2089 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2090 staticpro (&Qminibuffer_completion_confirm);
2091
2092 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2093 staticpro (&Qminibuffer_completion_predicate);
2094
2095 staticpro (&last_minibuf_string);
2096 last_minibuf_string = Qnil;
2097
2098 Quser_variable_p = intern ("user-variable-p");
2099 staticpro (&Quser_variable_p);
2100
770970cb
RS
2101 Qminibuffer_history = intern ("minibuffer-history");
2102 staticpro (&Qminibuffer_history);
f927c5ae 2103
406e55df
RS
2104 Qbuffer_name_history = intern ("buffer-name-history");
2105 staticpro (&Qbuffer_name_history);
33d0a17f 2106 Fset (Qbuffer_name_history, Qnil);
406e55df 2107
5c781212
RS
2108 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2109 staticpro (&Qminibuffer_setup_hook);
2110
177aecf9
KH
2111 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2112 staticpro (&Qminibuffer_exit_hook);
2113
77aa8edf
RS
2114 Qhistory_length = intern ("history-length");
2115 staticpro (&Qhistory_length);
2116
cee54539
KH
2117 Qcurrent_input_method = intern ("current-input-method");
2118 staticpro (&Qcurrent_input_method);
2119
2120 Qactivate_input_method = intern ("activate-input-method");
2121 staticpro (&Qactivate_input_method);
2122
6b61353c
KH
2123 Qcase_fold_search = intern ("case-fold-search");
2124 staticpro (&Qcase_fold_search);
2125
627fb581
RS
2126 Qread_expression_history = intern ("read-expression-history");
2127 staticpro (&Qread_expression_history);
2128
af52c32d
MB
2129 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2130 doc: /* If this is non-nil, `read-buffer' does its work by calling this function. */);
eebbfb01
KH
2131 Vread_buffer_function = Qnil;
2132
33df281c
CY
2133 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
2134 &read_buffer_completion_ignore_case,
2135 doc: /* *Non-nil means completion ignores case when reading a buffer name. */);
2136 read_buffer_completion_ignore_case = 0;
2137
af52c32d
MB
2138 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2139 doc: /* Normal hook run just after entry to minibuffer. */);
5c781212
RS
2140 Vminibuffer_setup_hook = Qnil;
2141
af52c32d
MB
2142 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2143 doc: /* Normal hook run just after exit from minibuffer. */);
177aecf9
KH
2144 Vminibuffer_exit_hook = Qnil;
2145
af52c32d
MB
2146 DEFVAR_LISP ("history-length", &Vhistory_length,
2147 doc: /* *Maximum length for history lists before truncation takes place.
a1f17501 2148A number means that length; t means infinite. Truncation takes place
f4b46bb9 2149just after a new element is inserted. Setting the `history-length'
a1f17501 2150property of a history variable overrides this default. */);
77aa8edf
RS
2151 XSETFASTINT (Vhistory_length, 30);
2152
0da4d471
JL
2153 DEFVAR_BOOL ("history-delete-duplicates", &history_delete_duplicates,
2154 doc: /* *Non-nil means to delete duplicates in history.
2155If set to t when adding a new history element, all previous identical
179a4ca7 2156elements are deleted from the history list. */);
0da4d471
JL
2157 history_delete_duplicates = 0;
2158
179a4ca7
JL
2159 DEFVAR_LISP ("history-add-new-input", &Vhistory_add_new_input,
2160 doc: /* *Non-nil means to add new elements in history.
2161If set to nil, minibuffer reading functions don't add new elements to the
2162history list, so it is possible to do this afterwards by calling
2163`add-to-history' explicitly. */);
2164 Vhistory_add_new_input = Qt;
2165
af52c32d 2166 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
75028673 2167 doc: /* Non-nil means don't consider case significant in completion.
f562df03
CY
2168For file-name completion, `read-file-name-completion-ignore-case'
2169controls the behavior, rather than this variable.
2170For buffer name completion, `read-buffer-completion-ignore-case'
d9a03ad2 2171controls the behavior, rather than this variable. */);
f927c5ae
JB
2172 completion_ignore_case = 0;
2173
af52c32d
MB
2174 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2175 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
a1f17501 2176This variable makes a difference whenever the minibuffer window is active. */);
f927c5ae
JB
2177 enable_recursive_minibuffers = 0;
2178
af52c32d
MB
2179 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2180 doc: /* Alist or obarray used for completion in the minibuffer.
6b61353c
KH
2181This becomes the ALIST argument to `try-completion' and `all-completions'.
2182The value can also be a list of strings or a hash table.
a1f17501
PJ
2183
2184The value may alternatively be a function, which is given three arguments:
2185 STRING, the current buffer contents;
2186 PREDICATE, the predicate for filtering possible matches;
2187 CODE, which says what kind of things to do.
b2ef9714
JB
2188CODE can be nil, t or `lambda':
2189 nil -- return the best completion of STRING, or nil if there is none.
2190 t -- return a list of all possible completions of STRING.
2191 lambda -- return t if STRING is a valid completion as it stands. */);
f927c5ae
JB
2192 Vminibuffer_completion_table = Qnil;
2193
af52c32d
MB
2194 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2195 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
f927c5ae
JB
2196 Vminibuffer_completion_predicate = Qnil;
2197
af52c32d 2198 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
b47d0e56
CY
2199 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2200If nil, confirmation is not required.
2201If the value is `confirm', the user may exit with an input that is not
2202 a valid completion alternative, but Emacs asks for confirmation.
2203If the value is `confirm-after-completion', the user may exit with an
2204 input that is not a valid completion alternative, but Emacs asks for
1b79e224
CY
2205 confirmation if the user submitted the input right after any of the
2206 completion commands listed in `minibuffer-confirm-exit-commands'. */);
f927c5ae
JB
2207 Vminibuffer_completion_confirm = Qnil;
2208
ccf330a6 2209 DEFVAR_LISP ("minibuffer-completing-file-name",
af52c32d 2210 &Vminibuffer_completing_file_name,
6ddfc113 2211 doc: /* Non-nil means completing file names. */);
ccf330a6
RS
2212 Vminibuffer_completing_file_name = Qnil;
2213
af52c32d
MB
2214 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2215 doc: /* Value that `help-form' takes on inside the minibuffer. */);
f927c5ae
JB
2216 Vminibuffer_help_form = Qnil;
2217
af52c32d
MB
2218 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2219 doc: /* History list symbol to add minibuffer values to.
a1f17501
PJ
2220Each string of minibuffer input, as it appears on exit from the minibuffer,
2221is added with
2222 (set minibuffer-history-variable
2223 (cons STRING (symbol-value minibuffer-history-variable))) */);
5a866662 2224 XSETFASTINT (Vminibuffer_history_variable, 0);
770970cb 2225
af52c32d
MB
2226 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2227 doc: /* Current position of redoing in the history list. */);
770970cb
RS
2228 Vminibuffer_history_position = Qnil;
2229
af52c32d
MB
2230 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2231 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
a1f17501 2232Some uses of the echo area also raise that frame (since they use it too). */);
6a9ee000
RS
2233 minibuffer_auto_raise = 0;
2234
af52c32d 2235 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
6b61353c
KH
2236 doc: /* List of regexps that should restrict possible completions.
2237The basic completion functions only consider a completion acceptable
2238if it matches all regular expressions in this list, with
2239`case-fold-search' bound to the value of `completion-ignore-case'.
2240See Info node `(elisp)Basic Completion', for a description of these
2241functions. */);
42006772
RS
2242 Vcompletion_regexp_list = Qnil;
2243
c3421833 2244 DEFVAR_BOOL ("minibuffer-allow-text-properties",
af52c32d
MB
2245 &minibuffer_allow_text_properties,
2246 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
a1f17501
PJ
2247This also affects `read-string', but it does not affect `read-minibuffer',
2248`read-no-blanks-input', or any of the functions that do minibuffer input
2249with completion; they always discard text properties. */);
c3421833
RS
2250 minibuffer_allow_text_properties = 0;
2251
af52c32d
MB
2252 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties,
2253 doc: /* Text properties that are added to minibuffer prompts.
a1f17501
PJ
2254These are in addition to the basic `field' property, and stickiness
2255properties. */);
cc64f5c9
MB
2256 /* We use `intern' here instead of Qread_only to avoid
2257 initialization-order problems. */
2258 Vminibuffer_prompt_properties
2259 = Fcons (intern ("read-only"), Fcons (Qt, Qnil));
2260
627fb581
RS
2261 DEFVAR_LISP ("read-expression-map", &Vread_expression_map,
2262 doc: /* Minibuffer keymap used for reading Lisp expressions. */);
2263 Vread_expression_map = Qnil;
2264
68313ed8 2265 defsubr (&Sset_minibuffer_window);
f927c5ae
JB
2266 defsubr (&Sread_from_minibuffer);
2267 defsubr (&Seval_minibuffer);
2268 defsubr (&Sread_minibuffer);
2269 defsubr (&Sread_string);
2270 defsubr (&Sread_command);
2271 defsubr (&Sread_variable);
ff137f16 2272 defsubr (&Sinternal_complete_buffer);
f927c5ae
JB
2273 defsubr (&Sread_buffer);
2274 defsubr (&Sread_no_blanks_input);
2275 defsubr (&Sminibuffer_depth);
37e9a934 2276 defsubr (&Sminibuffer_prompt);
f927c5ae 2277
873ef78e 2278 defsubr (&Sminibufferp);
a346ec72
MB
2279 defsubr (&Sminibuffer_prompt_end);
2280 defsubr (&Sminibuffer_contents);
2281 defsubr (&Sminibuffer_contents_no_properties);
b5e1e449 2282 defsubr (&Sminibuffer_completion_contents);
a346ec72 2283
f927c5ae
JB
2284 defsubr (&Stry_completion);
2285 defsubr (&Sall_completions);
695deb18
SM
2286 defsubr (&Stest_completion);
2287 defsubr (&Sassoc_string);
f927c5ae 2288 defsubr (&Scompleting_read);
f927c5ae
JB
2289}
2290
6b61353c
KH
2291/* arch-tag: 8f69b601-fba3-484c-a6dd-ceaee54a7a73
2292 (do not change this comment) */