(Ftry_completion): Use Fcompare_strings.
[bpt/emacs.git] / src / minibuf.c
1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998
3 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22
23 #include <config.h>
24 #include "lisp.h"
25 #include "commands.h"
26 #include "buffer.h"
27 #include "charset.h"
28 #include "dispextern.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "syntax.h"
32 #include "keyboard.h"
33
34 #define min(a, b) ((a) < (b) ? (a) : (b))
35
36 extern int quit_char;
37
38 /* List of buffers for use as minibuffers.
39 The first element of the list is used for the outermost minibuffer
40 invocation, the next element is used for a recursive minibuffer
41 invocation, etc. The list is extended at the end as deeper
42 minibuffer recursions are encountered. */
43 Lisp_Object Vminibuffer_list;
44
45 /* Data to remember during recursive minibuffer invocations */
46 Lisp_Object minibuf_save_list;
47
48 /* Depth in minibuffer invocations. */
49 int minibuf_level;
50
51 /* Nonzero means display completion help for invalid input. */
52 int auto_help;
53
54 /* The maximum length of a minibuffer history. */
55 Lisp_Object Qhistory_length, Vhistory_length;
56
57 /* Fread_minibuffer leaves the input here as a string. */
58 Lisp_Object last_minibuf_string;
59
60 /* Nonzero means let functions called when within a minibuffer
61 invoke recursive minibuffers (to read arguments, or whatever) */
62 int enable_recursive_minibuffers;
63
64 /* Nonzero means don't ignore text properties
65 in Fread_from_minibuffer. */
66 int minibuffer_allow_text_properties;
67
68 /* help-form is bound to this while in the minibuffer. */
69
70 Lisp_Object Vminibuffer_help_form;
71
72 /* Variable which is the history list to add minibuffer values to. */
73
74 Lisp_Object Vminibuffer_history_variable;
75
76 /* Current position in the history list (adjusted by M-n and M-p). */
77
78 Lisp_Object Vminibuffer_history_position;
79
80 Lisp_Object Qminibuffer_history;
81
82 Lisp_Object Qread_file_name_internal;
83
84 /* Normal hooks for entry to and exit from minibuffer. */
85
86 Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
87 Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
88
89 /* Function to call to read a buffer name. */
90 Lisp_Object Vread_buffer_function;
91
92 /* Nonzero means completion ignores case. */
93
94 int completion_ignore_case;
95
96 /* List of regexps that should restrict possible completions. */
97
98 Lisp_Object Vcompletion_regexp_list;
99
100 /* Nonzero means raise the minibuffer frame when the minibuffer
101 is entered. */
102
103 int minibuffer_auto_raise;
104
105 /* If last completion attempt reported "Complete but not unique"
106 then this is the string completed then; otherwise this is nil. */
107
108 static Lisp_Object last_exact_completion;
109
110 Lisp_Object Quser_variable_p;
111
112 Lisp_Object Qminibuffer_default;
113
114 /* Non-nil means it is the window for C-M-v to scroll
115 when the minibuffer is selected. */
116 extern Lisp_Object Vminibuf_scroll_window;
117
118 extern Lisp_Object Voverriding_local_map;
119
120 Lisp_Object Qcurrent_input_method, Qactivate_input_method;
121
122 \f
123 /* Put minibuf on currently selected frame's minibuffer.
124 We do this whenever the user starts a new minibuffer
125 or when a minibuffer exits. */
126
127 void
128 choose_minibuf_frame ()
129 {
130 if (selected_frame != 0
131 && !EQ (minibuf_window, selected_frame->minibuffer_window))
132 {
133 /* I don't think that any frames may validly have a null minibuffer
134 window anymore. */
135 if (NILP (selected_frame->minibuffer_window))
136 abort ();
137
138 Fset_window_buffer (selected_frame->minibuffer_window,
139 XWINDOW (minibuf_window)->buffer);
140 minibuf_window = selected_frame->minibuffer_window;
141 }
142
143 /* Make sure no other frame has a minibuffer as its selected window,
144 because the text would not be displayed in it, and that would be
145 confusing. Only allow the selected frame to do this,
146 and that only if the minibuffer is active. */
147 {
148 Lisp_Object tail, frame;
149
150 FOR_EACH_FRAME (tail, frame)
151 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
152 && !(XFRAME (frame) == selected_frame
153 && minibuf_level > 0))
154 Fset_frame_selected_window (frame, Fframe_first_window (frame));
155 }
156 }
157
158 Lisp_Object
159 choose_minibuf_frame_1 (ignore)
160 Lisp_Object ignore;
161 {
162 choose_minibuf_frame ();
163 return Qnil;
164 }
165
166 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
167 Sset_minibuffer_window, 1, 1, 0,
168 "Specify which minibuffer window to use for the minibuffer.\n\
169 This effects where the minibuffer is displayed if you put text in it\n\
170 without invoking the usual minibuffer commands.")
171 (window)
172 Lisp_Object window;
173 {
174 CHECK_WINDOW (window, 1);
175 if (! MINI_WINDOW_P (XWINDOW (window)))
176 error ("Window is not a minibuffer window");
177
178 minibuf_window = window;
179
180 return window;
181 }
182
183 \f
184 /* Actual minibuffer invocation. */
185
186 static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
187 static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
188 Lisp_Object, Lisp_Object,
189 int, Lisp_Object,
190 Lisp_Object, Lisp_Object,
191 int, int));
192
193 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
194 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
195 prompting with PROMPT (a string), using history list HISTVAR
196 with initial position HISTPOS. (BACKUP_N should be <= 0.)
197
198 Normally return the result as a string (the text that was read),
199 but if EXPFLAG is nonzero, read it and return the object read.
200 If HISTVAR is given, save the value read on that history only if it doesn't
201 match the front of that history list exactly. The value is pushed onto
202 the list as the string that was read.
203
204 DEFALT specifies te default value for the sake of history commands.
205
206 If ALLOW_PROPS is nonzero, we do not throw away text properties.
207
208 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
209 current input method. */
210
211 static Lisp_Object
212 read_minibuf (map, initial, prompt, backup_n, expflag,
213 histvar, histpos, defalt, allow_props, inherit_input_method)
214 Lisp_Object map;
215 Lisp_Object initial;
216 Lisp_Object prompt;
217 Lisp_Object backup_n;
218 int expflag;
219 Lisp_Object histvar;
220 Lisp_Object histpos;
221 Lisp_Object defalt;
222 int allow_props;
223 int inherit_input_method;
224 {
225 Lisp_Object val;
226 int count = specpdl_ptr - specpdl;
227 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
228 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
229 Lisp_Object enable_multibyte;
230
231 specbind (Qminibuffer_default, defalt);
232
233 single_kboard_state ();
234
235 val = Qnil;
236 ambient_dir = current_buffer->directory;
237 input_method = Qnil;
238 enable_multibyte = Qnil;
239
240 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
241 store them away before we can GC. Don't need to protect
242 BACKUP_N because we use the value only if it is an integer. */
243 GCPRO5 (map, initial, val, ambient_dir, input_method);
244
245 if (!STRINGP (prompt))
246 prompt = build_string ("");
247
248 if (!enable_recursive_minibuffers
249 && minibuf_level > 0)
250 {
251 if (EQ (selected_window, minibuf_window))
252 error ("Command attempted to use minibuffer while in minibuffer");
253 else
254 /* If we're in another window, cancel the minibuffer that's active. */
255 Fthrow (Qexit,
256 build_string ("Command attempted to use minibuffer while in minibuffer"));
257 }
258
259 /* Choose the minibuffer window and frame, and take action on them. */
260
261 choose_minibuf_frame ();
262
263 record_unwind_protect (choose_minibuf_frame_1, Qnil);
264
265 record_unwind_protect (Fset_window_configuration,
266 Fcurrent_window_configuration (Qnil));
267
268 /* If the minibuffer window is on a different frame, save that
269 frame's configuration too. */
270 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
271 if (XFRAME (mini_frame) != selected_frame)
272 record_unwind_protect (Fset_window_configuration,
273 Fcurrent_window_configuration (mini_frame));
274
275 /* If the minibuffer is on an iconified or invisible frame,
276 make it visible now. */
277 Fmake_frame_visible (mini_frame);
278
279 if (minibuffer_auto_raise)
280 Fraise_frame (mini_frame);
281
282 /* We have to do this after saving the window configuration
283 since that is what restores the current buffer. */
284
285 /* Arrange to restore a number of minibuffer-related variables.
286 We could bind each variable separately, but that would use lots of
287 specpdl slots. */
288 minibuf_save_list
289 = Fcons (Voverriding_local_map,
290 Fcons (minibuf_window, minibuf_save_list));
291 minibuf_save_list
292 = Fcons (minibuf_prompt,
293 Fcons (make_number (minibuf_prompt_width),
294 Fcons (Vhelp_form,
295 Fcons (Vcurrent_prefix_arg,
296 Fcons (Vminibuffer_history_position,
297 Fcons (Vminibuffer_history_variable,
298 minibuf_save_list))))));
299
300 record_unwind_protect (read_minibuf_unwind, Qnil);
301 minibuf_level++;
302
303 /* Now that we can restore all those variables, start changing them. */
304
305 minibuf_prompt_width = 0; /* xdisp.c puts in the right value. */
306 minibuf_prompt = Fcopy_sequence (prompt);
307 Vminibuffer_history_position = histpos;
308 Vminibuffer_history_variable = histvar;
309 Vhelp_form = Vminibuffer_help_form;
310
311 if (inherit_input_method)
312 {
313 /* `current-input-method' is buffer local. So, remeber it in
314 INPUT_METHOD before changing the current buffer. */
315 input_method = Fsymbol_value (Qcurrent_input_method);
316 enable_multibyte = current_buffer->enable_multibyte_characters;
317 }
318
319 /* Switch to the minibuffer. */
320
321 minibuffer = get_minibuffer (minibuf_level);
322 Fset_buffer (minibuffer);
323
324 /* The current buffer's default directory is usually the right thing
325 for our minibuffer here. However, if you're typing a command at
326 a minibuffer-only frame when minibuf_level is zero, then buf IS
327 the current_buffer, so reset_buffer leaves buf's default
328 directory unchanged. This is a bummer when you've just started
329 up Emacs and buf's default directory is Qnil. Here's a hack; can
330 you think of something better to do? Find another buffer with a
331 better directory, and use that one instead. */
332 if (STRINGP (ambient_dir))
333 current_buffer->directory = ambient_dir;
334 else
335 {
336 Lisp_Object buf_list;
337
338 for (buf_list = Vbuffer_alist;
339 CONSP (buf_list);
340 buf_list = XCONS (buf_list)->cdr)
341 {
342 Lisp_Object other_buf;
343
344 other_buf = XCONS (XCONS (buf_list)->car)->cdr;
345 if (STRINGP (XBUFFER (other_buf)->directory))
346 {
347 current_buffer->directory = XBUFFER (other_buf)->directory;
348 break;
349 }
350 }
351 }
352
353 if (XFRAME (mini_frame) != selected_frame)
354 Fredirect_frame_focus (Fselected_frame (), mini_frame);
355
356 Vminibuf_scroll_window = selected_window;
357 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
358 Fselect_window (minibuf_window);
359 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
360
361 Fmake_local_variable (Qprint_escape_newlines);
362 print_escape_newlines = 1;
363
364 /* Erase the buffer. */
365 {
366 int count1 = specpdl_ptr - specpdl;
367 specbind (Qinhibit_read_only, Qt);
368 Ferase_buffer ();
369 unbind_to (count1, Qnil);
370 }
371
372 /* Put in the initial input. */
373 if (!NILP (initial))
374 {
375 Finsert (1, &initial);
376 if (INTEGERP (backup_n))
377 Fforward_char (backup_n);
378 }
379
380 echo_area_glyphs = 0;
381 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
382 previous_echo_glyphs = 0;
383
384 current_buffer->keymap = map;
385
386 /* Turn on an input method stored in INPUT_METHOD if any. */
387 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
388 call1 (Qactivate_input_method, input_method);
389
390 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
391 if (inherit_input_method)
392 current_buffer->enable_multibyte_characters = enable_multibyte;
393
394 /* Run our hook, but not if it is empty.
395 (run-hooks would do nothing if it is empty,
396 but it's important to save time here in the usual case). */
397 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
398 && !NILP (Vrun_hooks))
399 call1 (Vrun_hooks, Qminibuffer_setup_hook);
400
401 /* ??? MCC did redraw_screen here if switching screens. */
402 recursive_edit_1 ();
403
404 /* If cursor is on the minibuffer line,
405 show the user we have exited by putting it in column 0. */
406 if ((FRAME_CURSOR_Y (selected_frame)
407 >= XFASTINT (XWINDOW (minibuf_window)->top))
408 && !noninteractive)
409 {
410 FRAME_CURSOR_X (selected_frame)
411 = FRAME_LEFT_SCROLL_BAR_WIDTH (selected_frame);
412 update_frame (selected_frame, 1, 1);
413 }
414
415 /* Make minibuffer contents into a string. */
416 Fset_buffer (minibuffer);
417 val = make_buffer_string (1, Z, allow_props);
418 #if 0 /* make_buffer_string should handle the gap. */
419 bcopy (GAP_END_ADDR, XSTRING (val)->data + GPT - BEG, Z - GPT);
420 #endif
421
422 /* VAL is the string of minibuffer text. */
423
424 last_minibuf_string = val;
425
426 /* Add the value to the appropriate history list unless it is empty. */
427 if (XSTRING (val)->size != 0
428 && SYMBOLP (Vminibuffer_history_variable)
429 && ! EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
430 {
431 /* If the caller wanted to save the value read on a history list,
432 then do so if the value is not already the front of the list. */
433 Lisp_Object histval;
434 histval = Fsymbol_value (Vminibuffer_history_variable);
435
436 /* The value of the history variable must be a cons or nil. Other
437 values are unacceptable. We silently ignore these values. */
438 if (NILP (histval)
439 || (CONSP (histval)
440 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
441 {
442 Lisp_Object length;
443
444 histval = Fcons (last_minibuf_string, histval);
445 Fset (Vminibuffer_history_variable, histval);
446
447 /* Truncate if requested. */
448 length = Fget (Vminibuffer_history_variable, Qhistory_length);
449 if (NILP (length)) length = Vhistory_length;
450 if (INTEGERP (length))
451 {
452 if (XINT (length) <= 0)
453 Fset (Vminibuffer_history_variable, Qnil);
454 else
455 {
456 Lisp_Object temp;
457
458 temp = Fnthcdr (Fsub1 (length), histval);
459 if (CONSP (temp)) Fsetcdr (temp, Qnil);
460 }
461 }
462 }
463 }
464
465 /* If Lisp form desired instead of string, parse it. */
466 if (expflag)
467 {
468 Lisp_Object expr_and_pos;
469 unsigned char *p;
470 int pos;
471
472 if (STRINGP (val) && XSTRING (val)->size == 0
473 && STRINGP (defalt))
474 val = defalt;
475
476 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
477 pos = XINT (Fcdr (expr_and_pos));
478 if (pos != XSTRING (val)->size)
479 {
480 /* Ignore trailing whitespace; any other trailing junk is an error. */
481 int i;
482 pos = string_char_to_byte (val, pos);
483 for (i = pos; i < STRING_BYTES (XSTRING (val)); i++)
484 {
485 int c = XSTRING (val)->data[i];
486 if (c != ' ' && c != '\t' && c != '\n')
487 error ("Trailing garbage following expression");
488 }
489 }
490 val = Fcar (expr_and_pos);
491 }
492
493 /* The appropriate frame will get selected
494 in set-window-configuration. */
495 RETURN_UNGCPRO (unbind_to (count, val));
496 }
497
498 /* Return a buffer to be used as the minibuffer at depth `depth'.
499 depth = 0 is the lowest allowed argument, and that is the value
500 used for nonrecursive minibuffer invocations */
501
502 Lisp_Object
503 get_minibuffer (depth)
504 int depth;
505 {
506 Lisp_Object tail, num, buf;
507 char name[24];
508 extern Lisp_Object nconc2 ();
509
510 XSETFASTINT (num, depth);
511 tail = Fnthcdr (num, Vminibuffer_list);
512 if (NILP (tail))
513 {
514 tail = Fcons (Qnil, Qnil);
515 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
516 }
517 buf = Fcar (tail);
518 if (NILP (buf) || NILP (XBUFFER (buf)->name))
519 {
520 sprintf (name, " *Minibuf-%d*", depth);
521 buf = Fget_buffer_create (build_string (name));
522
523 /* Although the buffer's name starts with a space, undo should be
524 enabled in it. */
525 Fbuffer_enable_undo (buf);
526
527 XCONS (tail)->car = buf;
528 }
529 else
530 {
531 int count = specpdl_ptr - specpdl;
532
533 reset_buffer (XBUFFER (buf));
534 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
535 Fset_buffer (buf);
536 Fkill_all_local_variables ();
537 unbind_to (count, Qnil);
538 }
539
540 return buf;
541 }
542
543 /* This function is called on exiting minibuffer, whether normally or not,
544 and it restores the current window, buffer, etc. */
545
546 static Lisp_Object
547 read_minibuf_unwind (data)
548 Lisp_Object data;
549 {
550 Lisp_Object old_deactivate_mark;
551 Lisp_Object window;
552
553 /* We are exiting the minibuffer one way or the other,
554 so run the hook. */
555 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
556 && !NILP (Vrun_hooks))
557 safe_run_hooks (Qminibuffer_exit_hook);
558
559 /* If this was a recursive minibuffer,
560 tie the minibuffer window back to the outer level minibuffer buffer. */
561 minibuf_level--;
562
563 window = minibuf_window;
564 /* To keep things predictable, in case it matters, let's be in the minibuffer
565 when we reset the relevant variables. */
566 Fset_buffer (XWINDOW (window)->buffer);
567
568 /* Restore prompt, etc, from outer minibuffer level. */
569 minibuf_prompt = Fcar (minibuf_save_list);
570 minibuf_save_list = Fcdr (minibuf_save_list);
571 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
572 minibuf_save_list = Fcdr (minibuf_save_list);
573 Vhelp_form = Fcar (minibuf_save_list);
574 minibuf_save_list = Fcdr (minibuf_save_list);
575 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
576 minibuf_save_list = Fcdr (minibuf_save_list);
577 Vminibuffer_history_position = Fcar (minibuf_save_list);
578 minibuf_save_list = Fcdr (minibuf_save_list);
579 Vminibuffer_history_variable = Fcar (minibuf_save_list);
580 minibuf_save_list = Fcdr (minibuf_save_list);
581 Voverriding_local_map = Fcar (minibuf_save_list);
582 minibuf_save_list = Fcdr (minibuf_save_list);
583 #if 0
584 temp = Fcar (minibuf_save_list);
585 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
586 minibuf_window = temp;
587 #endif
588 minibuf_save_list = Fcdr (minibuf_save_list);
589
590 /* Erase the minibuffer we were using at this level. */
591 {
592 int count = specpdl_ptr - specpdl;
593 /* Prevent error in erase-buffer. */
594 specbind (Qinhibit_read_only, Qt);
595 old_deactivate_mark = Vdeactivate_mark;
596 Ferase_buffer ();
597 Vdeactivate_mark = old_deactivate_mark;
598 unbind_to (count, Qnil);
599 }
600
601 /* Make sure minibuffer window is erased, not ignored. */
602 windows_or_buffers_changed++;
603 XSETFASTINT (XWINDOW (window)->last_modified, 0);
604 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
605
606 return Qnil;
607 }
608 \f
609
610 /* This comment supplies the doc string for read-from-minibuffer,
611 for make-docfile to see. We cannot put this in the real DEFUN
612 due to limits in the Unix cpp.
613
614 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
615 "Read a string from the minibuffer, prompting with string PROMPT.\n\
616 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
617 to be inserted into the minibuffer before reading input.\n\
618 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
619 is STRING, but point is placed at position POSITION in the minibuffer.\n\
620 Third arg KEYMAP is a keymap to use whilst reading;\n\
621 if omitted or nil, the default is `minibuffer-local-map'.\n\
622 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
623 and return that object:\n\
624 in other words, do `(car (read-from-string INPUT-STRING))'\n\
625 Fifth arg HIST, if non-nil, specifies a history list\n\
626 and optionally the initial position in the list.\n\
627 It can be a symbol, which is the history list variable to use,\n\
628 or it can be a cons cell (HISTVAR . HISTPOS).\n\
629 In that case, HISTVAR is the history list variable to use,\n\
630 and HISTPOS is the initial position (the position in the list\n\
631 which INITIAL-CONTENTS corresponds to).\n\
632 Positions are counted starting from 1 at the beginning of the list.\n\
633 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
634 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
635 if the user enters empty input! It returns the empty string.\n\
636 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
637 the current input method and the setting of enable-multibyte-characters.\n\
638 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
639 then the string which is returned includes whatever text properties\n\
640 were present in the minibuffer. Otherwise the value has no text properties.")
641 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
642 */
643
644 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
645 0 /* See immediately above */)
646 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
647 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
648 Lisp_Object inherit_input_method;
649 {
650 int pos = 0;
651 Lisp_Object histvar, histpos, position, val;
652 struct gcpro gcpro1;
653
654 position = Qnil;
655
656 CHECK_STRING (prompt, 0);
657 if (!NILP (initial_contents))
658 {
659 if (CONSP (initial_contents))
660 {
661 position = Fcdr (initial_contents);
662 initial_contents = Fcar (initial_contents);
663 }
664 CHECK_STRING (initial_contents, 1);
665 if (!NILP (position))
666 {
667 CHECK_NUMBER (position, 0);
668 /* Convert to distance from end of input. */
669 if (XINT (position) < 1)
670 /* A number too small means the beginning of the string. */
671 pos = - XSTRING (initial_contents)->size;
672 else
673 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
674 }
675 }
676
677 if (NILP (keymap))
678 keymap = Vminibuffer_local_map;
679 else
680 keymap = get_keymap (keymap);
681
682 if (SYMBOLP (hist))
683 {
684 histvar = hist;
685 histpos = Qnil;
686 }
687 else
688 {
689 histvar = Fcar_safe (hist);
690 histpos = Fcdr_safe (hist);
691 }
692 if (NILP (histvar))
693 histvar = Qminibuffer_history;
694 if (NILP (histpos))
695 XSETFASTINT (histpos, 0);
696
697 GCPRO1 (default_value);
698 val = read_minibuf (keymap, initial_contents, prompt,
699 make_number (pos), !NILP (read),
700 histvar, histpos, default_value,
701 minibuffer_allow_text_properties,
702 !NILP (inherit_input_method));
703 UNGCPRO;
704 return val;
705 }
706
707 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
708 "Return a Lisp object read using the minibuffer.\n\
709 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
710 is a string to insert in the minibuffer before reading.")
711 (prompt, initial_contents)
712 Lisp_Object prompt, initial_contents;
713 {
714 CHECK_STRING (prompt, 0);
715 if (!NILP (initial_contents))
716 CHECK_STRING (initial_contents, 1);
717 return read_minibuf (Vminibuffer_local_map, initial_contents,
718 prompt, Qnil, 1, Qminibuffer_history,
719 make_number (0), Qnil, 0, 0);
720 }
721
722 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
723 "Return value of Lisp expression read using the minibuffer.\n\
724 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
725 is a string to insert in the minibuffer before reading.")
726 (prompt, initial_contents)
727 Lisp_Object prompt, initial_contents;
728 {
729 return Feval (Fread_minibuffer (prompt, initial_contents));
730 }
731
732 /* Functions that use the minibuffer to read various things. */
733
734 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
735 "Read a string from the minibuffer, prompting with string PROMPT.\n\
736 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
737 The third arg HISTORY, if non-nil, specifies a history list\n\
738 and optionally the initial position in the list.\n\
739 See `read-from-minibuffer' for details of HISTORY argument.\n\
740 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
741 for history commands, and as the value to return if the user enters\n\
742 the empty string.\n\
743 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
744 the current input method and the setting of enable-multibyte-characters.")
745 (prompt, initial_input, history, default_value, inherit_input_method)
746 Lisp_Object prompt, initial_input, history, default_value;
747 Lisp_Object inherit_input_method;
748 {
749 Lisp_Object val;
750 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
751 Qnil, history, default_value,
752 inherit_input_method);
753 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (default_value))
754 val = default_value;
755 return val;
756 }
757
758 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
759 "Read a string from the terminal, not allowing blanks.\n\
760 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
761 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
762 the current input method and the setting of enable-multibyte-characters.")
763 (prompt, initial, inherit_input_method)
764 Lisp_Object prompt, initial, inherit_input_method;
765 {
766 CHECK_STRING (prompt, 0);
767 if (! NILP (initial))
768 CHECK_STRING (initial, 1);
769
770 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
771 0, Qminibuffer_history, make_number (0), Qnil, 0,
772 !NILP (inherit_input_method));
773 }
774
775 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
776 "Read the name of a command and return as a symbol.\n\
777 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
778 (prompt, default_value)
779 Lisp_Object prompt, default_value;
780 {
781 Lisp_Object name, default_string;
782
783 if (NILP (default_value))
784 default_string = Qnil;
785 else if (SYMBOLP (default_value))
786 XSETSTRING (default_string, XSYMBOL (default_value)->name);
787 else
788 default_string = default_value;
789
790 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
791 Qnil, Qnil, default_string, Qnil);
792 if (NILP (name))
793 return name;
794 return Fintern (name, Qnil);
795 }
796
797 #ifdef NOTDEF
798 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
799 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
800 Prompts with PROMPT.")
801 (prompt)
802 Lisp_Object prompt;
803 {
804 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
805 Qnil);
806 }
807 #endif /* NOTDEF */
808
809 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
810 "Read the name of a user variable and return it as a symbol.\n\
811 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
812 A user variable is one whose documentation starts with a `*' character.")
813 (prompt, default_value)
814 Lisp_Object prompt, default_value;
815 {
816 Lisp_Object name, default_string;
817
818 if (NILP (default_value))
819 default_string = Qnil;
820 else if (SYMBOLP (default_value))
821 XSETSTRING (default_string, XSYMBOL (default_value)->name);
822 else
823 default_string = default_value;
824
825 name = Fcompleting_read (prompt, Vobarray,
826 Quser_variable_p, Qt,
827 Qnil, Qnil, default_string, Qnil);
828 if (NILP (name))
829 return name;
830 return Fintern (name, Qnil);
831 }
832
833 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
834 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
835 Prompts with PROMPT.\n\
836 Optional second arg DEF is value to return if user enters an empty line.\n\
837 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
838 (prompt, def, require_match)
839 Lisp_Object prompt, def, require_match;
840 {
841 Lisp_Object tem;
842 Lisp_Object args[4];
843
844 if (BUFFERP (def))
845 def = XBUFFER (def)->name;
846
847 if (NILP (Vread_buffer_function))
848 {
849 if (!NILP (def))
850 {
851 args[0] = build_string ("%s(default %s) ");
852 args[1] = prompt;
853 args[2] = def;
854 prompt = Fformat (3, args);
855 }
856
857 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
858 require_match, Qnil, Qnil, def, Qnil);
859 }
860 else
861 {
862 args[0] = Vread_buffer_function;
863 args[1] = prompt;
864 args[2] = def;
865 args[3] = require_match;
866 return Ffuncall(4, args);
867 }
868 }
869 \f
870 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
871 "Return common substring of all completions of STRING in ALIST.\n\
872 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
873 All that match are compared together; the longest initial sequence\n\
874 common to all matches is returned as a string.\n\
875 If there is no match at all, nil is returned.\n\
876 For an exact match, t is returned.\n\
877 \n\
878 ALIST can be an obarray instead of an alist.\n\
879 Then the print names of all symbols in the obarray are the possible matches.\n\
880 \n\
881 ALIST can also be a function to do the completion itself.\n\
882 It receives three arguments: the values STRING, PREDICATE and nil.\n\
883 Whatever it returns becomes the value of `try-completion'.\n\
884 \n\
885 If optional third argument PREDICATE is non-nil,\n\
886 it is used to test each possible match.\n\
887 The match is a candidate only if PREDICATE returns non-nil.\n\
888 The argument given to PREDICATE is the alist element\n\
889 or the symbol from the obarray.")
890 (string, alist, predicate)
891 Lisp_Object string, alist, predicate;
892 {
893 Lisp_Object bestmatch, tail, elt, eltstring;
894 /* Size in bytes of BESTMATCH. */
895 int bestmatchsize;
896 /* These are in bytes, too. */
897 int compare, matchsize;
898 int list = CONSP (alist) || NILP (alist);
899 int index, obsize;
900 int matchcount = 0;
901 Lisp_Object bucket, zero, end, tem;
902 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
903
904 CHECK_STRING (string, 0);
905 if (!list && !VECTORP (alist))
906 return call3 (alist, string, predicate, Qnil);
907
908 bestmatch = Qnil;
909
910 /* If ALIST is not a list, set TAIL just for gc pro. */
911 tail = alist;
912 if (! list)
913 {
914 index = 0;
915 obsize = XVECTOR (alist)->size;
916 bucket = XVECTOR (alist)->contents[index];
917 }
918
919 while (1)
920 {
921 /* Get the next element of the alist or obarray. */
922 /* Exit the loop if the elements are all used up. */
923 /* elt gets the alist element or symbol.
924 eltstring gets the name to check as a completion. */
925
926 if (list)
927 {
928 if (NILP (tail))
929 break;
930 elt = Fcar (tail);
931 eltstring = Fcar (elt);
932 tail = Fcdr (tail);
933 }
934 else
935 {
936 if (XFASTINT (bucket) != 0)
937 {
938 elt = bucket;
939 eltstring = Fsymbol_name (elt);
940 if (XSYMBOL (bucket)->next)
941 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
942 else
943 XSETFASTINT (bucket, 0);
944 }
945 else if (++index >= obsize)
946 break;
947 else
948 {
949 bucket = XVECTOR (alist)->contents[index];
950 continue;
951 }
952 }
953
954 /* Is this element a possible completion? */
955
956 if (STRINGP (eltstring)
957 && STRING_BYTES (XSTRING (string)) <= STRING_BYTES (XSTRING (eltstring))
958 && (tem = Fcompare_strings (eltstring, make_number (0),
959 make_number (XSTRING (string)->size),
960 string, make_number (0), Qnil,
961 completion_ignore_case ?Qt : Qnil),
962 EQ (Qt, tem)))
963 {
964 /* Yes. */
965 Lisp_Object regexps;
966 Lisp_Object zero;
967 XSETFASTINT (zero, 0);
968
969 /* Ignore this element if it fails to match all the regexps. */
970 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
971 regexps = XCONS (regexps)->cdr)
972 {
973 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
974 if (NILP (tem))
975 break;
976 }
977 if (CONSP (regexps))
978 continue;
979
980 /* Ignore this element if there is a predicate
981 and the predicate doesn't like it. */
982
983 if (!NILP (predicate))
984 {
985 if (EQ (predicate, Qcommandp))
986 tem = Fcommandp (elt);
987 else
988 {
989 GCPRO4 (tail, string, eltstring, bestmatch);
990 tem = call1 (predicate, elt);
991 UNGCPRO;
992 }
993 if (NILP (tem)) continue;
994 }
995
996 /* Update computation of how much all possible completions match */
997
998 matchcount++;
999 if (NILP (bestmatch))
1000 {
1001 bestmatch = eltstring;
1002 bestmatchsize = XSTRING (eltstring)->size;
1003 }
1004 else
1005 {
1006 compare = min (bestmatchsize, XSTRING (eltstring)->size);
1007 tem = Fcompare_strings (bestmatch, make_number (0),
1008 make_number (compare),
1009 eltstring, make_number (0),
1010 make_number (compare),
1011 completion_ignore_case ? Qt : Qnil);
1012 if (EQ (tem, Qt))
1013 matchsize = compare;
1014 else if (XINT (tem) < 0)
1015 matchsize = - XINT (tem) - 1;
1016 else
1017 matchsize = XINT (tem) - 1;
1018
1019 if (matchsize < 0)
1020 matchsize = compare;
1021 if (completion_ignore_case)
1022 {
1023 /* If this is an exact match except for case,
1024 use it as the best match rather than one that is not an
1025 exact match. This way, we get the case pattern
1026 of the actual match. */
1027 if ((matchsize == XSTRING (eltstring)->size
1028 && matchsize < XSTRING (bestmatch)->size)
1029 ||
1030 /* If there is more than one exact match ignoring case,
1031 and one of them is exact including case,
1032 prefer that one. */
1033 /* If there is no exact match ignoring case,
1034 prefer a match that does not change the case
1035 of the input. */
1036 ((matchsize == XSTRING (eltstring)->size)
1037 ==
1038 (matchsize == XSTRING (bestmatch)->size)
1039 && (tem = Fcompare_strings (eltstring, make_number (0),
1040 make_number (XSTRING (string)->size),
1041 string, make_number (0),
1042 Qnil,
1043 Qnil),
1044 EQ (Qt, tem))
1045 && (tem = Fcompare_strings (bestmatch, make_number (0),
1046 make_number (XSTRING (string)->size),
1047 string, make_number (0),
1048 Qnil,
1049 Qnil),
1050 ! EQ (Qt, tem))))
1051 bestmatch = eltstring;
1052 }
1053 bestmatchsize = matchsize;
1054 }
1055 }
1056 }
1057
1058 if (NILP (bestmatch))
1059 return Qnil; /* No completions found */
1060 /* If we are ignoring case, and there is no exact match,
1061 and no additional text was supplied,
1062 don't change the case of what the user typed. */
1063 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
1064 && XSTRING (bestmatch)->size > bestmatchsize)
1065 return string;
1066
1067 /* Return t if the supplied string is an exact match (counting case);
1068 it does not require any change to be made. */
1069 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
1070 && (tem = Fcompare_strings (bestmatch, make_number (0),
1071 make_number (bestmatchsize),
1072 string, make_number (0),
1073 make_number (bestmatchsize),
1074 Qnil),
1075 EQ (Qt, tem)))
1076 return Qt;
1077
1078 XSETFASTINT (zero, 0); /* Else extract the part in which */
1079 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1080 return Fsubstring (bestmatch, zero, end);
1081 }
1082
1083 /* Compare exactly LEN chars of strings at S1 and S2,
1084 ignoring case if appropriate.
1085 Return -1 if strings match,
1086 else number of chars that match at the beginning. */
1087
1088 int
1089 scmp (s1, s2, len)
1090 register unsigned char *s1, *s2;
1091 int len;
1092 {
1093 register int l = len;
1094 register unsigned char *start = s1;
1095
1096 if (completion_ignore_case)
1097 {
1098 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
1099 l--;
1100 }
1101 else
1102 {
1103 while (l && *s1++ == *s2++)
1104 l--;
1105 }
1106 if (l == 0)
1107 return -1;
1108 else
1109 {
1110 int match = len - l;
1111
1112 /* Now *--S1 is the unmatching byte. If it is in the middle of
1113 multi-byte form, we must say that the multi-byte character
1114 there doesn't match. */
1115 while (match && *--s1 >= 0xA0) match--;
1116 return match;
1117 }
1118 }
1119 \f
1120 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1121 "Search for partial matches to STRING in ALIST.\n\
1122 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1123 The value is a list of all the strings from ALIST that match.\n\
1124 \n\
1125 ALIST can be an obarray instead of an alist.\n\
1126 Then the print names of all symbols in the obarray are the possible matches.\n\
1127 \n\
1128 ALIST can also be a function to do the completion itself.\n\
1129 It receives three arguments: the values STRING, PREDICATE and t.\n\
1130 Whatever it returns becomes the value of `all-completion'.\n\
1131 \n\
1132 If optional third argument PREDICATE is non-nil,\n\
1133 it is used to test each possible match.\n\
1134 The match is a candidate only if PREDICATE returns non-nil.\n\
1135 The argument given to PREDICATE is the alist element\n\
1136 or the symbol from the obarray.\n\
1137 \n\
1138 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1139 strings in ALIST that start with a space\n\
1140 are ignored unless STRING itself starts with a space.")
1141 (string, alist, predicate, hide_spaces)
1142 Lisp_Object string, alist, predicate, hide_spaces;
1143 {
1144 Lisp_Object tail, elt, eltstring;
1145 Lisp_Object allmatches;
1146 int list = CONSP (alist) || NILP (alist);
1147 int index, obsize;
1148 Lisp_Object bucket, tem;
1149 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1150
1151 CHECK_STRING (string, 0);
1152 if (!list && !VECTORP (alist))
1153 {
1154 return call3 (alist, string, predicate, Qt);
1155 }
1156 allmatches = Qnil;
1157
1158 /* If ALIST is not a list, set TAIL just for gc pro. */
1159 tail = alist;
1160 if (! list)
1161 {
1162 index = 0;
1163 obsize = XVECTOR (alist)->size;
1164 bucket = XVECTOR (alist)->contents[index];
1165 }
1166
1167 while (1)
1168 {
1169 /* Get the next element of the alist or obarray. */
1170 /* Exit the loop if the elements are all used up. */
1171 /* elt gets the alist element or symbol.
1172 eltstring gets the name to check as a completion. */
1173
1174 if (list)
1175 {
1176 if (NILP (tail))
1177 break;
1178 elt = Fcar (tail);
1179 eltstring = Fcar (elt);
1180 tail = Fcdr (tail);
1181 }
1182 else
1183 {
1184 if (XFASTINT (bucket) != 0)
1185 {
1186 elt = bucket;
1187 eltstring = Fsymbol_name (elt);
1188 if (XSYMBOL (bucket)->next)
1189 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1190 else
1191 XSETFASTINT (bucket, 0);
1192 }
1193 else if (++index >= obsize)
1194 break;
1195 else
1196 {
1197 bucket = XVECTOR (alist)->contents[index];
1198 continue;
1199 }
1200 }
1201
1202 /* Is this element a possible completion? */
1203
1204 if (STRINGP (eltstring)
1205 && STRING_BYTES (XSTRING (string)) <= STRING_BYTES (XSTRING (eltstring))
1206 /* If HIDE_SPACES, reject alternatives that start with space
1207 unless the input starts with space. */
1208 && ((STRING_BYTES (XSTRING (string)) > 0
1209 && XSTRING (string)->data[0] == ' ')
1210 || XSTRING (eltstring)->data[0] != ' '
1211 || NILP (hide_spaces))
1212 && (tem = Fcompare_strings (eltstring, make_number (0),
1213 make_number (XSTRING (string)->size),
1214 string, make_number (0),
1215 make_number (XSTRING (string)->size),
1216 completion_ignore_case ? Qt : Qnil),
1217 EQ (Qt, tem)))
1218 {
1219 /* Yes. */
1220 Lisp_Object regexps;
1221 Lisp_Object zero;
1222 XSETFASTINT (zero, 0);
1223
1224 /* Ignore this element if it fails to match all the regexps. */
1225 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1226 regexps = XCONS (regexps)->cdr)
1227 {
1228 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
1229 if (NILP (tem))
1230 break;
1231 }
1232 if (CONSP (regexps))
1233 continue;
1234
1235 /* Ignore this element if there is a predicate
1236 and the predicate doesn't like it. */
1237
1238 if (!NILP (predicate))
1239 {
1240 if (EQ (predicate, Qcommandp))
1241 tem = Fcommandp (elt);
1242 else
1243 {
1244 GCPRO4 (tail, eltstring, allmatches, string);
1245 tem = call1 (predicate, elt);
1246 UNGCPRO;
1247 }
1248 if (NILP (tem)) continue;
1249 }
1250 /* Ok => put it on the list. */
1251 allmatches = Fcons (eltstring, allmatches);
1252 }
1253 }
1254
1255 return Fnreverse (allmatches);
1256 }
1257 \f
1258 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1259 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1260 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1261
1262 /* This comment supplies the doc string for completing-read,
1263 for make-docfile to see. We cannot put this in the real DEFUN
1264 due to limits in the Unix cpp.
1265
1266 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1267 "Read a string in the minibuffer, with completion.\n\
1268 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1269 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1270 PREDICATE limits completion to a subset of TABLE.\n\
1271 See `try-completion' and `all-completions' for more details
1272 on completion, TABLE, and PREDICATE.\n\
1273 \n\
1274 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1275 the input is (or completes to) an element of TABLE or is null.\n\
1276 If it is also not t, Return does not exit if it does non-null completion.\n\
1277 If the input is null, `completing-read' returns an empty string,\n\
1278 regardless of the value of REQUIRE-MATCH.\n\
1279 \n\
1280 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1281 If it is (STRING . POSITION), the initial input\n\
1282 is STRING, but point is placed POSITION characters into the string.\n\
1283 HIST, if non-nil, specifies a history list\n\
1284 and optionally the initial position in the list.\n\
1285 It can be a symbol, which is the history list variable to use,\n\
1286 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1287 In that case, HISTVAR is the history list variable to use,\n\
1288 and HISTPOS is the initial position (the position in the list\n\
1289 which INITIAL-INPUT corresponds to).\n\
1290 Positions are counted starting from 1 at the beginning of the list.\n\
1291 DEF, if non-nil, is the default value.\n\
1292 \n\
1293 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1294 the current input method and the setting of enable-multibyte-characters.\n\
1295 \n\
1296 Completion ignores case if the ambient value of\n\
1297 `completion-ignore-case' is non-nil."
1298 */
1299 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1300 0 /* See immediately above */)
1301 (prompt, table, predicate, require_match, init, hist, def, inherit_input_method)
1302 Lisp_Object prompt, table, predicate, require_match, init, hist, def;
1303 Lisp_Object inherit_input_method;
1304 {
1305 Lisp_Object val, histvar, histpos, position;
1306 int pos = 0;
1307 int count = specpdl_ptr - specpdl;
1308 struct gcpro gcpro1;
1309 int disable_multibyte = EQ (table, Qread_file_name_internal);
1310
1311 GCPRO1 (def);
1312
1313 specbind (Qminibuffer_completion_table, table);
1314 specbind (Qminibuffer_completion_predicate, predicate);
1315 specbind (Qminibuffer_completion_confirm,
1316 EQ (require_match, Qt) ? Qnil : Qt);
1317 last_exact_completion = Qnil;
1318
1319 position = Qnil;
1320 if (!NILP (init))
1321 {
1322 if (CONSP (init))
1323 {
1324 position = Fcdr (init);
1325 init = Fcar (init);
1326 }
1327 CHECK_STRING (init, 0);
1328 if (!NILP (position))
1329 {
1330 CHECK_NUMBER (position, 0);
1331 /* Convert to distance from end of input. */
1332 pos = XINT (position) - XSTRING (init)->size;
1333 }
1334 }
1335
1336 if (SYMBOLP (hist))
1337 {
1338 histvar = hist;
1339 histpos = Qnil;
1340 }
1341 else
1342 {
1343 histvar = Fcar_safe (hist);
1344 histpos = Fcdr_safe (hist);
1345 }
1346 if (NILP (histvar))
1347 histvar = Qminibuffer_history;
1348 if (NILP (histpos))
1349 XSETFASTINT (histpos, 0);
1350
1351 val = read_minibuf (NILP (require_match)
1352 ? Vminibuffer_local_completion_map
1353 : Vminibuffer_local_must_match_map,
1354 init, prompt, make_number (pos), 0,
1355 histvar, histpos, def, 0,
1356 !NILP (inherit_input_method));
1357
1358 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (def))
1359 val = def;
1360
1361 RETURN_UNGCPRO (unbind_to (count, val));
1362 }
1363 \f
1364 Lisp_Object Fminibuffer_completion_help ();
1365 Lisp_Object assoc_for_completion ();
1366
1367 /* Test whether TXT is an exact completion. */
1368 Lisp_Object
1369 test_completion (txt)
1370 Lisp_Object txt;
1371 {
1372 Lisp_Object tem;
1373
1374 if (CONSP (Vminibuffer_completion_table)
1375 || NILP (Vminibuffer_completion_table))
1376 return assoc_for_completion (txt, Vminibuffer_completion_table);
1377 else if (VECTORP (Vminibuffer_completion_table))
1378 {
1379 /* Bypass intern-soft as that loses for nil */
1380 tem = oblookup (Vminibuffer_completion_table,
1381 XSTRING (txt)->data,
1382 XSTRING (txt)->size,
1383 STRING_BYTES (XSTRING (txt)));
1384 if (!SYMBOLP (tem))
1385 return Qnil;
1386 else if (!NILP (Vminibuffer_completion_predicate))
1387 return call1 (Vminibuffer_completion_predicate, tem);
1388 else
1389 return Qt;
1390 }
1391 else
1392 return call3 (Vminibuffer_completion_table, txt,
1393 Vminibuffer_completion_predicate, Qlambda);
1394 }
1395
1396 /* returns:
1397 * 0 no possible completion
1398 * 1 was already an exact and unique completion
1399 * 3 was already an exact completion
1400 * 4 completed to an exact completion
1401 * 5 some completion happened
1402 * 6 no completion happened
1403 */
1404 int
1405 do_completion ()
1406 {
1407 Lisp_Object completion, tem;
1408 int completedp;
1409 Lisp_Object last;
1410 struct gcpro gcpro1, gcpro2;
1411
1412 completion = Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table,
1413 Vminibuffer_completion_predicate);
1414 last = last_exact_completion;
1415 last_exact_completion = Qnil;
1416
1417 GCPRO2 (completion, last);
1418
1419 if (NILP (completion))
1420 {
1421 bitch_at_user ();
1422 temp_echo_area_glyphs (" [No match]");
1423 UNGCPRO;
1424 return 0;
1425 }
1426
1427 if (EQ (completion, Qt)) /* exact and unique match */
1428 {
1429 UNGCPRO;
1430 return 1;
1431 }
1432
1433 /* compiler bug */
1434 tem = Fstring_equal (completion, Fbuffer_string());
1435 if (completedp = NILP (tem))
1436 {
1437 Ferase_buffer (); /* Some completion happened */
1438 Finsert (1, &completion);
1439 }
1440
1441 /* It did find a match. Do we match some possibility exactly now? */
1442 tem = test_completion (Fbuffer_string ());
1443 if (NILP (tem))
1444 {
1445 /* not an exact match */
1446 UNGCPRO;
1447 if (completedp)
1448 return 5;
1449 else if (auto_help)
1450 Fminibuffer_completion_help ();
1451 else
1452 temp_echo_area_glyphs (" [Next char not unique]");
1453 return 6;
1454 }
1455 else if (completedp)
1456 {
1457 UNGCPRO;
1458 return 4;
1459 }
1460 /* If the last exact completion and this one were the same,
1461 it means we've already given a "Complete but not unique"
1462 message and the user's hit TAB again, so now we give him help. */
1463 last_exact_completion = completion;
1464 if (!NILP (last))
1465 {
1466 tem = Fbuffer_string ();
1467 if (!NILP (Fequal (tem, last)))
1468 Fminibuffer_completion_help ();
1469 }
1470 UNGCPRO;
1471 return 3;
1472 }
1473
1474 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1475
1476 Lisp_Object
1477 assoc_for_completion (key, list)
1478 register Lisp_Object key;
1479 Lisp_Object list;
1480 {
1481 register Lisp_Object tail;
1482
1483 if (completion_ignore_case)
1484 key = Fupcase (key);
1485
1486 for (tail = list; !NILP (tail); tail = Fcdr (tail))
1487 {
1488 register Lisp_Object elt, tem, thiscar;
1489 elt = Fcar (tail);
1490 if (!CONSP (elt)) continue;
1491 thiscar = Fcar (elt);
1492 if (!STRINGP (thiscar))
1493 continue;
1494 if (completion_ignore_case)
1495 thiscar = Fupcase (thiscar);
1496 tem = Fequal (thiscar, key);
1497 if (!NILP (tem)) return elt;
1498 QUIT;
1499 }
1500 return Qnil;
1501 }
1502
1503 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
1504 "Complete the minibuffer contents as far as possible.\n\
1505 Return nil if there is no valid completion, else t.\n\
1506 If no characters can be completed, display a list of possible completions.\n\
1507 If you repeat this command after it displayed such a list,\n\
1508 scroll the window of possible completions.")
1509 ()
1510 {
1511 register int i;
1512 Lisp_Object window, tem;
1513
1514 /* If the previous command was not this, then mark the completion
1515 buffer obsolete. */
1516 if (! EQ (current_kboard->Vlast_command, this_command))
1517 Vminibuf_scroll_window = Qnil;
1518
1519 window = Vminibuf_scroll_window;
1520 /* If there's a fresh completion window with a live buffer,
1521 and this command is repeated, scroll that window. */
1522 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1523 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1524 {
1525 struct buffer *obuf = current_buffer;
1526
1527 Fset_buffer (XWINDOW (window)->buffer);
1528 tem = Fpos_visible_in_window_p (make_number (ZV), window);
1529 if (! NILP (tem))
1530 /* If end is in view, scroll up to the beginning. */
1531 Fset_window_start (window, make_number (BEGV), Qnil);
1532 else
1533 /* Else scroll down one screen. */
1534 Fscroll_other_window (Qnil);
1535
1536 set_buffer_internal (obuf);
1537 return Qnil;
1538 }
1539
1540 i = do_completion ();
1541 switch (i)
1542 {
1543 case 0:
1544 return Qnil;
1545
1546 case 1:
1547 temp_echo_area_glyphs (" [Sole completion]");
1548 break;
1549
1550 case 3:
1551 temp_echo_area_glyphs (" [Complete, but not unique]");
1552 break;
1553 }
1554
1555 return Qt;
1556 }
1557 \f
1558 /* Subroutines of Fminibuffer_complete_and_exit. */
1559
1560 /* This one is called by internal_condition_case to do the real work. */
1561
1562 Lisp_Object
1563 complete_and_exit_1 ()
1564 {
1565 return make_number (do_completion ());
1566 }
1567
1568 /* This one is called by internal_condition_case if an error happens.
1569 Pretend the current value is an exact match. */
1570
1571 Lisp_Object
1572 complete_and_exit_2 (ignore)
1573 Lisp_Object ignore;
1574 {
1575 return make_number (1);
1576 }
1577
1578 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1579 Sminibuffer_complete_and_exit, 0, 0, "",
1580 "If the minibuffer contents is a valid completion then exit.\n\
1581 Otherwise try to complete it. If completion leads to a valid completion,\n\
1582 a repetition of this command will exit.")
1583 ()
1584 {
1585 register int i;
1586 Lisp_Object val;
1587
1588 /* Allow user to specify null string */
1589 if (BEGV == ZV)
1590 goto exit;
1591
1592 if (!NILP (test_completion (Fbuffer_string ())))
1593 goto exit;
1594
1595 /* Call do_completion, but ignore errors. */
1596 val = internal_condition_case (complete_and_exit_1, Qerror,
1597 complete_and_exit_2);
1598
1599 i = XFASTINT (val);
1600 switch (i)
1601 {
1602 case 1:
1603 case 3:
1604 goto exit;
1605
1606 case 4:
1607 if (!NILP (Vminibuffer_completion_confirm))
1608 {
1609 temp_echo_area_glyphs (" [Confirm]");
1610 return Qnil;
1611 }
1612 else
1613 goto exit;
1614
1615 default:
1616 return Qnil;
1617 }
1618 exit:
1619 Fthrow (Qexit, Qnil);
1620 /* NOTREACHED */
1621 }
1622
1623 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1624 0, 0, "",
1625 "Complete the minibuffer contents at most a single word.\n\
1626 After one word is completed as much as possible, a space or hyphen\n\
1627 is added, provided that matches some possible completion.\n\
1628 Return nil if there is no valid completion, else t.")
1629 ()
1630 {
1631 Lisp_Object completion, tem, tem1;
1632 register int i, i_byte;
1633 register unsigned char *completion_string;
1634 struct gcpro gcpro1, gcpro2;
1635
1636 /* We keep calling Fbuffer_string rather than arrange for GC to
1637 hold onto a pointer to one of the strings thus made. */
1638
1639 completion = Ftry_completion (Fbuffer_string (),
1640 Vminibuffer_completion_table,
1641 Vminibuffer_completion_predicate);
1642 if (NILP (completion))
1643 {
1644 bitch_at_user ();
1645 temp_echo_area_glyphs (" [No match]");
1646 return Qnil;
1647 }
1648 if (EQ (completion, Qt))
1649 return Qnil;
1650
1651 #if 0 /* How the below code used to look, for reference. */
1652 tem = Fbuffer_string ();
1653 b = XSTRING (tem)->data;
1654 i = ZV - 1 - XSTRING (completion)->size;
1655 p = XSTRING (completion)->data;
1656 if (i > 0 ||
1657 0 <= scmp (b, p, ZV - 1))
1658 {
1659 i = 1;
1660 /* Set buffer to longest match of buffer tail and completion head. */
1661 while (0 <= scmp (b + i, p, ZV - 1 - i))
1662 i++;
1663 del_range (1, i + 1);
1664 SET_PT (ZV);
1665 }
1666 #else /* Rewritten code */
1667 {
1668 int buffer_nchars, completion_nchars;
1669
1670 CHECK_STRING (completion, 0);
1671 tem = Fbuffer_string ();
1672 GCPRO2 (completion, tem);
1673 /* If reading a file name,
1674 expand any $ENVVAR refs in the buffer and in TEM. */
1675 if (EQ (Vminibuffer_completion_table, Qread_file_name_internal))
1676 {
1677 Lisp_Object substituted;
1678 substituted = Fsubstitute_in_file_name (tem);
1679 if (! EQ (substituted, tem))
1680 {
1681 tem = substituted;
1682 Ferase_buffer ();
1683 insert_from_string (tem, 0, 0, XSTRING (tem)->size,
1684 STRING_BYTES (XSTRING (tem)), 0);
1685 }
1686 }
1687 buffer_nchars = XSTRING (tem)->size; /* ie ZV - BEGV */
1688 completion_nchars = XSTRING (completion)->size;
1689 i = buffer_nchars - completion_nchars;
1690 if (i > 0
1691 ||
1692 (tem1 = Fcompare_strings (tem, make_number (0),
1693 make_number (buffer_nchars),
1694 completion, make_number (0),
1695 make_number (buffer_nchars),
1696 completion_ignore_case ? Qt : Qnil),
1697 ! EQ (tem1, Qt)))
1698 {
1699 int start_pos;
1700
1701 /* Set buffer to longest match of buffer tail and completion head. */
1702 if (i <= 0) i = 1;
1703 start_pos= i;
1704 buffer_nchars -= i;
1705 while (1)
1706 {
1707 tem1 = Fcompare_strings (tem, make_number (start_pos),
1708 make_number (buffer_nchars + start_pos),
1709 completion, make_number (0),
1710 make_number (buffer_nchars),
1711 completion_ignore_case ? Qt : Qnil);
1712 start_pos++;
1713 if (EQ (tem1, Qt))
1714 break;
1715 i++;
1716 }
1717 del_range (1, i + 1);
1718 SET_PT_BOTH (ZV, ZV_BYTE);
1719 }
1720 UNGCPRO;
1721 }
1722 #endif /* Rewritten code */
1723 i_byte = ZV_BYTE - BEGV_BYTE;
1724 i = ZV - BEGV;
1725
1726 /* If completion finds next char not unique,
1727 consider adding a space or a hyphen. */
1728 if (i == XSTRING (completion)->size)
1729 {
1730 GCPRO1 (completion);
1731 tem = Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1732 Vminibuffer_completion_table,
1733 Vminibuffer_completion_predicate);
1734 UNGCPRO;
1735
1736 if (STRINGP (tem))
1737 completion = tem;
1738 else
1739 {
1740 GCPRO1 (completion);
1741 tem =
1742 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1743 Vminibuffer_completion_table,
1744 Vminibuffer_completion_predicate);
1745 UNGCPRO;
1746
1747 if (STRINGP (tem))
1748 completion = tem;
1749 }
1750 }
1751
1752 /* Now find first word-break in the stuff found by completion.
1753 i gets index in string of where to stop completing. */
1754 {
1755 int len, c;
1756
1757 completion_string = XSTRING (completion)->data;
1758 for (; i_byte < STRING_BYTES (XSTRING (completion)); i_byte += len, i++)
1759 {
1760 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
1761 XSTRING (completion)->size - i_byte,
1762 len);
1763 if (SYNTAX (c) != Sword)
1764 {
1765 i_byte += len;
1766 i++;
1767 break;
1768 }
1769 }
1770 }
1771
1772 /* If got no characters, print help for user. */
1773
1774 if (i_byte == ZV_BYTE - BEGV_BYTE)
1775 {
1776 if (auto_help)
1777 Fminibuffer_completion_help ();
1778 return Qnil;
1779 }
1780
1781 /* Otherwise insert in minibuffer the chars we got */
1782
1783 Ferase_buffer ();
1784 insert_from_string (completion, 0, 0, i, i_byte, 1);
1785 return Qt;
1786 }
1787 \f
1788 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
1789 1, 1, 0,
1790 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1791 Each element may be just a symbol or string\n\
1792 or may be a list of two strings to be printed as if concatenated.\n\
1793 `standard-output' must be a buffer.\n\
1794 At the end, run the normal hook `completion-setup-hook'.\n\
1795 It can find the completion buffer in `standard-output'.")
1796 (completions)
1797 Lisp_Object completions;
1798 {
1799 Lisp_Object tail, elt;
1800 register int i;
1801 int column = 0;
1802 struct gcpro gcpro1, gcpro2;
1803 struct buffer *old = current_buffer;
1804 int first = 1;
1805
1806 /* Note that (when it matters) every variable
1807 points to a non-string that is pointed to by COMPLETIONS,
1808 except for ELT. ELT can be pointing to a string
1809 when terpri or Findent_to calls a change hook. */
1810 elt = Qnil;
1811 GCPRO2 (completions, elt);
1812
1813 if (BUFFERP (Vstandard_output))
1814 set_buffer_internal (XBUFFER (Vstandard_output));
1815
1816 if (NILP (completions))
1817 write_string ("There are no possible completions of what you have typed.",
1818 -1);
1819 else
1820 {
1821 write_string ("Possible completions are:", -1);
1822 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
1823 {
1824 Lisp_Object tem;
1825 int length;
1826 Lisp_Object startpos, endpos;
1827
1828 elt = Fcar (tail);
1829 /* Compute the length of this element. */
1830 if (CONSP (elt))
1831 {
1832 tem = XCAR (elt);
1833 CHECK_STRING (tem, 0);
1834 length = XSTRING (tem)->size;
1835
1836 tem = Fcar (XCDR (elt));
1837 CHECK_STRING (tem, 0);
1838 length += XSTRING (tem)->size;
1839 }
1840 else
1841 {
1842 CHECK_STRING (elt, 0);
1843 length = XSTRING (elt)->size;
1844 }
1845
1846 /* This does a bad job for narrower than usual windows.
1847 Sadly, the window it will appear in is not known
1848 until after the text has been made. */
1849
1850 if (BUFFERP (Vstandard_output))
1851 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
1852
1853 /* If the previous completion was very wide,
1854 or we have two on this line already,
1855 don't put another on the same line. */
1856 if (column > 33 || first
1857 /* If this is really wide, don't put it second on a line. */
1858 || column > 0 && length > 45)
1859 {
1860 Fterpri (Qnil);
1861 column = 0;
1862 }
1863 /* Otherwise advance to column 35. */
1864 else
1865 {
1866 if (BUFFERP (Vstandard_output))
1867 {
1868 tem = Findent_to (make_number (35), make_number (2));
1869
1870 column = XINT (tem);
1871 }
1872 else
1873 {
1874 do
1875 {
1876 write_string (" ", -1);
1877 column++;
1878 }
1879 while (column < 35);
1880 }
1881 }
1882
1883 if (BUFFERP (Vstandard_output))
1884 {
1885 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
1886 Fset_text_properties (startpos, endpos,
1887 Qnil, Vstandard_output);
1888 }
1889
1890 /* Output this element and update COLUMN. */
1891 if (CONSP (elt))
1892 {
1893 Fprinc (Fcar (elt), Qnil);
1894 Fprinc (Fcar (Fcdr (elt)), Qnil);
1895 }
1896 else
1897 Fprinc (elt, Qnil);
1898
1899 column += length;
1900
1901 /* If output is to a buffer, recompute COLUMN in a way
1902 that takes account of character widths. */
1903 if (BUFFERP (Vstandard_output))
1904 {
1905 tem = Fcurrent_column ();
1906 column = XINT (tem);
1907 }
1908
1909 first = 0;
1910 }
1911 }
1912
1913 UNGCPRO;
1914
1915 if (BUFFERP (Vstandard_output))
1916 set_buffer_internal (old);
1917
1918 if (!NILP (Vrun_hooks))
1919 call1 (Vrun_hooks, intern ("completion-setup-hook"));
1920
1921 return Qnil;
1922 }
1923
1924 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
1925 0, 0, "",
1926 "Display a list of possible completions of the current minibuffer contents.")
1927 ()
1928 {
1929 Lisp_Object completions;
1930
1931 message ("Making completion list...");
1932 completions = Fall_completions (Fbuffer_string (),
1933 Vminibuffer_completion_table,
1934 Vminibuffer_completion_predicate,
1935 Qt);
1936 echo_area_glyphs = 0;
1937
1938 if (NILP (completions))
1939 {
1940 bitch_at_user ();
1941 temp_echo_area_glyphs (" [No completions]");
1942 }
1943 else
1944 internal_with_output_to_temp_buffer ("*Completions*",
1945 Fdisplay_completion_list,
1946 Fsort (completions, Qstring_lessp));
1947 return Qnil;
1948 }
1949 \f
1950 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
1951 "Terminate minibuffer input.")
1952 ()
1953 {
1954 if (INTEGERP (last_command_char))
1955 internal_self_insert (XINT (last_command_char), 0);
1956 else
1957 bitch_at_user ();
1958
1959 Fthrow (Qexit, Qnil);
1960 }
1961
1962 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
1963 "Terminate this minibuffer argument.")
1964 ()
1965 {
1966 Fthrow (Qexit, Qnil);
1967 }
1968
1969 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1970 "Return current depth of activations of minibuffer, a nonnegative integer.")
1971 ()
1972 {
1973 return make_number (minibuf_level);
1974 }
1975
1976 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1977 "Return the prompt string of the currently-active minibuffer.\n\
1978 If no minibuffer is active, return nil.")
1979 ()
1980 {
1981 return Fcopy_sequence (minibuf_prompt);
1982 }
1983
1984 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width,
1985 Sminibuffer_prompt_width, 0, 0, 0,
1986 "Return the display width of the minibuffer prompt.")
1987 ()
1988 {
1989 Lisp_Object width;
1990 XSETFASTINT (width, minibuf_prompt_width);
1991 return width;
1992 }
1993 \f
1994 /* Temporarily display the string M at the end of the current
1995 minibuffer contents. This is used to display things like
1996 "[No Match]" when the user requests a completion for a prefix
1997 that has no possible completions, and other quick, unobtrusive
1998 messages. */
1999
2000 void
2001 temp_echo_area_glyphs (m)
2002 char *m;
2003 {
2004 int osize = ZV;
2005 int osize_byte = ZV_BYTE;
2006 int opoint = PT;
2007 int opoint_byte = PT_BYTE;
2008 Lisp_Object oinhibit;
2009 oinhibit = Vinhibit_quit;
2010
2011 /* Clear out any old echo-area message to make way for our new thing. */
2012 message (0);
2013
2014 SET_PT_BOTH (osize, osize_byte);
2015 insert_string (m);
2016 SET_PT_BOTH (opoint, opoint_byte);
2017 Vinhibit_quit = Qt;
2018 Fsit_for (make_number (2), Qnil, Qnil);
2019 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
2020 SET_PT_BOTH (opoint, opoint_byte);
2021 if (!NILP (Vquit_flag))
2022 {
2023 Vquit_flag = Qnil;
2024 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2025 }
2026 Vinhibit_quit = oinhibit;
2027 }
2028
2029 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2030 1, 1, 0,
2031 "Temporarily display STRING at the end of the minibuffer.\n\
2032 The text is displayed for two seconds,\n\
2033 or until the next input event arrives, whichever comes first.")
2034 (string)
2035 Lisp_Object string;
2036 {
2037 temp_echo_area_glyphs (XSTRING (string)->data);
2038 return Qnil;
2039 }
2040 \f
2041 void
2042 init_minibuf_once ()
2043 {
2044 Vminibuffer_list = Qnil;
2045 staticpro (&Vminibuffer_list);
2046 }
2047
2048 void
2049 syms_of_minibuf ()
2050 {
2051 minibuf_level = 0;
2052 minibuf_prompt = Qnil;
2053 staticpro (&minibuf_prompt);
2054
2055 minibuf_save_list = Qnil;
2056 staticpro (&minibuf_save_list);
2057
2058 Qread_file_name_internal = intern ("read-file-name-internal");
2059 staticpro (&Qread_file_name_internal);
2060
2061 Qminibuffer_default = intern ("minibuffer-default");
2062 staticpro (&Qminibuffer_default);
2063 Fset (Qminibuffer_default, Qnil);
2064
2065 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2066 staticpro (&Qminibuffer_completion_table);
2067
2068 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2069 staticpro (&Qminibuffer_completion_confirm);
2070
2071 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2072 staticpro (&Qminibuffer_completion_predicate);
2073
2074 staticpro (&last_exact_completion);
2075 last_exact_completion = Qnil;
2076
2077 staticpro (&last_minibuf_string);
2078 last_minibuf_string = Qnil;
2079
2080 Quser_variable_p = intern ("user-variable-p");
2081 staticpro (&Quser_variable_p);
2082
2083 Qminibuffer_history = intern ("minibuffer-history");
2084 staticpro (&Qminibuffer_history);
2085
2086 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2087 staticpro (&Qminibuffer_setup_hook);
2088
2089 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2090 staticpro (&Qminibuffer_exit_hook);
2091
2092 Qhistory_length = intern ("history-length");
2093 staticpro (&Qhistory_length);
2094
2095 Qcurrent_input_method = intern ("current-input-method");
2096 staticpro (&Qcurrent_input_method);
2097
2098 Qactivate_input_method = intern ("activate-input-method");
2099 staticpro (&Qactivate_input_method);
2100
2101 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2102 "If this is non-nil, `read-buffer' does its work by calling this function.");
2103 Vread_buffer_function = Qnil;
2104
2105 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2106 "Normal hook run just after entry to minibuffer.");
2107 Vminibuffer_setup_hook = Qnil;
2108
2109 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2110 "Normal hook run just after exit from minibuffer.");
2111 Vminibuffer_exit_hook = Qnil;
2112
2113 DEFVAR_LISP ("history-length", &Vhistory_length,
2114 "*Maximum length for history lists before truncation takes place.\n\
2115 A number means that length; t means infinite. Truncation takes place\n\
2116 just after a new element is inserted. Setting the history-length\n\
2117 property of a history variable overrides this default.");
2118 XSETFASTINT (Vhistory_length, 30);
2119
2120 DEFVAR_BOOL ("completion-auto-help", &auto_help,
2121 "*Non-nil means automatically provide help for invalid completion input.");
2122 auto_help = 1;
2123
2124 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2125 "Non-nil means don't consider case significant in completion.");
2126 completion_ignore_case = 0;
2127
2128 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2129 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2130 This variable makes a difference whenever the minibuffer window is active.");
2131 enable_recursive_minibuffers = 0;
2132
2133 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2134 "Alist or obarray used for completion in the minibuffer.\n\
2135 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2136 \n\
2137 The value may alternatively be a function, which is given three arguments:\n\
2138 STRING, the current buffer contents;\n\
2139 PREDICATE, the predicate for filtering possible matches;\n\
2140 CODE, which says what kind of things to do.\n\
2141 CODE can be nil, t or `lambda'.\n\
2142 nil means to return the best completion of STRING, or nil if there is none.\n\
2143 t means to return a list of all possible completions of STRING.\n\
2144 `lambda' means to return t if STRING is a valid completion as it stands.");
2145 Vminibuffer_completion_table = Qnil;
2146
2147 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2148 "Within call to `completing-read', this holds the PREDICATE argument.");
2149 Vminibuffer_completion_predicate = Qnil;
2150
2151 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2152 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2153 Vminibuffer_completion_confirm = Qnil;
2154
2155 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2156 "Value that `help-form' takes on inside the minibuffer.");
2157 Vminibuffer_help_form = Qnil;
2158
2159 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2160 "History list symbol to add minibuffer values to.\n\
2161 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2162 is added with\n\
2163 (set minibuffer-history-variable\n\
2164 (cons STRING (symbol-value minibuffer-history-variable)))");
2165 XSETFASTINT (Vminibuffer_history_variable, 0);
2166
2167 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2168 "Current position of redoing in the history list.");
2169 Vminibuffer_history_position = Qnil;
2170
2171 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2172 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2173 Some uses of the echo area also raise that frame (since they use it too).");
2174 minibuffer_auto_raise = 0;
2175
2176 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2177 "List of regexps that should restrict possible completions.");
2178 Vcompletion_regexp_list = Qnil;
2179
2180 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2181 &minibuffer_allow_text_properties,
2182 "Non-nil means `read-from-miniffer' should not discard text properties.\n\
2183 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2184 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2185 with completion; they always discard text properties.");
2186 minibuffer_allow_text_properties = 0;
2187
2188 defsubr (&Sset_minibuffer_window);
2189 defsubr (&Sread_from_minibuffer);
2190 defsubr (&Seval_minibuffer);
2191 defsubr (&Sread_minibuffer);
2192 defsubr (&Sread_string);
2193 defsubr (&Sread_command);
2194 defsubr (&Sread_variable);
2195 defsubr (&Sread_buffer);
2196 defsubr (&Sread_no_blanks_input);
2197 defsubr (&Sminibuffer_depth);
2198 defsubr (&Sminibuffer_prompt);
2199 defsubr (&Sminibuffer_prompt_width);
2200
2201 defsubr (&Stry_completion);
2202 defsubr (&Sall_completions);
2203 defsubr (&Scompleting_read);
2204 defsubr (&Sminibuffer_complete);
2205 defsubr (&Sminibuffer_complete_word);
2206 defsubr (&Sminibuffer_complete_and_exit);
2207 defsubr (&Sdisplay_completion_list);
2208 defsubr (&Sminibuffer_completion_help);
2209
2210 defsubr (&Sself_insert_and_exit);
2211 defsubr (&Sexit_minibuffer);
2212
2213 defsubr (&Sminibuffer_message);
2214 }
2215
2216 void
2217 keys_of_minibuf ()
2218 {
2219 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2220 "abort-recursive-edit");
2221 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2222 "exit-minibuffer");
2223 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2224 "exit-minibuffer");
2225
2226 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
2227 "abort-recursive-edit");
2228 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
2229 "exit-minibuffer");
2230 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
2231 "exit-minibuffer");
2232
2233 initial_define_key (Vminibuffer_local_ns_map, ' ',
2234 "exit-minibuffer");
2235 initial_define_key (Vminibuffer_local_ns_map, '\t',
2236 "exit-minibuffer");
2237 initial_define_key (Vminibuffer_local_ns_map, '?',
2238 "self-insert-and-exit");
2239
2240 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
2241 "abort-recursive-edit");
2242 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
2243 "exit-minibuffer");
2244 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
2245 "exit-minibuffer");
2246
2247 initial_define_key (Vminibuffer_local_completion_map, '\t',
2248 "minibuffer-complete");
2249 initial_define_key (Vminibuffer_local_completion_map, ' ',
2250 "minibuffer-complete-word");
2251 initial_define_key (Vminibuffer_local_completion_map, '?',
2252 "minibuffer-completion-help");
2253
2254 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
2255 "abort-recursive-edit");
2256 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2257 "minibuffer-complete-and-exit");
2258 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2259 "minibuffer-complete-and-exit");
2260 initial_define_key (Vminibuffer_local_must_match_map, '\t',
2261 "minibuffer-complete");
2262 initial_define_key (Vminibuffer_local_must_match_map, ' ',
2263 "minibuffer-complete-word");
2264 initial_define_key (Vminibuffer_local_must_match_map, '?',
2265 "minibuffer-completion-help");
2266 }