1 ;; recentf.el --- setup a menu of recently opened files
3 ;; Copyright (C) 1999, 2000 Free Software Foundation, Inc.
5 ;; Author: David Ponce <david@dponce.com>
6 ;; Created: July 19 1999
7 ;; Keywords: customization
9 ;; This file is part of GNU Emacs.
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)
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.
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.
28 ;; This package maintains a menu for visiting files that were operated
29 ;; on recently. When enabled a new "Open Recent" submenu is displayed
30 ;; in the "Files" menu. The recent files list is automatically saved
31 ;; across Emacs sessions. You can customize the number of recent
32 ;; files displayed, the location of the menu and others options (see
33 ;; the source code for details). To install and use, put the file on
34 ;; your Emacs-Lisp load path and add the following into your ~/.emacs
45 (defconst recentf-save-file-header
46 ";;; Automatically generated by `recentf' on %s.\n"
47 "Header to be written into the `recentf-save-file'.")
49 (defvar recentf-list nil
50 "List of recently opened files.")
52 (defvar recentf-update-menu-p t
53 "Non-nil if the recentf menu must be updated.")
55 (defvar recentf-initialized-p nil
56 "Non-nil if recentf already initialized.")
58 ;; IMPORTANT: This function must be defined before the following defcustoms
59 ;; because it is used in their :set clause. To avoid byte-compiler warnings
60 ;; the `symbol-value' function is used to access the `recentf-menu-path'
61 ;; and `recentf-menu-title' values.
62 (defun recentf-menu-customization-changed (sym val
)
63 "Function called when menu customization has changed.
64 It removes the recentf menu and forces its complete redrawing."
65 (when recentf-initialized-p
66 (easy-menu-remove-item nil
67 (symbol-value 'recentf-menu-path
)
68 (symbol-value 'recentf-menu-title
))
69 (setq recentf-update-menu-p t
))
70 (custom-set-default sym val
))
73 "Maintain a menu of recently opened files."
77 (defgroup recentf-filters nil
78 "Group to customize recentf menu filters.
79 You should define the options of your own filters in this group."
82 (defcustom recentf-max-saved-items
20
83 "*Maximum number of items saved to `recentf-save-file'."
87 (defcustom recentf-save-file
(expand-file-name "~/.recentf")
88 "*File to save `recentf-list' into."
92 (defcustom recentf-exclude nil
93 "*List of regexps for filenames excluded from `recentf-list'."
95 :type
'(repeat regexp
))
97 (defcustom recentf-menu-title
"Open Recent"
98 "*Name of the recentf menu."
101 :set
'recentf-menu-customization-changed
)
103 (defcustom recentf-menu-path
'("files")
104 "*Path where to add the recentf menu.
105 If nil add it at top level (see also `easy-menu-change')."
107 :type
'(choice (const :tag
"Top Level" nil
)
108 (sexp :tag
"Menu Path"))
109 :set
'recentf-menu-customization-changed
)
111 (defcustom recentf-menu-before
"open-file"
112 "*Name of the menu before which the recentf menu will be added.
113 If nil add it at end of menu (see also `easy-menu-change')."
115 :type
'(choice (string :tag
"Name")
116 (const :tag
"Last" nil
))
117 :set
'recentf-menu-customization-changed
)
119 (defcustom recentf-menu-action
'recentf-find-file
120 "*Function to invoke with a filename item of the recentf menu.
121 The default action `recentf-find-file' calls `find-file' to edit an
122 existing file. If the file does not exist or is not readable, it is
123 not edited and its name is removed from `recentf-list'. You can use
124 `find-file' instead to open non-existing files and keep them in the
125 list of recently opened files."
128 :set
'recentf-menu-customization-changed
)
130 (defcustom recentf-max-menu-items
10
131 "*Maximum number of items in the recentf menu."
134 :set
'recentf-menu-customization-changed
)
136 (defcustom recentf-menu-filter nil
137 "*Function used to filter files displayed in the recentf menu.
138 Nil means no filter. The following functions are predefined:
140 - - `recentf-sort-ascending' to sort menu items in ascending order.
141 - - `recentf-sort-descending' to sort menu items in descending order.
142 - - `recentf-sort-basenames-ascending' to sort file names in descending order.
143 - - `recentf-sort-basenames-descending' to sort file names in descending order.
144 - - `recentf-sort-directories-ascending' to sort directories in ascending order.
145 - - `recentf-sort-directories-descending' to sort directories in descending order.
146 - - `recentf-show-basenames' to show file names (no directories) in menu items.
147 - - `recentf-show-basenames-ascending' to show file names in ascending order.
148 - - `recentf-show-basenames-descending' to show file names in descending order.
149 - - `recentf-relative-filter' to show file names relative to `default-directory'.
150 - - `recentf-arrange-by-rule' to show sub-menus following user defined rules.
151 - - `recentf-arrange-by-mode' to show a sub-menu for each major mode.
152 - - `recentf-arrange-by-dir' to show a sub-menu for each directory.
153 - - `recentf-filter-changer' to manage a ring of filters.
155 The filter function is called with one argument, the list of menu elements
156 used to build the menu and must return a new list of menu elements (see
157 `recentf-make-menu-element' for menu element form)."
160 :set
'recentf-menu-customization-changed
)
162 (defcustom recentf-menu-append-commands-p t
163 "*If not-nil command items are appended to the menu."
166 :set
'recentf-menu-customization-changed
)
168 (defcustom recentf-keep-non-readable-files-p nil
169 "*If nil (default), non-readable files are not kept in `recentf-list'."
173 :initialize
'custom-initialize-default
174 :set
(lambda (sym val
)
176 (remove-hook 'kill-buffer-hook
'recentf-remove-file-hook
)
177 (add-hook 'kill-buffer-hook
'recentf-remove-file-hook
))
178 (custom-set-default sym val
)))
180 (defcustom recentf-mode nil
181 "Toggle recentf mode.
182 When recentf mode is enabled, it maintains a menu for visiting files that
183 were operated on recently.
184 Setting this variable directly does not take effect;
185 use either \\[customize] or the function `recentf-mode'."
186 :set
(lambda (symbol value
)
187 (recentf-mode (or value
0)))
188 :initialize
'custom-initialize-default
193 (defcustom recentf-load-hook nil
194 "*Normal hook run at end of loading the `recentf' package."
199 ;;;; Common functions
201 (defconst recentf-case-fold-search
202 (memq system-type
'(vax-vms windows-nt
))
203 "Non-nil if recentf searches and matches should ignore case.")
205 (defun recentf-include-p (filename)
206 "Return t if FILENAME match none of the `recentf-exclude' regexps."
207 (let ((case-fold-search recentf-case-fold-search
)
208 (rl recentf-exclude
))
209 (while (and rl
(not (string-match (car rl
) filename
)))
213 (defun recentf-add-file (filename)
214 "Add or move FILENAME at the beginning of `recentf-list'.
215 Does nothing if FILENAME matches one of the `recentf-exclude' regexps."
216 (let ((filename (expand-file-name filename
)))
217 (when (recentf-include-p filename
)
218 (setq recentf-list
(cons filename
(delete filename recentf-list
)))
219 (setq recentf-update-menu-p t
))))
221 (defun recentf-remove-if-non-readable (filename)
222 "Remove FILENAME from `recentf-list' if not readable."
223 (unless (file-readable-p filename
)
224 (setq recentf-list
(delete filename recentf-list
))
225 (setq recentf-update-menu-p t
)))
227 (defun recentf-find-file (filename)
228 "Edit file FILENAME using `find-file'.
229 If FILENAME is not readable it is removed from `recentf-list'."
230 (if (file-readable-p filename
)
233 (message "File `%s' not found." filename
)
234 (setq recentf-list
(delete filename recentf-list
))
235 (setq recentf-update-menu-p t
))))
237 (defun recentf-trunc-list (l n
)
238 "Return a list of the first N elements of L."
240 (while (and l
(> n
0))
241 (setq lh
(cons (car l
) lh
))
246 (defun recentf-elements (n)
247 "Return a list of the first N elements of `recentf-list'."
248 (recentf-trunc-list recentf-list n
))
250 (defun recentf-make-menu-element (menu-item menu-value
)
251 "Create a new menu-element.
253 A menu element is a pair (MENU-ITEM . MENU-VALUE) where:
255 - - MENU-ITEM is the menu item string displayed.
256 - - MENU-VALUE is the path used to open the file when the
257 corresponding MENU-ITEM is selected. Or it is
258 a pair (SUB-MENU-TITLE . MENU-ELEMENTS) where
259 SUB-MENU-TITLE is a sub-menu title and
260 MENU-ELEMENTS is the list of menu elements in
262 (cons menu-item menu-value
))
264 (defun recentf-menu-element-item (e)
265 "Return the item part of the menu-element E."
268 (defun recentf-menu-element-value (e)
269 "Return the value part of the menu-element E."
272 (defun recentf-set-menu-element-item (e item
)
273 "Change the item part of menu-element E to ITEM."
276 (defun recentf-set-menu-element-value (e value
)
277 "Change the value part of menu-element E to VALUE."
280 (defun recentf-sub-menu-element-p (e)
281 "Return non-nil if menu-element E defines a sub-menu."
282 (consp (recentf-menu-element-value e
)))
284 (defun recentf-make-default-menu-element (file-path)
285 "Make a new default menu element (MENU-ITEM . MENU-VALUE).
286 Do so for the given recent file path FILE-PATH. MENU-ITEM and
287 MENU-VALUE are set to FILE-PATH. See also
288 `recentf-make-menu-element'."
289 (recentf-make-menu-element file-path file-path
))
291 (defun recentf-menu-elements (n)
292 "Return a list of the first N default menu elements from `recentf-list'.
293 See also `recentf-make-default-menu-element'."
294 (mapcar 'recentf-make-default-menu-element
295 (recentf-elements n
)))
297 (defun recentf-apply-menu-filter (filter l
)
298 "Apply function FILTER to the list of menu-elements L.
299 It takes care of sub-menu elements in L and recursively apply FILTER
300 to them. It is guaranteed that FILTER receives only a list of single
301 menu-elements (no sub-menu)."
302 (if (and (functionp filter
) l
)
303 (let ((case-fold-search recentf-case-fold-search
)
304 menu-element sub-menu-elements single-elements
)
305 ;; split L in two sub-listes:
306 ;; one of sub-menus elements and
307 ;; one of single menu elements
309 (setq menu-element
(car l
))
310 (if (recentf-sub-menu-element-p menu-element
)
311 (setq sub-menu-elements
312 (cons menu-element sub-menu-elements
))
313 (setq single-elements
314 (cons menu-element single-elements
)))
316 ;; apply FILTER to the list of single menu elements
318 (setq single-elements
(funcall filter
319 (nreverse single-elements
))))
320 ;; apply FILTER to sub-menu menu element list
321 (setq l sub-menu-elements
)
322 (setq sub-menu-elements nil
)
324 (setq menu-element
(car l
))
325 (recentf-set-menu-element-value
327 (recentf-apply-menu-filter
329 (recentf-menu-element-value menu-element
)))
330 (setq sub-menu-elements
(cons menu-element sub-menu-elements
))
332 ;; build and return the new filtered menu element list
333 (nconc sub-menu-elements single-elements
))
336 (defvar recentf-menu-items-for-commands
337 (list ["Cleanup list" recentf-cleanup t
]
338 ["Edit list..." recentf-edit-list t
]
339 ["Save list now" recentf-save-list t
]
340 (vector "Recentf Options..." '(customize-group "recentf") t
))
341 "List of menu items for recentf commands.")
343 (defvar recentf-menu-filter-commands nil
344 "This variable can be used by menu filters to setup their own command menu.
346 If non-nil it must contain a list of valid menu-items to be appended
347 to the recent file list part of the menu. Before calling a menu
348 filter function this variable is reset to nil.")
350 (defun recentf-make-menu-items ()
351 "Make menu items from `recentf-list'."
352 (setq recentf-menu-filter-commands nil
)
354 (mapcar 'recentf-make-menu-item
355 (recentf-apply-menu-filter
357 (recentf-menu-elements recentf-max-menu-items
)))))
358 (append (or file-items
(list ["No files" t nil
]))
359 (and (< recentf-max-menu-items
(length recentf-list
))
360 (list ["More..." recentf-open-more-files t
]))
361 (and recentf-menu-filter-commands
363 recentf-menu-filter-commands
))
364 (and recentf-menu-append-commands-p
366 recentf-menu-items-for-commands
)))))
368 (defun recentf-make-menu-item (menu-element)
369 "Make a menu item from MENU-ELEMENT (see `recentf-make-menu-element')."
370 (let ((menu-item (recentf-menu-element-item menu-element
))
371 (menu-value (recentf-menu-element-value menu-element
)))
372 (if (recentf-sub-menu-element-p menu-element
)
373 (cons menu-item
(mapcar 'recentf-make-menu-item menu-value
))
375 (list recentf-menu-action menu-value
)
379 ;;;; Predefined menu filter functions
382 (defun recentf-sort-ascending (l)
383 "Sort the list of menu elements L in ascending order.
384 The MENU-ITEM part of each menu element is compared."
385 (sort (copy-sequence l
)
388 (string-lessp (recentf-menu-element-item e1
)
389 (recentf-menu-element-item e2
))))))
391 (defun recentf-sort-descending (l)
392 "Sort the list of menu elements L in descending order.
393 The MENU-ITEM part of each menu element is compared."
394 (sort (copy-sequence l
)
397 (string-lessp (recentf-menu-element-item e2
)
398 (recentf-menu-element-item e1
))))))
400 (defun recentf-sort-basenames-ascending (l)
401 "Sort the list of menu elements L in ascending order.
402 Only file names (without directories) are compared."
403 (sort (copy-sequence l
)
407 (file-name-nondirectory (recentf-menu-element-value e1
))
408 (file-name-nondirectory (recentf-menu-element-value e2
)))))))
410 (defun recentf-sort-basenames-descending (l)
411 "Sort the list of menu elements L in descending order.
412 Only file names (without directories) are compared."
413 (sort (copy-sequence l
)
417 (file-name-nondirectory (recentf-menu-element-value e2
))
418 (file-name-nondirectory (recentf-menu-element-value e1
)))))))
420 (defun recentf-directory-compare (p1 p2
)
421 "Compare directories then filenames in paths P1 and P2.
422 Return non-nil if P1 is less than P2."
423 (let ((d1 (file-name-directory p1
))
424 (f1 (file-name-nondirectory p1
))
425 (d2 (file-name-directory p2
))
426 (f2 (file-name-nondirectory p2
)))
429 (string-lessp d1 d2
))))
431 (defun recentf-sort-directories-ascending (l)
432 "Sort the list of menu elements L in ascending order.
433 Compares directories then filenames to order the list."
434 (sort (copy-sequence l
)
437 (recentf-directory-compare (recentf-menu-element-value e1
)
438 (recentf-menu-element-value e2
))))))
440 (defun recentf-sort-directories-descending (l)
441 "Sort the list of menu elements L in descending order.
442 Compares directories then filenames to order the list."
443 (sort (copy-sequence l
)
446 (recentf-directory-compare (recentf-menu-element-value e2
)
447 (recentf-menu-element-value e1
))))))
449 (defun recentf-show-basenames (l)
450 "Filter the list of menu elements L to show only file names (no directories)
451 in the menu. When file names are duplicated their directory component is added."
452 (let ((names (mapcar (function
454 (file-name-nondirectory
455 (recentf-menu-element-value item
))))
457 (dirs (mapcar (function
460 (recentf-menu-element-value item
))))
462 (pathes (mapcar 'recentf-menu-element-value l
))
464 item filtered-items filtered-list
)
466 (setq item
(car names
))
467 (setq names
(cdr names
))
470 (cons (recentf-make-menu-element
471 (if (or (member item names
) (member item filtered-items
))
472 (concat item
" (" (nth pos dirs
) ")")
476 (setq filtered-items
(cons item filtered-items
)))
477 (nreverse filtered-list
)))
479 (defun recentf-show-basenames-ascending (l)
480 "Filter the list of menu elements L.
481 Show only file names in the menu, sorted in ascending order. This
482 filter combines the `recentf-sort-basenames-ascending' and
483 `recentf-show-basenames' filters."
484 (recentf-show-basenames (recentf-sort-basenames-ascending l
)))
486 (defun recentf-show-basenames-descending (l)
487 "Filter the list of menu elements L.
488 Show only file names in the menu, sorted in descending order. This
489 filter combines the `recentf-sort-basenames-descending' and
490 `recentf-show-basenames' filters."
491 (recentf-show-basenames (recentf-sort-basenames-descending l
)))
493 (defun recentf-relative-filter (l)
494 "Filter the list of `recentf-menu-elements' L.
495 Show filenames relative to `default-directory'."
496 (setq recentf-update-menu-p t
) ; force menu update
498 (lambda (menu-element)
499 (let* ((ful-path (recentf-menu-element-value menu-element
))
500 (rel-path (file-relative-name ful-path
)))
501 (if (string-match "^\\.\\." rel-path
)
503 (recentf-make-menu-element rel-path ful-path
)))))
506 (defcustom recentf-arrange-rules
508 ("Elisp files (%d)" ".\\.el$")
509 ("Java files (%d)" ".\\.java$")
510 ("C/C++ files (%d)" "c\\(pp\\)?$")
512 "*List of rules used by `recentf-arrange-by-rule' to build sub-menus.
513 A rule is a pair (SUB-MENU-TITLE . MATCHER). SUB-MENU-TITLE is the
514 displayed title of the sub-menu where a '%d' `format' pattern is
515 replaced by the number of items in the sub-menu. MATCHER is a regexp
516 or a list of regexps. Items matching one of the regular expressions in
517 MATCHER are added to the corresponding sub-menu."
518 :group
'recentf-filters
519 :type
'(repeat (cons string
(repeat regexp
)))
520 :set
'recentf-menu-customization-changed
)
522 (defcustom recentf-arrange-by-rule-others
"Other files (%d)"
523 "*Title of the `recentf-arrange-by-rule' sub-menu.
524 This is for the menu where items that don't match any
525 `recentf-arrange-rules' are displayed. If nil these items are
526 displayed in the main recent files menu. A '%d' `format' pattern in
527 the title is replaced by the number of items in the sub-menu."
528 :group
'recentf-filters
529 :type
'(choice (const :tag
"Main menu" nil
)
530 (string :tag
"Title"))
531 :set
'recentf-menu-customization-changed
)
533 (defcustom recentf-arrange-by-rules-min-items
0
534 "*Minimum number of items in a `recentf-arrange-by-rule' sub-menu.
535 If the number of items in a sub-menu is less than this value the
536 corresponding sub-menu items are displayed in the main recent files
537 menu or in the `recentf-arrange-by-rule-others' sub-menu if
539 :group
'recentf-filters
541 :set
'recentf-menu-customization-changed
)
543 (defcustom recentf-arrange-by-rule-subfilter nil
544 "*Function used by `recentf-arrange-by-rule' to filter sub-menu elements.
545 Nil means no filter. See also `recentf-menu-filter'. You can't use
546 `recentf-arrange-by-rule' itself here!"
547 :group
'recentf-filters
549 :set
(lambda (sym val
)
550 (if (eq val
'recentf-arrange-by-rule
)
551 (error "Can't use `recentf-arrange-by-rule' itself here!")
552 (recentf-menu-customization-changed sym val
))))
554 (defun recentf-match-rule-p (matcher file-path
)
555 "Return non-nil if FILE-PATH match the rule specified by MATCHER.
556 See `recentf-arrange-rules' for details on MATCHER."
557 (if (stringp matcher
)
558 (string-match matcher file-path
)
559 (while (and (consp matcher
)
560 (not (string-match (car matcher
) file-path
)))
561 (setq matcher
(cdr matcher
)))
564 (defun recentf-arrange-by-rule (l)
565 "Filter the list of menu-elements L.
566 Arrange them in sub-menus following rules in `recentf-arrange-rules'."
567 (let ((sub-menus-number (length recentf-arrange-rules
)))
568 (if (> sub-menus-number
0)
569 (let ((sub-menus (apply 'vector
573 recentf-arrange-rules
)))
574 other-menu-elements index min-size
)
576 (let* ((menu-element (car l
))
577 (file-path (recentf-menu-element-value menu-element
))
578 (rules recentf-arrange-rules
)
581 (while (and (not found
) rules
)
582 (if (recentf-match-rule-p (cdar rules
) file-path
)
583 (let ((sub-menu (aref sub-menus index
)))
585 (recentf-set-menu-element-value
587 (cons menu-element
(recentf-menu-element-value sub-menu
)))
589 (setq index
(1+ index
))
590 (setq rules
(cdr rules
)))
592 (setq other-menu-elements
593 (cons menu-element other-menu-elements
)))
597 (setq min-size
(if (integerp recentf-arrange-by-rules-min-items
)
598 (max 0 recentf-arrange-by-rules-min-items
)
600 (while (< index sub-menus-number
)
601 (let* ((sub-menu (aref sub-menus index
))
602 (sub-menu-title (recentf-menu-element-item sub-menu
))
603 (sub-menu-elements (recentf-menu-element-value sub-menu
))
604 (sub-menu-length (length sub-menu-elements
)))
605 (if (> sub-menu-length
0)
607 ((< sub-menu-length min-size
)
608 (setq other-menu-elements
609 (nconc sub-menu-elements other-menu-elements
)))
610 ((>= sub-menu-length min-size
)
611 (recentf-set-menu-element-item
613 (format sub-menu-title sub-menu-length
))
614 (recentf-set-menu-element-value
616 (recentf-apply-menu-filter
617 recentf-arrange-by-rule-subfilter
618 (nreverse sub-menu-elements
)))
619 (setq l
(cons sub-menu l
)))))
620 (setq index
(1+ index
))))
621 (if (and (stringp recentf-arrange-by-rule-others
)
625 (cons (recentf-make-menu-element
626 (format recentf-arrange-by-rule-others
627 (length other-menu-elements
))
628 (recentf-apply-menu-filter
629 recentf-arrange-by-rule-subfilter
630 (nreverse other-menu-elements
)))
632 (setq l
(nconc (nreverse l
)
633 (recentf-apply-menu-filter
634 recentf-arrange-by-rule-subfilter
635 (nreverse other-menu-elements
)))))))
638 (defun recentf-build-mode-rules ()
639 "Convert `auto-mode-alist' to `recentf-arrange-rules' format."
640 (let ((case-fold-search recentf-case-fold-search
)
641 (modes auto-mode-alist
)
642 regexp mode rule-name rule rules
)
644 (setq regexp
(caar modes
))
645 (setq mode
(cdar modes
))
647 (setq rule-name
(symbol-name mode
))
648 (if (string-match "\\(.*\\)-mode$" rule-name
)
649 (setq rule-name
(match-string 1 rule-name
)))
650 (setq rule-name
(concat rule-name
" (%d)"))
651 (setq rule
(assoc rule-name rules
))
653 (setcdr rule
(cons regexp
(cdr rule
)))
654 (setq rules
(cons (list rule-name regexp
) rules
))))
655 (setq modes
(cdr modes
)))
656 ;; It is important to preserve auto-mode-alist order
657 ;; to ensure the right file <-> mode association
660 (defun recentf-arrange-by-mode (l)
661 "Filter the list of menu-elements L to build sub-menus for each major mode."
662 (let ((recentf-arrange-rules (recentf-build-mode-rules))
663 (recentf-arrange-by-rule-others "others (%d)"))
664 (recentf-arrange-by-rule l
)))
666 (defun recentf-build-dir-rules (l)
667 "Convert directories in menu-elements L to rules in `recentf-arrange-rules' format."
671 (let ((dir (file-name-directory
672 (recentf-menu-element-value e
))))
673 (or (member dir dirs
)
674 (setq dirs
(cons dir dirs
))))))
678 (cons (concat d
" (%d)")
680 (nreverse (sort dirs
'string-lessp
)))))
682 (defun recentf-file-name-nondir (l)
683 "Filter the list of menu-elements L to show only filenames.
684 This simplified version of `recentf-show-basenames' does not handle
685 duplicates. It is used by `recentf-arrange-by-dir' as its
686 `recentf-arrange-by-rule-subfilter'."
689 (recentf-make-menu-element
690 (file-name-nondirectory (recentf-menu-element-value e
))
691 (recentf-menu-element-value e
))))
694 (defun recentf-arrange-by-dir (l)
695 "Filter the list of menu-elements L to build sub-menus for each directory."
696 (let ((recentf-arrange-rules (recentf-build-dir-rules l
))
697 (recentf-arrange-by-rule-subfilter 'recentf-file-name-nondir
)
698 recentf-arrange-by-rule-others
)
699 (nreverse (recentf-arrange-by-rule l
))))
701 (defvar recentf-filter-changer-state nil
702 "Used by `recentf-filter-changer' to hold its state.")
704 (defcustom recentf-filter-changer-alist
706 (recentf-arrange-by-mode .
"*Files by Mode*")
707 (recentf-arrange-by-dir .
"*Files by Directory*")
708 (recentf-arrange-by-rule .
"*Files by User Rule*")
710 "*List of filters managed by `recentf-filter-changer'.
711 Each filter is defined by a pair (FILTER-FUN . FILTER-LBL) where:
713 - - FILTER-FUN is the function that filters menu-elements
714 - - FILTER-LBL is the menu item used to activate the filter"
715 :group
'recentf-filters
716 :type
'(repeat (cons function string
))
717 :set
(lambda (sym val
)
718 (setq recentf-filter-changer-state nil
)
719 (recentf-menu-customization-changed sym val
)))
721 (defun recentf-filter-changer-goto-next ()
722 "Go to the next filter available (see `recentf-filter-changer')."
723 (and (consp recentf-filter-changer-state
)
724 (setq recentf-filter-changer-state
725 (cdr recentf-filter-changer-state
)))
726 (setq recentf-update-menu-p t
))
728 (defun recentf-filter-changer-get-current ()
729 "Get the current filter available (see `recentf-filter-changer')."
730 (if (null recentf-filter-changer-state
)
731 (setq recentf-filter-changer-state recentf-filter-changer-alist
))
732 (and (consp recentf-filter-changer-state
)
733 (car recentf-filter-changer-state
)))
735 (defun recentf-filter-changer-get-next ()
736 "Get the next filter available (see `recentf-filter-changer')."
737 (let ((filters recentf-filter-changer-state
))
738 (cond ((consp filters
)
739 (setq filters
(cdr filters
))
741 (setq filters recentf-filter-changer-alist
)))
743 (setq filters recentf-filter-changer-alist
)
745 (setq filters
(cdr filters
)))))
749 (defun recentf-filter-changer (l)
750 "Manage a ring of filters.
751 `recentf-filter-changer-alist' defines the filters in the ring.
752 Actual filtering of L is delegated to the current filter in the
753 ring. A filter menu item is displayed allowing to dynamically activate
754 the next filter in the ring. If the filter ring is empty L is left
756 (let ((current-filter-item (recentf-filter-changer-get-current))
757 (next-filter-item (recentf-filter-changer-get-next)))
758 (when current-filter-item
759 (setq l
(recentf-apply-menu-filter (car current-filter-item
) l
))
761 (setq recentf-menu-filter-commands
762 (list (vector (cdr next-filter-item
)
763 '(recentf-filter-changer-goto-next)
771 (defun recentf-cancel-dialog (&rest ignore
)
772 "Cancel the current dialog.
773 Used by `recentf-edit-list' and `recentf-open-files' dialogs."
775 (kill-buffer (current-buffer))
776 (message "Dialog canceled."))
778 (defvar recentf-dialog-mode-map nil
779 "`recentf-dialog-mode' keymap.")
781 (if recentf-dialog-mode-map
783 (setq recentf-dialog-mode-map
(make-sparse-keymap))
784 (define-key recentf-dialog-mode-map
"q" 'recentf-cancel-dialog
)
785 (define-key recentf-dialog-mode-map
[down-mouse-1
] 'widget-button-click
)
786 (set-keymap-parent recentf-dialog-mode-map widget-keymap
))
788 (defun recentf-dialog-mode ()
789 "Major mode used in recentf dialogs.
791 These are the special commands of `recentf-dialog-mode' mode:
792 q -- cancel this dialog."
794 (setq major-mode
'recentf-dialog-mode
)
795 (setq mode-name
"recentf-dialog")
796 (use-local-map recentf-dialog-mode-map
))
799 ;;;; Hooks and Commands
802 (defun recentf-add-file-hook ()
803 "Insert the name of the file just opened or written into `recentf-list'."
804 (and buffer-file-name
(recentf-add-file buffer-file-name
))
807 (defun recentf-remove-file-hook ()
808 "When a buffer is killed remove a non readable file from `recentf-list'."
809 (and buffer-file-name
(recentf-remove-if-non-readable buffer-file-name
))
812 (defun recentf-update-menu-hook ()
813 "Update the recentf menu from the current `recentf-list'."
814 (when recentf-update-menu-p
817 (setq recentf-update-menu-p nil
)
818 (easy-menu-change recentf-menu-path
820 (recentf-make-menu-items)
821 recentf-menu-before
))
824 (defun recentf-dump-variable (variable &optional limit
)
825 "Insert a \"(setq VARIABLE value)\" in the current buffer.
826 Optional argument LIMIT specifies a maximum length when VARIABLE value
827 is a list (default to the full list)."
828 (let ((value (symbol-value variable
)))
829 (insert (format "(setq %S\n '(\n" variable
))
831 (if (and (integerp limit
) (> limit
0))
832 (setq value
(recentf-trunc-list value limit
)))
835 (insert (format " %S\n" e
))))
838 (insert (format " %S\n" value
))))
843 (defun recentf-save-list ()
844 "Save the current `recentf-list' to the file `recentf-save-file'."
848 (insert (format recentf-save-file-header
(current-time-string)))
849 (recentf-dump-variable 'recentf-list recentf-max-saved-items
)
850 (recentf-dump-variable 'recentf-filter-changer-state
)
851 (if (file-writable-p recentf-save-file
)
852 (write-region (point-min) (point-max) recentf-save-file
))
853 (kill-buffer (current-buffer)))
856 (defvar recentf-edit-selected-items nil
857 "Used by `recentf-edit-list'.
858 Holds list of files to be deleted from `recentf-list'.")
860 (defun recentf-edit-list-action (widget &rest ignore
)
861 "Checkbox WIDGET action used by `recentf-edit-list' to select/unselect a file."
862 (let ((value (widget-get widget
':tag
)))
863 ;; if value is already in the selected items
864 (if (memq value recentf-edit-selected-items
)
867 (setq recentf-edit-selected-items
868 (delq value recentf-edit-selected-items
))
869 (message "%s removed from selection." value
))
872 (setq recentf-edit-selected-items
873 (nconc (list value
) recentf-edit-selected-items
))
874 (message "%s added to selection." value
)))))
877 (defun recentf-edit-list ()
878 "Allow the user to edit the files that are kept in the recent list."
880 (with-current-buffer (get-buffer-create (concat "*" recentf-menu-title
" - Edit list*"))
881 (switch-to-buffer (current-buffer))
882 (kill-all-local-variables)
883 (let ((inhibit-read-only t
))
885 (let ((all (overlay-lists)))
886 ;; Delete all the overlays.
887 (mapcar 'delete-overlay
(car all
))
888 (mapcar 'delete-overlay
(cdr all
)))
889 (setq recentf-edit-selected-items nil
)
890 ;; Insert the dialog header
891 (widget-insert "Select the files to be deleted from the 'recentf-list'.\n\n")
892 (widget-insert "Click on Ok to update the list. ")
893 (widget-insert "Click on Cancel or type \"q\" to quit.\n")
894 ;; Insert the list of files as checkboxes
897 (widget-create 'checkbox
898 :value nil
; unselected checkbox
899 :format
"\n %[%v%] %t"
901 :notify
'recentf-edit-list-action
)))
903 (widget-insert "\n\n")
904 ;; Insert the Ok button
905 (widget-create 'push-button
906 :notify
(lambda (&rest ignore
)
907 (if recentf-edit-selected-items
908 (progn (kill-buffer (current-buffer))
912 (delq item recentf-list
))))
913 recentf-edit-selected-items
)
914 (message "%S file(s) removed from the list"
915 (length recentf-edit-selected-items
))
916 (setq recentf-update-menu-p t
))
917 (message "No file selected.")))
920 ;; Insert the Cancel button
921 (widget-create 'push-button
922 :notify
'recentf-cancel-dialog
924 (recentf-dialog-mode)
926 (goto-char (point-min))))
929 (defun recentf-cleanup ()
930 "Remove all non-readable and excluded files from `recentf-list'."
932 (let ((count (length recentf-list
)))
937 (and (file-readable-p filename
)
938 (recentf-include-p filename
)
941 (setq count
(- count
(length recentf-list
)))
942 (message "%s removed from the list"
943 (cond ((= count
0) "No file")
944 ((= count
1) "One file")
945 (t (format "%d files" count
)))))
946 (setq recentf-update-menu-p t
))
948 (defun recentf-open-files-action (widget &rest ignore
)
949 "Button WIDGET action used by `recentf-open-files' to open a file."
950 (kill-buffer (current-buffer))
951 (funcall recentf-menu-action
(widget-value widget
)))
953 (defvar recentf-open-files-item-shift
""
954 "String used by `recentf-open-files' to shift right sub-menu items.")
956 (defun recentf-open-files-item (menu-element)
957 "Insert MENU-ELEMENT item in the current interaction buffer."
958 (let ((menu-item (car menu-element
))
959 (file-path (cdr menu-element
)))
960 (if (consp file-path
) ; This is a sub-menu
961 (let* ((shift recentf-open-files-item-shift
)
962 (recentf-open-files-item-shift (concat shift
" ")))
966 :format
(concat shift
"%{%t%}:\n"))
967 (mapcar 'recentf-open-files-item
969 (widget-insert "\n"))
970 (widget-create 'push-button
971 :button-face
'default
973 :help-echo
(concat "Open " file-path
)
974 :format
(concat recentf-open-files-item-shift
"%[%t%]")
975 :notify
'recentf-open-files-action
977 (widget-insert "\n"))))
980 (defun recentf-open-files (&optional files buffer-name
)
981 "Display buffer allowing user to choose a file from recently-opened list.
982 The optional argument FILES may be used to specify the list, otherwise
983 `recentf-list' is used. The optional argument BUFFER-NAME specifies
984 which buffer to use for the interaction."
987 (setq files recentf-list
))
988 (if (null buffer-name
)
989 (setq buffer-name
(concat "*" recentf-menu-title
"*")))
990 (with-current-buffer (get-buffer-create buffer-name
)
991 (switch-to-buffer (current-buffer))
992 (kill-all-local-variables)
993 (let ((inhibit-read-only t
))
995 (let ((all (overlay-lists)))
996 ;; Delete all the overlays.
997 (mapcar 'delete-overlay
(car all
))
998 (mapcar 'delete-overlay
(cdr all
)))
999 ;; Insert the dialog header
1000 (widget-insert "Click on a file to open it. ")
1001 (widget-insert "Click on Cancel or type \"q\" to quit.\n\n" )
1002 ;; Insert the list of files as buttons
1003 (let ((recentf-open-files-item-shift ""))
1004 (mapcar 'recentf-open-files-item
1005 (recentf-apply-menu-filter
1007 (mapcar 'recentf-make-default-menu-element files
))))
1008 (widget-insert "\n")
1009 ;; Insert the Cancel button
1010 (widget-create 'push-button
1011 :notify
'recentf-cancel-dialog
1013 (recentf-dialog-mode)
1015 (goto-char (point-min))))
1018 (defun recentf-open-more-files ()
1019 "Allow the user to open files that are not in the menu."
1021 (recentf-open-files (nthcdr recentf-max-menu-items recentf-list
)
1022 (concat "*" recentf-menu-title
" - More*")))
1025 (defun recentf-mode (&optional arg
)
1026 "Toggle recentf mode.
1027 With prefix ARG, turn recentf mode on if and only if ARG is positive.
1028 Returns the new status of recentf mode (non-nil means on).
1030 When recentf mode is enabled, it maintains a menu for visiting files that
1031 were operated on recently."
1034 (> (prefix-numeric-value arg
) 0)
1035 (not recentf-mode
))))
1037 (unless recentf-initialized-p
1038 (setq recentf-initialized-p t
)
1039 (if (file-readable-p recentf-save-file
)
1040 (load-file recentf-save-file
))
1041 (setq recentf-update-menu-p t
)
1042 (add-hook 'find-file-hooks
'recentf-add-file-hook
)
1043 (add-hook 'write-file-hooks
'recentf-add-file-hook
)
1044 (add-hook 'menu-bar-update-hook
'recentf-update-menu-hook
)
1045 (add-hook 'kill-emacs-hook
'recentf-save-list
))
1046 (when recentf-initialized-p
1047 (setq recentf-initialized-p nil
)
1049 (easy-menu-remove-item nil recentf-menu-path recentf-menu-title
)
1050 (remove-hook 'find-file-hooks
'recentf-add-file-hook
)
1051 (remove-hook 'write-file-hooks
'recentf-add-file-hook
)
1052 (remove-hook 'menu-bar-update-hook
'recentf-update-menu-hook
)
1053 (remove-hook 'kill-emacs-hook
'recentf-save-list
)))
1054 (setq recentf-mode on-p
)))
1058 (run-hooks 'recentf-load-hook
)
1060 ;;; recentf.el ends here