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