Switch to recommended form of GPLv3 permissions notice.
[bpt/emacs.git] / lisp / ido.el
CommitLineData
789d1bf0
KS
1;;; ido.el --- interactively do things with buffers and files.
2
0d30b337 3;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
3da360a7 4;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
789d1bf0
KS
5
6;; Author: Kim F. Storm <storm@cua.dk>
7;; Based on: iswitchb by Stephen Eglen <stephen@cns.ed.ac.uk>
8;; Keywords: extensions convenience
9
10;; This file is part of GNU Emacs.
11
eb3fa2cf 12;; GNU Emacs is free software: you can redistribute it and/or modify
789d1bf0 13;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
789d1bf0
KS
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
eb3fa2cf 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
789d1bf0 24
789d1bf0
KS
25
26;;; Commentary:
27
28;; Ido - interactive do - switches between buffers and opens files and
29;; directories with a minimum of keystrokes. It is a superset of
30;; iswitchb, the interactive buffer switching package by Stephen Eglen.
31
32;; Interactive substring matching
33;; ------------------------------
34;;
35;; As you type in a substring, the list of buffers or files currently
36;; matching the substring are displayed as you type. The list is
37;; ordered so that the most recent buffers or files visited come at
38;; the start of the list.
39;;
40;; The buffer or file at the start of the list will be the one visited
41;; when you press RETURN. By typing more of the substring, the list is
42;; narrowed down so that gradually the buffer or file you want will be
43;; at the top of the list. Alternatively, you can use C-s and C-r (or
44;; the right and left arrow keys) to rotate buffer or file names in the
45;; list until the one you want is at the top of the list.
46;;
47;; Completion is also available so that you can see what is common to
48;; all of the matching buffers or files as you type.
49;;
50;; Example:
51;;
52;; If I have two buffers called "123456" and "123", with "123456" the
53;; most recent, when I use ido-switch-buffer, I first of all get
54;; presented with the list of all the buffers
55;;
04c95147 56;; Buffer: {123456 | 123}
789d1bf0
KS
57;;
58;; If I then press 2:
04c95147 59;; Buffer: 2[3]{123456 | 123}
789d1bf0
KS
60;;
61;; The list in {...} are the matching buffers, most recent first
62;; (buffers visible in the current frame are put at the end of the
63;; list by default). At any time I can select the item at the head of
f2801d2a
KS
64;; the list by pressing RET. I can also put the first element at the
65;; end of the list by pressing C-s or [right], or bring the last
66;; element to the head of the list by pressing C-r or [left].
789d1bf0
KS
67;;
68;; The item in [...] indicates what can be added to my input by
69;; pressing TAB. In this case, I will get "3" added to my input.
70
71;; So, I press TAB:
04c95147 72;; Buffer: 23{123456 | 123}
789d1bf0
KS
73;;
74;; At this point, I still have two matching buffers.
75;; If I want the first buffer in the list, I simply press RET. If I
76;; wanted the second in the list, I could press C-s to move it to the
77;; top of the list and then RET to select it.
78;;
79;; However, if I type 4, I only have one match left:
04c95147
KS
80;; Buffer: 234[123456]
81;;
82;; Since there is only one matching buffer left, it is given in [] and
83;; it is shown in the `ido-only-match' face (ForestGreen). I can now
84;; press TAB or RET to go to that buffer.
789d1bf0 85;;
04c95147
KS
86;; If I want to create a new buffer named "234", I press C-j instead of
87;; TAB or RET.
789d1bf0 88;;
04c95147 89;; If instead, I type "a":
789d1bf0
KS
90;; Buffer: 234a [No match]
91;; There are no matching buffers. If I press RET or TAB, I can be
92;; prompted to create a new buffer called "234a".
93;;
94;; Of course, where this function comes in really useful is when you
95;; can specify the buffer using only a few keystrokes. In the above
96;; example, the quickest way to get to the "123456" file would be
97;; just to type 4 and then RET (assuming there isn't any newer buffer
98;; with 4 in its name).
99
100;; Likewise, if you use C-x C-f (ido-find-file), the list of files and
101;; directories in the current directory is provided in the same
102;; fashion as the buffers above. The files and directories are
103;; normally sorted in alphabetical order, but the most recently
104;; visited directory is placed first to speed up navigating to
105;; directories that you have visited recently.
106;;
107;; In addition to scrolling through the list using [right] and [left],
108;; you can use [up] and [down] to quickly scroll the list to the next
109;; or previous subdirectory.
110;;
111;; To go down into a subdirectory, and continue the file selection on
112;; the files in that directory, simply move the directory to the head
113;; of the list and hit RET.
114;;
115;; To go up to the parent directory, delete any partial file name
116;; already specified (e.g. using [backspace]) and hit [backspace].
117;;
118;; To go to the root directory (on the current drive), enter two
119;; slashes. On MS-DOS or Windows, to select the root of another
120;; drive, enter X:/ where X is the drive letter. You can also visit
121;; files on other hosts using the ange-ftp notations `/host:' and
122;; `/user@host:'. See the variable `ido-slow-ftp-hosts' if you want
71296446 123;; to inhibit the ido substring matching for ftp access.
789d1bf0
KS
124;;
125;; If for some reason you cannot specify the proper file using
126;; ido-find-file, you can press C-f to enter the normal find-file.
127;; You can also press C-b to drop into ido-switch-buffer.
128
129;; See the doc string of ido-switch-buffer and ido-find-file for full
130;; keybindings and features.
131;; (describe-function 'ido-find-file)
132
133;; Hidden buffers and files
134;; ------------------------
135;;
136;; Normally, ido does not include hidden buffers (whose name starts
137;; with a space) and hidden files and directories (whose name starts
138;; with `.') in the list of possible completions. However, if the
139;; substring you enter does not match any of the visible buffers or
140;; files, ido will automatically look for completions among the hidden
141;; buffers or files.
142;;
143;; You can toggle display of the hidden buffers and files with C-a.
144
145;; Additional functionality
146;; ------------------------
147;;
148;; After C-x b, the buffer at the head of the list can be killed by
149;; pressing C-k. If the buffer needs saving, you will be queried
150;; before the buffer is killed.
151;;
152;; Likewise, after C-x C-f, you can delete (i.e. physically remove)
153;; the file at the head of the list with C-k. You will always be
154;; asked for confirmation before the file is deleted.
155;;
156;; If you enter C-x b to switch to a buffer visiting a given file, and
157;; you find that the file you are after is not in any buffer, you can
158;; press C-f to immediately drop into ido-find-file. And you can
159;; switch back to buffer selection with C-b.
160
161;; Prefix matching
162;; ---------------
163;;
164;; The standard way of completion with Unix-shells and Emacs is to insert a
165;; PREFIX and then hitting TAB (or another completion key). Cause of this
166;; behavior has become second nature to a lot of emacs users `ido' offers in
167;; addition to the default substring-matching-method (look above) also the
168;; prefix-matching-method. The kind of matching is the only difference to
169;; the description of the substring-matching above.
170;;
171;; You can toggle prefix matching with C-p.
172;;
173;; Example:
174;;
175;; If you have again two Buffers "123456" and "123" then hitting "2" does
f2801d2a 176;; not match because "2" is not a PREFIX in any of the buffer-names.
789d1bf0
KS
177
178;; Flexible matching
179;; -----------------
180;;
181;; If you set ido-enable-flex-matching, ido will do a more flexible
182;; matching (unless regexp matching is active) to find possible matches
183;; among the available buffer or file names if no matches are found using
184;; the normal prefix or substring matching.
185;;
186;; The flexible matching implies that any item which simply contains all
187;; of the entered characters in the specified sequence will match.
188;;
189;; Example:
190;;
191;; If you have four files "alpha", "beta", "gamma", and "delta",
192;; entering "aa" will match "alpha" and "gamma", while "ea" matches
193;; "beta" and "delta". If prefix matching is also active, "aa" only
194;; matches "alpha", while "ea" does not match any files.
195
196;; Regexp matching
197;; ---------------
198;;
199;; There is limited provision for regexp matching within ido,
200;; enabled through `ido-enable-regexp' (toggle with C-t).
f2801d2a
KS
201;; This allows you to type `[ch]$' for example and see all file names
202;; ending in `c' or `h'.
203;;
204;; Note: ido-style completion is inhibited when you enable regexp matching.
789d1bf0
KS
205
206
207;; Customization
208;; -------------
209;;
210;; Customize the `ido' group to change the `ido' functionality.
211;;
3729cc87
KS
212;; To modify the keybindings, use the ido-setup-hook. For example:
213;;(add-hook 'ido-setup-hook 'ido-my-keys)
789d1bf0
KS
214;;
215;;(defun ido-my-keys ()
216;; "Add my keybindings for ido."
facf67fd 217;; (define-key ido-completion-map " " 'ido-next-match)
789d1bf0
KS
218;; )
219
220;; Seeing all the matching buffers or files
221;; ----------------------------------------
222;;
223;; If you have many matching files, they may not all fit onto one
224;; line of the minibuffer. Normally, the minibuffer window will grow
225;; to show you more of the matching files (depending on the setting
226;; of the variables `resize-mini-windows' and `max-mini-window-height').
227;; If you want ido to behave differently from the default minibuffer
228;; resizing behaviour, set the variable `ido-max-window-height'.
229;;
230;; Also, to improve the responsiveness of ido, the maximum number of
231;; matching items is limited to 12, but you can increase or removed
232;; this limit via the `ido-max-prospects' variable.
233
234;; To see a full list of all matching buffers in a separate buffer,
235;; hit ? or press TAB when there are no further completions to the
236;; substring. Repeated TAB presses will scroll you through this
237;; separate buffer.
238
239;; Changing the list of files
240;; --------------------------
241
242;; By default, the list of current files is most recent first,
243;; oldest last, with the exception that the files visible in the
244;; current frame are put at the end of the list. A hook exists to
245;; allow other functions to order the list. For example, if you add:
246;;
247;; (add-hook 'ido-make-buffer-list-hook 'ido-summary-buffers-to-end)
248;;
249;; then all files matching "Summary" are moved to the end of the
250;; list. (I find this handy for keeping the INBOX Summary and so on
251;; out of the way.) It also moves files matching "output\*$" to the
90a02640 252;; end of the list (these are created by AUCTeX when compiling.)
789d1bf0
KS
253;; Other functions could be made available which alter the list of
254;; matching files (either deleting or rearranging elements.)
255
256;; Highlighting
257;; ------------
258
259;; The highlighting of matching items is controlled via ido-use-faces.
ccba8bb6
KS
260;; The faces used are ido-first-match, ido-only-match and
261;; ido-subdir.
789d1bf0
KS
262;; Colouring of the matching item was suggested by
263;; Carsten Dominik (dominik@strw.leidenuniv.nl).
264
265;; Replacement for read-buffer and read-file-name
266;; ----------------------------------------------
267
268;; ido-read-buffer and ido-read-file-name have been written to be drop
269;; in replacements for the normal buffer and file name reading
270;; functions `read-buffer' and `read-file-name'.
271
272;; To use ido for all buffer and file selections in Emacs, customize the
273;; variable `ido-everywhere'.
274
275;; Using ido-like behaviour in other lisp packages
276;; -----------------------------------------------
277
278;; If you don't want to rely on the `ido-everywhere' functionality,
279;; ido-read-buffer, ido-read-file-name, and ido-read-directory-name
280;; can be used by other packages to read a buffer name, a file name,
281;; or a directory name in the `ido' way.
282
04c95147
KS
283;;; Acknowledgements
284
285;; Infinite amounts of gratitude goes to Stephen Eglen <stephen@cns.ed.ac.uk>
286;; who wrote iswitch-buffer mode - from which I ripped off 99% of the code
287;; for ido-switch-buffer and found the inspiration for ido-find-file.
288;; The ido package would never have existed without his work.
289
290;; Also thanks to Klaus Berndl, Rohit Namjoshi, Robert Fenk, Alex
291;; Schroeder, Bill Benedetto, Stephen Eglen, and many others for bug
292;; fixes and improvements.
293
294;;; History
295
296;; Since I discovered Stephen Eglen's excellent iswitchb package, I just
297;; couldn't live without it, but once being addicted to switching buffers
298;; with a minimum of keystrokes, I soon found that opening files in the
299;; old-fashioned way was just too slow - so I decided to write a package
300;; which could open files with the same speed and ease as iswitchb could
301;; switch buffers.
302
303;; I originally wrote a separate ifindf.el package based on a copy of
304;; iswitchb.el, which did for opening files what iswitchb did for
305;; switching buffers. Along the way, I corrected a few errors in
306;; ifindf which could have found its way back into iswitchb, but since
307;; most of the functionality of the two package was practically
308;; identical, I decided that the proper thing to do was to merge my
309;; ifindf package back into iswitchb.
310;;
311;; This is basically what ido (interactively do) is all about; but I
312;; found it ackward to merge my changes into the "iswitchb-" namespace,
313;; so I invented a common "ido-" namespace for the merged packages.
314;;
315;; This version is based on ido.el version 1.57 released on
316;; gnu.emacs.sources adapted for emacs 22.1 to use command remapping
317;; and optionally hooking the read-buffer and read-file-name functions.
318;;
319;; Prefix matching was added by Klaus Berndl <klaus.berndl@sdm.de> based on
320;; an idea of Yuji Minejima <ggb01164@nifty.ne.jp> and his mcomplete-package.
321
789d1bf0
KS
322
323;;; Code:
324
325(provide 'ido)
326
b2ddf2d2
JB
327(defvar cua-inhibit-cua-keys)
328
789d1bf0
KS
329;;; User Variables
330;;
331;; These are some things you might want to change.
332
333(defun ido-fractionp (n)
334 (and (numberp n) (> n 0.0) (<= n 1.0)))
335
336(defgroup ido nil
337 "Switch between files using substrings."
338 :group 'extensions
339 :group 'convenience
bf247b6e 340 :version "22.1"
789d1bf0
KS
341 :link '(emacs-commentary-link :tag "Commentary" "ido.el")
342 :link '(emacs-library-link :tag "Lisp File" "ido.el"))
343
344;;;###autoload
345(defcustom ido-mode nil
346 "Determines for which functional group \(buffer and files) ido behavior
616e8e5f 347should be enabled. The following values are possible:
337d2b66 348- `buffer': Turn only on ido buffer behavior \(switching, killing,
71296446 349 displaying...)
337d2b66
RS
350- `file': Turn only on ido file behavior \(finding, writing, inserting...)
351- `both': Turn on ido buffer and file behavior.
352- `nil': Turn off any ido switching.
789d1bf0
KS
353
354Setting this variable directly does not take effect;
355use either \\[customize] or the function `ido-mode'."
356 :set #'(lambda (symbol value)
357 (ido-mode value))
64fb500a 358 :initialize 'custom-initialize-set
789d1bf0
KS
359 :require 'ido
360 :link '(emacs-commentary-link "ido.el")
1b00bc64 361 :set-after '(ido-save-directory-list-file
b97f1994 362 ;; This will clear ido-unc-hosts-cache, so set it
1b00bc64 363 ;; before loading history file.
b97f1994 364 ido-unc-hosts)
71296446 365 :type '(choice (const :tag "Turn on only buffer" buffer)
789d1bf0
KS
366 (const :tag "Turn on only file" file)
367 (const :tag "Turn on both buffer and file" both)
368 (const :tag "Switch off all" nil))
369 :group 'ido)
370
371(defcustom ido-everywhere nil
372 "Use ido everywhere for reading file names and directories.
373Setting this variable directly does not work. Use `customize' or
374call the function `ido-everywhere'."
375 :set #'(lambda (symbol value)
9d144e95 376 (ido-everywhere (if value 1 -1)))
789d1bf0
KS
377 :initialize 'custom-initialize-default
378 :type 'boolean
379 :group 'ido)
380
381(defcustom ido-case-fold case-fold-search
382 "*Non-nil if searching of buffer and file names should ignore case."
383 :type 'boolean
384 :group 'ido)
385
386(defcustom ido-ignore-buffers
387 '("\\` ")
388 "*List of regexps or functions matching buffer names to ignore.
389For example, traditional behavior is not to list buffers whose names begin
390with a space, for which the regexp is `\\` '. See the source file for
391example functions that filter buffernames."
392 :type '(repeat (choice regexp function))
393 :group 'ido)
394
395(defcustom ido-ignore-files
396 '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
397 "*List of regexps or functions matching file names to ignore.
398For example, traditional behavior is not to list files whose names begin
399with a #, for which the regexp is `\\`#'. See the source file for
400example functions that filter filenames."
401 :type '(repeat (choice regexp function))
402 :group 'ido)
403
404(defcustom ido-ignore-extensions t
a09e21bf 405 "*Non-nil means ignore files in `completion-ignored-extensions' list."
789d1bf0
KS
406 :type 'boolean
407 :group 'ido)
408
409(defcustom ido-show-dot-for-dired nil
410 "*Non-nil means to always put . as the first item in file name lists.
a09e21bf 411This allows the current directory to be opened immediately with `dired'."
789d1bf0
KS
412 :type 'boolean
413 :group 'ido)
414
1de0ae85
KS
415(defcustom ido-file-extensions-order nil
416 "*List of file extensions specifying preferred order of file selections.
417Each element is either a string with `.' as the first char, an empty
418string matching files without extension, or t which is the default order
616e8e5f 419for files with an unlisted file extension."
1de0ae85
KS
420 :type '(repeat (choice string
421 (const :tag "Default order" t)))
422 :group 'ido)
423
789d1bf0
KS
424(defcustom ido-ignore-directories
425 '("\\`CVS/" "\\`\\.\\./" "\\`\\./")
426 "*List of regexps or functions matching sub-directory names to ignore."
427 :type '(repeat (choice regexp function))
428 :group 'ido)
429
430(defcustom ido-ignore-directories-merge nil
362cdb61
KS
431 "*List of regexps or functions matching directory names to ignore during merge.
432Directory names matched by one of the regexps in this list are not inserted
789d1bf0
KS
433in merged file and directory lists."
434 :type '(repeat (choice regexp function))
435 :group 'ido)
436
3da360a7
SM
437;; Examples for setting the value of ido-ignore-buffers
438;;(defun ido-ignore-c-mode (name)
439;; "Ignore all c mode buffers -- example function for ido."
440;; (with-current-buffer name
441;; (derived-mode-p 'c-mode)))
442;;
443;;(setq ido-ignore-buffers '("^ " ido-ignore-c-mode))
789d1bf0 444
3da360a7
SM
445;; Examples for setting the value of ido-ignore-files
446;;(setq ido-ignore-files '("^ " "\\.c\\'" "\\.h\\'"))
789d1bf0 447
a11ad595 448(defcustom ido-default-file-method 'raise-frame
edcc53d1 449 "*How to visit a new file when using `ido-find-file'.
789d1bf0 450Possible values:
a11ad595
KS
451`selected-window' Show new file in selected window
452`other-window' Show new file in another window (same frame)
453`display' Display file in another window without selecting to it
454`other-frame' Show new file in another frame
455`maybe-frame' If a file is visible in another frame, prompt to ask if you
456 you want to see the file in the same window of the current
457 frame or in the other frame
458`raise-frame' If a file is visible in another frame, raise that
459 frame; otherwise, visit the file in the same window"
460 :type '(choice (const :tag "Visit in selected window" selected-window)
461 (const :tag "Visit in other window" other-window)
462 (const :tag "Display (no select) in other window" display)
463 (const :tag "Visit in other frame" other-frame)
464 (const :tag "Ask to visit in other frame" maybe-frame)
465 (const :tag "Raise frame if already visited" raise-frame))
789d1bf0
KS
466 :group 'ido)
467
a11ad595 468(defcustom ido-default-buffer-method 'raise-frame
edcc53d1 469 "*How to switch to new buffer when using `ido-switch-buffer'.
616e8e5f 470See `ido-default-file-method' for details."
a11ad595
KS
471 :type '(choice (const :tag "Show in selected window" selected-window)
472 (const :tag "Show in other window" other-window)
473 (const :tag "Display (no select) in other window" display)
474 (const :tag "Show in other frame" other-frame)
475 (const :tag "Ask to show in other frame" maybe-frame)
476 (const :tag "Raise frame if already shown" raise-frame))
477 :type '(choice (const selected-window)
478 (const other-window)
789d1bf0 479 (const display)
a11ad595 480 (const other-frame)
789d1bf0 481 (const maybe-frame)
a11ad595 482 (const raise-frame))
789d1bf0
KS
483 :group 'ido)
484
485(defcustom ido-enable-flex-matching nil
486 "*Non-nil means that `ido' will do flexible string matching.
487Flexible matching means that if the entered string does not
488match any item, any item containing the entered characters
489in the given sequence will match."
490 :type 'boolean
491 :group 'ido)
492
493
494(defcustom ido-enable-regexp nil
495 "*Non-nil means that `ido' will do regexp matching.
496Value can be toggled within `ido' using `ido-toggle-regexp'."
497 :type 'boolean
498 :group 'ido)
499
500(defcustom ido-enable-prefix nil
6d8b6cbd
KS
501 "*Non-nil means only match if the entered text is a prefix of file name.
502This behavior is like the standard emacs-completion.
29660eb7 503If nil, match if the entered text is an arbitrary substring.
789d1bf0
KS
504Value can be toggled within `ido' using `ido-toggle-prefix'."
505 :type 'boolean
506 :group 'ido)
507
6d8b6cbd
KS
508(defcustom ido-enable-dot-prefix nil
509 "*Non-nil means to match leading dot as prefix.
510I.e. hidden files and buffers will match only if you type a dot
511as first char even if `ido-enable-prefix' is nil."
512 :type 'boolean
513 :group 'ido)
514
d81aa76a
KS
515(defcustom ido-confirm-unique-completion nil
516 "*Non-nil means that even a unique completion must be confirmed.
517This means that \\[ido-complete] must always be followed by \\[ido-exit-minibuffer]
518even when there is only one unique completion."
519 :type 'boolean
520 :group 'ido)
521
d1a0acac
KS
522(defcustom ido-cannot-complete-command 'ido-completion-help
523 "*Command run when `ido-complete' can't complete any more.
524The most useful values are `ido-completion-help', which pops up a
525window with completion alternatives, or `ido-next-match' or
526`ido-prev-match', which cycle the buffer list."
527 :type 'function
528 :group 'ido)
529
530
789d1bf0
KS
531(defcustom ido-record-commands t
532 "*Non-nil means that `ido' will record commands in command history.
533Note that the non-ido equivalent command is recorded."
534 :type 'boolean
535 :group 'ido)
536
537(defcustom ido-max-prospects 12
538 "*Non-zero means that the prospect list will be limited to than number of items.
539For a long list of prospects, building the full list for the minibuffer can take a
616e8e5f 540non-negligible amount of time; setting this variable reduces that time."
789d1bf0
KS
541 :type 'integer
542 :group 'ido)
543
a42e9704 544(defcustom ido-max-file-prompt-width 0.35
789d1bf0
KS
545 "*Non-zero means that the prompt string be limited to than number of characters.
546If value is a floating point number, it specifies a fraction of the frame width."
547 :type '(choice
548 (integer :tag "Characters" :value 20)
549 (restricted-sexp :tag "Fraction of frame width"
550 :value 0.35
551 :match-alternatives (ido-fractionp)))
552 :group 'ido)
553
554(defcustom ido-max-window-height nil
555 "*Non-nil specifies a value to override `max-mini-window-height'."
556 :type '(choice
557 (const :tag "Don't override" nil)
558 (integer :tag "Number of lines" :value 1)
559 (restricted-sexp
560 :tag "Fraction of window height"
561 :value 0.25
562 :match-alternatives (ido-fractionp)))
563 :group 'ido)
564
565(defcustom ido-enable-last-directory-history t
362cdb61 566 "*Non-nil means that `ido' will remember latest selected directory names.
789d1bf0
KS
567See `ido-last-directory-list' and `ido-save-directory-list-file'."
568 :type 'boolean
569 :group 'ido)
570
571(defcustom ido-max-work-directory-list 50
572 "*Maximum number of working directories to record.
573This is the list of directories where files have most recently been opened.
574See `ido-work-directory-list' and `ido-save-directory-list-file'."
575 :type 'integer
576 :group 'ido)
577
578(defcustom ido-work-directory-list-ignore-regexps nil
579 "*List of regexps matching directories which should not be recorded.
362cdb61 580Directory names matched by one of the regexps in this list are not inserted in
789d1bf0
KS
581the `ido-work-directory-list' list."
582 :type '(repeat regexp)
583 :group 'ido)
584
bad111c2 585
310682e6
KS
586(defcustom ido-use-filename-at-point nil
587 "*Non-nil means that ido shall look for a filename at point.
3c88bdc5 588May use `ffap-guesser' to guess whether text at point is a filename.
310682e6 589If found, use that as the starting point for filename selection."
3c88bdc5
KS
590 :type '(choice
591 (const :tag "Disabled" nil)
592 (const :tag "Guess filename" guess)
593 (other :tag "Use literal filename" t))
310682e6
KS
594 :group 'ido)
595
596
597(defcustom ido-use-url-at-point nil
598 "*Non-nil means that ido shall look for a URL at point.
599If found, call `find-file-at-point' to visit it."
600 :type 'boolean
601 :group 'ido)
602
603
bad111c2
KS
604(defcustom ido-enable-tramp-completion t
605 "*Non-nil means that ido shall perform tramp method and server name completion.
362cdb61 606A tramp file name uses the following syntax: /method:user@host:filename."
bad111c2
KS
607 :type 'boolean
608 :group 'ido)
609
789d1bf0 610(defcustom ido-record-ftp-work-directories t
337d2b66 611 "*Non-nil means record ftp file names in the work directory list."
789d1bf0
KS
612 :type 'boolean
613 :group 'ido)
614
615(defcustom ido-merge-ftp-work-directories nil
337d2b66 616 "*If nil means merging ignores ftp file names in the work directory list."
789d1bf0
KS
617 :type 'boolean
618 :group 'ido)
619
620(defcustom ido-cache-ftp-work-directory-time 1.0
621 "*Maximum time to cache contents of an ftp directory (in hours).
dfebc0ae 622Use C-l in prompt to refresh list.
789d1bf0
KS
623If zero, ftp directories are not cached."
624 :type 'number
625 :group 'ido)
626
627(defcustom ido-slow-ftp-hosts nil
628 "*List of slow ftp hosts where ido prompting should not be used.
629If an ftp host is on this list, ido automatically switches to the non-ido
616e8e5f 630equivalent function, e.g. `find-file' rather than `ido-find-file'."
789d1bf0
KS
631 :type '(repeat string)
632 :group 'ido)
633
634(defcustom ido-slow-ftp-host-regexps nil
635 "*List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
636 :type '(repeat regexp)
637 :group 'ido)
638
4c2ee078 639(defvar ido-unc-hosts-cache t
d36995c6 640 "Cached value from `ido-unc-hosts' function.")
4c2ee078 641
dfebc0ae 642(defcustom ido-unc-hosts nil
4c2ee078
KS
643 "*List of known UNC host names to complete after initial //.
644If value is a function, that function is called to search network for
645hosts on first use of UNC path."
646 :type '(choice (repeat :tag "List of UNC host names" string)
647 (function-item :tag "Use `NET VIEW'"
648 :value ido-unc-hosts-net-view)
649 (function :tag "Your own function"))
650 :set #'(lambda (symbol value)
651 (set symbol value)
652 (setq ido-unc-hosts-cache t))
653 :group 'ido)
654
b97f1994
KS
655(defcustom ido-downcase-unc-hosts t
656 "*Non-nil if UNC host names should be downcased."
657 :type 'boolean
658 :group 'ido)
659
4c2ee078 660(defcustom ido-ignore-unc-host-regexps nil
b97f1994
KS
661 "*List of regexps matching UNC hosts to ignore.
662Case is ignored if `ido-downcase-unc-hosts' is set."
4c2ee078 663 :type '(repeat regexp)
dfebc0ae
KS
664 :group 'ido)
665
666(defcustom ido-cache-unc-host-shares-time 8.0
667 "*Maximum time to cache shares of an UNC host (in hours).
668Use C-l in prompt to refresh list.
3903655d 669If zero, UNC host shares are not cached."
dfebc0ae
KS
670 :type 'number
671 :group 'ido)
672
789d1bf0
KS
673(defcustom ido-max-work-file-list 10
674 "*Maximum number of names of recently opened files to record.
675This is the list the file names (sans directory) which have most recently
3903655d 676been opened. See `ido-work-file-list' and `ido-save-directory-list-file'."
789d1bf0
KS
677 :type 'integer
678 :group 'ido)
679
680(defcustom ido-work-directory-match-only t
681 "*Non-nil means to skip non-matching directories in the directory history.
682When some text is already entered at the `ido-find-file' prompt, using
683\\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories
684without any matching entries."
685 :type 'boolean
686 :group 'ido)
687
688(defcustom ido-auto-merge-work-directories-length 0
689 "*Automatically switch to merged work directories during file name input.
690The value is number of characters to type before switching to merged mode.
691If zero, the switch happens when no matches are found in the current directory.
692Automatic merging is disabled if the value is negative."
693 :type 'integer
694 :group 'ido)
695
696(defcustom ido-auto-merge-delay-time 0.70
697 "*Delay in seconds to wait for more input before doing auto merge."
698 :type 'number
699 :group 'ido)
700
701(defcustom ido-auto-merge-inhibit-characters-regexp "[][*?~]"
702 "*Regexp matching characters which should inhibit automatic merging.
703When a (partial) file name matches this regexp, merging is inhibited."
704 :type 'regexp
705 :group 'ido)
706
707(defcustom ido-merged-indicator "^"
708 "The string appended to first choice if it has multiple directory choices."
709 :type 'string
710 :group 'ido)
711
712(defcustom ido-max-dir-file-cache 100
713 "*Maximum number of working directories to be cached.
a09e21bf 714This is the size of the cache of `file-name-all-completions' results.
789d1bf0
KS
715Each cache entry is time stamped with the modification time of the
716directory. Some systems, like Windows, have unreliable directory
717modification times, so you may choose to disable caching on such
718systems, or explicitly refresh the cache contents using the command
719`ido-reread-directory' command (C-l) in the minibuffer.
720See also `ido-dir-file-cache' and `ido-save-directory-list-file'."
721 :type 'integer
722 :group 'ido)
723
cb65c373
KS
724(defcustom ido-max-directory-size 30000
725 "*Maximum size (in bytes) for directories to use ido completion.
726If you enter a directory with a size larger than this size, ido will
727not provide the normal completion. To show the completions, use C-a."
728 :type '(choice (const :tag "No limit" nil)
729 (integer :tag "Size in bytes" 30000))
730 :group 'ido)
731
789d1bf0
KS
732(defcustom ido-rotate-file-list-default nil
733 "*Non-nil means that `ido' will always rotate file list to get default in front."
734 :type 'boolean
735 :group 'ido)
736
5702da69
KS
737(defcustom ido-enter-matching-directory 'only
738 "*Additional methods to enter sub-directory of first/only matching item.
739If value is 'first, enter first matching sub-directory when typing a slash.
740If value is 'only, typing a slash only enters the sub-directory if it is
741the only matching item.
742If value is t, automatically enter a sub-directory when it is the only
743matching item, even without typing a slash."
71296446 744 :type '(choice (const :tag "Never" nil)
5702da69
KS
745 (const :tag "Slash enters first directory" first)
746 (const :tag "Slash enters first and only directory" only)
747 (other :tag "Always enter unique directory" t))
789d1bf0
KS
748 :group 'ido)
749
789d1bf0
KS
750(defcustom ido-create-new-buffer 'prompt
751 "*Specify whether a new buffer is created if no buffer matches substring.
752Choices are 'always to create new buffers unconditionally, 'prompt to
753ask user whether to create buffer, or 'never to never create new buffer."
71296446 754 :type '(choice (const always)
789d1bf0
KS
755 (const prompt)
756 (const never))
757 :group 'ido)
758
3729cc87 759(defcustom ido-setup-hook nil
616e8e5f 760 "*Hook run after the ido variables and keymap have been setup.
3729cc87
KS
761The dynamic variable `ido-cur-item' contains the current type of item that
762is read by ido, possible values are file, dir, buffer, and list.
facf67fd 763Additional keys can be defined in `ido-completion-map'."
789d1bf0
KS
764 :type 'hook
765 :group 'ido)
766
767(defcustom ido-separator nil
768 "*String used by ido to separate the alternatives in the minibuffer.
769Obsolete. Set 3rd element of `ido-decorations' instead."
610a4f64 770 :type '(choice string (const nil))
789d1bf0
KS
771 :group 'ido)
772
cb65c373 773(defcustom ido-decorations '( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]" " [Not readable]" " [Too big]")
789d1bf0 774 "*List of strings used by ido to display the alternatives in the minibuffer.
cb65c373 775There are 10 elements in this list:
789d1bf0 7761st and 2nd elements are used as brackets around the prospect list,
a09e21bf 7773rd element is the separator between prospects (ignored if `ido-separator' is set),
789d1bf0
KS
7784th element is the string inserted at the end of a truncated list of prospects,
7795th and 6th elements are used as brackets around the common match string which
780can be completed using TAB,
616e8e5f
JB
7817th element is the string displayed when there are no matches, and
7828th element is displayed if there is a single match (and faces are not used),
7839th element is displayed when the current directory is non-readable,
cb65c373 78410th element is displayed when directory exceeds `ido-max-directory-size'."
789d1bf0
KS
785 :type '(repeat string)
786 :group 'ido)
787
788(defcustom ido-use-faces t
789 "*Non-nil means use ido faces to highlighting first match, only match and
790subdirs in the alternatives."
791 :type 'boolean
792 :group 'ido)
793
ccba8bb6 794(defface ido-first-match '((t (:bold t)))
a09e21bf 795 "*Face used by ido for highlighting first match."
789d1bf0
KS
796 :group 'ido)
797
ccba8bb6 798(defface ido-only-match '((((class color))
789d1bf0
KS
799 (:foreground "ForestGreen"))
800 (t (:italic t)))
a09e21bf 801 "*Face used by ido for highlighting only match."
789d1bf0
KS
802 :group 'ido)
803
ccba8bb6 804(defface ido-subdir '((((min-colors 88) (class color))
ea81d57e
DN
805 (:foreground "red1"))
806 (((class color))
789d1bf0
KS
807 (:foreground "red"))
808 (t (:underline t)))
a09e21bf 809 "*Face used by ido for highlighting subdirs in the alternatives."
789d1bf0
KS
810 :group 'ido)
811
ccba8bb6 812(defface ido-indicator '((((min-colors 88) (class color))
ea81d57e
DN
813 (:foreground "yellow1"
814 :background "red1"
815 :width condensed))
816 (((class color))
789d1bf0
KS
817 (:foreground "yellow"
818 :background "red"
819 :width condensed))
820 (t (:inverse-video t)))
a09e21bf 821 "*Face used by ido for highlighting its indicators."
789d1bf0
KS
822 :group 'ido)
823
665ed61a
KS
824(defface ido-incomplete-regexp
825 '((t
826 (:inherit font-lock-warning-face)))
827 "Ido face for indicating incomplete regexps."
828 :group 'ido)
829
789d1bf0
KS
830(defcustom ido-make-file-list-hook nil
831 "*List of functions to run when the list of matching files is created.
832Each function on the list may modify the dynamically bound variable
833`ido-temp-list' which contains the current list of matching files."
834 :type 'hook
835 :group 'ido)
836
837(defcustom ido-make-dir-list-hook nil
838 "*List of functions to run when the list of matching directories is created.
839Each function on the list may modify the dynamically bound variable
840`ido-temp-list' which contains the current list of matching directories."
841 :type 'hook
842 :group 'ido)
843
844(defcustom ido-make-buffer-list-hook nil
845 "*List of functions to run when the list of matching buffers is created.
846Each function on the list may modify the dynamically bound variable
847`ido-temp-list' which contains the current list of matching buffer names."
848 :type 'hook
849 :group 'ido)
850
362cdb61 851(defcustom ido-rewrite-file-prompt-functions nil
789d1bf0
KS
852 "*List of functions to run when the find-file prompt is created.
853Each function on the list may modify the following dynamically bound
854variables:
337d2b66
RS
855 dirname - the (abbreviated) directory name
856 to be modified by the hook functions
857 max-width - the max width of the resulting dirname; nil means no limit
858 prompt - the basic prompt (e.g. \"Find File: \")
859 literal - the string shown if doing \"literal\" find; set to nil to omit
860 vc-off - the string shown if version control is inhibited; set to nit to omit
861 prefix - either nil or a fixed prefix for the dirname
862
789d1bf0 863The following variables are available, but should not be changed:
a09e21bf 864 `ido-current-directory' - the unabbreviated directory name
337d2b66 865 item - equals `file' or `dir' depending on the current mode."
789d1bf0
KS
866 :type 'hook
867 :group 'ido)
868
362cdb61
KS
869(defvar ido-rewrite-file-prompt-rules nil
870 "*Alist of rewriting rules for directory names in ido prompts.
871A list of elements of the form (FROM . TO) or (FROM . FUNC), each
872meaning to rewrite the directory name if matched by FROM by either
873substituting the matched string by TO or calling the function FUNC
874with the current directory name as its only argument and using the
875return value as the new directory name. In addition, each FUNC may
876also modify the dynamic variables described for the variable
877`ido-rewrite-file-prompt-functions'.")
789d1bf0
KS
878
879(defcustom ido-completion-buffer "*Ido Completions*"
880 "*Name of completion buffer used by ido.
881Set to nil to disable completion buffers popping up."
882 :type 'string
883 :group 'ido)
884
885(defcustom ido-completion-buffer-all-completions nil
886 "*Non-nil means to show all completions in completion buffer.
887Otherwise, only the current list of matches is shown."
888 :type 'boolean
889 :group 'ido)
890
891(defvar ido-all-frames 'visible
892 "*Argument to pass to `walk-windows' when finding visible files.
893See documentation of `walk-windows' for useful values.")
894
895(defcustom ido-minibuffer-setup-hook nil
896 "*Ido-specific customization of minibuffer setup.
897
4837b516 898This hook is run during minibuffer setup if `ido' is active.
789d1bf0
KS
899It is intended for use in customizing ido for interoperation
900with other packages. For instance:
901
71296446 902 \(add-hook 'ido-minibuffer-setup-hook
789d1bf0
KS
903 \(function
904 \(lambda ()
319a586a
JB
905 \(make-local-variable 'max-mini-window-height)
906 \(setq max-mini-window-height 3))))
789d1bf0 907
319a586a 908will constrain Emacs to a maximum minibuffer height of 3 lines when
789d1bf0
KS
909ido is running. Copied from `icomplete-minibuffer-setup-hook'."
910 :type 'hook
911 :group 'ido)
912
913(defcustom ido-save-directory-list-file "~/.ido.last"
914 "File in which the ido state is saved between invocations.
915Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
916`ido-work-file-list', and `ido-dir-file-cache'.
917Must be set before enabling ido mode."
918 :type 'string
919 :group 'ido)
920
921(defcustom ido-read-file-name-as-directory-commands '()
a2cf0212 922 "List of commands which uses `read-file-name' to read a directory name.
789d1bf0 923When `ido-everywhere' is non-nil, the commands in this list will read
616e8e5f 924the directory using `ido-read-directory-name'."
789d1bf0
KS
925 :type '(repeat symbol)
926 :group 'ido)
927
928(defcustom ido-read-file-name-non-ido '()
929 "List of commands which shall not read file names the ido way.
930When `ido-everywhere' is non-nil, the commands in this list will read
616e8e5f 931the file name using normal `read-file-name' style."
789d1bf0
KS
932 :type '(repeat symbol)
933 :group 'ido)
934
b2d4c118
KS
935(defcustom ido-before-fallback-functions '()
936 "List of functions to call before calling a fallback command.
937The fallback command is passed as an argument to the functions."
938 :type 'hook
939 :group 'ido)
940
789d1bf0
KS
941;;; Internal Variables
942
943;; Persistent variables
944
facf67fd 945(defvar ido-completion-map nil
973495ca
KS
946 "Currently active keymap for ido commands.")
947
facf67fd 948(defvar ido-common-completion-map nil
973495ca
KS
949 "Keymap for all ido commands.")
950
facf67fd 951(defvar ido-file-completion-map nil
973495ca
KS
952 "Keymap for ido file commands.")
953
facf67fd 954(defvar ido-file-dir-completion-map nil
973495ca
KS
955 "Keymap for ido file and directory commands.")
956
facf67fd 957(defvar ido-buffer-completion-map nil
973495ca 958 "Keymap for ido buffer commands.")
789d1bf0
KS
959
960(defvar ido-file-history nil
961 "History of files selected using `ido-find-file'.")
962
963(defvar ido-buffer-history nil
964 "History of buffers selected using `ido-switch-buffer'.")
965
789d1bf0 966(defvar ido-last-directory-list nil
362cdb61 967 "List of last selected directory names.
789d1bf0
KS
968See `ido-enable-last-directory-history' for details.")
969
970(defvar ido-work-directory-list nil
362cdb61 971 "List of actual working directory names.
789d1bf0 972The current directory is inserted at the front of this list whenever a
616e8e5f 973file is opened with `ido-find-file' and family.")
789d1bf0
KS
974
975(defvar ido-work-file-list nil
976 "List of actual work file names.
337d2b66
RS
977Opening a file with `ido-find-file' and similar functions
978inserts the current file name (relative to its containing directory)
979at the front of this list.")
789d1bf0
KS
980
981(defvar ido-dir-file-cache nil
337d2b66
RS
982 "List of `file-name-all-completions' results.
983Each element in the list is of the form (DIR (MTIME) FILE...).")
789d1bf0 984
69beb26d
KS
985(defvar ido-ignore-item-temp-list nil
986 "List of items to ignore in current ido invocation.
616e8e5f 987Intended to be let-bound by functions which call ido repeatedly.
69beb26d
KS
988Should never be set permanently.")
989
789d1bf0
KS
990;; Temporary storage
991
992(defvar ido-eoinput 1
993 "Point where minibuffer input ends and completion info begins.
994Copied from `icomplete-eoinput'.")
995(make-variable-buffer-local 'ido-eoinput)
996
997(defvar ido-common-match-string nil
998 "Stores the string that is common to all matching files.")
999
1000(defvar ido-rescan nil
1001 "Non-nil means we need to regenerate the list of matching items.")
1002
1003(defvar ido-rotate nil
1004 "Non-nil means we are rotating list of matches.")
1005
1006(defvar ido-text nil
1007 "Stores the users string as it is typed in.")
1008
1009(defvar ido-text-init nil
1010 "The initial string for the users string it is typed in.")
1011
3729cc87
KS
1012(defvar ido-input-stack nil
1013 "Stores the users strings when user hits M-b/M-f.")
1014
789d1bf0
KS
1015(defvar ido-matches nil
1016 "List of files currently matching `ido-text'.")
1017
1018(defvar ido-report-no-match t
a2cf0212 1019 "Report [No Match] when no completions matches `ido-text'.")
789d1bf0 1020
71296446
JB
1021(defvar ido-exit nil
1022 "Flag to monitor how `ido-find-file' exits.
789d1bf0
KS
1023If equal to `takeprompt', we use the prompt as the file name to be
1024selected.")
1025
1026(defvar ido-current-directory nil
616e8e5f 1027 "Current directory for `ido-find-file'.")
789d1bf0
KS
1028
1029(defvar ido-auto-merge-timer nil
1030 "Delay timer for auto merge.")
1031
1032(defvar ido-use-mycompletion-depth 0
71296446 1033 "Non-nil means use `ido' completion feedback.
a09e21bf
JB
1034Is set by ido functions to the current `minibuffer-depth',
1035so that it doesn't interfere with other minibuffer usage.")
789d1bf0 1036
665ed61a
KS
1037(defvar ido-incomplete-regexp nil
1038 "Non-nil if an incomplete regexp is entered.")
789d1bf0 1039
155943b9
KS
1040(defvar ido-initial-position nil
1041 "Non-nil means to explicitly cursor on entry to minibuffer.
1042Value is an integer which is number of chars to right of prompt.")
1043
789d1bf0
KS
1044;;; Variables with dynamic bindings.
1045;;; Declared here to keep the byte compiler quiet.
1046
db9f395b 1047;; Stores the current ido item type ('file, 'dir, 'buffer, or 'list).
789d1bf0
KS
1048(defvar ido-cur-item)
1049
3d37467b
KS
1050;;; Stores the current default item
1051(defvar ido-default-item)
1052
789d1bf0
KS
1053;; Stores the current list of items that will be searched through.
1054;; The list is ordered, so that the most interesting item comes first,
1055;; although by default, the files visible in the current frame are put
1056;; at the end of the list. Created by `ido-make-item-list'.
1057(defvar ido-cur-list)
1058
db9f395b
KS
1059;; Stores the choice list for ido-completing-read
1060(defvar ido-choice-list)
1061
789d1bf0
KS
1062;; Stores the list of items which are ignored when building
1063;; `ido-cur-list'. It is in no specific order.
1064(defvar ido-ignored-list)
1065
a70343bd
KS
1066;; Remember if current directory is non-readable (so we cannot do completion).
1067(defvar ido-directory-nonreadable)
1068
cb65c373
KS
1069;; Remember if current directory is 'huge' (so we don't want to do completion).
1070(defvar ido-directory-too-big)
1071
789d1bf0
KS
1072;; Keep current item list if non-nil.
1073(defvar ido-keep-item-list)
1074
1075;; Process ido-ignore-* lists.
1076(defvar ido-process-ignore-lists)
1077
1078;; Don't process ido-ignore- lists once.
1079(defvar ido-process-ignore-lists-inhibit)
1080
1081;; Buffer from which ido was entered.
1082(defvar ido-entry-buffer)
1083
1084;; Non-nil if matching file must be selected.
1085(defvar ido-require-match)
1086
1087;; Stores a temporary version of the file list being created.
1088(defvar ido-temp-list)
1089
1090;; Non-nil if default list element should be rotated into place.
1091(defvar ido-rotate-temp)
1092
1093;; Stores current index in ido-work-directory-list.
1094(defvar ido-work-directory-index)
1095
1096;; Stores current index in ido-work-file-list.
1097(defvar ido-work-file-index)
1098
1099;; Set when merged work directory list is in use.
1100(defvar ido-use-merged-list)
1101
1102;; Set when merged work directory list not yet built.
1103(defvar ido-try-merged-list)
1104
1105;; Saved state prior to last work directory merge.
1106;; Value is a list (ido-text dir cur-list ignored-list matches).
1107(defvar ido-pre-merge-state)
1108
310682e6
KS
1109;; Original value of vc-handled-backends for use in ido-toggle-vc.
1110(defvar ido-saved-vc-hb)
789d1bf0
KS
1111
1112;; Stores temporary state of literal find file.
1113(defvar ido-find-literal)
1114
db9f395b
KS
1115;; Set to 'ignore to inhibit switching between find-file/switch-buffer.
1116(defvar ido-context-switch-command)
789d1bf0
KS
1117
1118;;; FUNCTIONS
1119
1120(defun ido-active (&optional merge)
1121 (if merge
1122 ido-use-merged-list
cba9a3a5
KS
1123 (and (boundp 'ido-completing-read)
1124 (or (featurep 'xemacs)
1125 (= ido-use-mycompletion-depth (minibuffer-depth))))))
789d1bf0
KS
1126
1127(defvar ido-trace-enable nil)
1128
1129(defun ido-trace (p &optional s retval)
1130 (if ido-trace-enable
1131 (let ((b (get-buffer-create " *IDO Trace*"))
1132 (deactivate-mark deactivate-mark))
1133 (save-excursion
1134 (save-restriction
1135 (set-buffer b)
1136 (insert p ": " (if (stringp s) s (format "%S" s)) "\n")))))
1137 retval)
1138
1139(defun ido-toggle-trace (arg)
1140 (interactive "P")
1141 (setq ido-trace-enable (or arg (not ido-trace-enable)))
bad111c2
KS
1142 (if ido-trace-enable
1143 (message "IDO trace on"))
789d1bf0
KS
1144 (let ((b (get-buffer " *IDO Trace*")))
1145 (if b
1146 (if ido-trace-enable
1147 (kill-buffer b)
bad111c2
KS
1148 (pop-to-buffer b t t)
1149 (setq truncate-lines t)))))
1150
10b19e88
KS
1151(defun ido-local-file-exists-p (file)
1152 "Tell if FILE exists locally."
1153 (let (file-name-handler-alist)
1154 (file-exists-p file)))
1155
4c2ee078
KS
1156(defun ido-unc-hosts (&optional query)
1157 "Return list of UNC host names."
b97f1994
KS
1158 (let ((hosts
1159 (cond
1160 ((listp ido-unc-hosts)
1161 ido-unc-hosts) ;; static list or nil
1162 ((listp ido-unc-hosts-cache)
1163 ido-unc-hosts-cache) ;; result of net search
1164 ((and query (fboundp ido-unc-hosts))
1165 (message (propertize "Searching for UNC hosts..." 'face 'highlight))
1166 (setq ido-unc-hosts-cache (funcall ido-unc-hosts))
1167 (message nil)
1168 ido-unc-hosts-cache)
1169 (query
1170 (setq ido-unc-hosts-cache nil))
1171 (t (fboundp ido-unc-hosts)))))
1172 (when query
1173 (let ((case-fold-search ido-downcase-unc-hosts)
1174 res host re-list re)
1175 (while hosts
1176 (setq host (car hosts)
1177 hosts (cdr hosts)
1178 re-list (and ido-process-ignore-lists
1179 ido-ignore-unc-host-regexps))
1180 (while re-list
1181 (setq re (car re-list)
1182 re-list (cdr re-list))
1183 (if (string-match re host)
1184 (setq re-list nil
1185 host nil)))
1186 (when host
1187 (when ido-downcase-unc-hosts
1188 (setq host (downcase host)))
1189 (setq res (cons host res))))
1190 (setq hosts (sort res #'string<))))
1191 hosts))
4c2ee078
KS
1192
1193(defun ido-unc-hosts-net-view ()
1194 "Query network for list of UNC host names using `NET VIEW'."
1195 (let (hosts)
1196 (with-temp-buffer
1197 (shell-command "net view" t)
1198 (goto-char (point-min))
1199 (while (re-search-forward "^\\\\\\\\\\([[:graph:]]+\\)" nil t)
1200 (setq hosts (cons (match-string 1) hosts))))
1201 hosts))
1202
bad111c2 1203(defun ido-is-tramp-root (&optional dir)
bad111c2 1204 (and ido-enable-tramp-completion
c577a4d2
KS
1205 (string-match "\\`/[^/]+[@:]\\'"
1206 (or dir ido-current-directory))))
789d1bf0 1207
dfebc0ae 1208(defun ido-is-unc-root (&optional dir)
4c2ee078 1209 (and (ido-unc-hosts)
dfebc0ae
KS
1210 (string-equal "//"
1211 (or dir ido-current-directory))))
1212
1213(defun ido-is-unc-host (&optional dir)
4c2ee078 1214 (and (ido-unc-hosts)
dfebc0ae
KS
1215 (string-match "\\`//[^/]+/\\'"
1216 (or dir ido-current-directory))))
1217
789d1bf0
KS
1218(defun ido-is-root-directory (&optional dir)
1219 (setq dir (or dir ido-current-directory))
bad111c2
KS
1220 (or
1221 (string-equal "/" dir)
1222 (and (memq system-type '(windows-nt ms-dos))
1223 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir))
1224 (if ido-enable-tramp-completion
1225 (ido-is-tramp-root dir)
1226 (string-match "\\`/[^:/][^:/]+:\\'" dir))))
789d1bf0
KS
1227
1228(defun ido-is-ftp-directory (&optional dir)
71296446 1229 (string-match
bad111c2
KS
1230 (if ido-enable-tramp-completion
1231 "\\`/[^/:][^/:]+:" ;; like tramp-file-name-regexp-unified, but doesn't match single drive letters
1232 "\\`/[^/:][^/:]+:/")
1233 (or dir ido-current-directory)))
789d1bf0
KS
1234
1235(defun ido-is-slow-ftp-host (&optional dir)
1236 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps)
1237 (setq dir (or dir ido-current-directory))
1238 ;; (featurep 'ange-ftp)
1239 ;; (ange-ftp-ftp-name dir)
71296446 1240 (string-match
bad111c2
KS
1241 (if ido-enable-tramp-completion
1242 "\\`/\\([^/]+[@:]\\)*\\([^@/:][^@/:]+\\):"
1243 "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/")
1244 dir)
789d1bf0
KS
1245 (let ((host (substring dir (match-beginning 2) (match-end 2))))
1246 (or (member host ido-slow-ftp-hosts)
1247 (let ((re ido-slow-ftp-host-regexps))
1248 (while (and re (not (string-match (car re) host)))
1249 (setq re (cdr re)))
1250 re)))))
1251
1252(defun ido-time-stamp (&optional time)
1253 ;; Time is a floating point number (fractions of 1 hour)
1254 (setq time (or time (current-time)))
1255 (/ (+ (* (car time) 65536.0) (car (cdr time))) 3600.0))
1256
1257(defun ido-cache-ftp-valid (&optional time)
1258 (and (numberp ido-cache-ftp-work-directory-time)
1259 (> ido-cache-ftp-work-directory-time 0)
1260 (or (not time)
1261 (< (- (ido-time-stamp) time) ido-cache-ftp-work-directory-time))))
1262
dfebc0ae
KS
1263(defun ido-cache-unc-valid (&optional time)
1264 (and (numberp ido-cache-unc-host-shares-time)
1265 (> ido-cache-unc-host-shares-time 0)
1266 (or (not time)
1267 (< (- (ido-time-stamp) time) ido-cache-unc-host-shares-time))))
1268
789d1bf0
KS
1269(defun ido-may-cache-directory (&optional dir)
1270 (setq dir (or dir ido-current-directory))
bad111c2 1271 (cond
cb65c373
KS
1272 ((ido-directory-too-big-p dir)
1273 nil)
bad111c2
KS
1274 ((and (ido-is-root-directory dir)
1275 (or ido-enable-tramp-completion
1276 (memq system-type '(windows-nt ms-dos))))
1277 nil)
dfebc0ae
KS
1278 ((ido-is-unc-host dir)
1279 (ido-cache-unc-valid))
1280 ((ido-is-ftp-directory dir)
1281 (ido-cache-ftp-valid))
1282 (t t)))
789d1bf0
KS
1283
1284(defun ido-pp (list &optional sep)
1285 (let ((print-level nil) (eval-expression-print-level nil)
1286 (print-length nil) (eval-expression-print-length nil))
1287 (insert "\n;; ----- " (symbol-name list) " -----\n(\n ")
1288 (setq list (symbol-value list))
1289 (while list
1290 (let* ((elt (car list))
1291 (s (if (consp elt) (car elt) elt)))
1292 (if (and (stringp s) (= (length s) 0))
1293 (setq s nil))
1294 (if s
1295 (prin1 elt (current-buffer)))
1296 (if (and (setq list (cdr list)) s)
1297 (insert (or sep "\n ")))))
1298 (insert "\n)\n")))
1299
1300(defun ido-save-history ()
1301 "Save ido history and cache information between sessions."
1302 (interactive)
782ea71a
KS
1303 (when (and ido-last-directory-list ido-save-directory-list-file)
1304 (let ((buf (get-buffer-create " *ido session*"))
d725608c 1305 (version-control 'never))
782ea71a
KS
1306 (unwind-protect
1307 (with-current-buffer buf
1308 (erase-buffer)
efccebb5 1309 (insert ";;; -*- coding: utf-8 -*-\n")
d725608c 1310 (setq buffer-file-coding-system 'utf-8)
782ea71a
KS
1311 (ido-pp 'ido-last-directory-list)
1312 (ido-pp 'ido-work-directory-list)
1313 (ido-pp 'ido-work-file-list)
1314 (ido-pp 'ido-dir-file-cache "\n\n ")
1b00bc64
KS
1315 (if (listp ido-unc-hosts-cache)
1316 (ido-pp 'ido-unc-hosts-cache)
1317 (insert "\n;; ----- ido-unc-hosts-cache -----\nt\n"))
efccebb5 1318 (insert "\n")
789d1bf0 1319 (write-file ido-save-directory-list-file nil))
782ea71a 1320 (kill-buffer buf)))))
789d1bf0
KS
1321
1322(defun ido-load-history (&optional arg)
1323 "Load ido history and cache information from previous session.
1324With prefix argument, reload history unconditionally."
1325 (interactive "P")
1326 (if (or arg (and ido-save-directory-list-file (not ido-last-directory-list)))
1327 (let ((file (expand-file-name ido-save-directory-list-file))
1328 buf)
1329 (when (file-readable-p file)
782ea71a
KS
1330 (setq buf (get-buffer-create " *ido session*"))
1331 (unwind-protect
1332 (with-current-buffer buf
1333 (erase-buffer)
1334 (insert-file-contents file)
1335 (condition-case nil
1336 (setq ido-last-directory-list (read (current-buffer))
1337 ido-work-directory-list (read (current-buffer))
1338 ido-work-file-list (read (current-buffer))
1b00bc64
KS
1339 ido-dir-file-cache (read (current-buffer))
1340 ido-unc-hosts-cache (read (current-buffer)))
782ea71a
KS
1341 (error nil)))
1342 (kill-buffer buf)))))
789d1bf0
KS
1343 (ido-wash-history))
1344
1345(defun ido-wash-history ()
1346 "Clean-up ido history and cache information.
1347Removes badly formatted data and ignored directories."
1348 (interactive)
1349 ;; Check format of each of our lists, discard bogus elements
1350 (setq ido-last-directory-list
1351 (and (listp ido-last-directory-list)
1352 (let ((l ido-last-directory-list) r)
1353 (while l
1354 (if (and (consp (car l))
1355 (stringp (car (car l)))
1356 (stringp (cdr (car l))))
1357 (setq r (cons (car l) r)))
1358 (setq l (cdr l)))
1359 (nreverse r))))
71296446 1360 (setq ido-work-directory-list
789d1bf0
KS
1361 (and (listp ido-work-directory-list)
1362 (let ((l ido-work-directory-list) r)
1363 (while l
1364 (if (and (stringp (car l))
1365 (or ido-record-ftp-work-directories
1366 (not (ido-is-ftp-directory (car l)))))
1367 (setq r (cons (car l) r)))
1368 (setq l (cdr l)))
1369 (nreverse r))))
71296446 1370 (setq ido-work-file-list
789d1bf0
KS
1371 (and (listp ido-work-file-list)
1372 (let ((l ido-work-file-list) r)
1373 (while l
1374 (if (stringp (car l))
1375 (setq r (cons (car l) r)))
1376 (setq l (cdr l)))
1377 (nreverse r))))
71296446 1378 (setq ido-dir-file-cache
789d1bf0
KS
1379 (and (listp ido-dir-file-cache)
1380 (let ((l ido-dir-file-cache) r)
1381 (while l
1382 (if (and (listp (car l))
1383 (> (length (car l)) 2)
1384 (let ((dir (car (car l)))
1385 (time (car (cdr (car l))))
1386 (files (cdr (cdr (car l)))))
1387 (and
1388 (stringp dir)
1389 (consp time)
dfebc0ae
KS
1390 (cond
1391 ((integerp (car time))
1392 (and (/= (car time) 0)
1393 (integerp (car (cdr time)))
1394 (/= (car (cdr time)) 0)
1395 (ido-may-cache-directory dir)))
1396 ((eq (car time) 'ftp)
1397 (and (numberp (cdr time))
789d1bf0
KS
1398 (ido-is-ftp-directory dir)
1399 (ido-cache-ftp-valid (cdr time))))
dfebc0ae
KS
1400 ((eq (car time) 'unc)
1401 (and (numberp (cdr time))
1402 (ido-is-unc-host dir)
1403 (ido-cache-unc-valid (cdr time))))
1404 (t nil))
789d1bf0
KS
1405 (let ((s files) (ok t))
1406 (while s
1407 (if (stringp (car s))
1408 (setq s (cdr s))
1409 (setq s nil ok nil)))
1410 ok))))
1411 (setq r (cons (car l) r)))
1412 (setq l (cdr l)))
1413 (nreverse r))))
1414
1415 ;; Remove ignored directories from work directory list
1416 ;; according to ido-work-directory-list-ignore-regexps
1417 (if ido-work-directory-list
1418 (let ((dirs (reverse ido-work-directory-list)))
1419 (setq ido-work-directory-list nil)
1420 (while dirs
1421 (ido-record-work-directory (car dirs))
1422 (setq dirs (cdr dirs)))))
1423 ;; Get rid of text properties
1424 (let ((l ido-last-directory-list) e)
1425 (while l
1426 (setq e (car l) l (cdr l))
1427 (set-text-properties 0 (length (car e)) nil (car e))
1428 (set-text-properties 0 (length (cdr e)) nil (cdr e))))
1429 (let ((l ido-work-directory-list) e)
1430 (while l
1431 (setq e (car l) l (cdr l))
1432 (set-text-properties 0 (length e) nil e)))
1433 (let ((l ido-work-file-list) e)
1434 (while l
1435 (setq e (car l) l (cdr l))
1436 (set-text-properties 0 (length e) nil e)))
1437 (let ((l ido-dir-file-cache) e d)
1438 (while l
1439 (setq e (car l) l (cdr l))
1440 (if (listp e)
1441 (while e
1442 (setq d (car e) e (cdr e))
1443 (if (not (consp d))
973495ca 1444 (set-text-properties 0 (length d) nil d)))))))
789d1bf0
KS
1445
1446
1447(defun ido-kill-emacs-hook ()
1448 ;; ido kill emacs hook
1449 (ido-save-history))
1450
1451(defvar ido-minor-mode-map-entry nil)
1452
1453;;;###autoload
b0df3884 1454(defun ido-mode (&optional arg)
789d1bf0
KS
1455 "Toggle ido speed-ups on or off.
1456With ARG, turn ido speed-up on if arg is positive, off otherwise.
b0df3884
KS
1457Turning on ido-mode will remap (via a minor-mode keymap) the default
1458keybindings for the `find-file' and `switch-to-buffer' families of
1459commands to the ido versions of these functions.
1460However, if ARG arg equals 'files, remap only commands for files, or
1461if it equals 'buffers, remap only commands for buffer switching.
789d1bf0
KS
1462This function also adds a hook to the minibuffer."
1463 (interactive "P")
1464 (setq ido-mode
71296446 1465 (cond
789d1bf0
KS
1466 ((null arg) (if ido-mode nil 'both))
1467 ((eq arg t) 'both)
1468 ((eq arg 'files) 'file)
1469 ((eq arg 'buffers) 'buffer)
1470 ((memq arg '(file buffer both)) arg)
1471 ((> (prefix-numeric-value arg) 0) 'both)
1472 (t nil)))
1473
1474 (ido-everywhere (if ido-everywhere 1 -1))
973495ca 1475 (when ido-mode
facf67fd 1476 (ido-init-completion-maps))
789d1bf0
KS
1477
1478 (when ido-mode
1479 (add-hook 'minibuffer-setup-hook 'ido-minibuffer-setup)
1480 (add-hook 'choose-completion-string-functions 'ido-choose-completion-string)
1481 (ido-load-history)
1482
1483 (add-hook 'kill-emacs-hook 'ido-kill-emacs-hook)
1484
facf67fd 1485 (let ((map (make-sparse-keymap)))
789d1bf0
KS
1486 (when (memq ido-mode '(file both))
1487 (define-key map [remap find-file] 'ido-find-file)
1488 (define-key map [remap find-file-read-only] 'ido-find-file-read-only)
1489 (define-key map [remap find-alternate-file] 'ido-find-alternate-file)
1490 (define-key map [remap write-file] 'ido-write-file)
1491 (define-key map [remap insert-file] 'ido-insert-file)
1492 (define-key map [remap list-directory] 'ido-list-directory)
1493 (define-key map [remap dired] 'ido-dired)
1494 (define-key map [remap find-file-other-window] 'ido-find-file-other-window)
1495 (define-key map [remap find-file-read-only-other-window] 'ido-find-file-read-only-other-window)
1496 (define-key map [remap find-file-other-frame] 'ido-find-file-other-frame)
1497 (define-key map [remap find-file-read-only-other-frame] 'ido-find-file-read-only-other-frame))
1498
1499 (when (memq ido-mode '(buffer both))
1500 (define-key map [remap switch-to-buffer] 'ido-switch-buffer)
1501 (define-key map [remap switch-to-buffer-other-window] 'ido-switch-buffer-other-window)
1502 (define-key map [remap switch-to-buffer-other-frame] 'ido-switch-buffer-other-frame)
1503 (define-key map [remap insert-buffer] 'ido-insert-buffer)
1504 (define-key map [remap kill-buffer] 'ido-kill-buffer)
facf67fd
KS
1505 (define-key map [remap display-buffer] 'ido-display-buffer))
1506
1507 (if ido-minor-mode-map-entry
1508 (setcdr ido-minor-mode-map-entry map)
1509 (setq ido-minor-mode-map-entry (cons 'ido-mode map))
1510 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry)))))
1511
789d1bf0
KS
1512
1513(defun ido-everywhere (arg)
9d144e95
KS
1514 "Toggle using ido speed-ups everywhere file and directory names are read.
1515With ARG, turn ido speed-up on if arg is positive, off otherwise."
789d1bf0
KS
1516 (interactive "P")
1517 (setq ido-everywhere (if arg
71296446 1518 (> (prefix-numeric-value arg) 0)
789d1bf0 1519 (not ido-everywhere)))
bb7216f7 1520 (when (get 'ido-everywhere 'file)
d6810a2d 1521 (setq read-file-name-function (car (get 'ido-everywhere 'file)))
bb7216f7
KS
1522 (put 'ido-everywhere 'file nil))
1523 (when (get 'ido-everywhere 'buffer)
d6810a2d 1524 (setq read-buffer-function (car (get 'ido-everywhere 'buffer)))
bb7216f7
KS
1525 (put 'ido-everywhere 'buffer nil))
1526 (when ido-everywhere
1527 (when (memq ido-mode '(both file))
d6810a2d 1528 (put 'ido-everywhere 'file (cons read-file-name-function nil))
bb7216f7
KS
1529 (setq read-file-name-function 'ido-read-file-name))
1530 (when (memq ido-mode '(both buffer))
d6810a2d 1531 (put 'ido-everywhere 'buffer (cons read-buffer-function nil))
bb7216f7 1532 (setq read-buffer-function 'ido-read-buffer))))
789d1bf0
KS
1533
1534
71296446 1535;;; IDO KEYMAP
facf67fd
KS
1536(defun ido-init-completion-maps ()
1537 "Set up the completion keymaps used by `ido'."
789d1bf0 1538
973495ca
KS
1539 ;; Common map
1540 (let ((map (make-sparse-keymap)))
789d1bf0
KS
1541 (define-key map "\C-a" 'ido-toggle-ignore)
1542 (define-key map "\C-c" 'ido-toggle-case)
1543 (define-key map "\C-e" 'ido-edit-input)
1544 (define-key map "\t" 'ido-complete)
030fa15b 1545 (define-key map " " 'ido-complete-space)
789d1bf0
KS
1546 (define-key map "\C-j" 'ido-select-text)
1547 (define-key map "\C-m" 'ido-exit-minibuffer)
1548 (define-key map "\C-p" 'ido-toggle-prefix)
1549 (define-key map "\C-r" 'ido-prev-match)
1550 (define-key map "\C-s" 'ido-next-match)
1551 (define-key map "\C-t" 'ido-toggle-regexp)
1552 (define-key map "\C-z" 'ido-undo-merge-work-directory)
bf67f27b 1553 (define-key map [(control ?\s)] 'ido-restrict-to-matches)
a3f4d4d4 1554 (define-key map [(meta ?\s)] 'ido-take-first-match)
08bfde76 1555 (define-key map [(control ?@)] 'ido-restrict-to-matches)
789d1bf0
KS
1556 (define-key map [right] 'ido-next-match)
1557 (define-key map [left] 'ido-prev-match)
1558 (define-key map "?" 'ido-completion-help)
ae9d279d
KS
1559 ;; Magic commands.
1560 (define-key map "\C-b" 'ido-magic-backward-char)
1561 (define-key map "\C-f" 'ido-magic-forward-char)
1562 (define-key map "\C-d" 'ido-magic-delete-char)
973495ca 1563 (set-keymap-parent map minibuffer-local-map)
facf67fd 1564 (setq ido-common-completion-map map))
973495ca
KS
1565
1566 ;; File and directory map
1567 (let ((map (make-sparse-keymap)))
1568 (define-key map "\C-x\C-b" 'ido-enter-switch-buffer)
1569 (define-key map "\C-x\C-f" 'ido-fallback-command)
1570 (define-key map "\C-x\C-d" 'ido-enter-dired)
1571 (define-key map [down] 'ido-next-match-dir)
1572 (define-key map [up] 'ido-prev-match-dir)
1573 (define-key map [(meta up)] 'ido-prev-work-directory)
1574 (define-key map [(meta down)] 'ido-next-work-directory)
1575 (define-key map [backspace] 'ido-delete-backward-updir)
1576 (define-key map "\d" 'ido-delete-backward-updir)
87498551 1577 (define-key map [remap delete-backward-char] 'ido-delete-backward-updir) ; BS
542b315f
KS
1578 (define-key map [remap backward-kill-word] 'ido-delete-backward-word-updir) ; M-DEL
1579
973495ca
KS
1580 (define-key map [(control backspace)] 'ido-up-directory)
1581 (define-key map "\C-l" 'ido-reread-directory)
1582 (define-key map [(meta ?d)] 'ido-wide-find-dir-or-delete-dir)
1583 (define-key map [(meta ?b)] 'ido-push-dir)
a3f4d4d4 1584 (define-key map [(meta ?v)] 'ido-push-dir-first)
973495ca
KS
1585 (define-key map [(meta ?f)] 'ido-wide-find-file-or-pop-dir)
1586 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1587 (define-key map [(meta ?m)] 'ido-make-directory)
1588 (define-key map [(meta ?n)] 'ido-next-work-directory)
1589 (define-key map [(meta ?o)] 'ido-prev-work-file)
1590 (define-key map [(meta control ?o)] 'ido-next-work-file)
1591 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1592 (define-key map [(meta ?s)] 'ido-merge-work-directories)
facf67fd
KS
1593 (set-keymap-parent map ido-common-completion-map)
1594 (setq ido-file-dir-completion-map map))
973495ca
KS
1595
1596 ;; File only map
1597 (let ((map (make-sparse-keymap)))
1598 (define-key map "\C-k" 'ido-delete-file-at-head)
1599 (define-key map "\C-o" 'ido-copy-current-word)
1600 (define-key map "\C-w" 'ido-copy-current-file-name)
1601 (define-key map [(meta ?l)] 'ido-toggle-literal)
1602 (define-key map "\C-v" 'ido-toggle-vc)
facf67fd
KS
1603 (set-keymap-parent map ido-file-dir-completion-map)
1604 (setq ido-file-completion-map map))
973495ca
KS
1605
1606 ;; Buffer map
1607 (let ((map (make-sparse-keymap)))
1608 (define-key map "\C-x\C-f" 'ido-enter-find-file)
1609 (define-key map "\C-x\C-b" 'ido-fallback-command)
1610 (define-key map "\C-k" 'ido-kill-buffer-at-head)
facf67fd
KS
1611 (set-keymap-parent map ido-common-completion-map)
1612 (setq ido-buffer-completion-map map)))
ae9d279d 1613
789d1bf0 1614
facf67fd 1615(defun ido-setup-completion-map ()
973495ca 1616 "Set up the keymap for `ido'."
789d1bf0 1617
973495ca
KS
1618 ;; generated every time so that it can inherit new functions.
1619 (let ((map (make-sparse-keymap))
1620 (viper-p (if (boundp 'viper-mode) viper-mode)))
789d1bf0 1621
973495ca
KS
1622 (when viper-p
1623 (define-key map [remap viper-intercept-ESC-key] 'ignore))
1624
1625 (cond
1626 ((memq ido-cur-item '(file dir))
1627 (when ido-context-switch-command
1628 (define-key map "\C-x\C-b" ido-context-switch-command)
1629 (define-key map "\C-x\C-d" 'ignore))
1630 (when viper-p
9f781d7e
KS
1631 (define-key map [remap viper-backward-char] 'ido-delete-backward-updir)
1632 (define-key map [remap viper-del-backward-char-in-insert] 'ido-delete-backward-updir)
973495ca
KS
1633 (define-key map [remap viper-delete-backward-word] 'ido-delete-backward-word-updir))
1634 (set-keymap-parent map
1635 (if (eq ido-cur-item 'file)
facf67fd
KS
1636 ido-file-completion-map
1637 ido-file-dir-completion-map)))
973495ca
KS
1638
1639 ((eq ido-cur-item 'buffer)
1640 (when ido-context-switch-command
1641 (define-key map "\C-x\C-f" ido-context-switch-command))
facf67fd 1642 (set-keymap-parent map ido-buffer-completion-map))
973495ca
KS
1643
1644 (t
facf67fd 1645 (set-keymap-parent map ido-common-completion-map)))
f0a73ccc 1646
facf67fd 1647 (setq ido-completion-map map)))
789d1bf0
KS
1648
1649(defun ido-final-slash (dir &optional fix-it)
1650 ;; return DIR if DIR has final slash.
1651 ;; else if FIX-IT is non-nil, return DIR/
1652 ;; else return nil.
1653 (setq dir (ido-name dir))
1654 (cond
1655 ((string-match "/\\'" dir) dir)
bad111c2 1656 ((ido-is-tramp-root dir) dir)
789d1bf0
KS
1657 (fix-it (concat dir "/"))
1658 (t nil)))
1659
310682e6
KS
1660(defun ido-no-final-slash (s)
1661 ;; Remove optional final slash from string S
1662 (let ((l (1- (length s))))
1663 (if (and (> l 0) (eq (aref s l) ?/))
1664 (substring s 0 l)
1665 s)))
1666
866f2239
KS
1667(defun ido-nonreadable-directory-p (dir)
1668 ;; Return t if dir is a directory, but not readable
1669 ;; Do not check for non-readable directories via tramp, as this causes a premature
1670 ;; connect on incomplete tramp paths (after entring just method:).
1671 (let ((ido-enable-tramp-completion nil))
1672 (and (ido-final-slash dir)
dfebc0ae 1673 (not (ido-is-unc-host dir))
866f2239
KS
1674 (file-directory-p dir)
1675 (not (file-readable-p dir)))))
1676
cb65c373
KS
1677(defun ido-directory-too-big-p (dir)
1678 ;; Return t if dir is a directory, but too big to show
1679 ;; Do not check for non-readable directories via tramp, as this causes a premature
1680 ;; connect on incomplete tramp paths (after entring just method:).
1681 (let ((ido-enable-tramp-completion nil))
1682 (and (numberp ido-max-directory-size)
1683 (ido-final-slash dir)
dfebc0ae 1684 (not (ido-is-unc-host dir))
cb65c373
KS
1685 (file-directory-p dir)
1686 (> (nth 7 (file-attributes dir)) ido-max-directory-size))))
1687
789d1bf0
KS
1688(defun ido-set-current-directory (dir &optional subdir no-merge)
1689 ;; Set ido's current directory to DIR or DIR/SUBDIR
c577a4d2
KS
1690 (unless (and ido-enable-tramp-completion
1691 (string-match "\\`/[^/]*@\\'" dir))
1692 (setq dir (ido-final-slash dir t)))
789d1bf0
KS
1693 (setq ido-use-merged-list nil
1694 ido-try-merged-list (not no-merge))
c577a4d2
KS
1695 (when subdir
1696 (setq dir (concat dir subdir))
1697 (unless (and ido-enable-tramp-completion
1698 (string-match "\\`/[^/]*@\\'" dir))
1699 (setq dir (ido-final-slash dir t))))
dfebc0ae
KS
1700 (if (get-buffer ido-completion-buffer)
1701 (kill-buffer ido-completion-buffer))
1702 (cond
1703 ((equal dir ido-current-directory)
1704 nil)
1705 ((ido-is-unc-root dir)
1706 (ido-trace "unc" dir)
1707 (setq ido-current-directory dir)
1708 (setq ido-directory-nonreadable nil)
1709 (setq ido-directory-too-big nil)
1710 t)
1711 (t
789d1bf0
KS
1712 (ido-trace "cd" dir)
1713 (setq ido-current-directory dir)
1714 (if (get-buffer ido-completion-buffer)
1715 (kill-buffer ido-completion-buffer))
866f2239 1716 (setq ido-directory-nonreadable (ido-nonreadable-directory-p dir))
cb65c373
KS
1717 (setq ido-directory-too-big (and (not ido-directory-nonreadable)
1718 (ido-directory-too-big-p dir)))
dfebc0ae 1719 t)))
789d1bf0
KS
1720
1721(defun ido-set-current-home (&optional dir)
1722 ;; Set ido's current directory to user's home directory
1723 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1724
1725(defun ido-record-command (command arg)
1726 ;; Add (command arg) to command-history if ido-record-commands is t
1727 (if ido-record-commands
1728 (let ((cmd (list command arg)))
1729 (if (or (not command-history)
1730 (not (equal cmd (car command-history))))
1731 (setq command-history (cons cmd command-history))))))
1732
1733(defun ido-make-prompt (item prompt)
1734 ;; Make the prompt for ido-read-internal
1735 (cond
1736 ((and (memq item '(file dir)) ido-current-directory)
362cdb61 1737 (let ((dirname (abbreviate-file-name ido-current-directory))
a42e9704
KS
1738 (max-width (if (and ido-max-file-prompt-width (floatp ido-max-file-prompt-width))
1739 (floor (* (frame-width) ido-max-file-prompt-width))
1740 ido-max-file-prompt-width))
789d1bf0 1741 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
310682e6 1742 (vc-off (and ido-saved-vc-hb (not vc-handled-backends) "[-VC] "))
789d1bf0 1743 (prefix nil)
362cdb61 1744 (rule ido-rewrite-file-prompt-rules))
789d1bf0
KS
1745 (let ((case-fold-search nil))
1746 (while rule
1747 (if (and (consp (car rule))
362cdb61
KS
1748 (string-match (car (car rule)) dirname))
1749 (setq dirname
789d1bf0 1750 (if (stringp (cdr (car rule)))
362cdb61
KS
1751 (replace-match (cdr (car rule)) t nil dirname)
1752 (funcall (cdr (car rule)) dirname))))
789d1bf0 1753 (setq rule (cdr rule))))
362cdb61 1754 (run-hooks 'ido-rewrite-file-prompt-functions)
71296446 1755 (concat prompt
789d1bf0
KS
1756 ; (if ido-process-ignore-lists "" "&")
1757 (or literal "")
1758 (or vc-off "")
1759 (or prefix "")
362cdb61 1760 (let ((l (length dirname)))
789d1bf0 1761 (if (and max-width (> max-width 0) (> l max-width))
71296446 1762 (let* ((s (substring dirname (- max-width)))
789d1bf0
KS
1763 (i (string-match "/" s)))
1764 (concat "..." (if i (substring s i) s)))
362cdb61 1765 dirname)))))
789d1bf0
KS
1766 (t prompt)))
1767
1768;; Here is very briefly how ido-find-file works:
1769;;
1770;; (ido-find-file)
1771;; (ido-file-internal method)
1772;; set ido-current-directory
1773;; (ido-read-internal 'file ...)
1774;; (while ...
1775;; (ido-make-item-list ...)
1776;; (ido-set-matches)
1777;; (completing-read ... ido-text-init ...)
1778;;
1779;; ... here user is allowed to type characters and commands
1780;; a command may set ido-exit and call (exit-minibuffer)
1781;; to make ido-read-internal do advanced tasks (or return)
1782;;
1783;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1784;; which are run before and after each user command.
1785;;
1786;; return value from completing-read is stored in ido-final-text
1787;; - ido-exit may cause further actions to be taken:
1788;; 'refresh - repeat loop (make-item-list, set-matches)
1789;; 'edit - edit the prompt string, then repeat loop
1790;; 'keep - repeat loop but don't (re)make-item-list
1791;; 'updir - go up one directory, repeat loop
1792;; else set ido-selected based on ido-final-text,
1793;; optionally update ido-current-directory and repeat loop, or
1794;; exit with the return value of ido-selected (file name)
1795;; selected file name is returned from ido-read-internal,
1796;; ido-exit and method determines what action is taken
1797;; e.g. the file name may be ignored or joined with ido-current-directory, and
1798;; the relevant function is called (find-file, write-file, etc).
1799
1800(defun ido-read-internal (item prompt history &optional default require-match initial)
a2cf0212 1801 "Perform the `ido-read-buffer' and `ido-read-file-name' functions.
71296446 1802Return the name of a buffer or file selected.
789d1bf0 1803PROMPT is the prompt to give to the user.
2d38f869 1804DEFAULT if given is the default item to start with.
789d1bf0
KS
1805If REQUIRE-MATCH is non-nil, an existing file must be selected.
1806If INITIAL is non-nil, it specifies the initial input string."
1807 (let
1808 ((ido-cur-item item)
1809 (ido-entry-buffer (current-buffer))
1810 (ido-process-ignore-lists t)
1811 (ido-process-ignore-lists-inhibit nil)
1812 (ido-set-default-item t)
1813 ido-default-item
1814 ido-selected
1815 ido-final-text
1816 (done nil)
1817 (icomplete-mode nil) ;; prevent icomplete starting up
1818 ;; Exported dynamic variables:
1819 ido-cur-list
1820 ido-ignored-list
1821 (ido-rotate-temp nil)
1822 (ido-keep-item-list nil)
1823 (ido-use-merged-list nil)
1824 (ido-try-merged-list t)
1825 (ido-pre-merge-state nil)
1826 (ido-case-fold ido-case-fold)
1827 (ido-enable-prefix ido-enable-prefix)
1828 (ido-enable-regexp ido-enable-regexp)
1829 )
1830
facf67fd 1831 (ido-setup-completion-map)
789d1bf0 1832 (setq ido-text-init initial)
3729cc87
KS
1833 (setq ido-input-stack nil)
1834
1835 (run-hooks 'ido-setup-hook)
1836
789d1bf0 1837 (while (not done)
bad111c2 1838 (ido-trace "\n_LOOP_" ido-text-init)
789d1bf0
KS
1839 (setq ido-exit nil)
1840 (setq ido-rescan t)
1841 (setq ido-rotate nil)
1842 (setq ido-text "")
69beb26d
KS
1843 (when ido-set-default-item
1844 (setq ido-default-item
1845 (cond
1846 ((eq item 'buffer)
1847 (if (bufferp default) (buffer-name default) default))
2d38f869
KS
1848 ((stringp default)
1849 (if (memq item '(file dir))
1850 (file-name-nondirectory default)
1851 default))
69beb26d 1852 ((eq item 'file)
71296446 1853 (and ido-enable-last-directory-history
69beb26d
KS
1854 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1855 (and d (cdr d)))))))
1856 (if (member ido-default-item ido-ignore-item-temp-list)
1857 (setq ido-default-item nil))
5444f278 1858 (ido-trace "new default" ido-default-item)
155943b9
KS
1859 (if ido-default-item
1860 (setq ido-initial-position 0))
69beb26d 1861 (setq ido-set-default-item nil))
789d1bf0
KS
1862
1863 (if ido-process-ignore-lists-inhibit
1864 (setq ido-process-ignore-lists nil))
1865
1866 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1867 (let ((olist ido-cur-list)
1868 (oign ido-ignored-list)
1869 (omat ido-matches)
1870 (l (ido-make-merged-file-list ido-text-init
1871 (eq ido-use-merged-list 'auto)
1872 (eq ido-try-merged-list 'wide))))
ec441ab5 1873 (ido-trace "merged" l)
789d1bf0
KS
1874 (cond
1875 ((not l)
1876 (if (eq ido-try-merged-list 'wide)
1877 (setq ido-pre-merge-state
1878 (list "" ido-current-directory olist oign omat)
1879 ido-cur-list nil
1880 ido-ignored-list nil
1881 ido-matches nil
1882 ido-keep-item-list t
1883 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1884 ido-use-merged-list nil)
1885 (setq ido-cur-list olist
1886 ido-ignored-list oign
1887 ido-matches omat
1888 ido-keep-item-list t
1889 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1890 ido-use-merged-list nil)))
1891 ((eq l t)
1892 (setq ido-use-merged-list nil))
ec441ab5
KS
1893 ((eq l 'input-pending-p)
1894 (setq ido-try-merged-list t
1895 ido-use-merged-list nil))
789d1bf0
KS
1896 (t
1897 (setq ido-pre-merge-state
1898 (list ido-text-init ido-current-directory olist oign omat))
1899 (ido-set-current-directory (car (cdr (car l))))
1900 (if (ido-final-slash ido-text-init)
1901 (setq ido-text-init ""))
1902 (setq ido-cur-list l
1903 ido-ignored-list nil
1904 ido-matches l
1905 ido-rescan nil
1906 ido-keep-item-list t
1907 ido-use-merged-list t)
1908 (ido-trace "Merged" t)
1909 ))))
71296446 1910
789d1bf0
KS
1911 (cond
1912 (ido-keep-item-list
1913 (setq ido-keep-item-list nil
1914 ido-rescan nil))
1915 ((eq ido-cur-item 'file)
1916 (setq ido-ignored-list nil
cb65c373
KS
1917 ido-cur-list (and (not ido-directory-nonreadable)
1918 (not ido-directory-too-big)
1919 (ido-make-file-list ido-default-item))))
789d1bf0
KS
1920 ((eq ido-cur-item 'dir)
1921 (setq ido-ignored-list nil
cb65c373
KS
1922 ido-cur-list (and (not ido-directory-nonreadable)
1923 (not ido-directory-too-big)
1924 (ido-make-dir-list ido-default-item))))
789d1bf0
KS
1925 ((eq ido-cur-item 'buffer)
1926 (setq ido-ignored-list nil
1927 ido-cur-list (ido-make-buffer-list ido-default-item)))
db9f395b
KS
1928 ((eq ido-cur-item 'list)
1929 (setq ido-ignored-list nil
1930 ido-cur-list (ido-make-choice-list ido-default-item)))
789d1bf0
KS
1931 (t nil))
1932 (setq ido-rotate-temp nil)
1933
1934 (if ido-process-ignore-lists-inhibit
1935 (setq ido-process-ignore-lists t
1936 ido-process-ignore-lists-inhibit nil))
1937
1938 (ido-set-matches)
1939 (if (and ido-matches (eq ido-try-merged-list 'auto))
1940 (setq ido-try-merged-list t))
71296446 1941 (let
523c54f5
KS
1942 ((minibuffer-local-completion-map
1943 (if (memq ido-cur-item '(file dir))
1944 minibuffer-local-completion-map
1945 ido-completion-map))
1946 (minibuffer-local-filename-completion-map
1947 (if (memq ido-cur-item '(file dir))
1948 ido-completion-map
1949 minibuffer-local-filename-completion-map))
789d1bf0
KS
1950 (max-mini-window-height (or ido-max-window-height
1951 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1952 (ido-completing-read t)
1953 (ido-require-match require-match)
1954 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1955 (show-paren-mode nil))
1956 ;; prompt the user for the file name
1957 (setq ido-exit nil)
1958 (setq ido-final-text
1959 (catch 'ido
71296446 1960 (completing-read
789d1bf0 1961 (ido-make-prompt item prompt)
9066a4d0 1962 '(("dummy" . 1)) nil nil ; table predicate require-match
789d1bf0
KS
1963 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1964 history))))
1965 (ido-trace "completing-read" ido-final-text)
1966 (if (get-buffer ido-completion-buffer)
1967 (kill-buffer ido-completion-buffer))
1968
1969 (ido-trace "\n_EXIT_" ido-exit)
1970
1971 (cond
1972 ((eq ido-exit 'refresh)
71296446 1973 (if (and (eq ido-use-merged-list 'auto)
789d1bf0
KS
1974 (or (input-pending-p)))
1975 (setq ido-use-merged-list nil
1976 ido-keep-item-list t))
1977 nil)
1978
1979 ((eq ido-exit 'done)
1980 (setq done t
1981 ido-selected ido-text
1982 ido-exit nil))
1983
1984 ((memq ido-exit '(edit chdir))
71296446 1985 (cond
789d1bf0 1986 ((memq ido-cur-item '(file dir))
3f2b52ad 1987 (let* ((read-file-name-function nil)
789d1bf0
KS
1988 (edit (eq ido-exit 'edit))
1989 (d ido-current-directory)
1990 (f ido-text-init)
84f6c6d0 1991 (new t))
789d1bf0 1992 (setq ido-text-init "")
84f6c6d0
KS
1993 (while new
1994 (setq new (if edit
3729cc87
KS
1995 (condition-case nil
1996 (read-file-name (concat prompt "[EDIT] ")
1997 (expand-file-name d)
1998 (concat d f) nil f)
1999 (quit (concat d f)))
789d1bf0 2000 f)
84f6c6d0
KS
2001 d (or (file-name-directory new) "/")
2002 f (file-name-nondirectory new)
789d1bf0 2003 edit t)
71296446 2004 (if (or
789d1bf0
KS
2005 (file-directory-p d)
2006 (and (yes-or-no-p (format "Create directory %s? " d))
71296446 2007 (condition-case nil
789d1bf0
KS
2008 (progn (make-directory d t) t)
2009 (error
2010 (message "Could not create directory")
2011 (sit-for 1)
2012 nil))))
2013 (progn
2014 (ido-set-current-directory d nil (eq ido-exit 'chdir))
2015 (setq ido-text-init f
84f6c6d0 2016 new nil))))))
789d1bf0 2017 (t
3729cc87
KS
2018 (setq ido-text-init
2019 (condition-case nil
2020 (read-string (concat prompt "[EDIT] ") ido-final-text)
2021 (quit ido-final-text)))))
2022
789d1bf0
KS
2023 nil)
2024
2025 ((eq ido-exit 'keep)
2026 (setq ido-keep-item-list t))
2027
db9f395b 2028 ((memq ido-exit '(dired fallback find-file switch-to-buffer insert-buffer insert-file))
789d1bf0
KS
2029 (setq done t))
2030
3729cc87 2031 ((memq ido-exit '(updir push))
789d1bf0
KS
2032 ;; cannot go up if already at the root-dir (Unix) or at the
2033 ;; root-dir of a certain drive (Windows or MS-DOS).
bad111c2
KS
2034 (if (ido-is-tramp-root)
2035 (when (string-match "\\`\\(/\\([^/]+[:@]\\)*\\)\\([^/]+\\)[:@]\\'" ido-current-directory)
2036 (setq ido-text-init (match-string 3 ido-current-directory))
2037 (ido-set-current-directory (match-string 1 ido-current-directory))
2038 (setq ido-set-default-item t))
2039 (unless (ido-is-root-directory)
3729cc87
KS
2040 (when (eq ido-exit 'push)
2041 (setq ido-input-stack (cons (cons ido-cur-item ido-text) ido-input-stack))
2042 (setq ido-cur-item 'dir)
2043 (setq ido-text-init (file-name-nondirectory (substring ido-current-directory 0 -1)))
2044 (ido-trace "push" ido-input-stack))
bad111c2
KS
2045 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1)))
2046 (setq ido-set-default-item t))))
789d1bf0 2047
3729cc87
KS
2048 ((eq ido-exit 'pop)
2049 (ido-trace "pop" ido-input-stack)
2050 (let ((elt (car ido-input-stack)))
2051 (setq ido-input-stack (cdr ido-input-stack))
2052 (ido-set-current-directory (concat ido-current-directory ido-text))
2053 (setq ido-cur-item (car elt))
2054 (setq ido-text-init (cdr elt))))
2055
2056 ((eq ido-exit 'pop-all)
2057 (ido-trace "pop-all" ido-input-stack)
2058 (while ido-input-stack
2059 (let ((elt (car ido-input-stack)))
2060 (setq ido-input-stack (cdr ido-input-stack))
2061 (ido-set-current-directory (concat ido-current-directory ido-text))
2062 (setq ido-cur-item (car elt))
2063 (setq ido-text-init (cdr elt)))))
2064
789d1bf0 2065 ;; Handling the require-match must be done in a better way.
b3da0db5
KS
2066 ((and require-match
2067 (not (if ido-directory-too-big
2068 (file-exists-p (concat ido-current-directory ido-final-text))
2069 (ido-existing-item-p))))
a09e21bf 2070 (error "Must specify valid item"))
789d1bf0
KS
2071
2072 (t
2073 (setq ido-selected
69beb26d
KS
2074 (if (or (eq ido-exit 'takeprompt)
2075 (null ido-matches))
2076 ido-final-text
2077 ;; else take head of list
2078 (ido-name (car ido-matches))))
789d1bf0
KS
2079
2080 (cond
2a5095fb 2081 ((memq item '(buffer list))
789d1bf0
KS
2082 (setq done t))
2083
2084 ((string-equal "./" ido-selected)
2085 nil)
2086
2087 ((string-equal "../" ido-selected)
2088 ;; cannot go up if already at the root-dir (Unix) or at the
2089 ;; root-dir of a certain drive (Windows or MS-DOS).
2090 (or (ido-is-root-directory)
2091 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
2092 (setq ido-set-default-item t))
bad111c2 2093
10b19e88
KS
2094 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") ido-selected)
2095 (ido-is-root-directory) ;; Ange-ftp or Tramp
2096 (not (ido-local-file-exists-p ido-selected)))
bad111c2
KS
2097 (ido-set-current-directory ido-current-directory ido-selected)
2098 (ido-trace "tramp prefix" ido-selected)
789d1bf0
KS
2099 (if (ido-is-slow-ftp-host)
2100 (setq ido-exit 'fallback
2101 done t)
2102 (setq ido-set-default-item t)))
dfebc0ae 2103
789d1bf0
KS
2104 ((or (string-match "[/\\][^/\\]" ido-selected)
2105 (and (memq system-type '(windows-nt ms-dos))
10b19e88 2106 (string-match "\\`[a-zA-Z]:" ido-selected)))
789d1bf0
KS
2107 (ido-set-current-directory (file-name-directory ido-selected))
2108 (setq ido-set-default-item t))
2109
2110 ((string-match "\\`~" ido-selected)
2111 (ido-set-current-home ido-selected))
2112
2113 ((ido-final-slash ido-selected)
2114 (if ido-enable-last-directory-history
2115 (let ((x (assoc ido-current-directory ido-last-directory-list)))
2116 (if x
2117 (setcdr x ido-selected)
2118 (setq ido-last-directory-list
2119 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
2120 (ido-set-current-directory ido-current-directory ido-selected)
3729cc87 2121 (if ido-input-stack
11ae5e81
KS
2122 ; automatically pop stack elements which match existing files or directories
2123 (let (elt)
2124 (while (and (setq elt (car ido-input-stack))
2125 (file-exists-p (concat ido-current-directory (cdr elt))))
3729cc87
KS
2126 (if (setq ido-input-stack (cdr ido-input-stack))
2127 (ido-set-current-directory ido-current-directory (cdr elt))
2128 (setq ido-text-init (cdr elt)))
2129 (setq ido-cur-item (car elt))))
2130 (setq ido-set-default-item t)))
789d1bf0
KS
2131
2132 (t
2133 (setq done t))))))
2134 ido-selected))
2135
2136(defun ido-edit-input ()
155943b9
KS
2137 "Edit absolute file name entered so far with ido; terminate by RET.
2138If cursor is not at the end of the user input, move to end of input."
789d1bf0 2139 (interactive)
155943b9
KS
2140 (if (not (eobp))
2141 (end-of-line)
2142 (setq ido-text-init (if ido-matches (ido-name (car ido-matches)) ido-text))
2143 (setq ido-exit 'edit)
2144 (exit-minibuffer)))
789d1bf0
KS
2145
2146;;; MAIN FUNCTIONS
db9f395b 2147(defun ido-buffer-internal (method &optional fallback prompt default initial switch-cmd)
789d1bf0
KS
2148 ;; Internal function for ido-switch-buffer and friends
2149 (if (not ido-mode)
b2d4c118
KS
2150 (progn
2151 (run-hook-with-args 'ido-before-fallback-functions
2152 (or fallback 'switch-to-buffer))
2153 (call-interactively (or fallback 'switch-to-buffer)))
db9f395b 2154 (let* ((ido-context-switch-command switch-cmd)
cb65c373
KS
2155 (ido-current-directory nil)
2156 (ido-directory-nonreadable nil)
2157 (ido-directory-too-big nil)
2158 (buf (ido-read-internal 'buffer (or prompt "Buffer: ") 'ido-buffer-history default nil initial)))
789d1bf0
KS
2159
2160 ;; Choose the buffer name: either the text typed in, or the head
2161 ;; of the list of matches
2162
71296446 2163 (cond
db9f395b 2164 ((eq ido-exit 'find-file)
789d1bf0
KS
2165 (ido-file-internal ido-default-file-method nil nil nil nil ido-text))
2166
db9f395b
KS
2167 ((eq ido-exit 'insert-file)
2168 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil ido-text 'ido-enter-insert-buffer))
2169
789d1bf0
KS
2170 ((eq ido-exit 'fallback)
2171 (let ((read-buffer-function nil))
16f462c5
KS
2172 (setq this-command (or fallback 'switch-to-buffer))
2173 (run-hook-with-args 'ido-before-fallback-functions this-command)
2174 (call-interactively this-command)))
789d1bf0
KS
2175
2176 ;; Check buf is non-nil.
2177 ((not buf) nil)
69beb26d 2178 ((= (length buf) 0) nil)
789d1bf0
KS
2179
2180 ;; View buffer if it exists
2181 ((get-buffer buf)
16f462c5 2182 (add-to-history 'buffer-name-history buf)
789d1bf0
KS
2183 (if (eq method 'insert)
2184 (progn
2185 (ido-record-command 'insert-buffer buf)
2d13e588
KS
2186 (push-mark
2187 (save-excursion
2188 (insert-buffer-substring (get-buffer buf))
2189 (point))))
789d1bf0
KS
2190 (ido-visit-buffer buf method t)))
2191
2192 ;; buffer doesn't exist
2193 ((eq ido-create-new-buffer 'never)
a09e21bf 2194 (message "No buffer matching `%s'" buf))
789d1bf0
KS
2195
2196 ((and (eq ido-create-new-buffer 'prompt)
2197 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
2198 nil)
2199
2200 ;; create a new buffer
2201 (t
16f462c5 2202 (add-to-history 'buffer-name-history buf)
789d1bf0
KS
2203 (setq buf (get-buffer-create buf))
2204 (if (fboundp 'set-buffer-major-mode)
2205 (set-buffer-major-mode buf))
2206 (ido-visit-buffer buf method t))))))
2207
789d1bf0
KS
2208(defun ido-record-work-directory (&optional dir)
2209 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
2210 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
2211 (let ((items ido-work-directory-list-ignore-regexps)
2212 (case-fold-search nil))
2213 (while (and items dir)
2214 (if (string-match (car items) dir)
2215 (setq dir nil))
2216 (setq items (cdr items)))
2217 (if dir
2218 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
2219 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
2220 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
2221
2222(defun ido-forget-work-directory ()
2223 (interactive)
2224 (when (and ido-current-directory ido-work-directory-list)
2225 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
2226 (when ido-use-merged-list
2227 (ido-undo-merge-work-directory)
2228 (setq ido-exit 'refresh
2229 ido-try-merged-list t
2230 ido-use-merged-list t
2231 ido-text-init ido-text
2232 ido-rotate-temp t)
2233 (exit-minibuffer))))
71296446 2234
789d1bf0
KS
2235(defun ido-record-work-file (name)
2236 ;; Save NAME in ido-work-file-list
2237 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
2238 (or
2239 (and ido-work-file-list (equal (car ido-work-file-list) name))
2240 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
2241 (if (> (length ido-work-file-list) ido-max-work-file-list)
2242 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
2243
a70343bd
KS
2244(defun ido-expand-directory (dir)
2245 ;; Expand DIR or use DEFAULT-DIRECTORY if nil.
2246 ;; Add final slash to result in case it was missing from DEFAULT-DIRECTORY.
2247 (ido-final-slash (expand-file-name (or dir default-directory)) t))
2248
db9f395b 2249(defun ido-file-internal (method &optional fallback default prompt item initial switch-cmd)
789d1bf0 2250 ;; Internal function for ido-find-file and friends
310682e6
KS
2251 (unless item
2252 (setq item 'file))
94da3cf1
KS
2253 (let ((ido-current-directory (ido-expand-directory default))
2254 (ido-context-switch-command switch-cmd)
83a12f3a 2255 ido-directory-nonreadable ido-directory-too-big
94da3cf1
KS
2256 filename)
2257
2258 (if (or (not ido-mode) (ido-is-slow-ftp-host))
2259 (setq filename t
2260 ido-exit 'fallback)
2261 (setq ido-directory-nonreadable
2262 (ido-nonreadable-directory-p ido-current-directory)
2263 ido-directory-too-big
2264 (and (not ido-directory-nonreadable)
2265 (ido-directory-too-big-p ido-current-directory))))
2266
2267 (when (and (eq item 'file)
310682e6
KS
2268 (or ido-use-url-at-point ido-use-filename-at-point))
2269 (let (fn d)
2270 (require 'ffap)
2271 ;; Duplicate code from ffap-guesser as we want different behaviour for files and URLs.
2272 (cond
3729cc87
KS
2273 ((with-no-warnings
2274 (and ido-use-url-at-point
2275 ffap-url-regexp
2276 (ffap-fixup-url (or (ffap-url-at-point)
2277 (ffap-gopher-at-point)))))
310682e6
KS
2278 (setq ido-exit 'ffap
2279 filename t))
2280
2281 ((and ido-use-filename-at-point
004a00f4
DN
2282 (setq fn (with-no-warnings
2283 (if (eq ido-use-filename-at-point 'guess)
2284 (ffap-guesser)
2285 (ffap-string-at-point))))
d81aa76a 2286 (not (string-match "^http:/" fn))
310682e6
KS
2287 (setq d (file-name-directory fn))
2288 (file-directory-p d))
2289 (setq ido-current-directory d)
94da3cf1 2290 (setq initial (file-name-nondirectory fn))))))
310682e6
KS
2291
2292 (let (ido-saved-vc-hb
2293 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
789d1bf0
KS
2294 (ido-work-directory-index -1)
2295 (ido-work-file-index -1)
2296 (ido-find-literal nil))
2297
2298 (unless filename
310682e6 2299 (setq ido-saved-vc-hb vc-handled-backends)
d471b4fe
KS
2300 (let ((minibuffer-completing-file-name t))
2301 (setq filename (ido-read-internal item
2302 (or prompt "Find file: ")
033ecf78
KS
2303 'ido-file-history
2304 (and (eq method 'alt-file) buffer-file-name)
2305 nil initial))))
789d1bf0
KS
2306
2307 ;; Choose the file name: either the text typed in, or the head
2308 ;; of the list of matches
2309
2310 (cond
2311 ((eq ido-exit 'fallback)
2312 ;; Need to guard setting of default-directory here, since
2313 ;; we don't want to change directory of current buffer.
2314 (let ((default-directory ido-current-directory)
2315 (read-file-name-function nil))
16f462c5
KS
2316 (setq this-command (or fallback 'find-file))
2317 (run-hook-with-args 'ido-before-fallback-functions this-command)
2318 (call-interactively this-command)))
789d1bf0 2319
db9f395b 2320 ((eq ido-exit 'switch-to-buffer)
789d1bf0
KS
2321 (ido-buffer-internal ido-default-buffer-method nil nil nil ido-text))
2322
db9f395b
KS
2323 ((eq ido-exit 'insert-buffer)
2324 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil ido-text 'ido-enter-insert-file))
2325
789d1bf0
KS
2326 ((eq ido-exit 'dired)
2327 (dired (concat ido-current-directory (or ido-text ""))))
2328
310682e6
KS
2329 ((eq ido-exit 'ffap)
2330 (find-file-at-point))
2331
789d1bf0
KS
2332 ((eq method 'alt-file)
2333 (ido-record-work-file filename)
2334 (setq default-directory ido-current-directory)
2335 (ido-record-work-directory)
2336 (find-alternate-file filename))
2337
2338 ((memq method '(dired list-directory))
2339 (if (equal filename ".")
2340 (setq filename ""))
84f6c6d0
KS
2341 (let* ((dirname (ido-final-slash (concat ido-current-directory filename) t))
2342 (file (substring dirname 0 -1)))
789d1bf0 2343 (cond
84f6c6d0
KS
2344 ((file-directory-p dirname)
2345 (ido-record-command method dirname)
2346 (ido-record-work-directory dirname)
2347 (funcall method dirname))
789d1bf0
KS
2348 ((file-directory-p ido-current-directory)
2349 (cond
2350 ((file-exists-p file)
2351 (ido-record-command method ido-current-directory)
2352 (ido-record-work-directory)
2353 (funcall method ido-current-directory)
2354 (if (eq method 'dired)
3729cc87
KS
2355 (with-no-warnings
2356 (dired-goto-file (expand-file-name file)))))
789d1bf0 2357 ((string-match "[[*?]" filename)
84f6c6d0
KS
2358 (setq dirname (concat ido-current-directory filename))
2359 (ido-record-command method dirname)
789d1bf0 2360 (ido-record-work-directory)
84f6c6d0 2361 (funcall method dirname))
ce5a3ac0 2362 ((y-or-n-p (format "Directory %s does not exist. Create it? " filename))
84f6c6d0
KS
2363 (ido-record-command method dirname)
2364 (ido-record-work-directory dirname)
2365 (make-directory-internal dirname)
2366 (funcall method dirname))
789d1bf0
KS
2367 (t
2368 ;; put make-directory command on history
84f6c6d0 2369 (ido-record-command 'make-directory dirname))))
789d1bf0
KS
2370 (t (error "No such directory")))))
2371
2372 ((eq method 'write)
2373 (ido-record-work-file filename)
2374 (setq default-directory ido-current-directory)
16f462c5
KS
2375 (setq filename (concat ido-current-directory filename))
2376 (ido-record-command 'write-file filename)
2377 (add-to-history 'file-name-history filename)
789d1bf0 2378 (ido-record-work-directory)
16f462c5 2379 (write-file filename))
789d1bf0
KS
2380
2381 ((eq method 'read-only)
2382 (ido-record-work-file filename)
2383 (setq filename (concat ido-current-directory filename))
2384 (ido-record-command fallback filename)
2385 (ido-record-work-directory)
b2d4c118 2386 (run-hook-with-args 'ido-before-fallback-functions fallback)
789d1bf0
KS
2387 (funcall fallback filename))
2388
2389 ((eq method 'insert)
2390 (ido-record-work-file filename)
2391 (setq filename (concat ido-current-directory filename))
71296446 2392 (ido-record-command
789d1bf0
KS
2393 (if ido-find-literal 'insert-file-literally 'insert-file)
2394 filename)
16f462c5 2395 (add-to-history 'file-name-history filename)
789d1bf0 2396 (ido-record-work-directory)
2d13e588
KS
2397 (insert-file-1 filename
2398 (if ido-find-literal
2399 #'insert-file-contents-literally
2400 #'insert-file-contents)))
789d1bf0
KS
2401
2402 (filename
2403 (ido-record-work-file filename)
2404 (setq filename (concat ido-current-directory filename))
2405 (ido-record-command 'find-file filename)
16f462c5 2406 (add-to-history 'file-name-history filename)
789d1bf0
KS
2407 (ido-record-work-directory)
2408 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
2409
2410(defun ido-existing-item-p ()
2411 ;; Return non-nil if there is a matching item
2412 (not (null ido-matches)))
2413
2414;;; COMPLETION CODE
2415
2416(defun ido-set-common-completion ()
2417 ;; Find common completion of `ido-text' in `ido-matches'
2418 ;; The result is stored in `ido-common-match-string'
ccaa42ed
JB
2419 (let (val)
2420 (setq ido-common-match-string nil)
789d1bf0
KS
2421 (if (and ido-matches
2422 (not ido-enable-regexp) ;; testing
2423 (stringp ido-text)
2424 (> (length ido-text) 0))
2425 (if (setq val (ido-find-common-substring ido-matches ido-text))
2426 (setq ido-common-match-string val)))
2427 val))
2428
2429(defun ido-complete ()
2430 "Try and complete the current pattern amongst the file names."
2431 (interactive)
2432 (let (res)
71296446 2433 (cond
665ed61a
KS
2434 (ido-incomplete-regexp
2435 ;; Do nothing
2436 )
789d1bf0
KS
2437 ((and (memq ido-cur-item '(file dir))
2438 (string-match "[$]" ido-text))
2439 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
2440 (if (not (file-exists-p (file-name-directory evar)))
337d2b66 2441 (message "Expansion generates non-existing directory name")
789d1bf0
KS
2442 (if (file-directory-p evar)
2443 (ido-set-current-directory evar)
2444 (let ((d (or (file-name-directory evar) "/"))
2445 (f (file-name-nondirectory evar)))
2446 (when (file-directory-p d)
2447 (ido-set-current-directory d)
2448 (setq ido-text-init f))))
2449 (setq ido-exit 'refresh)
2450 (exit-minibuffer))))
2451
cb65c373
KS
2452 (ido-directory-too-big
2453 (setq ido-directory-too-big nil)
2454 (setq ido-text-init ido-text)
2455 (setq ido-exit 'refresh)
2456 (exit-minibuffer))
2457
789d1bf0
KS
2458 ((not ido-matches)
2459 (when ido-completion-buffer
d1a0acac 2460 (call-interactively (setq this-command ido-cannot-complete-command))))
71296446 2461
bad111c2
KS
2462 ((and (= 1 (length ido-matches))
2463 (not (and ido-enable-tramp-completion
2464 (string-equal ido-current-directory "/")
10b19e88
KS
2465 (string-match ".[@:]\\'" (ido-name (car ido-matches)))))
2466 (not (ido-local-file-exists-p (ido-name (car ido-matches)))))
789d1bf0 2467 ;; only one choice, so select it.
d81aa76a
KS
2468 (if (not ido-confirm-unique-completion)
2469 (exit-minibuffer)
2470 (setq ido-rescan (not ido-enable-prefix))
2471 (delete-region (minibuffer-prompt-end) (point))
5a1b28a4 2472 (insert (ido-name (car ido-matches)))))
71296446 2473
789d1bf0
KS
2474 (t ;; else there could be some completions
2475 (setq res ido-common-match-string)
2476 (if (and (not (memq res '(t nil)))
2477 (not (equal res ido-text)))
2478 ;; found something to complete, so put it in the minibuffer.
2479 (progn
2480 ;; move exact match to front if not in prefix mode
2481 (setq ido-rescan (not ido-enable-prefix))
2482 (delete-region (minibuffer-prompt-end) (point))
2483 (insert res))
2484 ;; else nothing to complete
d1a0acac 2485 (call-interactively (setq this-command ido-cannot-complete-command))
789d1bf0
KS
2486 )))))
2487
030fa15b
KS
2488(defun ido-complete-space ()
2489 "Try completion unless inserting the space makes sense."
2490 (interactive)
2491 (if (and (stringp ido-common-match-string)
2492 (stringp ido-text)
2493 (cond
2494 ((> (length ido-common-match-string) (length ido-text))
2495 (= (aref ido-common-match-string (length ido-text)) ? ))
2496 (ido-matches
2497 (let (insert-space
2498 (re (concat (regexp-quote ido-text) " "))
2499 (comp ido-matches))
2500 (while comp
2501 (if (string-match re (ido-name (car comp)))
2502 (setq comp nil insert-space t)
2503 (setq comp (cdr comp))))
2504 insert-space))
2505 (t nil)))
2506 (insert " ")
2507 (ido-complete)))
2508
789d1bf0
KS
2509(defun ido-undo-merge-work-directory (&optional text try refresh)
2510 "Undo or redo last ido directory merge operation.
2511If no merge has yet taken place, toggle automatic merging option."
2512 (interactive)
2513 (cond
2514 (ido-pre-merge-state
2515 (ido-set-current-directory (nth 1 ido-pre-merge-state))
2516 (setq ido-text-init (or text (car ido-pre-merge-state))
2517 ido-cur-list (nth 2 ido-pre-merge-state)
2518 ido-ignored-list (nth 3 ido-pre-merge-state)
2519 ido-matches (nth 4 ido-pre-merge-state)
2520 ido-use-merged-list nil
2521 ido-try-merged-list try
2522 ido-keep-item-list (not refresh)
2523 ido-rescan nil
2524 ido-exit 'refresh
2525 ido-pre-merge-state nil)
2526 (exit-minibuffer))
2527 (text
2528 nil)
2529 (ido-try-merged-list
2530 (setq ido-try-merged-list nil))
2531 (ido-matches
2532 (setq ido-try-merged-list t))
2533 ((not ido-use-merged-list)
2534 (ido-merge-work-directories))))
71296446 2535
ae9d279d
KS
2536;;; Magic C-f
2537
a9dbdece 2538(defun ido-magic-forward-char (arg)
ae9d279d 2539 "Move forward in user input or perform magic action.
616e8e5f 2540If no user input is present, or at end of input, perform magic actions:
cc2691b7
KS
2541C-x C-b ... C-f switch to ido-find-file.
2542C-x C-f ... C-f fallback to non-ido find-file.
2543C-x C-d ... C-f fallback to non-ido brief dired.
2544C-x d ... C-f fallback to non-ido dired."
a9dbdece 2545 (interactive "P")
ae9d279d 2546 (cond
a9dbdece
KS
2547 ((or arg (not (eobp)))
2548 (forward-char (min (prefix-numeric-value arg)
2549 (- (point-max) (point)))))
cc2691b7
KS
2550 ((memq ido-cur-item '(file dir))
2551 (ido-fallback-command))
2552 (ido-context-switch-command
2553 (call-interactively ido-context-switch-command))
2554 ((eq ido-cur-item 'buffer)
2555 (ido-enter-find-file))))
ae9d279d
KS
2556
2557;;; Magic C-b
2558
a9dbdece 2559(defun ido-magic-backward-char (arg)
ae9d279d 2560 "Move backward in user input or perform magic action.
cc2691b7 2561If no user input is present, or at start of input, perform magic actions:
a09e21bf
JB
2562C-x C-f C-b switch to `ido-switch-buffer'.
2563C-x C-d C-b switch to `ido-switch-buffer'.
2564C-x d C-b switch to `ido-switch-buffer'.
2565C-x C-b C-b fallback to non-ido `switch-to-buffer'."
a9dbdece 2566 (interactive "P")
ae9d279d 2567 (cond
a9dbdece
KS
2568 ((or arg (> (point) (minibuffer-prompt-end)))
2569 (forward-char
2570 (- (min (prefix-numeric-value arg)
2571 (- (point) (minibuffer-prompt-end))))))
155943b9
KS
2572 ((eq last-command this-command)
2573 (when (and (memq ido-cur-item '(file dir))
2574 (not (bobp)))
2575 (ido-push-dir))) ; else do nothing
ae9d279d 2576 ((eq ido-cur-item 'buffer)
cc2691b7
KS
2577 (ido-fallback-command))
2578 (ido-context-switch-command
2579 (call-interactively ido-context-switch-command))
2580 (t
2581 (ido-enter-switch-buffer))))
ae9d279d
KS
2582
2583;;; Magic C-d
2584
a9dbdece 2585(defun ido-magic-delete-char (arg)
ae9d279d
KS
2586 "Delete following char in user input or perform magic action.
2587If at end of user input, perform magic actions:
2588C-x C-f ... C-d enter dired on current directory."
a9dbdece 2589 (interactive "P")
ae9d279d 2590 (cond
a9dbdece
KS
2591 ((or arg (not (eobp)))
2592 (delete-char (min (prefix-numeric-value arg)
2593 (- (point-max) (point)))))
ae9d279d
KS
2594 (ido-context-switch-command
2595 nil)
2596 ((memq ido-cur-item '(file dir))
2597 (ido-enter-dired))))
2598
2599
789d1bf0
KS
2600;;; TOGGLE FUNCTIONS
2601
2602(defun ido-toggle-case ()
2603 "Toggle the value of `ido-case-fold'."
2604 (interactive)
2605 (setq ido-case-fold (not ido-case-fold))
2606 ;; ask for list to be regenerated.
2607 (setq ido-rescan t))
2608
2609(defun ido-toggle-regexp ()
2610 "Toggle the value of `ido-enable-regexp'."
2611 (interactive)
2612 (setq ido-enable-regexp (not ido-enable-regexp))
2613 ;; ask for list to be regenerated.
2614 (setq ido-rescan t))
2615
2616(defun ido-toggle-prefix ()
2617 "Toggle the value of `ido-enable-prefix'."
2618 (interactive)
2619 (setq ido-enable-prefix (not ido-enable-prefix))
2620 ;; ask for list to be regenerated.
2621 (setq ido-rescan t))
2622
2623(defun ido-toggle-ignore ()
2624 "Toggle ignoring files specified with `ido-ignore-files'."
2625 (interactive)
155943b9
KS
2626 (if (and (not (eobp)) (> (point) (minibuffer-prompt-end)))
2627 (goto-char (minibuffer-prompt-end))
2628 (if ido-directory-too-big
2629 (progn
2630 (message "Reading directory...")
2631 (setq ido-directory-too-big nil))
2632 (setq ido-process-ignore-lists (not ido-process-ignore-lists)))
2633 (setq ido-text-init ido-text)
2634 (setq ido-exit 'refresh)
2635 (exit-minibuffer)))
789d1bf0
KS
2636
2637(defun ido-toggle-vc ()
2638 "Disable version control for this file."
2639 (interactive)
2640 (if (and ido-mode (eq ido-cur-item 'file))
2641 (progn
310682e6
KS
2642 (setq vc-handled-backends
2643 (if vc-handled-backends nil ido-saved-vc-hb))
789d1bf0
KS
2644 (setq ido-text-init ido-text)
2645 (setq ido-exit 'keep)
2646 (exit-minibuffer))))
2647
2648(defun ido-toggle-literal ()
2649 "Toggle literal reading of this file."
2650 (interactive)
2651 (if (and ido-mode (eq ido-cur-item 'file))
2652 (progn
2653 (setq ido-find-literal (not ido-find-literal))
2654 (setq ido-text-init ido-text)
2655 (setq ido-exit 'keep)
2656 (exit-minibuffer))))
2657
2658(defun ido-reread-directory ()
2659 "Read current directory again.
2660May be useful if cached version is no longer valid, but directory
2661timestamp has not changed (e.g. with ftp or on Windows)."
2662 (interactive)
ff07e0ac 2663 (if (and ido-mode (memq ido-cur-item '(file dir)))
789d1bf0 2664 (progn
1b00bc64
KS
2665 (if (ido-is-unc-root)
2666 (setq ido-unc-hosts-cache t)
2667 (ido-remove-cached-dir ido-current-directory))
789d1bf0
KS
2668 (setq ido-text-init ido-text)
2669 (setq ido-rotate-temp t)
2670 (setq ido-exit 'refresh)
2671 (exit-minibuffer))))
2672
2673(defun ido-exit-minibuffer ()
2674 "Exit minibuffer, but make sure we have a match if one is needed."
2675 (interactive)
665ed61a
KS
2676 (if (and (or (not ido-require-match)
2677 (ido-existing-item-p))
2678 (not ido-incomplete-regexp))
3729cc87 2679 (exit-minibuffer)))
789d1bf0
KS
2680
2681(defun ido-select-text ()
2682 "Select the buffer or file named by the prompt.
2683If no buffer or file exactly matching the prompt exists, maybe create a new one."
2684 (interactive)
2685 (setq ido-exit 'takeprompt)
2686 (exit-minibuffer))
2687
2688(defun ido-fallback-command ()
2689 "Fallback to non-ido version of current command."
2690 (interactive)
4260eddd
KS
2691 (let ((i (length ido-text)))
2692 (while (> i 0)
2693 (push (aref ido-text (setq i (1- i))) unread-command-events)))
789d1bf0
KS
2694 (setq ido-exit 'fallback)
2695 (exit-minibuffer))
2696
2697(defun ido-enter-find-file ()
616e8e5f 2698 "Drop into `find-file' from buffer switching."
789d1bf0 2699 (interactive)
db9f395b 2700 (setq ido-exit 'find-file)
789d1bf0
KS
2701 (exit-minibuffer))
2702
2703(defun ido-enter-switch-buffer ()
616e8e5f 2704 "Drop into `ido-switch-buffer' from file switching."
789d1bf0 2705 (interactive)
db9f395b 2706 (setq ido-exit 'switch-to-buffer)
789d1bf0
KS
2707 (exit-minibuffer))
2708
2709(defun ido-enter-dired ()
a09e21bf 2710 "Drop into `dired' from file switching."
789d1bf0
KS
2711 (interactive)
2712 (setq ido-exit 'dired)
2713 (exit-minibuffer))
2714
db9f395b 2715(defun ido-enter-insert-buffer ()
a09e21bf 2716 "Drop into `insert-buffer' from insert file."
db9f395b
KS
2717 (interactive)
2718 (setq ido-exit 'insert-buffer)
2719 (exit-minibuffer))
2720
2721(defun ido-enter-insert-file ()
a09e21bf 2722 "Drop into `insert-file' from insert buffer."
db9f395b
KS
2723 (interactive)
2724 (setq ido-exit 'insert-file)
2725 (exit-minibuffer))
2726
789d1bf0
KS
2727
2728(defun ido-up-directory (&optional clear)
2729 "Go up one directory level."
2730 (interactive "P")
2731 (setq ido-text-init (if clear nil ido-text))
2732 (setq ido-exit 'updir)
2733 (setq ido-rotate-temp t)
2734 (exit-minibuffer))
2735
2736(defun ido-delete-backward-updir (count)
2737 "Delete char backwards, or at beginning of buffer, go up one level."
2738 (interactive "P")
2739 (cond
2740 ((= (minibuffer-prompt-end) (point))
2741 (if (not count)
2742 (ido-up-directory t)))
2743 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2744 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
f0a73ccc
KS
2745 ((eq this-original-command 'viper-backward-char)
2746 (funcall this-original-command (prefix-numeric-value count)))
2747 ((eq this-original-command 'viper-del-backward-char-in-insert)
2748 (funcall this-original-command))
789d1bf0
KS
2749 (t
2750 (delete-backward-char (prefix-numeric-value count)))))
2751
2752(defun ido-delete-backward-word-updir (count)
2753 "Delete all chars backwards, or at beginning of buffer, go up one level."
2754 (interactive "P")
2755 (if (= (minibuffer-prompt-end) (point))
2756 (if (not count)
2757 (ido-up-directory t))
f0a73ccc
KS
2758 (if (eq this-original-command 'viper-delete-backward-word)
2759 (funcall this-original-command (prefix-numeric-value count))
2760 (backward-kill-word (prefix-numeric-value count)))))
789d1bf0
KS
2761
2762(defun ido-get-work-directory (&optional incr must-match)
2763 (let ((n (length ido-work-directory-list))
2764 (i ido-work-directory-index)
2765 (j 0)
2766 dir)
2767 (if (or (not ido-text) (= (length ido-text) 0))
2768 (setq must-match nil))
2769 (while (< j n)
2770 (setq i (+ i incr)
2771 j (1+ j))
2772 (if (> incr 0)
2773 (if (>= i n) (setq i 0))
2774 (if (< i 0) (setq i (1- n))))
2775 (setq dir (nth i ido-work-directory-list))
2776 (if (and dir
2777 (not (equal dir ido-current-directory))
2778 (file-directory-p dir)
2779 (or (not must-match)
cb65c373 2780 ;; TODO. check for nonreadable and too-big.
ec441ab5 2781 (ido-set-matches-1
789d1bf0 2782 (if (eq ido-cur-item 'file)
ec441ab5
KS
2783 (ido-make-file-list-1 dir)
2784 (ido-make-dir-list-1 dir)))))
789d1bf0
KS
2785 (setq j n)
2786 (setq dir nil)))
2787 (if dir
2788 (setq ido-work-directory-index i))
2789 dir))
2790
2791(defun ido-prev-work-directory ()
2792 "Change to next working directory in list."
2793 (interactive)
2794 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2795 (when dir
2796 (ido-set-current-directory dir)
2797 (setq ido-exit 'refresh)
2798 (setq ido-text-init ido-text)
2799 (setq ido-rotate-temp t)
2800 (exit-minibuffer))))
2801
2802(defun ido-next-work-directory ()
2803 "Change to previous working directory in list."
2804 (interactive)
2805 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2806 (when dir
2807 (ido-set-current-directory dir)
2808 (setq ido-exit 'refresh)
2809 (setq ido-text-init ido-text)
2810 (setq ido-rotate-temp t)
2811 (exit-minibuffer))))
2812
2813(defun ido-merge-work-directories ()
2814 "Search (and merge) work directories for files matching the current input string."
2815 (interactive)
2816 (setq ido-use-merged-list t ido-try-merged-list t)
2817 (setq ido-exit 'refresh)
2818 (setq ido-text-init ido-text)
2819 (setq ido-rotate-temp t)
2820 (exit-minibuffer))
2821
2822(defun ido-wide-find-file (&optional file)
2823 "Prompt for FILE to search for using find, starting from current directory."
2824 (interactive)
2825 (unless file
b0df3884
KS
2826 (let ((enable-recursive-minibuffers t))
2827 (setq file
3729cc87
KS
2828 (condition-case nil
2829 (read-string (concat "Wide find file: " ido-current-directory) ido-text)
2830 (quit "")))))
789d1bf0
KS
2831 (when (> (length file) 0)
2832 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2833 (setq ido-exit 'refresh)
2834 (setq ido-text-init file)
2835 (setq ido-rotate-temp t)
2836 (exit-minibuffer)))
2837
2838(defun ido-wide-find-dir (&optional dir)
2839 "Prompt for DIR to search for using find, starting from current directory."
2840 (interactive)
2841 (unless dir
b0df3884
KS
2842 (let ((enable-recursive-minibuffers t))
2843 (setq dir
3729cc87
KS
2844 (condition-case nil
2845 (read-string (concat "Wide find directory: " ido-current-directory) ido-text)
2846 (quit "")))))
789d1bf0
KS
2847 (when (> (length dir) 0)
2848 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2849 (setq ido-exit 'refresh)
2850 (setq ido-text-init (ido-final-slash dir t))
2851 (setq ido-rotate-temp t)
2852 (exit-minibuffer)))
2853
ae9d279d
KS
2854(defun ido-wide-find-dir-or-delete-dir (&optional dir)
2855 "Prompt for DIR to search for using find, starting from current directory.
2856If input stack is non-empty, delete current directory component."
2857 (interactive)
2858 (if ido-input-stack
2859 (ido-delete-backward-word-updir 1)
2860 (ido-wide-find-dir)))
2861
a3f4d4d4
KS
2862(defun ido-take-first-match ()
2863 "Use first matching item as input text."
2864 (interactive)
2865 (when ido-matches
5a1b28a4 2866 (setq ido-text-init (ido-name (car ido-matches)))
a3f4d4d4
KS
2867 (setq ido-exit 'refresh)
2868 (exit-minibuffer)))
2869
3729cc87
KS
2870(defun ido-push-dir ()
2871 "Move to previous directory in file name, push current input on stack."
2872 (interactive)
2873 (setq ido-exit 'push)
2874 (exit-minibuffer))
2875
a3f4d4d4
KS
2876(defun ido-push-dir-first ()
2877 "Move to previous directory in file name, push first match on stack."
2878 (interactive)
2879 (if ido-matches
5a1b28a4 2880 (setq ido-text (ido-name (car ido-matches))))
a3f4d4d4
KS
2881 (setq ido-exit 'push)
2882 (exit-minibuffer))
2883
3729cc87
KS
2884(defun ido-pop-dir (arg)
2885 "Pop directory from input stack back to input.
2886With \\[universal-argument], pop all element."
2887 (interactive "P")
2888 (when ido-input-stack
2889 (setq ido-exit (if arg 'pop-all 'pop))
2890 (exit-minibuffer)))
2891
2892(defun ido-wide-find-file-or-pop-dir (arg)
2893 (interactive "P")
2894 (if ido-input-stack
2895 (ido-pop-dir arg)
2896 (ido-wide-find-file)))
2897
789d1bf0
KS
2898(defun ido-make-directory (&optional dir)
2899 "Prompt for DIR to create in current directory."
2900 (interactive)
2901 (unless dir
b0df3884
KS
2902 (let ((enable-recursive-minibuffers t))
2903 (setq dir
2904 (read-string (concat "Make directory: " ido-current-directory) ido-text))))
789d1bf0
KS
2905 (when (> (length dir) 0)
2906 (setq dir (concat ido-current-directory dir))
2907 (unless (file-exists-p dir)
2908 (make-directory dir t)
2909 (ido-set-current-directory dir)
2910 (setq ido-exit 'refresh)
2911 (setq ido-text-init nil)
2912 (setq ido-rotate-temp t)
2913 (exit-minibuffer))))
2914
2915(defun ido-get-work-file (incr)
2916 (let ((n (length ido-work-file-list))
2917 (i (+ ido-work-file-index incr))
2918 name)
2919 (if (> incr 0)
2920 (if (>= i n) (setq i 0))
2921 (if (< i 0) (setq i (1- n))))
2922 (setq name (nth i ido-work-file-list))
2923 (setq ido-work-file-index i)
2924 name))
2925
2926(defun ido-prev-work-file ()
2927 "Change to next working file name in list."
2928 (interactive)
2929 (let ((name (ido-get-work-file 1)))
2930 (when name
2931 (setq ido-text-init name)
2932 (setq ido-exit 'refresh)
2933 (exit-minibuffer))))
2934
2935(defun ido-next-work-file ()
2936 "Change to previous working file name in list."
2937 (interactive)
2938 (let ((name (ido-get-work-file -1)))
2939 (when name
2940 (setq ido-text-init name)
2941 (setq ido-exit 'refresh)
2942 (exit-minibuffer))))
2943
2944(defun ido-copy-current-file-name (all)
2945 "Insert file name of current buffer.
2946If repeated, insert text from buffer instead."
2947 (interactive "P")
bac4dbd1
KS
2948 (let* ((bfname (or (buffer-file-name ido-entry-buffer)
2949 (buffer-name ido-entry-buffer)))
84f6c6d0 2950 (name (and bfname (file-name-nondirectory bfname))))
789d1bf0 2951 (when name
71296446
JB
2952 (setq ido-text-init
2953 (if (or all
2490c740 2954 (eq last-command this-command)
84f6c6d0 2955 (not (equal (file-name-directory bfname) ido-current-directory))
789d1bf0
KS
2956 (not (string-match "\\.[^.]*\\'" name)))
2957 name
2958 (substring name 0 (1+ (match-beginning 0)))))
2959 (setq ido-exit 'refresh
2960 ido-try-merged-list nil)
2961 (exit-minibuffer))))
71296446 2962
789d1bf0 2963(defun ido-copy-current-word (all)
362cdb61 2964 "Insert current word (file or directory name) from current buffer."
789d1bf0
KS
2965 (interactive "P")
2966 (let ((word (save-excursion
2967 (set-buffer ido-entry-buffer)
2968 (let ((p (point)) start-line end-line start-name name)
1b5929b9
KS
2969 (if (and mark-active (/= p (mark)))
2970 (setq start-name (mark))
2971 (beginning-of-line)
2972 (setq start-line (point))
2973 (end-of-line)
2974 (setq end-line (point))
2975 (goto-char p)
2976 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
2977 (forward-char 1))
2978 (setq start-name (point))
2979 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
2980 (if (= start-name (point))
2981 (setq start-name nil)))
2982 (and start-name
2983 (buffer-substring-no-properties start-name (point)))))))
789d1bf0
KS
2984 (if (cond
2985 ((not word) nil)
2986 ((string-match "\\`[~/]" word)
2987 (setq ido-text-init word
2988 ido-try-merged-list nil
2989 ido-exit 'chdir))
2990 ((string-match "/" word)
2991 (setq ido-text-init (concat ido-current-directory word)
2992 ido-try-merged-list nil
2993 ido-exit 'chdir))
2994 (t
2995 (setq ido-text-init word
2996 ido-try-merged-list nil
2997 ido-exit 'refresh)))
2998 (exit-minibuffer))))
2999
71296446 3000(defun ido-next-match ()
789d1bf0
KS
3001 "Put first element of `ido-matches' at the end of the list."
3002 (interactive)
3003 (if ido-matches
3004 (let ((next (cadr ido-matches)))
3005 (setq ido-cur-list (ido-chop ido-cur-list next))
3006 (setq ido-rescan t)
3007 (setq ido-rotate t))))
3008
71296446 3009(defun ido-prev-match ()
789d1bf0
KS
3010 "Put last element of `ido-matches' at the front of the list."
3011 (interactive)
3012 (if ido-matches
3013 (let ((prev (car (last ido-matches))))
3014 (setq ido-cur-list (ido-chop ido-cur-list prev))
3015 (setq ido-rescan t)
3016 (setq ido-rotate t))))
3017
71296446 3018(defun ido-next-match-dir ()
789d1bf0
KS
3019 "Find next directory in match list.
3020If work directories have been merged, cycle through directories for
3021first matching file."
3022 (interactive)
3023 (if ido-use-merged-list
3024 (if ido-matches
3025 (let* ((elt (car ido-matches))
3026 (dirs (cdr elt)))
3027 (when (> (length dirs) 1)
3028 (setcdr elt (ido-chop dirs (cadr dirs))))
3029 (setq ido-rescan nil)))
3030 (let ((cnt (length ido-matches))
3031 (i 1))
3032 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
3033 (setq i (1+ i)))
3034 (if (< i cnt)
3035 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3036
71296446 3037(defun ido-prev-match-dir ()
789d1bf0
KS
3038 "Find previous directory in match list.
3039If work directories have been merged, cycle through directories
3040for first matching file."
3041 (interactive)
3042 (if ido-use-merged-list
3043 (if ido-matches
3044 (let* ((elt (car ido-matches))
3045 (dirs (cdr elt)))
3046 (when (> (length dirs) 1)
3047 (setcdr elt (ido-chop dirs (car (last dirs)))))
3048 (setq ido-rescan nil)))
3049 (let* ((cnt (length ido-matches))
3050 (i (1- cnt)))
3051 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
3052 (setq i (1- i)))
3053 (if (> i 0)
3054 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3055
71296446 3056(defun ido-restrict-to-matches ()
08bfde76
KS
3057 "Set current item list to the currently matched items."
3058 (interactive)
3059 (when ido-matches
3060 (setq ido-cur-list ido-matches
3061 ido-text-init ""
3062 ido-rescan nil
3063 ido-exit 'keep)
3064 (exit-minibuffer)))
3065
789d1bf0
KS
3066(defun ido-chop (items elem)
3067 "Remove all elements before ELEM and put them at the end of ITEMS."
3068 (let ((ret nil)
3069 (next nil)
3070 (sofar nil))
3071 (while (not ret)
3072 (setq next (car items))
3073 (if (equal next elem)
3074 (setq ret (append items (nreverse sofar)))
3075 ;; else
3076 (progn
3077 (setq items (cdr items))
3078 (setq sofar (cons next sofar)))))
3079 ret))
3080
3081(defun ido-name (item)
3082 ;; Return file name for current item, whether in a normal list
3083 ;; or a merged work directory list.
3084 (if (consp item) (car item) item))
3085
3086
3087;;; CREATE LIST OF ALL CURRENT FILES
3088
3089(defun ido-all-completions ()
3090 ;; Return unsorted list of all competions.
cb65c373
KS
3091 (let ((ido-process-ignore-lists nil)
3092 (ido-directory-too-big nil))
789d1bf0
KS
3093 (cond
3094 ((eq ido-cur-item 'file)
ec441ab5 3095 (ido-make-file-list-1 ido-current-directory))
789d1bf0 3096 ((eq ido-cur-item 'dir)
ec441ab5 3097 (ido-make-dir-list-1 ido-current-directory))
789d1bf0 3098 ((eq ido-cur-item 'buffer)
ec441ab5 3099 (ido-make-buffer-list-1))
db9f395b
KS
3100 ((eq ido-cur-item 'list)
3101 ido-choice-list)
789d1bf0
KS
3102 (t nil))))
3103
3104
1de0ae85
KS
3105;; File list sorting
3106
3107(defun ido-file-lessp (a b)
3108 ;; Simple compare two file names.
3109 (string-lessp (ido-no-final-slash a) (ido-no-final-slash b)))
3110
3111
3112(defun ido-file-extension-lessp (a b)
3113 ;; Compare file names according to ido-file-extensions-order list.
3114 (let ((n (compare-strings a 0 nil b 0 nil nil))
3115 lessp p)
3116 (if (eq n t)
3117 nil
3118 (if (< n 0)
3119 (setq n (1- (- n))
3120 p a a b b p
3121 lessp t)
3122 (setq n (1- n)))
3123 (cond
3124 ((= n 0)
3125 lessp)
3126 ((= (aref a n) ?.)
3127 (ido-file-extension-aux a b n lessp))
3128 (t
3129 (while (and (> n 2) (/= (aref a n) ?.))
3130 (setq n (1- n)))
3131 (if (> n 1)
3132 (ido-file-extension-aux a b n lessp)
3133 lessp))))))
3134
3135(defun ido-file-extension-aux (a b n lessp)
3136 (let ((oa (ido-file-extension-order a n))
3137 (ob (ido-file-extension-order b n)))
3138 (cond
1de0ae85 3139 ((and oa ob)
76a63a6e
KS
3140 (cond
3141 ((= oa ob)
3142 lessp)
3143 (lessp
3144 (> oa ob))
3145 (t
3146 (< oa ob))))
1de0ae85
KS
3147 (oa
3148 (not lessp))
3149 (ob
3150 lessp)
3151 (t
3152 lessp))))
3153
3154(defun ido-file-extension-order (s n)
3155 (let ((l ido-file-extensions-order)
3156 (i 0) o do)
3157 (while l
3158 (cond
3159 ((eq (car l) t)
3160 (setq do i
3161 l (cdr l)))
3162 ((eq (compare-strings s n nil (car l) 0 nil nil) t)
3163 (setq o i
3164 l nil))
3165 (t
3166 (setq l (cdr l))))
3167 (setq i (1+ i)))
3168 (or o do)))
3169
789d1bf0
KS
3170
3171(defun ido-sort-merged-list (items promote)
3172 ;; Input is list of ("file" . "dir") cons cells.
3173 ;; Output is sorted list of ("file "dir" ...) lists
3174 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
3175 res a cur dirs)
3176 (while l
3177 (setq a (car l)
3178 l (cdr l))
3179 (if (and res (string-equal (car (car res)) (car a)))
3180 (progn
3181 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
3182 (if (and promote (string-equal ido-current-directory (cdr a)))
3183 (setq cur t)))
3184 (setq res (cons (list (car a) (cdr a)) res)
3185 cur nil)))
3186 res))
3187
3188(defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
3189 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
71296446
JB
3190 (let ((filenames
3191 (split-string
789d1bf0 3192 (shell-command-to-string
ec579201
KS
3193 (concat "find "
3194 (shell-quote-argument dir)
3195 " -name "
3196 (shell-quote-argument
3197 (concat (if prefix "" "*") file "*"))
3198 " -type " (if finddir "d" "f") " -print"))))
84f6c6d0 3199 filename d f
789d1bf0 3200 res)
84f6c6d0
KS
3201 (while filenames
3202 (setq filename (car filenames)
3203 filenames (cdr filenames))
3204 (if (and (string-match "^/" filename)
3205 (file-exists-p filename))
3206 (setq d (file-name-directory filename)
3207 f (file-name-nondirectory filename)
789d1bf0
KS
3208 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
3209 res))
3210
3211(defun ido-flatten-merged-list (items)
362cdb61 3212 ;; Create a list of directory names based on a merged directory list.
789d1bf0
KS
3213 (let (res)
3214 (while items
3215 (let* ((item (car items))
3216 (file (car item))
3217 (dirs (cdr item)))
3218 (while dirs
3219 (setq res (cons (concat (car dirs) file) res)
3220 dirs (cdr dirs))))
3221 (setq items (cdr items)))
3222 res))
3223
ec441ab5
KS
3224
3225(defun ido-make-merged-file-list-1 (text auto wide)
789d1bf0 3226 (let (res)
ec441ab5
KS
3227 (if (and (ido-final-slash text) ido-dir-file-cache)
3228 (if wide
3229 (setq res (ido-wide-find-dirs-or-files
3230 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
3231 ;; Use list of cached directories
3232 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
3233 (dirs ido-dir-file-cache)
3234 dir b d f)
3235 (if nil ;; simple
3236 (while dirs
3237 (setq dir (car (car dirs))
3238 dirs (cdr dirs))
3239 (when (and (string-match re dir)
3240 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
3241 (file-directory-p dir))
3242 (setq b (substring dir 0 -1)
3243 f (concat (file-name-nondirectory b) "/")
3244 d (file-name-directory b)
3245 res (cons (cons f d) res))))
789d1bf0
KS
3246 (while dirs
3247 (setq dir (car dirs)
ec441ab5 3248 d (car dir)
789d1bf0 3249 dirs (cdr dirs))
ec441ab5
KS
3250 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
3251 (setq dir (cdr (cdr dir)))
3252 (while dir
3253 (setq f (car dir)
3254 dir (cdr dir))
3255 (if (and (string-match re f)
3256 (not (ido-ignore-item-p f ido-ignore-directories)))
3257 (setq res (cons (cons f d) res)))))
789d1bf0
KS
3258 (if (and auto (input-pending-p))
3259 (setq dirs nil
3260 res t))))))
ec441ab5
KS
3261 (if wide
3262 (setq res (ido-wide-find-dirs-or-files
3263 ido-current-directory text ido-enable-prefix nil))
3264 (let ((ido-text text)
3265 (dirs ido-work-directory-list)
3266 (must-match (and text (> (length text) 0)))
3267 dir fl)
3268 (if (and auto (not (member ido-current-directory dirs)))
3269 (setq dirs (cons ido-current-directory dirs)))
3270 (while dirs
3271 (setq dir (car dirs)
3272 dirs (cdr dirs))
3273 (when (and dir (stringp dir)
3274 (or ido-merge-ftp-work-directories
3275 (not (ido-is-ftp-directory dir)))
3276 (file-directory-p dir)
3277 ;; TODO. check for nonreadable and too-big.
3278 (setq fl (if (eq ido-cur-item 'file)
3279 (ido-make-file-list-1 dir t)
3280 (ido-make-dir-list-1 dir t))))
3281 (if must-match
3282 (setq fl (ido-set-matches-1 fl)))
3283 (if fl
3284 (setq res (nconc fl res))))
3285 (if (and auto (input-pending-p))
3286 (setq dirs nil
3287 res t))))))
3288 res))
3289
3290(defun ido-make-merged-file-list (text auto wide)
3291 (let (res)
3292 (message "Searching for `%s'...." text)
3293 (condition-case nil
edc42f56
KS
3294 (if (eq t (setq res
3295 (while-no-input
3296 (ido-make-merged-file-list-1 text auto wide))))
3297 (setq res 'input-pending-p))
ec441ab5
KS
3298 (quit
3299 (setq res t
3300 ido-try-merged-list nil
3301 ido-use-merged-list nil)))
3302 (when (and res (listp res))
3303 (setq res (ido-sort-merged-list res auto)))
9a08196a 3304 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
e20b3173 3305 (listp res)
9a08196a
KS
3306 (> (length text) 0))
3307 (let ((elt (assoc text res)))
4e85a733 3308 (when (and elt (not (eq elt (car res))))
9a08196a
KS
3309 (setq res (delq elt res))
3310 (setq res (cons elt res)))))
789d1bf0
KS
3311 (message nil)
3312 res))
3313
ec441ab5 3314(defun ido-make-buffer-list-1 (&optional frame visible)
789d1bf0 3315 ;; Return list of non-ignored buffer names
71296446 3316 (delq nil
789d1bf0
KS
3317 (mapcar
3318 (lambda (x)
3319 (let ((name (buffer-name x)))
69beb26d 3320 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
789d1bf0
KS
3321 name)))
3322 (buffer-list frame))))
3323
3324(defun ido-make-buffer-list (default)
3325 ;; Return the current list of buffers.
3326 ;; Currently visible buffers are put at the end of the list.
616e8e5f 3327 ;; The hook `ido-make-buffer-list-hook' is run after the list has been
789d1bf0
KS
3328 ;; created to allow the user to further modify the order of the buffer names
3329 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
3330 ;; it is put to the start of the list.
3331 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
ec441ab5 3332 (ido-temp-list (ido-make-buffer-list-1 (selected-frame) ido-current-buffers)))
789d1bf0
KS
3333 (if ido-temp-list
3334 (nconc ido-temp-list ido-current-buffers)
3335 (setq ido-temp-list ido-current-buffers))
3336 (if default
3337 (progn
71296446 3338 (setq ido-temp-list
789d1bf0 3339 (delete default ido-temp-list))
71296446 3340 (setq ido-temp-list
789d1bf0
KS
3341 (cons default ido-temp-list))))
3342 (run-hooks 'ido-make-buffer-list-hook)
3343 ido-temp-list))
3344
db9f395b
KS
3345(defun ido-make-choice-list (default)
3346 ;; Return the current list of choices.
3347 ;; If DEFAULT is non-nil, and corresponds to an element of choices,
3348 ;; it is put to the start of the list.
3349 (let ((ido-temp-list ido-choice-list))
3350 (if default
3351 (progn
3352 (setq ido-temp-list
3353 (delete default ido-temp-list))
3354 (setq ido-temp-list
3355 (cons default ido-temp-list))))
3356 ; (run-hooks 'ido-make-choice-list-hook)
3357 ido-temp-list))
3358
789d1bf0
KS
3359(defun ido-to-end (items)
3360 ;; Move the elements from ITEMS to the end of `ido-temp-list'
db99576a 3361 (mapc
71296446 3362 (lambda (elem)
789d1bf0
KS
3363 (setq ido-temp-list (delq elem ido-temp-list)))
3364 items)
3365 (if ido-temp-list
3366 (nconc ido-temp-list items)
3367 (setq ido-temp-list items)))
3368
2c52d7a3 3369(declare-function tramp-tramp-file-p "tramp" (name))
004a00f4 3370
ec441ab5 3371(defun ido-file-name-all-completions-1 (dir)
a70343bd 3372 (cond
866f2239 3373 ((ido-nonreadable-directory-p dir) '())
cb65c373
KS
3374 ;; do not check (ido-directory-too-big-p dir) here.
3375 ;; Caller must have done that if necessary.
c577a4d2 3376
a70343bd 3377 ((and ido-enable-tramp-completion
d9e43b70 3378 (or (fboundp 'tramp-completion-mode-p)
c577a4d2
KS
3379 (require 'tramp nil t))
3380 (string-match "\\`/[^/]+[:@]\\'" dir))
3381 ;; Strip method:user@host: part of tramp completions.
3382 ;; Tramp completions do not include leading slash.
d9e43b70
MA
3383 (let* ((len (1- (length dir)))
3384 (tramp-completion-mode t)
3385 (compl
3386 (or (file-name-all-completions "" dir)
3387 ;; work around bug in ange-ftp.
3388 ;; /ftp:user@host: => nil
3389 ;; /ftp:user@host:./ => ok
3390 (and
3391 (not (string= "/ftp:" dir))
3392 (tramp-tramp-file-p dir)
3393 (fboundp 'tramp-ftp-file-name-p)
3394 (funcall 'tramp-ftp-file-name-p dir)
3395 (string-match ":\\'" dir)
3396 (file-name-all-completions "" (concat dir "./"))))))
c577a4d2
KS
3397 (if (and compl
3398 (> (length (car compl)) len)
3399 (string= (substring (car compl) 0 len) (substring dir 1)))
a70343bd
KS
3400 (mapcar (lambda (c) (substring c len)) compl)
3401 compl)))
3402 (t
3403 (file-name-all-completions "" dir))))
bad111c2 3404
789d1bf0
KS
3405(defun ido-file-name-all-completions (dir)
3406 ;; Return name of all files in DIR
3407 ;; Uses and updates ido-dir-file-cache
dfebc0ae
KS
3408 (cond
3409 ((ido-is-unc-root dir)
3410 (mapcar
3411 (lambda (host)
3412 (if (string-match "/\\'" host) host (concat host "/")))
4c2ee078 3413 (ido-unc-hosts t)))
dfebc0ae
KS
3414 ((and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
3415 (stringp dir) (> (length dir) 0)
3416 (ido-may-cache-directory dir))
3417 (let* ((cached (assoc dir ido-dir-file-cache))
71296446 3418 (ctime (nth 1 cached))
789d1bf0 3419 (ftp (ido-is-ftp-directory dir))
dfebc0ae
KS
3420 (unc (ido-is-unc-host dir))
3421 (attr (if (or ftp unc) nil (file-attributes dir)))
789d1bf0
KS
3422 (mtime (nth 5 attr))
3423 valid)
3424 (when cached ; should we use the cached entry ?
dfebc0ae
KS
3425 (cond
3426 (ftp
3427 (setq valid (and (eq (car ctime) 'ftp)
3428 (ido-cache-ftp-valid (cdr ctime)))))
3429 (unc
3430 (setq valid (and (eq (car ctime) 'unc)
3431 (ido-cache-unc-valid (cdr ctime)))))
3432 (t
789d1bf0
KS
3433 (if attr
3434 (setq valid (and (= (car ctime) (car mtime))
dfebc0ae
KS
3435 (= (car (cdr ctime)) (car (cdr mtime))))))))
3436 (unless valid
3437 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
3438 cached nil)))
789d1bf0 3439 (unless cached
dfebc0ae
KS
3440 (cond
3441 (unc
3442 (setq mtime (cons 'unc (ido-time-stamp))))
3443 ((and ftp (file-readable-p dir))
3444 (setq mtime (cons 'ftp (ido-time-stamp)))))
789d1bf0 3445 (if mtime
ec441ab5 3446 (setq cached (cons dir (cons mtime (ido-file-name-all-completions-1 dir)))
789d1bf0
KS
3447 ido-dir-file-cache (cons cached ido-dir-file-cache)))
3448 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
3449 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
3450 (and cached
dfebc0ae
KS
3451 (cdr (cdr cached)))))
3452 (t
3453 (ido-file-name-all-completions-1 dir))))
789d1bf0
KS
3454
3455(defun ido-remove-cached-dir (dir)
3456 ;; Remove dir from ido-dir-file-cache
3457 (if (and ido-dir-file-cache
3458 (stringp dir) (> (length dir) 0))
3459 (let ((cached (assoc dir ido-dir-file-cache)))
3460 (if cached
3461 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
3462
3463
ec441ab5 3464(defun ido-make-file-list-1 (dir &optional merged)
789d1bf0
KS
3465 ;; Return list of non-ignored files in DIR
3466 ;; If MERGED is non-nil, each file is cons'ed with DIR
dfebc0ae
KS
3467 (and (or (ido-is-tramp-root dir) (ido-is-unc-root dir)
3468 (file-directory-p dir))
71296446 3469 (delq nil
789d1bf0
KS
3470 (mapcar
3471 (lambda (name)
3472 (if (not (ido-ignore-item-p name ido-ignore-files t))
3473 (if merged (cons name dir) name)))
3474 (ido-file-name-all-completions dir)))))
3475
3476(defun ido-make-file-list (default)
3477 ;; Return the current list of files.
3478 ;; Currently visible files are put at the end of the list.
71296446 3479 ;; The hook `ido-make-file-list-hook' is run after the list has been
789d1bf0
KS
3480 ;; created to allow the user to further modify the order of the file names
3481 ;; in this list.
ec441ab5 3482 (let ((ido-temp-list (ido-make-file-list-1 ido-current-directory)))
1de0ae85
KS
3483 (setq ido-temp-list (sort ido-temp-list
3484 (if ido-file-extensions-order
3485 #'ido-file-extension-lessp
3486 #'ido-file-lessp)))
c577a4d2
KS
3487 (unless (ido-is-tramp-root ido-current-directory)
3488 (let ((default-directory ido-current-directory))
3489 (ido-to-end ;; move ftp hosts and visited files to end
3490 (delq nil (mapcar
10b19e88
KS
3491 (lambda (x) (if (or (and (string-match ".:\\'" x)
3492 (not (ido-local-file-exists-p x)))
c577a4d2 3493 (and (not (ido-final-slash x))
10b19e88
KS
3494 (let (file-name-handler-alist)
3495 (get-file-buffer x)))) x))
c577a4d2 3496 ido-temp-list)))))
789d1bf0 3497 (ido-to-end ;; move . files to end
71296446 3498 (delq nil (mapcar
789d1bf0
KS
3499 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3500 ido-temp-list)))
3501 (if (and default (member default ido-temp-list))
3502 (if (or ido-rotate-temp ido-rotate-file-list-default)
3503 (unless (equal default (car ido-temp-list))
3504 (let ((l ido-temp-list) k)
3505 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3506 (setq l (cdr l)))
3507 (setq k (cdr l))
3508 (setcdr l nil)
3509 (nconc k ido-temp-list)
3510 (setq ido-temp-list k)))
71296446 3511 (setq ido-temp-list
789d1bf0 3512 (delete default ido-temp-list))
71296446 3513 (setq ido-temp-list
789d1bf0
KS
3514 (cons default ido-temp-list))))
3515 (when ido-show-dot-for-dired
3516 (setq ido-temp-list (delete "." ido-temp-list))
3517 (setq ido-temp-list (cons "." ido-temp-list)))
3518 (run-hooks 'ido-make-file-list-hook)
3519 ido-temp-list))
3520
ec441ab5 3521(defun ido-make-dir-list-1 (dir &optional merged)
789d1bf0
KS
3522 ;; Return list of non-ignored subdirs in DIR
3523 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
bad111c2 3524 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
71296446 3525 (delq nil
789d1bf0
KS
3526 (mapcar
3527 (lambda (name)
3528 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
3529 (if merged (cons name dir) name)))
3530 (ido-file-name-all-completions dir)))))
3531
3532(defun ido-make-dir-list (default)
3533 ;; Return the current list of directories.
71296446 3534 ;; The hook `ido-make-dir-list-hook' is run after the list has been
789d1bf0
KS
3535 ;; created to allow the user to further modify the order of the
3536 ;; directory names in this list.
ec441ab5 3537 (let ((ido-temp-list (ido-make-dir-list-1 ido-current-directory)))
1de0ae85 3538 (setq ido-temp-list (sort ido-temp-list #'ido-file-lessp))
789d1bf0 3539 (ido-to-end ;; move . files to end
71296446 3540 (delq nil (mapcar
789d1bf0
KS
3541 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3542 ido-temp-list)))
3543 (if (and default (member default ido-temp-list))
3544 (if (or ido-rotate-temp ido-rotate-file-list-default)
3545 (unless (equal default (car ido-temp-list))
3546 (let ((l ido-temp-list) k)
3547 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3548 (setq l (cdr l)))
3549 (setq k (cdr l))
3550 (setcdr l nil)
3551 (nconc k ido-temp-list)
3552 (setq ido-temp-list k)))
71296446 3553 (setq ido-temp-list
789d1bf0 3554 (delete default ido-temp-list))
71296446 3555 (setq ido-temp-list
789d1bf0
KS
3556 (cons default ido-temp-list))))
3557 (setq ido-temp-list (delete "." ido-temp-list))
3729cc87
KS
3558 (unless ido-input-stack
3559 (setq ido-temp-list (cons "." ido-temp-list)))
789d1bf0
KS
3560 (run-hooks 'ido-make-dir-list-hook)
3561 ido-temp-list))
3562
3563;; List of the files visible in the current frame.
3564(defvar ido-bufs-in-frame)
3565
3566(defun ido-get-buffers-in-frames (&optional current)
3567 ;; Return the list of buffers that are visible in the current frame.
3568 ;; If optional argument `current' is given, restrict searching to the
3569 ;; current frame, rather than all frames, regardless of value of
3570 ;; `ido-all-frames'.
3571 (let ((ido-bufs-in-frame nil))
3572 (walk-windows 'ido-get-bufname nil
71296446 3573 (if current
789d1bf0
KS
3574 nil
3575 ido-all-frames))
3576 ido-bufs-in-frame))
3577
3578(defun ido-get-bufname (win)
3579 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
3580 (let ((buf (buffer-name (window-buffer win))))
69beb26d
KS
3581 (unless (or (member buf ido-bufs-in-frame)
3582 (member buf ido-ignore-item-temp-list))
3583 ;; Only add buf if it is not already in list.
3584 ;; This prevents same buf in two different windows being
3585 ;; put into the list twice.
3586 (setq ido-bufs-in-frame
3587 (cons buf ido-bufs-in-frame)))))
789d1bf0
KS
3588
3589;;; FIND MATCHING ITEMS
3590
ec441ab5 3591(defun ido-set-matches-1 (items &optional do-full)
789d1bf0
KS
3592 ;; Return list of matches in items
3593 (let* ((case-fold-search ido-case-fold)
bad111c2
KS
3594 (slash (and (not ido-enable-prefix) (ido-final-slash ido-text)))
3595 (text (if slash (substring ido-text 0 -1) ido-text))
5444f278
KS
3596 (rex0 (if ido-enable-regexp text (regexp-quote text)))
3597 (rexq (concat rex0 (if slash ".*/" "")))
789d1bf0 3598 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
5444f278
KS
3599 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" rex0))
3600 (concat "\\`" rex0 (if slash "/" "") "\\'")))
3601 (suffix-re (and do-full slash
3602 (not ido-enable-regexp) (not (string-match "\$\\'" rex0))
3603 (concat rex0 "/\\'")))
789d1bf0
KS
3604 (prefix-re (and full-re (not ido-enable-prefix)
3605 (concat "\\`" rexq)))
6d8b6cbd
KS
3606 (non-prefix-dot (or (not ido-enable-dot-prefix)
3607 (not ido-process-ignore-lists)
3608 ido-enable-prefix
3609 (= (length ido-text) 0)))
5444f278 3610 full-matches suffix-matches prefix-matches matches)
665ed61a
KS
3611 (setq ido-incomplete-regexp nil)
3612 (condition-case error
db99576a 3613 (mapc
665ed61a
KS
3614 (lambda (item)
3615 (let ((name (ido-name item)))
5444f278
KS
3616 (if (and (or non-prefix-dot
3617 (if (= (aref ido-text 0) ?.)
3618 (= (aref name 0) ?.)
3619 (/= (aref name 0) ?.)))
3620 (string-match re name))
3621 (cond
39449da0 3622 ((and (eq ido-cur-item 'buffer)
3d37467b
KS
3623 (or (not (stringp ido-default-item))
3624 (not (string= name ido-default-item)))
39449da0
KS
3625 (string= name (buffer-name ido-entry-buffer)))
3626 (setq matches (cons item matches)))
5444f278
KS
3627 ((and full-re (string-match full-re name))
3628 (setq full-matches (cons item full-matches)))
3629 ((and suffix-re (string-match suffix-re name))
3630 (setq suffix-matches (cons item suffix-matches)))
3631 ((and prefix-re (string-match prefix-re name))
3632 (setq prefix-matches (cons item prefix-matches)))
3633 (t (setq matches (cons item matches))))))
3634 t)
665ed61a
KS
3635 items)
3636 (invalid-regexp
3637 (setq ido-incomplete-regexp t
3638 ;; Consider the invalid regexp message internally as a
3639 ;; special-case single match, and handle appropriately
3640 ;; elsewhere.
3641 matches (cdr error))))
5444f278
KS
3642 (when prefix-matches
3643 (ido-trace "prefix match" prefix-matches)
3644 (setq matches (nconc prefix-matches matches)))
3645 (when suffix-matches
3646 (ido-trace "suffix match" (list text suffix-re suffix-matches))
3647 (setq matches (nconc suffix-matches matches)))
3648 (when full-matches
3649 (ido-trace "full match" (list text full-re full-matches))
3650 (setq matches (nconc full-matches matches)))
789d1bf0
KS
3651 (when (and (null matches)
3652 ido-enable-flex-matching
3653 (> (length ido-text) 1)
3654 (not ido-enable-regexp))
9066a4d0 3655 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
789d1bf0
KS
3656 (if ido-enable-prefix
3657 (setq re (concat "\\`" re)))
db99576a 3658 (mapc
789d1bf0
KS
3659 (lambda (item)
3660 (let ((name (ido-name item)))
3661 (if (string-match re name)
3662 (setq matches (cons item matches)))))
3663 items))
3664 matches))
71296446 3665
789d1bf0
KS
3666
3667(defun ido-set-matches ()
3668 ;; Set `ido-matches' to the list of items matching prompt
3669 (when ido-rescan
ec441ab5 3670 (setq ido-matches (ido-set-matches-1 (reverse ido-cur-list) (not ido-rotate))
789d1bf0 3671 ido-rotate nil)))
71296446 3672
789d1bf0
KS
3673(defun ido-ignore-item-p (name re-list &optional ignore-ext)
3674 ;; Return t if the buffer or file NAME should be ignored.
69beb26d
KS
3675 (or (member name ido-ignore-item-temp-list)
3676 (and
3677 ido-process-ignore-lists re-list
d6049c78
KS
3678 (save-match-data
3679 (let ((ext-list (and ignore-ext ido-ignore-extensions
789d1bf0 3680 completion-ignored-extensions))
d6049c78
KS
3681 (case-fold-search ido-case-fold)
3682 ignorep nextstr
3683 (flen (length name)) slen)
3684 (while ext-list
3685 (setq nextstr (car ext-list))
3686 (if (cond
3687 ((stringp nextstr)
3688 (and (>= flen (setq slen (length nextstr)))
3689 (string-equal (substring name (- flen slen)) nextstr)))
bf8b0f8b 3690 ((functionp nextstr) (funcall nextstr name))
d6049c78
KS
3691 (t nil))
3692 (setq ignorep t
3693 ext-list nil
3694 re-list nil)
3695 (setq ext-list (cdr ext-list))))
3696 (while re-list
3697 (setq nextstr (car re-list))
3698 (if (cond
3699 ((stringp nextstr) (string-match nextstr name))
bf8b0f8b 3700 ((functionp nextstr) (funcall nextstr name))
d6049c78
KS
3701 (t nil))
3702 (setq ignorep t
3703 re-list nil)
3704 (setq re-list (cdr re-list))))
3705 ;; return the result
3706 (if ignorep
3707 (setq ido-ignored-list (cons name ido-ignored-list)))
3708 ignorep)))))
789d1bf0
KS
3709
3710;; Private variable used by `ido-word-matching-substring'.
3711(defvar ido-change-word-sub)
3712
3713(defun ido-find-common-substring (items subs)
3714 ;; Return common string following SUBS in each element of ITEMS.
3715 (let (res
3716 alist
3717 ido-change-word-sub)
3718 (setq ido-change-word-sub
3719 (if ido-enable-regexp
3720 subs
3721 (regexp-quote subs)))
9066a4d0 3722 (setq res (mapcar #'ido-word-matching-substring items))
789d1bf0 3723 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
9066a4d0 3724 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
789d1bf0
KS
3725
3726 ;; try-completion returns t if there is an exact match.
9066a4d0
KS
3727 (let* ((completion-ignore-case ido-case-fold)
3728 (comp (try-completion subs alist)))
3729 (if (eq comp t)
3730 subs
3731 comp))))
789d1bf0
KS
3732
3733(defun ido-word-matching-substring (word)
3734 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
3735 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
71296446 3736 (let ((case-fold-search ido-case-fold))
789d1bf0
KS
3737 (let ((m (string-match ido-change-word-sub (ido-name word))))
3738 (if m
3739 (substring (ido-name word) m)
3740 ;; else no match
3741 nil))))
3742
3743(defun ido-makealist (res)
3744 ;; Return dotted pair (RES . 1).
3745 (cons res 1))
3746
3747(defun ido-choose-completion-string (choice buffer mini-p base-size)
3748 (when (ido-active)
3749 ;; Insert the completion into the buffer where completion was requested.
3750 (if (get-buffer ido-completion-buffer)
3751 (kill-buffer ido-completion-buffer))
3752 (cond
3753 ((ido-active t) ;; ido-use-merged-list
3754 (setq ido-current-directory ""
3755 ido-text choice
3756 ido-exit 'done))
3757 ((not (ido-final-slash choice))
3758 (setq ido-text choice
3759 ido-exit 'done))
3760 (t
3761 (ido-set-current-directory ido-current-directory choice)
3762 (setq ido-exit 'refresh)))
3763 (exit-minibuffer)
3764 t))
3765
3766(defun ido-completion-help ()
3767 "Show possible completions in a *File Completions* buffer."
3768 (interactive)
3769 (setq ido-rescan nil)
3770 (let ((temp-buf (get-buffer ido-completion-buffer))
3771 display-it full-list)
3772 (if (and (eq last-command this-command) temp-buf)
3773 ;; scroll buffer
3774 (let (win (buf (current-buffer)))
3775 (display-buffer temp-buf nil nil)
3776 (set-buffer temp-buf)
3777 (setq win (get-buffer-window temp-buf))
3778 (if (pos-visible-in-window-p (point-max) win)
c05b0612
KS
3779 (if (or ido-completion-buffer-all-completions
3780 (boundp 'ido-completion-buffer-full))
789d1bf0 3781 (set-window-start win (point-min))
3729cc87
KS
3782 (with-no-warnings
3783 (set (make-local-variable 'ido-completion-buffer-full) t))
789d1bf0
KS
3784 (setq full-list t
3785 display-it t))
3786 (scroll-other-window))
3787 (set-buffer buf))
3788 (setq display-it t))
3789 (if display-it
3790 (with-output-to-temp-buffer ido-completion-buffer
1de0ae85 3791 (let ((completion-list (sort
789d1bf0 3792 (cond
c05b0612 3793 (ido-directory-too-big
1fd1a9f2 3794 (message "Reading directory...")
c05b0612
KS
3795 (setq ido-directory-too-big nil
3796 ido-ignored-list nil
3797 ido-cur-list (ido-all-completions)
3798 ido-rescan t)
3799 (ido-set-matches)
3800 (or ido-matches ido-cur-list))
789d1bf0
KS
3801 (ido-use-merged-list
3802 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
3803 ((or full-list ido-completion-buffer-all-completions)
3804 (ido-all-completions))
3805 (t
1de0ae85
KS
3806 (copy-sequence (or ido-matches ido-cur-list))))
3807 #'ido-file-lessp)))
1518d6e3 3808 (if (featurep 'xemacs)
789d1bf0
KS
3809 ;; XEmacs extents are put on by default, doesn't seem to be
3810 ;; any way of switching them off.
0fe826e9 3811 ;; This obscure code avoids a byte compiler warning in Emacs.
6c1bc246
KS
3812 (let ((f 'display-completion-list))
3813 (funcall f completion-list
3814 :help-string "ido "
71296446 3815 :activate-callback
a09e21bf 3816 '(lambda (x y z) (message "Doesn't work yet, sorry!"))))
789d1bf0
KS
3817 ;; else running Emacs
3818 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
3819 (display-completion-list completion-list)))))))
3820
3821;;; KILL CURRENT BUFFER
3822(defun ido-kill-buffer-at-head ()
155943b9
KS
3823 "Kill the buffer at the head of `ido-matches'.
3824If cursor is not at the end of the user input, delete to end of input."
789d1bf0 3825 (interactive)
155943b9 3826 (if (not (eobp))
79ef5763 3827 (delete-region (point) (line-end-position))
155943b9
KS
3828 (let ((enable-recursive-minibuffers t)
3829 (buf (ido-name (car ido-matches))))
3830 (when buf
3831 (kill-buffer buf)
3832 ;; Check if buffer still exists.
3833 (if (get-buffer buf)
3834 ;; buffer couldn't be killed.
3835 (setq ido-rescan t)
3836 ;; else buffer was killed so remove name from list.
3837 (setq ido-cur-list (delq buf ido-cur-list)))))))
789d1bf0
KS
3838
3839;;; DELETE CURRENT FILE
3840(defun ido-delete-file-at-head ()
155943b9
KS
3841 "Delete the file at the head of `ido-matches'.
3842If cursor is not at the end of the user input, delete to end of input."
789d1bf0 3843 (interactive)
155943b9 3844 (if (not (eobp))
79ef5763 3845 (delete-region (point) (line-end-position))
155943b9
KS
3846 (let ((enable-recursive-minibuffers t)
3847 (file (ido-name (car ido-matches))))
3848 (if file
3849 (setq file (concat ido-current-directory file)))
3850 (when (and file
3851 (file-exists-p file)
3852 (not (file-directory-p file))
3853 (file-writable-p ido-current-directory)
3854 (yes-or-no-p (concat "Delete " file "? ")))
3855 (delete-file file)
3856 ;; Check if file still exists.
3857 (if (file-exists-p file)
3858 ;; file could not be deleted
3859 (setq ido-rescan t)
3860 ;; else file was killed so remove name from list.
3861 (setq ido-cur-list (delq (car ido-matches) ido-cur-list)))))))
789d1bf0
KS
3862
3863
3864;;; VISIT CHOSEN BUFFER
3865(defun ido-visit-buffer (buffer method &optional record)
a11ad595 3866 "Switch to BUFFER according to METHOD.
616e8e5f 3867Record command in `command-history' if optional RECORD is non-nil."
930f852e
KS
3868 (if (bufferp buffer)
3869 (setq buffer (buffer-name buffer)))
789d1bf0
KS
3870 (let (win newframe)
3871 (cond
3872 ((eq method 'kill)
3873 (if record
3874 (ido-record-command 'kill-buffer buffer))
3875 (kill-buffer buffer))
3876
a11ad595 3877 ((eq method 'other-window)
789d1bf0
KS
3878 (if record
3879 (ido-record-command 'switch-to-buffer buffer))
3880 (switch-to-buffer-other-window buffer))
3881
3882 ((eq method 'display)
3883 (display-buffer buffer))
3884
a11ad595 3885 ((eq method 'other-frame)
1518d6e3 3886 (switch-to-buffer-other-frame buffer)
a11ad595
KS
3887 (select-frame-set-input-focus (selected-frame)))
3888
3889 ((and (memq method '(raise-frame maybe-frame))
3890 window-system
3891 (setq win (ido-buffer-window-other-frame buffer))
3892 (or (eq method 'raise-frame)
3893 (y-or-n-p "Jump to frame? ")))
3894 (setq newframe (window-frame win))
3895 (select-frame-set-input-focus newframe)
3896 (select-window win))
3897
3898 ;; (eq method 'selected-window)
3899 (t
3900 ;; No buffer in other frames...
3901 (if record
3902 (ido-record-command 'switch-to-buffer buffer))
3903 (switch-to-buffer buffer)
1518d6e3 3904 ))))
789d1bf0
KS
3905
3906
a11ad595 3907(defun ido-buffer-window-other-frame (buffer)
789d1bf0
KS
3908 ;; Return window pointer if BUFFER is visible in another frame.
3909 ;; If BUFFER is visible in the current frame, return nil.
3910 (let ((blist (ido-get-buffers-in-frames 'current)))
3911 ;;If the buffer is visible in current frame, return nil
69beb26d 3912 (if (member buffer blist)
789d1bf0
KS
3913 nil
3914 ;; maybe in other frame or icon
3915 (get-buffer-window buffer 0) ; better than 'visible
3916 )))
3917
3918
3919;;; ----------- IDONIZED FUNCTIONS ------------
3920
3921;;;###autoload
3922(defun ido-switch-buffer ()
3923 "Switch to another buffer.
3924The buffer is displayed according to `ido-default-buffer-method' -- the
3925default is to show it in the same window, unless it is already visible
3926in another frame.
3927
3928As you type in a string, all of the buffers matching the string are
3903655d 3929displayed if substring-matching is used \(default). Look at
616e8e5f
JB
3930`ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
3931buffer you want, it can then be selected. As you type, most keys have
facf67fd 3932their normal keybindings, except for the following: \\<ido-buffer-completion-map>
789d1bf0
KS
3933
3934RET Select the buffer at the front of the list of matches. If the
3935list is empty, possibly prompt to create new buffer.
3936
3937\\[ido-select-text] Select the current prompt as the buffer.
3938If no buffer is found, prompt for a new one.
3939
3940\\[ido-next-match] Put the first element at the end of the list.
3941\\[ido-prev-match] Put the last element at the start of the list.
71296446 3942\\[ido-complete] Complete a common suffix to the current string that
789d1bf0
KS
3943matches all buffers. If there is only one match, select that buffer.
3944If there is no common suffix, show a list of all matching buffers
3945in a separate window.
3946\\[ido-edit-input] Edit input string.
3947\\[ido-fallback-command] Fallback to non-ido version of current command.
3948\\[ido-toggle-regexp] Toggle regexp searching.
3949\\[ido-toggle-prefix] Toggle between substring and prefix matching.
3950\\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
3951\\[ido-completion-help] Show list of matching buffers in separate window.
a2cf0212 3952\\[ido-enter-find-file] Drop into `ido-find-file'.
789d1bf0
KS
3953\\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
3954\\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
3955 (interactive)
3956 (ido-buffer-internal ido-default-buffer-method))
3957
3958;;;###autoload
3959(defun ido-switch-buffer-other-window ()
3960 "Switch to another buffer and show it in another window.
3961The buffer name is selected interactively by typing a substring.
74a5d578 3962For details of keybindings, see `ido-switch-buffer'."
789d1bf0 3963 (interactive)
a11ad595 3964 (ido-buffer-internal 'other-window 'switch-to-buffer-other-window))
789d1bf0
KS
3965
3966;;;###autoload
3967(defun ido-display-buffer ()
3968 "Display a buffer in another window but don't select it.
3969The buffer name is selected interactively by typing a substring.
74a5d578 3970For details of keybindings, see `ido-switch-buffer'."
789d1bf0 3971 (interactive)
db9f395b 3972 (ido-buffer-internal 'display 'display-buffer nil nil nil 'ignore))
789d1bf0
KS
3973
3974;;;###autoload
3975(defun ido-kill-buffer ()
3976 "Kill a buffer.
3977The buffer name is selected interactively by typing a substring.
74a5d578 3978For details of keybindings, see `ido-switch-buffer'."
789d1bf0 3979 (interactive)
db9f395b 3980 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer)) nil 'ignore))
789d1bf0
KS
3981
3982;;;###autoload
3983(defun ido-insert-buffer ()
3984 "Insert contents of a buffer in current buffer after point.
3985The buffer name is selected interactively by typing a substring.
74a5d578 3986For details of keybindings, see `ido-switch-buffer'."
789d1bf0 3987 (interactive)
db9f395b 3988 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil nil 'ido-enter-insert-file))
789d1bf0
KS
3989
3990;;;###autoload
3991(defun ido-switch-buffer-other-frame ()
3992 "Switch to another buffer and show it in another frame.
3993The buffer name is selected interactively by typing a substring.
74a5d578 3994For details of keybindings, see `ido-switch-buffer'."
789d1bf0
KS
3995 (interactive)
3996 (if ido-mode
a11ad595 3997 (ido-buffer-internal 'other-frame)
789d1bf0
KS
3998 (call-interactively 'switch-to-buffer-other-frame)))
3999
4000;;;###autoload
4001(defun ido-find-file-in-dir (dir)
4002 "Switch to another file starting from DIR."
4003 (interactive "DDir: ")
72a75b41 4004 (setq dir (file-name-as-directory dir))
db9f395b 4005 (ido-file-internal ido-default-file-method nil dir nil nil nil 'ignore))
789d1bf0
KS
4006
4007;;;###autoload
4008(defun ido-find-file ()
4009 "Edit file with name obtained via minibuffer.
4010The file is displayed according to `ido-default-file-method' -- the
4011default is to show it in the same window, unless it is already
4012visible in another frame.
4013
616e8e5f
JB
4014The file name is selected interactively by typing a substring. As you
4015type in a string, all of the filenames matching the string are displayed
4016if substring-matching is used \(default). Look at `ido-enable-prefix' and
4017`ido-toggle-prefix'. When you have found the filename you want, it can
4018then be selected. As you type, most keys have their normal keybindings,
facf67fd 4019except for the following: \\<ido-file-completion-map>
789d1bf0
KS
4020
4021RET Select the file at the front of the list of matches. If the
4022list is empty, possibly prompt to create new file.
4023
4024\\[ido-select-text] Select the current prompt as the buffer or file.
4025If no buffer or file is found, prompt for a new one.
4026
4027\\[ido-next-match] Put the first element at the end of the list.
4028\\[ido-prev-match] Put the last element at the start of the list.
71296446 4029\\[ido-complete] Complete a common suffix to the current string that
789d1bf0
KS
4030matches all files. If there is only one match, select that file.
4031If there is no common suffix, show a list of all matching files
4032in a separate window.
362cdb61 4033\\[ido-edit-input] Edit input string (including directory).
789d1bf0
KS
4034\\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
4035\\[ido-merge-work-directories] search for file in the work directory history.
4036\\[ido-forget-work-directory] removes current directory from the work directory history.
4037\\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
973495ca 4038\\[ido-wide-find-file-or-pop-dir] and \\[ido-wide-find-dir-or-delete-dir] prompts and uses find to locate files or directories.
789d1bf0
KS
4039\\[ido-make-directory] prompts for a directory to create in current directory.
4040\\[ido-fallback-command] Fallback to non-ido version of current command.
4041\\[ido-toggle-regexp] Toggle regexp searching.
4042\\[ido-toggle-prefix] Toggle between substring and prefix matching.
4043\\[ido-toggle-case] Toggle case-sensitive searching of file names.
4044\\[ido-toggle-vc] Toggle version control for this file.
4045\\[ido-toggle-literal] Toggle literal reading of this file.
4046\\[ido-completion-help] Show list of matching files in separate window.
4047\\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
4048
4049 (interactive)
4050 (ido-file-internal ido-default-file-method))
4051
4052;;;###autoload
4053(defun ido-find-file-other-window ()
4054 "Switch to another file and show it in another window.
4055The file name is selected interactively by typing a substring.
74a5d578 4056For details of keybindings, see `ido-find-file'."
789d1bf0 4057 (interactive)
a11ad595 4058 (ido-file-internal 'other-window 'find-file-other-window))
789d1bf0
KS
4059
4060;;;###autoload
4061(defun ido-find-alternate-file ()
4062 "Switch to another file and show it in another window.
4063The file name is selected interactively by typing a substring.
74a5d578 4064For details of keybindings, see `ido-find-file'."
789d1bf0
KS
4065 (interactive)
4066 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
4067
4068;;;###autoload
4069(defun ido-find-file-read-only ()
4070 "Edit file read-only with name obtained via minibuffer.
4071The file name is selected interactively by typing a substring.
74a5d578 4072For details of keybindings, see `ido-find-file'."
789d1bf0
KS
4073 (interactive)
4074 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
4075
4076;;;###autoload
4077(defun ido-find-file-read-only-other-window ()
4078 "Edit file read-only in other window with name obtained via minibuffer.
4079The file name is selected interactively by typing a substring.
74a5d578 4080For details of keybindings, see `ido-find-file'."
789d1bf0
KS
4081 (interactive)
4082 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
4083
4084;;;###autoload
4085(defun ido-find-file-read-only-other-frame ()
4086 "Edit file read-only in other frame with name obtained via minibuffer.
4087The file name is selected interactively by typing a substring.
74a5d578 4088For details of keybindings, see `ido-find-file'."
789d1bf0
KS
4089 (interactive)
4090 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
4091
4092;;;###autoload
4093(defun ido-display-file ()
4094 "Display a file in another window but don't select it.
4095The file name is selected interactively by typing a substring.
74a5d578 4096For details of keybindings, see `ido-find-file'."
789d1bf0 4097 (interactive)
db9f395b 4098 (ido-file-internal 'display nil nil nil nil nil 'ignore))
789d1bf0
KS
4099
4100;;;###autoload
4101(defun ido-find-file-other-frame ()
4102 "Switch to another file and show it in another frame.
4103The file name is selected interactively by typing a substring.
74a5d578 4104For details of keybindings, see `ido-find-file'."
789d1bf0 4105 (interactive)
a11ad595 4106 (ido-file-internal 'other-frame 'find-file-other-frame))
789d1bf0
KS
4107
4108;;;###autoload
4109(defun ido-write-file ()
4110 "Write current buffer to a file.
4111The file name is selected interactively by typing a substring.
74a5d578 4112For details of keybindings, see `ido-find-file'."
789d1bf0
KS
4113 (interactive)
4114 (let ((ido-process-ignore-lists t)
4115 (ido-work-directory-match-only nil)
4116 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
4117 (ido-report-no-match nil)
d81aa76a 4118 (ido-confirm-unique-completion t)
789d1bf0 4119 (ido-auto-merge-work-directories-length -1))
db9f395b 4120 (ido-file-internal 'write 'write-file nil "Write file: " nil nil 'ignore)))
789d1bf0
KS
4121
4122;;;###autoload
4123(defun ido-insert-file ()
4124 "Insert contents of file in current buffer.
4125The file name is selected interactively by typing a substring.
74a5d578 4126For details of keybindings, see `ido-find-file'."
789d1bf0 4127 (interactive)
db9f395b 4128 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil nil 'ido-enter-insert-buffer))
789d1bf0
KS
4129
4130;;;###autoload
4131(defun ido-dired ()
a09e21bf 4132 "Call `dired' the ido way.
789d1bf0 4133The directory is selected interactively by typing a substring.
74a5d578 4134For details of keybindings, see `ido-find-file'."
789d1bf0
KS
4135 (interactive)
4136 (let ((ido-report-no-match nil)
4137 (ido-auto-merge-work-directories-length -1))
4138 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
4139
4140(defun ido-list-directory ()
a09e21bf 4141 "Call `list-directory' the ido way.
789d1bf0 4142The directory is selected interactively by typing a substring.
74a5d578 4143For details of keybindings, see `ido-find-file'."
789d1bf0
KS
4144 (interactive)
4145 (let ((ido-report-no-match nil)
4146 (ido-auto-merge-work-directories-length -1))
4147 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
4148
4149;;; XEmacs hack for showing default buffer
4150
4151;; The first time we enter the minibuffer, Emacs puts up the default
4152;; buffer to switch to, but XEmacs doesn't -- presumably there is a
4153;; subtle difference in the two versions of post-command-hook. The
4154;; default is shown for both whenever we delete all of our text
4155;; though, indicating its just a problem the first time we enter the
4156;; function. To solve this, we use another entry hook for emacs to
4157;; show the default the first time we enter the minibuffer.
4158
4159
4160;;; ICOMPLETE TYPE CODE
4161
4162(defun ido-initiate-auto-merge (buffer)
4163 (ido-trace "\n*merge timeout*" buffer)
4164 (setq ido-auto-merge-timer nil)
4165 (when (and (buffer-live-p buffer)
cba9a3a5 4166 (ido-active)
789d1bf0
KS
4167 (boundp 'ido-eoinput) ido-eoinput)
4168 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
4169 (ido-trace "request merge")
4170 (setq ido-use-merged-list 'auto
4171 ido-text-init contents
4172 ido-rotate-temp t
4173 ido-exit 'refresh)
4174 (save-excursion
4175 (set-buffer buffer)
4176 (ido-tidy))
4177 (throw 'ido contents))))
4178
4179(defun ido-exhibit ()
4180 "Post command hook for `ido'."
4181 ;; Find matching files and display a list in the minibuffer.
4182 ;; Copied from `icomplete-exhibit' with two changes:
4183 ;; 1. It prints a default file name when there is no text yet entered.
4184 ;; 2. It calls my completion routine rather than the standard completion.
4185
cba9a3a5 4186 (when (ido-active)
bad111c2
KS
4187 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
4188 (buffer-undo-list t)
4189 try-single-dir-match
4190 refresh)
789d1bf0 4191
5444f278
KS
4192 (when ido-trace-enable
4193 (ido-trace "\nexhibit" this-command)
4194 (ido-trace "dir" ido-current-directory)
4195 (ido-trace "contents" contents)
4196 (ido-trace "list" ido-cur-list)
4197 (ido-trace "matches" ido-matches)
4198 (ido-trace "rescan" ido-rescan))
789d1bf0 4199
bad111c2
KS
4200 (save-excursion
4201 (goto-char (point-max))
4202 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
4203 (unless (boundp 'ido-eoinput)
4204 ;; In case it got wiped out by major mode business:
4205 (make-local-variable 'ido-eoinput))
4206 (setq ido-eoinput (point))
4207
4208 ;; Handle explicit directory changes
4209 (cond
db9f395b 4210 ((memq ido-cur-item '(buffer list))
bad111c2
KS
4211 )
4212
4213 ((= (length contents) 0)
4214 )
4215
4216 ((= (length contents) 1)
dfebc0ae
KS
4217 (cond
4218 ((and (ido-is-tramp-root) (string-equal contents "/"))
bad111c2
KS
4219 (ido-set-current-directory ido-current-directory contents)
4220 (setq refresh t))
4c2ee078 4221 ((and (ido-unc-hosts) (string-equal contents "/")
dfebc0ae
KS
4222 (let ((ido-enable-tramp-completion nil))
4223 (ido-is-root-directory)))
4224 (ido-set-current-directory "//")
4225 (setq refresh t))
4226 ))
bad111c2 4227
10b19e88
KS
4228 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") contents)
4229 (ido-is-root-directory) ;; Ange-ftp or tramp
4230 (not (ido-local-file-exists-p contents)))
bad111c2
KS
4231 (ido-set-current-directory ido-current-directory contents)
4232 (when (ido-is-slow-ftp-host)
4233 (setq ido-exit 'fallback)
4234 (exit-minibuffer))
4235 (setq refresh t))
4236
4237 ((ido-final-slash contents) ;; xxx/
4238 (ido-trace "final slash" contents)
71296446 4239 (cond
bad111c2
KS
4240 ((string-equal contents "~/")
4241 (ido-set-current-home)
4242 (setq refresh t))
4243 ((string-equal contents "../")
4244 (ido-up-directory t)
4245 (setq refresh t))
4246 ((string-equal contents "./")
4247 (setq refresh t))
1c36d72a 4248 ((string-match "\\`~[-_a-zA-Z0-9]+[$]?/\\'" contents)
bad111c2
KS
4249 (ido-trace "new home" contents)
4250 (ido-set-current-home contents)
4251 (setq refresh t))
4252 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
4253 (let ((exp (condition-case ()
4254 (expand-file-name
4255 (substitute-in-file-name (substring contents 0 -1))
4256 ido-current-directory)
4257 (error nil))))
4258 (ido-trace contents exp)
4259 (when (and exp (file-directory-p exp))
4260 (ido-set-current-directory (file-name-directory exp))
4261 (setq ido-text-init (file-name-nondirectory exp))
4262 (setq refresh t))))
4263 ((and (memq system-type '(windows-nt ms-dos))
4264 (string-equal (substring contents 1) ":/"))
4265 (ido-set-current-directory (file-name-directory contents))
4266 (setq refresh t))
4267 ((string-equal (substring contents -2 -1) "/")
71296446 4268 (ido-set-current-directory
bad111c2
KS
4269 (if (memq system-type '(windows-nt ms-dos))
4270 (expand-file-name "/" ido-current-directory)
4271 "/"))
4272 (setq refresh t))
cb65c373 4273 ((and (or ido-directory-nonreadable ido-directory-too-big)
a70343bd 4274 (file-directory-p (concat ido-current-directory (file-name-directory contents))))
d81aa76a 4275 (ido-set-current-directory
a70343bd
KS
4276 (concat ido-current-directory (file-name-directory contents)))
4277 (setq refresh t))
bad111c2
KS
4278 (t
4279 (ido-trace "try single dir")
4280 (setq try-single-dir-match t))))
4281
4282 ((and (string-equal (substring contents -2 -1) "/")
4283 (not (string-match "[$]" contents)))
4284 (ido-set-current-directory
4285 (cond
4286 ((= (length contents) 2)
4287 "/")
4288 (ido-matches
5a1b28a4 4289 (concat ido-current-directory (ido-name (car ido-matches))))
bad111c2
KS
4290 (t
4291 (concat ido-current-directory (substring contents 0 -1)))))
4292 (setq ido-text-init (substring contents -1))
4293 (setq refresh t))
4294
4295 ((and (not ido-use-merged-list)
4296 (not (ido-final-slash contents))
4297 (eq ido-try-merged-list t)
4298 (numberp ido-auto-merge-work-directories-length)
4299 (> ido-auto-merge-work-directories-length 0)
4300 (= (length contents) ido-auto-merge-work-directories-length)
4301 (not (and ido-auto-merge-inhibit-characters-regexp
4302 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4303 (not (input-pending-p)))
4304 (setq ido-use-merged-list 'auto
4305 ido-text-init contents
4306 ido-rotate-temp t)
4307 (setq refresh t))
4308
4309 (t nil))
4310
4311 (when refresh
4312 (ido-trace "refresh on /" ido-text-init)
4313 (setq ido-exit 'refresh)
4314 (exit-minibuffer))
789d1bf0 4315
bad111c2
KS
4316 ;; Update the list of matches
4317 (setq ido-text contents)
4318 (ido-set-matches)
4319 (ido-trace "new " ido-matches)
4320
5702da69 4321 (when (and ido-enter-matching-directory
bad111c2 4322 ido-matches
5702da69
KS
4323 (or (eq ido-enter-matching-directory 'first)
4324 (null (cdr ido-matches)))
5a1b28a4 4325 (ido-final-slash (ido-name (car ido-matches)))
bad111c2 4326 (or try-single-dir-match
5702da69 4327 (eq ido-enter-matching-directory t)))
bad111c2 4328 (ido-trace "single match" (car ido-matches))
71296446 4329 (ido-set-current-directory
5a1b28a4 4330 (concat ido-current-directory (ido-name (car ido-matches))))
bad111c2
KS
4331 (setq ido-exit 'refresh)
4332 (exit-minibuffer))
4333
4334 (when (and (not ido-matches)
a70343bd 4335 (not ido-directory-nonreadable)
cb65c373 4336 (not ido-directory-too-big)
bad111c2 4337 ;; ido-rescan ?
789d1bf0
KS
4338 ido-process-ignore-lists
4339 ido-ignored-list)
bad111c2
KS
4340 (let ((ido-process-ignore-lists nil)
4341 (ido-rotate ido-rotate)
4342 (ido-cur-list ido-ignored-list))
4343 (ido-trace "try all" ido-ignored-list)
4344 (ido-set-matches))
4345 (when ido-matches
4346 (ido-trace "found " ido-matches)
4347 (setq ido-rescan t)
4348 (setq ido-process-ignore-lists-inhibit t)
4349 (setq ido-text-init ido-text)
4350 (setq ido-exit 'refresh)
4351 (exit-minibuffer)))
4352
4353 (when (and
4354 ido-rescan
4355 (not ido-matches)
4356 (memq ido-cur-item '(file dir))
4357 (not (ido-is-root-directory))
4358 (> (length contents) 1)
a70343bd 4359 (not (string-match "[$]" contents))
cb65c373
KS
4360 (not ido-directory-nonreadable)
4361 (not ido-directory-too-big))
bad111c2
KS
4362 (ido-trace "merge?")
4363 (if ido-use-merged-list
4364 (ido-undo-merge-work-directory contents nil)
4365 (when (and (eq ido-try-merged-list t)
4366 (numberp ido-auto-merge-work-directories-length)
4367 (= ido-auto-merge-work-directories-length 0)
4368 (not (and ido-auto-merge-inhibit-characters-regexp
4369 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4370 (not (input-pending-p)))
4371 (ido-trace "\n*start timer*")
4372 (setq ido-auto-merge-timer
4373 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
71296446 4374
bad111c2 4375 (setq ido-rescan t)
789d1bf0 4376
71296446 4377 (if (and ido-use-merged-list
bad111c2
KS
4378 ido-matches
4379 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
4380 (progn
4381 (ido-set-current-directory (car (cdr (car ido-matches))))
4382 (setq ido-use-merged-list t
4383 ido-exit 'keep
4384 ido-text-init ido-text)
4385 (exit-minibuffer)))
4386
4387 ;; Insert the match-status information:
4388 (ido-set-common-completion)
71296446 4389 (let ((inf (ido-completions
bad111c2
KS
4390 contents
4391 minibuffer-completion-table
4392 minibuffer-completion-predicate
4393 (not minibuffer-completion-confirm))))
4394 (ido-trace "inf" inf)
4395 (insert inf))
4396 ))))
789d1bf0
KS
4397
4398(defun ido-completions (name candidates predicate require-match)
4399 ;; Return the string that is displayed after the user's text.
4400 ;; Modified from `icomplete-completions'.
71296446 4401
789d1bf0
KS
4402 (let* ((comps ido-matches)
4403 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
4404 ido-merged-indicator))
4405 first)
4406
4407 (if (and ind ido-use-faces)
ccba8bb6 4408 (put-text-property 0 1 'face 'ido-indicator ind))
71296446 4409
789d1bf0
KS
4410 (if (and ido-use-faces comps)
4411 (let* ((fn (ido-name (car comps)))
4412 (ln (length fn)))
4413 (setq first (format "%s" fn))
4414 (put-text-property 0 ln 'face
4415 (if (= (length comps) 1)
665ed61a
KS
4416 (if ido-incomplete-regexp
4417 'ido-incomplete-regexp
4418 'ido-only-match)
ccba8bb6 4419 'ido-first-match)
789d1bf0
KS
4420 first)
4421 (if ind (setq first (concat first ind)))
4422 (setq comps (cons first (cdr comps)))))
4423
4424 (cond ((null comps)
a70343bd
KS
4425 (cond
4426 (ido-directory-nonreadable
4427 (or (nth 8 ido-decorations) " [Not readable]"))
cb65c373
KS
4428 (ido-directory-too-big
4429 (or (nth 9 ido-decorations) " [Too big]"))
a70343bd
KS
4430 (ido-report-no-match
4431 (nth 6 ido-decorations)) ;; [No match]
4432 (t "")))
665ed61a
KS
4433 (ido-incomplete-regexp
4434 (concat " " (car comps)))
789d1bf0 4435 ((null (cdr comps)) ;one match
665ed61a
KS
4436 (concat (if (if (not ido-enable-regexp)
4437 (= (length (ido-name (car comps))) (length name))
4438 ;; We can't rely on the length of the input
4439 ;; for regexps, so explicitly check for a
4440 ;; complete match
4441 (string-match name (ido-name (car comps)))
4442 (string-equal (match-string 0 (ido-name (car comps)))
4443 (ido-name (car comps))))
4444 ""
4445 ;; when there is one match, show the matching file name in full
4446 (concat (nth 4 ido-decorations) ;; [ ... ]
4447 (ido-name (car comps))
4448 (nth 5 ido-decorations)))
789d1bf0
KS
4449 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
4450 (t ;multiple matches
4451 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
4452 (alternatives
4453 (apply
71296446 4454 #'concat
789d1bf0 4455 (cdr (apply
9066a4d0
KS
4456 #'nconc
4457 (mapcar
4458 (lambda (com)
4459 (setq com (ido-name com))
4460 (setq items (1- items))
4461 (cond
4462 ((< items 0) ())
4463 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
4464 (t
4465 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
4466 (let ((str (substring com 0)))
4467 (if (and ido-use-faces
4468 (not (string= str first))
4469 (ido-final-slash str))
ccba8bb6 4470 (put-text-property 0 (length str) 'face 'ido-subdir str))
9066a4d0
KS
4471 str)))))
4472 comps))))))
789d1bf0
KS
4473
4474 (concat
4475 ;; put in common completion item -- what you get by pressing tab
9066a4d0
KS
4476 (if (and (stringp ido-common-match-string)
4477 (> (length ido-common-match-string) (length name)))
789d1bf0
KS
4478 (concat (nth 4 ido-decorations) ;; [ ... ]
4479 (substring ido-common-match-string (length name))
4480 (nth 5 ido-decorations)))
4481 ;; list all alternatives
4482 (nth 0 ido-decorations) ;; { ... }
4483 alternatives
4484 (nth 1 ido-decorations)))))))
4485
4486(defun ido-minibuffer-setup ()
4487 "Minibuffer setup hook for `ido'."
4488 ;; Copied from `icomplete-minibuffer-setup-hook'.
cba9a3a5 4489 (when (ido-active)
789d1bf0
KS
4490 (add-hook 'pre-command-hook 'ido-tidy nil t)
4491 (add-hook 'post-command-hook 'ido-exhibit nil t)
4492 (setq cua-inhibit-cua-keys t)
1518d6e3 4493 (when (featurep 'xemacs)
789d1bf0
KS
4494 (ido-exhibit)
4495 (goto-char (point-min)))
155943b9
KS
4496 (run-hooks 'ido-minibuffer-setup-hook)
4497 (when ido-initial-position
4498 (goto-char (+ (minibuffer-prompt-end) ido-initial-position))
4499 (setq ido-initial-position nil))))
789d1bf0
KS
4500
4501(defun ido-tidy ()
4502 "Pre command hook for `ido'."
4503 ;; Remove completions display, if any, prior to new user input.
4504 ;; Copied from `icomplete-tidy'."
4505
4506 (when ido-auto-merge-timer
4507 (ido-trace "\n*cancel timer*" this-command)
4508 (cancel-timer ido-auto-merge-timer)
4509 (setq ido-auto-merge-timer nil))
4510
cba9a3a5 4511 (if (ido-active)
789d1bf0
KS
4512 (if (and (boundp 'ido-eoinput)
4513 ido-eoinput)
71296446 4514
789d1bf0
KS
4515 (if (> ido-eoinput (point-max))
4516 ;; Oops, got rug pulled out from under us - reinit:
4517 (setq ido-eoinput (point-max))
4518 (let ((buffer-undo-list t))
4519 (delete-region ido-eoinput (point-max))))
71296446 4520
789d1bf0
KS
4521 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
4522 (make-local-variable 'ido-eoinput)
4523 (setq ido-eoinput 1))))
4524
4525(defun ido-summary-buffers-to-end ()
4526 ;; Move the summaries to the end of the buffer list.
4527 ;; This is an example function which can be hooked on to
4528 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
4529 ;; `Summary' or `output\*$'are put to the end of the list.
71296446
JB
4530 (let ((summaries (delq nil (mapcar
4531 (lambda (x)
4532 (if (or
789d1bf0
KS
4533 (string-match "Summary" x)
4534 (string-match "output\\*\\'" x))
4535 x))
4536 ido-temp-list))))
4537 (ido-to-end summaries)))
4538
4539;;; Helper functions for other programs
4540
84263efb 4541(put 'dired-do-rename 'ido 'ignore)
ae9d279d 4542(put 'ibuffer-find-file 'ido 'find-file)
76ce3ae6 4543(put 'dired-other-window 'ido 'dir)
84263efb 4544
cb65c373
KS
4545;;;###autoload
4546(defun ido-read-buffer (prompt &optional default require-match)
4547 "Ido replacement for the built-in `read-buffer'.
4548Return the name of a buffer selected.
4549PROMPT is the prompt to give to the user. DEFAULT if given is the default
4550buffer to be selected, which will go to the front of the list.
616e8e5f 4551If REQUIRE-MATCH is non-nil, an existing buffer must be selected."
cb65c373
KS
4552 (let* ((ido-current-directory nil)
4553 (ido-directory-nonreadable nil)
4554 (ido-directory-too-big nil)
4555 (ido-context-switch-command 'ignore)
4556 (buf (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match)))
4557 (if (eq ido-exit 'fallback)
4558 (let ((read-buffer-function nil))
b2d4c118 4559 (run-hook-with-args 'ido-before-fallback-functions 'read-buffer)
cb65c373
KS
4560 (read-buffer prompt default require-match))
4561 buf)))
4562
789d1bf0
KS
4563;;;###autoload
4564(defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
cb65c373
KS
4565 "Ido replacement for the built-in `read-file-name'.
4566Read file name, prompting with PROMPT and completing in directory DIR.
789d1bf0 4567See `read-file-name' for additional parameters."
db9f395b
KS
4568 (let (filename)
4569 (cond
4570 ((or (eq predicate 'file-directory-p)
4571 (eq (get this-command 'ido) 'dir)
4572 (memq this-command ido-read-file-name-as-directory-commands))
4573 (setq filename
89a28f0b
KS
4574 (ido-read-directory-name prompt dir default-filename mustmatch initial))
4575 (if (eq ido-exit 'fallback)
4576 (setq filename 'fallback)))
db9f395b
KS
4577 ((and (not (eq (get this-command 'ido) 'ignore))
4578 (not (memq this-command ido-read-file-name-non-ido))
4579 (or (null predicate) (eq predicate 'file-exists-p)))
4580 (let* (ido-saved-vc-hb
ae9d279d
KS
4581 (ido-context-switch-command
4582 (if (eq (get this-command 'ido) 'find-file) nil 'ignore))
db9f395b 4583 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
83a12f3a 4584 (minibuffer-completing-file-name t)
db9f395b
KS
4585 (ido-current-directory (ido-expand-directory dir))
4586 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
cb65c373
KS
4587 (ido-directory-too-big (and (not ido-directory-nonreadable)
4588 (ido-directory-too-big-p ido-current-directory)))
db9f395b 4589 (ido-work-directory-index -1)
fcbc95a9
KS
4590 (ido-show-dot-for-dired (and ido-show-dot-for-dired
4591 (not default-filename)))
db9f395b
KS
4592 (ido-work-file-index -1)
4593 (ido-find-literal nil))
4594 (setq ido-exit nil)
4595 (setq filename
4596 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
4597 (cond
4598 ((eq ido-exit 'fallback)
4599 (setq filename 'fallback))
ae9d279d
KS
4600 ((eq ido-exit 'dired)
4601 (setq filename ido-current-directory))
db9f395b
KS
4602 (filename
4603 (setq filename
4604 (concat ido-current-directory filename))))))
4605 (t
4606 (setq filename 'fallback)))
4607 (if (eq filename 'fallback)
4608 (let ((read-file-name-function nil))
b2d4c118 4609 (run-hook-with-args 'ido-before-fallback-functions 'read-file-name)
db9f395b
KS
4610 (read-file-name prompt dir default-filename mustmatch initial predicate))
4611 filename)))
789d1bf0
KS
4612
4613;;;###autoload
4614(defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
cb65c373
KS
4615 "Ido replacement for the built-in `read-directory-name'.
4616Read directory name, prompting with PROMPT and completing in directory DIR.
4617See `read-directory-name' for additional parameters."
a70343bd 4618 (let* (filename
83a12f3a 4619 (minibuffer-completing-file-name t)
db9f395b 4620 (ido-context-switch-command 'ignore)
a70343bd
KS
4621 ido-saved-vc-hb
4622 (ido-current-directory (ido-expand-directory dir))
4623 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
cb65c373
KS
4624 (ido-directory-too-big (and (not ido-directory-nonreadable)
4625 (ido-directory-too-big-p ido-current-directory)))
a70343bd
KS
4626 (ido-work-directory-index -1)
4627 (ido-work-file-index -1))
789d1bf0
KS
4628 (setq filename
4629 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
4630 (if filename
4631 (if (and (stringp filename) (string-equal filename "."))
4632 ido-current-directory
4633 (concat ido-current-directory filename)))))
4634
db9f395b
KS
4635;;;###autoload
4636(defun ido-completing-read (prompt choices &optional predicate require-match initial-input hist def)
cb65c373
KS
4637 "Ido replacement for the built-in `completing-read'.
4638Read a string in the minibuffer with ido-style completion.
db9f395b
KS
4639PROMPT is a string to prompt with; normally it ends in a colon and a space.
4640CHOICES is a list of strings which are the possible completions.
4641PREDICATE is currently ignored; it is included to be compatible
4642 with `completing-read'.
4643If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
4644 the input is (or completes to) an element of CHOICES or is null.
4645 If the input is null, `ido-completing-read' returns DEF, or an empty
4646 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
4647If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
4648 with point positioned at the end.
4649HIST, if non-nil, specifies a history list.
4650DEF, if non-nil, is the default value."
4651 (let ((ido-current-directory nil)
4652 (ido-directory-nonreadable nil)
cb65c373 4653 (ido-directory-too-big nil)
db9f395b
KS
4654 (ido-context-switch-command 'ignore)
4655 (ido-choice-list choices))
4656 (ido-read-internal 'list prompt hist def require-match initial-input)))
4657
4658
3da360a7 4659;; arch-tag: b63a3500-1735-41bd-8a01-05373f0864da
789d1bf0 4660;;; ido.el ends here