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