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