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