annotate lisp/prim/itimer-autosave.el @ 26:441bb1e64a06 r19-15b96

Import from CVS: tag r19-15b96
author cvs
date Mon, 13 Aug 2007 08:51:32 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
1 ;;; itimer-autosave.el --- Autosave functions with itimers
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
2
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
3 ;; Copyright status unknown
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
4
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
5 ;; This file is part of XEmacs.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
6
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
7 ;; XEmacs is free software; you can redistribute it and/or modify it
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
8 ;; under the terms of the GNU General Public License as published by
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
9 ;; the Free Software Foundation; either version 2, or (at your option)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
10 ;; any later version.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
11
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
12 ;; XEmacs is distributed in the hope that it will be useful, but
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
15 ;; General Public License for more details.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
16
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
17 ;; You should have received a copy of the GNU General Public License
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
18 ;; along with XEmacs; see the file COPYING. If not, write to the Free
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
19 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
20 ;; 02111-1307, USA.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
21
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
22 ;;; Synched up with: Not in FSF.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
23
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
24 ;;; Commentary:
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
25
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
26 ;; itimer-driven auto-saves
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
27
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
28 ;;; Code:
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
29
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
30 ;jwz: this is preloaded so don't ;;;###autoload
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
31 (defvar auto-save-timeout 960
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
32 "*Number of seconds idle time before auto-save.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
33 Zero or nil means disable auto-saving due to idleness.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
34
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
35 The actual amount of idle time between auto-saves is logarithmically related
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
36 to the size of the current buffer. This variable is the number of seconds
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
37 after which an auto-save will happen when the current buffer is 50k or less;
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
38 the timeout will be 2 1/4 times this in a 200k buffer, 3 3/4 times this in a
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
39 1000k buffer, and 4 1/2 times this in a 2000k buffer.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
40
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
41 See also the variable `auto-save-interval', which controls auto-saving based
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
42 on the number of characters typed.")
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
43
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
44 ;jwz: this is preloaded so don't ;;;###autoload
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
45 (defvar auto-gc-threshold (/ gc-cons-threshold 3)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
46 "*GC when this many bytes have been consed since the last GC,
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
47 and the user has been idle for `auto-save-timeout' seconds.")
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
48
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
49 (defun auto-save-itimer ()
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
50 "For use as a itimer callback function.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
51 Auto-saves and garbage-collects based on the size of the current buffer
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
52 and the value of `auto-save-timeout', `auto-gc-threshold', and the current
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
53 keyboard idle-time."
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
54 (if (or (null auto-save-timeout)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
55 (<= auto-save-timeout 0)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
56 (eq (minibuffer-window) (selected-window)))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
57 nil
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
58 (let ((buf-size (1+ (ash (buffer-size) -8)))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
59 (delay-level 0)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
60 (now (current-time))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
61 delay)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
62 (while (> buf-size 64)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
63 (setq delay-level (1+ delay-level)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
64 buf-size (- buf-size (ash buf-size -2))))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
65 (if (< delay-level 4)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
66 (setq delay-level 4))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
67 ;; delay_level is 4 for files under around 50k, 7 at 100k, 9 at 200k,
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
68 ;; 11 at 300k, and 12 at 500k, 15 at 1 meg, and 17 at 2 meg.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
69 (setq delay (/ (* delay-level auto-save-timeout) 4))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
70 (let ((idle-time (if (or (not (consp last-input-time))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
71 (/= (car now) (car last-input-time)))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
72 (1+ delay)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
73 (- (car (cdr now)) (cdr last-input-time)))))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
74 (and (> idle-time delay)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
75 (do-auto-save))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
76 (and (> idle-time auto-save-timeout)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
77 (> (consing-since-gc) auto-gc-threshold)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
78 (garbage-collect)))))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
79 ;; Look at the itimer that's currently running; if the user has changed
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
80 ;; the value of auto-save-timeout, modify this itimer to have the correct
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
81 ;; restart time. There will be some latency between when the user changes
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
82 ;; this variable and when it takes effect, but it will happen eventually.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
83 (let ((self (get-itimer "auto-save")))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
84 (or self (error "auto-save-itimer can't find itself"))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
85 (if (and auto-save-timeout (> auto-save-timeout 4))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
86 (or (= (itimer-restart self) (/ auto-save-timeout 4))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
87 (set-itimer-restart self (/ auto-save-timeout 4)))))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
88 nil)
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
89
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
90 (defun itimer-init-auto-gc ()
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
91 (or noninteractive ; may be being run from after-init-hook in -batch mode.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
92 (get-itimer "auto-save")
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
93 ;; the time here is just the first interval; if the user changes it
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
94 ;; later, it will adjust.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
95 (let ((time (max 2 (/ (or auto-save-timeout 30) 4))))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
96 (start-itimer "auto-save" 'auto-save-itimer time time))))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
97
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
98 (cond (purify-flag
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
99 ;; This file is being preloaded into an emacs about to be dumped.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
100 ;; So arrange for the auto-save itimer to be started once emacs
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
101 ;; is launched.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
102 (add-hook 'after-init-hook 'itimer-init-auto-gc))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
103 (t
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
104 ;; Otherwise, this file is being loaded into a normal, interactive
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
105 ;; emacs. Start the auto-save timer now.
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
106 (itimer-init-auto-gc)))
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
107
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
108
441bb1e64a06 Import from CVS: tag r19-15b96
cvs
parents:
diff changeset
109 ;;; itimer-autosave.el ends here