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