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