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