Avoid (most) uses of XCAR/XCDR as lvalues, for flexibility in experimenting
[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 #define DOC_STRINGS_IN_COMMENTS
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 /* 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, 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 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
328 Sminibuffer_prompt_end, 0, 0, 0,
329 /* 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);
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 /* Return the user input in a minbuffer 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 /* Return the user input in a minbuffer 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 /* 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 Qread_only, 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, remeber 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 /* This comment supplies the doc string for read-from-minibuffer,
815 for make-docfile to see. We cannot put this in the real DEFUN
816 due to limits in the Unix cpp.
817
818 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
819 "Read a string from the minibuffer, prompting with string PROMPT.\n\
820 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
821 to be inserted into the minibuffer before reading input.\n\
822 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
823 is STRING, but point is placed at position POSITION in the minibuffer.\n\
824 Third arg KEYMAP is a keymap to use whilst reading;\n\
825 if omitted or nil, the default is `minibuffer-local-map'.\n\
826 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
827 and return that object:\n\
828 in other words, do `(car (read-from-string INPUT-STRING))'\n\
829 Fifth arg HIST, if non-nil, specifies a history list\n\
830 and optionally the initial position in the list.\n\
831 It can be a symbol, which is the history list variable to use,\n\
832 or it can be a cons cell (HISTVAR . HISTPOS).\n\
833 In that case, HISTVAR is the history list variable to use,\n\
834 and HISTPOS is the initial position (the position in the list\n\
835 which INITIAL-CONTENTS corresponds to).\n\
836 Positions are counted starting from 1 at the beginning of the list.\n\
837 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
838 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
839 if the user enters empty input! It returns the empty string.\n\
840 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
841 the current input method and the setting of enable-multibyte-characters.\n\
842 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
843 then the string which is returned includes whatever text properties\n\
844 were present in the minibuffer. Otherwise the value has no text properties.")
845 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
846 */
847
848 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
849 /* Read a string from the minibuffer, prompting with string PROMPT.
850 If optional second arg INITIAL-CONTENTS is non-nil, it is a string
851 to be inserted into the minibuffer before reading input.
852 If INITIAL-CONTENTS is (STRING . POSITION), the initial input
853 is STRING, but point is placed at position POSITION in the minibuffer.
854 Third arg KEYMAP is a keymap to use whilst reading;
855 if omitted or nil, the default is `minibuffer-local-map'.
856 If fourth arg READ is non-nil, then interpret the result as a lisp object
857 and return that object:
858 in other words, do `(car (read-from-string INPUT-STRING))'
859 Fifth arg HIST, if non-nil, specifies a history list
860 and optionally the initial position in the list.
861 It can be a symbol, which is the history list variable to use,
862 or it can be a cons cell (HISTVAR . HISTPOS).
863 In that case, HISTVAR is the history list variable to use,
864 and HISTPOS is the initial position (the position in the list
865 which INITIAL-CONTENTS corresponds to).
866 Positions are counted starting from 1 at the beginning of the list.
867 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available
868 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE
869 if the user enters empty input! It returns the empty string.
870 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
871 the current input method and the setting of enable-multibyte-characters.
872 If the variable `minibuffer-allow-text-properties' is non-nil,
873 then the string which is returned includes whatever text properties
874 were present in the minibuffer. Otherwise the value has no text properties. */
875 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method))
876 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
877 Lisp_Object inherit_input_method;
878 {
879 int pos = 0;
880 Lisp_Object histvar, histpos, position, val;
881 struct gcpro gcpro1;
882
883 position = Qnil;
884
885 CHECK_STRING (prompt, 0);
886 if (!NILP (initial_contents))
887 {
888 if (CONSP (initial_contents))
889 {
890 position = Fcdr (initial_contents);
891 initial_contents = Fcar (initial_contents);
892 }
893 CHECK_STRING (initial_contents, 1);
894 if (!NILP (position))
895 {
896 CHECK_NUMBER (position, 0);
897 /* Convert to distance from end of input. */
898 if (XINT (position) < 1)
899 /* A number too small means the beginning of the string. */
900 pos = - XSTRING (initial_contents)->size;
901 else
902 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
903 }
904 }
905
906 if (NILP (keymap))
907 keymap = Vminibuffer_local_map;
908 else
909 keymap = get_keymap (keymap, 1, 0);
910
911 if (SYMBOLP (hist))
912 {
913 histvar = hist;
914 histpos = Qnil;
915 }
916 else
917 {
918 histvar = Fcar_safe (hist);
919 histpos = Fcdr_safe (hist);
920 }
921 if (NILP (histvar))
922 histvar = Qminibuffer_history;
923 if (NILP (histpos))
924 XSETFASTINT (histpos, 0);
925
926 GCPRO1 (default_value);
927 val = read_minibuf (keymap, initial_contents, prompt,
928 make_number (pos), !NILP (read),
929 histvar, histpos, default_value,
930 minibuffer_allow_text_properties,
931 !NILP (inherit_input_method));
932 UNGCPRO;
933 return val;
934 }
935
936 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
937 /* Return a Lisp object read using the minibuffer.
938 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
939 is a string to insert in the minibuffer before reading. */
940 (prompt, initial_contents))
941 Lisp_Object prompt, initial_contents;
942 {
943 CHECK_STRING (prompt, 0);
944 if (!NILP (initial_contents))
945 CHECK_STRING (initial_contents, 1);
946 return read_minibuf (Vminibuffer_local_map, initial_contents,
947 prompt, Qnil, 1, Qminibuffer_history,
948 make_number (0), Qnil, 0, 0);
949 }
950
951 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
952 /* Return value of Lisp expression read using the minibuffer.
953 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
954 is a string to insert in the minibuffer before reading. */
955 (prompt, initial_contents))
956 Lisp_Object prompt, initial_contents;
957 {
958 return Feval (Fread_minibuffer (prompt, initial_contents));
959 }
960
961 /* Functions that use the minibuffer to read various things. */
962
963 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
964 /* Read a string from the minibuffer, prompting with string PROMPT.
965 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
966 The third arg HISTORY, if non-nil, specifies a history list
967 and optionally the initial position in the list.
968 See `read-from-minibuffer' for details of HISTORY argument.
969 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used
970 for history commands, and as the value to return if the user enters
971 the empty string.
972 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
973 the current input method and the setting of enable-multibyte-characters. */
974 (prompt, initial_input, history, default_value, inherit_input_method))
975 Lisp_Object prompt, initial_input, history, default_value;
976 Lisp_Object inherit_input_method;
977 {
978 Lisp_Object val;
979 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
980 Qnil, history, default_value,
981 inherit_input_method);
982 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (default_value))
983 val = default_value;
984 return val;
985 }
986
987 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
988 /* Read a string from the terminal, not allowing blanks.
989 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.
990 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
991 the current input method and the setting of enable-multibyte-characters. */
992 (prompt, initial, inherit_input_method))
993 Lisp_Object prompt, initial, inherit_input_method;
994 {
995 CHECK_STRING (prompt, 0);
996 if (! NILP (initial))
997 CHECK_STRING (initial, 1);
998
999 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
1000 0, Qminibuffer_history, make_number (0), Qnil, 0,
1001 !NILP (inherit_input_method));
1002 }
1003
1004 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1005 /* Read the name of a command and return as a symbol.
1006 Prompts with PROMPT. By default, return DEFAULT-VALUE. */
1007 (prompt, default_value))
1008 Lisp_Object prompt, default_value;
1009 {
1010 Lisp_Object name, default_string;
1011
1012 if (NILP (default_value))
1013 default_string = Qnil;
1014 else if (SYMBOLP (default_value))
1015 XSETSTRING (default_string, XSYMBOL (default_value)->name);
1016 else
1017 default_string = default_value;
1018
1019 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1020 Qnil, Qnil, default_string, Qnil);
1021 if (NILP (name))
1022 return name;
1023 return Fintern (name, Qnil);
1024 }
1025
1026 #ifdef NOTDEF
1027 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1028 /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1029 Prompts with PROMPT. */
1030 (prompt))
1031 Lisp_Object prompt;
1032 {
1033 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1034 Qnil);
1035 }
1036 #endif /* NOTDEF */
1037
1038 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1039 /* Read the name of a user variable and return it as a symbol.
1040 Prompts with PROMPT. By default, return DEFAULT-VALUE.
1041 A user variable is one whose documentation starts with a `*' character. */
1042 (prompt, default_value))
1043 Lisp_Object prompt, default_value;
1044 {
1045 Lisp_Object name, default_string;
1046
1047 if (NILP (default_value))
1048 default_string = Qnil;
1049 else if (SYMBOLP (default_value))
1050 XSETSTRING (default_string, XSYMBOL (default_value)->name);
1051 else
1052 default_string = default_value;
1053
1054 name = Fcompleting_read (prompt, Vobarray,
1055 Quser_variable_p, Qt,
1056 Qnil, Qnil, default_string, Qnil);
1057 if (NILP (name))
1058 return name;
1059 return Fintern (name, Qnil);
1060 }
1061
1062 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1063 /* One arg PROMPT, a string. Read the name of a buffer and return as a string.
1064 Prompts with PROMPT.
1065 Optional second arg DEF is value to return if user enters an empty line.
1066 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed. */
1067 (prompt, def, require_match))
1068 Lisp_Object prompt, def, require_match;
1069 {
1070 Lisp_Object args[4];
1071
1072 if (BUFFERP (def))
1073 def = XBUFFER (def)->name;
1074
1075 if (NILP (Vread_buffer_function))
1076 {
1077 if (!NILP (def))
1078 {
1079 args[0] = build_string ("%s(default %s) ");
1080 args[1] = prompt;
1081 args[2] = def;
1082 prompt = Fformat (3, args);
1083 }
1084
1085 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
1086 require_match, Qnil, Qbuffer_name_history,
1087 def, Qnil);
1088 }
1089 else
1090 {
1091 args[0] = Vread_buffer_function;
1092 args[1] = prompt;
1093 args[2] = def;
1094 args[3] = require_match;
1095 return Ffuncall(4, args);
1096 }
1097 }
1098 \f
1099 static Lisp_Object
1100 minibuf_conform_representation (string, basis)
1101 Lisp_Object string, basis;
1102 {
1103 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1104 return string;
1105
1106 if (STRING_MULTIBYTE (string))
1107 return Fstring_make_unibyte (string);
1108 else
1109 return Fstring_make_multibyte (string);
1110 }
1111
1112 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1113 /* Return common substring of all completions of STRING in ALIST.
1114 Each car of each element of ALIST is tested to see if it begins with STRING.
1115 All that match are compared together; the longest initial sequence
1116 common to all matches is returned as a string.
1117 If there is no match at all, nil is returned.
1118 For a unique match which is exact, t is returned.
1119
1120 ALIST can be an obarray instead of an alist.
1121 Then the print names of all symbols in the obarray are the possible matches.
1122
1123 ALIST can also be a function to do the completion itself.
1124 It receives three arguments: the values STRING, PREDICATE and nil.
1125 Whatever it returns becomes the value of `try-completion'.
1126
1127 If optional third argument PREDICATE is non-nil,
1128 it is used to test each possible match.
1129 The match is a candidate only if PREDICATE returns non-nil.
1130 The argument given to PREDICATE is the alist element
1131 or the symbol from the obarray.
1132 Additionally to this predicate, `completion-regexp-list'
1133 is used to further constrain the set of candidates. */
1134 (string, alist, predicate))
1135 Lisp_Object string, alist, predicate;
1136 {
1137 Lisp_Object bestmatch, tail, elt, eltstring;
1138 /* Size in bytes of BESTMATCH. */
1139 int bestmatchsize = 0;
1140 /* These are in bytes, too. */
1141 int compare, matchsize;
1142 int list = CONSP (alist) || NILP (alist);
1143 int index = 0, obsize = 0;
1144 int matchcount = 0;
1145 Lisp_Object bucket, zero, end, tem;
1146 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1147
1148 CHECK_STRING (string, 0);
1149 if (!list && !VECTORP (alist))
1150 return call3 (alist, string, predicate, Qnil);
1151
1152 bestmatch = bucket = Qnil;
1153
1154 /* If ALIST is not a list, set TAIL just for gc pro. */
1155 tail = alist;
1156 if (! list)
1157 {
1158 index = 0;
1159 obsize = XVECTOR (alist)->size;
1160 bucket = XVECTOR (alist)->contents[index];
1161 }
1162
1163 while (1)
1164 {
1165 /* Get the next element of the alist or obarray. */
1166 /* Exit the loop if the elements are all used up. */
1167 /* elt gets the alist element or symbol.
1168 eltstring gets the name to check as a completion. */
1169
1170 if (list)
1171 {
1172 if (NILP (tail))
1173 break;
1174 elt = Fcar (tail);
1175 eltstring = Fcar (elt);
1176 tail = Fcdr (tail);
1177 }
1178 else
1179 {
1180 if (XFASTINT (bucket) != 0)
1181 {
1182 elt = bucket;
1183 eltstring = Fsymbol_name (elt);
1184 if (XSYMBOL (bucket)->next)
1185 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1186 else
1187 XSETFASTINT (bucket, 0);
1188 }
1189 else if (++index >= obsize)
1190 break;
1191 else
1192 {
1193 bucket = XVECTOR (alist)->contents[index];
1194 continue;
1195 }
1196 }
1197
1198 /* Is this element a possible completion? */
1199
1200 if (STRINGP (eltstring)
1201 && XSTRING (string)->size <= XSTRING (eltstring)->size
1202 && (tem = Fcompare_strings (eltstring, make_number (0),
1203 make_number (XSTRING (string)->size),
1204 string, make_number (0), Qnil,
1205 completion_ignore_case ?Qt : Qnil),
1206 EQ (Qt, tem)))
1207 {
1208 /* Yes. */
1209 Lisp_Object regexps;
1210 Lisp_Object zero;
1211 XSETFASTINT (zero, 0);
1212
1213 /* Ignore this element if it fails to match all the regexps. */
1214 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1215 regexps = XCDR (regexps))
1216 {
1217 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1218 if (NILP (tem))
1219 break;
1220 }
1221 if (CONSP (regexps))
1222 continue;
1223
1224 /* Ignore this element if there is a predicate
1225 and the predicate doesn't like it. */
1226
1227 if (!NILP (predicate))
1228 {
1229 if (EQ (predicate, Qcommandp))
1230 tem = Fcommandp (elt);
1231 else
1232 {
1233 GCPRO4 (tail, string, eltstring, bestmatch);
1234 tem = call1 (predicate, elt);
1235 UNGCPRO;
1236 }
1237 if (NILP (tem)) continue;
1238 }
1239
1240 /* Update computation of how much all possible completions match */
1241
1242 matchcount++;
1243 if (NILP (bestmatch))
1244 {
1245 bestmatch = eltstring;
1246 bestmatchsize = XSTRING (eltstring)->size;
1247 }
1248 else
1249 {
1250 compare = min (bestmatchsize, XSTRING (eltstring)->size);
1251 tem = Fcompare_strings (bestmatch, make_number (0),
1252 make_number (compare),
1253 eltstring, make_number (0),
1254 make_number (compare),
1255 completion_ignore_case ? Qt : Qnil);
1256 if (EQ (tem, Qt))
1257 matchsize = compare;
1258 else if (XINT (tem) < 0)
1259 matchsize = - XINT (tem) - 1;
1260 else
1261 matchsize = XINT (tem) - 1;
1262
1263 if (matchsize < 0)
1264 matchsize = compare;
1265 if (completion_ignore_case)
1266 {
1267 /* If this is an exact match except for case,
1268 use it as the best match rather than one that is not an
1269 exact match. This way, we get the case pattern
1270 of the actual match. */
1271 if ((matchsize == XSTRING (eltstring)->size
1272 && matchsize < XSTRING (bestmatch)->size)
1273 ||
1274 /* If there is more than one exact match ignoring case,
1275 and one of them is exact including case,
1276 prefer that one. */
1277 /* If there is no exact match ignoring case,
1278 prefer a match that does not change the case
1279 of the input. */
1280 ((matchsize == XSTRING (eltstring)->size)
1281 ==
1282 (matchsize == XSTRING (bestmatch)->size)
1283 && (tem = Fcompare_strings (eltstring, make_number (0),
1284 make_number (XSTRING (string)->size),
1285 string, make_number (0),
1286 Qnil,
1287 Qnil),
1288 EQ (Qt, tem))
1289 && (tem = Fcompare_strings (bestmatch, make_number (0),
1290 make_number (XSTRING (string)->size),
1291 string, make_number (0),
1292 Qnil,
1293 Qnil),
1294 ! EQ (Qt, tem))))
1295 bestmatch = eltstring;
1296 }
1297 bestmatchsize = matchsize;
1298 }
1299 }
1300 }
1301
1302 if (NILP (bestmatch))
1303 return Qnil; /* No completions found */
1304 /* If we are ignoring case, and there is no exact match,
1305 and no additional text was supplied,
1306 don't change the case of what the user typed. */
1307 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
1308 && XSTRING (bestmatch)->size > bestmatchsize)
1309 return minibuf_conform_representation (string, bestmatch);
1310
1311 /* Return t if the supplied string is an exact match (counting case);
1312 it does not require any change to be made. */
1313 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
1314 && (tem = Fcompare_strings (bestmatch, make_number (0),
1315 make_number (bestmatchsize),
1316 string, make_number (0),
1317 make_number (bestmatchsize),
1318 Qnil),
1319 EQ (Qt, tem)))
1320 return Qt;
1321
1322 XSETFASTINT (zero, 0); /* Else extract the part in which */
1323 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1324 return Fsubstring (bestmatch, zero, end);
1325 }
1326
1327 /* Compare exactly LEN chars of strings at S1 and S2,
1328 ignoring case if appropriate.
1329 Return -1 if strings match,
1330 else number of chars that match at the beginning. */
1331
1332 int
1333 scmp (s1, s2, len)
1334 register unsigned char *s1, *s2;
1335 int len;
1336 {
1337 register int l = len;
1338
1339 if (completion_ignore_case)
1340 {
1341 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
1342 l--;
1343 }
1344 else
1345 {
1346 while (l && *s1++ == *s2++)
1347 l--;
1348 }
1349 if (l == 0)
1350 return -1;
1351 else
1352 {
1353 int match = len - l;
1354
1355 /* Now *--S1 is the unmatching byte. If it is in the middle of
1356 multi-byte form, we must say that the multi-byte character
1357 there doesn't match. */
1358 while (match && *--s1 >= 0xA0) match--;
1359 return match;
1360 }
1361 }
1362 \f
1363 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1364 /* Search for partial matches to STRING in ALIST.
1365 Each car of each element of ALIST is tested to see if it begins with STRING.
1366 The value is a list of all the strings from ALIST that match.
1367
1368 ALIST can be an obarray instead of an alist.
1369 Then the print names of all symbols in the obarray are the possible matches.
1370
1371 ALIST can also be a function to do the completion itself.
1372 It receives three arguments: the values STRING, PREDICATE and t.
1373 Whatever it returns becomes the value of `all-completions'.
1374
1375 If optional third argument PREDICATE is non-nil,
1376 it is used to test each possible match.
1377 The match is a candidate only if PREDICATE returns non-nil.
1378 The argument given to PREDICATE is the alist element
1379 or the symbol from the obarray.
1380 Additionally to this predicate, `completion-regexp-list'
1381 is used to further constrain the set of candidates.
1382
1383 If the optional fourth argument HIDE-SPACES is non-nil,
1384 strings in ALIST that start with a space
1385 are ignored unless STRING itself starts with a space. */
1386 (string, alist, predicate, hide_spaces))
1387 Lisp_Object string, alist, predicate, hide_spaces;
1388 {
1389 Lisp_Object tail, elt, eltstring;
1390 Lisp_Object allmatches;
1391 int list = CONSP (alist) || NILP (alist);
1392 int index = 0, obsize = 0;
1393 Lisp_Object bucket, tem;
1394 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1395
1396 CHECK_STRING (string, 0);
1397 if (!list && !VECTORP (alist))
1398 {
1399 return call3 (alist, string, predicate, Qt);
1400 }
1401 allmatches = bucket = Qnil;
1402
1403 /* If ALIST is not a list, set TAIL just for gc pro. */
1404 tail = alist;
1405 if (! list)
1406 {
1407 index = 0;
1408 obsize = XVECTOR (alist)->size;
1409 bucket = XVECTOR (alist)->contents[index];
1410 }
1411
1412 while (1)
1413 {
1414 /* Get the next element of the alist or obarray. */
1415 /* Exit the loop if the elements are all used up. */
1416 /* elt gets the alist element or symbol.
1417 eltstring gets the name to check as a completion. */
1418
1419 if (list)
1420 {
1421 if (NILP (tail))
1422 break;
1423 elt = Fcar (tail);
1424 eltstring = Fcar (elt);
1425 tail = Fcdr (tail);
1426 }
1427 else
1428 {
1429 if (XFASTINT (bucket) != 0)
1430 {
1431 elt = bucket;
1432 eltstring = Fsymbol_name (elt);
1433 if (XSYMBOL (bucket)->next)
1434 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1435 else
1436 XSETFASTINT (bucket, 0);
1437 }
1438 else if (++index >= obsize)
1439 break;
1440 else
1441 {
1442 bucket = XVECTOR (alist)->contents[index];
1443 continue;
1444 }
1445 }
1446
1447 /* Is this element a possible completion? */
1448
1449 if (STRINGP (eltstring)
1450 && XSTRING (string)->size <= XSTRING (eltstring)->size
1451 /* If HIDE_SPACES, reject alternatives that start with space
1452 unless the input starts with space. */
1453 && ((STRING_BYTES (XSTRING (string)) > 0
1454 && XSTRING (string)->data[0] == ' ')
1455 || XSTRING (eltstring)->data[0] != ' '
1456 || NILP (hide_spaces))
1457 && (tem = Fcompare_strings (eltstring, make_number (0),
1458 make_number (XSTRING (string)->size),
1459 string, make_number (0),
1460 make_number (XSTRING (string)->size),
1461 completion_ignore_case ? Qt : Qnil),
1462 EQ (Qt, tem)))
1463 {
1464 /* Yes. */
1465 Lisp_Object regexps;
1466 Lisp_Object zero;
1467 XSETFASTINT (zero, 0);
1468
1469 /* Ignore this element if it fails to match all the regexps. */
1470 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1471 regexps = XCDR (regexps))
1472 {
1473 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1474 if (NILP (tem))
1475 break;
1476 }
1477 if (CONSP (regexps))
1478 continue;
1479
1480 /* Ignore this element if there is a predicate
1481 and the predicate doesn't like it. */
1482
1483 if (!NILP (predicate))
1484 {
1485 if (EQ (predicate, Qcommandp))
1486 tem = Fcommandp (elt);
1487 else
1488 {
1489 GCPRO4 (tail, eltstring, allmatches, string);
1490 tem = call1 (predicate, elt);
1491 UNGCPRO;
1492 }
1493 if (NILP (tem)) continue;
1494 }
1495 /* Ok => put it on the list. */
1496 allmatches = Fcons (eltstring, allmatches);
1497 }
1498 }
1499
1500 return Fnreverse (allmatches);
1501 }
1502 \f
1503 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1504 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1505 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1506 Lisp_Object Vminibuffer_completing_file_name;
1507
1508 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1509 /* Read a string in the minibuffer, with completion.
1510 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1511 TABLE is an alist whose elements' cars are strings, or an obarray.
1512 TABLE can also be a function to do the completion itself.
1513 PREDICATE limits completion to a subset of TABLE.
1514 See `try-completion' and `all-completions' for more details
1515 on completion, TABLE, and PREDICATE.
1516
1517 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
1518 the input is (or completes to) an element of TABLE or is null.
1519 If it is also not t, Return does not exit if it does non-null completion.
1520 If the input is null, `completing-read' returns an empty string,
1521 regardless of the value of REQUIRE-MATCH.
1522
1523 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
1524 If it is (STRING . POSITION), the initial input
1525 is STRING, but point is placed POSITION characters into the string.
1526 This feature is deprecated--it is best to pass nil for INITIAL.
1527 HIST, if non-nil, specifies a history list
1528 and optionally the initial position in the list.
1529 It can be a symbol, which is the history list variable to use,
1530 or it can be a cons cell (HISTVAR . HISTPOS).
1531 In that case, HISTVAR is the history list variable to use,
1532 and HISTPOS is the initial position (the position in the list
1533 which INITIAL-INPUT corresponds to).
1534 Positions are counted starting from 1 at the beginning of the list.
1535 DEF, if non-nil, is the default value.
1536
1537 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1538 the current input method and the setting of enable-multibyte-characters.
1539
1540 Completion ignores case if the ambient value of
1541 `completion-ignore-case' is non-nil. */
1542 (prompt, table, predicate, require_match, initial_input, hist, def, inherit_input_method))
1543 Lisp_Object prompt, table, predicate, require_match, initial_input;
1544 Lisp_Object hist, def, inherit_input_method;
1545 {
1546 Lisp_Object val, histvar, histpos, position;
1547 Lisp_Object init;
1548 int pos = 0;
1549 int count = specpdl_ptr - specpdl;
1550 struct gcpro gcpro1;
1551
1552 init = initial_input;
1553 GCPRO1 (def);
1554
1555 specbind (Qminibuffer_completion_table, table);
1556 specbind (Qminibuffer_completion_predicate, predicate);
1557 specbind (Qminibuffer_completion_confirm,
1558 EQ (require_match, Qt) ? Qnil : Qt);
1559 last_exact_completion = Qnil;
1560
1561 position = Qnil;
1562 if (!NILP (init))
1563 {
1564 if (CONSP (init))
1565 {
1566 position = Fcdr (init);
1567 init = Fcar (init);
1568 }
1569 CHECK_STRING (init, 0);
1570 if (!NILP (position))
1571 {
1572 CHECK_NUMBER (position, 0);
1573 /* Convert to distance from end of input. */
1574 pos = XINT (position) - XSTRING (init)->size;
1575 }
1576 }
1577
1578 if (SYMBOLP (hist))
1579 {
1580 histvar = hist;
1581 histpos = Qnil;
1582 }
1583 else
1584 {
1585 histvar = Fcar_safe (hist);
1586 histpos = Fcdr_safe (hist);
1587 }
1588 if (NILP (histvar))
1589 histvar = Qminibuffer_history;
1590 if (NILP (histpos))
1591 XSETFASTINT (histpos, 0);
1592
1593 val = read_minibuf (NILP (require_match)
1594 ? Vminibuffer_local_completion_map
1595 : Vminibuffer_local_must_match_map,
1596 init, prompt, make_number (pos), 0,
1597 histvar, histpos, def, 0,
1598 !NILP (inherit_input_method));
1599
1600 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (def))
1601 val = def;
1602
1603 RETURN_UNGCPRO (unbind_to (count, val));
1604 }
1605 \f
1606 Lisp_Object Fminibuffer_completion_help ();
1607 Lisp_Object assoc_for_completion ();
1608
1609 /* Test whether TXT is an exact completion. */
1610 Lisp_Object
1611 test_completion (txt)
1612 Lisp_Object txt;
1613 {
1614 Lisp_Object tem;
1615
1616 if (CONSP (Vminibuffer_completion_table)
1617 || NILP (Vminibuffer_completion_table))
1618 return assoc_for_completion (txt, Vminibuffer_completion_table);
1619 else if (VECTORP (Vminibuffer_completion_table))
1620 {
1621 /* Bypass intern-soft as that loses for nil */
1622 tem = oblookup (Vminibuffer_completion_table,
1623 XSTRING (txt)->data,
1624 XSTRING (txt)->size,
1625 STRING_BYTES (XSTRING (txt)));
1626 if (!SYMBOLP (tem))
1627 {
1628 if (STRING_MULTIBYTE (txt))
1629 txt = Fstring_make_unibyte (txt);
1630 else
1631 txt = Fstring_make_multibyte (txt);
1632
1633 tem = oblookup (Vminibuffer_completion_table,
1634 XSTRING (txt)->data,
1635 XSTRING (txt)->size,
1636 STRING_BYTES (XSTRING (txt)));
1637 if (!SYMBOLP (tem))
1638 return Qnil;
1639 }
1640 if (!NILP (Vminibuffer_completion_predicate))
1641 return call1 (Vminibuffer_completion_predicate, tem);
1642 else
1643 return Qt;
1644 }
1645 else
1646 return call3 (Vminibuffer_completion_table, txt,
1647 Vminibuffer_completion_predicate, Qlambda);
1648 }
1649
1650 /* returns:
1651 * 0 no possible completion
1652 * 1 was already an exact and unique completion
1653 * 3 was already an exact completion
1654 * 4 completed to an exact completion
1655 * 5 some completion happened
1656 * 6 no completion happened
1657 */
1658 int
1659 do_completion ()
1660 {
1661 Lisp_Object completion, string, tem;
1662 int completedp;
1663 Lisp_Object last;
1664 struct gcpro gcpro1, gcpro2;
1665
1666 completion = Ftry_completion (Fminibuffer_contents (),
1667 Vminibuffer_completion_table,
1668 Vminibuffer_completion_predicate);
1669 last = last_exact_completion;
1670 last_exact_completion = Qnil;
1671
1672 GCPRO2 (completion, last);
1673
1674 if (NILP (completion))
1675 {
1676 bitch_at_user ();
1677 temp_echo_area_glyphs (" [No match]");
1678 UNGCPRO;
1679 return 0;
1680 }
1681
1682 if (EQ (completion, Qt)) /* exact and unique match */
1683 {
1684 UNGCPRO;
1685 return 1;
1686 }
1687
1688 string = Fminibuffer_contents ();
1689
1690 /* COMPLETEDP should be true if some completion was done, which
1691 doesn't include simply changing the case of the entered string.
1692 However, for appearance, the string is rewritten if the case
1693 changes. */
1694 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qt);
1695 completedp = !EQ (tem, Qt);
1696
1697 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qnil);
1698 if (!EQ (tem, Qt))
1699 /* Rewrite the user's input. */
1700 {
1701 Fdelete_minibuffer_contents (); /* Some completion happened */
1702 Finsert (1, &completion);
1703
1704 if (! completedp)
1705 /* The case of the string changed, but that's all. We're not
1706 sure whether this is a unique completion or not, so try again
1707 using the real case (this shouldn't recurse again, because
1708 the next time try-completion will return either `t' or the
1709 exact string). */
1710 {
1711 UNGCPRO;
1712 return do_completion ();
1713 }
1714 }
1715
1716 /* It did find a match. Do we match some possibility exactly now? */
1717 tem = test_completion (Fminibuffer_contents ());
1718 if (NILP (tem))
1719 {
1720 /* not an exact match */
1721 UNGCPRO;
1722 if (completedp)
1723 return 5;
1724 else if (!NILP (Vcompletion_auto_help))
1725 Fminibuffer_completion_help ();
1726 else
1727 temp_echo_area_glyphs (" [Next char not unique]");
1728 return 6;
1729 }
1730 else if (completedp)
1731 {
1732 UNGCPRO;
1733 return 4;
1734 }
1735 /* If the last exact completion and this one were the same,
1736 it means we've already given a "Complete but not unique"
1737 message and the user's hit TAB again, so now we give him help. */
1738 last_exact_completion = completion;
1739 if (!NILP (last))
1740 {
1741 tem = Fminibuffer_contents ();
1742 if (!NILP (Fequal (tem, last)))
1743 Fminibuffer_completion_help ();
1744 }
1745 UNGCPRO;
1746 return 3;
1747 }
1748
1749 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1750
1751 Lisp_Object
1752 assoc_for_completion (key, list)
1753 register Lisp_Object key;
1754 Lisp_Object list;
1755 {
1756 register Lisp_Object tail;
1757
1758 for (tail = list; !NILP (tail); tail = Fcdr (tail))
1759 {
1760 register Lisp_Object elt, tem, thiscar;
1761 elt = Fcar (tail);
1762 if (!CONSP (elt)) continue;
1763 thiscar = Fcar (elt);
1764 if (!STRINGP (thiscar))
1765 continue;
1766 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1767 key, make_number (0), Qnil,
1768 completion_ignore_case ? Qt : Qnil);
1769 if (EQ (tem, Qt))
1770 return elt;
1771 QUIT;
1772 }
1773 return Qnil;
1774 }
1775
1776 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
1777 /* Complete the minibuffer contents as far as possible.
1778 Return nil if there is no valid completion, else t.
1779 If no characters can be completed, display a list of possible completions.
1780 If you repeat this command after it displayed such a list,
1781 scroll the window of possible completions. */
1782 ())
1783 {
1784 register int i;
1785 Lisp_Object window, tem;
1786
1787 /* If the previous command was not this,
1788 mark the completion buffer obsolete. */
1789 if (! EQ (current_kboard->Vlast_command, Vthis_command))
1790 Vminibuf_scroll_window = Qnil;
1791
1792 window = Vminibuf_scroll_window;
1793 /* If there's a fresh completion window with a live buffer,
1794 and this command is repeated, scroll that window. */
1795 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1796 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1797 {
1798 struct buffer *obuf = current_buffer;
1799
1800 Fset_buffer (XWINDOW (window)->buffer);
1801 tem = Fpos_visible_in_window_p (make_number (ZV), window, Qnil);
1802 if (! NILP (tem))
1803 /* If end is in view, scroll up to the beginning. */
1804 Fset_window_start (window, make_number (BEGV), Qnil);
1805 else
1806 /* Else scroll down one screen. */
1807 Fscroll_other_window (Qnil);
1808
1809 set_buffer_internal (obuf);
1810 return Qnil;
1811 }
1812
1813 i = do_completion ();
1814 switch (i)
1815 {
1816 case 0:
1817 return Qnil;
1818
1819 case 1:
1820 if (PT != ZV)
1821 Fgoto_char (make_number (ZV));
1822 temp_echo_area_glyphs (" [Sole completion]");
1823 break;
1824
1825 case 3:
1826 if (PT != ZV)
1827 Fgoto_char (make_number (ZV));
1828 temp_echo_area_glyphs (" [Complete, but not unique]");
1829 break;
1830 }
1831
1832 return Qt;
1833 }
1834 \f
1835 /* Subroutines of Fminibuffer_complete_and_exit. */
1836
1837 /* This one is called by internal_condition_case to do the real work. */
1838
1839 Lisp_Object
1840 complete_and_exit_1 ()
1841 {
1842 return make_number (do_completion ());
1843 }
1844
1845 /* This one is called by internal_condition_case if an error happens.
1846 Pretend the current value is an exact match. */
1847
1848 Lisp_Object
1849 complete_and_exit_2 (ignore)
1850 Lisp_Object ignore;
1851 {
1852 return make_number (1);
1853 }
1854
1855 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1856 Sminibuffer_complete_and_exit, 0, 0, "",
1857 /* If the minibuffer contents is a valid completion then exit.
1858 Otherwise try to complete it. If completion leads to a valid completion,
1859 a repetition of this command will exit. */
1860 ())
1861 {
1862 register int i;
1863 Lisp_Object val;
1864
1865 /* Allow user to specify null string */
1866 if (XINT (Fminibuffer_prompt_end ()) == ZV)
1867 goto exit;
1868
1869 if (!NILP (test_completion (Fminibuffer_contents ())))
1870 goto exit;
1871
1872 /* Call do_completion, but ignore errors. */
1873 val = internal_condition_case (complete_and_exit_1, Qerror,
1874 complete_and_exit_2);
1875
1876 i = XFASTINT (val);
1877 switch (i)
1878 {
1879 case 1:
1880 case 3:
1881 goto exit;
1882
1883 case 4:
1884 if (!NILP (Vminibuffer_completion_confirm))
1885 {
1886 temp_echo_area_glyphs (" [Confirm]");
1887 return Qnil;
1888 }
1889 else
1890 goto exit;
1891
1892 default:
1893 return Qnil;
1894 }
1895 exit:
1896 return Fthrow (Qexit, Qnil);
1897 /* NOTREACHED */
1898 }
1899
1900 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1901 0, 0, "",
1902 /* Complete the minibuffer contents at most a single word.
1903 After one word is completed as much as possible, a space or hyphen
1904 is added, provided that matches some possible completion.
1905 Return nil if there is no valid completion, else t. */
1906 ())
1907 {
1908 Lisp_Object completion, tem, tem1;
1909 register int i, i_byte;
1910 register unsigned char *completion_string;
1911 struct gcpro gcpro1, gcpro2;
1912 int prompt_end_charpos;
1913
1914 /* We keep calling Fbuffer_string rather than arrange for GC to
1915 hold onto a pointer to one of the strings thus made. */
1916
1917 completion = Ftry_completion (Fminibuffer_contents (),
1918 Vminibuffer_completion_table,
1919 Vminibuffer_completion_predicate);
1920 if (NILP (completion))
1921 {
1922 bitch_at_user ();
1923 temp_echo_area_glyphs (" [No match]");
1924 return Qnil;
1925 }
1926 if (EQ (completion, Qt))
1927 return Qnil;
1928
1929 #if 0 /* How the below code used to look, for reference. */
1930 tem = Fminibuffer_contents ();
1931 b = XSTRING (tem)->data;
1932 i = ZV - 1 - XSTRING (completion)->size;
1933 p = XSTRING (completion)->data;
1934 if (i > 0 ||
1935 0 <= scmp (b, p, ZV - 1))
1936 {
1937 i = 1;
1938 /* Set buffer to longest match of buffer tail and completion head. */
1939 while (0 <= scmp (b + i, p, ZV - 1 - i))
1940 i++;
1941 del_range (1, i + 1);
1942 SET_PT (ZV);
1943 }
1944 #else /* Rewritten code */
1945 {
1946 int buffer_nchars, completion_nchars;
1947
1948 CHECK_STRING (completion, 0);
1949 tem = Fminibuffer_contents ();
1950 GCPRO2 (completion, tem);
1951 /* If reading a file name,
1952 expand any $ENVVAR refs in the buffer and in TEM. */
1953 if (! NILP (Vminibuffer_completing_file_name))
1954 {
1955 Lisp_Object substituted;
1956 substituted = Fsubstitute_in_file_name (tem);
1957 if (! EQ (substituted, tem))
1958 {
1959 tem = substituted;
1960 Fdelete_minibuffer_contents ();
1961 insert_from_string (tem, 0, 0, XSTRING (tem)->size,
1962 STRING_BYTES (XSTRING (tem)), 0);
1963 }
1964 }
1965 buffer_nchars = XSTRING (tem)->size; /* ie ZV - BEGV */
1966 completion_nchars = XSTRING (completion)->size;
1967 i = buffer_nchars - completion_nchars;
1968 if (i > 0
1969 ||
1970 (tem1 = Fcompare_strings (tem, make_number (0),
1971 make_number (buffer_nchars),
1972 completion, make_number (0),
1973 make_number (buffer_nchars),
1974 completion_ignore_case ? Qt : Qnil),
1975 ! EQ (tem1, Qt)))
1976 {
1977 int start_pos;
1978
1979 /* Set buffer to longest match of buffer tail and completion head. */
1980 if (i <= 0) i = 1;
1981 start_pos= i;
1982 buffer_nchars -= i;
1983 while (i > 0)
1984 {
1985 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
1986 completion, make_number (0),
1987 make_number (buffer_nchars),
1988 completion_ignore_case ? Qt : Qnil);
1989 start_pos++;
1990 if (EQ (tem1, Qt))
1991 break;
1992 i++;
1993 buffer_nchars--;
1994 }
1995 del_range (1, i + 1);
1996 SET_PT_BOTH (ZV, ZV_BYTE);
1997 }
1998 UNGCPRO;
1999 }
2000 #endif /* Rewritten code */
2001
2002 prompt_end_charpos = XINT (Fminibuffer_prompt_end ());
2003
2004 {
2005 int prompt_end_bytepos;
2006 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
2007 i = ZV - prompt_end_charpos;
2008 i_byte = ZV_BYTE - prompt_end_bytepos;
2009 }
2010
2011 /* If completion finds next char not unique,
2012 consider adding a space or a hyphen. */
2013 if (i == XSTRING (completion)->size)
2014 {
2015 GCPRO1 (completion);
2016 tem = Ftry_completion (concat2 (Fminibuffer_contents (), build_string (" ")),
2017 Vminibuffer_completion_table,
2018 Vminibuffer_completion_predicate);
2019 UNGCPRO;
2020
2021 if (STRINGP (tem))
2022 completion = tem;
2023 else
2024 {
2025 GCPRO1 (completion);
2026 tem =
2027 Ftry_completion (concat2 (Fminibuffer_contents (), build_string ("-")),
2028 Vminibuffer_completion_table,
2029 Vminibuffer_completion_predicate);
2030 UNGCPRO;
2031
2032 if (STRINGP (tem))
2033 completion = tem;
2034 }
2035 }
2036
2037 /* Now find first word-break in the stuff found by completion.
2038 i gets index in string of where to stop completing. */
2039 {
2040 int len, c;
2041 int bytes = STRING_BYTES (XSTRING (completion));
2042 completion_string = XSTRING (completion)->data;
2043 for (; i_byte < STRING_BYTES (XSTRING (completion)); i_byte += len, i++)
2044 {
2045 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
2046 bytes - i_byte,
2047 len);
2048 if (SYNTAX (c) != Sword)
2049 {
2050 i_byte += len;
2051 i++;
2052 break;
2053 }
2054 }
2055 }
2056
2057 /* If got no characters, print help for user. */
2058
2059 if (i == ZV - prompt_end_charpos)
2060 {
2061 if (!NILP (Vcompletion_auto_help))
2062 Fminibuffer_completion_help ();
2063 return Qnil;
2064 }
2065
2066 /* Otherwise insert in minibuffer the chars we got */
2067
2068 Fdelete_minibuffer_contents ();
2069 insert_from_string (completion, 0, 0, i, i_byte, 1);
2070 return Qt;
2071 }
2072 \f
2073 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
2074 1, 1, 0,
2075 /* Display the list of completions, COMPLETIONS, using `standard-output'.
2076 Each element may be just a symbol or string
2077 or may be a list of two strings to be printed as if concatenated.
2078 `standard-output' must be a buffer.
2079 The actual completion alternatives, as inserted, are given `mouse-face'
2080 properties of `highlight'.
2081 At the end, this runs the normal hook `completion-setup-hook'.
2082 It can find the completion buffer in `standard-output'. */
2083 (completions))
2084 Lisp_Object completions;
2085 {
2086 Lisp_Object tail, elt;
2087 register int i;
2088 int column = 0;
2089 struct gcpro gcpro1, gcpro2;
2090 struct buffer *old = current_buffer;
2091 int first = 1;
2092
2093 /* Note that (when it matters) every variable
2094 points to a non-string that is pointed to by COMPLETIONS,
2095 except for ELT. ELT can be pointing to a string
2096 when terpri or Findent_to calls a change hook. */
2097 elt = Qnil;
2098 GCPRO2 (completions, elt);
2099
2100 if (BUFFERP (Vstandard_output))
2101 set_buffer_internal (XBUFFER (Vstandard_output));
2102
2103 if (NILP (completions))
2104 write_string ("There are no possible completions of what you have typed.",
2105 -1);
2106 else
2107 {
2108 write_string ("Possible completions are:", -1);
2109 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
2110 {
2111 Lisp_Object tem, string;
2112 int length;
2113 Lisp_Object startpos, endpos;
2114
2115 startpos = Qnil;
2116
2117 elt = Fcar (tail);
2118 /* Compute the length of this element. */
2119 if (CONSP (elt))
2120 {
2121 tem = XCAR (elt);
2122 CHECK_STRING (tem, 0);
2123 length = XSTRING (tem)->size;
2124
2125 tem = Fcar (XCDR (elt));
2126 CHECK_STRING (tem, 0);
2127 length += XSTRING (tem)->size;
2128 }
2129 else
2130 {
2131 CHECK_STRING (elt, 0);
2132 length = XSTRING (elt)->size;
2133 }
2134
2135 /* This does a bad job for narrower than usual windows.
2136 Sadly, the window it will appear in is not known
2137 until after the text has been made. */
2138
2139 if (BUFFERP (Vstandard_output))
2140 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2141
2142 /* If the previous completion was very wide,
2143 or we have two on this line already,
2144 don't put another on the same line. */
2145 if (column > 33 || first
2146 /* If this is really wide, don't put it second on a line. */
2147 || (column > 0 && length > 45))
2148 {
2149 Fterpri (Qnil);
2150 column = 0;
2151 }
2152 /* Otherwise advance to column 35. */
2153 else
2154 {
2155 if (BUFFERP (Vstandard_output))
2156 {
2157 tem = Findent_to (make_number (35), make_number (2));
2158
2159 column = XINT (tem);
2160 }
2161 else
2162 {
2163 do
2164 {
2165 write_string (" ", -1);
2166 column++;
2167 }
2168 while (column < 35);
2169 }
2170 }
2171
2172 if (BUFFERP (Vstandard_output))
2173 {
2174 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2175 Fset_text_properties (startpos, endpos,
2176 Qnil, Vstandard_output);
2177 }
2178
2179 /* Output this element.
2180 If necessary, convert it to unibyte or to multibyte first. */
2181 if (CONSP (elt))
2182 string = Fcar (elt);
2183 else
2184 string = elt;
2185 if (NILP (current_buffer->enable_multibyte_characters)
2186 && STRING_MULTIBYTE (string))
2187 string = Fstring_make_unibyte (string);
2188 else if (!NILP (current_buffer->enable_multibyte_characters)
2189 && !STRING_MULTIBYTE (string))
2190 string = Fstring_make_multibyte (string);
2191
2192 if (BUFFERP (Vstandard_output))
2193 {
2194 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2195
2196 Fprinc (string, Qnil);
2197
2198 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2199
2200 Fput_text_property (startpos, endpos,
2201 Qmouse_face, intern ("highlight"),
2202 Vstandard_output);
2203 }
2204 else
2205 {
2206 Fprinc (string, Qnil);
2207 }
2208
2209 /* Output the annotation for this element. */
2210 if (CONSP (elt))
2211 {
2212 if (BUFFERP (Vstandard_output))
2213 {
2214 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2215
2216 Fprinc (Fcar (Fcdr (elt)), Qnil);
2217
2218 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2219
2220 Fset_text_properties (startpos, endpos, Qnil,
2221 Vstandard_output);
2222 }
2223 else
2224 {
2225 Fprinc (Fcar (Fcdr (elt)), Qnil);
2226 }
2227 }
2228
2229
2230 /* Update COLUMN for what we have output. */
2231 column += length;
2232
2233 /* If output is to a buffer, recompute COLUMN in a way
2234 that takes account of character widths. */
2235 if (BUFFERP (Vstandard_output))
2236 {
2237 tem = Fcurrent_column ();
2238 column = XINT (tem);
2239 }
2240
2241 first = 0;
2242 }
2243 }
2244
2245 UNGCPRO;
2246
2247 if (BUFFERP (Vstandard_output))
2248 set_buffer_internal (old);
2249
2250 if (!NILP (Vrun_hooks))
2251 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2252
2253 return Qnil;
2254 }
2255
2256 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
2257 0, 0, "",
2258 /* Display a list of possible completions of the current minibuffer contents. */
2259 ())
2260 {
2261 Lisp_Object completions;
2262
2263 message ("Making completion list...");
2264 completions = Fall_completions (Fminibuffer_contents (),
2265 Vminibuffer_completion_table,
2266 Vminibuffer_completion_predicate,
2267 Qt);
2268 clear_message (1, 0);
2269
2270 if (NILP (completions))
2271 {
2272 bitch_at_user ();
2273 temp_echo_area_glyphs (" [No completions]");
2274 }
2275 else
2276 internal_with_output_to_temp_buffer ("*Completions*",
2277 Fdisplay_completion_list,
2278 Fsort (completions, Qstring_lessp));
2279 return Qnil;
2280 }
2281 \f
2282 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
2283 /* Terminate minibuffer input. */
2284 ())
2285 {
2286 if (INTEGERP (last_command_char))
2287 internal_self_insert (XINT (last_command_char), 0);
2288 else
2289 bitch_at_user ();
2290
2291 return Fthrow (Qexit, Qnil);
2292 }
2293
2294 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
2295 /* Terminate this minibuffer argument. */
2296 ())
2297 {
2298 return Fthrow (Qexit, Qnil);
2299 }
2300
2301 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2302 /* Return current depth of activations of minibuffer, a nonnegative integer. */
2303 ())
2304 {
2305 return make_number (minibuf_level);
2306 }
2307
2308 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2309 /* Return the prompt string of the currently-active minibuffer.
2310 If no minibuffer is active, return nil. */
2311 ())
2312 {
2313 return Fcopy_sequence (minibuf_prompt);
2314 }
2315
2316 \f
2317 /* Temporarily display the string M at the end of the current
2318 minibuffer contents. This is used to display things like
2319 "[No Match]" when the user requests a completion for a prefix
2320 that has no possible completions, and other quick, unobtrusive
2321 messages. */
2322
2323 void
2324 temp_echo_area_glyphs (m)
2325 char *m;
2326 {
2327 int osize = ZV;
2328 int osize_byte = ZV_BYTE;
2329 int opoint = PT;
2330 int opoint_byte = PT_BYTE;
2331 Lisp_Object oinhibit;
2332 oinhibit = Vinhibit_quit;
2333
2334 /* Clear out any old echo-area message to make way for our new thing. */
2335 message (0);
2336
2337 SET_PT_BOTH (osize, osize_byte);
2338 insert_string (m);
2339 SET_PT_BOTH (opoint, opoint_byte);
2340 Vinhibit_quit = Qt;
2341 Fsit_for (make_number (2), Qnil, Qnil);
2342 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
2343 SET_PT_BOTH (opoint, opoint_byte);
2344 if (!NILP (Vquit_flag))
2345 {
2346 Vquit_flag = Qnil;
2347 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2348 }
2349 Vinhibit_quit = oinhibit;
2350 }
2351
2352 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2353 1, 1, 0,
2354 /* Temporarily display STRING at the end of the minibuffer.
2355 The text is displayed for two seconds,
2356 or until the next input event arrives, whichever comes first. */
2357 (string))
2358 Lisp_Object string;
2359 {
2360 temp_echo_area_glyphs (XSTRING (string)->data);
2361 return Qnil;
2362 }
2363 \f
2364 void
2365 init_minibuf_once ()
2366 {
2367 Vminibuffer_list = Qnil;
2368 staticpro (&Vminibuffer_list);
2369 }
2370
2371 void
2372 syms_of_minibuf ()
2373 {
2374 minibuf_level = 0;
2375 minibuf_prompt = Qnil;
2376 staticpro (&minibuf_prompt);
2377
2378 minibuf_save_list = Qnil;
2379 staticpro (&minibuf_save_list);
2380
2381 Qread_file_name_internal = intern ("read-file-name-internal");
2382 staticpro (&Qread_file_name_internal);
2383
2384 Qminibuffer_default = intern ("minibuffer-default");
2385 staticpro (&Qminibuffer_default);
2386 Fset (Qminibuffer_default, Qnil);
2387
2388 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2389 staticpro (&Qminibuffer_completion_table);
2390
2391 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2392 staticpro (&Qminibuffer_completion_confirm);
2393
2394 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2395 staticpro (&Qminibuffer_completion_predicate);
2396
2397 staticpro (&last_exact_completion);
2398 last_exact_completion = Qnil;
2399
2400 staticpro (&last_minibuf_string);
2401 last_minibuf_string = Qnil;
2402
2403 Quser_variable_p = intern ("user-variable-p");
2404 staticpro (&Quser_variable_p);
2405
2406 Qminibuffer_history = intern ("minibuffer-history");
2407 staticpro (&Qminibuffer_history);
2408
2409 Qbuffer_name_history = intern ("buffer-name-history");
2410 staticpro (&Qbuffer_name_history);
2411 Fset (Qbuffer_name_history, Qnil);
2412
2413 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2414 staticpro (&Qminibuffer_setup_hook);
2415
2416 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2417 staticpro (&Qminibuffer_exit_hook);
2418
2419 Qhistory_length = intern ("history-length");
2420 staticpro (&Qhistory_length);
2421
2422 Qcurrent_input_method = intern ("current-input-method");
2423 staticpro (&Qcurrent_input_method);
2424
2425 Qactivate_input_method = intern ("activate-input-method");
2426 staticpro (&Qactivate_input_method);
2427
2428 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function
2429 /* If this is non-nil, `read-buffer' does its work by calling this function. */);
2430 Vread_buffer_function = Qnil;
2431
2432 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
2433 /* Normal hook run just after entry to minibuffer. */);
2434 Vminibuffer_setup_hook = Qnil;
2435
2436 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
2437 /* Normal hook run just after exit from minibuffer. */);
2438 Vminibuffer_exit_hook = Qnil;
2439
2440 DEFVAR_LISP ("history-length", &Vhistory_length
2441 /* *Maximum length for history lists before truncation takes place.
2442 A number means that length; t means infinite. Truncation takes place
2443 just after a new element is inserted. Setting the history-length
2444 property of a history variable overrides this default. */);
2445 XSETFASTINT (Vhistory_length, 30);
2446
2447 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help
2448 /* *Non-nil means automatically provide help for invalid completion input. */);
2449 Vcompletion_auto_help = Qt;
2450
2451 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
2452 /* Non-nil means don't consider case significant in completion. */);
2453 completion_ignore_case = 0;
2454
2455 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
2456 /* *Non-nil means to allow minibuffer commands while in the minibuffer.
2457 This variable makes a difference whenever the minibuffer window is active. */);
2458 enable_recursive_minibuffers = 0;
2459
2460 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
2461 /* Alist or obarray used for completion in the minibuffer.
2462 This becomes the ALIST argument to `try-completion' and `all-completion'.
2463
2464 The value may alternatively be a function, which is given three arguments:
2465 STRING, the current buffer contents;
2466 PREDICATE, the predicate for filtering possible matches;
2467 CODE, which says what kind of things to do.
2468 CODE can be nil, t or `lambda'.
2469 nil means to return the best completion of STRING, or nil if there is none.
2470 t means to return a list of all possible completions of STRING.
2471 `lambda' means to return t if STRING is a valid completion as it stands. */);
2472 Vminibuffer_completion_table = Qnil;
2473
2474 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
2475 /* Within call to `completing-read', this holds the PREDICATE argument. */);
2476 Vminibuffer_completion_predicate = Qnil;
2477
2478 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
2479 /* Non-nil => demand confirmation of completion before exiting minibuffer. */);
2480 Vminibuffer_completion_confirm = Qnil;
2481
2482 DEFVAR_LISP ("minibuffer-completing-file-name",
2483 &Vminibuffer_completing_file_name
2484 /* Non-nil means completing file names. */);
2485 Vminibuffer_completing_file_name = Qnil;
2486
2487 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
2488 /* Value that `help-form' takes on inside the minibuffer. */);
2489 Vminibuffer_help_form = Qnil;
2490
2491 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
2492 /* History list symbol to add minibuffer values to.
2493 Each string of minibuffer input, as it appears on exit from the minibuffer,
2494 is added with
2495 (set minibuffer-history-variable
2496 (cons STRING (symbol-value minibuffer-history-variable))) */);
2497 XSETFASTINT (Vminibuffer_history_variable, 0);
2498
2499 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
2500 /* Current position of redoing in the history list. */);
2501 Vminibuffer_history_position = Qnil;
2502
2503 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
2504 /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
2505 Some uses of the echo area also raise that frame (since they use it too). */);
2506 minibuffer_auto_raise = 0;
2507
2508 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
2509 /* List of regexps that should restrict possible completions. */);
2510 Vcompletion_regexp_list = Qnil;
2511
2512 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2513 &minibuffer_allow_text_properties
2514 /* Non-nil means `read-from-minibuffer' should not discard text properties.
2515 This also affects `read-string', but it does not affect `read-minibuffer',
2516 `read-no-blanks-input', or any of the functions that do minibuffer input
2517 with completion; they always discard text properties. */);
2518 minibuffer_allow_text_properties = 0;
2519
2520 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties
2521 /* Text properties that are added to minibuffer prompts.
2522 These are in addition to the basic `field' property, and stickiness
2523 properties. */);
2524 /* We use `intern' here instead of Qread_only to avoid
2525 initialization-order problems. */
2526 Vminibuffer_prompt_properties
2527 = Fcons (intern ("read-only"), Fcons (Qt, Qnil));
2528
2529 defsubr (&Sset_minibuffer_window);
2530 defsubr (&Sread_from_minibuffer);
2531 defsubr (&Seval_minibuffer);
2532 defsubr (&Sread_minibuffer);
2533 defsubr (&Sread_string);
2534 defsubr (&Sread_command);
2535 defsubr (&Sread_variable);
2536 defsubr (&Sread_buffer);
2537 defsubr (&Sread_no_blanks_input);
2538 defsubr (&Sminibuffer_depth);
2539 defsubr (&Sminibuffer_prompt);
2540
2541 defsubr (&Sminibuffer_prompt_end);
2542 defsubr (&Sminibuffer_contents);
2543 defsubr (&Sminibuffer_contents_no_properties);
2544 defsubr (&Sdelete_minibuffer_contents);
2545
2546 defsubr (&Stry_completion);
2547 defsubr (&Sall_completions);
2548 defsubr (&Scompleting_read);
2549 defsubr (&Sminibuffer_complete);
2550 defsubr (&Sminibuffer_complete_word);
2551 defsubr (&Sminibuffer_complete_and_exit);
2552 defsubr (&Sdisplay_completion_list);
2553 defsubr (&Sminibuffer_completion_help);
2554
2555 defsubr (&Sself_insert_and_exit);
2556 defsubr (&Sexit_minibuffer);
2557
2558 defsubr (&Sminibuffer_message);
2559 }
2560
2561 void
2562 keys_of_minibuf ()
2563 {
2564 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2565 "abort-recursive-edit");
2566 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2567 "exit-minibuffer");
2568 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2569 "exit-minibuffer");
2570
2571 initial_define_key (Vminibuffer_local_ns_map, ' ',
2572 "exit-minibuffer");
2573 initial_define_key (Vminibuffer_local_ns_map, '\t',
2574 "exit-minibuffer");
2575 initial_define_key (Vminibuffer_local_ns_map, '?',
2576 "self-insert-and-exit");
2577
2578 initial_define_key (Vminibuffer_local_completion_map, '\t',
2579 "minibuffer-complete");
2580 initial_define_key (Vminibuffer_local_completion_map, ' ',
2581 "minibuffer-complete-word");
2582 initial_define_key (Vminibuffer_local_completion_map, '?',
2583 "minibuffer-completion-help");
2584
2585 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2586 "minibuffer-complete-and-exit");
2587 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2588 "minibuffer-complete-and-exit");
2589 }