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