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