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