(add-log-current-defun): In texinfo-mode,
[bpt/emacs.git] / src / minibuf.c
CommitLineData
f927c5ae 1/* Minibuffer input and completion.
3a22ee35 2 Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
f927c5ae
JB
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
ffd56f97 8the Free Software Foundation; either version 2, or (at your option)
f927c5ae
JB
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
18the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20
18160b98 21#include <config.h>
f927c5ae
JB
22#include "lisp.h"
23#include "commands.h"
24#include "buffer.h"
25#include "dispextern.h"
ff11dfa1 26#include "frame.h"
f927c5ae
JB
27#include "window.h"
28#include "syntax.h"
29
30#define min(a, b) ((a) < (b) ? (a) : (b))
31
a4e71d81
KH
32extern int quit_char;
33
f927c5ae 34/* List of buffers for use as minibuffers.
4d04c1f1
KH
35 The first element of the list is used for the outermost minibuffer
36 invocation, the next element is used for a recursive minibuffer
37 invocation, etc. The list is extended at the end as deeper
38 minibuffer recursions are encountered. */
f927c5ae
JB
39Lisp_Object Vminibuffer_list;
40
4d04c1f1
KH
41/* Data to remember during recursive minibuffer invocations */
42Lisp_Object minibuf_save_list;
f927c5ae
JB
43
44/* Depth in minibuffer invocations. */
45int minibuf_level;
46
47/* Nonzero means display completion help for invalid input */
48int auto_help;
49
b278606c 50/* Fread_minibuffer leaves the input here as a string. */
f927c5ae
JB
51Lisp_Object last_minibuf_string;
52
53/* Nonzero means let functions called when within a minibuffer
54 invoke recursive minibuffers (to read arguments, or whatever) */
55int enable_recursive_minibuffers;
56
57/* help-form is bound to this while in the minibuffer. */
58
59Lisp_Object Vminibuffer_help_form;
60
770970cb
RS
61/* Variable which is the history list to add minibuffer values to. */
62
63Lisp_Object Vminibuffer_history_variable;
64
65/* Current position in the history list (adjusted by M-n and M-p). */
66
67Lisp_Object Vminibuffer_history_position;
68
69Lisp_Object Qminibuffer_history;
70
719b4a40
RS
71Lisp_Object Qread_file_name_internal;
72
177aecf9 73/* Normal hooks for entry to and exit from minibuffer. */
5c781212
RS
74
75Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
177aecf9 76Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
5c781212 77
f927c5ae
JB
78/* Nonzero means completion ignores case. */
79
80int completion_ignore_case;
81
42006772
RS
82/* List of regexps that should restrict possible completions. */
83
84Lisp_Object Vcompletion_regexp_list;
85
6a9ee000
RS
86/* Nonzero means raise the minibuffer frame when the minibuffer
87 is entered. */
88
89int minibuffer_auto_raise;
90
f927c5ae
JB
91/* If last completion attempt reported "Complete but not unique"
92 then this is the string completed then; otherwise this is nil. */
93
94static Lisp_Object last_exact_completion;
95
96Lisp_Object Quser_variable_p;
2cb6da5c
RS
97
98/* Non-nil means it is the window for C-M-v to scroll
99 when the minibuffer is selected. */
100extern Lisp_Object Vminibuf_scroll_window;
f927c5ae
JB
101\f
102/* Actual minibuffer invocation. */
103
104void read_minibuf_unwind ();
105Lisp_Object get_minibuffer ();
106Lisp_Object read_minibuf ();
107
770970cb 108/* Read from the minibuffer using keymap MAP, initial contents INITIAL
85b5fe07 109 (a string), putting point minus BACKUP_N chars from the end of INITIAL,
770970cb 110 prompting with PROMPT (a string), using history list HISTVAR
85b5fe07 111 with initial position HISTPOS. (BACKUP_N should be <= 0.)
770970cb
RS
112
113 Normally return the result as a string (the text that was read),
b278606c
BF
114 but if EXPFLAG is non-nil, read it and return the object read.
115 If HISTVAR is given, save the value read on that history only if it doesn't
116 match the front of that history list exactly. The value is pushed onto
117 the list as the string that was read, or as the object that resulted iff
118 EXPFLAG is non-nil. */
770970cb 119
f927c5ae 120Lisp_Object
770970cb 121read_minibuf (map, initial, prompt, backup_n, expflag, histvar, histpos)
f927c5ae
JB
122 Lisp_Object map;
123 Lisp_Object initial;
124 Lisp_Object prompt;
5061d9c3 125 Lisp_Object backup_n;
f927c5ae 126 int expflag;
770970cb
RS
127 Lisp_Object histvar;
128 Lisp_Object histpos;
f927c5ae
JB
129{
130 register Lisp_Object val;
131 int count = specpdl_ptr - specpdl;
5061d9c3 132 Lisp_Object mini_frame;
f927c5ae 133
7510b296 134 if (!STRINGP (prompt))
f927c5ae
JB
135 prompt = build_string ("");
136
137 /* Emacs in -batch mode calls minibuffer: print the prompt. */
7510b296 138 if (noninteractive && STRINGP (prompt))
f927c5ae
JB
139 printf ("%s", XSTRING (prompt)->data);
140
141 if (!enable_recursive_minibuffers
142 && minibuf_level > 0
143 && (EQ (selected_window, minibuf_window)))
144#if 0
ff11dfa1 145 || selected_frame != XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window)))
f927c5ae
JB
146#endif
147 error ("Command attempted to use minibuffer while in minibuffer");
148
4d04c1f1
KH
149 /* Could we simply bind these variables instead? */
150 minibuf_save_list
151 = Fcons (minibuf_prompt,
152 Fcons (make_number (minibuf_prompt_width),
153 Fcons (Vhelp_form,
154 Fcons (Vcurrent_prefix_arg,
155 Fcons (Vminibuffer_history_position,
156 Fcons (Vminibuffer_history_variable,
157 minibuf_save_list))))));
f927c5ae 158 minibuf_prompt_width = 0;
f927c5ae
JB
159
160 record_unwind_protect (Fset_window_configuration,
b2b2c677
JB
161 Fcurrent_window_configuration (Qnil));
162
ff11dfa1
JB
163 /* If the minibuffer window is on a different frame, save that
164 frame's configuration too. */
5061d9c3 165#ifdef MULTI_FRAME
75f00e72 166 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
ff11dfa1 167 if (XFRAME (mini_frame) != selected_frame)
5061d9c3
RS
168 record_unwind_protect (Fset_window_configuration,
169 Fcurrent_window_configuration (mini_frame));
5563e8e8
KH
170
171 /* If the minibuffer is on an iconified or invisible frame,
172 make it visible now. */
173 Fmake_frame_visible (mini_frame);
174
6a9ee000
RS
175 if (minibuffer_auto_raise)
176 Fraise_frame (mini_frame);
5061d9c3 177#endif
f927c5ae
JB
178
179 val = current_buffer->directory;
180 Fset_buffer (get_minibuffer (minibuf_level));
64a3a3c0
JB
181
182 /* The current buffer's default directory is usually the right thing
183 for our minibuffer here. However, if you're typing a command at
184 a minibuffer-only frame when minibuf_level is zero, then buf IS
185 the current_buffer, so reset_buffer leaves buf's default
186 directory unchanged. This is a bummer when you've just started
187 up Emacs and buf's default directory is Qnil. Here's a hack; can
188 you think of something better to do? Find another buffer with a
189 better directory, and use that one instead. */
7510b296 190 if (STRINGP (val))
64a3a3c0
JB
191 current_buffer->directory = val;
192 else
193 {
194 Lisp_Object buf_list;
195
196 for (buf_list = Vbuffer_alist;
197 CONSP (buf_list);
198 buf_list = XCONS (buf_list)->cdr)
199 {
1e62748e 200 Lisp_Object other_buf;
64a3a3c0 201
1e62748e 202 other_buf = XCONS (XCONS (buf_list)->car)->cdr;
7510b296 203 if (STRINGP (XBUFFER (other_buf)->directory))
64a3a3c0
JB
204 {
205 current_buffer->directory = XBUFFER (other_buf)->directory;
206 break;
207 }
208 }
209 }
210
33b1baf6 211#ifdef MULTI_FRAME
0abbff13
KH
212 if (XFRAME (mini_frame) != selected_frame)
213 Fredirect_frame_focus (Fselected_frame (), mini_frame);
33b1baf6 214#endif
f927c5ae
JB
215 Fmake_local_variable (Qprint_escape_newlines);
216 print_escape_newlines = 1;
217
43bad991 218 record_unwind_protect (read_minibuf_unwind, Qnil);
43bad991 219
f927c5ae
JB
220 Vminibuf_scroll_window = selected_window;
221 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
f927c5ae 222 Fselect_window (minibuf_window);
5a866662 223 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
f927c5ae
JB
224
225 Ferase_buffer ();
226 minibuf_level++;
f927c5ae 227
56a98455 228 if (!NILP (initial))
f927c5ae
JB
229 {
230 Finsert (1, &initial);
7510b296 231 if (!NILP (backup_n) && INTEGERP (backup_n))
f927c5ae
JB
232 Fforward_char (backup_n);
233 }
234
4d04c1f1 235 minibuf_prompt = Fcopy_sequence (prompt);
f927c5ae 236 echo_area_glyphs = 0;
73168c8b
RS
237 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
238 previous_echo_glyphs = 0;
f927c5ae
JB
239
240 Vhelp_form = Vminibuffer_help_form;
241 current_buffer->keymap = map;
770970cb
RS
242 Vminibuffer_history_position = histpos;
243 Vminibuffer_history_variable = histvar;
f927c5ae 244
5c781212
RS
245 /* Run our hook, but not if it is empty.
246 (run-hooks would do nothing if it is empty,
247 but it's important to save time here in the usual case. */
92d3b06e
RS
248 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
249 && !NILP (Vrun_hooks))
5c781212
RS
250 call1 (Vrun_hooks, Qminibuffer_setup_hook);
251
f927c5ae
JB
252/* ??? MCC did redraw_screen here if switching screens. */
253 recursive_edit_1 ();
254
255 /* If cursor is on the minibuffer line,
256 show the user we have exited by putting it in column 0. */
ff11dfa1 257 if ((FRAME_CURSOR_Y (selected_frame)
f927c5ae
JB
258 >= XFASTINT (XWINDOW (minibuf_window)->top))
259 && !noninteractive)
260 {
ff11dfa1
JB
261 FRAME_CURSOR_X (selected_frame) = 0;
262 update_frame (selected_frame, 1, 1);
f927c5ae
JB
263 }
264
265 /* Make minibuffer contents into a string */
ffd56f97 266 val = make_buffer_string (1, Z);
f927c5ae 267 bcopy (GAP_END_ADDR, XSTRING (val)->data + GPT - BEG, Z - GPT);
770970cb 268
b278606c
BF
269 /* VAL is the string of minibuffer text. */
270 last_minibuf_string = val;
271
7c70cfd3
KH
272 /* Add the value to the appropriate history list unless it is empty. */
273 if (XSTRING (val)->size != 0
7510b296 274 && SYMBOLP (Vminibuffer_history_variable)
b278606c
BF
275 && ! EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
276 {
277 /* If the caller wanted to save the value read on a history list,
60b73b25
RS
278 then do so if the value is not already the front of the list. */
279 Lisp_Object histval;
280 histval = Fsymbol_value (Vminibuffer_history_variable);
b278606c
BF
281
282 /* The value of the history variable must be a cons or nil. Other
60b73b25 283 values are unacceptable. We silently ignore these values. */
b278606c 284 if (NILP (histval)
60b73b25
RS
285 || (CONSP (histval)
286 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
287 Fset (Vminibuffer_history_variable,
288 Fcons (last_minibuf_string, histval));
b278606c 289 }
770970cb 290
60b73b25
RS
291 /* If Lisp form desired instead of string, parse it. */
292 if (expflag)
8acd16de
KH
293 {
294 Lisp_Object expr_and_pos;
295 unsigned char *p;
296
297 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
298 /* Ignore trailing whitespace; any other trailing junk is an error. */
299 for (p = XSTRING (val)->data + XINT (Fcdr (expr_and_pos)); *p; p++)
300 if (*p != ' ' && *p != '\t' && *p != '\n')
301 error ("Trailing garbage following expression");
302 val = Fcar (expr_and_pos);
303 }
60b73b25 304
2cb6da5c
RS
305 return unbind_to (count, val); /* The appropriate frame will get selected
306 in set-window-configuration. */
f927c5ae
JB
307}
308
309/* Return a buffer to be used as the minibuffer at depth `depth'.
310 depth = 0 is the lowest allowed argument, and that is the value
311 used for nonrecursive minibuffer invocations */
312
313Lisp_Object
314get_minibuffer (depth)
315 int depth;
316{
317 Lisp_Object tail, num, buf;
9f6c23bc 318 char name[24];
f927c5ae
JB
319 extern Lisp_Object nconc2 ();
320
5a866662 321 XSETFASTINT (num, depth);
f927c5ae 322 tail = Fnthcdr (num, Vminibuffer_list);
56a98455 323 if (NILP (tail))
f927c5ae
JB
324 {
325 tail = Fcons (Qnil, Qnil);
326 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
327 }
328 buf = Fcar (tail);
56a98455 329 if (NILP (buf) || NILP (XBUFFER (buf)->name))
f927c5ae
JB
330 {
331 sprintf (name, " *Minibuf-%d*", depth);
332 buf = Fget_buffer_create (build_string (name));
5d6533f1
JB
333
334 /* Although the buffer's name starts with a space, undo should be
335 enabled in it. */
336 Fbuffer_enable_undo (buf);
337
f927c5ae
JB
338 XCONS (tail)->car = buf;
339 }
340 else
5956f71d 341 {
6b3faad8
RS
342 int count = specpdl_ptr - specpdl;
343
5956f71d 344 reset_buffer (XBUFFER (buf));
6b3faad8
RS
345 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
346 Fset_buffer (buf);
347 Fkill_all_local_variables ();
348 unbind_to (count, Qnil);
5956f71d 349 }
64a3a3c0 350
f927c5ae
JB
351 return buf;
352}
353
354/* This function is called on exiting minibuffer, whether normally or not,
355 and it restores the current window, buffer, etc. */
356
357void
43bad991
JB
358read_minibuf_unwind (data)
359 Lisp_Object data;
f927c5ae 360{
c24e1160
RS
361 Lisp_Object old_deactivate_mark;
362
0a1dd1c5
RS
363 /* We are exiting the minibuffer one way or the other,
364 so run the hook. */
365 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
366 && !NILP (Vrun_hooks))
367 call1 (Vrun_hooks, Qminibuffer_exit_hook);
368
f927c5ae
JB
369 /* Erase the minibuffer we were using at this level. */
370 Fset_buffer (XWINDOW (minibuf_window)->buffer);
371
372 /* Prevent error in erase-buffer. */
373 current_buffer->read_only = Qnil;
c24e1160
RS
374
375 old_deactivate_mark = Vdeactivate_mark;
f927c5ae 376 Ferase_buffer ();
c24e1160 377 Vdeactivate_mark = old_deactivate_mark;
f927c5ae
JB
378
379 /* If this was a recursive minibuffer,
380 tie the minibuffer window back to the outer level minibuffer buffer */
381 minibuf_level--;
382 /* Make sure minibuffer window is erased, not ignored */
383 windows_or_buffers_changed++;
5a866662 384 XSETFASTINT (XWINDOW (minibuf_window)->last_modified, 0);
f927c5ae 385
4d04c1f1
KH
386 /* Restore prompt, etc from outer minibuffer */
387 minibuf_prompt = Fcar (minibuf_save_list);
388 minibuf_save_list = Fcdr (minibuf_save_list);
389 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
390 minibuf_save_list = Fcdr (minibuf_save_list);
391 Vhelp_form = Fcar (minibuf_save_list);
392 minibuf_save_list = Fcdr (minibuf_save_list);
393 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
394 minibuf_save_list = Fcdr (minibuf_save_list);
395 Vminibuffer_history_position = Fcar (minibuf_save_list);
396 minibuf_save_list = Fcdr (minibuf_save_list);
397 Vminibuffer_history_variable = Fcar (minibuf_save_list);
398 minibuf_save_list = Fcdr (minibuf_save_list);
f927c5ae
JB
399}
400\f
b9d721de
JB
401
402/* This comment supplies the doc string for read-from-minibuffer,
403 for make-docfile to see. We cannot put this in the real DEFUN
404 due to limits in the Unix cpp.
405
f927c5ae
JB
406DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
407 "Read a string from the minibuffer, prompting with string PROMPT.\n\
408If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
409 to be inserted into the minibuffer before reading input.\n\
770970cb
RS
410 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
411 is STRING, but point is placed POSITION characters into the string.\n\
f927c5ae
JB
412Third arg KEYMAP is a keymap to use whilst reading;\n\
413 if omitted or nil, the default is `minibuffer-local-map'.\n\
414If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
415 and return that object:\n\
416 in other words, do `(car (read-from-string INPUT-STRING))'\n\
770970cb
RS
417Fifth arg HIST, if non-nil, specifies a history list\n\
418 and optionally the initial position in the list.\n\
419 It can be a symbol, which is the history list variable to use,\n\
420 or it can be a cons cell (HISTVAR . HISTPOS).\n\
421 In that case, HISTVAR is the history list variable to use,\n\
422 and HISTPOS is the initial position (the position in the list\n\
423 which INITIAL-CONTENTS corresponds to).\n\
b9d721de
JB
424 Positions are counted starting from 1 at the beginning of the list."
425*/
426
427DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
428 0 /* See immediately above */)
68e5a8a2
RS
429 (prompt, initial_contents, keymap, read, hist)
430 Lisp_Object prompt, initial_contents, keymap, read, hist;
f927c5ae
JB
431{
432 int pos = 0;
770970cb
RS
433 Lisp_Object histvar, histpos, position;
434 position = Qnil;
f927c5ae
JB
435
436 CHECK_STRING (prompt, 0);
68e5a8a2 437 if (!NILP (initial_contents))
f927c5ae 438 {
7510b296 439 if (CONSP (initial_contents))
770970cb 440 {
68e5a8a2
RS
441 position = Fcdr (initial_contents);
442 initial_contents = Fcar (initial_contents);
770970cb 443 }
68e5a8a2 444 CHECK_STRING (initial_contents, 1);
56a98455 445 if (!NILP (position))
f927c5ae
JB
446 {
447 CHECK_NUMBER (position, 0);
448 /* Convert to distance from end of input. */
68e5a8a2 449 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
f927c5ae
JB
450 }
451 }
452
56a98455 453 if (NILP (keymap))
f927c5ae
JB
454 keymap = Vminibuffer_local_map;
455 else
456 keymap = get_keymap (keymap,2);
770970cb 457
7510b296 458 if (SYMBOLP (hist))
770970cb
RS
459 {
460 histvar = hist;
461 histpos = Qnil;
462 }
463 else
464 {
465 histvar = Fcar_safe (hist);
466 histpos = Fcdr_safe (hist);
467 }
468 if (NILP (histvar))
469 histvar = Qminibuffer_history;
470 if (NILP (histpos))
5a866662 471 XSETFASTINT (histpos, 0);
770970cb 472
68e5a8a2 473 return read_minibuf (keymap, initial_contents, prompt,
85b5fe07 474 make_number (pos), !NILP (read), histvar, histpos);
f927c5ae
JB
475}
476
477DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
478 "Return a Lisp object read using the minibuffer.\n\
479Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
480is a string to insert in the minibuffer before reading.")
481 (prompt, initial_contents)
482 Lisp_Object prompt, initial_contents;
483{
484 CHECK_STRING (prompt, 0);
56a98455 485 if (!NILP (initial_contents))
a1b4b084 486 CHECK_STRING (initial_contents, 1);
770970cb
RS
487 return read_minibuf (Vminibuffer_local_map, initial_contents,
488 prompt, Qnil, 1, Qminibuffer_history, make_number (0));
f927c5ae
JB
489}
490
491DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
492 "Return value of Lisp expression read using the minibuffer.\n\
493Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
494is a string to insert in the minibuffer before reading.")
495 (prompt, initial_contents)
496 Lisp_Object prompt, initial_contents;
497{
498 return Feval (Fread_minibuffer (prompt, initial_contents));
499}
500
501/* Functions that use the minibuffer to read various things. */
502
503DEFUN ("read-string", Fread_string, Sread_string, 1, 2, 0,
504 "Read a string from the minibuffer, prompting with string PROMPT.\n\
505If non-nil second arg INITIAL-INPUT is a string to insert before reading.")
506 (prompt, initial_input)
507 Lisp_Object prompt, initial_input;
508{
509 return Fread_from_minibuffer (prompt, initial_input, Qnil, Qnil, Qnil);
510}
511
b278606c 512DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 2, 0,
f927c5ae
JB
513 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
514Prompt with PROMPT, and provide INIT as an initial value of the input string.")
515 (prompt, init)
516 Lisp_Object prompt, init;
517{
518 CHECK_STRING (prompt, 0);
56a98455 519 if (! NILP (init))
f927c5ae
JB
520 CHECK_STRING (init, 1);
521
770970cb
RS
522 return read_minibuf (Vminibuffer_local_ns_map, init, prompt, Qnil, 0,
523 Qminibuffer_history, make_number (0));
f927c5ae
JB
524}
525
526DEFUN ("read-command", Fread_command, Sread_command, 1, 1, 0,
527 "One arg PROMPT, a string. Read the name of a command and return as a symbol.\n\
528Prompts with PROMPT.")
529 (prompt)
530 Lisp_Object prompt;
531{
532 return Fintern (Fcompleting_read (prompt, Vobarray, Qcommandp, Qt, Qnil, Qnil),
533 Qnil);
534}
535
536#ifdef NOTDEF
537DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
538 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
539Prompts with PROMPT.")
540 (prompt)
541 Lisp_Object prompt;
542{
543 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil),
544 Qnil);
545}
546#endif /* NOTDEF */
547
548DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 1, 0,
549 "One arg PROMPT, a string. Read the name of a user variable and return\n\
550it as a symbol. Prompts with PROMPT.\n\
551A user variable is one whose documentation starts with a `*' character.")
552 (prompt)
553 Lisp_Object prompt;
554{
555 return Fintern (Fcompleting_read (prompt, Vobarray,
556 Quser_variable_p, Qt, Qnil, Qnil),
557 Qnil);
558}
559
560DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
561 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
562Prompts with PROMPT.\n\
563Optional second arg is value to return if user enters an empty line.\n\
564If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
565 (prompt, def, require_match)
566 Lisp_Object prompt, def, require_match;
567{
568 Lisp_Object tem;
569 Lisp_Object args[3];
570 struct gcpro gcpro1;
571
7510b296 572 if (BUFFERP (def))
f927c5ae 573 def = XBUFFER (def)->name;
56a98455 574 if (!NILP (def))
f927c5ae
JB
575 {
576 args[0] = build_string ("%s(default %s) ");
577 args[1] = prompt;
578 args[2] = def;
579 prompt = Fformat (3, args);
580 }
581 GCPRO1 (def);
582 tem = Fcompleting_read (prompt, Vbuffer_alist, Qnil, require_match, Qnil, Qnil);
583 UNGCPRO;
584 if (XSTRING (tem)->size)
585 return tem;
586 return def;
587}
588\f
589DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
590 "Return common substring of all completions of STRING in ALIST.\n\
591Each car of each element of ALIST is tested to see if it begins with STRING.\n\
592All that match are compared together; the longest initial sequence\n\
593common to all matches is returned as a string.\n\
594If there is no match at all, nil is returned.\n\
595For an exact match, t is returned.\n\
596\n\
597ALIST can be an obarray instead of an alist.\n\
598Then the print names of all symbols in the obarray are the possible matches.\n\
599\n\
600ALIST can also be a function to do the completion itself.\n\
601It receives three arguments: the values STRING, PREDICATE and nil.\n\
602Whatever it returns becomes the value of `try-completion'.\n\
603\n\
604If optional third argument PREDICATE is non-nil,\n\
605it is used to test each possible match.\n\
606The match is a candidate only if PREDICATE returns non-nil.\n\
607The argument given to PREDICATE is the alist element or the symbol from the obarray.")
608 (string, alist, pred)
609 Lisp_Object string, alist, pred;
610{
611 Lisp_Object bestmatch, tail, elt, eltstring;
612 int bestmatchsize;
613 int compare, matchsize;
56a98455 614 int list = CONSP (alist) || NILP (alist);
f927c5ae
JB
615 int index, obsize;
616 int matchcount = 0;
617 Lisp_Object bucket, zero, end, tem;
618 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
619
620 CHECK_STRING (string, 0);
7510b296 621 if (!list && !VECTORP (alist))
f927c5ae
JB
622 return call3 (alist, string, pred, Qnil);
623
624 bestmatch = Qnil;
625
626 /* If ALIST is not a list, set TAIL just for gc pro. */
627 tail = alist;
628 if (! list)
629 {
630 index = 0;
631 obsize = XVECTOR (alist)->size;
632 bucket = XVECTOR (alist)->contents[index];
633 }
634
635 while (1)
636 {
637 /* Get the next element of the alist or obarray. */
638 /* Exit the loop if the elements are all used up. */
639 /* elt gets the alist element or symbol.
640 eltstring gets the name to check as a completion. */
641
642 if (list)
643 {
56a98455 644 if (NILP (tail))
f927c5ae
JB
645 break;
646 elt = Fcar (tail);
647 eltstring = Fcar (elt);
648 tail = Fcdr (tail);
649 }
650 else
651 {
652 if (XFASTINT (bucket) != 0)
653 {
654 elt = bucket;
655 eltstring = Fsymbol_name (elt);
656 if (XSYMBOL (bucket)->next)
657 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
658 else
5a866662 659 XSETFASTINT (bucket, 0);
f927c5ae
JB
660 }
661 else if (++index >= obsize)
662 break;
663 else
664 {
665 bucket = XVECTOR (alist)->contents[index];
666 continue;
667 }
668 }
669
670 /* Is this element a possible completion? */
671
7510b296 672 if (STRINGP (eltstring)
42006772
RS
673 && XSTRING (string)->size <= XSTRING (eltstring)->size
674 && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
675 XSTRING (string)->size))
f927c5ae
JB
676 {
677 /* Yes. */
42006772
RS
678 Lisp_Object regexps;
679 Lisp_Object zero;
5a866662 680 XSETFASTINT (zero, 0);
42006772
RS
681
682 /* Ignore this element if it fails to match all the regexps. */
683 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
684 regexps = XCONS (regexps)->cdr)
685 {
686 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
687 if (NILP (tem))
688 break;
689 }
690 if (CONSP (regexps))
691 continue;
692
f927c5ae
JB
693 /* Ignore this element if there is a predicate
694 and the predicate doesn't like it. */
695
56a98455 696 if (!NILP (pred))
f927c5ae
JB
697 {
698 if (EQ (pred, Qcommandp))
699 tem = Fcommandp (elt);
700 else
701 {
702 GCPRO4 (tail, string, eltstring, bestmatch);
703 tem = call1 (pred, elt);
704 UNGCPRO;
705 }
56a98455 706 if (NILP (tem)) continue;
f927c5ae
JB
707 }
708
709 /* Update computation of how much all possible completions match */
710
711 matchcount++;
56a98455 712 if (NILP (bestmatch))
f927c5ae
JB
713 bestmatch = eltstring, bestmatchsize = XSTRING (eltstring)->size;
714 else
715 {
716 compare = min (bestmatchsize, XSTRING (eltstring)->size);
717 matchsize = scmp (XSTRING (bestmatch)->data,
718 XSTRING (eltstring)->data,
719 compare);
52b14ac0
JB
720 if (matchsize < 0)
721 matchsize = compare;
722 if (completion_ignore_case)
723 {
724 /* If this is an exact match except for case,
725 use it as the best match rather than one that is not an
726 exact match. This way, we get the case pattern
727 of the actual match. */
728 if ((matchsize == XSTRING (eltstring)->size
729 && matchsize < XSTRING (bestmatch)->size)
730 ||
731 /* If there is more than one exact match ignoring case,
732 and one of them is exact including case,
733 prefer that one. */
734 /* If there is no exact match ignoring case,
735 prefer a match that does not change the case
736 of the input. */
737 ((matchsize == XSTRING (eltstring)->size)
738 ==
739 (matchsize == XSTRING (bestmatch)->size)
740 && !bcmp (XSTRING (eltstring)->data,
741 XSTRING (string)->data, XSTRING (string)->size)
742 && bcmp (XSTRING (bestmatch)->data,
743 XSTRING (string)->data, XSTRING (string)->size)))
744 bestmatch = eltstring;
745 }
746 bestmatchsize = matchsize;
f927c5ae
JB
747 }
748 }
749 }
750
56a98455 751 if (NILP (bestmatch))
f927c5ae 752 return Qnil; /* No completions found */
52b14ac0
JB
753 /* If we are ignoring case, and there is no exact match,
754 and no additional text was supplied,
755 don't change the case of what the user typed. */
756 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
757 && XSTRING (bestmatch)->size > bestmatchsize)
758 return string;
759
760 /* Return t if the supplied string is an exact match (counting case);
761 it does not require any change to be made. */
762 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
763 && !bcmp (XSTRING (bestmatch)->data, XSTRING (string)->data,
764 bestmatchsize))
f927c5ae
JB
765 return Qt;
766
5a866662
KH
767 XSETFASTINT (zero, 0); /* Else extract the part in which */
768 XSETFASTINT (end, bestmatchsize); /* all completions agree */
f927c5ae
JB
769 return Fsubstring (bestmatch, zero, end);
770}
771
772/* Compare exactly LEN chars of strings at S1 and S2,
773 ignoring case if appropriate.
774 Return -1 if strings match,
775 else number of chars that match at the beginning. */
776
829f7f7c 777int
f927c5ae 778scmp (s1, s2, len)
829f7f7c 779 register unsigned char *s1, *s2;
f927c5ae
JB
780 int len;
781{
782 register int l = len;
783
784 if (completion_ignore_case)
785 {
786 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
787 l--;
788 }
789 else
790 {
791 while (l && *s1++ == *s2++)
792 l--;
793 }
794 if (l == 0)
795 return -1;
829f7f7c
KH
796 else
797 return len - l;
f927c5ae
JB
798}
799\f
800DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 3, 0,
801 "Search for partial matches to STRING in ALIST.\n\
802Each car of each element of ALIST is tested to see if it begins with STRING.\n\
803The value is a list of all the strings from ALIST that match.\n\
804ALIST can be an obarray instead of an alist.\n\
805Then the print names of all symbols in the obarray are the possible matches.\n\
806\n\
807ALIST can also be a function to do the completion itself.\n\
808It receives three arguments: the values STRING, PREDICATE and t.\n\
809Whatever it returns becomes the value of `all-completion'.\n\
810\n\
811If optional third argument PREDICATE is non-nil,\n\
812it is used to test each possible match.\n\
813The match is a candidate only if PREDICATE returns non-nil.\n\
814The argument given to PREDICATE is the alist element or the symbol from the obarray.")
815 (string, alist, pred)
816 Lisp_Object string, alist, pred;
817{
818 Lisp_Object tail, elt, eltstring;
819 Lisp_Object allmatches;
56a98455 820 int list = CONSP (alist) || NILP (alist);
f927c5ae
JB
821 int index, obsize;
822 Lisp_Object bucket, tem;
823 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
824
825 CHECK_STRING (string, 0);
7510b296 826 if (!list && !VECTORP (alist))
f927c5ae
JB
827 {
828 return call3 (alist, string, pred, Qt);
829 }
830 allmatches = Qnil;
831
832 /* If ALIST is not a list, set TAIL just for gc pro. */
833 tail = alist;
834 if (! list)
835 {
836 index = 0;
837 obsize = XVECTOR (alist)->size;
838 bucket = XVECTOR (alist)->contents[index];
839 }
840
841 while (1)
842 {
843 /* Get the next element of the alist or obarray. */
844 /* Exit the loop if the elements are all used up. */
845 /* elt gets the alist element or symbol.
846 eltstring gets the name to check as a completion. */
847
848 if (list)
849 {
56a98455 850 if (NILP (tail))
f927c5ae
JB
851 break;
852 elt = Fcar (tail);
853 eltstring = Fcar (elt);
854 tail = Fcdr (tail);
855 }
856 else
857 {
858 if (XFASTINT (bucket) != 0)
859 {
860 elt = bucket;
861 eltstring = Fsymbol_name (elt);
862 if (XSYMBOL (bucket)->next)
863 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
864 else
5a866662 865 XSETFASTINT (bucket, 0);
f927c5ae
JB
866 }
867 else if (++index >= obsize)
868 break;
869 else
870 {
871 bucket = XVECTOR (alist)->contents[index];
872 continue;
873 }
874 }
875
876 /* Is this element a possible completion? */
877
7510b296 878 if (STRINGP (eltstring)
2cbaf886
RS
879 && XSTRING (string)->size <= XSTRING (eltstring)->size
880 /* Reject alternatives that start with space
881 unless the input starts with space. */
882 && ((XSTRING (string)->size > 0 && XSTRING (string)->data[0] == ' ')
883 || XSTRING (eltstring)->data[0] != ' ')
884 && 0 > scmp (XSTRING (eltstring)->data, XSTRING (string)->data,
885 XSTRING (string)->size))
f927c5ae
JB
886 {
887 /* Yes. */
42006772
RS
888 Lisp_Object regexps;
889 Lisp_Object zero;
5a866662 890 XSETFASTINT (zero, 0);
42006772
RS
891
892 /* Ignore this element if it fails to match all the regexps. */
893 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
894 regexps = XCONS (regexps)->cdr)
895 {
896 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
897 if (NILP (tem))
898 break;
899 }
900 if (CONSP (regexps))
901 continue;
902
f927c5ae
JB
903 /* Ignore this element if there is a predicate
904 and the predicate doesn't like it. */
905
56a98455 906 if (!NILP (pred))
f927c5ae
JB
907 {
908 if (EQ (pred, Qcommandp))
909 tem = Fcommandp (elt);
910 else
911 {
912 GCPRO4 (tail, eltstring, allmatches, string);
913 tem = call1 (pred, elt);
914 UNGCPRO;
915 }
56a98455 916 if (NILP (tem)) continue;
f927c5ae
JB
917 }
918 /* Ok => put it on the list. */
919 allmatches = Fcons (eltstring, allmatches);
920 }
921 }
922
923 return Fnreverse (allmatches);
924}
925\f
926Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
927Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
928Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
929
b9d721de
JB
930/* This comment supplies the doc string for completing-read,
931 for make-docfile to see. We cannot put this in the real DEFUN
932 due to limits in the Unix cpp.
933
f927c5ae
JB
934DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
935 "Read a string in the minibuffer, with completion.\n\
770970cb 936Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, HIST.\n\
f927c5ae
JB
937PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
938TABLE is an alist whose elements' cars are strings, or an obarray.\n\
939PREDICATE limits completion to a subset of TABLE.\n\
6b3faad8
RS
940See `try-completion' and `all-completions' for more details
941 on completion, TABLE, and PREDICATE.\n\
cbbc3917 942\n\
f927c5ae 943If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
4ced3209 944 the input is (or completes to) an element of TABLE or is null.\n\
f927c5ae 945 If it is also not t, Return does not exit if it does non-null completion.\n\
cbbc3917
RS
946If the input is null, `completing-read' returns nil,\n\
947 regardless of the value of REQUIRE-MATCH.\n\
948\n\
f927c5ae 949If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
770970cb
RS
950 If it is (STRING . POSITION), the initial input\n\
951 is STRING, but point is placed POSITION characters into the string.\n\
952HIST, if non-nil, specifies a history list\n\
953 and optionally the initial position in the list.\n\
954 It can be a symbol, which is the history list variable to use,\n\
955 or it can be a cons cell (HISTVAR . HISTPOS).\n\
956 In that case, HISTVAR is the history list variable to use,\n\
957 and HISTPOS is the initial position (the position in the list\n\
958 which INITIAL-CONTENTS corresponds to).\n\
959 Positions are counted starting from 1 at the beginning of the list.\n\
960Completion ignores case if the ambient value of\n\
b9d721de
JB
961 `completion-ignore-case' is non-nil."
962*/
963DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
964 0 /* See immediately above */)
770970cb
RS
965 (prompt, table, pred, require_match, init, hist)
966 Lisp_Object prompt, table, pred, require_match, init, hist;
f927c5ae 967{
770970cb
RS
968 Lisp_Object val, histvar, histpos, position;
969 int pos = 0;
f927c5ae
JB
970 int count = specpdl_ptr - specpdl;
971 specbind (Qminibuffer_completion_table, table);
972 specbind (Qminibuffer_completion_predicate, pred);
973 specbind (Qminibuffer_completion_confirm,
974 EQ (require_match, Qt) ? Qnil : Qt);
975 last_exact_completion = Qnil;
770970cb
RS
976
977 position = Qnil;
978 if (!NILP (init))
979 {
7510b296 980 if (CONSP (init))
770970cb
RS
981 {
982 position = Fcdr (init);
983 init = Fcar (init);
984 }
985 CHECK_STRING (init, 0);
986 if (!NILP (position))
987 {
988 CHECK_NUMBER (position, 0);
989 /* Convert to distance from end of input. */
5dadd3a2 990 pos = XINT (position) - XSTRING (init)->size;
770970cb
RS
991 }
992 }
993
7510b296 994 if (SYMBOLP (hist))
770970cb
RS
995 {
996 histvar = hist;
997 histpos = Qnil;
998 }
999 else
1000 {
1001 histvar = Fcar_safe (hist);
1002 histpos = Fcdr_safe (hist);
1003 }
1004 if (NILP (histvar))
1005 histvar = Qminibuffer_history;
1006 if (NILP (histpos))
5a866662 1007 XSETFASTINT (histpos, 0);
770970cb 1008
56a98455 1009 val = read_minibuf (NILP (require_match)
f927c5ae
JB
1010 ? Vminibuffer_local_completion_map
1011 : Vminibuffer_local_must_match_map,
85b5fe07 1012 init, prompt, make_number (pos), 0,
770970cb 1013 histvar, histpos);
f927c5ae
JB
1014 return unbind_to (count, val);
1015}
1016\f
1017/* Temporarily display the string M at the end of the current
1018 minibuffer contents. This is used to display things like
1019 "[No Match]" when the user requests a completion for a prefix
1020 that has no possible completions, and other quick, unobtrusive
1021 messages. */
1022
1023temp_echo_area_glyphs (m)
1024 char *m;
1025{
f927c5ae
JB
1026 int osize = ZV;
1027 Lisp_Object oinhibit;
1028 oinhibit = Vinhibit_quit;
1029
896adf84
JB
1030 /* Clear out any old echo-area message to make way for our new thing. */
1031 message (0);
f927c5ae
JB
1032
1033 SET_PT (osize);
1034 insert_string (m);
1035 SET_PT (osize);
1036 Vinhibit_quit = Qt;
1037 Fsit_for (make_number (2), Qnil, Qnil);
a2dd849e 1038 del_range (PT, ZV);
56a98455 1039 if (!NILP (Vquit_flag))
f927c5ae
JB
1040 {
1041 Vquit_flag = Qnil;
ba71d84a 1042 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
f927c5ae
JB
1043 }
1044 Vinhibit_quit = oinhibit;
1045}
1046
1047Lisp_Object Fminibuffer_completion_help ();
52b14ac0 1048Lisp_Object assoc_for_completion ();
f927c5ae
JB
1049
1050/* returns:
1051 * 0 no possible completion
1052 * 1 was already an exact and unique completion
1053 * 3 was already an exact completion
1054 * 4 completed to an exact completion
1055 * 5 some completion happened
1056 * 6 no completion happened
1057 */
1058int
1059do_completion ()
1060{
1061 Lisp_Object completion, tem;
1062 int completedp;
1063 Lisp_Object last;
1e00c2ff 1064 struct gcpro gcpro1, gcpro2;
f927c5ae
JB
1065
1066 completion = Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table,
1067 Vminibuffer_completion_predicate);
1068 last = last_exact_completion;
1069 last_exact_completion = Qnil;
1070
4f9b95e5
KH
1071 GCPRO2 (completion, last);
1072
56a98455 1073 if (NILP (completion))
f927c5ae
JB
1074 {
1075 bitch_at_user ();
1076 temp_echo_area_glyphs (" [No match]");
1e00c2ff 1077 UNGCPRO;
f927c5ae
JB
1078 return 0;
1079 }
1080
1081 if (EQ (completion, Qt)) /* exact and unique match */
1e00c2ff
KH
1082 {
1083 UNGCPRO;
1084 return 1;
1085 }
f927c5ae
JB
1086
1087 /* compiler bug */
1088 tem = Fstring_equal (completion, Fbuffer_string());
56a98455 1089 if (completedp = NILP (tem))
f927c5ae
JB
1090 {
1091 Ferase_buffer (); /* Some completion happened */
1092 Finsert (1, &completion);
1093 }
1094
1095 /* It did find a match. Do we match some possibility exactly now? */
1096 if (CONSP (Vminibuffer_completion_table)
56a98455 1097 || NILP (Vminibuffer_completion_table))
52b14ac0
JB
1098 tem = assoc_for_completion (Fbuffer_string (),
1099 Vminibuffer_completion_table);
7510b296 1100 else if (VECTORP (Vminibuffer_completion_table))
f927c5ae
JB
1101 {
1102 /* the primitive used by Fintern_soft */
1103 extern Lisp_Object oblookup ();
1104
1105 tem = Fbuffer_string ();
1106 /* Bypass intern-soft as that loses for nil */
1107 tem = oblookup (Vminibuffer_completion_table,
1108 XSTRING (tem)->data, XSTRING (tem)->size);
7510b296 1109 if (!SYMBOLP (tem))
f927c5ae 1110 tem = Qnil;
56a98455 1111 else if (!NILP (Vminibuffer_completion_predicate))
f927c5ae
JB
1112 tem = call1 (Vminibuffer_completion_predicate, tem);
1113 else
1114 tem = Qt;
1115 }
1116 else
1117 tem = call3 (Vminibuffer_completion_table,
1118 Fbuffer_string (),
1119 Vminibuffer_completion_predicate,
1120 Qlambda);
1121
56a98455 1122 if (NILP (tem))
1e00c2ff
KH
1123 {
1124 /* not an exact match */
1125 UNGCPRO;
f927c5ae
JB
1126 if (completedp)
1127 return 5;
1128 else if (auto_help)
1129 Fminibuffer_completion_help ();
1130 else
1131 temp_echo_area_glyphs (" [Next char not unique]");
1132 return 6;
1133 }
1134 else if (completedp)
1e00c2ff
KH
1135 {
1136 UNGCPRO;
1137 return 4;
1138 }
f927c5ae
JB
1139 /* If the last exact completion and this one were the same,
1140 it means we've already given a "Complete but not unique"
52b14ac0 1141 message and the user's hit TAB again, so now we give him help. */
f927c5ae 1142 last_exact_completion = completion;
56a98455 1143 if (!NILP (last))
f927c5ae
JB
1144 {
1145 tem = Fbuffer_string ();
56a98455 1146 if (!NILP (Fequal (tem, last)))
f927c5ae
JB
1147 Fminibuffer_completion_help ();
1148 }
1e00c2ff 1149 UNGCPRO;
f927c5ae 1150 return 3;
f927c5ae 1151}
1e00c2ff 1152
52b14ac0
JB
1153/* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1154
1155Lisp_Object
1156assoc_for_completion (key, list)
1157 register Lisp_Object key;
1158 Lisp_Object list;
1159{
1160 register Lisp_Object tail;
1161
1162 if (completion_ignore_case)
1163 key = Fupcase (key);
1164
56a98455 1165 for (tail = list; !NILP (tail); tail = Fcdr (tail))
52b14ac0
JB
1166 {
1167 register Lisp_Object elt, tem, thiscar;
1168 elt = Fcar (tail);
1169 if (!CONSP (elt)) continue;
1170 thiscar = Fcar (elt);
7510b296 1171 if (!STRINGP (thiscar))
52b14ac0
JB
1172 continue;
1173 if (completion_ignore_case)
1174 thiscar = Fupcase (thiscar);
1175 tem = Fequal (thiscar, key);
56a98455 1176 if (!NILP (tem)) return elt;
52b14ac0
JB
1177 QUIT;
1178 }
1179 return Qnil;
1180}
f927c5ae
JB
1181
1182DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
6300d782 1183 "Complete the minibuffer contents as far as possible.\n\
2cb6da5c
RS
1184Return nil if there is no valid completion, else t.\n\
1185If no characters can be completed, display a list of possible completions.\n\
1186If you repeat this command after it displayed such a list,\n\
1187scroll the window of possible completions.")
f927c5ae
JB
1188 ()
1189{
2cb6da5c
RS
1190 register int i;
1191 Lisp_Object window, tem;
1192
1193 /* If the previous command was not this, then mark the completion
1194 buffer obsolete. */
1195 if (! EQ (last_command, this_command))
1196 Vminibuf_scroll_window = Qnil;
1197
1198 window = Vminibuf_scroll_window;
1199 /* If there's a fresh completion window with a live buffer,
1200 and this command is repeated, scroll that window. */
1201 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1202 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1203 {
1204 struct buffer *obuf = current_buffer;
1205
1206 Fset_buffer (XWINDOW (window)->buffer);
1207 tem = Fpos_visible_in_window_p (make_number (ZV), window);
1208 if (! NILP (tem))
1209 /* If end is in view, scroll up to the beginning. */
8768d630 1210 Fset_window_start (window, BEGV, Qnil);
2cb6da5c
RS
1211 else
1212 /* Else scroll down one screen. */
1213 Fscroll_other_window (Qnil);
1214
1215 set_buffer_internal (obuf);
1216 return Qnil;
1217 }
1218
1219 i = do_completion ();
f927c5ae
JB
1220 switch (i)
1221 {
1222 case 0:
1223 return Qnil;
1224
1225 case 1:
1226 temp_echo_area_glyphs (" [Sole completion]");
1227 break;
1228
1229 case 3:
1230 temp_echo_area_glyphs (" [Complete, but not unique]");
1231 break;
1232 }
1233
1234 return Qt;
1235}
1236
1237DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1238 Sminibuffer_complete_and_exit, 0, 0, "",
1239 "Complete the minibuffer contents, and maybe exit.\n\
1240Exit if the name is valid with no completion needed.\n\
1241If name was completed to a valid match,\n\
1242a repetition of this command will exit.")
1243 ()
1244{
1245 register int i;
1246
1247 /* Allow user to specify null string */
1248 if (BEGV == ZV)
1249 goto exit;
1250
1251 i = do_completion ();
1252 switch (i)
1253 {
1254 case 1:
1255 case 3:
1256 goto exit;
1257
1258 case 4:
56a98455 1259 if (!NILP (Vminibuffer_completion_confirm))
f927c5ae
JB
1260 {
1261 temp_echo_area_glyphs (" [Confirm]");
1262 return Qnil;
1263 }
1264 else
1265 goto exit;
1266
1267 default:
1268 return Qnil;
1269 }
1270 exit:
1271 Fthrow (Qexit, Qnil);
1272 /* NOTREACHED */
1273}
1274
1275DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1276 0, 0, "",
1277 "Complete the minibuffer contents at most a single word.\n\
1278After one word is completed as much as possible, a space or hyphen\n\
6300d782
KH
1279is added, provided that matches some possible completion.\n\
1280Return nil if there is no valid completion, else t.")
f927c5ae
JB
1281 ()
1282{
1283 Lisp_Object completion, tem;
1284 register int i;
1285 register unsigned char *completion_string;
d7be4211 1286 struct gcpro gcpro1, gcpro2;
b278606c
BF
1287
1288 /* We keep calling Fbuffer_string rather than arrange for GC to
1289 hold onto a pointer to one of the strings thus made. */
f927c5ae
JB
1290
1291 completion = Ftry_completion (Fbuffer_string (),
1292 Vminibuffer_completion_table,
1293 Vminibuffer_completion_predicate);
56a98455 1294 if (NILP (completion))
f927c5ae
JB
1295 {
1296 bitch_at_user ();
1297 temp_echo_area_glyphs (" [No match]");
1298 return Qnil;
1299 }
1300 if (EQ (completion, Qt))
1301 return Qnil;
1302
b278606c 1303#if 0 /* How the below code used to look, for reference. */
f927c5ae
JB
1304 tem = Fbuffer_string ();
1305 b = XSTRING (tem)->data;
1306 i = ZV - 1 - XSTRING (completion)->size;
1307 p = XSTRING (completion)->data;
1308 if (i > 0 ||
1309 0 <= scmp (b, p, ZV - 1))
1310 {
1311 i = 1;
1312 /* Set buffer to longest match of buffer tail and completion head. */
1313 while (0 <= scmp (b + i, p, ZV - 1 - i))
1314 i++;
1315 del_range (1, i + 1);
1316 SET_PT (ZV);
1317 }
1318#else /* Rewritten code */
1319 {
1320 register unsigned char *buffer_string;
1321 int buffer_length, completion_length;
1322
1323 tem = Fbuffer_string ();
d7be4211 1324 GCPRO2 (completion, tem);
719b4a40
RS
1325 /* If reading a file name,
1326 expand any $ENVVAR refs in the buffer and in TEM. */
1327 if (EQ (Vminibuffer_completion_table, Qread_file_name_internal))
1328 {
1329 Lisp_Object substituted;
1330 substituted = Fsubstitute_in_file_name (tem);
1331 if (! EQ (substituted, tem))
1332 {
1333 tem = substituted;
1334 Ferase_buffer ();
3cab9ae4 1335 insert_from_string (tem, 0, XSTRING (tem)->size, 0);
719b4a40
RS
1336 }
1337 }
f927c5ae
JB
1338 buffer_string = XSTRING (tem)->data;
1339 completion_string = XSTRING (completion)->data;
1340 buffer_length = XSTRING (tem)->size; /* ie ZV - BEGV */
1341 completion_length = XSTRING (completion)->size;
1342 i = buffer_length - completion_length;
1343 /* Mly: I don't understand what this is supposed to do AT ALL */
1344 if (i > 0 ||
1345 0 <= scmp (buffer_string, completion_string, buffer_length))
1346 {
1347 /* Set buffer to longest match of buffer tail and completion head. */
1348 if (i <= 0) i = 1;
1349 buffer_string += i;
1350 buffer_length -= i;
1351 while (0 <= scmp (buffer_string++, completion_string, buffer_length--))
1352 i++;
1353 del_range (1, i + 1);
1354 SET_PT (ZV);
1355 }
d7be4211 1356 UNGCPRO;
f927c5ae
JB
1357 }
1358#endif /* Rewritten code */
1359 i = ZV - BEGV;
1360
1361 /* If completion finds next char not unique,
b278606c 1362 consider adding a space or a hyphen. */
f927c5ae
JB
1363 if (i == XSTRING (completion)->size)
1364 {
b278606c 1365 GCPRO1 (completion);
f927c5ae
JB
1366 tem = Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1367 Vminibuffer_completion_table,
1368 Vminibuffer_completion_predicate);
b278606c
BF
1369 UNGCPRO;
1370
7510b296 1371 if (STRINGP (tem))
f927c5ae
JB
1372 completion = tem;
1373 else
1374 {
b278606c
BF
1375 GCPRO1 (completion);
1376 tem =
1377 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1378 Vminibuffer_completion_table,
1379 Vminibuffer_completion_predicate);
1380 UNGCPRO;
1381
7510b296 1382 if (STRINGP (tem))
f927c5ae
JB
1383 completion = tem;
1384 }
1385 }
1386
1387 /* Now find first word-break in the stuff found by completion.
1388 i gets index in string of where to stop completing. */
b278606c 1389
f927c5ae
JB
1390 completion_string = XSTRING (completion)->data;
1391
1392 for (; i < XSTRING (completion)->size; i++)
1393 if (SYNTAX (completion_string[i]) != Sword) break;
1394 if (i < XSTRING (completion)->size)
1395 i = i + 1;
1396
1397 /* If got no characters, print help for user. */
1398
1399 if (i == ZV - BEGV)
1400 {
1401 if (auto_help)
1402 Fminibuffer_completion_help ();
1403 return Qnil;
1404 }
1405
1406 /* Otherwise insert in minibuffer the chars we got */
1407
1408 Ferase_buffer ();
3cab9ae4 1409 insert_from_string (completion, 0, i, 1);
f927c5ae
JB
1410 return Qt;
1411}
1412\f
1413DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
1414 1, 1, 0,
2dc2b736 1415 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
f927c5ae 1416Each element may be just a symbol or string\n\
2d7e41fe
RS
1417or may be a list of two strings to be printed as if concatenated.\n\
1418`standard-output' must be a buffer.\n\
1419At the end, run the normal hook `completion-setup-hook'.\n\
1420It can find the completion buffer in `standard-output'.")
f927c5ae
JB
1421 (completions)
1422 Lisp_Object completions;
1423{
1424 register Lisp_Object tail, elt;
1425 register int i;
2dc2b736 1426 int column = 0;
486cc7fb 1427 struct gcpro gcpro1;
2dc2b736 1428 struct buffer *old = current_buffer;
486cc7fb
RS
1429
1430 /* Note that (when it matters) every variable
1431 points to a non-string that is pointed to by COMPLETIONS. */
1432 GCPRO1 (completions);
1433
7510b296 1434 if (BUFFERP (Vstandard_output))
2dc2b736 1435 set_buffer_internal (XBUFFER (Vstandard_output));
f927c5ae 1436
56a98455 1437 if (NILP (completions))
cfc736bf
RS
1438 write_string ("There are no possible completions of what you have typed.",
1439 -1);
f927c5ae
JB
1440 else
1441 {
2dc2b736 1442 write_string ("Possible completions are:", -1);
56a98455 1443 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
f927c5ae
JB
1444 {
1445 /* this needs fixing for the case of long completions
1446 and/or narrow windows */
1447 /* Sadly, the window it will appear in is not known
1448 until after the text has been made. */
1449 if (i & 1)
2dc2b736 1450 {
7510b296 1451 if (BUFFERP (Vstandard_output))
18ae44fc 1452 Findent_to (make_number (35), make_number (2));
2dc2b736
RS
1453 else
1454 {
1455 do
1456 {
1457 write_string (" ", -1);
1458 column++;
1459 }
1460 while (column < 35);
1461 }
1462 }
f927c5ae 1463 else
2dc2b736
RS
1464 {
1465 Fterpri (Qnil);
1466 column = 0;
1467 }
f927c5ae
JB
1468 elt = Fcar (tail);
1469 if (CONSP (elt))
1470 {
7510b296 1471 if (!BUFFERP (Vstandard_output))
2dc2b736 1472 {
07accdfe 1473 Lisp_Object tem;
2dc2b736
RS
1474 tem = Flength (Fcar (elt));
1475 column += XINT (tem);
1476 tem = Flength (Fcar (Fcdr (elt)));
1477 column += XINT (tem);
1478 }
f927c5ae
JB
1479 Fprinc (Fcar (elt), Qnil);
1480 Fprinc (Fcar (Fcdr (elt)), Qnil);
1481 }
1482 else
2dc2b736 1483 {
7510b296 1484 if (!BUFFERP (Vstandard_output))
2dc2b736
RS
1485 {
1486 Lisp_Object tem;
f1b28218 1487 tem = Flength (elt);
2dc2b736
RS
1488 column += XINT (tem);
1489 }
1490 Fprinc (elt, Qnil);
1491 }
f927c5ae
JB
1492 }
1493 }
2dc2b736 1494
486cc7fb
RS
1495 UNGCPRO;
1496
7510b296 1497 if (BUFFERP (Vstandard_output))
2d7e41fe
RS
1498 set_buffer_internal (old);
1499
cfc736bf
RS
1500 if (!NILP (Vrun_hooks))
1501 call1 (Vrun_hooks, intern ("completion-setup-hook"));
1502
f927c5ae
JB
1503 return Qnil;
1504}
1505
1506DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
1507 0, 0, "",
1508 "Display a list of possible completions of the current minibuffer contents.")
1509 ()
1510{
1511 Lisp_Object completions;
1512
1513 message ("Making completion list...");
1514 completions = Fall_completions (Fbuffer_string (),
1515 Vminibuffer_completion_table,
1516 Vminibuffer_completion_predicate);
1517 echo_area_glyphs = 0;
1518
56a98455 1519 if (NILP (completions))
f927c5ae
JB
1520 {
1521 bitch_at_user ();
1522 temp_echo_area_glyphs (" [No completions]");
1523 }
1524 else
1525 internal_with_output_to_temp_buffer ("*Completions*",
1526 Fdisplay_completion_list,
1527 Fsort (completions, Qstring_lessp));
1528 return Qnil;
1529}
1530\f
1531DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
1532 "Terminate minibuffer input.")
1533 ()
1534{
7510b296 1535 if (INTEGERP (last_command_char))
f927c5ae
JB
1536 internal_self_insert (last_command_char, 0);
1537 else
1538 bitch_at_user ();
1539
1540 Fthrow (Qexit, Qnil);
1541}
1542
1543DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
1544 "Terminate this minibuffer argument.")
1545 ()
1546{
1547 Fthrow (Qexit, Qnil);
1548}
1549
1550DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1551 "Return current depth of activations of minibuffer, a nonnegative integer.")
1552 ()
1553{
1554 return make_number (minibuf_level);
1555}
1556
37e9a934
KH
1557DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1558 "Return the prompt string of the currently-active minibuffer.\n\
1559If no minibuffer is active, return nil.")
1560 ()
1561{
4d04c1f1 1562 return Fcopy_sequence (minibuf_prompt);
37e9a934
KH
1563}
1564
1565DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width,
1566 Sminibuffer_prompt_width, 0, 0, 0,
c5896ef4 1567 "Return the display width of the minibuffer prompt.")
37e9a934
KH
1568 ()
1569{
1570 Lisp_Object width;
5a866662 1571 XSETFASTINT (width, minibuf_prompt_width);
37e9a934
KH
1572 return width;
1573}
f927c5ae
JB
1574\f
1575init_minibuf_once ()
1576{
1577 Vminibuffer_list = Qnil;
1578 staticpro (&Vminibuffer_list);
1579}
1580
1581syms_of_minibuf ()
1582{
1583 minibuf_level = 0;
4d04c1f1
KH
1584 minibuf_prompt = Qnil;
1585 staticpro (&minibuf_prompt);
1586
1587 minibuf_save_list = Qnil;
1588 staticpro (&minibuf_save_list);
f927c5ae 1589
719b4a40
RS
1590 Qread_file_name_internal = intern ("read-file-name-internal");
1591 staticpro (&Qread_file_name_internal);
1592
f927c5ae
JB
1593 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
1594 staticpro (&Qminibuffer_completion_table);
1595
1596 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
1597 staticpro (&Qminibuffer_completion_confirm);
1598
1599 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
1600 staticpro (&Qminibuffer_completion_predicate);
1601
1e00c2ff
KH
1602 staticpro (&last_exact_completion);
1603 last_exact_completion = Qnil;
1604
f927c5ae
JB
1605 staticpro (&last_minibuf_string);
1606 last_minibuf_string = Qnil;
1607
1608 Quser_variable_p = intern ("user-variable-p");
1609 staticpro (&Quser_variable_p);
1610
770970cb
RS
1611 Qminibuffer_history = intern ("minibuffer-history");
1612 staticpro (&Qminibuffer_history);
f927c5ae 1613
5c781212
RS
1614 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
1615 staticpro (&Qminibuffer_setup_hook);
1616
177aecf9
KH
1617 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
1618 staticpro (&Qminibuffer_exit_hook);
1619
5c781212
RS
1620 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
1621 "Normal hook run just after entry to minibuffer.");
1622 Vminibuffer_setup_hook = Qnil;
1623
177aecf9
KH
1624 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
1625 "Normal hook run just after exit from minibuffer.");
1626 Vminibuffer_exit_hook = Qnil;
1627
f927c5ae
JB
1628 DEFVAR_BOOL ("completion-auto-help", &auto_help,
1629 "*Non-nil means automatically provide help for invalid completion input.");
1630 auto_help = 1;
1631
1632 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
1633 "Non-nil means don't consider case significant in completion.");
1634 completion_ignore_case = 0;
1635
1636 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
1637 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
1638More precisely, this variable makes a difference when the minibuffer window\n\
1639is the selected window. If you are in some other window, minibuffer commands\n\
1640are allowed even if a minibuffer is active.");
1641 enable_recursive_minibuffers = 0;
1642
1643 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
1644 "Alist or obarray used for completion in the minibuffer.\n\
1645This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
1646\n\
1647The value may alternatively be a function, which is given three arguments:\n\
1648 STRING, the current buffer contents;\n\
1649 PREDICATE, the predicate for filtering possible matches;\n\
1650 CODE, which says what kind of things to do.\n\
1651CODE can be nil, t or `lambda'.\n\
1652nil means to return the best completion of STRING, or nil if there is none.\n\
1653t means to return a list of all possible completions of STRING.\n\
1654`lambda' means to return t if STRING is a valid completion as it stands.");
1655 Vminibuffer_completion_table = Qnil;
1656
1657 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
1658 "Within call to `completing-read', this holds the PREDICATE argument.");
1659 Vminibuffer_completion_predicate = Qnil;
1660
1661 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
1662 "Non-nil => demand confirmation of completion before exiting minibuffer.");
1663 Vminibuffer_completion_confirm = Qnil;
1664
1665 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
1666 "Value that `help-form' takes on inside the minibuffer.");
1667 Vminibuffer_help_form = Qnil;
1668
770970cb
RS
1669 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
1670 "History list symbol to add minibuffer values to.\n\
1671Each minibuffer output is added with\n\
1672 (set minibuffer-history-variable\n\
1673 (cons STRING (symbol-value minibuffer-history-variable)))");
5a866662 1674 XSETFASTINT (Vminibuffer_history_variable, 0);
770970cb
RS
1675
1676 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
1677 "Current position of redoing in the history list.");
1678 Vminibuffer_history_position = Qnil;
1679
6a9ee000
RS
1680 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
1681 "*Non-nil means entering the minibuffer raises the minibuffer's frame.");
1682 minibuffer_auto_raise = 0;
1683
42006772
RS
1684 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
1685 "List of regexps that should restrict possible completions.");
1686 Vcompletion_regexp_list = Qnil;
1687
f927c5ae
JB
1688 defsubr (&Sread_from_minibuffer);
1689 defsubr (&Seval_minibuffer);
1690 defsubr (&Sread_minibuffer);
1691 defsubr (&Sread_string);
1692 defsubr (&Sread_command);
1693 defsubr (&Sread_variable);
1694 defsubr (&Sread_buffer);
1695 defsubr (&Sread_no_blanks_input);
1696 defsubr (&Sminibuffer_depth);
37e9a934
KH
1697 defsubr (&Sminibuffer_prompt);
1698 defsubr (&Sminibuffer_prompt_width);
f927c5ae
JB
1699
1700 defsubr (&Stry_completion);
1701 defsubr (&Sall_completions);
1702 defsubr (&Scompleting_read);
1703 defsubr (&Sminibuffer_complete);
1704 defsubr (&Sminibuffer_complete_word);
1705 defsubr (&Sminibuffer_complete_and_exit);
1706 defsubr (&Sdisplay_completion_list);
1707 defsubr (&Sminibuffer_completion_help);
1708
1709 defsubr (&Sself_insert_and_exit);
1710 defsubr (&Sexit_minibuffer);
1711
1712}
1713
1714keys_of_minibuf ()
1715{
1716 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
1717 "abort-recursive-edit");
1718 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
1719 "exit-minibuffer");
1720 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
1721 "exit-minibuffer");
1722
1723 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
1724 "abort-recursive-edit");
1725 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
1726 "exit-minibuffer");
1727 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
1728 "exit-minibuffer");
1729
1730 initial_define_key (Vminibuffer_local_ns_map, ' ',
1731 "exit-minibuffer");
1732 initial_define_key (Vminibuffer_local_ns_map, '\t',
1733 "exit-minibuffer");
1734 initial_define_key (Vminibuffer_local_ns_map, '?',
1735 "self-insert-and-exit");
1736
1737 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
1738 "abort-recursive-edit");
1739 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
1740 "exit-minibuffer");
1741 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
1742 "exit-minibuffer");
1743
1744 initial_define_key (Vminibuffer_local_completion_map, '\t',
1745 "minibuffer-complete");
1746 initial_define_key (Vminibuffer_local_completion_map, ' ',
1747 "minibuffer-complete-word");
1748 initial_define_key (Vminibuffer_local_completion_map, '?',
1749 "minibuffer-completion-help");
1750
1751 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
1752 "abort-recursive-edit");
1753 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
1754 "minibuffer-complete-and-exit");
1755 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
1756 "minibuffer-complete-and-exit");
1757 initial_define_key (Vminibuffer_local_must_match_map, '\t',
1758 "minibuffer-complete");
1759 initial_define_key (Vminibuffer_local_must_match_map, ' ',
1760 "minibuffer-complete-word");
1761 initial_define_key (Vminibuffer_local_must_match_map, '?',
1762 "minibuffer-completion-help");
1763}