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