mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-21 06:55:39 +00:00
228 lines
9.9 KiB
EmacsLisp
228 lines
9.9 KiB
EmacsLisp
;;; midnight.el --- run something every midnight, e.g., kill old buffers -*- lexical-binding:t -*-
|
|
|
|
;; Copyright (C) 1998-2024 Free Software Foundation, Inc.
|
|
|
|
;; Author: Sam Steingold <sds@gnu.org>
|
|
;; Created: 1998-05-18
|
|
;; Keywords: utilities
|
|
|
|
;; 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 3 of the License, 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. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; To use the file, put (midnight-mode) into your .emacs. Then, at
|
|
;; midnight, Emacs will run the normal hook `midnight-hook'. You can
|
|
;; put whatever you like there, say, `calendar'; by default there is
|
|
;; only one function there - `clean-buffer-list'. It will kill the
|
|
;; buffers matching `clean-buffer-list-kill-buffer-names' and
|
|
;; `clean-buffer-list-kill-regexps' and the buffers which where last
|
|
;; displayed more than `clean-buffer-list-delay-general' days ago,
|
|
;; keeping `clean-buffer-list-kill-never-buffer-names' and
|
|
;; `clean-buffer-list-kill-never-regexps'.
|
|
|
|
;;; Code:
|
|
|
|
(require 'cl-lib)
|
|
|
|
(defgroup midnight nil
|
|
"Run something every day at midnight."
|
|
:group 'calendar
|
|
:version "20.3")
|
|
|
|
(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
|
|
(define-minor-mode midnight-mode
|
|
"Non-nil means run `midnight-hook' at midnight."
|
|
:global t
|
|
:initialize #'custom-initialize-default
|
|
;; Call `midnight-delay-set' again because it takes care of starting
|
|
;; the timer if the mode is on. The ':initialize' function above
|
|
;; (which ends up calling `midnight-delay-set') did not know yet if
|
|
;; the mode was on or not.
|
|
(defvar midnight-delay)
|
|
(midnight-delay-set 'midnight-delay midnight-delay))
|
|
|
|
;;; clean-buffer-list stuff
|
|
|
|
(defcustom clean-buffer-list-delay-general 3
|
|
"The number of days before any buffer becomes eligible for autokilling.
|
|
The autokilling is done by `clean-buffer-list' when it is in `midnight-hook'.
|
|
Currently displayed and/or modified (unsaved) buffers, as well as buffers
|
|
matching `clean-buffer-list-kill-never-buffer-names' and
|
|
`clean-buffer-list-kill-never-regexps' are excluded."
|
|
:type 'natnum)
|
|
|
|
(defcustom clean-buffer-list-delay-special 3600
|
|
"The number of seconds before some buffers become eligible for autokilling.
|
|
Buffers matched by `clean-buffer-list-kill-regexps' and
|
|
`clean-buffer-list-kill-buffer-names' are killed if they were last
|
|
displayed more than this many seconds ago."
|
|
:type 'natnum)
|
|
|
|
(defcustom clean-buffer-list-kill-regexps '("\\`\\*Man ")
|
|
"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 it is in `midnight-hook'.
|
|
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'.
|
|
|
|
Each element can also be a function instead of a regexp, in which case
|
|
it takes a single argument (a buffer name) and should return non-nil
|
|
if the buffer should be killed by `clean-buffer-list'."
|
|
:type '(repeat
|
|
(choice (regexp :tag "Regexp matching Buffer Name")
|
|
(function :tag "Predicate function"))))
|
|
|
|
(defcustom clean-buffer-list-kill-buffer-names
|
|
'("*Help*" "*Apropos*" "*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 it is in `midnight-hook'.
|
|
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 '(repeat (string :tag "Buffer Name")))
|
|
|
|
(defcustom clean-buffer-list-kill-never-buffer-names
|
|
'("*scratch*" "*Messages*")
|
|
"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 '(repeat (string :tag "Buffer Name")))
|
|
|
|
(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.
|
|
|
|
Each element can also be a function instead of a regexp, in which case
|
|
it takes a single argument (a buffer name) and should return non-nil
|
|
if the buffer should never be killed by `clean-buffer-list'."
|
|
:type '(repeat
|
|
(choice (regexp :tag "Regexp matching Buffer Name")
|
|
(function :tag "Predicate function"))))
|
|
|
|
(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 name clean-buffer-list-kill-buffer-names #'string=
|
|
clean-buffer-list-delay-special)
|
|
(assoc-default name clean-buffer-list-kill-regexps
|
|
(lambda (re str)
|
|
(if (functionp re)
|
|
(funcall re str) (string-match re str)))
|
|
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 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'.
|
|
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 (current-time)) bts (ts (format-time-string "%Y-%m-%d %T" tm))
|
|
delay cbld bn)
|
|
(dolist (buf (buffer-list))
|
|
(when (buffer-live-p buf)
|
|
(setq bts (with-current-buffer buf buffer-display-time)
|
|
bn (buffer-name buf)
|
|
delay (if bts (round (float-time (time-subtract tm bts))) 0)
|
|
cbld (clean-buffer-list-delay bn))
|
|
(message "[%s] `%s' [%d %d]" ts bn delay cbld)
|
|
(unless (or (cl-find bn clean-buffer-list-kill-never-regexps
|
|
:test (lambda (bn re)
|
|
(if (functionp re)
|
|
(funcall re bn)
|
|
(string-match re bn))))
|
|
(cl-find bn clean-buffer-list-kill-never-buffer-names
|
|
:test #'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' (last displayed %s ago)" ts bn
|
|
(format-seconds "%Y, %D, %H, %M, %z%S" delay))
|
|
(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)
|
|
"The hook run `midnight-delay' seconds after midnight every day.
|
|
The default value is `clean-buffer-list'."
|
|
:type 'hook)
|
|
|
|
(defun midnight-next ()
|
|
"Return the number of whole or partial seconds till the next midnight."
|
|
(pcase-let ((`(,sec ,min ,hrs) (decode-time nil nil 'integer)))
|
|
(- (* 24 60 60) (* 60 60 hrs) (* 60 min) sec)))
|
|
|
|
;;;###autoload
|
|
(defun midnight-delay-set (symb tm)
|
|
"Modify `midnight-timer' according to `midnight-delay'.
|
|
Sets the first argument SYMB (which must be symbol `midnight-delay')
|
|
to its second argument TM."
|
|
(cl-assert (eq symb 'midnight-delay) t
|
|
"Invalid argument to `midnight-delay-set': `%s'")
|
|
(set symb tm)
|
|
(when (timerp midnight-timer) (cancel-timer midnight-timer))
|
|
;; Only start the timer if the mode is turned on.
|
|
(when midnight-mode
|
|
(setq midnight-timer
|
|
(run-at-time (if (numberp tm) (+ (midnight-next) tm) tm)
|
|
midnight-period #'run-hooks 'midnight-hook))))
|
|
|
|
(defcustom midnight-delay 3600
|
|
"The number of seconds after the midnight when the `midnight-timer' is run.
|
|
You should set this variable before loading midnight.el, or
|
|
set it by calling `midnight-delay-set', or use `custom'.
|
|
If you wish, you can use a string instead, it will be passed as the
|
|
first argument to `run-at-time'."
|
|
:type '(choice integer string)
|
|
:set #'midnight-delay-set)
|
|
|
|
(provide 'midnight)
|
|
|
|
;;; midnight.el ends here
|