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