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