annotate lisp/itimer-autosave.el @ 2362:6aa56b089139

[xemacs-hg @ 2004-11-02 09:51:04 by ben] To: xemacs-patches@xemacs.org internals/index.texi: Deleted. Incorporated into internals.texi. Having a separate index file messes up texinfo-master-menu. internals/internals.texi: Add bunches and bunches and bunches and bunches of stuff, taken from documentation floating around in various places -- text.c, file-coding.c, other .c and .h files, stuff that I wrote up for an old XEmacs contract, proposals written up in the process of an e-mail discussion, etc. Fix up some mistakes, esp. in CCL. Extra crap from CCL, duplicated with Lispref, removed. Sections on Old Future Work and Future Work Discussion added. Bunches of other work. Add bunches of documentation taken from the source code. Fixup various places to use @strong{}, @code{}, @file{}. Create new Text chapter, split off from Buffers and Textual Representation. Create new chapter for MS Windows, mostly written from scratch. Consolidate all Mule info under "Multilingual Support". Break up chapter on modules and move some parts to the sections discussing the modules, for consolidation purposes. Add a big cross-reference table for all the modules to where they're discussed (or not). New chapter Asynchronous Events; Quit Checking. (Taken from various parts of the code.) New Introduction. New section on Focus Handling (from the code). NOTE that in the process, I discovered that we essentially have FOUR redundant introductions to Mule issues! Someone really needs to go through and clean them up and integrate them (sjt?).
author ben
date Tue, 02 Nov 2004 09:51:18 +0000
parents 41ff10fd062f
children 308d34e9f07d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
1 ;;; itimer-autosave.el --- Autosave functions with itimers
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
2
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
3 ;; Copyright status unknown
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
4
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
5 ;; Maintainer: XEmacs Development Team
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
6 ;; Keywords: internal, dumped
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
7
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
8 ;; This file is part of XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
9
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
10 ;; XEmacs is free software; you can redistribute it and/or modify it
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
11 ;; under the terms of the GNU General Public License as published by
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
13 ;; any later version.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
14
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
15 ;; XEmacs is distributed in the hope that it will be useful, but
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
18 ;; General Public License for more details.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
19
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
21 ;; along with XEmacs; see the file COPYING. If not, write to the Free
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
23 ;; 02111-1307, USA.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
24
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
25 ;;; Synched up with: Not in FSF.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
26
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
27 ;;; Commentary:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
28
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
29 ;; This file is dumped with XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
30
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
31 ;; itimer-driven auto-saves
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
32
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
33 ;;; Code:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
34
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
35 ;jwz: this is preloaded so don't ;;;###autoload
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
36 (defvar auto-save-timeout 960
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
37 "*Number of seconds idle time before auto-save.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
38 Zero or nil means disable auto-saving due to idleness.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
39
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
40 The actual amount of idle time between auto-saves is logarithmically related
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
41 to the size of the current buffer. This variable is the number of seconds
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
42 after which an auto-save will happen when the current buffer is 50k or less;
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
43 the timeout will be 2 1/4 times this in a 200k buffer, 3 3/4 times this in a
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
44 1000k buffer, and 4 1/2 times this in a 2000k buffer.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
45
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
46 See also the variable `auto-save-interval', which controls auto-saving based
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
47 on the number of characters typed.")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
48
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
49 ;jwz: this is preloaded so don't ;;;###autoload
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
50 (defvar auto-gc-threshold (/ gc-cons-threshold 3)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
51 "*GC when this many bytes have been consed since the last GC,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
52 and the user has been idle for `auto-save-timeout' seconds.")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
53
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
54 (defun auto-save-itimer ()
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
55 "For use as a itimer callback function.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
56 Auto-saves and garbage-collects based on the size of the current buffer
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
57 and the value of `auto-save-timeout', `auto-gc-threshold', and the current
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
58 keyboard idle-time."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
59 (if (or (null auto-save-timeout)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
60 (<= auto-save-timeout 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
61 (eq (minibuffer-window) (selected-window)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
62 nil
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
63 (let ((buf-size (1+ (ash (buffer-size) -8)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
64 (delay-level 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
65 (now (current-time))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
66 delay)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
67 (while (> buf-size 64)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
68 (setq delay-level (1+ delay-level)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
69 buf-size (- buf-size (ash buf-size -2))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
70 (if (< delay-level 4)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
71 (setq delay-level 4))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
72 ;; delay_level is 4 for files under around 50k, 7 at 100k, 9 at 200k,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
73 ;; 11 at 300k, and 12 at 500k, 15 at 1 meg, and 17 at 2 meg.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
74 (setq delay (/ (* delay-level auto-save-timeout) 4))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
75 (let ((idle-time (if (or (not (consp last-input-time))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
76 (/= (car now) (car last-input-time)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
77 (1+ delay)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
78 (- (car (cdr now)) (cdr last-input-time)))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
79 (and (> idle-time delay)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
80 (do-auto-save))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
81 (and (> idle-time auto-save-timeout)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
82 (> (consing-since-gc) auto-gc-threshold)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
83 (garbage-collect)))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
84 ;; Look at the itimer that's currently running; if the user has changed
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
85 ;; the value of auto-save-timeout, modify this itimer to have the correct
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
86 ;; restart time. There will be some latency between when the user changes
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
87 ;; this variable and when it takes effect, but it will happen eventually.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
88 (let ((self (get-itimer "auto-save")))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
89 (or self (error "auto-save-itimer can't find itself"))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
90 (if (and auto-save-timeout (> auto-save-timeout 4))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
91 (or (= (itimer-restart self) (/ auto-save-timeout 4))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
92 (set-itimer-restart self (/ auto-save-timeout 4)))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
93 nil)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
94
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
95 (defun itimer-init-auto-gc ()
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
96 (or noninteractive ; may be being run from after-init-hook in -batch mode.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
97 (get-itimer "auto-save")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
98 ;; the time here is just the first interval; if the user changes it
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
99 ;; later, it will adjust.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
100 (let ((time (max 2 (/ (or auto-save-timeout 30) 4))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
101 (start-itimer "auto-save" 'auto-save-itimer time time))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
102
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
103 (cond (purify-flag
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
104 ;; This file is being preloaded into an emacs about to be dumped.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
105 ;; So arrange for the auto-save itimer to be started once emacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
106 ;; is launched.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
107 (add-hook 'after-init-hook 'itimer-init-auto-gc))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
108 (t
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
109 ;; Otherwise, this file is being loaded into a normal, interactive
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
110 ;; emacs. Start the auto-save timer now.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
111 (itimer-init-auto-gc)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
112
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
113
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
114 ;;; itimer-autosave.el ends here