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