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