X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/849ac8351dc494cdeedbbb9f68b724952210b7af..b83813ec2214046e9a2448058d4ede8e0062c0c4:/lisp/midnight.el diff --git a/lisp/midnight.el b/lisp/midnight.el index fd9867daaa..b20d7eed33 100644 --- a/lisp/midnight.el +++ b/lisp/midnight.el @@ -1,11 +1,12 @@ -;;; midnight.el --- run something every midnight, e.g., kill old buffers. +;;; midnight.el --- run something every midnight, e.g., kill old buffers -;;; Copyright (C) 1998 Free Software Foundation, Inc. +;; Copyright (C) 1998, 2001, 2002, 2003, 2004, 2005, +;; 2006, 2007 Free Software Foundation, Inc. -;;; Author: Sam Steingold -;;; Maintainer: Sam Steingold -;;; Created: 1998-05-18 -;;; Keywords: utilities +;; Author: Sam Steingold +;; Maintainer: Sam Steingold +;; Created: 1998-05-18 +;; Keywords: utilities ;; This file is part of GNU Emacs. @@ -21,8 +22,8 @@ ;; 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., 59 Temple Place - Suite 330, -;; Boston, MA 02111-1307, USA. +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: @@ -36,22 +37,31 @@ ;; keeping `clean-buffer-list-kill-never-buffer-names' and ;; `clean-buffer-list-kill-never-regexps'. +;;; Code: + (eval-when-compile - (require 'cl) - (require 'timer)) + (require 'cl)) + +(require 'timer) (defgroup midnight nil "Run something every day at midnight." :group 'calendar :version "20.3") -(defcustom midnight-mode t +(defvar midnight-timer nil + "Timer running the `midnight-hook' `midnight-delay' seconds after midnight. +Use `cancel-timer' to stop it and `midnight-delay-set' to change +the time when it is run.") + +(defcustom midnight-mode nil "*Non-nil means run `midnight-hook' at midnight. Setting this variable outside customize has no effect; call `cancel-timer' or `timer-activate' on `midnight-timer' instead." :type 'boolean :group 'midnight :require 'midnight + :initialize 'custom-initialize-default :set (lambda (symb val) (set symb val) (require 'midnight) (if val (timer-activate midnight-timer) @@ -59,21 +69,15 @@ call `cancel-timer' or `timer-activate' on `midnight-timer' instead." ;;; time conversion -(defun float-time (&optional tm) - "Convert `current-time' to a float number of seconds." - (multiple-value-bind (s0 s1 s2) (or tm (current-time)) - (+ (* (float (ash 1 16)) s0) (float s1) (* 0.0000001 s2)))) - -(defun time-float (num) +(defun midnight-time-float (num) "Convert the float number of seconds since epoch to the list of 3 integers." (let* ((div (ash 1 16)) (1st (floor num div))) (list 1st (floor (- num (* (float div) 1st))) (round (* 10000000 (mod num 1)))))) -(defun buffer-display-time (&optional buf) - "Return the time-stamp of the given buffer, or current buffer, as float." - (save-excursion - (set-buffer (or buf (current-buffer))) +(defun midnight-buffer-display-time (&optional buffer) + "Return the time-stamp of BUFFER, or current buffer, as float." + (with-current-buffer (or buffer (current-buffer)) (when buffer-display-time (float-time buffer-display-time)))) ;;; clean-buffer-list stuff @@ -95,114 +99,107 @@ displayed more than this many seconds ago." :type 'integer :group 'midnight) -(defcustom clean-buffer-list-kill-regexps '("\\*vc\\.") +(defcustom clean-buffer-list-kill-regexps nil "*List of regexps saying which buffers will be killed at midnight. If buffer name matches a regexp in the list and the buffer was not displayed in the last `clean-buffer-list-delay-special' seconds, it is killed by `clean-buffer-list' when is it in `midnight-hook'. -If a member of the list is a cons, it's `car' is the regexp and its `cdr' is +If a member of the list is a cons, its `car' is the regexp and its `cdr' is the number of seconds to use instead of `clean-buffer-list-delay-special'. See also `clean-buffer-list-kill-buffer-names', `clean-buffer-list-kill-never-regexps' and `clean-buffer-list-kill-never-buffer-names'." - :type 'list + :type '(repeat (regexp :tag "Regexp matching Buffer Name")) :group 'midnight) (defcustom clean-buffer-list-kill-buffer-names - '("*Help*" "*Apropos*" "*Man " "*Buffer List*" "*Compile-Log*" "*info*") + '("*Help*" "*Apropos*" "*Man " "*Buffer List*" "*Compile-Log*" "*info*" + "*vc*" "*vc-diff*" "*diff*") "*List of strings saying which buffers will be killed at midnight. Buffers with names in this list, which were not displayed in the last `clean-buffer-list-delay-special' seconds, are killed by `clean-buffer-list' when is it in `midnight-hook'. -If a member of the list is a cons, it's `car' is the name and its `cdr' is +If a member of the list is a cons, its `car' is the name and its `cdr' is the number of seconds to use instead of `clean-buffer-list-delay-special'. See also `clean-buffer-list-kill-regexps', `clean-buffer-list-kill-never-regexps' and `clean-buffer-list-kill-never-buffer-names'." - :type 'list + :type '(repeat (string :tag "Buffer Name")) :group 'midnight) (defcustom clean-buffer-list-kill-never-buffer-names - '("*scratch*" "*Messages*") + '("*scratch*" "*Messages*" "*server*") "*List of buffer names which will never be killed by `clean-buffer-list'. See also `clean-buffer-list-kill-never-regexps'. Note that this does override `clean-buffer-list-kill-regexps' and `clean-buffer-list-kill-buffer-names' so a buffer matching any of these two lists will NOT be killed if it is also present in this list." - :type 'list + :type '(repeat (string :tag "Buffer Name")) :group 'midnight) - -(defcustom clean-buffer-list-kill-never-regexps '("^ \*Minibuf-.*\*$") +(defcustom clean-buffer-list-kill-never-regexps '("^ \\*Minibuf-.*\\*$") "*List of regexp saying which buffers will never be killed at midnight. See also `clean-buffer-list-kill-never-buffer-names'. Killing is done by `clean-buffer-list'. Note that this does override `clean-buffer-list-kill-regexps' and `clean-buffer-list-kill-buffer-names' so a buffer matching any of these two lists will NOT be killed if it also matches anything in this list." - :type 'list + :type '(repeat (regexp :tag "Regexp matching Buffer Name")) :group 'midnight) (defun midnight-find (el ls test &optional key) "A stopgap solution to the absence of `find' in ELisp." - (if (fboundp 'find) - (find el ls :test test :key (or key 'eql)) - (dolist (rr ls) - (when (funcall test el (if key (funcall key rr) rr)) - (return rr))))) - -(defun assoc-default (el alist test default) - "Find object EL in a pseudo-alist ALIST. -ALIST is a list of conses or objects. EL is compared (using TEST) with -CAR (or the object itself, if it is not a cons) of elements of ALIST. -When TEST returns non-nil, CDR (or DEFAULT, if the object is not a cons) -of the object is returned. -This is a non-consing analogue of - (cdr (assoc el (mapcar (lambda (el) (if (consp el) el (cons el default))) - alist) - :test test)) -The calling sequence is: (ASSOC-DEFAULT EL ALIST TEST DEFAULT)" - (dolist (rr alist) - (when (funcall test el (if (consp rr) (car rr) rr)) - (return (if (consp rr) (cdr rr) default))))) - -(defun clean-buffer-list-delay (bn) - "Return the delay, in seconds, before this buffer name is auto-killed. + (dolist (rr ls) + (when (funcall test (if key (funcall key rr) rr) el) + (return rr)))) + +(defun clean-buffer-list-delay (name) + "Return the delay, in seconds, before killing a buffer named NAME. Uses `clean-buffer-list-kill-buffer-names', `clean-buffer-list-kill-regexps' `clean-buffer-list-delay-general' and `clean-buffer-list-delay-special'. Autokilling is done by `clean-buffer-list'." - (or (assoc-default bn clean-buffer-list-kill-buffer-names 'string= + (or (assoc-default name clean-buffer-list-kill-buffer-names 'string= clean-buffer-list-delay-special) - (assoc-default bn clean-buffer-list-kill-regexps 'string-match + (assoc-default name clean-buffer-list-kill-regexps 'string-match clean-buffer-list-delay-special) (* clean-buffer-list-delay-general 24 60 60))) +;;;###autoload (defun clean-buffer-list () - "Kill old buffers. -The relevant vartiables are `clean-buffer-list-delay-general', + "Kill old buffers that have not been displayed recently. +The relevant variables are `clean-buffer-list-delay-general', `clean-buffer-list-delay-special', `clean-buffer-list-kill-buffer-names', `clean-buffer-list-kill-never-buffer-names', -`clean-buffer-list-kill-regexps' and `clean-buffer-list-kill-never-regexps'." +`clean-buffer-list-kill-regexps' and +`clean-buffer-list-kill-never-regexps'. +While processing buffers, this procedure displays messages containing +the current date/time, buffer name, how many seconds ago it was +displayed (can be nil if the buffer was never displayed) and its +lifetime, i.e., its \"age\" when it will be purged." (interactive) - (let ((tm (float-time)) bts (ts (format-time-string "%Y-%m-%d %T")) bn) + (let ((tm (float-time)) bts (ts (format-time-string "%Y-%m-%d %T")) + delay cbld bn) (dolist (buf (buffer-list)) - (message "[%s] processing `%s'..." ts buf) - (setq bts (buffer-display-time buf) bn (buffer-name buf)) - (unless (or (midnight-find bn clean-buffer-list-kill-never-regexps - 'string-match) - (midnight-find bn clean-buffer-list-kill-never-buffer-names - 'string-equal) - (buffer-modified-p buf) (get-buffer-window buf 'visible) - (null bts) (< (- tm bts) (clean-buffer-list-delay bn))) - (message "[%s] killing `%s'" ts bn) - (kill-buffer buf))))) + (when (buffer-live-p buf) + (setq bts (midnight-buffer-display-time buf) bn (buffer-name buf) + delay (if bts (- tm bts) 0) cbld (clean-buffer-list-delay bn)) + (message "[%s] `%s' [%s %d]" ts bn (if bts (round delay)) cbld) + (unless (or (midnight-find bn clean-buffer-list-kill-never-regexps + 'string-match) + (midnight-find bn clean-buffer-list-kill-never-buffer-names + 'string-equal) + (get-buffer-process buf) + (and (buffer-file-name buf) (buffer-modified-p buf)) + (get-buffer-window buf 'visible) (< delay cbld)) + (message "[%s] killing `%s'" ts bn) + (kill-buffer buf)))))) ;;; midnight hook (defvar midnight-period (* 24 60 60) - "The number of seconds in a day - the delta for `midnight-timer'.") + "The number of seconds in a day--the delta for `midnight-timer'.") -(defcustom midnight-hook 'clean-buffer-list +(defcustom midnight-hook '(clean-buffer-list) "The hook run `midnight-delay' seconds after midnight every day. The default value is `clean-buffer-list'." :type 'hook @@ -213,28 +210,18 @@ The default value is `clean-buffer-list'." (multiple-value-bind (sec min hrs) (decode-time) (- (* 24 60 60) (* 60 60 hrs) (* 60 min) sec))) -(defvar midnight-timer nil - "Timer running the `midnight-hook' `midnight-delay' seconds after midnight. -Use `cancel-timer' to stop it and `midnight-delay-set' to change -the time when it is run.") - ;;;###autoload (defun midnight-delay-set (symb tm) "Modify `midnight-timer' according to `midnight-delay'. -Sets the first argument (which must be symbol `midnight-delay') -to its second argument." - (unless (eq symb 'midnight-delay) - (error "Illegal argument to `midnight-delay-set': `%s'" symb)) +Sets the first argument SYMB (which must be symbol `midnight-delay') +to its second argument TM." + (assert (eq symb 'midnight-delay) t + "Invalid argument to `midnight-delay-set': `%s'") (set symb tm) (when (timerp midnight-timer) (cancel-timer midnight-timer)) (setq midnight-timer (run-at-time (if (numberp tm) (+ (midnight-next) tm) tm) - midnight-period 'midnight-timer-function))) - -(defun midnight-timer-function () - "This is the function run by the `midnight-mode' timer once each day." - (when midnight-mode - (run-hooks 'midnight-hook))) + midnight-period 'run-hooks 'midnight-hook))) (defcustom midnight-delay 3600 "*The number of seconds after the midnight when the `midnight-timer' is run. @@ -248,4 +235,5 @@ first argument to `run-at-time'." (provide 'midnight) +;;; arch-tag: a5979be9-2890-46a3-ba84-791f0a4a6e80 ;;; midnight.el ends here