-;; recentf.el --- setup a menu of recently opened files\r
-\r
-;; Copyright (C) 1999, 2000 Free Software Foundation, Inc.\r
-\r
-;; Author: David Ponce <david@dponce.com>\r
-;; Created: July 19 1999\r
-;; Keywords: customization\r
-\r
-;; This file is part of GNU Emacs.\r
-\r
-;; GNU Emacs is free software; you can redistribute it and/or modify\r
-;; it under the terms of the GNU General Public License as published by\r
-;; the Free Software Foundation; either version 2, or (at your option)\r
-;; any later version.\r
-\r
-;; GNU Emacs is distributed in the hope that it will be useful,\r
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
-;; GNU General Public License for more details.\r
-\r
-;; You should have received a copy of the GNU General Public License\r
-;; along with GNU Emacs; see the file COPYING. If not, write to the\r
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,\r
-;; Boston, MA 02111-1307, USA.\r
-\r
-;;; Commentary:\r
-\r
-;; This package maintains a menu for visiting files that were operated\r
-;; on recently. When enabled a new "Open Recent" submenu is displayed\r
-;; in the "Files" menu. The recent files list is automatically saved\r
-;; across Emacs sessions. You can customize the number of recent\r
-;; files displayed, the location of the menu and others options (see\r
-;; the source code for details). To install and use, put the file on\r
-;; your Emacs-Lisp load path and add the following into your ~/.emacs\r
-;; startup file:\r
-;;\r
-;; (require 'recentf)\r
-;; (recentf-mode 1) \r
-\r
-;;; Code:\r
-\r
-(require 'easymenu)\r
-(require 'wid-edit)\r
-\r
-(defconst recentf-save-file-header\r
- ";;; Automatically generated by `recentf' on %s.\n"\r
- "Header to be written into the `recentf-save-file'.")\r
-\r
-(defvar recentf-list nil\r
- "List of recently opened files.")\r
-\r
-(defvar recentf-update-menu-p t\r
- "Non-nil if the recentf menu must be updated.")\r
-\r
-(defvar recentf-initialized-p nil\r
- "Non-nil if recentf already initialized.")\r
-\r
-;; IMPORTANT: This function must be defined before the following defcustoms\r
-;; because it is used in their :set clause. To avoid byte-compiler warnings\r
-;; the `symbol-value' function is used to access the `recentf-menu-path'\r
-;; and `recentf-menu-title' values.\r
-(defun recentf-menu-customization-changed (sym val)\r
- "Function called when menu customization has changed.\r
-It removes the recentf menu and forces its complete redrawing."\r
- (when recentf-initialized-p\r
- (easy-menu-remove-item nil \r
- (symbol-value 'recentf-menu-path)\r
- (symbol-value 'recentf-menu-title))\r
- (setq recentf-update-menu-p t))\r
- (custom-set-default sym val))\r
-\r
-(defgroup recentf nil\r
- "Maintain a menu of recently opened files."\r
- :version "21.1"\r
- :group 'files)\r
-\r
-(defgroup recentf-filters nil\r
- "Group to customize recentf menu filters.\r
-You should define the options of your own filters in this group."\r
- :group 'recentf)\r
-\r
-(defcustom recentf-max-saved-items 20\r
- "*Maximum number of items saved to `recentf-save-file'."\r
- :group 'recentf\r
- :type 'integer)\r
-\r
-(defcustom recentf-save-file (expand-file-name "~/.recentf")\r
- "*File to save `recentf-list' into."\r
- :group 'recentf\r
- :type 'file)\r
-\r
-(defcustom recentf-exclude nil\r
- "*List of regexps for filenames excluded from `recentf-list'."\r
- :group 'recentf\r
- :type '(repeat regexp))\r
-\r
-(defcustom recentf-menu-title "Open Recent"\r
- "*Name of the recentf menu."\r
- :group 'recentf\r
- :type 'string\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-menu-path '("files")\r
- "*Path where to add the recentf menu.\r
-If nil add it at top-level (see also `easy-menu-change')."\r
- :group 'recentf\r
- :type '(choice (const :tag "Top Level" nil)\r
- (sexp :tag "Menu Path"))\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-menu-before "open-file"\r
- "*Name of the menu before which the recentf menu will be added.\r
-If nil add it at end of menu (see also `easy-menu-change')."\r
- :group 'recentf\r
- :type '(choice (string :tag "Name")\r
- (const :tag "Last" nil))\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-menu-action 'recentf-find-file\r
- "*Function to invoke with a filename item of the recentf menu.\r
-The default action `recentf-find-file' calls `find-file' to edit an\r
-existing file. If the file does not exist or is not readable, it is\r
-not edited and its name is removed from `recentf-list'. You can use\r
-`find-file' instead to open non-existing files and keep them in the\r
-list of recently opened files."\r
- :group 'recentf\r
- :type 'function\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-max-menu-items 10\r
- "*Maximum number of items in the recentf menu."\r
- :group 'recentf\r
- :type 'integer\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-menu-filter nil\r
- "*Function used to filter files displayed in the recentf menu.\r
-Nil means no filter. The following functions are predefined:\r
-\r
-- - `recentf-sort-ascending' to sort menu items in ascending order.\r
-- - `recentf-sort-descending' to sort menu items in descending order.\r
-- - `recentf-sort-basenames-ascending' to sort file names in descending order.\r
-- - `recentf-sort-basenames-descending' to sort file names in descending order.\r
-- - `recentf-sort-directories-ascending' to sort directories in ascending order.\r
-- - `recentf-sort-directories-descending' to sort directories in descending order.\r
-- - `recentf-show-basenames' to show file names (no directories) in menu items.\r
-- - `recentf-show-basenames-ascending' to show file names in ascending order.\r
-- - `recentf-show-basenames-descending' to show file names in descending order.\r
-- - `recentf-relative-filter' to show file names relative to `default-directory'.\r
-- - `recentf-arrange-by-rule' to show sub-menus following user defined rules.\r
-- - `recentf-arrange-by-mode' to show a sub-menu for each major mode.\r
-- - `recentf-arrange-by-dir' to show a sub-menu for each directory.\r
-- - `recentf-filter-changer' to manage a ring of filters.\r
-\r
-The filter function is called with one argument, the list of menu elements\r
-used to build the menu and must return a new list of menu elements (see\r
-`recentf-make-menu-element' for menu element form)."\r
- :group 'recentf\r
- :type 'function\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-menu-append-commands-p t\r
- "*If not-nil command items are appended to the menu."\r
- :group 'recentf\r
- :type 'boolean\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-keep-non-readable-files-p nil\r
- "*If nil (default), non-readable files are not kept in `recentf-list'."\r
- :group 'recentf\r
- :type 'boolean\r
- :require 'recentf\r
- :initialize 'custom-initialize-default\r
- :set (lambda (sym val)\r
- (if val\r
- (remove-hook 'kill-buffer-hook 'recentf-remove-file-hook)\r
- (add-hook 'kill-buffer-hook 'recentf-remove-file-hook))\r
- (custom-set-default sym val)))\r
-\r
-(defcustom recentf-mode nil\r
- "Toggle recentf mode.\r
-When recentf mode is enabled, it maintains a menu for visiting files that\r
-were operated on recently.\r
-Setting this variable directly does not take effect;\r
-use either \\[customize] or the function `recentf-mode'."\r
- :set (lambda (symbol value)\r
- (recentf-mode (or value 0)))\r
- :initialize 'custom-initialize-default\r
- :type 'boolean\r
- :group 'recentf\r
- :require 'recentf)\r
-\r
-(defcustom recentf-load-hook nil\r
- "*Normal hook run at end of loading the `recentf' package."\r
- :group 'recentf\r
- :type 'hook)\r
-\r
-;;;\r
-;;; Common functions\r
-;;;\r
-(defconst recentf-case-fold-search\r
- (memq system-type '(vax-vms windows-nt))\r
- "Non-nil if recentf searches and matches should ignore case.")\r
-\r
-(defun recentf-include-p (filename)\r
- "Return t if FILENAME matches none of the `recentf-exclude' regexps."\r
- (let ((case-fold-search recentf-case-fold-search)\r
- (rl recentf-exclude))\r
- (while (and rl (not (string-match (car rl) filename)))\r
- (setq rl (cdr rl)))\r
- (null rl)))\r
-\r
-(defun recentf-add-file (filename)\r
- "Add or move FILENAME at the beginning of `recentf-list'.\r
-Does nothing if FILENAME matches one of the `recentf-exclude' regexps."\r
- (let ((filename (expand-file-name filename)))\r
- (when (recentf-include-p filename)\r
- (setq recentf-list (cons filename (delete filename recentf-list)))\r
- (setq recentf-update-menu-p t))))\r
-\r
-(defun recentf-remove-if-non-readable (filename)\r
- "Remove FILENAME from `recentf-list' if not readable."\r
- (unless (file-readable-p filename)\r
- (setq recentf-list (delete filename recentf-list))\r
- (setq recentf-update-menu-p t)))\r
-\r
-(defun recentf-find-file (filename)\r
- "Edit file FILENAME using `find-file'.\r
-If FILENAME is not readable it is removed from `recentf-list'."\r
- (if (file-readable-p filename)\r
- (find-file filename)\r
- (progn\r
- (message "File `%s' not found." filename)\r
- (setq recentf-list (delete filename recentf-list))\r
- (setq recentf-update-menu-p t))))\r
-\r
-(defun recentf-trunc-list (l n)\r
- "Return a list of the first N elements of L."\r
- (let ((lh nil))\r
- (while (and l (> n 0))\r
- (setq lh (cons (car l) lh))\r
- (setq n (1- n))\r
- (setq l (cdr l)))\r
- (nreverse lh)))\r
-\r
-(defun recentf-elements (n)\r
- "Return a list of the first N elements of `recentf-list'."\r
- (recentf-trunc-list recentf-list n))\r
-\r
-(defun recentf-make-menu-element (menu-item menu-value)\r
- "Create a new menu-element.\r
-\r
-A menu element is a pair (MENU-ITEM . MENU-VALUE) where:\r
-\r
-- - MENU-ITEM is the menu item string displayed.\r
-- - MENU-VALUE is the path used to open the file when the\r
- corresponding MENU-ITEM is selected. Or it is\r
- a pair (SUB-MENU-TITLE . MENU-ELEMENTS) where\r
- SUB-MENU-TITLE is a sub-menu title and\r
- MENU-ELEMENTS is the list of menu elements in\r
- the sub-menu."\r
- (cons menu-item menu-value))\r
-\r
-(defun recentf-menu-element-item (e)\r
- "Return the item part of the menu-element E."\r
- (car e))\r
-\r
-(defun recentf-menu-element-value (e)\r
- "Return the value part of the menu-element E."\r
- (cdr e))\r
-\r
-(defun recentf-set-menu-element-item (e item)\r
- "Change the item part of menu-element E to ITEM."\r
- (setcar e item))\r
-\r
-(defun recentf-set-menu-element-value (e value)\r
- "Change the value part of menu-element E to VALUE."\r
- (setcdr e value))\r
-\r
-(defun recentf-sub-menu-element-p (e)\r
- "Return non-nil if menu-element E defines a sub-menu."\r
- (consp (recentf-menu-element-value e)))\r
-\r
-(defun recentf-make-default-menu-element (file-path)\r
- "Make a new default menu element (MENU-ITEM . MENU-VALUE) for the\r
-given recent file path FILE-PATH. MENU-ITEM and MENU-VALUE are set to\r
-FILE-PATH. See also `recentf-make-menu-element'."\r
- (recentf-make-menu-element file-path file-path))\r
-\r
-(defun recentf-menu-elements (n)\r
- "Return a list of the first N default menu elements from\r
-`recentf-list'. See also `recentf-make-default-menu-element'."\r
- (mapcar 'recentf-make-default-menu-element\r
- (recentf-elements n)))\r
-\r
-(defun recentf-apply-menu-filter (filter l)\r
- "Convenient funtion to apply the function FILTER to the list of\r
-menu-elements L. It takes care of sub-menu elements in L and\r
-recursively apply FILTER to them. It is guarantee than FILTER receives\r
-only a list of single menu-elements (no sub-menu)."\r
- (if (and (functionp filter) l)\r
- (let ((case-fold-search recentf-case-fold-search)\r
- menu-element sub-menu-elements single-elements)\r
- ;; split L in two sub-listes:\r
- ;; one of sub-menus elements and\r
- ;; one of single menu elements\r
- (while l\r
- (setq menu-element (car l))\r
- (if (recentf-sub-menu-element-p menu-element)\r
- (setq sub-menu-elements\r
- (cons menu-element sub-menu-elements))\r
- (setq single-elements\r
- (cons menu-element single-elements)))\r
- (setq l (cdr l)))\r
- ;; apply FILTER to the list of single menu elements\r
- (if single-elements\r
- (setq single-elements (funcall filter\r
- (nreverse single-elements))))\r
- ;; apply FILTER to sub-menu menu element list\r
- (setq l sub-menu-elements)\r
- (setq sub-menu-elements nil)\r
- (while l\r
- (setq menu-element (car l))\r
- (recentf-set-menu-element-value\r
- menu-element\r
- (recentf-apply-menu-filter\r
- filter\r
- (recentf-menu-element-value menu-element)))\r
- (setq sub-menu-elements (cons menu-element sub-menu-elements))\r
- (setq l (cdr l)))\r
- ;; build and return the new filtered menu element list\r
- (nconc sub-menu-elements single-elements))\r
- l))\r
-\r
-(defvar recentf-menu-items-for-commands\r
- (list ["Cleanup list" recentf-cleanup t]\r
- ["Edit list..." recentf-edit-list t]\r
- ["Save list now" recentf-save-list t]\r
- (vector "Recentf Options..." '(customize-group "recentf") t))\r
- "List of menu items for recentf commands.")\r
-\r
-(defvar recentf-menu-filter-commands nil\r
- "This variable can be used by menu filters to setup their own command menu.\r
-\r
-If non-nil it must contain a list of valid menu-items to be appended\r
-to the recent file list part of the menu. Before calling a menu\r
-filter function this variable is reset to nil.")\r
-\r
-(defun recentf-make-menu-items ()\r
- "Make menu items from `recentf-list'."\r
- (setq recentf-menu-filter-commands nil)\r
- (let ((file-items\r
- (mapcar 'recentf-make-menu-item\r
- (recentf-apply-menu-filter\r
- recentf-menu-filter\r
- (recentf-menu-elements recentf-max-menu-items)))))\r
- (append (or file-items (list ["No files" t nil]))\r
- (and (< recentf-max-menu-items (length recentf-list))\r
- (list ["More..." recentf-open-more-files t]))\r
- (and recentf-menu-filter-commands\r
- (cons "---"\r
- recentf-menu-filter-commands))\r
- (and recentf-menu-append-commands-p\r
- (cons "---"\r
- recentf-menu-items-for-commands)))))\r
-\r
-(defun recentf-make-menu-item (menu-element)\r
- "Make a menu item from a menu element (see `recentf-make-menu-element')."\r
- (let ((menu-item (recentf-menu-element-item menu-element))\r
- (menu-value (recentf-menu-element-value menu-element)))\r
- (if (recentf-sub-menu-element-p menu-element)\r
- (cons menu-item (mapcar 'recentf-make-menu-item menu-value))\r
- (vector menu-item\r
- (list recentf-menu-action menu-value)\r
- t))))\r
-\r
-;;;\r
-;;; Predefined menu filter functions\r
-;;;\r
-\r
-(defun recentf-sort-ascending (l)\r
- "Sort the list of menu elements L in ascending order.\r
-The MENU-ITEM part of each menu element is compared."\r
- (sort (copy-sequence l)\r
- (function\r
- (lambda (e1 e2)\r
- (string-lessp (recentf-menu-element-item e1)\r
- (recentf-menu-element-item e2))))))\r
-\r
-(defun recentf-sort-descending (l)\r
- "Sort the list of menu elements L in descending order.\r
-The MENU-ITEM part of each menu element is compared."\r
- (sort (copy-sequence l)\r
- (function\r
- (lambda (e1 e2)\r
- (string-lessp (recentf-menu-element-item e2)\r
- (recentf-menu-element-item e1))))))\r
-\r
-(defun recentf-sort-basenames-ascending (l)\r
- "Sort the list of menu elements L in ascending order.\r
-Only file names (without directories) are compared."\r
- (sort (copy-sequence l)\r
- (function\r
- (lambda (e1 e2)\r
- (string-lessp\r
- (file-name-nondirectory (recentf-menu-element-value e1))\r
- (file-name-nondirectory (recentf-menu-element-value e2)))))))\r
-\r
-(defun recentf-sort-basenames-descending (l)\r
- "Sort the list of menu elements L in descending order.\r
-Only file names (without directories) are compared."\r
- (sort (copy-sequence l)\r
- (function\r
- (lambda (e1 e2)\r
- (string-lessp\r
- (file-name-nondirectory (recentf-menu-element-value e2))\r
- (file-name-nondirectory (recentf-menu-element-value e1)))))))\r
-\r
-(defun recentf-directory-compare (p1 p2)\r
- "Compare directories then filenames in pathes P1 and P2 and return\r
-non-nil if P1 is less than P2."\r
- (let ((d1 (file-name-directory p1))\r
- (f1 (file-name-nondirectory p1))\r
- (d2 (file-name-directory p2))\r
- (f2 (file-name-nondirectory p2)))\r
- (if (string= d1 d2)\r
- (string-lessp f1 f2)\r
- (string-lessp d1 d2))))\r
-\r
-(defun recentf-sort-directories-ascending (l)\r
- "Sort the list of menu elements L in ascending order.\r
-Compares directories then filenames to order the list."\r
- (sort (copy-sequence l)\r
- (function\r
- (lambda (e1 e2)\r
- (recentf-directory-compare (recentf-menu-element-value e1)\r
- (recentf-menu-element-value e2))))))\r
-\r
-(defun recentf-sort-directories-descending (l)\r
- "Sort the list of menu elements L in descending order.\r
-Compares directories then filenames to order the list."\r
- (sort (copy-sequence l)\r
- (function\r
- (lambda (e1 e2)\r
- (recentf-directory-compare (recentf-menu-element-value e2)\r
- (recentf-menu-element-value e1))))))\r
-\r
-(defun recentf-show-basenames (l)\r
- "Filter the list of menu elements L to show only file names (no directories)\r
-in the menu. When file names are duplicated their directory component is added."\r
- (let ((names (mapcar (function\r
- (lambda (item)\r
- (file-name-nondirectory\r
- (recentf-menu-element-value item))))\r
- l))\r
- (dirs (mapcar (function\r
- (lambda (item)\r
- (file-name-directory\r
- (recentf-menu-element-value item))))\r
- l))\r
- (pathes (mapcar 'recentf-menu-element-value l))\r
- (pos -1)\r
- item filtered-items filtered-list)\r
- (while names\r
- (setq item (car names))\r
- (setq names (cdr names))\r
- (setq pos (1+ pos))\r
- (setq filtered-list\r
- (cons (recentf-make-menu-element\r
- (if (or (member item names) (member item filtered-items))\r
- (concat item " (" (nth pos dirs) ")")\r
- item)\r
- (nth pos pathes))\r
- filtered-list))\r
- (setq filtered-items (cons item filtered-items)))\r
- (nreverse filtered-list)))\r
-\r
-(defun recentf-show-basenames-ascending (l)\r
- "Filter the list of menu elements L to show only file names in the menu,\r
-sorted in ascending order. This filter combines the `recentf-sort-basenames-ascending'\r
-and `recentf-show-basenames' filters."\r
- (recentf-show-basenames (recentf-sort-basenames-ascending l)))\r
-\r
-(defun recentf-show-basenames-descending (l)\r
- "Filter the list of menu elements L to show only file names in the menu,\r
-sorted in descending order. This filter combines the `recentf-sort-basenames-descending'\r
-and `recentf-show-basenames' filters."\r
- (recentf-show-basenames (recentf-sort-basenames-descending l)))\r
-\r
-(defun recentf-relative-filter (l)\r
- "Filter the list of `recentf-menu-elements' L to show filenames\r
-relative to `default-directory'."\r
- (setq recentf-update-menu-p t) ; force menu update\r
- (mapcar (function\r
- (lambda (menu-element)\r
- (let* ((ful-path (recentf-menu-element-value menu-element))\r
- (rel-path (file-relative-name ful-path)))\r
- (if (string-match "^\\.\\." rel-path)\r
- menu-element\r
- (recentf-make-menu-element rel-path ful-path)))))\r
- l))\r
-\r
-(defcustom recentf-arrange-rules\r
- '(\r
- ("Elisp files (%d)" ".\\.el$")\r
- ("Java files (%d)" ".\\.java$")\r
- ("C/C++ files (%d)" "c\\(pp\\)?$")\r
- )\r
- "*List of rules used by `recentf-arrange-by-rule' to build sub-menus.\r
-A rule is a pair (SUB-MENU-TITLE . MATCHER). SUB-MENU-TITLE is the\r
-displayed title of the sub-menu where a '%d' `format' pattern is\r
-replaced by the number of items in the sub-menu. MATCHER is a regexp\r
-or a list of regexps. Items matching one of the regular expressions in\r
-MATCHER are added to the corresponding sub-menu."\r
- :group 'recentf-filters\r
- :type '(repeat (cons string (repeat regexp)))\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-arrange-by-rule-others "Other files (%d)"\r
- "*Title of the `recentf-arrange-by-rule' sub-menu where items that\r
-don't match any `recentf-arrange-rules' are displayed. If nil\r
-these items are displayed in the main recent files menu. A '%d'\r
-`format' pattern in the title is replaced by the number of items in\r
-the sub-menu."\r
- :group 'recentf-filters\r
- :type '(choice (const :tag "Main menu" nil)\r
- (string :tag "Title"))\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-arrange-by-rules-min-items 0\r
- "*Minimum number of items in a `recentf-arrange-by-rule' sub-menu.\r
-If the number of items in a sub-menu is less than this value the\r
-corresponding sub-menu items are displayed in the main recent files\r
-menu or in the `recentf-arrange-by-rule-others' sub-menu if\r
-defined."\r
- :group 'recentf-filters\r
- :type 'number\r
- :set 'recentf-menu-customization-changed)\r
-\r
-(defcustom recentf-arrange-by-rule-subfilter nil\r
- "*Function used by `recentf-arrange-by-rule' to filter sub-menu elements.\r
-Nil means no filter. See also `recentf-menu-filter'. You can't use\r
-`recentf-arrange-by-rule' itself here!"\r
- :group 'recentf-filters\r
- :type 'function\r
- :set (lambda (sym val)\r
- (if (eq val 'recentf-arrange-by-rule)\r
- (error "Can't use `recentf-arrange-by-rule' itself here!")\r
- (recentf-menu-customization-changed sym val))))\r
-\r
-(defun recentf-match-rule-p (matcher file-path)\r
- "Return non-nil if FILE-PATH match the rule specified by MATCHER.\r
-See `recentf-arrange-rules' for details on MATCHER."\r
- (if (stringp matcher)\r
- (string-match matcher file-path)\r
- (while (and (consp matcher)\r
- (not (string-match (car matcher) file-path)))\r
- (setq matcher (cdr matcher)))\r
- matcher))\r
-\r
-(defun recentf-arrange-by-rule (l)\r
- "Filter the list of menu-elements L to arrange them in sub-menus\r
-following rules in `recentf-arrange-rules'."\r
- (let ((sub-menus-number (length recentf-arrange-rules)))\r
- (if (> sub-menus-number 0)\r
- (let ((sub-menus (apply 'vector\r
- (mapcar (function\r
- (lambda (pair)\r
- (list (car pair))))\r
- recentf-arrange-rules)))\r
- other-menu-elements index min-size)\r
- (while l\r
- (let* ((menu-element (car l))\r
- (file-path (recentf-menu-element-value menu-element))\r
- (rules recentf-arrange-rules)\r
- (found nil))\r
- (setq index 0)\r
- (while (and (not found) rules)\r
- (if (recentf-match-rule-p (cdar rules) file-path)\r
- (let ((sub-menu (aref sub-menus index)))\r
- (setq found t)\r
- (recentf-set-menu-element-value\r
- sub-menu\r
- (cons menu-element (recentf-menu-element-value sub-menu)))\r
- ))\r
- (setq index (1+ index))\r
- (setq rules (cdr rules)))\r
- (or found\r
- (setq other-menu-elements\r
- (cons menu-element other-menu-elements)))\r
- (setq l (cdr l))))\r
- (setq index 0)\r
- (setq l nil)\r
- (setq min-size (if (integerp recentf-arrange-by-rules-min-items)\r
- (max 0 recentf-arrange-by-rules-min-items)\r
- 0))\r
- (while (< index sub-menus-number)\r
- (let* ((sub-menu (aref sub-menus index))\r
- (sub-menu-title (recentf-menu-element-item sub-menu))\r
- (sub-menu-elements (recentf-menu-element-value sub-menu))\r
- (sub-menu-length (length sub-menu-elements)))\r
- (if (> sub-menu-length 0)\r
- (cond\r
- ((< sub-menu-length min-size)\r
- (setq other-menu-elements\r
- (nconc sub-menu-elements other-menu-elements)))\r
- ((>= sub-menu-length min-size)\r
- (recentf-set-menu-element-item\r
- sub-menu\r
- (format sub-menu-title sub-menu-length))\r
- (recentf-set-menu-element-value\r
- sub-menu\r
- (recentf-apply-menu-filter\r
- recentf-arrange-by-rule-subfilter\r
- (nreverse sub-menu-elements)))\r
- (setq l (cons sub-menu l)))))\r
- (setq index (1+ index))))\r
- (if (and (stringp recentf-arrange-by-rule-others)\r
- other-menu-elements)\r
- (setq l\r
- (nreverse\r
- (cons (recentf-make-menu-element\r
- (format recentf-arrange-by-rule-others\r
- (length other-menu-elements))\r
- (recentf-apply-menu-filter\r
- recentf-arrange-by-rule-subfilter\r
- (nreverse other-menu-elements)))\r
- l)))\r
- (setq l (nconc (nreverse l)\r
- (recentf-apply-menu-filter\r
- recentf-arrange-by-rule-subfilter\r
- (nreverse other-menu-elements)))))))\r
- l))\r
-\r
-(defun recentf-build-mode-rules ()\r
- "Convert `auto-mode-alist' to `recentf-arrange-rules' format."\r
- (let ((case-fold-search recentf-case-fold-search)\r
- (modes auto-mode-alist)\r
- regexp mode rule-name rule rules)\r
- (while modes\r
- (setq regexp (caar modes))\r
- (setq mode (cdar modes))\r
- (when (symbolp mode)\r
- (setq rule-name (symbol-name mode))\r
- (if (string-match "\\(.*\\)-mode$" rule-name)\r
- (setq rule-name (match-string 1 rule-name)))\r
- (setq rule-name (concat rule-name " (%d)"))\r
- (setq rule (assoc rule-name rules))\r
- (if rule\r
- (setcdr rule (cons regexp (cdr rule)))\r
- (setq rules (cons (list rule-name regexp) rules))))\r
- (setq modes (cdr modes)))\r
- ;; It is important to preserve auto-mode-alist order\r
- ;; to ensure the right file <-> mode association\r
- (nreverse rules)))\r
- \r
-(defun recentf-arrange-by-mode (l)\r
- "Filter the list of menu-elements L to build sub-menus for each\r
-major mode."\r
- (let ((recentf-arrange-rules (recentf-build-mode-rules))\r
- (recentf-arrange-by-rule-others "others (%d)"))\r
- (recentf-arrange-by-rule l)))\r
-\r
-(defun recentf-build-dir-rules (l)\r
- "Convert directories in the list of menu-elements L to rules in\r
-`recentf-arrange-rules' format."\r
- (let (dirs)\r
- (mapcar (function\r
- (lambda (e)\r
- (let ((dir (file-name-directory\r
- (recentf-menu-element-value e))))\r
- (or (member dir dirs)\r
- (setq dirs (cons dir dirs))))))\r
- l)\r
- (mapcar (function\r
- (lambda (d)\r
- (cons (concat d " (%d)")\r
- (concat "\\`" d))))\r
- (nreverse (sort dirs 'string-lessp)))))\r
-\r
-(defun recentf-file-name-nondir (l)\r
- "Filter the list of menu-elements L to show only filenames. This\r
-simplified version of `recentf-show-basenames' do not handle\r
-duplicates. It is used by `recentf-arrange-by-dir' as its\r
-`recentf-arrange-by-rule-subfilter'."\r
- (mapcar (function\r
- (lambda (e)\r
- (recentf-make-menu-element\r
- (file-name-nondirectory (recentf-menu-element-value e))\r
- (recentf-menu-element-value e))))\r
- l))\r
-\r
-(defun recentf-arrange-by-dir (l)\r
- "Filter the list of menu-elements L to build sub-menus for each\r
-directory."\r
- (let ((recentf-arrange-rules (recentf-build-dir-rules l))\r
- (recentf-arrange-by-rule-subfilter 'recentf-file-name-nondir)\r
- recentf-arrange-by-rule-others)\r
- (nreverse (recentf-arrange-by-rule l))))\r
-\r
-(defvar recentf-filter-changer-state nil\r
- "Used by `recentf-filter-changer' to hold its state.")\r
-\r
-(defcustom recentf-filter-changer-alist\r
- '(\r
- (recentf-arrange-by-mode . "*Files by Mode*")\r
- (recentf-arrange-by-dir . "*Files by Directory*")\r
- (recentf-arrange-by-rule . "*Files by User Rule*")\r
- )\r
- "*List of filters managed by `recentf-filter-changer'.\r
-Each filter is defined by a pair (FILTER-FUN . FILTER-LBL) where:\r
-\r
-- - FILTER-FUN is the function that filters menu-elements\r
-- - FILTER-LBL is the menu item used to activate the filter"\r
- :group 'recentf-filters\r
- :type '(repeat (cons function string))\r
- :set (lambda (sym val)\r
- (setq recentf-filter-changer-state nil)\r
- (recentf-menu-customization-changed sym val)))\r
-\r
-(defun recentf-filter-changer-goto-next ()\r
- "Go to the next filter available (see `recentf-filter-changer')."\r
- (and (consp recentf-filter-changer-state)\r
- (setq recentf-filter-changer-state\r
- (cdr recentf-filter-changer-state)))\r
- (setq recentf-update-menu-p t))\r
-\r
-(defun recentf-filter-changer-get-current ()\r
- "Get the current filter available (see `recentf-filter-changer')."\r
- (if (null recentf-filter-changer-state)\r
- (setq recentf-filter-changer-state recentf-filter-changer-alist))\r
- (and (consp recentf-filter-changer-state)\r
- (car recentf-filter-changer-state)))\r
-\r
-(defun recentf-filter-changer-get-next ()\r
- "Get the next filter available (see `recentf-filter-changer')."\r
- (let ((filters recentf-filter-changer-state))\r
- (cond ((consp filters)\r
- (setq filters (cdr filters))\r
- (if (null filters)\r
- (setq filters recentf-filter-changer-alist)))\r
- (t\r
- (setq filters recentf-filter-changer-alist)\r
- (if (consp filters)\r
- (setq filters (cdr filters)))))\r
- (if (consp filters)\r
- (car filters))))\r
- \r
-(defun recentf-filter-changer (l)\r
- "Manage a ring of filters. `recentf-filter-changer-alist' defines\r
-the filters in the ring. Actual filtering of L is delegated to the\r
-current filter in the ring. A filter menu item is displayed allowing\r
-to dynamically activate the next filter in the ring. If the filter\r
-ring is empty L is left unchanged."\r
- (let ((current-filter-item (recentf-filter-changer-get-current))\r
- (next-filter-item (recentf-filter-changer-get-next)))\r
- (when current-filter-item\r
- (setq l (recentf-apply-menu-filter (car current-filter-item) l))\r
- (if next-filter-item\r
- (setq recentf-menu-filter-commands\r
- (list (vector (cdr next-filter-item)\r
- '(recentf-filter-changer-goto-next)\r
- t)))))\r
- l))\r
-\r
-;;;\r
-;;; Dialogs stuff\r
-;;;\r
-\r
-(defun recentf-cancel-dialog (&rest ignore)\r
- "Cancel the current dialog. Used by `recentf-edit-list' and\r
-`recentf-open-files' dialogs."\r
- (interactive)\r
- (kill-buffer (current-buffer))\r
- (message "Dialog canceled."))\r
-\r
-(defvar recentf-dialog-mode-map nil\r
- "`recentf-dialog-mode' keymap.")\r
-\r
-(if recentf-dialog-mode-map\r
- ()\r
- (setq recentf-dialog-mode-map (make-sparse-keymap))\r
- (define-key recentf-dialog-mode-map "q" 'recentf-cancel-dialog)\r
- (set-keymap-parent recentf-dialog-mode-map widget-keymap))\r
-\r
-(defun recentf-dialog-mode ()\r
- "Major mode used in recentf dialogs.\r
-\r
-These are the special commands of recentf-dialog-mode mode:\r
- q -- cancel this dialog."\r
- (interactive)\r
- (setq major-mode 'recentf-dialog-mode)\r
- (setq mode-name "recentf-dialog")\r
- (use-local-map recentf-dialog-mode-map))\r
-\r
-;;;\r
-;;; Hooks and Commands\r
-;;;\r
-\r
-(defun recentf-add-file-hook ()\r
- "Insert the name of the file just opened or written into `recentf-list'."\r
- (and buffer-file-name (recentf-add-file buffer-file-name))\r
- nil)\r
-\r
-(defun recentf-remove-file-hook ()\r
- "When a buffer is killed remove a non readable file from `recentf-list'."\r
- (and buffer-file-name (recentf-remove-if-non-readable buffer-file-name))\r
- nil)\r
-\r
-(defun recentf-update-menu-hook ()\r
- "Update the recentf menu from the current `recentf-list'."\r
- (when recentf-update-menu-p\r
- (condition-case nil\r
- (progn\r
- (setq recentf-update-menu-p nil)\r
- (easy-menu-change recentf-menu-path\r
- recentf-menu-title\r
- (recentf-make-menu-items)\r
- recentf-menu-before))\r
- (error nil))))\r
-\r
-(defun recentf-dump-variable (variable &optional limit)\r
- "Insert a \"(setq VARIABLE value)\" in the current buffer. Optional\r
-argument LIMIT specifies a maximum length when VARIABLE value is a\r
-list (default to the full list)."\r
- (let ((value (symbol-value variable)))\r
- (insert (format "(setq %S\n '(\n" variable))\r
- (cond ((consp value)\r
- (if (and (integerp limit) (> limit 0))\r
- (setq value (recentf-trunc-list value limit)))\r
- (mapcar (function\r
- (lambda (e)\r
- (insert (format " %S\n" e))))\r
- value))\r
- (t\r
- (insert (format " %S\n" value))))\r
- (insert " ))\n")\r
- ))\r
-\r
-;;;###autoload\r
-(defun recentf-save-list ()\r
- "Save the current `recentf-list' to the file `recentf-save-file'."\r
- (interactive)\r
- (with-temp-buffer\r
- (erase-buffer)\r
- (insert (format recentf-save-file-header (current-time-string)))\r
- (recentf-dump-variable 'recentf-list recentf-max-saved-items)\r
- (recentf-dump-variable 'recentf-filter-changer-state)\r
- (if (file-writable-p recentf-save-file)\r
- (write-region (point-min) (point-max) recentf-save-file))\r
- (kill-buffer (current-buffer)))\r
- nil)\r
-\r
-(defvar recentf-edit-selected-items nil\r
- "Used by `recentf-edit-list' to hold the list of files to be deleted\r
-from `recentf-list'.")\r
-\r
-(defun recentf-edit-list-action (widget &rest ignore)\r
- "Checkbox widget action used by `recentf-edit-list' to select/unselect a file."\r
- (let ((value (widget-get widget ':tag)))\r
- ;; if value is already in the selected items\r
- (if (memq value recentf-edit-selected-items)\r
- ;; then remove it\r
- (progn\r
- (setq recentf-edit-selected-items\r
- (delq value recentf-edit-selected-items))\r
- (message "%s removed from selection." value))\r
- ;; else add it\r
- (progn\r
- (setq recentf-edit-selected-items\r
- (nconc (list value) recentf-edit-selected-items))\r
- (message "%s added to selection." value)))))\r
- \r
-;;;###autoload\r
-(defun recentf-edit-list ()\r
- "Allow the user to edit the files that are kept in the recent list."\r
- (interactive)\r
- (with-current-buffer (get-buffer-create (concat "*" recentf-menu-title " - Edit list*"))\r
- (switch-to-buffer (current-buffer))\r
- (kill-all-local-variables)\r
- (let ((inhibit-read-only t))\r
- (erase-buffer))\r
- (let ((all (overlay-lists)))\r
- ;; Delete all the overlays.\r
- (mapcar 'delete-overlay (car all))\r
- (mapcar 'delete-overlay (cdr all)))\r
- (setq recentf-edit-selected-items nil)\r
- ;; Insert the dialog header\r
- (widget-insert "Select the files to be deleted from the 'recentf-list'.\n\n")\r
- (widget-insert "Click on Ok to update the list. ")\r
- (widget-insert "Click on Cancel or type \"q\" to quit.\n")\r
- ;; Insert the list of files as checkboxes\r
- (mapcar (function\r
- (lambda (item)\r
- (widget-create 'checkbox\r
- :value nil ; unselected checkbox\r
- :format "\n %[%v%] %t"\r
- :tag item\r
- :notify 'recentf-edit-list-action)))\r
- recentf-list)\r
- (widget-insert "\n\n")\r
- ;; Insert the Ok button\r
- (widget-create 'push-button\r
- :notify (lambda (&rest ignore)\r
- (if recentf-edit-selected-items\r
- (progn (kill-buffer (current-buffer))\r
- (mapcar (function\r
- (lambda (item)\r
- (setq recentf-list\r
- (delq item recentf-list))))\r
- recentf-edit-selected-items)\r
- (message "%S file(s) removed from the list"\r
- (length recentf-edit-selected-items))\r
- (setq recentf-update-menu-p t))\r
- (message "No file selected.")))\r
- "Ok")\r
- (widget-insert " ")\r
- ;; Insert the Cancel button\r
- (widget-create 'push-button\r
- :notify 'recentf-cancel-dialog\r
- "Cancel")\r
- (recentf-dialog-mode)\r
- (widget-setup)\r
- (goto-char (point-min))))\r
-\r
-;;;###autoload\r
-(defun recentf-cleanup ()\r
- "Remove all non-readable and excluded files from `recentf-list'."\r
- (interactive)\r
- (let ((count (length recentf-list)))\r
- (setq recentf-list\r
- (delq nil\r
- (mapcar (function\r
- (lambda (filename)\r
- (and (file-readable-p filename)\r
- (recentf-include-p filename)\r
- filename)))\r
- recentf-list)))\r
- (setq count (- count (length recentf-list)))\r
- (message "%s removed from the list"\r
- (cond ((= count 0) "No file")\r
- ((= count 1) "One file")\r
- (t (format "%d files" count)))))\r
- (setq recentf-update-menu-p t))\r
-\r
-(defun recentf-open-files-action (widget &rest ignore)\r
- "Button widget action used by `recentf-open-files' to open a file."\r
- (kill-buffer (current-buffer))\r
- (funcall recentf-menu-action (widget-value widget)))\r
-\r
-(defvar recentf-open-files-item-shift ""\r
- "String used by `recentf-open-files' to shift right sub-menu\r
-items.")\r
-\r
-(defun recentf-open-files-item (menu-element)\r
- "Function called by `recentf-open-files' to insert a menu-element\r
-item in the current interaction buffer."\r
- (let ((menu-item (car menu-element))\r
- (file-path (cdr menu-element)))\r
- (if (consp file-path) ; This is a sub-menu\r
- (let* ((shift recentf-open-files-item-shift)\r
- (recentf-open-files-item-shift (concat shift " ")))\r
- (widget-create 'item\r
- :tag menu-item\r
- :sample-face 'bold\r
- :format (concat shift "%{%t%}:\n"))\r
- (mapcar 'recentf-open-files-item\r
- file-path)\r
- (widget-insert "\n"))\r
- (widget-create 'push-button\r
- :button-face 'default\r
- :tag menu-item\r
- :help-echo (concat "Open " file-path)\r
- :format (concat recentf-open-files-item-shift "%[%t%]")\r
- :notify 'recentf-open-files-action\r
- file-path)\r
- (widget-insert "\n"))))\r
-\r
-;;;###autoload\r
-(defun recentf-open-files (&optional files buffer-name)\r
- "Open a buffer that allows the user to choose a file to open from\r
-the list of recently opened files. The optional argument FILES may be\r
-used to specify the list, otherwise recentf-list is used. The optional\r
-argument BUFFER-NAME specifies which buffer to use for the interaction."\r
- (interactive)\r
- (if (null files)\r
- (setq files recentf-list))\r
- (if (null buffer-name)\r
- (setq buffer-name (concat "*" recentf-menu-title "*")))\r
- (with-current-buffer (get-buffer-create buffer-name)\r
- (switch-to-buffer (current-buffer))\r
- (kill-all-local-variables)\r
- (let ((inhibit-read-only t))\r
- (erase-buffer))\r
- (let ((all (overlay-lists)))\r
- ;; Delete all the overlays.\r
- (mapcar 'delete-overlay (car all))\r
- (mapcar 'delete-overlay (cdr all)))\r
- ;; Insert the dialog header\r
- (widget-insert "Click on a file to open it. ")\r
- (widget-insert "Click on Cancel or type \"q\" to quit.\n\n" )\r
- ;; Insert the list of files as buttons\r
- (let ((recentf-open-files-item-shift ""))\r
- (mapcar 'recentf-open-files-item\r
- (recentf-apply-menu-filter\r
- recentf-menu-filter\r
- (mapcar 'recentf-make-default-menu-element files))))\r
- (widget-insert "\n")\r
- ;; Insert the Cancel button\r
- (widget-create 'push-button\r
- :notify 'recentf-cancel-dialog\r
- "Cancel")\r
- (recentf-dialog-mode)\r
- (widget-setup)\r
- (goto-char (point-min))))\r
-\r
-;;;###autoload\r
-(defun recentf-open-more-files ()\r
- "Allow the user to open files that are not in the menu."\r
- (interactive)\r
- (recentf-open-files (nthcdr recentf-max-menu-items recentf-list)\r
- (concat "*" recentf-menu-title " - More*")))\r
-\r
-;;;###autoload\r
-(defun recentf-mode (&optional arg)\r
- "Toggle recentf mode.\r
-With prefix ARG, turn recentf mode on if and only if ARG is positive.\r
-Returns the new status of recentf mode (non-nil means on).\r
-\r
-When recentf mode is enabled, it maintains a menu for visiting files that\r
-were operated on recently."\r
- (interactive "P")\r
- (let ((on-p (if arg\r
- (> (prefix-numeric-value arg) 0)\r
- (not recentf-mode))))\r
- (if on-p\r
- (unless recentf-initialized-p\r
- (setq recentf-initialized-p t)\r
- (if (file-readable-p recentf-save-file)\r
- (load-file recentf-save-file))\r
- (setq recentf-update-menu-p t)\r
- (add-hook 'find-file-hooks 'recentf-add-file-hook)\r
- (add-hook 'write-file-hooks 'recentf-add-file-hook)\r
- (add-hook 'menu-bar-update-hook 'recentf-update-menu-hook)\r
- (add-hook 'kill-emacs-hook 'recentf-save-list))\r
- (when recentf-initialized-p\r
- (setq recentf-initialized-p nil)\r
- (recentf-save-list)\r
- (easy-menu-remove-item nil recentf-menu-path recentf-menu-title)\r
- (remove-hook 'find-file-hooks 'recentf-add-file-hook)\r
- (remove-hook 'write-file-hooks 'recentf-add-file-hook)\r
- (remove-hook 'menu-bar-update-hook 'recentf-update-menu-hook)\r
- (remove-hook 'kill-emacs-hook 'recentf-save-list)))\r
- (setq recentf-mode on-p)))\r
-\r
-(provide 'recentf)\r
-\r
-(run-hooks 'recentf-load-hook)\r
-\r
-;;; recentf.el ends here.\r
+;;; recentf.el --- setup a menu of recently opened files
+
+;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
+;; 2005 Free Software Foundation, Inc.
+
+;; Author: David Ponce <david@dponce.com>
+;; Created: July 19 1999
+;; Keywords: files
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published
+;; by the Free Software Foundation; either version 2, or (at your
+;; option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+
+;; This package maintains a menu for visiting files that were operated
+;; on recently. When enabled a new "Open Recent" sub menu is
+;; displayed in the "Files" menu. The recent files list is
+;; automatically saved across Emacs sessions. You can customize the
+;; number of recent files displayed, the location of the menu and
+;; others options (see the source code for details).
+
+;;; History:
+;;
+
+;;; Code:
+(require 'easymenu)
+(require 'tree-widget)
+(require 'timer)
+
+;;; Internal data
+;;
+(defvar recentf-list nil
+ "List of recently opened files.")
+
+(defvar recentf-data-cache nil
+ "Cache of data used to build the recentf menu.
+The menu is rebuilt when this data has changed.")
+\f
+;;; Customization
+;;
+(defgroup recentf nil
+ "Maintain a menu of recently opened files."
+ :version "21.1"
+ :group 'files)
+
+(defgroup recentf-filters nil
+ "Group to customize recentf menu filters.
+You should define the options of your own filters in this group."
+ :group 'recentf)
+
+(defcustom recentf-max-saved-items 20
+ "*Maximum number of items of the recent list that will be saved.
+A nil value means to save the whole list.
+See the command `recentf-save-list'."
+ :group 'recentf
+ :type 'integer)
+
+(defcustom recentf-save-file "~/.recentf"
+ "*File to save the recent list into."
+ :group 'recentf
+ :type 'file)
+
+(defcustom recentf-save-file-modes 384 ;; 0600
+ "Mode bits of recentf save file, as an integer, or nil.
+If non-nil, after writing `recentf-save-file', set its mode bits to
+this value. By default give R/W access only to the user who owns that
+file. See also the function `set-file-modes'."
+ :group 'recentf
+ :type '(choice (const :tag "Don't change" nil)
+ integer))
+
+(defcustom recentf-exclude nil
+ "*List of regexps and predicates for filenames excluded from the recent list.
+When a filename matches any of the regexps or satisfies any of the
+predicates it is excluded from the recent list.
+A predicate is a function that is passed a filename to check and that
+must return non-nil to exclude it."
+ :group 'recentf
+ :type '(repeat (choice regexp function)))
+
+(defcustom recentf-keep
+ '(file-readable-p)
+ "*List of regexps and predicates for filenames kept in the recent list.
+Regexps and predicates are tried in the specified order.
+When nil all filenames are kept in the recent list.
+When a filename matches any of the regexps or satisfies any of the
+predicates it is kept in the recent list.
+The default is to keep readable files.
+A predicate is a function that is passed a filename to check and that
+must return non-nil to keep it. For example, you can add the
+`file-remote-p' predicate in front of this list to keep remote file
+names in the recent list without checking their readability through a
+remote access."
+ :group 'recentf
+ :type '(repeat (choice regexp function)))
+
+(defun recentf-menu-customization-changed (variable value)
+ "Function called when the recentf menu customization has changed.
+Set VARIABLE with VALUE, and force a rebuild of the recentf menu."
+ (when (featurep 'recentf)
+ ;; Unavailable until recentf has been loaded.
+ (recentf-clear-data))
+ (set-default variable value))
+
+(defcustom recentf-menu-title "Open Recent"
+ "*Name of the recentf menu."
+ :group 'recentf
+ :type 'string
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-menu-path '("File")
+ "*Path where to add the recentf menu.
+If nil add it at top level (see also `easy-menu-add-item')."
+ :group 'recentf
+ :type '(choice (const :tag "Top Level" nil)
+ (sexp :tag "Menu Path"))
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-menu-before "Open File..."
+ "*Name of the menu before which the recentf menu will be added.
+If nil add it at end of menu (see also `easy-menu-add-item')."
+ :group 'recentf
+ :type '(choice (string :tag "Name")
+ (const :tag "Last" nil))
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-menu-action 'find-file
+ "*Function to invoke with a filename item of the recentf menu.
+The default is to call `find-file' to edit the selected file."
+ :group 'recentf
+ :type 'function
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-max-menu-items 10
+ "*Maximum number of items in the recentf menu."
+ :group 'recentf
+ :type 'integer
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-menu-filter nil
+ "*Function used to filter files displayed in the recentf menu.
+A nil value means no filter. The following functions are predefined:
+
+- `recentf-sort-ascending'
+ Sort menu items in ascending order.
+- `recentf-sort-descending'
+ Sort menu items in descending order.
+- `recentf-sort-basenames-ascending'
+ Sort menu items by filenames sans directory in ascending order.
+- `recentf-sort-basenames-descending'
+ Sort menu items by filenames sans directory in descending order.
+- `recentf-sort-directories-ascending'
+ Sort menu items by directories in ascending order.
+- `recentf-sort-directories-descending'
+ Sort menu items by directories in descending order.
+- `recentf-show-basenames'
+ Show filenames sans directory in menu items.
+- `recentf-show-basenames-ascending'
+ Show filenames sans directory in ascending order.
+- `recentf-show-basenames-descending'
+ Show filenames sans directory in descending order.
+- `recentf-relative-filter'
+ Show filenames relative to `default-directory'.
+- `recentf-arrange-by-rule'
+ Show sub-menus following user defined rules.
+- `recentf-arrange-by-mode'
+ Show a sub-menu for each major mode.
+- `recentf-arrange-by-dir'
+ Show a sub-menu for each directory.
+- `recentf-filter-changer'
+ Manage a ring of filters.
+
+The filter function is called with one argument, the list of menu
+elements used to build the menu and must return a new list of menu
+elements (see `recentf-make-menu-element' for menu element form)."
+ :group 'recentf
+ :type '(radio (const nil)
+ (function-item recentf-sort-ascending)
+ (function-item recentf-sort-descending)
+ (function-item recentf-sort-basenames-ascending)
+ (function-item recentf-sort-basenames-descending)
+ (function-item recentf-sort-directories-ascending)
+ (function-item recentf-sort-directories-descending)
+ (function-item recentf-show-basenames)
+ (function-item recentf-show-basenames-ascending)
+ (function-item recentf-show-basenames-descending)
+ (function-item recentf-relative-filter)
+ (function-item recentf-arrange-by-rule)
+ (function-item recentf-arrange-by-mode)
+ (function-item recentf-arrange-by-dir)
+ (function-item recentf-filter-changer)
+ function)
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-menu-open-all-flag nil
+ "*Non-nil means to show an \"All...\" item in the menu.
+This item will replace the \"More...\" item."
+ :group 'recentf
+ :type 'boolean
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-menu-append-commands-flag t
+ "*Non-nil means to append command items to the menu."
+ :group 'recentf
+ :type 'boolean
+ :set 'recentf-menu-customization-changed)
+
+(define-obsolete-variable-alias 'recentf-menu-append-commands-p
+ 'recentf-menu-append-commands-flag
+ "22.1")
+
+(defcustom recentf-auto-cleanup 'mode
+ "*Define when to automatically cleanup the recent list.
+The following values can be set:
+
+- `mode'
+ Cleanup when turning the mode on (default).
+- `never'
+ Never cleanup the list automatically.
+- A number
+ Cleanup each time Emacs has been idle that number of seconds.
+- A time string
+ Cleanup at specified time string, for example at \"11:00pm\".
+
+Setting this variable directly does not take effect;
+use \\[customize].
+
+See also the command `recentf-cleanup', that can be used to manually
+cleanup the list."
+ :group 'recentf
+ :type '(radio (const :tag "When mode enabled"
+ :value mode)
+ (const :tag "Never"
+ :value never)
+ (number :tag "When idle that seconds"
+ :value 300)
+ (string :tag "At time"
+ :value "11:00pm"))
+ :set (lambda (variable value)
+ (set-default variable value)
+ (when (featurep 'recentf)
+ ;; Unavailable until recentf has been loaded.
+ (recentf-auto-cleanup))))
+
+(defcustom recentf-initialize-file-name-history t
+ "*Non-nil means to initialize `file-name-history' with the recent list.
+If `file-name-history' is not empty, do nothing."
+ :group 'recentf
+ :type 'boolean)
+
+(defcustom recentf-load-hook nil
+ "*Normal hook run at end of loading the `recentf' package."
+ :group 'recentf
+ :type 'hook)
+
+(defcustom recentf-filename-handlers nil
+ "Functions to post process recent file names.
+They are successively passed a file name to transform it."
+ :group 'recentf
+ :type '(choice
+ (const :tag "None" nil)
+ (repeat :tag "Functions"
+ (choice
+ (const file-truename)
+ (const abbreviate-file-name)
+ (function :tag "Other function")))))
+
+(defcustom recentf-show-file-shortcuts-flag t
+ "Whether to show ``[N]'' for the Nth item up to 10.
+If non-nil, `recentf-open-files' will show labels for keys that can be
+used as shortcuts to open the Nth file."
+ :group 'recentf
+ :type 'boolean)
+\f
+;;; Utilities
+;;
+(defconst recentf-case-fold-search
+ (memq system-type '(vax-vms windows-nt cygwin))
+ "Non-nil if recentf searches and matches should ignore case.")
+
+(defsubst recentf-string-equal (s1 s2)
+ "Return non-nil if strings S1 and S2 have identical contents.
+Ignore case if `recentf-case-fold-search' is non-nil."
+ (if recentf-case-fold-search
+ (string-equal (downcase s1) (downcase s2))
+ (string-equal s1 s2)))
+
+(defsubst recentf-string-lessp (s1 s2)
+ "Return non-nil if string S1 is less than S2 in lexicographic order.
+Ignore case if `recentf-case-fold-search' is non-nil."
+ (if recentf-case-fold-search
+ (string-lessp (downcase s1) (downcase s2))
+ (string-lessp s1 s2)))
+
+(defun recentf-string-member (elt list)
+ "Return non-nil if ELT is an element of LIST.
+The value is actually the tail of LIST whose car is ELT.
+ELT must be a string and LIST a list of strings.
+Ignore case if `recentf-case-fold-search' is non-nil."
+ (while (and list (not (recentf-string-equal elt (car list))))
+ (setq list (cdr list)))
+ list)
+
+(defsubst recentf-trunc-list (l n)
+ "Return from L the list of its first N elements."
+ (let (nl)
+ (while (and l (> n 0))
+ (setq nl (cons (car l) nl)
+ n (1- n)
+ l (cdr l)))
+ (nreverse nl)))
+
+(defun recentf-dump-variable (variable &optional limit)
+ "Insert a \"(setq VARIABLE value)\" in the current buffer.
+When the value of VARIABLE is a list, optional argument LIMIT
+specifies a maximum number of elements to insert. By default insert
+the full list."
+ (let ((value (symbol-value variable)))
+ (if (atom value)
+ (insert (format "\n(setq %S %S)\n" variable value))
+ (when (and (integerp limit) (> limit 0))
+ (setq value (recentf-trunc-list value limit)))
+ (insert (format "\n(setq %S\n '(" variable))
+ (dolist (e value)
+ (insert (format "\n %S" e)))
+ (insert "\n ))\n"))))
+
+(defvar recentf-auto-cleanup-timer nil
+ "Timer used to automatically cleanup the recent list.
+See also the option `recentf-auto-cleanup'.")
+
+(defun recentf-auto-cleanup ()
+ "Automatic cleanup of the recent list."
+ (when (timerp recentf-auto-cleanup-timer)
+ (cancel-timer recentf-auto-cleanup-timer))
+ (when recentf-mode
+ (setq recentf-auto-cleanup-timer
+ (cond
+ ((eq 'mode recentf-auto-cleanup)
+ (recentf-cleanup)
+ nil)
+ ((numberp recentf-auto-cleanup)
+ (run-with-idle-timer
+ recentf-auto-cleanup t 'recentf-cleanup))
+ ((stringp recentf-auto-cleanup)
+ (run-at-time
+ recentf-auto-cleanup nil 'recentf-cleanup))))))
+\f
+;;; File functions
+;;
+(defsubst recentf-push (filename)
+ "Push FILENAME into the recent list, if it isn't there yet.
+If it is there yet, move it at the beginning of the list.
+If `recentf-case-fold-search' is non-nil, ignore case when comparing
+filenames."
+ (let ((m (recentf-string-member filename recentf-list)))
+ (and m (setq recentf-list (delq (car m) recentf-list)))
+ (push filename recentf-list)))
+
+(defun recentf-apply-filename-handlers (name)
+ "Apply `recentf-filename-handlers' to file NAME.
+Return the transformed file name, or NAME if any handler failed, or
+returned nil."
+ (or (condition-case nil
+ (let ((handlers recentf-filename-handlers)
+ (filename name))
+ (while (and filename handlers)
+ (setq filename (funcall (car handlers) filename)
+ handlers (cdr handlers)))
+ filename)
+ (error nil))
+ name))
+
+(defsubst recentf-expand-file-name (name)
+ "Convert file NAME to absolute, and canonicalize it.
+NAME is first passed to the function `expand-file-name', then to
+`recentf-filename-handlers' to post process it."
+ (recentf-apply-filename-handlers (expand-file-name name)))
+
+(defun recentf-include-p (filename)
+ "Return non-nil if FILENAME should be included in the recent list.
+That is, if it doesn't match any of the `recentf-exclude' checks."
+ (let ((case-fold-search recentf-case-fold-search)
+ (checks recentf-exclude)
+ (keepit t))
+ (while (and checks keepit)
+ (setq keepit (condition-case nil
+ (not (if (stringp (car checks))
+ ;; A regexp
+ (string-match (car checks) filename)
+ ;; A predicate
+ (funcall (car checks) filename)))
+ (error nil))
+ checks (cdr checks)))
+ keepit))
+
+(defun recentf-keep-p (filename)
+ "Return non-nil if FILENAME should be kept in the recent list.
+That is, if it matches any of the `recentf-keep' checks."
+ (let* ((case-fold-search recentf-case-fold-search)
+ (checks recentf-keep)
+ (keepit (null checks)))
+ (while (and checks (not keepit))
+ (setq keepit (condition-case nil
+ (if (stringp (car checks))
+ ;; A regexp
+ (string-match (car checks) filename)
+ ;; A predicate
+ (funcall (car checks) filename))
+ (error nil))
+ checks (cdr checks)))
+ keepit))
+
+(defsubst recentf-add-file (filename)
+ "Add or move FILENAME at the beginning of the recent list.
+Does nothing if the name satisfies any of the `recentf-exclude'
+regexps or predicates."
+ (setq filename (recentf-expand-file-name filename))
+ (when (recentf-include-p filename)
+ (recentf-push filename)))
+
+(defsubst recentf-remove-if-non-kept (filename)
+ "Remove FILENAME from the recent list, if file is not kept.
+Return non-nil if FILENAME has been removed."
+ (unless (recentf-keep-p filename)
+ (let ((m (recentf-string-member
+ (recentf-expand-file-name filename) recentf-list)))
+ (and m (setq recentf-list (delq (car m) recentf-list))))))
+
+(defsubst recentf-directory-compare (f1 f2)
+ "Compare absolute filenames F1 and F2.
+First compare directories, then filenames sans directory.
+Return non-nil if F1 is less than F2."
+ (let ((d1 (file-name-directory f1))
+ (d2 (file-name-directory f2)))
+ (if (recentf-string-equal d1 d2)
+ (recentf-string-lessp (file-name-nondirectory f1)
+ (file-name-nondirectory f2))
+ (recentf-string-lessp d1 d2))))
+\f
+;;; Menu building
+;;
+(defsubst recentf-digit-shortcut-command-name (n)
+ "Return a command name to open the Nth most recent file.
+See also the command `recentf-open-most-recent-file'."
+ (intern (format "recentf-open-most-recent-file-%d" n)))
+
+(defvar recentf--shortcuts-keymap
+ (let ((km (make-sparse-keymap)))
+ (dolist (k '(0 9 8 7 6 5 4 3 2 1))
+ (let ((cmd (recentf-digit-shortcut-command-name k)))
+ ;; Define a shortcut command.
+ (defalias cmd
+ `(lambda ()
+ (interactive)
+ (recentf-open-most-recent-file ,k)))
+ ;; Bind it to a digit key.
+ (define-key km (vector (+ k ?0)) cmd)))
+ km)
+ "Digit shortcuts keymap.")
+
+(defvar recentf-menu-items-for-commands
+ (list
+ ["Cleanup list"
+ recentf-cleanup
+ :help "Remove duplicates, and obsoletes files from the recent list"
+ :active t]
+ ["Edit list..."
+ recentf-edit-list
+ :help "Manually remove files from the recent list"
+ :active t]
+ ["Save list now"
+ recentf-save-list
+ :help "Save the list of recently opened files now"
+ :active t]
+ ["Options..."
+ (customize-group "recentf")
+ :help "Customize recently opened files menu and options"
+ :active t]
+ )
+ "List of menu items for recentf commands.")
+
+(defvar recentf-menu-filter-commands nil
+ "This variable can be used by menu filters to setup their own command menu.
+If non-nil it must contain a list of valid menu-items to be appended
+to the recent file list part of the menu. Before calling a menu
+filter function this variable is reset to nil.")
+
+(defsubst recentf-elements (n)
+ "Return a list of the first N elements of the recent list."
+ (recentf-trunc-list recentf-list n))
+
+(defsubst recentf-make-menu-element (menu-item menu-value)
+ "Create a new menu-element.
+A menu element is a pair (MENU-ITEM . MENU-VALUE), where MENU-ITEM is
+the menu item string displayed. MENU-VALUE is the file to be open
+when the corresponding MENU-ITEM is selected. Or it is a
+pair (SUB-MENU-TITLE . MENU-ELEMENTS) where SUB-MENU-TITLE is a
+sub-menu title and MENU-ELEMENTS is the list of menu elements in the
+sub-menu."
+ (cons menu-item menu-value))
+
+(defsubst recentf-menu-element-item (e)
+ "Return the item part of the menu-element E."
+ (car e))
+
+(defsubst recentf-menu-element-value (e)
+ "Return the value part of the menu-element E."
+ (cdr e))
+
+(defsubst recentf-set-menu-element-item (e item)
+ "Change the item part of menu-element E to ITEM."
+ (setcar e item))
+
+(defsubst recentf-set-menu-element-value (e value)
+ "Change the value part of menu-element E to VALUE."
+ (setcdr e value))
+
+(defsubst recentf-sub-menu-element-p (e)
+ "Return non-nil if menu-element E defines a sub-menu."
+ (consp (recentf-menu-element-value e)))
+
+(defsubst recentf-make-default-menu-element (file)
+ "Make a new default menu element with FILE.
+This a menu element (FILE . FILE)."
+ (recentf-make-menu-element file file))
+
+(defsubst recentf-menu-elements (n)
+ "Return a list of the first N default menu elements from the recent list.
+See also `recentf-make-default-menu-element'."
+ (mapcar 'recentf-make-default-menu-element
+ (recentf-elements n)))
+
+(defun recentf-apply-menu-filter (filter l)
+ "Apply function FILTER to the list of menu-elements L.
+It takes care of sub-menu elements in L and recursively apply FILTER
+to them. It is guaranteed that FILTER receives only a list of single
+menu-elements (no sub-menu)."
+ (if (and l (functionp filter))
+ (let ((case-fold-search recentf-case-fold-search)
+ elts others)
+ ;; split L into two sub-listes, one of sub-menus elements and
+ ;; another of single menu elements.
+ (dolist (elt l)
+ (if (recentf-sub-menu-element-p elt)
+ (push elt elts)
+ (push elt others)))
+ ;; Apply FILTER to single elements.
+ (when others
+ (setq others (funcall filter (nreverse others))))
+ ;; Apply FILTER to sub-menu elements.
+ (setq l nil)
+ (dolist (elt elts)
+ (recentf-set-menu-element-value
+ elt (recentf-apply-menu-filter
+ filter (recentf-menu-element-value elt)))
+ (push elt l))
+ ;; Return the new filtered menu element list.
+ (nconc l others))
+ l))
+
+;; Count the number of assigned menu shortcuts.
+(defvar recentf-menu-shortcuts)
+
+(defun recentf-make-menu-items ()
+ "Make menu items from the recent list."
+ (setq recentf-menu-filter-commands nil)
+ (let* ((recentf-menu-shortcuts 0)
+ (file-items
+ (mapcar 'recentf-make-menu-item
+ (recentf-apply-menu-filter
+ recentf-menu-filter
+ (recentf-menu-elements recentf-max-menu-items)))))
+ (append (or file-items (list ["No files" t
+ :help "No recent file to open"
+ :active nil]))
+ (if recentf-menu-open-all-flag
+ (list ["All..." recentf-open-files
+ :help "Open recent files through a dialog"
+ :active t])
+ (and (< recentf-max-menu-items (length recentf-list))
+ (list ["More..." recentf-open-more-files
+ :help "Open files not in the menu through a dialog"
+ :active t])))
+ (and recentf-menu-filter-commands
+ (cons "---"
+ recentf-menu-filter-commands))
+ (and recentf-menu-append-commands-flag
+ (cons "---"
+ recentf-menu-items-for-commands)))))
+
+(defun recentf-menu-value-shortcut (name)
+ "Return a shorcut digit for file NAME.
+Return nil if file NAME is not one of the ten more recent."
+ (let ((i 0) k)
+ (while (and (not k) (< i 10))
+ (if (string-equal name (nth i recentf-list))
+ (progn
+ (setq recentf-menu-shortcuts (1+ recentf-menu-shortcuts))
+ (setq k (% (1+ i) 10)))
+ (setq i (1+ i))))
+ k))
+
+(defun recentf-make-menu-item (elt)
+ "Make a menu item from menu element ELT."
+ (let ((item (recentf-menu-element-item elt))
+ (value (recentf-menu-element-value elt)))
+ (if (recentf-sub-menu-element-p elt)
+ (cons item (mapcar 'recentf-make-menu-item value))
+ (let ((k (and (< recentf-menu-shortcuts 10)
+ (recentf-menu-value-shortcut value))))
+ (vector item
+ ;; If the file name is one of the ten more recent, use
+ ;; a digit shortcut command to open it, else use an
+ ;; anonymous command.
+ (if k
+ (recentf-digit-shortcut-command-name k)
+ `(lambda ()
+ (interactive)
+ (,recentf-menu-action ,value)))
+ :help (concat "Open " value)
+ :active t)))))
+
+(defsubst recentf-menu-bar ()
+ "Return the keymap of the global menu bar."
+ (lookup-key global-map [menu-bar]))
+
+(defun recentf-clear-data ()
+ "Clear data used to build the recentf menu.
+This forces a rebuild of the menu."
+ (easy-menu-remove-item (recentf-menu-bar)
+ recentf-menu-path recentf-menu-title)
+ (setq recentf-data-cache nil))
+\f
+;;; Predefined menu filters
+;;
+(defsubst recentf-sort-ascending (l)
+ "Sort the list of menu elements L in ascending order.
+The MENU-ITEM part of each menu element is compared."
+ (sort (copy-sequence l)
+ #'(lambda (e1 e2)
+ (recentf-string-lessp
+ (recentf-menu-element-item e1)
+ (recentf-menu-element-item e2)))))
+
+(defsubst recentf-sort-descending (l)
+ "Sort the list of menu elements L in descending order.
+The MENU-ITEM part of each menu element is compared."
+ (sort (copy-sequence l)
+ #'(lambda (e1 e2)
+ (recentf-string-lessp
+ (recentf-menu-element-item e2)
+ (recentf-menu-element-item e1)))))
+
+(defsubst recentf-sort-basenames-ascending (l)
+ "Sort the list of menu elements L in ascending order.
+Only filenames sans directory are compared."
+ (sort (copy-sequence l)
+ #'(lambda (e1 e2)
+ (recentf-string-lessp
+ (file-name-nondirectory (recentf-menu-element-value e1))
+ (file-name-nondirectory (recentf-menu-element-value e2))))))
+
+(defsubst recentf-sort-basenames-descending (l)
+ "Sort the list of menu elements L in descending order.
+Only filenames sans directory are compared."
+ (sort (copy-sequence l)
+ #'(lambda (e1 e2)
+ (recentf-string-lessp
+ (file-name-nondirectory (recentf-menu-element-value e2))
+ (file-name-nondirectory (recentf-menu-element-value e1))))))
+
+(defsubst recentf-sort-directories-ascending (l)
+ "Sort the list of menu elements L in ascending order.
+Compares directories then filenames to order the list."
+ (sort (copy-sequence l)
+ #'(lambda (e1 e2)
+ (recentf-directory-compare
+ (recentf-menu-element-value e1)
+ (recentf-menu-element-value e2)))))
+
+(defsubst recentf-sort-directories-descending (l)
+ "Sort the list of menu elements L in descending order.
+Compares directories then filenames to order the list."
+ (sort (copy-sequence l)
+ #'(lambda (e1 e2)
+ (recentf-directory-compare
+ (recentf-menu-element-value e2)
+ (recentf-menu-element-value e1)))))
+
+(defun recentf-show-basenames (l &optional no-dir)
+ "Filter the list of menu elements L to show filenames sans directory.
+When a filename is duplicated, it is appended a sequence number if
+optional argument NO-DIR is non-nil, or its directory otherwise."
+ (let (filtered-names filtered-list full name counters sufx)
+ (dolist (elt l (nreverse filtered-list))
+ (setq full (recentf-menu-element-value elt)
+ name (file-name-nondirectory full))
+ (if (not (member name filtered-names))
+ (push name filtered-names)
+ (if no-dir
+ (if (setq sufx (assoc name counters))
+ (setcdr sufx (1+ (cdr sufx)))
+ (setq sufx 1)
+ (push (cons name sufx) counters))
+ (setq sufx (file-name-directory full)))
+ (setq name (format "%s(%s)" name sufx)))
+ (push (recentf-make-menu-element name full) filtered-list))))
+
+(defsubst recentf-show-basenames-ascending (l)
+ "Filter the list of menu elements L to show filenames sans directory.
+Filenames are sorted in ascending order.
+This filter combines the `recentf-sort-basenames-ascending' and
+`recentf-show-basenames' filters."
+ (recentf-show-basenames (recentf-sort-basenames-ascending l)))
+
+(defsubst recentf-show-basenames-descending (l)
+ "Filter the list of menu elements L to show filenames sans directory.
+Filenames are sorted in descending order.
+This filter combines the `recentf-sort-basenames-descending' and
+`recentf-show-basenames' filters."
+ (recentf-show-basenames (recentf-sort-basenames-descending l)))
+
+(defun recentf-relative-filter (l)
+ "Filter the list of menu-elements L to show relative filenames.
+Filenames are relative to the `default-directory'."
+ (mapcar #'(lambda (menu-element)
+ (let* ((ful (recentf-menu-element-value menu-element))
+ (rel (file-relative-name ful default-directory)))
+ (if (string-match "^\\.\\." rel)
+ menu-element
+ (recentf-make-menu-element rel ful))))
+ l))
+\f
+;;; Rule based menu filters
+;;
+(defcustom recentf-arrange-rules
+ '(
+ ("Elisp files (%d)" ".\\.el$")
+ ("Java files (%d)" ".\\.java$")
+ ("C/C++ files (%d)" "c\\(pp\\)?$")
+ )
+ "*List of rules used by `recentf-arrange-by-rule' to build sub-menus.
+A rule is a pair (SUB-MENU-TITLE . MATCHER). SUB-MENU-TITLE is the
+displayed title of the sub-menu where a '%d' `format' pattern is
+replaced by the number of items in the sub-menu. MATCHER is a regexp
+or a list of regexps. Items matching one of the regular expressions in
+MATCHER are added to the corresponding sub-menu."
+ :group 'recentf-filters
+ :type '(repeat (cons string (repeat regexp)))
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-arrange-by-rule-others "Other files (%d)"
+ "*Title of the `recentf-arrange-by-rule' sub-menu.
+This is for the menu where items that don't match any
+`recentf-arrange-rules' are displayed. If nil these items are
+displayed in the main recent files menu. A '%d' `format' pattern in
+the title is replaced by the number of items in the sub-menu."
+ :group 'recentf-filters
+ :type '(choice (const :tag "Main menu" nil)
+ (string :tag "Title"))
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-arrange-by-rules-min-items 0
+ "*Minimum number of items in a `recentf-arrange-by-rule' sub-menu.
+If the number of items in a sub-menu is less than this value the
+corresponding sub-menu items are displayed in the main recent files
+menu or in the `recentf-arrange-by-rule-others' sub-menu if
+defined."
+ :group 'recentf-filters
+ :type 'number
+ :set 'recentf-menu-customization-changed)
+
+(defcustom recentf-arrange-by-rule-subfilter nil
+ "*Function called by a rule based filter to filter sub-menu elements.
+A nil value means no filter. See also `recentf-menu-filter'.
+You can't use another rule based filter here."
+ :group 'recentf-filters
+ :type '(choice (const nil) function)
+ :set (lambda (variable value)
+ (when (memq value '(recentf-arrange-by-rule
+ recentf-arrange-by-mode
+ recentf-arrange-by-dir))
+ (error "Recursive use of a rule based filter"))
+ (recentf-menu-customization-changed variable value)))
+
+(defun recentf-match-rule-p (matcher filename)
+ "Return non-nil if the rule specified by MATCHER match FILENAME.
+See `recentf-arrange-rules' for details on MATCHER."
+ (if (stringp matcher)
+ (string-match matcher filename)
+ (while (and (consp matcher)
+ (not (string-match (car matcher) filename)))
+ (setq matcher (cdr matcher)))
+ matcher))
+
+(defun recentf-arrange-by-rule (l)
+ "Filter the list of menu-elements L.
+Arrange them in sub-menus following rules in `recentf-arrange-rules'."
+ (if (not recentf-arrange-rules)
+ l
+ (let ((menus (mapcar #'(lambda (r) (list (car r)))
+ recentf-arrange-rules))
+ menu others min file rules elts count)
+ (dolist (elt l)
+ (setq file (recentf-menu-element-value elt)
+ rules recentf-arrange-rules
+ elts menus
+ menu nil)
+ (while (and (not menu) rules)
+ (when (recentf-match-rule-p (cdar rules) file)
+ (setq menu (car elts))
+ (recentf-set-menu-element-value
+ menu (cons elt (recentf-menu-element-value menu))))
+ (setq rules (cdr rules)
+ elts (cdr elts)))
+ (unless menu
+ (push elt others)))
+
+ (setq l nil
+ min (if (natnump recentf-arrange-by-rules-min-items)
+ recentf-arrange-by-rules-min-items 0))
+ (dolist (menu menus)
+ (when (setq elts (recentf-menu-element-value menu))
+ (setq count (length elts))
+ (if (< count min)
+ (setq others (nconc elts others))
+ (recentf-set-menu-element-item
+ menu (format (recentf-menu-element-item menu) count))
+ (recentf-set-menu-element-value
+ menu (recentf-apply-menu-filter
+ recentf-arrange-by-rule-subfilter (nreverse elts)))
+ (push menu l))))
+
+ (if (and (stringp recentf-arrange-by-rule-others) others)
+ (nreverse
+ (cons
+ (recentf-make-menu-element
+ (format recentf-arrange-by-rule-others (length others))
+ (recentf-apply-menu-filter
+ recentf-arrange-by-rule-subfilter (nreverse others)))
+ l))
+ (nconc
+ (nreverse l)
+ (recentf-apply-menu-filter
+ recentf-arrange-by-rule-subfilter (nreverse others)))))
+ ))
+\f
+;;; Predefined rule based menu filters
+;;
+(defun recentf-build-mode-rules ()
+ "Convert `auto-mode-alist' to menu filter rules.
+Rules obey `recentf-arrange-rules' format."
+ (let ((case-fold-search recentf-case-fold-search)
+ regexp rule-name rule rules)
+ (dolist (mode auto-mode-alist)
+ (setq regexp (car mode)
+ mode (cdr mode))
+ (when (symbolp mode)
+ (setq rule-name (symbol-name mode))
+ (if (string-match "\\(.*\\)-mode$" rule-name)
+ (setq rule-name (match-string 1 rule-name)))
+ (setq rule-name (concat rule-name " (%d)")
+ rule (assoc rule-name rules))
+ (if rule
+ (setcdr rule (cons regexp (cdr rule)))
+ (push (list rule-name regexp) rules))))
+ ;; It is important to preserve auto-mode-alist order
+ ;; to ensure the right file <-> mode association
+ (nreverse rules)))
+
+(defun recentf-arrange-by-mode (l)
+ "Split the list of menu-elements L into sub-menus by major mode."
+ (let ((recentf-arrange-rules (recentf-build-mode-rules))
+ (recentf-arrange-by-rule-others "others (%d)"))
+ (recentf-arrange-by-rule l)))
+
+(defun recentf-build-dir-rules (l)
+ "Convert directories in menu-elements L to menu filter rules.
+Rules obey `recentf-arrange-rules' format."
+ (let (dirs)
+ (mapcar #'(lambda (e)
+ (let ((dir (file-name-directory
+ (recentf-menu-element-value e))))
+ (or (recentf-string-member dir dirs)
+ (push dir dirs))))
+ l)
+ (mapcar #'(lambda (d)
+ (cons (concat d " (%d)")
+ (concat "\\`" d)))
+ (nreverse (sort dirs 'recentf-string-lessp)))))
+
+(defun recentf-file-name-nondir (l)
+ "Filter the list of menu-elements L to show filenames sans directory.
+This simplified version of `recentf-show-basenames' does not handle
+duplicates. It is used by `recentf-arrange-by-dir' as its
+`recentf-arrange-by-rule-subfilter'."
+ (mapcar #'(lambda (e)
+ (recentf-make-menu-element
+ (file-name-nondirectory (recentf-menu-element-value e))
+ (recentf-menu-element-value e)))
+ l))
+
+(defun recentf-arrange-by-dir (l)
+ "Split the list of menu-elements L into sub-menus by directory."
+ (let ((recentf-arrange-rules (recentf-build-dir-rules l))
+ (recentf-arrange-by-rule-subfilter 'recentf-file-name-nondir)
+ recentf-arrange-by-rule-others)
+ (nreverse (recentf-arrange-by-rule l))))
+\f
+;;; Ring of menu filters
+;;
+(defvar recentf-filter-changer-state nil
+ "Used by `recentf-filter-changer' to hold its state.")
+
+(defcustom recentf-filter-changer-alist
+ '(
+ (recentf-arrange-by-mode . "*Files by Mode*")
+ (recentf-arrange-by-dir . "*Files by Directory*")
+ (recentf-arrange-by-rule . "*Files by User Rule*")
+ )
+ "*List of filters managed by `recentf-filter-changer'.
+Each filter is defined by a pair (FUNCTION . LABEL), where FUNCTION is
+the filter function, and LABEL is the menu item displayed to select
+that filter."
+ :group 'recentf-filters
+ :type '(repeat (cons function string))
+ :set (lambda (variable value)
+ (setq recentf-filter-changer-state nil)
+ (recentf-menu-customization-changed variable value)))
+
+(defun recentf-filter-changer-goto-next ()
+ "Go to the next filter available.
+See `recentf-filter-changer'."
+ (setq recentf-filter-changer-state (cdr recentf-filter-changer-state))
+ (recentf-clear-data))
+
+(defsubst recentf-filter-changer-get-current ()
+ "Get the current filter available.
+See `recentf-filter-changer'."
+ (unless recentf-filter-changer-state
+ (setq recentf-filter-changer-state recentf-filter-changer-alist))
+ (car recentf-filter-changer-state))
+
+(defsubst recentf-filter-changer-get-next ()
+ "Get the next filter available.
+See `recentf-filter-changer'."
+ ;; At this point the current filter is the first element of
+ ;; `recentf-filter-changer-state'.
+ (car (or (cdr recentf-filter-changer-state)
+ ;; There is no next element in
+ ;; `recentf-filter-changer-state', so loop back to the
+ ;; first element of `recentf-filter-changer-alist'.
+ recentf-filter-changer-alist)))
+
+(defun recentf-filter-changer (l)
+ "Manage a ring of menu filters.
+`recentf-filter-changer-alist' defines the filters in the ring.
+Filtering of L is delegated to the current filter in the ring. A
+filter menu item is displayed allowing to dynamically activate the
+next filter in the ring. If the filter ring is empty, L is left
+unchanged."
+ (let ((filter (recentf-filter-changer-get-current)))
+ (when filter
+ (setq l (recentf-apply-menu-filter (car filter) l)
+ filter (recentf-filter-changer-get-next))
+ (when filter
+ (setq recentf-menu-filter-commands
+ (list (vector (cdr filter)
+ '(recentf-filter-changer-goto-next)
+ t)))))
+ l))
+\f
+;;; Hooks
+;;
+(defun recentf-track-opened-file ()
+ "Insert the name of the file just opened or written into the recent list."
+ (and buffer-file-name
+ (recentf-add-file buffer-file-name))
+ ;; Must return nil because it is run from `write-file-functions'.
+ nil)
+
+(defun recentf-track-closed-file ()
+ "Update the recent list when a buffer is killed.
+That is, remove a non kept file from the recent list."
+ (and buffer-file-name
+ (recentf-remove-if-non-kept buffer-file-name)))
+
+(defun recentf-update-menu ()
+ "Update the recentf menu from the current recent list."
+ (let ((cache (cons default-directory recentf-list)))
+ ;; Does nothing, if nothing has changed.
+ (unless (equal recentf-data-cache cache)
+ (setq recentf-data-cache cache)
+ (condition-case err
+ (easy-menu-add-item
+ (recentf-menu-bar) recentf-menu-path
+ (easy-menu-create-menu recentf-menu-title
+ (recentf-make-menu-items))
+ recentf-menu-before)
+ (error
+ (message "recentf update menu failed: %s"
+ (error-message-string err)))))))
+
+(defconst recentf-used-hooks
+ '(
+ (find-file-hook recentf-track-opened-file)
+ (write-file-functions recentf-track-opened-file)
+ (kill-buffer-hook recentf-track-closed-file)
+ (menu-bar-update-hook recentf-update-menu)
+ (kill-emacs-hook recentf-save-list)
+ )
+ "Hooks used by recentf.")
+
+(defsubst recentf-enabled-p ()
+ "Return non-nil if recentf mode is currently enabled."
+ (memq 'recentf-update-menu menu-bar-update-hook))
+\f
+;;; Commands
+;;
+
+;;; Common dialog stuff
+;;
+(defun recentf-cancel-dialog (&rest ignore)
+ "Cancel the current dialog.
+IGNORE arguments."
+ (interactive)
+ (kill-buffer (current-buffer))
+ (message "Dialog canceled"))
+
+(defun recentf-dialog-goto-first (widget-type)
+ "Move the cursor to the first WIDGET-TYPE in current dialog.
+Go to the beginning of buffer if not found."
+ (goto-char (point-min))
+ (condition-case nil
+ (let (done)
+ (widget-move 1)
+ (while (not done)
+ (if (eq widget-type (widget-type (widget-at (point))))
+ (setq done t)
+ (widget-move 1))))
+ (goto-char (point-min))))
+
+(defvar recentf-dialog-mode-map
+ (let ((km (copy-keymap recentf--shortcuts-keymap)))
+ (set-keymap-parent km widget-keymap)
+ (define-key km "q" 'recentf-cancel-dialog)
+ (define-key km [follow-link] "\C-m")
+ km)
+ "Keymap used in recentf dialogs.")
+
+(define-derived-mode recentf-dialog-mode nil "recentf-dialog"
+ "Major mode of recentf dialogs.
+
+\\{recentf-dialog-mode-map}"
+ :syntax-table nil
+ :abbrev-table nil
+ (setq truncate-lines t))
+
+(defmacro recentf-dialog (name &rest forms)
+ "Show a dialog buffer with NAME, setup with FORMS."
+ (declare (indent 1) (debug t))
+ `(with-current-buffer (get-buffer-create ,name)
+ ;; Cleanup buffer
+ (let ((inhibit-read-only t)
+ (ol (overlay-lists)))
+ (mapc 'delete-overlay (car ol))
+ (mapc 'delete-overlay (cdr ol))
+ (erase-buffer))
+ (recentf-dialog-mode)
+ ,@forms
+ (widget-setup)
+ (switch-to-buffer (current-buffer))))
+\f
+;;; Edit list dialog
+;;
+(defvar recentf-edit-list nil)
+
+(defun recentf-edit-list-select (widget &rest ignore)
+ "Toggle a file selection based on the checkbox WIDGET state.
+IGNORE other arguments."
+ (let ((value (widget-get widget :tag))
+ (check (widget-value widget)))
+ (if check
+ (add-to-list 'recentf-edit-list value)
+ (setq recentf-edit-list (delq value recentf-edit-list)))
+ (message "%s %sselected" value (if check "" "un"))))
+
+(defun recentf-edit-list-validate (&rest ignore)
+ "Process the recent list when the edit list dialog is committed.
+IGNORE arguments."
+ (if recentf-edit-list
+ (let ((i 0))
+ (dolist (e recentf-edit-list)
+ (setq recentf-list (delq e recentf-list)
+ i (1+ i)))
+ (kill-buffer (current-buffer))
+ (message "%S file(s) removed from the list" i)
+ (recentf-clear-data))
+ (message "No file selected")))
+
+(defun recentf-edit-list ()
+ "Show a dialog to delete selected files from the recent list."
+ (interactive)
+ (recentf-dialog (format "*%s - Edit list*" recentf-menu-title)
+ (set (make-local-variable 'recentf-edit-list) nil)
+ (widget-insert
+ "Click on OK to delete selected files from the recent list.
+Click on Cancel or type `q' to cancel.\n")
+ ;; Insert the list of files as checkboxes
+ (dolist (item recentf-list)
+ (widget-create 'checkbox
+ :value nil ; unselected checkbox
+ :format "\n %[%v%] %t"
+ :tag item
+ :notify 'recentf-edit-list-select))
+ (widget-insert "\n\n")
+ (widget-create
+ 'push-button
+ :notify 'recentf-edit-list-validate
+ :help-echo "Delete selected files from the recent list"
+ "Ok")
+ (widget-insert " ")
+ (widget-create
+ 'push-button
+ :notify 'recentf-cancel-dialog
+ "Cancel")
+ (recentf-dialog-goto-first 'checkbox)))
+\f
+;;; Open file dialog
+;;
+(defun recentf-open-files-action (widget &rest ignore)
+ "Open the file stored in WIDGET's value when notified.
+IGNORE other arguments."
+ (kill-buffer (current-buffer))
+ (funcall recentf-menu-action (widget-value widget)))
+
+;; List of files associated to a digit shortcut key.
+(defvar recentf--files-with-key nil)
+
+(defun recentf-show-digit-shortcut-filter (l)
+ "Filter the list of menu-elements L to show digit shortcuts."
+ (let ((i 0))
+ (dolist (e l)
+ (setq i (1+ i))
+ (recentf-set-menu-element-item
+ e (format "[%d] %s" (% i 10) (recentf-menu-element-item e))))
+ l))
+
+(defun recentf-open-files-item (menu-element)
+ "Return a widget to display MENU-ELEMENT in a dialog buffer."
+ (if (consp (cdr menu-element))
+ ;; Represent a sub-menu with a tree widget
+ `(tree-widget
+ :open t
+ :match ignore
+ :node (item :tag ,(car menu-element)
+ :sample-face bold
+ :format "%{%t%}:\n")
+ ,@(mapcar 'recentf-open-files-item
+ (cdr menu-element)))
+ ;; Represent a single file with a link widget
+ `(link :tag ,(car menu-element)
+ :button-prefix ""
+ :button-suffix ""
+ :button-face default
+ :format "%[%t%]\n"
+ :help-echo ,(concat "Open " (cdr menu-element))
+ :action recentf-open-files-action
+ ,(cdr menu-element))))
+
+(defun recentf-open-files-items (files)
+ "Return a list of widgets to display FILES in a dialog buffer."
+ (set (make-local-variable 'recentf--files-with-key)
+ (recentf-trunc-list files 10))
+ (mapcar 'recentf-open-files-item
+ (append
+ ;; When requested group the files with shortcuts together
+ ;; at the top of the list.
+ (when recentf-show-file-shortcuts-flag
+ (setq files (nthcdr 10 files))
+ (recentf-apply-menu-filter
+ 'recentf-show-digit-shortcut-filter
+ (mapcar 'recentf-make-default-menu-element
+ recentf--files-with-key)))
+ ;; Then the other files.
+ (recentf-apply-menu-filter
+ recentf-menu-filter
+ (mapcar 'recentf-make-default-menu-element
+ files)))))
+
+(defun recentf-open-files (&optional files buffer-name)
+ "Show a dialog to open a recent file.
+If optional argument FILES is non-nil, it is a list of recently-opened
+files to choose from. It defaults to the whole recent list.
+If optional argument BUFFER-NAME is non-nil, it is a buffer name to
+use for the dialog. It defaults to \"*`recentf-menu-title'*\"."
+ (interactive)
+ (recentf-dialog (or buffer-name (format "*%s*" recentf-menu-title))
+ (widget-insert "Click on a file"
+ (if recentf-show-file-shortcuts-flag
+ ", or type the corresponding digit key,"
+ "")
+ " to open it.\n"
+ "Click on Cancel or type `q' to cancel.\n")
+ ;; Use a L&F that looks like the recentf menu.
+ (tree-widget-set-theme "folder")
+ (apply 'widget-create
+ `(group
+ :indent 2
+ :format "\n%v\n"
+ ,@(recentf-open-files-items (or files recentf-list))))
+ (widget-create
+ 'push-button
+ :notify 'recentf-cancel-dialog
+ "Cancel")
+ (recentf-dialog-goto-first 'link)))
+
+(defun recentf-open-more-files ()
+ "Show a dialog to open a recent file that is not in the menu."
+ (interactive)
+ (recentf-open-files (nthcdr recentf-max-menu-items recentf-list)
+ (format "*%s - More*" recentf-menu-title)))
+
+(defun recentf-open-most-recent-file (&optional n)
+ "Open the Nth most recent file.
+Optional argument N must be a valid digit number. It defaults to 1.
+1 opens the most recent file, 2 the second most recent one, etc..
+0 opens the tenth most recent file."
+ (interactive "p")
+ (cond
+ ((zerop n) (setq n 10))
+ ((and (> n 0) (< n 10)))
+ ((error "Recent file number out of range [0-9], %d" n)))
+ (let ((file (nth (1- n) (or recentf--files-with-key recentf-list))))
+ (unless file (error "Not that many recent files"))
+ ;; Close the open files dialog.
+ (when recentf--files-with-key
+ (kill-buffer (current-buffer)))
+ (funcall recentf-menu-action file)))
+\f
+;;; Save/load/cleanup the recent list
+;;
+(defconst recentf-save-file-header
+ ";;; Automatically generated by `recentf' on %s.\n"
+ "Header to be written into the `recentf-save-file'.")
+
+(defconst recentf-save-file-coding-system
+ (if (coding-system-p 'utf-8-emacs)
+ 'utf-8-emacs
+ 'emacs-mule)
+ "Coding system of the file `recentf-save-file'.")
+
+(defun recentf-save-list ()
+ "Save the recent list.
+Write data into the file specified by `recentf-save-file'."
+ (interactive)
+ (condition-case error
+ (with-temp-buffer
+ (erase-buffer)
+ (set-buffer-file-coding-system recentf-save-file-coding-system)
+ (insert (format recentf-save-file-header (current-time-string)))
+ (recentf-dump-variable 'recentf-list recentf-max-saved-items)
+ (recentf-dump-variable 'recentf-filter-changer-state)
+ (insert "\n\f\n;;; Local Variables:\n"
+ (format ";;; coding: %s\n" recentf-save-file-coding-system)
+ ";;; End:\n")
+ (write-file (expand-file-name recentf-save-file))
+ (when recentf-save-file-modes
+ (set-file-modes recentf-save-file recentf-save-file-modes))
+ nil)
+ (error
+ (warn "recentf mode: %s" (error-message-string error)))))
+
+(defun recentf-load-list ()
+ "Load a previously saved recent list.
+Read data from the file specified by `recentf-save-file'.
+When `recentf-initialize-file-name-history' is non-nil, initialize an
+empty `file-name-history' with the recent list."
+ (interactive)
+ (let ((file (expand-file-name recentf-save-file)))
+ (when (file-readable-p file)
+ (load-file file)
+ (and recentf-initialize-file-name-history
+ (not file-name-history)
+ (setq file-name-history (mapcar 'abbreviate-file-name
+ recentf-list))))))
+
+(defun recentf-cleanup ()
+ "Cleanup the recent list.
+That is, remove duplicates, non-kept, and excluded files."
+ (interactive)
+ (message "Cleaning up the recentf list...")
+ (let ((n 0) newlist)
+ (dolist (f recentf-list)
+ (setq f (recentf-expand-file-name f))
+ (if (and (recentf-include-p f)
+ (recentf-keep-p f)
+ (not (recentf-string-member f newlist)))
+ (push f newlist)
+ (setq n (1+ n))
+ (message "File %s removed from the recentf list" f)))
+ (message "Cleaning up the recentf list...done (%d removed)" n)
+ (setq recentf-list (nreverse newlist))))
+\f
+;;; The minor mode
+;;
+(defvar recentf-mode-map (make-sparse-keymap)
+ "Keymap to use in recentf mode.")
+
+;;;###autoload
+(define-minor-mode recentf-mode
+ "Toggle recentf mode.
+With prefix argument ARG, turn on if positive, otherwise off.
+Returns non-nil if the new state is enabled.
+
+When recentf mode is enabled, it maintains a menu for visiting files
+that were operated on recently.
+
+\\{recentf-mode-map}"
+ :global t
+ :group 'recentf
+ :keymap recentf-mode-map
+ (unless (and recentf-mode (recentf-enabled-p))
+ (if recentf-mode
+ (recentf-load-list)
+ (recentf-save-list))
+ (recentf-auto-cleanup)
+ (recentf-clear-data)
+ (let ((hook-setup (if recentf-mode 'add-hook 'remove-hook)))
+ (dolist (hook recentf-used-hooks)
+ (apply hook-setup hook)))
+ (run-hooks 'recentf-mode-hook)
+ (when (interactive-p)
+ (message "Recentf mode %sabled" (if recentf-mode "en" "dis"))))
+ recentf-mode)
+
+(provide 'recentf)
+
+(run-hooks 'recentf-load-hook)
+\f
+;; arch-tag: 78f1eec9-0d16-4d19-a4eb-2e4529edb62a
+;;; recentf.el ends here
HCoop / bpt / emacs.git / blobdiff