(Qforeground_color, Qbackground_color): Declare.
[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 && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
959 STRING_BYTES (XSTRING (string))))
960 {
961 /* Yes. */
962 Lisp_Object regexps;
963 Lisp_Object zero;
964 XSETFASTINT (zero, 0);
965
966 /* Ignore this element if it fails to match all the regexps. */
967 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
968 regexps = XCONS (regexps)->cdr)
969 {
970 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
971 if (NILP (tem))
972 break;
973 }
974 if (CONSP (regexps))
975 continue;
976
977 /* Ignore this element if there is a predicate
978 and the predicate doesn't like it. */
979
980 if (!NILP (predicate))
981 {
982 if (EQ (predicate, Qcommandp))
983 tem = Fcommandp (elt);
984 else
985 {
986 GCPRO4 (tail, string, eltstring, bestmatch);
987 tem = call1 (predicate, elt);
988 UNGCPRO;
989 }
990 if (NILP (tem)) continue;
991 }
992
993 /* Update computation of how much all possible completions match */
994
995 matchcount++;
996 if (NILP (bestmatch))
997 {
998 bestmatch = eltstring;
999 bestmatchsize = STRING_BYTES (XSTRING (eltstring));
1000 }
1001 else
1002 {
1003 compare = min (bestmatchsize, STRING_BYTES (XSTRING (eltstring)));
1004 matchsize = scmp (XSTRING (bestmatch)->data,
1005 XSTRING (eltstring)->data,
1006 compare);
1007 if (matchsize < 0)
1008 matchsize = compare;
1009 if (completion_ignore_case)
1010 {
1011 /* If this is an exact match except for case,
1012 use it as the best match rather than one that is not an
1013 exact match. This way, we get the case pattern
1014 of the actual match. */
1015 if ((matchsize == STRING_BYTES (XSTRING (eltstring))
1016 && matchsize < STRING_BYTES (XSTRING (bestmatch)))
1017 ||
1018 /* If there is more than one exact match ignoring case,
1019 and one of them is exact including case,
1020 prefer that one. */
1021 /* If there is no exact match ignoring case,
1022 prefer a match that does not change the case
1023 of the input. */
1024 ((matchsize == STRING_BYTES (XSTRING (eltstring)))
1025 ==
1026 (matchsize == STRING_BYTES (XSTRING (bestmatch)))
1027 && !bcmp (XSTRING (eltstring)->data,
1028 XSTRING (string)->data,
1029 STRING_BYTES (XSTRING (string)))
1030 && bcmp (XSTRING (bestmatch)->data,
1031 XSTRING (string)->data,
1032 STRING_BYTES (XSTRING (string)))))
1033 bestmatch = eltstring;
1034 }
1035 bestmatchsize = matchsize;
1036 }
1037 }
1038 }
1039
1040 if (NILP (bestmatch))
1041 return Qnil; /* No completions found */
1042 /* If we are ignoring case, and there is no exact match,
1043 and no additional text was supplied,
1044 don't change the case of what the user typed. */
1045 if (completion_ignore_case && bestmatchsize == STRING_BYTES (XSTRING (string))
1046 && STRING_BYTES (XSTRING (bestmatch)) > bestmatchsize)
1047 return string;
1048
1049 /* Return t if the supplied string is an exact match (counting case);
1050 it does not require any change to be made. */
1051 if (matchcount == 1 && bestmatchsize == STRING_BYTES (XSTRING (string))
1052 && !bcmp (XSTRING (bestmatch)->data, XSTRING (string)->data,
1053 bestmatchsize))
1054 return Qt;
1055
1056 bestmatchsize = string_byte_to_char (bestmatch, bestmatchsize);
1057
1058 XSETFASTINT (zero, 0); /* Else extract the part in which */
1059 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1060 return Fsubstring (bestmatch, zero, end);
1061 }
1062
1063 /* Compare exactly LEN chars of strings at S1 and S2,
1064 ignoring case if appropriate.
1065 Return -1 if strings match,
1066 else number of chars that match at the beginning. */
1067
1068 int
1069 scmp (s1, s2, len)
1070 register unsigned char *s1, *s2;
1071 int len;
1072 {
1073 register int l = len;
1074 register unsigned char *start = s1;
1075
1076 if (completion_ignore_case)
1077 {
1078 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
1079 l--;
1080 }
1081 else
1082 {
1083 while (l && *s1++ == *s2++)
1084 l--;
1085 }
1086 if (l == 0)
1087 return -1;
1088 else
1089 {
1090 int match = len - l;
1091
1092 /* Now *--S1 is the unmatching byte. If it is in the middle of
1093 multi-byte form, we must say that the multi-byte character
1094 there doesn't match. */
1095 while (match && *--s1 >= 0xA0) match--;
1096 return match;
1097 }
1098 }
1099 \f
1100 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1101 "Search for partial matches to STRING in ALIST.\n\
1102 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1103 The value is a list of all the strings from ALIST that match.\n\
1104 \n\
1105 ALIST can be an obarray instead of an alist.\n\
1106 Then the print names of all symbols in the obarray are the possible matches.\n\
1107 \n\
1108 ALIST can also be a function to do the completion itself.\n\
1109 It receives three arguments: the values STRING, PREDICATE and t.\n\
1110 Whatever it returns becomes the value of `all-completion'.\n\
1111 \n\
1112 If optional third argument PREDICATE is non-nil,\n\
1113 it is used to test each possible match.\n\
1114 The match is a candidate only if PREDICATE returns non-nil.\n\
1115 The argument given to PREDICATE is the alist element\n\
1116 or the symbol from the obarray.\n\
1117 \n\
1118 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1119 strings in ALIST that start with a space\n\
1120 are ignored unless STRING itself starts with a space.")
1121 (string, alist, predicate, hide_spaces)
1122 Lisp_Object string, alist, predicate, hide_spaces;
1123 {
1124 Lisp_Object tail, elt, eltstring;
1125 Lisp_Object allmatches;
1126 int list = CONSP (alist) || NILP (alist);
1127 int index, obsize;
1128 Lisp_Object bucket, tem;
1129 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1130
1131 CHECK_STRING (string, 0);
1132 if (!list && !VECTORP (alist))
1133 {
1134 return call3 (alist, string, predicate, Qt);
1135 }
1136 allmatches = Qnil;
1137
1138 /* If ALIST is not a list, set TAIL just for gc pro. */
1139 tail = alist;
1140 if (! list)
1141 {
1142 index = 0;
1143 obsize = XVECTOR (alist)->size;
1144 bucket = XVECTOR (alist)->contents[index];
1145 }
1146
1147 while (1)
1148 {
1149 /* Get the next element of the alist or obarray. */
1150 /* Exit the loop if the elements are all used up. */
1151 /* elt gets the alist element or symbol.
1152 eltstring gets the name to check as a completion. */
1153
1154 if (list)
1155 {
1156 if (NILP (tail))
1157 break;
1158 elt = Fcar (tail);
1159 eltstring = Fcar (elt);
1160 tail = Fcdr (tail);
1161 }
1162 else
1163 {
1164 if (XFASTINT (bucket) != 0)
1165 {
1166 elt = bucket;
1167 eltstring = Fsymbol_name (elt);
1168 if (XSYMBOL (bucket)->next)
1169 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1170 else
1171 XSETFASTINT (bucket, 0);
1172 }
1173 else if (++index >= obsize)
1174 break;
1175 else
1176 {
1177 bucket = XVECTOR (alist)->contents[index];
1178 continue;
1179 }
1180 }
1181
1182 /* Is this element a possible completion? */
1183
1184 if (STRINGP (eltstring)
1185 && STRING_BYTES (XSTRING (string)) <= STRING_BYTES (XSTRING (eltstring))
1186 /* If HIDE_SPACES, reject alternatives that start with space
1187 unless the input starts with space. */
1188 && ((STRING_BYTES (XSTRING (string)) > 0
1189 && XSTRING (string)->data[0] == ' ')
1190 || XSTRING (eltstring)->data[0] != ' '
1191 || NILP (hide_spaces))
1192 && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
1193 STRING_BYTES (XSTRING (string))))
1194 {
1195 /* Yes. */
1196 Lisp_Object regexps;
1197 Lisp_Object zero;
1198 XSETFASTINT (zero, 0);
1199
1200 /* Ignore this element if it fails to match all the regexps. */
1201 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1202 regexps = XCONS (regexps)->cdr)
1203 {
1204 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
1205 if (NILP (tem))
1206 break;
1207 }
1208 if (CONSP (regexps))
1209 continue;
1210
1211 /* Ignore this element if there is a predicate
1212 and the predicate doesn't like it. */
1213
1214 if (!NILP (predicate))
1215 {
1216 if (EQ (predicate, Qcommandp))
1217 tem = Fcommandp (elt);
1218 else
1219 {
1220 GCPRO4 (tail, eltstring, allmatches, string);
1221 tem = call1 (predicate, elt);
1222 UNGCPRO;
1223 }
1224 if (NILP (tem)) continue;
1225 }
1226 /* Ok => put it on the list. */
1227 allmatches = Fcons (eltstring, allmatches);
1228 }
1229 }
1230
1231 return Fnreverse (allmatches);
1232 }
1233 \f
1234 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1235 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1236 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1237
1238 /* This comment supplies the doc string for completing-read,
1239 for make-docfile to see. We cannot put this in the real DEFUN
1240 due to limits in the Unix cpp.
1241
1242 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1243 "Read a string in the minibuffer, with completion.\n\
1244 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1245 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1246 PREDICATE limits completion to a subset of TABLE.\n\
1247 See `try-completion' and `all-completions' for more details
1248 on completion, TABLE, and PREDICATE.\n\
1249 \n\
1250 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1251 the input is (or completes to) an element of TABLE or is null.\n\
1252 If it is also not t, Return does not exit if it does non-null completion.\n\
1253 If the input is null, `completing-read' returns an empty string,\n\
1254 regardless of the value of REQUIRE-MATCH.\n\
1255 \n\
1256 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1257 If it is (STRING . POSITION), the initial input\n\
1258 is STRING, but point is placed POSITION characters into the string.\n\
1259 HIST, if non-nil, specifies a history list\n\
1260 and optionally the initial position in the list.\n\
1261 It can be a symbol, which is the history list variable to use,\n\
1262 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1263 In that case, HISTVAR is the history list variable to use,\n\
1264 and HISTPOS is the initial position (the position in the list\n\
1265 which INITIAL-INPUT corresponds to).\n\
1266 Positions are counted starting from 1 at the beginning of the list.\n\
1267 DEF, if non-nil, is the default value.\n\
1268 \n\
1269 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1270 the current input method and the setting of enable-multibyte-characters.\n\
1271 \n\
1272 Completion ignores case if the ambient value of\n\
1273 `completion-ignore-case' is non-nil."
1274 */
1275 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1276 0 /* See immediately above */)
1277 (prompt, table, predicate, require_match, init, hist, def, inherit_input_method)
1278 Lisp_Object prompt, table, predicate, require_match, init, hist, def;
1279 Lisp_Object inherit_input_method;
1280 {
1281 Lisp_Object val, histvar, histpos, position;
1282 int pos = 0;
1283 int count = specpdl_ptr - specpdl;
1284 struct gcpro gcpro1;
1285 int disable_multibyte = EQ (table, Qread_file_name_internal);
1286
1287 GCPRO1 (def);
1288
1289 specbind (Qminibuffer_completion_table, table);
1290 specbind (Qminibuffer_completion_predicate, predicate);
1291 specbind (Qminibuffer_completion_confirm,
1292 EQ (require_match, Qt) ? Qnil : Qt);
1293 last_exact_completion = Qnil;
1294
1295 position = Qnil;
1296 if (!NILP (init))
1297 {
1298 if (CONSP (init))
1299 {
1300 position = Fcdr (init);
1301 init = Fcar (init);
1302 }
1303 CHECK_STRING (init, 0);
1304 if (!NILP (position))
1305 {
1306 CHECK_NUMBER (position, 0);
1307 /* Convert to distance from end of input. */
1308 pos = XINT (position) - XSTRING (init)->size;
1309 }
1310 }
1311
1312 if (SYMBOLP (hist))
1313 {
1314 histvar = hist;
1315 histpos = Qnil;
1316 }
1317 else
1318 {
1319 histvar = Fcar_safe (hist);
1320 histpos = Fcdr_safe (hist);
1321 }
1322 if (NILP (histvar))
1323 histvar = Qminibuffer_history;
1324 if (NILP (histpos))
1325 XSETFASTINT (histpos, 0);
1326
1327 val = read_minibuf (NILP (require_match)
1328 ? Vminibuffer_local_completion_map
1329 : Vminibuffer_local_must_match_map,
1330 init, prompt, make_number (pos), 0,
1331 histvar, histpos, def, 0,
1332 !NILP (inherit_input_method));
1333
1334 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (def))
1335 val = def;
1336
1337 RETURN_UNGCPRO (unbind_to (count, val));
1338 }
1339 \f
1340 Lisp_Object Fminibuffer_completion_help ();
1341 Lisp_Object assoc_for_completion ();
1342
1343 /* Test whether TXT is an exact completion. */
1344 Lisp_Object
1345 test_completion (txt)
1346 Lisp_Object txt;
1347 {
1348 Lisp_Object tem;
1349
1350 if (CONSP (Vminibuffer_completion_table)
1351 || NILP (Vminibuffer_completion_table))
1352 return assoc_for_completion (txt, Vminibuffer_completion_table);
1353 else if (VECTORP (Vminibuffer_completion_table))
1354 {
1355 /* Bypass intern-soft as that loses for nil */
1356 tem = oblookup (Vminibuffer_completion_table,
1357 XSTRING (txt)->data,
1358 XSTRING (txt)->size,
1359 STRING_BYTES (XSTRING (txt)));
1360 if (!SYMBOLP (tem))
1361 return Qnil;
1362 else if (!NILP (Vminibuffer_completion_predicate))
1363 return call1 (Vminibuffer_completion_predicate, tem);
1364 else
1365 return Qt;
1366 }
1367 else
1368 return call3 (Vminibuffer_completion_table, txt,
1369 Vminibuffer_completion_predicate, Qlambda);
1370 }
1371
1372 /* returns:
1373 * 0 no possible completion
1374 * 1 was already an exact and unique completion
1375 * 3 was already an exact completion
1376 * 4 completed to an exact completion
1377 * 5 some completion happened
1378 * 6 no completion happened
1379 */
1380 int
1381 do_completion ()
1382 {
1383 Lisp_Object completion, tem;
1384 int completedp;
1385 Lisp_Object last;
1386 struct gcpro gcpro1, gcpro2;
1387
1388 completion = Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table,
1389 Vminibuffer_completion_predicate);
1390 last = last_exact_completion;
1391 last_exact_completion = Qnil;
1392
1393 GCPRO2 (completion, last);
1394
1395 if (NILP (completion))
1396 {
1397 bitch_at_user ();
1398 temp_echo_area_glyphs (" [No match]");
1399 UNGCPRO;
1400 return 0;
1401 }
1402
1403 if (EQ (completion, Qt)) /* exact and unique match */
1404 {
1405 UNGCPRO;
1406 return 1;
1407 }
1408
1409 /* compiler bug */
1410 tem = Fstring_equal (completion, Fbuffer_string());
1411 if (completedp = NILP (tem))
1412 {
1413 Ferase_buffer (); /* Some completion happened */
1414 Finsert (1, &completion);
1415 }
1416
1417 /* It did find a match. Do we match some possibility exactly now? */
1418 tem = test_completion (Fbuffer_string ());
1419 if (NILP (tem))
1420 {
1421 /* not an exact match */
1422 UNGCPRO;
1423 if (completedp)
1424 return 5;
1425 else if (auto_help)
1426 Fminibuffer_completion_help ();
1427 else
1428 temp_echo_area_glyphs (" [Next char not unique]");
1429 return 6;
1430 }
1431 else if (completedp)
1432 {
1433 UNGCPRO;
1434 return 4;
1435 }
1436 /* If the last exact completion and this one were the same,
1437 it means we've already given a "Complete but not unique"
1438 message and the user's hit TAB again, so now we give him help. */
1439 last_exact_completion = completion;
1440 if (!NILP (last))
1441 {
1442 tem = Fbuffer_string ();
1443 if (!NILP (Fequal (tem, last)))
1444 Fminibuffer_completion_help ();
1445 }
1446 UNGCPRO;
1447 return 3;
1448 }
1449
1450 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1451
1452 Lisp_Object
1453 assoc_for_completion (key, list)
1454 register Lisp_Object key;
1455 Lisp_Object list;
1456 {
1457 register Lisp_Object tail;
1458
1459 if (completion_ignore_case)
1460 key = Fupcase (key);
1461
1462 for (tail = list; !NILP (tail); tail = Fcdr (tail))
1463 {
1464 register Lisp_Object elt, tem, thiscar;
1465 elt = Fcar (tail);
1466 if (!CONSP (elt)) continue;
1467 thiscar = Fcar (elt);
1468 if (!STRINGP (thiscar))
1469 continue;
1470 if (completion_ignore_case)
1471 thiscar = Fupcase (thiscar);
1472 tem = Fequal (thiscar, key);
1473 if (!NILP (tem)) return elt;
1474 QUIT;
1475 }
1476 return Qnil;
1477 }
1478
1479 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
1480 "Complete the minibuffer contents as far as possible.\n\
1481 Return nil if there is no valid completion, else t.\n\
1482 If no characters can be completed, display a list of possible completions.\n\
1483 If you repeat this command after it displayed such a list,\n\
1484 scroll the window of possible completions.")
1485 ()
1486 {
1487 register int i;
1488 Lisp_Object window, tem;
1489
1490 /* If the previous command was not this, then mark the completion
1491 buffer obsolete. */
1492 if (! EQ (current_kboard->Vlast_command, this_command))
1493 Vminibuf_scroll_window = Qnil;
1494
1495 window = Vminibuf_scroll_window;
1496 /* If there's a fresh completion window with a live buffer,
1497 and this command is repeated, scroll that window. */
1498 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1499 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1500 {
1501 struct buffer *obuf = current_buffer;
1502
1503 Fset_buffer (XWINDOW (window)->buffer);
1504 tem = Fpos_visible_in_window_p (make_number (ZV), window);
1505 if (! NILP (tem))
1506 /* If end is in view, scroll up to the beginning. */
1507 Fset_window_start (window, make_number (BEGV), Qnil);
1508 else
1509 /* Else scroll down one screen. */
1510 Fscroll_other_window (Qnil);
1511
1512 set_buffer_internal (obuf);
1513 return Qnil;
1514 }
1515
1516 i = do_completion ();
1517 switch (i)
1518 {
1519 case 0:
1520 return Qnil;
1521
1522 case 1:
1523 temp_echo_area_glyphs (" [Sole completion]");
1524 break;
1525
1526 case 3:
1527 temp_echo_area_glyphs (" [Complete, but not unique]");
1528 break;
1529 }
1530
1531 return Qt;
1532 }
1533 \f
1534 /* Subroutines of Fminibuffer_complete_and_exit. */
1535
1536 /* This one is called by internal_condition_case to do the real work. */
1537
1538 Lisp_Object
1539 complete_and_exit_1 ()
1540 {
1541 return make_number (do_completion ());
1542 }
1543
1544 /* This one is called by internal_condition_case if an error happens.
1545 Pretend the current value is an exact match. */
1546
1547 Lisp_Object
1548 complete_and_exit_2 (ignore)
1549 Lisp_Object ignore;
1550 {
1551 return make_number (1);
1552 }
1553
1554 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1555 Sminibuffer_complete_and_exit, 0, 0, "",
1556 "If the minibuffer contents is a valid completion then exit.\n\
1557 Otherwise try to complete it. If completion leads to a valid completion,\n\
1558 a repetition of this command will exit.")
1559 ()
1560 {
1561 register int i;
1562 Lisp_Object val;
1563
1564 /* Allow user to specify null string */
1565 if (BEGV == ZV)
1566 goto exit;
1567
1568 if (!NILP (test_completion (Fbuffer_string ())))
1569 goto exit;
1570
1571 /* Call do_completion, but ignore errors. */
1572 val = internal_condition_case (complete_and_exit_1, Qerror,
1573 complete_and_exit_2);
1574
1575 i = XFASTINT (val);
1576 switch (i)
1577 {
1578 case 1:
1579 case 3:
1580 goto exit;
1581
1582 case 4:
1583 if (!NILP (Vminibuffer_completion_confirm))
1584 {
1585 temp_echo_area_glyphs (" [Confirm]");
1586 return Qnil;
1587 }
1588 else
1589 goto exit;
1590
1591 default:
1592 return Qnil;
1593 }
1594 exit:
1595 Fthrow (Qexit, Qnil);
1596 /* NOTREACHED */
1597 }
1598
1599 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1600 0, 0, "",
1601 "Complete the minibuffer contents at most a single word.\n\
1602 After one word is completed as much as possible, a space or hyphen\n\
1603 is added, provided that matches some possible completion.\n\
1604 Return nil if there is no valid completion, else t.")
1605 ()
1606 {
1607 Lisp_Object completion, tem;
1608 register int i, i_byte;
1609 register unsigned char *completion_string;
1610 struct gcpro gcpro1, gcpro2;
1611
1612 /* We keep calling Fbuffer_string rather than arrange for GC to
1613 hold onto a pointer to one of the strings thus made. */
1614
1615 completion = Ftry_completion (Fbuffer_string (),
1616 Vminibuffer_completion_table,
1617 Vminibuffer_completion_predicate);
1618 if (NILP (completion))
1619 {
1620 bitch_at_user ();
1621 temp_echo_area_glyphs (" [No match]");
1622 return Qnil;
1623 }
1624 if (EQ (completion, Qt))
1625 return Qnil;
1626
1627 #if 0 /* How the below code used to look, for reference. */
1628 tem = Fbuffer_string ();
1629 b = XSTRING (tem)->data;
1630 i = ZV - 1 - XSTRING (completion)->size;
1631 p = XSTRING (completion)->data;
1632 if (i > 0 ||
1633 0 <= scmp (b, p, ZV - 1))
1634 {
1635 i = 1;
1636 /* Set buffer to longest match of buffer tail and completion head. */
1637 while (0 <= scmp (b + i, p, ZV - 1 - i))
1638 i++;
1639 del_range (1, i + 1);
1640 SET_PT (ZV);
1641 }
1642 #else /* Rewritten code */
1643 {
1644 register unsigned char *buffer_string;
1645 int buffer_nbytes, completion_nbytes;
1646
1647 CHECK_STRING (completion, 0);
1648 tem = Fbuffer_string ();
1649 GCPRO2 (completion, tem);
1650 /* If reading a file name,
1651 expand any $ENVVAR refs in the buffer and in TEM. */
1652 if (EQ (Vminibuffer_completion_table, Qread_file_name_internal))
1653 {
1654 Lisp_Object substituted;
1655 substituted = Fsubstitute_in_file_name (tem);
1656 if (! EQ (substituted, tem))
1657 {
1658 tem = substituted;
1659 Ferase_buffer ();
1660 insert_from_string (tem, 0, 0, XSTRING (tem)->size,
1661 STRING_BYTES (XSTRING (tem)), 0);
1662 }
1663 }
1664 buffer_string = XSTRING (tem)->data;
1665 completion_string = XSTRING (completion)->data;
1666 buffer_nbytes = STRING_BYTES (XSTRING (tem)); /* ie ZV_BYTE - BEGV_BYTE */
1667 completion_nbytes = STRING_BYTES (XSTRING (completion));
1668 i_byte = buffer_nbytes - completion_nbytes;
1669 if (i_byte > 0 ||
1670 0 <= scmp (buffer_string, completion_string, buffer_nbytes))
1671 {
1672 /* Set buffer to longest match of buffer tail and completion head. */
1673 if (i_byte <= 0) i_byte = 1;
1674 buffer_string += i_byte;
1675 buffer_nbytes -= i_byte;
1676 while (0 <= scmp (buffer_string++, completion_string, buffer_nbytes--))
1677 i_byte++;
1678 del_range_byte (1, i_byte + 1, 1);
1679 SET_PT_BOTH (ZV, ZV_BYTE);
1680 }
1681 UNGCPRO;
1682 }
1683 #endif /* Rewritten code */
1684 i_byte = ZV_BYTE - BEGV_BYTE;
1685 i = ZV - BEGV;
1686
1687 /* If completion finds next char not unique,
1688 consider adding a space or a hyphen. */
1689 if (i == XSTRING (completion)->size)
1690 {
1691 GCPRO1 (completion);
1692 tem = Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1693 Vminibuffer_completion_table,
1694 Vminibuffer_completion_predicate);
1695 UNGCPRO;
1696
1697 if (STRINGP (tem))
1698 completion = tem;
1699 else
1700 {
1701 GCPRO1 (completion);
1702 tem =
1703 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1704 Vminibuffer_completion_table,
1705 Vminibuffer_completion_predicate);
1706 UNGCPRO;
1707
1708 if (STRINGP (tem))
1709 completion = tem;
1710 }
1711 }
1712
1713 /* Now find first word-break in the stuff found by completion.
1714 i gets index in string of where to stop completing. */
1715 {
1716 int len, c;
1717
1718 completion_string = XSTRING (completion)->data;
1719 for (; i_byte < STRING_BYTES (XSTRING (completion)); i_byte += len, i++)
1720 {
1721 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
1722 XSTRING (completion)->size - i_byte,
1723 len);
1724 if (SYNTAX (c) != Sword)
1725 {
1726 i_byte += len;
1727 i++;
1728 break;
1729 }
1730 }
1731 }
1732
1733 /* If got no characters, print help for user. */
1734
1735 if (i_byte == ZV_BYTE - BEGV_BYTE)
1736 {
1737 if (auto_help)
1738 Fminibuffer_completion_help ();
1739 return Qnil;
1740 }
1741
1742 /* Otherwise insert in minibuffer the chars we got */
1743
1744 Ferase_buffer ();
1745 insert_from_string (completion, 0, 0, i, i_byte, 1);
1746 return Qt;
1747 }
1748 \f
1749 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
1750 1, 1, 0,
1751 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1752 Each element may be just a symbol or string\n\
1753 or may be a list of two strings to be printed as if concatenated.\n\
1754 `standard-output' must be a buffer.\n\
1755 At the end, run the normal hook `completion-setup-hook'.\n\
1756 It can find the completion buffer in `standard-output'.")
1757 (completions)
1758 Lisp_Object completions;
1759 {
1760 Lisp_Object tail, elt;
1761 register int i;
1762 int column = 0;
1763 struct gcpro gcpro1, gcpro2;
1764 struct buffer *old = current_buffer;
1765 int first = 1;
1766
1767 /* Note that (when it matters) every variable
1768 points to a non-string that is pointed to by COMPLETIONS,
1769 except for ELT. ELT can be pointing to a string
1770 when terpri or Findent_to calls a change hook. */
1771 elt = Qnil;
1772 GCPRO2 (completions, elt);
1773
1774 if (BUFFERP (Vstandard_output))
1775 set_buffer_internal (XBUFFER (Vstandard_output));
1776
1777 if (NILP (completions))
1778 write_string ("There are no possible completions of what you have typed.",
1779 -1);
1780 else
1781 {
1782 write_string ("Possible completions are:", -1);
1783 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
1784 {
1785 Lisp_Object tem;
1786 int length;
1787 Lisp_Object startpos, endpos;
1788
1789 elt = Fcar (tail);
1790 /* Compute the length of this element. */
1791 if (CONSP (elt))
1792 {
1793 tem = XCAR (elt);
1794 CHECK_STRING (tem, 0);
1795 length = XSTRING (tem)->size;
1796
1797 tem = Fcar (XCDR (elt));
1798 CHECK_STRING (tem, 0);
1799 length += XSTRING (tem)->size;
1800 }
1801 else
1802 {
1803 CHECK_STRING (elt, 0);
1804 length = XSTRING (elt)->size;
1805 }
1806
1807 /* This does a bad job for narrower than usual windows.
1808 Sadly, the window it will appear in is not known
1809 until after the text has been made. */
1810
1811 if (BUFFERP (Vstandard_output))
1812 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
1813
1814 /* If the previous completion was very wide,
1815 or we have two on this line already,
1816 don't put another on the same line. */
1817 if (column > 33 || first
1818 /* If this is really wide, don't put it second on a line. */
1819 || column > 0 && length > 45)
1820 {
1821 Fterpri (Qnil);
1822 column = 0;
1823 }
1824 /* Otherwise advance to column 35. */
1825 else
1826 {
1827 if (BUFFERP (Vstandard_output))
1828 {
1829 tem = Findent_to (make_number (35), make_number (2));
1830
1831 column = XINT (tem);
1832 }
1833 else
1834 {
1835 do
1836 {
1837 write_string (" ", -1);
1838 column++;
1839 }
1840 while (column < 35);
1841 }
1842 }
1843
1844 if (BUFFERP (Vstandard_output))
1845 {
1846 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
1847 Fset_text_properties (startpos, endpos,
1848 Qnil, Vstandard_output);
1849 }
1850
1851 /* Output this element and update COLUMN. */
1852 if (CONSP (elt))
1853 {
1854 Fprinc (Fcar (elt), Qnil);
1855 Fprinc (Fcar (Fcdr (elt)), Qnil);
1856 }
1857 else
1858 Fprinc (elt, Qnil);
1859
1860 column += length;
1861
1862 /* If output is to a buffer, recompute COLUMN in a way
1863 that takes account of character widths. */
1864 if (BUFFERP (Vstandard_output))
1865 {
1866 tem = Fcurrent_column ();
1867 column = XINT (tem);
1868 }
1869
1870 first = 0;
1871 }
1872 }
1873
1874 UNGCPRO;
1875
1876 if (BUFFERP (Vstandard_output))
1877 set_buffer_internal (old);
1878
1879 if (!NILP (Vrun_hooks))
1880 call1 (Vrun_hooks, intern ("completion-setup-hook"));
1881
1882 return Qnil;
1883 }
1884
1885 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
1886 0, 0, "",
1887 "Display a list of possible completions of the current minibuffer contents.")
1888 ()
1889 {
1890 Lisp_Object completions;
1891
1892 message ("Making completion list...");
1893 completions = Fall_completions (Fbuffer_string (),
1894 Vminibuffer_completion_table,
1895 Vminibuffer_completion_predicate,
1896 Qt);
1897 echo_area_glyphs = 0;
1898
1899 if (NILP (completions))
1900 {
1901 bitch_at_user ();
1902 temp_echo_area_glyphs (" [No completions]");
1903 }
1904 else
1905 internal_with_output_to_temp_buffer ("*Completions*",
1906 Fdisplay_completion_list,
1907 Fsort (completions, Qstring_lessp));
1908 return Qnil;
1909 }
1910 \f
1911 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
1912 "Terminate minibuffer input.")
1913 ()
1914 {
1915 if (INTEGERP (last_command_char))
1916 internal_self_insert (XINT (last_command_char), 0);
1917 else
1918 bitch_at_user ();
1919
1920 Fthrow (Qexit, Qnil);
1921 }
1922
1923 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
1924 "Terminate this minibuffer argument.")
1925 ()
1926 {
1927 Fthrow (Qexit, Qnil);
1928 }
1929
1930 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1931 "Return current depth of activations of minibuffer, a nonnegative integer.")
1932 ()
1933 {
1934 return make_number (minibuf_level);
1935 }
1936
1937 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1938 "Return the prompt string of the currently-active minibuffer.\n\
1939 If no minibuffer is active, return nil.")
1940 ()
1941 {
1942 return Fcopy_sequence (minibuf_prompt);
1943 }
1944
1945 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width,
1946 Sminibuffer_prompt_width, 0, 0, 0,
1947 "Return the display width of the minibuffer prompt.")
1948 ()
1949 {
1950 Lisp_Object width;
1951 XSETFASTINT (width, minibuf_prompt_width);
1952 return width;
1953 }
1954 \f
1955 /* Temporarily display the string M at the end of the current
1956 minibuffer contents. This is used to display things like
1957 "[No Match]" when the user requests a completion for a prefix
1958 that has no possible completions, and other quick, unobtrusive
1959 messages. */
1960
1961 void
1962 temp_echo_area_glyphs (m)
1963 char *m;
1964 {
1965 int osize = ZV;
1966 int osize_byte = ZV_BYTE;
1967 int opoint = PT;
1968 int opoint_byte = PT_BYTE;
1969 Lisp_Object oinhibit;
1970 oinhibit = Vinhibit_quit;
1971
1972 /* Clear out any old echo-area message to make way for our new thing. */
1973 message (0);
1974
1975 SET_PT_BOTH (osize, osize_byte);
1976 insert_string (m);
1977 SET_PT_BOTH (opoint, opoint_byte);
1978 Vinhibit_quit = Qt;
1979 Fsit_for (make_number (2), Qnil, Qnil);
1980 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
1981 SET_PT_BOTH (opoint, opoint_byte);
1982 if (!NILP (Vquit_flag))
1983 {
1984 Vquit_flag = Qnil;
1985 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
1986 }
1987 Vinhibit_quit = oinhibit;
1988 }
1989
1990 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
1991 1, 1, 0,
1992 "Temporarily display STRING at the end of the minibuffer.\n\
1993 The text is displayed for two seconds,\n\
1994 or until the next input event arrives, whichever comes first.")
1995 (string)
1996 Lisp_Object string;
1997 {
1998 temp_echo_area_glyphs (XSTRING (string)->data);
1999 return Qnil;
2000 }
2001 \f
2002 void
2003 init_minibuf_once ()
2004 {
2005 Vminibuffer_list = Qnil;
2006 staticpro (&Vminibuffer_list);
2007 }
2008
2009 void
2010 syms_of_minibuf ()
2011 {
2012 minibuf_level = 0;
2013 minibuf_prompt = Qnil;
2014 staticpro (&minibuf_prompt);
2015
2016 minibuf_save_list = Qnil;
2017 staticpro (&minibuf_save_list);
2018
2019 Qread_file_name_internal = intern ("read-file-name-internal");
2020 staticpro (&Qread_file_name_internal);
2021
2022 Qminibuffer_default = intern ("minibuffer-default");
2023 staticpro (&Qminibuffer_default);
2024 Fset (Qminibuffer_default, Qnil);
2025
2026 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2027 staticpro (&Qminibuffer_completion_table);
2028
2029 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2030 staticpro (&Qminibuffer_completion_confirm);
2031
2032 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2033 staticpro (&Qminibuffer_completion_predicate);
2034
2035 staticpro (&last_exact_completion);
2036 last_exact_completion = Qnil;
2037
2038 staticpro (&last_minibuf_string);
2039 last_minibuf_string = Qnil;
2040
2041 Quser_variable_p = intern ("user-variable-p");
2042 staticpro (&Quser_variable_p);
2043
2044 Qminibuffer_history = intern ("minibuffer-history");
2045 staticpro (&Qminibuffer_history);
2046
2047 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2048 staticpro (&Qminibuffer_setup_hook);
2049
2050 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2051 staticpro (&Qminibuffer_exit_hook);
2052
2053 Qhistory_length = intern ("history-length");
2054 staticpro (&Qhistory_length);
2055
2056 Qcurrent_input_method = intern ("current-input-method");
2057 staticpro (&Qcurrent_input_method);
2058
2059 Qactivate_input_method = intern ("activate-input-method");
2060 staticpro (&Qactivate_input_method);
2061
2062 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2063 "If this is non-nil, `read-buffer' does its work by calling this function.");
2064 Vread_buffer_function = Qnil;
2065
2066 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2067 "Normal hook run just after entry to minibuffer.");
2068 Vminibuffer_setup_hook = Qnil;
2069
2070 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2071 "Normal hook run just after exit from minibuffer.");
2072 Vminibuffer_exit_hook = Qnil;
2073
2074 DEFVAR_LISP ("history-length", &Vhistory_length,
2075 "*Maximum length for history lists before truncation takes place.\n\
2076 A number means that length; t means infinite. Truncation takes place\n\
2077 just after a new element is inserted. Setting the history-length\n\
2078 property of a history variable overrides this default.");
2079 XSETFASTINT (Vhistory_length, 30);
2080
2081 DEFVAR_BOOL ("completion-auto-help", &auto_help,
2082 "*Non-nil means automatically provide help for invalid completion input.");
2083 auto_help = 1;
2084
2085 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2086 "Non-nil means don't consider case significant in completion.");
2087 completion_ignore_case = 0;
2088
2089 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2090 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2091 This variable makes a difference whenever the minibuffer window is active.");
2092 enable_recursive_minibuffers = 0;
2093
2094 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2095 "Alist or obarray used for completion in the minibuffer.\n\
2096 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2097 \n\
2098 The value may alternatively be a function, which is given three arguments:\n\
2099 STRING, the current buffer contents;\n\
2100 PREDICATE, the predicate for filtering possible matches;\n\
2101 CODE, which says what kind of things to do.\n\
2102 CODE can be nil, t or `lambda'.\n\
2103 nil means to return the best completion of STRING, or nil if there is none.\n\
2104 t means to return a list of all possible completions of STRING.\n\
2105 `lambda' means to return t if STRING is a valid completion as it stands.");
2106 Vminibuffer_completion_table = Qnil;
2107
2108 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2109 "Within call to `completing-read', this holds the PREDICATE argument.");
2110 Vminibuffer_completion_predicate = Qnil;
2111
2112 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2113 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2114 Vminibuffer_completion_confirm = Qnil;
2115
2116 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2117 "Value that `help-form' takes on inside the minibuffer.");
2118 Vminibuffer_help_form = Qnil;
2119
2120 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2121 "History list symbol to add minibuffer values to.\n\
2122 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2123 is added with\n\
2124 (set minibuffer-history-variable\n\
2125 (cons STRING (symbol-value minibuffer-history-variable)))");
2126 XSETFASTINT (Vminibuffer_history_variable, 0);
2127
2128 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2129 "Current position of redoing in the history list.");
2130 Vminibuffer_history_position = Qnil;
2131
2132 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2133 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2134 Some uses of the echo area also raise that frame (since they use it too).");
2135 minibuffer_auto_raise = 0;
2136
2137 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2138 "List of regexps that should restrict possible completions.");
2139 Vcompletion_regexp_list = Qnil;
2140
2141 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2142 &minibuffer_allow_text_properties,
2143 "Non-nil means `read-from-miniffer' should not discard text properties.\n\
2144 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2145 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2146 with completion; they always discard text properties.");
2147 minibuffer_allow_text_properties = 0;
2148
2149 defsubr (&Sset_minibuffer_window);
2150 defsubr (&Sread_from_minibuffer);
2151 defsubr (&Seval_minibuffer);
2152 defsubr (&Sread_minibuffer);
2153 defsubr (&Sread_string);
2154 defsubr (&Sread_command);
2155 defsubr (&Sread_variable);
2156 defsubr (&Sread_buffer);
2157 defsubr (&Sread_no_blanks_input);
2158 defsubr (&Sminibuffer_depth);
2159 defsubr (&Sminibuffer_prompt);
2160 defsubr (&Sminibuffer_prompt_width);
2161
2162 defsubr (&Stry_completion);
2163 defsubr (&Sall_completions);
2164 defsubr (&Scompleting_read);
2165 defsubr (&Sminibuffer_complete);
2166 defsubr (&Sminibuffer_complete_word);
2167 defsubr (&Sminibuffer_complete_and_exit);
2168 defsubr (&Sdisplay_completion_list);
2169 defsubr (&Sminibuffer_completion_help);
2170
2171 defsubr (&Sself_insert_and_exit);
2172 defsubr (&Sexit_minibuffer);
2173
2174 defsubr (&Sminibuffer_message);
2175 }
2176
2177 void
2178 keys_of_minibuf ()
2179 {
2180 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2181 "abort-recursive-edit");
2182 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2183 "exit-minibuffer");
2184 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2185 "exit-minibuffer");
2186
2187 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
2188 "abort-recursive-edit");
2189 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
2190 "exit-minibuffer");
2191 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
2192 "exit-minibuffer");
2193
2194 initial_define_key (Vminibuffer_local_ns_map, ' ',
2195 "exit-minibuffer");
2196 initial_define_key (Vminibuffer_local_ns_map, '\t',
2197 "exit-minibuffer");
2198 initial_define_key (Vminibuffer_local_ns_map, '?',
2199 "self-insert-and-exit");
2200
2201 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
2202 "abort-recursive-edit");
2203 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
2204 "exit-minibuffer");
2205 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
2206 "exit-minibuffer");
2207
2208 initial_define_key (Vminibuffer_local_completion_map, '\t',
2209 "minibuffer-complete");
2210 initial_define_key (Vminibuffer_local_completion_map, ' ',
2211 "minibuffer-complete-word");
2212 initial_define_key (Vminibuffer_local_completion_map, '?',
2213 "minibuffer-completion-help");
2214
2215 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
2216 "abort-recursive-edit");
2217 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2218 "minibuffer-complete-and-exit");
2219 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2220 "minibuffer-complete-and-exit");
2221 initial_define_key (Vminibuffer_local_must_match_map, '\t',
2222 "minibuffer-complete");
2223 initial_define_key (Vminibuffer_local_must_match_map, ' ',
2224 "minibuffer-complete-word");
2225 initial_define_key (Vminibuffer_local_must_match_map, '?',
2226 "minibuffer-completion-help");
2227 }