]> code.delx.au - gnu-emacs/blob - lisp/ido.el
(apropos-command): Report documentation errors, rather than ignoring.
[gnu-emacs] / lisp / ido.el
1 ;;; ido.el --- interactively do things with buffers and files.
2
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 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 (message "Ido mode %s" (if ido-mode "enabled" "disabled")))
1512
1513
1514 (defun ido-everywhere (arg)
1515 "Toggle using ido speed-ups everywhere file and directory names are read.
1516 With ARG, turn ido speed-up on if arg is positive, off otherwise."
1517 (interactive "P")
1518 (setq ido-everywhere (if arg
1519 (> (prefix-numeric-value arg) 0)
1520 (not ido-everywhere)))
1521 (when (get 'ido-everywhere 'file)
1522 (setq read-file-name-function (car (get 'ido-everywhere 'file)))
1523 (put 'ido-everywhere 'file nil))
1524 (when (get 'ido-everywhere 'buffer)
1525 (setq read-buffer-function (car (get 'ido-everywhere 'buffer)))
1526 (put 'ido-everywhere 'buffer nil))
1527 (when ido-everywhere
1528 (when (memq ido-mode '(both file))
1529 (put 'ido-everywhere 'file (cons read-file-name-function nil))
1530 (setq read-file-name-function 'ido-read-file-name))
1531 (when (memq ido-mode '(both buffer))
1532 (put 'ido-everywhere 'buffer (cons read-buffer-function nil))
1533 (setq read-buffer-function 'ido-read-buffer))))
1534
1535
1536 ;;; IDO KEYMAP
1537 (defun ido-init-completion-maps ()
1538 "Set up the completion keymaps used by `ido'."
1539
1540 ;; Common map
1541 (let ((map (make-sparse-keymap)))
1542 (define-key map "\C-a" 'ido-toggle-ignore)
1543 (define-key map "\C-c" 'ido-toggle-case)
1544 (define-key map "\C-e" 'ido-edit-input)
1545 (define-key map "\t" 'ido-complete)
1546 (define-key map " " 'ido-complete-space)
1547 (define-key map "\C-j" 'ido-select-text)
1548 (define-key map "\C-m" 'ido-exit-minibuffer)
1549 (define-key map "\C-p" 'ido-toggle-prefix)
1550 (define-key map "\C-r" 'ido-prev-match)
1551 (define-key map "\C-s" 'ido-next-match)
1552 (define-key map "\C-t" 'ido-toggle-regexp)
1553 (define-key map "\C-z" 'ido-undo-merge-work-directory)
1554 (define-key map [(control ?\s)] 'ido-restrict-to-matches)
1555 (define-key map [(meta ?\s)] 'ido-take-first-match)
1556 (define-key map [(control ?@)] 'ido-restrict-to-matches)
1557 (define-key map [right] 'ido-next-match)
1558 (define-key map [left] 'ido-prev-match)
1559 (define-key map "?" 'ido-completion-help)
1560 ;; Magic commands.
1561 (define-key map "\C-b" 'ido-magic-backward-char)
1562 (define-key map "\C-f" 'ido-magic-forward-char)
1563 (define-key map "\C-d" 'ido-magic-delete-char)
1564 (set-keymap-parent map minibuffer-local-map)
1565 (setq ido-common-completion-map map))
1566
1567 ;; File and directory map
1568 (let ((map (make-sparse-keymap)))
1569 (define-key map "\C-x\C-b" 'ido-enter-switch-buffer)
1570 (define-key map "\C-x\C-f" 'ido-fallback-command)
1571 (define-key map "\C-x\C-d" 'ido-enter-dired)
1572 (define-key map [down] 'ido-next-match-dir)
1573 (define-key map [up] 'ido-prev-match-dir)
1574 (define-key map [(meta up)] 'ido-prev-work-directory)
1575 (define-key map [(meta down)] 'ido-next-work-directory)
1576 (define-key map [backspace] 'ido-delete-backward-updir)
1577 (define-key map "\d" 'ido-delete-backward-updir)
1578 (define-key map [remap delete-backward-char] 'ido-delete-backward-updir) ; BS
1579 (define-key map [remap backward-kill-word] 'ido-delete-backward-word-updir) ; M-DEL
1580
1581 (define-key map [(control backspace)] 'ido-up-directory)
1582 (define-key map "\C-l" 'ido-reread-directory)
1583 (define-key map [(meta ?d)] 'ido-wide-find-dir-or-delete-dir)
1584 (define-key map [(meta ?b)] 'ido-push-dir)
1585 (define-key map [(meta ?v)] 'ido-push-dir-first)
1586 (define-key map [(meta ?f)] 'ido-wide-find-file-or-pop-dir)
1587 (define-key map [(meta ?k)] 'ido-forget-work-directory)
1588 (define-key map [(meta ?m)] 'ido-make-directory)
1589 (define-key map [(meta ?n)] 'ido-next-work-directory)
1590 (define-key map [(meta ?o)] 'ido-prev-work-file)
1591 (define-key map [(meta control ?o)] 'ido-next-work-file)
1592 (define-key map [(meta ?p)] 'ido-prev-work-directory)
1593 (define-key map [(meta ?s)] 'ido-merge-work-directories)
1594 (set-keymap-parent map ido-common-completion-map)
1595 (setq ido-file-dir-completion-map map))
1596
1597 ;; File only map
1598 (let ((map (make-sparse-keymap)))
1599 (define-key map "\C-k" 'ido-delete-file-at-head)
1600 (define-key map "\C-o" 'ido-copy-current-word)
1601 (define-key map "\C-w" 'ido-copy-current-file-name)
1602 (define-key map [(meta ?l)] 'ido-toggle-literal)
1603 (define-key map "\C-v" 'ido-toggle-vc)
1604 (set-keymap-parent map ido-file-dir-completion-map)
1605 (setq ido-file-completion-map map))
1606
1607 ;; Buffer map
1608 (let ((map (make-sparse-keymap)))
1609 (define-key map "\C-x\C-f" 'ido-enter-find-file)
1610 (define-key map "\C-x\C-b" 'ido-fallback-command)
1611 (define-key map "\C-k" 'ido-kill-buffer-at-head)
1612 (set-keymap-parent map ido-common-completion-map)
1613 (setq ido-buffer-completion-map map)))
1614
1615
1616 (defun ido-setup-completion-map ()
1617 "Set up the keymap for `ido'."
1618
1619 ;; generated every time so that it can inherit new functions.
1620 (let ((map (make-sparse-keymap))
1621 (viper-p (if (boundp 'viper-mode) viper-mode)))
1622
1623 (when viper-p
1624 (define-key map [remap viper-intercept-ESC-key] 'ignore))
1625
1626 (cond
1627 ((memq ido-cur-item '(file dir))
1628 (when ido-context-switch-command
1629 (define-key map "\C-x\C-b" ido-context-switch-command)
1630 (define-key map "\C-x\C-d" 'ignore))
1631 (when viper-p
1632 (define-key map [remap viper-backward-char] 'ido-delete-backward-updir)
1633 (define-key map [remap viper-del-backward-char-in-insert] 'ido-delete-backward-updir)
1634 (define-key map [remap viper-delete-backward-word] 'ido-delete-backward-word-updir))
1635 (set-keymap-parent map
1636 (if (eq ido-cur-item 'file)
1637 ido-file-completion-map
1638 ido-file-dir-completion-map)))
1639
1640 ((eq ido-cur-item 'buffer)
1641 (when ido-context-switch-command
1642 (define-key map "\C-x\C-f" ido-context-switch-command))
1643 (set-keymap-parent map ido-buffer-completion-map))
1644
1645 (t
1646 (set-keymap-parent map ido-common-completion-map)))
1647
1648 (setq ido-completion-map map)))
1649
1650 (defun ido-final-slash (dir &optional fix-it)
1651 ;; return DIR if DIR has final slash.
1652 ;; else if FIX-IT is non-nil, return DIR/
1653 ;; else return nil.
1654 (setq dir (ido-name dir))
1655 (cond
1656 ((string-match "/\\'" dir) dir)
1657 ((ido-is-tramp-root dir) dir)
1658 (fix-it (concat dir "/"))
1659 (t nil)))
1660
1661 (defun ido-no-final-slash (s)
1662 ;; Remove optional final slash from string S
1663 (let ((l (1- (length s))))
1664 (if (and (> l 0) (eq (aref s l) ?/))
1665 (substring s 0 l)
1666 s)))
1667
1668 (defun ido-nonreadable-directory-p (dir)
1669 ;; Return t if dir is a directory, but not readable
1670 ;; Do not check for non-readable directories via tramp, as this causes a premature
1671 ;; connect on incomplete tramp paths (after entring just method:).
1672 (let ((ido-enable-tramp-completion nil))
1673 (and (ido-final-slash dir)
1674 (not (ido-is-unc-host dir))
1675 (file-directory-p dir)
1676 (not (file-readable-p dir)))))
1677
1678 (defun ido-directory-too-big-p (dir)
1679 ;; Return t if dir is a directory, but too big to show
1680 ;; Do not check for non-readable directories via tramp, as this causes a premature
1681 ;; connect on incomplete tramp paths (after entring just method:).
1682 (let ((ido-enable-tramp-completion nil))
1683 (and (numberp ido-max-directory-size)
1684 (ido-final-slash dir)
1685 (not (ido-is-unc-host dir))
1686 (file-directory-p dir)
1687 (> (nth 7 (file-attributes dir)) ido-max-directory-size))))
1688
1689 (defun ido-set-current-directory (dir &optional subdir no-merge)
1690 ;; Set ido's current directory to DIR or DIR/SUBDIR
1691 (unless (and ido-enable-tramp-completion
1692 (string-match "\\`/[^/]*@\\'" dir))
1693 (setq dir (ido-final-slash dir t)))
1694 (setq ido-use-merged-list nil
1695 ido-try-merged-list (not no-merge))
1696 (when subdir
1697 (setq dir (concat dir subdir))
1698 (unless (and ido-enable-tramp-completion
1699 (string-match "\\`/[^/]*@\\'" dir))
1700 (setq dir (ido-final-slash dir t))))
1701 (if (get-buffer ido-completion-buffer)
1702 (kill-buffer ido-completion-buffer))
1703 (cond
1704 ((equal dir ido-current-directory)
1705 nil)
1706 ((ido-is-unc-root dir)
1707 (ido-trace "unc" dir)
1708 (setq ido-current-directory dir)
1709 (setq ido-directory-nonreadable nil)
1710 (setq ido-directory-too-big nil)
1711 t)
1712 (t
1713 (ido-trace "cd" dir)
1714 (setq ido-current-directory dir)
1715 (if (get-buffer ido-completion-buffer)
1716 (kill-buffer ido-completion-buffer))
1717 (setq ido-directory-nonreadable (ido-nonreadable-directory-p dir))
1718 (setq ido-directory-too-big (and (not ido-directory-nonreadable)
1719 (ido-directory-too-big-p dir)))
1720 t)))
1721
1722 (defun ido-set-current-home (&optional dir)
1723 ;; Set ido's current directory to user's home directory
1724 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1725
1726 (defun ido-record-command (command arg)
1727 ;; Add (command arg) to command-history if ido-record-commands is t
1728 (if ido-record-commands
1729 (let ((cmd (list command arg)))
1730 (if (or (not command-history)
1731 (not (equal cmd (car command-history))))
1732 (setq command-history (cons cmd command-history))))))
1733
1734 (defun ido-make-prompt (item prompt)
1735 ;; Make the prompt for ido-read-internal
1736 (cond
1737 ((and (memq item '(file dir)) ido-current-directory)
1738 (let ((dirname (abbreviate-file-name ido-current-directory))
1739 (max-width (if (and ido-max-file-prompt-width (floatp ido-max-file-prompt-width))
1740 (floor (* (frame-width) ido-max-file-prompt-width))
1741 ido-max-file-prompt-width))
1742 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1743 (vc-off (and ido-saved-vc-hb (not vc-handled-backends) "[-VC] "))
1744 (prefix nil)
1745 (rule ido-rewrite-file-prompt-rules))
1746 (let ((case-fold-search nil))
1747 (while rule
1748 (if (and (consp (car rule))
1749 (string-match (car (car rule)) dirname))
1750 (setq dirname
1751 (if (stringp (cdr (car rule)))
1752 (replace-match (cdr (car rule)) t nil dirname)
1753 (funcall (cdr (car rule)) dirname))))
1754 (setq rule (cdr rule))))
1755 (run-hooks 'ido-rewrite-file-prompt-functions)
1756 (concat prompt
1757 ; (if ido-process-ignore-lists "" "&")
1758 (or literal "")
1759 (or vc-off "")
1760 (or prefix "")
1761 (let ((l (length dirname)))
1762 (if (and max-width (> max-width 0) (> l max-width))
1763 (let* ((s (substring dirname (- max-width)))
1764 (i (string-match "/" s)))
1765 (concat "..." (if i (substring s i) s)))
1766 dirname)))))
1767 (t prompt)))
1768
1769 ;; Here is very briefly how ido-find-file works:
1770 ;;
1771 ;; (ido-find-file)
1772 ;; (ido-file-internal method)
1773 ;; set ido-current-directory
1774 ;; (ido-read-internal 'file ...)
1775 ;; (while ...
1776 ;; (ido-make-item-list ...)
1777 ;; (ido-set-matches)
1778 ;; (completing-read ... ido-text-init ...)
1779 ;;
1780 ;; ... here user is allowed to type characters and commands
1781 ;; a command may set ido-exit and call (exit-minibuffer)
1782 ;; to make ido-read-internal do advanced tasks (or return)
1783 ;;
1784 ;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1785 ;; which are run before and after each user command.
1786 ;;
1787 ;; return value from completing-read is stored in ido-final-text
1788 ;; - ido-exit may cause further actions to be taken:
1789 ;; 'refresh - repeat loop (make-item-list, set-matches)
1790 ;; 'edit - edit the prompt string, then repeat loop
1791 ;; 'keep - repeat loop but don't (re)make-item-list
1792 ;; 'updir - go up one directory, repeat loop
1793 ;; else set ido-selected based on ido-final-text,
1794 ;; optionally update ido-current-directory and repeat loop, or
1795 ;; exit with the return value of ido-selected (file name)
1796 ;; selected file name is returned from ido-read-internal,
1797 ;; ido-exit and method determines what action is taken
1798 ;; e.g. the file name may be ignored or joined with ido-current-directory, and
1799 ;; the relevant function is called (find-file, write-file, etc).
1800
1801 (defun ido-read-internal (item prompt history &optional default require-match initial)
1802 "Perform the `ido-read-buffer' and `ido-read-file-name' functions.
1803 Return the name of a buffer or file selected.
1804 PROMPT is the prompt to give to the user.
1805 DEFAULT if given is the default item to start with.
1806 If REQUIRE-MATCH is non-nil, an existing file must be selected.
1807 If INITIAL is non-nil, it specifies the initial input string."
1808 (let
1809 ((ido-cur-item item)
1810 (ido-entry-buffer (current-buffer))
1811 (ido-process-ignore-lists t)
1812 (ido-process-ignore-lists-inhibit nil)
1813 (ido-set-default-item t)
1814 ido-default-item
1815 ido-selected
1816 ido-final-text
1817 (done nil)
1818 (icomplete-mode nil) ;; prevent icomplete starting up
1819 ;; Exported dynamic variables:
1820 ido-cur-list
1821 ido-ignored-list
1822 (ido-rotate-temp nil)
1823 (ido-keep-item-list nil)
1824 (ido-use-merged-list nil)
1825 (ido-try-merged-list t)
1826 (ido-pre-merge-state nil)
1827 (ido-case-fold ido-case-fold)
1828 (ido-enable-prefix ido-enable-prefix)
1829 (ido-enable-regexp ido-enable-regexp)
1830 )
1831
1832 (ido-setup-completion-map)
1833 (setq ido-text-init initial)
1834 (setq ido-input-stack nil)
1835
1836 (run-hooks 'ido-setup-hook)
1837
1838 (while (not done)
1839 (ido-trace "\n_LOOP_" ido-text-init)
1840 (setq ido-exit nil)
1841 (setq ido-rescan t)
1842 (setq ido-rotate nil)
1843 (setq ido-text "")
1844 (when ido-set-default-item
1845 (setq ido-default-item
1846 (cond
1847 ((eq item 'buffer)
1848 (if (bufferp default) (buffer-name default) default))
1849 ((stringp default)
1850 (if (memq item '(file dir))
1851 (file-name-nondirectory default)
1852 default))
1853 ((eq item 'file)
1854 (and ido-enable-last-directory-history
1855 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1856 (and d (cdr d)))))))
1857 (if (member ido-default-item ido-ignore-item-temp-list)
1858 (setq ido-default-item nil))
1859 (ido-trace "new default" ido-default-item)
1860 (if ido-default-item
1861 (setq ido-initial-position 0))
1862 (setq ido-set-default-item nil))
1863
1864 (if ido-process-ignore-lists-inhibit
1865 (setq ido-process-ignore-lists nil))
1866
1867 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1868 (let ((olist ido-cur-list)
1869 (oign ido-ignored-list)
1870 (omat ido-matches)
1871 (l (ido-make-merged-file-list ido-text-init
1872 (eq ido-use-merged-list 'auto)
1873 (eq ido-try-merged-list 'wide))))
1874 (ido-trace "merged" l)
1875 (cond
1876 ((not l)
1877 (if (eq ido-try-merged-list 'wide)
1878 (setq ido-pre-merge-state
1879 (list "" ido-current-directory olist oign omat)
1880 ido-cur-list nil
1881 ido-ignored-list nil
1882 ido-matches nil
1883 ido-keep-item-list t
1884 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1885 ido-use-merged-list nil)
1886 (setq ido-cur-list olist
1887 ido-ignored-list oign
1888 ido-matches omat
1889 ido-keep-item-list t
1890 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1891 ido-use-merged-list nil)))
1892 ((eq l t)
1893 (setq ido-use-merged-list nil))
1894 ((eq l 'input-pending-p)
1895 (setq ido-try-merged-list t
1896 ido-use-merged-list nil))
1897 (t
1898 (setq ido-pre-merge-state
1899 (list ido-text-init ido-current-directory olist oign omat))
1900 (ido-set-current-directory (car (cdr (car l))))
1901 (if (ido-final-slash ido-text-init)
1902 (setq ido-text-init ""))
1903 (setq ido-cur-list l
1904 ido-ignored-list nil
1905 ido-matches l
1906 ido-rescan nil
1907 ido-keep-item-list t
1908 ido-use-merged-list t)
1909 (ido-trace "Merged" t)
1910 ))))
1911
1912 (cond
1913 (ido-keep-item-list
1914 (setq ido-keep-item-list nil
1915 ido-rescan nil))
1916 ((eq ido-cur-item 'file)
1917 (setq ido-ignored-list nil
1918 ido-cur-list (and (not ido-directory-nonreadable)
1919 (not ido-directory-too-big)
1920 (ido-make-file-list ido-default-item))))
1921 ((eq ido-cur-item 'dir)
1922 (setq ido-ignored-list nil
1923 ido-cur-list (and (not ido-directory-nonreadable)
1924 (not ido-directory-too-big)
1925 (ido-make-dir-list ido-default-item))))
1926 ((eq ido-cur-item 'buffer)
1927 (setq ido-ignored-list nil
1928 ido-cur-list (ido-make-buffer-list ido-default-item)))
1929 ((eq ido-cur-item 'list)
1930 (setq ido-ignored-list nil
1931 ido-cur-list (ido-make-choice-list ido-default-item)))
1932 (t nil))
1933 (setq ido-rotate-temp nil)
1934
1935 (if ido-process-ignore-lists-inhibit
1936 (setq ido-process-ignore-lists t
1937 ido-process-ignore-lists-inhibit nil))
1938
1939 (ido-set-matches)
1940 (if (and ido-matches (eq ido-try-merged-list 'auto))
1941 (setq ido-try-merged-list t))
1942 (let
1943 ((minibuffer-local-completion-map
1944 (if (memq ido-cur-item '(file dir))
1945 minibuffer-local-completion-map
1946 ido-completion-map))
1947 (minibuffer-local-filename-completion-map
1948 (if (memq ido-cur-item '(file dir))
1949 ido-completion-map
1950 minibuffer-local-filename-completion-map))
1951 (max-mini-window-height (or ido-max-window-height
1952 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1953 (ido-completing-read t)
1954 (ido-require-match require-match)
1955 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1956 (show-paren-mode nil))
1957 ;; prompt the user for the file name
1958 (setq ido-exit nil)
1959 (setq ido-final-text
1960 (catch 'ido
1961 (completing-read
1962 (ido-make-prompt item prompt)
1963 '(("dummy" . 1)) nil nil ; table predicate require-match
1964 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1965 history))))
1966 (ido-trace "completing-read" ido-final-text)
1967 (if (get-buffer ido-completion-buffer)
1968 (kill-buffer ido-completion-buffer))
1969
1970 (ido-trace "\n_EXIT_" ido-exit)
1971
1972 (cond
1973 ((eq ido-exit 'refresh)
1974 (if (and (eq ido-use-merged-list 'auto)
1975 (or (input-pending-p)))
1976 (setq ido-use-merged-list nil
1977 ido-keep-item-list t))
1978 nil)
1979
1980 ((eq ido-exit 'done)
1981 (setq done t
1982 ido-selected ido-text
1983 ido-exit nil))
1984
1985 ((memq ido-exit '(edit chdir))
1986 (cond
1987 ((memq ido-cur-item '(file dir))
1988 (let* ((read-file-name-function nil)
1989 (edit (eq ido-exit 'edit))
1990 (d ido-current-directory)
1991 (f ido-text-init)
1992 (new t))
1993 (setq ido-text-init "")
1994 (while new
1995 (setq new (if edit
1996 (condition-case nil
1997 (read-file-name (concat prompt "[EDIT] ")
1998 (expand-file-name d)
1999 (concat d f) nil f)
2000 (quit (concat d f)))
2001 f)
2002 d (or (file-name-directory new) "/")
2003 f (file-name-nondirectory new)
2004 edit t)
2005 (if (or
2006 (file-directory-p d)
2007 (and (yes-or-no-p (format "Create directory %s? " d))
2008 (condition-case nil
2009 (progn (make-directory d t) t)
2010 (error
2011 (message "Could not create directory")
2012 (sit-for 1)
2013 nil))))
2014 (progn
2015 (ido-set-current-directory d nil (eq ido-exit 'chdir))
2016 (setq ido-text-init f
2017 new nil))))))
2018 (t
2019 (setq ido-text-init
2020 (condition-case nil
2021 (read-string (concat prompt "[EDIT] ") ido-final-text)
2022 (quit ido-final-text)))))
2023
2024 nil)
2025
2026 ((eq ido-exit 'keep)
2027 (setq ido-keep-item-list t))
2028
2029 ((memq ido-exit '(dired fallback find-file switch-to-buffer insert-buffer insert-file))
2030 (setq done t))
2031
2032 ((memq ido-exit '(updir push))
2033 ;; cannot go up if already at the root-dir (Unix) or at the
2034 ;; root-dir of a certain drive (Windows or MS-DOS).
2035 (if (ido-is-tramp-root)
2036 (when (string-match "\\`\\(/\\([^/]+[:@]\\)*\\)\\([^/]+\\)[:@]\\'" ido-current-directory)
2037 (setq ido-text-init (match-string 3 ido-current-directory))
2038 (ido-set-current-directory (match-string 1 ido-current-directory))
2039 (setq ido-set-default-item t))
2040 (unless (ido-is-root-directory)
2041 (when (eq ido-exit 'push)
2042 (setq ido-input-stack (cons (cons ido-cur-item ido-text) ido-input-stack))
2043 (setq ido-cur-item 'dir)
2044 (setq ido-text-init (file-name-nondirectory (substring ido-current-directory 0 -1)))
2045 (ido-trace "push" ido-input-stack))
2046 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1)))
2047 (setq ido-set-default-item t))))
2048
2049 ((eq ido-exit 'pop)
2050 (ido-trace "pop" ido-input-stack)
2051 (let ((elt (car ido-input-stack)))
2052 (setq ido-input-stack (cdr ido-input-stack))
2053 (ido-set-current-directory (concat ido-current-directory ido-text))
2054 (setq ido-cur-item (car elt))
2055 (setq ido-text-init (cdr elt))))
2056
2057 ((eq ido-exit 'pop-all)
2058 (ido-trace "pop-all" ido-input-stack)
2059 (while ido-input-stack
2060 (let ((elt (car ido-input-stack)))
2061 (setq ido-input-stack (cdr ido-input-stack))
2062 (ido-set-current-directory (concat ido-current-directory ido-text))
2063 (setq ido-cur-item (car elt))
2064 (setq ido-text-init (cdr elt)))))
2065
2066 ;; Handling the require-match must be done in a better way.
2067 ((and require-match
2068 (not (if ido-directory-too-big
2069 (file-exists-p (concat ido-current-directory ido-final-text))
2070 (ido-existing-item-p))))
2071 (error "Must specify valid item"))
2072
2073 (t
2074 (setq ido-selected
2075 (if (or (eq ido-exit 'takeprompt)
2076 (null ido-matches))
2077 ido-final-text
2078 ;; else take head of list
2079 (ido-name (car ido-matches))))
2080
2081 (cond
2082 ((memq item '(buffer list))
2083 (setq done t))
2084
2085 ((string-equal "./" ido-selected)
2086 nil)
2087
2088 ((string-equal "../" ido-selected)
2089 ;; cannot go up if already at the root-dir (Unix) or at the
2090 ;; root-dir of a certain drive (Windows or MS-DOS).
2091 (or (ido-is-root-directory)
2092 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
2093 (setq ido-set-default-item t))
2094
2095 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") ido-selected)
2096 (ido-is-root-directory) ;; Ange-ftp or Tramp
2097 (not (ido-local-file-exists-p ido-selected)))
2098 (ido-set-current-directory ido-current-directory ido-selected)
2099 (ido-trace "tramp prefix" ido-selected)
2100 (if (ido-is-slow-ftp-host)
2101 (setq ido-exit 'fallback
2102 done t)
2103 (setq ido-set-default-item t)))
2104
2105 ((or (string-match "[/\\][^/\\]" ido-selected)
2106 (and (memq system-type '(windows-nt ms-dos))
2107 (string-match "\\`[a-zA-Z]:" ido-selected)))
2108 (ido-set-current-directory (file-name-directory ido-selected))
2109 (setq ido-set-default-item t))
2110
2111 ((string-match "\\`~" ido-selected)
2112 (ido-set-current-home ido-selected))
2113
2114 ((ido-final-slash ido-selected)
2115 (if ido-enable-last-directory-history
2116 (let ((x (assoc ido-current-directory ido-last-directory-list)))
2117 (if x
2118 (setcdr x ido-selected)
2119 (setq ido-last-directory-list
2120 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
2121 (ido-set-current-directory ido-current-directory ido-selected)
2122 (if ido-input-stack
2123 ; automatically pop stack elements which match existing files or directories
2124 (let (elt)
2125 (while (and (setq elt (car ido-input-stack))
2126 (file-exists-p (concat ido-current-directory (cdr elt))))
2127 (if (setq ido-input-stack (cdr ido-input-stack))
2128 (ido-set-current-directory ido-current-directory (cdr elt))
2129 (setq ido-text-init (cdr elt)))
2130 (setq ido-cur-item (car elt))))
2131 (setq ido-set-default-item t)))
2132
2133 (t
2134 (setq done t))))))
2135 ido-selected))
2136
2137 (defun ido-edit-input ()
2138 "Edit absolute file name entered so far with ido; terminate by RET.
2139 If cursor is not at the end of the user input, move to end of input."
2140 (interactive)
2141 (if (not (eobp))
2142 (end-of-line)
2143 (setq ido-text-init (if ido-matches (ido-name (car ido-matches)) ido-text))
2144 (setq ido-exit 'edit)
2145 (exit-minibuffer)))
2146
2147 ;;; MAIN FUNCTIONS
2148 (defun ido-buffer-internal (method &optional fallback prompt default initial switch-cmd)
2149 ;; Internal function for ido-switch-buffer and friends
2150 (if (not ido-mode)
2151 (progn
2152 (run-hook-with-args 'ido-before-fallback-functions
2153 (or fallback 'switch-to-buffer))
2154 (call-interactively (or fallback 'switch-to-buffer)))
2155 (let* ((ido-context-switch-command switch-cmd)
2156 (ido-current-directory nil)
2157 (ido-directory-nonreadable nil)
2158 (ido-directory-too-big nil)
2159 (buf (ido-read-internal 'buffer (or prompt "Buffer: ") 'ido-buffer-history default nil initial)))
2160
2161 ;; Choose the buffer name: either the text typed in, or the head
2162 ;; of the list of matches
2163
2164 (cond
2165 ((eq ido-exit 'find-file)
2166 (ido-file-internal ido-default-file-method nil nil nil nil ido-text))
2167
2168 ((eq ido-exit 'insert-file)
2169 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil ido-text 'ido-enter-insert-buffer))
2170
2171 ((eq ido-exit 'fallback)
2172 (let ((read-buffer-function nil))
2173 (setq this-command (or fallback 'switch-to-buffer))
2174 (run-hook-with-args 'ido-before-fallback-functions this-command)
2175 (call-interactively this-command)))
2176
2177 ;; Check buf is non-nil.
2178 ((not buf) nil)
2179 ((= (length buf) 0) nil)
2180
2181 ;; View buffer if it exists
2182 ((get-buffer buf)
2183 (add-to-history 'buffer-name-history buf)
2184 (if (eq method 'insert)
2185 (progn
2186 (ido-record-command 'insert-buffer buf)
2187 (push-mark
2188 (save-excursion
2189 (insert-buffer-substring (get-buffer buf))
2190 (point))))
2191 (ido-visit-buffer buf method t)))
2192
2193 ;; buffer doesn't exist
2194 ((eq ido-create-new-buffer 'never)
2195 (message "No buffer matching `%s'" buf))
2196
2197 ((and (eq ido-create-new-buffer 'prompt)
2198 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
2199 nil)
2200
2201 ;; create a new buffer
2202 (t
2203 (add-to-history 'buffer-name-history buf)
2204 (setq buf (get-buffer-create buf))
2205 (if (fboundp 'set-buffer-major-mode)
2206 (set-buffer-major-mode buf))
2207 (ido-visit-buffer buf method t))))))
2208
2209 (defun ido-record-work-directory (&optional dir)
2210 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
2211 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
2212 (let ((items ido-work-directory-list-ignore-regexps)
2213 (case-fold-search nil))
2214 (while (and items dir)
2215 (if (string-match (car items) dir)
2216 (setq dir nil))
2217 (setq items (cdr items)))
2218 (if dir
2219 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
2220 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
2221 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
2222
2223 (defun ido-forget-work-directory ()
2224 (interactive)
2225 (when (and ido-current-directory ido-work-directory-list)
2226 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
2227 (when ido-use-merged-list
2228 (ido-undo-merge-work-directory)
2229 (setq ido-exit 'refresh
2230 ido-try-merged-list t
2231 ido-use-merged-list t
2232 ido-text-init ido-text
2233 ido-rotate-temp t)
2234 (exit-minibuffer))))
2235
2236 (defun ido-record-work-file (name)
2237 ;; Save NAME in ido-work-file-list
2238 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
2239 (or
2240 (and ido-work-file-list (equal (car ido-work-file-list) name))
2241 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
2242 (if (> (length ido-work-file-list) ido-max-work-file-list)
2243 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
2244
2245 (defun ido-expand-directory (dir)
2246 ;; Expand DIR or use DEFAULT-DIRECTORY if nil.
2247 ;; Add final slash to result in case it was missing from DEFAULT-DIRECTORY.
2248 (ido-final-slash (expand-file-name (or dir default-directory)) t))
2249
2250 (defun ido-file-internal (method &optional fallback default prompt item initial switch-cmd)
2251 ;; Internal function for ido-find-file and friends
2252 (unless item
2253 (setq item 'file))
2254 (let ((ido-current-directory (ido-expand-directory default))
2255 (ido-context-switch-command switch-cmd)
2256 ido-directory-nonreadable ido-directory-too-big
2257 filename)
2258
2259 (if (or (not ido-mode) (ido-is-slow-ftp-host))
2260 (setq filename t
2261 ido-exit 'fallback)
2262 (setq ido-directory-nonreadable
2263 (ido-nonreadable-directory-p ido-current-directory)
2264 ido-directory-too-big
2265 (and (not ido-directory-nonreadable)
2266 (ido-directory-too-big-p ido-current-directory))))
2267
2268 (when (and (eq item 'file)
2269 (or ido-use-url-at-point ido-use-filename-at-point))
2270 (let (fn d)
2271 (require 'ffap)
2272 ;; Duplicate code from ffap-guesser as we want different behavior for files and URLs.
2273 (cond
2274 ((with-no-warnings
2275 (and ido-use-url-at-point
2276 ffap-url-regexp
2277 (ffap-fixup-url (or (ffap-url-at-point)
2278 (ffap-gopher-at-point)))))
2279 (setq ido-exit 'ffap
2280 filename t))
2281
2282 ((and ido-use-filename-at-point
2283 (setq fn (with-no-warnings
2284 (if (eq ido-use-filename-at-point 'guess)
2285 (ffap-guesser)
2286 (ffap-string-at-point))))
2287 (not (string-match "^http:/" fn))
2288 (setq d (file-name-directory fn))
2289 (file-directory-p d))
2290 (setq ido-current-directory d)
2291 (setq initial (file-name-nondirectory fn))))))
2292
2293 (let (ido-saved-vc-hb
2294 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
2295 (ido-work-directory-index -1)
2296 (ido-work-file-index -1)
2297 (ido-find-literal nil))
2298
2299 (unless filename
2300 (setq ido-saved-vc-hb vc-handled-backends)
2301 (let ((minibuffer-completing-file-name t))
2302 (setq filename (ido-read-internal item
2303 (or prompt "Find file: ")
2304 'ido-file-history
2305 (and (eq method 'alt-file) buffer-file-name)
2306 nil initial))))
2307
2308 ;; Choose the file name: either the text typed in, or the head
2309 ;; of the list of matches
2310
2311 (cond
2312 ((eq ido-exit 'fallback)
2313 ;; Need to guard setting of default-directory here, since
2314 ;; we don't want to change directory of current buffer.
2315 (let ((default-directory ido-current-directory)
2316 (read-file-name-function nil))
2317 (setq this-command (or fallback 'find-file))
2318 (run-hook-with-args 'ido-before-fallback-functions this-command)
2319 (call-interactively this-command)))
2320
2321 ((eq ido-exit 'switch-to-buffer)
2322 (ido-buffer-internal ido-default-buffer-method nil nil nil ido-text))
2323
2324 ((eq ido-exit 'insert-buffer)
2325 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil ido-text 'ido-enter-insert-file))
2326
2327 ((eq ido-exit 'dired)
2328 (dired (concat ido-current-directory (or ido-text ""))))
2329
2330 ((eq ido-exit 'ffap)
2331 (find-file-at-point))
2332
2333 ((eq method 'alt-file)
2334 (ido-record-work-file filename)
2335 (setq default-directory ido-current-directory)
2336 (ido-record-work-directory)
2337 (find-alternate-file filename))
2338
2339 ((memq method '(dired list-directory))
2340 (if (equal filename ".")
2341 (setq filename ""))
2342 (let* ((dirname (ido-final-slash (concat ido-current-directory filename) t))
2343 (file (substring dirname 0 -1)))
2344 (cond
2345 ((file-directory-p dirname)
2346 (ido-record-command method dirname)
2347 (ido-record-work-directory dirname)
2348 (funcall method dirname))
2349 ((file-directory-p ido-current-directory)
2350 (cond
2351 ((file-exists-p file)
2352 (ido-record-command method ido-current-directory)
2353 (ido-record-work-directory)
2354 (funcall method ido-current-directory)
2355 (if (eq method 'dired)
2356 (with-no-warnings
2357 (dired-goto-file (expand-file-name file)))))
2358 ((string-match "[[*?]" filename)
2359 (setq dirname (concat ido-current-directory filename))
2360 (ido-record-command method dirname)
2361 (ido-record-work-directory)
2362 (funcall method dirname))
2363 ((y-or-n-p (format "Directory %s does not exist. Create it? " filename))
2364 (ido-record-command method dirname)
2365 (ido-record-work-directory dirname)
2366 (make-directory-internal dirname)
2367 (funcall method dirname))
2368 (t
2369 ;; put make-directory command on history
2370 (ido-record-command 'make-directory dirname))))
2371 (t (error "No such directory")))))
2372
2373 ((eq method 'write)
2374 (ido-record-work-file filename)
2375 (setq default-directory ido-current-directory)
2376 (setq filename (concat ido-current-directory filename))
2377 (ido-record-command 'write-file filename)
2378 (add-to-history 'file-name-history filename)
2379 (ido-record-work-directory)
2380 (write-file filename))
2381
2382 ((eq method 'read-only)
2383 (ido-record-work-file filename)
2384 (setq filename (concat ido-current-directory filename))
2385 (ido-record-command fallback filename)
2386 (ido-record-work-directory)
2387 (run-hook-with-args 'ido-before-fallback-functions fallback)
2388 (funcall fallback filename))
2389
2390 ((eq method 'insert)
2391 (ido-record-work-file filename)
2392 (setq filename (concat ido-current-directory filename))
2393 (ido-record-command
2394 (if ido-find-literal 'insert-file-literally 'insert-file)
2395 filename)
2396 (add-to-history 'file-name-history filename)
2397 (ido-record-work-directory)
2398 (insert-file-1 filename
2399 (if ido-find-literal
2400 #'insert-file-contents-literally
2401 #'insert-file-contents)))
2402
2403 (filename
2404 (ido-record-work-file filename)
2405 (setq filename (concat ido-current-directory filename))
2406 (ido-record-command 'find-file filename)
2407 (add-to-history 'file-name-history filename)
2408 (ido-record-work-directory)
2409 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
2410
2411 (defun ido-existing-item-p ()
2412 ;; Return non-nil if there is a matching item
2413 (not (null ido-matches)))
2414
2415 ;;; COMPLETION CODE
2416
2417 (defun ido-set-common-completion ()
2418 ;; Find common completion of `ido-text' in `ido-matches'
2419 ;; The result is stored in `ido-common-match-string'
2420 (let (val)
2421 (setq ido-common-match-string nil)
2422 (if (and ido-matches
2423 (not ido-enable-regexp) ;; testing
2424 (stringp ido-text)
2425 (> (length ido-text) 0))
2426 (if (setq val (ido-find-common-substring ido-matches ido-text))
2427 (setq ido-common-match-string val)))
2428 val))
2429
2430 (defun ido-complete ()
2431 "Try and complete the current pattern amongst the file names."
2432 (interactive)
2433 (let (res)
2434 (cond
2435 (ido-incomplete-regexp
2436 ;; Do nothing
2437 )
2438 ((and (memq ido-cur-item '(file dir))
2439 (string-match "[$]" ido-text))
2440 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
2441 (if (not (file-exists-p (file-name-directory evar)))
2442 (message "Expansion generates non-existing directory name")
2443 (if (file-directory-p evar)
2444 (ido-set-current-directory evar)
2445 (let ((d (or (file-name-directory evar) "/"))
2446 (f (file-name-nondirectory evar)))
2447 (when (file-directory-p d)
2448 (ido-set-current-directory d)
2449 (setq ido-text-init f))))
2450 (setq ido-exit 'refresh)
2451 (exit-minibuffer))))
2452
2453 (ido-directory-too-big
2454 (setq ido-directory-too-big nil)
2455 (setq ido-text-init ido-text)
2456 (setq ido-exit 'refresh)
2457 (exit-minibuffer))
2458
2459 ((not ido-matches)
2460 (when ido-completion-buffer
2461 (call-interactively (setq this-command ido-cannot-complete-command))))
2462
2463 ((and (= 1 (length ido-matches))
2464 (not (and ido-enable-tramp-completion
2465 (string-equal ido-current-directory "/")
2466 (string-match ".[@:]\\'" (ido-name (car ido-matches)))))
2467 (not (ido-local-file-exists-p (ido-name (car ido-matches)))))
2468 ;; only one choice, so select it.
2469 (if (not ido-confirm-unique-completion)
2470 (exit-minibuffer)
2471 (setq ido-rescan (not ido-enable-prefix))
2472 (delete-region (minibuffer-prompt-end) (point))
2473 (insert (ido-name (car ido-matches)))))
2474
2475 (t ;; else there could be some completions
2476 (setq res ido-common-match-string)
2477 (if (and (not (memq res '(t nil)))
2478 (not (equal res ido-text)))
2479 ;; found something to complete, so put it in the minibuffer.
2480 (progn
2481 ;; move exact match to front if not in prefix mode
2482 (setq ido-rescan (not ido-enable-prefix))
2483 (delete-region (minibuffer-prompt-end) (point))
2484 (insert res))
2485 ;; else nothing to complete
2486 (call-interactively (setq this-command ido-cannot-complete-command))
2487 )))))
2488
2489 (defun ido-complete-space ()
2490 "Try completion unless inserting the space makes sense."
2491 (interactive)
2492 (if (and (stringp ido-common-match-string)
2493 (stringp ido-text)
2494 (cond
2495 ((> (length ido-common-match-string) (length ido-text))
2496 (= (aref ido-common-match-string (length ido-text)) ? ))
2497 (ido-matches
2498 (let (insert-space
2499 (re (concat (regexp-quote ido-text) " "))
2500 (comp ido-matches))
2501 (while comp
2502 (if (string-match re (ido-name (car comp)))
2503 (setq comp nil insert-space t)
2504 (setq comp (cdr comp))))
2505 insert-space))
2506 (t nil)))
2507 (insert " ")
2508 (ido-complete)))
2509
2510 (defun ido-undo-merge-work-directory (&optional text try refresh)
2511 "Undo or redo last ido directory merge operation.
2512 If no merge has yet taken place, toggle automatic merging option."
2513 (interactive)
2514 (cond
2515 (ido-pre-merge-state
2516 (ido-set-current-directory (nth 1 ido-pre-merge-state))
2517 (setq ido-text-init (or text (car ido-pre-merge-state))
2518 ido-cur-list (nth 2 ido-pre-merge-state)
2519 ido-ignored-list (nth 3 ido-pre-merge-state)
2520 ido-matches (nth 4 ido-pre-merge-state)
2521 ido-use-merged-list nil
2522 ido-try-merged-list try
2523 ido-keep-item-list (not refresh)
2524 ido-rescan nil
2525 ido-exit 'refresh
2526 ido-pre-merge-state nil)
2527 (exit-minibuffer))
2528 (text
2529 nil)
2530 (ido-try-merged-list
2531 (setq ido-try-merged-list nil))
2532 (ido-matches
2533 (setq ido-try-merged-list t))
2534 ((not ido-use-merged-list)
2535 (ido-merge-work-directories))))
2536
2537 ;;; Magic C-f
2538
2539 (defun ido-magic-forward-char (arg)
2540 "Move forward in user input or perform magic action.
2541 If no user input is present, or at end of input, perform magic actions:
2542 C-x C-b ... C-f switch to ido-find-file.
2543 C-x C-f ... C-f fallback to non-ido find-file.
2544 C-x C-d ... C-f fallback to non-ido brief dired.
2545 C-x d ... C-f fallback to non-ido dired."
2546 (interactive "P")
2547 (cond
2548 ((or arg (not (eobp)))
2549 (forward-char (min (prefix-numeric-value arg)
2550 (- (point-max) (point)))))
2551 ((memq ido-cur-item '(file dir))
2552 (ido-fallback-command))
2553 (ido-context-switch-command
2554 (call-interactively ido-context-switch-command))
2555 ((eq ido-cur-item 'buffer)
2556 (ido-enter-find-file))))
2557
2558 ;;; Magic C-b
2559
2560 (defun ido-magic-backward-char (arg)
2561 "Move backward in user input or perform magic action.
2562 If no user input is present, or at start of input, perform magic actions:
2563 C-x C-f C-b switch to `ido-switch-buffer'.
2564 C-x C-d C-b switch to `ido-switch-buffer'.
2565 C-x d C-b switch to `ido-switch-buffer'.
2566 C-x C-b C-b fallback to non-ido `switch-to-buffer'."
2567 (interactive "P")
2568 (cond
2569 ((or arg (> (point) (minibuffer-prompt-end)))
2570 (forward-char
2571 (- (min (prefix-numeric-value arg)
2572 (- (point) (minibuffer-prompt-end))))))
2573 ((eq last-command this-command)
2574 (when (and (memq ido-cur-item '(file dir))
2575 (not (bobp)))
2576 (ido-push-dir))) ; else do nothing
2577 ((eq ido-cur-item 'buffer)
2578 (ido-fallback-command))
2579 (ido-context-switch-command
2580 (call-interactively ido-context-switch-command))
2581 (t
2582 (ido-enter-switch-buffer))))
2583
2584 ;;; Magic C-d
2585
2586 (defun ido-magic-delete-char (arg)
2587 "Delete following char in user input or perform magic action.
2588 If at end of user input, perform magic actions:
2589 C-x C-f ... C-d enter dired on current directory."
2590 (interactive "P")
2591 (cond
2592 ((or arg (not (eobp)))
2593 (delete-char (min (prefix-numeric-value arg)
2594 (- (point-max) (point)))))
2595 (ido-context-switch-command
2596 nil)
2597 ((memq ido-cur-item '(file dir))
2598 (ido-enter-dired))))
2599
2600
2601 ;;; TOGGLE FUNCTIONS
2602
2603 (defun ido-toggle-case ()
2604 "Toggle the value of `ido-case-fold'."
2605 (interactive)
2606 (setq ido-case-fold (not ido-case-fold))
2607 ;; ask for list to be regenerated.
2608 (setq ido-rescan t))
2609
2610 (defun ido-toggle-regexp ()
2611 "Toggle the value of `ido-enable-regexp'."
2612 (interactive)
2613 (setq ido-enable-regexp (not ido-enable-regexp))
2614 ;; ask for list to be regenerated.
2615 (setq ido-rescan t))
2616
2617 (defun ido-toggle-prefix ()
2618 "Toggle the value of `ido-enable-prefix'."
2619 (interactive)
2620 (setq ido-enable-prefix (not ido-enable-prefix))
2621 ;; ask for list to be regenerated.
2622 (setq ido-rescan t))
2623
2624 (defun ido-toggle-ignore ()
2625 "Toggle ignoring files specified with `ido-ignore-files'."
2626 (interactive)
2627 (if (and (not (eobp)) (> (point) (minibuffer-prompt-end)))
2628 (goto-char (minibuffer-prompt-end))
2629 (if ido-directory-too-big
2630 (progn
2631 (message "Reading directory...")
2632 (setq ido-directory-too-big nil))
2633 (setq ido-process-ignore-lists (not ido-process-ignore-lists)))
2634 (setq ido-text-init ido-text)
2635 (setq ido-exit 'refresh)
2636 (exit-minibuffer)))
2637
2638 (defun ido-toggle-vc ()
2639 "Disable version control for this file."
2640 (interactive)
2641 (if (and ido-mode (eq ido-cur-item 'file))
2642 (progn
2643 (setq vc-handled-backends
2644 (if vc-handled-backends nil ido-saved-vc-hb))
2645 (setq ido-text-init ido-text)
2646 (setq ido-exit 'keep)
2647 (exit-minibuffer))))
2648
2649 (defun ido-toggle-literal ()
2650 "Toggle literal reading of this file."
2651 (interactive)
2652 (if (and ido-mode (eq ido-cur-item 'file))
2653 (progn
2654 (setq ido-find-literal (not ido-find-literal))
2655 (setq ido-text-init ido-text)
2656 (setq ido-exit 'keep)
2657 (exit-minibuffer))))
2658
2659 (defun ido-reread-directory ()
2660 "Read current directory again.
2661 May be useful if cached version is no longer valid, but directory
2662 timestamp has not changed (e.g. with ftp or on Windows)."
2663 (interactive)
2664 (if (and ido-mode (memq ido-cur-item '(file dir)))
2665 (progn
2666 (if (ido-is-unc-root)
2667 (setq ido-unc-hosts-cache t)
2668 (ido-remove-cached-dir ido-current-directory))
2669 (setq ido-text-init ido-text)
2670 (setq ido-rotate-temp t)
2671 (setq ido-exit 'refresh)
2672 (exit-minibuffer))))
2673
2674 (defun ido-exit-minibuffer ()
2675 "Exit minibuffer, but make sure we have a match if one is needed."
2676 (interactive)
2677 (if (and (or (not ido-require-match)
2678 (ido-existing-item-p))
2679 (not ido-incomplete-regexp))
2680 (exit-minibuffer)))
2681
2682 (defun ido-select-text ()
2683 "Select the buffer or file named by the prompt.
2684 If no buffer or file exactly matching the prompt exists, maybe create a new one."
2685 (interactive)
2686 (setq ido-exit 'takeprompt)
2687 (exit-minibuffer))
2688
2689 (defun ido-fallback-command ()
2690 "Fallback to non-ido version of current command."
2691 (interactive)
2692 (let ((i (length ido-text)))
2693 (while (> i 0)
2694 (push (aref ido-text (setq i (1- i))) unread-command-events)))
2695 (setq ido-exit 'fallback)
2696 (exit-minibuffer))
2697
2698 (defun ido-enter-find-file ()
2699 "Drop into `find-file' from buffer switching."
2700 (interactive)
2701 (setq ido-exit 'find-file)
2702 (exit-minibuffer))
2703
2704 (defun ido-enter-switch-buffer ()
2705 "Drop into `ido-switch-buffer' from file switching."
2706 (interactive)
2707 (setq ido-exit 'switch-to-buffer)
2708 (exit-minibuffer))
2709
2710 (defun ido-enter-dired ()
2711 "Drop into `dired' from file switching."
2712 (interactive)
2713 (setq ido-exit 'dired)
2714 (exit-minibuffer))
2715
2716 (defun ido-enter-insert-buffer ()
2717 "Drop into `insert-buffer' from insert file."
2718 (interactive)
2719 (setq ido-exit 'insert-buffer)
2720 (exit-minibuffer))
2721
2722 (defun ido-enter-insert-file ()
2723 "Drop into `insert-file' from insert buffer."
2724 (interactive)
2725 (setq ido-exit 'insert-file)
2726 (exit-minibuffer))
2727
2728
2729 (defun ido-up-directory (&optional clear)
2730 "Go up one directory level."
2731 (interactive "P")
2732 (setq ido-text-init (if clear nil ido-text))
2733 (setq ido-exit 'updir)
2734 (setq ido-rotate-temp t)
2735 (exit-minibuffer))
2736
2737 (defun ido-delete-backward-updir (count)
2738 "Delete char backwards, or at beginning of buffer, go up one level."
2739 (interactive "P")
2740 (cond
2741 ((= (minibuffer-prompt-end) (point))
2742 (if (not count)
2743 (ido-up-directory t)))
2744 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2745 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
2746 ((eq this-original-command 'viper-backward-char)
2747 (funcall this-original-command (prefix-numeric-value count)))
2748 ((eq this-original-command 'viper-del-backward-char-in-insert)
2749 (funcall this-original-command))
2750 (t
2751 (delete-backward-char (prefix-numeric-value count)))))
2752
2753 (defun ido-delete-backward-word-updir (count)
2754 "Delete all chars backwards, or at beginning of buffer, go up one level."
2755 (interactive "P")
2756 (if (= (minibuffer-prompt-end) (point))
2757 (if (not count)
2758 (ido-up-directory t))
2759 (if (eq this-original-command 'viper-delete-backward-word)
2760 (funcall this-original-command (prefix-numeric-value count))
2761 (backward-kill-word (prefix-numeric-value count)))))
2762
2763 (defun ido-get-work-directory (&optional incr must-match)
2764 (let ((n (length ido-work-directory-list))
2765 (i ido-work-directory-index)
2766 (j 0)
2767 dir)
2768 (if (or (not ido-text) (= (length ido-text) 0))
2769 (setq must-match nil))
2770 (while (< j n)
2771 (setq i (+ i incr)
2772 j (1+ j))
2773 (if (> incr 0)
2774 (if (>= i n) (setq i 0))
2775 (if (< i 0) (setq i (1- n))))
2776 (setq dir (nth i ido-work-directory-list))
2777 (if (and dir
2778 (not (equal dir ido-current-directory))
2779 (file-directory-p dir)
2780 (or (not must-match)
2781 ;; TODO. check for nonreadable and too-big.
2782 (ido-set-matches-1
2783 (if (eq ido-cur-item 'file)
2784 (ido-make-file-list-1 dir)
2785 (ido-make-dir-list-1 dir)))))
2786 (setq j n)
2787 (setq dir nil)))
2788 (if dir
2789 (setq ido-work-directory-index i))
2790 dir))
2791
2792 (defun ido-prev-work-directory ()
2793 "Change to next working directory in list."
2794 (interactive)
2795 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2796 (when dir
2797 (ido-set-current-directory dir)
2798 (setq ido-exit 'refresh)
2799 (setq ido-text-init ido-text)
2800 (setq ido-rotate-temp t)
2801 (exit-minibuffer))))
2802
2803 (defun ido-next-work-directory ()
2804 "Change to previous working directory in list."
2805 (interactive)
2806 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2807 (when dir
2808 (ido-set-current-directory dir)
2809 (setq ido-exit 'refresh)
2810 (setq ido-text-init ido-text)
2811 (setq ido-rotate-temp t)
2812 (exit-minibuffer))))
2813
2814 (defun ido-merge-work-directories ()
2815 "Search (and merge) work directories for files matching the current input string."
2816 (interactive)
2817 (setq ido-use-merged-list t ido-try-merged-list t)
2818 (setq ido-exit 'refresh)
2819 (setq ido-text-init ido-text)
2820 (setq ido-rotate-temp t)
2821 (exit-minibuffer))
2822
2823 (defun ido-wide-find-file (&optional file)
2824 "Prompt for FILE to search for using find, starting from current directory."
2825 (interactive)
2826 (unless file
2827 (let ((enable-recursive-minibuffers t))
2828 (setq file
2829 (condition-case nil
2830 (read-string (concat "Wide find file: " ido-current-directory) ido-text)
2831 (quit "")))))
2832 (when (> (length file) 0)
2833 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2834 (setq ido-exit 'refresh)
2835 (setq ido-text-init file)
2836 (setq ido-rotate-temp t)
2837 (exit-minibuffer)))
2838
2839 (defun ido-wide-find-dir (&optional dir)
2840 "Prompt for DIR to search for using find, starting from current directory."
2841 (interactive)
2842 (unless dir
2843 (let ((enable-recursive-minibuffers t))
2844 (setq dir
2845 (condition-case nil
2846 (read-string (concat "Wide find directory: " ido-current-directory) ido-text)
2847 (quit "")))))
2848 (when (> (length dir) 0)
2849 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2850 (setq ido-exit 'refresh)
2851 (setq ido-text-init (ido-final-slash dir t))
2852 (setq ido-rotate-temp t)
2853 (exit-minibuffer)))
2854
2855 (defun ido-wide-find-dir-or-delete-dir (&optional dir)
2856 "Prompt for DIR to search for using find, starting from current directory.
2857 If input stack is non-empty, delete current directory component."
2858 (interactive)
2859 (if ido-input-stack
2860 (ido-delete-backward-word-updir 1)
2861 (ido-wide-find-dir)))
2862
2863 (defun ido-take-first-match ()
2864 "Use first matching item as input text."
2865 (interactive)
2866 (when ido-matches
2867 (setq ido-text-init (ido-name (car ido-matches)))
2868 (setq ido-exit 'refresh)
2869 (exit-minibuffer)))
2870
2871 (defun ido-push-dir ()
2872 "Move to previous directory in file name, push current input on stack."
2873 (interactive)
2874 (setq ido-exit 'push)
2875 (exit-minibuffer))
2876
2877 (defun ido-push-dir-first ()
2878 "Move to previous directory in file name, push first match on stack."
2879 (interactive)
2880 (if ido-matches
2881 (setq ido-text (ido-name (car ido-matches))))
2882 (setq ido-exit 'push)
2883 (exit-minibuffer))
2884
2885 (defun ido-pop-dir (arg)
2886 "Pop directory from input stack back to input.
2887 With \\[universal-argument], pop all element."
2888 (interactive "P")
2889 (when ido-input-stack
2890 (setq ido-exit (if arg 'pop-all 'pop))
2891 (exit-minibuffer)))
2892
2893 (defun ido-wide-find-file-or-pop-dir (arg)
2894 (interactive "P")
2895 (if ido-input-stack
2896 (ido-pop-dir arg)
2897 (ido-wide-find-file)))
2898
2899 (defun ido-make-directory (&optional dir)
2900 "Prompt for DIR to create in current directory."
2901 (interactive)
2902 (unless dir
2903 (let ((enable-recursive-minibuffers t))
2904 (setq dir
2905 (read-string (concat "Make directory: " ido-current-directory) ido-text))))
2906 (when (> (length dir) 0)
2907 (setq dir (concat ido-current-directory dir))
2908 (unless (file-exists-p dir)
2909 (make-directory dir t)
2910 (ido-set-current-directory dir)
2911 (setq ido-exit 'refresh)
2912 (setq ido-text-init nil)
2913 (setq ido-rotate-temp t)
2914 (exit-minibuffer))))
2915
2916 (defun ido-get-work-file (incr)
2917 (let ((n (length ido-work-file-list))
2918 (i (+ ido-work-file-index incr))
2919 name)
2920 (if (> incr 0)
2921 (if (>= i n) (setq i 0))
2922 (if (< i 0) (setq i (1- n))))
2923 (setq name (nth i ido-work-file-list))
2924 (setq ido-work-file-index i)
2925 name))
2926
2927 (defun ido-prev-work-file ()
2928 "Change to next working file name in list."
2929 (interactive)
2930 (let ((name (ido-get-work-file 1)))
2931 (when name
2932 (setq ido-text-init name)
2933 (setq ido-exit 'refresh)
2934 (exit-minibuffer))))
2935
2936 (defun ido-next-work-file ()
2937 "Change to previous working file name in list."
2938 (interactive)
2939 (let ((name (ido-get-work-file -1)))
2940 (when name
2941 (setq ido-text-init name)
2942 (setq ido-exit 'refresh)
2943 (exit-minibuffer))))
2944
2945 (defun ido-copy-current-file-name (all)
2946 "Insert file name of current buffer.
2947 If repeated, insert text from buffer instead."
2948 (interactive "P")
2949 (let* ((bfname (or (buffer-file-name ido-entry-buffer)
2950 (buffer-name ido-entry-buffer)))
2951 (name (and bfname (file-name-nondirectory bfname))))
2952 (when name
2953 (setq ido-text-init
2954 (if (or all
2955 (eq last-command this-command)
2956 (not (equal (file-name-directory bfname) ido-current-directory))
2957 (not (string-match "\\.[^.]*\\'" name)))
2958 name
2959 (substring name 0 (1+ (match-beginning 0)))))
2960 (setq ido-exit 'refresh
2961 ido-try-merged-list nil)
2962 (exit-minibuffer))))
2963
2964 (defun ido-copy-current-word (all)
2965 "Insert current word (file or directory name) from current buffer."
2966 (interactive "P")
2967 (let ((word (save-excursion
2968 (set-buffer ido-entry-buffer)
2969 (let ((p (point)) start-line end-line start-name name)
2970 (if (and mark-active (/= p (mark)))
2971 (setq start-name (mark))
2972 (beginning-of-line)
2973 (setq start-line (point))
2974 (end-of-line)
2975 (setq end-line (point))
2976 (goto-char p)
2977 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
2978 (forward-char 1))
2979 (setq start-name (point))
2980 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
2981 (if (= start-name (point))
2982 (setq start-name nil)))
2983 (and start-name
2984 (buffer-substring-no-properties start-name (point)))))))
2985 (if (cond
2986 ((not word) nil)
2987 ((string-match "\\`[~/]" word)
2988 (setq ido-text-init word
2989 ido-try-merged-list nil
2990 ido-exit 'chdir))
2991 ((string-match "/" word)
2992 (setq ido-text-init (concat ido-current-directory word)
2993 ido-try-merged-list nil
2994 ido-exit 'chdir))
2995 (t
2996 (setq ido-text-init word
2997 ido-try-merged-list nil
2998 ido-exit 'refresh)))
2999 (exit-minibuffer))))
3000
3001 (defun ido-next-match ()
3002 "Put first element of `ido-matches' at the end of the list."
3003 (interactive)
3004 (if ido-matches
3005 (let ((next (cadr ido-matches)))
3006 (setq ido-cur-list (ido-chop ido-cur-list next))
3007 (setq ido-rescan t)
3008 (setq ido-rotate t))))
3009
3010 (defun ido-prev-match ()
3011 "Put last element of `ido-matches' at the front of the list."
3012 (interactive)
3013 (if ido-matches
3014 (let ((prev (car (last ido-matches))))
3015 (setq ido-cur-list (ido-chop ido-cur-list prev))
3016 (setq ido-rescan t)
3017 (setq ido-rotate t))))
3018
3019 (defun ido-next-match-dir ()
3020 "Find next directory in match list.
3021 If work directories have been merged, cycle through directories for
3022 first matching file."
3023 (interactive)
3024 (if ido-use-merged-list
3025 (if ido-matches
3026 (let* ((elt (car ido-matches))
3027 (dirs (cdr elt)))
3028 (when (> (length dirs) 1)
3029 (setcdr elt (ido-chop dirs (cadr dirs))))
3030 (setq ido-rescan nil)))
3031 (let ((cnt (length ido-matches))
3032 (i 1))
3033 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
3034 (setq i (1+ i)))
3035 (if (< i cnt)
3036 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3037
3038 (defun ido-prev-match-dir ()
3039 "Find previous directory in match list.
3040 If work directories have been merged, cycle through directories
3041 for first matching file."
3042 (interactive)
3043 (if ido-use-merged-list
3044 (if ido-matches
3045 (let* ((elt (car ido-matches))
3046 (dirs (cdr elt)))
3047 (when (> (length dirs) 1)
3048 (setcdr elt (ido-chop dirs (car (last dirs)))))
3049 (setq ido-rescan nil)))
3050 (let* ((cnt (length ido-matches))
3051 (i (1- cnt)))
3052 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
3053 (setq i (1- i)))
3054 (if (> i 0)
3055 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
3056
3057 (defun ido-restrict-to-matches ()
3058 "Set current item list to the currently matched items."
3059 (interactive)
3060 (when ido-matches
3061 (setq ido-cur-list ido-matches
3062 ido-text-init ""
3063 ido-rescan nil
3064 ido-exit 'keep)
3065 (exit-minibuffer)))
3066
3067 (defun ido-chop (items elem)
3068 "Remove all elements before ELEM and put them at the end of ITEMS."
3069 (let ((ret nil)
3070 (next nil)
3071 (sofar nil))
3072 (while (not ret)
3073 (setq next (car items))
3074 (if (equal next elem)
3075 (setq ret (append items (nreverse sofar)))
3076 ;; else
3077 (progn
3078 (setq items (cdr items))
3079 (setq sofar (cons next sofar)))))
3080 ret))
3081
3082 (defun ido-name (item)
3083 ;; Return file name for current item, whether in a normal list
3084 ;; or a merged work directory list.
3085 (if (consp item) (car item) item))
3086
3087
3088 ;;; CREATE LIST OF ALL CURRENT FILES
3089
3090 (defun ido-all-completions ()
3091 ;; Return unsorted list of all competions.
3092 (let ((ido-process-ignore-lists nil)
3093 (ido-directory-too-big nil))
3094 (cond
3095 ((eq ido-cur-item 'file)
3096 (ido-make-file-list-1 ido-current-directory))
3097 ((eq ido-cur-item 'dir)
3098 (ido-make-dir-list-1 ido-current-directory))
3099 ((eq ido-cur-item 'buffer)
3100 (ido-make-buffer-list-1))
3101 ((eq ido-cur-item 'list)
3102 ido-choice-list)
3103 (t nil))))
3104
3105
3106 ;; File list sorting
3107
3108 (defun ido-file-lessp (a b)
3109 ;; Simple compare two file names.
3110 (string-lessp (ido-no-final-slash a) (ido-no-final-slash b)))
3111
3112
3113 (defun ido-file-extension-lessp (a b)
3114 ;; Compare file names according to ido-file-extensions-order list.
3115 (let ((n (compare-strings a 0 nil b 0 nil nil))
3116 lessp p)
3117 (if (eq n t)
3118 nil
3119 (if (< n 0)
3120 (setq n (1- (- n))
3121 p a a b b p
3122 lessp t)
3123 (setq n (1- n)))
3124 (cond
3125 ((= n 0)
3126 lessp)
3127 ((= (aref a n) ?.)
3128 (ido-file-extension-aux a b n lessp))
3129 (t
3130 (while (and (> n 2) (/= (aref a n) ?.))
3131 (setq n (1- n)))
3132 (if (> n 1)
3133 (ido-file-extension-aux a b n lessp)
3134 lessp))))))
3135
3136 (defun ido-file-extension-aux (a b n lessp)
3137 (let ((oa (ido-file-extension-order a n))
3138 (ob (ido-file-extension-order b n)))
3139 (cond
3140 ((and oa ob)
3141 (cond
3142 ((= oa ob)
3143 lessp)
3144 (lessp
3145 (> oa ob))
3146 (t
3147 (< oa ob))))
3148 (oa
3149 (not lessp))
3150 (ob
3151 lessp)
3152 (t
3153 lessp))))
3154
3155 (defun ido-file-extension-order (s n)
3156 (let ((l ido-file-extensions-order)
3157 (i 0) o do)
3158 (while l
3159 (cond
3160 ((eq (car l) t)
3161 (setq do i
3162 l (cdr l)))
3163 ((eq (compare-strings s n nil (car l) 0 nil nil) t)
3164 (setq o i
3165 l nil))
3166 (t
3167 (setq l (cdr l))))
3168 (setq i (1+ i)))
3169 (or o do)))
3170
3171
3172 (defun ido-sort-merged-list (items promote)
3173 ;; Input is list of ("file" . "dir") cons cells.
3174 ;; Output is sorted list of ("file "dir" ...) lists
3175 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
3176 res a cur dirs)
3177 (while l
3178 (setq a (car l)
3179 l (cdr l))
3180 (if (and res (string-equal (car (car res)) (car a)))
3181 (progn
3182 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
3183 (if (and promote (string-equal ido-current-directory (cdr a)))
3184 (setq cur t)))
3185 (setq res (cons (list (car a) (cdr a)) res)
3186 cur nil)))
3187 res))
3188
3189 (defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
3190 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
3191 (let ((filenames
3192 (split-string
3193 (shell-command-to-string
3194 (concat "find "
3195 (shell-quote-argument dir)
3196 " -name "
3197 (shell-quote-argument
3198 (concat (if prefix "" "*") file "*"))
3199 " -type " (if finddir "d" "f") " -print"))))
3200 filename d f
3201 res)
3202 (while filenames
3203 (setq filename (car filenames)
3204 filenames (cdr filenames))
3205 (if (and (string-match "^/" filename)
3206 (file-exists-p filename))
3207 (setq d (file-name-directory filename)
3208 f (file-name-nondirectory filename)
3209 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
3210 res))
3211
3212 (defun ido-flatten-merged-list (items)
3213 ;; Create a list of directory names based on a merged directory list.
3214 (let (res)
3215 (while items
3216 (let* ((item (car items))
3217 (file (car item))
3218 (dirs (cdr item)))
3219 (while dirs
3220 (setq res (cons (concat (car dirs) file) res)
3221 dirs (cdr dirs))))
3222 (setq items (cdr items)))
3223 res))
3224
3225
3226 (defun ido-make-merged-file-list-1 (text auto wide)
3227 (let (res)
3228 (if (and (ido-final-slash text) ido-dir-file-cache)
3229 (if wide
3230 (setq res (ido-wide-find-dirs-or-files
3231 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
3232 ;; Use list of cached directories
3233 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
3234 (dirs ido-dir-file-cache)
3235 dir b d f)
3236 (if nil ;; simple
3237 (while dirs
3238 (setq dir (car (car dirs))
3239 dirs (cdr dirs))
3240 (when (and (string-match re dir)
3241 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
3242 (file-directory-p dir))
3243 (setq b (substring dir 0 -1)
3244 f (concat (file-name-nondirectory b) "/")
3245 d (file-name-directory b)
3246 res (cons (cons f d) res))))
3247 (while dirs
3248 (setq dir (car dirs)
3249 d (car dir)
3250 dirs (cdr dirs))
3251 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
3252 (setq dir (cdr (cdr dir)))
3253 (while dir
3254 (setq f (car dir)
3255 dir (cdr dir))
3256 (if (and (string-match re f)
3257 (not (ido-ignore-item-p f ido-ignore-directories)))
3258 (setq res (cons (cons f d) res)))))
3259 (if (and auto (input-pending-p))
3260 (setq dirs nil
3261 res t))))))
3262 (if wide
3263 (setq res (ido-wide-find-dirs-or-files
3264 ido-current-directory text ido-enable-prefix nil))
3265 (let ((ido-text text)
3266 (dirs ido-work-directory-list)
3267 (must-match (and text (> (length text) 0)))
3268 dir fl)
3269 (if (and auto (not (member ido-current-directory dirs)))
3270 (setq dirs (cons ido-current-directory dirs)))
3271 (while dirs
3272 (setq dir (car dirs)
3273 dirs (cdr dirs))
3274 (when (and dir (stringp dir)
3275 (or ido-merge-ftp-work-directories
3276 (not (ido-is-ftp-directory dir)))
3277 (file-directory-p dir)
3278 ;; TODO. check for nonreadable and too-big.
3279 (setq fl (if (eq ido-cur-item 'file)
3280 (ido-make-file-list-1 dir t)
3281 (ido-make-dir-list-1 dir t))))
3282 (if must-match
3283 (setq fl (ido-set-matches-1 fl)))
3284 (if fl
3285 (setq res (nconc fl res))))
3286 (if (and auto (input-pending-p))
3287 (setq dirs nil
3288 res t))))))
3289 res))
3290
3291 (defun ido-make-merged-file-list (text auto wide)
3292 (let (res)
3293 (message "Searching for `%s'...." text)
3294 (condition-case nil
3295 (if (eq t (setq res
3296 (while-no-input
3297 (ido-make-merged-file-list-1 text auto wide))))
3298 (setq res 'input-pending-p))
3299 (quit
3300 (setq res t
3301 ido-try-merged-list nil
3302 ido-use-merged-list nil)))
3303 (when (and res (listp res))
3304 (setq res (ido-sort-merged-list res auto)))
3305 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
3306 (listp res)
3307 (> (length text) 0))
3308 (let ((elt (assoc text res)))
3309 (when (and elt (not (eq elt (car res))))
3310 (setq res (delq elt res))
3311 (setq res (cons elt res)))))
3312 (message nil)
3313 res))
3314
3315 (defun ido-make-buffer-list-1 (&optional frame visible)
3316 ;; Return list of non-ignored buffer names
3317 (delq nil
3318 (mapcar
3319 (lambda (x)
3320 (let ((name (buffer-name x)))
3321 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
3322 name)))
3323 (buffer-list frame))))
3324
3325 (defun ido-make-buffer-list (default)
3326 ;; Return the current list of buffers.
3327 ;; Currently visible buffers are put at the end of the list.
3328 ;; The hook `ido-make-buffer-list-hook' is run after the list has been
3329 ;; created to allow the user to further modify the order of the buffer names
3330 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
3331 ;; it is put to the start of the list.
3332 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
3333 (ido-temp-list (ido-make-buffer-list-1 (selected-frame) ido-current-buffers)))
3334 (if ido-temp-list
3335 (nconc ido-temp-list ido-current-buffers)
3336 (setq ido-temp-list ido-current-buffers))
3337 (if default
3338 (progn
3339 (setq ido-temp-list
3340 (delete default ido-temp-list))
3341 (setq ido-temp-list
3342 (cons default ido-temp-list))))
3343 (run-hooks 'ido-make-buffer-list-hook)
3344 ido-temp-list))
3345
3346 (defun ido-make-choice-list (default)
3347 ;; Return the current list of choices.
3348 ;; If DEFAULT is non-nil, and corresponds to an element of choices,
3349 ;; it is put to the start of the list.
3350 (let ((ido-temp-list ido-choice-list))
3351 (if default
3352 (progn
3353 (setq ido-temp-list
3354 (delete default ido-temp-list))
3355 (setq ido-temp-list
3356 (cons default ido-temp-list))))
3357 ; (run-hooks 'ido-make-choice-list-hook)
3358 ido-temp-list))
3359
3360 (defun ido-to-end (items)
3361 ;; Move the elements from ITEMS to the end of `ido-temp-list'
3362 (mapc
3363 (lambda (elem)
3364 (setq ido-temp-list (delq elem ido-temp-list)))
3365 items)
3366 (if ido-temp-list
3367 (nconc ido-temp-list items)
3368 (setq ido-temp-list items)))
3369
3370 (declare-function tramp-tramp-file-p "tramp" (name))
3371
3372 (defun ido-file-name-all-completions-1 (dir)
3373 (cond
3374 ((ido-nonreadable-directory-p dir) '())
3375 ;; do not check (ido-directory-too-big-p dir) here.
3376 ;; Caller must have done that if necessary.
3377
3378 ((and ido-enable-tramp-completion
3379 (or (fboundp 'tramp-completion-mode-p)
3380 (require 'tramp nil t))
3381 (string-match "\\`/[^/]+[:@]\\'" dir))
3382 ;; Strip method:user@host: part of tramp completions.
3383 ;; Tramp completions do not include leading slash.
3384 (let* ((len (1- (length dir)))
3385 (tramp-completion-mode t)
3386 (compl
3387 (or (file-name-all-completions "" dir)
3388 ;; work around bug in ange-ftp.
3389 ;; /ftp:user@host: => nil
3390 ;; /ftp:user@host:./ => ok
3391 (and
3392 (not (string= "/ftp:" dir))
3393 (tramp-tramp-file-p dir)
3394 (fboundp 'tramp-ftp-file-name-p)
3395 (funcall 'tramp-ftp-file-name-p dir)
3396 (string-match ":\\'" dir)
3397 (file-name-all-completions "" (concat dir "./"))))))
3398 (if (and compl
3399 (> (length (car compl)) len)
3400 (string= (substring (car compl) 0 len) (substring dir 1)))
3401 (mapcar (lambda (c) (substring c len)) compl)
3402 compl)))
3403 (t
3404 (file-name-all-completions "" dir))))
3405
3406 (defun ido-file-name-all-completions (dir)
3407 ;; Return name of all files in DIR
3408 ;; Uses and updates ido-dir-file-cache
3409 (cond
3410 ((ido-is-unc-root dir)
3411 (mapcar
3412 (lambda (host)
3413 (if (string-match "/\\'" host) host (concat host "/")))
3414 (ido-unc-hosts t)))
3415 ((and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
3416 (stringp dir) (> (length dir) 0)
3417 (ido-may-cache-directory dir))
3418 (let* ((cached (assoc dir ido-dir-file-cache))
3419 (ctime (nth 1 cached))
3420 (ftp (ido-is-ftp-directory dir))
3421 (unc (ido-is-unc-host dir))
3422 (attr (if (or ftp unc) nil (file-attributes dir)))
3423 (mtime (nth 5 attr))
3424 valid)
3425 (when cached ; should we use the cached entry ?
3426 (cond
3427 (ftp
3428 (setq valid (and (eq (car ctime) 'ftp)
3429 (ido-cache-ftp-valid (cdr ctime)))))
3430 (unc
3431 (setq valid (and (eq (car ctime) 'unc)
3432 (ido-cache-unc-valid (cdr ctime)))))
3433 (t
3434 (if attr
3435 (setq valid (and (= (car ctime) (car mtime))
3436 (= (car (cdr ctime)) (car (cdr mtime))))))))
3437 (unless valid
3438 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
3439 cached nil)))
3440 (unless cached
3441 (cond
3442 (unc
3443 (setq mtime (cons 'unc (ido-time-stamp))))
3444 ((and ftp (file-readable-p dir))
3445 (setq mtime (cons 'ftp (ido-time-stamp)))))
3446 (if mtime
3447 (setq cached (cons dir (cons mtime (ido-file-name-all-completions-1 dir)))
3448 ido-dir-file-cache (cons cached ido-dir-file-cache)))
3449 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
3450 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
3451 (and cached
3452 (cdr (cdr cached)))))
3453 (t
3454 (ido-file-name-all-completions-1 dir))))
3455
3456 (defun ido-remove-cached-dir (dir)
3457 ;; Remove dir from ido-dir-file-cache
3458 (if (and ido-dir-file-cache
3459 (stringp dir) (> (length dir) 0))
3460 (let ((cached (assoc dir ido-dir-file-cache)))
3461 (if cached
3462 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
3463
3464
3465 (defun ido-make-file-list-1 (dir &optional merged)
3466 ;; Return list of non-ignored files in DIR
3467 ;; If MERGED is non-nil, each file is cons'ed with DIR
3468 (and (or (ido-is-tramp-root dir) (ido-is-unc-root dir)
3469 (file-directory-p dir))
3470 (delq nil
3471 (mapcar
3472 (lambda (name)
3473 (if (not (ido-ignore-item-p name ido-ignore-files t))
3474 (if merged (cons name dir) name)))
3475 (ido-file-name-all-completions dir)))))
3476
3477 (defun ido-make-file-list (default)
3478 ;; Return the current list of files.
3479 ;; Currently visible files are put at the end of the list.
3480 ;; The hook `ido-make-file-list-hook' is run after the list has been
3481 ;; created to allow the user to further modify the order of the file names
3482 ;; in this list.
3483 (let ((ido-temp-list (ido-make-file-list-1 ido-current-directory)))
3484 (setq ido-temp-list (sort ido-temp-list
3485 (if ido-file-extensions-order
3486 #'ido-file-extension-lessp
3487 #'ido-file-lessp)))
3488 (unless (ido-is-tramp-root ido-current-directory)
3489 (let ((default-directory ido-current-directory))
3490 (ido-to-end ;; move ftp hosts and visited files to end
3491 (delq nil (mapcar
3492 (lambda (x) (if (or (and (string-match ".:\\'" x)
3493 (not (ido-local-file-exists-p x)))
3494 (and (not (ido-final-slash x))
3495 (let (file-name-handler-alist)
3496 (get-file-buffer x)))) x))
3497 ido-temp-list)))))
3498 (ido-to-end ;; move . files to end
3499 (delq nil (mapcar
3500 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3501 ido-temp-list)))
3502 (if (and default (member default ido-temp-list))
3503 (if (or ido-rotate-temp ido-rotate-file-list-default)
3504 (unless (equal default (car ido-temp-list))
3505 (let ((l ido-temp-list) k)
3506 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3507 (setq l (cdr l)))
3508 (setq k (cdr l))
3509 (setcdr l nil)
3510 (nconc k ido-temp-list)
3511 (setq ido-temp-list k)))
3512 (setq ido-temp-list
3513 (delete default ido-temp-list))
3514 (setq ido-temp-list
3515 (cons default ido-temp-list))))
3516 (when ido-show-dot-for-dired
3517 (setq ido-temp-list (delete "." ido-temp-list))
3518 (setq ido-temp-list (cons "." ido-temp-list)))
3519 (run-hooks 'ido-make-file-list-hook)
3520 ido-temp-list))
3521
3522 (defun ido-make-dir-list-1 (dir &optional merged)
3523 ;; Return list of non-ignored subdirs in DIR
3524 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
3525 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
3526 (delq nil
3527 (mapcar
3528 (lambda (name)
3529 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
3530 (if merged (cons name dir) name)))
3531 (ido-file-name-all-completions dir)))))
3532
3533 (defun ido-make-dir-list (default)
3534 ;; Return the current list of directories.
3535 ;; The hook `ido-make-dir-list-hook' is run after the list has been
3536 ;; created to allow the user to further modify the order of the
3537 ;; directory names in this list.
3538 (let ((ido-temp-list (ido-make-dir-list-1 ido-current-directory)))
3539 (setq ido-temp-list (sort ido-temp-list #'ido-file-lessp))
3540 (ido-to-end ;; move . files to end
3541 (delq nil (mapcar
3542 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
3543 ido-temp-list)))
3544 (if (and default (member default ido-temp-list))
3545 (if (or ido-rotate-temp ido-rotate-file-list-default)
3546 (unless (equal default (car ido-temp-list))
3547 (let ((l ido-temp-list) k)
3548 (while (and l (cdr l) (not (equal default (car (cdr l)))))
3549 (setq l (cdr l)))
3550 (setq k (cdr l))
3551 (setcdr l nil)
3552 (nconc k ido-temp-list)
3553 (setq ido-temp-list k)))
3554 (setq ido-temp-list
3555 (delete default ido-temp-list))
3556 (setq ido-temp-list
3557 (cons default ido-temp-list))))
3558 (setq ido-temp-list (delete "." ido-temp-list))
3559 (unless ido-input-stack
3560 (setq ido-temp-list (cons "." ido-temp-list)))
3561 (run-hooks 'ido-make-dir-list-hook)
3562 ido-temp-list))
3563
3564 ;; List of the files visible in the current frame.
3565 (defvar ido-bufs-in-frame)
3566
3567 (defun ido-get-buffers-in-frames (&optional current)
3568 ;; Return the list of buffers that are visible in the current frame.
3569 ;; If optional argument `current' is given, restrict searching to the
3570 ;; current frame, rather than all frames, regardless of value of
3571 ;; `ido-all-frames'.
3572 (let ((ido-bufs-in-frame nil))
3573 (walk-windows 'ido-get-bufname nil
3574 (if current
3575 nil
3576 ido-all-frames))
3577 ido-bufs-in-frame))
3578
3579 (defun ido-get-bufname (win)
3580 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
3581 (let ((buf (buffer-name (window-buffer win))))
3582 (unless (or (member buf ido-bufs-in-frame)
3583 (member buf ido-ignore-item-temp-list))
3584 ;; Only add buf if it is not already in list.
3585 ;; This prevents same buf in two different windows being
3586 ;; put into the list twice.
3587 (setq ido-bufs-in-frame
3588 (cons buf ido-bufs-in-frame)))))
3589
3590 ;;; FIND MATCHING ITEMS
3591
3592 (defun ido-set-matches-1 (items &optional do-full)
3593 ;; Return list of matches in items
3594 (let* ((case-fold-search ido-case-fold)
3595 (slash (and (not ido-enable-prefix) (ido-final-slash ido-text)))
3596 (text (if slash (substring ido-text 0 -1) ido-text))
3597 (rex0 (if ido-enable-regexp text (regexp-quote text)))
3598 (rexq (concat rex0 (if slash ".*/" "")))
3599 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
3600 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" rex0))
3601 (concat "\\`" rex0 (if slash "/" "") "\\'")))
3602 (suffix-re (and do-full slash
3603 (not ido-enable-regexp) (not (string-match "\$\\'" rex0))
3604 (concat rex0 "/\\'")))
3605 (prefix-re (and full-re (not ido-enable-prefix)
3606 (concat "\\`" rexq)))
3607 (non-prefix-dot (or (not ido-enable-dot-prefix)
3608 (not ido-process-ignore-lists)
3609 ido-enable-prefix
3610 (= (length ido-text) 0)))
3611 full-matches suffix-matches prefix-matches matches)
3612 (setq ido-incomplete-regexp nil)
3613 (condition-case error
3614 (mapc
3615 (lambda (item)
3616 (let ((name (ido-name item)))
3617 (if (and (or non-prefix-dot
3618 (if (= (aref ido-text 0) ?.)
3619 (= (aref name 0) ?.)
3620 (/= (aref name 0) ?.)))
3621 (string-match re name))
3622 (cond
3623 ((and (eq ido-cur-item 'buffer)
3624 (or (not (stringp ido-default-item))
3625 (not (string= name ido-default-item)))
3626 (string= name (buffer-name ido-entry-buffer)))
3627 (setq matches (cons item matches)))
3628 ((and full-re (string-match full-re name))
3629 (setq full-matches (cons item full-matches)))
3630 ((and suffix-re (string-match suffix-re name))
3631 (setq suffix-matches (cons item suffix-matches)))
3632 ((and prefix-re (string-match prefix-re name))
3633 (setq prefix-matches (cons item prefix-matches)))
3634 (t (setq matches (cons item matches))))))
3635 t)
3636 items)
3637 (invalid-regexp
3638 (setq ido-incomplete-regexp t
3639 ;; Consider the invalid regexp message internally as a
3640 ;; special-case single match, and handle appropriately
3641 ;; elsewhere.
3642 matches (cdr error))))
3643 (when prefix-matches
3644 (ido-trace "prefix match" prefix-matches)
3645 (setq matches (nconc prefix-matches matches)))
3646 (when suffix-matches
3647 (ido-trace "suffix match" (list text suffix-re suffix-matches))
3648 (setq matches (nconc suffix-matches matches)))
3649 (when full-matches
3650 (ido-trace "full match" (list text full-re full-matches))
3651 (setq matches (nconc full-matches matches)))
3652 (when (and (null matches)
3653 ido-enable-flex-matching
3654 (> (length ido-text) 1)
3655 (not ido-enable-regexp))
3656 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
3657 (if ido-enable-prefix
3658 (setq re (concat "\\`" re)))
3659 (mapc
3660 (lambda (item)
3661 (let ((name (ido-name item)))
3662 (if (string-match re name)
3663 (setq matches (cons item matches)))))
3664 items))
3665 matches))
3666
3667
3668 (defun ido-set-matches ()
3669 ;; Set `ido-matches' to the list of items matching prompt
3670 (when ido-rescan
3671 (setq ido-matches (ido-set-matches-1 (reverse ido-cur-list) (not ido-rotate))
3672 ido-rotate nil)))
3673
3674 (defun ido-ignore-item-p (name re-list &optional ignore-ext)
3675 ;; Return t if the buffer or file NAME should be ignored.
3676 (or (member name ido-ignore-item-temp-list)
3677 (and
3678 ido-process-ignore-lists re-list
3679 (save-match-data
3680 (let ((ext-list (and ignore-ext ido-ignore-extensions
3681 completion-ignored-extensions))
3682 (case-fold-search ido-case-fold)
3683 ignorep nextstr
3684 (flen (length name)) slen)
3685 (while ext-list
3686 (setq nextstr (car ext-list))
3687 (if (cond
3688 ((stringp nextstr)
3689 (and (>= flen (setq slen (length nextstr)))
3690 (string-equal (substring name (- flen slen)) nextstr)))
3691 ((functionp nextstr) (funcall nextstr name))
3692 (t nil))
3693 (setq ignorep t
3694 ext-list nil
3695 re-list nil)
3696 (setq ext-list (cdr ext-list))))
3697 (while re-list
3698 (setq nextstr (car re-list))
3699 (if (cond
3700 ((stringp nextstr) (string-match nextstr name))
3701 ((functionp nextstr) (funcall nextstr name))
3702 (t nil))
3703 (setq ignorep t
3704 re-list nil)
3705 (setq re-list (cdr re-list))))
3706 ;; return the result
3707 (if ignorep
3708 (setq ido-ignored-list (cons name ido-ignored-list)))
3709 ignorep)))))
3710
3711 ;; Private variable used by `ido-word-matching-substring'.
3712 (defvar ido-change-word-sub)
3713
3714 (defun ido-find-common-substring (items subs)
3715 ;; Return common string following SUBS in each element of ITEMS.
3716 (let (res
3717 alist
3718 ido-change-word-sub)
3719 (setq ido-change-word-sub
3720 (if ido-enable-regexp
3721 subs
3722 (regexp-quote subs)))
3723 (setq res (mapcar #'ido-word-matching-substring items))
3724 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
3725 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
3726
3727 ;; try-completion returns t if there is an exact match.
3728 (let* ((completion-ignore-case ido-case-fold)
3729 (comp (try-completion subs alist)))
3730 (if (eq comp t)
3731 subs
3732 comp))))
3733
3734 (defun ido-word-matching-substring (word)
3735 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
3736 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
3737 (let ((case-fold-search ido-case-fold))
3738 (let ((m (string-match ido-change-word-sub (ido-name word))))
3739 (if m
3740 (substring (ido-name word) m)
3741 ;; else no match
3742 nil))))
3743
3744 (defun ido-makealist (res)
3745 ;; Return dotted pair (RES . 1).
3746 (cons res 1))
3747
3748 (defun ido-choose-completion-string (choice buffer mini-p base-size)
3749 (when (ido-active)
3750 ;; Insert the completion into the buffer where completion was requested.
3751 (if (get-buffer ido-completion-buffer)
3752 (kill-buffer ido-completion-buffer))
3753 (cond
3754 ((ido-active t) ;; ido-use-merged-list
3755 (setq ido-current-directory ""
3756 ido-text choice
3757 ido-exit 'done))
3758 ((not (ido-final-slash choice))
3759 (setq ido-text choice
3760 ido-exit 'done))
3761 (t
3762 (ido-set-current-directory ido-current-directory choice)
3763 (setq ido-exit 'refresh)))
3764 (exit-minibuffer)
3765 t))
3766
3767 (defun ido-completion-help ()
3768 "Show possible completions in a *File Completions* buffer."
3769 (interactive)
3770 (setq ido-rescan nil)
3771 (let ((temp-buf (get-buffer ido-completion-buffer))
3772 display-it full-list)
3773 (if (and (eq last-command this-command) temp-buf)
3774 ;; scroll buffer
3775 (let (win (buf (current-buffer)))
3776 (display-buffer temp-buf nil nil)
3777 (set-buffer temp-buf)
3778 (setq win (get-buffer-window temp-buf))
3779 (if (pos-visible-in-window-p (point-max) win)
3780 (if (or ido-completion-buffer-all-completions
3781 (boundp 'ido-completion-buffer-full))
3782 (set-window-start win (point-min))
3783 (with-no-warnings
3784 (set (make-local-variable 'ido-completion-buffer-full) t))
3785 (setq full-list t
3786 display-it t))
3787 (scroll-other-window))
3788 (set-buffer buf))
3789 (setq display-it t))
3790 (if display-it
3791 (with-output-to-temp-buffer ido-completion-buffer
3792 (let ((completion-list (sort
3793 (cond
3794 (ido-directory-too-big
3795 (message "Reading directory...")
3796 (setq ido-directory-too-big nil
3797 ido-ignored-list nil
3798 ido-cur-list (ido-all-completions)
3799 ido-rescan t)
3800 (ido-set-matches)
3801 (or ido-matches ido-cur-list))
3802 (ido-use-merged-list
3803 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
3804 ((or full-list ido-completion-buffer-all-completions)
3805 (ido-all-completions))
3806 (t
3807 (copy-sequence (or ido-matches ido-cur-list))))
3808 #'ido-file-lessp)))
3809 (if (featurep 'xemacs)
3810 ;; XEmacs extents are put on by default, doesn't seem to be
3811 ;; any way of switching them off.
3812 ;; This obscure code avoids a byte compiler warning in Emacs.
3813 (let ((f 'display-completion-list))
3814 (funcall f completion-list
3815 :help-string "ido "
3816 :activate-callback
3817 '(lambda (x y z) (message "Doesn't work yet, sorry!"))))
3818 ;; else running Emacs
3819 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
3820 (display-completion-list completion-list)))))))
3821
3822 ;;; KILL CURRENT BUFFER
3823 (defun ido-kill-buffer-at-head ()
3824 "Kill the buffer at the head of `ido-matches'.
3825 If cursor is not at the end of the user input, delete to end of input."
3826 (interactive)
3827 (if (not (eobp))
3828 (delete-region (point) (line-end-position))
3829 (let ((enable-recursive-minibuffers t)
3830 (buf (ido-name (car ido-matches))))
3831 (when buf
3832 (kill-buffer buf)
3833 ;; Check if buffer still exists.
3834 (if (get-buffer buf)
3835 ;; buffer couldn't be killed.
3836 (setq ido-rescan t)
3837 ;; else buffer was killed so remove name from list.
3838 (setq ido-cur-list (delq buf ido-cur-list)))))))
3839
3840 ;;; DELETE CURRENT FILE
3841 (defun ido-delete-file-at-head ()
3842 "Delete the file at the head of `ido-matches'.
3843 If cursor is not at the end of the user input, delete to end of input."
3844 (interactive)
3845 (if (not (eobp))
3846 (delete-region (point) (line-end-position))
3847 (let ((enable-recursive-minibuffers t)
3848 (file (ido-name (car ido-matches))))
3849 (if file
3850 (setq file (concat ido-current-directory file)))
3851 (when (and file
3852 (file-exists-p file)
3853 (not (file-directory-p file))
3854 (file-writable-p ido-current-directory)
3855 (yes-or-no-p (concat "Delete " file "? ")))
3856 (delete-file file)
3857 ;; Check if file still exists.
3858 (if (file-exists-p file)
3859 ;; file could not be deleted
3860 (setq ido-rescan t)
3861 ;; else file was killed so remove name from list.
3862 (setq ido-cur-list (delq (car ido-matches) ido-cur-list)))))))
3863
3864
3865 ;;; VISIT CHOSEN BUFFER
3866 (defun ido-visit-buffer (buffer method &optional record)
3867 "Switch to BUFFER according to METHOD.
3868 Record command in `command-history' if optional RECORD is non-nil."
3869 (if (bufferp buffer)
3870 (setq buffer (buffer-name buffer)))
3871 (let (win newframe)
3872 (cond
3873 ((eq method 'kill)
3874 (if record
3875 (ido-record-command 'kill-buffer buffer))
3876 (kill-buffer buffer))
3877
3878 ((eq method 'other-window)
3879 (if record
3880 (ido-record-command 'switch-to-buffer buffer))
3881 (switch-to-buffer-other-window buffer))
3882
3883 ((eq method 'display)
3884 (display-buffer buffer))
3885
3886 ((eq method 'other-frame)
3887 (switch-to-buffer-other-frame buffer)
3888 (select-frame-set-input-focus (selected-frame)))
3889
3890 ((and (memq method '(raise-frame maybe-frame))
3891 window-system
3892 (setq win (ido-buffer-window-other-frame buffer))
3893 (or (eq method 'raise-frame)
3894 (y-or-n-p "Jump to frame? ")))
3895 (setq newframe (window-frame win))
3896 (select-frame-set-input-focus newframe)
3897 (select-window win))
3898
3899 ;; (eq method 'selected-window)
3900 (t
3901 ;; No buffer in other frames...
3902 (if record
3903 (ido-record-command 'switch-to-buffer buffer))
3904 (switch-to-buffer buffer)
3905 ))))
3906
3907
3908 (defun ido-buffer-window-other-frame (buffer)
3909 ;; Return window pointer if BUFFER is visible in another frame.
3910 ;; If BUFFER is visible in the current frame, return nil.
3911 (let ((blist (ido-get-buffers-in-frames 'current)))
3912 ;;If the buffer is visible in current frame, return nil
3913 (if (member buffer blist)
3914 nil
3915 ;; maybe in other frame or icon
3916 (get-buffer-window buffer 0) ; better than 'visible
3917 )))
3918
3919
3920 ;;; ----------- IDONIZED FUNCTIONS ------------
3921
3922 ;;;###autoload
3923 (defun ido-switch-buffer ()
3924 "Switch to another buffer.
3925 The buffer is displayed according to `ido-default-buffer-method' -- the
3926 default is to show it in the same window, unless it is already visible
3927 in another frame.
3928
3929 As you type in a string, all of the buffers matching the string are
3930 displayed if substring-matching is used \(default). Look at
3931 `ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
3932 buffer you want, it can then be selected. As you type, most keys have
3933 their normal keybindings, except for the following: \\<ido-buffer-completion-map>
3934
3935 RET Select the buffer at the front of the list of matches. If the
3936 list is empty, possibly prompt to create new buffer.
3937
3938 \\[ido-select-text] Select the current prompt as the buffer.
3939 If no buffer is found, prompt for a new one.
3940
3941 \\[ido-next-match] Put the first element at the end of the list.
3942 \\[ido-prev-match] Put the last element at the start of the list.
3943 \\[ido-complete] Complete a common suffix to the current string that
3944 matches all buffers. If there is only one match, select that buffer.
3945 If there is no common suffix, show a list of all matching buffers
3946 in a separate window.
3947 \\[ido-edit-input] Edit input string.
3948 \\[ido-fallback-command] Fallback to non-ido version of current command.
3949 \\[ido-toggle-regexp] Toggle regexp searching.
3950 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
3951 \\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
3952 \\[ido-completion-help] Show list of matching buffers in separate window.
3953 \\[ido-enter-find-file] Drop into `ido-find-file'.
3954 \\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
3955 \\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
3956 (interactive)
3957 (ido-buffer-internal ido-default-buffer-method))
3958
3959 ;;;###autoload
3960 (defun ido-switch-buffer-other-window ()
3961 "Switch to another buffer and show it in another window.
3962 The buffer name is selected interactively by typing a substring.
3963 For details of keybindings, see `ido-switch-buffer'."
3964 (interactive)
3965 (ido-buffer-internal 'other-window 'switch-to-buffer-other-window))
3966
3967 ;;;###autoload
3968 (defun ido-display-buffer ()
3969 "Display a buffer in another window but don't select it.
3970 The buffer name is selected interactively by typing a substring.
3971 For details of keybindings, see `ido-switch-buffer'."
3972 (interactive)
3973 (ido-buffer-internal 'display 'display-buffer nil nil nil 'ignore))
3974
3975 ;;;###autoload
3976 (defun ido-kill-buffer ()
3977 "Kill a buffer.
3978 The buffer name is selected interactively by typing a substring.
3979 For details of keybindings, see `ido-switch-buffer'."
3980 (interactive)
3981 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer)) nil 'ignore))
3982
3983 ;;;###autoload
3984 (defun ido-insert-buffer ()
3985 "Insert contents of a buffer in current buffer after point.
3986 The buffer name is selected interactively by typing a substring.
3987 For details of keybindings, see `ido-switch-buffer'."
3988 (interactive)
3989 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: " nil nil 'ido-enter-insert-file))
3990
3991 ;;;###autoload
3992 (defun ido-switch-buffer-other-frame ()
3993 "Switch to another buffer and show it in another frame.
3994 The buffer name is selected interactively by typing a substring.
3995 For details of keybindings, see `ido-switch-buffer'."
3996 (interactive)
3997 (if ido-mode
3998 (ido-buffer-internal 'other-frame)
3999 (call-interactively 'switch-to-buffer-other-frame)))
4000
4001 ;;;###autoload
4002 (defun ido-find-file-in-dir (dir)
4003 "Switch to another file starting from DIR."
4004 (interactive "DDir: ")
4005 (setq dir (file-name-as-directory dir))
4006 (ido-file-internal ido-default-file-method nil dir nil nil nil 'ignore))
4007
4008 ;;;###autoload
4009 (defun ido-find-file ()
4010 "Edit file with name obtained via minibuffer.
4011 The file is displayed according to `ido-default-file-method' -- the
4012 default is to show it in the same window, unless it is already
4013 visible in another frame.
4014
4015 The file name is selected interactively by typing a substring. As you
4016 type in a string, all of the filenames matching the string are displayed
4017 if substring-matching is used \(default). Look at `ido-enable-prefix' and
4018 `ido-toggle-prefix'. When you have found the filename you want, it can
4019 then be selected. As you type, most keys have their normal keybindings,
4020 except for the following: \\<ido-file-completion-map>
4021
4022 RET Select the file at the front of the list of matches. If the
4023 list is empty, possibly prompt to create new file.
4024
4025 \\[ido-select-text] Select the current prompt as the buffer or file.
4026 If no buffer or file is found, prompt for a new one.
4027
4028 \\[ido-next-match] Put the first element at the end of the list.
4029 \\[ido-prev-match] Put the last element at the start of the list.
4030 \\[ido-complete] Complete a common suffix to the current string that
4031 matches all files. If there is only one match, select that file.
4032 If there is no common suffix, show a list of all matching files
4033 in a separate window.
4034 \\[ido-edit-input] Edit input string (including directory).
4035 \\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
4036 \\[ido-merge-work-directories] search for file in the work directory history.
4037 \\[ido-forget-work-directory] removes current directory from the work directory history.
4038 \\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
4039 \\[ido-wide-find-file-or-pop-dir] and \\[ido-wide-find-dir-or-delete-dir] prompts and uses find to locate files or directories.
4040 \\[ido-make-directory] prompts for a directory to create in current directory.
4041 \\[ido-fallback-command] Fallback to non-ido version of current command.
4042 \\[ido-toggle-regexp] Toggle regexp searching.
4043 \\[ido-toggle-prefix] Toggle between substring and prefix matching.
4044 \\[ido-toggle-case] Toggle case-sensitive searching of file names.
4045 \\[ido-toggle-vc] Toggle version control for this file.
4046 \\[ido-toggle-literal] Toggle literal reading of this file.
4047 \\[ido-completion-help] Show list of matching files in separate window.
4048 \\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
4049
4050 (interactive)
4051 (ido-file-internal ido-default-file-method))
4052
4053 ;;;###autoload
4054 (defun ido-find-file-other-window ()
4055 "Switch to another file and show it in another window.
4056 The file name is selected interactively by typing a substring.
4057 For details of keybindings, see `ido-find-file'."
4058 (interactive)
4059 (ido-file-internal 'other-window 'find-file-other-window))
4060
4061 ;;;###autoload
4062 (defun ido-find-alternate-file ()
4063 "Switch to another file and show it in another window.
4064 The file name is selected interactively by typing a substring.
4065 For details of keybindings, see `ido-find-file'."
4066 (interactive)
4067 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
4068
4069 ;;;###autoload
4070 (defun ido-find-file-read-only ()
4071 "Edit file read-only with name obtained via minibuffer.
4072 The file name is selected interactively by typing a substring.
4073 For details of keybindings, see `ido-find-file'."
4074 (interactive)
4075 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
4076
4077 ;;;###autoload
4078 (defun ido-find-file-read-only-other-window ()
4079 "Edit file read-only in other window with name obtained via minibuffer.
4080 The file name is selected interactively by typing a substring.
4081 For details of keybindings, see `ido-find-file'."
4082 (interactive)
4083 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
4084
4085 ;;;###autoload
4086 (defun ido-find-file-read-only-other-frame ()
4087 "Edit file read-only in other frame with name obtained via minibuffer.
4088 The file name is selected interactively by typing a substring.
4089 For details of keybindings, see `ido-find-file'."
4090 (interactive)
4091 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
4092
4093 ;;;###autoload
4094 (defun ido-display-file ()
4095 "Display a file in another window but don't select it.
4096 The file name is selected interactively by typing a substring.
4097 For details of keybindings, see `ido-find-file'."
4098 (interactive)
4099 (ido-file-internal 'display nil nil nil nil nil 'ignore))
4100
4101 ;;;###autoload
4102 (defun ido-find-file-other-frame ()
4103 "Switch to another file and show it in another frame.
4104 The file name is selected interactively by typing a substring.
4105 For details of keybindings, see `ido-find-file'."
4106 (interactive)
4107 (ido-file-internal 'other-frame 'find-file-other-frame))
4108
4109 ;;;###autoload
4110 (defun ido-write-file ()
4111 "Write current buffer to a file.
4112 The file name is selected interactively by typing a substring.
4113 For details of keybindings, see `ido-find-file'."
4114 (interactive)
4115 (let ((ido-process-ignore-lists t)
4116 (ido-work-directory-match-only nil)
4117 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
4118 (ido-report-no-match nil)
4119 (ido-confirm-unique-completion t)
4120 (ido-auto-merge-work-directories-length -1))
4121 (ido-file-internal 'write 'write-file nil "Write file: " nil nil 'ignore)))
4122
4123 ;;;###autoload
4124 (defun ido-insert-file ()
4125 "Insert contents of file in current buffer.
4126 The file name is selected interactively by typing a substring.
4127 For details of keybindings, see `ido-find-file'."
4128 (interactive)
4129 (ido-file-internal 'insert 'insert-file nil "Insert file: " nil nil 'ido-enter-insert-buffer))
4130
4131 ;;;###autoload
4132 (defun ido-dired ()
4133 "Call `dired' the ido way.
4134 The directory is selected interactively by typing a substring.
4135 For details of keybindings, see `ido-find-file'."
4136 (interactive)
4137 (let ((ido-report-no-match nil)
4138 (ido-auto-merge-work-directories-length -1))
4139 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
4140
4141 (defun ido-list-directory ()
4142 "Call `list-directory' the ido way.
4143 The directory is selected interactively by typing a substring.
4144 For details of keybindings, see `ido-find-file'."
4145 (interactive)
4146 (let ((ido-report-no-match nil)
4147 (ido-auto-merge-work-directories-length -1))
4148 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
4149
4150 ;;; XEmacs hack for showing default buffer
4151
4152 ;; The first time we enter the minibuffer, Emacs puts up the default
4153 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
4154 ;; subtle difference in the two versions of post-command-hook. The
4155 ;; default is shown for both whenever we delete all of our text
4156 ;; though, indicating its just a problem the first time we enter the
4157 ;; function. To solve this, we use another entry hook for emacs to
4158 ;; show the default the first time we enter the minibuffer.
4159
4160
4161 ;;; ICOMPLETE TYPE CODE
4162
4163 (defun ido-initiate-auto-merge (buffer)
4164 (ido-trace "\n*merge timeout*" buffer)
4165 (setq ido-auto-merge-timer nil)
4166 (when (and (buffer-live-p buffer)
4167 (ido-active)
4168 (boundp 'ido-eoinput) ido-eoinput)
4169 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
4170 (ido-trace "request merge")
4171 (setq ido-use-merged-list 'auto
4172 ido-text-init contents
4173 ido-rotate-temp t
4174 ido-exit 'refresh)
4175 (save-excursion
4176 (set-buffer buffer)
4177 (ido-tidy))
4178 (throw 'ido contents))))
4179
4180 (defun ido-exhibit ()
4181 "Post command hook for `ido'."
4182 ;; Find matching files and display a list in the minibuffer.
4183 ;; Copied from `icomplete-exhibit' with two changes:
4184 ;; 1. It prints a default file name when there is no text yet entered.
4185 ;; 2. It calls my completion routine rather than the standard completion.
4186
4187 (when (ido-active)
4188 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
4189 (buffer-undo-list t)
4190 try-single-dir-match
4191 refresh)
4192
4193 (when ido-trace-enable
4194 (ido-trace "\nexhibit" this-command)
4195 (ido-trace "dir" ido-current-directory)
4196 (ido-trace "contents" contents)
4197 (ido-trace "list" ido-cur-list)
4198 (ido-trace "matches" ido-matches)
4199 (ido-trace "rescan" ido-rescan))
4200
4201 (save-excursion
4202 (goto-char (point-max))
4203 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
4204 (unless (boundp 'ido-eoinput)
4205 ;; In case it got wiped out by major mode business:
4206 (make-local-variable 'ido-eoinput))
4207 (setq ido-eoinput (point))
4208
4209 ;; Handle explicit directory changes
4210 (cond
4211 ((memq ido-cur-item '(buffer list))
4212 )
4213
4214 ((= (length contents) 0)
4215 )
4216
4217 ((= (length contents) 1)
4218 (cond
4219 ((and (ido-is-tramp-root) (string-equal contents "/"))
4220 (ido-set-current-directory ido-current-directory contents)
4221 (setq refresh t))
4222 ((and (ido-unc-hosts) (string-equal contents "/")
4223 (let ((ido-enable-tramp-completion nil))
4224 (ido-is-root-directory)))
4225 (ido-set-current-directory "//")
4226 (setq refresh t))
4227 ))
4228
4229 ((and (string-match (if ido-enable-tramp-completion ".[:@]\\'" ".:\\'") contents)
4230 (ido-is-root-directory) ;; Ange-ftp or tramp
4231 (not (ido-local-file-exists-p contents)))
4232 (ido-set-current-directory ido-current-directory contents)
4233 (when (ido-is-slow-ftp-host)
4234 (setq ido-exit 'fallback)
4235 (exit-minibuffer))
4236 (setq refresh t))
4237
4238 ((ido-final-slash contents) ;; xxx/
4239 (ido-trace "final slash" contents)
4240 (cond
4241 ((string-equal contents "~/")
4242 (ido-set-current-home)
4243 (setq refresh t))
4244 ((string-equal contents "../")
4245 (ido-up-directory t)
4246 (setq refresh t))
4247 ((string-equal contents "./")
4248 (setq refresh t))
4249 ((string-match "\\`~[-_a-zA-Z0-9]+[$]?/\\'" contents)
4250 (ido-trace "new home" contents)
4251 (ido-set-current-home contents)
4252 (setq refresh t))
4253 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
4254 (let ((exp (condition-case ()
4255 (expand-file-name
4256 (substitute-in-file-name (substring contents 0 -1))
4257 ido-current-directory)
4258 (error nil))))
4259 (ido-trace contents exp)
4260 (when (and exp (file-directory-p exp))
4261 (ido-set-current-directory (file-name-directory exp))
4262 (setq ido-text-init (file-name-nondirectory exp))
4263 (setq refresh t))))
4264 ((and (memq system-type '(windows-nt ms-dos))
4265 (string-equal (substring contents 1) ":/"))
4266 (ido-set-current-directory (file-name-directory contents))
4267 (setq refresh t))
4268 ((string-equal (substring contents -2 -1) "/")
4269 (ido-set-current-directory
4270 (if (memq system-type '(windows-nt ms-dos))
4271 (expand-file-name "/" ido-current-directory)
4272 "/"))
4273 (setq refresh t))
4274 ((and (or ido-directory-nonreadable ido-directory-too-big)
4275 (file-directory-p (concat ido-current-directory (file-name-directory contents))))
4276 (ido-set-current-directory
4277 (concat ido-current-directory (file-name-directory contents)))
4278 (setq refresh t))
4279 (t
4280 (ido-trace "try single dir")
4281 (setq try-single-dir-match t))))
4282
4283 ((and (string-equal (substring contents -2 -1) "/")
4284 (not (string-match "[$]" contents)))
4285 (ido-set-current-directory
4286 (cond
4287 ((= (length contents) 2)
4288 "/")
4289 (ido-matches
4290 (concat ido-current-directory (ido-name (car ido-matches))))
4291 (t
4292 (concat ido-current-directory (substring contents 0 -1)))))
4293 (setq ido-text-init (substring contents -1))
4294 (setq refresh t))
4295
4296 ((and (not ido-use-merged-list)
4297 (not (ido-final-slash contents))
4298 (eq ido-try-merged-list t)
4299 (numberp ido-auto-merge-work-directories-length)
4300 (> ido-auto-merge-work-directories-length 0)
4301 (= (length contents) ido-auto-merge-work-directories-length)
4302 (not (and ido-auto-merge-inhibit-characters-regexp
4303 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4304 (not (input-pending-p)))
4305 (setq ido-use-merged-list 'auto
4306 ido-text-init contents
4307 ido-rotate-temp t)
4308 (setq refresh t))
4309
4310 (t nil))
4311
4312 (when refresh
4313 (ido-trace "refresh on /" ido-text-init)
4314 (setq ido-exit 'refresh)
4315 (exit-minibuffer))
4316
4317 ;; Update the list of matches
4318 (setq ido-text contents)
4319 (ido-set-matches)
4320 (ido-trace "new " ido-matches)
4321
4322 (when (and ido-enter-matching-directory
4323 ido-matches
4324 (or (eq ido-enter-matching-directory 'first)
4325 (null (cdr ido-matches)))
4326 (ido-final-slash (ido-name (car ido-matches)))
4327 (or try-single-dir-match
4328 (eq ido-enter-matching-directory t)))
4329 (ido-trace "single match" (car ido-matches))
4330 (ido-set-current-directory
4331 (concat ido-current-directory (ido-name (car ido-matches))))
4332 (setq ido-exit 'refresh)
4333 (exit-minibuffer))
4334
4335 (when (and (not ido-matches)
4336 (not ido-directory-nonreadable)
4337 (not ido-directory-too-big)
4338 ;; ido-rescan ?
4339 ido-process-ignore-lists
4340 ido-ignored-list)
4341 (let ((ido-process-ignore-lists nil)
4342 (ido-rotate ido-rotate)
4343 (ido-cur-list ido-ignored-list))
4344 (ido-trace "try all" ido-ignored-list)
4345 (ido-set-matches))
4346 (when ido-matches
4347 (ido-trace "found " ido-matches)
4348 (setq ido-rescan t)
4349 (setq ido-process-ignore-lists-inhibit t)
4350 (setq ido-text-init ido-text)
4351 (setq ido-exit 'refresh)
4352 (exit-minibuffer)))
4353
4354 (when (and
4355 ido-rescan
4356 (not ido-matches)
4357 (memq ido-cur-item '(file dir))
4358 (not (ido-is-root-directory))
4359 (> (length contents) 1)
4360 (not (string-match "[$]" contents))
4361 (not ido-directory-nonreadable)
4362 (not ido-directory-too-big))
4363 (ido-trace "merge?")
4364 (if ido-use-merged-list
4365 (ido-undo-merge-work-directory contents nil)
4366 (when (and (eq ido-try-merged-list t)
4367 (numberp ido-auto-merge-work-directories-length)
4368 (= ido-auto-merge-work-directories-length 0)
4369 (not (and ido-auto-merge-inhibit-characters-regexp
4370 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
4371 (not (input-pending-p)))
4372 (ido-trace "\n*start timer*")
4373 (setq ido-auto-merge-timer
4374 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
4375
4376 (setq ido-rescan t)
4377
4378 (if (and ido-use-merged-list
4379 ido-matches
4380 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
4381 (progn
4382 (ido-set-current-directory (car (cdr (car ido-matches))))
4383 (setq ido-use-merged-list t
4384 ido-exit 'keep
4385 ido-text-init ido-text)
4386 (exit-minibuffer)))
4387
4388 ;; Insert the match-status information:
4389 (ido-set-common-completion)
4390 (let ((inf (ido-completions
4391 contents
4392 minibuffer-completion-table
4393 minibuffer-completion-predicate
4394 (not minibuffer-completion-confirm))))
4395 (ido-trace "inf" inf)
4396 (insert inf))
4397 ))))
4398
4399 (defun ido-completions (name candidates predicate require-match)
4400 ;; Return the string that is displayed after the user's text.
4401 ;; Modified from `icomplete-completions'.
4402
4403 (let* ((comps ido-matches)
4404 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
4405 ido-merged-indicator))
4406 first)
4407
4408 (if (and ind ido-use-faces)
4409 (put-text-property 0 1 'face 'ido-indicator ind))
4410
4411 (if (and ido-use-faces comps)
4412 (let* ((fn (ido-name (car comps)))
4413 (ln (length fn)))
4414 (setq first (format "%s" fn))
4415 (put-text-property 0 ln 'face
4416 (if (= (length comps) 1)
4417 (if ido-incomplete-regexp
4418 'ido-incomplete-regexp
4419 'ido-only-match)
4420 'ido-first-match)
4421 first)
4422 (if ind (setq first (concat first ind)))
4423 (setq comps (cons first (cdr comps)))))
4424
4425 (cond ((null comps)
4426 (cond
4427 (ido-directory-nonreadable
4428 (or (nth 8 ido-decorations) " [Not readable]"))
4429 (ido-directory-too-big
4430 (or (nth 9 ido-decorations) " [Too big]"))
4431 (ido-report-no-match
4432 (nth 6 ido-decorations)) ;; [No match]
4433 (t "")))
4434 (ido-incomplete-regexp
4435 (concat " " (car comps)))
4436 ((null (cdr comps)) ;one match
4437 (concat (if (if (not ido-enable-regexp)
4438 (= (length (ido-name (car comps))) (length name))
4439 ;; We can't rely on the length of the input
4440 ;; for regexps, so explicitly check for a
4441 ;; complete match
4442 (string-match name (ido-name (car comps)))
4443 (string-equal (match-string 0 (ido-name (car comps)))
4444 (ido-name (car comps))))
4445 ""
4446 ;; when there is one match, show the matching file name in full
4447 (concat (nth 4 ido-decorations) ;; [ ... ]
4448 (ido-name (car comps))
4449 (nth 5 ido-decorations)))
4450 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
4451 (t ;multiple matches
4452 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
4453 (alternatives
4454 (apply
4455 #'concat
4456 (cdr (apply
4457 #'nconc
4458 (mapcar
4459 (lambda (com)
4460 (setq com (ido-name com))
4461 (setq items (1- items))
4462 (cond
4463 ((< items 0) ())
4464 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
4465 (t
4466 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
4467 (let ((str (substring com 0)))
4468 (if (and ido-use-faces
4469 (not (string= str first))
4470 (ido-final-slash str))
4471 (put-text-property 0 (length str) 'face 'ido-subdir str))
4472 str)))))
4473 comps))))))
4474
4475 (concat
4476 ;; put in common completion item -- what you get by pressing tab
4477 (if (and (stringp ido-common-match-string)
4478 (> (length ido-common-match-string) (length name)))
4479 (concat (nth 4 ido-decorations) ;; [ ... ]
4480 (substring ido-common-match-string (length name))
4481 (nth 5 ido-decorations)))
4482 ;; list all alternatives
4483 (nth 0 ido-decorations) ;; { ... }
4484 alternatives
4485 (nth 1 ido-decorations)))))))
4486
4487 (defun ido-minibuffer-setup ()
4488 "Minibuffer setup hook for `ido'."
4489 ;; Copied from `icomplete-minibuffer-setup-hook'.
4490 (when (ido-active)
4491 (add-hook 'pre-command-hook 'ido-tidy nil t)
4492 (add-hook 'post-command-hook 'ido-exhibit nil t)
4493 (setq cua-inhibit-cua-keys t)
4494 (when (featurep 'xemacs)
4495 (ido-exhibit)
4496 (goto-char (point-min)))
4497 (run-hooks 'ido-minibuffer-setup-hook)
4498 (when ido-initial-position
4499 (goto-char (+ (minibuffer-prompt-end) ido-initial-position))
4500 (setq ido-initial-position nil))))
4501
4502 (defun ido-tidy ()
4503 "Pre command hook for `ido'."
4504 ;; Remove completions display, if any, prior to new user input.
4505 ;; Copied from `icomplete-tidy'."
4506
4507 (when ido-auto-merge-timer
4508 (ido-trace "\n*cancel timer*" this-command)
4509 (cancel-timer ido-auto-merge-timer)
4510 (setq ido-auto-merge-timer nil))
4511
4512 (if (ido-active)
4513 (if (and (boundp 'ido-eoinput)
4514 ido-eoinput)
4515
4516 (if (> ido-eoinput (point-max))
4517 ;; Oops, got rug pulled out from under us - reinit:
4518 (setq ido-eoinput (point-max))
4519 (let ((buffer-undo-list t))
4520 (delete-region ido-eoinput (point-max))))
4521
4522 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
4523 (make-local-variable 'ido-eoinput)
4524 (setq ido-eoinput 1))))
4525
4526 (defun ido-summary-buffers-to-end ()
4527 ;; Move the summaries to the end of the buffer list.
4528 ;; This is an example function which can be hooked on to
4529 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
4530 ;; `Summary' or `output\*$'are put to the end of the list.
4531 (let ((summaries (delq nil (mapcar
4532 (lambda (x)
4533 (if (or
4534 (string-match "Summary" x)
4535 (string-match "output\\*\\'" x))
4536 x))
4537 ido-temp-list))))
4538 (ido-to-end summaries)))
4539
4540 ;;; Helper functions for other programs
4541
4542 (put 'dired-do-rename 'ido 'ignore)
4543 (put 'ibuffer-find-file 'ido 'find-file)
4544 (put 'dired-other-window 'ido 'dir)
4545
4546 ;;;###autoload
4547 (defun ido-read-buffer (prompt &optional default require-match)
4548 "Ido replacement for the built-in `read-buffer'.
4549 Return the name of a buffer selected.
4550 PROMPT is the prompt to give to the user. DEFAULT if given is the default
4551 buffer to be selected, which will go to the front of the list.
4552 If REQUIRE-MATCH is non-nil, an existing buffer must be selected."
4553 (let* ((ido-current-directory nil)
4554 (ido-directory-nonreadable nil)
4555 (ido-directory-too-big nil)
4556 (ido-context-switch-command 'ignore)
4557 (buf (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match)))
4558 (if (eq ido-exit 'fallback)
4559 (let ((read-buffer-function nil))
4560 (run-hook-with-args 'ido-before-fallback-functions 'read-buffer)
4561 (read-buffer prompt default require-match))
4562 buf)))
4563
4564 ;;;###autoload
4565 (defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
4566 "Ido replacement for the built-in `read-file-name'.
4567 Read file name, prompting with PROMPT and completing in directory DIR.
4568 See `read-file-name' for additional parameters."
4569 (let (filename)
4570 (cond
4571 ((or (eq predicate 'file-directory-p)
4572 (eq (get this-command 'ido) 'dir)
4573 (memq this-command ido-read-file-name-as-directory-commands))
4574 (setq filename
4575 (ido-read-directory-name prompt dir default-filename mustmatch initial))
4576 (if (eq ido-exit 'fallback)
4577 (setq filename 'fallback)))
4578 ((and (not (eq (get this-command 'ido) 'ignore))
4579 (not (memq this-command ido-read-file-name-non-ido))
4580 (or (null predicate) (eq predicate 'file-exists-p)))
4581 (let* (ido-saved-vc-hb
4582 (ido-context-switch-command
4583 (if (eq (get this-command 'ido) 'find-file) nil 'ignore))
4584 (vc-handled-backends (and (boundp 'vc-handled-backends) vc-handled-backends))
4585 (minibuffer-completing-file-name t)
4586 (ido-current-directory (ido-expand-directory dir))
4587 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4588 (ido-directory-too-big (and (not ido-directory-nonreadable)
4589 (ido-directory-too-big-p ido-current-directory)))
4590 (ido-work-directory-index -1)
4591 (ido-show-dot-for-dired (and ido-show-dot-for-dired
4592 (not default-filename)))
4593 (ido-work-file-index -1)
4594 (ido-find-literal nil))
4595 (setq ido-exit nil)
4596 (setq filename
4597 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
4598 (cond
4599 ((eq ido-exit 'fallback)
4600 (setq filename 'fallback))
4601 ((eq ido-exit 'dired)
4602 (setq filename ido-current-directory))
4603 (filename
4604 (setq filename
4605 (concat ido-current-directory filename))))))
4606 (t
4607 (setq filename 'fallback)))
4608 (if (eq filename 'fallback)
4609 (let ((read-file-name-function nil))
4610 (run-hook-with-args 'ido-before-fallback-functions 'read-file-name)
4611 (read-file-name prompt dir default-filename mustmatch initial predicate))
4612 filename)))
4613
4614 ;;;###autoload
4615 (defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
4616 "Ido replacement for the built-in `read-directory-name'.
4617 Read directory name, prompting with PROMPT and completing in directory DIR.
4618 See `read-directory-name' for additional parameters."
4619 (let* (filename
4620 (minibuffer-completing-file-name t)
4621 (ido-context-switch-command 'ignore)
4622 ido-saved-vc-hb
4623 (ido-current-directory (ido-expand-directory dir))
4624 (ido-directory-nonreadable (not (file-readable-p ido-current-directory)))
4625 (ido-directory-too-big (and (not ido-directory-nonreadable)
4626 (ido-directory-too-big-p ido-current-directory)))
4627 (ido-work-directory-index -1)
4628 (ido-work-file-index -1))
4629 (setq filename
4630 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
4631 (if filename
4632 (if (and (stringp filename) (string-equal filename "."))
4633 ido-current-directory
4634 (concat ido-current-directory filename)))))
4635
4636 ;;;###autoload
4637 (defun ido-completing-read (prompt choices &optional predicate require-match initial-input hist def)
4638 "Ido replacement for the built-in `completing-read'.
4639 Read a string in the minibuffer with ido-style completion.
4640 PROMPT is a string to prompt with; normally it ends in a colon and a space.
4641 CHOICES is a list of strings which are the possible completions.
4642 PREDICATE is currently ignored; it is included to be compatible
4643 with `completing-read'.
4644 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
4645 the input is (or completes to) an element of CHOICES or is null.
4646 If the input is null, `ido-completing-read' returns DEF, or an empty
4647 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
4648 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
4649 with point positioned at the end.
4650 HIST, if non-nil, specifies a history list.
4651 DEF, if non-nil, is the default value."
4652 (let ((ido-current-directory nil)
4653 (ido-directory-nonreadable nil)
4654 (ido-directory-too-big nil)
4655 (ido-context-switch-command 'ignore)
4656 (ido-choice-list choices))
4657 (ido-read-internal 'list prompt hist def require-match initial-input)))
4658
4659
4660 ;; arch-tag: b63a3500-1735-41bd-8a01-05373f0864da
4661 ;;; ido.el ends here