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