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