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