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