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