(browse-url-netscape-new-window-is-tab): New variable.
[bpt/emacs.git] / src / minibuf.c
CommitLineData
f927c5ae 1/* Minibuffer input and completion.
7292839d 2 Copyright (C) 1985,86,93,94,95,96,97,98,99,2000,01,03,04
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
3b7ad313
EN
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, 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
SM
1183Each car of each element of ALIST (or each element if it is not a cons cell)
1184is tested to see if it begins with STRING.
a1f17501
PJ
1185All that match are compared together; the longest initial sequence
1186common to all matches is returned as a string.
1187If there is no match at all, nil is returned.
1188For a unique match which is exact, t is returned.
1189
85cd4372
SM
1190If ALIST is a hash-table, all the string keys are the possible matches.
1191If ALIST is an obarray, the names of all symbols in the obarray
1192are the possible matches.
a1f17501
PJ
1193
1194ALIST can also be a function to do the completion itself.
1195It receives three arguments: the values STRING, PREDICATE and nil.
1196Whatever it returns becomes the value of `try-completion'.
1197
1198If optional third argument PREDICATE is non-nil,
1199it is used to test each possible match.
1200The match is a candidate only if PREDICATE returns non-nil.
1201The argument given to PREDICATE is the alist element
85cd4372
SM
1202or the symbol from the obarray. If ALIST is a hash-table,
1203predicate is called with two arguments: the key and the value.
a1f17501 1204Additionally to this predicate, `completion-regexp-list'
af52c32d
MB
1205is used to further constrain the set of candidates. */)
1206 (string, alist, predicate)
7efd36fc 1207 Lisp_Object string, alist, predicate;
f927c5ae
JB
1208{
1209 Lisp_Object bestmatch, tail, elt, eltstring;
af2b7cd5 1210 /* Size in bytes of BESTMATCH. */
6bbd7a29 1211 int bestmatchsize = 0;
af2b7cd5 1212 /* These are in bytes, too. */
f927c5ae 1213 int compare, matchsize;
85cd4372
SM
1214 int type = HASH_TABLE_P (alist) ? 3
1215 : VECTORP (alist) ? 2
1216 : NILP (alist) || (CONSP (alist)
1217 && (!SYMBOLP (XCAR (alist))
1218 || NILP (XCAR (alist))));
6bbd7a29 1219 int index = 0, obsize = 0;
f927c5ae 1220 int matchcount = 0;
acd81db9 1221 int bindcount = -1;
f927c5ae
JB
1222 Lisp_Object bucket, zero, end, tem;
1223 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1224
b7826503 1225 CHECK_STRING (string);
85cd4372 1226 if (type == 0)
7efd36fc 1227 return call3 (alist, string, predicate, Qnil);
f927c5ae 1228
6bbd7a29 1229 bestmatch = bucket = Qnil;
c8ae863b 1230 zero = make_number (0);
f927c5ae
JB
1231
1232 /* If ALIST is not a list, set TAIL just for gc pro. */
1233 tail = alist;
85cd4372 1234 if (type == 2)
f927c5ae 1235 {
f927c5ae
JB
1236 obsize = XVECTOR (alist)->size;
1237 bucket = XVECTOR (alist)->contents[index];
1238 }
1239
1240 while (1)
1241 {
85cd4372 1242 /* Get the next element of the alist, obarray, or hash-table. */
f927c5ae
JB
1243 /* Exit the loop if the elements are all used up. */
1244 /* elt gets the alist element or symbol.
1245 eltstring gets the name to check as a completion. */
1246
85cd4372 1247 if (type == 1)
f927c5ae 1248 {
695deb18 1249 if (!CONSP (tail))
f927c5ae 1250 break;
695deb18
SM
1251 elt = XCAR (tail);
1252 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1253 tail = XCDR (tail);
f927c5ae 1254 }
85cd4372 1255 else if (type == 2)
f927c5ae 1256 {
c8ae863b 1257 if (!EQ (bucket, zero))
f927c5ae
JB
1258 {
1259 elt = bucket;
1260 eltstring = Fsymbol_name (elt);
1261 if (XSYMBOL (bucket)->next)
1262 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1263 else
5a866662 1264 XSETFASTINT (bucket, 0);
f927c5ae
JB
1265 }
1266 else if (++index >= obsize)
1267 break;
1268 else
1269 {
1270 bucket = XVECTOR (alist)->contents[index];
1271 continue;
1272 }
1273 }
85cd4372
SM
1274 else /* if (type == 3) */
1275 {
1276 while (index < HASH_TABLE_SIZE (XHASH_TABLE (alist))
1277 && NILP (HASH_HASH (XHASH_TABLE (alist), index)))
1278 index++;
1279 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (alist)))
1280 break;
1281 else
1282 elt = eltstring = HASH_KEY (XHASH_TABLE (alist), index++);
1283 }
f927c5ae
JB
1284
1285 /* Is this element a possible completion? */
1286
7510b296 1287 if (STRINGP (eltstring)
d5db4077 1288 && SCHARS (string) <= SCHARS (eltstring)
c8ae863b 1289 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1290 make_number (SCHARS (string)),
c8ae863b 1291 string, zero, Qnil,
b0c138ce 1292 completion_ignore_case ? Qt : Qnil),
69f4ef20 1293 EQ (Qt, tem)))
f927c5ae
JB
1294 {
1295 /* Yes. */
42006772 1296 Lisp_Object regexps;
42006772
RS
1297
1298 /* Ignore this element if it fails to match all the regexps. */
acd81db9
DK
1299 {
1300 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1301 regexps = XCDR (regexps))
1302 {
1303 if (bindcount < 0) {
1304 bindcount = SPECPDL_INDEX ();
1305 specbind (Qcase_fold_search,
1306 completion_ignore_case ? Qt : Qnil);
77443789 1307 }
acd81db9
DK
1308 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1309 if (NILP (tem))
1310 break;
1311 }
1312 if (CONSP (regexps))
1313 continue;
1314 }
42006772 1315
f927c5ae
JB
1316 /* Ignore this element if there is a predicate
1317 and the predicate doesn't like it. */
1318
7efd36fc 1319 if (!NILP (predicate))
f927c5ae 1320 {
7efd36fc 1321 if (EQ (predicate, Qcommandp))
c837f4f9 1322 tem = Fcommandp (elt, Qnil);
f927c5ae
JB
1323 else
1324 {
acd81db9
DK
1325 if (bindcount >= 0) {
1326 unbind_to (bindcount, Qnil);
1327 bindcount = -1;
1328 }
f927c5ae 1329 GCPRO4 (tail, string, eltstring, bestmatch);
85cd4372
SM
1330 tem = type == 3
1331 ? call2 (predicate, elt,
1332 HASH_VALUE (XHASH_TABLE (alist), index - 1))
1333 : call1 (predicate, elt);
f927c5ae
JB
1334 UNGCPRO;
1335 }
56a98455 1336 if (NILP (tem)) continue;
f927c5ae
JB
1337 }
1338
1339 /* Update computation of how much all possible completions match */
1340
56a98455 1341 if (NILP (bestmatch))
af2b7cd5 1342 {
85cd4372 1343 matchcount = 1;
af2b7cd5 1344 bestmatch = eltstring;
d5db4077 1345 bestmatchsize = SCHARS (eltstring);
af2b7cd5 1346 }
f927c5ae
JB
1347 else
1348 {
d5db4077 1349 compare = min (bestmatchsize, SCHARS (eltstring));
c8ae863b 1350 tem = Fcompare_strings (bestmatch, zero,
69f4ef20 1351 make_number (compare),
c8ae863b 1352 eltstring, zero,
69f4ef20
RS
1353 make_number (compare),
1354 completion_ignore_case ? Qt : Qnil);
1355 if (EQ (tem, Qt))
1356 matchsize = compare;
1357 else if (XINT (tem) < 0)
1358 matchsize = - XINT (tem) - 1;
1359 else
1360 matchsize = XINT (tem) - 1;
1361
52b14ac0 1362 if (matchsize < 0)
695deb18 1363 /* When can this happen ? -stef */
52b14ac0
JB
1364 matchsize = compare;
1365 if (completion_ignore_case)
1366 {
1367 /* If this is an exact match except for case,
1368 use it as the best match rather than one that is not an
1369 exact match. This way, we get the case pattern
1370 of the actual match. */
d5db4077
KR
1371 if ((matchsize == SCHARS (eltstring)
1372 && matchsize < SCHARS (bestmatch))
52b14ac0
JB
1373 ||
1374 /* If there is more than one exact match ignoring case,
1375 and one of them is exact including case,
1376 prefer that one. */
1377 /* If there is no exact match ignoring case,
1378 prefer a match that does not change the case
1379 of the input. */
d5db4077 1380 ((matchsize == SCHARS (eltstring))
52b14ac0 1381 ==
d5db4077 1382 (matchsize == SCHARS (bestmatch))
c8ae863b 1383 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1384 make_number (SCHARS (string)),
c8ae863b 1385 string, zero,
69f4ef20
RS
1386 Qnil,
1387 Qnil),
1388 EQ (Qt, tem))
c8ae863b 1389 && (tem = Fcompare_strings (bestmatch, zero,
d5db4077 1390 make_number (SCHARS (string)),
c8ae863b 1391 string, zero,
69f4ef20
RS
1392 Qnil,
1393 Qnil),
1394 ! EQ (Qt, tem))))
52b14ac0
JB
1395 bestmatch = eltstring;
1396 }
d5db4077 1397 if (bestmatchsize != SCHARS (eltstring)
85cd4372
SM
1398 || bestmatchsize != matchsize)
1399 /* Don't count the same string multiple times. */
1400 matchcount++;
52b14ac0 1401 bestmatchsize = matchsize;
d5db4077 1402 if (matchsize <= SCHARS (string)
695deb18
SM
1403 && matchcount > 1)
1404 /* No need to look any further. */
1405 break;
f927c5ae
JB
1406 }
1407 }
1408 }
1409
acd81db9
DK
1410 if (bindcount >= 0) {
1411 unbind_to (bindcount, Qnil);
1412 bindcount = -1;
1413 }
1414
56a98455 1415 if (NILP (bestmatch))
f927c5ae 1416 return Qnil; /* No completions found */
52b14ac0
JB
1417 /* If we are ignoring case, and there is no exact match,
1418 and no additional text was supplied,
1419 don't change the case of what the user typed. */
d5db4077
KR
1420 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1421 && SCHARS (bestmatch) > bestmatchsize)
ec067ec7 1422 return minibuf_conform_representation (string, bestmatch);
52b14ac0
JB
1423
1424 /* Return t if the supplied string is an exact match (counting case);
1425 it does not require any change to be made. */
d5db4077 1426 if (matchcount == 1 && bestmatchsize == SCHARS (string)
69f4ef20
RS
1427 && (tem = Fcompare_strings (bestmatch, make_number (0),
1428 make_number (bestmatchsize),
1429 string, make_number (0),
1430 make_number (bestmatchsize),
1431 Qnil),
1432 EQ (Qt, tem)))
f927c5ae
JB
1433 return Qt;
1434
5a866662
KH
1435 XSETFASTINT (zero, 0); /* Else extract the part in which */
1436 XSETFASTINT (end, bestmatchsize); /* all completions agree */
f927c5ae
JB
1437 return Fsubstring (bestmatch, zero, end);
1438}
f927c5ae 1439\f
89a255dc 1440DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
af52c32d 1441 doc: /* Search for partial matches to STRING in ALIST.
f9b9ccef
SM
1442Each car of each element of ALIST (or each element if it is not a cons cell)
1443is tested to see if it begins with STRING.
a1f17501
PJ
1444The value is a list of all the strings from ALIST that match.
1445
85cd4372
SM
1446If ALIST is a hash-table, all the string keys are the possible matches.
1447If ALIST is an obarray, the names of all symbols in the obarray
1448are the possible matches.
a1f17501
PJ
1449
1450ALIST can also be a function to do the completion itself.
1451It receives three arguments: the values STRING, PREDICATE and t.
1452Whatever it returns becomes the value of `all-completions'.
1453
1454If optional third argument PREDICATE is non-nil,
1455it is used to test each possible match.
1456The match is a candidate only if PREDICATE returns non-nil.
1457The argument given to PREDICATE is the alist element
85cd4372
SM
1458or the symbol from the obarray. If ALIST is a hash-table,
1459predicate is called with two arguments: the key and the value.
a1f17501
PJ
1460Additionally to this predicate, `completion-regexp-list'
1461is used to further constrain the set of candidates.
1462
1463If the optional fourth argument HIDE-SPACES is non-nil,
1464strings in ALIST that start with a space
af52c32d
MB
1465are ignored unless STRING itself starts with a space. */)
1466 (string, alist, predicate, hide_spaces)
7efd36fc 1467 Lisp_Object string, alist, predicate, hide_spaces;
f927c5ae
JB
1468{
1469 Lisp_Object tail, elt, eltstring;
1470 Lisp_Object allmatches;
85cd4372
SM
1471 int type = HASH_TABLE_P (alist) ? 3
1472 : VECTORP (alist) ? 2
1473 : NILP (alist) || (CONSP (alist)
1474 && (!SYMBOLP (XCAR (alist))
1475 || NILP (XCAR (alist))));
6bbd7a29 1476 int index = 0, obsize = 0;
acd81db9 1477 int bindcount = -1;
c8ae863b 1478 Lisp_Object bucket, tem, zero;
f927c5ae
JB
1479 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1480
b7826503 1481 CHECK_STRING (string);
85cd4372
SM
1482 if (type == 0)
1483 return call3 (alist, string, predicate, Qt);
6bbd7a29 1484 allmatches = bucket = Qnil;
c8ae863b 1485 zero = make_number (0);
f927c5ae
JB
1486
1487 /* If ALIST is not a list, set TAIL just for gc pro. */
1488 tail = alist;
85cd4372 1489 if (type == 2)
f927c5ae 1490 {
f927c5ae
JB
1491 obsize = XVECTOR (alist)->size;
1492 bucket = XVECTOR (alist)->contents[index];
1493 }
1494
1495 while (1)
1496 {
85cd4372 1497 /* Get the next element of the alist, obarray, or hash-table. */
f927c5ae
JB
1498 /* Exit the loop if the elements are all used up. */
1499 /* elt gets the alist element or symbol.
1500 eltstring gets the name to check as a completion. */
1501
85cd4372 1502 if (type == 1)
f927c5ae 1503 {
695deb18 1504 if (!CONSP (tail))
f927c5ae 1505 break;
695deb18
SM
1506 elt = XCAR (tail);
1507 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1508 tail = XCDR (tail);
f927c5ae 1509 }
85cd4372 1510 else if (type == 2)
f927c5ae 1511 {
c8ae863b 1512 if (!EQ (bucket, zero))
f927c5ae
JB
1513 {
1514 elt = bucket;
1515 eltstring = Fsymbol_name (elt);
1516 if (XSYMBOL (bucket)->next)
1517 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1518 else
5a866662 1519 XSETFASTINT (bucket, 0);
f927c5ae
JB
1520 }
1521 else if (++index >= obsize)
1522 break;
1523 else
1524 {
1525 bucket = XVECTOR (alist)->contents[index];
1526 continue;
1527 }
1528 }
85cd4372
SM
1529 else /* if (type == 3) */
1530 {
1531 while (index < HASH_TABLE_SIZE (XHASH_TABLE (alist))
1532 && NILP (HASH_HASH (XHASH_TABLE (alist), index)))
1533 index++;
1534 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (alist)))
1535 break;
1536 else
1537 elt = eltstring = HASH_KEY (XHASH_TABLE (alist), index++);
1538 }
f927c5ae
JB
1539
1540 /* Is this element a possible completion? */
1541
7510b296 1542 if (STRINGP (eltstring)
d5db4077 1543 && SCHARS (string) <= SCHARS (eltstring)
89a255dc 1544 /* If HIDE_SPACES, reject alternatives that start with space
2cbaf886 1545 unless the input starts with space. */
d5db4077
KR
1546 && ((SBYTES (string) > 0
1547 && SREF (string, 0) == ' ')
1548 || SREF (eltstring, 0) != ' '
89a255dc 1549 || NILP (hide_spaces))
c8ae863b 1550 && (tem = Fcompare_strings (eltstring, zero,
d5db4077 1551 make_number (SCHARS (string)),
c8ae863b 1552 string, zero,
d5db4077 1553 make_number (SCHARS (string)),
69f4ef20
RS
1554 completion_ignore_case ? Qt : Qnil),
1555 EQ (Qt, tem)))
f927c5ae
JB
1556 {
1557 /* Yes. */
42006772
RS
1558 Lisp_Object regexps;
1559 Lisp_Object zero;
5a866662 1560 XSETFASTINT (zero, 0);
42006772
RS
1561
1562 /* Ignore this element if it fails to match all the regexps. */
acd81db9
DK
1563 {
1564 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1565 regexps = XCDR (regexps))
1566 {
1567 if (bindcount < 0) {
1568 bindcount = SPECPDL_INDEX ();
1569 specbind (Qcase_fold_search,
1570 completion_ignore_case ? Qt : Qnil);
77443789 1571 }
acd81db9
DK
1572 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1573 if (NILP (tem))
1574 break;
1575 }
1576 if (CONSP (regexps))
1577 continue;
1578 }
42006772 1579
f927c5ae
JB
1580 /* Ignore this element if there is a predicate
1581 and the predicate doesn't like it. */
1582
7efd36fc 1583 if (!NILP (predicate))
f927c5ae 1584 {
7efd36fc 1585 if (EQ (predicate, Qcommandp))
c837f4f9 1586 tem = Fcommandp (elt, Qnil);
f927c5ae
JB
1587 else
1588 {
acd81db9
DK
1589 if (bindcount >= 0) {
1590 unbind_to (bindcount, Qnil);
1591 bindcount = -1;
1592 }
f927c5ae 1593 GCPRO4 (tail, eltstring, allmatches, string);
85cd4372
SM
1594 tem = type == 3
1595 ? call2 (predicate, elt,
1596 HASH_VALUE (XHASH_TABLE (alist), index - 1))
1597 : call1 (predicate, elt);
f927c5ae
JB
1598 UNGCPRO;
1599 }
56a98455 1600 if (NILP (tem)) continue;
f927c5ae
JB
1601 }
1602 /* Ok => put it on the list. */
1603 allmatches = Fcons (eltstring, allmatches);
1604 }
1605 }
1606
acd81db9
DK
1607 if (bindcount >= 0) {
1608 unbind_to (bindcount, Qnil);
1609 bindcount = -1;
1610 }
1611
f927c5ae
JB
1612 return Fnreverse (allmatches);
1613}
1614\f
1615Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1616Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1617Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
ccf330a6 1618Lisp_Object Vminibuffer_completing_file_name;
f927c5ae 1619
cee54539 1620DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
af52c32d 1621 doc: /* Read a string in the minibuffer, with completion.
a1f17501 1622PROMPT is a string to prompt with; normally it ends in a colon and a space.
b0c138ce 1623TABLE can be an list of strings, an alist, an obarray or a hash table.
a1f17501
PJ
1624TABLE can also be a function to do the completion itself.
1625PREDICATE limits completion to a subset of TABLE.
1626See `try-completion' and `all-completions' for more details
1627 on completion, TABLE, and PREDICATE.
1628
1629If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
1630 the input is (or completes to) an element of TABLE or is null.
345c105f 1631 If it is also not t, typing RET does not exit if it does non-null completion.
b0c138ce
LT
1632If the input is null, `completing-read' returns DEF, or an empty string
1633 if DEF is nil, regardless of the value of REQUIRE-MATCH.
1634
1635If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1636 with point positioned at the end.
1637 If it is (STRING . POSITION), the initial input is STRING, but point
1638 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1639 that this is different from `read-from-minibuffer' and related
1640 functions, which use one-indexing for POSITION.) This feature is
1641 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1642 default value DEF instead. The user can yank the default value into
1643 the minibuffer easily using \\[next-history-element].
1644
1645HIST, if non-nil, specifies a history list and optionally the initial
1646 position in the list. It can be a symbol, which is the history list
1647 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1648 that case, HISTVAR is the history list variable to use, and HISTPOS
1649 is the initial position (the position in the list used by the
1650 minibuffer history commands). For consistency, you should also
1651 specify that element of the history as the value of
1fb101f3 1652 INITIAL-INPUT. (This is the only case in which you should use
b0c138ce
LT
1653 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1654 1 at the beginning of the list. The variable `history-length'
1655 controls the maximum length of a history list.
38668f81 1656
a1f17501
PJ
1657DEF, if non-nil, is the default value.
1658
1659If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
029a305c 1660 the current input method and the setting of `enable-multibyte-characters'.
a1f17501
PJ
1661
1662Completion ignores case if the ambient value of
af52c32d
MB
1663 `completion-ignore-case' is non-nil. */)
1664 (prompt, table, predicate, require_match, initial_input, hist, def, inherit_input_method)
d43f85c2
RS
1665 Lisp_Object prompt, table, predicate, require_match, initial_input;
1666 Lisp_Object hist, def, inherit_input_method;
f927c5ae 1667{
86408abd
LT
1668 Lisp_Object val, histvar, histpos, position;
1669 Lisp_Object init;
1670 int pos = 0;
aed13378 1671 int count = SPECPDL_INDEX ();
0c8ee1a2
RS
1672 struct gcpro gcpro1;
1673
86408abd 1674 init = initial_input;
0c8ee1a2
RS
1675 GCPRO1 (def);
1676
f927c5ae 1677 specbind (Qminibuffer_completion_table, table);
7efd36fc 1678 specbind (Qminibuffer_completion_predicate, predicate);
f927c5ae 1679 specbind (Qminibuffer_completion_confirm,
695deb18 1680 EQ (require_match, Qt) ? Qnil : require_match);
f927c5ae 1681 last_exact_completion = Qnil;
770970cb 1682
86408abd
LT
1683 position = Qnil;
1684 if (!NILP (init))
1685 {
1686 if (CONSP (init))
1687 {
1688 position = Fcdr (init);
1689 init = Fcar (init);
1690 }
1691 CHECK_STRING (init);
1692 if (!NILP (position))
1693 {
1694 CHECK_NUMBER (position);
1695 /* Convert to distance from end of input. */
1696 pos = XINT (position) - SCHARS (init);
1697 }
1698 }
1699
7510b296 1700 if (SYMBOLP (hist))
770970cb
RS
1701 {
1702 histvar = hist;
1703 histpos = Qnil;
1704 }
1705 else
1706 {
1707 histvar = Fcar_safe (hist);
1708 histpos = Fcdr_safe (hist);
1709 }
1710 if (NILP (histvar))
1711 histvar = Qminibuffer_history;
1712 if (NILP (histpos))
5a866662 1713 XSETFASTINT (histpos, 0);
770970cb 1714
56a98455 1715 val = read_minibuf (NILP (require_match)
f927c5ae
JB
1716 ? Vminibuffer_local_completion_map
1717 : Vminibuffer_local_must_match_map,
86408abd 1718 init, prompt, make_number (pos), 0,
cee54539 1719 histvar, histpos, def, 0,
da34f64e 1720 !NILP (inherit_input_method), 0);
b9a86585 1721
d5db4077 1722 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (def))
b9a86585
RS
1723 val = def;
1724
0c8ee1a2 1725 RETURN_UNGCPRO (unbind_to (count, val));
f927c5ae
JB
1726}
1727\f
f927c5ae 1728Lisp_Object Fminibuffer_completion_help ();
695deb18 1729Lisp_Object Fassoc_string ();
5d2ca7ae
RS
1730
1731/* Test whether TXT is an exact completion. */
695deb18
SM
1732DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1733 doc: /* Return non-nil if STRING is a valid completion.
1734Takes the same arguments as `all-completions' and `try-completion'.
1735If ALIST is a function, it is called with three arguments:
1736the values STRING, PREDICATE and `lambda'. */)
1737 (string, alist, predicate)
1738 Lisp_Object string, alist, predicate;
5d2ca7ae 1739{
adb0708c 1740 Lisp_Object regexps, tail, tem = Qnil;
85cd4372 1741 int i = 0;
5d2ca7ae 1742
695deb18
SM
1743 CHECK_STRING (string);
1744
1745 if ((CONSP (alist) && (!SYMBOLP (XCAR (alist)) || NILP (XCAR (alist))))
1746 || NILP (alist))
1747 {
1748 tem = Fassoc_string (string, alist, completion_ignore_case ? Qt : Qnil);
85cd4372 1749 if NILP (tem)
695deb18
SM
1750 return Qnil;
1751 }
1752 else if (VECTORP (alist))
5d2ca7ae 1753 {
695deb18
SM
1754 /* Bypass intern-soft as that loses for nil. */
1755 tem = oblookup (alist,
d5db4077
KR
1756 SDATA (string),
1757 SCHARS (string),
1758 SBYTES (string));
44472c88 1759 if (!SYMBOLP (tem))
9404446f 1760 {
695deb18
SM
1761 if (STRING_MULTIBYTE (string))
1762 string = Fstring_make_unibyte (string);
9404446f 1763 else
695deb18 1764 string = Fstring_make_multibyte (string);
9404446f 1765
adb0708c 1766 tem = oblookup (alist,
d5db4077
KR
1767 SDATA (string),
1768 SCHARS (string),
1769 SBYTES (string));
9404446f 1770 }
adb0708c
LT
1771
1772 if (completion_ignore_case && !SYMBOLP (tem))
1773 {
1774 for (i = XVECTOR (alist)->size - 1; i >= 0; i--)
1775 {
1776 tail = XVECTOR (alist)->contents[i];
1777 if (SYMBOLP (tail))
1778 while (1)
1779 {
1780 if (EQ((Fcompare_strings (string, make_number (0), Qnil,
1781 Fsymbol_name (tail),
1782 make_number (0) , Qnil, Qt)),
1783 Qt))
1784 {
1785 tem = tail;
1786 break;
1787 }
1788 if (XSYMBOL (tail)->next == 0)
1789 break;
1790 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1791 }
1792 }
1793 }
1794
1795 if (!SYMBOLP (tem))
1796 return Qnil;
5d2ca7ae 1797 }
85cd4372
SM
1798 else if (HASH_TABLE_P (alist))
1799 {
adb0708c
LT
1800 struct Lisp_Hash_Table *h = XHASH_TABLE (alist);
1801 i = hash_lookup (h, string, NULL);
85cd4372 1802 if (i >= 0)
adb0708c 1803 tem = HASH_KEY (h, i);
85cd4372 1804 else
adb0708c
LT
1805 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1806 if (!NILP (HASH_HASH (h, i)) &&
1807 EQ (Fcompare_strings (string, make_number (0), Qnil,
1808 HASH_KEY (h, i), make_number (0) , Qnil,
1809 completion_ignore_case ? Qt : Qnil),
1810 Qt))
1811 {
1812 tem = HASH_KEY (h, i);
1813 break;
1814 }
1815 if (!STRINGP (tem))
85cd4372
SM
1816 return Qnil;
1817 }
5d2ca7ae 1818 else
695deb18
SM
1819 return call3 (alist, string, predicate, Qlambda);
1820
1821 /* Reject this element if it fails to match all the regexps. */
77443789
AS
1822 if (CONSP (Vcompletion_regexp_list))
1823 {
1824 int count = SPECPDL_INDEX ();
1825 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1826 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1827 regexps = XCDR (regexps))
1828 {
1829 if (NILP (Fstring_match (XCAR (regexps),
1830 SYMBOLP (tem) ? string : tem,
1831 Qnil)))
1832 return unbind_to (count, Qnil);
1833 }
1834 unbind_to (count, Qnil);
1835 }
695deb18
SM
1836
1837 /* Finally, check the predicate. */
1838 if (!NILP (predicate))
b0c138ce
LT
1839 {
1840 return HASH_TABLE_P (alist)
1841 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (alist), i))
1842 : call1 (predicate, tem);
1843 }
695deb18
SM
1844 else
1845 return Qt;
5d2ca7ae 1846}
f927c5ae
JB
1847
1848/* returns:
1849 * 0 no possible completion
1850 * 1 was already an exact and unique completion
1851 * 3 was already an exact completion
1852 * 4 completed to an exact completion
1853 * 5 some completion happened
1854 * 6 no completion happened
1855 */
1856int
1857do_completion ()
1858{
0c80756e 1859 Lisp_Object completion, string, tem;
f927c5ae
JB
1860 int completedp;
1861 Lisp_Object last;
1e00c2ff 1862 struct gcpro gcpro1, gcpro2;
f927c5ae 1863
1011edb5 1864 completion = Ftry_completion (minibuffer_completion_contents (),
8e9968c6 1865 Vminibuffer_completion_table,
f927c5ae
JB
1866 Vminibuffer_completion_predicate);
1867 last = last_exact_completion;
1868 last_exact_completion = Qnil;
1869
4f9b95e5
KH
1870 GCPRO2 (completion, last);
1871
56a98455 1872 if (NILP (completion))
f927c5ae
JB
1873 {
1874 bitch_at_user ();
805221da 1875 temp_echo_area_glyphs (build_string (" [No match]"));
1e00c2ff 1876 UNGCPRO;
f927c5ae
JB
1877 return 0;
1878 }
1879
1880 if (EQ (completion, Qt)) /* exact and unique match */
1e00c2ff
KH
1881 {
1882 UNGCPRO;
1883 return 1;
1884 }
f927c5ae 1885
1011edb5 1886 string = minibuffer_completion_contents ();
0c80756e
MB
1887
1888 /* COMPLETEDP should be true if some completion was done, which
1889 doesn't include simply changing the case of the entered string.
1890 However, for appearance, the string is rewritten if the case
1891 changes. */
1892 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qt);
01cce3e7 1893 completedp = !EQ (tem, Qt);
0c80756e 1894
7892a68b
KH
1895 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qnil);
1896 if (!EQ (tem, Qt))
0c80756e 1897 /* Rewrite the user's input. */
f927c5ae 1898 {
1011edb5
RS
1899 int prompt_end = XINT (Fminibuffer_prompt_end ());
1900 /* Some completion happened */
1901
1902 if (! NILP (Vminibuffer_completing_file_name)
d5db4077 1903 && SREF (completion, SBYTES (completion) - 1) == '/'
1011edb5
RS
1904 && PT < ZV
1905 && FETCH_CHAR (PT_BYTE) == '/')
1906 {
1907 del_range (prompt_end, PT + 1);
1908 }
1909 else
1910 del_range (prompt_end, PT);
1911
f927c5ae 1912 Finsert (1, &completion);
6e69ab8c
MB
1913
1914 if (! completedp)
1915 /* The case of the string changed, but that's all. We're not
1916 sure whether this is a unique completion or not, so try again
1917 using the real case (this shouldn't recurse again, because
1918 the next time try-completion will return either `t' or the
1919 exact string). */
1920 {
1921 UNGCPRO;
1922 return do_completion ();
1923 }
f927c5ae
JB
1924 }
1925
1926 /* It did find a match. Do we match some possibility exactly now? */
695deb18
SM
1927 tem = Ftest_completion (Fminibuffer_contents (),
1928 Vminibuffer_completion_table,
1929 Vminibuffer_completion_predicate);
56a98455 1930 if (NILP (tem))
1e00c2ff
KH
1931 {
1932 /* not an exact match */
1933 UNGCPRO;
f927c5ae
JB
1934 if (completedp)
1935 return 5;
739cc391 1936 else if (!NILP (Vcompletion_auto_help))
f927c5ae
JB
1937 Fminibuffer_completion_help ();
1938 else
805221da 1939 temp_echo_area_glyphs (build_string (" [Next char not unique]"));
f927c5ae
JB
1940 return 6;
1941 }
1942 else if (completedp)
1e00c2ff
KH
1943 {
1944 UNGCPRO;
1945 return 4;
1946 }
f927c5ae
JB
1947 /* If the last exact completion and this one were the same,
1948 it means we've already given a "Complete but not unique"
52b14ac0 1949 message and the user's hit TAB again, so now we give him help. */
f927c5ae 1950 last_exact_completion = completion;
56a98455 1951 if (!NILP (last))
f927c5ae 1952 {
1011edb5 1953 tem = minibuffer_completion_contents ();
56a98455 1954 if (!NILP (Fequal (tem, last)))
f927c5ae
JB
1955 Fminibuffer_completion_help ();
1956 }
1e00c2ff 1957 UNGCPRO;
f927c5ae 1958 return 3;
f927c5ae 1959}
1e00c2ff 1960
52b14ac0
JB
1961/* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1962
695deb18
SM
1963DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1964 doc: /* Like `assoc' but specifically for strings.
1965Unibyte strings are converted to multibyte for comparison.
1966And case is ignored if CASE-FOLD is non-nil.
1967As opposed to `assoc', it will also match an entry consisting of a single
1968string rather than a cons cell whose car is a string. */)
1969 (key, list, case_fold)
52b14ac0 1970 register Lisp_Object key;
695deb18 1971 Lisp_Object list, case_fold;
52b14ac0
JB
1972{
1973 register Lisp_Object tail;
1974
56a98455 1975 for (tail = list; !NILP (tail); tail = Fcdr (tail))
52b14ac0
JB
1976 {
1977 register Lisp_Object elt, tem, thiscar;
1978 elt = Fcar (tail);
695deb18 1979 thiscar = CONSP (elt) ? XCAR (elt) : elt;
7510b296 1980 if (!STRINGP (thiscar))
52b14ac0 1981 continue;
9404446f
RS
1982 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1983 key, make_number (0), Qnil,
695deb18 1984 case_fold);
9404446f
RS
1985 if (EQ (tem, Qt))
1986 return elt;
52b14ac0
JB
1987 QUIT;
1988 }
1989 return Qnil;
1990}
f927c5ae
JB
1991
1992DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
af52c32d 1993 doc: /* Complete the minibuffer contents as far as possible.
a1f17501
PJ
1994Return nil if there is no valid completion, else t.
1995If no characters can be completed, display a list of possible completions.
1996If you repeat this command after it displayed such a list,
af52c32d
MB
1997scroll the window of possible completions. */)
1998 ()
f927c5ae 1999{
2cb6da5c
RS
2000 register int i;
2001 Lisp_Object window, tem;
2002
df902b62
RS
2003 /* If the previous command was not this,
2004 mark the completion buffer obsolete. */
2005 if (! EQ (current_kboard->Vlast_command, Vthis_command))
2cb6da5c
RS
2006 Vminibuf_scroll_window = Qnil;
2007
2008 window = Vminibuf_scroll_window;
2009 /* If there's a fresh completion window with a live buffer,
2010 and this command is repeated, scroll that window. */
2011 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
2012 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
2013 {
2014 struct buffer *obuf = current_buffer;
2015
2016 Fset_buffer (XWINDOW (window)->buffer);
7d7c3861 2017 tem = Fpos_visible_in_window_p (make_number (ZV), window, Qnil);
2cb6da5c
RS
2018 if (! NILP (tem))
2019 /* If end is in view, scroll up to the beginning. */
b7df898e 2020 Fset_window_start (window, make_number (BEGV), Qnil);
2cb6da5c
RS
2021 else
2022 /* Else scroll down one screen. */
2023 Fscroll_other_window (Qnil);
2024
2025 set_buffer_internal (obuf);
2026 return Qnil;
2027 }
2028
2029 i = do_completion ();
f927c5ae
JB
2030 switch (i)
2031 {
2032 case 0:
2033 return Qnil;
2034
2035 case 1:
a1c5aa96
GM
2036 if (PT != ZV)
2037 Fgoto_char (make_number (ZV));
805221da 2038 temp_echo_area_glyphs (build_string (" [Sole completion]"));
f927c5ae
JB
2039 break;
2040
2041 case 3:
9994cc69
GM
2042 if (PT != ZV)
2043 Fgoto_char (make_number (ZV));
805221da 2044 temp_echo_area_glyphs (build_string (" [Complete, but not unique]"));
f927c5ae
JB
2045 break;
2046 }
2047
2048 return Qt;
2049}
e4c97a67
RS
2050\f
2051/* Subroutines of Fminibuffer_complete_and_exit. */
2052
2053/* This one is called by internal_condition_case to do the real work. */
2054
2055Lisp_Object
2056complete_and_exit_1 ()
2057{
2058 return make_number (do_completion ());
2059}
2060
2061/* This one is called by internal_condition_case if an error happens.
2062 Pretend the current value is an exact match. */
2063
2064Lisp_Object
2065complete_and_exit_2 (ignore)
2066 Lisp_Object ignore;
2067{
2068 return make_number (1);
2069}
f927c5ae
JB
2070
2071DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
94c7167b 2072 Sminibuffer_complete_and_exit, 0, 0, "",
af52c32d 2073 doc: /* If the minibuffer contents is a valid completion then exit.
a1f17501 2074Otherwise try to complete it. If completion leads to a valid completion,
af52c32d
MB
2075a repetition of this command will exit. */)
2076 ()
f927c5ae
JB
2077{
2078 register int i;
e4c97a67 2079 Lisp_Object val;
f927c5ae
JB
2080
2081 /* Allow user to specify null string */
a346ec72 2082 if (XINT (Fminibuffer_prompt_end ()) == ZV)
f927c5ae
JB
2083 goto exit;
2084
36baf3b7
RS
2085 val = Fminibuffer_contents ();
2086 if (!NILP (Ftest_completion (val,
695deb18
SM
2087 Vminibuffer_completion_table,
2088 Vminibuffer_completion_predicate)))
36baf3b7
RS
2089 {
2090 if (completion_ignore_case)
2091 { /* Fixup case of the field, if necessary. */
2092 Lisp_Object compl
2093 = Ftry_completion (val,
2094 Vminibuffer_completion_table,
2095 Vminibuffer_completion_predicate);
2096 if (STRINGP (compl)
2097 /* If it weren't for this piece of paranoia, I'd replace
2098 the whole thing with a call to do_completion. */
2099 && EQ (Flength (val), Flength (compl)))
2100 {
2101 del_range (XINT (Fminibuffer_prompt_end ()), ZV);
2102 Finsert (1, &compl);
2103 }
2104 }
2105 goto exit;
2106 }
2107
e4c97a67 2108 /* Call do_completion, but ignore errors. */
8db426c7 2109 SET_PT (ZV);
e4c97a67
RS
2110 val = internal_condition_case (complete_and_exit_1, Qerror,
2111 complete_and_exit_2);
2112
2113 i = XFASTINT (val);
f927c5ae
JB
2114 switch (i)
2115 {
2116 case 1:
2117 case 3:
2118 goto exit;
2119
2120 case 4:
56a98455 2121 if (!NILP (Vminibuffer_completion_confirm))
f927c5ae 2122 {
805221da 2123 temp_echo_area_glyphs (build_string (" [Confirm]"));
f927c5ae
JB
2124 return Qnil;
2125 }
2126 else
2127 goto exit;
2128
2129 default:
2130 return Qnil;
2131 }
2132 exit:
6bbd7a29 2133 return Fthrow (Qexit, Qnil);
f927c5ae
JB
2134 /* NOTREACHED */
2135}
2136
2137DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
94c7167b 2138 0, 0, "",
af52c32d 2139 doc: /* Complete the minibuffer contents at most a single word.
a1f17501
PJ
2140After one word is completed as much as possible, a space or hyphen
2141is added, provided that matches some possible completion.
af52c32d
MB
2142Return nil if there is no valid completion, else t. */)
2143 ()
f927c5ae 2144{
69f4ef20 2145 Lisp_Object completion, tem, tem1;
af2b7cd5 2146 register int i, i_byte;
27883fdd 2147 register const unsigned char *completion_string;
d7be4211 2148 struct gcpro gcpro1, gcpro2;
1011edb5 2149 int prompt_end_charpos = XINT (Fminibuffer_prompt_end ());
b278606c
BF
2150
2151 /* We keep calling Fbuffer_string rather than arrange for GC to
2152 hold onto a pointer to one of the strings thus made. */
f927c5ae 2153
1011edb5 2154 completion = Ftry_completion (minibuffer_completion_contents (),
f927c5ae
JB
2155 Vminibuffer_completion_table,
2156 Vminibuffer_completion_predicate);
56a98455 2157 if (NILP (completion))
f927c5ae
JB
2158 {
2159 bitch_at_user ();
805221da 2160 temp_echo_area_glyphs (build_string (" [No match]"));
f927c5ae
JB
2161 return Qnil;
2162 }
2163 if (EQ (completion, Qt))
2164 return Qnil;
2165
b278606c 2166#if 0 /* How the below code used to look, for reference. */
a346ec72 2167 tem = Fminibuffer_contents ();
d5db4077
KR
2168 b = SDATA (tem);
2169 i = ZV - 1 - SCHARS (completion);
2170 p = SDATA (completion);
f927c5ae
JB
2171 if (i > 0 ||
2172 0 <= scmp (b, p, ZV - 1))
2173 {
2174 i = 1;
2175 /* Set buffer to longest match of buffer tail and completion head. */
2176 while (0 <= scmp (b + i, p, ZV - 1 - i))
2177 i++;
2178 del_range (1, i + 1);
2179 SET_PT (ZV);
2180 }
2181#else /* Rewritten code */
2182 {
69f4ef20 2183 int buffer_nchars, completion_nchars;
f927c5ae 2184
b7826503 2185 CHECK_STRING (completion);
1011edb5 2186 tem = minibuffer_completion_contents ();
d7be4211 2187 GCPRO2 (completion, tem);
719b4a40
RS
2188 /* If reading a file name,
2189 expand any $ENVVAR refs in the buffer and in TEM. */
ccf330a6 2190 if (! NILP (Vminibuffer_completing_file_name))
719b4a40
RS
2191 {
2192 Lisp_Object substituted;
2193 substituted = Fsubstitute_in_file_name (tem);
2194 if (! EQ (substituted, tem))
2195 {
2196 tem = substituted;
1011edb5
RS
2197 del_range (prompt_end_charpos, PT);
2198 Finsert (1, &tem);
719b4a40
RS
2199 }
2200 }
d5db4077
KR
2201 buffer_nchars = SCHARS (tem); /* # chars in what we completed. */
2202 completion_nchars = SCHARS (completion);
69f4ef20
RS
2203 i = buffer_nchars - completion_nchars;
2204 if (i > 0
2205 ||
2206 (tem1 = Fcompare_strings (tem, make_number (0),
2207 make_number (buffer_nchars),
2208 completion, make_number (0),
2209 make_number (buffer_nchars),
2210 completion_ignore_case ? Qt : Qnil),
2211 ! EQ (tem1, Qt)))
f927c5ae 2212 {
69f4ef20
RS
2213 int start_pos;
2214
1011edb5
RS
2215 /* Make buffer (before point) contain the longest match
2216 of TEM's tail and COMPLETION's head. */
69f4ef20
RS
2217 if (i <= 0) i = 1;
2218 start_pos= i;
2219 buffer_nchars -= i;
669c6673 2220 while (i > 0)
69f4ef20 2221 {
669c6673 2222 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
69f4ef20
RS
2223 completion, make_number (0),
2224 make_number (buffer_nchars),
2225 completion_ignore_case ? Qt : Qnil);
2226 start_pos++;
2227 if (EQ (tem1, Qt))
2228 break;
2229 i++;
669c6673 2230 buffer_nchars--;
69f4ef20 2231 }
4f9f637a 2232 del_range (start_pos, start_pos + buffer_nchars);
f927c5ae 2233 }
d7be4211 2234 UNGCPRO;
f927c5ae
JB
2235 }
2236#endif /* Rewritten code */
9ab4a725 2237
279cf52c 2238 {
8e9968c6 2239 int prompt_end_bytepos;
279cf52c 2240 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
1011edb5
RS
2241 i = PT - prompt_end_charpos;
2242 i_byte = PT_BYTE - prompt_end_bytepos;
279cf52c 2243 }
f927c5ae
JB
2244
2245 /* If completion finds next char not unique,
b278606c 2246 consider adding a space or a hyphen. */
d5db4077 2247 if (i == SCHARS (completion))
f927c5ae 2248 {
b278606c 2249 GCPRO1 (completion);
1011edb5
RS
2250 tem = Ftry_completion (concat2 (minibuffer_completion_contents (),
2251 build_string (" ")),
f927c5ae
JB
2252 Vminibuffer_completion_table,
2253 Vminibuffer_completion_predicate);
b278606c
BF
2254 UNGCPRO;
2255
7510b296 2256 if (STRINGP (tem))
f927c5ae
JB
2257 completion = tem;
2258 else
2259 {
b278606c
BF
2260 GCPRO1 (completion);
2261 tem =
1011edb5
RS
2262 Ftry_completion (concat2 (minibuffer_completion_contents (),
2263 build_string ("-")),
b278606c
BF
2264 Vminibuffer_completion_table,
2265 Vminibuffer_completion_predicate);
2266 UNGCPRO;
2267
7510b296 2268 if (STRINGP (tem))
f927c5ae
JB
2269 completion = tem;
2270 }
9ab4a725 2271 }
f927c5ae
JB
2272
2273 /* Now find first word-break in the stuff found by completion.
2274 i gets index in string of where to stop completing. */
d50a3d2a
KH
2275 {
2276 int len, c;
d5db4077
KR
2277 int bytes = SBYTES (completion);
2278 completion_string = SDATA (completion);
2279 for (; i_byte < SBYTES (completion); i_byte += len, i++)
d50a3d2a 2280 {
af2b7cd5 2281 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
54643b2c 2282 bytes - i_byte,
d50a3d2a
KH
2283 len);
2284 if (SYNTAX (c) != Sword)
2285 {
af2b7cd5
RS
2286 i_byte += len;
2287 i++;
d50a3d2a
KH
2288 break;
2289 }
2290 }
2291 }
f927c5ae
JB
2292
2293 /* If got no characters, print help for user. */
2294
1011edb5 2295 if (i == PT - prompt_end_charpos)
f927c5ae 2296 {
739cc391 2297 if (!NILP (Vcompletion_auto_help))
f927c5ae
JB
2298 Fminibuffer_completion_help ();
2299 return Qnil;
2300 }
2301
2302 /* Otherwise insert in minibuffer the chars we got */
2303
1011edb5 2304 if (! NILP (Vminibuffer_completing_file_name)
d5db4077 2305 && SREF (completion, SBYTES (completion) - 1) == '/'
1011edb5
RS
2306 && PT < ZV
2307 && FETCH_CHAR (PT_BYTE) == '/')
2308 {
2309 del_range (prompt_end_charpos, PT + 1);
2310 }
2311 else
2312 del_range (prompt_end_charpos, PT);
2313
af2b7cd5 2314 insert_from_string (completion, 0, 0, i, i_byte, 1);
f927c5ae
JB
2315 return Qt;
2316}
2317\f
2318DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
2319 1, 1, 0,
af52c32d 2320 doc: /* Display the list of completions, COMPLETIONS, using `standard-output'.
a1f17501
PJ
2321Each element may be just a symbol or string
2322or may be a list of two strings to be printed as if concatenated.
b0c138ce
LT
2323If it is a list of two strings, the first is the actual completion
2324alternative, the second serves as annotation.
a1f17501
PJ
2325`standard-output' must be a buffer.
2326The actual completion alternatives, as inserted, are given `mouse-face'
2327properties of `highlight'.
2328At the end, this runs the normal hook `completion-setup-hook'.
af52c32d
MB
2329It can find the completion buffer in `standard-output'. */)
2330 (completions)
f927c5ae
JB
2331 Lisp_Object completions;
2332{
dae36123 2333 Lisp_Object tail, elt;
f927c5ae 2334 register int i;
2dc2b736 2335 int column = 0;
dae36123 2336 struct gcpro gcpro1, gcpro2;
2dc2b736 2337 struct buffer *old = current_buffer;
681f5af4 2338 int first = 1;
486cc7fb
RS
2339
2340 /* Note that (when it matters) every variable
dae36123
RS
2341 points to a non-string that is pointed to by COMPLETIONS,
2342 except for ELT. ELT can be pointing to a string
2343 when terpri or Findent_to calls a change hook. */
2344 elt = Qnil;
2345 GCPRO2 (completions, elt);
486cc7fb 2346
7510b296 2347 if (BUFFERP (Vstandard_output))
2dc2b736 2348 set_buffer_internal (XBUFFER (Vstandard_output));
f927c5ae 2349
56a98455 2350 if (NILP (completions))
cfc736bf
RS
2351 write_string ("There are no possible completions of what you have typed.",
2352 -1);
f927c5ae
JB
2353 else
2354 {
2dc2b736 2355 write_string ("Possible completions are:", -1);
56a98455 2356 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
f927c5ae 2357 {
ec067ec7 2358 Lisp_Object tem, string;
681f5af4 2359 int length;
47d7d104 2360 Lisp_Object startpos, endpos;
681f5af4 2361
6bbd7a29
GM
2362 startpos = Qnil;
2363
681f5af4 2364 elt = Fcar (tail);
b0c138ce
LT
2365 if (SYMBOLP (elt))
2366 elt = SYMBOL_NAME (elt);
681f5af4
RS
2367 /* Compute the length of this element. */
2368 if (CONSP (elt))
2369 {
49db96ce 2370 tem = XCAR (elt);
b7826503 2371 CHECK_STRING (tem);
d5db4077 2372 length = SCHARS (tem);
681f5af4 2373
49db96ce 2374 tem = Fcar (XCDR (elt));
b7826503 2375 CHECK_STRING (tem);
d5db4077 2376 length += SCHARS (tem);
681f5af4
RS
2377 }
2378 else
2379 {
b7826503 2380 CHECK_STRING (elt);
d5db4077 2381 length = SCHARS (elt);
681f5af4
RS
2382 }
2383
2384 /* This does a bad job for narrower than usual windows.
2385 Sadly, the window it will appear in is not known
2386 until after the text has been made. */
2387
47d7d104
RS
2388 if (BUFFERP (Vstandard_output))
2389 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2390
681f5af4
RS
2391 /* If the previous completion was very wide,
2392 or we have two on this line already,
2393 don't put another on the same line. */
2394 if (column > 33 || first
2395 /* If this is really wide, don't put it second on a line. */
13c67cc6 2396 || (column > 0 && length > 45))
681f5af4
RS
2397 {
2398 Fterpri (Qnil);
2399 column = 0;
2400 }
2401 /* Otherwise advance to column 35. */
2402 else
2dc2b736 2403 {
7510b296 2404 if (BUFFERP (Vstandard_output))
681f5af4
RS
2405 {
2406 tem = Findent_to (make_number (35), make_number (2));
9ab4a725 2407
681f5af4
RS
2408 column = XINT (tem);
2409 }
2dc2b736
RS
2410 else
2411 {
2412 do
2413 {
2414 write_string (" ", -1);
2415 column++;
2416 }
2417 while (column < 35);
2418 }
2419 }
681f5af4 2420
47d7d104
RS
2421 if (BUFFERP (Vstandard_output))
2422 {
2423 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2424 Fset_text_properties (startpos, endpos,
2425 Qnil, Vstandard_output);
2426 }
2427
ec067ec7 2428 /* Output this element.
9404446f 2429 If necessary, convert it to unibyte or to multibyte first. */
f927c5ae 2430 if (CONSP (elt))
ec067ec7 2431 string = Fcar (elt);
f927c5ae 2432 else
ec067ec7
RS
2433 string = elt;
2434 if (NILP (current_buffer->enable_multibyte_characters)
2435 && STRING_MULTIBYTE (string))
2436 string = Fstring_make_unibyte (string);
9404446f
RS
2437 else if (!NILP (current_buffer->enable_multibyte_characters)
2438 && !STRING_MULTIBYTE (string))
2439 string = Fstring_make_multibyte (string);
5744fa7c
RS
2440
2441 if (BUFFERP (Vstandard_output))
2442 {
4b37311e 2443 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
5744fa7c
RS
2444
2445 Fprinc (string, Qnil);
2446
4b37311e 2447 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
5744fa7c 2448
4b37311e 2449 Fput_text_property (startpos, endpos,
5744fa7c
RS
2450 Qmouse_face, intern ("highlight"),
2451 Vstandard_output);
2452 }
2453 else
2454 {
2455 Fprinc (string, Qnil);
2456 }
ec067ec7
RS
2457
2458 /* Output the annotation for this element. */
2459 if (CONSP (elt))
4b37311e
RS
2460 {
2461 if (BUFFERP (Vstandard_output))
2462 {
2463 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2464
2465 Fprinc (Fcar (Fcdr (elt)), Qnil);
2466
2467 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2468
2469 Fset_text_properties (startpos, endpos, Qnil,
2470 Vstandard_output);
2471 }
2472 else
2473 {
2474 Fprinc (Fcar (Fcdr (elt)), Qnil);
2475 }
2476 }
2477
681f5af4 2478
ec067ec7 2479 /* Update COLUMN for what we have output. */
681f5af4
RS
2480 column += length;
2481
2482 /* If output is to a buffer, recompute COLUMN in a way
2483 that takes account of character widths. */
2484 if (BUFFERP (Vstandard_output))
2dc2b736 2485 {
681f5af4
RS
2486 tem = Fcurrent_column ();
2487 column = XINT (tem);
2dc2b736 2488 }
681f5af4
RS
2489
2490 first = 0;
f927c5ae
JB
2491 }
2492 }
2dc2b736 2493
486cc7fb
RS
2494 UNGCPRO;
2495
7510b296 2496 if (BUFFERP (Vstandard_output))
2d7e41fe
RS
2497 set_buffer_internal (old);
2498
cfc736bf
RS
2499 if (!NILP (Vrun_hooks))
2500 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2501
f927c5ae
JB
2502 return Qnil;
2503}
2504
2505DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
94c7167b 2506 0, 0, "",
af52c32d
MB
2507 doc: /* Display a list of possible completions of the current minibuffer contents. */)
2508 ()
f927c5ae
JB
2509{
2510 Lisp_Object completions;
2511
2512 message ("Making completion list...");
1011edb5 2513 completions = Fall_completions (minibuffer_completion_contents (),
f927c5ae 2514 Vminibuffer_completion_table,
89a255dc
RS
2515 Vminibuffer_completion_predicate,
2516 Qt);
39e98b38 2517 clear_message (1, 0);
f927c5ae 2518
56a98455 2519 if (NILP (completions))
f927c5ae
JB
2520 {
2521 bitch_at_user ();
805221da 2522 temp_echo_area_glyphs (build_string (" [No completions]"));
f927c5ae
JB
2523 }
2524 else
2525 internal_with_output_to_temp_buffer ("*Completions*",
2526 Fdisplay_completion_list,
2527 Fsort (completions, Qstring_lessp));
2528 return Qnil;
2529}
2530\f
2531DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
af52c32d
MB
2532 doc: /* Terminate minibuffer input. */)
2533 ()
f927c5ae 2534{
7510b296 2535 if (INTEGERP (last_command_char))
dab3ab3c 2536 internal_self_insert (XINT (last_command_char), 0);
f927c5ae
JB
2537 else
2538 bitch_at_user ();
2539
6bbd7a29 2540 return Fthrow (Qexit, Qnil);
f927c5ae
JB
2541}
2542
2543DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
af52c32d
MB
2544 doc: /* Terminate this minibuffer argument. */)
2545 ()
f927c5ae 2546{
6bbd7a29 2547 return Fthrow (Qexit, Qnil);
f927c5ae
JB
2548}
2549
2550DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
af52c32d
MB
2551 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
2552 ()
f927c5ae
JB
2553{
2554 return make_number (minibuf_level);
2555}
2556
37e9a934 2557DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
af52c32d
MB
2558 doc: /* Return the prompt string of the currently-active minibuffer.
2559If no minibuffer is active, return nil. */)
2560 ()
37e9a934 2561{
4d04c1f1 2562 return Fcopy_sequence (minibuf_prompt);
37e9a934
KH
2563}
2564
f927c5ae 2565\f
805221da 2566/* Temporarily display STRING at the end of the current
2d955a50
RS
2567 minibuffer contents. This is used to display things like
2568 "[No Match]" when the user requests a completion for a prefix
2569 that has no possible completions, and other quick, unobtrusive
2570 messages. */
2571
9d815fd9 2572void
805221da
KH
2573temp_echo_area_glyphs (string)
2574 Lisp_Object string;
2d955a50
RS
2575{
2576 int osize = ZV;
a9c26562 2577 int osize_byte = ZV_BYTE;
2d955a50 2578 int opoint = PT;
a9c26562 2579 int opoint_byte = PT_BYTE;
2d955a50
RS
2580 Lisp_Object oinhibit;
2581 oinhibit = Vinhibit_quit;
2582
2583 /* Clear out any old echo-area message to make way for our new thing. */
2584 message (0);
2585
a9c26562 2586 SET_PT_BOTH (osize, osize_byte);
805221da 2587 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), 0);
a9c26562 2588 SET_PT_BOTH (opoint, opoint_byte);
2d955a50
RS
2589 Vinhibit_quit = Qt;
2590 Fsit_for (make_number (2), Qnil, Qnil);
bc69581b 2591 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
a9c26562 2592 SET_PT_BOTH (opoint, opoint_byte);
2d955a50
RS
2593 if (!NILP (Vquit_flag))
2594 {
2595 Vquit_flag = Qnil;
2596 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2597 }
2598 Vinhibit_quit = oinhibit;
2599}
2600
2601DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
94c7167b 2602 1, 1, 0,
af52c32d 2603 doc: /* Temporarily display STRING at the end of the minibuffer.
a1f17501 2604The text is displayed for two seconds,
af52c32d
MB
2605or until the next input event arrives, whichever comes first. */)
2606 (string)
2d955a50
RS
2607 Lisp_Object string;
2608{
1a9e275b 2609 CHECK_STRING (string);
805221da 2610 temp_echo_area_glyphs (string);
2d955a50
RS
2611 return Qnil;
2612}
2613\f
9d815fd9 2614void
f927c5ae
JB
2615init_minibuf_once ()
2616{
2617 Vminibuffer_list = Qnil;
2618 staticpro (&Vminibuffer_list);
2619}
2620
9d815fd9 2621void
f927c5ae
JB
2622syms_of_minibuf ()
2623{
2624 minibuf_level = 0;
4d04c1f1
KH
2625 minibuf_prompt = Qnil;
2626 staticpro (&minibuf_prompt);
2627
2628 minibuf_save_list = Qnil;
2629 staticpro (&minibuf_save_list);
f927c5ae 2630
719b4a40
RS
2631 Qread_file_name_internal = intern ("read-file-name-internal");
2632 staticpro (&Qread_file_name_internal);
2633
e5d4686b
RS
2634 Qminibuffer_default = intern ("minibuffer-default");
2635 staticpro (&Qminibuffer_default);
2636 Fset (Qminibuffer_default, Qnil);
2637
f927c5ae
JB
2638 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2639 staticpro (&Qminibuffer_completion_table);
2640
2641 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2642 staticpro (&Qminibuffer_completion_confirm);
2643
2644 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2645 staticpro (&Qminibuffer_completion_predicate);
2646
1e00c2ff
KH
2647 staticpro (&last_exact_completion);
2648 last_exact_completion = Qnil;
2649
f927c5ae
JB
2650 staticpro (&last_minibuf_string);
2651 last_minibuf_string = Qnil;
2652
2653 Quser_variable_p = intern ("user-variable-p");
2654 staticpro (&Quser_variable_p);
2655
770970cb
RS
2656 Qminibuffer_history = intern ("minibuffer-history");
2657 staticpro (&Qminibuffer_history);
f927c5ae 2658
406e55df
RS
2659 Qbuffer_name_history = intern ("buffer-name-history");
2660 staticpro (&Qbuffer_name_history);
33d0a17f 2661 Fset (Qbuffer_name_history, Qnil);
406e55df 2662
5c781212
RS
2663 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2664 staticpro (&Qminibuffer_setup_hook);
2665
177aecf9
KH
2666 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2667 staticpro (&Qminibuffer_exit_hook);
2668
77aa8edf
RS
2669 Qhistory_length = intern ("history-length");
2670 staticpro (&Qhistory_length);
2671
cee54539
KH
2672 Qcurrent_input_method = intern ("current-input-method");
2673 staticpro (&Qcurrent_input_method);
2674
2675 Qactivate_input_method = intern ("activate-input-method");
2676 staticpro (&Qactivate_input_method);
2677
b0c138ce
LT
2678 Qcase_fold_search = intern ("case-fold-search");
2679 staticpro (&Qcase_fold_search);
2680
af52c32d
MB
2681 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2682 doc: /* If this is non-nil, `read-buffer' does its work by calling this function. */);
eebbfb01
KH
2683 Vread_buffer_function = Qnil;
2684
af52c32d
MB
2685 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2686 doc: /* Normal hook run just after entry to minibuffer. */);
5c781212
RS
2687 Vminibuffer_setup_hook = Qnil;
2688
af52c32d
MB
2689 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2690 doc: /* Normal hook run just after exit from minibuffer. */);
177aecf9
KH
2691 Vminibuffer_exit_hook = Qnil;
2692
af52c32d
MB
2693 DEFVAR_LISP ("history-length", &Vhistory_length,
2694 doc: /* *Maximum length for history lists before truncation takes place.
a1f17501
PJ
2695A number means that length; t means infinite. Truncation takes place
2696just after a new element is inserted. Setting the history-length
2697property of a history variable overrides this default. */);
77aa8edf
RS
2698 XSETFASTINT (Vhistory_length, 30);
2699
0da4d471
JL
2700 DEFVAR_BOOL ("history-delete-duplicates", &history_delete_duplicates,
2701 doc: /* *Non-nil means to delete duplicates in history.
2702If set to t when adding a new history element, all previous identical
2703elements are deleted. */);
2704 history_delete_duplicates = 0;
2705
af52c32d
MB
2706 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help,
2707 doc: /* *Non-nil means automatically provide help for invalid completion input. */);
739cc391 2708 Vcompletion_auto_help = Qt;
f927c5ae 2709
af52c32d 2710 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
75028673
JPW
2711 doc: /* Non-nil means don't consider case significant in completion.
2712
d9a03ad2
RS
2713For file-name completion, the variable `read-file-name-completion-ignore-case'
2714controls the behavior, rather than this variable. */);
f927c5ae
JB
2715 completion_ignore_case = 0;
2716
af52c32d
MB
2717 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2718 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
a1f17501 2719This variable makes a difference whenever the minibuffer window is active. */);
f927c5ae
JB
2720 enable_recursive_minibuffers = 0;
2721
af52c32d
MB
2722 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2723 doc: /* Alist or obarray used for completion in the minibuffer.
b0c138ce
LT
2724This becomes the ALIST argument to `try-completion' and `all-completions'.
2725The value can also be a list of strings or a hash table.
a1f17501
PJ
2726
2727The value may alternatively be a function, which is given three arguments:
2728 STRING, the current buffer contents;
2729 PREDICATE, the predicate for filtering possible matches;
2730 CODE, which says what kind of things to do.
2731CODE can be nil, t or `lambda'.
2732nil means to return the best completion of STRING, or nil if there is none.
2733t means to return a list of all possible completions of STRING.
2734`lambda' means to return t if STRING is a valid completion as it stands. */);
f927c5ae
JB
2735 Vminibuffer_completion_table = Qnil;
2736
af52c32d
MB
2737 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2738 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
f927c5ae
JB
2739 Vminibuffer_completion_predicate = Qnil;
2740
af52c32d 2741 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
fd771ceb 2742 doc: /* Non-nil means to demand confirmation of completion before exiting minibuffer. */);
f927c5ae
JB
2743 Vminibuffer_completion_confirm = Qnil;
2744
ccf330a6 2745 DEFVAR_LISP ("minibuffer-completing-file-name",
af52c32d
MB
2746 &Vminibuffer_completing_file_name,
2747 doc: /* Non-nil means completing file names. */);
ccf330a6
RS
2748 Vminibuffer_completing_file_name = Qnil;
2749
af52c32d
MB
2750 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2751 doc: /* Value that `help-form' takes on inside the minibuffer. */);
f927c5ae
JB
2752 Vminibuffer_help_form = Qnil;
2753
af52c32d
MB
2754 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2755 doc: /* History list symbol to add minibuffer values to.
a1f17501
PJ
2756Each string of minibuffer input, as it appears on exit from the minibuffer,
2757is added with
2758 (set minibuffer-history-variable
2759 (cons STRING (symbol-value minibuffer-history-variable))) */);
5a866662 2760 XSETFASTINT (Vminibuffer_history_variable, 0);
770970cb 2761
af52c32d
MB
2762 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2763 doc: /* Current position of redoing in the history list. */);
770970cb
RS
2764 Vminibuffer_history_position = Qnil;
2765
af52c32d
MB
2766 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2767 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
a1f17501 2768Some uses of the echo area also raise that frame (since they use it too). */);
6a9ee000
RS
2769 minibuffer_auto_raise = 0;
2770
af52c32d 2771 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
b0c138ce
LT
2772 doc: /* List of regexps that should restrict possible completions.
2773The basic completion functions only consider a completion acceptable
2774if it matches all regular expressions in this list, with
2775`case-fold-search' bound to the value of `completion-ignore-case'.
2776See Info node `(elisp)Basic Completion', for a description of these
2777functions. */);
42006772
RS
2778 Vcompletion_regexp_list = Qnil;
2779
c3421833 2780 DEFVAR_BOOL ("minibuffer-allow-text-properties",
af52c32d
MB
2781 &minibuffer_allow_text_properties,
2782 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
a1f17501
PJ
2783This also affects `read-string', but it does not affect `read-minibuffer',
2784`read-no-blanks-input', or any of the functions that do minibuffer input
2785with completion; they always discard text properties. */);
c3421833
RS
2786 minibuffer_allow_text_properties = 0;
2787
af52c32d
MB
2788 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties,
2789 doc: /* Text properties that are added to minibuffer prompts.
a1f17501
PJ
2790These are in addition to the basic `field' property, and stickiness
2791properties. */);
cc64f5c9
MB
2792 /* We use `intern' here instead of Qread_only to avoid
2793 initialization-order problems. */
2794 Vminibuffer_prompt_properties
2795 = Fcons (intern ("read-only"), Fcons (Qt, Qnil));
2796
68313ed8 2797 defsubr (&Sset_minibuffer_window);
f927c5ae
JB
2798 defsubr (&Sread_from_minibuffer);
2799 defsubr (&Seval_minibuffer);
2800 defsubr (&Sread_minibuffer);
2801 defsubr (&Sread_string);
2802 defsubr (&Sread_command);
2803 defsubr (&Sread_variable);
2804 defsubr (&Sread_buffer);
2805 defsubr (&Sread_no_blanks_input);
2806 defsubr (&Sminibuffer_depth);
37e9a934 2807 defsubr (&Sminibuffer_prompt);
f927c5ae 2808
873ef78e 2809 defsubr (&Sminibufferp);
a346ec72
MB
2810 defsubr (&Sminibuffer_prompt_end);
2811 defsubr (&Sminibuffer_contents);
2812 defsubr (&Sminibuffer_contents_no_properties);
2813 defsubr (&Sdelete_minibuffer_contents);
2814
f927c5ae
JB
2815 defsubr (&Stry_completion);
2816 defsubr (&Sall_completions);
695deb18
SM
2817 defsubr (&Stest_completion);
2818 defsubr (&Sassoc_string);
f927c5ae
JB
2819 defsubr (&Scompleting_read);
2820 defsubr (&Sminibuffer_complete);
2821 defsubr (&Sminibuffer_complete_word);
2822 defsubr (&Sminibuffer_complete_and_exit);
2823 defsubr (&Sdisplay_completion_list);
2824 defsubr (&Sminibuffer_completion_help);
2825
2826 defsubr (&Sself_insert_and_exit);
2827 defsubr (&Sexit_minibuffer);
2828
2d955a50 2829 defsubr (&Sminibuffer_message);
f927c5ae
JB
2830}
2831
9d815fd9 2832void
f927c5ae
JB
2833keys_of_minibuf ()
2834{
2835 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2836 "abort-recursive-edit");
2837 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2838 "exit-minibuffer");
2839 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2840 "exit-minibuffer");
2841
f927c5ae
JB
2842 initial_define_key (Vminibuffer_local_ns_map, ' ',
2843 "exit-minibuffer");
2844 initial_define_key (Vminibuffer_local_ns_map, '\t',
2845 "exit-minibuffer");
2846 initial_define_key (Vminibuffer_local_ns_map, '?',
2847 "self-insert-and-exit");
2848
f927c5ae
JB
2849 initial_define_key (Vminibuffer_local_completion_map, '\t',
2850 "minibuffer-complete");
2851 initial_define_key (Vminibuffer_local_completion_map, ' ',
2852 "minibuffer-complete-word");
2853 initial_define_key (Vminibuffer_local_completion_map, '?',
2854 "minibuffer-completion-help");
2855
f927c5ae
JB
2856 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2857 "minibuffer-complete-and-exit");
2858 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2859 "minibuffer-complete-and-exit");
f927c5ae 2860}
ab5796a9
MB
2861
2862/* arch-tag: 8f69b601-fba3-484c-a6dd-ceaee54a7a73
2863 (do not change this comment) */