1 ;;; ido.el --- interactively do things with buffers and files.
3 ;; Copyright (C) 1996-2011 Free Software Foundation, Inc.
5 ;; Author: Kim F. Storm <storm@cua.dk>
6 ;; Based on: iswitchb by Stephen Eglen <stephen@cns.ed.ac.uk>
7 ;; Keywords: extensions convenience
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; Ido - interactive do - switches between buffers and opens files and
28 ;; directories with a minimum of keystrokes. It is a superset of
29 ;; iswitchb, the interactive buffer switching package by Stephen Eglen.
31 ;; Interactive substring matching
32 ;; ------------------------------
34 ;; As you type in a substring, the list of buffers or files currently
35 ;; matching the substring are displayed as you type. The list is
36 ;; ordered so that the most recent buffers or files visited come at
37 ;; the start of the list.
39 ;; The buffer or file at the start of the list will be the one visited
40 ;; when you press RETURN. By typing more of the substring, the list is
41 ;; narrowed down so that gradually the buffer or file you want will be
42 ;; at the top of the list. Alternatively, you can use C-s and C-r (or
43 ;; the right and left arrow keys) to rotate buffer or file names in the
44 ;; list until the one you want is at the top of the list.
46 ;; Completion is also available so that you can see what is common to
47 ;; all of the matching buffers or files as you type.
51 ;; If I have two buffers called "123456" and "123", with "123456" the
52 ;; most recent, when I use ido-switch-buffer, I first of all get
53 ;; presented with the list of all the buffers
55 ;; Buffer: {123456 | 123}
58 ;; Buffer: 2[3]{123456 | 123}
60 ;; The list in {...} are the matching buffers, most recent first
61 ;; (buffers visible in the current frame are put at the end of the
62 ;; list by default). At any time I can select the item at the head of
63 ;; the list by pressing RET. I can also put the first element at the
64 ;; end of the list by pressing C-s or [right], or bring the last
65 ;; element to the head of the list by pressing C-r or [left].
67 ;; The item in [...] indicates what can be added to my input by
68 ;; pressing TAB. In this case, I will get "3" added to my input.
71 ;; Buffer: 23{123456 | 123}
73 ;; At this point, I still have two matching buffers.
74 ;; If I want the first buffer in the list, I simply press RET. If I
75 ;; wanted the second in the list, I could press C-s to move it to the
76 ;; top of the list and then RET to select it.
78 ;; However, if I type 4, I only have one match left:
79 ;; Buffer: 234[123456]
81 ;; Since there is only one matching buffer left, it is given in [] and
82 ;; it is shown in the `ido-only-match' face (ForestGreen). I can now
83 ;; press TAB or RET to go to that buffer.
85 ;; If I want to create a new buffer named "234", I press C-j instead of
88 ;; If instead, I type "a":
89 ;; Buffer: 234a [No match]
90 ;; There are no matching buffers. If I press RET or TAB, I can be
91 ;; prompted to create a new buffer called "234a".
93 ;; Of course, where this function comes in really useful is when you
94 ;; can specify the buffer using only a few keystrokes. In the above
95 ;; example, the quickest way to get to the "123456" file would be
96 ;; just to type 4 and then RET (assuming there isn't any newer buffer
97 ;; with 4 in its name).
99 ;; Likewise, if you use C-x C-f (ido-find-file), the list of files and
100 ;; directories in the current directory is provided in the same
101 ;; fashion as the buffers above. The files and directories are
102 ;; normally sorted in alphabetical order, but the most recently
103 ;; visited directory is placed first to speed up navigating to
104 ;; directories that you have visited recently.
106 ;; In addition to scrolling through the list using [right] and [left],
107 ;; you can use [up] and [down] to quickly scroll the list to the next
108 ;; or previous subdirectory.
110 ;; To go down into a subdirectory, and continue the file selection on
111 ;; the files in that directory, simply move the directory to the head
112 ;; of the list and hit RET.
114 ;; To go up to the parent directory, delete any partial file name
115 ;; already specified (e.g. using [backspace]) and hit [backspace].
117 ;; To go to the root directory (on the current drive), enter two
118 ;; slashes. On MS-DOS or Windows, to select the root of another
119 ;; drive, enter X:/ where X is the drive letter. You can also visit
120 ;; files on other hosts using the ange-ftp notations `/host:' and
121 ;; `/user@host:'. See the variable `ido-slow-ftp-hosts' if you want
122 ;; to inhibit the ido substring matching for ftp access.
124 ;; If for some reason you cannot specify the proper file using
125 ;; ido-find-file, you can press C-f to enter the normal find-file.
126 ;; You can also press C-b to drop into ido-switch-buffer.
128 ;; See the doc string of ido-switch-buffer and ido-find-file for full
129 ;; keybindings and features.
130 ;; (describe-function 'ido-find-file)
132 ;; Hidden buffers and files
133 ;; ------------------------
135 ;; Normally, ido does not include hidden buffers (whose name starts
136 ;; with a space) and hidden files and directories (whose name starts
137 ;; with `.') in the list of possible completions. However, if the
138 ;; substring you enter does not match any of the visible buffers or
139 ;; files, ido will automatically look for completions among the hidden
142 ;; You can toggle display of the hidden buffers and files with C-a.
144 ;; Additional functionality
145 ;; ------------------------
147 ;; After C-x b, the buffer at the head of the list can be killed by
148 ;; pressing C-k. If the buffer needs saving, you will be queried
149 ;; before the buffer is killed.
151 ;; Likewise, after C-x C-f, you can delete (i.e. physically remove)
152 ;; the file at the head of the list with C-k. You will always be
153 ;; asked for confirmation before the file is deleted.
155 ;; If you enter C-x b to switch to a buffer visiting a given file, and
156 ;; you find that the file you are after is not in any buffer, you can
157 ;; press C-f to immediately drop into ido-find-file. And you can
158 ;; switch back to buffer selection with C-b.
163 ;; The standard way of completion with Unix-shells and Emacs is to insert a
164 ;; PREFIX and then hitting TAB (or another completion key). Cause of this
165 ;; behavior has become second nature to a lot of emacs users `ido' offers in
166 ;; addition to the default substring-matching-method (look above) also the
167 ;; prefix-matching-method. The kind of matching is the only difference to
168 ;; the description of the substring-matching above.
170 ;; You can toggle prefix matching with C-p.
174 ;; If you have again two Buffers "123456" and "123" then hitting "2" does
175 ;; not match because "2" is not a PREFIX in any of the buffer-names.
180 ;; If you set ido-enable-flex-matching, ido will do a more flexible
181 ;; matching (unless regexp matching is active) to find possible matches
182 ;; among the available buffer or file names if no matches are found using
183 ;; the normal prefix or substring matching.
185 ;; The flexible matching implies that any item which simply contains all
186 ;; of the entered characters in the specified sequence will match.
190 ;; If you have four files "alpha", "beta", "gamma", and "delta",
191 ;; entering "aa" will match "alpha" and "gamma", while "ea" matches
192 ;; "beta" and "delta". If prefix matching is also active, "aa" only
193 ;; matches "alpha", while "ea" does not match any files.
198 ;; There is limited provision for regexp matching within ido,
199 ;; enabled through `ido-enable-regexp' (toggle with C-t).
200 ;; This allows you to type `[ch]$' for example and see all file names
201 ;; ending in `c' or `h'.
203 ;; Note: ido-style completion is inhibited when you enable regexp matching.
209 ;; Customize the `ido' group to change the `ido' functionality.
211 ;; To modify the keybindings, use the ido-setup-hook. For example:
212 ;;(add-hook 'ido-setup-hook 'ido-my-keys)
214 ;;(defun ido-my-keys ()
215 ;; "Add my keybindings for ido."
216 ;; (define-key ido-completion-map " " 'ido-next-match)
219 ;; Seeing all the matching buffers or files
220 ;; ----------------------------------------
222 ;; If you have many matching files, they may not all fit onto one
223 ;; line of the minibuffer. Normally, the minibuffer window will grow
224 ;; to show you more of the matching files (depending on the setting
225 ;; of the variables `resize-mini-windows' and `max-mini-window-height').
226 ;; If you want ido to behave differently from the default minibuffer
227 ;; resizing behavior, set the variable `ido-max-window-height'.
229 ;; Also, to improve the responsiveness of ido, the maximum number of
230 ;; matching items is limited to 12, but you can increase or removed
231 ;; this limit via the `ido-max-prospects' variable.
233 ;; To see a full list of all matching buffers in a separate buffer,
234 ;; hit ? or press TAB when there are no further completions to the
235 ;; substring. Repeated TAB presses will scroll you through this
238 ;; Changing the list of files
239 ;; --------------------------
241 ;; By default, the list of current files is most recent first,
242 ;; oldest last, with the exception that the files visible in the
243 ;; current frame are put at the end of the list. A hook exists to
244 ;; allow other functions to order the list. For example, if you add:
246 ;; (add-hook 'ido-make-buffer-list-hook 'ido-summary-buffers-to-end)
248 ;; then all files matching "Summary" are moved to the end of the
249 ;; list. (I find this handy for keeping the INBOX Summary and so on
250 ;; out of the way.) It also moves files matching "output\*$" to the
251 ;; end of the list (these are created by AUCTeX when compiling.)
252 ;; Other functions could be made available which alter the list of
253 ;; matching files (either deleting or rearranging elements.)
258 ;; The highlighting of matching items is controlled via ido-use-faces.
259 ;; The faces used are ido-first-match, ido-only-match and
261 ;; Colouring of the matching item was suggested by
262 ;; Carsten Dominik (dominik@strw.leidenuniv.nl).
264 ;; Replacement for read-buffer and read-file-name
265 ;; ----------------------------------------------
267 ;; ido-read-buffer and ido-read-file-name have been written to be drop
268 ;; in replacements for the normal buffer and file name reading
269 ;; functions `read-buffer' and `read-file-name'.
271 ;; To use ido for all buffer and file selections in Emacs, customize the
272 ;; variable `ido-everywhere'.
274 ;; Using ido-like behavior in other lisp packages
275 ;; -----------------------------------------------
277 ;; If you don't want to rely on the `ido-everywhere' functionality,
278 ;; ido-read-buffer, ido-read-file-name, and ido-read-directory-name
279 ;; can be used by other packages to read a buffer name, a file name,
280 ;; or a directory name in the `ido' way.
284 ;; Infinite amounts of gratitude goes to Stephen Eglen <stephen@cns.ed.ac.uk>
285 ;; who wrote iswitch-buffer mode - from which I ripped off 99% of the code
286 ;; for ido-switch-buffer and found the inspiration for ido-find-file.
287 ;; The ido package would never have existed without his work.
289 ;; Also thanks to Klaus Berndl, Rohit Namjoshi, Robert Fenk, Alex
290 ;; Schroeder, Bill Benedetto, Stephen Eglen, and many others for bug
291 ;; fixes and improvements.
295 ;; Since I discovered Stephen Eglen's excellent iswitchb package, I just
296 ;; couldn't live without it, but once being addicted to switching buffers
297 ;; with a minimum of keystrokes, I soon found that opening files in the
298 ;; old-fashioned way was just too slow - so I decided to write a package
299 ;; which could open files with the same speed and ease as iswitchb could
302 ;; I originally wrote a separate ifindf.el package based on a copy of
303 ;; iswitchb.el, which did for opening files what iswitchb did for
304 ;; switching buffers. Along the way, I corrected a few errors in
305 ;; ifindf which could have found its way back into iswitchb, but since
306 ;; most of the functionality of the two package was practically
307 ;; identical, I decided that the proper thing to do was to merge my
308 ;; ifindf package back into iswitchb.
310 ;; This is basically what ido (interactively do) is all about; but I
311 ;; found it ackward to merge my changes into the "iswitchb-" namespace,
312 ;; so I invented a common "ido-" namespace for the merged packages.
314 ;; This version is based on ido.el version 1.57 released on
315 ;; gnu.emacs.sources adapted for emacs 22.1 to use command remapping
316 ;; and optionally hooking the read-buffer and read-file-name functions.
318 ;; Prefix matching was added by Klaus Berndl <klaus.berndl@sdm.de> based on
319 ;; an idea of Yuji Minejima <ggb01164@nifty.ne.jp> and his mcomplete-package.
324 (defvar recentf-list
)
328 ;; These are some things you might want to change.
330 (defun ido-fractionp (n)
331 (and (numberp n
) (> n
0.0) (<= n
1.0)))
334 "Switch between files using substrings."
338 :link
'(emacs-commentary-link :tag
"Commentary" "ido.el")
339 :link
'(emacs-library-link :tag
"Lisp File" "ido.el"))
342 (defcustom ido-mode nil
343 "Determines for which functional group \(buffer and files) ido behavior
344 should be enabled. The following values are possible:
345 - `buffer': Turn only on ido buffer behavior \(switching, killing,
347 - `file': Turn only on ido file behavior \(finding, writing, inserting...)
348 - `both': Turn on ido buffer and file behavior.
349 - `nil': Turn off any ido switching.
351 Setting this variable directly does not take effect;
352 use either \\[customize] or the function `ido-mode'."
353 :set
#'(lambda (symbol value
)
355 :initialize
'custom-initialize-default
357 :link
'(emacs-commentary-link "ido.el")
358 :set-after
'(ido-save-directory-list-file
359 ;; This will clear ido-unc-hosts-cache, so set it
360 ;; before loading history file.
362 :type
'(choice (const :tag
"Turn on only buffer" buffer
)
363 (const :tag
"Turn on only file" file
)
364 (const :tag
"Turn on both buffer and file" both
)
365 (const :tag
"Switch off all" nil
))
368 (defcustom ido-case-fold case-fold-search
369 "Non-nil if searching of buffer and file names should ignore case."
373 (defcustom ido-ignore-buffers
375 "List of regexps or functions matching buffer names to ignore.
376 For example, traditional behavior is not to list buffers whose names begin
377 with a space, for which the regexp is `\\` '. See the source file for
378 example functions that filter buffer names."
379 :type
'(repeat (choice regexp function
))
382 (defcustom ido-ignore-files
383 '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
384 "List of regexps or functions matching file names to ignore.
385 For example, traditional behavior is not to list files whose names begin
386 with a #, for which the regexp is `\\`#'. See the source file for
387 example functions that filter filenames."
388 :type
'(repeat (choice regexp function
))
391 (defcustom ido-ignore-extensions t
392 "Non-nil means ignore files in `completion-ignored-extensions' list."
396 (defcustom ido-show-dot-for-dired nil
397 "Non-nil means to always put . as the first item in file name lists.
398 This allows the current directory to be opened immediately with `dired'."
402 (defcustom ido-file-extensions-order nil
403 "List of file extensions specifying preferred order of file selections.
404 Each element is either a string with `.' as the first char, an empty
405 string matching files without extension, or t which is the default order
406 for files with an unlisted file extension."
407 :type
'(repeat (choice string
408 (const :tag
"Default order" t
)))
411 (defcustom ido-ignore-directories
412 '("\\`CVS/" "\\`\\.\\./" "\\`\\./")
413 "List of regexps or functions matching sub-directory names to ignore."
414 :type
'(repeat (choice regexp function
))
417 (defcustom ido-ignore-directories-merge nil
418 "List of regexps or functions matching directory names to ignore during merge.
419 Directory names matched by one of the regexps in this list are not inserted
420 in merged file and directory lists."
421 :type
'(repeat (choice regexp function
))
424 ;; Examples for setting the value of ido-ignore-buffers
425 ;;(defun ido-ignore-c-mode (name)
426 ;; "Ignore all c mode buffers -- example function for ido."
427 ;; (with-current-buffer name
428 ;; (derived-mode-p 'c-mode)))
430 ;;(setq ido-ignore-buffers '("^ " ido-ignore-c-mode))
432 ;; Examples for setting the value of ido-ignore-files
433 ;;(setq ido-ignore-files '("^ " "\\.c\\'" "\\.h\\'"))
435 (defcustom ido-default-file-method
'raise-frame
436 "How to visit a new file when using `ido-find-file'.
438 `selected-window' Show new file in selected window
439 `other-window' Show new file in another window (same frame)
440 `display' Display file in another window without selecting to it
441 `other-frame' Show new file in another frame
442 `maybe-frame' If a file is visible in another frame, prompt to ask if you
443 you want to see the file in the same window of the current
444 frame or in the other frame
445 `raise-frame' If a file is visible in another frame, raise that
446 frame; otherwise, visit the file in the same window"
447 :type
'(choice (const :tag
"Visit in selected window" selected-window
)
448 (const :tag
"Visit in other window" other-window
)
449 (const :tag
"Display (no select) in other window" display
)
450 (const :tag
"Visit in other frame" other-frame
)
451 (const :tag
"Ask to visit in other frame" maybe-frame
)
452 (const :tag
"Raise frame if already visited" raise-frame
))
455 (defcustom ido-default-buffer-method
'raise-frame
456 "How to switch to new buffer when using `ido-switch-buffer'.
457 See `ido-default-file-method' for details."
458 :type
'(choice (const :tag
"Show in selected window" selected-window
)
459 (const :tag
"Show in other window" other-window
)
460 (const :tag
"Display (no select) in other window" display
)
461 (const :tag
"Show in other frame" other-frame
)
462 (const :tag
"Ask to show in other frame" maybe-frame
)
463 (const :tag
"Raise frame if already shown" raise-frame
))
464 :type
'(choice (const selected-window
)
472 (defcustom ido-enable-flex-matching nil
473 "Non-nil means that `ido' will do flexible string matching.
474 Flexible matching means that if the entered string does not
475 match any item, any item containing the entered characters
476 in the given sequence will match."
481 (defcustom ido-enable-regexp nil
482 "Non-nil means that `ido' will do regexp matching.
483 Value can be toggled within `ido' using `ido-toggle-regexp'."
487 (defcustom ido-enable-prefix nil
488 "Non-nil means only match if the entered text is a prefix of file name.
489 This behavior is like the standard Emacs completion.
490 If nil, match if the entered text is an arbitrary substring.
491 Value can be toggled within `ido' using `ido-toggle-prefix'."
495 (defcustom ido-enable-dot-prefix nil
496 "Non-nil means to match leading dot as prefix.
497 I.e. hidden files and buffers will match only if you type a dot
498 as first char even if `ido-enable-prefix' is nil."
502 (defcustom ido-confirm-unique-completion nil
503 "Non-nil means that even a unique completion must be confirmed.
504 This means that \\[ido-complete] must always be followed by \\[ido-exit-minibuffer]
505 even when there is only one unique completion."
509 (defcustom ido-cannot-complete-command
'ido-completion-help
510 "Command run when `ido-complete' can't complete any more.
511 The most useful values are `ido-completion-help', which pops up a
512 window with completion alternatives, or `ido-next-match' or
513 `ido-prev-match', which cycle the buffer list."
518 (defcustom ido-record-commands t
519 "Non-nil means that `ido' will record commands in command history.
520 Note that the non-ido equivalent command is recorded."
524 (defcustom ido-max-prospects
12
525 "Non-zero means that the prospect list will be limited to that number of items.
526 For a long list of prospects, building the full list for the minibuffer can take a
527 non-negligible amount of time; setting this variable reduces that time."
531 (defcustom ido-max-file-prompt-width
0.35
532 "Non-zero means that the prompt string be limited to that number of characters.
533 If value is a floating point number, it specifies a fraction of the frame width."
535 (integer :tag
"Characters" :value
20)
536 (restricted-sexp :tag
"Fraction of frame width"
538 :match-alternatives
(ido-fractionp)))
541 (defcustom ido-max-window-height nil
542 "Non-nil specifies a value to override `max-mini-window-height'."
544 (const :tag
"Don't override" nil
)
545 (integer :tag
"Number of lines" :value
1)
547 :tag
"Fraction of window height"
549 :match-alternatives
(ido-fractionp)))
552 (defcustom ido-enable-last-directory-history t
553 "Non-nil means that `ido' will remember latest selected directory names.
554 See `ido-last-directory-list' and `ido-save-directory-list-file'."
558 (defcustom ido-max-work-directory-list
50
559 "Maximum number of working directories to record.
560 This is the list of directories where files have most recently been opened.
561 See `ido-work-directory-list' and `ido-save-directory-list-file'."
565 (defcustom ido-work-directory-list-ignore-regexps nil
566 "List of regexps matching directories which should not be recorded.
567 Directory names matched by one of the regexps in this list are not inserted in
568 the `ido-work-directory-list' list."
569 :type
'(repeat regexp
)
573 (defcustom ido-use-filename-at-point nil
574 "Non-nil means that ido shall look for a filename at point.
575 May use `ffap-guesser' to guess whether text at point is a filename.
576 If found, use that as the starting point for filename selection."
578 (const :tag
"Disabled" nil
)
579 (const :tag
"Guess filename" guess
)
580 (other :tag
"Use literal filename" t
))
584 (defcustom ido-use-url-at-point nil
585 "Non-nil means that ido shall look for a URL at point.
586 If found, call `find-file-at-point' to visit it."
591 (defcustom ido-enable-tramp-completion t
592 "Non-nil means that ido shall perform tramp method and server name completion.
593 A tramp file name uses the following syntax: /method:user@host:filename."
597 (defcustom ido-record-ftp-work-directories t
598 "Non-nil means record ftp file names in the work directory list."
602 (defcustom ido-merge-ftp-work-directories nil
603 "If nil, merging ignores ftp file names in the work directory list."
607 (defcustom ido-cache-ftp-work-directory-time
1.0
608 "Maximum time to cache contents of an ftp directory (in hours).
609 Use C-l in prompt to refresh list.
610 If zero, ftp directories are not cached."
614 (defcustom ido-slow-ftp-hosts nil
615 "List of slow ftp hosts where ido prompting should not be used.
616 If an ftp host is on this list, ido automatically switches to the non-ido
617 equivalent function, e.g. `find-file' rather than `ido-find-file'."
618 :type
'(repeat string
)
621 (defcustom ido-slow-ftp-host-regexps nil
622 "List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
623 :type
'(repeat regexp
)
626 (defvar ido-unc-hosts-cache t
627 "Cached value from `ido-unc-hosts' function.")
629 (defcustom ido-unc-hosts nil
630 "List of known UNC host names to complete after initial //.
631 If value is a function, that function is called to search network for
632 hosts on first use of UNC path."
633 :type
'(choice (repeat :tag
"List of UNC host names" string
)
634 (function-item :tag
"Use `NET VIEW'"
635 :value ido-unc-hosts-net-view
)
636 (function :tag
"Your own function"))
637 :set
#'(lambda (symbol value
)
639 (setq ido-unc-hosts-cache t
))
642 (defcustom ido-downcase-unc-hosts t
643 "Non-nil if UNC host names should be downcased."
647 (defcustom ido-ignore-unc-host-regexps nil
648 "List of regexps matching UNC hosts to ignore.
649 Case is ignored if `ido-downcase-unc-hosts' is set."
650 :type
'(repeat regexp
)
653 (defcustom ido-cache-unc-host-shares-time
8.0
654 "Maximum time to cache shares of an UNC host (in hours).
655 Use C-l in prompt to refresh list.
656 If zero, UNC host shares are not cached."
660 (defcustom ido-max-work-file-list
10
661 "Maximum number of names of recently opened files to record.
662 This is the list of the file names (sans directory) which have most recently
663 been opened. See `ido-work-file-list' and `ido-save-directory-list-file'."
667 (defcustom ido-work-directory-match-only t
668 "Non-nil means to skip non-matching directories in the directory history.
669 When some text is already entered at the `ido-find-file' prompt, using
670 \\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories
671 without any matching entries."
675 (defcustom ido-auto-merge-work-directories-length
0
676 "Automatically switch to merged work directories during file name input.
677 The value is number of characters to type before switching to merged mode.
678 If zero, the switch happens when no matches are found in the current directory.
679 Automatic merging is disabled if the value is negative."
683 (defcustom ido-auto-merge-delay-time
0.70
684 "Delay in seconds to wait for more input before doing auto merge."
688 (defcustom ido-auto-merge-inhibit-characters-regexp
"[][*?~]"
689 "Regexp matching characters which should inhibit automatic merging.
690 When a (partial) file name matches this regexp, merging is inhibited."
694 (defcustom ido-merged-indicator
"^"
695 "The string appended to first choice if it has multiple directory choices."
699 (defcustom ido-max-dir-file-cache
100
700 "Maximum number of working directories to be cached.
701 This is the size of the cache of `file-name-all-completions' results.
702 Each cache entry is time stamped with the modification time of the
703 directory. Some systems, like Windows, have unreliable directory
704 modification times, so you may choose to disable caching on such
705 systems, or explicitly refresh the cache contents using the command
706 `ido-reread-directory' command (C-l) in the minibuffer.
707 See also `ido-dir-file-cache' and `ido-save-directory-list-file'."
711 (defcustom ido-max-directory-size
30000
712 "Maximum size (in bytes) for directories to use ido completion.
713 If you enter a directory with a size larger than this size, ido will
714 not provide the normal completion. To show the completions, use C-a."
715 :type
'(choice (const :tag
"No limit" nil
)
716 (integer :tag
"Size in bytes" 30000))
719 (defcustom ido-rotate-file-list-default nil
720 "Non-nil means that `ido' will always rotate file list to get default in front."
724 (defcustom ido-enter-matching-directory
'only
725 "Additional methods to enter sub-directory of first/only matching item.
726 If value is 'first, enter first matching sub-directory when typing a slash.
727 If value is 'only, typing a slash only enters the sub-directory if it is
728 the only matching item.
729 If value is t, automatically enter a sub-directory when it is the only
730 matching item, even without typing a slash."
731 :type
'(choice (const :tag
"Never" nil
)
732 (const :tag
"Slash enters first directory" first
)
733 (const :tag
"Slash enters first and only directory" only
)
734 (other :tag
"Always enter unique directory" t
))
737 (defcustom ido-create-new-buffer
'prompt
738 "Specify whether a new buffer is created if no buffer matches substring.
739 Choices are 'always to create new buffers unconditionally, 'prompt to
740 ask user whether to create buffer, or 'never to never create new buffer."
741 :type
'(choice (const always
)
746 (defcustom ido-setup-hook nil
747 "Hook run after the ido variables and keymap have been setup.
748 The dynamic variable `ido-cur-item' contains the current type of item that
749 is read by ido; possible values are file, dir, buffer, and list.
750 Additional keys can be defined in `ido-completion-map'."
754 (defcustom ido-separator nil
755 "String used by ido to separate the alternatives in the minibuffer.
756 Obsolete. Set 3rd element of `ido-decorations' instead."
757 :type
'(choice string
(const nil
))
760 (defcustom ido-decorations
'( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]" " [Not readable]" " [Too big]" " [Confirm]")
761 "List of strings used by ido to display the alternatives in the minibuffer.
762 There are 11 elements in this list:
763 1st and 2nd elements are used as brackets around the prospect list,
764 3rd element is the separator between prospects (ignored if `ido-separator' is set),
765 4th element is the string inserted at the end of a truncated list of prospects,
766 5th and 6th elements are used as brackets around the common match string which
767 can be completed using TAB,
768 7th element is the string displayed when there are no matches, and
769 8th element is displayed if there is a single match (and faces are not used),
770 9th element is displayed when the current directory is non-readable,
771 10th element is displayed when directory exceeds `ido-max-directory-size',
772 11th element is displayed to confirm creating new file or buffer."
773 :type
'(repeat string
)
776 (defcustom ido-use-virtual-buffers nil
777 "If non-nil, refer to past buffers as well as existing ones.
778 Essentially it works as follows: Say you are visiting a file and
779 the buffer gets cleaned up by mignight.el. Later, you want to
780 switch to that buffer, but find it's no longer open. With
781 virtual buffers enabled, the buffer name stays in the buffer
782 list (using the `ido-virtual' face, and always at the end), and if
783 you select it, it opens the file back up again. This allows you
784 to think less about whether recently opened files are still open
785 or not. Most of the time you can quit Emacs, restart, and then
786 switch to a file buffer that was previously open as if it still
788 This feature relies upon the `recentf' package, which will be
789 enabled if this variable is configured to a non-nil value."
794 (defcustom ido-use-faces t
795 "Non-nil means use ido faces to highlighting first match, only match and
796 subdirs in the alternatives."
800 (defface ido-first-match
'((t (:bold t
)))
801 "Face used by ido for highlighting first match."
804 (defface ido-only-match
'((((class color
))
805 (:foreground
"ForestGreen"))
807 "Face used by ido for highlighting only match."
810 (defface ido-subdir
'((((min-colors 88) (class color
))
811 (:foreground
"red1"))
815 "Face used by ido for highlighting subdirs in the alternatives."
818 (defface ido-virtual
'((t (:inherit font-lock-builtin-face
)))
819 "Face used by ido for matching virtual buffer names."
823 (defface ido-indicator
'((((min-colors 88) (class color
))
824 (:foreground
"yellow1"
828 (:foreground
"yellow"
831 (t (:inverse-video t
)))
832 "Face used by ido for highlighting its indicators."
835 (defface ido-incomplete-regexp
837 (:inherit font-lock-warning-face
)))
838 "Ido face for indicating incomplete regexps."
841 (defcustom ido-make-file-list-hook nil
842 "List of functions to run when the list of matching files is created.
843 Each function on the list may modify the dynamically bound variable
844 `ido-temp-list' which contains the current list of matching files."
848 (defcustom ido-make-dir-list-hook nil
849 "List of functions to run when the list of matching directories is created.
850 Each function on the list may modify the dynamically bound variable
851 `ido-temp-list' which contains the current list of matching directories."
855 (defcustom ido-make-buffer-list-hook nil
856 "List of functions to run when the list of matching buffers is created.
857 Each function on the list may modify the dynamically bound variable
858 `ido-temp-list' which contains the current list of matching buffer names."
862 (defcustom ido-rewrite-file-prompt-functions nil
863 "List of functions to run when the find-file prompt is created.
864 Each function on the list may modify the following dynamically bound
866 dirname - the (abbreviated) directory name
867 to be modified by the hook functions
868 max-width - the max width of the resulting dirname; nil means no limit
869 prompt - the basic prompt (e.g. \"Find File: \")
870 literal - the string shown if doing \"literal\" find; set to nil to omit
871 vc-off - the string shown if version control is inhibited; set to nil to omit
872 prefix - either nil or a fixed prefix for the dirname
874 The following variables are available, but should not be changed:
875 `ido-current-directory' - the unabbreviated directory name
876 item - equals `file' or `dir' depending on the current mode."
880 (defvar ido-rewrite-file-prompt-rules nil
881 "*Alist of rewriting rules for directory names in ido prompts.
882 A list of elements of the form (FROM . TO) or (FROM . FUNC), each
883 meaning to rewrite the directory name if matched by FROM by either
884 substituting the matched string by TO or calling the function FUNC
885 with the current directory name as its only argument and using the
886 return value as the new directory name. In addition, each FUNC may
887 also modify the dynamic variables described for the variable
888 `ido-rewrite-file-prompt-functions'.")
890 (defcustom ido-completion-buffer
"*Ido Completions*"
891 "Name of completion buffer used by ido.
892 Set to nil to disable completion buffers popping up."
896 (defcustom ido-completion-buffer-all-completions nil
897 "Non-nil means to show all completions in completion buffer.
898 Otherwise, only the current list of matches is shown."
902 (defvar ido-all-frames
'visible
903 "*Argument to pass to `walk-windows' when finding visible files.
904 See documentation of `walk-windows' for useful values.")
906 (defcustom ido-minibuffer-setup-hook nil
907 "Ido-specific customization of minibuffer setup.
909 This hook is run during minibuffer setup if `ido' is active.
910 It is intended for use in customizing ido for interoperation
911 with other packages. For instance:
913 \(add-hook 'ido-minibuffer-setup-hook
916 \(make-local-variable 'max-mini-window-height)
917 \(setq max-mini-window-height 3))))
919 will constrain Emacs to a maximum minibuffer height of 3 lines when
920 ido is running. Copied from `icomplete-minibuffer-setup-hook'."
924 (defcustom ido-save-directory-list-file
(convert-standard-filename "~/.ido.last")
925 "File in which the ido state is saved between invocations.
926 Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
927 `ido-work-file-list', and `ido-dir-file-cache'.
928 Must be set before enabling ido mode."
932 (defcustom ido-read-file-name-as-directory-commands
'()
933 "List of commands which uses `read-file-name' to read a directory name.
934 When `ido-everywhere' is non-nil, the commands in this list will read
935 the directory using `ido-read-directory-name'."
936 :type
'(repeat symbol
)
939 (defcustom ido-read-file-name-non-ido
'()
940 "List of commands which shall not read file names the ido way.
941 When `ido-everywhere' is non-nil, the commands in this list will read
942 the file name using normal `read-file-name' style."
943 :type
'(repeat symbol
)
946 (defcustom ido-before-fallback-functions
'()
947 "List of functions to call before calling a fallback command.
948 The fallback command is passed as an argument to the functions."
952 ;;; Internal Variables
954 ;; Persistent variables
956 (defvar ido-completion-map nil
957 "Currently active keymap for ido commands.")
959 (defvar ido-common-completion-map nil
960 "Keymap for all ido commands.")
962 (defvar ido-file-completion-map nil
963 "Keymap for ido file commands.")
965 (defvar ido-file-dir-completion-map nil
966 "Keymap for ido file and directory commands.")
968 (defvar ido-buffer-completion-map nil
969 "Keymap for ido buffer commands.")
971 (defvar ido-file-history nil
972 "History of files selected using `ido-find-file'.")
974 (defvar ido-buffer-history nil
975 "History of buffers selected using `ido-switch-buffer'.")
977 (defvar ido-last-directory-list nil
978 "List of last selected directory names.
979 See `ido-enable-last-directory-history' for details.")
981 (defvar ido-work-directory-list nil
982 "List of actual working directory names.
983 The current directory is inserted at the front of this list whenever a
984 file is opened with `ido-find-file' and family.")
986 (defvar ido-work-file-list nil
987 "List of actual work file names.
988 Opening a file with `ido-find-file' and similar functions
989 inserts the current file name (relative to its containing directory)
990 at the front of this list.")
992 (defvar ido-dir-file-cache nil
993 "List of `file-name-all-completions' results.
994 Each element in the list is of the form (DIR (MTIME) FILE...).")
996 (defvar ido-ignore-item-temp-list nil
997 "List of items to ignore in current ido invocation.
998 Intended to be let-bound by functions which call ido repeatedly.
999 Should never be set permanently.")
1001 ;; Temporary storage
1003 (defvar ido-eoinput
1
1004 "Point where minibuffer input ends and completion info begins.
1005 Copied from `icomplete-eoinput'.")
1006 (make-variable-buffer-local 'ido-eoinput
)
1008 (defvar ido-common-match-string nil
1009 "Stores the string that is common to all matching files.")
1011 (defvar ido-rescan nil
1012 "Non-nil means we need to regenerate the list of matching items.")
1014 (defvar ido-rotate nil
1015 "Non-nil means we are rotating list of matches.")
1017 (defvar ido-text nil
1018 "Stores the users string as it is typed in.")
1020 (defvar ido-text-init nil
1021 "The initial string for the users string it is typed in.")
1023 (defvar ido-input-stack nil
1024 "Stores the users strings when user hits M-b/M-f.")
1026 (defvar ido-matches nil
1027 "List of files currently matching `ido-text'.")
1029 (defvar ido-report-no-match t
1030 "Report [No Match] when no completions matches `ido-text'.")
1032 (defvar ido-exit nil
1033 "Flag to monitor how `ido-find-file' exits.
1034 If equal to `takeprompt', we use the prompt as the file name to be
1037 (defvar ido-current-directory nil
1038 "Current directory for `ido-find-file'.")
1040 (defvar ido-auto-merge-timer nil
1041 "Delay timer for auto merge.")
1043 (defvar ido-use-mycompletion-depth
0
1044 "Non-nil means use `ido' completion feedback.
1045 Is set by ido functions to the current `minibuffer-depth',
1046 so that it doesn't interfere with other minibuffer usage.")
1048 (defvar ido-incomplete-regexp nil
1049 "Non-nil if an incomplete regexp is entered.")
1051 (defvar ido-initial-position nil
1052 "Non-nil means to explicitly cursor on entry to minibuffer.
1053 Value is an integer which is number of chars to right of prompt.")
1055 (defvar ido-virtual-buffers nil
1056 "List of virtual buffers, that is, past visited files.
1057 This is a copy of `recentf-list', pared down and with faces applied.
1058 Only used if `ido-use-virtual-buffers' is non-nil.")
1060 ;;; Variables with dynamic bindings.
1061 ;;; Declared here to keep the byte compiler quiet.
1063 ;; Stores the current ido item type ('file, 'dir, 'buffer, or 'list).
1064 (defvar ido-cur-item
)
1066 ;;; Stores the current default item
1067 (defvar ido-default-item
)
1069 ;; Stores the current list of items that will be searched through.
1070 ;; The list is ordered, so that the most interesting item comes first,
1071 ;; although by default, the files visible in the current frame are put
1072 ;; at the end of the list. Created by `ido-make-item-list'.
1073 (defvar ido-cur-list
)
1075 ;; Stores the choice list for ido-completing-read
1076 (defvar ido-choice-list
)
1078 ;; Stores the list of items which are ignored when building
1079 ;; `ido-cur-list'. It is in no specific order.
1080 (defvar ido-ignored-list
)
1082 ;; Remember if current directory is non-readable (so we cannot do completion).
1083 (defvar ido-directory-nonreadable
)
1085 ;; Remember if current directory is 'huge' (so we don't want to do completion).
1086 (defvar ido-directory-too-big
)
1088 ;; Keep current item list if non-nil.
1089 (defvar ido-keep-item-list
)
1091 ;; Process ido-ignore-* lists.
1092 (defvar ido-process-ignore-lists
)
1094 ;; Don't process ido-ignore- lists once.
1095 (defvar ido-process-ignore-lists-inhibit
)
1097 ;; Buffer from which ido was entered.
1098 (defvar ido-entry-buffer
)
1100 ;; Non-nil if matching file must be selected.
1101 (defvar ido-require-match
)
1103 ;; Non-nil if we should add [confirm] to prompt
1104 (defvar ido-show-confirm-message
)
1106 ;; Stores a temporary version of the file list being created.
1107 (defvar ido-temp-list
)
1109 ;; Non-nil if default list element should be rotated into place.
1110 (defvar ido-rotate-temp
)
1112 ;; Stores current index in ido-work-directory-list.
1113 (defvar ido-work-directory-index
)
1115 ;; Stores current index in ido-work-file-list.
1116 (defvar ido-work-file-index
)
1118 ;; Set when merged work directory list is in use.
1119 (defvar ido-use-merged-list
)
1121 ;; Set when merged work directory list not yet built.
1122 (defvar ido-try-merged-list
)
1124 ;; Saved state prior to last work directory merge.
1125 ;; Value is a list (ido-text dir cur-list ignored-list matches).
1126 (defvar ido-pre-merge-state
)
1128 ;; Original value of vc-handled-backends for use in ido-toggle-vc.
1129 (defvar ido-saved-vc-hb
)
1131 ;; Stores temporary state of literal find file.
1132 (defvar ido-find-literal
)
1134 ;; Set to 'ignore to inhibit switching between find-file/switch-buffer.
1135 (defvar ido-context-switch-command
)
1139 (defun ido-active (&optional merge
)
1142 (and (boundp 'ido-completing-read
)
1143 (or (featurep 'xemacs
)
1144 (= ido-use-mycompletion-depth
(minibuffer-depth))))))
1146 (defvar ido-trace-enable nil
)
1148 (defun ido-trace (p &optional s retval
)
1149 (if ido-trace-enable
1150 (let ((b (get-buffer-create " *IDO Trace*"))
1151 (deactivate-mark deactivate-mark
))
1155 (insert p
": " (if (stringp s
) s
(format "%S" s
)) "\n")))))
1158 (defun ido-toggle-trace (arg)
1160 (setq ido-trace-enable
(or arg
(not ido-trace-enable
)))
1161 (if ido-trace-enable
1162 (message "IDO trace on"))
1163 (let ((b (get-buffer " *IDO Trace*")))
1165 (if ido-trace-enable
1167 (pop-to-buffer b t t
)
1168 (setq truncate-lines t
)))))
1170 (defun ido-local-file-exists-p (file)
1171 "Tell if FILE exists locally."
1172 (let (file-name-handler-alist)
1173 (file-exists-p file
)))
1175 (defun ido-unc-hosts (&optional query
)
1176 "Return list of UNC host names."
1179 ((listp ido-unc-hosts
)
1180 ido-unc-hosts
) ;; static list or nil
1181 ((listp ido-unc-hosts-cache
)
1182 ido-unc-hosts-cache
) ;; result of net search
1183 ((and query
(fboundp ido-unc-hosts
))
1184 (message (propertize "Searching for UNC hosts..." 'face
'highlight
))
1185 (setq ido-unc-hosts-cache
(funcall ido-unc-hosts
))
1187 ido-unc-hosts-cache
)
1189 (setq ido-unc-hosts-cache nil
))
1190 (t (fboundp ido-unc-hosts
)))))
1192 (let ((case-fold-search ido-downcase-unc-hosts
)
1193 res host re-list re
)
1195 (setq host
(car hosts
)
1197 re-list
(and ido-process-ignore-lists
1198 ido-ignore-unc-host-regexps
))
1200 (setq re
(car re-list
)
1201 re-list
(cdr re-list
))
1202 (if (string-match re host
)
1206 (when ido-downcase-unc-hosts
1207 (setq host
(downcase host
)))
1208 (setq res
(cons host res
))))
1209 (setq hosts
(sort res
#'string
<))))
1212 (defun ido-unc-hosts-net-view ()
1213 "Query network for list of UNC host names using `NET VIEW'."
1216 (shell-command "net view" t
)
1217 (goto-char (point-min))
1218 (while (re-search-forward "^\\\\\\\\\\([[:graph:]]+\\)" nil t
)
1219 (setq hosts
(cons (match-string 1) hosts
))))
1222 (defun ido-is-tramp-root (&optional dir
)
1223 (and ido-enable-tramp-completion
1224 (string-match "\\`/[^/]+[@:]\\'"
1225 (or dir ido-current-directory
))))
1227 (defun ido-is-unc-root (&optional dir
)
1228 (and (ido-unc-hosts)
1230 (or dir ido-current-directory
))))
1232 (defun ido-is-unc-host (&optional dir
)
1233 (and (ido-unc-hosts)
1234 (string-match "\\`//[^/]+/\\'"
1235 (or dir ido-current-directory
))))
1237 (defun ido-is-root-directory (&optional dir
)
1238 (setq dir
(or dir ido-current-directory
))
1240 (string-equal "/" dir
)
1241 (and (memq system-type
'(windows-nt ms-dos
))
1242 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir
))
1243 (if ido-enable-tramp-completion
1244 (ido-is-tramp-root dir
)
1245 (string-match "\\`/[^:/][^:/]+:\\'" dir
))))
1247 (defun ido-is-ftp-directory (&optional dir
)
1249 (if ido-enable-tramp-completion
1250 "\\`/[^/:][^/:]+:" ;; like tramp-file-name-regexp-unified, but doesn't match single drive letters
1251 "\\`/[^/:][^/:]+:/")
1252 (or dir ido-current-directory
)))
1254 (defun ido-is-slow-ftp-host (&optional dir
)
1255 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps
)
1256 (setq dir
(or dir ido-current-directory
))
1257 ;; (featurep 'ange-ftp)
1258 ;; (ange-ftp-ftp-name dir)
1260 (if ido-enable-tramp-completion
1261 "\\`/\\([^/]+[@:]\\)*\\([^@/:][^@/:]+\\):"
1262 "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/")
1264 (let ((host (substring dir
(match-beginning 2) (match-end 2))))
1265 (or (member host ido-slow-ftp-hosts
)
1266 (let ((re ido-slow-ftp-host-regexps
))
1267 (while (and re
(not (string-match (car re
) host
)))
1271 (defun ido-time-stamp (&optional time
)
1272 ;; Time is a floating point number (fractions of 1 hour)
1273 (setq time
(or time
(current-time)))
1274 (/ (+ (* (car time
) 65536.0) (car (cdr time
))) 3600.0))
1276 (defun ido-cache-ftp-valid (&optional time
)
1277 (and (numberp ido-cache-ftp-work-directory-time
)
1278 (> ido-cache-ftp-work-directory-time
0)
1280 (< (- (ido-time-stamp) time
) ido-cache-ftp-work-directory-time
))))
1282 (defun ido-cache-unc-valid (&optional time
)
1283 (and (numberp ido-cache-unc-host-shares-time
)
1284 (> ido-cache-unc-host-shares-time
0)
1286 (< (- (ido-time-stamp) time
) ido-cache-unc-host-shares-time
))))
1288 (defun ido-may-cache-directory (&optional dir
)
1289 (setq dir
(or dir ido-current-directory
))
1291 ((and (ido-is-root-directory dir
)
1292 (or ido-enable-tramp-completion
1293 (memq system-type
'(windows-nt ms-dos
))))
1295 ((ido-is-unc-host dir
)
1296 (ido-cache-unc-valid))
1297 ((ido-is-ftp-directory dir
)
1298 (ido-cache-ftp-valid))
1299 ((ido-directory-too-big-p dir
)
1303 (defun ido-pp (list &optional sep
)
1304 (let ((print-level nil
) (eval-expression-print-level nil
)
1305 (print-length nil
) (eval-expression-print-length nil
))
1306 (insert "\n;; ----- " (symbol-name list
) " -----\n(\n ")
1307 (setq list
(symbol-value list
))
1309 (let* ((elt (car list
))
1310 (s (if (consp elt
) (car elt
) elt
)))
1311 (if (and (stringp s
) (= (length s
) 0))
1314 (prin1 elt
(current-buffer)))
1315 (if (and (setq list
(cdr list
)) s
)
1316 (insert (or sep
"\n ")))))
1319 (defun ido-save-history ()
1320 "Save ido history and cache information between sessions."
1322 (when (and ido-last-directory-list ido-save-directory-list-file
)
1323 (let ((buf (get-buffer-create " *ido session*"))
1324 (version-control 'never
))
1326 (with-current-buffer buf
1328 (insert ";;; -*- coding: utf-8 -*-\n")
1329 (setq buffer-file-coding-system
'utf-8
)
1330 (ido-pp 'ido-last-directory-list
)
1331 (ido-pp 'ido-work-directory-list
)
1332 (ido-pp 'ido-work-file-list
)
1333 (ido-pp 'ido-dir-file-cache
"\n\n ")
1334 (if (listp ido-unc-hosts-cache
)
1335 (ido-pp 'ido-unc-hosts-cache
)
1336 (insert "\n;; ----- ido-unc-hosts-cache -----\nt\n"))
1337 (write-file ido-save-directory-list-file nil
))
1338 (kill-buffer buf
)))))
1340 (defun ido-load-history (&optional arg
)
1341 "Load ido history and cache information from previous session.
1342 With prefix argument, reload history unconditionally."
1344 (if (or arg
(and ido-save-directory-list-file
(not ido-last-directory-list
)))
1345 (let ((file (expand-file-name ido-save-directory-list-file
))
1347 (when (file-readable-p file
)
1348 (setq buf
(get-buffer-create " *ido session*"))
1350 (with-current-buffer buf
1352 (insert-file-contents file
)
1354 (setq ido-last-directory-list
(read (current-buffer))
1355 ido-work-directory-list
(read (current-buffer))
1356 ido-work-file-list
(read (current-buffer))
1357 ido-dir-file-cache
(read (current-buffer))
1358 ido-unc-hosts-cache
(read (current-buffer)))
1360 (kill-buffer buf
)))))
1363 (defun ido-wash-history ()
1364 "Clean-up ido history and cache information.
1365 Removes badly formatted data and ignored directories."
1367 ;; Check format of each of our lists, discard bogus elements
1368 (setq ido-last-directory-list
1369 (and (listp ido-last-directory-list
)
1370 (let ((l ido-last-directory-list
) r
)
1372 (if (and (consp (car l
))
1373 (stringp (car (car l
)))
1374 (stringp (cdr (car l
))))
1375 (setq r
(cons (car l
) r
)))
1378 (setq ido-work-directory-list
1379 (and (listp ido-work-directory-list
)
1380 (let ((l ido-work-directory-list
) r
)
1382 (if (and (stringp (car l
))
1383 (or ido-record-ftp-work-directories
1384 (not (ido-is-ftp-directory (car l
)))))
1385 (setq r
(cons (car l
) r
)))
1388 (setq ido-work-file-list
1389 (and (listp ido-work-file-list
)
1390 (let ((l ido-work-file-list
) r
)
1392 (if (stringp (car l
))
1393 (setq r
(cons (car l
) r
)))
1396 (setq ido-dir-file-cache
1397 (and (listp ido-dir-file-cache
)
1398 (let ((l ido-dir-file-cache
) r
)
1400 (if (and (listp (car l
))
1401 (> (length (car l
)) 2)
1402 (let ((dir (car (car l
)))
1403 (time (car (cdr (car l
))))
1404 (files (cdr (cdr (car l
)))))
1409 ((integerp (car time
))
1410 (and (/= (car time
) 0)
1411 (integerp (car (cdr time
)))
1412 (/= (car (cdr time
)) 0)
1413 (ido-may-cache-directory dir
)))
1414 ((eq (car time
) 'ftp
)
1415 (and (numberp (cdr time
))
1416 (ido-is-ftp-directory dir
)
1417 (ido-cache-ftp-valid (cdr time
))))
1418 ((eq (car time
) 'unc
)
1419 (and (numberp (cdr time
))
1420 (ido-is-unc-host dir
)
1421 (ido-cache-unc-valid (cdr time
))))
1423 (let ((s files
) (ok t
))
1425 (if (stringp (car s
))
1427 (setq s nil ok nil
)))
1429 (setq r
(cons (car l
) r
)))
1433 ;; Remove ignored directories from work directory list
1434 ;; according to ido-work-directory-list-ignore-regexps
1435 (if ido-work-directory-list
1436 (let ((dirs (reverse ido-work-directory-list
)))
1437 (setq ido-work-directory-list nil
)
1439 (ido-record-work-directory (car dirs
))
1440 (setq dirs
(cdr dirs
)))))
1441 ;; Get rid of text properties
1442 (let ((l ido-last-directory-list
) e
)
1444 (setq e
(car l
) l
(cdr l
))
1445 (set-text-properties 0 (length (car e
)) nil
(car e
))
1446 (set-text-properties 0 (length (cdr e
)) nil
(cdr e
))))
1447 (let ((l ido-work-directory-list
) e
)
1449 (setq e
(car l
) l
(cdr l
))
1450 (set-text-properties 0 (length e
) nil e
)))
1451 (let ((l ido-work-file-list
) e
)
1453 (setq e
(car l
) l
(cdr l
))
1454 (set-text-properties 0 (length e
) nil e
)))
1455 (let ((l ido-dir-file-cache
) e d
)
1457 (setq e
(car l
) l
(cdr l
))
1460 (setq d
(car e
) e
(cdr e
))
1462 (set-text-properties 0 (length d
) nil d
)))))))
1465 (defun ido-kill-emacs-hook ()
1466 ;; ido kill emacs hook
1469 (defun ido-common-initialization ()
1470 (ido-init-completion-maps)
1471 (add-hook 'minibuffer-setup-hook
'ido-minibuffer-setup
)
1472 (add-hook 'choose-completion-string-functions
'ido-choose-completion-string
))
1474 (define-minor-mode ido-everywhere
1475 "Toggle using ido-mode everywhere file and directory names are read.
1476 With ARG, turn ido-mode on if arg is positive, off otherwise."
1479 (when (get 'ido-everywhere
'file
)
1480 (setq read-file-name-function
(car (get 'ido-everywhere
'file
)))
1481 (put 'ido-everywhere
'file nil
))
1482 (when (get 'ido-everywhere
'buffer
)
1483 (setq read-buffer-function
(car (get 'ido-everywhere
'buffer
)))
1484 (put 'ido-everywhere
'buffer nil
))
1485 (when ido-everywhere
1486 (when (memq ido-mode
'(both file
))
1487 (put 'ido-everywhere
'file
(cons read-file-name-function nil
))
1488 (setq read-file-name-function
'ido-read-file-name
))
1489 (when (memq ido-mode
'(both buffer
))
1490 (put 'ido-everywhere
'buffer
(cons read-buffer-function nil
))
1491 (setq read-buffer-function
'ido-read-buffer
))))
1493 (defvar ido-minor-mode-map-entry nil
)
1496 (defun ido-mode (&optional arg
)
1497 "Toggle ido mode on or off.
1498 With ARG, turn ido-mode on if arg is positive, off otherwise.
1499 Turning on ido-mode will remap (via a minor-mode keymap) the default
1500 keybindings for the `find-file' and `switch-to-buffer' families of
1501 commands to the ido versions of these functions.
1502 However, if ARG arg equals 'files, remap only commands for files, or
1503 if it equals 'buffers, remap only commands for buffer switching.
1504 This function also adds a hook to the minibuffer."
1508 ((null arg
) (if ido-mode nil
'both
))
1510 ((eq arg
'files
) 'file
)
1511 ((eq arg
'buffers
) 'buffer
)
1512 ((memq arg
'(file buffer both
)) arg
)
1513 ((> (prefix-numeric-value arg
) 0) 'both
)
1516 (ido-everywhere (if ido-everywhere
1 -
1))
1519 (ido-common-initialization)
1522 (add-hook 'kill-emacs-hook
'ido-kill-emacs-hook
)
1524 (let ((map (make-sparse-keymap)))
1525 (when (memq ido-mode
'(file both
))
1526 (define-key map
[remap find-file
] 'ido-find-file
)
1527 (define-key map
[remap find-file-read-only
] 'ido-find-file-read-only
)
1528 (define-key map
[remap find-alternate-file
] 'ido-find-alternate-file
)
1529 (define-key map
[remap write-file
] 'ido-write-file
)
1530 (define-key map
[remap insert-file
] 'ido-insert-file
)
1531 (define-key map
[remap list-directory
] 'ido-list-directory
)
1532 (define-key map
[remap dired
] 'ido-dired
)
1533 (define-key map
[remap find-file-other-window
]
1534 'ido-find-file-other-window
)
1535 (define-key map
[remap find-file-read-only-other-window
]
1536 'ido-find-file-read-only-other-window
)
1537 (define-key map
[remap find-file-other-frame
]
1538 'ido-find-file-other-frame
)
1539 (define-key map
[remap find-file-read-only-other-frame
]
1540 'ido-find-file-read-only-other-frame
))
1542 (when (memq ido-mode
'(buffer both
))
1543 (define-key map
[remap switch-to-buffer
] 'ido-switch-buffer
)
1544 (define-key map
[remap switch-to-buffer-other-window
]
1545 'ido-switch-buffer-other-window
)
1546 (define-key map
[remap switch-to-buffer-other-frame
]
1547 'ido-switch-buffer-other-frame
)
1548 (define-key map
[remap insert-buffer
] 'ido-insert-buffer
)
1549 (define-key map
[remap kill-buffer
] 'ido-kill-buffer
)
1550 (define-key map
[remap display-buffer
] 'ido-display-buffer
))
1552 (if ido-minor-mode-map-entry
1553 (setcdr ido-minor-mode-map-entry map
)
1554 (setq ido-minor-mode-map-entry
(cons 'ido-mode map
))
1555 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry
))))
1557 (message "Ido mode %s" (if ido-mode
"enabled" "disabled")))
1561 (defun ido-init-completion-maps ()
1562 "Set up the completion keymaps used by `ido'."
1565 (let ((map (make-sparse-keymap)))
1566 (define-key map
"\C-a" 'ido-toggle-ignore
)
1567 (define-key map
"\C-c" 'ido-toggle-case
)
1568 (define-key map
"\C-e" 'ido-edit-input
)
1569 (define-key map
"\t" 'ido-complete
)
1570 (define-key map
" " 'ido-complete-space
)
1571 (define-key map
"\C-j" 'ido-select-text
)
1572 (define-key map
"\C-m" 'ido-exit-minibuffer
)
1573 (define-key map
"\C-p" 'ido-toggle-prefix
)
1574 (define-key map
"\C-r" 'ido-prev-match
)
1575 (define-key map
"\C-s" 'ido-next-match
)
1576 (define-key map
"\C-t" 'ido-toggle-regexp
)
1577 (define-key map
"\C-z" 'ido-undo-merge-work-directory
)
1578 (define-key map
[(control ?\s
)] 'ido-restrict-to-matches
)
1579 (define-key map
[(meta ?\s
)] 'ido-take-first-match
)
1580 (define-key map
[(control ?
@)] 'ido-restrict-to-matches
)
1581 (define-key map
[right] 'ido-next-match)
1582 (define-key map [left] 'ido-prev-match)
1583 (define-key map "?" 'ido-completion-help)
1585 (define-key map "\C-b" 'ido-magic-backward-char)
1586 (define-key map "\C-f" 'ido-magic-forward-char)
1587 (define-key map "\C-d" 'ido-magic-delete-char)
1588 (set-keymap-parent map minibuffer-local-map)
1589 (setq ido-common-completion-map map))
1591 ;; File and directory map
1592 (let ((map (make-sparse-keymap)))
1593 (define-key map "\C-x\C-b" 'ido-enter-switch-buffer)
1594 (define-key map "\C-x\C-f" 'ido-fallback-command)
1595 (define-key map "\C-x\C-d" 'ido-enter-dired)
1596 (define-key map [down] 'ido-next-match-dir)
1597 (define-key map [up] 'ido-prev-match-dir)
1598 (define-key map [(meta up)] 'ido-prev-work-directory)
1599 (define-key map [(meta down)] 'ido-next-work-directory)
1600 (define-key map [backspace] 'ido-delete-backward-updir)
1601 (define-key map "\d" 'ido-delete-backward-updir)
1602 (define-key map [remap delete-backward-char] 'ido-delete-backward-updir) ; BS
1603 (define-key map [remap backward-kill-word] 'ido-delete-backward-word-updir) ; M-DEL
1605 (define-key map [(control backspace)] 'ido-up-directory)
1606 (define-key map "\C-l" 'ido-reread-directory)
1607 (define-key map [(meta ?d)] 'ido-wide-find-dir-or-delete-dir)
1608 (define-key map [(meta ?b)] 'ido-push-dir)
1609 (define-key map [(meta ?v)] 'ido-push-dir-first)
1610 (define-key map [(meta ?f)] 'ido-wide-find-file-or-pop-dir)
1611 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1612 (define-key map [(meta ?m)] 'ido-make-directory)
1613 (define-key map [(meta ?n)] 'ido-next-work-directory)
1614 (define-key map [(meta ?o)] 'ido-prev-work-file)
1615 (define-key map [(meta control ?o)] 'ido-next-work-file)
1616 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1617 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1618 (set-keymap-parent map ido-common-completion-map)
1619 (setq ido-file-dir-completion-map map))
1622 (let ((map (make-sparse-keymap)))
1623 (define-key map "\C-k" 'ido-delete-file-at-head)
1624 (define-key map "\C-o" 'ido-copy-current-word)
1625 (define-key map "\C-w" 'ido-copy-current-file-name)
1626 (define-key map [(meta ?l)] 'ido-toggle-literal)
1627 (set-keymap-parent map ido-file-dir-completion-map)
1628 (setq ido-file-completion-map map))
1631 (let ((map (make-sparse-keymap)))
1632 (define-key map "\C-x\C-f" 'ido-enter-find-file)
1633 (define-key map "\C-x\C-b" 'ido-fallback-command)
1634 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1635 (define-key map "\C-o" 'ido-toggle-virtual-buffers)
1636 (set-keymap-parent map ido-common-completion-map)
1637 (setq ido-buffer-completion-map map)))
1640 (defun ido-setup-completion-map ()
1641 "Set up the keymap for `ido'."
1643 ;; generated every time so that it can inherit new functions.
1644 (let ((map (make-sparse-keymap))
1645 (viper-p (if (boundp 'viper-mode) viper-mode)))
1648 (define-key map [remap viper-intercept-ESC-key] 'ignore))
1651 ((memq ido-cur-item '(file dir))
1652 (when ido-context-switch-command
1653 (define-key map "\C-x\C-b" ido-context-switch-command)
1654 (define-key map "\C-x\C-d" 'ignore))
1656 (define-key map [remap viper-backward-char] 'ido-delete-backward-updir)
1657 (define-key map [remap viper-del-backward-char-in-insert] 'ido-delete-backward-updir)
1658 (define-key map [remap viper-delete-backward-word] 'ido-delete-backward-word-updir))
1659 (set-keymap-parent map
1660 (if (eq ido-cur-item 'file)
1661 ido-file-completion-map
1662 ido-file-dir-completion-map)))
1664 ((eq ido-cur-item 'buffer)
1665 (when ido-context-switch-command
1666 (define-key map "\C-x\C-f" ido-context-switch-command))
1667 (set-keymap-parent map ido-buffer-completion-map))
1670 (set-keymap-parent map ido-common-completion-map)))
1672 (setq ido-completion-map map)))
1674 (defun ido-final-slash (dir &optional fix-it)
1675 ;; return DIR if DIR has final slash.
1676 ;; else if FIX-IT is non-nil, return DIR/
1678 (setq dir (ido-name dir))
1680 ((string-match "/\\'" dir) dir)
1681 ((ido-is-tramp-root dir) dir)
1682 (fix-it (concat dir "/"))
1685 (defun ido-no-final-slash (s)
1686 ;; Remove optional final slash from string S
1687 (let ((l (1- (length s))))
1688 (if (and (> l 0) (eq (aref s l) ?/))
1692 (defun ido-nonreadable-directory-p (dir)
1693 ;; Return t if dir is a directory, but not readable
1694 ;; Do not check for non-readable directories via tramp, as this causes a premature
1695 ;; connect on incomplete tramp paths (after entring just method:).
1696 (let ((ido-enable-tramp-completion nil))
1697 (and (ido-final-slash dir)
1698 (not (ido-is-unc-host dir))
1699 (file-directory-p dir)
1700 (not (file-readable-p dir)))))
1702 (defun ido-directory-too-big-p (dir)
1703 ;; Return t if dir is a directory, but too big to show
1704 ;; Do not check for non-readable directories via tramp, as this causes a premature
1705 ;; connect on incomplete tramp paths (after entring just method:).
1706 (let ((ido-enable-tramp-completion nil))
1707 (and (numberp ido-max-directory-size)
1708 (ido-final-slash dir)
1709 (not (ido-is-unc-host dir))
1710 (file-directory-p dir)
1711 (> (nth 7 (file-attributes dir)) ido-max-directory-size))))
1713 (defun ido-set-current-directory (dir &optional subdir no-merge)
1714 ;; Set ido's current directory to DIR or DIR/SUBDIR
1715 (unless (and ido-enable-tramp-completion
1716 (string-match "\\`/[^/]*@\\'" dir))
1717 (setq dir (ido-final-slash dir t)))
1718 (setq ido-use-merged-list nil
1719 ido-try-merged-list (not no-merge))
1721 (setq dir (concat dir subdir))
1722 (unless (and ido-enable-tramp-completion
1723 (string-match "\\`/[^/]*@\\'" dir))
1724 (setq dir (ido-final-slash dir t))))
1725 (if (get-buffer ido-completion-buffer)
1726 (kill-buffer ido-completion-buffer))
1728 ((equal dir ido-current-directory)
1730 ((ido-is-unc-root dir)
1731 (ido-trace "unc" dir)
1732 (setq ido-current-directory dir)
1733 (setq ido-directory-nonreadable nil)
1734 (setq ido-directory-too-big nil)
1737 (ido-trace "cd" dir)
1738 (setq ido-current-directory dir)
1739 (if (get-buffer ido-completion-buffer)
1740 (kill-buffer ido-completion-buffer))
1741 (setq ido-directory-nonreadable (ido-nonreadable-directory-p dir))
1742 (setq ido-directory-too-big (and (not ido-directory-nonreadable)
1743 (ido-directory-too-big-p dir)))
1746 (defun ido-set-current-home (&optional dir)
1747 ;; Set ido's current directory to user's home directory
1748 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1750 (defun ido-record-command (command arg)
1751 ;; Add (command arg) to command-history if ido-record-commands is t
1752 (if ido-record-commands
1753 (let ((cmd (list command arg)))
1754 (if (or (not command-history)
1755 (not (equal cmd (car command-history))))
1756 (setq command-history (cons cmd command-history))))))
1758 (defun ido-make-prompt (item prompt)
1759 ;; Make the prompt for ido-read-internal
1761 ((and (memq item '(file dir)) ido-current-directory)
1762 (let ((dirname (abbreviate-file-name ido-current-directory))
1763 (max-width (if (and ido-max-file-prompt-width (floatp ido-max-file-prompt-width))
1764 (floor (* (frame-width) ido-max-file-prompt-width))
1765 ido-max-file-prompt-width))
1766 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1767 (vc-off (and ido-saved-vc-hb (not vc-handled-backends) "[-VC] "))
1769 (rule ido-rewrite-file-prompt-rules))
1770 (let ((case-fold-search nil))
1772 (if (and (consp (car rule))
1773 (string-match (car (car rule)) dirname))
1775 (if (stringp (cdr (car rule)))
1776 (replace-match (cdr (car rule)) t nil dirname)
1777 (funcall (cdr (car rule)) dirname))))
1778 (setq rule (cdr rule))))
1779 (run-hooks 'ido-rewrite-file-prompt-functions)
1781 ; (if ido-process-ignore-lists "" "&")
1785 (let ((l (length dirname)))
1786 (if (and max-width (> max-width 0) (> l max-width))
1787 (let* ((s (substring dirname (- max-width)))
1788 (i (string-match "/" s)))
1789 (concat "..." (if i (substring s i) s)))
1793 ;; Here is very briefly how ido-find-file works:
1796 ;; (ido-file-internal method)
1797 ;; set ido-current-directory
1798 ;; (ido-read-internal 'file ...)
1800 ;; (ido-make-item-list ...)
1801 ;; (ido-set-matches)
1802 ;; (completing-read ... ido-text-init ...)
1804 ;; ... here user is allowed to type characters and commands
1805 ;; a command may set ido-exit and call (exit-minibuffer)
1806 ;; to make ido-read-internal do advanced tasks (or return)
1808 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1809 ;; which are run before and after each user command.
1811 ;; return value from completing-read is stored in ido-final-text
1812 ;; - ido-exit may cause further actions to be taken:
1813 ;; 'refresh - repeat loop (make-item-list, set-matches)
1814 ;; 'edit - edit the prompt string, then repeat loop
1815 ;; 'keep - repeat loop but don't (re)make-item-list
1816 ;; 'updir - go up one directory, repeat loop
1817 ;; else set ido-selected based on ido-final-text,
1818 ;; optionally update ido-current-directory and repeat loop, or
1819 ;; exit with the return value of ido-selected (file name)
1820 ;; selected file name is returned from ido-read-internal,
1821 ;; ido-exit and method determines what action is taken
1822 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1823 ;; the relevant function is called (find-file, write-file, etc).
1825 (defun ido-read-internal (item prompt history &optional default require-match initial)
1826 "Perform the `ido-read-buffer' and `ido-read-file-name' functions.
1827 Return the name of a buffer or file selected.
1828 PROMPT is the prompt to give to the user.
1829 DEFAULT if given is the default item to start with.
1830 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1831 If INITIAL is non-nil, it specifies the initial input string."
1833 ((ido-cur-item item)
1834 (ido-entry-buffer (current-buffer))
1835 (ido-process-ignore-lists t)
1836 (ido-process-ignore-lists-inhibit nil)
1837 (ido-set-default-item t)
1842 (icomplete-mode nil) ;; prevent icomplete starting up
1843 ;; Exported dynamic variables:
1846 (ido-rotate-temp nil)
1847 (ido-keep-item-list nil)
1848 (ido-use-merged-list nil)
1849 (ido-try-merged-list t)
1850 (ido-pre-merge-state nil)
1851 (ido-case-fold ido-case-fold)
1852 (ido-enable-prefix ido-enable-prefix)
1853 (ido-enable-regexp ido-enable-regexp)
1854 (ido-show-confirm-message nil)
1857 (ido-setup-completion-map)
1858 (setq ido-text-init initial)
1859 (setq ido-input-stack nil)
1861 (run-hooks 'ido-setup-hook)
1864 (ido-trace "\n_LOOP_" ido-text-init)
1867 (setq ido-rotate nil)
1869 (when ido-set-default-item
1870 (setq ido-default-item
1873 (if (bufferp default) (buffer-name default) default))
1875 (if (memq item '(file dir))
1876 (file-name-nondirectory default)
1879 (and ido-enable-last-directory-history
1880 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1881 (and d (cdr d)))))))
1882 (if (member ido-default-item ido-ignore-item-temp-list)
1883 (setq ido-default-item nil))
1884 (ido-trace "new default" ido-default-item)
1885 (if ido-default-item
1886 (setq ido-initial-position 0))
1887 (setq ido-set-default-item nil))
1889 (if ido-process-ignore-lists-inhibit
1890 (setq ido-process-ignore-lists nil))
1892 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1893 (let ((olist ido-cur-list)
1894 (oign ido-ignored-list)
1896 (l (ido-make-merged-file-list ido-text-init
1897 (eq ido-use-merged-list 'auto)
1898 (eq ido-try-merged-list 'wide))))
1899 (ido-trace "merged" l)
1902 (if (eq ido-try-merged-list 'wide)
1903 (setq ido-pre-merge-state
1904 (list "" ido-current-directory olist oign omat)
1906 ido-ignored-list nil
1908 ido-keep-item-list t
1909 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1910 ido-use-merged-list nil)
1911 (setq ido-cur-list olist
1912 ido-ignored-list oign
1914 ido-keep-item-list t
1915 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1916 ido-use-merged-list nil)))
1918 (setq ido-use-merged-list nil))
1919 ((eq l 'input-pending-p)
1920 (setq ido-try-merged-list t
1921 ido-use-merged-list nil))
1923 (setq ido-pre-merge-state
1924 (list ido-text-init ido-current-directory olist oign omat))
1925 (ido-set-current-directory (car (cdr (car l))))
1926 (if (ido-final-slash ido-text-init)
1927 (setq ido-text-init ""))
1928 (setq ido-cur-list l
1929 ido-ignored-list nil
1932 ido-keep-item-list t
1933 ido-use-merged-list t)
1934 (ido-trace "Merged" t)
1939 (setq ido-keep-item-list nil
1941 ((eq ido-cur-item 'file)
1942 (setq ido-ignored-list nil
1943 ido-cur-list (and (not ido-directory-nonreadable)
1944 (not ido-directory-too-big)
1945 (ido-make-file-list ido-default-item))))
1946 ((eq ido-cur-item 'dir)
1947 (setq ido-ignored-list nil
1948 ido-cur-list (and (not ido-directory-nonreadable)
1949 (not ido-directory-too-big)
1950 (ido-make-dir-list ido-default-item))))
1951 ((eq ido-cur-item 'buffer)
1952 (setq ido-ignored-list nil
1953 ido-cur-list (ido-make-buffer-list ido-default-item)))
1954 ((eq ido-cur-item 'list)
1955 (setq ido-ignored-list nil
1956 ido-cur-list (ido-make-choice-list ido-default-item)))
1958 (setq ido-rotate-temp nil)
1960 (if ido-process-ignore-lists-inhibit
1961 (setq ido-process-ignore-lists t
1962 ido-process-ignore-lists-inhibit nil))
1965 (if (and ido-matches (eq ido-try-merged-list 'auto))
1966 (setq ido-try-merged-list t))
1968 ((minibuffer-local-completion-map
1969 (if (memq ido-cur-item '(file dir))
1970 minibuffer-local-completion-map
1971 ido-completion-map))
1972 (minibuffer-local-filename-completion-map
1973 (if (memq ido-cur-item '(file dir))
1975 minibuffer-local-filename-completion-map))
1976 (max-mini-window-height (or ido-max-window-height
1977 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1978 (ido-completing-read t)
1979 (ido-require-match require-match)
1980 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1981 (show-paren-mode nil))
1982 ;; prompt the user for the file name
1984 (setq ido-final-text
1987 (ido-make-prompt item prompt)
1988 '(("dummy" . 1)) nil nil ; table predicate require-match
1989 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1991 (ido-trace "completing-read" ido-final-text)
1992 (if (get-buffer ido-completion-buffer)
1993 (kill-buffer ido-completion-buffer))
1995 (ido-trace "\n_EXIT_" ido-exit)
1998 ((eq ido-exit 'refresh)
1999 (if (and (eq ido-use-merged-list 'auto)
2000 (or (input-pending-p)))
2001 (setq ido-use-merged-list nil
2002 ido-keep-item-list t))
2005 ((eq ido-exit 'done)
2007 ido-selected ido-text
2010 ((memq ido-exit '(edit chdir))
2012 ((memq ido-cur-item '(file dir))
2013 (let* ((read-file-name-function nil)
2014 (edit (eq ido-exit 'edit))
2015 (d ido-current-directory)
2018 (setq ido-text-init "")
2022 (read-file-name (concat prompt "[EDIT] ")
2023 (expand-file-name d)
2025 (quit (concat d f)))
2027 d (or (file-name-directory new) "/")
2028 f (file-name-nondirectory new)
2031 (file-directory-p d)
2032 (and (yes-or-no-p (format "Create directory %s? " d))
2034 (progn (make-directory d t) t)
2036 (message "Could not create directory")
2040 (ido-set-current-directory d nil (eq ido-exit 'chdir))
2041 (setq ido-text-init f
2046 (read-string (concat prompt "[EDIT] ") ido-final-text)
2047 (quit ido-final-text)))))
2051 ((eq ido-exit 'keep)
2052 (setq ido-keep-item-list t))
2054 ((memq ido-exit '(dired fallback find-file switch-to-buffer insert-buffer insert-file))
2057 ((memq ido-exit '(updir push))
2058 ;; cannot go up if already at the root-dir (Unix) or at the
2059 ;; root-dir of a certain drive (Windows or MS-DOS).
2060 (if (ido-is-tramp-root)
2061 (when (string-match "\\`\\(/\\([^/]+[:@]\\)*\\)\\([^/]+\\)[:@]\\'" ido-current-directory)
2062 (setq ido-text-init (match-string 3 ido-current-directory))
2063 (ido-set-current-directory (match-string 1 ido-current-directory))
2064 (setq ido-set-default-item t))
2065 (unless (ido-is-root-directory)
2066 (when (eq ido-exit 'push)
2067 (setq ido-input-stack (cons (cons ido-cur-item ido-text) ido-input-stack))
2068 (setq ido-cur-item 'dir)
2069 (setq ido-text-init (file-name-nondirectory (substring ido-current-directory 0 -1)))
2070 (ido-trace "push" ido-input-stack))
2071 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1)))
2072 (setq ido-set-default-item t))))
2075 (ido-trace "pop" ido-input-stack)
2076 (let ((elt (car ido-input-stack)))
2077 (setq ido-input-stack (cdr ido-input-stack))
2078 (ido-set-current-directory (concat ido-current-directory ido-text))
2079 (setq ido-cur-item (car elt))
2080 (setq ido-text-init (cdr elt))))
2082 ((eq ido-exit 'pop-all)
2083 (ido-trace "pop-all" ido-input-stack)
2084 (while ido-input-stack
2085 (let ((elt (car ido-input-stack)))
2086 (setq ido-input-stack (cdr ido-input-stack))
2087 (ido-set-current-directory (concat ido-current-directory ido-text))
2088 (setq ido-cur-item (car elt))
2089 (setq ido-text-init (cdr elt)))))
2091 ;; Handling the require-match must be done in a better way.
2093 (not (memq require-match '(confirm confirm-after-completion)))
2094 (not (if ido-directory-too-big
2095 (file-exists-p (concat ido-current-directory ido-final-text))
2096 (ido-existing-item-p))))
2097 (error "Must specify valid item"))
2101 (if (or (eq ido-exit 'takeprompt)
2104 ;; else take head of list
2105 (ido-name (car ido-matches))))
2108 ((memq item '(buffer list))
2111 ((string-equal "./" ido-selected)
2114 ((string-equal "../" ido-selected)
2115 ;; cannot go up if already at the root-dir (Unix) or at the
2116 ;; root-dir of a certain drive (Windows or MS-DOS).
2117 (or (ido-is-root-directory)
2118 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
2119 (setq ido-set-default-item t))
2121 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") ido-selected)
2122 (ido-is-root-directory) ;; Ange-ftp or Tramp
2123 (not (ido-local-file-exists-p ido-selected)))
2124 (ido-set-current-directory ido-current-directory ido-selected)
2125 (ido-trace "tramp prefix" ido-selected)
2126 (if (ido-is-slow-ftp-host)
2127 (setq ido-exit 'fallback
2129 (setq ido-set-default-item t)))
2131 ((or (string-match "[/\\][^/\\]" ido-selected)
2132 (and (memq system-type '(windows-nt ms-dos))
2133 (string-match "\\`[a-zA-Z]:" ido-selected)))
2134 (ido-set-current-directory (file-name-directory ido-selected))
2135 (setq ido-set-default-item t))
2137 ((string-match "\\`~" ido-selected)
2138 (ido-set-current-home ido-selected))
2140 ((ido-final-slash ido-selected)
2141 (if ido-enable-last-directory-history
2142 (let ((x (assoc ido-current-directory ido-last-directory-list)))
2144 (setcdr x ido-selected)
2145 (setq ido-last-directory-list
2146 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
2147 (ido-set-current-directory ido-current-directory ido-selected)
2149 ; automatically pop stack elements which match existing files or directories
2151 (while (and (setq elt (car ido-input-stack))
2152 (file-exists-p (concat ido-current-directory (cdr elt))))
2153 (if (setq ido-input-stack (cdr ido-input-stack))
2154 (ido-set-current-directory ido-current-directory (cdr elt))
2155 (setq ido-text-init (cdr elt)))
2156 (setq ido-cur-item (car elt))))
2157 (setq ido-set-default-item t)))
2163 (defun ido-edit-input ()
2164 "Edit absolute file name entered so far with ido; terminate by RET.
2165 If cursor is not at the end of the user input, move to end of input."
2169 (setq ido-text-init (if ido-matches (ido-name (car ido-matches)) ido-text))
2170 (setq ido-exit 'edit)
2174 (defun ido-buffer-internal (method &optional fallback prompt default initial switch-cmd)
2175 ;; Internal function for ido-switch-buffer and friends
2178 (run-hook-with-args 'ido-before-fallback-functions
2179 (or fallback 'switch-to-buffer))
2180 (call-interactively (or fallback 'switch-to-buffer)))
2181 (let* ((ido-context-switch-command switch-cmd)
2182 (ido-current-directory nil)
2183 (ido-directory-nonreadable nil)
2184 (ido-directory-too-big nil)
2185 (ido-use-virtual-buffers (if (eq method 'kill)
2186 nil ;; Don't consider virtual buffers for killing
2187 ido-use-virtual-buffers))
2188 (require-match (confirm-nonexistent-file-or-buffer))
2189 (buf (ido-read-internal 'buffer (or prompt "Buffer: ") 'ido-buffer-history default
2190 require-match initial))
2193 ;; Choose the buffer name: either the text typed in, or the head
2194 ;; of the list of matches
2197 ((eq ido-exit 'find-file)
2199 (if (memq method '(other-window other-frame)) method ido-default-file-method)
2200 nil nil nil nil ido-text))
2202 ((eq ido-exit 'insert-file)
2203 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil ido-text 'ido-enter-insert-buffer))
2205 ((eq ido-exit 'fallback)
2206 (let ((read-buffer-function nil))
2207 (setq this-command (or fallback 'switch-to-buffer))
2208 (run-hook-with-args 'ido-before-fallback-functions this-command)
2209 (call-interactively this-command)))
2211 ;; Check buf is non-nil.
2213 ((= (length buf) 0) nil)
2215 ;; View buffer if it exists
2217 (add-to-history 'buffer-name-history buf)
2218 (if (eq method 'insert)
2220 (ido-record-command 'insert-buffer buf)
2223 (insert-buffer-substring (get-buffer buf))
2225 (ido-visit-buffer buf method t)))
2227 ;; check for a virtual buffer reference
2228 ((and ido-use-virtual-buffers ido-virtual-buffers
2229 (setq filename (assoc buf ido-virtual-buffers)))
2230 (ido-visit-buffer (find-file-noselect (cdr filename)) method t))
2232 ((and (eq ido-create-new-buffer 'prompt)
2233 (null require-match)
2234 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
2237 ;; buffer doesn't exist
2238 ((and (eq ido-create-new-buffer 'never)
2239 (null require-match))
2240 (message "No buffer matching `%s'" buf))
2242 ((and (eq ido-create-new-buffer 'prompt)
2243 (null require-match)
2244 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
2247 ;; create a new buffer
2249 (add-to-history 'buffer-name-history buf)
2250 (setq buf (get-buffer-create buf))
2251 (if (fboundp 'set-buffer-major-mode)
2252 (set-buffer-major-mode buf))
2253 (ido-visit-buffer buf method t))))))
2255 (defun ido-record-work-directory (&optional dir)
2256 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
2257 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
2258 (let ((items ido-work-directory-list-ignore-regexps)
2259 (case-fold-search nil))
2260 (while (and items dir)
2261 (if (string-match (car items) dir)
2263 (setq items (cdr items)))
2265 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
2266 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
2267 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
2269 (defun ido-forget-work-directory ()
2271 (when (and ido-current-directory ido-work-directory-list)
2272 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
2273 (when ido-use-merged-list
2274 (ido-undo-merge-work-directory)
2275 (setq ido-exit 'refresh
2276 ido-try-merged-list t
2277 ido-use-merged-list t
2278 ido-text-init ido-text
2280 (exit-minibuffer))))
2282 (defun ido-record-work-file (name)
2283 ;; Save NAME in ido-work-file-list
2284 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
2286 (and ido-work-file-list (equal (car ido-work-file-list) name))
2287 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
2288 (if (> (length ido-work-file-list) ido-max-work-file-list)
2289 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
2291 (defun ido-expand-directory (dir)
2292 ;; Expand DIR or use DEFAULT-DIRECTORY if nil.
2293 ;; Add final slash to result in case it was missing from DEFAULT-DIRECTORY.
2294 (ido-final-slash (expand-file-name (or dir default-directory)) t))
2296 (defun ido-file-internal (method &optional fallback default prompt item initial switch-cmd)
2297 ;; Internal function for ido-find-file and friends
2300 (let ((ido-current-directory (ido-expand-directory default))
2301 (ido-context-switch-command switch-cmd)
2302 ido-directory-nonreadable ido-directory-too-big
2305 (if (or (not ido-mode) (ido-is-slow-ftp-host))
2308 (setq ido-directory-nonreadable
2309 (ido-nonreadable-directory-p ido-current-directory)
2310 ido-directory-too-big
2311 (and (not ido-directory-nonreadable)
2312 (ido-directory-too-big-p ido-current-directory))))
2314 (when (and (eq item 'file)
2315 (or ido-use-url-at-point ido-use-filename-at-point))
2318 ;; Duplicate code from ffap-guesser as we want different
2319 ;; behavior for files and URLs.
2322 (and ido-use-url-at-point
2324 (ffap-fixup-url (or (ffap-url-at-point)
2325 (ffap-gopher-at-point)))))
2326 (setq ido-exit 'ffap
2329 ((and ido-use-filename-at-point
2330 (setq fn (with-no-warnings
2331 (if (eq ido-use-filename-at-point 'guess)
2333 (ffap-string-at-point))))
2334 (not (string-match "^http:/" fn))
2335 (let ((absolute-fn (expand-file-name fn)))
2336 (setq d (if (file-directory-p absolute-fn)
2337 (file-name-as-directory absolute-fn)
2338 (file-name-directory absolute-fn))))
2339 (file-directory-p d))
2340 (setq ido-current-directory d)
2341 (setq initial (file-name-nondirectory fn))))))
2343 (let (ido-saved-vc-hb
2344 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
2345 (ido-work-directory-index -1)
2346 (ido-work-file-index -1)
2347 (ido-find-literal nil))
2350 (setq ido-saved-vc-hb vc-handled-backends)
2351 (let ((minibuffer-completing-file-name t))
2352 (setq filename (ido-read-internal item
2353 (or prompt "Find file: ")
2355 (and (eq method 'alt-file) buffer-file-name)
2356 (confirm-nonexistent-file-or-buffer) initial))))
2358 ;; Choose the file name: either the text typed in, or the head
2359 ;; of the list of matches
2362 ((eq ido-exit 'fallback)
2363 ;; Need to guard setting of default-directory here, since
2364 ;; we don't want to change directory of current buffer.
2365 (let ((default-directory ido-current-directory)
2366 (read-file-name-function nil))
2367 (setq this-command (or fallback 'find-file))
2368 (run-hook-with-args 'ido-before-fallback-functions this-command)
2369 (call-interactively this-command)))
2371 ((eq ido-exit 'switch-to-buffer)
2372 (ido-buffer-internal
2373 (if (memq method '(other-window other-frame)) method ido-default-buffer-method)
2374 nil nil nil ido-text))
2376 ((eq ido-exit 'insert-buffer)
2377 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil ido-text 'ido-enter-insert-file))
2379 ((eq ido-exit 'dired)
2380 (dired (concat ido-current-directory (or ido-text ""))))
2382 ((eq ido-exit 'ffap)
2383 (find-file-at-point))
2385 ((eq method 'alt-file)
2386 (ido-record-work-file filename)
2387 (setq default-directory ido-current-directory)
2388 (ido-record-work-directory)
2389 (find-alternate-file filename))
2391 ((memq method '(dired list-directory))
2392 (if (equal filename ".")
2394 (let* ((dirname (ido-final-slash (concat ido-current-directory filename) t))
2395 (file (substring dirname 0 -1)))
2397 ((file-directory-p dirname)
2398 (ido-record-command method dirname)
2399 (ido-record-work-directory dirname)
2400 (funcall method dirname))
2401 ((file-directory-p ido-current-directory)
2403 ((file-exists-p file)
2404 (ido-record-command method ido-current-directory)
2405 (ido-record-work-directory)
2406 (funcall method ido-current-directory)
2407 (if (eq method 'dired)
2409 (dired-goto-file (expand-file-name file)))))
2410 ((string-match "[[*?]" filename)
2411 (setq dirname (concat ido-current-directory filename))
2412 (ido-record-command method dirname)
2413 (ido-record-work-directory)
2414 (funcall method dirname))
2415 ((y-or-n-p (format "Directory %s does not exist. Create it? " filename))
2416 (ido-record-command method dirname)
2417 (ido-record-work-directory dirname)
2418 (make-directory-internal dirname)
2419 (funcall method dirname))
2421 ;; put make-directory command on history
2422 (ido-record-command 'make-directory dirname))))
2423 (t (error "No such directory")))))
2426 (ido-record-work-file filename)
2427 (setq default-directory ido-current-directory)
2428 (setq filename (concat ido-current-directory filename))
2429 (ido-record-command 'write-file filename)
2430 (add-to-history 'file-name-history filename)
2431 (ido-record-work-directory)
2432 (write-file filename t))
2434 ((eq method 'read-only)
2435 (ido-record-work-file filename)
2436 (setq filename (concat ido-current-directory filename))
2437 (ido-record-command fallback filename)
2438 (ido-record-work-directory)
2439 (run-hook-with-args 'ido-before-fallback-functions fallback)
2440 (funcall fallback filename))
2442 ((eq method 'insert)
2443 (ido-record-work-file filename)
2444 (setq filename (concat ido-current-directory filename))
2446 (if ido-find-literal 'insert-file-literally 'insert-file)
2448 (add-to-history 'file-name-history filename)
2449 (ido-record-work-directory)
2450 (insert-file-1 filename
2451 (if ido-find-literal
2452 #'insert-file-contents-literally
2453 #'insert-file-contents)))
2456 (ido-record-work-file filename)
2457 (setq filename (concat ido-current-directory filename))
2458 (ido-record-command 'find-file filename)
2459 (add-to-history 'file-name-history filename)
2460 (ido-record-work-directory)
2461 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
2463 (defun ido-existing-item-p ()
2464 ;; Return non-nil if there is a matching item
2465 (not (null ido-matches)))
2469 (defun ido-set-common-completion ()
2470 ;; Find common completion of `ido-text' in `ido-matches'
2471 ;; The result is stored in `ido-common-match-string'
2473 (setq ido-common-match-string nil)
2474 (if (and ido-matches
2475 (not ido-enable-regexp) ;; testing
2477 (> (length ido-text) 0))
2478 (if (setq val (ido-find-common-substring ido-matches ido-text))
2479 (setq ido-common-match-string val)))
2482 (defun ido-complete ()
2483 "Try and complete the current pattern amongst the file names."
2487 (ido-incomplete-regexp
2490 ((and (memq ido-cur-item '(file dir))
2491 (string-match "[$]" ido-text))
2492 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
2493 (if (not (file-exists-p (file-name-directory evar)))
2494 (message "Expansion generates non-existing directory name")
2495 (if (file-directory-p evar)
2496 (ido-set-current-directory evar)
2497 (let ((d (or (file-name-directory evar) "/"))
2498 (f (file-name-nondirectory evar)))
2499 (when (file-directory-p d)
2500 (ido-set-current-directory d)
2501 (setq ido-text-init f))))
2502 (setq ido-exit 'refresh)
2503 (exit-minibuffer))))
2505 (ido-directory-too-big
2506 (setq ido-directory-too-big nil)
2507 (setq ido-text-init ido-text)
2508 (setq ido-exit 'refresh)
2512 (when ido-completion-buffer
2513 (call-interactively (setq this-command ido-cannot-complete-command))))
2515 ((and (= 1 (length ido-matches))
2516 (not (and ido-enable-tramp-completion
2517 (string-equal ido-current-directory "/")
2518 (string-match ".[@:]\\'" (ido-name (car ido-matches)))))
2519 (not (ido-local-file-exists-p (ido-name (car ido-matches)))))
2520 ;; only one choice, so select it.
2521 (if (not ido-confirm-unique-completion)
2523 (setq ido-rescan (not ido-enable-prefix))
2524 (delete-region (minibuffer-prompt-end) (point))
2525 (insert (ido-name (car ido-matches)))))
2527 (t ;; else there could be some completions
2528 (setq res ido-common-match-string)
2529 (if (and (not (memq res '(t nil)))
2530 (not (equal res ido-text)))
2531 ;; found something to complete, so put it in the minibuffer.
2533 ;; move exact match to front if not in prefix mode
2534 (setq ido-rescan (not ido-enable-prefix))
2535 (delete-region (minibuffer-prompt-end) (point))
2537 ;; else nothing to complete
2538 (call-interactively (setq this-command ido-cannot-complete-command))
2541 (defun ido-complete-space ()
2542 "Try completion unless inserting the space makes sense."
2544 (if (and (stringp ido-common-match-string)
2547 ((> (length ido-common-match-string) (length ido-text))
2548 (= (aref ido-common-match-string (length ido-text)) ? ))
2551 (re (concat (regexp-quote ido-text) " "))
2554 (if (string-match re (ido-name (car comp)))
2555 (setq comp nil insert-space t)
2556 (setq comp (cdr comp))))
2562 (defun ido-undo-merge-work-directory (&optional text try refresh)
2563 "Undo or redo last ido directory merge operation.
2564 If no merge has yet taken place, toggle automatic merging option."
2567 (ido-pre-merge-state
2568 (ido-set-current-directory (nth 1 ido-pre-merge-state))
2569 (setq ido-text-init (or text (car ido-pre-merge-state))
2570 ido-cur-list (nth 2 ido-pre-merge-state)
2571 ido-ignored-list (nth 3 ido-pre-merge-state)
2572 ido-matches (nth 4 ido-pre-merge-state)
2573 ido-use-merged-list nil
2574 ido-try-merged-list try
2575 ido-keep-item-list (not refresh)
2578 ido-pre-merge-state nil)
2582 (ido-try-merged-list
2583 (setq ido-try-merged-list nil))
2585 (setq ido-try-merged-list t))
2586 ((not ido-use-merged-list)
2587 (ido-merge-work-directories))))
2591 (defun ido-magic-forward-char (arg)
2592 "Move forward in user input or perform magic action.
2593 If no user input is present, or at end of input, perform magic actions:
2594 C-x C-b ... C-f switch to `ido-find-file'.
2595 C-x C-f ... C-f fallback to non-ido `find-file'.
2596 C-x C-d ... C-f fallback to non-ido brief `dired'.
2597 C-x d ... C-f fallback to non-ido `dired'."
2600 ((or arg (not (eobp)))
2601 (forward-char (min (prefix-numeric-value arg)
2602 (- (point-max) (point)))))
2603 ((memq ido-cur-item '(file dir))
2604 (ido-fallback-command))
2605 (ido-context-switch-command
2606 (call-interactively ido-context-switch-command))
2607 ((eq ido-cur-item 'buffer)
2608 (ido-enter-find-file))))
2612 (defun ido-magic-backward-char (arg)
2613 "Move backward in user input or perform magic action.
2614 If no user input is present, or at start of input, perform magic actions:
2615 C-x C-f C-b switch to `ido-switch-buffer'.
2616 C-x C-d C-b switch to `ido-switch-buffer'.
2617 C-x d C-b switch to `ido-switch-buffer'.
2618 C-x C-b C-b fallback to non-ido `switch-to-buffer'."
2621 ((or arg (> (point) (minibuffer-prompt-end)))
2623 (- (min (prefix-numeric-value arg)
2624 (- (point) (minibuffer-prompt-end))))))
2625 ((eq last-command this-command)
2626 (when (and (memq ido-cur-item '(file dir))
2628 (ido-push-dir))) ; else do nothing
2629 ((eq ido-cur-item 'buffer)
2630 (ido-fallback-command))
2631 (ido-context-switch-command
2632 (call-interactively ido-context-switch-command))
2634 (ido-enter-switch-buffer))))
2638 (defun ido-magic-delete-char (arg)
2639 "Delete following char in user input or perform magic action.
2640 If at end of user input, perform magic actions:
2641 C-x C-f ... C-d enter `dired' on current directory."
2644 ((or arg (not (eobp)))
2645 (delete-char (min (prefix-numeric-value arg)
2646 (- (point-max) (point)))))
2647 (ido-context-switch-command
2649 ((memq ido-cur-item '(file dir))
2650 (ido-enter-dired))))
2653 ;;; TOGGLE FUNCTIONS
2655 (defun ido-toggle-case ()
2656 "Toggle the value of `ido-case-fold'."
2658 (setq ido-case-fold (not ido-case-fold))
2659 ;; ask for list to be regenerated.
2660 (setq ido-rescan t))
2662 (defun ido-toggle-regexp ()
2663 "Toggle the value of `ido-enable-regexp'."
2665 (setq ido-enable-regexp (not ido-enable-regexp))
2666 ;; ask for list to be regenerated.
2667 (setq ido-rescan t))
2669 (defun ido-toggle-prefix ()
2670 "Toggle the value of `ido-enable-prefix'."
2672 (setq ido-enable-prefix (not ido-enable-prefix))
2673 ;; ask for list to be regenerated.
2674 (setq ido-rescan t))
2676 (defun ido-toggle-ignore ()
2677 "Toggle ignoring files specified with `ido-ignore-files'."
2679 (if (and (not (eobp)) (> (point) (minibuffer-prompt-end)))
2680 (goto-char (minibuffer-prompt-end))
2681 (if ido-directory-too-big
2683 (message "Reading directory...")
2684 (setq ido-directory-too-big nil))
2685 (setq ido-process-ignore-lists (not ido-process-ignore-lists)))
2686 (setq ido-text-init ido-text)
2687 (setq ido-exit 'refresh)
2690 (defun ido-toggle-vc ()
2691 "Disable version control for this file."
2693 (if (and ido-mode (eq ido-cur-item 'file))
2695 (setq vc-handled-backends
2696 (if vc-handled-backends nil ido-saved-vc-hb))
2697 (setq ido-text-init ido-text)
2698 (setq ido-exit 'keep)
2699 (exit-minibuffer))))
2701 (defun ido-toggle-literal ()
2702 "Toggle literal reading of this file."
2704 (if (and ido-mode (eq ido-cur-item 'file))
2706 (setq ido-find-literal (not ido-find-literal))
2707 (setq ido-text-init ido-text)
2708 (setq ido-exit 'keep)
2709 (exit-minibuffer))))
2711 (defun ido-toggle-virtual-buffers ()
2712 "Toggle the use of virtual buffers.
2713 See `ido-use-virtual-buffers' for explanation of virtual buffer."
2715 (when (and ido-mode (eq ido-cur-item 'buffer))
2716 (setq ido-use-virtual-buffers (not ido-use-virtual-buffers))
2717 (setq ido-text-init ido-text)
2718 (setq ido-exit 'refresh)
2721 (defun ido-reread-directory ()
2722 "Read current directory again.
2723 May be useful if cached version is no longer valid, but directory
2724 timestamp has not changed (e.g. with ftp or on Windows)."
2726 (if (and ido-mode (memq ido-cur-item '(file dir)))
2728 (if (ido-is-unc-root)
2729 (setq ido-unc-hosts-cache t)
2730 (ido-remove-cached-dir ido-current-directory))
2731 (setq ido-text-init ido-text)
2732 (setq ido-rotate-temp t)
2733 (setq ido-exit 'refresh)
2734 (exit-minibuffer))))
2736 (defun ido-exit-minibuffer ()
2737 "Exit minibuffer, but make sure we have a match if one is needed."
2739 (if (and (or (not ido-require-match)
2740 (if (memq ido-require-match '(confirm confirm-after-completion))
2741 (if (or (eq ido-cur-item 'dir)
2742 (eq last-command this-command))
2744 (setq ido-show-confirm-message t)
2746 (ido-existing-item-p))
2747 (not ido-incomplete-regexp))
2750 (defun ido-select-text ()
2751 "Select the buffer or file named by the prompt.
2752 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2754 (setq ido-exit 'takeprompt)
2757 (defun ido-fallback-command ()
2758 "Fallback to non-ido version of current command."
2760 (let ((i (length ido-text)))
2762 (push (aref ido-text (setq i (1- i))) unread-command-events)))
2763 (setq ido-exit 'fallback)
2766 (defun ido-enter-find-file ()
2767 "Drop into `find-file' from buffer switching."
2769 (setq ido-exit 'find-file)
2772 (defun ido-enter-switch-buffer ()
2773 "Drop into `ido-switch-buffer' from file switching."
2775 (setq ido-exit 'switch-to-buffer)
2778 (defun ido-enter-dired ()
2779 "Drop into `dired' from file switching."
2781 (setq ido-exit 'dired)
2784 (defun ido-enter-insert-buffer ()
2785 "Drop into `insert-buffer' from insert file."
2787 (setq ido-exit 'insert-buffer)
2790 (defun ido-enter-insert-file ()
2791 "Drop into `insert-file' from insert buffer."
2793 (setq ido-exit 'insert-file)
2797 (defun ido-up-directory (&optional clear)
2798 "Go up one directory level."
2800 (setq ido-text-init (if clear nil ido-text))
2801 (setq ido-exit 'updir)
2802 (setq ido-rotate-temp t)
2805 (defun ido-delete-backward-updir (count)
2806 "Delete char backwards, or at beginning of buffer, go up one level."
2809 ((= (minibuffer-prompt-end) (point))
2811 (ido-up-directory t)))
2812 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2813 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2814 ((eq this-original-command 'viper-backward-char)
2815 (funcall this-original-command (prefix-numeric-value count)))
2816 ((eq this-original-command 'viper-del-backward-char-in-insert)
2817 (funcall this-original-command))
2819 (delete-char (- (prefix-numeric-value count))))))
2821 (defun ido-delete-backward-word-updir (count)
2822 "Delete all chars backwards, or at beginning of buffer, go up one level."
2824 (if (= (minibuffer-prompt-end) (point))
2826 (ido-up-directory t))
2827 (if (eq this-original-command 'viper-delete-backward-word)
2828 (funcall this-original-command (prefix-numeric-value count))
2829 (backward-kill-word (prefix-numeric-value count)))))
2831 (defun ido-get-work-directory (&optional incr must-match)
2832 (let ((n (length ido-work-directory-list))
2833 (i ido-work-directory-index)
2836 (if (or (not ido-text) (= (length ido-text) 0))
2837 (setq must-match nil))
2842 (if (>= i n) (setq i 0))
2843 (if (< i 0) (setq i (1- n))))
2844 (setq dir (nth i ido-work-directory-list))
2846 (not (equal dir ido-current-directory))
2847 (file-directory-p dir)
2848 (or (not must-match)
2849 ;; TODO. check for nonreadable and too-big.
2851 (if (eq ido-cur-item 'file)
2852 (ido-make-file-list-1 dir)
2853 (ido-make-dir-list-1 dir)))))
2857 (setq ido-work-directory-index i))
2860 (defun ido-prev-work-directory ()
2861 "Change to next working directory in list."
2863 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2865 (ido-set-current-directory dir)
2866 (setq ido-exit 'refresh)
2867 (setq ido-text-init ido-text)
2868 (setq ido-rotate-temp t)
2869 (exit-minibuffer))))
2871 (defun ido-next-work-directory ()
2872 "Change to previous working directory in list."
2874 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2876 (ido-set-current-directory dir)
2877 (setq ido-exit 'refresh)
2878 (setq ido-text-init ido-text)
2879 (setq ido-rotate-temp t)
2880 (exit-minibuffer))))
2882 (defun ido-merge-work-directories ()
2883 "Search (and merge) work directories for files matching the current input string."
2885 (setq ido-use-merged-list t ido-try-merged-list t)
2886 (setq ido-exit 'refresh)
2887 (setq ido-text-init ido-text)
2888 (setq ido-rotate-temp t)
2891 (defun ido-wide-find-file (&optional file)
2892 "Prompt for FILE to search for using find, starting from current directory."
2895 (let ((enable-recursive-minibuffers t))
2898 (read-string (concat "Wide find file: " ido-current-directory) ido-text)
2900 (when (> (length file) 0)
2901 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2902 (setq ido-exit 'refresh)
2903 (setq ido-text-init file)
2904 (setq ido-rotate-temp t)
2907 (defun ido-wide-find-dir (&optional dir)
2908 "Prompt for DIR to search for using find, starting from current directory."
2911 (let ((enable-recursive-minibuffers t))
2914 (read-string (concat "Wide find directory: " ido-current-directory) ido-text)
2916 (when (> (length dir) 0)
2917 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2918 (setq ido-exit 'refresh)
2919 (setq ido-text-init (ido-final-slash dir t))
2920 (setq ido-rotate-temp t)
2923 (defun ido-wide-find-dir-or-delete-dir (&optional dir)
2924 "Prompt for DIR to search for using find, starting from current directory.
2925 If input stack is non-empty, delete current directory component."
2928 (ido-delete-backward-word-updir 1)
2929 (ido-wide-find-dir)))
2931 (defun ido-take-first-match ()
2932 "Use first matching item as input text."
2935 (setq ido-text-init (ido-name (car ido-matches)))
2936 (setq ido-exit 'refresh)
2939 (defun ido-push-dir ()
2940 "Move to previous directory in file name, push current input on stack."
2942 (setq ido-exit 'push)
2945 (defun ido-push-dir-first ()
2946 "Move to previous directory in file name, push first match on stack."
2949 (setq ido-text (ido-name (car ido-matches))))
2950 (setq ido-exit 'push)
2953 (defun ido-pop-dir (arg)
2954 "Pop directory from input stack back to input.
2955 With \\[universal-argument], pop all elements."
2957 (when ido-input-stack
2958 (setq ido-exit (if arg 'pop-all 'pop))
2961 (defun ido-wide-find-file-or-pop-dir (arg)
2965 (ido-wide-find-file)))
2967 (defun ido-make-directory (&optional dir)
2968 "Prompt for DIR to create in current directory."
2971 (let ((enable-recursive-minibuffers t))
2973 (read-string (concat "Make directory: " ido-current-directory) ido-text))))
2974 (when (> (length dir) 0)
2975 (setq dir (concat ido-current-directory dir))
2976 (unless (file-exists-p dir)
2977 (make-directory dir t)
2978 (ido-set-current-directory dir)
2979 (setq ido-exit 'refresh)
2980 (setq ido-text-init nil)
2981 (setq ido-rotate-temp t)
2982 (exit-minibuffer))))
2984 (defun ido-get-work-file (incr)
2985 (let ((n (length ido-work-file-list))
2986 (i (+ ido-work-file-index incr))
2989 (if (>= i n) (setq i 0))
2990 (if (< i 0) (setq i (1- n))))
2991 (setq name (nth i ido-work-file-list))
2992 (setq ido-work-file-index i)
2995 (defun ido-prev-work-file ()
2996 "Change to next working file name in list."
2998 (let ((name (ido-get-work-file 1)))
3000 (setq ido-text-init name)
3001 (setq ido-exit 'refresh)
3002 (exit-minibuffer))))
3004 (defun ido-next-work-file ()
3005 "Change to previous working file name in list."
3007 (let ((name (ido-get-work-file -1)))
3009 (setq ido-text-init name)
3010 (setq ido-exit 'refresh)
3011 (exit-minibuffer))))
3013 (defun ido-copy-current-file-name (all)
3014 "Insert file name of current buffer.
3015 If repeated, insert text from buffer instead."
3017 (let* ((bfname (or (buffer-file-name ido-entry-buffer)
3018 (buffer-name ido-entry-buffer)))
3019 (name (and bfname (file-name-nondirectory bfname))))
3023 (eq last-command this-command)
3024 (not (equal (file-name-directory bfname) ido-current-directory))
3025 (not (string-match "\\.[^.]*\\'" name)))
3027 (substring name 0 (1+ (match-beginning 0)))))
3028 (setq ido-exit 'refresh
3029 ido-try-merged-list nil)
3030 (exit-minibuffer))))
3032 (defun ido-copy-current-word (all)
3033 "Insert current word (file or directory name) from current buffer."
3035 (let ((word (with-current-buffer ido-entry-buffer
3036 (let ((p (point)) start-line end-line start-name name)
3037 (if (and mark-active (/= p (mark)))
3038 (setq start-name (mark))
3040 (setq start-line (point))
3042 (setq end-line (point))
3044 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
3046 (setq start-name (point))
3047 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
3048 (if (= start-name (point))
3049 (setq start-name nil)))
3051 (buffer-substring-no-properties start-name (point)))))))
3054 ((string-match "\\`[~/]" word)
3055 (setq ido-text-init word
3056 ido-try-merged-list nil
3058 ((string-match "/" word)
3059 (setq ido-text-init (concat ido-current-directory word)
3060 ido-try-merged-list nil
3063 (setq ido-text-init word
3064 ido-try-merged-list nil
3065 ido-exit 'refresh)))
3066 (exit-minibuffer))))
3068 (defun ido-next-match ()
3069 "Put first element of `ido-matches' at the end of the list."
3072 (let ((next (cadr ido-matches)))
3073 (setq ido-cur-list (ido-chop ido-cur-list next))
3074 (setq ido-matches (ido-chop ido-matches next))
3075 (setq ido-rescan nil))))
3077 (defun ido-prev-match ()
3078 "Put last element of `ido-matches' at the front of the list."
3081 (let ((prev (car (last ido-matches))))
3082 (setq ido-cur-list (ido-chop ido-cur-list prev))
3083 (setq ido-matches (ido-chop ido-matches prev))
3084 (setq ido-rescan nil))))
3086 (defun ido-next-match-dir ()
3087 "Find next directory in match list.
3088 If work directories have been merged, cycle through directories for
3089 first matching file."
3091 (if ido-use-merged-list
3093 (let* ((elt (car ido-matches))
3095 (when (> (length dirs) 1)
3096 (setcdr elt (ido-chop dirs (cadr dirs))))
3097 (setq ido-rescan nil)))
3098 (let ((cnt (length ido-matches))
3100 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
3103 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3105 (defun ido-prev-match-dir ()
3106 "Find previous directory in match list.
3107 If work directories have been merged, cycle through directories
3108 for first matching file."
3110 (if ido-use-merged-list
3112 (let* ((elt (car ido-matches))
3114 (when (> (length dirs) 1)
3115 (setcdr elt (ido-chop dirs (car (last dirs)))))
3116 (setq ido-rescan nil)))
3117 (let* ((cnt (length ido-matches))
3119 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
3122 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3124 (defun ido-restrict-to-matches ()
3125 "Set current item list to the currently matched items."
3128 (setq ido-cur-list ido-matches
3134 (defun ido-chop (items elem)
3135 "Remove all elements before ELEM and put them at the end of ITEMS."
3140 (setq next (car items))
3141 (if (equal next elem)
3142 (setq ret (append items (nreverse sofar)))
3145 (setq items (cdr items))
3146 (setq sofar (cons next sofar)))))
3149 (defun ido-name (item)
3150 ;; Return file name for current item, whether in a normal list
3151 ;; or a merged work directory list.
3152 (if (consp item) (car item) item))
3155 ;;; CREATE LIST OF ALL CURRENT FILES
3157 (defun ido-all-completions ()
3158 ;; Return unsorted list of all competions.
3159 (let ((ido-process-ignore-lists nil)
3160 (ido-directory-too-big nil))
3162 ((eq ido-cur-item 'file)
3163 (ido-make-file-list-1 ido-current-directory))
3164 ((eq ido-cur-item 'dir)
3165 (ido-make-dir-list-1 ido-current-directory))
3166 ((eq ido-cur-item 'buffer)
3167 (ido-make-buffer-list-1))
3168 ((eq ido-cur-item 'list)
3173 ;; File list sorting
3175 (defun ido-file-lessp (a b)
3176 ;; Simple compare two file names.
3177 (string-lessp (ido-no-final-slash a) (ido-no-final-slash b)))
3180 (defun ido-file-extension-lessp (a b)
3181 ;; Compare file names according to ido-file-extensions-order list.
3182 (let ((n (compare-strings a 0 nil b 0 nil nil))
3195 (ido-file-extension-aux a b n lessp))
3197 (while (and (> n 2) (/= (aref a n) ?.))
3200 (ido-file-extension-aux a b n lessp)
3203 (defun ido-file-extension-aux (a b n lessp)
3204 (let ((oa (ido-file-extension-order a n))
3205 (ob (ido-file-extension-order b n)))
3222 (defun ido-file-extension-order (s n)
3223 (let ((l ido-file-extensions-order)
3230 ((eq (compare-strings s n nil (car l) 0 nil nil) t)
3239 (defun ido-sort-merged-list (items promote)
3240 ;; Input is list of ("file" . "dir") cons cells.
3241 ;; Output is sorted list of ("file "dir" ...) lists
3242 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
3247 (if (and res (string-equal (car (car res)) (car a)))
3249 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
3250 (if (and promote (string-equal ido-current-directory (cdr a)))
3252 (setq res (cons (list (car a) (cdr a)) res)
3256 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
3257 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
3260 (shell-command-to-string
3262 (shell-quote-argument dir)
3264 (shell-quote-argument
3265 (concat (if prefix "" "*") file "*"))
3266 " -type " (if finddir "d" "f") " -print"))))
3270 (setq filename (car filenames)
3271 filenames (cdr filenames))
3272 (if (and (string-match "^/" filename)
3273 (file-exists-p filename))
3274 (setq d (file-name-directory filename)
3275 f (file-name-nondirectory filename)
3276 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
3279 (defun ido-flatten-merged-list (items)
3280 ;; Create a list of directory names based on a merged directory list.
3283 (let* ((item (car items))
3287 (setq res (cons (concat (car dirs) file) res)
3289 (setq items (cdr items)))
3293 (defun ido-make-merged-file-list-1 (text auto wide)
3295 (if (and (ido-final-slash text) ido-dir-file-cache)
3297 (setq res (ido-wide-find-dirs-or-files
3298 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
3299 ;; Use list of cached directories
3300 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
3301 (dirs ido-dir-file-cache)
3305 (setq dir (car (car dirs))
3307 (when (and (string-match re dir)
3308 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
3309 (file-directory-p dir))
3310 (setq b (substring dir 0 -1)
3311 f (concat (file-name-nondirectory b) "/")
3312 d (file-name-directory b)
3313 res (cons (cons f d) res))))
3315 (setq dir (car dirs)
3318 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
3319 (setq dir (cdr (cdr dir)))
3323 (if (and (string-match re f)
3324 (not (ido-ignore-item-p f ido-ignore-directories)))
3325 (setq res (cons (cons f d) res)))))
3326 (if (and auto (input-pending-p))
3330 (setq res (ido-wide-find-dirs-or-files
3331 ido-current-directory text ido-enable-prefix nil))
3332 (let ((ido-text text)
3333 (dirs ido-work-directory-list)
3334 (must-match (and text (> (length text) 0)))
3336 (if (and auto (not (member ido-current-directory dirs)))
3337 (setq dirs (cons ido-current-directory dirs)))
3339 (setq dir (car dirs)
3341 (when (and dir (stringp dir)
3342 (or ido-merge-ftp-work-directories
3343 (not (ido-is-ftp-directory dir)))
3344 (file-directory-p dir)
3345 ;; TODO. check for nonreadable and too-big.
3346 (setq fl (if (eq ido-cur-item 'file)
3347 (ido-make-file-list-1 dir t)
3348 (ido-make-dir-list-1 dir t))))
3350 (setq fl (ido-set-matches-1 fl)))
3352 (setq res (nconc fl res))))
3353 (if (and auto (input-pending-p))
3358 (defun ido-make-merged-file-list (text auto wide)
3360 (message "Searching for `%s'...." text)
3364 (ido-make-merged-file-list-1 text auto wide))))
3365 (setq res 'input-pending-p))
3368 ido-try-merged-list nil
3369 ido-use-merged-list nil)))
3370 (when (and res (listp res))
3371 (setq res (ido-sort-merged-list res auto)))
3372 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
3374 (> (length text) 0))
3375 (let ((elt (assoc text res)))
3376 (when (and elt (not (eq elt (car res))))
3377 (setq res (delq elt res))
3378 (setq res (cons elt res)))))
3382 (defun ido-make-buffer-list-1 (&optional frame visible)
3383 ;; Return list of non-ignored buffer names
3387 (let ((name (buffer-name x)))
3388 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
3390 (buffer-list frame))))
3392 (defun ido-make-buffer-list (default)
3393 ;; Return the current list of buffers.
3394 ;; Currently visible buffers are put at the end of the list.
3395 ;; The hook `ido-make-buffer-list-hook' is run after the list has been
3396 ;; created to allow the user to further modify the order of the buffer names
3397 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
3398 ;; it is put to the start of the list.
3399 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
3400 (ido-temp-list (ido-make-buffer-list-1 (selected-frame) ido-current-buffers)))
3402 (nconc ido-temp-list ido-current-buffers)
3403 (setq ido-temp-list ido-current-buffers))
3406 (cons default (delete default ido-temp-list))))
3407 (if ido-use-virtual-buffers
3408 (ido-add-virtual-buffers-to-list))
3409 (run-hooks 'ido-make-buffer-list-hook)
3412 (defun ido-add-virtual-buffers-to-list ()
3413 "Add recently visited files, and bookmark files, to the buffer list.
3414 This is to make them appear as if they were \"virtual buffers\"."
3415 ;; If no buffers matched, and virtual buffers are being used, then
3416 ;; consult the list of past visited files, to see if we can find
3417 ;; the file which the user might thought was still open.
3418 (unless recentf-mode (recentf-mode 1))
3419 (setq ido-virtual-buffers nil)
3421 (dolist (head recentf-list)
3422 (and (setq name (file-name-nondirectory head))
3423 (null (get-file-buffer head))
3424 (not (assoc name ido-virtual-buffers))
3425 (not (member name ido-temp-list))
3426 (not (ido-ignore-item-p name ido-ignore-buffers))
3427 ;;(file-exists-p head)
3428 (push (cons name head) ido-virtual-buffers))))
3429 (when ido-virtual-buffers
3431 (dolist (comp ido-virtual-buffers)
3432 (put-text-property 0 (length (car comp))
3436 (nconc ido-temp-list
3437 (nreverse (mapcar #'car ido-virtual-buffers))))))
3439 (defun ido-make-choice-list (default)
3440 ;; Return the current list of choices.
3441 ;; If DEFAULT is non-nil, and corresponds to an element of choices,
3442 ;; it is put to the start of the list.
3443 (let ((ido-temp-list ido-choice-list))
3447 (delete default ido-temp-list))
3449 (cons default ido-temp-list))))
3450 ; (run-hooks 'ido-make-choice-list-hook)
3453 (defun ido-to-end (items)
3454 ;; Move the elements from ITEMS to the end of `ido-temp-list'
3457 (setq ido-temp-list (delq elem ido-temp-list)))
3460 (nconc ido-temp-list items)
3461 (setq ido-temp-list items)))
3463 (declare-function tramp-tramp-file-p "tramp" (name))
3465 (defun ido-file-name-all-completions-1 (dir)
3467 ((ido-nonreadable-directory-p dir) '())
3468 ;; do not check (ido-directory-too-big-p dir) here.
3469 ;; Caller must have done that if necessary.
3471 ((and ido-enable-tramp-completion
3472 (or (fboundp 'tramp-completion-mode-p)
3473 (require 'tramp nil t))
3474 (string-match "\\`/[^/]+[:@]\\'" dir))
3475 ;; Strip method:user@host: part of tramp completions.
3476 ;; Tramp completions do not include leading slash.
3477 (let* ((len (1- (length dir)))
3480 (or (file-name-all-completions "" dir)
3481 ;; work around bug in ange-ftp.
3482 ;; /ftp:user@host: => nil
3483 ;; /ftp:user@host:./ => ok
3485 (not (string= "/ftp:" dir))
3486 (tramp-tramp-file-p dir)
3487 (fboundp 'tramp-ftp-file-name-p)
3488 (funcall 'tramp-ftp-file-name-p dir)
3489 (string-match ":\\'" dir)
3490 (file-name-all-completions "" (concat dir "./"))))))
3492 (> (length (car compl)) len)
3493 (string= (substring (car compl) 0 len) (substring dir 1)))
3494 (mapcar (lambda (c) (substring c len)) compl)
3497 (file-name-all-completions "" dir))))
3499 (defun ido-file-name-all-completions (dir)
3500 ;; Return name of all files in DIR
3501 ;; Uses and updates ido-dir-file-cache
3503 ((ido-is-unc-root dir)
3506 (if (string-match "/\\'" host) host (concat host "/")))
3508 ((and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
3509 (stringp dir) (> (length dir) 0)
3510 (ido-may-cache-directory dir))
3511 (let* ((cached (assoc dir ido-dir-file-cache))
3512 (ctime (nth 1 cached))
3513 (ftp (ido-is-ftp-directory dir))
3514 (unc (ido-is-unc-host dir))
3515 (attr (if (or ftp unc) nil (file-attributes dir)))
3516 (mtime (nth 5 attr))
3518 (when cached ; should we use the cached entry ?
3521 (setq valid (and (eq (car ctime) 'ftp)
3522 (ido-cache-ftp-valid (cdr ctime)))))
3524 (setq valid (and (eq (car ctime) 'unc)
3525 (ido-cache-unc-valid (cdr ctime)))))
3528 (setq valid (and (= (car ctime) (car mtime))
3529 (= (car (cdr ctime)) (car (cdr mtime))))))))
3531 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
3536 (setq mtime (cons 'unc (ido-time-stamp))))
3537 ((and ftp (file-readable-p dir))
3538 (setq mtime (cons 'ftp (ido-time-stamp)))))
3540 (setq cached (cons dir (cons mtime (ido-file-name-all-completions-1 dir)))
3541 ido-dir-file-cache (cons cached ido-dir-file-cache)))
3542 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
3543 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
3545 (cdr (cdr cached)))))
3547 (ido-file-name-all-completions-1 dir))))
3549 (defun ido-remove-cached-dir (dir)
3550 ;; Remove dir from ido-dir-file-cache
3551 (if (and ido-dir-file-cache
3552 (stringp dir) (> (length dir) 0))
3553 (let ((cached (assoc dir ido-dir-file-cache)))
3555 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
3558 (defun ido-make-file-list-1 (dir &optional merged)
3559 ;; Return list of non-ignored files in DIR
3560 ;; If MERGED is non-nil, each file is cons'ed with DIR
3561 (and (or (ido-is-tramp-root dir) (ido-is-unc-root dir)
3562 (file-directory-p dir))
3566 (if (not (ido-ignore-item-p name ido-ignore-files t))
3567 (if merged (cons name dir) name)))
3568 (ido-file-name-all-completions dir)))))
3570 (defun ido-make-file-list (default)
3571 ;; Return the current list of files.
3572 ;; Currently visible files are put at the end of the list.
3573 ;; The hook `ido-make-file-list-hook' is run after the list has been
3574 ;; created to allow the user to further modify the order of the file names
3576 (let ((ido-temp-list (ido-make-file-list-1 ido-current-directory)))
3577 (setq ido-temp-list (sort ido-temp-list
3578 (if ido-file-extensions-order
3579 #'ido-file-extension-lessp
3581 (unless (ido-is-tramp-root ido-current-directory)
3582 (let ((default-directory ido-current-directory))
3583 (ido-to-end ;; move ftp hosts and visited files to end
3585 (lambda (x) (if (or (and (string-match ".:\\'" x)
3586 (not (ido-local-file-exists-p x)))
3587 (and (not (ido-final-slash x))
3588 (let (file-name-handler-alist)
3589 (get-file-buffer x)))) x))
3591 (ido-to-end ;; move . files to end
3593 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3595 (if (and default (member default ido-temp-list))
3596 (if (or ido-rotate-temp ido-rotate-file-list-default)
3597 (unless (equal default (car ido-temp-list))
3598 (let ((l ido-temp-list) k)
3599 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3603 (nconc k ido-temp-list)
3604 (setq ido-temp-list k)))
3606 (delete default ido-temp-list))
3608 (cons default ido-temp-list))))
3609 (when ido-show-dot-for-dired
3610 (setq ido-temp-list (delete "." ido-temp-list))
3611 (setq ido-temp-list (cons "." ido-temp-list)))
3612 (run-hooks 'ido-make-file-list-hook)
3615 (defun ido-make-dir-list-1 (dir &optional merged)
3616 ;; Return list of non-ignored subdirs in DIR
3617 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
3618 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
3622 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
3623 (if merged (cons name dir) name)))
3624 (ido-file-name-all-completions dir)))))
3626 (defun ido-make-dir-list (default)
3627 ;; Return the current list of directories.
3628 ;; The hook `ido-make-dir-list-hook' is run after the list has been
3629 ;; created to allow the user to further modify the order of the
3630 ;; directory names in this list.
3631 (let ((ido-temp-list (ido-make-dir-list-1 ido-current-directory)))
3632 (setq ido-temp-list (sort ido-temp-list #'ido-file-lessp))
3633 (ido-to-end ;; move . files to end
3635 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3637 (if (and default (member default ido-temp-list))
3638 (if (or ido-rotate-temp ido-rotate-file-list-default)
3639 (unless (equal default (car ido-temp-list))
3640 (let ((l ido-temp-list) k)
3641 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3645 (nconc k ido-temp-list)
3646 (setq ido-temp-list k)))
3648 (delete default ido-temp-list))
3650 (cons default ido-temp-list))))
3651 (setq ido-temp-list (delete "." ido-temp-list))
3652 (unless ido-input-stack
3653 (setq ido-temp-list (cons "." ido-temp-list)))
3654 (run-hooks 'ido-make-dir-list-hook)
3657 ;; List of the files visible in the current frame.
3658 (defvar ido-bufs-in-frame)
3660 (defun ido-get-buffers-in-frames (&optional current)
3661 ;; Return the list of buffers that are visible in the current frame.
3662 ;; If optional argument `current' is given, restrict searching to the
3663 ;; current frame, rather than all frames, regardless of value of
3664 ;; `ido-all-frames'.
3665 (let ((ido-bufs-in-frame nil))
3666 (walk-windows 'ido-get-bufname nil
3672 (defun ido-get-bufname (win)
3673 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
3674 (let ((buf (buffer-name (window-buffer win))))
3675 (unless (or (member buf ido-bufs-in-frame)
3676 (member buf ido-ignore-item-temp-list))
3677 ;; Only add buf if it is not already in list.
3678 ;; This prevents same buf in two different windows being
3679 ;; put into the list twice.
3680 (setq ido-bufs-in-frame
3681 (cons buf ido-bufs-in-frame)))))
3683 ;;; FIND MATCHING ITEMS
3685 (defun ido-set-matches-1 (items &optional do-full)
3686 ;; Return list of matches in items
3687 (let* ((case-fold-search ido-case-fold)
3688 (slash (and (not ido-enable-prefix) (ido-final-slash ido-text)))
3689 (text (if slash (substring ido-text 0 -1) ido-text))
3690 (rex0 (if ido-enable-regexp text (regexp-quote text)))
3691 (rexq (concat rex0 (if slash ".*/" "")))
3692 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
3693 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" rex0))
3694 (concat "\\`" rex0 (if slash "/" "") "\\'")))
3695 (suffix-re (and do-full slash
3696 (not ido-enable-regexp) (not (string-match "\$\\'" rex0))
3697 (concat rex0 "/\\'")))
3698 (prefix-re (and full-re (not ido-enable-prefix)
3699 (concat "\\`" rexq)))
3700 (non-prefix-dot (or (not ido-enable-dot-prefix)
3701 (not ido-process-ignore-lists)
3703 (= (length ido-text) 0)))
3704 full-matches suffix-matches prefix-matches matches)
3705 (setq ido-incomplete-regexp nil)
3706 (condition-case error
3709 (let ((name (ido-name item)))
3710 (if (and (or non-prefix-dot
3711 (if (= (aref ido-text 0) ?.)
3712 (= (aref name 0) ?.)
3713 (/= (aref name 0) ?.)))
3714 (string-match re name))
3716 ((and (eq ido-cur-item 'buffer)
3717 (or (not (stringp ido-default-item))
3718 (not (string= name ido-default-item)))
3719 (string= name (buffer-name ido-entry-buffer)))
3720 (setq matches (cons item matches)))
3721 ((and full-re (string-match full-re name))
3722 (setq full-matches (cons item full-matches)))
3723 ((and suffix-re (string-match suffix-re name))
3724 (setq suffix-matches (cons item suffix-matches)))
3725 ((and prefix-re (string-match prefix-re name))
3726 (setq prefix-matches (cons item prefix-matches)))
3727 (t (setq matches (cons item matches))))))
3731 (setq ido-incomplete-regexp t
3732 ;; Consider the invalid regexp message internally as a
3733 ;; special-case single match, and handle appropriately
3735 matches (cdr error))))
3736 (when prefix-matches
3737 (ido-trace "prefix match" prefix-matches)
3739 (setq matches (nconc prefix-matches matches)))
3740 (when suffix-matches
3741 (ido-trace "suffix match" (list text suffix-re suffix-matches))
3742 (setq matches (nconc suffix-matches matches)))
3744 (ido-trace "full match" (list text full-re full-matches))
3745 (setq matches (nconc full-matches matches)))
3746 (when (and (null matches)
3747 ido-enable-flex-matching
3748 (> (length ido-text) 1)
3749 (not ido-enable-regexp))
3750 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
3751 (if ido-enable-prefix
3752 (setq re (concat "\\`" re)))
3755 (let ((name (ido-name item)))
3756 (if (string-match re name)
3757 (setq matches (cons item matches)))))
3762 (defun ido-set-matches ()
3763 ;; Set `ido-matches' to the list of items matching prompt
3765 (setq ido-matches (ido-set-matches-1 (reverse ido-cur-list) (not ido-rotate))
3768 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
3769 ;; Return t if the buffer or file NAME should be ignored.
3770 (or (member name ido-ignore-item-temp-list)
3772 ido-process-ignore-lists re-list
3774 (let ((ext-list (and ignore-ext ido-ignore-extensions
3775 completion-ignored-extensions))
3776 (case-fold-search ido-case-fold)
3778 (flen (length name)) slen)
3780 (setq nextstr (car ext-list))
3783 (and (>= flen (setq slen (length nextstr)))
3784 (string-equal (substring name (- flen slen)) nextstr)))
3785 ((functionp nextstr) (funcall nextstr name))
3790 (setq ext-list (cdr ext-list))))
3792 (setq nextstr (car re-list))
3794 ((stringp nextstr) (string-match nextstr name))
3795 ((functionp nextstr) (funcall nextstr name))
3799 (setq re-list (cdr re-list))))
3800 ;; return the result
3802 (setq ido-ignored-list (cons name ido-ignored-list)))
3805 ;; Private variable used by `ido-word-matching-substring'.
3806 (defvar ido-change-word-sub)
3808 (defun ido-find-common-substring (items subs)
3809 ;; Return common string following SUBS in each element of ITEMS.
3812 ido-change-word-sub)
3813 (setq ido-change-word-sub
3814 (if ido-enable-regexp
3816 (regexp-quote subs)))
3817 (setq res (mapcar #'ido-word-matching-substring items))
3818 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
3819 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
3821 ;; try-completion returns t if there is an exact match.
3822 (let* ((completion-ignore-case ido-case-fold)
3823 (comp (try-completion subs alist)))
3828 (defun ido-word-matching-substring (word)
3829 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
3830 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
3831 (let ((case-fold-search ido-case-fold))
3832 (let ((m (string-match ido-change-word-sub (ido-name word))))
3834 (substring (ido-name word) m)
3838 (defun ido-makealist (res)
3839 ;; Return dotted pair (RES . 1).
3842 (defun ido-choose-completion-string (choice &rest ignored)
3844 ;; Insert the completion into the buffer where completion was requested.
3845 (if (get-buffer ido-completion-buffer)
3846 (kill-buffer ido-completion-buffer))
3848 ((ido-active t) ;; ido-use-merged-list
3849 (setq ido-current-directory ""
3852 ((not (ido-final-slash choice))
3853 (setq ido-text choice
3856 (ido-set-current-directory ido-current-directory choice)
3857 (setq ido-exit 'refresh)))
3861 (defun ido-completion-help ()
3862 "Show possible completions in a *File Completions* buffer."
3864 (setq ido-rescan nil)
3865 (let ((temp-buf (get-buffer ido-completion-buffer))
3866 display-it full-list)
3867 (if (and (eq last-command this-command) temp-buf)
3869 (let (win (buf (current-buffer)))
3870 (display-buffer temp-buf nil nil)
3871 (set-buffer temp-buf)
3872 (setq win (get-buffer-window temp-buf))
3873 (if (pos-visible-in-window-p (point-max) win)
3874 (if (or ido-completion-buffer-all-completions
3875 (boundp 'ido-completion-buffer-full))
3876 (set-window-start win (point-min))
3878 (set (make-local-variable 'ido-completion-buffer-full) t))
3881 (scroll-other-window))
3883 (setq display-it t))
3885 (with-output-to-temp-buffer ido-completion-buffer
3886 (let ((completion-list (sort
3888 (ido-directory-too-big
3889 (message "Reading directory...")
3890 (setq ido-directory-too-big nil
3891 ido-ignored-list nil
3892 ido-cur-list (ido-all-completions)
3895 (or ido-matches ido-cur-list))
3896 (ido-use-merged-list
3897 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
3898 ((or full-list ido-completion-buffer-all-completions)
3899 (ido-all-completions))
3901 (copy-sequence (or ido-matches ido-cur-list))))
3903 (if (featurep 'xemacs)
3904 ;; XEmacs extents are put on by default, doesn't seem to be
3905 ;; any way of switching them off.
3906 ;; This obscure code avoids a byte compiler warning in Emacs.
3907 (let ((f 'display-completion-list))
3908 (funcall f completion-list
3911 '(lambda (x y z) (message "Doesn't work yet, sorry!"))))
3912 ;; else running Emacs
3913 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
3914 (display-completion-list completion-list)))))))
3916 ;;; KILL CURRENT BUFFER
3917 (defun ido-kill-buffer-at-head ()
3918 "Kill the buffer at the head of `ido-matches'.
3919 If cursor is not at the end of the user input, delete to end of input."
3922 (delete-region (point) (line-end-position))
3923 (let ((enable-recursive-minibuffers t)
3924 (buf (ido-name (car ido-matches)))
3925 (nextbuf (cadr ido-matches)))
3926 (when (get-buffer buf)
3927 ;; If next match names a buffer use the buffer object; buffer
3928 ;; name may be changed by packages such as uniquify; mindful
3929 ;; of virtual buffers.
3930 (when (and nextbuf (get-buffer nextbuf))
3931 (setq nextbuf (get-buffer nextbuf)))
3932 (if (null (kill-buffer buf))
3933 ;; Buffer couldn't be killed.
3935 ;; Else `kill-buffer' succeeds so re-make the buffer list
3936 ;; taking into account packages like uniquify may rename
3938 (if (bufferp nextbuf)
3939 (setq nextbuf (buffer-name nextbuf)))
3940 (setq ido-default-item nextbuf
3941 ido-text-init ido-text
3943 (exit-minibuffer))))))
3945 ;;; DELETE CURRENT FILE
3946 (defun ido-delete-file-at-head ()
3947 "Delete the file at the head of `ido-matches'.
3948 If cursor is not at the end of the user input, delete to end of input."
3951 (delete-region (point) (line-end-position))
3952 (let ((enable-recursive-minibuffers t)
3953 (file (ido-name (car ido-matches))))
3955 (setq file (concat ido-current-directory file)))
3957 (file-exists-p file)
3958 (not (file-directory-p file))
3959 (file-writable-p ido-current-directory)
3960 (yes-or-no-p (concat "Delete " file "? ")))
3962 ;; Check if file still exists.
3963 (if (file-exists-p file)
3964 ;; file could not be deleted
3966 ;; else file was killed so remove name from list.
3967 (setq ido-cur-list (delq (car ido-matches) ido-cur-list)))))))
3970 ;;; VISIT CHOSEN BUFFER
3971 (defun ido-visit-buffer (buffer method &optional record)
3972 "Switch to BUFFER according to METHOD.
3973 Record command in `command-history' if optional RECORD is non-nil."
3974 (if (bufferp buffer)
3975 (setq buffer (buffer-name buffer)))
3980 (ido-record-command 'kill-buffer buffer))
3981 (kill-buffer buffer))
3983 ((eq method 'other-window)
3985 (ido-record-command 'switch-to-buffer buffer))
3986 (switch-to-buffer-other-window buffer))
3988 ((eq method 'display)
3989 (display-buffer buffer))
3991 ((eq method 'other-frame)
3992 (switch-to-buffer-other-frame buffer)
3993 (select-frame-set-input-focus (selected-frame)))
3995 ((and (memq method '(raise-frame maybe-frame))
3997 (setq win (ido-buffer-window-other-frame buffer))
3998 (or (eq method 'raise-frame)
3999 (y-or-n-p "Jump to frame? ")))
4000 (setq newframe (window-frame win))
4001 (select-frame-set-input-focus newframe)
4002 (select-window win))
4004 ;; (eq method 'selected-window)
4006 ;; No buffer in other frames...
4008 (ido-record-command 'switch-to-buffer buffer))
4009 (switch-to-buffer buffer)
4013 (defun ido-buffer-window-other-frame (buffer)
4014 ;; Return window pointer if BUFFER is visible in another frame.
4015 ;; If BUFFER is visible in the current frame, return nil.
4016 (let ((blist (ido-get-buffers-in-frames 'current)))
4017 ;;If the buffer is visible in current frame, return nil
4018 (if (member buffer blist)
4020 ;; maybe in other frame or icon
4021 (get-buffer-window buffer 0) ; better than 'visible
4025 ;;; ----------- IDONIZED FUNCTIONS ------------
4028 (defun ido-switch-buffer ()
4029 "Switch to another buffer.
4030 The buffer is displayed according to `ido-default-buffer-method' -- the
4031 default is to show it in the same window, unless it is already visible
4034 As you type in a string, all of the buffers matching the string are
4035 displayed if substring-matching is used \(default). Look at
4036 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
4037 buffer you want, it can then be selected. As you type, most keys have
4038 their normal keybindings, except for the following: \\<ido-buffer-completion-map>
4040 RET Select the buffer at the front of the list of matches. If the
4041 list is empty, possibly prompt to create new buffer.
4043 \\[ido-select-text] Select the current prompt as the buffer.
4044 If no buffer is found, prompt for a new one.
4046 \\[ido-next-match] Put the first element at the end of the list.
4047 \\[ido-prev-match] Put the last element at the start of the list.
4048 \\[ido-complete] Complete a common suffix to the current string that
4049 matches all buffers. If there is only one match, select that buffer.
4050 If there is no common suffix, show a list of all matching buffers
4051 in a separate window.
4052 \\[ido-edit-input] Edit input string.
4053 \\[ido-fallback-command] Fallback to non-ido version of current command.
4054 \\[ido-toggle-regexp] Toggle regexp searching.
4055 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
4056 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
4057 \\[ido-completion-help] Show list of matching buffers in separate window.
4058 \\[ido-enter-find-file] Drop into `ido-find-file'.
4059 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
4060 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
4062 (ido-buffer-internal ido-default-buffer-method))
4065 (defun ido-switch-buffer-other-window ()
4066 "Switch to another buffer and show it in another window.
4067 The buffer name is selected interactively by typing a substring.
4068 For details of keybindings, see `ido-switch-buffer'."
4070 (ido-buffer-internal 'other-window 'switch-to-buffer-other-window))
4073 (defun ido-display-buffer ()
4074 "Display a buffer in another window but don't select it.
4075 The buffer name is selected interactively by typing a substring.
4076 For details of keybindings, see `ido-switch-buffer'."
4078 (ido-buffer-internal 'display 'display-buffer nil nil nil 'ignore))
4081 (defun ido-kill-buffer ()
4083 The buffer name is selected interactively by typing a substring.
4084 For details of keybindings, see `ido-switch-buffer'."
4086 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer)) nil 'ignore))
4089 (defun ido-insert-buffer ()
4090 "Insert contents of a buffer in current buffer after point.
4091 The buffer name is selected interactively by typing a substring.
4092 For details of keybindings, see `ido-switch-buffer'."
4094 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil nil 'ido-enter-insert-file))
4097 (defun ido-switch-buffer-other-frame ()
4098 "Switch to another buffer and show it in another frame.
4099 The buffer name is selected interactively by typing a substring.
4100 For details of keybindings, see `ido-switch-buffer'."
4103 (ido-buffer-internal 'other-frame)
4104 (call-interactively 'switch-to-buffer-other-frame)))
4107 (defun ido-find-file-in-dir (dir)
4108 "Switch to another file starting from DIR."
4109 (interactive "DDir: ")
4110 (setq dir (file-name-as-directory dir))
4111 (ido-file-internal ido-default-file-method nil dir nil nil nil 'ignore))
4114 (defun ido-find-file ()
4115 "Edit file with name obtained via minibuffer.
4116 The file is displayed according to `ido-default-file-method' -- the
4117 default is to show it in the same window, unless it is already
4118 visible in another frame.
4120 The file name is selected interactively by typing a substring. As you
4121 type in a string, all of the filenames matching the string are displayed
4122 if substring-matching is used \(default). Look at `ido-enable-prefix' and
4123 `ido-toggle-prefix'. When you have found the filename you want, it can
4124 then be selected. As you type, most keys have their normal keybindings,
4125 except for the following: \\<ido-file-completion-map>
4127 RET Select the file at the front of the list of matches. If the
4128 list is empty, possibly prompt to create new file.
4130 \\[ido-select-text] Select the current prompt as the buffer or file.
4131 If no buffer or file is found, prompt for a new one.
4133 \\[ido-next-match] Put the first element at the end of the list.
4134 \\[ido-prev-match] Put the last element at the start of the list.
4135 \\[ido-complete] Complete a common suffix to the current string that
4136 matches all files. If there is only one match, select that file.
4137 If there is no common suffix, show a list of all matching files
4138 in a separate window.
4139 \\[ido-edit-input] Edit input string (including directory).
4140 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
4141 \\[ido-merge-work-directories] search for file in the work directory history.
4142 \\[ido-forget-work-directory] removes current directory from the work directory history.
4143 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
4144 \\[ido-wide-find-file-or-pop-dir] and \\[ido-wide-find-dir-or-delete-dir] prompts and uses find to locate files or directories.
4145 \\[ido-make-directory] prompts for a directory to create in current directory.
4146 \\[ido-fallback-command] Fallback to non-ido version of current command.
4147 \\[ido-toggle-regexp] Toggle regexp searching.
4148 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
4149 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
4150 \\[ido-toggle-vc] Toggle version control for this file.
4151 \\[ido-toggle-literal] Toggle literal reading of this file.
4152 \\[ido-completion-help] Show list of matching files in separate window.
4153 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
4156 (ido-file-internal ido-default-file-method))
4159 (defun ido-find-file-other-window ()
4160 "Switch to another file and show it in another window.
4161 The file name is selected interactively by typing a substring.
4162 For details of keybindings, see `ido-find-file'."
4164 (ido-file-internal 'other-window 'find-file-other-window))
4167 (defun ido-find-alternate-file ()
4168 "Switch to another file and show it in another window.
4169 The file name is selected interactively by typing a substring.
4170 For details of keybindings, see `ido-find-file'."
4172 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
4175 (defun ido-find-file-read-only ()
4176 "Edit file read-only with name obtained via minibuffer.
4177 The file name is selected interactively by typing a substring.
4178 For details of keybindings, see `ido-find-file'."
4180 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
4183 (defun ido-find-file-read-only-other-window ()
4184 "Edit file read-only in other window with name obtained via minibuffer.
4185 The file name is selected interactively by typing a substring.
4186 For details of keybindings, see `ido-find-file'."
4188 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
4191 (defun ido-find-file-read-only-other-frame ()
4192 "Edit file read-only in other frame with name obtained via minibuffer.
4193 The file name is selected interactively by typing a substring.
4194 For details of keybindings, see `ido-find-file'."
4196 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
4199 (defun ido-display-file ()
4200 "Display a file in another window but don't select it.
4201 The file name is selected interactively by typing a substring.
4202 For details of keybindings, see `ido-find-file'."
4204 (ido-file-internal 'display nil nil nil nil nil 'ignore))
4207 (defun ido-find-file-other-frame ()
4208 "Switch to another file and show it in another frame.
4209 The file name is selected interactively by typing a substring.
4210 For details of keybindings, see `ido-find-file'."
4212 (ido-file-internal 'other-frame 'find-file-other-frame))
4215 (defun ido-write-file ()
4216 "Write current buffer to a file.
4217 The file name is selected interactively by typing a substring.
4218 For details of keybindings, see `ido-find-file'."
4220 (let ((ido-process-ignore-lists t)
4221 (ido-work-directory-match-only nil)
4222 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
4223 (ido-report-no-match nil)
4224 (ido-confirm-unique-completion t)
4225 (ido-auto-merge-work-directories-length -1))
4226 (ido-file-internal 'write 'write-file nil "Write file: " nil nil 'ignore)))
4229 (defun ido-insert-file ()
4230 "Insert contents of file in current buffer.
4231 The file name is selected interactively by typing a substring.
4232 For details of keybindings, see `ido-find-file'."
4234 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil nil 'ido-enter-insert-buffer))
4238 "Call `dired' the ido way.
4239 The directory is selected interactively by typing a substring.
4240 For details of keybindings, see `ido-find-file'."
4242 (let ((ido-report-no-match nil)
4243 (ido-auto-merge-work-directories-length -1))
4244 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
4246 (defun ido-list-directory ()
4247 "Call `list-directory' the ido way.
4248 The directory is selected interactively by typing a substring.
4249 For details of keybindings, see `ido-find-file'."
4251 (let ((ido-report-no-match nil)
4252 (ido-auto-merge-work-directories-length -1))
4253 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
4255 ;;; XEmacs hack for showing default buffer
4257 ;; The first time we enter the minibuffer, Emacs puts up the default
4258 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
4259 ;; subtle difference in the two versions of post-command-hook. The
4260 ;; default is shown for both whenever we delete all of our text
4261 ;; though, indicating its just a problem the first time we enter the
4262 ;; function. To solve this, we use another entry hook for emacs to
4263 ;; show the default the first time we enter the minibuffer.
4266 ;;; ICOMPLETE TYPE CODE
4268 (defun ido-initiate-auto-merge (buffer)
4269 (ido-trace "\n*merge timeout*" buffer)
4270 (setq ido-auto-merge-timer nil)
4271 (when (and (buffer-live-p buffer)
4273 (boundp 'ido-eoinput) ido-eoinput)
4274 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
4275 (ido-trace "request merge")
4276 (setq ido-use-merged-list 'auto
4277 ido-text-init contents
4280 (with-current-buffer buffer
4282 (throw 'ido contents))))
4284 (defun ido-exhibit ()
4285 "Post command hook for `ido'."
4286 ;; Find matching files and display a list in the minibuffer.
4287 ;; Copied from `icomplete-exhibit' with two changes:
4288 ;; 1. It prints a default file name when there is no text yet entered.
4289 ;; 2. It calls my completion routine rather than the standard completion.
4292 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
4293 (buffer-undo-list t)
4294 try-single-dir-match
4297 (when ido-trace-enable
4298 (ido-trace "\nexhibit" this-command)
4299 (ido-trace "dir" ido-current-directory)
4300 (ido-trace "contents" contents)
4301 (ido-trace "list" ido-cur-list)
4302 (ido-trace "matches" ido-matches)
4303 (ido-trace "rescan" ido-rescan))
4306 (goto-char (point-max))
4307 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
4308 (unless (boundp 'ido-eoinput)
4309 ;; In case it got wiped out by major mode business:
4310 (make-local-variable 'ido-eoinput))
4311 (setq ido-eoinput (point))
4313 ;; Handle explicit directory changes
4315 ((memq ido-cur-item '(buffer list))
4318 ((= (length contents) 0)
4321 ((= (length contents) 1)
4323 ((and (ido-is-tramp-root) (string-equal contents "/"))
4324 (ido-set-current-directory ido-current-directory contents)
4326 ((and (ido-unc-hosts) (string-equal contents "/")
4327 (let ((ido-enable-tramp-completion nil))
4328 (ido-is-root-directory)))
4329 (ido-set-current-directory "//")
4333 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") contents)
4334 (ido-is-root-directory) ;; Ange-ftp or tramp
4335 (not (ido-local-file-exists-p contents)))
4336 (ido-set-current-directory ido-current-directory contents)
4337 (when (ido-is-slow-ftp-host)
4338 (setq ido-exit 'fallback)
4342 ((ido-final-slash contents) ;; xxx/
4343 (ido-trace "final slash" contents)
4345 ((string-equal contents "~/")
4346 (ido-set-current-home)
4348 ((string-equal contents "../")
4349 (ido-up-directory t)
4351 ((string-equal contents "./")
4353 ((string-match "\\`~[-_a-zA-Z0-9]+[$]?/\\'" contents)
4354 (ido-trace "new home" contents)
4355 (ido-set-current-home contents)
4357 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
4358 (let ((exp (condition-case ()
4360 (substitute-in-file-name (substring contents 0 -1))
4361 ido-current-directory)
4363 (ido-trace contents exp)
4364 (when (and exp (file-directory-p exp))
4365 (ido-set-current-directory (file-name-directory exp))
4366 (setq ido-text-init (file-name-nondirectory exp))
4368 ((and (memq system-type '(windows-nt ms-dos))
4369 (string-equal (substring contents 1) ":/"))
4370 (ido-set-current-directory (file-name-directory contents))
4372 ((string-equal (substring contents -2 -1) "/")
4373 (ido-set-current-directory
4374 (if (memq system-type '(windows-nt ms-dos))
4375 (expand-file-name "/" ido-current-directory)
4378 ((and (or ido-directory-nonreadable ido-directory-too-big)
4379 (file-directory-p (concat ido-current-directory (file-name-directory contents))))
4380 (ido-set-current-directory
4381 (concat ido-current-directory (file-name-directory contents)))
4384 (ido-trace "try single dir")
4385 (setq try-single-dir-match t))))
4387 ((and (string-equal (substring contents -2 -1) "/")
4388 (not (string-match "[$]" contents)))
4389 (ido-set-current-directory
4391 ((= (length contents) 2)
4394 (concat ido-current-directory (ido-name (car ido-matches))))
4396 (concat ido-current-directory (substring contents 0 -1)))))
4397 (setq ido-text-init (substring contents -1))
4400 ((and (not ido-use-merged-list)
4401 (not (ido-final-slash contents))
4402 (eq ido-try-merged-list t)
4403 (numberp ido-auto-merge-work-directories-length)
4404 (> ido-auto-merge-work-directories-length 0)
4405 (= (length contents) ido-auto-merge-work-directories-length)
4406 (not (and ido-auto-merge-inhibit-characters-regexp
4407 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4408 (not (input-pending-p)))
4409 (setq ido-use-merged-list 'auto
4410 ido-text-init contents
4417 (ido-trace "refresh on /" ido-text-init)
4418 (setq ido-exit 'refresh)
4421 ;; Update the list of matches
4422 (setq ido-text contents)
4424 (ido-trace "new " ido-matches)
4426 (when (and ido-enter-matching-directory
4428 (or (eq ido-enter-matching-directory 'first)
4429 (null (cdr ido-matches)))
4430 (ido-final-slash (ido-name (car ido-matches)))
4431 (or try-single-dir-match
4432 (eq ido-enter-matching-directory t)))
4433 (ido-trace "single match" (car ido-matches))
4434 (ido-set-current-directory
4435 (concat ido-current-directory (ido-name (car ido-matches))))
4436 (setq ido-exit 'refresh)
4439 (when (and (not ido-matches)
4440 (not ido-directory-nonreadable)
4441 (not ido-directory-too-big)
4443 ido-process-ignore-lists
4445 (let ((ido-process-ignore-lists nil)
4446 (ido-rotate ido-rotate)
4447 (ido-cur-list ido-ignored-list))
4448 (ido-trace "try all" ido-ignored-list)
4451 (ido-trace "found " ido-matches)
4453 (setq ido-process-ignore-lists-inhibit t)
4454 (setq ido-text-init ido-text)
4455 (setq ido-exit 'refresh)
4461 (memq ido-cur-item '(file dir))
4462 (not (ido-is-root-directory))
4463 (> (length contents) 1)
4464 (not (string-match "[$]" contents))
4465 (not ido-directory-nonreadable)
4466 (not ido-directory-too-big))
4467 (ido-trace "merge?")
4468 (if ido-use-merged-list
4469 (ido-undo-merge-work-directory contents nil)
4470 (when (and (eq ido-try-merged-list t)
4471 (numberp ido-auto-merge-work-directories-length)
4472 (= ido-auto-merge-work-directories-length 0)
4473 (not (and ido-auto-merge-inhibit-characters-regexp
4474 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4475 (not (input-pending-p)))
4476 (ido-trace "\n*start timer*")
4477 (setq ido-auto-merge-timer
4478 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
4482 (if (and ido-use-merged-list
4484 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
4486 (ido-set-current-directory (car (cdr (car ido-matches))))
4487 (setq ido-use-merged-list t
4489 ido-text-init ido-text)
4492 ;; Insert the match-status information:
4493 (ido-set-common-completion)
4494 (let ((inf (ido-completions
4496 minibuffer-completion-table
4497 minibuffer-completion-predicate
4498 (not minibuffer-completion-confirm))))
4499 (setq ido-show-confirm-message nil)
4500 (ido-trace "inf" inf)
4504 (defun ido-completions (name candidates predicate require-match)
4505 ;; Return the string that is displayed after the user's text.
4506 ;; Modified from `icomplete-completions'.
4508 (let* ((comps ido-matches)
4509 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
4510 ido-merged-indicator))
4513 (if (and ind ido-use-faces)
4514 (put-text-property 0 1 'face 'ido-indicator ind))
4516 (if (and ido-use-faces comps)
4517 (let* ((fn (ido-name (car comps)))
4519 (setq first (format "%s" fn))
4520 (put-text-property 0 ln 'face
4521 (if (= (length comps) 1)
4522 (if ido-incomplete-regexp
4523 'ido-incomplete-regexp
4527 (if ind (setq first (concat first ind)))
4528 (setq comps (cons first (cdr comps)))))
4532 (ido-show-confirm-message
4533 (or (nth 10 ido-decorations) " [Confirm]"))
4534 (ido-directory-nonreadable
4535 (or (nth 8 ido-decorations) " [Not readable]"))
4536 (ido-directory-too-big
4537 (or (nth 9 ido-decorations) " [Too big]"))
4538 (ido-report-no-match
4539 (nth 6 ido-decorations)) ;; [No match]
4541 (ido-incomplete-regexp
4542 (concat " " (car comps)))
4543 ((null (cdr comps)) ;one match
4544 (concat (if (if (not ido-enable-regexp)
4545 (= (length (ido-name (car comps))) (length name))
4546 ;; We can't rely on the length of the input
4547 ;; for regexps, so explicitly check for a
4549 (string-match name (ido-name (car comps)))
4550 (string-equal (match-string 0 (ido-name (car comps)))
4551 (ido-name (car comps))))
4553 ;; when there is one match, show the matching file name in full
4554 (concat (nth 4 ido-decorations) ;; [ ... ]
4555 (ido-name (car comps))
4556 (nth 5 ido-decorations)))
4557 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
4558 (t ;multiple matches
4559 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
4567 (setq com (ido-name com))
4568 (setq items (1- items))
4571 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
4573 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
4574 (let ((str (substring com 0)))
4575 (if (and ido-use-faces
4576 (not (string= str first))
4577 (ido-final-slash str))
4578 (put-text-property 0 (length str) 'face 'ido-subdir str))
4583 ;; put in common completion item -- what you get by pressing tab
4584 (if (and (stringp ido-common-match-string)
4585 (> (length ido-common-match-string) (length name)))
4586 (concat (nth 4 ido-decorations) ;; [ ... ]
4587 (substring ido-common-match-string (length name))
4588 (nth 5 ido-decorations)))
4589 ;; list all alternatives
4590 (nth 0 ido-decorations) ;; { ... }
4592 (nth 1 ido-decorations)))))))
4594 (defun ido-minibuffer-setup ()
4595 "Minibuffer setup hook for `ido'."
4596 ;; Copied from `icomplete-minibuffer-setup-hook'.
4598 (add-hook 'pre-command-hook 'ido-tidy nil t)
4599 (add-hook 'post-command-hook 'ido-exhibit nil t)
4600 (when (featurep 'xemacs)
4602 (goto-char (point-min)))
4603 (run-hooks 'ido-minibuffer-setup-hook)
4604 (when ido-initial-position
4605 (goto-char (+ (minibuffer-prompt-end) ido-initial-position))
4606 (setq ido-initial-position nil))))
4609 "Pre command hook for `ido'."
4610 ;; Remove completions display, if any, prior to new user input.
4611 ;; Copied from `icomplete-tidy'."
4613 (when ido-auto-merge-timer
4614 (ido-trace "\n*cancel timer*" this-command)
4615 (cancel-timer ido-auto-merge-timer)
4616 (setq ido-auto-merge-timer nil))
4619 (if (and (boundp 'ido-eoinput)
4622 (if (> ido-eoinput (point-max))
4623 ;; Oops, got rug pulled out from under us - reinit:
4624 (setq ido-eoinput (point-max))
4625 (let ((buffer-undo-list t))
4626 (delete-region ido-eoinput (point-max))))
4628 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
4629 (make-local-variable 'ido-eoinput)
4630 (setq ido-eoinput 1))))
4632 (defun ido-summary-buffers-to-end ()
4633 ;; Move the summaries to the end of the buffer list.
4634 ;; This is an example function which can be hooked on to
4635 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
4636 ;; `Summary' or `output\*$'are put to the end of the list.
4637 (let ((summaries (delq nil (mapcar
4640 (string-match "Summary" x)
4641 (string-match "output\\*\\'" x))
4644 (ido-to-end summaries)))
4646 ;;; Helper functions for other programs
4648 (put 'dired-do-rename 'ido 'ignore)
4649 (put 'ibuffer-find-file 'ido 'find-file)
4650 (put 'dired-other-window 'ido 'dir)
4653 (defun ido-read-buffer (prompt &optional default require-match)
4654 "Ido replacement for the built-in `read-buffer'.
4655 Return the name of a buffer selected.
4656 PROMPT is the prompt to give to the user. DEFAULT if given is the default
4657 buffer to be selected, which will go to the front of the list.
4658 If REQUIRE-MATCH is non-nil, an existing buffer must be selected."
4659 (let* ((ido-current-directory nil)
4660 (ido-directory-nonreadable nil)
4661 (ido-directory-too-big nil)
4662 (ido-context-switch-command 'ignore)
4663 (buf (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match)))
4664 (if (eq ido-exit 'fallback)
4665 (let ((read-buffer-function nil))
4666 (run-hook-with-args 'ido-before-fallback-functions 'read-buffer)
4667 (read-buffer prompt default require-match))
4671 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
4672 "Ido replacement for the built-in `read-file-name'.
4673 Read file name, prompting with PROMPT and completing in directory DIR.
4674 See `read-file-name' for additional parameters."
4677 ((or (eq predicate 'file-directory-p)
4678 (eq (get this-command 'ido) 'dir)
4679 (memq this-command ido-read-file-name-as-directory-commands))
4681 (ido-read-directory-name prompt dir default-filename mustmatch initial))
4682 (if (eq ido-exit 'fallback)
4683 (setq filename 'fallback)))
4684 ((and (not (eq (get this-command 'ido) 'ignore))
4685 (not (memq this-command ido-read-file-name-non-ido))
4686 (or (null predicate) (eq predicate 'file-exists-p)))
4687 (let* (ido-saved-vc-hb
4688 (ido-context-switch-command
4689 (if (eq (get this-command 'ido) 'find-file) nil 'ignore))
4690 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
4691 (minibuffer-completing-file-name t)
4692 (ido-current-directory (ido-expand-directory dir))
4693 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4694 (ido-directory-too-big (and (not ido-directory-nonreadable)
4695 (ido-directory-too-big-p ido-current-directory)))
4696 (ido-work-directory-index -1)
4697 (ido-show-dot-for-dired (and ido-show-dot-for-dired
4698 (not default-filename)))
4699 (ido-work-file-index -1)
4700 (ido-find-literal nil))
4703 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
4705 ((eq ido-exit 'fallback)
4706 (setq filename 'fallback))
4707 ((eq ido-exit 'dired)
4708 (setq filename ido-current-directory))
4711 (concat ido-current-directory filename))))))
4713 (setq filename 'fallback)))
4714 (if (eq filename 'fallback)
4715 (let ((read-file-name-function nil))
4716 (run-hook-with-args 'ido-before-fallback-functions 'read-file-name)
4717 (read-file-name prompt dir default-filename mustmatch initial predicate))
4721 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
4722 "Ido replacement for the built-in `read-directory-name'.
4723 Read directory name, prompting with PROMPT and completing in directory DIR.
4724 See `read-directory-name' for additional parameters."
4726 (minibuffer-completing-file-name t)
4727 (ido-context-switch-command 'ignore)
4729 (ido-current-directory (ido-expand-directory dir))
4730 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4731 (ido-directory-too-big (and (not ido-directory-nonreadable)
4732 (ido-directory-too-big-p ido-current-directory)))
4733 (ido-work-directory-index -1)
4734 (ido-work-file-index -1))
4736 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
4738 (if (and (stringp filename) (string-equal filename "."))
4739 ido-current-directory
4740 (concat ido-current-directory filename)))))
4743 (defun ido-completing-read (prompt choices &optional predicate require-match initial-input hist def)
4744 "Ido replacement for the built-in `completing-read'.
4745 Read a string in the minibuffer with ido-style completion.
4746 PROMPT is a string to prompt with; normally it ends in a colon and a space.
4747 CHOICES is a list of strings which are the possible completions.
4748 PREDICATE is currently ignored; it is included to be compatible
4749 with `completing-read'.
4750 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
4751 the input is (or completes to) an element of CHOICES or is null.
4752 If the input is null, `ido-completing-read' returns DEF, or an empty
4753 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
4754 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
4755 with point positioned at the end.
4756 HIST, if non-nil, specifies a history list.
4757 DEF, if non-nil, is the default value."
4758 (let ((ido-current-directory nil)
4759 (ido-directory-nonreadable nil)
4760 (ido-directory-too-big nil)
4761 (ido-context-switch-command 'ignore)
4762 (ido-choice-list choices))
4763 ;; Initialize ido before invoking ido-read-internal
4764 (ido-common-initialization)
4765 (ido-read-internal 'list prompt hist def require-match initial-input)))
4767 (defun ido-unload-function ()
4768 "Unload the Ido library."
4770 (setq minor-mode-map-alist (assq-delete-all 'ido-mode minor-mode-map-alist))
4771 ;; continue standard unloading
4776 ;;; ido.el ends here