more XCAR/XCDR/XFLOAT_DATA uses, to help isolete lisp engine
[bpt/emacs.git] / src / minibuf.c
CommitLineData
f927c5ae 1/* Minibuffer input and completion.
8e9968c6 2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999
6801b300 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>
f927c5ae
JB
25#include "lisp.h"
26#include "commands.h"
27#include "buffer.h"
d50a3d2a 28#include "charset.h"
f927c5ae 29#include "dispextern.h"
ff11dfa1 30#include "frame.h"
f927c5ae
JB
31#include "window.h"
32#include "syntax.h"
5221fd63 33#include "keyboard.h"
f927c5ae
JB
34
35#define min(a, b) ((a) < (b) ? (a) : (b))
36
a4e71d81
KH
37extern int quit_char;
38
f927c5ae 39/* List of buffers for use as minibuffers.
4d04c1f1
KH
40 The first element of the list is used for the outermost minibuffer
41 invocation, the next element is used for a recursive minibuffer
42 invocation, etc. The list is extended at the end as deeper
43 minibuffer recursions are encountered. */
279cf52c 44
f927c5ae
JB
45Lisp_Object Vminibuffer_list;
46
4d04c1f1 47/* Data to remember during recursive minibuffer invocations */
279cf52c 48
4d04c1f1 49Lisp_Object minibuf_save_list;
f927c5ae
JB
50
51/* Depth in minibuffer invocations. */
279cf52c 52
f927c5ae
JB
53int minibuf_level;
54
77aa8edf 55/* Nonzero means display completion help for invalid input. */
279cf52c 56
f927c5ae
JB
57int auto_help;
58
77aa8edf 59/* The maximum length of a minibuffer history. */
279cf52c 60
77aa8edf
RS
61Lisp_Object Qhistory_length, Vhistory_length;
62
b278606c 63/* Fread_minibuffer leaves the input here as a string. */
279cf52c 64
f927c5ae
JB
65Lisp_Object last_minibuf_string;
66
67/* Nonzero means let functions called when within a minibuffer
68 invoke recursive minibuffers (to read arguments, or whatever) */
279cf52c 69
f927c5ae
JB
70int enable_recursive_minibuffers;
71
c3421833
RS
72/* Nonzero means don't ignore text properties
73 in Fread_from_minibuffer. */
279cf52c 74
c3421833
RS
75int minibuffer_allow_text_properties;
76
f927c5ae
JB
77/* help-form is bound to this while in the minibuffer. */
78
79Lisp_Object Vminibuffer_help_form;
80
770970cb
RS
81/* Variable which is the history list to add minibuffer values to. */
82
83Lisp_Object Vminibuffer_history_variable;
84
85/* Current position in the history list (adjusted by M-n and M-p). */
86
87Lisp_Object Vminibuffer_history_position;
88
406e55df 89Lisp_Object Qminibuffer_history, Qbuffer_name_history;
770970cb 90
719b4a40
RS
91Lisp_Object Qread_file_name_internal;
92
177aecf9 93/* Normal hooks for entry to and exit from minibuffer. */
5c781212
RS
94
95Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
177aecf9 96Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
5c781212 97
eebbfb01
KH
98/* Function to call to read a buffer name. */
99Lisp_Object Vread_buffer_function;
100
f927c5ae
JB
101/* Nonzero means completion ignores case. */
102
103int completion_ignore_case;
104
42006772
RS
105/* List of regexps that should restrict possible completions. */
106
107Lisp_Object Vcompletion_regexp_list;
108
6a9ee000
RS
109/* Nonzero means raise the minibuffer frame when the minibuffer
110 is entered. */
111
112int minibuffer_auto_raise;
113
f927c5ae
JB
114/* If last completion attempt reported "Complete but not unique"
115 then this is the string completed then; otherwise this is nil. */
116
117static Lisp_Object last_exact_completion;
118
2cb6da5c
RS
119/* Non-nil means it is the window for C-M-v to scroll
120 when the minibuffer is selected. */
279cf52c 121
2cb6da5c 122extern Lisp_Object Vminibuf_scroll_window;
30e13e56
RS
123
124extern Lisp_Object Voverriding_local_map;
cee54539 125
5744fa7c
RS
126Lisp_Object Quser_variable_p;
127
128Lisp_Object Qminibuffer_default;
129
cee54539
KH
130Lisp_Object Qcurrent_input_method, Qactivate_input_method;
131
5744fa7c 132extern Lisp_Object Qmouse_face;
279cf52c 133
8e9968c6 134extern Lisp_Object Qfield;
f927c5ae 135\f
89fdc4a0
KH
136/* Put minibuf on currently selected frame's minibuffer.
137 We do this whenever the user starts a new minibuffer
138 or when a minibuffer exits. */
139
140void
141choose_minibuf_frame ()
142{
a4aafc54
GM
143 if (FRAMEP (selected_frame)
144 && FRAME_LIVE_P (XFRAME (selected_frame))
145 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
89fdc4a0 146 {
a4aafc54
GM
147 struct frame *sf = XFRAME (selected_frame);
148 Lisp_Object buffer;
149
89fdc4a0
KH
150 /* I don't think that any frames may validly have a null minibuffer
151 window anymore. */
a4aafc54 152 if (NILP (sf->minibuffer_window))
89fdc4a0
KH
153 abort ();
154
a4aafc54
GM
155 /* Under X, we come here with minibuf_window being the
156 minibuffer window of the unused termcap window created in
157 init_window_once. That window doesn't have a buffer. */
158 buffer = XWINDOW (minibuf_window)->buffer;
159 if (BUFFERP (buffer))
160 Fset_window_buffer (sf->minibuffer_window, buffer);
161 minibuf_window = sf->minibuffer_window;
89fdc4a0 162 }
914860c2
RS
163
164 /* Make sure no other frame has a minibuffer as its selected window,
165 because the text would not be displayed in it, and that would be
07d402c8
RS
166 confusing. Only allow the selected frame to do this,
167 and that only if the minibuffer is active. */
914860c2
RS
168 {
169 Lisp_Object tail, frame;
170
171 FOR_EACH_FRAME (tail, frame)
07d402c8 172 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
a4aafc54 173 && !(EQ (frame, selected_frame)
07d402c8 174 && minibuf_level > 0))
914860c2
RS
175 Fset_frame_selected_window (frame, Fframe_first_window (frame));
176 }
89fdc4a0 177}
68313ed8 178
0c94f256
RS
179Lisp_Object
180choose_minibuf_frame_1 (ignore)
181 Lisp_Object ignore;
182{
183 choose_minibuf_frame ();
184 return Qnil;
185}
186
68313ed8
RS
187DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
188 Sset_minibuffer_window, 1, 1, 0,
189 "Specify which minibuffer window to use for the minibuffer.\n\
190This effects where the minibuffer is displayed if you put text in it\n\
191without invoking the usual minibuffer commands.")
192 (window)
193 Lisp_Object window;
194{
195 CHECK_WINDOW (window, 1);
196 if (! MINI_WINDOW_P (XWINDOW (window)))
197 error ("Window is not a minibuffer window");
198
199 minibuf_window = window;
200
201 return window;
202}
203
89fdc4a0 204\f
f927c5ae
JB
205/* Actual minibuffer invocation. */
206
af2b7cd5
RS
207static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
208static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
209 Lisp_Object, Lisp_Object,
210 int, Lisp_Object,
211 Lisp_Object, Lisp_Object,
212 int, int));
f927c5ae 213
770970cb 214/* Read from the minibuffer using keymap MAP, initial contents INITIAL
a9c26562 215 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
770970cb 216 prompting with PROMPT (a string), using history list HISTVAR
85b5fe07 217 with initial position HISTPOS. (BACKUP_N should be <= 0.)
770970cb
RS
218
219 Normally return the result as a string (the text that was read),
3ab14176 220 but if EXPFLAG is nonzero, read it and return the object read.
b278606c
BF
221 If HISTVAR is given, save the value read on that history only if it doesn't
222 match the front of that history list exactly. The value is pushed onto
e5d4686b 223 the list as the string that was read.
770970cb 224
c3421833
RS
225 DEFALT specifies te default value for the sake of history commands.
226
cee54539
KH
227 If ALLOW_PROPS is nonzero, we do not throw away text properties.
228
229 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
230 current input method. */
e5d4686b
RS
231
232static Lisp_Object
233read_minibuf (map, initial, prompt, backup_n, expflag,
cee54539 234 histvar, histpos, defalt, allow_props, inherit_input_method)
f927c5ae
JB
235 Lisp_Object map;
236 Lisp_Object initial;
237 Lisp_Object prompt;
5061d9c3 238 Lisp_Object backup_n;
f927c5ae 239 int expflag;
770970cb
RS
240 Lisp_Object histvar;
241 Lisp_Object histpos;
e5d4686b 242 Lisp_Object defalt;
af2b7cd5 243 int allow_props;
cee54539 244 int inherit_input_method;
f927c5ae 245{
00a34088 246 Lisp_Object val;
f927c5ae 247 int count = specpdl_ptr - specpdl;
cee54539
KH
248 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
249 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
c75000c7 250 Lisp_Object enable_multibyte;
13c67cc6 251 extern Lisp_Object Qread_only, Qfront_sticky;
fbd1209a 252 extern Lisp_Object Qrear_nonsticky;
00a34088 253
e5d4686b
RS
254 specbind (Qminibuffer_default, defalt);
255
08f7d623 256 single_kboard_state ();
718d3251 257
00a34088 258 val = Qnil;
57ceaa8a 259 ambient_dir = current_buffer->directory;
cee54539 260 input_method = Qnil;
c75000c7 261 enable_multibyte = Qnil;
57ceaa8a 262
00a34088
RS
263 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
264 store them away before we can GC. Don't need to protect
265 BACKUP_N because we use the value only if it is an integer. */
cee54539 266 GCPRO5 (map, initial, val, ambient_dir, input_method);
f927c5ae 267
7510b296 268 if (!STRINGP (prompt))
f927c5ae
JB
269 prompt = build_string ("");
270
f927c5ae 271 if (!enable_recursive_minibuffers
be15a518
RS
272 && minibuf_level > 0)
273 {
274 if (EQ (selected_window, minibuf_window))
275 error ("Command attempted to use minibuffer while in minibuffer");
276 else
277 /* If we're in another window, cancel the minibuffer that's active. */
278 Fthrow (Qexit,
279 build_string ("Command attempted to use minibuffer while in minibuffer"));
280 }
f927c5ae 281
748dc60a 282 /* Choose the minibuffer window and frame, and take action on them. */
f927c5ae 283
c5b6b680
RS
284 choose_minibuf_frame ();
285
0c94f256
RS
286 record_unwind_protect (choose_minibuf_frame_1, Qnil);
287
f927c5ae 288 record_unwind_protect (Fset_window_configuration,
b2b2c677
JB
289 Fcurrent_window_configuration (Qnil));
290
ff11dfa1
JB
291 /* If the minibuffer window is on a different frame, save that
292 frame's configuration too. */
75f00e72 293 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
a4aafc54 294 if (!EQ (mini_frame, selected_frame))
5061d9c3
RS
295 record_unwind_protect (Fset_window_configuration,
296 Fcurrent_window_configuration (mini_frame));
5563e8e8
KH
297
298 /* If the minibuffer is on an iconified or invisible frame,
299 make it visible now. */
300 Fmake_frame_visible (mini_frame);
301
6a9ee000
RS
302 if (minibuffer_auto_raise)
303 Fraise_frame (mini_frame);
f927c5ae 304
748dc60a
RS
305 /* We have to do this after saving the window configuration
306 since that is what restores the current buffer. */
307
308 /* Arrange to restore a number of minibuffer-related variables.
309 We could bind each variable separately, but that would use lots of
310 specpdl slots. */
311 minibuf_save_list
312 = Fcons (Voverriding_local_map,
313 Fcons (minibuf_window, minibuf_save_list));
314 minibuf_save_list
315 = Fcons (minibuf_prompt,
316 Fcons (make_number (minibuf_prompt_width),
317 Fcons (Vhelp_form,
318 Fcons (Vcurrent_prefix_arg,
319 Fcons (Vminibuffer_history_position,
320 Fcons (Vminibuffer_history_variable,
321 minibuf_save_list))))));
322
323 record_unwind_protect (read_minibuf_unwind, Qnil);
324 minibuf_level++;
325
326 /* Now that we can restore all those variables, start changing them. */
327
1e3f16d5 328 minibuf_prompt_width = 0;
748dc60a
RS
329 minibuf_prompt = Fcopy_sequence (prompt);
330 Vminibuffer_history_position = histpos;
331 Vminibuffer_history_variable = histvar;
332 Vhelp_form = Vminibuffer_help_form;
333
cee54539 334 if (inherit_input_method)
c75000c7
RS
335 {
336 /* `current-input-method' is buffer local. So, remeber it in
337 INPUT_METHOD before changing the current buffer. */
338 input_method = Fsymbol_value (Qcurrent_input_method);
339 enable_multibyte = current_buffer->enable_multibyte_characters;
340 }
cee54539 341
748dc60a
RS
342 /* Switch to the minibuffer. */
343
4f69d8f6
RS
344 minibuffer = get_minibuffer (minibuf_level);
345 Fset_buffer (minibuffer);
64a3a3c0
JB
346
347 /* The current buffer's default directory is usually the right thing
348 for our minibuffer here. However, if you're typing a command at
349 a minibuffer-only frame when minibuf_level is zero, then buf IS
350 the current_buffer, so reset_buffer leaves buf's default
351 directory unchanged. This is a bummer when you've just started
352 up Emacs and buf's default directory is Qnil. Here's a hack; can
353 you think of something better to do? Find another buffer with a
354 better directory, and use that one instead. */
748dc60a
RS
355 if (STRINGP (ambient_dir))
356 current_buffer->directory = ambient_dir;
64a3a3c0
JB
357 else
358 {
359 Lisp_Object buf_list;
360
361 for (buf_list = Vbuffer_alist;
362 CONSP (buf_list);
7539e11f 363 buf_list = XCDR (buf_list))
64a3a3c0 364 {
1e62748e 365 Lisp_Object other_buf;
64a3a3c0 366
7539e11f 367 other_buf = XCDR (XCAR (buf_list));
7510b296 368 if (STRINGP (XBUFFER (other_buf)->directory))
64a3a3c0
JB
369 {
370 current_buffer->directory = XBUFFER (other_buf)->directory;
371 break;
372 }
373 }
374 }
375
a4aafc54
GM
376 if (!EQ (mini_frame, selected_frame))
377 Fredirect_frame_focus (selected_frame, mini_frame);
43bad991 378
f927c5ae
JB
379 Vminibuf_scroll_window = selected_window;
380 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
f927c5ae 381 Fselect_window (minibuf_window);
5a866662 382 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
f927c5ae 383
748dc60a
RS
384 Fmake_local_variable (Qprint_escape_newlines);
385 print_escape_newlines = 1;
386
387 /* Erase the buffer. */
59115a22
RS
388 {
389 int count1 = specpdl_ptr - specpdl;
390 specbind (Qinhibit_read_only, Qt);
391 Ferase_buffer ();
392 unbind_to (count1, Qnil);
393 }
394
279cf52c
GM
395 if (!NILP (current_buffer->enable_multibyte_characters)
396 && ! STRING_MULTIBYTE (minibuf_prompt))
397 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
398
279cf52c
GM
399 /* Insert the prompt, record where it ends. */
400 Finsert (1, &minibuf_prompt);
279cf52c
GM
401 if (PT > BEG)
402 {
fbd1209a 403 Fput_text_property (make_number (BEG), make_number (PT),
279cf52c 404 Qfront_sticky, Qt, Qnil);
fbd1209a 405 Fput_text_property (make_number (BEG), make_number (PT),
279cf52c 406 Qrear_nonsticky, Qt, Qnil);
8e9968c6
GM
407 Fput_text_property (make_number (BEG), make_number (PT),
408 Qfield, Qt, Qnil);
fbd1209a
RS
409 Fput_text_property (make_number (BEG), make_number (PT),
410 Qread_only, Qt, Qnil);
279cf52c 411 }
1e3f16d5
GM
412
413 minibuf_prompt_width = current_column ();
279cf52c 414
094d9789
RS
415 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
416 if (inherit_input_method)
417 current_buffer->enable_multibyte_characters = enable_multibyte;
418
748dc60a 419 /* Put in the initial input. */
56a98455 420 if (!NILP (initial))
f927c5ae
JB
421 {
422 Finsert (1, &initial);
a9c26562
RS
423 if (INTEGERP (backup_n))
424 Fforward_char (backup_n);
f927c5ae
JB
425 }
426
39e98b38 427 clear_message (1, 1);
f927c5ae
JB
428 current_buffer->keymap = map;
429
cee54539 430 /* Turn on an input method stored in INPUT_METHOD if any. */
6801b300 431 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
cee54539
KH
432 call1 (Qactivate_input_method, input_method);
433
5c781212
RS
434 /* Run our hook, but not if it is empty.
435 (run-hooks would do nothing if it is empty,
748dc60a 436 but it's important to save time here in the usual case). */
92d3b06e
RS
437 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
438 && !NILP (Vrun_hooks))
5c781212
RS
439 call1 (Vrun_hooks, Qminibuffer_setup_hook);
440
f927c5ae
JB
441 recursive_edit_1 ();
442
443 /* If cursor is on the minibuffer line,
444 show the user we have exited by putting it in column 0. */
279cf52c 445 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
f927c5ae
JB
446 && !noninteractive)
447 {
279cf52c
GM
448 XWINDOW (minibuf_window)->cursor.hpos = 0;
449 XWINDOW (minibuf_window)->cursor.x = 0;
450 XWINDOW (minibuf_window)->must_be_updated_p = 1;
a4aafc54 451 update_frame (XFRAME (selected_frame), 1, 1);
337aaf1f
GM
452 if (rif && rif->flush_display)
453 rif->flush_display (XFRAME (XWINDOW (minibuf_window)->frame));
f927c5ae
JB
454 }
455
c3421833 456 /* Make minibuffer contents into a string. */
4f69d8f6 457 Fset_buffer (minibuffer);
8e9968c6 458 val = Ffield_string (make_number (ZV), allow_props ? Qt : Qnil);
770970cb 459
b278606c 460 /* VAL is the string of minibuffer text. */
7019cca7 461
b278606c
BF
462 last_minibuf_string = val;
463
3ab14176 464 /* Add the value to the appropriate history list unless it is empty. */
9f6131cf 465 if (XSTRING (val)->size != 0
c6d65724 466 && SYMBOLP (Vminibuffer_history_variable))
3ab14176
KH
467 {
468 /* If the caller wanted to save the value read on a history list,
469 then do so if the value is not already the front of the list. */
470 Lisp_Object histval;
c6d65724
RS
471
472 /* If variable is unbound, make it nil. */
473 if (EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
474 Fset (Vminibuffer_history_variable, Qnil);
475
3ab14176
KH
476 histval = Fsymbol_value (Vminibuffer_history_variable);
477
478 /* The value of the history variable must be a cons or nil. Other
479 values are unacceptable. We silently ignore these values. */
480 if (NILP (histval)
9f6131cf
RS
481 || (CONSP (histval)
482 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
77aa8edf
RS
483 {
484 Lisp_Object length;
485
486 histval = Fcons (last_minibuf_string, histval);
487 Fset (Vminibuffer_history_variable, histval);
488
489 /* Truncate if requested. */
490 length = Fget (Vminibuffer_history_variable, Qhistory_length);
491 if (NILP (length)) length = Vhistory_length;
e5d4686b
RS
492 if (INTEGERP (length))
493 {
494 if (XINT (length) <= 0)
495 Fset (Vminibuffer_history_variable, Qnil);
496 else
497 {
498 Lisp_Object temp;
499
500 temp = Fnthcdr (Fsub1 (length), histval);
501 if (CONSP (temp)) Fsetcdr (temp, Qnil);
502 }
503 }
77aa8edf 504 }
9f6131cf
RS
505 }
506
507 /* If Lisp form desired instead of string, parse it. */
508 if (expflag)
509 {
510 Lisp_Object expr_and_pos;
82d6226f 511 int pos;
9f6131cf 512
c923ccc9
RS
513 if (STRINGP (val) && XSTRING (val)->size == 0
514 && STRINGP (defalt))
515 val = defalt;
516
9f6131cf 517 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
82d6226f
RS
518 pos = XINT (Fcdr (expr_and_pos));
519 if (pos != XSTRING (val)->size)
520 {
521 /* Ignore trailing whitespace; any other trailing junk is an error. */
522 int i;
523 pos = string_char_to_byte (val, pos);
fc932ac6 524 for (i = pos; i < STRING_BYTES (XSTRING (val)); i++)
82d6226f
RS
525 {
526 int c = XSTRING (val)->data[i];
527 if (c != ' ' && c != '\t' && c != '\n')
528 error ("Trailing garbage following expression");
529 }
530 }
9f6131cf 531 val = Fcar (expr_and_pos);
3ab14176
KH
532 }
533
00a34088
RS
534 /* The appropriate frame will get selected
535 in set-window-configuration. */
536 RETURN_UNGCPRO (unbind_to (count, val));
f927c5ae
JB
537}
538
539/* Return a buffer to be used as the minibuffer at depth `depth'.
540 depth = 0 is the lowest allowed argument, and that is the value
541 used for nonrecursive minibuffer invocations */
542
543Lisp_Object
544get_minibuffer (depth)
545 int depth;
546{
547 Lisp_Object tail, num, buf;
9f6c23bc 548 char name[24];
f927c5ae
JB
549 extern Lisp_Object nconc2 ();
550
5a866662 551 XSETFASTINT (num, depth);
f927c5ae 552 tail = Fnthcdr (num, Vminibuffer_list);
56a98455 553 if (NILP (tail))
f927c5ae
JB
554 {
555 tail = Fcons (Qnil, Qnil);
556 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
557 }
558 buf = Fcar (tail);
56a98455 559 if (NILP (buf) || NILP (XBUFFER (buf)->name))
f927c5ae
JB
560 {
561 sprintf (name, " *Minibuf-%d*", depth);
562 buf = Fget_buffer_create (build_string (name));
5d6533f1
JB
563
564 /* Although the buffer's name starts with a space, undo should be
565 enabled in it. */
566 Fbuffer_enable_undo (buf);
567
7539e11f 568 XCAR (tail) = buf;
f927c5ae
JB
569 }
570 else
5956f71d 571 {
6b3faad8
RS
572 int count = specpdl_ptr - specpdl;
573
5956f71d 574 reset_buffer (XBUFFER (buf));
6b3faad8
RS
575 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
576 Fset_buffer (buf);
577 Fkill_all_local_variables ();
578 unbind_to (count, Qnil);
5956f71d 579 }
64a3a3c0 580
f927c5ae
JB
581 return buf;
582}
583
279cf52c
GM
584/* This function is called on exiting minibuffer, whether normally or
585 not, and it restores the current window, buffer, etc. */
f927c5ae 586
9d815fd9 587static Lisp_Object
43bad991
JB
588read_minibuf_unwind (data)
589 Lisp_Object data;
f927c5ae 590{
c24e1160 591 Lisp_Object old_deactivate_mark;
59115a22 592 Lisp_Object window;
c24e1160 593
0a1dd1c5
RS
594 /* We are exiting the minibuffer one way or the other,
595 so run the hook. */
596 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
597 && !NILP (Vrun_hooks))
060ffec1 598 safe_run_hooks (Qminibuffer_exit_hook);
0a1dd1c5 599
f927c5ae 600 /* If this was a recursive minibuffer,
59115a22 601 tie the minibuffer window back to the outer level minibuffer buffer. */
f927c5ae 602 minibuf_level--;
f927c5ae 603
59115a22 604 window = minibuf_window;
279cf52c
GM
605 /* To keep things predictable, in case it matters, let's be in the
606 minibuffer when we reset the relevant variables. */
59115a22
RS
607 Fset_buffer (XWINDOW (window)->buffer);
608
609 /* Restore prompt, etc, from outer minibuffer level. */
4d04c1f1
KH
610 minibuf_prompt = Fcar (minibuf_save_list);
611 minibuf_save_list = Fcdr (minibuf_save_list);
612 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
613 minibuf_save_list = Fcdr (minibuf_save_list);
614 Vhelp_form = Fcar (minibuf_save_list);
615 minibuf_save_list = Fcdr (minibuf_save_list);
ee9e37ab 616 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
4d04c1f1
KH
617 minibuf_save_list = Fcdr (minibuf_save_list);
618 Vminibuffer_history_position = Fcar (minibuf_save_list);
619 minibuf_save_list = Fcdr (minibuf_save_list);
620 Vminibuffer_history_variable = Fcar (minibuf_save_list);
621 minibuf_save_list = Fcdr (minibuf_save_list);
30e13e56 622 Voverriding_local_map = Fcar (minibuf_save_list);
c5b6b680 623 minibuf_save_list = Fcdr (minibuf_save_list);
914860c2
RS
624#if 0
625 temp = Fcar (minibuf_save_list);
626 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
627 minibuf_window = temp;
628#endif
30e13e56 629 minibuf_save_list = Fcdr (minibuf_save_list);
59115a22
RS
630
631 /* Erase the minibuffer we were using at this level. */
632 {
633 int count = specpdl_ptr - specpdl;
634 /* Prevent error in erase-buffer. */
635 specbind (Qinhibit_read_only, Qt);
636 old_deactivate_mark = Vdeactivate_mark;
637 Ferase_buffer ();
638 Vdeactivate_mark = old_deactivate_mark;
639 unbind_to (count, Qnil);
640 }
641
544e358d
GM
642 /* When we get to the outmost level, make sure we resize the
643 mini-window back to its normal size. */
644 if (minibuf_level == 0)
1e3f16d5 645 resize_mini_window (XWINDOW (window), 0);
544e358d 646
59115a22
RS
647 /* Make sure minibuffer window is erased, not ignored. */
648 windows_or_buffers_changed++;
649 XSETFASTINT (XWINDOW (window)->last_modified, 0);
193e4518 650 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
9d815fd9 651 return Qnil;
f927c5ae
JB
652}
653\f
b9d721de
JB
654
655/* This comment supplies the doc string for read-from-minibuffer,
656 for make-docfile to see. We cannot put this in the real DEFUN
657 due to limits in the Unix cpp.
658
cee54539 659DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
f927c5ae
JB
660 "Read a string from the minibuffer, prompting with string PROMPT.\n\
661If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
662 to be inserted into the minibuffer before reading input.\n\
770970cb 663 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
18fef111 664 is STRING, but point is placed at position POSITION in the minibuffer.\n\
f927c5ae
JB
665Third arg KEYMAP is a keymap to use whilst reading;\n\
666 if omitted or nil, the default is `minibuffer-local-map'.\n\
667If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
668 and return that object:\n\
669 in other words, do `(car (read-from-string INPUT-STRING))'\n\
770970cb
RS
670Fifth arg HIST, if non-nil, specifies a history list\n\
671 and optionally the initial position in the list.\n\
672 It can be a symbol, which is the history list variable to use,\n\
673 or it can be a cons cell (HISTVAR . HISTPOS).\n\
674 In that case, HISTVAR is the history list variable to use,\n\
675 and HISTPOS is the initial position (the position in the list\n\
676 which INITIAL-CONTENTS corresponds to).\n\
e5d4686b 677 Positions are counted starting from 1 at the beginning of the list.\n\
b9a86585
RS
678Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
679 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
680 if the user enters empty input! It returns the empty string.\n\
c8c15521
RS
681Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
682 the current input method and the setting of enable-multibyte-characters.\n\
19a4cb25 683If the variable `minibuffer-allow-text-properties' is non-nil,\n\
c3421833 684 then the string which is returned includes whatever text properties\n\
cee54539
KH
685 were present in the minibuffer. Otherwise the value has no text properties.")
686 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
687 */
b9d721de 688
cee54539 689DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
b9d721de 690 0 /* See immediately above */)
cee54539 691 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
e5d4686b 692 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
cee54539 693 Lisp_Object inherit_input_method;
f927c5ae
JB
694{
695 int pos = 0;
e5d4686b 696 Lisp_Object histvar, histpos, position, val;
1d8d92f4
RS
697 struct gcpro gcpro1;
698
770970cb 699 position = Qnil;
f927c5ae
JB
700
701 CHECK_STRING (prompt, 0);
68e5a8a2 702 if (!NILP (initial_contents))
f927c5ae 703 {
7510b296 704 if (CONSP (initial_contents))
770970cb 705 {
68e5a8a2
RS
706 position = Fcdr (initial_contents);
707 initial_contents = Fcar (initial_contents);
770970cb 708 }
68e5a8a2 709 CHECK_STRING (initial_contents, 1);
56a98455 710 if (!NILP (position))
f927c5ae
JB
711 {
712 CHECK_NUMBER (position, 0);
713 /* Convert to distance from end of input. */
18fef111
RS
714 if (XINT (position) < 1)
715 /* A number too small means the beginning of the string. */
716 pos = - XSTRING (initial_contents)->size;
717 else
718 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
f927c5ae
JB
719 }
720 }
721
56a98455 722 if (NILP (keymap))
f927c5ae
JB
723 keymap = Vminibuffer_local_map;
724 else
b7df898e 725 keymap = get_keymap (keymap);
770970cb 726
7510b296 727 if (SYMBOLP (hist))
770970cb
RS
728 {
729 histvar = hist;
730 histpos = Qnil;
731 }
732 else
733 {
734 histvar = Fcar_safe (hist);
735 histpos = Fcdr_safe (hist);
736 }
737 if (NILP (histvar))
738 histvar = Qminibuffer_history;
739 if (NILP (histpos))
5a866662 740 XSETFASTINT (histpos, 0);
770970cb 741
1d8d92f4 742 GCPRO1 (default_value);
e5d4686b
RS
743 val = read_minibuf (keymap, initial_contents, prompt,
744 make_number (pos), !NILP (read),
c3421833 745 histvar, histpos, default_value,
cee54539
KH
746 minibuffer_allow_text_properties,
747 !NILP (inherit_input_method));
1d8d92f4 748 UNGCPRO;
e5d4686b 749 return val;
f927c5ae
JB
750}
751
752DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
753 "Return a Lisp object read using the minibuffer.\n\
754Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
755is a string to insert in the minibuffer before reading.")
756 (prompt, initial_contents)
757 Lisp_Object prompt, initial_contents;
758{
759 CHECK_STRING (prompt, 0);
56a98455 760 if (!NILP (initial_contents))
a1b4b084 761 CHECK_STRING (initial_contents, 1);
770970cb 762 return read_minibuf (Vminibuffer_local_map, initial_contents,
e5d4686b 763 prompt, Qnil, 1, Qminibuffer_history,
dd9d15d6 764 make_number (0), Qnil, 0, 0);
f927c5ae
JB
765}
766
767DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
768 "Return value of Lisp expression read using the minibuffer.\n\
769Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
770is a string to insert in the minibuffer before reading.")
771 (prompt, initial_contents)
772 Lisp_Object prompt, initial_contents;
773{
774 return Feval (Fread_minibuffer (prompt, initial_contents));
775}
776
777/* Functions that use the minibuffer to read various things. */
778
cee54539 779DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
f927c5ae 780 "Read a string from the minibuffer, prompting with string PROMPT.\n\
80896ab4
RS
781If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
782The third arg HISTORY, if non-nil, specifies a history list\n\
783 and optionally the initial position in the list.\n\
cee54539 784See `read-from-minibuffer' for details of HISTORY argument.\n\
19a4cb25
SE
785Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
786 for history commands, and as the value to return if the user enters\n\
787 the empty string.\n\
788Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
c8c15521 789 the current input method and the setting of enable-multibyte-characters.")
cee54539 790 (prompt, initial_input, history, default_value, inherit_input_method)
e5d4686b 791 Lisp_Object prompt, initial_input, history, default_value;
cee54539 792 Lisp_Object inherit_input_method;
f927c5ae 793{
b9a86585
RS
794 Lisp_Object val;
795 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
796 Qnil, history, default_value,
797 inherit_input_method);
798 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (default_value))
799 val = default_value;
800 return val;
f927c5ae
JB
801}
802
cee54539 803DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
c923ccc9
RS
804 "Read a string from the terminal, not allowing blanks.\n\
805Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
c8c15521
RS
806Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
807the current input method and the setting of enable-multibyte-characters.")
c923ccc9
RS
808 (prompt, initial, inherit_input_method)
809 Lisp_Object prompt, initial, inherit_input_method;
f927c5ae
JB
810{
811 CHECK_STRING (prompt, 0);
c923ccc9
RS
812 if (! NILP (initial))
813 CHECK_STRING (initial, 1);
f927c5ae 814
c923ccc9 815 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
cee54539
KH
816 0, Qminibuffer_history, make_number (0), Qnil, 0,
817 !NILP (inherit_input_method));
f927c5ae
JB
818}
819
e5d4686b
RS
820DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
821 "Read the name of a command and return as a symbol.\n\
822Prompts with PROMPT. By default, return DEFAULT-VALUE.")
823 (prompt, default_value)
824 Lisp_Object prompt, default_value;
f927c5ae 825{
7c8d9931
RS
826 Lisp_Object name, default_string;
827
828 if (NILP (default_value))
829 default_string = Qnil;
830 else if (SYMBOLP (default_value))
6dd05c14 831 XSETSTRING (default_string, XSYMBOL (default_value)->name);
7c8d9931
RS
832 else
833 default_string = default_value;
834
835 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
836 Qnil, Qnil, default_string, Qnil);
837 if (NILP (name))
838 return name;
839 return Fintern (name, Qnil);
f927c5ae
JB
840}
841
842#ifdef NOTDEF
843DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
844 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
845Prompts with PROMPT.")
846 (prompt)
847 Lisp_Object prompt;
848{
cee54539 849 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
f927c5ae
JB
850 Qnil);
851}
852#endif /* NOTDEF */
853
e5d4686b
RS
854DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
855 "Read the name of a user variable and return it as a symbol.\n\
856Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
f927c5ae 857A user variable is one whose documentation starts with a `*' character.")
e5d4686b
RS
858 (prompt, default_value)
859 Lisp_Object prompt, default_value;
f927c5ae 860{
7c8d9931
RS
861 Lisp_Object name, default_string;
862
863 if (NILP (default_value))
864 default_string = Qnil;
865 else if (SYMBOLP (default_value))
6dd05c14 866 XSETSTRING (default_string, XSYMBOL (default_value)->name);
7c8d9931
RS
867 else
868 default_string = default_value;
869
870 name = Fcompleting_read (prompt, Vobarray,
871 Quser_variable_p, Qt,
872 Qnil, Qnil, default_string, Qnil);
873 if (NILP (name))
874 return name;
875 return Fintern (name, Qnil);
f927c5ae
JB
876}
877
878DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
879 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
880Prompts with PROMPT.\n\
e5d4686b 881Optional second arg DEF is value to return if user enters an empty line.\n\
f927c5ae
JB
882If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
883 (prompt, def, require_match)
884 Lisp_Object prompt, def, require_match;
885{
eebbfb01
KH
886 Lisp_Object args[4];
887
7510b296 888 if (BUFFERP (def))
f927c5ae 889 def = XBUFFER (def)->name;
eebbfb01
KH
890
891 if (NILP (Vread_buffer_function))
892 {
893 if (!NILP (def))
894 {
895 args[0] = build_string ("%s(default %s) ");
896 args[1] = prompt;
897 args[2] = def;
898 prompt = Fformat (3, args);
899 }
900
901 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
406e55df
RS
902 require_match, Qnil, Qbuffer_name_history,
903 def, Qnil);
eebbfb01
KH
904 }
905 else
f927c5ae 906 {
eebbfb01 907 args[0] = Vread_buffer_function;
f927c5ae
JB
908 args[1] = prompt;
909 args[2] = def;
eebbfb01
KH
910 args[3] = require_match;
911 return Ffuncall(4, args);
f927c5ae 912 }
f927c5ae
JB
913}
914\f
ec067ec7
RS
915static Lisp_Object
916minibuf_conform_representation (string, basis)
917 Lisp_Object string, basis;
918{
919 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
920 return string;
921
922 if (STRING_MULTIBYTE (string))
923 return Fstring_make_unibyte (string);
924 else
925 return Fstring_make_multibyte (string);
926}
927
f927c5ae
JB
928DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
929 "Return common substring of all completions of STRING in ALIST.\n\
930Each car of each element of ALIST is tested to see if it begins with STRING.\n\
931All that match are compared together; the longest initial sequence\n\
932common to all matches is returned as a string.\n\
933If there is no match at all, nil is returned.\n\
934For an exact match, t is returned.\n\
935\n\
936ALIST can be an obarray instead of an alist.\n\
937Then the print names of all symbols in the obarray are the possible matches.\n\
938\n\
939ALIST can also be a function to do the completion itself.\n\
940It receives three arguments: the values STRING, PREDICATE and nil.\n\
941Whatever it returns becomes the value of `try-completion'.\n\
942\n\
943If optional third argument PREDICATE is non-nil,\n\
944it is used to test each possible match.\n\
945The match is a candidate only if PREDICATE returns non-nil.\n\
89a255dc
RS
946The argument given to PREDICATE is the alist element\n\
947or the symbol from the obarray.")
7efd36fc
EN
948 (string, alist, predicate)
949 Lisp_Object string, alist, predicate;
f927c5ae
JB
950{
951 Lisp_Object bestmatch, tail, elt, eltstring;
af2b7cd5 952 /* Size in bytes of BESTMATCH. */
f927c5ae 953 int bestmatchsize;
af2b7cd5 954 /* These are in bytes, too. */
f927c5ae 955 int compare, matchsize;
56a98455 956 int list = CONSP (alist) || NILP (alist);
f927c5ae
JB
957 int index, obsize;
958 int matchcount = 0;
959 Lisp_Object bucket, zero, end, tem;
960 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
961
962 CHECK_STRING (string, 0);
7510b296 963 if (!list && !VECTORP (alist))
7efd36fc 964 return call3 (alist, string, predicate, Qnil);
f927c5ae
JB
965
966 bestmatch = Qnil;
967
968 /* If ALIST is not a list, set TAIL just for gc pro. */
969 tail = alist;
970 if (! list)
971 {
972 index = 0;
973 obsize = XVECTOR (alist)->size;
974 bucket = XVECTOR (alist)->contents[index];
975 }
976
977 while (1)
978 {
979 /* Get the next element of the alist or obarray. */
980 /* Exit the loop if the elements are all used up. */
981 /* elt gets the alist element or symbol.
982 eltstring gets the name to check as a completion. */
983
984 if (list)
985 {
56a98455 986 if (NILP (tail))
f927c5ae
JB
987 break;
988 elt = Fcar (tail);
989 eltstring = Fcar (elt);
990 tail = Fcdr (tail);
991 }
992 else
993 {
994 if (XFASTINT (bucket) != 0)
995 {
996 elt = bucket;
997 eltstring = Fsymbol_name (elt);
998 if (XSYMBOL (bucket)->next)
999 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1000 else
5a866662 1001 XSETFASTINT (bucket, 0);
f927c5ae
JB
1002 }
1003 else if (++index >= obsize)
1004 break;
1005 else
1006 {
1007 bucket = XVECTOR (alist)->contents[index];
1008 continue;
1009 }
1010 }
1011
1012 /* Is this element a possible completion? */
1013
7510b296 1014 if (STRINGP (eltstring)
7d315986 1015 && XSTRING (string)->size <= XSTRING (eltstring)->size
69f4ef20
RS
1016 && (tem = Fcompare_strings (eltstring, make_number (0),
1017 make_number (XSTRING (string)->size),
1018 string, make_number (0), Qnil,
1019 completion_ignore_case ?Qt : Qnil),
1020 EQ (Qt, tem)))
f927c5ae
JB
1021 {
1022 /* Yes. */
42006772
RS
1023 Lisp_Object regexps;
1024 Lisp_Object zero;
5a866662 1025 XSETFASTINT (zero, 0);
42006772
RS
1026
1027 /* Ignore this element if it fails to match all the regexps. */
1028 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
7539e11f 1029 regexps = XCDR (regexps))
42006772 1030 {
7539e11f 1031 tem = Fstring_match (XCAR (regexps), eltstring, zero);
42006772
RS
1032 if (NILP (tem))
1033 break;
1034 }
1035 if (CONSP (regexps))
1036 continue;
1037
f927c5ae
JB
1038 /* Ignore this element if there is a predicate
1039 and the predicate doesn't like it. */
1040
7efd36fc 1041 if (!NILP (predicate))
f927c5ae 1042 {
7efd36fc 1043 if (EQ (predicate, Qcommandp))
f927c5ae
JB
1044 tem = Fcommandp (elt);
1045 else
1046 {
1047 GCPRO4 (tail, string, eltstring, bestmatch);
7efd36fc 1048 tem = call1 (predicate, elt);
f927c5ae
JB
1049 UNGCPRO;
1050 }
56a98455 1051 if (NILP (tem)) continue;
f927c5ae
JB
1052 }
1053
1054 /* Update computation of how much all possible completions match */
1055
1056 matchcount++;
56a98455 1057 if (NILP (bestmatch))
af2b7cd5
RS
1058 {
1059 bestmatch = eltstring;
69f4ef20 1060 bestmatchsize = XSTRING (eltstring)->size;
af2b7cd5 1061 }
f927c5ae
JB
1062 else
1063 {
69f4ef20
RS
1064 compare = min (bestmatchsize, XSTRING (eltstring)->size);
1065 tem = Fcompare_strings (bestmatch, make_number (0),
1066 make_number (compare),
1067 eltstring, make_number (0),
1068 make_number (compare),
1069 completion_ignore_case ? Qt : Qnil);
1070 if (EQ (tem, Qt))
1071 matchsize = compare;
1072 else if (XINT (tem) < 0)
1073 matchsize = - XINT (tem) - 1;
1074 else
1075 matchsize = XINT (tem) - 1;
1076
52b14ac0
JB
1077 if (matchsize < 0)
1078 matchsize = compare;
1079 if (completion_ignore_case)
1080 {
1081 /* If this is an exact match except for case,
1082 use it as the best match rather than one that is not an
1083 exact match. This way, we get the case pattern
1084 of the actual match. */
69f4ef20
RS
1085 if ((matchsize == XSTRING (eltstring)->size
1086 && matchsize < XSTRING (bestmatch)->size)
52b14ac0
JB
1087 ||
1088 /* If there is more than one exact match ignoring case,
1089 and one of them is exact including case,
1090 prefer that one. */
1091 /* If there is no exact match ignoring case,
1092 prefer a match that does not change the case
1093 of the input. */
69f4ef20 1094 ((matchsize == XSTRING (eltstring)->size)
52b14ac0 1095 ==
69f4ef20
RS
1096 (matchsize == XSTRING (bestmatch)->size)
1097 && (tem = Fcompare_strings (eltstring, make_number (0),
1098 make_number (XSTRING (string)->size),
1099 string, make_number (0),
1100 Qnil,
1101 Qnil),
1102 EQ (Qt, tem))
1103 && (tem = Fcompare_strings (bestmatch, make_number (0),
1104 make_number (XSTRING (string)->size),
1105 string, make_number (0),
1106 Qnil,
1107 Qnil),
1108 ! EQ (Qt, tem))))
52b14ac0
JB
1109 bestmatch = eltstring;
1110 }
1111 bestmatchsize = matchsize;
f927c5ae
JB
1112 }
1113 }
1114 }
1115
56a98455 1116 if (NILP (bestmatch))
f927c5ae 1117 return Qnil; /* No completions found */
52b14ac0
JB
1118 /* If we are ignoring case, and there is no exact match,
1119 and no additional text was supplied,
1120 don't change the case of what the user typed. */
69f4ef20
RS
1121 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
1122 && XSTRING (bestmatch)->size > bestmatchsize)
ec067ec7 1123 return minibuf_conform_representation (string, bestmatch);
52b14ac0
JB
1124
1125 /* Return t if the supplied string is an exact match (counting case);
1126 it does not require any change to be made. */
69f4ef20
RS
1127 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
1128 && (tem = Fcompare_strings (bestmatch, make_number (0),
1129 make_number (bestmatchsize),
1130 string, make_number (0),
1131 make_number (bestmatchsize),
1132 Qnil),
1133 EQ (Qt, tem)))
f927c5ae
JB
1134 return Qt;
1135
5a866662
KH
1136 XSETFASTINT (zero, 0); /* Else extract the part in which */
1137 XSETFASTINT (end, bestmatchsize); /* all completions agree */
f927c5ae
JB
1138 return Fsubstring (bestmatch, zero, end);
1139}
1140
1141/* Compare exactly LEN chars of strings at S1 and S2,
1142 ignoring case if appropriate.
1143 Return -1 if strings match,
1144 else number of chars that match at the beginning. */
1145
829f7f7c 1146int
f927c5ae 1147scmp (s1, s2, len)
829f7f7c 1148 register unsigned char *s1, *s2;
f927c5ae
JB
1149 int len;
1150{
1151 register int l = len;
1152
1153 if (completion_ignore_case)
1154 {
2e34157c 1155 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
f927c5ae
JB
1156 l--;
1157 }
1158 else
1159 {
1160 while (l && *s1++ == *s2++)
1161 l--;
1162 }
1163 if (l == 0)
1164 return -1;
829f7f7c 1165 else
d50a3d2a
KH
1166 {
1167 int match = len - l;
1168
1169 /* Now *--S1 is the unmatching byte. If it is in the middle of
1170 multi-byte form, we must say that the multi-byte character
1171 there doesn't match. */
1172 while (match && *--s1 >= 0xA0) match--;
1173 return match;
1174 }
f927c5ae
JB
1175}
1176\f
89a255dc 1177DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
f927c5ae
JB
1178 "Search for partial matches to STRING in ALIST.\n\
1179Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1180The value is a list of all the strings from ALIST that match.\n\
89a255dc 1181\n\
f927c5ae
JB
1182ALIST can be an obarray instead of an alist.\n\
1183Then the print names of all symbols in the obarray are the possible matches.\n\
1184\n\
1185ALIST can also be a function to do the completion itself.\n\
1186It receives three arguments: the values STRING, PREDICATE and t.\n\
1187Whatever it returns becomes the value of `all-completion'.\n\
1188\n\
1189If optional third argument PREDICATE is non-nil,\n\
1190it is used to test each possible match.\n\
1191The match is a candidate only if PREDICATE returns non-nil.\n\
89a255dc
RS
1192The argument given to PREDICATE is the alist element\n\
1193or the symbol from the obarray.\n\
1194\n\
1195If the optional fourth argument HIDE-SPACES is non-nil,\n\
1196strings in ALIST that start with a space\n\
1197are ignored unless STRING itself starts with a space.")
7efd36fc
EN
1198 (string, alist, predicate, hide_spaces)
1199 Lisp_Object string, alist, predicate, hide_spaces;
f927c5ae
JB
1200{
1201 Lisp_Object tail, elt, eltstring;
1202 Lisp_Object allmatches;
56a98455 1203 int list = CONSP (alist) || NILP (alist);
f927c5ae
JB
1204 int index, obsize;
1205 Lisp_Object bucket, tem;
1206 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1207
1208 CHECK_STRING (string, 0);
7510b296 1209 if (!list && !VECTORP (alist))
f927c5ae 1210 {
7efd36fc 1211 return call3 (alist, string, predicate, Qt);
f927c5ae
JB
1212 }
1213 allmatches = Qnil;
1214
1215 /* If ALIST is not a list, set TAIL just for gc pro. */
1216 tail = alist;
1217 if (! list)
1218 {
1219 index = 0;
1220 obsize = XVECTOR (alist)->size;
1221 bucket = XVECTOR (alist)->contents[index];
1222 }
1223
1224 while (1)
1225 {
1226 /* Get the next element of the alist or obarray. */
1227 /* Exit the loop if the elements are all used up. */
1228 /* elt gets the alist element or symbol.
1229 eltstring gets the name to check as a completion. */
1230
1231 if (list)
1232 {
56a98455 1233 if (NILP (tail))
f927c5ae
JB
1234 break;
1235 elt = Fcar (tail);
1236 eltstring = Fcar (elt);
1237 tail = Fcdr (tail);
1238 }
1239 else
1240 {
1241 if (XFASTINT (bucket) != 0)
1242 {
1243 elt = bucket;
1244 eltstring = Fsymbol_name (elt);
1245 if (XSYMBOL (bucket)->next)
1246 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1247 else
5a866662 1248 XSETFASTINT (bucket, 0);
f927c5ae
JB
1249 }
1250 else if (++index >= obsize)
1251 break;
1252 else
1253 {
1254 bucket = XVECTOR (alist)->contents[index];
1255 continue;
1256 }
1257 }
1258
1259 /* Is this element a possible completion? */
1260
7510b296 1261 if (STRINGP (eltstring)
7d315986 1262 && XSTRING (string)->size <= XSTRING (eltstring)->size
89a255dc 1263 /* If HIDE_SPACES, reject alternatives that start with space
2cbaf886 1264 unless the input starts with space. */
fc932ac6 1265 && ((STRING_BYTES (XSTRING (string)) > 0
af2b7cd5 1266 && XSTRING (string)->data[0] == ' ')
89a255dc
RS
1267 || XSTRING (eltstring)->data[0] != ' '
1268 || NILP (hide_spaces))
69f4ef20
RS
1269 && (tem = Fcompare_strings (eltstring, make_number (0),
1270 make_number (XSTRING (string)->size),
1271 string, make_number (0),
1272 make_number (XSTRING (string)->size),
1273 completion_ignore_case ? Qt : Qnil),
1274 EQ (Qt, tem)))
f927c5ae
JB
1275 {
1276 /* Yes. */
42006772
RS
1277 Lisp_Object regexps;
1278 Lisp_Object zero;
5a866662 1279 XSETFASTINT (zero, 0);
42006772
RS
1280
1281 /* Ignore this element if it fails to match all the regexps. */
1282 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
7539e11f 1283 regexps = XCDR (regexps))
42006772 1284 {
7539e11f 1285 tem = Fstring_match (XCAR (regexps), eltstring, zero);
42006772
RS
1286 if (NILP (tem))
1287 break;
1288 }
1289 if (CONSP (regexps))
1290 continue;
1291
f927c5ae
JB
1292 /* Ignore this element if there is a predicate
1293 and the predicate doesn't like it. */
1294
7efd36fc 1295 if (!NILP (predicate))
f927c5ae 1296 {
7efd36fc 1297 if (EQ (predicate, Qcommandp))
f927c5ae
JB
1298 tem = Fcommandp (elt);
1299 else
1300 {
1301 GCPRO4 (tail, eltstring, allmatches, string);
7efd36fc 1302 tem = call1 (predicate, elt);
f927c5ae
JB
1303 UNGCPRO;
1304 }
56a98455 1305 if (NILP (tem)) continue;
f927c5ae
JB
1306 }
1307 /* Ok => put it on the list. */
1308 allmatches = Fcons (eltstring, allmatches);
1309 }
1310 }
1311
1312 return Fnreverse (allmatches);
1313}
1314\f
1315Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1316Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1317Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
ccf330a6 1318Lisp_Object Vminibuffer_completing_file_name;
f927c5ae 1319
b9d721de
JB
1320/* This comment supplies the doc string for completing-read,
1321 for make-docfile to see. We cannot put this in the real DEFUN
1322 due to limits in the Unix cpp.
1323
cee54539 1324DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
f927c5ae 1325 "Read a string in the minibuffer, with completion.\n\
f927c5ae
JB
1326PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1327TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1328PREDICATE limits completion to a subset of TABLE.\n\
60e6659c 1329See `try-completion' and `all-completions' for more details\n\
6b3faad8 1330 on completion, TABLE, and PREDICATE.\n\
cbbc3917 1331\n\
f927c5ae 1332If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
4ced3209 1333 the input is (or completes to) an element of TABLE or is null.\n\
f927c5ae 1334 If it is also not t, Return does not exit if it does non-null completion.\n\
fab95625 1335If the input is null, `completing-read' returns an empty string,\n\
cbbc3917
RS
1336 regardless of the value of REQUIRE-MATCH.\n\
1337\n\
f927c5ae 1338If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
770970cb
RS
1339 If it is (STRING . POSITION), the initial input\n\
1340 is STRING, but point is placed POSITION characters into the string.\n\
1341HIST, if non-nil, specifies a history list\n\
1342 and optionally the initial position in the list.\n\
1343 It can be a symbol, which is the history list variable to use,\n\
1344 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1345 In that case, HISTVAR is the history list variable to use,\n\
1346 and HISTPOS is the initial position (the position in the list\n\
4356f221 1347 which INITIAL-INPUT corresponds to).\n\
770970cb 1348 Positions are counted starting from 1 at the beginning of the list.\n\
cee54539
KH
1349DEF, if non-nil, is the default value.\n\
1350\n\
1351If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
c8c15521 1352 the current input method and the setting of enable-multibyte-characters.\n\
cee54539 1353\n\
770970cb 1354Completion ignores case if the ambient value of\n\
b9d721de
JB
1355 `completion-ignore-case' is non-nil."
1356*/
cee54539 1357DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
b9d721de 1358 0 /* See immediately above */)
cee54539 1359 (prompt, table, predicate, require_match, init, hist, def, inherit_input_method)
e5d4686b 1360 Lisp_Object prompt, table, predicate, require_match, init, hist, def;
cee54539 1361 Lisp_Object inherit_input_method;
f927c5ae 1362{
770970cb
RS
1363 Lisp_Object val, histvar, histpos, position;
1364 int pos = 0;
f927c5ae 1365 int count = specpdl_ptr - specpdl;
0c8ee1a2
RS
1366 struct gcpro gcpro1;
1367
1368 GCPRO1 (def);
1369
f927c5ae 1370 specbind (Qminibuffer_completion_table, table);
7efd36fc 1371 specbind (Qminibuffer_completion_predicate, predicate);
f927c5ae
JB
1372 specbind (Qminibuffer_completion_confirm,
1373 EQ (require_match, Qt) ? Qnil : Qt);
1374 last_exact_completion = Qnil;
770970cb
RS
1375
1376 position = Qnil;
1377 if (!NILP (init))
1378 {
7510b296 1379 if (CONSP (init))
770970cb
RS
1380 {
1381 position = Fcdr (init);
1382 init = Fcar (init);
1383 }
1384 CHECK_STRING (init, 0);
1385 if (!NILP (position))
1386 {
1387 CHECK_NUMBER (position, 0);
1388 /* Convert to distance from end of input. */
5dadd3a2 1389 pos = XINT (position) - XSTRING (init)->size;
770970cb
RS
1390 }
1391 }
1392
7510b296 1393 if (SYMBOLP (hist))
770970cb
RS
1394 {
1395 histvar = hist;
1396 histpos = Qnil;
1397 }
1398 else
1399 {
1400 histvar = Fcar_safe (hist);
1401 histpos = Fcdr_safe (hist);
1402 }
1403 if (NILP (histvar))
1404 histvar = Qminibuffer_history;
1405 if (NILP (histpos))
5a866662 1406 XSETFASTINT (histpos, 0);
770970cb 1407
56a98455 1408 val = read_minibuf (NILP (require_match)
f927c5ae
JB
1409 ? Vminibuffer_local_completion_map
1410 : Vminibuffer_local_must_match_map,
85b5fe07 1411 init, prompt, make_number (pos), 0,
cee54539
KH
1412 histvar, histpos, def, 0,
1413 !NILP (inherit_input_method));
b9a86585
RS
1414
1415 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (def))
1416 val = def;
1417
0c8ee1a2 1418 RETURN_UNGCPRO (unbind_to (count, val));
f927c5ae
JB
1419}
1420\f
f927c5ae 1421Lisp_Object Fminibuffer_completion_help ();
52b14ac0 1422Lisp_Object assoc_for_completion ();
5d2ca7ae
RS
1423
1424/* Test whether TXT is an exact completion. */
1425Lisp_Object
1426test_completion (txt)
1427 Lisp_Object txt;
1428{
1429 Lisp_Object tem;
1430
1431 if (CONSP (Vminibuffer_completion_table)
1432 || NILP (Vminibuffer_completion_table))
1433 return assoc_for_completion (txt, Vminibuffer_completion_table);
1434 else if (VECTORP (Vminibuffer_completion_table))
1435 {
1436 /* Bypass intern-soft as that loses for nil */
1437 tem = oblookup (Vminibuffer_completion_table,
af2b7cd5
RS
1438 XSTRING (txt)->data,
1439 XSTRING (txt)->size,
fc932ac6 1440 STRING_BYTES (XSTRING (txt)));
44472c88 1441 if (!SYMBOLP (tem))
9404446f
RS
1442 {
1443 if (STRING_MULTIBYTE (txt))
1444 txt = Fstring_make_unibyte (txt);
1445 else
1446 txt = Fstring_make_multibyte (txt);
1447
1448 tem = oblookup (Vminibuffer_completion_table,
1449 XSTRING (txt)->data,
1450 XSTRING (txt)->size,
1451 STRING_BYTES (XSTRING (txt)));
1452 if (!SYMBOLP (tem))
1453 return Qnil;
1454 }
1455 if (!NILP (Vminibuffer_completion_predicate))
5d2ca7ae
RS
1456 return call1 (Vminibuffer_completion_predicate, tem);
1457 else
1458 return Qt;
1459 }
1460 else
1461 return call3 (Vminibuffer_completion_table, txt,
1462 Vminibuffer_completion_predicate, Qlambda);
1463}
f927c5ae
JB
1464
1465/* returns:
1466 * 0 no possible completion
1467 * 1 was already an exact and unique completion
1468 * 3 was already an exact completion
1469 * 4 completed to an exact completion
1470 * 5 some completion happened
1471 * 6 no completion happened
1472 */
1473int
1474do_completion ()
1475{
1476 Lisp_Object completion, tem;
1477 int completedp;
1478 Lisp_Object last;
1e00c2ff 1479 struct gcpro gcpro1, gcpro2;
f927c5ae 1480
8e9968c6
GM
1481 completion = Ftry_completion (Ffield_string (ZV),
1482 Vminibuffer_completion_table,
f927c5ae
JB
1483 Vminibuffer_completion_predicate);
1484 last = last_exact_completion;
1485 last_exact_completion = Qnil;
1486
4f9b95e5
KH
1487 GCPRO2 (completion, last);
1488
56a98455 1489 if (NILP (completion))
f927c5ae
JB
1490 {
1491 bitch_at_user ();
1492 temp_echo_area_glyphs (" [No match]");
1e00c2ff 1493 UNGCPRO;
f927c5ae
JB
1494 return 0;
1495 }
1496
1497 if (EQ (completion, Qt)) /* exact and unique match */
1e00c2ff
KH
1498 {
1499 UNGCPRO;
1500 return 1;
1501 }
f927c5ae
JB
1502
1503 /* compiler bug */
8e9968c6 1504 tem = Fstring_equal (completion, Ffield_string(ZV));
13c67cc6
GM
1505 completedp = NILP (tem);
1506 if (completedp)
f927c5ae 1507 {
8e9968c6 1508 Ferase_field (make_number (ZV)); /* Some completion happened */
f927c5ae
JB
1509 Finsert (1, &completion);
1510 }
1511
1512 /* It did find a match. Do we match some possibility exactly now? */
8e9968c6 1513 tem = test_completion (Ffield_string(ZV));
56a98455 1514 if (NILP (tem))
1e00c2ff
KH
1515 {
1516 /* not an exact match */
1517 UNGCPRO;
f927c5ae
JB
1518 if (completedp)
1519 return 5;
1520 else if (auto_help)
1521 Fminibuffer_completion_help ();
1522 else
1523 temp_echo_area_glyphs (" [Next char not unique]");
1524 return 6;
1525 }
1526 else if (completedp)
1e00c2ff
KH
1527 {
1528 UNGCPRO;
1529 return 4;
1530 }
f927c5ae
JB
1531 /* If the last exact completion and this one were the same,
1532 it means we've already given a "Complete but not unique"
52b14ac0 1533 message and the user's hit TAB again, so now we give him help. */
f927c5ae 1534 last_exact_completion = completion;
56a98455 1535 if (!NILP (last))
f927c5ae 1536 {
8e9968c6 1537 tem = Ffield_string (ZV);
56a98455 1538 if (!NILP (Fequal (tem, last)))
f927c5ae
JB
1539 Fminibuffer_completion_help ();
1540 }
1e00c2ff 1541 UNGCPRO;
f927c5ae 1542 return 3;
f927c5ae 1543}
1e00c2ff 1544
52b14ac0
JB
1545/* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1546
1547Lisp_Object
1548assoc_for_completion (key, list)
1549 register Lisp_Object key;
1550 Lisp_Object list;
1551{
1552 register Lisp_Object tail;
1553
56a98455 1554 for (tail = list; !NILP (tail); tail = Fcdr (tail))
52b14ac0
JB
1555 {
1556 register Lisp_Object elt, tem, thiscar;
1557 elt = Fcar (tail);
1558 if (!CONSP (elt)) continue;
1559 thiscar = Fcar (elt);
7510b296 1560 if (!STRINGP (thiscar))
52b14ac0 1561 continue;
9404446f
RS
1562 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1563 key, make_number (0), Qnil,
1564 completion_ignore_case ? Qt : Qnil);
1565 if (EQ (tem, Qt))
1566 return elt;
52b14ac0
JB
1567 QUIT;
1568 }
1569 return Qnil;
1570}
f927c5ae
JB
1571
1572DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
6300d782 1573 "Complete the minibuffer contents as far as possible.\n\
2cb6da5c
RS
1574Return nil if there is no valid completion, else t.\n\
1575If no characters can be completed, display a list of possible completions.\n\
1576If you repeat this command after it displayed such a list,\n\
1577scroll the window of possible completions.")
f927c5ae
JB
1578 ()
1579{
2cb6da5c
RS
1580 register int i;
1581 Lisp_Object window, tem;
1582
df902b62
RS
1583 /* If the previous command was not this,
1584 mark the completion buffer obsolete. */
1585 if (! EQ (current_kboard->Vlast_command, Vthis_command))
2cb6da5c
RS
1586 Vminibuf_scroll_window = Qnil;
1587
1588 window = Vminibuf_scroll_window;
1589 /* If there's a fresh completion window with a live buffer,
1590 and this command is repeated, scroll that window. */
1591 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1592 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1593 {
1594 struct buffer *obuf = current_buffer;
1595
1596 Fset_buffer (XWINDOW (window)->buffer);
1597 tem = Fpos_visible_in_window_p (make_number (ZV), window);
1598 if (! NILP (tem))
1599 /* If end is in view, scroll up to the beginning. */
b7df898e 1600 Fset_window_start (window, make_number (BEGV), Qnil);
2cb6da5c
RS
1601 else
1602 /* Else scroll down one screen. */
1603 Fscroll_other_window (Qnil);
1604
1605 set_buffer_internal (obuf);
1606 return Qnil;
1607 }
1608
1609 i = do_completion ();
f927c5ae
JB
1610 switch (i)
1611 {
1612 case 0:
1613 return Qnil;
1614
1615 case 1:
1616 temp_echo_area_glyphs (" [Sole completion]");
1617 break;
1618
1619 case 3:
1620 temp_echo_area_glyphs (" [Complete, but not unique]");
1621 break;
1622 }
1623
1624 return Qt;
1625}
e4c97a67
RS
1626\f
1627/* Subroutines of Fminibuffer_complete_and_exit. */
1628
1629/* This one is called by internal_condition_case to do the real work. */
1630
1631Lisp_Object
1632complete_and_exit_1 ()
1633{
1634 return make_number (do_completion ());
1635}
1636
1637/* This one is called by internal_condition_case if an error happens.
1638 Pretend the current value is an exact match. */
1639
1640Lisp_Object
1641complete_and_exit_2 (ignore)
1642 Lisp_Object ignore;
1643{
1644 return make_number (1);
1645}
f927c5ae
JB
1646
1647DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1648 Sminibuffer_complete_and_exit, 0, 0, "",
5d2ca7ae
RS
1649 "If the minibuffer contents is a valid completion then exit.\n\
1650Otherwise try to complete it. If completion leads to a valid completion,\n\
f927c5ae
JB
1651a repetition of this command will exit.")
1652 ()
1653{
1654 register int i;
e4c97a67 1655 Lisp_Object val;
f927c5ae
JB
1656
1657 /* Allow user to specify null string */
8e9968c6 1658 if (Ffield_beginning (ZV, Qnil) == ZV)
f927c5ae
JB
1659 goto exit;
1660
8e9968c6 1661 if (!NILP (test_completion (Ffield_string (ZV))))
5d2ca7ae
RS
1662 goto exit;
1663
e4c97a67
RS
1664 /* Call do_completion, but ignore errors. */
1665 val = internal_condition_case (complete_and_exit_1, Qerror,
1666 complete_and_exit_2);
1667
1668 i = XFASTINT (val);
f927c5ae
JB
1669 switch (i)
1670 {
1671 case 1:
1672 case 3:
1673 goto exit;
1674
1675 case 4:
56a98455 1676 if (!NILP (Vminibuffer_completion_confirm))
f927c5ae
JB
1677 {
1678 temp_echo_area_glyphs (" [Confirm]");
1679 return Qnil;
1680 }
1681 else
1682 goto exit;
1683
1684 default:
1685 return Qnil;
1686 }
1687 exit:
1688 Fthrow (Qexit, Qnil);
1689 /* NOTREACHED */
1690}
1691
1692DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1693 0, 0, "",
1694 "Complete the minibuffer contents at most a single word.\n\
1695After one word is completed as much as possible, a space or hyphen\n\
6300d782
KH
1696is added, provided that matches some possible completion.\n\
1697Return nil if there is no valid completion, else t.")
f927c5ae
JB
1698 ()
1699{
69f4ef20 1700 Lisp_Object completion, tem, tem1;
af2b7cd5 1701 register int i, i_byte;
f927c5ae 1702 register unsigned char *completion_string;
d7be4211 1703 struct gcpro gcpro1, gcpro2;
8e9968c6 1704 int prompt_end_charpos;
b278606c
BF
1705
1706 /* We keep calling Fbuffer_string rather than arrange for GC to
1707 hold onto a pointer to one of the strings thus made. */
f927c5ae 1708
8e9968c6 1709 completion = Ftry_completion (Ffield_string (ZV),
f927c5ae
JB
1710 Vminibuffer_completion_table,
1711 Vminibuffer_completion_predicate);
56a98455 1712 if (NILP (completion))
f927c5ae
JB
1713 {
1714 bitch_at_user ();
1715 temp_echo_area_glyphs (" [No match]");
1716 return Qnil;
1717 }
1718 if (EQ (completion, Qt))
1719 return Qnil;
1720
b278606c 1721#if 0 /* How the below code used to look, for reference. */
8e9968c6 1722 tem = Ffield_string (ZV);
f927c5ae
JB
1723 b = XSTRING (tem)->data;
1724 i = ZV - 1 - XSTRING (completion)->size;
1725 p = XSTRING (completion)->data;
1726 if (i > 0 ||
1727 0 <= scmp (b, p, ZV - 1))
1728 {
1729 i = 1;
1730 /* Set buffer to longest match of buffer tail and completion head. */
1731 while (0 <= scmp (b + i, p, ZV - 1 - i))
1732 i++;
1733 del_range (1, i + 1);
1734 SET_PT (ZV);
1735 }
1736#else /* Rewritten code */
1737 {
69f4ef20 1738 int buffer_nchars, completion_nchars;
f927c5ae 1739
59860a8c 1740 CHECK_STRING (completion, 0);
8e9968c6 1741 tem = Ffield_string (ZV);
d7be4211 1742 GCPRO2 (completion, tem);
719b4a40
RS
1743 /* If reading a file name,
1744 expand any $ENVVAR refs in the buffer and in TEM. */
ccf330a6 1745 if (! NILP (Vminibuffer_completing_file_name))
719b4a40
RS
1746 {
1747 Lisp_Object substituted;
1748 substituted = Fsubstitute_in_file_name (tem);
1749 if (! EQ (substituted, tem))
1750 {
1751 tem = substituted;
8e9968c6 1752 Ferase_field (make_number (ZV));
af2b7cd5 1753 insert_from_string (tem, 0, 0, XSTRING (tem)->size,
fc932ac6 1754 STRING_BYTES (XSTRING (tem)), 0);
719b4a40
RS
1755 }
1756 }
69f4ef20
RS
1757 buffer_nchars = XSTRING (tem)->size; /* ie ZV - BEGV */
1758 completion_nchars = XSTRING (completion)->size;
1759 i = buffer_nchars - completion_nchars;
1760 if (i > 0
1761 ||
1762 (tem1 = Fcompare_strings (tem, make_number (0),
1763 make_number (buffer_nchars),
1764 completion, make_number (0),
1765 make_number (buffer_nchars),
1766 completion_ignore_case ? Qt : Qnil),
1767 ! EQ (tem1, Qt)))
f927c5ae 1768 {
69f4ef20
RS
1769 int start_pos;
1770
1771 /* Set buffer to longest match of buffer tail and completion head. */
1772 if (i <= 0) i = 1;
1773 start_pos= i;
1774 buffer_nchars -= i;
669c6673 1775 while (i > 0)
69f4ef20 1776 {
669c6673 1777 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
69f4ef20
RS
1778 completion, make_number (0),
1779 make_number (buffer_nchars),
1780 completion_ignore_case ? Qt : Qnil);
1781 start_pos++;
1782 if (EQ (tem1, Qt))
1783 break;
1784 i++;
669c6673 1785 buffer_nchars--;
69f4ef20
RS
1786 }
1787 del_range (1, i + 1);
a9c26562 1788 SET_PT_BOTH (ZV, ZV_BYTE);
f927c5ae 1789 }
d7be4211 1790 UNGCPRO;
f927c5ae
JB
1791 }
1792#endif /* Rewritten code */
279cf52c 1793
8e9968c6
GM
1794 prompt_end_charpos = Ffield_beginning (make_number (ZV), Qnil);
1795
279cf52c 1796 {
8e9968c6 1797 int prompt_end_bytepos;
279cf52c
GM
1798 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
1799 i = ZV - prompt_end_charpos;
1800 i_byte = ZV_BYTE - prompt_end_bytepos;
1801 }
f927c5ae
JB
1802
1803 /* If completion finds next char not unique,
b278606c 1804 consider adding a space or a hyphen. */
f927c5ae
JB
1805 if (i == XSTRING (completion)->size)
1806 {
b278606c 1807 GCPRO1 (completion);
8e9968c6 1808 tem = Ftry_completion (concat2 (Ffield_string (ZV), build_string (" ")),
f927c5ae
JB
1809 Vminibuffer_completion_table,
1810 Vminibuffer_completion_predicate);
b278606c
BF
1811 UNGCPRO;
1812
7510b296 1813 if (STRINGP (tem))
f927c5ae
JB
1814 completion = tem;
1815 else
1816 {
b278606c
BF
1817 GCPRO1 (completion);
1818 tem =
8e9968c6 1819 Ftry_completion (concat2 (Ffield_string (ZV), build_string ("-")),
b278606c
BF
1820 Vminibuffer_completion_table,
1821 Vminibuffer_completion_predicate);
1822 UNGCPRO;
1823
7510b296 1824 if (STRINGP (tem))
f927c5ae
JB
1825 completion = tem;
1826 }
1827 }
1828
1829 /* Now find first word-break in the stuff found by completion.
1830 i gets index in string of where to stop completing. */
d50a3d2a
KH
1831 {
1832 int len, c;
54643b2c 1833 int bytes = STRING_BYTES (XSTRING (completion));
d50a3d2a 1834 completion_string = XSTRING (completion)->data;
fc932ac6 1835 for (; i_byte < STRING_BYTES (XSTRING (completion)); i_byte += len, i++)
d50a3d2a 1836 {
af2b7cd5 1837 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
54643b2c 1838 bytes - i_byte,
d50a3d2a
KH
1839 len);
1840 if (SYNTAX (c) != Sword)
1841 {
af2b7cd5
RS
1842 i_byte += len;
1843 i++;
d50a3d2a
KH
1844 break;
1845 }
1846 }
1847 }
f927c5ae
JB
1848
1849 /* If got no characters, print help for user. */
1850
8e9968c6 1851 if (i == ZV - prompt_end_charpos)
f927c5ae
JB
1852 {
1853 if (auto_help)
1854 Fminibuffer_completion_help ();
1855 return Qnil;
1856 }
1857
1858 /* Otherwise insert in minibuffer the chars we got */
1859
8e9968c6 1860 Ferase_field (make_number (ZV));
af2b7cd5 1861 insert_from_string (completion, 0, 0, i, i_byte, 1);
f927c5ae
JB
1862 return Qt;
1863}
1864\f
1865DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
1866 1, 1, 0,
2dc2b736 1867 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
f927c5ae 1868Each element may be just a symbol or string\n\
2d7e41fe
RS
1869or may be a list of two strings to be printed as if concatenated.\n\
1870`standard-output' must be a buffer.\n\
5744fa7c
RS
1871The actual completion alternatives, as inserted, are given `mouse-face'\n\
1872properties of `highlight'.\n\
1873At the end, this runs the normal hook `completion-setup-hook'.\n\
2d7e41fe 1874It can find the completion buffer in `standard-output'.")
f927c5ae
JB
1875 (completions)
1876 Lisp_Object completions;
1877{
dae36123 1878 Lisp_Object tail, elt;
f927c5ae 1879 register int i;
2dc2b736 1880 int column = 0;
dae36123 1881 struct gcpro gcpro1, gcpro2;
2dc2b736 1882 struct buffer *old = current_buffer;
681f5af4 1883 int first = 1;
486cc7fb
RS
1884
1885 /* Note that (when it matters) every variable
dae36123
RS
1886 points to a non-string that is pointed to by COMPLETIONS,
1887 except for ELT. ELT can be pointing to a string
1888 when terpri or Findent_to calls a change hook. */
1889 elt = Qnil;
1890 GCPRO2 (completions, elt);
486cc7fb 1891
7510b296 1892 if (BUFFERP (Vstandard_output))
2dc2b736 1893 set_buffer_internal (XBUFFER (Vstandard_output));
f927c5ae 1894
56a98455 1895 if (NILP (completions))
cfc736bf
RS
1896 write_string ("There are no possible completions of what you have typed.",
1897 -1);
f927c5ae
JB
1898 else
1899 {
2dc2b736 1900 write_string ("Possible completions are:", -1);
56a98455 1901 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
f927c5ae 1902 {
ec067ec7 1903 Lisp_Object tem, string;
681f5af4 1904 int length;
47d7d104 1905 Lisp_Object startpos, endpos;
681f5af4
RS
1906
1907 elt = Fcar (tail);
1908 /* Compute the length of this element. */
1909 if (CONSP (elt))
1910 {
49db96ce 1911 tem = XCAR (elt);
681f5af4 1912 CHECK_STRING (tem, 0);
49db96ce 1913 length = XSTRING (tem)->size;
681f5af4 1914
49db96ce 1915 tem = Fcar (XCDR (elt));
681f5af4 1916 CHECK_STRING (tem, 0);
49db96ce 1917 length += XSTRING (tem)->size;
681f5af4
RS
1918 }
1919 else
1920 {
1921 CHECK_STRING (elt, 0);
49db96ce 1922 length = XSTRING (elt)->size;
681f5af4
RS
1923 }
1924
1925 /* This does a bad job for narrower than usual windows.
1926 Sadly, the window it will appear in is not known
1927 until after the text has been made. */
1928
47d7d104
RS
1929 if (BUFFERP (Vstandard_output))
1930 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
1931
681f5af4
RS
1932 /* If the previous completion was very wide,
1933 or we have two on this line already,
1934 don't put another on the same line. */
1935 if (column > 33 || first
1936 /* If this is really wide, don't put it second on a line. */
13c67cc6 1937 || (column > 0 && length > 45))
681f5af4
RS
1938 {
1939 Fterpri (Qnil);
1940 column = 0;
1941 }
1942 /* Otherwise advance to column 35. */
1943 else
2dc2b736 1944 {
7510b296 1945 if (BUFFERP (Vstandard_output))
681f5af4
RS
1946 {
1947 tem = Findent_to (make_number (35), make_number (2));
47d7d104 1948
681f5af4
RS
1949 column = XINT (tem);
1950 }
2dc2b736
RS
1951 else
1952 {
1953 do
1954 {
1955 write_string (" ", -1);
1956 column++;
1957 }
1958 while (column < 35);
1959 }
1960 }
681f5af4 1961
47d7d104
RS
1962 if (BUFFERP (Vstandard_output))
1963 {
1964 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
1965 Fset_text_properties (startpos, endpos,
1966 Qnil, Vstandard_output);
1967 }
1968
ec067ec7 1969 /* Output this element.
9404446f 1970 If necessary, convert it to unibyte or to multibyte first. */
f927c5ae 1971 if (CONSP (elt))
ec067ec7 1972 string = Fcar (elt);
f927c5ae 1973 else
ec067ec7
RS
1974 string = elt;
1975 if (NILP (current_buffer->enable_multibyte_characters)
1976 && STRING_MULTIBYTE (string))
1977 string = Fstring_make_unibyte (string);
9404446f
RS
1978 else if (!NILP (current_buffer->enable_multibyte_characters)
1979 && !STRING_MULTIBYTE (string))
1980 string = Fstring_make_multibyte (string);
5744fa7c
RS
1981
1982 if (BUFFERP (Vstandard_output))
1983 {
4b37311e 1984 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
5744fa7c
RS
1985
1986 Fprinc (string, Qnil);
1987
4b37311e 1988 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
5744fa7c 1989
4b37311e 1990 Fput_text_property (startpos, endpos,
5744fa7c
RS
1991 Qmouse_face, intern ("highlight"),
1992 Vstandard_output);
1993 }
1994 else
1995 {
1996 Fprinc (string, Qnil);
1997 }
ec067ec7
RS
1998
1999 /* Output the annotation for this element. */
2000 if (CONSP (elt))
4b37311e
RS
2001 {
2002 if (BUFFERP (Vstandard_output))
2003 {
2004 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2005
2006 Fprinc (Fcar (Fcdr (elt)), Qnil);
2007
2008 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2009
2010 Fset_text_properties (startpos, endpos, Qnil,
2011 Vstandard_output);
2012 }
2013 else
2014 {
2015 Fprinc (Fcar (Fcdr (elt)), Qnil);
2016 }
2017 }
2018
681f5af4 2019
ec067ec7 2020 /* Update COLUMN for what we have output. */
681f5af4
RS
2021 column += length;
2022
2023 /* If output is to a buffer, recompute COLUMN in a way
2024 that takes account of character widths. */
2025 if (BUFFERP (Vstandard_output))
2dc2b736 2026 {
681f5af4
RS
2027 tem = Fcurrent_column ();
2028 column = XINT (tem);
2dc2b736 2029 }
681f5af4
RS
2030
2031 first = 0;
f927c5ae
JB
2032 }
2033 }
2dc2b736 2034
486cc7fb
RS
2035 UNGCPRO;
2036
7510b296 2037 if (BUFFERP (Vstandard_output))
2d7e41fe
RS
2038 set_buffer_internal (old);
2039
cfc736bf
RS
2040 if (!NILP (Vrun_hooks))
2041 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2042
f927c5ae
JB
2043 return Qnil;
2044}
2045
2046DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
2047 0, 0, "",
2048 "Display a list of possible completions of the current minibuffer contents.")
2049 ()
2050{
2051 Lisp_Object completions;
2052
2053 message ("Making completion list...");
8e9968c6 2054 completions = Fall_completions (Ffield_string (ZV),
f927c5ae 2055 Vminibuffer_completion_table,
89a255dc
RS
2056 Vminibuffer_completion_predicate,
2057 Qt);
39e98b38 2058 clear_message (1, 0);
f927c5ae 2059
56a98455 2060 if (NILP (completions))
f927c5ae
JB
2061 {
2062 bitch_at_user ();
2063 temp_echo_area_glyphs (" [No completions]");
2064 }
2065 else
2066 internal_with_output_to_temp_buffer ("*Completions*",
2067 Fdisplay_completion_list,
2068 Fsort (completions, Qstring_lessp));
2069 return Qnil;
2070}
2071\f
2072DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
2073 "Terminate minibuffer input.")
2074 ()
2075{
7510b296 2076 if (INTEGERP (last_command_char))
dab3ab3c 2077 internal_self_insert (XINT (last_command_char), 0);
f927c5ae
JB
2078 else
2079 bitch_at_user ();
2080
2081 Fthrow (Qexit, Qnil);
2082}
2083
2084DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
2085 "Terminate this minibuffer argument.")
2086 ()
2087{
2088 Fthrow (Qexit, Qnil);
2089}
2090
2091DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2092 "Return current depth of activations of minibuffer, a nonnegative integer.")
2093 ()
2094{
2095 return make_number (minibuf_level);
2096}
2097
37e9a934
KH
2098DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2099 "Return the prompt string of the currently-active minibuffer.\n\
2100If no minibuffer is active, return nil.")
2101 ()
2102{
4d04c1f1 2103 return Fcopy_sequence (minibuf_prompt);
37e9a934
KH
2104}
2105
f927c5ae 2106\f
2d955a50
RS
2107/* Temporarily display the string M at the end of the current
2108 minibuffer contents. This is used to display things like
2109 "[No Match]" when the user requests a completion for a prefix
2110 that has no possible completions, and other quick, unobtrusive
2111 messages. */
2112
9d815fd9 2113void
2d955a50
RS
2114temp_echo_area_glyphs (m)
2115 char *m;
2116{
2117 int osize = ZV;
a9c26562 2118 int osize_byte = ZV_BYTE;
2d955a50 2119 int opoint = PT;
a9c26562 2120 int opoint_byte = PT_BYTE;
2d955a50
RS
2121 Lisp_Object oinhibit;
2122 oinhibit = Vinhibit_quit;
2123
2124 /* Clear out any old echo-area message to make way for our new thing. */
2125 message (0);
2126
a9c26562 2127 SET_PT_BOTH (osize, osize_byte);
2d955a50 2128 insert_string (m);
a9c26562 2129 SET_PT_BOTH (opoint, opoint_byte);
2d955a50
RS
2130 Vinhibit_quit = Qt;
2131 Fsit_for (make_number (2), Qnil, Qnil);
bc69581b 2132 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
a9c26562 2133 SET_PT_BOTH (opoint, opoint_byte);
2d955a50
RS
2134 if (!NILP (Vquit_flag))
2135 {
2136 Vquit_flag = Qnil;
2137 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2138 }
2139 Vinhibit_quit = oinhibit;
2140}
2141
2142DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2143 1, 1, 0,
2144 "Temporarily display STRING at the end of the minibuffer.\n\
2145The text is displayed for two seconds,\n\
2146or until the next input event arrives, whichever comes first.")
2147 (string)
2148 Lisp_Object string;
2149{
2150 temp_echo_area_glyphs (XSTRING (string)->data);
2151 return Qnil;
2152}
2153\f
9d815fd9 2154void
f927c5ae
JB
2155init_minibuf_once ()
2156{
2157 Vminibuffer_list = Qnil;
2158 staticpro (&Vminibuffer_list);
2159}
2160
9d815fd9 2161void
f927c5ae
JB
2162syms_of_minibuf ()
2163{
2164 minibuf_level = 0;
4d04c1f1
KH
2165 minibuf_prompt = Qnil;
2166 staticpro (&minibuf_prompt);
2167
2168 minibuf_save_list = Qnil;
2169 staticpro (&minibuf_save_list);
f927c5ae 2170
719b4a40
RS
2171 Qread_file_name_internal = intern ("read-file-name-internal");
2172 staticpro (&Qread_file_name_internal);
2173
e5d4686b
RS
2174 Qminibuffer_default = intern ("minibuffer-default");
2175 staticpro (&Qminibuffer_default);
2176 Fset (Qminibuffer_default, Qnil);
2177
f927c5ae
JB
2178 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2179 staticpro (&Qminibuffer_completion_table);
2180
2181 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2182 staticpro (&Qminibuffer_completion_confirm);
2183
2184 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2185 staticpro (&Qminibuffer_completion_predicate);
2186
1e00c2ff
KH
2187 staticpro (&last_exact_completion);
2188 last_exact_completion = Qnil;
2189
f927c5ae
JB
2190 staticpro (&last_minibuf_string);
2191 last_minibuf_string = Qnil;
2192
2193 Quser_variable_p = intern ("user-variable-p");
2194 staticpro (&Quser_variable_p);
2195
770970cb
RS
2196 Qminibuffer_history = intern ("minibuffer-history");
2197 staticpro (&Qminibuffer_history);
f927c5ae 2198
406e55df
RS
2199 Qbuffer_name_history = intern ("buffer-name-history");
2200 staticpro (&Qbuffer_name_history);
33d0a17f 2201 Fset (Qbuffer_name_history, Qnil);
406e55df 2202
5c781212
RS
2203 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2204 staticpro (&Qminibuffer_setup_hook);
2205
177aecf9
KH
2206 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2207 staticpro (&Qminibuffer_exit_hook);
2208
77aa8edf
RS
2209 Qhistory_length = intern ("history-length");
2210 staticpro (&Qhistory_length);
2211
cee54539
KH
2212 Qcurrent_input_method = intern ("current-input-method");
2213 staticpro (&Qcurrent_input_method);
2214
2215 Qactivate_input_method = intern ("activate-input-method");
2216 staticpro (&Qactivate_input_method);
2217
eebbfb01
KH
2218 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2219 "If this is non-nil, `read-buffer' does its work by calling this function.");
2220 Vread_buffer_function = Qnil;
2221
5c781212
RS
2222 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2223 "Normal hook run just after entry to minibuffer.");
2224 Vminibuffer_setup_hook = Qnil;
2225
177aecf9
KH
2226 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2227 "Normal hook run just after exit from minibuffer.");
2228 Vminibuffer_exit_hook = Qnil;
2229
77aa8edf
RS
2230 DEFVAR_LISP ("history-length", &Vhistory_length,
2231 "*Maximum length for history lists before truncation takes place.\n\
2232A number means that length; t means infinite. Truncation takes place\n\
2233just after a new element is inserted. Setting the history-length\n\
2234property of a history variable overrides this default.");
2235 XSETFASTINT (Vhistory_length, 30);
2236
f927c5ae
JB
2237 DEFVAR_BOOL ("completion-auto-help", &auto_help,
2238 "*Non-nil means automatically provide help for invalid completion input.");
2239 auto_help = 1;
2240
2241 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2242 "Non-nil means don't consider case significant in completion.");
2243 completion_ignore_case = 0;
2244
2245 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2246 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
7e3e3ad1 2247This variable makes a difference whenever the minibuffer window is active.");
f927c5ae
JB
2248 enable_recursive_minibuffers = 0;
2249
2250 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2251 "Alist or obarray used for completion in the minibuffer.\n\
2252This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2253\n\
2254The value may alternatively be a function, which is given three arguments:\n\
2255 STRING, the current buffer contents;\n\
2256 PREDICATE, the predicate for filtering possible matches;\n\
2257 CODE, which says what kind of things to do.\n\
2258CODE can be nil, t or `lambda'.\n\
2259nil means to return the best completion of STRING, or nil if there is none.\n\
2260t means to return a list of all possible completions of STRING.\n\
2261`lambda' means to return t if STRING is a valid completion as it stands.");
2262 Vminibuffer_completion_table = Qnil;
2263
2264 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2265 "Within call to `completing-read', this holds the PREDICATE argument.");
2266 Vminibuffer_completion_predicate = Qnil;
2267
2268 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2269 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2270 Vminibuffer_completion_confirm = Qnil;
2271
ccf330a6
RS
2272 DEFVAR_LISP ("minibuffer-completing-file-name",
2273 &Vminibuffer_completing_file_name,
2274 "Non-nil means completing file names.");
2275 Vminibuffer_completing_file_name = Qnil;
2276
f927c5ae
JB
2277 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2278 "Value that `help-form' takes on inside the minibuffer.");
2279 Vminibuffer_help_form = Qnil;
2280
770970cb
RS
2281 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2282 "History list symbol to add minibuffer values to.\n\
2fa2413b
RS
2283Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2284is added with\n\
770970cb
RS
2285 (set minibuffer-history-variable\n\
2286 (cons STRING (symbol-value minibuffer-history-variable)))");
5a866662 2287 XSETFASTINT (Vminibuffer_history_variable, 0);
770970cb
RS
2288
2289 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2290 "Current position of redoing in the history list.");
2291 Vminibuffer_history_position = Qnil;
2292
6a9ee000 2293 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
e98bcc1a
RS
2294 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2295Some uses of the echo area also raise that frame (since they use it too).");
6a9ee000
RS
2296 minibuffer_auto_raise = 0;
2297
42006772
RS
2298 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2299 "List of regexps that should restrict possible completions.");
2300 Vcompletion_regexp_list = Qnil;
2301
c3421833
RS
2302 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2303 &minibuffer_allow_text_properties,
e9cccb71 2304 "Non-nil means `read-from-minibuffer' should not discard text properties.\n\
c3421833
RS
2305This also affects `read-string', but it does not affect `read-minibuffer',\n\
2306`read-no-blanks-input', or any of the functions that do minibuffer input\n\
2bfbde2b 2307with completion; they always discard text properties.");
c3421833
RS
2308 minibuffer_allow_text_properties = 0;
2309
68313ed8 2310 defsubr (&Sset_minibuffer_window);
f927c5ae
JB
2311 defsubr (&Sread_from_minibuffer);
2312 defsubr (&Seval_minibuffer);
2313 defsubr (&Sread_minibuffer);
2314 defsubr (&Sread_string);
2315 defsubr (&Sread_command);
2316 defsubr (&Sread_variable);
2317 defsubr (&Sread_buffer);
2318 defsubr (&Sread_no_blanks_input);
2319 defsubr (&Sminibuffer_depth);
37e9a934 2320 defsubr (&Sminibuffer_prompt);
f927c5ae
JB
2321
2322 defsubr (&Stry_completion);
2323 defsubr (&Sall_completions);
2324 defsubr (&Scompleting_read);
2325 defsubr (&Sminibuffer_complete);
2326 defsubr (&Sminibuffer_complete_word);
2327 defsubr (&Sminibuffer_complete_and_exit);
2328 defsubr (&Sdisplay_completion_list);
2329 defsubr (&Sminibuffer_completion_help);
2330
2331 defsubr (&Sself_insert_and_exit);
2332 defsubr (&Sexit_minibuffer);
2333
2d955a50 2334 defsubr (&Sminibuffer_message);
f927c5ae
JB
2335}
2336
9d815fd9 2337void
f927c5ae
JB
2338keys_of_minibuf ()
2339{
2340 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2341 "abort-recursive-edit");
2342 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2343 "exit-minibuffer");
2344 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2345 "exit-minibuffer");
2346
2347 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
2348 "abort-recursive-edit");
2349 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
2350 "exit-minibuffer");
2351 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
2352 "exit-minibuffer");
2353
2354 initial_define_key (Vminibuffer_local_ns_map, ' ',
2355 "exit-minibuffer");
2356 initial_define_key (Vminibuffer_local_ns_map, '\t',
2357 "exit-minibuffer");
2358 initial_define_key (Vminibuffer_local_ns_map, '?',
2359 "self-insert-and-exit");
2360
2361 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
2362 "abort-recursive-edit");
2363 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
2364 "exit-minibuffer");
2365 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
2366 "exit-minibuffer");
2367
2368 initial_define_key (Vminibuffer_local_completion_map, '\t',
2369 "minibuffer-complete");
2370 initial_define_key (Vminibuffer_local_completion_map, ' ',
2371 "minibuffer-complete-word");
2372 initial_define_key (Vminibuffer_local_completion_map, '?',
2373 "minibuffer-completion-help");
2374
2375 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
2376 "abort-recursive-edit");
2377 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2378 "minibuffer-complete-and-exit");
2379 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2380 "minibuffer-complete-and-exit");
2381 initial_define_key (Vminibuffer_local_must_match_map, '\t',
2382 "minibuffer-complete");
2383 initial_define_key (Vminibuffer_local_must_match_map, ' ',
2384 "minibuffer-complete-word");
2385 initial_define_key (Vminibuffer_local_must_match_map, '?',
2386 "minibuffer-completion-help");
2387}