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