(Fread_from_minibuffer, Fread_command, Fread_function)
[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 /* 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 doc: /* Specify which minibuffer window to use for the minibuffer.
197 This effects where the minibuffer is displayed if you put text in it
198 without invoking the usual minibuffer commands. */)
199 (window)
200 Lisp_Object window;
201 {
202 CHECK_WINDOW (window);
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 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
328 Sminibuffer_prompt_end, 0, 0, 0,
329 doc: /* Return the buffer position of the end of the minibuffer prompt.
330 Return (point-min) if current buffer is not a mini-buffer. */)
331 ()
332 {
333 /* This function is written to be most efficient when there's a prompt. */
334 Lisp_Object beg = make_number (BEGV);
335 Lisp_Object end = Ffield_end (beg, Qnil, Qnil);
336
337 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
338 return beg;
339 else
340 return end;
341 }
342
343 DEFUN ("minibuffer-contents", Fminibuffer_contents,
344 Sminibuffer_contents, 0, 0, 0,
345 doc: /* Return the user input in a minibuffer as a string.
346 The current buffer must be a minibuffer. */)
347 ()
348 {
349 int prompt_end = XINT (Fminibuffer_prompt_end ());
350 return make_buffer_string (prompt_end, ZV, 1);
351 }
352
353 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
354 Sminibuffer_contents_no_properties, 0, 0, 0,
355 doc: /* Return the user input in a minibuffer as a string, without text-properties.
356 The current buffer must be a minibuffer. */)
357 ()
358 {
359 int prompt_end = XINT (Fminibuffer_prompt_end ());
360 return make_buffer_string (prompt_end, ZV, 0);
361 }
362
363 DEFUN ("delete-minibuffer-contents", Fdelete_minibuffer_contents,
364 Sdelete_minibuffer_contents, 0, 0, 0,
365 doc: /* Delete all user input in a minibuffer.
366 The current buffer must be a minibuffer. */)
367 ()
368 {
369 int prompt_end = XINT (Fminibuffer_prompt_end ());
370 if (prompt_end < ZV)
371 del_range (prompt_end, ZV);
372 return Qnil;
373 }
374
375
376 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
377 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
378 prompting with PROMPT (a string), using history list HISTVAR
379 with initial position HISTPOS. (BACKUP_N should be <= 0.)
380
381 Normally return the result as a string (the text that was read),
382 but if EXPFLAG is nonzero, read it and return the object read.
383 If HISTVAR is given, save the value read on that history only if it doesn't
384 match the front of that history list exactly. The value is pushed onto
385 the list as the string that was read.
386
387 DEFALT specifies te default value for the sake of history commands.
388
389 If ALLOW_PROPS is nonzero, we do not throw away text properties.
390
391 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
392 current input method. */
393
394 static Lisp_Object
395 read_minibuf (map, initial, prompt, backup_n, expflag,
396 histvar, histpos, defalt, allow_props, inherit_input_method)
397 Lisp_Object map;
398 Lisp_Object initial;
399 Lisp_Object prompt;
400 Lisp_Object backup_n;
401 int expflag;
402 Lisp_Object histvar;
403 Lisp_Object histpos;
404 Lisp_Object defalt;
405 int allow_props;
406 int inherit_input_method;
407 {
408 Lisp_Object val;
409 int count = specpdl_ptr - specpdl;
410 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
411 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
412 Lisp_Object enable_multibyte;
413 extern Lisp_Object Qfront_sticky;
414 extern Lisp_Object Qrear_nonsticky;
415
416 specbind (Qminibuffer_default, defalt);
417
418 single_kboard_state ();
419 #ifdef HAVE_X_WINDOWS
420 if (display_hourglass_p)
421 cancel_hourglass ();
422 #endif
423
424 val = Qnil;
425 ambient_dir = current_buffer->directory;
426 input_method = Qnil;
427 enable_multibyte = Qnil;
428
429 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
430 store them away before we can GC. Don't need to protect
431 BACKUP_N because we use the value only if it is an integer. */
432 GCPRO5 (map, initial, val, ambient_dir, input_method);
433
434 if (!STRINGP (prompt))
435 prompt = build_string ("");
436
437 if (!enable_recursive_minibuffers
438 && minibuf_level > 0)
439 {
440 if (EQ (selected_window, minibuf_window))
441 error ("Command attempted to use minibuffer while in minibuffer");
442 else
443 /* If we're in another window, cancel the minibuffer that's active. */
444 Fthrow (Qexit,
445 build_string ("Command attempted to use minibuffer while in minibuffer"));
446 }
447
448 if (noninteractive)
449 {
450 val = read_minibuf_noninteractive (map, initial, prompt, backup_n,
451 expflag, histvar, histpos, defalt,
452 allow_props, inherit_input_method);
453 return unbind_to (count, val);
454 }
455
456 /* Choose the minibuffer window and frame, and take action on them. */
457
458 choose_minibuf_frame ();
459
460 record_unwind_protect (choose_minibuf_frame_1, Qnil);
461
462 record_unwind_protect (Fset_window_configuration,
463 Fcurrent_window_configuration (Qnil));
464
465 /* If the minibuffer window is on a different frame, save that
466 frame's configuration too. */
467 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
468 if (!EQ (mini_frame, selected_frame))
469 record_unwind_protect (Fset_window_configuration,
470 Fcurrent_window_configuration (mini_frame));
471
472 /* If the minibuffer is on an iconified or invisible frame,
473 make it visible now. */
474 Fmake_frame_visible (mini_frame);
475
476 if (minibuffer_auto_raise)
477 Fraise_frame (mini_frame);
478
479 /* We have to do this after saving the window configuration
480 since that is what restores the current buffer. */
481
482 /* Arrange to restore a number of minibuffer-related variables.
483 We could bind each variable separately, but that would use lots of
484 specpdl slots. */
485 minibuf_save_list
486 = Fcons (Voverriding_local_map,
487 Fcons (minibuf_window, minibuf_save_list));
488 minibuf_save_list
489 = Fcons (minibuf_prompt,
490 Fcons (make_number (minibuf_prompt_width),
491 Fcons (Vhelp_form,
492 Fcons (Vcurrent_prefix_arg,
493 Fcons (Vminibuffer_history_position,
494 Fcons (Vminibuffer_history_variable,
495 minibuf_save_list))))));
496
497 record_unwind_protect (read_minibuf_unwind, Qnil);
498 minibuf_level++;
499
500 /* Now that we can restore all those variables, start changing them. */
501
502 minibuf_prompt_width = 0;
503 minibuf_prompt = Fcopy_sequence (prompt);
504 Vminibuffer_history_position = histpos;
505 Vminibuffer_history_variable = histvar;
506 Vhelp_form = Vminibuffer_help_form;
507
508 if (inherit_input_method)
509 {
510 /* `current-input-method' is buffer local. So, remember it in
511 INPUT_METHOD before changing the current buffer. */
512 input_method = Fsymbol_value (Qcurrent_input_method);
513 enable_multibyte = current_buffer->enable_multibyte_characters;
514 }
515
516 /* Switch to the minibuffer. */
517
518 minibuffer = get_minibuffer (minibuf_level);
519 Fset_buffer (minibuffer);
520
521 /* The current buffer's default directory is usually the right thing
522 for our minibuffer here. However, if you're typing a command at
523 a minibuffer-only frame when minibuf_level is zero, then buf IS
524 the current_buffer, so reset_buffer leaves buf's default
525 directory unchanged. This is a bummer when you've just started
526 up Emacs and buf's default directory is Qnil. Here's a hack; can
527 you think of something better to do? Find another buffer with a
528 better directory, and use that one instead. */
529 if (STRINGP (ambient_dir))
530 current_buffer->directory = ambient_dir;
531 else
532 {
533 Lisp_Object buf_list;
534
535 for (buf_list = Vbuffer_alist;
536 CONSP (buf_list);
537 buf_list = XCDR (buf_list))
538 {
539 Lisp_Object other_buf;
540
541 other_buf = XCDR (XCAR (buf_list));
542 if (STRINGP (XBUFFER (other_buf)->directory))
543 {
544 current_buffer->directory = XBUFFER (other_buf)->directory;
545 break;
546 }
547 }
548 }
549
550 if (!EQ (mini_frame, selected_frame))
551 Fredirect_frame_focus (selected_frame, mini_frame);
552
553 Vminibuf_scroll_window = selected_window;
554 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
555 Fselect_window (minibuf_window);
556 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
557
558 Fmake_local_variable (Qprint_escape_newlines);
559 print_escape_newlines = 1;
560
561 /* Erase the buffer. */
562 {
563 int count1 = BINDING_STACK_SIZE ();
564 specbind (Qinhibit_read_only, Qt);
565 specbind (Qinhibit_modification_hooks, Qt);
566 Ferase_buffer ();
567 unbind_to (count1, Qnil);
568 }
569
570 if (!NILP (current_buffer->enable_multibyte_characters)
571 && ! STRING_MULTIBYTE (minibuf_prompt))
572 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
573
574 /* Insert the prompt, record where it ends. */
575 Finsert (1, &minibuf_prompt);
576 if (PT > BEG)
577 {
578 Fput_text_property (make_number (BEG), make_number (PT),
579 Qfront_sticky, Qt, Qnil);
580 Fput_text_property (make_number (BEG), make_number (PT),
581 Qrear_nonsticky, Qt, Qnil);
582 Fput_text_property (make_number (BEG), make_number (PT),
583 Qfield, Qt, Qnil);
584 Fadd_text_properties (make_number (BEG), make_number (PT),
585 Vminibuffer_prompt_properties, Qnil);
586 }
587
588 minibuf_prompt_width = current_column ();
589
590 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
591 if (inherit_input_method)
592 current_buffer->enable_multibyte_characters = enable_multibyte;
593
594 /* Put in the initial input. */
595 if (!NILP (initial))
596 {
597 Finsert (1, &initial);
598 if (INTEGERP (backup_n))
599 Fforward_char (backup_n);
600 }
601
602 clear_message (1, 1);
603 current_buffer->keymap = map;
604
605 /* Turn on an input method stored in INPUT_METHOD if any. */
606 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
607 call1 (Qactivate_input_method, input_method);
608
609 /* Run our hook, but not if it is empty.
610 (run-hooks would do nothing if it is empty,
611 but it's important to save time here in the usual case.) */
612 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
613 && !NILP (Vrun_hooks))
614 call1 (Vrun_hooks, Qminibuffer_setup_hook);
615
616 /* Don't allow the user to undo past this point. */
617 current_buffer->undo_list = Qnil;
618
619 recursive_edit_1 ();
620
621 /* If cursor is on the minibuffer line,
622 show the user we have exited by putting it in column 0. */
623 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
624 && !noninteractive)
625 {
626 XWINDOW (minibuf_window)->cursor.hpos = 0;
627 XWINDOW (minibuf_window)->cursor.x = 0;
628 XWINDOW (minibuf_window)->must_be_updated_p = 1;
629 update_frame (XFRAME (selected_frame), 1, 1);
630 if (rif && rif->flush_display)
631 rif->flush_display (XFRAME (XWINDOW (minibuf_window)->frame));
632 }
633
634 /* Make minibuffer contents into a string. */
635 Fset_buffer (minibuffer);
636 if (allow_props)
637 val = Fminibuffer_contents ();
638 else
639 val = Fminibuffer_contents_no_properties ();
640
641 /* VAL is the string of minibuffer text. */
642
643 last_minibuf_string = val;
644
645 /* Add the value to the appropriate history list unless it is empty. */
646 if (XSTRING (val)->size != 0
647 && SYMBOLP (Vminibuffer_history_variable))
648 {
649 /* If the caller wanted to save the value read on a history list,
650 then do so if the value is not already the front of the list. */
651 Lisp_Object histval;
652
653 /* If variable is unbound, make it nil. */
654 if (EQ (SYMBOL_VALUE (Vminibuffer_history_variable), Qunbound))
655 Fset (Vminibuffer_history_variable, Qnil);
656
657 histval = Fsymbol_value (Vminibuffer_history_variable);
658
659 /* The value of the history variable must be a cons or nil. Other
660 values are unacceptable. We silently ignore these values. */
661 if (NILP (histval)
662 || (CONSP (histval)
663 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
664 {
665 Lisp_Object length;
666
667 histval = Fcons (last_minibuf_string, histval);
668 Fset (Vminibuffer_history_variable, histval);
669
670 /* Truncate if requested. */
671 length = Fget (Vminibuffer_history_variable, Qhistory_length);
672 if (NILP (length)) length = Vhistory_length;
673 if (INTEGERP (length))
674 {
675 if (XINT (length) <= 0)
676 Fset (Vminibuffer_history_variable, Qnil);
677 else
678 {
679 Lisp_Object temp;
680
681 temp = Fnthcdr (Fsub1 (length), histval);
682 if (CONSP (temp)) Fsetcdr (temp, Qnil);
683 }
684 }
685 }
686 }
687
688 /* If Lisp form desired instead of string, parse it. */
689 if (expflag)
690 val = string_to_object (val, defalt);
691
692 /* The appropriate frame will get selected
693 in set-window-configuration. */
694 RETURN_UNGCPRO (unbind_to (count, val));
695 }
696
697 /* Return a buffer to be used as the minibuffer at depth `depth'.
698 depth = 0 is the lowest allowed argument, and that is the value
699 used for nonrecursive minibuffer invocations */
700
701 Lisp_Object
702 get_minibuffer (depth)
703 int depth;
704 {
705 Lisp_Object tail, num, buf;
706 char name[24];
707 extern Lisp_Object nconc2 ();
708
709 XSETFASTINT (num, depth);
710 tail = Fnthcdr (num, Vminibuffer_list);
711 if (NILP (tail))
712 {
713 tail = Fcons (Qnil, Qnil);
714 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
715 }
716 buf = Fcar (tail);
717 if (NILP (buf) || NILP (XBUFFER (buf)->name))
718 {
719 sprintf (name, " *Minibuf-%d*", depth);
720 buf = Fget_buffer_create (build_string (name));
721
722 /* Although the buffer's name starts with a space, undo should be
723 enabled in it. */
724 Fbuffer_enable_undo (buf);
725
726 XSETCAR (tail, buf);
727 }
728 else
729 {
730 int count = specpdl_ptr - specpdl;
731
732 reset_buffer (XBUFFER (buf));
733 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
734 Fset_buffer (buf);
735 Fkill_all_local_variables ();
736 unbind_to (count, Qnil);
737 }
738
739 return buf;
740 }
741
742 /* This function is called on exiting minibuffer, whether normally or
743 not, and it restores the current window, buffer, etc. */
744
745 static Lisp_Object
746 read_minibuf_unwind (data)
747 Lisp_Object data;
748 {
749 Lisp_Object old_deactivate_mark;
750 Lisp_Object window;
751
752 /* We are exiting the minibuffer one way or the other,
753 so run the hook. */
754 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
755 && !NILP (Vrun_hooks))
756 safe_run_hooks (Qminibuffer_exit_hook);
757
758 /* If this was a recursive minibuffer,
759 tie the minibuffer window back to the outer level minibuffer buffer. */
760 minibuf_level--;
761
762 window = minibuf_window;
763 /* To keep things predictable, in case it matters, let's be in the
764 minibuffer when we reset the relevant variables. */
765 Fset_buffer (XWINDOW (window)->buffer);
766
767 /* Restore prompt, etc, from outer minibuffer level. */
768 minibuf_prompt = Fcar (minibuf_save_list);
769 minibuf_save_list = Fcdr (minibuf_save_list);
770 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
771 minibuf_save_list = Fcdr (minibuf_save_list);
772 Vhelp_form = Fcar (minibuf_save_list);
773 minibuf_save_list = Fcdr (minibuf_save_list);
774 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
775 minibuf_save_list = Fcdr (minibuf_save_list);
776 Vminibuffer_history_position = Fcar (minibuf_save_list);
777 minibuf_save_list = Fcdr (minibuf_save_list);
778 Vminibuffer_history_variable = Fcar (minibuf_save_list);
779 minibuf_save_list = Fcdr (minibuf_save_list);
780 Voverriding_local_map = Fcar (minibuf_save_list);
781 minibuf_save_list = Fcdr (minibuf_save_list);
782 #if 0
783 temp = Fcar (minibuf_save_list);
784 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
785 minibuf_window = temp;
786 #endif
787 minibuf_save_list = Fcdr (minibuf_save_list);
788
789 /* Erase the minibuffer we were using at this level. */
790 {
791 int count = specpdl_ptr - specpdl;
792 /* Prevent error in erase-buffer. */
793 specbind (Qinhibit_read_only, Qt);
794 specbind (Qinhibit_modification_hooks, Qt);
795 old_deactivate_mark = Vdeactivate_mark;
796 Ferase_buffer ();
797 Vdeactivate_mark = old_deactivate_mark;
798 unbind_to (count, Qnil);
799 }
800
801 /* When we get to the outmost level, make sure we resize the
802 mini-window back to its normal size. */
803 if (minibuf_level == 0)
804 resize_mini_window (XWINDOW (window), 0);
805
806 /* Make sure minibuffer window is erased, not ignored. */
807 windows_or_buffers_changed++;
808 XSETFASTINT (XWINDOW (window)->last_modified, 0);
809 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
810 return Qnil;
811 }
812 \f
813
814 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
815 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
816 If optional second arg INITIAL-CONTENTS is non-nil, it is a string
817 to be inserted into the minibuffer before reading input.
818 If INITIAL-CONTENTS is (STRING . POSITION), the initial input
819 is STRING, but point is placed at position POSITION in the minibuffer.
820 Third arg KEYMAP is a keymap to use whilst reading;
821 if omitted or nil, the default is `minibuffer-local-map'.
822 If fourth arg READ is non-nil, then interpret the result as a Lisp object
823 and return that object:
824 in other words, do `(car (read-from-string INPUT-STRING))'
825 Fifth arg HIST, if non-nil, specifies a history list
826 and optionally the initial position in the list.
827 It can be a symbol, which is the history list variable to use,
828 or it can be a cons cell (HISTVAR . HISTPOS).
829 In that case, HISTVAR is the history list variable to use,
830 and HISTPOS is the initial position (the position in the list
831 which INITIAL-CONTENTS corresponds to).
832 Positions are counted starting from 1 at the beginning of the list.
833 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available
834 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE
835 if the user enters empty input! It returns the empty string.
836 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
837 the current input method and the setting of `enable-multibyte-characters'.
838 If the variable `minibuffer-allow-text-properties' is non-nil,
839 then the string which is returned includes whatever text properties
840 were present in the minibuffer. Otherwise the value has no text properties. */)
841 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
842 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
843 Lisp_Object inherit_input_method;
844 {
845 int pos = 0;
846 Lisp_Object histvar, histpos, position, val;
847 struct gcpro gcpro1;
848
849 position = Qnil;
850
851 CHECK_STRING (prompt);
852 if (!NILP (initial_contents))
853 {
854 if (CONSP (initial_contents))
855 {
856 position = Fcdr (initial_contents);
857 initial_contents = Fcar (initial_contents);
858 }
859 CHECK_STRING (initial_contents);
860 if (!NILP (position))
861 {
862 CHECK_NUMBER (position);
863 /* Convert to distance from end of input. */
864 if (XINT (position) < 1)
865 /* A number too small means the beginning of the string. */
866 pos = - XSTRING (initial_contents)->size;
867 else
868 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
869 }
870 }
871
872 if (NILP (keymap))
873 keymap = Vminibuffer_local_map;
874 else
875 keymap = get_keymap (keymap, 1, 0);
876
877 if (SYMBOLP (hist))
878 {
879 histvar = hist;
880 histpos = Qnil;
881 }
882 else
883 {
884 histvar = Fcar_safe (hist);
885 histpos = Fcdr_safe (hist);
886 }
887 if (NILP (histvar))
888 histvar = Qminibuffer_history;
889 if (NILP (histpos))
890 XSETFASTINT (histpos, 0);
891
892 GCPRO1 (default_value);
893 val = read_minibuf (keymap, initial_contents, prompt,
894 make_number (pos), !NILP (read),
895 histvar, histpos, default_value,
896 minibuffer_allow_text_properties,
897 !NILP (inherit_input_method));
898 UNGCPRO;
899 return val;
900 }
901
902 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
903 doc: /* Return a Lisp object read using the minibuffer.
904 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
905 is a string to insert in the minibuffer before reading. */)
906 (prompt, initial_contents)
907 Lisp_Object prompt, initial_contents;
908 {
909 CHECK_STRING (prompt);
910 if (!NILP (initial_contents))
911 CHECK_STRING (initial_contents);
912 return read_minibuf (Vminibuffer_local_map, initial_contents,
913 prompt, Qnil, 1, Qminibuffer_history,
914 make_number (0), Qnil, 0, 0);
915 }
916
917 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
918 doc: /* Return value of Lisp expression read using the minibuffer.
919 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
920 is a string to insert in the minibuffer before reading. */)
921 (prompt, initial_contents)
922 Lisp_Object prompt, initial_contents;
923 {
924 return Feval (Fread_minibuffer (prompt, initial_contents));
925 }
926
927 /* Functions that use the minibuffer to read various things. */
928
929 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
930 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
931 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
932 The third arg HISTORY, if non-nil, specifies a history list
933 and optionally the initial position in the list.
934 See `read-from-minibuffer' for details of HISTORY argument.
935 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used
936 for history commands, and as the value to return if the user enters
937 the empty string.
938 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
939 the current input method and the setting of `enable-multibyte-characters'. */)
940 (prompt, initial_input, history, default_value, inherit_input_method)
941 Lisp_Object prompt, initial_input, history, default_value;
942 Lisp_Object inherit_input_method;
943 {
944 Lisp_Object val;
945 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
946 Qnil, history, default_value,
947 inherit_input_method);
948 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (default_value))
949 val = default_value;
950 return val;
951 }
952
953 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
954 doc: /* Read a string from the terminal, not allowing blanks.
955 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.
956 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
957 the current input method and the setting of `enable-multibyte-characters'. */)
958 (prompt, initial, inherit_input_method)
959 Lisp_Object prompt, initial, inherit_input_method;
960 {
961 CHECK_STRING (prompt);
962 if (! NILP (initial))
963 CHECK_STRING (initial);
964
965 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
966 0, Qminibuffer_history, make_number (0), Qnil, 0,
967 !NILP (inherit_input_method));
968 }
969
970 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
971 doc: /* Read the name of a command and return as a symbol.
972 Prompt with PROMPT. By default, return DEFAULT-VALUE. */)
973 (prompt, default_value)
974 Lisp_Object prompt, default_value;
975 {
976 Lisp_Object name, default_string;
977
978 if (NILP (default_value))
979 default_string = Qnil;
980 else if (SYMBOLP (default_value))
981 XSETSTRING (default_string, XSYMBOL (default_value)->name);
982 else
983 default_string = default_value;
984
985 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
986 Qnil, Qnil, default_string, Qnil);
987 if (NILP (name))
988 return name;
989 return Fintern (name, Qnil);
990 }
991
992 #ifdef NOTDEF
993 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
994 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
995 Prompt with PROMPT. */)
996 (prompt)
997 Lisp_Object prompt;
998 {
999 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1000 Qnil);
1001 }
1002 #endif /* NOTDEF */
1003
1004 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1005 doc: /* Read the name of a user variable and return it as a symbol.
1006 Prompt with PROMPT. By default, return DEFAULT-VALUE.
1007 A user variable is one whose documentation starts with a `*' character. */)
1008 (prompt, default_value)
1009 Lisp_Object prompt, default_value;
1010 {
1011 Lisp_Object name, default_string;
1012
1013 if (NILP (default_value))
1014 default_string = Qnil;
1015 else if (SYMBOLP (default_value))
1016 XSETSTRING (default_string, XSYMBOL (default_value)->name);
1017 else
1018 default_string = default_value;
1019
1020 name = Fcompleting_read (prompt, Vobarray,
1021 Quser_variable_p, Qt,
1022 Qnil, Qnil, default_string, Qnil);
1023 if (NILP (name))
1024 return name;
1025 return Fintern (name, Qnil);
1026 }
1027
1028 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1029 doc: /* Read the name of a buffer and return as a string.
1030 Prompt with PROMPT.
1031 Optional second arg DEF is value to return if user enters an empty line.
1032 If optional third arg REQUIRE-MATCH is non-nil,
1033 only existing buffer names are allowed. */)
1034 (prompt, def, require_match)
1035 Lisp_Object prompt, def, require_match;
1036 {
1037 Lisp_Object args[4];
1038
1039 if (BUFFERP (def))
1040 def = XBUFFER (def)->name;
1041
1042 if (NILP (Vread_buffer_function))
1043 {
1044 if (!NILP (def))
1045 {
1046 args[0] = build_string ("%s(default %s) ");
1047 args[1] = prompt;
1048 args[2] = def;
1049 prompt = Fformat (3, args);
1050 }
1051
1052 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
1053 require_match, Qnil, Qbuffer_name_history,
1054 def, Qnil);
1055 }
1056 else
1057 {
1058 args[0] = Vread_buffer_function;
1059 args[1] = prompt;
1060 args[2] = def;
1061 args[3] = require_match;
1062 return Ffuncall(4, args);
1063 }
1064 }
1065 \f
1066 static Lisp_Object
1067 minibuf_conform_representation (string, basis)
1068 Lisp_Object string, basis;
1069 {
1070 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1071 return string;
1072
1073 if (STRING_MULTIBYTE (string))
1074 return Fstring_make_unibyte (string);
1075 else
1076 return Fstring_make_multibyte (string);
1077 }
1078
1079 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1080 doc: /* Return common substring of all completions of STRING in ALIST.
1081 Each car of each element of ALIST is tested to see if it begins with STRING.
1082 All that match are compared together; the longest initial sequence
1083 common to all matches is returned as a string.
1084 If there is no match at all, nil is returned.
1085 For a unique match which is exact, t is returned.
1086
1087 ALIST can be an obarray instead of an alist.
1088 Then the print names of all symbols in the obarray are the possible matches.
1089
1090 ALIST can also be a function to do the completion itself.
1091 It receives three arguments: the values STRING, PREDICATE and nil.
1092 Whatever it returns becomes the value of `try-completion'.
1093
1094 If optional third argument PREDICATE is non-nil,
1095 it is used to test each possible match.
1096 The match is a candidate only if PREDICATE returns non-nil.
1097 The argument given to PREDICATE is the alist element
1098 or the symbol from the obarray.
1099 Additionally to this predicate, `completion-regexp-list'
1100 is used to further constrain the set of candidates. */)
1101 (string, alist, predicate)
1102 Lisp_Object string, alist, predicate;
1103 {
1104 Lisp_Object bestmatch, tail, elt, eltstring;
1105 /* Size in bytes of BESTMATCH. */
1106 int bestmatchsize = 0;
1107 /* These are in bytes, too. */
1108 int compare, matchsize;
1109 int list = CONSP (alist) || NILP (alist);
1110 int index = 0, obsize = 0;
1111 int matchcount = 0;
1112 Lisp_Object bucket, zero, end, tem;
1113 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1114
1115 CHECK_STRING (string);
1116 if (!list && !VECTORP (alist))
1117 return call3 (alist, string, predicate, Qnil);
1118
1119 bestmatch = bucket = Qnil;
1120
1121 /* If ALIST is not a list, set TAIL just for gc pro. */
1122 tail = alist;
1123 if (! list)
1124 {
1125 index = 0;
1126 obsize = XVECTOR (alist)->size;
1127 bucket = XVECTOR (alist)->contents[index];
1128 }
1129
1130 while (1)
1131 {
1132 /* Get the next element of the alist or obarray. */
1133 /* Exit the loop if the elements are all used up. */
1134 /* elt gets the alist element or symbol.
1135 eltstring gets the name to check as a completion. */
1136
1137 if (list)
1138 {
1139 if (NILP (tail))
1140 break;
1141 elt = Fcar (tail);
1142 eltstring = Fcar (elt);
1143 tail = Fcdr (tail);
1144 }
1145 else
1146 {
1147 if (XFASTINT (bucket) != 0)
1148 {
1149 elt = bucket;
1150 eltstring = Fsymbol_name (elt);
1151 if (XSYMBOL (bucket)->next)
1152 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1153 else
1154 XSETFASTINT (bucket, 0);
1155 }
1156 else if (++index >= obsize)
1157 break;
1158 else
1159 {
1160 bucket = XVECTOR (alist)->contents[index];
1161 continue;
1162 }
1163 }
1164
1165 /* Is this element a possible completion? */
1166
1167 if (STRINGP (eltstring)
1168 && XSTRING (string)->size <= XSTRING (eltstring)->size
1169 && (tem = Fcompare_strings (eltstring, make_number (0),
1170 make_number (XSTRING (string)->size),
1171 string, make_number (0), Qnil,
1172 completion_ignore_case ?Qt : Qnil),
1173 EQ (Qt, tem)))
1174 {
1175 /* Yes. */
1176 Lisp_Object regexps;
1177 Lisp_Object zero;
1178 XSETFASTINT (zero, 0);
1179
1180 /* Ignore this element if it fails to match all the regexps. */
1181 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1182 regexps = XCDR (regexps))
1183 {
1184 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1185 if (NILP (tem))
1186 break;
1187 }
1188 if (CONSP (regexps))
1189 continue;
1190
1191 /* Ignore this element if there is a predicate
1192 and the predicate doesn't like it. */
1193
1194 if (!NILP (predicate))
1195 {
1196 if (EQ (predicate, Qcommandp))
1197 tem = Fcommandp (elt);
1198 else
1199 {
1200 GCPRO4 (tail, string, eltstring, bestmatch);
1201 tem = call1 (predicate, elt);
1202 UNGCPRO;
1203 }
1204 if (NILP (tem)) continue;
1205 }
1206
1207 /* Update computation of how much all possible completions match */
1208
1209 matchcount++;
1210 if (NILP (bestmatch))
1211 {
1212 bestmatch = eltstring;
1213 bestmatchsize = XSTRING (eltstring)->size;
1214 }
1215 else
1216 {
1217 compare = min (bestmatchsize, XSTRING (eltstring)->size);
1218 tem = Fcompare_strings (bestmatch, make_number (0),
1219 make_number (compare),
1220 eltstring, make_number (0),
1221 make_number (compare),
1222 completion_ignore_case ? Qt : Qnil);
1223 if (EQ (tem, Qt))
1224 matchsize = compare;
1225 else if (XINT (tem) < 0)
1226 matchsize = - XINT (tem) - 1;
1227 else
1228 matchsize = XINT (tem) - 1;
1229
1230 if (matchsize < 0)
1231 matchsize = compare;
1232 if (completion_ignore_case)
1233 {
1234 /* If this is an exact match except for case,
1235 use it as the best match rather than one that is not an
1236 exact match. This way, we get the case pattern
1237 of the actual match. */
1238 if ((matchsize == XSTRING (eltstring)->size
1239 && matchsize < XSTRING (bestmatch)->size)
1240 ||
1241 /* If there is more than one exact match ignoring case,
1242 and one of them is exact including case,
1243 prefer that one. */
1244 /* If there is no exact match ignoring case,
1245 prefer a match that does not change the case
1246 of the input. */
1247 ((matchsize == XSTRING (eltstring)->size)
1248 ==
1249 (matchsize == XSTRING (bestmatch)->size)
1250 && (tem = Fcompare_strings (eltstring, make_number (0),
1251 make_number (XSTRING (string)->size),
1252 string, make_number (0),
1253 Qnil,
1254 Qnil),
1255 EQ (Qt, tem))
1256 && (tem = Fcompare_strings (bestmatch, make_number (0),
1257 make_number (XSTRING (string)->size),
1258 string, make_number (0),
1259 Qnil,
1260 Qnil),
1261 ! EQ (Qt, tem))))
1262 bestmatch = eltstring;
1263 }
1264 bestmatchsize = matchsize;
1265 }
1266 }
1267 }
1268
1269 if (NILP (bestmatch))
1270 return Qnil; /* No completions found */
1271 /* If we are ignoring case, and there is no exact match,
1272 and no additional text was supplied,
1273 don't change the case of what the user typed. */
1274 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
1275 && XSTRING (bestmatch)->size > bestmatchsize)
1276 return minibuf_conform_representation (string, bestmatch);
1277
1278 /* Return t if the supplied string is an exact match (counting case);
1279 it does not require any change to be made. */
1280 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
1281 && (tem = Fcompare_strings (bestmatch, make_number (0),
1282 make_number (bestmatchsize),
1283 string, make_number (0),
1284 make_number (bestmatchsize),
1285 Qnil),
1286 EQ (Qt, tem)))
1287 return Qt;
1288
1289 XSETFASTINT (zero, 0); /* Else extract the part in which */
1290 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1291 return Fsubstring (bestmatch, zero, end);
1292 }
1293 \f
1294 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1295 doc: /* Search for partial matches to STRING in ALIST.
1296 Each car of each element of ALIST is tested to see if it begins with STRING.
1297 The value is a list of all the strings from ALIST that match.
1298
1299 ALIST can be an obarray instead of an alist.
1300 Then the print names of all symbols in the obarray are the possible matches.
1301
1302 ALIST can also be a function to do the completion itself.
1303 It receives three arguments: the values STRING, PREDICATE and t.
1304 Whatever it returns becomes the value of `all-completions'.
1305
1306 If optional third argument PREDICATE is non-nil,
1307 it is used to test each possible match.
1308 The match is a candidate only if PREDICATE returns non-nil.
1309 The argument given to PREDICATE is the alist element
1310 or the symbol from the obarray.
1311 Additionally to this predicate, `completion-regexp-list'
1312 is used to further constrain the set of candidates.
1313
1314 If the optional fourth argument HIDE-SPACES is non-nil,
1315 strings in ALIST that start with a space
1316 are ignored unless STRING itself starts with a space. */)
1317 (string, alist, predicate, hide_spaces)
1318 Lisp_Object string, alist, predicate, hide_spaces;
1319 {
1320 Lisp_Object tail, elt, eltstring;
1321 Lisp_Object allmatches;
1322 int list = CONSP (alist) || NILP (alist);
1323 int index = 0, obsize = 0;
1324 Lisp_Object bucket, tem;
1325 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1326
1327 CHECK_STRING (string);
1328 if (!list && !VECTORP (alist))
1329 {
1330 return call3 (alist, string, predicate, Qt);
1331 }
1332 allmatches = bucket = Qnil;
1333
1334 /* If ALIST is not a list, set TAIL just for gc pro. */
1335 tail = alist;
1336 if (! list)
1337 {
1338 index = 0;
1339 obsize = XVECTOR (alist)->size;
1340 bucket = XVECTOR (alist)->contents[index];
1341 }
1342
1343 while (1)
1344 {
1345 /* Get the next element of the alist or obarray. */
1346 /* Exit the loop if the elements are all used up. */
1347 /* elt gets the alist element or symbol.
1348 eltstring gets the name to check as a completion. */
1349
1350 if (list)
1351 {
1352 if (NILP (tail))
1353 break;
1354 elt = Fcar (tail);
1355 eltstring = Fcar (elt);
1356 tail = Fcdr (tail);
1357 }
1358 else
1359 {
1360 if (XFASTINT (bucket) != 0)
1361 {
1362 elt = bucket;
1363 eltstring = Fsymbol_name (elt);
1364 if (XSYMBOL (bucket)->next)
1365 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1366 else
1367 XSETFASTINT (bucket, 0);
1368 }
1369 else if (++index >= obsize)
1370 break;
1371 else
1372 {
1373 bucket = XVECTOR (alist)->contents[index];
1374 continue;
1375 }
1376 }
1377
1378 /* Is this element a possible completion? */
1379
1380 if (STRINGP (eltstring)
1381 && XSTRING (string)->size <= XSTRING (eltstring)->size
1382 /* If HIDE_SPACES, reject alternatives that start with space
1383 unless the input starts with space. */
1384 && ((STRING_BYTES (XSTRING (string)) > 0
1385 && XSTRING (string)->data[0] == ' ')
1386 || XSTRING (eltstring)->data[0] != ' '
1387 || NILP (hide_spaces))
1388 && (tem = Fcompare_strings (eltstring, make_number (0),
1389 make_number (XSTRING (string)->size),
1390 string, make_number (0),
1391 make_number (XSTRING (string)->size),
1392 completion_ignore_case ? Qt : Qnil),
1393 EQ (Qt, tem)))
1394 {
1395 /* Yes. */
1396 Lisp_Object regexps;
1397 Lisp_Object zero;
1398 XSETFASTINT (zero, 0);
1399
1400 /* Ignore this element if it fails to match all the regexps. */
1401 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1402 regexps = XCDR (regexps))
1403 {
1404 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1405 if (NILP (tem))
1406 break;
1407 }
1408 if (CONSP (regexps))
1409 continue;
1410
1411 /* Ignore this element if there is a predicate
1412 and the predicate doesn't like it. */
1413
1414 if (!NILP (predicate))
1415 {
1416 if (EQ (predicate, Qcommandp))
1417 tem = Fcommandp (elt);
1418 else
1419 {
1420 GCPRO4 (tail, eltstring, allmatches, string);
1421 tem = call1 (predicate, elt);
1422 UNGCPRO;
1423 }
1424 if (NILP (tem)) continue;
1425 }
1426 /* Ok => put it on the list. */
1427 allmatches = Fcons (eltstring, allmatches);
1428 }
1429 }
1430
1431 return Fnreverse (allmatches);
1432 }
1433 \f
1434 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1435 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1436 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1437 Lisp_Object Vminibuffer_completing_file_name;
1438
1439 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1440 doc: /* Read a string in the minibuffer, with completion.
1441 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1442 TABLE is an alist whose elements' cars are strings, or an obarray.
1443 TABLE can also be a function to do the completion itself.
1444 PREDICATE limits completion to a subset of TABLE.
1445 See `try-completion' and `all-completions' for more details
1446 on completion, TABLE, and PREDICATE.
1447
1448 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
1449 the input is (or completes to) an element of TABLE or is null.
1450 If it is also not t, Return does not exit if it does non-null completion.
1451 If the input is null, `completing-read' returns an empty string,
1452 regardless of the value of REQUIRE-MATCH.
1453
1454 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
1455 If it is (STRING . POSITION), the initial input
1456 is STRING, but point is placed POSITION characters into the string.
1457 This feature is deprecated--it is best to pass nil for INITIAL.
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 }