*** empty log message ***
[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>
71296446 29;; who wrote iswitch-buffer mode - from which I ripped off 99% of the code
789d1bf0
KS
30;; for ido-switch-buffer and found the inspiration for ido-find-file.
31;; The ido package would never have existed without his work.
32
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;;
71296446 95;; Buffer: {123456,123}
789d1bf0
KS
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
71296446 159;; to inhibit the ido substring matching for ftp access.
789d1bf0
KS
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,
71296446 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"
71296446 362 :type '(choice (const :tag "Turn on only buffer" buffer)
789d1bf0
KS
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."
71296446 449 :type '(choice (const samewindow)
789d1bf0
KS
450 (const otherwindow)
451 (const display)
71296446 452 (const otherframe)
789d1bf0
KS
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."
71296446 460 :type '(choice (const samewindow)
789d1bf0
KS
461 (const otherwindow)
462 (const display)
71296446 463 (const otherframe)
789d1bf0
KS
464 (const maybe-frame)
465 (const always-frame))
466 :group 'ido)
467
468(defcustom ido-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."
71296446 649 :type '(choice (const :tag "Never" nil)
789d1bf0
KS
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."
71296446 658 :type '(choice (const always)
789d1bf0
KS
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,
71296446 6827th element is the string displayed when there are a no matches, and
789d1bf0
KS
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
71296446 697(defface ido-only-match-face '((((class color))
789d1bf0
KS
698 (:foreground "ForestGreen"))
699 (t (:italic t)))
700 "*Font used by ido for highlighting only match."
701 :group 'ido)
702
71296446 703(defface ido-subdir-face '((((class color))
789d1bf0
KS
704 (:foreground "red"))
705 (t (:underline t)))
706 "*Font used by ido for highlighting subdirs in the alternatives."
707 :group 'ido)
708
71296446 709(defface ido-indicator-face '((((class color))
789d1bf0
KS
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
71296446 789 \(add-hook 'ido-minibuffer-setup-hook
789d1bf0
KS
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
71296446
JB
887(defvar ido-exit nil
888 "Flag to monitor how `ido-find-file' exits.
789d1bf0
KS
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
71296446 899 "Non-nil means use `ido' completion feedback.
789d1bf0
KS
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)
71296446 1011 (string-match
bad111c2
KS
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)
71296446 1022 (string-match
bad111c2
KS
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))))
71296446 1133 (setq ido-work-directory-list
789d1bf0
KS
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))))
71296446 1143 (setq ido-work-file-list
789d1bf0
KS
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))))
71296446 1151 (setq ido-dir-file-cache
789d1bf0
KS
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,
71296446 1226turning on ido-mode will modify the default keybindings for the
789d1bf0
KS
1227find-file and switch-to-buffer families of commands to the ido
1228versions of these functions.
71296446 1229However, if second arg equals 'files, bind only for files, or if it
789d1bf0
KS
1230equals 'buffers, bind only for buffers.
1231This function also adds a hook to the minibuffer."
1232 (interactive "P")
1233 (setq ido-mode
71296446 1234 (cond
789d1bf0
KS
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
71296446 1282 (> (prefix-numeric-value arg) 0)
789d1bf0 1283 (not ido-everywhere)))
71296446 1284 (setq read-file-name-function
789d1bf0
KS
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
71296446 1292;;; IDO KEYMAP
789d1bf0
KS
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
f0a73ccc 1355 (when (if (boundp 'viper-mode) viper-mode)
9f781d7e
KS
1356 (define-key map [remap viper-intercept-ESC-key] 'ignore)
1357 (when (memq ido-cur-item '(file dir))
1358 (define-key map [remap viper-backward-char] 'ido-delete-backward-updir)
1359 (define-key map [remap viper-del-backward-char-in-insert] 'ido-delete-backward-updir)
1360 (define-key map [remap viper-delete-backward-word] 'ido-delete-backward-word-updir)))
f0a73ccc 1361
789d1bf0
KS
1362 (setq ido-mode-map map)
1363 (run-hooks 'ido-define-mode-map-hook)))
1364
1365(defun ido-final-slash (dir &optional fix-it)
1366 ;; return DIR if DIR has final slash.
1367 ;; else if FIX-IT is non-nil, return DIR/
1368 ;; else return nil.
1369 (setq dir (ido-name dir))
1370 (cond
1371 ((string-match "/\\'" dir) dir)
bad111c2 1372 ((ido-is-tramp-root dir) dir)
789d1bf0
KS
1373 (fix-it (concat dir "/"))
1374 (t nil)))
1375
1376(defun ido-set-current-directory (dir &optional subdir no-merge)
1377 ;; Set ido's current directory to DIR or DIR/SUBDIR
1378 (setq dir (ido-final-slash dir t))
1379 (setq ido-use-merged-list nil
1380 ido-try-merged-list (not no-merge))
1381 (if subdir
1382 (setq dir (ido-final-slash (concat dir subdir) t)))
1383 (if (equal dir ido-current-directory)
1384 nil
1385 (ido-trace "cd" dir)
1386 (setq ido-current-directory dir)
1387 (if (get-buffer ido-completion-buffer)
1388 (kill-buffer ido-completion-buffer))
1389 t))
1390
1391(defun ido-set-current-home (&optional dir)
1392 ;; Set ido's current directory to user's home directory
1393 (ido-set-current-directory (expand-file-name (or dir "~/"))))
1394
1395(defun ido-record-command (command arg)
1396 ;; Add (command arg) to command-history if ido-record-commands is t
1397 (if ido-record-commands
1398 (let ((cmd (list command arg)))
1399 (if (or (not command-history)
1400 (not (equal cmd (car command-history))))
1401 (setq command-history (cons cmd command-history))))))
1402
1403(defun ido-make-prompt (item prompt)
1404 ;; Make the prompt for ido-read-internal
1405 (cond
1406 ((and (memq item '(file dir)) ido-current-directory)
362cdb61 1407 (let ((dirname (abbreviate-file-name ido-current-directory))
a42e9704
KS
1408 (max-width (if (and ido-max-file-prompt-width (floatp ido-max-file-prompt-width))
1409 (floor (* (frame-width) ido-max-file-prompt-width))
1410 ido-max-file-prompt-width))
789d1bf0
KS
1411 (literal (and (boundp 'ido-find-literal) ido-find-literal "(literal) "))
1412 (vc-off (and ido-saved-vc-mt (not vc-master-templates) "[-VC] "))
1413 (prefix nil)
362cdb61 1414 (rule ido-rewrite-file-prompt-rules))
789d1bf0
KS
1415 (let ((case-fold-search nil))
1416 (while rule
1417 (if (and (consp (car rule))
362cdb61
KS
1418 (string-match (car (car rule)) dirname))
1419 (setq dirname
789d1bf0 1420 (if (stringp (cdr (car rule)))
362cdb61
KS
1421 (replace-match (cdr (car rule)) t nil dirname)
1422 (funcall (cdr (car rule)) dirname))))
789d1bf0 1423 (setq rule (cdr rule))))
362cdb61 1424 (run-hooks 'ido-rewrite-file-prompt-functions)
71296446 1425 (concat prompt
789d1bf0
KS
1426 ; (if ido-process-ignore-lists "" "&")
1427 (or literal "")
1428 (or vc-off "")
1429 (or prefix "")
362cdb61 1430 (let ((l (length dirname)))
789d1bf0 1431 (if (and max-width (> max-width 0) (> l max-width))
71296446 1432 (let* ((s (substring dirname (- max-width)))
789d1bf0
KS
1433 (i (string-match "/" s)))
1434 (concat "..." (if i (substring s i) s)))
362cdb61 1435 dirname)))))
789d1bf0
KS
1436 (t prompt)))
1437
1438;; Here is very briefly how ido-find-file works:
1439;;
1440;; (ido-find-file)
1441;; (ido-file-internal method)
1442;; set ido-current-directory
1443;; (ido-read-internal 'file ...)
1444;; (while ...
1445;; (ido-make-item-list ...)
1446;; (ido-set-matches)
1447;; (completing-read ... ido-text-init ...)
1448;;
1449;; ... here user is allowed to type characters and commands
1450;; a command may set ido-exit and call (exit-minibuffer)
1451;; to make ido-read-internal do advanced tasks (or return)
1452;;
1453;; ... ido-tidy and ido-exhibit are pre- and post-hooks
1454;; which are run before and after each user command.
1455;;
1456;; return value from completing-read is stored in ido-final-text
1457;; - ido-exit may cause further actions to be taken:
1458;; 'refresh - repeat loop (make-item-list, set-matches)
1459;; 'edit - edit the prompt string, then repeat loop
1460;; 'keep - repeat loop but don't (re)make-item-list
1461;; 'updir - go up one directory, repeat loop
1462;; else set ido-selected based on ido-final-text,
1463;; optionally update ido-current-directory and repeat loop, or
1464;; exit with the return value of ido-selected (file name)
1465;; selected file name is returned from ido-read-internal,
1466;; ido-exit and method determines what action is taken
1467;; e.g. the file name may be ignored or joined with ido-current-directory, and
1468;; the relevant function is called (find-file, write-file, etc).
1469
1470(defun ido-read-internal (item prompt history &optional default require-match initial)
1471 "Perform the ido-read-buffer and ido-read-file-name functions.
71296446 1472Return the name of a buffer or file selected.
789d1bf0
KS
1473PROMPT is the prompt to give to the user.
1474DEFAULT if given is the default directory to start with.
1475If REQUIRE-MATCH is non-nil, an existing file must be selected.
1476If INITIAL is non-nil, it specifies the initial input string."
1477 (let
1478 ((ido-cur-item item)
1479 (ido-entry-buffer (current-buffer))
1480 (ido-process-ignore-lists t)
1481 (ido-process-ignore-lists-inhibit nil)
1482 (ido-set-default-item t)
1483 ido-default-item
1484 ido-selected
1485 ido-final-text
1486 (done nil)
1487 (icomplete-mode nil) ;; prevent icomplete starting up
1488 ;; Exported dynamic variables:
1489 ido-cur-list
1490 ido-ignored-list
1491 (ido-rotate-temp nil)
1492 (ido-keep-item-list nil)
1493 (ido-use-merged-list nil)
1494 (ido-try-merged-list t)
1495 (ido-pre-merge-state nil)
1496 (ido-case-fold ido-case-fold)
1497 (ido-enable-prefix ido-enable-prefix)
1498 (ido-enable-regexp ido-enable-regexp)
1499 )
1500
1501 (ido-define-mode-map)
1502 (setq ido-text-init initial)
1503 (while (not done)
bad111c2 1504 (ido-trace "\n_LOOP_" ido-text-init)
789d1bf0
KS
1505 (setq ido-exit nil)
1506 (setq ido-rescan t)
1507 (setq ido-rotate nil)
1508 (setq ido-text "")
69beb26d
KS
1509 (when ido-set-default-item
1510 (setq ido-default-item
1511 (cond
1512 ((eq item 'buffer)
1513 (if (bufferp default) (buffer-name default) default))
1514 ((stringp default) default)
1515 ((eq item 'file)
71296446 1516 (and ido-enable-last-directory-history
69beb26d
KS
1517 (let ((d (assoc ido-current-directory ido-last-directory-list)))
1518 (and d (cdr d)))))))
1519 (if (member ido-default-item ido-ignore-item-temp-list)
1520 (setq ido-default-item nil))
1521 (setq ido-set-default-item nil))
789d1bf0
KS
1522
1523 (if ido-process-ignore-lists-inhibit
1524 (setq ido-process-ignore-lists nil))
1525
1526 (if (and ido-use-merged-list (memq ido-try-merged-list '(t wide)) (not ido-keep-item-list))
1527 (let ((olist ido-cur-list)
1528 (oign ido-ignored-list)
1529 (omat ido-matches)
1530 (l (ido-make-merged-file-list ido-text-init
1531 (eq ido-use-merged-list 'auto)
1532 (eq ido-try-merged-list 'wide))))
1533 (cond
1534 ((not l)
1535 (if (eq ido-try-merged-list 'wide)
1536 (setq ido-pre-merge-state
1537 (list "" ido-current-directory olist oign omat)
1538 ido-cur-list nil
1539 ido-ignored-list nil
1540 ido-matches nil
1541 ido-keep-item-list t
1542 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1543 ido-use-merged-list nil)
1544 (setq ido-cur-list olist
1545 ido-ignored-list oign
1546 ido-matches omat
1547 ido-keep-item-list t
1548 ido-try-merged-list (if (eq ido-use-merged-list 'auto) 'auto nil)
1549 ido-use-merged-list nil)))
1550 ((eq l t)
1551 (setq ido-use-merged-list nil))
1552 (t
1553 (setq ido-pre-merge-state
1554 (list ido-text-init ido-current-directory olist oign omat))
1555 (ido-set-current-directory (car (cdr (car l))))
1556 (if (ido-final-slash ido-text-init)
1557 (setq ido-text-init ""))
1558 (setq ido-cur-list l
1559 ido-ignored-list nil
1560 ido-matches l
1561 ido-rescan nil
1562 ido-keep-item-list t
1563 ido-use-merged-list t)
1564 (ido-trace "Merged" t)
1565 ))))
71296446 1566
789d1bf0
KS
1567 (cond
1568 (ido-keep-item-list
1569 (setq ido-keep-item-list nil
1570 ido-rescan nil))
1571 ((eq ido-cur-item 'file)
1572 (setq ido-ignored-list nil
1573 ido-cur-list (ido-make-file-list ido-default-item)))
1574 ((eq ido-cur-item 'dir)
1575 (setq ido-ignored-list nil
1576 ido-cur-list (ido-make-dir-list ido-default-item)))
1577 ((eq ido-cur-item 'buffer)
1578 (setq ido-ignored-list nil
1579 ido-cur-list (ido-make-buffer-list ido-default-item)))
1580 (t nil))
1581 (setq ido-rotate-temp nil)
1582
1583 (if ido-process-ignore-lists-inhibit
1584 (setq ido-process-ignore-lists t
1585 ido-process-ignore-lists-inhibit nil))
1586
1587 (ido-set-matches)
1588 (if (and ido-matches (eq ido-try-merged-list 'auto))
1589 (setq ido-try-merged-list t))
71296446 1590 (let
789d1bf0
KS
1591 ((minibuffer-local-completion-map ido-mode-map)
1592 (max-mini-window-height (or ido-max-window-height
1593 (and (boundp 'max-mini-window-height) max-mini-window-height)))
1594 (ido-completing-read t)
1595 (ido-require-match require-match)
1596 (ido-use-mycompletion-depth (1+ (minibuffer-depth)))
1597 (show-paren-mode nil))
1598 ;; prompt the user for the file name
1599 (setq ido-exit nil)
1600 (setq ido-final-text
1601 (catch 'ido
71296446 1602 (completing-read
789d1bf0 1603 (ido-make-prompt item prompt)
9066a4d0 1604 '(("dummy" . 1)) nil nil ; table predicate require-match
789d1bf0
KS
1605 (prog1 ido-text-init (setq ido-text-init nil)) ;initial-contents
1606 history))))
1607 (ido-trace "completing-read" ido-final-text)
1608 (if (get-buffer ido-completion-buffer)
1609 (kill-buffer ido-completion-buffer))
1610
1611 (ido-trace "\n_EXIT_" ido-exit)
1612
1613 (cond
1614 ((eq ido-exit 'refresh)
71296446 1615 (if (and (eq ido-use-merged-list 'auto)
789d1bf0
KS
1616 (or (input-pending-p)))
1617 (setq ido-use-merged-list nil
1618 ido-keep-item-list t))
1619 nil)
1620
1621 ((eq ido-exit 'done)
1622 (setq done t
1623 ido-selected ido-text
1624 ido-exit nil))
1625
1626 ((memq ido-exit '(edit chdir))
71296446 1627 (cond
789d1bf0
KS
1628 ((memq ido-cur-item '(file dir))
1629 (let* ((process-environment (cons "HOME=/" process-environment)) ;; cheat read-file-name
1630 (read-file-name-function nil)
1631 (edit (eq ido-exit 'edit))
1632 (d ido-current-directory)
1633 (f ido-text-init)
84f6c6d0 1634 (new t))
789d1bf0 1635 (setq ido-text-init "")
84f6c6d0
KS
1636 (while new
1637 (setq new (if edit
789d1bf0
KS
1638 (read-file-name (concat prompt "[EDIT] ") d (concat d f) nil f)
1639 f)
84f6c6d0
KS
1640 d (or (file-name-directory new) "/")
1641 f (file-name-nondirectory new)
789d1bf0 1642 edit t)
71296446 1643 (if (or
789d1bf0
KS
1644 (file-directory-p d)
1645 (and (yes-or-no-p (format "Create directory %s? " d))
71296446 1646 (condition-case nil
789d1bf0
KS
1647 (progn (make-directory d t) t)
1648 (error
1649 (message "Could not create directory")
1650 (sit-for 1)
1651 nil))))
1652 (progn
1653 (ido-set-current-directory d nil (eq ido-exit 'chdir))
1654 (setq ido-text-init f
84f6c6d0 1655 new nil))))))
789d1bf0 1656 (t
789d1bf0
KS
1657 (setq ido-text-init (read-string (concat prompt "[EDIT] ") ido-final-text))))
1658 nil)
1659
1660 ((eq ido-exit 'keep)
1661 (setq ido-keep-item-list t))
1662
1663 ((memq ido-exit '(dired fallback findfile findbuffer))
1664 (setq done t))
1665
1666 ((eq ido-exit 'updir)
1667 ;; cannot go up if already at the root-dir (Unix) or at the
1668 ;; root-dir of a certain drive (Windows or MS-DOS).
bad111c2
KS
1669 (if (ido-is-tramp-root)
1670 (when (string-match "\\`\\(/\\([^/]+[:@]\\)*\\)\\([^/]+\\)[:@]\\'" ido-current-directory)
1671 (setq ido-text-init (match-string 3 ido-current-directory))
1672 (ido-set-current-directory (match-string 1 ido-current-directory))
1673 (setq ido-set-default-item t))
1674 (unless (ido-is-root-directory)
1675 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1)))
1676 (setq ido-set-default-item t))))
789d1bf0
KS
1677
1678 ;; Handling the require-match must be done in a better way.
1679 ((and require-match (not (ido-existing-item-p)))
1680 (error "must specify valid item"))
1681
1682 (t
1683 (setq ido-selected
69beb26d
KS
1684 (if (or (eq ido-exit 'takeprompt)
1685 (null ido-matches))
1686 ido-final-text
1687 ;; else take head of list
1688 (ido-name (car ido-matches))))
789d1bf0
KS
1689
1690 (cond
1691 ((eq item 'buffer)
1692 (setq done t))
1693
1694 ((string-equal "./" ido-selected)
1695 nil)
1696
1697 ((string-equal "../" ido-selected)
1698 ;; cannot go up if already at the root-dir (Unix) or at the
1699 ;; root-dir of a certain drive (Windows or MS-DOS).
1700 (or (ido-is-root-directory)
1701 (ido-set-current-directory (file-name-directory (substring ido-current-directory 0 -1))))
1702 (setq ido-set-default-item t))
bad111c2
KS
1703
1704 ((and (string-match (if ido-enable-tramp-completion "..[:@]\\'" "..:\\'") ido-selected)
1705 (ido-is-root-directory)) ;; Ange-ftp or Tramp
1706 (ido-set-current-directory ido-current-directory ido-selected)
1707 (ido-trace "tramp prefix" ido-selected)
789d1bf0
KS
1708 (if (ido-is-slow-ftp-host)
1709 (setq ido-exit 'fallback
1710 done t)
1711 (setq ido-set-default-item t)))
789d1bf0
KS
1712 ((or (string-match "[/\\][^/\\]" ido-selected)
1713 (and (memq system-type '(windows-nt ms-dos))
1714 (string-match "\\`.:" ido-selected)))
1715 (ido-set-current-directory (file-name-directory ido-selected))
1716 (setq ido-set-default-item t))
1717
1718 ((string-match "\\`~" ido-selected)
1719 (ido-set-current-home ido-selected))
1720
1721 ((ido-final-slash ido-selected)
1722 (if ido-enable-last-directory-history
1723 (let ((x (assoc ido-current-directory ido-last-directory-list)))
1724 (if x
1725 (setcdr x ido-selected)
1726 (setq ido-last-directory-list
1727 (cons (cons ido-current-directory ido-selected) ido-last-directory-list)))))
1728 (ido-set-current-directory ido-current-directory ido-selected)
1729 (setq ido-set-default-item t))
1730
1731 (t
1732 (setq done t))))))
1733 ido-selected))
1734
1735(defun ido-edit-input ()
362cdb61 1736 "Edit absolute file name entered so far with ido; terminate by RET."
789d1bf0
KS
1737 (interactive)
1738 (setq ido-text-init ido-text)
1739 (setq ido-exit 'edit)
1740 (exit-minibuffer))
1741
1742;;; MAIN FUNCTIONS
1743(defun ido-buffer-internal (method &optional fallback prompt default initial)
1744 ;; Internal function for ido-switch-buffer and friends
1745 (if (not ido-mode)
1746 (call-interactively (or fallback 'switch-to-buffer))
1747 (let ((buf (ido-read-buffer (or prompt "Buffer: ") default nil initial)))
1748
1749 ;; Choose the buffer name: either the text typed in, or the head
1750 ;; of the list of matches
1751
71296446 1752 (cond
789d1bf0
KS
1753 ((eq ido-exit 'findfile)
1754 (ido-file-internal ido-default-file-method nil nil nil nil ido-text))
1755
1756 ((eq ido-exit 'fallback)
1757 (let ((read-buffer-function nil))
1758 (call-interactively (or fallback 'switch-to-buffer))))
1759
1760 ;; Check buf is non-nil.
1761 ((not buf) nil)
69beb26d 1762 ((= (length buf) 0) nil)
789d1bf0
KS
1763
1764 ;; View buffer if it exists
1765 ((get-buffer buf)
1766 (if (eq method 'insert)
1767 (progn
1768 (ido-record-command 'insert-buffer buf)
1769 (insert-buffer buf))
1770 (ido-visit-buffer buf method t)))
1771
1772 ;; buffer doesn't exist
1773 ((eq ido-create-new-buffer 'never)
1774 (message "no buffer matching `%s'" buf))
1775
1776 ((and (eq ido-create-new-buffer 'prompt)
1777 (not (y-or-n-p (format "No buffer matching `%s', create one? " buf))))
1778 nil)
1779
1780 ;; create a new buffer
1781 (t
1782 (setq buf (get-buffer-create buf))
1783 (if (fboundp 'set-buffer-major-mode)
1784 (set-buffer-major-mode buf))
1785 (ido-visit-buffer buf method t))))))
1786
1787;;;###autoload
1788(defun ido-read-buffer (prompt &optional default require-match initial)
1789 "Replacement for the built-in `read-buffer'.
71296446 1790Return the name of a buffer selected.
789d1bf0
KS
1791PROMPT is the prompt to give to the user. DEFAULT if given is the default
1792buffer to be selected, which will go to the front of the list.
1793If REQUIRE-MATCH is non-nil, an existing-buffer must be selected.
1794If INITIAL is non-nil, it specifies the initial input string."
1795 (let ((ido-current-directory nil))
1796 (ido-read-internal 'buffer prompt 'ido-buffer-history default require-match initial)))
1797
1798(defun ido-record-work-directory (&optional dir)
1799 (when (and (numberp ido-max-work-directory-list) (> ido-max-work-directory-list 0))
1800 (if (and (setq dir (or dir ido-current-directory)) (> (length dir) 0))
1801 (let ((items ido-work-directory-list-ignore-regexps)
1802 (case-fold-search nil))
1803 (while (and items dir)
1804 (if (string-match (car items) dir)
1805 (setq dir nil))
1806 (setq items (cdr items)))
1807 (if dir
1808 (setq ido-work-directory-list (cons dir (delete dir ido-work-directory-list))))))
1809 (if (> (length ido-work-directory-list) ido-max-work-directory-list)
1810 (setcdr (nthcdr (1- ido-max-work-directory-list) ido-work-directory-list) nil))))
1811
1812(defun ido-forget-work-directory ()
1813 (interactive)
1814 (when (and ido-current-directory ido-work-directory-list)
1815 (setq ido-work-directory-list (delete ido-current-directory ido-work-directory-list))
1816 (when ido-use-merged-list
1817 (ido-undo-merge-work-directory)
1818 (setq ido-exit 'refresh
1819 ido-try-merged-list t
1820 ido-use-merged-list t
1821 ido-text-init ido-text
1822 ido-rotate-temp t)
1823 (exit-minibuffer))))
71296446 1824
789d1bf0
KS
1825(defun ido-record-work-file (name)
1826 ;; Save NAME in ido-work-file-list
1827 (when (and (numberp ido-max-work-file-list) (> ido-max-work-file-list 0))
1828 (or
1829 (and ido-work-file-list (equal (car ido-work-file-list) name))
1830 (setq ido-work-file-list (cons name (delete name ido-work-file-list))))
1831 (if (> (length ido-work-file-list) ido-max-work-file-list)
1832 (setcdr (nthcdr (1- ido-max-work-file-list) ido-work-file-list) nil))))
1833
1834(defun ido-file-internal (method &optional fallback default prompt item initial)
1835 ;; Internal function for ido-find-file and friends
1836 (let ((ido-current-directory (expand-file-name (or default default-directory)))
1837 filename)
1838
1839 (if (or (not ido-mode) (ido-is-slow-ftp-host))
1840 (setq filename t
1841 ido-exit 'fallback))
1842
1843 (let (ido-saved-vc-mt
1844 (vc-master-templates (and (boundp 'vc-master-templates) vc-master-templates))
1845 (ido-work-directory-index -1)
1846 (ido-work-file-index -1)
1847 (ido-find-literal nil))
1848
1849 (unless filename
1850 (setq ido-saved-vc-mt vc-master-templates)
1851 (setq filename (ido-read-internal (or item 'file)
1852 (or prompt "Find file: ")
1853 'ido-file-history nil nil initial)))
1854
1855 ;; Choose the file name: either the text typed in, or the head
1856 ;; of the list of matches
1857
1858 (cond
1859 ((eq ido-exit 'fallback)
1860 ;; Need to guard setting of default-directory here, since
1861 ;; we don't want to change directory of current buffer.
1862 (let ((default-directory ido-current-directory)
1863 (read-file-name-function nil))
1864 (call-interactively (or fallback 'find-file))))
1865
1866 ((eq ido-exit 'findbuffer)
1867 (ido-buffer-internal ido-default-buffer-method nil nil nil ido-text))
1868
1869 ((eq ido-exit 'dired)
1870 (dired (concat ido-current-directory (or ido-text ""))))
1871
1872 ((eq method 'alt-file)
1873 (ido-record-work-file filename)
1874 (setq default-directory ido-current-directory)
1875 (ido-record-work-directory)
1876 (find-alternate-file filename))
1877
1878 ((memq method '(dired list-directory))
1879 (if (equal filename ".")
1880 (setq filename ""))
84f6c6d0
KS
1881 (let* ((dirname (ido-final-slash (concat ido-current-directory filename) t))
1882 (file (substring dirname 0 -1)))
789d1bf0 1883 (cond
84f6c6d0
KS
1884 ((file-directory-p dirname)
1885 (ido-record-command method dirname)
1886 (ido-record-work-directory dirname)
1887 (funcall method dirname))
789d1bf0
KS
1888 ((file-directory-p ido-current-directory)
1889 (cond
1890 ((file-exists-p file)
1891 (ido-record-command method ido-current-directory)
1892 (ido-record-work-directory)
1893 (funcall method ido-current-directory)
1894 (if (eq method 'dired)
1895 (dired-goto-file (expand-file-name file))))
1896 ((string-match "[[*?]" filename)
84f6c6d0
KS
1897 (setq dirname (concat ido-current-directory filename))
1898 (ido-record-command method dirname)
789d1bf0 1899 (ido-record-work-directory)
84f6c6d0 1900 (funcall method dirname))
789d1bf0 1901 ((y-or-n-p (format "Directory %s does not exist. Create it " filename))
84f6c6d0
KS
1902 (ido-record-command method dirname)
1903 (ido-record-work-directory dirname)
1904 (make-directory-internal dirname)
1905 (funcall method dirname))
789d1bf0
KS
1906 (t
1907 ;; put make-directory command on history
84f6c6d0 1908 (ido-record-command 'make-directory dirname))))
789d1bf0
KS
1909 (t (error "No such directory")))))
1910
1911 ((eq method 'write)
1912 (ido-record-work-file filename)
1913 (setq default-directory ido-current-directory)
1914 (ido-record-command 'write-file (concat ido-current-directory filename))
1915 (ido-record-work-directory)
1916 (write-file filename))
1917
1918 ((eq method 'read-only)
1919 (ido-record-work-file filename)
1920 (setq filename (concat ido-current-directory filename))
1921 (ido-record-command fallback filename)
1922 (ido-record-work-directory)
1923 (funcall fallback filename))
1924
1925 ((eq method 'insert)
1926 (ido-record-work-file filename)
1927 (setq filename (concat ido-current-directory filename))
71296446 1928 (ido-record-command
789d1bf0
KS
1929 (if ido-find-literal 'insert-file-literally 'insert-file)
1930 filename)
1931 (ido-record-work-directory)
1932 (if ido-find-literal
1933 (insert-file-contents-literally filename)
1934 (insert-file-contents filename)))
1935
1936 (filename
1937 (ido-record-work-file filename)
1938 (setq filename (concat ido-current-directory filename))
1939 (ido-record-command 'find-file filename)
1940 (ido-record-work-directory)
1941 (ido-visit-buffer (find-file-noselect filename nil ido-find-literal) method))))))
1942
1943(defun ido-existing-item-p ()
1944 ;; Return non-nil if there is a matching item
1945 (not (null ido-matches)))
1946
1947;;; COMPLETION CODE
1948
1949(defun ido-set-common-completion ()
1950 ;; Find common completion of `ido-text' in `ido-matches'
1951 ;; The result is stored in `ido-common-match-string'
1952 (let* (val)
1953 (setq ido-common-match-string nil)
1954 (if (and ido-matches
1955 (not ido-enable-regexp) ;; testing
1956 (stringp ido-text)
1957 (> (length ido-text) 0))
1958 (if (setq val (ido-find-common-substring ido-matches ido-text))
1959 (setq ido-common-match-string val)))
1960 val))
1961
1962(defun ido-complete ()
1963 "Try and complete the current pattern amongst the file names."
1964 (interactive)
1965 (let (res)
71296446 1966 (cond
789d1bf0
KS
1967 ((and (memq ido-cur-item '(file dir))
1968 (string-match "[$]" ido-text))
1969 (let ((evar (substitute-in-file-name (concat ido-current-directory ido-text))))
1970 (if (not (file-exists-p (file-name-directory evar)))
337d2b66 1971 (message "Expansion generates non-existing directory name")
789d1bf0
KS
1972 (if (file-directory-p evar)
1973 (ido-set-current-directory evar)
1974 (let ((d (or (file-name-directory evar) "/"))
1975 (f (file-name-nondirectory evar)))
1976 (when (file-directory-p d)
1977 (ido-set-current-directory d)
1978 (setq ido-text-init f))))
1979 (setq ido-exit 'refresh)
1980 (exit-minibuffer))))
1981
1982 ((not ido-matches)
1983 (when ido-completion-buffer
d1a0acac 1984 (call-interactively (setq this-command ido-cannot-complete-command))))
71296446 1985
bad111c2
KS
1986 ((and (= 1 (length ido-matches))
1987 (not (and ido-enable-tramp-completion
1988 (string-equal ido-current-directory "/")
1989 (string-match "..[@:]\\'" (car ido-matches)))))
789d1bf0
KS
1990 ;; only one choice, so select it.
1991 (exit-minibuffer))
71296446 1992
789d1bf0
KS
1993 (t ;; else there could be some completions
1994 (setq res ido-common-match-string)
1995 (if (and (not (memq res '(t nil)))
1996 (not (equal res ido-text)))
1997 ;; found something to complete, so put it in the minibuffer.
1998 (progn
1999 ;; move exact match to front if not in prefix mode
2000 (setq ido-rescan (not ido-enable-prefix))
2001 (delete-region (minibuffer-prompt-end) (point))
2002 (insert res))
2003 ;; else nothing to complete
d1a0acac 2004 (call-interactively (setq this-command ido-cannot-complete-command))
789d1bf0
KS
2005 )))))
2006
030fa15b
KS
2007(defun ido-complete-space ()
2008 "Try completion unless inserting the space makes sense."
2009 (interactive)
2010 (if (and (stringp ido-common-match-string)
2011 (stringp ido-text)
2012 (cond
2013 ((> (length ido-common-match-string) (length ido-text))
2014 (= (aref ido-common-match-string (length ido-text)) ? ))
2015 (ido-matches
2016 (let (insert-space
2017 (re (concat (regexp-quote ido-text) " "))
2018 (comp ido-matches))
2019 (while comp
2020 (if (string-match re (ido-name (car comp)))
2021 (setq comp nil insert-space t)
2022 (setq comp (cdr comp))))
2023 insert-space))
2024 (t nil)))
2025 (insert " ")
2026 (ido-complete)))
2027
789d1bf0
KS
2028(defun ido-undo-merge-work-directory (&optional text try refresh)
2029 "Undo or redo last ido directory merge operation.
2030If no merge has yet taken place, toggle automatic merging option."
2031 (interactive)
2032 (cond
2033 (ido-pre-merge-state
2034 (ido-set-current-directory (nth 1 ido-pre-merge-state))
2035 (setq ido-text-init (or text (car ido-pre-merge-state))
2036 ido-cur-list (nth 2 ido-pre-merge-state)
2037 ido-ignored-list (nth 3 ido-pre-merge-state)
2038 ido-matches (nth 4 ido-pre-merge-state)
2039 ido-use-merged-list nil
2040 ido-try-merged-list try
2041 ido-keep-item-list (not refresh)
2042 ido-rescan nil
2043 ido-exit 'refresh
2044 ido-pre-merge-state nil)
2045 (exit-minibuffer))
2046 (text
2047 nil)
2048 (ido-try-merged-list
2049 (setq ido-try-merged-list nil))
2050 (ido-matches
2051 (setq ido-try-merged-list t))
2052 ((not ido-use-merged-list)
2053 (ido-merge-work-directories))))
71296446 2054
789d1bf0
KS
2055;;; TOGGLE FUNCTIONS
2056
2057(defun ido-toggle-case ()
2058 "Toggle the value of `ido-case-fold'."
2059 (interactive)
2060 (setq ido-case-fold (not ido-case-fold))
2061 ;; ask for list to be regenerated.
2062 (setq ido-rescan t))
2063
2064(defun ido-toggle-regexp ()
2065 "Toggle the value of `ido-enable-regexp'."
2066 (interactive)
2067 (setq ido-enable-regexp (not ido-enable-regexp))
2068 ;; ask for list to be regenerated.
2069 (setq ido-rescan t))
2070
2071(defun ido-toggle-prefix ()
2072 "Toggle the value of `ido-enable-prefix'."
2073 (interactive)
2074 (setq ido-enable-prefix (not ido-enable-prefix))
2075 ;; ask for list to be regenerated.
2076 (setq ido-rescan t))
2077
2078(defun ido-toggle-ignore ()
2079 "Toggle ignoring files specified with `ido-ignore-files'."
2080 (interactive)
2081 (setq ido-process-ignore-lists (not ido-process-ignore-lists))
2082 (setq ido-text-init ido-text)
2083 (setq ido-exit 'refresh)
2084 (exit-minibuffer))
2085
2086(defun ido-toggle-vc ()
2087 "Disable version control for this file."
2088 (interactive)
2089 (if (and ido-mode (eq ido-cur-item 'file))
2090 (progn
71296446 2091 (setq vc-master-templates
789d1bf0
KS
2092 (if vc-master-templates nil ido-saved-vc-mt))
2093 (setq ido-text-init ido-text)
2094 (setq ido-exit 'keep)
2095 (exit-minibuffer))))
2096
2097(defun ido-toggle-literal ()
2098 "Toggle literal reading of this file."
2099 (interactive)
2100 (if (and ido-mode (eq ido-cur-item 'file))
2101 (progn
2102 (setq ido-find-literal (not ido-find-literal))
2103 (setq ido-text-init ido-text)
2104 (setq ido-exit 'keep)
2105 (exit-minibuffer))))
2106
2107(defun ido-reread-directory ()
2108 "Read current directory again.
2109May be useful if cached version is no longer valid, but directory
2110timestamp has not changed (e.g. with ftp or on Windows)."
2111 (interactive)
2112 (if (and ido-mode (eq ido-cur-item 'file))
2113 (progn
2114 (ido-remove-cached-dir ido-current-directory)
2115 (setq ido-text-init ido-text)
2116 (setq ido-rotate-temp t)
2117 (setq ido-exit 'refresh)
2118 (exit-minibuffer))))
2119
2120(defun ido-exit-minibuffer ()
2121 "Exit minibuffer, but make sure we have a match if one is needed."
2122 (interactive)
2123 (if (or (not ido-require-match)
2124 (ido-existing-item-p))
2125 (throw 'exit nil)))
2126
2127(defun ido-select-text ()
2128 "Select the buffer or file named by the prompt.
2129If no buffer or file exactly matching the prompt exists, maybe create a new one."
2130 (interactive)
2131 (setq ido-exit 'takeprompt)
2132 (exit-minibuffer))
2133
2134(defun ido-fallback-command ()
2135 "Fallback to non-ido version of current command."
2136 (interactive)
2137 (setq ido-exit 'fallback)
2138 (exit-minibuffer))
2139
2140(defun ido-enter-find-file ()
2141 "Drop into find-file from buffer switching."
2142 (interactive)
2143 (setq ido-exit 'findfile)
2144 (exit-minibuffer))
2145
2146(defun ido-enter-switch-buffer ()
2147 "Drop into ido-switch-buffer from file switching."
2148 (interactive)
2149 (setq ido-exit 'findbuffer)
2150 (exit-minibuffer))
2151
2152(defun ido-enter-dired ()
2153 "Drop into dired from file switching."
2154 (interactive)
2155 (setq ido-exit 'dired)
2156 (exit-minibuffer))
2157
2158
2159(defun ido-up-directory (&optional clear)
2160 "Go up one directory level."
2161 (interactive "P")
2162 (setq ido-text-init (if clear nil ido-text))
2163 (setq ido-exit 'updir)
2164 (setq ido-rotate-temp t)
2165 (exit-minibuffer))
2166
2167(defun ido-delete-backward-updir (count)
2168 "Delete char backwards, or at beginning of buffer, go up one level."
2169 (interactive "P")
2170 (cond
2171 ((= (minibuffer-prompt-end) (point))
2172 (if (not count)
2173 (ido-up-directory t)))
2174 ((and ido-pre-merge-state (string-equal (car ido-pre-merge-state) ido-text))
2175 (ido-undo-merge-work-directory (substring ido-text 0 -1) t t))
f0a73ccc
KS
2176 ((eq this-original-command 'viper-backward-char)
2177 (funcall this-original-command (prefix-numeric-value count)))
2178 ((eq this-original-command 'viper-del-backward-char-in-insert)
2179 (funcall this-original-command))
789d1bf0
KS
2180 (t
2181 (delete-backward-char (prefix-numeric-value count)))))
2182
2183(defun ido-delete-backward-word-updir (count)
2184 "Delete all chars backwards, or at beginning of buffer, go up one level."
2185 (interactive "P")
2186 (if (= (minibuffer-prompt-end) (point))
2187 (if (not count)
2188 (ido-up-directory t))
f0a73ccc
KS
2189 (if (eq this-original-command 'viper-delete-backward-word)
2190 (funcall this-original-command (prefix-numeric-value count))
2191 (backward-kill-word (prefix-numeric-value count)))))
789d1bf0
KS
2192
2193(defun ido-get-work-directory (&optional incr must-match)
2194 (let ((n (length ido-work-directory-list))
2195 (i ido-work-directory-index)
2196 (j 0)
2197 dir)
2198 (if (or (not ido-text) (= (length ido-text) 0))
2199 (setq must-match nil))
2200 (while (< j n)
2201 (setq i (+ i incr)
2202 j (1+ j))
2203 (if (> incr 0)
2204 (if (>= i n) (setq i 0))
2205 (if (< i 0) (setq i (1- n))))
2206 (setq dir (nth i ido-work-directory-list))
2207 (if (and dir
2208 (not (equal dir ido-current-directory))
2209 (file-directory-p dir)
2210 (or (not must-match)
2211 (ido-set-matches1
2212 (if (eq ido-cur-item 'file)
2213 (ido-make-file-list1 dir)
2214 (ido-make-dir-list1 dir)))))
2215 (setq j n)
2216 (setq dir nil)))
2217 (if dir
2218 (setq ido-work-directory-index i))
2219 dir))
2220
2221(defun ido-prev-work-directory ()
2222 "Change to next working directory in list."
2223 (interactive)
2224 (let ((dir (ido-get-work-directory 1 ido-work-directory-match-only)))
2225 (when dir
2226 (ido-set-current-directory dir)
2227 (setq ido-exit 'refresh)
2228 (setq ido-text-init ido-text)
2229 (setq ido-rotate-temp t)
2230 (exit-minibuffer))))
2231
2232(defun ido-next-work-directory ()
2233 "Change to previous working directory in list."
2234 (interactive)
2235 (let ((dir (ido-get-work-directory -1 ido-work-directory-match-only)))
2236 (when dir
2237 (ido-set-current-directory dir)
2238 (setq ido-exit 'refresh)
2239 (setq ido-text-init ido-text)
2240 (setq ido-rotate-temp t)
2241 (exit-minibuffer))))
2242
2243(defun ido-merge-work-directories ()
2244 "Search (and merge) work directories for files matching the current input string."
2245 (interactive)
2246 (setq ido-use-merged-list t ido-try-merged-list t)
2247 (setq ido-exit 'refresh)
2248 (setq ido-text-init ido-text)
2249 (setq ido-rotate-temp t)
2250 (exit-minibuffer))
2251
2252(defun ido-wide-find-file (&optional file)
2253 "Prompt for FILE to search for using find, starting from current directory."
2254 (interactive)
2255 (unless file
2256 (setq file (read-string (concat "Wide find file: " ido-current-directory) ido-text)))
2257 (when (> (length file) 0)
2258 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2259 (setq ido-exit 'refresh)
2260 (setq ido-text-init file)
2261 (setq ido-rotate-temp t)
2262 (exit-minibuffer)))
2263
2264(defun ido-wide-find-dir (&optional dir)
2265 "Prompt for DIR to search for using find, starting from current directory."
2266 (interactive)
2267 (unless dir
2268 (setq dir (read-string (concat "Wide find directory: " ido-current-directory) ido-text)))
2269 (when (> (length dir) 0)
2270 (setq ido-use-merged-list t ido-try-merged-list 'wide)
2271 (setq ido-exit 'refresh)
2272 (setq ido-text-init (ido-final-slash dir t))
2273 (setq ido-rotate-temp t)
2274 (exit-minibuffer)))
2275
2276(defun ido-make-directory (&optional dir)
2277 "Prompt for DIR to create in current directory."
2278 (interactive)
2279 (unless dir
2280 (setq dir (read-string (concat "Make directory: " ido-current-directory) ido-text)))
2281 (when (> (length dir) 0)
2282 (setq dir (concat ido-current-directory dir))
2283 (unless (file-exists-p dir)
2284 (make-directory dir t)
2285 (ido-set-current-directory dir)
2286 (setq ido-exit 'refresh)
2287 (setq ido-text-init nil)
2288 (setq ido-rotate-temp t)
2289 (exit-minibuffer))))
2290
2291(defun ido-get-work-file (incr)
2292 (let ((n (length ido-work-file-list))
2293 (i (+ ido-work-file-index incr))
2294 name)
2295 (if (> incr 0)
2296 (if (>= i n) (setq i 0))
2297 (if (< i 0) (setq i (1- n))))
2298 (setq name (nth i ido-work-file-list))
2299 (setq ido-work-file-index i)
2300 name))
2301
2302(defun ido-prev-work-file ()
2303 "Change to next working file name in list."
2304 (interactive)
2305 (let ((name (ido-get-work-file 1)))
2306 (when name
2307 (setq ido-text-init name)
2308 (setq ido-exit 'refresh)
2309 (exit-minibuffer))))
2310
2311(defun ido-next-work-file ()
2312 "Change to previous working file name in list."
2313 (interactive)
2314 (let ((name (ido-get-work-file -1)))
2315 (when name
2316 (setq ido-text-init name)
2317 (setq ido-exit 'refresh)
2318 (exit-minibuffer))))
2319
2320(defun ido-copy-current-file-name (all)
2321 "Insert file name of current buffer.
2322If repeated, insert text from buffer instead."
2323 (interactive "P")
84f6c6d0
KS
2324 (let* ((bfname (buffer-file-name ido-entry-buffer))
2325 (name (and bfname (file-name-nondirectory bfname))))
789d1bf0 2326 (when name
71296446
JB
2327 (setq ido-text-init
2328 (if (or all
84f6c6d0 2329 (not (equal (file-name-directory bfname) ido-current-directory))
789d1bf0
KS
2330 (not (string-match "\\.[^.]*\\'" name)))
2331 name
2332 (substring name 0 (1+ (match-beginning 0)))))
2333 (setq ido-exit 'refresh
2334 ido-try-merged-list nil)
2335 (exit-minibuffer))))
71296446 2336
789d1bf0 2337(defun ido-copy-current-word (all)
362cdb61 2338 "Insert current word (file or directory name) from current buffer."
789d1bf0
KS
2339 (interactive "P")
2340 (let ((word (save-excursion
2341 (set-buffer ido-entry-buffer)
2342 (let ((p (point)) start-line end-line start-name name)
2343 (beginning-of-line)
2344 (setq start-line (point))
2345 (end-of-line)
2346 (setq end-line (point))
2347 (goto-char p)
2348 (if (re-search-backward "[^-_a-zA-Z0-9:./\\~@]" start-line 1)
2349 (forward-char 1))
2350 (setq start-name (point))
2351 (re-search-forward "[-_a-zA-Z0-9:./\\~@]*" end-line 1)
2352 (if (= start-name (point))
2353 nil
2354 (buffer-substring-no-properties start-name (point)))))))
2355 (if (cond
2356 ((not word) nil)
2357 ((string-match "\\`[~/]" word)
2358 (setq ido-text-init word
2359 ido-try-merged-list nil
2360 ido-exit 'chdir))
2361 ((string-match "/" word)
2362 (setq ido-text-init (concat ido-current-directory word)
2363 ido-try-merged-list nil
2364 ido-exit 'chdir))
2365 (t
2366 (setq ido-text-init word
2367 ido-try-merged-list nil
2368 ido-exit 'refresh)))
2369 (exit-minibuffer))))
2370
71296446 2371(defun ido-next-match ()
789d1bf0
KS
2372 "Put first element of `ido-matches' at the end of the list."
2373 (interactive)
2374 (if ido-matches
2375 (let ((next (cadr ido-matches)))
2376 (setq ido-cur-list (ido-chop ido-cur-list next))
2377 (setq ido-rescan t)
2378 (setq ido-rotate t))))
2379
71296446 2380(defun ido-prev-match ()
789d1bf0
KS
2381 "Put last element of `ido-matches' at the front of the list."
2382 (interactive)
2383 (if ido-matches
2384 (let ((prev (car (last ido-matches))))
2385 (setq ido-cur-list (ido-chop ido-cur-list prev))
2386 (setq ido-rescan t)
2387 (setq ido-rotate t))))
2388
71296446 2389(defun ido-next-match-dir ()
789d1bf0
KS
2390 "Find next directory in match list.
2391If work directories have been merged, cycle through directories for
2392first matching file."
2393 (interactive)
2394 (if ido-use-merged-list
2395 (if ido-matches
2396 (let* ((elt (car ido-matches))
2397 (dirs (cdr elt)))
2398 (when (> (length dirs) 1)
2399 (setcdr elt (ido-chop dirs (cadr dirs))))
2400 (setq ido-rescan nil)))
2401 (let ((cnt (length ido-matches))
2402 (i 1))
2403 (while (and (< i cnt) (not (ido-final-slash (nth i ido-matches))))
2404 (setq i (1+ i)))
2405 (if (< i cnt)
2406 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2407
71296446 2408(defun ido-prev-match-dir ()
789d1bf0
KS
2409 "Find previous directory in match list.
2410If work directories have been merged, cycle through directories
2411for first matching file."
2412 (interactive)
2413 (if ido-use-merged-list
2414 (if ido-matches
2415 (let* ((elt (car ido-matches))
2416 (dirs (cdr elt)))
2417 (when (> (length dirs) 1)
2418 (setcdr elt (ido-chop dirs (car (last dirs)))))
2419 (setq ido-rescan nil)))
2420 (let* ((cnt (length ido-matches))
2421 (i (1- cnt)))
2422 (while (and (> i 0) (not (ido-final-slash (nth i ido-matches))))
2423 (setq i (1- i)))
2424 (if (> i 0)
2425 (setq ido-cur-list (ido-chop ido-cur-list (nth i ido-matches)))))))
2426
71296446 2427(defun ido-restrict-to-matches ()
08bfde76
KS
2428 "Set current item list to the currently matched items."
2429 (interactive)
2430 (when ido-matches
2431 (setq ido-cur-list ido-matches
2432 ido-text-init ""
2433 ido-rescan nil
2434 ido-exit 'keep)
2435 (exit-minibuffer)))
2436
789d1bf0
KS
2437(defun ido-chop (items elem)
2438 "Remove all elements before ELEM and put them at the end of ITEMS."
2439 (let ((ret nil)
2440 (next nil)
2441 (sofar nil))
2442 (while (not ret)
2443 (setq next (car items))
2444 (if (equal next elem)
2445 (setq ret (append items (nreverse sofar)))
2446 ;; else
2447 (progn
2448 (setq items (cdr items))
2449 (setq sofar (cons next sofar)))))
2450 ret))
2451
2452(defun ido-name (item)
2453 ;; Return file name for current item, whether in a normal list
2454 ;; or a merged work directory list.
2455 (if (consp item) (car item) item))
2456
2457
2458;;; CREATE LIST OF ALL CURRENT FILES
2459
2460(defun ido-all-completions ()
2461 ;; Return unsorted list of all competions.
2462 (let ((ido-process-ignore-lists nil))
2463 (cond
2464 ((eq ido-cur-item 'file)
2465 (ido-make-file-list1 ido-current-directory))
2466 ((eq ido-cur-item 'dir)
2467 (ido-make-dir-list1 ido-current-directory))
2468 ((eq ido-cur-item 'buffer)
2469 (ido-make-buffer-list1))
2470 (t nil))))
2471
2472
2473(defun ido-sort-list (items)
2474 ;; Simple list of file or buffer names
2475 (sort items (lambda (a b) (string-lessp a b))))
2476
2477(defun ido-sort-merged-list (items promote)
2478 ;; Input is list of ("file" . "dir") cons cells.
2479 ;; Output is sorted list of ("file "dir" ...) lists
2480 (let ((l (sort items (lambda (a b) (string-lessp (car b) (car a)))))
2481 res a cur dirs)
2482 (while l
2483 (setq a (car l)
2484 l (cdr l))
2485 (if (and res (string-equal (car (car res)) (car a)))
2486 (progn
2487 (setcdr (car (if cur (cdr res) res)) (cons (cdr a) (cdr (car res))))
2488 (if (and promote (string-equal ido-current-directory (cdr a)))
2489 (setq cur t)))
2490 (setq res (cons (list (car a) (cdr a)) res)
2491 cur nil)))
2492 res))
2493
2494(defun ido-wide-find-dirs-or-files (dir file &optional prefix finddir)
2495 ;; As ido-run-find-command, but returns a list of cons pairs ("file" . "dir")
71296446
JB
2496 (let ((filenames
2497 (split-string
789d1bf0
KS
2498 (shell-command-to-string
2499 (concat "find " dir " -name \"" (if prefix "" "*") file "*\" -type " (if finddir "d" "f") " -print"))))
84f6c6d0 2500 filename d f
789d1bf0 2501 res)
84f6c6d0
KS
2502 (while filenames
2503 (setq filename (car filenames)
2504 filenames (cdr filenames))
2505 (if (and (string-match "^/" filename)
2506 (file-exists-p filename))
2507 (setq d (file-name-directory filename)
2508 f (file-name-nondirectory filename)
789d1bf0
KS
2509 res (cons (cons (if finddir (ido-final-slash f t) f) d) res))))
2510 res))
2511
2512(defun ido-flatten-merged-list (items)
362cdb61 2513 ;; Create a list of directory names based on a merged directory list.
789d1bf0
KS
2514 (let (res)
2515 (while items
2516 (let* ((item (car items))
2517 (file (car item))
2518 (dirs (cdr item)))
2519 (while dirs
2520 (setq res (cons (concat (car dirs) file) res)
2521 dirs (cdr dirs))))
2522 (setq items (cdr items)))
2523 res))
2524
2525(defun ido-make-merged-file-list (text auto wide)
2526 (let (res)
2527 (message "Searching for `%s'...." text)
2528 (if (and (ido-final-slash text) ido-dir-file-cache)
2529 (if wide
2530 (setq res (ido-wide-find-dirs-or-files
2531 ido-current-directory (substring text 0 -1) ido-enable-prefix t))
2532 ;; Use list of cached directories
2533 (let ((re (concat (regexp-quote (substring text 0 -1)) "[^/:]*/\\'"))
2534 (dirs ido-dir-file-cache)
2535 dir b d f)
2536 (if nil ;; simple
2537 (while dirs
2538 (setq dir (car (car dirs))
2539 dirs (cdr dirs))
2540 (when (and (string-match re dir)
2541 (not (ido-ignore-item-p dir ido-ignore-directories-merge))
2542 (file-directory-p dir))
2543 (setq b (substring dir 0 -1)
2544 f (concat (file-name-nondirectory b) "/")
2545 d (file-name-directory b)
2546 res (cons (cons f d) res))))
2547 (while dirs
2548 (setq dir (car dirs)
2549 d (car dir)
2550 dirs (cdr dirs))
2551 (when (not (ido-ignore-item-p d ido-ignore-directories-merge))
2552 (setq dir (cdr (cdr dir)))
2553 (while dir
2554 (setq f (car dir)
2555 dir (cdr dir))
2556 (if (and (string-match re f)
2557 (not (ido-ignore-item-p f ido-ignore-directories)))
2558 (setq res (cons (cons f d) res)))))
2559 (if (and auto (input-pending-p))
2560 (setq dirs nil
2561 res t))))))
2562 (if wide
2563 (setq res (ido-wide-find-dirs-or-files
2564 ido-current-directory text ido-enable-prefix nil))
2565 (let ((ido-text text)
2566 (dirs ido-work-directory-list)
2567 (must-match (and text (> (length text) 0)))
2568 dir fl)
2569 (if (and auto (not (member ido-current-directory dirs)))
2570 (setq dirs (cons ido-current-directory dirs)))
2571 (while dirs
2572 (setq dir (car dirs)
2573 dirs (cdr dirs))
2574 (when (and dir (stringp dir)
2575 (or ido-merge-ftp-work-directories
2576 (not (ido-is-ftp-directory dir)))
2577 (file-directory-p dir)
2578 (setq fl (if (eq ido-cur-item 'file)
2579 (ido-make-file-list1 dir t)
2580 (ido-make-dir-list1 dir t))))
2581 (if must-match
2582 (setq fl (ido-set-matches1 fl)))
2583 (if fl
2584 (setq res (nconc fl res))))
2585 (if (and auto (input-pending-p))
2586 (setq dirs nil
2587 res t))))))
2588 (if (and res (not (eq res t)))
2589 (setq res (ido-sort-merged-list res auto)))
9a08196a 2590 (when (and (or ido-rotate-temp ido-rotate-file-list-default)
e20b3173 2591 (listp res)
9a08196a
KS
2592 (> (length text) 0))
2593 (let ((elt (assoc text res)))
4e85a733 2594 (when (and elt (not (eq elt (car res))))
9a08196a
KS
2595 (setq res (delq elt res))
2596 (setq res (cons elt res)))))
789d1bf0
KS
2597 (message nil)
2598 res))
2599
2600(defun ido-make-buffer-list1 (&optional frame visible)
2601 ;; Return list of non-ignored buffer names
71296446 2602 (delq nil
789d1bf0
KS
2603 (mapcar
2604 (lambda (x)
2605 (let ((name (buffer-name x)))
69beb26d 2606 (if (not (or (ido-ignore-item-p name ido-ignore-buffers) (member name visible)))
789d1bf0
KS
2607 name)))
2608 (buffer-list frame))))
2609
2610(defun ido-make-buffer-list (default)
2611 ;; Return the current list of buffers.
2612 ;; Currently visible buffers are put at the end of the list.
71296446 2613 ;; The hook `ido-make-buflist-hook' is run after the list has been
789d1bf0
KS
2614 ;; created to allow the user to further modify the order of the buffer names
2615 ;; in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
2616 ;; it is put to the start of the list.
2617 (let* ((ido-current-buffers (ido-get-buffers-in-frames 'current))
2618 (ido-temp-list (ido-make-buffer-list1 (selected-frame) ido-current-buffers)))
2619 (if ido-temp-list
2620 (nconc ido-temp-list ido-current-buffers)
2621 (setq ido-temp-list ido-current-buffers))
2622 (if default
2623 (progn
71296446 2624 (setq ido-temp-list
789d1bf0 2625 (delete default ido-temp-list))
71296446 2626 (setq ido-temp-list
789d1bf0
KS
2627 (cons default ido-temp-list))))
2628 (run-hooks 'ido-make-buffer-list-hook)
2629 ido-temp-list))
2630
2631(defun ido-to-end (items)
2632 ;; Move the elements from ITEMS to the end of `ido-temp-list'
71296446
JB
2633 (mapcar
2634 (lambda (elem)
789d1bf0
KS
2635 (setq ido-temp-list (delq elem ido-temp-list)))
2636 items)
2637 (if ido-temp-list
2638 (nconc ido-temp-list items)
2639 (setq ido-temp-list items)))
2640
bad111c2
KS
2641(defun ido-file-name-all-completions1 (dir)
2642 (if (and ido-enable-tramp-completion
2643 (string-match "\\`/\\([^/:]+:\\([^/:@]+@\\)?\\)\\'" dir))
2644
2645 ;; Trick tramp's file-name-all-completions handler to DTRT, as it
2646 ;; has some pretty obscure requirements. This seems to work...
2647 ;; /ftp: => (f-n-a-c "/ftp:" "")
2648 ;; /ftp:kfs: => (f-n-a-c "" "/ftp:kfs:")
2649 ;; /ftp:kfs@ => (f-n-a-c "ftp:kfs@" "/")
2650 ;; /ftp:kfs@kfs: => (f-n-a-c "" "/ftp:kfs@kfs:")
2651 ;; Currently no attempt is made to handle multi: stuff.
2652
2653 (let* ((prefix (match-string 1 dir))
2654 (user-flag (match-beginning 2))
2655 (len (and prefix (length prefix)))
2656 compl)
2657 (if user-flag
2658 (setq dir (substring dir 1)))
2659 (require 'tramp nil t)
2660 (ido-trace "tramp complete" dir)
2661 (setq compl (file-name-all-completions dir (if user-flag "/" "")))
2662 (if (> len 0)
2663 (mapcar (lambda (c) (substring c len)) compl)
2664 compl))
2665 (file-name-all-completions "" dir)))
2666
789d1bf0
KS
2667(defun ido-file-name-all-completions (dir)
2668 ;; Return name of all files in DIR
2669 ;; Uses and updates ido-dir-file-cache
2670 (if (and (numberp ido-max-dir-file-cache) (> ido-max-dir-file-cache 0)
2671 (stringp dir) (> (length dir) 0)
2672 (ido-may-cache-directory dir))
2673 (let* ((cached (assoc dir ido-dir-file-cache))
71296446 2674 (ctime (nth 1 cached))
789d1bf0
KS
2675 (ftp (ido-is-ftp-directory dir))
2676 (attr (if ftp nil (file-attributes dir)))
2677 (mtime (nth 5 attr))
2678 valid)
2679 (when cached ; should we use the cached entry ?
2680 (if ftp
2681 (setq valid (and (eq (car ctime) 'ftp)
2682 (ido-cache-ftp-valid (cdr ctime))))
2683 (if attr
2684 (setq valid (and (= (car ctime) (car mtime))
2685 (= (car (cdr ctime)) (car (cdr mtime)))))))
2686 (if (not valid)
2687 (setq ido-dir-file-cache (delq cached ido-dir-file-cache)
2688 cached nil)))
2689 (unless cached
2690 (if (and ftp (file-readable-p dir))
2691 (setq mtime (cons 'ftp (ido-time-stamp))))
2692 (if mtime
bad111c2 2693 (setq cached (cons dir (cons mtime (ido-file-name-all-completions1 dir)))
789d1bf0
KS
2694 ido-dir-file-cache (cons cached ido-dir-file-cache)))
2695 (if (> (length ido-dir-file-cache) ido-max-dir-file-cache)
2696 (setcdr (nthcdr (1- ido-max-dir-file-cache) ido-dir-file-cache) nil)))
2697 (and cached
2698 (cdr (cdr cached))))
bad111c2 2699 (ido-file-name-all-completions1 dir)))
789d1bf0
KS
2700
2701(defun ido-remove-cached-dir (dir)
2702 ;; Remove dir from ido-dir-file-cache
2703 (if (and ido-dir-file-cache
2704 (stringp dir) (> (length dir) 0))
2705 (let ((cached (assoc dir ido-dir-file-cache)))
2706 (if cached
2707 (setq ido-dir-file-cache (delq cached ido-dir-file-cache))))))
2708
2709
2710(defun ido-make-file-list1 (dir &optional merged)
2711 ;; Return list of non-ignored files in DIR
2712 ;; If MERGED is non-nil, each file is cons'ed with DIR
bad111c2 2713 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
71296446 2714 (delq nil
789d1bf0
KS
2715 (mapcar
2716 (lambda (name)
2717 (if (not (ido-ignore-item-p name ido-ignore-files t))
2718 (if merged (cons name dir) name)))
2719 (ido-file-name-all-completions dir)))))
2720
2721(defun ido-make-file-list (default)
2722 ;; Return the current list of files.
2723 ;; Currently visible files are put at the end of the list.
71296446 2724 ;; The hook `ido-make-file-list-hook' is run after the list has been
789d1bf0
KS
2725 ;; created to allow the user to further modify the order of the file names
2726 ;; in this list.
2727 (let ((ido-temp-list (ido-make-file-list1 ido-current-directory)))
2728 (setq ido-temp-list (ido-sort-list ido-temp-list))
2729 (let ((default-directory ido-current-directory))
2730 (ido-to-end ;; move ftp hosts and visited files to end
71296446
JB
2731 (delq nil (mapcar
2732 (lambda (x) (if (or (string-match "..:\\'" x)
4d80e3ae
KS
2733 (and (not (ido-final-slash x))
2734 (get-file-buffer x))) x))
789d1bf0
KS
2735 ido-temp-list))))
2736 (ido-to-end ;; move . files to end
71296446 2737 (delq nil (mapcar
789d1bf0
KS
2738 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2739 ido-temp-list)))
2740 (if (and default (member default ido-temp-list))
2741 (if (or ido-rotate-temp ido-rotate-file-list-default)
2742 (unless (equal default (car ido-temp-list))
2743 (let ((l ido-temp-list) k)
2744 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2745 (setq l (cdr l)))
2746 (setq k (cdr l))
2747 (setcdr l nil)
2748 (nconc k ido-temp-list)
2749 (setq ido-temp-list k)))
71296446 2750 (setq ido-temp-list
789d1bf0 2751 (delete default ido-temp-list))
71296446 2752 (setq ido-temp-list
789d1bf0
KS
2753 (cons default ido-temp-list))))
2754 (when ido-show-dot-for-dired
2755 (setq ido-temp-list (delete "." ido-temp-list))
2756 (setq ido-temp-list (cons "." ido-temp-list)))
2757 (run-hooks 'ido-make-file-list-hook)
2758 ido-temp-list))
2759
2760(defun ido-make-dir-list1 (dir &optional merged)
2761 ;; Return list of non-ignored subdirs in DIR
2762 ;; If MERGED is non-nil, each subdir is cons'ed with DIR
bad111c2 2763 (and (or (ido-is-tramp-root dir) (file-directory-p dir))
71296446 2764 (delq nil
789d1bf0
KS
2765 (mapcar
2766 (lambda (name)
2767 (and (ido-final-slash name) (not (ido-ignore-item-p name ido-ignore-directories))
2768 (if merged (cons name dir) name)))
2769 (ido-file-name-all-completions dir)))))
2770
2771(defun ido-make-dir-list (default)
2772 ;; Return the current list of directories.
71296446 2773 ;; The hook `ido-make-dir-list-hook' is run after the list has been
789d1bf0
KS
2774 ;; created to allow the user to further modify the order of the
2775 ;; directory names in this list.
2776 (let ((ido-temp-list (ido-make-dir-list1 ido-current-directory)))
2777 (setq ido-temp-list (ido-sort-list ido-temp-list))
789d1bf0 2778 (ido-to-end ;; move . files to end
71296446 2779 (delq nil (mapcar
789d1bf0
KS
2780 (lambda (x) (if (string-equal (substring x 0 1) ".") x))
2781 ido-temp-list)))
2782 (if (and default (member default ido-temp-list))
2783 (if (or ido-rotate-temp ido-rotate-file-list-default)
2784 (unless (equal default (car ido-temp-list))
2785 (let ((l ido-temp-list) k)
2786 (while (and l (cdr l) (not (equal default (car (cdr l)))))
2787 (setq l (cdr l)))
2788 (setq k (cdr l))
2789 (setcdr l nil)
2790 (nconc k ido-temp-list)
2791 (setq ido-temp-list k)))
71296446 2792 (setq ido-temp-list
789d1bf0 2793 (delete default ido-temp-list))
71296446 2794 (setq ido-temp-list
789d1bf0
KS
2795 (cons default ido-temp-list))))
2796 (setq ido-temp-list (delete "." ido-temp-list))
2797 (setq ido-temp-list (cons "." ido-temp-list))
2798 (run-hooks 'ido-make-dir-list-hook)
2799 ido-temp-list))
2800
2801;; List of the files visible in the current frame.
2802(defvar ido-bufs-in-frame)
2803
2804(defun ido-get-buffers-in-frames (&optional current)
2805 ;; Return the list of buffers that are visible in the current frame.
2806 ;; If optional argument `current' is given, restrict searching to the
2807 ;; current frame, rather than all frames, regardless of value of
2808 ;; `ido-all-frames'.
2809 (let ((ido-bufs-in-frame nil))
2810 (walk-windows 'ido-get-bufname nil
71296446 2811 (if current
789d1bf0
KS
2812 nil
2813 ido-all-frames))
2814 ido-bufs-in-frame))
2815
2816(defun ido-get-bufname (win)
2817 ;; Used by `ido-get-buffers-in-frames' to walk through all windows
2818 (let ((buf (buffer-name (window-buffer win))))
69beb26d
KS
2819 (unless (or (member buf ido-bufs-in-frame)
2820 (member buf ido-ignore-item-temp-list))
2821 ;; Only add buf if it is not already in list.
2822 ;; This prevents same buf in two different windows being
2823 ;; put into the list twice.
2824 (setq ido-bufs-in-frame
2825 (cons buf ido-bufs-in-frame)))))
789d1bf0
KS
2826
2827;;; FIND MATCHING ITEMS
2828
2829(defun ido-set-matches1 (items &optional do-full)
2830 ;; Return list of matches in items
2831 (let* ((case-fold-search ido-case-fold)
bad111c2
KS
2832 (slash (and (not ido-enable-prefix) (ido-final-slash ido-text)))
2833 (text (if slash (substring ido-text 0 -1) ido-text))
2834 (rexq (concat (if ido-enable-regexp text (regexp-quote text)) (if slash ".*/" "")))
789d1bf0
KS
2835 (re (if ido-enable-prefix (concat "\\`" rexq) rexq))
2836 (full-re (and do-full (not ido-enable-regexp) (not (string-match "\$\\'" re))
2837 (concat "\\`" re "\\'")))
2838 (prefix-re (and full-re (not ido-enable-prefix)
2839 (concat "\\`" rexq)))
2840 full-matches
2841 prefix-matches
2842 matches)
2843 (mapcar
2844 (lambda (item)
2845 (let ((name (ido-name item)))
2846 (if (string-match re name)
2847 (cond
2848 ((and full-re (string-match full-re name))
2849 (setq full-matches (cons item full-matches)))
2850 ((and prefix-re (string-match prefix-re name))
2851 (setq prefix-matches (cons item prefix-matches)))
2852 (t (setq matches (cons item matches))))))
2853 t)
2854 items)
2855 (if prefix-matches
2856 (setq matches (nconc prefix-matches matches)))
2857 (if full-matches
2858 (setq matches (nconc full-matches matches)))
2859 (when (and (null matches)
2860 ido-enable-flex-matching
2861 (> (length ido-text) 1)
2862 (not ido-enable-regexp))
9066a4d0 2863 (setq re (mapconcat #'regexp-quote (split-string ido-text "") ".*"))
789d1bf0
KS
2864 (if ido-enable-prefix
2865 (setq re (concat "\\`" re)))
2866 (mapcar
2867 (lambda (item)
2868 (let ((name (ido-name item)))
2869 (if (string-match re name)
2870 (setq matches (cons item matches)))))
2871 items))
2872 matches))
71296446 2873
789d1bf0
KS
2874
2875(defun ido-set-matches ()
2876 ;; Set `ido-matches' to the list of items matching prompt
2877 (when ido-rescan
2878 (setq ido-matches (ido-set-matches1 (reverse ido-cur-list) (not ido-rotate))
2879 ido-rotate nil)))
71296446 2880
789d1bf0
KS
2881(defun ido-ignore-item-p (name re-list &optional ignore-ext)
2882 ;; Return t if the buffer or file NAME should be ignored.
69beb26d
KS
2883 (or (member name ido-ignore-item-temp-list)
2884 (and
2885 ido-process-ignore-lists re-list
789d1bf0
KS
2886 (let ((data (match-data))
2887 (ext-list (and ignore-ext ido-ignore-extensions
2888 completion-ignored-extensions))
71296446 2889 ignorep nextstr
789d1bf0
KS
2890 (flen (length name)) slen)
2891 (while ext-list
2892 (setq nextstr (car ext-list))
2893 (if (cond
2894 ((stringp nextstr)
2895 (and (>= flen (setq slen (length nextstr)))
2896 (string-equal (substring name (- flen slen)) nextstr)))
2897 ((fboundp nextstr) (funcall nextstr name))
2898 (t nil))
2899 (setq ignorep t
2900 ext-list nil
2901 re-list nil)
2902 (setq ext-list (cdr ext-list))))
2903 (while re-list
2904 (setq nextstr (car re-list))
2905 (if (cond
2906 ((stringp nextstr) (string-match nextstr name))
2907 ((fboundp nextstr) (funcall nextstr name))
2908 (t nil))
2909 (setq ignorep t
2910 re-list nil)
2911 (setq re-list (cdr re-list))))
2912 ;; return the result
2913 (if ignorep
2914 (setq ido-ignored-list (cons name ido-ignored-list)))
2915 (set-match-data data)
69beb26d 2916 ignorep))))
789d1bf0
KS
2917
2918
2919;; Private variable used by `ido-word-matching-substring'.
2920(defvar ido-change-word-sub)
2921
2922(defun ido-find-common-substring (items subs)
2923 ;; Return common string following SUBS in each element of ITEMS.
2924 (let (res
2925 alist
2926 ido-change-word-sub)
2927 (setq ido-change-word-sub
2928 (if ido-enable-regexp
2929 subs
2930 (regexp-quote subs)))
9066a4d0 2931 (setq res (mapcar #'ido-word-matching-substring items))
789d1bf0 2932 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
9066a4d0 2933 (setq alist (mapcar #'ido-makealist res)) ;; could use an OBARRAY
789d1bf0
KS
2934
2935 ;; try-completion returns t if there is an exact match.
9066a4d0
KS
2936 (let* ((completion-ignore-case ido-case-fold)
2937 (comp (try-completion subs alist)))
2938 (if (eq comp t)
2939 subs
2940 comp))))
789d1bf0
KS
2941
2942(defun ido-word-matching-substring (word)
2943 ;; Return part of WORD before 1st match to `ido-change-word-sub'.
2944 ;; If `ido-change-word-sub' cannot be found in WORD, return nil.
71296446 2945 (let ((case-fold-search ido-case-fold))
789d1bf0
KS
2946 (let ((m (string-match ido-change-word-sub (ido-name word))))
2947 (if m
2948 (substring (ido-name word) m)
2949 ;; else no match
2950 nil))))
2951
2952(defun ido-makealist (res)
2953 ;; Return dotted pair (RES . 1).
2954 (cons res 1))
2955
2956(defun ido-choose-completion-string (choice buffer mini-p base-size)
2957 (when (ido-active)
2958 ;; Insert the completion into the buffer where completion was requested.
2959 (if (get-buffer ido-completion-buffer)
2960 (kill-buffer ido-completion-buffer))
2961 (cond
2962 ((ido-active t) ;; ido-use-merged-list
2963 (setq ido-current-directory ""
2964 ido-text choice
2965 ido-exit 'done))
2966 ((not (ido-final-slash choice))
2967 (setq ido-text choice
2968 ido-exit 'done))
2969 (t
2970 (ido-set-current-directory ido-current-directory choice)
2971 (setq ido-exit 'refresh)))
2972 (exit-minibuffer)
2973 t))
2974
2975(defun ido-completion-help ()
2976 "Show possible completions in a *File Completions* buffer."
2977 (interactive)
2978 (setq ido-rescan nil)
2979 (let ((temp-buf (get-buffer ido-completion-buffer))
2980 display-it full-list)
2981 (if (and (eq last-command this-command) temp-buf)
2982 ;; scroll buffer
2983 (let (win (buf (current-buffer)))
2984 (display-buffer temp-buf nil nil)
2985 (set-buffer temp-buf)
2986 (setq win (get-buffer-window temp-buf))
2987 (if (pos-visible-in-window-p (point-max) win)
2988 (if (or ido-completion-buffer-all-completions (boundp 'ido-completion-buffer-full))
2989 (set-window-start win (point-min))
2990 (set (make-local-variable 'ido-completion-buffer-full) t)
2991 (setq full-list t
2992 display-it t))
2993 (scroll-other-window))
2994 (set-buffer buf))
2995 (setq display-it t))
2996 (if display-it
2997 (with-output-to-temp-buffer ido-completion-buffer
2998 (let ((completion-list (ido-sort-list
2999 (cond
3000 (ido-use-merged-list
3001 (ido-flatten-merged-list (or ido-matches ido-cur-list)))
3002 ((or full-list ido-completion-buffer-all-completions)
3003 (ido-all-completions))
3004 (t
3005 (copy-sequence (or ido-matches ido-cur-list)))))))
1518d6e3 3006 (if (featurep 'xemacs)
789d1bf0
KS
3007 ;; XEmacs extents are put on by default, doesn't seem to be
3008 ;; any way of switching them off.
0fe826e9 3009 ;; This obscure code avoids a byte compiler warning in Emacs.
6c1bc246
KS
3010 (let ((f 'display-completion-list))
3011 (funcall f completion-list
3012 :help-string "ido "
71296446 3013 :activate-callback
6c1bc246 3014 '(lambda (x y z) (message "doesn't work yet, sorry!"))))
789d1bf0
KS
3015 ;; else running Emacs
3016 ;;(add-hook 'completion-setup-hook 'completion-setup-function)
3017 (display-completion-list completion-list)))))))
3018
3019;;; KILL CURRENT BUFFER
3020(defun ido-kill-buffer-at-head ()
3021 "Kill the buffer at the head of `ido-matches'."
3022 (interactive)
3023 (let ((enable-recursive-minibuffers t)
3024 (buf (car ido-matches)))
3025 (when buf
3026 (kill-buffer buf)
3027 ;; Check if buffer still exists.
3028 (if (get-buffer buf)
3029 ;; buffer couldn't be killed.
71296446 3030 (setq ido-rescan t)
789d1bf0
KS
3031 ;; else buffer was killed so remove name from list.
3032 (setq ido-cur-list (delq buf ido-cur-list))))))
3033
3034;;; DELETE CURRENT FILE
3035(defun ido-delete-file-at-head ()
3036 "Delete the file at the head of `ido-matches'."
3037 (interactive)
3038 (let ((enable-recursive-minibuffers t)
3039 (file (car ido-matches)))
3040 (if file
3041 (setq file (concat ido-current-directory file)))
3042 (when (and file
3043 (file-exists-p file)
3044 (not (file-directory-p file))
3045 (file-writable-p ido-current-directory)
3046 (yes-or-no-p (concat "Delete " file " ")))
3047 (delete-file file)
3048 ;; Check if file still exists.
3049 (if (file-exists-p file)
3050 ;; file could not be deleted
71296446 3051 (setq ido-rescan t)
789d1bf0
KS
3052 ;; else file was killed so remove name from list.
3053 (setq ido-cur-list (delq (car ido-matches) ido-cur-list))))))
3054
3055
3056;;; VISIT CHOSEN BUFFER
3057(defun ido-visit-buffer (buffer method &optional record)
3058 "Visit file named FILE according to METHOD.
3059Record command in command-history if optional RECORD is non-nil."
3060
3061 (let (win newframe)
3062 (cond
3063 ((eq method 'kill)
3064 (if record
3065 (ido-record-command 'kill-buffer buffer))
3066 (kill-buffer buffer))
3067
3068 ((eq method 'samewindow)
3069 (if record
3070 (ido-record-command 'switch-to-buffer buffer))
3071 (switch-to-buffer buffer))
3072
3073 ((memq method '(always-frame maybe-frame))
3074 (cond
3075 ((and window-system
3076 (setq win (ido-window-buffer-p buffer))
3077 (or (eq method 'always-frame)
3078 (y-or-n-p "Jump to frame? ")))
3079 (setq newframe (window-frame win))
3080 (if (fboundp 'select-frame-set-input-focus)
3081 (select-frame-set-input-focus newframe)
3082 (raise-frame newframe)
3083 (select-frame newframe)
1518d6e3 3084 (unless (featurep 'xemacs)
789d1bf0
KS
3085 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
3086 (select-window win))
3087 (t
3088 ;; No buffer in other frames...
3089 (if record
3090 (ido-record-command 'switch-to-buffer buffer))
3091 (switch-to-buffer buffer)
3092 )))
3093
3094 ((eq method 'otherwindow)
3095 (if record
3096 (ido-record-command 'switch-to-buffer buffer))
3097 (switch-to-buffer-other-window buffer))
3098
3099 ((eq method 'display)
3100 (display-buffer buffer))
3101
3102 ((eq method 'otherframe)
1518d6e3
KS
3103 (switch-to-buffer-other-frame buffer)
3104 (unless (featurep 'xemacs)
3105 (select-frame-set-input-focus (selected-frame)))
3106 ))))
789d1bf0
KS
3107
3108
3109(defun ido-window-buffer-p (buffer)
3110 ;; Return window pointer if BUFFER is visible in another frame.
3111 ;; If BUFFER is visible in the current frame, return nil.
3112 (let ((blist (ido-get-buffers-in-frames 'current)))
3113 ;;If the buffer is visible in current frame, return nil
69beb26d 3114 (if (member buffer blist)
789d1bf0
KS
3115 nil
3116 ;; maybe in other frame or icon
3117 (get-buffer-window buffer 0) ; better than 'visible
3118 )))
3119
3120
3121;;; ----------- IDONIZED FUNCTIONS ------------
3122
3123;;;###autoload
3124(defun ido-switch-buffer ()
3125 "Switch to another buffer.
3126The buffer is displayed according to `ido-default-buffer-method' -- the
3127default is to show it in the same window, unless it is already visible
3128in another frame.
3129
3130As you type in a string, all of the buffers matching the string are
3131displayed if substring-matching is used \(default). Look at
3132`ido-enable-prefix' and `ido-toggle-prefix'. When you have found the
3133buffer you want, it can then be selected. As you type, most keys have their
3134normal keybindings, except for the following: \\<ido-mode-map>
3135
3136RET Select the buffer at the front of the list of matches. If the
3137list is empty, possibly prompt to create new buffer.
3138
3139\\[ido-select-text] Select the current prompt as the buffer.
3140If no buffer is found, prompt for a new one.
3141
3142\\[ido-next-match] Put the first element at the end of the list.
3143\\[ido-prev-match] Put the last element at the start of the list.
71296446 3144\\[ido-complete] Complete a common suffix to the current string that
789d1bf0
KS
3145matches all buffers. If there is only one match, select that buffer.
3146If there is no common suffix, show a list of all matching buffers
3147in a separate window.
3148\\[ido-edit-input] Edit input string.
3149\\[ido-fallback-command] Fallback to non-ido version of current command.
3150\\[ido-toggle-regexp] Toggle regexp searching.
3151\\[ido-toggle-prefix] Toggle between substring and prefix matching.
3152\\[ido-toggle-case] Toggle case-sensitive searching of buffer names.
3153\\[ido-completion-help] Show list of matching buffers in separate window.
3154\\[ido-enter-find-file] Drop into ido-find-file.
3155\\[ido-kill-buffer-at-head] Kill buffer at head of buffer list.
3156\\[ido-toggle-ignore] Toggle ignoring buffers listed in `ido-ignore-buffers'."
3157 (interactive)
3158 (ido-buffer-internal ido-default-buffer-method))
3159
3160;;;###autoload
3161(defun ido-switch-buffer-other-window ()
3162 "Switch to another buffer and show it in another window.
3163The buffer name is selected interactively by typing a substring.
3164For details of keybindings, do `\\[describe-function] ido'."
3165 (interactive)
3166 (ido-buffer-internal 'otherwindow 'switch-to-buffer-other-window))
3167
3168;;;###autoload
3169(defun ido-display-buffer ()
3170 "Display a buffer in another window but don't select it.
3171The buffer name is selected interactively by typing a substring.
3172For details of keybindings, do `\\[describe-function] ido'."
3173 (interactive)
3174 (ido-buffer-internal 'display 'display-buffer))
3175
3176;;;###autoload
3177(defun ido-kill-buffer ()
3178 "Kill a buffer.
3179The buffer name is selected interactively by typing a substring.
3180For details of keybindings, do `\\[describe-function] ido'."
3181 (interactive)
3182 (ido-buffer-internal 'kill 'kill-buffer "Kill buffer: " (buffer-name (current-buffer))))
3183
3184;;;###autoload
3185(defun ido-insert-buffer ()
3186 "Insert contents of a buffer in current buffer after point.
3187The buffer name is selected interactively by typing a substring.
3188For details of keybindings, do `\\[describe-function] ido'."
3189 (interactive)
3190 (ido-buffer-internal 'insert 'insert-buffer "Insert buffer: "))
3191
3192;;;###autoload
3193(defun ido-switch-buffer-other-frame ()
3194 "Switch to another buffer and show it in another frame.
3195The buffer name is selected interactively by typing a substring.
3196For details of keybindings, do `\\[describe-function] ido'."
3197 (interactive)
3198 (if ido-mode
3199 (ido-buffer-internal 'otherframe)
3200 (call-interactively 'switch-to-buffer-other-frame)))
3201
3202;;;###autoload
3203(defun ido-find-file-in-dir (dir)
3204 "Switch to another file starting from DIR."
3205 (interactive "DDir: ")
3206 (if (not (equal (substring dir -1) "/"))
3207 (setq dir (concat dir "/")))
3208 (ido-file-internal ido-default-file-method nil dir))
3209
3210;;;###autoload
3211(defun ido-find-file ()
3212 "Edit file with name obtained via minibuffer.
3213The file is displayed according to `ido-default-file-method' -- the
3214default is to show it in the same window, unless it is already
3215visible in another frame.
3216
3217The file name is selected interactively by typing a substring. As you type
3218in a string, all of the filenames matching the string are displayed if
3219substring-matching is used \(default). Look at `ido-enable-prefix' and
3220`ido-toggle-prefix'. When you have found the filename you want, it can
3221then be selected. As you type, most keys have their normal keybindings,
3222except for the following: \\<ido-mode-map>
3223
3224RET Select the file at the front of the list of matches. If the
3225list is empty, possibly prompt to create new file.
3226
3227\\[ido-select-text] Select the current prompt as the buffer or file.
3228If no buffer or file is found, prompt for a new one.
3229
3230\\[ido-next-match] Put the first element at the end of the list.
3231\\[ido-prev-match] Put the last element at the start of the list.
71296446 3232\\[ido-complete] Complete a common suffix to the current string that
789d1bf0
KS
3233matches all files. If there is only one match, select that file.
3234If there is no common suffix, show a list of all matching files
3235in a separate window.
362cdb61 3236\\[ido-edit-input] Edit input string (including directory).
789d1bf0
KS
3237\\[ido-prev-work-directory] or \\[ido-next-work-directory] go to previous/next directory in work directory history.
3238\\[ido-merge-work-directories] search for file in the work directory history.
3239\\[ido-forget-work-directory] removes current directory from the work directory history.
3240\\[ido-prev-work-file] or \\[ido-next-work-file] cycle through the work file history.
3241\\[ido-wide-find-file] and \\[ido-wide-find-dir] prompts and uses find to locate files or directories.
3242\\[ido-make-directory] prompts for a directory to create in current directory.
3243\\[ido-fallback-command] Fallback to non-ido version of current command.
3244\\[ido-toggle-regexp] Toggle regexp searching.
3245\\[ido-toggle-prefix] Toggle between substring and prefix matching.
3246\\[ido-toggle-case] Toggle case-sensitive searching of file names.
3247\\[ido-toggle-vc] Toggle version control for this file.
3248\\[ido-toggle-literal] Toggle literal reading of this file.
3249\\[ido-completion-help] Show list of matching files in separate window.
3250\\[ido-toggle-ignore] Toggle ignoring files listed in `ido-ignore-files'."
3251
3252 (interactive)
3253 (ido-file-internal ido-default-file-method))
3254
3255;;;###autoload
3256(defun ido-find-file-other-window ()
3257 "Switch to another file and show it in another window.
3258The file name is selected interactively by typing a substring.
3259For details of keybindings, do `\\[describe-function] ido-find-file'."
3260 (interactive)
3261 (ido-file-internal 'otherwindow 'find-file-other-window))
3262
3263;;;###autoload
3264(defun ido-find-alternate-file ()
3265 "Switch to another file and show it in another window.
3266The file name is selected interactively by typing a substring.
3267For details of keybindings, do `\\[describe-function] ido-find-file'."
3268 (interactive)
3269 (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
3270
3271;;;###autoload
3272(defun ido-find-file-read-only ()
3273 "Edit file read-only with name obtained via minibuffer.
3274The file name is selected interactively by typing a substring.
3275For details of keybindings, do `\\[describe-function] ido-find-file'."
3276 (interactive)
3277 (ido-file-internal 'read-only 'find-file-read-only nil "Find file read-only: "))
3278
3279;;;###autoload
3280(defun ido-find-file-read-only-other-window ()
3281 "Edit file read-only in other window with name obtained via minibuffer.
3282The file name is selected interactively by typing a substring.
3283For details of keybindings, do `\\[describe-function] ido-find-file'."
3284 (interactive)
3285 (ido-file-internal 'read-only 'find-file-read-only-other-window nil "Find file read-only other window: "))
3286
3287;;;###autoload
3288(defun ido-find-file-read-only-other-frame ()
3289 "Edit file read-only in other frame with name obtained via minibuffer.
3290The file name is selected interactively by typing a substring.
3291For details of keybindings, do `\\[describe-function] ido-find-file'."
3292 (interactive)
3293 (ido-file-internal 'read-only 'find-file-read-only-other-frame nil "Find file read-only other frame: "))
3294
3295;;;###autoload
3296(defun ido-display-file ()
3297 "Display a file in another window but don't select it.
3298The file name is selected interactively by typing a substring.
3299For details of keybindings, do `\\[describe-function] ido-find-file'."
3300 (interactive)
3301 (ido-file-internal 'display))
3302
3303;;;###autoload
3304(defun ido-find-file-other-frame ()
3305 "Switch to another file and show it in another frame.
3306The file name is selected interactively by typing a substring.
3307For details of keybindings, do `\\[describe-function] ido-find-file'."
3308 (interactive)
3309 (ido-file-internal 'otherframe 'find-file-other-frame))
3310
3311;;;###autoload
3312(defun ido-write-file ()
3313 "Write current buffer to a file.
3314The file name is selected interactively by typing a substring.
3315For details of keybindings, do `\\[describe-function] ido-find-file'."
3316 (interactive)
3317 (let ((ido-process-ignore-lists t)
3318 (ido-work-directory-match-only nil)
3319 (ido-ignore-files (cons "[^/]\\'" ido-ignore-files))
3320 (ido-report-no-match nil)
3321 (ido-auto-merge-work-directories-length -1))
3322 (ido-file-internal 'write 'write-file nil "Write file: ")))
3323
3324;;;###autoload
3325(defun ido-insert-file ()
3326 "Insert contents of file in current buffer.
3327The file name is selected interactively by typing a substring.
3328For details of keybindings, do `\\[describe-function] ido-find-file'."
3329 (interactive)
3330 (ido-file-internal 'insert 'insert-file nil "Insert file: "))
3331
3332;;;###autoload
3333(defun ido-dired ()
3334 "Call dired the ido way.
3335The directory is selected interactively by typing a substring.
3336For details of keybindings, do `\\[describe-function] ido-find-file'."
3337 (interactive)
3338 (let ((ido-report-no-match nil)
3339 (ido-auto-merge-work-directories-length -1))
3340 (ido-file-internal 'dired 'dired nil "Dired: " 'dir)))
3341
3342(defun ido-list-directory ()
3343 "Call list-directory the ido way.
3344The directory is selected interactively by typing a substring.
3345For details of keybindings, do `\\[describe-function] ido-find-file'."
3346 (interactive)
3347 (let ((ido-report-no-match nil)
3348 (ido-auto-merge-work-directories-length -1))
3349 (ido-file-internal 'list-directory 'list-directory nil "List directory: " 'dir)))
3350
3351;;; XEmacs hack for showing default buffer
3352
3353;; The first time we enter the minibuffer, Emacs puts up the default
3354;; buffer to switch to, but XEmacs doesn't -- presumably there is a
3355;; subtle difference in the two versions of post-command-hook. The
3356;; default is shown for both whenever we delete all of our text
3357;; though, indicating its just a problem the first time we enter the
3358;; function. To solve this, we use another entry hook for emacs to
3359;; show the default the first time we enter the minibuffer.
3360
3361
3362;;; ICOMPLETE TYPE CODE
3363
3364(defun ido-initiate-auto-merge (buffer)
3365 (ido-trace "\n*merge timeout*" buffer)
3366 (setq ido-auto-merge-timer nil)
3367 (when (and (buffer-live-p buffer)
3368 (= ido-use-mycompletion-depth (minibuffer-depth))
3369 (boundp 'ido-eoinput) ido-eoinput)
3370 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) ido-eoinput)))
3371 (ido-trace "request merge")
3372 (setq ido-use-merged-list 'auto
3373 ido-text-init contents
3374 ido-rotate-temp t
3375 ido-exit 'refresh)
3376 (save-excursion
3377 (set-buffer buffer)
3378 (ido-tidy))
3379 (throw 'ido contents))))
3380
3381(defun ido-exhibit ()
3382 "Post command hook for `ido'."
3383 ;; Find matching files and display a list in the minibuffer.
3384 ;; Copied from `icomplete-exhibit' with two changes:
3385 ;; 1. It prints a default file name when there is no text yet entered.
3386 ;; 2. It calls my completion routine rather than the standard completion.
3387
bad111c2
KS
3388 (when (= ido-use-mycompletion-depth (minibuffer-depth))
3389 (let ((contents (buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
3390 (buffer-undo-list t)
3391 try-single-dir-match
3392 refresh)
789d1bf0 3393
bad111c2
KS
3394 (ido-trace "\nexhibit" this-command)
3395 (ido-trace "dir" ido-current-directory)
3396 (ido-trace "contents" contents)
3397 (ido-trace "list" ido-cur-list)
3398 (ido-trace "matches" ido-matches)
3399 (ido-trace "rescan" ido-rescan)
789d1bf0 3400
bad111c2
KS
3401 (save-excursion
3402 (goto-char (point-max))
3403 ;; Register the end of input, so we know where the extra stuff (match-status info) begins:
3404 (unless (boundp 'ido-eoinput)
3405 ;; In case it got wiped out by major mode business:
3406 (make-local-variable 'ido-eoinput))
3407 (setq ido-eoinput (point))
3408
3409 ;; Handle explicit directory changes
3410 (cond
3411 ((eq ido-cur-item 'buffer)
3412 )
3413
3414 ((= (length contents) 0)
3415 )
3416
3417 ((= (length contents) 1)
3418 (when (and (ido-is-tramp-root) (string-equal contents "/"))
3419 (ido-set-current-directory ido-current-directory contents)
3420 (setq refresh t))
3421 )
3422
3423 ((and (string-match (if ido-enable-tramp-completion "..[:@]\\'" "..:\\'") contents)
3424 (ido-is-root-directory)) ;; Ange-ftp or tramp
3425 (ido-set-current-directory ido-current-directory contents)
3426 (when (ido-is-slow-ftp-host)
3427 (setq ido-exit 'fallback)
3428 (exit-minibuffer))
3429 (setq refresh t))
3430
3431 ((ido-final-slash contents) ;; xxx/
3432 (ido-trace "final slash" contents)
71296446 3433 (cond
bad111c2
KS
3434 ((string-equal contents "~/")
3435 (ido-set-current-home)
3436 (setq refresh t))
3437 ((string-equal contents "../")
3438 (ido-up-directory t)
3439 (setq refresh t))
3440 ((string-equal contents "./")
3441 (setq refresh t))
3442 ((string-match "\\`~[a-zA-Z0-9]+/\\'" contents)
3443 (ido-trace "new home" contents)
3444 (ido-set-current-home contents)
3445 (setq refresh t))
3446 ((string-match "[$][A-Za-z0-9_]+/\\'" contents)
3447 (let ((exp (condition-case ()
3448 (expand-file-name
3449 (substitute-in-file-name (substring contents 0 -1))
3450 ido-current-directory)
3451 (error nil))))
3452 (ido-trace contents exp)
3453 (when (and exp (file-directory-p exp))
3454 (ido-set-current-directory (file-name-directory exp))
3455 (setq ido-text-init (file-name-nondirectory exp))
3456 (setq refresh t))))
3457 ((and (memq system-type '(windows-nt ms-dos))
3458 (string-equal (substring contents 1) ":/"))
3459 (ido-set-current-directory (file-name-directory contents))
3460 (setq refresh t))
3461 ((string-equal (substring contents -2 -1) "/")
71296446 3462 (ido-set-current-directory
bad111c2
KS
3463 (if (memq system-type '(windows-nt ms-dos))
3464 (expand-file-name "/" ido-current-directory)
3465 "/"))
3466 (setq refresh t))
3467 (t
3468 (ido-trace "try single dir")
3469 (setq try-single-dir-match t))))
3470
3471 ((and (string-equal (substring contents -2 -1) "/")
3472 (not (string-match "[$]" contents)))
3473 (ido-set-current-directory
3474 (cond
3475 ((= (length contents) 2)
3476 "/")
3477 (ido-matches
789d1bf0 3478 (concat ido-current-directory (car ido-matches)))
bad111c2
KS
3479 (t
3480 (concat ido-current-directory (substring contents 0 -1)))))
3481 (setq ido-text-init (substring contents -1))
3482 (setq refresh t))
3483
3484 ((and (not ido-use-merged-list)
3485 (not (ido-final-slash contents))
3486 (eq ido-try-merged-list t)
3487 (numberp ido-auto-merge-work-directories-length)
3488 (> ido-auto-merge-work-directories-length 0)
3489 (= (length contents) ido-auto-merge-work-directories-length)
3490 (not (and ido-auto-merge-inhibit-characters-regexp
3491 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3492 (not (input-pending-p)))
3493 (setq ido-use-merged-list 'auto
3494 ido-text-init contents
3495 ido-rotate-temp t)
3496 (setq refresh t))
3497
3498 (t nil))
3499
3500 (when refresh
3501 (ido-trace "refresh on /" ido-text-init)
3502 (setq ido-exit 'refresh)
3503 (exit-minibuffer))
789d1bf0 3504
bad111c2
KS
3505 ;; Update the list of matches
3506 (setq ido-text contents)
3507 (ido-set-matches)
3508 (ido-trace "new " ido-matches)
3509
3510 (when (and ido-enter-single-matching-directory
3511 ido-matches
3512 (null (cdr ido-matches))
3513 (ido-final-slash (car ido-matches))
3514 (or try-single-dir-match
3515 (eq ido-enter-single-matching-directory t)))
3516 (ido-trace "single match" (car ido-matches))
71296446 3517 (ido-set-current-directory
bad111c2
KS
3518 (concat ido-current-directory (car ido-matches)))
3519 (setq ido-exit 'refresh)
3520 (exit-minibuffer))
3521
3522 (when (and (not ido-matches)
3523 ;; ido-rescan ?
789d1bf0
KS
3524 ido-process-ignore-lists
3525 ido-ignored-list)
bad111c2
KS
3526 (let ((ido-process-ignore-lists nil)
3527 (ido-rotate ido-rotate)
3528 (ido-cur-list ido-ignored-list))
3529 (ido-trace "try all" ido-ignored-list)
3530 (ido-set-matches))
3531 (when ido-matches
3532 (ido-trace "found " ido-matches)
3533 (setq ido-rescan t)
3534 (setq ido-process-ignore-lists-inhibit t)
3535 (setq ido-text-init ido-text)
3536 (setq ido-exit 'refresh)
3537 (exit-minibuffer)))
3538
3539 (when (and
3540 ido-rescan
3541 (not ido-matches)
3542 (memq ido-cur-item '(file dir))
3543 (not (ido-is-root-directory))
3544 (> (length contents) 1)
3545 (not (string-match "[$]" contents)))
3546 (ido-trace "merge?")
3547 (if ido-use-merged-list
3548 (ido-undo-merge-work-directory contents nil)
3549 (when (and (eq ido-try-merged-list t)
3550 (numberp ido-auto-merge-work-directories-length)
3551 (= ido-auto-merge-work-directories-length 0)
3552 (not (and ido-auto-merge-inhibit-characters-regexp
3553 (string-match ido-auto-merge-inhibit-characters-regexp contents)))
3554 (not (input-pending-p)))
3555 (ido-trace "\n*start timer*")
3556 (setq ido-auto-merge-timer
3557 (run-with-timer ido-auto-merge-delay-time nil 'ido-initiate-auto-merge (current-buffer))))))
71296446 3558
bad111c2 3559 (setq ido-rescan t)
789d1bf0 3560
71296446 3561 (if (and ido-use-merged-list
bad111c2
KS
3562 ido-matches
3563 (not (string-equal (car (cdr (car ido-matches))) ido-current-directory)))
3564 (progn
3565 (ido-set-current-directory (car (cdr (car ido-matches))))
3566 (setq ido-use-merged-list t
3567 ido-exit 'keep
3568 ido-text-init ido-text)
3569 (exit-minibuffer)))
3570
3571 ;; Insert the match-status information:
3572 (ido-set-common-completion)
71296446 3573 (let ((inf (ido-completions
bad111c2
KS
3574 contents
3575 minibuffer-completion-table
3576 minibuffer-completion-predicate
3577 (not minibuffer-completion-confirm))))
3578 (ido-trace "inf" inf)
3579 (insert inf))
3580 ))))
789d1bf0
KS
3581
3582(defun ido-completions (name candidates predicate require-match)
3583 ;; Return the string that is displayed after the user's text.
3584 ;; Modified from `icomplete-completions'.
71296446 3585
789d1bf0
KS
3586 (let* ((comps ido-matches)
3587 (ind (and (consp (car comps)) (> (length (cdr (car comps))) 1)
3588 ido-merged-indicator))
3589 first)
3590
3591 (if (and ind ido-use-faces)
3592 (put-text-property 0 1 'face 'ido-indicator-face ind))
71296446 3593
789d1bf0
KS
3594 (if (and ido-use-faces comps)
3595 (let* ((fn (ido-name (car comps)))
3596 (ln (length fn)))
3597 (setq first (format "%s" fn))
3598 (put-text-property 0 ln 'face
3599 (if (= (length comps) 1)
3600 'ido-only-match-face
3601 'ido-first-match-face)
3602 first)
3603 (if ind (setq first (concat first ind)))
3604 (setq comps (cons first (cdr comps)))))
3605
3606 (cond ((null comps)
3607 (if ido-report-no-match
3608 (nth 6 ido-decorations) ;; [No Match]
3609 ""))
3610
3611 ((null (cdr comps)) ;one match
3612 (concat (if (> (length (ido-name (car comps))) (length name))
3613 ;; when there is one match, show the matching file name in full
3614 (concat (nth 4 ido-decorations) ;; [ ... ]
3615 (ido-name (car comps))
3616 (nth 5 ido-decorations))
3617 "")
3618 (if (not ido-use-faces) (nth 7 ido-decorations)))) ;; [Matched]
3619 (t ;multiple matches
3620 (let* ((items (if (> ido-max-prospects 0) (1+ ido-max-prospects) 999))
3621 (alternatives
3622 (apply
71296446 3623 #'concat
789d1bf0 3624 (cdr (apply
9066a4d0
KS
3625 #'nconc
3626 (mapcar
3627 (lambda (com)
3628 (setq com (ido-name com))
3629 (setq items (1- items))
3630 (cond
3631 ((< items 0) ())
3632 ((= items 0) (list (nth 3 ido-decorations))) ; " | ..."
3633 (t
3634 (list (or ido-separator (nth 2 ido-decorations)) ; " | "
3635 (let ((str (substring com 0)))
3636 (if (and ido-use-faces
3637 (not (string= str first))
3638 (ido-final-slash str))
3639 (put-text-property 0 (length str) 'face 'ido-subdir-face str))
3640 str)))))
3641 comps))))))
789d1bf0
KS
3642
3643 (concat
3644 ;; put in common completion item -- what you get by pressing tab
9066a4d0
KS
3645 (if (and (stringp ido-common-match-string)
3646 (> (length ido-common-match-string) (length name)))
789d1bf0
KS
3647 (concat (nth 4 ido-decorations) ;; [ ... ]
3648 (substring ido-common-match-string (length name))
3649 (nth 5 ido-decorations)))
3650 ;; list all alternatives
3651 (nth 0 ido-decorations) ;; { ... }
3652 alternatives
3653 (nth 1 ido-decorations)))))))
3654
3655(defun ido-minibuffer-setup ()
3656 "Minibuffer setup hook for `ido'."
3657 ;; Copied from `icomplete-minibuffer-setup-hook'.
71296446 3658 (when (and (boundp 'ido-completing-read)
1518d6e3
KS
3659 (or (featurep 'xemacs)
3660 (= ido-use-mycompletion-depth (minibuffer-depth))))
789d1bf0
KS
3661 (add-hook 'pre-command-hook 'ido-tidy nil t)
3662 (add-hook 'post-command-hook 'ido-exhibit nil t)
3663 (setq cua-inhibit-cua-keys t)
1518d6e3 3664 (when (featurep 'xemacs)
789d1bf0
KS
3665 (ido-exhibit)
3666 (goto-char (point-min)))
3667 (run-hooks 'ido-minibuffer-setup-hook)))
3668
3669(defun ido-tidy ()
3670 "Pre command hook for `ido'."
3671 ;; Remove completions display, if any, prior to new user input.
3672 ;; Copied from `icomplete-tidy'."
3673
3674 (when ido-auto-merge-timer
3675 (ido-trace "\n*cancel timer*" this-command)
3676 (cancel-timer ido-auto-merge-timer)
3677 (setq ido-auto-merge-timer nil))
3678
3679 (if (and (boundp 'ido-use-mycompletion-depth)
3680 (= ido-use-mycompletion-depth (minibuffer-depth)))
3681 (if (and (boundp 'ido-eoinput)
3682 ido-eoinput)
71296446 3683
789d1bf0
KS
3684 (if (> ido-eoinput (point-max))
3685 ;; Oops, got rug pulled out from under us - reinit:
3686 (setq ido-eoinput (point-max))
3687 (let ((buffer-undo-list t))
3688 (delete-region ido-eoinput (point-max))))
71296446 3689
789d1bf0
KS
3690 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
3691 (make-local-variable 'ido-eoinput)
3692 (setq ido-eoinput 1))))
3693
3694(defun ido-summary-buffers-to-end ()
3695 ;; Move the summaries to the end of the buffer list.
3696 ;; This is an example function which can be hooked on to
3697 ;; `ido-make-buffer-list-hook'. Any buffer matching the regexps
3698 ;; `Summary' or `output\*$'are put to the end of the list.
71296446
JB
3699 (let ((summaries (delq nil (mapcar
3700 (lambda (x)
3701 (if (or
789d1bf0
KS
3702 (string-match "Summary" x)
3703 (string-match "output\\*\\'" x))
3704 x))
3705 ido-temp-list))))
3706 (ido-to-end summaries)))
3707
3708;;; Helper functions for other programs
3709
3710;;;###autoload
3711(defun ido-read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
3712 "Read file name, prompting with PROMPT and completing in directory DIR.
3713See `read-file-name' for additional parameters."
789d1bf0
KS
3714 (cond
3715 ((or (eq predicate 'file-directory-p)
3716 (memq this-command ido-read-file-name-as-directory-commands))
3717 (ido-read-directory-name prompt dir default-filename mustmatch initial))
3718 ((and (not (memq this-command ido-read-file-name-non-ido))
3719 (or (null predicate) (eq predicate 'file-exists-p)))
789d1bf0
KS
3720 (let (filename
3721 ido-saved-vc-mt
3722 (vc-master-templates (and (boundp 'vc-master-templates) vc-master-templates))
3723 (ido-current-directory (expand-file-name (or dir default-directory)))
3724 (ido-work-directory-index -1)
3725 (ido-work-file-index -1)
3726 (ido-find-literal nil))
3727 (setq filename
3728 (ido-read-internal 'file prompt 'ido-file-history default-filename mustmatch initial))
3729 (if filename
3730 (concat ido-current-directory filename))))
3731 (t
3732 (let ((read-file-name-function nil))
3733 (read-file-name prompt dir default-filename mustmatch initial predicate)))))
3734
3735;;;###autoload
3736(defun ido-read-directory-name (prompt &optional dir default-dirname mustmatch initial)
3737 "Read directory name, prompting with PROMPT and completing in directory DIR.
3738See `read-file-name' for additional parameters."
3739 (let (filename
3740 ido-saved-vc-mt
3741 (ido-current-directory (expand-file-name (or dir default-directory)))
3742 (ido-work-directory-index -1)
3743 (ido-work-file-index -1))
3744 (setq filename
3745 (ido-read-internal 'dir prompt 'ido-file-history default-dirname mustmatch initial))
3746 (if filename
3747 (if (and (stringp filename) (string-equal filename "."))
3748 ido-current-directory
3749 (concat ido-current-directory filename)))))
3750
3751;;; ido.el ends here