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