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