(stop_other_atimers): Fix loop to correctly compute `prev'.
[emacs.git] / lisp / ido.el
bloba6bd99cdeea25fd9a1baf0172fc5236639a8f27c
1 ;;; ido.el --- interactively do things with buffers and files.
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Kim F. Storm <storm@cua.dk>
7 ;; Based on: iswitchb by Stephen Eglen <stephen@cns.ed.ac.uk>
8 ;; Keywords: extensions convenience
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Acknowledgements
29 ;; Infinite amounts of gratitude goes to Stephen Eglen <stephen@cns.ed.ac.uk>
30 ;; who wrote iswitch-buffer mode - from which I ripped off 99% of the code
31 ;; for ido-switch-buffer and found the inspiration for ido-find-file.
32 ;; The ido package would never have existed without his work.
34 ;; Also thanks to Klaus Berndl, Rohit Namjoshi, Robert Fenk, Alex
35 ;; Schroeder, Bill Benedetto, Stephen Eglen, and many others for bug
36 ;; fixes and improvements.
38 ;;; History
40 ;; Since I discovered Stephen Eglen's excellent iswitchb package, I just
41 ;; couldn't live without it, but once being addicted to switching buffers
42 ;; with a minimum of keystrokes, I soon found that opening files in the
43 ;; old-fashioned way was just too slow - so I decided to write a package
44 ;; which could open files with the same speed and ease as iswitchb could
45 ;; switch buffers.
47 ;; I originally wrote a separate ifindf.el package based on a copy of
48 ;; iswitchb.el, which did for opening files what iswitchb did for
49 ;; switching buffers. Along the way, I corrected a few errors in
50 ;; ifindf which could have found its way back into iswitchb, but since
51 ;; most of the functionality of the two package was practically
52 ;; identical, I decided that the proper thing to do was to merge my
53 ;; ifindf package back into iswitchb.
55 ;; This is basically what ido (interactively do) is all about; but I
56 ;; found it ackward to merge my changes into the "iswitchb-" namespace,
57 ;; so I invented a common "ido-" namespace for the merged packages.
59 ;; This version is based on ido.el version 1.57 released on
60 ;; gnu.emacs.sources adapted for emacs 22.1 to use command remapping
61 ;; and optionally hooking the read-buffer and read-file-name functions.
63 ;; Prefix matching was added by Klaus Berndl <klaus.berndl@sdm.de> based on
64 ;; an idea of Yuji Minejima <ggb01164@nifty.ne.jp> and his mcomplete-package.
67 ;;; Commentary:
69 ;; Ido - interactive do - switches between buffers and opens files and
70 ;; directories with a minimum of keystrokes. It is a superset of
71 ;; iswitchb, the interactive buffer switching package by Stephen Eglen.
73 ;; Interactive substring matching
74 ;; ------------------------------
76 ;; As you type in a substring, the list of buffers or files currently
77 ;; matching the substring are displayed as you type. The list is
78 ;; ordered so that the most recent buffers or files visited come at
79 ;; the start of the list.
81 ;; The buffer or file at the start of the list will be the one visited
82 ;; when you press RETURN. By typing more of the substring, the list is
83 ;; narrowed down so that gradually the buffer or file you want will be
84 ;; at the top of the list. Alternatively, you can use C-s and C-r (or
85 ;; the right and left arrow keys) to rotate buffer or file names in the
86 ;; list until the one you want is at the top of the list.
88 ;; Completion is also available so that you can see what is common to
89 ;; all of the matching buffers or files as you type.
91 ;; Example:
93 ;; If I have two buffers called "123456" and "123", with "123456" the
94 ;; most recent, when I use ido-switch-buffer, I first of all get
95 ;; presented with the list of all the buffers
97 ;; Buffer: {123456,123}
99 ;; If I then press 2:
100 ;; Buffer: 2[3]{123456,123}
102 ;; The list in {...} are the matching buffers, most recent first
103 ;; (buffers visible in the current frame are put at the end of the
104 ;; list by default). At any time I can select the item at the head of
105 ;; the list by pressing RET. I can also put the first element at the
106 ;; end of the list by pressing C-s or [right], or bring the last
107 ;; element to the head of the list by pressing C-r or [left].
109 ;; The item in [...] indicates what can be added to my input by
110 ;; pressing TAB. In this case, I will get "3" added to my input.
112 ;; So, I press TAB:
113 ;; Buffer: 23{123456,123}
115 ;; At this point, I still have two matching buffers.
116 ;; If I want the first buffer in the list, I simply press RET. If I
117 ;; wanted the second in the list, I could press C-s to move it to the
118 ;; top of the list and then RET to select it.
120 ;; However, if I type 4, I only have one match left:
121 ;; Buffer: 234[123456] [Matched]
123 ;; Since there is only one matching buffer left, it is given in [] and we
124 ;; see the text [Matched] afterwards. I can now press TAB or RET to go
125 ;; to that buffer.
127 ;; If however, I now type "a":
128 ;; Buffer: 234a [No match]
129 ;; There are no matching buffers. If I press RET or TAB, I can be
130 ;; prompted to create a new buffer called "234a".
132 ;; Of course, where this function comes in really useful is when you
133 ;; can specify the buffer using only a few keystrokes. In the above
134 ;; example, the quickest way to get to the "123456" file would be
135 ;; just to type 4 and then RET (assuming there isn't any newer buffer
136 ;; with 4 in its name).
138 ;; Likewise, if you use C-x C-f (ido-find-file), the list of files and
139 ;; directories in the current directory is provided in the same
140 ;; fashion as the buffers above. The files and directories are
141 ;; normally sorted in alphabetical order, but the most recently
142 ;; visited directory is placed first to speed up navigating to
143 ;; directories that you have visited recently.
145 ;; In addition to scrolling through the list using [right] and [left],
146 ;; you can use [up] and [down] to quickly scroll the list to the next
147 ;; or previous subdirectory.
149 ;; To go down into a subdirectory, and continue the file selection on
150 ;; the files in that directory, simply move the directory to the head
151 ;; of the list and hit RET.
153 ;; To go up to the parent directory, delete any partial file name
154 ;; already specified (e.g. using [backspace]) and hit [backspace].
156 ;; To go to the root directory (on the current drive), enter two
157 ;; slashes. On MS-DOS or Windows, to select the root of another
158 ;; drive, enter X:/ where X is the drive letter. You can also visit
159 ;; files on other hosts using the ange-ftp notations `/host:' and
160 ;; `/user@host:'. See the variable `ido-slow-ftp-hosts' if you want
161 ;; to inhibit the ido substring matching for ftp access.
163 ;; If for some reason you cannot specify the proper file using
164 ;; ido-find-file, you can press C-f to enter the normal find-file.
165 ;; You can also press C-b to drop into ido-switch-buffer.
167 ;; See the doc string of ido-switch-buffer and ido-find-file for full
168 ;; keybindings and features.
169 ;; (describe-function 'ido-find-file)
171 ;; Hidden buffers and files
172 ;; ------------------------
174 ;; Normally, ido does not include hidden buffers (whose name starts
175 ;; with a space) and hidden files and directories (whose name starts
176 ;; with `.') in the list of possible completions. However, if the
177 ;; substring you enter does not match any of the visible buffers or
178 ;; files, ido will automatically look for completions among the hidden
179 ;; buffers or files.
181 ;; You can toggle display of the hidden buffers and files with C-a.
183 ;; Additional functionality
184 ;; ------------------------
186 ;; After C-x b, the buffer at the head of the list can be killed by
187 ;; pressing C-k. If the buffer needs saving, you will be queried
188 ;; before the buffer is killed.
190 ;; Likewise, after C-x C-f, you can delete (i.e. physically remove)
191 ;; the file at the head of the list with C-k. You will always be
192 ;; asked for confirmation before the file is deleted.
194 ;; If you enter C-x b to switch to a buffer visiting a given file, and
195 ;; you find that the file you are after is not in any buffer, you can
196 ;; press C-f to immediately drop into ido-find-file. And you can
197 ;; switch back to buffer selection with C-b.
199 ;; Prefix matching
200 ;; ---------------
202 ;; The standard way of completion with Unix-shells and Emacs is to insert a
203 ;; PREFIX and then hitting TAB (or another completion key). Cause of this
204 ;; behavior has become second nature to a lot of emacs users `ido' offers in
205 ;; addition to the default substring-matching-method (look above) also the
206 ;; prefix-matching-method. The kind of matching is the only difference to
207 ;; the description of the substring-matching above.
209 ;; You can toggle prefix matching with C-p.
211 ;; Example:
213 ;; If you have again two Buffers "123456" and "123" then hitting "2" does
214 ;; not match because "2" is not a PREFIX in any of the buffer-names.
216 ;; Flexible matching
217 ;; -----------------
219 ;; If you set ido-enable-flex-matching, ido will do a more flexible
220 ;; matching (unless regexp matching is active) to find possible matches
221 ;; among the available buffer or file names if no matches are found using
222 ;; the normal prefix or substring matching.
224 ;; The flexible matching implies that any item which simply contains all
225 ;; of the entered characters in the specified sequence will match.
227 ;; Example:
229 ;; If you have four files "alpha", "beta", "gamma", and "delta",
230 ;; entering "aa" will match "alpha" and "gamma", while "ea" matches
231 ;; "beta" and "delta". If prefix matching is also active, "aa" only
232 ;; matches "alpha", while "ea" does not match any files.
234 ;; Regexp matching
235 ;; ---------------
237 ;; There is limited provision for regexp matching within ido,
238 ;; enabled through `ido-enable-regexp' (toggle with C-t).
239 ;; This allows you to type `[ch]$' for example and see all file names
240 ;; ending in `c' or `h'.
242 ;; Note: ido-style completion is inhibited when you enable regexp matching.
245 ;; Customization
246 ;; -------------
248 ;; Customize the `ido' group to change the `ido' functionality.
250 ;; To modify the keybindings, use the ido-setup-hook. For example:
251 ;;(add-hook 'ido-setup-hook 'ido-my-keys)
253 ;;(defun ido-my-keys ()
254 ;; "Add my keybindings for ido."
255 ;; (define-key ido-mode-map " " 'ido-next-match)
256 ;; )
258 ;; Seeing all the matching buffers or files
259 ;; ----------------------------------------
261 ;; If you have many matching files, they may not all fit onto one
262 ;; line of the minibuffer. Normally, the minibuffer window will grow
263 ;; to show you more of the matching files (depending on the setting
264 ;; of the variables `resize-mini-windows' and `max-mini-window-height').
265 ;; If you want ido to behave differently from the default minibuffer
266 ;; resizing behaviour, set the variable `ido-max-window-height'.
268 ;; Also, to improve the responsiveness of ido, the maximum number of
269 ;; matching items is limited to 12, but you can increase or removed
270 ;; this limit via the `ido-max-prospects' variable.
272 ;; To see a full list of all matching buffers in a separate buffer,
273 ;; hit ? or press TAB when there are no further completions to the
274 ;; substring. Repeated TAB presses will scroll you through this
275 ;; separate buffer.
277 ;; Changing the list of files
278 ;; --------------------------
280 ;; By default, the list of current files is most recent first,
281 ;; oldest last, with the exception that the files visible in the
282 ;; current frame are put at the end of the list. A hook exists to
283 ;; allow other functions to order the list. For example, if you add:
285 ;; (add-hook 'ido-make-buffer-list-hook 'ido-summary-buffers-to-end)
287 ;; then all files matching "Summary" are moved to the end of the
288 ;; list. (I find this handy for keeping the INBOX Summary and so on
289 ;; out of the way.) It also moves files matching "output\*$" to the
290 ;; end of the list (these are created by AUCTeX when compiling.)
291 ;; Other functions could be made available which alter the list of
292 ;; matching files (either deleting or rearranging elements.)
294 ;; Highlighting
295 ;; ------------
297 ;; The highlighting of matching items is controlled via ido-use-faces.
298 ;; The faces used are ido-first-match, ido-only-match and
299 ;; ido-subdir.
300 ;; Colouring of the matching item was suggested by
301 ;; Carsten Dominik (dominik@strw.leidenuniv.nl).
303 ;; Replacement for read-buffer and read-file-name
304 ;; ----------------------------------------------
306 ;; ido-read-buffer and ido-read-file-name have been written to be drop
307 ;; in replacements for the normal buffer and file name reading
308 ;; functions `read-buffer' and `read-file-name'.
310 ;; To use ido for all buffer and file selections in Emacs, customize the
311 ;; variable `ido-everywhere'.
313 ;; Using ido-like behaviour in other lisp packages
314 ;; -----------------------------------------------
316 ;; If you don't want to rely on the `ido-everywhere' functionality,
317 ;; ido-read-buffer, ido-read-file-name, and ido-read-directory-name
318 ;; can be used by other packages to read a buffer name, a file name,
319 ;; or a directory name in the `ido' way.
322 ;;; Code:
324 (provide 'ido)
326 (defvar cua-inhibit-cua-keys)
328 ;;; User Variables
330 ;; These are some things you might want to change.
332 (defun ido-fractionp (n)
333 (and (numberp n) (> n 0.0) (<= n 1.0)))
335 (defgroup ido nil
336 "Switch between files using substrings."
337 :group 'extensions
338 :group 'convenience
339 :version "22.1"
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-set
358 :require 'ido
359 :link '(emacs-commentary-link "ido.el")
360 :set-after '(ido-save-directory-list-file)
361 :type '(choice (const :tag "Turn on only buffer" buffer)
362 (const :tag "Turn on only file" file)
363 (const :tag "Turn on both buffer and file" both)
364 (const :tag "Switch off all" nil))
365 :group 'ido)
367 (defcustom ido-everywhere nil
368 "Use ido everywhere for reading file names and directories.
369 Setting this variable directly does not work. Use `customize' or
370 call the function `ido-everywhere'."
371 :set #'(lambda (symbol value)
372 (ido-everywhere (if value 1 -1)))
373 :initialize 'custom-initialize-default
374 :type 'boolean
375 :group 'ido)
377 (defcustom ido-case-fold case-fold-search
378 "*Non-nil if searching of buffer and file names should ignore case."
379 :type 'boolean
380 :group 'ido)
382 (defcustom ido-ignore-buffers
383 '("\\` ")
384 "*List of regexps or functions matching buffer names to ignore.
385 For example, traditional behavior is not to list buffers whose names begin
386 with a space, for which the regexp is `\\` '. See the source file for
387 example functions that filter buffernames."
388 :type '(repeat (choice regexp function))
389 :group 'ido)
391 (defcustom ido-ignore-files
392 '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
393 "*List of regexps or functions matching file names to ignore.
394 For example, traditional behavior is not to list files whose names begin
395 with a #, for which the regexp is `\\`#'. See the source file for
396 example functions that filter filenames."
397 :type '(repeat (choice regexp function))
398 :group 'ido)
400 (defcustom ido-ignore-extensions t
401 "*Non-nil means ignore files in completion-ignored-extensions list."
402 :type 'boolean
403 :group 'ido)
405 (defcustom ido-show-dot-for-dired nil
406 "*Non-nil means to always put . as the first item in file name lists.
407 This allows the current directory to be opened immediate with `dired'."
408 :type 'boolean
409 :group 'ido)
411 (defcustom ido-file-extensions-order nil
412 "*List of file extensions specifying preferred order of file selections.
413 Each element is either a string with `.' as the first char, an empty
414 string matching files without extension, or t which is the default order
415 for files with an unlisted file extension."
416 :type '(repeat (choice string
417 (const :tag "Default order" t)))
418 :group 'ido)
420 (defcustom ido-ignore-directories
421 '("\\`CVS/" "\\`\\.\\./" "\\`\\./")
422 "*List of regexps or functions matching sub-directory names to ignore."
423 :type '(repeat (choice regexp function))
424 :group 'ido)
426 (defcustom ido-ignore-directories-merge nil
427 "*List of regexps or functions matching directory names to ignore during merge.
428 Directory names matched by one of the regexps in this list are not inserted
429 in merged file and directory lists."
430 :type '(repeat (choice regexp function))
431 :group 'ido)
433 ;;; Examples for setting the value of ido-ignore-buffers
434 ;(defun ido-ignore-c-mode (name)
435 ; "Ignore all c mode buffers -- example function for ido."
436 ; (save-excursion
437 ; (set-buffer name)
438 ; (string-match "^C$" mode-name)))
440 ;(setq ido-ignore-buffers '("^ " ido-ignore-c-mode))
442 ;;; Examples for setting the value of ido-ignore-files
443 ;(setq ido-ignore-files '("^ " "\\.c$" "\\.h$"))
445 (defcustom ido-default-file-method 'always-frame
446 "*How to switch to new file when using `ido-find-file'.
447 Possible values:
448 `samewindow' Show new file in same window
449 `otherwindow' Show new file in another window (same frame)
450 `display' Display file in another window without switching to it
451 `otherframe' Show new file in another frame
452 `maybe-frame' If a file is visible in another frame, prompt to ask if you
453 you want to see the file in the same window of the current
454 frame or in the other frame
455 `always-frame' If a file is visible in another frame, raise that
456 frame; otherwise, visit the file in the same window"
457 :type '(choice (const samewindow)
458 (const otherwindow)
459 (const display)
460 (const otherframe)
461 (const maybe-frame)
462 (const always-frame))
463 :group 'ido)
465 (defcustom ido-default-buffer-method 'always-frame
466 "*How to switch to new buffer when using `ido-switch-buffer'.
467 See `ido-default-file-method' for details."
468 :type '(choice (const samewindow)
469 (const otherwindow)
470 (const display)
471 (const otherframe)
472 (const maybe-frame)
473 (const always-frame))
474 :group 'ido)
476 (defcustom ido-enable-flex-matching nil
477 "*Non-nil means that `ido' will do flexible string matching.
478 Flexible matching means that if the entered string does not
479 match any item, any item containing the entered characters
480 in the given sequence will match."
481 :type 'boolean
482 :group 'ido)
485 (defcustom ido-enable-regexp nil
486 "*Non-nil means that `ido' will do regexp matching.
487 Value can be toggled within `ido' using `ido-toggle-regexp'."
488 :type 'boolean
489 :group 'ido)
491 (defcustom ido-enable-prefix nil
492 "*Non-nil means only match if the entered text is a prefix of file name.
493 This behavior is like the standard emacs-completion.
494 Nil means to match if the entered text is an arbitrary substring.
495 Value can be toggled within `ido' using `ido-toggle-prefix'."
496 :type 'boolean
497 :group 'ido)
499 (defcustom ido-enable-dot-prefix nil
500 "*Non-nil means to match leading dot as prefix.
501 I.e. hidden files and buffers will match only if you type a dot
502 as first char even if `ido-enable-prefix' is nil."
503 :type 'boolean
504 :group 'ido)
506 (defcustom ido-confirm-unique-completion nil
507 "*Non-nil means that even a unique completion must be confirmed.
508 This means that \\[ido-complete] must always be followed by \\[ido-exit-minibuffer]
509 even when there is only one unique completion."
510 :type 'boolean
511 :group 'ido)
513 (defcustom ido-cannot-complete-command 'ido-completion-help
514 "*Command run when `ido-complete' can't complete any more.
515 The most useful values are `ido-completion-help', which pops up a
516 window with completion alternatives, or `ido-next-match' or
517 `ido-prev-match', which cycle the buffer list."
518 :type 'function
519 :group 'ido)
522 (defcustom ido-record-commands t
523 "*Non-nil means that `ido' will record commands in command history.
524 Note that the non-ido equivalent command is recorded."
525 :type 'boolean
526 :group 'ido)
528 (defcustom ido-max-prospects 12
529 "*Non-zero means that the prospect list will be limited to than number of items.
530 For a long list of prospects, building the full list for the minibuffer can take a
531 non-negligible amount of time; setting this variable reduces that time."
532 :type 'integer
533 :group 'ido)
535 (defcustom ido-max-file-prompt-width 0.35
536 "*Non-zero means that the prompt string be limited to than number of characters.
537 If value is a floating point number, it specifies a fraction of the frame width."
538 :type '(choice
539 (integer :tag "Characters" :value 20)
540 (restricted-sexp :tag "Fraction of frame width"
541 :value 0.35
542 :match-alternatives (ido-fractionp)))
543 :group 'ido)
545 (defcustom ido-max-window-height nil
546 "*Non-nil specifies a value to override `max-mini-window-height'."
547 :type '(choice
548 (const :tag "Don't override" nil)
549 (integer :tag "Number of lines" :value 1)
550 (restricted-sexp
551 :tag "Fraction of window height"
552 :value 0.25
553 :match-alternatives (ido-fractionp)))
554 :group 'ido)
556 (defcustom ido-enable-last-directory-history t
557 "*Non-nil means that `ido' will remember latest selected directory names.
558 See `ido-last-directory-list' and `ido-save-directory-list-file'."
559 :type 'boolean
560 :group 'ido)
562 (defcustom ido-max-work-directory-list 50
563 "*Maximum number of working directories to record.
564 This is the list of directories where files have most recently been opened.
565 See `ido-work-directory-list' and `ido-save-directory-list-file'."
566 :type 'integer
567 :group 'ido)
569 (defcustom ido-work-directory-list-ignore-regexps nil
570 "*List of regexps matching directories which should not be recorded.
571 Directory names matched by one of the regexps in this list are not inserted in
572 the `ido-work-directory-list' list."
573 :type '(repeat regexp)
574 :group 'ido)
577 (defcustom ido-use-filename-at-point nil
578 "*Non-nil means that ido shall look for a filename at point.
579 May use `ffap-guesser' to guess whether text at point is a filename.
580 If found, use that as the starting point for filename selection."
581 :type '(choice
582 (const :tag "Disabled" nil)
583 (const :tag "Guess filename" guess)
584 (other :tag "Use literal filename" t))
585 :group 'ido)
588 (defcustom ido-use-url-at-point nil
589 "*Non-nil means that ido shall look for a URL at point.
590 If found, call `find-file-at-point' to visit it."
591 :type 'boolean
592 :group 'ido)
595 (defcustom ido-enable-tramp-completion t
596 "*Non-nil means that ido shall perform tramp method and server name completion.
597 A tramp file name uses the following syntax: /method:user@host:filename."
598 :type 'boolean
599 :group 'ido)
601 (defcustom ido-record-ftp-work-directories t
602 "*Non-nil means record ftp file names in the work directory list."
603 :type 'boolean
604 :group 'ido)
606 (defcustom ido-merge-ftp-work-directories nil
607 "*If nil means merging ignores ftp file names in the work directory list."
608 :type 'boolean
609 :group 'ido)
611 (defcustom ido-cache-ftp-work-directory-time 1.0
612 "*Maximum time to cache contents of an ftp directory (in hours).
613 If zero, ftp directories are not cached."
614 :type 'number
615 :group 'ido)
617 (defcustom ido-slow-ftp-hosts nil
618 "*List of slow ftp hosts where ido prompting should not be used.
619 If an ftp host is on this list, ido automatically switches to the non-ido
620 equivalent function, e.g. `find-file' rather than `ido-find-file'."
621 :type '(repeat string)
622 :group 'ido)
624 (defcustom ido-slow-ftp-host-regexps nil
625 "*List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')."
626 :type '(repeat regexp)
627 :group 'ido)
629 (defcustom ido-max-work-file-list 10
630 "*Maximum number of names of recently opened files to record.
631 This is the list the file names (sans directory) which have most recently
632 been opened. See `ido-work-file-list' and `ido-save-directory-list-file'."
633 :type 'integer
634 :group 'ido)
636 (defcustom ido-work-directory-match-only t
637 "*Non-nil means to skip non-matching directories in the directory history.
638 When some text is already entered at the `ido-find-file' prompt, using
639 \\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories
640 without any matching entries."
641 :type 'boolean
642 :group 'ido)
644 (defcustom ido-auto-merge-work-directories-length 0
645 "*Automatically switch to merged work directories during file name input.
646 The value is number of characters to type before switching to merged mode.
647 If zero, the switch happens when no matches are found in the current directory.
648 Automatic merging is disabled if the value is negative."
649 :type 'integer
650 :group 'ido)
652 (defcustom ido-auto-merge-delay-time 0.70
653 "*Delay in seconds to wait for more input before doing auto merge."
654 :type 'number
655 :group 'ido)
657 (defcustom ido-auto-merge-inhibit-characters-regexp "[][*?~]"
658 "*Regexp matching characters which should inhibit automatic merging.
659 When a (partial) file name matches this regexp, merging is inhibited."
660 :type 'regexp
661 :group 'ido)
663 (defcustom ido-merged-indicator "^"
664 "The string appended to first choice if it has multiple directory choices."
665 :type 'string
666 :group 'ido)
668 (defcustom ido-max-dir-file-cache 100
669 "*Maximum number of working directories to be cached.
670 This is the size of the cache of file-name-all-completions results.
671 Each cache entry is time stamped with the modification time of the
672 directory. Some systems, like Windows, have unreliable directory
673 modification times, so you may choose to disable caching on such
674 systems, or explicitly refresh the cache contents using the command
675 `ido-reread-directory' command (C-l) in the minibuffer.
676 See also `ido-dir-file-cache' and `ido-save-directory-list-file'."
677 :type 'integer
678 :group 'ido)
680 (defcustom ido-max-directory-size 30000
681 "*Maximum size (in bytes) for directories to use ido completion.
682 If you enter a directory with a size larger than this size, ido will
683 not provide the normal completion. To show the completions, use C-a."
684 :type '(choice (const :tag "No limit" nil)
685 (integer :tag "Size in bytes" 30000))
686 :group 'ido)
688 (defcustom ido-rotate-file-list-default nil
689 "*Non-nil means that `ido' will always rotate file list to get default in front."
690 :type 'boolean
691 :group 'ido)
693 (defcustom ido-enter-matching-directory 'only
694 "*Additional methods to enter sub-directory of first/only matching item.
695 If value is 'first, enter first matching sub-directory when typing a slash.
696 If value is 'only, typing a slash only enters the sub-directory if it is
697 the only matching item.
698 If value is t, automatically enter a sub-directory when it is the only
699 matching item, even without typing a slash."
700 :type '(choice (const :tag "Never" nil)
701 (const :tag "Slash enters first directory" first)
702 (const :tag "Slash enters first and only directory" only)
703 (other :tag "Always enter unique directory" t))
704 :group 'ido)
706 (defcustom ido-create-new-buffer 'prompt
707 "*Specify whether a new buffer is created if no buffer matches substring.
708 Choices are 'always to create new buffers unconditionally, 'prompt to
709 ask user whether to create buffer, or 'never to never create new buffer."
710 :type '(choice (const always)
711 (const prompt)
712 (const never))
713 :group 'ido)
715 (defcustom ido-setup-hook nil
716 "*Hook run after the ido variables and keymap have been setup.
717 The dynamic variable `ido-cur-item' contains the current type of item that
718 is read by ido, possible values are file, dir, buffer, and list.
719 Additional keys can be defined in `ido-mode-map'."
720 :type 'hook
721 :group 'ido)
723 (defcustom ido-separator nil
724 "*String used by ido to separate the alternatives in the minibuffer.
725 Obsolete. Set 3rd element of `ido-decorations' instead."
726 :type '(choice string (const nil))
727 :group 'ido)
729 (defcustom ido-decorations '( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]" " [Not readable]" " [Too big]")
730 "*List of strings used by ido to display the alternatives in the minibuffer.
731 There are 10 elements in this list:
732 1st and 2nd elements are used as brackets around the prospect list,
733 3rd element is the separator between prospects (ignored if ido-separator is set),
734 4th element is the string inserted at the end of a truncated list of prospects,
735 5th and 6th elements are used as brackets around the common match string which
736 can be completed using TAB,
737 7th element is the string displayed when there are no matches, and
738 8th element is displayed if there is a single match (and faces are not used),
739 9th element is displayed when the current directory is non-readable,
740 10th element is displayed when directory exceeds `ido-max-directory-size'."
741 :type '(repeat string)
742 :group 'ido)
744 (defcustom ido-use-faces t
745 "*Non-nil means use ido faces to highlighting first match, only match and
746 subdirs in the alternatives."
747 :type 'boolean
748 :group 'ido)
750 (defface ido-first-match '((t (:bold t)))
751 "*Font used by ido for highlighting first match."
752 :group 'ido)
754 (defface ido-only-match '((((class color))
755 (:foreground "ForestGreen"))
756 (t (:italic t)))
757 "*Font used by ido for highlighting only match."
758 :group 'ido)
760 (defface ido-subdir '((((min-colors 88) (class color))
761 (:foreground "red1"))
762 (((class color))
763 (:foreground "red"))
764 (t (:underline t)))
765 "*Font used by ido for highlighting subdirs in the alternatives."
766 :group 'ido)
768 (defface ido-indicator '((((min-colors 88) (class color))
769 (:foreground "yellow1"
770 :background "red1"
771 :width condensed))
772 (((class color))
773 (:foreground "yellow"
774 :background "red"
775 :width condensed))
776 (t (:inverse-video t)))
777 "*Font used by ido for highlighting its indicators."
778 :group 'ido)
780 (defface ido-incomplete-regexp
781 '((t
782 (:inherit font-lock-warning-face)))
783 "Ido face for indicating incomplete regexps."
784 :group 'ido)
786 (defcustom ido-make-file-list-hook nil
787 "*List of functions to run when the list of matching files is created.
788 Each function on the list may modify the dynamically bound variable
789 `ido-temp-list' which contains the current list of matching files."
790 :type 'hook
791 :group 'ido)
793 (defcustom ido-make-dir-list-hook nil
794 "*List of functions to run when the list of matching directories is created.
795 Each function on the list may modify the dynamically bound variable
796 `ido-temp-list' which contains the current list of matching directories."
797 :type 'hook
798 :group 'ido)
800 (defcustom ido-make-buffer-list-hook nil
801 "*List of functions to run when the list of matching buffers is created.
802 Each function on the list may modify the dynamically bound variable
803 `ido-temp-list' which contains the current list of matching buffer names."
804 :type 'hook
805 :group 'ido)
807 (defcustom ido-rewrite-file-prompt-functions nil
808 "*List of functions to run when the find-file prompt is created.
809 Each function on the list may modify the following dynamically bound
810 variables:
811 dirname - the (abbreviated) directory name
812 to be modified by the hook functions
813 max-width - the max width of the resulting dirname; nil means no limit
814 prompt - the basic prompt (e.g. \"Find File: \")
815 literal - the string shown if doing \"literal\" find; set to nil to omit
816 vc-off - the string shown if version control is inhibited; set to nit to omit
817 prefix - either nil or a fixed prefix for the dirname
819 The following variables are available, but should not be changed:
820 ido-current-directory - the unabbreviated directory name
821 item - equals `file' or `dir' depending on the current mode."
822 :type 'hook
823 :group 'ido)
825 (defvar ido-rewrite-file-prompt-rules nil
826 "*Alist of rewriting rules for directory names in ido prompts.
827 A list of elements of the form (FROM . TO) or (FROM . FUNC), each
828 meaning to rewrite the directory name if matched by FROM by either
829 substituting the matched string by TO or calling the function FUNC
830 with the current directory name as its only argument and using the
831 return value as the new directory name. In addition, each FUNC may
832 also modify the dynamic variables described for the variable
833 `ido-rewrite-file-prompt-functions'.")
835 (defcustom ido-completion-buffer "*Ido Completions*"
836 "*Name of completion buffer used by ido.
837 Set to nil to disable completion buffers popping up."
838 :type 'string
839 :group 'ido)
841 (defcustom ido-completion-buffer-all-completions nil
842 "*Non-nil means to show all completions in completion buffer.
843 Otherwise, only the current list of matches is shown."
844 :type 'boolean
845 :group 'ido)
847 (defvar ido-all-frames 'visible
848 "*Argument to pass to `walk-windows' when finding visible files.
849 See documentation of `walk-windows' for useful values.")
851 (defcustom ido-minibuffer-setup-hook nil
852 "*Ido-specific customization of minibuffer setup.
854 This hook is run during minibuffer setup iff `ido' will be active.
855 It is intended for use in customizing ido for interoperation
856 with other packages. For instance:
858 \(add-hook 'ido-minibuffer-setup-hook
859 \(function
860 \(lambda ()
861 \(make-local-variable 'max-mini-window-height)
862 \(setq max-mini-window-height 3))))
864 will constrain Emacs to a maximum minibuffer height of 3 lines when
865 ido is running. Copied from `icomplete-minibuffer-setup-hook'."
866 :type 'hook
867 :group 'ido)
869 (defcustom ido-save-directory-list-file "~/.ido.last"
870 "File in which the ido state is saved between invocations.
871 Variables stored are: `ido-last-directory-list', `ido-work-directory-list',
872 `ido-work-file-list', and `ido-dir-file-cache'.
873 Must be set before enabling ido mode."
874 :type 'string
875 :group 'ido)
877 (defcustom ido-read-file-name-as-directory-commands '()
878 "List of commands which uses read-file-name to read a directory name.
879 When `ido-everywhere' is non-nil, the commands in this list will read
880 the directory using `ido-read-directory-name'."
881 :type '(repeat symbol)
882 :group 'ido)
884 (defcustom ido-read-file-name-non-ido '()
885 "List of commands which shall not read file names the ido way.
886 When `ido-everywhere' is non-nil, the commands in this list will read
887 the file name using normal `read-file-name' style."
888 :type '(repeat symbol)
889 :group 'ido)
891 (defcustom ido-before-fallback-functions '()
892 "List of functions to call before calling a fallback command.
893 The fallback command is passed as an argument to the functions."
894 :type 'hook
895 :group 'ido)
897 ;;; Internal Variables
899 ;; Persistent variables
901 (defvar ido-mode-map nil
902 "Currently active keymap for ido commands.")
904 (defvar ido-mode-common-map nil
905 "Keymap for all ido commands.")
907 (defvar ido-mode-file-map nil
908 "Keymap for ido file commands.")
910 (defvar ido-mode-file-dir-map nil
911 "Keymap for ido file and directory commands.")
913 (defvar ido-mode-buffer-map nil
914 "Keymap for ido buffer commands.")
916 (defvar ido-file-history nil
917 "History of files selected using `ido-find-file'.")
919 (defvar ido-buffer-history nil
920 "History of buffers selected using `ido-switch-buffer'.")
922 (defvar ido-last-directory-list nil
923 "List of last selected directory names.
924 See `ido-enable-last-directory-history' for details.")
926 (defvar ido-work-directory-list nil
927 "List of actual working directory names.
928 The current directory is inserted at the front of this list whenever a
929 file is opened with `ido-find-file' and family.")
931 (defvar ido-work-file-list nil
932 "List of actual work file names.
933 Opening a file with `ido-find-file' and similar functions
934 inserts the current file name (relative to its containing directory)
935 at the front of this list.")
937 (defvar ido-dir-file-cache nil
938 "List of `file-name-all-completions' results.
939 Each element in the list is of the form (DIR (MTIME) FILE...).")
941 (defvar ido-ignore-item-temp-list nil
942 "List of items to ignore in current ido invocation.
943 Intended to be let-bound by functions which call ido repeatedly.
944 Should never be set permanently.")
946 ;; Temporary storage
948 (defvar ido-eoinput 1
949 "Point where minibuffer input ends and completion info begins.
950 Copied from `icomplete-eoinput'.")
951 (make-variable-buffer-local 'ido-eoinput)
953 (defvar ido-common-match-string nil
954 "Stores the string that is common to all matching files.")
956 (defvar ido-rescan nil
957 "Non-nil means we need to regenerate the list of matching items.")
959 (defvar ido-rotate nil
960 "Non-nil means we are rotating list of matches.")
962 (defvar ido-text nil
963 "Stores the users string as it is typed in.")
965 (defvar ido-text-init nil
966 "The initial string for the users string it is typed in.")
968 (defvar ido-input-stack nil
969 "Stores the users strings when user hits M-b/M-f.")
971 (defvar ido-matches nil
972 "List of files currently matching `ido-text'.")
974 (defvar ido-report-no-match t
975 "Report [No Match] when no completions matches ido-text.")
977 (defvar ido-exit nil
978 "Flag to monitor how `ido-find-file' exits.
979 If equal to `takeprompt', we use the prompt as the file name to be
980 selected.")
982 (defvar ido-current-directory nil
983 "Current directory for `ido-find-file'.")
985 (defvar ido-auto-merge-timer nil
986 "Delay timer for auto merge.")
988 (defvar ido-use-mycompletion-depth 0
989 "Non-nil means use `ido' completion feedback.
990 Is set by ido functions to the current minibuffer-depth, so that
991 it doesn't interfere with other minibuffer usage.")
993 (defvar ido-incomplete-regexp nil
994 "Non-nil if an incomplete regexp is entered.")
996 ;;; Variables with dynamic bindings.
997 ;;; Declared here to keep the byte compiler quiet.
999 ;; Stores the current ido item type ('file, 'dir, 'buffer, or 'list).
1000 (defvar ido-cur-item)
1002 ;; Stores the current list of items that will be searched through.
1003 ;; The list is ordered, so that the most interesting item comes first,
1004 ;; although by default, the files visible in the current frame are put
1005 ;; at the end of the list. Created by `ido-make-item-list'.
1006 (defvar ido-cur-list)
1008 ;; Stores the choice list for ido-completing-read
1009 (defvar ido-choice-list)
1011 ;; Stores the list of items which are ignored when building
1012 ;; `ido-cur-list'. It is in no specific order.
1013 (defvar ido-ignored-list)
1015 ;; Remember if current directory is non-readable (so we cannot do completion).
1016 (defvar ido-directory-nonreadable)
1018 ;; Remember if current directory is 'huge' (so we don't want to do completion).
1019 (defvar ido-directory-too-big)
1021 ;; Keep current item list if non-nil.
1022 (defvar ido-keep-item-list)
1024 ;; Process ido-ignore-* lists.
1025 (defvar ido-process-ignore-lists)
1027 ;; Don't process ido-ignore- lists once.
1028 (defvar ido-process-ignore-lists-inhibit)
1030 ;; Buffer from which ido was entered.
1031 (defvar ido-entry-buffer)
1033 ;; Non-nil if matching file must be selected.
1034 (defvar ido-require-match)
1036 ;; Stores a temporary version of the file list being created.
1037 (defvar ido-temp-list)
1039 ;; Non-nil if default list element should be rotated into place.
1040 (defvar ido-rotate-temp)
1042 ;; Stores current index in ido-work-directory-list.
1043 (defvar ido-work-directory-index)
1045 ;; Stores current index in ido-work-file-list.
1046 (defvar ido-work-file-index)
1048 ;; Set when merged work directory list is in use.
1049 (defvar ido-use-merged-list)
1051 ;; Set when merged work directory list not yet built.
1052 (defvar ido-try-merged-list)
1054 ;; Saved state prior to last work directory merge.
1055 ;; Value is a list (ido-text dir cur-list ignored-list matches).
1056 (defvar ido-pre-merge-state)
1058 ;; Original value of vc-handled-backends for use in ido-toggle-vc.
1059 (defvar ido-saved-vc-hb)
1061 ;; Stores temporary state of literal find file.
1062 (defvar ido-find-literal)
1064 ;; Set to 'ignore to inhibit switching between find-file/switch-buffer.
1065 (defvar ido-context-switch-command)
1067 ;;; FUNCTIONS
1069 (defun ido-active (&optional merge)
1070 (if merge
1071 ido-use-merged-list
1072 (and (boundp 'ido-completing-read) (= ido-use-mycompletion-depth (minibuffer-depth)))))
1074 (defvar ido-trace-enable nil)
1076 (defun ido-trace (p &optional s retval)
1077 (if ido-trace-enable
1078 (let ((b (get-buffer-create " *IDO Trace*"))
1079 (deactivate-mark deactivate-mark))
1080 (save-excursion
1081 (save-restriction
1082 (set-buffer b)
1083 (insert p ": " (if (stringp s) s (format "%S" s)) "\n")))))
1084 retval)
1086 (defun ido-toggle-trace (arg)
1087 (interactive "P")
1088 (setq ido-trace-enable (or arg (not ido-trace-enable)))
1089 (if ido-trace-enable
1090 (message "IDO trace on"))
1091 (let ((b (get-buffer " *IDO Trace*")))
1092 (if b
1093 (if ido-trace-enable
1094 (kill-buffer b)
1095 (pop-to-buffer b t t)
1096 (setq truncate-lines t)))))
1098 (defun ido-is-tramp-root (&optional dir)
1099 (and ido-enable-tramp-completion
1100 (string-match "\\`/[^/]+[@:]\\'"
1101 (or dir ido-current-directory))))
1103 (defun ido-is-root-directory (&optional dir)
1104 (setq dir (or dir ido-current-directory))
1106 (string-equal "/" dir)
1107 (and (memq system-type '(windows-nt ms-dos))
1108 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir))
1109 (if ido-enable-tramp-completion
1110 (ido-is-tramp-root dir)
1111 (string-match "\\`/[^:/][^:/]+:\\'" dir))))
1113 (defun ido-is-ftp-directory (&optional dir)
1114 (string-match
1115 (if ido-enable-tramp-completion
1116 "\\`/[^/:][^/:]+:" ;; like tramp-file-name-regexp-unified, but doesn't match single drive letters
1117 "\\`/[^/:][^/:]+:/")
1118 (or dir ido-current-directory)))
1120 (defun ido-is-slow-ftp-host (&optional dir)
1121 (and (or ido-slow-ftp-hosts ido-slow-ftp-host-regexps)
1122 (setq dir (or dir ido-current-directory))
1123 ;; (featurep 'ange-ftp)
1124 ;; (ange-ftp-ftp-name dir)
1125 (string-match
1126 (if ido-enable-tramp-completion
1127 "\\`/\\([^/]+[@:]\\)*\\([^@/:][^@/:]+\\):"
1128 "\\`/\\([^/:]*@\\)?\\([^@/:][^@/:]+\\):/")
1129 dir)
1130 (let ((host (substring dir (match-beginning 2) (match-end 2))))
1131 (or (member host ido-slow-ftp-hosts)
1132 (let ((re ido-slow-ftp-host-regexps))
1133 (while (and re (not (string-match (car re) host)))
1134 (setq re (cdr re)))
1135 re)))))
1137 (defun ido-time-stamp (&optional time)
1138 ;; Time is a floating point number (fractions of 1 hour)
1139 (setq time (or time (current-time)))
1140 (/ (+ (* (car time) 65536.0) (car (cdr time))) 3600.0))
1142 (defun ido-cache-ftp-valid (&optional time)
1143 (and (numberp ido-cache-ftp-work-directory-time)
1144 (> ido-cache-ftp-work-directory-time 0)
1145 (or (not time)
1146 (< (- (ido-time-stamp) time) ido-cache-ftp-work-directory-time))))
1148 (defun ido-may-cache-directory (&optional dir)
1149 (setq dir (or dir ido-current-directory))
1150 (cond
1151 ((ido-directory-too-big-p dir)
1152 nil)
1153 ((and (ido-is-root-directory dir)
1154 (or ido-enable-tramp-completion
1155 (memq system-type '(windows-nt ms-dos))))
1156 nil)
1157 ((not (ido-is-ftp-directory dir))
1159 ((ido-cache-ftp-valid)
1160 t)))
1162 (defun ido-pp (list &optional sep)
1163 (let ((print-level nil) (eval-expression-print-level nil)
1164 (print-length nil) (eval-expression-print-length nil))
1165 (insert "\n;; ----- " (symbol-name list) " -----\n(\n ")
1166 (setq list (symbol-value list))
1167 (while list
1168 (let* ((elt (car list))
1169 (s (if (consp elt) (car elt) elt)))
1170 (if (and (stringp s) (= (length s) 0))
1171 (setq s nil))
1172 (if s
1173 (prin1 elt (current-buffer)))
1174 (if (and (setq list (cdr list)) s)
1175 (insert (or sep "\n ")))))
1176 (insert "\n)\n")))
1178 (defun ido-save-history ()
1179 "Save ido history and cache information between sessions."
1180 (interactive)
1181 (if (and ido-last-directory-list ido-save-directory-list-file)
1182 (save-excursion
1183 (save-window-excursion
1184 (if (find-buffer-visiting ido-save-directory-list-file)
1185 (kill-buffer (find-buffer-visiting ido-save-directory-list-file)))
1186 (if (file-exists-p ido-save-directory-list-file)
1187 (delete-file ido-save-directory-list-file))
1188 (set-buffer (let ((enable-local-variables nil))
1189 (find-file-noselect ido-save-directory-list-file t)))
1190 (goto-char (point-min))
1191 (delete-region (point-min) (point-max))
1192 (ido-pp 'ido-last-directory-list)
1193 (ido-pp 'ido-work-directory-list)
1194 (ido-pp 'ido-work-file-list)
1195 (ido-pp 'ido-dir-file-cache "\n\n ")
1196 (insert "\n")
1197 (let ((version-control 'never))
1198 (write-file ido-save-directory-list-file nil))
1199 (kill-buffer (current-buffer))))))
1201 (defun ido-load-history (&optional arg)
1202 "Load ido history and cache information from previous session.
1203 With prefix argument, reload history unconditionally."
1204 (interactive "P")
1205 (if (or arg (and ido-save-directory-list-file (not ido-last-directory-list)))
1206 (let ((file (expand-file-name ido-save-directory-list-file))
1207 buf)
1208 (when (file-readable-p file)
1209 (save-excursion
1210 (save-window-excursion
1211 (setq buf (set-buffer (let ((enable-local-variables nil))
1212 (find-file-noselect file))))
1213 (goto-char (point-min))
1214 (condition-case nil
1215 (setq ido-last-directory-list (read (current-buffer))
1216 ido-work-directory-list (read (current-buffer))
1217 ido-work-file-list (read (current-buffer))
1218 ido-dir-file-cache (read (current-buffer)))
1219 (error nil))))
1220 (kill-buffer buf))))
1221 (ido-wash-history))
1223 (defun ido-wash-history ()
1224 "Clean-up ido history and cache information.
1225 Removes badly formatted data and ignored directories."
1226 (interactive)
1227 ;; Check format of each of our lists, discard bogus elements
1228 (setq ido-last-directory-list
1229 (and (listp ido-last-directory-list)
1230 (let ((l ido-last-directory-list) r)
1231 (while l
1232 (if (and (consp (car l))
1233 (stringp (car (car l)))
1234 (stringp (cdr (car l))))
1235 (setq r (cons (car l) r)))
1236 (setq l (cdr l)))
1237 (nreverse r))))
1238 (setq ido-work-directory-list
1239 (and (listp ido-work-directory-list)
1240 (let ((l ido-work-directory-list) r)
1241 (while l
1242 (if (and (stringp (car l))
1243 (or ido-record-ftp-work-directories
1244 (not (ido-is-ftp-directory (car l)))))
1245 (setq r (cons (car l) r)))
1246 (setq l (cdr l)))
1247 (nreverse r))))
1248 (setq ido-work-file-list
1249 (and (listp ido-work-file-list)
1250 (let ((l ido-work-file-list) r)
1251 (while l
1252 (if (stringp (car l))
1253 (setq r (cons (car l) r)))
1254 (setq l (cdr l)))
1255 (nreverse r))))
1256 (setq ido-dir-file-cache
1257 (and (listp ido-dir-file-cache)
1258 (let ((l ido-dir-file-cache) r)
1259 (while l
1260 (if (and (listp (car l))
1261 (> (length (car l)) 2)
1262 (let ((dir (car (car l)))
1263 (time (car (cdr (car l))))
1264 (files (cdr (cdr (car l)))))
1265 (and
1266 (stringp dir)
1267 (consp time)
1268 (if (integerp (car time))
1269 (and (/= (car time) 0)
1270 (integerp (car (cdr time)))
1271 (/= (car (cdr time)) 0)
1272 (ido-may-cache-directory dir))
1273 (and (eq (car time) 'ftp)
1274 (numberp (cdr time))
1275 (ido-is-ftp-directory dir)
1276 (ido-cache-ftp-valid (cdr time))))
1277 (let ((s files) (ok t))
1278 (while s
1279 (if (stringp (car s))
1280 (setq s (cdr s))
1281 (setq s nil ok nil)))
1282 ok))))
1283 (setq r (cons (car l) r)))
1284 (setq l (cdr l)))
1285 (nreverse r))))
1287 ;; Remove ignored directories from work directory list
1288 ;; according to ido-work-directory-list-ignore-regexps
1289 (if ido-work-directory-list
1290 (let ((dirs (reverse ido-work-directory-list)))
1291 (setq ido-work-directory-list nil)
1292 (while dirs
1293 (ido-record-work-directory (car dirs))
1294 (setq dirs (cdr dirs)))))
1295 ;; Get rid of text properties
1296 (let ((l ido-last-directory-list) e)
1297 (while l
1298 (setq e (car l) l (cdr l))
1299 (set-text-properties 0 (length (car e)) nil (car e))
1300 (set-text-properties 0 (length (cdr e)) nil (cdr e))))
1301 (let ((l ido-work-directory-list) e)
1302 (while l
1303 (setq e (car l) l (cdr l))
1304 (set-text-properties 0 (length e) nil e)))
1305 (let ((l ido-work-file-list) e)
1306 (while l
1307 (setq e (car l) l (cdr l))
1308 (set-text-properties 0 (length e) nil e)))
1309 (let ((l ido-dir-file-cache) e d)
1310 (while l
1311 (setq e (car l) l (cdr l))
1312 (if (listp e)
1313 (while e
1314 (setq d (car e) e (cdr e))
1315 (if (not (consp d))
1316 (set-text-properties 0 (length d) nil d)))))))
1319 (defun ido-kill-emacs-hook ()
1320 ;; ido kill emacs hook
1321 (ido-save-history))
1323 (defvar ido-minor-mode-map-entry nil)
1325 ;;;###autoload
1326 (defun ido-mode (&optional arg)
1327 "Toggle ido speed-ups on or off.
1328 With ARG, turn ido speed-up on if arg is positive, off otherwise.
1329 Turning on ido-mode will remap (via a minor-mode keymap) the default
1330 keybindings for the `find-file' and `switch-to-buffer' families of
1331 commands to the ido versions of these functions.
1332 However, if ARG arg equals 'files, remap only commands for files, or
1333 if it equals 'buffers, remap only commands for buffer switching.
1334 This function also adds a hook to the minibuffer."
1335 (interactive "P")
1336 (setq ido-mode
1337 (cond
1338 ((null arg) (if ido-mode nil 'both))
1339 ((eq arg t) 'both)
1340 ((eq arg 'files) 'file)
1341 ((eq arg 'buffers) 'buffer)
1342 ((memq arg '(file buffer both)) arg)
1343 ((> (prefix-numeric-value arg) 0) 'both)
1344 (t nil)))
1346 (ido-everywhere (if ido-everywhere 1 -1))
1347 (when ido-mode
1348 (ido-init-mode-maps))
1350 (when ido-mode
1351 (add-hook 'minibuffer-setup-hook 'ido-minibuffer-setup)
1352 (add-hook 'choose-completion-string-functions 'ido-choose-completion-string)
1353 (ido-load-history)
1355 (add-hook 'kill-emacs-hook 'ido-kill-emacs-hook)
1357 (if ido-minor-mode-map-entry
1358 (setcdr ido-minor-mode-map-entry (make-sparse-keymap))
1359 (setq ido-minor-mode-map-entry (cons 'ido-mode (make-sparse-keymap)))
1360 (add-to-list 'minor-mode-map-alist ido-minor-mode-map-entry))
1362 (let ((map (cdr ido-minor-mode-map-entry)))
1363 (when (memq ido-mode '(file both))
1364 (define-key map [remap find-file] 'ido-find-file)
1365 (define-key map [remap find-file-read-only] 'ido-find-file-read-only)
1366 (define-key map [remap find-alternate-file] 'ido-find-alternate-file)
1367 (define-key map [remap write-file] 'ido-write-file)
1368 (define-key map [remap insert-file] 'ido-insert-file)
1369 (define-key map [remap list-directory] 'ido-list-directory)
1370 (define-key map [remap dired] 'ido-dired)
1371 (define-key map [remap find-file-other-window] 'ido-find-file-other-window)
1372 (define-key map [remap find-file-read-only-other-window] 'ido-find-file-read-only-other-window)
1373 (define-key map [remap find-file-other-frame] 'ido-find-file-other-frame)
1374 (define-key map [remap find-file-read-only-other-frame] 'ido-find-file-read-only-other-frame))
1376 (when (memq ido-mode '(buffer both))
1377 (define-key map [remap switch-to-buffer] 'ido-switch-buffer)
1378 (define-key map [remap switch-to-buffer-other-window] 'ido-switch-buffer-other-window)
1379 (define-key map [remap switch-to-buffer-other-frame] 'ido-switch-buffer-other-frame)
1380 (define-key map [remap insert-buffer] 'ido-insert-buffer)
1381 (define-key map [remap kill-buffer] 'ido-kill-buffer)
1382 (define-key map [remap display-buffer] 'ido-display-buffer)))))
1384 (defun ido-everywhere (arg)
1385 "Toggle using ido speed-ups everywhere file and directory names are read.
1386 With ARG, turn ido speed-up on if arg is positive, off otherwise."
1387 (interactive "P")
1388 (setq ido-everywhere (if arg
1389 (> (prefix-numeric-value arg) 0)
1390 (not ido-everywhere)))
1391 (when (get 'ido-everywhere 'file)
1392 (setq read-file-name-function (car (get 'ido-everywhere 'file)))
1393 (put 'ido-everywhere 'file nil))
1394 (when (get 'ido-everywhere 'buffer)
1395 (setq read-buffer-function (car (get 'ido-everywhere 'buffer)))
1396 (put 'ido-everywhere 'buffer nil))
1397 (when ido-everywhere
1398 (when (memq ido-mode '(both file))
1399 (put 'ido-everywhere 'file (cons read-file-name-function nil))
1400 (setq read-file-name-function 'ido-read-file-name))
1401 (when (memq ido-mode '(both buffer))
1402 (put 'ido-everywhere 'buffer (cons read-buffer-function nil))
1403 (setq read-buffer-function 'ido-read-buffer))))
1406 ;;; IDO KEYMAP
1407 (defun ido-init-mode-maps ()
1408 "Set up the keymaps used by `ido'."
1410 ;; Common map
1411 (let ((map (make-sparse-keymap)))
1412 (define-key map "\C-a" 'ido-toggle-ignore)
1413 (define-key map "\C-c" 'ido-toggle-case)
1414 (define-key map "\C-e" 'ido-edit-input)
1415 (define-key map "\t" 'ido-complete)
1416 (define-key map " " 'ido-complete-space)
1417 (define-key map "\C-j" 'ido-select-text)
1418 (define-key map "\C-m" 'ido-exit-minibuffer)
1419 (define-key map "\C-p" 'ido-toggle-prefix)
1420 (define-key map "\C-r" 'ido-prev-match)
1421 (define-key map "\C-s" 'ido-next-match)
1422 (define-key map "\C-t" 'ido-toggle-regexp)
1423 (define-key map "\C-z" 'ido-undo-merge-work-directory)
1424 (define-key map [(control ?\s)] 'ido-restrict-to-matches)
1425 (define-key map [(control ?@)] 'ido-restrict-to-matches)
1426 (define-key map [right] 'ido-next-match)
1427 (define-key map [left] 'ido-prev-match)
1428 (define-key map "?" 'ido-completion-help)
1429 ;; Magic commands.
1430 (define-key map "\C-b" 'ido-magic-backward-char)
1431 (define-key map "\C-f" 'ido-magic-forward-char)
1432 (define-key map "\C-d" 'ido-magic-delete-char)
1433 (set-keymap-parent map minibuffer-local-map)
1434 (setq ido-mode-common-map map))
1436 ;; File and directory map
1437 (let ((map (make-sparse-keymap)))
1438 (define-key map "\C-x\C-b" 'ido-enter-switch-buffer)
1439 (define-key map "\C-x\C-f" 'ido-fallback-command)
1440 (define-key map "\C-x\C-d" 'ido-enter-dired)
1441 (define-key map [down] 'ido-next-match-dir)
1442 (define-key map [up] 'ido-prev-match-dir)
1443 (define-key map [(meta up)] 'ido-prev-work-directory)
1444 (define-key map [(meta down)] 'ido-next-work-directory)
1445 (define-key map [backspace] 'ido-delete-backward-updir)
1446 (define-key map "\d" 'ido-delete-backward-updir)
1447 (define-key map [(meta backspace)] 'ido-delete-backward-word-updir)
1448 (define-key map [(control backspace)] 'ido-up-directory)
1449 (define-key map "\C-l" 'ido-reread-directory)
1450 (define-key map [(meta ?d)] 'ido-wide-find-dir-or-delete-dir)
1451 (define-key map [(meta ?b)] 'ido-push-dir)
1452 (define-key map [(meta ?f)] 'ido-wide-find-file-or-pop-dir)
1453 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1454 (define-key map [(meta ?m)] 'ido-make-directory)
1455 (define-key map [(meta ?n)] 'ido-next-work-directory)
1456 (define-key map [(meta ?o)] 'ido-prev-work-file)
1457 (define-key map [(meta control ?o)] 'ido-next-work-file)
1458 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1459 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1460 (set-keymap-parent map ido-mode-common-map)
1461 (setq ido-mode-file-dir-map map))
1463 ;; File only map
1464 (let ((map (make-sparse-keymap)))
1465 (define-key map "\C-k" 'ido-delete-file-at-head)
1466 (define-key map "\C-o" 'ido-copy-current-word)
1467 (define-key map "\C-w" 'ido-copy-current-file-name)
1468 (define-key map [(meta ?l)] 'ido-toggle-literal)
1469 (define-key map "\C-v" 'ido-toggle-vc)
1470 (set-keymap-parent map ido-mode-file-dir-map)
1471 (setq ido-mode-file-map map))
1473 ;; Buffer map
1474 (let ((map (make-sparse-keymap)))
1475 (define-key map "\C-x\C-f" 'ido-enter-find-file)
1476 (define-key map "\C-x\C-b" 'ido-fallback-command)
1477 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1478 (set-keymap-parent map ido-mode-common-map)
1479 (setq ido-mode-buffer-map map)))
1482 (defun ido-define-mode-map ()
1483 "Set up the keymap for `ido'."
1485 ;; generated every time so that it can inherit new functions.
1486 (let ((map (make-sparse-keymap))
1487 (viper-p (if (boundp 'viper-mode) viper-mode)))
1489 (when viper-p
1490 (define-key map [remap viper-intercept-ESC-key] 'ignore))
1492 (cond
1493 ((memq ido-cur-item '(file dir))
1494 (when ido-context-switch-command
1495 (define-key map "\C-x\C-b" ido-context-switch-command)
1496 (define-key map "\C-x\C-d" 'ignore))
1497 (when viper-p
1498 (define-key map [remap viper-backward-char] 'ido-delete-backward-updir)
1499 (define-key map [remap viper-del-backward-char-in-insert] 'ido-delete-backward-updir)
1500 (define-key map [remap viper-delete-backward-word] 'ido-delete-backward-word-updir))
1501 (set-keymap-parent map
1502 (if (eq ido-cur-item 'file)
1503 ido-mode-file-map
1504 ido-mode-file-dir-map)))
1506 ((eq ido-cur-item 'buffer)
1507 (when ido-context-switch-command
1508 (define-key map "\C-x\C-f" ido-context-switch-command))
1509 (set-keymap-parent map ido-mode-buffer-map))
1512 (set-keymap-parent map ido-mode-common-map)))
1514 (setq ido-mode-map map)))
1516 (defun ido-final-slash (dir &optional fix-it)
1517 ;; return DIR if DIR has final slash.
1518 ;; else if FIX-IT is non-nil, return DIR/
1519 ;; else return nil.
1520 (setq dir (ido-name dir))
1521 (cond
1522 ((string-match "/\\'" dir) dir)
1523 ((ido-is-tramp-root dir) dir)
1524 (fix-it (concat dir "/"))
1525 (t nil)))
1527 (defun ido-no-final-slash (s)
1528 ;; Remove optional final slash from string S
1529 (let ((l (1- (length s))))
1530 (if (and (> l 0) (eq (aref s l) ?/))
1531 (substring s 0 l)
1532 s)))
1534 (defun ido-nonreadable-directory-p (dir)
1535 ;; Return t if dir is a directory, but not readable
1536 ;; Do not check for non-readable directories via tramp, as this causes a premature
1537 ;; connect on incomplete tramp paths (after entring just method:).
1538 (let ((ido-enable-tramp-completion nil))
1539 (and (ido-final-slash dir)
1540 (file-directory-p dir)
1541 (not (file-readable-p dir)))))
1543 (defun ido-directory-too-big-p (dir)
1544 ;; Return t if dir is a directory, but too big to show
1545 ;; Do not check for non-readable directories via tramp, as this causes a premature
1546 ;; connect on incomplete tramp paths (after entring just method:).
1547 (let ((ido-enable-tramp-completion nil))
1548 (and (numberp ido-max-directory-size)
1549 (ido-final-slash dir)
1550 (file-directory-p dir)
1551 (> (nth 7 (file-attributes dir)) ido-max-directory-size))))
1553 (defun ido-set-current-directory (dir &optional subdir no-merge)
1554 ;; Set ido's current directory to DIR or DIR/SUBDIR
1555 (unless (and ido-enable-tramp-completion
1556 (string-match "\\`/[^/]*@\\'" dir))
1557 (setq dir (ido-final-slash dir t)))
1558 (setq ido-use-merged-list nil
1559 ido-try-merged-list (not no-merge))
1560 (when subdir
1561 (setq dir (concat dir subdir))
1562 (unless (and ido-enable-tramp-completion
1563 (string-match "\\`/[^/]*@\\'" dir))
1564 (setq dir (ido-final-slash dir t))))
1565 (if (equal dir ido-current-directory)
1567 (ido-trace "cd" dir)
1568 (setq ido-current-directory dir)
1569 (if (get-buffer ido-completion-buffer)
1570 (kill-buffer ido-completion-buffer))
1571 (setq ido-directory-nonreadable (ido-nonreadable-directory-p dir))
1572 (setq ido-directory-too-big (and (not ido-directory-nonreadable)
1573 (ido-directory-too-big-p dir)))
1576 (defun ido-set-current-home (&optional dir)
1577 ;; Set ido's current directory to user's home directory
1578 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1580 (defun ido-record-command (command arg)
1581 ;; Add (command arg) to command-history if ido-record-commands is t
1582 (if ido-record-commands
1583 (let ((cmd (list command arg)))
1584 (if (or (not command-history)
1585 (not (equal cmd (car command-history))))
1586 (setq command-history (cons cmd command-history))))))
1588 (defun ido-make-prompt (item prompt)
1589 ;; Make the prompt for ido-read-internal
1590 (cond
1591 ((and (memq item '(file dir)) ido-current-directory)
1592 (let ((dirname (abbreviate-file-name ido-current-directory))
1593 (max-width (if (and ido-max-file-prompt-width (floatp ido-max-file-prompt-width))
1594 (floor (* (frame-width) ido-max-file-prompt-width))
1595 ido-max-file-prompt-width))
1596 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1597 (vc-off (and ido-saved-vc-hb (not vc-handled-backends) "[-VC] "))
1598 (prefix nil)
1599 (rule ido-rewrite-file-prompt-rules))
1600 (let ((case-fold-search nil))
1601 (while rule
1602 (if (and (consp (car rule))
1603 (string-match (car (car rule)) dirname))
1604 (setq dirname
1605 (if (stringp (cdr (car rule)))
1606 (replace-match (cdr (car rule)) t nil dirname)
1607 (funcall (cdr (car rule)) dirname))))
1608 (setq rule (cdr rule))))
1609 (run-hooks 'ido-rewrite-file-prompt-functions)
1610 (concat prompt
1611 ; (if ido-process-ignore-lists "" "&")
1612 (or literal "")
1613 (or vc-off "")
1614 (or prefix "")
1615 (let ((l (length dirname)))
1616 (if (and max-width (> max-width 0) (> l max-width))
1617 (let* ((s (substring dirname (- max-width)))
1618 (i (string-match "/" s)))
1619 (concat "..." (if i (substring s i) s)))
1620 dirname)))))
1621 (t prompt)))
1623 ;; Here is very briefly how ido-find-file works:
1625 ;; (ido-find-file)
1626 ;; (ido-file-internal method)
1627 ;; set ido-current-directory
1628 ;; (ido-read-internal 'file ...)
1629 ;; (while ...
1630 ;; (ido-make-item-list ...)
1631 ;; (ido-set-matches)
1632 ;; (completing-read ... ido-text-init ...)
1634 ;; ... here user is allowed to type characters and commands
1635 ;; a command may set ido-exit and call (exit-minibuffer)
1636 ;; to make ido-read-internal do advanced tasks (or return)
1638 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1639 ;; which are run before and after each user command.
1641 ;; return value from completing-read is stored in ido-final-text
1642 ;; - ido-exit may cause further actions to be taken:
1643 ;; 'refresh - repeat loop (make-item-list, set-matches)
1644 ;; 'edit - edit the prompt string, then repeat loop
1645 ;; 'keep - repeat loop but don't (re)make-item-list
1646 ;; 'updir - go up one directory, repeat loop
1647 ;; else set ido-selected based on ido-final-text,
1648 ;; optionally update ido-current-directory and repeat loop, or
1649 ;; exit with the return value of ido-selected (file name)
1650 ;; selected file name is returned from ido-read-internal,
1651 ;; ido-exit and method determines what action is taken
1652 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1653 ;; the relevant function is called (find-file, write-file, etc).
1655 (defun ido-read-internal (item prompt history &optional default require-match initial)
1656 "Perform the ido-read-buffer and ido-read-file-name functions.
1657 Return the name of a buffer or file selected.
1658 PROMPT is the prompt to give to the user.
1659 DEFAULT if given is the default directory to start with.
1660 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1661 If INITIAL is non-nil, it specifies the initial input string."
1662 (let
1663 ((ido-cur-item item)
1664 (ido-entry-buffer (current-buffer))
1665 (ido-process-ignore-lists t)
1666 (ido-process-ignore-lists-inhibit nil)
1667 (ido-set-default-item t)
1668 ido-default-item
1669 ido-selected
1670 ido-final-text
1671 (done nil)
1672 (icomplete-mode nil) ;; prevent icomplete starting up
1673 ;; Exported dynamic variables:
1674 ido-cur-list
1675 ido-ignored-list
1676 (ido-rotate-temp nil)
1677 (ido-keep-item-list nil)
1678 (ido-use-merged-list nil)
1679 (ido-try-merged-list t)
1680 (ido-pre-merge-state nil)
1681 (ido-case-fold ido-case-fold)
1682 (ido-enable-prefix ido-enable-prefix)
1683 (ido-enable-regexp ido-enable-regexp)
1686 (ido-define-mode-map)
1687 (setq ido-text-init initial)
1688 (setq ido-input-stack nil)
1690 (run-hooks 'ido-setup-hook)
1692 (while (not done)
1693 (ido-trace "\n_LOOP_" ido-text-init)
1694 (setq ido-exit nil)
1695 (setq ido-rescan t)
1696 (setq ido-rotate nil)
1697 (setq ido-text "")
1698 (when ido-set-default-item
1699 (setq ido-default-item
1700 (cond
1701 ((eq item 'buffer)
1702 (if (bufferp default) (buffer-name default) default))
1703 ((stringp default) default)
1704 ((eq item 'file)
1705 (and ido-enable-last-directory-history
1706 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1707 (and d (cdr d)))))))
1708 (if (member ido-default-item ido-ignore-item-temp-list)
1709 (setq ido-default-item nil))
1710 (setq ido-set-default-item nil))
1712 (if ido-process-ignore-lists-inhibit
1713 (setq ido-process-ignore-lists nil))
1715 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1716 (let ((olist ido-cur-list)
1717 (oign ido-ignored-list)
1718 (omat ido-matches)
1719 (l (ido-make-merged-file-list ido-text-init
1720 (eq ido-use-merged-list 'auto)
1721 (eq ido-try-merged-list 'wide))))
1722 (ido-trace "merged" l)
1723 (cond
1724 ((not l)
1725 (if (eq ido-try-merged-list 'wide)
1726 (setq ido-pre-merge-state
1727 (list "" ido-current-directory olist oign omat)
1728 ido-cur-list nil
1729 ido-ignored-list nil
1730 ido-matches nil
1731 ido-keep-item-list t
1732 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1733 ido-use-merged-list nil)
1734 (setq ido-cur-list olist
1735 ido-ignored-list oign
1736 ido-matches omat
1737 ido-keep-item-list t
1738 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1739 ido-use-merged-list nil)))
1740 ((eq l t)
1741 (setq ido-use-merged-list nil))
1742 ((eq l 'input-pending-p)
1743 (setq ido-try-merged-list t
1744 ido-use-merged-list nil))
1746 (setq ido-pre-merge-state
1747 (list ido-text-init ido-current-directory olist oign omat))
1748 (ido-set-current-directory (car (cdr (car l))))
1749 (if (ido-final-slash ido-text-init)
1750 (setq ido-text-init ""))
1751 (setq ido-cur-list l
1752 ido-ignored-list nil
1753 ido-matches l
1754 ido-rescan nil
1755 ido-keep-item-list t
1756 ido-use-merged-list t)
1757 (ido-trace "Merged" t)
1758 ))))
1760 (cond
1761 (ido-keep-item-list
1762 (setq ido-keep-item-list nil
1763 ido-rescan nil))
1764 ((eq ido-cur-item 'file)
1765 (setq ido-ignored-list nil
1766 ido-cur-list (and (not ido-directory-nonreadable)
1767 (not ido-directory-too-big)
1768 (ido-make-file-list ido-default-item))))
1769 ((eq ido-cur-item 'dir)
1770 (setq ido-ignored-list nil
1771 ido-cur-list (and (not ido-directory-nonreadable)
1772 (not ido-directory-too-big)
1773 (ido-make-dir-list ido-default-item))))
1774 ((eq ido-cur-item 'buffer)
1775 (setq ido-ignored-list nil
1776 ido-cur-list (ido-make-buffer-list ido-default-item)))
1777 ((eq ido-cur-item 'list)
1778 (setq ido-ignored-list nil
1779 ido-cur-list (ido-make-choice-list ido-default-item)))
1780 (t nil))
1781 (setq ido-rotate-temp nil)
1783 (if ido-process-ignore-lists-inhibit
1784 (setq ido-process-ignore-lists t
1785 ido-process-ignore-lists-inhibit nil))
1787 (ido-set-matches)
1788 (if (and ido-matches (eq ido-try-merged-list 'auto))
1789 (setq ido-try-merged-list t))
1790 (let
1791 ((minibuffer-local-completion-map ido-mode-map)
1792 (max-mini-window-height (or ido-max-window-height
1793 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1794 (ido-completing-read t)
1795 (ido-require-match require-match)
1796 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1797 (show-paren-mode nil))
1798 ;; prompt the user for the file name
1799 (setq ido-exit nil)
1800 (setq ido-final-text
1801 (catch 'ido
1802 (completing-read
1803 (ido-make-prompt item prompt)
1804 '(("dummy" . 1)) nil nil ; table predicate require-match
1805 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1806 history))))
1807 (ido-trace "completing-read" ido-final-text)
1808 (if (get-buffer ido-completion-buffer)
1809 (kill-buffer ido-completion-buffer))
1811 (ido-trace "\n_EXIT_" ido-exit)
1813 (cond
1814 ((eq ido-exit 'refresh)
1815 (if (and (eq ido-use-merged-list 'auto)
1816 (or (input-pending-p)))
1817 (setq ido-use-merged-list nil
1818 ido-keep-item-list t))
1819 nil)
1821 ((eq ido-exit 'done)
1822 (setq done t
1823 ido-selected ido-text
1824 ido-exit nil))
1826 ((memq ido-exit '(edit chdir))
1827 (cond
1828 ((memq ido-cur-item '(file dir))
1829 (let* ((read-file-name-function nil)
1830 (edit (eq ido-exit 'edit))
1831 (d ido-current-directory)
1832 (f ido-text-init)
1833 (new t))
1834 (setq ido-text-init "")
1835 (while new
1836 (setq new (if edit
1837 (condition-case nil
1838 (read-file-name (concat prompt "[EDIT] ")
1839 (expand-file-name d)
1840 (concat d f) nil f)
1841 (quit (concat d f)))
1843 d (or (file-name-directory new) "/")
1844 f (file-name-nondirectory new)
1845 edit t)
1846 (if (or
1847 (file-directory-p d)
1848 (and (yes-or-no-p (format "Create directory %s? " d))
1849 (condition-case nil
1850 (progn (make-directory d t) t)
1851 (error
1852 (message "Could not create directory")
1853 (sit-for 1)
1854 nil))))
1855 (progn
1856 (ido-set-current-directory d nil (eq ido-exit 'chdir))
1857 (setq ido-text-init f
1858 new nil))))))
1860 (setq ido-text-init
1861 (condition-case nil
1862 (read-string (concat prompt "[EDIT] ") ido-final-text)
1863 (quit ido-final-text)))))
1865 nil)
1867 ((eq ido-exit 'keep)
1868 (setq ido-keep-item-list t))
1870 ((memq ido-exit '(dired fallback find-file switch-to-buffer insert-buffer insert-file))
1871 (setq done t))
1873 ((memq ido-exit '(updir push))
1874 ;; cannot go up if already at the root-dir (Unix) or at the
1875 ;; root-dir of a certain drive (Windows or MS-DOS).
1876 (if (ido-is-tramp-root)
1877 (when (string-match "\\`\\(/\\([^/]+[:@]\\)*\\)\\([^/]+\\)[:@]\\'" ido-current-directory)
1878 (setq ido-text-init (match-string 3 ido-current-directory))
1879 (ido-set-current-directory (match-string 1 ido-current-directory))
1880 (setq ido-set-default-item t))
1881 (unless (ido-is-root-directory)
1882 (when (eq ido-exit 'push)
1883 (setq ido-input-stack (cons (cons ido-cur-item ido-text) ido-input-stack))
1884 (setq ido-cur-item 'dir)
1885 (setq ido-text-init (file-name-nondirectory (substring ido-current-directory 0 -1)))
1886 (ido-trace "push" ido-input-stack))
1887 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1)))
1888 (setq ido-set-default-item t))))
1890 ((eq ido-exit 'pop)
1891 (ido-trace "pop" ido-input-stack)
1892 (let ((elt (car ido-input-stack)))
1893 (setq ido-input-stack (cdr ido-input-stack))
1894 (ido-set-current-directory (concat ido-current-directory ido-text))
1895 (setq ido-cur-item (car elt))
1896 (setq ido-text-init (cdr elt))))
1898 ((eq ido-exit 'pop-all)
1899 (ido-trace "pop-all" ido-input-stack)
1900 (while ido-input-stack
1901 (let ((elt (car ido-input-stack)))
1902 (setq ido-input-stack (cdr ido-input-stack))
1903 (ido-set-current-directory (concat ido-current-directory ido-text))
1904 (setq ido-cur-item (car elt))
1905 (setq ido-text-init (cdr elt)))))
1907 ;; Handling the require-match must be done in a better way.
1908 ((and require-match
1909 (not (if ido-directory-too-big
1910 (file-exists-p (concat ido-current-directory ido-final-text))
1911 (ido-existing-item-p))))
1912 (error "must specify valid item"))
1915 (setq ido-selected
1916 (if (or (eq ido-exit 'takeprompt)
1917 (null ido-matches))
1918 ido-final-text
1919 ;; else take head of list
1920 (ido-name (car ido-matches))))
1922 (cond
1923 ((memq item '(buffer list))
1924 (setq done t))
1926 ((string-equal "./" ido-selected)
1927 nil)
1929 ((string-equal "../" ido-selected)
1930 ;; cannot go up if already at the root-dir (Unix) or at the
1931 ;; root-dir of a certain drive (Windows or MS-DOS).
1932 (or (ido-is-root-directory)
1933 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1934 (setq ido-set-default-item t))
1936 ((and (string-match (if ido-enable-tramp-completion "..[:@]\\'" "..:\\'") ido-selected)
1937 (ido-is-root-directory)) ;; Ange-ftp or Tramp
1938 (ido-set-current-directory ido-current-directory ido-selected)
1939 (ido-trace "tramp prefix" ido-selected)
1940 (if (ido-is-slow-ftp-host)
1941 (setq ido-exit 'fallback
1942 done t)
1943 (setq ido-set-default-item t)))
1944 ((or (string-match "[/\\][^/\\]" ido-selected)
1945 (and (memq system-type '(windows-nt ms-dos))
1946 (string-match "\\`.:" ido-selected)))
1947 (ido-set-current-directory (file-name-directory ido-selected))
1948 (setq ido-set-default-item t))
1950 ((string-match "\\`~" ido-selected)
1951 (ido-set-current-home ido-selected))
1953 ((ido-final-slash ido-selected)
1954 (if ido-enable-last-directory-history
1955 (let ((x (assoc ido-current-directory ido-last-directory-list)))
1956 (if x
1957 (setcdr x ido-selected)
1958 (setq ido-last-directory-list
1959 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
1960 (ido-set-current-directory ido-current-directory ido-selected)
1961 (if ido-input-stack
1962 (while ido-input-stack
1963 (let ((elt (car ido-input-stack)))
1964 (if (setq ido-input-stack (cdr ido-input-stack))
1965 (ido-set-current-directory ido-current-directory (cdr elt))
1966 (setq ido-text-init (cdr elt)))
1967 (setq ido-cur-item (car elt))))
1968 (setq ido-set-default-item t)))
1971 (setq done t))))))
1972 ido-selected))
1974 (defun ido-edit-input ()
1975 "Edit absolute file name entered so far with ido; terminate by RET."
1976 (interactive)
1977 (setq ido-text-init ido-text)
1978 (setq ido-exit 'edit)
1979 (exit-minibuffer))
1981 ;;; MAIN FUNCTIONS
1982 (defun ido-buffer-internal (method &optional fallback prompt default initial switch-cmd)
1983 ;; Internal function for ido-switch-buffer and friends
1984 (if (not ido-mode)
1985 (progn
1986 (run-hook-with-args 'ido-before-fallback-functions
1987 (or fallback 'switch-to-buffer))
1988 (call-interactively (or fallback 'switch-to-buffer)))
1989 (let* ((ido-context-switch-command switch-cmd)
1990 (ido-current-directory nil)
1991 (ido-directory-nonreadable nil)
1992 (ido-directory-too-big nil)
1993 (buf (ido-read-internal 'buffer (or prompt "Buffer: ") 'ido-buffer-history default nil initial)))
1995 ;; Choose the buffer name: either the text typed in, or the head
1996 ;; of the list of matches
1998 (cond
1999 ((eq ido-exit 'find-file)
2000 (ido-file-internal ido-default-file-method nil nil nil nil ido-text))
2002 ((eq ido-exit 'insert-file)
2003 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil ido-text 'ido-enter-insert-buffer))
2005 ((eq ido-exit 'fallback)
2006 (let ((read-buffer-function nil))
2007 (run-hook-with-args 'ido-before-fallback-functions
2008 (or fallback 'switch-to-buffer))
2009 (call-interactively (or fallback 'switch-to-buffer))))
2011 ;; Check buf is non-nil.
2012 ((not buf) nil)
2013 ((= (length buf) 0) nil)
2015 ;; View buffer if it exists
2016 ((get-buffer buf)
2017 (if (eq method 'insert)
2018 (progn
2019 (ido-record-command 'insert-buffer buf)
2020 (with-no-warnings
2021 ;; we really want to run insert-buffer here
2022 (insert-buffer buf)))
2023 (ido-visit-buffer buf method t)))
2025 ;; buffer doesn't exist
2026 ((eq ido-create-new-buffer 'never)
2027 (message "no buffer matching `%s'" buf))
2029 ((and (eq ido-create-new-buffer 'prompt)
2030 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
2031 nil)
2033 ;; create a new buffer
2035 (setq buf (get-buffer-create buf))
2036 (if (fboundp 'set-buffer-major-mode)
2037 (set-buffer-major-mode buf))
2038 (ido-visit-buffer buf method t))))))
2040 (defun ido-record-work-directory (&optional dir)
2041 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
2042 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
2043 (let ((items ido-work-directory-list-ignore-regexps)
2044 (case-fold-search nil))
2045 (while (and items dir)
2046 (if (string-match (car items) dir)
2047 (setq dir nil))
2048 (setq items (cdr items)))
2049 (if dir
2050 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
2051 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
2052 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
2054 (defun ido-forget-work-directory ()
2055 (interactive)
2056 (when (and ido-current-directory ido-work-directory-list)
2057 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
2058 (when ido-use-merged-list
2059 (ido-undo-merge-work-directory)
2060 (setq ido-exit 'refresh
2061 ido-try-merged-list t
2062 ido-use-merged-list t
2063 ido-text-init ido-text
2064 ido-rotate-temp t)
2065 (exit-minibuffer))))
2067 (defun ido-record-work-file (name)
2068 ;; Save NAME in ido-work-file-list
2069 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
2071 (and ido-work-file-list (equal (car ido-work-file-list) name))
2072 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
2073 (if (> (length ido-work-file-list) ido-max-work-file-list)
2074 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
2076 (defun ido-expand-directory (dir)
2077 ;; Expand DIR or use DEFAULT-DIRECTORY if nil.
2078 ;; Add final slash to result in case it was missing from DEFAULT-DIRECTORY.
2079 (ido-final-slash (expand-file-name (or dir default-directory)) t))
2081 (defun ido-file-internal (method &optional fallback default prompt item initial switch-cmd)
2082 ;; Internal function for ido-find-file and friends
2083 (unless item
2084 (setq item 'file))
2085 (let ((ido-current-directory (ido-expand-directory default))
2086 (ido-context-switch-command switch-cmd)
2087 ido-directory-nonreadable ido-directory-too-big
2088 (minibuffer-completing-file-name t)
2089 filename)
2091 (if (or (not ido-mode) (ido-is-slow-ftp-host))
2092 (setq filename t
2093 ido-exit 'fallback)
2094 (setq ido-directory-nonreadable
2095 (ido-nonreadable-directory-p ido-current-directory)
2096 ido-directory-too-big
2097 (and (not ido-directory-nonreadable)
2098 (ido-directory-too-big-p ido-current-directory))))
2100 (when (and (eq item 'file)
2101 (or ido-use-url-at-point ido-use-filename-at-point))
2102 (let (fn d)
2103 (require 'ffap)
2104 ;; Duplicate code from ffap-guesser as we want different behaviour for files and URLs.
2105 (cond
2106 ((with-no-warnings
2107 (and ido-use-url-at-point
2108 ffap-url-regexp
2109 (ffap-fixup-url (or (ffap-url-at-point)
2110 (ffap-gopher-at-point)))))
2111 (setq ido-exit 'ffap
2112 filename t))
2114 ((and ido-use-filename-at-point
2115 (setq fn (if (eq ido-use-filename-at-point 'guess)
2116 (with-no-warnings (ffap-guesser))
2117 (ffap-string-at-point)))
2118 (not (string-match "^http:/" fn))
2119 (setq d (file-name-directory fn))
2120 (file-directory-p d))
2121 (setq ido-current-directory d)
2122 (setq initial (file-name-nondirectory fn))))))
2124 (let (ido-saved-vc-hb
2125 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
2126 (ido-work-directory-index -1)
2127 (ido-work-file-index -1)
2128 (ido-find-literal nil))
2130 (unless filename
2131 (setq ido-saved-vc-hb vc-handled-backends)
2132 (setq filename (ido-read-internal item
2133 (or prompt "Find file: ")
2134 'ido-file-history nil nil initial)))
2136 ;; Choose the file name: either the text typed in, or the head
2137 ;; of the list of matches
2139 (cond
2140 ((eq ido-exit 'fallback)
2141 ;; Need to guard setting of default-directory here, since
2142 ;; we don't want to change directory of current buffer.
2143 (let ((default-directory ido-current-directory)
2144 (read-file-name-function nil))
2145 (run-hook-with-args 'ido-before-fallback-functions
2146 (or fallback 'find-file))
2147 (call-interactively (or fallback 'find-file))))
2149 ((eq ido-exit 'switch-to-buffer)
2150 (ido-buffer-internal ido-default-buffer-method nil nil nil ido-text))
2152 ((eq ido-exit 'insert-buffer)
2153 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil ido-text 'ido-enter-insert-file))
2155 ((eq ido-exit 'dired)
2156 (dired (concat ido-current-directory (or ido-text ""))))
2158 ((eq ido-exit 'ffap)
2159 (find-file-at-point))
2161 ((eq method 'alt-file)
2162 (ido-record-work-file filename)
2163 (setq default-directory ido-current-directory)
2164 (ido-record-work-directory)
2165 (find-alternate-file filename))
2167 ((memq method '(dired list-directory))
2168 (if (equal filename ".")
2169 (setq filename ""))
2170 (let* ((dirname (ido-final-slash (concat ido-current-directory filename) t))
2171 (file (substring dirname 0 -1)))
2172 (cond
2173 ((file-directory-p dirname)
2174 (ido-record-command method dirname)
2175 (ido-record-work-directory dirname)
2176 (funcall method dirname))
2177 ((file-directory-p ido-current-directory)
2178 (cond
2179 ((file-exists-p file)
2180 (ido-record-command method ido-current-directory)
2181 (ido-record-work-directory)
2182 (funcall method ido-current-directory)
2183 (if (eq method 'dired)
2184 (with-no-warnings
2185 (dired-goto-file (expand-file-name file)))))
2186 ((string-match "[[*?]" filename)
2187 (setq dirname (concat ido-current-directory filename))
2188 (ido-record-command method dirname)
2189 (ido-record-work-directory)
2190 (funcall method dirname))
2191 ((y-or-n-p (format "Directory %s does not exist. Create it? " filename))
2192 (ido-record-command method dirname)
2193 (ido-record-work-directory dirname)
2194 (make-directory-internal dirname)
2195 (funcall method dirname))
2197 ;; put make-directory command on history
2198 (ido-record-command 'make-directory dirname))))
2199 (t (error "No such directory")))))
2201 ((eq method 'write)
2202 (ido-record-work-file filename)
2203 (setq default-directory ido-current-directory)
2204 (ido-record-command 'write-file (concat ido-current-directory filename))
2205 (ido-record-work-directory)
2206 (write-file filename))
2208 ((eq method 'read-only)
2209 (ido-record-work-file filename)
2210 (setq filename (concat ido-current-directory filename))
2211 (ido-record-command fallback filename)
2212 (ido-record-work-directory)
2213 (run-hook-with-args 'ido-before-fallback-functions fallback)
2214 (funcall fallback filename))
2216 ((eq method 'insert)
2217 (ido-record-work-file filename)
2218 (setq filename (concat ido-current-directory filename))
2219 (ido-record-command
2220 (if ido-find-literal 'insert-file-literally 'insert-file)
2221 filename)
2222 (ido-record-work-directory)
2223 (if ido-find-literal
2224 (insert-file-contents-literally filename)
2225 (insert-file-contents filename)))
2227 (filename
2228 (ido-record-work-file filename)
2229 (setq filename (concat ido-current-directory filename))
2230 (ido-record-command 'find-file filename)
2231 (ido-record-work-directory)
2232 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
2234 (defun ido-existing-item-p ()
2235 ;; Return non-nil if there is a matching item
2236 (not (null ido-matches)))
2238 ;;; COMPLETION CODE
2240 (defun ido-set-common-completion ()
2241 ;; Find common completion of `ido-text' in `ido-matches'
2242 ;; The result is stored in `ido-common-match-string'
2243 (let* (val)
2244 (setq ido-common-match-string nil)
2245 (if (and ido-matches
2246 (not ido-enable-regexp) ;; testing
2247 (stringp ido-text)
2248 (> (length ido-text) 0))
2249 (if (setq val (ido-find-common-substring ido-matches ido-text))
2250 (setq ido-common-match-string val)))
2251 val))
2253 (defun ido-complete ()
2254 "Try and complete the current pattern amongst the file names."
2255 (interactive)
2256 (let (res)
2257 (cond
2258 (ido-incomplete-regexp
2259 ;; Do nothing
2261 ((and (memq ido-cur-item '(file dir))
2262 (string-match "[$]" ido-text))
2263 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
2264 (if (not (file-exists-p (file-name-directory evar)))
2265 (message "Expansion generates non-existing directory name")
2266 (if (file-directory-p evar)
2267 (ido-set-current-directory evar)
2268 (let ((d (or (file-name-directory evar) "/"))
2269 (f (file-name-nondirectory evar)))
2270 (when (file-directory-p d)
2271 (ido-set-current-directory d)
2272 (setq ido-text-init f))))
2273 (setq ido-exit 'refresh)
2274 (exit-minibuffer))))
2276 (ido-directory-too-big
2277 (setq ido-directory-too-big nil)
2278 (setq ido-text-init ido-text)
2279 (setq ido-exit 'refresh)
2280 (exit-minibuffer))
2282 ((not ido-matches)
2283 (when ido-completion-buffer
2284 (call-interactively (setq this-command ido-cannot-complete-command))))
2286 ((and (= 1 (length ido-matches))
2287 (not (and ido-enable-tramp-completion
2288 (string-equal ido-current-directory "/")
2289 (string-match "..[@:]\\'" (car ido-matches)))))
2290 ;; only one choice, so select it.
2291 (if (not ido-confirm-unique-completion)
2292 (exit-minibuffer)
2293 (setq ido-rescan (not ido-enable-prefix))
2294 (delete-region (minibuffer-prompt-end) (point))
2295 (insert (car ido-matches))))
2297 (t ;; else there could be some completions
2298 (setq res ido-common-match-string)
2299 (if (and (not (memq res '(t nil)))
2300 (not (equal res ido-text)))
2301 ;; found something to complete, so put it in the minibuffer.
2302 (progn
2303 ;; move exact match to front if not in prefix mode
2304 (setq ido-rescan (not ido-enable-prefix))
2305 (delete-region (minibuffer-prompt-end) (point))
2306 (insert res))
2307 ;; else nothing to complete
2308 (call-interactively (setq this-command ido-cannot-complete-command))
2309 )))))
2311 (defun ido-complete-space ()
2312 "Try completion unless inserting the space makes sense."
2313 (interactive)
2314 (if (and (stringp ido-common-match-string)
2315 (stringp ido-text)
2316 (cond
2317 ((> (length ido-common-match-string) (length ido-text))
2318 (= (aref ido-common-match-string (length ido-text)) ? ))
2319 (ido-matches
2320 (let (insert-space
2321 (re (concat (regexp-quote ido-text) " "))
2322 (comp ido-matches))
2323 (while comp
2324 (if (string-match re (ido-name (car comp)))
2325 (setq comp nil insert-space t)
2326 (setq comp (cdr comp))))
2327 insert-space))
2328 (t nil)))
2329 (insert " ")
2330 (ido-complete)))
2332 (defun ido-undo-merge-work-directory (&optional text try refresh)
2333 "Undo or redo last ido directory merge operation.
2334 If no merge has yet taken place, toggle automatic merging option."
2335 (interactive)
2336 (cond
2337 (ido-pre-merge-state
2338 (ido-set-current-directory (nth 1 ido-pre-merge-state))
2339 (setq ido-text-init (or text (car ido-pre-merge-state))
2340 ido-cur-list (nth 2 ido-pre-merge-state)
2341 ido-ignored-list (nth 3 ido-pre-merge-state)
2342 ido-matches (nth 4 ido-pre-merge-state)
2343 ido-use-merged-list nil
2344 ido-try-merged-list try
2345 ido-keep-item-list (not refresh)
2346 ido-rescan nil
2347 ido-exit 'refresh
2348 ido-pre-merge-state nil)
2349 (exit-minibuffer))
2350 (text
2351 nil)
2352 (ido-try-merged-list
2353 (setq ido-try-merged-list nil))
2354 (ido-matches
2355 (setq ido-try-merged-list t))
2356 ((not ido-use-merged-list)
2357 (ido-merge-work-directories))))
2359 ;;; Magic C-f
2361 (defun ido-magic-forward-char ()
2362 "Move forward in user input or perform magic action.
2363 If no user input is present, or at end of input, perform magic actions:
2364 C-x C-b ... C-f switch to ido-find-file.
2365 C-x C-f ... C-f fallback to non-ido find-file.
2366 C-x C-d ... C-f fallback to non-ido brief dired.
2367 C-x d ... C-f fallback to non-ido dired."
2368 (interactive)
2369 (cond
2370 ((not (eobp))
2371 (forward-char 1))
2372 ((memq ido-cur-item '(file dir))
2373 (ido-fallback-command))
2374 (ido-context-switch-command
2375 (call-interactively ido-context-switch-command))
2376 ((eq ido-cur-item 'buffer)
2377 (ido-enter-find-file))))
2379 ;;; Magic C-b
2381 (defun ido-magic-backward-char ()
2382 "Move backward in user input or perform magic action.
2383 If no user input is present, or at start of input, perform magic actions:
2384 C-x C-f C-b switch to ido-switch-buffer.
2385 C-x C-d C-b switch to ido-switch-buffer.
2386 C-x d C-b switch to ido-switch-buffer.
2387 C-x C-b C-b fallback to non-ido switch-to-buffer."
2388 (interactive)
2389 (cond
2390 ((> (point) (minibuffer-prompt-end))
2391 (forward-char -1))
2392 ((eq ido-cur-item 'buffer)
2393 (ido-fallback-command))
2394 (ido-context-switch-command
2395 (call-interactively ido-context-switch-command))
2397 (ido-enter-switch-buffer))))
2399 ;;; Magic C-d
2401 (defun ido-magic-delete-char ()
2402 "Delete following char in user input or perform magic action.
2403 If at end of user input, perform magic actions:
2404 C-x C-f ... C-d enter dired on current directory."
2405 (interactive)
2406 (cond
2407 ((not (eobp))
2408 (delete-char 1))
2409 (ido-context-switch-command
2410 nil)
2411 ((memq ido-cur-item '(file dir))
2412 (ido-enter-dired))))
2415 ;;; TOGGLE FUNCTIONS
2417 (defun ido-toggle-case ()
2418 "Toggle the value of `ido-case-fold'."
2419 (interactive)
2420 (setq ido-case-fold (not ido-case-fold))
2421 ;; ask for list to be regenerated.
2422 (setq ido-rescan t))
2424 (defun ido-toggle-regexp ()
2425 "Toggle the value of `ido-enable-regexp'."
2426 (interactive)
2427 (setq ido-enable-regexp (not ido-enable-regexp))
2428 ;; ask for list to be regenerated.
2429 (setq ido-rescan t))
2431 (defun ido-toggle-prefix ()
2432 "Toggle the value of `ido-enable-prefix'."
2433 (interactive)
2434 (setq ido-enable-prefix (not ido-enable-prefix))
2435 ;; ask for list to be regenerated.
2436 (setq ido-rescan t))
2438 (defun ido-toggle-ignore ()
2439 "Toggle ignoring files specified with `ido-ignore-files'."
2440 (interactive)
2441 (if ido-directory-too-big
2442 (setq ido-directory-too-big nil)
2443 (setq ido-process-ignore-lists (not ido-process-ignore-lists)))
2444 (setq ido-text-init ido-text)
2445 (setq ido-exit 'refresh)
2446 (exit-minibuffer))
2448 (defun ido-toggle-vc ()
2449 "Disable version control for this file."
2450 (interactive)
2451 (if (and ido-mode (eq ido-cur-item 'file))
2452 (progn
2453 (setq vc-handled-backends
2454 (if vc-handled-backends nil ido-saved-vc-hb))
2455 (setq ido-text-init ido-text)
2456 (setq ido-exit 'keep)
2457 (exit-minibuffer))))
2459 (defun ido-toggle-literal ()
2460 "Toggle literal reading of this file."
2461 (interactive)
2462 (if (and ido-mode (eq ido-cur-item 'file))
2463 (progn
2464 (setq ido-find-literal (not ido-find-literal))
2465 (setq ido-text-init ido-text)
2466 (setq ido-exit 'keep)
2467 (exit-minibuffer))))
2469 (defun ido-reread-directory ()
2470 "Read current directory again.
2471 May be useful if cached version is no longer valid, but directory
2472 timestamp has not changed (e.g. with ftp or on Windows)."
2473 (interactive)
2474 (if (and ido-mode (eq ido-cur-item 'file))
2475 (progn
2476 (ido-remove-cached-dir ido-current-directory)
2477 (setq ido-text-init ido-text)
2478 (setq ido-rotate-temp t)
2479 (setq ido-exit 'refresh)
2480 (exit-minibuffer))))
2482 (defun ido-exit-minibuffer ()
2483 "Exit minibuffer, but make sure we have a match if one is needed."
2484 (interactive)
2485 (if (and (or (not ido-require-match)
2486 (ido-existing-item-p))
2487 (not ido-incomplete-regexp))
2488 (exit-minibuffer)))
2490 (defun ido-select-text ()
2491 "Select the buffer or file named by the prompt.
2492 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2493 (interactive)
2494 (setq ido-exit 'takeprompt)
2495 (exit-minibuffer))
2497 (defun ido-fallback-command ()
2498 "Fallback to non-ido version of current command."
2499 (interactive)
2500 (let ((i (length ido-text)))
2501 (while (> i 0)
2502 (push (aref ido-text (setq i (1- i))) unread-command-events)))
2503 (setq ido-exit 'fallback)
2504 (exit-minibuffer))
2506 (defun ido-enter-find-file ()
2507 "Drop into `find-file' from buffer switching."
2508 (interactive)
2509 (setq ido-exit 'find-file)
2510 (exit-minibuffer))
2512 (defun ido-enter-switch-buffer ()
2513 "Drop into `ido-switch-buffer' from file switching."
2514 (interactive)
2515 (setq ido-exit 'switch-to-buffer)
2516 (exit-minibuffer))
2518 (defun ido-enter-dired ()
2519 "Drop into dired from file switching."
2520 (interactive)
2521 (setq ido-exit 'dired)
2522 (exit-minibuffer))
2524 (defun ido-enter-insert-buffer ()
2525 "Drop into insert buffer from insert file."
2526 (interactive)
2527 (setq ido-exit 'insert-buffer)
2528 (exit-minibuffer))
2530 (defun ido-enter-insert-file ()
2531 "Drop into insert file from insert buffer."
2532 (interactive)
2533 (setq ido-exit 'insert-file)
2534 (exit-minibuffer))
2537 (defun ido-up-directory (&optional clear)
2538 "Go up one directory level."
2539 (interactive "P")
2540 (setq ido-text-init (if clear nil ido-text))
2541 (setq ido-exit 'updir)
2542 (setq ido-rotate-temp t)
2543 (exit-minibuffer))
2545 (defun ido-delete-backward-updir (count)
2546 "Delete char backwards, or at beginning of buffer, go up one level."
2547 (interactive "P")
2548 (cond
2549 ((= (minibuffer-prompt-end) (point))
2550 (if (not count)
2551 (ido-up-directory t)))
2552 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2553 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2554 ((eq this-original-command 'viper-backward-char)
2555 (funcall this-original-command (prefix-numeric-value count)))
2556 ((eq this-original-command 'viper-del-backward-char-in-insert)
2557 (funcall this-original-command))
2559 (delete-backward-char (prefix-numeric-value count)))))
2561 (defun ido-delete-backward-word-updir (count)
2562 "Delete all chars backwards, or at beginning of buffer, go up one level."
2563 (interactive "P")
2564 (if (= (minibuffer-prompt-end) (point))
2565 (if (not count)
2566 (ido-up-directory t))
2567 (if (eq this-original-command 'viper-delete-backward-word)
2568 (funcall this-original-command (prefix-numeric-value count))
2569 (backward-kill-word (prefix-numeric-value count)))))
2571 (defun ido-get-work-directory (&optional incr must-match)
2572 (let ((n (length ido-work-directory-list))
2573 (i ido-work-directory-index)
2574 (j 0)
2575 dir)
2576 (if (or (not ido-text) (= (length ido-text) 0))
2577 (setq must-match nil))
2578 (while (< j n)
2579 (setq i (+ i incr)
2580 j (1+ j))
2581 (if (> incr 0)
2582 (if (>= i n) (setq i 0))
2583 (if (< i 0) (setq i (1- n))))
2584 (setq dir (nth i ido-work-directory-list))
2585 (if (and dir
2586 (not (equal dir ido-current-directory))
2587 (file-directory-p dir)
2588 (or (not must-match)
2589 ;; TODO. check for nonreadable and too-big.
2590 (ido-set-matches-1
2591 (if (eq ido-cur-item 'file)
2592 (ido-make-file-list-1 dir)
2593 (ido-make-dir-list-1 dir)))))
2594 (setq j n)
2595 (setq dir nil)))
2596 (if dir
2597 (setq ido-work-directory-index i))
2598 dir))
2600 (defun ido-prev-work-directory ()
2601 "Change to next working directory in list."
2602 (interactive)
2603 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2604 (when dir
2605 (ido-set-current-directory dir)
2606 (setq ido-exit 'refresh)
2607 (setq ido-text-init ido-text)
2608 (setq ido-rotate-temp t)
2609 (exit-minibuffer))))
2611 (defun ido-next-work-directory ()
2612 "Change to previous working directory in list."
2613 (interactive)
2614 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2615 (when dir
2616 (ido-set-current-directory dir)
2617 (setq ido-exit 'refresh)
2618 (setq ido-text-init ido-text)
2619 (setq ido-rotate-temp t)
2620 (exit-minibuffer))))
2622 (defun ido-merge-work-directories ()
2623 "Search (and merge) work directories for files matching the current input string."
2624 (interactive)
2625 (setq ido-use-merged-list t ido-try-merged-list t)
2626 (setq ido-exit 'refresh)
2627 (setq ido-text-init ido-text)
2628 (setq ido-rotate-temp t)
2629 (exit-minibuffer))
2631 (defun ido-wide-find-file (&optional file)
2632 "Prompt for FILE to search for using find, starting from current directory."
2633 (interactive)
2634 (unless file
2635 (let ((enable-recursive-minibuffers t))
2636 (setq file
2637 (condition-case nil
2638 (read-string (concat "Wide find file: " ido-current-directory) ido-text)
2639 (quit "")))))
2640 (when (> (length file) 0)
2641 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2642 (setq ido-exit 'refresh)
2643 (setq ido-text-init file)
2644 (setq ido-rotate-temp t)
2645 (exit-minibuffer)))
2647 (defun ido-wide-find-dir (&optional dir)
2648 "Prompt for DIR to search for using find, starting from current directory."
2649 (interactive)
2650 (unless dir
2651 (let ((enable-recursive-minibuffers t))
2652 (setq dir
2653 (condition-case nil
2654 (read-string (concat "Wide find directory: " ido-current-directory) ido-text)
2655 (quit "")))))
2656 (when (> (length dir) 0)
2657 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2658 (setq ido-exit 'refresh)
2659 (setq ido-text-init (ido-final-slash dir t))
2660 (setq ido-rotate-temp t)
2661 (exit-minibuffer)))
2663 (defun ido-wide-find-dir-or-delete-dir (&optional dir)
2664 "Prompt for DIR to search for using find, starting from current directory.
2665 If input stack is non-empty, delete current directory component."
2666 (interactive)
2667 (if ido-input-stack
2668 (ido-delete-backward-word-updir 1)
2669 (ido-wide-find-dir)))
2671 (defun ido-push-dir ()
2672 "Move to previous directory in file name, push current input on stack."
2673 (interactive)
2674 (setq ido-exit 'push)
2675 (exit-minibuffer))
2677 (defun ido-pop-dir (arg)
2678 "Pop directory from input stack back to input.
2679 With \\[universal-argument], pop all element."
2680 (interactive "P")
2681 (when ido-input-stack
2682 (setq ido-exit (if arg 'pop-all 'pop))
2683 (exit-minibuffer)))
2685 (defun ido-wide-find-file-or-pop-dir (arg)
2686 (interactive "P")
2687 (if ido-input-stack
2688 (ido-pop-dir arg)
2689 (ido-wide-find-file)))
2691 (defun ido-make-directory (&optional dir)
2692 "Prompt for DIR to create in current directory."
2693 (interactive)
2694 (unless dir
2695 (let ((enable-recursive-minibuffers t))
2696 (setq dir
2697 (read-string (concat "Make directory: " ido-current-directory) ido-text))))
2698 (when (> (length dir) 0)
2699 (setq dir (concat ido-current-directory dir))
2700 (unless (file-exists-p dir)
2701 (make-directory dir t)
2702 (ido-set-current-directory dir)
2703 (setq ido-exit 'refresh)
2704 (setq ido-text-init nil)
2705 (setq ido-rotate-temp t)
2706 (exit-minibuffer))))
2708 (defun ido-get-work-file (incr)
2709 (let ((n (length ido-work-file-list))
2710 (i (+ ido-work-file-index incr))
2711 name)
2712 (if (> incr 0)
2713 (if (>= i n) (setq i 0))
2714 (if (< i 0) (setq i (1- n))))
2715 (setq name (nth i ido-work-file-list))
2716 (setq ido-work-file-index i)
2717 name))
2719 (defun ido-prev-work-file ()
2720 "Change to next working file name in list."
2721 (interactive)
2722 (let ((name (ido-get-work-file 1)))
2723 (when name
2724 (setq ido-text-init name)
2725 (setq ido-exit 'refresh)
2726 (exit-minibuffer))))
2728 (defun ido-next-work-file ()
2729 "Change to previous working file name in list."
2730 (interactive)
2731 (let ((name (ido-get-work-file -1)))
2732 (when name
2733 (setq ido-text-init name)
2734 (setq ido-exit 'refresh)
2735 (exit-minibuffer))))
2737 (defun ido-copy-current-file-name (all)
2738 "Insert file name of current buffer.
2739 If repeated, insert text from buffer instead."
2740 (interactive "P")
2741 (let* ((bfname (buffer-file-name ido-entry-buffer))
2742 (name (and bfname (file-name-nondirectory bfname))))
2743 (when name
2744 (setq ido-text-init
2745 (if (or all
2746 (not (equal (file-name-directory bfname) ido-current-directory))
2747 (not (string-match "\\.[^.]*\\'" name)))
2748 name
2749 (substring name 0 (1+ (match-beginning 0)))))
2750 (setq ido-exit 'refresh
2751 ido-try-merged-list nil)
2752 (exit-minibuffer))))
2754 (defun ido-copy-current-word (all)
2755 "Insert current word (file or directory name) from current buffer."
2756 (interactive "P")
2757 (let ((word (save-excursion
2758 (set-buffer ido-entry-buffer)
2759 (let ((p (point)) start-line end-line start-name name)
2760 (beginning-of-line)
2761 (setq start-line (point))
2762 (end-of-line)
2763 (setq end-line (point))
2764 (goto-char p)
2765 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
2766 (forward-char 1))
2767 (setq start-name (point))
2768 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
2769 (if (= start-name (point))
2771 (buffer-substring-no-properties start-name (point)))))))
2772 (if (cond
2773 ((not word) nil)
2774 ((string-match "\\`[~/]" word)
2775 (setq ido-text-init word
2776 ido-try-merged-list nil
2777 ido-exit 'chdir))
2778 ((string-match "/" word)
2779 (setq ido-text-init (concat ido-current-directory word)
2780 ido-try-merged-list nil
2781 ido-exit 'chdir))
2783 (setq ido-text-init word
2784 ido-try-merged-list nil
2785 ido-exit 'refresh)))
2786 (exit-minibuffer))))
2788 (defun ido-next-match ()
2789 "Put first element of `ido-matches' at the end of the list."
2790 (interactive)
2791 (if ido-matches
2792 (let ((next (cadr ido-matches)))
2793 (setq ido-cur-list (ido-chop ido-cur-list next))
2794 (setq ido-rescan t)
2795 (setq ido-rotate t))))
2797 (defun ido-prev-match ()
2798 "Put last element of `ido-matches' at the front of the list."
2799 (interactive)
2800 (if ido-matches
2801 (let ((prev (car (last ido-matches))))
2802 (setq ido-cur-list (ido-chop ido-cur-list prev))
2803 (setq ido-rescan t)
2804 (setq ido-rotate t))))
2806 (defun ido-next-match-dir ()
2807 "Find next directory in match list.
2808 If work directories have been merged, cycle through directories for
2809 first matching file."
2810 (interactive)
2811 (if ido-use-merged-list
2812 (if ido-matches
2813 (let* ((elt (car ido-matches))
2814 (dirs (cdr elt)))
2815 (when (> (length dirs) 1)
2816 (setcdr elt (ido-chop dirs (cadr dirs))))
2817 (setq ido-rescan nil)))
2818 (let ((cnt (length ido-matches))
2819 (i 1))
2820 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
2821 (setq i (1+ i)))
2822 (if (< i cnt)
2823 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2825 (defun ido-prev-match-dir ()
2826 "Find previous directory in match list.
2827 If work directories have been merged, cycle through directories
2828 for first matching file."
2829 (interactive)
2830 (if ido-use-merged-list
2831 (if ido-matches
2832 (let* ((elt (car ido-matches))
2833 (dirs (cdr elt)))
2834 (when (> (length dirs) 1)
2835 (setcdr elt (ido-chop dirs (car (last dirs)))))
2836 (setq ido-rescan nil)))
2837 (let* ((cnt (length ido-matches))
2838 (i (1- cnt)))
2839 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
2840 (setq i (1- i)))
2841 (if (> i 0)
2842 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2844 (defun ido-restrict-to-matches ()
2845 "Set current item list to the currently matched items."
2846 (interactive)
2847 (when ido-matches
2848 (setq ido-cur-list ido-matches
2849 ido-text-init ""
2850 ido-rescan nil
2851 ido-exit 'keep)
2852 (exit-minibuffer)))
2854 (defun ido-chop (items elem)
2855 "Remove all elements before ELEM and put them at the end of ITEMS."
2856 (let ((ret nil)
2857 (next nil)
2858 (sofar nil))
2859 (while (not ret)
2860 (setq next (car items))
2861 (if (equal next elem)
2862 (setq ret (append items (nreverse sofar)))
2863 ;; else
2864 (progn
2865 (setq items (cdr items))
2866 (setq sofar (cons next sofar)))))
2867 ret))
2869 (defun ido-name (item)
2870 ;; Return file name for current item, whether in a normal list
2871 ;; or a merged work directory list.
2872 (if (consp item) (car item) item))
2875 ;;; CREATE LIST OF ALL CURRENT FILES
2877 (defun ido-all-completions ()
2878 ;; Return unsorted list of all competions.
2879 (let ((ido-process-ignore-lists nil)
2880 (ido-directory-too-big nil))
2881 (cond
2882 ((eq ido-cur-item 'file)
2883 (ido-make-file-list-1 ido-current-directory))
2884 ((eq ido-cur-item 'dir)
2885 (ido-make-dir-list-1 ido-current-directory))
2886 ((eq ido-cur-item 'buffer)
2887 (ido-make-buffer-list-1))
2888 ((eq ido-cur-item 'list)
2889 ido-choice-list)
2890 (t nil))))
2893 ;; File list sorting
2895 (defun ido-file-lessp (a b)
2896 ;; Simple compare two file names.
2897 (string-lessp (ido-no-final-slash a) (ido-no-final-slash b)))
2900 (defun ido-file-extension-lessp (a b)
2901 ;; Compare file names according to ido-file-extensions-order list.
2902 (let ((n (compare-strings a 0 nil b 0 nil nil))
2903 lessp p)
2904 (if (eq n t)
2906 (if (< n 0)
2907 (setq n (1- (- n))
2908 p a a b b p
2909 lessp t)
2910 (setq n (1- n)))
2911 (cond
2912 ((= n 0)
2913 lessp)
2914 ((= (aref a n) ?.)
2915 (ido-file-extension-aux a b n lessp))
2917 (while (and (> n 2) (/= (aref a n) ?.))
2918 (setq n (1- n)))
2919 (if (> n 1)
2920 (ido-file-extension-aux a b n lessp)
2921 lessp))))))
2923 (defun ido-file-extension-aux (a b n lessp)
2924 (let ((oa (ido-file-extension-order a n))
2925 (ob (ido-file-extension-order b n)))
2926 (cond
2927 ((= oa ob)
2928 lessp)
2929 ((and oa ob)
2930 (if lessp
2931 (> oa ob)
2932 (< oa ob)))
2934 (not lessp))
2936 lessp)
2938 lessp))))
2940 (defun ido-file-extension-order (s n)
2941 (let ((l ido-file-extensions-order)
2942 (i 0) o do)
2943 (while l
2944 (cond
2945 ((eq (car l) t)
2946 (setq do i
2947 l (cdr l)))
2948 ((eq (compare-strings s n nil (car l) 0 nil nil) t)
2949 (setq o i
2950 l nil))
2952 (setq l (cdr l))))
2953 (setq i (1+ i)))
2954 (or o do)))
2957 (defun ido-sort-merged-list (items promote)
2958 ;; Input is list of ("file" . "dir") cons cells.
2959 ;; Output is sorted list of ("file "dir" ...) lists
2960 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
2961 res a cur dirs)
2962 (while l
2963 (setq a (car l)
2964 l (cdr l))
2965 (if (and res (string-equal (car (car res)) (car a)))
2966 (progn
2967 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
2968 (if (and promote (string-equal ido-current-directory (cdr a)))
2969 (setq cur t)))
2970 (setq res (cons (list (car a) (cdr a)) res)
2971 cur nil)))
2972 res))
2974 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
2975 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
2976 (let ((filenames
2977 (split-string
2978 (shell-command-to-string
2979 (concat "find " dir " -name \"" (if prefix "" "*") file "*\" -type " (if finddir "d" "f") " -print"))))
2980 filename d f
2981 res)
2982 (while filenames
2983 (setq filename (car filenames)
2984 filenames (cdr filenames))
2985 (if (and (string-match "^/" filename)
2986 (file-exists-p filename))
2987 (setq d (file-name-directory filename)
2988 f (file-name-nondirectory filename)
2989 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
2990 res))
2992 (defun ido-flatten-merged-list (items)
2993 ;; Create a list of directory names based on a merged directory list.
2994 (let (res)
2995 (while items
2996 (let* ((item (car items))
2997 (file (car item))
2998 (dirs (cdr item)))
2999 (while dirs
3000 (setq res (cons (concat (car dirs) file) res)
3001 dirs (cdr dirs))))
3002 (setq items (cdr items)))
3003 res))
3006 (defun ido-make-merged-file-list-1 (text auto wide)
3007 (let (res)
3008 (if (and (ido-final-slash text) ido-dir-file-cache)
3009 (if wide
3010 (setq res (ido-wide-find-dirs-or-files
3011 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
3012 ;; Use list of cached directories
3013 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
3014 (dirs ido-dir-file-cache)
3015 dir b d f)
3016 (if nil ;; simple
3017 (while dirs
3018 (setq dir (car (car dirs))
3019 dirs (cdr dirs))
3020 (when (and (string-match re dir)
3021 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
3022 (file-directory-p dir))
3023 (setq b (substring dir 0 -1)
3024 f (concat (file-name-nondirectory b) "/")
3025 d (file-name-directory b)
3026 res (cons (cons f d) res))))
3027 (while dirs
3028 (setq dir (car dirs)
3029 d (car dir)
3030 dirs (cdr dirs))
3031 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
3032 (setq dir (cdr (cdr dir)))
3033 (while dir
3034 (setq f (car dir)
3035 dir (cdr dir))
3036 (if (and (string-match re f)
3037 (not (ido-ignore-item-p f ido-ignore-directories)))
3038 (setq res (cons (cons f d) res)))))
3039 (if (and auto (input-pending-p))
3040 (setq dirs nil
3041 res t))))))
3042 (if wide
3043 (setq res (ido-wide-find-dirs-or-files
3044 ido-current-directory text ido-enable-prefix nil))
3045 (let ((ido-text text)
3046 (dirs ido-work-directory-list)
3047 (must-match (and text (> (length text) 0)))
3048 dir fl)
3049 (if (and auto (not (member ido-current-directory dirs)))
3050 (setq dirs (cons ido-current-directory dirs)))
3051 (while dirs
3052 (setq dir (car dirs)
3053 dirs (cdr dirs))
3054 (when (and dir (stringp dir)
3055 (or ido-merge-ftp-work-directories
3056 (not (ido-is-ftp-directory dir)))
3057 (file-directory-p dir)
3058 ;; TODO. check for nonreadable and too-big.
3059 (setq fl (if (eq ido-cur-item 'file)
3060 (ido-make-file-list-1 dir t)
3061 (ido-make-dir-list-1 dir t))))
3062 (if must-match
3063 (setq fl (ido-set-matches-1 fl)))
3064 (if fl
3065 (setq res (nconc fl res))))
3066 (if (and auto (input-pending-p))
3067 (setq dirs nil
3068 res t))))))
3069 res))
3071 (defun ido-make-merged-file-list (text auto wide)
3072 (let (res)
3073 (message "Searching for `%s'...." text)
3074 (condition-case nil
3075 (if (eq t (setq res
3076 (while-no-input
3077 (ido-make-merged-file-list-1 text auto wide))))
3078 (setq res 'input-pending-p))
3079 (quit
3080 (setq res t
3081 ido-try-merged-list nil
3082 ido-use-merged-list nil)))
3083 (when (and res (listp res))
3084 (setq res (ido-sort-merged-list res auto)))
3085 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
3086 (listp res)
3087 (> (length text) 0))
3088 (let ((elt (assoc text res)))
3089 (when (and elt (not (eq elt (car res))))
3090 (setq res (delq elt res))
3091 (setq res (cons elt res)))))
3092 (message nil)
3093 res))
3095 (defun ido-make-buffer-list-1 (&optional frame visible)
3096 ;; Return list of non-ignored buffer names
3097 (delq nil
3098 (mapcar
3099 (lambda (x)
3100 (let ((name (buffer-name x)))
3101 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
3102 name)))
3103 (buffer-list frame))))
3105 (defun ido-make-buffer-list (default)
3106 ;; Return the current list of buffers.
3107 ;; Currently visible buffers are put at the end of the list.
3108 ;; The hook `ido-make-buffer-list-hook' is run after the list has been
3109 ;; created to allow the user to further modify the order of the buffer names
3110 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
3111 ;; it is put to the start of the list.
3112 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
3113 (ido-temp-list (ido-make-buffer-list-1 (selected-frame) ido-current-buffers)))
3114 (if ido-temp-list
3115 (nconc ido-temp-list ido-current-buffers)
3116 (setq ido-temp-list ido-current-buffers))
3117 (if default
3118 (progn
3119 (setq ido-temp-list
3120 (delete default ido-temp-list))
3121 (setq ido-temp-list
3122 (cons default ido-temp-list))))
3123 (run-hooks 'ido-make-buffer-list-hook)
3124 ido-temp-list))
3126 (defun ido-make-choice-list (default)
3127 ;; Return the current list of choices.
3128 ;; If DEFAULT is non-nil, and corresponds to an element of choices,
3129 ;; it is put to the start of the list.
3130 (let ((ido-temp-list ido-choice-list))
3131 (if default
3132 (progn
3133 (setq ido-temp-list
3134 (delete default ido-temp-list))
3135 (setq ido-temp-list
3136 (cons default ido-temp-list))))
3137 ; (run-hooks 'ido-make-choice-list-hook)
3138 ido-temp-list))
3140 (defun ido-to-end (items)
3141 ;; Move the elements from ITEMS to the end of `ido-temp-list'
3142 (mapcar
3143 (lambda (elem)
3144 (setq ido-temp-list (delq elem ido-temp-list)))
3145 items)
3146 (if ido-temp-list
3147 (nconc ido-temp-list items)
3148 (setq ido-temp-list items)))
3150 (defun ido-file-name-all-completions-1 (dir)
3151 (cond
3152 ((ido-nonreadable-directory-p dir) '())
3153 ;; do not check (ido-directory-too-big-p dir) here.
3154 ;; Caller must have done that if necessary.
3156 ((and ido-enable-tramp-completion
3157 (or (fboundp 'tramp-completion-mode)
3158 (require 'tramp nil t))
3159 (string-match "\\`/[^/]+[:@]\\'" dir))
3160 ;; Strip method:user@host: part of tramp completions.
3161 ;; Tramp completions do not include leading slash.
3162 (let ((len (1- (length dir)))
3163 (compl
3164 (or (file-name-all-completions "" dir)
3165 ;; work around bug in ange-ftp.
3166 ;; /ftp:user@host: => nil
3167 ;; /ftp:user@host:./ => ok
3168 (and
3169 (not (string= "/ftp:" dir))
3170 (tramp-tramp-file-p dir)
3171 (fboundp 'tramp-ftp-file-name-p)
3172 (funcall 'tramp-ftp-file-name-p dir)
3173 (string-match ":\\'" dir)
3174 (file-name-all-completions "" (concat dir "./"))))))
3175 (if (and compl
3176 (> (length (car compl)) len)
3177 (string= (substring (car compl) 0 len) (substring dir 1)))
3178 (mapcar (lambda (c) (substring c len)) compl)
3179 compl)))
3181 (file-name-all-completions "" dir))))
3183 (defun ido-file-name-all-completions (dir)
3184 ;; Return name of all files in DIR
3185 ;; Uses and updates ido-dir-file-cache
3186 (if (and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
3187 (stringp dir) (> (length dir) 0)
3188 (ido-may-cache-directory dir))
3189 (let* ((cached (assoc dir ido-dir-file-cache))
3190 (ctime (nth 1 cached))
3191 (ftp (ido-is-ftp-directory dir))
3192 (attr (if ftp nil (file-attributes dir)))
3193 (mtime (nth 5 attr))
3194 valid)
3195 (when cached ; should we use the cached entry ?
3196 (if ftp
3197 (setq valid (and (eq (car ctime) 'ftp)
3198 (ido-cache-ftp-valid (cdr ctime))))
3199 (if attr
3200 (setq valid (and (= (car ctime) (car mtime))
3201 (= (car (cdr ctime)) (car (cdr mtime)))))))
3202 (if (not valid)
3203 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
3204 cached nil)))
3205 (unless cached
3206 (if (and ftp (file-readable-p dir))
3207 (setq mtime (cons 'ftp (ido-time-stamp))))
3208 (if mtime
3209 (setq cached (cons dir (cons mtime (ido-file-name-all-completions-1 dir)))
3210 ido-dir-file-cache (cons cached ido-dir-file-cache)))
3211 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
3212 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
3213 (and cached
3214 (cdr (cdr cached))))
3215 (ido-file-name-all-completions-1 dir)))
3217 (defun ido-remove-cached-dir (dir)
3218 ;; Remove dir from ido-dir-file-cache
3219 (if (and ido-dir-file-cache
3220 (stringp dir) (> (length dir) 0))
3221 (let ((cached (assoc dir ido-dir-file-cache)))
3222 (if cached
3223 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
3226 (defun ido-make-file-list-1 (dir &optional merged)
3227 ;; Return list of non-ignored files in DIR
3228 ;; If MERGED is non-nil, each file is cons'ed with DIR
3229 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
3230 (delq nil
3231 (mapcar
3232 (lambda (name)
3233 (if (not (ido-ignore-item-p name ido-ignore-files t))
3234 (if merged (cons name dir) name)))
3235 (ido-file-name-all-completions dir)))))
3237 (defun ido-make-file-list (default)
3238 ;; Return the current list of files.
3239 ;; Currently visible files are put at the end of the list.
3240 ;; The hook `ido-make-file-list-hook' is run after the list has been
3241 ;; created to allow the user to further modify the order of the file names
3242 ;; in this list.
3243 (let ((ido-temp-list (ido-make-file-list-1 ido-current-directory)))
3244 (setq ido-temp-list (sort ido-temp-list
3245 (if ido-file-extensions-order
3246 #'ido-file-extension-lessp
3247 #'ido-file-lessp)))
3248 (unless (ido-is-tramp-root ido-current-directory)
3249 (let ((default-directory ido-current-directory))
3250 (ido-to-end ;; move ftp hosts and visited files to end
3251 (delq nil (mapcar
3252 (lambda (x) (if (or (string-match "..:\\'" x)
3253 (and (not (ido-final-slash x))
3254 (get-file-buffer x))) x))
3255 ido-temp-list)))))
3256 (ido-to-end ;; move . files to end
3257 (delq nil (mapcar
3258 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3259 ido-temp-list)))
3260 (if (and default (member default ido-temp-list))
3261 (if (or ido-rotate-temp ido-rotate-file-list-default)
3262 (unless (equal default (car ido-temp-list))
3263 (let ((l ido-temp-list) k)
3264 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3265 (setq l (cdr l)))
3266 (setq k (cdr l))
3267 (setcdr l nil)
3268 (nconc k ido-temp-list)
3269 (setq ido-temp-list k)))
3270 (setq ido-temp-list
3271 (delete default ido-temp-list))
3272 (setq ido-temp-list
3273 (cons default ido-temp-list))))
3274 (when ido-show-dot-for-dired
3275 (setq ido-temp-list (delete "." ido-temp-list))
3276 (setq ido-temp-list (cons "." ido-temp-list)))
3277 (run-hooks 'ido-make-file-list-hook)
3278 ido-temp-list))
3280 (defun ido-make-dir-list-1 (dir &optional merged)
3281 ;; Return list of non-ignored subdirs in DIR
3282 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
3283 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
3284 (delq nil
3285 (mapcar
3286 (lambda (name)
3287 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
3288 (if merged (cons name dir) name)))
3289 (ido-file-name-all-completions dir)))))
3291 (defun ido-make-dir-list (default)
3292 ;; Return the current list of directories.
3293 ;; The hook `ido-make-dir-list-hook' is run after the list has been
3294 ;; created to allow the user to further modify the order of the
3295 ;; directory names in this list.
3296 (let ((ido-temp-list (ido-make-dir-list-1 ido-current-directory)))
3297 (setq ido-temp-list (sort ido-temp-list #'ido-file-lessp))
3298 (ido-to-end ;; move . files to end
3299 (delq nil (mapcar
3300 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3301 ido-temp-list)))
3302 (if (and default (member default ido-temp-list))
3303 (if (or ido-rotate-temp ido-rotate-file-list-default)
3304 (unless (equal default (car ido-temp-list))
3305 (let ((l ido-temp-list) k)
3306 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3307 (setq l (cdr l)))
3308 (setq k (cdr l))
3309 (setcdr l nil)
3310 (nconc k ido-temp-list)
3311 (setq ido-temp-list k)))
3312 (setq ido-temp-list
3313 (delete default ido-temp-list))
3314 (setq ido-temp-list
3315 (cons default ido-temp-list))))
3316 (setq ido-temp-list (delete "." ido-temp-list))
3317 (unless ido-input-stack
3318 (setq ido-temp-list (cons "." ido-temp-list)))
3319 (run-hooks 'ido-make-dir-list-hook)
3320 ido-temp-list))
3322 ;; List of the files visible in the current frame.
3323 (defvar ido-bufs-in-frame)
3325 (defun ido-get-buffers-in-frames (&optional current)
3326 ;; Return the list of buffers that are visible in the current frame.
3327 ;; If optional argument `current' is given, restrict searching to the
3328 ;; current frame, rather than all frames, regardless of value of
3329 ;; `ido-all-frames'.
3330 (let ((ido-bufs-in-frame nil))
3331 (walk-windows 'ido-get-bufname nil
3332 (if current
3334 ido-all-frames))
3335 ido-bufs-in-frame))
3337 (defun ido-get-bufname (win)
3338 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
3339 (let ((buf (buffer-name (window-buffer win))))
3340 (unless (or (member buf ido-bufs-in-frame)
3341 (member buf ido-ignore-item-temp-list))
3342 ;; Only add buf if it is not already in list.
3343 ;; This prevents same buf in two different windows being
3344 ;; put into the list twice.
3345 (setq ido-bufs-in-frame
3346 (cons buf ido-bufs-in-frame)))))
3348 ;;; FIND MATCHING ITEMS
3350 (defun ido-set-matches-1 (items &optional do-full)
3351 ;; Return list of matches in items
3352 (let* ((case-fold-search ido-case-fold)
3353 (slash (and (not ido-enable-prefix) (ido-final-slash ido-text)))
3354 (text (if slash (substring ido-text 0 -1) ido-text))
3355 (rexq (concat (if ido-enable-regexp text (regexp-quote text)) (if slash ".*/" "")))
3356 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
3357 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" re))
3358 (concat "\\`" re "\\'")))
3359 (prefix-re (and full-re (not ido-enable-prefix)
3360 (concat "\\`" rexq)))
3361 (non-prefix-dot (or (not ido-enable-dot-prefix)
3362 (not ido-process-ignore-lists)
3363 ido-enable-prefix
3364 (= (length ido-text) 0)))
3366 full-matches
3367 prefix-matches
3368 matches)
3369 (setq ido-incomplete-regexp nil)
3370 (condition-case error
3371 (mapcar
3372 (lambda (item)
3373 (let ((name (ido-name item)))
3374 (if (and (or non-prefix-dot
3375 (if (= (aref ido-text 0) ?.)
3376 (= (aref name 0) ?.)
3377 (/= (aref name 0) ?.)))
3378 (string-match re name))
3379 (cond
3380 ((and full-re (string-match full-re name))
3381 (setq full-matches (cons item full-matches)))
3382 ((and prefix-re (string-match prefix-re name))
3383 (setq prefix-matches (cons item prefix-matches)))
3384 (t (setq matches (cons item matches))))))
3386 items)
3387 (invalid-regexp
3388 (setq ido-incomplete-regexp t
3389 ;; Consider the invalid regexp message internally as a
3390 ;; special-case single match, and handle appropriately
3391 ;; elsewhere.
3392 matches (cdr error))))
3393 (if prefix-matches
3394 (setq matches (nconc prefix-matches matches)))
3395 (if full-matches
3396 (setq matches (nconc full-matches matches)))
3397 (when (and (null matches)
3398 ido-enable-flex-matching
3399 (> (length ido-text) 1)
3400 (not ido-enable-regexp))
3401 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
3402 (if ido-enable-prefix
3403 (setq re (concat "\\`" re)))
3404 (mapcar
3405 (lambda (item)
3406 (let ((name (ido-name item)))
3407 (if (string-match re name)
3408 (setq matches (cons item matches)))))
3409 items))
3410 matches))
3413 (defun ido-set-matches ()
3414 ;; Set `ido-matches' to the list of items matching prompt
3415 (when ido-rescan
3416 (setq ido-matches (ido-set-matches-1 (reverse ido-cur-list) (not ido-rotate))
3417 ido-rotate nil)))
3419 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
3420 ;; Return t if the buffer or file NAME should be ignored.
3421 (or (member name ido-ignore-item-temp-list)
3422 (and
3423 ido-process-ignore-lists re-list
3424 (save-match-data
3425 (let ((ext-list (and ignore-ext ido-ignore-extensions
3426 completion-ignored-extensions))
3427 (case-fold-search ido-case-fold)
3428 ignorep nextstr
3429 (flen (length name)) slen)
3430 (while ext-list
3431 (setq nextstr (car ext-list))
3432 (if (cond
3433 ((stringp nextstr)
3434 (and (>= flen (setq slen (length nextstr)))
3435 (string-equal (substring name (- flen slen)) nextstr)))
3436 ((fboundp nextstr) (funcall nextstr name))
3437 (t nil))
3438 (setq ignorep t
3439 ext-list nil
3440 re-list nil)
3441 (setq ext-list (cdr ext-list))))
3442 (while re-list
3443 (setq nextstr (car re-list))
3444 (if (cond
3445 ((stringp nextstr) (string-match nextstr name))
3446 ((fboundp nextstr) (funcall nextstr name))
3447 (t nil))
3448 (setq ignorep t
3449 re-list nil)
3450 (setq re-list (cdr re-list))))
3451 ;; return the result
3452 (if ignorep
3453 (setq ido-ignored-list (cons name ido-ignored-list)))
3454 ignorep)))))
3456 ;; Private variable used by `ido-word-matching-substring'.
3457 (defvar ido-change-word-sub)
3459 (defun ido-find-common-substring (items subs)
3460 ;; Return common string following SUBS in each element of ITEMS.
3461 (let (res
3462 alist
3463 ido-change-word-sub)
3464 (setq ido-change-word-sub
3465 (if ido-enable-regexp
3466 subs
3467 (regexp-quote subs)))
3468 (setq res (mapcar #'ido-word-matching-substring items))
3469 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
3470 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
3472 ;; try-completion returns t if there is an exact match.
3473 (let* ((completion-ignore-case ido-case-fold)
3474 (comp (try-completion subs alist)))
3475 (if (eq comp t)
3476 subs
3477 comp))))
3479 (defun ido-word-matching-substring (word)
3480 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
3481 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
3482 (let ((case-fold-search ido-case-fold))
3483 (let ((m (string-match ido-change-word-sub (ido-name word))))
3484 (if m
3485 (substring (ido-name word) m)
3486 ;; else no match
3487 nil))))
3489 (defun ido-makealist (res)
3490 ;; Return dotted pair (RES . 1).
3491 (cons res 1))
3493 (defun ido-choose-completion-string (choice buffer mini-p base-size)
3494 (when (ido-active)
3495 ;; Insert the completion into the buffer where completion was requested.
3496 (if (get-buffer ido-completion-buffer)
3497 (kill-buffer ido-completion-buffer))
3498 (cond
3499 ((ido-active t) ;; ido-use-merged-list
3500 (setq ido-current-directory ""
3501 ido-text choice
3502 ido-exit 'done))
3503 ((not (ido-final-slash choice))
3504 (setq ido-text choice
3505 ido-exit 'done))
3507 (ido-set-current-directory ido-current-directory choice)
3508 (setq ido-exit 'refresh)))
3509 (exit-minibuffer)
3512 (defun ido-completion-help ()
3513 "Show possible completions in a *File Completions* buffer."
3514 (interactive)
3515 (setq ido-rescan nil)
3516 (let ((temp-buf (get-buffer ido-completion-buffer))
3517 display-it full-list)
3518 (if (and (eq last-command this-command) temp-buf)
3519 ;; scroll buffer
3520 (let (win (buf (current-buffer)))
3521 (display-buffer temp-buf nil nil)
3522 (set-buffer temp-buf)
3523 (setq win (get-buffer-window temp-buf))
3524 (if (pos-visible-in-window-p (point-max) win)
3525 (if (or ido-completion-buffer-all-completions (boundp 'ido-completion-buffer-full))
3526 (set-window-start win (point-min))
3527 (with-no-warnings
3528 (set (make-local-variable 'ido-completion-buffer-full) t))
3529 (setq full-list t
3530 display-it t))
3531 (scroll-other-window))
3532 (set-buffer buf))
3533 (setq display-it t))
3534 (if display-it
3535 (with-output-to-temp-buffer ido-completion-buffer
3536 (let ((completion-list (sort
3537 (cond
3538 (ido-use-merged-list
3539 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
3540 ((or full-list ido-completion-buffer-all-completions)
3541 (ido-all-completions))
3543 (copy-sequence (or ido-matches ido-cur-list))))
3544 #'ido-file-lessp)))
3545 (if (featurep 'xemacs)
3546 ;; XEmacs extents are put on by default, doesn't seem to be
3547 ;; any way of switching them off.
3548 ;; This obscure code avoids a byte compiler warning in Emacs.
3549 (let ((f 'display-completion-list))
3550 (funcall f completion-list
3551 :help-string "ido "
3552 :activate-callback
3553 '(lambda (x y z) (message "doesn't work yet, sorry!"))))
3554 ;; else running Emacs
3555 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
3556 (display-completion-list completion-list)))))))
3558 ;;; KILL CURRENT BUFFER
3559 (defun ido-kill-buffer-at-head ()
3560 "Kill the buffer at the head of `ido-matches'."
3561 (interactive)
3562 (let ((enable-recursive-minibuffers t)
3563 (buf (car ido-matches)))
3564 (when buf
3565 (kill-buffer buf)
3566 ;; Check if buffer still exists.
3567 (if (get-buffer buf)
3568 ;; buffer couldn't be killed.
3569 (setq ido-rescan t)
3570 ;; else buffer was killed so remove name from list.
3571 (setq ido-cur-list (delq buf ido-cur-list))))))
3573 ;;; DELETE CURRENT FILE
3574 (defun ido-delete-file-at-head ()
3575 "Delete the file at the head of `ido-matches'."
3576 (interactive)
3577 (let ((enable-recursive-minibuffers t)
3578 (file (car ido-matches)))
3579 (if file
3580 (setq file (concat ido-current-directory file)))
3581 (when (and file
3582 (file-exists-p file)
3583 (not (file-directory-p file))
3584 (file-writable-p ido-current-directory)
3585 (yes-or-no-p (concat "Delete " file "? ")))
3586 (delete-file file)
3587 ;; Check if file still exists.
3588 (if (file-exists-p file)
3589 ;; file could not be deleted
3590 (setq ido-rescan t)
3591 ;; else file was killed so remove name from list.
3592 (setq ido-cur-list (delq (car ido-matches) ido-cur-list))))))
3595 ;;; VISIT CHOSEN BUFFER
3596 (defun ido-visit-buffer (buffer method &optional record)
3597 "Visit file named FILE according to METHOD.
3598 Record command in `command-history' if optional RECORD is non-nil."
3600 (let (win newframe)
3601 (cond
3602 ((eq method 'kill)
3603 (if record
3604 (ido-record-command 'kill-buffer buffer))
3605 (kill-buffer buffer))
3607 ((eq method 'samewindow)
3608 (if record
3609 (ido-record-command 'switch-to-buffer buffer))
3610 (switch-to-buffer buffer))
3612 ((memq method '(always-frame maybe-frame))
3613 (cond
3614 ((and window-system
3615 (setq win (ido-window-buffer-p buffer))
3616 (or (eq method 'always-frame)
3617 (y-or-n-p "Jump to frame? ")))
3618 (setq newframe (window-frame win))
3619 (if (fboundp 'select-frame-set-input-focus)
3620 (select-frame-set-input-focus newframe)
3621 (raise-frame newframe)
3622 (select-frame newframe)
3623 (unless (featurep 'xemacs)
3624 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
3625 (select-window win))
3627 ;; No buffer in other frames...
3628 (if record
3629 (ido-record-command 'switch-to-buffer buffer))
3630 (switch-to-buffer buffer)
3633 ((eq method 'otherwindow)
3634 (if record
3635 (ido-record-command 'switch-to-buffer buffer))
3636 (switch-to-buffer-other-window buffer))
3638 ((eq method 'display)
3639 (display-buffer buffer))
3641 ((eq method 'otherframe)
3642 (switch-to-buffer-other-frame buffer)
3643 (unless (featurep 'xemacs)
3644 (select-frame-set-input-focus (selected-frame)))
3645 ))))
3648 (defun ido-window-buffer-p (buffer)
3649 ;; Return window pointer if BUFFER is visible in another frame.
3650 ;; If BUFFER is visible in the current frame, return nil.
3651 (let ((blist (ido-get-buffers-in-frames 'current)))
3652 ;;If the buffer is visible in current frame, return nil
3653 (if (member buffer blist)
3655 ;; maybe in other frame or icon
3656 (get-buffer-window buffer 0) ; better than 'visible
3660 ;;; ----------- IDONIZED FUNCTIONS ------------
3662 ;;;###autoload
3663 (defun ido-switch-buffer ()
3664 "Switch to another buffer.
3665 The buffer is displayed according to `ido-default-buffer-method' -- the
3666 default is to show it in the same window, unless it is already visible
3667 in another frame.
3669 As you type in a string, all of the buffers matching the string are
3670 displayed if substring-matching is used \(default). Look at
3671 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
3672 buffer you want, it can then be selected. As you type, most keys have
3673 their normal keybindings, except for the following: \\<ido-mode-buffer-map>
3675 RET Select the buffer at the front of the list of matches. If the
3676 list is empty, possibly prompt to create new buffer.
3678 \\[ido-select-text] Select the current prompt as the buffer.
3679 If no buffer is found, prompt for a new one.
3681 \\[ido-next-match] Put the first element at the end of the list.
3682 \\[ido-prev-match] Put the last element at the start of the list.
3683 \\[ido-complete] Complete a common suffix to the current string that
3684 matches all buffers. If there is only one match, select that buffer.
3685 If there is no common suffix, show a list of all matching buffers
3686 in a separate window.
3687 \\[ido-edit-input] Edit input string.
3688 \\[ido-fallback-command] Fallback to non-ido version of current command.
3689 \\[ido-toggle-regexp] Toggle regexp searching.
3690 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3691 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
3692 \\[ido-completion-help] Show list of matching buffers in separate window.
3693 \\[ido-enter-find-file] Drop into ido-find-file.
3694 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
3695 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
3696 (interactive)
3697 (ido-buffer-internal ido-default-buffer-method))
3699 ;;;###autoload
3700 (defun ido-switch-buffer-other-window ()
3701 "Switch to another buffer and show it in another window.
3702 The buffer name is selected interactively by typing a substring.
3703 For details of keybindings, do `\\[describe-function] ido'."
3704 (interactive)
3705 (ido-buffer-internal 'otherwindow 'switch-to-buffer-other-window))
3707 ;;;###autoload
3708 (defun ido-display-buffer ()
3709 "Display a buffer in another window but don't select it.
3710 The buffer name is selected interactively by typing a substring.
3711 For details of keybindings, do `\\[describe-function] ido'."
3712 (interactive)
3713 (ido-buffer-internal 'display 'display-buffer nil nil nil 'ignore))
3715 ;;;###autoload
3716 (defun ido-kill-buffer ()
3717 "Kill a buffer.
3718 The buffer name is selected interactively by typing a substring.
3719 For details of keybindings, do `\\[describe-function] ido'."
3720 (interactive)
3721 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer)) nil 'ignore))
3723 ;;;###autoload
3724 (defun ido-insert-buffer ()
3725 "Insert contents of a buffer in current buffer after point.
3726 The buffer name is selected interactively by typing a substring.
3727 For details of keybindings, do `\\[describe-function] ido'."
3728 (interactive)
3729 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil nil 'ido-enter-insert-file))
3731 ;;;###autoload
3732 (defun ido-switch-buffer-other-frame ()
3733 "Switch to another buffer and show it in another frame.
3734 The buffer name is selected interactively by typing a substring.
3735 For details of keybindings, do `\\[describe-function] ido'."
3736 (interactive)
3737 (if ido-mode
3738 (ido-buffer-internal 'otherframe)
3739 (call-interactively 'switch-to-buffer-other-frame)))
3741 ;;;###autoload
3742 (defun ido-find-file-in-dir (dir)
3743 "Switch to another file starting from DIR."
3744 (interactive "DDir: ")
3745 (if (not (equal (substring dir -1) "/"))
3746 (setq dir (concat dir "/")))
3747 (ido-file-internal ido-default-file-method nil dir nil nil nil 'ignore))
3749 ;;;###autoload
3750 (defun ido-find-file ()
3751 "Edit file with name obtained via minibuffer.
3752 The file is displayed according to `ido-default-file-method' -- the
3753 default is to show it in the same window, unless it is already
3754 visible in another frame.
3756 The file name is selected interactively by typing a substring. As you
3757 type in a string, all of the filenames matching the string are displayed
3758 if substring-matching is used \(default). Look at `ido-enable-prefix' and
3759 `ido-toggle-prefix'. When you have found the filename you want, it can
3760 then be selected. As you type, most keys have their normal keybindings,
3761 except for the following: \\<ido-mode-file-map>
3763 RET Select the file at the front of the list of matches. If the
3764 list is empty, possibly prompt to create new file.
3766 \\[ido-select-text] Select the current prompt as the buffer or file.
3767 If no buffer or file is found, prompt for a new one.
3769 \\[ido-next-match] Put the first element at the end of the list.
3770 \\[ido-prev-match] Put the last element at the start of the list.
3771 \\[ido-complete] Complete a common suffix to the current string that
3772 matches all files. If there is only one match, select that file.
3773 If there is no common suffix, show a list of all matching files
3774 in a separate window.
3775 \\[ido-edit-input] Edit input string (including directory).
3776 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
3777 \\[ido-merge-work-directories] search for file in the work directory history.
3778 \\[ido-forget-work-directory] removes current directory from the work directory history.
3779 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
3780 \\[ido-wide-find-file-or-pop-dir] and \\[ido-wide-find-dir-or-delete-dir] prompts and uses find to locate files or directories.
3781 \\[ido-make-directory] prompts for a directory to create in current directory.
3782 \\[ido-fallback-command] Fallback to non-ido version of current command.
3783 \\[ido-toggle-regexp] Toggle regexp searching.
3784 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3785 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
3786 \\[ido-toggle-vc] Toggle version control for this file.
3787 \\[ido-toggle-literal] Toggle literal reading of this file.
3788 \\[ido-completion-help] Show list of matching files in separate window.
3789 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
3791 (interactive)
3792 (ido-file-internal ido-default-file-method))
3794 ;;;###autoload
3795 (defun ido-find-file-other-window ()
3796 "Switch to another file and show it in another window.
3797 The file name is selected interactively by typing a substring.
3798 For details of keybindings, do `\\[describe-function] ido-find-file'."
3799 (interactive)
3800 (ido-file-internal 'otherwindow 'find-file-other-window))
3802 ;;;###autoload
3803 (defun ido-find-alternate-file ()
3804 "Switch to another file and show it in another window.
3805 The file name is selected interactively by typing a substring.
3806 For details of keybindings, do `\\[describe-function] ido-find-file'."
3807 (interactive)
3808 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
3810 ;;;###autoload
3811 (defun ido-find-file-read-only ()
3812 "Edit file read-only with name obtained via minibuffer.
3813 The file name is selected interactively by typing a substring.
3814 For details of keybindings, do `\\[describe-function] ido-find-file'."
3815 (interactive)
3816 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
3818 ;;;###autoload
3819 (defun ido-find-file-read-only-other-window ()
3820 "Edit file read-only in other window with name obtained via minibuffer.
3821 The file name is selected interactively by typing a substring.
3822 For details of keybindings, do `\\[describe-function] ido-find-file'."
3823 (interactive)
3824 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
3826 ;;;###autoload
3827 (defun ido-find-file-read-only-other-frame ()
3828 "Edit file read-only in other frame with name obtained via minibuffer.
3829 The file name is selected interactively by typing a substring.
3830 For details of keybindings, do `\\[describe-function] ido-find-file'."
3831 (interactive)
3832 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
3834 ;;;###autoload
3835 (defun ido-display-file ()
3836 "Display a file in another window but don't select it.
3837 The file name is selected interactively by typing a substring.
3838 For details of keybindings, do `\\[describe-function] ido-find-file'."
3839 (interactive)
3840 (ido-file-internal 'display nil nil nil nil nil 'ignore))
3842 ;;;###autoload
3843 (defun ido-find-file-other-frame ()
3844 "Switch to another file and show it in another frame.
3845 The file name is selected interactively by typing a substring.
3846 For details of keybindings, do `\\[describe-function] ido-find-file'."
3847 (interactive)
3848 (ido-file-internal 'otherframe 'find-file-other-frame))
3850 ;;;###autoload
3851 (defun ido-write-file ()
3852 "Write current buffer to a file.
3853 The file name is selected interactively by typing a substring.
3854 For details of keybindings, do `\\[describe-function] ido-find-file'."
3855 (interactive)
3856 (let ((ido-process-ignore-lists t)
3857 (ido-work-directory-match-only nil)
3858 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
3859 (ido-report-no-match nil)
3860 (ido-confirm-unique-completion t)
3861 (ido-auto-merge-work-directories-length -1))
3862 (ido-file-internal 'write 'write-file nil "Write file: " nil nil 'ignore)))
3864 ;;;###autoload
3865 (defun ido-insert-file ()
3866 "Insert contents of file in current buffer.
3867 The file name is selected interactively by typing a substring.
3868 For details of keybindings, do `\\[describe-function] ido-find-file'."
3869 (interactive)
3870 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil nil 'ido-enter-insert-buffer))
3872 ;;;###autoload
3873 (defun ido-dired ()
3874 "Call dired the ido way.
3875 The directory is selected interactively by typing a substring.
3876 For details of keybindings, do `\\[describe-function] ido-find-file'."
3877 (interactive)
3878 (let ((ido-report-no-match nil)
3879 (ido-auto-merge-work-directories-length -1))
3880 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
3882 (defun ido-list-directory ()
3883 "Call list-directory the ido way.
3884 The directory is selected interactively by typing a substring.
3885 For details of keybindings, do `\\[describe-function] ido-find-file'."
3886 (interactive)
3887 (let ((ido-report-no-match nil)
3888 (ido-auto-merge-work-directories-length -1))
3889 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
3891 ;;; XEmacs hack for showing default buffer
3893 ;; The first time we enter the minibuffer, Emacs puts up the default
3894 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
3895 ;; subtle difference in the two versions of post-command-hook. The
3896 ;; default is shown for both whenever we delete all of our text
3897 ;; though, indicating its just a problem the first time we enter the
3898 ;; function. To solve this, we use another entry hook for emacs to
3899 ;; show the default the first time we enter the minibuffer.
3902 ;;; ICOMPLETE TYPE CODE
3904 (defun ido-initiate-auto-merge (buffer)
3905 (ido-trace "\n*merge timeout*" buffer)
3906 (setq ido-auto-merge-timer nil)
3907 (when (and (buffer-live-p buffer)
3908 (= ido-use-mycompletion-depth (minibuffer-depth))
3909 (boundp 'ido-eoinput) ido-eoinput)
3910 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
3911 (ido-trace "request merge")
3912 (setq ido-use-merged-list 'auto
3913 ido-text-init contents
3914 ido-rotate-temp t
3915 ido-exit 'refresh)
3916 (save-excursion
3917 (set-buffer buffer)
3918 (ido-tidy))
3919 (throw 'ido contents))))
3921 (defun ido-exhibit ()
3922 "Post command hook for `ido'."
3923 ;; Find matching files and display a list in the minibuffer.
3924 ;; Copied from `icomplete-exhibit' with two changes:
3925 ;; 1. It prints a default file name when there is no text yet entered.
3926 ;; 2. It calls my completion routine rather than the standard completion.
3928 (when (= ido-use-mycompletion-depth (minibuffer-depth))
3929 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
3930 (buffer-undo-list t)
3931 try-single-dir-match
3932 refresh)
3934 (ido-trace "\nexhibit" this-command)
3935 (ido-trace "dir" ido-current-directory)
3936 (ido-trace "contents" contents)
3937 (ido-trace "list" ido-cur-list)
3938 (ido-trace "matches" ido-matches)
3939 (ido-trace "rescan" ido-rescan)
3941 (save-excursion
3942 (goto-char (point-max))
3943 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
3944 (unless (boundp 'ido-eoinput)
3945 ;; In case it got wiped out by major mode business:
3946 (make-local-variable 'ido-eoinput))
3947 (setq ido-eoinput (point))
3949 ;; Handle explicit directory changes
3950 (cond
3951 ((memq ido-cur-item '(buffer list))
3954 ((= (length contents) 0)
3957 ((= (length contents) 1)
3958 (when (and (ido-is-tramp-root) (string-equal contents "/"))
3959 (ido-set-current-directory ido-current-directory contents)
3960 (setq refresh t))
3963 ((and (string-match (if ido-enable-tramp-completion "..[:@]\\'" "..:\\'") contents)
3964 (ido-is-root-directory)) ;; Ange-ftp or tramp
3965 (ido-set-current-directory ido-current-directory contents)
3966 (when (ido-is-slow-ftp-host)
3967 (setq ido-exit 'fallback)
3968 (exit-minibuffer))
3969 (setq refresh t))
3971 ((ido-final-slash contents) ;; xxx/
3972 (ido-trace "final slash" contents)
3973 (cond
3974 ((string-equal contents "~/")
3975 (ido-set-current-home)
3976 (setq refresh t))
3977 ((string-equal contents "../")
3978 (ido-up-directory t)
3979 (setq refresh t))
3980 ((string-equal contents "./")
3981 (setq refresh t))
3982 ((string-match "\\`~[a-zA-Z0-9]+/\\'" contents)
3983 (ido-trace "new home" contents)
3984 (ido-set-current-home contents)
3985 (setq refresh t))
3986 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
3987 (let ((exp (condition-case ()
3988 (expand-file-name
3989 (substitute-in-file-name (substring contents 0 -1))
3990 ido-current-directory)
3991 (error nil))))
3992 (ido-trace contents exp)
3993 (when (and exp (file-directory-p exp))
3994 (ido-set-current-directory (file-name-directory exp))
3995 (setq ido-text-init (file-name-nondirectory exp))
3996 (setq refresh t))))
3997 ((and (memq system-type '(windows-nt ms-dos))
3998 (string-equal (substring contents 1) ":/"))
3999 (ido-set-current-directory (file-name-directory contents))
4000 (setq refresh t))
4001 ((string-equal (substring contents -2 -1) "/")
4002 (ido-set-current-directory
4003 (if (memq system-type '(windows-nt ms-dos))
4004 (expand-file-name "/" ido-current-directory)
4005 "/"))
4006 (setq refresh t))
4007 ((and (or ido-directory-nonreadable ido-directory-too-big)
4008 (file-directory-p (concat ido-current-directory (file-name-directory contents))))
4009 (ido-set-current-directory
4010 (concat ido-current-directory (file-name-directory contents)))
4011 (setq refresh t))
4013 (ido-trace "try single dir")
4014 (setq try-single-dir-match t))))
4016 ((and (string-equal (substring contents -2 -1) "/")
4017 (not (string-match "[$]" contents)))
4018 (ido-set-current-directory
4019 (cond
4020 ((= (length contents) 2)
4021 "/")
4022 (ido-matches
4023 (concat ido-current-directory (car ido-matches)))
4025 (concat ido-current-directory (substring contents 0 -1)))))
4026 (setq ido-text-init (substring contents -1))
4027 (setq refresh t))
4029 ((and (not ido-use-merged-list)
4030 (not (ido-final-slash contents))
4031 (eq ido-try-merged-list t)
4032 (numberp ido-auto-merge-work-directories-length)
4033 (> ido-auto-merge-work-directories-length 0)
4034 (= (length contents) ido-auto-merge-work-directories-length)
4035 (not (and ido-auto-merge-inhibit-characters-regexp
4036 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4037 (not (input-pending-p)))
4038 (setq ido-use-merged-list 'auto
4039 ido-text-init contents
4040 ido-rotate-temp t)
4041 (setq refresh t))
4043 (t nil))
4045 (when refresh
4046 (ido-trace "refresh on /" ido-text-init)
4047 (setq ido-exit 'refresh)
4048 (exit-minibuffer))
4050 ;; Update the list of matches
4051 (setq ido-text contents)
4052 (ido-set-matches)
4053 (ido-trace "new " ido-matches)
4055 (when (and ido-enter-matching-directory
4056 ido-matches
4057 (or (eq ido-enter-matching-directory 'first)
4058 (null (cdr ido-matches)))
4059 (ido-final-slash (car ido-matches))
4060 (or try-single-dir-match
4061 (eq ido-enter-matching-directory t)))
4062 (ido-trace "single match" (car ido-matches))
4063 (ido-set-current-directory
4064 (concat ido-current-directory (car ido-matches)))
4065 (setq ido-exit 'refresh)
4066 (exit-minibuffer))
4068 (when (and (not ido-matches)
4069 (not ido-directory-nonreadable)
4070 (not ido-directory-too-big)
4071 ;; ido-rescan ?
4072 ido-process-ignore-lists
4073 ido-ignored-list)
4074 (let ((ido-process-ignore-lists nil)
4075 (ido-rotate ido-rotate)
4076 (ido-cur-list ido-ignored-list))
4077 (ido-trace "try all" ido-ignored-list)
4078 (ido-set-matches))
4079 (when ido-matches
4080 (ido-trace "found " ido-matches)
4081 (setq ido-rescan t)
4082 (setq ido-process-ignore-lists-inhibit t)
4083 (setq ido-text-init ido-text)
4084 (setq ido-exit 'refresh)
4085 (exit-minibuffer)))
4087 (when (and
4088 ido-rescan
4089 (not ido-matches)
4090 (memq ido-cur-item '(file dir))
4091 (not (ido-is-root-directory))
4092 (> (length contents) 1)
4093 (not (string-match "[$]" contents))
4094 (not ido-directory-nonreadable)
4095 (not ido-directory-too-big))
4096 (ido-trace "merge?")
4097 (if ido-use-merged-list
4098 (ido-undo-merge-work-directory contents nil)
4099 (when (and (eq ido-try-merged-list t)
4100 (numberp ido-auto-merge-work-directories-length)
4101 (= ido-auto-merge-work-directories-length 0)
4102 (not (and ido-auto-merge-inhibit-characters-regexp
4103 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4104 (not (input-pending-p)))
4105 (ido-trace "\n*start timer*")
4106 (setq ido-auto-merge-timer
4107 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
4109 (setq ido-rescan t)
4111 (if (and ido-use-merged-list
4112 ido-matches
4113 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
4114 (progn
4115 (ido-set-current-directory (car (cdr (car ido-matches))))
4116 (setq ido-use-merged-list t
4117 ido-exit 'keep
4118 ido-text-init ido-text)
4119 (exit-minibuffer)))
4121 ;; Insert the match-status information:
4122 (ido-set-common-completion)
4123 (let ((inf (ido-completions
4124 contents
4125 minibuffer-completion-table
4126 minibuffer-completion-predicate
4127 (not minibuffer-completion-confirm))))
4128 (ido-trace "inf" inf)
4129 (insert inf))
4130 ))))
4132 (defun ido-completions (name candidates predicate require-match)
4133 ;; Return the string that is displayed after the user's text.
4134 ;; Modified from `icomplete-completions'.
4136 (let* ((comps ido-matches)
4137 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
4138 ido-merged-indicator))
4139 first)
4141 (if (and ind ido-use-faces)
4142 (put-text-property 0 1 'face 'ido-indicator ind))
4144 (if (and ido-use-faces comps)
4145 (let* ((fn (ido-name (car comps)))
4146 (ln (length fn)))
4147 (setq first (format "%s" fn))
4148 (put-text-property 0 ln 'face
4149 (if (= (length comps) 1)
4150 (if ido-incomplete-regexp
4151 'ido-incomplete-regexp
4152 'ido-only-match)
4153 'ido-first-match)
4154 first)
4155 (if ind (setq first (concat first ind)))
4156 (setq comps (cons first (cdr comps)))))
4158 (cond ((null comps)
4159 (cond
4160 (ido-directory-nonreadable
4161 (or (nth 8 ido-decorations) " [Not readable]"))
4162 (ido-directory-too-big
4163 (or (nth 9 ido-decorations) " [Too big]"))
4164 (ido-report-no-match
4165 (nth 6 ido-decorations)) ;; [No match]
4166 (t "")))
4167 (ido-incomplete-regexp
4168 (concat " " (car comps)))
4169 ((null (cdr comps)) ;one match
4170 (concat (if (if (not ido-enable-regexp)
4171 (= (length (ido-name (car comps))) (length name))
4172 ;; We can't rely on the length of the input
4173 ;; for regexps, so explicitly check for a
4174 ;; complete match
4175 (string-match name (ido-name (car comps)))
4176 (string-equal (match-string 0 (ido-name (car comps)))
4177 (ido-name (car comps))))
4179 ;; when there is one match, show the matching file name in full
4180 (concat (nth 4 ido-decorations) ;; [ ... ]
4181 (ido-name (car comps))
4182 (nth 5 ido-decorations)))
4183 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
4184 (t ;multiple matches
4185 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
4186 (alternatives
4187 (apply
4188 #'concat
4189 (cdr (apply
4190 #'nconc
4191 (mapcar
4192 (lambda (com)
4193 (setq com (ido-name com))
4194 (setq items (1- items))
4195 (cond
4196 ((< items 0) ())
4197 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
4199 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
4200 (let ((str (substring com 0)))
4201 (if (and ido-use-faces
4202 (not (string= str first))
4203 (ido-final-slash str))
4204 (put-text-property 0 (length str) 'face 'ido-subdir str))
4205 str)))))
4206 comps))))))
4208 (concat
4209 ;; put in common completion item -- what you get by pressing tab
4210 (if (and (stringp ido-common-match-string)
4211 (> (length ido-common-match-string) (length name)))
4212 (concat (nth 4 ido-decorations) ;; [ ... ]
4213 (substring ido-common-match-string (length name))
4214 (nth 5 ido-decorations)))
4215 ;; list all alternatives
4216 (nth 0 ido-decorations) ;; { ... }
4217 alternatives
4218 (nth 1 ido-decorations)))))))
4220 (defun ido-minibuffer-setup ()
4221 "Minibuffer setup hook for `ido'."
4222 ;; Copied from `icomplete-minibuffer-setup-hook'.
4223 (when (and (boundp 'ido-completing-read)
4224 (or (featurep 'xemacs)
4225 (= ido-use-mycompletion-depth (minibuffer-depth))))
4226 (add-hook 'pre-command-hook 'ido-tidy nil t)
4227 (add-hook 'post-command-hook 'ido-exhibit nil t)
4228 (setq cua-inhibit-cua-keys t)
4229 (when (featurep 'xemacs)
4230 (ido-exhibit)
4231 (goto-char (point-min)))
4232 (run-hooks 'ido-minibuffer-setup-hook)))
4234 (defun ido-tidy ()
4235 "Pre command hook for `ido'."
4236 ;; Remove completions display, if any, prior to new user input.
4237 ;; Copied from `icomplete-tidy'."
4239 (when ido-auto-merge-timer
4240 (ido-trace "\n*cancel timer*" this-command)
4241 (cancel-timer ido-auto-merge-timer)
4242 (setq ido-auto-merge-timer nil))
4244 (if (and (boundp 'ido-use-mycompletion-depth)
4245 (= ido-use-mycompletion-depth (minibuffer-depth)))
4246 (if (and (boundp 'ido-eoinput)
4247 ido-eoinput)
4249 (if (> ido-eoinput (point-max))
4250 ;; Oops, got rug pulled out from under us - reinit:
4251 (setq ido-eoinput (point-max))
4252 (let ((buffer-undo-list t))
4253 (delete-region ido-eoinput (point-max))))
4255 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
4256 (make-local-variable 'ido-eoinput)
4257 (setq ido-eoinput 1))))
4259 (defun ido-summary-buffers-to-end ()
4260 ;; Move the summaries to the end of the buffer list.
4261 ;; This is an example function which can be hooked on to
4262 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
4263 ;; `Summary' or `output\*$'are put to the end of the list.
4264 (let ((summaries (delq nil (mapcar
4265 (lambda (x)
4266 (if (or
4267 (string-match "Summary" x)
4268 (string-match "output\\*\\'" x))
4270 ido-temp-list))))
4271 (ido-to-end summaries)))
4273 ;;; Helper functions for other programs
4275 (put 'dired-do-rename 'ido 'ignore)
4276 (put 'ibuffer-find-file 'ido 'find-file)
4277 (put 'dired-other-window 'ido 'dir)
4279 ;;;###autoload
4280 (defun ido-read-buffer (prompt &optional default require-match)
4281 "Ido replacement for the built-in `read-buffer'.
4282 Return the name of a buffer selected.
4283 PROMPT is the prompt to give to the user. DEFAULT if given is the default
4284 buffer to be selected, which will go to the front of the list.
4285 If REQUIRE-MATCH is non-nil, an existing buffer must be selected."
4286 (let* ((ido-current-directory nil)
4287 (ido-directory-nonreadable nil)
4288 (ido-directory-too-big nil)
4289 (ido-context-switch-command 'ignore)
4290 (buf (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match)))
4291 (if (eq ido-exit 'fallback)
4292 (let ((read-buffer-function nil))
4293 (run-hook-with-args 'ido-before-fallback-functions 'read-buffer)
4294 (read-buffer prompt default require-match))
4295 buf)))
4297 ;;;###autoload
4298 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
4299 "Ido replacement for the built-in `read-file-name'.
4300 Read file name, prompting with PROMPT and completing in directory DIR.
4301 See `read-file-name' for additional parameters."
4302 (let (filename)
4303 (cond
4304 ((or (eq predicate 'file-directory-p)
4305 (eq (get this-command 'ido) 'dir)
4306 (memq this-command ido-read-file-name-as-directory-commands))
4307 (setq filename
4308 (ido-read-directory-name prompt dir default-filename mustmatch initial))
4309 (if (eq ido-exit 'fallback)
4310 (setq filename 'fallback)))
4311 ((and (not (eq (get this-command 'ido) 'ignore))
4312 (not (memq this-command ido-read-file-name-non-ido))
4313 (or (null predicate) (eq predicate 'file-exists-p)))
4314 (let* (ido-saved-vc-hb
4315 (ido-context-switch-command
4316 (if (eq (get this-command 'ido) 'find-file) nil 'ignore))
4317 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
4318 (minibuffer-completing-file-name t)
4319 (ido-current-directory (ido-expand-directory dir))
4320 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4321 (ido-directory-too-big (and (not ido-directory-nonreadable)
4322 (ido-directory-too-big-p ido-current-directory)))
4323 (ido-work-directory-index -1)
4324 (ido-work-file-index -1)
4325 (ido-find-literal nil))
4326 (setq ido-exit nil)
4327 (setq filename
4328 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
4329 (cond
4330 ((eq ido-exit 'fallback)
4331 (setq filename 'fallback))
4332 ((eq ido-exit 'dired)
4333 (setq filename ido-current-directory))
4334 (filename
4335 (setq filename
4336 (concat ido-current-directory filename))))))
4338 (setq filename 'fallback)))
4339 (if (eq filename 'fallback)
4340 (let ((read-file-name-function nil))
4341 (run-hook-with-args 'ido-before-fallback-functions 'read-file-name)
4342 (read-file-name prompt dir default-filename mustmatch initial predicate))
4343 filename)))
4345 ;;;###autoload
4346 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
4347 "Ido replacement for the built-in `read-directory-name'.
4348 Read directory name, prompting with PROMPT and completing in directory DIR.
4349 See `read-directory-name' for additional parameters."
4350 (let* (filename
4351 (minibuffer-completing-file-name t)
4352 (ido-context-switch-command 'ignore)
4353 ido-saved-vc-hb
4354 (ido-current-directory (ido-expand-directory dir))
4355 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4356 (ido-directory-too-big (and (not ido-directory-nonreadable)
4357 (ido-directory-too-big-p ido-current-directory)))
4358 (ido-work-directory-index -1)
4359 (ido-work-file-index -1))
4360 (setq filename
4361 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
4362 (if filename
4363 (if (and (stringp filename) (string-equal filename "."))
4364 ido-current-directory
4365 (concat ido-current-directory filename)))))
4367 ;;;###autoload
4368 (defun ido-completing-read (prompt choices &optional predicate require-match initial-input hist def)
4369 "Ido replacement for the built-in `completing-read'.
4370 Read a string in the minibuffer with ido-style completion.
4371 PROMPT is a string to prompt with; normally it ends in a colon and a space.
4372 CHOICES is a list of strings which are the possible completions.
4373 PREDICATE is currently ignored; it is included to be compatible
4374 with `completing-read'.
4375 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
4376 the input is (or completes to) an element of CHOICES or is null.
4377 If the input is null, `ido-completing-read' returns DEF, or an empty
4378 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
4379 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
4380 with point positioned at the end.
4381 HIST, if non-nil, specifies a history list.
4382 DEF, if non-nil, is the default value."
4383 (let ((ido-current-directory nil)
4384 (ido-directory-nonreadable nil)
4385 (ido-directory-too-big nil)
4386 (ido-context-switch-command 'ignore)
4387 (ido-choice-list choices))
4388 (ido-read-internal 'list prompt hist def require-match initial-input)))
4391 ;;; arch-tag: b63a3500-1735-41bd-8a01-05373f0864da
4392 ;;; ido.el ends here