(Fcompleting_read): Doc fix.
[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 #include "lisp.h"
26 #include "commands.h"
27 #include "buffer.h"
28 #include "charset.h"
29 #include "dispextern.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "syntax.h"
34 #include "intervals.h"
35
36 #define min(a, b) ((a) < (b) ? (a) : (b))
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 /* Non-nil means it is the window for C-M-v to scroll
127 when the minibuffer is selected. */
128
129 extern Lisp_Object Vminibuf_scroll_window;
130
131 extern Lisp_Object Voverriding_local_map;
132
133 Lisp_Object Quser_variable_p;
134
135 Lisp_Object Qminibuffer_default;
136
137 Lisp_Object Qcurrent_input_method, Qactivate_input_method;
138
139 extern Lisp_Object Qmouse_face;
140
141 extern Lisp_Object Qfield;
142 \f
143 /* Put minibuf on currently selected frame's minibuffer.
144 We do this whenever the user starts a new minibuffer
145 or when a minibuffer exits. */
146
147 void
148 choose_minibuf_frame ()
149 {
150 if (FRAMEP (selected_frame)
151 && FRAME_LIVE_P (XFRAME (selected_frame))
152 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
153 {
154 struct frame *sf = XFRAME (selected_frame);
155 Lisp_Object buffer;
156
157 /* I don't think that any frames may validly have a null minibuffer
158 window anymore. */
159 if (NILP (sf->minibuffer_window))
160 abort ();
161
162 /* Under X, we come here with minibuf_window being the
163 minibuffer window of the unused termcap window created in
164 init_window_once. That window doesn't have a buffer. */
165 buffer = XWINDOW (minibuf_window)->buffer;
166 if (BUFFERP (buffer))
167 Fset_window_buffer (sf->minibuffer_window, buffer);
168 minibuf_window = sf->minibuffer_window;
169 }
170
171 /* Make sure no other frame has a minibuffer as its selected window,
172 because the text would not be displayed in it, and that would be
173 confusing. Only allow the selected frame to do this,
174 and that only if the minibuffer is active. */
175 {
176 Lisp_Object tail, frame;
177
178 FOR_EACH_FRAME (tail, frame)
179 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
180 && !(EQ (frame, selected_frame)
181 && minibuf_level > 0))
182 Fset_frame_selected_window (frame, Fframe_first_window (frame));
183 }
184 }
185
186 Lisp_Object
187 choose_minibuf_frame_1 (ignore)
188 Lisp_Object ignore;
189 {
190 choose_minibuf_frame ();
191 return Qnil;
192 }
193
194 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
195 Sset_minibuffer_window, 1, 1, 0,
196 "Specify which minibuffer window to use for the minibuffer.\n\
197 This effects where the minibuffer is displayed if you put text in it\n\
198 without invoking the usual minibuffer commands.")
199 (window)
200 Lisp_Object window;
201 {
202 CHECK_WINDOW (window, 1);
203 if (! MINI_WINDOW_P (XWINDOW (window)))
204 error ("Window is not a minibuffer window");
205
206 minibuf_window = window;
207
208 return window;
209 }
210
211 \f
212 /* Actual minibuffer invocation. */
213
214 static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
215 static Lisp_Object read_minibuf 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 read_minibuf_noninteractive P_ ((Lisp_Object, Lisp_Object,
221 Lisp_Object, Lisp_Object,
222 int, Lisp_Object,
223 Lisp_Object, Lisp_Object,
224 int, int));
225 static Lisp_Object string_to_object P_ ((Lisp_Object, Lisp_Object));
226
227
228 /* Read a Lisp object from VAL and return it. If VAL is an empty
229 string, and DEFALT is a string, read from DEFALT instead of VAL. */
230
231 static Lisp_Object
232 string_to_object (val, defalt)
233 Lisp_Object val, defalt;
234 {
235 struct gcpro gcpro1, gcpro2;
236 Lisp_Object expr_and_pos;
237 int pos;
238
239 GCPRO2 (val, defalt);
240
241 if (STRINGP (val) && XSTRING (val)->size == 0
242 && STRINGP (defalt))
243 val = defalt;
244
245 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
246 pos = XINT (Fcdr (expr_and_pos));
247 if (pos != XSTRING (val)->size)
248 {
249 /* Ignore trailing whitespace; any other trailing junk
250 is an error. */
251 int i;
252 pos = string_char_to_byte (val, pos);
253 for (i = pos; i < STRING_BYTES (XSTRING (val)); i++)
254 {
255 int c = XSTRING (val)->data[i];
256 if (c != ' ' && c != '\t' && c != '\n')
257 error ("Trailing garbage following expression");
258 }
259 }
260
261 val = Fcar (expr_and_pos);
262 RETURN_UNGCPRO (val);
263 }
264
265
266 /* Like read_minibuf but reading from stdin. This function is called
267 from read_minibuf to do the job if noninteractive. */
268
269 static Lisp_Object
270 read_minibuf_noninteractive (map, initial, prompt, backup_n, expflag,
271 histvar, histpos, defalt, allow_props,
272 inherit_input_method)
273 Lisp_Object map;
274 Lisp_Object initial;
275 Lisp_Object prompt;
276 Lisp_Object backup_n;
277 int expflag;
278 Lisp_Object histvar;
279 Lisp_Object histpos;
280 Lisp_Object defalt;
281 int allow_props;
282 int inherit_input_method;
283 {
284 int size, len;
285 char *line, *s;
286 Lisp_Object val;
287
288 fprintf (stdout, "%s", XSTRING (prompt)->data);
289 fflush (stdout);
290
291 val = Qnil;
292 size = 100;
293 len = 0;
294 line = (char *) xmalloc (size * sizeof *line);
295 while ((s = fgets (line + len, size - len, stdin)) != NULL
296 && (len = strlen (line),
297 len == size - 1 && line[len - 1] != '\n'))
298 {
299 size *= 2;
300 line = (char *) xrealloc (line, size);
301 }
302
303 if (s)
304 {
305 len = strlen (line);
306
307 if (len > 0 && line[len - 1] == '\n')
308 line[--len] = '\0';
309
310 val = build_string (line);
311 xfree (line);
312 }
313 else
314 {
315 xfree (line);
316 error ("Error reading from stdin");
317 }
318
319 /* If Lisp form desired instead of string, parse it. */
320 if (expflag)
321 val = string_to_object (val, defalt);
322
323 return val;
324 }
325
326
327 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
328 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
329 prompting with PROMPT (a string), using history list HISTVAR
330 with initial position HISTPOS. (BACKUP_N should be <= 0.)
331
332 Normally return the result as a string (the text that was read),
333 but if EXPFLAG is nonzero, read it and return the object read.
334 If HISTVAR is given, save the value read on that history only if it doesn't
335 match the front of that history list exactly. The value is pushed onto
336 the list as the string that was read.
337
338 DEFALT specifies te default value for the sake of history commands.
339
340 If ALLOW_PROPS is nonzero, we do not throw away text properties.
341
342 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
343 current input method. */
344
345 static Lisp_Object
346 read_minibuf (map, initial, prompt, backup_n, expflag,
347 histvar, histpos, defalt, allow_props, inherit_input_method)
348 Lisp_Object map;
349 Lisp_Object initial;
350 Lisp_Object prompt;
351 Lisp_Object backup_n;
352 int expflag;
353 Lisp_Object histvar;
354 Lisp_Object histpos;
355 Lisp_Object defalt;
356 int allow_props;
357 int inherit_input_method;
358 {
359 Lisp_Object val;
360 int count = specpdl_ptr - specpdl;
361 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
362 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
363 Lisp_Object enable_multibyte;
364 extern Lisp_Object Qread_only, Qfront_sticky;
365 extern Lisp_Object Qrear_nonsticky;
366
367 specbind (Qminibuffer_default, defalt);
368
369 single_kboard_state ();
370 #ifdef HAVE_X_WINDOWS
371 if (display_hourglass_p)
372 cancel_hourglass ();
373 #endif
374
375 val = Qnil;
376 ambient_dir = current_buffer->directory;
377 input_method = Qnil;
378 enable_multibyte = Qnil;
379
380 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
381 store them away before we can GC. Don't need to protect
382 BACKUP_N because we use the value only if it is an integer. */
383 GCPRO5 (map, initial, val, ambient_dir, input_method);
384
385 if (!STRINGP (prompt))
386 prompt = build_string ("");
387
388 if (!enable_recursive_minibuffers
389 && minibuf_level > 0)
390 {
391 if (EQ (selected_window, minibuf_window))
392 error ("Command attempted to use minibuffer while in minibuffer");
393 else
394 /* If we're in another window, cancel the minibuffer that's active. */
395 Fthrow (Qexit,
396 build_string ("Command attempted to use minibuffer while in minibuffer"));
397 }
398
399 if (noninteractive)
400 {
401 val = read_minibuf_noninteractive (map, initial, prompt, backup_n,
402 expflag, histvar, histpos, defalt,
403 allow_props, inherit_input_method);
404 return unbind_to (count, val);
405 }
406
407 /* Choose the minibuffer window and frame, and take action on them. */
408
409 choose_minibuf_frame ();
410
411 record_unwind_protect (choose_minibuf_frame_1, Qnil);
412
413 record_unwind_protect (Fset_window_configuration,
414 Fcurrent_window_configuration (Qnil));
415
416 /* If the minibuffer window is on a different frame, save that
417 frame's configuration too. */
418 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
419 if (!EQ (mini_frame, selected_frame))
420 record_unwind_protect (Fset_window_configuration,
421 Fcurrent_window_configuration (mini_frame));
422
423 /* If the minibuffer is on an iconified or invisible frame,
424 make it visible now. */
425 Fmake_frame_visible (mini_frame);
426
427 if (minibuffer_auto_raise)
428 Fraise_frame (mini_frame);
429
430 /* We have to do this after saving the window configuration
431 since that is what restores the current buffer. */
432
433 /* Arrange to restore a number of minibuffer-related variables.
434 We could bind each variable separately, but that would use lots of
435 specpdl slots. */
436 minibuf_save_list
437 = Fcons (Voverriding_local_map,
438 Fcons (minibuf_window, minibuf_save_list));
439 minibuf_save_list
440 = Fcons (minibuf_prompt,
441 Fcons (make_number (minibuf_prompt_width),
442 Fcons (Vhelp_form,
443 Fcons (Vcurrent_prefix_arg,
444 Fcons (Vminibuffer_history_position,
445 Fcons (Vminibuffer_history_variable,
446 minibuf_save_list))))));
447
448 record_unwind_protect (read_minibuf_unwind, Qnil);
449 minibuf_level++;
450
451 /* Now that we can restore all those variables, start changing them. */
452
453 minibuf_prompt_width = 0;
454 minibuf_prompt = Fcopy_sequence (prompt);
455 Vminibuffer_history_position = histpos;
456 Vminibuffer_history_variable = histvar;
457 Vhelp_form = Vminibuffer_help_form;
458
459 if (inherit_input_method)
460 {
461 /* `current-input-method' is buffer local. So, remeber it in
462 INPUT_METHOD before changing the current buffer. */
463 input_method = Fsymbol_value (Qcurrent_input_method);
464 enable_multibyte = current_buffer->enable_multibyte_characters;
465 }
466
467 /* Switch to the minibuffer. */
468
469 minibuffer = get_minibuffer (minibuf_level);
470 Fset_buffer (minibuffer);
471
472 /* The current buffer's default directory is usually the right thing
473 for our minibuffer here. However, if you're typing a command at
474 a minibuffer-only frame when minibuf_level is zero, then buf IS
475 the current_buffer, so reset_buffer leaves buf's default
476 directory unchanged. This is a bummer when you've just started
477 up Emacs and buf's default directory is Qnil. Here's a hack; can
478 you think of something better to do? Find another buffer with a
479 better directory, and use that one instead. */
480 if (STRINGP (ambient_dir))
481 current_buffer->directory = ambient_dir;
482 else
483 {
484 Lisp_Object buf_list;
485
486 for (buf_list = Vbuffer_alist;
487 CONSP (buf_list);
488 buf_list = XCDR (buf_list))
489 {
490 Lisp_Object other_buf;
491
492 other_buf = XCDR (XCAR (buf_list));
493 if (STRINGP (XBUFFER (other_buf)->directory))
494 {
495 current_buffer->directory = XBUFFER (other_buf)->directory;
496 break;
497 }
498 }
499 }
500
501 if (!EQ (mini_frame, selected_frame))
502 Fredirect_frame_focus (selected_frame, mini_frame);
503
504 Vminibuf_scroll_window = selected_window;
505 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
506 Fselect_window (minibuf_window);
507 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
508
509 Fmake_local_variable (Qprint_escape_newlines);
510 print_escape_newlines = 1;
511
512 /* Erase the buffer. */
513 {
514 int count1 = specpdl_ptr - specpdl;
515 specbind (Qinhibit_read_only, Qt);
516 Ferase_buffer ();
517 unbind_to (count1, Qnil);
518 }
519
520 if (!NILP (current_buffer->enable_multibyte_characters)
521 && ! STRING_MULTIBYTE (minibuf_prompt))
522 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
523
524 /* Insert the prompt, record where it ends. */
525 Finsert (1, &minibuf_prompt);
526 if (PT > BEG)
527 {
528 Fput_text_property (make_number (BEG), make_number (PT),
529 Qfront_sticky, Qt, Qnil);
530 Fput_text_property (make_number (BEG), make_number (PT),
531 Qrear_nonsticky, Qt, Qnil);
532 Fput_text_property (make_number (BEG), make_number (PT),
533 Qfield, Qt, Qnil);
534 Fadd_text_properties (make_number (BEG), make_number (PT),
535 Vminibuffer_prompt_properties, Qnil);
536 }
537
538 minibuf_prompt_width = current_column ();
539
540 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
541 if (inherit_input_method)
542 current_buffer->enable_multibyte_characters = enable_multibyte;
543
544 /* Put in the initial input. */
545 if (!NILP (initial))
546 {
547 Finsert (1, &initial);
548 if (INTEGERP (backup_n))
549 Fforward_char (backup_n);
550 }
551
552 clear_message (1, 1);
553 current_buffer->keymap = map;
554
555 /* Turn on an input method stored in INPUT_METHOD if any. */
556 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
557 call1 (Qactivate_input_method, input_method);
558
559 /* Run our hook, but not if it is empty.
560 (run-hooks would do nothing if it is empty,
561 but it's important to save time here in the usual case). */
562 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
563 && !NILP (Vrun_hooks))
564 call1 (Vrun_hooks, Qminibuffer_setup_hook);
565
566 /* Don't allow the user to undo past this point. */
567 current_buffer->undo_list = Qnil;
568
569 recursive_edit_1 ();
570
571 /* If cursor is on the minibuffer line,
572 show the user we have exited by putting it in column 0. */
573 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
574 && !noninteractive)
575 {
576 XWINDOW (minibuf_window)->cursor.hpos = 0;
577 XWINDOW (minibuf_window)->cursor.x = 0;
578 XWINDOW (minibuf_window)->must_be_updated_p = 1;
579 update_frame (XFRAME (selected_frame), 1, 1);
580 if (rif && rif->flush_display)
581 rif->flush_display (XFRAME (XWINDOW (minibuf_window)->frame));
582 }
583
584 /* Make minibuffer contents into a string. */
585 Fset_buffer (minibuffer);
586 if (allow_props)
587 val = Ffield_string (make_number (ZV));
588 else
589 val = Ffield_string_no_properties (make_number (ZV));
590
591 /* VAL is the string of minibuffer text. */
592
593 last_minibuf_string = val;
594
595 /* Add the value to the appropriate history list unless it is empty. */
596 if (XSTRING (val)->size != 0
597 && SYMBOLP (Vminibuffer_history_variable))
598 {
599 /* If the caller wanted to save the value read on a history list,
600 then do so if the value is not already the front of the list. */
601 Lisp_Object histval;
602
603 /* If variable is unbound, make it nil. */
604 if (EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
605 Fset (Vminibuffer_history_variable, Qnil);
606
607 histval = Fsymbol_value (Vminibuffer_history_variable);
608
609 /* The value of the history variable must be a cons or nil. Other
610 values are unacceptable. We silently ignore these values. */
611 if (NILP (histval)
612 || (CONSP (histval)
613 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
614 {
615 Lisp_Object length;
616
617 histval = Fcons (last_minibuf_string, histval);
618 Fset (Vminibuffer_history_variable, histval);
619
620 /* Truncate if requested. */
621 length = Fget (Vminibuffer_history_variable, Qhistory_length);
622 if (NILP (length)) length = Vhistory_length;
623 if (INTEGERP (length))
624 {
625 if (XINT (length) <= 0)
626 Fset (Vminibuffer_history_variable, Qnil);
627 else
628 {
629 Lisp_Object temp;
630
631 temp = Fnthcdr (Fsub1 (length), histval);
632 if (CONSP (temp)) Fsetcdr (temp, Qnil);
633 }
634 }
635 }
636 }
637
638 /* If Lisp form desired instead of string, parse it. */
639 if (expflag)
640 val = string_to_object (val, defalt);
641
642 /* The appropriate frame will get selected
643 in set-window-configuration. */
644 RETURN_UNGCPRO (unbind_to (count, val));
645 }
646
647 /* Return a buffer to be used as the minibuffer at depth `depth'.
648 depth = 0 is the lowest allowed argument, and that is the value
649 used for nonrecursive minibuffer invocations */
650
651 Lisp_Object
652 get_minibuffer (depth)
653 int depth;
654 {
655 Lisp_Object tail, num, buf;
656 char name[24];
657 extern Lisp_Object nconc2 ();
658
659 XSETFASTINT (num, depth);
660 tail = Fnthcdr (num, Vminibuffer_list);
661 if (NILP (tail))
662 {
663 tail = Fcons (Qnil, Qnil);
664 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
665 }
666 buf = Fcar (tail);
667 if (NILP (buf) || NILP (XBUFFER (buf)->name))
668 {
669 sprintf (name, " *Minibuf-%d*", depth);
670 buf = Fget_buffer_create (build_string (name));
671
672 /* Although the buffer's name starts with a space, undo should be
673 enabled in it. */
674 Fbuffer_enable_undo (buf);
675
676 XCAR (tail) = buf;
677 }
678 else
679 {
680 int count = specpdl_ptr - specpdl;
681
682 reset_buffer (XBUFFER (buf));
683 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
684 Fset_buffer (buf);
685 Fkill_all_local_variables ();
686 unbind_to (count, Qnil);
687 }
688
689 return buf;
690 }
691
692 /* This function is called on exiting minibuffer, whether normally or
693 not, and it restores the current window, buffer, etc. */
694
695 static Lisp_Object
696 read_minibuf_unwind (data)
697 Lisp_Object data;
698 {
699 Lisp_Object old_deactivate_mark;
700 Lisp_Object window;
701
702 /* We are exiting the minibuffer one way or the other,
703 so run the hook. */
704 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
705 && !NILP (Vrun_hooks))
706 safe_run_hooks (Qminibuffer_exit_hook);
707
708 /* If this was a recursive minibuffer,
709 tie the minibuffer window back to the outer level minibuffer buffer. */
710 minibuf_level--;
711
712 window = minibuf_window;
713 /* To keep things predictable, in case it matters, let's be in the
714 minibuffer when we reset the relevant variables. */
715 Fset_buffer (XWINDOW (window)->buffer);
716
717 /* Restore prompt, etc, from outer minibuffer level. */
718 minibuf_prompt = Fcar (minibuf_save_list);
719 minibuf_save_list = Fcdr (minibuf_save_list);
720 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
721 minibuf_save_list = Fcdr (minibuf_save_list);
722 Vhelp_form = Fcar (minibuf_save_list);
723 minibuf_save_list = Fcdr (minibuf_save_list);
724 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
725 minibuf_save_list = Fcdr (minibuf_save_list);
726 Vminibuffer_history_position = Fcar (minibuf_save_list);
727 minibuf_save_list = Fcdr (minibuf_save_list);
728 Vminibuffer_history_variable = Fcar (minibuf_save_list);
729 minibuf_save_list = Fcdr (minibuf_save_list);
730 Voverriding_local_map = Fcar (minibuf_save_list);
731 minibuf_save_list = Fcdr (minibuf_save_list);
732 #if 0
733 temp = Fcar (minibuf_save_list);
734 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
735 minibuf_window = temp;
736 #endif
737 minibuf_save_list = Fcdr (minibuf_save_list);
738
739 /* Erase the minibuffer we were using at this level. */
740 {
741 int count = specpdl_ptr - specpdl;
742 /* Prevent error in erase-buffer. */
743 specbind (Qinhibit_read_only, Qt);
744 old_deactivate_mark = Vdeactivate_mark;
745 Ferase_buffer ();
746 Vdeactivate_mark = old_deactivate_mark;
747 unbind_to (count, Qnil);
748 }
749
750 /* When we get to the outmost level, make sure we resize the
751 mini-window back to its normal size. */
752 if (minibuf_level == 0)
753 resize_mini_window (XWINDOW (window), 0);
754
755 /* Make sure minibuffer window is erased, not ignored. */
756 windows_or_buffers_changed++;
757 XSETFASTINT (XWINDOW (window)->last_modified, 0);
758 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
759 return Qnil;
760 }
761 \f
762
763 /* This comment supplies the doc string for read-from-minibuffer,
764 for make-docfile to see. We cannot put this in the real DEFUN
765 due to limits in the Unix cpp.
766
767 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
768 "Read a string from the minibuffer, prompting with string PROMPT.\n\
769 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
770 to be inserted into the minibuffer before reading input.\n\
771 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
772 is STRING, but point is placed at position POSITION in the minibuffer.\n\
773 Third arg KEYMAP is a keymap to use whilst reading;\n\
774 if omitted or nil, the default is `minibuffer-local-map'.\n\
775 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
776 and return that object:\n\
777 in other words, do `(car (read-from-string INPUT-STRING))'\n\
778 Fifth arg HIST, if non-nil, specifies a history list\n\
779 and optionally the initial position in the list.\n\
780 It can be a symbol, which is the history list variable to use,\n\
781 or it can be a cons cell (HISTVAR . HISTPOS).\n\
782 In that case, HISTVAR is the history list variable to use,\n\
783 and HISTPOS is the initial position (the position in the list\n\
784 which INITIAL-CONTENTS corresponds to).\n\
785 Positions are counted starting from 1 at the beginning of the list.\n\
786 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
787 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
788 if the user enters empty input! It returns the empty string.\n\
789 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
790 the current input method and the setting of enable-multibyte-characters.\n\
791 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
792 then the string which is returned includes whatever text properties\n\
793 were present in the minibuffer. Otherwise the value has no text properties.")
794 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
795 */
796
797 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
798 0 /* See immediately above */)
799 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
800 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
801 Lisp_Object inherit_input_method;
802 {
803 int pos = 0;
804 Lisp_Object histvar, histpos, position, val;
805 struct gcpro gcpro1;
806
807 position = Qnil;
808
809 CHECK_STRING (prompt, 0);
810 if (!NILP (initial_contents))
811 {
812 if (CONSP (initial_contents))
813 {
814 position = Fcdr (initial_contents);
815 initial_contents = Fcar (initial_contents);
816 }
817 CHECK_STRING (initial_contents, 1);
818 if (!NILP (position))
819 {
820 CHECK_NUMBER (position, 0);
821 /* Convert to distance from end of input. */
822 if (XINT (position) < 1)
823 /* A number too small means the beginning of the string. */
824 pos = - XSTRING (initial_contents)->size;
825 else
826 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
827 }
828 }
829
830 if (NILP (keymap))
831 keymap = Vminibuffer_local_map;
832 else
833 keymap = get_keymap (keymap, 1, 0);
834
835 if (SYMBOLP (hist))
836 {
837 histvar = hist;
838 histpos = Qnil;
839 }
840 else
841 {
842 histvar = Fcar_safe (hist);
843 histpos = Fcdr_safe (hist);
844 }
845 if (NILP (histvar))
846 histvar = Qminibuffer_history;
847 if (NILP (histpos))
848 XSETFASTINT (histpos, 0);
849
850 GCPRO1 (default_value);
851 val = read_minibuf (keymap, initial_contents, prompt,
852 make_number (pos), !NILP (read),
853 histvar, histpos, default_value,
854 minibuffer_allow_text_properties,
855 !NILP (inherit_input_method));
856 UNGCPRO;
857 return val;
858 }
859
860 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
861 "Return a Lisp object read using the minibuffer.\n\
862 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
863 is a string to insert in the minibuffer before reading.")
864 (prompt, initial_contents)
865 Lisp_Object prompt, initial_contents;
866 {
867 CHECK_STRING (prompt, 0);
868 if (!NILP (initial_contents))
869 CHECK_STRING (initial_contents, 1);
870 return read_minibuf (Vminibuffer_local_map, initial_contents,
871 prompt, Qnil, 1, Qminibuffer_history,
872 make_number (0), Qnil, 0, 0);
873 }
874
875 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
876 "Return value of Lisp expression read using the minibuffer.\n\
877 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
878 is a string to insert in the minibuffer before reading.")
879 (prompt, initial_contents)
880 Lisp_Object prompt, initial_contents;
881 {
882 return Feval (Fread_minibuffer (prompt, initial_contents));
883 }
884
885 /* Functions that use the minibuffer to read various things. */
886
887 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
888 "Read a string from the minibuffer, prompting with string PROMPT.\n\
889 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
890 The third arg HISTORY, if non-nil, specifies a history list\n\
891 and optionally the initial position in the list.\n\
892 See `read-from-minibuffer' for details of HISTORY argument.\n\
893 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
894 for history commands, and as the value to return if the user enters\n\
895 the empty string.\n\
896 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
897 the current input method and the setting of enable-multibyte-characters.")
898 (prompt, initial_input, history, default_value, inherit_input_method)
899 Lisp_Object prompt, initial_input, history, default_value;
900 Lisp_Object inherit_input_method;
901 {
902 Lisp_Object val;
903 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
904 Qnil, history, default_value,
905 inherit_input_method);
906 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (default_value))
907 val = default_value;
908 return val;
909 }
910
911 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
912 "Read a string from the terminal, not allowing blanks.\n\
913 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
914 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
915 the current input method and the setting of enable-multibyte-characters.")
916 (prompt, initial, inherit_input_method)
917 Lisp_Object prompt, initial, inherit_input_method;
918 {
919 CHECK_STRING (prompt, 0);
920 if (! NILP (initial))
921 CHECK_STRING (initial, 1);
922
923 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
924 0, Qminibuffer_history, make_number (0), Qnil, 0,
925 !NILP (inherit_input_method));
926 }
927
928 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
929 "Read the name of a command and return as a symbol.\n\
930 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
931 (prompt, default_value)
932 Lisp_Object prompt, default_value;
933 {
934 Lisp_Object name, default_string;
935
936 if (NILP (default_value))
937 default_string = Qnil;
938 else if (SYMBOLP (default_value))
939 XSETSTRING (default_string, XSYMBOL (default_value)->name);
940 else
941 default_string = default_value;
942
943 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
944 Qnil, Qnil, default_string, Qnil);
945 if (NILP (name))
946 return name;
947 return Fintern (name, Qnil);
948 }
949
950 #ifdef NOTDEF
951 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
952 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
953 Prompts with PROMPT.")
954 (prompt)
955 Lisp_Object prompt;
956 {
957 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
958 Qnil);
959 }
960 #endif /* NOTDEF */
961
962 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
963 "Read the name of a user variable and return it as a symbol.\n\
964 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
965 A user variable is one whose documentation starts with a `*' character.")
966 (prompt, default_value)
967 Lisp_Object prompt, default_value;
968 {
969 Lisp_Object name, default_string;
970
971 if (NILP (default_value))
972 default_string = Qnil;
973 else if (SYMBOLP (default_value))
974 XSETSTRING (default_string, XSYMBOL (default_value)->name);
975 else
976 default_string = default_value;
977
978 name = Fcompleting_read (prompt, Vobarray,
979 Quser_variable_p, Qt,
980 Qnil, Qnil, default_string, Qnil);
981 if (NILP (name))
982 return name;
983 return Fintern (name, Qnil);
984 }
985
986 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
987 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
988 Prompts with PROMPT.\n\
989 Optional second arg DEF is value to return if user enters an empty line.\n\
990 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
991 (prompt, def, require_match)
992 Lisp_Object prompt, def, require_match;
993 {
994 Lisp_Object args[4];
995
996 if (BUFFERP (def))
997 def = XBUFFER (def)->name;
998
999 if (NILP (Vread_buffer_function))
1000 {
1001 if (!NILP (def))
1002 {
1003 args[0] = build_string ("%s(default %s) ");
1004 args[1] = prompt;
1005 args[2] = def;
1006 prompt = Fformat (3, args);
1007 }
1008
1009 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
1010 require_match, Qnil, Qbuffer_name_history,
1011 def, Qnil);
1012 }
1013 else
1014 {
1015 args[0] = Vread_buffer_function;
1016 args[1] = prompt;
1017 args[2] = def;
1018 args[3] = require_match;
1019 return Ffuncall(4, args);
1020 }
1021 }
1022 \f
1023 static Lisp_Object
1024 minibuf_conform_representation (string, basis)
1025 Lisp_Object string, basis;
1026 {
1027 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1028 return string;
1029
1030 if (STRING_MULTIBYTE (string))
1031 return Fstring_make_unibyte (string);
1032 else
1033 return Fstring_make_multibyte (string);
1034 }
1035
1036 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1037 "Return common substring of all completions of STRING in ALIST.\n\
1038 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1039 All that match are compared together; the longest initial sequence\n\
1040 common to all matches is returned as a string.\n\
1041 If there is no match at all, nil is returned.\n\
1042 For a unique match which is exact, t is returned.\n\
1043 \n\
1044 ALIST can be an obarray instead of an alist.\n\
1045 Then the print names of all symbols in the obarray are the possible matches.\n\
1046 \n\
1047 ALIST can also be a function to do the completion itself.\n\
1048 It receives three arguments: the values STRING, PREDICATE and nil.\n\
1049 Whatever it returns becomes the value of `try-completion'.\n\
1050 \n\
1051 If optional third argument PREDICATE is non-nil,\n\
1052 it is used to test each possible match.\n\
1053 The match is a candidate only if PREDICATE returns non-nil.\n\
1054 The argument given to PREDICATE is the alist element\n\
1055 or the symbol from the obarray.\n\
1056 Additionally to this predicate, `completion-regexp-list'\n\
1057 is used to further constrain the set of candidates.")
1058 (string, alist, predicate)
1059 Lisp_Object string, alist, predicate;
1060 {
1061 Lisp_Object bestmatch, tail, elt, eltstring;
1062 /* Size in bytes of BESTMATCH. */
1063 int bestmatchsize = 0;
1064 /* These are in bytes, too. */
1065 int compare, matchsize;
1066 int list = CONSP (alist) || NILP (alist);
1067 int index = 0, obsize = 0;
1068 int matchcount = 0;
1069 Lisp_Object bucket, zero, end, tem;
1070 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1071
1072 CHECK_STRING (string, 0);
1073 if (!list && !VECTORP (alist))
1074 return call3 (alist, string, predicate, Qnil);
1075
1076 bestmatch = bucket = Qnil;
1077
1078 /* If ALIST is not a list, set TAIL just for gc pro. */
1079 tail = alist;
1080 if (! list)
1081 {
1082 index = 0;
1083 obsize = XVECTOR (alist)->size;
1084 bucket = XVECTOR (alist)->contents[index];
1085 }
1086
1087 while (1)
1088 {
1089 /* Get the next element of the alist or obarray. */
1090 /* Exit the loop if the elements are all used up. */
1091 /* elt gets the alist element or symbol.
1092 eltstring gets the name to check as a completion. */
1093
1094 if (list)
1095 {
1096 if (NILP (tail))
1097 break;
1098 elt = Fcar (tail);
1099 eltstring = Fcar (elt);
1100 tail = Fcdr (tail);
1101 }
1102 else
1103 {
1104 if (XFASTINT (bucket) != 0)
1105 {
1106 elt = bucket;
1107 eltstring = Fsymbol_name (elt);
1108 if (XSYMBOL (bucket)->next)
1109 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1110 else
1111 XSETFASTINT (bucket, 0);
1112 }
1113 else if (++index >= obsize)
1114 break;
1115 else
1116 {
1117 bucket = XVECTOR (alist)->contents[index];
1118 continue;
1119 }
1120 }
1121
1122 /* Is this element a possible completion? */
1123
1124 if (STRINGP (eltstring)
1125 && XSTRING (string)->size <= XSTRING (eltstring)->size
1126 && (tem = Fcompare_strings (eltstring, make_number (0),
1127 make_number (XSTRING (string)->size),
1128 string, make_number (0), Qnil,
1129 completion_ignore_case ?Qt : Qnil),
1130 EQ (Qt, tem)))
1131 {
1132 /* Yes. */
1133 Lisp_Object regexps;
1134 Lisp_Object zero;
1135 XSETFASTINT (zero, 0);
1136
1137 /* Ignore this element if it fails to match all the regexps. */
1138 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1139 regexps = XCDR (regexps))
1140 {
1141 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1142 if (NILP (tem))
1143 break;
1144 }
1145 if (CONSP (regexps))
1146 continue;
1147
1148 /* Ignore this element if there is a predicate
1149 and the predicate doesn't like it. */
1150
1151 if (!NILP (predicate))
1152 {
1153 if (EQ (predicate, Qcommandp))
1154 tem = Fcommandp (elt);
1155 else
1156 {
1157 GCPRO4 (tail, string, eltstring, bestmatch);
1158 tem = call1 (predicate, elt);
1159 UNGCPRO;
1160 }
1161 if (NILP (tem)) continue;
1162 }
1163
1164 /* Update computation of how much all possible completions match */
1165
1166 matchcount++;
1167 if (NILP (bestmatch))
1168 {
1169 bestmatch = eltstring;
1170 bestmatchsize = XSTRING (eltstring)->size;
1171 }
1172 else
1173 {
1174 compare = min (bestmatchsize, XSTRING (eltstring)->size);
1175 tem = Fcompare_strings (bestmatch, make_number (0),
1176 make_number (compare),
1177 eltstring, make_number (0),
1178 make_number (compare),
1179 completion_ignore_case ? Qt : Qnil);
1180 if (EQ (tem, Qt))
1181 matchsize = compare;
1182 else if (XINT (tem) < 0)
1183 matchsize = - XINT (tem) - 1;
1184 else
1185 matchsize = XINT (tem) - 1;
1186
1187 if (matchsize < 0)
1188 matchsize = compare;
1189 if (completion_ignore_case)
1190 {
1191 /* If this is an exact match except for case,
1192 use it as the best match rather than one that is not an
1193 exact match. This way, we get the case pattern
1194 of the actual match. */
1195 if ((matchsize == XSTRING (eltstring)->size
1196 && matchsize < XSTRING (bestmatch)->size)
1197 ||
1198 /* If there is more than one exact match ignoring case,
1199 and one of them is exact including case,
1200 prefer that one. */
1201 /* If there is no exact match ignoring case,
1202 prefer a match that does not change the case
1203 of the input. */
1204 ((matchsize == XSTRING (eltstring)->size)
1205 ==
1206 (matchsize == XSTRING (bestmatch)->size)
1207 && (tem = Fcompare_strings (eltstring, make_number (0),
1208 make_number (XSTRING (string)->size),
1209 string, make_number (0),
1210 Qnil,
1211 Qnil),
1212 EQ (Qt, tem))
1213 && (tem = Fcompare_strings (bestmatch, make_number (0),
1214 make_number (XSTRING (string)->size),
1215 string, make_number (0),
1216 Qnil,
1217 Qnil),
1218 ! EQ (Qt, tem))))
1219 bestmatch = eltstring;
1220 }
1221 bestmatchsize = matchsize;
1222 }
1223 }
1224 }
1225
1226 if (NILP (bestmatch))
1227 return Qnil; /* No completions found */
1228 /* If we are ignoring case, and there is no exact match,
1229 and no additional text was supplied,
1230 don't change the case of what the user typed. */
1231 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
1232 && XSTRING (bestmatch)->size > bestmatchsize)
1233 return minibuf_conform_representation (string, bestmatch);
1234
1235 /* Return t if the supplied string is an exact match (counting case);
1236 it does not require any change to be made. */
1237 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
1238 && (tem = Fcompare_strings (bestmatch, make_number (0),
1239 make_number (bestmatchsize),
1240 string, make_number (0),
1241 make_number (bestmatchsize),
1242 Qnil),
1243 EQ (Qt, tem)))
1244 return Qt;
1245
1246 XSETFASTINT (zero, 0); /* Else extract the part in which */
1247 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1248 return Fsubstring (bestmatch, zero, end);
1249 }
1250
1251 /* Compare exactly LEN chars of strings at S1 and S2,
1252 ignoring case if appropriate.
1253 Return -1 if strings match,
1254 else number of chars that match at the beginning. */
1255
1256 int
1257 scmp (s1, s2, len)
1258 register unsigned char *s1, *s2;
1259 int len;
1260 {
1261 register int l = len;
1262
1263 if (completion_ignore_case)
1264 {
1265 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
1266 l--;
1267 }
1268 else
1269 {
1270 while (l && *s1++ == *s2++)
1271 l--;
1272 }
1273 if (l == 0)
1274 return -1;
1275 else
1276 {
1277 int match = len - l;
1278
1279 /* Now *--S1 is the unmatching byte. If it is in the middle of
1280 multi-byte form, we must say that the multi-byte character
1281 there doesn't match. */
1282 while (match && *--s1 >= 0xA0) match--;
1283 return match;
1284 }
1285 }
1286 \f
1287 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1288 "Search for partial matches to STRING in ALIST.\n\
1289 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1290 The value is a list of all the strings from ALIST that match.\n\
1291 \n\
1292 ALIST can be an obarray instead of an alist.\n\
1293 Then the print names of all symbols in the obarray are the possible matches.\n\
1294 \n\
1295 ALIST can also be a function to do the completion itself.\n\
1296 It receives three arguments: the values STRING, PREDICATE and t.\n\
1297 Whatever it returns becomes the value of `all-completions'.\n\
1298 \n\
1299 If optional third argument PREDICATE is non-nil,\n\
1300 it is used to test each possible match.\n\
1301 The match is a candidate only if PREDICATE returns non-nil.\n\
1302 The argument given to PREDICATE is the alist element\n\
1303 or the symbol from the obarray.\n\
1304 Additionally to this predicate, `completion-regexp-list'\n\
1305 is used to further constrain the set of candidates.\n\
1306 \n\
1307 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1308 strings in ALIST that start with a space\n\
1309 are ignored unless STRING itself starts with a space.")
1310 (string, alist, predicate, hide_spaces)
1311 Lisp_Object string, alist, predicate, hide_spaces;
1312 {
1313 Lisp_Object tail, elt, eltstring;
1314 Lisp_Object allmatches;
1315 int list = CONSP (alist) || NILP (alist);
1316 int index = 0, obsize = 0;
1317 Lisp_Object bucket, tem;
1318 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1319
1320 CHECK_STRING (string, 0);
1321 if (!list && !VECTORP (alist))
1322 {
1323 return call3 (alist, string, predicate, Qt);
1324 }
1325 allmatches = bucket = Qnil;
1326
1327 /* If ALIST is not a list, set TAIL just for gc pro. */
1328 tail = alist;
1329 if (! list)
1330 {
1331 index = 0;
1332 obsize = XVECTOR (alist)->size;
1333 bucket = XVECTOR (alist)->contents[index];
1334 }
1335
1336 while (1)
1337 {
1338 /* Get the next element of the alist or obarray. */
1339 /* Exit the loop if the elements are all used up. */
1340 /* elt gets the alist element or symbol.
1341 eltstring gets the name to check as a completion. */
1342
1343 if (list)
1344 {
1345 if (NILP (tail))
1346 break;
1347 elt = Fcar (tail);
1348 eltstring = Fcar (elt);
1349 tail = Fcdr (tail);
1350 }
1351 else
1352 {
1353 if (XFASTINT (bucket) != 0)
1354 {
1355 elt = bucket;
1356 eltstring = Fsymbol_name (elt);
1357 if (XSYMBOL (bucket)->next)
1358 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1359 else
1360 XSETFASTINT (bucket, 0);
1361 }
1362 else if (++index >= obsize)
1363 break;
1364 else
1365 {
1366 bucket = XVECTOR (alist)->contents[index];
1367 continue;
1368 }
1369 }
1370
1371 /* Is this element a possible completion? */
1372
1373 if (STRINGP (eltstring)
1374 && XSTRING (string)->size <= XSTRING (eltstring)->size
1375 /* If HIDE_SPACES, reject alternatives that start with space
1376 unless the input starts with space. */
1377 && ((STRING_BYTES (XSTRING (string)) > 0
1378 && XSTRING (string)->data[0] == ' ')
1379 || XSTRING (eltstring)->data[0] != ' '
1380 || NILP (hide_spaces))
1381 && (tem = Fcompare_strings (eltstring, make_number (0),
1382 make_number (XSTRING (string)->size),
1383 string, make_number (0),
1384 make_number (XSTRING (string)->size),
1385 completion_ignore_case ? Qt : Qnil),
1386 EQ (Qt, tem)))
1387 {
1388 /* Yes. */
1389 Lisp_Object regexps;
1390 Lisp_Object zero;
1391 XSETFASTINT (zero, 0);
1392
1393 /* Ignore this element if it fails to match all the regexps. */
1394 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1395 regexps = XCDR (regexps))
1396 {
1397 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1398 if (NILP (tem))
1399 break;
1400 }
1401 if (CONSP (regexps))
1402 continue;
1403
1404 /* Ignore this element if there is a predicate
1405 and the predicate doesn't like it. */
1406
1407 if (!NILP (predicate))
1408 {
1409 if (EQ (predicate, Qcommandp))
1410 tem = Fcommandp (elt);
1411 else
1412 {
1413 GCPRO4 (tail, eltstring, allmatches, string);
1414 tem = call1 (predicate, elt);
1415 UNGCPRO;
1416 }
1417 if (NILP (tem)) continue;
1418 }
1419 /* Ok => put it on the list. */
1420 allmatches = Fcons (eltstring, allmatches);
1421 }
1422 }
1423
1424 return Fnreverse (allmatches);
1425 }
1426 \f
1427 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1428 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1429 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1430 Lisp_Object Vminibuffer_completing_file_name;
1431
1432 /* This comment supplies the doc string for completing-read,
1433 for make-docfile to see. We cannot put this in the real DEFUN
1434 due to limits in the Unix cpp.
1435
1436 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1437 "Read a string in the minibuffer, with completion.\n\
1438 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1439 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1440 TABLE can also be a function to do the completion itself.\n\
1441 PREDICATE limits completion to a subset of TABLE.\n\
1442 See `try-completion' and `all-completions' for more details\n\
1443 on completion, TABLE, and PREDICATE.\n\
1444 \n\
1445 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1446 the input is (or completes to) an element of TABLE or is null.\n\
1447 If it is also not t, Return does not exit if it does non-null completion.\n\
1448 If the input is null, `completing-read' returns an empty string,\n\
1449 regardless of the value of REQUIRE-MATCH.\n\
1450 \n\
1451 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1452 If it is (STRING . POSITION), the initial input\n\
1453 is STRING, but point is placed POSITION characters into the string.\n\
1454 This feature is deprecated--it is best to pass nil for INITIAL.\n\
1455 HIST, if non-nil, specifies a history list\n\
1456 and optionally the initial position in the list.\n\
1457 It can be a symbol, which is the history list variable to use,\n\
1458 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1459 In that case, HISTVAR is the history list variable to use,\n\
1460 and HISTPOS is the initial position (the position in the list\n\
1461 which INITIAL-INPUT corresponds to).\n\
1462 Positions are counted starting from 1 at the beginning of the list.\n\
1463 DEF, if non-nil, is the default value.\n\
1464 \n\
1465 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1466 the current input method and the setting of enable-multibyte-characters.\n\
1467 \n\
1468 Completion ignores case if the ambient value of\n\
1469 `completion-ignore-case' is non-nil."
1470 */
1471 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1472 0 /* See immediately above */)
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, 0);
1501 if (!NILP (position))
1502 {
1503 CHECK_NUMBER (position, 0);
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 (Ffield_string (make_number (ZV)),
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 = Ffield_string (make_number (ZV));
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_field (make_number (ZV)); /* 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 (Ffield_string (make_number (ZV)));
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 = Ffield_string (make_number (ZV));
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 "Complete the minibuffer contents as far as possible.\n\
1709 Return nil if there is no valid completion, else t.\n\
1710 If no characters can be completed, display a list of possible completions.\n\
1711 If you repeat this command after it displayed such a list,\n\
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 "If the minibuffer contents is a valid completion then exit.\n\
1789 Otherwise try to complete it. If completion leads to a valid completion,\n\
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 (Ffield_beginning (make_number (ZV), Qnil)) == ZV)
1798 goto exit;
1799
1800 if (!NILP (test_completion (Ffield_string (make_number (ZV)))))
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 "Complete the minibuffer contents at most a single word.\n\
1834 After one word is completed as much as possible, a space or hyphen\n\
1835 is added, provided that matches some possible completion.\n\
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 (Ffield_string (make_number (ZV)),
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 = Ffield_string (make_number (ZV));
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, 0);
1880 tem = Ffield_string (make_number (ZV));
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_field (make_number (ZV));
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 (Ffield_beginning (make_number (ZV), Qnil));
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 (Ffield_string (make_number (ZV)), 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 (Ffield_string (make_number (ZV)), 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_field (make_number (ZV));
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 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
2007 Each element may be just a symbol or string\n\
2008 or may be a list of two strings to be printed as if concatenated.\n\
2009 `standard-output' must be a buffer.\n\
2010 The actual completion alternatives, as inserted, are given `mouse-face'\n\
2011 properties of `highlight'.\n\
2012 At the end, this runs the normal hook `completion-setup-hook'.\n\
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, 0);
2054 length = XSTRING (tem)->size;
2055
2056 tem = Fcar (XCDR (elt));
2057 CHECK_STRING (tem, 0);
2058 length += XSTRING (tem)->size;
2059 }
2060 else
2061 {
2062 CHECK_STRING (elt, 0);
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 "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 (Ffield_string (make_number (ZV)),
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 "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 "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 "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 "Return the prompt string of the currently-active minibuffer.\n\
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 "Temporarily display STRING at the end of the minibuffer.\n\
2286 The text is displayed for two seconds,\n\
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 "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 "Normal hook run just after entry to minibuffer.");
2365 Vminibuffer_setup_hook = Qnil;
2366
2367 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2368 "Normal hook run just after exit from minibuffer.");
2369 Vminibuffer_exit_hook = Qnil;
2370
2371 DEFVAR_LISP ("history-length", &Vhistory_length,
2372 "*Maximum length for history lists before truncation takes place.\n\
2373 A number means that length; t means infinite. Truncation takes place\n\
2374 just after a new element is inserted. Setting the history-length\n\
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 "*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 "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 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
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 "Alist or obarray used for completion in the minibuffer.\n\
2393 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2394 \n\
2395 The value may alternatively be a function, which is given three arguments:\n\
2396 STRING, the current buffer contents;\n\
2397 PREDICATE, the predicate for filtering possible matches;\n\
2398 CODE, which says what kind of things to do.\n\
2399 CODE can be nil, t or `lambda'.\n\
2400 nil means to return the best completion of STRING, or nil if there is none.\n\
2401 t means to return a list of all possible completions of STRING.\n\
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 "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 "Non-nil => 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 "Non-nil means completing file names.");
2416 Vminibuffer_completing_file_name = Qnil;
2417
2418 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2419 "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 "History list symbol to add minibuffer values to.\n\
2424 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2425 is added with\n\
2426 (set minibuffer-history-variable\n\
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 "Current position of redoing in the history list.");
2432 Vminibuffer_history_position = Qnil;
2433
2434 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2435 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
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 "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 "Non-nil means `read-from-minibuffer' should not discard text properties.\n\
2446 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2447 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
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 "Text properties that are added to minibuffer prompts.\n\
2453 These are in addition to the basic `field' property, and stickiness\n\
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 (&Stry_completion);
2473 defsubr (&Sall_completions);
2474 defsubr (&Scompleting_read);
2475 defsubr (&Sminibuffer_complete);
2476 defsubr (&Sminibuffer_complete_word);
2477 defsubr (&Sminibuffer_complete_and_exit);
2478 defsubr (&Sdisplay_completion_list);
2479 defsubr (&Sminibuffer_completion_help);
2480
2481 defsubr (&Sself_insert_and_exit);
2482 defsubr (&Sexit_minibuffer);
2483
2484 defsubr (&Sminibuffer_message);
2485 }
2486
2487 void
2488 keys_of_minibuf ()
2489 {
2490 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2491 "abort-recursive-edit");
2492 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2493 "exit-minibuffer");
2494 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2495 "exit-minibuffer");
2496
2497 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
2498 "abort-recursive-edit");
2499 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
2500 "exit-minibuffer");
2501 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
2502 "exit-minibuffer");
2503
2504 initial_define_key (Vminibuffer_local_ns_map, ' ',
2505 "exit-minibuffer");
2506 initial_define_key (Vminibuffer_local_ns_map, '\t',
2507 "exit-minibuffer");
2508 initial_define_key (Vminibuffer_local_ns_map, '?',
2509 "self-insert-and-exit");
2510
2511 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
2512 "abort-recursive-edit");
2513 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
2514 "exit-minibuffer");
2515 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
2516 "exit-minibuffer");
2517
2518 initial_define_key (Vminibuffer_local_completion_map, '\t',
2519 "minibuffer-complete");
2520 initial_define_key (Vminibuffer_local_completion_map, ' ',
2521 "minibuffer-complete-word");
2522 initial_define_key (Vminibuffer_local_completion_map, '?',
2523 "minibuffer-completion-help");
2524
2525 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
2526 "abort-recursive-edit");
2527 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2528 "minibuffer-complete-and-exit");
2529 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2530 "minibuffer-complete-and-exit");
2531 initial_define_key (Vminibuffer_local_must_match_map, '\t',
2532 "minibuffer-complete");
2533 initial_define_key (Vminibuffer_local_must_match_map, ' ',
2534 "minibuffer-complete-word");
2535 initial_define_key (Vminibuffer_local_must_match_map, '?',
2536 "minibuffer-completion-help");
2537 }