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