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