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