-;;; 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, 2002, 2003, 2004, 2005,
+;; 2006 Free Software Foundation, Inc.
-;;; Author: Sam Steingold <sds@usa.net>
-;;; Maintainer: Sam Steingold <sds@usa.net>
-;;; Created: 1998-05-18
-;;; Keywords: utilities
+;; Author: Sam Steingold <sds@usa.net>
+;; Maintainer: Sam Steingold <sds@usa.net>
+;; Created: 1998-05-18
+;; Keywords: utilities
;; This file is part of GNU Emacs.
;; 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:
;; 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)
;;; 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)
+(defun midnight-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)))
+ (with-current-buffer (or buf (current-buffer))
(when buffer-display-time (float-time buffer-display-time))))
;;; clean-buffer-list stuff
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*"
- "*vc*" "*vc-diff*")
+ "*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
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)))))
+ (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.
clean-buffer-list-delay-special)
(* clean-buffer-list-delay-general 24 60 60)))
+;;;###autoload
(defun clean-buffer-list ()
"Kill old buffers that have not been displayed recently.
-The relevant vartiables are `clean-buffer-list-delay-general',
+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'.")
-(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
(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
(provide 'midnight)
+;;; arch-tag: a5979be9-2890-46a3-ba84-791f0a4a6e80
;;; midnight.el ends here