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