* xscheme.el (scheme-interaction-mode): Doc fix.
[emacs.git] / lisp / ido.el
blob054c084968e219ce555485cfceb1139886065f0a
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)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; 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.
26 ;;; Acknowledgements
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.
36 ;;; History
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
43 ;; switch buffers.
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.
65 ;;; Commentary:
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.
89 ;; Example:
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}
97 ;; If I then press 2:
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.
110 ;; So, I press TAB:
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
123 ;; to that buffer.
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
177 ;; buffers or files.
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.
197 ;; Prefix matching
198 ;; ---------------
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.
209 ;; Example:
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.
215 ;; Flexible matching
216 ;; -----------------
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.
226 ;; Example:
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.
233 ;; Regexp matching
234 ;; ---------------
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.
248 ;; Customization
249 ;; -------------
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)
259 ;; )
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
278 ;; separate buffer.
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.)
297 ;; Highlighting
298 ;; ------------
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
302 ;; ido-subdir-face.
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.
325 ;;; Code:
327 (provide 'ido)
329 ;;; User Variables
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)))
336 (defgroup ido nil
337 "Switch between files using substrings."
338 :group 'extensions
339 :group 'convenience
340 :link '(emacs-commentary-link :tag "Commentary" "ido.el")
341 :link '(emacs-library-link :tag "Lisp File" "ido.el"))
343 ;;;###autoload
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,
348 displaying...)
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)
356 (ido-mode value))
357 :initialize 'custom-initialize-default
358 :require 'ido
359 :link '(emacs-commentary-link "ido.el")
360 :set-after '(ido-save-directory-list-file)
361 :version "21.4"
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))
366 :group 'ido)
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
375 :type 'boolean
376 :group 'ido)
378 (defcustom ido-case-fold case-fold-search
379 "*Non-nil if searching of buffer and file names should ignore case."
380 :type 'boolean
381 :group 'ido)
383 (defcustom ido-ignore-buffers
384 '("\\` ")
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))
390 :group 'ido)
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))
399 :group 'ido)
401 (defcustom ido-ignore-extensions t
402 "*Non-nil means ignore files in completion-ignored-extensions list."
403 :type 'boolean
404 :group 'ido)
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'."
409 :type 'boolean
410 :group 'ido)
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))
416 :group 'ido)
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))
423 :group 'ido)
425 ;;; Examples for setting the value of ido-ignore-buffers
426 ;(defun ido-ignore-c-mode (name)
427 ; "Ignore all c mode buffers -- example function for ido."
428 ; (save-excursion
429 ; (set-buffer name)
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'.
439 Possible values:
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)
450 (const otherwindow)
451 (const display)
452 (const otherframe)
453 (const maybe-frame)
454 (const always-frame))
455 :group 'ido)
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)
461 (const otherwindow)
462 (const display)
463 (const otherframe)
464 (const maybe-frame)
465 (const always-frame))
466 :group 'ido)
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."
473 :type 'boolean
474 :group 'ido)
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'."
480 :type 'boolean
481 :group 'ido)
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'."
489 :type 'boolean
490 :group 'ido)
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."
495 :type 'boolean
496 :group 'ido)
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."
502 :type 'integer
503 :group 'ido)
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."
508 :type '(choice
509 (integer :tag "Characters" :value 20)
510 (restricted-sexp :tag "Fraction of frame width"
511 :value 0.35
512 :match-alternatives (ido-fractionp)))
513 :group 'ido)
515 (defcustom ido-max-window-height nil
516 "*Non-nil specifies a value to override `max-mini-window-height'."
517 :type '(choice
518 (const :tag "Don't override" nil)
519 (integer :tag "Number of lines" :value 1)
520 (restricted-sexp
521 :tag "Fraction of window height"
522 :value 0.25
523 :match-alternatives (ido-fractionp)))
524 :group 'ido)
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'."
529 :type 'boolean
530 :group 'ido)
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'."
536 :type 'integer
537 :group 'ido)
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)
544 :group 'ido)
546 (defcustom ido-record-ftp-work-directories t
547 "*Non-nil means that ftp paths are recorded in work directory list."
548 :type 'boolean
549 :group 'ido)
551 (defcustom ido-merge-ftp-work-directories nil
552 "*Nil means that ftp paths in work directory list are ignored during merge."
553 :type 'boolean
554 :group 'ido)
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."
559 :type 'number
560 :group 'ido)
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)
567 :group 'ido)
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)
572 :group 'ido)
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'."
578 :type 'integer
579 :group 'ido)
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."
586 :type 'boolean
587 :group 'ido)
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."
594 :type 'integer
595 :group 'ido)
597 (defcustom ido-auto-merge-delay-time 0.70
598 "*Delay in seconds to wait for more input before doing auto merge."
599 :type 'number
600 :group 'ido)
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."
605 :type 'regexp
606 :group 'ido)
608 (defcustom ido-merged-indicator "^"
609 "The string appended to first choice if it has multiple directory choices."
610 :type 'string
611 :group 'ido)
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'."
622 :type 'integer
623 :group 'ido)
625 (defcustom ido-rotate-file-list-default nil
626 "*Non-nil means that `ido' will always rotate file list to get default in front."
627 :type 'boolean
628 :group 'ido)
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))
636 :group 'ido)
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)
643 (const prompt)
644 (const never))
645 :group 'ido)
647 (defcustom ido-define-mode-map-hook nil
648 "*Hook to define keys in `ido-mode-map' for extra keybindings."
649 :type 'hook
650 :group 'ido)
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))
656 :group 'ido)
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)
669 :group 'ido)
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."
674 :type 'boolean
675 :group 'ido)
677 (defface ido-first-match-face '((t (:bold t)))
678 "*Font used by ido for highlighting first match."
679 :group 'ido)
681 (defface ido-only-match-face '((((class color))
682 (:foreground "ForestGreen"))
683 (t (:italic t)))
684 "*Font used by ido for highlighting only match."
685 :group 'ido)
687 (defface ido-subdir-face '((((class color))
688 (:foreground "red"))
689 (t (:underline t)))
690 "*Font used by ido for highlighting subdirs in the alternatives."
691 :group 'ido)
693 (defface ido-indicator-face '((((class color))
694 (:foreground "yellow"
695 :background "red"
696 :width condensed))
697 (t (:inverse-video t)))
698 "*Font used by ido for highlighting its indicators."
699 :group 'ido)
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."
705 :type 'hook
706 :group 'ido)
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."
712 :type 'hook
713 :group 'ido)
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."
719 :type 'hook
720 :group 'ido)
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
725 variables:
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."
735 :type 'hook
736 :group 'ido)
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."
751 :type 'string
752 :group 'ido)
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."
757 :type 'boolean
758 :group 'ido)
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
772 \(function
773 \(lambda ()
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'."
779 :type 'hook
780 :group 'ido)
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."
787 :type 'string
788 :group 'ido)
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)
795 :group 'ido)
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)
802 :group 'ido)
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...).")
838 (defvar ido-ignore-item-temp-list nil
839 "List of items to ignore in current ido invocation.
840 Intended to be let-bound by functions which calls ido repeatedly.
841 Should never be set permanently.")
843 ;; Temporary storage
845 (defvar ido-eoinput 1
846 "Point where minibuffer input ends and completion info begins.
847 Copied from `icomplete-eoinput'.")
848 (make-variable-buffer-local 'ido-eoinput)
850 (defvar ido-common-match-string nil
851 "Stores the string that is common to all matching files.")
853 (defvar ido-rescan nil
854 "Non-nil means we need to regenerate the list of matching items.")
856 (defvar ido-rotate nil
857 "Non-nil means we are rotating list of matches.")
859 (defvar ido-text nil
860 "Stores the users string as it is typed in.")
862 (defvar ido-text-init nil
863 "The initial string for the users string it is typed in.")
865 (defvar ido-matches nil
866 "List of files currently matching `ido-text'.")
868 (defvar ido-report-no-match t
869 "Report [No Match] when no completions matches ido-text.")
871 (defvar ido-exit nil
872 "Flag to monitor how `ido-find-file' exits.
873 If equal to `takeprompt', we use the prompt as the file name to be
874 selected.")
876 (defvar ido-current-directory nil
877 "Current directory for ido-find-file.")
879 (defvar ido-auto-merge-timer nil
880 "Delay timer for auto merge.")
882 (defvar ido-use-mycompletion-depth 0
883 "Non-nil means use `ido' completion feedback.
884 Is set by ido functions to the current minibuffer-depth, so that
885 it doesn't interfere with other minibuffer usage.")
888 ;;; Variables with dynamic bindings.
889 ;;; Declared here to keep the byte compiler quiet.
891 ;; Stores the current ido item type ('file, 'dir or 'buffer).
892 (defvar ido-cur-item)
894 ;; Stores the current list of items that will be searched through.
895 ;; The list is ordered, so that the most interesting item comes first,
896 ;; although by default, the files visible in the current frame are put
897 ;; at the end of the list. Created by `ido-make-item-list'.
898 (defvar ido-cur-list)
900 ;; Stores the list of items which are ignored when building
901 ;; `ido-cur-list'. It is in no specific order.
902 (defvar ido-ignored-list)
904 ;; Keep current item list if non-nil.
905 (defvar ido-keep-item-list)
907 ;; Process ido-ignore-* lists.
908 (defvar ido-process-ignore-lists)
910 ;; Don't process ido-ignore- lists once.
911 (defvar ido-process-ignore-lists-inhibit)
913 ;; Buffer from which ido was entered.
914 (defvar ido-entry-buffer)
916 ;; Non-nil if matching file must be selected.
917 (defvar ido-require-match)
919 ;; Stores a temporary version of the file list being created.
920 (defvar ido-temp-list)
922 ;; Non-nil if default list element should be rotated into place.
923 (defvar ido-rotate-temp)
925 ;; Stores current index in ido-work-directory-list.
926 (defvar ido-work-directory-index)
928 ;; Stores current index in ido-work-file-list.
929 (defvar ido-work-file-index)
931 ;; Set when merged work directory list is in use.
932 (defvar ido-use-merged-list)
934 ;; Set when merged work directory list not yet built.
935 (defvar ido-try-merged-list)
937 ;; Saved state prior to last work directory merge.
938 ;; Value is a list (ido-text dir cur-list ignored-list matches).
939 (defvar ido-pre-merge-state)
941 ;; Original value of vc-master-templates for use in ido-toggle-vc.
942 (defvar ido-saved-vc-mt)
944 ;; Stores temporary state of literal find file.
945 (defvar ido-find-literal)
948 ;;; FUNCTIONS
950 (defun ido-active (&optional merge)
951 (if merge
952 ido-use-merged-list
953 (and (boundp 'ido-completing-read) (= ido-use-mycompletion-depth (minibuffer-depth)))))
955 (defvar ido-trace-enable nil)
957 (defun ido-trace (p &optional s retval)
958 (if ido-trace-enable
959 (let ((b (get-buffer-create " *IDO Trace*"))
960 (deactivate-mark deactivate-mark))
961 (save-excursion
962 (save-restriction
963 (set-buffer b)
964 (insert p ": " (if (stringp s) s (format "%S" s)) "\n")))))
965 retval)
967 (defun ido-toggle-trace (arg)
968 (interactive "P")
969 (setq ido-trace-enable (or arg (not ido-trace-enable)))
970 (let ((b (get-buffer " *IDO Trace*")))
971 (if b
972 (if ido-trace-enable
973 (kill-buffer b)
974 (pop-to-buffer b t t)))))
976 (defun ido-is-root-directory (&optional dir)
977 (setq dir (or dir ido-current-directory))
978 (if (memq system-type '(windows-nt ms-dos))
979 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir)
980 (string-equal "/" dir)))
982 (defun ido-is-ftp-directory (&optional dir)
983 (string-match "\\`/[^/:][^/:]+:/" (or dir ido-current-directory)))
985 (defun ido-is-slow-ftp-host (&optional dir)
986 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps)
987 (setq dir (or dir ido-current-directory))
988 ;; (featurep 'ange-ftp)
989 ;; (ange-ftp-ftp-name dir)
990 (string-match "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/" dir)
991 (let ((host (substring dir (match-beginning 2) (match-end 2))))
992 (or (member host ido-slow-ftp-hosts)
993 (let ((re ido-slow-ftp-host-regexps))
994 (while (and re (not (string-match (car re) host)))
995 (setq re (cdr re)))
996 re)))))
998 (defun ido-time-stamp (&optional time)
999 ;; Time is a floating point number (fractions of 1 hour)
1000 (setq time (or time (current-time)))
1001 (/ (+ (* (car time) 65536.0) (car (cdr time))) 3600.0))
1003 (defun ido-cache-ftp-valid (&optional time)
1004 (and (numberp ido-cache-ftp-work-directory-time)
1005 (> ido-cache-ftp-work-directory-time 0)
1006 (or (not time)
1007 (< (- (ido-time-stamp) time) ido-cache-ftp-work-directory-time))))
1009 (defun ido-may-cache-directory (&optional dir)
1010 (setq dir (or dir ido-current-directory))
1011 (if (and (memq system-type '(windows-nt ms-dos))
1012 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir))
1014 (or (not (ido-is-ftp-directory dir))
1015 (ido-cache-ftp-valid))))
1017 (defun ido-pp (list &optional sep)
1018 (let ((print-level nil) (eval-expression-print-level nil)
1019 (print-length nil) (eval-expression-print-length nil))
1020 (insert "\n;; ----- " (symbol-name list) " -----\n(\n ")
1021 (setq list (symbol-value list))
1022 (while list
1023 (let* ((elt (car list))
1024 (s (if (consp elt) (car elt) elt)))
1025 (if (and (stringp s) (= (length s) 0))
1026 (setq s nil))
1027 (if s
1028 (prin1 elt (current-buffer)))
1029 (if (and (setq list (cdr list)) s)
1030 (insert (or sep "\n ")))))
1031 (insert "\n)\n")))
1033 (defun ido-save-history ()
1034 "Save ido history and cache information between sessions."
1035 (interactive)
1036 (if (and ido-last-directory-list ido-save-directory-list-file)
1037 (save-excursion
1038 (save-window-excursion
1039 (if (find-buffer-visiting ido-save-directory-list-file)
1040 (kill-buffer (find-buffer-visiting ido-save-directory-list-file)))
1041 (if (file-exists-p ido-save-directory-list-file)
1042 (delete-file ido-save-directory-list-file))
1043 (set-buffer (let ((enable-local-variables nil))
1044 (find-file-noselect ido-save-directory-list-file t)))
1045 (goto-char (point-min))
1046 (delete-region (point-min) (point-max))
1047 (ido-pp 'ido-last-directory-list)
1048 (ido-pp 'ido-work-directory-list)
1049 (ido-pp 'ido-work-file-list)
1050 (ido-pp 'ido-dir-file-cache "\n\n ")
1051 (insert "\n")
1052 (let ((version-control 'never))
1053 (write-file ido-save-directory-list-file nil))
1054 (kill-buffer (current-buffer))))))
1056 (defun ido-load-history (&optional arg)
1057 "Load ido history and cache information from previous session.
1058 With prefix argument, reload history unconditionally."
1059 (interactive "P")
1060 (if (or arg (and ido-save-directory-list-file (not ido-last-directory-list)))
1061 (let ((file (expand-file-name ido-save-directory-list-file))
1062 buf)
1063 (when (file-readable-p file)
1064 (save-excursion
1065 (save-window-excursion
1066 (setq buf (set-buffer (let ((enable-local-variables nil))
1067 (find-file-noselect file))))
1068 (goto-char (point-min))
1069 (condition-case nil
1070 (setq ido-last-directory-list (read (current-buffer))
1071 ido-work-directory-list (read (current-buffer))
1072 ido-work-file-list (read (current-buffer))
1073 ido-dir-file-cache (read (current-buffer)))
1074 (error nil))))
1075 (kill-buffer buf))))
1076 (ido-wash-history))
1078 (defun ido-wash-history ()
1079 "Clean-up ido history and cache information.
1080 Removes badly formatted data and ignored directories."
1081 (interactive)
1082 ;; Check format of each of our lists, discard bogus elements
1083 (setq ido-last-directory-list
1084 (and (listp ido-last-directory-list)
1085 (let ((l ido-last-directory-list) r)
1086 (while l
1087 (if (and (consp (car l))
1088 (stringp (car (car l)))
1089 (stringp (cdr (car l))))
1090 (setq r (cons (car l) r)))
1091 (setq l (cdr l)))
1092 (nreverse r))))
1093 (setq ido-work-directory-list
1094 (and (listp ido-work-directory-list)
1095 (let ((l ido-work-directory-list) r)
1096 (while l
1097 (if (and (stringp (car l))
1098 (or ido-record-ftp-work-directories
1099 (not (ido-is-ftp-directory (car l)))))
1100 (setq r (cons (car l) r)))
1101 (setq l (cdr l)))
1102 (nreverse r))))
1103 (setq ido-work-file-list
1104 (and (listp ido-work-file-list)
1105 (let ((l ido-work-file-list) r)
1106 (while l
1107 (if (stringp (car l))
1108 (setq r (cons (car l) r)))
1109 (setq l (cdr l)))
1110 (nreverse r))))
1111 (setq ido-dir-file-cache
1112 (and (listp ido-dir-file-cache)
1113 (let ((l ido-dir-file-cache) r)
1114 (while l
1115 (if (and (listp (car l))
1116 (> (length (car l)) 2)
1117 (let ((dir (car (car l)))
1118 (time (car (cdr (car l))))
1119 (files (cdr (cdr (car l)))))
1120 (and
1121 (stringp dir)
1122 (consp time)
1123 (if (integerp (car time))
1124 (and (/= (car time) 0)
1125 (integerp (car (cdr time)))
1126 (/= (car (cdr time)) 0)
1127 (ido-may-cache-directory dir))
1128 (and (eq (car time) 'ftp)
1129 (numberp (cdr time))
1130 (ido-is-ftp-directory dir)
1131 (ido-cache-ftp-valid (cdr time))))
1132 (let ((s files) (ok t))
1133 (while s
1134 (if (stringp (car s))
1135 (setq s (cdr s))
1136 (setq s nil ok nil)))
1137 ok))))
1138 (setq r (cons (car l) r)))
1139 (setq l (cdr l)))
1140 (nreverse r))))
1142 ;; Remove ignored directories from work directory list
1143 ;; according to ido-work-directory-list-ignore-regexps
1144 (if ido-work-directory-list
1145 (let ((dirs (reverse ido-work-directory-list)))
1146 (setq ido-work-directory-list nil)
1147 (while dirs
1148 (ido-record-work-directory (car dirs))
1149 (setq dirs (cdr dirs)))))
1150 ;; Get rid of text properties
1151 (let ((l ido-last-directory-list) e)
1152 (while l
1153 (setq e (car l) l (cdr l))
1154 (set-text-properties 0 (length (car e)) nil (car e))
1155 (set-text-properties 0 (length (cdr e)) nil (cdr e))))
1156 (let ((l ido-work-directory-list) e)
1157 (while l
1158 (setq e (car l) l (cdr l))
1159 (set-text-properties 0 (length e) nil e)))
1160 (let ((l ido-work-file-list) e)
1161 (while l
1162 (setq e (car l) l (cdr l))
1163 (set-text-properties 0 (length e) nil e)))
1164 (let ((l ido-dir-file-cache) e d)
1165 (while l
1166 (setq e (car l) l (cdr l))
1167 (if (listp e)
1168 (while e
1169 (setq d (car e) e (cdr e))
1170 (if (not (consp d))
1171 (set-text-properties 0 (length d) nil d))))))
1175 (defun ido-kill-emacs-hook ()
1176 ;; ido kill emacs hook
1177 (ido-save-history))
1179 (defvar ido-minor-mode-map-entry nil)
1181 ;;;###autoload
1182 (defun ido-mode (&optional arg nobind)
1183 "Toggle ido speed-ups on or off.
1184 With ARG, turn ido speed-up on if arg is positive, off otherwise.
1185 If second argument NOBIND is non-nil, no keys are rebound; otherwise,
1186 turning on ido-mode will modify the default keybindings for the
1187 find-file and switch-to-buffer families of commands to the ido
1188 versions of these functions.
1189 However, if second arg equals 'files, bind only for files, or if it
1190 equals 'buffers, bind only for buffers.
1191 This function also adds a hook to the minibuffer."
1192 (interactive "P")
1193 (setq ido-mode
1194 (cond
1195 ((null arg) (if ido-mode nil 'both))
1196 ((eq arg t) 'both)
1197 ((eq arg 'files) 'file)
1198 ((eq arg 'buffers) 'buffer)
1199 ((memq arg '(file buffer both)) arg)
1200 ((> (prefix-numeric-value arg) 0) 'both)
1201 (t nil)))
1203 (ido-everywhere (if ido-everywhere 1 -1))
1205 (when ido-mode
1206 (add-hook 'minibuffer-setup-hook 'ido-minibuffer-setup)
1207 (add-hook 'choose-completion-string-functions 'ido-choose-completion-string)
1208 (ido-load-history)
1210 (add-hook 'kill-emacs-hook 'ido-kill-emacs-hook)
1212 (unless ido-minor-mode-map-entry
1213 (setq ido-minor-mode-map-entry (cons 'ido-mode (make-sparse-keymap)))
1214 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry))
1216 (let ((map (cdr ido-minor-mode-map-entry)))
1217 (when (memq ido-mode '(file both))
1218 (define-key map [remap find-file] 'ido-find-file)
1219 (define-key map [remap find-file-read-only] 'ido-find-file-read-only)
1220 (define-key map [remap find-alternate-file] 'ido-find-alternate-file)
1221 (define-key map [remap write-file] 'ido-write-file)
1222 (define-key map [remap insert-file] 'ido-insert-file)
1223 (define-key map [remap list-directory] 'ido-list-directory)
1224 (define-key map [remap dired] 'ido-dired)
1225 (define-key map [remap find-file-other-window] 'ido-find-file-other-window)
1226 (define-key map [remap find-file-read-only-other-window] 'ido-find-file-read-only-other-window)
1227 (define-key map [remap find-file-other-frame] 'ido-find-file-other-frame)
1228 (define-key map [remap find-file-read-only-other-frame] 'ido-find-file-read-only-other-frame))
1230 (when (memq ido-mode '(buffer both))
1231 (define-key map [remap switch-to-buffer] 'ido-switch-buffer)
1232 (define-key map [remap switch-to-buffer-other-window] 'ido-switch-buffer-other-window)
1233 (define-key map [remap switch-to-buffer-other-frame] 'ido-switch-buffer-other-frame)
1234 (define-key map [remap insert-buffer] 'ido-insert-buffer)
1235 (define-key map [remap kill-buffer] 'ido-kill-buffer)
1236 (define-key map [remap display-buffer] 'ido-display-buffer)))))
1238 (defun ido-everywhere (arg)
1239 "Enable ido everywhere file and directory names are read."
1240 (interactive "P")
1241 (setq ido-everywhere (if arg
1242 (> (prefix-numeric-value arg) 0)
1243 (not ido-everywhere)))
1244 (setq read-file-name-function
1245 (and ido-everywhere (memq ido-mode '(both file))
1246 'ido-read-file-name))
1247 (setq read-buffer-function
1248 (and ido-everywhere (memq ido-mode '(both buffer))
1249 'ido-read-buffer)))
1252 ;;; IDO KEYMAP
1253 (defun ido-define-mode-map ()
1254 "Set up the keymap for `ido'."
1255 (let (map)
1256 ;; generated every time so that it can inherit new functions.
1258 (setq map (copy-keymap minibuffer-local-map))
1259 (define-key map "\C-a" 'ido-toggle-ignore)
1260 (define-key map "\C-c" 'ido-toggle-case)
1261 (define-key map "\C-e" 'ido-edit-input)
1262 (define-key map "\t" 'ido-complete)
1263 (define-key map " " 'ido-complete-space)
1264 (define-key map "\C-j" 'ido-select-text)
1265 (define-key map "\C-m" 'ido-exit-minibuffer)
1266 (define-key map "\C-p" 'ido-toggle-prefix)
1267 (define-key map "\C-r" 'ido-prev-match)
1268 (define-key map "\C-s" 'ido-next-match)
1269 (define-key map "\C-t" 'ido-toggle-regexp)
1270 (define-key map "\C-z" 'ido-undo-merge-work-directory)
1271 (define-key map [right] 'ido-next-match)
1272 (define-key map [left] 'ido-prev-match)
1273 (define-key map "?" 'ido-completion-help)
1275 (when (memq ido-cur-item '(file dir))
1276 (define-key map "\C-b" 'ido-enter-switch-buffer)
1277 (define-key map "\C-d" 'ido-enter-dired)
1278 (define-key map "\C-f" 'ido-fallback-command)
1279 (define-key map [down] 'ido-next-match-dir)
1280 (define-key map [up] 'ido-prev-match-dir)
1281 (define-key map [(meta up)] 'ido-prev-work-directory)
1282 (define-key map [(meta down)] 'ido-next-work-directory)
1283 (define-key map [backspace] 'ido-delete-backward-updir)
1284 (define-key map "\d" 'ido-delete-backward-updir)
1285 (define-key map [(meta backspace)] 'ido-delete-backward-word-updir)
1286 (define-key map [(control backspace)] 'ido-up-directory)
1287 (define-key map [(meta ?b)] 'ido-next-work-file)
1288 (define-key map [(meta ?d)] 'ido-wide-find-dir)
1289 (define-key map [(meta ?f)] 'ido-wide-find-file)
1290 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1291 (define-key map [(meta ?m)] 'ido-make-directory)
1292 (define-key map [(meta ?n)] 'ido-next-work-directory)
1293 (define-key map [(meta ?o)] 'ido-prev-work-file)
1294 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1295 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1298 (when (eq ido-cur-item 'file)
1299 (define-key map "\C-k" 'ido-delete-file-at-head)
1300 (define-key map "\C-o" 'ido-copy-current-word)
1301 (define-key map "\C-l" 'ido-reread-directory)
1302 (define-key map "\C-w" 'ido-copy-current-file-name)
1303 (define-key map [(meta ?l)] 'ido-toggle-literal)
1304 (define-key map "\C-v" 'ido-toggle-vc)
1307 (when (eq ido-cur-item 'buffer)
1308 (define-key map "\C-b" 'ido-fallback-command)
1309 (define-key map "\C-f" 'ido-enter-find-file)
1310 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1313 (setq ido-mode-map map)
1314 (run-hooks 'ido-define-mode-map-hook)))
1316 (defun ido-final-slash (dir &optional fix-it)
1317 ;; return DIR if DIR has final slash.
1318 ;; else if FIX-IT is non-nil, return DIR/
1319 ;; else return nil.
1320 (setq dir (ido-name dir))
1321 (cond
1322 ((string-match "/\\'" dir) dir)
1323 (fix-it (concat dir "/"))
1324 (t nil)))
1326 (defun ido-set-current-directory (dir &optional subdir no-merge)
1327 ;; Set ido's current directory to DIR or DIR/SUBDIR
1328 (setq dir (ido-final-slash dir t))
1329 (setq ido-use-merged-list nil
1330 ido-try-merged-list (not no-merge))
1331 (if subdir
1332 (setq dir (ido-final-slash (concat dir subdir) t)))
1333 (if (equal dir ido-current-directory)
1335 (ido-trace "cd" dir)
1336 (setq ido-current-directory dir)
1337 (if (get-buffer ido-completion-buffer)
1338 (kill-buffer ido-completion-buffer))
1341 (defun ido-set-current-home (&optional dir)
1342 ;; Set ido's current directory to user's home directory
1343 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1345 (defun ido-record-command (command arg)
1346 ;; Add (command arg) to command-history if ido-record-commands is t
1347 (if ido-record-commands
1348 (let ((cmd (list command arg)))
1349 (if (or (not command-history)
1350 (not (equal cmd (car command-history))))
1351 (setq command-history (cons cmd command-history))))))
1353 (defun ido-make-prompt (item prompt)
1354 ;; Make the prompt for ido-read-internal
1355 (cond
1356 ((and (memq item '(file dir)) ido-current-directory)
1357 (let ((path (abbreviate-file-name ido-current-directory))
1358 (max-width (if (and ido-max-prompt-path (floatp ido-max-prompt-path))
1359 (floor (* (frame-width) ido-max-prompt-path))
1360 ido-max-prompt-path))
1361 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1362 (vc-off (and ido-saved-vc-mt (not vc-master-templates) "[-VC] "))
1363 (prefix nil)
1364 (rule ido-rewrite-prompt-path-rules))
1365 (let ((case-fold-search nil))
1366 (while rule
1367 (if (and (consp (car rule))
1368 (string-match (car (car rule)) path))
1369 (setq path
1370 (if (stringp (cdr (car rule)))
1371 (replace-match (cdr (car rule)) t nil path)
1372 (funcall (cdr (car rule)) path))))
1373 (setq rule (cdr rule))))
1374 (run-hooks 'ido-make-file-prompt-hook)
1375 (concat prompt
1376 ; (if ido-process-ignore-lists "" "&")
1377 (or literal "")
1378 (or vc-off "")
1379 (or prefix "")
1380 (let ((l (length path)))
1381 (if (and max-width (> max-width 0) (> l max-width))
1382 (let* ((s (substring path (- max-width)))
1383 (i (string-match "/" s)))
1384 (concat "..." (if i (substring s i) s)))
1385 path)))))
1386 (t prompt)))
1388 ;; Here is very briefly how ido-find-file works:
1390 ;; (ido-find-file)
1391 ;; (ido-file-internal method)
1392 ;; set ido-current-directory
1393 ;; (ido-read-internal 'file ...)
1394 ;; (while ...
1395 ;; (ido-make-item-list ...)
1396 ;; (ido-set-matches)
1397 ;; (completing-read ... ido-text-init ...)
1399 ;; ... here user is allowed to type characters and commands
1400 ;; a command may set ido-exit and call (exit-minibuffer)
1401 ;; to make ido-read-internal do advanced tasks (or return)
1403 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1404 ;; which are run before and after each user command.
1406 ;; return value from completing-read is stored in ido-final-text
1407 ;; - ido-exit may cause further actions to be taken:
1408 ;; 'refresh - repeat loop (make-item-list, set-matches)
1409 ;; 'edit - edit the prompt string, then repeat loop
1410 ;; 'keep - repeat loop but don't (re)make-item-list
1411 ;; 'updir - go up one directory, repeat loop
1412 ;; else set ido-selected based on ido-final-text,
1413 ;; optionally update ido-current-directory and repeat loop, or
1414 ;; exit with the return value of ido-selected (file name)
1415 ;; selected file name is returned from ido-read-internal,
1416 ;; ido-exit and method determines what action is taken
1417 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1418 ;; the relevant function is called (find-file, write-file, etc).
1420 (defun ido-read-internal (item prompt history &optional default require-match initial)
1421 "Perform the ido-read-buffer and ido-read-file-name functions.
1422 Return the name of a buffer or file selected.
1423 PROMPT is the prompt to give to the user.
1424 DEFAULT if given is the default directory to start with.
1425 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1426 If INITIAL is non-nil, it specifies the initial input string."
1427 (let
1428 ((ido-cur-item item)
1429 (ido-entry-buffer (current-buffer))
1430 (ido-process-ignore-lists t)
1431 (ido-process-ignore-lists-inhibit nil)
1432 (ido-set-default-item t)
1433 ido-default-item
1434 ido-selected
1435 ido-final-text
1436 (done nil)
1437 (icomplete-mode nil) ;; prevent icomplete starting up
1438 ;; Exported dynamic variables:
1439 ido-cur-list
1440 ido-ignored-list
1441 (ido-rotate-temp nil)
1442 (ido-keep-item-list nil)
1443 (ido-use-merged-list nil)
1444 (ido-try-merged-list t)
1445 (ido-pre-merge-state nil)
1446 (ido-case-fold ido-case-fold)
1447 (ido-enable-prefix ido-enable-prefix)
1448 (ido-enable-regexp ido-enable-regexp)
1451 (ido-define-mode-map)
1452 (setq ido-text-init initial)
1453 (while (not done)
1454 (ido-trace "\n_LOOP_")
1455 (setq ido-exit nil)
1456 (setq ido-rescan t)
1457 (setq ido-rotate nil)
1458 (setq ido-text "")
1459 (when ido-set-default-item
1460 (setq ido-default-item
1461 (cond
1462 ((eq item 'buffer)
1463 (if (bufferp default) (buffer-name default) default))
1464 ((stringp default) default)
1465 ((eq item 'file)
1466 (and ido-enable-last-directory-history
1467 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1468 (and d (cdr d)))))))
1469 (if (member ido-default-item ido-ignore-item-temp-list)
1470 (setq ido-default-item nil))
1471 (setq ido-set-default-item nil))
1473 (if ido-process-ignore-lists-inhibit
1474 (setq ido-process-ignore-lists nil))
1476 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1477 (let ((olist ido-cur-list)
1478 (oign ido-ignored-list)
1479 (omat ido-matches)
1480 (l (ido-make-merged-file-list ido-text-init
1481 (eq ido-use-merged-list 'auto)
1482 (eq ido-try-merged-list 'wide))))
1483 (cond
1484 ((not l)
1485 (if (eq ido-try-merged-list 'wide)
1486 (setq ido-pre-merge-state
1487 (list "" ido-current-directory olist oign omat)
1488 ido-cur-list nil
1489 ido-ignored-list nil
1490 ido-matches nil
1491 ido-keep-item-list t
1492 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1493 ido-use-merged-list nil)
1494 (setq ido-cur-list olist
1495 ido-ignored-list oign
1496 ido-matches omat
1497 ido-keep-item-list t
1498 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1499 ido-use-merged-list nil)))
1500 ((eq l t)
1501 (setq ido-use-merged-list nil))
1503 (setq ido-pre-merge-state
1504 (list ido-text-init ido-current-directory olist oign omat))
1505 (ido-set-current-directory (car (cdr (car l))))
1506 (if (ido-final-slash ido-text-init)
1507 (setq ido-text-init ""))
1508 (setq ido-cur-list l
1509 ido-ignored-list nil
1510 ido-matches l
1511 ido-rescan nil
1512 ido-keep-item-list t
1513 ido-use-merged-list t)
1514 (ido-trace "Merged" t)
1515 ))))
1517 (cond
1518 (ido-keep-item-list
1519 (setq ido-keep-item-list nil
1520 ido-rescan nil))
1521 ((eq ido-cur-item 'file)
1522 (setq ido-ignored-list nil
1523 ido-cur-list (ido-make-file-list ido-default-item)))
1524 ((eq ido-cur-item 'dir)
1525 (setq ido-ignored-list nil
1526 ido-cur-list (ido-make-dir-list ido-default-item)))
1527 ((eq ido-cur-item 'buffer)
1528 (setq ido-ignored-list nil
1529 ido-cur-list (ido-make-buffer-list ido-default-item)))
1530 (t nil))
1531 (setq ido-rotate-temp nil)
1533 (if ido-process-ignore-lists-inhibit
1534 (setq ido-process-ignore-lists t
1535 ido-process-ignore-lists-inhibit nil))
1537 (ido-set-matches)
1538 (if (and ido-matches (eq ido-try-merged-list 'auto))
1539 (setq ido-try-merged-list t))
1540 (let
1541 ((minibuffer-local-completion-map ido-mode-map)
1542 (max-mini-window-height (or ido-max-window-height
1543 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1544 (ido-completing-read t)
1545 (ido-require-match require-match)
1546 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1547 (show-paren-mode nil))
1548 ;; prompt the user for the file name
1549 (setq ido-exit nil)
1550 (setq ido-final-text
1551 (catch 'ido
1552 (completing-read
1553 (ido-make-prompt item prompt)
1554 '(("dummy" . 1)) nil nil ; table predicate require-match
1555 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1556 history))))
1557 (ido-trace "completing-read" ido-final-text)
1558 (if (get-buffer ido-completion-buffer)
1559 (kill-buffer ido-completion-buffer))
1561 (ido-trace "\n_EXIT_" ido-exit)
1563 (cond
1564 ((eq ido-exit 'refresh)
1565 (if (and (eq ido-use-merged-list 'auto)
1566 (or (input-pending-p)))
1567 (setq ido-use-merged-list nil
1568 ido-keep-item-list t))
1569 nil)
1571 ((eq ido-exit 'done)
1572 (setq done t
1573 ido-selected ido-text
1574 ido-exit nil))
1576 ((memq ido-exit '(edit chdir))
1577 (cond
1578 ((memq ido-cur-item '(file dir))
1579 (let* ((process-environment (cons "HOME=/" process-environment)) ;; cheat read-file-name
1580 (read-file-name-function nil)
1581 (edit (eq ido-exit 'edit))
1582 (d ido-current-directory)
1583 (f ido-text-init)
1584 (path t))
1585 (setq ido-text-init "")
1586 (while path
1587 (setq path (if edit
1588 (read-file-name (concat prompt "[EDIT] ") d (concat d f) nil f)
1590 d (or (file-name-directory path) "/")
1591 f (file-name-nondirectory path)
1592 edit t)
1593 (if (or
1594 (file-directory-p d)
1595 (and (yes-or-no-p (format "Create directory %s? " d))
1596 (condition-case nil
1597 (progn (make-directory d t) t)
1598 (error
1599 (message "Could not create directory")
1600 (sit-for 1)
1601 nil))))
1602 (progn
1603 (ido-set-current-directory d nil (eq ido-exit 'chdir))
1604 (setq ido-text-init f
1605 path nil))))))
1607 (setq ido-text-init nil)
1608 (setq ido-text-init (read-string (concat prompt "[EDIT] ") ido-final-text))))
1609 nil)
1611 ((eq ido-exit 'keep)
1612 (setq ido-keep-item-list t))
1614 ((memq ido-exit '(dired fallback findfile findbuffer))
1615 (setq done t))
1617 ((eq ido-exit 'updir)
1618 ;; cannot go up if already at the root-dir (Unix) or at the
1619 ;; root-dir of a certain drive (Windows or MS-DOS).
1620 (or (ido-is-root-directory)
1621 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1622 (setq ido-set-default-item t))
1624 ;; Handling the require-match must be done in a better way.
1625 ((and require-match (not (ido-existing-item-p)))
1626 (error "must specify valid item"))
1629 (setq ido-selected
1630 (if (or (eq ido-exit 'takeprompt)
1631 (null ido-matches))
1632 ido-final-text
1633 ;; else take head of list
1634 (ido-name (car ido-matches))))
1636 (cond
1637 ((eq item 'buffer)
1638 (setq done t))
1640 ((string-equal "./" ido-selected)
1641 nil)
1643 ((string-equal "../" ido-selected)
1644 ;; cannot go up if already at the root-dir (Unix) or at the
1645 ;; root-dir of a certain drive (Windows or MS-DOS).
1646 (or (ido-is-root-directory)
1647 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1648 (setq ido-set-default-item t))
1649 ((and (string-equal ido-current-directory "/")
1650 (string-match "..:\\'" ido-selected)) ;; Ange-ftp
1651 (ido-set-current-directory "/" ido-selected)
1652 (if (ido-is-slow-ftp-host)
1653 (setq ido-exit 'fallback
1654 done t)
1655 (setq ido-set-default-item t)))
1657 ((or (string-match "[/\\][^/\\]" ido-selected)
1658 (and (memq system-type '(windows-nt ms-dos))
1659 (string-match "\\`.:" ido-selected)))
1660 (ido-set-current-directory (file-name-directory ido-selected))
1661 (setq ido-set-default-item t))
1663 ((string-match "\\`~" ido-selected)
1664 (ido-set-current-home ido-selected))
1666 ((ido-final-slash ido-selected)
1667 (if ido-enable-last-directory-history
1668 (let ((x (assoc ido-current-directory ido-last-directory-list)))
1669 (if x
1670 (setcdr x ido-selected)
1671 (setq ido-last-directory-list
1672 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
1673 (ido-set-current-directory ido-current-directory ido-selected)
1674 (setq ido-set-default-item t))
1677 (setq done t))))))
1678 ido-selected))
1680 (defun ido-edit-input ()
1681 "Edit ido path and input string. Terminate by RET."
1682 (interactive)
1683 (setq ido-text-init ido-text)
1684 (setq ido-exit 'edit)
1685 (exit-minibuffer))
1687 ;;; MAIN FUNCTIONS
1688 (defun ido-buffer-internal (method &optional fallback prompt default initial)
1689 ;; Internal function for ido-switch-buffer and friends
1690 (if (not ido-mode)
1691 (call-interactively (or fallback 'switch-to-buffer))
1692 (let ((buf (ido-read-buffer (or prompt "Buffer: ") default nil initial)))
1694 ;; Choose the buffer name: either the text typed in, or the head
1695 ;; of the list of matches
1697 (cond
1698 ((eq ido-exit 'findfile)
1699 (ido-file-internal ido-default-file-method nil nil nil nil ido-text))
1701 ((eq ido-exit 'fallback)
1702 (let ((read-buffer-function nil))
1703 (call-interactively (or fallback 'switch-to-buffer))))
1705 ;; Check buf is non-nil.
1706 ((not buf) nil)
1707 ((= (length buf) 0) nil)
1709 ;; View buffer if it exists
1710 ((get-buffer buf)
1711 (if (eq method 'insert)
1712 (progn
1713 (ido-record-command 'insert-buffer buf)
1714 (insert-buffer buf))
1715 (ido-visit-buffer buf method t)))
1717 ;; buffer doesn't exist
1718 ((eq ido-create-new-buffer 'never)
1719 (message "no buffer matching `%s'" buf))
1721 ((and (eq ido-create-new-buffer 'prompt)
1722 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
1723 nil)
1725 ;; create a new buffer
1727 (setq buf (get-buffer-create buf))
1728 (if (fboundp 'set-buffer-major-mode)
1729 (set-buffer-major-mode buf))
1730 (ido-visit-buffer buf method t))))))
1732 ;;;###autoload
1733 (defun ido-read-buffer (prompt &optional default require-match initial)
1734 "Replacement for the built-in `read-buffer'.
1735 Return the name of a buffer selected.
1736 PROMPT is the prompt to give to the user. DEFAULT if given is the default
1737 buffer to be selected, which will go to the front of the list.
1738 If REQUIRE-MATCH is non-nil, an existing-buffer must be selected.
1739 If INITIAL is non-nil, it specifies the initial input string."
1740 (let ((ido-current-directory nil))
1741 (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match initial)))
1743 (defun ido-record-work-directory (&optional dir)
1744 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
1745 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
1746 (let ((items ido-work-directory-list-ignore-regexps)
1747 (case-fold-search nil))
1748 (while (and items dir)
1749 (if (string-match (car items) dir)
1750 (setq dir nil))
1751 (setq items (cdr items)))
1752 (if dir
1753 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
1754 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
1755 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
1757 (defun ido-forget-work-directory ()
1758 (interactive)
1759 (when (and ido-current-directory ido-work-directory-list)
1760 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
1761 (when ido-use-merged-list
1762 (ido-undo-merge-work-directory)
1763 (setq ido-exit 'refresh
1764 ido-try-merged-list t
1765 ido-use-merged-list t
1766 ido-text-init ido-text
1767 ido-rotate-temp t)
1768 (exit-minibuffer))))
1770 (defun ido-record-work-file (name)
1771 ;; Save NAME in ido-work-file-list
1772 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
1774 (and ido-work-file-list (equal (car ido-work-file-list) name))
1775 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
1776 (if (> (length ido-work-file-list) ido-max-work-file-list)
1777 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
1779 (defun ido-file-internal (method &optional fallback default prompt item initial)
1780 ;; Internal function for ido-find-file and friends
1781 (let ((ido-current-directory (expand-file-name (or default default-directory)))
1782 filename)
1784 (if (or (not ido-mode) (ido-is-slow-ftp-host))
1785 (setq filename t
1786 ido-exit 'fallback))
1788 (let (ido-saved-vc-mt
1789 (vc-master-templates (and (boundp 'vc-master-templates) vc-master-templates))
1790 (ido-work-directory-index -1)
1791 (ido-work-file-index -1)
1792 (ido-find-literal nil))
1794 (unless filename
1795 (setq ido-saved-vc-mt vc-master-templates)
1796 (setq filename (ido-read-internal (or item 'file)
1797 (or prompt "Find file: ")
1798 'ido-file-history nil nil initial)))
1800 ;; Choose the file name: either the text typed in, or the head
1801 ;; of the list of matches
1803 (cond
1804 ((eq ido-exit 'fallback)
1805 ;; Need to guard setting of default-directory here, since
1806 ;; we don't want to change directory of current buffer.
1807 (let ((default-directory ido-current-directory)
1808 (read-file-name-function nil))
1809 (call-interactively (or fallback 'find-file))))
1811 ((eq ido-exit 'findbuffer)
1812 (ido-buffer-internal ido-default-buffer-method nil nil nil ido-text))
1814 ((eq ido-exit 'dired)
1815 (dired (concat ido-current-directory (or ido-text ""))))
1817 ((eq method 'alt-file)
1818 (ido-record-work-file filename)
1819 (setq default-directory ido-current-directory)
1820 (ido-record-work-directory)
1821 (find-alternate-file filename))
1823 ((memq method '(dired list-directory))
1824 (if (equal filename ".")
1825 (setq filename ""))
1826 (let* ((path (ido-final-slash (concat ido-current-directory filename) t))
1827 (file (substring path 0 -1)))
1828 (cond
1829 ((file-directory-p path)
1830 (ido-record-command method path)
1831 (ido-record-work-directory path)
1832 (funcall method path))
1833 ((file-directory-p ido-current-directory)
1834 (cond
1835 ((file-exists-p file)
1836 (ido-record-command method ido-current-directory)
1837 (ido-record-work-directory)
1838 (funcall method ido-current-directory)
1839 (if (eq method 'dired)
1840 (dired-goto-file (expand-file-name file))))
1841 ((string-match "[[*?]" filename)
1842 (setq path (concat ido-current-directory filename))
1843 (ido-record-command method path)
1844 (ido-record-work-directory)
1845 (funcall method path))
1846 ((y-or-n-p (format "Directory %s does not exist. Create it " filename))
1847 (ido-record-command method path)
1848 (ido-record-work-directory path)
1849 (make-directory-internal path)
1850 (funcall method path))
1852 ;; put make-directory command on history
1853 (ido-record-command 'make-directory path))))
1854 (t (error "No such directory")))))
1856 ((eq method 'write)
1857 (ido-record-work-file filename)
1858 (setq default-directory ido-current-directory)
1859 (ido-record-command 'write-file (concat ido-current-directory filename))
1860 (ido-record-work-directory)
1861 (write-file filename))
1863 ((eq method 'read-only)
1864 (ido-record-work-file filename)
1865 (setq filename (concat ido-current-directory filename))
1866 (ido-record-command fallback filename)
1867 (ido-record-work-directory)
1868 (funcall fallback filename))
1870 ((eq method 'insert)
1871 (ido-record-work-file filename)
1872 (setq filename (concat ido-current-directory filename))
1873 (ido-record-command
1874 (if ido-find-literal 'insert-file-literally 'insert-file)
1875 filename)
1876 (ido-record-work-directory)
1877 (if ido-find-literal
1878 (insert-file-contents-literally filename)
1879 (insert-file-contents filename)))
1881 (filename
1882 (ido-record-work-file filename)
1883 (setq filename (concat ido-current-directory filename))
1884 (ido-record-command 'find-file filename)
1885 (ido-record-work-directory)
1886 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
1888 (defun ido-existing-item-p ()
1889 ;; Return non-nil if there is a matching item
1890 (not (null ido-matches)))
1892 ;;; COMPLETION CODE
1894 (defun ido-set-common-completion ()
1895 ;; Find common completion of `ido-text' in `ido-matches'
1896 ;; The result is stored in `ido-common-match-string'
1897 (let* (val)
1898 (setq ido-common-match-string nil)
1899 (if (and ido-matches
1900 (not ido-enable-regexp) ;; testing
1901 (stringp ido-text)
1902 (> (length ido-text) 0))
1903 (if (setq val (ido-find-common-substring ido-matches ido-text))
1904 (setq ido-common-match-string val)))
1905 val))
1907 (defun ido-complete ()
1908 "Try and complete the current pattern amongst the file names."
1909 (interactive)
1910 (let (res)
1911 (cond
1912 ((and (memq ido-cur-item '(file dir))
1913 (string-match "[$]" ido-text))
1914 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
1915 (if (not (file-exists-p (file-name-directory evar)))
1916 (message "Expansion generates non-existing directory path")
1917 (if (file-directory-p evar)
1918 (ido-set-current-directory evar)
1919 (let ((d (or (file-name-directory evar) "/"))
1920 (f (file-name-nondirectory evar)))
1921 (when (file-directory-p d)
1922 (ido-set-current-directory d)
1923 (setq ido-text-init f))))
1924 (setq ido-exit 'refresh)
1925 (exit-minibuffer))))
1927 ((not ido-matches)
1928 (when ido-completion-buffer
1929 (setq this-command 'ido-completion-help)
1930 (ido-completion-help)))
1932 ((= 1 (length ido-matches))
1933 ;; only one choice, so select it.
1934 (exit-minibuffer))
1936 (t ;; else there could be some completions
1937 (setq res ido-common-match-string)
1938 (if (and (not (memq res '(t nil)))
1939 (not (equal res ido-text)))
1940 ;; found something to complete, so put it in the minibuffer.
1941 (progn
1942 ;; move exact match to front if not in prefix mode
1943 (setq ido-rescan (not ido-enable-prefix))
1944 (delete-region (minibuffer-prompt-end) (point))
1945 (insert res))
1946 ;; else nothing to complete
1947 (ido-completion-help)
1948 )))))
1950 (defun ido-complete-space ()
1951 "Try completion unless inserting the space makes sense."
1952 (interactive)
1953 (if (and (stringp ido-common-match-string)
1954 (stringp ido-text)
1955 (cond
1956 ((> (length ido-common-match-string) (length ido-text))
1957 (= (aref ido-common-match-string (length ido-text)) ? ))
1958 (ido-matches
1959 (let (insert-space
1960 (re (concat (regexp-quote ido-text) " "))
1961 (comp ido-matches))
1962 (while comp
1963 (if (string-match re (ido-name (car comp)))
1964 (setq comp nil insert-space t)
1965 (setq comp (cdr comp))))
1966 insert-space))
1967 (t nil)))
1968 (insert " ")
1969 (ido-complete)))
1971 (defun ido-undo-merge-work-directory (&optional text try refresh)
1972 "Undo or redo last ido directory merge operation.
1973 If no merge has yet taken place, toggle automatic merging option."
1974 (interactive)
1975 (cond
1976 (ido-pre-merge-state
1977 (ido-set-current-directory (nth 1 ido-pre-merge-state))
1978 (setq ido-text-init (or text (car ido-pre-merge-state))
1979 ido-cur-list (nth 2 ido-pre-merge-state)
1980 ido-ignored-list (nth 3 ido-pre-merge-state)
1981 ido-matches (nth 4 ido-pre-merge-state)
1982 ido-use-merged-list nil
1983 ido-try-merged-list try
1984 ido-keep-item-list (not refresh)
1985 ido-rescan nil
1986 ido-exit 'refresh
1987 ido-pre-merge-state nil)
1988 (exit-minibuffer))
1989 (text
1990 nil)
1991 (ido-try-merged-list
1992 (setq ido-try-merged-list nil))
1993 (ido-matches
1994 (setq ido-try-merged-list t))
1995 ((not ido-use-merged-list)
1996 (ido-merge-work-directories))))
1998 ;;; TOGGLE FUNCTIONS
2000 (defun ido-toggle-case ()
2001 "Toggle the value of `ido-case-fold'."
2002 (interactive)
2003 (setq ido-case-fold (not ido-case-fold))
2004 ;; ask for list to be regenerated.
2005 (setq ido-rescan t))
2007 (defun ido-toggle-regexp ()
2008 "Toggle the value of `ido-enable-regexp'."
2009 (interactive)
2010 (setq ido-enable-regexp (not ido-enable-regexp))
2011 ;; ask for list to be regenerated.
2012 (setq ido-rescan t))
2014 (defun ido-toggle-prefix ()
2015 "Toggle the value of `ido-enable-prefix'."
2016 (interactive)
2017 (setq ido-enable-prefix (not ido-enable-prefix))
2018 ;; ask for list to be regenerated.
2019 (setq ido-rescan t))
2021 (defun ido-toggle-ignore ()
2022 "Toggle ignoring files specified with `ido-ignore-files'."
2023 (interactive)
2024 (setq ido-process-ignore-lists (not ido-process-ignore-lists))
2025 (setq ido-text-init ido-text)
2026 (setq ido-exit 'refresh)
2027 (exit-minibuffer))
2029 (defun ido-toggle-vc ()
2030 "Disable version control for this file."
2031 (interactive)
2032 (if (and ido-mode (eq ido-cur-item 'file))
2033 (progn
2034 (setq vc-master-templates
2035 (if vc-master-templates nil ido-saved-vc-mt))
2036 (setq ido-text-init ido-text)
2037 (setq ido-exit 'keep)
2038 (exit-minibuffer))))
2040 (defun ido-toggle-literal ()
2041 "Toggle literal reading of this file."
2042 (interactive)
2043 (if (and ido-mode (eq ido-cur-item 'file))
2044 (progn
2045 (setq ido-find-literal (not ido-find-literal))
2046 (setq ido-text-init ido-text)
2047 (setq ido-exit 'keep)
2048 (exit-minibuffer))))
2050 (defun ido-reread-directory ()
2051 "Read current directory again.
2052 May be useful if cached version is no longer valid, but directory
2053 timestamp has not changed (e.g. with ftp or on Windows)."
2054 (interactive)
2055 (if (and ido-mode (eq ido-cur-item 'file))
2056 (progn
2057 (ido-remove-cached-dir ido-current-directory)
2058 (setq ido-text-init ido-text)
2059 (setq ido-rotate-temp t)
2060 (setq ido-exit 'refresh)
2061 (exit-minibuffer))))
2063 (defun ido-exit-minibuffer ()
2064 "Exit minibuffer, but make sure we have a match if one is needed."
2065 (interactive)
2066 (if (or (not ido-require-match)
2067 (ido-existing-item-p))
2068 (throw 'exit nil)))
2070 (defun ido-select-text ()
2071 "Select the buffer or file named by the prompt.
2072 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2073 (interactive)
2074 (setq ido-exit 'takeprompt)
2075 (exit-minibuffer))
2077 (defun ido-fallback-command ()
2078 "Fallback to non-ido version of current command."
2079 (interactive)
2080 (setq ido-exit 'fallback)
2081 (exit-minibuffer))
2083 (defun ido-enter-find-file ()
2084 "Drop into find-file from buffer switching."
2085 (interactive)
2086 (setq ido-exit 'findfile)
2087 (exit-minibuffer))
2089 (defun ido-enter-switch-buffer ()
2090 "Drop into ido-switch-buffer from file switching."
2091 (interactive)
2092 (setq ido-exit 'findbuffer)
2093 (exit-minibuffer))
2095 (defun ido-enter-dired ()
2096 "Drop into dired from file switching."
2097 (interactive)
2098 (setq ido-exit 'dired)
2099 (exit-minibuffer))
2102 (defun ido-up-directory (&optional clear)
2103 "Go up one directory level."
2104 (interactive "P")
2105 (setq ido-text-init (if clear nil ido-text))
2106 (setq ido-exit 'updir)
2107 (setq ido-rotate-temp t)
2108 (exit-minibuffer))
2110 (defun ido-delete-backward-updir (count)
2111 "Delete char backwards, or at beginning of buffer, go up one level."
2112 (interactive "P")
2113 (cond
2114 ((= (minibuffer-prompt-end) (point))
2115 (if (not count)
2116 (ido-up-directory t)))
2117 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2118 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2120 (delete-backward-char (prefix-numeric-value count)))))
2122 (defun ido-delete-backward-word-updir (count)
2123 "Delete all chars backwards, or at beginning of buffer, go up one level."
2124 (interactive "P")
2125 (if (= (minibuffer-prompt-end) (point))
2126 (if (not count)
2127 (ido-up-directory t))
2128 (backward-kill-word (prefix-numeric-value count))))
2130 (defun ido-get-work-directory (&optional incr must-match)
2131 (let ((n (length ido-work-directory-list))
2132 (i ido-work-directory-index)
2133 (j 0)
2134 dir)
2135 (if (or (not ido-text) (= (length ido-text) 0))
2136 (setq must-match nil))
2137 (while (< j n)
2138 (setq i (+ i incr)
2139 j (1+ j))
2140 (if (> incr 0)
2141 (if (>= i n) (setq i 0))
2142 (if (< i 0) (setq i (1- n))))
2143 (setq dir (nth i ido-work-directory-list))
2144 (if (and dir
2145 (not (equal dir ido-current-directory))
2146 (file-directory-p dir)
2147 (or (not must-match)
2148 (ido-set-matches1
2149 (if (eq ido-cur-item 'file)
2150 (ido-make-file-list1 dir)
2151 (ido-make-dir-list1 dir)))))
2152 (setq j n)
2153 (setq dir nil)))
2154 (if dir
2155 (setq ido-work-directory-index i))
2156 dir))
2158 (defun ido-prev-work-directory ()
2159 "Change to next working directory in list."
2160 (interactive)
2161 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2162 (when dir
2163 (ido-set-current-directory dir)
2164 (setq ido-exit 'refresh)
2165 (setq ido-text-init ido-text)
2166 (setq ido-rotate-temp t)
2167 (exit-minibuffer))))
2169 (defun ido-next-work-directory ()
2170 "Change to previous working directory in list."
2171 (interactive)
2172 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2173 (when dir
2174 (ido-set-current-directory dir)
2175 (setq ido-exit 'refresh)
2176 (setq ido-text-init ido-text)
2177 (setq ido-rotate-temp t)
2178 (exit-minibuffer))))
2180 (defun ido-merge-work-directories ()
2181 "Search (and merge) work directories for files matching the current input string."
2182 (interactive)
2183 (setq ido-use-merged-list t ido-try-merged-list t)
2184 (setq ido-exit 'refresh)
2185 (setq ido-text-init ido-text)
2186 (setq ido-rotate-temp t)
2187 (exit-minibuffer))
2189 (defun ido-wide-find-file (&optional file)
2190 "Prompt for FILE to search for using find, starting from current directory."
2191 (interactive)
2192 (unless file
2193 (setq file (read-string (concat "Wide find file: " ido-current-directory) ido-text)))
2194 (when (> (length file) 0)
2195 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2196 (setq ido-exit 'refresh)
2197 (setq ido-text-init file)
2198 (setq ido-rotate-temp t)
2199 (exit-minibuffer)))
2201 (defun ido-wide-find-dir (&optional dir)
2202 "Prompt for DIR to search for using find, starting from current directory."
2203 (interactive)
2204 (unless dir
2205 (setq dir (read-string (concat "Wide find directory: " ido-current-directory) ido-text)))
2206 (when (> (length dir) 0)
2207 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2208 (setq ido-exit 'refresh)
2209 (setq ido-text-init (ido-final-slash dir t))
2210 (setq ido-rotate-temp t)
2211 (exit-minibuffer)))
2213 (defun ido-make-directory (&optional dir)
2214 "Prompt for DIR to create in current directory."
2215 (interactive)
2216 (unless dir
2217 (setq dir (read-string (concat "Make directory: " ido-current-directory) ido-text)))
2218 (when (> (length dir) 0)
2219 (setq dir (concat ido-current-directory dir))
2220 (unless (file-exists-p dir)
2221 (make-directory dir t)
2222 (ido-set-current-directory dir)
2223 (setq ido-exit 'refresh)
2224 (setq ido-text-init nil)
2225 (setq ido-rotate-temp t)
2226 (exit-minibuffer))))
2228 (defun ido-get-work-file (incr)
2229 (let ((n (length ido-work-file-list))
2230 (i (+ ido-work-file-index incr))
2231 name)
2232 (if (> incr 0)
2233 (if (>= i n) (setq i 0))
2234 (if (< i 0) (setq i (1- n))))
2235 (setq name (nth i ido-work-file-list))
2236 (setq ido-work-file-index i)
2237 name))
2239 (defun ido-prev-work-file ()
2240 "Change to next working file name in list."
2241 (interactive)
2242 (let ((name (ido-get-work-file 1)))
2243 (when name
2244 (setq ido-text-init name)
2245 (setq ido-exit 'refresh)
2246 (exit-minibuffer))))
2248 (defun ido-next-work-file ()
2249 "Change to previous working file name in list."
2250 (interactive)
2251 (let ((name (ido-get-work-file -1)))
2252 (when name
2253 (setq ido-text-init name)
2254 (setq ido-exit 'refresh)
2255 (exit-minibuffer))))
2257 (defun ido-copy-current-file-name (all)
2258 "Insert file name of current buffer.
2259 If repeated, insert text from buffer instead."
2260 (interactive "P")
2261 (let* ((path (buffer-file-name ido-entry-buffer))
2262 (name (and path (file-name-nondirectory path))))
2263 (when name
2264 (setq ido-text-init
2265 (if (or all
2266 (not (equal (file-name-directory path) ido-current-directory))
2267 (not (string-match "\\.[^.]*\\'" name)))
2268 name
2269 (substring name 0 (1+ (match-beginning 0)))))
2270 (setq ido-exit 'refresh
2271 ido-try-merged-list nil)
2272 (exit-minibuffer))))
2274 (defun ido-copy-current-word (all)
2275 "Insert current word (file name or path) from current buffer."
2276 (interactive "P")
2277 (let ((word (save-excursion
2278 (set-buffer ido-entry-buffer)
2279 (let ((p (point)) start-line end-line start-name name)
2280 (beginning-of-line)
2281 (setq start-line (point))
2282 (end-of-line)
2283 (setq end-line (point))
2284 (goto-char p)
2285 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
2286 (forward-char 1))
2287 (setq start-name (point))
2288 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
2289 (if (= start-name (point))
2291 (buffer-substring-no-properties start-name (point)))))))
2292 (if (cond
2293 ((not word) nil)
2294 ((string-match "\\`[~/]" word)
2295 (setq ido-text-init word
2296 ido-try-merged-list nil
2297 ido-exit 'chdir))
2298 ((string-match "/" word)
2299 (setq ido-text-init (concat ido-current-directory word)
2300 ido-try-merged-list nil
2301 ido-exit 'chdir))
2303 (setq ido-text-init word
2304 ido-try-merged-list nil
2305 ido-exit 'refresh)))
2306 (exit-minibuffer))))
2308 (defun ido-next-match ()
2309 "Put first element of `ido-matches' at the end of the list."
2310 (interactive)
2311 (if ido-matches
2312 (let ((next (cadr ido-matches)))
2313 (setq ido-cur-list (ido-chop ido-cur-list next))
2314 (setq ido-rescan t)
2315 (setq ido-rotate t))))
2317 (defun ido-prev-match ()
2318 "Put last element of `ido-matches' at the front of the list."
2319 (interactive)
2320 (if ido-matches
2321 (let ((prev (car (last ido-matches))))
2322 (setq ido-cur-list (ido-chop ido-cur-list prev))
2323 (setq ido-rescan t)
2324 (setq ido-rotate t))))
2326 (defun ido-next-match-dir ()
2327 "Find next directory in match list.
2328 If work directories have been merged, cycle through directories for
2329 first matching file."
2330 (interactive)
2331 (if ido-use-merged-list
2332 (if ido-matches
2333 (let* ((elt (car ido-matches))
2334 (dirs (cdr elt)))
2335 (when (> (length dirs) 1)
2336 (setcdr elt (ido-chop dirs (cadr dirs))))
2337 (setq ido-rescan nil)))
2338 (let ((cnt (length ido-matches))
2339 (i 1))
2340 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
2341 (setq i (1+ i)))
2342 (if (< i cnt)
2343 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2345 (defun ido-prev-match-dir ()
2346 "Find previous directory in match list.
2347 If work directories have been merged, cycle through directories
2348 for first matching file."
2349 (interactive)
2350 (if ido-use-merged-list
2351 (if ido-matches
2352 (let* ((elt (car ido-matches))
2353 (dirs (cdr elt)))
2354 (when (> (length dirs) 1)
2355 (setcdr elt (ido-chop dirs (car (last dirs)))))
2356 (setq ido-rescan nil)))
2357 (let* ((cnt (length ido-matches))
2358 (i (1- cnt)))
2359 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
2360 (setq i (1- i)))
2361 (if (> i 0)
2362 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2364 (defun ido-chop (items elem)
2365 "Remove all elements before ELEM and put them at the end of ITEMS."
2366 (let ((ret nil)
2367 (next nil)
2368 (sofar nil))
2369 (while (not ret)
2370 (setq next (car items))
2371 (if (equal next elem)
2372 (setq ret (append items (nreverse sofar)))
2373 ;; else
2374 (progn
2375 (setq items (cdr items))
2376 (setq sofar (cons next sofar)))))
2377 ret))
2379 (defun ido-name (item)
2380 ;; Return file name for current item, whether in a normal list
2381 ;; or a merged work directory list.
2382 (if (consp item) (car item) item))
2385 ;;; CREATE LIST OF ALL CURRENT FILES
2387 (defun ido-all-completions ()
2388 ;; Return unsorted list of all competions.
2389 (let ((ido-process-ignore-lists nil))
2390 (cond
2391 ((eq ido-cur-item 'file)
2392 (ido-make-file-list1 ido-current-directory))
2393 ((eq ido-cur-item 'dir)
2394 (ido-make-dir-list1 ido-current-directory))
2395 ((eq ido-cur-item 'buffer)
2396 (ido-make-buffer-list1))
2397 (t nil))))
2400 (defun ido-sort-list (items)
2401 ;; Simple list of file or buffer names
2402 (sort items (lambda (a b) (string-lessp a b))))
2404 (defun ido-sort-merged-list (items promote)
2405 ;; Input is list of ("file" . "dir") cons cells.
2406 ;; Output is sorted list of ("file "dir" ...) lists
2407 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
2408 res a cur dirs)
2409 (while l
2410 (setq a (car l)
2411 l (cdr l))
2412 (if (and res (string-equal (car (car res)) (car a)))
2413 (progn
2414 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
2415 (if (and promote (string-equal ido-current-directory (cdr a)))
2416 (setq cur t)))
2417 (setq res (cons (list (car a) (cdr a)) res)
2418 cur nil)))
2419 res))
2421 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
2422 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
2423 (let ((paths
2424 (split-string
2425 (shell-command-to-string
2426 (concat "find " dir " -name \"" (if prefix "" "*") file "*\" -type " (if finddir "d" "f") " -print"))))
2427 path d f
2428 res)
2429 (while paths
2430 (setq path (car paths)
2431 paths (cdr paths)
2432 paths (cdr paths))
2433 (if (and (string-match "^/" path)
2434 (file-exists-p path))
2435 (setq d (file-name-directory path)
2436 f (file-name-nondirectory path)
2437 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
2438 res))
2440 (defun ido-flatten-merged-list (items)
2441 ;; Create a list of path names based on a merged directory list.
2442 (let (res)
2443 (while items
2444 (let* ((item (car items))
2445 (file (car item))
2446 (dirs (cdr item)))
2447 (while dirs
2448 (setq res (cons (concat (car dirs) file) res)
2449 dirs (cdr dirs))))
2450 (setq items (cdr items)))
2451 res))
2453 (defun ido-make-merged-file-list (text auto wide)
2454 (let (res)
2455 (message "Searching for `%s'...." text)
2456 (if (and (ido-final-slash text) ido-dir-file-cache)
2457 (if wide
2458 (setq res (ido-wide-find-dirs-or-files
2459 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
2460 ;; Use list of cached directories
2461 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
2462 (dirs ido-dir-file-cache)
2463 dir b d f)
2464 (if nil ;; simple
2465 (while dirs
2466 (setq dir (car (car dirs))
2467 dirs (cdr dirs))
2468 (when (and (string-match re dir)
2469 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
2470 (file-directory-p dir))
2471 (setq b (substring dir 0 -1)
2472 f (concat (file-name-nondirectory b) "/")
2473 d (file-name-directory b)
2474 res (cons (cons f d) res))))
2475 (while dirs
2476 (setq dir (car dirs)
2477 d (car dir)
2478 dirs (cdr dirs))
2479 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
2480 (setq dir (cdr (cdr dir)))
2481 (while dir
2482 (setq f (car dir)
2483 dir (cdr dir))
2484 (if (and (string-match re f)
2485 (not (ido-ignore-item-p f ido-ignore-directories)))
2486 (setq res (cons (cons f d) res)))))
2487 (if (and auto (input-pending-p))
2488 (setq dirs nil
2489 res t))))))
2490 (if wide
2491 (setq res (ido-wide-find-dirs-or-files
2492 ido-current-directory text ido-enable-prefix nil))
2493 (let ((ido-text text)
2494 (dirs ido-work-directory-list)
2495 (must-match (and text (> (length text) 0)))
2496 dir fl)
2497 (if (and auto (not (member ido-current-directory dirs)))
2498 (setq dirs (cons ido-current-directory dirs)))
2499 (while dirs
2500 (setq dir (car dirs)
2501 dirs (cdr dirs))
2502 (when (and dir (stringp dir)
2503 (or ido-merge-ftp-work-directories
2504 (not (ido-is-ftp-directory dir)))
2505 (file-directory-p dir)
2506 (setq fl (if (eq ido-cur-item 'file)
2507 (ido-make-file-list1 dir t)
2508 (ido-make-dir-list1 dir t))))
2509 (if must-match
2510 (setq fl (ido-set-matches1 fl)))
2511 (if fl
2512 (setq res (nconc fl res))))
2513 (if (and auto (input-pending-p))
2514 (setq dirs nil
2515 res t))))))
2516 (if (and res (not (eq res t)))
2517 (setq res (ido-sort-merged-list res auto)))
2518 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
2519 (listp res)
2520 (> (length text) 0))
2521 (let ((elt (assoc text res)))
2522 (when (and elt (not (eq elt (car res))))
2523 (setq res (delq elt res))
2524 (setq res (cons elt res)))))
2525 (message nil)
2526 res))
2528 (defun ido-make-buffer-list1 (&optional frame visible)
2529 ;; Return list of non-ignored buffer names
2530 (delq nil
2531 (mapcar
2532 (lambda (x)
2533 (let ((name (buffer-name x)))
2534 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
2535 name)))
2536 (buffer-list frame))))
2538 (defun ido-make-buffer-list (default)
2539 ;; Return the current list of buffers.
2540 ;; Currently visible buffers are put at the end of the list.
2541 ;; The hook `ido-make-buflist-hook' is run after the list has been
2542 ;; created to allow the user to further modify the order of the buffer names
2543 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
2544 ;; it is put to the start of the list.
2545 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
2546 (ido-temp-list (ido-make-buffer-list1 (selected-frame) ido-current-buffers)))
2547 (if ido-temp-list
2548 (nconc ido-temp-list ido-current-buffers)
2549 (setq ido-temp-list ido-current-buffers))
2550 (if default
2551 (progn
2552 (setq ido-temp-list
2553 (delete default ido-temp-list))
2554 (setq ido-temp-list
2555 (cons default ido-temp-list))))
2556 (run-hooks 'ido-make-buffer-list-hook)
2557 ido-temp-list))
2559 (defun ido-to-end (items)
2560 ;; Move the elements from ITEMS to the end of `ido-temp-list'
2561 (mapcar
2562 (lambda (elem)
2563 (setq ido-temp-list (delq elem ido-temp-list)))
2564 items)
2565 (if ido-temp-list
2566 (nconc ido-temp-list items)
2567 (setq ido-temp-list items)))
2569 (defun ido-file-name-all-completions (dir)
2570 ;; Return name of all files in DIR
2571 ;; Uses and updates ido-dir-file-cache
2572 (if (and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
2573 (stringp dir) (> (length dir) 0)
2574 (ido-may-cache-directory dir))
2575 (let* ((cached (assoc dir ido-dir-file-cache))
2576 (ctime (nth 1 cached))
2577 (ftp (ido-is-ftp-directory dir))
2578 (attr (if ftp nil (file-attributes dir)))
2579 (mtime (nth 5 attr))
2580 valid)
2581 (when cached ; should we use the cached entry ?
2582 (if ftp
2583 (setq valid (and (eq (car ctime) 'ftp)
2584 (ido-cache-ftp-valid (cdr ctime))))
2585 (if attr
2586 (setq valid (and (= (car ctime) (car mtime))
2587 (= (car (cdr ctime)) (car (cdr mtime)))))))
2588 (if (not valid)
2589 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
2590 cached nil)))
2591 (unless cached
2592 (if (and ftp (file-readable-p dir))
2593 (setq mtime (cons 'ftp (ido-time-stamp))))
2594 (if mtime
2595 (setq cached (cons dir (cons mtime (file-name-all-completions "" dir)))
2596 ido-dir-file-cache (cons cached ido-dir-file-cache)))
2597 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
2598 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
2599 (and cached
2600 (cdr (cdr cached))))
2601 (file-name-all-completions "" dir)))
2603 (defun ido-remove-cached-dir (dir)
2604 ;; Remove dir from ido-dir-file-cache
2605 (if (and ido-dir-file-cache
2606 (stringp dir) (> (length dir) 0))
2607 (let ((cached (assoc dir ido-dir-file-cache)))
2608 (if cached
2609 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
2612 (defun ido-make-file-list1 (dir &optional merged)
2613 ;; Return list of non-ignored files in DIR
2614 ;; If MERGED is non-nil, each file is cons'ed with DIR
2615 (and (file-directory-p dir)
2616 (delq nil
2617 (mapcar
2618 (lambda (name)
2619 (if (not (ido-ignore-item-p name ido-ignore-files t))
2620 (if merged (cons name dir) name)))
2621 (ido-file-name-all-completions dir)))))
2623 (defun ido-make-file-list (default)
2624 ;; Return the current list of files.
2625 ;; Currently visible files are put at the end of the list.
2626 ;; The hook `ido-make-file-list-hook' is run after the list has been
2627 ;; created to allow the user to further modify the order of the file names
2628 ;; in this list.
2629 (let ((ido-temp-list (ido-make-file-list1 ido-current-directory)))
2630 (setq ido-temp-list (ido-sort-list ido-temp-list))
2631 (let ((default-directory ido-current-directory))
2632 (ido-to-end ;; move ftp hosts and visited files to end
2633 (delq nil (mapcar
2634 (lambda (x) (if (or (string-match "..:\\'" x) (get-file-buffer x)) x))
2635 ido-temp-list))))
2636 (ido-to-end ;; move . files to end
2637 (delq nil (mapcar
2638 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2639 ido-temp-list)))
2640 (if (and default (member default ido-temp-list))
2641 (if (or ido-rotate-temp ido-rotate-file-list-default)
2642 (unless (equal default (car ido-temp-list))
2643 (let ((l ido-temp-list) k)
2644 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2645 (setq l (cdr l)))
2646 (setq k (cdr l))
2647 (setcdr l nil)
2648 (nconc k ido-temp-list)
2649 (setq ido-temp-list k)))
2650 (setq ido-temp-list
2651 (delete default ido-temp-list))
2652 (setq ido-temp-list
2653 (cons default ido-temp-list))))
2654 (when ido-show-dot-for-dired
2655 (setq ido-temp-list (delete "." ido-temp-list))
2656 (setq ido-temp-list (cons "." ido-temp-list)))
2657 (run-hooks 'ido-make-file-list-hook)
2658 ido-temp-list))
2660 (defun ido-make-dir-list1 (dir &optional merged)
2661 ;; Return list of non-ignored subdirs in DIR
2662 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
2663 (and (file-directory-p dir)
2664 (delq nil
2665 (mapcar
2666 (lambda (name)
2667 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
2668 (if merged (cons name dir) name)))
2669 (ido-file-name-all-completions dir)))))
2671 (defun ido-make-dir-list (default)
2672 ;; Return the current list of directories.
2673 ;; The hook `ido-make-dir-list-hook' is run after the list has been
2674 ;; created to allow the user to further modify the order of the
2675 ;; directory names in this list.
2676 (let ((ido-temp-list (ido-make-dir-list1 ido-current-directory)))
2677 (setq ido-temp-list (ido-sort-list ido-temp-list))
2678 (let ((default-directory ido-current-directory))
2679 (ido-to-end ;; move visited files to end
2680 (delq nil (mapcar
2681 (lambda (x) (if (get-file-buffer x) x))
2682 ido-temp-list))))
2683 (ido-to-end ;; move . files to end
2684 (delq nil (mapcar
2685 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2686 ido-temp-list)))
2687 (if (and default (member default ido-temp-list))
2688 (if (or ido-rotate-temp ido-rotate-file-list-default)
2689 (unless (equal default (car ido-temp-list))
2690 (let ((l ido-temp-list) k)
2691 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2692 (setq l (cdr l)))
2693 (setq k (cdr l))
2694 (setcdr l nil)
2695 (nconc k ido-temp-list)
2696 (setq ido-temp-list k)))
2697 (setq ido-temp-list
2698 (delete default ido-temp-list))
2699 (setq ido-temp-list
2700 (cons default ido-temp-list))))
2701 (setq ido-temp-list (delete "." ido-temp-list))
2702 (setq ido-temp-list (cons "." ido-temp-list))
2703 (run-hooks 'ido-make-dir-list-hook)
2704 ido-temp-list))
2706 ;; List of the files visible in the current frame.
2707 (defvar ido-bufs-in-frame)
2709 (defun ido-get-buffers-in-frames (&optional current)
2710 ;; Return the list of buffers that are visible in the current frame.
2711 ;; If optional argument `current' is given, restrict searching to the
2712 ;; current frame, rather than all frames, regardless of value of
2713 ;; `ido-all-frames'.
2714 (let ((ido-bufs-in-frame nil))
2715 (walk-windows 'ido-get-bufname nil
2716 (if current
2718 ido-all-frames))
2719 ido-bufs-in-frame))
2721 (defun ido-get-bufname (win)
2722 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
2723 (let ((buf (buffer-name (window-buffer win))))
2724 (unless (or (member buf ido-bufs-in-frame)
2725 (member buf ido-ignore-item-temp-list))
2726 ;; Only add buf if it is not already in list.
2727 ;; This prevents same buf in two different windows being
2728 ;; put into the list twice.
2729 (setq ido-bufs-in-frame
2730 (cons buf ido-bufs-in-frame)))))
2732 ;;; FIND MATCHING ITEMS
2734 (defun ido-set-matches1 (items &optional do-full)
2735 ;; Return list of matches in items
2736 (let* ((case-fold-search ido-case-fold)
2737 (rexq (if ido-enable-regexp ido-text (regexp-quote ido-text)))
2738 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
2739 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" re))
2740 (concat "\\`" re "\\'")))
2741 (prefix-re (and full-re (not ido-enable-prefix)
2742 (concat "\\`" rexq)))
2743 full-matches
2744 prefix-matches
2745 matches)
2746 (mapcar
2747 (lambda (item)
2748 (let ((name (ido-name item)))
2749 (if (string-match re name)
2750 (cond
2751 ((and full-re (string-match full-re name))
2752 (setq full-matches (cons item full-matches)))
2753 ((and prefix-re (string-match prefix-re name))
2754 (setq prefix-matches (cons item prefix-matches)))
2755 (t (setq matches (cons item matches))))))
2757 items)
2758 (if prefix-matches
2759 (setq matches (nconc prefix-matches matches)))
2760 (if full-matches
2761 (setq matches (nconc full-matches matches)))
2762 (when (and (null matches)
2763 ido-enable-flex-matching
2764 (> (length ido-text) 1)
2765 (not ido-enable-regexp))
2766 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
2767 (if ido-enable-prefix
2768 (setq re (concat "\\`" re)))
2769 (mapcar
2770 (lambda (item)
2771 (let ((name (ido-name item)))
2772 (if (string-match re name)
2773 (setq matches (cons item matches)))))
2774 items))
2775 matches))
2778 (defun ido-set-matches ()
2779 ;; Set `ido-matches' to the list of items matching prompt
2780 (when ido-rescan
2781 (setq ido-matches (ido-set-matches1 (reverse ido-cur-list) (not ido-rotate))
2782 ido-rotate nil)))
2784 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
2785 ;; Return t if the buffer or file NAME should be ignored.
2786 (or (member name ido-ignore-item-temp-list)
2787 (and
2788 ido-process-ignore-lists re-list
2789 (let ((data (match-data))
2790 (ext-list (and ignore-ext ido-ignore-extensions
2791 completion-ignored-extensions))
2792 ignorep nextstr
2793 (flen (length name)) slen)
2794 (while ext-list
2795 (setq nextstr (car ext-list))
2796 (if (cond
2797 ((stringp nextstr)
2798 (and (>= flen (setq slen (length nextstr)))
2799 (string-equal (substring name (- flen slen)) nextstr)))
2800 ((fboundp nextstr) (funcall nextstr name))
2801 (t nil))
2802 (setq ignorep t
2803 ext-list nil
2804 re-list nil)
2805 (setq ext-list (cdr ext-list))))
2806 (while re-list
2807 (setq nextstr (car re-list))
2808 (if (cond
2809 ((stringp nextstr) (string-match nextstr name))
2810 ((fboundp nextstr) (funcall nextstr name))
2811 (t nil))
2812 (setq ignorep t
2813 re-list nil)
2814 (setq re-list (cdr re-list))))
2815 ;; return the result
2816 (if ignorep
2817 (setq ido-ignored-list (cons name ido-ignored-list)))
2818 (set-match-data data)
2819 ignorep))))
2822 ;; Private variable used by `ido-word-matching-substring'.
2823 (defvar ido-change-word-sub)
2825 (defun ido-find-common-substring (items subs)
2826 ;; Return common string following SUBS in each element of ITEMS.
2827 (let (res
2828 alist
2829 ido-change-word-sub)
2830 (setq ido-change-word-sub
2831 (if ido-enable-regexp
2832 subs
2833 (regexp-quote subs)))
2834 (setq res (mapcar #'ido-word-matching-substring items))
2835 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
2836 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
2838 ;; try-completion returns t if there is an exact match.
2839 (let* ((completion-ignore-case ido-case-fold)
2840 (comp (try-completion subs alist)))
2841 (if (eq comp t)
2842 subs
2843 comp))))
2845 (defun ido-word-matching-substring (word)
2846 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
2847 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
2848 (let ((case-fold-search ido-case-fold))
2849 (let ((m (string-match ido-change-word-sub (ido-name word))))
2850 (if m
2851 (substring (ido-name word) m)
2852 ;; else no match
2853 nil))))
2855 (defun ido-makealist (res)
2856 ;; Return dotted pair (RES . 1).
2857 (cons res 1))
2859 (defun ido-choose-completion-string (choice buffer mini-p base-size)
2860 (when (ido-active)
2861 ;; Insert the completion into the buffer where completion was requested.
2862 (if (get-buffer ido-completion-buffer)
2863 (kill-buffer ido-completion-buffer))
2864 (cond
2865 ((ido-active t) ;; ido-use-merged-list
2866 (setq ido-current-directory ""
2867 ido-text choice
2868 ido-exit 'done))
2869 ((not (ido-final-slash choice))
2870 (setq ido-text choice
2871 ido-exit 'done))
2873 (ido-set-current-directory ido-current-directory choice)
2874 (setq ido-exit 'refresh)))
2875 (exit-minibuffer)
2878 (defun ido-completion-help ()
2879 "Show possible completions in a *File Completions* buffer."
2880 (interactive)
2881 (setq ido-rescan nil)
2882 (let ((temp-buf (get-buffer ido-completion-buffer))
2883 display-it full-list)
2884 (if (and (eq last-command this-command) temp-buf)
2885 ;; scroll buffer
2886 (let (win (buf (current-buffer)))
2887 (display-buffer temp-buf nil nil)
2888 (set-buffer temp-buf)
2889 (setq win (get-buffer-window temp-buf))
2890 (if (pos-visible-in-window-p (point-max) win)
2891 (if (or ido-completion-buffer-all-completions (boundp 'ido-completion-buffer-full))
2892 (set-window-start win (point-min))
2893 (set (make-local-variable 'ido-completion-buffer-full) t)
2894 (setq full-list t
2895 display-it t))
2896 (scroll-other-window))
2897 (set-buffer buf))
2898 (setq display-it t))
2899 (if display-it
2900 (with-output-to-temp-buffer ido-completion-buffer
2901 (let ((completion-list (ido-sort-list
2902 (cond
2903 (ido-use-merged-list
2904 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
2905 ((or full-list ido-completion-buffer-all-completions)
2906 (ido-all-completions))
2908 (copy-sequence (or ido-matches ido-cur-list)))))))
2909 (if ido-xemacs
2910 ;; XEmacs extents are put on by default, doesn't seem to be
2911 ;; any way of switching them off.
2912 ;; This obscure code avoids a byte compiler warning in Emacs.
2913 (let ((f 'display-completion-list))
2914 (funcall f completion-list
2915 :help-string "ido "
2916 :activate-callback
2917 '(lambda (x y z) (message "doesn't work yet, sorry!"))))
2918 ;; else running Emacs
2919 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
2920 (display-completion-list completion-list)))))))
2922 ;;; KILL CURRENT BUFFER
2923 (defun ido-kill-buffer-at-head ()
2924 "Kill the buffer at the head of `ido-matches'."
2925 (interactive)
2926 (let ((enable-recursive-minibuffers t)
2927 (buf (car ido-matches)))
2928 (when buf
2929 (kill-buffer buf)
2930 ;; Check if buffer still exists.
2931 (if (get-buffer buf)
2932 ;; buffer couldn't be killed.
2933 (setq ido-rescan t)
2934 ;; else buffer was killed so remove name from list.
2935 (setq ido-cur-list (delq buf ido-cur-list))))))
2937 ;;; DELETE CURRENT FILE
2938 (defun ido-delete-file-at-head ()
2939 "Delete the file at the head of `ido-matches'."
2940 (interactive)
2941 (let ((enable-recursive-minibuffers t)
2942 (file (car ido-matches)))
2943 (if file
2944 (setq file (concat ido-current-directory file)))
2945 (when (and file
2946 (file-exists-p file)
2947 (not (file-directory-p file))
2948 (file-writable-p ido-current-directory)
2949 (yes-or-no-p (concat "Delete " file " ")))
2950 (delete-file file)
2951 ;; Check if file still exists.
2952 (if (file-exists-p file)
2953 ;; file could not be deleted
2954 (setq ido-rescan t)
2955 ;; else file was killed so remove name from list.
2956 (setq ido-cur-list (delq (car ido-matches) ido-cur-list))))))
2959 ;;; VISIT CHOSEN BUFFER
2960 (defun ido-visit-buffer (buffer method &optional record)
2961 "Visit file named FILE according to METHOD.
2962 Record command in command-history if optional RECORD is non-nil."
2964 (let (win newframe)
2965 (cond
2966 ((eq method 'kill)
2967 (if record
2968 (ido-record-command 'kill-buffer buffer))
2969 (kill-buffer buffer))
2971 ((eq method 'samewindow)
2972 (if record
2973 (ido-record-command 'switch-to-buffer buffer))
2974 (switch-to-buffer buffer))
2976 ((memq method '(always-frame maybe-frame))
2977 (cond
2978 ((and window-system
2979 (setq win (ido-window-buffer-p buffer))
2980 (or (eq method 'always-frame)
2981 (y-or-n-p "Jump to frame? ")))
2982 (setq newframe (window-frame win))
2983 (if (fboundp 'select-frame-set-input-focus)
2984 (select-frame-set-input-focus newframe)
2985 (raise-frame newframe)
2986 (select-frame newframe)
2987 (if (not ido-xemacs)
2988 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
2989 (select-window win))
2991 ;; No buffer in other frames...
2992 (if record
2993 (ido-record-command 'switch-to-buffer buffer))
2994 (switch-to-buffer buffer)
2997 ((eq method 'otherwindow)
2998 (if record
2999 (ido-record-command 'switch-to-buffer buffer))
3000 (switch-to-buffer-other-window buffer))
3002 ((eq method 'display)
3003 (display-buffer buffer))
3005 ((eq method 'otherframe)
3006 (progn
3007 (switch-to-buffer-other-frame buffer)
3008 (if (not ido-xemacs)
3009 (if (fboundp 'select-frame-set-input-focus)
3010 (select-frame-set-input-focus (selected-frame))
3011 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
3012 )))))
3015 (defun ido-window-buffer-p (buffer)
3016 ;; Return window pointer if BUFFER is visible in another frame.
3017 ;; If BUFFER is visible in the current frame, return nil.
3018 (let ((blist (ido-get-buffers-in-frames 'current)))
3019 ;;If the buffer is visible in current frame, return nil
3020 (if (member buffer blist)
3022 ;; maybe in other frame or icon
3023 (get-buffer-window buffer 0) ; better than 'visible
3027 ;;; ----------- IDONIZED FUNCTIONS ------------
3029 ;;;###autoload
3030 (defun ido-switch-buffer ()
3031 "Switch to another buffer.
3032 The buffer is displayed according to `ido-default-buffer-method' -- the
3033 default is to show it in the same window, unless it is already visible
3034 in another frame.
3036 As you type in a string, all of the buffers matching the string are
3037 displayed if substring-matching is used \(default). Look at
3038 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
3039 buffer you want, it can then be selected. As you type, most keys have their
3040 normal keybindings, except for the following: \\<ido-mode-map>
3042 RET Select the buffer at the front of the list of matches. If the
3043 list is empty, possibly prompt to create new buffer.
3045 \\[ido-select-text] Select the current prompt as the buffer.
3046 If no buffer is found, prompt for a new one.
3048 \\[ido-next-match] Put the first element at the end of the list.
3049 \\[ido-prev-match] Put the last element at the start of the list.
3050 \\[ido-complete] Complete a common suffix to the current string that
3051 matches all buffers. If there is only one match, select that buffer.
3052 If there is no common suffix, show a list of all matching buffers
3053 in a separate window.
3054 \\[ido-edit-input] Edit input string.
3055 \\[ido-fallback-command] Fallback to non-ido version of current command.
3056 \\[ido-toggle-regexp] Toggle regexp searching.
3057 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3058 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
3059 \\[ido-completion-help] Show list of matching buffers in separate window.
3060 \\[ido-enter-find-file] Drop into ido-find-file.
3061 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
3062 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
3063 (interactive)
3064 (ido-buffer-internal ido-default-buffer-method))
3066 ;;;###autoload
3067 (defun ido-switch-buffer-other-window ()
3068 "Switch to another buffer and show it in another window.
3069 The buffer name is selected interactively by typing a substring.
3070 For details of keybindings, do `\\[describe-function] ido'."
3071 (interactive)
3072 (ido-buffer-internal 'otherwindow 'switch-to-buffer-other-window))
3074 ;;;###autoload
3075 (defun ido-display-buffer ()
3076 "Display a buffer in another window but don't select it.
3077 The buffer name is selected interactively by typing a substring.
3078 For details of keybindings, do `\\[describe-function] ido'."
3079 (interactive)
3080 (ido-buffer-internal 'display 'display-buffer))
3082 ;;;###autoload
3083 (defun ido-kill-buffer ()
3084 "Kill a buffer.
3085 The buffer name is selected interactively by typing a substring.
3086 For details of keybindings, do `\\[describe-function] ido'."
3087 (interactive)
3088 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer))))
3090 ;;;###autoload
3091 (defun ido-insert-buffer ()
3092 "Insert contents of a buffer in current buffer after point.
3093 The buffer name is selected interactively by typing a substring.
3094 For details of keybindings, do `\\[describe-function] ido'."
3095 (interactive)
3096 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: "))
3098 ;;;###autoload
3099 (defun ido-switch-buffer-other-frame ()
3100 "Switch to another buffer and show it in another frame.
3101 The buffer name is selected interactively by typing a substring.
3102 For details of keybindings, do `\\[describe-function] ido'."
3103 (interactive)
3104 (if ido-mode
3105 (ido-buffer-internal 'otherframe)
3106 (call-interactively 'switch-to-buffer-other-frame)))
3108 ;;;###autoload
3109 (defun ido-find-file-in-dir (dir)
3110 "Switch to another file starting from DIR."
3111 (interactive "DDir: ")
3112 (if (not (equal (substring dir -1) "/"))
3113 (setq dir (concat dir "/")))
3114 (ido-file-internal ido-default-file-method nil dir))
3116 ;;;###autoload
3117 (defun ido-find-file ()
3118 "Edit file with name obtained via minibuffer.
3119 The file is displayed according to `ido-default-file-method' -- the
3120 default is to show it in the same window, unless it is already
3121 visible in another frame.
3123 The file name is selected interactively by typing a substring. As you type
3124 in a string, all of the filenames matching the string are displayed if
3125 substring-matching is used \(default). Look at `ido-enable-prefix' and
3126 `ido-toggle-prefix'. When you have found the filename you want, it can
3127 then be selected. As you type, most keys have their normal keybindings,
3128 except for the following: \\<ido-mode-map>
3130 RET Select the file at the front of the list of matches. If the
3131 list is empty, possibly prompt to create new file.
3133 \\[ido-select-text] Select the current prompt as the buffer or file.
3134 If no buffer or file is found, prompt for a new one.
3136 \\[ido-next-match] Put the first element at the end of the list.
3137 \\[ido-prev-match] Put the last element at the start of the list.
3138 \\[ido-complete] Complete a common suffix to the current string that
3139 matches all files. If there is only one match, select that file.
3140 If there is no common suffix, show a list of all matching files
3141 in a separate window.
3142 \\[ido-edit-input] Edit input string (including path).
3143 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
3144 \\[ido-merge-work-directories] search for file in the work directory history.
3145 \\[ido-forget-work-directory] removes current directory from the work directory history.
3146 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
3147 \\[ido-wide-find-file] and \\[ido-wide-find-dir] prompts and uses find to locate files or directories.
3148 \\[ido-make-directory] prompts for a directory to create in current directory.
3149 \\[ido-fallback-command] Fallback to non-ido version of current command.
3150 \\[ido-toggle-regexp] Toggle regexp searching.
3151 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3152 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
3153 \\[ido-toggle-vc] Toggle version control for this file.
3154 \\[ido-toggle-literal] Toggle literal reading of this file.
3155 \\[ido-completion-help] Show list of matching files in separate window.
3156 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
3158 (interactive)
3159 (ido-file-internal ido-default-file-method))
3161 ;;;###autoload
3162 (defun ido-find-file-other-window ()
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'."
3166 (interactive)
3167 (ido-file-internal 'otherwindow 'find-file-other-window))
3169 ;;;###autoload
3170 (defun ido-find-alternate-file ()
3171 "Switch to another file and show it in another window.
3172 The file name is selected interactively by typing a substring.
3173 For details of keybindings, do `\\[describe-function] ido-find-file'."
3174 (interactive)
3175 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
3177 ;;;###autoload
3178 (defun ido-find-file-read-only ()
3179 "Edit file read-only 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'."
3182 (interactive)
3183 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
3185 ;;;###autoload
3186 (defun ido-find-file-read-only-other-window ()
3187 "Edit file read-only in other window 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'."
3190 (interactive)
3191 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
3193 ;;;###autoload
3194 (defun ido-find-file-read-only-other-frame ()
3195 "Edit file read-only in other frame with name obtained via minibuffer.
3196 The file name is selected interactively by typing a substring.
3197 For details of keybindings, do `\\[describe-function] ido-find-file'."
3198 (interactive)
3199 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
3201 ;;;###autoload
3202 (defun ido-display-file ()
3203 "Display a file in another window but don't select it.
3204 The file name is selected interactively by typing a substring.
3205 For details of keybindings, do `\\[describe-function] ido-find-file'."
3206 (interactive)
3207 (ido-file-internal 'display))
3209 ;;;###autoload
3210 (defun ido-find-file-other-frame ()
3211 "Switch to another file and show it in another frame.
3212 The file name is selected interactively by typing a substring.
3213 For details of keybindings, do `\\[describe-function] ido-find-file'."
3214 (interactive)
3215 (ido-file-internal 'otherframe 'find-file-other-frame))
3217 ;;;###autoload
3218 (defun ido-write-file ()
3219 "Write current buffer to a file.
3220 The file name is selected interactively by typing a substring.
3221 For details of keybindings, do `\\[describe-function] ido-find-file'."
3222 (interactive)
3223 (let ((ido-process-ignore-lists t)
3224 (ido-work-directory-match-only nil)
3225 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
3226 (ido-report-no-match nil)
3227 (ido-auto-merge-work-directories-length -1))
3228 (ido-file-internal 'write 'write-file nil "Write file: ")))
3230 ;;;###autoload
3231 (defun ido-insert-file ()
3232 "Insert contents of file in current buffer.
3233 The file name is selected interactively by typing a substring.
3234 For details of keybindings, do `\\[describe-function] ido-find-file'."
3235 (interactive)
3236 (ido-file-internal 'insert 'insert-file nil "Insert file: "))
3238 ;;;###autoload
3239 (defun ido-dired ()
3240 "Call dired the ido way.
3241 The directory is selected interactively by typing a substring.
3242 For details of keybindings, do `\\[describe-function] ido-find-file'."
3243 (interactive)
3244 (let ((ido-report-no-match nil)
3245 (ido-auto-merge-work-directories-length -1))
3246 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
3248 (defun ido-list-directory ()
3249 "Call list-directory the ido way.
3250 The directory is selected interactively by typing a substring.
3251 For details of keybindings, do `\\[describe-function] ido-find-file'."
3252 (interactive)
3253 (let ((ido-report-no-match nil)
3254 (ido-auto-merge-work-directories-length -1))
3255 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
3257 ;;; XEmacs hack for showing default buffer
3259 ;; The first time we enter the minibuffer, Emacs puts up the default
3260 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
3261 ;; subtle difference in the two versions of post-command-hook. The
3262 ;; default is shown for both whenever we delete all of our text
3263 ;; though, indicating its just a problem the first time we enter the
3264 ;; function. To solve this, we use another entry hook for emacs to
3265 ;; show the default the first time we enter the minibuffer.
3268 ;;; ICOMPLETE TYPE CODE
3270 (defun ido-initiate-auto-merge (buffer)
3271 (ido-trace "\n*merge timeout*" buffer)
3272 (setq ido-auto-merge-timer nil)
3273 (when (and (buffer-live-p buffer)
3274 (= ido-use-mycompletion-depth (minibuffer-depth))
3275 (boundp 'ido-eoinput) ido-eoinput)
3276 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
3277 (ido-trace "request merge")
3278 (setq ido-use-merged-list 'auto
3279 ido-text-init contents
3280 ido-rotate-temp t
3281 ido-exit 'refresh)
3282 (save-excursion
3283 (set-buffer buffer)
3284 (ido-tidy))
3285 (throw 'ido contents))))
3287 (defun ido-exhibit ()
3288 "Post command hook for `ido'."
3289 ;; Find matching files and display a list in the minibuffer.
3290 ;; Copied from `icomplete-exhibit' with two changes:
3291 ;; 1. It prints a default file name when there is no text yet entered.
3292 ;; 2. It calls my completion routine rather than the standard completion.
3294 (if (= ido-use-mycompletion-depth (minibuffer-depth))
3295 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
3296 (buffer-undo-list t)
3297 try-single-dir-match)
3299 (ido-trace "\nexhibit" this-command)
3300 (ido-trace "dir" ido-current-directory)
3301 (ido-trace "contents" contents)
3302 (ido-trace "list" ido-cur-list)
3303 (ido-trace "matches" ido-matches)
3304 (ido-trace "rescan" ido-rescan)
3306 (save-excursion
3307 (goto-char (point-max))
3308 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
3309 (if (not (boundp 'ido-eoinput))
3310 ;; In case it got wiped out by major mode business:
3311 (make-local-variable 'ido-eoinput))
3312 (setq ido-eoinput (point))
3314 ;; Handle explicit directory changes
3315 (and
3316 (memq ido-cur-item '(file dir))
3317 (> (length contents) 1)
3318 (cond
3319 ((ido-final-slash contents) ;; xxx/
3320 (ido-trace "final slash" contents)
3321 (cond
3322 ((string-equal contents "~/")
3323 (ido-set-current-home)
3325 ((string-equal contents "../")
3326 (ido-up-directory t)
3328 ((string-equal contents "./")
3330 ((string-match contents "\\`~[a-zA-Z0-9]/\\'")
3331 (ido-set-current-home contents)
3333 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
3334 (let ((exp (condition-case ()
3335 (expand-file-name
3336 (substitute-in-file-name (substring contents 0 -1))
3337 ido-current-directory)
3338 (error nil))))
3339 (ido-trace contents exp)
3340 (if (and exp (file-directory-p exp))
3341 (progn
3342 (ido-set-current-directory (file-name-directory exp))
3343 (setq ido-text-init (file-name-nondirectory exp))
3345 nil)))
3346 ((and (memq system-type '(windows-nt ms-dos))
3347 (string-equal (substring contents 1) ":/"))
3348 (ido-set-current-directory (file-name-directory contents))
3350 ((string-equal (substring contents -2 -1) "/")
3351 (ido-set-current-directory
3352 (if (memq system-type '(windows-nt ms-dos))
3353 (expand-file-name "/" ido-current-directory)
3354 "/"))
3357 (setq try-single-dir-match t)
3358 nil)))
3360 ((and (string-equal ido-current-directory "/")
3361 (string-match "..:\\'" contents)) ;; Ange-ftp
3362 (ido-set-current-directory "/" contents)
3363 (when (ido-is-slow-ftp-host)
3364 (setq ido-exit 'fallback)
3365 (exit-minibuffer))
3368 ((and (string-equal (substring contents -2 -1) "/")
3369 (not (string-match "[$]" contents)))
3370 (ido-set-current-directory
3371 (cond
3372 ((= (length contents) 2)
3373 "/")
3374 (ido-matches
3375 (concat ido-current-directory (car ido-matches)))
3377 (concat ido-current-directory (substring contents 0 -1)))))
3378 (setq ido-text-init (substring contents -1))
3381 ((and (not ido-use-merged-list)
3382 (not (ido-final-slash contents))
3383 (eq ido-try-merged-list t)
3384 (numberp ido-auto-merge-work-directories-length)
3385 (> ido-auto-merge-work-directories-length 0)
3386 (= (length contents) ido-auto-merge-work-directories-length)
3387 (not (and ido-auto-merge-inhibit-characters-regexp
3388 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3389 (not (input-pending-p)))
3390 (setq ido-use-merged-list 'auto
3391 ido-text-init contents
3392 ido-rotate-temp t)
3394 (progn
3395 (ido-trace "refresh on /" ido-text-init)
3396 (setq ido-exit 'refresh)
3397 (exit-minibuffer)))
3399 ;; Update the list of matches
3400 (setq ido-text contents)
3401 (ido-set-matches)
3402 (ido-trace "new " ido-matches)
3404 (when (and ido-enter-single-matching-directory
3405 ido-matches
3406 (null (cdr ido-matches))
3407 (ido-final-slash (car ido-matches))
3408 (or try-single-dir-match
3409 (eq ido-enter-single-matching-directory t)))
3410 (ido-trace "single match" (car ido-matches))
3411 (ido-set-current-directory
3412 (concat ido-current-directory (car ido-matches)))
3413 (setq ido-exit 'refresh)
3414 (exit-minibuffer))
3416 (when (and (not ido-matches)
3417 ; ido-rescan
3418 ido-process-ignore-lists
3419 ido-ignored-list)
3420 (let ((ido-process-ignore-lists nil)
3421 (ido-rotate ido-rotate)
3422 (ido-cur-list ido-ignored-list))
3423 (ido-trace "try all" ido-ignored-list)
3424 (ido-set-matches))
3425 (when ido-matches
3426 (ido-trace "found " ido-matches)
3427 (setq ido-rescan t)
3428 (setq ido-process-ignore-lists-inhibit t)
3429 (setq ido-text-init ido-text)
3430 (setq ido-exit 'refresh)
3431 (exit-minibuffer)))
3433 (when (and
3434 ido-rescan
3435 (not ido-matches)
3436 (memq ido-cur-item '(file dir))
3437 (not (ido-is-root-directory))
3438 (> (length contents) 1)
3439 (not (string-match "[$]" contents)))
3440 (ido-trace "merge?")
3441 (if ido-use-merged-list
3442 (ido-undo-merge-work-directory contents nil)
3443 (when (and (eq ido-try-merged-list t)
3444 (numberp ido-auto-merge-work-directories-length)
3445 (= ido-auto-merge-work-directories-length 0)
3446 (not (and ido-auto-merge-inhibit-characters-regexp
3447 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3448 (not (input-pending-p)))
3449 (ido-trace "\n*start timer*")
3450 (setq ido-auto-merge-timer
3451 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
3453 (setq ido-rescan t)
3455 (if (and ido-use-merged-list
3456 ido-matches
3457 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
3458 (progn
3459 (ido-set-current-directory (car (cdr (car ido-matches))))
3460 (setq ido-use-merged-list t
3461 ido-exit 'keep
3462 ido-text-init ido-text)
3463 (exit-minibuffer)))
3465 ;; Insert the match-status information:
3466 (ido-set-common-completion)
3467 (let ((inf (ido-completions
3468 contents
3469 minibuffer-completion-table
3470 minibuffer-completion-predicate
3471 (not minibuffer-completion-confirm))))
3472 (ido-trace "inf" inf)
3473 (insert inf))
3475 ))))
3477 (defun ido-completions (name candidates predicate require-match)
3478 ;; Return the string that is displayed after the user's text.
3479 ;; Modified from `icomplete-completions'.
3481 (let* ((comps ido-matches)
3482 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
3483 ido-merged-indicator))
3484 first)
3486 (if (and ind ido-use-faces)
3487 (put-text-property 0 1 'face 'ido-indicator-face ind))
3489 (if (and ido-use-faces comps)
3490 (let* ((fn (ido-name (car comps)))
3491 (ln (length fn)))
3492 (setq first (format "%s" fn))
3493 (put-text-property 0 ln 'face
3494 (if (= (length comps) 1)
3495 'ido-only-match-face
3496 'ido-first-match-face)
3497 first)
3498 (if ind (setq first (concat first ind)))
3499 (setq comps (cons first (cdr comps)))))
3501 (cond ((null comps)
3502 (if ido-report-no-match
3503 (nth 6 ido-decorations) ;; [No Match]
3504 ""))
3506 ((null (cdr comps)) ;one match
3507 (concat (if (> (length (ido-name (car comps))) (length name))
3508 ;; when there is one match, show the matching file name in full
3509 (concat (nth 4 ido-decorations) ;; [ ... ]
3510 (ido-name (car comps))
3511 (nth 5 ido-decorations))
3513 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
3514 (t ;multiple matches
3515 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
3516 (alternatives
3517 (apply
3518 #'concat
3519 (cdr (apply
3520 #'nconc
3521 (mapcar
3522 (lambda (com)
3523 (setq com (ido-name com))
3524 (setq items (1- items))
3525 (cond
3526 ((< items 0) ())
3527 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
3529 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
3530 (let ((str (substring com 0)))
3531 (if (and ido-use-faces
3532 (not (string= str first))
3533 (ido-final-slash str))
3534 (put-text-property 0 (length str) 'face 'ido-subdir-face str))
3535 str)))))
3536 comps))))))
3538 (concat
3539 ;; put in common completion item -- what you get by pressing tab
3540 (if (and (stringp ido-common-match-string)
3541 (> (length ido-common-match-string) (length name)))
3542 (concat (nth 4 ido-decorations) ;; [ ... ]
3543 (substring ido-common-match-string (length name))
3544 (nth 5 ido-decorations)))
3545 ;; list all alternatives
3546 (nth 0 ido-decorations) ;; { ... }
3547 alternatives
3548 (nth 1 ido-decorations)))))))
3550 (defun ido-minibuffer-setup ()
3551 "Minibuffer setup hook for `ido'."
3552 ;; Copied from `icomplete-minibuffer-setup-hook'.
3553 (when (and (boundp 'ido-completing-read)
3554 (or ido-xemacs (= ido-use-mycompletion-depth (minibuffer-depth))))
3555 (add-hook 'pre-command-hook 'ido-tidy nil t)
3556 (add-hook 'post-command-hook 'ido-exhibit nil t)
3557 (setq cua-inhibit-cua-keys t)
3558 (when ido-xemacs
3559 (ido-exhibit)
3560 (goto-char (point-min)))
3561 (run-hooks 'ido-minibuffer-setup-hook)))
3563 (defun ido-tidy ()
3564 "Pre command hook for `ido'."
3565 ;; Remove completions display, if any, prior to new user input.
3566 ;; Copied from `icomplete-tidy'."
3568 (when ido-auto-merge-timer
3569 (ido-trace "\n*cancel timer*" this-command)
3570 (cancel-timer ido-auto-merge-timer)
3571 (setq ido-auto-merge-timer nil))
3573 (if (and (boundp 'ido-use-mycompletion-depth)
3574 (= ido-use-mycompletion-depth (minibuffer-depth)))
3575 (if (and (boundp 'ido-eoinput)
3576 ido-eoinput)
3578 (if (> ido-eoinput (point-max))
3579 ;; Oops, got rug pulled out from under us - reinit:
3580 (setq ido-eoinput (point-max))
3581 (let ((buffer-undo-list t))
3582 (delete-region ido-eoinput (point-max))))
3584 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
3585 (make-local-variable 'ido-eoinput)
3586 (setq ido-eoinput 1))))
3588 (defun ido-summary-buffers-to-end ()
3589 ;; Move the summaries to the end of the buffer list.
3590 ;; This is an example function which can be hooked on to
3591 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
3592 ;; `Summary' or `output\*$'are put to the end of the list.
3593 (let ((summaries (delq nil (mapcar
3594 (lambda (x)
3595 (if (or
3596 (string-match "Summary" x)
3597 (string-match "output\\*\\'" x))
3599 ido-temp-list))))
3600 (ido-to-end summaries)))
3602 ;;; Helper functions for other programs
3604 ;;;###autoload
3605 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
3606 "Read file name, prompting with PROMPT and completing in directory DIR.
3607 See `read-file-name' for additional parameters."
3608 (message "%S %S %S %S" this-command ido-read-file-name-non-ido
3609 predicate (memq this-command ido-read-file-name-non-ido))
3610 (cond
3611 ((or (eq predicate 'file-directory-p)
3612 (memq this-command ido-read-file-name-as-directory-commands))
3613 (ido-read-directory-name prompt dir default-filename mustmatch initial))
3614 ((and (not (memq this-command ido-read-file-name-non-ido))
3615 (or (null predicate) (eq predicate 'file-exists-p)))
3616 (message "gotit")
3617 (let (filename
3618 ido-saved-vc-mt
3619 (vc-master-templates (and (boundp 'vc-master-templates) vc-master-templates))
3620 (ido-current-directory (expand-file-name (or dir default-directory)))
3621 (ido-work-directory-index -1)
3622 (ido-work-file-index -1)
3623 (ido-find-literal nil))
3624 (setq filename
3625 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
3626 (if filename
3627 (concat ido-current-directory filename))))
3629 (let ((read-file-name-function nil))
3630 (read-file-name prompt dir default-filename mustmatch initial predicate)))))
3632 ;;;###autoload
3633 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
3634 "Read directory name, prompting with PROMPT and completing in directory DIR.
3635 See `read-file-name' for additional parameters."
3636 (let (filename
3637 ido-saved-vc-mt
3638 (ido-current-directory (expand-file-name (or dir default-directory)))
3639 (ido-work-directory-index -1)
3640 (ido-work-file-index -1))
3641 (setq filename
3642 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
3643 (if filename
3644 (if (and (stringp filename) (string-equal filename "."))
3645 ido-current-directory
3646 (concat ido-current-directory filename)))))
3648 ;;; ido.el ends here