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