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