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