;; keeping `clean-buffer-list-kill-never-buffer-names' and
;; `clean-buffer-list-kill-never-regexps'.
-(eval-when-compile (require 'cl))
+;;; Code:
+
+(eval-when-compile
+ (require 'cl))
+
+(require 'timer)
(defgroup midnight nil
"Run something every day at midnight."
- :group 'calendar)
+ :group 'calendar
+ :version "20.3")
+
+(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)
+ (cancel-timer midnight-timer))))
;;; time conversion
-(defun float-time (&optional tm)
+(defun midnight-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)))
- (when buffer-display-time (float-time buffer-display-time))))
+ (when buffer-display-time (midnight-float-time buffer-display-time))))
;;; clean-buffer-list stuff
matching `clean-buffer-list-kill-never-buffer-names' and
`clean-buffer-list-kill-never-regexps' are excluded."
:type 'integer
- :group 'midnight
- :version "20.3")
+ :group 'midnight)
(defcustom clean-buffer-list-delay-special 3600
"*The number of seconds before some buffers become eligible for autokilling.
`clean-buffer-list-kill-buffer-names' are killed if they were last
displayed more than this many seconds ago."
:type 'integer
- :group 'midnight
- :version "20.3")
+ :group 'midnight)
(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
- :group 'midnight
- :version "20.3")
+ :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
- :group 'midnight
- :version "20.3")
+ :type '(repeat (string :tag "Buffer Name"))
+ :group 'midnight)
(defcustom clean-buffer-list-kill-never-buffer-names
'("*scratch*" "*Messages*")
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
- :group 'midnight
- :version "20.3")
+ :type '(repeat (string :tag "Buffer Name"))
+ :group 'midnight)
+
(defcustom clean-buffer-list-kill-never-regexps '("^ \*Minibuf-.*\*$")
"*List of regexp saying which buffers will never be killed at midnight.
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
- :group 'midnight
- :version "20.3")
+ :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))
- (loop for rr in ls when (funcall test el (if key (funcall key rr) rr))
- return rr)))
+ (dolist (rr ls)
+ (when (funcall test el (if key (funcall key rr) rr))
+ (return rr))))
-(defun clean-buffer-list-delay (bn)
- "Return the delay, in seconds, before this buffer name is auto-killed.
+(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'."
- (flet ((ff (ls ts)
- (let ((zz (midnight-find
- bn ls ts (lambda (xx) (if (consp xx) (car xx) xx)))))
- (cond ((consp zz) (cdr zz))
- ((null zz) nil)
- (clean-buffer-list-delay-special)))))
- (or (ff clean-buffer-list-kill-buffer-names 'string=)
- (ff clean-buffer-list-kill-regexps 'string-match)
- (* clean-buffer-list-delay-general 24 60 60))))
+ (or (assoc-default name clean-buffer-list-kill-buffer-names 'string=
+ clean-buffer-list-delay-special)
+ (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)
- (dolist (buf (buffer-list))
- (message "[%s] processing `%s'..." ts buf)
- (setq bts (buffer-display-time buf) bn (buffer-name buf))
- (unless (or ;; (string-match clean-buffer-list-kill-never bn)
- (midnight-find bn clean-buffer-list-kill-never-regexps
+ (let ((tm (midnight-float-time)) bts (ts (format-time-string "%Y-%m-%d %T"))
+ (bufs (buffer-list)) buf delay cbld bn)
+ (while (setq buf (pop bufs))
+ (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)
- (buffer-modified-p buf) (get-buffer-window buf 'visible)
- (null bts) (< (- tm bts) (clean-buffer-list-delay bn)))
+ (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
- :group 'midnight
- :version "20.3")
+ :group 'midnight)
(defun midnight-next ()
"Return the number of seconds till the next midnight."
;;;###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
+ "Illegal argument to `midnight-delay-set': `%s'" symb)
(set symb tm)
(when (timerp midnight-timer) (cancel-timer midnight-timer))
(setq midnight-timer
first argument to `run-at-time'."
:type 'sexp
:set 'midnight-delay-set
- :group 'midnight
- :version "20.3")
+ :group 'midnight)
(provide 'midnight)
HCoop / bpt / emacs.git / blobdiff