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