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