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