1 ;;; ido.el --- interactively do things with buffers and files.
3 ;; Copyright (C) 1996-2004 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 2, or (at your option)
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; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; Infinite amounts of gratitude goes to Stephen Eglen <stephen@cns.ed.ac.uk>
29 ;; who wrote iswitch-buffer mode - from which I ripped off 99% of the code
30 ;; for ido-switch-buffer and found the inspiration for ido-find-file.
31 ;; The ido package would never have existed without his work.
33 ;; Also thanks to Klaus Berndl, Rohit Namjoshi, Robert Fenk, Alex
34 ;; Schroeder, Bill Benedetto, Stephen Eglen, and many others for bug
35 ;; fixes and improvements.
39 ;; Since I discovered Stephen Eglen's excellent iswitchb package, I just
40 ;; couldn't live without it, but once being addicted to switching buffers
41 ;; with a minimum of keystrokes, I soon found that opening files in the
42 ;; old-fashioned way was just too slow - so I decided to write a package
43 ;; which could open files with the same speed and ease as iswitchb could
46 ;; I originally wrote a separate ifindf.el package based on a copy of
47 ;; iswitchb.el, which did for opening files what iswitchb did for
48 ;; switching buffers. Along the way, I corrected a few errors in
49 ;; ifindf which could have found its way back into iswitchb, but since
50 ;; most of the functionality of the two package was practically
51 ;; identical, I decided that the proper thing to do was to merge my
52 ;; ifindf package back into iswitchb.
54 ;; This is basically what ido (interactively do) is all about; but I
55 ;; found it ackward to merge my changes into the "iswitchb-" namespace,
56 ;; so I invented a common "ido-" namespace for the merged packages.
58 ;; This version is based on ido.el version 1.57 released on
59 ;; gnu.emacs.sources adapted for emacs 21.5 to use command remapping
60 ;; and optionally hooking the read-buffer and read-file-name functions.
62 ;; Prefix matching was added by Klaus Berndl <klaus.berndl@sdm.de> based on
63 ;; an idea of Yuji Minejima <ggb01164@nifty.ne.jp> and his mcomplete-package.
68 ;; Ido - interactive do - switches between buffers and opens files and
69 ;; directories with a minimum of keystrokes. It is a superset of
70 ;; iswitchb, the interactive buffer switching package by Stephen Eglen.
72 ;; Interactive substring matching
73 ;; ------------------------------
75 ;; As you type in a substring, the list of buffers or files currently
76 ;; matching the substring are displayed as you type. The list is
77 ;; ordered so that the most recent buffers or files visited come at
78 ;; the start of the list.
80 ;; The buffer or file at the start of the list will be the one visited
81 ;; when you press RETURN. By typing more of the substring, the list is
82 ;; narrowed down so that gradually the buffer or file you want will be
83 ;; at the top of the list. Alternatively, you can use C-s and C-r (or
84 ;; the right and left arrow keys) to rotate buffer or file names in the
85 ;; list until the one you want is at the top of the list.
87 ;; Completion is also available so that you can see what is common to
88 ;; all of the matching buffers or files as you type.
92 ;; If I have two buffers called "123456" and "123", with "123456" the
93 ;; most recent, when I use ido-switch-buffer, I first of all get
94 ;; presented with the list of all the buffers
96 ;; Buffer: {123456,123}
99 ;; Buffer: 2[3]{123456,123}
101 ;; The list in {...} are the matching buffers, most recent first
102 ;; (buffers visible in the current frame are put at the end of the
103 ;; list by default). At any time I can select the item at the head of
104 ;; the list by pressing RET. I can also bring the put the first
105 ;; element at the end of the list by pressing C-s or [right], or put
106 ;; the last element at the head of the list by pressing C-r or [left].
108 ;; The item in [...] indicates what can be added to my input by
109 ;; pressing TAB. In this case, I will get "3" added to my input.
112 ;; Buffer: 23{123456,123}
114 ;; At this point, I still have two matching buffers.
115 ;; If I want the first buffer in the list, I simply press RET. If I
116 ;; wanted the second in the list, I could press C-s to move it to the
117 ;; top of the list and then RET to select it.
119 ;; However, if I type 4, I only have one match left:
120 ;; Buffer: 234[123456] [Matched]
122 ;; Since there is only one matching buffer left, it is given in [] and we
123 ;; see the text [Matched] afterwards. I can now press TAB or RET to go
126 ;; If however, I now type "a":
127 ;; Buffer: 234a [No match]
128 ;; There are no matching buffers. If I press RET or TAB, I can be
129 ;; prompted to create a new buffer called "234a".
131 ;; Of course, where this function comes in really useful is when you
132 ;; can specify the buffer using only a few keystrokes. In the above
133 ;; example, the quickest way to get to the "123456" file would be
134 ;; just to type 4 and then RET (assuming there isn't any newer buffer
135 ;; with 4 in its name).
137 ;; Likewise, if you use C-x C-f (ido-find-file), the list of files and
138 ;; directories in the current directory is provided in the same
139 ;; fashion as the buffers above. The files and directories are
140 ;; normally sorted in alphabetical order, but the most recently
141 ;; visited directory is placed first to speed up navigating to
142 ;; directories that you have visited recently.
144 ;; In addition to scrolling through the list using [right] and [left],
145 ;; you can use [up] and [down] to quickly scroll the list to the next
146 ;; or previous subdirectory.
148 ;; To go down into a subdirectory, and continue the file selection on
149 ;; the files in that directory, simply move the directory to the head
150 ;; of the list and hit RET.
152 ;; To go up to the parent directory, delete any partial file name
153 ;; already specified (e.g. using [backspace]) and hit [backspace].
155 ;; To go to the root directory (on the current drive), enter two
156 ;; slashes. On MS-DOS or Windows, to select the root of another
157 ;; drive, enter X:/ where X is the drive letter. You can also visit
158 ;; files on other hosts using the ange-ftp notations `/host:' and
159 ;; `/user@host:'. See the variable `ido-slow-ftp-hosts' if you want
160 ;; to inhibit the ido substring matching for ftp access.
162 ;; If for some reason you cannot specify the proper file using
163 ;; ido-find-file, you can press C-f to enter the normal find-file.
164 ;; You can also press C-b to drop into ido-switch-buffer.
166 ;; See the doc string of ido-switch-buffer and ido-find-file for full
167 ;; keybindings and features.
168 ;; (describe-function 'ido-find-file)
170 ;; Hidden buffers and files
171 ;; ------------------------
173 ;; Normally, ido does not include hidden buffers (whose name starts
174 ;; with a space) and hidden files and directories (whose name starts
175 ;; with `.') in the list of possible completions. However, if the
176 ;; substring you enter does not match any of the visible buffers or
177 ;; files, ido will automatically look for completions among the hidden
180 ;; You can toggle display of the hidden buffers and files with C-a.
182 ;; Additional functionality
183 ;; ------------------------
185 ;; After C-x b, the buffer at the head of the list can be killed by
186 ;; pressing C-k. If the buffer needs saving, you will be queried
187 ;; before the buffer is killed.
189 ;; Likewise, after C-x C-f, you can delete (i.e. physically remove)
190 ;; the file at the head of the list with C-k. You will always be
191 ;; asked for confirmation before the file is deleted.
193 ;; If you enter C-x b to switch to a buffer visiting a given file, and
194 ;; you find that the file you are after is not in any buffer, you can
195 ;; press C-f to immediately drop into ido-find-file. And you can
196 ;; switch back to buffer selection with C-b.
201 ;; The standard way of completion with Unix-shells and Emacs is to insert a
202 ;; PREFIX and then hitting TAB (or another completion key). Cause of this
203 ;; behavior has become second nature to a lot of emacs users `ido' offers in
204 ;; addition to the default substring-matching-method (look above) also the
205 ;; prefix-matching-method. The kind of matching is the only difference to
206 ;; the description of the substring-matching above.
208 ;; You can toggle prefix matching with C-p.
212 ;; If you have again two Buffers "123456" and "123" then hitting "2" does
213 ;; not match because "2" is not a PREFIX in any of the buffer-names. This
214 ;; is the only difference between the substring and prefix matching.
219 ;; If you set ido-enable-flex-matching, ido will do a more flexible
220 ;; matching (unless regexp matching is active) to find possible matches
221 ;; among the available buffer or file names if no matches are found using
222 ;; the normal prefix or substring matching.
224 ;; The flexible matching implies that any item which simply contains all
225 ;; of the entered characters in the specified sequence will match.
229 ;; If you have four files "alpha", "beta", "gamma", and "delta",
230 ;; entering "aa" will match "alpha" and "gamma", while "ea" matches
231 ;; "beta" and "delta". If prefix matching is also active, "aa" only
232 ;; matches "alpha", while "ea" does not match any files.
237 ;; There is limited provision for regexp matching within ido,
238 ;; enabled through `ido-enable-regexp' (toggle with C-t).
239 ;; This allows you to type `c$' for example and see all file names
240 ;; ending in `c'. This facility is quite limited though in two
241 ;; respects. First, you can't currently type in expressions like
242 ;; `[0-9]' directly -- you have to type them in when ido-enable-regexp
243 ;; is nil and then toggle on the regexp functionality. Likewise,
244 ;; don't enter an expression containing `\' in regexp mode. If you
245 ;; try, ido gets confused, so just hit C-g and try again. Secondly,
246 ;; no completion mechanism is currently offered with regexp searching.
252 ;; Customize the `ido' group to change the `ido' functionality.
254 ;; To modify the keybindings, use the hook provided. For example:
255 ;;(add-hook 'ido-define-mode-map-hook 'ido-my-keys)
257 ;;(defun ido-my-keys ()
258 ;; "Add my keybindings for ido."
259 ;; (define-key ido-mode-map " " 'ido-next-match)
262 ;; Seeing all the matching buffers or files
263 ;; ----------------------------------------
265 ;; If you have many matching files, they may not all fit onto one
266 ;; line of the minibuffer. Normally, the minibuffer window will grow
267 ;; to show you more of the matching files (depending on the setting
268 ;; of the variables `resize-mini-windows' and `max-mini-window-height').
269 ;; If you want ido to behave differently from the default minibuffer
270 ;; resizing behaviour, set the variable `ido-max-window-height'.
272 ;; Also, to improve the responsiveness of ido, the maximum number of
273 ;; matching items is limited to 12, but you can increase or removed
274 ;; this limit via the `ido-max-prospects' variable.
276 ;; To see a full list of all matching buffers in a separate buffer,
277 ;; hit ? or press TAB when there are no further completions to the
278 ;; substring. Repeated TAB presses will scroll you through this
281 ;; Changing the list of files
282 ;; --------------------------
284 ;; By default, the list of current files is most recent first,
285 ;; oldest last, with the exception that the files visible in the
286 ;; current frame are put at the end of the list. A hook exists to
287 ;; allow other functions to order the list. For example, if you add:
289 ;; (add-hook 'ido-make-buffer-list-hook 'ido-summary-buffers-to-end)
291 ;; then all files matching "Summary" are moved to the end of the
292 ;; list. (I find this handy for keeping the INBOX Summary and so on
293 ;; out of the way.) It also moves files matching "output\*$" to the
294 ;; end of the list (these are created by AUCTeX when compiling.)
295 ;; Other functions could be made available which alter the list of
296 ;; matching files (either deleting or rearranging elements.)
301 ;; The highlighting of matching items is controlled via ido-use-faces.
302 ;; The faces used are ido-first-match-face, ido-only-match-face and
304 ;; Colouring of the matching item was suggested by
305 ;; Carsten Dominik (dominik@strw.leidenuniv.nl).
307 ;; Replacement for read-buffer and read-file-name
308 ;; ----------------------------------------------
310 ;; ido-read-buffer and ido-read-file-name have been written to be drop
311 ;; in replacements for the normal buffer and file name reading
312 ;; functions `read-buffer' and `read-file-name'.
314 ;; To use ido for all buffer and file selections in Emacs, customize the
315 ;; variable `ido-everywhere'.
317 ;; Using ido-like behaviour in other lisp packages
318 ;; -----------------------------------------------
320 ;; If you don't want to rely on the `ido-everywhere' functionality,
321 ;; ido-read-buffer, ido-read-file-name, and ido-read-directory-name
322 ;; can be used by other packages to read a buffer name, a file name,
323 ;; or a directory name in the `ido' way.
332 ;; These are some things you might want to change.
334 (defun ido-fractionp (n)
335 (and (numberp n
) (> n
0.0) (<= n
1.0)))
338 "Switch between files using substrings."
342 :link
'(emacs-commentary-link :tag
"Commentary" "ido.el")
343 :link
'(emacs-library-link :tag
"Lisp File" "ido.el"))
346 (defcustom ido-mode nil
347 "Determines for which functional group \(buffer and files) ido behavior
348 should be enabled. The following values are possible:
349 - `buffer': Turn only on ido buffer behavior \(switching, killing,
351 - `file': Turn only on ido file behavior \(finding, writing, inserting...)
352 - `both': Turn on ido buffer and file behavior.
353 - `nil': Turn off any ido switching.
355 Setting this variable directly does not take effect;
356 use either \\[customize] or the function `ido-mode'."
357 :set
#'(lambda (symbol value
)
359 :initialize
'custom-initialize-default
361 :link
'(emacs-commentary-link "ido.el")
362 :set-after
'(ido-save-directory-list-file)
363 :type
'(choice (const :tag
"Turn on only buffer" buffer
)
364 (const :tag
"Turn on only file" file
)
365 (const :tag
"Turn on both buffer and file" both
)
366 (const :tag
"Switch off all" nil
))
369 (defcustom ido-everywhere nil
370 "Use ido everywhere for reading file names and directories.
371 Setting this variable directly does not work. Use `customize' or
372 call the function `ido-everywhere'."
373 :set
#'(lambda (symbol value
)
374 (ido-everywhere value
))
375 :initialize
'custom-initialize-default
379 (defcustom ido-case-fold case-fold-search
380 "*Non-nil if searching of buffer and file names should ignore case."
384 (defcustom ido-ignore-buffers
386 "*List of regexps or functions matching buffer names to ignore.
387 For example, traditional behavior is not to list buffers whose names begin
388 with a space, for which the regexp is `\\` '. See the source file for
389 example functions that filter buffernames."
390 :type
'(repeat (choice regexp function
))
393 (defcustom ido-ignore-files
394 '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
395 "*List of regexps or functions matching file names to ignore.
396 For example, traditional behavior is not to list files whose names begin
397 with a #, for which the regexp is `\\`#'. See the source file for
398 example functions that filter filenames."
399 :type
'(repeat (choice regexp function
))
402 (defcustom ido-ignore-extensions t
403 "*Non-nil means ignore files in completion-ignored-extensions list."
407 (defcustom ido-show-dot-for-dired nil
408 "*Non-nil means to always put . as the first item in file name lists.
409 This allows the current directory to be opened immediate with `dired'."
413 (defcustom ido-file-extensions-order nil
414 "*List of file extensions specifying preferred order of file selections.
415 Each element is either a string with `.' as the first char, an empty
416 string matching files without extension, or t which is the default order
417 of for files with an unlisted file extension."
418 :type
'(repeat (choice string
419 (const :tag
"Default order" t
)))
422 (defcustom ido-ignore-directories
423 '("\\`CVS/" "\\`\\.\\./" "\\`\\./")
424 "*List of regexps or functions matching sub-directory names to ignore."
425 :type
'(repeat (choice regexp function
))
428 (defcustom ido-ignore-directories-merge nil
429 "*List of regexps or functions matching directory names to ignore during merge.
430 Directory names matched by one of the regexps in this list are not inserted
431 in merged file and directory lists."
432 :type
'(repeat (choice regexp function
))
435 ;;; Examples for setting the value of ido-ignore-buffers
436 ;(defun ido-ignore-c-mode (name)
437 ; "Ignore all c mode buffers -- example function for ido."
440 ; (string-match "^C$" mode-name)))
442 ;(setq ido-ignore-buffers '("^ " ido-ignore-c-mode))
444 ;;; Examples for setting the value of ido-ignore-files
445 ;(setq ido-ignore-files '("^ " "\\.c$" "\\.h$"))
447 (defcustom ido-default-file-method
'always-frame
448 "*How to switch to new file when using `ido-find-file'.
450 `samewindow' Show new file in same window
451 `otherwindow' Show new file in another window (same frame)
452 `display' Display file in another window without switching to it
453 `otherframe' Show new file in another frame
454 `maybe-frame' If a file is visible in another frame, prompt to ask if you
455 you want to see the file in the same window of the current
456 frame or in the other frame.
457 `always-frame' If a file is visible in another frame, raise that
458 frame. Otherwise, visit the file in the same window."
459 :type
'(choice (const samewindow
)
464 (const always-frame
))
467 (defcustom ido-default-buffer-method
'always-frame
468 "*How to switch to new buffer when using `ido-switch-buffer'.
469 See ido-default-file-method for details."
470 :type
'(choice (const samewindow
)
475 (const always-frame
))
478 (defcustom ido-enable-flex-matching nil
479 "*Non-nil means that `ido' will do flexible string matching.
480 Flexible matching means that if the entered string does not
481 match any item, any item containing the entered characters
482 in the given sequence will match."
487 (defcustom ido-enable-regexp nil
488 "*Non-nil means that `ido' will do regexp matching.
489 Value can be toggled within `ido' using `ido-toggle-regexp'."
493 (defcustom ido-enable-prefix nil
494 "*Non-nil means only match if the entered text is a prefix of file name.
495 This behavior is like the standard emacs-completion.
496 Nil means to match if the entered text is an arbitrary substring.
497 Value can be toggled within `ido' using `ido-toggle-prefix'."
501 (defcustom ido-enable-dot-prefix nil
502 "*Non-nil means to match leading dot as prefix.
503 I.e. hidden files and buffers will match only if you type a dot
504 as first char even if `ido-enable-prefix' is nil."
508 (defcustom ido-confirm-unique-completion nil
509 "*Non-nil means that even a unique completion must be confirmed.
510 This means that \\[ido-complete] must always be followed by \\[ido-exit-minibuffer]
511 even when there is only one unique completion."
515 (defcustom ido-cannot-complete-command
'ido-completion-help
516 "*Command run when `ido-complete' can't complete any more.
517 The most useful values are `ido-completion-help', which pops up a
518 window with completion alternatives, or `ido-next-match' or
519 `ido-prev-match', which cycle the buffer list."
524 (defcustom ido-record-commands t
525 "*Non-nil means that `ido' will record commands in command history.
526 Note that the non-ido equivalent command is recorded."
530 (defcustom ido-max-prospects
12
531 "*Non-zero means that the prospect list will be limited to than number of items.
532 For a long list of prospects, building the full list for the minibuffer can take a
533 non-negletable amount of time; setting this variable reduces that time."
537 (defcustom ido-max-file-prompt-width
0.35
538 "*Non-zero means that the prompt string be limited to than number of characters.
539 If value is a floating point number, it specifies a fraction of the frame width."
541 (integer :tag
"Characters" :value
20)
542 (restricted-sexp :tag
"Fraction of frame width"
544 :match-alternatives
(ido-fractionp)))
547 (defcustom ido-max-window-height nil
548 "*Non-nil specifies a value to override `max-mini-window-height'."
550 (const :tag
"Don't override" nil
)
551 (integer :tag
"Number of lines" :value
1)
553 :tag
"Fraction of window height"
555 :match-alternatives
(ido-fractionp)))
558 (defcustom ido-enable-last-directory-history t
559 "*Non-nil means that `ido' will remember latest selected directory names.
560 See `ido-last-directory-list' and `ido-save-directory-list-file'."
564 (defcustom ido-max-work-directory-list
50
565 "*Maximum number of working directories to record.
566 This is the list of directories where files have most recently been opened.
567 See `ido-work-directory-list' and `ido-save-directory-list-file'."
571 (defcustom ido-work-directory-list-ignore-regexps nil
572 "*List of regexps matching directories which should not be recorded.
573 Directory names matched by one of the regexps in this list are not inserted in
574 the `ido-work-directory-list' list."
575 :type
'(repeat regexp
)
579 (defcustom ido-use-filename-at-point nil
580 "*Non-nil means that ido shall look for a filename at point.
581 If found, use that as the starting point for filename selection."
586 (defcustom ido-use-url-at-point nil
587 "*Non-nil means that ido shall look for a URL at point.
588 If found, call `find-file-at-point' to visit it."
593 (defcustom ido-enable-tramp-completion t
594 "*Non-nil means that ido shall perform tramp method and server name completion.
595 A tramp file name uses the following syntax: /method:user@host:filename."
599 (defcustom ido-record-ftp-work-directories t
600 "*Non-nil means record ftp file names in the work directory list."
604 (defcustom ido-merge-ftp-work-directories nil
605 "*If nil means merging ignores ftp file names in the work directory list."
609 (defcustom ido-cache-ftp-work-directory-time
1.0
610 "*Maximum time to cache contents of an ftp directory (in hours).
611 If zero, ftp directories are not cached."
615 (defcustom ido-slow-ftp-hosts nil
616 "*List of slow ftp hosts where ido prompting should not be used.
617 If an ftp host is on this list, ido automatically switches to the non-ido
618 equivalent function, e.g. find-file rather than ido-find-file."
619 :type
'(repeat string
)
622 (defcustom ido-slow-ftp-host-regexps nil
623 "*List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
624 :type
'(repeat regexp
)
627 (defcustom ido-max-work-file-list
10
628 "*Maximum number of names of recently opened files to record.
629 This is the list the file names (sans directory) which have most recently
630 been opened. See `ido-work-file-list' and `ido-save-directory-list-file'."
634 (defcustom ido-work-directory-match-only t
635 "*Non-nil means to skip non-matching directories in the directory history.
636 When some text is already entered at the `ido-find-file' prompt, using
637 \\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories
638 without any matching entries."
642 (defcustom ido-auto-merge-work-directories-length
0
643 "*Automatically switch to merged work directories during file name input.
644 The value is number of characters to type before switching to merged mode.
645 If zero, the switch happens when no matches are found in the current directory.
646 Automatic merging is disabled if the value is negative."
650 (defcustom ido-auto-merge-delay-time
0.70
651 "*Delay in seconds to wait for more input before doing auto merge."
655 (defcustom ido-auto-merge-inhibit-characters-regexp
"[][*?~]"
656 "*Regexp matching characters which should inhibit automatic merging.
657 When a (partial) file name matches this regexp, merging is inhibited."
661 (defcustom ido-merged-indicator
"^"
662 "The string appended to first choice if it has multiple directory choices."
666 (defcustom ido-max-dir-file-cache
100
667 "*Maximum number of working directories to be cached.
668 This is the size of the cache of file-name-all-completions results.
669 Each cache entry is time stamped with the modification time of the
670 directory. Some systems, like Windows, have unreliable directory
671 modification times, so you may choose to disable caching on such
672 systems, or explicitly refresh the cache contents using the command
673 `ido-reread-directory' command (C-l) in the minibuffer.
674 See also `ido-dir-file-cache' and `ido-save-directory-list-file'."
678 (defcustom ido-max-directory-size
30000
679 "*Maximum size (in bytes) for directories to use ido completion.
680 If you enter a directory with a size larger than this size, ido will
681 not provide the normal completion. To show the completions, use C-a."
682 :type
'(choice (const :tag
"No limit" nil
)
683 (integer :tag
"Size in bytes" 30000))
686 (defcustom ido-rotate-file-list-default nil
687 "*Non-nil means that `ido' will always rotate file list to get default in front."
691 (defcustom ido-enter-single-matching-directory
'slash
692 "*Automatically enter sub-directory if it is the only matching item, if non-nil.
693 If value is 'slash, only enter if typing final slash, else do it always."
694 :type
'(choice (const :tag
"Never" nil
)
695 (const :tag
"When typing /" slash
)
696 (other :tag
"Always" t
))
699 (defcustom ido-create-new-buffer
'prompt
700 "*Specify whether a new buffer is created if no buffer matches substring.
701 Choices are 'always to create new buffers unconditionally, 'prompt to
702 ask user whether to create buffer, or 'never to never create new buffer."
703 :type
'(choice (const always
)
708 (defcustom ido-define-mode-map-hook nil
709 "*Hook to define keys in `ido-mode-map' for extra keybindings."
713 (defcustom ido-separator nil
714 "*String used by ido to separate the alternatives in the minibuffer.
715 Obsolete. Set 3rd element of `ido-decorations' instead."
716 :type
'(choice string
(const nil
))
719 (defcustom ido-decorations
'( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]" " [Not readable]" " [Too big]")
720 "*List of strings used by ido to display the alternatives in the minibuffer.
721 There are 10 elements in this list:
722 1st and 2nd elements are used as brackets around the prospect list,
723 3rd element is the separator between prospects (ignored if ido-separator is set),
724 4th element is the string inserted at the end of a truncated list of prospects,
725 5th and 6th elements are used as brackets around the common match string which
726 can be completed using TAB,
727 7th element is the string displayed when there are a no matches, and
728 8th element is displayed if there is a single match (and faces are not used).
729 9th element is displayed when the current directory is non-readable.
730 10th element is displayed when directory exceeds `ido-max-directory-size'."
731 :type
'(repeat string
)
734 (defcustom ido-use-faces t
735 "*Non-nil means use ido faces to highlighting first match, only match and
736 subdirs in the alternatives."
740 (defface ido-first-match-face
'((t (:bold t
)))
741 "*Font used by ido for highlighting first match."
744 (defface ido-only-match-face
'((((class color
))
745 (:foreground
"ForestGreen"))
747 "*Font used by ido for highlighting only match."
750 (defface ido-subdir-face
'((((class color
))
753 "*Font used by ido for highlighting subdirs in the alternatives."
756 (defface ido-indicator-face
'((((class color
))
757 (:foreground
"yellow"
760 (t (:inverse-video t
)))
761 "*Font used by ido for highlighting its indicators."
764 (defcustom ido-make-file-list-hook nil
765 "*List of functions to run when the list of matching files is created.
766 Each function on the list may modify the dynamically bound variable
767 `ido-temp-list' which contains the current list of matching files."
771 (defcustom ido-make-dir-list-hook nil
772 "*List of functions to run when the list of matching directories is created.
773 Each function on the list may modify the dynamically bound variable
774 `ido-temp-list' which contains the current list of matching directories."
778 (defcustom ido-make-buffer-list-hook nil
779 "*List of functions to run when the list of matching buffers is created.
780 Each function on the list may modify the dynamically bound variable
781 `ido-temp-list' which contains the current list of matching buffer names."
785 (defcustom ido-rewrite-file-prompt-functions nil
786 "*List of functions to run when the find-file prompt is created.
787 Each function on the list may modify the following dynamically bound
789 dirname - the (abbreviated) directory name
790 to be modified by the hook functions
791 max-width - the max width of the resulting dirname; nil means no limit
792 prompt - the basic prompt (e.g. \"Find File: \")
793 literal - the string shown if doing \"literal\" find; set to nil to omit
794 vc-off - the string shown if version control is inhibited; set to nit to omit
795 prefix - either nil or a fixed prefix for the dirname
797 The following variables are available, but should not be changed:
798 ido-current-directory - the unabbreviated directory name
799 item - equals `file' or `dir' depending on the current mode."
803 (defvar ido-rewrite-file-prompt-rules nil
804 "*Alist of rewriting rules for directory names in ido prompts.
805 A list of elements of the form (FROM . TO) or (FROM . FUNC), each
806 meaning to rewrite the directory name if matched by FROM by either
807 substituting the matched string by TO or calling the function FUNC
808 with the current directory name as its only argument and using the
809 return value as the new directory name. In addition, each FUNC may
810 also modify the dynamic variables described for the variable
811 `ido-rewrite-file-prompt-functions'.")
813 (defcustom ido-completion-buffer
"*Ido Completions*"
814 "*Name of completion buffer used by ido.
815 Set to nil to disable completion buffers popping up."
819 (defcustom ido-completion-buffer-all-completions nil
820 "*Non-nil means to show all completions in completion buffer.
821 Otherwise, only the current list of matches is shown."
825 (defvar ido-all-frames
'visible
826 "*Argument to pass to `walk-windows' when finding visible files.
827 See documentation of `walk-windows' for useful values.")
829 (defcustom ido-minibuffer-setup-hook nil
830 "*Ido-specific customization of minibuffer setup.
832 This hook is run during minibuffer setup iff `ido' will be active.
833 It is intended for use in customizing ido for interoperation
834 with other packages. For instance:
836 \(add-hook 'ido-minibuffer-setup-hook
839 \(make-local-variable 'max-mini-window-height)
840 \(setq max-mini-window-height 3))))
842 will constrain Emacs to a maximum minibuffer height of 3 lines when
843 ido is running. Copied from `icomplete-minibuffer-setup-hook'."
847 (defcustom ido-save-directory-list-file
"~/.ido.last"
848 "File in which the ido state is saved between invocations.
849 Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
850 `ido-work-file-list', and `ido-dir-file-cache'.
851 Must be set before enabling ido mode."
855 (defcustom ido-read-file-name-as-directory-commands
'()
856 "List of commands which uses read-file-name to read a directory name.
857 When `ido-everywhere' is non-nil, the commands in this list will read
858 the directory using ido-read-directory-name."
859 :type
'(repeat symbol
)
862 (defcustom ido-read-file-name-non-ido
'()
863 "List of commands which shall not read file names the ido way.
864 When `ido-everywhere' is non-nil, the commands in this list will read
865 the file name using normal read-file-name style."
866 :type
'(repeat symbol
)
869 ;;; Internal Variables
871 ;; Persistent variables
873 (defvar ido-mode-map nil
874 "Keymap for `ido-find-file' and `ido-switch-buffer'.")
876 (defvar ido-file-history nil
877 "History of files selected using `ido-find-file'.")
879 (defvar ido-buffer-history nil
880 "History of buffers selected using `ido-switch-buffer'.")
882 (defvar ido-last-directory-list nil
883 "List of last selected directory names.
884 See `ido-enable-last-directory-history' for details.")
886 (defvar ido-work-directory-list nil
887 "List of actual working directory names.
888 The current directory is inserted at the front of this list whenever a
889 file is opened with ido-find-file and family.")
891 (defvar ido-work-file-list nil
892 "List of actual work file names.
893 Opening a file with `ido-find-file' and similar functions
894 inserts the current file name (relative to its containing directory)
895 at the front of this list.")
897 (defvar ido-dir-file-cache nil
898 "List of `file-name-all-completions' results.
899 Each element in the list is of the form (DIR (MTIME) FILE...).")
901 (defvar ido-ignore-item-temp-list nil
902 "List of items to ignore in current ido invocation.
903 Intended to be let-bound by functions which calls ido repeatedly.
904 Should never be set permanently.")
908 (defvar ido-eoinput
1
909 "Point where minibuffer input ends and completion info begins.
910 Copied from `icomplete-eoinput'.")
911 (make-variable-buffer-local 'ido-eoinput
)
913 (defvar ido-common-match-string nil
914 "Stores the string that is common to all matching files.")
916 (defvar ido-rescan nil
917 "Non-nil means we need to regenerate the list of matching items.")
919 (defvar ido-rotate nil
920 "Non-nil means we are rotating list of matches.")
923 "Stores the users string as it is typed in.")
925 (defvar ido-text-init nil
926 "The initial string for the users string it is typed in.")
928 (defvar ido-matches nil
929 "List of files currently matching `ido-text'.")
931 (defvar ido-report-no-match t
932 "Report [No Match] when no completions matches ido-text.")
935 "Flag to monitor how `ido-find-file' exits.
936 If equal to `takeprompt', we use the prompt as the file name to be
939 (defvar ido-current-directory nil
940 "Current directory for ido-find-file.")
942 (defvar ido-auto-merge-timer nil
943 "Delay timer for auto merge.")
945 (defvar ido-use-mycompletion-depth
0
946 "Non-nil means use `ido' completion feedback.
947 Is set by ido functions to the current minibuffer-depth, so that
948 it doesn't interfere with other minibuffer usage.")
951 ;;; Variables with dynamic bindings.
952 ;;; Declared here to keep the byte compiler quiet.
954 ;; Stores the current ido item type ('file, 'dir, 'buffer, or 'list).
955 (defvar ido-cur-item
)
957 ;; Stores the current list of items that will be searched through.
958 ;; The list is ordered, so that the most interesting item comes first,
959 ;; although by default, the files visible in the current frame are put
960 ;; at the end of the list. Created by `ido-make-item-list'.
961 (defvar ido-cur-list
)
963 ;; Stores the choice list for ido-completing-read
964 (defvar ido-choice-list
)
966 ;; Stores the list of items which are ignored when building
967 ;; `ido-cur-list'. It is in no specific order.
968 (defvar ido-ignored-list
)
970 ;; Remember if current directory is non-readable (so we cannot do completion).
971 (defvar ido-directory-nonreadable
)
973 ;; Remember if current directory is 'huge' (so we don't want to do completion).
974 (defvar ido-directory-too-big
)
976 ;; Keep current item list if non-nil.
977 (defvar ido-keep-item-list
)
979 ;; Process ido-ignore-* lists.
980 (defvar ido-process-ignore-lists
)
982 ;; Don't process ido-ignore- lists once.
983 (defvar ido-process-ignore-lists-inhibit
)
985 ;; Buffer from which ido was entered.
986 (defvar ido-entry-buffer
)
988 ;; Non-nil if matching file must be selected.
989 (defvar ido-require-match
)
991 ;; Stores a temporary version of the file list being created.
992 (defvar ido-temp-list
)
994 ;; Non-nil if default list element should be rotated into place.
995 (defvar ido-rotate-temp
)
997 ;; Stores current index in ido-work-directory-list.
998 (defvar ido-work-directory-index
)
1000 ;; Stores current index in ido-work-file-list.
1001 (defvar ido-work-file-index
)
1003 ;; Set when merged work directory list is in use.
1004 (defvar ido-use-merged-list
)
1006 ;; Set when merged work directory list not yet built.
1007 (defvar ido-try-merged-list
)
1009 ;; Saved state prior to last work directory merge.
1010 ;; Value is a list (ido-text dir cur-list ignored-list matches).
1011 (defvar ido-pre-merge-state
)
1013 ;; Original value of vc-handled-backends for use in ido-toggle-vc.
1014 (defvar ido-saved-vc-hb
)
1016 ;; Stores temporary state of literal find file.
1017 (defvar ido-find-literal
)
1019 ;; Set to 'ignore to inhibit switching between find-file/switch-buffer.
1020 (defvar ido-context-switch-command
)
1024 (defun ido-active (&optional merge
)
1027 (and (boundp 'ido-completing-read
) (= ido-use-mycompletion-depth
(minibuffer-depth)))))
1029 (defvar ido-trace-enable nil
)
1031 (defun ido-trace (p &optional s retval
)
1032 (if ido-trace-enable
1033 (let ((b (get-buffer-create " *IDO Trace*"))
1034 (deactivate-mark deactivate-mark
))
1038 (insert p
": " (if (stringp s
) s
(format "%S" s
)) "\n")))))
1041 (defun ido-toggle-trace (arg)
1043 (setq ido-trace-enable
(or arg
(not ido-trace-enable
)))
1044 (if ido-trace-enable
1045 (message "IDO trace on"))
1046 (let ((b (get-buffer " *IDO Trace*")))
1048 (if ido-trace-enable
1050 (pop-to-buffer b t t
)
1051 (setq truncate-lines t
)))))
1053 (defun ido-is-tramp-root (&optional dir
)
1054 (setq dir
(or dir ido-current-directory
))
1055 (and ido-enable-tramp-completion
1056 (string-match "\\`/[^/][^/]+:\\([^/:@]+@\\)?\\'" dir
)))
1058 (defun ido-is-root-directory (&optional dir
)
1059 (setq dir
(or dir ido-current-directory
))
1061 (string-equal "/" dir
)
1062 (and (memq system-type
'(windows-nt ms-dos
))
1063 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir
))
1064 (if ido-enable-tramp-completion
1065 (ido-is-tramp-root dir
)
1066 (string-match "\\`/[^:/][^:/]+:\\'" dir
))))
1068 (defun ido-is-ftp-directory (&optional dir
)
1070 (if ido-enable-tramp-completion
1071 "\\`/[^/:][^/:]+:" ;; like tramp-file-name-regexp-unified, but doesn't match single drive letters
1072 "\\`/[^/:][^/:]+:/")
1073 (or dir ido-current-directory
)))
1075 (defun ido-is-slow-ftp-host (&optional dir
)
1076 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps
)
1077 (setq dir
(or dir ido-current-directory
))
1078 ;; (featurep 'ange-ftp)
1079 ;; (ange-ftp-ftp-name dir)
1081 (if ido-enable-tramp-completion
1082 "\\`/\\([^/]+[@:]\\)*\\([^@/:][^@/:]+\\):"
1083 "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/")
1085 (let ((host (substring dir
(match-beginning 2) (match-end 2))))
1086 (or (member host ido-slow-ftp-hosts
)
1087 (let ((re ido-slow-ftp-host-regexps
))
1088 (while (and re
(not (string-match (car re
) host
)))
1092 (defun ido-time-stamp (&optional time
)
1093 ;; Time is a floating point number (fractions of 1 hour)
1094 (setq time
(or time
(current-time)))
1095 (/ (+ (* (car time
) 65536.0) (car (cdr time
))) 3600.0))
1097 (defun ido-cache-ftp-valid (&optional time
)
1098 (and (numberp ido-cache-ftp-work-directory-time
)
1099 (> ido-cache-ftp-work-directory-time
0)
1101 (< (- (ido-time-stamp) time
) ido-cache-ftp-work-directory-time
))))
1103 (defun ido-may-cache-directory (&optional dir
)
1104 (setq dir
(or dir ido-current-directory
))
1106 ((ido-directory-too-big-p dir
)
1108 ((and (ido-is-root-directory dir
)
1109 (or ido-enable-tramp-completion
1110 (memq system-type
'(windows-nt ms-dos
))))
1112 ((not (ido-is-ftp-directory dir
))
1114 ((ido-cache-ftp-valid)
1117 (defun ido-pp (list &optional sep
)
1118 (let ((print-level nil
) (eval-expression-print-level nil
)
1119 (print-length nil
) (eval-expression-print-length nil
))
1120 (insert "\n;; ----- " (symbol-name list
) " -----\n(\n ")
1121 (setq list
(symbol-value list
))
1123 (let* ((elt (car list
))
1124 (s (if (consp elt
) (car elt
) elt
)))
1125 (if (and (stringp s
) (= (length s
) 0))
1128 (prin1 elt
(current-buffer)))
1129 (if (and (setq list
(cdr list
)) s
)
1130 (insert (or sep
"\n ")))))
1133 (defun ido-save-history ()
1134 "Save ido history and cache information between sessions."
1136 (if (and ido-last-directory-list ido-save-directory-list-file
)
1138 (save-window-excursion
1139 (if (find-buffer-visiting ido-save-directory-list-file
)
1140 (kill-buffer (find-buffer-visiting ido-save-directory-list-file
)))
1141 (if (file-exists-p ido-save-directory-list-file
)
1142 (delete-file ido-save-directory-list-file
))
1143 (set-buffer (let ((enable-local-variables nil
))
1144 (find-file-noselect ido-save-directory-list-file t
)))
1145 (goto-char (point-min))
1146 (delete-region (point-min) (point-max))
1147 (ido-pp 'ido-last-directory-list
)
1148 (ido-pp 'ido-work-directory-list
)
1149 (ido-pp 'ido-work-file-list
)
1150 (ido-pp 'ido-dir-file-cache
"\n\n ")
1152 (let ((version-control 'never
))
1153 (write-file ido-save-directory-list-file nil
))
1154 (kill-buffer (current-buffer))))))
1156 (defun ido-load-history (&optional arg
)
1157 "Load ido history and cache information from previous session.
1158 With prefix argument, reload history unconditionally."
1160 (if (or arg
(and ido-save-directory-list-file
(not ido-last-directory-list
)))
1161 (let ((file (expand-file-name ido-save-directory-list-file
))
1163 (when (file-readable-p file
)
1165 (save-window-excursion
1166 (setq buf
(set-buffer (let ((enable-local-variables nil
))
1167 (find-file-noselect file
))))
1168 (goto-char (point-min))
1170 (setq ido-last-directory-list
(read (current-buffer))
1171 ido-work-directory-list
(read (current-buffer))
1172 ido-work-file-list
(read (current-buffer))
1173 ido-dir-file-cache
(read (current-buffer)))
1175 (kill-buffer buf
))))
1178 (defun ido-wash-history ()
1179 "Clean-up ido history and cache information.
1180 Removes badly formatted data and ignored directories."
1182 ;; Check format of each of our lists, discard bogus elements
1183 (setq ido-last-directory-list
1184 (and (listp ido-last-directory-list
)
1185 (let ((l ido-last-directory-list
) r
)
1187 (if (and (consp (car l
))
1188 (stringp (car (car l
)))
1189 (stringp (cdr (car l
))))
1190 (setq r
(cons (car l
) r
)))
1193 (setq ido-work-directory-list
1194 (and (listp ido-work-directory-list
)
1195 (let ((l ido-work-directory-list
) r
)
1197 (if (and (stringp (car l
))
1198 (or ido-record-ftp-work-directories
1199 (not (ido-is-ftp-directory (car l
)))))
1200 (setq r
(cons (car l
) r
)))
1203 (setq ido-work-file-list
1204 (and (listp ido-work-file-list
)
1205 (let ((l ido-work-file-list
) r
)
1207 (if (stringp (car l
))
1208 (setq r
(cons (car l
) r
)))
1211 (setq ido-dir-file-cache
1212 (and (listp ido-dir-file-cache
)
1213 (let ((l ido-dir-file-cache
) r
)
1215 (if (and (listp (car l
))
1216 (> (length (car l
)) 2)
1217 (let ((dir (car (car l
)))
1218 (time (car (cdr (car l
))))
1219 (files (cdr (cdr (car l
)))))
1223 (if (integerp (car time
))
1224 (and (/= (car time
) 0)
1225 (integerp (car (cdr time
)))
1226 (/= (car (cdr time
)) 0)
1227 (ido-may-cache-directory dir
))
1228 (and (eq (car time
) 'ftp
)
1229 (numberp (cdr time
))
1230 (ido-is-ftp-directory dir
)
1231 (ido-cache-ftp-valid (cdr time
))))
1232 (let ((s files
) (ok t
))
1234 (if (stringp (car s
))
1236 (setq s nil ok nil
)))
1238 (setq r
(cons (car l
) r
)))
1242 ;; Remove ignored directories from work directory list
1243 ;; according to ido-work-directory-list-ignore-regexps
1244 (if ido-work-directory-list
1245 (let ((dirs (reverse ido-work-directory-list
)))
1246 (setq ido-work-directory-list nil
)
1248 (ido-record-work-directory (car dirs
))
1249 (setq dirs
(cdr dirs
)))))
1250 ;; Get rid of text properties
1251 (let ((l ido-last-directory-list
) e
)
1253 (setq e
(car l
) l
(cdr l
))
1254 (set-text-properties 0 (length (car e
)) nil
(car e
))
1255 (set-text-properties 0 (length (cdr e
)) nil
(cdr e
))))
1256 (let ((l ido-work-directory-list
) e
)
1258 (setq e
(car l
) l
(cdr l
))
1259 (set-text-properties 0 (length e
) nil e
)))
1260 (let ((l ido-work-file-list
) e
)
1262 (setq e
(car l
) l
(cdr l
))
1263 (set-text-properties 0 (length e
) nil e
)))
1264 (let ((l ido-dir-file-cache
) e d
)
1266 (setq e
(car l
) l
(cdr l
))
1269 (setq d
(car e
) e
(cdr e
))
1271 (set-text-properties 0 (length d
) nil d
))))))
1275 (defun ido-kill-emacs-hook ()
1276 ;; ido kill emacs hook
1279 (defvar ido-minor-mode-map-entry nil
)
1282 (defun ido-mode (&optional arg
)
1283 "Toggle ido speed-ups on or off.
1284 With ARG, turn ido speed-up on if arg is positive, off otherwise.
1285 Turning on ido-mode will remap (via a minor-mode keymap) the default
1286 keybindings for the `find-file' and `switch-to-buffer' families of
1287 commands to the ido versions of these functions.
1288 However, if ARG arg equals 'files, remap only commands for files, or
1289 if it equals 'buffers, remap only commands for buffer switching.
1290 This function also adds a hook to the minibuffer."
1294 ((null arg
) (if ido-mode nil
'both
))
1296 ((eq arg
'files
) 'file
)
1297 ((eq arg
'buffers
) 'buffer
)
1298 ((memq arg
'(file buffer both
)) arg
)
1299 ((> (prefix-numeric-value arg
) 0) 'both
)
1302 (ido-everywhere (if ido-everywhere
1 -
1))
1305 (add-hook 'minibuffer-setup-hook
'ido-minibuffer-setup
)
1306 (add-hook 'choose-completion-string-functions
'ido-choose-completion-string
)
1309 (add-hook 'kill-emacs-hook
'ido-kill-emacs-hook
)
1311 (unless ido-minor-mode-map-entry
1312 (setq ido-minor-mode-map-entry
(cons 'ido-mode
(make-sparse-keymap)))
1313 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry
))
1315 (let ((map (cdr ido-minor-mode-map-entry
)))
1316 (when (memq ido-mode
'(file both
))
1317 (define-key map
[remap find-file
] 'ido-find-file
)
1318 (define-key map
[remap find-file-read-only
] 'ido-find-file-read-only
)
1319 (define-key map
[remap find-alternate-file
] 'ido-find-alternate-file
)
1320 (define-key map
[remap write-file
] 'ido-write-file
)
1321 (define-key map
[remap insert-file
] 'ido-insert-file
)
1322 (define-key map
[remap list-directory
] 'ido-list-directory
)
1323 (define-key map
[remap dired
] 'ido-dired
)
1324 (define-key map
[remap find-file-other-window
] 'ido-find-file-other-window
)
1325 (define-key map
[remap find-file-read-only-other-window
] 'ido-find-file-read-only-other-window
)
1326 (define-key map
[remap find-file-other-frame
] 'ido-find-file-other-frame
)
1327 (define-key map
[remap find-file-read-only-other-frame
] 'ido-find-file-read-only-other-frame
))
1329 (when (memq ido-mode
'(buffer both
))
1330 (define-key map
[remap switch-to-buffer
] 'ido-switch-buffer
)
1331 (define-key map
[remap switch-to-buffer-other-window
] 'ido-switch-buffer-other-window
)
1332 (define-key map
[remap switch-to-buffer-other-frame
] 'ido-switch-buffer-other-frame
)
1333 (define-key map
[remap insert-buffer
] 'ido-insert-buffer
)
1334 (define-key map
[remap kill-buffer
] 'ido-kill-buffer
)
1335 (define-key map
[remap display-buffer
] 'ido-display-buffer
)))))
1337 (defun ido-everywhere (arg)
1338 "Enable ido everywhere file and directory names are read."
1340 (setq ido-everywhere
(if arg
1341 (> (prefix-numeric-value arg
) 0)
1342 (not ido-everywhere
)))
1343 (setq read-file-name-function
1344 (and ido-everywhere
(memq ido-mode
'(both file
))
1345 'ido-read-file-name
))
1346 (setq read-buffer-function
1347 (and ido-everywhere
(memq ido-mode
'(both buffer
))
1352 (defun ido-define-mode-map ()
1353 "Set up the keymap for `ido'."
1355 ;; generated every time so that it can inherit new functions.
1357 (setq map
(copy-keymap minibuffer-local-map
))
1358 (define-key map
"\C-a" 'ido-toggle-ignore
)
1359 (define-key map
"\C-c" 'ido-toggle-case
)
1360 (define-key map
"\C-e" 'ido-edit-input
)
1361 (define-key map
"\t" 'ido-complete
)
1362 (define-key map
" " 'ido-complete-space
)
1363 (define-key map
"\C-j" 'ido-select-text
)
1364 (define-key map
"\C-m" 'ido-exit-minibuffer
)
1365 (define-key map
"\C-p" 'ido-toggle-prefix
)
1366 (define-key map
"\C-r" 'ido-prev-match
)
1367 (define-key map
"\C-s" 'ido-next-match
)
1368 (define-key map
"\C-t" 'ido-toggle-regexp
)
1369 (define-key map
"\C-z" 'ido-undo-merge-work-directory
)
1370 (define-key map
[(control ?
)] 'ido-restrict-to-matches
)
1371 (define-key map
[(control ?
@)] 'ido-restrict-to-matches
)
1372 (define-key map
[right] 'ido-next-match)
1373 (define-key map [left] 'ido-prev-match)
1374 (define-key map "?" 'ido-completion-help)
1376 (when (memq ido-cur-item '(file dir))
1377 (define-key map "\C-b" (or ido-context-switch-command 'ido-enter-switch-buffer))
1378 (define-key map "\C-d" (or (and ido-context-switch-command 'ignore) 'ido-enter-dired))
1379 (define-key map "\C-f" 'ido-fallback-command)
1380 (define-key map [down] 'ido-next-match-dir)
1381 (define-key map [up] 'ido-prev-match-dir)
1382 (define-key map [(meta up)] 'ido-prev-work-directory)
1383 (define-key map [(meta down)] 'ido-next-work-directory)
1384 (define-key map [backspace] 'ido-delete-backward-updir)
1385 (define-key map "\d" 'ido-delete-backward-updir)
1386 (define-key map [(meta backspace)] 'ido-delete-backward-word-updir)
1387 (define-key map [(control backspace)] 'ido-up-directory)
1388 (define-key map "\C-l" 'ido-reread-directory)
1389 (define-key map [(meta ?b)] 'ido-next-work-file)
1390 (define-key map [(meta ?d)] 'ido-wide-find-dir)
1391 (define-key map [(meta ?f)] 'ido-wide-find-file)
1392 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1393 (define-key map [(meta ?m)] 'ido-make-directory)
1394 (define-key map [(meta ?n)] 'ido-next-work-directory)
1395 (define-key map [(meta ?o)] 'ido-prev-work-file)
1396 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1397 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1400 (when (eq ido-cur-item 'file)
1401 (define-key map "\C-k" 'ido-delete-file-at-head)
1402 (define-key map "\C-o" 'ido-copy-current-word)
1403 (define-key map "\C-w" 'ido-copy-current-file-name)
1404 (define-key map [(meta ?l)] 'ido-toggle-literal)
1405 (define-key map "\C-v" 'ido-toggle-vc)
1408 (when (eq ido-cur-item 'buffer)
1409 (define-key map "\C-f" (or ido-context-switch-command 'ido-enter-find-file))
1410 (define-key map "\C-b" 'ido-fallback-command)
1411 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1414 (when (if (boundp 'viper-mode) viper-mode)
1415 (define-key map [remap viper-intercept-ESC-key] 'ignore)
1416 (when (memq ido-cur-item '(file dir))
1417 (define-key map [remap viper-backward-char] 'ido-delete-backward-updir)
1418 (define-key map [remap viper-del-backward-char-in-insert] 'ido-delete-backward-updir)
1419 (define-key map [remap viper-delete-backward-word] 'ido-delete-backward-word-updir)))
1421 (setq ido-mode-map map)
1422 (run-hooks 'ido-define-mode-map-hook)))
1424 (defun ido-final-slash (dir &optional fix-it)
1425 ;; return DIR if DIR has final slash.
1426 ;; else if FIX-IT is non-nil, return DIR/
1428 (setq dir (ido-name dir))
1430 ((string-match "/\\'" dir) dir)
1431 ((ido-is-tramp-root dir) dir)
1432 (fix-it (concat dir "/"))
1435 (defun ido-no-final-slash (s)
1436 ;; Remove optional final slash from string S
1437 (let ((l (1- (length s))))
1438 (if (and (> l 0) (eq (aref s l) ?/))
1442 (defun ido-nonreadable-directory-p (dir)
1443 ;; Return t if dir is a directory, but not readable
1444 ;; Do not check for non-readable directories via tramp, as this causes a premature
1445 ;; connect on incomplete tramp paths (after entring just method:).
1446 (let ((ido-enable-tramp-completion nil))
1447 (and (ido-final-slash dir)
1448 (file-directory-p dir)
1449 (not (file-readable-p dir)))))
1451 (defun ido-directory-too-big-p (dir)
1452 ;; Return t if dir is a directory, but too big to show
1453 ;; Do not check for non-readable directories via tramp, as this causes a premature
1454 ;; connect on incomplete tramp paths (after entring just method:).
1455 (let ((ido-enable-tramp-completion nil))
1456 (and (numberp ido-max-directory-size)
1457 (ido-final-slash dir)
1458 (file-directory-p dir)
1459 (> (nth 7 (file-attributes dir)) ido-max-directory-size))))
1461 (defun ido-set-current-directory (dir &optional subdir no-merge)
1462 ;; Set ido's current directory to DIR or DIR/SUBDIR
1463 (setq dir (ido-final-slash dir t))
1464 (setq ido-use-merged-list nil
1465 ido-try-merged-list (not no-merge))
1467 (setq dir (ido-final-slash (concat dir subdir) t)))
1468 (if (equal dir ido-current-directory)
1470 (ido-trace "cd" dir)
1471 (setq ido-current-directory dir)
1472 (if (get-buffer ido-completion-buffer)
1473 (kill-buffer ido-completion-buffer))
1474 (setq ido-directory-nonreadable (ido-nonreadable-directory-p dir))
1475 (setq ido-directory-too-big (and (not ido-directory-nonreadable)
1476 (ido-directory-too-big-p dir)))
1479 (defun ido-set-current-home (&optional dir)
1480 ;; Set ido's current directory to user's home directory
1481 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1483 (defun ido-record-command (command arg)
1484 ;; Add (command arg) to command-history if ido-record-commands is t
1485 (if ido-record-commands
1486 (let ((cmd (list command arg)))
1487 (if (or (not command-history)
1488 (not (equal cmd (car command-history))))
1489 (setq command-history (cons cmd command-history))))))
1491 (defun ido-make-prompt (item prompt)
1492 ;; Make the prompt for ido-read-internal
1494 ((and (memq item '(file dir)) ido-current-directory)
1495 (let ((dirname (abbreviate-file-name ido-current-directory))
1496 (max-width (if (and ido-max-file-prompt-width (floatp ido-max-file-prompt-width))
1497 (floor (* (frame-width) ido-max-file-prompt-width))
1498 ido-max-file-prompt-width))
1499 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1500 (vc-off (and ido-saved-vc-hb (not vc-handled-backends) "[-VC] "))
1502 (rule ido-rewrite-file-prompt-rules))
1503 (let ((case-fold-search nil))
1505 (if (and (consp (car rule))
1506 (string-match (car (car rule)) dirname))
1508 (if (stringp (cdr (car rule)))
1509 (replace-match (cdr (car rule)) t nil dirname)
1510 (funcall (cdr (car rule)) dirname))))
1511 (setq rule (cdr rule))))
1512 (run-hooks 'ido-rewrite-file-prompt-functions)
1514 ; (if ido-process-ignore-lists "" "&")
1518 (let ((l (length dirname)))
1519 (if (and max-width (> max-width 0) (> l max-width))
1520 (let* ((s (substring dirname (- max-width)))
1521 (i (string-match "/" s)))
1522 (concat "..." (if i (substring s i) s)))
1526 ;; Here is very briefly how ido-find-file works:
1529 ;; (ido-file-internal method)
1530 ;; set ido-current-directory
1531 ;; (ido-read-internal 'file ...)
1533 ;; (ido-make-item-list ...)
1534 ;; (ido-set-matches)
1535 ;; (completing-read ... ido-text-init ...)
1537 ;; ... here user is allowed to type characters and commands
1538 ;; a command may set ido-exit and call (exit-minibuffer)
1539 ;; to make ido-read-internal do advanced tasks (or return)
1541 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1542 ;; which are run before and after each user command.
1544 ;; return value from completing-read is stored in ido-final-text
1545 ;; - ido-exit may cause further actions to be taken:
1546 ;; 'refresh - repeat loop (make-item-list, set-matches)
1547 ;; 'edit - edit the prompt string, then repeat loop
1548 ;; 'keep - repeat loop but don't (re)make-item-list
1549 ;; 'updir - go up one directory, repeat loop
1550 ;; else set ido-selected based on ido-final-text,
1551 ;; optionally update ido-current-directory and repeat loop, or
1552 ;; exit with the return value of ido-selected (file name)
1553 ;; selected file name is returned from ido-read-internal,
1554 ;; ido-exit and method determines what action is taken
1555 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1556 ;; the relevant function is called (find-file, write-file, etc).
1558 (defun ido-read-internal (item prompt history &optional default require-match initial)
1559 "Perform the ido-read-buffer and ido-read-file-name functions.
1560 Return the name of a buffer or file selected.
1561 PROMPT is the prompt to give to the user.
1562 DEFAULT if given is the default directory to start with.
1563 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1564 If INITIAL is non-nil, it specifies the initial input string."
1566 ((ido-cur-item item)
1567 (ido-entry-buffer (current-buffer))
1568 (ido-process-ignore-lists t)
1569 (ido-process-ignore-lists-inhibit nil)
1570 (ido-set-default-item t)
1575 (icomplete-mode nil) ;; prevent icomplete starting up
1576 ;; Exported dynamic variables:
1579 (ido-rotate-temp nil)
1580 (ido-keep-item-list nil)
1581 (ido-use-merged-list nil)
1582 (ido-try-merged-list t)
1583 (ido-pre-merge-state nil)
1584 (ido-case-fold ido-case-fold)
1585 (ido-enable-prefix ido-enable-prefix)
1586 (ido-enable-regexp ido-enable-regexp)
1589 (ido-define-mode-map)
1590 (setq ido-text-init initial)
1592 (ido-trace "\n_LOOP_" ido-text-init)
1595 (setq ido-rotate nil)
1597 (when ido-set-default-item
1598 (setq ido-default-item
1601 (if (bufferp default) (buffer-name default) default))
1602 ((stringp default) default)
1604 (and ido-enable-last-directory-history
1605 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1606 (and d (cdr d)))))))
1607 (if (member ido-default-item ido-ignore-item-temp-list)
1608 (setq ido-default-item nil))
1609 (setq ido-set-default-item nil))
1611 (if ido-process-ignore-lists-inhibit
1612 (setq ido-process-ignore-lists nil))
1614 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1615 (let ((olist ido-cur-list)
1616 (oign ido-ignored-list)
1618 (l (ido-make-merged-file-list ido-text-init
1619 (eq ido-use-merged-list 'auto)
1620 (eq ido-try-merged-list 'wide))))
1623 (if (eq ido-try-merged-list 'wide)
1624 (setq ido-pre-merge-state
1625 (list "" ido-current-directory olist oign omat)
1627 ido-ignored-list nil
1629 ido-keep-item-list t
1630 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1631 ido-use-merged-list nil)
1632 (setq ido-cur-list olist
1633 ido-ignored-list oign
1635 ido-keep-item-list t
1636 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1637 ido-use-merged-list nil)))
1639 (setq ido-use-merged-list nil))
1641 (setq ido-pre-merge-state
1642 (list ido-text-init ido-current-directory olist oign omat))
1643 (ido-set-current-directory (car (cdr (car l))))
1644 (if (ido-final-slash ido-text-init)
1645 (setq ido-text-init ""))
1646 (setq ido-cur-list l
1647 ido-ignored-list nil
1650 ido-keep-item-list t
1651 ido-use-merged-list t)
1652 (ido-trace "Merged" t)
1657 (setq ido-keep-item-list nil
1659 ((eq ido-cur-item 'file)
1660 (setq ido-ignored-list nil
1661 ido-cur-list (and (not ido-directory-nonreadable)
1662 (not ido-directory-too-big)
1663 (ido-make-file-list ido-default-item))))
1664 ((eq ido-cur-item 'dir)
1665 (setq ido-ignored-list nil
1666 ido-cur-list (and (not ido-directory-nonreadable)
1667 (not ido-directory-too-big)
1668 (ido-make-dir-list ido-default-item))))
1669 ((eq ido-cur-item 'buffer)
1670 (setq ido-ignored-list nil
1671 ido-cur-list (ido-make-buffer-list ido-default-item)))
1672 ((eq ido-cur-item 'list)
1673 (setq ido-ignored-list nil
1674 ido-cur-list (ido-make-choice-list ido-default-item)))
1676 (setq ido-rotate-temp nil)
1678 (if ido-process-ignore-lists-inhibit
1679 (setq ido-process-ignore-lists t
1680 ido-process-ignore-lists-inhibit nil))
1683 (if (and ido-matches (eq ido-try-merged-list 'auto))
1684 (setq ido-try-merged-list t))
1686 ((minibuffer-local-completion-map ido-mode-map)
1687 (max-mini-window-height (or ido-max-window-height
1688 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1689 (ido-completing-read t)
1690 (ido-require-match require-match)
1691 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1692 (show-paren-mode nil))
1693 ;; prompt the user for the file name
1695 (setq ido-final-text
1698 (ido-make-prompt item prompt)
1699 '(("dummy" . 1)) nil nil ; table predicate require-match
1700 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1702 (ido-trace "completing-read" ido-final-text)
1703 (if (get-buffer ido-completion-buffer)
1704 (kill-buffer ido-completion-buffer))
1706 (ido-trace "\n_EXIT_" ido-exit)
1709 ((eq ido-exit 'refresh)
1710 (if (and (eq ido-use-merged-list 'auto)
1711 (or (input-pending-p)))
1712 (setq ido-use-merged-list nil
1713 ido-keep-item-list t))
1716 ((eq ido-exit 'done)
1718 ido-selected ido-text
1721 ((memq ido-exit '(edit chdir))
1723 ((memq ido-cur-item '(file dir))
1724 (let* ((read-file-name-function nil)
1725 (edit (eq ido-exit 'edit))
1726 (d ido-current-directory)
1729 (setq ido-text-init "")
1732 (read-file-name (concat prompt "[EDIT] ")
1733 (expand-file-name d)
1736 d (or (file-name-directory new) "/")
1737 f (file-name-nondirectory new)
1740 (file-directory-p d)
1741 (and (yes-or-no-p (format "Create directory %s? " d))
1743 (progn (make-directory d t) t)
1745 (message "Could not create directory")
1749 (ido-set-current-directory d nil (eq ido-exit 'chdir))
1750 (setq ido-text-init f
1753 (setq ido-text-init (read-string (concat prompt "[EDIT] ") ido-final-text))))
1756 ((eq ido-exit 'keep)
1757 (setq ido-keep-item-list t))
1759 ((memq ido-exit '(dired fallback find-file switch-to-buffer insert-buffer insert-file))
1762 ((eq ido-exit 'updir)
1763 ;; cannot go up if already at the root-dir (Unix) or at the
1764 ;; root-dir of a certain drive (Windows or MS-DOS).
1765 (if (ido-is-tramp-root)
1766 (when (string-match "\\`\\(/\\([^/]+[:@]\\)*\\)\\([^/]+\\)[:@]\\'" ido-current-directory)
1767 (setq ido-text-init (match-string 3 ido-current-directory))
1768 (ido-set-current-directory (match-string 1 ido-current-directory))
1769 (setq ido-set-default-item t))
1770 (unless (ido-is-root-directory)
1771 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1)))
1772 (setq ido-set-default-item t))))
1774 ;; Handling the require-match must be done in a better way.
1776 (not (if ido-directory-too-big
1777 (file-exists-p (concat ido-current-directory ido-final-text))
1778 (ido-existing-item-p))))
1779 (error "must specify valid item"))
1783 (if (or (eq ido-exit 'takeprompt)
1786 ;; else take head of list
1787 (ido-name (car ido-matches))))
1793 ((string-equal "./" ido-selected)
1796 ((string-equal "../" ido-selected)
1797 ;; cannot go up if already at the root-dir (Unix) or at the
1798 ;; root-dir of a certain drive (Windows or MS-DOS).
1799 (or (ido-is-root-directory)
1800 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1801 (setq ido-set-default-item t))
1803 ((and (string-match (if ido-enable-tramp-completion "..[:@]\\'" "..:\\'") ido-selected)
1804 (ido-is-root-directory)) ;; Ange-ftp or Tramp
1805 (ido-set-current-directory ido-current-directory ido-selected)
1806 (ido-trace "tramp prefix" ido-selected)
1807 (if (ido-is-slow-ftp-host)
1808 (setq ido-exit 'fallback
1810 (setq ido-set-default-item t)))
1811 ((or (string-match "[/\\][^/\\]" ido-selected)
1812 (and (memq system-type '(windows-nt ms-dos))
1813 (string-match "\\`.:" ido-selected)))
1814 (ido-set-current-directory (file-name-directory ido-selected))
1815 (setq ido-set-default-item t))
1817 ((string-match "\\`~" ido-selected)
1818 (ido-set-current-home ido-selected))
1820 ((ido-final-slash ido-selected)
1821 (if ido-enable-last-directory-history
1822 (let ((x (assoc ido-current-directory ido-last-directory-list)))
1824 (setcdr x ido-selected)
1825 (setq ido-last-directory-list
1826 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
1827 (ido-set-current-directory ido-current-directory ido-selected)
1828 (setq ido-set-default-item t))
1834 (defun ido-edit-input ()
1835 "Edit absolute file name entered so far with ido; terminate by RET."
1837 (setq ido-text-init ido-text)
1838 (setq ido-exit 'edit)
1842 (defun ido-buffer-internal (method &optional fallback prompt default initial switch-cmd)
1843 ;; Internal function for ido-switch-buffer and friends
1845 (call-interactively (or fallback 'switch-to-buffer))
1846 (let* ((ido-context-switch-command switch-cmd)
1847 (ido-current-directory nil)
1848 (ido-directory-nonreadable nil)
1849 (ido-directory-too-big nil)
1850 (buf (ido-read-internal 'buffer (or prompt "Buffer: ") 'ido-buffer-history default nil initial)))
1852 ;; Choose the buffer name: either the text typed in, or the head
1853 ;; of the list of matches
1856 ((eq ido-exit 'find-file)
1857 (ido-file-internal ido-default-file-method nil nil nil nil ido-text))
1859 ((eq ido-exit 'insert-file)
1860 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil ido-text 'ido-enter-insert-buffer))
1862 ((eq ido-exit 'fallback)
1863 (let ((read-buffer-function nil))
1864 (call-interactively (or fallback 'switch-to-buffer))))
1866 ;; Check buf is non-nil.
1868 ((= (length buf) 0) nil)
1870 ;; View buffer if it exists
1872 (if (eq method 'insert)
1874 (ido-record-command 'insert-buffer buf)
1875 (insert-buffer buf))
1876 (ido-visit-buffer buf method t)))
1878 ;; buffer doesn't exist
1879 ((eq ido-create-new-buffer 'never)
1880 (message "no buffer matching `%s'" buf))
1882 ((and (eq ido-create-new-buffer 'prompt)
1883 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
1886 ;; create a new buffer
1888 (setq buf (get-buffer-create buf))
1889 (if (fboundp 'set-buffer-major-mode)
1890 (set-buffer-major-mode buf))
1891 (ido-visit-buffer buf method t))))))
1893 (defun ido-record-work-directory (&optional dir)
1894 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
1895 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
1896 (let ((items ido-work-directory-list-ignore-regexps)
1897 (case-fold-search nil))
1898 (while (and items dir)
1899 (if (string-match (car items) dir)
1901 (setq items (cdr items)))
1903 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
1904 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
1905 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
1907 (defun ido-forget-work-directory ()
1909 (when (and ido-current-directory ido-work-directory-list)
1910 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
1911 (when ido-use-merged-list
1912 (ido-undo-merge-work-directory)
1913 (setq ido-exit 'refresh
1914 ido-try-merged-list t
1915 ido-use-merged-list t
1916 ido-text-init ido-text
1918 (exit-minibuffer))))
1920 (defun ido-record-work-file (name)
1921 ;; Save NAME in ido-work-file-list
1922 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
1924 (and ido-work-file-list (equal (car ido-work-file-list) name))
1925 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
1926 (if (> (length ido-work-file-list) ido-max-work-file-list)
1927 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
1929 (defun ido-expand-directory (dir)
1930 ;; Expand DIR or use DEFAULT-DIRECTORY if nil.
1931 ;; Add final slash to result in case it was missing from DEFAULT-DIRECTORY.
1932 (ido-final-slash (expand-file-name (or dir default-directory)) t))
1934 (defun ido-file-internal (method &optional fallback default prompt item initial switch-cmd)
1935 ;; Internal function for ido-find-file and friends
1938 (let* ((ido-current-directory (ido-expand-directory default))
1939 (ido-directory-nonreadable (ido-nonreadable-directory-p ido-current-directory))
1940 (ido-directory-too-big (and (not ido-directory-nonreadable)
1941 (ido-directory-too-big-p ido-current-directory)))
1942 (ido-context-switch-command switch-cmd)
1946 ((or (not ido-mode) (ido-is-slow-ftp-host))
1948 ido-exit 'fallback))
1950 ((and (eq item 'file)
1951 (or ido-use-url-at-point ido-use-filename-at-point))
1954 ;; Duplicate code from ffap-guesser as we want different behaviour for files and URLs.
1956 ((and ido-use-url-at-point
1958 (ffap-fixup-url (or (ffap-url-at-point)
1959 (ffap-gopher-at-point))))
1960 (setq ido-exit 'ffap
1963 ((and ido-use-filename-at-point
1964 (setq fn (ffap-string-at-point))
1965 (not (string-match "^http:/" fn))
1966 (setq d (file-name-directory fn))
1967 (file-directory-p d))
1968 (setq ido-current-directory d)
1969 (setq initial (file-name-nondirectory fn)))))))
1971 (let (ido-saved-vc-hb
1972 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
1973 (ido-work-directory-index -1)
1974 (ido-work-file-index -1)
1975 (ido-find-literal nil))
1978 (setq ido-saved-vc-hb vc-handled-backends)
1979 (setq filename (ido-read-internal item
1980 (or prompt "Find file: ")
1981 'ido-file-history nil nil initial)))
1983 ;; Choose the file name: either the text typed in, or the head
1984 ;; of the list of matches
1987 ((eq ido-exit 'fallback)
1988 ;; Need to guard setting of default-directory here, since
1989 ;; we don't want to change directory of current buffer.
1990 (let ((default-directory ido-current-directory)
1991 (read-file-name-function nil))
1992 (call-interactively (or fallback 'find-file))))
1994 ((eq ido-exit 'switch-to-buffer)
1995 (ido-buffer-internal ido-default-buffer-method nil nil nil ido-text))
1997 ((eq ido-exit 'insert-buffer)
1998 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil ido-text 'ido-enter-insert-file))
2000 ((eq ido-exit 'dired)
2001 (dired (concat ido-current-directory (or ido-text ""))))
2003 ((eq ido-exit 'ffap)
2004 (find-file-at-point))
2006 ((eq method 'alt-file)
2007 (ido-record-work-file filename)
2008 (setq default-directory ido-current-directory)
2009 (ido-record-work-directory)
2010 (find-alternate-file filename))
2012 ((memq method '(dired list-directory))
2013 (if (equal filename ".")
2015 (let* ((dirname (ido-final-slash (concat ido-current-directory filename) t))
2016 (file (substring dirname 0 -1)))
2018 ((file-directory-p dirname)
2019 (ido-record-command method dirname)
2020 (ido-record-work-directory dirname)
2021 (funcall method dirname))
2022 ((file-directory-p ido-current-directory)
2024 ((file-exists-p file)
2025 (ido-record-command method ido-current-directory)
2026 (ido-record-work-directory)
2027 (funcall method ido-current-directory)
2028 (if (eq method 'dired)
2029 (dired-goto-file (expand-file-name file))))
2030 ((string-match "[[*?]" filename)
2031 (setq dirname (concat ido-current-directory filename))
2032 (ido-record-command method dirname)
2033 (ido-record-work-directory)
2034 (funcall method dirname))
2035 ((y-or-n-p (format "Directory %s does not exist. Create it " filename))
2036 (ido-record-command method dirname)
2037 (ido-record-work-directory dirname)
2038 (make-directory-internal dirname)
2039 (funcall method dirname))
2041 ;; put make-directory command on history
2042 (ido-record-command 'make-directory dirname))))
2043 (t (error "No such directory")))))
2046 (ido-record-work-file filename)
2047 (setq default-directory ido-current-directory)
2048 (ido-record-command 'write-file (concat ido-current-directory filename))
2049 (ido-record-work-directory)
2050 (write-file filename))
2052 ((eq method 'read-only)
2053 (ido-record-work-file filename)
2054 (setq filename (concat ido-current-directory filename))
2055 (ido-record-command fallback filename)
2056 (ido-record-work-directory)
2057 (funcall fallback filename))
2059 ((eq method 'insert)
2060 (ido-record-work-file filename)
2061 (setq filename (concat ido-current-directory filename))
2063 (if ido-find-literal 'insert-file-literally 'insert-file)
2065 (ido-record-work-directory)
2066 (if ido-find-literal
2067 (insert-file-contents-literally filename)
2068 (insert-file-contents filename)))
2071 (ido-record-work-file filename)
2072 (setq filename (concat ido-current-directory filename))
2073 (ido-record-command 'find-file filename)
2074 (ido-record-work-directory)
2075 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
2077 (defun ido-existing-item-p ()
2078 ;; Return non-nil if there is a matching item
2079 (not (null ido-matches)))
2083 (defun ido-set-common-completion ()
2084 ;; Find common completion of `ido-text' in `ido-matches'
2085 ;; The result is stored in `ido-common-match-string'
2087 (setq ido-common-match-string nil)
2088 (if (and ido-matches
2089 (not ido-enable-regexp) ;; testing
2091 (> (length ido-text) 0))
2092 (if (setq val (ido-find-common-substring ido-matches ido-text))
2093 (setq ido-common-match-string val)))
2096 (defun ido-complete ()
2097 "Try and complete the current pattern amongst the file names."
2101 ((and (memq ido-cur-item '(file dir))
2102 (string-match "[$]" ido-text))
2103 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
2104 (if (not (file-exists-p (file-name-directory evar)))
2105 (message "Expansion generates non-existing directory name")
2106 (if (file-directory-p evar)
2107 (ido-set-current-directory evar)
2108 (let ((d (or (file-name-directory evar) "/"))
2109 (f (file-name-nondirectory evar)))
2110 (when (file-directory-p d)
2111 (ido-set-current-directory d)
2112 (setq ido-text-init f))))
2113 (setq ido-exit 'refresh)
2114 (exit-minibuffer))))
2116 (ido-directory-too-big
2117 (setq ido-directory-too-big nil)
2118 (setq ido-text-init ido-text)
2119 (setq ido-exit 'refresh)
2123 (when ido-completion-buffer
2124 (call-interactively (setq this-command ido-cannot-complete-command))))
2126 ((and (= 1 (length ido-matches))
2127 (not (and ido-enable-tramp-completion
2128 (string-equal ido-current-directory "/")
2129 (string-match "..[@:]\\'" (car ido-matches)))))
2130 ;; only one choice, so select it.
2131 (if (not ido-confirm-unique-completion)
2133 (setq ido-rescan (not ido-enable-prefix))
2134 (delete-region (minibuffer-prompt-end) (point))
2135 (insert (car ido-matches))))
2137 (t ;; else there could be some completions
2138 (setq res ido-common-match-string)
2139 (if (and (not (memq res '(t nil)))
2140 (not (equal res ido-text)))
2141 ;; found something to complete, so put it in the minibuffer.
2143 ;; move exact match to front if not in prefix mode
2144 (setq ido-rescan (not ido-enable-prefix))
2145 (delete-region (minibuffer-prompt-end) (point))
2147 ;; else nothing to complete
2148 (call-interactively (setq this-command ido-cannot-complete-command))
2151 (defun ido-complete-space ()
2152 "Try completion unless inserting the space makes sense."
2154 (if (and (stringp ido-common-match-string)
2157 ((> (length ido-common-match-string) (length ido-text))
2158 (= (aref ido-common-match-string (length ido-text)) ? ))
2161 (re (concat (regexp-quote ido-text) " "))
2164 (if (string-match re (ido-name (car comp)))
2165 (setq comp nil insert-space t)
2166 (setq comp (cdr comp))))
2172 (defun ido-undo-merge-work-directory (&optional text try refresh)
2173 "Undo or redo last ido directory merge operation.
2174 If no merge has yet taken place, toggle automatic merging option."
2177 (ido-pre-merge-state
2178 (ido-set-current-directory (nth 1 ido-pre-merge-state))
2179 (setq ido-text-init (or text (car ido-pre-merge-state))
2180 ido-cur-list (nth 2 ido-pre-merge-state)
2181 ido-ignored-list (nth 3 ido-pre-merge-state)
2182 ido-matches (nth 4 ido-pre-merge-state)
2183 ido-use-merged-list nil
2184 ido-try-merged-list try
2185 ido-keep-item-list (not refresh)
2188 ido-pre-merge-state nil)
2192 (ido-try-merged-list
2193 (setq ido-try-merged-list nil))
2195 (setq ido-try-merged-list t))
2196 ((not ido-use-merged-list)
2197 (ido-merge-work-directories))))
2199 ;;; TOGGLE FUNCTIONS
2201 (defun ido-toggle-case ()
2202 "Toggle the value of `ido-case-fold'."
2204 (setq ido-case-fold (not ido-case-fold))
2205 ;; ask for list to be regenerated.
2206 (setq ido-rescan t))
2208 (defun ido-toggle-regexp ()
2209 "Toggle the value of `ido-enable-regexp'."
2211 (setq ido-enable-regexp (not ido-enable-regexp))
2212 ;; ask for list to be regenerated.
2213 (setq ido-rescan t))
2215 (defun ido-toggle-prefix ()
2216 "Toggle the value of `ido-enable-prefix'."
2218 (setq ido-enable-prefix (not ido-enable-prefix))
2219 ;; ask for list to be regenerated.
2220 (setq ido-rescan t))
2222 (defun ido-toggle-ignore ()
2223 "Toggle ignoring files specified with `ido-ignore-files'."
2225 (if ido-directory-too-big
2226 (setq ido-directory-too-big nil)
2227 (setq ido-process-ignore-lists (not ido-process-ignore-lists)))
2228 (setq ido-text-init ido-text)
2229 (setq ido-exit 'refresh)
2232 (defun ido-toggle-vc ()
2233 "Disable version control for this file."
2235 (if (and ido-mode (eq ido-cur-item 'file))
2237 (setq vc-handled-backends
2238 (if vc-handled-backends nil ido-saved-vc-hb))
2239 (setq ido-text-init ido-text)
2240 (setq ido-exit 'keep)
2241 (exit-minibuffer))))
2243 (defun ido-toggle-literal ()
2244 "Toggle literal reading of this file."
2246 (if (and ido-mode (eq ido-cur-item 'file))
2248 (setq ido-find-literal (not ido-find-literal))
2249 (setq ido-text-init ido-text)
2250 (setq ido-exit 'keep)
2251 (exit-minibuffer))))
2253 (defun ido-reread-directory ()
2254 "Read current directory again.
2255 May be useful if cached version is no longer valid, but directory
2256 timestamp has not changed (e.g. with ftp or on Windows)."
2258 (if (and ido-mode (eq ido-cur-item 'file))
2260 (ido-remove-cached-dir ido-current-directory)
2261 (setq ido-text-init ido-text)
2262 (setq ido-rotate-temp t)
2263 (setq ido-exit 'refresh)
2264 (exit-minibuffer))))
2266 (defun ido-exit-minibuffer ()
2267 "Exit minibuffer, but make sure we have a match if one is needed."
2269 (if (or (not ido-require-match)
2270 (ido-existing-item-p))
2273 (defun ido-select-text ()
2274 "Select the buffer or file named by the prompt.
2275 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2277 (setq ido-exit 'takeprompt)
2280 (defun ido-fallback-command ()
2281 "Fallback to non-ido version of current command."
2283 (let ((i (length ido-text)))
2285 (push (aref ido-text (setq i (1- i))) unread-command-events)))
2286 (setq ido-exit 'fallback)
2289 (defun ido-enter-find-file ()
2290 "Drop into find-file from buffer switching."
2292 (setq ido-exit 'find-file)
2295 (defun ido-enter-switch-buffer ()
2296 "Drop into ido-switch-buffer from file switching."
2298 (setq ido-exit 'switch-to-buffer)
2301 (defun ido-enter-dired ()
2302 "Drop into dired from file switching."
2304 (setq ido-exit 'dired)
2307 (defun ido-enter-insert-buffer ()
2308 "Drop into insert buffer from insert file."
2310 (setq ido-exit 'insert-buffer)
2313 (defun ido-enter-insert-file ()
2314 "Drop into insert file from insert buffer."
2316 (setq ido-exit 'insert-file)
2320 (defun ido-up-directory (&optional clear)
2321 "Go up one directory level."
2323 (setq ido-text-init (if clear nil ido-text))
2324 (setq ido-exit 'updir)
2325 (setq ido-rotate-temp t)
2328 (defun ido-delete-backward-updir (count)
2329 "Delete char backwards, or at beginning of buffer, go up one level."
2332 ((= (minibuffer-prompt-end) (point))
2334 (ido-up-directory t)))
2335 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2336 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2337 ((eq this-original-command 'viper-backward-char)
2338 (funcall this-original-command (prefix-numeric-value count)))
2339 ((eq this-original-command 'viper-del-backward-char-in-insert)
2340 (funcall this-original-command))
2342 (delete-backward-char (prefix-numeric-value count)))))
2344 (defun ido-delete-backward-word-updir (count)
2345 "Delete all chars backwards, or at beginning of buffer, go up one level."
2347 (if (= (minibuffer-prompt-end) (point))
2349 (ido-up-directory t))
2350 (if (eq this-original-command 'viper-delete-backward-word)
2351 (funcall this-original-command (prefix-numeric-value count))
2352 (backward-kill-word (prefix-numeric-value count)))))
2354 (defun ido-get-work-directory (&optional incr must-match)
2355 (let ((n (length ido-work-directory-list))
2356 (i ido-work-directory-index)
2359 (if (or (not ido-text) (= (length ido-text) 0))
2360 (setq must-match nil))
2365 (if (>= i n) (setq i 0))
2366 (if (< i 0) (setq i (1- n))))
2367 (setq dir (nth i ido-work-directory-list))
2369 (not (equal dir ido-current-directory))
2370 (file-directory-p dir)
2371 (or (not must-match)
2372 ;; TODO. check for nonreadable and too-big.
2374 (if (eq ido-cur-item 'file)
2375 (ido-make-file-list1 dir)
2376 (ido-make-dir-list1 dir)))))
2380 (setq ido-work-directory-index i))
2383 (defun ido-prev-work-directory ()
2384 "Change to next working directory in list."
2386 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2388 (ido-set-current-directory dir)
2389 (setq ido-exit 'refresh)
2390 (setq ido-text-init ido-text)
2391 (setq ido-rotate-temp t)
2392 (exit-minibuffer))))
2394 (defun ido-next-work-directory ()
2395 "Change to previous working directory in list."
2397 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2399 (ido-set-current-directory dir)
2400 (setq ido-exit 'refresh)
2401 (setq ido-text-init ido-text)
2402 (setq ido-rotate-temp t)
2403 (exit-minibuffer))))
2405 (defun ido-merge-work-directories ()
2406 "Search (and merge) work directories for files matching the current input string."
2408 (setq ido-use-merged-list t ido-try-merged-list t)
2409 (setq ido-exit 'refresh)
2410 (setq ido-text-init ido-text)
2411 (setq ido-rotate-temp t)
2414 (defun ido-wide-find-file (&optional file)
2415 "Prompt for FILE to search for using find, starting from current directory."
2418 (let ((enable-recursive-minibuffers t))
2420 (read-string (concat "Wide find file: " ido-current-directory) ido-text))))
2421 (when (> (length file) 0)
2422 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2423 (setq ido-exit 'refresh)
2424 (setq ido-text-init file)
2425 (setq ido-rotate-temp t)
2428 (defun ido-wide-find-dir (&optional dir)
2429 "Prompt for DIR to search for using find, starting from current directory."
2432 (let ((enable-recursive-minibuffers t))
2434 (read-string (concat "Wide find directory: " ido-current-directory) ido-text))))
2435 (when (> (length dir) 0)
2436 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2437 (setq ido-exit 'refresh)
2438 (setq ido-text-init (ido-final-slash dir t))
2439 (setq ido-rotate-temp t)
2442 (defun ido-make-directory (&optional dir)
2443 "Prompt for DIR to create in current directory."
2446 (let ((enable-recursive-minibuffers t))
2448 (read-string (concat "Make directory: " ido-current-directory) ido-text))))
2449 (when (> (length dir) 0)
2450 (setq dir (concat ido-current-directory dir))
2451 (unless (file-exists-p dir)
2452 (make-directory dir t)
2453 (ido-set-current-directory dir)
2454 (setq ido-exit 'refresh)
2455 (setq ido-text-init nil)
2456 (setq ido-rotate-temp t)
2457 (exit-minibuffer))))
2459 (defun ido-get-work-file (incr)
2460 (let ((n (length ido-work-file-list))
2461 (i (+ ido-work-file-index incr))
2464 (if (>= i n) (setq i 0))
2465 (if (< i 0) (setq i (1- n))))
2466 (setq name (nth i ido-work-file-list))
2467 (setq ido-work-file-index i)
2470 (defun ido-prev-work-file ()
2471 "Change to next working file name in list."
2473 (let ((name (ido-get-work-file 1)))
2475 (setq ido-text-init name)
2476 (setq ido-exit 'refresh)
2477 (exit-minibuffer))))
2479 (defun ido-next-work-file ()
2480 "Change to previous working file name in list."
2482 (let ((name (ido-get-work-file -1)))
2484 (setq ido-text-init name)
2485 (setq ido-exit 'refresh)
2486 (exit-minibuffer))))
2488 (defun ido-copy-current-file-name (all)
2489 "Insert file name of current buffer.
2490 If repeated, insert text from buffer instead."
2492 (let* ((bfname (buffer-file-name ido-entry-buffer))
2493 (name (and bfname (file-name-nondirectory bfname))))
2497 (not (equal (file-name-directory bfname) ido-current-directory))
2498 (not (string-match "\\.[^.]*\\'" name)))
2500 (substring name 0 (1+ (match-beginning 0)))))
2501 (setq ido-exit 'refresh
2502 ido-try-merged-list nil)
2503 (exit-minibuffer))))
2505 (defun ido-copy-current-word (all)
2506 "Insert current word (file or directory name) from current buffer."
2508 (let ((word (save-excursion
2509 (set-buffer ido-entry-buffer)
2510 (let ((p (point)) start-line end-line start-name name)
2512 (setq start-line (point))
2514 (setq end-line (point))
2516 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
2518 (setq start-name (point))
2519 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
2520 (if (= start-name (point))
2522 (buffer-substring-no-properties start-name (point)))))))
2525 ((string-match "\\`[~/]" word)
2526 (setq ido-text-init word
2527 ido-try-merged-list nil
2529 ((string-match "/" word)
2530 (setq ido-text-init (concat ido-current-directory word)
2531 ido-try-merged-list nil
2534 (setq ido-text-init word
2535 ido-try-merged-list nil
2536 ido-exit 'refresh)))
2537 (exit-minibuffer))))
2539 (defun ido-next-match ()
2540 "Put first element of `ido-matches' at the end of the list."
2543 (let ((next (cadr ido-matches)))
2544 (setq ido-cur-list (ido-chop ido-cur-list next))
2546 (setq ido-rotate t))))
2548 (defun ido-prev-match ()
2549 "Put last element of `ido-matches' at the front of the list."
2552 (let ((prev (car (last ido-matches))))
2553 (setq ido-cur-list (ido-chop ido-cur-list prev))
2555 (setq ido-rotate t))))
2557 (defun ido-next-match-dir ()
2558 "Find next directory in match list.
2559 If work directories have been merged, cycle through directories for
2560 first matching file."
2562 (if ido-use-merged-list
2564 (let* ((elt (car ido-matches))
2566 (when (> (length dirs) 1)
2567 (setcdr elt (ido-chop dirs (cadr dirs))))
2568 (setq ido-rescan nil)))
2569 (let ((cnt (length ido-matches))
2571 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
2574 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2576 (defun ido-prev-match-dir ()
2577 "Find previous directory in match list.
2578 If work directories have been merged, cycle through directories
2579 for first matching file."
2581 (if ido-use-merged-list
2583 (let* ((elt (car ido-matches))
2585 (when (> (length dirs) 1)
2586 (setcdr elt (ido-chop dirs (car (last dirs)))))
2587 (setq ido-rescan nil)))
2588 (let* ((cnt (length ido-matches))
2590 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
2593 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2595 (defun ido-restrict-to-matches ()
2596 "Set current item list to the currently matched items."
2599 (setq ido-cur-list ido-matches
2605 (defun ido-chop (items elem)
2606 "Remove all elements before ELEM and put them at the end of ITEMS."
2611 (setq next (car items))
2612 (if (equal next elem)
2613 (setq ret (append items (nreverse sofar)))
2616 (setq items (cdr items))
2617 (setq sofar (cons next sofar)))))
2620 (defun ido-name (item)
2621 ;; Return file name for current item, whether in a normal list
2622 ;; or a merged work directory list.
2623 (if (consp item) (car item) item))
2626 ;;; CREATE LIST OF ALL CURRENT FILES
2628 (defun ido-all-completions ()
2629 ;; Return unsorted list of all competions.
2630 (let ((ido-process-ignore-lists nil)
2631 (ido-directory-too-big nil))
2633 ((eq ido-cur-item 'file)
2634 (ido-make-file-list1 ido-current-directory))
2635 ((eq ido-cur-item 'dir)
2636 (ido-make-dir-list1 ido-current-directory))
2637 ((eq ido-cur-item 'buffer)
2638 (ido-make-buffer-list1))
2639 ((eq ido-cur-item 'list)
2644 ;; File list sorting
2646 (defun ido-file-lessp (a b)
2647 ;; Simple compare two file names.
2648 (string-lessp (ido-no-final-slash a) (ido-no-final-slash b)))
2651 (defun ido-file-extension-lessp (a b)
2652 ;; Compare file names according to ido-file-extensions-order list.
2653 (let ((n (compare-strings a 0 nil b 0 nil nil))
2666 (ido-file-extension-aux a b n lessp))
2668 (while (and (> n 2) (/= (aref a n) ?.))
2671 (ido-file-extension-aux a b n lessp)
2674 (defun ido-file-extension-aux (a b n lessp)
2675 (let ((oa (ido-file-extension-order a n))
2676 (ob (ido-file-extension-order b n)))
2691 (defun ido-file-extension-order (s n)
2692 (let ((l ido-file-extensions-order)
2699 ((eq (compare-strings s n nil (car l) 0 nil nil) t)
2708 (defun ido-sort-merged-list (items promote)
2709 ;; Input is list of ("file" . "dir") cons cells.
2710 ;; Output is sorted list of ("file "dir" ...) lists
2711 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
2716 (if (and res (string-equal (car (car res)) (car a)))
2718 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
2719 (if (and promote (string-equal ido-current-directory (cdr a)))
2721 (setq res (cons (list (car a) (cdr a)) res)
2725 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
2726 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
2729 (shell-command-to-string
2730 (concat "find " dir " -name \"" (if prefix "" "*") file "*\" -type " (if finddir "d" "f") " -print"))))
2734 (setq filename (car filenames)
2735 filenames (cdr filenames))
2736 (if (and (string-match "^/" filename)
2737 (file-exists-p filename))
2738 (setq d (file-name-directory filename)
2739 f (file-name-nondirectory filename)
2740 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
2743 (defun ido-flatten-merged-list (items)
2744 ;; Create a list of directory names based on a merged directory list.
2747 (let* ((item (car items))
2751 (setq res (cons (concat (car dirs) file) res)
2753 (setq items (cdr items)))
2756 (defun ido-make-merged-file-list (text auto wide)
2758 (message "Searching for `%s'...." text)
2759 (if (and (ido-final-slash text) ido-dir-file-cache)
2761 (setq res (ido-wide-find-dirs-or-files
2762 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
2763 ;; Use list of cached directories
2764 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
2765 (dirs ido-dir-file-cache)
2769 (setq dir (car (car dirs))
2771 (when (and (string-match re dir)
2772 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
2773 (file-directory-p dir))
2774 (setq b (substring dir 0 -1)
2775 f (concat (file-name-nondirectory b) "/")
2776 d (file-name-directory b)
2777 res (cons (cons f d) res))))
2779 (setq dir (car dirs)
2782 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
2783 (setq dir (cdr (cdr dir)))
2787 (if (and (string-match re f)
2788 (not (ido-ignore-item-p f ido-ignore-directories)))
2789 (setq res (cons (cons f d) res)))))
2790 (if (and auto (input-pending-p))
2794 (setq res (ido-wide-find-dirs-or-files
2795 ido-current-directory text ido-enable-prefix nil))
2796 (let ((ido-text text)
2797 (dirs ido-work-directory-list)
2798 (must-match (and text (> (length text) 0)))
2800 (if (and auto (not (member ido-current-directory dirs)))
2801 (setq dirs (cons ido-current-directory dirs)))
2803 (setq dir (car dirs)
2805 (when (and dir (stringp dir)
2806 (or ido-merge-ftp-work-directories
2807 (not (ido-is-ftp-directory dir)))
2808 (file-directory-p dir)
2809 ;; TODO. check for nonreadable and too-big.
2810 (setq fl (if (eq ido-cur-item 'file)
2811 (ido-make-file-list1 dir t)
2812 (ido-make-dir-list1 dir t))))
2814 (setq fl (ido-set-matches1 fl)))
2816 (setq res (nconc fl res))))
2817 (if (and auto (input-pending-p))
2820 (if (and res (not (eq res t)))
2821 (setq res (ido-sort-merged-list res auto)))
2822 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
2824 (> (length text) 0))
2825 (let ((elt (assoc text res)))
2826 (when (and elt (not (eq elt (car res))))
2827 (setq res (delq elt res))
2828 (setq res (cons elt res)))))
2832 (defun ido-make-buffer-list1 (&optional frame visible)
2833 ;; Return list of non-ignored buffer names
2837 (let ((name (buffer-name x)))
2838 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
2840 (buffer-list frame))))
2842 (defun ido-make-buffer-list (default)
2843 ;; Return the current list of buffers.
2844 ;; Currently visible buffers are put at the end of the list.
2845 ;; The hook `ido-make-buflist-hook' is run after the list has been
2846 ;; created to allow the user to further modify the order of the buffer names
2847 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
2848 ;; it is put to the start of the list.
2849 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
2850 (ido-temp-list (ido-make-buffer-list1 (selected-frame) ido-current-buffers)))
2852 (nconc ido-temp-list ido-current-buffers)
2853 (setq ido-temp-list ido-current-buffers))
2857 (delete default ido-temp-list))
2859 (cons default ido-temp-list))))
2860 (run-hooks 'ido-make-buffer-list-hook)
2863 (defun ido-make-choice-list (default)
2864 ;; Return the current list of choices.
2865 ;; If DEFAULT is non-nil, and corresponds to an element of choices,
2866 ;; it is put to the start of the list.
2867 (let ((ido-temp-list ido-choice-list))
2871 (delete default ido-temp-list))
2873 (cons default ido-temp-list))))
2874 ; (run-hooks 'ido-make-choice-list-hook)
2877 (defun ido-to-end (items)
2878 ;; Move the elements from ITEMS to the end of `ido-temp-list'
2881 (setq ido-temp-list (delq elem ido-temp-list)))
2884 (nconc ido-temp-list items)
2885 (setq ido-temp-list items)))
2887 (defun ido-file-name-all-completions1 (dir)
2889 ((ido-nonreadable-directory-p dir) '())
2890 ;; do not check (ido-directory-too-big-p dir) here.
2891 ;; Caller must have done that if necessary.
2892 ((and ido-enable-tramp-completion
2893 (string-match "\\`/\\([^/:]+:\\([^/:@]+@\\)?\\)\\'" dir))
2895 ;; Trick tramp's file-name-all-completions handler to DTRT, as it
2896 ;; has some pretty obscure requirements. This seems to work...
2897 ;; /ftp: => (f-n-a-c "/ftp:" "")
2898 ;; /ftp:kfs: => (f-n-a-c "" "/ftp:kfs:")
2899 ;; /ftp:kfs@ => (f-n-a-c "ftp:kfs@" "/")
2900 ;; /ftp:kfs@kfs: => (f-n-a-c "" "/ftp:kfs@kfs:")
2901 ;; Currently no attempt is made to handle multi: stuff.
2903 (let* ((prefix (match-string 1 dir))
2904 (user-flag (match-beginning 2))
2905 (len (and prefix (length prefix)))
2908 (setq dir (substring dir 1)))
2909 (require 'tramp nil t)
2910 (ido-trace "tramp complete" dir)
2911 (setq compl (file-name-all-completions dir (if user-flag "/" "")))
2913 (mapcar (lambda (c) (substring c len)) compl)
2916 (file-name-all-completions "" dir))))
2918 (defun ido-file-name-all-completions (dir)
2919 ;; Return name of all files in DIR
2920 ;; Uses and updates ido-dir-file-cache
2921 (if (and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
2922 (stringp dir) (> (length dir) 0)
2923 (ido-may-cache-directory dir))
2924 (let* ((cached (assoc dir ido-dir-file-cache))
2925 (ctime (nth 1 cached))
2926 (ftp (ido-is-ftp-directory dir))
2927 (attr (if ftp nil (file-attributes dir)))
2928 (mtime (nth 5 attr))
2930 (when cached ; should we use the cached entry ?
2932 (setq valid (and (eq (car ctime) 'ftp)
2933 (ido-cache-ftp-valid (cdr ctime))))
2935 (setq valid (and (= (car ctime) (car mtime))
2936 (= (car (cdr ctime)) (car (cdr mtime)))))))
2938 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
2941 (if (and ftp (file-readable-p dir))
2942 (setq mtime (cons 'ftp (ido-time-stamp))))
2944 (setq cached (cons dir (cons mtime (ido-file-name-all-completions1 dir)))
2945 ido-dir-file-cache (cons cached ido-dir-file-cache)))
2946 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
2947 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
2949 (cdr (cdr cached))))
2950 (ido-file-name-all-completions1 dir)))
2952 (defun ido-remove-cached-dir (dir)
2953 ;; Remove dir from ido-dir-file-cache
2954 (if (and ido-dir-file-cache
2955 (stringp dir) (> (length dir) 0))
2956 (let ((cached (assoc dir ido-dir-file-cache)))
2958 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
2961 (defun ido-make-file-list1 (dir &optional merged)
2962 ;; Return list of non-ignored files in DIR
2963 ;; If MERGED is non-nil, each file is cons'ed with DIR
2964 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
2968 (if (not (ido-ignore-item-p name ido-ignore-files t))
2969 (if merged (cons name dir) name)))
2970 (ido-file-name-all-completions dir)))))
2972 (defun ido-make-file-list (default)
2973 ;; Return the current list of files.
2974 ;; Currently visible files are put at the end of the list.
2975 ;; The hook `ido-make-file-list-hook' is run after the list has been
2976 ;; created to allow the user to further modify the order of the file names
2978 (let ((ido-temp-list (ido-make-file-list1 ido-current-directory)))
2979 (setq ido-temp-list (sort ido-temp-list
2980 (if ido-file-extensions-order
2981 #'ido-file-extension-lessp
2983 (let ((default-directory ido-current-directory))
2984 (ido-to-end ;; move ftp hosts and visited files to end
2986 (lambda (x) (if (or (string-match "..:\\'" x)
2987 (and (not (ido-final-slash x))
2988 (get-file-buffer x))) x))
2990 (ido-to-end ;; move . files to end
2992 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2994 (if (and default (member default ido-temp-list))
2995 (if (or ido-rotate-temp ido-rotate-file-list-default)
2996 (unless (equal default (car ido-temp-list))
2997 (let ((l ido-temp-list) k)
2998 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3002 (nconc k ido-temp-list)
3003 (setq ido-temp-list k)))
3005 (delete default ido-temp-list))
3007 (cons default ido-temp-list))))
3008 (when ido-show-dot-for-dired
3009 (setq ido-temp-list (delete "." ido-temp-list))
3010 (setq ido-temp-list (cons "." ido-temp-list)))
3011 (run-hooks 'ido-make-file-list-hook)
3014 (defun ido-make-dir-list1 (dir &optional merged)
3015 ;; Return list of non-ignored subdirs in DIR
3016 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
3017 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
3021 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
3022 (if merged (cons name dir) name)))
3023 (ido-file-name-all-completions dir)))))
3025 (defun ido-make-dir-list (default)
3026 ;; Return the current list of directories.
3027 ;; The hook `ido-make-dir-list-hook' is run after the list has been
3028 ;; created to allow the user to further modify the order of the
3029 ;; directory names in this list.
3030 (let ((ido-temp-list (ido-make-dir-list1 ido-current-directory)))
3031 (setq ido-temp-list (sort ido-temp-list #'ido-file-lessp))
3032 (ido-to-end ;; move . files to end
3034 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3036 (if (and default (member default ido-temp-list))
3037 (if (or ido-rotate-temp ido-rotate-file-list-default)
3038 (unless (equal default (car ido-temp-list))
3039 (let ((l ido-temp-list) k)
3040 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3044 (nconc k ido-temp-list)
3045 (setq ido-temp-list k)))
3047 (delete default ido-temp-list))
3049 (cons default ido-temp-list))))
3050 (setq ido-temp-list (delete "." ido-temp-list))
3051 (setq ido-temp-list (cons "." ido-temp-list))
3052 (run-hooks 'ido-make-dir-list-hook)
3055 ;; List of the files visible in the current frame.
3056 (defvar ido-bufs-in-frame)
3058 (defun ido-get-buffers-in-frames (&optional current)
3059 ;; Return the list of buffers that are visible in the current frame.
3060 ;; If optional argument `current' is given, restrict searching to the
3061 ;; current frame, rather than all frames, regardless of value of
3062 ;; `ido-all-frames'.
3063 (let ((ido-bufs-in-frame nil))
3064 (walk-windows 'ido-get-bufname nil
3070 (defun ido-get-bufname (win)
3071 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
3072 (let ((buf (buffer-name (window-buffer win))))
3073 (unless (or (member buf ido-bufs-in-frame)
3074 (member buf ido-ignore-item-temp-list))
3075 ;; Only add buf if it is not already in list.
3076 ;; This prevents same buf in two different windows being
3077 ;; put into the list twice.
3078 (setq ido-bufs-in-frame
3079 (cons buf ido-bufs-in-frame)))))
3081 ;;; FIND MATCHING ITEMS
3083 (defun ido-set-matches1 (items &optional do-full)
3084 ;; Return list of matches in items
3085 (let* ((case-fold-search ido-case-fold)
3086 (slash (and (not ido-enable-prefix) (ido-final-slash ido-text)))
3087 (text (if slash (substring ido-text 0 -1) ido-text))
3088 (rexq (concat (if ido-enable-regexp text (regexp-quote text)) (if slash ".*/" "")))
3089 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
3090 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" re))
3091 (concat "\\`" re "\\'")))
3092 (prefix-re (and full-re (not ido-enable-prefix)
3093 (concat "\\`" rexq)))
3094 (non-prefix-dot (or (not ido-enable-dot-prefix)
3095 (not ido-process-ignore-lists)
3097 (= (length ido-text) 0)))
3104 (let ((name (ido-name item)))
3105 (if (and (or non-prefix-dot
3106 (if (= (aref ido-text 0) ?.)
3107 (= (aref name 0) ?.)
3108 (/= (aref name 0) ?.)))
3109 (string-match re name))
3111 ((and full-re (string-match full-re name))
3112 (setq full-matches (cons item full-matches)))
3113 ((and prefix-re (string-match prefix-re name))
3114 (setq prefix-matches (cons item prefix-matches)))
3115 (t (setq matches (cons item matches))))))
3119 (setq matches (nconc prefix-matches matches)))
3121 (setq matches (nconc full-matches matches)))
3122 (when (and (null matches)
3123 ido-enable-flex-matching
3124 (> (length ido-text) 1)
3125 (not ido-enable-regexp))
3126 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
3127 (if ido-enable-prefix
3128 (setq re (concat "\\`" re)))
3131 (let ((name (ido-name item)))
3132 (if (string-match re name)
3133 (setq matches (cons item matches)))))
3138 (defun ido-set-matches ()
3139 ;; Set `ido-matches' to the list of items matching prompt
3141 (setq ido-matches (ido-set-matches1 (reverse ido-cur-list) (not ido-rotate))
3144 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
3145 ;; Return t if the buffer or file NAME should be ignored.
3146 (or (member name ido-ignore-item-temp-list)
3148 ido-process-ignore-lists re-list
3149 (let ((data (match-data))
3150 (ext-list (and ignore-ext ido-ignore-extensions
3151 completion-ignored-extensions))
3153 (flen (length name)) slen)
3155 (setq nextstr (car ext-list))
3158 (and (>= flen (setq slen (length nextstr)))
3159 (string-equal (substring name (- flen slen)) nextstr)))
3160 ((fboundp nextstr) (funcall nextstr name))
3165 (setq ext-list (cdr ext-list))))
3167 (setq nextstr (car re-list))
3169 ((stringp nextstr) (string-match nextstr name))
3170 ((fboundp nextstr) (funcall nextstr name))
3174 (setq re-list (cdr re-list))))
3175 ;; return the result
3177 (setq ido-ignored-list (cons name ido-ignored-list)))
3178 (set-match-data data)
3182 ;; Private variable used by `ido-word-matching-substring'.
3183 (defvar ido-change-word-sub)
3185 (defun ido-find-common-substring (items subs)
3186 ;; Return common string following SUBS in each element of ITEMS.
3189 ido-change-word-sub)
3190 (setq ido-change-word-sub
3191 (if ido-enable-regexp
3193 (regexp-quote subs)))
3194 (setq res (mapcar #'ido-word-matching-substring items))
3195 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
3196 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
3198 ;; try-completion returns t if there is an exact match.
3199 (let* ((completion-ignore-case ido-case-fold)
3200 (comp (try-completion subs alist)))
3205 (defun ido-word-matching-substring (word)
3206 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
3207 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
3208 (let ((case-fold-search ido-case-fold))
3209 (let ((m (string-match ido-change-word-sub (ido-name word))))
3211 (substring (ido-name word) m)
3215 (defun ido-makealist (res)
3216 ;; Return dotted pair (RES . 1).
3219 (defun ido-choose-completion-string (choice buffer mini-p base-size)
3221 ;; Insert the completion into the buffer where completion was requested.
3222 (if (get-buffer ido-completion-buffer)
3223 (kill-buffer ido-completion-buffer))
3225 ((ido-active t) ;; ido-use-merged-list
3226 (setq ido-current-directory ""
3229 ((not (ido-final-slash choice))
3230 (setq ido-text choice
3233 (ido-set-current-directory ido-current-directory choice)
3234 (setq ido-exit 'refresh)))
3238 (defun ido-completion-help ()
3239 "Show possible completions in a *File Completions* buffer."
3241 (setq ido-rescan nil)
3242 (let ((temp-buf (get-buffer ido-completion-buffer))
3243 display-it full-list)
3244 (if (and (eq last-command this-command) temp-buf)
3246 (let (win (buf (current-buffer)))
3247 (display-buffer temp-buf nil nil)
3248 (set-buffer temp-buf)
3249 (setq win (get-buffer-window temp-buf))
3250 (if (pos-visible-in-window-p (point-max) win)
3251 (if (or ido-completion-buffer-all-completions (boundp 'ido-completion-buffer-full))
3252 (set-window-start win (point-min))
3253 (set (make-local-variable 'ido-completion-buffer-full) t)
3256 (scroll-other-window))
3258 (setq display-it t))
3260 (with-output-to-temp-buffer ido-completion-buffer
3261 (let ((completion-list (sort
3263 (ido-use-merged-list
3264 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
3265 ((or full-list ido-completion-buffer-all-completions)
3266 (ido-all-completions))
3268 (copy-sequence (or ido-matches ido-cur-list))))
3270 (if (featurep 'xemacs)
3271 ;; XEmacs extents are put on by default, doesn't seem to be
3272 ;; any way of switching them off.
3273 ;; This obscure code avoids a byte compiler warning in Emacs.
3274 (let ((f 'display-completion-list))
3275 (funcall f completion-list
3278 '(lambda (x y z) (message "doesn't work yet, sorry!"))))
3279 ;; else running Emacs
3280 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
3281 (display-completion-list completion-list)))))))
3283 ;;; KILL CURRENT BUFFER
3284 (defun ido-kill-buffer-at-head ()
3285 "Kill the buffer at the head of `ido-matches'."
3287 (let ((enable-recursive-minibuffers t)
3288 (buf (car ido-matches)))
3291 ;; Check if buffer still exists.
3292 (if (get-buffer buf)
3293 ;; buffer couldn't be killed.
3295 ;; else buffer was killed so remove name from list.
3296 (setq ido-cur-list (delq buf ido-cur-list))))))
3298 ;;; DELETE CURRENT FILE
3299 (defun ido-delete-file-at-head ()
3300 "Delete the file at the head of `ido-matches'."
3302 (let ((enable-recursive-minibuffers t)
3303 (file (car ido-matches)))
3305 (setq file (concat ido-current-directory file)))
3307 (file-exists-p file)
3308 (not (file-directory-p file))
3309 (file-writable-p ido-current-directory)
3310 (yes-or-no-p (concat "Delete " file " ")))
3312 ;; Check if file still exists.
3313 (if (file-exists-p file)
3314 ;; file could not be deleted
3316 ;; else file was killed so remove name from list.
3317 (setq ido-cur-list (delq (car ido-matches) ido-cur-list))))))
3320 ;;; VISIT CHOSEN BUFFER
3321 (defun ido-visit-buffer (buffer method &optional record)
3322 "Visit file named FILE according to METHOD.
3323 Record command in command-history if optional RECORD is non-nil."
3329 (ido-record-command 'kill-buffer buffer))
3330 (kill-buffer buffer))
3332 ((eq method 'samewindow)
3334 (ido-record-command 'switch-to-buffer buffer))
3335 (switch-to-buffer buffer))
3337 ((memq method '(always-frame maybe-frame))
3340 (setq win (ido-window-buffer-p buffer))
3341 (or (eq method 'always-frame)
3342 (y-or-n-p "Jump to frame? ")))
3343 (setq newframe (window-frame win))
3344 (if (fboundp 'select-frame-set-input-focus)
3345 (select-frame-set-input-focus newframe)
3346 (raise-frame newframe)
3347 (select-frame newframe)
3348 (unless (featurep 'xemacs)
3349 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
3350 (select-window win))
3352 ;; No buffer in other frames...
3354 (ido-record-command 'switch-to-buffer buffer))
3355 (switch-to-buffer buffer)
3358 ((eq method 'otherwindow)
3360 (ido-record-command 'switch-to-buffer buffer))
3361 (switch-to-buffer-other-window buffer))
3363 ((eq method 'display)
3364 (display-buffer buffer))
3366 ((eq method 'otherframe)
3367 (switch-to-buffer-other-frame buffer)
3368 (unless (featurep 'xemacs)
3369 (select-frame-set-input-focus (selected-frame)))
3373 (defun ido-window-buffer-p (buffer)
3374 ;; Return window pointer if BUFFER is visible in another frame.
3375 ;; If BUFFER is visible in the current frame, return nil.
3376 (let ((blist (ido-get-buffers-in-frames 'current)))
3377 ;;If the buffer is visible in current frame, return nil
3378 (if (member buffer blist)
3380 ;; maybe in other frame or icon
3381 (get-buffer-window buffer 0) ; better than 'visible
3385 ;;; ----------- IDONIZED FUNCTIONS ------------
3388 (defun ido-switch-buffer ()
3389 "Switch to another buffer.
3390 The buffer is displayed according to `ido-default-buffer-method' -- the
3391 default is to show it in the same window, unless it is already visible
3394 As you type in a string, all of the buffers matching the string are
3395 displayed if substring-matching is used \(default). Look at
3396 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
3397 buffer you want, it can then be selected. As you type, most keys have their
3398 normal keybindings, except for the following: \\<ido-mode-map>
3400 RET Select the buffer at the front of the list of matches. If the
3401 list is empty, possibly prompt to create new buffer.
3403 \\[ido-select-text] Select the current prompt as the buffer.
3404 If no buffer is found, prompt for a new one.
3406 \\[ido-next-match] Put the first element at the end of the list.
3407 \\[ido-prev-match] Put the last element at the start of the list.
3408 \\[ido-complete] Complete a common suffix to the current string that
3409 matches all buffers. If there is only one match, select that buffer.
3410 If there is no common suffix, show a list of all matching buffers
3411 in a separate window.
3412 \\[ido-edit-input] Edit input string.
3413 \\[ido-fallback-command] Fallback to non-ido version of current command.
3414 \\[ido-toggle-regexp] Toggle regexp searching.
3415 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3416 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
3417 \\[ido-completion-help] Show list of matching buffers in separate window.
3418 \\[ido-enter-find-file] Drop into ido-find-file.
3419 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
3420 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
3422 (ido-buffer-internal ido-default-buffer-method))
3425 (defun ido-switch-buffer-other-window ()
3426 "Switch to another buffer and show it in another window.
3427 The buffer name is selected interactively by typing a substring.
3428 For details of keybindings, do `\\[describe-function] ido'."
3430 (ido-buffer-internal 'otherwindow 'switch-to-buffer-other-window))
3433 (defun ido-display-buffer ()
3434 "Display a buffer in another window but don't select it.
3435 The buffer name is selected interactively by typing a substring.
3436 For details of keybindings, do `\\[describe-function] ido'."
3438 (ido-buffer-internal 'display 'display-buffer nil nil nil 'ignore))
3441 (defun ido-kill-buffer ()
3443 The buffer name is selected interactively by typing a substring.
3444 For details of keybindings, do `\\[describe-function] ido'."
3446 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer)) nil 'ignore))
3449 (defun ido-insert-buffer ()
3450 "Insert contents of a buffer in current buffer after point.
3451 The buffer name is selected interactively by typing a substring.
3452 For details of keybindings, do `\\[describe-function] ido'."
3454 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil nil 'ido-enter-insert-file))
3457 (defun ido-switch-buffer-other-frame ()
3458 "Switch to another buffer and show it in another frame.
3459 The buffer name is selected interactively by typing a substring.
3460 For details of keybindings, do `\\[describe-function] ido'."
3463 (ido-buffer-internal 'otherframe)
3464 (call-interactively 'switch-to-buffer-other-frame)))
3467 (defun ido-find-file-in-dir (dir)
3468 "Switch to another file starting from DIR."
3469 (interactive "DDir: ")
3470 (if (not (equal (substring dir -1) "/"))
3471 (setq dir (concat dir "/")))
3472 (ido-file-internal ido-default-file-method nil dir nil nil nil 'ignore))
3475 (defun ido-find-file ()
3476 "Edit file with name obtained via minibuffer.
3477 The file is displayed according to `ido-default-file-method' -- the
3478 default is to show it in the same window, unless it is already
3479 visible in another frame.
3481 The file name is selected interactively by typing a substring. As you type
3482 in a string, all of the filenames matching the string are displayed if
3483 substring-matching is used \(default). Look at `ido-enable-prefix' and
3484 `ido-toggle-prefix'. When you have found the filename you want, it can
3485 then be selected. As you type, most keys have their normal keybindings,
3486 except for the following: \\<ido-mode-map>
3488 RET Select the file at the front of the list of matches. If the
3489 list is empty, possibly prompt to create new file.
3491 \\[ido-select-text] Select the current prompt as the buffer or file.
3492 If no buffer or file is found, prompt for a new one.
3494 \\[ido-next-match] Put the first element at the end of the list.
3495 \\[ido-prev-match] Put the last element at the start of the list.
3496 \\[ido-complete] Complete a common suffix to the current string that
3497 matches all files. If there is only one match, select that file.
3498 If there is no common suffix, show a list of all matching files
3499 in a separate window.
3500 \\[ido-edit-input] Edit input string (including directory).
3501 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
3502 \\[ido-merge-work-directories] search for file in the work directory history.
3503 \\[ido-forget-work-directory] removes current directory from the work directory history.
3504 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
3505 \\[ido-wide-find-file] and \\[ido-wide-find-dir] prompts and uses find to locate files or directories.
3506 \\[ido-make-directory] prompts for a directory to create in current directory.
3507 \\[ido-fallback-command] Fallback to non-ido version of current command.
3508 \\[ido-toggle-regexp] Toggle regexp searching.
3509 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3510 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
3511 \\[ido-toggle-vc] Toggle version control for this file.
3512 \\[ido-toggle-literal] Toggle literal reading of this file.
3513 \\[ido-completion-help] Show list of matching files in separate window.
3514 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
3517 (ido-file-internal ido-default-file-method))
3520 (defun ido-find-file-other-window ()
3521 "Switch to another file and show it in another window.
3522 The file name is selected interactively by typing a substring.
3523 For details of keybindings, do `\\[describe-function] ido-find-file'."
3525 (ido-file-internal 'otherwindow 'find-file-other-window))
3528 (defun ido-find-alternate-file ()
3529 "Switch to another file and show it in another window.
3530 The file name is selected interactively by typing a substring.
3531 For details of keybindings, do `\\[describe-function] ido-find-file'."
3533 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
3536 (defun ido-find-file-read-only ()
3537 "Edit file read-only with name obtained via minibuffer.
3538 The file name is selected interactively by typing a substring.
3539 For details of keybindings, do `\\[describe-function] ido-find-file'."
3541 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
3544 (defun ido-find-file-read-only-other-window ()
3545 "Edit file read-only in other window with name obtained via minibuffer.
3546 The file name is selected interactively by typing a substring.
3547 For details of keybindings, do `\\[describe-function] ido-find-file'."
3549 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
3552 (defun ido-find-file-read-only-other-frame ()
3553 "Edit file read-only in other frame with name obtained via minibuffer.
3554 The file name is selected interactively by typing a substring.
3555 For details of keybindings, do `\\[describe-function] ido-find-file'."
3557 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
3560 (defun ido-display-file ()
3561 "Display a file in another window but don't select it.
3562 The file name is selected interactively by typing a substring.
3563 For details of keybindings, do `\\[describe-function] ido-find-file'."
3565 (ido-file-internal 'display nil nil nil nil nil 'ignore))
3568 (defun ido-find-file-other-frame ()
3569 "Switch to another file and show it in another frame.
3570 The file name is selected interactively by typing a substring.
3571 For details of keybindings, do `\\[describe-function] ido-find-file'."
3573 (ido-file-internal 'otherframe 'find-file-other-frame))
3576 (defun ido-write-file ()
3577 "Write current buffer to a file.
3578 The file name is selected interactively by typing a substring.
3579 For details of keybindings, do `\\[describe-function] ido-find-file'."
3581 (let ((ido-process-ignore-lists t)
3582 (ido-work-directory-match-only nil)
3583 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
3584 (ido-report-no-match nil)
3585 (ido-confirm-unique-completion t)
3586 (ido-auto-merge-work-directories-length -1))
3587 (ido-file-internal 'write 'write-file nil "Write file: " nil nil 'ignore)))
3590 (defun ido-insert-file ()
3591 "Insert contents of file in current buffer.
3592 The file name is selected interactively by typing a substring.
3593 For details of keybindings, do `\\[describe-function] ido-find-file'."
3595 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil nil 'ido-enter-insert-buffer))
3599 "Call dired the ido way.
3600 The directory is selected interactively by typing a substring.
3601 For details of keybindings, do `\\[describe-function] ido-find-file'."
3603 (let ((ido-report-no-match nil)
3604 (ido-auto-merge-work-directories-length -1))
3605 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
3607 (defun ido-list-directory ()
3608 "Call list-directory the ido way.
3609 The directory is selected interactively by typing a substring.
3610 For details of keybindings, do `\\[describe-function] ido-find-file'."
3612 (let ((ido-report-no-match nil)
3613 (ido-auto-merge-work-directories-length -1))
3614 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
3616 ;;; XEmacs hack for showing default buffer
3618 ;; The first time we enter the minibuffer, Emacs puts up the default
3619 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
3620 ;; subtle difference in the two versions of post-command-hook. The
3621 ;; default is shown for both whenever we delete all of our text
3622 ;; though, indicating its just a problem the first time we enter the
3623 ;; function. To solve this, we use another entry hook for emacs to
3624 ;; show the default the first time we enter the minibuffer.
3627 ;;; ICOMPLETE TYPE CODE
3629 (defun ido-initiate-auto-merge (buffer)
3630 (ido-trace "\n*merge timeout*" buffer)
3631 (setq ido-auto-merge-timer nil)
3632 (when (and (buffer-live-p buffer)
3633 (= ido-use-mycompletion-depth (minibuffer-depth))
3634 (boundp 'ido-eoinput) ido-eoinput)
3635 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
3636 (ido-trace "request merge")
3637 (setq ido-use-merged-list 'auto
3638 ido-text-init contents
3644 (throw 'ido contents))))
3646 (defun ido-exhibit ()
3647 "Post command hook for `ido'."
3648 ;; Find matching files and display a list in the minibuffer.
3649 ;; Copied from `icomplete-exhibit' with two changes:
3650 ;; 1. It prints a default file name when there is no text yet entered.
3651 ;; 2. It calls my completion routine rather than the standard completion.
3653 (when (= ido-use-mycompletion-depth (minibuffer-depth))
3654 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
3655 (buffer-undo-list t)
3656 try-single-dir-match
3659 (ido-trace "\nexhibit" this-command)
3660 (ido-trace "dir" ido-current-directory)
3661 (ido-trace "contents" contents)
3662 (ido-trace "list" ido-cur-list)
3663 (ido-trace "matches" ido-matches)
3664 (ido-trace "rescan" ido-rescan)
3667 (goto-char (point-max))
3668 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
3669 (unless (boundp 'ido-eoinput)
3670 ;; In case it got wiped out by major mode business:
3671 (make-local-variable 'ido-eoinput))
3672 (setq ido-eoinput (point))
3674 ;; Handle explicit directory changes
3676 ((memq ido-cur-item '(buffer list))
3679 ((= (length contents) 0)
3682 ((= (length contents) 1)
3683 (when (and (ido-is-tramp-root) (string-equal contents "/"))
3684 (ido-set-current-directory ido-current-directory contents)
3688 ((and (string-match (if ido-enable-tramp-completion "..[:@]\\'" "..:\\'") contents)
3689 (ido-is-root-directory)) ;; Ange-ftp or tramp
3690 (ido-set-current-directory ido-current-directory contents)
3691 (when (ido-is-slow-ftp-host)
3692 (setq ido-exit 'fallback)
3696 ((ido-final-slash contents) ;; xxx/
3697 (ido-trace "final slash" contents)
3699 ((string-equal contents "~/")
3700 (ido-set-current-home)
3702 ((string-equal contents "../")
3703 (ido-up-directory t)
3705 ((string-equal contents "./")
3707 ((string-match "\\`~[a-zA-Z0-9]+/\\'" contents)
3708 (ido-trace "new home" contents)
3709 (ido-set-current-home contents)
3711 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
3712 (let ((exp (condition-case ()
3714 (substitute-in-file-name (substring contents 0 -1))
3715 ido-current-directory)
3717 (ido-trace contents exp)
3718 (when (and exp (file-directory-p exp))
3719 (ido-set-current-directory (file-name-directory exp))
3720 (setq ido-text-init (file-name-nondirectory exp))
3722 ((and (memq system-type '(windows-nt ms-dos))
3723 (string-equal (substring contents 1) ":/"))
3724 (ido-set-current-directory (file-name-directory contents))
3726 ((string-equal (substring contents -2 -1) "/")
3727 (ido-set-current-directory
3728 (if (memq system-type '(windows-nt ms-dos))
3729 (expand-file-name "/" ido-current-directory)
3732 ((and (or ido-directory-nonreadable ido-directory-too-big)
3733 (file-directory-p (concat ido-current-directory (file-name-directory contents))))
3734 (ido-set-current-directory
3735 (concat ido-current-directory (file-name-directory contents)))
3738 (ido-trace "try single dir")
3739 (setq try-single-dir-match t))))
3741 ((and (string-equal (substring contents -2 -1) "/")
3742 (not (string-match "[$]" contents)))
3743 (ido-set-current-directory
3745 ((= (length contents) 2)
3748 (concat ido-current-directory (car ido-matches)))
3750 (concat ido-current-directory (substring contents 0 -1)))))
3751 (setq ido-text-init (substring contents -1))
3754 ((and (not ido-use-merged-list)
3755 (not (ido-final-slash contents))
3756 (eq ido-try-merged-list t)
3757 (numberp ido-auto-merge-work-directories-length)
3758 (> ido-auto-merge-work-directories-length 0)
3759 (= (length contents) ido-auto-merge-work-directories-length)
3760 (not (and ido-auto-merge-inhibit-characters-regexp
3761 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3762 (not (input-pending-p)))
3763 (setq ido-use-merged-list 'auto
3764 ido-text-init contents
3771 (ido-trace "refresh on /" ido-text-init)
3772 (setq ido-exit 'refresh)
3775 ;; Update the list of matches
3776 (setq ido-text contents)
3778 (ido-trace "new " ido-matches)
3780 (when (and ido-enter-single-matching-directory
3782 (null (cdr ido-matches))
3783 (ido-final-slash (car ido-matches))
3784 (or try-single-dir-match
3785 (eq ido-enter-single-matching-directory t)))
3786 (ido-trace "single match" (car ido-matches))
3787 (ido-set-current-directory
3788 (concat ido-current-directory (car ido-matches)))
3789 (setq ido-exit 'refresh)
3792 (when (and (not ido-matches)
3793 (not ido-directory-nonreadable)
3794 (not ido-directory-too-big)
3796 ido-process-ignore-lists
3798 (let ((ido-process-ignore-lists nil)
3799 (ido-rotate ido-rotate)
3800 (ido-cur-list ido-ignored-list))
3801 (ido-trace "try all" ido-ignored-list)
3804 (ido-trace "found " ido-matches)
3806 (setq ido-process-ignore-lists-inhibit t)
3807 (setq ido-text-init ido-text)
3808 (setq ido-exit 'refresh)
3814 (memq ido-cur-item '(file dir))
3815 (not (ido-is-root-directory))
3816 (> (length contents) 1)
3817 (not (string-match "[$]" contents))
3818 (not ido-directory-nonreadable)
3819 (not ido-directory-too-big))
3820 (ido-trace "merge?")
3821 (if ido-use-merged-list
3822 (ido-undo-merge-work-directory contents nil)
3823 (when (and (eq ido-try-merged-list t)
3824 (numberp ido-auto-merge-work-directories-length)
3825 (= ido-auto-merge-work-directories-length 0)
3826 (not (and ido-auto-merge-inhibit-characters-regexp
3827 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3828 (not (input-pending-p)))
3829 (ido-trace "\n*start timer*")
3830 (setq ido-auto-merge-timer
3831 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
3835 (if (and ido-use-merged-list
3837 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
3839 (ido-set-current-directory (car (cdr (car ido-matches))))
3840 (setq ido-use-merged-list t
3842 ido-text-init ido-text)
3845 ;; Insert the match-status information:
3846 (ido-set-common-completion)
3847 (let ((inf (ido-completions
3849 minibuffer-completion-table
3850 minibuffer-completion-predicate
3851 (not minibuffer-completion-confirm))))
3852 (ido-trace "inf" inf)
3856 (defun ido-completions (name candidates predicate require-match)
3857 ;; Return the string that is displayed after the user's text.
3858 ;; Modified from `icomplete-completions'.
3860 (let* ((comps ido-matches)
3861 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
3862 ido-merged-indicator))
3865 (if (and ind ido-use-faces)
3866 (put-text-property 0 1 'face 'ido-indicator-face ind))
3868 (if (and ido-use-faces comps)
3869 (let* ((fn (ido-name (car comps)))
3871 (setq first (format "%s" fn))
3872 (put-text-property 0 ln 'face
3873 (if (= (length comps) 1)
3874 'ido-only-match-face
3875 'ido-first-match-face)
3877 (if ind (setq first (concat first ind)))
3878 (setq comps (cons first (cdr comps)))))
3882 (ido-directory-nonreadable
3883 (or (nth 8 ido-decorations) " [Not readable]"))
3884 (ido-directory-too-big
3885 (or (nth 9 ido-decorations) " [Too big]"))
3886 (ido-report-no-match
3887 (nth 6 ido-decorations)) ;; [No match]
3890 ((null (cdr comps)) ;one match
3891 (concat (if (> (length (ido-name (car comps))) (length name))
3892 ;; when there is one match, show the matching file name in full
3893 (concat (nth 4 ido-decorations) ;; [ ... ]
3894 (ido-name (car comps))
3895 (nth 5 ido-decorations))
3897 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
3898 (t ;multiple matches
3899 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
3907 (setq com (ido-name com))
3908 (setq items (1- items))
3911 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
3913 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
3914 (let ((str (substring com 0)))
3915 (if (and ido-use-faces
3916 (not (string= str first))
3917 (ido-final-slash str))
3918 (put-text-property 0 (length str) 'face 'ido-subdir-face str))
3923 ;; put in common completion item -- what you get by pressing tab
3924 (if (and (stringp ido-common-match-string)
3925 (> (length ido-common-match-string) (length name)))
3926 (concat (nth 4 ido-decorations) ;; [ ... ]
3927 (substring ido-common-match-string (length name))
3928 (nth 5 ido-decorations)))
3929 ;; list all alternatives
3930 (nth 0 ido-decorations) ;; { ... }
3932 (nth 1 ido-decorations)))))))
3934 (defun ido-minibuffer-setup ()
3935 "Minibuffer setup hook for `ido'."
3936 ;; Copied from `icomplete-minibuffer-setup-hook'.
3937 (when (and (boundp 'ido-completing-read)
3938 (or (featurep 'xemacs)
3939 (= ido-use-mycompletion-depth (minibuffer-depth))))
3940 (add-hook 'pre-command-hook 'ido-tidy nil t)
3941 (add-hook 'post-command-hook 'ido-exhibit nil t)
3942 (setq cua-inhibit-cua-keys t)
3943 (when (featurep 'xemacs)
3945 (goto-char (point-min)))
3946 (run-hooks 'ido-minibuffer-setup-hook)))
3949 "Pre command hook for `ido'."
3950 ;; Remove completions display, if any, prior to new user input.
3951 ;; Copied from `icomplete-tidy'."
3953 (when ido-auto-merge-timer
3954 (ido-trace "\n*cancel timer*" this-command)
3955 (cancel-timer ido-auto-merge-timer)
3956 (setq ido-auto-merge-timer nil))
3958 (if (and (boundp 'ido-use-mycompletion-depth)
3959 (= ido-use-mycompletion-depth (minibuffer-depth)))
3960 (if (and (boundp 'ido-eoinput)
3963 (if (> ido-eoinput (point-max))
3964 ;; Oops, got rug pulled out from under us - reinit:
3965 (setq ido-eoinput (point-max))
3966 (let ((buffer-undo-list t))
3967 (delete-region ido-eoinput (point-max))))
3969 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
3970 (make-local-variable 'ido-eoinput)
3971 (setq ido-eoinput 1))))
3973 (defun ido-summary-buffers-to-end ()
3974 ;; Move the summaries to the end of the buffer list.
3975 ;; This is an example function which can be hooked on to
3976 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
3977 ;; `Summary' or `output\*$'are put to the end of the list.
3978 (let ((summaries (delq nil (mapcar
3981 (string-match "Summary" x)
3982 (string-match "output\\*\\'" x))
3985 (ido-to-end summaries)))
3987 ;;; Helper functions for other programs
3989 (put 'dired-do-rename 'ido 'ignore)
3992 (defun ido-read-buffer (prompt &optional default require-match)
3993 "Ido replacement for the built-in `read-buffer'.
3994 Return the name of a buffer selected.
3995 PROMPT is the prompt to give to the user. DEFAULT if given is the default
3996 buffer to be selected, which will go to the front of the list.
3997 If REQUIRE-MATCH is non-nil, an existing-buffer must be selected."
3998 (let* ((ido-current-directory nil)
3999 (ido-directory-nonreadable nil)
4000 (ido-directory-too-big nil)
4001 (ido-context-switch-command 'ignore)
4002 (buf (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match)))
4003 (if (eq ido-exit 'fallback)
4004 (let ((read-buffer-function nil))
4005 (read-buffer prompt default require-match))
4009 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
4010 "Ido replacement for the built-in `read-file-name'.
4011 Read file name, prompting with PROMPT and completing in directory DIR.
4012 See `read-file-name' for additional parameters."
4015 ((or (eq predicate 'file-directory-p)
4016 (eq (get this-command 'ido) 'dir)
4017 (memq this-command ido-read-file-name-as-directory-commands))
4019 (ido-read-directory-name prompt dir default-filename mustmatch initial)))
4020 ((and (not (eq (get this-command 'ido) 'ignore))
4021 (not (memq this-command ido-read-file-name-non-ido))
4022 (or (null predicate) (eq predicate 'file-exists-p)))
4023 (let* (ido-saved-vc-hb
4024 (ido-context-switch-command 'ignore)
4025 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
4026 (ido-current-directory (ido-expand-directory dir))
4027 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4028 (ido-directory-too-big (and (not ido-directory-nonreadable)
4029 (ido-directory-too-big-p ido-current-directory)))
4030 (ido-work-directory-index -1)
4031 (ido-work-file-index -1)
4032 (ido-find-literal nil))
4035 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
4037 ((eq ido-exit 'fallback)
4038 (setq filename 'fallback))
4041 (concat ido-current-directory filename))))))
4043 (setq filename 'fallback)))
4044 (if (eq filename 'fallback)
4045 (let ((read-file-name-function nil))
4046 (read-file-name prompt dir default-filename mustmatch initial predicate))
4050 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
4051 "Ido replacement for the built-in `read-directory-name'.
4052 Read directory name, prompting with PROMPT and completing in directory DIR.
4053 See `read-directory-name' for additional parameters."
4055 (ido-context-switch-command 'ignore)
4057 (ido-current-directory (ido-expand-directory dir))
4058 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4059 (ido-directory-too-big (and (not ido-directory-nonreadable)
4060 (ido-directory-too-big-p ido-current-directory)))
4061 (ido-work-directory-index -1)
4062 (ido-work-file-index -1))
4064 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
4066 (if (and (stringp filename) (string-equal filename "."))
4067 ido-current-directory
4068 (concat ido-current-directory filename)))))
4071 (defun ido-completing-read (prompt choices &optional predicate require-match initial-input hist def)
4072 "Ido replacement for the built-in `completing-read'.
4073 Read a string in the minibuffer with ido-style completion.
4074 PROMPT is a string to prompt with; normally it ends in a colon and a space.
4075 CHOICES is a list of strings which are the possible completions.
4076 PREDICATE is currently ignored; it is included to be compatible
4077 with `completing-read'.
4078 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
4079 the input is (or completes to) an element of CHOICES or is null.
4080 If the input is null, `ido-completing-read' returns DEF, or an empty
4081 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
4082 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
4083 with point positioned at the end.
4084 HIST, if non-nil, specifies a history list.
4085 DEF, if non-nil, is the default value."
4086 (let ((ido-current-directory nil)
4087 (ido-directory-nonreadable nil)
4088 (ido-directory-too-big nil)
4089 (ido-context-switch-command 'ignore)
4090 (ido-choice-list choices))
4091 (ido-read-internal 'list prompt hist def require-match initial-input)))
4094 ;;; arch-tag: b63a3500-1735-41bd-8a01-05373f0864da
4095 ;;; ido.el ends here