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