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