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