(outline-next-heading): Make sure the match-data is correct where returning.
[emacs.git] / lisp / ido.el
blobf9ba8178cba572b298e0b0b929b6ade4f3eccce1
1 ;;; ido.el --- interactively do things with buffers and files.
3 ;; Copyright (C) 1996-2002 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 Schroeder,
34 ;; Bill Benedetto, and Stephen Eglen for bug fixes and improvements.
36 ;;; History
38 ;; Since I discovered Stephen Eglen's excellent iswitchb package, I just
39 ;; couldn't live without it, but once being addicted to switching buffers
40 ;; with a minimum of keystrokes, I soon found that opening files in the
41 ;; old-fashioned way was just too slow - so I decided to write a package
42 ;; which could open files with the same speed and ease as iswitchb could
43 ;; switch buffers.
45 ;; I originally wrote a separate ifindf.el package based on a copy of
46 ;; iswitchb.el, which did for opening files what iswitchb did for
47 ;; switching buffers. Along the way, I corrected a few errors in
48 ;; ifindf which could have found its way back into iswitchb, but since
49 ;; most of the functionality of the two package was practically
50 ;; identical, I decided that the proper thing to do was to merge my
51 ;; ifindf package back into iswitchb.
53 ;; This is basically what ido (interactively do) is all about; but I
54 ;; found it ackward to merge my changes into the "iswitchb-" namespace,
55 ;; so I invented a common "ido-" namespace for the merged packages.
57 ;; This version is based on ido.el version 1.57 released on
58 ;; gnu.emacs.sources adapted for emacs 21.4 to use command remapping
59 ;; and optionally hooking the read-buffer and read-file-name functions.
61 ;; Prefix matching was added by Klaus Berndl <klaus.berndl@sdm.de> based on
62 ;; an idea of Yuji Minejima <ggb01164@nifty.ne.jp> and his mcomplete-package.
65 ;;; Commentary:
67 ;; Ido - interactive do - switches between buffers and opens files and
68 ;; directories with a minimum of keystrokes. It is a superset of
69 ;; iswitchb, the interactive buffer switching package by Stephen Eglen.
71 ;; Interactive substring matching
72 ;; ------------------------------
74 ;; As you type in a substring, the list of buffers or files currently
75 ;; matching the substring are displayed as you type. The list is
76 ;; ordered so that the most recent buffers or files visited come at
77 ;; the start of the list.
79 ;; The buffer or file at the start of the list will be the one visited
80 ;; when you press RETURN. By typing more of the substring, the list is
81 ;; narrowed down so that gradually the buffer or file you want will be
82 ;; at the top of the list. Alternatively, you can use C-s and C-r (or
83 ;; the right and left arrow keys) to rotate buffer or file names in the
84 ;; list until the one you want is at the top of the list.
86 ;; Completion is also available so that you can see what is common to
87 ;; all of the matching buffers or files as you type.
89 ;; Example:
91 ;; If I have two buffers called "123456" and "123", with "123456" the
92 ;; most recent, when I use ido-switch-buffer, I first of all get
93 ;; presented with the list of all the buffers
95 ;; Buffer: {123456,123}
97 ;; If I then press 2:
98 ;; Buffer: 2[3]{123456,123}
100 ;; The list in {...} are the matching buffers, most recent first
101 ;; (buffers visible in the current frame are put at the end of the
102 ;; list by default). At any time I can select the item at the head of
103 ;; the list by pressing RET. I can also bring the put the first
104 ;; element at the end of the list by pressing C-s or [right], or put
105 ;; the last element at the head of the list by pressing C-r or [left].
107 ;; The item in [...] indicates what can be added to my input by
108 ;; pressing TAB. In this case, I will get "3" added to my input.
110 ;; So, I press TAB:
111 ;; Buffer: 23{123456,123}
113 ;; At this point, I still have two matching buffers.
114 ;; If I want the first buffer in the list, I simply press RET. If I
115 ;; wanted the second in the list, I could press C-s to move it to the
116 ;; top of the list and then RET to select it.
118 ;; However, if I type 4, I only have one match left:
119 ;; Buffer: 234[123456] [Matched]
121 ;; Since there is only one matching buffer left, it is given in [] and we
122 ;; see the text [Matched] afterwards. I can now press TAB or RET to go
123 ;; to that buffer.
125 ;; If however, I now type "a":
126 ;; Buffer: 234a [No match]
127 ;; There are no matching buffers. If I press RET or TAB, I can be
128 ;; prompted to create a new buffer called "234a".
130 ;; Of course, where this function comes in really useful is when you
131 ;; can specify the buffer using only a few keystrokes. In the above
132 ;; example, the quickest way to get to the "123456" file would be
133 ;; just to type 4 and then RET (assuming there isn't any newer buffer
134 ;; with 4 in its name).
136 ;; Likewise, if you use C-x C-f (ido-find-file), the list of files and
137 ;; directories in the current directory is provided in the same
138 ;; fashion as the buffers above. The files and directories are
139 ;; normally sorted in alphabetical order, but the most recently
140 ;; visited directory is placed first to speed up navigating to
141 ;; directories that you have visited recently.
143 ;; In addition to scrolling through the list using [right] and [left],
144 ;; you can use [up] and [down] to quickly scroll the list to the next
145 ;; or previous subdirectory.
147 ;; To go down into a subdirectory, and continue the file selection on
148 ;; the files in that directory, simply move the directory to the head
149 ;; of the list and hit RET.
151 ;; To go up to the parent directory, delete any partial file name
152 ;; already specified (e.g. using [backspace]) and hit [backspace].
154 ;; To go to the root directory (on the current drive), enter two
155 ;; slashes. On MS-DOS or Windows, to select the root of another
156 ;; drive, enter X:/ where X is the drive letter. You can also visit
157 ;; files on other hosts using the ange-ftp notations `/host:' and
158 ;; `/user@host:'. See the variable `ido-slow-ftp-hosts' if you want
159 ;; to inhibit the ido substring matching for ftp access.
161 ;; If for some reason you cannot specify the proper file using
162 ;; ido-find-file, you can press C-f to enter the normal find-file.
163 ;; You can also press C-b to drop into ido-switch-buffer.
165 ;; See the doc string of ido-switch-buffer and ido-find-file for full
166 ;; keybindings and features.
167 ;; (describe-function 'ido-find-file)
169 ;; Hidden buffers and files
170 ;; ------------------------
172 ;; Normally, ido does not include hidden buffers (whose name starts
173 ;; with a space) and hidden files and directories (whose name starts
174 ;; with `.') in the list of possible completions. However, if the
175 ;; substring you enter does not match any of the visible buffers or
176 ;; files, ido will automatically look for completions among the hidden
177 ;; buffers or files.
179 ;; You can toggle display of the hidden buffers and files with C-a.
181 ;; Additional functionality
182 ;; ------------------------
184 ;; After C-x b, the buffer at the head of the list can be killed by
185 ;; pressing C-k. If the buffer needs saving, you will be queried
186 ;; before the buffer is killed.
188 ;; Likewise, after C-x C-f, you can delete (i.e. physically remove)
189 ;; the file at the head of the list with C-k. You will always be
190 ;; asked for confirmation before the file is deleted.
192 ;; If you enter C-x b to switch to a buffer visiting a given file, and
193 ;; you find that the file you are after is not in any buffer, you can
194 ;; press C-f to immediately drop into ido-find-file. And you can
195 ;; switch back to buffer selection with C-b.
197 ;; Prefix matching
198 ;; ---------------
200 ;; The standard way of completion with Unix-shells and Emacs is to insert a
201 ;; PREFIX and then hitting TAB (or another completion key). Cause of this
202 ;; behavior has become second nature to a lot of emacs users `ido' offers in
203 ;; addition to the default substring-matching-method (look above) also the
204 ;; prefix-matching-method. The kind of matching is the only difference to
205 ;; the description of the substring-matching above.
207 ;; You can toggle prefix matching with C-p.
209 ;; Example:
211 ;; If you have again two Buffers "123456" and "123" then hitting "2" does
212 ;; not match because "2" is not a PREFIX in any of the buffer-names. This
213 ;; is the only difference between the substring and prefix matching.
215 ;; Flexible matching
216 ;; -----------------
218 ;; If you set ido-enable-flex-matching, ido will do a more flexible
219 ;; matching (unless regexp matching is active) to find possible matches
220 ;; among the available buffer or file names if no matches are found using
221 ;; the normal prefix or substring matching.
223 ;; The flexible matching implies that any item which simply contains all
224 ;; of the entered characters in the specified sequence will match.
226 ;; Example:
228 ;; If you have four files "alpha", "beta", "gamma", and "delta",
229 ;; entering "aa" will match "alpha" and "gamma", while "ea" matches
230 ;; "beta" and "delta". If prefix matching is also active, "aa" only
231 ;; matches "alpha", while "ea" does not match any files.
233 ;; Regexp matching
234 ;; ---------------
236 ;; There is limited provision for regexp matching within ido,
237 ;; enabled through `ido-enable-regexp' (toggle with C-t).
238 ;; This allows you to type `c$' for example and see all file names
239 ;; ending in `c'. This facility is quite limited though in two
240 ;; respects. First, you can't currently type in expressions like
241 ;; `[0-9]' directly -- you have to type them in when ido-enable-regexp
242 ;; is nil and then toggle on the regexp functionality. Likewise,
243 ;; don't enter an expression containing `\' in regexp mode. If you
244 ;; try, ido gets confused, so just hit C-g and try again. Secondly,
245 ;; no completion mechanism is currently offered with regexp searching.
248 ;; Customization
249 ;; -------------
251 ;; Customize the `ido' group to change the `ido' functionality.
253 ;; To modify the keybindings, use the hook provided. For example:
254 ;;(add-hook 'ido-define-mode-map-hook 'ido-my-keys)
256 ;;(defun ido-my-keys ()
257 ;; "Add my keybindings for ido."
258 ;; (define-key ido-mode-map " " 'ido-next-match)
259 ;; )
261 ;; Seeing all the matching buffers or files
262 ;; ----------------------------------------
264 ;; If you have many matching files, they may not all fit onto one
265 ;; line of the minibuffer. Normally, the minibuffer window will grow
266 ;; to show you more of the matching files (depending on the setting
267 ;; of the variables `resize-mini-windows' and `max-mini-window-height').
268 ;; If you want ido to behave differently from the default minibuffer
269 ;; resizing behaviour, set the variable `ido-max-window-height'.
271 ;; Also, to improve the responsiveness of ido, the maximum number of
272 ;; matching items is limited to 12, but you can increase or removed
273 ;; this limit via the `ido-max-prospects' variable.
275 ;; To see a full list of all matching buffers in a separate buffer,
276 ;; hit ? or press TAB when there are no further completions to the
277 ;; substring. Repeated TAB presses will scroll you through this
278 ;; separate buffer.
280 ;; Changing the list of files
281 ;; --------------------------
283 ;; By default, the list of current files is most recent first,
284 ;; oldest last, with the exception that the files visible in the
285 ;; current frame are put at the end of the list. A hook exists to
286 ;; allow other functions to order the list. For example, if you add:
288 ;; (add-hook 'ido-make-buffer-list-hook 'ido-summary-buffers-to-end)
290 ;; then all files matching "Summary" are moved to the end of the
291 ;; list. (I find this handy for keeping the INBOX Summary and so on
292 ;; out of the way.) It also moves files matching "output\*$" to the
293 ;; end of the list (these are created by AUC TeX when compiling.)
294 ;; Other functions could be made available which alter the list of
295 ;; matching files (either deleting or rearranging elements.)
297 ;; Highlighting
298 ;; ------------
300 ;; The highlighting of matching items is controlled via ido-use-faces.
301 ;; The faces used are ido-first-match-face, ido-only-match-face and
302 ;; ido-subdir-face.
303 ;; Colouring of the matching item was suggested by
304 ;; Carsten Dominik (dominik@strw.leidenuniv.nl).
306 ;; Replacement for read-buffer and read-file-name
307 ;; ----------------------------------------------
309 ;; ido-read-buffer and ido-read-file-name have been written to be drop
310 ;; in replacements for the normal buffer and file name reading
311 ;; functions `read-buffer' and `read-file-name'.
313 ;; To use ido for all buffer and file selections in Emacs, customize the
314 ;; variable `ido-everywhere'.
316 ;; Using ido-like behaviour in other lisp packages
317 ;; -----------------------------------------------
319 ;; If you don't want to rely on the `ido-everywhere' functionality,
320 ;; ido-read-buffer, ido-read-file-name, and ido-read-directory-name
321 ;; can be used by other packages to read a buffer name, a file name,
322 ;; or a directory name in the `ido' way.
325 ;;; Code:
327 (provide 'ido)
329 ;;; User Variables
331 ;; These are some things you might want to change.
333 (defun ido-fractionp (n)
334 (and (numberp n) (> n 0.0) (<= n 1.0)))
336 (defgroup ido nil
337 "Switch between files using substrings."
338 :group 'extensions
339 :group 'convenience
340 :link '(emacs-commentary-link :tag "Commentary" "ido.el")
341 :link '(emacs-library-link :tag "Lisp File" "ido.el"))
343 ;;;###autoload
344 (defcustom ido-mode nil
345 "Determines for which functional group \(buffer and files) ido behavior
346 should be enabled. The following values are possible:
347 - 'buffer: Turn only on ido buffer behavior \(switching, killing,
348 displaying...)
349 - 'file: Turn only on ido file behavior \(finding, writing, inserting...)
350 - 'both: Turn on ido buffer and file behavior.
351 - nil: Turn off any ido switching.
353 Setting this variable directly does not take effect;
354 use either \\[customize] or the function `ido-mode'."
355 :set #'(lambda (symbol value)
356 (ido-mode value))
357 :initialize 'custom-initialize-default
358 :require 'ido
359 :link '(emacs-commentary-link "ido.el")
360 :set-after '(ido-save-directory-list-file)
361 :version "21.4"
362 :type '(choice (const :tag "Turn on only buffer" buffer)
363 (const :tag "Turn on only file" file)
364 (const :tag "Turn on both buffer and file" both)
365 (const :tag "Switch off all" nil))
366 :group 'ido)
368 (defcustom ido-everywhere nil
369 "Use ido everywhere for reading file names and directories.
370 Setting this variable directly does not work. Use `customize' or
371 call the function `ido-everywhere'."
372 :set #'(lambda (symbol value)
373 (ido-everywhere value))
374 :initialize 'custom-initialize-default
375 :type 'boolean
376 :group 'ido)
378 (defcustom ido-case-fold case-fold-search
379 "*Non-nil if searching of buffer and file names should ignore case."
380 :type 'boolean
381 :group 'ido)
383 (defcustom ido-ignore-buffers
384 '("\\` ")
385 "*List of regexps or functions matching buffer names to ignore.
386 For example, traditional behavior is not to list buffers whose names begin
387 with a space, for which the regexp is `\\` '. See the source file for
388 example functions that filter buffernames."
389 :type '(repeat (choice regexp function))
390 :group 'ido)
392 (defcustom ido-ignore-files
393 '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
394 "*List of regexps or functions matching file names to ignore.
395 For example, traditional behavior is not to list files whose names begin
396 with a #, for which the regexp is `\\`#'. See the source file for
397 example functions that filter filenames."
398 :type '(repeat (choice regexp function))
399 :group 'ido)
401 (defcustom ido-ignore-extensions t
402 "*Non-nil means ignore files in completion-ignored-extensions list."
403 :type 'boolean
404 :group 'ido)
406 (defcustom ido-show-dot-for-dired nil
407 "*Non-nil means to always put . as the first item in file name lists.
408 This allows the current directory to be opened immediate with `dired'."
409 :type 'boolean
410 :group 'ido)
412 (defcustom ido-ignore-directories
413 '("\\`CVS/" "\\`\\.\\./" "\\`\\./")
414 "*List of regexps or functions matching sub-directory names to ignore."
415 :type '(repeat (choice regexp function))
416 :group 'ido)
418 (defcustom ido-ignore-directories-merge nil
419 "*List of regexps or functions matching directory path names to ignore during merge.
420 Directory paths matched by one of the regexps in this list are not inserted
421 in merged file and directory lists."
422 :type '(repeat (choice regexp function))
423 :group 'ido)
425 ;;; Examples for setting the value of ido-ignore-buffers
426 ;(defun ido-ignore-c-mode (name)
427 ; "Ignore all c mode buffers -- example function for ido."
428 ; (save-excursion
429 ; (set-buffer name)
430 ; (string-match "^C$" mode-name)))
432 ;(setq ido-ignore-buffers '("^ " ido-ignore-c-mode))
434 ;;; Examples for setting the value of ido-ignore-files
435 ;(setq ido-ignore-files '("^ " "\\.c$" "\\.h$"))
437 (defcustom ido-default-file-method 'always-frame
438 "*How to switch to new file when using `ido-find-file'.
439 Possible values:
440 `samewindow' Show new file in same window
441 `otherwindow' Show new file in another window (same frame)
442 `display' Display file in another window without switching to it
443 `otherframe' Show new file in another frame
444 `maybe-frame' If a file is visible in another frame, prompt to ask if you
445 you want to see the file in the same window of the current
446 frame or in the other frame.
447 `always-frame' If a file is visible in another frame, raise that
448 frame. Otherwise, visit the file in the same window."
449 :type '(choice (const samewindow)
450 (const otherwindow)
451 (const display)
452 (const otherframe)
453 (const maybe-frame)
454 (const always-frame))
455 :group 'ido)
457 (defcustom ido-default-buffer-method 'always-frame
458 "*How to switch to new buffer when using `ido-switch-buffer'.
459 See ido-default-file-method for details."
460 :type '(choice (const samewindow)
461 (const otherwindow)
462 (const display)
463 (const otherframe)
464 (const maybe-frame)
465 (const always-frame))
466 :group 'ido)
468 (defcustom ido-enable-flex-matching nil
469 "*Non-nil means that `ido' will do flexible string matching.
470 Flexible matching means that if the entered string does not
471 match any item, any item containing the entered characters
472 in the given sequence will match."
473 :type 'boolean
474 :group 'ido)
477 (defcustom ido-enable-regexp nil
478 "*Non-nil means that `ido' will do regexp matching.
479 Value can be toggled within `ido' using `ido-toggle-regexp'."
480 :type 'boolean
481 :group 'ido)
483 (defcustom ido-enable-prefix nil
484 "*Nil means that `ido' will match if the inserted text is an
485 arbitrary substring (default). If non-nil `ido' will only match if the inserted
486 text is a prefix \(this behavior is like the standard unix- or
487 emacs-completion works).
488 Value can be toggled within `ido' using `ido-toggle-prefix'."
489 :type 'boolean
490 :group 'ido)
492 (defcustom ido-record-commands t
493 "*Non-nil means that `ido' will record commands in command history.
494 Note that the non-ido equivalent command is recorded."
495 :type 'boolean
496 :group 'ido)
498 (defcustom ido-max-prospects 12
499 "*Non-zero means that the prospect list will be limited to than number of items.
500 For a long list of prospects, building the full list for the minibuffer can take a
501 non-negletable amount of time; setting this variable reduces that time."
502 :type 'integer
503 :group 'ido)
505 (defcustom ido-max-prompt-path 0.35
506 "*Non-zero means that the prompt string be limited to than number of characters.
507 If value is a floating point number, it specifies a fraction of the frame width."
508 :type '(choice
509 (integer :tag "Characters" :value 20)
510 (restricted-sexp :tag "Fraction of frame width"
511 :value 0.35
512 :match-alternatives (ido-fractionp)))
513 :group 'ido)
515 (defcustom ido-max-window-height nil
516 "*Non-nil specifies a value to override `max-mini-window-height'."
517 :type '(choice
518 (const :tag "Don't override" nil)
519 (integer :tag "Number of lines" :value 1)
520 (restricted-sexp
521 :tag "Fraction of window height"
522 :value 0.25
523 :match-alternatives (ido-fractionp)))
524 :group 'ido)
526 (defcustom ido-enable-last-directory-history t
527 "*Non-nil means that `ido' will remember latest selected directory paths.
528 See `ido-last-directory-list' and `ido-save-directory-list-file'."
529 :type 'boolean
530 :group 'ido)
532 (defcustom ido-max-work-directory-list 50
533 "*Maximum number of working directories to record.
534 This is the list of directories where files have most recently been opened.
535 See `ido-work-directory-list' and `ido-save-directory-list-file'."
536 :type 'integer
537 :group 'ido)
539 (defcustom ido-work-directory-list-ignore-regexps nil
540 "*List of regexps matching directories which should not be recorded.
541 Directory paths matched by one of the regexps in this list are not inserted in
542 the `ido-work-directory-list' list."
543 :type '(repeat regexp)
544 :group 'ido)
546 (defcustom ido-record-ftp-work-directories t
547 "*Non-nil means that ftp paths are recorded in work directory list."
548 :type 'boolean
549 :group 'ido)
551 (defcustom ido-merge-ftp-work-directories nil
552 "*Nil means that ftp paths in work directory list are ignored during merge."
553 :type 'boolean
554 :group 'ido)
556 (defcustom ido-cache-ftp-work-directory-time 1.0
557 "*Maximum time to cache contents of an ftp directory (in hours).
558 If zero, ftp directories are not cached."
559 :type 'number
560 :group 'ido)
562 (defcustom ido-slow-ftp-hosts nil
563 "*List of slow ftp hosts where ido prompting should not be used.
564 If an ftp host is on this list, ido automatically switches to the non-ido
565 equivalent function, e.g. find-file rather than ido-find-file."
566 :type '(repeat string)
567 :group 'ido)
569 (defcustom ido-slow-ftp-host-regexps nil
570 "*List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
571 :type '(repeat regexp)
572 :group 'ido)
574 (defcustom ido-max-work-file-list 10
575 "*Maximum number of names of recently opened files to record.
576 This is the list the file names (sans directory) which have most recently
577 been opened. See `ido-work-file-list' and `ido-save-directory-list-file'."
578 :type 'integer
579 :group 'ido)
581 (defcustom ido-work-directory-match-only t
582 "*Non-nil means to skip non-matching directories in the directory history.
583 When some text is already entered at the `ido-find-file' prompt, using
584 \\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories
585 without any matching entries."
586 :type 'boolean
587 :group 'ido)
589 (defcustom ido-auto-merge-work-directories-length 0
590 "*Automatically switch to merged work directories during file name input.
591 The value is number of characters to type before switching to merged mode.
592 If zero, the switch happens when no matches are found in the current directory.
593 Automatic merging is disabled if the value is negative."
594 :type 'integer
595 :group 'ido)
597 (defcustom ido-auto-merge-delay-time 0.70
598 "*Delay in seconds to wait for more input before doing auto merge."
599 :type 'number
600 :group 'ido)
602 (defcustom ido-auto-merge-inhibit-characters-regexp "[][*?~]"
603 "*Regexp matching characters which should inhibit automatic merging.
604 When a (partial) file name matches this regexp, merging is inhibited."
605 :type 'regexp
606 :group 'ido)
608 (defcustom ido-merged-indicator "^"
609 "The string appended to first choice if it has multiple directory choices."
610 :type 'string
611 :group 'ido)
613 (defcustom ido-max-dir-file-cache 100
614 "*Maximum number of working directories to be cached.
615 This is the size of the cache of file-name-all-completions results.
616 Each cache entry is time stamped with the modification time of the
617 directory. Some systems, like Windows, have unreliable directory
618 modification times, so you may choose to disable caching on such
619 systems, or explicitly refresh the cache contents using the command
620 `ido-reread-directory' command (C-l) in the minibuffer.
621 See also `ido-dir-file-cache' and `ido-save-directory-list-file'."
622 :type 'integer
623 :group 'ido)
625 (defcustom ido-rotate-file-list-default nil
626 "*Non-nil means that `ido' will always rotate file list to get default in front."
627 :type 'boolean
628 :group 'ido)
630 (defcustom ido-enter-single-matching-directory nil
631 "*Automatically enter sub-directory if it is the only matching item, if non-nil.
632 If value is 'slash, only enter if typing final slash, else do it always."
633 :type '(choice (const :tag "Never" nil)
634 (const :tag "When typing /" slash)
635 (other :tag "Always" t))
636 :group 'ido)
638 (defcustom ido-create-new-buffer 'prompt
639 "*Specify whether a new buffer is created if no buffer matches substring.
640 Choices are 'always to create new buffers unconditionally, 'prompt to
641 ask user whether to create buffer, or 'never to never create new buffer."
642 :type '(choice (const always)
643 (const prompt)
644 (const never))
645 :group 'ido)
647 (defcustom ido-define-mode-map-hook nil
648 "*Hook to define keys in `ido-mode-map' for extra keybindings."
649 :type 'hook
650 :group 'ido)
652 (defcustom ido-separator nil
653 "*String used by ido to separate the alternatives in the minibuffer.
654 Obsolete. Set 3rd element of `ido-decorations' instead."
655 :type '(choice string (const nil))
656 :group 'ido)
658 (defcustom ido-decorations '( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]")
659 "*List of strings used by ido to display the alternatives in the minibuffer.
660 There are 8 elements in this list, each is a pair of strings:
661 1st and 2nd elements are used as brackets around the prospect list,
662 3rd element is the separator between prospects (ignored if ido-separator is set),
663 4th element is the string inserted at the end of a truncated list of prospects,
664 5th and 6th elements are used as brackets around the common match string which
665 can be completed using TAB,
666 7th element is the string displayed when there are a no matches, and
667 8th element displayed if there is a single match (and faces are not used)."
668 :type '(repeat string)
669 :group 'ido)
671 (defcustom ido-use-faces t
672 "*Non-nil means use ido faces to highlighting first match, only match and
673 subdirs in the alternatives."
674 :type 'boolean
675 :group 'ido)
677 (defface ido-first-match-face '((t (:bold t)))
678 "*Font used by ido for highlighting first match."
679 :group 'ido)
681 (defface ido-only-match-face '((((class color))
682 (:foreground "ForestGreen"))
683 (t (:italic t)))
684 "*Font used by ido for highlighting only match."
685 :group 'ido)
687 (defface ido-subdir-face '((((class color))
688 (:foreground "red"))
689 (t (:underline t)))
690 "*Font used by ido for highlighting subdirs in the alternatives."
691 :group 'ido)
693 (defface ido-indicator-face '((((class color))
694 (:foreground "yellow"
695 :background "red"
696 :width condensed))
697 (t (:inverse-video t)))
698 "*Font used by ido for highlighting its indicators."
699 :group 'ido)
701 (defcustom ido-make-file-list-hook nil
702 "*List of functions to run when the list of matching files is created.
703 Each function on the list may modify the dynamically bound variable
704 `ido-temp-list' which contains the current list of matching files."
705 :type 'hook
706 :group 'ido)
708 (defcustom ido-make-dir-list-hook nil
709 "*List of functions to run when the list of matching directories is created.
710 Each function on the list may modify the dynamically bound variable
711 `ido-temp-list' which contains the current list of matching directories."
712 :type 'hook
713 :group 'ido)
715 (defcustom ido-make-buffer-list-hook nil
716 "*List of functions to run when the list of matching buffers is created.
717 Each function on the list may modify the dynamically bound variable
718 `ido-temp-list' which contains the current list of matching buffer names."
719 :type 'hook
720 :group 'ido)
722 (defcustom ido-make-file-prompt-hook nil
723 "*List of functions to run when the find-file prompt is created.
724 Each function on the list may modify the following dynamically bound
725 variables:
726 path - the (abbreviated) directory path
727 max-width - the max width of the path; set to nil to inhibit truncation
728 prompt - the basic prompt (e.g. \"Find File: \")
729 literal - the string shown if doing `literal' find; set to nil to omit
730 vc-off - the string shown if version control is inhibited; set to nit to omit
731 prefix - normally nil, but may be set to a fixed prefix for the path
732 The following variables are available, but should not be changed:
733 ido-current-directory - the unabbreviated directory path
734 item - equals 'file or 'dir depending on the current mode."
735 :type 'hook
736 :group 'ido)
738 (defvar ido-rewrite-prompt-path-rules nil
739 "*Alist of rewriting rules for file paths.
740 A list of elements of the form (FROM . TO) or (FROM . FUNC),
741 each meaning to rewrite the path if matched by FROM by either
742 substituting the matched string by TO or calling the function
743 FUNC with the current path as its only argument and using the
744 return value as the new path. In addition, each FUNC may
745 also modify the dynamic variables described for the
746 variable `ido-make-file-prompt-hook'.")
748 (defcustom ido-completion-buffer "*Ido Completions*"
749 "*Name of completion buffer used by ido.
750 Set to nil to disable completion buffers popping up."
751 :type 'string
752 :group 'ido)
754 (defcustom ido-completion-buffer-all-completions nil
755 "*Non-nil means to show all completions in completion buffer.
756 Otherwise, only the current list of matches is shown."
757 :type 'boolean
758 :group 'ido)
760 (defvar ido-all-frames 'visible
761 "*Argument to pass to `walk-windows' when finding visible files.
762 See documentation of `walk-windows' for useful values.")
764 (defcustom ido-minibuffer-setup-hook nil
765 "*Ido-specific customization of minibuffer setup.
767 This hook is run during minibuffer setup iff `ido' will be active.
768 It is intended for use in customizing ido for interoperation
769 with other packages. For instance:
771 \(add-hook 'ido-minibuffer-setup-hook
772 \(function
773 \(lambda ()
774 \(make-local-variable 'max-mini-window-height)
775 \(setq max-mini-window-height 3))))
777 will constrain Emacs to a maximum minibuffer height of 3 lines when
778 ido is running. Copied from `icomplete-minibuffer-setup-hook'."
779 :type 'hook
780 :group 'ido)
782 (defcustom ido-save-directory-list-file "~/.ido.last"
783 "File in which the ido state is saved between invocations.
784 Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
785 `ido-work-file-list', and `ido-dir-file-cache'.
786 Must be set before enabling ido mode."
787 :type 'string
788 :group 'ido)
790 (defcustom ido-read-file-name-as-directory-commands '()
791 "List of commands which uses read-file-name to read a directory path.
792 When `ido-everywhere' is non-nil, the commands in this list will read
793 the directory using ido-read-directory-name."
794 :type '(repeat symbol)
795 :group 'ido)
797 (defcustom ido-read-file-name-non-ido '()
798 "List of commands which shall not read file names the ido way.
799 When `ido-everywhere' is non-nil, the commands in this list will read
800 the file name using normal read-file-name style."
801 :type '(repeat symbol)
802 :group 'ido)
804 ;;; Internal Variables
806 ;; Persistent variables
808 (defvar ido-mode-map nil
809 "Keymap for `ido-find-file' and `ido-switch-buffer'.")
811 (defvar ido-file-history nil
812 "History of files selected using `ido-find-file'.")
814 (defvar ido-buffer-history nil
815 "History of buffers selected using `ido-switch-buffer'.")
817 (defvar ido-xemacs (string-match "XEmacs" (emacs-version))
818 "Non-nil if we are running XEmacs. Otherwise, assume we are running Emacs.")
820 (defvar ido-last-directory-list nil
821 "List of last selected directory paths.
822 See `ido-enable-last-directory-history' for details.")
824 (defvar ido-work-directory-list nil
825 "List of actual working directory paths.
826 The current directory is inserted at the front of this list whenever a
827 file is opened with ido-find-file and family.")
829 (defvar ido-work-file-list nil
830 "List of actual work file names.
831 The current file name (sans path) is inserted at the front of this list
832 whenever a file is opened with ido-find-file and family.")
834 (defvar ido-dir-file-cache nil
835 "List of file-name-all-completions results.
836 Each element in the list is of the form (dir (mtime) file...).")
838 (defvar ido-ignore-item-temp-list nil
839 "List of items to ignore in current ido invocation.
840 Intended to be let-bound by functions which calls ido repeatedly.
841 Should never be set permanently.")
843 ;; Temporary storage
845 (defvar ido-eoinput 1
846 "Point where minibuffer input ends and completion info begins.
847 Copied from `icomplete-eoinput'.")
848 (make-variable-buffer-local 'ido-eoinput)
850 (defvar ido-common-match-string nil
851 "Stores the string that is common to all matching files.")
853 (defvar ido-rescan nil
854 "Non-nil means we need to regenerate the list of matching items.")
856 (defvar ido-rotate nil
857 "Non-nil means we are rotating list of matches.")
859 (defvar ido-text nil
860 "Stores the users string as it is typed in.")
862 (defvar ido-text-init nil
863 "The initial string for the users string it is typed in.")
865 (defvar ido-matches nil
866 "List of files currently matching `ido-text'.")
868 (defvar ido-report-no-match t
869 "Report [No Match] when no completions matches ido-text.")
871 (defvar ido-exit nil
872 "Flag to monitor how `ido-find-file' exits.
873 If equal to `takeprompt', we use the prompt as the file name to be
874 selected.")
876 (defvar ido-current-directory nil
877 "Current directory for ido-find-file.")
879 (defvar ido-auto-merge-timer nil
880 "Delay timer for auto merge.")
882 (defvar ido-use-mycompletion-depth 0
883 "Non-nil means use `ido' completion feedback.
884 Is set by ido functions to the current minibuffer-depth, so that
885 it doesn't interfere with other minibuffer usage.")
888 ;;; Variables with dynamic bindings.
889 ;;; Declared here to keep the byte compiler quiet.
891 ;; Stores the current ido item type ('file, 'dir or 'buffer).
892 (defvar ido-cur-item)
894 ;; Stores the current list of items that will be searched through.
895 ;; The list is ordered, so that the most interesting item comes first,
896 ;; although by default, the files visible in the current frame are put
897 ;; at the end of the list. Created by `ido-make-item-list'.
898 (defvar ido-cur-list)
900 ;; Stores the list of items which are ignored when building
901 ;; `ido-cur-list'. It is in no specific order.
902 (defvar ido-ignored-list)
904 ;; Keep current item list if non-nil.
905 (defvar ido-keep-item-list)
907 ;; Process ido-ignore-* lists.
908 (defvar ido-process-ignore-lists)
910 ;; Don't process ido-ignore- lists once.
911 (defvar ido-process-ignore-lists-inhibit)
913 ;; Buffer from which ido was entered.
914 (defvar ido-entry-buffer)
916 ;; Non-nil if matching file must be selected.
917 (defvar ido-require-match)
919 ;; Stores a temporary version of the file list being created.
920 (defvar ido-temp-list)
922 ;; Non-nil if default list element should be rotated into place.
923 (defvar ido-rotate-temp)
925 ;; Stores current index in ido-work-directory-list.
926 (defvar ido-work-directory-index)
928 ;; Stores current index in ido-work-file-list.
929 (defvar ido-work-file-index)
931 ;; Set when merged work directory list is in use.
932 (defvar ido-use-merged-list)
934 ;; Set when merged work directory list not yet built.
935 (defvar ido-try-merged-list)
937 ;; Saved state prior to last work directory merge.
938 ;; Value is a list (ido-text dir cur-list ignored-list matches).
939 (defvar ido-pre-merge-state)
941 ;; Original value of vc-master-templates for use in ido-toggle-vc.
942 (defvar ido-saved-vc-mt)
944 ;; Stores temporary state of literal find file.
945 (defvar ido-find-literal)
948 ;;; FUNCTIONS
950 (defun ido-active (&optional merge)
951 (if merge
952 ido-use-merged-list
953 (and (boundp 'ido-completing-read) (= ido-use-mycompletion-depth (minibuffer-depth)))))
955 (defvar ido-trace-enable nil)
957 (defun ido-trace (p &optional s retval)
958 (if ido-trace-enable
959 (let ((b (get-buffer-create " *IDO Trace*"))
960 (deactivate-mark deactivate-mark))
961 (save-excursion
962 (save-restriction
963 (set-buffer b)
964 (insert p ": " (if (stringp s) s (format "%S" s)) "\n")))))
965 retval)
967 (defun ido-toggle-trace (arg)
968 (interactive "P")
969 (setq ido-trace-enable (or arg (not ido-trace-enable)))
970 (let ((b (get-buffer " *IDO Trace*")))
971 (if b
972 (if ido-trace-enable
973 (kill-buffer b)
974 (pop-to-buffer b t t)))))
976 (defun ido-is-root-directory (&optional dir)
977 (setq dir (or dir ido-current-directory))
978 (if (memq system-type '(windows-nt ms-dos))
979 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir)
980 (string-equal "/" dir)))
982 (defun ido-is-ftp-directory (&optional dir)
983 (string-match "\\`/[^/:][^/:]+:/" (or dir ido-current-directory)))
985 (defun ido-is-slow-ftp-host (&optional dir)
986 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps)
987 (setq dir (or dir ido-current-directory))
988 ;; (featurep 'ange-ftp)
989 ;; (ange-ftp-ftp-name dir)
990 (string-match "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/" dir)
991 (let ((host (substring dir (match-beginning 2) (match-end 2))))
992 (or (member host ido-slow-ftp-hosts)
993 (let ((re ido-slow-ftp-host-regexps))
994 (while (and re (not (string-match (car re) host)))
995 (setq re (cdr re)))
996 re)))))
998 (defun ido-time-stamp (&optional time)
999 ;; Time is a floating point number (fractions of 1 hour)
1000 (setq time (or time (current-time)))
1001 (/ (+ (* (car time) 65536.0) (car (cdr time))) 3600.0))
1003 (defun ido-cache-ftp-valid (&optional time)
1004 (and (numberp ido-cache-ftp-work-directory-time)
1005 (> ido-cache-ftp-work-directory-time 0)
1006 (or (not time)
1007 (< (- (ido-time-stamp) time) ido-cache-ftp-work-directory-time))))
1009 (defun ido-may-cache-directory (&optional dir)
1010 (setq dir (or dir ido-current-directory))
1011 (if (and (memq system-type '(windows-nt ms-dos))
1012 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir))
1014 (or (not (ido-is-ftp-directory dir))
1015 (ido-cache-ftp-valid))))
1017 (defun ido-pp (list &optional sep)
1018 (let ((print-level nil) (eval-expression-print-level nil)
1019 (print-length nil) (eval-expression-print-length nil))
1020 (insert "\n;; ----- " (symbol-name list) " -----\n(\n ")
1021 (setq list (symbol-value list))
1022 (while list
1023 (let* ((elt (car list))
1024 (s (if (consp elt) (car elt) elt)))
1025 (if (and (stringp s) (= (length s) 0))
1026 (setq s nil))
1027 (if s
1028 (prin1 elt (current-buffer)))
1029 (if (and (setq list (cdr list)) s)
1030 (insert (or sep "\n ")))))
1031 (insert "\n)\n")))
1033 (defun ido-save-history ()
1034 "Save ido history and cache information between sessions."
1035 (interactive)
1036 (if (and ido-last-directory-list ido-save-directory-list-file)
1037 (save-excursion
1038 (save-window-excursion
1039 (if (find-buffer-visiting ido-save-directory-list-file)
1040 (kill-buffer (find-buffer-visiting ido-save-directory-list-file)))
1041 (if (file-exists-p ido-save-directory-list-file)
1042 (delete-file ido-save-directory-list-file))
1043 (set-buffer (let ((enable-local-variables nil))
1044 (find-file-noselect ido-save-directory-list-file t)))
1045 (goto-char (point-min))
1046 (delete-region (point-min) (point-max))
1047 (ido-pp 'ido-last-directory-list)
1048 (ido-pp 'ido-work-directory-list)
1049 (ido-pp 'ido-work-file-list)
1050 (ido-pp 'ido-dir-file-cache "\n\n ")
1051 (insert "\n")
1052 (let ((version-control 'never))
1053 (write-file ido-save-directory-list-file nil))
1054 (kill-buffer (current-buffer))))))
1056 (defun ido-load-history (&optional arg)
1057 "Load ido history and cache information from previous session.
1058 With prefix argument, reload history unconditionally."
1059 (interactive "P")
1060 (if (or arg (and ido-save-directory-list-file (not ido-last-directory-list)))
1061 (let ((file (expand-file-name ido-save-directory-list-file))
1062 buf)
1063 (when (file-readable-p file)
1064 (save-excursion
1065 (save-window-excursion
1066 (setq buf (set-buffer (let ((enable-local-variables nil))
1067 (find-file-noselect file))))
1068 (goto-char (point-min))
1069 (condition-case nil
1070 (setq ido-last-directory-list (read (current-buffer))
1071 ido-work-directory-list (read (current-buffer))
1072 ido-work-file-list (read (current-buffer))
1073 ido-dir-file-cache (read (current-buffer)))
1074 (error nil))))
1075 (kill-buffer buf))))
1076 (ido-wash-history))
1078 (defun ido-wash-history ()
1079 "Clean-up ido history and cache information.
1080 Removes badly formatted data and ignored directories."
1081 (interactive)
1082 ;; Check format of each of our lists, discard bogus elements
1083 (setq ido-last-directory-list
1084 (and (listp ido-last-directory-list)
1085 (let ((l ido-last-directory-list) r)
1086 (while l
1087 (if (and (consp (car l))
1088 (stringp (car (car l)))
1089 (stringp (cdr (car l))))
1090 (setq r (cons (car l) r)))
1091 (setq l (cdr l)))
1092 (nreverse r))))
1093 (setq ido-work-directory-list
1094 (and (listp ido-work-directory-list)
1095 (let ((l ido-work-directory-list) r)
1096 (while l
1097 (if (and (stringp (car l))
1098 (or ido-record-ftp-work-directories
1099 (not (ido-is-ftp-directory (car l)))))
1100 (setq r (cons (car l) r)))
1101 (setq l (cdr l)))
1102 (nreverse r))))
1103 (setq ido-work-file-list
1104 (and (listp ido-work-file-list)
1105 (let ((l ido-work-file-list) r)
1106 (while l
1107 (if (stringp (car l))
1108 (setq r (cons (car l) r)))
1109 (setq l (cdr l)))
1110 (nreverse r))))
1111 (setq ido-dir-file-cache
1112 (and (listp ido-dir-file-cache)
1113 (let ((l ido-dir-file-cache) r)
1114 (while l
1115 (if (and (listp (car l))
1116 (> (length (car l)) 2)
1117 (let ((dir (car (car l)))
1118 (time (car (cdr (car l))))
1119 (files (cdr (cdr (car l)))))
1120 (and
1121 (stringp dir)
1122 (consp time)
1123 (if (integerp (car time))
1124 (and (/= (car time) 0)
1125 (integerp (car (cdr time)))
1126 (/= (car (cdr time)) 0)
1127 (ido-may-cache-directory dir))
1128 (and (eq (car time) 'ftp)
1129 (numberp (cdr time))
1130 (ido-is-ftp-directory dir)
1131 (ido-cache-ftp-valid (cdr time))))
1132 (let ((s files) (ok t))
1133 (while s
1134 (if (stringp (car s))
1135 (setq s (cdr s))
1136 (setq s nil ok nil)))
1137 ok))))
1138 (setq r (cons (car l) r)))
1139 (setq l (cdr l)))
1140 (nreverse r))))
1142 ;; Remove ignored directories from work directory list
1143 ;; according to ido-work-directory-list-ignore-regexps
1144 (if ido-work-directory-list
1145 (let ((dirs (reverse ido-work-directory-list)))
1146 (setq ido-work-directory-list nil)
1147 (while dirs
1148 (ido-record-work-directory (car dirs))
1149 (setq dirs (cdr dirs)))))
1150 ;; Get rid of text properties
1151 (let ((l ido-last-directory-list) e)
1152 (while l
1153 (setq e (car l) l (cdr l))
1154 (set-text-properties 0 (length (car e)) nil (car e))
1155 (set-text-properties 0 (length (cdr e)) nil (cdr e))))
1156 (let ((l ido-work-directory-list) e)
1157 (while l
1158 (setq e (car l) l (cdr l))
1159 (set-text-properties 0 (length e) nil e)))
1160 (let ((l ido-work-file-list) e)
1161 (while l
1162 (setq e (car l) l (cdr l))
1163 (set-text-properties 0 (length e) nil e)))
1164 (let ((l ido-dir-file-cache) e d)
1165 (while l
1166 (setq e (car l) l (cdr l))
1167 (if (listp e)
1168 (while e
1169 (setq d (car e) e (cdr e))
1170 (if (not (consp d))
1171 (set-text-properties 0 (length d) nil d))))))
1175 (defun ido-kill-emacs-hook ()
1176 ;; ido kill emacs hook
1177 (ido-save-history))
1179 (defvar ido-minor-mode-map-entry nil)
1181 ;;;###autoload
1182 (defun ido-mode (&optional arg nobind)
1183 "Toggle ido speed-ups on or off.
1184 With ARG, turn ido speed-up on if arg is positive, off otherwise.
1185 If second argument NOBIND is non-nil, no keys are rebound; otherwise,
1186 turning on ido-mode will modify the default keybindings for the
1187 find-file and switch-to-buffer families of commands to the ido
1188 versions of these functions.
1189 However, if second arg equals 'files, bind only for files, or if it
1190 equals 'buffers, bind only for buffers.
1191 This function also adds a hook to the minibuffer."
1192 (interactive "P")
1193 (setq ido-mode
1194 (cond
1195 ((null arg) (if ido-mode nil 'both))
1196 ((eq arg t) 'both)
1197 ((eq arg 'files) 'file)
1198 ((eq arg 'buffers) 'buffer)
1199 ((memq arg '(file buffer both)) arg)
1200 ((> (prefix-numeric-value arg) 0) 'both)
1201 (t nil)))
1203 (ido-everywhere (if ido-everywhere 1 -1))
1205 (when ido-mode
1206 (add-hook 'minibuffer-setup-hook 'ido-minibuffer-setup)
1207 (add-hook 'choose-completion-string-functions 'ido-choose-completion-string)
1208 (ido-load-history)
1210 (add-hook 'kill-emacs-hook 'ido-kill-emacs-hook)
1212 (unless ido-minor-mode-map-entry
1213 (setq ido-minor-mode-map-entry (cons 'ido-mode (make-sparse-keymap)))
1214 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry))
1216 (let ((map (cdr ido-minor-mode-map-entry)))
1217 (when (memq ido-mode '(file both))
1218 (define-key map [remap find-file] 'ido-find-file)
1219 (define-key map [remap find-file-read-only] 'ido-find-file-read-only)
1220 (define-key map [remap find-alternate-file] 'ido-find-alternate-file)
1221 (define-key map [remap write-file] 'ido-write-file)
1222 (define-key map [remap insert-file] 'ido-insert-file)
1223 (define-key map [remap list-directory] 'ido-list-directory)
1224 (define-key map [remap dired] 'ido-dired)
1225 (define-key map [remap find-file-other-window] 'ido-find-file-other-window)
1226 (define-key map [remap find-file-read-only-other-window] 'ido-find-file-read-only-other-window)
1227 (define-key map [remap find-file-other-frame] 'ido-find-file-other-frame)
1228 (define-key map [remap find-file-read-only-other-frame] 'ido-find-file-read-only-other-frame))
1230 (when (memq ido-mode '(buffer both))
1231 (define-key map [remap switch-to-buffer] 'ido-switch-buffer)
1232 (define-key map [remap switch-to-buffer-other-window] 'ido-switch-buffer-other-window)
1233 (define-key map [remap switch-to-buffer-other-frame] 'ido-switch-buffer-other-frame)
1234 (define-key map [remap insert-buffer] 'ido-insert-buffer)
1235 (define-key map [remap kill-buffer] 'ido-kill-buffer)
1236 (define-key map [remap display-buffer] 'ido-display-buffer)))))
1238 (defun ido-everywhere (arg)
1239 "Enable ido everywhere file and directory names are read."
1240 (interactive "P")
1241 (setq ido-everywhere (if arg
1242 (> (prefix-numeric-value arg) 0)
1243 (not ido-everywhere)))
1244 (setq read-file-name-function
1245 (and ido-everywhere (memq ido-mode '(both file))
1246 'ido-read-file-name))
1247 (setq read-buffer-function
1248 (and ido-everywhere (memq ido-mode '(both buffer))
1249 'ido-read-buffer)))
1252 ;;; IDO KEYMAP
1253 (defun ido-define-mode-map ()
1254 "Set up the keymap for `ido'."
1255 (let (map)
1256 ;; generated every time so that it can inherit new functions.
1258 (setq map (copy-keymap minibuffer-local-map))
1259 (define-key map "\C-a" 'ido-toggle-ignore)
1260 (define-key map "\C-c" 'ido-toggle-case)
1261 (define-key map "\C-e" 'ido-edit-input)
1262 (define-key map "\t" 'ido-complete)
1263 (define-key map " " 'ido-complete-space)
1264 (define-key map "\C-j" 'ido-select-text)
1265 (define-key map "\C-m" 'ido-exit-minibuffer)
1266 (define-key map "\C-p" 'ido-toggle-prefix)
1267 (define-key map "\C-r" 'ido-prev-match)
1268 (define-key map "\C-s" 'ido-next-match)
1269 (define-key map "\C-t" 'ido-toggle-regexp)
1270 (define-key map "\C-z" 'ido-undo-merge-work-directory)
1271 (define-key map [(control ? )] 'ido-restrict-to-matches)
1272 (define-key map [(control ?@)] 'ido-restrict-to-matches)
1273 (define-key map [right] 'ido-next-match)
1274 (define-key map [left] 'ido-prev-match)
1275 (define-key map "?" 'ido-completion-help)
1277 (when (memq ido-cur-item '(file dir))
1278 (define-key map "\C-b" 'ido-enter-switch-buffer)
1279 (define-key map "\C-d" 'ido-enter-dired)
1280 (define-key map "\C-f" 'ido-fallback-command)
1281 (define-key map [down] 'ido-next-match-dir)
1282 (define-key map [up] 'ido-prev-match-dir)
1283 (define-key map [(meta up)] 'ido-prev-work-directory)
1284 (define-key map [(meta down)] 'ido-next-work-directory)
1285 (define-key map [backspace] 'ido-delete-backward-updir)
1286 (define-key map "\d" 'ido-delete-backward-updir)
1287 (define-key map [(meta backspace)] 'ido-delete-backward-word-updir)
1288 (define-key map [(control backspace)] 'ido-up-directory)
1289 (define-key map [(meta ?b)] 'ido-next-work-file)
1290 (define-key map [(meta ?d)] 'ido-wide-find-dir)
1291 (define-key map [(meta ?f)] 'ido-wide-find-file)
1292 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1293 (define-key map [(meta ?m)] 'ido-make-directory)
1294 (define-key map [(meta ?n)] 'ido-next-work-directory)
1295 (define-key map [(meta ?o)] 'ido-prev-work-file)
1296 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1297 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1300 (when (eq ido-cur-item 'file)
1301 (define-key map "\C-k" 'ido-delete-file-at-head)
1302 (define-key map "\C-o" 'ido-copy-current-word)
1303 (define-key map "\C-l" 'ido-reread-directory)
1304 (define-key map "\C-w" 'ido-copy-current-file-name)
1305 (define-key map [(meta ?l)] 'ido-toggle-literal)
1306 (define-key map "\C-v" 'ido-toggle-vc)
1309 (when (eq ido-cur-item 'buffer)
1310 (define-key map "\C-b" 'ido-fallback-command)
1311 (define-key map "\C-f" 'ido-enter-find-file)
1312 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1315 (setq ido-mode-map map)
1316 (run-hooks 'ido-define-mode-map-hook)))
1318 (defun ido-final-slash (dir &optional fix-it)
1319 ;; return DIR if DIR has final slash.
1320 ;; else if FIX-IT is non-nil, return DIR/
1321 ;; else return nil.
1322 (setq dir (ido-name dir))
1323 (cond
1324 ((string-match "/\\'" dir) dir)
1325 (fix-it (concat dir "/"))
1326 (t nil)))
1328 (defun ido-set-current-directory (dir &optional subdir no-merge)
1329 ;; Set ido's current directory to DIR or DIR/SUBDIR
1330 (setq dir (ido-final-slash dir t))
1331 (setq ido-use-merged-list nil
1332 ido-try-merged-list (not no-merge))
1333 (if subdir
1334 (setq dir (ido-final-slash (concat dir subdir) t)))
1335 (if (equal dir ido-current-directory)
1337 (ido-trace "cd" dir)
1338 (setq ido-current-directory dir)
1339 (if (get-buffer ido-completion-buffer)
1340 (kill-buffer ido-completion-buffer))
1343 (defun ido-set-current-home (&optional dir)
1344 ;; Set ido's current directory to user's home directory
1345 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1347 (defun ido-record-command (command arg)
1348 ;; Add (command arg) to command-history if ido-record-commands is t
1349 (if ido-record-commands
1350 (let ((cmd (list command arg)))
1351 (if (or (not command-history)
1352 (not (equal cmd (car command-history))))
1353 (setq command-history (cons cmd command-history))))))
1355 (defun ido-make-prompt (item prompt)
1356 ;; Make the prompt for ido-read-internal
1357 (cond
1358 ((and (memq item '(file dir)) ido-current-directory)
1359 (let ((path (abbreviate-file-name ido-current-directory))
1360 (max-width (if (and ido-max-prompt-path (floatp ido-max-prompt-path))
1361 (floor (* (frame-width) ido-max-prompt-path))
1362 ido-max-prompt-path))
1363 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1364 (vc-off (and ido-saved-vc-mt (not vc-master-templates) "[-VC] "))
1365 (prefix nil)
1366 (rule ido-rewrite-prompt-path-rules))
1367 (let ((case-fold-search nil))
1368 (while rule
1369 (if (and (consp (car rule))
1370 (string-match (car (car rule)) path))
1371 (setq path
1372 (if (stringp (cdr (car rule)))
1373 (replace-match (cdr (car rule)) t nil path)
1374 (funcall (cdr (car rule)) path))))
1375 (setq rule (cdr rule))))
1376 (run-hooks 'ido-make-file-prompt-hook)
1377 (concat prompt
1378 ; (if ido-process-ignore-lists "" "&")
1379 (or literal "")
1380 (or vc-off "")
1381 (or prefix "")
1382 (let ((l (length path)))
1383 (if (and max-width (> max-width 0) (> l max-width))
1384 (let* ((s (substring path (- max-width)))
1385 (i (string-match "/" s)))
1386 (concat "..." (if i (substring s i) s)))
1387 path)))))
1388 (t prompt)))
1390 ;; Here is very briefly how ido-find-file works:
1392 ;; (ido-find-file)
1393 ;; (ido-file-internal method)
1394 ;; set ido-current-directory
1395 ;; (ido-read-internal 'file ...)
1396 ;; (while ...
1397 ;; (ido-make-item-list ...)
1398 ;; (ido-set-matches)
1399 ;; (completing-read ... ido-text-init ...)
1401 ;; ... here user is allowed to type characters and commands
1402 ;; a command may set ido-exit and call (exit-minibuffer)
1403 ;; to make ido-read-internal do advanced tasks (or return)
1405 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1406 ;; which are run before and after each user command.
1408 ;; return value from completing-read is stored in ido-final-text
1409 ;; - ido-exit may cause further actions to be taken:
1410 ;; 'refresh - repeat loop (make-item-list, set-matches)
1411 ;; 'edit - edit the prompt string, then repeat loop
1412 ;; 'keep - repeat loop but don't (re)make-item-list
1413 ;; 'updir - go up one directory, repeat loop
1414 ;; else set ido-selected based on ido-final-text,
1415 ;; optionally update ido-current-directory and repeat loop, or
1416 ;; exit with the return value of ido-selected (file name)
1417 ;; selected file name is returned from ido-read-internal,
1418 ;; ido-exit and method determines what action is taken
1419 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1420 ;; the relevant function is called (find-file, write-file, etc).
1422 (defun ido-read-internal (item prompt history &optional default require-match initial)
1423 "Perform the ido-read-buffer and ido-read-file-name functions.
1424 Return the name of a buffer or file selected.
1425 PROMPT is the prompt to give to the user.
1426 DEFAULT if given is the default directory to start with.
1427 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1428 If INITIAL is non-nil, it specifies the initial input string."
1429 (let
1430 ((ido-cur-item item)
1431 (ido-entry-buffer (current-buffer))
1432 (ido-process-ignore-lists t)
1433 (ido-process-ignore-lists-inhibit nil)
1434 (ido-set-default-item t)
1435 ido-default-item
1436 ido-selected
1437 ido-final-text
1438 (done nil)
1439 (icomplete-mode nil) ;; prevent icomplete starting up
1440 ;; Exported dynamic variables:
1441 ido-cur-list
1442 ido-ignored-list
1443 (ido-rotate-temp nil)
1444 (ido-keep-item-list nil)
1445 (ido-use-merged-list nil)
1446 (ido-try-merged-list t)
1447 (ido-pre-merge-state nil)
1448 (ido-case-fold ido-case-fold)
1449 (ido-enable-prefix ido-enable-prefix)
1450 (ido-enable-regexp ido-enable-regexp)
1453 (ido-define-mode-map)
1454 (setq ido-text-init initial)
1455 (while (not done)
1456 (ido-trace "\n_LOOP_")
1457 (setq ido-exit nil)
1458 (setq ido-rescan t)
1459 (setq ido-rotate nil)
1460 (setq ido-text "")
1461 (when ido-set-default-item
1462 (setq ido-default-item
1463 (cond
1464 ((eq item 'buffer)
1465 (if (bufferp default) (buffer-name default) default))
1466 ((stringp default) default)
1467 ((eq item 'file)
1468 (and ido-enable-last-directory-history
1469 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1470 (and d (cdr d)))))))
1471 (if (member ido-default-item ido-ignore-item-temp-list)
1472 (setq ido-default-item nil))
1473 (setq ido-set-default-item nil))
1475 (if ido-process-ignore-lists-inhibit
1476 (setq ido-process-ignore-lists nil))
1478 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1479 (let ((olist ido-cur-list)
1480 (oign ido-ignored-list)
1481 (omat ido-matches)
1482 (l (ido-make-merged-file-list ido-text-init
1483 (eq ido-use-merged-list 'auto)
1484 (eq ido-try-merged-list 'wide))))
1485 (cond
1486 ((not l)
1487 (if (eq ido-try-merged-list 'wide)
1488 (setq ido-pre-merge-state
1489 (list "" ido-current-directory olist oign omat)
1490 ido-cur-list nil
1491 ido-ignored-list nil
1492 ido-matches nil
1493 ido-keep-item-list t
1494 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1495 ido-use-merged-list nil)
1496 (setq ido-cur-list olist
1497 ido-ignored-list oign
1498 ido-matches omat
1499 ido-keep-item-list t
1500 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1501 ido-use-merged-list nil)))
1502 ((eq l t)
1503 (setq ido-use-merged-list nil))
1505 (setq ido-pre-merge-state
1506 (list ido-text-init ido-current-directory olist oign omat))
1507 (ido-set-current-directory (car (cdr (car l))))
1508 (if (ido-final-slash ido-text-init)
1509 (setq ido-text-init ""))
1510 (setq ido-cur-list l
1511 ido-ignored-list nil
1512 ido-matches l
1513 ido-rescan nil
1514 ido-keep-item-list t
1515 ido-use-merged-list t)
1516 (ido-trace "Merged" t)
1517 ))))
1519 (cond
1520 (ido-keep-item-list
1521 (setq ido-keep-item-list nil
1522 ido-rescan nil))
1523 ((eq ido-cur-item 'file)
1524 (setq ido-ignored-list nil
1525 ido-cur-list (ido-make-file-list ido-default-item)))
1526 ((eq ido-cur-item 'dir)
1527 (setq ido-ignored-list nil
1528 ido-cur-list (ido-make-dir-list ido-default-item)))
1529 ((eq ido-cur-item 'buffer)
1530 (setq ido-ignored-list nil
1531 ido-cur-list (ido-make-buffer-list ido-default-item)))
1532 (t nil))
1533 (setq ido-rotate-temp nil)
1535 (if ido-process-ignore-lists-inhibit
1536 (setq ido-process-ignore-lists t
1537 ido-process-ignore-lists-inhibit nil))
1539 (ido-set-matches)
1540 (if (and ido-matches (eq ido-try-merged-list 'auto))
1541 (setq ido-try-merged-list t))
1542 (let
1543 ((minibuffer-local-completion-map ido-mode-map)
1544 (max-mini-window-height (or ido-max-window-height
1545 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1546 (ido-completing-read t)
1547 (ido-require-match require-match)
1548 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1549 (show-paren-mode nil))
1550 ;; prompt the user for the file name
1551 (setq ido-exit nil)
1552 (setq ido-final-text
1553 (catch 'ido
1554 (completing-read
1555 (ido-make-prompt item prompt)
1556 '(("dummy" . 1)) nil nil ; table predicate require-match
1557 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1558 history))))
1559 (ido-trace "completing-read" ido-final-text)
1560 (if (get-buffer ido-completion-buffer)
1561 (kill-buffer ido-completion-buffer))
1563 (ido-trace "\n_EXIT_" ido-exit)
1565 (cond
1566 ((eq ido-exit 'refresh)
1567 (if (and (eq ido-use-merged-list 'auto)
1568 (or (input-pending-p)))
1569 (setq ido-use-merged-list nil
1570 ido-keep-item-list t))
1571 nil)
1573 ((eq ido-exit 'done)
1574 (setq done t
1575 ido-selected ido-text
1576 ido-exit nil))
1578 ((memq ido-exit '(edit chdir))
1579 (cond
1580 ((memq ido-cur-item '(file dir))
1581 (let* ((process-environment (cons "HOME=/" process-environment)) ;; cheat read-file-name
1582 (read-file-name-function nil)
1583 (edit (eq ido-exit 'edit))
1584 (d ido-current-directory)
1585 (f ido-text-init)
1586 (path t))
1587 (setq ido-text-init "")
1588 (while path
1589 (setq path (if edit
1590 (read-file-name (concat prompt "[EDIT] ") d (concat d f) nil f)
1592 d (or (file-name-directory path) "/")
1593 f (file-name-nondirectory path)
1594 edit t)
1595 (if (or
1596 (file-directory-p d)
1597 (and (yes-or-no-p (format "Create directory %s? " d))
1598 (condition-case nil
1599 (progn (make-directory d t) t)
1600 (error
1601 (message "Could not create directory")
1602 (sit-for 1)
1603 nil))))
1604 (progn
1605 (ido-set-current-directory d nil (eq ido-exit 'chdir))
1606 (setq ido-text-init f
1607 path nil))))))
1609 (setq ido-text-init nil)
1610 (setq ido-text-init (read-string (concat prompt "[EDIT] ") ido-final-text))))
1611 nil)
1613 ((eq ido-exit 'keep)
1614 (setq ido-keep-item-list t))
1616 ((memq ido-exit '(dired fallback findfile findbuffer))
1617 (setq done t))
1619 ((eq ido-exit 'updir)
1620 ;; cannot go up if already at the root-dir (Unix) or at the
1621 ;; root-dir of a certain drive (Windows or MS-DOS).
1622 (or (ido-is-root-directory)
1623 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1624 (setq ido-set-default-item t))
1626 ;; Handling the require-match must be done in a better way.
1627 ((and require-match (not (ido-existing-item-p)))
1628 (error "must specify valid item"))
1631 (setq ido-selected
1632 (if (or (eq ido-exit 'takeprompt)
1633 (null ido-matches))
1634 ido-final-text
1635 ;; else take head of list
1636 (ido-name (car ido-matches))))
1638 (cond
1639 ((eq item 'buffer)
1640 (setq done t))
1642 ((string-equal "./" ido-selected)
1643 nil)
1645 ((string-equal "../" ido-selected)
1646 ;; cannot go up if already at the root-dir (Unix) or at the
1647 ;; root-dir of a certain drive (Windows or MS-DOS).
1648 (or (ido-is-root-directory)
1649 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1650 (setq ido-set-default-item t))
1651 ((and (string-equal ido-current-directory "/")
1652 (string-match "..:\\'" ido-selected)) ;; Ange-ftp
1653 (ido-set-current-directory "/" ido-selected)
1654 (if (ido-is-slow-ftp-host)
1655 (setq ido-exit 'fallback
1656 done t)
1657 (setq ido-set-default-item t)))
1659 ((or (string-match "[/\\][^/\\]" ido-selected)
1660 (and (memq system-type '(windows-nt ms-dos))
1661 (string-match "\\`.:" ido-selected)))
1662 (ido-set-current-directory (file-name-directory ido-selected))
1663 (setq ido-set-default-item t))
1665 ((string-match "\\`~" ido-selected)
1666 (ido-set-current-home ido-selected))
1668 ((ido-final-slash ido-selected)
1669 (if ido-enable-last-directory-history
1670 (let ((x (assoc ido-current-directory ido-last-directory-list)))
1671 (if x
1672 (setcdr x ido-selected)
1673 (setq ido-last-directory-list
1674 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
1675 (ido-set-current-directory ido-current-directory ido-selected)
1676 (setq ido-set-default-item t))
1679 (setq done t))))))
1680 ido-selected))
1682 (defun ido-edit-input ()
1683 "Edit ido path and input string. Terminate by RET."
1684 (interactive)
1685 (setq ido-text-init ido-text)
1686 (setq ido-exit 'edit)
1687 (exit-minibuffer))
1689 ;;; MAIN FUNCTIONS
1690 (defun ido-buffer-internal (method &optional fallback prompt default initial)
1691 ;; Internal function for ido-switch-buffer and friends
1692 (if (not ido-mode)
1693 (call-interactively (or fallback 'switch-to-buffer))
1694 (let ((buf (ido-read-buffer (or prompt "Buffer: ") default nil initial)))
1696 ;; Choose the buffer name: either the text typed in, or the head
1697 ;; of the list of matches
1699 (cond
1700 ((eq ido-exit 'findfile)
1701 (ido-file-internal ido-default-file-method nil nil nil nil ido-text))
1703 ((eq ido-exit 'fallback)
1704 (let ((read-buffer-function nil))
1705 (call-interactively (or fallback 'switch-to-buffer))))
1707 ;; Check buf is non-nil.
1708 ((not buf) nil)
1709 ((= (length buf) 0) nil)
1711 ;; View buffer if it exists
1712 ((get-buffer buf)
1713 (if (eq method 'insert)
1714 (progn
1715 (ido-record-command 'insert-buffer buf)
1716 (insert-buffer buf))
1717 (ido-visit-buffer buf method t)))
1719 ;; buffer doesn't exist
1720 ((eq ido-create-new-buffer 'never)
1721 (message "no buffer matching `%s'" buf))
1723 ((and (eq ido-create-new-buffer 'prompt)
1724 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
1725 nil)
1727 ;; create a new buffer
1729 (setq buf (get-buffer-create buf))
1730 (if (fboundp 'set-buffer-major-mode)
1731 (set-buffer-major-mode buf))
1732 (ido-visit-buffer buf method t))))))
1734 ;;;###autoload
1735 (defun ido-read-buffer (prompt &optional default require-match initial)
1736 "Replacement for the built-in `read-buffer'.
1737 Return the name of a buffer selected.
1738 PROMPT is the prompt to give to the user. DEFAULT if given is the default
1739 buffer to be selected, which will go to the front of the list.
1740 If REQUIRE-MATCH is non-nil, an existing-buffer must be selected.
1741 If INITIAL is non-nil, it specifies the initial input string."
1742 (let ((ido-current-directory nil))
1743 (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match initial)))
1745 (defun ido-record-work-directory (&optional dir)
1746 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
1747 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
1748 (let ((items ido-work-directory-list-ignore-regexps)
1749 (case-fold-search nil))
1750 (while (and items dir)
1751 (if (string-match (car items) dir)
1752 (setq dir nil))
1753 (setq items (cdr items)))
1754 (if dir
1755 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
1756 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
1757 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
1759 (defun ido-forget-work-directory ()
1760 (interactive)
1761 (when (and ido-current-directory ido-work-directory-list)
1762 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
1763 (when ido-use-merged-list
1764 (ido-undo-merge-work-directory)
1765 (setq ido-exit 'refresh
1766 ido-try-merged-list t
1767 ido-use-merged-list t
1768 ido-text-init ido-text
1769 ido-rotate-temp t)
1770 (exit-minibuffer))))
1772 (defun ido-record-work-file (name)
1773 ;; Save NAME in ido-work-file-list
1774 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
1776 (and ido-work-file-list (equal (car ido-work-file-list) name))
1777 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
1778 (if (> (length ido-work-file-list) ido-max-work-file-list)
1779 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
1781 (defun ido-file-internal (method &optional fallback default prompt item initial)
1782 ;; Internal function for ido-find-file and friends
1783 (let ((ido-current-directory (expand-file-name (or default default-directory)))
1784 filename)
1786 (if (or (not ido-mode) (ido-is-slow-ftp-host))
1787 (setq filename t
1788 ido-exit 'fallback))
1790 (let (ido-saved-vc-mt
1791 (vc-master-templates (and (boundp 'vc-master-templates) vc-master-templates))
1792 (ido-work-directory-index -1)
1793 (ido-work-file-index -1)
1794 (ido-find-literal nil))
1796 (unless filename
1797 (setq ido-saved-vc-mt vc-master-templates)
1798 (setq filename (ido-read-internal (or item 'file)
1799 (or prompt "Find file: ")
1800 'ido-file-history nil nil initial)))
1802 ;; Choose the file name: either the text typed in, or the head
1803 ;; of the list of matches
1805 (cond
1806 ((eq ido-exit 'fallback)
1807 ;; Need to guard setting of default-directory here, since
1808 ;; we don't want to change directory of current buffer.
1809 (let ((default-directory ido-current-directory)
1810 (read-file-name-function nil))
1811 (call-interactively (or fallback 'find-file))))
1813 ((eq ido-exit 'findbuffer)
1814 (ido-buffer-internal ido-default-buffer-method nil nil nil ido-text))
1816 ((eq ido-exit 'dired)
1817 (dired (concat ido-current-directory (or ido-text ""))))
1819 ((eq method 'alt-file)
1820 (ido-record-work-file filename)
1821 (setq default-directory ido-current-directory)
1822 (ido-record-work-directory)
1823 (find-alternate-file filename))
1825 ((memq method '(dired list-directory))
1826 (if (equal filename ".")
1827 (setq filename ""))
1828 (let* ((path (ido-final-slash (concat ido-current-directory filename) t))
1829 (file (substring path 0 -1)))
1830 (cond
1831 ((file-directory-p path)
1832 (ido-record-command method path)
1833 (ido-record-work-directory path)
1834 (funcall method path))
1835 ((file-directory-p ido-current-directory)
1836 (cond
1837 ((file-exists-p file)
1838 (ido-record-command method ido-current-directory)
1839 (ido-record-work-directory)
1840 (funcall method ido-current-directory)
1841 (if (eq method 'dired)
1842 (dired-goto-file (expand-file-name file))))
1843 ((string-match "[[*?]" filename)
1844 (setq path (concat ido-current-directory filename))
1845 (ido-record-command method path)
1846 (ido-record-work-directory)
1847 (funcall method path))
1848 ((y-or-n-p (format "Directory %s does not exist. Create it " filename))
1849 (ido-record-command method path)
1850 (ido-record-work-directory path)
1851 (make-directory-internal path)
1852 (funcall method path))
1854 ;; put make-directory command on history
1855 (ido-record-command 'make-directory path))))
1856 (t (error "No such directory")))))
1858 ((eq method 'write)
1859 (ido-record-work-file filename)
1860 (setq default-directory ido-current-directory)
1861 (ido-record-command 'write-file (concat ido-current-directory filename))
1862 (ido-record-work-directory)
1863 (write-file filename))
1865 ((eq method 'read-only)
1866 (ido-record-work-file filename)
1867 (setq filename (concat ido-current-directory filename))
1868 (ido-record-command fallback filename)
1869 (ido-record-work-directory)
1870 (funcall fallback filename))
1872 ((eq method 'insert)
1873 (ido-record-work-file filename)
1874 (setq filename (concat ido-current-directory filename))
1875 (ido-record-command
1876 (if ido-find-literal 'insert-file-literally 'insert-file)
1877 filename)
1878 (ido-record-work-directory)
1879 (if ido-find-literal
1880 (insert-file-contents-literally filename)
1881 (insert-file-contents filename)))
1883 (filename
1884 (ido-record-work-file filename)
1885 (setq filename (concat ido-current-directory filename))
1886 (ido-record-command 'find-file filename)
1887 (ido-record-work-directory)
1888 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
1890 (defun ido-existing-item-p ()
1891 ;; Return non-nil if there is a matching item
1892 (not (null ido-matches)))
1894 ;;; COMPLETION CODE
1896 (defun ido-set-common-completion ()
1897 ;; Find common completion of `ido-text' in `ido-matches'
1898 ;; The result is stored in `ido-common-match-string'
1899 (let* (val)
1900 (setq ido-common-match-string nil)
1901 (if (and ido-matches
1902 (not ido-enable-regexp) ;; testing
1903 (stringp ido-text)
1904 (> (length ido-text) 0))
1905 (if (setq val (ido-find-common-substring ido-matches ido-text))
1906 (setq ido-common-match-string val)))
1907 val))
1909 (defun ido-complete ()
1910 "Try and complete the current pattern amongst the file names."
1911 (interactive)
1912 (let (res)
1913 (cond
1914 ((and (memq ido-cur-item '(file dir))
1915 (string-match "[$]" ido-text))
1916 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
1917 (if (not (file-exists-p (file-name-directory evar)))
1918 (message "Expansion generates non-existing directory path")
1919 (if (file-directory-p evar)
1920 (ido-set-current-directory evar)
1921 (let ((d (or (file-name-directory evar) "/"))
1922 (f (file-name-nondirectory evar)))
1923 (when (file-directory-p d)
1924 (ido-set-current-directory d)
1925 (setq ido-text-init f))))
1926 (setq ido-exit 'refresh)
1927 (exit-minibuffer))))
1929 ((not ido-matches)
1930 (when ido-completion-buffer
1931 (setq this-command 'ido-completion-help)
1932 (ido-completion-help)))
1934 ((= 1 (length ido-matches))
1935 ;; only one choice, so select it.
1936 (exit-minibuffer))
1938 (t ;; else there could be some completions
1939 (setq res ido-common-match-string)
1940 (if (and (not (memq res '(t nil)))
1941 (not (equal res ido-text)))
1942 ;; found something to complete, so put it in the minibuffer.
1943 (progn
1944 ;; move exact match to front if not in prefix mode
1945 (setq ido-rescan (not ido-enable-prefix))
1946 (delete-region (minibuffer-prompt-end) (point))
1947 (insert res))
1948 ;; else nothing to complete
1949 (ido-completion-help)
1950 )))))
1952 (defun ido-complete-space ()
1953 "Try completion unless inserting the space makes sense."
1954 (interactive)
1955 (if (and (stringp ido-common-match-string)
1956 (stringp ido-text)
1957 (cond
1958 ((> (length ido-common-match-string) (length ido-text))
1959 (= (aref ido-common-match-string (length ido-text)) ? ))
1960 (ido-matches
1961 (let (insert-space
1962 (re (concat (regexp-quote ido-text) " "))
1963 (comp ido-matches))
1964 (while comp
1965 (if (string-match re (ido-name (car comp)))
1966 (setq comp nil insert-space t)
1967 (setq comp (cdr comp))))
1968 insert-space))
1969 (t nil)))
1970 (insert " ")
1971 (ido-complete)))
1973 (defun ido-undo-merge-work-directory (&optional text try refresh)
1974 "Undo or redo last ido directory merge operation.
1975 If no merge has yet taken place, toggle automatic merging option."
1976 (interactive)
1977 (cond
1978 (ido-pre-merge-state
1979 (ido-set-current-directory (nth 1 ido-pre-merge-state))
1980 (setq ido-text-init (or text (car ido-pre-merge-state))
1981 ido-cur-list (nth 2 ido-pre-merge-state)
1982 ido-ignored-list (nth 3 ido-pre-merge-state)
1983 ido-matches (nth 4 ido-pre-merge-state)
1984 ido-use-merged-list nil
1985 ido-try-merged-list try
1986 ido-keep-item-list (not refresh)
1987 ido-rescan nil
1988 ido-exit 'refresh
1989 ido-pre-merge-state nil)
1990 (exit-minibuffer))
1991 (text
1992 nil)
1993 (ido-try-merged-list
1994 (setq ido-try-merged-list nil))
1995 (ido-matches
1996 (setq ido-try-merged-list t))
1997 ((not ido-use-merged-list)
1998 (ido-merge-work-directories))))
2000 ;;; TOGGLE FUNCTIONS
2002 (defun ido-toggle-case ()
2003 "Toggle the value of `ido-case-fold'."
2004 (interactive)
2005 (setq ido-case-fold (not ido-case-fold))
2006 ;; ask for list to be regenerated.
2007 (setq ido-rescan t))
2009 (defun ido-toggle-regexp ()
2010 "Toggle the value of `ido-enable-regexp'."
2011 (interactive)
2012 (setq ido-enable-regexp (not ido-enable-regexp))
2013 ;; ask for list to be regenerated.
2014 (setq ido-rescan t))
2016 (defun ido-toggle-prefix ()
2017 "Toggle the value of `ido-enable-prefix'."
2018 (interactive)
2019 (setq ido-enable-prefix (not ido-enable-prefix))
2020 ;; ask for list to be regenerated.
2021 (setq ido-rescan t))
2023 (defun ido-toggle-ignore ()
2024 "Toggle ignoring files specified with `ido-ignore-files'."
2025 (interactive)
2026 (setq ido-process-ignore-lists (not ido-process-ignore-lists))
2027 (setq ido-text-init ido-text)
2028 (setq ido-exit 'refresh)
2029 (exit-minibuffer))
2031 (defun ido-toggle-vc ()
2032 "Disable version control for this file."
2033 (interactive)
2034 (if (and ido-mode (eq ido-cur-item 'file))
2035 (progn
2036 (setq vc-master-templates
2037 (if vc-master-templates nil ido-saved-vc-mt))
2038 (setq ido-text-init ido-text)
2039 (setq ido-exit 'keep)
2040 (exit-minibuffer))))
2042 (defun ido-toggle-literal ()
2043 "Toggle literal reading of this file."
2044 (interactive)
2045 (if (and ido-mode (eq ido-cur-item 'file))
2046 (progn
2047 (setq ido-find-literal (not ido-find-literal))
2048 (setq ido-text-init ido-text)
2049 (setq ido-exit 'keep)
2050 (exit-minibuffer))))
2052 (defun ido-reread-directory ()
2053 "Read current directory again.
2054 May be useful if cached version is no longer valid, but directory
2055 timestamp has not changed (e.g. with ftp or on Windows)."
2056 (interactive)
2057 (if (and ido-mode (eq ido-cur-item 'file))
2058 (progn
2059 (ido-remove-cached-dir ido-current-directory)
2060 (setq ido-text-init ido-text)
2061 (setq ido-rotate-temp t)
2062 (setq ido-exit 'refresh)
2063 (exit-minibuffer))))
2065 (defun ido-exit-minibuffer ()
2066 "Exit minibuffer, but make sure we have a match if one is needed."
2067 (interactive)
2068 (if (or (not ido-require-match)
2069 (ido-existing-item-p))
2070 (throw 'exit nil)))
2072 (defun ido-select-text ()
2073 "Select the buffer or file named by the prompt.
2074 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2075 (interactive)
2076 (setq ido-exit 'takeprompt)
2077 (exit-minibuffer))
2079 (defun ido-fallback-command ()
2080 "Fallback to non-ido version of current command."
2081 (interactive)
2082 (setq ido-exit 'fallback)
2083 (exit-minibuffer))
2085 (defun ido-enter-find-file ()
2086 "Drop into find-file from buffer switching."
2087 (interactive)
2088 (setq ido-exit 'findfile)
2089 (exit-minibuffer))
2091 (defun ido-enter-switch-buffer ()
2092 "Drop into ido-switch-buffer from file switching."
2093 (interactive)
2094 (setq ido-exit 'findbuffer)
2095 (exit-minibuffer))
2097 (defun ido-enter-dired ()
2098 "Drop into dired from file switching."
2099 (interactive)
2100 (setq ido-exit 'dired)
2101 (exit-minibuffer))
2104 (defun ido-up-directory (&optional clear)
2105 "Go up one directory level."
2106 (interactive "P")
2107 (setq ido-text-init (if clear nil ido-text))
2108 (setq ido-exit 'updir)
2109 (setq ido-rotate-temp t)
2110 (exit-minibuffer))
2112 (defun ido-delete-backward-updir (count)
2113 "Delete char backwards, or at beginning of buffer, go up one level."
2114 (interactive "P")
2115 (cond
2116 ((= (minibuffer-prompt-end) (point))
2117 (if (not count)
2118 (ido-up-directory t)))
2119 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2120 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2122 (delete-backward-char (prefix-numeric-value count)))))
2124 (defun ido-delete-backward-word-updir (count)
2125 "Delete all chars backwards, or at beginning of buffer, go up one level."
2126 (interactive "P")
2127 (if (= (minibuffer-prompt-end) (point))
2128 (if (not count)
2129 (ido-up-directory t))
2130 (backward-kill-word (prefix-numeric-value count))))
2132 (defun ido-get-work-directory (&optional incr must-match)
2133 (let ((n (length ido-work-directory-list))
2134 (i ido-work-directory-index)
2135 (j 0)
2136 dir)
2137 (if (or (not ido-text) (= (length ido-text) 0))
2138 (setq must-match nil))
2139 (while (< j n)
2140 (setq i (+ i incr)
2141 j (1+ j))
2142 (if (> incr 0)
2143 (if (>= i n) (setq i 0))
2144 (if (< i 0) (setq i (1- n))))
2145 (setq dir (nth i ido-work-directory-list))
2146 (if (and dir
2147 (not (equal dir ido-current-directory))
2148 (file-directory-p dir)
2149 (or (not must-match)
2150 (ido-set-matches1
2151 (if (eq ido-cur-item 'file)
2152 (ido-make-file-list1 dir)
2153 (ido-make-dir-list1 dir)))))
2154 (setq j n)
2155 (setq dir nil)))
2156 (if dir
2157 (setq ido-work-directory-index i))
2158 dir))
2160 (defun ido-prev-work-directory ()
2161 "Change to next working directory in list."
2162 (interactive)
2163 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2164 (when dir
2165 (ido-set-current-directory dir)
2166 (setq ido-exit 'refresh)
2167 (setq ido-text-init ido-text)
2168 (setq ido-rotate-temp t)
2169 (exit-minibuffer))))
2171 (defun ido-next-work-directory ()
2172 "Change to previous working directory in list."
2173 (interactive)
2174 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2175 (when dir
2176 (ido-set-current-directory dir)
2177 (setq ido-exit 'refresh)
2178 (setq ido-text-init ido-text)
2179 (setq ido-rotate-temp t)
2180 (exit-minibuffer))))
2182 (defun ido-merge-work-directories ()
2183 "Search (and merge) work directories for files matching the current input string."
2184 (interactive)
2185 (setq ido-use-merged-list t ido-try-merged-list t)
2186 (setq ido-exit 'refresh)
2187 (setq ido-text-init ido-text)
2188 (setq ido-rotate-temp t)
2189 (exit-minibuffer))
2191 (defun ido-wide-find-file (&optional file)
2192 "Prompt for FILE to search for using find, starting from current directory."
2193 (interactive)
2194 (unless file
2195 (setq file (read-string (concat "Wide find file: " ido-current-directory) ido-text)))
2196 (when (> (length file) 0)
2197 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2198 (setq ido-exit 'refresh)
2199 (setq ido-text-init file)
2200 (setq ido-rotate-temp t)
2201 (exit-minibuffer)))
2203 (defun ido-wide-find-dir (&optional dir)
2204 "Prompt for DIR to search for using find, starting from current directory."
2205 (interactive)
2206 (unless dir
2207 (setq dir (read-string (concat "Wide find directory: " ido-current-directory) ido-text)))
2208 (when (> (length dir) 0)
2209 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2210 (setq ido-exit 'refresh)
2211 (setq ido-text-init (ido-final-slash dir t))
2212 (setq ido-rotate-temp t)
2213 (exit-minibuffer)))
2215 (defun ido-make-directory (&optional dir)
2216 "Prompt for DIR to create in current directory."
2217 (interactive)
2218 (unless dir
2219 (setq dir (read-string (concat "Make directory: " ido-current-directory) ido-text)))
2220 (when (> (length dir) 0)
2221 (setq dir (concat ido-current-directory dir))
2222 (unless (file-exists-p dir)
2223 (make-directory dir t)
2224 (ido-set-current-directory dir)
2225 (setq ido-exit 'refresh)
2226 (setq ido-text-init nil)
2227 (setq ido-rotate-temp t)
2228 (exit-minibuffer))))
2230 (defun ido-get-work-file (incr)
2231 (let ((n (length ido-work-file-list))
2232 (i (+ ido-work-file-index incr))
2233 name)
2234 (if (> incr 0)
2235 (if (>= i n) (setq i 0))
2236 (if (< i 0) (setq i (1- n))))
2237 (setq name (nth i ido-work-file-list))
2238 (setq ido-work-file-index i)
2239 name))
2241 (defun ido-prev-work-file ()
2242 "Change to next working file name in list."
2243 (interactive)
2244 (let ((name (ido-get-work-file 1)))
2245 (when name
2246 (setq ido-text-init name)
2247 (setq ido-exit 'refresh)
2248 (exit-minibuffer))))
2250 (defun ido-next-work-file ()
2251 "Change to previous working file name in list."
2252 (interactive)
2253 (let ((name (ido-get-work-file -1)))
2254 (when name
2255 (setq ido-text-init name)
2256 (setq ido-exit 'refresh)
2257 (exit-minibuffer))))
2259 (defun ido-copy-current-file-name (all)
2260 "Insert file name of current buffer.
2261 If repeated, insert text from buffer instead."
2262 (interactive "P")
2263 (let* ((path (buffer-file-name ido-entry-buffer))
2264 (name (and path (file-name-nondirectory path))))
2265 (when name
2266 (setq ido-text-init
2267 (if (or all
2268 (not (equal (file-name-directory path) ido-current-directory))
2269 (not (string-match "\\.[^.]*\\'" name)))
2270 name
2271 (substring name 0 (1+ (match-beginning 0)))))
2272 (setq ido-exit 'refresh
2273 ido-try-merged-list nil)
2274 (exit-minibuffer))))
2276 (defun ido-copy-current-word (all)
2277 "Insert current word (file name or path) from current buffer."
2278 (interactive "P")
2279 (let ((word (save-excursion
2280 (set-buffer ido-entry-buffer)
2281 (let ((p (point)) start-line end-line start-name name)
2282 (beginning-of-line)
2283 (setq start-line (point))
2284 (end-of-line)
2285 (setq end-line (point))
2286 (goto-char p)
2287 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
2288 (forward-char 1))
2289 (setq start-name (point))
2290 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
2291 (if (= start-name (point))
2293 (buffer-substring-no-properties start-name (point)))))))
2294 (if (cond
2295 ((not word) nil)
2296 ((string-match "\\`[~/]" word)
2297 (setq ido-text-init word
2298 ido-try-merged-list nil
2299 ido-exit 'chdir))
2300 ((string-match "/" word)
2301 (setq ido-text-init (concat ido-current-directory word)
2302 ido-try-merged-list nil
2303 ido-exit 'chdir))
2305 (setq ido-text-init word
2306 ido-try-merged-list nil
2307 ido-exit 'refresh)))
2308 (exit-minibuffer))))
2310 (defun ido-next-match ()
2311 "Put first element of `ido-matches' at the end of the list."
2312 (interactive)
2313 (if ido-matches
2314 (let ((next (cadr ido-matches)))
2315 (setq ido-cur-list (ido-chop ido-cur-list next))
2316 (setq ido-rescan t)
2317 (setq ido-rotate t))))
2319 (defun ido-prev-match ()
2320 "Put last element of `ido-matches' at the front of the list."
2321 (interactive)
2322 (if ido-matches
2323 (let ((prev (car (last ido-matches))))
2324 (setq ido-cur-list (ido-chop ido-cur-list prev))
2325 (setq ido-rescan t)
2326 (setq ido-rotate t))))
2328 (defun ido-next-match-dir ()
2329 "Find next directory in match list.
2330 If work directories have been merged, cycle through directories for
2331 first matching file."
2332 (interactive)
2333 (if ido-use-merged-list
2334 (if ido-matches
2335 (let* ((elt (car ido-matches))
2336 (dirs (cdr elt)))
2337 (when (> (length dirs) 1)
2338 (setcdr elt (ido-chop dirs (cadr dirs))))
2339 (setq ido-rescan nil)))
2340 (let ((cnt (length ido-matches))
2341 (i 1))
2342 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
2343 (setq i (1+ i)))
2344 (if (< i cnt)
2345 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2347 (defun ido-prev-match-dir ()
2348 "Find previous directory in match list.
2349 If work directories have been merged, cycle through directories
2350 for first matching file."
2351 (interactive)
2352 (if ido-use-merged-list
2353 (if ido-matches
2354 (let* ((elt (car ido-matches))
2355 (dirs (cdr elt)))
2356 (when (> (length dirs) 1)
2357 (setcdr elt (ido-chop dirs (car (last dirs)))))
2358 (setq ido-rescan nil)))
2359 (let* ((cnt (length ido-matches))
2360 (i (1- cnt)))
2361 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
2362 (setq i (1- i)))
2363 (if (> i 0)
2364 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2366 (defun ido-restrict-to-matches ()
2367 "Set current item list to the currently matched items."
2368 (interactive)
2369 (when ido-matches
2370 (setq ido-cur-list ido-matches
2371 ido-text-init ""
2372 ido-rescan nil
2373 ido-exit 'keep)
2374 (exit-minibuffer)))
2376 (defun ido-chop (items elem)
2377 "Remove all elements before ELEM and put them at the end of ITEMS."
2378 (let ((ret nil)
2379 (next nil)
2380 (sofar nil))
2381 (while (not ret)
2382 (setq next (car items))
2383 (if (equal next elem)
2384 (setq ret (append items (nreverse sofar)))
2385 ;; else
2386 (progn
2387 (setq items (cdr items))
2388 (setq sofar (cons next sofar)))))
2389 ret))
2391 (defun ido-name (item)
2392 ;; Return file name for current item, whether in a normal list
2393 ;; or a merged work directory list.
2394 (if (consp item) (car item) item))
2397 ;;; CREATE LIST OF ALL CURRENT FILES
2399 (defun ido-all-completions ()
2400 ;; Return unsorted list of all competions.
2401 (let ((ido-process-ignore-lists nil))
2402 (cond
2403 ((eq ido-cur-item 'file)
2404 (ido-make-file-list1 ido-current-directory))
2405 ((eq ido-cur-item 'dir)
2406 (ido-make-dir-list1 ido-current-directory))
2407 ((eq ido-cur-item 'buffer)
2408 (ido-make-buffer-list1))
2409 (t nil))))
2412 (defun ido-sort-list (items)
2413 ;; Simple list of file or buffer names
2414 (sort items (lambda (a b) (string-lessp a b))))
2416 (defun ido-sort-merged-list (items promote)
2417 ;; Input is list of ("file" . "dir") cons cells.
2418 ;; Output is sorted list of ("file "dir" ...) lists
2419 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
2420 res a cur dirs)
2421 (while l
2422 (setq a (car l)
2423 l (cdr l))
2424 (if (and res (string-equal (car (car res)) (car a)))
2425 (progn
2426 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
2427 (if (and promote (string-equal ido-current-directory (cdr a)))
2428 (setq cur t)))
2429 (setq res (cons (list (car a) (cdr a)) res)
2430 cur nil)))
2431 res))
2433 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
2434 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
2435 (let ((paths
2436 (split-string
2437 (shell-command-to-string
2438 (concat "find " dir " -name \"" (if prefix "" "*") file "*\" -type " (if finddir "d" "f") " -print"))))
2439 path d f
2440 res)
2441 (while paths
2442 (setq path (car paths)
2443 paths (cdr paths)
2444 paths (cdr paths))
2445 (if (and (string-match "^/" path)
2446 (file-exists-p path))
2447 (setq d (file-name-directory path)
2448 f (file-name-nondirectory path)
2449 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
2450 res))
2452 (defun ido-flatten-merged-list (items)
2453 ;; Create a list of path names based on a merged directory list.
2454 (let (res)
2455 (while items
2456 (let* ((item (car items))
2457 (file (car item))
2458 (dirs (cdr item)))
2459 (while dirs
2460 (setq res (cons (concat (car dirs) file) res)
2461 dirs (cdr dirs))))
2462 (setq items (cdr items)))
2463 res))
2465 (defun ido-make-merged-file-list (text auto wide)
2466 (let (res)
2467 (message "Searching for `%s'...." text)
2468 (if (and (ido-final-slash text) ido-dir-file-cache)
2469 (if wide
2470 (setq res (ido-wide-find-dirs-or-files
2471 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
2472 ;; Use list of cached directories
2473 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
2474 (dirs ido-dir-file-cache)
2475 dir b d f)
2476 (if nil ;; simple
2477 (while dirs
2478 (setq dir (car (car dirs))
2479 dirs (cdr dirs))
2480 (when (and (string-match re dir)
2481 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
2482 (file-directory-p dir))
2483 (setq b (substring dir 0 -1)
2484 f (concat (file-name-nondirectory b) "/")
2485 d (file-name-directory b)
2486 res (cons (cons f d) res))))
2487 (while dirs
2488 (setq dir (car dirs)
2489 d (car dir)
2490 dirs (cdr dirs))
2491 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
2492 (setq dir (cdr (cdr dir)))
2493 (while dir
2494 (setq f (car dir)
2495 dir (cdr dir))
2496 (if (and (string-match re f)
2497 (not (ido-ignore-item-p f ido-ignore-directories)))
2498 (setq res (cons (cons f d) res)))))
2499 (if (and auto (input-pending-p))
2500 (setq dirs nil
2501 res t))))))
2502 (if wide
2503 (setq res (ido-wide-find-dirs-or-files
2504 ido-current-directory text ido-enable-prefix nil))
2505 (let ((ido-text text)
2506 (dirs ido-work-directory-list)
2507 (must-match (and text (> (length text) 0)))
2508 dir fl)
2509 (if (and auto (not (member ido-current-directory dirs)))
2510 (setq dirs (cons ido-current-directory dirs)))
2511 (while dirs
2512 (setq dir (car dirs)
2513 dirs (cdr dirs))
2514 (when (and dir (stringp dir)
2515 (or ido-merge-ftp-work-directories
2516 (not (ido-is-ftp-directory dir)))
2517 (file-directory-p dir)
2518 (setq fl (if (eq ido-cur-item 'file)
2519 (ido-make-file-list1 dir t)
2520 (ido-make-dir-list1 dir t))))
2521 (if must-match
2522 (setq fl (ido-set-matches1 fl)))
2523 (if fl
2524 (setq res (nconc fl res))))
2525 (if (and auto (input-pending-p))
2526 (setq dirs nil
2527 res t))))))
2528 (if (and res (not (eq res t)))
2529 (setq res (ido-sort-merged-list res auto)))
2530 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
2531 (listp res)
2532 (> (length text) 0))
2533 (let ((elt (assoc text res)))
2534 (when (and elt (not (eq elt (car res))))
2535 (setq res (delq elt res))
2536 (setq res (cons elt res)))))
2537 (message nil)
2538 res))
2540 (defun ido-make-buffer-list1 (&optional frame visible)
2541 ;; Return list of non-ignored buffer names
2542 (delq nil
2543 (mapcar
2544 (lambda (x)
2545 (let ((name (buffer-name x)))
2546 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
2547 name)))
2548 (buffer-list frame))))
2550 (defun ido-make-buffer-list (default)
2551 ;; Return the current list of buffers.
2552 ;; Currently visible buffers are put at the end of the list.
2553 ;; The hook `ido-make-buflist-hook' is run after the list has been
2554 ;; created to allow the user to further modify the order of the buffer names
2555 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
2556 ;; it is put to the start of the list.
2557 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
2558 (ido-temp-list (ido-make-buffer-list1 (selected-frame) ido-current-buffers)))
2559 (if ido-temp-list
2560 (nconc ido-temp-list ido-current-buffers)
2561 (setq ido-temp-list ido-current-buffers))
2562 (if default
2563 (progn
2564 (setq ido-temp-list
2565 (delete default ido-temp-list))
2566 (setq ido-temp-list
2567 (cons default ido-temp-list))))
2568 (run-hooks 'ido-make-buffer-list-hook)
2569 ido-temp-list))
2571 (defun ido-to-end (items)
2572 ;; Move the elements from ITEMS to the end of `ido-temp-list'
2573 (mapcar
2574 (lambda (elem)
2575 (setq ido-temp-list (delq elem ido-temp-list)))
2576 items)
2577 (if ido-temp-list
2578 (nconc ido-temp-list items)
2579 (setq ido-temp-list items)))
2581 (defun ido-file-name-all-completions (dir)
2582 ;; Return name of all files in DIR
2583 ;; Uses and updates ido-dir-file-cache
2584 (if (and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
2585 (stringp dir) (> (length dir) 0)
2586 (ido-may-cache-directory dir))
2587 (let* ((cached (assoc dir ido-dir-file-cache))
2588 (ctime (nth 1 cached))
2589 (ftp (ido-is-ftp-directory dir))
2590 (attr (if ftp nil (file-attributes dir)))
2591 (mtime (nth 5 attr))
2592 valid)
2593 (when cached ; should we use the cached entry ?
2594 (if ftp
2595 (setq valid (and (eq (car ctime) 'ftp)
2596 (ido-cache-ftp-valid (cdr ctime))))
2597 (if attr
2598 (setq valid (and (= (car ctime) (car mtime))
2599 (= (car (cdr ctime)) (car (cdr mtime)))))))
2600 (if (not valid)
2601 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
2602 cached nil)))
2603 (unless cached
2604 (if (and ftp (file-readable-p dir))
2605 (setq mtime (cons 'ftp (ido-time-stamp))))
2606 (if mtime
2607 (setq cached (cons dir (cons mtime (file-name-all-completions "" dir)))
2608 ido-dir-file-cache (cons cached ido-dir-file-cache)))
2609 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
2610 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
2611 (and cached
2612 (cdr (cdr cached))))
2613 (file-name-all-completions "" dir)))
2615 (defun ido-remove-cached-dir (dir)
2616 ;; Remove dir from ido-dir-file-cache
2617 (if (and ido-dir-file-cache
2618 (stringp dir) (> (length dir) 0))
2619 (let ((cached (assoc dir ido-dir-file-cache)))
2620 (if cached
2621 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
2624 (defun ido-make-file-list1 (dir &optional merged)
2625 ;; Return list of non-ignored files in DIR
2626 ;; If MERGED is non-nil, each file is cons'ed with DIR
2627 (and (file-directory-p dir)
2628 (delq nil
2629 (mapcar
2630 (lambda (name)
2631 (if (not (ido-ignore-item-p name ido-ignore-files t))
2632 (if merged (cons name dir) name)))
2633 (ido-file-name-all-completions dir)))))
2635 (defun ido-make-file-list (default)
2636 ;; Return the current list of files.
2637 ;; Currently visible files are put at the end of the list.
2638 ;; The hook `ido-make-file-list-hook' is run after the list has been
2639 ;; created to allow the user to further modify the order of the file names
2640 ;; in this list.
2641 (let ((ido-temp-list (ido-make-file-list1 ido-current-directory)))
2642 (setq ido-temp-list (ido-sort-list ido-temp-list))
2643 (let ((default-directory ido-current-directory))
2644 (ido-to-end ;; move ftp hosts and visited files to end
2645 (delq nil (mapcar
2646 (lambda (x) (if (or (string-match "..:\\'" x) (get-file-buffer x)) x))
2647 ido-temp-list))))
2648 (ido-to-end ;; move . files to end
2649 (delq nil (mapcar
2650 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2651 ido-temp-list)))
2652 (if (and default (member default ido-temp-list))
2653 (if (or ido-rotate-temp ido-rotate-file-list-default)
2654 (unless (equal default (car ido-temp-list))
2655 (let ((l ido-temp-list) k)
2656 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2657 (setq l (cdr l)))
2658 (setq k (cdr l))
2659 (setcdr l nil)
2660 (nconc k ido-temp-list)
2661 (setq ido-temp-list k)))
2662 (setq ido-temp-list
2663 (delete default ido-temp-list))
2664 (setq ido-temp-list
2665 (cons default ido-temp-list))))
2666 (when ido-show-dot-for-dired
2667 (setq ido-temp-list (delete "." ido-temp-list))
2668 (setq ido-temp-list (cons "." ido-temp-list)))
2669 (run-hooks 'ido-make-file-list-hook)
2670 ido-temp-list))
2672 (defun ido-make-dir-list1 (dir &optional merged)
2673 ;; Return list of non-ignored subdirs in DIR
2674 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
2675 (and (file-directory-p dir)
2676 (delq nil
2677 (mapcar
2678 (lambda (name)
2679 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
2680 (if merged (cons name dir) name)))
2681 (ido-file-name-all-completions dir)))))
2683 (defun ido-make-dir-list (default)
2684 ;; Return the current list of directories.
2685 ;; The hook `ido-make-dir-list-hook' is run after the list has been
2686 ;; created to allow the user to further modify the order of the
2687 ;; directory names in this list.
2688 (let ((ido-temp-list (ido-make-dir-list1 ido-current-directory)))
2689 (setq ido-temp-list (ido-sort-list ido-temp-list))
2690 (let ((default-directory ido-current-directory))
2691 (ido-to-end ;; move visited files to end
2692 (delq nil (mapcar
2693 (lambda (x) (if (get-file-buffer x) x))
2694 ido-temp-list))))
2695 (ido-to-end ;; move . files to end
2696 (delq nil (mapcar
2697 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2698 ido-temp-list)))
2699 (if (and default (member default ido-temp-list))
2700 (if (or ido-rotate-temp ido-rotate-file-list-default)
2701 (unless (equal default (car ido-temp-list))
2702 (let ((l ido-temp-list) k)
2703 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2704 (setq l (cdr l)))
2705 (setq k (cdr l))
2706 (setcdr l nil)
2707 (nconc k ido-temp-list)
2708 (setq ido-temp-list k)))
2709 (setq ido-temp-list
2710 (delete default ido-temp-list))
2711 (setq ido-temp-list
2712 (cons default ido-temp-list))))
2713 (setq ido-temp-list (delete "." ido-temp-list))
2714 (setq ido-temp-list (cons "." ido-temp-list))
2715 (run-hooks 'ido-make-dir-list-hook)
2716 ido-temp-list))
2718 ;; List of the files visible in the current frame.
2719 (defvar ido-bufs-in-frame)
2721 (defun ido-get-buffers-in-frames (&optional current)
2722 ;; Return the list of buffers that are visible in the current frame.
2723 ;; If optional argument `current' is given, restrict searching to the
2724 ;; current frame, rather than all frames, regardless of value of
2725 ;; `ido-all-frames'.
2726 (let ((ido-bufs-in-frame nil))
2727 (walk-windows 'ido-get-bufname nil
2728 (if current
2730 ido-all-frames))
2731 ido-bufs-in-frame))
2733 (defun ido-get-bufname (win)
2734 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
2735 (let ((buf (buffer-name (window-buffer win))))
2736 (unless (or (member buf ido-bufs-in-frame)
2737 (member buf ido-ignore-item-temp-list))
2738 ;; Only add buf if it is not already in list.
2739 ;; This prevents same buf in two different windows being
2740 ;; put into the list twice.
2741 (setq ido-bufs-in-frame
2742 (cons buf ido-bufs-in-frame)))))
2744 ;;; FIND MATCHING ITEMS
2746 (defun ido-set-matches1 (items &optional do-full)
2747 ;; Return list of matches in items
2748 (let* ((case-fold-search ido-case-fold)
2749 (rexq (if ido-enable-regexp ido-text (regexp-quote ido-text)))
2750 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
2751 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" re))
2752 (concat "\\`" re "\\'")))
2753 (prefix-re (and full-re (not ido-enable-prefix)
2754 (concat "\\`" rexq)))
2755 full-matches
2756 prefix-matches
2757 matches)
2758 (mapcar
2759 (lambda (item)
2760 (let ((name (ido-name item)))
2761 (if (string-match re name)
2762 (cond
2763 ((and full-re (string-match full-re name))
2764 (setq full-matches (cons item full-matches)))
2765 ((and prefix-re (string-match prefix-re name))
2766 (setq prefix-matches (cons item prefix-matches)))
2767 (t (setq matches (cons item matches))))))
2769 items)
2770 (if prefix-matches
2771 (setq matches (nconc prefix-matches matches)))
2772 (if full-matches
2773 (setq matches (nconc full-matches matches)))
2774 (when (and (null matches)
2775 ido-enable-flex-matching
2776 (> (length ido-text) 1)
2777 (not ido-enable-regexp))
2778 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
2779 (if ido-enable-prefix
2780 (setq re (concat "\\`" re)))
2781 (mapcar
2782 (lambda (item)
2783 (let ((name (ido-name item)))
2784 (if (string-match re name)
2785 (setq matches (cons item matches)))))
2786 items))
2787 matches))
2790 (defun ido-set-matches ()
2791 ;; Set `ido-matches' to the list of items matching prompt
2792 (when ido-rescan
2793 (setq ido-matches (ido-set-matches1 (reverse ido-cur-list) (not ido-rotate))
2794 ido-rotate nil)))
2796 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
2797 ;; Return t if the buffer or file NAME should be ignored.
2798 (or (member name ido-ignore-item-temp-list)
2799 (and
2800 ido-process-ignore-lists re-list
2801 (let ((data (match-data))
2802 (ext-list (and ignore-ext ido-ignore-extensions
2803 completion-ignored-extensions))
2804 ignorep nextstr
2805 (flen (length name)) slen)
2806 (while ext-list
2807 (setq nextstr (car ext-list))
2808 (if (cond
2809 ((stringp nextstr)
2810 (and (>= flen (setq slen (length nextstr)))
2811 (string-equal (substring name (- flen slen)) nextstr)))
2812 ((fboundp nextstr) (funcall nextstr name))
2813 (t nil))
2814 (setq ignorep t
2815 ext-list nil
2816 re-list nil)
2817 (setq ext-list (cdr ext-list))))
2818 (while re-list
2819 (setq nextstr (car re-list))
2820 (if (cond
2821 ((stringp nextstr) (string-match nextstr name))
2822 ((fboundp nextstr) (funcall nextstr name))
2823 (t nil))
2824 (setq ignorep t
2825 re-list nil)
2826 (setq re-list (cdr re-list))))
2827 ;; return the result
2828 (if ignorep
2829 (setq ido-ignored-list (cons name ido-ignored-list)))
2830 (set-match-data data)
2831 ignorep))))
2834 ;; Private variable used by `ido-word-matching-substring'.
2835 (defvar ido-change-word-sub)
2837 (defun ido-find-common-substring (items subs)
2838 ;; Return common string following SUBS in each element of ITEMS.
2839 (let (res
2840 alist
2841 ido-change-word-sub)
2842 (setq ido-change-word-sub
2843 (if ido-enable-regexp
2844 subs
2845 (regexp-quote subs)))
2846 (setq res (mapcar #'ido-word-matching-substring items))
2847 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
2848 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
2850 ;; try-completion returns t if there is an exact match.
2851 (let* ((completion-ignore-case ido-case-fold)
2852 (comp (try-completion subs alist)))
2853 (if (eq comp t)
2854 subs
2855 comp))))
2857 (defun ido-word-matching-substring (word)
2858 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
2859 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
2860 (let ((case-fold-search ido-case-fold))
2861 (let ((m (string-match ido-change-word-sub (ido-name word))))
2862 (if m
2863 (substring (ido-name word) m)
2864 ;; else no match
2865 nil))))
2867 (defun ido-makealist (res)
2868 ;; Return dotted pair (RES . 1).
2869 (cons res 1))
2871 (defun ido-choose-completion-string (choice buffer mini-p base-size)
2872 (when (ido-active)
2873 ;; Insert the completion into the buffer where completion was requested.
2874 (if (get-buffer ido-completion-buffer)
2875 (kill-buffer ido-completion-buffer))
2876 (cond
2877 ((ido-active t) ;; ido-use-merged-list
2878 (setq ido-current-directory ""
2879 ido-text choice
2880 ido-exit 'done))
2881 ((not (ido-final-slash choice))
2882 (setq ido-text choice
2883 ido-exit 'done))
2885 (ido-set-current-directory ido-current-directory choice)
2886 (setq ido-exit 'refresh)))
2887 (exit-minibuffer)
2890 (defun ido-completion-help ()
2891 "Show possible completions in a *File Completions* buffer."
2892 (interactive)
2893 (setq ido-rescan nil)
2894 (let ((temp-buf (get-buffer ido-completion-buffer))
2895 display-it full-list)
2896 (if (and (eq last-command this-command) temp-buf)
2897 ;; scroll buffer
2898 (let (win (buf (current-buffer)))
2899 (display-buffer temp-buf nil nil)
2900 (set-buffer temp-buf)
2901 (setq win (get-buffer-window temp-buf))
2902 (if (pos-visible-in-window-p (point-max) win)
2903 (if (or ido-completion-buffer-all-completions (boundp 'ido-completion-buffer-full))
2904 (set-window-start win (point-min))
2905 (set (make-local-variable 'ido-completion-buffer-full) t)
2906 (setq full-list t
2907 display-it t))
2908 (scroll-other-window))
2909 (set-buffer buf))
2910 (setq display-it t))
2911 (if display-it
2912 (with-output-to-temp-buffer ido-completion-buffer
2913 (let ((completion-list (ido-sort-list
2914 (cond
2915 (ido-use-merged-list
2916 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
2917 ((or full-list ido-completion-buffer-all-completions)
2918 (ido-all-completions))
2920 (copy-sequence (or ido-matches ido-cur-list)))))))
2921 (if ido-xemacs
2922 ;; XEmacs extents are put on by default, doesn't seem to be
2923 ;; any way of switching them off.
2924 ;; This obscure code avoids a byte compiler warning in Emacs.
2925 (let ((f 'display-completion-list))
2926 (funcall f completion-list
2927 :help-string "ido "
2928 :activate-callback
2929 '(lambda (x y z) (message "doesn't work yet, sorry!"))))
2930 ;; else running Emacs
2931 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
2932 (display-completion-list completion-list)))))))
2934 ;;; KILL CURRENT BUFFER
2935 (defun ido-kill-buffer-at-head ()
2936 "Kill the buffer at the head of `ido-matches'."
2937 (interactive)
2938 (let ((enable-recursive-minibuffers t)
2939 (buf (car ido-matches)))
2940 (when buf
2941 (kill-buffer buf)
2942 ;; Check if buffer still exists.
2943 (if (get-buffer buf)
2944 ;; buffer couldn't be killed.
2945 (setq ido-rescan t)
2946 ;; else buffer was killed so remove name from list.
2947 (setq ido-cur-list (delq buf ido-cur-list))))))
2949 ;;; DELETE CURRENT FILE
2950 (defun ido-delete-file-at-head ()
2951 "Delete the file at the head of `ido-matches'."
2952 (interactive)
2953 (let ((enable-recursive-minibuffers t)
2954 (file (car ido-matches)))
2955 (if file
2956 (setq file (concat ido-current-directory file)))
2957 (when (and file
2958 (file-exists-p file)
2959 (not (file-directory-p file))
2960 (file-writable-p ido-current-directory)
2961 (yes-or-no-p (concat "Delete " file " ")))
2962 (delete-file file)
2963 ;; Check if file still exists.
2964 (if (file-exists-p file)
2965 ;; file could not be deleted
2966 (setq ido-rescan t)
2967 ;; else file was killed so remove name from list.
2968 (setq ido-cur-list (delq (car ido-matches) ido-cur-list))))))
2971 ;;; VISIT CHOSEN BUFFER
2972 (defun ido-visit-buffer (buffer method &optional record)
2973 "Visit file named FILE according to METHOD.
2974 Record command in command-history if optional RECORD is non-nil."
2976 (let (win newframe)
2977 (cond
2978 ((eq method 'kill)
2979 (if record
2980 (ido-record-command 'kill-buffer buffer))
2981 (kill-buffer buffer))
2983 ((eq method 'samewindow)
2984 (if record
2985 (ido-record-command 'switch-to-buffer buffer))
2986 (switch-to-buffer buffer))
2988 ((memq method '(always-frame maybe-frame))
2989 (cond
2990 ((and window-system
2991 (setq win (ido-window-buffer-p buffer))
2992 (or (eq method 'always-frame)
2993 (y-or-n-p "Jump to frame? ")))
2994 (setq newframe (window-frame win))
2995 (if (fboundp 'select-frame-set-input-focus)
2996 (select-frame-set-input-focus newframe)
2997 (raise-frame newframe)
2998 (select-frame newframe)
2999 (if (not ido-xemacs)
3000 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
3001 (select-window win))
3003 ;; No buffer in other frames...
3004 (if record
3005 (ido-record-command 'switch-to-buffer buffer))
3006 (switch-to-buffer buffer)
3009 ((eq method 'otherwindow)
3010 (if record
3011 (ido-record-command 'switch-to-buffer buffer))
3012 (switch-to-buffer-other-window buffer))
3014 ((eq method 'display)
3015 (display-buffer buffer))
3017 ((eq method 'otherframe)
3018 (progn
3019 (switch-to-buffer-other-frame buffer)
3020 (if (not ido-xemacs)
3021 (if (fboundp 'select-frame-set-input-focus)
3022 (select-frame-set-input-focus (selected-frame))
3023 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
3024 )))))
3027 (defun ido-window-buffer-p (buffer)
3028 ;; Return window pointer if BUFFER is visible in another frame.
3029 ;; If BUFFER is visible in the current frame, return nil.
3030 (let ((blist (ido-get-buffers-in-frames 'current)))
3031 ;;If the buffer is visible in current frame, return nil
3032 (if (member buffer blist)
3034 ;; maybe in other frame or icon
3035 (get-buffer-window buffer 0) ; better than 'visible
3039 ;;; ----------- IDONIZED FUNCTIONS ------------
3041 ;;;###autoload
3042 (defun ido-switch-buffer ()
3043 "Switch to another buffer.
3044 The buffer is displayed according to `ido-default-buffer-method' -- the
3045 default is to show it in the same window, unless it is already visible
3046 in another frame.
3048 As you type in a string, all of the buffers matching the string are
3049 displayed if substring-matching is used \(default). Look at
3050 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
3051 buffer you want, it can then be selected. As you type, most keys have their
3052 normal keybindings, except for the following: \\<ido-mode-map>
3054 RET Select the buffer at the front of the list of matches. If the
3055 list is empty, possibly prompt to create new buffer.
3057 \\[ido-select-text] Select the current prompt as the buffer.
3058 If no buffer is found, prompt for a new one.
3060 \\[ido-next-match] Put the first element at the end of the list.
3061 \\[ido-prev-match] Put the last element at the start of the list.
3062 \\[ido-complete] Complete a common suffix to the current string that
3063 matches all buffers. If there is only one match, select that buffer.
3064 If there is no common suffix, show a list of all matching buffers
3065 in a separate window.
3066 \\[ido-edit-input] Edit input string.
3067 \\[ido-fallback-command] Fallback to non-ido version of current command.
3068 \\[ido-toggle-regexp] Toggle regexp searching.
3069 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3070 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
3071 \\[ido-completion-help] Show list of matching buffers in separate window.
3072 \\[ido-enter-find-file] Drop into ido-find-file.
3073 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
3074 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
3075 (interactive)
3076 (ido-buffer-internal ido-default-buffer-method))
3078 ;;;###autoload
3079 (defun ido-switch-buffer-other-window ()
3080 "Switch to another buffer and show it in another window.
3081 The buffer name is selected interactively by typing a substring.
3082 For details of keybindings, do `\\[describe-function] ido'."
3083 (interactive)
3084 (ido-buffer-internal 'otherwindow 'switch-to-buffer-other-window))
3086 ;;;###autoload
3087 (defun ido-display-buffer ()
3088 "Display a buffer in another window but don't select it.
3089 The buffer name is selected interactively by typing a substring.
3090 For details of keybindings, do `\\[describe-function] ido'."
3091 (interactive)
3092 (ido-buffer-internal 'display 'display-buffer))
3094 ;;;###autoload
3095 (defun ido-kill-buffer ()
3096 "Kill a buffer.
3097 The buffer name is selected interactively by typing a substring.
3098 For details of keybindings, do `\\[describe-function] ido'."
3099 (interactive)
3100 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer))))
3102 ;;;###autoload
3103 (defun ido-insert-buffer ()
3104 "Insert contents of a buffer in current buffer after point.
3105 The buffer name is selected interactively by typing a substring.
3106 For details of keybindings, do `\\[describe-function] ido'."
3107 (interactive)
3108 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: "))
3110 ;;;###autoload
3111 (defun ido-switch-buffer-other-frame ()
3112 "Switch to another buffer and show it in another frame.
3113 The buffer name is selected interactively by typing a substring.
3114 For details of keybindings, do `\\[describe-function] ido'."
3115 (interactive)
3116 (if ido-mode
3117 (ido-buffer-internal 'otherframe)
3118 (call-interactively 'switch-to-buffer-other-frame)))
3120 ;;;###autoload
3121 (defun ido-find-file-in-dir (dir)
3122 "Switch to another file starting from DIR."
3123 (interactive "DDir: ")
3124 (if (not (equal (substring dir -1) "/"))
3125 (setq dir (concat dir "/")))
3126 (ido-file-internal ido-default-file-method nil dir))
3128 ;;;###autoload
3129 (defun ido-find-file ()
3130 "Edit file with name obtained via minibuffer.
3131 The file is displayed according to `ido-default-file-method' -- the
3132 default is to show it in the same window, unless it is already
3133 visible in another frame.
3135 The file name is selected interactively by typing a substring. As you type
3136 in a string, all of the filenames matching the string are displayed if
3137 substring-matching is used \(default). Look at `ido-enable-prefix' and
3138 `ido-toggle-prefix'. When you have found the filename you want, it can
3139 then be selected. As you type, most keys have their normal keybindings,
3140 except for the following: \\<ido-mode-map>
3142 RET Select the file at the front of the list of matches. If the
3143 list is empty, possibly prompt to create new file.
3145 \\[ido-select-text] Select the current prompt as the buffer or file.
3146 If no buffer or file is found, prompt for a new one.
3148 \\[ido-next-match] Put the first element at the end of the list.
3149 \\[ido-prev-match] Put the last element at the start of the list.
3150 \\[ido-complete] Complete a common suffix to the current string that
3151 matches all files. If there is only one match, select that file.
3152 If there is no common suffix, show a list of all matching files
3153 in a separate window.
3154 \\[ido-edit-input] Edit input string (including path).
3155 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
3156 \\[ido-merge-work-directories] search for file in the work directory history.
3157 \\[ido-forget-work-directory] removes current directory from the work directory history.
3158 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
3159 \\[ido-wide-find-file] and \\[ido-wide-find-dir] prompts and uses find to locate files or directories.
3160 \\[ido-make-directory] prompts for a directory to create in current directory.
3161 \\[ido-fallback-command] Fallback to non-ido version of current command.
3162 \\[ido-toggle-regexp] Toggle regexp searching.
3163 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3164 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
3165 \\[ido-toggle-vc] Toggle version control for this file.
3166 \\[ido-toggle-literal] Toggle literal reading of this file.
3167 \\[ido-completion-help] Show list of matching files in separate window.
3168 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
3170 (interactive)
3171 (ido-file-internal ido-default-file-method))
3173 ;;;###autoload
3174 (defun ido-find-file-other-window ()
3175 "Switch to another file and show it in another window.
3176 The file name is selected interactively by typing a substring.
3177 For details of keybindings, do `\\[describe-function] ido-find-file'."
3178 (interactive)
3179 (ido-file-internal 'otherwindow 'find-file-other-window))
3181 ;;;###autoload
3182 (defun ido-find-alternate-file ()
3183 "Switch to another file and show it in another window.
3184 The file name is selected interactively by typing a substring.
3185 For details of keybindings, do `\\[describe-function] ido-find-file'."
3186 (interactive)
3187 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
3189 ;;;###autoload
3190 (defun ido-find-file-read-only ()
3191 "Edit file read-only with name obtained via minibuffer.
3192 The file name is selected interactively by typing a substring.
3193 For details of keybindings, do `\\[describe-function] ido-find-file'."
3194 (interactive)
3195 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
3197 ;;;###autoload
3198 (defun ido-find-file-read-only-other-window ()
3199 "Edit file read-only in other window with name obtained via minibuffer.
3200 The file name is selected interactively by typing a substring.
3201 For details of keybindings, do `\\[describe-function] ido-find-file'."
3202 (interactive)
3203 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
3205 ;;;###autoload
3206 (defun ido-find-file-read-only-other-frame ()
3207 "Edit file read-only in other frame with name obtained via minibuffer.
3208 The file name is selected interactively by typing a substring.
3209 For details of keybindings, do `\\[describe-function] ido-find-file'."
3210 (interactive)
3211 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
3213 ;;;###autoload
3214 (defun ido-display-file ()
3215 "Display a file in another window but don't select it.
3216 The file name is selected interactively by typing a substring.
3217 For details of keybindings, do `\\[describe-function] ido-find-file'."
3218 (interactive)
3219 (ido-file-internal 'display))
3221 ;;;###autoload
3222 (defun ido-find-file-other-frame ()
3223 "Switch to another file and show it in another frame.
3224 The file name is selected interactively by typing a substring.
3225 For details of keybindings, do `\\[describe-function] ido-find-file'."
3226 (interactive)
3227 (ido-file-internal 'otherframe 'find-file-other-frame))
3229 ;;;###autoload
3230 (defun ido-write-file ()
3231 "Write current buffer to a file.
3232 The file name is selected interactively by typing a substring.
3233 For details of keybindings, do `\\[describe-function] ido-find-file'."
3234 (interactive)
3235 (let ((ido-process-ignore-lists t)
3236 (ido-work-directory-match-only nil)
3237 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
3238 (ido-report-no-match nil)
3239 (ido-auto-merge-work-directories-length -1))
3240 (ido-file-internal 'write 'write-file nil "Write file: ")))
3242 ;;;###autoload
3243 (defun ido-insert-file ()
3244 "Insert contents of file in current buffer.
3245 The file name is selected interactively by typing a substring.
3246 For details of keybindings, do `\\[describe-function] ido-find-file'."
3247 (interactive)
3248 (ido-file-internal 'insert 'insert-file nil "Insert file: "))
3250 ;;;###autoload
3251 (defun ido-dired ()
3252 "Call dired the ido way.
3253 The directory is selected interactively by typing a substring.
3254 For details of keybindings, do `\\[describe-function] ido-find-file'."
3255 (interactive)
3256 (let ((ido-report-no-match nil)
3257 (ido-auto-merge-work-directories-length -1))
3258 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
3260 (defun ido-list-directory ()
3261 "Call list-directory the ido way.
3262 The directory is selected interactively by typing a substring.
3263 For details of keybindings, do `\\[describe-function] ido-find-file'."
3264 (interactive)
3265 (let ((ido-report-no-match nil)
3266 (ido-auto-merge-work-directories-length -1))
3267 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
3269 ;;; XEmacs hack for showing default buffer
3271 ;; The first time we enter the minibuffer, Emacs puts up the default
3272 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
3273 ;; subtle difference in the two versions of post-command-hook. The
3274 ;; default is shown for both whenever we delete all of our text
3275 ;; though, indicating its just a problem the first time we enter the
3276 ;; function. To solve this, we use another entry hook for emacs to
3277 ;; show the default the first time we enter the minibuffer.
3280 ;;; ICOMPLETE TYPE CODE
3282 (defun ido-initiate-auto-merge (buffer)
3283 (ido-trace "\n*merge timeout*" buffer)
3284 (setq ido-auto-merge-timer nil)
3285 (when (and (buffer-live-p buffer)
3286 (= ido-use-mycompletion-depth (minibuffer-depth))
3287 (boundp 'ido-eoinput) ido-eoinput)
3288 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
3289 (ido-trace "request merge")
3290 (setq ido-use-merged-list 'auto
3291 ido-text-init contents
3292 ido-rotate-temp t
3293 ido-exit 'refresh)
3294 (save-excursion
3295 (set-buffer buffer)
3296 (ido-tidy))
3297 (throw 'ido contents))))
3299 (defun ido-exhibit ()
3300 "Post command hook for `ido'."
3301 ;; Find matching files and display a list in the minibuffer.
3302 ;; Copied from `icomplete-exhibit' with two changes:
3303 ;; 1. It prints a default file name when there is no text yet entered.
3304 ;; 2. It calls my completion routine rather than the standard completion.
3306 (if (= ido-use-mycompletion-depth (minibuffer-depth))
3307 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
3308 (buffer-undo-list t)
3309 try-single-dir-match)
3311 (ido-trace "\nexhibit" this-command)
3312 (ido-trace "dir" ido-current-directory)
3313 (ido-trace "contents" contents)
3314 (ido-trace "list" ido-cur-list)
3315 (ido-trace "matches" ido-matches)
3316 (ido-trace "rescan" ido-rescan)
3318 (save-excursion
3319 (goto-char (point-max))
3320 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
3321 (if (not (boundp 'ido-eoinput))
3322 ;; In case it got wiped out by major mode business:
3323 (make-local-variable 'ido-eoinput))
3324 (setq ido-eoinput (point))
3326 ;; Handle explicit directory changes
3327 (and
3328 (memq ido-cur-item '(file dir))
3329 (> (length contents) 1)
3330 (cond
3331 ((ido-final-slash contents) ;; xxx/
3332 (ido-trace "final slash" contents)
3333 (cond
3334 ((string-equal contents "~/")
3335 (ido-set-current-home)
3337 ((string-equal contents "../")
3338 (ido-up-directory t)
3340 ((string-equal contents "./")
3342 ((string-match contents "\\`~[a-zA-Z0-9]/\\'")
3343 (ido-set-current-home contents)
3345 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
3346 (let ((exp (condition-case ()
3347 (expand-file-name
3348 (substitute-in-file-name (substring contents 0 -1))
3349 ido-current-directory)
3350 (error nil))))
3351 (ido-trace contents exp)
3352 (if (and exp (file-directory-p exp))
3353 (progn
3354 (ido-set-current-directory (file-name-directory exp))
3355 (setq ido-text-init (file-name-nondirectory exp))
3357 nil)))
3358 ((and (memq system-type '(windows-nt ms-dos))
3359 (string-equal (substring contents 1) ":/"))
3360 (ido-set-current-directory (file-name-directory contents))
3362 ((string-equal (substring contents -2 -1) "/")
3363 (ido-set-current-directory
3364 (if (memq system-type '(windows-nt ms-dos))
3365 (expand-file-name "/" ido-current-directory)
3366 "/"))
3369 (setq try-single-dir-match t)
3370 nil)))
3372 ((and (string-equal ido-current-directory "/")
3373 (string-match "..:\\'" contents)) ;; Ange-ftp
3374 (ido-set-current-directory "/" contents)
3375 (when (ido-is-slow-ftp-host)
3376 (setq ido-exit 'fallback)
3377 (exit-minibuffer))
3380 ((and (string-equal (substring contents -2 -1) "/")
3381 (not (string-match "[$]" contents)))
3382 (ido-set-current-directory
3383 (cond
3384 ((= (length contents) 2)
3385 "/")
3386 (ido-matches
3387 (concat ido-current-directory (car ido-matches)))
3389 (concat ido-current-directory (substring contents 0 -1)))))
3390 (setq ido-text-init (substring contents -1))
3393 ((and (not ido-use-merged-list)
3394 (not (ido-final-slash contents))
3395 (eq ido-try-merged-list t)
3396 (numberp ido-auto-merge-work-directories-length)
3397 (> ido-auto-merge-work-directories-length 0)
3398 (= (length contents) ido-auto-merge-work-directories-length)
3399 (not (and ido-auto-merge-inhibit-characters-regexp
3400 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3401 (not (input-pending-p)))
3402 (setq ido-use-merged-list 'auto
3403 ido-text-init contents
3404 ido-rotate-temp t)
3406 (progn
3407 (ido-trace "refresh on /" ido-text-init)
3408 (setq ido-exit 'refresh)
3409 (exit-minibuffer)))
3411 ;; Update the list of matches
3412 (setq ido-text contents)
3413 (ido-set-matches)
3414 (ido-trace "new " ido-matches)
3416 (when (and ido-enter-single-matching-directory
3417 ido-matches
3418 (null (cdr ido-matches))
3419 (ido-final-slash (car ido-matches))
3420 (or try-single-dir-match
3421 (eq ido-enter-single-matching-directory t)))
3422 (ido-trace "single match" (car ido-matches))
3423 (ido-set-current-directory
3424 (concat ido-current-directory (car ido-matches)))
3425 (setq ido-exit 'refresh)
3426 (exit-minibuffer))
3428 (when (and (not ido-matches)
3429 ; ido-rescan
3430 ido-process-ignore-lists
3431 ido-ignored-list)
3432 (let ((ido-process-ignore-lists nil)
3433 (ido-rotate ido-rotate)
3434 (ido-cur-list ido-ignored-list))
3435 (ido-trace "try all" ido-ignored-list)
3436 (ido-set-matches))
3437 (when ido-matches
3438 (ido-trace "found " ido-matches)
3439 (setq ido-rescan t)
3440 (setq ido-process-ignore-lists-inhibit t)
3441 (setq ido-text-init ido-text)
3442 (setq ido-exit 'refresh)
3443 (exit-minibuffer)))
3445 (when (and
3446 ido-rescan
3447 (not ido-matches)
3448 (memq ido-cur-item '(file dir))
3449 (not (ido-is-root-directory))
3450 (> (length contents) 1)
3451 (not (string-match "[$]" contents)))
3452 (ido-trace "merge?")
3453 (if ido-use-merged-list
3454 (ido-undo-merge-work-directory contents nil)
3455 (when (and (eq ido-try-merged-list t)
3456 (numberp ido-auto-merge-work-directories-length)
3457 (= ido-auto-merge-work-directories-length 0)
3458 (not (and ido-auto-merge-inhibit-characters-regexp
3459 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3460 (not (input-pending-p)))
3461 (ido-trace "\n*start timer*")
3462 (setq ido-auto-merge-timer
3463 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
3465 (setq ido-rescan t)
3467 (if (and ido-use-merged-list
3468 ido-matches
3469 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
3470 (progn
3471 (ido-set-current-directory (car (cdr (car ido-matches))))
3472 (setq ido-use-merged-list t
3473 ido-exit 'keep
3474 ido-text-init ido-text)
3475 (exit-minibuffer)))
3477 ;; Insert the match-status information:
3478 (ido-set-common-completion)
3479 (let ((inf (ido-completions
3480 contents
3481 minibuffer-completion-table
3482 minibuffer-completion-predicate
3483 (not minibuffer-completion-confirm))))
3484 (ido-trace "inf" inf)
3485 (insert inf))
3487 ))))
3489 (defun ido-completions (name candidates predicate require-match)
3490 ;; Return the string that is displayed after the user's text.
3491 ;; Modified from `icomplete-completions'.
3493 (let* ((comps ido-matches)
3494 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
3495 ido-merged-indicator))
3496 first)
3498 (if (and ind ido-use-faces)
3499 (put-text-property 0 1 'face 'ido-indicator-face ind))
3501 (if (and ido-use-faces comps)
3502 (let* ((fn (ido-name (car comps)))
3503 (ln (length fn)))
3504 (setq first (format "%s" fn))
3505 (put-text-property 0 ln 'face
3506 (if (= (length comps) 1)
3507 'ido-only-match-face
3508 'ido-first-match-face)
3509 first)
3510 (if ind (setq first (concat first ind)))
3511 (setq comps (cons first (cdr comps)))))
3513 (cond ((null comps)
3514 (if ido-report-no-match
3515 (nth 6 ido-decorations) ;; [No Match]
3516 ""))
3518 ((null (cdr comps)) ;one match
3519 (concat (if (> (length (ido-name (car comps))) (length name))
3520 ;; when there is one match, show the matching file name in full
3521 (concat (nth 4 ido-decorations) ;; [ ... ]
3522 (ido-name (car comps))
3523 (nth 5 ido-decorations))
3525 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
3526 (t ;multiple matches
3527 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
3528 (alternatives
3529 (apply
3530 #'concat
3531 (cdr (apply
3532 #'nconc
3533 (mapcar
3534 (lambda (com)
3535 (setq com (ido-name com))
3536 (setq items (1- items))
3537 (cond
3538 ((< items 0) ())
3539 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
3541 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
3542 (let ((str (substring com 0)))
3543 (if (and ido-use-faces
3544 (not (string= str first))
3545 (ido-final-slash str))
3546 (put-text-property 0 (length str) 'face 'ido-subdir-face str))
3547 str)))))
3548 comps))))))
3550 (concat
3551 ;; put in common completion item -- what you get by pressing tab
3552 (if (and (stringp ido-common-match-string)
3553 (> (length ido-common-match-string) (length name)))
3554 (concat (nth 4 ido-decorations) ;; [ ... ]
3555 (substring ido-common-match-string (length name))
3556 (nth 5 ido-decorations)))
3557 ;; list all alternatives
3558 (nth 0 ido-decorations) ;; { ... }
3559 alternatives
3560 (nth 1 ido-decorations)))))))
3562 (defun ido-minibuffer-setup ()
3563 "Minibuffer setup hook for `ido'."
3564 ;; Copied from `icomplete-minibuffer-setup-hook'.
3565 (when (and (boundp 'ido-completing-read)
3566 (or ido-xemacs (= ido-use-mycompletion-depth (minibuffer-depth))))
3567 (add-hook 'pre-command-hook 'ido-tidy nil t)
3568 (add-hook 'post-command-hook 'ido-exhibit nil t)
3569 (setq cua-inhibit-cua-keys t)
3570 (when ido-xemacs
3571 (ido-exhibit)
3572 (goto-char (point-min)))
3573 (run-hooks 'ido-minibuffer-setup-hook)))
3575 (defun ido-tidy ()
3576 "Pre command hook for `ido'."
3577 ;; Remove completions display, if any, prior to new user input.
3578 ;; Copied from `icomplete-tidy'."
3580 (when ido-auto-merge-timer
3581 (ido-trace "\n*cancel timer*" this-command)
3582 (cancel-timer ido-auto-merge-timer)
3583 (setq ido-auto-merge-timer nil))
3585 (if (and (boundp 'ido-use-mycompletion-depth)
3586 (= ido-use-mycompletion-depth (minibuffer-depth)))
3587 (if (and (boundp 'ido-eoinput)
3588 ido-eoinput)
3590 (if (> ido-eoinput (point-max))
3591 ;; Oops, got rug pulled out from under us - reinit:
3592 (setq ido-eoinput (point-max))
3593 (let ((buffer-undo-list t))
3594 (delete-region ido-eoinput (point-max))))
3596 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
3597 (make-local-variable 'ido-eoinput)
3598 (setq ido-eoinput 1))))
3600 (defun ido-summary-buffers-to-end ()
3601 ;; Move the summaries to the end of the buffer list.
3602 ;; This is an example function which can be hooked on to
3603 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
3604 ;; `Summary' or `output\*$'are put to the end of the list.
3605 (let ((summaries (delq nil (mapcar
3606 (lambda (x)
3607 (if (or
3608 (string-match "Summary" x)
3609 (string-match "output\\*\\'" x))
3611 ido-temp-list))))
3612 (ido-to-end summaries)))
3614 ;;; Helper functions for other programs
3616 ;;;###autoload
3617 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
3618 "Read file name, prompting with PROMPT and completing in directory DIR.
3619 See `read-file-name' for additional parameters."
3620 (message "%S %S %S %S" this-command ido-read-file-name-non-ido
3621 predicate (memq this-command ido-read-file-name-non-ido))
3622 (cond
3623 ((or (eq predicate 'file-directory-p)
3624 (memq this-command ido-read-file-name-as-directory-commands))
3625 (ido-read-directory-name prompt dir default-filename mustmatch initial))
3626 ((and (not (memq this-command ido-read-file-name-non-ido))
3627 (or (null predicate) (eq predicate 'file-exists-p)))
3628 (message "gotit")
3629 (let (filename
3630 ido-saved-vc-mt
3631 (vc-master-templates (and (boundp 'vc-master-templates) vc-master-templates))
3632 (ido-current-directory (expand-file-name (or dir default-directory)))
3633 (ido-work-directory-index -1)
3634 (ido-work-file-index -1)
3635 (ido-find-literal nil))
3636 (setq filename
3637 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
3638 (if filename
3639 (concat ido-current-directory filename))))
3641 (let ((read-file-name-function nil))
3642 (read-file-name prompt dir default-filename mustmatch initial predicate)))))
3644 ;;;###autoload
3645 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
3646 "Read directory name, prompting with PROMPT and completing in directory DIR.
3647 See `read-file-name' for additional parameters."
3648 (let (filename
3649 ido-saved-vc-mt
3650 (ido-current-directory (expand-file-name (or dir default-directory)))
3651 (ido-work-directory-index -1)
3652 (ido-work-file-index -1))
3653 (setq filename
3654 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
3655 (if filename
3656 (if (and (stringp filename) (string-equal filename "."))
3657 ido-current-directory
3658 (concat ido-current-directory filename)))))
3660 ;;; ido.el ends here