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