1 ;;; ido.el --- interactively do things with buffers and files.
3 ;; Copyright (C) 1996-2002 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 Schroeder,
34 ;; Bill Benedetto, and Stephen Eglen for bug fixes and improvements.
38 ;; Since I discovered Stephen Eglen's excellent iswitchb package, I just
39 ;; couldn't live without it, but once being addicted to switching buffers
40 ;; with a minimum of keystrokes, I soon found that opening files in the
41 ;; old-fashioned way was just too slow - so I decided to write a package
42 ;; which could open files with the same speed and ease as iswitchb could
45 ;; I originally wrote a separate ifindf.el package based on a copy of
46 ;; iswitchb.el, which did for opening files what iswitchb did for
47 ;; switching buffers. Along the way, I corrected a few errors in
48 ;; ifindf which could have found its way back into iswitchb, but since
49 ;; most of the functionality of the two package was practically
50 ;; identical, I decided that the proper thing to do was to merge my
51 ;; ifindf package back into iswitchb.
53 ;; This is basically what ido (interactively do) is all about; but I
54 ;; found it ackward to merge my changes into the "iswitchb-" namespace,
55 ;; so I invented a common "ido-" namespace for the merged packages.
57 ;; This version is based on ido.el version 1.57 released on
58 ;; gnu.emacs.sources adapted for emacs 21.4 to use command remapping
59 ;; and optionally hooking the read-buffer and read-file-name functions.
61 ;; Prefix matching was added by Klaus Berndl <klaus.berndl@sdm.de> based on
62 ;; an idea of Yuji Minejima <ggb01164@nifty.ne.jp> and his mcomplete-package.
67 ;; Ido - interactive do - switches between buffers and opens files and
68 ;; directories with a minimum of keystrokes. It is a superset of
69 ;; iswitchb, the interactive buffer switching package by Stephen Eglen.
71 ;; Interactive substring matching
72 ;; ------------------------------
74 ;; As you type in a substring, the list of buffers or files currently
75 ;; matching the substring are displayed as you type. The list is
76 ;; ordered so that the most recent buffers or files visited come at
77 ;; the start of the list.
79 ;; The buffer or file at the start of the list will be the one visited
80 ;; when you press RETURN. By typing more of the substring, the list is
81 ;; narrowed down so that gradually the buffer or file you want will be
82 ;; at the top of the list. Alternatively, you can use C-s and C-r (or
83 ;; the right and left arrow keys) to rotate buffer or file names in the
84 ;; list until the one you want is at the top of the list.
86 ;; Completion is also available so that you can see what is common to
87 ;; all of the matching buffers or files as you type.
91 ;; If I have two buffers called "123456" and "123", with "123456" the
92 ;; most recent, when I use ido-switch-buffer, I first of all get
93 ;; presented with the list of all the buffers
95 ;; Buffer: {123456,123}
98 ;; Buffer: 2[3]{123456,123}
100 ;; The list in {...} are the matching buffers, most recent first
101 ;; (buffers visible in the current frame are put at the end of the
102 ;; list by default). At any time I can select the item at the head of
103 ;; the list by pressing RET. I can also bring the put the first
104 ;; element at the end of the list by pressing C-s or [right], or put
105 ;; the last element at the head of the list by pressing C-r or [left].
107 ;; The item in [...] indicates what can be added to my input by
108 ;; pressing TAB. In this case, I will get "3" added to my input.
111 ;; Buffer: 23{123456,123}
113 ;; At this point, I still have two matching buffers.
114 ;; If I want the first buffer in the list, I simply press RET. If I
115 ;; wanted the second in the list, I could press C-s to move it to the
116 ;; top of the list and then RET to select it.
118 ;; However, if I type 4, I only have one match left:
119 ;; Buffer: 234[123456] [Matched]
121 ;; Since there is only one matching buffer left, it is given in [] and we
122 ;; see the text [Matched] afterwards. I can now press TAB or RET to go
125 ;; If however, I now type "a":
126 ;; Buffer: 234a [No match]
127 ;; There are no matching buffers. If I press RET or TAB, I can be
128 ;; prompted to create a new buffer called "234a".
130 ;; Of course, where this function comes in really useful is when you
131 ;; can specify the buffer using only a few keystrokes. In the above
132 ;; example, the quickest way to get to the "123456" file would be
133 ;; just to type 4 and then RET (assuming there isn't any newer buffer
134 ;; with 4 in its name).
136 ;; Likewise, if you use C-x C-f (ido-find-file), the list of files and
137 ;; directories in the current directory is provided in the same
138 ;; fashion as the buffers above. The files and directories are
139 ;; normally sorted in alphabetical order, but the most recently
140 ;; visited directory is placed first to speed up navigating to
141 ;; directories that you have visited recently.
143 ;; In addition to scrolling through the list using [right] and [left],
144 ;; you can use [up] and [down] to quickly scroll the list to the next
145 ;; or previous subdirectory.
147 ;; To go down into a subdirectory, and continue the file selection on
148 ;; the files in that directory, simply move the directory to the head
149 ;; of the list and hit RET.
151 ;; To go up to the parent directory, delete any partial file name
152 ;; already specified (e.g. using [backspace]) and hit [backspace].
154 ;; To go to the root directory (on the current drive), enter two
155 ;; slashes. On MS-DOS or Windows, to select the root of another
156 ;; drive, enter X:/ where X is the drive letter. You can also visit
157 ;; files on other hosts using the ange-ftp notations `/host:' and
158 ;; `/user@host:'. See the variable `ido-slow-ftp-hosts' if you want
159 ;; to inhibit the ido substring matching for ftp access.
161 ;; If for some reason you cannot specify the proper file using
162 ;; ido-find-file, you can press C-f to enter the normal find-file.
163 ;; You can also press C-b to drop into ido-switch-buffer.
165 ;; See the doc string of ido-switch-buffer and ido-find-file for full
166 ;; keybindings and features.
167 ;; (describe-function 'ido-find-file)
169 ;; Hidden buffers and files
170 ;; ------------------------
172 ;; Normally, ido does not include hidden buffers (whose name starts
173 ;; with a space) and hidden files and directories (whose name starts
174 ;; with `.') in the list of possible completions. However, if the
175 ;; substring you enter does not match any of the visible buffers or
176 ;; files, ido will automatically look for completions among the hidden
179 ;; You can toggle display of the hidden buffers and files with C-a.
181 ;; Additional functionality
182 ;; ------------------------
184 ;; After C-x b, the buffer at the head of the list can be killed by
185 ;; pressing C-k. If the buffer needs saving, you will be queried
186 ;; before the buffer is killed.
188 ;; Likewise, after C-x C-f, you can delete (i.e. physically remove)
189 ;; the file at the head of the list with C-k. You will always be
190 ;; asked for confirmation before the file is deleted.
192 ;; If you enter C-x b to switch to a buffer visiting a given file, and
193 ;; you find that the file you are after is not in any buffer, you can
194 ;; press C-f to immediately drop into ido-find-file. And you can
195 ;; switch back to buffer selection with C-b.
200 ;; The standard way of completion with Unix-shells and Emacs is to insert a
201 ;; PREFIX and then hitting TAB (or another completion key). Cause of this
202 ;; behavior has become second nature to a lot of emacs users `ido' offers in
203 ;; addition to the default substring-matching-method (look above) also the
204 ;; prefix-matching-method. The kind of matching is the only difference to
205 ;; the description of the substring-matching above.
207 ;; You can toggle prefix matching with C-p.
211 ;; If you have again two Buffers "123456" and "123" then hitting "2" does
212 ;; not match because "2" is not a PREFIX in any of the buffer-names. This
213 ;; is the only difference between the substring and prefix matching.
218 ;; If you set ido-enable-flex-matching, ido will do a more flexible
219 ;; matching (unless regexp matching is active) to find possible matches
220 ;; among the available buffer or file names if no matches are found using
221 ;; the normal prefix or substring matching.
223 ;; The flexible matching implies that any item which simply contains all
224 ;; of the entered characters in the specified sequence will match.
228 ;; If you have four files "alpha", "beta", "gamma", and "delta",
229 ;; entering "aa" will match "alpha" and "gamma", while "ea" matches
230 ;; "beta" and "delta". If prefix matching is also active, "aa" only
231 ;; matches "alpha", while "ea" does not match any files.
236 ;; There is limited provision for regexp matching within ido,
237 ;; enabled through `ido-enable-regexp' (toggle with C-t).
238 ;; This allows you to type `c$' for example and see all file names
239 ;; ending in `c'. This facility is quite limited though in two
240 ;; respects. First, you can't currently type in expressions like
241 ;; `[0-9]' directly -- you have to type them in when ido-enable-regexp
242 ;; is nil and then toggle on the regexp functionality. Likewise,
243 ;; don't enter an expression containing `\' in regexp mode. If you
244 ;; try, ido gets confused, so just hit C-g and try again. Secondly,
245 ;; no completion mechanism is currently offered with regexp searching.
251 ;; Customize the `ido' group to change the `ido' functionality.
253 ;; To modify the keybindings, use the hook provided. For example:
254 ;;(add-hook 'ido-define-mode-map-hook 'ido-my-keys)
256 ;;(defun ido-my-keys ()
257 ;; "Add my keybindings for ido."
258 ;; (define-key ido-mode-map " " 'ido-next-match)
261 ;; Seeing all the matching buffers or files
262 ;; ----------------------------------------
264 ;; If you have many matching files, they may not all fit onto one
265 ;; line of the minibuffer. Normally, the minibuffer window will grow
266 ;; to show you more of the matching files (depending on the setting
267 ;; of the variables `resize-mini-windows' and `max-mini-window-height').
268 ;; If you want ido to behave differently from the default minibuffer
269 ;; resizing behaviour, set the variable `ido-max-window-height'.
271 ;; Also, to improve the responsiveness of ido, the maximum number of
272 ;; matching items is limited to 12, but you can increase or removed
273 ;; this limit via the `ido-max-prospects' variable.
275 ;; To see a full list of all matching buffers in a separate buffer,
276 ;; hit ? or press TAB when there are no further completions to the
277 ;; substring. Repeated TAB presses will scroll you through this
280 ;; Changing the list of files
281 ;; --------------------------
283 ;; By default, the list of current files is most recent first,
284 ;; oldest last, with the exception that the files visible in the
285 ;; current frame are put at the end of the list. A hook exists to
286 ;; allow other functions to order the list. For example, if you add:
288 ;; (add-hook 'ido-make-buffer-list-hook 'ido-summary-buffers-to-end)
290 ;; then all files matching "Summary" are moved to the end of the
291 ;; list. (I find this handy for keeping the INBOX Summary and so on
292 ;; out of the way.) It also moves files matching "output\*$" to the
293 ;; end of the list (these are created by AUC TeX when compiling.)
294 ;; Other functions could be made available which alter the list of
295 ;; matching files (either deleting or rearranging elements.)
300 ;; The highlighting of matching items is controlled via ido-use-faces.
301 ;; The faces used are ido-first-match-face, ido-only-match-face and
303 ;; Colouring of the matching item was suggested by
304 ;; Carsten Dominik (dominik@strw.leidenuniv.nl).
306 ;; Replacement for read-buffer and read-file-name
307 ;; ----------------------------------------------
309 ;; ido-read-buffer and ido-read-file-name have been written to be drop
310 ;; in replacements for the normal buffer and file name reading
311 ;; functions `read-buffer' and `read-file-name'.
313 ;; To use ido for all buffer and file selections in Emacs, customize the
314 ;; variable `ido-everywhere'.
316 ;; Using ido-like behaviour in other lisp packages
317 ;; -----------------------------------------------
319 ;; If you don't want to rely on the `ido-everywhere' functionality,
320 ;; ido-read-buffer, ido-read-file-name, and ido-read-directory-name
321 ;; can be used by other packages to read a buffer name, a file name,
322 ;; or a directory name in the `ido' way.
331 ;; These are some things you might want to change.
333 (defun ido-fractionp (n)
334 (and (numberp n
) (> n
0.0) (<= n
1.0)))
337 "Switch between files using substrings."
340 :link
'(emacs-commentary-link :tag
"Commentary" "ido.el")
341 :link
'(emacs-library-link :tag
"Lisp File" "ido.el"))
344 (defcustom ido-mode nil
345 "Determines for which functional group \(buffer and files) ido behavior
346 should be enabled. The following values are possible:
347 - 'buffer: Turn only on ido buffer behavior \(switching, killing,
349 - 'file: Turn only on ido file behavior \(finding, writing, inserting...)
350 - 'both: Turn on ido buffer and file behavior.
351 - nil: Turn off any ido switching.
353 Setting this variable directly does not take effect;
354 use either \\[customize] or the function `ido-mode'."
355 :set
#'(lambda (symbol value
)
357 :initialize
'custom-initialize-default
359 :link
'(emacs-commentary-link "ido.el")
360 :set-after
'(ido-save-directory-list-file)
362 :type
'(choice (const :tag
"Turn on only buffer" buffer
)
363 (const :tag
"Turn on only file" file
)
364 (const :tag
"Turn on both buffer and file" both
)
365 (const :tag
"Switch off all" nil
))
368 (defcustom ido-everywhere nil
369 "Use ido everywhere for reading file names and directories.
370 Setting this variable directly does not work. Use `customize' or
371 call the function `ido-everywhere'."
372 :set
#'(lambda (symbol value
)
373 (ido-everywhere value
))
374 :initialize
'custom-initialize-default
378 (defcustom ido-case-fold case-fold-search
379 "*Non-nil if searching of buffer and file names should ignore case."
383 (defcustom ido-ignore-buffers
385 "*List of regexps or functions matching buffer names to ignore.
386 For example, traditional behavior is not to list buffers whose names begin
387 with a space, for which the regexp is `\\` '. See the source file for
388 example functions that filter buffernames."
389 :type
'(repeat (choice regexp function
))
392 (defcustom ido-ignore-files
393 '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
394 "*List of regexps or functions matching file names to ignore.
395 For example, traditional behavior is not to list files whose names begin
396 with a #, for which the regexp is `\\`#'. See the source file for
397 example functions that filter filenames."
398 :type
'(repeat (choice regexp function
))
401 (defcustom ido-ignore-extensions t
402 "*Non-nil means ignore files in completion-ignored-extensions list."
406 (defcustom ido-show-dot-for-dired nil
407 "*Non-nil means to always put . as the first item in file name lists.
408 This allows the current directory to be opened immediate with `dired'."
412 (defcustom ido-ignore-directories
413 '("\\`CVS/" "\\`\\.\\./" "\\`\\./")
414 "*List of regexps or functions matching sub-directory names to ignore."
415 :type
'(repeat (choice regexp function
))
418 (defcustom ido-ignore-directories-merge nil
419 "*List of regexps or functions matching directory path names to ignore during merge.
420 Directory paths matched by one of the regexps in this list are not inserted
421 in merged file and directory lists."
422 :type
'(repeat (choice regexp function
))
425 ;;; Examples for setting the value of ido-ignore-buffers
426 ;(defun ido-ignore-c-mode (name)
427 ; "Ignore all c mode buffers -- example function for ido."
430 ; (string-match "^C$" mode-name)))
432 ;(setq ido-ignore-buffers '("^ " ido-ignore-c-mode))
434 ;;; Examples for setting the value of ido-ignore-files
435 ;(setq ido-ignore-files '("^ " "\\.c$" "\\.h$"))
437 (defcustom ido-default-file-method
'always-frame
438 "*How to switch to new file when using `ido-find-file'.
440 `samewindow' Show new file in same window
441 `otherwindow' Show new file in another window (same frame)
442 `display' Display file in another window without switching to it
443 `otherframe' Show new file in another frame
444 `maybe-frame' If a file is visible in another frame, prompt to ask if you
445 you want to see the file in the same window of the current
446 frame or in the other frame.
447 `always-frame' If a file is visible in another frame, raise that
448 frame. Otherwise, visit the file in the same window."
449 :type
'(choice (const samewindow
)
454 (const always-frame
))
457 (defcustom ido-default-buffer-method
'always-frame
458 "*How to switch to new buffer when using `ido-switch-buffer'.
459 See ido-default-file-method for details."
460 :type
'(choice (const samewindow
)
465 (const always-frame
))
468 (defcustom ido-enable-flex-matching nil
469 "*Non-nil means that `ido' will do flexible string matching.
470 Flexible matching means that if the entered string does not
471 match any item, any item containing the entered characters
472 in the given sequence will match."
477 (defcustom ido-enable-regexp nil
478 "*Non-nil means that `ido' will do regexp matching.
479 Value can be toggled within `ido' using `ido-toggle-regexp'."
483 (defcustom ido-enable-prefix nil
484 "*Nil means that `ido' will match if the inserted text is an
485 arbitrary substring (default). If non-nil `ido' will only match if the inserted
486 text is a prefix \(this behavior is like the standard unix- or
487 emacs-completion works).
488 Value can be toggled within `ido' using `ido-toggle-prefix'."
492 (defcustom ido-record-commands t
493 "*Non-nil means that `ido' will record commands in command history.
494 Note that the non-ido equivalent command is recorded."
498 (defcustom ido-max-prospects
12
499 "*Non-zero means that the prospect list will be limited to than number of items.
500 For a long list of prospects, building the full list for the minibuffer can take a
501 non-negletable amount of time; setting this variable reduces that time."
505 (defcustom ido-max-prompt-path
0.35
506 "*Non-zero means that the prompt string be limited to than number of characters.
507 If value is a floating point number, it specifies a fraction of the frame width."
509 (integer :tag
"Characters" :value
20)
510 (restricted-sexp :tag
"Fraction of frame width"
512 :match-alternatives
(ido-fractionp)))
515 (defcustom ido-max-window-height nil
516 "*Non-nil specifies a value to override `max-mini-window-height'."
518 (const :tag
"Don't override" nil
)
519 (integer :tag
"Number of lines" :value
1)
521 :tag
"Fraction of window height"
523 :match-alternatives
(ido-fractionp)))
526 (defcustom ido-enable-last-directory-history t
527 "*Non-nil means that `ido' will remember latest selected directory paths.
528 See `ido-last-directory-list' and `ido-save-directory-list-file'."
532 (defcustom ido-max-work-directory-list
50
533 "*Maximum number of working directories to record.
534 This is the list of directories where files have most recently been opened.
535 See `ido-work-directory-list' and `ido-save-directory-list-file'."
539 (defcustom ido-work-directory-list-ignore-regexps nil
540 "*List of regexps matching directories which should not be recorded.
541 Directory paths matched by one of the regexps in this list are not inserted in
542 the `ido-work-directory-list' list."
543 :type
'(repeat regexp
)
546 (defcustom ido-record-ftp-work-directories t
547 "*Non-nil means that ftp paths are recorded in work directory list."
551 (defcustom ido-merge-ftp-work-directories nil
552 "*Nil means that ftp paths in work directory list are ignored during merge."
556 (defcustom ido-cache-ftp-work-directory-time
1.0
557 "*Maximum time to cache contents of an ftp directory (in hours).
558 If zero, ftp directories are not cached."
562 (defcustom ido-slow-ftp-hosts nil
563 "*List of slow ftp hosts where ido prompting should not be used.
564 If an ftp host is on this list, ido automatically switches to the non-ido
565 equivalent function, e.g. find-file rather than ido-find-file."
566 :type
'(repeat string
)
569 (defcustom ido-slow-ftp-host-regexps nil
570 "*List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
571 :type
'(repeat regexp
)
574 (defcustom ido-max-work-file-list
10
575 "*Maximum number of names of recently opened files to record.
576 This is the list the file names (sans directory) which have most recently
577 been opened. See `ido-work-file-list' and `ido-save-directory-list-file'."
581 (defcustom ido-work-directory-match-only t
582 "*Non-nil means to skip non-matching directories in the directory history.
583 When some text is already entered at the `ido-find-file' prompt, using
584 \\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories
585 without any matching entries."
589 (defcustom ido-auto-merge-work-directories-length
0
590 "*Automatically switch to merged work directories during file name input.
591 The value is number of characters to type before switching to merged mode.
592 If zero, the switch happens when no matches are found in the current directory.
593 Automatic merging is disabled if the value is negative."
597 (defcustom ido-auto-merge-delay-time
0.70
598 "*Delay in seconds to wait for more input before doing auto merge."
602 (defcustom ido-auto-merge-inhibit-characters-regexp
"[][*?~]"
603 "*Regexp matching characters which should inhibit automatic merging.
604 When a (partial) file name matches this regexp, merging is inhibited."
608 (defcustom ido-merged-indicator
"^"
609 "The string appended to first choice if it has multiple directory choices."
613 (defcustom ido-max-dir-file-cache
100
614 "*Maximum number of working directories to be cached.
615 This is the size of the cache of file-name-all-completions results.
616 Each cache entry is time stamped with the modification time of the
617 directory. Some systems, like Windows, have unreliable directory
618 modification times, so you may choose to disable caching on such
619 systems, or explicitly refresh the cache contents using the command
620 `ido-reread-directory' command (C-l) in the minibuffer.
621 See also `ido-dir-file-cache' and `ido-save-directory-list-file'."
625 (defcustom ido-rotate-file-list-default nil
626 "*Non-nil means that `ido' will always rotate file list to get default in front."
630 (defcustom ido-enter-single-matching-directory nil
631 "*Automatically enter sub-directory if it is the only matching item, if non-nil.
632 If value is 'slash, only enter if typing final slash, else do it always."
633 :type
'(choice (const :tag
"Never" nil
)
634 (const :tag
"When typing /" slash
)
635 (other :tag
"Always" t
))
638 (defcustom ido-create-new-buffer
'prompt
639 "*Specify whether a new buffer is created if no buffer matches substring.
640 Choices are 'always to create new buffers unconditionally, 'prompt to
641 ask user whether to create buffer, or 'never to never create new buffer."
642 :type
'(choice (const always
)
647 (defcustom ido-define-mode-map-hook nil
648 "*Hook to define keys in `ido-mode-map' for extra keybindings."
652 (defcustom ido-separator nil
653 "*String used by ido to separate the alternatives in the minibuffer.
654 Obsolete. Set 3rd element of `ido-decorations' instead."
655 :type
'(choice string
(const nil
))
658 (defcustom ido-decorations
'( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]")
659 "*List of strings used by ido to display the alternatives in the minibuffer.
660 There are 8 elements in this list, each is a pair of strings:
661 1st and 2nd elements are used as brackets around the prospect list,
662 3rd element is the separator between prospects (ignored if ido-separator is set),
663 4th element is the string inserted at the end of a truncated list of prospects,
664 5th and 6th elements are used as brackets around the common match string which
665 can be completed using TAB,
666 7th element is the string displayed when there are a no matches, and
667 8th element displayed if there is a single match (and faces are not used)."
668 :type
'(repeat string
)
671 (defcustom ido-use-faces t
672 "*Non-nil means use ido faces to highlighting first match, only match and
673 subdirs in the alternatives."
677 (defface ido-first-match-face
'((t (:bold t
)))
678 "*Font used by ido for highlighting first match."
681 (defface ido-only-match-face
'((((class color
))
682 (:foreground
"ForestGreen"))
684 "*Font used by ido for highlighting only match."
687 (defface ido-subdir-face
'((((class color
))
690 "*Font used by ido for highlighting subdirs in the alternatives."
693 (defface ido-indicator-face
'((((class color
))
694 (:foreground
"yellow"
697 (t (:inverse-video t
)))
698 "*Font used by ido for highlighting its indicators."
701 (defcustom ido-make-file-list-hook nil
702 "*List of functions to run when the list of matching files is created.
703 Each function on the list may modify the dynamically bound variable
704 `ido-temp-list' which contains the current list of matching files."
708 (defcustom ido-make-dir-list-hook nil
709 "*List of functions to run when the list of matching directories is created.
710 Each function on the list may modify the dynamically bound variable
711 `ido-temp-list' which contains the current list of matching directories."
715 (defcustom ido-make-buffer-list-hook nil
716 "*List of functions to run when the list of matching buffers is created.
717 Each function on the list may modify the dynamically bound variable
718 `ido-temp-list' which contains the current list of matching buffer names."
722 (defcustom ido-make-file-prompt-hook nil
723 "*List of functions to run when the find-file prompt is created.
724 Each function on the list may modify the following dynamically bound
726 path - the (abbreviated) directory path
727 max-width - the max width of the path; set to nil to inhibit truncation
728 prompt - the basic prompt (e.g. \"Find File: \")
729 literal - the string shown if doing `literal' find; set to nil to omit
730 vc-off - the string shown if version control is inhibited; set to nit to omit
731 prefix - normally nil, but may be set to a fixed prefix for the path
732 The following variables are available, but should not be changed:
733 ido-current-directory - the unabbreviated directory path
734 item - equals 'file or 'dir depending on the current mode."
738 (defvar ido-rewrite-prompt-path-rules nil
739 "*Alist of rewriting rules for file paths.
740 A list of elements of the form (FROM . TO) or (FROM . FUNC),
741 each meaning to rewrite the path if matched by FROM by either
742 substituting the matched string by TO or calling the function
743 FUNC with the current path as its only argument and using the
744 return value as the new path. In addition, each FUNC may
745 also modify the dynamic variables described for the
746 variable `ido-make-file-prompt-hook'.")
748 (defcustom ido-completion-buffer
"*Ido Completions*"
749 "*Name of completion buffer used by ido.
750 Set to nil to disable completion buffers popping up."
754 (defcustom ido-completion-buffer-all-completions nil
755 "*Non-nil means to show all completions in completion buffer.
756 Otherwise, only the current list of matches is shown."
760 (defvar ido-all-frames
'visible
761 "*Argument to pass to `walk-windows' when finding visible files.
762 See documentation of `walk-windows' for useful values.")
764 (defcustom ido-minibuffer-setup-hook nil
765 "*Ido-specific customization of minibuffer setup.
767 This hook is run during minibuffer setup iff `ido' will be active.
768 It is intended for use in customizing ido for interoperation
769 with other packages. For instance:
771 \(add-hook 'ido-minibuffer-setup-hook
774 \(make-local-variable 'max-mini-window-height)
775 \(setq max-mini-window-height 3))))
777 will constrain Emacs to a maximum minibuffer height of 3 lines when
778 ido is running. Copied from `icomplete-minibuffer-setup-hook'."
782 (defcustom ido-save-directory-list-file
"~/.ido.last"
783 "File in which the ido state is saved between invocations.
784 Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
785 `ido-work-file-list', and `ido-dir-file-cache'.
786 Must be set before enabling ido mode."
790 (defcustom ido-read-file-name-as-directory-commands
'()
791 "List of commands which uses read-file-name to read a directory path.
792 When `ido-everywhere' is non-nil, the commands in this list will read
793 the directory using ido-read-directory-name."
794 :type
'(repeat symbol
)
797 (defcustom ido-read-file-name-non-ido
'()
798 "List of commands which shall not read file names the ido way.
799 When `ido-everywhere' is non-nil, the commands in this list will read
800 the file name using normal read-file-name style."
801 :type
'(repeat symbol
)
804 ;;; Internal Variables
806 ;; Persistent variables
808 (defvar ido-mode-map nil
809 "Keymap for `ido-find-file' and `ido-switch-buffer'.")
811 (defvar ido-file-history nil
812 "History of files selected using `ido-find-file'.")
814 (defvar ido-buffer-history nil
815 "History of buffers selected using `ido-switch-buffer'.")
817 (defvar ido-xemacs
(string-match "XEmacs" (emacs-version))
818 "Non-nil if we are running XEmacs. Otherwise, assume we are running Emacs.")
820 (defvar ido-last-directory-list nil
821 "List of last selected directory paths.
822 See `ido-enable-last-directory-history' for details.")
824 (defvar ido-work-directory-list nil
825 "List of actual working directory paths.
826 The current directory is inserted at the front of this list whenever a
827 file is opened with ido-find-file and family.")
829 (defvar ido-work-file-list nil
830 "List of actual work file names.
831 The current file name (sans path) is inserted at the front of this list
832 whenever a file is opened with ido-find-file and family.")
834 (defvar ido-dir-file-cache nil
835 "List of file-name-all-completions results.
836 Each element in the list is of the form (dir (mtime) file...).")
840 (defvar ido-eoinput
1
841 "Point where minibuffer input ends and completion info begins.
842 Copied from `icomplete-eoinput'.")
843 (make-variable-buffer-local 'ido-eoinput
)
845 (defvar ido-common-match-string nil
846 "Stores the string that is common to all matching files.")
848 (defvar ido-rescan nil
849 "Non-nil means we need to regenerate the list of matching items.")
851 (defvar ido-rotate nil
852 "Non-nil means we are rotating list of matches.")
855 "Stores the users string as it is typed in.")
857 (defvar ido-text-init nil
858 "The initial string for the users string it is typed in.")
860 (defvar ido-matches nil
861 "List of files currently matching `ido-text'.")
863 (defvar ido-report-no-match t
864 "Report [No Match] when no completions matches ido-text.")
867 "Flag to monitor how `ido-find-file' exits.
868 If equal to `takeprompt', we use the prompt as the file name to be
871 (defvar ido-current-directory nil
872 "Current directory for ido-find-file.")
874 (defvar ido-auto-merge-timer nil
875 "Delay timer for auto merge.")
877 (defvar ido-use-mycompletion-depth
0
878 "Non-nil means use `ido' completion feedback.
879 Is set by ido functions to the current minibuffer-depth, so that
880 it doesn't interfere with other minibuffer usage.")
883 ;;; Variables with dynamic bindings.
884 ;;; Declared here to keep the byte compiler quiet.
886 ;; Stores the current ido item type ('file, 'dir or 'buffer).
887 (defvar ido-cur-item
)
889 ;; Stores the current list of items that will be searched through.
890 ;; The list is ordered, so that the most interesting item comes first,
891 ;; although by default, the files visible in the current frame are put
892 ;; at the end of the list. Created by `ido-make-item-list'.
893 (defvar ido-cur-list
)
895 ;; Stores the list of items which are ignored when building
896 ;; `ido-cur-list'. It is in no specific order.
897 (defvar ido-ignored-list
)
899 ;; Keep current item list if non-nil.
900 (defvar ido-keep-item-list
)
902 ;; Process ido-ignore-* lists.
903 (defvar ido-process-ignore-lists
)
905 ;; Don't process ido-ignore- lists once.
906 (defvar ido-process-ignore-lists-inhibit
)
908 ;; Buffer from which ido was entered.
909 (defvar ido-entry-buffer
)
911 ;; Non-nil if matching file must be selected.
912 (defvar ido-require-match
)
914 ;; Stores a temporary version of the file list being created.
915 (defvar ido-temp-list
)
917 ;; Non-nil if default list element should be rotated into place.
918 (defvar ido-rotate-temp
)
920 ;; Stores current index in ido-work-directory-list.
921 (defvar ido-work-directory-index
)
923 ;; Stores current index in ido-work-file-list.
924 (defvar ido-work-file-index
)
926 ;; Set when merged work directory list is in use.
927 (defvar ido-use-merged-list
)
929 ;; Set when merged work directory list not yet built.
930 (defvar ido-try-merged-list
)
932 ;; Saved state prior to last work directory merge.
933 ;; Value is a list (ido-text dir cur-list ignored-list matches).
934 (defvar ido-pre-merge-state
)
936 ;; Original value of vc-master-templates for use in ido-toggle-vc.
937 (defvar ido-saved-vc-mt
)
939 ;; Stores temporary state of literal find file.
940 (defvar ido-find-literal
)
945 (defun ido-active (&optional merge
)
948 (and (boundp 'ido-completing-read
) (= ido-use-mycompletion-depth
(minibuffer-depth)))))
950 (defvar ido-trace-enable nil
)
952 (defun ido-trace (p &optional s retval
)
954 (let ((b (get-buffer-create " *IDO Trace*"))
955 (deactivate-mark deactivate-mark
))
959 (insert p
": " (if (stringp s
) s
(format "%S" s
)) "\n")))))
962 (defun ido-toggle-trace (arg)
964 (setq ido-trace-enable
(or arg
(not ido-trace-enable
)))
965 (let ((b (get-buffer " *IDO Trace*")))
969 (pop-to-buffer b t t
)))))
971 (defun ido-is-root-directory (&optional dir
)
972 (setq dir
(or dir ido-current-directory
))
973 (if (memq system-type
'(windows-nt ms-dos
))
974 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir
)
975 (string-equal "/" dir
)))
977 (defun ido-is-ftp-directory (&optional dir
)
978 (string-match "\\`/[^/:][^/:]+:/" (or dir ido-current-directory
)))
980 (defun ido-is-slow-ftp-host (&optional dir
)
981 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps
)
982 (setq dir
(or dir ido-current-directory
))
983 ;; (featurep 'ange-ftp)
984 ;; (ange-ftp-ftp-name dir)
985 (string-match "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/" dir
)
986 (let ((host (substring dir
(match-beginning 2) (match-end 2))))
987 (or (member host ido-slow-ftp-hosts
)
988 (let ((re ido-slow-ftp-host-regexps
))
989 (while (and re
(not (string-match (car re
) host
)))
993 (defun ido-time-stamp (&optional time
)
994 ;; Time is a floating point number (fractions of 1 hour)
995 (setq time
(or time
(current-time)))
996 (/ (+ (* (car time
) 65536.0) (car (cdr time
))) 3600.0))
998 (defun ido-cache-ftp-valid (&optional time
)
999 (and (numberp ido-cache-ftp-work-directory-time
)
1000 (> ido-cache-ftp-work-directory-time
0)
1002 (< (- (ido-time-stamp) time
) ido-cache-ftp-work-directory-time
))))
1004 (defun ido-may-cache-directory (&optional dir
)
1005 (setq dir
(or dir ido-current-directory
))
1006 (if (and (memq system-type
'(windows-nt ms-dos
))
1007 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir
))
1009 (or (not (ido-is-ftp-directory dir
))
1010 (ido-cache-ftp-valid))))
1012 (defun ido-pp (list &optional sep
)
1013 (let ((print-level nil
) (eval-expression-print-level nil
)
1014 (print-length nil
) (eval-expression-print-length nil
))
1015 (insert "\n;; ----- " (symbol-name list
) " -----\n(\n ")
1016 (setq list
(symbol-value list
))
1018 (let* ((elt (car list
))
1019 (s (if (consp elt
) (car elt
) elt
)))
1020 (if (and (stringp s
) (= (length s
) 0))
1023 (prin1 elt
(current-buffer)))
1024 (if (and (setq list
(cdr list
)) s
)
1025 (insert (or sep
"\n ")))))
1028 (defun ido-save-history ()
1029 "Save ido history and cache information between sessions."
1031 (if (and ido-last-directory-list ido-save-directory-list-file
)
1033 (save-window-excursion
1034 (if (find-buffer-visiting ido-save-directory-list-file
)
1035 (kill-buffer (find-buffer-visiting ido-save-directory-list-file
)))
1036 (if (file-exists-p ido-save-directory-list-file
)
1037 (delete-file ido-save-directory-list-file
))
1038 (set-buffer (let ((enable-local-variables nil
))
1039 (find-file-noselect ido-save-directory-list-file t
)))
1040 (goto-char (point-min))
1041 (delete-region (point-min) (point-max))
1042 (ido-pp 'ido-last-directory-list
)
1043 (ido-pp 'ido-work-directory-list
)
1044 (ido-pp 'ido-work-file-list
)
1045 (ido-pp 'ido-dir-file-cache
"\n\n ")
1047 (let ((version-control 'never
))
1048 (write-file ido-save-directory-list-file nil
))
1049 (kill-buffer (current-buffer))))))
1051 (defun ido-load-history (&optional arg
)
1052 "Load ido history and cache information from previous session.
1053 With prefix argument, reload history unconditionally."
1055 (if (or arg
(and ido-save-directory-list-file
(not ido-last-directory-list
)))
1056 (let ((file (expand-file-name ido-save-directory-list-file
))
1058 (when (file-readable-p file
)
1060 (save-window-excursion
1061 (setq buf
(set-buffer (let ((enable-local-variables nil
))
1062 (find-file-noselect file
))))
1063 (goto-char (point-min))
1065 (setq ido-last-directory-list
(read (current-buffer))
1066 ido-work-directory-list
(read (current-buffer))
1067 ido-work-file-list
(read (current-buffer))
1068 ido-dir-file-cache
(read (current-buffer)))
1070 (kill-buffer buf
))))
1073 (defun ido-wash-history ()
1074 "Clean-up ido history and cache information.
1075 Removes badly formatted data and ignored directories."
1077 ;; Check format of each of our lists, discard bogus elements
1078 (setq ido-last-directory-list
1079 (and (listp ido-last-directory-list
)
1080 (let ((l ido-last-directory-list
) r
)
1082 (if (and (consp (car l
))
1083 (stringp (car (car l
)))
1084 (stringp (cdr (car l
))))
1085 (setq r
(cons (car l
) r
)))
1088 (setq ido-work-directory-list
1089 (and (listp ido-work-directory-list
)
1090 (let ((l ido-work-directory-list
) r
)
1092 (if (and (stringp (car l
))
1093 (or ido-record-ftp-work-directories
1094 (not (ido-is-ftp-directory (car l
)))))
1095 (setq r
(cons (car l
) r
)))
1098 (setq ido-work-file-list
1099 (and (listp ido-work-file-list
)
1100 (let ((l ido-work-file-list
) r
)
1102 (if (stringp (car l
))
1103 (setq r
(cons (car l
) r
)))
1106 (setq ido-dir-file-cache
1107 (and (listp ido-dir-file-cache
)
1108 (let ((l ido-dir-file-cache
) r
)
1110 (if (and (listp (car l
))
1111 (> (length (car l
)) 2)
1112 (let ((dir (car (car l
)))
1113 (time (car (cdr (car l
))))
1114 (files (cdr (cdr (car l
)))))
1118 (if (integerp (car time
))
1119 (and (/= (car time
) 0)
1120 (integerp (car (cdr time
)))
1121 (/= (car (cdr time
)) 0)
1122 (ido-may-cache-directory dir
))
1123 (and (eq (car time
) 'ftp
)
1124 (numberp (cdr time
))
1125 (ido-is-ftp-directory dir
)
1126 (ido-cache-ftp-valid (cdr time
))))
1127 (let ((s files
) (ok t
))
1129 (if (stringp (car s
))
1131 (setq s nil ok nil
)))
1133 (setq r
(cons (car l
) r
)))
1137 ;; Remove ignored directories from work directory list
1138 ;; according to ido-work-directory-list-ignore-regexps
1139 (if ido-work-directory-list
1140 (let ((dirs (reverse ido-work-directory-list
)))
1141 (setq ido-work-directory-list nil
)
1143 (ido-record-work-directory (car dirs
))
1144 (setq dirs
(cdr dirs
)))))
1145 ;; Get rid of text properties
1146 (let ((l ido-last-directory-list
) e
)
1148 (setq e
(car l
) l
(cdr l
))
1149 (set-text-properties 0 (length (car e
)) nil
(car e
))
1150 (set-text-properties 0 (length (cdr e
)) nil
(cdr e
))))
1151 (let ((l ido-work-directory-list
) e
)
1153 (setq e
(car l
) l
(cdr l
))
1154 (set-text-properties 0 (length e
) nil e
)))
1155 (let ((l ido-work-file-list
) e
)
1157 (setq e
(car l
) l
(cdr l
))
1158 (set-text-properties 0 (length e
) nil e
)))
1159 (let ((l ido-dir-file-cache
) e d
)
1161 (setq e
(car l
) l
(cdr l
))
1164 (setq d
(car e
) e
(cdr e
))
1166 (set-text-properties 0 (length d
) nil d
))))))
1170 (defun ido-kill-emacs-hook ()
1171 ;; ido kill emacs hook
1174 (defvar ido-minor-mode-map-entry nil
)
1177 (defun ido-mode (&optional arg nobind
)
1178 "Toggle ido speed-ups on or off.
1179 With ARG, turn ido speed-up on if arg is positive, off otherwise.
1180 If second argument NOBIND is non-nil, no keys are rebound; otherwise,
1181 turning on ido-mode will modify the default keybindings for the
1182 find-file and switch-to-buffer families of commands to the ido
1183 versions of these functions.
1184 However, if second arg equals 'files, bind only for files, or if it
1185 equals 'buffers, bind only for buffers.
1186 This function also adds a hook to the minibuffer."
1190 ((null arg
) (if ido-mode nil
'both
))
1192 ((eq arg
'files
) 'file
)
1193 ((eq arg
'buffers
) 'buffer
)
1194 ((memq arg
'(file buffer both
)) arg
)
1195 ((> (prefix-numeric-value arg
) 0) 'both
)
1198 (ido-everywhere (if ido-everywhere
1 -
1))
1201 (add-hook 'minibuffer-setup-hook
'ido-minibuffer-setup
)
1202 (add-hook 'choose-completion-string-functions
'ido-choose-completion-string
)
1205 (add-hook 'kill-emacs-hook
'ido-kill-emacs-hook
)
1207 (unless ido-minor-mode-map-entry
1208 (setq ido-minor-mode-map-entry
(cons 'ido-mode
(make-sparse-keymap)))
1209 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry
))
1211 (let ((map (cdr ido-minor-mode-map-entry
)))
1212 (when (memq ido-mode
'(file both
))
1213 (define-key map
[remap find-file
] 'ido-find-file
)
1214 (define-key map
[remap find-file-read-only
] 'ido-find-file-read-only
)
1215 (define-key map
[remap find-alternate-file
] 'ido-find-alternate-file
)
1216 (define-key map
[remap write-file
] 'ido-write-file
)
1217 (define-key map
[remap insert-file
] 'ido-insert-file
)
1218 (define-key map
[remap list-directory
] 'ido-list-directory
)
1219 (define-key map
[remap dired
] 'ido-dired
)
1220 (define-key map
[remap find-file-other-window
] 'ido-find-file-other-window
)
1221 (define-key map
[remap find-file-read-only-other-window
] 'ido-find-file-read-only-other-window
)
1222 (define-key map
[remap find-file-other-frame
] 'ido-find-file-other-frame
)
1223 (define-key map
[remap find-file-read-only-other-frame
] 'ido-find-file-read-only-other-frame
))
1225 (when (memq ido-mode
'(buffer both
))
1226 (define-key map
[remap switch-to-buffer
] 'ido-switch-buffer
)
1227 (define-key map
[remap switch-to-buffer-other-window
] 'ido-switch-buffer-other-window
)
1228 (define-key map
[remap switch-to-buffer-other-frame
] 'ido-switch-buffer-other-frame
)
1229 (define-key map
[remap insert-buffer
] 'ido-insert-buffer
)
1230 (define-key map
[remap kill-buffer
] 'ido-kill-buffer
)
1231 (define-key map
[remap display-buffer
] 'ido-display-buffer
)))))
1233 (defun ido-everywhere (arg)
1234 "Enable ido everywhere file and directory names are read."
1236 (setq ido-everywhere
(if arg
1237 (> (prefix-numeric-value arg
) 0)
1238 (not ido-everywhere
)))
1239 (setq read-file-name-function
1240 (and ido-everywhere
(memq ido-mode
'(both file
))
1241 'ido-read-file-name
))
1242 (setq read-buffer-function
1243 (and ido-everywhere
(memq ido-mode
'(both buffer
))
1248 (defun ido-define-mode-map ()
1249 "Set up the keymap for `ido'."
1251 ;; generated every time so that it can inherit new functions.
1253 (setq map
(copy-keymap minibuffer-local-map
))
1254 (define-key map
"\C-a" 'ido-toggle-ignore
)
1255 (define-key map
"\C-c" 'ido-toggle-case
)
1256 (define-key map
"\C-e" 'ido-edit-input
)
1257 (define-key map
"\t" 'ido-complete
)
1258 (define-key map
" " 'ido-complete-space
)
1259 (define-key map
"\C-j" 'ido-select-text
)
1260 (define-key map
"\C-m" 'ido-exit-minibuffer
)
1261 (define-key map
"\C-p" 'ido-toggle-prefix
)
1262 (define-key map
"\C-r" 'ido-prev-match
)
1263 (define-key map
"\C-s" 'ido-next-match
)
1264 (define-key map
"\C-t" 'ido-toggle-regexp
)
1265 (define-key map
"\C-z" 'ido-undo-merge-work-directory
)
1266 (define-key map
[right] 'ido-next-match)
1267 (define-key map [left] 'ido-prev-match)
1268 (define-key map "?" 'ido-completion-help)
1270 (when (memq ido-cur-item '(file dir))
1271 (define-key map "\C-b" 'ido-enter-switch-buffer)
1272 (define-key map "\C-d" 'ido-enter-dired)
1273 (define-key map "\C-f" 'ido-fallback-command)
1274 (define-key map [down] 'ido-next-match-dir)
1275 (define-key map [up] 'ido-prev-match-dir)
1276 (define-key map [(meta up)] 'ido-prev-work-directory)
1277 (define-key map [(meta down)] 'ido-next-work-directory)
1278 (define-key map [backspace] 'ido-delete-backward-updir)
1279 (define-key map "\d" 'ido-delete-backward-updir)
1280 (define-key map [(meta backspace)] 'ido-delete-backward-word-updir)
1281 (define-key map [(control backspace)] 'ido-up-directory)
1282 (define-key map [(meta ?b)] 'ido-next-work-file)
1283 (define-key map [(meta ?d)] 'ido-wide-find-dir)
1284 (define-key map [(meta ?f)] 'ido-wide-find-file)
1285 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1286 (define-key map [(meta ?m)] 'ido-make-directory)
1287 (define-key map [(meta ?n)] 'ido-next-work-directory)
1288 (define-key map [(meta ?o)] 'ido-prev-work-file)
1289 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1290 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1293 (when (eq ido-cur-item 'file)
1294 (define-key map "\C-k" 'ido-delete-file-at-head)
1295 (define-key map "\C-o" 'ido-copy-current-word)
1296 (define-key map "\C-l" 'ido-reread-directory)
1297 (define-key map "\C-w" 'ido-copy-current-file-name)
1298 (define-key map [(meta ?l)] 'ido-toggle-literal)
1299 (define-key map "\C-v" 'ido-toggle-vc)
1302 (when (eq ido-cur-item 'buffer)
1303 (define-key map "\C-b" 'ido-fallback-command)
1304 (define-key map "\C-f" 'ido-enter-find-file)
1305 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1308 (setq ido-mode-map map)
1309 (run-hooks 'ido-define-mode-map-hook)))
1311 (defun ido-final-slash (dir &optional fix-it)
1312 ;; return DIR if DIR has final slash.
1313 ;; else if FIX-IT is non-nil, return DIR/
1315 (setq dir (ido-name dir))
1317 ((string-match "/\\'" dir) dir)
1318 (fix-it (concat dir "/"))
1321 (defun ido-set-current-directory (dir &optional subdir no-merge)
1322 ;; Set ido's current directory to DIR or DIR/SUBDIR
1323 (setq dir (ido-final-slash dir t))
1324 (setq ido-use-merged-list nil
1325 ido-try-merged-list (not no-merge))
1327 (setq dir (ido-final-slash (concat dir subdir) t)))
1328 (if (equal dir ido-current-directory)
1330 (ido-trace "cd" dir)
1331 (setq ido-current-directory dir)
1332 (if (get-buffer ido-completion-buffer)
1333 (kill-buffer ido-completion-buffer))
1336 (defun ido-set-current-home (&optional dir)
1337 ;; Set ido's current directory to user's home directory
1338 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1340 (defun ido-record-command (command arg)
1341 ;; Add (command arg) to command-history if ido-record-commands is t
1342 (if ido-record-commands
1343 (let ((cmd (list command arg)))
1344 (if (or (not command-history)
1345 (not (equal cmd (car command-history))))
1346 (setq command-history (cons cmd command-history))))))
1348 (defun ido-make-prompt (item prompt)
1349 ;; Make the prompt for ido-read-internal
1351 ((and (memq item '(file dir)) ido-current-directory)
1352 (let ((path (abbreviate-file-name ido-current-directory))
1353 (max-width (if (and ido-max-prompt-path (floatp ido-max-prompt-path))
1354 (floor (* (frame-width) ido-max-prompt-path))
1355 ido-max-prompt-path))
1356 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1357 (vc-off (and ido-saved-vc-mt (not vc-master-templates) "[-VC] "))
1359 (rule ido-rewrite-prompt-path-rules))
1360 (let ((case-fold-search nil))
1362 (if (and (consp (car rule))
1363 (string-match (car (car rule)) path))
1365 (if (stringp (cdr (car rule)))
1366 (replace-match (cdr (car rule)) t nil path)
1367 (funcall (cdr (car rule)) path))))
1368 (setq rule (cdr rule))))
1369 (run-hooks 'ido-make-file-prompt-hook)
1371 ; (if ido-process-ignore-lists "" "&")
1375 (let ((l (length path)))
1376 (if (and max-width (> max-width 0) (> l max-width))
1377 (let* ((s (substring path (- max-width)))
1378 (i (string-match "/" s)))
1379 (concat "..." (if i (substring s i) s)))
1383 ;; Here is very briefly how ido-find-file works:
1386 ;; (ido-file-internal method)
1387 ;; set ido-current-directory
1388 ;; (ido-read-internal 'file ...)
1390 ;; (ido-make-item-list ...)
1391 ;; (ido-set-matches)
1392 ;; (completing-read ... ido-text-init ...)
1394 ;; ... here user is allowed to type characters and commands
1395 ;; a command may set ido-exit and call (exit-minibuffer)
1396 ;; to make ido-read-internal do advanced tasks (or return)
1398 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1399 ;; which are run before and after each user command.
1401 ;; return value from completing-read is stored in ido-final-text
1402 ;; - ido-exit may cause further actions to be taken:
1403 ;; 'refresh - repeat loop (make-item-list, set-matches)
1404 ;; 'edit - edit the prompt string, then repeat loop
1405 ;; 'keep - repeat loop but don't (re)make-item-list
1406 ;; 'updir - go up one directory, repeat loop
1407 ;; else set ido-selected based on ido-final-text,
1408 ;; optionally update ido-current-directory and repeat loop, or
1409 ;; exit with the return value of ido-selected (file name)
1410 ;; selected file name is returned from ido-read-internal,
1411 ;; ido-exit and method determines what action is taken
1412 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1413 ;; the relevant function is called (find-file, write-file, etc).
1415 (defun ido-read-internal (item prompt history &optional default require-match initial)
1416 "Perform the ido-read-buffer and ido-read-file-name functions.
1417 Return the name of a buffer or file selected.
1418 PROMPT is the prompt to give to the user.
1419 DEFAULT if given is the default directory to start with.
1420 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1421 If INITIAL is non-nil, it specifies the initial input string."
1423 ((ido-cur-item item)
1424 (ido-entry-buffer (current-buffer))
1425 (ido-process-ignore-lists t)
1426 (ido-process-ignore-lists-inhibit nil)
1427 (ido-set-default-item t)
1432 (icomplete-mode nil) ;; prevent icomplete starting up
1433 ;; Exported dynamic variables:
1436 (ido-rotate-temp nil)
1437 (ido-keep-item-list nil)
1438 (ido-use-merged-list nil)
1439 (ido-try-merged-list t)
1440 (ido-pre-merge-state nil)
1441 (ido-case-fold ido-case-fold)
1442 (ido-enable-prefix ido-enable-prefix)
1443 (ido-enable-regexp ido-enable-regexp)
1446 (ido-define-mode-map)
1447 (setq ido-text-init initial)
1449 (ido-trace "\n_LOOP_")
1452 (setq ido-rotate nil)
1454 (if ido-set-default-item
1455 (setq ido-default-item
1458 (if (bufferp default) (buffer-name default) default))
1459 ((stringp default) default)
1461 (and ido-enable-last-directory-history
1462 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1464 ido-set-default-item nil))
1466 (if ido-process-ignore-lists-inhibit
1467 (setq ido-process-ignore-lists nil))
1469 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1470 (let ((olist ido-cur-list)
1471 (oign ido-ignored-list)
1473 (l (ido-make-merged-file-list ido-text-init
1474 (eq ido-use-merged-list 'auto)
1475 (eq ido-try-merged-list 'wide))))
1478 (if (eq ido-try-merged-list 'wide)
1479 (setq ido-pre-merge-state
1480 (list "" ido-current-directory olist oign omat)
1482 ido-ignored-list nil
1484 ido-keep-item-list t
1485 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1486 ido-use-merged-list nil)
1487 (setq ido-cur-list olist
1488 ido-ignored-list oign
1490 ido-keep-item-list t
1491 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1492 ido-use-merged-list nil)))
1494 (setq ido-use-merged-list nil))
1496 (setq ido-pre-merge-state
1497 (list ido-text-init ido-current-directory olist oign omat))
1498 (ido-set-current-directory (car (cdr (car l))))
1499 (if (ido-final-slash ido-text-init)
1500 (setq ido-text-init ""))
1501 (setq ido-cur-list l
1502 ido-ignored-list nil
1505 ido-keep-item-list t
1506 ido-use-merged-list t)
1507 (ido-trace "Merged" t)
1512 (setq ido-keep-item-list nil
1514 ((eq ido-cur-item 'file)
1515 (setq ido-ignored-list nil
1516 ido-cur-list (ido-make-file-list ido-default-item)))
1517 ((eq ido-cur-item 'dir)
1518 (setq ido-ignored-list nil
1519 ido-cur-list (ido-make-dir-list ido-default-item)))
1520 ((eq ido-cur-item 'buffer)
1521 (setq ido-ignored-list nil
1522 ido-cur-list (ido-make-buffer-list ido-default-item)))
1524 (setq ido-rotate-temp nil)
1526 (if ido-process-ignore-lists-inhibit
1527 (setq ido-process-ignore-lists t
1528 ido-process-ignore-lists-inhibit nil))
1531 (if (and ido-matches (eq ido-try-merged-list 'auto))
1532 (setq ido-try-merged-list t))
1534 ((minibuffer-local-completion-map ido-mode-map)
1535 (max-mini-window-height (or ido-max-window-height
1536 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1537 (ido-completing-read t)
1538 (ido-require-match require-match)
1539 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1540 (show-paren-mode nil))
1541 ;; prompt the user for the file name
1543 (setq ido-final-text
1546 (ido-make-prompt item prompt)
1547 '(("dummy" . 1)) nil nil ; table predicate require-match
1548 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1550 (ido-trace "completing-read" ido-final-text)
1551 (if (get-buffer ido-completion-buffer)
1552 (kill-buffer ido-completion-buffer))
1554 (ido-trace "\n_EXIT_" ido-exit)
1557 ((eq ido-exit 'refresh)
1558 (if (and (eq ido-use-merged-list 'auto)
1559 (or (input-pending-p)))
1560 (setq ido-use-merged-list nil
1561 ido-keep-item-list t))
1564 ((eq ido-exit 'done)
1566 ido-selected ido-text
1569 ((memq ido-exit '(edit chdir))
1571 ((memq ido-cur-item '(file dir))
1572 (let* ((process-environment (cons "HOME=/" process-environment)) ;; cheat read-file-name
1573 (read-file-name-function nil)
1574 (edit (eq ido-exit 'edit))
1575 (d ido-current-directory)
1578 (setq ido-text-init "")
1581 (read-file-name (concat prompt "[EDIT] ") d (concat d f) nil f)
1583 d (or (file-name-directory path) "/")
1584 f (file-name-nondirectory path)
1587 (file-directory-p d)
1588 (and (yes-or-no-p (format "Create directory %s? " d))
1590 (progn (make-directory d t) t)
1592 (message "Could not create directory")
1596 (ido-set-current-directory d nil (eq ido-exit 'chdir))
1597 (setq ido-text-init f
1600 (setq ido-text-init nil)
1601 (setq ido-text-init (read-string (concat prompt "[EDIT] ") ido-final-text))))
1604 ((eq ido-exit 'keep)
1605 (setq ido-keep-item-list t))
1607 ((memq ido-exit '(dired fallback findfile findbuffer))
1610 ((eq ido-exit 'updir)
1611 ;; cannot go up if already at the root-dir (Unix) or at the
1612 ;; root-dir of a certain drive (Windows or MS-DOS).
1613 (or (ido-is-root-directory)
1614 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1615 (setq ido-set-default-item t))
1617 ;; Handling the require-match must be done in a better way.
1618 ((and require-match (not (ido-existing-item-p)))
1619 (error "must specify valid item"))
1623 (if (and ido-matches (equal ido-final-text ""))
1624 (ido-name (car ido-matches)) ;; possibly choose the default file
1625 (if (or (eq ido-exit 'takeprompt)
1628 ;; else take head of list
1629 (ido-name (car ido-matches)))))
1635 ((string-equal "./" ido-selected)
1638 ((string-equal "../" ido-selected)
1639 ;; cannot go up if already at the root-dir (Unix) or at the
1640 ;; root-dir of a certain drive (Windows or MS-DOS).
1641 (or (ido-is-root-directory)
1642 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1643 (setq ido-set-default-item t))
1645 ((and (string-equal ido-current-directory "/")
1646 (string-match "..:\\'" ido-selected)) ;; Ange-ftp
1647 (ido-set-current-directory "/" ido-selected)
1648 (if (ido-is-slow-ftp-host)
1649 (setq ido-exit 'fallback
1651 (setq ido-set-default-item t)))
1653 ((or (string-match "[/\\][^/\\]" ido-selected)
1654 (and (memq system-type '(windows-nt ms-dos))
1655 (string-match "\\`.:" ido-selected)))
1656 (ido-set-current-directory (file-name-directory ido-selected))
1657 (setq ido-set-default-item t))
1659 ((string-match "\\`~" ido-selected)
1660 (ido-set-current-home ido-selected))
1662 ((ido-final-slash ido-selected)
1663 (if ido-enable-last-directory-history
1664 (let ((x (assoc ido-current-directory ido-last-directory-list)))
1666 (setcdr x ido-selected)
1667 (setq ido-last-directory-list
1668 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
1669 (ido-set-current-directory ido-current-directory ido-selected)
1670 (setq ido-set-default-item t))
1676 (defun ido-edit-input ()
1677 "Edit ido path and input string. Terminate by RET."
1679 (setq ido-text-init ido-text)
1680 (setq ido-exit 'edit)
1684 (defun ido-buffer-internal (method &optional fallback prompt default initial)
1685 ;; Internal function for ido-switch-buffer and friends
1687 (call-interactively (or fallback 'switch-to-buffer))
1688 (let ((buf (ido-read-buffer (or prompt "Buffer: ") default nil initial)))
1690 ;; Choose the buffer name: either the text typed in, or the head
1691 ;; of the list of matches
1694 ((eq ido-exit 'findfile)
1695 (ido-file-internal ido-default-file-method nil nil nil nil ido-text))
1697 ((eq ido-exit 'fallback)
1698 (let ((read-buffer-function nil))
1699 (call-interactively (or fallback 'switch-to-buffer))))
1701 ;; Check buf is non-nil.
1704 ;; View buffer if it exists
1706 (if (eq method 'insert)
1708 (ido-record-command 'insert-buffer buf)
1709 (insert-buffer buf))
1710 (ido-visit-buffer buf method t)))
1712 ;; buffer doesn't exist
1713 ((eq ido-create-new-buffer 'never)
1714 (message "no buffer matching `%s'" buf))
1716 ((and (eq ido-create-new-buffer 'prompt)
1717 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
1720 ;; create a new buffer
1722 (setq buf (get-buffer-create buf))
1723 (if (fboundp 'set-buffer-major-mode)
1724 (set-buffer-major-mode buf))
1725 (ido-visit-buffer buf method t))))))
1728 (defun ido-read-buffer (prompt &optional default require-match initial)
1729 "Replacement for the built-in `read-buffer'.
1730 Return the name of a buffer selected.
1731 PROMPT is the prompt to give to the user. DEFAULT if given is the default
1732 buffer to be selected, which will go to the front of the list.
1733 If REQUIRE-MATCH is non-nil, an existing-buffer must be selected.
1734 If INITIAL is non-nil, it specifies the initial input string."
1735 (let ((ido-current-directory nil))
1736 (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match initial)))
1738 (defun ido-record-work-directory (&optional dir)
1739 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
1740 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
1741 (let ((items ido-work-directory-list-ignore-regexps)
1742 (case-fold-search nil))
1743 (while (and items dir)
1744 (if (string-match (car items) dir)
1746 (setq items (cdr items)))
1748 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
1749 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
1750 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
1752 (defun ido-forget-work-directory ()
1754 (when (and ido-current-directory ido-work-directory-list)
1755 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
1756 (when ido-use-merged-list
1757 (ido-undo-merge-work-directory)
1758 (setq ido-exit 'refresh
1759 ido-try-merged-list t
1760 ido-use-merged-list t
1761 ido-text-init ido-text
1763 (exit-minibuffer))))
1765 (defun ido-record-work-file (name)
1766 ;; Save NAME in ido-work-file-list
1767 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
1769 (and ido-work-file-list (equal (car ido-work-file-list) name))
1770 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
1771 (if (> (length ido-work-file-list) ido-max-work-file-list)
1772 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
1774 (defun ido-file-internal (method &optional fallback default prompt item initial)
1775 ;; Internal function for ido-find-file and friends
1776 (let ((ido-current-directory (expand-file-name (or default default-directory)))
1779 (if (or (not ido-mode) (ido-is-slow-ftp-host))
1781 ido-exit 'fallback))
1783 (let (ido-saved-vc-mt
1784 (vc-master-templates (and (boundp 'vc-master-templates) vc-master-templates))
1785 (ido-work-directory-index -1)
1786 (ido-work-file-index -1)
1787 (ido-find-literal nil))
1790 (setq ido-saved-vc-mt vc-master-templates)
1791 (setq filename (ido-read-internal (or item 'file)
1792 (or prompt "Find file: ")
1793 'ido-file-history nil nil initial)))
1795 ;; Choose the file name: either the text typed in, or the head
1796 ;; of the list of matches
1799 ((eq ido-exit 'fallback)
1800 ;; Need to guard setting of default-directory here, since
1801 ;; we don't want to change directory of current buffer.
1802 (let ((default-directory ido-current-directory)
1803 (read-file-name-function nil))
1804 (call-interactively (or fallback 'find-file))))
1806 ((eq ido-exit 'findbuffer)
1807 (ido-buffer-internal ido-default-buffer-method nil nil nil ido-text))
1809 ((eq ido-exit 'dired)
1810 (dired (concat ido-current-directory (or ido-text ""))))
1812 ((eq method 'alt-file)
1813 (ido-record-work-file filename)
1814 (setq default-directory ido-current-directory)
1815 (ido-record-work-directory)
1816 (find-alternate-file filename))
1818 ((memq method '(dired list-directory))
1819 (if (equal filename ".")
1821 (let* ((path (ido-final-slash (concat ido-current-directory filename) t))
1822 (file (substring path 0 -1)))
1824 ((file-directory-p path)
1825 (ido-record-command method path)
1826 (ido-record-work-directory path)
1827 (funcall method path))
1828 ((file-directory-p ido-current-directory)
1830 ((file-exists-p file)
1831 (ido-record-command method ido-current-directory)
1832 (ido-record-work-directory)
1833 (funcall method ido-current-directory)
1834 (if (eq method 'dired)
1835 (dired-goto-file (expand-file-name file))))
1836 ((string-match "[[*?]" filename)
1837 (setq path (concat ido-current-directory filename))
1838 (ido-record-command method path)
1839 (ido-record-work-directory)
1840 (funcall method path))
1841 ((y-or-n-p (format "Directory %s does not exist. Create it " filename))
1842 (ido-record-command method path)
1843 (ido-record-work-directory path)
1844 (make-directory-internal path)
1845 (funcall method path))
1847 ;; put make-directory command on history
1848 (ido-record-command 'make-directory path))))
1849 (t (error "No such directory")))))
1852 (ido-record-work-file filename)
1853 (setq default-directory ido-current-directory)
1854 (ido-record-command 'write-file (concat ido-current-directory filename))
1855 (ido-record-work-directory)
1856 (write-file filename))
1858 ((eq method 'read-only)
1859 (ido-record-work-file filename)
1860 (setq filename (concat ido-current-directory filename))
1861 (ido-record-command fallback filename)
1862 (ido-record-work-directory)
1863 (funcall fallback filename))
1865 ((eq method 'insert)
1866 (ido-record-work-file filename)
1867 (setq filename (concat ido-current-directory filename))
1869 (if ido-find-literal 'insert-file-literally 'insert-file)
1871 (ido-record-work-directory)
1872 (if ido-find-literal
1873 (insert-file-contents-literally filename)
1874 (insert-file-contents filename)))
1877 (ido-record-work-file filename)
1878 (setq filename (concat ido-current-directory filename))
1879 (ido-record-command 'find-file filename)
1880 (ido-record-work-directory)
1881 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
1883 (defun ido-existing-item-p ()
1884 ;; Return non-nil if there is a matching item
1885 (not (null ido-matches)))
1889 (defun ido-set-common-completion ()
1890 ;; Find common completion of `ido-text' in `ido-matches'
1891 ;; The result is stored in `ido-common-match-string'
1893 (setq ido-common-match-string nil)
1894 (if (and ido-matches
1895 (not ido-enable-regexp) ;; testing
1897 (> (length ido-text) 0))
1898 (if (setq val (ido-find-common-substring ido-matches ido-text))
1899 (setq ido-common-match-string val)))
1902 (defun ido-complete ()
1903 "Try and complete the current pattern amongst the file names."
1907 ((and (memq ido-cur-item '(file dir))
1908 (string-match "[$]" ido-text))
1909 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
1910 (if (not (file-exists-p (file-name-directory evar)))
1911 (message "Expansion generates non-existing directory path")
1912 (if (file-directory-p evar)
1913 (ido-set-current-directory evar)
1914 (let ((d (or (file-name-directory evar) "/"))
1915 (f (file-name-nondirectory evar)))
1916 (when (file-directory-p d)
1917 (ido-set-current-directory d)
1918 (setq ido-text-init f))))
1919 (setq ido-exit 'refresh)
1920 (exit-minibuffer))))
1923 (when ido-completion-buffer
1924 (setq this-command 'ido-completion-help)
1925 (ido-completion-help)))
1927 ((= 1 (length ido-matches))
1928 ;; only one choice, so select it.
1931 (t ;; else there could be some completions
1932 (setq res ido-common-match-string)
1933 (if (and (not (memq res '(t nil)))
1934 (not (equal res ido-text)))
1935 ;; found something to complete, so put it in the minibuffer.
1937 ;; move exact match to front if not in prefix mode
1938 (setq ido-rescan (not ido-enable-prefix))
1939 (delete-region (minibuffer-prompt-end) (point))
1941 ;; else nothing to complete
1942 (ido-completion-help)
1945 (defun ido-complete-space ()
1946 "Try completion unless inserting the space makes sense."
1948 (if (and (stringp ido-common-match-string)
1951 ((> (length ido-common-match-string) (length ido-text))
1952 (= (aref ido-common-match-string (length ido-text)) ? ))
1955 (re (concat (regexp-quote ido-text) " "))
1958 (if (string-match re (ido-name (car comp)))
1959 (setq comp nil insert-space t)
1960 (setq comp (cdr comp))))
1966 (defun ido-undo-merge-work-directory (&optional text try refresh)
1967 "Undo or redo last ido directory merge operation.
1968 If no merge has yet taken place, toggle automatic merging option."
1971 (ido-pre-merge-state
1972 (ido-set-current-directory (nth 1 ido-pre-merge-state))
1973 (setq ido-text-init (or text (car ido-pre-merge-state))
1974 ido-cur-list (nth 2 ido-pre-merge-state)
1975 ido-ignored-list (nth 3 ido-pre-merge-state)
1976 ido-matches (nth 4 ido-pre-merge-state)
1977 ido-use-merged-list nil
1978 ido-try-merged-list try
1979 ido-keep-item-list (not refresh)
1982 ido-pre-merge-state nil)
1986 (ido-try-merged-list
1987 (setq ido-try-merged-list nil))
1989 (setq ido-try-merged-list t))
1990 ((not ido-use-merged-list)
1991 (ido-merge-work-directories))))
1993 ;;; TOGGLE FUNCTIONS
1995 (defun ido-toggle-case ()
1996 "Toggle the value of `ido-case-fold'."
1998 (setq ido-case-fold (not ido-case-fold))
1999 ;; ask for list to be regenerated.
2000 (setq ido-rescan t))
2002 (defun ido-toggle-regexp ()
2003 "Toggle the value of `ido-enable-regexp'."
2005 (setq ido-enable-regexp (not ido-enable-regexp))
2006 ;; ask for list to be regenerated.
2007 (setq ido-rescan t))
2009 (defun ido-toggle-prefix ()
2010 "Toggle the value of `ido-enable-prefix'."
2012 (setq ido-enable-prefix (not ido-enable-prefix))
2013 ;; ask for list to be regenerated.
2014 (setq ido-rescan t))
2016 (defun ido-toggle-ignore ()
2017 "Toggle ignoring files specified with `ido-ignore-files'."
2019 (setq ido-process-ignore-lists (not ido-process-ignore-lists))
2020 (setq ido-text-init ido-text)
2021 (setq ido-exit 'refresh)
2024 (defun ido-toggle-vc ()
2025 "Disable version control for this file."
2027 (if (and ido-mode (eq ido-cur-item 'file))
2029 (setq vc-master-templates
2030 (if vc-master-templates nil ido-saved-vc-mt))
2031 (setq ido-text-init ido-text)
2032 (setq ido-exit 'keep)
2033 (exit-minibuffer))))
2035 (defun ido-toggle-literal ()
2036 "Toggle literal reading of this file."
2038 (if (and ido-mode (eq ido-cur-item 'file))
2040 (setq ido-find-literal (not ido-find-literal))
2041 (setq ido-text-init ido-text)
2042 (setq ido-exit 'keep)
2043 (exit-minibuffer))))
2045 (defun ido-reread-directory ()
2046 "Read current directory again.
2047 May be useful if cached version is no longer valid, but directory
2048 timestamp has not changed (e.g. with ftp or on Windows)."
2050 (if (and ido-mode (eq ido-cur-item 'file))
2052 (ido-remove-cached-dir ido-current-directory)
2053 (setq ido-text-init ido-text)
2054 (setq ido-rotate-temp t)
2055 (setq ido-exit 'refresh)
2056 (exit-minibuffer))))
2058 (defun ido-exit-minibuffer ()
2059 "Exit minibuffer, but make sure we have a match if one is needed."
2061 (if (or (not ido-require-match)
2062 (ido-existing-item-p))
2065 (defun ido-select-text ()
2066 "Select the buffer or file named by the prompt.
2067 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2069 (setq ido-exit 'takeprompt)
2072 (defun ido-fallback-command ()
2073 "Fallback to non-ido version of current command."
2075 (setq ido-exit 'fallback)
2078 (defun ido-enter-find-file ()
2079 "Drop into find-file from buffer switching."
2081 (setq ido-exit 'findfile)
2084 (defun ido-enter-switch-buffer ()
2085 "Drop into ido-switch-buffer from file switching."
2087 (setq ido-exit 'findbuffer)
2090 (defun ido-enter-dired ()
2091 "Drop into dired from file switching."
2093 (setq ido-exit 'dired)
2097 (defun ido-up-directory (&optional clear)
2098 "Go up one directory level."
2100 (setq ido-text-init (if clear nil ido-text))
2101 (setq ido-exit 'updir)
2102 (setq ido-rotate-temp t)
2105 (defun ido-delete-backward-updir (count)
2106 "Delete char backwards, or at beginning of buffer, go up one level."
2109 ((= (minibuffer-prompt-end) (point))
2111 (ido-up-directory t)))
2112 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2113 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2115 (delete-backward-char (prefix-numeric-value count)))))
2117 (defun ido-delete-backward-word-updir (count)
2118 "Delete all chars backwards, or at beginning of buffer, go up one level."
2120 (if (= (minibuffer-prompt-end) (point))
2122 (ido-up-directory t))
2123 (backward-kill-word (prefix-numeric-value count))))
2125 (defun ido-get-work-directory (&optional incr must-match)
2126 (let ((n (length ido-work-directory-list))
2127 (i ido-work-directory-index)
2130 (if (or (not ido-text) (= (length ido-text) 0))
2131 (setq must-match nil))
2136 (if (>= i n) (setq i 0))
2137 (if (< i 0) (setq i (1- n))))
2138 (setq dir (nth i ido-work-directory-list))
2140 (not (equal dir ido-current-directory))
2141 (file-directory-p dir)
2142 (or (not must-match)
2144 (if (eq ido-cur-item 'file)
2145 (ido-make-file-list1 dir)
2146 (ido-make-dir-list1 dir)))))
2150 (setq ido-work-directory-index i))
2153 (defun ido-prev-work-directory ()
2154 "Change to next working directory in list."
2156 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2158 (ido-set-current-directory dir)
2159 (setq ido-exit 'refresh)
2160 (setq ido-text-init ido-text)
2161 (setq ido-rotate-temp t)
2162 (exit-minibuffer))))
2164 (defun ido-next-work-directory ()
2165 "Change to previous working directory in list."
2167 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2169 (ido-set-current-directory dir)
2170 (setq ido-exit 'refresh)
2171 (setq ido-text-init ido-text)
2172 (setq ido-rotate-temp t)
2173 (exit-minibuffer))))
2175 (defun ido-merge-work-directories ()
2176 "Search (and merge) work directories for files matching the current input string."
2178 (setq ido-use-merged-list t ido-try-merged-list t)
2179 (setq ido-exit 'refresh)
2180 (setq ido-text-init ido-text)
2181 (setq ido-rotate-temp t)
2184 (defun ido-wide-find-file (&optional file)
2185 "Prompt for FILE to search for using find, starting from current directory."
2188 (setq file (read-string (concat "Wide find file: " ido-current-directory) ido-text)))
2189 (when (> (length file) 0)
2190 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2191 (setq ido-exit 'refresh)
2192 (setq ido-text-init file)
2193 (setq ido-rotate-temp t)
2196 (defun ido-wide-find-dir (&optional dir)
2197 "Prompt for DIR to search for using find, starting from current directory."
2200 (setq dir (read-string (concat "Wide find directory: " ido-current-directory) ido-text)))
2201 (when (> (length dir) 0)
2202 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2203 (setq ido-exit 'refresh)
2204 (setq ido-text-init (ido-final-slash dir t))
2205 (setq ido-rotate-temp t)
2208 (defun ido-make-directory (&optional dir)
2209 "Prompt for DIR to create in current directory."
2212 (setq dir (read-string (concat "Make directory: " ido-current-directory) ido-text)))
2213 (when (> (length dir) 0)
2214 (setq dir (concat ido-current-directory dir))
2215 (unless (file-exists-p dir)
2216 (make-directory dir t)
2217 (ido-set-current-directory dir)
2218 (setq ido-exit 'refresh)
2219 (setq ido-text-init nil)
2220 (setq ido-rotate-temp t)
2221 (exit-minibuffer))))
2223 (defun ido-get-work-file (incr)
2224 (let ((n (length ido-work-file-list))
2225 (i (+ ido-work-file-index incr))
2228 (if (>= i n) (setq i 0))
2229 (if (< i 0) (setq i (1- n))))
2230 (setq name (nth i ido-work-file-list))
2231 (setq ido-work-file-index i)
2234 (defun ido-prev-work-file ()
2235 "Change to next working file name in list."
2237 (let ((name (ido-get-work-file 1)))
2239 (setq ido-text-init name)
2240 (setq ido-exit 'refresh)
2241 (exit-minibuffer))))
2243 (defun ido-next-work-file ()
2244 "Change to previous working file name in list."
2246 (let ((name (ido-get-work-file -1)))
2248 (setq ido-text-init name)
2249 (setq ido-exit 'refresh)
2250 (exit-minibuffer))))
2252 (defun ido-copy-current-file-name (all)
2253 "Insert file name of current buffer.
2254 If repeated, insert text from buffer instead."
2256 (let* ((path (buffer-file-name ido-entry-buffer))
2257 (name (and path (file-name-nondirectory path))))
2261 (not (equal (file-name-directory path) ido-current-directory))
2262 (not (string-match "\\.[^.]*\\'" name)))
2264 (substring name 0 (1+ (match-beginning 0)))))
2265 (setq ido-exit 'refresh
2266 ido-try-merged-list nil)
2267 (exit-minibuffer))))
2269 (defun ido-copy-current-word (all)
2270 "Insert current word (file name or path) from current buffer."
2272 (let ((word (save-excursion
2273 (set-buffer ido-entry-buffer)
2274 (let ((p (point)) start-line end-line start-name name)
2276 (setq start-line (point))
2278 (setq end-line (point))
2280 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
2282 (setq start-name (point))
2283 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
2284 (if (= start-name (point))
2286 (buffer-substring-no-properties start-name (point)))))))
2289 ((string-match "\\`[~/]" word)
2290 (setq ido-text-init word
2291 ido-try-merged-list nil
2293 ((string-match "/" word)
2294 (setq ido-text-init (concat ido-current-directory word)
2295 ido-try-merged-list nil
2298 (setq ido-text-init word
2299 ido-try-merged-list nil
2300 ido-exit 'refresh)))
2301 (exit-minibuffer))))
2303 (defun ido-next-match ()
2304 "Put first element of `ido-matches' at the end of the list."
2307 (let ((next (cadr ido-matches)))
2308 (setq ido-cur-list (ido-chop ido-cur-list next))
2310 (setq ido-rotate t))))
2312 (defun ido-prev-match ()
2313 "Put last element of `ido-matches' at the front of the list."
2316 (let ((prev (car (last ido-matches))))
2317 (setq ido-cur-list (ido-chop ido-cur-list prev))
2319 (setq ido-rotate t))))
2321 (defun ido-next-match-dir ()
2322 "Find next directory in match list.
2323 If work directories have been merged, cycle through directories for
2324 first matching file."
2326 (if ido-use-merged-list
2328 (let* ((elt (car ido-matches))
2330 (when (> (length dirs) 1)
2331 (setcdr elt (ido-chop dirs (cadr dirs))))
2332 (setq ido-rescan nil)))
2333 (let ((cnt (length ido-matches))
2335 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
2338 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2340 (defun ido-prev-match-dir ()
2341 "Find previous directory in match list.
2342 If work directories have been merged, cycle through directories
2343 for first matching file."
2345 (if ido-use-merged-list
2347 (let* ((elt (car ido-matches))
2349 (when (> (length dirs) 1)
2350 (setcdr elt (ido-chop dirs (car (last dirs)))))
2351 (setq ido-rescan nil)))
2352 (let* ((cnt (length ido-matches))
2354 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
2357 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2359 (defun ido-chop (items elem)
2360 "Remove all elements before ELEM and put them at the end of ITEMS."
2365 (setq next (car items))
2366 (if (equal next elem)
2367 (setq ret (append items (nreverse sofar)))
2370 (setq items (cdr items))
2371 (setq sofar (cons next sofar)))))
2374 (defun ido-name (item)
2375 ;; Return file name for current item, whether in a normal list
2376 ;; or a merged work directory list.
2377 (if (consp item) (car item) item))
2380 ;;; CREATE LIST OF ALL CURRENT FILES
2382 (defun ido-all-completions ()
2383 ;; Return unsorted list of all competions.
2384 (let ((ido-process-ignore-lists nil))
2386 ((eq ido-cur-item 'file)
2387 (ido-make-file-list1 ido-current-directory))
2388 ((eq ido-cur-item 'dir)
2389 (ido-make-dir-list1 ido-current-directory))
2390 ((eq ido-cur-item 'buffer)
2391 (ido-make-buffer-list1))
2395 (defun ido-sort-list (items)
2396 ;; Simple list of file or buffer names
2397 (sort items (lambda (a b) (string-lessp a b))))
2399 (defun ido-sort-merged-list (items promote)
2400 ;; Input is list of ("file" . "dir") cons cells.
2401 ;; Output is sorted list of ("file "dir" ...) lists
2402 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
2407 (if (and res (string-equal (car (car res)) (car a)))
2409 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
2410 (if (and promote (string-equal ido-current-directory (cdr a)))
2412 (setq res (cons (list (car a) (cdr a)) res)
2416 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
2417 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
2420 (shell-command-to-string
2421 (concat "find " dir " -name \"" (if prefix "" "*") file "*\" -type " (if finddir "d" "f") " -print"))))
2425 (setq path (car paths)
2428 (if (and (string-match "^/" path)
2429 (file-exists-p path))
2430 (setq d (file-name-directory path)
2431 f (file-name-nondirectory path)
2432 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
2435 (defun ido-flatten-merged-list (items)
2436 ;; Create a list of path names based on a merged directory list.
2439 (let* ((item (car items))
2443 (setq res (cons (concat (car dirs) file) res)
2445 (setq items (cdr items)))
2448 (defun ido-make-merged-file-list (text auto wide)
2450 (message "Searching for `%s'...." text)
2451 (if (and (ido-final-slash text) ido-dir-file-cache)
2453 (setq res (ido-wide-find-dirs-or-files
2454 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
2455 ;; Use list of cached directories
2456 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
2457 (dirs ido-dir-file-cache)
2461 (setq dir (car (car dirs))
2463 (when (and (string-match re dir)
2464 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
2465 (file-directory-p dir))
2466 (setq b (substring dir 0 -1)
2467 f (concat (file-name-nondirectory b) "/")
2468 d (file-name-directory b)
2469 res (cons (cons f d) res))))
2471 (setq dir (car dirs)
2474 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
2475 (setq dir (cdr (cdr dir)))
2479 (if (and (string-match re f)
2480 (not (ido-ignore-item-p f ido-ignore-directories)))
2481 (setq res (cons (cons f d) res)))))
2482 (if (and auto (input-pending-p))
2486 (setq res (ido-wide-find-dirs-or-files
2487 ido-current-directory text ido-enable-prefix nil))
2488 (let ((ido-text text)
2489 (dirs ido-work-directory-list)
2490 (must-match (and text (> (length text) 0)))
2492 (if (and auto (not (member ido-current-directory dirs)))
2493 (setq dirs (cons ido-current-directory dirs)))
2495 (setq dir (car dirs)
2497 (when (and dir (stringp dir)
2498 (or ido-merge-ftp-work-directories
2499 (not (ido-is-ftp-directory dir)))
2500 (file-directory-p dir)
2501 (setq fl (if (eq ido-cur-item 'file)
2502 (ido-make-file-list1 dir t)
2503 (ido-make-dir-list1 dir t))))
2505 (setq fl (ido-set-matches1 fl)))
2507 (setq res (nconc fl res))))
2508 (if (and auto (input-pending-p))
2511 (if (and res (not (eq res t)))
2512 (setq res (ido-sort-merged-list res auto)))
2513 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
2515 (> (length text) 0))
2516 (let ((elt (assoc text res)))
2517 (when (and elt (not (eq elt (car res))))
2518 (setq res (delq elt res))
2519 (setq res (cons elt res)))))
2523 (defun ido-make-buffer-list1 (&optional frame visible)
2524 ;; Return list of non-ignored buffer names
2528 (let ((name (buffer-name x)))
2529 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (memq name visible)))
2531 (buffer-list frame))))
2533 (defun ido-make-buffer-list (default)
2534 ;; Return the current list of buffers.
2535 ;; Currently visible buffers are put at the end of the list.
2536 ;; The hook `ido-make-buflist-hook' is run after the list has been
2537 ;; created to allow the user to further modify the order of the buffer names
2538 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
2539 ;; it is put to the start of the list.
2540 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
2541 (ido-temp-list (ido-make-buffer-list1 (selected-frame) ido-current-buffers)))
2543 (nconc ido-temp-list ido-current-buffers)
2544 (setq ido-temp-list ido-current-buffers))
2548 (delete default ido-temp-list))
2550 (cons default ido-temp-list))))
2551 (run-hooks 'ido-make-buffer-list-hook)
2554 (defun ido-to-end (items)
2555 ;; Move the elements from ITEMS to the end of `ido-temp-list'
2558 (setq ido-temp-list (delq elem ido-temp-list)))
2561 (nconc ido-temp-list items)
2562 (setq ido-temp-list items)))
2564 (defun ido-file-name-all-completions (dir)
2565 ;; Return name of all files in DIR
2566 ;; Uses and updates ido-dir-file-cache
2567 (if (and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
2568 (stringp dir) (> (length dir) 0)
2569 (ido-may-cache-directory dir))
2570 (let* ((cached (assoc dir ido-dir-file-cache))
2571 (ctime (nth 1 cached))
2572 (ftp (ido-is-ftp-directory dir))
2573 (attr (if ftp nil (file-attributes dir)))
2574 (mtime (nth 5 attr))
2576 (when cached ; should we use the cached entry ?
2578 (setq valid (and (eq (car ctime) 'ftp)
2579 (ido-cache-ftp-valid (cdr ctime))))
2581 (setq valid (and (= (car ctime) (car mtime))
2582 (= (car (cdr ctime)) (car (cdr mtime)))))))
2584 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
2587 (if (and ftp (file-readable-p dir))
2588 (setq mtime (cons 'ftp (ido-time-stamp))))
2590 (setq cached (cons dir (cons mtime (file-name-all-completions "" dir)))
2591 ido-dir-file-cache (cons cached ido-dir-file-cache)))
2592 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
2593 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
2595 (cdr (cdr cached))))
2596 (file-name-all-completions "" dir)))
2598 (defun ido-remove-cached-dir (dir)
2599 ;; Remove dir from ido-dir-file-cache
2600 (if (and ido-dir-file-cache
2601 (stringp dir) (> (length dir) 0))
2602 (let ((cached (assoc dir ido-dir-file-cache)))
2604 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
2607 (defun ido-make-file-list1 (dir &optional merged)
2608 ;; Return list of non-ignored files in DIR
2609 ;; If MERGED is non-nil, each file is cons'ed with DIR
2610 (and (file-directory-p dir)
2614 (if (not (ido-ignore-item-p name ido-ignore-files t))
2615 (if merged (cons name dir) name)))
2616 (ido-file-name-all-completions dir)))))
2618 (defun ido-make-file-list (default)
2619 ;; Return the current list of files.
2620 ;; Currently visible files are put at the end of the list.
2621 ;; The hook `ido-make-file-list-hook' is run after the list has been
2622 ;; created to allow the user to further modify the order of the file names
2624 (let ((ido-temp-list (ido-make-file-list1 ido-current-directory)))
2625 (setq ido-temp-list (ido-sort-list ido-temp-list))
2626 (let ((default-directory ido-current-directory))
2627 (ido-to-end ;; move ftp hosts and visited files to end
2629 (lambda (x) (if (or (string-match "..:\\'" x) (get-file-buffer x)) x))
2631 (ido-to-end ;; move . files to end
2633 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2635 (if (and default (member default ido-temp-list))
2636 (if (or ido-rotate-temp ido-rotate-file-list-default)
2637 (unless (equal default (car ido-temp-list))
2638 (let ((l ido-temp-list) k)
2639 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2643 (nconc k ido-temp-list)
2644 (setq ido-temp-list k)))
2646 (delete default ido-temp-list))
2648 (cons default ido-temp-list))))
2649 (when ido-show-dot-for-dired
2650 (setq ido-temp-list (delete "." ido-temp-list))
2651 (setq ido-temp-list (cons "." ido-temp-list)))
2652 (run-hooks 'ido-make-file-list-hook)
2655 (defun ido-make-dir-list1 (dir &optional merged)
2656 ;; Return list of non-ignored subdirs in DIR
2657 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
2658 (and (file-directory-p dir)
2662 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
2663 (if merged (cons name dir) name)))
2664 (ido-file-name-all-completions dir)))))
2666 (defun ido-make-dir-list (default)
2667 ;; Return the current list of directories.
2668 ;; The hook `ido-make-dir-list-hook' is run after the list has been
2669 ;; created to allow the user to further modify the order of the
2670 ;; directory names in this list.
2671 (let ((ido-temp-list (ido-make-dir-list1 ido-current-directory)))
2672 (setq ido-temp-list (ido-sort-list ido-temp-list))
2673 (let ((default-directory ido-current-directory))
2674 (ido-to-end ;; move visited files to end
2676 (lambda (x) (if (get-file-buffer x) x))
2678 (ido-to-end ;; move . files to end
2680 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2682 (if (and default (member default ido-temp-list))
2683 (if (or ido-rotate-temp ido-rotate-file-list-default)
2684 (unless (equal default (car ido-temp-list))
2685 (let ((l ido-temp-list) k)
2686 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2690 (nconc k ido-temp-list)
2691 (setq ido-temp-list k)))
2693 (delete default ido-temp-list))
2695 (cons default ido-temp-list))))
2696 (setq ido-temp-list (delete "." ido-temp-list))
2697 (setq ido-temp-list (cons "." ido-temp-list))
2698 (run-hooks 'ido-make-dir-list-hook)
2701 ;; List of the files visible in the current frame.
2702 (defvar ido-bufs-in-frame)
2704 (defun ido-get-buffers-in-frames (&optional current)
2705 ;; Return the list of buffers that are visible in the current frame.
2706 ;; If optional argument `current' is given, restrict searching to the
2707 ;; current frame, rather than all frames, regardless of value of
2708 ;; `ido-all-frames'.
2709 (let ((ido-bufs-in-frame nil))
2710 (walk-windows 'ido-get-bufname nil
2716 (defun ido-get-bufname (win)
2717 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
2718 (let ((buf (buffer-name (window-buffer win))))
2719 (if (not (member buf ido-bufs-in-frame))
2720 ;; Only add buf if it is not already in list.
2721 ;; This prevents same buf in two different windows being
2722 ;; put into the list twice.
2723 (setq ido-bufs-in-frame
2724 (cons buf ido-bufs-in-frame)))))
2726 ;;; FIND MATCHING ITEMS
2728 (defun ido-set-matches1 (items &optional do-full)
2729 ;; Return list of matches in items
2730 (let* ((case-fold-search ido-case-fold)
2731 (rexq (if ido-enable-regexp ido-text (regexp-quote ido-text)))
2732 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
2733 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" re))
2734 (concat "\\`" re "\\'")))
2735 (prefix-re (and full-re (not ido-enable-prefix)
2736 (concat "\\`" rexq)))
2742 (let ((name (ido-name item)))
2743 (if (string-match re name)
2745 ((and full-re (string-match full-re name))
2746 (setq full-matches (cons item full-matches)))
2747 ((and prefix-re (string-match prefix-re name))
2748 (setq prefix-matches (cons item prefix-matches)))
2749 (t (setq matches (cons item matches))))))
2753 (setq matches (nconc prefix-matches matches)))
2755 (setq matches (nconc full-matches matches)))
2756 (when (and (null matches)
2757 ido-enable-flex-matching
2758 (> (length ido-text) 1)
2759 (not ido-enable-regexp))
2760 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
2761 (if ido-enable-prefix
2762 (setq re (concat "\\`" re)))
2765 (let ((name (ido-name item)))
2766 (if (string-match re name)
2767 (setq matches (cons item matches)))))
2772 (defun ido-set-matches ()
2773 ;; Set `ido-matches' to the list of items matching prompt
2775 (setq ido-matches (ido-set-matches1 (reverse ido-cur-list) (not ido-rotate))
2778 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
2779 ;; Return t if the buffer or file NAME should be ignored.
2780 (and ido-process-ignore-lists re-list
2781 (let ((data (match-data))
2782 (ext-list (and ignore-ext ido-ignore-extensions
2783 completion-ignored-extensions))
2785 (flen (length name)) slen)
2787 (setq nextstr (car ext-list))
2790 (and (>= flen (setq slen (length nextstr)))
2791 (string-equal (substring name (- flen slen)) nextstr)))
2792 ((fboundp nextstr) (funcall nextstr name))
2797 (setq ext-list (cdr ext-list))))
2799 (setq nextstr (car re-list))
2801 ((stringp nextstr) (string-match nextstr name))
2802 ((fboundp nextstr) (funcall nextstr name))
2806 (setq re-list (cdr re-list))))
2807 ;; return the result
2809 (setq ido-ignored-list (cons name ido-ignored-list)))
2810 (set-match-data data)
2814 ;; Private variable used by `ido-word-matching-substring'.
2815 (defvar ido-change-word-sub)
2817 (defun ido-find-common-substring (items subs)
2818 ;; Return common string following SUBS in each element of ITEMS.
2821 ido-change-word-sub)
2822 (setq ido-change-word-sub
2823 (if ido-enable-regexp
2825 (regexp-quote subs)))
2826 (setq res (mapcar #'ido-word-matching-substring items))
2827 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
2828 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
2830 ;; try-completion returns t if there is an exact match.
2831 (let* ((completion-ignore-case ido-case-fold)
2832 (comp (try-completion subs alist)))
2837 (defun ido-word-matching-substring (word)
2838 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
2839 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
2840 (let ((case-fold-search ido-case-fold))
2841 (let ((m (string-match ido-change-word-sub (ido-name word))))
2843 (substring (ido-name word) m)
2847 (defun ido-makealist (res)
2848 ;; Return dotted pair (RES . 1).
2851 (defun ido-choose-completion-string (choice buffer mini-p base-size)
2853 ;; Insert the completion into the buffer where completion was requested.
2854 (if (get-buffer ido-completion-buffer)
2855 (kill-buffer ido-completion-buffer))
2857 ((ido-active t) ;; ido-use-merged-list
2858 (setq ido-current-directory ""
2861 ((not (ido-final-slash choice))
2862 (setq ido-text choice
2865 (ido-set-current-directory ido-current-directory choice)
2866 (setq ido-exit 'refresh)))
2870 (defun ido-completion-help ()
2871 "Show possible completions in a *File Completions* buffer."
2873 (setq ido-rescan nil)
2874 (let ((temp-buf (get-buffer ido-completion-buffer))
2875 display-it full-list)
2876 (if (and (eq last-command this-command) temp-buf)
2878 (let (win (buf (current-buffer)))
2879 (display-buffer temp-buf nil nil)
2880 (set-buffer temp-buf)
2881 (setq win (get-buffer-window temp-buf))
2882 (if (pos-visible-in-window-p (point-max) win)
2883 (if (or ido-completion-buffer-all-completions (boundp 'ido-completion-buffer-full))
2884 (set-window-start win (point-min))
2885 (set (make-local-variable 'ido-completion-buffer-full) t)
2888 (scroll-other-window))
2890 (setq display-it t))
2892 (with-output-to-temp-buffer ido-completion-buffer
2893 (let ((completion-list (ido-sort-list
2895 (ido-use-merged-list
2896 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
2897 ((or full-list ido-completion-buffer-all-completions)
2898 (ido-all-completions))
2900 (copy-sequence (or ido-matches ido-cur-list)))))))
2902 ;; XEmacs extents are put on by default, doesn't seem to be
2903 ;; any way of switching them off.
2904 ;; This obscure code avoids a byte compiler warning in Emacs.
2905 (let ((f 'display-completion-list))
2906 (funcall f completion-list
2909 '(lambda (x y z) (message "doesn't work yet, sorry!"))))
2910 ;; else running Emacs
2911 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
2912 (display-completion-list completion-list)))))))
2914 ;;; KILL CURRENT BUFFER
2915 (defun ido-kill-buffer-at-head ()
2916 "Kill the buffer at the head of `ido-matches'."
2918 (let ((enable-recursive-minibuffers t)
2919 (buf (car ido-matches)))
2922 ;; Check if buffer still exists.
2923 (if (get-buffer buf)
2924 ;; buffer couldn't be killed.
2926 ;; else buffer was killed so remove name from list.
2927 (setq ido-cur-list (delq buf ido-cur-list))))))
2929 ;;; DELETE CURRENT FILE
2930 (defun ido-delete-file-at-head ()
2931 "Delete the file at the head of `ido-matches'."
2933 (let ((enable-recursive-minibuffers t)
2934 (file (car ido-matches)))
2936 (setq file (concat ido-current-directory file)))
2938 (file-exists-p file)
2939 (not (file-directory-p file))
2940 (file-writable-p ido-current-directory)
2941 (yes-or-no-p (concat "Delete " file " ")))
2943 ;; Check if file still exists.
2944 (if (file-exists-p file)
2945 ;; file could not be deleted
2947 ;; else file was killed so remove name from list.
2948 (setq ido-cur-list (delq (car ido-matches) ido-cur-list))))))
2951 ;;; VISIT CHOSEN BUFFER
2952 (defun ido-visit-buffer (buffer method &optional record)
2953 "Visit file named FILE according to METHOD.
2954 Record command in command-history if optional RECORD is non-nil."
2960 (ido-record-command 'kill-buffer buffer))
2961 (kill-buffer buffer))
2963 ((eq method 'samewindow)
2965 (ido-record-command 'switch-to-buffer buffer))
2966 (switch-to-buffer buffer))
2968 ((memq method '(always-frame maybe-frame))
2971 (setq win (ido-window-buffer-p buffer))
2972 (or (eq method 'always-frame)
2973 (y-or-n-p "Jump to frame? ")))
2974 (setq newframe (window-frame win))
2975 (if (fboundp 'select-frame-set-input-focus)
2976 (select-frame-set-input-focus newframe)
2977 (raise-frame newframe)
2978 (select-frame newframe)
2979 (if (not ido-xemacs)
2980 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
2981 (select-window win))
2983 ;; No buffer in other frames...
2985 (ido-record-command 'switch-to-buffer buffer))
2986 (switch-to-buffer buffer)
2989 ((eq method 'otherwindow)
2991 (ido-record-command 'switch-to-buffer buffer))
2992 (switch-to-buffer-other-window buffer))
2994 ((eq method 'display)
2995 (display-buffer buffer))
2997 ((eq method 'otherframe)
2999 (switch-to-buffer-other-frame buffer)
3000 (if (not ido-xemacs)
3001 (if (fboundp 'select-frame-set-input-focus)
3002 (select-frame-set-input-focus (selected-frame))
3003 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
3007 (defun ido-window-buffer-p (buffer)
3008 ;; Return window pointer if BUFFER is visible in another frame.
3009 ;; If BUFFER is visible in the current frame, return nil.
3010 (let ((blist (ido-get-buffers-in-frames 'current)))
3011 ;;If the buffer is visible in current frame, return nil
3012 (if (memq buffer blist)
3014 ;; maybe in other frame or icon
3015 (get-buffer-window buffer 0) ; better than 'visible
3019 ;;; ----------- IDONIZED FUNCTIONS ------------
3022 (defun ido-switch-buffer ()
3023 "Switch to another buffer.
3024 The buffer is displayed according to `ido-default-buffer-method' -- the
3025 default is to show it in the same window, unless it is already visible
3028 As you type in a string, all of the buffers matching the string are
3029 displayed if substring-matching is used \(default). Look at
3030 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
3031 buffer you want, it can then be selected. As you type, most keys have their
3032 normal keybindings, except for the following: \\<ido-mode-map>
3034 RET Select the buffer at the front of the list of matches. If the
3035 list is empty, possibly prompt to create new buffer.
3037 \\[ido-select-text] Select the current prompt as the buffer.
3038 If no buffer is found, prompt for a new one.
3040 \\[ido-next-match] Put the first element at the end of the list.
3041 \\[ido-prev-match] Put the last element at the start of the list.
3042 \\[ido-complete] Complete a common suffix to the current string that
3043 matches all buffers. If there is only one match, select that buffer.
3044 If there is no common suffix, show a list of all matching buffers
3045 in a separate window.
3046 \\[ido-edit-input] Edit input string.
3047 \\[ido-fallback-command] Fallback to non-ido version of current command.
3048 \\[ido-toggle-regexp] Toggle regexp searching.
3049 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3050 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
3051 \\[ido-completion-help] Show list of matching buffers in separate window.
3052 \\[ido-enter-find-file] Drop into ido-find-file.
3053 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
3054 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
3056 (ido-buffer-internal ido-default-buffer-method))
3059 (defun ido-switch-buffer-other-window ()
3060 "Switch to another buffer and show it in another window.
3061 The buffer name is selected interactively by typing a substring.
3062 For details of keybindings, do `\\[describe-function] ido'."
3064 (ido-buffer-internal 'otherwindow 'switch-to-buffer-other-window))
3067 (defun ido-display-buffer ()
3068 "Display a buffer in another window but don't select it.
3069 The buffer name is selected interactively by typing a substring.
3070 For details of keybindings, do `\\[describe-function] ido'."
3072 (ido-buffer-internal 'display 'display-buffer))
3075 (defun ido-kill-buffer ()
3077 The buffer name is selected interactively by typing a substring.
3078 For details of keybindings, do `\\[describe-function] ido'."
3080 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer))))
3083 (defun ido-insert-buffer ()
3084 "Insert contents of a buffer in current buffer after point.
3085 The buffer name is selected interactively by typing a substring.
3086 For details of keybindings, do `\\[describe-function] ido'."
3088 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: "))
3091 (defun ido-switch-buffer-other-frame ()
3092 "Switch to another buffer and show it in another frame.
3093 The buffer name is selected interactively by typing a substring.
3094 For details of keybindings, do `\\[describe-function] ido'."
3097 (ido-buffer-internal 'otherframe)
3098 (call-interactively 'switch-to-buffer-other-frame)))
3101 (defun ido-find-file-in-dir (dir)
3102 "Switch to another file starting from DIR."
3103 (interactive "DDir: ")
3104 (if (not (equal (substring dir -1) "/"))
3105 (setq dir (concat dir "/")))
3106 (ido-file-internal ido-default-file-method nil dir))
3109 (defun ido-find-file ()
3110 "Edit file with name obtained via minibuffer.
3111 The file is displayed according to `ido-default-file-method' -- the
3112 default is to show it in the same window, unless it is already
3113 visible in another frame.
3115 The file name is selected interactively by typing a substring. As you type
3116 in a string, all of the filenames matching the string are displayed if
3117 substring-matching is used \(default). Look at `ido-enable-prefix' and
3118 `ido-toggle-prefix'. When you have found the filename you want, it can
3119 then be selected. As you type, most keys have their normal keybindings,
3120 except for the following: \\<ido-mode-map>
3122 RET Select the file at the front of the list of matches. If the
3123 list is empty, possibly prompt to create new file.
3125 \\[ido-select-text] Select the current prompt as the buffer or file.
3126 If no buffer or file is found, prompt for a new one.
3128 \\[ido-next-match] Put the first element at the end of the list.
3129 \\[ido-prev-match] Put the last element at the start of the list.
3130 \\[ido-complete] Complete a common suffix to the current string that
3131 matches all files. If there is only one match, select that file.
3132 If there is no common suffix, show a list of all matching files
3133 in a separate window.
3134 \\[ido-edit-input] Edit input string (including path).
3135 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
3136 \\[ido-merge-work-directories] search for file in the work directory history.
3137 \\[ido-forget-work-directory] removes current directory from the work directory history.
3138 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
3139 \\[ido-wide-find-file] and \\[ido-wide-find-dir] prompts and uses find to locate files or directories.
3140 \\[ido-make-directory] prompts for a directory to create in current directory.
3141 \\[ido-fallback-command] Fallback to non-ido version of current command.
3142 \\[ido-toggle-regexp] Toggle regexp searching.
3143 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3144 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
3145 \\[ido-toggle-vc] Toggle version control for this file.
3146 \\[ido-toggle-literal] Toggle literal reading of this file.
3147 \\[ido-completion-help] Show list of matching files in separate window.
3148 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
3151 (ido-file-internal ido-default-file-method))
3154 (defun ido-find-file-other-window ()
3155 "Switch to another file and show it in another window.
3156 The file name is selected interactively by typing a substring.
3157 For details of keybindings, do `\\[describe-function] ido-find-file'."
3159 (ido-file-internal 'otherwindow 'find-file-other-window))
3162 (defun ido-find-alternate-file ()
3163 "Switch to another file and show it in another window.
3164 The file name is selected interactively by typing a substring.
3165 For details of keybindings, do `\\[describe-function] ido-find-file'."
3167 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
3170 (defun ido-find-file-read-only ()
3171 "Edit file read-only with name obtained via minibuffer.
3172 The file name is selected interactively by typing a substring.
3173 For details of keybindings, do `\\[describe-function] ido-find-file'."
3175 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
3178 (defun ido-find-file-read-only-other-window ()
3179 "Edit file read-only in other window with name obtained via minibuffer.
3180 The file name is selected interactively by typing a substring.
3181 For details of keybindings, do `\\[describe-function] ido-find-file'."
3183 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
3186 (defun ido-find-file-read-only-other-frame ()
3187 "Edit file read-only in other frame with name obtained via minibuffer.
3188 The file name is selected interactively by typing a substring.
3189 For details of keybindings, do `\\[describe-function] ido-find-file'."
3191 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
3194 (defun ido-display-file ()
3195 "Display a file in another window but don't select it.
3196 The file name is selected interactively by typing a substring.
3197 For details of keybindings, do `\\[describe-function] ido-find-file'."
3199 (ido-file-internal 'display))
3202 (defun ido-find-file-other-frame ()
3203 "Switch to another file and show it in another frame.
3204 The file name is selected interactively by typing a substring.
3205 For details of keybindings, do `\\[describe-function] ido-find-file'."
3207 (ido-file-internal 'otherframe 'find-file-other-frame))
3210 (defun ido-write-file ()
3211 "Write current buffer to a file.
3212 The file name is selected interactively by typing a substring.
3213 For details of keybindings, do `\\[describe-function] ido-find-file'."
3215 (let ((ido-process-ignore-lists t)
3216 (ido-work-directory-match-only nil)
3217 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
3218 (ido-report-no-match nil)
3219 (ido-auto-merge-work-directories-length -1))
3220 (ido-file-internal 'write 'write-file nil "Write file: ")))
3223 (defun ido-insert-file ()
3224 "Insert contents of file in current buffer.
3225 The file name is selected interactively by typing a substring.
3226 For details of keybindings, do `\\[describe-function] ido-find-file'."
3228 (ido-file-internal 'insert 'insert-file nil "Insert file: "))
3232 "Call dired the ido way.
3233 The directory is selected interactively by typing a substring.
3234 For details of keybindings, do `\\[describe-function] ido-find-file'."
3236 (let ((ido-report-no-match nil)
3237 (ido-auto-merge-work-directories-length -1))
3238 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
3240 (defun ido-list-directory ()
3241 "Call list-directory the ido way.
3242 The directory is selected interactively by typing a substring.
3243 For details of keybindings, do `\\[describe-function] ido-find-file'."
3245 (let ((ido-report-no-match nil)
3246 (ido-auto-merge-work-directories-length -1))
3247 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
3249 ;;; XEmacs hack for showing default buffer
3251 ;; The first time we enter the minibuffer, Emacs puts up the default
3252 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
3253 ;; subtle difference in the two versions of post-command-hook. The
3254 ;; default is shown for both whenever we delete all of our text
3255 ;; though, indicating its just a problem the first time we enter the
3256 ;; function. To solve this, we use another entry hook for emacs to
3257 ;; show the default the first time we enter the minibuffer.
3260 ;;; ICOMPLETE TYPE CODE
3262 (defun ido-initiate-auto-merge (buffer)
3263 (ido-trace "\n*merge timeout*" buffer)
3264 (setq ido-auto-merge-timer nil)
3265 (when (and (buffer-live-p buffer)
3266 (= ido-use-mycompletion-depth (minibuffer-depth))
3267 (boundp 'ido-eoinput) ido-eoinput)
3268 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
3269 (ido-trace "request merge")
3270 (setq ido-use-merged-list 'auto
3271 ido-text-init contents
3277 (throw 'ido contents))))
3279 (defun ido-exhibit ()
3280 "Post command hook for `ido'."
3281 ;; Find matching files and display a list in the minibuffer.
3282 ;; Copied from `icomplete-exhibit' with two changes:
3283 ;; 1. It prints a default file name when there is no text yet entered.
3284 ;; 2. It calls my completion routine rather than the standard completion.
3286 (if (= ido-use-mycompletion-depth (minibuffer-depth))
3287 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
3288 (buffer-undo-list t)
3289 try-single-dir-match)
3291 (ido-trace "\nexhibit" this-command)
3292 (ido-trace "dir" ido-current-directory)
3293 (ido-trace "contents" contents)
3294 (ido-trace "list" ido-cur-list)
3295 (ido-trace "matches" ido-matches)
3296 (ido-trace "rescan" ido-rescan)
3299 (goto-char (point-max))
3300 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
3301 (if (not (boundp 'ido-eoinput))
3302 ;; In case it got wiped out by major mode business:
3303 (make-local-variable 'ido-eoinput))
3304 (setq ido-eoinput (point))
3306 ;; Handle explicit directory changes
3308 (memq ido-cur-item '(file dir))
3309 (> (length contents) 1)
3311 ((ido-final-slash contents) ;; xxx/
3312 (ido-trace "final slash" contents)
3314 ((string-equal contents "~/")
3315 (ido-set-current-home)
3317 ((string-equal contents "../")
3318 (ido-up-directory t)
3320 ((string-equal contents "./")
3322 ((string-match contents "\\`~[a-zA-Z0-9]/\\'")
3323 (ido-set-current-home contents)
3325 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
3326 (let ((exp (condition-case ()
3328 (substitute-in-file-name (substring contents 0 -1))
3329 ido-current-directory)
3331 (ido-trace contents exp)
3332 (if (and exp (file-directory-p exp))
3334 (ido-set-current-directory (file-name-directory exp))
3335 (setq ido-text-init (file-name-nondirectory exp))
3338 ((and (memq system-type '(windows-nt ms-dos))
3339 (string-equal (substring contents 1) ":/"))
3340 (ido-set-current-directory (file-name-directory contents))
3342 ((string-equal (substring contents -2 -1) "/")
3343 (ido-set-current-directory
3344 (if (memq system-type '(windows-nt ms-dos))
3345 (expand-file-name "/" ido-current-directory)
3349 (setq try-single-dir-match t)
3352 ((and (string-equal ido-current-directory "/")
3353 (string-match "..:\\'" contents)) ;; Ange-ftp
3354 (ido-set-current-directory "/" contents)
3355 (when (ido-is-slow-ftp-host)
3356 (setq ido-exit 'fallback)
3360 ((and (string-equal (substring contents -2 -1) "/")
3361 (not (string-match "[$]" contents)))
3362 (ido-set-current-directory
3364 ((= (length contents) 2)
3367 (concat ido-current-directory (car ido-matches)))
3369 (concat ido-current-directory (substring contents 0 -1)))))
3370 (setq ido-text-init (substring contents -1))
3373 ((and (not ido-use-merged-list)
3374 (not (ido-final-slash contents))
3375 (eq ido-try-merged-list t)
3376 (numberp ido-auto-merge-work-directories-length)
3377 (> ido-auto-merge-work-directories-length 0)
3378 (= (length contents) ido-auto-merge-work-directories-length)
3379 (not (and ido-auto-merge-inhibit-characters-regexp
3380 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3381 (not (input-pending-p)))
3382 (setq ido-use-merged-list 'auto
3383 ido-text-init contents
3387 (ido-trace "refresh on /" ido-text-init)
3388 (setq ido-exit 'refresh)
3391 ;; Update the list of matches
3392 (setq ido-text contents)
3394 (ido-trace "new " ido-matches)
3396 (when (and ido-enter-single-matching-directory
3398 (null (cdr ido-matches))
3399 (ido-final-slash (car ido-matches))
3400 (or try-single-dir-match
3401 (eq ido-enter-single-matching-directory t)))
3402 (ido-trace "single match" (car ido-matches))
3403 (ido-set-current-directory
3404 (concat ido-current-directory (car ido-matches)))
3405 (setq ido-exit 'refresh)
3408 (when (and (not ido-matches)
3410 ido-process-ignore-lists
3412 (let ((ido-process-ignore-lists nil)
3413 (ido-rotate ido-rotate)
3414 (ido-cur-list ido-ignored-list))
3415 (ido-trace "try all" ido-ignored-list)
3418 (ido-trace "found " ido-matches)
3420 (setq ido-process-ignore-lists-inhibit t)
3421 (setq ido-text-init ido-text)
3422 (setq ido-exit 'refresh)
3428 (memq ido-cur-item '(file dir))
3429 (not (ido-is-root-directory))
3430 (> (length contents) 1)
3431 (not (string-match "[$]" contents)))
3432 (ido-trace "merge?")
3433 (if ido-use-merged-list
3434 (ido-undo-merge-work-directory contents nil)
3435 (when (and (eq ido-try-merged-list t)
3436 (numberp ido-auto-merge-work-directories-length)
3437 (= ido-auto-merge-work-directories-length 0)
3438 (not (and ido-auto-merge-inhibit-characters-regexp
3439 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3440 (not (input-pending-p)))
3441 (ido-trace "\n*start timer*")
3442 (setq ido-auto-merge-timer
3443 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
3447 (if (and ido-use-merged-list
3449 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
3451 (ido-set-current-directory (car (cdr (car ido-matches))))
3452 (setq ido-use-merged-list t
3454 ido-text-init ido-text)
3457 ;; Insert the match-status information:
3458 (ido-set-common-completion)
3459 (let ((inf (ido-completions
3461 minibuffer-completion-table
3462 minibuffer-completion-predicate
3463 (not minibuffer-completion-confirm))))
3464 (ido-trace "inf" inf)
3469 (defun ido-completions (name candidates predicate require-match)
3470 ;; Return the string that is displayed after the user's text.
3471 ;; Modified from `icomplete-completions'.
3473 (let* ((comps ido-matches)
3474 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
3475 ido-merged-indicator))
3478 (if (and ind ido-use-faces)
3479 (put-text-property 0 1 'face 'ido-indicator-face ind))
3481 (if (and ido-use-faces comps)
3482 (let* ((fn (ido-name (car comps)))
3484 (setq first (format "%s" fn))
3485 (put-text-property 0 ln 'face
3486 (if (= (length comps) 1)
3487 'ido-only-match-face
3488 'ido-first-match-face)
3490 (if ind (setq first (concat first ind)))
3491 (setq comps (cons first (cdr comps)))))
3494 (if ido-report-no-match
3495 (nth 6 ido-decorations) ;; [No Match]
3498 ((null (cdr comps)) ;one match
3499 (concat (if (> (length (ido-name (car comps))) (length name))
3500 ;; when there is one match, show the matching file name in full
3501 (concat (nth 4 ido-decorations) ;; [ ... ]
3502 (ido-name (car comps))
3503 (nth 5 ido-decorations))
3505 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
3506 (t ;multiple matches
3507 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
3515 (setq com (ido-name com))
3516 (setq items (1- items))
3519 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
3521 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
3522 (let ((str (substring com 0)))
3523 (if (and ido-use-faces
3524 (not (string= str first))
3525 (ido-final-slash str))
3526 (put-text-property 0 (length str) 'face 'ido-subdir-face str))
3531 ;; put in common completion item -- what you get by pressing tab
3532 (if (and (stringp ido-common-match-string)
3533 (> (length ido-common-match-string) (length name)))
3534 (concat (nth 4 ido-decorations) ;; [ ... ]
3535 (substring ido-common-match-string (length name))
3536 (nth 5 ido-decorations)))
3537 ;; list all alternatives
3538 (nth 0 ido-decorations) ;; { ... }
3540 (nth 1 ido-decorations)))))))
3542 (defun ido-minibuffer-setup ()
3543 "Minibuffer setup hook for `ido'."
3544 ;; Copied from `icomplete-minibuffer-setup-hook'.
3545 (when (and (boundp 'ido-completing-read)
3546 (or ido-xemacs (= ido-use-mycompletion-depth (minibuffer-depth))))
3547 (add-hook 'pre-command-hook 'ido-tidy nil t)
3548 (add-hook 'post-command-hook 'ido-exhibit nil t)
3549 (setq cua-inhibit-cua-keys t)
3552 (goto-char (point-min)))
3553 (run-hooks 'ido-minibuffer-setup-hook)))
3556 "Pre command hook for `ido'."
3557 ;; Remove completions display, if any, prior to new user input.
3558 ;; Copied from `icomplete-tidy'."
3560 (when ido-auto-merge-timer
3561 (ido-trace "\n*cancel timer*" this-command)
3562 (cancel-timer ido-auto-merge-timer)
3563 (setq ido-auto-merge-timer nil))
3565 (if (and (boundp 'ido-use-mycompletion-depth)
3566 (= ido-use-mycompletion-depth (minibuffer-depth)))
3567 (if (and (boundp 'ido-eoinput)
3570 (if (> ido-eoinput (point-max))
3571 ;; Oops, got rug pulled out from under us - reinit:
3572 (setq ido-eoinput (point-max))
3573 (let ((buffer-undo-list t))
3574 (delete-region ido-eoinput (point-max))))
3576 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
3577 (make-local-variable 'ido-eoinput)
3578 (setq ido-eoinput 1))))
3580 (defun ido-summary-buffers-to-end ()
3581 ;; Move the summaries to the end of the buffer list.
3582 ;; This is an example function which can be hooked on to
3583 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
3584 ;; `Summary' or `output\*$'are put to the end of the list.
3585 (let ((summaries (delq nil (mapcar
3588 (string-match "Summary" x)
3589 (string-match "output\\*\\'" x))
3592 (ido-to-end summaries)))
3594 ;;; Helper functions for other programs
3597 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
3598 "Read file name, prompting with PROMPT and completing in directory DIR.
3599 See `read-file-name' for additional parameters."
3600 (message "%S %S %S %S" this-command ido-read-file-name-non-ido
3601 predicate (memq this-command ido-read-file-name-non-ido))
3603 ((or (eq predicate 'file-directory-p)
3604 (memq this-command ido-read-file-name-as-directory-commands))
3605 (ido-read-directory-name prompt dir default-filename mustmatch initial))
3606 ((and (not (memq this-command ido-read-file-name-non-ido))
3607 (or (null predicate) (eq predicate 'file-exists-p)))
3611 (vc-master-templates (and (boundp 'vc-master-templates) vc-master-templates))
3612 (ido-current-directory (expand-file-name (or dir default-directory)))
3613 (ido-work-directory-index -1)
3614 (ido-work-file-index -1)
3615 (ido-find-literal nil))
3617 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
3619 (concat ido-current-directory filename))))
3621 (let ((read-file-name-function nil))
3622 (read-file-name prompt dir default-filename mustmatch initial predicate)))))
3625 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
3626 "Read directory name, prompting with PROMPT and completing in directory DIR.
3627 See `read-file-name' for additional parameters."
3630 (ido-current-directory (expand-file-name (or dir default-directory)))
3631 (ido-work-directory-index -1)
3632 (ido-work-file-index -1))
3634 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
3636 (if (and (stringp filename) (string-equal filename "."))
3637 ido-current-directory
3638 (concat ido-current-directory filename)))))
3640 ;;; ido.el ends here