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