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