(tooltip-mode): Doc fix.
[emacs.git] / lisp / ido.el
blob10fac08196ae7dea19cdec2a3f886fd1a4e389d8
1 ;;; ido.el --- interactively do things with buffers and files.
3 ;; Copyright (C) 1996-2004 Free Software Foundation, Inc.
5 ;; Author: Kim F. Storm <storm@cua.dk>
6 ;; Based on: iswitchb by Stephen Eglen <stephen@cns.ed.ac.uk>
7 ;; Keywords: extensions convenience
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Acknowledgements
28 ;; Infinite amounts of gratitude goes to Stephen Eglen <stephen@cns.ed.ac.uk>
29 ;; who wrote iswitch-buffer mode - from which I ripped off 99% of the code
30 ;; for ido-switch-buffer and found the inspiration for ido-find-file.
31 ;; The ido package would never have existed without his work.
33 ;; Also thanks to Klaus Berndl, Rohit Namjoshi, Robert Fenk, Alex
34 ;; Schroeder, Bill Benedetto, Stephen Eglen, and many others for bug
35 ;; fixes and improvements.
37 ;;; History
39 ;; Since I discovered Stephen Eglen's excellent iswitchb package, I just
40 ;; couldn't live without it, but once being addicted to switching buffers
41 ;; with a minimum of keystrokes, I soon found that opening files in the
42 ;; old-fashioned way was just too slow - so I decided to write a package
43 ;; which could open files with the same speed and ease as iswitchb could
44 ;; switch buffers.
46 ;; I originally wrote a separate ifindf.el package based on a copy of
47 ;; iswitchb.el, which did for opening files what iswitchb did for
48 ;; switching buffers. Along the way, I corrected a few errors in
49 ;; ifindf which could have found its way back into iswitchb, but since
50 ;; most of the functionality of the two package was practically
51 ;; identical, I decided that the proper thing to do was to merge my
52 ;; ifindf package back into iswitchb.
54 ;; This is basically what ido (interactively do) is all about; but I
55 ;; found it ackward to merge my changes into the "iswitchb-" namespace,
56 ;; so I invented a common "ido-" namespace for the merged packages.
58 ;; This version is based on ido.el version 1.57 released on
59 ;; gnu.emacs.sources adapted for emacs 21.5 to use command remapping
60 ;; and optionally hooking the read-buffer and read-file-name functions.
62 ;; Prefix matching was added by Klaus Berndl <klaus.berndl@sdm.de> based on
63 ;; an idea of Yuji Minejima <ggb01164@nifty.ne.jp> and his mcomplete-package.
66 ;;; Commentary:
68 ;; Ido - interactive do - switches between buffers and opens files and
69 ;; directories with a minimum of keystrokes. It is a superset of
70 ;; iswitchb, the interactive buffer switching package by Stephen Eglen.
72 ;; Interactive substring matching
73 ;; ------------------------------
75 ;; As you type in a substring, the list of buffers or files currently
76 ;; matching the substring are displayed as you type. The list is
77 ;; ordered so that the most recent buffers or files visited come at
78 ;; the start of the list.
80 ;; The buffer or file at the start of the list will be the one visited
81 ;; when you press RETURN. By typing more of the substring, the list is
82 ;; narrowed down so that gradually the buffer or file you want will be
83 ;; at the top of the list. Alternatively, you can use C-s and C-r (or
84 ;; the right and left arrow keys) to rotate buffer or file names in the
85 ;; list until the one you want is at the top of the list.
87 ;; Completion is also available so that you can see what is common to
88 ;; all of the matching buffers or files as you type.
90 ;; Example:
92 ;; If I have two buffers called "123456" and "123", with "123456" the
93 ;; most recent, when I use ido-switch-buffer, I first of all get
94 ;; presented with the list of all the buffers
96 ;; Buffer: {123456,123}
98 ;; If I then press 2:
99 ;; Buffer: 2[3]{123456,123}
101 ;; The list in {...} are the matching buffers, most recent first
102 ;; (buffers visible in the current frame are put at the end of the
103 ;; list by default). At any time I can select the item at the head of
104 ;; the list by pressing RET. I can also bring the put the first
105 ;; element at the end of the list by pressing C-s or [right], or put
106 ;; the last element at the head of the list by pressing C-r or [left].
108 ;; The item in [...] indicates what can be added to my input by
109 ;; pressing TAB. In this case, I will get "3" added to my input.
111 ;; So, I press TAB:
112 ;; Buffer: 23{123456,123}
114 ;; At this point, I still have two matching buffers.
115 ;; If I want the first buffer in the list, I simply press RET. If I
116 ;; wanted the second in the list, I could press C-s to move it to the
117 ;; top of the list and then RET to select it.
119 ;; However, if I type 4, I only have one match left:
120 ;; Buffer: 234[123456] [Matched]
122 ;; Since there is only one matching buffer left, it is given in [] and we
123 ;; see the text [Matched] afterwards. I can now press TAB or RET to go
124 ;; to that buffer.
126 ;; If however, I now type "a":
127 ;; Buffer: 234a [No match]
128 ;; There are no matching buffers. If I press RET or TAB, I can be
129 ;; prompted to create a new buffer called "234a".
131 ;; Of course, where this function comes in really useful is when you
132 ;; can specify the buffer using only a few keystrokes. In the above
133 ;; example, the quickest way to get to the "123456" file would be
134 ;; just to type 4 and then RET (assuming there isn't any newer buffer
135 ;; with 4 in its name).
137 ;; Likewise, if you use C-x C-f (ido-find-file), the list of files and
138 ;; directories in the current directory is provided in the same
139 ;; fashion as the buffers above. The files and directories are
140 ;; normally sorted in alphabetical order, but the most recently
141 ;; visited directory is placed first to speed up navigating to
142 ;; directories that you have visited recently.
144 ;; In addition to scrolling through the list using [right] and [left],
145 ;; you can use [up] and [down] to quickly scroll the list to the next
146 ;; or previous subdirectory.
148 ;; To go down into a subdirectory, and continue the file selection on
149 ;; the files in that directory, simply move the directory to the head
150 ;; of the list and hit RET.
152 ;; To go up to the parent directory, delete any partial file name
153 ;; already specified (e.g. using [backspace]) and hit [backspace].
155 ;; To go to the root directory (on the current drive), enter two
156 ;; slashes. On MS-DOS or Windows, to select the root of another
157 ;; drive, enter X:/ where X is the drive letter. You can also visit
158 ;; files on other hosts using the ange-ftp notations `/host:' and
159 ;; `/user@host:'. See the variable `ido-slow-ftp-hosts' if you want
160 ;; to inhibit the ido substring matching for ftp access.
162 ;; If for some reason you cannot specify the proper file using
163 ;; ido-find-file, you can press C-f to enter the normal find-file.
164 ;; You can also press C-b to drop into ido-switch-buffer.
166 ;; See the doc string of ido-switch-buffer and ido-find-file for full
167 ;; keybindings and features.
168 ;; (describe-function 'ido-find-file)
170 ;; Hidden buffers and files
171 ;; ------------------------
173 ;; Normally, ido does not include hidden buffers (whose name starts
174 ;; with a space) and hidden files and directories (whose name starts
175 ;; with `.') in the list of possible completions. However, if the
176 ;; substring you enter does not match any of the visible buffers or
177 ;; files, ido will automatically look for completions among the hidden
178 ;; buffers or files.
180 ;; You can toggle display of the hidden buffers and files with C-a.
182 ;; Additional functionality
183 ;; ------------------------
185 ;; After C-x b, the buffer at the head of the list can be killed by
186 ;; pressing C-k. If the buffer needs saving, you will be queried
187 ;; before the buffer is killed.
189 ;; Likewise, after C-x C-f, you can delete (i.e. physically remove)
190 ;; the file at the head of the list with C-k. You will always be
191 ;; asked for confirmation before the file is deleted.
193 ;; If you enter C-x b to switch to a buffer visiting a given file, and
194 ;; you find that the file you are after is not in any buffer, you can
195 ;; press C-f to immediately drop into ido-find-file. And you can
196 ;; switch back to buffer selection with C-b.
198 ;; Prefix matching
199 ;; ---------------
201 ;; The standard way of completion with Unix-shells and Emacs is to insert a
202 ;; PREFIX and then hitting TAB (or another completion key). Cause of this
203 ;; behavior has become second nature to a lot of emacs users `ido' offers in
204 ;; addition to the default substring-matching-method (look above) also the
205 ;; prefix-matching-method. The kind of matching is the only difference to
206 ;; the description of the substring-matching above.
208 ;; You can toggle prefix matching with C-p.
210 ;; Example:
212 ;; If you have again two Buffers "123456" and "123" then hitting "2" does
213 ;; not match because "2" is not a PREFIX in any of the buffer-names. This
214 ;; is the only difference between the substring and prefix matching.
216 ;; Flexible matching
217 ;; -----------------
219 ;; If you set ido-enable-flex-matching, ido will do a more flexible
220 ;; matching (unless regexp matching is active) to find possible matches
221 ;; among the available buffer or file names if no matches are found using
222 ;; the normal prefix or substring matching.
224 ;; The flexible matching implies that any item which simply contains all
225 ;; of the entered characters in the specified sequence will match.
227 ;; Example:
229 ;; If you have four files "alpha", "beta", "gamma", and "delta",
230 ;; entering "aa" will match "alpha" and "gamma", while "ea" matches
231 ;; "beta" and "delta". If prefix matching is also active, "aa" only
232 ;; matches "alpha", while "ea" does not match any files.
234 ;; Regexp matching
235 ;; ---------------
237 ;; There is limited provision for regexp matching within ido,
238 ;; enabled through `ido-enable-regexp' (toggle with C-t).
239 ;; This allows you to type `c$' for example and see all file names
240 ;; ending in `c'. This facility is quite limited though in two
241 ;; respects. First, you can't currently type in expressions like
242 ;; `[0-9]' directly -- you have to type them in when ido-enable-regexp
243 ;; is nil and then toggle on the regexp functionality. Likewise,
244 ;; don't enter an expression containing `\' in regexp mode. If you
245 ;; try, ido gets confused, so just hit C-g and try again. Secondly,
246 ;; no completion mechanism is currently offered with regexp searching.
249 ;; Customization
250 ;; -------------
252 ;; Customize the `ido' group to change the `ido' functionality.
254 ;; To modify the keybindings, use the hook provided. For example:
255 ;;(add-hook 'ido-define-mode-map-hook 'ido-my-keys)
257 ;;(defun ido-my-keys ()
258 ;; "Add my keybindings for ido."
259 ;; (define-key ido-mode-map " " 'ido-next-match)
260 ;; )
262 ;; Seeing all the matching buffers or files
263 ;; ----------------------------------------
265 ;; If you have many matching files, they may not all fit onto one
266 ;; line of the minibuffer. Normally, the minibuffer window will grow
267 ;; to show you more of the matching files (depending on the setting
268 ;; of the variables `resize-mini-windows' and `max-mini-window-height').
269 ;; If you want ido to behave differently from the default minibuffer
270 ;; resizing behaviour, set the variable `ido-max-window-height'.
272 ;; Also, to improve the responsiveness of ido, the maximum number of
273 ;; matching items is limited to 12, but you can increase or removed
274 ;; this limit via the `ido-max-prospects' variable.
276 ;; To see a full list of all matching buffers in a separate buffer,
277 ;; hit ? or press TAB when there are no further completions to the
278 ;; substring. Repeated TAB presses will scroll you through this
279 ;; separate buffer.
281 ;; Changing the list of files
282 ;; --------------------------
284 ;; By default, the list of current files is most recent first,
285 ;; oldest last, with the exception that the files visible in the
286 ;; current frame are put at the end of the list. A hook exists to
287 ;; allow other functions to order the list. For example, if you add:
289 ;; (add-hook 'ido-make-buffer-list-hook 'ido-summary-buffers-to-end)
291 ;; then all files matching "Summary" are moved to the end of the
292 ;; list. (I find this handy for keeping the INBOX Summary and so on
293 ;; out of the way.) It also moves files matching "output\*$" to the
294 ;; end of the list (these are created by AUCTeX when compiling.)
295 ;; Other functions could be made available which alter the list of
296 ;; matching files (either deleting or rearranging elements.)
298 ;; Highlighting
299 ;; ------------
301 ;; The highlighting of matching items is controlled via ido-use-faces.
302 ;; The faces used are ido-first-match-face, ido-only-match-face and
303 ;; ido-subdir-face.
304 ;; Colouring of the matching item was suggested by
305 ;; Carsten Dominik (dominik@strw.leidenuniv.nl).
307 ;; Replacement for read-buffer and read-file-name
308 ;; ----------------------------------------------
310 ;; ido-read-buffer and ido-read-file-name have been written to be drop
311 ;; in replacements for the normal buffer and file name reading
312 ;; functions `read-buffer' and `read-file-name'.
314 ;; To use ido for all buffer and file selections in Emacs, customize the
315 ;; variable `ido-everywhere'.
317 ;; Using ido-like behaviour in other lisp packages
318 ;; -----------------------------------------------
320 ;; If you don't want to rely on the `ido-everywhere' functionality,
321 ;; ido-read-buffer, ido-read-file-name, and ido-read-directory-name
322 ;; can be used by other packages to read a buffer name, a file name,
323 ;; or a directory name in the `ido' way.
326 ;;; Code:
328 (provide 'ido)
330 ;;; User Variables
332 ;; These are some things you might want to change.
334 (defun ido-fractionp (n)
335 (and (numberp n) (> n 0.0) (<= n 1.0)))
337 (defgroup ido nil
338 "Switch between files using substrings."
339 :group 'extensions
340 :group 'convenience
341 :version "21.4"
342 :link '(emacs-commentary-link :tag "Commentary" "ido.el")
343 :link '(emacs-library-link :tag "Lisp File" "ido.el"))
345 ;;;###autoload
346 (defcustom ido-mode nil
347 "Determines for which functional group \(buffer and files) ido behavior
348 should be enabled. The following values are possible:
349 - `buffer': Turn only on ido buffer behavior \(switching, killing,
350 displaying...)
351 - `file': Turn only on ido file behavior \(finding, writing, inserting...)
352 - `both': Turn on ido buffer and file behavior.
353 - `nil': Turn off any ido switching.
355 Setting this variable directly does not take effect;
356 use either \\[customize] or the function `ido-mode'."
357 :set #'(lambda (symbol value)
358 (ido-mode value))
359 :initialize 'custom-initialize-default
360 :require 'ido
361 :link '(emacs-commentary-link "ido.el")
362 :set-after '(ido-save-directory-list-file)
363 :type '(choice (const :tag "Turn on only buffer" buffer)
364 (const :tag "Turn on only file" file)
365 (const :tag "Turn on both buffer and file" both)
366 (const :tag "Switch off all" nil))
367 :group 'ido)
369 (defcustom ido-everywhere nil
370 "Use ido everywhere for reading file names and directories.
371 Setting this variable directly does not work. Use `customize' or
372 call the function `ido-everywhere'."
373 :set #'(lambda (symbol value)
374 (ido-everywhere value))
375 :initialize 'custom-initialize-default
376 :type 'boolean
377 :group 'ido)
379 (defcustom ido-case-fold case-fold-search
380 "*Non-nil if searching of buffer and file names should ignore case."
381 :type 'boolean
382 :group 'ido)
384 (defcustom ido-ignore-buffers
385 '("\\` ")
386 "*List of regexps or functions matching buffer names to ignore.
387 For example, traditional behavior is not to list buffers whose names begin
388 with a space, for which the regexp is `\\` '. See the source file for
389 example functions that filter buffernames."
390 :type '(repeat (choice regexp function))
391 :group 'ido)
393 (defcustom ido-ignore-files
394 '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
395 "*List of regexps or functions matching file names to ignore.
396 For example, traditional behavior is not to list files whose names begin
397 with a #, for which the regexp is `\\`#'. See the source file for
398 example functions that filter filenames."
399 :type '(repeat (choice regexp function))
400 :group 'ido)
402 (defcustom ido-ignore-extensions t
403 "*Non-nil means ignore files in completion-ignored-extensions list."
404 :type 'boolean
405 :group 'ido)
407 (defcustom ido-show-dot-for-dired nil
408 "*Non-nil means to always put . as the first item in file name lists.
409 This allows the current directory to be opened immediate with `dired'."
410 :type 'boolean
411 :group 'ido)
413 (defcustom ido-ignore-directories
414 '("\\`CVS/" "\\`\\.\\./" "\\`\\./")
415 "*List of regexps or functions matching sub-directory names to ignore."
416 :type '(repeat (choice regexp function))
417 :group 'ido)
419 (defcustom ido-ignore-directories-merge nil
420 "*List of regexps or functions matching directory names to ignore during merge.
421 Directory names matched by one of the regexps in this list are not inserted
422 in merged file and directory lists."
423 :type '(repeat (choice regexp function))
424 :group 'ido)
426 ;;; Examples for setting the value of ido-ignore-buffers
427 ;(defun ido-ignore-c-mode (name)
428 ; "Ignore all c mode buffers -- example function for ido."
429 ; (save-excursion
430 ; (set-buffer name)
431 ; (string-match "^C$" mode-name)))
433 ;(setq ido-ignore-buffers '("^ " ido-ignore-c-mode))
435 ;;; Examples for setting the value of ido-ignore-files
436 ;(setq ido-ignore-files '("^ " "\\.c$" "\\.h$"))
438 (defcustom ido-default-file-method 'always-frame
439 "*How to switch to new file when using `ido-find-file'.
440 Possible values:
441 `samewindow' Show new file in same window
442 `otherwindow' Show new file in another window (same frame)
443 `display' Display file in another window without switching to it
444 `otherframe' Show new file in another frame
445 `maybe-frame' If a file is visible in another frame, prompt to ask if you
446 you want to see the file in the same window of the current
447 frame or in the other frame.
448 `always-frame' If a file is visible in another frame, raise that
449 frame. Otherwise, visit the file in the same window."
450 :type '(choice (const samewindow)
451 (const otherwindow)
452 (const display)
453 (const otherframe)
454 (const maybe-frame)
455 (const always-frame))
456 :group 'ido)
458 (defcustom ido-default-buffer-method 'always-frame
459 "*How to switch to new buffer when using `ido-switch-buffer'.
460 See ido-default-file-method for details."
461 :type '(choice (const samewindow)
462 (const otherwindow)
463 (const display)
464 (const otherframe)
465 (const maybe-frame)
466 (const always-frame))
467 :group 'ido)
469 (defcustom ido-enable-flex-matching nil
470 "*Non-nil means that `ido' will do flexible string matching.
471 Flexible matching means that if the entered string does not
472 match any item, any item containing the entered characters
473 in the given sequence will match."
474 :type 'boolean
475 :group 'ido)
478 (defcustom ido-enable-regexp nil
479 "*Non-nil means that `ido' will do regexp matching.
480 Value can be toggled within `ido' using `ido-toggle-regexp'."
481 :type 'boolean
482 :group 'ido)
484 (defcustom ido-enable-prefix nil
485 "*Non-nil means only match if the entered text is a prefix of file name.
486 This behavior is like the standard emacs-completion.
487 Nil means to match if the entered text is an arbitrary substring.
488 Value can be toggled within `ido' using `ido-toggle-prefix'."
489 :type 'boolean
490 :group 'ido)
492 (defcustom ido-enable-dot-prefix nil
493 "*Non-nil means to match leading dot as prefix.
494 I.e. hidden files and buffers will match only if you type a dot
495 as first char even if `ido-enable-prefix' is nil."
496 :type 'boolean
497 :group 'ido)
499 (defcustom ido-confirm-unique-completion nil
500 "*Non-nil means that even a unique completion must be confirmed.
501 This means that \\[ido-complete] must always be followed by \\[ido-exit-minibuffer]
502 even when there is only one unique completion."
503 :type 'boolean
504 :group 'ido)
506 (defcustom ido-cannot-complete-command 'ido-completion-help
507 "*Command run when `ido-complete' can't complete any more.
508 The most useful values are `ido-completion-help', which pops up a
509 window with completion alternatives, or `ido-next-match' or
510 `ido-prev-match', which cycle the buffer list."
511 :type 'function
512 :group 'ido)
515 (defcustom ido-record-commands t
516 "*Non-nil means that `ido' will record commands in command history.
517 Note that the non-ido equivalent command is recorded."
518 :type 'boolean
519 :group 'ido)
521 (defcustom ido-max-prospects 12
522 "*Non-zero means that the prospect list will be limited to than number of items.
523 For a long list of prospects, building the full list for the minibuffer can take a
524 non-negletable amount of time; setting this variable reduces that time."
525 :type 'integer
526 :group 'ido)
528 (defcustom ido-max-file-prompt-width 0.35
529 "*Non-zero means that the prompt string be limited to than number of characters.
530 If value is a floating point number, it specifies a fraction of the frame width."
531 :type '(choice
532 (integer :tag "Characters" :value 20)
533 (restricted-sexp :tag "Fraction of frame width"
534 :value 0.35
535 :match-alternatives (ido-fractionp)))
536 :group 'ido)
538 (defcustom ido-max-window-height nil
539 "*Non-nil specifies a value to override `max-mini-window-height'."
540 :type '(choice
541 (const :tag "Don't override" nil)
542 (integer :tag "Number of lines" :value 1)
543 (restricted-sexp
544 :tag "Fraction of window height"
545 :value 0.25
546 :match-alternatives (ido-fractionp)))
547 :group 'ido)
549 (defcustom ido-enable-last-directory-history t
550 "*Non-nil means that `ido' will remember latest selected directory names.
551 See `ido-last-directory-list' and `ido-save-directory-list-file'."
552 :type 'boolean
553 :group 'ido)
555 (defcustom ido-max-work-directory-list 50
556 "*Maximum number of working directories to record.
557 This is the list of directories where files have most recently been opened.
558 See `ido-work-directory-list' and `ido-save-directory-list-file'."
559 :type 'integer
560 :group 'ido)
562 (defcustom ido-work-directory-list-ignore-regexps nil
563 "*List of regexps matching directories which should not be recorded.
564 Directory names matched by one of the regexps in this list are not inserted in
565 the `ido-work-directory-list' list."
566 :type '(repeat regexp)
567 :group 'ido)
570 (defcustom ido-use-filename-at-point nil
571 "*Non-nil means that ido shall look for a filename at point.
572 If found, use that as the starting point for filename selection."
573 :type 'boolean
574 :group 'ido)
577 (defcustom ido-use-url-at-point nil
578 "*Non-nil means that ido shall look for a URL at point.
579 If found, call `find-file-at-point' to visit it."
580 :type 'boolean
581 :group 'ido)
584 (defcustom ido-enable-tramp-completion t
585 "*Non-nil means that ido shall perform tramp method and server name completion.
586 A tramp file name uses the following syntax: /method:user@host:filename."
587 :type 'boolean
588 :group 'ido)
590 (defcustom ido-record-ftp-work-directories t
591 "*Non-nil means record ftp file names in the work directory list."
592 :type 'boolean
593 :group 'ido)
595 (defcustom ido-merge-ftp-work-directories nil
596 "*If nil means merging ignores ftp file names in the work directory list."
597 :type 'boolean
598 :group 'ido)
600 (defcustom ido-cache-ftp-work-directory-time 1.0
601 "*Maximum time to cache contents of an ftp directory (in hours).
602 If zero, ftp directories are not cached."
603 :type 'number
604 :group 'ido)
606 (defcustom ido-slow-ftp-hosts nil
607 "*List of slow ftp hosts where ido prompting should not be used.
608 If an ftp host is on this list, ido automatically switches to the non-ido
609 equivalent function, e.g. find-file rather than ido-find-file."
610 :type '(repeat string)
611 :group 'ido)
613 (defcustom ido-slow-ftp-host-regexps nil
614 "*List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
615 :type '(repeat regexp)
616 :group 'ido)
618 (defcustom ido-max-work-file-list 10
619 "*Maximum number of names of recently opened files to record.
620 This is the list the file names (sans directory) which have most recently
621 been opened. See `ido-work-file-list' and `ido-save-directory-list-file'."
622 :type 'integer
623 :group 'ido)
625 (defcustom ido-work-directory-match-only t
626 "*Non-nil means to skip non-matching directories in the directory history.
627 When some text is already entered at the `ido-find-file' prompt, using
628 \\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories
629 without any matching entries."
630 :type 'boolean
631 :group 'ido)
633 (defcustom ido-auto-merge-work-directories-length 0
634 "*Automatically switch to merged work directories during file name input.
635 The value is number of characters to type before switching to merged mode.
636 If zero, the switch happens when no matches are found in the current directory.
637 Automatic merging is disabled if the value is negative."
638 :type 'integer
639 :group 'ido)
641 (defcustom ido-auto-merge-delay-time 0.70
642 "*Delay in seconds to wait for more input before doing auto merge."
643 :type 'number
644 :group 'ido)
646 (defcustom ido-auto-merge-inhibit-characters-regexp "[][*?~]"
647 "*Regexp matching characters which should inhibit automatic merging.
648 When a (partial) file name matches this regexp, merging is inhibited."
649 :type 'regexp
650 :group 'ido)
652 (defcustom ido-merged-indicator "^"
653 "The string appended to first choice if it has multiple directory choices."
654 :type 'string
655 :group 'ido)
657 (defcustom ido-max-dir-file-cache 100
658 "*Maximum number of working directories to be cached.
659 This is the size of the cache of file-name-all-completions results.
660 Each cache entry is time stamped with the modification time of the
661 directory. Some systems, like Windows, have unreliable directory
662 modification times, so you may choose to disable caching on such
663 systems, or explicitly refresh the cache contents using the command
664 `ido-reread-directory' command (C-l) in the minibuffer.
665 See also `ido-dir-file-cache' and `ido-save-directory-list-file'."
666 :type 'integer
667 :group 'ido)
669 (defcustom ido-max-directory-size 30000
670 "*Maximum size (in bytes) for directories to use ido completion.
671 If you enter a directory with a size larger than this size, ido will
672 not provide the normal completion. To show the completions, use C-a."
673 :type '(choice (const :tag "No limit" nil)
674 (integer :tag "Size in bytes" 30000))
675 :group 'ido)
677 (defcustom ido-rotate-file-list-default nil
678 "*Non-nil means that `ido' will always rotate file list to get default in front."
679 :type 'boolean
680 :group 'ido)
682 (defcustom ido-enter-single-matching-directory 'slash
683 "*Automatically enter sub-directory if it is the only matching item, if non-nil.
684 If value is 'slash, only enter if typing final slash, else do it always."
685 :type '(choice (const :tag "Never" nil)
686 (const :tag "When typing /" slash)
687 (other :tag "Always" t))
688 :group 'ido)
690 (defcustom ido-create-new-buffer 'prompt
691 "*Specify whether a new buffer is created if no buffer matches substring.
692 Choices are 'always to create new buffers unconditionally, 'prompt to
693 ask user whether to create buffer, or 'never to never create new buffer."
694 :type '(choice (const always)
695 (const prompt)
696 (const never))
697 :group 'ido)
699 (defcustom ido-define-mode-map-hook nil
700 "*Hook to define keys in `ido-mode-map' for extra keybindings."
701 :type 'hook
702 :group 'ido)
704 (defcustom ido-separator nil
705 "*String used by ido to separate the alternatives in the minibuffer.
706 Obsolete. Set 3rd element of `ido-decorations' instead."
707 :type '(choice string (const nil))
708 :group 'ido)
710 (defcustom ido-decorations '( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]" " [Not readable]" " [Too big]")
711 "*List of strings used by ido to display the alternatives in the minibuffer.
712 There are 10 elements in this list:
713 1st and 2nd elements are used as brackets around the prospect list,
714 3rd element is the separator between prospects (ignored if ido-separator is set),
715 4th element is the string inserted at the end of a truncated list of prospects,
716 5th and 6th elements are used as brackets around the common match string which
717 can be completed using TAB,
718 7th element is the string displayed when there are a no matches, and
719 8th element is displayed if there is a single match (and faces are not used).
720 9th element is displayed when the current directory is non-readable.
721 10th element is displayed when directory exceeds `ido-max-directory-size'."
722 :type '(repeat string)
723 :group 'ido)
725 (defcustom ido-use-faces t
726 "*Non-nil means use ido faces to highlighting first match, only match and
727 subdirs in the alternatives."
728 :type 'boolean
729 :group 'ido)
731 (defface ido-first-match-face '((t (:bold t)))
732 "*Font used by ido for highlighting first match."
733 :group 'ido)
735 (defface ido-only-match-face '((((class color))
736 (:foreground "ForestGreen"))
737 (t (:italic t)))
738 "*Font used by ido for highlighting only match."
739 :group 'ido)
741 (defface ido-subdir-face '((((class color))
742 (:foreground "red"))
743 (t (:underline t)))
744 "*Font used by ido for highlighting subdirs in the alternatives."
745 :group 'ido)
747 (defface ido-indicator-face '((((class color))
748 (:foreground "yellow"
749 :background "red"
750 :width condensed))
751 (t (:inverse-video t)))
752 "*Font used by ido for highlighting its indicators."
753 :group 'ido)
755 (defcustom ido-make-file-list-hook nil
756 "*List of functions to run when the list of matching files is created.
757 Each function on the list may modify the dynamically bound variable
758 `ido-temp-list' which contains the current list of matching files."
759 :type 'hook
760 :group 'ido)
762 (defcustom ido-make-dir-list-hook nil
763 "*List of functions to run when the list of matching directories is created.
764 Each function on the list may modify the dynamically bound variable
765 `ido-temp-list' which contains the current list of matching directories."
766 :type 'hook
767 :group 'ido)
769 (defcustom ido-make-buffer-list-hook nil
770 "*List of functions to run when the list of matching buffers is created.
771 Each function on the list may modify the dynamically bound variable
772 `ido-temp-list' which contains the current list of matching buffer names."
773 :type 'hook
774 :group 'ido)
776 (defcustom ido-rewrite-file-prompt-functions nil
777 "*List of functions to run when the find-file prompt is created.
778 Each function on the list may modify the following dynamically bound
779 variables:
780 dirname - the (abbreviated) directory name
781 to be modified by the hook functions
782 max-width - the max width of the resulting dirname; nil means no limit
783 prompt - the basic prompt (e.g. \"Find File: \")
784 literal - the string shown if doing \"literal\" find; set to nil to omit
785 vc-off - the string shown if version control is inhibited; set to nit to omit
786 prefix - either nil or a fixed prefix for the dirname
788 The following variables are available, but should not be changed:
789 ido-current-directory - the unabbreviated directory name
790 item - equals `file' or `dir' depending on the current mode."
791 :type 'hook
792 :group 'ido)
794 (defvar ido-rewrite-file-prompt-rules nil
795 "*Alist of rewriting rules for directory names in ido prompts.
796 A list of elements of the form (FROM . TO) or (FROM . FUNC), each
797 meaning to rewrite the directory name if matched by FROM by either
798 substituting the matched string by TO or calling the function FUNC
799 with the current directory name as its only argument and using the
800 return value as the new directory name. In addition, each FUNC may
801 also modify the dynamic variables described for the variable
802 `ido-rewrite-file-prompt-functions'.")
804 (defcustom ido-completion-buffer "*Ido Completions*"
805 "*Name of completion buffer used by ido.
806 Set to nil to disable completion buffers popping up."
807 :type 'string
808 :group 'ido)
810 (defcustom ido-completion-buffer-all-completions nil
811 "*Non-nil means to show all completions in completion buffer.
812 Otherwise, only the current list of matches is shown."
813 :type 'boolean
814 :group 'ido)
816 (defvar ido-all-frames 'visible
817 "*Argument to pass to `walk-windows' when finding visible files.
818 See documentation of `walk-windows' for useful values.")
820 (defcustom ido-minibuffer-setup-hook nil
821 "*Ido-specific customization of minibuffer setup.
823 This hook is run during minibuffer setup iff `ido' will be active.
824 It is intended for use in customizing ido for interoperation
825 with other packages. For instance:
827 \(add-hook 'ido-minibuffer-setup-hook
828 \(function
829 \(lambda ()
830 \(make-local-variable 'max-mini-window-height)
831 \(setq max-mini-window-height 3))))
833 will constrain Emacs to a maximum minibuffer height of 3 lines when
834 ido is running. Copied from `icomplete-minibuffer-setup-hook'."
835 :type 'hook
836 :group 'ido)
838 (defcustom ido-save-directory-list-file "~/.ido.last"
839 "File in which the ido state is saved between invocations.
840 Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
841 `ido-work-file-list', and `ido-dir-file-cache'.
842 Must be set before enabling ido mode."
843 :type 'string
844 :group 'ido)
846 (defcustom ido-read-file-name-as-directory-commands '()
847 "List of commands which uses read-file-name to read a directory name.
848 When `ido-everywhere' is non-nil, the commands in this list will read
849 the directory using ido-read-directory-name."
850 :type '(repeat symbol)
851 :group 'ido)
853 (defcustom ido-read-file-name-non-ido '()
854 "List of commands which shall not read file names the ido way.
855 When `ido-everywhere' is non-nil, the commands in this list will read
856 the file name using normal read-file-name style."
857 :type '(repeat symbol)
858 :group 'ido)
860 ;;; Internal Variables
862 ;; Persistent variables
864 (defvar ido-mode-map nil
865 "Keymap for `ido-find-file' and `ido-switch-buffer'.")
867 (defvar ido-file-history nil
868 "History of files selected using `ido-find-file'.")
870 (defvar ido-buffer-history nil
871 "History of buffers selected using `ido-switch-buffer'.")
873 (defvar ido-last-directory-list nil
874 "List of last selected directory names.
875 See `ido-enable-last-directory-history' for details.")
877 (defvar ido-work-directory-list nil
878 "List of actual working directory names.
879 The current directory is inserted at the front of this list whenever a
880 file is opened with ido-find-file and family.")
882 (defvar ido-work-file-list nil
883 "List of actual work file names.
884 Opening a file with `ido-find-file' and similar functions
885 inserts the current file name (relative to its containing directory)
886 at the front of this list.")
888 (defvar ido-dir-file-cache nil
889 "List of `file-name-all-completions' results.
890 Each element in the list is of the form (DIR (MTIME) FILE...).")
892 (defvar ido-ignore-item-temp-list nil
893 "List of items to ignore in current ido invocation.
894 Intended to be let-bound by functions which calls ido repeatedly.
895 Should never be set permanently.")
897 ;; Temporary storage
899 (defvar ido-eoinput 1
900 "Point where minibuffer input ends and completion info begins.
901 Copied from `icomplete-eoinput'.")
902 (make-variable-buffer-local 'ido-eoinput)
904 (defvar ido-common-match-string nil
905 "Stores the string that is common to all matching files.")
907 (defvar ido-rescan nil
908 "Non-nil means we need to regenerate the list of matching items.")
910 (defvar ido-rotate nil
911 "Non-nil means we are rotating list of matches.")
913 (defvar ido-text nil
914 "Stores the users string as it is typed in.")
916 (defvar ido-text-init nil
917 "The initial string for the users string it is typed in.")
919 (defvar ido-matches nil
920 "List of files currently matching `ido-text'.")
922 (defvar ido-report-no-match t
923 "Report [No Match] when no completions matches ido-text.")
925 (defvar ido-exit nil
926 "Flag to monitor how `ido-find-file' exits.
927 If equal to `takeprompt', we use the prompt as the file name to be
928 selected.")
930 (defvar ido-current-directory nil
931 "Current directory for ido-find-file.")
933 (defvar ido-auto-merge-timer nil
934 "Delay timer for auto merge.")
936 (defvar ido-use-mycompletion-depth 0
937 "Non-nil means use `ido' completion feedback.
938 Is set by ido functions to the current minibuffer-depth, so that
939 it doesn't interfere with other minibuffer usage.")
942 ;;; Variables with dynamic bindings.
943 ;;; Declared here to keep the byte compiler quiet.
945 ;; Stores the current ido item type ('file, 'dir, 'buffer, or 'list).
946 (defvar ido-cur-item)
948 ;; Stores the current list of items that will be searched through.
949 ;; The list is ordered, so that the most interesting item comes first,
950 ;; although by default, the files visible in the current frame are put
951 ;; at the end of the list. Created by `ido-make-item-list'.
952 (defvar ido-cur-list)
954 ;; Stores the choice list for ido-completing-read
955 (defvar ido-choice-list)
957 ;; Stores the list of items which are ignored when building
958 ;; `ido-cur-list'. It is in no specific order.
959 (defvar ido-ignored-list)
961 ;; Remember if current directory is non-readable (so we cannot do completion).
962 (defvar ido-directory-nonreadable)
964 ;; Remember if current directory is 'huge' (so we don't want to do completion).
965 (defvar ido-directory-too-big)
967 ;; Keep current item list if non-nil.
968 (defvar ido-keep-item-list)
970 ;; Process ido-ignore-* lists.
971 (defvar ido-process-ignore-lists)
973 ;; Don't process ido-ignore- lists once.
974 (defvar ido-process-ignore-lists-inhibit)
976 ;; Buffer from which ido was entered.
977 (defvar ido-entry-buffer)
979 ;; Non-nil if matching file must be selected.
980 (defvar ido-require-match)
982 ;; Stores a temporary version of the file list being created.
983 (defvar ido-temp-list)
985 ;; Non-nil if default list element should be rotated into place.
986 (defvar ido-rotate-temp)
988 ;; Stores current index in ido-work-directory-list.
989 (defvar ido-work-directory-index)
991 ;; Stores current index in ido-work-file-list.
992 (defvar ido-work-file-index)
994 ;; Set when merged work directory list is in use.
995 (defvar ido-use-merged-list)
997 ;; Set when merged work directory list not yet built.
998 (defvar ido-try-merged-list)
1000 ;; Saved state prior to last work directory merge.
1001 ;; Value is a list (ido-text dir cur-list ignored-list matches).
1002 (defvar ido-pre-merge-state)
1004 ;; Original value of vc-handled-backends for use in ido-toggle-vc.
1005 (defvar ido-saved-vc-hb)
1007 ;; Stores temporary state of literal find file.
1008 (defvar ido-find-literal)
1010 ;; Set to 'ignore to inhibit switching between find-file/switch-buffer.
1011 (defvar ido-context-switch-command)
1013 ;;; FUNCTIONS
1015 (defun ido-active (&optional merge)
1016 (if merge
1017 ido-use-merged-list
1018 (and (boundp 'ido-completing-read) (= ido-use-mycompletion-depth (minibuffer-depth)))))
1020 (defvar ido-trace-enable nil)
1022 (defun ido-trace (p &optional s retval)
1023 (if ido-trace-enable
1024 (let ((b (get-buffer-create " *IDO Trace*"))
1025 (deactivate-mark deactivate-mark))
1026 (save-excursion
1027 (save-restriction
1028 (set-buffer b)
1029 (insert p ": " (if (stringp s) s (format "%S" s)) "\n")))))
1030 retval)
1032 (defun ido-toggle-trace (arg)
1033 (interactive "P")
1034 (setq ido-trace-enable (or arg (not ido-trace-enable)))
1035 (if ido-trace-enable
1036 (message "IDO trace on"))
1037 (let ((b (get-buffer " *IDO Trace*")))
1038 (if b
1039 (if ido-trace-enable
1040 (kill-buffer b)
1041 (pop-to-buffer b t t)
1042 (setq truncate-lines t)))))
1044 (defun ido-is-tramp-root (&optional dir)
1045 (setq dir (or dir ido-current-directory))
1046 (and ido-enable-tramp-completion
1047 (string-match "\\`/[^/][^/]+:\\([^/:@]+@\\)?\\'" dir)))
1049 (defun ido-is-root-directory (&optional dir)
1050 (setq dir (or dir ido-current-directory))
1052 (string-equal "/" dir)
1053 (and (memq system-type '(windows-nt ms-dos))
1054 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir))
1055 (if ido-enable-tramp-completion
1056 (ido-is-tramp-root dir)
1057 (string-match "\\`/[^:/][^:/]+:\\'" dir))))
1059 (defun ido-is-ftp-directory (&optional dir)
1060 (string-match
1061 (if ido-enable-tramp-completion
1062 "\\`/[^/:][^/:]+:" ;; like tramp-file-name-regexp-unified, but doesn't match single drive letters
1063 "\\`/[^/:][^/:]+:/")
1064 (or dir ido-current-directory)))
1066 (defun ido-is-slow-ftp-host (&optional dir)
1067 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps)
1068 (setq dir (or dir ido-current-directory))
1069 ;; (featurep 'ange-ftp)
1070 ;; (ange-ftp-ftp-name dir)
1071 (string-match
1072 (if ido-enable-tramp-completion
1073 "\\`/\\([^/]+[@:]\\)*\\([^@/:][^@/:]+\\):"
1074 "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/")
1075 dir)
1076 (let ((host (substring dir (match-beginning 2) (match-end 2))))
1077 (or (member host ido-slow-ftp-hosts)
1078 (let ((re ido-slow-ftp-host-regexps))
1079 (while (and re (not (string-match (car re) host)))
1080 (setq re (cdr re)))
1081 re)))))
1083 (defun ido-time-stamp (&optional time)
1084 ;; Time is a floating point number (fractions of 1 hour)
1085 (setq time (or time (current-time)))
1086 (/ (+ (* (car time) 65536.0) (car (cdr time))) 3600.0))
1088 (defun ido-cache-ftp-valid (&optional time)
1089 (and (numberp ido-cache-ftp-work-directory-time)
1090 (> ido-cache-ftp-work-directory-time 0)
1091 (or (not time)
1092 (< (- (ido-time-stamp) time) ido-cache-ftp-work-directory-time))))
1094 (defun ido-may-cache-directory (&optional dir)
1095 (setq dir (or dir ido-current-directory))
1096 (cond
1097 ((ido-directory-too-big-p dir)
1098 nil)
1099 ((and (ido-is-root-directory dir)
1100 (or ido-enable-tramp-completion
1101 (memq system-type '(windows-nt ms-dos))))
1102 nil)
1103 ((not (ido-is-ftp-directory dir))
1105 ((ido-cache-ftp-valid)
1106 t)))
1108 (defun ido-pp (list &optional sep)
1109 (let ((print-level nil) (eval-expression-print-level nil)
1110 (print-length nil) (eval-expression-print-length nil))
1111 (insert "\n;; ----- " (symbol-name list) " -----\n(\n ")
1112 (setq list (symbol-value list))
1113 (while list
1114 (let* ((elt (car list))
1115 (s (if (consp elt) (car elt) elt)))
1116 (if (and (stringp s) (= (length s) 0))
1117 (setq s nil))
1118 (if s
1119 (prin1 elt (current-buffer)))
1120 (if (and (setq list (cdr list)) s)
1121 (insert (or sep "\n ")))))
1122 (insert "\n)\n")))
1124 (defun ido-save-history ()
1125 "Save ido history and cache information between sessions."
1126 (interactive)
1127 (if (and ido-last-directory-list ido-save-directory-list-file)
1128 (save-excursion
1129 (save-window-excursion
1130 (if (find-buffer-visiting ido-save-directory-list-file)
1131 (kill-buffer (find-buffer-visiting ido-save-directory-list-file)))
1132 (if (file-exists-p ido-save-directory-list-file)
1133 (delete-file ido-save-directory-list-file))
1134 (set-buffer (let ((enable-local-variables nil))
1135 (find-file-noselect ido-save-directory-list-file t)))
1136 (goto-char (point-min))
1137 (delete-region (point-min) (point-max))
1138 (ido-pp 'ido-last-directory-list)
1139 (ido-pp 'ido-work-directory-list)
1140 (ido-pp 'ido-work-file-list)
1141 (ido-pp 'ido-dir-file-cache "\n\n ")
1142 (insert "\n")
1143 (let ((version-control 'never))
1144 (write-file ido-save-directory-list-file nil))
1145 (kill-buffer (current-buffer))))))
1147 (defun ido-load-history (&optional arg)
1148 "Load ido history and cache information from previous session.
1149 With prefix argument, reload history unconditionally."
1150 (interactive "P")
1151 (if (or arg (and ido-save-directory-list-file (not ido-last-directory-list)))
1152 (let ((file (expand-file-name ido-save-directory-list-file))
1153 buf)
1154 (when (file-readable-p file)
1155 (save-excursion
1156 (save-window-excursion
1157 (setq buf (set-buffer (let ((enable-local-variables nil))
1158 (find-file-noselect file))))
1159 (goto-char (point-min))
1160 (condition-case nil
1161 (setq ido-last-directory-list (read (current-buffer))
1162 ido-work-directory-list (read (current-buffer))
1163 ido-work-file-list (read (current-buffer))
1164 ido-dir-file-cache (read (current-buffer)))
1165 (error nil))))
1166 (kill-buffer buf))))
1167 (ido-wash-history))
1169 (defun ido-wash-history ()
1170 "Clean-up ido history and cache information.
1171 Removes badly formatted data and ignored directories."
1172 (interactive)
1173 ;; Check format of each of our lists, discard bogus elements
1174 (setq ido-last-directory-list
1175 (and (listp ido-last-directory-list)
1176 (let ((l ido-last-directory-list) r)
1177 (while l
1178 (if (and (consp (car l))
1179 (stringp (car (car l)))
1180 (stringp (cdr (car l))))
1181 (setq r (cons (car l) r)))
1182 (setq l (cdr l)))
1183 (nreverse r))))
1184 (setq ido-work-directory-list
1185 (and (listp ido-work-directory-list)
1186 (let ((l ido-work-directory-list) r)
1187 (while l
1188 (if (and (stringp (car l))
1189 (or ido-record-ftp-work-directories
1190 (not (ido-is-ftp-directory (car l)))))
1191 (setq r (cons (car l) r)))
1192 (setq l (cdr l)))
1193 (nreverse r))))
1194 (setq ido-work-file-list
1195 (and (listp ido-work-file-list)
1196 (let ((l ido-work-file-list) r)
1197 (while l
1198 (if (stringp (car l))
1199 (setq r (cons (car l) r)))
1200 (setq l (cdr l)))
1201 (nreverse r))))
1202 (setq ido-dir-file-cache
1203 (and (listp ido-dir-file-cache)
1204 (let ((l ido-dir-file-cache) r)
1205 (while l
1206 (if (and (listp (car l))
1207 (> (length (car l)) 2)
1208 (let ((dir (car (car l)))
1209 (time (car (cdr (car l))))
1210 (files (cdr (cdr (car l)))))
1211 (and
1212 (stringp dir)
1213 (consp time)
1214 (if (integerp (car time))
1215 (and (/= (car time) 0)
1216 (integerp (car (cdr time)))
1217 (/= (car (cdr time)) 0)
1218 (ido-may-cache-directory dir))
1219 (and (eq (car time) 'ftp)
1220 (numberp (cdr time))
1221 (ido-is-ftp-directory dir)
1222 (ido-cache-ftp-valid (cdr time))))
1223 (let ((s files) (ok t))
1224 (while s
1225 (if (stringp (car s))
1226 (setq s (cdr s))
1227 (setq s nil ok nil)))
1228 ok))))
1229 (setq r (cons (car l) r)))
1230 (setq l (cdr l)))
1231 (nreverse r))))
1233 ;; Remove ignored directories from work directory list
1234 ;; according to ido-work-directory-list-ignore-regexps
1235 (if ido-work-directory-list
1236 (let ((dirs (reverse ido-work-directory-list)))
1237 (setq ido-work-directory-list nil)
1238 (while dirs
1239 (ido-record-work-directory (car dirs))
1240 (setq dirs (cdr dirs)))))
1241 ;; Get rid of text properties
1242 (let ((l ido-last-directory-list) e)
1243 (while l
1244 (setq e (car l) l (cdr l))
1245 (set-text-properties 0 (length (car e)) nil (car e))
1246 (set-text-properties 0 (length (cdr e)) nil (cdr e))))
1247 (let ((l ido-work-directory-list) e)
1248 (while l
1249 (setq e (car l) l (cdr l))
1250 (set-text-properties 0 (length e) nil e)))
1251 (let ((l ido-work-file-list) e)
1252 (while l
1253 (setq e (car l) l (cdr l))
1254 (set-text-properties 0 (length e) nil e)))
1255 (let ((l ido-dir-file-cache) e d)
1256 (while l
1257 (setq e (car l) l (cdr l))
1258 (if (listp e)
1259 (while e
1260 (setq d (car e) e (cdr e))
1261 (if (not (consp d))
1262 (set-text-properties 0 (length d) nil d))))))
1266 (defun ido-kill-emacs-hook ()
1267 ;; ido kill emacs hook
1268 (ido-save-history))
1270 (defvar ido-minor-mode-map-entry nil)
1272 ;;;###autoload
1273 (defun ido-mode (&optional arg)
1274 "Toggle ido speed-ups on or off.
1275 With ARG, turn ido speed-up on if arg is positive, off otherwise.
1276 Turning on ido-mode will remap (via a minor-mode keymap) the default
1277 keybindings for the `find-file' and `switch-to-buffer' families of
1278 commands to the ido versions of these functions.
1279 However, if ARG arg equals 'files, remap only commands for files, or
1280 if it equals 'buffers, remap only commands for buffer switching.
1281 This function also adds a hook to the minibuffer."
1282 (interactive "P")
1283 (setq ido-mode
1284 (cond
1285 ((null arg) (if ido-mode nil 'both))
1286 ((eq arg t) 'both)
1287 ((eq arg 'files) 'file)
1288 ((eq arg 'buffers) 'buffer)
1289 ((memq arg '(file buffer both)) arg)
1290 ((> (prefix-numeric-value arg) 0) 'both)
1291 (t nil)))
1293 (ido-everywhere (if ido-everywhere 1 -1))
1295 (when ido-mode
1296 (add-hook 'minibuffer-setup-hook 'ido-minibuffer-setup)
1297 (add-hook 'choose-completion-string-functions 'ido-choose-completion-string)
1298 (ido-load-history)
1300 (add-hook 'kill-emacs-hook 'ido-kill-emacs-hook)
1302 (unless ido-minor-mode-map-entry
1303 (setq ido-minor-mode-map-entry (cons 'ido-mode (make-sparse-keymap)))
1304 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry))
1306 (let ((map (cdr ido-minor-mode-map-entry)))
1307 (when (memq ido-mode '(file both))
1308 (define-key map [remap find-file] 'ido-find-file)
1309 (define-key map [remap find-file-read-only] 'ido-find-file-read-only)
1310 (define-key map [remap find-alternate-file] 'ido-find-alternate-file)
1311 (define-key map [remap write-file] 'ido-write-file)
1312 (define-key map [remap insert-file] 'ido-insert-file)
1313 (define-key map [remap list-directory] 'ido-list-directory)
1314 (define-key map [remap dired] 'ido-dired)
1315 (define-key map [remap find-file-other-window] 'ido-find-file-other-window)
1316 (define-key map [remap find-file-read-only-other-window] 'ido-find-file-read-only-other-window)
1317 (define-key map [remap find-file-other-frame] 'ido-find-file-other-frame)
1318 (define-key map [remap find-file-read-only-other-frame] 'ido-find-file-read-only-other-frame))
1320 (when (memq ido-mode '(buffer both))
1321 (define-key map [remap switch-to-buffer] 'ido-switch-buffer)
1322 (define-key map [remap switch-to-buffer-other-window] 'ido-switch-buffer-other-window)
1323 (define-key map [remap switch-to-buffer-other-frame] 'ido-switch-buffer-other-frame)
1324 (define-key map [remap insert-buffer] 'ido-insert-buffer)
1325 (define-key map [remap kill-buffer] 'ido-kill-buffer)
1326 (define-key map [remap display-buffer] 'ido-display-buffer)))))
1328 (defun ido-everywhere (arg)
1329 "Enable ido everywhere file and directory names are read."
1330 (interactive "P")
1331 (setq ido-everywhere (if arg
1332 (> (prefix-numeric-value arg) 0)
1333 (not ido-everywhere)))
1334 (setq read-file-name-function
1335 (and ido-everywhere (memq ido-mode '(both file))
1336 'ido-read-file-name))
1337 (setq read-buffer-function
1338 (and ido-everywhere (memq ido-mode '(both buffer))
1339 'ido-read-buffer)))
1342 ;;; IDO KEYMAP
1343 (defun ido-define-mode-map ()
1344 "Set up the keymap for `ido'."
1345 (let (map)
1346 ;; generated every time so that it can inherit new functions.
1348 (setq map (copy-keymap minibuffer-local-map))
1349 (define-key map "\C-a" 'ido-toggle-ignore)
1350 (define-key map "\C-c" 'ido-toggle-case)
1351 (define-key map "\C-e" 'ido-edit-input)
1352 (define-key map "\t" 'ido-complete)
1353 (define-key map " " 'ido-complete-space)
1354 (define-key map "\C-j" 'ido-select-text)
1355 (define-key map "\C-m" 'ido-exit-minibuffer)
1356 (define-key map "\C-p" 'ido-toggle-prefix)
1357 (define-key map "\C-r" 'ido-prev-match)
1358 (define-key map "\C-s" 'ido-next-match)
1359 (define-key map "\C-t" 'ido-toggle-regexp)
1360 (define-key map "\C-z" 'ido-undo-merge-work-directory)
1361 (define-key map [(control ? )] 'ido-restrict-to-matches)
1362 (define-key map [(control ?@)] 'ido-restrict-to-matches)
1363 (define-key map [right] 'ido-next-match)
1364 (define-key map [left] 'ido-prev-match)
1365 (define-key map "?" 'ido-completion-help)
1367 (when (memq ido-cur-item '(file dir))
1368 (define-key map "\C-b" (or ido-context-switch-command 'ido-enter-switch-buffer))
1369 (define-key map "\C-d" (or (and ido-context-switch-command 'ignore) 'ido-enter-dired))
1370 (define-key map "\C-f" 'ido-fallback-command)
1371 (define-key map [down] 'ido-next-match-dir)
1372 (define-key map [up] 'ido-prev-match-dir)
1373 (define-key map [(meta up)] 'ido-prev-work-directory)
1374 (define-key map [(meta down)] 'ido-next-work-directory)
1375 (define-key map [backspace] 'ido-delete-backward-updir)
1376 (define-key map "\d" 'ido-delete-backward-updir)
1377 (define-key map [(meta backspace)] 'ido-delete-backward-word-updir)
1378 (define-key map [(control backspace)] 'ido-up-directory)
1379 (define-key map "\C-l" 'ido-reread-directory)
1380 (define-key map [(meta ?b)] 'ido-next-work-file)
1381 (define-key map [(meta ?d)] 'ido-wide-find-dir)
1382 (define-key map [(meta ?f)] 'ido-wide-find-file)
1383 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1384 (define-key map [(meta ?m)] 'ido-make-directory)
1385 (define-key map [(meta ?n)] 'ido-next-work-directory)
1386 (define-key map [(meta ?o)] 'ido-prev-work-file)
1387 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1388 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1391 (when (eq ido-cur-item 'file)
1392 (define-key map "\C-k" 'ido-delete-file-at-head)
1393 (define-key map "\C-o" 'ido-copy-current-word)
1394 (define-key map "\C-w" 'ido-copy-current-file-name)
1395 (define-key map [(meta ?l)] 'ido-toggle-literal)
1396 (define-key map "\C-v" 'ido-toggle-vc)
1399 (when (eq ido-cur-item 'buffer)
1400 (define-key map "\C-f" (or ido-context-switch-command 'ido-enter-find-file))
1401 (define-key map "\C-b" 'ido-fallback-command)
1402 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1405 (when (if (boundp 'viper-mode) viper-mode)
1406 (define-key map [remap viper-intercept-ESC-key] 'ignore)
1407 (when (memq ido-cur-item '(file dir))
1408 (define-key map [remap viper-backward-char] 'ido-delete-backward-updir)
1409 (define-key map [remap viper-del-backward-char-in-insert] 'ido-delete-backward-updir)
1410 (define-key map [remap viper-delete-backward-word] 'ido-delete-backward-word-updir)))
1412 (setq ido-mode-map map)
1413 (run-hooks 'ido-define-mode-map-hook)))
1415 (defun ido-final-slash (dir &optional fix-it)
1416 ;; return DIR if DIR has final slash.
1417 ;; else if FIX-IT is non-nil, return DIR/
1418 ;; else return nil.
1419 (setq dir (ido-name dir))
1420 (cond
1421 ((string-match "/\\'" dir) dir)
1422 ((ido-is-tramp-root dir) dir)
1423 (fix-it (concat dir "/"))
1424 (t nil)))
1426 (defun ido-no-final-slash (s)
1427 ;; Remove optional final slash from string S
1428 (let ((l (1- (length s))))
1429 (if (and (> l 0) (eq (aref s l) ?/))
1430 (substring s 0 l)
1431 s)))
1433 (defun ido-nonreadable-directory-p (dir)
1434 ;; Return t if dir is a directory, but not readable
1435 ;; Do not check for non-readable directories via tramp, as this causes a premature
1436 ;; connect on incomplete tramp paths (after entring just method:).
1437 (let ((ido-enable-tramp-completion nil))
1438 (and (ido-final-slash dir)
1439 (file-directory-p dir)
1440 (not (file-readable-p dir)))))
1442 (defun ido-directory-too-big-p (dir)
1443 ;; Return t if dir is a directory, but too big to show
1444 ;; Do not check for non-readable directories via tramp, as this causes a premature
1445 ;; connect on incomplete tramp paths (after entring just method:).
1446 (let ((ido-enable-tramp-completion nil))
1447 (and (numberp ido-max-directory-size)
1448 (ido-final-slash dir)
1449 (file-directory-p dir)
1450 (> (nth 7 (file-attributes dir)) ido-max-directory-size))))
1452 (defun ido-set-current-directory (dir &optional subdir no-merge)
1453 ;; Set ido's current directory to DIR or DIR/SUBDIR
1454 (setq dir (ido-final-slash dir t))
1455 (setq ido-use-merged-list nil
1456 ido-try-merged-list (not no-merge))
1457 (if subdir
1458 (setq dir (ido-final-slash (concat dir subdir) t)))
1459 (if (equal dir ido-current-directory)
1461 (ido-trace "cd" dir)
1462 (setq ido-current-directory dir)
1463 (if (get-buffer ido-completion-buffer)
1464 (kill-buffer ido-completion-buffer))
1465 (setq ido-directory-nonreadable (ido-nonreadable-directory-p dir))
1466 (setq ido-directory-too-big (and (not ido-directory-nonreadable)
1467 (ido-directory-too-big-p dir)))
1470 (defun ido-set-current-home (&optional dir)
1471 ;; Set ido's current directory to user's home directory
1472 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1474 (defun ido-record-command (command arg)
1475 ;; Add (command arg) to command-history if ido-record-commands is t
1476 (if ido-record-commands
1477 (let ((cmd (list command arg)))
1478 (if (or (not command-history)
1479 (not (equal cmd (car command-history))))
1480 (setq command-history (cons cmd command-history))))))
1482 (defun ido-make-prompt (item prompt)
1483 ;; Make the prompt for ido-read-internal
1484 (cond
1485 ((and (memq item '(file dir)) ido-current-directory)
1486 (let ((dirname (abbreviate-file-name ido-current-directory))
1487 (max-width (if (and ido-max-file-prompt-width (floatp ido-max-file-prompt-width))
1488 (floor (* (frame-width) ido-max-file-prompt-width))
1489 ido-max-file-prompt-width))
1490 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1491 (vc-off (and ido-saved-vc-hb (not vc-handled-backends) "[-VC] "))
1492 (prefix nil)
1493 (rule ido-rewrite-file-prompt-rules))
1494 (let ((case-fold-search nil))
1495 (while rule
1496 (if (and (consp (car rule))
1497 (string-match (car (car rule)) dirname))
1498 (setq dirname
1499 (if (stringp (cdr (car rule)))
1500 (replace-match (cdr (car rule)) t nil dirname)
1501 (funcall (cdr (car rule)) dirname))))
1502 (setq rule (cdr rule))))
1503 (run-hooks 'ido-rewrite-file-prompt-functions)
1504 (concat prompt
1505 ; (if ido-process-ignore-lists "" "&")
1506 (or literal "")
1507 (or vc-off "")
1508 (or prefix "")
1509 (let ((l (length dirname)))
1510 (if (and max-width (> max-width 0) (> l max-width))
1511 (let* ((s (substring dirname (- max-width)))
1512 (i (string-match "/" s)))
1513 (concat "..." (if i (substring s i) s)))
1514 dirname)))))
1515 (t prompt)))
1517 ;; Here is very briefly how ido-find-file works:
1519 ;; (ido-find-file)
1520 ;; (ido-file-internal method)
1521 ;; set ido-current-directory
1522 ;; (ido-read-internal 'file ...)
1523 ;; (while ...
1524 ;; (ido-make-item-list ...)
1525 ;; (ido-set-matches)
1526 ;; (completing-read ... ido-text-init ...)
1528 ;; ... here user is allowed to type characters and commands
1529 ;; a command may set ido-exit and call (exit-minibuffer)
1530 ;; to make ido-read-internal do advanced tasks (or return)
1532 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1533 ;; which are run before and after each user command.
1535 ;; return value from completing-read is stored in ido-final-text
1536 ;; - ido-exit may cause further actions to be taken:
1537 ;; 'refresh - repeat loop (make-item-list, set-matches)
1538 ;; 'edit - edit the prompt string, then repeat loop
1539 ;; 'keep - repeat loop but don't (re)make-item-list
1540 ;; 'updir - go up one directory, repeat loop
1541 ;; else set ido-selected based on ido-final-text,
1542 ;; optionally update ido-current-directory and repeat loop, or
1543 ;; exit with the return value of ido-selected (file name)
1544 ;; selected file name is returned from ido-read-internal,
1545 ;; ido-exit and method determines what action is taken
1546 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1547 ;; the relevant function is called (find-file, write-file, etc).
1549 (defun ido-read-internal (item prompt history &optional default require-match initial)
1550 "Perform the ido-read-buffer and ido-read-file-name functions.
1551 Return the name of a buffer or file selected.
1552 PROMPT is the prompt to give to the user.
1553 DEFAULT if given is the default directory to start with.
1554 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1555 If INITIAL is non-nil, it specifies the initial input string."
1556 (let
1557 ((ido-cur-item item)
1558 (ido-entry-buffer (current-buffer))
1559 (ido-process-ignore-lists t)
1560 (ido-process-ignore-lists-inhibit nil)
1561 (ido-set-default-item t)
1562 ido-default-item
1563 ido-selected
1564 ido-final-text
1565 (done nil)
1566 (icomplete-mode nil) ;; prevent icomplete starting up
1567 ;; Exported dynamic variables:
1568 ido-cur-list
1569 ido-ignored-list
1570 (ido-rotate-temp nil)
1571 (ido-keep-item-list nil)
1572 (ido-use-merged-list nil)
1573 (ido-try-merged-list t)
1574 (ido-pre-merge-state nil)
1575 (ido-case-fold ido-case-fold)
1576 (ido-enable-prefix ido-enable-prefix)
1577 (ido-enable-regexp ido-enable-regexp)
1580 (ido-define-mode-map)
1581 (setq ido-text-init initial)
1582 (while (not done)
1583 (ido-trace "\n_LOOP_" ido-text-init)
1584 (setq ido-exit nil)
1585 (setq ido-rescan t)
1586 (setq ido-rotate nil)
1587 (setq ido-text "")
1588 (when ido-set-default-item
1589 (setq ido-default-item
1590 (cond
1591 ((eq item 'buffer)
1592 (if (bufferp default) (buffer-name default) default))
1593 ((stringp default) default)
1594 ((eq item 'file)
1595 (and ido-enable-last-directory-history
1596 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1597 (and d (cdr d)))))))
1598 (if (member ido-default-item ido-ignore-item-temp-list)
1599 (setq ido-default-item nil))
1600 (setq ido-set-default-item nil))
1602 (if ido-process-ignore-lists-inhibit
1603 (setq ido-process-ignore-lists nil))
1605 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1606 (let ((olist ido-cur-list)
1607 (oign ido-ignored-list)
1608 (omat ido-matches)
1609 (l (ido-make-merged-file-list ido-text-init
1610 (eq ido-use-merged-list 'auto)
1611 (eq ido-try-merged-list 'wide))))
1612 (cond
1613 ((not l)
1614 (if (eq ido-try-merged-list 'wide)
1615 (setq ido-pre-merge-state
1616 (list "" ido-current-directory olist oign omat)
1617 ido-cur-list nil
1618 ido-ignored-list nil
1619 ido-matches nil
1620 ido-keep-item-list t
1621 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1622 ido-use-merged-list nil)
1623 (setq ido-cur-list olist
1624 ido-ignored-list oign
1625 ido-matches omat
1626 ido-keep-item-list t
1627 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1628 ido-use-merged-list nil)))
1629 ((eq l t)
1630 (setq ido-use-merged-list nil))
1632 (setq ido-pre-merge-state
1633 (list ido-text-init ido-current-directory olist oign omat))
1634 (ido-set-current-directory (car (cdr (car l))))
1635 (if (ido-final-slash ido-text-init)
1636 (setq ido-text-init ""))
1637 (setq ido-cur-list l
1638 ido-ignored-list nil
1639 ido-matches l
1640 ido-rescan nil
1641 ido-keep-item-list t
1642 ido-use-merged-list t)
1643 (ido-trace "Merged" t)
1644 ))))
1646 (cond
1647 (ido-keep-item-list
1648 (setq ido-keep-item-list nil
1649 ido-rescan nil))
1650 ((eq ido-cur-item 'file)
1651 (setq ido-ignored-list nil
1652 ido-cur-list (and (not ido-directory-nonreadable)
1653 (not ido-directory-too-big)
1654 (ido-make-file-list ido-default-item))))
1655 ((eq ido-cur-item 'dir)
1656 (setq ido-ignored-list nil
1657 ido-cur-list (and (not ido-directory-nonreadable)
1658 (not ido-directory-too-big)
1659 (ido-make-dir-list ido-default-item))))
1660 ((eq ido-cur-item 'buffer)
1661 (setq ido-ignored-list nil
1662 ido-cur-list (ido-make-buffer-list ido-default-item)))
1663 ((eq ido-cur-item 'list)
1664 (setq ido-ignored-list nil
1665 ido-cur-list (ido-make-choice-list ido-default-item)))
1666 (t nil))
1667 (setq ido-rotate-temp nil)
1669 (if ido-process-ignore-lists-inhibit
1670 (setq ido-process-ignore-lists t
1671 ido-process-ignore-lists-inhibit nil))
1673 (ido-set-matches)
1674 (if (and ido-matches (eq ido-try-merged-list 'auto))
1675 (setq ido-try-merged-list t))
1676 (let
1677 ((minibuffer-local-completion-map ido-mode-map)
1678 (max-mini-window-height (or ido-max-window-height
1679 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1680 (ido-completing-read t)
1681 (ido-require-match require-match)
1682 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1683 (show-paren-mode nil))
1684 ;; prompt the user for the file name
1685 (setq ido-exit nil)
1686 (setq ido-final-text
1687 (catch 'ido
1688 (completing-read
1689 (ido-make-prompt item prompt)
1690 '(("dummy" . 1)) nil nil ; table predicate require-match
1691 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1692 history))))
1693 (ido-trace "completing-read" ido-final-text)
1694 (if (get-buffer ido-completion-buffer)
1695 (kill-buffer ido-completion-buffer))
1697 (ido-trace "\n_EXIT_" ido-exit)
1699 (cond
1700 ((eq ido-exit 'refresh)
1701 (if (and (eq ido-use-merged-list 'auto)
1702 (or (input-pending-p)))
1703 (setq ido-use-merged-list nil
1704 ido-keep-item-list t))
1705 nil)
1707 ((eq ido-exit 'done)
1708 (setq done t
1709 ido-selected ido-text
1710 ido-exit nil))
1712 ((memq ido-exit '(edit chdir))
1713 (cond
1714 ((memq ido-cur-item '(file dir))
1715 (let* ((read-file-name-function nil)
1716 (edit (eq ido-exit 'edit))
1717 (d ido-current-directory)
1718 (f ido-text-init)
1719 (new t))
1720 (setq ido-text-init "")
1721 (while new
1722 (setq new (if edit
1723 (read-file-name (concat prompt "[EDIT] ")
1724 (expand-file-name d)
1725 (concat d f) nil f)
1727 d (or (file-name-directory new) "/")
1728 f (file-name-nondirectory new)
1729 edit t)
1730 (if (or
1731 (file-directory-p d)
1732 (and (yes-or-no-p (format "Create directory %s? " d))
1733 (condition-case nil
1734 (progn (make-directory d t) t)
1735 (error
1736 (message "Could not create directory")
1737 (sit-for 1)
1738 nil))))
1739 (progn
1740 (ido-set-current-directory d nil (eq ido-exit 'chdir))
1741 (setq ido-text-init f
1742 new nil))))))
1744 (setq ido-text-init (read-string (concat prompt "[EDIT] ") ido-final-text))))
1745 nil)
1747 ((eq ido-exit 'keep)
1748 (setq ido-keep-item-list t))
1750 ((memq ido-exit '(dired fallback find-file switch-to-buffer insert-buffer insert-file))
1751 (setq done t))
1753 ((eq ido-exit 'updir)
1754 ;; cannot go up if already at the root-dir (Unix) or at the
1755 ;; root-dir of a certain drive (Windows or MS-DOS).
1756 (if (ido-is-tramp-root)
1757 (when (string-match "\\`\\(/\\([^/]+[:@]\\)*\\)\\([^/]+\\)[:@]\\'" ido-current-directory)
1758 (setq ido-text-init (match-string 3 ido-current-directory))
1759 (ido-set-current-directory (match-string 1 ido-current-directory))
1760 (setq ido-set-default-item t))
1761 (unless (ido-is-root-directory)
1762 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1)))
1763 (setq ido-set-default-item t))))
1765 ;; Handling the require-match must be done in a better way.
1766 ((and require-match
1767 (not (if ido-directory-too-big
1768 (file-exists-p (concat ido-current-directory ido-final-text))
1769 (ido-existing-item-p))))
1770 (error "must specify valid item"))
1773 (setq ido-selected
1774 (if (or (eq ido-exit 'takeprompt)
1775 (null ido-matches))
1776 ido-final-text
1777 ;; else take head of list
1778 (ido-name (car ido-matches))))
1780 (cond
1781 ((eq item 'buffer)
1782 (setq done t))
1784 ((string-equal "./" ido-selected)
1785 nil)
1787 ((string-equal "../" ido-selected)
1788 ;; cannot go up if already at the root-dir (Unix) or at the
1789 ;; root-dir of a certain drive (Windows or MS-DOS).
1790 (or (ido-is-root-directory)
1791 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1792 (setq ido-set-default-item t))
1794 ((and (string-match (if ido-enable-tramp-completion "..[:@]\\'" "..:\\'") ido-selected)
1795 (ido-is-root-directory)) ;; Ange-ftp or Tramp
1796 (ido-set-current-directory ido-current-directory ido-selected)
1797 (ido-trace "tramp prefix" ido-selected)
1798 (if (ido-is-slow-ftp-host)
1799 (setq ido-exit 'fallback
1800 done t)
1801 (setq ido-set-default-item t)))
1802 ((or (string-match "[/\\][^/\\]" ido-selected)
1803 (and (memq system-type '(windows-nt ms-dos))
1804 (string-match "\\`.:" ido-selected)))
1805 (ido-set-current-directory (file-name-directory ido-selected))
1806 (setq ido-set-default-item t))
1808 ((string-match "\\`~" ido-selected)
1809 (ido-set-current-home ido-selected))
1811 ((ido-final-slash ido-selected)
1812 (if ido-enable-last-directory-history
1813 (let ((x (assoc ido-current-directory ido-last-directory-list)))
1814 (if x
1815 (setcdr x ido-selected)
1816 (setq ido-last-directory-list
1817 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
1818 (ido-set-current-directory ido-current-directory ido-selected)
1819 (setq ido-set-default-item t))
1822 (setq done t))))))
1823 ido-selected))
1825 (defun ido-edit-input ()
1826 "Edit absolute file name entered so far with ido; terminate by RET."
1827 (interactive)
1828 (setq ido-text-init ido-text)
1829 (setq ido-exit 'edit)
1830 (exit-minibuffer))
1832 ;;; MAIN FUNCTIONS
1833 (defun ido-buffer-internal (method &optional fallback prompt default initial switch-cmd)
1834 ;; Internal function for ido-switch-buffer and friends
1835 (if (not ido-mode)
1836 (call-interactively (or fallback 'switch-to-buffer))
1837 (let* ((ido-context-switch-command switch-cmd)
1838 (ido-current-directory nil)
1839 (ido-directory-nonreadable nil)
1840 (ido-directory-too-big nil)
1841 (buf (ido-read-internal 'buffer (or prompt "Buffer: ") 'ido-buffer-history default nil initial)))
1843 ;; Choose the buffer name: either the text typed in, or the head
1844 ;; of the list of matches
1846 (cond
1847 ((eq ido-exit 'find-file)
1848 (ido-file-internal ido-default-file-method nil nil nil nil ido-text))
1850 ((eq ido-exit 'insert-file)
1851 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil ido-text 'ido-enter-insert-buffer))
1853 ((eq ido-exit 'fallback)
1854 (let ((read-buffer-function nil))
1855 (call-interactively (or fallback 'switch-to-buffer))))
1857 ;; Check buf is non-nil.
1858 ((not buf) nil)
1859 ((= (length buf) 0) nil)
1861 ;; View buffer if it exists
1862 ((get-buffer buf)
1863 (if (eq method 'insert)
1864 (progn
1865 (ido-record-command 'insert-buffer buf)
1866 (insert-buffer buf))
1867 (ido-visit-buffer buf method t)))
1869 ;; buffer doesn't exist
1870 ((eq ido-create-new-buffer 'never)
1871 (message "no buffer matching `%s'" buf))
1873 ((and (eq ido-create-new-buffer 'prompt)
1874 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
1875 nil)
1877 ;; create a new buffer
1879 (setq buf (get-buffer-create buf))
1880 (if (fboundp 'set-buffer-major-mode)
1881 (set-buffer-major-mode buf))
1882 (ido-visit-buffer buf method t))))))
1884 (defun ido-record-work-directory (&optional dir)
1885 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
1886 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
1887 (let ((items ido-work-directory-list-ignore-regexps)
1888 (case-fold-search nil))
1889 (while (and items dir)
1890 (if (string-match (car items) dir)
1891 (setq dir nil))
1892 (setq items (cdr items)))
1893 (if dir
1894 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
1895 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
1896 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
1898 (defun ido-forget-work-directory ()
1899 (interactive)
1900 (when (and ido-current-directory ido-work-directory-list)
1901 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
1902 (when ido-use-merged-list
1903 (ido-undo-merge-work-directory)
1904 (setq ido-exit 'refresh
1905 ido-try-merged-list t
1906 ido-use-merged-list t
1907 ido-text-init ido-text
1908 ido-rotate-temp t)
1909 (exit-minibuffer))))
1911 (defun ido-record-work-file (name)
1912 ;; Save NAME in ido-work-file-list
1913 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
1915 (and ido-work-file-list (equal (car ido-work-file-list) name))
1916 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
1917 (if (> (length ido-work-file-list) ido-max-work-file-list)
1918 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
1920 (defun ido-expand-directory (dir)
1921 ;; Expand DIR or use DEFAULT-DIRECTORY if nil.
1922 ;; Add final slash to result in case it was missing from DEFAULT-DIRECTORY.
1923 (ido-final-slash (expand-file-name (or dir default-directory)) t))
1925 (defun ido-file-internal (method &optional fallback default prompt item initial switch-cmd)
1926 ;; Internal function for ido-find-file and friends
1927 (unless item
1928 (setq item 'file))
1929 (let* ((ido-current-directory (ido-expand-directory default))
1930 (ido-directory-nonreadable (ido-nonreadable-directory-p ido-current-directory))
1931 (ido-directory-too-big (and (not ido-directory-nonreadable)
1932 (ido-directory-too-big-p ido-current-directory)))
1933 (ido-context-switch-command switch-cmd)
1934 filename)
1936 (cond
1937 ((or (not ido-mode) (ido-is-slow-ftp-host))
1938 (setq filename t
1939 ido-exit 'fallback))
1941 ((and (eq item 'file)
1942 (or ido-use-url-at-point ido-use-filename-at-point))
1943 (let (fn d)
1944 (require 'ffap)
1945 ;; Duplicate code from ffap-guesser as we want different behaviour for files and URLs.
1946 (cond
1947 ((and ido-use-url-at-point
1948 ffap-url-regexp
1949 (ffap-fixup-url (or (ffap-url-at-point)
1950 (ffap-gopher-at-point))))
1951 (setq ido-exit 'ffap
1952 filename t))
1954 ((and ido-use-filename-at-point
1955 (setq fn (ffap-string-at-point))
1956 (not (string-match "^http:/" fn))
1957 (setq d (file-name-directory fn))
1958 (file-directory-p d))
1959 (setq ido-current-directory d)
1960 (setq initial (file-name-nondirectory fn)))))))
1962 (let (ido-saved-vc-hb
1963 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
1964 (ido-work-directory-index -1)
1965 (ido-work-file-index -1)
1966 (ido-find-literal nil))
1968 (unless filename
1969 (setq ido-saved-vc-hb vc-handled-backends)
1970 (setq filename (ido-read-internal item
1971 (or prompt "Find file: ")
1972 'ido-file-history nil nil initial)))
1974 ;; Choose the file name: either the text typed in, or the head
1975 ;; of the list of matches
1977 (cond
1978 ((eq ido-exit 'fallback)
1979 ;; Need to guard setting of default-directory here, since
1980 ;; we don't want to change directory of current buffer.
1981 (let ((default-directory ido-current-directory)
1982 (read-file-name-function nil))
1983 (call-interactively (or fallback 'find-file))))
1985 ((eq ido-exit 'switch-to-buffer)
1986 (ido-buffer-internal ido-default-buffer-method nil nil nil ido-text))
1988 ((eq ido-exit 'insert-buffer)
1989 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil ido-text 'ido-enter-insert-file))
1991 ((eq ido-exit 'dired)
1992 (dired (concat ido-current-directory (or ido-text ""))))
1994 ((eq ido-exit 'ffap)
1995 (find-file-at-point))
1997 ((eq method 'alt-file)
1998 (ido-record-work-file filename)
1999 (setq default-directory ido-current-directory)
2000 (ido-record-work-directory)
2001 (find-alternate-file filename))
2003 ((memq method '(dired list-directory))
2004 (if (equal filename ".")
2005 (setq filename ""))
2006 (let* ((dirname (ido-final-slash (concat ido-current-directory filename) t))
2007 (file (substring dirname 0 -1)))
2008 (cond
2009 ((file-directory-p dirname)
2010 (ido-record-command method dirname)
2011 (ido-record-work-directory dirname)
2012 (funcall method dirname))
2013 ((file-directory-p ido-current-directory)
2014 (cond
2015 ((file-exists-p file)
2016 (ido-record-command method ido-current-directory)
2017 (ido-record-work-directory)
2018 (funcall method ido-current-directory)
2019 (if (eq method 'dired)
2020 (dired-goto-file (expand-file-name file))))
2021 ((string-match "[[*?]" filename)
2022 (setq dirname (concat ido-current-directory filename))
2023 (ido-record-command method dirname)
2024 (ido-record-work-directory)
2025 (funcall method dirname))
2026 ((y-or-n-p (format "Directory %s does not exist. Create it " filename))
2027 (ido-record-command method dirname)
2028 (ido-record-work-directory dirname)
2029 (make-directory-internal dirname)
2030 (funcall method dirname))
2032 ;; put make-directory command on history
2033 (ido-record-command 'make-directory dirname))))
2034 (t (error "No such directory")))))
2036 ((eq method 'write)
2037 (ido-record-work-file filename)
2038 (setq default-directory ido-current-directory)
2039 (ido-record-command 'write-file (concat ido-current-directory filename))
2040 (ido-record-work-directory)
2041 (write-file filename))
2043 ((eq method 'read-only)
2044 (ido-record-work-file filename)
2045 (setq filename (concat ido-current-directory filename))
2046 (ido-record-command fallback filename)
2047 (ido-record-work-directory)
2048 (funcall fallback filename))
2050 ((eq method 'insert)
2051 (ido-record-work-file filename)
2052 (setq filename (concat ido-current-directory filename))
2053 (ido-record-command
2054 (if ido-find-literal 'insert-file-literally 'insert-file)
2055 filename)
2056 (ido-record-work-directory)
2057 (if ido-find-literal
2058 (insert-file-contents-literally filename)
2059 (insert-file-contents filename)))
2061 (filename
2062 (ido-record-work-file filename)
2063 (setq filename (concat ido-current-directory filename))
2064 (ido-record-command 'find-file filename)
2065 (ido-record-work-directory)
2066 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
2068 (defun ido-existing-item-p ()
2069 ;; Return non-nil if there is a matching item
2070 (not (null ido-matches)))
2072 ;;; COMPLETION CODE
2074 (defun ido-set-common-completion ()
2075 ;; Find common completion of `ido-text' in `ido-matches'
2076 ;; The result is stored in `ido-common-match-string'
2077 (let* (val)
2078 (setq ido-common-match-string nil)
2079 (if (and ido-matches
2080 (not ido-enable-regexp) ;; testing
2081 (stringp ido-text)
2082 (> (length ido-text) 0))
2083 (if (setq val (ido-find-common-substring ido-matches ido-text))
2084 (setq ido-common-match-string val)))
2085 val))
2087 (defun ido-complete ()
2088 "Try and complete the current pattern amongst the file names."
2089 (interactive)
2090 (let (res)
2091 (cond
2092 ((and (memq ido-cur-item '(file dir))
2093 (string-match "[$]" ido-text))
2094 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
2095 (if (not (file-exists-p (file-name-directory evar)))
2096 (message "Expansion generates non-existing directory name")
2097 (if (file-directory-p evar)
2098 (ido-set-current-directory evar)
2099 (let ((d (or (file-name-directory evar) "/"))
2100 (f (file-name-nondirectory evar)))
2101 (when (file-directory-p d)
2102 (ido-set-current-directory d)
2103 (setq ido-text-init f))))
2104 (setq ido-exit 'refresh)
2105 (exit-minibuffer))))
2107 (ido-directory-too-big
2108 (setq ido-directory-too-big nil)
2109 (setq ido-text-init ido-text)
2110 (setq ido-exit 'refresh)
2111 (exit-minibuffer))
2113 ((not ido-matches)
2114 (when ido-completion-buffer
2115 (call-interactively (setq this-command ido-cannot-complete-command))))
2117 ((and (= 1 (length ido-matches))
2118 (not (and ido-enable-tramp-completion
2119 (string-equal ido-current-directory "/")
2120 (string-match "..[@:]\\'" (car ido-matches)))))
2121 ;; only one choice, so select it.
2122 (if (not ido-confirm-unique-completion)
2123 (exit-minibuffer)
2124 (setq ido-rescan (not ido-enable-prefix))
2125 (delete-region (minibuffer-prompt-end) (point))
2126 (insert (car ido-matches))))
2128 (t ;; else there could be some completions
2129 (setq res ido-common-match-string)
2130 (if (and (not (memq res '(t nil)))
2131 (not (equal res ido-text)))
2132 ;; found something to complete, so put it in the minibuffer.
2133 (progn
2134 ;; move exact match to front if not in prefix mode
2135 (setq ido-rescan (not ido-enable-prefix))
2136 (delete-region (minibuffer-prompt-end) (point))
2137 (insert res))
2138 ;; else nothing to complete
2139 (call-interactively (setq this-command ido-cannot-complete-command))
2140 )))))
2142 (defun ido-complete-space ()
2143 "Try completion unless inserting the space makes sense."
2144 (interactive)
2145 (if (and (stringp ido-common-match-string)
2146 (stringp ido-text)
2147 (cond
2148 ((> (length ido-common-match-string) (length ido-text))
2149 (= (aref ido-common-match-string (length ido-text)) ? ))
2150 (ido-matches
2151 (let (insert-space
2152 (re (concat (regexp-quote ido-text) " "))
2153 (comp ido-matches))
2154 (while comp
2155 (if (string-match re (ido-name (car comp)))
2156 (setq comp nil insert-space t)
2157 (setq comp (cdr comp))))
2158 insert-space))
2159 (t nil)))
2160 (insert " ")
2161 (ido-complete)))
2163 (defun ido-undo-merge-work-directory (&optional text try refresh)
2164 "Undo or redo last ido directory merge operation.
2165 If no merge has yet taken place, toggle automatic merging option."
2166 (interactive)
2167 (cond
2168 (ido-pre-merge-state
2169 (ido-set-current-directory (nth 1 ido-pre-merge-state))
2170 (setq ido-text-init (or text (car ido-pre-merge-state))
2171 ido-cur-list (nth 2 ido-pre-merge-state)
2172 ido-ignored-list (nth 3 ido-pre-merge-state)
2173 ido-matches (nth 4 ido-pre-merge-state)
2174 ido-use-merged-list nil
2175 ido-try-merged-list try
2176 ido-keep-item-list (not refresh)
2177 ido-rescan nil
2178 ido-exit 'refresh
2179 ido-pre-merge-state nil)
2180 (exit-minibuffer))
2181 (text
2182 nil)
2183 (ido-try-merged-list
2184 (setq ido-try-merged-list nil))
2185 (ido-matches
2186 (setq ido-try-merged-list t))
2187 ((not ido-use-merged-list)
2188 (ido-merge-work-directories))))
2190 ;;; TOGGLE FUNCTIONS
2192 (defun ido-toggle-case ()
2193 "Toggle the value of `ido-case-fold'."
2194 (interactive)
2195 (setq ido-case-fold (not ido-case-fold))
2196 ;; ask for list to be regenerated.
2197 (setq ido-rescan t))
2199 (defun ido-toggle-regexp ()
2200 "Toggle the value of `ido-enable-regexp'."
2201 (interactive)
2202 (setq ido-enable-regexp (not ido-enable-regexp))
2203 ;; ask for list to be regenerated.
2204 (setq ido-rescan t))
2206 (defun ido-toggle-prefix ()
2207 "Toggle the value of `ido-enable-prefix'."
2208 (interactive)
2209 (setq ido-enable-prefix (not ido-enable-prefix))
2210 ;; ask for list to be regenerated.
2211 (setq ido-rescan t))
2213 (defun ido-toggle-ignore ()
2214 "Toggle ignoring files specified with `ido-ignore-files'."
2215 (interactive)
2216 (if ido-directory-too-big
2217 (setq ido-directory-too-big nil)
2218 (setq ido-process-ignore-lists (not ido-process-ignore-lists)))
2219 (setq ido-text-init ido-text)
2220 (setq ido-exit 'refresh)
2221 (exit-minibuffer))
2223 (defun ido-toggle-vc ()
2224 "Disable version control for this file."
2225 (interactive)
2226 (if (and ido-mode (eq ido-cur-item 'file))
2227 (progn
2228 (setq vc-handled-backends
2229 (if vc-handled-backends nil ido-saved-vc-hb))
2230 (setq ido-text-init ido-text)
2231 (setq ido-exit 'keep)
2232 (exit-minibuffer))))
2234 (defun ido-toggle-literal ()
2235 "Toggle literal reading of this file."
2236 (interactive)
2237 (if (and ido-mode (eq ido-cur-item 'file))
2238 (progn
2239 (setq ido-find-literal (not ido-find-literal))
2240 (setq ido-text-init ido-text)
2241 (setq ido-exit 'keep)
2242 (exit-minibuffer))))
2244 (defun ido-reread-directory ()
2245 "Read current directory again.
2246 May be useful if cached version is no longer valid, but directory
2247 timestamp has not changed (e.g. with ftp or on Windows)."
2248 (interactive)
2249 (if (and ido-mode (eq ido-cur-item 'file))
2250 (progn
2251 (ido-remove-cached-dir ido-current-directory)
2252 (setq ido-text-init ido-text)
2253 (setq ido-rotate-temp t)
2254 (setq ido-exit 'refresh)
2255 (exit-minibuffer))))
2257 (defun ido-exit-minibuffer ()
2258 "Exit minibuffer, but make sure we have a match if one is needed."
2259 (interactive)
2260 (if (or (not ido-require-match)
2261 (ido-existing-item-p))
2262 (throw 'exit nil)))
2264 (defun ido-select-text ()
2265 "Select the buffer or file named by the prompt.
2266 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2267 (interactive)
2268 (setq ido-exit 'takeprompt)
2269 (exit-minibuffer))
2271 (defun ido-fallback-command ()
2272 "Fallback to non-ido version of current command."
2273 (interactive)
2274 (setq ido-exit 'fallback)
2275 (exit-minibuffer))
2277 (defun ido-enter-find-file ()
2278 "Drop into find-file from buffer switching."
2279 (interactive)
2280 (setq ido-exit 'find-file)
2281 (exit-minibuffer))
2283 (defun ido-enter-switch-buffer ()
2284 "Drop into ido-switch-buffer from file switching."
2285 (interactive)
2286 (setq ido-exit 'switch-to-buffer)
2287 (exit-minibuffer))
2289 (defun ido-enter-dired ()
2290 "Drop into dired from file switching."
2291 (interactive)
2292 (setq ido-exit 'dired)
2293 (exit-minibuffer))
2295 (defun ido-enter-insert-buffer ()
2296 "Drop into insert buffer from insert file."
2297 (interactive)
2298 (setq ido-exit 'insert-buffer)
2299 (exit-minibuffer))
2301 (defun ido-enter-insert-file ()
2302 "Drop into insert file from insert buffer."
2303 (interactive)
2304 (setq ido-exit 'insert-file)
2305 (exit-minibuffer))
2308 (defun ido-up-directory (&optional clear)
2309 "Go up one directory level."
2310 (interactive "P")
2311 (setq ido-text-init (if clear nil ido-text))
2312 (setq ido-exit 'updir)
2313 (setq ido-rotate-temp t)
2314 (exit-minibuffer))
2316 (defun ido-delete-backward-updir (count)
2317 "Delete char backwards, or at beginning of buffer, go up one level."
2318 (interactive "P")
2319 (cond
2320 ((= (minibuffer-prompt-end) (point))
2321 (if (not count)
2322 (ido-up-directory t)))
2323 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2324 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2325 ((eq this-original-command 'viper-backward-char)
2326 (funcall this-original-command (prefix-numeric-value count)))
2327 ((eq this-original-command 'viper-del-backward-char-in-insert)
2328 (funcall this-original-command))
2330 (delete-backward-char (prefix-numeric-value count)))))
2332 (defun ido-delete-backward-word-updir (count)
2333 "Delete all chars backwards, or at beginning of buffer, go up one level."
2334 (interactive "P")
2335 (if (= (minibuffer-prompt-end) (point))
2336 (if (not count)
2337 (ido-up-directory t))
2338 (if (eq this-original-command 'viper-delete-backward-word)
2339 (funcall this-original-command (prefix-numeric-value count))
2340 (backward-kill-word (prefix-numeric-value count)))))
2342 (defun ido-get-work-directory (&optional incr must-match)
2343 (let ((n (length ido-work-directory-list))
2344 (i ido-work-directory-index)
2345 (j 0)
2346 dir)
2347 (if (or (not ido-text) (= (length ido-text) 0))
2348 (setq must-match nil))
2349 (while (< j n)
2350 (setq i (+ i incr)
2351 j (1+ j))
2352 (if (> incr 0)
2353 (if (>= i n) (setq i 0))
2354 (if (< i 0) (setq i (1- n))))
2355 (setq dir (nth i ido-work-directory-list))
2356 (if (and dir
2357 (not (equal dir ido-current-directory))
2358 (file-directory-p dir)
2359 (or (not must-match)
2360 ;; TODO. check for nonreadable and too-big.
2361 (ido-set-matches1
2362 (if (eq ido-cur-item 'file)
2363 (ido-make-file-list1 dir)
2364 (ido-make-dir-list1 dir)))))
2365 (setq j n)
2366 (setq dir nil)))
2367 (if dir
2368 (setq ido-work-directory-index i))
2369 dir))
2371 (defun ido-prev-work-directory ()
2372 "Change to next working directory in list."
2373 (interactive)
2374 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2375 (when dir
2376 (ido-set-current-directory dir)
2377 (setq ido-exit 'refresh)
2378 (setq ido-text-init ido-text)
2379 (setq ido-rotate-temp t)
2380 (exit-minibuffer))))
2382 (defun ido-next-work-directory ()
2383 "Change to previous working directory in list."
2384 (interactive)
2385 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2386 (when dir
2387 (ido-set-current-directory dir)
2388 (setq ido-exit 'refresh)
2389 (setq ido-text-init ido-text)
2390 (setq ido-rotate-temp t)
2391 (exit-minibuffer))))
2393 (defun ido-merge-work-directories ()
2394 "Search (and merge) work directories for files matching the current input string."
2395 (interactive)
2396 (setq ido-use-merged-list t ido-try-merged-list t)
2397 (setq ido-exit 'refresh)
2398 (setq ido-text-init ido-text)
2399 (setq ido-rotate-temp t)
2400 (exit-minibuffer))
2402 (defun ido-wide-find-file (&optional file)
2403 "Prompt for FILE to search for using find, starting from current directory."
2404 (interactive)
2405 (unless file
2406 (let ((enable-recursive-minibuffers t))
2407 (setq file
2408 (read-string (concat "Wide find file: " ido-current-directory) ido-text))))
2409 (when (> (length file) 0)
2410 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2411 (setq ido-exit 'refresh)
2412 (setq ido-text-init file)
2413 (setq ido-rotate-temp t)
2414 (exit-minibuffer)))
2416 (defun ido-wide-find-dir (&optional dir)
2417 "Prompt for DIR to search for using find, starting from current directory."
2418 (interactive)
2419 (unless dir
2420 (let ((enable-recursive-minibuffers t))
2421 (setq dir
2422 (read-string (concat "Wide find directory: " ido-current-directory) ido-text))))
2423 (when (> (length dir) 0)
2424 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2425 (setq ido-exit 'refresh)
2426 (setq ido-text-init (ido-final-slash dir t))
2427 (setq ido-rotate-temp t)
2428 (exit-minibuffer)))
2430 (defun ido-make-directory (&optional dir)
2431 "Prompt for DIR to create in current directory."
2432 (interactive)
2433 (unless dir
2434 (let ((enable-recursive-minibuffers t))
2435 (setq dir
2436 (read-string (concat "Make directory: " ido-current-directory) ido-text))))
2437 (when (> (length dir) 0)
2438 (setq dir (concat ido-current-directory dir))
2439 (unless (file-exists-p dir)
2440 (make-directory dir t)
2441 (ido-set-current-directory dir)
2442 (setq ido-exit 'refresh)
2443 (setq ido-text-init nil)
2444 (setq ido-rotate-temp t)
2445 (exit-minibuffer))))
2447 (defun ido-get-work-file (incr)
2448 (let ((n (length ido-work-file-list))
2449 (i (+ ido-work-file-index incr))
2450 name)
2451 (if (> incr 0)
2452 (if (>= i n) (setq i 0))
2453 (if (< i 0) (setq i (1- n))))
2454 (setq name (nth i ido-work-file-list))
2455 (setq ido-work-file-index i)
2456 name))
2458 (defun ido-prev-work-file ()
2459 "Change to next working file name in list."
2460 (interactive)
2461 (let ((name (ido-get-work-file 1)))
2462 (when name
2463 (setq ido-text-init name)
2464 (setq ido-exit 'refresh)
2465 (exit-minibuffer))))
2467 (defun ido-next-work-file ()
2468 "Change to previous working file name in list."
2469 (interactive)
2470 (let ((name (ido-get-work-file -1)))
2471 (when name
2472 (setq ido-text-init name)
2473 (setq ido-exit 'refresh)
2474 (exit-minibuffer))))
2476 (defun ido-copy-current-file-name (all)
2477 "Insert file name of current buffer.
2478 If repeated, insert text from buffer instead."
2479 (interactive "P")
2480 (let* ((bfname (buffer-file-name ido-entry-buffer))
2481 (name (and bfname (file-name-nondirectory bfname))))
2482 (when name
2483 (setq ido-text-init
2484 (if (or all
2485 (not (equal (file-name-directory bfname) ido-current-directory))
2486 (not (string-match "\\.[^.]*\\'" name)))
2487 name
2488 (substring name 0 (1+ (match-beginning 0)))))
2489 (setq ido-exit 'refresh
2490 ido-try-merged-list nil)
2491 (exit-minibuffer))))
2493 (defun ido-copy-current-word (all)
2494 "Insert current word (file or directory name) from current buffer."
2495 (interactive "P")
2496 (let ((word (save-excursion
2497 (set-buffer ido-entry-buffer)
2498 (let ((p (point)) start-line end-line start-name name)
2499 (beginning-of-line)
2500 (setq start-line (point))
2501 (end-of-line)
2502 (setq end-line (point))
2503 (goto-char p)
2504 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
2505 (forward-char 1))
2506 (setq start-name (point))
2507 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
2508 (if (= start-name (point))
2510 (buffer-substring-no-properties start-name (point)))))))
2511 (if (cond
2512 ((not word) nil)
2513 ((string-match "\\`[~/]" word)
2514 (setq ido-text-init word
2515 ido-try-merged-list nil
2516 ido-exit 'chdir))
2517 ((string-match "/" word)
2518 (setq ido-text-init (concat ido-current-directory word)
2519 ido-try-merged-list nil
2520 ido-exit 'chdir))
2522 (setq ido-text-init word
2523 ido-try-merged-list nil
2524 ido-exit 'refresh)))
2525 (exit-minibuffer))))
2527 (defun ido-next-match ()
2528 "Put first element of `ido-matches' at the end of the list."
2529 (interactive)
2530 (if ido-matches
2531 (let ((next (cadr ido-matches)))
2532 (setq ido-cur-list (ido-chop ido-cur-list next))
2533 (setq ido-rescan t)
2534 (setq ido-rotate t))))
2536 (defun ido-prev-match ()
2537 "Put last element of `ido-matches' at the front of the list."
2538 (interactive)
2539 (if ido-matches
2540 (let ((prev (car (last ido-matches))))
2541 (setq ido-cur-list (ido-chop ido-cur-list prev))
2542 (setq ido-rescan t)
2543 (setq ido-rotate t))))
2545 (defun ido-next-match-dir ()
2546 "Find next directory in match list.
2547 If work directories have been merged, cycle through directories for
2548 first matching file."
2549 (interactive)
2550 (if ido-use-merged-list
2551 (if ido-matches
2552 (let* ((elt (car ido-matches))
2553 (dirs (cdr elt)))
2554 (when (> (length dirs) 1)
2555 (setcdr elt (ido-chop dirs (cadr dirs))))
2556 (setq ido-rescan nil)))
2557 (let ((cnt (length ido-matches))
2558 (i 1))
2559 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
2560 (setq i (1+ i)))
2561 (if (< i cnt)
2562 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2564 (defun ido-prev-match-dir ()
2565 "Find previous directory in match list.
2566 If work directories have been merged, cycle through directories
2567 for first matching file."
2568 (interactive)
2569 (if ido-use-merged-list
2570 (if ido-matches
2571 (let* ((elt (car ido-matches))
2572 (dirs (cdr elt)))
2573 (when (> (length dirs) 1)
2574 (setcdr elt (ido-chop dirs (car (last dirs)))))
2575 (setq ido-rescan nil)))
2576 (let* ((cnt (length ido-matches))
2577 (i (1- cnt)))
2578 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
2579 (setq i (1- i)))
2580 (if (> i 0)
2581 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2583 (defun ido-restrict-to-matches ()
2584 "Set current item list to the currently matched items."
2585 (interactive)
2586 (when ido-matches
2587 (setq ido-cur-list ido-matches
2588 ido-text-init ""
2589 ido-rescan nil
2590 ido-exit 'keep)
2591 (exit-minibuffer)))
2593 (defun ido-chop (items elem)
2594 "Remove all elements before ELEM and put them at the end of ITEMS."
2595 (let ((ret nil)
2596 (next nil)
2597 (sofar nil))
2598 (while (not ret)
2599 (setq next (car items))
2600 (if (equal next elem)
2601 (setq ret (append items (nreverse sofar)))
2602 ;; else
2603 (progn
2604 (setq items (cdr items))
2605 (setq sofar (cons next sofar)))))
2606 ret))
2608 (defun ido-name (item)
2609 ;; Return file name for current item, whether in a normal list
2610 ;; or a merged work directory list.
2611 (if (consp item) (car item) item))
2614 ;;; CREATE LIST OF ALL CURRENT FILES
2616 (defun ido-all-completions ()
2617 ;; Return unsorted list of all competions.
2618 (let ((ido-process-ignore-lists nil)
2619 (ido-directory-too-big nil))
2620 (cond
2621 ((eq ido-cur-item 'file)
2622 (ido-make-file-list1 ido-current-directory))
2623 ((eq ido-cur-item 'dir)
2624 (ido-make-dir-list1 ido-current-directory))
2625 ((eq ido-cur-item 'buffer)
2626 (ido-make-buffer-list1))
2627 ((eq ido-cur-item 'list)
2628 ido-choice-list)
2629 (t nil))))
2632 (defun ido-sort-list (items)
2633 ;; Simple list of file or buffer names
2634 (sort items (lambda (a b) (string-lessp (ido-no-final-slash a)
2635 (ido-no-final-slash b)))))
2637 (defun ido-sort-merged-list (items promote)
2638 ;; Input is list of ("file" . "dir") cons cells.
2639 ;; Output is sorted list of ("file "dir" ...) lists
2640 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
2641 res a cur dirs)
2642 (while l
2643 (setq a (car l)
2644 l (cdr l))
2645 (if (and res (string-equal (car (car res)) (car a)))
2646 (progn
2647 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
2648 (if (and promote (string-equal ido-current-directory (cdr a)))
2649 (setq cur t)))
2650 (setq res (cons (list (car a) (cdr a)) res)
2651 cur nil)))
2652 res))
2654 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
2655 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
2656 (let ((filenames
2657 (split-string
2658 (shell-command-to-string
2659 (concat "find " dir " -name \"" (if prefix "" "*") file "*\" -type " (if finddir "d" "f") " -print"))))
2660 filename d f
2661 res)
2662 (while filenames
2663 (setq filename (car filenames)
2664 filenames (cdr filenames))
2665 (if (and (string-match "^/" filename)
2666 (file-exists-p filename))
2667 (setq d (file-name-directory filename)
2668 f (file-name-nondirectory filename)
2669 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
2670 res))
2672 (defun ido-flatten-merged-list (items)
2673 ;; Create a list of directory names based on a merged directory list.
2674 (let (res)
2675 (while items
2676 (let* ((item (car items))
2677 (file (car item))
2678 (dirs (cdr item)))
2679 (while dirs
2680 (setq res (cons (concat (car dirs) file) res)
2681 dirs (cdr dirs))))
2682 (setq items (cdr items)))
2683 res))
2685 (defun ido-make-merged-file-list (text auto wide)
2686 (let (res)
2687 (message "Searching for `%s'...." text)
2688 (if (and (ido-final-slash text) ido-dir-file-cache)
2689 (if wide
2690 (setq res (ido-wide-find-dirs-or-files
2691 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
2692 ;; Use list of cached directories
2693 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
2694 (dirs ido-dir-file-cache)
2695 dir b d f)
2696 (if nil ;; simple
2697 (while dirs
2698 (setq dir (car (car dirs))
2699 dirs (cdr dirs))
2700 (when (and (string-match re dir)
2701 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
2702 (file-directory-p dir))
2703 (setq b (substring dir 0 -1)
2704 f (concat (file-name-nondirectory b) "/")
2705 d (file-name-directory b)
2706 res (cons (cons f d) res))))
2707 (while dirs
2708 (setq dir (car dirs)
2709 d (car dir)
2710 dirs (cdr dirs))
2711 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
2712 (setq dir (cdr (cdr dir)))
2713 (while dir
2714 (setq f (car dir)
2715 dir (cdr dir))
2716 (if (and (string-match re f)
2717 (not (ido-ignore-item-p f ido-ignore-directories)))
2718 (setq res (cons (cons f d) res)))))
2719 (if (and auto (input-pending-p))
2720 (setq dirs nil
2721 res t))))))
2722 (if wide
2723 (setq res (ido-wide-find-dirs-or-files
2724 ido-current-directory text ido-enable-prefix nil))
2725 (let ((ido-text text)
2726 (dirs ido-work-directory-list)
2727 (must-match (and text (> (length text) 0)))
2728 dir fl)
2729 (if (and auto (not (member ido-current-directory dirs)))
2730 (setq dirs (cons ido-current-directory dirs)))
2731 (while dirs
2732 (setq dir (car dirs)
2733 dirs (cdr dirs))
2734 (when (and dir (stringp dir)
2735 (or ido-merge-ftp-work-directories
2736 (not (ido-is-ftp-directory dir)))
2737 (file-directory-p dir)
2738 ;; TODO. check for nonreadable and too-big.
2739 (setq fl (if (eq ido-cur-item 'file)
2740 (ido-make-file-list1 dir t)
2741 (ido-make-dir-list1 dir t))))
2742 (if must-match
2743 (setq fl (ido-set-matches1 fl)))
2744 (if fl
2745 (setq res (nconc fl res))))
2746 (if (and auto (input-pending-p))
2747 (setq dirs nil
2748 res t))))))
2749 (if (and res (not (eq res t)))
2750 (setq res (ido-sort-merged-list res auto)))
2751 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
2752 (listp res)
2753 (> (length text) 0))
2754 (let ((elt (assoc text res)))
2755 (when (and elt (not (eq elt (car res))))
2756 (setq res (delq elt res))
2757 (setq res (cons elt res)))))
2758 (message nil)
2759 res))
2761 (defun ido-make-buffer-list1 (&optional frame visible)
2762 ;; Return list of non-ignored buffer names
2763 (delq nil
2764 (mapcar
2765 (lambda (x)
2766 (let ((name (buffer-name x)))
2767 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
2768 name)))
2769 (buffer-list frame))))
2771 (defun ido-make-buffer-list (default)
2772 ;; Return the current list of buffers.
2773 ;; Currently visible buffers are put at the end of the list.
2774 ;; The hook `ido-make-buflist-hook' is run after the list has been
2775 ;; created to allow the user to further modify the order of the buffer names
2776 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
2777 ;; it is put to the start of the list.
2778 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
2779 (ido-temp-list (ido-make-buffer-list1 (selected-frame) ido-current-buffers)))
2780 (if ido-temp-list
2781 (nconc ido-temp-list ido-current-buffers)
2782 (setq ido-temp-list ido-current-buffers))
2783 (if default
2784 (progn
2785 (setq ido-temp-list
2786 (delete default ido-temp-list))
2787 (setq ido-temp-list
2788 (cons default ido-temp-list))))
2789 (run-hooks 'ido-make-buffer-list-hook)
2790 ido-temp-list))
2792 (defun ido-make-choice-list (default)
2793 ;; Return the current list of choices.
2794 ;; If DEFAULT is non-nil, and corresponds to an element of choices,
2795 ;; it is put to the start of the list.
2796 (let ((ido-temp-list ido-choice-list))
2797 (if default
2798 (progn
2799 (setq ido-temp-list
2800 (delete default ido-temp-list))
2801 (setq ido-temp-list
2802 (cons default ido-temp-list))))
2803 ; (run-hooks 'ido-make-choice-list-hook)
2804 ido-temp-list))
2806 (defun ido-to-end (items)
2807 ;; Move the elements from ITEMS to the end of `ido-temp-list'
2808 (mapcar
2809 (lambda (elem)
2810 (setq ido-temp-list (delq elem ido-temp-list)))
2811 items)
2812 (if ido-temp-list
2813 (nconc ido-temp-list items)
2814 (setq ido-temp-list items)))
2816 (defun ido-file-name-all-completions1 (dir)
2817 (cond
2818 ((ido-nonreadable-directory-p dir) '())
2819 ;; do not check (ido-directory-too-big-p dir) here.
2820 ;; Caller must have done that if necessary.
2821 ((and ido-enable-tramp-completion
2822 (string-match "\\`/\\([^/:]+:\\([^/:@]+@\\)?\\)\\'" dir))
2824 ;; Trick tramp's file-name-all-completions handler to DTRT, as it
2825 ;; has some pretty obscure requirements. This seems to work...
2826 ;; /ftp: => (f-n-a-c "/ftp:" "")
2827 ;; /ftp:kfs: => (f-n-a-c "" "/ftp:kfs:")
2828 ;; /ftp:kfs@ => (f-n-a-c "ftp:kfs@" "/")
2829 ;; /ftp:kfs@kfs: => (f-n-a-c "" "/ftp:kfs@kfs:")
2830 ;; Currently no attempt is made to handle multi: stuff.
2832 (let* ((prefix (match-string 1 dir))
2833 (user-flag (match-beginning 2))
2834 (len (and prefix (length prefix)))
2835 compl)
2836 (if user-flag
2837 (setq dir (substring dir 1)))
2838 (require 'tramp nil t)
2839 (ido-trace "tramp complete" dir)
2840 (setq compl (file-name-all-completions dir (if user-flag "/" "")))
2841 (if (> len 0)
2842 (mapcar (lambda (c) (substring c len)) compl)
2843 compl)))
2845 (file-name-all-completions "" dir))))
2847 (defun ido-file-name-all-completions (dir)
2848 ;; Return name of all files in DIR
2849 ;; Uses and updates ido-dir-file-cache
2850 (if (and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
2851 (stringp dir) (> (length dir) 0)
2852 (ido-may-cache-directory dir))
2853 (let* ((cached (assoc dir ido-dir-file-cache))
2854 (ctime (nth 1 cached))
2855 (ftp (ido-is-ftp-directory dir))
2856 (attr (if ftp nil (file-attributes dir)))
2857 (mtime (nth 5 attr))
2858 valid)
2859 (when cached ; should we use the cached entry ?
2860 (if ftp
2861 (setq valid (and (eq (car ctime) 'ftp)
2862 (ido-cache-ftp-valid (cdr ctime))))
2863 (if attr
2864 (setq valid (and (= (car ctime) (car mtime))
2865 (= (car (cdr ctime)) (car (cdr mtime)))))))
2866 (if (not valid)
2867 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
2868 cached nil)))
2869 (unless cached
2870 (if (and ftp (file-readable-p dir))
2871 (setq mtime (cons 'ftp (ido-time-stamp))))
2872 (if mtime
2873 (setq cached (cons dir (cons mtime (ido-file-name-all-completions1 dir)))
2874 ido-dir-file-cache (cons cached ido-dir-file-cache)))
2875 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
2876 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
2877 (and cached
2878 (cdr (cdr cached))))
2879 (ido-file-name-all-completions1 dir)))
2881 (defun ido-remove-cached-dir (dir)
2882 ;; Remove dir from ido-dir-file-cache
2883 (if (and ido-dir-file-cache
2884 (stringp dir) (> (length dir) 0))
2885 (let ((cached (assoc dir ido-dir-file-cache)))
2886 (if cached
2887 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
2890 (defun ido-make-file-list1 (dir &optional merged)
2891 ;; Return list of non-ignored files in DIR
2892 ;; If MERGED is non-nil, each file is cons'ed with DIR
2893 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
2894 (delq nil
2895 (mapcar
2896 (lambda (name)
2897 (if (not (ido-ignore-item-p name ido-ignore-files t))
2898 (if merged (cons name dir) name)))
2899 (ido-file-name-all-completions dir)))))
2901 (defun ido-make-file-list (default)
2902 ;; Return the current list of files.
2903 ;; Currently visible files are put at the end of the list.
2904 ;; The hook `ido-make-file-list-hook' is run after the list has been
2905 ;; created to allow the user to further modify the order of the file names
2906 ;; in this list.
2907 (let ((ido-temp-list (ido-make-file-list1 ido-current-directory)))
2908 (setq ido-temp-list (ido-sort-list ido-temp-list))
2909 (let ((default-directory ido-current-directory))
2910 (ido-to-end ;; move ftp hosts and visited files to end
2911 (delq nil (mapcar
2912 (lambda (x) (if (or (string-match "..:\\'" x)
2913 (and (not (ido-final-slash x))
2914 (get-file-buffer x))) x))
2915 ido-temp-list))))
2916 (ido-to-end ;; move . files to end
2917 (delq nil (mapcar
2918 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2919 ido-temp-list)))
2920 (if (and default (member default ido-temp-list))
2921 (if (or ido-rotate-temp ido-rotate-file-list-default)
2922 (unless (equal default (car ido-temp-list))
2923 (let ((l ido-temp-list) k)
2924 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2925 (setq l (cdr l)))
2926 (setq k (cdr l))
2927 (setcdr l nil)
2928 (nconc k ido-temp-list)
2929 (setq ido-temp-list k)))
2930 (setq ido-temp-list
2931 (delete default ido-temp-list))
2932 (setq ido-temp-list
2933 (cons default ido-temp-list))))
2934 (when ido-show-dot-for-dired
2935 (setq ido-temp-list (delete "." ido-temp-list))
2936 (setq ido-temp-list (cons "." ido-temp-list)))
2937 (run-hooks 'ido-make-file-list-hook)
2938 ido-temp-list))
2940 (defun ido-make-dir-list1 (dir &optional merged)
2941 ;; Return list of non-ignored subdirs in DIR
2942 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
2943 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
2944 (delq nil
2945 (mapcar
2946 (lambda (name)
2947 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
2948 (if merged (cons name dir) name)))
2949 (ido-file-name-all-completions dir)))))
2951 (defun ido-make-dir-list (default)
2952 ;; Return the current list of directories.
2953 ;; The hook `ido-make-dir-list-hook' is run after the list has been
2954 ;; created to allow the user to further modify the order of the
2955 ;; directory names in this list.
2956 (let ((ido-temp-list (ido-make-dir-list1 ido-current-directory)))
2957 (setq ido-temp-list (ido-sort-list ido-temp-list))
2958 (ido-to-end ;; move . files to end
2959 (delq nil (mapcar
2960 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2961 ido-temp-list)))
2962 (if (and default (member default ido-temp-list))
2963 (if (or ido-rotate-temp ido-rotate-file-list-default)
2964 (unless (equal default (car ido-temp-list))
2965 (let ((l ido-temp-list) k)
2966 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2967 (setq l (cdr l)))
2968 (setq k (cdr l))
2969 (setcdr l nil)
2970 (nconc k ido-temp-list)
2971 (setq ido-temp-list k)))
2972 (setq ido-temp-list
2973 (delete default ido-temp-list))
2974 (setq ido-temp-list
2975 (cons default ido-temp-list))))
2976 (setq ido-temp-list (delete "." ido-temp-list))
2977 (setq ido-temp-list (cons "." ido-temp-list))
2978 (run-hooks 'ido-make-dir-list-hook)
2979 ido-temp-list))
2981 ;; List of the files visible in the current frame.
2982 (defvar ido-bufs-in-frame)
2984 (defun ido-get-buffers-in-frames (&optional current)
2985 ;; Return the list of buffers that are visible in the current frame.
2986 ;; If optional argument `current' is given, restrict searching to the
2987 ;; current frame, rather than all frames, regardless of value of
2988 ;; `ido-all-frames'.
2989 (let ((ido-bufs-in-frame nil))
2990 (walk-windows 'ido-get-bufname nil
2991 (if current
2993 ido-all-frames))
2994 ido-bufs-in-frame))
2996 (defun ido-get-bufname (win)
2997 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
2998 (let ((buf (buffer-name (window-buffer win))))
2999 (unless (or (member buf ido-bufs-in-frame)
3000 (member buf ido-ignore-item-temp-list))
3001 ;; Only add buf if it is not already in list.
3002 ;; This prevents same buf in two different windows being
3003 ;; put into the list twice.
3004 (setq ido-bufs-in-frame
3005 (cons buf ido-bufs-in-frame)))))
3007 ;;; FIND MATCHING ITEMS
3009 (defun ido-set-matches1 (items &optional do-full)
3010 ;; Return list of matches in items
3011 (let* ((case-fold-search ido-case-fold)
3012 (slash (and (not ido-enable-prefix) (ido-final-slash ido-text)))
3013 (text (if slash (substring ido-text 0 -1) ido-text))
3014 (rexq (concat (if ido-enable-regexp text (regexp-quote text)) (if slash ".*/" "")))
3015 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
3016 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" re))
3017 (concat "\\`" re "\\'")))
3018 (prefix-re (and full-re (not ido-enable-prefix)
3019 (concat "\\`" rexq)))
3020 (non-prefix-dot (or (not ido-enable-dot-prefix)
3021 (not ido-process-ignore-lists)
3022 ido-enable-prefix
3023 (= (length ido-text) 0)))
3025 full-matches
3026 prefix-matches
3027 matches)
3028 (mapcar
3029 (lambda (item)
3030 (let ((name (ido-name item)))
3031 (if (and (or non-prefix-dot
3032 (if (= (aref ido-text 0) ?.)
3033 (= (aref name 0) ?.)
3034 (/= (aref name 0) ?.)))
3035 (string-match re name))
3036 (cond
3037 ((and full-re (string-match full-re name))
3038 (setq full-matches (cons item full-matches)))
3039 ((and prefix-re (string-match prefix-re name))
3040 (setq prefix-matches (cons item prefix-matches)))
3041 (t (setq matches (cons item matches))))))
3043 items)
3044 (if prefix-matches
3045 (setq matches (nconc prefix-matches matches)))
3046 (if full-matches
3047 (setq matches (nconc full-matches matches)))
3048 (when (and (null matches)
3049 ido-enable-flex-matching
3050 (> (length ido-text) 1)
3051 (not ido-enable-regexp))
3052 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
3053 (if ido-enable-prefix
3054 (setq re (concat "\\`" re)))
3055 (mapcar
3056 (lambda (item)
3057 (let ((name (ido-name item)))
3058 (if (string-match re name)
3059 (setq matches (cons item matches)))))
3060 items))
3061 matches))
3064 (defun ido-set-matches ()
3065 ;; Set `ido-matches' to the list of items matching prompt
3066 (when ido-rescan
3067 (setq ido-matches (ido-set-matches1 (reverse ido-cur-list) (not ido-rotate))
3068 ido-rotate nil)))
3070 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
3071 ;; Return t if the buffer or file NAME should be ignored.
3072 (or (member name ido-ignore-item-temp-list)
3073 (and
3074 ido-process-ignore-lists re-list
3075 (let ((data (match-data))
3076 (ext-list (and ignore-ext ido-ignore-extensions
3077 completion-ignored-extensions))
3078 ignorep nextstr
3079 (flen (length name)) slen)
3080 (while ext-list
3081 (setq nextstr (car ext-list))
3082 (if (cond
3083 ((stringp nextstr)
3084 (and (>= flen (setq slen (length nextstr)))
3085 (string-equal (substring name (- flen slen)) nextstr)))
3086 ((fboundp nextstr) (funcall nextstr name))
3087 (t nil))
3088 (setq ignorep t
3089 ext-list nil
3090 re-list nil)
3091 (setq ext-list (cdr ext-list))))
3092 (while re-list
3093 (setq nextstr (car re-list))
3094 (if (cond
3095 ((stringp nextstr) (string-match nextstr name))
3096 ((fboundp nextstr) (funcall nextstr name))
3097 (t nil))
3098 (setq ignorep t
3099 re-list nil)
3100 (setq re-list (cdr re-list))))
3101 ;; return the result
3102 (if ignorep
3103 (setq ido-ignored-list (cons name ido-ignored-list)))
3104 (set-match-data data)
3105 ignorep))))
3108 ;; Private variable used by `ido-word-matching-substring'.
3109 (defvar ido-change-word-sub)
3111 (defun ido-find-common-substring (items subs)
3112 ;; Return common string following SUBS in each element of ITEMS.
3113 (let (res
3114 alist
3115 ido-change-word-sub)
3116 (setq ido-change-word-sub
3117 (if ido-enable-regexp
3118 subs
3119 (regexp-quote subs)))
3120 (setq res (mapcar #'ido-word-matching-substring items))
3121 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
3122 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
3124 ;; try-completion returns t if there is an exact match.
3125 (let* ((completion-ignore-case ido-case-fold)
3126 (comp (try-completion subs alist)))
3127 (if (eq comp t)
3128 subs
3129 comp))))
3131 (defun ido-word-matching-substring (word)
3132 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
3133 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
3134 (let ((case-fold-search ido-case-fold))
3135 (let ((m (string-match ido-change-word-sub (ido-name word))))
3136 (if m
3137 (substring (ido-name word) m)
3138 ;; else no match
3139 nil))))
3141 (defun ido-makealist (res)
3142 ;; Return dotted pair (RES . 1).
3143 (cons res 1))
3145 (defun ido-choose-completion-string (choice buffer mini-p base-size)
3146 (when (ido-active)
3147 ;; Insert the completion into the buffer where completion was requested.
3148 (if (get-buffer ido-completion-buffer)
3149 (kill-buffer ido-completion-buffer))
3150 (cond
3151 ((ido-active t) ;; ido-use-merged-list
3152 (setq ido-current-directory ""
3153 ido-text choice
3154 ido-exit 'done))
3155 ((not (ido-final-slash choice))
3156 (setq ido-text choice
3157 ido-exit 'done))
3159 (ido-set-current-directory ido-current-directory choice)
3160 (setq ido-exit 'refresh)))
3161 (exit-minibuffer)
3164 (defun ido-completion-help ()
3165 "Show possible completions in a *File Completions* buffer."
3166 (interactive)
3167 (setq ido-rescan nil)
3168 (let ((temp-buf (get-buffer ido-completion-buffer))
3169 display-it full-list)
3170 (if (and (eq last-command this-command) temp-buf)
3171 ;; scroll buffer
3172 (let (win (buf (current-buffer)))
3173 (display-buffer temp-buf nil nil)
3174 (set-buffer temp-buf)
3175 (setq win (get-buffer-window temp-buf))
3176 (if (pos-visible-in-window-p (point-max) win)
3177 (if (or ido-completion-buffer-all-completions (boundp 'ido-completion-buffer-full))
3178 (set-window-start win (point-min))
3179 (set (make-local-variable 'ido-completion-buffer-full) t)
3180 (setq full-list t
3181 display-it t))
3182 (scroll-other-window))
3183 (set-buffer buf))
3184 (setq display-it t))
3185 (if display-it
3186 (with-output-to-temp-buffer ido-completion-buffer
3187 (let ((completion-list (ido-sort-list
3188 (cond
3189 (ido-use-merged-list
3190 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
3191 ((or full-list ido-completion-buffer-all-completions)
3192 (ido-all-completions))
3194 (copy-sequence (or ido-matches ido-cur-list)))))))
3195 (if (featurep 'xemacs)
3196 ;; XEmacs extents are put on by default, doesn't seem to be
3197 ;; any way of switching them off.
3198 ;; This obscure code avoids a byte compiler warning in Emacs.
3199 (let ((f 'display-completion-list))
3200 (funcall f completion-list
3201 :help-string "ido "
3202 :activate-callback
3203 '(lambda (x y z) (message "doesn't work yet, sorry!"))))
3204 ;; else running Emacs
3205 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
3206 (display-completion-list completion-list)))))))
3208 ;;; KILL CURRENT BUFFER
3209 (defun ido-kill-buffer-at-head ()
3210 "Kill the buffer at the head of `ido-matches'."
3211 (interactive)
3212 (let ((enable-recursive-minibuffers t)
3213 (buf (car ido-matches)))
3214 (when buf
3215 (kill-buffer buf)
3216 ;; Check if buffer still exists.
3217 (if (get-buffer buf)
3218 ;; buffer couldn't be killed.
3219 (setq ido-rescan t)
3220 ;; else buffer was killed so remove name from list.
3221 (setq ido-cur-list (delq buf ido-cur-list))))))
3223 ;;; DELETE CURRENT FILE
3224 (defun ido-delete-file-at-head ()
3225 "Delete the file at the head of `ido-matches'."
3226 (interactive)
3227 (let ((enable-recursive-minibuffers t)
3228 (file (car ido-matches)))
3229 (if file
3230 (setq file (concat ido-current-directory file)))
3231 (when (and file
3232 (file-exists-p file)
3233 (not (file-directory-p file))
3234 (file-writable-p ido-current-directory)
3235 (yes-or-no-p (concat "Delete " file " ")))
3236 (delete-file file)
3237 ;; Check if file still exists.
3238 (if (file-exists-p file)
3239 ;; file could not be deleted
3240 (setq ido-rescan t)
3241 ;; else file was killed so remove name from list.
3242 (setq ido-cur-list (delq (car ido-matches) ido-cur-list))))))
3245 ;;; VISIT CHOSEN BUFFER
3246 (defun ido-visit-buffer (buffer method &optional record)
3247 "Visit file named FILE according to METHOD.
3248 Record command in command-history if optional RECORD is non-nil."
3250 (let (win newframe)
3251 (cond
3252 ((eq method 'kill)
3253 (if record
3254 (ido-record-command 'kill-buffer buffer))
3255 (kill-buffer buffer))
3257 ((eq method 'samewindow)
3258 (if record
3259 (ido-record-command 'switch-to-buffer buffer))
3260 (switch-to-buffer buffer))
3262 ((memq method '(always-frame maybe-frame))
3263 (cond
3264 ((and window-system
3265 (setq win (ido-window-buffer-p buffer))
3266 (or (eq method 'always-frame)
3267 (y-or-n-p "Jump to frame? ")))
3268 (setq newframe (window-frame win))
3269 (if (fboundp 'select-frame-set-input-focus)
3270 (select-frame-set-input-focus newframe)
3271 (raise-frame newframe)
3272 (select-frame newframe)
3273 (unless (featurep 'xemacs)
3274 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
3275 (select-window win))
3277 ;; No buffer in other frames...
3278 (if record
3279 (ido-record-command 'switch-to-buffer buffer))
3280 (switch-to-buffer buffer)
3283 ((eq method 'otherwindow)
3284 (if record
3285 (ido-record-command 'switch-to-buffer buffer))
3286 (switch-to-buffer-other-window buffer))
3288 ((eq method 'display)
3289 (display-buffer buffer))
3291 ((eq method 'otherframe)
3292 (switch-to-buffer-other-frame buffer)
3293 (unless (featurep 'xemacs)
3294 (select-frame-set-input-focus (selected-frame)))
3295 ))))
3298 (defun ido-window-buffer-p (buffer)
3299 ;; Return window pointer if BUFFER is visible in another frame.
3300 ;; If BUFFER is visible in the current frame, return nil.
3301 (let ((blist (ido-get-buffers-in-frames 'current)))
3302 ;;If the buffer is visible in current frame, return nil
3303 (if (member buffer blist)
3305 ;; maybe in other frame or icon
3306 (get-buffer-window buffer 0) ; better than 'visible
3310 ;;; ----------- IDONIZED FUNCTIONS ------------
3312 ;;;###autoload
3313 (defun ido-switch-buffer ()
3314 "Switch to another buffer.
3315 The buffer is displayed according to `ido-default-buffer-method' -- the
3316 default is to show it in the same window, unless it is already visible
3317 in another frame.
3319 As you type in a string, all of the buffers matching the string are
3320 displayed if substring-matching is used \(default). Look at
3321 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
3322 buffer you want, it can then be selected. As you type, most keys have their
3323 normal keybindings, except for the following: \\<ido-mode-map>
3325 RET Select the buffer at the front of the list of matches. If the
3326 list is empty, possibly prompt to create new buffer.
3328 \\[ido-select-text] Select the current prompt as the buffer.
3329 If no buffer is found, prompt for a new one.
3331 \\[ido-next-match] Put the first element at the end of the list.
3332 \\[ido-prev-match] Put the last element at the start of the list.
3333 \\[ido-complete] Complete a common suffix to the current string that
3334 matches all buffers. If there is only one match, select that buffer.
3335 If there is no common suffix, show a list of all matching buffers
3336 in a separate window.
3337 \\[ido-edit-input] Edit input string.
3338 \\[ido-fallback-command] Fallback to non-ido version of current command.
3339 \\[ido-toggle-regexp] Toggle regexp searching.
3340 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3341 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
3342 \\[ido-completion-help] Show list of matching buffers in separate window.
3343 \\[ido-enter-find-file] Drop into ido-find-file.
3344 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
3345 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
3346 (interactive)
3347 (ido-buffer-internal ido-default-buffer-method))
3349 ;;;###autoload
3350 (defun ido-switch-buffer-other-window ()
3351 "Switch to another buffer and show it in another window.
3352 The buffer name is selected interactively by typing a substring.
3353 For details of keybindings, do `\\[describe-function] ido'."
3354 (interactive)
3355 (ido-buffer-internal 'otherwindow 'switch-to-buffer-other-window))
3357 ;;;###autoload
3358 (defun ido-display-buffer ()
3359 "Display a buffer in another window but don't select it.
3360 The buffer name is selected interactively by typing a substring.
3361 For details of keybindings, do `\\[describe-function] ido'."
3362 (interactive)
3363 (ido-buffer-internal 'display 'display-buffer nil nil nil 'ignore))
3365 ;;;###autoload
3366 (defun ido-kill-buffer ()
3367 "Kill a buffer.
3368 The buffer name is selected interactively by typing a substring.
3369 For details of keybindings, do `\\[describe-function] ido'."
3370 (interactive)
3371 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer)) nil 'ignore))
3373 ;;;###autoload
3374 (defun ido-insert-buffer ()
3375 "Insert contents of a buffer in current buffer after point.
3376 The buffer name is selected interactively by typing a substring.
3377 For details of keybindings, do `\\[describe-function] ido'."
3378 (interactive)
3379 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil nil 'ido-enter-insert-file))
3381 ;;;###autoload
3382 (defun ido-switch-buffer-other-frame ()
3383 "Switch to another buffer and show it in another frame.
3384 The buffer name is selected interactively by typing a substring.
3385 For details of keybindings, do `\\[describe-function] ido'."
3386 (interactive)
3387 (if ido-mode
3388 (ido-buffer-internal 'otherframe)
3389 (call-interactively 'switch-to-buffer-other-frame)))
3391 ;;;###autoload
3392 (defun ido-find-file-in-dir (dir)
3393 "Switch to another file starting from DIR."
3394 (interactive "DDir: ")
3395 (if (not (equal (substring dir -1) "/"))
3396 (setq dir (concat dir "/")))
3397 (ido-file-internal ido-default-file-method nil dir nil nil nil 'ignore))
3399 ;;;###autoload
3400 (defun ido-find-file ()
3401 "Edit file with name obtained via minibuffer.
3402 The file is displayed according to `ido-default-file-method' -- the
3403 default is to show it in the same window, unless it is already
3404 visible in another frame.
3406 The file name is selected interactively by typing a substring. As you type
3407 in a string, all of the filenames matching the string are displayed if
3408 substring-matching is used \(default). Look at `ido-enable-prefix' and
3409 `ido-toggle-prefix'. When you have found the filename you want, it can
3410 then be selected. As you type, most keys have their normal keybindings,
3411 except for the following: \\<ido-mode-map>
3413 RET Select the file at the front of the list of matches. If the
3414 list is empty, possibly prompt to create new file.
3416 \\[ido-select-text] Select the current prompt as the buffer or file.
3417 If no buffer or file is found, prompt for a new one.
3419 \\[ido-next-match] Put the first element at the end of the list.
3420 \\[ido-prev-match] Put the last element at the start of the list.
3421 \\[ido-complete] Complete a common suffix to the current string that
3422 matches all files. If there is only one match, select that file.
3423 If there is no common suffix, show a list of all matching files
3424 in a separate window.
3425 \\[ido-edit-input] Edit input string (including directory).
3426 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
3427 \\[ido-merge-work-directories] search for file in the work directory history.
3428 \\[ido-forget-work-directory] removes current directory from the work directory history.
3429 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
3430 \\[ido-wide-find-file] and \\[ido-wide-find-dir] prompts and uses find to locate files or directories.
3431 \\[ido-make-directory] prompts for a directory to create in current directory.
3432 \\[ido-fallback-command] Fallback to non-ido version of current command.
3433 \\[ido-toggle-regexp] Toggle regexp searching.
3434 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3435 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
3436 \\[ido-toggle-vc] Toggle version control for this file.
3437 \\[ido-toggle-literal] Toggle literal reading of this file.
3438 \\[ido-completion-help] Show list of matching files in separate window.
3439 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
3441 (interactive)
3442 (ido-file-internal ido-default-file-method))
3444 ;;;###autoload
3445 (defun ido-find-file-other-window ()
3446 "Switch to another file and show it in another window.
3447 The file name is selected interactively by typing a substring.
3448 For details of keybindings, do `\\[describe-function] ido-find-file'."
3449 (interactive)
3450 (ido-file-internal 'otherwindow 'find-file-other-window))
3452 ;;;###autoload
3453 (defun ido-find-alternate-file ()
3454 "Switch to another file and show it in another window.
3455 The file name is selected interactively by typing a substring.
3456 For details of keybindings, do `\\[describe-function] ido-find-file'."
3457 (interactive)
3458 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
3460 ;;;###autoload
3461 (defun ido-find-file-read-only ()
3462 "Edit file read-only with name obtained via minibuffer.
3463 The file name is selected interactively by typing a substring.
3464 For details of keybindings, do `\\[describe-function] ido-find-file'."
3465 (interactive)
3466 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
3468 ;;;###autoload
3469 (defun ido-find-file-read-only-other-window ()
3470 "Edit file read-only in other window with name obtained via minibuffer.
3471 The file name is selected interactively by typing a substring.
3472 For details of keybindings, do `\\[describe-function] ido-find-file'."
3473 (interactive)
3474 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
3476 ;;;###autoload
3477 (defun ido-find-file-read-only-other-frame ()
3478 "Edit file read-only in other frame with name obtained via minibuffer.
3479 The file name is selected interactively by typing a substring.
3480 For details of keybindings, do `\\[describe-function] ido-find-file'."
3481 (interactive)
3482 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
3484 ;;;###autoload
3485 (defun ido-display-file ()
3486 "Display a file in another window but don't select it.
3487 The file name is selected interactively by typing a substring.
3488 For details of keybindings, do `\\[describe-function] ido-find-file'."
3489 (interactive)
3490 (ido-file-internal 'display nil nil nil nil nil 'ignore))
3492 ;;;###autoload
3493 (defun ido-find-file-other-frame ()
3494 "Switch to another file and show it in another frame.
3495 The file name is selected interactively by typing a substring.
3496 For details of keybindings, do `\\[describe-function] ido-find-file'."
3497 (interactive)
3498 (ido-file-internal 'otherframe 'find-file-other-frame))
3500 ;;;###autoload
3501 (defun ido-write-file ()
3502 "Write current buffer to a file.
3503 The file name is selected interactively by typing a substring.
3504 For details of keybindings, do `\\[describe-function] ido-find-file'."
3505 (interactive)
3506 (let ((ido-process-ignore-lists t)
3507 (ido-work-directory-match-only nil)
3508 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
3509 (ido-report-no-match nil)
3510 (ido-confirm-unique-completion t)
3511 (ido-auto-merge-work-directories-length -1))
3512 (ido-file-internal 'write 'write-file nil "Write file: " nil nil 'ignore)))
3514 ;;;###autoload
3515 (defun ido-insert-file ()
3516 "Insert contents of file in current buffer.
3517 The file name is selected interactively by typing a substring.
3518 For details of keybindings, do `\\[describe-function] ido-find-file'."
3519 (interactive)
3520 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil nil 'ido-enter-insert-buffer))
3522 ;;;###autoload
3523 (defun ido-dired ()
3524 "Call dired the ido way.
3525 The directory is selected interactively by typing a substring.
3526 For details of keybindings, do `\\[describe-function] ido-find-file'."
3527 (interactive)
3528 (let ((ido-report-no-match nil)
3529 (ido-auto-merge-work-directories-length -1))
3530 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
3532 (defun ido-list-directory ()
3533 "Call list-directory the ido way.
3534 The directory is selected interactively by typing a substring.
3535 For details of keybindings, do `\\[describe-function] ido-find-file'."
3536 (interactive)
3537 (let ((ido-report-no-match nil)
3538 (ido-auto-merge-work-directories-length -1))
3539 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
3541 ;;; XEmacs hack for showing default buffer
3543 ;; The first time we enter the minibuffer, Emacs puts up the default
3544 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
3545 ;; subtle difference in the two versions of post-command-hook. The
3546 ;; default is shown for both whenever we delete all of our text
3547 ;; though, indicating its just a problem the first time we enter the
3548 ;; function. To solve this, we use another entry hook for emacs to
3549 ;; show the default the first time we enter the minibuffer.
3552 ;;; ICOMPLETE TYPE CODE
3554 (defun ido-initiate-auto-merge (buffer)
3555 (ido-trace "\n*merge timeout*" buffer)
3556 (setq ido-auto-merge-timer nil)
3557 (when (and (buffer-live-p buffer)
3558 (= ido-use-mycompletion-depth (minibuffer-depth))
3559 (boundp 'ido-eoinput) ido-eoinput)
3560 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
3561 (ido-trace "request merge")
3562 (setq ido-use-merged-list 'auto
3563 ido-text-init contents
3564 ido-rotate-temp t
3565 ido-exit 'refresh)
3566 (save-excursion
3567 (set-buffer buffer)
3568 (ido-tidy))
3569 (throw 'ido contents))))
3571 (defun ido-exhibit ()
3572 "Post command hook for `ido'."
3573 ;; Find matching files and display a list in the minibuffer.
3574 ;; Copied from `icomplete-exhibit' with two changes:
3575 ;; 1. It prints a default file name when there is no text yet entered.
3576 ;; 2. It calls my completion routine rather than the standard completion.
3578 (when (= ido-use-mycompletion-depth (minibuffer-depth))
3579 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
3580 (buffer-undo-list t)
3581 try-single-dir-match
3582 refresh)
3584 (ido-trace "\nexhibit" this-command)
3585 (ido-trace "dir" ido-current-directory)
3586 (ido-trace "contents" contents)
3587 (ido-trace "list" ido-cur-list)
3588 (ido-trace "matches" ido-matches)
3589 (ido-trace "rescan" ido-rescan)
3591 (save-excursion
3592 (goto-char (point-max))
3593 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
3594 (unless (boundp 'ido-eoinput)
3595 ;; In case it got wiped out by major mode business:
3596 (make-local-variable 'ido-eoinput))
3597 (setq ido-eoinput (point))
3599 ;; Handle explicit directory changes
3600 (cond
3601 ((memq ido-cur-item '(buffer list))
3604 ((= (length contents) 0)
3607 ((= (length contents) 1)
3608 (when (and (ido-is-tramp-root) (string-equal contents "/"))
3609 (ido-set-current-directory ido-current-directory contents)
3610 (setq refresh t))
3613 ((and (string-match (if ido-enable-tramp-completion "..[:@]\\'" "..:\\'") contents)
3614 (ido-is-root-directory)) ;; Ange-ftp or tramp
3615 (ido-set-current-directory ido-current-directory contents)
3616 (when (ido-is-slow-ftp-host)
3617 (setq ido-exit 'fallback)
3618 (exit-minibuffer))
3619 (setq refresh t))
3621 ((ido-final-slash contents) ;; xxx/
3622 (ido-trace "final slash" contents)
3623 (cond
3624 ((string-equal contents "~/")
3625 (ido-set-current-home)
3626 (setq refresh t))
3627 ((string-equal contents "../")
3628 (ido-up-directory t)
3629 (setq refresh t))
3630 ((string-equal contents "./")
3631 (setq refresh t))
3632 ((string-match "\\`~[a-zA-Z0-9]+/\\'" contents)
3633 (ido-trace "new home" contents)
3634 (ido-set-current-home contents)
3635 (setq refresh t))
3636 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
3637 (let ((exp (condition-case ()
3638 (expand-file-name
3639 (substitute-in-file-name (substring contents 0 -1))
3640 ido-current-directory)
3641 (error nil))))
3642 (ido-trace contents exp)
3643 (when (and exp (file-directory-p exp))
3644 (ido-set-current-directory (file-name-directory exp))
3645 (setq ido-text-init (file-name-nondirectory exp))
3646 (setq refresh t))))
3647 ((and (memq system-type '(windows-nt ms-dos))
3648 (string-equal (substring contents 1) ":/"))
3649 (ido-set-current-directory (file-name-directory contents))
3650 (setq refresh t))
3651 ((string-equal (substring contents -2 -1) "/")
3652 (ido-set-current-directory
3653 (if (memq system-type '(windows-nt ms-dos))
3654 (expand-file-name "/" ido-current-directory)
3655 "/"))
3656 (setq refresh t))
3657 ((and (or ido-directory-nonreadable ido-directory-too-big)
3658 (file-directory-p (concat ido-current-directory (file-name-directory contents))))
3659 (ido-set-current-directory
3660 (concat ido-current-directory (file-name-directory contents)))
3661 (setq refresh t))
3663 (ido-trace "try single dir")
3664 (setq try-single-dir-match t))))
3666 ((and (string-equal (substring contents -2 -1) "/")
3667 (not (string-match "[$]" contents)))
3668 (ido-set-current-directory
3669 (cond
3670 ((= (length contents) 2)
3671 "/")
3672 (ido-matches
3673 (concat ido-current-directory (car ido-matches)))
3675 (concat ido-current-directory (substring contents 0 -1)))))
3676 (setq ido-text-init (substring contents -1))
3677 (setq refresh t))
3679 ((and (not ido-use-merged-list)
3680 (not (ido-final-slash contents))
3681 (eq ido-try-merged-list t)
3682 (numberp ido-auto-merge-work-directories-length)
3683 (> ido-auto-merge-work-directories-length 0)
3684 (= (length contents) ido-auto-merge-work-directories-length)
3685 (not (and ido-auto-merge-inhibit-characters-regexp
3686 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3687 (not (input-pending-p)))
3688 (setq ido-use-merged-list 'auto
3689 ido-text-init contents
3690 ido-rotate-temp t)
3691 (setq refresh t))
3693 (t nil))
3695 (when refresh
3696 (ido-trace "refresh on /" ido-text-init)
3697 (setq ido-exit 'refresh)
3698 (exit-minibuffer))
3700 ;; Update the list of matches
3701 (setq ido-text contents)
3702 (ido-set-matches)
3703 (ido-trace "new " ido-matches)
3705 (when (and ido-enter-single-matching-directory
3706 ido-matches
3707 (null (cdr ido-matches))
3708 (ido-final-slash (car ido-matches))
3709 (or try-single-dir-match
3710 (eq ido-enter-single-matching-directory t)))
3711 (ido-trace "single match" (car ido-matches))
3712 (ido-set-current-directory
3713 (concat ido-current-directory (car ido-matches)))
3714 (setq ido-exit 'refresh)
3715 (exit-minibuffer))
3717 (when (and (not ido-matches)
3718 (not ido-directory-nonreadable)
3719 (not ido-directory-too-big)
3720 ;; ido-rescan ?
3721 ido-process-ignore-lists
3722 ido-ignored-list)
3723 (let ((ido-process-ignore-lists nil)
3724 (ido-rotate ido-rotate)
3725 (ido-cur-list ido-ignored-list))
3726 (ido-trace "try all" ido-ignored-list)
3727 (ido-set-matches))
3728 (when ido-matches
3729 (ido-trace "found " ido-matches)
3730 (setq ido-rescan t)
3731 (setq ido-process-ignore-lists-inhibit t)
3732 (setq ido-text-init ido-text)
3733 (setq ido-exit 'refresh)
3734 (exit-minibuffer)))
3736 (when (and
3737 ido-rescan
3738 (not ido-matches)
3739 (memq ido-cur-item '(file dir))
3740 (not (ido-is-root-directory))
3741 (> (length contents) 1)
3742 (not (string-match "[$]" contents))
3743 (not ido-directory-nonreadable)
3744 (not ido-directory-too-big))
3745 (ido-trace "merge?")
3746 (if ido-use-merged-list
3747 (ido-undo-merge-work-directory contents nil)
3748 (when (and (eq ido-try-merged-list t)
3749 (numberp ido-auto-merge-work-directories-length)
3750 (= ido-auto-merge-work-directories-length 0)
3751 (not (and ido-auto-merge-inhibit-characters-regexp
3752 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3753 (not (input-pending-p)))
3754 (ido-trace "\n*start timer*")
3755 (setq ido-auto-merge-timer
3756 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
3758 (setq ido-rescan t)
3760 (if (and ido-use-merged-list
3761 ido-matches
3762 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
3763 (progn
3764 (ido-set-current-directory (car (cdr (car ido-matches))))
3765 (setq ido-use-merged-list t
3766 ido-exit 'keep
3767 ido-text-init ido-text)
3768 (exit-minibuffer)))
3770 ;; Insert the match-status information:
3771 (ido-set-common-completion)
3772 (let ((inf (ido-completions
3773 contents
3774 minibuffer-completion-table
3775 minibuffer-completion-predicate
3776 (not minibuffer-completion-confirm))))
3777 (ido-trace "inf" inf)
3778 (insert inf))
3779 ))))
3781 (defun ido-completions (name candidates predicate require-match)
3782 ;; Return the string that is displayed after the user's text.
3783 ;; Modified from `icomplete-completions'.
3785 (let* ((comps ido-matches)
3786 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
3787 ido-merged-indicator))
3788 first)
3790 (if (and ind ido-use-faces)
3791 (put-text-property 0 1 'face 'ido-indicator-face ind))
3793 (if (and ido-use-faces comps)
3794 (let* ((fn (ido-name (car comps)))
3795 (ln (length fn)))
3796 (setq first (format "%s" fn))
3797 (put-text-property 0 ln 'face
3798 (if (= (length comps) 1)
3799 'ido-only-match-face
3800 'ido-first-match-face)
3801 first)
3802 (if ind (setq first (concat first ind)))
3803 (setq comps (cons first (cdr comps)))))
3805 (cond ((null comps)
3806 (cond
3807 (ido-directory-nonreadable
3808 (or (nth 8 ido-decorations) " [Not readable]"))
3809 (ido-directory-too-big
3810 (or (nth 9 ido-decorations) " [Too big]"))
3811 (ido-report-no-match
3812 (nth 6 ido-decorations)) ;; [No match]
3813 (t "")))
3815 ((null (cdr comps)) ;one match
3816 (concat (if (> (length (ido-name (car comps))) (length name))
3817 ;; when there is one match, show the matching file name in full
3818 (concat (nth 4 ido-decorations) ;; [ ... ]
3819 (ido-name (car comps))
3820 (nth 5 ido-decorations))
3822 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
3823 (t ;multiple matches
3824 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
3825 (alternatives
3826 (apply
3827 #'concat
3828 (cdr (apply
3829 #'nconc
3830 (mapcar
3831 (lambda (com)
3832 (setq com (ido-name com))
3833 (setq items (1- items))
3834 (cond
3835 ((< items 0) ())
3836 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
3838 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
3839 (let ((str (substring com 0)))
3840 (if (and ido-use-faces
3841 (not (string= str first))
3842 (ido-final-slash str))
3843 (put-text-property 0 (length str) 'face 'ido-subdir-face str))
3844 str)))))
3845 comps))))))
3847 (concat
3848 ;; put in common completion item -- what you get by pressing tab
3849 (if (and (stringp ido-common-match-string)
3850 (> (length ido-common-match-string) (length name)))
3851 (concat (nth 4 ido-decorations) ;; [ ... ]
3852 (substring ido-common-match-string (length name))
3853 (nth 5 ido-decorations)))
3854 ;; list all alternatives
3855 (nth 0 ido-decorations) ;; { ... }
3856 alternatives
3857 (nth 1 ido-decorations)))))))
3859 (defun ido-minibuffer-setup ()
3860 "Minibuffer setup hook for `ido'."
3861 ;; Copied from `icomplete-minibuffer-setup-hook'.
3862 (when (and (boundp 'ido-completing-read)
3863 (or (featurep 'xemacs)
3864 (= ido-use-mycompletion-depth (minibuffer-depth))))
3865 (add-hook 'pre-command-hook 'ido-tidy nil t)
3866 (add-hook 'post-command-hook 'ido-exhibit nil t)
3867 (setq cua-inhibit-cua-keys t)
3868 (when (featurep 'xemacs)
3869 (ido-exhibit)
3870 (goto-char (point-min)))
3871 (run-hooks 'ido-minibuffer-setup-hook)))
3873 (defun ido-tidy ()
3874 "Pre command hook for `ido'."
3875 ;; Remove completions display, if any, prior to new user input.
3876 ;; Copied from `icomplete-tidy'."
3878 (when ido-auto-merge-timer
3879 (ido-trace "\n*cancel timer*" this-command)
3880 (cancel-timer ido-auto-merge-timer)
3881 (setq ido-auto-merge-timer nil))
3883 (if (and (boundp 'ido-use-mycompletion-depth)
3884 (= ido-use-mycompletion-depth (minibuffer-depth)))
3885 (if (and (boundp 'ido-eoinput)
3886 ido-eoinput)
3888 (if (> ido-eoinput (point-max))
3889 ;; Oops, got rug pulled out from under us - reinit:
3890 (setq ido-eoinput (point-max))
3891 (let ((buffer-undo-list t))
3892 (delete-region ido-eoinput (point-max))))
3894 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
3895 (make-local-variable 'ido-eoinput)
3896 (setq ido-eoinput 1))))
3898 (defun ido-summary-buffers-to-end ()
3899 ;; Move the summaries to the end of the buffer list.
3900 ;; This is an example function which can be hooked on to
3901 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
3902 ;; `Summary' or `output\*$'are put to the end of the list.
3903 (let ((summaries (delq nil (mapcar
3904 (lambda (x)
3905 (if (or
3906 (string-match "Summary" x)
3907 (string-match "output\\*\\'" x))
3909 ido-temp-list))))
3910 (ido-to-end summaries)))
3912 ;;; Helper functions for other programs
3914 (put 'dired-do-rename 'ido 'ignore)
3916 ;;;###autoload
3917 (defun ido-read-buffer (prompt &optional default require-match)
3918 "Ido replacement for the built-in `read-buffer'.
3919 Return the name of a buffer selected.
3920 PROMPT is the prompt to give to the user. DEFAULT if given is the default
3921 buffer to be selected, which will go to the front of the list.
3922 If REQUIRE-MATCH is non-nil, an existing-buffer must be selected."
3923 (let* ((ido-current-directory nil)
3924 (ido-directory-nonreadable nil)
3925 (ido-directory-too-big nil)
3926 (ido-context-switch-command 'ignore)
3927 (buf (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match)))
3928 (if (eq ido-exit 'fallback)
3929 (let ((read-buffer-function nil))
3930 (read-buffer prompt default require-match))
3931 buf)))
3933 ;;;###autoload
3934 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
3935 "Ido replacement for the built-in `read-file-name'.
3936 Read file name, prompting with PROMPT and completing in directory DIR.
3937 See `read-file-name' for additional parameters."
3938 (let (filename)
3939 (cond
3940 ((or (eq predicate 'file-directory-p)
3941 (eq (get this-command 'ido) 'dir)
3942 (memq this-command ido-read-file-name-as-directory-commands))
3943 (setq filename
3944 (ido-read-directory-name prompt dir default-filename mustmatch initial)))
3945 ((and (not (eq (get this-command 'ido) 'ignore))
3946 (not (memq this-command ido-read-file-name-non-ido))
3947 (or (null predicate) (eq predicate 'file-exists-p)))
3948 (let* (ido-saved-vc-hb
3949 (ido-context-switch-command 'ignore)
3950 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
3951 (ido-current-directory (ido-expand-directory dir))
3952 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
3953 (ido-directory-too-big (and (not ido-directory-nonreadable)
3954 (ido-directory-too-big-p ido-current-directory)))
3955 (ido-work-directory-index -1)
3956 (ido-work-file-index -1)
3957 (ido-find-literal nil))
3958 (setq ido-exit nil)
3959 (setq filename
3960 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
3961 (cond
3962 ((eq ido-exit 'fallback)
3963 (setq filename 'fallback))
3964 (filename
3965 (setq filename
3966 (concat ido-current-directory filename))))))
3968 (setq filename 'fallback)))
3969 (if (eq filename 'fallback)
3970 (let ((read-file-name-function nil))
3971 (read-file-name prompt dir default-filename mustmatch initial predicate))
3972 filename)))
3974 ;;;###autoload
3975 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
3976 "Ido replacement for the built-in `read-directory-name'.
3977 Read directory name, prompting with PROMPT and completing in directory DIR.
3978 See `read-directory-name' for additional parameters."
3979 (let* (filename
3980 (ido-context-switch-command 'ignore)
3981 ido-saved-vc-hb
3982 (ido-current-directory (ido-expand-directory dir))
3983 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
3984 (ido-directory-too-big (and (not ido-directory-nonreadable)
3985 (ido-directory-too-big-p ido-current-directory)))
3986 (ido-work-directory-index -1)
3987 (ido-work-file-index -1))
3988 (setq filename
3989 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
3990 (if filename
3991 (if (and (stringp filename) (string-equal filename "."))
3992 ido-current-directory
3993 (concat ido-current-directory filename)))))
3995 ;;;###autoload
3996 (defun ido-completing-read (prompt choices &optional predicate require-match initial-input hist def)
3997 "Ido replacement for the built-in `completing-read'.
3998 Read a string in the minibuffer with ido-style completion.
3999 PROMPT is a string to prompt with; normally it ends in a colon and a space.
4000 CHOICES is a list of strings which are the possible completions.
4001 PREDICATE is currently ignored; it is included to be compatible
4002 with `completing-read'.
4003 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
4004 the input is (or completes to) an element of CHOICES or is null.
4005 If the input is null, `ido-completing-read' returns DEF, or an empty
4006 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
4007 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
4008 with point positioned at the end.
4009 HIST, if non-nil, specifies a history list.
4010 DEF, if non-nil, is the default value."
4011 (let ((ido-current-directory nil)
4012 (ido-directory-nonreadable nil)
4013 (ido-directory-too-big nil)
4014 (ido-context-switch-command 'ignore)
4015 (ido-choice-list choices))
4016 (ido-read-internal 'list prompt hist def require-match initial-input)))
4019 ;;; arch-tag: b63a3500-1735-41bd-8a01-05373f0864da
4020 ;;; ido.el ends here