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