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