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