Use Frun_hooks rather than calling Vrun_hooks manually
[bpt/emacs.git] / src / minibuf.c
1 /* Minibuffer input and completion.
2
3 Copyright (C) 1985-1986, 1993-2011 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 3 of the License, or
10 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
19
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <setjmp.h>
24
25 #include "lisp.h"
26 #include "commands.h"
27 #include "buffer.h"
28 #include "character.h"
29 #include "dispextern.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "syntax.h"
34 #include "intervals.h"
35 #include "keymap.h"
36 #include "termhooks.h"
37
38 /* List of buffers for use as minibuffers.
39 The first element of the list is used for the outermost minibuffer
40 invocation, the next element is used for a recursive minibuffer
41 invocation, etc. The list is extended at the end as deeper
42 minibuffer recursions are encountered. */
43
44 Lisp_Object Vminibuffer_list;
45
46 /* Data to remember during recursive minibuffer invocations */
47
48 Lisp_Object minibuf_save_list;
49
50 /* Depth in minibuffer invocations. */
51
52 int minibuf_level;
53
54 /* The maximum length of a minibuffer history. */
55
56 Lisp_Object Qhistory_length;
57
58 /* Fread_minibuffer leaves the input here as a string. */
59
60 Lisp_Object last_minibuf_string;
61
62 Lisp_Object Qminibuffer_history, Qbuffer_name_history;
63
64 Lisp_Object Qread_file_name_internal;
65
66 /* Normal hooks for entry to and exit from minibuffer. */
67
68 Lisp_Object Qminibuffer_setup_hook;
69 Lisp_Object Qminibuffer_exit_hook;
70
71 Lisp_Object Qcompletion_ignore_case;
72 Lisp_Object Qminibuffer_completion_table;
73 Lisp_Object Qminibuffer_completion_predicate;
74 Lisp_Object Qminibuffer_completion_confirm;
75 Lisp_Object Qcompleting_read_default;
76 Lisp_Object Quser_variable_p;
77
78 Lisp_Object Qminibuffer_default;
79
80 Lisp_Object Qcurrent_input_method, Qactivate_input_method;
81
82 Lisp_Object Qcase_fold_search;
83
84 Lisp_Object Qread_expression_history;
85
86 /* Prompt to display in front of the mini-buffer contents. */
87
88 static Lisp_Object minibuf_prompt;
89
90 /* Width of current mini-buffer prompt. Only set after display_line
91 of the line that contains the prompt. */
92
93 static EMACS_INT minibuf_prompt_width;
94
95 \f
96 /* Put minibuf on currently selected frame's minibuffer.
97 We do this whenever the user starts a new minibuffer
98 or when a minibuffer exits. */
99
100 void
101 choose_minibuf_frame (void)
102 {
103 if (FRAMEP (selected_frame)
104 && FRAME_LIVE_P (XFRAME (selected_frame))
105 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
106 {
107 struct frame *sf = XFRAME (selected_frame);
108 Lisp_Object buffer;
109
110 /* I don't think that any frames may validly have a null minibuffer
111 window anymore. */
112 if (NILP (sf->minibuffer_window))
113 abort ();
114
115 /* Under X, we come here with minibuf_window being the
116 minibuffer window of the unused termcap window created in
117 init_window_once. That window doesn't have a buffer. */
118 buffer = XWINDOW (minibuf_window)->buffer;
119 if (BUFFERP (buffer))
120 Fset_window_buffer (sf->minibuffer_window, buffer, Qnil);
121 minibuf_window = sf->minibuffer_window;
122 }
123
124 /* Make sure no other frame has a minibuffer as its selected window,
125 because the text would not be displayed in it, and that would be
126 confusing. Only allow the selected frame to do this,
127 and that only if the minibuffer is active. */
128 {
129 Lisp_Object tail, frame;
130
131 FOR_EACH_FRAME (tail, frame)
132 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
133 && !(EQ (frame, selected_frame)
134 && minibuf_level > 0))
135 Fset_frame_selected_window (frame, Fframe_first_window (frame), Qnil);
136 }
137 }
138
139 static Lisp_Object
140 choose_minibuf_frame_1 (Lisp_Object ignore)
141 {
142 choose_minibuf_frame ();
143 return Qnil;
144 }
145
146 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
147 Sset_minibuffer_window, 1, 1, 0,
148 doc: /* Specify which minibuffer window to use for the minibuffer.
149 This affects where the minibuffer is displayed if you put text in it
150 without invoking the usual minibuffer commands. */)
151 (Lisp_Object window)
152 {
153 CHECK_WINDOW (window);
154 if (! MINI_WINDOW_P (XWINDOW (window)))
155 error ("Window is not a minibuffer window");
156
157 minibuf_window = window;
158
159 return window;
160 }
161
162 \f
163 /* Actual minibuffer invocation. */
164
165 static Lisp_Object read_minibuf_unwind (Lisp_Object);
166 static Lisp_Object run_exit_minibuf_hook (Lisp_Object);
167 static Lisp_Object read_minibuf (Lisp_Object, Lisp_Object,
168 Lisp_Object, Lisp_Object,
169 int, Lisp_Object,
170 Lisp_Object, Lisp_Object,
171 int, int);
172 static Lisp_Object read_minibuf_noninteractive (Lisp_Object, Lisp_Object,
173 Lisp_Object, Lisp_Object,
174 int, Lisp_Object,
175 Lisp_Object, Lisp_Object,
176 int, int);
177 static Lisp_Object string_to_object (Lisp_Object, Lisp_Object);
178
179
180 /* Read a Lisp object from VAL and return it. If VAL is an empty
181 string, and DEFALT is a string, read from DEFALT instead of VAL. */
182
183 static Lisp_Object
184 string_to_object (Lisp_Object val, Lisp_Object defalt)
185 {
186 struct gcpro gcpro1, gcpro2;
187 Lisp_Object expr_and_pos;
188 EMACS_INT pos;
189
190 GCPRO2 (val, defalt);
191
192 if (STRINGP (val) && SCHARS (val) == 0)
193 {
194 if (STRINGP (defalt))
195 val = defalt;
196 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
197 val = XCAR (defalt);
198 }
199
200 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
201 pos = XINT (Fcdr (expr_and_pos));
202 if (pos != SCHARS (val))
203 {
204 /* Ignore trailing whitespace; any other trailing junk
205 is an error. */
206 EMACS_INT i;
207 pos = string_char_to_byte (val, pos);
208 for (i = pos; i < SBYTES (val); i++)
209 {
210 int c = SREF (val, i);
211 if (c != ' ' && c != '\t' && c != '\n')
212 error ("Trailing garbage following expression");
213 }
214 }
215
216 val = Fcar (expr_and_pos);
217 RETURN_UNGCPRO (val);
218 }
219
220
221 /* Like read_minibuf but reading from stdin. This function is called
222 from read_minibuf to do the job if noninteractive. */
223
224 static Lisp_Object
225 read_minibuf_noninteractive (Lisp_Object map, Lisp_Object initial,
226 Lisp_Object prompt, Lisp_Object backup_n,
227 int expflag,
228 Lisp_Object histvar, Lisp_Object histpos,
229 Lisp_Object defalt,
230 int allow_props, int inherit_input_method)
231 {
232 int size, len;
233 char *line, *s;
234 Lisp_Object val;
235
236 fprintf (stdout, "%s", SDATA (prompt));
237 fflush (stdout);
238
239 val = Qnil;
240 size = 100;
241 len = 0;
242 line = (char *) xmalloc (size * sizeof *line);
243 while ((s = fgets (line + len, size - len, stdin)) != NULL
244 && (len = strlen (line),
245 len == size - 1 && line[len - 1] != '\n'))
246 {
247 size *= 2;
248 line = (char *) xrealloc (line, size);
249 }
250
251 if (s)
252 {
253 len = strlen (line);
254
255 if (len > 0 && line[len - 1] == '\n')
256 line[--len] = '\0';
257
258 val = build_string (line);
259 xfree (line);
260 }
261 else
262 {
263 xfree (line);
264 error ("Error reading from stdin");
265 }
266
267 /* If Lisp form desired instead of string, parse it. */
268 if (expflag)
269 val = string_to_object (val, CONSP (defalt) ? XCAR (defalt) : defalt);
270
271 return val;
272 }
273 \f
274 DEFUN ("minibufferp", Fminibufferp,
275 Sminibufferp, 0, 1, 0,
276 doc: /* Return t if BUFFER is a minibuffer.
277 No argument or nil as argument means use current buffer as BUFFER.
278 BUFFER can be a buffer or a buffer name. */)
279 (Lisp_Object buffer)
280 {
281 Lisp_Object tem;
282
283 if (NILP (buffer))
284 buffer = Fcurrent_buffer ();
285 else if (STRINGP (buffer))
286 buffer = Fget_buffer (buffer);
287 else
288 CHECK_BUFFER (buffer);
289
290 tem = Fmemq (buffer, Vminibuffer_list);
291 return ! NILP (tem) ? Qt : Qnil;
292 }
293
294 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
295 Sminibuffer_prompt_end, 0, 0, 0,
296 doc: /* Return the buffer position of the end of the minibuffer prompt.
297 Return (point-min) if current buffer is not a minibuffer. */)
298 (void)
299 {
300 /* This function is written to be most efficient when there's a prompt. */
301 Lisp_Object beg, end, tem;
302 beg = make_number (BEGV);
303
304 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
305 if (NILP (tem))
306 return beg;
307
308 end = Ffield_end (beg, Qnil, Qnil);
309
310 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
311 return beg;
312 else
313 return end;
314 }
315
316 DEFUN ("minibuffer-contents", Fminibuffer_contents,
317 Sminibuffer_contents, 0, 0, 0,
318 doc: /* Return the user input in a minibuffer as a string.
319 If the current buffer is not a minibuffer, return its entire contents. */)
320 (void)
321 {
322 EMACS_INT prompt_end = XINT (Fminibuffer_prompt_end ());
323 return make_buffer_string (prompt_end, ZV, 1);
324 }
325
326 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
327 Sminibuffer_contents_no_properties, 0, 0, 0,
328 doc: /* Return the user input in a minibuffer as a string, without text-properties.
329 If the current buffer is not a minibuffer, return its entire contents. */)
330 (void)
331 {
332 EMACS_INT prompt_end = XINT (Fminibuffer_prompt_end ());
333 return make_buffer_string (prompt_end, ZV, 0);
334 }
335
336 DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
337 Sminibuffer_completion_contents, 0, 0, 0,
338 doc: /* Return the user input in a minibuffer before point as a string.
339 That is what completion commands operate on.
340 If the current buffer is not a minibuffer, return its entire contents. */)
341 (void)
342 {
343 EMACS_INT prompt_end = XINT (Fminibuffer_prompt_end ());
344 if (PT < prompt_end)
345 error ("Cannot do completion in the prompt");
346 return make_buffer_string (prompt_end, PT, 1);
347 }
348
349 \f
350 /* Read from the minibuffer using keymap MAP and initial contents INITIAL,
351 putting point minus BACKUP_N bytes from the end of INITIAL,
352 prompting with PROMPT (a string), using history list HISTVAR
353 with initial position HISTPOS. INITIAL should be a string or a
354 cons of a string and an integer. BACKUP_N should be <= 0, or
355 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
356 ignored and replaced with an integer that puts point at one-indexed
357 position N in INITIAL, where N is the CDR of INITIAL, or at the
358 beginning of INITIAL if N <= 0.
359
360 Normally return the result as a string (the text that was read),
361 but if EXPFLAG is nonzero, read it and return the object read.
362 If HISTVAR is given, save the value read on that history only if it doesn't
363 match the front of that history list exactly. The value is pushed onto
364 the list as the string that was read.
365
366 DEFALT specifies the default value for the sake of history commands.
367
368 If ALLOW_PROPS is nonzero, we do not throw away text properties.
369
370 if INHERIT_INPUT_METHOD is nonzero, the minibuffer inherits the
371 current input method. */
372
373 static Lisp_Object
374 read_minibuf (Lisp_Object map, Lisp_Object initial, Lisp_Object prompt,
375 Lisp_Object backup_n, int expflag,
376 Lisp_Object histvar, Lisp_Object histpos, Lisp_Object defalt,
377 int allow_props, int inherit_input_method)
378 {
379 Lisp_Object val;
380 int count = SPECPDL_INDEX ();
381 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
382 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
383 Lisp_Object enable_multibyte;
384 int pos = INTEGERP (backup_n) ? XINT (backup_n) : 0;
385 /* String to add to the history. */
386 Lisp_Object histstring;
387
388 Lisp_Object empty_minibuf;
389 Lisp_Object dummy, frame;
390
391 specbind (Qminibuffer_default, defalt);
392
393 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
394 in previous recursive minibuffer, but was not set explicitly
395 to t for this invocation, so set it to nil in this minibuffer.
396 Save the old value now, before we change it. */
397 specbind (intern ("minibuffer-completing-file-name"), Vminibuffer_completing_file_name);
398 if (EQ (Vminibuffer_completing_file_name, Qlambda))
399 Vminibuffer_completing_file_name = Qnil;
400
401 #ifdef HAVE_WINDOW_SYSTEM
402 if (display_hourglass_p)
403 cancel_hourglass ();
404 #endif
405
406 if (!NILP (initial))
407 {
408 if (CONSP (initial))
409 {
410 backup_n = Fcdr (initial);
411 initial = Fcar (initial);
412 CHECK_STRING (initial);
413 if (!NILP (backup_n))
414 {
415 CHECK_NUMBER (backup_n);
416 /* Convert to distance from end of input. */
417 if (XINT (backup_n) < 1)
418 /* A number too small means the beginning of the string. */
419 pos = - SCHARS (initial);
420 else
421 pos = XINT (backup_n) - 1 - SCHARS (initial);
422 }
423 }
424 else
425 CHECK_STRING (initial);
426 }
427 val = Qnil;
428 ambient_dir = BVAR (current_buffer, directory);
429 input_method = Qnil;
430 enable_multibyte = Qnil;
431
432 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
433 store them away before we can GC. Don't need to protect
434 BACKUP_N because we use the value only if it is an integer. */
435 GCPRO5 (map, initial, val, ambient_dir, input_method);
436
437 if (!STRINGP (prompt))
438 prompt = empty_unibyte_string;
439
440 if (!enable_recursive_minibuffers
441 && minibuf_level > 0)
442 {
443 if (EQ (selected_window, minibuf_window))
444 error ("Command attempted to use minibuffer while in minibuffer");
445 else
446 /* If we're in another window, cancel the minibuffer that's active. */
447 Fthrow (Qexit,
448 build_string ("Command attempted to use minibuffer while in minibuffer"));
449 }
450
451 if ((noninteractive
452 /* In case we are running as a daemon, only do this before
453 detaching from the terminal. */
454 || (IS_DAEMON && (daemon_pipe[1] >= 0)))
455 && NILP (Vexecuting_kbd_macro))
456 {
457 val = read_minibuf_noninteractive (map, initial, prompt,
458 make_number (pos),
459 expflag, histvar, histpos, defalt,
460 allow_props, inherit_input_method);
461 UNGCPRO;
462 return unbind_to (count, val);
463 }
464
465 /* Choose the minibuffer window and frame, and take action on them. */
466
467 choose_minibuf_frame ();
468
469 record_unwind_protect (choose_minibuf_frame_1, Qnil);
470
471 record_unwind_protect (Fset_window_configuration,
472 Fcurrent_window_configuration (Qnil));
473
474 /* If the minibuffer window is on a different frame, save that
475 frame's configuration too. */
476 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
477 if (!EQ (mini_frame, selected_frame))
478 record_unwind_protect (Fset_window_configuration,
479 Fcurrent_window_configuration (mini_frame));
480
481 /* If the minibuffer is on an iconified or invisible frame,
482 make it visible now. */
483 Fmake_frame_visible (mini_frame);
484
485 if (minibuffer_auto_raise)
486 Fraise_frame (mini_frame);
487
488 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
489
490 /* We have to do this after saving the window configuration
491 since that is what restores the current buffer. */
492
493 /* Arrange to restore a number of minibuffer-related variables.
494 We could bind each variable separately, but that would use lots of
495 specpdl slots. */
496 minibuf_save_list
497 = Fcons (Voverriding_local_map,
498 Fcons (minibuf_window,
499 minibuf_save_list));
500 minibuf_save_list
501 = Fcons (minibuf_prompt,
502 Fcons (make_number (minibuf_prompt_width),
503 Fcons (Vhelp_form,
504 Fcons (Vcurrent_prefix_arg,
505 Fcons (Vminibuffer_history_position,
506 Fcons (Vminibuffer_history_variable,
507 minibuf_save_list))))));
508
509 record_unwind_protect (read_minibuf_unwind, Qnil);
510 minibuf_level++;
511 /* We are exiting the minibuffer one way or the other, so run the hook.
512 It should be run before unwinding the minibuf settings. Do it
513 separately from read_minibuf_unwind because we need to make sure that
514 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
515 signals an error. --Stef */
516 record_unwind_protect (run_exit_minibuf_hook, Qnil);
517
518 /* Now that we can restore all those variables, start changing them. */
519
520 minibuf_prompt_width = 0;
521 minibuf_prompt = Fcopy_sequence (prompt);
522 Vminibuffer_history_position = histpos;
523 Vminibuffer_history_variable = histvar;
524 Vhelp_form = Vminibuffer_help_form;
525 /* If this minibuffer is reading a file name, that doesn't mean
526 recursive ones are. But we cannot set it to nil, because
527 completion code still need to know the minibuffer is completing a
528 file name. So use `lambda' as intermediate value meaning
529 "t" in this minibuffer, but "nil" in next minibuffer. */
530 if (!NILP (Vminibuffer_completing_file_name))
531 Vminibuffer_completing_file_name = Qlambda;
532
533 if (inherit_input_method)
534 {
535 /* `current-input-method' is buffer local. So, remember it in
536 INPUT_METHOD before changing the current buffer. */
537 input_method = Fsymbol_value (Qcurrent_input_method);
538 enable_multibyte = BVAR (current_buffer, enable_multibyte_characters);
539 }
540
541 /* Switch to the minibuffer. */
542
543 minibuffer = get_minibuffer (minibuf_level);
544 Fset_buffer (minibuffer);
545
546 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
547 if (inherit_input_method)
548 BVAR (current_buffer, enable_multibyte_characters) = enable_multibyte;
549
550 /* The current buffer's default directory is usually the right thing
551 for our minibuffer here. However, if you're typing a command at
552 a minibuffer-only frame when minibuf_level is zero, then buf IS
553 the current_buffer, so reset_buffer leaves buf's default
554 directory unchanged. This is a bummer when you've just started
555 up Emacs and buf's default directory is Qnil. Here's a hack; can
556 you think of something better to do? Find another buffer with a
557 better directory, and use that one instead. */
558 if (STRINGP (ambient_dir))
559 BVAR (current_buffer, directory) = ambient_dir;
560 else
561 {
562 Lisp_Object buf_list;
563
564 for (buf_list = Vbuffer_alist;
565 CONSP (buf_list);
566 buf_list = XCDR (buf_list))
567 {
568 Lisp_Object other_buf;
569
570 other_buf = XCDR (XCAR (buf_list));
571 if (STRINGP (BVAR (XBUFFER (other_buf), directory)))
572 {
573 BVAR (current_buffer, directory) = BVAR (XBUFFER (other_buf), directory);
574 break;
575 }
576 }
577 }
578
579 if (!EQ (mini_frame, selected_frame))
580 Fredirect_frame_focus (selected_frame, mini_frame);
581
582 Vminibuf_scroll_window = selected_window;
583 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
584 minibuf_selected_window = selected_window;
585
586 /* Empty out the minibuffers of all frames other than the one
587 where we are going to display one now.
588 Set them to point to ` *Minibuf-0*', which is always empty. */
589 empty_minibuf = Fget_buffer (build_string (" *Minibuf-0*"));
590
591 FOR_EACH_FRAME (dummy, frame)
592 {
593 Lisp_Object root_window = Fframe_root_window (frame);
594 Lisp_Object mini_window = XWINDOW (root_window)->next;
595
596 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
597 && !NILP (Fwindow_minibuffer_p (mini_window)))
598 Fset_window_buffer (mini_window, empty_minibuf, Qnil);
599 }
600
601 /* Display this minibuffer in the proper window. */
602 Fset_window_buffer (minibuf_window, Fcurrent_buffer (), Qnil);
603 Fselect_window (minibuf_window, Qnil);
604 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
605
606 Fmake_local_variable (Qprint_escape_newlines);
607 print_escape_newlines = 1;
608
609 /* Erase the buffer. */
610 {
611 int count1 = SPECPDL_INDEX ();
612 specbind (Qinhibit_read_only, Qt);
613 specbind (Qinhibit_modification_hooks, Qt);
614 Ferase_buffer ();
615
616 if (!NILP (BVAR (current_buffer, enable_multibyte_characters))
617 && ! STRING_MULTIBYTE (minibuf_prompt))
618 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
619
620 /* Insert the prompt, record where it ends. */
621 Finsert (1, &minibuf_prompt);
622 if (PT > BEG)
623 {
624 Fput_text_property (make_number (BEG), make_number (PT),
625 Qfront_sticky, Qt, Qnil);
626 Fput_text_property (make_number (BEG), make_number (PT),
627 Qrear_nonsticky, Qt, Qnil);
628 Fput_text_property (make_number (BEG), make_number (PT),
629 Qfield, Qt, Qnil);
630 Fadd_text_properties (make_number (BEG), make_number (PT),
631 Vminibuffer_prompt_properties, Qnil);
632 }
633 unbind_to (count1, Qnil);
634 }
635
636 minibuf_prompt_width = current_column ();
637
638 /* Put in the initial input. */
639 if (!NILP (initial))
640 {
641 Finsert (1, &initial);
642 Fforward_char (make_number (pos));
643 }
644
645 clear_message (1, 1);
646 BVAR (current_buffer, keymap) = map;
647
648 /* Turn on an input method stored in INPUT_METHOD if any. */
649 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
650 call1 (Qactivate_input_method, input_method);
651
652 Frun_hooks (1, &Qminibuffer_setup_hook);
653
654 /* Don't allow the user to undo past this point. */
655 BVAR (current_buffer, undo_list) = Qnil;
656
657 recursive_edit_1 ();
658
659 /* If cursor is on the minibuffer line,
660 show the user we have exited by putting it in column 0. */
661 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
662 && !noninteractive)
663 {
664 XWINDOW (minibuf_window)->cursor.hpos = 0;
665 XWINDOW (minibuf_window)->cursor.x = 0;
666 XWINDOW (minibuf_window)->must_be_updated_p = 1;
667 update_frame (XFRAME (selected_frame), 1, 1);
668 {
669 struct frame *f = XFRAME (XWINDOW (minibuf_window)->frame);
670 struct redisplay_interface *rif = FRAME_RIF (f);
671 if (rif && rif->flush_display)
672 rif->flush_display (f);
673 }
674 }
675
676 /* Make minibuffer contents into a string. */
677 Fset_buffer (minibuffer);
678 if (allow_props)
679 val = Fminibuffer_contents ();
680 else
681 val = Fminibuffer_contents_no_properties ();
682
683 /* VAL is the string of minibuffer text. */
684
685 last_minibuf_string = val;
686
687 /* Choose the string to add to the history. */
688 if (SCHARS (val) != 0)
689 histstring = val;
690 else if (STRINGP (defalt))
691 histstring = defalt;
692 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
693 histstring = XCAR (defalt);
694 else
695 histstring = Qnil;
696
697 /* Add the value to the appropriate history list, if any. */
698 if (!NILP (Vhistory_add_new_input)
699 && SYMBOLP (Vminibuffer_history_variable)
700 && !NILP (histstring))
701 {
702 /* If the caller wanted to save the value read on a history list,
703 then do so if the value is not already the front of the list. */
704 Lisp_Object histval;
705
706 /* If variable is unbound, make it nil. */
707
708 histval = find_symbol_value (Vminibuffer_history_variable);
709 if (EQ (histval, Qunbound))
710 Fset (Vminibuffer_history_variable, Qnil);
711
712 /* The value of the history variable must be a cons or nil. Other
713 values are unacceptable. We silently ignore these values. */
714
715 if (NILP (histval)
716 || (CONSP (histval)
717 /* Don't duplicate the most recent entry in the history. */
718 && (NILP (Fequal (histstring, Fcar (histval))))))
719 {
720 Lisp_Object length;
721
722 if (history_delete_duplicates) Fdelete (histstring, histval);
723 histval = Fcons (histstring, histval);
724 Fset (Vminibuffer_history_variable, histval);
725
726 /* Truncate if requested. */
727 length = Fget (Vminibuffer_history_variable, Qhistory_length);
728 if (NILP (length)) length = Vhistory_length;
729 if (INTEGERP (length))
730 {
731 if (XINT (length) <= 0)
732 Fset (Vminibuffer_history_variable, Qnil);
733 else
734 {
735 Lisp_Object temp;
736
737 temp = Fnthcdr (Fsub1 (length), histval);
738 if (CONSP (temp)) Fsetcdr (temp, Qnil);
739 }
740 }
741 }
742 }
743
744 /* If Lisp form desired instead of string, parse it. */
745 if (expflag)
746 val = string_to_object (val, defalt);
747
748 /* The appropriate frame will get selected
749 in set-window-configuration. */
750 UNGCPRO;
751 return unbind_to (count, val);
752 }
753
754 /* Return a buffer to be used as the minibuffer at depth `depth'.
755 depth = 0 is the lowest allowed argument, and that is the value
756 used for nonrecursive minibuffer invocations */
757
758 Lisp_Object
759 get_minibuffer (int depth)
760 {
761 Lisp_Object tail, num, buf;
762 char name[24];
763
764 XSETFASTINT (num, depth);
765 tail = Fnthcdr (num, Vminibuffer_list);
766 if (NILP (tail))
767 {
768 tail = Fcons (Qnil, Qnil);
769 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
770 }
771 buf = Fcar (tail);
772 if (NILP (buf) || NILP (BVAR (XBUFFER (buf), name)))
773 {
774 sprintf (name, " *Minibuf-%d*", depth);
775 buf = Fget_buffer_create (build_string (name));
776
777 /* Although the buffer's name starts with a space, undo should be
778 enabled in it. */
779 Fbuffer_enable_undo (buf);
780
781 XSETCAR (tail, buf);
782 }
783 else
784 {
785 int count = SPECPDL_INDEX ();
786 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
787 have to empty the list, otherwise we end up with overlays that
788 think they belong to this buffer while the buffer doesn't know about
789 them any more. */
790 delete_all_overlays (XBUFFER (buf));
791 reset_buffer (XBUFFER (buf));
792 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
793 Fset_buffer (buf);
794 Fkill_all_local_variables ();
795 unbind_to (count, Qnil);
796 }
797
798 return buf;
799 }
800
801 static Lisp_Object
802 run_exit_minibuf_hook (Lisp_Object data)
803 {
804 safe_run_hooks (Qminibuffer_exit_hook);
805 return Qnil;
806 }
807
808 /* This function is called on exiting minibuffer, whether normally or
809 not, and it restores the current window, buffer, etc. */
810
811 static Lisp_Object
812 read_minibuf_unwind (Lisp_Object data)
813 {
814 Lisp_Object old_deactivate_mark;
815 Lisp_Object window;
816
817 /* If this was a recursive minibuffer,
818 tie the minibuffer window back to the outer level minibuffer buffer. */
819 minibuf_level--;
820
821 window = minibuf_window;
822 /* To keep things predictable, in case it matters, let's be in the
823 minibuffer when we reset the relevant variables. */
824 Fset_buffer (XWINDOW (window)->buffer);
825
826 /* Restore prompt, etc, from outer minibuffer level. */
827 minibuf_prompt = Fcar (minibuf_save_list);
828 minibuf_save_list = Fcdr (minibuf_save_list);
829 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
830 minibuf_save_list = Fcdr (minibuf_save_list);
831 Vhelp_form = Fcar (minibuf_save_list);
832 minibuf_save_list = Fcdr (minibuf_save_list);
833 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
834 minibuf_save_list = Fcdr (minibuf_save_list);
835 Vminibuffer_history_position = Fcar (minibuf_save_list);
836 minibuf_save_list = Fcdr (minibuf_save_list);
837 Vminibuffer_history_variable = Fcar (minibuf_save_list);
838 minibuf_save_list = Fcdr (minibuf_save_list);
839 Voverriding_local_map = Fcar (minibuf_save_list);
840 minibuf_save_list = Fcdr (minibuf_save_list);
841 #if 0
842 temp = Fcar (minibuf_save_list);
843 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
844 minibuf_window = temp;
845 #endif
846 minibuf_save_list = Fcdr (minibuf_save_list);
847
848 /* Erase the minibuffer we were using at this level. */
849 {
850 int count = SPECPDL_INDEX ();
851 /* Prevent error in erase-buffer. */
852 specbind (Qinhibit_read_only, Qt);
853 specbind (Qinhibit_modification_hooks, Qt);
854 old_deactivate_mark = Vdeactivate_mark;
855 Ferase_buffer ();
856 Vdeactivate_mark = old_deactivate_mark;
857 unbind_to (count, Qnil);
858 }
859
860 /* When we get to the outmost level, make sure we resize the
861 mini-window back to its normal size. */
862 if (minibuf_level == 0)
863 resize_mini_window (XWINDOW (window), 0);
864
865 /* Make sure minibuffer window is erased, not ignored. */
866 windows_or_buffers_changed++;
867 XSETFASTINT (XWINDOW (window)->last_modified, 0);
868 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
869 return Qnil;
870 }
871 \f
872
873 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
874 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
875 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
876 DEFAULT-VALUE. It normally should be nil in new code, except when
877 HIST is a cons. It is discussed in more detail below.
878 Third arg KEYMAP is a keymap to use whilst reading;
879 if omitted or nil, the default is `minibuffer-local-map'.
880 If fourth arg READ is non-nil, then interpret the result as a Lisp object
881 and return that object:
882 in other words, do `(car (read-from-string INPUT-STRING))'
883 Fifth arg HIST, if non-nil, specifies a history list and optionally
884 the initial position in the list. It can be a symbol, which is the
885 history list variable to use, or it can be a cons cell
886 (HISTVAR . HISTPOS). In that case, HISTVAR is the history list variable
887 to use, and HISTPOS is the initial position for use by the minibuffer
888 history commands. For consistency, you should also specify that
889 element of the history as the value of INITIAL-CONTENTS. Positions
890 are counted starting from 1 at the beginning of the list.
891 Sixth arg DEFAULT-VALUE is the default value or the list of default values.
892 If non-nil, it is available for history commands, and as the value
893 (or the first element of the list of default values) to return
894 if the user enters the empty string. But, unless READ is non-nil,
895 `read-from-minibuffer' does NOT return DEFAULT-VALUE if the user enters
896 empty input! It returns the empty string.
897 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
898 the current input method and the setting of `enable-multibyte-characters'.
899 If the variable `minibuffer-allow-text-properties' is non-nil,
900 then the string which is returned includes whatever text properties
901 were present in the minibuffer. Otherwise the value has no text properties.
902
903 The remainder of this documentation string describes the
904 INITIAL-CONTENTS argument in more detail. It is only relevant when
905 studying existing code, or when HIST is a cons. If non-nil,
906 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
907 reading input. Normally, point is put at the end of that string.
908 However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
909 input is STRING, but point is placed at _one-indexed_ position
910 POSITION in the minibuffer. Any integer value less than or equal to
911 one puts point at the beginning of the string. *Note* that this
912 behavior differs from the way such arguments are used in `completing-read'
913 and some related functions, which use zero-indexing for POSITION. */)
914 (Lisp_Object prompt, Lisp_Object initial_contents, Lisp_Object keymap, Lisp_Object read, Lisp_Object hist, Lisp_Object default_value, Lisp_Object inherit_input_method)
915 {
916 Lisp_Object histvar, histpos, val;
917 struct gcpro gcpro1;
918
919 CHECK_STRING (prompt);
920 if (NILP (keymap))
921 keymap = Vminibuffer_local_map;
922 else
923 keymap = get_keymap (keymap, 1, 0);
924
925 if (SYMBOLP (hist))
926 {
927 histvar = hist;
928 histpos = Qnil;
929 }
930 else
931 {
932 histvar = Fcar_safe (hist);
933 histpos = Fcdr_safe (hist);
934 }
935 if (NILP (histvar))
936 histvar = Qminibuffer_history;
937 if (NILP (histpos))
938 XSETFASTINT (histpos, 0);
939
940 GCPRO1 (default_value);
941 val = read_minibuf (keymap, initial_contents, prompt,
942 Qnil, !NILP (read),
943 histvar, histpos, default_value,
944 minibuffer_allow_text_properties,
945 !NILP (inherit_input_method));
946 UNGCPRO;
947 return val;
948 }
949
950 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
951 doc: /* Return a Lisp object read using the minibuffer, unevaluated.
952 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
953 is a string to insert in the minibuffer before reading.
954 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
955 Such arguments are used as in `read-from-minibuffer'.) */)
956 (Lisp_Object prompt, Lisp_Object initial_contents)
957 {
958 CHECK_STRING (prompt);
959 return read_minibuf (Vminibuffer_local_map, initial_contents,
960 prompt, Qnil, 1, Qminibuffer_history,
961 make_number (0), Qnil, 0, 0);
962 }
963
964 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
965 doc: /* Return value of Lisp expression read using the minibuffer.
966 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
967 is a string to insert in the minibuffer before reading.
968 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
969 Such arguments are used as in `read-from-minibuffer'.) */)
970 (Lisp_Object prompt, Lisp_Object initial_contents)
971 {
972 return Feval (read_minibuf (Vread_expression_map, initial_contents,
973 prompt, Qnil, 1, Qread_expression_history,
974 make_number (0), Qnil, 0, 0));
975 }
976
977 /* Functions that use the minibuffer to read various things. */
978
979 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
980 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
981 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
982 This argument has been superseded by DEFAULT-VALUE and should normally
983 be nil in new code. It behaves as in `read-from-minibuffer'. See the
984 documentation string of that function for details.
985 The third arg HISTORY, if non-nil, specifies a history list
986 and optionally the initial position in the list.
987 See `read-from-minibuffer' for details of HISTORY argument.
988 Fourth arg DEFAULT-VALUE is the default value or the list of default values.
989 If non-nil, it is used for history commands, and as the value (or the first
990 element of the list of default values) to return if the user enters the
991 empty string.
992 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
993 the current input method and the setting of `enable-multibyte-characters'. */)
994 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
995 {
996 Lisp_Object val;
997 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
998 Qnil, history, default_value,
999 inherit_input_method);
1000 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
1001 val = CONSP (default_value) ? XCAR (default_value) : default_value;
1002 return val;
1003 }
1004
1005 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1006 doc: /* Read a string from the terminal, not allowing blanks.
1007 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1008 non-nil, it should be a string, which is used as initial input, with
1009 point positioned at the end, so that SPACE will accept the input.
1010 \(Actually, INITIAL can also be a cons of a string and an integer.
1011 Such values are treated as in `read-from-minibuffer', but are normally
1012 not useful in this function.)
1013 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1014 the current input method and the setting of`enable-multibyte-characters'. */)
1015 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
1016 {
1017 CHECK_STRING (prompt);
1018 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
1019 0, Qminibuffer_history, make_number (0), Qnil, 0,
1020 !NILP (inherit_input_method));
1021 }
1022
1023 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1024 doc: /* Read the name of a command and return as a symbol.
1025 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1026 if it is a list. */)
1027 (Lisp_Object prompt, Lisp_Object default_value)
1028 {
1029 Lisp_Object name, default_string;
1030
1031 if (NILP (default_value))
1032 default_string = Qnil;
1033 else if (SYMBOLP (default_value))
1034 default_string = SYMBOL_NAME (default_value);
1035 else
1036 default_string = default_value;
1037
1038 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1039 Qnil, Qnil, default_string, Qnil);
1040 if (NILP (name))
1041 return name;
1042 return Fintern (name, Qnil);
1043 }
1044
1045 #ifdef NOTDEF
1046 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1047 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1048 Prompt with PROMPT. */)
1049 (Lisp_Object prompt)
1050 {
1051 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1052 Qnil);
1053 }
1054 #endif /* NOTDEF */
1055
1056 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1057 doc: /* Read the name of a user variable and return it as a symbol.
1058 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1059 if it is a list.
1060 A user variable is one for which `user-variable-p' returns non-nil. */)
1061 (Lisp_Object prompt, Lisp_Object default_value)
1062 {
1063 Lisp_Object name, default_string;
1064
1065 if (NILP (default_value))
1066 default_string = Qnil;
1067 else if (SYMBOLP (default_value))
1068 default_string = SYMBOL_NAME (default_value);
1069 else
1070 default_string = default_value;
1071
1072 name = Fcompleting_read (prompt, Vobarray,
1073 Quser_variable_p, Qt,
1074 Qnil, Qnil, default_string, Qnil);
1075 if (NILP (name))
1076 return name;
1077 return Fintern (name, Qnil);
1078 }
1079
1080 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1081 doc: /* Read the name of a buffer and return as a string.
1082 Prompt with PROMPT.
1083 Optional second arg DEF is value to return if user enters an empty line.
1084 If DEF is a list of default values, return its first element.
1085 Optional third arg REQUIRE-MATCH determines whether non-existing
1086 buffer names are allowed. It has the same meaning as the
1087 REQUIRE-MATCH argument of `completing-read'.
1088 The argument PROMPT should be a string ending with a colon and a space.
1089 If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1090 case while reading the buffer name.
1091 If `read-buffer-function' is non-nil, this works by calling it as a
1092 function, instead of the usual behavior. */)
1093 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match)
1094 {
1095 Lisp_Object args[4], result;
1096 char *s;
1097 int len;
1098 int count = SPECPDL_INDEX ();
1099
1100 if (BUFFERP (def))
1101 def = BVAR (XBUFFER (def), name);
1102
1103 specbind (Qcompletion_ignore_case,
1104 read_buffer_completion_ignore_case ? Qt : Qnil);
1105
1106 if (NILP (Vread_buffer_function))
1107 {
1108 if (!NILP (def))
1109 {
1110 /* A default value was provided: we must change PROMPT,
1111 editing the default value in before the colon. To achieve
1112 this, we replace PROMPT with a substring that doesn't
1113 contain the terminal space and colon (if present). They
1114 are then added back using Fformat. */
1115
1116 if (STRINGP (prompt))
1117 {
1118 s = SSDATA (prompt);
1119 len = strlen (s);
1120 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1121 len = len - 2;
1122 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1123 len--;
1124
1125 prompt = make_specified_string (s, -1, len,
1126 STRING_MULTIBYTE (prompt));
1127 }
1128
1129 args[0] = build_string ("%s (default %s): ");
1130 args[1] = prompt;
1131 args[2] = CONSP (def) ? XCAR (def) : def;
1132 prompt = Fformat (3, args);
1133 }
1134
1135 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1136 Qnil, require_match, Qnil, Qbuffer_name_history,
1137 def, Qnil);
1138 }
1139 else
1140 {
1141 args[0] = Vread_buffer_function;
1142 args[1] = prompt;
1143 args[2] = def;
1144 args[3] = require_match;
1145 result = Ffuncall(4, args);
1146 }
1147 return unbind_to (count, result);
1148 }
1149 \f
1150 static Lisp_Object
1151 minibuf_conform_representation (Lisp_Object string, Lisp_Object basis)
1152 {
1153 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1154 return string;
1155
1156 if (STRING_MULTIBYTE (string))
1157 return Fstring_make_unibyte (string);
1158 else
1159 return Fstring_make_multibyte (string);
1160 }
1161
1162 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1163 doc: /* Return common substring of all completions of STRING in COLLECTION.
1164 Test each possible completion specified by COLLECTION
1165 to see if it begins with STRING. The possible completions may be
1166 strings or symbols. Symbols are converted to strings before testing,
1167 see `symbol-name'.
1168 All that match STRING are compared together; the longest initial sequence
1169 common to all these matches is the return value.
1170 If there is no match at all, the return value is nil.
1171 For a unique match which is exact, the return value is t.
1172
1173 If COLLECTION is an alist, the keys (cars of elements) are the
1174 possible completions. If an element is not a cons cell, then the
1175 element itself is the possible completion.
1176 If COLLECTION is a hash-table, all the keys that are strings or symbols
1177 are the possible completions.
1178 If COLLECTION is an obarray, the names of all symbols in the obarray
1179 are the possible completions.
1180
1181 COLLECTION can also be a function to do the completion itself.
1182 It receives three arguments: the values STRING, PREDICATE and nil.
1183 Whatever it returns becomes the value of `try-completion'.
1184
1185 If optional third argument PREDICATE is non-nil,
1186 it is used to test each possible match.
1187 The match is a candidate only if PREDICATE returns non-nil.
1188 The argument given to PREDICATE is the alist element
1189 or the symbol from the obarray. If COLLECTION is a hash-table,
1190 predicate is called with two arguments: the key and the value.
1191 Additionally to this predicate, `completion-regexp-list'
1192 is used to further constrain the set of candidates. */)
1193 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1194 {
1195 Lisp_Object bestmatch, tail, elt, eltstring;
1196 /* Size in bytes of BESTMATCH. */
1197 int bestmatchsize = 0;
1198 /* These are in bytes, too. */
1199 int compare, matchsize;
1200 enum { function_table, list_table, obarray_table, hash_table}
1201 type = (HASH_TABLE_P (collection) ? hash_table
1202 : VECTORP (collection) ? obarray_table
1203 : ((NILP (collection)
1204 || (CONSP (collection)
1205 && (!SYMBOLP (XCAR (collection))
1206 || NILP (XCAR (collection)))))
1207 ? list_table : function_table));
1208 int idx = 0, obsize = 0;
1209 int matchcount = 0;
1210 int bindcount = -1;
1211 Lisp_Object bucket, zero, end, tem;
1212 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1213
1214 CHECK_STRING (string);
1215 if (type == function_table)
1216 return call3 (collection, string, predicate, Qnil);
1217
1218 bestmatch = bucket = Qnil;
1219 zero = make_number (0);
1220
1221 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1222 tail = collection;
1223 if (type == obarray_table)
1224 {
1225 collection = check_obarray (collection);
1226 obsize = XVECTOR (collection)->size;
1227 bucket = XVECTOR (collection)->contents[idx];
1228 }
1229
1230 while (1)
1231 {
1232 /* Get the next element of the alist, obarray, or hash-table. */
1233 /* Exit the loop if the elements are all used up. */
1234 /* elt gets the alist element or symbol.
1235 eltstring gets the name to check as a completion. */
1236
1237 if (type == list_table)
1238 {
1239 if (!CONSP (tail))
1240 break;
1241 elt = XCAR (tail);
1242 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1243 tail = XCDR (tail);
1244 }
1245 else if (type == obarray_table)
1246 {
1247 if (!EQ (bucket, zero))
1248 {
1249 if (!SYMBOLP (bucket))
1250 error ("Bad data in guts of obarray");
1251 elt = bucket;
1252 eltstring = elt;
1253 if (XSYMBOL (bucket)->next)
1254 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1255 else
1256 XSETFASTINT (bucket, 0);
1257 }
1258 else if (++idx >= obsize)
1259 break;
1260 else
1261 {
1262 bucket = XVECTOR (collection)->contents[idx];
1263 continue;
1264 }
1265 }
1266 else /* if (type == hash_table) */
1267 {
1268 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1269 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1270 idx++;
1271 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1272 break;
1273 else
1274 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1275 }
1276
1277 /* Is this element a possible completion? */
1278
1279 if (SYMBOLP (eltstring))
1280 eltstring = Fsymbol_name (eltstring);
1281
1282 if (STRINGP (eltstring)
1283 && SCHARS (string) <= SCHARS (eltstring)
1284 && (tem = Fcompare_strings (eltstring, zero,
1285 make_number (SCHARS (string)),
1286 string, zero, Qnil,
1287 completion_ignore_case ? Qt : Qnil),
1288 EQ (Qt, tem)))
1289 {
1290 /* Yes. */
1291 Lisp_Object regexps;
1292
1293 /* Ignore this element if it fails to match all the regexps. */
1294 {
1295 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1296 regexps = XCDR (regexps))
1297 {
1298 if (bindcount < 0) {
1299 bindcount = SPECPDL_INDEX ();
1300 specbind (Qcase_fold_search,
1301 completion_ignore_case ? Qt : Qnil);
1302 }
1303 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1304 if (NILP (tem))
1305 break;
1306 }
1307 if (CONSP (regexps))
1308 continue;
1309 }
1310
1311 /* Ignore this element if there is a predicate
1312 and the predicate doesn't like it. */
1313
1314 if (!NILP (predicate))
1315 {
1316 if (EQ (predicate, Qcommandp))
1317 tem = Fcommandp (elt, Qnil);
1318 else
1319 {
1320 if (bindcount >= 0)
1321 {
1322 unbind_to (bindcount, Qnil);
1323 bindcount = -1;
1324 }
1325 GCPRO4 (tail, string, eltstring, bestmatch);
1326 tem = (type == hash_table
1327 ? call2 (predicate, elt,
1328 HASH_VALUE (XHASH_TABLE (collection),
1329 idx - 1))
1330 : call1 (predicate, elt));
1331 UNGCPRO;
1332 }
1333 if (NILP (tem)) continue;
1334 }
1335
1336 /* Update computation of how much all possible completions match */
1337
1338 if (NILP (bestmatch))
1339 {
1340 matchcount = 1;
1341 bestmatch = eltstring;
1342 bestmatchsize = SCHARS (eltstring);
1343 }
1344 else
1345 {
1346 compare = min (bestmatchsize, SCHARS (eltstring));
1347 tem = Fcompare_strings (bestmatch, zero,
1348 make_number (compare),
1349 eltstring, zero,
1350 make_number (compare),
1351 completion_ignore_case ? Qt : Qnil);
1352 if (EQ (tem, Qt))
1353 matchsize = compare;
1354 else if (XINT (tem) < 0)
1355 matchsize = - XINT (tem) - 1;
1356 else
1357 matchsize = XINT (tem) - 1;
1358
1359 if (completion_ignore_case)
1360 {
1361 /* If this is an exact match except for case,
1362 use it as the best match rather than one that is not an
1363 exact match. This way, we get the case pattern
1364 of the actual match. */
1365 if ((matchsize == SCHARS (eltstring)
1366 && matchsize < SCHARS (bestmatch))
1367 ||
1368 /* If there is more than one exact match ignoring case,
1369 and one of them is exact including case,
1370 prefer that one. */
1371 /* If there is no exact match ignoring case,
1372 prefer a match that does not change the case
1373 of the input. */
1374 ((matchsize == SCHARS (eltstring))
1375 ==
1376 (matchsize == SCHARS (bestmatch))
1377 && (tem = Fcompare_strings (eltstring, zero,
1378 make_number (SCHARS (string)),
1379 string, zero,
1380 Qnil,
1381 Qnil),
1382 EQ (Qt, tem))
1383 && (tem = Fcompare_strings (bestmatch, zero,
1384 make_number (SCHARS (string)),
1385 string, zero,
1386 Qnil,
1387 Qnil),
1388 ! EQ (Qt, tem))))
1389 bestmatch = eltstring;
1390 }
1391 if (bestmatchsize != SCHARS (eltstring)
1392 || bestmatchsize != matchsize)
1393 /* Don't count the same string multiple times. */
1394 matchcount++;
1395 bestmatchsize = matchsize;
1396 if (matchsize <= SCHARS (string)
1397 /* If completion-ignore-case is non-nil, don't
1398 short-circuit because we want to find the best
1399 possible match *including* case differences. */
1400 && !completion_ignore_case
1401 && matchcount > 1)
1402 /* No need to look any further. */
1403 break;
1404 }
1405 }
1406 }
1407
1408 if (bindcount >= 0) {
1409 unbind_to (bindcount, Qnil);
1410 bindcount = -1;
1411 }
1412
1413 if (NILP (bestmatch))
1414 return Qnil; /* No completions found */
1415 /* If we are ignoring case, and there is no exact match,
1416 and no additional text was supplied,
1417 don't change the case of what the user typed. */
1418 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1419 && SCHARS (bestmatch) > bestmatchsize)
1420 return minibuf_conform_representation (string, bestmatch);
1421
1422 /* Return t if the supplied string is an exact match (counting case);
1423 it does not require any change to be made. */
1424 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
1425 return Qt;
1426
1427 XSETFASTINT (zero, 0); /* Else extract the part in which */
1428 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1429 return Fsubstring (bestmatch, zero, end);
1430 }
1431 \f
1432 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1433 doc: /* Search for partial matches to STRING in COLLECTION.
1434 Test each of the possible completions specified by COLLECTION
1435 to see if it begins with STRING. The possible completions may be
1436 strings or symbols. Symbols are converted to strings before testing,
1437 see `symbol-name'.
1438 The value is a list of all the possible completions that match STRING.
1439
1440 If COLLECTION is an alist, the keys (cars of elements) are the
1441 possible completions. If an element is not a cons cell, then the
1442 element itself is the possible completion.
1443 If COLLECTION is a hash-table, all the keys that are strings or symbols
1444 are the possible completions.
1445 If COLLECTION is an obarray, the names of all symbols in the obarray
1446 are the possible completions.
1447
1448 COLLECTION can also be a function to do the completion itself.
1449 It receives three arguments: the values STRING, PREDICATE and t.
1450 Whatever it returns becomes the value of `all-completions'.
1451
1452 If optional third argument PREDICATE is non-nil,
1453 it is used to test each possible match.
1454 The match is a candidate only if PREDICATE returns non-nil.
1455 The argument given to PREDICATE is the alist element
1456 or the symbol from the obarray. If COLLECTION is a hash-table,
1457 predicate is called with two arguments: the key and the value.
1458 Additionally to this predicate, `completion-regexp-list'
1459 is used to further constrain the set of candidates.
1460
1461 An obsolete optional fourth argument HIDE-SPACES is still accepted for
1462 backward compatibility. If non-nil, strings in COLLECTION that start
1463 with a space are ignored unless STRING itself starts with a space. */)
1464 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
1465 {
1466 Lisp_Object tail, elt, eltstring;
1467 Lisp_Object allmatches;
1468 int type = HASH_TABLE_P (collection) ? 3
1469 : VECTORP (collection) ? 2
1470 : NILP (collection) || (CONSP (collection)
1471 && (!SYMBOLP (XCAR (collection))
1472 || NILP (XCAR (collection))));
1473 int idx = 0, obsize = 0;
1474 int bindcount = -1;
1475 Lisp_Object bucket, tem, zero;
1476 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1477
1478 CHECK_STRING (string);
1479 if (type == 0)
1480 return call3 (collection, string, predicate, Qt);
1481 allmatches = bucket = Qnil;
1482 zero = make_number (0);
1483
1484 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1485 tail = collection;
1486 if (type == 2)
1487 {
1488 collection = check_obarray (collection);
1489 obsize = XVECTOR (collection)->size;
1490 bucket = XVECTOR (collection)->contents[idx];
1491 }
1492
1493 while (1)
1494 {
1495 /* Get the next element of the alist, obarray, or hash-table. */
1496 /* Exit the loop if the elements are all used up. */
1497 /* elt gets the alist element or symbol.
1498 eltstring gets the name to check as a completion. */
1499
1500 if (type == 1)
1501 {
1502 if (!CONSP (tail))
1503 break;
1504 elt = XCAR (tail);
1505 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1506 tail = XCDR (tail);
1507 }
1508 else if (type == 2)
1509 {
1510 if (!EQ (bucket, zero))
1511 {
1512 if (!SYMBOLP (bucket))
1513 error ("Bad data in guts of obarray");
1514 elt = bucket;
1515 eltstring = elt;
1516 if (XSYMBOL (bucket)->next)
1517 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1518 else
1519 XSETFASTINT (bucket, 0);
1520 }
1521 else if (++idx >= obsize)
1522 break;
1523 else
1524 {
1525 bucket = XVECTOR (collection)->contents[idx];
1526 continue;
1527 }
1528 }
1529 else /* if (type == 3) */
1530 {
1531 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1532 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1533 idx++;
1534 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1535 break;
1536 else
1537 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1538 }
1539
1540 /* Is this element a possible completion? */
1541
1542 if (SYMBOLP (eltstring))
1543 eltstring = Fsymbol_name (eltstring);
1544
1545 if (STRINGP (eltstring)
1546 && SCHARS (string) <= SCHARS (eltstring)
1547 /* If HIDE_SPACES, reject alternatives that start with space
1548 unless the input starts with space. */
1549 && (NILP (hide_spaces)
1550 || (SBYTES (string) > 0
1551 && SREF (string, 0) == ' ')
1552 || SREF (eltstring, 0) != ' ')
1553 && (tem = Fcompare_strings (eltstring, zero,
1554 make_number (SCHARS (string)),
1555 string, zero,
1556 make_number (SCHARS (string)),
1557 completion_ignore_case ? Qt : Qnil),
1558 EQ (Qt, tem)))
1559 {
1560 /* Yes. */
1561 Lisp_Object regexps;
1562
1563 /* Ignore this element if it fails to match all the regexps. */
1564 {
1565 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1566 regexps = XCDR (regexps))
1567 {
1568 if (bindcount < 0) {
1569 bindcount = SPECPDL_INDEX ();
1570 specbind (Qcase_fold_search,
1571 completion_ignore_case ? Qt : Qnil);
1572 }
1573 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1574 if (NILP (tem))
1575 break;
1576 }
1577 if (CONSP (regexps))
1578 continue;
1579 }
1580
1581 /* Ignore this element if there is a predicate
1582 and the predicate doesn't like it. */
1583
1584 if (!NILP (predicate))
1585 {
1586 if (EQ (predicate, Qcommandp))
1587 tem = Fcommandp (elt, Qnil);
1588 else
1589 {
1590 if (bindcount >= 0) {
1591 unbind_to (bindcount, Qnil);
1592 bindcount = -1;
1593 }
1594 GCPRO4 (tail, eltstring, allmatches, string);
1595 tem = type == 3
1596 ? call2 (predicate, elt,
1597 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
1598 : call1 (predicate, elt);
1599 UNGCPRO;
1600 }
1601 if (NILP (tem)) continue;
1602 }
1603 /* Ok => put it on the list. */
1604 allmatches = Fcons (eltstring, allmatches);
1605 }
1606 }
1607
1608 if (bindcount >= 0) {
1609 unbind_to (bindcount, Qnil);
1610 bindcount = -1;
1611 }
1612
1613 return Fnreverse (allmatches);
1614 }
1615 \f
1616 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1617 doc: /* Read a string in the minibuffer, with completion.
1618 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1619 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1620 COLLECTION can also be a function to do the completion itself.
1621 PREDICATE limits completion to a subset of COLLECTION.
1622 See `try-completion' and `all-completions' for more details
1623 on completion, COLLECTION, and PREDICATE.
1624
1625 REQUIRE-MATCH can take the following values:
1626 - t means that the user is not allowed to exit unless
1627 the input is (or completes to) an element of COLLECTION or is null.
1628 - nil means that the user can exit with any input.
1629 - `confirm' means that the user can exit with any input, but she needs
1630 to confirm her choice if the input is not an element of COLLECTION.
1631 - `confirm-after-completion' means that the user can exit with any
1632 input, but she needs to confirm her choice if she called
1633 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1634 and the input is not an element of COLLECTION.
1635 - anything else behaves like t except that typing RET does not exit if it
1636 does non-null completion.
1637
1638 If the input is null, `completing-read' returns DEF, or the first element
1639 of the list of default values, or an empty string if DEF is nil,
1640 regardless of the value of REQUIRE-MATCH.
1641
1642 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1643 with point positioned at the end.
1644 If it is (STRING . POSITION), the initial input is STRING, but point
1645 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1646 that this is different from `read-from-minibuffer' and related
1647 functions, which use one-indexing for POSITION.) This feature is
1648 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1649 default value DEF instead. The user can yank the default value into
1650 the minibuffer easily using \\[next-history-element].
1651
1652 HIST, if non-nil, specifies a history list and optionally the initial
1653 position in the list. It can be a symbol, which is the history list
1654 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1655 that case, HISTVAR is the history list variable to use, and HISTPOS
1656 is the initial position (the position in the list used by the
1657 minibuffer history commands). For consistency, you should also
1658 specify that element of the history as the value of
1659 INITIAL-INPUT. (This is the only case in which you should use
1660 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1661 1 at the beginning of the list. The variable `history-length'
1662 controls the maximum length of a history list.
1663
1664 DEF, if non-nil, is the default value or the list of default values.
1665
1666 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1667 the current input method and the setting of `enable-multibyte-characters'.
1668
1669 Completion ignores case if the ambient value of
1670 `completion-ignore-case' is non-nil.
1671
1672 See also `completing-read-function'. */)
1673 (Lisp_Object prompt, Lisp_Object collection, Lisp_Object predicate, Lisp_Object require_match, Lisp_Object initial_input, Lisp_Object hist, Lisp_Object def, Lisp_Object inherit_input_method)
1674 {
1675 Lisp_Object args[9];
1676 args[0] = Vcompleting_read_function;
1677 args[1] = prompt;
1678 args[2] = collection;
1679 args[3] = predicate;
1680 args[4] = require_match;
1681 args[5] = initial_input;
1682 args[6] = hist;
1683 args[7] = def;
1684 args[8] = inherit_input_method;
1685 return Ffuncall (9, args);
1686 }
1687
1688 DEFUN ("completing-read-default", Fcompleting_read_default, Scompleting_read_default, 2, 8, 0,
1689 doc: /* Default method for reading from the minibuffer with completion.
1690 See `completing-read' for the meaning of the arguments. */)
1691 (Lisp_Object prompt, Lisp_Object collection, Lisp_Object predicate, Lisp_Object require_match, Lisp_Object initial_input, Lisp_Object hist, Lisp_Object def, Lisp_Object inherit_input_method)
1692 {
1693 Lisp_Object val, histvar, histpos, position;
1694 Lisp_Object init;
1695 int pos = 0;
1696 int count = SPECPDL_INDEX ();
1697 struct gcpro gcpro1;
1698
1699 init = initial_input;
1700 GCPRO1 (def);
1701
1702 specbind (Qminibuffer_completion_table, collection);
1703 specbind (Qminibuffer_completion_predicate, predicate);
1704 specbind (Qminibuffer_completion_confirm,
1705 EQ (require_match, Qt) ? Qnil : require_match);
1706
1707 position = Qnil;
1708 if (!NILP (init))
1709 {
1710 if (CONSP (init))
1711 {
1712 position = Fcdr (init);
1713 init = Fcar (init);
1714 }
1715 CHECK_STRING (init);
1716 if (!NILP (position))
1717 {
1718 CHECK_NUMBER (position);
1719 /* Convert to distance from end of input. */
1720 pos = XINT (position) - SCHARS (init);
1721 }
1722 }
1723
1724 if (SYMBOLP (hist))
1725 {
1726 histvar = hist;
1727 histpos = Qnil;
1728 }
1729 else
1730 {
1731 histvar = Fcar_safe (hist);
1732 histpos = Fcdr_safe (hist);
1733 }
1734 if (NILP (histvar))
1735 histvar = Qminibuffer_history;
1736 if (NILP (histpos))
1737 XSETFASTINT (histpos, 0);
1738
1739 val = read_minibuf (NILP (require_match)
1740 ? (NILP (Vminibuffer_completing_file_name)
1741 || EQ (Vminibuffer_completing_file_name, Qlambda)
1742 ? Vminibuffer_local_completion_map
1743 : Vminibuffer_local_filename_completion_map)
1744 : (NILP (Vminibuffer_completing_file_name)
1745 || EQ (Vminibuffer_completing_file_name, Qlambda)
1746 ? Vminibuffer_local_must_match_map
1747 : Vminibuffer_local_filename_must_match_map),
1748 init, prompt, make_number (pos), 0,
1749 histvar, histpos, def, 0,
1750 !NILP (inherit_input_method));
1751
1752 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (def))
1753 val = CONSP (def) ? XCAR (def) : def;
1754
1755 RETURN_UNGCPRO (unbind_to (count, val));
1756 }
1757 \f
1758 Lisp_Object Fassoc_string (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold);
1759
1760 /* Test whether TXT is an exact completion. */
1761 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1762 doc: /* Return non-nil if STRING is a valid completion.
1763 Takes the same arguments as `all-completions' and `try-completion'.
1764 If COLLECTION is a function, it is called with three arguments:
1765 the values STRING, PREDICATE and `lambda'. */)
1766 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1767 {
1768 Lisp_Object regexps, tail, tem = Qnil;
1769 int i = 0;
1770
1771 CHECK_STRING (string);
1772
1773 if ((CONSP (collection)
1774 && (!SYMBOLP (XCAR (collection)) || NILP (XCAR (collection))))
1775 || NILP (collection))
1776 {
1777 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1778 if (NILP (tem))
1779 return Qnil;
1780 }
1781 else if (VECTORP (collection))
1782 {
1783 /* Bypass intern-soft as that loses for nil. */
1784 tem = oblookup (collection,
1785 SSDATA (string),
1786 SCHARS (string),
1787 SBYTES (string));
1788 if (!SYMBOLP (tem))
1789 {
1790 if (STRING_MULTIBYTE (string))
1791 string = Fstring_make_unibyte (string);
1792 else
1793 string = Fstring_make_multibyte (string);
1794
1795 tem = oblookup (collection,
1796 SSDATA (string),
1797 SCHARS (string),
1798 SBYTES (string));
1799 }
1800
1801 if (completion_ignore_case && !SYMBOLP (tem))
1802 {
1803 for (i = XVECTOR (collection)->size - 1; i >= 0; i--)
1804 {
1805 tail = XVECTOR (collection)->contents[i];
1806 if (SYMBOLP (tail))
1807 while (1)
1808 {
1809 if (EQ((Fcompare_strings (string, make_number (0), Qnil,
1810 Fsymbol_name (tail),
1811 make_number (0) , Qnil, Qt)),
1812 Qt))
1813 {
1814 tem = tail;
1815 break;
1816 }
1817 if (XSYMBOL (tail)->next == 0)
1818 break;
1819 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1820 }
1821 }
1822 }
1823
1824 if (!SYMBOLP (tem))
1825 return Qnil;
1826 }
1827 else if (HASH_TABLE_P (collection))
1828 {
1829 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1830 i = hash_lookup (h, string, NULL);
1831 if (i >= 0)
1832 tem = HASH_KEY (h, i);
1833 else
1834 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1835 if (!NILP (HASH_HASH (h, i)) &&
1836 EQ (Fcompare_strings (string, make_number (0), Qnil,
1837 HASH_KEY (h, i), make_number (0) , Qnil,
1838 completion_ignore_case ? Qt : Qnil),
1839 Qt))
1840 {
1841 tem = HASH_KEY (h, i);
1842 break;
1843 }
1844 if (!STRINGP (tem))
1845 return Qnil;
1846 }
1847 else
1848 return call3 (collection, string, predicate, Qlambda);
1849
1850 /* Reject this element if it fails to match all the regexps. */
1851 if (CONSP (Vcompletion_regexp_list))
1852 {
1853 int count = SPECPDL_INDEX ();
1854 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1855 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1856 regexps = XCDR (regexps))
1857 {
1858 if (NILP (Fstring_match (XCAR (regexps),
1859 SYMBOLP (tem) ? string : tem,
1860 Qnil)))
1861 return unbind_to (count, Qnil);
1862 }
1863 unbind_to (count, Qnil);
1864 }
1865
1866 /* Finally, check the predicate. */
1867 if (!NILP (predicate))
1868 {
1869 return HASH_TABLE_P (collection)
1870 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1871 : call1 (predicate, tem);
1872 }
1873 else
1874 return Qt;
1875 }
1876
1877 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1878 doc: /* Perform completion on buffer names.
1879 If the argument FLAG is nil, invoke `try-completion', if it's t, invoke
1880 `all-completions', otherwise invoke `test-completion'.
1881
1882 The arguments STRING and PREDICATE are as in `try-completion',
1883 `all-completions', and `test-completion'. */)
1884 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
1885 {
1886 if (NILP (flag))
1887 return Ftry_completion (string, Vbuffer_alist, predicate);
1888 else if (EQ (flag, Qt))
1889 {
1890 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
1891 if (SCHARS (string) > 0)
1892 return res;
1893 else
1894 { /* Strip out internal buffers. */
1895 Lisp_Object bufs = res;
1896 /* First, look for a non-internal buffer in `res'. */
1897 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1898 bufs = XCDR (bufs);
1899 if (NILP (bufs))
1900 /* All bufs in `res' are internal, so don't trip them out. */
1901 return res;
1902 res = bufs;
1903 while (CONSP (XCDR (bufs)))
1904 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1905 XSETCDR (bufs, XCDR (XCDR (bufs)));
1906 else
1907 bufs = XCDR (bufs);
1908 return res;
1909 }
1910 }
1911 else /* assume `lambda' */
1912 return Ftest_completion (string, Vbuffer_alist, predicate);
1913 }
1914
1915 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1916
1917 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1918 doc: /* Like `assoc' but specifically for strings (and symbols).
1919
1920 This returns the first element of LIST whose car matches the string or
1921 symbol KEY, or nil if no match exists. When performing the
1922 comparison, symbols are first converted to strings, and unibyte
1923 strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
1924 is ignored.
1925
1926 Unlike `assoc', KEY can also match an entry in LIST consisting of a
1927 single string, rather than a cons cell whose car is a string. */)
1928 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
1929 {
1930 register Lisp_Object tail;
1931
1932 if (SYMBOLP (key))
1933 key = Fsymbol_name (key);
1934
1935 for (tail = list; CONSP (tail); tail = XCDR (tail))
1936 {
1937 register Lisp_Object elt, tem, thiscar;
1938 elt = XCAR (tail);
1939 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1940 if (SYMBOLP (thiscar))
1941 thiscar = Fsymbol_name (thiscar);
1942 else if (!STRINGP (thiscar))
1943 continue;
1944 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1945 key, make_number (0), Qnil,
1946 case_fold);
1947 if (EQ (tem, Qt))
1948 return elt;
1949 QUIT;
1950 }
1951 return Qnil;
1952 }
1953
1954 \f
1955 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1956 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
1957 (void)
1958 {
1959 return make_number (minibuf_level);
1960 }
1961
1962 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1963 doc: /* Return the prompt string of the currently-active minibuffer.
1964 If no minibuffer is active, return nil. */)
1965 (void)
1966 {
1967 return Fcopy_sequence (minibuf_prompt);
1968 }
1969
1970 \f
1971 void
1972 init_minibuf_once (void)
1973 {
1974 Vminibuffer_list = Qnil;
1975 staticpro (&Vminibuffer_list);
1976 }
1977
1978 void
1979 syms_of_minibuf (void)
1980 {
1981 minibuf_level = 0;
1982 minibuf_prompt = Qnil;
1983 staticpro (&minibuf_prompt);
1984
1985 minibuf_save_list = Qnil;
1986 staticpro (&minibuf_save_list);
1987
1988 Qcompleting_read_default = intern_c_string ("completing-read-default");
1989 staticpro (&Qcompleting_read_default);
1990
1991 Qcompletion_ignore_case = intern_c_string ("completion-ignore-case");
1992 staticpro (&Qcompletion_ignore_case);
1993
1994 Qread_file_name_internal = intern_c_string ("read-file-name-internal");
1995 staticpro (&Qread_file_name_internal);
1996
1997 Qminibuffer_default = intern_c_string ("minibuffer-default");
1998 staticpro (&Qminibuffer_default);
1999 Fset (Qminibuffer_default, Qnil);
2000
2001 Qminibuffer_completion_table = intern_c_string ("minibuffer-completion-table");
2002 staticpro (&Qminibuffer_completion_table);
2003
2004 Qminibuffer_completion_confirm = intern_c_string ("minibuffer-completion-confirm");
2005 staticpro (&Qminibuffer_completion_confirm);
2006
2007 Qminibuffer_completion_predicate = intern_c_string ("minibuffer-completion-predicate");
2008 staticpro (&Qminibuffer_completion_predicate);
2009
2010 staticpro (&last_minibuf_string);
2011 last_minibuf_string = Qnil;
2012
2013 Quser_variable_p = intern_c_string ("user-variable-p");
2014 staticpro (&Quser_variable_p);
2015
2016 Qminibuffer_history = intern_c_string ("minibuffer-history");
2017 staticpro (&Qminibuffer_history);
2018
2019 Qbuffer_name_history = intern_c_string ("buffer-name-history");
2020 staticpro (&Qbuffer_name_history);
2021 Fset (Qbuffer_name_history, Qnil);
2022
2023 Qminibuffer_setup_hook = intern_c_string ("minibuffer-setup-hook");
2024 staticpro (&Qminibuffer_setup_hook);
2025
2026 Qminibuffer_exit_hook = intern_c_string ("minibuffer-exit-hook");
2027 staticpro (&Qminibuffer_exit_hook);
2028
2029 Qhistory_length = intern_c_string ("history-length");
2030 staticpro (&Qhistory_length);
2031
2032 Qcurrent_input_method = intern_c_string ("current-input-method");
2033 staticpro (&Qcurrent_input_method);
2034
2035 Qactivate_input_method = intern_c_string ("activate-input-method");
2036 staticpro (&Qactivate_input_method);
2037
2038 Qcase_fold_search = intern_c_string ("case-fold-search");
2039 staticpro (&Qcase_fold_search);
2040
2041 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
2042 doc: /* A history list for arguments that are Lisp expressions to evaluate.
2043 For example, `eval-expression' uses this. */);
2044 Vread_expression_history = Qnil;
2045
2046 Qread_expression_history = intern_c_string ("read-expression-history");
2047 staticpro (&Qread_expression_history);
2048
2049 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
2050 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
2051 The function is called with the arguments passed to `read-buffer'. */);
2052 Vread_buffer_function = Qnil;
2053
2054 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
2055 read_buffer_completion_ignore_case,
2056 doc: /* *Non-nil means completion ignores case when reading a buffer name. */);
2057 read_buffer_completion_ignore_case = 0;
2058
2059 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
2060 doc: /* Normal hook run just after entry to minibuffer. */);
2061 Vminibuffer_setup_hook = Qnil;
2062
2063 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
2064 doc: /* Normal hook run just after exit from minibuffer. */);
2065 Vminibuffer_exit_hook = Qnil;
2066
2067 DEFVAR_LISP ("history-length", Vhistory_length,
2068 doc: /* *Maximum length for history lists before truncation takes place.
2069 A number means that length; t means infinite. Truncation takes place
2070 just after a new element is inserted. Setting the `history-length'
2071 property of a history variable overrides this default. */);
2072 XSETFASTINT (Vhistory_length, 30);
2073
2074 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
2075 doc: /* *Non-nil means to delete duplicates in history.
2076 If set to t when adding a new history element, all previous identical
2077 elements are deleted from the history list. */);
2078 history_delete_duplicates = 0;
2079
2080 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
2081 doc: /* *Non-nil means to add new elements in history.
2082 If set to nil, minibuffer reading functions don't add new elements to the
2083 history list, so it is possible to do this afterwards by calling
2084 `add-to-history' explicitly. */);
2085 Vhistory_add_new_input = Qt;
2086
2087 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
2088 doc: /* Non-nil means don't consider case significant in completion.
2089 For file-name completion, `read-file-name-completion-ignore-case'
2090 controls the behavior, rather than this variable.
2091 For buffer name completion, `read-buffer-completion-ignore-case'
2092 controls the behavior, rather than this variable. */);
2093 completion_ignore_case = 0;
2094
2095 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
2096 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
2097 This variable makes a difference whenever the minibuffer window is active. */);
2098 enable_recursive_minibuffers = 0;
2099
2100 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
2101 doc: /* Alist or obarray used for completion in the minibuffer.
2102 This becomes the ALIST argument to `try-completion' and `all-completions'.
2103 The value can also be a list of strings or a hash table.
2104
2105 The value may alternatively be a function, which is given three arguments:
2106 STRING, the current buffer contents;
2107 PREDICATE, the predicate for filtering possible matches;
2108 CODE, which says what kind of things to do.
2109 CODE can be nil, t or `lambda':
2110 nil -- return the best completion of STRING, or nil if there is none.
2111 t -- return a list of all possible completions of STRING.
2112 lambda -- return t if STRING is a valid completion as it stands. */);
2113 Vminibuffer_completion_table = Qnil;
2114
2115 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
2116 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2117 Vminibuffer_completion_predicate = Qnil;
2118
2119 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
2120 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2121 If nil, confirmation is not required.
2122 If the value is `confirm', the user may exit with an input that is not
2123 a valid completion alternative, but Emacs asks for confirmation.
2124 If the value is `confirm-after-completion', the user may exit with an
2125 input that is not a valid completion alternative, but Emacs asks for
2126 confirmation if the user submitted the input right after any of the
2127 completion commands listed in `minibuffer-confirm-exit-commands'. */);
2128 Vminibuffer_completion_confirm = Qnil;
2129
2130 DEFVAR_LISP ("minibuffer-completing-file-name",
2131 Vminibuffer_completing_file_name,
2132 doc: /* Non-nil means completing file names. */);
2133 Vminibuffer_completing_file_name = Qnil;
2134
2135 DEFVAR_LISP ("completing-read-function",
2136 Vcompleting_read_function,
2137 doc: /* The function called by `completing-read' to do the work.
2138 It should accept the same arguments as `completing-read'. */);
2139 Vcompleting_read_function = Qcompleting_read_default;
2140
2141 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
2142 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2143 Vminibuffer_help_form = Qnil;
2144
2145 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
2146 doc: /* History list symbol to add minibuffer values to.
2147 Each string of minibuffer input, as it appears on exit from the minibuffer,
2148 is added with
2149 (set minibuffer-history-variable
2150 (cons STRING (symbol-value minibuffer-history-variable))) */);
2151 XSETFASTINT (Vminibuffer_history_variable, 0);
2152
2153 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
2154 doc: /* Current position of redoing in the history list. */);
2155 Vminibuffer_history_position = Qnil;
2156
2157 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
2158 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
2159 Some uses of the echo area also raise that frame (since they use it too). */);
2160 minibuffer_auto_raise = 0;
2161
2162 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
2163 doc: /* List of regexps that should restrict possible completions.
2164 The basic completion functions only consider a completion acceptable
2165 if it matches all regular expressions in this list, with
2166 `case-fold-search' bound to the value of `completion-ignore-case'.
2167 See Info node `(elisp)Basic Completion', for a description of these
2168 functions. */);
2169 Vcompletion_regexp_list = Qnil;
2170
2171 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2172 minibuffer_allow_text_properties,
2173 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2174 This also affects `read-string', but it does not affect `read-minibuffer',
2175 `read-no-blanks-input', or any of the functions that do minibuffer input
2176 with completion; they always discard text properties. */);
2177 minibuffer_allow_text_properties = 0;
2178
2179 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
2180 doc: /* Text properties that are added to minibuffer prompts.
2181 These are in addition to the basic `field' property, and stickiness
2182 properties. */);
2183 /* We use `intern' here instead of Qread_only to avoid
2184 initialization-order problems. */
2185 Vminibuffer_prompt_properties
2186 = Fcons (intern_c_string ("read-only"), Fcons (Qt, Qnil));
2187
2188 DEFVAR_LISP ("read-expression-map", Vread_expression_map,
2189 doc: /* Minibuffer keymap used for reading Lisp expressions. */);
2190 Vread_expression_map = Qnil;
2191
2192 defsubr (&Sset_minibuffer_window);
2193 defsubr (&Sread_from_minibuffer);
2194 defsubr (&Seval_minibuffer);
2195 defsubr (&Sread_minibuffer);
2196 defsubr (&Sread_string);
2197 defsubr (&Sread_command);
2198 defsubr (&Sread_variable);
2199 defsubr (&Sinternal_complete_buffer);
2200 defsubr (&Sread_buffer);
2201 defsubr (&Sread_no_blanks_input);
2202 defsubr (&Sminibuffer_depth);
2203 defsubr (&Sminibuffer_prompt);
2204
2205 defsubr (&Sminibufferp);
2206 defsubr (&Sminibuffer_prompt_end);
2207 defsubr (&Sminibuffer_contents);
2208 defsubr (&Sminibuffer_contents_no_properties);
2209 defsubr (&Sminibuffer_completion_contents);
2210
2211 defsubr (&Stry_completion);
2212 defsubr (&Sall_completions);
2213 defsubr (&Stest_completion);
2214 defsubr (&Sassoc_string);
2215 defsubr (&Scompleting_read);
2216 defsubr (&Scompleting_read_default);
2217 }