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