(test_completion): Pass both kinds of size to oblookup.
[bpt/emacs.git] / src / minibuf.c
1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997
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 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (defalt))
425 val = defalt;
426
427 last_minibuf_string = val;
428
429 /* Add the value to the appropriate history list unless it is empty. */
430 if (XSTRING (val)->size != 0
431 && SYMBOLP (Vminibuffer_history_variable)
432 && ! EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
433 {
434 /* If the caller wanted to save the value read on a history list,
435 then do so if the value is not already the front of the list. */
436 Lisp_Object histval;
437 histval = Fsymbol_value (Vminibuffer_history_variable);
438
439 /* The value of the history variable must be a cons or nil. Other
440 values are unacceptable. We silently ignore these values. */
441 if (NILP (histval)
442 || (CONSP (histval)
443 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
444 {
445 Lisp_Object length;
446
447 histval = Fcons (last_minibuf_string, histval);
448 Fset (Vminibuffer_history_variable, histval);
449
450 /* Truncate if requested. */
451 length = Fget (Vminibuffer_history_variable, Qhistory_length);
452 if (NILP (length)) length = Vhistory_length;
453 if (INTEGERP (length))
454 {
455 if (XINT (length) <= 0)
456 Fset (Vminibuffer_history_variable, Qnil);
457 else
458 {
459 Lisp_Object temp;
460
461 temp = Fnthcdr (Fsub1 (length), histval);
462 if (CONSP (temp)) Fsetcdr (temp, Qnil);
463 }
464 }
465 }
466 }
467
468 /* If Lisp form desired instead of string, parse it. */
469 if (expflag)
470 {
471 Lisp_Object expr_and_pos;
472 unsigned char *p;
473
474 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
475 /* Ignore trailing whitespace; any other trailing junk is an error. */
476 for (p = XSTRING (val)->data + XINT (Fcdr (expr_and_pos)); *p; p++)
477 if (*p != ' ' && *p != '\t' && *p != '\n')
478 error ("Trailing garbage following expression");
479 val = Fcar (expr_and_pos);
480 }
481
482 /* The appropriate frame will get selected
483 in set-window-configuration. */
484 RETURN_UNGCPRO (unbind_to (count, val));
485 }
486
487 /* Return a buffer to be used as the minibuffer at depth `depth'.
488 depth = 0 is the lowest allowed argument, and that is the value
489 used for nonrecursive minibuffer invocations */
490
491 Lisp_Object
492 get_minibuffer (depth)
493 int depth;
494 {
495 Lisp_Object tail, num, buf;
496 char name[24];
497 extern Lisp_Object nconc2 ();
498
499 XSETFASTINT (num, depth);
500 tail = Fnthcdr (num, Vminibuffer_list);
501 if (NILP (tail))
502 {
503 tail = Fcons (Qnil, Qnil);
504 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
505 }
506 buf = Fcar (tail);
507 if (NILP (buf) || NILP (XBUFFER (buf)->name))
508 {
509 sprintf (name, " *Minibuf-%d*", depth);
510 buf = Fget_buffer_create (build_string (name));
511
512 /* Although the buffer's name starts with a space, undo should be
513 enabled in it. */
514 Fbuffer_enable_undo (buf);
515
516 XCONS (tail)->car = buf;
517 }
518 else
519 {
520 int count = specpdl_ptr - specpdl;
521
522 reset_buffer (XBUFFER (buf));
523 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
524 Fset_buffer (buf);
525 Fkill_all_local_variables ();
526 unbind_to (count, Qnil);
527 }
528
529 return buf;
530 }
531
532 /* This function is called on exiting minibuffer, whether normally or not,
533 and it restores the current window, buffer, etc. */
534
535 static Lisp_Object
536 read_minibuf_unwind (data)
537 Lisp_Object data;
538 {
539 Lisp_Object old_deactivate_mark;
540 Lisp_Object window;
541
542 /* We are exiting the minibuffer one way or the other,
543 so run the hook. */
544 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
545 && !NILP (Vrun_hooks))
546 safe_run_hooks (Qminibuffer_exit_hook);
547
548 /* If this was a recursive minibuffer,
549 tie the minibuffer window back to the outer level minibuffer buffer. */
550 minibuf_level--;
551
552 window = minibuf_window;
553 /* To keep things predictable, in case it matters, let's be in the minibuffer
554 when we reset the relevant variables. */
555 Fset_buffer (XWINDOW (window)->buffer);
556
557 /* Restore prompt, etc, from outer minibuffer level. */
558 minibuf_prompt = Fcar (minibuf_save_list);
559 minibuf_save_list = Fcdr (minibuf_save_list);
560 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
561 minibuf_save_list = Fcdr (minibuf_save_list);
562 Vhelp_form = Fcar (minibuf_save_list);
563 minibuf_save_list = Fcdr (minibuf_save_list);
564 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
565 minibuf_save_list = Fcdr (minibuf_save_list);
566 Vminibuffer_history_position = Fcar (minibuf_save_list);
567 minibuf_save_list = Fcdr (minibuf_save_list);
568 Vminibuffer_history_variable = Fcar (minibuf_save_list);
569 minibuf_save_list = Fcdr (minibuf_save_list);
570 Voverriding_local_map = Fcar (minibuf_save_list);
571 minibuf_save_list = Fcdr (minibuf_save_list);
572 #if 0
573 temp = Fcar (minibuf_save_list);
574 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
575 minibuf_window = temp;
576 #endif
577 minibuf_save_list = Fcdr (minibuf_save_list);
578
579 /* Erase the minibuffer we were using at this level. */
580 {
581 int count = specpdl_ptr - specpdl;
582 /* Prevent error in erase-buffer. */
583 specbind (Qinhibit_read_only, Qt);
584 old_deactivate_mark = Vdeactivate_mark;
585 Ferase_buffer ();
586 Vdeactivate_mark = old_deactivate_mark;
587 unbind_to (count, Qnil);
588 }
589
590 /* Make sure minibuffer window is erased, not ignored. */
591 windows_or_buffers_changed++;
592 XSETFASTINT (XWINDOW (window)->last_modified, 0);
593 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
594
595 return Qnil;
596 }
597 \f
598
599 /* This comment supplies the doc string for read-from-minibuffer,
600 for make-docfile to see. We cannot put this in the real DEFUN
601 due to limits in the Unix cpp.
602
603 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
604 "Read a string from the minibuffer, prompting with string PROMPT.\n\
605 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
606 to be inserted into the minibuffer before reading input.\n\
607 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
608 is STRING, but point is placed at position POSITION in the minibuffer.\n\
609 Third arg KEYMAP is a keymap to use whilst reading;\n\
610 if omitted or nil, the default is `minibuffer-local-map'.\n\
611 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
612 and return that object:\n\
613 in other words, do `(car (read-from-string INPUT-STRING))'\n\
614 Fifth arg HIST, if non-nil, specifies a history list\n\
615 and optionally the initial position in the list.\n\
616 It can be a symbol, which is the history list variable to use,\n\
617 or it can be a cons cell (HISTVAR . HISTPOS).\n\
618 In that case, HISTVAR is the history list variable to use,\n\
619 and HISTPOS is the initial position (the position in the list\n\
620 which INITIAL-CONTENTS corresponds to).\n\
621 Positions are counted starting from 1 at the beginning of the list.\n\
622 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
623 for history commands, and as the value to return if the user enters\n\
624 the empty string.\n\
625 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
626 the current input method and the setting of enable-multibyte-characters.\n\
627 If the variable `minibuffer-allow-text-properties is non-nil,\n\
628 then the string which is returned includes whatever text properties\n\
629 were present in the minibuffer. Otherwise the value has no text properties.")
630 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
631 */
632
633 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
634 0 /* See immediately above */)
635 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
636 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
637 Lisp_Object inherit_input_method;
638 {
639 int pos = 0;
640 Lisp_Object histvar, histpos, position, val;
641 struct gcpro gcpro1;
642
643 position = Qnil;
644
645 CHECK_STRING (prompt, 0);
646 if (!NILP (initial_contents))
647 {
648 if (CONSP (initial_contents))
649 {
650 position = Fcdr (initial_contents);
651 initial_contents = Fcar (initial_contents);
652 }
653 CHECK_STRING (initial_contents, 1);
654 if (!NILP (position))
655 {
656 CHECK_NUMBER (position, 0);
657 /* Convert to distance from end of input. */
658 if (XINT (position) < 1)
659 /* A number too small means the beginning of the string. */
660 pos = - XSTRING (initial_contents)->size;
661 else
662 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
663 }
664 }
665
666 if (NILP (keymap))
667 keymap = Vminibuffer_local_map;
668 else
669 keymap = get_keymap (keymap);
670
671 if (SYMBOLP (hist))
672 {
673 histvar = hist;
674 histpos = Qnil;
675 }
676 else
677 {
678 histvar = Fcar_safe (hist);
679 histpos = Fcdr_safe (hist);
680 }
681 if (NILP (histvar))
682 histvar = Qminibuffer_history;
683 if (NILP (histpos))
684 XSETFASTINT (histpos, 0);
685
686 GCPRO1 (default_value);
687 val = read_minibuf (keymap, initial_contents, prompt,
688 make_number (pos), !NILP (read),
689 histvar, histpos, default_value,
690 minibuffer_allow_text_properties,
691 !NILP (inherit_input_method));
692 UNGCPRO;
693 return val;
694 }
695
696 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
697 "Return a Lisp object read using the minibuffer.\n\
698 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
699 is a string to insert in the minibuffer before reading.")
700 (prompt, initial_contents)
701 Lisp_Object prompt, initial_contents;
702 {
703 CHECK_STRING (prompt, 0);
704 if (!NILP (initial_contents))
705 CHECK_STRING (initial_contents, 1);
706 return read_minibuf (Vminibuffer_local_map, initial_contents,
707 prompt, Qnil, 1, Qminibuffer_history,
708 make_number (0), Qnil, 0, 0);
709 }
710
711 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
712 "Return value of Lisp expression read using the minibuffer.\n\
713 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
714 is a string to insert in the minibuffer before reading.")
715 (prompt, initial_contents)
716 Lisp_Object prompt, initial_contents;
717 {
718 return Feval (Fread_minibuffer (prompt, initial_contents));
719 }
720
721 /* Functions that use the minibuffer to read various things. */
722
723 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
724 "Read a string from the minibuffer, prompting with string PROMPT.\n\
725 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
726 The third arg HISTORY, if non-nil, specifies a history list\n\
727 and optionally the initial position in the list.\n\
728 See `read-from-minibuffer' for details of HISTORY argument.\n\
729 Fourth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
730 the current input method and the setting of enable-multibyte-characters.")
731 (prompt, initial_input, history, default_value, inherit_input_method)
732 Lisp_Object prompt, initial_input, history, default_value;
733 Lisp_Object inherit_input_method;
734 {
735 return Fread_from_minibuffer (prompt, initial_input, Qnil,
736 Qnil, history, default_value,
737 inherit_input_method);
738 }
739
740 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
741 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
742 Prompt with PROMPT, and provide INIT as an initial value of the input string.\n\
743 Third 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, init, inherit_input_method)
746 Lisp_Object prompt, init, inherit_input_method;
747 {
748 CHECK_STRING (prompt, 0);
749 if (! NILP (init))
750 CHECK_STRING (init, 1);
751
752 return read_minibuf (Vminibuffer_local_ns_map, init, prompt, Qnil,
753 0, Qminibuffer_history, make_number (0), Qnil, 0,
754 !NILP (inherit_input_method));
755 }
756
757 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
758 "Read the name of a command and return as a symbol.\n\
759 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
760 (prompt, default_value)
761 Lisp_Object prompt, default_value;
762 {
763 Lisp_Object name, default_string;
764
765 if (NILP (default_value))
766 default_string = Qnil;
767 else if (SYMBOLP (default_value))
768 XSETSTRING (default_string, XSYMBOL (default_value)->name);
769 else
770 default_string = default_value;
771
772 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
773 Qnil, Qnil, default_string, Qnil);
774 if (NILP (name))
775 return name;
776 return Fintern (name, Qnil);
777 }
778
779 #ifdef NOTDEF
780 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
781 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
782 Prompts with PROMPT.")
783 (prompt)
784 Lisp_Object prompt;
785 {
786 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
787 Qnil);
788 }
789 #endif /* NOTDEF */
790
791 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
792 "Read the name of a user variable and return it as a symbol.\n\
793 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
794 A user variable is one whose documentation starts with a `*' character.")
795 (prompt, default_value)
796 Lisp_Object prompt, default_value;
797 {
798 Lisp_Object name, default_string;
799
800 if (NILP (default_value))
801 default_string = Qnil;
802 else if (SYMBOLP (default_value))
803 XSETSTRING (default_string, XSYMBOL (default_value)->name);
804 else
805 default_string = default_value;
806
807 name = Fcompleting_read (prompt, Vobarray,
808 Quser_variable_p, Qt,
809 Qnil, Qnil, default_string, Qnil);
810 if (NILP (name))
811 return name;
812 return Fintern (name, Qnil);
813 }
814
815 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
816 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
817 Prompts with PROMPT.\n\
818 Optional second arg DEF is value to return if user enters an empty line.\n\
819 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
820 (prompt, def, require_match)
821 Lisp_Object prompt, def, require_match;
822 {
823 Lisp_Object tem;
824 Lisp_Object args[4];
825
826 if (BUFFERP (def))
827 def = XBUFFER (def)->name;
828
829 if (NILP (Vread_buffer_function))
830 {
831 if (!NILP (def))
832 {
833 args[0] = build_string ("%s(default %s) ");
834 args[1] = prompt;
835 args[2] = def;
836 prompt = Fformat (3, args);
837 }
838
839 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
840 require_match, Qnil, Qnil, def, Qnil);
841 }
842 else
843 {
844 args[0] = Vread_buffer_function;
845 args[1] = prompt;
846 args[2] = def;
847 args[3] = require_match;
848 return Ffuncall(4, args);
849 }
850 }
851 \f
852 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
853 "Return common substring of all completions of STRING in ALIST.\n\
854 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
855 All that match are compared together; the longest initial sequence\n\
856 common to all matches is returned as a string.\n\
857 If there is no match at all, nil is returned.\n\
858 For an exact match, t is returned.\n\
859 \n\
860 ALIST can be an obarray instead of an alist.\n\
861 Then the print names of all symbols in the obarray are the possible matches.\n\
862 \n\
863 ALIST can also be a function to do the completion itself.\n\
864 It receives three arguments: the values STRING, PREDICATE and nil.\n\
865 Whatever it returns becomes the value of `try-completion'.\n\
866 \n\
867 If optional third argument PREDICATE is non-nil,\n\
868 it is used to test each possible match.\n\
869 The match is a candidate only if PREDICATE returns non-nil.\n\
870 The argument given to PREDICATE is the alist element\n\
871 or the symbol from the obarray.")
872 (string, alist, predicate)
873 Lisp_Object string, alist, predicate;
874 {
875 Lisp_Object bestmatch, tail, elt, eltstring;
876 /* Size in bytes of BESTMATCH. */
877 int bestmatchsize;
878 /* These are in bytes, too. */
879 int compare, matchsize;
880 int list = CONSP (alist) || NILP (alist);
881 int index, obsize;
882 int matchcount = 0;
883 Lisp_Object bucket, zero, end, tem;
884 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
885
886 CHECK_STRING (string, 0);
887 if (!list && !VECTORP (alist))
888 return call3 (alist, string, predicate, Qnil);
889
890 bestmatch = Qnil;
891
892 /* If ALIST is not a list, set TAIL just for gc pro. */
893 tail = alist;
894 if (! list)
895 {
896 index = 0;
897 obsize = XVECTOR (alist)->size;
898 bucket = XVECTOR (alist)->contents[index];
899 }
900
901 while (1)
902 {
903 /* Get the next element of the alist or obarray. */
904 /* Exit the loop if the elements are all used up. */
905 /* elt gets the alist element or symbol.
906 eltstring gets the name to check as a completion. */
907
908 if (list)
909 {
910 if (NILP (tail))
911 break;
912 elt = Fcar (tail);
913 eltstring = Fcar (elt);
914 tail = Fcdr (tail);
915 }
916 else
917 {
918 if (XFASTINT (bucket) != 0)
919 {
920 elt = bucket;
921 eltstring = Fsymbol_name (elt);
922 if (XSYMBOL (bucket)->next)
923 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
924 else
925 XSETFASTINT (bucket, 0);
926 }
927 else if (++index >= obsize)
928 break;
929 else
930 {
931 bucket = XVECTOR (alist)->contents[index];
932 continue;
933 }
934 }
935
936 /* Is this element a possible completion? */
937
938 if (STRINGP (eltstring)
939 && XSTRING (string)->size_byte <= XSTRING (eltstring)->size_byte
940 && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
941 XSTRING (string)->size_byte))
942 {
943 /* Yes. */
944 Lisp_Object regexps;
945 Lisp_Object zero;
946 XSETFASTINT (zero, 0);
947
948 /* Ignore this element if it fails to match all the regexps. */
949 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
950 regexps = XCONS (regexps)->cdr)
951 {
952 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
953 if (NILP (tem))
954 break;
955 }
956 if (CONSP (regexps))
957 continue;
958
959 /* Ignore this element if there is a predicate
960 and the predicate doesn't like it. */
961
962 if (!NILP (predicate))
963 {
964 if (EQ (predicate, Qcommandp))
965 tem = Fcommandp (elt);
966 else
967 {
968 GCPRO4 (tail, string, eltstring, bestmatch);
969 tem = call1 (predicate, elt);
970 UNGCPRO;
971 }
972 if (NILP (tem)) continue;
973 }
974
975 /* Update computation of how much all possible completions match */
976
977 matchcount++;
978 if (NILP (bestmatch))
979 {
980 bestmatch = eltstring;
981 bestmatchsize = XSTRING (eltstring)->size_byte;
982 }
983 else
984 {
985 compare = min (bestmatchsize, XSTRING (eltstring)->size_byte);
986 matchsize = scmp (XSTRING (bestmatch)->data,
987 XSTRING (eltstring)->data,
988 compare);
989 if (matchsize < 0)
990 matchsize = compare;
991 if (completion_ignore_case)
992 {
993 /* If this is an exact match except for case,
994 use it as the best match rather than one that is not an
995 exact match. This way, we get the case pattern
996 of the actual match. */
997 if ((matchsize == XSTRING (eltstring)->size_byte
998 && matchsize < XSTRING (bestmatch)->size_byte)
999 ||
1000 /* If there is more than one exact match ignoring case,
1001 and one of them is exact including case,
1002 prefer that one. */
1003 /* If there is no exact match ignoring case,
1004 prefer a match that does not change the case
1005 of the input. */
1006 ((matchsize == XSTRING (eltstring)->size_byte)
1007 ==
1008 (matchsize == XSTRING (bestmatch)->size_byte)
1009 && !bcmp (XSTRING (eltstring)->data,
1010 XSTRING (string)->data,
1011 XSTRING (string)->size_byte)
1012 && bcmp (XSTRING (bestmatch)->data,
1013 XSTRING (string)->data,
1014 XSTRING (string)->size_byte)))
1015 bestmatch = eltstring;
1016 }
1017 bestmatchsize = matchsize;
1018 }
1019 }
1020 }
1021
1022 if (NILP (bestmatch))
1023 return Qnil; /* No completions found */
1024 /* If we are ignoring case, and there is no exact match,
1025 and no additional text was supplied,
1026 don't change the case of what the user typed. */
1027 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size_byte
1028 && XSTRING (bestmatch)->size_byte > bestmatchsize)
1029 return string;
1030
1031 /* Return t if the supplied string is an exact match (counting case);
1032 it does not require any change to be made. */
1033 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size_byte
1034 && !bcmp (XSTRING (bestmatch)->data, XSTRING (string)->data,
1035 bestmatchsize))
1036 return Qt;
1037
1038 bestmatchsize = string_byte_to_char (bestmatch, bestmatchsize);
1039
1040 XSETFASTINT (zero, 0); /* Else extract the part in which */
1041 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1042 return Fsubstring (bestmatch, zero, end);
1043 }
1044
1045 /* Compare exactly LEN chars of strings at S1 and S2,
1046 ignoring case if appropriate.
1047 Return -1 if strings match,
1048 else number of chars that match at the beginning. */
1049
1050 int
1051 scmp (s1, s2, len)
1052 register unsigned char *s1, *s2;
1053 int len;
1054 {
1055 register int l = len;
1056 register unsigned char *start = s1;
1057
1058 if (completion_ignore_case)
1059 {
1060 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
1061 l--;
1062 }
1063 else
1064 {
1065 while (l && *s1++ == *s2++)
1066 l--;
1067 }
1068 if (l == 0)
1069 return -1;
1070 else
1071 {
1072 int match = len - l;
1073
1074 /* Now *--S1 is the unmatching byte. If it is in the middle of
1075 multi-byte form, we must say that the multi-byte character
1076 there doesn't match. */
1077 while (match && *--s1 >= 0xA0) match--;
1078 return match;
1079 }
1080 }
1081 \f
1082 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1083 "Search for partial matches to STRING in ALIST.\n\
1084 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1085 The value is a list of all the strings from ALIST that match.\n\
1086 \n\
1087 ALIST can be an obarray instead of an alist.\n\
1088 Then the print names of all symbols in the obarray are the possible matches.\n\
1089 \n\
1090 ALIST can also be a function to do the completion itself.\n\
1091 It receives three arguments: the values STRING, PREDICATE and t.\n\
1092 Whatever it returns becomes the value of `all-completion'.\n\
1093 \n\
1094 If optional third argument PREDICATE is non-nil,\n\
1095 it is used to test each possible match.\n\
1096 The match is a candidate only if PREDICATE returns non-nil.\n\
1097 The argument given to PREDICATE is the alist element\n\
1098 or the symbol from the obarray.\n\
1099 \n\
1100 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1101 strings in ALIST that start with a space\n\
1102 are ignored unless STRING itself starts with a space.")
1103 (string, alist, predicate, hide_spaces)
1104 Lisp_Object string, alist, predicate, hide_spaces;
1105 {
1106 Lisp_Object tail, elt, eltstring;
1107 Lisp_Object allmatches;
1108 int list = CONSP (alist) || NILP (alist);
1109 int index, obsize;
1110 Lisp_Object bucket, tem;
1111 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1112
1113 CHECK_STRING (string, 0);
1114 if (!list && !VECTORP (alist))
1115 {
1116 return call3 (alist, string, predicate, Qt);
1117 }
1118 allmatches = Qnil;
1119
1120 /* If ALIST is not a list, set TAIL just for gc pro. */
1121 tail = alist;
1122 if (! list)
1123 {
1124 index = 0;
1125 obsize = XVECTOR (alist)->size;
1126 bucket = XVECTOR (alist)->contents[index];
1127 }
1128
1129 while (1)
1130 {
1131 /* Get the next element of the alist or obarray. */
1132 /* Exit the loop if the elements are all used up. */
1133 /* elt gets the alist element or symbol.
1134 eltstring gets the name to check as a completion. */
1135
1136 if (list)
1137 {
1138 if (NILP (tail))
1139 break;
1140 elt = Fcar (tail);
1141 eltstring = Fcar (elt);
1142 tail = Fcdr (tail);
1143 }
1144 else
1145 {
1146 if (XFASTINT (bucket) != 0)
1147 {
1148 elt = bucket;
1149 eltstring = Fsymbol_name (elt);
1150 if (XSYMBOL (bucket)->next)
1151 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1152 else
1153 XSETFASTINT (bucket, 0);
1154 }
1155 else if (++index >= obsize)
1156 break;
1157 else
1158 {
1159 bucket = XVECTOR (alist)->contents[index];
1160 continue;
1161 }
1162 }
1163
1164 /* Is this element a possible completion? */
1165
1166 if (STRINGP (eltstring)
1167 && XSTRING (string)->size_byte <= XSTRING (eltstring)->size_byte
1168 /* If HIDE_SPACES, reject alternatives that start with space
1169 unless the input starts with space. */
1170 && ((XSTRING (string)->size_byte > 0
1171 && XSTRING (string)->data[0] == ' ')
1172 || XSTRING (eltstring)->data[0] != ' '
1173 || NILP (hide_spaces))
1174 && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
1175 XSTRING (string)->size_byte))
1176 {
1177 /* Yes. */
1178 Lisp_Object regexps;
1179 Lisp_Object zero;
1180 XSETFASTINT (zero, 0);
1181
1182 /* Ignore this element if it fails to match all the regexps. */
1183 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1184 regexps = XCONS (regexps)->cdr)
1185 {
1186 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
1187 if (NILP (tem))
1188 break;
1189 }
1190 if (CONSP (regexps))
1191 continue;
1192
1193 /* Ignore this element if there is a predicate
1194 and the predicate doesn't like it. */
1195
1196 if (!NILP (predicate))
1197 {
1198 if (EQ (predicate, Qcommandp))
1199 tem = Fcommandp (elt);
1200 else
1201 {
1202 GCPRO4 (tail, eltstring, allmatches, string);
1203 tem = call1 (predicate, elt);
1204 UNGCPRO;
1205 }
1206 if (NILP (tem)) continue;
1207 }
1208 /* Ok => put it on the list. */
1209 allmatches = Fcons (eltstring, allmatches);
1210 }
1211 }
1212
1213 return Fnreverse (allmatches);
1214 }
1215 \f
1216 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1217 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1218 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1219
1220 /* This comment supplies the doc string for completing-read,
1221 for make-docfile to see. We cannot put this in the real DEFUN
1222 due to limits in the Unix cpp.
1223
1224 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1225 "Read a string in the minibuffer, with completion.\n\
1226 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1227 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1228 PREDICATE limits completion to a subset of TABLE.\n\
1229 See `try-completion' and `all-completions' for more details
1230 on completion, TABLE, and PREDICATE.\n\
1231 \n\
1232 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1233 the input is (or completes to) an element of TABLE or is null.\n\
1234 If it is also not t, Return does not exit if it does non-null completion.\n\
1235 If the input is null, `completing-read' returns an empty string,\n\
1236 regardless of the value of REQUIRE-MATCH.\n\
1237 \n\
1238 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1239 If it is (STRING . POSITION), the initial input\n\
1240 is STRING, but point is placed POSITION characters into the string.\n\
1241 HIST, if non-nil, specifies a history list\n\
1242 and optionally the initial position in the list.\n\
1243 It can be a symbol, which is the history list variable to use,\n\
1244 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1245 In that case, HISTVAR is the history list variable to use,\n\
1246 and HISTPOS is the initial position (the position in the list\n\
1247 which INITIAL-INPUT corresponds to).\n\
1248 Positions are counted starting from 1 at the beginning of the list.\n\
1249 DEF, if non-nil, is the default value.\n\
1250 \n\
1251 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1252 the current input method and the setting of enable-multibyte-characters.\n\
1253 \n\
1254 Completion ignores case if the ambient value of\n\
1255 `completion-ignore-case' is non-nil."
1256 */
1257 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1258 0 /* See immediately above */)
1259 (prompt, table, predicate, require_match, init, hist, def, inherit_input_method)
1260 Lisp_Object prompt, table, predicate, require_match, init, hist, def;
1261 Lisp_Object inherit_input_method;
1262 {
1263 Lisp_Object val, histvar, histpos, position;
1264 int pos = 0;
1265 int count = specpdl_ptr - specpdl;
1266 struct gcpro gcpro1;
1267 int disable_multibyte = EQ (table, Qread_file_name_internal);
1268
1269 GCPRO1 (def);
1270
1271 specbind (Qminibuffer_completion_table, table);
1272 specbind (Qminibuffer_completion_predicate, predicate);
1273 specbind (Qminibuffer_completion_confirm,
1274 EQ (require_match, Qt) ? Qnil : Qt);
1275 last_exact_completion = Qnil;
1276
1277 position = Qnil;
1278 if (!NILP (init))
1279 {
1280 if (CONSP (init))
1281 {
1282 position = Fcdr (init);
1283 init = Fcar (init);
1284 }
1285 CHECK_STRING (init, 0);
1286 if (!NILP (position))
1287 {
1288 CHECK_NUMBER (position, 0);
1289 /* Convert to distance from end of input. */
1290 pos = XINT (position) - XSTRING (init)->size;
1291 }
1292 }
1293
1294 if (SYMBOLP (hist))
1295 {
1296 histvar = hist;
1297 histpos = Qnil;
1298 }
1299 else
1300 {
1301 histvar = Fcar_safe (hist);
1302 histpos = Fcdr_safe (hist);
1303 }
1304 if (NILP (histvar))
1305 histvar = Qminibuffer_history;
1306 if (NILP (histpos))
1307 XSETFASTINT (histpos, 0);
1308
1309 val = read_minibuf (NILP (require_match)
1310 ? Vminibuffer_local_completion_map
1311 : Vminibuffer_local_must_match_map,
1312 init, prompt, make_number (pos), 0,
1313 histvar, histpos, def, 0,
1314 !NILP (inherit_input_method));
1315 RETURN_UNGCPRO (unbind_to (count, val));
1316 }
1317 \f
1318 Lisp_Object Fminibuffer_completion_help ();
1319 Lisp_Object assoc_for_completion ();
1320
1321 /* Test whether TXT is an exact completion. */
1322 Lisp_Object
1323 test_completion (txt)
1324 Lisp_Object txt;
1325 {
1326 Lisp_Object tem;
1327
1328 if (CONSP (Vminibuffer_completion_table)
1329 || NILP (Vminibuffer_completion_table))
1330 return assoc_for_completion (txt, Vminibuffer_completion_table);
1331 else if (VECTORP (Vminibuffer_completion_table))
1332 {
1333 /* Bypass intern-soft as that loses for nil */
1334 tem = oblookup (Vminibuffer_completion_table,
1335 XSTRING (txt)->data,
1336 XSTRING (txt)->size,
1337 XSTRING (txt)->size_byte);
1338 if (!SYMBOLP (tem))
1339 return Qnil;
1340 else if (!NILP (Vminibuffer_completion_predicate))
1341 return call1 (Vminibuffer_completion_predicate, tem);
1342 else
1343 return Qt;
1344 }
1345 else
1346 return call3 (Vminibuffer_completion_table, txt,
1347 Vminibuffer_completion_predicate, Qlambda);
1348 }
1349
1350 /* returns:
1351 * 0 no possible completion
1352 * 1 was already an exact and unique completion
1353 * 3 was already an exact completion
1354 * 4 completed to an exact completion
1355 * 5 some completion happened
1356 * 6 no completion happened
1357 */
1358 int
1359 do_completion ()
1360 {
1361 Lisp_Object completion, tem;
1362 int completedp;
1363 Lisp_Object last;
1364 struct gcpro gcpro1, gcpro2;
1365
1366 completion = Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table,
1367 Vminibuffer_completion_predicate);
1368 last = last_exact_completion;
1369 last_exact_completion = Qnil;
1370
1371 GCPRO2 (completion, last);
1372
1373 if (NILP (completion))
1374 {
1375 bitch_at_user ();
1376 temp_echo_area_glyphs (" [No match]");
1377 UNGCPRO;
1378 return 0;
1379 }
1380
1381 if (EQ (completion, Qt)) /* exact and unique match */
1382 {
1383 UNGCPRO;
1384 return 1;
1385 }
1386
1387 /* compiler bug */
1388 tem = Fstring_equal (completion, Fbuffer_string());
1389 if (completedp = NILP (tem))
1390 {
1391 Ferase_buffer (); /* Some completion happened */
1392 Finsert (1, &completion);
1393 }
1394
1395 /* It did find a match. Do we match some possibility exactly now? */
1396 tem = test_completion (Fbuffer_string ());
1397 if (NILP (tem))
1398 {
1399 /* not an exact match */
1400 UNGCPRO;
1401 if (completedp)
1402 return 5;
1403 else if (auto_help)
1404 Fminibuffer_completion_help ();
1405 else
1406 temp_echo_area_glyphs (" [Next char not unique]");
1407 return 6;
1408 }
1409 else if (completedp)
1410 {
1411 UNGCPRO;
1412 return 4;
1413 }
1414 /* If the last exact completion and this one were the same,
1415 it means we've already given a "Complete but not unique"
1416 message and the user's hit TAB again, so now we give him help. */
1417 last_exact_completion = completion;
1418 if (!NILP (last))
1419 {
1420 tem = Fbuffer_string ();
1421 if (!NILP (Fequal (tem, last)))
1422 Fminibuffer_completion_help ();
1423 }
1424 UNGCPRO;
1425 return 3;
1426 }
1427
1428 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1429
1430 Lisp_Object
1431 assoc_for_completion (key, list)
1432 register Lisp_Object key;
1433 Lisp_Object list;
1434 {
1435 register Lisp_Object tail;
1436
1437 if (completion_ignore_case)
1438 key = Fupcase (key);
1439
1440 for (tail = list; !NILP (tail); tail = Fcdr (tail))
1441 {
1442 register Lisp_Object elt, tem, thiscar;
1443 elt = Fcar (tail);
1444 if (!CONSP (elt)) continue;
1445 thiscar = Fcar (elt);
1446 if (!STRINGP (thiscar))
1447 continue;
1448 if (completion_ignore_case)
1449 thiscar = Fupcase (thiscar);
1450 tem = Fequal (thiscar, key);
1451 if (!NILP (tem)) return elt;
1452 QUIT;
1453 }
1454 return Qnil;
1455 }
1456
1457 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
1458 "Complete the minibuffer contents as far as possible.\n\
1459 Return nil if there is no valid completion, else t.\n\
1460 If no characters can be completed, display a list of possible completions.\n\
1461 If you repeat this command after it displayed such a list,\n\
1462 scroll the window of possible completions.")
1463 ()
1464 {
1465 register int i;
1466 Lisp_Object window, tem;
1467
1468 /* If the previous command was not this, then mark the completion
1469 buffer obsolete. */
1470 if (! EQ (current_kboard->Vlast_command, this_command))
1471 Vminibuf_scroll_window = Qnil;
1472
1473 window = Vminibuf_scroll_window;
1474 /* If there's a fresh completion window with a live buffer,
1475 and this command is repeated, scroll that window. */
1476 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1477 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1478 {
1479 struct buffer *obuf = current_buffer;
1480
1481 Fset_buffer (XWINDOW (window)->buffer);
1482 tem = Fpos_visible_in_window_p (make_number (ZV), window);
1483 if (! NILP (tem))
1484 /* If end is in view, scroll up to the beginning. */
1485 Fset_window_start (window, make_number (BEGV), Qnil);
1486 else
1487 /* Else scroll down one screen. */
1488 Fscroll_other_window (Qnil);
1489
1490 set_buffer_internal (obuf);
1491 return Qnil;
1492 }
1493
1494 i = do_completion ();
1495 switch (i)
1496 {
1497 case 0:
1498 return Qnil;
1499
1500 case 1:
1501 temp_echo_area_glyphs (" [Sole completion]");
1502 break;
1503
1504 case 3:
1505 temp_echo_area_glyphs (" [Complete, but not unique]");
1506 break;
1507 }
1508
1509 return Qt;
1510 }
1511 \f
1512 /* Subroutines of Fminibuffer_complete_and_exit. */
1513
1514 /* This one is called by internal_condition_case to do the real work. */
1515
1516 Lisp_Object
1517 complete_and_exit_1 ()
1518 {
1519 return make_number (do_completion ());
1520 }
1521
1522 /* This one is called by internal_condition_case if an error happens.
1523 Pretend the current value is an exact match. */
1524
1525 Lisp_Object
1526 complete_and_exit_2 (ignore)
1527 Lisp_Object ignore;
1528 {
1529 return make_number (1);
1530 }
1531
1532 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1533 Sminibuffer_complete_and_exit, 0, 0, "",
1534 "If the minibuffer contents is a valid completion then exit.\n\
1535 Otherwise try to complete it. If completion leads to a valid completion,\n\
1536 a repetition of this command will exit.")
1537 ()
1538 {
1539 register int i;
1540 Lisp_Object val;
1541
1542 /* Allow user to specify null string */
1543 if (BEGV == ZV)
1544 goto exit;
1545
1546 if (!NILP (test_completion (Fbuffer_string ())))
1547 goto exit;
1548
1549 /* Call do_completion, but ignore errors. */
1550 val = internal_condition_case (complete_and_exit_1, Qerror,
1551 complete_and_exit_2);
1552
1553 i = XFASTINT (val);
1554 switch (i)
1555 {
1556 case 1:
1557 case 3:
1558 goto exit;
1559
1560 case 4:
1561 if (!NILP (Vminibuffer_completion_confirm))
1562 {
1563 temp_echo_area_glyphs (" [Confirm]");
1564 return Qnil;
1565 }
1566 else
1567 goto exit;
1568
1569 default:
1570 return Qnil;
1571 }
1572 exit:
1573 Fthrow (Qexit, Qnil);
1574 /* NOTREACHED */
1575 }
1576
1577 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1578 0, 0, "",
1579 "Complete the minibuffer contents at most a single word.\n\
1580 After one word is completed as much as possible, a space or hyphen\n\
1581 is added, provided that matches some possible completion.\n\
1582 Return nil if there is no valid completion, else t.")
1583 ()
1584 {
1585 Lisp_Object completion, tem;
1586 register int i, i_byte;
1587 register unsigned char *completion_string;
1588 struct gcpro gcpro1, gcpro2;
1589
1590 /* We keep calling Fbuffer_string rather than arrange for GC to
1591 hold onto a pointer to one of the strings thus made. */
1592
1593 completion = Ftry_completion (Fbuffer_string (),
1594 Vminibuffer_completion_table,
1595 Vminibuffer_completion_predicate);
1596 if (NILP (completion))
1597 {
1598 bitch_at_user ();
1599 temp_echo_area_glyphs (" [No match]");
1600 return Qnil;
1601 }
1602 if (EQ (completion, Qt))
1603 return Qnil;
1604
1605 #if 0 /* How the below code used to look, for reference. */
1606 tem = Fbuffer_string ();
1607 b = XSTRING (tem)->data;
1608 i = ZV - 1 - XSTRING (completion)->size;
1609 p = XSTRING (completion)->data;
1610 if (i > 0 ||
1611 0 <= scmp (b, p, ZV - 1))
1612 {
1613 i = 1;
1614 /* Set buffer to longest match of buffer tail and completion head. */
1615 while (0 <= scmp (b + i, p, ZV - 1 - i))
1616 i++;
1617 del_range (1, i + 1);
1618 SET_PT (ZV);
1619 }
1620 #else /* Rewritten code */
1621 {
1622 register unsigned char *buffer_string;
1623 int buffer_nbytes, completion_nbytes;
1624
1625 CHECK_STRING (completion, 0);
1626 tem = Fbuffer_string ();
1627 GCPRO2 (completion, tem);
1628 /* If reading a file name,
1629 expand any $ENVVAR refs in the buffer and in TEM. */
1630 if (EQ (Vminibuffer_completion_table, Qread_file_name_internal))
1631 {
1632 Lisp_Object substituted;
1633 substituted = Fsubstitute_in_file_name (tem);
1634 if (! EQ (substituted, tem))
1635 {
1636 tem = substituted;
1637 Ferase_buffer ();
1638 insert_from_string (tem, 0, 0, XSTRING (tem)->size,
1639 XSTRING (tem)->size_byte, 0);
1640 }
1641 }
1642 buffer_string = XSTRING (tem)->data;
1643 completion_string = XSTRING (completion)->data;
1644 buffer_nbytes = XSTRING (tem)->size_byte; /* ie ZV_BYTE - BEGV_BYTE */
1645 completion_nbytes = XSTRING (completion)->size_byte;
1646 i_byte = buffer_nbytes - completion_nbytes;
1647 if (i > 0 ||
1648 0 <= scmp (buffer_string, completion_string, buffer_nbytes))
1649 {
1650 /* Set buffer to longest match of buffer tail and completion head. */
1651 if (i_byte <= 0) i_byte = 1;
1652 buffer_string += i_byte;
1653 buffer_nbytes -= i_byte;
1654 while (0 <= scmp (buffer_string++, completion_string, buffer_nbytes--))
1655 i_byte++;
1656 del_range_byte (1, i_byte + 1, 1);
1657 SET_PT_BOTH (ZV, ZV_BYTE);
1658 }
1659 UNGCPRO;
1660 }
1661 #endif /* Rewritten code */
1662 i_byte = ZV_BYTE - BEGV_BYTE;
1663 i = ZV - BEGV;
1664
1665 /* If completion finds next char not unique,
1666 consider adding a space or a hyphen. */
1667 if (i == XSTRING (completion)->size)
1668 {
1669 GCPRO1 (completion);
1670 tem = Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1671 Vminibuffer_completion_table,
1672 Vminibuffer_completion_predicate);
1673 UNGCPRO;
1674
1675 if (STRINGP (tem))
1676 completion = tem;
1677 else
1678 {
1679 GCPRO1 (completion);
1680 tem =
1681 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1682 Vminibuffer_completion_table,
1683 Vminibuffer_completion_predicate);
1684 UNGCPRO;
1685
1686 if (STRINGP (tem))
1687 completion = tem;
1688 }
1689 }
1690
1691 /* Now find first word-break in the stuff found by completion.
1692 i gets index in string of where to stop completing. */
1693 {
1694 int len, c;
1695
1696 completion_string = XSTRING (completion)->data;
1697 for (; i_byte < XSTRING (completion)->size_byte; i_byte += len, i++)
1698 {
1699 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
1700 XSTRING (completion)->size - i_byte,
1701 len);
1702 if (SYNTAX (c) != Sword)
1703 {
1704 i_byte += len;
1705 i++;
1706 break;
1707 }
1708 }
1709 }
1710
1711 /* If got no characters, print help for user. */
1712
1713 if (i_byte == ZV_BYTE - BEGV_BYTE)
1714 {
1715 if (auto_help)
1716 Fminibuffer_completion_help ();
1717 return Qnil;
1718 }
1719
1720 /* Otherwise insert in minibuffer the chars we got */
1721
1722 Ferase_buffer ();
1723 insert_from_string (completion, 0, 0, i, i_byte, 1);
1724 return Qt;
1725 }
1726 \f
1727 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
1728 1, 1, 0,
1729 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1730 Each element may be just a symbol or string\n\
1731 or may be a list of two strings to be printed as if concatenated.\n\
1732 `standard-output' must be a buffer.\n\
1733 At the end, run the normal hook `completion-setup-hook'.\n\
1734 It can find the completion buffer in `standard-output'.")
1735 (completions)
1736 Lisp_Object completions;
1737 {
1738 Lisp_Object tail, elt;
1739 register int i;
1740 int column = 0;
1741 struct gcpro gcpro1, gcpro2;
1742 struct buffer *old = current_buffer;
1743 int first = 1;
1744
1745 /* Note that (when it matters) every variable
1746 points to a non-string that is pointed to by COMPLETIONS,
1747 except for ELT. ELT can be pointing to a string
1748 when terpri or Findent_to calls a change hook. */
1749 elt = Qnil;
1750 GCPRO2 (completions, elt);
1751
1752 if (BUFFERP (Vstandard_output))
1753 set_buffer_internal (XBUFFER (Vstandard_output));
1754
1755 if (NILP (completions))
1756 write_string ("There are no possible completions of what you have typed.",
1757 -1);
1758 else
1759 {
1760 write_string ("Possible completions are:", -1);
1761 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
1762 {
1763 Lisp_Object tem;
1764 int length;
1765 Lisp_Object startpos, endpos;
1766
1767 elt = Fcar (tail);
1768 /* Compute the length of this element. */
1769 if (CONSP (elt))
1770 {
1771 tem = XCAR (elt);
1772 CHECK_STRING (tem, 0);
1773 length = XSTRING (tem)->size;
1774
1775 tem = Fcar (XCDR (elt));
1776 CHECK_STRING (tem, 0);
1777 length += XSTRING (tem)->size;
1778 }
1779 else
1780 {
1781 CHECK_STRING (elt, 0);
1782 length = XSTRING (elt)->size;
1783 }
1784
1785 /* This does a bad job for narrower than usual windows.
1786 Sadly, the window it will appear in is not known
1787 until after the text has been made. */
1788
1789 if (BUFFERP (Vstandard_output))
1790 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
1791
1792 /* If the previous completion was very wide,
1793 or we have two on this line already,
1794 don't put another on the same line. */
1795 if (column > 33 || first
1796 /* If this is really wide, don't put it second on a line. */
1797 || column > 0 && length > 45)
1798 {
1799 Fterpri (Qnil);
1800 column = 0;
1801 }
1802 /* Otherwise advance to column 35. */
1803 else
1804 {
1805 if (BUFFERP (Vstandard_output))
1806 {
1807 tem = Findent_to (make_number (35), make_number (2));
1808
1809 column = XINT (tem);
1810 }
1811 else
1812 {
1813 do
1814 {
1815 write_string (" ", -1);
1816 column++;
1817 }
1818 while (column < 35);
1819 }
1820 }
1821
1822 if (BUFFERP (Vstandard_output))
1823 {
1824 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
1825 Fset_text_properties (startpos, endpos,
1826 Qnil, Vstandard_output);
1827 }
1828
1829 /* Output this element and update COLUMN. */
1830 if (CONSP (elt))
1831 {
1832 Fprinc (Fcar (elt), Qnil);
1833 Fprinc (Fcar (Fcdr (elt)), Qnil);
1834 }
1835 else
1836 Fprinc (elt, Qnil);
1837
1838 column += length;
1839
1840 /* If output is to a buffer, recompute COLUMN in a way
1841 that takes account of character widths. */
1842 if (BUFFERP (Vstandard_output))
1843 {
1844 tem = Fcurrent_column ();
1845 column = XINT (tem);
1846 }
1847
1848 first = 0;
1849 }
1850 }
1851
1852 UNGCPRO;
1853
1854 if (BUFFERP (Vstandard_output))
1855 set_buffer_internal (old);
1856
1857 if (!NILP (Vrun_hooks))
1858 call1 (Vrun_hooks, intern ("completion-setup-hook"));
1859
1860 return Qnil;
1861 }
1862
1863 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
1864 0, 0, "",
1865 "Display a list of possible completions of the current minibuffer contents.")
1866 ()
1867 {
1868 Lisp_Object completions;
1869
1870 message ("Making completion list...");
1871 completions = Fall_completions (Fbuffer_string (),
1872 Vminibuffer_completion_table,
1873 Vminibuffer_completion_predicate,
1874 Qt);
1875 echo_area_glyphs = 0;
1876
1877 if (NILP (completions))
1878 {
1879 bitch_at_user ();
1880 temp_echo_area_glyphs (" [No completions]");
1881 }
1882 else
1883 internal_with_output_to_temp_buffer ("*Completions*",
1884 Fdisplay_completion_list,
1885 Fsort (completions, Qstring_lessp));
1886 return Qnil;
1887 }
1888 \f
1889 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
1890 "Terminate minibuffer input.")
1891 ()
1892 {
1893 if (INTEGERP (last_command_char))
1894 internal_self_insert (last_command_char, 0);
1895 else
1896 bitch_at_user ();
1897
1898 Fthrow (Qexit, Qnil);
1899 }
1900
1901 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
1902 "Terminate this minibuffer argument.")
1903 ()
1904 {
1905 Fthrow (Qexit, Qnil);
1906 }
1907
1908 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1909 "Return current depth of activations of minibuffer, a nonnegative integer.")
1910 ()
1911 {
1912 return make_number (minibuf_level);
1913 }
1914
1915 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1916 "Return the prompt string of the currently-active minibuffer.\n\
1917 If no minibuffer is active, return nil.")
1918 ()
1919 {
1920 return Fcopy_sequence (minibuf_prompt);
1921 }
1922
1923 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width,
1924 Sminibuffer_prompt_width, 0, 0, 0,
1925 "Return the display width of the minibuffer prompt.")
1926 ()
1927 {
1928 Lisp_Object width;
1929 XSETFASTINT (width, minibuf_prompt_width);
1930 return width;
1931 }
1932 \f
1933 /* Temporarily display the string M at the end of the current
1934 minibuffer contents. This is used to display things like
1935 "[No Match]" when the user requests a completion for a prefix
1936 that has no possible completions, and other quick, unobtrusive
1937 messages. */
1938
1939 void
1940 temp_echo_area_glyphs (m)
1941 char *m;
1942 {
1943 int osize = ZV;
1944 int osize_byte = ZV_BYTE;
1945 int opoint = PT;
1946 int opoint_byte = PT_BYTE;
1947 Lisp_Object oinhibit;
1948 oinhibit = Vinhibit_quit;
1949
1950 /* Clear out any old echo-area message to make way for our new thing. */
1951 message (0);
1952
1953 SET_PT_BOTH (osize, osize_byte);
1954 insert_string (m);
1955 SET_PT_BOTH (opoint, opoint_byte);
1956 Vinhibit_quit = Qt;
1957 Fsit_for (make_number (2), Qnil, Qnil);
1958 del_range_both (osize, ZV, osize_byte, ZV_BYTE, 1);
1959 SET_PT_BOTH (opoint, opoint_byte);
1960 if (!NILP (Vquit_flag))
1961 {
1962 Vquit_flag = Qnil;
1963 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
1964 }
1965 Vinhibit_quit = oinhibit;
1966 }
1967
1968 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
1969 1, 1, 0,
1970 "Temporarily display STRING at the end of the minibuffer.\n\
1971 The text is displayed for two seconds,\n\
1972 or until the next input event arrives, whichever comes first.")
1973 (string)
1974 Lisp_Object string;
1975 {
1976 temp_echo_area_glyphs (XSTRING (string)->data);
1977 return Qnil;
1978 }
1979 \f
1980 void
1981 init_minibuf_once ()
1982 {
1983 Vminibuffer_list = Qnil;
1984 staticpro (&Vminibuffer_list);
1985 }
1986
1987 void
1988 syms_of_minibuf ()
1989 {
1990 minibuf_level = 0;
1991 minibuf_prompt = Qnil;
1992 staticpro (&minibuf_prompt);
1993
1994 minibuf_save_list = Qnil;
1995 staticpro (&minibuf_save_list);
1996
1997 Qread_file_name_internal = intern ("read-file-name-internal");
1998 staticpro (&Qread_file_name_internal);
1999
2000 Qminibuffer_default = intern ("minibuffer-default");
2001 staticpro (&Qminibuffer_default);
2002 Fset (Qminibuffer_default, Qnil);
2003
2004 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2005 staticpro (&Qminibuffer_completion_table);
2006
2007 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2008 staticpro (&Qminibuffer_completion_confirm);
2009
2010 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2011 staticpro (&Qminibuffer_completion_predicate);
2012
2013 staticpro (&last_exact_completion);
2014 last_exact_completion = Qnil;
2015
2016 staticpro (&last_minibuf_string);
2017 last_minibuf_string = Qnil;
2018
2019 Quser_variable_p = intern ("user-variable-p");
2020 staticpro (&Quser_variable_p);
2021
2022 Qminibuffer_history = intern ("minibuffer-history");
2023 staticpro (&Qminibuffer_history);
2024
2025 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2026 staticpro (&Qminibuffer_setup_hook);
2027
2028 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2029 staticpro (&Qminibuffer_exit_hook);
2030
2031 Qhistory_length = intern ("history-length");
2032 staticpro (&Qhistory_length);
2033
2034 Qcurrent_input_method = intern ("current-input-method");
2035 staticpro (&Qcurrent_input_method);
2036
2037 Qactivate_input_method = intern ("activate-input-method");
2038 staticpro (&Qactivate_input_method);
2039
2040 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2041 "If this is non-nil, `read-buffer' does its work by calling this function.");
2042 Vread_buffer_function = Qnil;
2043
2044 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2045 "Normal hook run just after entry to minibuffer.");
2046 Vminibuffer_setup_hook = Qnil;
2047
2048 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2049 "Normal hook run just after exit from minibuffer.");
2050 Vminibuffer_exit_hook = Qnil;
2051
2052 DEFVAR_LISP ("history-length", &Vhistory_length,
2053 "*Maximum length for history lists before truncation takes place.\n\
2054 A number means that length; t means infinite. Truncation takes place\n\
2055 just after a new element is inserted. Setting the history-length\n\
2056 property of a history variable overrides this default.");
2057 XSETFASTINT (Vhistory_length, 30);
2058
2059 DEFVAR_BOOL ("completion-auto-help", &auto_help,
2060 "*Non-nil means automatically provide help for invalid completion input.");
2061 auto_help = 1;
2062
2063 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2064 "Non-nil means don't consider case significant in completion.");
2065 completion_ignore_case = 0;
2066
2067 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2068 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2069 This variable makes a difference whenever the minibuffer window is active.");
2070 enable_recursive_minibuffers = 0;
2071
2072 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2073 "Alist or obarray used for completion in the minibuffer.\n\
2074 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2075 \n\
2076 The value may alternatively be a function, which is given three arguments:\n\
2077 STRING, the current buffer contents;\n\
2078 PREDICATE, the predicate for filtering possible matches;\n\
2079 CODE, which says what kind of things to do.\n\
2080 CODE can be nil, t or `lambda'.\n\
2081 nil means to return the best completion of STRING, or nil if there is none.\n\
2082 t means to return a list of all possible completions of STRING.\n\
2083 `lambda' means to return t if STRING is a valid completion as it stands.");
2084 Vminibuffer_completion_table = Qnil;
2085
2086 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2087 "Within call to `completing-read', this holds the PREDICATE argument.");
2088 Vminibuffer_completion_predicate = Qnil;
2089
2090 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2091 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2092 Vminibuffer_completion_confirm = Qnil;
2093
2094 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2095 "Value that `help-form' takes on inside the minibuffer.");
2096 Vminibuffer_help_form = Qnil;
2097
2098 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2099 "History list symbol to add minibuffer values to.\n\
2100 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2101 is added with\n\
2102 (set minibuffer-history-variable\n\
2103 (cons STRING (symbol-value minibuffer-history-variable)))");
2104 XSETFASTINT (Vminibuffer_history_variable, 0);
2105
2106 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2107 "Current position of redoing in the history list.");
2108 Vminibuffer_history_position = Qnil;
2109
2110 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2111 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2112 Some uses of the echo area also raise that frame (since they use it too).");
2113 minibuffer_auto_raise = 0;
2114
2115 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2116 "List of regexps that should restrict possible completions.");
2117 Vcompletion_regexp_list = Qnil;
2118
2119 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2120 &minibuffer_allow_text_properties,
2121 "Non-nil means `read-from-miniffer' should not discard text properties.\n\
2122 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2123 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2124 with completion; they always discard text properties.");
2125 minibuffer_allow_text_properties = 0;
2126
2127 defsubr (&Sset_minibuffer_window);
2128 defsubr (&Sread_from_minibuffer);
2129 defsubr (&Seval_minibuffer);
2130 defsubr (&Sread_minibuffer);
2131 defsubr (&Sread_string);
2132 defsubr (&Sread_command);
2133 defsubr (&Sread_variable);
2134 defsubr (&Sread_buffer);
2135 defsubr (&Sread_no_blanks_input);
2136 defsubr (&Sminibuffer_depth);
2137 defsubr (&Sminibuffer_prompt);
2138 defsubr (&Sminibuffer_prompt_width);
2139
2140 defsubr (&Stry_completion);
2141 defsubr (&Sall_completions);
2142 defsubr (&Scompleting_read);
2143 defsubr (&Sminibuffer_complete);
2144 defsubr (&Sminibuffer_complete_word);
2145 defsubr (&Sminibuffer_complete_and_exit);
2146 defsubr (&Sdisplay_completion_list);
2147 defsubr (&Sminibuffer_completion_help);
2148
2149 defsubr (&Sself_insert_and_exit);
2150 defsubr (&Sexit_minibuffer);
2151
2152 defsubr (&Sminibuffer_message);
2153 }
2154
2155 void
2156 keys_of_minibuf ()
2157 {
2158 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2159 "abort-recursive-edit");
2160 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2161 "exit-minibuffer");
2162 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2163 "exit-minibuffer");
2164
2165 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
2166 "abort-recursive-edit");
2167 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
2168 "exit-minibuffer");
2169 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
2170 "exit-minibuffer");
2171
2172 initial_define_key (Vminibuffer_local_ns_map, ' ',
2173 "exit-minibuffer");
2174 initial_define_key (Vminibuffer_local_ns_map, '\t',
2175 "exit-minibuffer");
2176 initial_define_key (Vminibuffer_local_ns_map, '?',
2177 "self-insert-and-exit");
2178
2179 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
2180 "abort-recursive-edit");
2181 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
2182 "exit-minibuffer");
2183 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
2184 "exit-minibuffer");
2185
2186 initial_define_key (Vminibuffer_local_completion_map, '\t',
2187 "minibuffer-complete");
2188 initial_define_key (Vminibuffer_local_completion_map, ' ',
2189 "minibuffer-complete-word");
2190 initial_define_key (Vminibuffer_local_completion_map, '?',
2191 "minibuffer-completion-help");
2192
2193 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
2194 "abort-recursive-edit");
2195 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2196 "minibuffer-complete-and-exit");
2197 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2198 "minibuffer-complete-and-exit");
2199 initial_define_key (Vminibuffer_local_must_match_map, '\t',
2200 "minibuffer-complete");
2201 initial_define_key (Vminibuffer_local_must_match_map, ' ',
2202 "minibuffer-complete-word");
2203 initial_define_key (Vminibuffer_local_must_match_map, '?',
2204 "minibuffer-completion-help");
2205 }