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