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