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