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