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