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