Update copyright year to 2014 by running admin/update-copyright.
[emacs.git] / lisp / ido.el
blobf405aa0eb41f046af1833d5feaa01c636c4261a5
1 ;;; ido.el --- interactively do things with buffers and files
3 ;; Copyright (C) 1996-2014 Free Software Foundation, Inc.
5 ;; Author: Kim F. Storm <storm@cua.dk>
6 ;; Based on: iswitchb by Stephen Eglen <stephen@cns.ed.ac.uk>
7 ;; Keywords: extensions convenience
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Ido - interactive do - switches between buffers and opens files and
28 ;; directories with a minimum of keystrokes. It is a superset of
29 ;; iswitchb, the interactive buffer switching package by Stephen Eglen.
31 ;; Interactive substring matching
32 ;; ------------------------------
34 ;; As you type in a substring, the list of buffers or files currently
35 ;; matching the substring are displayed as you type. The list is
36 ;; ordered so that the most recent buffers or files visited come at
37 ;; the start of the list.
39 ;; The buffer or file at the start of the list will be the one visited
40 ;; when you press RETURN. By typing more of the substring, the list is
41 ;; narrowed down so that gradually the buffer or file you want will be
42 ;; at the top of the list. Alternatively, you can use C-s and C-r (or
43 ;; the right and left arrow keys) to rotate buffer or file names in the
44 ;; list until the one you want is at the top of the list.
46 ;; Completion is also available so that you can see what is common to
47 ;; all of the matching buffers or files as you type.
49 ;; Example:
51 ;; If I have two buffers called "123456" and "123", with "123456" the
52 ;; most recent, when I use ido-switch-buffer, I first of all get
53 ;; presented with the list of all the buffers
55 ;; Buffer: {123456 | 123}
57 ;; If I then press 2:
58 ;; Buffer: 2[3]{123456 | 123}
60 ;; The list in {...} are the matching buffers, most recent first
61 ;; (buffers visible in the current frame are put at the end of the
62 ;; list by default). At any time I can select the item at the head of
63 ;; the list by pressing RET. I can also put the first element at the
64 ;; end of the list by pressing C-s or [right], or bring the last
65 ;; element to the head of the list by pressing C-r or [left].
67 ;; The item in [...] indicates what can be added to my input by
68 ;; pressing TAB. In this case, I will get "3" added to my input.
70 ;; So, I press TAB:
71 ;; Buffer: 23{123456 | 123}
73 ;; At this point, I still have two matching buffers.
74 ;; If I want the first buffer in the list, I simply press RET. If I
75 ;; wanted the second in the list, I could press C-s to move it to the
76 ;; top of the list and then RET to select it.
78 ;; However, if I type 4, I only have one match left:
79 ;; Buffer: 234[123456]
81 ;; Since there is only one matching buffer left, it is given in [] and
82 ;; it is shown in the `ido-only-match' face (ForestGreen). I can now
83 ;; press TAB or RET to go to that buffer.
85 ;; If I want to create a new buffer named "234", I press C-j instead of
86 ;; TAB or RET.
88 ;; If instead, I type "a":
89 ;; Buffer: 234a [No match]
90 ;; There are no matching buffers. If I press RET or TAB, I can be
91 ;; prompted to create a new buffer called "234a".
93 ;; Of course, where this function comes in really useful is when you
94 ;; can specify the buffer using only a few keystrokes. In the above
95 ;; example, the quickest way to get to the "123456" file would be
96 ;; just to type 4 and then RET (assuming there isn't any newer buffer
97 ;; with 4 in its name).
99 ;; Likewise, if you use C-x C-f (ido-find-file), the list of files and
100 ;; directories in the current directory is provided in the same
101 ;; fashion as the buffers above. The files and directories are
102 ;; normally sorted in alphabetical order, but the most recently
103 ;; visited directory is placed first to speed up navigating to
104 ;; directories that you have visited recently.
106 ;; In addition to scrolling through the list using [right] and [left],
107 ;; you can use [up] and [down] to quickly scroll the list to the next
108 ;; or previous subdirectory.
110 ;; To go down into a subdirectory, and continue the file selection on
111 ;; the files in that directory, simply move the directory to the head
112 ;; of the list and hit RET.
114 ;; To go up to the parent directory, delete any partial file name
115 ;; already specified (e.g. using [backspace]) and hit [backspace].
117 ;; To go to the root directory (on the current drive), enter two
118 ;; slashes. On MS-DOS or Windows, to select the root of another
119 ;; drive, enter X:/ where X is the drive letter. You can also visit
120 ;; files on other hosts using the ange-ftp notations `/host:' and
121 ;; `/user@host:'. See the variable `ido-slow-ftp-hosts' if you want
122 ;; to inhibit the ido substring matching for ftp access.
124 ;; If for some reason you cannot specify the proper file using
125 ;; ido-find-file, you can press C-f to enter the normal find-file.
126 ;; You can also press C-b to drop into ido-switch-buffer.
128 ;; See the doc string of ido-switch-buffer and ido-find-file for full
129 ;; keybindings and features.
130 ;; (describe-function 'ido-find-file)
132 ;; Hidden buffers and files
133 ;; ------------------------
135 ;; Normally, ido does not include hidden buffers (whose name starts
136 ;; with a space) and hidden files and directories (whose name starts
137 ;; with `.') in the list of possible completions. However, if the
138 ;; substring you enter does not match any of the visible buffers or
139 ;; files, ido will automatically look for completions among the hidden
140 ;; buffers or files.
142 ;; You can toggle display of the hidden buffers and files with C-a.
144 ;; Additional functionality
145 ;; ------------------------
147 ;; After C-x b, the buffer at the head of the list can be killed by
148 ;; pressing C-k. If the buffer needs saving, you will be queried
149 ;; before the buffer is killed.
151 ;; Likewise, after C-x C-f, you can delete (i.e. physically remove)
152 ;; the file at the head of the list with C-k. You will always be
153 ;; asked for confirmation before the file is deleted.
155 ;; If you enter C-x b to switch to a buffer visiting a given file, and
156 ;; you find that the file you are after is not in any buffer, you can
157 ;; press C-f to immediately drop into ido-find-file. And you can
158 ;; switch back to buffer selection with C-b.
160 ;; Prefix matching
161 ;; ---------------
163 ;; The standard way of completion with Unix-shells and Emacs is to insert a
164 ;; PREFIX and then hitting TAB (or another completion key). Cause of this
165 ;; behavior has become second nature to a lot of Emacs users `ido' offers in
166 ;; addition to the default substring-matching-method (look above) also the
167 ;; prefix-matching-method. The kind of matching is the only difference to
168 ;; the description of the substring-matching above.
170 ;; You can toggle prefix matching with C-p.
172 ;; Example:
174 ;; If you have again two Buffers "123456" and "123" then hitting "2" does
175 ;; not match because "2" is not a PREFIX in any of the buffer-names.
177 ;; Flexible matching
178 ;; -----------------
180 ;; If you set ido-enable-flex-matching, ido will do a more flexible
181 ;; matching (unless regexp matching is active) to find possible matches
182 ;; among the available buffer or file names if no matches are found using
183 ;; the normal prefix or substring matching.
185 ;; The flexible matching implies that any item which simply contains all
186 ;; of the entered characters in the specified sequence will match.
188 ;; Example:
190 ;; If you have four files "alpha", "beta", "gamma", and "delta",
191 ;; entering "aa" will match "alpha" and "gamma", while "ea" matches
192 ;; "beta" and "delta". If prefix matching is also active, "aa" only
193 ;; matches "alpha", while "ea" does not match any files.
195 ;; Regexp matching
196 ;; ---------------
198 ;; There is limited provision for regexp matching within ido,
199 ;; enabled through `ido-enable-regexp' (toggle with C-t).
200 ;; This allows you to type `[ch]$' for example and see all file names
201 ;; ending in `c' or `h'.
203 ;; Note: ido-style completion is inhibited when you enable regexp matching.
206 ;; Customization
207 ;; -------------
209 ;; Customize the `ido' group to change the `ido' functionality.
211 ;; To modify the keybindings, use the ido-setup-hook. For example:
212 ;;(add-hook 'ido-setup-hook 'ido-my-keys)
214 ;;(defun ido-my-keys ()
215 ;; "Add my keybindings for ido."
216 ;; (define-key ido-completion-map " " 'ido-next-match)
217 ;; )
219 ;; Seeing all the matching buffers or files
220 ;; ----------------------------------------
222 ;; If you have many matching files, they may not all fit onto one
223 ;; line of the minibuffer. Normally, the minibuffer window will grow
224 ;; to show you more of the matching files (depending on the setting
225 ;; of the variables `resize-mini-windows' and `max-mini-window-height').
226 ;; If you want ido to behave differently from the default minibuffer
227 ;; resizing behavior, set the variable `ido-max-window-height'.
229 ;; Also, to improve the responsiveness of ido, the maximum number of
230 ;; matching items is limited to 12, but you can increase or removed
231 ;; this limit via the `ido-max-prospects' variable.
233 ;; To see a full list of all matching buffers in a separate buffer,
234 ;; hit ? or press TAB when there are no further completions to the
235 ;; substring. Repeated TAB presses will scroll you through this
236 ;; separate buffer.
238 ;; Changing the list of files
239 ;; --------------------------
241 ;; By default, the list of current files is most recent first,
242 ;; oldest last, with the exception that the files visible in the
243 ;; current frame are put at the end of the list. A hook exists to
244 ;; allow other functions to order the list. For example, if you add:
246 ;; (add-hook 'ido-make-buffer-list-hook 'ido-summary-buffers-to-end)
248 ;; then all files matching "Summary" are moved to the end of the
249 ;; list. (I find this handy for keeping the INBOX Summary and so on
250 ;; out of the way.) It also moves files matching "output\*$" to the
251 ;; end of the list (these are created by AUCTeX when compiling.)
252 ;; Other functions could be made available which alter the list of
253 ;; matching files (either deleting or rearranging elements.)
255 ;; Highlighting
256 ;; ------------
258 ;; The highlighting of matching items is controlled via ido-use-faces.
259 ;; The faces used are ido-first-match, ido-only-match and
260 ;; ido-subdir.
261 ;; Coloring of the matching item was suggested by
262 ;; Carsten Dominik (dominik@strw.leidenuniv.nl).
264 ;; Replacement for read-buffer and read-file-name
265 ;; ----------------------------------------------
267 ;; ido-read-buffer and ido-read-file-name have been written to be drop
268 ;; in replacements for the normal buffer and file name reading
269 ;; functions `read-buffer' and `read-file-name'.
271 ;; To use ido for all buffer and file selections in Emacs, customize the
272 ;; variable `ido-everywhere'.
274 ;; Using ido-like behavior in other Lisp packages
275 ;; -----------------------------------------------
277 ;; If you don't want to rely on the `ido-everywhere' functionality,
278 ;; ido-read-buffer, ido-read-file-name, and ido-read-directory-name
279 ;; can be used by other packages to read a buffer name, a file name,
280 ;; or a directory name in the `ido' way.
282 ;;; Acknowledgments
284 ;; Infinite amounts of gratitude goes to Stephen Eglen <stephen@cns.ed.ac.uk>
285 ;; who wrote iswitch-buffer mode - from which I ripped off 99% of the code
286 ;; for ido-switch-buffer and found the inspiration for ido-find-file.
287 ;; The ido package would never have existed without his work.
289 ;; Also thanks to Klaus Berndl, Rohit Namjoshi, Robert Fenk, Alex
290 ;; Schroeder, Bill Benedetto, Stephen Eglen, and many others for bug
291 ;; fixes and improvements.
293 ;;; History
295 ;; Since I discovered Stephen Eglen's excellent iswitchb package, I just
296 ;; couldn't live without it, but once being addicted to switching buffers
297 ;; with a minimum of keystrokes, I soon found that opening files in the
298 ;; old-fashioned way was just too slow - so I decided to write a package
299 ;; which could open files with the same speed and ease as iswitchb could
300 ;; switch buffers.
302 ;; I originally wrote a separate ifindf.el package based on a copy of
303 ;; iswitchb.el, which did for opening files what iswitchb did for
304 ;; switching buffers. Along the way, I corrected a few errors in
305 ;; ifindf which could have found its way back into iswitchb, but since
306 ;; most of the functionality of the two package was practically
307 ;; identical, I decided that the proper thing to do was to merge my
308 ;; ifindf package back into iswitchb.
310 ;; This is basically what ido (interactively do) is all about; but I
311 ;; found it awkward to merge my changes into the "iswitchb-" namespace,
312 ;; so I invented a common "ido-" namespace for the merged packages.
314 ;; This version is based on ido.el version 1.57 released on
315 ;; gnu.emacs.sources adapted for Emacs 22.1 to use command remapping
316 ;; and optionally hooking the read-buffer and read-file-name functions.
318 ;; Prefix matching was added by Klaus Berndl <klaus.berndl@sdm.de> based on
319 ;; an idea of Yuji Minejima <ggb01164@nifty.ne.jp> and his mcomplete-package.
322 ;;; Code:
324 (defvar recentf-list)
326 ;;; User Variables
328 ;; These are some things you might want to change.
330 (defun ido-fractionp (n)
331 "Return t if N is a fraction."
332 (and (numberp n) (> n 0.0) (<= n 1.0)))
334 (defgroup ido nil
335 "Switch between files using substrings."
336 :group 'extensions
337 :group 'convenience
338 :version "22.1"
339 :link '(emacs-commentary-link :tag "Commentary" "ido.el")
340 :link '(emacs-library-link :tag "Lisp File" "ido.el"))
342 ;;;###autoload
343 (defcustom ido-mode nil
344 "Determines for which buffer/file Ido should be enabled.
345 The following values are possible:
346 - `buffer': Turn only on ido buffer behavior (switching, killing,
347 displaying...)
348 - `file': Turn only on ido file behavior (finding, writing, inserting...)
349 - `both': Turn on ido buffer and file behavior.
350 - nil: Turn off any ido switching.
352 Setting this variable directly does not take effect;
353 use either \\[customize] or the function `ido-mode'."
354 :set #'(lambda (_symbol value)
355 (ido-mode value))
356 :initialize 'custom-initialize-default
357 :require 'ido
358 :link '(emacs-commentary-link "ido.el")
359 :set-after '(ido-save-directory-list-file
360 ;; This will clear ido-unc-hosts-cache, so set it
361 ;; before loading history file.
362 ido-unc-hosts)
363 :type '(choice (const :tag "Turn on only buffer" buffer)
364 (const :tag "Turn on only file" file)
365 (const :tag "Turn on both buffer and file" both)
366 (const :tag "Switch off all" nil))
367 :group 'ido)
369 (defcustom ido-case-fold case-fold-search
370 "Non-nil if searching of buffer and file names should ignore case."
371 :type 'boolean
372 :group 'ido)
374 (defcustom ido-ignore-buffers
375 '("\\` ")
376 "List of regexps or functions matching buffer names to ignore.
377 For example, traditional behavior is not to list buffers whose names begin
378 with a space, for which the regexp is `\\` '. See the source file for
379 example functions that filter buffer names."
380 :type '(repeat (choice regexp function))
381 :group 'ido)
383 (defcustom ido-ignore-files
384 '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
385 "List of regexps or functions matching file names to ignore.
386 For example, traditional behavior is not to list files whose names begin
387 with a #, for which the regexp is `\\`#'. See the source file for
388 example functions that filter filenames."
389 :type '(repeat (choice regexp function))
390 :group 'ido)
392 (defcustom ido-ignore-extensions t
393 "Non-nil means ignore files in `completion-ignored-extensions' list."
394 :type 'boolean
395 :group 'ido)
397 (defcustom ido-show-dot-for-dired nil
398 "Non-nil means to always put . as the first item in file name lists.
399 This allows the current directory to be opened immediately with `dired'."
400 :type 'boolean
401 :group 'ido)
403 (defcustom ido-file-extensions-order nil
404 "List of file extensions specifying preferred order of file selections.
405 Each element is either a string with `.' as the first char, an empty
406 string matching files without extension, or t which is the default order
407 for files with an unlisted file extension."
408 :type '(repeat (choice string
409 (const :tag "Default order" t)))
410 :group 'ido)
412 (defcustom ido-ignore-directories
413 '("\\`CVS/" "\\`\\.\\./" "\\`\\./")
414 "List of regexps or functions matching sub-directory names to ignore."
415 :type '(repeat (choice regexp function))
416 :group 'ido)
418 (defcustom ido-ignore-directories-merge nil
419 "List of regexps or functions matching directory names to ignore during merge.
420 Directory names matched by one of the regexps in this list are not inserted
421 in merged file and directory lists."
422 :type '(repeat (choice regexp function))
423 :group 'ido)
425 ;; Examples for setting the value of ido-ignore-buffers
426 ;;(defun ido-ignore-c-mode (name)
427 ;; "Ignore all c mode buffers -- example function for ido."
428 ;; (with-current-buffer name
429 ;; (derived-mode-p 'c-mode)))
431 ;;(setq ido-ignore-buffers '("^ " ido-ignore-c-mode))
433 ;; Examples for setting the value of ido-ignore-files
434 ;;(setq ido-ignore-files '("^ " "\\.c\\'" "\\.h\\'"))
436 (defcustom ido-default-file-method 'raise-frame
437 "How to visit a new file when using `ido-find-file'.
438 Possible values:
439 `selected-window' Show new file in selected window
440 `other-window' Show new file in another window (same frame)
441 `display' Display file in another window without selecting to it
442 `other-frame' Show new file in another frame
443 `maybe-frame' If a file is visible in another frame, prompt to ask if you
444 you want to see the file in the same window of the current
445 frame or in the other frame
446 `raise-frame' If a file is visible in another frame, raise that
447 frame; otherwise, visit the file in the same window"
448 :type '(choice (const :tag "Visit in selected window" selected-window)
449 (const :tag "Visit in other window" other-window)
450 (const :tag "Display (no select) in other window" display)
451 (const :tag "Visit in other frame" other-frame)
452 (const :tag "Ask to visit in other frame" maybe-frame)
453 (const :tag "Raise frame if already visited" raise-frame))
454 :group 'ido)
456 (defcustom ido-default-buffer-method 'raise-frame
457 "How to switch to new buffer when using `ido-switch-buffer'.
458 See `ido-default-file-method' for details."
459 :type '(choice (const :tag "Show in selected window" selected-window)
460 (const :tag "Show in other window" other-window)
461 (const :tag "Display (no select) in other window" display)
462 (const :tag "Show in other frame" other-frame)
463 (const :tag "Ask to show in other frame" maybe-frame)
464 (const :tag "Raise frame if already shown" raise-frame))
465 :group 'ido)
467 (defcustom ido-enable-flex-matching nil
468 "Non-nil means that `ido' will do flexible string matching.
469 Flexible matching means that if the entered string does not
470 match any item, any item containing the entered characters
471 in the given sequence will match."
472 :type 'boolean
473 :group 'ido)
476 (defcustom ido-enable-regexp nil
477 "Non-nil means that `ido' will do regexp matching.
478 Value can be toggled within `ido' using `ido-toggle-regexp'."
479 :type 'boolean
480 :group 'ido)
482 (defcustom ido-enable-prefix nil
483 "Non-nil means only match if the entered text is a prefix of file name.
484 This behavior is like the standard Emacs completion.
485 If nil, match if the entered text is an arbitrary substring.
486 Value can be toggled within `ido' using `ido-toggle-prefix'."
487 :type 'boolean
488 :group 'ido)
490 (defcustom ido-enable-dot-prefix nil
491 "Non-nil means to match leading dot as prefix.
492 I.e. hidden files and buffers will match only if you type a dot
493 as first char even if `ido-enable-prefix' is nil."
494 :type 'boolean
495 :group 'ido)
497 ;; See http://debbugs.gnu.org/2042 for more info.
498 (defcustom ido-buffer-disable-smart-matches t
499 "Non-nil means not to re-order matches for buffer switching.
500 By default, ido arranges matches in the following order:
502 full-matches > suffix matches > prefix matches > remaining matches
504 which can get in the way for buffer switching."
505 :version "24.3"
506 :type 'boolean
507 :group 'ido)
509 (defcustom ido-confirm-unique-completion nil
510 "Non-nil means that even a unique completion must be confirmed.
511 This means that \\[ido-complete] must always be followed by \\[ido-exit-minibuffer]
512 even when there is only one unique completion."
513 :type 'boolean
514 :group 'ido)
516 (defcustom ido-cannot-complete-command 'ido-completion-help
517 "Command run when `ido-complete' can't complete any more.
518 The most useful values are `ido-completion-help', which pops up a
519 window with completion alternatives, or `ido-next-match' or
520 `ido-prev-match', which cycle the buffer list."
521 :type 'function
522 :group 'ido)
525 (defcustom ido-record-commands t
526 "Non-nil means that Ido will record commands in command history.
527 Note that the non-Ido equivalent command is recorded."
528 :type 'boolean
529 :group 'ido)
531 (defcustom ido-max-prospects 12
532 "Upper limit of the prospect list if non-zero.
533 Zero means no limit for the prospect list.
534 For a long list of prospects, building the full list for the
535 minibuffer can take a non-negligible amount of time; setting this
536 variable reduces that time."
537 :type 'integer
538 :group 'ido)
540 (defcustom ido-max-file-prompt-width 0.35
541 "Upper limit of the prompt string.
542 If value is an integer, it specifies the number of characters of
543 the string.
544 If value is a floating point number, it specifies a fraction of
545 the frame width."
546 :type '(choice
547 (integer :tag "Characters" :value 20)
548 (restricted-sexp :tag "Fraction of frame width"
549 :value 0.35
550 :match-alternatives (ido-fractionp)))
551 :group 'ido)
553 (defcustom ido-max-window-height nil
554 "Non-nil specifies a value to override `max-mini-window-height'."
555 :type '(choice
556 (const :tag "Don't override" nil)
557 (integer :tag "Number of lines" :value 1)
558 (restricted-sexp
559 :tag "Fraction of window height"
560 :value 0.25
561 :match-alternatives (ido-fractionp)))
562 :group 'ido)
564 (defcustom ido-enable-last-directory-history t
565 "Non-nil means that `ido' will remember latest selected directory names.
566 See `ido-last-directory-list' and `ido-save-directory-list-file'."
567 :type 'boolean
568 :group 'ido)
570 (defcustom ido-max-work-directory-list 50
571 "Maximum number of working directories to record.
572 This is the list of directories where files have most recently been opened.
573 See `ido-work-directory-list' and `ido-save-directory-list-file'."
574 :type 'integer
575 :group 'ido)
577 (defcustom ido-work-directory-list-ignore-regexps nil
578 "List of regexps matching directories which should not be recorded.
579 Directory names matched by one of the regexps in this list are not inserted in
580 the `ido-work-directory-list' list."
581 :type '(repeat regexp)
582 :group 'ido)
585 (defcustom ido-use-filename-at-point nil
586 "Non-nil means that ido shall look for a filename at point.
587 May use `ffap-guesser' to guess whether text at point is a filename.
588 If found, use that as the starting point for filename selection."
589 :type '(choice
590 (const :tag "Disabled" nil)
591 (const :tag "Guess filename" guess)
592 (other :tag "Use literal filename" t))
593 :group 'ido)
596 (defcustom ido-use-url-at-point nil
597 "Non-nil means that ido shall look for a URL at point.
598 If found, call `find-file-at-point' to visit it."
599 :type 'boolean
600 :group 'ido)
603 (defcustom ido-enable-tramp-completion t
604 "Non-nil means that ido shall perform tramp method and server name completion.
605 A tramp file name uses the following syntax: /method:user@host:filename."
606 :type 'boolean
607 :group 'ido)
609 (defcustom ido-record-ftp-work-directories t
610 "Non-nil means record ftp file names in the work directory list."
611 :type 'boolean
612 :group 'ido)
614 (defcustom ido-merge-ftp-work-directories nil
615 "If nil, merging ignores ftp file names in the work directory list."
616 :type 'boolean
617 :group 'ido)
619 (defcustom ido-cache-ftp-work-directory-time 1.0
620 "Maximum time to cache contents of an ftp directory (in hours).
621 \\<ido-file-completion-map>
622 Use \\[ido-reread-directory] in prompt to refresh list.
623 If zero, ftp directories are not cached."
624 :type 'number
625 :group 'ido)
627 (defcustom ido-slow-ftp-hosts nil
628 "List of slow ftp hosts where ido prompting should not be used.
629 If an ftp host is on this list, ido automatically switches to the non-ido
630 equivalent function, e.g. `find-file' rather than `ido-find-file'."
631 :type '(repeat string)
632 :group 'ido)
634 (defcustom ido-slow-ftp-host-regexps nil
635 "List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
636 :type '(repeat regexp)
637 :group 'ido)
639 (defvar ido-unc-hosts-cache t
640 "Cached value from the function `ido-unc-hosts'.")
642 (defcustom ido-unc-hosts nil
643 "List of known UNC host names to complete after initial //.
644 If value is a function, that function is called to search network for
645 hosts on first use of UNC path."
646 :type '(choice (repeat :tag "List of UNC host names" string)
647 (function-item :tag "Use `NET VIEW'"
648 :value ido-unc-hosts-net-view)
649 (function :tag "Your own function"))
650 :set #'(lambda (symbol value)
651 (set symbol value)
652 (setq ido-unc-hosts-cache t))
653 :group 'ido)
655 (defcustom ido-downcase-unc-hosts t
656 "Non-nil if UNC host names should be downcased."
657 :type 'boolean
658 :group 'ido)
660 (defcustom ido-ignore-unc-host-regexps nil
661 "List of regexps matching UNC hosts to ignore.
662 Case is ignored if `ido-downcase-unc-hosts' is set."
663 :type '(repeat regexp)
664 :group 'ido)
666 (defcustom ido-cache-unc-host-shares-time 8.0
667 "Maximum time to cache shares of an UNC host (in hours).
668 \\<ido-file-completion-map>
669 Use \\[ido-reread-directory] in prompt to refresh list.
670 If zero, UNC host shares are not cached."
671 :type 'number
672 :group 'ido)
674 (defcustom ido-max-work-file-list 10
675 "Maximum number of names of recently opened files to record.
676 This is the list of the file names (sans directory) which have most recently
677 been opened. See `ido-work-file-list' and `ido-save-directory-list-file'."
678 :type 'integer
679 :group 'ido)
681 (defcustom ido-work-directory-match-only t
682 "Non-nil means to skip non-matching directories in the directory history.
683 When some text is already entered at the `ido-find-file' prompt, using
684 \\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories
685 without any matching entries."
686 :type 'boolean
687 :group 'ido)
689 (defcustom ido-auto-merge-work-directories-length 0
690 "Automatically switch to merged work directories during file name input.
691 The value is number of characters to type before switching to merged mode.
692 If zero, the switch happens when no matches are found in the current directory.
693 Automatic merging is disabled if the value is negative."
694 :type 'integer
695 :group 'ido)
697 (defcustom ido-auto-merge-delay-time 0.70
698 "Delay in seconds to wait for more input before doing auto merge."
699 :type 'number
700 :group 'ido)
702 (defcustom ido-auto-merge-inhibit-characters-regexp "[][*?~]"
703 "Regexp matching characters which should inhibit automatic merging.
704 When a (partial) file name matches this regexp, merging is inhibited."
705 :type 'regexp
706 :group 'ido)
708 (defcustom ido-merged-indicator "^"
709 "The string appended to first choice if it has multiple directory choices."
710 :type 'string
711 :group 'ido)
713 (defcustom ido-max-dir-file-cache 100
714 "Maximum number of working directories to be cached.
715 \\<ido-file-completion-map>
716 This is the size of the cache of `file-name-all-completions' results.
717 Each cache entry is time stamped with the modification time of the
718 directory. Some systems, like Windows, have unreliable directory
719 modification times, so you may choose to disable caching on such
720 systems, or explicitly refresh the cache contents using the command
721 `ido-reread-directory' command (\\[ido-reread-directory]) in the minibuffer.
722 See also `ido-dir-file-cache' and `ido-save-directory-list-file'."
723 :type 'integer
724 :group 'ido)
726 (defcustom ido-max-directory-size nil
727 "Maximum size (in bytes) for directories to use ido completion.
728 \\<ido-completion-map>
729 If you enter a directory with a size larger than this size, ido will
730 not provide the normal completion. To show the completions, use \\[ido-toggle-ignore]."
731 :type '(choice (const :tag "No limit" nil)
732 (integer :tag "Size in bytes" 30000))
733 :group 'ido)
735 (defcustom ido-rotate-file-list-default nil
736 "Non-nil means that `ido' will always rotate file list to get default in front."
737 :type 'boolean
738 :group 'ido)
740 (defcustom ido-enter-matching-directory 'only
741 "Additional methods to enter sub-directory of first/only matching item.
742 If value is 'first, enter first matching sub-directory when typing a slash.
743 If value is 'only, typing a slash only enters the sub-directory if it is
744 the only matching item.
745 If value is t, automatically enter a sub-directory when it is the only
746 matching item, even without typing a slash."
747 :type '(choice (const :tag "Never" nil)
748 (const :tag "Slash enters first directory" first)
749 (const :tag "Slash enters first and only directory" only)
750 (other :tag "Always enter unique directory" t))
751 :group 'ido)
753 (defcustom ido-create-new-buffer 'prompt
754 "Specify whether a new buffer is created if no buffer matches substring.
755 Choices are 'always to create new buffers unconditionally, 'prompt to
756 ask user whether to create buffer, or 'never to never create new buffer."
757 :type '(choice (const always)
758 (const prompt)
759 (const never))
760 :group 'ido)
762 (defcustom ido-setup-hook nil
763 "Hook run after the ido variables and keymap have been setup.
764 The dynamic variable `ido-cur-item' contains the current type of item that
765 is read by ido; possible values are file, dir, buffer, and list.
766 Additional keys can be defined in `ido-completion-map'."
767 :type 'hook
768 :group 'ido)
770 (defcustom ido-separator nil
771 "String used by ido to separate the alternatives in the minibuffer.
772 Obsolete. Set 3rd element of `ido-decorations' instead."
773 :type '(choice string (const nil))
774 :group 'ido)
776 (defcustom ido-decorations '( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]" " [Not readable]" " [Too big]" " [Confirm]")
777 "List of strings used by ido to display the alternatives in the minibuffer.
778 There are between 11 and 13 elements in this list:
779 1st and 2nd elements are used as brackets around the prospect list,
780 3rd element is the separator between prospects (ignored if
781 `ido-separator' is set),
782 4th element is the string inserted at the end of a truncated list of prospects,
783 5th and 6th elements are used as brackets around the common match string which
784 can be completed using TAB,
785 7th element is the string displayed when there are no matches, and
786 8th element is displayed if there is a single match (and faces are not used),
787 9th element is displayed when the current directory is non-readable,
788 10th element is displayed when directory exceeds `ido-max-directory-size',
789 11th element is displayed to confirm creating new file or buffer.
790 12th and 13th elements (if present) are used as brackets around the sole
791 remaining completion. If absent, elements 5 and 6 are used instead."
792 :type '(repeat string)
793 :group 'ido)
795 (defcustom ido-use-virtual-buffers nil
796 "Specify how virtual buffers should be used.
797 The value can be one of the following:
799 nil: No virtual buffers are used.
800 auto: Use virtual buffers when the current input matches no
801 existing buffers.
802 t: Always use virtual buffers.
804 Essentially it works as follows: Say you are visiting a file and
805 the buffer gets cleaned up by midnight.el. Later, you want to
806 switch to that buffer, but find it's no longer open. With virtual
807 buffers enabled, the buffer name stays in the buffer list (using
808 the `ido-virtual' face, and always at the end), and if you select
809 it, it opens the file back up again. This allows you to think
810 less about whether recently opened files are still open or not.
811 Most of the time you can quit Emacs, restart, and then switch to
812 a file buffer that was previously open as if it still were. This
813 feature relies upon the `recentf' package, which will be enabled
814 if this variable is configured to a non-nil value."
815 :version "24.4"
816 :type '(choice (const :tag "Always" t)
817 (const :tag "Automatic" auto)
818 (const :tag "Never" nil))
819 :group 'ido)
821 (defcustom ido-use-faces t
822 "Non-nil means use ido faces to highlighting first match, only match and
823 subdirs in the alternatives."
824 :type 'boolean
825 :group 'ido)
827 (defface ido-first-match '((t :weight bold))
828 "Face used by ido for highlighting first match."
829 :group 'ido)
831 (defface ido-only-match '((((class color))
832 :foreground "ForestGreen")
833 (t :slant italic))
834 "Face used by ido for highlighting only match."
835 :group 'ido)
837 (defface ido-subdir '((((min-colors 88) (class color))
838 :foreground "red1")
839 (((class color))
840 :foreground "red")
841 (t :underline t))
842 "Face used by ido for highlighting subdirs in the alternatives."
843 :group 'ido)
845 (defface ido-virtual '((t :inherit font-lock-builtin-face))
846 "Face used by ido for matching virtual buffer names."
847 :version "24.1"
848 :group 'ido)
850 (defface ido-indicator '((((min-colors 88) (class color))
851 :foreground "yellow1" :background "red1" :width condensed)
852 (((class color))
853 :foreground "yellow" :background "red" :width condensed)
854 (t :inverse-video t))
855 "Face used by ido for highlighting its indicators."
856 :group 'ido)
858 (defface ido-incomplete-regexp
859 '((t :inherit font-lock-warning-face))
860 "Ido face for indicating incomplete regexps."
861 :group 'ido)
863 (defcustom ido-make-file-list-hook nil
864 "List of functions to run when the list of matching files is created.
865 Each function on the list may modify the dynamically bound variable
866 `ido-temp-list' which contains the current list of matching files."
867 :type 'hook
868 :group 'ido)
870 (defcustom ido-make-dir-list-hook nil
871 "List of functions to run when the list of matching directories is created.
872 Each function on the list may modify the dynamically bound variable
873 `ido-temp-list' which contains the current list of matching directories."
874 :type 'hook
875 :group 'ido)
877 (defcustom ido-make-buffer-list-hook nil
878 "List of functions to run when the list of matching buffers is created.
879 Each function on the list may modify the dynamically bound variable
880 `ido-temp-list' which contains the current list of matching buffer names."
881 :type 'hook
882 :group 'ido)
884 (defcustom ido-rewrite-file-prompt-functions nil
885 "List of functions to run when the find-file prompt is created.
886 Each function on the list may modify the following dynamically bound
887 variables:
888 dirname - the (abbreviated) directory name
889 to be modified by the hook functions
890 max-width - the max width of the resulting dirname; nil means no limit
891 prompt - the basic prompt (e.g. \"Find File: \")
892 literal - the string shown if doing \"literal\" find; set to nil to omit
893 vc-off - the string shown if version control is inhibited; set to nil to omit
894 prefix - either nil or a fixed prefix for the dirname
896 The following variables are available, but should not be changed:
897 `ido-current-directory' - the unabbreviated directory name
898 item - equals `file' or `dir' depending on the current mode."
899 :type 'hook
900 :group 'ido)
902 (defvar ido-rewrite-file-prompt-rules nil
903 "Alist of rewriting rules for directory names in ido prompts.
904 A list of elements of the form (FROM . TO) or (FROM . FUNC), each
905 meaning to rewrite the directory name if matched by FROM by either
906 substituting the matched string by TO or calling the function FUNC
907 with the current directory name as its only argument and using the
908 return value as the new directory name. In addition, each FUNC may
909 also modify the dynamic variables described for the variable
910 `ido-rewrite-file-prompt-functions'.")
912 (defcustom ido-completion-buffer "*Ido Completions*"
913 "Name of completion buffer used by ido.
914 Set to nil to disable completion buffers popping up."
915 :type 'string
916 :group 'ido)
918 (defcustom ido-completion-buffer-all-completions nil
919 "Non-nil means to show all completions in completion buffer.
920 Otherwise, only the current list of matches is shown."
921 :type 'boolean
922 :group 'ido)
924 (defcustom ido-all-frames 'visible
925 "Argument to pass to `walk-windows' when Ido is finding buffers.
926 See documentation of `walk-windows' for useful values."
927 :type '(choice (const :tag "Selected frame only" nil)
928 (const :tag "All existing frames" t)
929 (const :tag "All visible frames" visible)
930 (const :tag "All frames on this terminal" 0))
931 :group 'ido)
933 (defcustom ido-minibuffer-setup-hook nil
934 "Ido-specific customization of minibuffer setup.
936 This hook is run during minibuffer setup if `ido' is active.
937 It is intended for use in customizing ido for interoperation
938 with other packages. For instance:
940 \(add-hook 'ido-minibuffer-setup-hook
941 \(function
942 \(lambda ()
943 \(make-local-variable 'max-mini-window-height)
944 \(setq max-mini-window-height 3))))
946 will constrain Emacs to a maximum minibuffer height of 3 lines when
947 ido is running. Copied from `icomplete-minibuffer-setup-hook'."
948 :type 'hook
949 :group 'ido)
951 (defcustom ido-save-directory-list-file
952 (locate-user-emacs-file "ido.last" ".ido.last")
953 "File in which the ido state is saved between invocations.
954 Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
955 `ido-work-file-list', and `ido-dir-file-cache'.
956 Must be set before enabling ido mode."
957 :type 'string
958 :group 'ido)
960 (defcustom ido-read-file-name-as-directory-commands '()
961 "List of commands which uses `read-file-name' to read a directory name.
962 When `ido-everywhere' is non-nil, the commands in this list will read
963 the directory using `ido-read-directory-name'."
964 :type '(repeat symbol)
965 :group 'ido)
967 (defcustom ido-read-file-name-non-ido '()
968 "List of commands which shall not read file names the ido way.
969 When `ido-everywhere' is non-nil, the commands in this list will read
970 the file name using normal `read-file-name' style."
971 :type '(repeat symbol)
972 :group 'ido)
974 (defcustom ido-before-fallback-functions '()
975 "List of functions to call before calling a fallback command.
976 The fallback command is passed as an argument to the functions."
977 :type 'hook
978 :group 'ido)
980 ;;; Internal Variables
982 ;; Persistent variables
984 (defvar ido-completion-map nil
985 "Currently active keymap for ido commands.")
987 (defvar ido-common-completion-map nil
988 "Keymap for all ido commands.")
990 (defvar ido-file-completion-map nil
991 "Keymap for ido file commands.")
993 (defvar ido-file-dir-completion-map nil
994 "Keymap for ido file and directory commands.")
996 (defvar ido-buffer-completion-map nil
997 "Keymap for ido buffer commands.")
999 (defvar ido-file-history nil
1000 "History of files selected using `ido-find-file'.")
1002 (defvar ido-buffer-history nil
1003 "History of buffers selected using `ido-switch-buffer'.")
1005 (defvar ido-last-directory-list nil
1006 "List of last selected directory names.
1007 See `ido-enable-last-directory-history' for details.")
1009 (defvar ido-work-directory-list nil
1010 "List of actual working directory names.
1011 The current directory is inserted at the front of this list whenever a
1012 file is opened with `ido-find-file' and family.")
1014 (defvar ido-work-file-list nil
1015 "List of actual work file names.
1016 Opening a file with `ido-find-file' and similar functions
1017 inserts the current file name (relative to its containing directory)
1018 at the front of this list.")
1020 (defvar ido-dir-file-cache nil
1021 "List of `file-name-all-completions' results.
1022 Each element in the list is of the form (DIR (MTIME) FILE...).")
1024 (defvar ido-ignore-item-temp-list nil
1025 "List of items to ignore in current ido invocation.
1026 Intended to be let-bound by functions which call ido repeatedly.
1027 Should never be set permanently.")
1029 ;; Temporary storage
1031 (defvar ido-eoinput 1
1032 "Point where minibuffer input ends and completion info begins.
1033 Copied from `icomplete-eoinput'.")
1034 (make-variable-buffer-local 'ido-eoinput)
1036 (defvar ido-common-match-string nil
1037 "Stores the string that is common to all matching files.")
1039 (defvar ido-rescan nil
1040 "Non-nil means we need to regenerate the list of matching items.")
1042 (defvar ido-rotate nil
1043 "Non-nil means we are rotating list of matches.")
1045 (defvar ido-text nil
1046 "Stores the users string as it is typed in.")
1048 (defvar ido-text-init nil
1049 "The initial string for the users string it is typed in.")
1051 (defvar ido-input-stack nil
1052 "Stores the users strings when user hits M-b/M-f.")
1054 (defvar ido-matches nil
1055 "List of files currently matching `ido-text'.")
1057 (defvar ido-report-no-match t
1058 "Report [No Match] when no completions matches `ido-text'.")
1060 (defvar ido-exit nil
1061 "Flag to monitor how `ido-find-file' exits.
1062 If equal to `takeprompt', we use the prompt as the file name to be
1063 selected.")
1065 (defvar ido-current-directory nil
1066 "Current directory for `ido-find-file'.")
1068 (defvar ido-auto-merge-timer nil
1069 "Delay timer for auto merge.")
1071 (defvar ido-use-mycompletion-depth 0
1072 "Non-nil means use `ido' completion feedback.
1073 Is set by ido functions to the current `minibuffer-depth',
1074 so that it doesn't interfere with other minibuffer usage.")
1076 (defvar ido-incomplete-regexp nil
1077 "Non-nil if an incomplete regexp is entered.")
1079 (defvar ido-initial-position nil
1080 "Non-nil means to explicitly cursor on entry to minibuffer.
1081 Value is an integer which is number of chars to right of prompt.")
1083 (defvar ido-virtual-buffers nil
1084 "List of virtual buffers, that is, past visited files.
1085 This is a copy of `recentf-list', pared down and with faces applied.
1086 Only used if `ido-use-virtual-buffers' is non-nil.")
1088 ;;; Variables with dynamic bindings.
1089 ;;; Declared here to keep the byte compiler quiet.
1091 ;; Stores the current ido item type ('file, 'dir, 'buffer, or 'list).
1092 (defvar ido-cur-item)
1094 ;;; Stores the current default item
1095 (defvar ido-default-item)
1097 ;; Stores the current list of items that will be searched through.
1098 ;; The list is ordered, so that the most interesting item comes first,
1099 ;; although by default, the files visible in the current frame are put
1100 ;; at the end of the list. Created by `ido-make-item-list'.
1101 (defvar ido-cur-list)
1103 ;; Stores the choice list for ido-completing-read
1104 (defvar ido-choice-list)
1106 ;; Stores the list of items which are ignored when building
1107 ;; `ido-cur-list'. It is in no specific order.
1108 (defvar ido-ignored-list)
1110 ;; Remember if current directory is non-readable (so we cannot do completion).
1111 (defvar ido-directory-nonreadable)
1113 ;; Remember if current directory is 'huge' (so we don't want to do completion).
1114 (defvar ido-directory-too-big)
1116 ;; Keep current item list if non-nil.
1117 (defvar ido-keep-item-list)
1119 ;; Process ido-ignore-* lists.
1120 (defvar ido-process-ignore-lists)
1122 ;; Don't process ido-ignore- lists once.
1123 (defvar ido-process-ignore-lists-inhibit)
1125 ;; Is ido using virtual buffers?
1126 (defvar ido-enable-virtual-buffers)
1128 ;; Buffer from which ido was entered.
1129 (defvar ido-entry-buffer)
1131 ;; Non-nil if matching file must be selected.
1132 (defvar ido-require-match)
1134 ;; Non-nil if we should add [confirm] to prompt
1135 (defvar ido-show-confirm-message)
1137 ;; Stores a temporary version of the file list being created.
1138 (defvar ido-temp-list)
1140 ;; Non-nil if default list element should be rotated into place.
1141 (defvar ido-rotate-temp)
1143 ;; Stores current index in ido-work-directory-list.
1144 (defvar ido-work-directory-index)
1146 ;; Stores current index in ido-work-file-list.
1147 (defvar ido-work-file-index)
1149 ;; Set when merged work directory list is in use.
1150 (defvar ido-use-merged-list)
1152 ;; Set when merged work directory list not yet built.
1153 (defvar ido-try-merged-list)
1155 ;; Saved state prior to last work directory merge.
1156 ;; Value is a list (ido-text dir cur-list ignored-list matches).
1157 (defvar ido-pre-merge-state)
1159 ;; Original value of vc-handled-backends for use in ido-toggle-vc.
1160 (defvar ido-saved-vc-hb)
1162 ;; Stores temporary state of literal find file.
1163 (defvar ido-find-literal)
1165 ;; Set to 'ignore to inhibit switching between find-file/switch-buffer.
1166 (defvar ido-context-switch-command)
1168 ;; Dynamically bound in ido-read-internal.
1169 (defvar ido-completing-read)
1171 ;;; FUNCTIONS
1173 (defun ido-active (&optional merge)
1174 (if merge
1175 ido-use-merged-list
1176 (and (boundp 'ido-completing-read)
1177 (or (featurep 'xemacs)
1178 (= ido-use-mycompletion-depth (minibuffer-depth))))))
1180 (defvar ido-trace-enable nil)
1182 (defun ido-trace (p &optional s retval)
1183 (if ido-trace-enable
1184 (let ((b (get-buffer-create " *IDO Trace*"))
1185 (deactivate-mark deactivate-mark))
1186 (save-excursion
1187 (save-restriction
1188 (set-buffer b)
1189 (insert p ": " (if (stringp s) s (format "%S" s)) "\n")))))
1190 retval)
1192 (defun ido-toggle-trace (arg)
1193 (interactive "P")
1194 (setq ido-trace-enable (or arg (not ido-trace-enable)))
1195 (if ido-trace-enable
1196 (message "IDO trace on"))
1197 (let ((b (get-buffer " *IDO Trace*")))
1198 (if b
1199 (if ido-trace-enable
1200 (kill-buffer b)
1201 (pop-to-buffer b t t)
1202 (setq truncate-lines t)))))
1204 (defun ido-local-file-exists-p (file)
1205 "Tell if FILE exists locally."
1206 (let (file-name-handler-alist)
1207 (file-exists-p file)))
1209 (defun ido-unc-hosts (&optional query)
1210 "Return list of UNC host names."
1211 (let ((hosts
1212 (cond
1213 ((listp ido-unc-hosts)
1214 ido-unc-hosts) ;; static list or nil
1215 ((listp ido-unc-hosts-cache)
1216 ido-unc-hosts-cache) ;; result of net search
1217 ((and query (fboundp ido-unc-hosts))
1218 (message (propertize "Searching for UNC hosts..." 'face 'highlight))
1219 (setq ido-unc-hosts-cache (funcall ido-unc-hosts))
1220 (message nil)
1221 ido-unc-hosts-cache)
1222 (query
1223 (setq ido-unc-hosts-cache nil))
1224 (t (fboundp ido-unc-hosts)))))
1225 (when query
1226 (let ((case-fold-search ido-downcase-unc-hosts)
1227 res host re-list re)
1228 (while hosts
1229 (setq host (car hosts)
1230 hosts (cdr hosts)
1231 re-list (and ido-process-ignore-lists
1232 ido-ignore-unc-host-regexps))
1233 (while re-list
1234 (setq re (car re-list)
1235 re-list (cdr re-list))
1236 (if (string-match re host)
1237 (setq re-list nil
1238 host nil)))
1239 (when host
1240 (when ido-downcase-unc-hosts
1241 (setq host (downcase host)))
1242 (setq res (cons host res))))
1243 (setq hosts (sort res #'string<))))
1244 hosts))
1246 (defun ido-unc-hosts-net-view ()
1247 "Query network for list of UNC host names using `NET VIEW'."
1248 (let (hosts)
1249 (with-temp-buffer
1250 (shell-command "net view" t)
1251 (goto-char (point-min))
1252 (while (re-search-forward "^\\\\\\\\\\([[:graph:]]+\\)" nil t)
1253 (setq hosts (cons (match-string 1) hosts))))
1254 hosts))
1256 (defun ido-is-tramp-root (&optional dir)
1257 (and ido-enable-tramp-completion
1258 (string-match "\\`/[^/]+[@:]\\'"
1259 (or dir ido-current-directory))))
1261 (defun ido-is-unc-root (&optional dir)
1262 (and (ido-unc-hosts)
1263 (string-equal "//"
1264 (or dir ido-current-directory))))
1266 (defun ido-is-unc-host (&optional dir)
1267 (and (ido-unc-hosts)
1268 (string-match "\\`//[^/]+/\\'"
1269 (or dir ido-current-directory))))
1271 (defun ido-is-root-directory (&optional dir)
1272 (setq dir (or dir ido-current-directory))
1274 (string-equal "/" dir)
1275 (and (memq system-type '(windows-nt ms-dos))
1276 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir))
1277 (if ido-enable-tramp-completion
1278 (ido-is-tramp-root dir)
1279 (string-match "\\`/[^:/][^:/]+:\\'" dir))))
1281 (defun ido-is-ftp-directory (&optional dir)
1282 (string-match
1283 (if ido-enable-tramp-completion
1284 "\\`/[^/:][^/:]+:" ;; like tramp-file-name-regexp-unified, but doesn't match single drive letters
1285 "\\`/[^/:][^/:]+:/")
1286 (or dir ido-current-directory)))
1288 (defun ido-is-slow-ftp-host (&optional dir)
1289 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps)
1290 (setq dir (or dir ido-current-directory))
1291 ;; (featurep 'ange-ftp)
1292 ;; (ange-ftp-ftp-name dir)
1293 (string-match
1294 (if ido-enable-tramp-completion
1295 "\\`/\\([^/]+[@:]\\)*\\([^@/:][^@/:]+\\):"
1296 "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/")
1297 dir)
1298 (let ((host (substring dir (match-beginning 2) (match-end 2))))
1299 (or (member host ido-slow-ftp-hosts)
1300 (let ((re ido-slow-ftp-host-regexps))
1301 (while (and re (not (string-match (car re) host)))
1302 (setq re (cdr re)))
1303 re)))))
1305 (defun ido-time-stamp (&optional time)
1306 ;; Time is a floating point number (fractions of 1 hour)
1307 (setq time (or time (current-time)))
1308 (/ (+ (* (car time) 65536.0) (car (cdr time))) 3600.0))
1310 (defun ido-cache-ftp-valid (&optional time)
1311 (and (numberp ido-cache-ftp-work-directory-time)
1312 (> ido-cache-ftp-work-directory-time 0)
1313 (or (not time)
1314 (< (- (ido-time-stamp) time) ido-cache-ftp-work-directory-time))))
1316 (defun ido-cache-unc-valid (&optional time)
1317 (and (numberp ido-cache-unc-host-shares-time)
1318 (> ido-cache-unc-host-shares-time 0)
1319 (or (not time)
1320 (< (- (ido-time-stamp) time) ido-cache-unc-host-shares-time))))
1322 (defun ido-may-cache-directory (&optional dir)
1323 (setq dir (or dir ido-current-directory))
1324 (cond
1325 ((and (ido-is-root-directory dir)
1326 (or ido-enable-tramp-completion
1327 (memq system-type '(windows-nt ms-dos))))
1328 nil)
1329 ((ido-is-unc-host dir)
1330 (ido-cache-unc-valid))
1331 ((ido-is-ftp-directory dir)
1332 (ido-cache-ftp-valid))
1333 ((ido-directory-too-big-p dir)
1334 nil)
1335 (t t)))
1337 (defun ido-pp (list &optional sep)
1338 (let ((print-level nil) (eval-expression-print-level nil)
1339 (print-length nil) (eval-expression-print-length nil))
1340 (insert "\n;; ----- " (symbol-name list) " -----\n(\n ")
1341 (setq list (symbol-value list))
1342 (while list
1343 (let* ((elt (car list))
1344 (s (if (consp elt) (car elt) elt)))
1345 (if (and (stringp s) (= (length s) 0))
1346 (setq s nil))
1347 (if s
1348 (prin1 elt (current-buffer)))
1349 (if (and (setq list (cdr list)) s)
1350 (insert (or sep "\n ")))))
1351 (insert "\n)\n")))
1353 (defun ido-save-history ()
1354 "Save ido history and cache information between sessions."
1355 (interactive)
1356 (when (and ido-last-directory-list ido-save-directory-list-file)
1357 (let ((buf (get-buffer-create " *ido session*"))
1358 (version-control 'never))
1359 (unwind-protect
1360 (with-current-buffer buf
1361 (erase-buffer)
1362 (insert ";;; -*- coding: utf-8 -*-\n")
1363 (setq buffer-file-coding-system 'utf-8)
1364 (ido-pp 'ido-last-directory-list)
1365 (ido-pp 'ido-work-directory-list)
1366 (ido-pp 'ido-work-file-list)
1367 (ido-pp 'ido-dir-file-cache "\n\n ")
1368 (if (listp ido-unc-hosts-cache)
1369 (ido-pp 'ido-unc-hosts-cache)
1370 (insert "\n;; ----- ido-unc-hosts-cache -----\nt\n"))
1371 (write-file ido-save-directory-list-file nil))
1372 (kill-buffer buf)))))
1374 (defun ido-load-history (&optional arg)
1375 "Load ido history and cache information from previous session.
1376 With prefix argument, reload history unconditionally."
1377 (interactive "P")
1378 (if (or arg (and ido-save-directory-list-file (not ido-last-directory-list)))
1379 (let ((file (expand-file-name ido-save-directory-list-file))
1380 buf)
1381 (when (file-readable-p file)
1382 (setq buf (get-buffer-create " *ido session*"))
1383 (unwind-protect
1384 (with-current-buffer buf
1385 (erase-buffer)
1386 (insert-file-contents file)
1387 (condition-case nil
1388 (setq ido-last-directory-list (read (current-buffer))
1389 ido-work-directory-list (read (current-buffer))
1390 ido-work-file-list (read (current-buffer))
1391 ido-dir-file-cache (read (current-buffer))
1392 ido-unc-hosts-cache (read (current-buffer)))
1393 (error nil)))
1394 (kill-buffer buf)))))
1395 (ido-wash-history))
1397 (defun ido-wash-history ()
1398 "Clean-up ido history and cache information.
1399 Removes badly formatted data and ignored directories."
1400 (interactive)
1401 ;; Check format of each of our lists, discard bogus elements
1402 (setq ido-last-directory-list
1403 (and (listp ido-last-directory-list)
1404 (let ((l ido-last-directory-list) r)
1405 (while l
1406 (if (and (consp (car l))
1407 (stringp (car (car l)))
1408 (stringp (cdr (car l))))
1409 (setq r (cons (car l) r)))
1410 (setq l (cdr l)))
1411 (nreverse r))))
1412 (setq ido-work-directory-list
1413 (and (listp ido-work-directory-list)
1414 (let ((l ido-work-directory-list) r)
1415 (while l
1416 (if (and (stringp (car l))
1417 (or ido-record-ftp-work-directories
1418 (not (ido-is-ftp-directory (car l)))))
1419 (setq r (cons (car l) r)))
1420 (setq l (cdr l)))
1421 (nreverse r))))
1422 (setq ido-work-file-list
1423 (and (listp ido-work-file-list)
1424 (let ((l ido-work-file-list) r)
1425 (while l
1426 (if (stringp (car l))
1427 (setq r (cons (car l) r)))
1428 (setq l (cdr l)))
1429 (nreverse r))))
1430 (setq ido-dir-file-cache
1431 (and (listp ido-dir-file-cache)
1432 (let ((l ido-dir-file-cache) r)
1433 (while l
1434 (if (and (listp (car l))
1435 (> (length (car l)) 2)
1436 (let ((dir (car (car l)))
1437 (time (car (cdr (car l))))
1438 (files (cdr (cdr (car l)))))
1439 (and
1440 (stringp dir)
1441 (consp time)
1442 (cond
1443 ((integerp (car time))
1444 (and (/= (car time) 0)
1445 (integerp (car (cdr time)))
1446 (/= (car (cdr time)) 0)
1447 (ido-may-cache-directory dir)))
1448 ((eq (car time) 'ftp)
1449 (and (numberp (cdr time))
1450 (ido-is-ftp-directory dir)
1451 (ido-cache-ftp-valid (cdr time))))
1452 ((eq (car time) 'unc)
1453 (and (numberp (cdr time))
1454 (ido-is-unc-host dir)
1455 (ido-cache-unc-valid (cdr time))))
1456 (t nil))
1457 (let ((s files) (ok t))
1458 (while s
1459 (if (stringp (car s))
1460 (setq s (cdr s))
1461 (setq s nil ok nil)))
1462 ok))))
1463 (setq r (cons (car l) r)))
1464 (setq l (cdr l)))
1465 (nreverse r))))
1467 ;; Remove ignored directories from work directory list
1468 ;; according to ido-work-directory-list-ignore-regexps
1469 (if ido-work-directory-list
1470 (let ((dirs (reverse ido-work-directory-list)))
1471 (setq ido-work-directory-list nil)
1472 (while dirs
1473 (ido-record-work-directory (car dirs))
1474 (setq dirs (cdr dirs)))))
1475 ;; Get rid of text properties
1476 (let ((l ido-last-directory-list) e)
1477 (while l
1478 (setq e (car l) l (cdr l))
1479 (set-text-properties 0 (length (car e)) nil (car e))
1480 (set-text-properties 0 (length (cdr e)) nil (cdr e))))
1481 (let ((l ido-work-directory-list) e)
1482 (while l
1483 (setq e (car l) l (cdr l))
1484 (set-text-properties 0 (length e) nil e)))
1485 (let ((l ido-work-file-list) e)
1486 (while l
1487 (setq e (car l) l (cdr l))
1488 (set-text-properties 0 (length e) nil e)))
1489 (let ((l ido-dir-file-cache) e d)
1490 (while l
1491 (setq e (car l) l (cdr l))
1492 (if (listp e)
1493 (while e
1494 (setq d (car e) e (cdr e))
1495 (if (not (consp d))
1496 (set-text-properties 0 (length d) nil d)))))))
1499 (defun ido-kill-emacs-hook ()
1500 ;; ido kill emacs hook
1501 (ido-save-history))
1503 (defun ido-common-initialization ()
1504 (ido-init-completion-maps)
1505 (add-hook 'minibuffer-setup-hook 'ido-minibuffer-setup)
1506 (add-hook 'choose-completion-string-functions 'ido-choose-completion-string))
1508 (define-minor-mode ido-everywhere
1509 "Toggle use of Ido for all buffer/file reading.
1510 With a prefix argument ARG, enable this feature if ARG is
1511 positive, and disable it otherwise. If called from Lisp, enable
1512 the mode if ARG is omitted or nil."
1513 :global t
1514 :group 'ido
1515 (when (get 'ido-everywhere 'file)
1516 (setq read-file-name-function (car (get 'ido-everywhere 'file)))
1517 (put 'ido-everywhere 'file nil))
1518 (when (get 'ido-everywhere 'buffer)
1519 (setq read-buffer-function (car (get 'ido-everywhere 'buffer)))
1520 (put 'ido-everywhere 'buffer nil))
1521 (when ido-everywhere
1522 (when (memq ido-mode '(both file))
1523 (put 'ido-everywhere 'file (cons read-file-name-function nil))
1524 (setq read-file-name-function 'ido-read-file-name))
1525 (when (memq ido-mode '(both buffer))
1526 (put 'ido-everywhere 'buffer (cons read-buffer-function nil))
1527 (setq read-buffer-function 'ido-read-buffer))))
1529 (defvar ido-minor-mode-map-entry nil)
1531 ;;;###autoload
1532 (defun ido-mode (&optional arg)
1533 "Toggle ido mode on or off.
1534 With ARG, turn ido-mode on if arg is positive, off otherwise.
1535 Turning on ido-mode will remap (via a minor-mode keymap) the default
1536 keybindings for the `find-file' and `switch-to-buffer' families of
1537 commands to the ido versions of these functions.
1538 However, if ARG arg equals 'files, remap only commands for files, or
1539 if it equals 'buffers, remap only commands for buffer switching.
1540 This function also adds a hook to the minibuffer."
1541 (interactive "P")
1542 (setq ido-mode
1543 (cond
1544 ((null arg) (if ido-mode nil 'both))
1545 ((eq arg t) 'both)
1546 ((eq arg 'files) 'file)
1547 ((eq arg 'buffers) 'buffer)
1548 ((memq arg '(file buffer both)) arg)
1549 ((> (prefix-numeric-value arg) 0) 'both)
1550 (t nil)))
1552 (ido-everywhere (if ido-everywhere 1 -1))
1554 (when ido-mode
1555 (ido-common-initialization)
1556 (ido-load-history)
1558 (add-hook 'kill-emacs-hook 'ido-kill-emacs-hook)
1560 (let ((map (make-sparse-keymap)))
1561 (when (memq ido-mode '(file both))
1562 (define-key map [remap find-file] 'ido-find-file)
1563 (define-key map [remap find-file-read-only] 'ido-find-file-read-only)
1564 (define-key map [remap find-alternate-file] 'ido-find-alternate-file)
1565 (define-key map [remap write-file] 'ido-write-file)
1566 (define-key map [remap insert-file] 'ido-insert-file)
1567 (define-key map [remap list-directory] 'ido-list-directory)
1568 (define-key map [remap dired] 'ido-dired)
1569 (define-key map [remap find-file-other-window]
1570 'ido-find-file-other-window)
1571 (define-key map [remap find-file-read-only-other-window]
1572 'ido-find-file-read-only-other-window)
1573 (define-key map [remap find-file-other-frame]
1574 'ido-find-file-other-frame)
1575 (define-key map [remap find-file-read-only-other-frame]
1576 'ido-find-file-read-only-other-frame))
1578 (when (memq ido-mode '(buffer both))
1579 (define-key map [remap switch-to-buffer] 'ido-switch-buffer)
1580 (define-key map [remap switch-to-buffer-other-window]
1581 'ido-switch-buffer-other-window)
1582 (define-key map [remap switch-to-buffer-other-frame]
1583 'ido-switch-buffer-other-frame)
1584 (define-key map [remap insert-buffer] 'ido-insert-buffer)
1585 (define-key map [remap kill-buffer] 'ido-kill-buffer)
1586 (define-key map [remap display-buffer] 'ido-display-buffer))
1588 (if ido-minor-mode-map-entry
1589 (setcdr ido-minor-mode-map-entry map)
1590 (setq ido-minor-mode-map-entry (cons 'ido-mode map))
1591 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry))))
1593 (when (called-interactively-p 'any)
1594 (message "Ido mode %s" (if ido-mode "enabled" "disabled"))))
1597 ;;; IDO KEYMAP
1598 (defun ido-init-completion-maps ()
1599 "Set up the completion keymaps used by `ido'."
1601 ;; Common map
1602 (let ((map (make-sparse-keymap)))
1603 (define-key map "\C-a" 'ido-toggle-ignore)
1604 (define-key map "\C-c" 'ido-toggle-case)
1605 (define-key map "\C-e" 'ido-edit-input)
1606 (define-key map "\t" 'ido-complete)
1607 (define-key map " " 'ido-complete-space)
1608 (define-key map "\C-j" 'ido-select-text)
1609 (define-key map "\C-m" 'ido-exit-minibuffer)
1610 (define-key map "\C-p" 'ido-toggle-prefix)
1611 (define-key map "\C-r" 'ido-prev-match)
1612 (define-key map "\C-s" 'ido-next-match)
1613 (define-key map [?\C-.] 'ido-next-match)
1614 (define-key map [?\C-,] 'ido-prev-match)
1615 (define-key map "\C-t" 'ido-toggle-regexp)
1616 (define-key map "\C-z" 'ido-undo-merge-work-directory)
1617 (define-key map [(control ?\s)] 'ido-restrict-to-matches)
1618 (define-key map [(meta ?\s)] 'ido-take-first-match)
1619 (define-key map [(control ?@)] 'ido-restrict-to-matches)
1620 (define-key map [right] 'ido-next-match)
1621 (define-key map [left] 'ido-prev-match)
1622 (define-key map "?" 'ido-completion-help)
1623 ;; Magic commands.
1624 (define-key map "\C-b" 'ido-magic-backward-char)
1625 (define-key map "\C-f" 'ido-magic-forward-char)
1626 (define-key map "\C-d" 'ido-magic-delete-char)
1627 (set-keymap-parent map minibuffer-local-map)
1628 (setq ido-common-completion-map map))
1630 ;; File and directory map
1631 (let ((map (make-sparse-keymap)))
1632 (define-key map "\C-x\C-b" 'ido-enter-switch-buffer)
1633 (define-key map "\C-x\C-f" 'ido-fallback-command)
1634 (define-key map "\C-x\C-d" 'ido-enter-dired)
1635 (define-key map [down] 'ido-next-match-dir)
1636 (define-key map [up] 'ido-prev-match-dir)
1637 (define-key map [(meta up)] 'ido-prev-work-directory)
1638 (define-key map [(meta down)] 'ido-next-work-directory)
1639 (define-key map [backspace] 'ido-delete-backward-updir)
1640 (define-key map "\d" 'ido-delete-backward-updir)
1641 (define-key map [remap delete-backward-char] 'ido-delete-backward-updir) ; BS
1642 (define-key map [remap backward-kill-word] 'ido-delete-backward-word-updir) ; M-DEL
1644 (define-key map [(control backspace)] 'ido-up-directory)
1645 (define-key map "\C-l" 'ido-reread-directory)
1646 (define-key map [(meta ?d)] 'ido-wide-find-dir-or-delete-dir)
1647 (define-key map [(meta ?b)] 'ido-push-dir)
1648 (define-key map [(meta ?v)] 'ido-push-dir-first)
1649 (define-key map [(meta ?f)] 'ido-wide-find-file-or-pop-dir)
1650 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1651 (define-key map [(meta ?m)] 'ido-make-directory)
1652 (define-key map [(meta ?n)] 'ido-next-work-directory)
1653 (define-key map [(meta ?o)] 'ido-prev-work-file)
1654 (define-key map [(meta control ?o)] 'ido-next-work-file)
1655 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1656 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1657 (set-keymap-parent map ido-common-completion-map)
1658 (setq ido-file-dir-completion-map map))
1660 ;; File only map
1661 (let ((map (make-sparse-keymap)))
1662 (define-key map "\C-k" 'ido-delete-file-at-head)
1663 (define-key map "\C-o" 'ido-copy-current-word)
1664 (define-key map "\C-w" 'ido-copy-current-file-name)
1665 (define-key map [(meta ?l)] 'ido-toggle-literal)
1666 (set-keymap-parent map ido-file-dir-completion-map)
1667 (setq ido-file-completion-map map))
1669 ;; Buffer map
1670 (let ((map (make-sparse-keymap)))
1671 (define-key map "\C-x\C-f" 'ido-enter-find-file)
1672 (define-key map "\C-x\C-b" 'ido-fallback-command)
1673 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1674 (define-key map "\C-o" 'ido-toggle-virtual-buffers)
1675 (set-keymap-parent map ido-common-completion-map)
1676 (setq ido-buffer-completion-map map)))
1679 (defun ido-setup-completion-map ()
1680 "Set up the keymap for `ido'."
1682 ;; generated every time so that it can inherit new functions.
1683 (let ((map (make-sparse-keymap))
1684 (viper-p (if (boundp 'viper-mode) viper-mode)))
1686 (when viper-p
1687 (define-key map [remap viper-intercept-ESC-key] 'ignore))
1689 (cond
1690 ((memq ido-cur-item '(file dir))
1691 (when ido-context-switch-command
1692 (define-key map "\C-x\C-b" ido-context-switch-command)
1693 (define-key map "\C-x\C-d" 'ignore))
1694 (when viper-p
1695 (define-key map [remap viper-backward-char] 'ido-delete-backward-updir)
1696 (define-key map [remap viper-del-backward-char-in-insert] 'ido-delete-backward-updir)
1697 (define-key map [remap viper-delete-backward-word] 'ido-delete-backward-word-updir))
1698 (set-keymap-parent map
1699 (if (eq ido-cur-item 'file)
1700 ido-file-completion-map
1701 ido-file-dir-completion-map)))
1703 ((eq ido-cur-item 'buffer)
1704 (when ido-context-switch-command
1705 (define-key map "\C-x\C-f" ido-context-switch-command))
1706 (set-keymap-parent map ido-buffer-completion-map))
1709 (set-keymap-parent map ido-common-completion-map)))
1711 (setq ido-completion-map map)))
1713 (defun ido-final-slash (dir &optional fix-it)
1714 ;; return DIR if DIR has final slash.
1715 ;; else if FIX-IT is non-nil, return DIR/
1716 ;; else return nil.
1717 (setq dir (ido-name dir))
1718 (cond
1719 ((string-match "/\\'" dir) dir)
1720 ((ido-is-tramp-root dir) dir)
1721 (fix-it (concat dir "/"))
1722 (t nil)))
1724 (defun ido-no-final-slash (s)
1725 ;; Remove optional final slash from string S
1726 (let ((l (1- (length s))))
1727 (if (and (> l 0) (eq (aref s l) ?/))
1728 (substring s 0 l)
1729 s)))
1731 (defun ido-nonreadable-directory-p (dir)
1732 ;; Return t if dir is a directory, but not readable
1733 ;; Do not check for non-readable directories via tramp, as this causes a premature
1734 ;; connect on incomplete tramp paths (after entering just method:).
1735 (let ((ido-enable-tramp-completion nil))
1736 (and (ido-final-slash dir)
1737 (not (ido-is-unc-host dir))
1738 (file-directory-p dir)
1739 (not (file-readable-p dir)))))
1741 (defun ido-directory-too-big-p (dir)
1742 ;; Return t if dir is a directory, but too big to show
1743 ;; Do not check for non-readable directories via tramp, as this causes a premature
1744 ;; connect on incomplete tramp paths (after entering just method:).
1745 (let ((ido-enable-tramp-completion nil))
1746 (and (numberp ido-max-directory-size)
1747 (ido-final-slash dir)
1748 (not (ido-is-unc-host dir))
1749 (file-directory-p dir)
1750 (> (nth 7 (file-attributes (file-truename dir))) ido-max-directory-size))))
1752 (defun ido-set-current-directory (dir &optional subdir no-merge)
1753 ;; Set ido's current directory to DIR or DIR/SUBDIR
1754 (unless (and ido-enable-tramp-completion
1755 (string-match "\\`/[^/]*@\\'" dir))
1756 (setq dir (ido-final-slash dir t)))
1757 (setq ido-use-merged-list nil
1758 ido-try-merged-list (not no-merge))
1759 (when subdir
1760 (setq dir (concat dir subdir))
1761 (unless (and ido-enable-tramp-completion
1762 (string-match "\\`/[^/]*@\\'" dir))
1763 (setq dir (ido-final-slash dir t))))
1764 (and ido-completion-buffer
1765 (get-buffer ido-completion-buffer)
1766 (kill-buffer ido-completion-buffer))
1767 (cond
1768 ((equal dir ido-current-directory)
1769 nil)
1770 ((ido-is-unc-root dir)
1771 (ido-trace "unc" dir)
1772 (setq ido-current-directory dir)
1773 (setq ido-directory-nonreadable nil)
1774 (setq ido-directory-too-big nil)
1777 (ido-trace "cd" dir)
1778 (setq ido-current-directory dir)
1779 (and ido-completion-buffer
1780 (get-buffer ido-completion-buffer)
1781 (kill-buffer ido-completion-buffer))
1782 (setq ido-directory-nonreadable (ido-nonreadable-directory-p dir))
1783 (setq ido-directory-too-big (and (not ido-directory-nonreadable)
1784 (ido-directory-too-big-p dir)))
1785 t)))
1787 (defun ido-set-current-home (&optional dir)
1788 ;; Set ido's current directory to user's home directory
1789 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1791 (defun ido-record-command (command arg)
1792 "Add (COMMAND ARG) to `command-history' if `ido-record-commands' is non-nil."
1793 (if ido-record-commands ; FIXME: use `when' instead of `if'?
1794 (let ((cmd (list command arg)))
1795 (if (or (not command-history) ; FIXME: ditto
1796 (not (equal cmd (car command-history))))
1797 (setq command-history (cons cmd command-history))))))
1799 (defun ido-make-prompt (item prompt)
1800 ;; Make the prompt for ido-read-internal
1801 (cond
1802 ((and (memq item '(file dir)) ido-current-directory)
1803 (let ((dirname (abbreviate-file-name ido-current-directory))
1804 (max-width (if (and ido-max-file-prompt-width (floatp ido-max-file-prompt-width))
1805 (floor (* (frame-width) ido-max-file-prompt-width))
1806 ido-max-file-prompt-width))
1807 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1808 (vc-off (and ido-saved-vc-hb (not vc-handled-backends) "[-VC] "))
1809 (prefix nil)
1810 (rule ido-rewrite-file-prompt-rules))
1811 (let ((case-fold-search nil))
1812 (while rule
1813 (if (and (consp (car rule))
1814 (string-match (car (car rule)) dirname))
1815 (setq dirname
1816 (if (stringp (cdr (car rule)))
1817 (replace-match (cdr (car rule)) t nil dirname)
1818 (funcall (cdr (car rule)) dirname))))
1819 (setq rule (cdr rule))))
1820 (run-hooks 'ido-rewrite-file-prompt-functions)
1821 (concat prompt
1822 ; (if ido-process-ignore-lists "" "&")
1823 (or literal "")
1824 (or vc-off "")
1825 (or prefix "")
1826 (let ((l (length dirname)))
1827 (if (and max-width (> max-width 0) (> l max-width))
1828 (let* ((s (substring dirname (- max-width)))
1829 (i (string-match "/" s)))
1830 (concat "..." (if i (substring s i) s)))
1831 dirname)))))
1832 (t prompt)))
1834 ;; Here is very briefly how ido-find-file works:
1836 ;; (ido-find-file)
1837 ;; (ido-file-internal method)
1838 ;; set ido-current-directory
1839 ;; (ido-read-internal 'file ...)
1840 ;; (while ...
1841 ;; (ido-make-item-list ...)
1842 ;; (ido-set-matches)
1843 ;; (completing-read ... ido-text-init ...)
1845 ;; ... here user is allowed to type characters and commands
1846 ;; a command may set ido-exit and call (exit-minibuffer)
1847 ;; to make ido-read-internal do advanced tasks (or return)
1849 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1850 ;; which are run before and after each user command.
1852 ;; return value from completing-read is stored in ido-final-text
1853 ;; - ido-exit may cause further actions to be taken:
1854 ;; 'refresh - repeat loop (make-item-list, set-matches)
1855 ;; 'edit - edit the prompt string, then repeat loop
1856 ;; 'keep - repeat loop but don't (re)make-item-list
1857 ;; 'updir - go up one directory, repeat loop
1858 ;; else set ido-selected based on ido-final-text,
1859 ;; optionally update ido-current-directory and repeat loop, or
1860 ;; exit with the return value of ido-selected (file name)
1861 ;; selected file name is returned from ido-read-internal,
1862 ;; ido-exit and method determines what action is taken
1863 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1864 ;; the relevant function is called (find-file, write-file, etc).
1866 (defun ido-read-internal (item prompt hist &optional default require-match initial)
1867 "Perform the `ido-read-buffer' and `ido-read-file-name' functions.
1868 Return the name of a buffer or file selected.
1869 PROMPT is the prompt to give to the user.
1870 DEFAULT if given is the default item to start with.
1871 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1872 If INITIAL is non-nil, it specifies the initial input string."
1873 (let
1874 ((ido-cur-item item)
1875 (ido-entry-buffer (current-buffer))
1876 (ido-process-ignore-lists t)
1877 (ido-process-ignore-lists-inhibit nil)
1878 (ido-set-default-item t)
1879 ido-default-item
1880 ido-selected
1881 ido-final-text
1882 (done nil)
1883 (icomplete-mode nil) ;; prevent icomplete starting up
1884 ;; Exported dynamic variables:
1885 ido-cur-list
1886 ido-ignored-list
1887 (ido-rotate-temp nil)
1888 (ido-keep-item-list nil)
1889 (ido-use-merged-list nil)
1890 (ido-try-merged-list t)
1891 (ido-pre-merge-state nil)
1892 (ido-case-fold ido-case-fold)
1893 (ido-enable-prefix ido-enable-prefix)
1894 (ido-enable-regexp ido-enable-regexp)
1895 (ido-show-confirm-message nil)
1898 (ido-setup-completion-map)
1899 (setq ido-text-init initial)
1900 (setq ido-input-stack nil)
1902 (run-hooks 'ido-setup-hook)
1904 (while (not done)
1905 (ido-trace "\n_LOOP_" ido-text-init)
1906 (setq ido-exit nil)
1907 (setq ido-rescan t)
1908 (setq ido-rotate nil)
1909 (setq ido-text "")
1910 (when ido-set-default-item
1911 (setq ido-default-item
1912 (cond
1913 ((eq item 'buffer)
1914 (if (bufferp default) (buffer-name default) default))
1915 ((stringp default)
1916 (if (memq item '(file dir))
1917 (file-name-nondirectory default)
1918 default))
1919 ((eq item 'file)
1920 (and ido-enable-last-directory-history
1921 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1922 (and d (cdr d)))))))
1923 (if (member ido-default-item ido-ignore-item-temp-list)
1924 (setq ido-default-item nil))
1925 (ido-trace "new default" ido-default-item)
1926 (if ido-default-item
1927 (setq ido-initial-position 0))
1928 (setq ido-set-default-item nil))
1930 (if ido-process-ignore-lists-inhibit
1931 (setq ido-process-ignore-lists nil))
1933 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1934 (let ((olist ido-cur-list)
1935 (oign ido-ignored-list)
1936 (omat ido-matches)
1937 (l (ido-make-merged-file-list ido-text-init
1938 (eq ido-use-merged-list 'auto)
1939 (eq ido-try-merged-list 'wide))))
1940 (ido-trace "merged" l)
1941 (cond
1942 ((not l)
1943 (if (eq ido-try-merged-list 'wide)
1944 (setq ido-pre-merge-state
1945 (list "" ido-current-directory olist oign omat)
1946 ido-cur-list nil
1947 ido-ignored-list nil
1948 ido-matches nil
1949 ido-keep-item-list t
1950 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1951 ido-use-merged-list nil)
1952 (setq ido-cur-list olist
1953 ido-ignored-list oign
1954 ido-matches omat
1955 ido-keep-item-list t
1956 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1957 ido-use-merged-list nil)))
1958 ((eq l t)
1959 (setq ido-use-merged-list nil))
1960 ((eq l 'input-pending-p)
1961 (setq ido-try-merged-list t
1962 ido-use-merged-list nil))
1964 (setq ido-pre-merge-state
1965 (list ido-text-init ido-current-directory olist oign omat))
1966 (ido-set-current-directory (car (cdr (car l))))
1967 (if (ido-final-slash ido-text-init)
1968 (setq ido-text-init ""))
1969 (setq ido-cur-list l
1970 ido-ignored-list nil
1971 ido-matches l
1972 ido-rescan nil
1973 ido-keep-item-list t
1974 ido-use-merged-list t)
1975 (ido-trace "Merged" t)
1976 ))))
1978 (cond
1979 (ido-keep-item-list
1980 (setq ido-keep-item-list nil
1981 ido-rescan nil))
1982 ((eq ido-cur-item 'file)
1983 (setq ido-ignored-list nil
1984 ido-cur-list (and (not ido-directory-nonreadable)
1985 (not ido-directory-too-big)
1986 (ido-make-file-list ido-default-item))))
1987 ((eq ido-cur-item 'dir)
1988 (setq ido-ignored-list nil
1989 ido-cur-list (and (not ido-directory-nonreadable)
1990 (not ido-directory-too-big)
1991 (ido-make-dir-list ido-default-item))))
1992 ((eq ido-cur-item 'buffer)
1993 (setq ido-ignored-list nil
1994 ido-cur-list (ido-make-buffer-list ido-default-item)))
1995 ((eq ido-cur-item 'list)
1996 (setq ido-ignored-list nil
1997 ido-cur-list (ido-make-choice-list ido-default-item)))
1998 (t nil))
1999 (setq ido-rotate-temp nil)
2001 (if ido-process-ignore-lists-inhibit
2002 (setq ido-process-ignore-lists t
2003 ido-process-ignore-lists-inhibit nil))
2005 (ido-set-matches)
2006 (if (and ido-matches (eq ido-try-merged-list 'auto))
2007 (setq ido-try-merged-list t))
2008 (let ((max-mini-window-height (or ido-max-window-height
2009 (and (boundp 'max-mini-window-height)
2010 max-mini-window-height)))
2011 (ido-completing-read t)
2012 (ido-require-match require-match)
2013 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
2014 (show-paren-mode nil)
2015 ;; Postpone history adding till later
2016 (history-add-new-input nil))
2017 ;; prompt the user for the file name
2018 (setq ido-exit nil)
2019 (setq ido-final-text
2020 (catch 'ido
2021 (read-from-minibuffer (ido-make-prompt item prompt)
2022 (prog1 ido-text-init
2023 (setq ido-text-init nil))
2024 ido-completion-map nil hist))))
2025 (ido-trace "read-from-minibuffer" ido-final-text)
2026 (and ido-completion-buffer
2027 (get-buffer ido-completion-buffer)
2028 (kill-buffer ido-completion-buffer))
2030 (ido-trace "\n_EXIT_" ido-exit)
2032 (cond
2033 ((eq ido-exit 'refresh)
2034 (if (and (eq ido-use-merged-list 'auto)
2035 (or (input-pending-p)))
2036 (setq ido-use-merged-list nil
2037 ido-keep-item-list t))
2038 nil)
2040 ((eq ido-exit 'done)
2041 (setq done t
2042 ido-selected ido-text
2043 ido-exit nil))
2045 ((memq ido-exit '(edit chdir))
2046 (cond
2047 ((memq ido-cur-item '(file dir))
2048 (let* ((read-file-name-function nil)
2049 (edit (eq ido-exit 'edit))
2050 (d ido-current-directory)
2051 (f ido-text-init)
2052 (new t))
2053 (setq ido-text-init "")
2054 (while new
2055 (setq new (if edit
2056 (condition-case nil
2057 (read-file-name (concat prompt "[EDIT] ")
2058 (expand-file-name d)
2059 (concat d f) nil f)
2060 (quit (concat d f)))
2062 d (or (file-name-directory new) "/")
2063 f (file-name-nondirectory new)
2064 edit t)
2065 (if (or
2066 (file-directory-p d)
2067 (and (yes-or-no-p (format "Create directory %s? " d))
2068 (condition-case nil
2069 (progn (make-directory d t) t)
2070 (error
2071 (message "Could not create directory")
2072 (sit-for 1)
2073 nil))))
2074 (progn
2075 (ido-set-current-directory d nil (eq ido-exit 'chdir))
2076 (setq ido-text-init f
2077 new nil))))))
2079 (setq ido-text-init
2080 (condition-case nil
2081 (read-string (concat prompt "[EDIT] ") ido-final-text)
2082 (quit ido-final-text)))))
2084 nil)
2086 ((eq ido-exit 'keep)
2087 (setq ido-keep-item-list t))
2089 ((memq ido-exit '(dired fallback find-file switch-to-buffer insert-buffer insert-file))
2090 (setq done t))
2092 ((memq ido-exit '(updir push))
2093 ;; cannot go up if already at the root-dir (Unix) or at the
2094 ;; root-dir of a certain drive (Windows or MS-DOS).
2095 (if (ido-is-tramp-root)
2096 (when (string-match "\\`\\(/\\([^/]+[:@]\\)*\\)\\([^/]+\\)[:@]\\'" ido-current-directory)
2097 (setq ido-text-init (match-string 3 ido-current-directory))
2098 (ido-set-current-directory (match-string 1 ido-current-directory))
2099 (setq ido-set-default-item t))
2100 (unless (ido-is-root-directory)
2101 (when (eq ido-exit 'push)
2102 (setq ido-input-stack (cons (cons ido-cur-item ido-text) ido-input-stack))
2103 (setq ido-cur-item 'dir)
2104 (setq ido-text-init (file-name-nondirectory (substring ido-current-directory 0 -1)))
2105 (ido-trace "push" ido-input-stack))
2106 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1)))
2107 (setq ido-set-default-item t))))
2109 ((eq ido-exit 'pop)
2110 (ido-trace "pop" ido-input-stack)
2111 (let ((elt (car ido-input-stack)))
2112 (setq ido-input-stack (cdr ido-input-stack))
2113 (ido-set-current-directory (concat ido-current-directory ido-text))
2114 (setq ido-cur-item (car elt))
2115 (setq ido-text-init (cdr elt))))
2117 ((eq ido-exit 'pop-all)
2118 (ido-trace "pop-all" ido-input-stack)
2119 (while ido-input-stack
2120 (let ((elt (car ido-input-stack)))
2121 (setq ido-input-stack (cdr ido-input-stack))
2122 (ido-set-current-directory (concat ido-current-directory ido-text))
2123 (setq ido-cur-item (car elt))
2124 (setq ido-text-init (cdr elt)))))
2126 ;; Handling the require-match must be done in a better way.
2127 ((and require-match
2128 (not (memq require-match '(confirm confirm-after-completion)))
2129 (not (if ido-directory-too-big
2130 (file-exists-p (concat ido-current-directory ido-final-text))
2131 (ido-existing-item-p))))
2132 (error "Must specify valid item"))
2135 (setq ido-selected
2136 (if (or (eq ido-exit 'takeprompt)
2137 (null ido-matches))
2138 ido-final-text
2139 ;; else take head of list
2140 (ido-name (car ido-matches))))
2142 (cond
2143 ((memq item '(buffer list))
2144 (setq done t))
2146 ((string-equal "./" ido-selected)
2147 nil)
2149 ((string-equal "../" ido-selected)
2150 ;; cannot go up if already at the root-dir (Unix) or at the
2151 ;; root-dir of a certain drive (Windows or MS-DOS).
2152 (or (ido-is-root-directory)
2153 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
2154 (setq ido-set-default-item t))
2156 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") ido-selected)
2157 (ido-is-root-directory) ;; Ange-ftp or Tramp
2158 (not (ido-local-file-exists-p ido-selected)))
2159 (ido-set-current-directory ido-current-directory ido-selected)
2160 (ido-trace "tramp prefix" ido-selected)
2161 (if (ido-is-slow-ftp-host)
2162 (setq ido-exit 'fallback
2163 done t)
2164 (setq ido-set-default-item t)))
2166 ((string-match (if (memq system-type '(windows-nt ms-dos))
2167 "\\`[a-zA-Z]:\\|[/\\][^/\\]"
2168 "/[^/]")
2169 ido-selected)
2170 (ido-set-current-directory (file-name-directory ido-selected))
2171 (setq ido-set-default-item t))
2173 ((string-match "\\`~" ido-selected)
2174 (ido-set-current-home ido-selected))
2176 ((ido-final-slash ido-selected)
2177 (if ido-enable-last-directory-history
2178 (let ((x (assoc ido-current-directory ido-last-directory-list)))
2179 (if x
2180 (setcdr x ido-selected)
2181 (setq ido-last-directory-list
2182 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
2183 (ido-set-current-directory ido-current-directory ido-selected)
2184 (if ido-input-stack
2185 ; automatically pop stack elements which match existing files or directories
2186 (let (elt)
2187 (while (and (setq elt (car ido-input-stack))
2188 (file-exists-p (concat ido-current-directory (cdr elt))))
2189 (if (setq ido-input-stack (cdr ido-input-stack))
2190 (ido-set-current-directory ido-current-directory (cdr elt))
2191 (setq ido-text-init (cdr elt)))
2192 (setq ido-cur-item (car elt))))
2193 (setq ido-set-default-item t)))
2196 (setq done t))))))
2197 (add-to-history (cond
2198 ((consp hist)
2199 (or (car hist) 'minibuffer-history))
2200 (hist hist)
2201 (t 'minibuffer-history))
2202 ido-selected)
2203 ido-selected))
2205 (defun ido-edit-input ()
2206 "Edit absolute file name entered so far with ido; terminate by RET.
2207 If cursor is not at the end of the user input, move to end of input."
2208 (interactive)
2209 (if (not (eobp))
2210 (end-of-line)
2211 (setq ido-text-init (if ido-matches (ido-name (car ido-matches)) ido-text))
2212 (setq ido-exit 'edit)
2213 (exit-minibuffer)))
2215 ;;; MAIN FUNCTIONS
2216 (defun ido-buffer-internal (method &optional fallback prompt default initial switch-cmd)
2217 ;; Internal function for ido-switch-buffer and friends
2218 (if (not ido-mode)
2219 (progn
2220 (run-hook-with-args 'ido-before-fallback-functions
2221 (or fallback 'switch-to-buffer))
2222 (call-interactively (or fallback 'switch-to-buffer)))
2223 (let* ((ido-context-switch-command switch-cmd)
2224 (ido-current-directory nil)
2225 (ido-directory-nonreadable nil)
2226 (ido-directory-too-big nil)
2227 (ido-enable-virtual-buffers (and ido-use-virtual-buffers
2228 (not (eq ido-use-virtual-buffers 'auto))))
2229 (require-match (confirm-nonexistent-file-or-buffer))
2230 (buf (ido-read-internal 'buffer (or prompt "Buffer: ") 'ido-buffer-history default
2231 require-match initial))
2232 filename)
2234 ;; Choose the buffer name: either the text typed in, or the head
2235 ;; of the list of matches
2237 (cond
2238 ((eq ido-exit 'find-file)
2239 (ido-file-internal
2240 (if (memq method '(other-window other-frame)) method ido-default-file-method)
2241 nil nil nil nil ido-text))
2243 ((eq ido-exit 'insert-file)
2244 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil ido-text 'ido-enter-insert-buffer))
2246 ((eq ido-exit 'fallback)
2247 (let ((read-buffer-function nil))
2248 (setq this-command (or fallback 'switch-to-buffer))
2249 (run-hook-with-args 'ido-before-fallback-functions this-command)
2250 (call-interactively this-command)))
2252 ;; Check buf is non-nil.
2253 ((not buf) nil)
2254 ((= (length buf) 0) nil)
2256 ;; View buffer if it exists
2257 ((get-buffer buf)
2258 (add-to-history 'buffer-name-history buf)
2259 (if (eq method 'insert)
2260 (progn
2261 (ido-record-command 'insert-buffer buf)
2262 (push-mark
2263 (save-excursion
2264 (insert-buffer-substring (get-buffer buf))
2265 (point))))
2266 (ido-visit-buffer buf method t)))
2268 ;; check for a virtual buffer reference
2269 ((and ido-enable-virtual-buffers
2270 ido-virtual-buffers
2271 (setq filename (assoc buf ido-virtual-buffers)))
2272 (ido-visit-buffer (find-file-noselect (cdr filename)) method t))
2274 ((and (eq ido-create-new-buffer 'prompt)
2275 (null require-match)
2276 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
2277 nil)
2279 ;; buffer doesn't exist
2280 ((and (eq ido-create-new-buffer 'never)
2281 (null require-match))
2282 (message "No buffer matching `%s'" buf))
2284 ((and (eq ido-create-new-buffer 'prompt)
2285 (null require-match)
2286 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
2287 nil)
2289 ;; create a new buffer
2291 (add-to-history 'buffer-name-history buf)
2292 (setq buf (get-buffer-create buf))
2293 (if (fboundp 'set-buffer-major-mode)
2294 (set-buffer-major-mode buf))
2295 (ido-visit-buffer buf method t))))))
2297 (defun ido-record-work-directory (&optional dir)
2298 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
2299 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
2300 (let ((items ido-work-directory-list-ignore-regexps)
2301 (case-fold-search nil))
2302 (while (and items dir)
2303 (if (string-match (car items) dir)
2304 (setq dir nil))
2305 (setq items (cdr items)))
2306 (if dir
2307 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
2308 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
2309 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
2311 (defun ido-forget-work-directory ()
2312 (interactive)
2313 (when (and ido-current-directory ido-work-directory-list)
2314 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
2315 (when ido-use-merged-list
2316 (ido-undo-merge-work-directory)
2317 (setq ido-exit 'refresh
2318 ido-try-merged-list t
2319 ido-use-merged-list t
2320 ido-text-init ido-text
2321 ido-rotate-temp t)
2322 (exit-minibuffer))))
2324 (defun ido-record-work-file (name)
2325 ;; Save NAME in ido-work-file-list
2326 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
2328 (and ido-work-file-list (equal (car ido-work-file-list) name))
2329 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
2330 (if (> (length ido-work-file-list) ido-max-work-file-list)
2331 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
2333 (defun ido-expand-directory (dir)
2334 ;; Expand DIR or use DEFAULT-DIRECTORY if nil.
2335 ;; Add final slash to result in case it was missing from DEFAULT-DIRECTORY.
2336 (ido-final-slash (expand-file-name (or dir default-directory)) t))
2338 (defun ido-file-internal (method &optional fallback default prompt item initial switch-cmd)
2339 ;; Internal function for ido-find-file and friends
2340 (unless item
2341 (setq item 'file))
2342 (let ((ido-current-directory (ido-expand-directory default))
2343 (ido-context-switch-command switch-cmd)
2344 ido-directory-nonreadable ido-directory-too-big
2345 filename)
2347 (if (or (not ido-mode) (ido-is-slow-ftp-host))
2348 (setq filename t
2349 ido-exit 'fallback)
2350 (setq ido-directory-nonreadable
2351 (ido-nonreadable-directory-p ido-current-directory)
2352 ido-directory-too-big
2353 (and (not ido-directory-nonreadable)
2354 (ido-directory-too-big-p ido-current-directory))))
2356 (when (and (eq item 'file)
2357 (or ido-use-url-at-point ido-use-filename-at-point))
2358 (let (fn d)
2359 (require 'ffap)
2360 ;; Duplicate code from ffap-guesser as we want different
2361 ;; behavior for files and URLs.
2362 (cond
2363 ((with-no-warnings
2364 (and ido-use-url-at-point
2365 ffap-url-regexp
2366 (ffap-fixup-url (or (ffap-url-at-point)
2367 (ffap-gopher-at-point)))))
2368 (setq ido-exit 'ffap
2369 filename t))
2371 ((and ido-use-filename-at-point
2372 (setq fn (with-no-warnings
2373 (if (eq ido-use-filename-at-point 'guess)
2374 (ffap-guesser)
2375 (ffap-string-at-point))))
2376 (not (string-match "^http:/" fn))
2377 (let ((absolute-fn (expand-file-name fn)))
2378 (setq d (if (file-directory-p absolute-fn)
2379 (file-name-as-directory absolute-fn)
2380 (file-name-directory absolute-fn))))
2381 (file-directory-p d))
2382 (setq ido-current-directory d)
2383 (setq initial (file-name-nondirectory fn))))))
2385 (let (ido-saved-vc-hb
2386 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
2387 (ido-work-directory-index -1)
2388 (ido-work-file-index -1)
2389 (ido-find-literal nil))
2391 (unless filename
2392 (setq ido-saved-vc-hb vc-handled-backends)
2393 (let ((minibuffer-completing-file-name t))
2394 (setq filename (ido-read-internal item
2395 (or prompt "Find file: ")
2396 'ido-file-history
2397 (and (eq method 'alt-file) buffer-file-name)
2398 (confirm-nonexistent-file-or-buffer) initial))))
2400 ;; Choose the file name: either the text typed in, or the head
2401 ;; of the list of matches
2403 (cond
2404 ((eq ido-exit 'fallback)
2405 ;; Need to guard setting of default-directory here, since
2406 ;; we don't want to change directory of current buffer.
2407 (let ((default-directory ido-current-directory)
2408 (read-file-name-function nil))
2409 (setq this-command (or fallback 'find-file))
2410 (run-hook-with-args 'ido-before-fallback-functions this-command)
2411 (call-interactively this-command)))
2413 ((eq ido-exit 'switch-to-buffer)
2414 (ido-buffer-internal
2415 (if (memq method '(other-window other-frame)) method ido-default-buffer-method)
2416 nil nil nil ido-text))
2418 ((eq ido-exit 'insert-buffer)
2419 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil ido-text 'ido-enter-insert-file))
2421 ((eq ido-exit 'dired)
2422 (funcall (cond ((eq method 'other-window) 'dired-other-window)
2423 ((eq method 'other-frame) 'dired-other-frame)
2424 (t 'dired))
2425 (concat ido-current-directory (or ido-text ""))))
2427 ((eq ido-exit 'ffap)
2428 (find-file-at-point))
2430 ((eq method 'alt-file)
2431 (ido-record-work-file filename)
2432 (setq default-directory ido-current-directory)
2433 (ido-record-work-directory)
2434 (find-alternate-file filename))
2436 ((memq method '(dired list-directory))
2437 (if (equal filename ".")
2438 (setq filename ""))
2439 (let* ((dirname (ido-final-slash (concat ido-current-directory filename) t))
2440 (file (substring dirname 0 -1)))
2441 (cond
2442 ((file-directory-p dirname)
2443 (ido-record-command method dirname)
2444 (ido-record-work-directory dirname)
2445 (funcall method dirname))
2446 ((file-directory-p ido-current-directory)
2447 (cond
2448 ((file-exists-p file)
2449 (ido-record-command method ido-current-directory)
2450 (ido-record-work-directory)
2451 (funcall method ido-current-directory)
2452 (if (eq method 'dired)
2453 (with-no-warnings
2454 (dired-goto-file (expand-file-name file)))))
2455 ((string-match "[[*?]" filename)
2456 (setq dirname (concat ido-current-directory filename))
2457 (ido-record-command method dirname)
2458 (ido-record-work-directory)
2459 (funcall method dirname))
2460 ((y-or-n-p (format "Directory %s does not exist. Create it? " filename))
2461 (ido-record-command method dirname)
2462 (ido-record-work-directory dirname)
2463 (make-directory-internal dirname)
2464 (funcall method dirname))
2466 ;; put make-directory command on history
2467 (ido-record-command 'make-directory dirname))))
2468 (t (error "No such directory")))))
2470 ((eq method 'write)
2471 (ido-record-work-file filename)
2472 (setq default-directory ido-current-directory)
2473 (setq filename (concat ido-current-directory filename))
2474 (ido-record-command 'write-file filename)
2475 (add-to-history 'file-name-history filename)
2476 (ido-record-work-directory)
2477 (write-file filename t))
2479 ((eq method 'read-only)
2480 (ido-record-work-file filename)
2481 (setq filename (concat ido-current-directory filename))
2482 (ido-record-command fallback filename)
2483 (ido-record-work-directory)
2484 (run-hook-with-args 'ido-before-fallback-functions fallback)
2485 (funcall fallback filename))
2487 ((eq method 'insert)
2488 (ido-record-work-file filename)
2489 (setq filename (concat ido-current-directory filename))
2490 (ido-record-command
2491 (if ido-find-literal 'insert-file-literally 'insert-file)
2492 filename)
2493 (add-to-history 'file-name-history filename)
2494 (ido-record-work-directory)
2495 (insert-file-1 filename
2496 (if ido-find-literal
2497 #'insert-file-contents-literally
2498 #'insert-file-contents)))
2500 (filename
2501 (ido-record-work-file filename)
2502 (setq filename (concat ido-current-directory filename))
2503 (ido-record-command 'find-file filename)
2504 (add-to-history 'file-name-history filename)
2505 (ido-record-work-directory)
2506 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
2508 (defun ido-existing-item-p ()
2509 ;; Return non-nil if there is a matching item
2510 (not (null ido-matches)))
2512 ;;; COMPLETION CODE
2514 (defun ido-set-common-completion ()
2515 ;; Find common completion of `ido-text' in `ido-matches'
2516 ;; The result is stored in `ido-common-match-string'
2517 (let (val)
2518 (setq ido-common-match-string nil)
2519 (if (and ido-matches
2520 (not ido-enable-regexp) ;; testing
2521 (stringp ido-text)
2522 (> (length ido-text) 0))
2523 (if (setq val (ido-find-common-substring ido-matches ido-text))
2524 (setq ido-common-match-string val)))
2525 val))
2527 (defun ido-complete ()
2528 "Try and complete the current pattern amongst the file names."
2529 (interactive)
2530 (let (res)
2531 (cond
2532 (ido-incomplete-regexp
2533 ;; Do nothing
2535 ((and (memq ido-cur-item '(file dir))
2536 (string-match "[$]" ido-text))
2537 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
2538 (if (not (file-exists-p (file-name-directory evar)))
2539 (message "Expansion generates non-existing directory name")
2540 (if (file-directory-p evar)
2541 (ido-set-current-directory evar)
2542 (let ((d (or (file-name-directory evar) "/"))
2543 (f (file-name-nondirectory evar)))
2544 (when (file-directory-p d)
2545 (ido-set-current-directory d)
2546 (setq ido-text-init f))))
2547 (setq ido-exit 'refresh)
2548 (exit-minibuffer))))
2550 (ido-directory-too-big
2551 (setq ido-directory-too-big nil)
2552 (setq ido-text-init ido-text)
2553 (setq ido-exit 'refresh)
2554 (exit-minibuffer))
2556 ((not ido-matches)
2557 (when ido-completion-buffer
2558 (call-interactively (setq this-command ido-cannot-complete-command))))
2560 ((and (= 1 (length ido-matches))
2561 (not (and ido-enable-tramp-completion
2562 (string-equal ido-current-directory "/")
2563 (string-match ".[@:]\\'" (ido-name (car ido-matches)))))
2564 (not (ido-local-file-exists-p (ido-name (car ido-matches)))))
2565 ;; only one choice, so select it.
2566 (if (not ido-confirm-unique-completion)
2567 (exit-minibuffer)
2568 (setq ido-rescan (not ido-enable-prefix))
2569 (delete-region (minibuffer-prompt-end) (point))
2570 (insert (ido-name (car ido-matches)))))
2572 (t ;; else there could be some completions
2573 (setq res ido-common-match-string)
2574 (if (and (not (memq res '(t nil)))
2575 (not (equal res ido-text)))
2576 ;; found something to complete, so put it in the minibuffer.
2577 (progn
2578 ;; move exact match to front if not in prefix mode
2579 (setq ido-rescan (not ido-enable-prefix))
2580 (delete-region (minibuffer-prompt-end) (point))
2581 (insert res))
2582 ;; else nothing to complete
2583 (call-interactively (setq this-command ido-cannot-complete-command))
2584 )))))
2586 (defun ido-complete-space ()
2587 "Try completion unless inserting the space makes sense."
2588 (interactive)
2589 (if (and (stringp ido-common-match-string)
2590 (stringp ido-text)
2591 (cond
2592 ((> (length ido-common-match-string) (length ido-text))
2593 (= (aref ido-common-match-string (length ido-text)) ? ))
2594 (ido-matches
2595 (let (insert-space
2596 (re (concat (regexp-quote ido-text) " "))
2597 (comp ido-matches))
2598 (while comp
2599 (if (string-match re (ido-name (car comp)))
2600 (setq comp nil insert-space t)
2601 (setq comp (cdr comp))))
2602 insert-space))
2603 (t nil)))
2604 (insert " ")
2605 (ido-complete)))
2607 (defun ido-undo-merge-work-directory (&optional text try refresh)
2608 "Undo or redo last ido directory merge operation.
2609 If no merge has yet taken place, toggle automatic merging option."
2610 (interactive)
2611 (cond
2612 (ido-pre-merge-state
2613 (ido-set-current-directory (nth 1 ido-pre-merge-state))
2614 (setq ido-text-init (or text (car ido-pre-merge-state))
2615 ido-cur-list (nth 2 ido-pre-merge-state)
2616 ido-ignored-list (nth 3 ido-pre-merge-state)
2617 ido-matches (nth 4 ido-pre-merge-state)
2618 ido-use-merged-list nil
2619 ido-try-merged-list try
2620 ido-keep-item-list (not refresh)
2621 ido-rescan nil
2622 ido-exit 'refresh
2623 ido-pre-merge-state nil)
2624 (exit-minibuffer))
2625 (text
2626 nil)
2627 (ido-try-merged-list
2628 (setq ido-try-merged-list nil))
2629 (ido-matches
2630 (setq ido-try-merged-list t))
2631 ((not ido-use-merged-list)
2632 (ido-merge-work-directories))))
2634 ;;; Magic C-f
2636 (defun ido-magic-forward-char (arg)
2637 "Move forward in user input or perform magic action.
2638 If no user input is present, or at end of input, perform magic actions:
2639 C-x C-b ... C-f switch to `ido-find-file'.
2640 C-x C-f ... C-f fallback to non-ido `find-file'.
2641 C-x C-d ... C-f fallback to non-ido brief `dired'.
2642 C-x d ... C-f fallback to non-ido `dired'."
2643 (interactive "P")
2644 (cond
2645 ((or arg (not (eobp)))
2646 (forward-char (min (prefix-numeric-value arg)
2647 (- (point-max) (point)))))
2648 ((memq ido-cur-item '(file dir))
2649 (ido-fallback-command))
2650 (ido-context-switch-command
2651 (call-interactively ido-context-switch-command))
2652 ((eq ido-cur-item 'buffer)
2653 (ido-enter-find-file))))
2655 ;;; Magic C-b
2657 (defun ido-magic-backward-char (arg)
2658 "Move backward in user input or perform magic action.
2659 If no user input is present, or at start of input, perform magic actions:
2660 C-x C-f C-b switch to `ido-switch-buffer'.
2661 C-x C-d C-b switch to `ido-switch-buffer'.
2662 C-x d C-b switch to `ido-switch-buffer'.
2663 C-x C-b C-b fallback to non-ido `switch-to-buffer'."
2664 (interactive "P")
2665 (cond
2666 ((or arg (> (point) (minibuffer-prompt-end)))
2667 (forward-char
2668 (- (min (prefix-numeric-value arg)
2669 (- (point) (minibuffer-prompt-end))))))
2670 ((eq last-command this-command)
2671 (when (and (memq ido-cur-item '(file dir))
2672 (not (bobp)))
2673 (ido-push-dir))) ; else do nothing
2674 ((eq ido-cur-item 'buffer)
2675 (ido-fallback-command))
2676 (ido-context-switch-command
2677 (call-interactively ido-context-switch-command))
2679 (ido-enter-switch-buffer))))
2681 ;;; Magic C-d
2683 (defun ido-magic-delete-char (arg)
2684 "Delete following char in user input or perform magic action.
2685 If at end of user input, perform magic actions:
2686 C-x C-f ... C-d enter `dired' on current directory."
2687 (interactive "P")
2688 (cond
2689 ((or arg (not (eobp)))
2690 (delete-char (min (prefix-numeric-value arg)
2691 (- (point-max) (point)))))
2692 (ido-context-switch-command
2693 nil)
2694 ((memq ido-cur-item '(file dir))
2695 (ido-enter-dired))))
2698 ;;; TOGGLE FUNCTIONS
2700 (defun ido-toggle-case ()
2701 "Toggle the value of `ido-case-fold'."
2702 (interactive)
2703 (setq ido-case-fold (not ido-case-fold))
2704 ;; ask for list to be regenerated.
2705 (setq ido-rescan t))
2707 (defun ido-toggle-regexp ()
2708 "Toggle the value of `ido-enable-regexp'."
2709 (interactive)
2710 (setq ido-enable-regexp (not ido-enable-regexp))
2711 ;; ask for list to be regenerated.
2712 (setq ido-rescan t))
2714 (defun ido-toggle-prefix ()
2715 "Toggle the value of `ido-enable-prefix'."
2716 (interactive)
2717 (setq ido-enable-prefix (not ido-enable-prefix))
2718 ;; ask for list to be regenerated.
2719 (setq ido-rescan t))
2721 (defun ido-toggle-ignore ()
2722 "Toggle ignoring files specified with `ido-ignore-files'."
2723 (interactive)
2724 (if (and (not (eobp)) (> (point) (minibuffer-prompt-end)))
2725 (goto-char (minibuffer-prompt-end))
2726 (if ido-directory-too-big
2727 (progn
2728 (message "Reading directory...")
2729 (setq ido-directory-too-big nil))
2730 (setq ido-process-ignore-lists (not ido-process-ignore-lists)))
2731 (setq ido-text-init ido-text)
2732 (setq ido-exit 'refresh)
2733 (exit-minibuffer)))
2735 (defun ido-toggle-vc ()
2736 "Disable version control for this file."
2737 (interactive)
2738 (if (and ido-mode (eq ido-cur-item 'file))
2739 (progn
2740 (setq vc-handled-backends
2741 (if vc-handled-backends nil ido-saved-vc-hb))
2742 (setq ido-text-init ido-text)
2743 (setq ido-exit 'keep)
2744 (exit-minibuffer))))
2746 (defun ido-toggle-literal ()
2747 "Toggle literal reading of this file."
2748 (interactive)
2749 (if (and ido-mode (eq ido-cur-item 'file))
2750 (progn
2751 (setq ido-find-literal (not ido-find-literal))
2752 (setq ido-text-init ido-text)
2753 (setq ido-exit 'keep)
2754 (exit-minibuffer))))
2756 (defun ido-toggle-virtual-buffers ()
2757 "Toggle the use of virtual buffers.
2758 See `ido-use-virtual-buffers' for explanation of virtual buffer."
2759 (interactive)
2760 (when (and ido-mode (eq ido-cur-item 'buffer))
2761 (setq ido-enable-virtual-buffers
2762 (if ido-enable-virtual-buffers
2764 ;; Use `always' instead of t for `ido-exhibit'.
2765 'always))
2766 (setq ido-text-init ido-text)
2767 (setq ido-exit 'refresh)
2768 (exit-minibuffer)))
2770 (defun ido-reread-directory ()
2771 "Read current directory again.
2772 May be useful if cached version is no longer valid, but directory
2773 timestamp has not changed (e.g. with ftp or on Windows)."
2774 (interactive)
2775 (if (and ido-mode (memq ido-cur-item '(file dir)))
2776 (progn
2777 (if (ido-is-unc-root)
2778 (setq ido-unc-hosts-cache t)
2779 (ido-remove-cached-dir ido-current-directory))
2780 (setq ido-text-init ido-text)
2781 (setq ido-rotate-temp t)
2782 (setq ido-exit 'refresh)
2783 (exit-minibuffer))))
2785 (defun ido-exit-minibuffer ()
2786 "Exit minibuffer, but make sure we have a match if one is needed."
2787 (interactive)
2788 (if (and (or (not ido-require-match)
2789 (if (memq ido-require-match '(confirm confirm-after-completion))
2790 (if (or (eq ido-cur-item 'dir)
2791 (eq last-command this-command))
2793 (setq ido-show-confirm-message t)
2794 nil))
2795 (ido-existing-item-p))
2796 (not ido-incomplete-regexp))
2797 (exit-minibuffer)))
2799 (defun ido-select-text ()
2800 "Select the buffer or file named by the prompt.
2801 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2802 (interactive)
2803 (setq ido-exit 'takeprompt)
2804 (exit-minibuffer))
2806 (defun ido-fallback-command ()
2807 "Fallback to non-ido version of current command."
2808 (interactive)
2809 (let ((i (length ido-text)))
2810 (while (> i 0)
2811 (push (aref ido-text (setq i (1- i))) unread-command-events)))
2812 (setq ido-exit 'fallback)
2813 (exit-minibuffer))
2815 (defun ido-enter-find-file ()
2816 "Drop into `find-file' from buffer switching."
2817 (interactive)
2818 (setq ido-exit 'find-file)
2819 (exit-minibuffer))
2821 (defun ido-enter-switch-buffer ()
2822 "Drop into `ido-switch-buffer' from file switching."
2823 (interactive)
2824 (setq ido-exit 'switch-to-buffer)
2825 (exit-minibuffer))
2827 (defun ido-enter-dired ()
2828 "Drop into `dired' from file switching."
2829 (interactive)
2830 (setq ido-exit 'dired)
2831 (exit-minibuffer))
2833 (defun ido-enter-insert-buffer ()
2834 "Drop into `insert-buffer' from insert file."
2835 (interactive)
2836 (setq ido-exit 'insert-buffer)
2837 (exit-minibuffer))
2839 (defun ido-enter-insert-file ()
2840 "Drop into `insert-file' from insert buffer."
2841 (interactive)
2842 (setq ido-exit 'insert-file)
2843 (exit-minibuffer))
2846 (defun ido-up-directory (&optional clear)
2847 "Go up one directory level."
2848 (interactive "P")
2849 (setq ido-text-init (if clear nil ido-text))
2850 (setq ido-exit 'updir)
2851 (setq ido-rotate-temp t)
2852 (exit-minibuffer))
2854 (defun ido-delete-backward-updir (count)
2855 "Delete char backwards, or at beginning of buffer, go up one level."
2856 (interactive "P")
2857 (cond
2858 ((= (minibuffer-prompt-end) (point))
2859 (if (not count)
2860 (ido-up-directory t)))
2861 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2862 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2863 ((eq this-original-command 'viper-backward-char)
2864 (funcall this-original-command (prefix-numeric-value count)))
2865 ((eq this-original-command 'viper-del-backward-char-in-insert)
2866 (funcall this-original-command))
2868 (delete-char (- (prefix-numeric-value count))))))
2870 (defun ido-delete-backward-word-updir (count)
2871 "Delete all chars backwards, or at beginning of buffer, go up one level."
2872 (interactive "P")
2873 (if (= (minibuffer-prompt-end) (point))
2874 (if (not count)
2875 (ido-up-directory t))
2876 (if (eq this-original-command 'viper-delete-backward-word)
2877 (funcall this-original-command (prefix-numeric-value count))
2878 (backward-kill-word (prefix-numeric-value count)))))
2880 (defun ido-get-work-directory (&optional incr must-match)
2881 (let ((n (length ido-work-directory-list))
2882 (i ido-work-directory-index)
2883 (j 0)
2884 dir)
2885 (if (or (not ido-text) (= (length ido-text) 0))
2886 (setq must-match nil))
2887 (while (< j n)
2888 (setq i (+ i incr)
2889 j (1+ j))
2890 (if (> incr 0)
2891 (if (>= i n) (setq i 0))
2892 (if (< i 0) (setq i (1- n))))
2893 (setq dir (nth i ido-work-directory-list))
2894 (if (and dir
2895 (not (equal dir ido-current-directory))
2896 (file-directory-p dir)
2897 (or (not must-match)
2898 ;; TODO. check for nonreadable and too-big.
2899 (ido-set-matches-1
2900 (if (eq ido-cur-item 'file)
2901 (ido-make-file-list-1 dir)
2902 (ido-make-dir-list-1 dir)))))
2903 (setq j n)
2904 (setq dir nil)))
2905 (if dir
2906 (setq ido-work-directory-index i))
2907 dir))
2909 (defun ido-prev-work-directory ()
2910 "Change to next working directory in list."
2911 (interactive)
2912 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2913 (when dir
2914 (ido-set-current-directory dir)
2915 (setq ido-exit 'refresh)
2916 (setq ido-text-init ido-text)
2917 (setq ido-rotate-temp t)
2918 (exit-minibuffer))))
2920 (defun ido-next-work-directory ()
2921 "Change to previous working directory in list."
2922 (interactive)
2923 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2924 (when dir
2925 (ido-set-current-directory dir)
2926 (setq ido-exit 'refresh)
2927 (setq ido-text-init ido-text)
2928 (setq ido-rotate-temp t)
2929 (exit-minibuffer))))
2931 (defun ido-merge-work-directories ()
2932 "Search (and merge) work directories for files matching the current input string."
2933 (interactive)
2934 (setq ido-use-merged-list t ido-try-merged-list t)
2935 (setq ido-exit 'refresh)
2936 (setq ido-text-init ido-text)
2937 (setq ido-rotate-temp t)
2938 (exit-minibuffer))
2940 (defun ido-wide-find-file (&optional file)
2941 "Prompt for FILE to search for using find, starting from current directory."
2942 (interactive)
2943 (unless file
2944 (let ((enable-recursive-minibuffers t))
2945 (setq file
2946 (condition-case nil
2947 (read-string (concat "Wide find file: " ido-current-directory) ido-text)
2948 (quit "")))))
2949 (when (> (length file) 0)
2950 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2951 (setq ido-exit 'refresh)
2952 (setq ido-text-init file)
2953 (setq ido-rotate-temp t)
2954 (exit-minibuffer)))
2956 (defun ido-wide-find-dir (&optional dir)
2957 "Prompt for DIR to search for using find, starting from current directory."
2958 (interactive)
2959 (unless dir
2960 (let ((enable-recursive-minibuffers t))
2961 (setq dir
2962 (condition-case nil
2963 (read-string (concat "Wide find directory: " ido-current-directory) ido-text)
2964 (quit "")))))
2965 (when (> (length dir) 0)
2966 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2967 (setq ido-exit 'refresh)
2968 (setq ido-text-init (ido-final-slash dir t))
2969 (setq ido-rotate-temp t)
2970 (exit-minibuffer)))
2972 (defun ido-wide-find-dir-or-delete-dir (&optional _dir)
2973 "Prompt for DIR to search for using find, starting from current directory.
2974 If input stack is non-empty, delete current directory component."
2975 (interactive)
2976 (if ido-input-stack
2977 (ido-delete-backward-word-updir 1)
2978 (ido-wide-find-dir)))
2980 (defun ido-take-first-match ()
2981 "Use first matching item as input text."
2982 (interactive)
2983 (when ido-matches
2984 (setq ido-text-init (ido-name (car ido-matches)))
2985 (setq ido-exit 'refresh)
2986 (exit-minibuffer)))
2988 (defun ido-push-dir ()
2989 "Move to previous directory in file name, push current input on stack."
2990 (interactive)
2991 (setq ido-exit 'push)
2992 (exit-minibuffer))
2994 (defun ido-push-dir-first ()
2995 "Move to previous directory in file name, push first match on stack."
2996 (interactive)
2997 (if ido-matches
2998 (setq ido-text (ido-name (car ido-matches))))
2999 (setq ido-exit 'push)
3000 (exit-minibuffer))
3002 (defun ido-pop-dir (arg)
3003 "Pop directory from input stack back to input.
3004 With \\[universal-argument], pop all elements."
3005 (interactive "P")
3006 (when ido-input-stack
3007 (setq ido-exit (if arg 'pop-all 'pop))
3008 (exit-minibuffer)))
3010 (defun ido-wide-find-file-or-pop-dir (arg)
3011 (interactive "P")
3012 (if ido-input-stack
3013 (ido-pop-dir arg)
3014 (ido-wide-find-file)))
3016 (defun ido-make-directory (&optional dir)
3017 "Prompt for DIR to create in current directory."
3018 (interactive)
3019 (unless dir
3020 (let ((enable-recursive-minibuffers t))
3021 (setq dir
3022 (read-string (concat "Make directory: " ido-current-directory) ido-text))))
3023 (when (> (length dir) 0)
3024 (setq dir (concat ido-current-directory dir))
3025 (unless (file-exists-p dir)
3026 (make-directory dir t)
3027 (ido-set-current-directory dir)
3028 (setq ido-exit 'refresh)
3029 (setq ido-text-init nil)
3030 (setq ido-rotate-temp t)
3031 (exit-minibuffer))))
3033 (defun ido-get-work-file (incr)
3034 (let ((n (length ido-work-file-list))
3035 (i (+ ido-work-file-index incr))
3036 name)
3037 (if (> incr 0)
3038 (if (>= i n) (setq i 0))
3039 (if (< i 0) (setq i (1- n))))
3040 (setq name (nth i ido-work-file-list))
3041 (setq ido-work-file-index i)
3042 name))
3044 (defun ido-prev-work-file ()
3045 "Change to next working file name in list."
3046 (interactive)
3047 (let ((name (ido-get-work-file 1)))
3048 (when name
3049 (setq ido-text-init name)
3050 (setq ido-exit 'refresh)
3051 (exit-minibuffer))))
3053 (defun ido-next-work-file ()
3054 "Change to previous working file name in list."
3055 (interactive)
3056 (let ((name (ido-get-work-file -1)))
3057 (when name
3058 (setq ido-text-init name)
3059 (setq ido-exit 'refresh)
3060 (exit-minibuffer))))
3062 (defun ido-copy-current-file-name (all)
3063 "Insert file name of current buffer.
3064 If repeated, insert text from buffer instead."
3065 (interactive "P")
3066 (let* ((bfname (or (buffer-file-name ido-entry-buffer)
3067 (buffer-name ido-entry-buffer)))
3068 (name (and bfname (file-name-nondirectory bfname))))
3069 (when name
3070 (setq ido-text-init
3071 (if (or all
3072 (eq last-command this-command)
3073 (not (equal (file-name-directory bfname) ido-current-directory))
3074 (not (string-match "\\.[^.]*\\'" name)))
3075 name
3076 (substring name 0 (1+ (match-beginning 0)))))
3077 (setq ido-exit 'refresh
3078 ido-try-merged-list nil)
3079 (exit-minibuffer))))
3081 (defun ido-copy-current-word (_all)
3082 "Insert current word (file or directory name) from current buffer."
3083 (interactive "P")
3084 (let ((word (with-current-buffer ido-entry-buffer
3085 (let ((p (point)) start-line end-line start-name)
3086 (if (and mark-active (/= p (mark)))
3087 (setq start-name (mark))
3088 (beginning-of-line)
3089 (setq start-line (point))
3090 (end-of-line)
3091 (setq end-line (point))
3092 (goto-char p)
3093 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
3094 (forward-char 1))
3095 (setq start-name (point))
3096 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
3097 (if (= start-name (point))
3098 (setq start-name nil)))
3099 (and start-name
3100 (buffer-substring-no-properties start-name (point)))))))
3101 (if (cond
3102 ((not word) nil)
3103 ((string-match "\\`[~/]" word)
3104 (setq ido-text-init word
3105 ido-try-merged-list nil
3106 ido-exit 'chdir))
3107 ((string-match "/" word)
3108 (setq ido-text-init (concat ido-current-directory word)
3109 ido-try-merged-list nil
3110 ido-exit 'chdir))
3112 (setq ido-text-init word
3113 ido-try-merged-list nil
3114 ido-exit 'refresh)))
3115 (exit-minibuffer))))
3117 (defun ido-next-match ()
3118 "Put first element of `ido-matches' at the end of the list."
3119 (interactive)
3120 (if ido-matches
3121 (let ((next (cadr ido-matches)))
3122 (setq ido-cur-list (ido-chop ido-cur-list next))
3123 (setq ido-matches (ido-chop ido-matches next))
3124 (setq ido-rescan nil))))
3126 (defun ido-prev-match ()
3127 "Put last element of `ido-matches' at the front of the list."
3128 (interactive)
3129 (if ido-matches
3130 (let ((prev (car (last ido-matches))))
3131 (setq ido-cur-list (ido-chop ido-cur-list prev))
3132 (setq ido-matches (ido-chop ido-matches prev))
3133 (setq ido-rescan nil))))
3135 (defun ido-next-match-dir ()
3136 "Find next directory in match list.
3137 If work directories have been merged, cycle through directories for
3138 first matching file."
3139 (interactive)
3140 (if ido-use-merged-list
3141 (if ido-matches
3142 (let* ((elt (car ido-matches))
3143 (dirs (cdr elt)))
3144 (when (> (length dirs) 1)
3145 (setcdr elt (ido-chop dirs (cadr dirs))))
3146 (setq ido-rescan nil)))
3147 (let ((cnt (length ido-matches))
3148 (i 1))
3149 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
3150 (setq i (1+ i)))
3151 (if (< i cnt)
3152 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3154 (defun ido-prev-match-dir ()
3155 "Find previous directory in match list.
3156 If work directories have been merged, cycle through directories
3157 for first matching file."
3158 (interactive)
3159 (if ido-use-merged-list
3160 (if ido-matches
3161 (let* ((elt (car ido-matches))
3162 (dirs (cdr elt)))
3163 (when (> (length dirs) 1)
3164 (setcdr elt (ido-chop dirs (car (last dirs)))))
3165 (setq ido-rescan nil)))
3166 (let* ((cnt (length ido-matches))
3167 (i (1- cnt)))
3168 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
3169 (setq i (1- i)))
3170 (if (> i 0)
3171 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3173 (defun ido-restrict-to-matches ()
3174 "Set current item list to the currently matched items."
3175 (interactive)
3176 (when ido-matches
3177 (setq ido-cur-list ido-matches
3178 ido-text-init ""
3179 ido-rescan nil
3180 ido-exit 'keep)
3181 (exit-minibuffer)))
3183 (defun ido-chop (items elem)
3184 "Remove all elements before ELEM and put them at the end of ITEMS."
3185 (let ((ret nil)
3186 (next nil)
3187 (sofar nil))
3188 (while (not ret)
3189 (setq next (car items))
3190 (if (equal next elem)
3191 (setq ret (append items (nreverse sofar)))
3192 ;; else
3193 (progn
3194 (setq items (cdr items))
3195 (setq sofar (cons next sofar)))))
3196 ret))
3198 (defun ido-name (item)
3199 ;; Return file name for current item, whether in a normal list
3200 ;; or a merged work directory list.
3201 (if (consp item) (car item) item))
3204 ;;; CREATE LIST OF ALL CURRENT FILES
3206 (defun ido-all-completions ()
3207 ;; Return unsorted list of all completions.
3208 (let ((ido-process-ignore-lists nil)
3209 (ido-directory-too-big nil))
3210 (cond
3211 ((eq ido-cur-item 'file)
3212 (ido-make-file-list-1 ido-current-directory))
3213 ((eq ido-cur-item 'dir)
3214 (ido-make-dir-list-1 ido-current-directory))
3215 ((eq ido-cur-item 'buffer)
3216 (ido-make-buffer-list-1))
3217 ((eq ido-cur-item 'list)
3218 ido-choice-list)
3219 (t nil))))
3222 ;; File list sorting
3224 (defun ido-file-lessp (a b)
3225 ;; Simple compare two file names.
3226 (string-lessp (ido-no-final-slash a) (ido-no-final-slash b)))
3229 (defun ido-file-extension-lessp (a b)
3230 ;; Compare file names according to ido-file-extensions-order list.
3231 (let ((n (compare-strings a 0 nil b 0 nil nil))
3232 lessp p)
3233 (if (eq n t)
3235 (if (< n 0)
3236 (setq n (1- (- n))
3237 p a a b b p
3238 lessp t)
3239 (setq n (1- n)))
3240 (cond
3241 ((= n 0)
3242 lessp)
3243 ((= (aref a n) ?.)
3244 (ido-file-extension-aux a b n lessp))
3246 (while (and (> n 2) (/= (aref a n) ?.))
3247 (setq n (1- n)))
3248 (if (> n 1)
3249 (ido-file-extension-aux a b n lessp)
3250 lessp))))))
3252 (defun ido-file-extension-aux (a b n lessp)
3253 (let ((oa (ido-file-extension-order a n))
3254 (ob (ido-file-extension-order b n)))
3255 (cond
3256 ((and oa ob)
3257 (cond
3258 ((= oa ob)
3259 lessp)
3260 (lessp
3261 (> oa ob))
3263 (< oa ob))))
3265 (not lessp))
3267 lessp)
3269 lessp))))
3271 (defun ido-file-extension-order (s n)
3272 (let ((l ido-file-extensions-order)
3273 (i 0) o do)
3274 (while l
3275 (cond
3276 ((eq (car l) t)
3277 (setq do i
3278 l (cdr l)))
3279 ((eq (compare-strings s n nil (car l) 0 nil nil) t)
3280 (setq o i
3281 l nil))
3283 (setq l (cdr l))))
3284 (setq i (1+ i)))
3285 (or o do)))
3288 (defun ido-sort-merged-list (items promote)
3289 ;; Input is list of ("file" . "dir") cons cells.
3290 ;; Output is sorted list of ("file "dir" ...) lists
3291 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
3292 res a cur)
3293 (while l
3294 (setq a (car l)
3295 l (cdr l))
3296 (if (and res (string-equal (car (car res)) (car a)))
3297 (progn
3298 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
3299 (if (and promote (string-equal ido-current-directory (cdr a)))
3300 (setq cur t)))
3301 (setq res (cons (list (car a) (cdr a)) res)
3302 cur nil)))
3303 res))
3305 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
3306 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
3307 (let ((filenames
3308 (delq nil
3309 (mapcar (lambda (name)
3310 (unless (ido-ignore-item-p name ido-ignore-files t)
3311 name))
3312 (split-string
3313 (shell-command-to-string
3314 (concat "find "
3315 (shell-quote-argument dir)
3316 (if ido-case-fold " -iname " " -name ")
3317 (shell-quote-argument
3318 (concat (if prefix "" "*") file "*"))
3319 " -type " (if finddir "d" "f") " -print"))))))
3320 filename d f
3321 res)
3322 (while filenames
3323 (setq filename (car filenames)
3324 filenames (cdr filenames))
3325 (if (and (file-name-absolute-p filename)
3326 (file-exists-p filename))
3327 (setq d (file-name-directory filename)
3328 f (file-name-nondirectory filename)
3329 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
3330 res))
3332 (defun ido-flatten-merged-list (items)
3333 "Create a list of directory names based on a merged directory list."
3334 (let (res)
3335 (while items
3336 (let* ((item (car items))
3337 (file (car item))
3338 (dirs (cdr item)))
3339 (while dirs
3340 (setq res (cons (concat (car dirs) file) res)
3341 dirs (cdr dirs))))
3342 (setq items (cdr items)))
3343 res))
3346 (defun ido-make-merged-file-list-1 (text auto wide)
3347 (let (res)
3348 (if (and (ido-final-slash text) ido-dir-file-cache)
3349 (if wide
3350 (setq res (ido-wide-find-dirs-or-files
3351 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
3352 ;; Use list of cached directories
3353 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
3354 (dirs ido-dir-file-cache)
3355 dir b d f)
3356 (if nil ;; simple
3357 (while dirs
3358 (setq dir (car (car dirs))
3359 dirs (cdr dirs))
3360 (when (and (string-match re dir)
3361 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
3362 (file-directory-p dir))
3363 (setq b (substring dir 0 -1)
3364 f (concat (file-name-nondirectory b) "/")
3365 d (file-name-directory b)
3366 res (cons (cons f d) res))))
3367 (while dirs
3368 (setq dir (car dirs)
3369 d (car dir)
3370 dirs (cdr dirs))
3371 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
3372 (setq dir (cdr (cdr dir)))
3373 (while dir
3374 (setq f (car dir)
3375 dir (cdr dir))
3376 (if (and (string-match re f)
3377 (not (ido-ignore-item-p f ido-ignore-directories)))
3378 (setq res (cons (cons f d) res)))))
3379 (if (and auto (input-pending-p))
3380 (setq dirs nil
3381 res t))))))
3382 (if wide
3383 (setq res (ido-wide-find-dirs-or-files
3384 ido-current-directory text ido-enable-prefix nil))
3385 (let ((ido-text text)
3386 (dirs ido-work-directory-list)
3387 (must-match (and text (> (length text) 0)))
3388 dir fl)
3389 (if (and auto (not (member ido-current-directory dirs)))
3390 (setq dirs (cons ido-current-directory dirs)))
3391 (while dirs
3392 (setq dir (car dirs)
3393 dirs (cdr dirs))
3394 (when (and dir (stringp dir)
3395 (or ido-merge-ftp-work-directories
3396 (not (ido-is-ftp-directory dir)))
3397 (file-directory-p dir)
3398 ;; TODO. check for nonreadable and too-big.
3399 (setq fl (if (eq ido-cur-item 'file)
3400 (ido-make-file-list-1 dir t)
3401 (ido-make-dir-list-1 dir t))))
3402 (if must-match
3403 (setq fl (ido-set-matches-1 fl)))
3404 (if fl
3405 (setq res (nconc fl res))))
3406 (if (and auto (input-pending-p))
3407 (setq dirs nil
3408 res t))))))
3409 res))
3411 (defun ido-make-merged-file-list (text auto wide)
3412 (let (res)
3413 (message "Searching for `%s'...." text)
3414 (condition-case nil
3415 (if (eq t (setq res
3416 (while-no-input
3417 (ido-make-merged-file-list-1 text auto wide))))
3418 (setq res 'input-pending-p))
3419 (quit
3420 (setq res t
3421 ido-try-merged-list nil
3422 ido-use-merged-list nil)))
3423 (when (and res (listp res))
3424 (setq res (ido-sort-merged-list res auto)))
3425 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
3426 (listp res)
3427 (> (length text) 0))
3428 (let ((elt (assoc text res)))
3429 (when (and elt (not (eq elt (car res))))
3430 (setq res (delq elt res))
3431 (setq res (cons elt res)))))
3432 (message nil)
3433 res))
3435 (defun ido-make-buffer-list-1 (&optional frame visible)
3436 "Return list of non-ignored buffer names."
3437 (delq nil
3438 (mapcar
3439 (lambda (x)
3440 (let ((name (buffer-name x)))
3441 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
3442 name)))
3443 (buffer-list frame))))
3445 (defun ido-make-buffer-list (default)
3446 "Return the current list of buffers.
3447 Currently visible buffers are put at the end of the list.
3448 The hook `ido-make-buffer-list-hook' is run after the list has been
3449 created to allow the user to further modify the order of the buffer names
3450 in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
3451 it is put to the start of the list."
3452 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
3453 (ido-temp-list (ido-make-buffer-list-1 (selected-frame) ido-current-buffers)))
3454 (if ido-temp-list
3455 (nconc ido-temp-list ido-current-buffers)
3456 (setq ido-temp-list ido-current-buffers))
3457 (if default
3458 (setq ido-temp-list
3459 (cons default (delete default ido-temp-list))))
3460 (if (bound-and-true-p ido-enable-virtual-buffers)
3461 (ido-add-virtual-buffers-to-list))
3462 (run-hooks 'ido-make-buffer-list-hook)
3463 ido-temp-list))
3465 (defun ido-add-virtual-buffers-to-list ()
3466 "Add recently visited files, and bookmark files, to the buffer list.
3467 This is to make them appear as if they were \"virtual buffers\"."
3468 ;; If no buffers matched, and virtual buffers are being used, then
3469 ;; consult the list of past visited files, to see if we can find
3470 ;; the file which the user might thought was still open.
3471 (unless recentf-mode (recentf-mode 1))
3472 (setq ido-virtual-buffers nil)
3473 (let (name)
3474 (dolist (head recentf-list)
3475 (setq name (file-name-nondirectory head))
3476 ;; In case HEAD is a directory with trailing /. See bug#14552.
3477 (when (equal name "")
3478 (setq name (file-name-nondirectory (directory-file-name head))))
3479 (when (equal name "")
3480 (setq name head))
3481 (and (not (equal name ""))
3482 (null (get-file-buffer head))
3483 (not (assoc name ido-virtual-buffers))
3484 (not (member name ido-temp-list))
3485 (not (ido-ignore-item-p name ido-ignore-buffers))
3486 ;;(file-exists-p head)
3487 (push (cons name head) ido-virtual-buffers))))
3488 (when ido-virtual-buffers
3489 (if ido-use-faces
3490 (dolist (comp ido-virtual-buffers)
3491 (put-text-property 0 (length (car comp))
3492 'face 'ido-virtual
3493 (car comp))))
3494 (setq ido-temp-list
3495 (nconc ido-temp-list
3496 (nreverse (mapcar #'car ido-virtual-buffers))))))
3498 (defun ido-make-choice-list (default)
3499 "Return the current list of choices.
3500 If DEFAULT is non-nil, and corresponds to an element of choices,
3501 it is put to the start of the list."
3502 (let ((ido-temp-list ido-choice-list))
3503 (if default
3504 (progn
3505 (setq ido-temp-list
3506 (delete default ido-temp-list))
3507 (setq ido-temp-list
3508 (cons default ido-temp-list))))
3509 ; (run-hooks 'ido-make-choice-list-hook)
3510 ido-temp-list))
3512 (defun ido-to-end (items)
3513 "Move the elements from ITEMS to the end of `ido-temp-list'."
3514 (mapc
3515 (lambda (elem)
3516 (setq ido-temp-list (delq elem ido-temp-list)))
3517 items)
3518 (if ido-temp-list
3519 (nconc ido-temp-list items)
3520 (setq ido-temp-list items)))
3522 (defun ido-file-name-all-completions-1 (dir)
3523 (cond
3524 ((ido-nonreadable-directory-p dir) '())
3525 ;; do not check (ido-directory-too-big-p dir) here.
3526 ;; Caller must have done that if necessary.
3528 ((and ido-enable-tramp-completion
3529 (string-match "\\`/[^/]+[:@]\\'" dir))
3530 ;; Strip method:user@host: part of tramp completions.
3531 ;; Tramp completions do not include leading slash.
3532 (let* ((len (1- (length dir)))
3533 (non-essential t)
3534 (compl
3535 (or (file-name-all-completions "" dir)
3536 ;; work around bug in ange-ftp.
3537 ;; /ftp:user@host: => nil
3538 ;; /ftp:user@host:./ => ok
3539 (and
3540 (not (string= "/ftp:" dir))
3541 (file-remote-p dir)
3542 ;; tramp-ftp-file-name-p is available only when tramp
3543 ;; has been loaded.
3544 (fboundp 'tramp-ftp-file-name-p)
3545 (funcall 'tramp-ftp-file-name-p dir)
3546 (string-match ":\\'" dir)
3547 (file-name-all-completions "" (concat dir "./"))))))
3548 (if (and compl
3549 (> (length (car compl)) len)
3550 (string= (substring (car compl) 0 len) (substring dir 1)))
3551 (mapcar (lambda (c) (substring c len)) compl)
3552 compl)))
3554 (file-name-all-completions "" dir))))
3556 (defun ido-file-name-all-completions (dir)
3557 "Return name of all files in DIR.
3558 Uses and updates `ido-dir-file-cache'."
3559 (cond
3560 ((ido-is-unc-root dir)
3561 (mapcar
3562 (lambda (host)
3563 (if (string-match "/\\'" host) host (concat host "/")))
3564 (ido-unc-hosts t)))
3565 ((and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
3566 (stringp dir) (> (length dir) 0)
3567 (ido-may-cache-directory dir))
3568 (let* ((cached (assoc dir ido-dir-file-cache))
3569 (ctime (nth 1 cached))
3570 (ftp (ido-is-ftp-directory dir))
3571 (unc (ido-is-unc-host dir))
3572 (attr (if (or ftp unc) nil (file-attributes dir)))
3573 (mtime (nth 5 attr))
3574 valid)
3575 (when cached ; should we use the cached entry ?
3576 (cond
3577 (ftp
3578 (setq valid (and (eq (car ctime) 'ftp)
3579 (ido-cache-ftp-valid (cdr ctime)))))
3580 (unc
3581 (setq valid (and (eq (car ctime) 'unc)
3582 (ido-cache-unc-valid (cdr ctime)))))
3584 (if attr
3585 (setq valid (and (= (car ctime) (car mtime))
3586 (= (car (cdr ctime)) (car (cdr mtime))))))))
3587 (unless valid
3588 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
3589 cached nil)))
3590 (unless cached
3591 (cond
3592 (unc
3593 (setq mtime (cons 'unc (ido-time-stamp))))
3594 ((and ftp (file-readable-p dir))
3595 (setq mtime (cons 'ftp (ido-time-stamp)))))
3596 (if mtime
3597 (setq cached (cons dir (cons mtime (ido-file-name-all-completions-1 dir)))
3598 ido-dir-file-cache (cons cached ido-dir-file-cache)))
3599 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
3600 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
3601 (and cached
3602 (cdr (cdr cached)))))
3604 (ido-file-name-all-completions-1 dir))))
3606 (defun ido-remove-cached-dir (dir)
3607 "Remove DIR from `ido-dir-file-cache'."
3608 (if (and ido-dir-file-cache
3609 (stringp dir) (> (length dir) 0))
3610 (let ((cached (assoc dir ido-dir-file-cache)))
3611 (if cached
3612 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
3615 (defun ido-make-file-list-1 (dir &optional merged)
3616 "Return list of non-ignored files in DIR
3617 If MERGED is non-nil, each file is cons'ed with DIR."
3618 (and (or (ido-is-tramp-root dir) (ido-is-unc-root dir)
3619 (file-directory-p dir))
3620 (delq nil
3621 (mapcar
3622 (lambda (name)
3623 (if (not (ido-ignore-item-p name ido-ignore-files t))
3624 (if merged (cons name dir) name)))
3625 (ido-file-name-all-completions dir)))))
3627 (defun ido-make-file-list (default)
3628 "Return the current list of files.
3629 Currently visible files are put at the end of the list.
3630 The hook `ido-make-file-list-hook' is run after the list has been
3631 created to allow the user to further modify the order of the file names
3632 in this list."
3633 (let ((ido-temp-list (ido-make-file-list-1 ido-current-directory)))
3634 (setq ido-temp-list (sort ido-temp-list
3635 (if ido-file-extensions-order
3636 #'ido-file-extension-lessp
3637 #'ido-file-lessp)))
3638 (unless (ido-is-tramp-root ido-current-directory)
3639 (let ((default-directory ido-current-directory))
3640 (ido-to-end ;; move ftp hosts and visited files to end
3641 (delq nil (mapcar
3642 (lambda (x) (if (or (and (string-match ".:\\'" x)
3643 (not (ido-local-file-exists-p x)))
3644 (and (not (ido-final-slash x))
3645 (let (file-name-handler-alist)
3646 (get-file-buffer x)))) x))
3647 ido-temp-list)))))
3648 (ido-to-end ;; move . files to end
3649 (delq nil (mapcar
3650 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3651 ido-temp-list)))
3652 (if (and default (member default ido-temp-list))
3653 (if (or ido-rotate-temp ido-rotate-file-list-default)
3654 (unless (equal default (car ido-temp-list))
3655 (let ((l ido-temp-list) k)
3656 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3657 (setq l (cdr l)))
3658 (setq k (cdr l))
3659 (setcdr l nil)
3660 (nconc k ido-temp-list)
3661 (setq ido-temp-list k)))
3662 (setq ido-temp-list
3663 (delete default ido-temp-list))
3664 (setq ido-temp-list
3665 (cons default ido-temp-list))))
3666 (when ido-show-dot-for-dired
3667 (setq ido-temp-list (delete "." ido-temp-list))
3668 (setq ido-temp-list (cons "." ido-temp-list)))
3669 (run-hooks 'ido-make-file-list-hook)
3670 ido-temp-list))
3672 (defun ido-make-dir-list-1 (dir &optional merged)
3673 "Return list of non-ignored subdirs in DIR.
3674 If MERGED is non-nil, each subdir is cons'ed with DIR."
3675 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
3676 (delq nil
3677 (mapcar
3678 (lambda (name)
3679 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
3680 (if merged (cons name dir) name)))
3681 (ido-file-name-all-completions dir)))))
3683 (defun ido-make-dir-list (default)
3684 "Return the current list of directories.
3685 The hook `ido-make-dir-list-hook' is run after the list has been
3686 created to allow the user to further modify the order of the
3687 directory names in this list."
3688 (let ((ido-temp-list (ido-make-dir-list-1 ido-current-directory)))
3689 (setq ido-temp-list (sort ido-temp-list #'ido-file-lessp))
3690 (ido-to-end ;; move . files to end
3691 (delq nil (mapcar
3692 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3693 ido-temp-list)))
3694 (if (and default (member default ido-temp-list))
3695 (if (or ido-rotate-temp ido-rotate-file-list-default)
3696 (unless (equal default (car ido-temp-list))
3697 (let ((l ido-temp-list) k)
3698 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3699 (setq l (cdr l)))
3700 (setq k (cdr l))
3701 (setcdr l nil)
3702 (nconc k ido-temp-list)
3703 (setq ido-temp-list k)))
3704 (setq ido-temp-list
3705 (delete default ido-temp-list))
3706 (setq ido-temp-list
3707 (cons default ido-temp-list))))
3708 (setq ido-temp-list (delete "." ido-temp-list))
3709 (unless ido-input-stack
3710 (setq ido-temp-list (cons "." ido-temp-list)))
3711 (run-hooks 'ido-make-dir-list-hook)
3712 ido-temp-list))
3714 ;; List of the files visible in the current frame.
3715 (defvar ido-bufs-in-frame)
3717 (defun ido-get-buffers-in-frames (&optional current)
3718 "Return the list of buffers that are visible in the current frame.
3719 If optional argument CURRENT is given, restrict searching to the current
3720 frame, rather than all frames, regardless of value of `ido-all-frames'."
3721 (let ((ido-bufs-in-frame nil))
3722 (walk-windows 'ido-get-bufname nil
3723 (if current
3725 ido-all-frames))
3726 ido-bufs-in-frame))
3728 (defun ido-get-bufname (win)
3729 "Used by `ido-get-buffers-in-frames' to walk through all windows."
3730 (let ((buf (buffer-name (window-buffer win))))
3731 (unless (or (member buf ido-bufs-in-frame)
3732 (member buf ido-ignore-item-temp-list))
3733 ;; Only add buf if it is not already in list.
3734 ;; This prevents same buf in two different windows being
3735 ;; put into the list twice.
3736 (setq ido-bufs-in-frame
3737 (cons buf ido-bufs-in-frame)))))
3739 ;;; FIND MATCHING ITEMS
3741 (defun ido-set-matches-1 (items &optional do-full)
3742 "Return list of matches in ITEMS."
3743 (let* ((case-fold-search ido-case-fold)
3744 (slash (and (not ido-enable-prefix) (ido-final-slash ido-text)))
3745 (text (if slash (substring ido-text 0 -1) ido-text))
3746 (rex0 (if ido-enable-regexp text (regexp-quote text)))
3747 (rexq (concat rex0 (if slash ".*/" "")))
3748 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
3749 (full-re (and do-full
3750 (not (and (eq ido-cur-item 'buffer)
3751 ido-buffer-disable-smart-matches))
3752 (not ido-enable-regexp)
3753 (not (string-match "\$\\'" rex0))
3754 (concat "\\`" rex0 (if slash "/" "") "\\'")))
3755 (suffix-re (and do-full slash
3756 (not (and (eq ido-cur-item 'buffer)
3757 ido-buffer-disable-smart-matches))
3758 (not ido-enable-regexp)
3759 (not (string-match "\$\\'" rex0))
3760 (concat rex0 "/\\'")))
3761 (prefix-re (and full-re (not ido-enable-prefix)
3762 (concat "\\`" rexq)))
3763 (non-prefix-dot (or (not ido-enable-dot-prefix)
3764 (not ido-process-ignore-lists)
3765 ido-enable-prefix
3766 (= (length ido-text) 0)))
3767 full-matches suffix-matches prefix-matches matches)
3768 (setq ido-incomplete-regexp nil)
3769 (condition-case error
3770 (mapc
3771 (lambda (item)
3772 (let ((name (ido-name item)))
3773 (if (and (or non-prefix-dot
3774 (if (= (aref ido-text 0) ?.)
3775 (= (aref name 0) ?.)
3776 (/= (aref name 0) ?.)))
3777 (string-match re name))
3778 (cond
3779 ((and (eq ido-cur-item 'buffer)
3780 (or (not (stringp ido-default-item))
3781 (not (string= name ido-default-item)))
3782 (string= name (buffer-name ido-entry-buffer)))
3783 (setq matches (cons item matches)))
3784 ((and full-re (string-match full-re name))
3785 (setq full-matches (cons item full-matches)))
3786 ((and suffix-re (string-match suffix-re name))
3787 (setq suffix-matches (cons item suffix-matches)))
3788 ((and prefix-re (string-match prefix-re name))
3789 (setq prefix-matches (cons item prefix-matches)))
3790 (t (setq matches (cons item matches))))))
3792 items)
3793 (invalid-regexp
3794 (setq ido-incomplete-regexp t
3795 ;; Consider the invalid regexp message internally as a
3796 ;; special-case single match, and handle appropriately
3797 ;; elsewhere.
3798 matches (cdr error))))
3799 (when prefix-matches
3800 (ido-trace "prefix match" prefix-matches)
3801 ;; Bug#2042.
3802 (setq matches (nconc prefix-matches matches)))
3803 (when suffix-matches
3804 (ido-trace "suffix match" (list text suffix-re suffix-matches))
3805 (setq matches (nconc suffix-matches matches)))
3806 (when full-matches
3807 (ido-trace "full match" (list text full-re full-matches))
3808 (setq matches (nconc full-matches matches)))
3809 (when (and (null matches)
3810 ido-enable-flex-matching
3811 (> (length ido-text) 1)
3812 (not ido-enable-regexp))
3813 (setq re (concat (regexp-quote (string (aref ido-text 0)))
3814 (mapconcat (lambda (c)
3815 (concat "[^" (string c) "]*"
3816 (regexp-quote (string c))))
3817 (substring ido-text 1) "")))
3818 (if ido-enable-prefix
3819 (setq re (concat "\\`" re)))
3820 (mapc
3821 (lambda (item)
3822 (let ((name (ido-name item)))
3823 (if (string-match re name)
3824 (setq matches (cons item matches)))))
3825 items))
3826 (delete-consecutive-dups matches t)))
3829 (defun ido-set-matches ()
3830 "Set `ido-matches' to the list of items matching prompt."
3831 (when ido-rescan
3832 (setq ido-matches (ido-set-matches-1 (reverse ido-cur-list) (not ido-rotate))
3833 ido-rotate nil)))
3835 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
3836 "Return t if the buffer or file NAME should be ignored."
3837 (or (member name ido-ignore-item-temp-list)
3838 (and
3839 ido-process-ignore-lists re-list
3840 (save-match-data
3841 (let ((ext-list (and ignore-ext ido-ignore-extensions
3842 completion-ignored-extensions))
3843 (case-fold-search ido-case-fold)
3844 ignorep nextstr
3845 (flen (length name)) slen)
3846 (while ext-list
3847 (setq nextstr (car ext-list))
3848 (if (cond
3849 ((stringp nextstr)
3850 (and (>= flen (setq slen (length nextstr)))
3851 (string-equal (substring name (- flen slen)) nextstr)))
3852 ((functionp nextstr) (funcall nextstr name))
3853 (t nil))
3854 (setq ignorep t
3855 ext-list nil
3856 re-list nil)
3857 (setq ext-list (cdr ext-list))))
3858 (while re-list
3859 (setq nextstr (car re-list))
3860 (if (cond
3861 ((stringp nextstr) (string-match nextstr name))
3862 ((functionp nextstr) (funcall nextstr name))
3863 (t nil))
3864 (setq ignorep t
3865 re-list nil)
3866 (setq re-list (cdr re-list))))
3867 ;; return the result
3868 (if ignorep
3869 (setq ido-ignored-list (cons name ido-ignored-list)))
3870 ignorep)))))
3872 ;; Private variable used by `ido-word-matching-substring'.
3873 (defvar ido-change-word-sub)
3875 (defun ido-find-common-substring (items subs)
3876 "Return common string following SUBS in each element of ITEMS."
3877 (let (res
3878 alist
3879 ido-change-word-sub)
3880 (setq ido-change-word-sub
3881 (if ido-enable-regexp
3882 subs
3883 (regexp-quote subs)))
3884 (setq res (mapcar #'ido-word-matching-substring items))
3885 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
3886 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
3888 ;; try-completion returns t if there is an exact match.
3889 (let* ((completion-ignore-case ido-case-fold)
3890 (comp (try-completion subs alist)))
3891 (if (eq comp t)
3892 subs
3893 comp))))
3895 (defun ido-word-matching-substring (word)
3896 "Return part of WORD before first match to `ido-change-word-sub'.
3897 If `ido-change-word-sub' cannot be found in WORD, return nil."
3898 (let ((case-fold-search ido-case-fold))
3899 (let ((m (string-match ido-change-word-sub (ido-name word))))
3900 (if m
3901 (substring (ido-name word) m)
3902 ;; else no match
3903 nil))))
3905 (defun ido-makealist (res)
3906 "Return dotted pair (RES . 1)."
3907 (cons res 1))
3909 (defun ido-choose-completion-string (choice &rest ignored)
3910 (when (ido-active)
3911 ;; Insert the completion into the buffer where completion was requested.
3912 (and ido-completion-buffer
3913 (get-buffer ido-completion-buffer)
3914 (kill-buffer ido-completion-buffer))
3915 (cond
3916 ((ido-active t) ;; ido-use-merged-list
3917 (setq ido-current-directory ""
3918 ido-text choice
3919 ido-exit 'done))
3920 ((not (ido-final-slash choice))
3921 (setq ido-text choice
3922 ido-exit 'done))
3924 (ido-set-current-directory ido-current-directory choice)
3925 (setq ido-exit 'refresh)))
3926 (exit-minibuffer)
3929 (defun ido-completion-help ()
3930 "Show possible completions in a *File Completions* buffer."
3931 (interactive)
3932 (setq ido-rescan nil)
3933 (let ((temp-buf (and ido-completion-buffer
3934 (get-buffer ido-completion-buffer)))
3935 display-it full-list)
3936 (if (and (eq last-command this-command) temp-buf)
3937 ;; scroll buffer
3938 (let (win (buf (current-buffer)))
3939 (display-buffer temp-buf nil nil)
3940 (set-buffer temp-buf)
3941 (setq win (get-buffer-window temp-buf))
3942 (if (pos-visible-in-window-p (point-max) win)
3943 (if (or ido-completion-buffer-all-completions
3944 (boundp 'ido-completion-buffer-full))
3945 (set-window-start win (point-min))
3946 (with-no-warnings
3947 (set (make-local-variable 'ido-completion-buffer-full) t))
3948 (setq full-list t
3949 display-it t))
3950 (scroll-other-window))
3951 (set-buffer buf))
3952 (setq display-it t))
3953 (if (and ido-completion-buffer display-it)
3954 (with-output-to-temp-buffer ido-completion-buffer
3955 (let ((completion-list (sort
3956 (cond
3957 (ido-directory-too-big
3958 (message "Reading directory...")
3959 (setq ido-directory-too-big nil
3960 ido-ignored-list nil
3961 ido-cur-list (ido-all-completions)
3962 ido-rescan t)
3963 (ido-set-matches)
3964 (or ido-matches ido-cur-list))
3965 (ido-use-merged-list
3966 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
3967 ((or full-list ido-completion-buffer-all-completions)
3968 (ido-all-completions))
3970 (copy-sequence (or ido-matches ido-cur-list))))
3971 #'ido-file-lessp)))
3972 (if (featurep 'xemacs)
3973 ;; XEmacs extents are put on by default, doesn't seem to be
3974 ;; any way of switching them off.
3975 (display-completion-list
3976 completion-list
3977 :help-string "ido "
3978 :activate-callback
3979 (lambda (&rest _) (message "Doesn't work yet, sorry!")))
3980 ;; else running Emacs
3981 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
3982 (display-completion-list completion-list)))))))
3984 ;;; KILL CURRENT BUFFER
3985 (defun ido-kill-buffer-at-head ()
3986 "Kill the buffer at the head of `ido-matches'.
3987 If cursor is not at the end of the user input, delete to end of input."
3988 (interactive)
3989 (if (not (eobp))
3990 (delete-region (point) (line-end-position))
3991 (let ((enable-recursive-minibuffers t)
3992 (buf (ido-name (car ido-matches)))
3993 (nextbuf (cadr ido-matches)))
3994 (cond
3995 ((get-buffer buf)
3996 ;; If next match names a buffer use the buffer object; buffer
3997 ;; name may be changed by packages such as uniquify.
3998 (when (and nextbuf (get-buffer nextbuf))
3999 (setq nextbuf (get-buffer nextbuf)))
4000 (if (null (kill-buffer buf))
4001 ;; Buffer couldn't be killed.
4002 (setq ido-rescan t)
4003 ;; Else `kill-buffer' succeeds so re-make the buffer list
4004 ;; taking into account packages like uniquify may rename
4005 ;; buffers.
4006 (if (bufferp nextbuf)
4007 (setq nextbuf (buffer-name nextbuf)))
4008 (setq ido-default-item nextbuf
4009 ido-text-init ido-text
4010 ido-exit 'refresh)
4011 (exit-minibuffer)))
4012 ;; Handle virtual buffers
4013 ((assoc buf ido-virtual-buffers)
4014 (setq recentf-list
4015 (delete (cdr (assoc buf ido-virtual-buffers)) recentf-list))
4016 (setq ido-cur-list (delete buf ido-cur-list))
4017 (setq ido-rescan t))))))
4019 ;;; DELETE CURRENT FILE
4020 (defun ido-delete-file-at-head ()
4021 "Delete the file at the head of `ido-matches'.
4022 Trash the file if `delete-by-moving-to-trash' is non-nil.
4023 If cursor is not at the end of the user input, delete to end of input."
4024 (interactive)
4025 (if (not (eobp))
4026 (delete-region (point) (line-end-position))
4027 (let ((enable-recursive-minibuffers t)
4028 (file (ido-name (car ido-matches))))
4029 (if file
4030 (setq file (concat ido-current-directory file)))
4031 (when (and file
4032 (file-exists-p file)
4033 (not (file-directory-p file))
4034 (file-writable-p ido-current-directory)
4035 (or delete-by-moving-to-trash
4036 (yes-or-no-p (concat "Delete " file "? "))))
4037 (delete-file file 'trash)
4038 ;; Check if file still exists.
4039 (if (file-exists-p file)
4040 ;; file could not be deleted
4041 (setq ido-rescan t)
4042 ;; else file was killed so remove name from list.
4043 (setq ido-cur-list (delq (car ido-matches) ido-cur-list)))))))
4046 ;;; VISIT CHOSEN BUFFER
4047 (defun ido-visit-buffer (buffer method &optional record)
4048 "Switch to BUFFER according to METHOD.
4049 Record command in `command-history' if optional RECORD is non-nil."
4050 (if (bufferp buffer)
4051 (setq buffer (buffer-name buffer)))
4052 (let (win newframe)
4053 (cond
4054 ((eq method 'kill)
4055 (if record
4056 (ido-record-command 'kill-buffer buffer))
4057 (kill-buffer buffer))
4059 ((eq method 'other-window)
4060 (if record
4061 (ido-record-command 'switch-to-buffer buffer))
4062 (switch-to-buffer-other-window buffer))
4064 ((eq method 'display)
4065 (display-buffer buffer))
4067 ((eq method 'other-frame)
4068 (switch-to-buffer-other-frame buffer)
4069 (select-frame-set-input-focus (selected-frame)))
4071 ((and (memq method '(raise-frame maybe-frame))
4072 window-system
4073 (setq win (ido-buffer-window-other-frame buffer))
4074 (or (eq method 'raise-frame)
4075 (y-or-n-p "Jump to frame? ")))
4076 (setq newframe (window-frame win))
4077 (select-frame-set-input-focus newframe)
4078 (select-window win))
4080 ;; (eq method 'selected-window)
4082 ;; No buffer in other frames...
4083 (if record
4084 (ido-record-command 'switch-to-buffer buffer))
4085 (switch-to-buffer buffer)
4086 ))))
4089 (defun ido-buffer-window-other-frame (buffer)
4090 "Return window pointer if BUFFER is visible in another frame.
4091 If BUFFER is visible in the current frame, return nil."
4092 (let ((blist (ido-get-buffers-in-frames 'current)))
4093 ;;If the buffer is visible in current frame, return nil
4094 (if (member buffer blist)
4096 ;; maybe in other frame or icon
4097 (get-buffer-window buffer 0) ; better than 'visible
4101 ;;; ----------- IDONIZED FUNCTIONS ------------
4103 ;;;###autoload
4104 (defun ido-switch-buffer ()
4105 "Switch to another buffer.
4106 The buffer is displayed according to `ido-default-buffer-method' -- the
4107 default is to show it in the same window, unless it is already visible
4108 in another frame.
4110 As you type in a string, all of the buffers matching the string are
4111 displayed if substring-matching is used \(default). Look at
4112 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
4113 buffer you want, it can then be selected. As you type, most keys have
4114 their normal keybindings, except for the following: \\<ido-buffer-completion-map>
4116 RET Select the buffer at the front of the list of matches. If the
4117 list is empty, possibly prompt to create new buffer.
4119 \\[ido-select-text] Use the current input string verbatim.
4121 \\[ido-next-match] Put the first element at the end of the list.
4122 \\[ido-prev-match] Put the last element at the start of the list.
4123 \\[ido-complete] Complete a common suffix to the current string that
4124 matches all buffers. If there is only one match, select that buffer.
4125 If there is no common suffix, show a list of all matching buffers
4126 in a separate window.
4127 \\[ido-edit-input] Edit input string.
4128 \\[ido-fallback-command] Fallback to non-ido version of current command.
4129 \\[ido-toggle-regexp] Toggle regexp searching.
4130 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
4131 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
4132 \\[ido-completion-help] Show list of matching buffers in separate window.
4133 \\[ido-enter-find-file] Drop into `ido-find-file'.
4134 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
4135 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
4136 (interactive)
4137 (ido-buffer-internal ido-default-buffer-method))
4139 ;;;###autoload
4140 (defun ido-switch-buffer-other-window ()
4141 "Switch to another buffer and show it in another window.
4142 The buffer name is selected interactively by typing a substring.
4143 For details of keybindings, see `ido-switch-buffer'."
4144 (interactive)
4145 (ido-buffer-internal 'other-window 'switch-to-buffer-other-window))
4147 ;;;###autoload
4148 (defun ido-display-buffer ()
4149 "Display a buffer in another window but don't select it.
4150 The buffer name is selected interactively by typing a substring.
4151 For details of keybindings, see `ido-switch-buffer'."
4152 (interactive)
4153 (ido-buffer-internal 'display 'display-buffer nil nil nil 'ignore))
4155 ;;;###autoload
4156 (defun ido-kill-buffer ()
4157 "Kill a buffer.
4158 The buffer name is selected interactively by typing a substring.
4159 For details of keybindings, see `ido-switch-buffer'."
4160 (interactive)
4161 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer)) nil 'ignore))
4163 ;;;###autoload
4164 (defun ido-insert-buffer ()
4165 "Insert contents of a buffer in current buffer after point.
4166 The buffer name is selected interactively by typing a substring.
4167 For details of keybindings, see `ido-switch-buffer'."
4168 (interactive)
4169 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil nil 'ido-enter-insert-file))
4171 ;;;###autoload
4172 (defun ido-switch-buffer-other-frame ()
4173 "Switch to another buffer and show it in another frame.
4174 The buffer name is selected interactively by typing a substring.
4175 For details of keybindings, see `ido-switch-buffer'."
4176 (interactive)
4177 (if ido-mode
4178 (ido-buffer-internal 'other-frame)
4179 (call-interactively 'switch-to-buffer-other-frame)))
4181 ;;;###autoload
4182 (defun ido-find-file-in-dir (dir)
4183 "Switch to another file starting from DIR."
4184 (interactive "DDir: ")
4185 (setq dir (file-name-as-directory dir))
4186 (ido-file-internal ido-default-file-method nil dir nil nil nil 'ignore))
4188 ;;;###autoload
4189 (defun ido-find-file ()
4190 "Edit file with name obtained via minibuffer.
4191 The file is displayed according to `ido-default-file-method' -- the
4192 default is to show it in the same window, unless it is already
4193 visible in another frame.
4195 The file name is selected interactively by typing a substring. As you
4196 type in a string, all of the filenames matching the string are displayed
4197 if substring-matching is used \(default). Look at `ido-enable-prefix' and
4198 `ido-toggle-prefix'. When you have found the filename you want, it can
4199 then be selected. As you type, most keys have their normal keybindings,
4200 except for the following: \\<ido-file-completion-map>
4202 RET Select the file at the front of the list of matches. If the
4203 list is empty, possibly prompt to create new file.
4205 \\[ido-select-text] Use the current input string verbatim.
4207 \\[ido-next-match] Put the first element at the end of the list.
4208 \\[ido-prev-match] Put the last element at the start of the list.
4209 \\[ido-complete] Complete a common suffix to the current string that
4210 matches all files. If there is only one match, select that file.
4211 If there is no common suffix, show a list of all matching files
4212 in a separate window.
4213 \\[ido-magic-delete-char] Open the specified directory in Dired mode.
4214 \\[ido-edit-input] Edit input string (including directory).
4215 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
4216 \\[ido-merge-work-directories] search for file in the work directory history.
4217 \\[ido-forget-work-directory] removes current directory from the work directory history.
4218 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
4219 \\[ido-wide-find-file-or-pop-dir] and \\[ido-wide-find-dir-or-delete-dir] prompts and uses find to locate files or directories.
4220 \\[ido-make-directory] prompts for a directory to create in current directory.
4221 \\[ido-fallback-command] Fallback to non-ido version of current command.
4222 \\[ido-toggle-regexp] Toggle regexp searching.
4223 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
4224 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
4225 \\[ido-toggle-literal] Toggle literal reading of this file.
4226 \\[ido-completion-help] Show list of matching files in separate window.
4227 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
4229 (interactive)
4230 (ido-file-internal ido-default-file-method))
4232 ;;;###autoload
4233 (defun ido-find-file-other-window ()
4234 "Switch to another file and show it in another window.
4235 The file name is selected interactively by typing a substring.
4236 For details of keybindings, see `ido-find-file'."
4237 (interactive)
4238 (ido-file-internal 'other-window 'find-file-other-window))
4240 ;;;###autoload
4241 (defun ido-find-alternate-file ()
4242 "Switch to another file and show it in another window.
4243 The file name is selected interactively by typing a substring.
4244 For details of keybindings, see `ido-find-file'."
4245 (interactive)
4246 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
4248 ;;;###autoload
4249 (defun ido-find-file-read-only ()
4250 "Edit file read-only with name obtained via minibuffer.
4251 The file name is selected interactively by typing a substring.
4252 For details of keybindings, see `ido-find-file'."
4253 (interactive)
4254 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
4256 ;;;###autoload
4257 (defun ido-find-file-read-only-other-window ()
4258 "Edit file read-only in other window with name obtained via minibuffer.
4259 The file name is selected interactively by typing a substring.
4260 For details of keybindings, see `ido-find-file'."
4261 (interactive)
4262 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
4264 ;;;###autoload
4265 (defun ido-find-file-read-only-other-frame ()
4266 "Edit file read-only in other frame with name obtained via minibuffer.
4267 The file name is selected interactively by typing a substring.
4268 For details of keybindings, see `ido-find-file'."
4269 (interactive)
4270 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
4272 ;;;###autoload
4273 (defun ido-display-file ()
4274 "Display a file in another window but don't select it.
4275 The file name is selected interactively by typing a substring.
4276 For details of keybindings, see `ido-find-file'."
4277 (interactive)
4278 (ido-file-internal 'display nil nil nil nil nil 'ignore))
4280 ;;;###autoload
4281 (defun ido-find-file-other-frame ()
4282 "Switch to another file and show it in another frame.
4283 The file name is selected interactively by typing a substring.
4284 For details of keybindings, see `ido-find-file'."
4285 (interactive)
4286 (ido-file-internal 'other-frame 'find-file-other-frame))
4288 ;;;###autoload
4289 (defun ido-write-file ()
4290 "Write current buffer to a file.
4291 The file name is selected interactively by typing a substring.
4292 For details of keybindings, see `ido-find-file'."
4293 (interactive)
4294 (let ((ido-process-ignore-lists t)
4295 (ido-work-directory-match-only nil)
4296 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
4297 (ido-report-no-match nil)
4298 (ido-confirm-unique-completion t)
4299 (ido-auto-merge-work-directories-length -1))
4300 (ido-file-internal 'write 'write-file nil "Write file: " nil nil 'ignore)))
4302 ;;;###autoload
4303 (defun ido-insert-file ()
4304 "Insert contents of file in current buffer.
4305 The file name is selected interactively by typing a substring.
4306 For details of keybindings, see `ido-find-file'."
4307 (interactive)
4308 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil nil 'ido-enter-insert-buffer))
4310 ;;;###autoload
4311 (defun ido-dired ()
4312 "Call `dired' the ido way.
4313 The directory is selected interactively by typing a substring.
4314 For details of keybindings, see `ido-find-file'."
4315 (interactive)
4316 (let ((ido-report-no-match nil)
4317 (ido-auto-merge-work-directories-length -1))
4318 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
4320 (defun ido-list-directory ()
4321 "Call `list-directory' the ido way.
4322 The directory is selected interactively by typing a substring.
4323 For details of keybindings, see `ido-find-file'."
4324 (interactive)
4325 (let ((ido-report-no-match nil)
4326 (ido-auto-merge-work-directories-length -1))
4327 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
4329 ;;; XEmacs hack for showing default buffer
4331 ;; The first time we enter the minibuffer, Emacs puts up the default
4332 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
4333 ;; subtle difference in the two versions of post-command-hook. The
4334 ;; default is shown for both whenever we delete all of our text
4335 ;; though, indicating its just a problem the first time we enter the
4336 ;; function. To solve this, we use another entry hook for emacs to
4337 ;; show the default the first time we enter the minibuffer.
4340 ;;; ICOMPLETE TYPE CODE
4342 (defun ido-initiate-auto-merge (buffer)
4343 (ido-trace "\n*merge timeout*" buffer)
4344 (setq ido-auto-merge-timer nil)
4345 (when (and (buffer-live-p buffer)
4346 (ido-active)
4347 (boundp 'ido-eoinput) ido-eoinput)
4348 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
4349 (ido-trace "request merge")
4350 (setq ido-use-merged-list 'auto
4351 ido-text-init contents
4352 ido-rotate-temp t
4353 ido-exit 'refresh)
4354 (with-current-buffer buffer
4355 (ido-tidy))
4356 (throw 'ido contents))))
4358 (defun ido-exhibit ()
4359 "Post command hook for `ido'."
4360 ;; Find matching files and display a list in the minibuffer.
4361 ;; Copied from `icomplete-exhibit' with two changes:
4362 ;; 1. It prints a default file name when there is no text yet entered.
4363 ;; 2. It calls my completion routine rather than the standard completion.
4365 (when (ido-active)
4366 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
4367 (buffer-undo-list t)
4368 try-single-dir-match
4369 refresh)
4371 (when ido-trace-enable
4372 (ido-trace "\nexhibit" this-command)
4373 (ido-trace "dir" ido-current-directory)
4374 (ido-trace "contents" contents)
4375 (ido-trace "list" ido-cur-list)
4376 (ido-trace "matches" ido-matches)
4377 (ido-trace "rescan" ido-rescan))
4379 (save-excursion
4380 (goto-char (point-max))
4381 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
4382 (unless (boundp 'ido-eoinput)
4383 ;; In case it got wiped out by major mode business:
4384 (make-local-variable 'ido-eoinput))
4385 (setq ido-eoinput (point))
4387 ;; Handle explicit directory changes
4388 (cond
4389 ((memq ido-cur-item '(buffer list))
4392 ((= (length contents) 0)
4395 ((= (length contents) 1)
4396 (cond
4397 ((and (ido-is-tramp-root) (string-equal contents "/"))
4398 (ido-set-current-directory ido-current-directory contents)
4399 (setq refresh t))
4400 ((and (ido-unc-hosts) (string-equal contents "/")
4401 (let ((ido-enable-tramp-completion nil))
4402 (ido-is-root-directory)))
4403 (ido-set-current-directory "//")
4404 (setq refresh t))
4407 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") contents)
4408 (ido-is-root-directory) ;; Ange-ftp or tramp
4409 (not (ido-local-file-exists-p contents)))
4410 (ido-set-current-directory ido-current-directory contents)
4411 (when (ido-is-slow-ftp-host)
4412 (setq ido-exit 'fallback)
4413 (exit-minibuffer))
4414 (setq refresh t))
4416 ((ido-final-slash contents) ;; xxx/
4417 (ido-trace "final slash" contents)
4418 (cond
4419 ((string-equal contents "~/")
4420 (ido-set-current-home)
4421 (setq refresh t))
4422 ((string-equal contents "../")
4423 (ido-up-directory t)
4424 (setq refresh t))
4425 ((string-equal contents "./")
4426 (setq refresh t))
4427 ((string-match "\\`~[-_a-zA-Z0-9]+[$]?/\\'" contents)
4428 (ido-trace "new home" contents)
4429 (ido-set-current-home contents)
4430 (setq refresh t))
4431 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
4432 (let ((exp (condition-case ()
4433 (expand-file-name
4434 (substitute-in-file-name (substring contents 0 -1))
4435 ido-current-directory)
4436 (error nil))))
4437 (ido-trace contents exp)
4438 (when (and exp (file-directory-p exp))
4439 (ido-set-current-directory (file-name-directory exp))
4440 (setq ido-text-init (file-name-nondirectory exp))
4441 (setq refresh t))))
4442 ((and (memq system-type '(windows-nt ms-dos))
4443 (string-equal (substring contents 1) ":/"))
4444 (ido-set-current-directory (file-name-directory contents))
4445 (setq refresh t))
4446 ((string-equal (substring contents -2 -1) "/")
4447 (ido-set-current-directory
4448 (if (memq system-type '(windows-nt ms-dos))
4449 (expand-file-name "/" ido-current-directory)
4450 "/"))
4451 (setq refresh t))
4452 ((and (or ido-directory-nonreadable ido-directory-too-big)
4453 (file-directory-p (concat ido-current-directory (file-name-directory contents))))
4454 (ido-set-current-directory
4455 (concat ido-current-directory (file-name-directory contents)))
4456 (setq refresh t))
4458 (ido-trace "try single dir")
4459 (setq try-single-dir-match t))))
4461 ((and (string-equal (substring contents -2 -1) "/")
4462 (not (string-match "[$]" contents)))
4463 (ido-set-current-directory
4464 (cond
4465 ((= (length contents) 2)
4466 "/")
4467 (ido-matches
4468 (concat ido-current-directory (ido-name (car ido-matches))))
4470 (concat ido-current-directory (substring contents 0 -1)))))
4471 (setq ido-text-init (substring contents -1))
4472 (setq refresh t))
4474 ((and (not ido-use-merged-list)
4475 (not (ido-final-slash contents))
4476 (eq ido-try-merged-list t)
4477 (numberp ido-auto-merge-work-directories-length)
4478 (> ido-auto-merge-work-directories-length 0)
4479 (= (length contents) ido-auto-merge-work-directories-length)
4480 (not (and ido-auto-merge-inhibit-characters-regexp
4481 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4482 (not (input-pending-p)))
4483 (setq ido-use-merged-list 'auto
4484 ido-text-init contents
4485 ido-rotate-temp t)
4486 (setq refresh t))
4488 (t nil))
4490 (when refresh
4491 (ido-trace "refresh on /" ido-text-init)
4492 (setq ido-exit 'refresh)
4493 (exit-minibuffer))
4495 (when (and ido-enter-matching-directory
4496 ido-matches
4497 (or (eq ido-enter-matching-directory 'first)
4498 (null (cdr ido-matches)))
4499 (ido-final-slash (ido-name (car ido-matches)))
4500 (or try-single-dir-match
4501 (eq ido-enter-matching-directory t)))
4502 (ido-trace "single match" (car ido-matches))
4503 (ido-set-current-directory
4504 (concat ido-current-directory (ido-name (car ido-matches))))
4505 (setq ido-exit 'refresh)
4506 (exit-minibuffer))
4508 ;; Update the list of matches
4509 (setq ido-text contents)
4510 (ido-set-matches)
4511 (ido-trace "new " ido-matches)
4513 (when (and (boundp 'ido-enable-virtual-buffers)
4514 (not (eq ido-enable-virtual-buffers 'always))
4515 (eq ido-cur-item 'buffer)
4516 (eq ido-use-virtual-buffers 'auto))
4518 (when (and (not ido-enable-virtual-buffers)
4519 (not ido-matches))
4520 (setq ido-text-init ido-text)
4521 (setq ido-enable-virtual-buffers t)
4522 (setq ido-exit 'refresh)
4523 (exit-minibuffer))
4525 ;; If input matches real buffers turn off virtual buffers.
4526 (when (and ido-enable-virtual-buffers
4527 ido-matches
4528 (ido-set-matches-1 (ido-make-buffer-list-1)))
4529 (setq ido-enable-virtual-buffers nil)
4530 (setq ido-text-init ido-text)
4531 (setq ido-exit 'refresh)
4532 (exit-minibuffer)))
4534 (when (and (not ido-matches)
4535 (not ido-directory-nonreadable)
4536 (not ido-directory-too-big)
4537 ;; ido-rescan ?
4538 ido-process-ignore-lists
4539 ido-ignored-list)
4540 (let ((ido-process-ignore-lists nil)
4541 (ido-rotate ido-rotate)
4542 (ido-cur-list ido-ignored-list))
4543 (ido-trace "try all" ido-ignored-list)
4544 (ido-set-matches))
4545 (when ido-matches
4546 (ido-trace "found " ido-matches)
4547 (setq ido-rescan t)
4548 (setq ido-process-ignore-lists-inhibit t)
4549 (setq ido-text-init ido-text)
4550 (setq ido-exit 'refresh)
4551 (exit-minibuffer)))
4553 (when (and
4554 ido-rescan
4555 (not ido-matches)
4556 (memq ido-cur-item '(file dir))
4557 (not (ido-is-root-directory))
4558 (> (length contents) 1)
4559 (not (string-match "[$]" contents))
4560 (not ido-directory-nonreadable)
4561 (not ido-directory-too-big))
4562 (ido-trace "merge?")
4563 (if ido-use-merged-list
4564 (ido-undo-merge-work-directory contents nil)
4565 (when (and (eq ido-try-merged-list t)
4566 (numberp ido-auto-merge-work-directories-length)
4567 (= ido-auto-merge-work-directories-length 0)
4568 (not (and ido-auto-merge-inhibit-characters-regexp
4569 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4570 (not (input-pending-p)))
4571 (ido-trace "\n*start timer*")
4572 (setq ido-auto-merge-timer
4573 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
4575 (setq ido-rescan t)
4577 (if (and ido-use-merged-list
4578 ido-matches
4579 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
4580 (progn
4581 (ido-set-current-directory (car (cdr (car ido-matches))))
4582 (setq ido-use-merged-list t
4583 ido-exit 'keep
4584 ido-text-init ido-text)
4585 (exit-minibuffer)))
4587 ;; Insert the match-status information:
4588 (ido-set-common-completion)
4589 (let ((inf (ido-completions contents)))
4590 (setq ido-show-confirm-message nil)
4591 (ido-trace "inf" inf)
4592 (insert inf))
4593 ))))
4595 (defun ido-completions (name)
4596 "Return the string that is displayed after the user's text.
4597 Modified from `icomplete-completions'."
4598 (let* ((comps ido-matches)
4599 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
4600 ido-merged-indicator))
4601 first)
4603 (if (and ind ido-use-faces)
4604 (put-text-property 0 1 'face 'ido-indicator ind))
4606 (if (and ido-use-faces comps)
4607 (let* ((fn (ido-name (car comps)))
4608 (ln (length fn)))
4609 (setq first (format "%s" fn))
4610 (put-text-property 0 ln 'face
4611 (if (= (length comps) 1)
4612 (if ido-incomplete-regexp
4613 'ido-incomplete-regexp
4614 'ido-only-match)
4615 'ido-first-match)
4616 first)
4617 (if ind (setq first (concat first ind)))
4618 (setq comps (cons first (cdr comps)))))
4620 (cond ((null comps)
4621 (cond
4622 (ido-show-confirm-message
4623 (or (nth 10 ido-decorations) " [Confirm]"))
4624 (ido-directory-nonreadable
4625 (or (nth 8 ido-decorations) " [Not readable]"))
4626 (ido-directory-too-big
4627 (or (nth 9 ido-decorations) " [Too big]"))
4628 (ido-report-no-match
4629 (nth 6 ido-decorations)) ;; [No match]
4630 (t "")))
4631 (ido-incomplete-regexp
4632 (concat " " (car comps)))
4633 ((null (cdr comps)) ;one match
4634 (concat (if (if (not ido-enable-regexp)
4635 (= (length (ido-name (car comps))) (length name))
4636 ;; We can't rely on the length of the input
4637 ;; for regexps, so explicitly check for a
4638 ;; complete match
4639 (string-match name (ido-name (car comps)))
4640 (string-equal (match-string 0 (ido-name (car comps)))
4641 (ido-name (car comps))))
4643 ;; When there is only one match, show the matching file
4644 ;; name in full, wrapped in [ ... ].
4645 (concat
4646 (or (nth 11 ido-decorations) (nth 4 ido-decorations))
4647 (ido-name (car comps))
4648 (or (nth 12 ido-decorations) (nth 5 ido-decorations))))
4649 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
4650 (t ;multiple matches
4651 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
4652 (alternatives
4653 (apply
4654 #'concat
4655 (cdr (apply
4656 #'nconc
4657 (mapcar
4658 (lambda (com)
4659 (setq com (ido-name com))
4660 (setq items (1- items))
4661 (cond
4662 ((< items 0) ())
4663 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
4665 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
4666 (let ((str (substring com 0)))
4667 (if (and ido-use-faces
4668 (not (string= str first))
4669 (ido-final-slash str))
4670 (put-text-property 0 (length str) 'face 'ido-subdir str))
4671 str)))))
4672 comps))))))
4674 (concat
4675 ;; put in common completion item -- what you get by pressing tab
4676 (if (and (stringp ido-common-match-string)
4677 (> (length ido-common-match-string) (length name)))
4678 (concat (nth 4 ido-decorations) ;; [ ... ]
4679 (substring ido-common-match-string (length name))
4680 (nth 5 ido-decorations)))
4681 ;; list all alternatives
4682 (nth 0 ido-decorations) ;; { ... }
4683 alternatives
4684 (nth 1 ido-decorations)))))))
4686 (defun ido-minibuffer-setup ()
4687 "Minibuffer setup hook for `ido'."
4688 ;; Copied from `icomplete-minibuffer-setup-hook'.
4689 (when (ido-active)
4690 (add-hook 'pre-command-hook 'ido-tidy nil t)
4691 (add-hook 'post-command-hook 'ido-exhibit nil t)
4692 (when (featurep 'xemacs)
4693 (ido-exhibit)
4694 (goto-char (point-min)))
4695 (run-hooks 'ido-minibuffer-setup-hook)
4696 (when ido-initial-position
4697 (goto-char (+ (minibuffer-prompt-end) ido-initial-position))
4698 (setq ido-initial-position nil))))
4700 (defun ido-tidy ()
4701 "Pre command hook for `ido'."
4702 ;; Remove completions display, if any, prior to new user input.
4703 ;; Copied from `icomplete-tidy'."
4705 (when ido-auto-merge-timer
4706 (ido-trace "\n*cancel timer*" this-command)
4707 (cancel-timer ido-auto-merge-timer)
4708 (setq ido-auto-merge-timer nil))
4710 (when (ido-active)
4711 (if (bound-and-true-p ido-eoinput)
4712 (if (> ido-eoinput (point-max))
4713 ;; Oops, got rug pulled out from under us - reinit:
4714 (setq ido-eoinput (point-max))
4715 (let ((inhibit-read-only t)
4716 (buffer-undo-list t))
4717 (delete-region ido-eoinput (point-max))))
4719 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
4720 (make-local-variable 'ido-eoinput)
4721 (setq ido-eoinput 1))))
4723 (defun ido-summary-buffers-to-end ()
4724 ;; Move the summaries to the end of the buffer list.
4725 ;; This is an example function which can be hooked on to
4726 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
4727 ;; `Summary' or `output\*$'are put to the end of the list.
4728 (let ((summaries (delq nil (mapcar
4729 (lambda (x)
4730 (if (or
4731 (string-match "Summary" x)
4732 (string-match "output\\*\\'" x))
4734 ido-temp-list))))
4735 (ido-to-end summaries)))
4737 ;;; Helper functions for other programs
4739 (put 'ibuffer-find-file 'ido 'find-file)
4740 (put 'dired 'ido 'dir)
4741 (put 'dired-other-window 'ido 'dir)
4742 (put 'dired-other-frame 'ido 'dir)
4743 ;; See http://debbugs.gnu.org/11954 for reasons.
4744 (put 'dired-do-copy 'ido 'ignore)
4745 (put 'dired-do-rename 'ido 'ignore)
4747 ;;;###autoload
4748 (defun ido-read-buffer (prompt &optional default require-match)
4749 "Ido replacement for the built-in `read-buffer'.
4750 Return the name of a buffer selected.
4751 PROMPT is the prompt to give to the user. DEFAULT if given is the default
4752 buffer to be selected, which will go to the front of the list.
4753 If REQUIRE-MATCH is non-nil, an existing buffer must be selected."
4754 (let* ((ido-current-directory nil)
4755 (ido-directory-nonreadable nil)
4756 (ido-directory-too-big nil)
4757 (ido-context-switch-command 'ignore)
4758 (buf (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match)))
4759 (if (eq ido-exit 'fallback)
4760 (let ((read-buffer-function nil))
4761 (run-hook-with-args 'ido-before-fallback-functions 'read-buffer)
4762 (read-buffer prompt default require-match))
4763 buf)))
4765 ;;;###autoload
4766 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
4767 "Ido replacement for the built-in `read-file-name'.
4768 Read file name, prompting with PROMPT and completing in directory DIR.
4769 See `read-file-name' for additional parameters."
4770 (let (filename)
4771 (cond
4772 ((or (eq predicate 'file-directory-p)
4773 (eq (and (symbolp this-command)
4774 (get this-command 'ido)) 'dir)
4775 (memq this-command ido-read-file-name-as-directory-commands))
4776 (setq filename
4777 (ido-read-directory-name prompt dir default-filename mustmatch initial)))
4778 ((and (not (eq (and (symbolp this-command)
4779 (get this-command 'ido)) 'ignore))
4780 (not (memq this-command ido-read-file-name-non-ido))
4781 (or (null predicate) (eq predicate 'file-exists-p)))
4782 (let* (ido-saved-vc-hb
4783 (ido-context-switch-command
4784 (if (eq (and (symbolp this-command)
4785 (get this-command 'ido)) 'find-file)
4786 nil 'ignore))
4787 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
4788 (minibuffer-completing-file-name t)
4789 (ido-current-directory (ido-expand-directory dir))
4790 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4791 (ido-directory-too-big (and (not ido-directory-nonreadable)
4792 (ido-directory-too-big-p ido-current-directory)))
4793 (ido-work-directory-index -1)
4794 (ido-show-dot-for-dired (and ido-show-dot-for-dired
4795 (not default-filename)))
4796 (ido-work-file-index -1)
4797 (ido-find-literal nil))
4798 (setq ido-exit nil)
4799 (setq filename
4800 (ido-read-internal 'file prompt 'ido-file-history
4801 (cond ; Bug#11861.
4802 ((stringp default-filename) default-filename)
4803 ((consp default-filename) (car default-filename))
4804 ((and (not default-filename) initial)
4805 (expand-file-name initial dir))
4806 (buffer-file-name buffer-file-name))
4807 mustmatch initial))
4808 (setq dir ido-current-directory) ; See bug#1516.
4809 (cond
4810 ((eq ido-exit 'fallback)
4811 (setq filename 'fallback))
4812 ((eq ido-exit 'dired)
4813 (setq filename ido-current-directory))
4814 (filename
4815 (setq filename
4816 (concat ido-current-directory filename))))))
4818 (setq filename 'fallback)))
4819 (if (eq filename 'fallback)
4820 (let ((read-file-name-function nil))
4821 (run-hook-with-args 'ido-before-fallback-functions 'read-file-name)
4822 (read-file-name prompt dir default-filename mustmatch initial predicate))
4823 filename)))
4825 ;;;###autoload
4826 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
4827 "Ido replacement for the built-in `read-directory-name'.
4828 Read directory name, prompting with PROMPT and completing in directory DIR.
4829 See `read-directory-name' for additional parameters."
4830 (let* (filename
4831 (minibuffer-completing-file-name t)
4832 (ido-context-switch-command 'ignore)
4833 ido-saved-vc-hb
4834 (ido-current-directory (ido-expand-directory dir))
4835 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4836 (ido-directory-too-big (and (not ido-directory-nonreadable)
4837 (ido-directory-too-big-p ido-current-directory)))
4838 (ido-work-directory-index -1)
4839 (ido-work-file-index -1))
4840 (setq filename (ido-read-internal
4841 'dir prompt 'ido-file-history
4842 (or default-dirname ; Bug#11861.
4843 (if initial
4844 (expand-file-name initial ido-current-directory)
4845 ido-current-directory))
4846 mustmatch initial))
4847 (cond
4848 ((eq ido-exit 'fallback)
4849 (let ((read-file-name-function nil))
4850 (run-hook-with-args 'ido-before-fallback-functions 'read-directory-name)
4851 (read-directory-name prompt ido-current-directory
4852 default-dirname mustmatch initial)))
4853 ((equal filename ".") ido-current-directory)
4854 (t (concat ido-current-directory filename)))))
4856 ;;;###autoload
4857 (defun ido-completing-read (prompt choices &optional _predicate require-match
4858 initial-input hist def _inherit-input-method)
4859 "Ido replacement for the built-in `completing-read'.
4860 Read a string in the minibuffer with ido-style completion.
4861 PROMPT is a string to prompt with; normally it ends in a colon and a space.
4862 CHOICES is a list of strings which are the possible completions.
4863 PREDICATE and INHERIT-INPUT-METHOD is currently ignored; it is included
4864 to be compatible with `completing-read'.
4865 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
4866 the input is (or completes to) an element of CHOICES or is null.
4867 If the input is null, `ido-completing-read' returns DEF, or an empty
4868 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
4869 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
4870 with point positioned at the end.
4871 HIST, if non-nil, specifies a history list.
4872 DEF, if non-nil, is the default value."
4873 (let ((ido-current-directory nil)
4874 (ido-directory-nonreadable nil)
4875 (ido-directory-too-big nil)
4876 (ido-context-switch-command 'ignore)
4877 (ido-choice-list choices))
4878 ;; Initialize ido before invoking ido-read-internal
4879 (ido-common-initialization)
4880 (ido-read-internal 'list prompt hist def require-match initial-input)))
4882 (defun ido-unload-function ()
4883 "Unload the Ido library."
4884 (ido-mode -1)
4885 (setq minor-mode-map-alist (assq-delete-all 'ido-mode minor-mode-map-alist))
4886 ;; continue standard unloading
4887 nil)
4889 (provide 'ido)
4891 ;;; ido.el ends here