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