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