* dirtrack.el (dirtrack): Support shell buffers with path
[emacs.git] / lisp / ido.el
blob0844c2c50c6b9e31a9b6723a612a9fa8dc874264
1 ;;; ido.el --- interactively do things with buffers and files
3 ;; Copyright (C) 1996-2011 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 ;; Colouring 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 ;;; Acknowledgements
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 ackward 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 (and (numberp n) (> n 0.0) (<= n 1.0)))
333 (defgroup ido nil
334 "Switch between files using substrings."
335 :group 'extensions
336 :group 'convenience
337 :version "22.1"
338 :link '(emacs-commentary-link :tag "Commentary" "ido.el")
339 :link '(emacs-library-link :tag "Lisp File" "ido.el"))
341 ;;;###autoload
342 (defcustom ido-mode nil
343 "Determines for which functional group \(buffer and files) ido behavior
344 should be enabled. The following values are possible:
345 - `buffer': Turn only on ido buffer behavior \(switching, killing,
346 displaying...)
347 - `file': Turn only on ido file behavior \(finding, writing, inserting...)
348 - `both': Turn on ido buffer and file behavior.
349 - `nil': Turn off any ido switching.
351 Setting this variable directly does not take effect;
352 use either \\[customize] or the function `ido-mode'."
353 :set #'(lambda (_symbol value)
354 (ido-mode value))
355 :initialize 'custom-initialize-default
356 :require 'ido
357 :link '(emacs-commentary-link "ido.el")
358 :set-after '(ido-save-directory-list-file
359 ;; This will clear ido-unc-hosts-cache, so set it
360 ;; before loading history file.
361 ido-unc-hosts)
362 :type '(choice (const :tag "Turn on only buffer" buffer)
363 (const :tag "Turn on only file" file)
364 (const :tag "Turn on both buffer and file" both)
365 (const :tag "Switch off all" nil))
366 :group 'ido)
368 (defcustom ido-case-fold case-fold-search
369 "Non-nil if searching of buffer and file names should ignore case."
370 :type 'boolean
371 :group 'ido)
373 (defcustom ido-ignore-buffers
374 '("\\` ")
375 "List of regexps or functions matching buffer names to ignore.
376 For example, traditional behavior is not to list buffers whose names begin
377 with a space, for which the regexp is `\\` '. See the source file for
378 example functions that filter buffer names."
379 :type '(repeat (choice regexp function))
380 :group 'ido)
382 (defcustom ido-ignore-files
383 '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
384 "List of regexps or functions matching file names to ignore.
385 For example, traditional behavior is not to list files whose names begin
386 with a #, for which the regexp is `\\`#'. See the source file for
387 example functions that filter filenames."
388 :type '(repeat (choice regexp function))
389 :group 'ido)
391 (defcustom ido-ignore-extensions t
392 "Non-nil means ignore files in `completion-ignored-extensions' list."
393 :type 'boolean
394 :group 'ido)
396 (defcustom ido-show-dot-for-dired nil
397 "Non-nil means to always put . as the first item in file name lists.
398 This allows the current directory to be opened immediately with `dired'."
399 :type 'boolean
400 :group 'ido)
402 (defcustom ido-file-extensions-order nil
403 "List of file extensions specifying preferred order of file selections.
404 Each element is either a string with `.' as the first char, an empty
405 string matching files without extension, or t which is the default order
406 for files with an unlisted file extension."
407 :type '(repeat (choice string
408 (const :tag "Default order" t)))
409 :group 'ido)
411 (defcustom ido-ignore-directories
412 '("\\`CVS/" "\\`\\.\\./" "\\`\\./")
413 "List of regexps or functions matching sub-directory names to ignore."
414 :type '(repeat (choice regexp function))
415 :group 'ido)
417 (defcustom ido-ignore-directories-merge nil
418 "List of regexps or functions matching directory names to ignore during merge.
419 Directory names matched by one of the regexps in this list are not inserted
420 in merged file and directory lists."
421 :type '(repeat (choice regexp function))
422 :group 'ido)
424 ;; Examples for setting the value of ido-ignore-buffers
425 ;;(defun ido-ignore-c-mode (name)
426 ;; "Ignore all c mode buffers -- example function for ido."
427 ;; (with-current-buffer name
428 ;; (derived-mode-p 'c-mode)))
430 ;;(setq ido-ignore-buffers '("^ " ido-ignore-c-mode))
432 ;; Examples for setting the value of ido-ignore-files
433 ;;(setq ido-ignore-files '("^ " "\\.c\\'" "\\.h\\'"))
435 (defcustom ido-default-file-method 'raise-frame
436 "How to visit a new file when using `ido-find-file'.
437 Possible values:
438 `selected-window' Show new file in selected window
439 `other-window' Show new file in another window (same frame)
440 `display' Display file in another window without selecting to it
441 `other-frame' Show new file in another frame
442 `maybe-frame' If a file is visible in another frame, prompt to ask if you
443 you want to see the file in the same window of the current
444 frame or in the other frame
445 `raise-frame' If a file is visible in another frame, raise that
446 frame; otherwise, visit the file in the same window"
447 :type '(choice (const :tag "Visit in selected window" selected-window)
448 (const :tag "Visit in other window" other-window)
449 (const :tag "Display (no select) in other window" display)
450 (const :tag "Visit in other frame" other-frame)
451 (const :tag "Ask to visit in other frame" maybe-frame)
452 (const :tag "Raise frame if already visited" raise-frame))
453 :group 'ido)
455 (defcustom ido-default-buffer-method 'raise-frame
456 "How to switch to new buffer when using `ido-switch-buffer'.
457 See `ido-default-file-method' for details."
458 :type '(choice (const :tag "Show in selected window" selected-window)
459 (const :tag "Show in other window" other-window)
460 (const :tag "Display (no select) in other window" display)
461 (const :tag "Show in other frame" other-frame)
462 (const :tag "Ask to show in other frame" maybe-frame)
463 (const :tag "Raise frame if already shown" raise-frame))
464 :group 'ido)
466 (defcustom ido-enable-flex-matching nil
467 "Non-nil means that `ido' will do flexible string matching.
468 Flexible matching means that if the entered string does not
469 match any item, any item containing the entered characters
470 in the given sequence will match."
471 :type 'boolean
472 :group 'ido)
475 (defcustom ido-enable-regexp nil
476 "Non-nil means that `ido' will do regexp matching.
477 Value can be toggled within `ido' using `ido-toggle-regexp'."
478 :type 'boolean
479 :group 'ido)
481 (defcustom ido-enable-prefix nil
482 "Non-nil means only match if the entered text is a prefix of file name.
483 This behavior is like the standard Emacs completion.
484 If nil, match if the entered text is an arbitrary substring.
485 Value can be toggled within `ido' using `ido-toggle-prefix'."
486 :type 'boolean
487 :group 'ido)
489 (defcustom ido-enable-dot-prefix nil
490 "Non-nil means to match leading dot as prefix.
491 I.e. hidden files and buffers will match only if you type a dot
492 as first char even if `ido-enable-prefix' is nil."
493 :type 'boolean
494 :group 'ido)
496 (defcustom ido-confirm-unique-completion nil
497 "Non-nil means that even a unique completion must be confirmed.
498 This means that \\[ido-complete] must always be followed by \\[ido-exit-minibuffer]
499 even when there is only one unique completion."
500 :type 'boolean
501 :group 'ido)
503 (defcustom ido-cannot-complete-command 'ido-completion-help
504 "Command run when `ido-complete' can't complete any more.
505 The most useful values are `ido-completion-help', which pops up a
506 window with completion alternatives, or `ido-next-match' or
507 `ido-prev-match', which cycle the buffer list."
508 :type 'function
509 :group 'ido)
512 (defcustom ido-record-commands t
513 "Non-nil means that `ido' will record commands in command history.
514 Note that the non-ido equivalent command is recorded."
515 :type 'boolean
516 :group 'ido)
518 (defcustom ido-max-prospects 12
519 "Non-zero means that the prospect list will be limited to that number of items.
520 For a long list of prospects, building the full list for the minibuffer can take a
521 non-negligible amount of time; setting this variable reduces that time."
522 :type 'integer
523 :group 'ido)
525 (defcustom ido-max-file-prompt-width 0.35
526 "Non-zero means that the prompt string be limited to that number of characters.
527 If value is a floating point number, it specifies a fraction of the frame width."
528 :type '(choice
529 (integer :tag "Characters" :value 20)
530 (restricted-sexp :tag "Fraction of frame width"
531 :value 0.35
532 :match-alternatives (ido-fractionp)))
533 :group 'ido)
535 (defcustom ido-max-window-height nil
536 "Non-nil specifies a value to override `max-mini-window-height'."
537 :type '(choice
538 (const :tag "Don't override" nil)
539 (integer :tag "Number of lines" :value 1)
540 (restricted-sexp
541 :tag "Fraction of window height"
542 :value 0.25
543 :match-alternatives (ido-fractionp)))
544 :group 'ido)
546 (defcustom ido-enable-last-directory-history t
547 "Non-nil means that `ido' will remember latest selected directory names.
548 See `ido-last-directory-list' and `ido-save-directory-list-file'."
549 :type 'boolean
550 :group 'ido)
552 (defcustom ido-max-work-directory-list 50
553 "Maximum number of working directories to record.
554 This is the list of directories where files have most recently been opened.
555 See `ido-work-directory-list' and `ido-save-directory-list-file'."
556 :type 'integer
557 :group 'ido)
559 (defcustom ido-work-directory-list-ignore-regexps nil
560 "List of regexps matching directories which should not be recorded.
561 Directory names matched by one of the regexps in this list are not inserted in
562 the `ido-work-directory-list' list."
563 :type '(repeat regexp)
564 :group 'ido)
567 (defcustom ido-use-filename-at-point nil
568 "Non-nil means that ido shall look for a filename at point.
569 May use `ffap-guesser' to guess whether text at point is a filename.
570 If found, use that as the starting point for filename selection."
571 :type '(choice
572 (const :tag "Disabled" nil)
573 (const :tag "Guess filename" guess)
574 (other :tag "Use literal filename" t))
575 :group 'ido)
578 (defcustom ido-use-url-at-point nil
579 "Non-nil means that ido shall look for a URL at point.
580 If found, call `find-file-at-point' to visit it."
581 :type 'boolean
582 :group 'ido)
585 (defcustom ido-enable-tramp-completion t
586 "Non-nil means that ido shall perform tramp method and server name completion.
587 A tramp file name uses the following syntax: /method:user@host:filename."
588 :type 'boolean
589 :group 'ido)
591 (defcustom ido-record-ftp-work-directories t
592 "Non-nil means record ftp file names in the work directory list."
593 :type 'boolean
594 :group 'ido)
596 (defcustom ido-merge-ftp-work-directories nil
597 "If nil, merging ignores ftp file names in the work directory list."
598 :type 'boolean
599 :group 'ido)
601 (defcustom ido-cache-ftp-work-directory-time 1.0
602 "Maximum time to cache contents of an ftp directory (in hours).
603 Use C-l in prompt to refresh list.
604 If zero, ftp directories are not cached."
605 :type 'number
606 :group 'ido)
608 (defcustom ido-slow-ftp-hosts nil
609 "List of slow ftp hosts where ido prompting should not be used.
610 If an ftp host is on this list, ido automatically switches to the non-ido
611 equivalent function, e.g. `find-file' rather than `ido-find-file'."
612 :type '(repeat string)
613 :group 'ido)
615 (defcustom ido-slow-ftp-host-regexps nil
616 "List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
617 :type '(repeat regexp)
618 :group 'ido)
620 (defvar ido-unc-hosts-cache t
621 "Cached value from `ido-unc-hosts' function.")
623 (defcustom ido-unc-hosts nil
624 "List of known UNC host names to complete after initial //.
625 If value is a function, that function is called to search network for
626 hosts on first use of UNC path."
627 :type '(choice (repeat :tag "List of UNC host names" string)
628 (function-item :tag "Use `NET VIEW'"
629 :value ido-unc-hosts-net-view)
630 (function :tag "Your own function"))
631 :set #'(lambda (symbol value)
632 (set symbol value)
633 (setq ido-unc-hosts-cache t))
634 :group 'ido)
636 (defcustom ido-downcase-unc-hosts t
637 "Non-nil if UNC host names should be downcased."
638 :type 'boolean
639 :group 'ido)
641 (defcustom ido-ignore-unc-host-regexps nil
642 "List of regexps matching UNC hosts to ignore.
643 Case is ignored if `ido-downcase-unc-hosts' is set."
644 :type '(repeat regexp)
645 :group 'ido)
647 (defcustom ido-cache-unc-host-shares-time 8.0
648 "Maximum time to cache shares of an UNC host (in hours).
649 Use C-l in prompt to refresh list.
650 If zero, UNC host shares are not cached."
651 :type 'number
652 :group 'ido)
654 (defcustom ido-max-work-file-list 10
655 "Maximum number of names of recently opened files to record.
656 This is the list of the file names (sans directory) which have most recently
657 been opened. See `ido-work-file-list' and `ido-save-directory-list-file'."
658 :type 'integer
659 :group 'ido)
661 (defcustom ido-work-directory-match-only t
662 "Non-nil means to skip non-matching directories in the directory history.
663 When some text is already entered at the `ido-find-file' prompt, using
664 \\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories
665 without any matching entries."
666 :type 'boolean
667 :group 'ido)
669 (defcustom ido-auto-merge-work-directories-length 0
670 "Automatically switch to merged work directories during file name input.
671 The value is number of characters to type before switching to merged mode.
672 If zero, the switch happens when no matches are found in the current directory.
673 Automatic merging is disabled if the value is negative."
674 :type 'integer
675 :group 'ido)
677 (defcustom ido-auto-merge-delay-time 0.70
678 "Delay in seconds to wait for more input before doing auto merge."
679 :type 'number
680 :group 'ido)
682 (defcustom ido-auto-merge-inhibit-characters-regexp "[][*?~]"
683 "Regexp matching characters which should inhibit automatic merging.
684 When a (partial) file name matches this regexp, merging is inhibited."
685 :type 'regexp
686 :group 'ido)
688 (defcustom ido-merged-indicator "^"
689 "The string appended to first choice if it has multiple directory choices."
690 :type 'string
691 :group 'ido)
693 (defcustom ido-max-dir-file-cache 100
694 "Maximum number of working directories to be cached.
695 This is the size of the cache of `file-name-all-completions' results.
696 Each cache entry is time stamped with the modification time of the
697 directory. Some systems, like Windows, have unreliable directory
698 modification times, so you may choose to disable caching on such
699 systems, or explicitly refresh the cache contents using the command
700 `ido-reread-directory' command (C-l) in the minibuffer.
701 See also `ido-dir-file-cache' and `ido-save-directory-list-file'."
702 :type 'integer
703 :group 'ido)
705 (defcustom ido-max-directory-size 30000
706 "Maximum size (in bytes) for directories to use ido completion.
707 If you enter a directory with a size larger than this size, ido will
708 not provide the normal completion. To show the completions, use C-a."
709 :type '(choice (const :tag "No limit" nil)
710 (integer :tag "Size in bytes" 30000))
711 :group 'ido)
713 (defcustom ido-rotate-file-list-default nil
714 "Non-nil means that `ido' will always rotate file list to get default in front."
715 :type 'boolean
716 :group 'ido)
718 (defcustom ido-enter-matching-directory 'only
719 "Additional methods to enter sub-directory of first/only matching item.
720 If value is 'first, enter first matching sub-directory when typing a slash.
721 If value is 'only, typing a slash only enters the sub-directory if it is
722 the only matching item.
723 If value is t, automatically enter a sub-directory when it is the only
724 matching item, even without typing a slash."
725 :type '(choice (const :tag "Never" nil)
726 (const :tag "Slash enters first directory" first)
727 (const :tag "Slash enters first and only directory" only)
728 (other :tag "Always enter unique directory" t))
729 :group 'ido)
731 (defcustom ido-create-new-buffer 'prompt
732 "Specify whether a new buffer is created if no buffer matches substring.
733 Choices are 'always to create new buffers unconditionally, 'prompt to
734 ask user whether to create buffer, or 'never to never create new buffer."
735 :type '(choice (const always)
736 (const prompt)
737 (const never))
738 :group 'ido)
740 (defcustom ido-setup-hook nil
741 "Hook run after the ido variables and keymap have been setup.
742 The dynamic variable `ido-cur-item' contains the current type of item that
743 is read by ido; possible values are file, dir, buffer, and list.
744 Additional keys can be defined in `ido-completion-map'."
745 :type 'hook
746 :group 'ido)
748 (defcustom ido-separator nil
749 "String used by ido to separate the alternatives in the minibuffer.
750 Obsolete. Set 3rd element of `ido-decorations' instead."
751 :type '(choice string (const nil))
752 :group 'ido)
754 (defcustom ido-decorations '( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]" " [Not readable]" " [Too big]" " [Confirm]")
755 "List of strings used by ido to display the alternatives in the minibuffer.
756 There are 11 elements in this list:
757 1st and 2nd elements are used as brackets around the prospect list,
758 3rd element is the separator between prospects (ignored if `ido-separator' is set),
759 4th element is the string inserted at the end of a truncated list of prospects,
760 5th and 6th elements are used as brackets around the common match string which
761 can be completed using TAB,
762 7th element is the string displayed when there are no matches, and
763 8th element is displayed if there is a single match (and faces are not used),
764 9th element is displayed when the current directory is non-readable,
765 10th element is displayed when directory exceeds `ido-max-directory-size',
766 11th element is displayed to confirm creating new file or buffer."
767 :type '(repeat string)
768 :group 'ido)
770 (defcustom ido-use-virtual-buffers nil
771 "If non-nil, refer to past buffers as well as existing ones.
772 Essentially it works as follows: Say you are visiting a file and
773 the buffer gets cleaned up by mignight.el. Later, you want to
774 switch to that buffer, but find it's no longer open. With
775 virtual buffers enabled, the buffer name stays in the buffer
776 list (using the `ido-virtual' face, and always at the end), and if
777 you select it, it opens the file back up again. This allows you
778 to think less about whether recently opened files are still open
779 or not. Most of the time you can quit Emacs, restart, and then
780 switch to a file buffer that was previously open as if it still
781 were.
782 This feature relies upon the `recentf' package, which will be
783 enabled if this variable is configured to a non-nil value."
784 :version "24.1"
785 :type 'boolean
786 :group 'ido)
788 (defcustom ido-use-faces t
789 "Non-nil means use ido faces to highlighting first match, only match and
790 subdirs in the alternatives."
791 :type 'boolean
792 :group 'ido)
794 (defface ido-first-match '((t (:bold t)))
795 "Face used by ido for highlighting first match."
796 :group 'ido)
798 (defface ido-only-match '((((class color))
799 (:foreground "ForestGreen"))
800 (t (:italic t)))
801 "Face used by ido for highlighting only match."
802 :group 'ido)
804 (defface ido-subdir '((((min-colors 88) (class color))
805 (:foreground "red1"))
806 (((class color))
807 (:foreground "red"))
808 (t (:underline t)))
809 "Face used by ido for highlighting subdirs in the alternatives."
810 :group 'ido)
812 (defface ido-virtual '((t (:inherit font-lock-builtin-face)))
813 "Face used by ido for matching virtual buffer names."
814 :version "24.1"
815 :group 'ido)
817 (defface ido-indicator '((((min-colors 88) (class color))
818 (:foreground "yellow1"
819 :background "red1"
820 :width condensed))
821 (((class color))
822 (:foreground "yellow"
823 :background "red"
824 :width condensed))
825 (t (:inverse-video t)))
826 "Face used by ido for highlighting its indicators."
827 :group 'ido)
829 (defface ido-incomplete-regexp
830 '((t
831 (:inherit font-lock-warning-face)))
832 "Ido face for indicating incomplete regexps."
833 :group 'ido)
835 (defcustom ido-make-file-list-hook nil
836 "List of functions to run when the list of matching files is created.
837 Each function on the list may modify the dynamically bound variable
838 `ido-temp-list' which contains the current list of matching files."
839 :type 'hook
840 :group 'ido)
842 (defcustom ido-make-dir-list-hook nil
843 "List of functions to run when the list of matching directories is created.
844 Each function on the list may modify the dynamically bound variable
845 `ido-temp-list' which contains the current list of matching directories."
846 :type 'hook
847 :group 'ido)
849 (defcustom ido-make-buffer-list-hook nil
850 "List of functions to run when the list of matching buffers is created.
851 Each function on the list may modify the dynamically bound variable
852 `ido-temp-list' which contains the current list of matching buffer names."
853 :type 'hook
854 :group 'ido)
856 (defcustom ido-rewrite-file-prompt-functions nil
857 "List of functions to run when the find-file prompt is created.
858 Each function on the list may modify the following dynamically bound
859 variables:
860 dirname - the (abbreviated) directory name
861 to be modified by the hook functions
862 max-width - the max width of the resulting dirname; nil means no limit
863 prompt - the basic prompt (e.g. \"Find File: \")
864 literal - the string shown if doing \"literal\" find; set to nil to omit
865 vc-off - the string shown if version control is inhibited; set to nil to omit
866 prefix - either nil or a fixed prefix for the dirname
868 The following variables are available, but should not be changed:
869 `ido-current-directory' - the unabbreviated directory name
870 item - equals `file' or `dir' depending on the current mode."
871 :type 'hook
872 :group 'ido)
874 (defvar ido-rewrite-file-prompt-rules nil
875 "*Alist of rewriting rules for directory names in ido prompts.
876 A list of elements of the form (FROM . TO) or (FROM . FUNC), each
877 meaning to rewrite the directory name if matched by FROM by either
878 substituting the matched string by TO or calling the function FUNC
879 with the current directory name as its only argument and using the
880 return value as the new directory name. In addition, each FUNC may
881 also modify the dynamic variables described for the variable
882 `ido-rewrite-file-prompt-functions'.")
884 (defcustom ido-completion-buffer "*Ido Completions*"
885 "Name of completion buffer used by ido.
886 Set to nil to disable completion buffers popping up."
887 :type 'string
888 :group 'ido)
890 (defcustom ido-completion-buffer-all-completions nil
891 "Non-nil means to show all completions in completion buffer.
892 Otherwise, only the current list of matches is shown."
893 :type 'boolean
894 :group 'ido)
896 (defvar ido-all-frames 'visible
897 "*Argument to pass to `walk-windows' when finding visible files.
898 See documentation of `walk-windows' for useful values.")
900 (defcustom ido-minibuffer-setup-hook nil
901 "Ido-specific customization of minibuffer setup.
903 This hook is run during minibuffer setup if `ido' is active.
904 It is intended for use in customizing ido for interoperation
905 with other packages. For instance:
907 \(add-hook 'ido-minibuffer-setup-hook
908 \(function
909 \(lambda ()
910 \(make-local-variable 'max-mini-window-height)
911 \(setq max-mini-window-height 3))))
913 will constrain Emacs to a maximum minibuffer height of 3 lines when
914 ido is running. Copied from `icomplete-minibuffer-setup-hook'."
915 :type 'hook
916 :group 'ido)
918 (defcustom ido-save-directory-list-file (convert-standard-filename "~/.ido.last")
919 "File in which the ido state is saved between invocations.
920 Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
921 `ido-work-file-list', and `ido-dir-file-cache'.
922 Must be set before enabling ido mode."
923 :type 'string
924 :group 'ido)
926 (defcustom ido-read-file-name-as-directory-commands '()
927 "List of commands which uses `read-file-name' to read a directory name.
928 When `ido-everywhere' is non-nil, the commands in this list will read
929 the directory using `ido-read-directory-name'."
930 :type '(repeat symbol)
931 :group 'ido)
933 (defcustom ido-read-file-name-non-ido '()
934 "List of commands which shall not read file names the ido way.
935 When `ido-everywhere' is non-nil, the commands in this list will read
936 the file name using normal `read-file-name' style."
937 :type '(repeat symbol)
938 :group 'ido)
940 (defcustom ido-before-fallback-functions '()
941 "List of functions to call before calling a fallback command.
942 The fallback command is passed as an argument to the functions."
943 :type 'hook
944 :group 'ido)
946 ;;; Internal Variables
948 ;; Persistent variables
950 (defvar ido-completion-map nil
951 "Currently active keymap for ido commands.")
953 (defvar ido-common-completion-map nil
954 "Keymap for all ido commands.")
956 (defvar ido-file-completion-map nil
957 "Keymap for ido file commands.")
959 (defvar ido-file-dir-completion-map nil
960 "Keymap for ido file and directory commands.")
962 (defvar ido-buffer-completion-map nil
963 "Keymap for ido buffer commands.")
965 (defvar ido-file-history nil
966 "History of files selected using `ido-find-file'.")
968 (defvar ido-buffer-history nil
969 "History of buffers selected using `ido-switch-buffer'.")
971 (defvar ido-last-directory-list nil
972 "List of last selected directory names.
973 See `ido-enable-last-directory-history' for details.")
975 (defvar ido-work-directory-list nil
976 "List of actual working directory names.
977 The current directory is inserted at the front of this list whenever a
978 file is opened with `ido-find-file' and family.")
980 (defvar ido-work-file-list nil
981 "List of actual work file names.
982 Opening a file with `ido-find-file' and similar functions
983 inserts the current file name (relative to its containing directory)
984 at the front of this list.")
986 (defvar ido-dir-file-cache nil
987 "List of `file-name-all-completions' results.
988 Each element in the list is of the form (DIR (MTIME) FILE...).")
990 (defvar ido-ignore-item-temp-list nil
991 "List of items to ignore in current ido invocation.
992 Intended to be let-bound by functions which call ido repeatedly.
993 Should never be set permanently.")
995 ;; Temporary storage
997 (defvar ido-eoinput 1
998 "Point where minibuffer input ends and completion info begins.
999 Copied from `icomplete-eoinput'.")
1000 (make-variable-buffer-local 'ido-eoinput)
1002 (defvar ido-common-match-string nil
1003 "Stores the string that is common to all matching files.")
1005 (defvar ido-rescan nil
1006 "Non-nil means we need to regenerate the list of matching items.")
1008 (defvar ido-rotate nil
1009 "Non-nil means we are rotating list of matches.")
1011 (defvar ido-text nil
1012 "Stores the users string as it is typed in.")
1014 (defvar ido-text-init nil
1015 "The initial string for the users string it is typed in.")
1017 (defvar ido-input-stack nil
1018 "Stores the users strings when user hits M-b/M-f.")
1020 (defvar ido-matches nil
1021 "List of files currently matching `ido-text'.")
1023 (defvar ido-report-no-match t
1024 "Report [No Match] when no completions matches `ido-text'.")
1026 (defvar ido-exit nil
1027 "Flag to monitor how `ido-find-file' exits.
1028 If equal to `takeprompt', we use the prompt as the file name to be
1029 selected.")
1031 (defvar ido-current-directory nil
1032 "Current directory for `ido-find-file'.")
1034 (defvar ido-auto-merge-timer nil
1035 "Delay timer for auto merge.")
1037 (defvar ido-use-mycompletion-depth 0
1038 "Non-nil means use `ido' completion feedback.
1039 Is set by ido functions to the current `minibuffer-depth',
1040 so that it doesn't interfere with other minibuffer usage.")
1042 (defvar ido-incomplete-regexp nil
1043 "Non-nil if an incomplete regexp is entered.")
1045 (defvar ido-initial-position nil
1046 "Non-nil means to explicitly cursor on entry to minibuffer.
1047 Value is an integer which is number of chars to right of prompt.")
1049 (defvar ido-virtual-buffers nil
1050 "List of virtual buffers, that is, past visited files.
1051 This is a copy of `recentf-list', pared down and with faces applied.
1052 Only used if `ido-use-virtual-buffers' is non-nil.")
1054 ;;; Variables with dynamic bindings.
1055 ;;; Declared here to keep the byte compiler quiet.
1057 ;; Stores the current ido item type ('file, 'dir, 'buffer, or 'list).
1058 (defvar ido-cur-item)
1060 ;;; Stores the current default item
1061 (defvar ido-default-item)
1063 ;; Stores the current list of items that will be searched through.
1064 ;; The list is ordered, so that the most interesting item comes first,
1065 ;; although by default, the files visible in the current frame are put
1066 ;; at the end of the list. Created by `ido-make-item-list'.
1067 (defvar ido-cur-list)
1069 ;; Stores the choice list for ido-completing-read
1070 (defvar ido-choice-list)
1072 ;; Stores the list of items which are ignored when building
1073 ;; `ido-cur-list'. It is in no specific order.
1074 (defvar ido-ignored-list)
1076 ;; Remember if current directory is non-readable (so we cannot do completion).
1077 (defvar ido-directory-nonreadable)
1079 ;; Remember if current directory is 'huge' (so we don't want to do completion).
1080 (defvar ido-directory-too-big)
1082 ;; Keep current item list if non-nil.
1083 (defvar ido-keep-item-list)
1085 ;; Process ido-ignore-* lists.
1086 (defvar ido-process-ignore-lists)
1088 ;; Don't process ido-ignore- lists once.
1089 (defvar ido-process-ignore-lists-inhibit)
1091 ;; Buffer from which ido was entered.
1092 (defvar ido-entry-buffer)
1094 ;; Non-nil if matching file must be selected.
1095 (defvar ido-require-match)
1097 ;; Non-nil if we should add [confirm] to prompt
1098 (defvar ido-show-confirm-message)
1100 ;; Stores a temporary version of the file list being created.
1101 (defvar ido-temp-list)
1103 ;; Non-nil if default list element should be rotated into place.
1104 (defvar ido-rotate-temp)
1106 ;; Stores current index in ido-work-directory-list.
1107 (defvar ido-work-directory-index)
1109 ;; Stores current index in ido-work-file-list.
1110 (defvar ido-work-file-index)
1112 ;; Set when merged work directory list is in use.
1113 (defvar ido-use-merged-list)
1115 ;; Set when merged work directory list not yet built.
1116 (defvar ido-try-merged-list)
1118 ;; Saved state prior to last work directory merge.
1119 ;; Value is a list (ido-text dir cur-list ignored-list matches).
1120 (defvar ido-pre-merge-state)
1122 ;; Original value of vc-handled-backends for use in ido-toggle-vc.
1123 (defvar ido-saved-vc-hb)
1125 ;; Stores temporary state of literal find file.
1126 (defvar ido-find-literal)
1128 ;; Set to 'ignore to inhibit switching between find-file/switch-buffer.
1129 (defvar ido-context-switch-command)
1131 ;; Dynamically bound in ido-read-internal.
1132 (defvar ido-completing-read)
1134 ;;; FUNCTIONS
1136 (defun ido-active (&optional merge)
1137 (if merge
1138 ido-use-merged-list
1139 (and (boundp 'ido-completing-read)
1140 (or (featurep 'xemacs)
1141 (= ido-use-mycompletion-depth (minibuffer-depth))))))
1143 (defvar ido-trace-enable nil)
1145 (defun ido-trace (p &optional s retval)
1146 (if ido-trace-enable
1147 (let ((b (get-buffer-create " *IDO Trace*"))
1148 (deactivate-mark deactivate-mark))
1149 (save-excursion
1150 (save-restriction
1151 (set-buffer b)
1152 (insert p ": " (if (stringp s) s (format "%S" s)) "\n")))))
1153 retval)
1155 (defun ido-toggle-trace (arg)
1156 (interactive "P")
1157 (setq ido-trace-enable (or arg (not ido-trace-enable)))
1158 (if ido-trace-enable
1159 (message "IDO trace on"))
1160 (let ((b (get-buffer " *IDO Trace*")))
1161 (if b
1162 (if ido-trace-enable
1163 (kill-buffer b)
1164 (pop-to-buffer b t t)
1165 (setq truncate-lines t)))))
1167 (defun ido-local-file-exists-p (file)
1168 "Tell if FILE exists locally."
1169 (let (file-name-handler-alist)
1170 (file-exists-p file)))
1172 (defun ido-unc-hosts (&optional query)
1173 "Return list of UNC host names."
1174 (let ((hosts
1175 (cond
1176 ((listp ido-unc-hosts)
1177 ido-unc-hosts) ;; static list or nil
1178 ((listp ido-unc-hosts-cache)
1179 ido-unc-hosts-cache) ;; result of net search
1180 ((and query (fboundp ido-unc-hosts))
1181 (message (propertize "Searching for UNC hosts..." 'face 'highlight))
1182 (setq ido-unc-hosts-cache (funcall ido-unc-hosts))
1183 (message nil)
1184 ido-unc-hosts-cache)
1185 (query
1186 (setq ido-unc-hosts-cache nil))
1187 (t (fboundp ido-unc-hosts)))))
1188 (when query
1189 (let ((case-fold-search ido-downcase-unc-hosts)
1190 res host re-list re)
1191 (while hosts
1192 (setq host (car hosts)
1193 hosts (cdr hosts)
1194 re-list (and ido-process-ignore-lists
1195 ido-ignore-unc-host-regexps))
1196 (while re-list
1197 (setq re (car re-list)
1198 re-list (cdr re-list))
1199 (if (string-match re host)
1200 (setq re-list nil
1201 host nil)))
1202 (when host
1203 (when ido-downcase-unc-hosts
1204 (setq host (downcase host)))
1205 (setq res (cons host res))))
1206 (setq hosts (sort res #'string<))))
1207 hosts))
1209 (defun ido-unc-hosts-net-view ()
1210 "Query network for list of UNC host names using `NET VIEW'."
1211 (let (hosts)
1212 (with-temp-buffer
1213 (shell-command "net view" t)
1214 (goto-char (point-min))
1215 (while (re-search-forward "^\\\\\\\\\\([[:graph:]]+\\)" nil t)
1216 (setq hosts (cons (match-string 1) hosts))))
1217 hosts))
1219 (defun ido-is-tramp-root (&optional dir)
1220 (and ido-enable-tramp-completion
1221 (string-match "\\`/[^/]+[@:]\\'"
1222 (or dir ido-current-directory))))
1224 (defun ido-is-unc-root (&optional dir)
1225 (and (ido-unc-hosts)
1226 (string-equal "//"
1227 (or dir ido-current-directory))))
1229 (defun ido-is-unc-host (&optional dir)
1230 (and (ido-unc-hosts)
1231 (string-match "\\`//[^/]+/\\'"
1232 (or dir ido-current-directory))))
1234 (defun ido-is-root-directory (&optional dir)
1235 (setq dir (or dir ido-current-directory))
1237 (string-equal "/" dir)
1238 (and (memq system-type '(windows-nt ms-dos))
1239 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir))
1240 (if ido-enable-tramp-completion
1241 (ido-is-tramp-root dir)
1242 (string-match "\\`/[^:/][^:/]+:\\'" dir))))
1244 (defun ido-is-ftp-directory (&optional dir)
1245 (string-match
1246 (if ido-enable-tramp-completion
1247 "\\`/[^/:][^/:]+:" ;; like tramp-file-name-regexp-unified, but doesn't match single drive letters
1248 "\\`/[^/:][^/:]+:/")
1249 (or dir ido-current-directory)))
1251 (defun ido-is-slow-ftp-host (&optional dir)
1252 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps)
1253 (setq dir (or dir ido-current-directory))
1254 ;; (featurep 'ange-ftp)
1255 ;; (ange-ftp-ftp-name dir)
1256 (string-match
1257 (if ido-enable-tramp-completion
1258 "\\`/\\([^/]+[@:]\\)*\\([^@/:][^@/:]+\\):"
1259 "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/")
1260 dir)
1261 (let ((host (substring dir (match-beginning 2) (match-end 2))))
1262 (or (member host ido-slow-ftp-hosts)
1263 (let ((re ido-slow-ftp-host-regexps))
1264 (while (and re (not (string-match (car re) host)))
1265 (setq re (cdr re)))
1266 re)))))
1268 (defun ido-time-stamp (&optional time)
1269 ;; Time is a floating point number (fractions of 1 hour)
1270 (setq time (or time (current-time)))
1271 (/ (+ (* (car time) 65536.0) (car (cdr time))) 3600.0))
1273 (defun ido-cache-ftp-valid (&optional time)
1274 (and (numberp ido-cache-ftp-work-directory-time)
1275 (> ido-cache-ftp-work-directory-time 0)
1276 (or (not time)
1277 (< (- (ido-time-stamp) time) ido-cache-ftp-work-directory-time))))
1279 (defun ido-cache-unc-valid (&optional time)
1280 (and (numberp ido-cache-unc-host-shares-time)
1281 (> ido-cache-unc-host-shares-time 0)
1282 (or (not time)
1283 (< (- (ido-time-stamp) time) ido-cache-unc-host-shares-time))))
1285 (defun ido-may-cache-directory (&optional dir)
1286 (setq dir (or dir ido-current-directory))
1287 (cond
1288 ((and (ido-is-root-directory dir)
1289 (or ido-enable-tramp-completion
1290 (memq system-type '(windows-nt ms-dos))))
1291 nil)
1292 ((ido-is-unc-host dir)
1293 (ido-cache-unc-valid))
1294 ((ido-is-ftp-directory dir)
1295 (ido-cache-ftp-valid))
1296 ((ido-directory-too-big-p dir)
1297 nil)
1298 (t t)))
1300 (defun ido-pp (list &optional sep)
1301 (let ((print-level nil) (eval-expression-print-level nil)
1302 (print-length nil) (eval-expression-print-length nil))
1303 (insert "\n;; ----- " (symbol-name list) " -----\n(\n ")
1304 (setq list (symbol-value list))
1305 (while list
1306 (let* ((elt (car list))
1307 (s (if (consp elt) (car elt) elt)))
1308 (if (and (stringp s) (= (length s) 0))
1309 (setq s nil))
1310 (if s
1311 (prin1 elt (current-buffer)))
1312 (if (and (setq list (cdr list)) s)
1313 (insert (or sep "\n ")))))
1314 (insert "\n)\n")))
1316 (defun ido-save-history ()
1317 "Save ido history and cache information between sessions."
1318 (interactive)
1319 (when (and ido-last-directory-list ido-save-directory-list-file)
1320 (let ((buf (get-buffer-create " *ido session*"))
1321 (version-control 'never))
1322 (unwind-protect
1323 (with-current-buffer buf
1324 (erase-buffer)
1325 (insert ";;; -*- coding: utf-8 -*-\n")
1326 (setq buffer-file-coding-system 'utf-8)
1327 (ido-pp 'ido-last-directory-list)
1328 (ido-pp 'ido-work-directory-list)
1329 (ido-pp 'ido-work-file-list)
1330 (ido-pp 'ido-dir-file-cache "\n\n ")
1331 (if (listp ido-unc-hosts-cache)
1332 (ido-pp 'ido-unc-hosts-cache)
1333 (insert "\n;; ----- ido-unc-hosts-cache -----\nt\n"))
1334 (write-file ido-save-directory-list-file nil))
1335 (kill-buffer buf)))))
1337 (defun ido-load-history (&optional arg)
1338 "Load ido history and cache information from previous session.
1339 With prefix argument, reload history unconditionally."
1340 (interactive "P")
1341 (if (or arg (and ido-save-directory-list-file (not ido-last-directory-list)))
1342 (let ((file (expand-file-name ido-save-directory-list-file))
1343 buf)
1344 (when (file-readable-p file)
1345 (setq buf (get-buffer-create " *ido session*"))
1346 (unwind-protect
1347 (with-current-buffer buf
1348 (erase-buffer)
1349 (insert-file-contents file)
1350 (condition-case nil
1351 (setq ido-last-directory-list (read (current-buffer))
1352 ido-work-directory-list (read (current-buffer))
1353 ido-work-file-list (read (current-buffer))
1354 ido-dir-file-cache (read (current-buffer))
1355 ido-unc-hosts-cache (read (current-buffer)))
1356 (error nil)))
1357 (kill-buffer buf)))))
1358 (ido-wash-history))
1360 (defun ido-wash-history ()
1361 "Clean-up ido history and cache information.
1362 Removes badly formatted data and ignored directories."
1363 (interactive)
1364 ;; Check format of each of our lists, discard bogus elements
1365 (setq ido-last-directory-list
1366 (and (listp ido-last-directory-list)
1367 (let ((l ido-last-directory-list) r)
1368 (while l
1369 (if (and (consp (car l))
1370 (stringp (car (car l)))
1371 (stringp (cdr (car l))))
1372 (setq r (cons (car l) r)))
1373 (setq l (cdr l)))
1374 (nreverse r))))
1375 (setq ido-work-directory-list
1376 (and (listp ido-work-directory-list)
1377 (let ((l ido-work-directory-list) r)
1378 (while l
1379 (if (and (stringp (car l))
1380 (or ido-record-ftp-work-directories
1381 (not (ido-is-ftp-directory (car l)))))
1382 (setq r (cons (car l) r)))
1383 (setq l (cdr l)))
1384 (nreverse r))))
1385 (setq ido-work-file-list
1386 (and (listp ido-work-file-list)
1387 (let ((l ido-work-file-list) r)
1388 (while l
1389 (if (stringp (car l))
1390 (setq r (cons (car l) r)))
1391 (setq l (cdr l)))
1392 (nreverse r))))
1393 (setq ido-dir-file-cache
1394 (and (listp ido-dir-file-cache)
1395 (let ((l ido-dir-file-cache) r)
1396 (while l
1397 (if (and (listp (car l))
1398 (> (length (car l)) 2)
1399 (let ((dir (car (car l)))
1400 (time (car (cdr (car l))))
1401 (files (cdr (cdr (car l)))))
1402 (and
1403 (stringp dir)
1404 (consp time)
1405 (cond
1406 ((integerp (car time))
1407 (and (/= (car time) 0)
1408 (integerp (car (cdr time)))
1409 (/= (car (cdr time)) 0)
1410 (ido-may-cache-directory dir)))
1411 ((eq (car time) 'ftp)
1412 (and (numberp (cdr time))
1413 (ido-is-ftp-directory dir)
1414 (ido-cache-ftp-valid (cdr time))))
1415 ((eq (car time) 'unc)
1416 (and (numberp (cdr time))
1417 (ido-is-unc-host dir)
1418 (ido-cache-unc-valid (cdr time))))
1419 (t nil))
1420 (let ((s files) (ok t))
1421 (while s
1422 (if (stringp (car s))
1423 (setq s (cdr s))
1424 (setq s nil ok nil)))
1425 ok))))
1426 (setq r (cons (car l) r)))
1427 (setq l (cdr l)))
1428 (nreverse r))))
1430 ;; Remove ignored directories from work directory list
1431 ;; according to ido-work-directory-list-ignore-regexps
1432 (if ido-work-directory-list
1433 (let ((dirs (reverse ido-work-directory-list)))
1434 (setq ido-work-directory-list nil)
1435 (while dirs
1436 (ido-record-work-directory (car dirs))
1437 (setq dirs (cdr dirs)))))
1438 ;; Get rid of text properties
1439 (let ((l ido-last-directory-list) e)
1440 (while l
1441 (setq e (car l) l (cdr l))
1442 (set-text-properties 0 (length (car e)) nil (car e))
1443 (set-text-properties 0 (length (cdr e)) nil (cdr e))))
1444 (let ((l ido-work-directory-list) e)
1445 (while l
1446 (setq e (car l) l (cdr l))
1447 (set-text-properties 0 (length e) nil e)))
1448 (let ((l ido-work-file-list) e)
1449 (while l
1450 (setq e (car l) l (cdr l))
1451 (set-text-properties 0 (length e) nil e)))
1452 (let ((l ido-dir-file-cache) e d)
1453 (while l
1454 (setq e (car l) l (cdr l))
1455 (if (listp e)
1456 (while e
1457 (setq d (car e) e (cdr e))
1458 (if (not (consp d))
1459 (set-text-properties 0 (length d) nil d)))))))
1462 (defun ido-kill-emacs-hook ()
1463 ;; ido kill emacs hook
1464 (ido-save-history))
1466 (defun ido-common-initialization ()
1467 (ido-init-completion-maps)
1468 (add-hook 'minibuffer-setup-hook 'ido-minibuffer-setup)
1469 (add-hook 'choose-completion-string-functions 'ido-choose-completion-string))
1471 (define-minor-mode ido-everywhere
1472 "Toggle using ido-mode everywhere file and directory names are read.
1473 With ARG, turn ido-mode on if arg is positive, off otherwise."
1474 :global t
1475 :group 'ido
1476 (when (get 'ido-everywhere 'file)
1477 (setq read-file-name-function (car (get 'ido-everywhere 'file)))
1478 (put 'ido-everywhere 'file nil))
1479 (when (get 'ido-everywhere 'buffer)
1480 (setq read-buffer-function (car (get 'ido-everywhere 'buffer)))
1481 (put 'ido-everywhere 'buffer nil))
1482 (when ido-everywhere
1483 (when (memq ido-mode '(both file))
1484 (put 'ido-everywhere 'file (cons read-file-name-function nil))
1485 (setq read-file-name-function 'ido-read-file-name))
1486 (when (memq ido-mode '(both buffer))
1487 (put 'ido-everywhere 'buffer (cons read-buffer-function nil))
1488 (setq read-buffer-function 'ido-read-buffer))))
1490 (defvar ido-minor-mode-map-entry nil)
1492 ;;;###autoload
1493 (defun ido-mode (&optional arg)
1494 "Toggle ido mode on or off.
1495 With ARG, turn ido-mode on if arg is positive, off otherwise.
1496 Turning on ido-mode will remap (via a minor-mode keymap) the default
1497 keybindings for the `find-file' and `switch-to-buffer' families of
1498 commands to the ido versions of these functions.
1499 However, if ARG arg equals 'files, remap only commands for files, or
1500 if it equals 'buffers, remap only commands for buffer switching.
1501 This function also adds a hook to the minibuffer."
1502 (interactive "P")
1503 (setq ido-mode
1504 (cond
1505 ((null arg) (if ido-mode nil 'both))
1506 ((eq arg t) 'both)
1507 ((eq arg 'files) 'file)
1508 ((eq arg 'buffers) 'buffer)
1509 ((memq arg '(file buffer both)) arg)
1510 ((> (prefix-numeric-value arg) 0) 'both)
1511 (t nil)))
1513 (ido-everywhere (if ido-everywhere 1 -1))
1515 (when ido-mode
1516 (ido-common-initialization)
1517 (ido-load-history)
1519 (add-hook 'kill-emacs-hook 'ido-kill-emacs-hook)
1521 (let ((map (make-sparse-keymap)))
1522 (when (memq ido-mode '(file both))
1523 (define-key map [remap find-file] 'ido-find-file)
1524 (define-key map [remap find-file-read-only] 'ido-find-file-read-only)
1525 (define-key map [remap find-alternate-file] 'ido-find-alternate-file)
1526 (define-key map [remap write-file] 'ido-write-file)
1527 (define-key map [remap insert-file] 'ido-insert-file)
1528 (define-key map [remap list-directory] 'ido-list-directory)
1529 (define-key map [remap dired] 'ido-dired)
1530 (define-key map [remap find-file-other-window]
1531 'ido-find-file-other-window)
1532 (define-key map [remap find-file-read-only-other-window]
1533 'ido-find-file-read-only-other-window)
1534 (define-key map [remap find-file-other-frame]
1535 'ido-find-file-other-frame)
1536 (define-key map [remap find-file-read-only-other-frame]
1537 'ido-find-file-read-only-other-frame))
1539 (when (memq ido-mode '(buffer both))
1540 (define-key map [remap switch-to-buffer] 'ido-switch-buffer)
1541 (define-key map [remap switch-to-buffer-other-window]
1542 'ido-switch-buffer-other-window)
1543 (define-key map [remap switch-to-buffer-other-frame]
1544 'ido-switch-buffer-other-frame)
1545 (define-key map [remap insert-buffer] 'ido-insert-buffer)
1546 (define-key map [remap kill-buffer] 'ido-kill-buffer)
1547 (define-key map [remap display-buffer] 'ido-display-buffer))
1549 (if ido-minor-mode-map-entry
1550 (setcdr ido-minor-mode-map-entry map)
1551 (setq ido-minor-mode-map-entry (cons 'ido-mode map))
1552 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry))))
1554 (when (called-interactively-p 'any)
1555 (message "Ido mode %s" (if ido-mode "enabled" "disabled"))))
1558 ;;; IDO KEYMAP
1559 (defun ido-init-completion-maps ()
1560 "Set up the completion keymaps used by `ido'."
1562 ;; Common map
1563 (let ((map (make-sparse-keymap)))
1564 (define-key map "\C-a" 'ido-toggle-ignore)
1565 (define-key map "\C-c" 'ido-toggle-case)
1566 (define-key map "\C-e" 'ido-edit-input)
1567 (define-key map "\t" 'ido-complete)
1568 (define-key map " " 'ido-complete-space)
1569 (define-key map "\C-j" 'ido-select-text)
1570 (define-key map "\C-m" 'ido-exit-minibuffer)
1571 (define-key map "\C-p" 'ido-toggle-prefix)
1572 (define-key map "\C-r" 'ido-prev-match)
1573 (define-key map "\C-s" 'ido-next-match)
1574 (define-key map "\C-t" 'ido-toggle-regexp)
1575 (define-key map "\C-z" 'ido-undo-merge-work-directory)
1576 (define-key map [(control ?\s)] 'ido-restrict-to-matches)
1577 (define-key map [(meta ?\s)] 'ido-take-first-match)
1578 (define-key map [(control ?@)] 'ido-restrict-to-matches)
1579 (define-key map [right] 'ido-next-match)
1580 (define-key map [left] 'ido-prev-match)
1581 (define-key map "?" 'ido-completion-help)
1582 ;; Magic commands.
1583 (define-key map "\C-b" 'ido-magic-backward-char)
1584 (define-key map "\C-f" 'ido-magic-forward-char)
1585 (define-key map "\C-d" 'ido-magic-delete-char)
1586 (set-keymap-parent map minibuffer-local-map)
1587 (setq ido-common-completion-map map))
1589 ;; File and directory map
1590 (let ((map (make-sparse-keymap)))
1591 (define-key map "\C-x\C-b" 'ido-enter-switch-buffer)
1592 (define-key map "\C-x\C-f" 'ido-fallback-command)
1593 (define-key map "\C-x\C-d" 'ido-enter-dired)
1594 (define-key map [down] 'ido-next-match-dir)
1595 (define-key map [up] 'ido-prev-match-dir)
1596 (define-key map [(meta up)] 'ido-prev-work-directory)
1597 (define-key map [(meta down)] 'ido-next-work-directory)
1598 (define-key map [backspace] 'ido-delete-backward-updir)
1599 (define-key map "\d" 'ido-delete-backward-updir)
1600 (define-key map [remap delete-backward-char] 'ido-delete-backward-updir) ; BS
1601 (define-key map [remap backward-kill-word] 'ido-delete-backward-word-updir) ; M-DEL
1603 (define-key map [(control backspace)] 'ido-up-directory)
1604 (define-key map "\C-l" 'ido-reread-directory)
1605 (define-key map [(meta ?d)] 'ido-wide-find-dir-or-delete-dir)
1606 (define-key map [(meta ?b)] 'ido-push-dir)
1607 (define-key map [(meta ?v)] 'ido-push-dir-first)
1608 (define-key map [(meta ?f)] 'ido-wide-find-file-or-pop-dir)
1609 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1610 (define-key map [(meta ?m)] 'ido-make-directory)
1611 (define-key map [(meta ?n)] 'ido-next-work-directory)
1612 (define-key map [(meta ?o)] 'ido-prev-work-file)
1613 (define-key map [(meta control ?o)] 'ido-next-work-file)
1614 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1615 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1616 (set-keymap-parent map ido-common-completion-map)
1617 (setq ido-file-dir-completion-map map))
1619 ;; File only map
1620 (let ((map (make-sparse-keymap)))
1621 (define-key map "\C-k" 'ido-delete-file-at-head)
1622 (define-key map "\C-o" 'ido-copy-current-word)
1623 (define-key map "\C-w" 'ido-copy-current-file-name)
1624 (define-key map [(meta ?l)] 'ido-toggle-literal)
1625 (set-keymap-parent map ido-file-dir-completion-map)
1626 (setq ido-file-completion-map map))
1628 ;; Buffer map
1629 (let ((map (make-sparse-keymap)))
1630 (define-key map "\C-x\C-f" 'ido-enter-find-file)
1631 (define-key map "\C-x\C-b" 'ido-fallback-command)
1632 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1633 (define-key map "\C-o" 'ido-toggle-virtual-buffers)
1634 (set-keymap-parent map ido-common-completion-map)
1635 (setq ido-buffer-completion-map map)))
1638 (defun ido-setup-completion-map ()
1639 "Set up the keymap for `ido'."
1641 ;; generated every time so that it can inherit new functions.
1642 (let ((map (make-sparse-keymap))
1643 (viper-p (if (boundp 'viper-mode) viper-mode)))
1645 (when viper-p
1646 (define-key map [remap viper-intercept-ESC-key] 'ignore))
1648 (cond
1649 ((memq ido-cur-item '(file dir))
1650 (when ido-context-switch-command
1651 (define-key map "\C-x\C-b" ido-context-switch-command)
1652 (define-key map "\C-x\C-d" 'ignore))
1653 (when viper-p
1654 (define-key map [remap viper-backward-char] 'ido-delete-backward-updir)
1655 (define-key map [remap viper-del-backward-char-in-insert] 'ido-delete-backward-updir)
1656 (define-key map [remap viper-delete-backward-word] 'ido-delete-backward-word-updir))
1657 (set-keymap-parent map
1658 (if (eq ido-cur-item 'file)
1659 ido-file-completion-map
1660 ido-file-dir-completion-map)))
1662 ((eq ido-cur-item 'buffer)
1663 (when ido-context-switch-command
1664 (define-key map "\C-x\C-f" ido-context-switch-command))
1665 (set-keymap-parent map ido-buffer-completion-map))
1668 (set-keymap-parent map ido-common-completion-map)))
1670 (setq ido-completion-map map)))
1672 (defun ido-final-slash (dir &optional fix-it)
1673 ;; return DIR if DIR has final slash.
1674 ;; else if FIX-IT is non-nil, return DIR/
1675 ;; else return nil.
1676 (setq dir (ido-name dir))
1677 (cond
1678 ((string-match "/\\'" dir) dir)
1679 ((ido-is-tramp-root dir) dir)
1680 (fix-it (concat dir "/"))
1681 (t nil)))
1683 (defun ido-no-final-slash (s)
1684 ;; Remove optional final slash from string S
1685 (let ((l (1- (length s))))
1686 (if (and (> l 0) (eq (aref s l) ?/))
1687 (substring s 0 l)
1688 s)))
1690 (defun ido-nonreadable-directory-p (dir)
1691 ;; Return t if dir is a directory, but not readable
1692 ;; Do not check for non-readable directories via tramp, as this causes a premature
1693 ;; connect on incomplete tramp paths (after entring just method:).
1694 (let ((ido-enable-tramp-completion nil))
1695 (and (ido-final-slash dir)
1696 (not (ido-is-unc-host dir))
1697 (file-directory-p dir)
1698 (not (file-readable-p dir)))))
1700 (defun ido-directory-too-big-p (dir)
1701 ;; Return t if dir is a directory, but too big to show
1702 ;; Do not check for non-readable directories via tramp, as this causes a premature
1703 ;; connect on incomplete tramp paths (after entring just method:).
1704 (let ((ido-enable-tramp-completion nil))
1705 (and (numberp ido-max-directory-size)
1706 (ido-final-slash dir)
1707 (not (ido-is-unc-host dir))
1708 (file-directory-p dir)
1709 (> (nth 7 (file-attributes dir)) ido-max-directory-size))))
1711 (defun ido-set-current-directory (dir &optional subdir no-merge)
1712 ;; Set ido's current directory to DIR or DIR/SUBDIR
1713 (unless (and ido-enable-tramp-completion
1714 (string-match "\\`/[^/]*@\\'" dir))
1715 (setq dir (ido-final-slash dir t)))
1716 (setq ido-use-merged-list nil
1717 ido-try-merged-list (not no-merge))
1718 (when subdir
1719 (setq dir (concat dir subdir))
1720 (unless (and ido-enable-tramp-completion
1721 (string-match "\\`/[^/]*@\\'" dir))
1722 (setq dir (ido-final-slash dir t))))
1723 (if (get-buffer ido-completion-buffer)
1724 (kill-buffer ido-completion-buffer))
1725 (cond
1726 ((equal dir ido-current-directory)
1727 nil)
1728 ((ido-is-unc-root dir)
1729 (ido-trace "unc" dir)
1730 (setq ido-current-directory dir)
1731 (setq ido-directory-nonreadable nil)
1732 (setq ido-directory-too-big nil)
1735 (ido-trace "cd" dir)
1736 (setq ido-current-directory dir)
1737 (if (get-buffer ido-completion-buffer)
1738 (kill-buffer ido-completion-buffer))
1739 (setq ido-directory-nonreadable (ido-nonreadable-directory-p dir))
1740 (setq ido-directory-too-big (and (not ido-directory-nonreadable)
1741 (ido-directory-too-big-p dir)))
1742 t)))
1744 (defun ido-set-current-home (&optional dir)
1745 ;; Set ido's current directory to user's home directory
1746 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1748 (defun ido-record-command (command arg)
1749 ;; Add (command arg) to command-history if ido-record-commands is t
1750 (if ido-record-commands
1751 (let ((cmd (list command arg)))
1752 (if (or (not command-history)
1753 (not (equal cmd (car command-history))))
1754 (setq command-history (cons cmd command-history))))))
1756 (defun ido-make-prompt (item prompt)
1757 ;; Make the prompt for ido-read-internal
1758 (cond
1759 ((and (memq item '(file dir)) ido-current-directory)
1760 (let ((dirname (abbreviate-file-name ido-current-directory))
1761 (max-width (if (and ido-max-file-prompt-width (floatp ido-max-file-prompt-width))
1762 (floor (* (frame-width) ido-max-file-prompt-width))
1763 ido-max-file-prompt-width))
1764 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1765 (vc-off (and ido-saved-vc-hb (not vc-handled-backends) "[-VC] "))
1766 (prefix nil)
1767 (rule ido-rewrite-file-prompt-rules))
1768 (let ((case-fold-search nil))
1769 (while rule
1770 (if (and (consp (car rule))
1771 (string-match (car (car rule)) dirname))
1772 (setq dirname
1773 (if (stringp (cdr (car rule)))
1774 (replace-match (cdr (car rule)) t nil dirname)
1775 (funcall (cdr (car rule)) dirname))))
1776 (setq rule (cdr rule))))
1777 (run-hooks 'ido-rewrite-file-prompt-functions)
1778 (concat prompt
1779 ; (if ido-process-ignore-lists "" "&")
1780 (or literal "")
1781 (or vc-off "")
1782 (or prefix "")
1783 (let ((l (length dirname)))
1784 (if (and max-width (> max-width 0) (> l max-width))
1785 (let* ((s (substring dirname (- max-width)))
1786 (i (string-match "/" s)))
1787 (concat "..." (if i (substring s i) s)))
1788 dirname)))))
1789 (t prompt)))
1791 ;; Here is very briefly how ido-find-file works:
1793 ;; (ido-find-file)
1794 ;; (ido-file-internal method)
1795 ;; set ido-current-directory
1796 ;; (ido-read-internal 'file ...)
1797 ;; (while ...
1798 ;; (ido-make-item-list ...)
1799 ;; (ido-set-matches)
1800 ;; (completing-read ... ido-text-init ...)
1802 ;; ... here user is allowed to type characters and commands
1803 ;; a command may set ido-exit and call (exit-minibuffer)
1804 ;; to make ido-read-internal do advanced tasks (or return)
1806 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1807 ;; which are run before and after each user command.
1809 ;; return value from completing-read is stored in ido-final-text
1810 ;; - ido-exit may cause further actions to be taken:
1811 ;; 'refresh - repeat loop (make-item-list, set-matches)
1812 ;; 'edit - edit the prompt string, then repeat loop
1813 ;; 'keep - repeat loop but don't (re)make-item-list
1814 ;; 'updir - go up one directory, repeat loop
1815 ;; else set ido-selected based on ido-final-text,
1816 ;; optionally update ido-current-directory and repeat loop, or
1817 ;; exit with the return value of ido-selected (file name)
1818 ;; selected file name is returned from ido-read-internal,
1819 ;; ido-exit and method determines what action is taken
1820 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1821 ;; the relevant function is called (find-file, write-file, etc).
1823 (defun ido-read-internal (item prompt hist &optional default require-match initial)
1824 "Perform the `ido-read-buffer' and `ido-read-file-name' functions.
1825 Return the name of a buffer or file selected.
1826 PROMPT is the prompt to give to the user.
1827 DEFAULT if given is the default item to start with.
1828 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1829 If INITIAL is non-nil, it specifies the initial input string."
1830 (let
1831 ((ido-cur-item item)
1832 (ido-entry-buffer (current-buffer))
1833 (ido-process-ignore-lists t)
1834 (ido-process-ignore-lists-inhibit nil)
1835 (ido-set-default-item t)
1836 ido-default-item
1837 ido-selected
1838 ido-final-text
1839 (done nil)
1840 (icomplete-mode nil) ;; prevent icomplete starting up
1841 ;; Exported dynamic variables:
1842 ido-cur-list
1843 ido-ignored-list
1844 (ido-rotate-temp nil)
1845 (ido-keep-item-list nil)
1846 (ido-use-merged-list nil)
1847 (ido-try-merged-list t)
1848 (ido-pre-merge-state nil)
1849 (ido-case-fold ido-case-fold)
1850 (ido-enable-prefix ido-enable-prefix)
1851 (ido-enable-regexp ido-enable-regexp)
1852 (ido-show-confirm-message nil)
1855 (ido-setup-completion-map)
1856 (setq ido-text-init initial)
1857 (setq ido-input-stack nil)
1859 (run-hooks 'ido-setup-hook)
1861 (while (not done)
1862 (ido-trace "\n_LOOP_" ido-text-init)
1863 (setq ido-exit nil)
1864 (setq ido-rescan t)
1865 (setq ido-rotate nil)
1866 (setq ido-text "")
1867 (when ido-set-default-item
1868 (setq ido-default-item
1869 (cond
1870 ((eq item 'buffer)
1871 (if (bufferp default) (buffer-name default) default))
1872 ((stringp default)
1873 (if (memq item '(file dir))
1874 (file-name-nondirectory default)
1875 default))
1876 ((eq item 'file)
1877 (and ido-enable-last-directory-history
1878 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1879 (and d (cdr d)))))))
1880 (if (member ido-default-item ido-ignore-item-temp-list)
1881 (setq ido-default-item nil))
1882 (ido-trace "new default" ido-default-item)
1883 (if ido-default-item
1884 (setq ido-initial-position 0))
1885 (setq ido-set-default-item nil))
1887 (if ido-process-ignore-lists-inhibit
1888 (setq ido-process-ignore-lists nil))
1890 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1891 (let ((olist ido-cur-list)
1892 (oign ido-ignored-list)
1893 (omat ido-matches)
1894 (l (ido-make-merged-file-list ido-text-init
1895 (eq ido-use-merged-list 'auto)
1896 (eq ido-try-merged-list 'wide))))
1897 (ido-trace "merged" l)
1898 (cond
1899 ((not l)
1900 (if (eq ido-try-merged-list 'wide)
1901 (setq ido-pre-merge-state
1902 (list "" ido-current-directory olist oign omat)
1903 ido-cur-list nil
1904 ido-ignored-list nil
1905 ido-matches nil
1906 ido-keep-item-list t
1907 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1908 ido-use-merged-list nil)
1909 (setq ido-cur-list olist
1910 ido-ignored-list oign
1911 ido-matches omat
1912 ido-keep-item-list t
1913 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1914 ido-use-merged-list nil)))
1915 ((eq l t)
1916 (setq ido-use-merged-list nil))
1917 ((eq l 'input-pending-p)
1918 (setq ido-try-merged-list t
1919 ido-use-merged-list nil))
1921 (setq ido-pre-merge-state
1922 (list ido-text-init ido-current-directory olist oign omat))
1923 (ido-set-current-directory (car (cdr (car l))))
1924 (if (ido-final-slash ido-text-init)
1925 (setq ido-text-init ""))
1926 (setq ido-cur-list l
1927 ido-ignored-list nil
1928 ido-matches l
1929 ido-rescan nil
1930 ido-keep-item-list t
1931 ido-use-merged-list t)
1932 (ido-trace "Merged" t)
1933 ))))
1935 (cond
1936 (ido-keep-item-list
1937 (setq ido-keep-item-list nil
1938 ido-rescan nil))
1939 ((eq ido-cur-item 'file)
1940 (setq ido-ignored-list nil
1941 ido-cur-list (and (not ido-directory-nonreadable)
1942 (not ido-directory-too-big)
1943 (ido-make-file-list ido-default-item))))
1944 ((eq ido-cur-item 'dir)
1945 (setq ido-ignored-list nil
1946 ido-cur-list (and (not ido-directory-nonreadable)
1947 (not ido-directory-too-big)
1948 (ido-make-dir-list ido-default-item))))
1949 ((eq ido-cur-item 'buffer)
1950 (setq ido-ignored-list nil
1951 ido-cur-list (ido-make-buffer-list ido-default-item)))
1952 ((eq ido-cur-item 'list)
1953 (setq ido-ignored-list nil
1954 ido-cur-list (ido-make-choice-list ido-default-item)))
1955 (t nil))
1956 (setq ido-rotate-temp nil)
1958 (if ido-process-ignore-lists-inhibit
1959 (setq ido-process-ignore-lists t
1960 ido-process-ignore-lists-inhibit nil))
1962 (ido-set-matches)
1963 (if (and ido-matches (eq ido-try-merged-list 'auto))
1964 (setq ido-try-merged-list t))
1965 (let ((max-mini-window-height (or ido-max-window-height
1966 (and (boundp 'max-mini-window-height)
1967 max-mini-window-height)))
1968 (ido-completing-read t)
1969 (ido-require-match require-match)
1970 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1971 (show-paren-mode nil)
1972 ;; Postpone history adding till later
1973 (history-add-new-input nil))
1974 ;; prompt the user for the file name
1975 (setq ido-exit nil)
1976 (setq ido-final-text
1977 (catch 'ido
1978 (read-from-minibuffer (ido-make-prompt item prompt)
1979 (prog1 ido-text-init
1980 (setq ido-text-init nil))
1981 ido-completion-map nil hist))))
1982 (ido-trace "read-from-minibuffer" ido-final-text)
1983 (if (get-buffer ido-completion-buffer)
1984 (kill-buffer ido-completion-buffer))
1986 (ido-trace "\n_EXIT_" ido-exit)
1988 (cond
1989 ((eq ido-exit 'refresh)
1990 (if (and (eq ido-use-merged-list 'auto)
1991 (or (input-pending-p)))
1992 (setq ido-use-merged-list nil
1993 ido-keep-item-list t))
1994 nil)
1996 ((eq ido-exit 'done)
1997 (setq done t
1998 ido-selected ido-text
1999 ido-exit nil))
2001 ((memq ido-exit '(edit chdir))
2002 (cond
2003 ((memq ido-cur-item '(file dir))
2004 (let* ((read-file-name-function nil)
2005 (edit (eq ido-exit 'edit))
2006 (d ido-current-directory)
2007 (f ido-text-init)
2008 (new t))
2009 (setq ido-text-init "")
2010 (while new
2011 (setq new (if edit
2012 (condition-case nil
2013 (read-file-name (concat prompt "[EDIT] ")
2014 (expand-file-name d)
2015 (concat d f) nil f)
2016 (quit (concat d f)))
2018 d (or (file-name-directory new) "/")
2019 f (file-name-nondirectory new)
2020 edit t)
2021 (if (or
2022 (file-directory-p d)
2023 (and (yes-or-no-p (format "Create directory %s? " d))
2024 (condition-case nil
2025 (progn (make-directory d t) t)
2026 (error
2027 (message "Could not create directory")
2028 (sit-for 1)
2029 nil))))
2030 (progn
2031 (ido-set-current-directory d nil (eq ido-exit 'chdir))
2032 (setq ido-text-init f
2033 new nil))))))
2035 (setq ido-text-init
2036 (condition-case nil
2037 (read-string (concat prompt "[EDIT] ") ido-final-text)
2038 (quit ido-final-text)))))
2040 nil)
2042 ((eq ido-exit 'keep)
2043 (setq ido-keep-item-list t))
2045 ((memq ido-exit '(dired fallback find-file switch-to-buffer insert-buffer insert-file))
2046 (setq done t))
2048 ((memq ido-exit '(updir push))
2049 ;; cannot go up if already at the root-dir (Unix) or at the
2050 ;; root-dir of a certain drive (Windows or MS-DOS).
2051 (if (ido-is-tramp-root)
2052 (when (string-match "\\`\\(/\\([^/]+[:@]\\)*\\)\\([^/]+\\)[:@]\\'" ido-current-directory)
2053 (setq ido-text-init (match-string 3 ido-current-directory))
2054 (ido-set-current-directory (match-string 1 ido-current-directory))
2055 (setq ido-set-default-item t))
2056 (unless (ido-is-root-directory)
2057 (when (eq ido-exit 'push)
2058 (setq ido-input-stack (cons (cons ido-cur-item ido-text) ido-input-stack))
2059 (setq ido-cur-item 'dir)
2060 (setq ido-text-init (file-name-nondirectory (substring ido-current-directory 0 -1)))
2061 (ido-trace "push" ido-input-stack))
2062 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1)))
2063 (setq ido-set-default-item t))))
2065 ((eq ido-exit 'pop)
2066 (ido-trace "pop" ido-input-stack)
2067 (let ((elt (car ido-input-stack)))
2068 (setq ido-input-stack (cdr ido-input-stack))
2069 (ido-set-current-directory (concat ido-current-directory ido-text))
2070 (setq ido-cur-item (car elt))
2071 (setq ido-text-init (cdr elt))))
2073 ((eq ido-exit 'pop-all)
2074 (ido-trace "pop-all" ido-input-stack)
2075 (while ido-input-stack
2076 (let ((elt (car ido-input-stack)))
2077 (setq ido-input-stack (cdr ido-input-stack))
2078 (ido-set-current-directory (concat ido-current-directory ido-text))
2079 (setq ido-cur-item (car elt))
2080 (setq ido-text-init (cdr elt)))))
2082 ;; Handling the require-match must be done in a better way.
2083 ((and require-match
2084 (not (memq require-match '(confirm confirm-after-completion)))
2085 (not (if ido-directory-too-big
2086 (file-exists-p (concat ido-current-directory ido-final-text))
2087 (ido-existing-item-p))))
2088 (error "Must specify valid item"))
2091 (setq ido-selected
2092 (if (or (eq ido-exit 'takeprompt)
2093 (null ido-matches))
2094 ido-final-text
2095 ;; else take head of list
2096 (ido-name (car ido-matches))))
2098 (cond
2099 ((memq item '(buffer list))
2100 (setq done t))
2102 ((string-equal "./" ido-selected)
2103 nil)
2105 ((string-equal "../" ido-selected)
2106 ;; cannot go up if already at the root-dir (Unix) or at the
2107 ;; root-dir of a certain drive (Windows or MS-DOS).
2108 (or (ido-is-root-directory)
2109 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
2110 (setq ido-set-default-item t))
2112 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") ido-selected)
2113 (ido-is-root-directory) ;; Ange-ftp or Tramp
2114 (not (ido-local-file-exists-p ido-selected)))
2115 (ido-set-current-directory ido-current-directory ido-selected)
2116 (ido-trace "tramp prefix" ido-selected)
2117 (if (ido-is-slow-ftp-host)
2118 (setq ido-exit 'fallback
2119 done t)
2120 (setq ido-set-default-item t)))
2122 ((or (string-match "[/\\][^/\\]" ido-selected)
2123 (and (memq system-type '(windows-nt ms-dos))
2124 (string-match "\\`[a-zA-Z]:" ido-selected)))
2125 (ido-set-current-directory (file-name-directory ido-selected))
2126 (setq ido-set-default-item t))
2128 ((string-match "\\`~" ido-selected)
2129 (ido-set-current-home ido-selected))
2131 ((ido-final-slash ido-selected)
2132 (if ido-enable-last-directory-history
2133 (let ((x (assoc ido-current-directory ido-last-directory-list)))
2134 (if x
2135 (setcdr x ido-selected)
2136 (setq ido-last-directory-list
2137 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
2138 (ido-set-current-directory ido-current-directory ido-selected)
2139 (if ido-input-stack
2140 ; automatically pop stack elements which match existing files or directories
2141 (let (elt)
2142 (while (and (setq elt (car ido-input-stack))
2143 (file-exists-p (concat ido-current-directory (cdr elt))))
2144 (if (setq ido-input-stack (cdr ido-input-stack))
2145 (ido-set-current-directory ido-current-directory (cdr elt))
2146 (setq ido-text-init (cdr elt)))
2147 (setq ido-cur-item (car elt))))
2148 (setq ido-set-default-item t)))
2151 (setq done t))))))
2152 (add-to-history (cond
2153 ((consp hist)
2154 (or (car hist) 'minibuffer-history))
2155 (hist hist)
2156 (t 'minibuffer-history))
2157 ido-selected)
2158 ido-selected))
2160 (defun ido-edit-input ()
2161 "Edit absolute file name entered so far with ido; terminate by RET.
2162 If cursor is not at the end of the user input, move to end of input."
2163 (interactive)
2164 (if (not (eobp))
2165 (end-of-line)
2166 (setq ido-text-init (if ido-matches (ido-name (car ido-matches)) ido-text))
2167 (setq ido-exit 'edit)
2168 (exit-minibuffer)))
2170 ;;; MAIN FUNCTIONS
2171 (defun ido-buffer-internal (method &optional fallback prompt default initial switch-cmd)
2172 ;; Internal function for ido-switch-buffer and friends
2173 (if (not ido-mode)
2174 (progn
2175 (run-hook-with-args 'ido-before-fallback-functions
2176 (or fallback 'switch-to-buffer))
2177 (call-interactively (or fallback 'switch-to-buffer)))
2178 (let* ((ido-context-switch-command switch-cmd)
2179 (ido-current-directory nil)
2180 (ido-directory-nonreadable nil)
2181 (ido-directory-too-big nil)
2182 (ido-use-virtual-buffers ido-use-virtual-buffers)
2183 (require-match (confirm-nonexistent-file-or-buffer))
2184 (buf (ido-read-internal 'buffer (or prompt "Buffer: ") 'ido-buffer-history default
2185 require-match initial))
2186 filename)
2188 ;; Choose the buffer name: either the text typed in, or the head
2189 ;; of the list of matches
2191 (cond
2192 ((eq ido-exit 'find-file)
2193 (ido-file-internal
2194 (if (memq method '(other-window other-frame)) method ido-default-file-method)
2195 nil nil nil nil ido-text))
2197 ((eq ido-exit 'insert-file)
2198 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil ido-text 'ido-enter-insert-buffer))
2200 ((eq ido-exit 'fallback)
2201 (let ((read-buffer-function nil))
2202 (setq this-command (or fallback 'switch-to-buffer))
2203 (run-hook-with-args 'ido-before-fallback-functions this-command)
2204 (call-interactively this-command)))
2206 ;; Check buf is non-nil.
2207 ((not buf) nil)
2208 ((= (length buf) 0) nil)
2210 ;; View buffer if it exists
2211 ((get-buffer buf)
2212 (add-to-history 'buffer-name-history buf)
2213 (if (eq method 'insert)
2214 (progn
2215 (ido-record-command 'insert-buffer buf)
2216 (push-mark
2217 (save-excursion
2218 (insert-buffer-substring (get-buffer buf))
2219 (point))))
2220 (ido-visit-buffer buf method t)))
2222 ;; check for a virtual buffer reference
2223 ((and ido-use-virtual-buffers ido-virtual-buffers
2224 (setq filename (assoc buf ido-virtual-buffers)))
2225 (ido-visit-buffer (find-file-noselect (cdr filename)) method t))
2227 ((and (eq ido-create-new-buffer 'prompt)
2228 (null require-match)
2229 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
2230 nil)
2232 ;; buffer doesn't exist
2233 ((and (eq ido-create-new-buffer 'never)
2234 (null require-match))
2235 (message "No buffer matching `%s'" buf))
2237 ((and (eq ido-create-new-buffer 'prompt)
2238 (null require-match)
2239 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
2240 nil)
2242 ;; create a new buffer
2244 (add-to-history 'buffer-name-history buf)
2245 (setq buf (get-buffer-create buf))
2246 (if (fboundp 'set-buffer-major-mode)
2247 (set-buffer-major-mode buf))
2248 (ido-visit-buffer buf method t))))))
2250 (defun ido-record-work-directory (&optional dir)
2251 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
2252 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
2253 (let ((items ido-work-directory-list-ignore-regexps)
2254 (case-fold-search nil))
2255 (while (and items dir)
2256 (if (string-match (car items) dir)
2257 (setq dir nil))
2258 (setq items (cdr items)))
2259 (if dir
2260 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
2261 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
2262 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
2264 (defun ido-forget-work-directory ()
2265 (interactive)
2266 (when (and ido-current-directory ido-work-directory-list)
2267 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
2268 (when ido-use-merged-list
2269 (ido-undo-merge-work-directory)
2270 (setq ido-exit 'refresh
2271 ido-try-merged-list t
2272 ido-use-merged-list t
2273 ido-text-init ido-text
2274 ido-rotate-temp t)
2275 (exit-minibuffer))))
2277 (defun ido-record-work-file (name)
2278 ;; Save NAME in ido-work-file-list
2279 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
2281 (and ido-work-file-list (equal (car ido-work-file-list) name))
2282 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
2283 (if (> (length ido-work-file-list) ido-max-work-file-list)
2284 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
2286 (defun ido-expand-directory (dir)
2287 ;; Expand DIR or use DEFAULT-DIRECTORY if nil.
2288 ;; Add final slash to result in case it was missing from DEFAULT-DIRECTORY.
2289 (ido-final-slash (expand-file-name (or dir default-directory)) t))
2291 (defun ido-file-internal (method &optional fallback default prompt item initial switch-cmd)
2292 ;; Internal function for ido-find-file and friends
2293 (unless item
2294 (setq item 'file))
2295 (let ((ido-current-directory (ido-expand-directory default))
2296 (ido-context-switch-command switch-cmd)
2297 ido-directory-nonreadable ido-directory-too-big
2298 filename)
2300 (if (or (not ido-mode) (ido-is-slow-ftp-host))
2301 (setq filename t
2302 ido-exit 'fallback)
2303 (setq ido-directory-nonreadable
2304 (ido-nonreadable-directory-p ido-current-directory)
2305 ido-directory-too-big
2306 (and (not ido-directory-nonreadable)
2307 (ido-directory-too-big-p ido-current-directory))))
2309 (when (and (eq item 'file)
2310 (or ido-use-url-at-point ido-use-filename-at-point))
2311 (let (fn d)
2312 (require 'ffap)
2313 ;; Duplicate code from ffap-guesser as we want different
2314 ;; behavior for files and URLs.
2315 (cond
2316 ((with-no-warnings
2317 (and ido-use-url-at-point
2318 ffap-url-regexp
2319 (ffap-fixup-url (or (ffap-url-at-point)
2320 (ffap-gopher-at-point)))))
2321 (setq ido-exit 'ffap
2322 filename t))
2324 ((and ido-use-filename-at-point
2325 (setq fn (with-no-warnings
2326 (if (eq ido-use-filename-at-point 'guess)
2327 (ffap-guesser)
2328 (ffap-string-at-point))))
2329 (not (string-match "^http:/" fn))
2330 (let ((absolute-fn (expand-file-name fn)))
2331 (setq d (if (file-directory-p absolute-fn)
2332 (file-name-as-directory absolute-fn)
2333 (file-name-directory absolute-fn))))
2334 (file-directory-p d))
2335 (setq ido-current-directory d)
2336 (setq initial (file-name-nondirectory fn))))))
2338 (let (ido-saved-vc-hb
2339 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
2340 (ido-work-directory-index -1)
2341 (ido-work-file-index -1)
2342 (ido-find-literal nil))
2344 (unless filename
2345 (setq ido-saved-vc-hb vc-handled-backends)
2346 (let ((minibuffer-completing-file-name t))
2347 (setq filename (ido-read-internal item
2348 (or prompt "Find file: ")
2349 'ido-file-history
2350 (and (eq method 'alt-file) buffer-file-name)
2351 (confirm-nonexistent-file-or-buffer) initial))))
2353 ;; Choose the file name: either the text typed in, or the head
2354 ;; of the list of matches
2356 (cond
2357 ((eq ido-exit 'fallback)
2358 ;; Need to guard setting of default-directory here, since
2359 ;; we don't want to change directory of current buffer.
2360 (let ((default-directory ido-current-directory)
2361 (read-file-name-function nil))
2362 (setq this-command (or fallback 'find-file))
2363 (run-hook-with-args 'ido-before-fallback-functions this-command)
2364 (call-interactively this-command)))
2366 ((eq ido-exit 'switch-to-buffer)
2367 (ido-buffer-internal
2368 (if (memq method '(other-window other-frame)) method ido-default-buffer-method)
2369 nil nil nil ido-text))
2371 ((eq ido-exit 'insert-buffer)
2372 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil ido-text 'ido-enter-insert-file))
2374 ((eq ido-exit 'dired)
2375 (dired (concat ido-current-directory (or ido-text ""))))
2377 ((eq ido-exit 'ffap)
2378 (find-file-at-point))
2380 ((eq method 'alt-file)
2381 (ido-record-work-file filename)
2382 (setq default-directory ido-current-directory)
2383 (ido-record-work-directory)
2384 (find-alternate-file filename))
2386 ((memq method '(dired list-directory))
2387 (if (equal filename ".")
2388 (setq filename ""))
2389 (let* ((dirname (ido-final-slash (concat ido-current-directory filename) t))
2390 (file (substring dirname 0 -1)))
2391 (cond
2392 ((file-directory-p dirname)
2393 (ido-record-command method dirname)
2394 (ido-record-work-directory dirname)
2395 (funcall method dirname))
2396 ((file-directory-p ido-current-directory)
2397 (cond
2398 ((file-exists-p file)
2399 (ido-record-command method ido-current-directory)
2400 (ido-record-work-directory)
2401 (funcall method ido-current-directory)
2402 (if (eq method 'dired)
2403 (with-no-warnings
2404 (dired-goto-file (expand-file-name file)))))
2405 ((string-match "[[*?]" filename)
2406 (setq dirname (concat ido-current-directory filename))
2407 (ido-record-command method dirname)
2408 (ido-record-work-directory)
2409 (funcall method dirname))
2410 ((y-or-n-p (format "Directory %s does not exist. Create it? " filename))
2411 (ido-record-command method dirname)
2412 (ido-record-work-directory dirname)
2413 (make-directory-internal dirname)
2414 (funcall method dirname))
2416 ;; put make-directory command on history
2417 (ido-record-command 'make-directory dirname))))
2418 (t (error "No such directory")))))
2420 ((eq method 'write)
2421 (ido-record-work-file filename)
2422 (setq default-directory ido-current-directory)
2423 (setq filename (concat ido-current-directory filename))
2424 (ido-record-command 'write-file filename)
2425 (add-to-history 'file-name-history filename)
2426 (ido-record-work-directory)
2427 (write-file filename t))
2429 ((eq method 'read-only)
2430 (ido-record-work-file filename)
2431 (setq filename (concat ido-current-directory filename))
2432 (ido-record-command fallback filename)
2433 (ido-record-work-directory)
2434 (run-hook-with-args 'ido-before-fallback-functions fallback)
2435 (funcall fallback filename))
2437 ((eq method 'insert)
2438 (ido-record-work-file filename)
2439 (setq filename (concat ido-current-directory filename))
2440 (ido-record-command
2441 (if ido-find-literal 'insert-file-literally 'insert-file)
2442 filename)
2443 (add-to-history 'file-name-history filename)
2444 (ido-record-work-directory)
2445 (insert-file-1 filename
2446 (if ido-find-literal
2447 #'insert-file-contents-literally
2448 #'insert-file-contents)))
2450 (filename
2451 (ido-record-work-file filename)
2452 (setq filename (concat ido-current-directory filename))
2453 (ido-record-command 'find-file filename)
2454 (add-to-history 'file-name-history filename)
2455 (ido-record-work-directory)
2456 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
2458 (defun ido-existing-item-p ()
2459 ;; Return non-nil if there is a matching item
2460 (not (null ido-matches)))
2462 ;;; COMPLETION CODE
2464 (defun ido-set-common-completion ()
2465 ;; Find common completion of `ido-text' in `ido-matches'
2466 ;; The result is stored in `ido-common-match-string'
2467 (let (val)
2468 (setq ido-common-match-string nil)
2469 (if (and ido-matches
2470 (not ido-enable-regexp) ;; testing
2471 (stringp ido-text)
2472 (> (length ido-text) 0))
2473 (if (setq val (ido-find-common-substring ido-matches ido-text))
2474 (setq ido-common-match-string val)))
2475 val))
2477 (defun ido-complete ()
2478 "Try and complete the current pattern amongst the file names."
2479 (interactive)
2480 (let (res)
2481 (cond
2482 (ido-incomplete-regexp
2483 ;; Do nothing
2485 ((and (memq ido-cur-item '(file dir))
2486 (string-match "[$]" ido-text))
2487 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
2488 (if (not (file-exists-p (file-name-directory evar)))
2489 (message "Expansion generates non-existing directory name")
2490 (if (file-directory-p evar)
2491 (ido-set-current-directory evar)
2492 (let ((d (or (file-name-directory evar) "/"))
2493 (f (file-name-nondirectory evar)))
2494 (when (file-directory-p d)
2495 (ido-set-current-directory d)
2496 (setq ido-text-init f))))
2497 (setq ido-exit 'refresh)
2498 (exit-minibuffer))))
2500 (ido-directory-too-big
2501 (setq ido-directory-too-big nil)
2502 (setq ido-text-init ido-text)
2503 (setq ido-exit 'refresh)
2504 (exit-minibuffer))
2506 ((not ido-matches)
2507 (when ido-completion-buffer
2508 (call-interactively (setq this-command ido-cannot-complete-command))))
2510 ((and (= 1 (length ido-matches))
2511 (not (and ido-enable-tramp-completion
2512 (string-equal ido-current-directory "/")
2513 (string-match ".[@:]\\'" (ido-name (car ido-matches)))))
2514 (not (ido-local-file-exists-p (ido-name (car ido-matches)))))
2515 ;; only one choice, so select it.
2516 (if (not ido-confirm-unique-completion)
2517 (exit-minibuffer)
2518 (setq ido-rescan (not ido-enable-prefix))
2519 (delete-region (minibuffer-prompt-end) (point))
2520 (insert (ido-name (car ido-matches)))))
2522 (t ;; else there could be some completions
2523 (setq res ido-common-match-string)
2524 (if (and (not (memq res '(t nil)))
2525 (not (equal res ido-text)))
2526 ;; found something to complete, so put it in the minibuffer.
2527 (progn
2528 ;; move exact match to front if not in prefix mode
2529 (setq ido-rescan (not ido-enable-prefix))
2530 (delete-region (minibuffer-prompt-end) (point))
2531 (insert res))
2532 ;; else nothing to complete
2533 (call-interactively (setq this-command ido-cannot-complete-command))
2534 )))))
2536 (defun ido-complete-space ()
2537 "Try completion unless inserting the space makes sense."
2538 (interactive)
2539 (if (and (stringp ido-common-match-string)
2540 (stringp ido-text)
2541 (cond
2542 ((> (length ido-common-match-string) (length ido-text))
2543 (= (aref ido-common-match-string (length ido-text)) ? ))
2544 (ido-matches
2545 (let (insert-space
2546 (re (concat (regexp-quote ido-text) " "))
2547 (comp ido-matches))
2548 (while comp
2549 (if (string-match re (ido-name (car comp)))
2550 (setq comp nil insert-space t)
2551 (setq comp (cdr comp))))
2552 insert-space))
2553 (t nil)))
2554 (insert " ")
2555 (ido-complete)))
2557 (defun ido-undo-merge-work-directory (&optional text try refresh)
2558 "Undo or redo last ido directory merge operation.
2559 If no merge has yet taken place, toggle automatic merging option."
2560 (interactive)
2561 (cond
2562 (ido-pre-merge-state
2563 (ido-set-current-directory (nth 1 ido-pre-merge-state))
2564 (setq ido-text-init (or text (car ido-pre-merge-state))
2565 ido-cur-list (nth 2 ido-pre-merge-state)
2566 ido-ignored-list (nth 3 ido-pre-merge-state)
2567 ido-matches (nth 4 ido-pre-merge-state)
2568 ido-use-merged-list nil
2569 ido-try-merged-list try
2570 ido-keep-item-list (not refresh)
2571 ido-rescan nil
2572 ido-exit 'refresh
2573 ido-pre-merge-state nil)
2574 (exit-minibuffer))
2575 (text
2576 nil)
2577 (ido-try-merged-list
2578 (setq ido-try-merged-list nil))
2579 (ido-matches
2580 (setq ido-try-merged-list t))
2581 ((not ido-use-merged-list)
2582 (ido-merge-work-directories))))
2584 ;;; Magic C-f
2586 (defun ido-magic-forward-char (arg)
2587 "Move forward in user input or perform magic action.
2588 If no user input is present, or at end of input, perform magic actions:
2589 C-x C-b ... C-f switch to `ido-find-file'.
2590 C-x C-f ... C-f fallback to non-ido `find-file'.
2591 C-x C-d ... C-f fallback to non-ido brief `dired'.
2592 C-x d ... C-f fallback to non-ido `dired'."
2593 (interactive "P")
2594 (cond
2595 ((or arg (not (eobp)))
2596 (forward-char (min (prefix-numeric-value arg)
2597 (- (point-max) (point)))))
2598 ((memq ido-cur-item '(file dir))
2599 (ido-fallback-command))
2600 (ido-context-switch-command
2601 (call-interactively ido-context-switch-command))
2602 ((eq ido-cur-item 'buffer)
2603 (ido-enter-find-file))))
2605 ;;; Magic C-b
2607 (defun ido-magic-backward-char (arg)
2608 "Move backward in user input or perform magic action.
2609 If no user input is present, or at start of input, perform magic actions:
2610 C-x C-f C-b switch to `ido-switch-buffer'.
2611 C-x C-d C-b switch to `ido-switch-buffer'.
2612 C-x d C-b switch to `ido-switch-buffer'.
2613 C-x C-b C-b fallback to non-ido `switch-to-buffer'."
2614 (interactive "P")
2615 (cond
2616 ((or arg (> (point) (minibuffer-prompt-end)))
2617 (forward-char
2618 (- (min (prefix-numeric-value arg)
2619 (- (point) (minibuffer-prompt-end))))))
2620 ((eq last-command this-command)
2621 (when (and (memq ido-cur-item '(file dir))
2622 (not (bobp)))
2623 (ido-push-dir))) ; else do nothing
2624 ((eq ido-cur-item 'buffer)
2625 (ido-fallback-command))
2626 (ido-context-switch-command
2627 (call-interactively ido-context-switch-command))
2629 (ido-enter-switch-buffer))))
2631 ;;; Magic C-d
2633 (defun ido-magic-delete-char (arg)
2634 "Delete following char in user input or perform magic action.
2635 If at end of user input, perform magic actions:
2636 C-x C-f ... C-d enter `dired' on current directory."
2637 (interactive "P")
2638 (cond
2639 ((or arg (not (eobp)))
2640 (delete-char (min (prefix-numeric-value arg)
2641 (- (point-max) (point)))))
2642 (ido-context-switch-command
2643 nil)
2644 ((memq ido-cur-item '(file dir))
2645 (ido-enter-dired))))
2648 ;;; TOGGLE FUNCTIONS
2650 (defun ido-toggle-case ()
2651 "Toggle the value of `ido-case-fold'."
2652 (interactive)
2653 (setq ido-case-fold (not ido-case-fold))
2654 ;; ask for list to be regenerated.
2655 (setq ido-rescan t))
2657 (defun ido-toggle-regexp ()
2658 "Toggle the value of `ido-enable-regexp'."
2659 (interactive)
2660 (setq ido-enable-regexp (not ido-enable-regexp))
2661 ;; ask for list to be regenerated.
2662 (setq ido-rescan t))
2664 (defun ido-toggle-prefix ()
2665 "Toggle the value of `ido-enable-prefix'."
2666 (interactive)
2667 (setq ido-enable-prefix (not ido-enable-prefix))
2668 ;; ask for list to be regenerated.
2669 (setq ido-rescan t))
2671 (defun ido-toggle-ignore ()
2672 "Toggle ignoring files specified with `ido-ignore-files'."
2673 (interactive)
2674 (if (and (not (eobp)) (> (point) (minibuffer-prompt-end)))
2675 (goto-char (minibuffer-prompt-end))
2676 (if ido-directory-too-big
2677 (progn
2678 (message "Reading directory...")
2679 (setq ido-directory-too-big nil))
2680 (setq ido-process-ignore-lists (not ido-process-ignore-lists)))
2681 (setq ido-text-init ido-text)
2682 (setq ido-exit 'refresh)
2683 (exit-minibuffer)))
2685 (defun ido-toggle-vc ()
2686 "Disable version control for this file."
2687 (interactive)
2688 (if (and ido-mode (eq ido-cur-item 'file))
2689 (progn
2690 (setq vc-handled-backends
2691 (if vc-handled-backends nil ido-saved-vc-hb))
2692 (setq ido-text-init ido-text)
2693 (setq ido-exit 'keep)
2694 (exit-minibuffer))))
2696 (defun ido-toggle-literal ()
2697 "Toggle literal reading of this file."
2698 (interactive)
2699 (if (and ido-mode (eq ido-cur-item 'file))
2700 (progn
2701 (setq ido-find-literal (not ido-find-literal))
2702 (setq ido-text-init ido-text)
2703 (setq ido-exit 'keep)
2704 (exit-minibuffer))))
2706 (defun ido-toggle-virtual-buffers ()
2707 "Toggle the use of virtual buffers.
2708 See `ido-use-virtual-buffers' for explanation of virtual buffer."
2709 (interactive)
2710 (when (and ido-mode (eq ido-cur-item 'buffer))
2711 (setq ido-use-virtual-buffers (not ido-use-virtual-buffers))
2712 (setq ido-text-init ido-text)
2713 (setq ido-exit 'refresh)
2714 (exit-minibuffer)))
2716 (defun ido-reread-directory ()
2717 "Read current directory again.
2718 May be useful if cached version is no longer valid, but directory
2719 timestamp has not changed (e.g. with ftp or on Windows)."
2720 (interactive)
2721 (if (and ido-mode (memq ido-cur-item '(file dir)))
2722 (progn
2723 (if (ido-is-unc-root)
2724 (setq ido-unc-hosts-cache t)
2725 (ido-remove-cached-dir ido-current-directory))
2726 (setq ido-text-init ido-text)
2727 (setq ido-rotate-temp t)
2728 (setq ido-exit 'refresh)
2729 (exit-minibuffer))))
2731 (defun ido-exit-minibuffer ()
2732 "Exit minibuffer, but make sure we have a match if one is needed."
2733 (interactive)
2734 (if (and (or (not ido-require-match)
2735 (if (memq ido-require-match '(confirm confirm-after-completion))
2736 (if (or (eq ido-cur-item 'dir)
2737 (eq last-command this-command))
2739 (setq ido-show-confirm-message t)
2740 nil))
2741 (ido-existing-item-p))
2742 (not ido-incomplete-regexp))
2743 (exit-minibuffer)))
2745 (defun ido-select-text ()
2746 "Select the buffer or file named by the prompt.
2747 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2748 (interactive)
2749 (setq ido-exit 'takeprompt)
2750 (exit-minibuffer))
2752 (defun ido-fallback-command ()
2753 "Fallback to non-ido version of current command."
2754 (interactive)
2755 (let ((i (length ido-text)))
2756 (while (> i 0)
2757 (push (aref ido-text (setq i (1- i))) unread-command-events)))
2758 (setq ido-exit 'fallback)
2759 (exit-minibuffer))
2761 (defun ido-enter-find-file ()
2762 "Drop into `find-file' from buffer switching."
2763 (interactive)
2764 (setq ido-exit 'find-file)
2765 (exit-minibuffer))
2767 (defun ido-enter-switch-buffer ()
2768 "Drop into `ido-switch-buffer' from file switching."
2769 (interactive)
2770 (setq ido-exit 'switch-to-buffer)
2771 (exit-minibuffer))
2773 (defun ido-enter-dired ()
2774 "Drop into `dired' from file switching."
2775 (interactive)
2776 (setq ido-exit 'dired)
2777 (exit-minibuffer))
2779 (defun ido-enter-insert-buffer ()
2780 "Drop into `insert-buffer' from insert file."
2781 (interactive)
2782 (setq ido-exit 'insert-buffer)
2783 (exit-minibuffer))
2785 (defun ido-enter-insert-file ()
2786 "Drop into `insert-file' from insert buffer."
2787 (interactive)
2788 (setq ido-exit 'insert-file)
2789 (exit-minibuffer))
2792 (defun ido-up-directory (&optional clear)
2793 "Go up one directory level."
2794 (interactive "P")
2795 (setq ido-text-init (if clear nil ido-text))
2796 (setq ido-exit 'updir)
2797 (setq ido-rotate-temp t)
2798 (exit-minibuffer))
2800 (defun ido-delete-backward-updir (count)
2801 "Delete char backwards, or at beginning of buffer, go up one level."
2802 (interactive "P")
2803 (cond
2804 ((= (minibuffer-prompt-end) (point))
2805 (if (not count)
2806 (ido-up-directory t)))
2807 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2808 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2809 ((eq this-original-command 'viper-backward-char)
2810 (funcall this-original-command (prefix-numeric-value count)))
2811 ((eq this-original-command 'viper-del-backward-char-in-insert)
2812 (funcall this-original-command))
2814 (delete-char (- (prefix-numeric-value count))))))
2816 (defun ido-delete-backward-word-updir (count)
2817 "Delete all chars backwards, or at beginning of buffer, go up one level."
2818 (interactive "P")
2819 (if (= (minibuffer-prompt-end) (point))
2820 (if (not count)
2821 (ido-up-directory t))
2822 (if (eq this-original-command 'viper-delete-backward-word)
2823 (funcall this-original-command (prefix-numeric-value count))
2824 (backward-kill-word (prefix-numeric-value count)))))
2826 (defun ido-get-work-directory (&optional incr must-match)
2827 (let ((n (length ido-work-directory-list))
2828 (i ido-work-directory-index)
2829 (j 0)
2830 dir)
2831 (if (or (not ido-text) (= (length ido-text) 0))
2832 (setq must-match nil))
2833 (while (< j n)
2834 (setq i (+ i incr)
2835 j (1+ j))
2836 (if (> incr 0)
2837 (if (>= i n) (setq i 0))
2838 (if (< i 0) (setq i (1- n))))
2839 (setq dir (nth i ido-work-directory-list))
2840 (if (and dir
2841 (not (equal dir ido-current-directory))
2842 (file-directory-p dir)
2843 (or (not must-match)
2844 ;; TODO. check for nonreadable and too-big.
2845 (ido-set-matches-1
2846 (if (eq ido-cur-item 'file)
2847 (ido-make-file-list-1 dir)
2848 (ido-make-dir-list-1 dir)))))
2849 (setq j n)
2850 (setq dir nil)))
2851 (if dir
2852 (setq ido-work-directory-index i))
2853 dir))
2855 (defun ido-prev-work-directory ()
2856 "Change to next working directory in list."
2857 (interactive)
2858 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2859 (when dir
2860 (ido-set-current-directory dir)
2861 (setq ido-exit 'refresh)
2862 (setq ido-text-init ido-text)
2863 (setq ido-rotate-temp t)
2864 (exit-minibuffer))))
2866 (defun ido-next-work-directory ()
2867 "Change to previous working directory in list."
2868 (interactive)
2869 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2870 (when dir
2871 (ido-set-current-directory dir)
2872 (setq ido-exit 'refresh)
2873 (setq ido-text-init ido-text)
2874 (setq ido-rotate-temp t)
2875 (exit-minibuffer))))
2877 (defun ido-merge-work-directories ()
2878 "Search (and merge) work directories for files matching the current input string."
2879 (interactive)
2880 (setq ido-use-merged-list t ido-try-merged-list t)
2881 (setq ido-exit 'refresh)
2882 (setq ido-text-init ido-text)
2883 (setq ido-rotate-temp t)
2884 (exit-minibuffer))
2886 (defun ido-wide-find-file (&optional file)
2887 "Prompt for FILE to search for using find, starting from current directory."
2888 (interactive)
2889 (unless file
2890 (let ((enable-recursive-minibuffers t))
2891 (setq file
2892 (condition-case nil
2893 (read-string (concat "Wide find file: " ido-current-directory) ido-text)
2894 (quit "")))))
2895 (when (> (length file) 0)
2896 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2897 (setq ido-exit 'refresh)
2898 (setq ido-text-init file)
2899 (setq ido-rotate-temp t)
2900 (exit-minibuffer)))
2902 (defun ido-wide-find-dir (&optional dir)
2903 "Prompt for DIR to search for using find, starting from current directory."
2904 (interactive)
2905 (unless dir
2906 (let ((enable-recursive-minibuffers t))
2907 (setq dir
2908 (condition-case nil
2909 (read-string (concat "Wide find directory: " ido-current-directory) ido-text)
2910 (quit "")))))
2911 (when (> (length dir) 0)
2912 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2913 (setq ido-exit 'refresh)
2914 (setq ido-text-init (ido-final-slash dir t))
2915 (setq ido-rotate-temp t)
2916 (exit-minibuffer)))
2918 (defun ido-wide-find-dir-or-delete-dir (&optional _dir)
2919 "Prompt for DIR to search for using find, starting from current directory.
2920 If input stack is non-empty, delete current directory component."
2921 (interactive)
2922 (if ido-input-stack
2923 (ido-delete-backward-word-updir 1)
2924 (ido-wide-find-dir)))
2926 (defun ido-take-first-match ()
2927 "Use first matching item as input text."
2928 (interactive)
2929 (when ido-matches
2930 (setq ido-text-init (ido-name (car ido-matches)))
2931 (setq ido-exit 'refresh)
2932 (exit-minibuffer)))
2934 (defun ido-push-dir ()
2935 "Move to previous directory in file name, push current input on stack."
2936 (interactive)
2937 (setq ido-exit 'push)
2938 (exit-minibuffer))
2940 (defun ido-push-dir-first ()
2941 "Move to previous directory in file name, push first match on stack."
2942 (interactive)
2943 (if ido-matches
2944 (setq ido-text (ido-name (car ido-matches))))
2945 (setq ido-exit 'push)
2946 (exit-minibuffer))
2948 (defun ido-pop-dir (arg)
2949 "Pop directory from input stack back to input.
2950 With \\[universal-argument], pop all elements."
2951 (interactive "P")
2952 (when ido-input-stack
2953 (setq ido-exit (if arg 'pop-all 'pop))
2954 (exit-minibuffer)))
2956 (defun ido-wide-find-file-or-pop-dir (arg)
2957 (interactive "P")
2958 (if ido-input-stack
2959 (ido-pop-dir arg)
2960 (ido-wide-find-file)))
2962 (defun ido-make-directory (&optional dir)
2963 "Prompt for DIR to create in current directory."
2964 (interactive)
2965 (unless dir
2966 (let ((enable-recursive-minibuffers t))
2967 (setq dir
2968 (read-string (concat "Make directory: " ido-current-directory) ido-text))))
2969 (when (> (length dir) 0)
2970 (setq dir (concat ido-current-directory dir))
2971 (unless (file-exists-p dir)
2972 (make-directory dir t)
2973 (ido-set-current-directory dir)
2974 (setq ido-exit 'refresh)
2975 (setq ido-text-init nil)
2976 (setq ido-rotate-temp t)
2977 (exit-minibuffer))))
2979 (defun ido-get-work-file (incr)
2980 (let ((n (length ido-work-file-list))
2981 (i (+ ido-work-file-index incr))
2982 name)
2983 (if (> incr 0)
2984 (if (>= i n) (setq i 0))
2985 (if (< i 0) (setq i (1- n))))
2986 (setq name (nth i ido-work-file-list))
2987 (setq ido-work-file-index i)
2988 name))
2990 (defun ido-prev-work-file ()
2991 "Change to next working file name in list."
2992 (interactive)
2993 (let ((name (ido-get-work-file 1)))
2994 (when name
2995 (setq ido-text-init name)
2996 (setq ido-exit 'refresh)
2997 (exit-minibuffer))))
2999 (defun ido-next-work-file ()
3000 "Change to previous working file name in list."
3001 (interactive)
3002 (let ((name (ido-get-work-file -1)))
3003 (when name
3004 (setq ido-text-init name)
3005 (setq ido-exit 'refresh)
3006 (exit-minibuffer))))
3008 (defun ido-copy-current-file-name (all)
3009 "Insert file name of current buffer.
3010 If repeated, insert text from buffer instead."
3011 (interactive "P")
3012 (let* ((bfname (or (buffer-file-name ido-entry-buffer)
3013 (buffer-name ido-entry-buffer)))
3014 (name (and bfname (file-name-nondirectory bfname))))
3015 (when name
3016 (setq ido-text-init
3017 (if (or all
3018 (eq last-command this-command)
3019 (not (equal (file-name-directory bfname) ido-current-directory))
3020 (not (string-match "\\.[^.]*\\'" name)))
3021 name
3022 (substring name 0 (1+ (match-beginning 0)))))
3023 (setq ido-exit 'refresh
3024 ido-try-merged-list nil)
3025 (exit-minibuffer))))
3027 (defun ido-copy-current-word (_all)
3028 "Insert current word (file or directory name) from current buffer."
3029 (interactive "P")
3030 (let ((word (with-current-buffer ido-entry-buffer
3031 (let ((p (point)) start-line end-line start-name)
3032 (if (and mark-active (/= p (mark)))
3033 (setq start-name (mark))
3034 (beginning-of-line)
3035 (setq start-line (point))
3036 (end-of-line)
3037 (setq end-line (point))
3038 (goto-char p)
3039 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
3040 (forward-char 1))
3041 (setq start-name (point))
3042 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
3043 (if (= start-name (point))
3044 (setq start-name nil)))
3045 (and start-name
3046 (buffer-substring-no-properties start-name (point)))))))
3047 (if (cond
3048 ((not word) nil)
3049 ((string-match "\\`[~/]" word)
3050 (setq ido-text-init word
3051 ido-try-merged-list nil
3052 ido-exit 'chdir))
3053 ((string-match "/" word)
3054 (setq ido-text-init (concat ido-current-directory word)
3055 ido-try-merged-list nil
3056 ido-exit 'chdir))
3058 (setq ido-text-init word
3059 ido-try-merged-list nil
3060 ido-exit 'refresh)))
3061 (exit-minibuffer))))
3063 (defun ido-next-match ()
3064 "Put first element of `ido-matches' at the end of the list."
3065 (interactive)
3066 (if ido-matches
3067 (let ((next (cadr ido-matches)))
3068 (setq ido-cur-list (ido-chop ido-cur-list next))
3069 (setq ido-matches (ido-chop ido-matches next))
3070 (setq ido-rescan nil))))
3072 (defun ido-prev-match ()
3073 "Put last element of `ido-matches' at the front of the list."
3074 (interactive)
3075 (if ido-matches
3076 (let ((prev (car (last ido-matches))))
3077 (setq ido-cur-list (ido-chop ido-cur-list prev))
3078 (setq ido-matches (ido-chop ido-matches prev))
3079 (setq ido-rescan nil))))
3081 (defun ido-next-match-dir ()
3082 "Find next directory in match list.
3083 If work directories have been merged, cycle through directories for
3084 first matching file."
3085 (interactive)
3086 (if ido-use-merged-list
3087 (if ido-matches
3088 (let* ((elt (car ido-matches))
3089 (dirs (cdr elt)))
3090 (when (> (length dirs) 1)
3091 (setcdr elt (ido-chop dirs (cadr dirs))))
3092 (setq ido-rescan nil)))
3093 (let ((cnt (length ido-matches))
3094 (i 1))
3095 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
3096 (setq i (1+ i)))
3097 (if (< i cnt)
3098 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3100 (defun ido-prev-match-dir ()
3101 "Find previous directory in match list.
3102 If work directories have been merged, cycle through directories
3103 for first matching file."
3104 (interactive)
3105 (if ido-use-merged-list
3106 (if ido-matches
3107 (let* ((elt (car ido-matches))
3108 (dirs (cdr elt)))
3109 (when (> (length dirs) 1)
3110 (setcdr elt (ido-chop dirs (car (last dirs)))))
3111 (setq ido-rescan nil)))
3112 (let* ((cnt (length ido-matches))
3113 (i (1- cnt)))
3114 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
3115 (setq i (1- i)))
3116 (if (> i 0)
3117 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3119 (defun ido-restrict-to-matches ()
3120 "Set current item list to the currently matched items."
3121 (interactive)
3122 (when ido-matches
3123 (setq ido-cur-list ido-matches
3124 ido-text-init ""
3125 ido-rescan nil
3126 ido-exit 'keep)
3127 (exit-minibuffer)))
3129 (defun ido-chop (items elem)
3130 "Remove all elements before ELEM and put them at the end of ITEMS."
3131 (let ((ret nil)
3132 (next nil)
3133 (sofar nil))
3134 (while (not ret)
3135 (setq next (car items))
3136 (if (equal next elem)
3137 (setq ret (append items (nreverse sofar)))
3138 ;; else
3139 (progn
3140 (setq items (cdr items))
3141 (setq sofar (cons next sofar)))))
3142 ret))
3144 (defun ido-name (item)
3145 ;; Return file name for current item, whether in a normal list
3146 ;; or a merged work directory list.
3147 (if (consp item) (car item) item))
3150 ;;; CREATE LIST OF ALL CURRENT FILES
3152 (defun ido-all-completions ()
3153 ;; Return unsorted list of all competions.
3154 (let ((ido-process-ignore-lists nil)
3155 (ido-directory-too-big nil))
3156 (cond
3157 ((eq ido-cur-item 'file)
3158 (ido-make-file-list-1 ido-current-directory))
3159 ((eq ido-cur-item 'dir)
3160 (ido-make-dir-list-1 ido-current-directory))
3161 ((eq ido-cur-item 'buffer)
3162 (ido-make-buffer-list-1))
3163 ((eq ido-cur-item 'list)
3164 ido-choice-list)
3165 (t nil))))
3168 ;; File list sorting
3170 (defun ido-file-lessp (a b)
3171 ;; Simple compare two file names.
3172 (string-lessp (ido-no-final-slash a) (ido-no-final-slash b)))
3175 (defun ido-file-extension-lessp (a b)
3176 ;; Compare file names according to ido-file-extensions-order list.
3177 (let ((n (compare-strings a 0 nil b 0 nil nil))
3178 lessp p)
3179 (if (eq n t)
3181 (if (< n 0)
3182 (setq n (1- (- n))
3183 p a a b b p
3184 lessp t)
3185 (setq n (1- n)))
3186 (cond
3187 ((= n 0)
3188 lessp)
3189 ((= (aref a n) ?.)
3190 (ido-file-extension-aux a b n lessp))
3192 (while (and (> n 2) (/= (aref a n) ?.))
3193 (setq n (1- n)))
3194 (if (> n 1)
3195 (ido-file-extension-aux a b n lessp)
3196 lessp))))))
3198 (defun ido-file-extension-aux (a b n lessp)
3199 (let ((oa (ido-file-extension-order a n))
3200 (ob (ido-file-extension-order b n)))
3201 (cond
3202 ((and oa ob)
3203 (cond
3204 ((= oa ob)
3205 lessp)
3206 (lessp
3207 (> oa ob))
3209 (< oa ob))))
3211 (not lessp))
3213 lessp)
3215 lessp))))
3217 (defun ido-file-extension-order (s n)
3218 (let ((l ido-file-extensions-order)
3219 (i 0) o do)
3220 (while l
3221 (cond
3222 ((eq (car l) t)
3223 (setq do i
3224 l (cdr l)))
3225 ((eq (compare-strings s n nil (car l) 0 nil nil) t)
3226 (setq o i
3227 l nil))
3229 (setq l (cdr l))))
3230 (setq i (1+ i)))
3231 (or o do)))
3234 (defun ido-sort-merged-list (items promote)
3235 ;; Input is list of ("file" . "dir") cons cells.
3236 ;; Output is sorted list of ("file "dir" ...) lists
3237 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
3238 res a cur)
3239 (while l
3240 (setq a (car l)
3241 l (cdr l))
3242 (if (and res (string-equal (car (car res)) (car a)))
3243 (progn
3244 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
3245 (if (and promote (string-equal ido-current-directory (cdr a)))
3246 (setq cur t)))
3247 (setq res (cons (list (car a) (cdr a)) res)
3248 cur nil)))
3249 res))
3251 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
3252 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
3253 (let ((filenames
3254 (split-string
3255 (shell-command-to-string
3256 (concat "find "
3257 (shell-quote-argument dir)
3258 " -name "
3259 (shell-quote-argument
3260 (concat (if prefix "" "*") file "*"))
3261 " -type " (if finddir "d" "f") " -print"))))
3262 filename d f
3263 res)
3264 (while filenames
3265 (setq filename (car filenames)
3266 filenames (cdr filenames))
3267 (if (and (string-match "^/" filename)
3268 (file-exists-p filename))
3269 (setq d (file-name-directory filename)
3270 f (file-name-nondirectory filename)
3271 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
3272 res))
3274 (defun ido-flatten-merged-list (items)
3275 ;; Create a list of directory names based on a merged directory list.
3276 (let (res)
3277 (while items
3278 (let* ((item (car items))
3279 (file (car item))
3280 (dirs (cdr item)))
3281 (while dirs
3282 (setq res (cons (concat (car dirs) file) res)
3283 dirs (cdr dirs))))
3284 (setq items (cdr items)))
3285 res))
3288 (defun ido-make-merged-file-list-1 (text auto wide)
3289 (let (res)
3290 (if (and (ido-final-slash text) ido-dir-file-cache)
3291 (if wide
3292 (setq res (ido-wide-find-dirs-or-files
3293 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
3294 ;; Use list of cached directories
3295 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
3296 (dirs ido-dir-file-cache)
3297 dir b d f)
3298 (if nil ;; simple
3299 (while dirs
3300 (setq dir (car (car dirs))
3301 dirs (cdr dirs))
3302 (when (and (string-match re dir)
3303 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
3304 (file-directory-p dir))
3305 (setq b (substring dir 0 -1)
3306 f (concat (file-name-nondirectory b) "/")
3307 d (file-name-directory b)
3308 res (cons (cons f d) res))))
3309 (while dirs
3310 (setq dir (car dirs)
3311 d (car dir)
3312 dirs (cdr dirs))
3313 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
3314 (setq dir (cdr (cdr dir)))
3315 (while dir
3316 (setq f (car dir)
3317 dir (cdr dir))
3318 (if (and (string-match re f)
3319 (not (ido-ignore-item-p f ido-ignore-directories)))
3320 (setq res (cons (cons f d) res)))))
3321 (if (and auto (input-pending-p))
3322 (setq dirs nil
3323 res t))))))
3324 (if wide
3325 (setq res (ido-wide-find-dirs-or-files
3326 ido-current-directory text ido-enable-prefix nil))
3327 (let ((ido-text text)
3328 (dirs ido-work-directory-list)
3329 (must-match (and text (> (length text) 0)))
3330 dir fl)
3331 (if (and auto (not (member ido-current-directory dirs)))
3332 (setq dirs (cons ido-current-directory dirs)))
3333 (while dirs
3334 (setq dir (car dirs)
3335 dirs (cdr dirs))
3336 (when (and dir (stringp dir)
3337 (or ido-merge-ftp-work-directories
3338 (not (ido-is-ftp-directory dir)))
3339 (file-directory-p dir)
3340 ;; TODO. check for nonreadable and too-big.
3341 (setq fl (if (eq ido-cur-item 'file)
3342 (ido-make-file-list-1 dir t)
3343 (ido-make-dir-list-1 dir t))))
3344 (if must-match
3345 (setq fl (ido-set-matches-1 fl)))
3346 (if fl
3347 (setq res (nconc fl res))))
3348 (if (and auto (input-pending-p))
3349 (setq dirs nil
3350 res t))))))
3351 res))
3353 (defun ido-make-merged-file-list (text auto wide)
3354 (let (res)
3355 (message "Searching for `%s'...." text)
3356 (condition-case nil
3357 (if (eq t (setq res
3358 (while-no-input
3359 (ido-make-merged-file-list-1 text auto wide))))
3360 (setq res 'input-pending-p))
3361 (quit
3362 (setq res t
3363 ido-try-merged-list nil
3364 ido-use-merged-list nil)))
3365 (when (and res (listp res))
3366 (setq res (ido-sort-merged-list res auto)))
3367 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
3368 (listp res)
3369 (> (length text) 0))
3370 (let ((elt (assoc text res)))
3371 (when (and elt (not (eq elt (car res))))
3372 (setq res (delq elt res))
3373 (setq res (cons elt res)))))
3374 (message nil)
3375 res))
3377 (defun ido-make-buffer-list-1 (&optional frame visible)
3378 ;; Return list of non-ignored buffer names
3379 (delq nil
3380 (mapcar
3381 (lambda (x)
3382 (let ((name (buffer-name x)))
3383 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
3384 name)))
3385 (buffer-list frame))))
3387 (defun ido-make-buffer-list (default)
3388 ;; Return the current list of buffers.
3389 ;; Currently visible buffers are put at the end of the list.
3390 ;; The hook `ido-make-buffer-list-hook' is run after the list has been
3391 ;; created to allow the user to further modify the order of the buffer names
3392 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
3393 ;; it is put to the start of the list.
3394 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
3395 (ido-temp-list (ido-make-buffer-list-1 (selected-frame) ido-current-buffers)))
3396 (if ido-temp-list
3397 (nconc ido-temp-list ido-current-buffers)
3398 (setq ido-temp-list ido-current-buffers))
3399 (if default
3400 (setq ido-temp-list
3401 (cons default (delete default ido-temp-list))))
3402 (if ido-use-virtual-buffers
3403 (ido-add-virtual-buffers-to-list))
3404 (run-hooks 'ido-make-buffer-list-hook)
3405 ido-temp-list))
3407 (defun ido-add-virtual-buffers-to-list ()
3408 "Add recently visited files, and bookmark files, to the buffer list.
3409 This is to make them appear as if they were \"virtual buffers\"."
3410 ;; If no buffers matched, and virtual buffers are being used, then
3411 ;; consult the list of past visited files, to see if we can find
3412 ;; the file which the user might thought was still open.
3413 (unless recentf-mode (recentf-mode 1))
3414 (setq ido-virtual-buffers nil)
3415 (let (name)
3416 (dolist (head recentf-list)
3417 (and (setq name (file-name-nondirectory head))
3418 (null (get-file-buffer head))
3419 (not (assoc name ido-virtual-buffers))
3420 (not (member name ido-temp-list))
3421 (not (ido-ignore-item-p name ido-ignore-buffers))
3422 ;;(file-exists-p head)
3423 (push (cons name head) ido-virtual-buffers))))
3424 (when ido-virtual-buffers
3425 (if ido-use-faces
3426 (dolist (comp ido-virtual-buffers)
3427 (put-text-property 0 (length (car comp))
3428 'face 'ido-virtual
3429 (car comp))))
3430 (setq ido-temp-list
3431 (nconc ido-temp-list
3432 (nreverse (mapcar #'car ido-virtual-buffers))))))
3434 (defun ido-make-choice-list (default)
3435 ;; Return the current list of choices.
3436 ;; If DEFAULT is non-nil, and corresponds to an element of choices,
3437 ;; it is put to the start of the list.
3438 (let ((ido-temp-list ido-choice-list))
3439 (if default
3440 (progn
3441 (setq ido-temp-list
3442 (delete default ido-temp-list))
3443 (setq ido-temp-list
3444 (cons default ido-temp-list))))
3445 ; (run-hooks 'ido-make-choice-list-hook)
3446 ido-temp-list))
3448 (defun ido-to-end (items)
3449 ;; Move the elements from ITEMS to the end of `ido-temp-list'
3450 (mapc
3451 (lambda (elem)
3452 (setq ido-temp-list (delq elem ido-temp-list)))
3453 items)
3454 (if ido-temp-list
3455 (nconc ido-temp-list items)
3456 (setq ido-temp-list items)))
3458 (declare-function tramp-tramp-file-p "tramp" (name))
3460 (defun ido-file-name-all-completions-1 (dir)
3461 (cond
3462 ((ido-nonreadable-directory-p dir) '())
3463 ;; do not check (ido-directory-too-big-p dir) here.
3464 ;; Caller must have done that if necessary.
3466 ((and ido-enable-tramp-completion
3467 (or (fboundp 'tramp-completion-mode-p)
3468 (require 'tramp nil t))
3469 (string-match "\\`/[^/]+[:@]\\'" dir))
3470 ;; Strip method:user@host: part of tramp completions.
3471 ;; Tramp completions do not include leading slash.
3472 (let* ((len (1- (length dir)))
3473 (non-essential t)
3474 (compl
3475 (or (file-name-all-completions "" dir)
3476 ;; work around bug in ange-ftp.
3477 ;; /ftp:user@host: => nil
3478 ;; /ftp:user@host:./ => ok
3479 (and
3480 (not (string= "/ftp:" dir))
3481 (tramp-tramp-file-p dir)
3482 (fboundp 'tramp-ftp-file-name-p)
3483 (funcall 'tramp-ftp-file-name-p dir)
3484 (string-match ":\\'" dir)
3485 (file-name-all-completions "" (concat dir "./"))))))
3486 (if (and compl
3487 (> (length (car compl)) len)
3488 (string= (substring (car compl) 0 len) (substring dir 1)))
3489 (mapcar (lambda (c) (substring c len)) compl)
3490 compl)))
3492 (file-name-all-completions "" dir))))
3494 (defun ido-file-name-all-completions (dir)
3495 ;; Return name of all files in DIR
3496 ;; Uses and updates ido-dir-file-cache
3497 (cond
3498 ((ido-is-unc-root dir)
3499 (mapcar
3500 (lambda (host)
3501 (if (string-match "/\\'" host) host (concat host "/")))
3502 (ido-unc-hosts t)))
3503 ((and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
3504 (stringp dir) (> (length dir) 0)
3505 (ido-may-cache-directory dir))
3506 (let* ((cached (assoc dir ido-dir-file-cache))
3507 (ctime (nth 1 cached))
3508 (ftp (ido-is-ftp-directory dir))
3509 (unc (ido-is-unc-host dir))
3510 (attr (if (or ftp unc) nil (file-attributes dir)))
3511 (mtime (nth 5 attr))
3512 valid)
3513 (when cached ; should we use the cached entry ?
3514 (cond
3515 (ftp
3516 (setq valid (and (eq (car ctime) 'ftp)
3517 (ido-cache-ftp-valid (cdr ctime)))))
3518 (unc
3519 (setq valid (and (eq (car ctime) 'unc)
3520 (ido-cache-unc-valid (cdr ctime)))))
3522 (if attr
3523 (setq valid (and (= (car ctime) (car mtime))
3524 (= (car (cdr ctime)) (car (cdr mtime))))))))
3525 (unless valid
3526 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
3527 cached nil)))
3528 (unless cached
3529 (cond
3530 (unc
3531 (setq mtime (cons 'unc (ido-time-stamp))))
3532 ((and ftp (file-readable-p dir))
3533 (setq mtime (cons 'ftp (ido-time-stamp)))))
3534 (if mtime
3535 (setq cached (cons dir (cons mtime (ido-file-name-all-completions-1 dir)))
3536 ido-dir-file-cache (cons cached ido-dir-file-cache)))
3537 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
3538 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
3539 (and cached
3540 (cdr (cdr cached)))))
3542 (ido-file-name-all-completions-1 dir))))
3544 (defun ido-remove-cached-dir (dir)
3545 ;; Remove dir from ido-dir-file-cache
3546 (if (and ido-dir-file-cache
3547 (stringp dir) (> (length dir) 0))
3548 (let ((cached (assoc dir ido-dir-file-cache)))
3549 (if cached
3550 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
3553 (defun ido-make-file-list-1 (dir &optional merged)
3554 ;; Return list of non-ignored files in DIR
3555 ;; If MERGED is non-nil, each file is cons'ed with DIR
3556 (and (or (ido-is-tramp-root dir) (ido-is-unc-root dir)
3557 (file-directory-p dir))
3558 (delq nil
3559 (mapcar
3560 (lambda (name)
3561 (if (not (ido-ignore-item-p name ido-ignore-files t))
3562 (if merged (cons name dir) name)))
3563 (ido-file-name-all-completions dir)))))
3565 (defun ido-make-file-list (default)
3566 ;; Return the current list of files.
3567 ;; Currently visible files are put at the end of the list.
3568 ;; The hook `ido-make-file-list-hook' is run after the list has been
3569 ;; created to allow the user to further modify the order of the file names
3570 ;; in this list.
3571 (let ((ido-temp-list (ido-make-file-list-1 ido-current-directory)))
3572 (setq ido-temp-list (sort ido-temp-list
3573 (if ido-file-extensions-order
3574 #'ido-file-extension-lessp
3575 #'ido-file-lessp)))
3576 (unless (ido-is-tramp-root ido-current-directory)
3577 (let ((default-directory ido-current-directory))
3578 (ido-to-end ;; move ftp hosts and visited files to end
3579 (delq nil (mapcar
3580 (lambda (x) (if (or (and (string-match ".:\\'" x)
3581 (not (ido-local-file-exists-p x)))
3582 (and (not (ido-final-slash x))
3583 (let (file-name-handler-alist)
3584 (get-file-buffer x)))) x))
3585 ido-temp-list)))))
3586 (ido-to-end ;; move . files to end
3587 (delq nil (mapcar
3588 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3589 ido-temp-list)))
3590 (if (and default (member default ido-temp-list))
3591 (if (or ido-rotate-temp ido-rotate-file-list-default)
3592 (unless (equal default (car ido-temp-list))
3593 (let ((l ido-temp-list) k)
3594 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3595 (setq l (cdr l)))
3596 (setq k (cdr l))
3597 (setcdr l nil)
3598 (nconc k ido-temp-list)
3599 (setq ido-temp-list k)))
3600 (setq ido-temp-list
3601 (delete default ido-temp-list))
3602 (setq ido-temp-list
3603 (cons default ido-temp-list))))
3604 (when ido-show-dot-for-dired
3605 (setq ido-temp-list (delete "." ido-temp-list))
3606 (setq ido-temp-list (cons "." ido-temp-list)))
3607 (run-hooks 'ido-make-file-list-hook)
3608 ido-temp-list))
3610 (defun ido-make-dir-list-1 (dir &optional merged)
3611 ;; Return list of non-ignored subdirs in DIR
3612 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
3613 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
3614 (delq nil
3615 (mapcar
3616 (lambda (name)
3617 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
3618 (if merged (cons name dir) name)))
3619 (ido-file-name-all-completions dir)))))
3621 (defun ido-make-dir-list (default)
3622 ;; Return the current list of directories.
3623 ;; The hook `ido-make-dir-list-hook' is run after the list has been
3624 ;; created to allow the user to further modify the order of the
3625 ;; directory names in this list.
3626 (let ((ido-temp-list (ido-make-dir-list-1 ido-current-directory)))
3627 (setq ido-temp-list (sort ido-temp-list #'ido-file-lessp))
3628 (ido-to-end ;; move . files to end
3629 (delq nil (mapcar
3630 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3631 ido-temp-list)))
3632 (if (and default (member default ido-temp-list))
3633 (if (or ido-rotate-temp ido-rotate-file-list-default)
3634 (unless (equal default (car ido-temp-list))
3635 (let ((l ido-temp-list) k)
3636 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3637 (setq l (cdr l)))
3638 (setq k (cdr l))
3639 (setcdr l nil)
3640 (nconc k ido-temp-list)
3641 (setq ido-temp-list k)))
3642 (setq ido-temp-list
3643 (delete default ido-temp-list))
3644 (setq ido-temp-list
3645 (cons default ido-temp-list))))
3646 (setq ido-temp-list (delete "." ido-temp-list))
3647 (unless ido-input-stack
3648 (setq ido-temp-list (cons "." ido-temp-list)))
3649 (run-hooks 'ido-make-dir-list-hook)
3650 ido-temp-list))
3652 ;; List of the files visible in the current frame.
3653 (defvar ido-bufs-in-frame)
3655 (defun ido-get-buffers-in-frames (&optional current)
3656 ;; Return the list of buffers that are visible in the current frame.
3657 ;; If optional argument `current' is given, restrict searching to the
3658 ;; current frame, rather than all frames, regardless of value of
3659 ;; `ido-all-frames'.
3660 (let ((ido-bufs-in-frame nil))
3661 (walk-windows 'ido-get-bufname nil
3662 (if current
3664 ido-all-frames))
3665 ido-bufs-in-frame))
3667 (defun ido-get-bufname (win)
3668 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
3669 (let ((buf (buffer-name (window-buffer win))))
3670 (unless (or (member buf ido-bufs-in-frame)
3671 (member buf ido-ignore-item-temp-list))
3672 ;; Only add buf if it is not already in list.
3673 ;; This prevents same buf in two different windows being
3674 ;; put into the list twice.
3675 (setq ido-bufs-in-frame
3676 (cons buf ido-bufs-in-frame)))))
3678 ;;; FIND MATCHING ITEMS
3680 (defun ido-set-matches-1 (items &optional do-full)
3681 ;; Return list of matches in items
3682 (let* ((case-fold-search ido-case-fold)
3683 (slash (and (not ido-enable-prefix) (ido-final-slash ido-text)))
3684 (text (if slash (substring ido-text 0 -1) ido-text))
3685 (rex0 (if ido-enable-regexp text (regexp-quote text)))
3686 (rexq (concat rex0 (if slash ".*/" "")))
3687 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
3688 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" rex0))
3689 (concat "\\`" rex0 (if slash "/" "") "\\'")))
3690 (suffix-re (and do-full slash
3691 (not ido-enable-regexp) (not (string-match "\$\\'" rex0))
3692 (concat rex0 "/\\'")))
3693 (prefix-re (and full-re (not ido-enable-prefix)
3694 (concat "\\`" rexq)))
3695 (non-prefix-dot (or (not ido-enable-dot-prefix)
3696 (not ido-process-ignore-lists)
3697 ido-enable-prefix
3698 (= (length ido-text) 0)))
3699 full-matches suffix-matches prefix-matches matches)
3700 (setq ido-incomplete-regexp nil)
3701 (condition-case error
3702 (mapc
3703 (lambda (item)
3704 (let ((name (ido-name item)))
3705 (if (and (or non-prefix-dot
3706 (if (= (aref ido-text 0) ?.)
3707 (= (aref name 0) ?.)
3708 (/= (aref name 0) ?.)))
3709 (string-match re name))
3710 (cond
3711 ((and (eq ido-cur-item 'buffer)
3712 (or (not (stringp ido-default-item))
3713 (not (string= name ido-default-item)))
3714 (string= name (buffer-name ido-entry-buffer)))
3715 (setq matches (cons item matches)))
3716 ((and full-re (string-match full-re name))
3717 (setq full-matches (cons item full-matches)))
3718 ((and suffix-re (string-match suffix-re name))
3719 (setq suffix-matches (cons item suffix-matches)))
3720 ((and prefix-re (string-match prefix-re name))
3721 (setq prefix-matches (cons item prefix-matches)))
3722 (t (setq matches (cons item matches))))))
3724 items)
3725 (invalid-regexp
3726 (setq ido-incomplete-regexp t
3727 ;; Consider the invalid regexp message internally as a
3728 ;; special-case single match, and handle appropriately
3729 ;; elsewhere.
3730 matches (cdr error))))
3731 (when prefix-matches
3732 (ido-trace "prefix match" prefix-matches)
3733 ;; Bug#2042.
3734 (setq matches (nconc prefix-matches matches)))
3735 (when suffix-matches
3736 (ido-trace "suffix match" (list text suffix-re suffix-matches))
3737 (setq matches (nconc suffix-matches matches)))
3738 (when full-matches
3739 (ido-trace "full match" (list text full-re full-matches))
3740 (setq matches (nconc full-matches matches)))
3741 (when (and (null matches)
3742 ido-enable-flex-matching
3743 (> (length ido-text) 1)
3744 (not ido-enable-regexp))
3745 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
3746 (if ido-enable-prefix
3747 (setq re (concat "\\`" re)))
3748 (mapc
3749 (lambda (item)
3750 (let ((name (ido-name item)))
3751 (if (string-match re name)
3752 (setq matches (cons item matches)))))
3753 items))
3754 matches))
3757 (defun ido-set-matches ()
3758 ;; Set `ido-matches' to the list of items matching prompt
3759 (when ido-rescan
3760 (setq ido-matches (ido-set-matches-1 (reverse ido-cur-list) (not ido-rotate))
3761 ido-rotate nil)))
3763 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
3764 ;; Return t if the buffer or file NAME should be ignored.
3765 (or (member name ido-ignore-item-temp-list)
3766 (and
3767 ido-process-ignore-lists re-list
3768 (save-match-data
3769 (let ((ext-list (and ignore-ext ido-ignore-extensions
3770 completion-ignored-extensions))
3771 (case-fold-search ido-case-fold)
3772 ignorep nextstr
3773 (flen (length name)) slen)
3774 (while ext-list
3775 (setq nextstr (car ext-list))
3776 (if (cond
3777 ((stringp nextstr)
3778 (and (>= flen (setq slen (length nextstr)))
3779 (string-equal (substring name (- flen slen)) nextstr)))
3780 ((functionp nextstr) (funcall nextstr name))
3781 (t nil))
3782 (setq ignorep t
3783 ext-list nil
3784 re-list nil)
3785 (setq ext-list (cdr ext-list))))
3786 (while re-list
3787 (setq nextstr (car re-list))
3788 (if (cond
3789 ((stringp nextstr) (string-match nextstr name))
3790 ((functionp nextstr) (funcall nextstr name))
3791 (t nil))
3792 (setq ignorep t
3793 re-list nil)
3794 (setq re-list (cdr re-list))))
3795 ;; return the result
3796 (if ignorep
3797 (setq ido-ignored-list (cons name ido-ignored-list)))
3798 ignorep)))))
3800 ;; Private variable used by `ido-word-matching-substring'.
3801 (defvar ido-change-word-sub)
3803 (defun ido-find-common-substring (items subs)
3804 ;; Return common string following SUBS in each element of ITEMS.
3805 (let (res
3806 alist
3807 ido-change-word-sub)
3808 (setq ido-change-word-sub
3809 (if ido-enable-regexp
3810 subs
3811 (regexp-quote subs)))
3812 (setq res (mapcar #'ido-word-matching-substring items))
3813 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
3814 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
3816 ;; try-completion returns t if there is an exact match.
3817 (let* ((completion-ignore-case ido-case-fold)
3818 (comp (try-completion subs alist)))
3819 (if (eq comp t)
3820 subs
3821 comp))))
3823 (defun ido-word-matching-substring (word)
3824 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
3825 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
3826 (let ((case-fold-search ido-case-fold))
3827 (let ((m (string-match ido-change-word-sub (ido-name word))))
3828 (if m
3829 (substring (ido-name word) m)
3830 ;; else no match
3831 nil))))
3833 (defun ido-makealist (res)
3834 ;; Return dotted pair (RES . 1).
3835 (cons res 1))
3837 (defun ido-choose-completion-string (choice &rest ignored)
3838 (when (ido-active)
3839 ;; Insert the completion into the buffer where completion was requested.
3840 (if (get-buffer ido-completion-buffer)
3841 (kill-buffer ido-completion-buffer))
3842 (cond
3843 ((ido-active t) ;; ido-use-merged-list
3844 (setq ido-current-directory ""
3845 ido-text choice
3846 ido-exit 'done))
3847 ((not (ido-final-slash choice))
3848 (setq ido-text choice
3849 ido-exit 'done))
3851 (ido-set-current-directory ido-current-directory choice)
3852 (setq ido-exit 'refresh)))
3853 (exit-minibuffer)
3856 (defun ido-completion-help ()
3857 "Show possible completions in a *File Completions* buffer."
3858 (interactive)
3859 (setq ido-rescan nil)
3860 (let ((temp-buf (get-buffer ido-completion-buffer))
3861 display-it full-list)
3862 (if (and (eq last-command this-command) temp-buf)
3863 ;; scroll buffer
3864 (let (win (buf (current-buffer)))
3865 (display-buffer temp-buf nil nil)
3866 (set-buffer temp-buf)
3867 (setq win (get-buffer-window temp-buf))
3868 (if (pos-visible-in-window-p (point-max) win)
3869 (if (or ido-completion-buffer-all-completions
3870 (boundp 'ido-completion-buffer-full))
3871 (set-window-start win (point-min))
3872 (with-no-warnings
3873 (set (make-local-variable 'ido-completion-buffer-full) t))
3874 (setq full-list t
3875 display-it t))
3876 (scroll-other-window))
3877 (set-buffer buf))
3878 (setq display-it t))
3879 (if display-it
3880 (with-output-to-temp-buffer ido-completion-buffer
3881 (let ((completion-list (sort
3882 (cond
3883 (ido-directory-too-big
3884 (message "Reading directory...")
3885 (setq ido-directory-too-big nil
3886 ido-ignored-list nil
3887 ido-cur-list (ido-all-completions)
3888 ido-rescan t)
3889 (ido-set-matches)
3890 (or ido-matches ido-cur-list))
3891 (ido-use-merged-list
3892 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
3893 ((or full-list ido-completion-buffer-all-completions)
3894 (ido-all-completions))
3896 (copy-sequence (or ido-matches ido-cur-list))))
3897 #'ido-file-lessp)))
3898 (if (featurep 'xemacs)
3899 ;; XEmacs extents are put on by default, doesn't seem to be
3900 ;; any way of switching them off.
3901 ;; This obscure code avoids a byte compiler warning in Emacs.
3902 (let ((f 'display-completion-list))
3903 (funcall f completion-list
3904 :help-string "ido "
3905 :activate-callback
3906 (lambda (x y z) (message "Doesn't work yet, sorry!"))))
3907 ;; else running Emacs
3908 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
3909 (display-completion-list completion-list)))))))
3911 ;;; KILL CURRENT BUFFER
3912 (defun ido-kill-buffer-at-head ()
3913 "Kill the buffer at the head of `ido-matches'.
3914 If cursor is not at the end of the user input, delete to end of input."
3915 (interactive)
3916 (if (not (eobp))
3917 (delete-region (point) (line-end-position))
3918 (let ((enable-recursive-minibuffers t)
3919 (buf (ido-name (car ido-matches)))
3920 (nextbuf (cadr ido-matches)))
3921 (cond
3922 ((get-buffer buf)
3923 ;; If next match names a buffer use the buffer object; buffer
3924 ;; name may be changed by packages such as uniquify.
3925 (when (and nextbuf (get-buffer nextbuf))
3926 (setq nextbuf (get-buffer nextbuf)))
3927 (if (null (kill-buffer buf))
3928 ;; Buffer couldn't be killed.
3929 (setq ido-rescan t)
3930 ;; Else `kill-buffer' succeeds so re-make the buffer list
3931 ;; taking into account packages like uniquify may rename
3932 ;; buffers.
3933 (if (bufferp nextbuf)
3934 (setq nextbuf (buffer-name nextbuf)))
3935 (setq ido-default-item nextbuf
3936 ido-text-init ido-text
3937 ido-exit 'refresh)
3938 (exit-minibuffer)))
3939 ;; Handle virtual buffers
3940 ((assoc buf ido-virtual-buffers)
3941 (setq recentf-list
3942 (delete (cdr (assoc buf ido-virtual-buffers)) recentf-list))
3943 (setq ido-cur-list (delete buf ido-cur-list))
3944 (setq ido-rescan t))))))
3946 ;;; DELETE CURRENT FILE
3947 (defun ido-delete-file-at-head ()
3948 "Delete the file at the head of `ido-matches'.
3949 If cursor is not at the end of the user input, delete to end of input."
3950 (interactive)
3951 (if (not (eobp))
3952 (delete-region (point) (line-end-position))
3953 (let ((enable-recursive-minibuffers t)
3954 (file (ido-name (car ido-matches))))
3955 (if file
3956 (setq file (concat ido-current-directory file)))
3957 (when (and file
3958 (file-exists-p file)
3959 (not (file-directory-p file))
3960 (file-writable-p ido-current-directory)
3961 (yes-or-no-p (concat "Delete " file "? ")))
3962 (delete-file file)
3963 ;; Check if file still exists.
3964 (if (file-exists-p file)
3965 ;; file could not be deleted
3966 (setq ido-rescan t)
3967 ;; else file was killed so remove name from list.
3968 (setq ido-cur-list (delq (car ido-matches) ido-cur-list)))))))
3971 ;;; VISIT CHOSEN BUFFER
3972 (defun ido-visit-buffer (buffer method &optional record)
3973 "Switch to BUFFER according to METHOD.
3974 Record command in `command-history' if optional RECORD is non-nil."
3975 (if (bufferp buffer)
3976 (setq buffer (buffer-name buffer)))
3977 (let (win newframe)
3978 (cond
3979 ((eq method 'kill)
3980 (if record
3981 (ido-record-command 'kill-buffer buffer))
3982 (kill-buffer buffer))
3984 ((eq method 'other-window)
3985 (if record
3986 (ido-record-command 'switch-to-buffer buffer))
3987 (switch-to-buffer-other-window buffer))
3989 ((eq method 'display)
3990 (display-buffer buffer))
3992 ((eq method 'other-frame)
3993 (switch-to-buffer-other-frame buffer)
3994 (select-frame-set-input-focus (selected-frame)))
3996 ((and (memq method '(raise-frame maybe-frame))
3997 window-system
3998 (setq win (ido-buffer-window-other-frame buffer))
3999 (or (eq method 'raise-frame)
4000 (y-or-n-p "Jump to frame? ")))
4001 (setq newframe (window-frame win))
4002 (select-frame-set-input-focus newframe)
4003 (select-window win))
4005 ;; (eq method 'selected-window)
4007 ;; No buffer in other frames...
4008 (if record
4009 (ido-record-command 'switch-to-buffer buffer))
4010 (switch-to-buffer buffer)
4011 ))))
4014 (defun ido-buffer-window-other-frame (buffer)
4015 ;; Return window pointer if BUFFER is visible in another frame.
4016 ;; If BUFFER is visible in the current frame, return nil.
4017 (let ((blist (ido-get-buffers-in-frames 'current)))
4018 ;;If the buffer is visible in current frame, return nil
4019 (if (member buffer blist)
4021 ;; maybe in other frame or icon
4022 (get-buffer-window buffer 0) ; better than 'visible
4026 ;;; ----------- IDONIZED FUNCTIONS ------------
4028 ;;;###autoload
4029 (defun ido-switch-buffer ()
4030 "Switch to another buffer.
4031 The buffer is displayed according to `ido-default-buffer-method' -- the
4032 default is to show it in the same window, unless it is already visible
4033 in another frame.
4035 As you type in a string, all of the buffers matching the string are
4036 displayed if substring-matching is used \(default). Look at
4037 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
4038 buffer you want, it can then be selected. As you type, most keys have
4039 their normal keybindings, except for the following: \\<ido-buffer-completion-map>
4041 RET Select the buffer at the front of the list of matches. If the
4042 list is empty, possibly prompt to create new buffer.
4044 \\[ido-select-text] Select the current prompt as the buffer.
4045 If no buffer is found, prompt for a new one.
4047 \\[ido-next-match] Put the first element at the end of the list.
4048 \\[ido-prev-match] Put the last element at the start of the list.
4049 \\[ido-complete] Complete a common suffix to the current string that
4050 matches all buffers. If there is only one match, select that buffer.
4051 If there is no common suffix, show a list of all matching buffers
4052 in a separate window.
4053 \\[ido-edit-input] Edit input string.
4054 \\[ido-fallback-command] Fallback to non-ido version of current command.
4055 \\[ido-toggle-regexp] Toggle regexp searching.
4056 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
4057 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
4058 \\[ido-completion-help] Show list of matching buffers in separate window.
4059 \\[ido-enter-find-file] Drop into `ido-find-file'.
4060 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
4061 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
4062 (interactive)
4063 (ido-buffer-internal ido-default-buffer-method))
4065 ;;;###autoload
4066 (defun ido-switch-buffer-other-window ()
4067 "Switch to another buffer and show it in another window.
4068 The buffer name is selected interactively by typing a substring.
4069 For details of keybindings, see `ido-switch-buffer'."
4070 (interactive)
4071 (ido-buffer-internal 'other-window 'switch-to-buffer-other-window))
4073 ;;;###autoload
4074 (defun ido-display-buffer ()
4075 "Display a buffer in another window but don't select it.
4076 The buffer name is selected interactively by typing a substring.
4077 For details of keybindings, see `ido-switch-buffer'."
4078 (interactive)
4079 (ido-buffer-internal 'display 'display-buffer nil nil nil 'ignore))
4081 ;;;###autoload
4082 (defun ido-kill-buffer ()
4083 "Kill a buffer.
4084 The buffer name is selected interactively by typing a substring.
4085 For details of keybindings, see `ido-switch-buffer'."
4086 (interactive)
4087 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer)) nil 'ignore))
4089 ;;;###autoload
4090 (defun ido-insert-buffer ()
4091 "Insert contents of a buffer in current buffer after point.
4092 The buffer name is selected interactively by typing a substring.
4093 For details of keybindings, see `ido-switch-buffer'."
4094 (interactive)
4095 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil nil 'ido-enter-insert-file))
4097 ;;;###autoload
4098 (defun ido-switch-buffer-other-frame ()
4099 "Switch to another buffer and show it in another frame.
4100 The buffer name is selected interactively by typing a substring.
4101 For details of keybindings, see `ido-switch-buffer'."
4102 (interactive)
4103 (if ido-mode
4104 (ido-buffer-internal 'other-frame)
4105 (call-interactively 'switch-to-buffer-other-frame)))
4107 ;;;###autoload
4108 (defun ido-find-file-in-dir (dir)
4109 "Switch to another file starting from DIR."
4110 (interactive "DDir: ")
4111 (setq dir (file-name-as-directory dir))
4112 (ido-file-internal ido-default-file-method nil dir nil nil nil 'ignore))
4114 ;;;###autoload
4115 (defun ido-find-file ()
4116 "Edit file with name obtained via minibuffer.
4117 The file is displayed according to `ido-default-file-method' -- the
4118 default is to show it in the same window, unless it is already
4119 visible in another frame.
4121 The file name is selected interactively by typing a substring. As you
4122 type in a string, all of the filenames matching the string are displayed
4123 if substring-matching is used \(default). Look at `ido-enable-prefix' and
4124 `ido-toggle-prefix'. When you have found the filename you want, it can
4125 then be selected. As you type, most keys have their normal keybindings,
4126 except for the following: \\<ido-file-completion-map>
4128 RET Select the file at the front of the list of matches. If the
4129 list is empty, possibly prompt to create new file.
4131 \\[ido-select-text] Select the current prompt as the buffer or file.
4132 If no buffer or file is found, prompt for a new one.
4134 \\[ido-next-match] Put the first element at the end of the list.
4135 \\[ido-prev-match] Put the last element at the start of the list.
4136 \\[ido-complete] Complete a common suffix to the current string that
4137 matches all files. If there is only one match, select that file.
4138 If there is no common suffix, show a list of all matching files
4139 in a separate window.
4140 \\[ido-edit-input] Edit input string (including directory).
4141 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
4142 \\[ido-merge-work-directories] search for file in the work directory history.
4143 \\[ido-forget-work-directory] removes current directory from the work directory history.
4144 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
4145 \\[ido-wide-find-file-or-pop-dir] and \\[ido-wide-find-dir-or-delete-dir] prompts and uses find to locate files or directories.
4146 \\[ido-make-directory] prompts for a directory to create in current directory.
4147 \\[ido-fallback-command] Fallback to non-ido version of current command.
4148 \\[ido-toggle-regexp] Toggle regexp searching.
4149 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
4150 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
4151 \\[ido-toggle-vc] Toggle version control for this file.
4152 \\[ido-toggle-literal] Toggle literal reading of this file.
4153 \\[ido-completion-help] Show list of matching files in separate window.
4154 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
4156 (interactive)
4157 (ido-file-internal ido-default-file-method))
4159 ;;;###autoload
4160 (defun ido-find-file-other-window ()
4161 "Switch to another file and show it in another window.
4162 The file name is selected interactively by typing a substring.
4163 For details of keybindings, see `ido-find-file'."
4164 (interactive)
4165 (ido-file-internal 'other-window 'find-file-other-window))
4167 ;;;###autoload
4168 (defun ido-find-alternate-file ()
4169 "Switch to another file and show it in another window.
4170 The file name is selected interactively by typing a substring.
4171 For details of keybindings, see `ido-find-file'."
4172 (interactive)
4173 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
4175 ;;;###autoload
4176 (defun ido-find-file-read-only ()
4177 "Edit file read-only with name obtained via minibuffer.
4178 The file name is selected interactively by typing a substring.
4179 For details of keybindings, see `ido-find-file'."
4180 (interactive)
4181 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
4183 ;;;###autoload
4184 (defun ido-find-file-read-only-other-window ()
4185 "Edit file read-only in other window with name obtained via minibuffer.
4186 The file name is selected interactively by typing a substring.
4187 For details of keybindings, see `ido-find-file'."
4188 (interactive)
4189 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
4191 ;;;###autoload
4192 (defun ido-find-file-read-only-other-frame ()
4193 "Edit file read-only in other frame with name obtained via minibuffer.
4194 The file name is selected interactively by typing a substring.
4195 For details of keybindings, see `ido-find-file'."
4196 (interactive)
4197 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
4199 ;;;###autoload
4200 (defun ido-display-file ()
4201 "Display a file in another window but don't select it.
4202 The file name is selected interactively by typing a substring.
4203 For details of keybindings, see `ido-find-file'."
4204 (interactive)
4205 (ido-file-internal 'display nil nil nil nil nil 'ignore))
4207 ;;;###autoload
4208 (defun ido-find-file-other-frame ()
4209 "Switch to another file and show it in another frame.
4210 The file name is selected interactively by typing a substring.
4211 For details of keybindings, see `ido-find-file'."
4212 (interactive)
4213 (ido-file-internal 'other-frame 'find-file-other-frame))
4215 ;;;###autoload
4216 (defun ido-write-file ()
4217 "Write current buffer to a file.
4218 The file name is selected interactively by typing a substring.
4219 For details of keybindings, see `ido-find-file'."
4220 (interactive)
4221 (let ((ido-process-ignore-lists t)
4222 (ido-work-directory-match-only nil)
4223 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
4224 (ido-report-no-match nil)
4225 (ido-confirm-unique-completion t)
4226 (ido-auto-merge-work-directories-length -1))
4227 (ido-file-internal 'write 'write-file nil "Write file: " nil nil 'ignore)))
4229 ;;;###autoload
4230 (defun ido-insert-file ()
4231 "Insert contents of file in current buffer.
4232 The file name is selected interactively by typing a substring.
4233 For details of keybindings, see `ido-find-file'."
4234 (interactive)
4235 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil nil 'ido-enter-insert-buffer))
4237 ;;;###autoload
4238 (defun ido-dired ()
4239 "Call `dired' the ido way.
4240 The directory is selected interactively by typing a substring.
4241 For details of keybindings, see `ido-find-file'."
4242 (interactive)
4243 (let ((ido-report-no-match nil)
4244 (ido-auto-merge-work-directories-length -1))
4245 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
4247 (defun ido-list-directory ()
4248 "Call `list-directory' the ido way.
4249 The directory is selected interactively by typing a substring.
4250 For details of keybindings, see `ido-find-file'."
4251 (interactive)
4252 (let ((ido-report-no-match nil)
4253 (ido-auto-merge-work-directories-length -1))
4254 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
4256 ;;; XEmacs hack for showing default buffer
4258 ;; The first time we enter the minibuffer, Emacs puts up the default
4259 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
4260 ;; subtle difference in the two versions of post-command-hook. The
4261 ;; default is shown for both whenever we delete all of our text
4262 ;; though, indicating its just a problem the first time we enter the
4263 ;; function. To solve this, we use another entry hook for emacs to
4264 ;; show the default the first time we enter the minibuffer.
4267 ;;; ICOMPLETE TYPE CODE
4269 (defun ido-initiate-auto-merge (buffer)
4270 (ido-trace "\n*merge timeout*" buffer)
4271 (setq ido-auto-merge-timer nil)
4272 (when (and (buffer-live-p buffer)
4273 (ido-active)
4274 (boundp 'ido-eoinput) ido-eoinput)
4275 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
4276 (ido-trace "request merge")
4277 (setq ido-use-merged-list 'auto
4278 ido-text-init contents
4279 ido-rotate-temp t
4280 ido-exit 'refresh)
4281 (with-current-buffer buffer
4282 (ido-tidy))
4283 (throw 'ido contents))))
4285 (defun ido-exhibit ()
4286 "Post command hook for `ido'."
4287 ;; Find matching files and display a list in the minibuffer.
4288 ;; Copied from `icomplete-exhibit' with two changes:
4289 ;; 1. It prints a default file name when there is no text yet entered.
4290 ;; 2. It calls my completion routine rather than the standard completion.
4292 (when (ido-active)
4293 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
4294 (buffer-undo-list t)
4295 try-single-dir-match
4296 refresh)
4298 (when ido-trace-enable
4299 (ido-trace "\nexhibit" this-command)
4300 (ido-trace "dir" ido-current-directory)
4301 (ido-trace "contents" contents)
4302 (ido-trace "list" ido-cur-list)
4303 (ido-trace "matches" ido-matches)
4304 (ido-trace "rescan" ido-rescan))
4306 (save-excursion
4307 (goto-char (point-max))
4308 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
4309 (unless (boundp 'ido-eoinput)
4310 ;; In case it got wiped out by major mode business:
4311 (make-local-variable 'ido-eoinput))
4312 (setq ido-eoinput (point))
4314 ;; Handle explicit directory changes
4315 (cond
4316 ((memq ido-cur-item '(buffer list))
4319 ((= (length contents) 0)
4322 ((= (length contents) 1)
4323 (cond
4324 ((and (ido-is-tramp-root) (string-equal contents "/"))
4325 (ido-set-current-directory ido-current-directory contents)
4326 (setq refresh t))
4327 ((and (ido-unc-hosts) (string-equal contents "/")
4328 (let ((ido-enable-tramp-completion nil))
4329 (ido-is-root-directory)))
4330 (ido-set-current-directory "//")
4331 (setq refresh t))
4334 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") contents)
4335 (ido-is-root-directory) ;; Ange-ftp or tramp
4336 (not (ido-local-file-exists-p contents)))
4337 (ido-set-current-directory ido-current-directory contents)
4338 (when (ido-is-slow-ftp-host)
4339 (setq ido-exit 'fallback)
4340 (exit-minibuffer))
4341 (setq refresh t))
4343 ((ido-final-slash contents) ;; xxx/
4344 (ido-trace "final slash" contents)
4345 (cond
4346 ((string-equal contents "~/")
4347 (ido-set-current-home)
4348 (setq refresh t))
4349 ((string-equal contents "../")
4350 (ido-up-directory t)
4351 (setq refresh t))
4352 ((string-equal contents "./")
4353 (setq refresh t))
4354 ((string-match "\\`~[-_a-zA-Z0-9]+[$]?/\\'" contents)
4355 (ido-trace "new home" contents)
4356 (ido-set-current-home contents)
4357 (setq refresh t))
4358 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
4359 (let ((exp (condition-case ()
4360 (expand-file-name
4361 (substitute-in-file-name (substring contents 0 -1))
4362 ido-current-directory)
4363 (error nil))))
4364 (ido-trace contents exp)
4365 (when (and exp (file-directory-p exp))
4366 (ido-set-current-directory (file-name-directory exp))
4367 (setq ido-text-init (file-name-nondirectory exp))
4368 (setq refresh t))))
4369 ((and (memq system-type '(windows-nt ms-dos))
4370 (string-equal (substring contents 1) ":/"))
4371 (ido-set-current-directory (file-name-directory contents))
4372 (setq refresh t))
4373 ((string-equal (substring contents -2 -1) "/")
4374 (ido-set-current-directory
4375 (if (memq system-type '(windows-nt ms-dos))
4376 (expand-file-name "/" ido-current-directory)
4377 "/"))
4378 (setq refresh t))
4379 ((and (or ido-directory-nonreadable ido-directory-too-big)
4380 (file-directory-p (concat ido-current-directory (file-name-directory contents))))
4381 (ido-set-current-directory
4382 (concat ido-current-directory (file-name-directory contents)))
4383 (setq refresh t))
4385 (ido-trace "try single dir")
4386 (setq try-single-dir-match t))))
4388 ((and (string-equal (substring contents -2 -1) "/")
4389 (not (string-match "[$]" contents)))
4390 (ido-set-current-directory
4391 (cond
4392 ((= (length contents) 2)
4393 "/")
4394 (ido-matches
4395 (concat ido-current-directory (ido-name (car ido-matches))))
4397 (concat ido-current-directory (substring contents 0 -1)))))
4398 (setq ido-text-init (substring contents -1))
4399 (setq refresh t))
4401 ((and (not ido-use-merged-list)
4402 (not (ido-final-slash contents))
4403 (eq ido-try-merged-list t)
4404 (numberp ido-auto-merge-work-directories-length)
4405 (> ido-auto-merge-work-directories-length 0)
4406 (= (length contents) ido-auto-merge-work-directories-length)
4407 (not (and ido-auto-merge-inhibit-characters-regexp
4408 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4409 (not (input-pending-p)))
4410 (setq ido-use-merged-list 'auto
4411 ido-text-init contents
4412 ido-rotate-temp t)
4413 (setq refresh t))
4415 (t nil))
4417 (when refresh
4418 (ido-trace "refresh on /" ido-text-init)
4419 (setq ido-exit 'refresh)
4420 (exit-minibuffer))
4422 ;; Update the list of matches
4423 (setq ido-text contents)
4424 (ido-set-matches)
4425 (ido-trace "new " ido-matches)
4427 (when (and ido-enter-matching-directory
4428 ido-matches
4429 (or (eq ido-enter-matching-directory 'first)
4430 (null (cdr ido-matches)))
4431 (ido-final-slash (ido-name (car ido-matches)))
4432 (or try-single-dir-match
4433 (eq ido-enter-matching-directory t)))
4434 (ido-trace "single match" (car ido-matches))
4435 (ido-set-current-directory
4436 (concat ido-current-directory (ido-name (car ido-matches))))
4437 (setq ido-exit 'refresh)
4438 (exit-minibuffer))
4440 (when (and (not ido-matches)
4441 (not ido-directory-nonreadable)
4442 (not ido-directory-too-big)
4443 ;; ido-rescan ?
4444 ido-process-ignore-lists
4445 ido-ignored-list)
4446 (let ((ido-process-ignore-lists nil)
4447 (ido-rotate ido-rotate)
4448 (ido-cur-list ido-ignored-list))
4449 (ido-trace "try all" ido-ignored-list)
4450 (ido-set-matches))
4451 (when ido-matches
4452 (ido-trace "found " ido-matches)
4453 (setq ido-rescan t)
4454 (setq ido-process-ignore-lists-inhibit t)
4455 (setq ido-text-init ido-text)
4456 (setq ido-exit 'refresh)
4457 (exit-minibuffer)))
4459 (when (and
4460 ido-rescan
4461 (not ido-matches)
4462 (memq ido-cur-item '(file dir))
4463 (not (ido-is-root-directory))
4464 (> (length contents) 1)
4465 (not (string-match "[$]" contents))
4466 (not ido-directory-nonreadable)
4467 (not ido-directory-too-big))
4468 (ido-trace "merge?")
4469 (if ido-use-merged-list
4470 (ido-undo-merge-work-directory contents nil)
4471 (when (and (eq ido-try-merged-list t)
4472 (numberp ido-auto-merge-work-directories-length)
4473 (= ido-auto-merge-work-directories-length 0)
4474 (not (and ido-auto-merge-inhibit-characters-regexp
4475 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4476 (not (input-pending-p)))
4477 (ido-trace "\n*start timer*")
4478 (setq ido-auto-merge-timer
4479 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
4481 (setq ido-rescan t)
4483 (if (and ido-use-merged-list
4484 ido-matches
4485 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
4486 (progn
4487 (ido-set-current-directory (car (cdr (car ido-matches))))
4488 (setq ido-use-merged-list t
4489 ido-exit 'keep
4490 ido-text-init ido-text)
4491 (exit-minibuffer)))
4493 ;; Insert the match-status information:
4494 (ido-set-common-completion)
4495 (let ((inf (ido-completions contents)))
4496 (setq ido-show-confirm-message nil)
4497 (ido-trace "inf" inf)
4498 (insert inf))
4499 ))))
4501 (defun ido-completions (name)
4502 ;; Return the string that is displayed after the user's text.
4503 ;; Modified from `icomplete-completions'.
4505 (let* ((comps ido-matches)
4506 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
4507 ido-merged-indicator))
4508 first)
4510 (if (and ind ido-use-faces)
4511 (put-text-property 0 1 'face 'ido-indicator ind))
4513 (if (and ido-use-faces comps)
4514 (let* ((fn (ido-name (car comps)))
4515 (ln (length fn)))
4516 (setq first (format "%s" fn))
4517 (put-text-property 0 ln 'face
4518 (if (= (length comps) 1)
4519 (if ido-incomplete-regexp
4520 'ido-incomplete-regexp
4521 'ido-only-match)
4522 'ido-first-match)
4523 first)
4524 (if ind (setq first (concat first ind)))
4525 (setq comps (cons first (cdr comps)))))
4527 (cond ((null comps)
4528 (cond
4529 (ido-show-confirm-message
4530 (or (nth 10 ido-decorations) " [Confirm]"))
4531 (ido-directory-nonreadable
4532 (or (nth 8 ido-decorations) " [Not readable]"))
4533 (ido-directory-too-big
4534 (or (nth 9 ido-decorations) " [Too big]"))
4535 (ido-report-no-match
4536 (nth 6 ido-decorations)) ;; [No match]
4537 (t "")))
4538 (ido-incomplete-regexp
4539 (concat " " (car comps)))
4540 ((null (cdr comps)) ;one match
4541 (concat (if (if (not ido-enable-regexp)
4542 (= (length (ido-name (car comps))) (length name))
4543 ;; We can't rely on the length of the input
4544 ;; for regexps, so explicitly check for a
4545 ;; complete match
4546 (string-match name (ido-name (car comps)))
4547 (string-equal (match-string 0 (ido-name (car comps)))
4548 (ido-name (car comps))))
4550 ;; when there is one match, show the matching file name in full
4551 (concat (nth 4 ido-decorations) ;; [ ... ]
4552 (ido-name (car comps))
4553 (nth 5 ido-decorations)))
4554 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
4555 (t ;multiple matches
4556 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
4557 (alternatives
4558 (apply
4559 #'concat
4560 (cdr (apply
4561 #'nconc
4562 (mapcar
4563 (lambda (com)
4564 (setq com (ido-name com))
4565 (setq items (1- items))
4566 (cond
4567 ((< items 0) ())
4568 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
4570 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
4571 (let ((str (substring com 0)))
4572 (if (and ido-use-faces
4573 (not (string= str first))
4574 (ido-final-slash str))
4575 (put-text-property 0 (length str) 'face 'ido-subdir str))
4576 str)))))
4577 comps))))))
4579 (concat
4580 ;; put in common completion item -- what you get by pressing tab
4581 (if (and (stringp ido-common-match-string)
4582 (> (length ido-common-match-string) (length name)))
4583 (concat (nth 4 ido-decorations) ;; [ ... ]
4584 (substring ido-common-match-string (length name))
4585 (nth 5 ido-decorations)))
4586 ;; list all alternatives
4587 (nth 0 ido-decorations) ;; { ... }
4588 alternatives
4589 (nth 1 ido-decorations)))))))
4591 (defun ido-minibuffer-setup ()
4592 "Minibuffer setup hook for `ido'."
4593 ;; Copied from `icomplete-minibuffer-setup-hook'.
4594 (when (ido-active)
4595 (add-hook 'pre-command-hook 'ido-tidy nil t)
4596 (add-hook 'post-command-hook 'ido-exhibit nil t)
4597 (when (featurep 'xemacs)
4598 (ido-exhibit)
4599 (goto-char (point-min)))
4600 (run-hooks 'ido-minibuffer-setup-hook)
4601 (when ido-initial-position
4602 (goto-char (+ (minibuffer-prompt-end) ido-initial-position))
4603 (setq ido-initial-position nil))))
4605 (defun ido-tidy ()
4606 "Pre command hook for `ido'."
4607 ;; Remove completions display, if any, prior to new user input.
4608 ;; Copied from `icomplete-tidy'."
4610 (when ido-auto-merge-timer
4611 (ido-trace "\n*cancel timer*" this-command)
4612 (cancel-timer ido-auto-merge-timer)
4613 (setq ido-auto-merge-timer nil))
4615 (if (ido-active)
4616 (if (and (boundp 'ido-eoinput)
4617 ido-eoinput)
4619 (if (> ido-eoinput (point-max))
4620 ;; Oops, got rug pulled out from under us - reinit:
4621 (setq ido-eoinput (point-max))
4622 (let ((buffer-undo-list t))
4623 (delete-region ido-eoinput (point-max))))
4625 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
4626 (make-local-variable 'ido-eoinput)
4627 (setq ido-eoinput 1))))
4629 (defun ido-summary-buffers-to-end ()
4630 ;; Move the summaries to the end of the buffer list.
4631 ;; This is an example function which can be hooked on to
4632 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
4633 ;; `Summary' or `output\*$'are put to the end of the list.
4634 (let ((summaries (delq nil (mapcar
4635 (lambda (x)
4636 (if (or
4637 (string-match "Summary" x)
4638 (string-match "output\\*\\'" x))
4640 ido-temp-list))))
4641 (ido-to-end summaries)))
4643 ;;; Helper functions for other programs
4645 (put 'dired-do-rename 'ido 'ignore)
4646 (put 'ibuffer-find-file 'ido 'find-file)
4647 (put 'dired-other-window 'ido 'dir)
4649 ;;;###autoload
4650 (defun ido-read-buffer (prompt &optional default require-match)
4651 "Ido replacement for the built-in `read-buffer'.
4652 Return the name of a buffer selected.
4653 PROMPT is the prompt to give to the user. DEFAULT if given is the default
4654 buffer to be selected, which will go to the front of the list.
4655 If REQUIRE-MATCH is non-nil, an existing buffer must be selected."
4656 (let* ((ido-current-directory nil)
4657 (ido-directory-nonreadable nil)
4658 (ido-directory-too-big nil)
4659 (ido-context-switch-command 'ignore)
4660 (buf (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match)))
4661 (if (eq ido-exit 'fallback)
4662 (let ((read-buffer-function nil))
4663 (run-hook-with-args 'ido-before-fallback-functions 'read-buffer)
4664 (read-buffer prompt default require-match))
4665 buf)))
4667 ;;;###autoload
4668 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
4669 "Ido replacement for the built-in `read-file-name'.
4670 Read file name, prompting with PROMPT and completing in directory DIR.
4671 See `read-file-name' for additional parameters."
4672 (let (filename)
4673 (cond
4674 ((or (eq predicate 'file-directory-p)
4675 (eq (get this-command 'ido) 'dir)
4676 (memq this-command ido-read-file-name-as-directory-commands))
4677 (setq filename
4678 (ido-read-directory-name prompt dir default-filename mustmatch initial))
4679 (if (eq ido-exit 'fallback)
4680 (setq filename 'fallback)))
4681 ((and (not (eq (get this-command 'ido) 'ignore))
4682 (not (memq this-command ido-read-file-name-non-ido))
4683 (or (null predicate) (eq predicate 'file-exists-p)))
4684 (let* (ido-saved-vc-hb
4685 (ido-context-switch-command
4686 (if (eq (get this-command 'ido) 'find-file) nil 'ignore))
4687 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
4688 (minibuffer-completing-file-name t)
4689 (ido-current-directory (ido-expand-directory dir))
4690 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4691 (ido-directory-too-big (and (not ido-directory-nonreadable)
4692 (ido-directory-too-big-p ido-current-directory)))
4693 (ido-work-directory-index -1)
4694 (ido-show-dot-for-dired (and ido-show-dot-for-dired
4695 (not default-filename)))
4696 (ido-work-file-index -1)
4697 (ido-find-literal nil))
4698 (setq ido-exit nil)
4699 (setq filename
4700 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
4701 (cond
4702 ((eq ido-exit 'fallback)
4703 (setq filename 'fallback))
4704 ((eq ido-exit 'dired)
4705 (setq filename ido-current-directory))
4706 (filename
4707 (setq filename
4708 (concat ido-current-directory filename))))))
4710 (setq filename 'fallback)))
4711 (if (eq filename 'fallback)
4712 (let ((read-file-name-function nil))
4713 (run-hook-with-args 'ido-before-fallback-functions 'read-file-name)
4714 (read-file-name prompt dir default-filename mustmatch initial predicate))
4715 filename)))
4717 ;;;###autoload
4718 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
4719 "Ido replacement for the built-in `read-directory-name'.
4720 Read directory name, prompting with PROMPT and completing in directory DIR.
4721 See `read-directory-name' for additional parameters."
4722 (let* (filename
4723 (minibuffer-completing-file-name t)
4724 (ido-context-switch-command 'ignore)
4725 ido-saved-vc-hb
4726 (ido-current-directory (ido-expand-directory dir))
4727 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4728 (ido-directory-too-big (and (not ido-directory-nonreadable)
4729 (ido-directory-too-big-p ido-current-directory)))
4730 (ido-work-directory-index -1)
4731 (ido-work-file-index -1))
4732 (setq filename
4733 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
4734 (if filename
4735 (if (and (stringp filename) (string-equal filename "."))
4736 ido-current-directory
4737 (concat ido-current-directory filename)))))
4739 ;;;###autoload
4740 (defun ido-completing-read (prompt choices &optional _predicate require-match
4741 initial-input hist def _inherit-input-method)
4742 "Ido replacement for the built-in `completing-read'.
4743 Read a string in the minibuffer with ido-style completion.
4744 PROMPT is a string to prompt with; normally it ends in a colon and a space.
4745 CHOICES is a list of strings which are the possible completions.
4746 PREDICATE and INHERIT-INPUT-METHOD is currently ignored; it is included
4747 to be compatible with `completing-read'.
4748 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
4749 the input is (or completes to) an element of CHOICES or is null.
4750 If the input is null, `ido-completing-read' returns DEF, or an empty
4751 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
4752 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
4753 with point positioned at the end.
4754 HIST, if non-nil, specifies a history list.
4755 DEF, if non-nil, is the default value."
4756 (let ((ido-current-directory nil)
4757 (ido-directory-nonreadable nil)
4758 (ido-directory-too-big nil)
4759 (ido-context-switch-command 'ignore)
4760 (ido-choice-list choices))
4761 ;; Initialize ido before invoking ido-read-internal
4762 (ido-common-initialization)
4763 (ido-read-internal 'list prompt hist def require-match initial-input)))
4765 (defun ido-unload-function ()
4766 "Unload the Ido library."
4767 (ido-mode -1)
4768 (setq minor-mode-map-alist (assq-delete-all 'ido-mode minor-mode-map-alist))
4769 ;; continue standard unloading
4770 nil)
4772 (provide 'ido)
4774 ;;; ido.el ends here